xmlsitemap.module 84.4 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 Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
23
use Symfony\Component\HttpFoundation\Response;
24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41

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

42 43 44 45 46 47 48 49 50 51 52 53 54 55 56
/**
 * 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');

57 58 59 60 61 62 63 64 65 66
/**
 * 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);

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

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

95 96 97
  return $hooks;
}

98 99
/**
 * Implements hook_help().
Darren Oh's avatar
Darren Oh committed
100
 */
101
function xmlsitemap_help($route_name, RouteMatchInterface $route_match) {
102 103
  $output = '';

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

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

  return $output;
}

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

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

150 151 152 153 154
/**
 * 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();
155
  return !empty($rebuild_types) && \Drupal::currentUser()->hasPermission('administer xmlsitemap');
156 157
}

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

170
  // If the minimum sitemap lifetime hasn't been passed, skip.
171
  $lifetime = REQUEST_TIME - \Drupal::state()->get('xmlsitemap_generated_last');
172
  if ($lifetime < \Drupal::config('xmlsitemap.settings')->get('minimum_lifetime')) {
173 174
    return;
  }
175
  xmlsitemap_xmlsitemap_index_links(\Drupal::config('xmlsitemap.settings')->get('batch_limit'));
176
  // Regenerate the sitemap XML files.
177
  xmlsitemap_run_unprogressive_batch('xmlsitemap_regenerate_batch');
Darren Oh's avatar
Darren Oh committed
178 179
}

180 181 182 183 184 185 186 187 188 189 190 191 192 193
/**
 * 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
194
/**
195
 * Implements hook_robotstxt().
Darren Oh's avatar
Darren Oh committed
196
 */
197
function xmlsitemap_robotstxt() {
198 199
  $sitemap_storage = \Drupal::entityManager()->getStorage('xmlsitemap');
  if ($sitemap = $sitemap_storage->loadByContext()) {
200 201
    $uri = xmlsitemap_sitemap_uri($sitemap);
    $robotstxt[] = 'Sitemap: ' . url($uri['path'], $uri['options']);
202
    return $robotstxt;
203
  }
Darren Oh's avatar
Darren Oh committed
204 205
}

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

231 232 233 234 235
/**
 * Internal default variables state for xmlsitemap_var().
 */
function xmlsitemap_state_variables() {
  return array(
236 237 238 239 240
    'xmlsitemap_rebuild_needed' => FALSE,
    'xmlsitemap_regenerate_needed' => TRUE,
    'xmlsitemap_base_url' => '',
    'xmlsitemap_generated_last' => 0,
    'xmlsitemap_developer_mode' => 0
241 242 243
  );
}

244 245 246 247 248 249
/**
 * Internal implementation of variable_get().
 */
function xmlsitemap_var($name, $default = NULL) {
  $defaults = &drupal_static(__FUNCTION__);
  if (!isset($defaults)) {
250 251
    $defaults = xmlsitemap_config_variables();
    $defaults += xmlsitemap_state_variables();
252 253
  }

254 255 256
  // @todo Remove when stable.
  if (!isset($defaults[$name])) {
    trigger_error(strtr('Default variable for %variable not found.', array('%variable' => drupal_placeholder($name))));
257 258
  }

259 260 261 262
  if (\Drupal::state()->get($name, NULL) === NULL) {
    return \Drupal::config('xmlsitemap.settings')->get($name);
  }
  return \Drupal::state()->get($name);
263 264
}

Darren Oh's avatar
Darren Oh committed
265
/**
266
 * @defgroup xmlsitemap_api XML sitemap API.
267
 * @{
268 269
 * 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
270
 */
271 272 273 274 275 276

/**
 * Load an XML sitemap array from the database.
 *
 * @param $smid
 *   An XML sitemap ID.
277 278 279
 *
 * @return
 *   The XML sitemap object.
280 281 282 283
 */
function xmlsitemap_sitemap_load($smid) {
  $sitemap = xmlsitemap_sitemap_load_multiple(array($smid));
  return $sitemap ? reset($sitemap) : FALSE;
Darren Oh's avatar
Darren Oh committed
284 285 286
}

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

306
  $sitemaps = $storage->loadMultiple($conditions['smid']);
307 308 309 310 311 312
  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
313
  }
314

315
  return $sitemaps;
316 317
}

