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

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

/**
8 9 10
 * @file
 * Main file for the xmlsitemap module.
 */
11
use Drupal\Component\Utility\Crypt;
12 13
use Drupal\Core\Session\UserSession;
use Symfony\Component\HttpFoundation\Request;
14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31

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

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

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

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

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

85 86 87
  return $hooks;
}

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

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

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

  return $output;
}

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

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

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

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

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

Darren Oh's avatar
Darren Oh committed
216 217 218
  return $items;
}

219 220 221 222 223 224 225 226 227
/**
 * 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
228
/**
229
 * Implements hook_cron().
230 231 232
 *
 * @todo Use new Queue system. Need to add {sitemap}.queued.
 * @todo Regenerate one at a time?
Darren Oh's avatar
Darren Oh committed
233
 */
234
function xmlsitemap_cron() {
235
  // If there were no new or changed links, skip.
236
  if (!\Drupal::config('xmlsitemap.settings')->get('regenerate_needed')) {
237 238 239
    return;
  }

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

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

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

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

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

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

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

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

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

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

  $query = db_select('xmlsitemap_sitemap');
  $query->fields('xmlsitemap_sitemap');
362 363 364 365
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
  }

366
  $sitemaps = $query->execute()->fetchAllAssoc('smid');
367
  foreach ($sitemaps as $smid => $sitemap) {
368 369
    $sitemaps[$smid]->context = unserialize($sitemap->context);
    $sitemaps[$smid]->uri = xmlsitemap_sitemap_uri($sitemaps[$smid]);
Darren Oh's avatar
Darren Oh committed
370
  }
371

372
  return $sitemaps;
373 374 375
}

/**
376
 * Load an XML sitemap array from the database based on its context.
377
 *
378 379
 * @param $context
 *   An optional XML sitemap context array to use to find the correct XML
380
 *   sitemap. If not provided, the current site's context will be used.
381
 *
382
 * @see xmlsitemap_get_current_context()
383
 */
384 385 386
function xmlsitemap_sitemap_load_by_context(array $context = NULL) {
  if (!isset($context)) {
    $context = xmlsitemap_get_current_context();
Darren Oh's avatar
Darren Oh committed
387
  }
388 389
  $hash = xmlsitemap_sitemap_get_context_hash($context);
  $smid = db_query_range("SELECT smid FROM {xmlsitemap_sitemap} WHERE smid = :hash", 0, 1, array(':hash' => $hash))->fetchField();
390
  return xmlsitemap_sitemap_load($smid);
Darren Oh's avatar
Darren Oh committed
391 392 393
}

/**
394
 * Save changes to an XML sitemap or add a new XML sitemap.
395
 *
396
 * @param $sitemap
397
 *   The XML sitemap array to be saved. If $sitemap->smid is omitted, a new
398 399 400
 *   XML sitemap will be added.
 *
 * @todo Save the sitemap's URL as a column?
Darren Oh's avatar
Darren Oh committed
401
 */
402
function xmlsitemap_sitemap_save(stdClass $sitemap) {
403 404 405 406
  if (!isset($sitemap->context)) {
    $sitemap->context = array();
  }

407
  // Make sure context is sorted before saving the hash.
408 409
  $sitemap->is_new = empty($sitemap->smid);
  $sitemap->old_smid = $sitemap->is_new ? NULL : $sitemap->smid;
410
  $sitemap->smid = xmlsitemap_sitemap_get_context_hash($sitemap->context);
411

412
  // If the context was changed, we need to perform additional actions.
413
  if (!$sitemap->is_new && $sitemap->smid != $sitemap->old_smid) {
414
    // Rename the files directory so the sitemap does not break.
415
    $old_sitemap = (object) array('smid' => $sitemap->old_smid);
416
    $old_dir = xmlsitemap_get_directory($old_sitemap);
417 418 419 420 421
    $new_dir = xmlsitemap_get_directory($sitemap);
    xmlsitemap_directory_move($old_dir, $new_dir);

    // Change the smid field so drupal_write_record() does not fail.
    db_update('xmlsitemap_sitemap')
422
      ->fields(array('smid' => $sitemap->smid))
423
      ->condition('smid', $sitemap->old_smid)
424 425 426
      ->execute();

    // Mark the sitemaps as needing regeneration.
427
    \Drupal::config('xmlsitemap.settings')->set('regenerate_needed', TRUE);
428
  }
429

430
  if ($sitemap->is_new) {
431
    drupal_write_record('xmlsitemap_sitemap', $sitemap);
432 433 434 435 436
    module_invoke_all('xmlsitemap_sitemap_insert', $sitemap);
  }
  else {
    drupal_write_record('xmlsitemap_sitemap', $sitemap, array('smid'));
    module_invoke_all('xmlsitemap_sitemap_update', $sitemap);
437
  }
438 439

  return $sitemap;
440 441 442
}

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

