xmlsitemap.module 89.4 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 Drupal\Component\Utility\Crypt;
12
use Drupal\Core\Language\LanguageInterface;
13
use Drupal\xmlsitemap\XmlSitemapInterface;
14 15
use Drupal\Component\Utility\String;
use Drupal\Core\Render\Element;
16
use Drupal\Core\Entity\EntityForm;
17
use Drupal\Core\Entity\EntityInterface;
18
use Drupal\Core\Session\AnonymousUserSession;
19
use Drupal\Core\Routing\RouteMatchInterface;
20
use Drupal\Core\Database\Query\AlterableInterface;
21
use Drupal\Core\Entity\Query\QueryInterface;
22
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
23
use Symfony\Component\HttpFoundation\Response;
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($route_name, RouteMatchInterface $route_match) {
102 103
  $output = '';

104
  switch ($route_name) {
105
    case 'help.page.xmlsitemap':
106 107 108 109
    case 'xmlsitemap.admin_settings':
    case 'xmlsitemap.entities_settings':
    case 'xmlsitemap.admin_edit':
    case 'xmlsitemap.admin_delete':
110
      return;
111
    case 'xmlsitemap.admin_search':
112
      break;
113
    case 'xmlsitemap.admin_search_list':
114
      break;
115
    case 'xmlsitemap.admin_rebuild':
116 117 118
      $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>';
  }

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

  return $output;
}

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

138 139 140 141 142 143 144 145 146 147 148 149
/**
 * Implements hook_theme().
 */
function xmlsitemap_theme() {
  return array(
    'xmlsitemap_content_settings_table' => array(
      'render element' => 'element',
      'file' => 'xmlsitemap.module',
    ),
  );
}

150 151
/**
 * Menu access callback; determines if the user can use the rebuild links page.
152 153 154
 *
 * @return bool
 *   Returns TRUE if current user can access rebuild form. FALSE otherwise.
155 156 157
 */
function _xmlsitemap_rebuild_form_access() {
  $rebuild_types = xmlsitemap_get_rebuildable_link_types();
158
  return !empty($rebuild_types) && \Drupal::currentUser()->hasPermission('administer xmlsitemap');
159 160
}

Darren Oh's avatar
Darren Oh committed
161
/**
162
 * Implements hook_cron().
163 164 165
 *
 * @todo Use new Queue system. Need to add {sitemap}.queued.
 * @todo Regenerate one at a time?
Darren Oh's avatar
Darren Oh committed
166
 */
167
function xmlsitemap_cron() {
168
  // If there were no new or changed links, skip.
169
  if (!\Drupal::state()->get('xmlsitemap_regenerate_needed')) {
170 171 172
    return;
  }

173
  // If the minimum sitemap lifetime hasn't been passed, skip.
174
  $lifetime = REQUEST_TIME - \Drupal::state()->get('xmlsitemap_generated_last');
175
  if ($lifetime < \Drupal::config('xmlsitemap.settings')->get('minimum_lifetime')) {
176 177
    return;
  }
178
  xmlsitemap_xmlsitemap_index_links(\Drupal::config('xmlsitemap.settings')->get('batch_limit'));
179
  // Regenerate the sitemap XML files.
180
  xmlsitemap_run_unprogressive_batch('xmlsitemap_regenerate_batch');
Darren Oh's avatar
Darren Oh committed
181 182
}

183 184 185 186 187 188 189 190 191 192 193 194 195 196
/**
 * 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
197
/**
198
 * Implements hook_robotstxt().
Darren Oh's avatar
Darren Oh committed
199
 */
200
function xmlsitemap_robotstxt() {
201 202
  $sitemap_storage = \Drupal::entityManager()->getStorage('xmlsitemap');
  if ($sitemap = $sitemap_storage->loadByContext()) {
203 204
    $uri = xmlsitemap_sitemap_uri($sitemap);
    $robotstxt[] = 'Sitemap: ' . url($uri['path'], $uri['options']);
205
    return $robotstxt;
206
  }
Darren Oh's avatar
Darren Oh committed
207 208
}

209
/**
210
 * Internal default variables config for xmlsitemap_var().
211 212 213
 *
 * @return array
 *   Array with config variables of xmlsitemap.settings config object.
214
 */
