xmlsitemap.module 80.3 KB
Newer Older
Darren Oh's avatar
Darren Oh committed
1 2 3
<?php

/**
4
 * @defgroup xmlsitemap XML sitemap
Darren Oh's avatar
Darren Oh committed
5 6 7
 */

/**
8 9 10
 * @file
 * Main file for the xmlsitemap module.
 */
11
use 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 Drupal\Core\Cache\Cache;
23
use Drupal\Core\Form\FormStateInterface;
24
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
25
use Symfony\Component\HttpFoundation\Response;
26 27 28 29

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

32 33 34
/**
 * The maximum filesize of a sitemap chunk file.
 */
35
const XMLSITEMAP_MAX_SITEMAP_FILESIZE = 10485760;
36

37 38 39 40 41 42 43 44 45
/**
 * 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;
46

47 48 49
/**
 * Short lastmod timestamp format.
 */
50
const XMLSITEMAP_LASTMOD_SHORT = 'Y-m-d';
51 52 53 54

/**
 * Medium lastmod timestamp format.
 */
55
const XMLSITEMAP_LASTMOD_MEDIUM = 'Y-m-d\TH:i\Z';
56 57 58 59

/**
 * Long lastmod timestamp format.
 */
60
const XMLSITEMAP_LASTMOD_LONG = 'c';
61

62 63 64
/**
 * The default inclusion status for link types in the sitemaps.
 */
65
const XMLSITEMAP_STATUS_DEFAULT = 0;
66 67 68 69

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

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

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

100 101 102
  return $hooks;
}

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

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

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

  return $output;
}

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

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

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

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

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

188
/**
189
 * Implements hook_modules_installed().
190
 */
191 192
function xmlsitemap_modules_installed(array $modules) {
  \Drupal::cache()->deleteTags(array('xmlsitemap'));
193 194 195
}

/**
196
 * Implements hook_modules_uninstalled().
197
 */
198 199
function xmlsitemap_modules_uninstalled(array $modules) {
  \Drupal::cache()->deleteTags(array('xmlsitemap'));
200 201
}

Darren Oh's avatar
Darren Oh committed
202
/**
203
 * Implements hook_robotstxt().
Darren Oh's avatar
Darren Oh committed
204
 */
205
function xmlsitemap_robotstxt() {
206 207
  $sitemap_storage = \Drupal::entityManager()->getStorage('xmlsitemap');
  if ($sitemap = $sitemap_storage->loadByContext()) {
208 209
    $uri = xmlsitemap_sitemap_uri($sitemap);
    $robotstxt[] = 'Sitemap: ' . url($uri['path'], $uri['options']);
210
    return $robotstxt;
211
  }
Darren Oh's avatar
Darren Oh committed
212 213
}

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

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

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

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

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

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

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

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

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

329
  return $sitemaps;
330 331
}

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

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

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

  return $sitemap;
364 365 366
}

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

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

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

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

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

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

Darren Oh's avatar
Darren Oh committed
457
/**
458
 * @} End of "defgroup xmlsitemap_api"
459
 */
460
function xmlsitemap_get_directory(XmlSitemapInterface $sitemap = NULL) {
461 462
  $directory = &drupal_static(__FUNCTION__);
  if (!isset($directory)) {
463
    $directory = \Drupal::config('xmlsitemap.settings')->get('path');
Darren Oh's avatar
Darren Oh committed
464
  }
465

466
  if ($sitemap != NULL && !empty($sitemap->id)) {
467
    return file_build_uri($directory . '/' . $sitemap->id);
468 469 470 471
  }
  else {
    return file_build_uri($directory);
  }
Darren Oh's avatar
Darren Oh committed
472 473 474
}

/**
475
 * Check that the sitemap files directory exists and is writable.
Darren Oh's avatar
Darren Oh committed
476
 */