Darren Oh's avatar
Darren Oh committed
318
/**
319
 * Save changes to an XML sitemap or add a new XML sitemap.
320
 *
321
 * @param $sitemap
322
 *   The XML sitemap array to be saved. If $sitemap->smid is omitted, a new
323 324 325
 *   XML sitemap will be added.
 *
 * @todo Save the sitemap's URL as a column?
Darren Oh's avatar
Darren Oh committed
326
 */
327
function xmlsitemap_sitemap_save(XmlSitemapInterface $sitemap) {
328
  $context = $sitemap->context;
329
  if (!isset($context) || !$context) {
330
    $sitemap->context = array();
331 332
  }

333
  // Make sure context is sorted before saving the hash.
334 335
  //$sitemap->is_new = empty($sitemap->getId());
  //$sitemap->old_smid = $sitemap->is_new ? NULL : $sitemap->smid;
336
  $sitemap->setOriginalId($sitemap->isNew() ? NULL : $sitemap->getId());
337
  $sitemap->setId(xmlsitemap_sitemap_get_context_hash($context));
338
  // If the context was changed, we need to perform additional actions.
339
  if (!$sitemap->isNew() && $sitemap->getId() != $sitemap->getOriginalId()) {
340
    // Rename the files directory so the sitemap does not break.
341
    $old_sitemap = (object) array('smid' => $sitemap->old_smid);
342
    $old_dir = xmlsitemap_get_directory($old_sitemap);
343 344 345 346
    $new_dir = xmlsitemap_get_directory($sitemap);
    xmlsitemap_directory_move($old_dir, $new_dir);

    // Mark the sitemaps as needing regeneration.
347
    \Drupal::state()->set('xmlsitemap_regenerate_needed', TRUE);
348
  }
349
  $sitemap->save();
350 351

  return $sitemap;
352 353 354
}

/**
355
 * Delete an XML sitemap.
356
 *
357 358
 * @param $smid
 *   An XML sitemap ID.
359
 */
360 361
function xmlsitemap_sitemap_delete($smid) {
  xmlsitemap_sitemap_delete_multiple(array($smid));
362 363
}

Darren Oh's avatar
Darren Oh committed
364
/**
365
 * Delete multiple XML sitemaps.
366
 *
367 368
 * @param $smids
 *   An array of XML sitemap IDs.
Darren Oh's avatar
Darren Oh committed
369
 */
370 371 372 373 374
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);
375
      $sitemap->delete();
376
      \Drupal::moduleHandler()->invokeAll('xmlsitemap_sitemap_delete', array($sitemap));
377
    }
378
  }
379
}
380

381 382 383 384
/**
 * Return the expected file path for a specific sitemap chunk.
 *
 * @param $sitemap
385
 *   An XmlSitemapInterface sitemap object.
386 387 388
 * @param $chunk
 *   An optional specific chunk in the sitemap. Defaults to the index page.
 */
389
function xmlsitemap_sitemap_get_file(XmlSitemapInterface $sitemap, $chunk = 'index') {
390
  return xmlsitemap_get_directory($sitemap) . "/{$chunk}.xml";
Darren Oh's avatar
Darren Oh committed
391 392
}

393 394 395 396 397 398
/**
 * Find the maximum file size of all a sitemap's XML files.
 *
 * @param $sitemap
 *   The XML sitemap array.
 */
399
function xmlsitemap_sitemap_get_max_filesize(XmlSitemapInterface $sitemap) {
400
  $dir = xmlsitemap_get_directory($sitemap);
401
  $sitemap->setMaxFileSize(0);
402
  foreach (file_scan_directory($dir, '/\.xml$/') as $file) {
403
    $sitemap->setMaxFileSize(max($sitemap->getMaxFileSize(), filesize($file->uri)));
404
  }
405
  return $sitemap->getMaxFileSize();
406 407
}

408 409
function xmlsitemap_sitemap_get_context_hash(array &$context) {
  asort($context);
410
  return Crypt::hashBase64(serialize($context));
411 412
}

Darren Oh's avatar
Darren Oh committed
413
/**
414
 * Returns the uri elements of an XML sitemap.
415
 *
416 417
 * @param \Drupal\xmlsitemap\XmlSitemapInterface $sitemap
 *   The sitemap represented by and XmlSitemapInterface object.
418
 * @return
419 420
 *   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
421
 */
422
function xmlsitemap_sitemap_uri(XmlSitemapInterface $sitemap) {
423
  $uri['path'] = 'sitemap.xml';
424 425
  $uri['options'] = \Drupal::moduleHandler()->invokeAll('xmlsitemap_context_url_options', array($sitemap->context));
  $context = $sitemap->context;
426
  \Drupal::moduleHandler()->alter('xmlsitemap_context_url_options', $uri['options'], $context);
427 428
  $uri['options'] += array(
    'absolute' => TRUE,
429
    'base_url' => \Drupal::state()->get('xmlsitemap_base_url')
430 431 432
  );
  return $uri;
}
433

