xmlsitemap.module 47.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 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32

/**
 * 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);

33 34 35 36 37 38 39 40 41 42 43 44 45 46 47
/**
 * 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');

48 49 50 51 52 53 54 55 56 57
/**
 * 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);

58 59 60 61
/**
 * Implements hook_hook_info().
 */
function xmlsitemap_hook_info() {
62 63 64 65 66 67 68
  $hooks = array(
    'xmlsitemap_link_info',
    'xmlsitemap_link_info_alter',
    'xmlsitemap_link_alter',
    'xmlsitemap_index_links',
    'xmlsitemap_context_info',
    'xmlsitemap_context_info_alter',
69
    'xmlsitemap_context_url_options',
70
    'xmlsitemap_context',
71 72
    'xmlsitemap_sitemap_insert',
    'xmlsitemap_sitemap_update',
73 74 75 76
    'xmlsitemap_sitemap_operations',
    'xmlsitemap_sitemap_delete',
    'xmlsitemap_sitemap_link_url_options_alter',
    'query_xmlsitemap_generate_alter',
77
    'query_xmlsitemap_link_bundle_access_alter',
78
    'form_xmlsitemap_sitemap_edit_form_alter',
79
  );
80 81 82 83 84

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

86 87 88
  return $hooks;
}

89 90
/**
 * Implements hook_help().
Darren Oh's avatar
Darren Oh committed
91
 */
92
function xmlsitemap_help($path, Request $request) {
93 94
  $output = '';

95
  switch ($path) {
96
    case 'help.page.xmlsitemap':
97
    case 'admin/config/search/xmlsitemap/settings/%/%/%':
Dave Reid's avatar
Dave Reid committed
98 99
    case 'admin/config/search/xmlsitemap/edit/%':
    case 'admin/config/search/xmlsitemap/delete/%':
100
      return;
101 102
    case 'admin/help#xmlsitemap':
      break;
103
    case 'admin/config/search/xmlsitemap':
104
      break;
105
    case 'admin/config/search/xmlsitemap/rebuild':
106 107 108
      $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>';
  }

109 110
  $currentUser = \Drupal::currentUser();
  if (arg(0) == 'admin' && strpos($path, 'xmlsitemap') !== FALSE && $currentUser->hasPermission('administer xmlsitemap')) {
111
    module_load_include('inc', 'xmlsitemap');
112 113
    // Alert the user to any potential problems detected by hook_requirements.
    xmlsitemap_check_status();
114
    $output .= _xmlsitemap_get_blurb();
Darren Oh's avatar
Darren Oh committed
115
  }
116 117 118 119 120 121 122

  return $output;
}

/**
 * Implements hook_perm().
 */
Dave Reid's avatar
Dave Reid committed
123
function xmlsitemap_permission() {
124 125
  $permissions['administer xmlsitemap'] = array(
    'title' => t('Administer XML sitemap settings.'),
Dave Reid's avatar
Dave Reid committed
126
  );
127
  return $permissions;
Darren Oh's avatar
Darren Oh committed
128 129 130
}

/**
131
 * Implements hook_menu().
Darren Oh's avatar
Darren Oh committed
132
 */
133
function xmlsitemap_menu() {
134
  $items['admin/config/search/xmlsitemap'] = array(
135
    'title' => 'XML sitemap',
136
    'description' => "Configure your site's XML sitemaps to help search engines find and index pages on your site.",
137
    'page callback' => 'drupal_get_form',
138
    'page arguments' => array('xmlsitemap_sitemap_list_form'),
139 140
    'access arguments' => array('administer xmlsitemap'),
    'file' => 'xmlsitemap.admin.inc',
141
  );
142 143 144 145 146 147 148 149 150 151 152 153
  $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',
154
    'modal' => TRUE,
155
    'options' => array('modal' => TRUE),
156 157
  );
  $items['admin/config/search/xmlsitemap/edit/%xmlsitemap_sitemap'] = array(
158
    'title' => 'Edit XML sitemap',
159 160 161 162
    'page callback' => 'drupal_get_form',
    'page arguments' => array('xmlsitemap_sitemap_edit_form', 5),
    'access arguments' => array('administer xmlsitemap'),
    'file' => 'xmlsitemap.admin.inc',
163
    'modal' => TRUE,
164 165
  );
  $items['admin/config/search/xmlsitemap/delete/%xmlsitemap_sitemap'] = array(
166
    'title' => 'Delete XML sitemap',
167 168 169 170
    'page callback' => 'drupal_get_form',
    'page arguments' => array('xmlsitemap_sitemap_delete_form', 5),
    'access arguments' => array('administer xmlsitemap'),
    'file' => 'xmlsitemap.admin.inc',
171
    'modal' => TRUE,
172
  );