477
function xmlsitemap_check_directory(XmlSitemapInterface $sitemap = NULL) {
478 479 480 481 482 483 484 485
  $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;
}

486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507
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;
}

508 509 510 511 512 513 514 515 516 517 518
/**
 * 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.
 */
519
function xmlsitemap_clear_directory(XmlSitemapInterface $sitemap = NULL, $delete = FALSE) {
520 521 522 523
  $directory = xmlsitemap_get_directory($sitemap);
  return _xmlsitemap_delete_recursive($directory, $delete);
}

524 525 526
/**
 * Move a directory to a new location.
 *
527
 * @param string $old_dir
528
 *   A string specifying the filepath or URI of the original directory.
529
 * @param string $new_dir
530
 *   A string specifying the filepath or URI of the new directory.
531
 * @param integer $replace
532 533
 *   Replace behavior when the destination file already exists.
 *
534
 * @return bool
535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556
 *   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;
}

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

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

610 611
  if ($reset) {
    $link_info = NULL;
612 613 614
    foreach (\Drupal::languageManager()->getLanguages() as $lang) {
      \Drupal::cache()->delete('xmlsitemap:link_info:' . $lang->getId());
    }
615 616
  }

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

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

  return $link_info;
Darren Oh's avatar
Darren Oh committed
673 674
}

675 676 677 678 679 680 681 682 683
/**
 * Returns enabled bundles of an entity type.
 *
 * @param string $entity_type
 *   Entity type id.
 *
 * @return array
 *   Array with entity bundles info.
 */
684 685 686 687
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) {
688
    $settings = xmlsitemap_link_bundle_load($entity_type, $bundle);
689
    if (!empty($settings['status'])) {
690 691 692 693 694 695
      $bundles[] = $bundle;
    }
  }
  return $bundles;
}

696 697 698 699 700 701 702 703 704 705 706
/**
 * Returns statistics about specific entity links.
 *
 * @param string $entity_type
 *   Entity type id.
 * @param string $bundle
 *   Bundle id;
 *
 * @return array
 *   Array with statistics.
 */
707 708 709
function xmlsitemap_get_link_type_indexed_status($entity_type, $bundle = '') {
  $info = xmlsitemap_get_link_info($entity_type);

710 711
  $status['indexed'] = db_query("SELECT COUNT(id) FROM {xmlsitemap} WHERE type = :entity AND subtype = :bundle", array(':entity' => $entity_type, ':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, ':bundle' => $bundle))->fetchField();
712

713 714 715 716 717 718 719 720 721 722 723 724 725 726
  try {
    $entity_query_object = \Drupal::entityQuery($entity_type);
    $entity_query_object->addTag('xmlsitemap_link_bundle_access');
    $entity_query_object->addTag('xmlsitemap_link_indexed_status');
    $entity_query_object->addMetaData('entity', $entity_type);
    $entity_query_object->addMetaData('type', $bundle);
    $entity_query_object->addMetaData('entity_info', $info);
    $entity_query_object->count();
    $status['total'] = $entity_query_object->execute();
    return $status;
  }
  catch (Exception $e) {
    $status['total'] = 0;
  }
727 728
  return $status;
}
729

730 731 732 733 734 735 736 737 738 739 740 741 742 743
/**
 * Implements hook_entity_query_alter().
 *
 * @todo Remove when http://drupal.org/node/1054168 is fixed.
 */
function xmlsitemap_entity_query_alter($query) {
  $conditions = &$query->entityConditions;

  // Alter user entity queries only.
  if (isset($conditions['entity_type']) && $conditions['entity_type']['value'] == 'user' && isset($conditions['bundle'])) {
    unset($conditions['bundle']);
  }
}

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

770
  \Drupal::config('xmlsitemap.settings')->set("xmlsitemap_settings_{$entity}_{$bundle}", $settings)->save();
771
  foreach (\Drupal::languageManager()->getLanguages() as $lang) {
772
    \Drupal::cache()->delete('xmlsitemap:link_info:' . $lang->getId());
773 774
  }
  xmlsitemap_get_link_info(NULL, TRUE);
775 776
}

777 778 779 780 781 782 783 784 785 786
/**
 * Renames a bundle.
 *
 * @param string $entity
 *   Entity type id.
 * @param string $bundle_old
 *   Old bundle name.
 * @param string $bundle_new
 *   New bundle name.
 */
787 788
function xmlsitemap_link_bundle_rename($entity, $bundle_old, $bundle_new) {
  if ($bundle_old != $bundle_new) {
789
    $settings = xmlsitemap_link_bundle_load($entity, $bundle_old);
790 791 792 793
    \Drupal::config('xmlsitemap.settings')->clear("xmlsitemap_settings_{$entity}_{$bundle_old}");
    $old_bundle_value = \Drupal::config('xmlsitemap.settings')->get("xmlsitemap_entity_{$entity}_bundle_{$bundle_old}");
    \Drupal::config('xmlsitemap.settings')->clear("xmlsitemap_entity_{$entity}_bundle_{$bundle_old}");
    \Drupal::config('xmlsitemap.settings')->set("xmlsitemap_entity_{$entity}_bundle_{$bundle_new}", $old_bundle_value)->save();
794
    xmlsitemap_link_bundle_settings_save($entity, $bundle_new, $settings, FALSE);
795
    \Drupal::service('xmlsitemap.link_storage')->updateMultiple(array('subtype' => $bundle_new), array('type' => $entity, 'subtype' => $bundle_old));
796 797 798
  }
}

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

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

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

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

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

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

  return FALSE;
}
913