215
function xmlsitemap_config_variables() {
216
  return array(
217
    'minimum_lifetime' => 0,
218 219 220 221 222 223 224 225 226
    'xsl' => 1,
    'prefetch_aliases' => 1,
    'chunk_size' => 'auto',
    'batch_limit' => 100,
    'path' => 'xmlsitemap',
    'frontpage_priority' => 1.0,
    'frontpage_changefreq' => XMLSITEMAP_FREQUENCY_DAILY,
    'lastmod_format' => XMLSITEMAP_LASTMOD_MEDIUM,
    'gz' => FALSE,
227
    // Removed variables are set to NULL so they can still be deleted.
228 229 230 231 232 233
    'regenerate_last' => NULL,
    'custom_links' => NULL,
    'priority_default' => NULL,
    'languages' => NULL,
    'max_chunks' => NULL,
    'max_filesize' => NULL,
234 235 236
  );
}

237 238
/**
 * Internal default variables state for xmlsitemap_var().
239 240 241
 *
 * @return array
 *   Array with state variables defined by xmlsitemap module.
242 243 244
 */
function xmlsitemap_state_variables() {
  return array(
245 246 247 248 249
    'xmlsitemap_rebuild_needed' => FALSE,
    'xmlsitemap_regenerate_needed' => TRUE,
    'xmlsitemap_base_url' => '',
    'xmlsitemap_generated_last' => 0,
    'xmlsitemap_developer_mode' => 0
250 251 252
  );
}

253 254 255 256 257 258
/**
 * Internal implementation of variable_get().
 */
function xmlsitemap_var($name, $default = NULL) {
  $defaults = &drupal_static(__FUNCTION__);
  if (!isset($defaults)) {
259 260
    $defaults = xmlsitemap_config_variables();
    $defaults += xmlsitemap_state_variables();
261 262
  }

263 264 265
  // @todo Remove when stable.
  if (!isset($defaults[$name])) {
    trigger_error(strtr('Default variable for %variable not found.', array('%variable' => drupal_placeholder($name))));
266 267
  }

268 269 270 271
  if (\Drupal::state()->get($name, NULL) === NULL) {
    return \Drupal::config('xmlsitemap.settings')->get($name);
  }
  return \Drupal::state()->get($name);
272 273
}

Darren Oh's avatar
Darren Oh committed
274
/**
275
 * @defgroup xmlsitemap_api XML sitemap API.
276
 * @{
277 278
 * 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
279
 */
280 281 282 283 284 285

/**
 * Load an XML sitemap array from the database.
 *
 * @param $smid
 *   An XML sitemap ID.
286 287 288
 *
 * @return
 *   The XML sitemap object.
289 290 291 292
 */
function xmlsitemap_sitemap_load($smid) {
  $sitemap = xmlsitemap_sitemap_load_multiple(array($smid));
  return $sitemap ? reset($sitemap) : FALSE;
Darren Oh's avatar
Darren Oh committed
293 294 295
}

/**
296 297 298
 * Load multiple XML sitemaps from the database.
 *
 * @param $smids
299 300 301
 *   An array of XML sitemap IDs, or FALSE to load all XML sitemaps.
 * @param $conditions
 *   An array of conditions in the form 'field' => $value.
302 303 304
 *
 * @return
 *   An array of XML sitemap objects.
Darren Oh's avatar
Darren Oh committed
305
 */
306 307 308 309
function xmlsitemap_sitemap_load_multiple($smids = array(), array $conditions = array()) {
  if ($smids !== FALSE) {
    $conditions['smid'] = $smids;
  }
310
  else {
311
    $conditions['smid'] = NULL;
312
  }
313
  $storage = Drupal::entityManager()->getStorage('xmlsitemap');
314

315
  $sitemaps = $storage->loadMultiple($conditions['smid']);
316 317 318 319 320 321
  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
322
  }
323

324
  return $sitemaps;
325 326
}

Darren Oh's avatar
Darren Oh committed
327
/**
328
 * Save changes to an XML sitemap or add a new XML sitemap.
329
 *
330
 * @param $sitemap
331
 *   The XML sitemap array to be saved. If $sitemap->smid is omitted, a new
332 333 334
 *   XML sitemap will be added.
 *
 * @todo Save the sitemap's URL as a column?
Darren Oh's avatar
Darren Oh committed
335
 */
