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

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

/**
8 9 10
 * @file
 * Main file for the xmlsitemap module.
 */
11
use Symfony\Component\HttpFoundation\Request;
12
use Drupal\Component\Utility\Crypt;
13
use Drupal\Core\Session\UserSession;
14
use Drupal\Core\Language\LanguageInterface;
15
use Drupal\xmlsitemap\XmlSitemapInterface;
16 17
use Drupal\user\Entity\User;
use Drupal\user\UserInterface;
18 19
use Drupal\Component\Utility\String;
use Drupal\Core\Render\Element;
20 21
use Drupal\Core\Entity\EntityFormBuilderInterface;
use Drupal\Core\Entity\EntityForm;
22 23
use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Entity\Entity;
24
use Drupal\Core\Session\AnonymousUserSession;
25
use Drupal\Core\Routing\RouteMatchInterface;
26
use Drupal\Core\Database\Query\AlterableInterface;
27
use Drupal\Core\Entity\Query\QueryInterface;
28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45

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

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

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

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

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

99 100 101
  return $hooks;
}

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

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

123
  $currentUser = \Drupal::currentUser();
124
  if (strpos($route_name, 'xmlsitemap') !== FALSE && $currentUser->hasPermission('administer xmlsitemap')) {
125
    module_load_include('inc', 'xmlsitemap');
126 127
    // Alert the user to any potential problems detected by hook_requirements.
    xmlsitemap_check_status();
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
 * Implements hook_menu().
Darren Oh's avatar
Darren Oh committed
146
 */
147
function xmlsitemap_menu() {
148
  $items['admin/config/search/xmlsitemap'] = array(
149
    'title' => 'XML sitemap',
150
    'description' => "Configure your site's XML sitemaps to help search engines find and index pages on your site.",
151
    'page callback' => 'drupal_get_form',
152
    'page arguments' => array('xmlsitemap_sitemap_list_form'),
153 154
    'access arguments' => array('administer xmlsitemap'),
    'file' => 'xmlsitemap.admin.inc',
155
  );
156 157 158 159 160 161 162 163 164 165 166 167
  $items['admin/config/search/xmlsitemap/list'] = array(
    'title' => 'List',
    'type' => MENU_DEFAULT_LOCAL_TASK,
    'weight' => -10,
  );
  $items['admin/config/search/xmlsitemap/add'] = array(
    'title' => 'Add new XML sitemap',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('xmlsitemap_sitemap_edit_form'),
    'access arguments' => array('administer xmlsitemap'),
    'type' => MENU_LOCAL_ACTION,
    'file' => 'xmlsitemap.admin.inc',
168
    'modal' => TRUE,
169
    'options' => array('modal' => TRUE),
170 171
  );
  $items['admin/config/search/xmlsitemap/edit/%xmlsitemap_sitemap'] = array(
172
    'title' => 'Edit XML sitemap',
173 174 175 176
    'page callback' => 'drupal_get_form',
    'page arguments' => array('xmlsitemap_sitemap_edit_form', 5),
    'access arguments' => array('administer xmlsitemap'),
    'file' => 'xmlsitemap.admin.inc',
177
    'modal' => TRUE,
178 179
  );
  $items['admin/config/search/xmlsitemap/delete/%xmlsitemap_sitemap'] = array(
180
    'title' => 'Delete XML sitemap',
181 182 183 184
    'page callback' => 'drupal_get_form',
    'page arguments' => array('xmlsitemap_sitemap_delete_form', 5),
    'access arguments' => array('administer xmlsitemap'),
    'file' => 'xmlsitemap.admin.inc',
185
    'modal' => TRUE,
186
  );
187

188
  $items['admin/config/search/xmlsitemap/settings'] = array(
189
    'title' => 'Settings',
190 191
    'page callback' => 'drupal_get_form',
    'page arguments' => array('xmlsitemap_settings_form'),
192
    'access arguments' => array('administer xmlsitemap'),
193
    'type' => MENU_LOCAL_TASK,
194
    'file' => 'xmlsitemap.admin.inc',
195
    'weight' => 10,
196
  );
197 198 199 200 201 202 203 204 205 206
  $items['admin/config/search/xmlsitemap/settings/%xmlsitemap_link_bundle/%'] = array(
    'load arguments' => array(6),
    'page callback' => 'drupal_get_form',
    'page arguments' => array('xmlsitemap_link_bundle_settings_form', 5),
    'access callback' => 'xmlsitemap_link_bundle_access',
    'access arguments' => array(5),
    'file' => 'xmlsitemap.admin.inc',
    'modal' => TRUE,
  );

207
  $items['admin/config/search/xmlsitemap/rebuild'] = array(
208
    'title' => 'Rebuild links',
209
    'description' => 'Rebuild the site map.',
210
    'page callback' => 'drupal_get_form',
211
    'page arguments' => array('xmlsitemap_rebuild_form'),
212
    'access callback' => '_xmlsitemap_rebuild_form_access',
213
    'type' => MENU_LOCAL_TASK,
214
    'file' => 'xmlsitemap.admin.inc',
215
    'weight' => 20,
216 217 218
  );

  $items['sitemap.xml'] = array(
219
    'page callback' => 'xmlsitemap_output_chunk',
220
    'access callback' => TRUE,
221 222 223 224 225 226
    'type' => MENU_CALLBACK,
    'file' => 'xmlsitemap.pages.inc',
  );
  $items['sitemap.xsl'] = array(
    'page callback' => 'xmlsitemap_output_xsl',
    'access callback' => TRUE,
227
    'type' => MENU_CALLBACK,
228
    'file' => 'xmlsitemap.pages.inc',
229 230
  );

Darren Oh's avatar
Darren Oh committed
231 232 233
  return $items;
}

234 235 236 237 238 239 240 241 242 243 244 245
/**
 * Implements hook_theme().
 */
function xmlsitemap_theme() {
  return array(
    'xmlsitemap_content_settings_table' => array(
      'render element' => 'element',
      'file' => 'xmlsitemap.module',
    ),
  );
}

246 247 248 249 250 251
/**
 * 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();
252
  return !empty($rebuild_types) && \Drupal::currentUser()->hasPermission('administer xmlsitemap');
253 254
}

Darren Oh's avatar
Darren Oh committed
255
/**
256
 * Implements hook_cron().
257 258 259
 *
 * @todo Use new Queue system. Need to add {sitemap}.queued.
 * @todo Regenerate one at a time?
Darren Oh's avatar
Darren Oh committed
260
 */
261
function xmlsitemap_cron() {
262
  // If there were no new or changed links, skip.
263
  if (!\Drupal::config('xmlsitemap.settings')->get('regenerate_needed')) {
264 265 266
    return;
  }

267
  // If the minimum sitemap lifetime hasn't been passed, skip.
268
  $lifetime = REQUEST_TIME - \Drupal::config('xmlsitemap.settings')->get('generated_last');
269
  if ($lifetime < \Drupal::config('xmlsitemap.settings')->get('minimum_lifetime')) {
270 271
    return;
  }
272
  xmlsitemap_xmlsitemap_index_links(\Drupal::config('xmlsitemap.settings')->get('batch_limit'));
273
  // Regenerate the sitemap XML files.
274
  module_load_include('generate.inc', 'xmlsitemap');
275
  xmlsitemap_run_unprogressive_batch('xmlsitemap_regenerate_batch');
Darren Oh's avatar
Darren Oh committed
276 277
}

278 279 280 281 282 283 284 285 286 287 288 289 290 291
/**
 * 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
292
/**
293
 * Implements hook_robotstxt().
Darren Oh's avatar
Darren Oh committed
294
 */
295
function xmlsitemap_robotstxt() {
296
  if ($sitemap = xmlsitemap_sitemap_load_by_context()) {
297 298
    $uri = xmlsitemap_sitemap_uri($sitemap);
    $robotstxt[] = 'Sitemap: ' . url($uri['path'], $uri['options']);
299
    return $robotstxt;
300
  }
Darren Oh's avatar
Darren Oh committed
301 302
}

303
/**
304
 * Internal default variables for xmlsitemap_var().
305
 */
306 307
function xmlsitemap_variables() {
  return array(
308 309
    'rebuild_needed' => FALSE,
    'regenerate_needed' => FALSE,
310
    'minimum_lifetime' => 0,
311 312 313 314 315 316 317 318 319 320 321 322
    'generated_last' => 0,
    '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,
323
    // Removed variables are set to NULL so they can still be deleted.
324 325 326 327 328 329
    'regenerate_last' => NULL,
    'custom_links' => NULL,
    'priority_default' => NULL,
    'languages' => NULL,
    'max_chunks' => NULL,
    'max_filesize' => NULL,
330 331 332 333 334 335 336 337 338 339
  );
}

/**
 * Internal implementation of variable_get().
 */
function xmlsitemap_var($name, $default = NULL) {
  $defaults = &drupal_static(__FUNCTION__);
  if (!isset($defaults)) {
    $defaults = xmlsitemap_variables();
340 341
  }

342 343 344
  // @todo Remove when stable.
  if (!isset($defaults[$name])) {
    trigger_error(strtr('Default variable for %variable not found.', array('%variable' => drupal_placeholder($name))));
345 346
  }

347
  return \Drupal::config('xmlsitemap.settings')->get($name);
348 349
}

Darren Oh's avatar
Darren Oh committed
350
/**
351
 * @defgroup xmlsitemap_api XML sitemap API.
352
 * @{
353 354
 * 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
355
 */
356 357 358 359 360 361

/**
 * Load an XML sitemap array from the database.
 *
 * @param $smid
 *   An XML sitemap ID.
362 363 364
 *
 * @return
 *   The XML sitemap object.
365 366 367 368
 */
function xmlsitemap_sitemap_load($smid) {
  $sitemap = xmlsitemap_sitemap_load_multiple(array($smid));
  return $sitemap ? reset($sitemap) : FALSE;
Darren Oh's avatar
Darren Oh committed
369 370 371
}

/**
372 373 374
 * Load multiple XML sitemaps from the database.
 *
 * @param $smids
375 376 377
 *   An array of XML sitemap IDs, or FALSE to load all XML sitemaps.
 * @param $conditions
 *   An array of conditions in the form 'field' => $value.
378 379 380
 *
 * @return
 *   An array of XML sitemap objects.
Darren Oh's avatar
Darren Oh committed
381
 */
382 383 384 385
function xmlsitemap_sitemap_load_multiple($smids = array(), array $conditions = array()) {
  if ($smids !== FALSE) {
    $conditions['smid'] = $smids;
  }
386
  else {
387
    $conditions['smid'] = NULL;
388
  }
389
  $storage = Drupal::entityManager()->getStorage('xmlsitemap');
390

391
  $sitemaps = $storage->loadMultiple($conditions['smid']);
392 393 394 395 396 397
  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
398
  }
399

400
  return $sitemaps;
401 402 403
}

