xmlsitemap.module 79.5 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

12
use Drupal\Component\Utility\Crypt;
13
use Drupal\Component\Utility\SafeMarkup;
14
use Drupal\Component\Utility\Unicode;
15
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 Drupal\Core\Entity\Query\QueryException;
23
use Drupal\Core\Cache\Cache;
24
use Drupal\Core\Form\FormStateInterface;
25
use Drupal\Core\Language\LanguageInterface;
26
use Drupal\Core\Url;
27 28
use Drupal\xmlsitemap\Entity\XmlSitemap;
use Drupal\xmlsitemap\XmlSitemapInterface;
29
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
30
use Symfony\Component\HttpFoundation\Response;
31

32 33 34 35

/**
 * The maximum number of links in one sitemap chunk file.
 */
36
const XMLSITEMAP_MAX_SITEMAP_LINKS = 50000;
37

38 39 40
/**
 * The maximum filesize of a sitemap chunk file.
 */
41
const XMLSITEMAP_MAX_SITEMAP_FILESIZE = 10485760;
42

43
/**
44
 * Xmlsitemap Frequencies.
45
 */
46 47 48 49 50 51 52 53 54 55
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
56
const XMLSITEMAP_FREQUENCY_ALWAYS = 60;
57

58 59 60
/**
 * Short lastmod timestamp format.
 */
61
const XMLSITEMAP_LASTMOD_SHORT = 'Y-m-d';
62 63 64 65

/**
 * Medium lastmod timestamp format.
 */
66
const XMLSITEMAP_LASTMOD_MEDIUM = 'Y-m-d\TH:i\Z';
67 68 69 70

/**
 * Long lastmod timestamp format.
 */
71
const XMLSITEMAP_LASTMOD_LONG = 'c';
72

73 74 75
/**
 * The default inclusion status for link types in the sitemaps.
 */
76
const XMLSITEMAP_STATUS_DEFAULT = 0;
77 78 79 80

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

83 84 85 86
/**
 * Implements hook_hook_info().
 */
function xmlsitemap_hook_info() {
87 88 89 90 91 92 93
  $hooks = array(
    'xmlsitemap_link_info',
    'xmlsitemap_link_info_alter',
    'xmlsitemap_link_alter',
    'xmlsitemap_index_links',
    'xmlsitemap_context_info',
    'xmlsitemap_context_info_alter',
94
    'xmlsitemap_context_url_options',
95
    'xmlsitemap_context',
96 97
    'xmlsitemap_sitemap_insert',
    'xmlsitemap_sitemap_update',
98 99 100 101
    'xmlsitemap_sitemap_operations',
    'xmlsitemap_sitemap_delete',
    'xmlsitemap_sitemap_link_url_options_alter',
    'query_xmlsitemap_generate_alter',
102
    'query_xmlsitemap_link_bundle_access_alter',
103
    'form_xmlsitemap_sitemap_edit_form_alter',
104
  );
105 106 107 108 109

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

111 112 113
  return $hooks;
}

114 115
/**
 * Implements hook_help().
Darren Oh's avatar
Darren Oh committed
116
 */
117
function xmlsitemap_help($route_name, RouteMatchInterface $route_match) {
118 119
  $output = '';

120
  switch ($route_name) {
121
    case 'help.page.xmlsitemap':
122 123
    case 'xmlsitemap.admin_settings':
    case 'xmlsitemap.entities_settings':
124 125
    case 'entity.xmlsitemap.edit_form':
    case 'entity.xmlsitemap.delete_form':
126
      return;
127

128
    case 'xmlsitemap.admin_search':
129
      break;
130

131
    case 'xmlsitemap.admin_search_list':
132
      break;
133

134
    case 'xmlsitemap.admin_rebuild':
135 136 137
      $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>';
  }

138
  $currentUser = \Drupal::currentUser();
139
  if (strpos($route_name, 'xmlsitemap') !== FALSE && $currentUser->hasPermission('administer xmlsitemap')) {
140
    // Alert the user to any potential problems detected by hook_requirements.
141
    $output .= _xmlsitemap_get_blurb();
Darren Oh's avatar
Darren Oh committed
142
  }
143 144 145 146

  return $output;
}

