xmlsitemap.module 42.2 KB
Newer Older
Darren Oh's avatar
Darren Oh committed
1 2 3 4
<?php
// $Id$

/**
5
 * @defgroup xmlsitemap XML sitemap: create sitemaps.org sitemaps.
Darren Oh's avatar
Darren Oh committed
6 7 8
 */

/**
9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
 * @file
 * Main file for the xmlsitemap module.
 */

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

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

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

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

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

83 84
/**
 * Implements hook_help().
Darren Oh's avatar
Darren Oh committed
85
 */
86
function xmlsitemap_help($path, $arg) {
87 88
  $output = '';

89
  switch ($path) {
90
    case 'admin/help/xmlsitemap':
91
    case 'admin/config/search/xmlsitemap/settings/%/%/%':
Dave Reid's avatar
Dave Reid committed
92 93
    case 'admin/config/search/xmlsitemap/edit/%':
    case 'admin/config/search/xmlsitemap/delete/%':
94
      return;
95 96
    case 'admin/help#xmlsitemap':
      break;
97
    case 'admin/config/search/xmlsitemap':
98
      break;
99
    case 'admin/config/search/xmlsitemap/rebuild':
100 101 102
      $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>';
  }

103
  if (arg(0) == 'admin' && strpos($path, 'xmlsitemap') !== FALSE && user_access('administer xmlsitemap')) {
104
    module_load_include('inc', 'xmlsitemap');
105 106 107
    if ($arg[1] == 'config') {
      // Alert the user to any potential problems detected by hook_requirements.
      xmlsitemap_check_status();
108
    }
109
    $output .= _xmlsitemap_get_blurb();
Darren Oh's avatar
Darren Oh committed
110
  }
111 112 113 114 115 116 117

  return $output;
}

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

/**
126
 * Implements hook_menu().
Darren Oh's avatar
Darren Oh committed
127
 */
128
function xmlsitemap_menu() {
129
  $items['admin/config/search/xmlsitemap'] = array(
130
    'title' => 'XML sitemap',
131
    'description' => 'Configure the XML sitemaps.',
132
    'page callback' => 'drupal_get_form',
133
    'page arguments' => array('xmlsitemap_sitemap_list_form'),
134 135
    'access arguments' => array('administer xmlsitemap'),
    'file' => 'xmlsitemap.admin.inc',
136
  );
137 138 139 140 141 142 143 144 145 146 147 148
  $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',
149
    'modal' => TRUE,
150 151 152 153 154 155 156
  );
  $items['admin/config/search/xmlsitemap/edit/%xmlsitemap_sitemap'] = array(
    'page callback' => 'drupal_get_form',
    'page arguments' => array('xmlsitemap_sitemap_edit_form', 5),
    'access arguments' => array('administer xmlsitemap'),
    'type' => MENU_CALLBACK,
    'file' => 'xmlsitemap.admin.inc',
157
    'modal' => TRUE,
158 159 160 161 162 163 164
  );
  $items['admin/config/search/xmlsitemap/delete/%xmlsitemap_sitemap'] = array(
    'page callback' => 'drupal_get_form',
    'page arguments' => array('xmlsitemap_sitemap_delete_form', 5),
    'access arguments' => array('administer xmlsitemap'),
    'type' => MENU_CALLBACK,
    'file' => 'xmlsitemap.admin.inc',
165
    'modal' => TRUE,
166
  );
167

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

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

  $items['sitemap.xml'] = array(
199 200 201 202 203 204 205 206
    'page callback' => 'xmlsitemap_output_chunk',
    'access arguments' => array('access content'),
    'type' => MENU_CALLBACK,
    'file' => 'xmlsitemap.pages.inc',
  );
  $items['sitemap.xsl'] = array(
    'page callback' => 'xmlsitemap_output_xsl',
    'access callback' => TRUE,
207
    'type' => MENU_CALLBACK,
208
    'file' => 'xmlsitemap.pages.inc',
209 210
  );

Darren Oh's avatar
Darren Oh committed
211 212 213
  return $items;
}

214 215 216 217 218 219 220 221 222
/**
 * 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
223
/**
224
 * Implements hook_cron().
225 226 227
 *
 * @todo Use new Queue system. Need to add {sitemap}.queued.
 * @todo Regenerate one at a time?
Darren Oh's avatar
Darren Oh committed
228
 */