336
function xmlsitemap_sitemap_save(XmlSitemapInterface $sitemap) {
337
  $context = $sitemap->context;
338
  if (!isset($context) || !$context) {
339
    $sitemap->context = array();
340 341
  }

342
  // Make sure context is sorted before saving the hash.
343
  $sitemap->setOriginalId($sitemap->isNew() ? NULL : $sitemap->getId());
344
  $sitemap->setId(xmlsitemap_sitemap_get_context_hash($context));
345
  // If the context was changed, we need to perform additional actions.
346
  if (!$sitemap->isNew() && $sitemap->getId() != $sitemap->getOriginalId()) {
347
    // Rename the files directory so the sitemap does not break.
348
    $old_sitemap = (object) array('smid' => $sitemap->old_smid);
349
    $old_dir = xmlsitemap_get_directory($old_sitemap);
350 351 352 353
    $new_dir = xmlsitemap_get_directory($sitemap);
    xmlsitemap_directory_move($old_dir, $new_dir);

    // Mark the sitemaps as needing regeneration.
354
    \Drupal::state()->set('xmlsitemap_regenerate_needed', TRUE);
355
  }
356
  $sitemap->save();
357 358

  return $sitemap;
359 360 361
}

/**
362
 * Delete an XML sitemap.
363
 *
364
 * @param string $smid
365
 *   An XML sitemap ID.
366
 */
367 368
function xmlsitemap_sitemap_delete($smid) {
  xmlsitemap_sitemap_delete_multiple(array($smid));
369 370
}

Darren Oh's avatar
Darren Oh committed
371
/**
372
 * Delete multiple XML sitemaps.
373
 *
374
 * @param array $smids
375
 *   An array of XML sitemap IDs.
Darren Oh's avatar
Darren Oh committed
376
 */
377 378 379 380 381
function xmlsitemap_sitemap_delete_multiple(array $smids) {
  if (!empty($smids)) {
    $sitemaps = xmlsitemap_sitemap_load_multiple($smids);
    foreach ($sitemaps as $sitemap) {
      xmlsitemap_clear_directory($sitemap, TRUE);
382
      $sitemap->delete();
383
      \Drupal::moduleHandler()->invokeAll('xmlsitemap_sitemap_delete', array($sitemap));
384
    }
385
  }
386
}
387

388 389 390 391
/**
 * Return the expected file path for a specific sitemap chunk.
 *
 * @param $sitemap
392
 *   An XmlSitemapInterface sitemap object.
393 394
 * @param $chunk
 *   An optional specific chunk in the sitemap. Defaults to the index page.
395 396 397
 *
 * @return string
 *   File path for a specific sitemap chunk.
398
 */
399
function xmlsitemap_sitemap_get_file(XmlSitemapInterface $sitemap, $chunk = 'index') {
400
  return xmlsitemap_get_directory($sitemap) . "/{$chunk}.xml";
Darren Oh's avatar
Darren Oh committed
401 402
}

403 404 405
/**
 * Find the maximum file size of all a sitemap's XML files.
 *
406 407
 * @param \Drupal\xmlsitemap\XmlSitemapInterface $sitemap
 *   The XML sitemap object.
408
 */
409
function xmlsitemap_sitemap_get_max_filesize(XmlSitemapInterface $sitemap) {
410
  $dir = xmlsitemap_get_directory($sitemap);
411
  $sitemap->setMaxFileSize(0);
412
  foreach (file_scan_directory($dir, '/\.xml$/') as $file) {
413
    $sitemap->setMaxFileSize(max($sitemap->getMaxFileSize(), filesize($file->uri)));
414
  }
415
  return $sitemap->getMaxFileSize();
416 417
}

418 419 420 421 422 423 424 425
/**
 * Returns the hash string for a context.
 *
 * @param array $context
 *   Context to be hashed.
 * @return string
 *   Hash string for the context.
 */
426 427
function xmlsitemap_sitemap_get_context_hash(array &$context) {
  asort($context);
428
  return Crypt::hashBase64(serialize($context));
429 430
}

Darren Oh's avatar
Darren Oh committed
431
/**
432
 * Returns the uri elements of an XML sitemap.
433
 *
434 435
 * @param \Drupal\xmlsitemap\XmlSitemapInterface $sitemap
 *   The sitemap represented by and XmlSitemapInterface object.
436
 * @return
437 438
 *   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
439
 */
440
function xmlsitemap_sitemap_uri(XmlSitemapInterface $sitemap) {
441
  $uri['path'] = 'sitemap.xml';
442 443
  $uri['options'] = \Drupal::moduleHandler()->invokeAll('xmlsitemap_context_url_options', array($sitemap->context));
  $context = $sitemap->context;
444
  \Drupal::moduleHandler()->alter('xmlsitemap_context_url_options', $uri['options'], $context);
445 446
  $uri['options'] += array(
    'absolute' => TRUE,
447
    'base_url' => \Drupal::state()->get('xmlsitemap_base_url')
448 449 450
  );
  return $uri;
}
451