173

174
  $items['admin/config/search/xmlsitemap/settings'] = array(
175
    'title' => 'Settings',
176 177
    'page callback' => 'drupal_get_form',
    'page arguments' => array('xmlsitemap_settings_form'),
178
    'access arguments' => array('administer xmlsitemap'),
179
    'type' => MENU_LOCAL_TASK,
180
    'file' => 'xmlsitemap.admin.inc',
181
    'weight' => 10,
182
  );
183 184 185 186 187 188 189 190 191 192
  $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,
  );

193
  $items['admin/config/search/xmlsitemap/rebuild'] = array(
194
    'title' => 'Rebuild links',
195
    'description' => 'Rebuild the site map.',
196
    'page callback' => 'drupal_get_form',
197
    'page arguments' => array('xmlsitemap_rebuild_form'),
198
    'access callback' => '_xmlsitemap_rebuild_form_access',
199
    'type' => MENU_LOCAL_TASK,
200
    'file' => 'xmlsitemap.admin.inc',
201
    'weight' => 20,
202 203 204
  );

  $items['sitemap.xml'] = array(
205
    'page callback' => 'xmlsitemap_output_chunk',
206
    'access callback' => TRUE,
207 208 209 210 211 212
    'type' => MENU_CALLBACK,
    'file' => 'xmlsitemap.pages.inc',
  );
  $items['sitemap.xsl'] = array(
    'page callback' => 'xmlsitemap_output_xsl',
    'access callback' => TRUE,
213
    'type' => MENU_CALLBACK,
214
    'file' => 'xmlsitemap.pages.inc',
215 216
  );

Darren Oh's avatar
Darren Oh committed
217 218 219
  return $items;
}

220 221 222 223 224 225 226 227 228
/**
 * 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
229
/**
230
 * Implements hook_cron().
231 232 233
 *
 * @todo Use new Queue system. Need to add {sitemap}.queued.
 * @todo Regenerate one at a time?
Darren Oh's avatar
Darren Oh committed
234
 */
235
function xmlsitemap_cron() {
236
  // If there were no new or changed links, skip.
237
  if (!\Drupal::config('xmlsitemap.settings')->get('regenerate_needed')) {
238 239 240
    return;
  }

241
  // If the minimum sitemap lifetime hasn't been passed, skip.
242 243
  $lifetime = REQUEST_TIME - \Drupal::config('xmlsitemap.settings')->get('generated_last');
  if ($lifetime < \Drupal::config('xmlsitemap.settings')->get('minimum_lifetine')) {
244 245 246 247
    return;
  }

  // Regenerate the sitemap XML files.
248
  module_load_include('generate.inc', 'xmlsitemap');
249
  xmlsitemap_run_unprogressive_batch('xmlsitemap_regenerate_batch');
Darren Oh's avatar
Darren Oh committed
250 251
}

252 253 254 255 256 257 258 259 260 261 262 263 264 265
/**
 * 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
266
/**
267
 * Implements hook_robotstxt().
Darren Oh's avatar
Darren Oh committed
268
 */
269
function xmlsitemap_robotstxt() {
270
  if ($sitemap = xmlsitemap_sitemap_load_by_context()) {
271
    $robotstxt[] = 'Sitemap: ' . url($sitemap->uri['path'], $sitemap->uri['options']);
272
    return $robotstxt;
273
  }
Darren Oh's avatar
Darren Oh committed
274 275
}