229
function xmlsitemap_cron() {
230 231
  // If there were no new or changed links, skip.
  if (!variable_get('xmlsitemap_regenerate_needed', FALSE)) {
232 233 234
    return;
  }

235 236 237 238 239 240 241
  // If the minimum sitemap lifetime hasn't been passed, skip.
  $lifetime = REQUEST_TIME - variable_get('xmlsitemap_generated_last', 0);
  if ($lifetime < variable_get('xmlsitemap_minimum_lifetime', 0)) {
    return;
  }

  // Regenerate the sitemap XML files.
242 243
  module_load_include('generate.inc', 'xmlsitemap');
  xmlsitemap_run_progressive_batch('xmlsitemap_regenerate_batch');
Darren Oh's avatar
Darren Oh committed
244 245
}

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

270
/**
271
 * Internal default variables for xmlsitemap_var().
272
 */
273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289
function xmlsitemap_variables() {
  return array(
    'xmlsitemap_rebuild_needed' => FALSE,
    'xmlsitemap_regenerate_needed' => FALSE,
    'xmlsitemap_minimum_lifetime' => 0,
    'xmlsitemap_generated_last' => 0,
    'xmlsitemap_xsl' => 1,
    'xmlsitemap_prefetch_aliases' => 1,
    'xmlsitemap_chunk_size' => 'auto',
    'xmlsitemap_batch_limit' => 100,
    'xmlsitemap_path' => 'xmlsitemap',
    'xmlsitemap_base_url' => $GLOBALS['base_url'],
    'xmlsitemap_developer_mode' => 0,
    'xmlsitemap_frontpage_priority' => 1.0,
    'xmlsitemap_frontpage_changefreq' => XMLSITEMAP_FREQUENCY_DAILY,
    'xmlsitemap_lastmod_format' => XMLSITEMAP_LASTMOD_MEDIUM,
    'xmlsitemap_gz' => FALSE,
290
    // Removed variables are set to NULL so they can still be deleted.
291 292 293 294
    'xmlsitemap_regenerate_last' => NULL,
    'xmlsitemap_custom_links' => NULL,
    'xmlsitemap_priority_default' => NULL,
    'xmlsitemap_languages' => NULL,
295 296
    'xmlsitemap_max_chunks' => NULL,
    'xmlsitemap_max_filesize' => NULL,
297 298 299 300 301 302 303 304 305 306
  );
}

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

309 310 311 312 313
  $name = 'xmlsitemap_' . $name;

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

316
  return variable_get($name, isset($default) || !isset($defaults[$name]) ? $default : $defaults[$name]);
317 318
}

Darren Oh's avatar
Darren Oh committed
319
/**
320 321
 * @defgroup xmlsitemap_sitemap_api XML sitemap API for sitemaps.
 * @{
Darren Oh's avatar
Darren Oh committed
322
 */
323 324 325 326 327 328 329 330 331 332

/**
 * Load an XML sitemap array from the database.
 *
 * @param $smid
 *   An XML sitemap ID.
 */
function xmlsitemap_sitemap_load($smid) {
  $sitemap = xmlsitemap_sitemap_load_multiple(array($smid));
  return $sitemap ? reset($sitemap) : FALSE;
Darren Oh's avatar
Darren Oh committed
333 334 335
}

/**
336 337 338
 * Load multiple XML sitemaps from the database.
 *
 * @param $smids
339 340 341
 *   An array of XML sitemap IDs, or FALSE to load all XML sitemaps.
 * @param $conditions
 *   An array of conditions in the form 'field' => $value.
Darren Oh's avatar
Darren Oh committed
342
 */
343 344 345 346 347 348 349 350 351 352 353 354 355 356
function xmlsitemap_sitemap_load_multiple($smids = array(), array $conditions = array()) {
  $query = db_select('xmlsitemap_sitemap');
  $query->fields('xmlsitemap_sitemap');
  if ($smids !== FALSE) {
    $conditions['smid'] = $smids;
  }
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
  }

  $sitemaps = $query->execute()->fetchAllAssoc('smid', PDO::FETCH_ASSOC);
  foreach ($sitemaps as $smid => $sitemap) {
    $sitemaps[$smid]['context'] = unserialize($sitemap['context']);
    $sitemaps[$smid]['uri'] = xmlsitemap_sitemap_uri($sitemaps[$smid]);
Darren Oh's avatar
Darren Oh committed
357
  }
