xmlsitemap.module 47.3 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 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33

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

34 35 36 37 38 39 40 41 42 43 44 45 46 47 48
/**
 * 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');

49 50 51 52 53 54 55 56 57 58
/**
 * 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);

59 60 61 62
/**
 * Implements hook_hook_info().
 */
function xmlsitemap_hook_info() {
63 64 65 66 67 68 69
  $hooks = array(
    'xmlsitemap_link_info',
    'xmlsitemap_link_info_alter',
    'xmlsitemap_link_alter',
    'xmlsitemap_index_links',
    'xmlsitemap_context_info',
    'xmlsitemap_context_info_alter',
70
    'xmlsitemap_context_url_options',
71
    'xmlsitemap_context',
72 73
    'xmlsitemap_sitemap_insert',
    'xmlsitemap_sitemap_update',
74 75 76 77
    'xmlsitemap_sitemap_operations',
    'xmlsitemap_sitemap_delete',
    'xmlsitemap_sitemap_link_url_options_alter',
    'query_xmlsitemap_generate_alter',
78
    'query_xmlsitemap_link_bundle_access_alter',
79
    'form_xmlsitemap_sitemap_edit_form_alter',
80
  );
81 82 83 84 85

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

87 88 89
  return $hooks;
}

90 91
/**
 * Implements hook_help().
Darren Oh's avatar
Darren Oh committed
92
 */
93
function xmlsitemap_help($path, Request $request) {
94 95
  $output = '';

96
  switch ($path) {
97
    case 'help.page.xmlsitemap':
98
    case 'admin/config/search/xmlsitemap/settings/%/%/%':
Dave Reid's avatar
Dave Reid committed
99 100
    case 'admin/config/search/xmlsitemap/edit/%':
    case 'admin/config/search/xmlsitemap/delete/%':
101
      return;
102 103
    case 'admin/help#xmlsitemap':
      break;
104
    case 'admin/config/search/xmlsitemap':
105
      break;
106
    case 'admin/config/search/xmlsitemap/rebuild':
107 108 109
      $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>';
  }

110 111
  $currentUser = \Drupal::currentUser();
  if (arg(0) == 'admin' && strpos($path, 'xmlsitemap') !== FALSE && $currentUser->hasPermission('administer xmlsitemap')) {
112
    module_load_include('inc', 'xmlsitemap');
113 114
    // Alert the user to any potential problems detected by hook_requirements.
    xmlsitemap_check_status();
115
    $output .= _xmlsitemap_get_blurb();
Darren Oh's avatar
Darren Oh committed
116
  }
117 118 119 120 121 122 123

  return $output;
}

/**
 * Implements hook_perm().
 */
Dave Reid's avatar
Dave Reid committed
124
function xmlsitemap_permission() {
125 126
  $permissions['administer xmlsitemap'] = array(
    'title' => t('Administer XML sitemap settings.'),
Dave Reid's avatar
Dave Reid committed
127
  );
128
  return $permissions;
Darren Oh's avatar
Darren Oh committed
129 130 131
}

/**
132
 * Implements hook_menu().
Darren Oh's avatar
Darren Oh committed
133
 */
134
function xmlsitemap_menu() {
135
  $items['admin/config/search/xmlsitemap'] = array(
136
    'title' => 'XML sitemap',
137
    'description' => "Configure your site's XML sitemaps to help search engines find and index pages on your site.",
138
    'page callback' => 'drupal_get_form',
139
    'page arguments' => array('xmlsitemap_sitemap_list_form'),
140 141
    'access arguments' => array('administer xmlsitemap'),
    'file' => 'xmlsitemap.admin.inc',
142
  );
143 144 145 146 147 148 149 150 151 152 153 154
  $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',
155
    'modal' => TRUE,
156
    'options' => array('modal' => TRUE),
157 158
  );
  $items['admin/config/search/xmlsitemap/edit/%xmlsitemap_sitemap'] = array(
159
    'title' => 'Edit XML sitemap',
160 161 162 163
    'page callback' => 'drupal_get_form',
    'page arguments' => array('xmlsitemap_sitemap_edit_form', 5),
    'access arguments' => array('administer xmlsitemap'),
    'file' => 'xmlsitemap.admin.inc',
164
    'modal' => TRUE,
165 166
  );
  $items['admin/config/search/xmlsitemap/delete/%xmlsitemap_sitemap'] = array(
167
    'title' => 'Delete XML sitemap',
168 169 170 171
    'page callback' => 'drupal_get_form',
    'page arguments' => array('xmlsitemap_sitemap_delete_form', 5),
    'access arguments' => array('administer xmlsitemap'),
    'file' => 'xmlsitemap.admin.inc',
172
    'modal' => TRUE,
173
  );