/**
404
 * Load an XML sitemap array from the database based on its context.
405
 *
406 407
 * @param $context
 *   An optional XML sitemap context array to use to find the correct XML
408
 *   sitemap. If not provided, the current site's context will be used.
409
 *
410
 * @see xmlsitemap_get_current_context()
411
 */
412 413 414
function xmlsitemap_sitemap_load_by_context(array $context = NULL) {
  if (!isset($context)) {
    $context = xmlsitemap_get_current_context();
Darren Oh's avatar
Darren Oh committed
415
  }
416 417
  $sitemaps = \Drupal::entityManager()->getStorage('xmlsitemap')->loadMultiple();
  foreach ($sitemaps as $sitemap) {
418
    if ($sitemap->context == $context) {
419 420 421 422
      return $sitemap;
    }
  }
  return NULL;
Darren Oh's avatar
Darren Oh committed
423 424 425
}

/**
426
 * Save changes to an XML sitemap or add a new XML sitemap.
427
 *
428
 * @param $sitemap
429
 *   The XML sitemap array to be saved. If $sitemap->smid is omitted, a new
430 431 432
 *   XML sitemap will be added.
 *
 * @todo Save the sitemap's URL as a column?
Darren Oh's avatar
Darren Oh committed
433
 */
434
function xmlsitemap_sitemap_save(XmlSitemapInterface $sitemap) {
435
  $context = $sitemap->context;
436
  if (!isset($context) || !$context) {
437
    $sitemap->context = array();
438 439
  }

440
  // Make sure context is sorted before saving the hash.
441 442
  //$sitemap->is_new = empty($sitemap->getId());
  //$sitemap->old_smid = $sitemap->is_new ? NULL : $sitemap->smid;
443
  $sitemap->setOriginalId($sitemap->isNew() ? NULL : $sitemap->getId());
444
  $sitemap->setId(xmlsitemap_sitemap_get_context_hash($context));
445
  // If the context was changed, we need to perform additional actions.
446
  if (!$sitemap->isNew() && $sitemap->getId() != $sitemap->getOriginalId()) {
447
    // Rename the files directory so the sitemap does not break.
448
    $old_sitemap = (object) array('smid' => $sitemap->old_smid);
449
    $old_dir = xmlsitemap_get_directory($old_sitemap);
450 451 452 453
    $new_dir = xmlsitemap_get_directory($sitemap);
    xmlsitemap_directory_move($old_dir, $new_dir);

    // Mark the sitemaps as needing regeneration.
454
    \Drupal::config('xmlsitemap.settings')->set('regenerate_needed', TRUE)->save();
455
  }
456
  $sitemap->save();
457 458

  return $sitemap;
459 460 461
}

