xmlsitemap.module 86.1 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 Symfony\Component\HttpFoundation\Request;
12
use Drupal\Component\Utility\Crypt;
13
use Drupal\Core\Session\UserSession;
14
use Drupal\Core\Language\LanguageInterface;
15
use Drupal\xmlsitemap\XmlSitemapInterface;
16 17
use Drupal\user\Entity\User;
use Drupal\user\UserInterface;
18 19
use Drupal\Component\Utility\String;
use Drupal\Core\Render\Element;
20 21
use Drupal\Core\Entity\EntityFormBuilderInterface;
use Drupal\Core\Entity\EntityForm;
22 23
use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Entity\Entity;
24
use Drupal\Core\Session\AnonymousUserSession;
25
use Drupal\Core\Routing\RouteMatchInterface;
26
use Drupal\Core\Database\Query\AlterableInterface;
27
use Drupal\Core\Entity\Query\QueryInterface;
28
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
29
use Drupal\Component\Utility\Bytes;
30
use Symfony\Component\HttpFoundation\Response;
31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48

/**
 * The maximum number of links in one sitemap chunk file.
 */
define('XMLSITEMAP_MAX_SITEMAP_LINKS', 50000);

/**
 * The maximum filesize of a sitemap chunk file.
 */
define('XMLSITEMAP_MAX_SITEMAP_FILESIZE', 10485760);

define('XMLSITEMAP_FREQUENCY_YEARLY', 31449600); // 60 * 60 * 24 * 7 * 52
define('XMLSITEMAP_FREQUENCY_MONTHLY', 2419200); // 60 * 60 * 24 * 7 * 4
define('XMLSITEMAP_FREQUENCY_WEEKLY', 604800); // 60 * 60 * 24 * 7
define('XMLSITEMAP_FREQUENCY_DAILY', 86400); // 60 * 60 * 24
define('XMLSITEMAP_FREQUENCY_HOURLY', 3600); // 60 * 60
define('XMLSITEMAP_FREQUENCY_ALWAYS', 60);

49 50 51 52 53 54 55 56 57 58 59 60 61 62 63
/**
 * Short lastmod timestamp format.
 */
define('XMLSITEMAP_LASTMOD_SHORT', 'Y-m-d');

/**
 * Medium lastmod timestamp format.
 */
define('XMLSITEMAP_LASTMOD_MEDIUM', 'Y-m-d\TH:i\Z');

/**
 * Long lastmod timestamp format.
 */
define('XMLSITEMAP_LASTMOD_LONG', 'c');

64 65 66 67 68 69 70 71 72 73
/**
 * The default inclusion status for link types in the sitemaps.
 */
define('XMLSITEMAP_STATUS_DEFAULT', 0);

/**
 * The default priority for link types in the sitemaps.
 */
define('XMLSITEMAP_PRIORITY_DEFAULT', 0.5);

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

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

102 103 104
  return $hooks;
}

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

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

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

  return $output;
}

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

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

157 158 159 160 161
/**
 * Menu access callback; determines if the user can use the rebuild links page.
 */
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 189 190 191 192 193 194 195 196 197 198 199 200
/**
 * Implements hook_modules_enabled().
 */
function xmlsitemap_modules_enabled(array $modules) {
  cache_clear_all('xmlsitemap:', 'cache', TRUE);
}

/**
 * Implements hook_modules_disabled().
 */
function xmlsitemap_modules_disabled(array $modules) {
  cache_clear_all('xmlsitemap:', 'cache', TRUE);
}

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
  if ($sitemap = xmlsitemap_sitemap_load_by_context()) {
206 207
    $uri = xmlsitemap_sitemap_uri($sitemap);
    $robotstxt[] = 'Sitemap: ' . url($uri['path'], $uri['options']);
208
    return $robotstxt;
209
  }
Darren Oh's avatar
Darren Oh committed
210 211
}

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

237 238 239 240 241
/**
 * Internal default variables state for xmlsitemap_var().
 */