434 435 436 437 438 439 440 441 442 443 444 445 446 447 448
/**
 * 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
449
/**
450
 * Load sitemap links from the database.
451 452
 *
 * @param $conditions
453 454
 *   An array of conditions on the {xmlsitemap} table in the form
 *   'field' => $value.
455
 * @return
456
 *   An array of sitemap link arrays.
Darren Oh's avatar
Darren Oh committed
457
 */
458
function xmlsitemap_link_load_multiple(array $conditions = array()) {
459 460
  $query = db_select('xmlsitemap');
  $query->fields('xmlsitemap');
461

462 463 464
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
  }
465

466
  $links = $query->execute()->fetchAll(PDO::FETCH_ASSOC);
467

468 469 470
  return $links;
}

Darren Oh's avatar
Darren Oh committed
471
/**
472 473 474 475
 * Saves or updates a sitemap link.
 *
 * @param $link
 *   An array with a sitemap link.
Darren Oh's avatar
Darren Oh committed
476
 */
477
function xmlsitemap_link_save(array $link) {
478 479
  $link += array(
    'access' => 1,
Dave Reid's avatar
Dave Reid committed
480
    'status' => 1,
481 482
    'status_override' => 0,
    'lastmod' => 0,
483
    'priority' => XMLSITEMAP_PRIORITY_DEFAULT,
484 485 486
    'priority_override' => 0,
    'changefreq' => 0,
    'changecount' => 0,
487
    'language' => LanguageInterface::LANGCODE_NOT_SPECIFIED,
488 489 490
  );

  // Allow other modules to alter the link before saving.
491
  \Drupal::moduleHandler()->alter('xmlsitemap_link', $link);
492 493 494 495 496

  // 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
497
  }
498 499 500 501 502
  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;
  }

503
  $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();
504 505

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

510
  // Save the link and allow other modules to respond to the link being saved.
511
  if ($existing) {
512
    drupal_write_record('xmlsitemap', $link, array('type', 'id'));
513
    \Drupal::moduleHandler()->invokeAll('xmlsitemap_link_update', array($link));
514 515
  }
  else {
516
    $result = drupal_write_record('xmlsitemap', $link);
517
    \Drupal::moduleHandler()->invokeAll('xmlsitemap_link_insert', array($link));
518 519 520
  }

  return $link;
Darren Oh's avatar
Darren Oh committed
521 522 523
}

/**
524 525 526 527 528 529 530 531 532 533 534
 * 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
535
 */
536
function xmlsitemap_link_update_multiple($updates = array(), $conditions = array(), $check_flag = TRUE) {
537 538
  // If we are going to modify a visible sitemap link, we will need to set
  // the regenerate needed flag.
539
  if ($check_flag && !\Drupal::state()->get('xmlsitemap_regenerate_needed')) {
540 541 542 543
    _xmlsitemap_check_changed_links($conditions, $updates, TRUE);
  }

  // Process updates.
544 545 546 547 548
  $query = db_update('xmlsitemap');
  $query->fields($updates);
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
  }
549

550
  return $query->execute();
Darren Oh's avatar
Darren Oh committed
551 552
}

553
/**
554
 * Delete a specific sitemap link from the database.
555 556 557 558
 *
 * If a visible sitemap link was deleted, this will automatically set the
 * regenerate needed flag.
 *
559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576
 * @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.
 *
577
 * @param $conditions
578 579
 *   An array of conditions on the {xmlsitemap} table in the form
 *   'field' => $value.
580 581
 * @return
 *   The number of links that were deleted.
582
 */
583
function xmlsitemap_link_delete_multiple(array $conditions) {
584 585 586
  // 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().
587
  // @todo Remove this check when http://drupal.org/node/151452 is fixed.
588 589 590 591
  if (!db_table_exists('xmlsitemap')) {
    return FALSE;
  }

592
  if (!\Drupal::state()->get('xmlsitemap_regenerate_needed')) {
593
    _xmlsitemap_check_changed_links($conditions, array(), TRUE);
594
  }
595

596 597
  // @todo Add a hook_xmlsitemap_link_delete() hook invoked here.

598 599 600 601
  $query = db_delete('xmlsitemap');
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
  }