452 453 454
/**
 * Load a specific sitemap link from the database.
 *
455
 * @param string $entity_type
456 457
 *   A string with the entity type.
 * @param $entity_id
458
 *   ID for the entity to be loaded.
459 460 461 462 463 464 465 466
 * @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
467
/**
468
 * Load sitemap links from the database.
469 470
 *
 * @param $conditions
471 472
 *   An array of conditions on the {xmlsitemap} table in the form
 *   'field' => $value.
473
 * @return
474
 *   An array of sitemap link arrays.
Darren Oh's avatar
Darren Oh committed
475
 */
476
function xmlsitemap_link_load_multiple(array $conditions = array()) {
477 478
  $query = db_select('xmlsitemap');
  $query->fields('xmlsitemap');
479

480 481 482
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
  }
483

484
  $links = $query->execute()->fetchAll(PDO::FETCH_ASSOC);
485

486 487 488
  return $links;
}

Darren Oh's avatar
Darren Oh committed
489
/**
490 491
 * Saves or updates a sitemap link.
 *
492
 * @param array $link
493
 *   An array with a sitemap link.
494 495 496
 *
 * @return array
 *   Sitemap link saved.
Darren Oh's avatar
Darren Oh committed
497
 */
498
function xmlsitemap_link_save(array $link) {
499 500
  $link += array(
    'access' => 1,
Dave Reid's avatar
Dave Reid committed
501
    'status' => 1,
502 503
    'status_override' => 0,
    'lastmod' => 0,
504
    'priority' => XMLSITEMAP_PRIORITY_DEFAULT,
505 506 507
    'priority_override' => 0,
    'changefreq' => 0,
    'changecount' => 0,
508
    'language' => LanguageInterface::LANGCODE_NOT_SPECIFIED,
509 510 511
  );

  // Allow other modules to alter the link before saving.
512
  \Drupal::moduleHandler()->alter('xmlsitemap_link', $link);
513 514 515 516 517

  // 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
518
  }
519 520 521 522 523
  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;
  }

524
  $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();
525 526

  // Check if this is a changed link and set the regenerate flag if necessary.
527
  if (!\Drupal::state()->get('xmlsitemap_regenerate_needed')) {
528 529 530
    _xmlsitemap_check_changed_link($link, $existing, TRUE);
  }

531
  // Save the link and allow other modules to respond to the link being saved.
532
  if ($existing) {
533
    drupal_write_record('xmlsitemap', $link, array('type', 'id'));
534
    \Drupal::moduleHandler()->invokeAll('xmlsitemap_link_update', array($link));
535 536
  }
  else {
537
    $result = drupal_write_record('xmlsitemap', $link);
538
    \Drupal::moduleHandler()->invokeAll('xmlsitemap_link_insert', array($link));
539 540 541
  }

  return $link;
Darren Oh's avatar
Darren Oh committed
542 543 544
}

/**
545 546 547 548 549 550 551 552 553 554 555
 * 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
556
 */
557
function xmlsitemap_link_update_multiple($updates = array(), $conditions = array(), $check_flag = TRUE) {
558 559
  // If we are going to modify a visible sitemap link, we will need to set
  // the regenerate needed flag.
560
  if ($check_flag && !\Drupal::state()->get('xmlsitemap_regenerate_needed')) {
561 562 563 564
    _xmlsitemap_check_changed_links($conditions, $updates, TRUE);
  }

  // Process updates.
565 566 567 568 569
  $query = db_update('xmlsitemap');
  $query->fields($updates);
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
  }
570

571
  return $query->execute();
Darren Oh's avatar
Darren Oh committed
572 573
}

574
/**
575
 * Delete a specific sitemap link from the database.
576 577 578 579
 *
 * If a visible sitemap link was deleted, this will automatically set the
 * regenerate needed flag.
 *
580
 * @param $entity_type
581
 *   Entity type id.
582
 * @param $entity_id
583
 *   Entity ID.
584 585 586 587 588 589 590 591 592 593 594 595 596 597
 * @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.
 *
598
 * @param $conditions
599 600
 *   An array of conditions on the {xmlsitemap} table in the form
 *   'field' => $value.
601 602
 * @return
 *   The number of links that were deleted.
603
 */