function xmlsitemap_state_variables() {
  return array(
242 243 244 245 246
    'xmlsitemap_rebuild_needed' => FALSE,
    'xmlsitemap_regenerate_needed' => TRUE,
    'xmlsitemap_base_url' => '',
    'xmlsitemap_generated_last' => 0,
    'xmlsitemap_developer_mode' => 0
247 248 249
  );
}

250 251 252 253 254 255
/**
 * Internal implementation of variable_get().
 */
function xmlsitemap_var($name, $default = NULL) {
  $defaults = &drupal_static(__FUNCTION__);
  if (!isset($defaults)) {
256 257
    $defaults = xmlsitemap_config_variables();
    $defaults += xmlsitemap_state_variables();
258 259
  }

260 261 262
  // @todo Remove when stable.
  if (!isset($defaults[$name])) {
    trigger_error(strtr('Default variable for %variable not found.', array('%variable' => drupal_placeholder($name))));
263 264
  }

265 266 267 268
  if (\Drupal::state()->get($name, NULL) === NULL) {
    return \Drupal::config('xmlsitemap.settings')->get($name);
  }
  return \Drupal::state()->get($name);
269 270
}

Darren Oh's avatar
Darren Oh committed
271
/**
272
 * @defgroup xmlsitemap_api XML sitemap API.
273
 * @{
274 275
 * 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
276
 */
277 278 279 280 281 282

/**
 * Load an XML sitemap array from the database.
 *
 * @param $smid
 *   An XML sitemap ID.
283 284 285
 *
 * @return
 *   The XML sitemap object.
286 287 288 289
 */
function xmlsitemap_sitemap_load($smid) {
  $sitemap = xmlsitemap_sitemap_load_multiple(array($smid));
  return $sitemap ? reset($sitemap) : FALSE;
Darren Oh's avatar
Darren Oh committed
290 291 292
}

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

312
  $sitemaps = $storage->loadMultiple($conditions['smid']);
313 314 315 316 317 318
  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
319
  }
320

321
  return $sitemaps;
322 323 324
}

/**
325
 * Load an XML sitemap array from the database based on its context.
326
 *
327 328
 * @param $context
 *   An optional XML sitemap context array to use to find the correct XML
329
 *   sitemap. If not provided, the current site's context will be used.
330
 *
331
 * @see xmlsitemap_get_current_context()
332
 */
333 334 335
function xmlsitemap_sitemap_load_by_context(array $context = NULL) {
  if (!isset($context)) {
    $context = xmlsitemap_get_current_context();
Darren Oh's avatar
Darren Oh committed
336
  }
337 338
  $sitemaps = \Drupal::entityManager()->getStorage('xmlsitemap')->loadMultiple();
  foreach ($sitemaps as $sitemap) {
339
    if ($sitemap->context == $context) {
340 341 342 343
      return $sitemap;
    }
  }
  return NULL;
Darren Oh's avatar
Darren Oh committed
344 345 346
}

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

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

    // Mark the sitemaps as needing regeneration.
375
    \Drupal::state()->set('xmlsitemap_regenerate_needed', TRUE);
376
  }
377
  $sitemap->save();
378 379

  return $sitemap;
380 381 382
}

/**
383
 * Delete an XML sitemap.
384
 *
385 386
 * @param $smid
 *   An XML sitemap ID.
387
 */
388 389
function xmlsitemap_sitemap_delete($smid) {
  xmlsitemap_sitemap_delete_multiple(array($smid));
390 391
}

Darren Oh's avatar
Darren Oh committed
392
/**
393
 * Delete multiple XML sitemaps.
394
 *
395 396
 * @param $smids
 *   An array of XML sitemap IDs.
Darren Oh's avatar
Darren Oh committed
397
 */
398 399 400 401 402
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);
403
      $sitemap->delete();
404
      \Drupal::moduleHandler()->invokeAll('xmlsitemap_sitemap_delete', array($sitemap));
405
    }
406
  }
407
}
408

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

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

436 437
function xmlsitemap_sitemap_get_context_hash(array &$context) {
  asort($context);
438
  return Crypt::hashBase64(serialize($context));
439 440
}

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