602

603
  return $query->execute();
604 605
}

Darren Oh's avatar
Darren Oh committed
606
/**
607
 * Check if there is a visible sitemap link given a certain set of conditions.
608
 *
609 610 611 612 613 614 615
 * @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.
616
 */
617 618
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.
619 620
  $conditions['status'] = (!empty($updates['status']) && empty($conditions['status'])) ? 0 : 1;
  $conditions['access'] = (!empty($updates['access']) && empty($conditions['access'])) ? 0 : 1;
621

622 623 624 625
  $query = db_select('xmlsitemap');
  $query->addExpression('1');
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
626
  }
627 628
  $query->range(0, 1);
  $changed = $query->execute()->fetchField();
629

630
  if ($changed && $flag) {
631
    \Drupal::state()->set('xmlsitemap_regenerate_needed', TRUE);
Darren Oh's avatar
Darren Oh committed
632
  }
633

634
  return $changed;
Darren Oh's avatar
Darren Oh committed
635 636 637
}

/**
638
 * Check if there is sitemap link is changed from the existing data.
639
 *
640 641 642 643 644 645 646 647 648 649 650
 * @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
651
 */
652 653
function _xmlsitemap_check_changed_link(array $link, $original_link = NULL, $flag = FALSE) {
  $changed = FALSE;
654

655 656 657 658
  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
659

660 661 662 663
  if (!$original_link) {
    if ($link['access'] && $link['status']) {
      // Adding a new visible link.
      $changed = TRUE;
Darren Oh's avatar
Darren Oh committed
664
    }
665
  }
666 667 668 669 670 671 672 673
  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
674 675
    }
  }
676 677

  if ($changed && $flag) {
678
    \Drupal::state()->set('xmlsitemap_regenerate_needed', TRUE);
679 680
  }

681
  return $changed;
Darren Oh's avatar
Darren Oh committed
682 683 684
}

/**
685
 * @} End of "defgroup xmlsitemap_api"
686
 */
687
function xmlsitemap_get_directory(XmlSitemapInterface $sitemap = NULL) {
688 689
  $directory = &drupal_static(__FUNCTION__);
  if (!isset($directory)) {
690
    $directory = \Drupal::config('xmlsitemap.settings')->get('path');
Darren Oh's avatar
Darren Oh committed
691
  }
692

693
  if ($sitemap != NULL && !empty($sitemap->id)) {
694
    return file_build_uri($directory . '/' . $sitemap->id);
695 696 697 698
  }
  else {
    return file_build_uri($directory);
  }
Darren Oh's avatar
Darren Oh committed
699 700 701
}

/**
702
 * Check that the sitemap files directory exists and is writable.
Darren Oh's avatar
Darren Oh committed
703
 */
704
function xmlsitemap_check_directory(XmlSitemapInterface $sitemap = NULL) {
705 706 707 708 709 710 711 712
  $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;
}

713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734
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;
}

735
function xmlsitemap_clear_directory(XmlSitemapInterface $sitemap = NULL, $delete = FALSE) {
736 737 738 739
  $directory = xmlsitemap_get_directory($sitemap);
  return _xmlsitemap_delete_recursive($directory, $delete);
}

740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772
/**
 * 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;
}

773 774 775 776 777 778 779 780
/**
 * 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
781
 *   A filepath relative to the Drupal root directory.
782 783 784 785 786 787 788 789 790 791 792 793 794
 * @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;
795
      file_unmanaged_delete_recursive($entry_path, NULL);
796 797
    }
    $dir->close();
798
    return $delete_root ? drupal_rmdir($path) : TRUE;
799 800
  }
  return file_unmanaged_delete($path);
Darren Oh's avatar
Darren Oh committed
801 802 803
}

/**
804 805 806 807 808 809 810 811 812 813 814
 * 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
815
 */
