xmlsitemap.module 80.9 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\Entity\Query\QueryException;
23
use Drupal\Core\Cache\Cache;
24
use Drupal\Core\Form\FormStateInterface;
25
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
26
use Symfony\Component\HttpFoundation\Response;
27 28 29 30

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

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

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

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

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

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

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

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

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

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

101 102 103
  return $hooks;
}

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

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

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

  return $output;
}

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

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
  // If there were no new or changed links, skip.
175
  if (!\Drupal::state()->get('xmlsitemap_regenerate_needed')) {
176 177 178
    return;
  }

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

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

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

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

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

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

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

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

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

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

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

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

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

330
  return $sitemaps;
331 332
}

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

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

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

  return $sitemap;
365 366 367
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

711 712
  $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();
713

714 715 716 717 718 719 720 721 722 723 724 725 726 727
  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;
  }
728 729
  return $status;
}
730

731 732 733 734 735 736 737 738 739 740 741 742 743 744
/**
 * 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']);
  }
}

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 772 773 774 775
  foreach ($settings as $key => $value) {
    \Drupal::config("xmlsitemap.settings.{$entity}.{$bundle}")->set($key, $value);
  }
  \Drupal::config("xmlsitemap.settings.{$entity}.{$bundle}")->save();

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

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

803
/**
804 805 806 807 808 809 810 811
 * 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.
812 813
 */
function xmlsitemap_link_type_rename($entity_old, $entity_new, $bundles = NULL) {
814 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;
    }
    \Drupal::config('xmlsitemap.settings')->clear($key);
820
    if (isset($value)) {
821
      $variable_new = str_replace('xmlsitemap_settings_' . $entity_old, 'xmlsitemap_settings_' . $entity_new, $key);
822
      \Drupal::config('xmlsitemap.settings')->set($variable_new, $value)->save();
823 824 825
    }
  }

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

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

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

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

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

  return FALSE;
}
916

917 918 919 920 921 922 923 924 925 926 927
/**
 * 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.
 */
928 929 930 931 932 933 934 935 936 937 938 939 940
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;
  }
}
941

942
/**
943
 * Implements hook_entity_bundle_rename().
944
 */
945 946
function xmlsitemap_entity_bundle_rename($entity_type_id, $bundle_old, $bundle_new) {
  xmlsitemap_link_bundle_rename($entity_type_id, $bundle_old, $bundle_new);
947 948 949
}

/**
950
 * Implements hook_entity_bundle_delete().
951
 */
952
function xmlsitemap_entity_bundle_delete($entity_type, $bundle, $instances) {
953 954 955
  xmlsitemap_link_bundle_delete($entity_type, $bundle, TRUE);
}

956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980
/**
 * 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.
981 982 983 984 985