147 148 149 150 151 152 153 154 155 156 157 158
/**
 * Implements hook_theme().
 */
function xmlsitemap_theme() {
  return array(
    'xmlsitemap_content_settings_table' => array(
      'render element' => 'element',
      'file' => 'xmlsitemap.module',
    ),
  );
}

159 160
/**
 * Menu access callback; determines if the user can use the rebuild links page.
161 162 163
 *
 * @return bool
 *   Returns TRUE if current user can access rebuild form. FALSE otherwise.
164 165 166
 */
function _xmlsitemap_rebuild_form_access() {
  $rebuild_types = xmlsitemap_get_rebuildable_link_types();
167
  return !empty($rebuild_types) && \Drupal::currentUser()->hasPermission('administer xmlsitemap');
168 169
}

Darren Oh's avatar
Darren Oh committed
170
/**
171
 * Implements hook_cron().
172 173 174
 *
 * @todo Use new Queue system. Need to add {sitemap}.queued.
 * @todo Regenerate one at a time?
Darren Oh's avatar
Darren Oh committed
175
 */
176
function xmlsitemap_cron() {
177 178 179 180 181
  // If cron sitemap file regeneration is disabled, stop.
  if (\Drupal::config('xmlsitemap.settings')->get('disable_cron_regeneration')) {
    return;
  }

182
  // If there were no new or changed links, skip.
183
  if (!\Drupal::state()->get('xmlsitemap_regenerate_needed')) {
184 185 186
    return;
  }

187 188 189 190 191
  // If cron sitemap file regeneration is disabled, stop.
  if (\Drupal::config('xmlsitemap.settings')->get('disable_cron_regeneration')) {
    return;
  }

192
  // If the minimum sitemap lifetime hasn't been passed, skip.
193
  $lifetime = REQUEST_TIME - \Drupal::state()->get('xmlsitemap_generated_last');
194
  if ($lifetime < \Drupal::config('xmlsitemap.settings')->get('minimum_lifetime')) {
195 196
    return;
  }
197
  xmlsitemap_xmlsitemap_index_links(\Drupal::config('xmlsitemap.settings')->get('batch_limit'));
198
  // Regenerate the sitemap XML files.
199
  xmlsitemap_run_unprogressive_batch('xmlsitemap_regenerate_batch');
Darren Oh's avatar
Darren Oh committed
200 201
}

202
/**
203
 * Implements hook_modules_installed().
204
 */
205
function xmlsitemap_modules_installed(array $modules) {
206
  Cache::invalidateTags(array('xmlsitemap'));
207 208 209
}

/**
210
 * Implements hook_modules_uninstalled().
211
 */
212
function xmlsitemap_modules_uninstalled(array $modules) {
213
  Cache::invalidateTags(array('xmlsitemap'));
214 215
}

Darren Oh's avatar
Darren Oh committed
216
/**
217
 * Implements hook_robotstxt().
Darren Oh's avatar
Darren Oh committed
218
 */
219
function xmlsitemap_robotstxt() {
220
  if ($sitemap = XmlSitemap::loadByContext()) {
221
    $uri = xmlsitemap_sitemap_uri($sitemap);
222
    $robotstxt[] = 'Sitemap: ' . Url::fromUri($uri['path'], $uri['options'])->toString();
223
    return $robotstxt;
224
  }
Darren Oh's avatar
Darren Oh committed
225 226
}

227
/**
228
 * Internal default variables config for xmlsitemap_var().
229 230 231
 *
 * @return array
 *   Array with config variables of xmlsitemap.settings config object.
232
 */
233
function xmlsitemap_config_variables() {
234
  return array(
235
    'minimum_lifetime' => 0,
236 237 238 239 240 241 242 243 244
    '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,
245
    'disable_cron_regeneration' => FALSE,
246 247 248
  );
}

