xmlsitemap.module 66.3 KB
Newer Older
Darren Oh's avatar
Darren Oh committed
1 2 3
<?php

/**
4
 * @defgroup xmlsitemap XML sitemap
Darren Oh's avatar
Darren Oh committed
5 6 7
 */

/**
8 9 10
 * @file
 * Main file for the xmlsitemap module.
 */
11
use Symfony\Component\HttpFoundation\Request;
12
use Drupal\Component\Utility\Crypt;
13
use Drupal\Core\Session\UserSession;
14
use Drupal\Core\Language\LanguageInterface;
15
use Drupal\xmlsitemap\XmlSitemapInterface;
16 17
use Drupal\user\Entity\User;
use Drupal\user\UserInterface;
18 19
use Drupal\Component\Utility\String;
use Drupal\Core\Render\Element;
20 21
use Drupal\Core\Entity\EntityFormBuilderInterface;
use Drupal\Core\Entity\EntityForm;
22 23
use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Entity\Entity;
24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41

/**
 * The maximum number of links in one sitemap chunk file.
 */
define('XMLSITEMAP_MAX_SITEMAP_LINKS', 50000);

/**
 * The maximum filesize of a sitemap chunk file.
 */
define('XMLSITEMAP_MAX_SITEMAP_FILESIZE', 10485760);

define('XMLSITEMAP_FREQUENCY_YEARLY', 31449600); // 60 * 60 * 24 * 7 * 52
define('XMLSITEMAP_FREQUENCY_MONTHLY', 2419200); // 60 * 60 * 24 * 7 * 4
define('XMLSITEMAP_FREQUENCY_WEEKLY', 604800); // 60 * 60 * 24 * 7
define('XMLSITEMAP_FREQUENCY_DAILY', 86400); // 60 * 60 * 24
define('XMLSITEMAP_FREQUENCY_HOURLY', 3600); // 60 * 60
define('XMLSITEMAP_FREQUENCY_ALWAYS', 60);

42 43 44 45 46 47 48 49 50 51 52 53 54 55 56
/**
 * Short lastmod timestamp format.
 */
define('XMLSITEMAP_LASTMOD_SHORT', 'Y-m-d');

/**
 * Medium lastmod timestamp format.
 */
define('XMLSITEMAP_LASTMOD_MEDIUM', 'Y-m-d\TH:i\Z');

/**
 * Long lastmod timestamp format.
 */
define('XMLSITEMAP_LASTMOD_LONG', 'c');

57 58 59 60 61 62 63 64 65 66
/**
 * The default inclusion status for link types in the sitemaps.
 */
define('XMLSITEMAP_STATUS_DEFAULT', 0);

/**
 * The default priority for link types in the sitemaps.
 */
define('XMLSITEMAP_PRIORITY_DEFAULT', 0.5);

67 68 69 70
/**
 * Implements hook_hook_info().
 */
function xmlsitemap_hook_info() {
71 72 73 74 75 76 77
  $hooks = array(
    'xmlsitemap_link_info',
    'xmlsitemap_link_info_alter',
    'xmlsitemap_link_alter',
    'xmlsitemap_index_links',
    'xmlsitemap_context_info',
    'xmlsitemap_context_info_alter',
78
    'xmlsitemap_context_url_options',
79
    'xmlsitemap_context',
80 81
    'xmlsitemap_sitemap_insert',
    'xmlsitemap_sitemap_update',
82 83 84 85
    'xmlsitemap_sitemap_operations',
    'xmlsitemap_sitemap_delete',
    'xmlsitemap_sitemap_link_url_options_alter',
    'query_xmlsitemap_generate_alter',
86
    'query_xmlsitemap_link_bundle_access_alter',
87
    'form_xmlsitemap_sitemap_edit_form_alter',
88
  );
89 90 91 92 93

  $hooks = array_combine($hooks, $hooks);
  foreach ($hooks as $hook => $info) {
    $hooks[$hook] = array('group' => 'xmlsitemap');
  }
94

95 96 97
  return $hooks;
}

98 99
/**
 * Implements hook_help().
Darren Oh's avatar
Darren Oh committed
100
 */
101
function xmlsitemap_help($path, Request $request) {
102 103
  $output = '';

104
  switch ($path) {
105
    case 'help.page.xmlsitemap':
106
    case 'admin/config/search/xmlsitemap/settings/%/%/%':
Dave Reid's avatar
Dave Reid committed
107 108
    case 'admin/config/search/xmlsitemap/edit/%':
    case 'admin/config/search/xmlsitemap/delete/%':
109
      return;
110 111
    case 'admin/help#xmlsitemap':
      break;
112
    case 'admin/config/search/xmlsitemap':
113
      break;
114
    case 'admin/config/search/xmlsitemap/rebuild':
115 116 117
      $output .= '<p>' . t("This action rebuilds your site's XML sitemap and regenerates the cached files, and may be a lengthy process. If you just installed XML sitemap, this can be helpful to import all your site's content into the sitemap. Otherwise, this should only be used in emergencies.") . '</p>';
  }

118 119
  $currentUser = \Drupal::currentUser();
  if (arg(0) == 'admin' && strpos($path, 'xmlsitemap') !== FALSE && $currentUser->hasPermission('administer xmlsitemap')) {
120
    module_load_include('inc', 'xmlsitemap');
121 122
    // Alert the user to any potential problems detected by hook_requirements.
    xmlsitemap_check_status();
123
    $output .= _xmlsitemap_get_blurb();
Darren Oh's avatar
Darren Oh committed
124
  }
125 126 127 128 129 130 131

  return $output;
}