276
/**
277
 * Internal default variables for xmlsitemap_var().
278
 */
279 280
function xmlsitemap_variables() {
  return array(
281 282 283 284 285 286 287 288 289 290 291 292 293 294 295
    '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,
296
    // Removed variables are set to NULL so they can still be deleted.
297 298 299 300 301 302
    'regenerate_last' => NULL,
    'custom_links' => NULL,
    'priority_default' => NULL,
    'languages' => NULL,
    'max_chunks' => NULL,
    'max_filesize' => NULL,
303 304 305 306 307 308 309 310 311 312
  );
}

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

315 316 317
  // @todo Remove when stable.
  if (!isset($defaults[$name])) {
    trigger_error(strtr('Default variable for %variable not found.', array('%variable' => drupal_placeholder($name))));
318 319
  }

320
  return \Drupal::config('xmlsitemap.settings')->get($name);
321
  return variable_get($name, isset($default) || !isset($defaults[$name]) ? $default : $defaults[$name]);
322 323
}

Darren Oh's avatar
Darren Oh committed
324
/**
325
 * @defgroup xmlsitemap_api XML sitemap API.
326
 * @{
327 328
 * 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
329
 */
330 331 332 333 334 335

/**
 * Load an XML sitemap array from the database.
 *
 * @param $smid
 *   An XML sitemap ID.
336 337 338
 *
 * @return
 *   The XML sitemap object.
339 340 341 342
 */
function xmlsitemap_sitemap_load($smid) {
  $sitemap = xmlsitemap_sitemap_load_multiple(array($smid));
  return $sitemap ? reset($sitemap) : FALSE;
Darren Oh's avatar
Darren Oh committed
343 344 345
}

/**
346 347 348
 * Load multiple XML sitemaps from the database.
 *
 * @param $smids
349 350 351
 *   An array of XML sitemap IDs, or FALSE to load all XML sitemaps.
 * @param $conditions
 *   An array of conditions in the form 'field' => $value.
352 353 354
 *
 * @return
 *   An array of XML sitemap objects.
Darren Oh's avatar
Darren Oh committed
355
 */
356 357 358 359
function xmlsitemap_sitemap_load_multiple($smids = array(), array $conditions = array()) {
  if ($smids !== FALSE) {
    $conditions['smid'] = $smids;
  }
360 361
  else {
    $conditions['smid'] = array();
362
  }
363
  $storage = Drupal::entityManager()->getStorage('xmlsitemap');
364

365 366 367 368 369 370 371 372 373 374 375 376
  $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');
   */
  $sitemaps = array();
  foreach ($sitemaps as $sitemap) {
    $sitemaps[$sitemap->id()]->setContext(unserialize($sitemap->getContext()));
    $sitemaps[$sitemap->id()]->uri = xmlsitemap_sitemap_uri($sitemap);
Darren Oh's avatar
Darren Oh committed
377
  }
378

379
  return $sitemaps;
380 381 382
}

/**
383
 * Load an XML sitemap array from the database based on its context.
384
 *
385 386
 * @param $context
 *   An optional XML sitemap context array to use to find the correct XML
387
 *   sitemap. If not provided, the current site's context will be used.
388
 *
389
 * @see xmlsitemap_get_current_context()
390
 */
391 392 393
function xmlsitemap_sitemap_load_by_context(array $context = NULL) {
  if (!isset($context)) {
    $context = xmlsitemap_get_current_context();
Darren Oh's avatar
Darren Oh committed
394
  }
395 396
  $hash = xmlsitemap_sitemap_get_context_hash($context);
  $smid = db_query_range("SELECT smid FROM {xmlsitemap_sitemap} WHERE smid = :hash", 0, 1, array(':hash' => $hash))->fetchField();
397
  return xmlsitemap_sitemap_load($smid);
Darren Oh's avatar
Darren Oh committed
398 399 400
}

/**
401
 * Save changes to an XML sitemap or add a new XML sitemap.
402
 *
403
 * @param $sitemap
404
 *   The XML sitemap array to be saved. If $sitemap->smid is omitted, a new
405 406 407
 *   XML sitemap will be added.
 *
 * @todo Save the sitemap's URL as a column?
Darren Oh's avatar
Darren Oh committed
408
 */