358

359
  return $sitemaps;
360 361 362
}

/**
363
 * Load an XML sitemap array from the database based on its context.
364
 *
365 366
 * @param $context
 *   An optional XML sitemap context array to use to find the correct XML
367
 *   sitemap. If not provided, the current site's context will be used.
368
 *
369
 * @see xmlsitemap_get_current_context()
370
 */
371 372 373
function xmlsitemap_sitemap_load_by_context(array $context = NULL) {
  if (!isset($context)) {
    $context = xmlsitemap_get_current_context();
Darren Oh's avatar
Darren Oh committed
374
  }
375 376 377
  $hash = md5(serialize($context));
  $smid = db_query_range("SELECT smid FROM {xmlsitemap_sitemap} WHERE context_hash = :hash", 0, 1, array(':hash' => $hash))->fetchField();
  return xmlsitemap_sitemap_load($smid);
Darren Oh's avatar
Darren Oh committed
378 379 380
}

/**
381
 * Save changes to an XML sitemap or add a new XML sitemap.
382
 *
383 384 385 386 387
 * @param $sitemap
 *   The XML sitemap array to be saved. If $sitemap['smid'] is omitted, a new
 *   XML sitemap will be added.
 *
 * @todo Save the sitemap's URL as a column?
Darren Oh's avatar
Darren Oh committed
388
 */
389 390 391 392 393 394 395 396 397 398 399
function xmlsitemap_sitemap_save(array $sitemap) {
  // Make sure context is sorted before saving the hash.
  asort($sitemap['context']);
  $sitemap['context_hash'] = md5(serialize($sitemap['context']));

  if (!empty($sitemap['smid'])) {
    drupal_write_record('xmlsitemap_sitemap', $sitemap, array('smid'));
  }
  else {
    drupal_write_record('xmlsitemap_sitemap', $sitemap);
  }
400 401 402
}

/**
403
 * Delete an XML sitemap.
404
 *
405 406
 * @param $smid
 *   An XML sitemap ID.
407
 */
408 409
function xmlsitemap_sitemap_delete($smid) {
  xmlsitemap_sitemap_delete_multiple(array($smid));
410 411
}

Darren Oh's avatar
Darren Oh committed
412
/**
413
 * Delete multiple XML sitemaps.
414
 *
415 416
 * @param $smids
 *   An array of XML sitemap IDs.
Darren Oh's avatar
Darren Oh committed
417
 */
418 419 420 421 422 423
function xmlsitemap_sitemap_delete_multiple(array $smids) {
  if (!empty($smids)) {
    $sitemaps = xmlsitemap_sitemap_load_multiple($smids);
    db_delete('xmlsitemap_sitemap')
        ->condition('smid', $smids)
        ->execute();
424

425 426 427 428
    foreach ($sitemaps as $sitemap) {
      xmlsitemap_clear_directory($sitemap, TRUE);
      module_invoke_all('xmlsitemap_sitemap_delete', $sitemap);
    }
429
  }
430
}
431

432 433 434 435 436 437 438 439 440 441
/**
 * 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.
 */
function xmlsitemap_sitemap_get_file(array $sitemap, $chunk = 'index') {
  return xmlsitemap_get_directory($sitemap) . "/{$chunk}.xml";
Darren Oh's avatar
Darren Oh committed
442 443
}

444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459
/**
 * Find the maximum file size of all a sitemap's XML files.
 *
 * @param $sitemap
 *   The XML sitemap array.
 *
 */
function xmlsitemap_sitemap_get_max_filesize(array &$sitemap) {
  $dir = xmlsitemap_get_directory($sitemap);
  $sitemap['max_filesize'] = 0;
  foreach (file_scan_directory($dir, '/\.xml$/') as $file) {
    $sitemap['max_filesize'] = max($sitemap['max_filesize'], filesize($file->uri));
  }
  return $sitemap['max_filesize'];
}

Darren Oh's avatar
Darren Oh committed
460
/**
461
 * Returns the uri elements of an XML sitemap.
462
 *
463 464
 * @param $sitemap
 *   An unserialized data array for an XML sitemap.
465
 * @return
466 467
 *   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
468
 */