/**
462
 * Delete an XML sitemap.
463
 *
464 465
 * @param $smid
 *   An XML sitemap ID.
466
 */
467 468
function xmlsitemap_sitemap_delete($smid) {
  xmlsitemap_sitemap_delete_multiple(array($smid));
469 470
}

Darren Oh's avatar
Darren Oh committed
471
/**
472
 * Delete multiple XML sitemaps.
473
 *
474 475
 * @param $smids
 *   An array of XML sitemap IDs.
Darren Oh's avatar
Darren Oh committed
476
 */
477 478 479 480 481
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);
482
      $sitemap->delete();
483
      \Drupal::moduleHandler()->invokeAll('xmlsitemap_sitemap_delete', array($sitemap));
484
    }
485
  }
486
}
487

488 489 490 491
/**
 * Return the expected file path for a specific sitemap chunk.
 *
 * @param $sitemap
492
 *   An XmlSitemapInterface sitemap object.
493 494 495
 * @param $chunk
 *   An optional specific chunk in the sitemap. Defaults to the index page.
 */
496
function xmlsitemap_sitemap_get_file(XmlSitemapInterface $sitemap, $chunk = 'index') {
497
  return xmlsitemap_get_directory($sitemap) . "/{$chunk}.xml";
Darren Oh's avatar
Darren Oh committed
498 499
}