462 463 464 465 466 467 468 469 470 471 472 473 474 475 476
/**
 * Load a specific sitemap link from the database.
 *
 * @param $entity_type
 *   A string with the entity type.
 * @param $entity_id
 *   An integer with the entity ID.
 * @return
 *   A sitemap link (array) or FALSE if the conditions were not found.
 */
function xmlsitemap_link_load($entity_type, $entity_id) {
  $link = xmlsitemap_link_load_multiple(array('type' => $entity_type, 'id' => $entity_id));
  return $link ? reset($link) : FALSE;
}

Darren Oh's avatar
Darren Oh committed
477
/**
478
 * Load sitemap links from the database.
479 480
 *
 * @param $conditions
481 482
 *   An array of conditions on the {xmlsitemap} table in the form
 *   'field' => $value.
483
 * @return
484
 *   An array of sitemap link arrays.
Darren Oh's avatar
Darren Oh committed
485
 */
486
function xmlsitemap_link_load_multiple(array $conditions = array()) {
487 488
  $query = db_select('xmlsitemap');
  $query->fields('xmlsitemap');
489

490 491 492
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
  }
493

494
  $links = $query->execute()->fetchAll(PDO::FETCH_ASSOC);
495

496 497 498
  return $links;
}

Darren Oh's avatar
Darren Oh committed
499
/**
500 501 502 503
 * Saves or updates a sitemap link.
 *
 * @param $link
 *   An array with a sitemap link.
Darren Oh's avatar
Darren Oh committed
504
 */
505
function xmlsitemap_link_save(array $link) {
506 507
  $link += array(
    'access' => 1,
Dave Reid's avatar
Dave Reid committed
508
    'status' => 1,
509 510
    'status_override' => 0,
    'lastmod' => 0,
511
    'priority' => XMLSITEMAP_PRIORITY_DEFAULT,
512 513 514
    'priority_override' => 0,
    'changefreq' => 0,
    'changecount' => 0,
515
    'language' => LanguageInterface::LANGCODE_NOT_SPECIFIED,
516 517 518
  );

  // Allow other modules to alter the link before saving.
519
  \Drupal::moduleHandler()->alter('xmlsitemap_link', $link);
520 521 522 523 524

  // Temporary validation checks.
  // @todo Remove in final?
  if ($link['priority'] < 0 || $link['priority'] > 1) {
    trigger_error(t('Invalid sitemap link priority %priority.<br />@link', array('%priority' => $link['priority'], '@link' => var_export($link, TRUE))), E_USER_ERROR);
Darren Oh's avatar
Darren Oh committed
525
  }
526 527 528 529 530
  if ($link['changecount'] < 0) {
    trigger_error(t('Negative changecount value. Please report this to <a href="@516928">@516928</a>.<br />@link', array('@516928' => 'http://drupal.org/node/516928', '@link' => var_export($link, TRUE))), E_USER_ERROR);
    $link['changecount'] = 0;
  }

531
  $existing = db_query_range("SELECT loc, access, status, lastmod, priority, changefreq, changecount, language FROM {xmlsitemap} WHERE type = :type AND id = :id", 0, 1, array(':type' => $link['type'], ':id' => $link['id']))->fetchAssoc();
532 533

  // Check if this is a changed link and set the regenerate flag if necessary.
534
  if (!\Drupal::state()->get('xmlsitemap_regenerate_needed')) {
535 536 537
    _xmlsitemap_check_changed_link($link, $existing, TRUE);
  }

538
  // Save the link and allow other modules to respond to the link being saved.
539
  if ($existing) {
540
    drupal_write_record('xmlsitemap', $link, array('type', 'id'));
541
    \Drupal::moduleHandler()->invokeAll('xmlsitemap_link_update', array($link));
542 543
  }
  else {
544
    $result = drupal_write_record('xmlsitemap', $link);
545
    \Drupal::moduleHandler()->invokeAll('xmlsitemap_link_insert', array($link));
546 547 548
  }

  return $link;
Darren Oh's avatar
Darren Oh committed
549 550 551
}