/**
 * Implements hook_perm().
 */
Dave Reid's avatar
Dave Reid committed
132
function xmlsitemap_permission() {
133 134
  $permissions['administer xmlsitemap'] = array(
    'title' => t('Administer XML sitemap settings.'),
Dave Reid's avatar
Dave Reid committed
135
  );
136
  return $permissions;
Darren Oh's avatar
Darren Oh committed
137 138 139
}

/**
140
 * Implements hook_menu().
Darren Oh's avatar
Darren Oh committed
141
 */
142
function xmlsitemap_menu() {
143
  $items['admin/config/search/xmlsitemap'] = array(
144
    'title' => 'XML sitemap',
145
    'description' => "Configure your site's XML sitemaps to help search engines find and index pages on your site.",
146
    'page callback' => 'drupal_get_form',
147
    'page arguments' => array('xmlsitemap_sitemap_list_form'),
148 149
    'access arguments' => array('administer xmlsitemap'),
    'file' => 'xmlsitemap.admin.inc',
150
  );
151 152 153 154 155 156 157 158 159 160 161 162
  $items['admin/config/search/xmlsitemap/list'] = array(
    'title' => 'List',
    'type' => MENU_DEFAULT_LOCAL_TASK,
    'weight' => -10,
  );
  $items['admin/config/search/xmlsitemap/add'] = array(
    'title' => 'Add new XML sitemap',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('xmlsitemap_sitemap_edit_form'),
    'access arguments' => array('administer xmlsitemap'),
    'type' => MENU_LOCAL_ACTION,
    'file' => 'xmlsitemap.admin.inc',
163
    'modal' => TRUE,
164
    'options' => array('modal' => TRUE),
165 166
  );
  $items['admin/config/search/xmlsitemap/edit/%xmlsitemap_sitemap'] = array(
167
    'title' => 'Edit XML sitemap',
168 169 170 171
    'page callback' => 'drupal_get_form',
    'page arguments' => array('xmlsitemap_sitemap_edit_form', 5),
    'access arguments' => array('administer xmlsitemap'),
    'file' => 'xmlsitemap.admin.inc',
172
    'modal' => TRUE,
173 174
  );
  $items['admin/config/search/xmlsitemap/delete/%xmlsitemap_sitemap'] = array(
175
    'title' => 'Delete XML sitemap',
176 177 178 179
    'page callback' => 'drupal_get_form',
    'page arguments' => array('xmlsitemap_sitemap_delete_form', 5),
    'access arguments' => array('administer xmlsitemap'),
    'file' => 'xmlsitemap.admin.inc',
180
    'modal' => TRUE,
181
  );
182

183
  $items['admin/config/search/xmlsitemap/settings'] = array(
184
    'title' => 'Settings',
185 186
    'page callback' => 'drupal_get_form',
    'page arguments' => array('xmlsitemap_settings_form'),
187
    'access arguments' => array('administer xmlsitemap'),
188
    'type' => MENU_LOCAL_TASK,
189
    'file' => 'xmlsitemap.admin.inc',
190
    'weight' => 10,
191
  );
192 193 194 195 196 197 198 199 200 201
  $items['admin/config/search/xmlsitemap/settings/%xmlsitemap_link_bundle/%'] = array(
    'load arguments' => array(6),
    'page callback' => 'drupal_get_form',
    'page arguments' => array('xmlsitemap_link_bundle_settings_form', 5),
    'access callback' => 'xmlsitemap_link_bundle_access',
    'access arguments' => array(5),
    'file' => 'xmlsitemap.admin.inc',
    'modal' => TRUE,
  );

202
  $items['admin/config/search/xmlsitemap/rebuild'] = array(
203
    'title' => 'Rebuild links',
204
    'description' => 'Rebuild the site map.',
205
    'page callback' => 'drupal_get_form',
206
    'page arguments' => array('xmlsitemap_rebuild_form'),
207
    'access callback' => '_xmlsitemap_rebuild_form_access',
208
    'type' => MENU_LOCAL_TASK,
209
    'file' => 'xmlsitemap.admin.inc',
210
    'weight' => 20,
211 212 213
  );

  $items['sitemap.xml'] = array(
214
    'page callback' => 'xmlsitemap_output_chunk',
215
    'access callback' => TRUE,
216 217 218 219 220 221
    'type' => MENU_CALLBACK,
    'file' => 'xmlsitemap.pages.inc',
  );
  $items['sitemap.xsl'] = array(
    'page callback' => 'xmlsitemap_output_xsl',
    'access callback' => TRUE,
222
    'type' => MENU_CALLBACK,
223
    'file' => 'xmlsitemap.pages.inc',
224 225
  );

Darren Oh's avatar
Darren Oh committed
226 227 228
  return $items;
}