500 501 502 503 504 505
/**
 * Find the maximum file size of all a sitemap's XML files.
 *
 * @param $sitemap
 *   The XML sitemap array.
 */
506
function xmlsitemap_sitemap_get_max_filesize(XmlSitemapInterface $sitemap) {
507
  $dir = xmlsitemap_get_directory($sitemap);
508
  $sitemap->setMaxFileSize(0);
509
  foreach (file_scan_directory($dir, '/\.xml$/') as $file) {
510
    $sitemap->setMaxFileSize(max($sitemap->getMaxFileSize(), filesize($file->uri)));
511
  }
512
  return $sitemap->getMaxFileSize();
513 514
}

515 516
function xmlsitemap_sitemap_get_context_hash(array &$context) {
  asort($context);
517
  return Crypt::hashBase64(serialize($context));
518 519
}

Darren Oh's avatar
Darren Oh committed
520
/**
521
 * Returns the uri elements of an XML sitemap.
522
 *
523 524
 * @param \Drupal\xmlsitemap\XmlSitemapInterface $sitemap
 *   The sitemap represented by and XmlSitemapInterface object.
525
 * @return
526 527
 *   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
528
 */
529
function xmlsitemap_sitemap_uri(XmlSitemapInterface $sitemap) {
530
  $uri['path'] = 'sitemap.xml';
531 532
  $uri['options'] = \Drupal::moduleHandler()->invokeAll('xmlsitemap_context_url_options', array($sitemap->context));
  $context = $sitemap->context;
533
  \Drupal::moduleHandler()->alter('xmlsitemap_context_url_options', $uri['options'], $context);
534 535
  $uri['options'] += array(
    'absolute' => TRUE,
536
    'base_url' => \Drupal::state()->get('base_url')
537 538 539
  );
  return $uri;
}
540

