xmlsitemap.module 79.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
use Drupal\Component\Utility\SafeMarkup;
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\Url;
26
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
27
use Symfony\Component\HttpFoundation\Response;
28
use Drupal\Component\Utility\Unicode;
29 30 31 32

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

35 36 37
/**
 * The maximum filesize of a sitemap chunk file.
 */
38
const XMLSITEMAP_MAX_SITEMAP_FILESIZE = 10485760;
39

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

55 56 57
/**
 * Short lastmod timestamp format.
 */
58
const XMLSITEMAP_LASTMOD_SHORT = 'Y-m-d';
59 60 61 62

/**
 * Medium lastmod timestamp format.
 */
63
const XMLSITEMAP_LASTMOD_MEDIUM = 'Y-m-d\TH:i\Z';
64 65 66 67

/**
 * Long lastmod timestamp format.
 */
68
const XMLSITEMAP_LASTMOD_LONG = 'c';
69

70 71 72
/**
 * The default inclusion status for link types in the sitemaps.
 */
73
const XMLSITEMAP_STATUS_DEFAULT = 0;
74 75 76 77

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

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

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

108 109 110
  return $hooks;
}

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

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

125
    case 'xmlsitemap.admin_search':
126
      break;
127

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

131
    case 'xmlsitemap.admin_rebuild':
132 133 134
      $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>';
  }

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

  return $output;
}

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

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

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

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

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

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

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

/**
207
 * Implements hook_modules_uninstalled().
208
 */
209
function xmlsitemap_modules_uninstalled(array $modules) {
210
  Cache::invalidateTags(array('xmlsitemap'));
211 212
}

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

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

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

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

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

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

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

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

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

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

336
  return $sitemaps;
337 338
}

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

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

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

  return $sitemap;
371 372 373
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  return $link_info;
Darren Oh's avatar
Darren Oh committed
682 683
}

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

705 706 707
/**
 * Returns statistics about specific entity links.
 *
708
 * @param string $entity_type_id
709 710
 *   Entity type id.
 * @param string $bundle
711
 *   Bundle id.
712 713 714 715
 *
 * @return array
 *   Array with statistics.
 */
716 717 718
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);
719

720 721
  $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();
722

723
  try {
724 725 726 727 728 729 730 731 732 733 734 735 736
    $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();
737 738
    return $status;
  }
739
  catch (\Exception $e) {
740 741
    $status['total'] = 0;
  }
742 743
  return $status;
}
744

745 746 747 748 749 750 751 752 753 754 755 756 757 758 759
/**
 * 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.
 */
760 761
function xmlsitemap_link_bundle_settings_save($entity, $bundle, array $settings, $update_links = TRUE) {
  if ($update_links) {
762
    $old_settings = xmlsitemap_link_bundle_load($entity, $bundle);
763
    if ($settings['status'] != $old_settings['status']) {
764
      \Drupal::service('xmlsitemap.link_storage')->updateMultiple(array('status' => $settings['status']), array('type' => $entity, 'subtype' => $bundle, 'status_override' => 0));
765 766
    }
    if ($settings['priority'] != $old_settings['priority']) {
767
      \Drupal::service('xmlsitemap.link_storage')->updateMultiple(array('priority' => $settings['priority']), array('type' => $entity, 'subtype' => $bundle, 'priority_override' => 0));
768 769 770
    }
  }

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

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

781 782 783 784 785 786 787 788 789 790
/**
 * Renames a bundle.
 *
 * @param string $entity
 *   Entity type id.
 * @param string $bundle_old
 *   Old bundle name.
 * @param string $bundle_new
 *   New bundle name.
 */
791 792
function xmlsitemap_link_bundle_rename($entity, $bundle_old, $bundle_new) {
  if ($bundle_old != $bundle_new) {
793 794
    if (!\Drupal::config("xmlsitemap.settings.{$entity}.{$bundle_old}")->isNew()) {
      $settings = xmlsitemap_link_bundle_load($entity, $bundle_old);
795
      \Drupal::configFactory()->getEditable("xmlsitemap.settings.{$entity}.{$bundle_old}")->delete();
796 797 798
      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));
    }
799 800 801
  }
}

802
/**
803 804 805 806
 * Renames a link type.
 *
 * @param string $entity_old
 *   Old entity type id.
807
 * @param string or int or object... $entity_newNew entity type id.
808 809 810
 *   New entity type id.
 * @param array $bundles
 *   Bundles to be updated.
811 812
 */
function xmlsitemap_link_type_rename($entity_old, $entity_new, $bundles = NULL) {
813 814 815 816 817
  $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;
    }
818
    \Drupal::configFactory()->getEditable('xmlsitemap.settings')->clear($key);
819
    if (isset($value)) {
820
      $variable_new = str_replace('xmlsitemap_settings_' . $entity_old, 'xmlsitemap_settings_' . $entity_new, $key);
821
      \Drupal::configFactory()->getEditable('xmlsitemap.settings')->set($variable_new, $value)->save();
822 823 824
    }
  }

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

829 830 831 832 833 834 835 836 837 838 839 840
/**
 * 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.
 */
841 842 843 844 845 846 847
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);
848 849 850
    if (isset($entity_info['bundles'][$bundle])) {
      $info['info'] = $entity_info['bundles'][$bundle];
    }
851
  }
852
  $bundle_settings = \Drupal::config("xmlsitemap.settings.{$entity}.{$bundle}")->get();
853 854 855
  if ($bundle_settings) {
    $info += $bundle_settings;
  }
856 857 858
  $info += array(
    'status' => XMLSITEMAP_STATUS_DEFAULT,
    'priority' => XMLSITEMAP_PRIORITY_DEFAULT,
859
    'changefreq' => 0,
860 861
  );
  return $info;
862 863
}

864 865 866 867 868 869 870 871 872 873
/**
 * 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.
 */
874
function xmlsitemap_link_bundle_delete($entity, $bundle, $delete_links = TRUE) {
875
  \Drupal::configFactory()->getEditable("xmlsitemap.settings.{$entity}.{$bundle}")->delete();
876
  if ($delete_links) {
877
    \Drupal::service('xmlsitemap.link_storage')->deleteMultiple(array('type' => $entity, 'subtype' => $bundle));
878
  }
879
  xmlsitemap_get_link_info(NULL, TRUE);
880 881
}

882 883 884 885 886 887 888 889 890 891
/**
 * 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.
 */
892 893 894 895 896 897 898
function xmlsitemap_link_bundle_access($entity, $bundle = NULL) {
  if (is_array($entity) && !isset($bundle)) {
    $bundle = $entity;
  }
  else {
    $bundle = xmlsitemap_link_bundle_load($entity, $bundle);
  }
899

900 901
  if (isset($bundle['info']['admin'])) {
    $admin = $bundle['info']['admin'];
902 903 904 905 906 907 908 909
    $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']);
910 911 912 913 914
    }
  }

  return FALSE;
}