229 230 231 232 233 234 235 236 237 238 239 240
/**
 * Implements hook_theme().
 */
function xmlsitemap_theme() {
  return array(
    'xmlsitemap_content_settings_table' => array(
      'render element' => 'element',
      'file' => 'xmlsitemap.module',
    ),
  );
}

241 242 243 244 245 246 247 248 249
/**
 * Menu access callback; determines if the user can use the rebuild links page.
 */
function _xmlsitemap_rebuild_form_access() {
  module_load_include('generate.inc', 'xmlsitemap');
  $rebuild_types = xmlsitemap_get_rebuildable_link_types();
  return !empty($rebuild_types) && user_access('administer xmlsitemap');
}

Darren Oh's avatar
Darren Oh committed
250
/**
251
 * Implements hook_cron().
252 253 254
 *
 * @todo Use new Queue system. Need to add {sitemap}.queued.
 * @todo Regenerate one at a time?
Darren Oh's avatar
Darren Oh committed
255
 */
256
function xmlsitemap_cron() {
257
  // If there were no new or changed links, skip.
258
  if (!\Drupal::config('xmlsitemap.settings')->get('regenerate_needed')) {
259 260 261
    return;
  }

262
  // If the minimum sitemap lifetime hasn't been passed, skip.
263 264
  $lifetime = REQUEST_TIME - \Drupal::config('xmlsitemap.settings')->get('generated_last');
  if ($lifetime < \Drupal::config('xmlsitemap.settings')->get('minimum_lifetine')) {
265 266
    return;
  }
267
  xmlsitemap_xmlsitemap_index_links(100);
268
  // Regenerate the sitemap XML files.
269
  module_load_include('generate.inc', 'xmlsitemap');
270
  xmlsitemap_run_unprogressive_batch('xmlsitemap_regenerate_batch');
Darren Oh's avatar
Darren Oh committed
271 272
}

273 274 275 276 277 278 279 280 281 282 283 284 285 286
/**
 * Implements hook_modules_enabled().
 */
function xmlsitemap_modules_enabled(array $modules) {
  cache_clear_all('xmlsitemap:', 'cache', TRUE);
}

/**
 * Implements hook_modules_disabled().
 */
function xmlsitemap_modules_disabled(array $modules) {
  cache_clear_all('xmlsitemap:', 'cache', TRUE);
}

Darren Oh's avatar
Darren Oh committed
287
/**
288
 * Implements hook_robotstxt().
Darren Oh's avatar
Darren Oh committed
289
 */
290
function xmlsitemap_robotstxt() {
291
  if ($sitemap = xmlsitemap_sitemap_load_by_context()) {
292
    $robotstxt[] = 'Sitemap: ' . url($sitemap->uri['path'], $sitemap->uri['options']);
293
    return $robotstxt;
294
  }
Darren Oh's avatar
Darren Oh committed
295 296
}

297
/**
298
 * Internal default variables for xmlsitemap_var().
299
 */
300 301
function xmlsitemap_variables() {
  return array(
302 303 304 305 306 307 308 309 310 311 312 313 314 315 316
    'rebuild_needed' => FALSE,
    'regenerate_needed' => FALSE,
    'minimum_lifetine' => 0,
    'generated_last' => 0,
    'xsl' => 1,
    'prefetch_aliases' => 1,
    'chunk_size' => 'auto',
    'batch_limit' => 100,
    'path' => 'xmlsitemap',
    'base_url' => $GLOBALS['base_url'],
    'developer_mode' => 0,
    'frontpage_priority' => 1.0,
    'frontpage_changefreq' => XMLSITEMAP_FREQUENCY_DAILY,
    'lastmod_format' => XMLSITEMAP_LASTMOD_MEDIUM,
    'gz' => FALSE,
317
    // Removed variables are set to NULL so they can still be deleted.
318 319 320 321 322 323
    'regenerate_last' => NULL,
    'custom_links' => NULL,
    'priority_default' => NULL,
    'languages' => NULL,
    'max_chunks' => NULL,
    'max_filesize' => NULL,
324 325 326 327 328 329 330 331 332 333
  );
}

/**
 * Internal implementation of variable_get().
 */
function xmlsitemap_var($name, $default = NULL) {
  $defaults = &drupal_static(__FUNCTION__);
  if (!isset($defaults)) {
    $defaults = xmlsitemap_variables();
334 335
  }

336 337 338
  // @todo Remove when stable.
  if (!isset($defaults[$name])) {
    trigger_error(strtr('Default variable for %variable not found.', array('%variable' => drupal_placeholder($name))));
339 340
  }

341
  return \Drupal::config('xmlsitemap.settings')->get($name);
342
  return variable_get($name, isset($default) || !isset($defaults[$name]) ? $default : $defaults[$name]);
343 344
}