249 250
/**
 * Internal default variables state for xmlsitemap_var().
251 252 253
 *
 * @return array
 *   Array with state variables defined by xmlsitemap module.
254 255 256
 */
function xmlsitemap_state_variables() {
  return array(
257 258 259 260
    'xmlsitemap_rebuild_needed' => FALSE,
    'xmlsitemap_regenerate_needed' => TRUE,
    'xmlsitemap_base_url' => '',
    'xmlsitemap_generated_last' => 0,
261 262
    'xmlsitemap_developer_mode' => 0,
    'max_chunks' => NULL,
263
    'max_filesize' => NULL,
264 265 266
  );
}

267 268 269 270 271 272
/**
 * Internal implementation of variable_get().
 */
function xmlsitemap_var($name, $default = NULL) {
  $defaults = &drupal_static(__FUNCTION__);
  if (!isset($defaults)) {
273 274
    $defaults = xmlsitemap_config_variables();
    $defaults += xmlsitemap_state_variables();
275 276
  }

277 278 279
  // @todo Remove when stable.
  if (!isset($defaults[$name])) {
    trigger_error(strtr('Default variable for %variable not found.', array('%variable' => drupal_placeholder($name))));
280 281
  }

282 283 284 285
  if (\Drupal::state()->get($name, NULL) === NULL) {
    return \Drupal::config('xmlsitemap.settings')->get($name);
  }
  return \Drupal::state()->get($name);
286 287
}

Darren Oh's avatar
Darren Oh committed
288
/**
289
 * @defgroup xmlsitemap_api XML sitemap API.
290
 * @{
291 292
 * 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
293
 */
294 295 296 297 298 299

/**
 * Load an XML sitemap array from the database.
 *
 * @param $smid
 *   An XML sitemap ID.
300 301 302
 *
 * @return
 *   The XML sitemap object.
303 304 305 306
 */
function xmlsitemap_sitemap_load($smid) {
  $sitemap = xmlsitemap_sitemap_load_multiple(array($smid));
  return $sitemap ? reset($sitemap) : FALSE;
Darren Oh's avatar
Darren Oh committed
307 308 309
}

/**
310 311 312
 * Load multiple XML sitemaps from the database.
 *
 * @param $smids
313 314 315
 *   An array of XML sitemap IDs, or FALSE to load all XML sitemaps.
 * @param $conditions
 *   An array of conditions in the form 'field' => $value.
316 317 318
 *
 * @return
 *   An array of XML sitemap objects.
Darren Oh's avatar
Darren Oh committed
319
 */
320 321 322 323
function xmlsitemap_sitemap_load_multiple($smids = array(), array $conditions = array()) {
  if ($smids !== FALSE) {
    $conditions['smid'] = $smids;
  }
324
  else {
325
    $conditions['smid'] = NULL;
326
  }
327
  $storage = Drupal::entityTypeManager()->getStorage('xmlsitemap');
328

329
  $sitemaps = $storage->loadMultiple($conditions['smid']);
330 331 332 333 334 335
  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
336
  }
337

338
  return $sitemaps;
339 340
}

Darren Oh's avatar
Darren Oh committed
341
/**
342
 * Save changes to an XML sitemap or add a new XML sitemap.
343
 *
344
 * @param $sitemap
345
 *   The XML sitemap array to be saved. If $sitemap->smid is omitted, a new
346 347 348
 *   XML sitemap will be added.
 *
 * @todo Save the sitemap's URL as a column?
Darren Oh's avatar
Darren Oh committed
349
 */
