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

/**
 * The maximum number of links in one sitemap chunk file.
 */
28
const XMLSITEMAP_MAX_SITEMAP_LINKS = 50000;
29 30 31
/**
 * The maximum filesize of a sitemap chunk file.
 */
32
const XMLSITEMAP_MAX_SITEMAP_FILESIZE = 10485760;
33

34 35 36 37 38 39 40 41 42
/**
 * Xmlsitemap Frequencies
 */
const XMLSITEMAP_FREQUENCY_YEARLY = 31449600; // 60 * 60 * 24 * 7 * 52
const XMLSITEMAP_FREQUENCY_MONTHLY = 2419200; // 60 * 60 * 24 * 7 * 4
const XMLSITEMAP_FREQUENCY_WEEKLY = 604800; // 60 * 60 * 24 * 7
const XMLSITEMAP_FREQUENCY_DAILY = 86400; // 60 * 60 * 24
const XMLSITEMAP_FREQUENCY_HOURLY = 3600; // 60 * 60
const XMLSITEMAP_FREQUENCY_ALWAYS = 60;
43

44 45 46
/**
 * Short lastmod timestamp format.
 */
47
const XMLSITEMAP_LASTMOD_SHORT = 'Y-m-d';
48 49 50 51

/**
 * Medium lastmod timestamp format.
 */
52
const XMLSITEMAP_LASTMOD_MEDIUM = 'Y-m-d\TH:i\Z';
53 54 55 56

/**
 * Long lastmod timestamp format.
 */
57
const XMLSITEMAP_LASTMOD_LONG = 'c';
58

59 60 61
/**
 * The default inclusion status for link types in the sitemaps.
 */
62
const XMLSITEMAP_STATUS_DEFAULT = 0;
63 64 65 66

/**
 * The default priority for link types in the sitemaps.
 */
67
const XMLSITEMAP_PRIORITY_DEFAULT = 0.5;
68

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

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

97 98 99
  return $hooks;
}

100 101
/**
 * Implements hook_help().
Darren Oh's avatar
Darren Oh committed
102
 */
103
function xmlsitemap_help($route_name, RouteMatchInterface $route_match) {
104 105
  $output = '';

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

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

  return $output;
}

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

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

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

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

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

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

211
/**
212
 * Internal default variables config for xmlsitemap_var().
213 214 215
 *
 * @return array
 *   Array with config variables of xmlsitemap.settings config object.
216
 */
217
function xmlsitemap_config_variables() {
218
  return array(
219
    'minimum_lifetime' => 0,
220 221 222 223 224 225 226 227 228
    '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,
229
    // Removed variables are set to NULL so they can still be deleted.
230 231 232 233 234 235
    'regenerate_last' => NULL,
    'custom_links' => NULL,
    'priority_default' => NULL,
    'languages' => NULL,
    'max_chunks' => NULL,
    'max_filesize' => NULL,
236 237 238
  );
}

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

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

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

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

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

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

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

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

326
  return $sitemaps;
327 328
}

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

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

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

  return $sitemap;
361 362 363
}

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

Darren Oh's avatar
Darren Oh committed
373
/**
374
 * Delete multiple XML sitemaps.
375
 *
376
 * @param array $smids
377
 *   An array of XML sitemap IDs.
Darren Oh's avatar
Darren Oh committed
378
 */
379 380 381 382 383
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);
384
      $sitemap->delete();
385
      \Drupal::moduleHandler()->invokeAll('xmlsitemap_sitemap_delete', array($sitemap));
386
    }
387
  }
388
}
389

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

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

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

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

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

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

486
  $links = $query->execute()->fetchAll(PDO::FETCH_ASSOC);
487

488 489 490
  return $links;
}

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

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

  // 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
520
  }
521 522 523 524 525
  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;
  }

526
  $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();
527 528

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

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

  return $link;
Darren Oh's avatar
Darren Oh committed
544 545 546
}

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

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

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

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

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

619 620
  // @todo Add a hook_xmlsitemap_link_delete() hook invoked here.

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

626
  return $query->execute();
627 628
}

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

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

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

657
  return $changed;
Darren Oh's avatar
Darren Oh committed
658 659 660
}

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

678 679 680 681
  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
682

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

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

704
  return $changed;
Darren Oh's avatar
Darren Oh committed
705 706 707
}

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

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

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

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

758 759 760 761 762 763 764 765 766 767 768
/**
 * 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.
 */
769
function xmlsitemap_clear_directory(XmlSitemapInterface $sitemap = NULL, $delete = FALSE) {
770 771 772 773
  $directory = xmlsitemap_get_directory($sitemap);
  return _xmlsitemap_delete_recursive($directory, $delete);
}

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

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

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

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

867
  if (!isset($link_info)) {
868
    $cid = 'xmlsitemap:link_info:' . $language->getId();
869
    if ($cache = \Drupal::cache()->get($cid)) {
870
      $link_info = $cache->data;
871
    }
872
    else {
873
      \Drupal::entityManager()->clearCachedDefinitions();
874 875 876 877 878 879 880 881 882 883 884
      $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)) {
885 886
          // Remove any non URL-able or XML sitemap un-supported entites.
        }
887
        foreach (\Drupal::entityManager()->getBundleInfo($entity_type->id()) as $bundle_key => $bundle) {
888 889 890 891
          if (!isset($bundle['xmlsitemap'])) {
            // Remove any un-supported entity bundles.
          }
        }
892
      }
893
      $link_info = array_merge($link_info, \Drupal::moduleHandler()->invokeAll('xmlsitemap_link_info'));
894 895 896 897 898
      foreach ($link_info as $key => &$info) {
        $info += array(
          'type' => $key,
          'base table' => FALSE,
          'bundles' => array(),
899 900
          'xmlsitemap' => array(),
        );
901 902 903 904 905 906 907 908 909
        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);
        }
910
      }