Darren Oh's avatar
Darren Oh committed
345
/**
346
 * @defgroup xmlsitemap_api XML sitemap API.
347
 * @{
348 349
 * This is the XML sitemap API to be used by modules wishing to work with
 * XML sitemap and/or link data.
Darren Oh's avatar
Darren Oh committed
350
 */
351 352 353 354 355 356

/**
 * Load an XML sitemap array from the database.
 *
 * @param $smid
 *   An XML sitemap ID.
357 358 359
 *
 * @return
 *   The XML sitemap object.
360 361 362 363
 */
function xmlsitemap_sitemap_load($smid) {
  $sitemap = xmlsitemap_sitemap_load_multiple(array($smid));
  return $sitemap ? reset($sitemap) : FALSE;
Darren Oh's avatar
Darren Oh committed
364 365 366
}

/**
367 368 369
 * Load multiple XML sitemaps from the database.
 *
 * @param $smids
370 371 372
 *   An array of XML sitemap IDs, or FALSE to load all XML sitemaps.
 * @param $conditions
 *   An array of conditions in the form 'field' => $value.
373 374 375
 *
 * @return
 *   An array of XML sitemap objects.
Darren Oh's avatar
Darren Oh committed
376
 */
377 378 379 380
function xmlsitemap_sitemap_load_multiple($smids = array(), array $conditions = array()) {
  if ($smids !== FALSE) {
    $conditions['smid'] = $smids;
  }
381
  else {
382
    $conditions['smid'] = NULL;
383
  }
384
  $storage = Drupal::entityManager()->getStorage('xmlsitemap');
385

386 387 388 389 390 391 392 393
  $sitemaps = $storage->loadMultiple($conditions['smid']);
  /* $query = db_select('xmlsitemap_sitemap');
    $query->fields('xmlsitemap_sitemap');
    foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
    }
    $sitemaps = $query->execute()->fetchAllAssoc('smid');
   */
394 395 396 397 398 399
  if (count($sitemaps) <= 0) {
    return array();
  }
  foreach ($sitemaps as &$sitemap) {
    $uri = xmlsitemap_sitemap_uri($sitemap);
    $sitemap->uri = $uri;
Darren Oh's avatar
Darren Oh committed
400
  }
401

402
  return $sitemaps;
403 404 405
}

/**
406
 * Load an XML sitemap array from the database based on its context.
407
 *
408 409
 * @param $context
 *   An optional XML sitemap context array to use to find the correct XML
410
 *   sitemap. If not provided, the current site's context will be used.
411
 *
412
 * @see xmlsitemap_get_current_context()
413
 */
414 415 416
function xmlsitemap_sitemap_load_by_context(array $context = NULL) {
  if (!isset($context)) {
    $context = xmlsitemap_get_current_context();
Darren Oh's avatar
Darren Oh committed
417
  }
418
  $hash = xmlsitemap_sitemap_get_context_hash($context);
419 420 421 422 423 424 425 426
  $sitemaps = \Drupal::entityManager()->getStorage('xmlsitemap')->loadMultiple();
  return reset($sitemaps);
  foreach ($sitemaps as $sitemap) {
    if ($sitemap->getContext() == $hash) {
      return $sitemap;
    }
  }
  return NULL;
Darren Oh's avatar
Darren Oh committed
427 428 429
}

/**
430
 * Save changes to an XML sitemap or add a new XML sitemap.
431
 *
432
 * @param $sitemap
433
 *   The XML sitemap array to be saved. If $sitemap->smid is omitted, a new
434 435 436
 *   XML sitemap will be added.
 *
 * @todo Save the sitemap's URL as a column?
Darren Oh's avatar
Darren Oh committed
437
 */
438
function xmlsitemap_sitemap_save(XmlSitemapInterface $sitemap) {
439 440
  $context = $sitemap->getContext();
  if (!isset($context) || !$context) {
441
    $sitemap->setContext(array());
442 443
  }

444
  // Make sure context is sorted before saving the hash.
445 446
  //$sitemap->is_new = empty($sitemap->getId());
  //$sitemap->old_smid = $sitemap->is_new ? NULL : $sitemap->smid;
447
  $sitemap->setOriginalId($sitemap->isNew() ? NULL : $sitemap->getId());
448 449
  $context = $sitemap->getContext();
  $sitemap->setId(xmlsitemap_sitemap_get_context_hash($context));
450
  // If the context was changed, we need to perform additional actions.
451
  if (!$sitemap->isNew() && $sitemap->getId() != $sitemap->getOriginalId()) {
452
    // Rename the files directory so the sitemap does not break.
453
    $old_sitemap = (object) array('smid' => $sitemap->old_smid);
454
    $old_dir = xmlsitemap_get_directory($old_sitemap);
455 456 457 458
    $new_dir = xmlsitemap_get_directory($sitemap);
    xmlsitemap_directory_move($old_dir, $new_dir);

    // Mark the sitemaps as needing regeneration.
459
    \Drupal::config('xmlsitemap.settings')->set('regenerate_needed', TRUE);
460
  }
461
  $sitemap->save();
462 463

  return $sitemap;
464 465 466
}