350
function xmlsitemap_sitemap_save(XmlSitemapInterface $sitemap) {
351
  $context = $sitemap->context;
352
  if (!isset($context) || !$context) {
353
    $sitemap->context = array();
354 355
  }

356
  // Make sure context is sorted before saving the hash.
357
  $sitemap->setOriginalId($sitemap->isNew() ? NULL : $sitemap->getId());
358
  $sitemap->setId(xmlsitemap_sitemap_get_context_hash($context));
359
  // If the context was changed, we need to perform additional actions.
360
  if (!$sitemap->isNew() && $sitemap->getId() != $sitemap->getOriginalId()) {
361
    // Rename the files directory so the sitemap does not break.
362
    $old_sitemap = (object) array('smid' => $sitemap->old_smid);
363
    $old_dir = xmlsitemap_get_directory($old_sitemap);
364 365 366 367
    $new_dir = xmlsitemap_get_directory($sitemap);
    xmlsitemap_directory_move($old_dir, $new_dir);

    // Mark the sitemaps as needing regeneration.
368
    \Drupal::state()->set('xmlsitemap_regenerate_needed', TRUE);
369
  }
370
  $sitemap->save();
371 372

  return $sitemap;
373 374 375
}

/**
376
 * Delete an XML sitemap.
377
 *
378
 * @param string $smid
379
 *   An XML sitemap ID.
380
 */
381 382
function xmlsitemap_sitemap_delete($smid) {
  xmlsitemap_sitemap_delete_multiple(array($smid));
383 384
}

Darren Oh's avatar
Darren Oh committed
385
/**
386
 * Delete multiple XML sitemaps.
387
 *
388
 * @param array $smids
389
 *   An array of XML sitemap IDs.
Darren Oh's avatar
Darren Oh committed
390
 */
391 392 393 394 395
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);
396
      $sitemap->delete();
397
      \Drupal::moduleHandler()->invokeAll('xmlsitemap_sitemap_delete', array($sitemap));
398
    }
399
  }
400
}
401

402 403 404 405
/**
 * Return the expected file path for a specific sitemap chunk.
 *
 * @param $sitemap
406
 *   An XmlSitemapInterface sitemap object.
407 408
 * @param $chunk
 *   An optional specific chunk in the sitemap. Defaults to the index page.
409 410 411
 *
 * @return string
 *   File path for a specific sitemap chunk.
412
 */
413
function xmlsitemap_sitemap_get_file(XmlSitemapInterface $sitemap, $chunk = 'index') {
414
  return xmlsitemap_get_directory($sitemap) . "/{$chunk}.xml";
Darren Oh's avatar
Darren Oh committed
415 416
}

417 418 419
/**
 * Find the maximum file size of all a sitemap's XML files.
 *
420 421
 * @param \Drupal\xmlsitemap\XmlSitemapInterface $sitemap
 *   The XML sitemap object.
422
 */
423
function xmlsitemap_sitemap_get_max_filesize(XmlSitemapInterface $sitemap) {
424
  $dir = xmlsitemap_get_directory($sitemap);
425
  $sitemap->setMaxFileSize(0);
426
  foreach (file_scan_directory($dir, '/\.xml$/') as $file) {
427
    $sitemap->setMaxFileSize(max($sitemap->getMaxFileSize(), filesize($file->uri)));
428
  }
429
  return $sitemap->getMaxFileSize();
430 431
}

432 433 434 435 436 437 438 439
/**
 * Returns the hash string for a context.
 *
 * @param array $context
 *   Context to be hashed.
 * @return string
 *   Hash string for the context.
 */
440 441
function xmlsitemap_sitemap_get_context_hash(array &$context) {
  asort($context);
442
  return Crypt::hashBase64(serialize($context));
443 444
}

Darren Oh's avatar
Darren Oh committed
445
/**
446
 * Returns the uri elements of an XML sitemap.
447
 *
448 449
 * @param \Drupal\xmlsitemap\XmlSitemapInterface $sitemap
 *   The sitemap represented by and XmlSitemapInterface object.
450
 * @return
451 452
 *   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
453
 */
454
function xmlsitemap_sitemap_uri(XmlSitemapInterface $sitemap) {
455
  $uri['path'] = 'sitemap.xml';
456 457
  $uri['options'] = \Drupal::moduleHandler()->invokeAll('xmlsitemap_context_url_options', array($sitemap->context));
  $context = $sitemap->context;
458
  \Drupal::moduleHandler()->alter('xmlsitemap_context_url_options', $uri['options'], $context);
459 460
  $uri['options'] += array(
    'absolute' => TRUE,
461
    'base_url' => \Drupal::state()->get('xmlsitemap_base_url'),
462 463 464
  );
  return $uri;
}
465