409
function xmlsitemap_sitemap_save(stdClass $sitemap) {
410 411 412 413
  if (!isset($sitemap->context)) {
    $sitemap->context = array();
  }

414
  // Make sure context is sorted before saving the hash.
415 416
  $sitemap->is_new = empty($sitemap->smid);
  $sitemap->old_smid = $sitemap->is_new ? NULL : $sitemap->smid;
417
  $sitemap->smid = xmlsitemap_sitemap_get_context_hash($sitemap->context);
418

419
  // If the context was changed, we need to perform additional actions.
420
  if (!$sitemap->is_new && $sitemap->smid != $sitemap->old_smid) {
421
    // Rename the files directory so the sitemap does not break.
422
    $old_sitemap = (object) array('smid' => $sitemap->old_smid);
423
    $old_dir = xmlsitemap_get_directory($old_sitemap);
424 425 426 427 428
    $new_dir = xmlsitemap_get_directory($sitemap);
    xmlsitemap_directory_move($old_dir, $new_dir);

    // Change the smid field so drupal_write_record() does not fail.
    db_update('xmlsitemap_sitemap')
429 430 431
        ->fields(array('smid' => $sitemap->smid))
        ->condition('smid', $sitemap->old_smid)
        ->execute();
432 433

    // Mark the sitemaps as needing regeneration.
434
    \Drupal::config('xmlsitemap.settings')->set('regenerate_needed', TRUE);
435
  }
436

437
  if ($sitemap->is_new) {
438
    drupal_write_record('xmlsitemap_sitemap', $sitemap);
439 440 441 442 443
    module_invoke_all('xmlsitemap_sitemap_insert', $sitemap);
  }
  else {
    drupal_write_record('xmlsitemap_sitemap', $sitemap, array('smid'));
    module_invoke_all('xmlsitemap_sitemap_update', $sitemap);
444
  }
445 446

  return $sitemap;
447 448 449
}

/**
450
 * Delete an XML sitemap.
451
 *
452 453
 * @param $smid
 *   An XML sitemap ID.
454
 */
455 456
function xmlsitemap_sitemap_delete($smid) {
  xmlsitemap_sitemap_delete_multiple(array($smid));
457 458
}

Darren Oh's avatar
Darren Oh committed
459
/**
460
 * Delete multiple XML sitemaps.
461
 *
462 463
 * @param $smids
 *   An array of XML sitemap IDs.
Darren Oh's avatar
Darren Oh committed
464
 */
465 466 467
function xmlsitemap_sitemap_delete_multiple(array $smids) {
  if (!empty($smids)) {
    $sitemaps = xmlsitemap_sitemap_load_multiple($smids);
468 469 470 471 472
    /*
      db_delete('xmlsitemap_sitemap')
      ->condition('smid', $smids)
      ->execute();
     */
473 474
    foreach ($sitemaps as $sitemap) {
      xmlsitemap_clear_directory($sitemap, TRUE);
475
      $sitemap->delete();
476 477
      module_invoke_all('xmlsitemap_sitemap_delete', $sitemap);
    }
478
  }
479
}
480

481 482 483 484 485 486 487 488
/**
 * Return the expected file path for a specific sitemap chunk.
 *
 * @param $sitemap
 *   An XML sitemap array.
 * @param $chunk
 *   An optional specific chunk in the sitemap. Defaults to the index page.
 */
489
function xmlsitemap_sitemap_get_file(stdClass $sitemap, $chunk = 'index') {
490
  return xmlsitemap_get_directory($sitemap) . "/{$chunk}.xml";
Darren Oh's avatar
Darren Oh committed
491 492
}

493 494 495 496 497 498
/**
 * Find the maximum file size of all a sitemap's XML files.
 *
 * @param $sitemap
 *   The XML sitemap array.
 */