/**
467
 * Delete an XML sitemap.
468
 *
469 470
 * @param $smid
 *   An XML sitemap ID.
471
 */
472 473
function xmlsitemap_sitemap_delete($smid) {
  xmlsitemap_sitemap_delete_multiple(array($smid));
474 475
}

Darren Oh's avatar
Darren Oh committed
476
/**
477
 * Delete multiple XML sitemaps.
478
 *
479 480
 * @param $smids
 *   An array of XML sitemap IDs.
Darren Oh's avatar
Darren Oh committed
481
 */
482 483 484
function xmlsitemap_sitemap_delete_multiple(array $smids) {
  if (!empty($smids)) {
    $sitemaps = xmlsitemap_sitemap_load_multiple($smids);
485 486 487 488 489
    /*
      db_delete('xmlsitemap_sitemap')
      ->condition('smid', $smids)
      ->execute();
     */
490 491
    foreach ($sitemaps as $sitemap) {
      xmlsitemap_clear_directory($sitemap, TRUE);
492
      $sitemap->delete();
493
      \Drupal::moduleHandler()->invokeAll('xmlsitemap_sitemap_delete', array($sitemap));
494
    }
495
  }
496
}
497

498 499 500 501
/**
 * Return the expected file path for a specific sitemap chunk.
 *
 * @param $sitemap
502
 *   An XmlSitemapInterface sitemap object.
503 504 505
 * @param $chunk
 *   An optional specific chunk in the sitemap. Defaults to the index page.
 */
506
function xmlsitemap_sitemap_get_file(XmlSitemapInterface $sitemap, $chunk = 'index') {
507
  return xmlsitemap_get_directory($sitemap) . "/{$chunk}.xml";
Darren Oh's avatar
Darren Oh committed
508 509
}

510 511 512 513 514 515
/**
 * Find the maximum file size of all a sitemap's XML files.
 *
 * @param $sitemap
 *   The XML sitemap array.
 */
516
function xmlsitemap_sitemap_get_max_filesize(XmlSitemapInterface $sitemap) {
517
  $dir = xmlsitemap_get_directory($sitemap);
518
  $sitemap->setMaxFileSize(0);
519
  foreach (file_scan_directory($dir, '/\.xml$/') as $file) {
520
    $sitemap->setMaxFileSize(max($sitemap->getMaxFileSize(), filesize($file->uri)));
521
  }
522
  return $sitemap->getMaxFileSize();
523 524
}

525 526
function xmlsitemap_sitemap_get_context_hash(array &$context) {
  asort($context);
527
  return Crypt::hashBase64(serialize($context));
528 529
}

Darren Oh's avatar
Darren Oh committed
530
/**
531
 * Returns the uri elements of an XML sitemap.
532
 *
533 534
 * @param \Drupal\xmlsitemap\XmlSitemapInterface $sitemap
 *   The sitemap represented by and XmlSitemapInterface object.
535
 * @return
536 537
 *   An array containing the 'path' and 'options' keys used to build the uri of
 *   the XML sitemap, and matching the signature of url().
Darren Oh's avatar
Darren Oh committed
538
 */
539
function xmlsitemap_sitemap_uri(XmlSitemapInterface $sitemap) {
540
  $uri['path'] = 'sitemap.xml';
541 542
  $uri['options'] = \Drupal::moduleHandler()->invokeAll('xmlsitemap_context_url_options', array($sitemap->context));
  $context = $sitemap->context;
543
  \Drupal::moduleHandler()->alter('xmlsitemap_context_url_options', $uri['options'], $context);
544 545
  $uri['options'] += array(
    'absolute' => TRUE,
546
    'base_url' => \Drupal::state()->get('base_url')
547 548 549
  );
  return $uri;
}
550

551 552 553 554 555 556 557 558 559 560 561 562 563 564 565
/**
 * Load a specific sitemap link from the database.
 *
 * @param $entity_type
 *   A string with the entity type.
 * @param $entity_id
 *   An integer with the entity ID.
 * @return
 *   A sitemap link (array) or FALSE if the conditions were not found.
 */
function xmlsitemap_link_load($entity_type, $entity_id) {
  $link = xmlsitemap_link_load_multiple(array('type' => $entity_type, 'id' => $entity_id));
  return $link ? reset($link) : FALSE;
}

Darren Oh's avatar
Darren Oh committed
566
/**
567
 * Load sitemap links from the database.
568 569
 *
 * @param $conditions
570 571
 *   An array of conditions on the {xmlsitemap} table in the form
 *   'field' => $value.
572
 * @return
573
 *   An array of sitemap link arrays.
Darren Oh's avatar
Darren Oh committed
574
 */
575
function xmlsitemap_link_load_multiple(array $conditions = array()) {
576 577
  $query = db_select('xmlsitemap');
  $query->fields('xmlsitemap');
578

579 580 581
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
  }
582

583
  $links = $query->execute()->fetchAll(PDO::FETCH_ASSOC);
