xmlsitemap.module 78.7 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 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46

/**
 * 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);

47 48 49 50 51 52 53 54 55 56 57 58 59 60 61
/**
 * 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');

62 63 64 65 66 67 68 69 70 71
/**
 * 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);

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

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

100 101 102
  return $hooks;
}

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

109
  switch ($route_name) {
110
    case 'help.page.xmlsitemap':
111 112 113 114
    case 'xmlsitemap.admin_settings':
    case 'xmlsitemap.entities_settings':
    case 'xmlsitemap.admin_edit':
    case 'xmlsitemap.admin_delete':
115
      return;
116
    case 'xmlsitemap.admin_search':
117
      break;
118
    case 'xmlsitemap.admin_search_list':
119
      break;
120
    case 'xmlsitemap.admin_rebuild':
121 122 123
      $output .= '<p>' . t("This action rebuilds your site's XML sitemap and regenerates the cached files, and may be a lengthy process. If you just installed XML sitemap, this can be helpful to import all your site's content into the sitemap. Otherwise, this should only be used in emergencies.") . '</p>';
  }

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

  return $output;
}

/**
 * Implements hook_perm().
 */
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 162
/**
 * Menu access callback; determines if the user can use the rebuild links page.
 */
function _xmlsitemap_rebuild_form_access() {
  module_load_include('generate.inc', 'xmlsitemap');
  $rebuild_types = xmlsitemap_get_rebuildable_link_types();
163
  return !empty($rebuild_types) && \Drupal::currentUser()->hasPermission('administer xmlsitemap');
164 165
}

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

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

189 190 191 192 193 194 195 196 197 198 199 200 201 202
/**
 * 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
203
/**
204
 * Implements hook_robotstxt().
Darren Oh's avatar
Darren Oh committed
205
 */
206
function xmlsitemap_robotstxt() {
207
  if ($sitemap = xmlsitemap_sitemap_load_by_context()) {
208 209
    $uri = xmlsitemap_sitemap_uri($sitemap);
    $robotstxt[] = 'Sitemap: ' . url($uri['path'], $uri['options']);
210
    return $robotstxt;
211
  }
Darren Oh's avatar
Darren Oh committed
212 213
}

214
/**
215
 * Internal default variables config for xmlsitemap_var().
216
 */
217
function xmlsitemap_config_variables() {
218
  return array(
219
    'minimum_lifetime' => 0,
220 221 222 223 224 225 226 227 228 229 230
    'xsl' => 1,
    'prefetch_aliases' => 1,
    'chunk_size' => 'auto',
    'batch_limit' => 100,
    'path' => 'xmlsitemap',
    'base_url' => $GLOBALS['base_url'],
    'developer_mode' => 0,
    '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 243 244 245 246 247 248
/**
 * Internal default variables state for xmlsitemap_var().
 */
function xmlsitemap_state_variables() {
  return array(
    'rebuild_needed' => FALSE,
    'regenerate_needed' => TRUE,
    'base_url' => '',
249
    'generated_last' => 0,
250 251 252 253
    'developer_mode' => 0
  );
}

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

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

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

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

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

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

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

325
  return $sitemaps;
326 327 328
}

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

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

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

    // Mark the sitemaps as needing regeneration.
379
    \Drupal::state()->set('regenerate_needed', TRUE);
380
  }
381
  $sitemap->save();
382 383

  return $sitemap;
384 385 386
}

/**
387
 * Delete an XML sitemap.
388
 *
389 390
 * @param $smid
 *   An XML sitemap ID.
391
 */
392 393
function xmlsitemap_sitemap_delete($smid) {
  xmlsitemap_sitemap_delete_multiple(array($smid));
394 395
}

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

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

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

440 441
function xmlsitemap_sitemap_get_context_hash(array &$context) {
  asort($context);
442
  return Crypt::hashBase64(serialize($context));
443 444
}

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