499
function xmlsitemap_sitemap_get_max_filesize(stdClass $sitemap) {
500
  $dir = xmlsitemap_get_directory($sitemap);
501
  $sitemap->max_filesize = 0;
502
  foreach (file_scan_directory($dir, '/\.xml$/') as $file) {
503
    $sitemap->max_filesize = max($sitemap->max_filesize, filesize($file->uri));
504
  }
505
  return $sitemap->max_filesize;
506 507
}

508 509
function xmlsitemap_sitemap_get_context_hash(array &$context) {
  asort($context);
510
  return Crypt::hashBase64(serialize($context));
511 512
}

Darren Oh's avatar
Darren Oh committed
513
/**
514
 * Returns the uri elements of an XML sitemap.
515
 *
516 517
 * @param $sitemap
 *   An unserialized data array for an XML sitemap.
518
 * @return
519 520
 *   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
521
 */
522
function xmlsitemap_sitemap_uri(stdClass $sitemap) {
523
  $uri['path'] = 'sitemap.xml';
524 525
  $uri['options'] = module_invoke_all('xmlsitemap_context_url_options', $sitemap->context);
  drupal_alter('xmlsitemap_context_url_options', $uri['options'], $sitemap->context);
526 527
  $uri['options'] += array(
    'absolute' => TRUE,
528
    'base_url' => $GLOBALS['base_url'],
529 530 531
  );
  return $uri;
}
532

533 534 535 536 537 538 539 540 541 542 543 544 545 546 547
/**
 * 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
548
/**
549
 * Load sitemap links from the database.
550 551
 *
 * @param $conditions
552 553
 *   An array of conditions on the {xmlsitemap} table in the form
 *   'field' => $value.
554
 * @return
555
 *   An array of sitemap link arrays.
Darren Oh's avatar
Darren Oh committed
556
 */
557
function xmlsitemap_link_load_multiple(array $conditions = array()) {
558 559
  $query = db_select('xmlsitemap');
  $query->fields('xmlsitemap');
560

561 562 563
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
  }
564

565
  $links = $query->execute()->fetchAll(PDO::FETCH_ASSOC);
566

567 568 569
  return $links;
}

Darren Oh's avatar
Darren Oh committed
570
/**
571 572 573 574
 * Saves or updates a sitemap link.
 *
 * @param $link
 *   An array with a sitemap link.
Darren Oh's avatar
Darren Oh committed
575
 */
576
function xmlsitemap_link_save(array $link) {
577 578
  $link += array(
    'access' => 1,
Dave Reid's avatar
Dave Reid committed
579
    'status' => 1,
580 581
    'status_override' => 0,
    'lastmod' => 0,
582
    'priority' => XMLSITEMAP_PRIORITY_DEFAULT,
583 584 585
    'priority_override' => 0,
    'changefreq' => 0,
    'changecount' => 0,
586
    'language' => LanguageInterface::LANGCODE_NOT_SPECIFIED,
587 588 589 590 591 592 593 594 595
  );

  // 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
596
  }
597 598 599 600 601
  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;
  }

602
  $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();
603 604

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

609
  // Save the link and allow other modules to respond to the link being saved.
610
  if ($existing) {
611
    drupal_write_record('xmlsitemap', $link, array('type', 'id'));
612
    module_invoke_all('xmlsitemap_link_update', $link);
613 614
  }
  else {
615
    drupal_write_record('xmlsitemap', $link);
616
    module_invoke_all('xmlsitemap_link_insert', $link);
617 618 619
  }

  return $link;
Darren Oh's avatar
Darren Oh committed
620 621 622
}

/**
623 624 625 626 627 628 629 630 631 632 633
 * 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
634
 */
635
function xmlsitemap_link_update_multiple($updates = array(), $conditions = array(), $check_flag = TRUE) {
636 637
  // If we are going to modify a visible sitemap link, we will need to set
  // the regenerate needed flag.
638
  if ($check_flag && !\Drupal::config('xmlsitemap.settings')->get('regenerate_needed')) {
639 640 641 642
    _xmlsitemap_check_changed_links($conditions, $updates, TRUE);
  }

  // Process updates.
643 644 645 646 647
  $query = db_update('xmlsitemap');
  $query->fields($updates);
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
  }