584

585 586 587
  return $links;
}

Darren Oh's avatar
Darren Oh committed
588
/**
589 590 591 592
 * Saves or updates a sitemap link.
 *
 * @param $link
 *   An array with a sitemap link.
Darren Oh's avatar
Darren Oh committed
593
 */
594
function xmlsitemap_link_save(array $link) {
595 596
  $link += array(
    'access' => 1,
Dave Reid's avatar
Dave Reid committed
597
    'status' => 1,
598 599
    'status_override' => 0,
    'lastmod' => 0,
600
    'priority' => XMLSITEMAP_PRIORITY_DEFAULT,
601 602 603
    'priority_override' => 0,
    'changefreq' => 0,
    'changecount' => 0,
604
    'language' => LanguageInterface::LANGCODE_NOT_SPECIFIED,
605 606 607 608 609 610 611 612 613
  );

  // Allow other modules to alter the link before saving.
  drupal_alter('xmlsitemap_link', $link);

  // Temporary validation checks.
  // @todo Remove in final?
  if ($link['priority'] < 0 || $link['priority'] > 1) {
    trigger_error(t('Invalid sitemap link priority %priority.<br />@link', array('%priority' => $link['priority'], '@link' => var_export($link, TRUE))), E_USER_ERROR);
Darren Oh's avatar
Darren Oh committed
614
  }
615 616 617 618 619
  if ($link['changecount'] < 0) {
    trigger_error(t('Negative changecount value. Please report this to <a href="@516928">@516928</a>.<br />@link', array('@516928' => 'http://drupal.org/node/516928', '@link' => var_export($link, TRUE))), E_USER_ERROR);
    $link['changecount'] = 0;
  }

620
  $existing = db_query_range("SELECT loc, access, status, lastmod, priority, changefreq, changecount, language FROM {xmlsitemap} WHERE type = :type AND id = :id", 0, 1, array(':type' => $link['type'], ':id' => $link['id']))->fetchAssoc();
621 622

  // Check if this is a changed link and set the regenerate flag if necessary.
623
  if (!\Drupal::config('xmlsitemap.settings')->get('regenerate_needed')) {
624 625 626
    _xmlsitemap_check_changed_link($link, $existing, TRUE);
  }

627
  // Save the link and allow other modules to respond to the link being saved.
628
  if ($existing) {
629
    drupal_write_record('xmlsitemap', $link, array('type', 'id'));
630
    \Drupal::moduleHandler()->invokeAll('xmlsitemap_link_update', array($link));
631 632
  }
  else {
633
    $result = drupal_write_record('xmlsitemap', $link);
634
    \Drupal::moduleHandler()->invokeAll('xmlsitemap_link_insert', array($link));
635 636 637
  }

  return $link;
Darren Oh's avatar
Darren Oh committed
638 639 640
}

/**
641 642 643 644 645 646 647 648 649 650 651
 * Perform a mass update of sitemap data.
 *
 * If visible links are updated, this will automatically set the regenerate
 * needed flag to TRUE.
 *
 * @param $updates
 *   An array of values to update fields to, keyed by field name.
 * @param $conditions
 *   An array of values to match keyed by field.
 * @return
 *   The number of links that were updated.
Darren Oh's avatar
Darren Oh committed
652
 */
653
function xmlsitemap_link_update_multiple($updates = array(), $conditions = array(), $check_flag = TRUE) {
654 655
  // If we are going to modify a visible sitemap link, we will need to set
  // the regenerate needed flag.
656
  if ($check_flag && !\Drupal::config('xmlsitemap.settings')->get('regenerate_needed')) {
657 658 659 660
    _xmlsitemap_check_changed_links($conditions, $updates, TRUE);
  }

  // Process updates.
661 662 663 664 665
  $query = db_update('xmlsitemap');
  $query->fields($updates);
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
  }
666

667
  return $query->execute();
Darren Oh's avatar
Darren Oh committed
668 669
}

670
/**
671
 * Delete a specific sitemap link from the database.
672 673 674 675
 *
 * If a visible sitemap link was deleted, this will automatically set the
 * regenerate needed flag.
 *
676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693
 * @param $entity_type
 *   A string with the entity type.
 * @param $entity_id
 *   An integer with the entity ID.
 * @return
 *   The number of links that were deleted.
 */
function xmlsitemap_link_delete($entity_type, $entity_id) {
  $conditions = array('type' => $entity_type, 'id' => $entity_id);
  return xmlsitemap_link_delete_multiple($conditions);
}

/**
 * Delete multiple sitemap links from the database.
 *
 * If visible sitemap links were deleted, this will automatically set the
 * regenerate needed flag.
 *
694
 * @param $conditions
695 696
 *   An array of conditions on the {xmlsitemap} table in the form
 *   'field' => $value.
697 698
 * @return
 *   The number of links that were deleted.
699
 */