Darren Oh's avatar
Darren Oh committed
466
/**
467
 * @} End of "defgroup xmlsitemap_api"
468
 */
469
function xmlsitemap_get_directory(XmlSitemapInterface $sitemap = NULL) {
470 471
  $directory = &drupal_static(__FUNCTION__);
  if (!isset($directory)) {
472
    $directory = \Drupal::config('xmlsitemap.settings')->get('path');
Darren Oh's avatar
Darren Oh committed
473
  }
474

475
  if ($sitemap != NULL && !empty($sitemap->id)) {
476
    return file_build_uri($directory . '/' . $sitemap->id);
477 478 479 480
  }
  else {
    return file_build_uri($directory);
  }
Darren Oh's avatar
Darren Oh committed
481 482 483
}

/**
484
 * Check that the sitemap files directory exists and is writable.
Darren Oh's avatar
Darren Oh committed
485
 */
486
function xmlsitemap_check_directory(XmlSitemapInterface $sitemap = NULL) {
487 488 489
  $directory = xmlsitemap_get_directory($sitemap);
  $result = file_prepare_directory($directory, FILE_CREATE_DIRECTORY | FILE_MODIFY_PERMISSIONS);
  if (!$result) {
490
    \Drupal::logger('file system')->error('The directory %directory does not exist or is not writable.', array('%directory' => $directory));
491 492 493 494
  }
  return $result;
}

495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516
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;
}

517 518 519 520 521 522 523 524 525 526 527
/**
 * 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.
 */
528
function xmlsitemap_clear_directory(XmlSitemapInterface $sitemap = NULL, $delete = FALSE) {
529 530 531 532
  $directory = xmlsitemap_get_directory($sitemap);
  return _xmlsitemap_delete_recursive($directory, $delete);
}

533 534 535
/**
 * Move a directory to a new location.
 *
536
 * @param string $old_dir
537
 *   A string specifying the filepath or URI of the original directory.
538
 * @param string $new_dir
539
 *   A string specifying the filepath or URI of the new directory.
540
 * @param int $replaceReplace behavior when the destination file already exists.
541 542
 *   Replace behavior when the destination file already exists.
 *
543
 * @return bool
544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565
 *   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;
}

566 567 568
/**
 * Recursively delete all files and folders in the specified filepath.
 *
569
 * This is a backport of Drupal 8's file_unmanaged_delete_recursive().
570 571 572
 *
 * Note that this only deletes visible files with write permission.
 *
573
 * @param string $path
574
 *   A filepath relative to the Drupal root directory.
575
 * @param bool $delete_root
576
 *   A boolean if TRUE will delete the $path directory afterwards.
577 578 579
 *
 * @return bool
 *   TRUE if operation was successful, FALSE otherwise.
580 581 582 583 584 585 586 587 588 589 590
 */
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;
591
      file_unmanaged_delete_recursive($entry_path, NULL);
592 593
    }
    $dir->close();
594
    return $delete_root ? drupal_rmdir($path) : TRUE;
595 596
  }
  return file_unmanaged_delete($path);
Darren Oh's avatar
Darren Oh committed
597 598 599
}

/**
600 601 602 603 604 605 606 607 608
 * 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.
 *
609 610 611
 * @return array
 *   Info about sitemap link.
 *
612 613
 * @see hook_xmlsitemap_link_info()
 * @see hook_xmlsitemap_link_info_alter()
Darren Oh's avatar
Darren Oh committed
614
 */