541 542 543 544 545 546 547 548 549 550 551 552 553 554 555
/**
 * 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
556
/**
557
 * Load sitemap links from the database.
558 559
 *
 * @param $conditions
560 561
 *   An array of conditions on the {xmlsitemap} table in the form
 *   'field' => $value.
562
 * @return
563
 *   An array of sitemap link arrays.
Darren Oh's avatar
Darren Oh committed
564
 */
565
function xmlsitemap_link_load_multiple(array $conditions = array()) {
566 567
  $query = db_select('xmlsitemap');
  $query->fields('xmlsitemap');
568

569 570 571
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
  }
572

573
  $links = $query->execute()->fetchAll(PDO::FETCH_ASSOC);
574

575 576 577
  return $links;
}

Darren Oh's avatar
Darren Oh committed
578
/**
579 580 581 582
 * Saves or updates a sitemap link.
 *
 * @param $link
 *   An array with a sitemap link.
Darren Oh's avatar
Darren Oh committed
583
 */
584
function xmlsitemap_link_save(array $link) {
585 586
  $link += array(
    'access' => 1,
Dave Reid's avatar
Dave Reid committed
587
    'status' => 1,
588 589
    'status_override' => 0,
    'lastmod' => 0,
590
    'priority' => XMLSITEMAP_PRIORITY_DEFAULT,
591 592 593
    'priority_override' => 0,
    'changefreq' => 0,
    'changecount' => 0,
594
    'language' => LanguageInterface::LANGCODE_NOT_SPECIFIED,
595 596 597 598 599 600 601 602 603
  );

  // Allow other modules to alter the link before saving.
  drupal_alter('xmlsitemap_link', $link);

  // 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
604
  }
605 606 607 608 609
  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;
  }

610
  $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();
611 612

  // Check if this is a changed link and set the regenerate flag if necessary.
613
  if (!\Drupal::config('xmlsitemap.settings')->get('regenerate_needed')) {
614 615 616
    _xmlsitemap_check_changed_link($link, $existing, TRUE);
  }

617
  // Save the link and allow other modules to respond to the link being saved.
618
  if ($existing) {
619
    drupal_write_record('xmlsitemap', $link, array('type', 'id'));
620
    \Drupal::moduleHandler()->invokeAll('xmlsitemap_link_update', array($link));
621 622
  }
  else {
623
    $result = drupal_write_record('xmlsitemap', $link);
624
    \Drupal::moduleHandler()->invokeAll('xmlsitemap_link_insert', array($link));
625 626 627
  }

  return $link;
Darren Oh's avatar
Darren Oh committed
628 629 630
}

/**
631 632 633 634 635 636 637 638 639 640 641
 * 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
642
 */
643
function xmlsitemap_link_update_multiple($updates = array(), $conditions = array(), $check_flag = TRUE) {
644 645
  // If we are going to modify a visible sitemap link, we will need to set
  // the regenerate needed flag.
646
  if ($check_flag && !\Drupal::config('xmlsitemap.settings')->get('regenerate_needed')) {
647 648 649 650
    _xmlsitemap_check_changed_links($conditions, $updates, TRUE);
  }

  // Process updates.
651 652 653 654 655
  $query = db_update('xmlsitemap');
  $query->fields($updates);
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
  }
656

657
  return $query->execute();
Darren Oh's avatar
Darren Oh committed
658 659
}

660
/**
661
 * Delete a specific sitemap link from the database.
662 663 664 665
 *
 * If a visible sitemap link was deleted, this will automatically set the
 * regenerate needed flag.
 *
666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683
 * @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.
 *
684
 * @param $conditions
685 686
 *   An array of conditions on the {xmlsitemap} table in the form
 *   'field' => $value.
687 688
 * @return
 *   The number of links that were deleted.
689
 */
690
function xmlsitemap_link_delete_multiple(array $conditions) {
691 692 693
  // 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().
694
  // @todo Remove this check when http://drupal.org/node/151452 is fixed.
695 696 697 698
  if (!db_table_exists('xmlsitemap')) {
    return FALSE;
  }

699
  if (!\Drupal::config('xmlsitemap.settings')->get('regenerate_needed')) {
700
    _xmlsitemap_check_changed_links($conditions, array(), TRUE);
701
  }
702

703 704
  // @todo Add a hook_xmlsitemap_link_delete() hook invoked here.

705 706 707 708
  $query = db_delete('xmlsitemap');
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
  }