174

175
  $items['admin/config/search/xmlsitemap/settings'] = array(
176
    'title' => 'Settings',
177 178
    'page callback' => 'drupal_get_form',
    'page arguments' => array('xmlsitemap_settings_form'),
179
    'access arguments' => array('administer xmlsitemap'),
180
    'type' => MENU_LOCAL_TASK,
181
    'file' => 'xmlsitemap.admin.inc',
182
    'weight' => 10,
183
  );
184 185 186 187 188 189 190 191 192 193
  $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,
  );

194
  $items['admin/config/search/xmlsitemap/rebuild'] = array(
195
    'title' => 'Rebuild links',
196
    'description' => 'Rebuild the site map.',
197
    'page callback' => 'drupal_get_form',
198
    'page arguments' => array('xmlsitemap_rebuild_form'),
199
    'access callback' => '_xmlsitemap_rebuild_form_access',
200
    'type' => MENU_LOCAL_TASK,
201
    'file' => 'xmlsitemap.admin.inc',
202
    'weight' => 20,
203 204 205
  );

  $items['sitemap.xml'] = array(
206
    'page callback' => 'xmlsitemap_output_chunk',
207
    'access callback' => TRUE,
208 209 210 211 212 213
    'type' => MENU_CALLBACK,
    'file' => 'xmlsitemap.pages.inc',
  );
  $items['sitemap.xsl'] = array(
    'page callback' => 'xmlsitemap_output_xsl',
    'access callback' => TRUE,
214
    'type' => MENU_CALLBACK,
215
    'file' => 'xmlsitemap.pages.inc',
216 217
  );

Darren Oh's avatar
Darren Oh committed
218 219 220
  return $items;
}

221 222 223 224 225 226 227 228 229
/**
 * 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();
  return !empty($rebuild_types) && user_access('administer xmlsitemap');
}

Darren Oh's avatar
Darren Oh committed
230
/**
231
 * Implements hook_cron().
232 233 234
 *
 * @todo Use new Queue system. Need to add {sitemap}.queued.
 * @todo Regenerate one at a time?
Darren Oh's avatar
Darren Oh committed
235
 */
236
function xmlsitemap_cron() {
237
  // If there were no new or changed links, skip.
238
  if (!\Drupal::config('xmlsitemap.settings')->get('regenerate_needed')) {
239 240 241
    return;
  }

242
  // If the minimum sitemap lifetime hasn't been passed, skip.
243 244
  $lifetime = REQUEST_TIME - \Drupal::config('xmlsitemap.settings')->get('generated_last');
  if ($lifetime < \Drupal::config('xmlsitemap.settings')->get('minimum_lifetine')) {
245 246 247 248
    return;
  }

  // Regenerate the sitemap XML files.
249
  module_load_include('generate.inc', 'xmlsitemap');
250
  xmlsitemap_run_unprogressive_batch('xmlsitemap_regenerate_batch');
Darren Oh's avatar
Darren Oh committed
251 252
}

253 254 255 256 257 258 259 260 261 262 263 264 265 266
/**
 * 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
267
/**
268
 * Implements hook_robotstxt().
Darren Oh's avatar
Darren Oh committed
269
 */
270
function xmlsitemap_robotstxt() {
271
  if ($sitemap = xmlsitemap_sitemap_load_by_context()) {
272
    $robotstxt[] = 'Sitemap: ' . url($sitemap->uri['path'], $sitemap->uri['options']);
273
    return $robotstxt;
274
  }
Darren Oh's avatar
Darren Oh committed
275 276
}