615
function xmlsitemap_get_link_info($type = NULL, $reset = FALSE) {
616
  $language = \Drupal::languageManager()->getCurrentLanguage();
617
  $link_info = &drupal_static(__FUNCTION__);
618

619 620
  if ($reset) {
    $link_info = NULL;
621 622 623
    foreach (\Drupal::languageManager()->getLanguages() as $lang) {
      \Drupal::cache()->delete('xmlsitemap:link_info:' . $lang->getId());
    }
624 625
  }

626
  if (!isset($link_info)) {
627
    $cid = 'xmlsitemap:link_info:' . $language->getId();
628
    if ($cache = \Drupal::cache()->get($cid)) {
629
      $link_info = $cache->data;
630
    }
631
    else {
632
      \Drupal::entityTypeManager()->clearCachedDefinitions();
633
      $link_info = array();
634
      $entity_types = \Drupal::entityTypeManager()->getDefinitions();
635 636 637 638 639
      foreach ($entity_types as $key => $entity_type) {
        $link_info[$key] = array(
          'label' => $entity_type->getLabel(),
          'type' => $entity_type->id(),
          'base table' => $entity_type->getBaseTable(),
640
          'bundles' => \Drupal::service('entity_type.bundle.info')->getBundleInfo($entity_type->id()),
641 642 643
        );
        $uri_callback = $entity_type->getUriCallback();
        if (empty($uri_callback) || !isset($entity_type->xmlsitemap)) {
644 645
          // Remove any non URL-able or XML sitemap un-supported entites.
        }
646
        foreach (\Drupal::service('entity_type.bundle.info')->getBundleInfo($entity_type->id()) as $bundle_key => $bundle) {
647 648 649 650
          if (!isset($bundle['xmlsitemap'])) {
            // Remove any un-supported entity bundles.
          }
        }
651
      }
652
      $link_info = array_merge($link_info, \Drupal::moduleHandler()->invokeAll('xmlsitemap_link_info'));
653 654 655 656 657
      foreach ($link_info as $key => &$info) {
        $info += array(
          'type' => $key,
          'base table' => FALSE,
          'bundles' => array(),
658 659 660
          'xmlsitemap' => [
            'process callback' => 'xmlsitemap_xmlsitemap_process_entity_links',
          ],
661
        );
662
        if (!isset($info['xmlsitemap']['rebuild callback']) && !empty($info['base table']) && $entity_types[$key]->getKey('id')) {
663 664 665 666 667 668 669 670
          $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);
        }
671
      }
672
      \Drupal::moduleHandler()->alter('xmlsitemap_link_info', $link_info);
673 674
      ksort($link_info);
      // Cache by language since this info contains translated strings.
675
      \Drupal::cache()->set($cid, $link_info, Cache::PERMANENT, array('xmlsitemap'));
676
    }
Darren Oh's avatar
Darren Oh committed
677
  }
678 679 680 681 682 683

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

  return $link_info;
Darren Oh's avatar
Darren Oh committed
684 685
}

686 687 688 689 690 691 692 693 694
/**
 * Returns enabled bundles of an entity type.
 *
 * @param string $entity_type
 *   Entity type id.
 *
 * @return array
 *   Array with entity bundles info.
 */
695 696 697 698
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) {
699
    $settings = xmlsitemap_link_bundle_load($entity_type, $bundle);
700
    if (!empty($settings['status'])) {
701 702 703 704 705 706
      $bundles[] = $bundle;
    }
  }
  return $bundles;
}

707 708 709
/**
 * Returns statistics about specific entity links.
 *
710
 * @param string $entity_type_id
711 712
 *   Entity type id.
 * @param string $bundle
713
 *   Bundle id.
714 715 716 717
 *
 * @return array
 *   Array with statistics.
 */
718 719 720
function xmlsitemap_get_link_type_indexed_status($entity_type_id, $bundle = '') {
  $info = xmlsitemap_get_link_info($entity_type_id);
  $entity_type = \Drupal::entityTypeManager()->getDefinition($entity_type_id);
721

722 723
  $status['indexed'] = db_query("SELECT COUNT(id) FROM {xmlsitemap} WHERE type = :entity AND subtype = :bundle", array(':entity' => $entity_type_id, ':bundle' => $bundle))->fetchField();
  $status['visible'] = db_query("SELECT COUNT(id) FROM {xmlsitemap} WHERE type = :entity AND subtype = :bundle AND status = 1 AND access = 1", array(':entity' => $entity_type_id, ':bundle' => $bundle))->fetchField();
724

725
  try {
726 727 728 729 730 731 732 733 734 735 736 737 738
    $query = \Drupal::entityQuery($entity_type_id);

    if ($bundle) {
      $query->condition($entity_type->getKey('bundle'), $bundle, '=');
    }

    $query->addTag('xmlsitemap_link_bundle_access');
    $query->addTag('xmlsitemap_link_indexed_status');
    $query->addMetaData('entity_type_id', $entity_type_id);
    $query->addMetaData('bundle', $bundle);
    $query->addMetaData('entity_info', $info);
    $query->count();
    $status['total'] = $query->execute();
739 740
    return $status;
  }
741
  catch (\Exception $e) {
742 743
    $status['total'] = 0;
  }
744 745
  return $status;
}
746