469 470 471 472 473 474 475 476 477 478
function xmlsitemap_sitemap_uri(array $sitemap) {
  $uri['path'] = 'sitemap.xml';
  $uri['options'] = module_invoke_all('xmlsitemap_context_url_options', $sitemap['context']);
  drupal_alter('xmlsitemap_context_url_options', $uri['options'], $sitemap['context']);
  $uri['options'] += array(
    'absolute' => TRUE,
    'base_url' => variable_get('xmlsitemap_base_url', $GLOBALS['base_url']),
  );
  return $uri;
}
479

480 481 482
/**
 * @} End of "defgroup xmlsitemap_sitemap_api"
 */
Darren Oh's avatar
Darren Oh committed
483

484 485 486 487
/**
 * @defgroup xmlsitemap_link_api XML sitemap API for sitemap links.
 * @{
 */
Darren Oh's avatar
Darren Oh committed
488

489 490 491 492 493 494 495 496 497 498 499 500 501 502 503
/**
 * 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
504
/**
505
 * Load sitemap links from the database.
506 507
 *
 * @param $conditions
508 509
 *   An array of conditions on the {xmlsitemap} table in the form
 *   'field' => $value.
510
 * @return
511
 *   An array of sitemap link arrays.
Darren Oh's avatar
Darren Oh committed
512
 */
513
function xmlsitemap_link_load_multiple(array $conditions = array()) {
514 515
  $query = db_select('xmlsitemap');
  $query->fields('xmlsitemap');
516

517 518 519
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
  }
520

521
  $links = $query->execute()->fetchAll(PDO::FETCH_ASSOC);
522

523 524 525
  return $links;
}

Darren Oh's avatar
Darren Oh committed
526
/**
527 528 529 530
 * Saves or updates a sitemap link.
 *
 * @param $link
 *   An array with a sitemap link.
Darren Oh's avatar
Darren Oh committed
531
 */
532
function xmlsitemap_link_save(array $link) {
533 534
  $link += array(
    'access' => 1,
Dave Reid's avatar
Dave Reid committed
535
    'status' => 1,
536 537
    'status_override' => 0,
    'lastmod' => 0,
538
    'priority' => XMLSITEMAP_PRIORITY_DEFAULT,
539 540 541
    'priority_override' => 0,
    'changefreq' => 0,
    'changecount' => 0,
542
    'language' => LANGUAGE_NONE,
543 544 545 546 547 548 549 550 551
  );

  // 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
552
  }
553 554 555 556 557
  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;
  }

558
  $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();
559 560 561 562 563 564 565

  // Check if this is a changed link and set the regenerate flag if necessary.
  if (!variable_get('xmlsitemap_regenerate_needed', FALSE)) {
    _xmlsitemap_check_changed_link($link, $existing, TRUE);
  }

  if ($existing) {
566
    drupal_write_record('xmlsitemap', $link, array('type', 'id'));
567 568
  }
  else {
569
    drupal_write_record('xmlsitemap', $link);
570 571 572 573 574 575
  }

  // Allow other modules to respond after saving the link.
  //module_invoke_all('xmlsitemap_save_link', $link);

  return $link;
Darren Oh's avatar
Darren Oh committed
576 577 578
}

/**
579 580 581 582 583 584 585 586 587 588 589
 * 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
590
 */
591
function xmlsitemap_link_update_multiple($updates = array(), $conditions = array()) {
592 593 594 595 596 597 598
  // If we are going to modify a visible sitemap link, we will need to set
  // the regenerate needed flag.
  if (!variable_get('xmlsitemap_regenerate_needed', FALSE)) {
    _xmlsitemap_check_changed_links($conditions, $updates, TRUE);
  }

  // Process updates.
599 600 601 602 603
  $query = db_update('xmlsitemap');
  $query->fields($updates);
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
  }
604

605
  return $query->execute();
Darren Oh's avatar
Darren Oh committed
606 607
}

608
/**
609
 * Delete a specific sitemap link from the database.
610 611 612 613
 *
 * If a visible sitemap link was deleted, this will automatically set the
 * regenerate needed flag.
 *
614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631
 * @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.
 *
632
 * @param $conditions
633 634
 *   An array of conditions on the {xmlsitemap} table in the form
 *   'field' => $value.
635 636
 * @return
 *   The number of links that were deleted.
637
 */