277
/**
278
 * Internal default variables for xmlsitemap_var().
279
 */
280 281
function xmlsitemap_variables() {
  return array(
282 283 284 285 286 287 288 289 290 291 292 293 294 295 296
    'rebuild_needed' => FALSE,
    'regenerate_needed' => FALSE,
    'minimum_lifetine' => 0,
    '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,
297
    // Removed variables are set to NULL so they can still be deleted.
298 299 300 301 302 303
    'regenerate_last' => NULL,
    'custom_links' => NULL,
    'priority_default' => NULL,
    'languages' => NULL,
    'max_chunks' => NULL,
    'max_filesize' => NULL,
304 305 306 307 308 309 310 311 312 313
  );
}

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

316 317 318
  // @todo Remove when stable.
  if (!isset($defaults[$name])) {
    trigger_error(strtr('Default variable for %variable not found.', array('%variable' => drupal_placeholder($name))));
319 320
  }

321
  return \Drupal::config('xmlsitemap.settings')->get($name);
322
  return variable_get($name, isset($default) || !isset($defaults[$name]) ? $default : $defaults[$name]);
323 324
}

Darren Oh's avatar
Darren Oh committed
325
/**
326
 * @defgroup xmlsitemap_api XML sitemap API.
327
 * @{
328 329
 * 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
330
 */
331 332 333 334 335 336

/**
 * Load an XML sitemap array from the database.
 *
 * @param $smid
 *   An XML sitemap ID.
337 338 339
 *
 * @return
 *   The XML sitemap object.
340 341 342 343
 */
function xmlsitemap_sitemap_load($smid) {
  $sitemap = xmlsitemap_sitemap_load_multiple(array($smid));
  return $sitemap ? reset($sitemap) : FALSE;
Darren Oh's avatar
Darren Oh committed
344 345 346
}

/**
347 348 349
 * Load multiple XML sitemaps from the database.
 *
 * @param $smids
350 351 352
 *   An array of XML sitemap IDs, or FALSE to load all XML sitemaps.
 * @param $conditions
 *   An array of conditions in the form 'field' => $value.
353 354 355
 *
 * @return
 *   An array of XML sitemap objects.
Darren Oh's avatar
Darren Oh committed
356
 */
357 358 359 360
function xmlsitemap_sitemap_load_multiple($smids = array(), array $conditions = array()) {
  if ($smids !== FALSE) {
    $conditions['smid'] = $smids;
  }
361 362
  else {
    $conditions['smid'] = array();
363
  }
364
  $storage = Drupal::entityManager()->getStorage('xmlsitemap');
365

366 367 368 369 370 371 372 373 374 375 376
  $sitemaps = $storage->loadMultiple($conditions['smid']);
  /* $query = db_select('xmlsitemap_sitemap');
    $query->fields('xmlsitemap_sitemap');
    foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
    }
    $sitemaps = $query->execute()->fetchAllAssoc('smid');
   */
  foreach ($sitemaps as $sitemap) {
    $sitemaps[$sitemap->id()]->setContext(unserialize($sitemap->getContext()));
    $sitemaps[$sitemap->id()]->uri = xmlsitemap_sitemap_uri($sitemap);
Darren Oh's avatar
Darren Oh committed
377
  }
378

379
  return $sitemaps;
380 381 382
}

/**
383
 * Load an XML sitemap array from the database based on its context.
384
 *
385 386
 * @param $context
 *   An optional XML sitemap context array to use to find the correct XML
387
 *   sitemap. If not provided, the current site's context will be used.
388
 *
389
 * @see xmlsitemap_get_current_context()
390
 */