747 748 749 750 751 752 753 754 755 756 757 758 759 760 761
/**
 * Saves xmlsitemap settings for a specific bundle.
 *
 * @param string $entity
 *   Entity type id.
 * @param string $bundle
 *   Bundle id.
 * @param array $settings
 *   Settings to be saved.
 * @param bool $update_links
 *   Update bundle links after settings are saved.
 *
 * @return array
 *   Info about sitemap link.
 */
762 763
function xmlsitemap_link_bundle_settings_save($entity, $bundle, array $settings, $update_links = TRUE) {
  if ($update_links) {
764
    $old_settings = xmlsitemap_link_bundle_load($entity, $bundle);
765
    if ($settings['status'] != $old_settings['status']) {
766
      \Drupal::service('xmlsitemap.link_storage')->updateMultiple(array('status' => $settings['status']), array('type' => $entity, 'subtype' => $bundle, 'status_override' => 0));
767 768
    }
    if ($settings['priority'] != $old_settings['priority']) {
769
      \Drupal::service('xmlsitemap.link_storage')->updateMultiple(array('priority' => $settings['priority']), array('type' => $entity, 'subtype' => $bundle, 'priority_override' => 0));
770 771 772
    }
  }

773
  foreach ($settings as $key => $value) {
774
    \Drupal::configFactory()->getEditable("xmlsitemap.settings.{$entity}.{$bundle}")->set($key, $value)->save();
775 776
  }

777
  foreach (\Drupal::languageManager()->getLanguages() as $lang) {
778
    \Drupal::cache()->delete('xmlsitemap:link_info:' . $lang->getId());
779 780
  }
  xmlsitemap_get_link_info(NULL, TRUE);
781 782
}

783 784 785 786 787 788 789 790 791 792
/**
 * Renames a bundle.
 *
 * @param string $entity
 *   Entity type id.
 * @param string $bundle_old
 *   Old bundle name.
 * @param string $bundle_new
 *   New bundle name.
 */
793 794
function xmlsitemap_link_bundle_rename($entity, $bundle_old, $bundle_new) {
  if ($bundle_old != $bundle_new) {
795 796
    if (!\Drupal::config("xmlsitemap.settings.{$entity}.{$bundle_old}")->isNew()) {
      $settings = xmlsitemap_link_bundle_load($entity, $bundle_old);
797
      \Drupal::configFactory()->getEditable("xmlsitemap.settings.{$entity}.{$bundle_old}")->delete();
798 799 800
      xmlsitemap_link_bundle_settings_save($entity, $bundle_new, $settings, FALSE);
      \Drupal::service('xmlsitemap.link_storage')->updateMultiple(array('subtype' => $bundle_new), array('type' => $entity, 'subtype' => $bundle_old));
    }
801 802 803
  }
}

804
/**
805 806 807 808
 * Renames a link type.
 *
 * @param string $entity_old
 *   Old entity type id.
809
 * @param string or int or object... $entity_newNew entity type id.
810 811 812
 *   New entity type id.
 * @param array $bundles
 *   Bundles to be updated.
813 814
 */