/**
552 553 554 555 556 557 558 559 560 561 562
 * Perform a mass update of sitemap data.
 *
 * If visible links are updated, this will automatically set the regenerate
 * needed flag to TRUE.
 *
 * @param $updates
 *   An array of values to update fields to, keyed by field name.
 * @param $conditions
 *   An array of values to match keyed by field.
 * @return
 *   The number of links that were updated.
Darren Oh's avatar
Darren Oh committed
563
 */
564
function xmlsitemap_link_update_multiple($updates = array(), $conditions = array(), $check_flag = TRUE) {
565 566
  // If we are going to modify a visible sitemap link, we will need to set
  // the regenerate needed flag.
567
  if ($check_flag && !\Drupal::state()->get('xmlsitemap_regenerate_needed')) {
568 569 570 571
    _xmlsitemap_check_changed_links($conditions, $updates, TRUE);
  }

  // Process updates.
572 573 574 575 576
  $query = db_update('xmlsitemap');
  $query->fields($updates);
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
  }
577

578
  return $query->execute();
Darren Oh's avatar
Darren Oh committed
579 580
}

581
/**
582
 * Delete a specific sitemap link from the database.
583 584 585 586
 *
 * If a visible sitemap link was deleted, this will automatically set the
 * regenerate needed flag.
 *
587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604
 * @param $entity_type
 *   A string with the entity type.
 * @param $entity_id
 *   An integer with the entity ID.
 * @return
 *   The number of links that were deleted.
 */
function xmlsitemap_link_delete($entity_type, $entity_id) {
  $conditions = array('type' => $entity_type, 'id' => $entity_id);
  return xmlsitemap_link_delete_multiple($conditions);
}

/**
 * Delete multiple sitemap links from the database.
 *
 * If visible sitemap links were deleted, this will automatically set the
 * regenerate needed flag.
 *
605
 * @param $conditions
606 607
 *   An array of conditions on the {xmlsitemap} table in the form
 *   'field' => $value.
608 609
 * @return
 *   The number of links that were deleted.
610
 */
611
function xmlsitemap_link_delete_multiple(array $conditions) {
612 613 614
  // Because this function is called from sub-module uninstall hooks, we have
  // to manually check if the table exists since it could have been removed
  // in xmlsitemap_uninstall().
615
  // @todo Remove this check when http://drupal.org/node/151452 is fixed.
616 617 618 619
  if (!db_table_exists('xmlsitemap')) {
    return FALSE;
  }

620
  if (!\Drupal::state()->get('xmlsitemap_regenerate_needed')) {
621
    _xmlsitemap_check_changed_links($conditions, array(), TRUE);
622
  }
623

624 625
  // @todo Add a hook_xmlsitemap_link_delete() hook invoked here.

626 627 628 629
  $query = db_delete('xmlsitemap');
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
  }
630

631
  return $query->execute();
632 633
}

Darren Oh's avatar
Darren Oh committed
634
/**
635
 * Check if there is a visible sitemap link given a certain set of conditions.
636
 *
637 638 639 640 641 642 643
 * @param $conditions
 *   An array of values to match keyed by field.
 * @param $flag
 *   An optional boolean that if TRUE, will set the regenerate needed flag if
 *   there is a match. Defaults to FALSE.
 * @return
 *   TRUE if there is a visible link, or FALSE otherwise.
644
 */
645 646
function _xmlsitemap_check_changed_links(array $conditions = array(), array $updates = array(), $flag = FALSE) {
  // If we are changing status or access, check for negative current values.
647 648
  $conditions['status'] = (!empty($updates['status']) && empty($conditions['status'])) ? 0 : 1;
  $conditions['access'] = (!empty($updates['access']) && empty($conditions['access'])) ? 0 : 1;
649

650 651 652 653
  $query = db_select('xmlsitemap');
  $query->addExpression('1');
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
654
  }
655 656
  $query->range(0, 1);
  $changed = $query->execute()->fetchField();