638
function xmlsitemap_link_delete_multiple(array $conditions) {
639 640 641
  // 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().
642
  // @todo Remove this check when http://drupal.org/node/151452 is fixed.
643 644 645 646
  if (!db_table_exists('xmlsitemap')) {
    return FALSE;
  }

647 648
  if (!variable_get('xmlsitemap_regenerate_needed', TRUE)) {
    _xmlsitemap_check_changed_links($conditions, array(), TRUE);
649
  }
650

651 652 653 654 655
  $query = db_delete('xmlsitemap');
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
  }
  return $query->execute();
656 657
}

Darren Oh's avatar
Darren Oh committed
658
/**
659
 * Check if there is a visible sitemap link given a certain set of conditions.
660
 *
661 662 663 664 665 666 667
 * @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.
668
 */
669 670 671 672
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.
  $conditions['status'] = (!empty($updates['status']) && empty($condition['status'])) ? 0 : 1;
  $conditions['access'] = (!empty($updates['access']) && empty($condition['access'])) ? 0 : 1;
673

674 675 676 677
  $query = db_select('xmlsitemap');
  $query->addExpression('1');
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
678
  }
679 680
  $query->range(0, 1);
  $changed = $query->execute()->fetchField();
681

682 683
  if ($changed && $flag) {
    variable_set('xmlsitemap_regenerate_needed', TRUE);
Darren Oh's avatar
Darren Oh committed
684
  }
685

686
  return $changed;
Darren Oh's avatar
Darren Oh committed
687 688 689
}

/**
690
 * Check if there is sitemap link is changed from the existing data.
691
 *
692 693 694 695 696 697 698 699 700 701 702
 * @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
703
 */
704 705
function _xmlsitemap_check_changed_link(array $link, $original_link = NULL, $flag = FALSE) {
  $changed = FALSE;
706

707 708 709 710
  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
711

712 713 714 715
  if (!$original_link) {
    if ($link['access'] && $link['status']) {
      // Adding a new visible link.
      $changed = TRUE;
Darren Oh's avatar
Darren Oh committed
716
    }
717
  }
718 719 720 721 722 723 724 725
  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
726 727
    }
  }
728 729 730

  if ($changed && $flag) {
    variable_set('xmlsitemap_regenerate_needed', TRUE);
731 732
  }

733
  return $changed;
Darren Oh's avatar
Darren Oh committed
734 735 736
}

/**
737
 * @} End of "defgroup xmlsitemap_link_api"
738
 */
Darren Oh's avatar
Darren Oh committed
739

740 741
function xmlsitemap_get_directory(array $sitemap = NULL) {
  $directory = &drupal_static(__FUNCTION__);
742

743 744
  if (!isset($directory)) {
    $directory = file_directory_path() . '/' . variable_get('xmlsitemap_path', 'xmlsitemap');
Darren Oh's avatar
Darren Oh committed
745
  }
746 747

  return $directory . (!empty($sitemap) ? '/' . $sitemap['context_hash'] : '');
Darren Oh's avatar
Darren Oh committed
748 749 750
}

/**
751
 * Check that the sitemap files directory exists and is writable.
Darren Oh's avatar
Darren Oh committed
752
 */
753 754 755 756 757 758 759 760 761
function xmlsitemap_check_directory(array $sitemap = NULL) {
  $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;
}

762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783
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;
}

784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813
function xmlsitemap_clear_directory(array $sitemap = NULL, $delete = FALSE) {
  $directory = xmlsitemap_get_directory($sitemap);
  return _xmlsitemap_delete_recursive($directory, $delete);
}

/**
 * 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
 *   A filepath relative to file_directory_path.
 * @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;
      file_unmanaged_delete_recursive($entry_path, TRUE);
    }
    $dir->close();
814
    return $delete_root ? drupal_rmdir($path) : TRUE;
815 816
  }
  return file_unmanaged_delete($path);
Darren Oh's avatar
Darren Oh committed
817 818 819
}

/**
820 821 822 823 824 825 826 827 828 829 830
 * 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
831
 */