function xmlsitemap_link_type_rename($entity_old, $entity_new, $bundles = NULL) {
815 816 817 818 819
  $variables = \Drupal::config('xmlsitemap.settings')->get();
  foreach ($variables as $key => $value) {
    if (!strpos($key, "xmlsitemap_settings_{$entity_old}") && !strpos($key, "xmlsitemap_entity_{$entity_old}")) {
      continue;
    }
820
    \Drupal::configFactory()->getEditable('xmlsitemap.settings')->clear($key);
821
    if (isset($value)) {
822
      $variable_new = str_replace('xmlsitemap_settings_' . $entity_old, 'xmlsitemap_settings_' . $entity_new, $key);
823
      \Drupal::configFactory()->getEditable('xmlsitemap.settings')->set($variable_new, $value)->save();
824 825 826
    }
  }

827
  \Drupal::service('xmlsitemap.link_storage')->updateMultiple(array('type' => $entity_new), array('type' => $entity_old), FALSE);
828 829 830
  xmlsitemap_get_link_info(NULL, TRUE);
}

831 832 833 834 835 836 837 838 839 840 841 842
/**
 * Loads link bundle info.
 *
 * @param string $entity
 *   Entity type id.
 * @param string $bundle
 *   Bundle info.
 * @param bool $load_bundle_info
 *   If TRUE, loads bundle info.
 * @return array
 *   Info about a bundle.
 */
843 844 845 846 847 848 849
function xmlsitemap_link_bundle_load($entity, $bundle, $load_bundle_info = TRUE) {
  $info = array(
    'entity' => $entity,
    'bundle' => $bundle,
  );
  if ($load_bundle_info) {
    $entity_info = xmlsitemap_get_link_info($entity);
850 851 852
    if (isset($entity_info['bundles'][$bundle])) {
      $info['info'] = $entity_info['bundles'][$bundle];
    }
853
  }
854
  $bundle_settings = \Drupal::config("xmlsitemap.settings.{$entity}.{$bundle}")->get();
855 856 857
  if ($bundle_settings) {
    $info += $bundle_settings;
  }
858 859 860
  $info += array(
    'status' => XMLSITEMAP_STATUS_DEFAULT,
    'priority' => XMLSITEMAP_PRIORITY_DEFAULT,
861
    'changefreq' => 0,
862 863
  );
  return $info;
864 865
}

866 867 868 869 870 871 872 873 874 875
/**
 * Deletes all links of a specific bundle.
 *
 * @param string $entity
 *   Entity type id.
 * @param string $bundle
 *   Bundle id.
 * @param bool $delete_links
 *   If TRUE, deletes bundle links from {xmlsitemap} table.
 */
876
function xmlsitemap_link_bundle_delete($entity, $bundle, $delete_links = TRUE) {
877
  \Drupal::configFactory()->getEditable("xmlsitemap.settings.{$entity}.{$bundle}")->delete();
878
  if ($delete_links) {
879
    \Drupal::service('xmlsitemap.link_storage')->deleteMultiple(array('type' => $entity, 'subtype' => $bundle));
880
  }
881
  xmlsitemap_get_link_info(NULL, TRUE);
882 883
}

884 885 886 887 888 889 890 891 892 893
/**
 * Checks access for a bundle.
 *
 * @param string $entity
 *   Entity type id.
 * @param string $bundle
 *   Bundle id.
 * @return bool
 *   If TRUE, access is allowed, FALSE otherwise.
 */
894 895 896 897 898 899 900
function xmlsitemap_link_bundle_access($entity, $bundle = NULL) {
  if (is_array($entity) && !isset($bundle)) {
    $bundle = $entity;
  }
  else {
    $bundle = xmlsitemap_link_bundle_load($entity, $bundle);
  }
901

902 903
  if (isset($bundle['info']['admin'])) {
    $admin = $bundle['info']['admin'];
904 905 906 907 908 909 910 911
    $admin += array('access arguments' => array());

    if (!isset($admin['access callback']) && count($admin['access arguments']) == 1) {
      $admin['access callback'] = 'user_access';
    }

    if (!empty($admin['access callback'])) {
      return call_user_func_array($admin['access callback'], $admin['access arguments']);
912 913 914 915 916
    }
  }

  return FALSE;
}