604
function xmlsitemap_link_delete_multiple(array $conditions) {
605 606 607
  // 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().
608
  // @todo Remove this check when http://drupal.org/node/151452 is fixed.
609 610 611 612
  if (!db_table_exists('xmlsitemap')) {
    return FALSE;
  }

613
  if (!\Drupal::state()->get('xmlsitemap_regenerate_needed')) {
614
    _xmlsitemap_check_changed_links($conditions, array(), TRUE);
615
  }
616

617 618
  // @todo Add a hook_xmlsitemap_link_delete() hook invoked here.

619 620 621 622
  $query = db_delete('xmlsitemap');
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
  }
623

624
  return $query->execute();
625 626
}

Darren Oh's avatar
Darren Oh committed
627
/**
628
 * Check if there is a visible sitemap link given a certain set of conditions.
629
 *
630 631 632 633 634 635 636
 * @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.
637
 */
638 639
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.
640 641
  $conditions['status'] = (!empty($updates['status']) && empty($conditions['status'])) ? 0 : 1;
  $conditions['access'] = (!empty($updates['access']) && empty($conditions['access'])) ? 0 : 1;
642

643 644 645 646
  $query = db_select('xmlsitemap');
  $query->addExpression('1');
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
647
  }
648 649
  $query->range(0, 1);
  $changed = $query->execute()->fetchField();
650

651
  if ($changed && $flag) {
652
    \Drupal::state()->set('xmlsitemap_regenerate_needed', TRUE);
Darren Oh's avatar
Darren Oh committed
653
  }
654

655
  return $changed;
Darren Oh's avatar
Darren Oh committed
656 657 658
}

/**
659
 * Check if there is sitemap link is changed from the existing data.
660
 *
661
 * @param array $link
662
 *   An array of the sitemap link.
663
 * @param array $original_link
664 665 666
 *   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.
667
 * @param bool $flag
668 669
 *   An optional boolean that if TRUE, will set the regenerate needed flag if
 *   there is a match. Defaults to FALSE.
670
 * @return bool
671
 *   TRUE if the link is changed, or FALSE otherwise.
Darren Oh's avatar
Darren Oh committed
672
 */
673 674
function _xmlsitemap_check_changed_link(array $link, $original_link = NULL, $flag = FALSE) {
  $changed = FALSE;
675

676 677 678 679
  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
680

681 682 683 684
  if (!$original_link) {
    if ($link['access'] && $link['status']) {
      // Adding a new visible link.
      $changed = TRUE;
Darren Oh's avatar
Darren Oh committed
685
    }
686
  }
687 688 689 690 691 692 693 694
  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
695 696
    }
  }
697 698

  if ($changed && $flag) {
699
    \Drupal::state()->set('xmlsitemap_regenerate_needed', TRUE);
700 701
  }

702
  return $changed;
Darren Oh's avatar
Darren Oh committed
703 704 705
}

/**
706
 * @} End of "defgroup xmlsitemap_api"
707
 */
708
function xmlsitemap_get_directory(XmlSitemapInterface $sitemap = NULL) {
709 710
  $directory = &drupal_static(__FUNCTION__);
  if (!isset($directory)) {
711
    $directory = \Drupal::config('xmlsitemap.settings')->get('path');
Darren Oh's avatar
Darren Oh committed
712
  }
713

714
  if ($sitemap != NULL && !empty($sitemap->id)) {
715
    return file_build_uri($directory . '/' . $sitemap->id);
716 717 718 719
  }
  else {
    return file_build_uri($directory);
  }
Darren Oh's avatar
Darren Oh committed
720 721 722
}

/**
723
 * Check that the sitemap files directory exists and is writable.
Darren Oh's avatar
Darren Oh committed
724
 */
725
function xmlsitemap_check_directory(XmlSitemapInterface $sitemap = NULL) {
726 727 728 729 730 731 732 733
  $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;
}

734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755
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;
}

756 757 758 759 760 761 762 763 764 765 766
/**
 * Clears sitemap directory.
 *
 * @param \Drupal\xmlsitemap\XmlSitemapInterface $sitemap
 *   Sitemap entity.
 * @param bool $delete
 *   If TRUE, delete the path directory afterwards.
 *
 * @return bool
 *   Returns TRUE is operation was successful, FALSE otherwise.
 */
767
function xmlsitemap_clear_directory(XmlSitemapInterface $sitemap = NULL, $delete = FALSE) {
768 769 770 771
  $directory = xmlsitemap_get_directory($sitemap);
  return _xmlsitemap_delete_recursive($directory, $delete);
}