832
function xmlsitemap_get_link_info($type = NULL, $reset = FALSE) {
833
  global $language;
834
  $link_info = &drupal_static(__FUNCTION__);
835

836 837
  if ($reset) {
    $link_info = NULL;
838
    entity_info_cache_clear();
839 840 841 842 843
  }
  elseif ($cached = cache_get('xmlsitemap:link_info:' . $language->language)) {
    $link_info = $cached->data;
  }

844
  if (!isset($link_info)) {
845 846
    $link_info = entity_get_info();
    foreach ($link_info as $key => $info) {
847
      if (empty($info['uri callback']) || !isset($info['xmlsitemap'])) {
848 849 850 851 852 853
        // 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.
854
          //unset($link_info[$key]['bundles'][$bundle_key]);
855 856 857
        }
      }
    }
858
    $link_info = array_merge($link_info, module_invoke_all('xmlsitemap_link_info'));
859 860
    foreach ($link_info as $key => &$info) {
      $info += array(
861 862 863
        'type' => $key,
        'base table' => FALSE,
        'bundles' => array(),
864
        'xmlsitemap' => array(),
865
      );
866
      if (!isset($info['xmlsitemap']['rebuild callback']) && !empty($info['base table']) && !empty($info['entity keys']['id']) && !empty($info['xmlsitemap']['process callback'])) {
867 868
        $info['xmlsitemap']['rebuild callback'] = 'xmlsitemap_rebuild_batch_fetch';
      }
869 870 871 872
      foreach ($info['bundles'] as $bundle => &$bundle_info) {
        $bundle_info += array(
          'xmlsitemap' => array(),
        );
873
        $bundle_info['xmlsitemap'] += xmlsitemap_link_bundle_load($key, $bundle, FALSE);
874
      }
875 876 877 878 879
    }
    drupal_alter('xmlsitemap_link_info', $link_info);
    ksort($link_info);
    // Cache by language since this info contains translated strings.
    cache_set('xmlsitemap:link_info:' . $language->language, $link_info);
Darren Oh's avatar
Darren Oh committed
880
  }
881 882 883 884 885 886

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

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

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

902 903 904 905 906 907 908
function xmlsitemap_get_link_type_indexed_status($entity_type, $bundle = '') {
  $info = xmlsitemap_get_link_info($entity_type);
  $status = array();

  $indexed = db_select('xmlsitemap');
  $indexed->condition('type', $entity_type);
  $indexed->condition('subtype', $bundle);
909
  $visible = clone $indexed;
910 911 912
  $visible->condition('status', 1);
  $visible->condition('access', 1);

913 914
  $status['indexed'] = $indexed->countQuery()->execute()->fetchField();
  $status['visible'] = $visible->countQuery()->execute()->fetchField();
915

916 917
  $total = db_select($info['base table'], 'base');
  $total->addField('base', $info['entity keys']['id']);
918
  $total->condition($info['entity keys']['id'], 0, '>');
919 920
  $total->addTag('xmlsitemap_link_bundle_access');
  $total->addTag('xmlsitemap_link_indexed_status');
921 922 923
  $total->addMetaData('entity', $entity_type);
  $total->addMetaData('bundle', $bundle);
  $total->addMetaData('entity_info', $info);
924
  $status['total'] = $total->countQuery()->execute()->fetchField();
925 926 927

  return $status;
}
928 929
function xmlsitemap_link_bundle_settings_save($entity, $bundle, array $settings, $update_links = TRUE) {
  if ($update_links) {
930
    $old_settings = xmlsitemap_link_bundle_load($entity, $bundle);
931
    if ($settings['status'] != $old_settings['status']) {
932
      xmlsitemap_link_update_multiple(array('status' => $settings['status']), array('type' => $entity, 'subtype' => $bundle, 'status_override' => 0));
933 934
    }
    if ($settings['priority'] != $old_settings['priority']) {
935
      xmlsitemap_link_update_multiple(array('priority' => $settings['priority']), array('type' => $entity, 'subtype' => $bundle, 'priority_override' => 0));
936 937 938 939 940 941 942 943
    }
  }

  variable_set("xmlsitemap_settings_{$entity}_{$bundle}", $settings);
  cache_clear_all('xmlsitemap:link_info:', 'cache', TRUE);
  //xmlsitemap_get_link_info(NULL, TRUE);
}

944 945
function xmlsitemap_link_bundle_rename($entity, $bundle_old, $bundle_new) {
  if ($bundle_old != $bundle_new) {
946
    $settings = xmlsitemap_link_bundle_load($entity, $bundle_old);
947 948
    variable_del("xmlsitemap_settings_{$entity}_{$bundle_old}");
    xmlsitemap_link_bundle_settings_save($entity, $bundle_new, $settings, FALSE);
949
    xmlsitemap_link_update_multiple(array('subtype' => $bundle_new), array('type' => $entity, 'subtype' => $bundle_old));
950 951 952
  }
}

