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

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

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

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

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

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

101 102 103
  return $hooks;
}

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

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

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

  return $output;
}

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

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

156 157 158 159 160
/**
 * 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();
161
  return !empty($rebuild_types) && \Drupal::currentUser()->hasPermission('administer xmlsitemap');
162 163
}

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

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

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

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

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

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

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

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

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

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

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

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

320
  return $sitemaps;
321 322 323
}

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

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

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

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

  return $sitemap;
379 380 381
}

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

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

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

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

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

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

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

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

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

495 496 497
  return $links;
}

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

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

  // 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
524
  }
525 526 527 528 529
  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;
  }

530
  $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();
531 532

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

682 683 684 685
  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
686

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

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

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

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

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

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

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

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

767 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
/**
 * 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;
}

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

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

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

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

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

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

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

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

933 934
  $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();
935

936 937 938 939 940 941 942