657

658
  if ($changed && $flag) {
659
    \Drupal::state()->set('xmlsitemap_regenerate_needed', TRUE);
Darren Oh's avatar
Darren Oh committed
660
  }
661

662
  return $changed;
Darren Oh's avatar
Darren Oh committed
663 664 665
}

/**
666
 * Check if there is sitemap link is changed from the existing data.
667
 *
668 669 670 671 672 673 674 675 676 677 678
 * @param $link
 *   An array of the sitemap link.
 * @param $original_link
 *   An optional array of the existing data. This should only contain the
 *   fields necessary for comparison. If not provided the existing data will be
 *   loaded from the database.
 * @param $flag
 *   An optional boolean that if TRUE, will set the regenerate needed flag if
 *   there is a match. Defaults to FALSE.
 * @return
 *   TRUE if the link is changed, or FALSE otherwise.
Darren Oh's avatar
Darren Oh committed
679
 */
680 681
function _xmlsitemap_check_changed_link(array $link, $original_link = NULL, $flag = FALSE) {
  $changed = FALSE;
682

683 684 685 686
  if ($original_link === NULL) {
    // Load only the fields necessary for data to be changed in the sitemap.
    $original_link = db_query_range("SELECT loc, access, status, lastmod, priority, changefreq, changecount, language FROM {xmlsitemap} WHERE type = :type AND id = :id", 0, 1, array(':type' => $link['type'], ':id' => $link['id']))->fetchAssoc();
  }
Darren Oh's avatar
Darren Oh committed
687

688 689 690 691
  if (!$original_link) {
    if ($link['access'] && $link['status']) {
      // Adding a new visible link.
      $changed = TRUE;
Darren Oh's avatar
Darren Oh committed
692
    }
693
  }
694 695 696 697 698 699 700 701
  else {
    if (!($original_link['access'] && $original_link['status']) && $link['access'] && $link['status']) {
      // Changing a non-visible link to a visible link.
      $changed = TRUE;
    }
    elseif ($original_link['access'] && $original_link['status'] && array_diff_assoc($original_link, $link)) {
      // Changing a visible link
      $changed = TRUE;
Darren Oh's avatar
Darren Oh committed
702 703
    }
  }
704 705

  if ($changed && $flag) {
706
    \Drupal::state()->set('xmlsitemap_regenerate_needed', TRUE);
707 708
  }

709
  return $changed;
Darren Oh's avatar
Darren Oh committed
710 711 712
}

/**
713
 * @} End of "defgroup xmlsitemap_api"
714
 */
715
function xmlsitemap_get_directory(XmlSitemapInterface $sitemap = NULL) {
716 717
  $directory = &drupal_static(__FUNCTION__);
  if (!isset($directory)) {
718
    $directory = \Drupal::config('xmlsitemap.settings')->get('path');
Darren Oh's avatar
Darren Oh committed
719
  }
720

721
  if ($sitemap != NULL && !empty($sitemap->id)) {
722
    return file_build_uri($directory . '/' . $sitemap->id);
723 724 725 726
  }
  else {
    return file_build_uri($directory);
  }
Darren Oh's avatar
Darren Oh committed
727 728 729
}

/**
730
 * Check that the sitemap files directory exists and is writable.
Darren Oh's avatar
Darren Oh committed
731
 */
732
function xmlsitemap_check_directory(XmlSitemapInterface $sitemap = NULL) {
733 734 735 736 737 738 739 740
  $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;
}

741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762
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;
}

763
function xmlsitemap_clear_directory(XmlSitemapInterface $sitemap = NULL, $delete = FALSE) {
764 765 766 767
  $directory = xmlsitemap_get_directory($sitemap);
  return _xmlsitemap_delete_recursive($directory, $delete);
}