466 467 468 469 470 471 472 473 474 475 476 477 478 479 480
/**
 * 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
481
/**
482
 * Load sitemap links from the database.
483 484
 *
 * @param $conditions
485 486
 *   An array of conditions on the {xmlsitemap} table in the form
 *   'field' => $value.
487
 * @return
488
 *   An array of sitemap link arrays.
Darren Oh's avatar
Darren Oh committed
489
 */
490
function xmlsitemap_link_load_multiple(array $conditions = array()) {
491 492
  $query = db_select('xmlsitemap');
  $query->fields('xmlsitemap');
493

494 495 496
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
  }
497

498
  $links = $query->execute()->fetchAll(PDO::FETCH_ASSOC);
499

500 501 502
  return $links;
}

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

  // Allow other modules to alter the link before saving.
523
  \Drupal::moduleHandler()->alter('xmlsitemap_link', $link);
524 525 526 527 528

  // 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
529
  }
530 531 532 533 534
  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;
  }

535
  $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();
536 537

  // Check if this is a changed link and set the regenerate flag if necessary.
538
  if (!\Drupal::state()->get('regenerate_needed')) {
539 540 541
    _xmlsitemap_check_changed_link($link, $existing, TRUE);
  }

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

  return $link;
Darren Oh's avatar
Darren Oh committed
553 554 555
}

/**
556 557 558 559 560 561 562 563 564 565 566
 * 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
567
 */
568
function xmlsitemap_link_update_multiple($updates = array(), $conditions = array(), $check_flag = TRUE) {
569 570
  // If we are going to modify a visible sitemap link, we will need to set
  // the regenerate needed flag.
571
  if ($check_flag && !\Drupal::state()->get('regenerate_needed')) {
572 573 574 575
    _xmlsitemap_check_changed_links($conditions, $updates, TRUE);
  }

  // Process updates.
576 577 578 579 580
  $query = db_update('xmlsitemap');
  $query->fields($updates);
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
  }
581

582
  return $query->execute();
Darren Oh's avatar
Darren Oh committed
583 584
}

585
/**
586
 * Delete a specific sitemap link from the database.
587 588 589 590
 *
 * If a visible sitemap link was deleted, this will automatically set the
 * regenerate needed flag.
 *
591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608
 * @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.
 *
609
 * @param $conditions
610 611
 *   An array of conditions on the {xmlsitemap} table in the form
 *   'field' => $value.
612 613
 * @return
 *   The number of links that were deleted.
614
 */
615
function xmlsitemap_link_delete_multiple(array $conditions) {
616 617 618
  // 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().
619
  // @todo Remove this check when http://drupal.org/node/151452 is fixed.
620 621 622 623
  if (!db_table_exists('xmlsitemap')) {
    return FALSE;
  }

624
  if (!\Drupal::state()->get('regenerate_needed')) {
625
    _xmlsitemap_check_changed_links($conditions, array(), TRUE);
626
  }
627

628 629
  // @todo Add a hook_xmlsitemap_link_delete() hook invoked here.

630 631 632 633
  $query = db_delete('xmlsitemap');
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
  }
634

635
  return $query->execute();
636 637
}

Darren Oh's avatar
Darren Oh committed
638
/**
639
 * Check if there is a visible sitemap link given a certain set of conditions.
640
 *
641 642 643 644 645 646 647
 * @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.
648
 */
649 650
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.
651 652
  $conditions['status'] = (!empty($updates['status']) && empty($conditions['status'])) ? 0 : 1;
  $conditions['access'] = (!empty($updates['access']) && empty($conditions['access'])) ? 0 : 1;
653

654 655 656 657
  $query = db_select('xmlsitemap');
  $query->addExpression('1');
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
658
  }
659 660
  $query->range(0, 1);
  $changed = $query->execute()->fetchField();
661