700
function xmlsitemap_link_delete_multiple(array $conditions) {
701 702 703
  // Because this function is called from sub-module uninstall hooks, we have
  // to manually check if the table exists since it could have been removed
  // in xmlsitemap_uninstall().
704
  // @todo Remove this check when http://drupal.org/node/151452 is fixed.
705 706 707 708
  if (!db_table_exists('xmlsitemap')) {
    return FALSE;
  }

709
  if (!\Drupal::config('xmlsitemap.settings')->get('regenerate_needed')) {
710
    _xmlsitemap_check_changed_links($conditions, array(), TRUE);
711
  }
712

713 714
  // @todo Add a hook_xmlsitemap_link_delete() hook invoked here.

715 716 717 718
  $query = db_delete('xmlsitemap');
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
  }
719

720
  return $query->execute();
721 722
}

Darren Oh's avatar
Darren Oh committed
723
/**
724
 * Check if there is a visible sitemap link given a certain set of conditions.
725
 *
726 727 728 729 730 731 732
 * @param $conditions
 *   An array of values to match keyed by field.
 * @param $flag
 *   An optional boolean that if TRUE, will set the regenerate needed flag if
 *   there is a match. Defaults to FALSE.
 * @return
 *   TRUE if there is a visible link, or FALSE otherwise.
733
 */
734 735
function _xmlsitemap_check_changed_links(array $conditions = array(), array $updates = array(), $flag = FALSE) {
  // If we are changing status or access, check for negative current values.
736 737
  $conditions['status'] = (!empty($updates['status']) && empty($conditions['status'])) ? 0 : 1;
  $conditions['access'] = (!empty($updates['access']) && empty($conditions['access'])) ? 0 : 1;
738

739 740 741 742
  $query = db_select('xmlsitemap');
  $query->addExpression('1');
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
743
  }
744 745
  $query->range(0, 1);
  $changed = $query->execute()->fetchField();
746

747
  if ($changed && $flag) {
748
    \Drupal::config('xmlsitemap.settings')->set('regenerate_needed', TRUE);
Darren Oh's avatar
Darren Oh committed
749
  }
750

751
  return $changed;
Darren Oh's avatar
Darren Oh committed
752 753 754
}

/**
755
 * Check if there is sitemap link is changed from the existing data.
756
 *
757 758 759 760 761 762 763 764 765 766 767
 * @param $link
 *   An array of the sitemap link.
 * @param $original_link
 *   An optional array of the existing data. This should only contain the
 *   fields necessary for comparison. If not provided the existing data will be
 *   loaded from the database.
 * @param $flag
 *   An optional boolean that if TRUE, will set the regenerate needed flag if
 *   there is a match. Defaults to FALSE.
 * @return
 *   TRUE if the link is changed, or FALSE otherwise.
Darren Oh's avatar
Darren Oh committed
768
 */
769 770
function _xmlsitemap_check_changed_link(array $link, $original_link = NULL, $flag = FALSE) {
  $changed = FALSE;
771

772 773 774 775
  if ($original_link === NULL) {
    // Load only the fields necessary for data to be changed in the sitemap.
    $original_link = db_query_range("SELECT loc, access, status, lastmod, priority, changefreq, changecount, language FROM {xmlsitemap} WHERE type = :type AND id = :id", 0, 1, array(':type' => $link['type'], ':id' => $link['id']))->fetchAssoc();
  }
Darren Oh's avatar
Darren Oh committed
776

777 778 779 780
  if (!$original_link) {
    if ($link['access'] && $link['status']) {
      // Adding a new visible link.
      $changed = TRUE;
Darren Oh's avatar
Darren Oh committed
781
    }
782
  }
783 784 785 786 787 788 789 790
  else {
    if (!($original_link['access'] && $original_link['status']) && $link['access'] && $link['status']) {
      // Changing a non-visible link to a visible link.
      $changed = TRUE;
    }
    elseif ($original_link['access'] && $original_link['status'] && array_diff_assoc($original_link, $link)) {
      // Changing a visible link
      $changed = TRUE;
Darren Oh's avatar
Darren Oh committed
791 792
    }
  }
793 794

  if ($changed && $flag) {
795
    \Drupal::config('xmlsitemap.settings')->set('regenerate_needed', TRUE);
796 797
  }

798
  return $changed;
Darren Oh's avatar
Darren Oh committed
799 800 801
}

/**
802
 * @} End of "defgroup xmlsitemap_api"
803
 */
804
function xmlsitemap_get_directory(XmlSitemapInterface $sitemap = NULL) {
805 806
  $directory = &drupal_static(__FUNCTION__);
  if (!isset($directory)) {
807
    $directory = \Drupal::config('xmlsitemap.settings')->get('path');
Darren Oh's avatar
Darren Oh committed
808
  }
809

810
  if ($sitemap != NULL && !empty($sitemap->id)) {
811
    return file_build_uri($directory . '/' . $sitemap->id);
812 813 814 815
  }
  else {
    return file_build_uri($directory);
  }
Darren Oh's avatar
Darren Oh committed
816 817 818
}

/**
819
 * Check that the sitemap files directory exists and is writable.
Darren Oh's avatar
Darren Oh committed
820
 */