648

649
  return $query->execute();
Darren Oh's avatar
Darren Oh committed
650 651
}

652
/**
653
 * Delete a specific sitemap link from the database.
654 655 656 657
 *
 * If a visible sitemap link was deleted, this will automatically set the
 * regenerate needed flag.
 *
658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675
 * @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.
 *
676
 * @param $conditions
677 678
 *   An array of conditions on the {xmlsitemap} table in the form
 *   'field' => $value.
679 680
 * @return
 *   The number of links that were deleted.
681
 */
682
function xmlsitemap_link_delete_multiple(array $conditions) {
683 684 685
  // 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().
686
  // @todo Remove this check when http://drupal.org/node/151452 is fixed.
687 688 689 690
  if (!db_table_exists('xmlsitemap')) {
    return FALSE;
  }

691
  if (!\Drupal::config('xmlsitemap.settings')->get('regenerate_needed')) {
692
    _xmlsitemap_check_changed_links($conditions, array(), TRUE);
693
  }
694

695 696
  // @todo Add a hook_xmlsitemap_link_delete() hook invoked here.

697 698 699 700
  $query = db_delete('xmlsitemap');
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
  }
701

702
  return $query->execute();
703 704
}

Darren Oh's avatar
Darren Oh committed
705
/**
706
 * Check if there is a visible sitemap link given a certain set of conditions.
707
 *
708 709 710 711 712 713 714
 * @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.
715
 */
716 717
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.
718 719
  $conditions['status'] = (!empty($updates['status']) && empty($conditions['status'])) ? 0 : 1;
  $conditions['access'] = (!empty($updates['access']) && empty($conditions['access'])) ? 0 : 1;
720

721 722 723 724
  $query = db_select('xmlsitemap');
  $query->addExpression('1');
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
725
  }
726 727
  $query->range(0, 1);
  $changed = $query->execute()->fetchField();
728

729
  if ($changed && $flag) {
730
    \Drupal::config('xmlsitemap.settings')->set('regenerate_needed', TRUE);
Darren Oh's avatar
Darren Oh committed
731
  }
732

733
  return $changed;
Darren Oh's avatar
Darren Oh committed
734 735 736
}

/**
737
 * Check if there is sitemap link is changed from the existing data.
738
 *
739 740 741 742 743 744 745 746 747 748 749
 * @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
750
 */
751 752
function _xmlsitemap_check_changed_link(array $link, $original_link = NULL, $flag = FALSE) {
  $changed = FALSE;
753

754 755 756 757
  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
758

759 760 761 762
  if (!$original_link) {
    if ($link['access'] && $link['status']) {
      // Adding a new visible link.
      $changed = TRUE;
Darren Oh's avatar
Darren Oh committed
763
    }
764
  }
765 766 767 768 769 770 771 772
  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
773 774
    }
  }
775 776

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

780
  return $changed;
Darren Oh's avatar
Darren Oh committed
781 782 783
}

/**
784
 * @} End of "defgroup xmlsitemap_api"
785
 */
786
function xmlsitemap_get_directory(stdClass $sitemap = NULL) {
787
  $directory = &drupal_static(__FUNCTION__);
788

789
  if (!isset($directory)) {
790
    $directory = \Drupal::config('xmlsitemap.settings')->get('path');
Darren Oh's avatar
Darren Oh committed
791
  }
792

793
  if ($sitemap != NULL && !empty($sitemap->id)) {
794
    return file_build_uri($directory . '/' . $sitemap->smid);
795 796 797 798
  }
  else {
    return file_build_uri($directory);
  }
Darren Oh's avatar
Darren Oh committed
799 800 801
}

/**
802
 * Check that the sitemap files directory exists and is writable.
Darren Oh's avatar
Darren Oh committed
803
 */
804
function xmlsitemap_check_directory(stdClass $sitemap = NULL) {
805 806 807 808 809 810 811 812
  $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;
}

813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834
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;
}