953 954 955 956 957 958 959
function xmlsitemap_link_bundle_load($entity, $bundle, $load_bundle_info = TRUE) {
  $info = array(
    'entity' => $entity,
    'bundle' => $bundle,
  );
  if ($load_bundle_info) {
    $entity_info = xmlsitemap_get_link_info($entity);
960 961 962
    if (isset($entity_info['bundles'][$bundle])) {
      $info['info'] = $entity_info['bundles'][$bundle];
    }
963 964 965 966 967 968 969
  }
  $info += variable_get("xmlsitemap_settings_{$entity}_{$bundle}", array());
  $info += array(
    'status' => XMLSITEMAP_STATUS_DEFAULT,
    'priority' => XMLSITEMAP_PRIORITY_DEFAULT,
  );
  return $info;
970 971 972 973 974 975 976 977 978 979 980
}

function xmlsitemap_link_bundle_delete($entity, $bundle, $delete_links = TRUE) {
  variable_del("xmlsitemap_settings_{$entity}_{$bundle}");
  if ($delete_links) {
    xmlsitemap_link_delete_multiple(array('type' => $entity, 'subtype' => $bundle));
  }
  cache_clear_all('xmlsitemap:link_info:', 'cache', TRUE);
  //xmlsitemap_get_link_info(NULL, TRUE);
}

981 982 983 984 985 986 987
function xmlsitemap_link_bundle_access($entity, $bundle = NULL) {
  if (is_array($entity) && !isset($bundle)) {
    $bundle = $entity;
  }
  else {
    $bundle = xmlsitemap_link_bundle_load($entity, $bundle);
  }
988

989 990
  if (isset($bundle['info']['admin'])) {
    $admin = $bundle['info']['admin'];
991 992 993 994 995 996 997 998
    $admin += array('access arguments' => array());

    if (!isset($admin['access callback']) && count($admin['access arguments']) == 1) {
      $admin['access callback'] = 'user_access';
    }

    if (!empty($admin['access callback'])) {
      return call_user_func_array($admin['access callback'], $admin['access arguments']);
999 1000 1001 1002 1003
    }
  }

  return FALSE;
}
1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017

function xmlsitemap_get_bundle_path($entity, $bundle) {
  $info = xmlsitemap_get_link_info($entity);

  if (!empty($info['bundles'][$bundle]['admin']['real path'])) {
    return $info['bundles'][$bundle]['admin']['real path'];
  }
  elseif (!empty($info['bundles'][$bundle]['admin']['path'])) {
    return $info['bundles'][$bundle]['admin']['path'];
  }
  else {
    return FALSE;
  }
}
1018

1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218
/**
 * Determine the frequency of updates to a link.
 *
 * @param $interval
 *   An interval value in seconds.
 * @return
 *   A string representing the update frequency according to the sitemaps.org
 *   protocol.
 */
function xmlsitemap_get_changefreq($interval) {
  if ($interval <= 0 || !is_numeric($interval)) {
    return FALSE;
  }

  foreach (xmlsitemap_get_changefreq_options() as $value => $frequency) {
    if ($interval <= $value) {
      return $frequency;
    }
  }

  return 'never';
}

/**
 * Get the current number of sitemap chunks.
 */
function xmlsitemap_get_chunk_count($reset = FALSE) {
  static $chunks;
  if (!isset($chunks) || $reset) {
    $count = max(xmlsitemap_get_link_count($reset), 1);
    $chunks = ceil($count / xmlsitemap_get_chunk_size($reset));
  }
  return $chunks;
}

/**
 * Get the current number of sitemap links.
 */
function xmlsitemap_get_link_count($reset = FALSE) {
  static $count;
  if (!isset($count) || $reset) {
    $count = db_query("SELECT COUNT(id) FROM {xmlsitemap} WHERE access = 1 AND status = 1")->fetchField();
  }
  return $count;
}

/**
 * Get the sitemap chunk size.
 *
 * This function is useful with the chunk size is set to automatic as it will
 * calculate the appropriate value. Use this function instead of @code
 * xmlsitemap_var('chunk_size') @endcode when the actual value is needed.
 *
 * @param $reset
 *   A boolean to reset the saved, static result. Defaults to FALSE.
 * @return
 *   An integer with the number of links in each sitemap page.
 */