768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800
/**
 * Move a directory to a new location.
 *
 * @param $old_dir
 *   A string specifying the filepath or URI of the original directory.
 * @param $new_dir
 *   A string specifying the filepath or URI of the new directory.
 * @param $replace
 *   Replace behavior when the destination file already exists.
 *
 * @return
 *   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;
}

801 802 803 804 805 806 807 808
/**
 * Recursively delete all files and folders in the specified filepath.
 *
 * This is a backport of Drupal 7's file_unmanaged_delete_recursive().
 *
 * Note that this only deletes visible files with write permission.
 *
 * @param $path
809
 *   A filepath relative to the Drupal root directory.
810 811 812 813 814 815 816 817 818 819 820 821 822
 * @param $delete_root
 *   A boolean if TRUE will delete the $path directory afterwards.
 */
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;
823
      file_unmanaged_delete_recursive($entry_path, NULL);
824 825
    }
    $dir->close();
826
    return $delete_root ? drupal_rmdir($path) : TRUE;
827 828
  }
  return file_unmanaged_delete($path);
Darren Oh's avatar
Darren Oh committed
829 830 831
}

/**
832 833 834 835 836 837 838 839 840 841 842
 * 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.
 *
 * @see hook_xmlsitemap_link_info()
 * @see hook_xmlsitemap_link_info_alter()
Darren Oh's avatar
Darren Oh committed
843
 */
844
function xmlsitemap_get_link_info($type = NULL, $reset = FALSE) {
845
  $language = \Drupal::languageManager()->getCurrentLanguage();
846
  $link_info = &drupal_static(__FUNCTION__);
847

848 849
  if ($reset) {
    $link_info = NULL;
850 851 852
    foreach (\Drupal::languageManager()->getLanguages() as $lang) {
      \Drupal::cache()->delete('xmlsitemap:link_info:' . $lang->getId());
    }
853 854
  }

855
  if (!isset($link_info)) {
856
    $cid = 'xmlsitemap:link_info:' . $language->getId();
857
    if ($cache = \Drupal::cache()->get($cid)) {
858
      $link_info = $cache->data;
859
    }
860
    else {
861
      \Drupal::entityManager()->clearCachedDefinitions();
862 863 864 865 866 867 868 869 870 871 872
      $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)) {
873
          // Remove any non URL-able or XML sitemap un-supported entites.
874 875
          //unset($entity_types[$key]);
          //unset($link_info[$key]);
876
        }
877
        foreach (\Drupal::entityManager()->getBundleInfo($entity_type->id()) as $bundle_key => $bundle) {
878 879 880 881 882
          if (!isset($bundle['xmlsitemap'])) {
            // Remove any un-supported entity bundles.
            //unset($link_info[$key]['bundles'][$bundle_key]);
          }
        }
883 884
        //unset($entity_types[$key]);
        //unset($link_info[$key]);
885
      }
886
      $link_info = array_merge($link_info, \Drupal::moduleHandler()->invokeAll('xmlsitemap_link_info'));
887 888 889 890 891
      foreach ($link_info as $key => &$info) {
        $info += array(
          'type' => $key,
          'base table' => FALSE,
          'bundles' => array(),
892 893
          'xmlsitemap' => array(),
        );
894 895 896 897 898 899 900 901 902
        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);
        }
903
      }
904
      \Drupal::moduleHandler()->alter('xmlsitemap_link_info', $link_info);
905 906
      ksort($link_info);
      // Cache by language since this info contains translated strings.
907
      \Drupal::cache()->set($cid, $link_info);
908
    }
Darren Oh's avatar
Darren Oh committed
909
  }
910 911 912 913 914 915

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

  return $link_info;
Darren Oh's avatar
Darren Oh committed
916 917
}

918 919 920 921
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) {
922
    $settings = xmlsitemap_link_bundle_load($entity_type, $bundle);
923
    if (!empty($settings['status'])) {
924
      //if (!empty($bundle_info['xmlsitemap']['status'])) {
925 926 927 928 929 930
      $bundles[] = $bundle;
    }
  }
  return $bundles;
}

931 932 933
function xmlsitemap_get_link_type_indexed_status($entity_type, $bundle = '') {
  $info = xmlsitemap_get_link_info($entity_type);

934 935
  $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' =>