391 392 393
function xmlsitemap_sitemap_load_by_context(array $context = NULL) {
  if (!isset($context)) {
    $context = xmlsitemap_get_current_context();
Darren Oh's avatar
Darren Oh committed
394
  }
395
  $hash = xmlsitemap_sitemap_get_context_hash($context);
396 397 398 399 400 401 402 403
  $sitemaps = \Drupal::entityManager()->getStorage('xmlsitemap')->loadMultiple();
  return reset($sitemaps);
  foreach ($sitemaps as $sitemap) {
    if ($sitemap->getContext() == $hash) {
      return $sitemap;
    }
  }
  return NULL;
Darren Oh's avatar
Darren Oh committed
404 405 406
}

/**
407
 * Save changes to an XML sitemap or add a new XML sitemap.
408
 *
409
 * @param $sitemap
410
 *   The XML sitemap array to be saved. If $sitemap->smid is omitted, a new
411 412 413
 *   XML sitemap will be added.
 *
 * @todo Save the sitemap's URL as a column?
Darren Oh's avatar
Darren Oh committed
414
 */
415
function xmlsitemap_sitemap_save(XmlSitemapInterface $sitemap) {
416 417
  $context = $sitemap->getContext();
  if (!isset($context) || !$context) {
418
    $sitemap->setContext(array());
419 420
  }

421
  // Make sure context is sorted before saving the hash.
422 423
  //$sitemap->is_new = empty($sitemap->getId());
  //$sitemap->old_smid = $sitemap->is_new ? NULL : $sitemap->smid;
424
  $sitemap->setOriginalId($sitemap->isNew() ? NULL : $sitemap->getId());
425 426
  //$sitemap->smid = xmlsitemap_sitemap_get_context_hash($sitemap->context);
  $sitemap->setId(xmlsitemap_sitemap_get_context_hash($sitemap->getContext()));
427
  // If the context was changed, we need to perform additional actions.
428
  if (!$sitemap->isNew() && $sitemap->getId() != $sitemap->getOriginalId()) {
429
    // Rename the files directory so the sitemap does not break.
430
    $old_sitemap = (object) array('smid' => $sitemap->old_smid);
431
    $old_dir = xmlsitemap_get_directory($old_sitemap);
432 433 434 435
    $new_dir = xmlsitemap_get_directory($sitemap);
    xmlsitemap_directory_move($old_dir, $new_dir);

    // Mark the sitemaps as needing regeneration.
436
    \Drupal::config('xmlsitemap.settings')->set('regenerate_needed', TRUE);
437
  }
438
  $sitemap->save();
439 440

  return $sitemap;
441 442 443
}

/**
444
 * Delete an XML sitemap.
445
 *
446 447
 * @param $smid
 *   An XML sitemap ID.
448
 */
449 450
function xmlsitemap_sitemap_delete($smid) {
  xmlsitemap_sitemap_delete_multiple(array($smid));
451 452
}

Darren Oh's avatar
Darren Oh committed
453
/**
454
 * Delete multiple XML sitemaps.
455
 *
456 457
 * @param $smids
 *   An array of XML sitemap IDs.
Darren Oh's avatar
Darren Oh committed
458
 */
459 460 461
function xmlsitemap_sitemap_delete_multiple(array $smids) {
  if (!empty($smids)) {
    $sitemaps = xmlsitemap_sitemap_load_multiple($smids);
462 463 464 465 466
    /*
      db_delete('xmlsitemap_sitemap')
      ->condition('smid', $smids)
      ->execute();
     */
467 468
    foreach ($sitemaps as $sitemap) {
      xmlsitemap_clear_directory($sitemap, TRUE);
469
      $sitemap->delete();
470 471
      module_invoke_all('xmlsitemap_sitemap_delete', $sitemap);
    }
472
  }
473
}
474

475 476 477 478
/**
 * Return the expected file path for a specific sitemap chunk.
 *
 * @param $sitemap
479
 *   An XmlSitemapInterface sitemap object.
480 481 482
 * @param $chunk
 *   An optional specific chunk in the sitemap. Defaults to the index page.
 */
483
function xmlsitemap_sitemap_get_file(XmlSitemapInterface $sitemap, $chunk = 'index') {
484
  return xmlsitemap_get_directory($sitemap) . "/{$chunk}.xml";
Darren Oh's avatar
Darren Oh committed
485 486
}