914 915 916 917 918 919 920 921 922 923 924
/**
 * Get path of a bundle.
 *
 * @param string $entity
 *   Entity type id.
 * @param string $bundle
 *   Bundle id.
 *
 * @return
 *   Path of bundle, or FALSE if it does not exist.
 */
925 926 927 928 929 930 931 932 933 934 935 936 937
function xmlsitemap_get_bundle_path($entity, $bundle) {
  $info = xmlsitemap_get_link_info($entity);

  if (!empty($info['bundles'][$bundle]['admin']['real path'])) {
    return $info['bundles'][$bundle]['admin']['real path'];
  }
  elseif (!empty($info['bundles'][$bundle]['admin']['path'])) {
    return $info['bundles'][$bundle]['admin']['path'];
  }
  else {
    return FALSE;
  }
}
938

939
/**
940
 * Implements hook_entity_bundle_rename().
941
 */
942 943
function xmlsitemap_entity_bundle_rename($entity_type_id, $bundle_old, $bundle_new) {
  xmlsitemap_link_bundle_rename($entity_type_id, $bundle_old, $bundle_new);
944 945 946
}

/**
947
 * Implements hook_entity_bundle_delete().
948
 */
949
function xmlsitemap_entity_bundle_delete($entity_type, $bundle, $instances) {
950 951 952
  xmlsitemap_link_bundle_delete($entity_type, $bundle, TRUE);
}

953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977
/**
 * Determine the frequency of updates to a link.
 *
 * @param $interval
 *   An interval value in seconds.
 * @return
 *   A string representing the update frequency according to the sitemaps.org
 *   protocol.
 */
function xmlsitemap_get_changefreq($interval) {
  if ($interval <= 0 || !is_numeric($interval)) {
    return FALSE;
  }

  foreach (xmlsitemap_get_changefreq_options() as $value => $frequency) {
    if ($interval <= $value) {
      return $frequency;
    }
  }

  return 'never';
}

/**
 * Get the current number of sitemap chunks.
978 979 980 981 982 983 984 985
 *
 * @static int $chunks
 *   Number of chunks.
 * @param int $reset
 *   If TRUE, reset number of chunks.
 *
 * @return integer
 *   Number of chunks.