Darren Oh's avatar
Darren Oh committed
452
/**
453
 * Delete multiple XML sitemaps.
454
 *
455 456
 * @param $smids
 *   An array of XML sitemap IDs.
Darren Oh's avatar
Darren Oh committed
457
 */
458 459 460 461 462 463
function xmlsitemap_sitemap_delete_multiple(array $smids) {
  if (!empty($smids)) {
    $sitemaps = xmlsitemap_sitemap_load_multiple($smids);
    db_delete('xmlsitemap_sitemap')
        ->condition('smid', $smids)
        ->execute();
464

465 466 467 468
    foreach ($sitemaps as $sitemap) {
      xmlsitemap_clear_directory($sitemap, TRUE);
      module_invoke_all('xmlsitemap_sitemap_delete', $sitemap);
    }
469
  }
470
}
471

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

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

499 500
function xmlsitemap_sitemap_get_context_hash(array &$context) {
  asort($context);
501
  return Crypt::hashBase64(serialize($context));
502 503
}

Darren Oh's avatar
Darren Oh committed
504
/**
505
 * Returns the uri elements of an XML sitemap.
506
 *
507 508
 * @param $sitemap
 *   An unserialized data array for an XML sitemap.
509
 * @return
510 511
 *   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
512
 */
513
function xmlsitemap_sitemap_uri(stdClass $sitemap) {
514
  $uri['path'] = 'sitemap.xml';
515 516
  $uri['options'] = module_invoke_all('xmlsitemap_context_url_options', $sitemap->context);
  drupal_alter('xmlsitemap_context_url_options', $uri['options'], $sitemap->context);
517 518
  $uri['options'] += array(
    'absolute' => TRUE,
519
    'base_url' => $GLOBALS['base_url'],
520 521 522
  );
  return $uri;
}
523

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

552 553 554
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
  }
555

556
  $links = $query->execute()->fetchAll(PDO::FETCH_ASSOC);
557

558 559 560
  return $links;
}

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

  // 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
587
  }
588 589 590 591 592
  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;
  }

593
  $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();
594 595

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

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

  return $link;
Darren Oh's avatar
Darren Oh committed
611 612 613
}

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

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

640
  return $query->execute();
Darren Oh's avatar
Darren Oh committed
641 642
}

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

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

686 687
  // @todo Add a hook_xmlsitemap_link_delete() hook invoked here.

688 689 690 691
  $query = db_delete('xmlsitemap');
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
  }
692

693
  return $query->execute();
694 695
}

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

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

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

724
  return $changed;
Darren Oh's avatar
Darren Oh committed
725 726 727
}

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

745 746 747 748
  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
749

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

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

771
  return $changed;
Darren Oh's avatar
Darren Oh committed
772 773 774
}

/**
775
 * @} End of "defgroup xmlsitemap_api"
776
 */
Darren Oh's avatar
Darren Oh committed
777

778
function xmlsitemap_get_directory(stdClass $sitemap = NULL) {
779
  $directory = &drupal_static(__FUNCTION__);
780

781
  if (!isset($directory)) {
782
    $directory = \Drupal::config('xmlsitemap.settings')->get('path');
Darren Oh's avatar
Darren Oh committed
783
  }
784

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

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

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

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

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

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

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

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

917
  if (!isset($link_info)) {
918 919 920
    $cid = 'xmlsitemap:link_info:' . $language->language;
    if ($cache = cache_get($cid)) {
      $link_info = $cache->data;
921
    }
922 923 924 925 926 927 928 929 930 931 932 933 934 935
    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]);
          }
        }
936
      }
937 938 939 940 941 942
      $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(),
943 944
          'xmlsitemap' => array(),
        );
945 946 947 948 949 950 951 952 953
        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);
        }
954
      }
955 956 957 958
      drupal_alter('xmlsitemap_link_info', $link_info);
      ksort($link_info);
      // Cache by language since this info contains translated strings.
      cache_set($cid, $link_info);
959
    }
Darren Oh's avatar
Darren Oh committed
960
  }