487 488 489 490 491 492
/**
 * Find the maximum file size of all a sitemap's XML files.
 *
 * @param $sitemap
 *   The XML sitemap array.
 */
493
function xmlsitemap_sitemap_get_max_filesize(XmlSitemapInterface $sitemap) {
494
  $dir = xmlsitemap_get_directory($sitemap);
495
  $sitemap->setMaxFileSize(0);
496
  foreach (file_scan_directory($dir, '/\.xml$/') as $file) {
497
    $sitemap->setMaxFileSize(max($sitemap->getMaxFileSize(), filesize($file->uri)));
498
  }
499
  return $sitemap->getMaxFileSize();
500 501
}

502 503
function xmlsitemap_sitemap_get_context_hash(array &$context) {
  asort($context);
504
  return Crypt::hashBase64(serialize($context));
505 506
}

Darren Oh's avatar
Darren Oh committed
507
/**
508
 * Returns the uri elements of an XML sitemap.
509
 *
510 511
 * @param \Drupal\xmlsitemap\XmlSitemapInterface $sitemap
 *   The sitemap represented by and XmlSitemapInterface object.
512
 * @return
513 514
 *   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
515
 */
516
function xmlsitemap_sitemap_uri(XmlSitemapInterface $sitemap) {
517
  $uri['path'] = 'sitemap.xml';
518 519
  $uri['options'] = module_invoke_all('xmlsitemap_context_url_options', $sitemap->getContext());
  drupal_alter('xmlsitemap_context_url_options', $uri['options'], $sitemap->getContext());
520 521
  $uri['options'] += array(
    'absolute' => TRUE,
522
    'base_url' => $GLOBALS['base_url'],
523 524 525
  );
  return $uri;
}
526

527 528 529 530 531 532 533 534 535 536 537 538 539 540 541
/**
 * 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
542
/**
543
 * Load sitemap links from the database.
544 545
 *
 * @param $conditions
546 547
 *   An array of conditions on the {xmlsitemap} table in the form
 *   'field' => $value.
548
 * @return
549
 *   An array of sitemap link arrays.
Darren Oh's avatar
Darren Oh committed
550
 */
551
function xmlsitemap_link_load_multiple(array $conditions = array()) {
552 553
  $query = db_select('xmlsitemap');
  $query->fields('xmlsitemap');
554

555 556 557
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
  }
558

559
  $links = $query->execute()->fetchAll(PDO::FETCH_ASSOC);
560

561 562 563
  return $links;
}

Darren Oh's avatar
Darren Oh committed
564
/**
565 566 567 568
 * Saves or updates a sitemap link.
 *
 * @param $link
 *   An array with a sitemap link.
Darren Oh's avatar
Darren Oh committed
569
 */
570
function xmlsitemap_link_save(array $link) {
571 572
  $link += array(
    'access' => 1,
Dave Reid's avatar
Dave Reid committed
573
    'status' => 1,
574 575
    'status_override' => 0,
    'lastmod' => 0,
576
    'priority' => XMLSITEMAP_PRIORITY_DEFAULT,
577 578 579
    'priority_override' => 0,
    'changefreq' => 0,
    'changecount' => 0,
580
    'language' => LanguageInterface::LANGCODE_NOT_SPECIFIED,
581 582 583 584 585 586 587 588 589
  );

  // 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
590
  }
591 592 593 594 595
  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;
  }

596
  $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();
597 598

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

603
  // Save the link and allow other modules to respond to the link being saved.
604
  if ($existing) {
605
    drupal_write_record('xmlsitemap', $link, array('type', 'id'));
606
    module_invoke_all('xmlsitemap_link_update', $link);
607 608
  }
  else {
609
    drupal_write_record('xmlsitemap', $link);
610
    module_invoke_all('xmlsitemap_link_insert', $link);
611 612 613
  }

  return $link;
Darren Oh's avatar
Darren Oh committed
614 615 616
}

/**
617 618 619 620 621 622 623 624 625 626 627
 * 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
628
 */