709

710
  return $query->execute();
711 712
}

Darren Oh's avatar
Darren Oh committed
713
/**
714
 * Check if there is a visible sitemap link given a certain set of conditions.
715
 *
716 717 718 719 720 721 722
 * @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.
723
 */
724 725
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.
726 727
  $conditions['status'] = (!empty($updates['status']) && empty($conditions['status'])) ? 0 : 1;
  $conditions['access'] = (!empty($updates['access']) && empty($conditions['access'])) ? 0 : 1;
728

729 730 731 732
  $query = db_select('xmlsitemap');
  $query->addExpression('1');
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
733
  }
734 735
  $query->range(0, 1);
  $changed = $query->execute()->fetchField();
736

737
  if ($changed && $flag) {
738
    \Drupal::config('xmlsitemap.settings')->set('regenerate_needed', TRUE)->save();
Darren Oh's avatar
Darren Oh committed
739
  }
740

741
  return $changed;
Darren Oh's avatar
Darren Oh committed
742 743 744
}

/**
745
 * Check if there is sitemap link is changed from the existing data.
746
 *
747 748 749 750 751 752 753 754 755 756 757
 * @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
758
 */
759 760
function _xmlsitemap_check_changed_link(array $link, $original_link = NULL, $flag = FALSE) {
  $changed = FALSE;
761

762 763 764 765
  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
766

767 768 769 770
  if (!$original_link) {
    if ($link['access'] && $link['status']) {
      // Adding a new visible link.
      $changed = TRUE;
Darren Oh's avatar
Darren Oh committed
771
    }
772
  }
773 774 775 776 777 778 779 780
  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
781 782
    }
  }
783 784

  if ($changed && $flag) {
785
    \Drupal::config('xmlsitemap.settings')->set('regenerate_needed', TRUE)->save();
786 787
  }

788
  return $changed;
Darren Oh's avatar
Darren Oh committed
789 790 791
}

/**
792
 * @} End of "defgroup xmlsitemap_api"
793
 */
794
function xmlsitemap_get_directory(XmlSitemapInterface $sitemap = NULL) {
795 796
  $directory = &drupal_static(__FUNCTION__);
  if (!isset($directory)) {
797
    $directory = \Drupal::config('xmlsitemap.settings')->get('path');
Darren Oh's avatar
Darren Oh committed
798
  }
799

800
  if ($sitemap != NULL && !empty($sitemap->id)) {
801
    return file_build_uri($directory . '/' . $sitemap->id);
802 803 804 805
  }
  else {
    return file_build_uri($directory);
  }
Darren Oh's avatar
Darren Oh committed
806 807 808
}

/**
809
 * Check that the sitemap files directory exists and is writable.
Darren Oh's avatar
Darren Oh committed
810
 */
811
function xmlsitemap_check_directory(XmlSitemapInterface $sitemap = NULL) {
812 813 814 815 816 817 818 819
  $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;
}

820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841
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;
}

842
function xmlsitemap_clear_directory(XmlSitemapInterface $sitemap = NULL, $delete = FALSE) {
843 844 845 846
  $directory = xmlsitemap_get_directory($sitemap);
  return _xmlsitemap_delete_recursive($directory, $delete);
}

847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879
/**
 * 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;
}

880 881 882 883 884 885 886 887
/**
 * 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
888
 *   A filepath relative to the Drupal root directory.
889 890 891 892 893 894 895 896 897 898 899 900 901
 * @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;
902
      file_unmanaged_delete_recursive($entry_path, NULL);
903 904
    }
    $dir->close();
905
    return $delete_root ? drupal_rmdir($path) : TRUE;
906 907
  }
  return file_unmanaged_delete($path);
Darren Oh's avatar
Darren Oh committed
908 909 910
}

/**
911 912 913 914 915 916 917 918 919 920 921
 * 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
922
 */
923
function xmlsitemap_get_link_info($type = NULL, $reset = FALSE) {
924
  $language = \Drupal::languageManager()->getCurrentLanguage();
925
  $link_info = &drupal_static(__FUNCTION__);
926

927 928
  if ($reset) {
    $link_info = NULL;
929 930 931
    foreach (\Drupal::languageManager()->getLanguages() as $lang) {
      \Drupal::cache()->