662
  if ($changed && $flag) {
663
    \Drupal::state()->set('regenerate_needed', TRUE);
Darren Oh's avatar
Darren Oh committed
664
  }
665

666
  return $changed;
Darren Oh's avatar
Darren Oh committed
667 668 669
}

/**
670
 * Check if there is sitemap link is changed from the existing data.
671
 *
672 673 674 675 676 677 678 679 680 681 682
 * @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
683
 */
684 685
function _xmlsitemap_check_changed_link(array $link, $original_link = NULL, $flag = FALSE) {
  $changed = FALSE;
686

687 688 689 690
  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
691

692 693 694 695
  if (!$original_link) {
    if ($link['access'] && $link['status']) {
      // Adding a new visible link.
      $changed = TRUE;
Darren Oh's avatar
Darren Oh committed
696
    }
697
  }
698 699 700 701 702 703 704 705
  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
706 707
    }
  }
708 709

  if ($changed && $flag) {
710
    \Drupal::state()->set('regenerate_needed', TRUE);
711 712
  }

713
  return $changed;
Darren Oh's avatar
Darren Oh committed
714 715 716
}

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

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

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

745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766
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;
}

767
function xmlsitemap_clear_directory(XmlSitemapInterface $sitemap = NULL, $delete = FALSE) {
768 769 770 771
  $directory = xmlsitemap_get_directory($sitemap);
  return _xmlsitemap_delete_recursive($directory, $delete);
}

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 801 802 803 804
/**
 * 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;
}

805 806 807 808 809 810 811 812
/**
 * 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
813
 *   A filepath relative to the Drupal root directory.
814 815 816 817 818 819 820 821 822 823 824 825 826
 * @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;
827
      file_unmanaged_delete_recursive($entry_path, NULL);
828 829
    }
    $dir->close();
830
    return $delete_root ? drupal_rmdir($path) : TRUE;
831 832
  }
  return file_unmanaged_delete($path);
Darren Oh's avatar
Darren Oh committed
833 834 835
}

/**
836 837 838 839 840 841 842 843 844 845 846
 * 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
847
 */
848
function xmlsitemap_get_link_info($type = NULL, $reset = FALSE) {
849
  $language = \Drupal::languageManager()->getCurrentLanguage();
850
  $link_info = &drupal_static(__FUNCTION__);
851

852 853
  if ($reset) {
    $link_info = NULL;
854 855 856
    foreach (\Drupal::languageManager()->getLanguages() as $lang) {
      \Drupal::cache()->delete('xmlsitemap:link_info:' . $lang->getId());
    }
857 858
  }

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

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

  return $link_info;
Darren Oh's avatar
Darren Oh committed
920 921
}

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

935 936 937
function xmlsitemap_get_link_type_indexed_status($entity_type, $bundle = '') {
  $info = xmlsitemap_get_link_info($entity_type);

938 939
  $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();
940

941 942 943 944 945 946 947 948 949 950
  $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->condition('bundle', $bundle);
  //$entity_query_object->condition('id', 0, '>');
  $entity_query_object->count();
  $status['total'] = $entity_query_object->execute();
951 952
  return $status;
}
953

954 955 956 957 958 959 960 961 962 963 964 965 966 967
/**
 * 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']);
  }
}

968 969
function xmlsitemap_link_bundle_settings_save($entity, $bundle, array $settings, $update_links = TRUE) {
  if ($update_links) {
970
    $old_settings = xmlsitemap_link_bundle_load($entity, $bundle);
971
    if ($settings['status'] != $old_settings['status']) {
972
      xmlsitemap_link_update_multiple(array('status' => $settings['status']), array('type' => $entity, 'subtype' => $bundle, 'status_override' => 0));
973 974
    }
    if ($settings['priority'] != $old_settings['priority']) {
975
      xmlsitemap_link_update_multiple(array('priority' => $settings['priority']), array('type' => $entity, 'subtype' => $bundle, 'priority_override' => 0));