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

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

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

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

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

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

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

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

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

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

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

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

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

99 100 101
  return $hooks;
}

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

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

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

  return $output;
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

328
  return $sitemaps;
329 330
}

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

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

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

  return $sitemap;
363 364 365
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

709 710
  $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();
711

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

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

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

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

776 777 778 779 780 781 782 783 784 785
/**
 * Renames a bundle.
 *
 * @param string $entity
 *   Entity type id.
 * @param string $bundle_old
 *   Old bundle name.
 * @param string $bundle_new
 *   New bundle name.
 */
786 787
function xmlsitemap_link_bundle_rename($entity, $bundle_old, $bundle_new) {
  if ($bundle_old != $bundle_new) {
788
    $settings = xmlsitemap_link_bundle_load($entity, $bundle_old);
789 790 791 792
    \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();
793
    xmlsitemap_link_bundle_settings_save($entity, $bundle_new, $settings, FALSE);
794
    \Drupal::service('xmlsitemap.link_storage')->updateMultiple(array('subtype' => $bundle_new), array('type' => $entity, 'subtype' => $bundle_old));
795 796 797
  }
}

798
/**
799 800 801 802 803 804 805 806
 * 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.
807 808
 */
function xmlsitemap_link_type_rename($entity_old, $entity_new, $bundles = NULL) {
809 810 811 812 813 814
  $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);
815
    if (isset($value)) {
816
      $variable_new = str_replace('xmlsitemap_settings_' . $entity_old, 'xmlsitemap_settings_' . $entity_new, $key);
817
      \Drupal::config('xmlsitemap.settings')->set($variable_new, $value)->save();
818 819 820
    }
  }

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

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

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

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

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

  return FALSE;
}
912

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

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

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

952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976
/**
 * 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.
977 978 979 980 981 982 983 984
 *
 * @static int $chunks
 *   Number of chunks.
 * @param int $reset
 *   If TRUE, reset number of chunks.
 *
 * @return integer
 *   Number of chunks.
985 986