835
function xmlsitemap_clear_directory(stdClass $sitemap = NULL, $delete = FALSE) {
836 837 838 839
  $directory = xmlsitemap_get_directory($sitemap);
  return _xmlsitemap_delete_recursive($directory, $delete);
}

840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872
/**
 * 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;
}

873 874 875 876 877 878 879 880
/**
 * 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
881
 *   A filepath relative to the Drupal root directory.
882 883 884 885 886 887 888 889 890 891 892 893 894
 * @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;
895
      file_unmanaged_delete_recursive($entry_path, NULL);
896 897
    }
    $dir->close();
898
    return $delete_root ? drupal_rmdir($path) : TRUE;
899 900
  }
  return file_unmanaged_delete($path);
Darren Oh's avatar
Darren Oh committed
901 902 903
}

/**
904 905 906 907 908 909 910 911 912 913 914
 * 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
915
 */
916
function xmlsitemap_get_link_info($type = NULL, $reset = FALSE) {
917
  global $language;
918
  $link_info = &drupal_static(__FUNCTION__);
919

920 921
  if ($reset) {
    $link_info = NULL;
922
    cache_clear_all('xmlsitemap:link_info:', 'cache', TRUE);
923 924
  }

925
  if (!isset($link_info)) {
926
    $cid = 'xmlsitemap:link_info:' . $language->language;
927
    if ($cache = \Drupal::cache()->get($cid)) {
928
      $link_info = $cache->data;
929
    }
930 931 932 933 934 935 936 937 938 939 940 941 942 943
    else {
      entity_info_cache_clear();
      $link_info = entity_get_info();
      foreach ($link_info as $key => $info) {
        if (empty($info['uri callback']) || !isset($info['xmlsitemap'])) {
          // Remove any non URL-able or XML sitemap un-supported entites.
          unset($link_info[$key]);
        }
        foreach ($info['bundles'] as $bundle_key => $bundle) {
          if (!isset($bundle['xmlsitemap'])) {
            // Remove any un-supported entity bundles.
            //unset($link_info[$key]['bundles'][$bundle_key]);
          }
        }
944
      }
945 946 947 948 949 950
      $link_info = array_merge($link_info, module_invoke_all('xmlsitemap_link_info'));
      foreach ($link_info as $key => &$info) {
        $info += array(
          'type' => $key,
          'base table' => FALSE,
          'bundles' => array(),
951 952
          'xmlsitemap' => array(),
        );
953 954 955 956 957 958 959 960 961
        if (!isset($info['xmlsitemap']['rebuild callback']) && !empty($info['base table']) && !empty($info['entity keys']['id']) && !empty($info['xmlsitemap']['process callback'])) {
          $info['xmlsitemap']['rebuild callback'] = 'xmlsitemap_rebuild_batch_fetch';
        }
        foreach ($info['bundles'] as $bundle => &$bundle_info) {
          $bundle_info += array(
            'xmlsitemap' => array(),
          );
          $bundle_info['xmlsitemap'] += xmlsitemap_link_bundle_load($key, $bundle, FALSE);
        }
962
      }
963 964 965
      drupal_alter('xmlsitemap_link_info', $link_info);
      ksort($link_info);
      // Cache by language since this info contains translated strings.
966
      \Drupal::cache()->set($cid, $link_info);
967
    }
Darren Oh's avatar
Darren Oh committed
968
  }
969 970 971 972 973 974

  if (isset($type)) {
    return isset($link_info[$type]) ? $link_info[$type] : NULL;
  }

  return $link_info;
Darren Oh's avatar
Darren Oh committed
975 976
}

977 978 979 980
function xmlsitemap_get_link_type_enabled_bundles($entity_type) {
  $bundles = array();
  $info = xmlsitemap_get_link_info($entity_type);
  foreach ($info['bundles'] as $bundle => $bundle_info) {
981
    $settings = xmlsitemap_link_bundle_load($entity_type, $bundle);
982
    if (!empty($settings['status'])) {
983
      //if (!empty($bundle_info['xmlsitemap']['status'])) {
984 985 986 987 988 989
      $bundles[] = $bundle;
    }
  }
  return $bundles;
}

990 991 992
function