772 773 774
/**
 * Move a directory to a new location.
 *
775
 * @param string $old_dir
776
 *   A string specifying the filepath or URI of the original directory.
777
 * @param string $new_dir
778
 *   A string specifying the filepath or URI of the new directory.
779
 * @param integer $replace
780 781
 *   Replace behavior when the destination file already exists.
 *
782
 * @return bool
783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804
 *   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;
}

805 806 807
/**
 * Recursively delete all files and folders in the specified filepath.
 *
808
 * This is a backport of Drupal 8's file_unmanaged_delete_recursive().
809 810 811
 *
 * Note that this only deletes visible files with write permission.
 *
812
 * @param string $path
813
 *   A filepath relative to the Drupal root directory.
814
 * @param bool $delete_root
815
 *   A boolean if TRUE will delete the $path directory afterwards.
816 817 818
 *
 * @return bool
 *   TRUE if operation was successful, FALSE otherwise.
819 820 821 822 823 824 825 826 827 828 829
 */
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;
830
      file_unmanaged_delete_recursive($entry_path, NULL);
831 832
    }
    $dir->close();
833
    return $delete_root ? drupal_rmdir($path) : TRUE;
834 835
  }
  return file_unmanaged_delete($path);
Darren Oh's avatar
Darren Oh committed
836 837 838
}

/**
839 840 841 842 843 844 845 846 847
 * 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.
 *
848 849 850
 * @return array
 *   Info about sitemap link.
 *
851 852
 * @see hook_xmlsitemap_link_info()
 * @see hook_xmlsitemap_link_info_alter()
Darren Oh's avatar
Darren Oh committed
853
 */
854
function xmlsitemap_get_link_info($type = NULL, $reset = FALSE) {
855
  $language = \Drupal::languageManager()->getCurrentLanguage();
856
  $link_info = &drupal_static(__FUNCTION__);
857

858 859
  if ($reset) {
    $link_info = NULL;
860 861 862
    foreach (\Drupal::languageManager()->getLanguages() as $lang) {
      \Drupal::cache()->delete('xmlsitemap:link_info:' . $lang->getId());
    }
863 864
  }

865
  if (!isset($link_info)) {
866
    $cid = 'xmlsitemap:link_info:' . $language->getId();
867
    if ($cache = \Drupal::cache()->get($cid)) {
868
      $link_info = $cache->data;
869
    }
870
    else {
871
      \Drupal::entityManager()->clearCachedDefinitions();
872 873 874 875 876 877 878 879 880 881 882
      $link_info = array();
      $entity_types = \Drupal::entityManager()->getDefinitions();
      foreach ($entity_types as $key => $entity_type) {
        $link_info[$key] = array(
          'label' => $entity_type->getLabel(),
          'type' => $entity_type->id(),
          'base table' => $entity_type->getBaseTable(),
          'bundles' => \Drupal::entityManager()->getBundleInfo($entity_type->id())
        );
        $uri_callback = $entity_type->getUriCallback();
        if (empty($uri_callback) || !isset($entity_type->xmlsitemap)) {
883 884
          // Remove any non URL-able or XML sitemap un-supported entites.
        }
885
        foreach (\Drupal::entityManager()->getBundleInfo($entity_type->id()) as $bundle_key => $bundle) {
886 887 888 889
          if (!isset($bundle['xmlsitemap'])) {
            // Remove any un-supported entity bundles.
          }
        }
890
      }
891
      $link_info = array_merge($link_info, \Drupal::moduleHandler()->invokeAll('xmlsitemap_link_info'));
892 893 894 895 896
      foreach ($link_info as $key => &$info) {
        $info += array(
          'type' => $key,
          'base table' => FALSE,
          'bundles' => array(),
897 898
          'xmlsitemap' => array(),
        );
899 900 901 902 903 904 905 906 907
        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);
        }
908
      }
909
      \Drupal::moduleHandler()->alter('xmlsitemap_link_info', $link_info);
910 911
      ksort($link_info);
      // Cache by language since this info contains translated strings.
912
      \Drupal::cache()->set($cid, $link_info);
913
    }
Darren Oh's avatar
Darren Oh committed
914
  }
915 916 917 918 919 920

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

  return $link_info;
Darren Oh's avatar
Darren Oh committed
921 922
}

923 924 925 926 927 928 929 930 931
/**
 * Returns enabled bundles of an entity type.
 *
 * @param string $entity_type
 *   Entity type id.
 *
 * @return array
 *   Array with entity bundles info.
 */
932 933 934 935
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) {
936
    $settings = xmlsitemap_link_bundle_load($entity_type, $bundle);