629
function xmlsitemap_link_update_multiple($updates = array(), $conditions = array(), $check_flag = TRUE) {
630 631
  // If we are going to modify a visible sitemap link, we will need to set
  // the regenerate needed flag.
632
  if ($check_flag && !\Drupal::config('xmlsitemap.settings')->get('regenerate_needed')) {
633 634 635 636
    _xmlsitemap_check_changed_links($conditions, $updates, TRUE);
  }

  // Process updates.
637 638 639 640 641
  $query = db_update('xmlsitemap');
  $query->fields($updates);
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
  }
642

643
  return $query->execute();
Darren Oh's avatar
Darren Oh committed
644 645
}

646
/**
647
 * Delete a specific sitemap link from the database.
648 649 650 651
 *
 * If a visible sitemap link was deleted, this will automatically set the
 * regenerate needed flag.
 *
652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669
 * @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.
 *
670
 * @param $conditions
671 672
 *   An array of conditions on the {xmlsitemap} table in the form
 *   'field' => $value.
673 674
 * @return
 *   The number of links that were deleted.
675
 */
676
function xmlsitemap_link_delete_multiple(array $conditions) {
677 678 679
  // 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().
680
  // @todo Remove this check when http://drupal.org/node/151452 is fixed.
681 682 683 684
  if (!db_table_exists('xmlsitemap')) {
    return FALSE;
  }

685
  if (!\Drupal::config('xmlsitemap.settings')->get('regenerate_needed')) {
686
    _xmlsitemap_check_changed_links($conditions, array(), TRUE);
687
  }
688

689 690
  // @todo Add a hook_xmlsitemap_link_delete() hook invoked here.

691 692 693 694
  $query = db_delete('xmlsitemap');
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
  }
695

696
  return $query->execute();
697 698
}

Darren Oh's avatar
Darren Oh committed
699
/**
700
 * Check if there is a visible sitemap link given a certain set of conditions.
701
 *
702 703 704 705 706 707 708
 * @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.
709
 */
710 711
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.
712 713
  $conditions['status'] = (!empty($updates['status']) && empty($conditions['status'])) ? 0 : 1;
  $conditions['access'] = (!empty($updates['access']) && empty($conditions['access'])) ? 0 : 1;
714

715 716 717 718
  $query = db_select('xmlsitemap');
  $query->addExpression('1');
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
719
  }
720 721
  $query->range(0, 1);
  $changed = $query->execute()->fetchField();
722

723
  if ($changed && $flag) {
724
    \Drupal::config('xmlsitemap.settings')->set('regenerate_needed', TRUE);
Darren Oh's avatar
Darren Oh committed
725
  }
726

727
  return $changed;
Darren Oh's avatar
Darren Oh committed
728 729 730
}

/**
731
 * Check if there is sitemap link is changed from the existing data.
732
 *
733 734 735 736 737 738 739 740 741 742 743
 * @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
744
 */
745 746
function _xmlsitemap_check_changed_link(array $link, $original_link = NULL, $flag = FALSE) {
  $changed = FALSE;
747

748 749 750 751
  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
752

753 754 755 756
  if (!$original_link) {
    if ($link['access'] && $link['status']) {
      // Adding a new visible link.
      $changed = TRUE;
Darren Oh's avatar
Darren Oh committed
757
    }
758
  }
759 760 761 762 763 764 765 766
  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
767 768
    }
  }
769 770

  if ($changed && $flag) {
771
    \Drupal::config('xmlsitemap.settings')->set('regenerate_needed', TRUE);
772 773
  }

774
  return $changed;
Darren Oh's avatar
Darren Oh committed
775 776 777
}

/**
778
 * @} End of "defgroup xmlsitemap_api"
779
 */
780
function xmlsitemap_get_directory(XmlSitemapInterface  $sitemap = NULL) {
781 782
  $directory = &drupal_static(__FUNCTION__);
  if (!isset($directory)) {
783
    $directory = \Drupal::config('xmlsitemap.settings')->get('path');
Darren Oh's avatar
Darren Oh committed
784
  }
785

786
  if ($sitemap != NULL && !empty($sitemap->id)) {
787
    return file_build_uri($directory . '/' . $sitemap->id);
788 789 790 791
  }
  else {
    return file_build_uri($directory);
  }
Darren Oh's avatar
Darren Oh committed
792 793 794
}