function xmlsitemap_get_chunk_size($reset = FALSE) {
  static $size;
  if (!isset($size) || $reset) {
    $size = xmlsitemap_var('chunk_size');
    if ($size === 'auto') {
      $count = max(xmlsitemap_get_link_count($reset), 1); // Prevent divide by zero.
      $size = min(ceil($count / 10000) * 5000, XMLSITEMAP_MAX_SITEMAP_LINKS);
    }
  }
  return $size;
}

/**
 * Recalculate the changefreq of a sitemap link.
 *
 * @param $link
 *   A sitemap link array.
 */
function xmlsitemap_recalculate_changefreq(&$link) {
  $link['changefreq'] = round((($link['changefreq'] * $link['changecount']) + (REQUEST_TIME - $link['lastmod'])) / ($link['changecount'] + 1));
  $link['changecount']++;
  $link['lastmod'] = REQUEST_TIME;
}

/**
 * Calculates the average interval between UNIX timestamps.
 *
 * @param $timestamps
 *   An array of UNIX timestamp integers.
 * @return
 *   An integer of the average interval.
 */
function xmlsitemap_calculate_changefreq($timestamps) {
  sort($timestamps);
  $count = count($timestamps) - 1;
  $diff = 0;

  for ($i = 0; $i < $count; $i++) {
    $diff += $timestamps[$i + 1] - $timestamps[$i];
  }

  return $count > 0 ? round($diff / $count) : 0;
}

/**
 * Submit handler; Set the regenerate needed flag if variables have changed.
 *
 * This function needs to be called before system_settings_form_submit() or any
 * calls to variable_set().
 */
function xmlsitemap_form_submit_flag_regenerate($form, $form_state) {
  foreach ($form_state['values'] as $variable => $value) {
    $stored_value = variable_get($variable, 'not_a_variable');
    if (is_array($value) && !empty($form_state['values']['array_filter'])) {
      $value = array_keys(array_filter($value));
    }
    if ($stored_value != 'not_a_variable' && $stored_value != $value) {
      variable_set('xmlsitemap_regenerate_needed', TRUE);
      drupal_set_message(t('XML sitemap settings have been modified and the files should be regenerated. You can <a href="@run-cron">run cron manually</a> to regenerate the cached files.', array('@run-cron' => url('admin/reports/status/run-cron', array('query' => drupal_get_destination())))), 'warning', FALSE);
      return;
    }
  }
}

/**
 * Set the current user stored in $GLOBALS['user'].
 *
 * @todo Remove when http://drupal.org/node/287292 is fixed.
 */
function xmlsitemap_switch_user($new_user = NULL) {
  global $user;
  $user_original = &drupal_static(__FUNCTION__);

  if (!isset($new_user)) {
    if (isset($user_original)) {
      // Restore the original user.
      $user = $user_original;
      $user_original = NULL;
      drupal_save_session(TRUE);
    }
    else {
      return FALSE;
    }
  }
  elseif (is_numeric($new_user) && $user->uid != $new_user) {
    // Get the full user object.
    if (!$new_user) {
      $new_user = drupal_anonymous_user();
    }
    elseif (!$new_user = user_load($new_user)) {
      return FALSE;
    }

    // Backup the original user object.
    if (!isset($user_original)) {
      $user_original = $user;
      drupal_save_session(FALSE);
    }

    $user = $new_user;
  }
  elseif (is_object($new_user) && $user->uid != $new_user->uid) {
    // Backup the original user object.
    if (!isset($user_original)) {
      $user_original = $user;
      drupal_save_session(FALSE);
    }

    $user = $new_user;
  }
  else {
    return FALSE;
  }

  return $user;
}

/**
 * Restore the user that was originally loaded.
 *
 * @return
 *  Current user.
 */
function xmlsitemap_restore_user() {
  return xmlsitemap_switch_user();
}

function xmlsitemap_process_form_link_options($form, &$form_state) {
  $link = &$form_state['values']['xmlsitemap'];
  $fields = array('status' => XMLSITEMAP_STATUS_DEFAULT, 'priority' => XMLSITEMAP_PRIORITY_DEFAULT);

  foreach ($fields as $field => $default) {
    if ($link[$field] === 'default') {
      $link[$field] = isset($link[$field . '_default']) ? $link[$field . '_default'] : $default;
      $link[$field . '_override'] = 0;
    }
    else {
      $link[$field . '_override'] = 1;
    }
  }
}