816
function xmlsitemap_get_link_info($type = NULL, $reset = FALSE) {
817
  $language = \Drupal::languageManager()->getCurrentLanguage();
818
  $link_info = &drupal_static(__FUNCTION__);
819

820 821
  if ($reset) {
    $link_info = NULL;
822 823 824
    foreach (\Drupal::languageManager()->getLanguages() as $lang) {
      \Drupal::cache()->delete('xmlsitemap:link_info:' . $lang->getId());
    }
825 826
  }

827
  if (!isset($link_info)) {
828
    $cid = 'xmlsitemap:link_info:' . $language->getId();
829
    if ($cache = \Drupal::cache()->get($cid)) {
830
      $link_info = $cache->data;
831
    }
832
    else {
833
      \Drupal::entityManager()->clearCachedDefinitions();
834 835 836 837 838 839 840 841 842 843 844
      $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)) {
845
          // Remove any non URL-able or XML sitemap un-supported entites.
846 847
          //unset($entity_types[$key]);
          //unset($link_info[$key]);
848
        }
849
        foreach (\Drupal::entityManager()->getBundleInfo($entity_type->id()) as $bundle_key => $bundle) {
850 851 852 853 854
          if (!isset($bundle['xmlsitemap'])) {
            // Remove any un-supported entity bundles.
            //unset($link_info[$key]['bundles'][$bundle_key]);
          }
        }
855 856
        //unset($entity_types[$key]);
        //unset($link_info[$key]);
857
      }
858
      $link_info = array_merge($link_info, \Drupal::moduleHandler()->invokeAll('xmlsitemap_link_info'));
859 860 861 862 863
      foreach ($link_info as $key => &$info) {
        $info += array(
          'type' => $key,
          'base table' => FALSE,
          'bundles' => array(),
864 865
          'xmlsitemap' => array(),
        );
866 867 868 869 870 871 872 873 874
        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);
        }
875
      }
876
      \Drupal::moduleHandler()->alter('xmlsitemap_link_info', $link_info);
877 878
      ksort($link_info);
      // Cache by language since this info contains translated strings.
879
      \Drupal::cache()->set($cid, $link_info);
880
    }
Darren Oh's avatar
Darren Oh committed
881
  }
882 883 884 885 886 887

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

  return $link_info;
Darren Oh's avatar
Darren Oh committed
888 889
}

890 891 892 893
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) {
894
    $settings = xmlsitemap_link_bundle_load($entity_type, $bundle);
895
    if (!empty($settings['status'])) {
896
      //if (!empty($bundle_info['xmlsitemap']['status'])) {
897 898 899 900 901 902
      $bundles[] = $bundle;
    }
  }
  return $bundles;
}

903 904 905
function xmlsitemap_get_link_type_indexed_status($entity_type, $bundle = '') {
  $info = xmlsitemap_get_link_info($entity_type);

906 907
  $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();
908

909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924
  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->condition('bundle', $bundle);
    //$entity_query_object->condition('id', 0, '>');
    $entity_query_object->count();
    $status['total'] = $entity_query_object->execute();
    return $status;
  }
  catch (Exception $e) {
    $status['total'] = 0;
  }
925 926
  return $status;
}
927

928 929 930 931 932 933 934 935 936 937 938 939 940 941
/**
 * 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']);
  }
}

942 943
function xmlsitemap_link_bundle_settings_save($entity, $bundle, array $settings, $update_links = TRUE) {
  if ($update_links) {
944
    $old_settings = xmlsitemap_link_bundle_load($entity, $bundle);
945
    if ($settings['status'] != $old_settings['status']) {
946
      xmlsitemap_link_update_multiple(array('status' => $settings['status']), array('type' => $entity, 'subtype' => $bundle, 'status_override' => 0));
947 948
    }
    if ($settings['priority'] != $old_settings['priority']) {
949
      xmlsitemap_link_update_multiple(array('priority' => $settings['priority']), array('type' => $entity, 'subtype' => $bundle, 'priority_override' => 0));
950 951 952
    }
  }

953
  \Drupal::config('xmlsitemap.settings')->set("xmlsitemap_settings_{$entity}_{$bundle}", $settings)->save();
954
  foreach (\Drupal::languageManager()->getLanguages() as $lang) {
955
    \Drupal::cache()->delete('xmlsitemap:link_info:' . $lang->getId());
956 957 958 959
  }
  \Drupal::cache()->deleteAll();
  //cache_clear_all('xmlsitemap:link_info:', 'cache', TRUE);
  xmlsitemap_get_link_info(NULL, TRUE);
960 961
}

962 963
function xmlsitemap_link_bundle_rename($entity, $bundle_old, $bundle_new) {
  if ($bundle_old != $bundle_new) {
964
    $settings = xmlsitemap_link_bundle_load($entity, $bundle_old);
965 966 967 968
    \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();
969
    xmlsitemap_link_bundle_settings_save($entity, $bundle_new, $settings, FALSE);
970
    xmlsitemap_link_update_multiple(array('subtype' => $bundle_new), array('type' => $entity, 'subtype' => $bundle_old));
971 972 973
  }
}

Dave Reid's avatar