/**
795
 * Check that the sitemap files directory exists and is writable.
Darren Oh's avatar
Darren Oh committed
796
 */
797
function xmlsitemap_check_directory(stdClass $sitemap = NULL) {
798 799 800 801 802 803 804 805
  $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;
}

806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827
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;
}

828
function xmlsitemap_clear_directory(stdClass $sitemap = NULL, $delete = FALSE) {
829 830 831 832
  $directory = xmlsitemap_get_directory($sitemap);
  return _xmlsitemap_delete_recursive($directory, $delete);
}

833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865
/**
 * 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;
}

866 867 868 869 870 871 872 873
/**
 * 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
874
 *   A filepath relative to the Drupal root directory.
875 876 877 878 879 880 881 882 883 884 885 886 887
 * @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;
888
      file_unmanaged_delete_recursive($entry_path, NULL);
889 890
    }
    $dir->close();
891
    return $delete_root ? drupal_rmdir($path) : TRUE;
892 893
  }
  return file_unmanaged_delete($path);
Darren Oh's avatar
Darren Oh committed
894 895 896
}

/**
897 898 899 900 901 902 903 904 905 906 907
 * 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
908
 */
909
function xmlsitemap_get_link_info($type = NULL, $reset = FALSE) {
910
  global $language;
911
  $link_info = &drupal_static(__FUNCTION__);
912

913 914
  if ($reset) {
    $link_info = NULL;
915
    cache_clear_all('xmlsitemap:link_info:', 'cache', TRUE);
916 917
  }

918
  if (!isset($link_info)) {
919
    $cid = 'xmlsitemap:link_info:' . $language->language;
920
    if ($cache = \Drupal::cache()->get($cid)) {
921
      $link_info = $cache->data;
922
    }
923 924 925 926 927 928 929 930 931 932 933 934 935 936
    else {
      entity_info_cache_clear();
      $link_info = entity_get_info();
      foreach ($link_info as $key => $info) {
        if (empty($info['uri callback']) || !isset($info['xmlsitemap'])) {
          // Remove any non URL-able or XML sitemap un-supported entites.
          unset($link_info[$key]);
        }
        foreach ($info['bundles'] as $bundle_key => $bundle) {
          if (!isset($bundle['xmlsitemap'])) {
            // Remove any un-supported entity bundles.
            //unset($link_info[$key]['bundles'][$bundle_key]);
          }
        }
937
      }
938 939 940 941 942 943
      $link_info = array_merge($link_info, module_invoke_all('xmlsitemap_link_info'));
      foreach ($link_info as $key => &$info) {
        $info += array(
          'type' => $key,
          'base table' => FALSE,
          'bundles' => array(),
944 945
          'xmlsitemap' => array(),
        );
946 947 948 949 950 951 952 953 954
        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);
        }
955
      }
956 957 958
      drupal_alter('xmlsitemap_link_info', $link_info);
      ksort($link_info);
      // Cache by language since this info contains translated strings.
959
      \Drupal::cache()->set($cid, $link_info);
960
    }
Darren Oh's avatar
Darren Oh committed
961
  }
962 963 964 965 966 967

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

  return $link_info;
Darren Oh's avatar
Darren Oh committed
968 969
}

970 971 972 973
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) {
974
    $settings = xmlsitemap_link_bundle_load($entity_type, $bundle);
975
    if (!empty($settings['status'])) {
976
      //if (!empty($bundle_info['xmlsitemap']['status'])) {
977 978 979 980 981 982
      $bundles[] = $bundle;
    }
  }
  return $bundles;
}

983 984 985
function xmlsitemap_get_link_type_indexed_status($entity_type, $bundle = '') {
  $info = xmlsitemap_get_link_info($entity_type);

986 987
  $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();
988

Dave Reid's avatar