821
function xmlsitemap_check_directory(XmlSitemapInterface $sitemap = NULL) {
822 823 824 825 826 827 828 829
  $directory = xmlsitemap_get_directory($sitemap);
  $result = file_prepare_directory($directory, FILE_CREATE_DIRECTORY | FILE_MODIFY_PERMISSIONS);
  if (!$result) {
    watchdog('file system', 'The directory %directory does not exist or is not writable.', array('%directory' => $directory), WATCHDOG_ERROR);
  }
  return $result;
}

830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851
function xmlsitemap_check_all_directories() {
  $directories = array();

  $sitemaps = xmlsitemap_sitemap_load_multiple(FALSE);
  foreach ($sitemaps as $smid => $sitemap) {
    $directory = xmlsitemap_get_directory($sitemap);
    $directories[$directory] = $directory;
  }

  foreach ($directories as $directory) {
    $result = file_prepare_directory($directory, FILE_CREATE_DIRECTORY | FILE_MODIFY_PERMISSIONS);
    if ($result) {
      $directories[$directory] = TRUE;
    }
    else {
      $directories[$directory] = FALSE;
    }
  }

  return $directories;
}

852
function xmlsitemap_clear_directory(XmlSitemapInterface $sitemap = NULL, $delete = FALSE) {
853 854 855 856
  $directory = xmlsitemap_get_directory($sitemap);
  return _xmlsitemap_delete_recursive($directory, $delete);
}

857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889
/**
 * Move a directory to a new location.
 *
 * @param $old_dir
 *   A string specifying the filepath or URI of the original directory.
 * @param $new_dir
 *   A string specifying the filepath or URI of the new directory.
 * @param $replace
 *   Replace behavior when the destination file already exists.
 *
 * @return
 *   TRUE if the directory was moved successfully. FALSE otherwise.
 */
function xmlsitemap_directory_move($old_dir, $new_dir, $replace = FILE_EXISTS_REPLACE) {
  $success = file_prepare_directory($new_dir, FILE_CREATE_DIRECTORY | FILE_MODIFY_PERMISSIONS);

  $old_path = drupal_realpath($old_dir);
  $new_path = drupal_realpath($new_dir);
  if (!is_dir($old_path) || !is_dir($new_path) || !$success) {
    return FALSE;
  }

  $files = file_scan_directory($old_dir, '/.*/');
  foreach ($files as $file) {
    $file->uri_new = $new_dir . '/' . basename($file->filename);
    $success &= (bool) file_unmanaged_move($file->uri, $file->uri_new, $replace);
  }

  // The remove the directory.
  $success &= drupal_rmdir($old_dir);
  return $success;
}

890 891 892 893 894 895 896 897
/**
 * Recursively delete all files and folders in the specified filepath.
 *
 * This is a backport of Drupal 7's file_unmanaged_delete_recursive().
 *
 * Note that this only deletes visible files with write permission.
 *
 * @param $path
898
 *   A filepath relative to the Drupal root directory.
899 900 901 902 903 904 905 906 907 908 909 910 911
 * @param $delete_root
 *   A boolean if TRUE will delete the $path directory afterwards.
 */
function _xmlsitemap_delete_recursive($path, $delete_root = FALSE) {
  // Resolve streamwrapper URI to local path.
  $path = drupal_realpath($path);
  if (is_dir($path)) {
    $dir = dir($path);
    while (($entry = $dir->read()) !== FALSE) {
      if ($entry == '.' || $entry == '..') {
        continue;
      }
      $entry_path = $path . '/' . $entry;
912
      file_unmanaged_delete_recursive($entry_path, NULL);
913 914
    }
    $dir->close();
915
    return $delete_root ? drupal_rmdir($path) : TRUE;
916 917
  }
  return file_unmanaged_delete($path);
Darren Oh's avatar
Darren Oh committed
918 919 920
}

/**
921 922 923 924 925 926 927 928 929 930 931
 * Returns information about supported sitemap link types.
 *
 * @param $type
 *   (optional) The link type to return information for. If omitted,
 *   information for all link types is returned.
 * @param $reset
 *   (optional) Boolean whether to reset the static cache and do nothing. Only
 *   used for tests.
 *
 * @see hook_xmlsitemap_link_info()
 * @see hook_xmlsitemap_link_info_alter()
Darren Oh's avatar
Darren Oh committed
932
 */
933
function xmlsitemap_get_link_info($type = NULL, $reset = FALSE) {
934
  $language = \Drupal::languageManager()->getCurrentLanguage();
935
  $link_info = &drupal_static(__FUNCTION__);
936

937 938
  if ($reset) {
    $link_info = NULL;
939 940 941
    foreach (\Drupal::languageManager()->getLanguages() as $lang) {
      \Drupal::cache()->delete('xmlsitemap:link_info:' . $lang->getId());
    }
942 943
  }

944
  if (!isset($link_info)) {
945
    $cid = 'xmlsitemap:link_info:' . $language->getId();
946
    if ($cache = \Drupal::cache()->get($cid)) {