xmlsitemap.module 34.8 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 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78
/**
 * Implements hook_hook_info().
 */
function xmlsitemap_hook_info() {
  $hooks['xmlsitemap_link_info'] = array(
    'group' => 'xmlsitemap',
  );
  $hooks['xmlsitemap_link_info_alter'] = array(
    'group' => 'xmlsitemap',
  );
  $hooks['xmlsitemap_link_alter'] = array(
    'group' => 'xmlsitemap',
  );
  $hooks['xmlsitemap_index_links'] = array(
    'group' => 'xmlsitemap',
  );
  $hooks['xmlsitemap_context_info'] = array(
    'group' => 'xmlsitemap',
  );
  $hooks['xmlsitemap_context'] = array(
    'group' => 'xmlsitemap',
  );
  $hooks['xmlsitemap_context_fallback'] = array(
    'group' => 'xmlsitemap',
  );
  $hooks['xmlsitemap_context_url_options'] = array(
    'group' => 'xmlsitemap',
  );
  $hooks['xmlsitemap_sitemap_operations'] = array(
    'group' => 'xmlsitemap',
  );
  return $hooks;
}

79 80
/**
 * Implements hook_help().
Darren Oh's avatar
Darren Oh committed
81
 */
82
function xmlsitemap_help($path, $arg) {
83 84
  $output = '';

85
  switch ($path) {
86
    case 'admin/help/xmlsitemap':
87
    case 'admin/config/search/xmlsitemap/settings/%/%/%':
88
      return;
89 90
    case 'admin/help#xmlsitemap':
      break;
91
    case 'admin/config/search/xmlsitemap':
92
      break;
93
    case 'admin/config/search/xmlsitemap/rebuild':
94 95 96
      $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>';
  }

97 98 99 100
  if (arg(0) == 'admin' && strpos($path, 'xmlsitemap') !== FALSE) {
    if ($arg[1] == 'config' && user_access('administer xmlsitemap')) {
      module_load_install('xmlsitemap');
      xmlsitemap_check_status();
101 102 103
    }
    module_load_include('inc', 'xmlsitemap');
    if ($blurb = _xmlsitemap_get_blurb()) {
104
      $output .= $blurb;
105
    }
Darren Oh's avatar
Darren Oh committed
106
  }
107 108 109 110 111 112 113

  return $output;
}

/**
 * Implements hook_perm().
 */
Dave Reid's avatar
Dave Reid committed
114 115 116 117 118 119
function xmlsitemap_permission() {
  return array(
    'administer xmlsitemap' => array(
      'title' => t('Administer XML sitemap settings.'),
    ),
  );
Darren Oh's avatar
Darren Oh committed
120 121
}

122 123 124 125
function xmlsitemap_sitemap_load_multiple(array $smids) {
  $sitemaps = db_query("SELECT * FROM {xmlsitemap_sitemap} WHERE smid IN (:smids)", array(':smids' => $smids))->fetchAllAssoc('smid', PDO::FETCH_ASSOC);
  foreach ($sitemaps as $smid => $sitemap) {
    $sitemaps[$smid]['context'] = unserialize($sitemap['context']);
126
  }
127 128 129 130 131 132
  return $sitemaps;
}

function xmlsitemap_sitemap_load($smid) {
  $sitemap = xmlsitemap_sitemap_load_multiple(array($smid));
  return $sitemap ? reset($sitemap) : FALSE;
133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153
}

function xmlsitemap_sitemap_load_by_context(array $context = NULL) {
  if (!isset($context)) {
    $context = xmlsitemap_get_current_context();
  }
  $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);
}

function xmlsitemap_sitemap_uri(array $sitemap) {
  // @todo Why aren't all modules invoked sometimes? Why is this include needed?
  module_load_all_includes('xmlsitemap.inc');
  $uri = array();
  $uri['path'] = 'sitemap.xml';
  $uri['options'] = module_invoke_all('xmlsitemap_context_url_options', $sitemap['context']);
  $uri['options'] += array(
    'absolute' => TRUE,
    'base_url' => xmlsitemap_var('base_url'),
  );
154
  $uri['url'] = url($uri['path'], $uri['options']);
155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173
  return $uri;
}

function xmlsitemap_sitemap_save(array $sitemap) {
  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);
  }
}

function xmlsitemap_sitemap_delete($smid) {
  db_delete('xmlsitemap_sitemap')
    ->condition('smid', $smid)
    ->execute();
174
  // @todo Delete context files.
175 176
}

Darren Oh's avatar
Darren Oh committed
177
/**
178
 * Implements hook_menu().
Darren Oh's avatar
Darren Oh committed
179
 */
180
function xmlsitemap_menu() {
181
  $items['admin/config/search/xmlsitemap'] = array(
182
    'title' => 'XML sitemap',
183
    'description' => 'Configure the XML sitemaps.',
184
    'page callback' => 'drupal_get_form',
185
    'page arguments' => array('xmlsitemap_sitemap_list_form'),
186 187
    'access arguments' => array('administer xmlsitemap'),
    'file' => 'xmlsitemap.admin.inc',
188
  );
189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215
  $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',
  );
  $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',
  );
  $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',
  );
216
  $items['admin/config/search/xmlsitemap/settings'] = array(
217
    'title' => 'Settings',
218 219
    'page callback' => 'drupal_get_form',
    'page arguments' => array('xmlsitemap_settings_form'),
220
    'access arguments' => array('administer xmlsitemap'),
221
    'type' => MENU_LOCAL_TASK,
222
    'file' => 'xmlsitemap.admin.inc',
223
    'weight' => 10,
224
  );
225
  $items['admin/config/search/xmlsitemap/rebuild'] = array(
226
    'title' => 'Rebuild links',
227
    'description' => 'Rebuild the site map.',
228
    'page callback' => 'drupal_get_form',
229 230
    'page arguments' => array('xmlsitemap_rebuild_form'),
    'access arguments' => array('administer xmlsitemap'),
231
    'type' => MENU_LOCAL_TASK,
232
    'file' => 'xmlsitemap.admin.inc',
233
    'weight' => 20,
234 235 236
  );

  $items['sitemap.xml'] = array(
237 238 239 240 241 242 243 244
    '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,
245
    'type' => MENU_CALLBACK,
246
    'file' => 'xmlsitemap.pages.inc',
247 248
  );

249 250 251 252 253 254 255 256 257 258 259
  // CTools/Dialog API callback for editing bundle settings.
  if (module_exists('dialog')) {
    $items['admin/config/search/xmlsitemap/settings/%/%/%dialog_js'] = array(
      'page callback' => 'xmlsitemap_bundle_settings_dialog',
      'page arguments' => array(5, 6, 7),
      'access arguments' => array('administer xmlsitemap'),
      'type' => MENU_CALLBACK,
      'file' => 'xmlsitemap.admin.inc',
    );
  }

Darren Oh's avatar
Darren Oh committed
260 261 262 263
  return $items;
}

/**
264
 * Implements hook_cron().
Darren Oh's avatar
Darren Oh committed
265
 */
266
function xmlsitemap_cron() {
267 268
  // If there were no new or changed links, skip.
  if (!variable_get('xmlsitemap_regenerate_needed', FALSE)) {
269 270 271
    return;
  }

272 273 274 275 276 277 278
  // 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.
279 280
  module_load_include('generate.inc', 'xmlsitemap');
  xmlsitemap_run_progressive_batch('xmlsitemap_regenerate_batch');
Darren Oh's avatar
Darren Oh committed
281 282 283
}

/**
284
 * Implements hook_robotstxt().
Darren Oh's avatar
Darren Oh committed
285
 */
286
function xmlsitemap_robotstxt() {
287 288 289 290
  // @todo Simplify this down to one function somehow?
  $context = xmlsitemap_get_current_context();
  if ($sitemap = xmlsitemap_sitemap_load_by_context($context)) {
    $uri = xmlsitemap_sitemap_uri($sitemap);
291
    $robotstxt[] = 'Sitemap: ' . $uri['url'];
292
    return $robotstxt;
293
  }
Darren Oh's avatar
Darren Oh committed
294 295
}

296
/**
297 298 299 300 301 302 303
 * 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.
304
 */
305 306 307 308 309 310 311 312 313 314 315 316
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';
317 318
}

Darren Oh's avatar
Darren Oh committed
319
/**
320
 * Get the current number of sitemap chunks.
Darren Oh's avatar
Darren Oh committed
321
 */
322 323 324 325 326 327 328
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;
Darren Oh's avatar
Darren Oh committed
329 330 331
}

/**
332
 * Get the current number of sitemap links.
Darren Oh's avatar
Darren Oh committed
333
 */
334 335 336
function xmlsitemap_get_link_count($reset = FALSE) {
  static $count;
  if (!isset($count) || $reset) {
337
    $count = db_query("SELECT COUNT(id) FROM {xmlsitemap} WHERE access = 1 AND status = 1")->fetchField();
Darren Oh's avatar
Darren Oh committed
338
  }
339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360
  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);
Darren Oh's avatar
Darren Oh committed
361 362
    }
  }
363
  return $size;
Darren Oh's avatar
Darren Oh committed
364 365 366
}

/**
367 368 369 370
 * Recalculate the changefreq of a sitemap link.
 *
 * @param $link
 *   A sitemap link array.
Darren Oh's avatar
Darren Oh committed
371
 */
372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392
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];
Darren Oh's avatar
Darren Oh committed
393
  }
394 395 396 397

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

Darren Oh's avatar
Darren Oh committed
398
/**
399 400 401 402 403 404 405 406 407
 * Check if there is a visible sitemap link given a certain set of conditions.
 *
 * @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.
Darren Oh's avatar
Darren Oh committed
408
 */
409 410 411 412 413
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;

414 415 416 417 418 419 420
  $query = db_select('xmlsitemap');
  $query->addExpression('1');
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
  }
  $query->range(0, 1);
  $changed = $query->execute()->fetchField();
421 422 423 424 425 426

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

  return $changed;
Darren Oh's avatar
Darren Oh committed
427 428 429
}

/**
430 431 432 433 434 435 436 437 438 439 440 441 442
 * Check if there is sitemap link is changed from the existing data.
 *
 * @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
443
 */
444 445 446 447 448
function _xmlsitemap_check_changed_link(array $link, $original_link = NULL, $flag = FALSE) {
  $changed = FALSE;

  if ($original_link === NULL) {
    // Load only the fields necessary for data to be changed in the sitemap.
449
    $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
450
  }
451 452 453 454 455

  if (!$original_link) {
    if ($link['access'] && $link['status']) {
      // Adding a new visible link.
      $changed = TRUE;
Darren Oh's avatar
Darren Oh committed
456
    }
457 458 459 460 461
  }
  else {
    if (!($original_link['access'] && $original_link['status']) && $link['access'] && $link['status']) {
      // Changing a non-visible link to a visible link.
      $changed = TRUE;
Darren Oh's avatar
Darren Oh committed
462
    }
463 464 465
    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
466 467
    }
  }
468 469 470

  if ($changed && $flag) {
    variable_set('xmlsitemap_regenerate_needed', TRUE);
Darren Oh's avatar
Darren Oh committed
471 472
  }

473
  return $changed;
Darren Oh's avatar
Darren Oh committed
474 475
}

476 477 478 479 480 481 482 483 484 485 486 487 488 489 490
/**
 * 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
491
/**
492
 * Load sitemap links from the database.
493 494
 *
 * @param $conditions
495 496
 *   An array of conditions on the {xmlsitemap} table in the form
 *   'field' => $value.
497
 * @return
498
 *   An array of sitemap link arrays.
Darren Oh's avatar
Darren Oh committed
499
 */
500
function xmlsitemap_link_load_multiple(array $conditions = array()) {
501 502
  $query = db_select('xmlsitemap');
  $query->fields('xmlsitemap');
503

504 505 506
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
  }
507

508
  $links = $query->execute()->fetchAll(PDO::FETCH_ASSOC);
509

510 511 512
  return $links;
}

Darren Oh's avatar
Darren Oh committed
513
/**
514 515 516 517
 * Saves or updates a sitemap link.
 *
 * @param $link
 *   An array with a sitemap link.
Darren Oh's avatar
Darren Oh committed
518
 */
519 520 521 522 523 524 525 526 527 528
function xmlsitemap_save_link(array $link) {
  $link += array(
    'access' => 1,
    'status' => 1,
    'status_override' => 0,
    'lastmod' => 0,
    'priority' => 0.5,
    'priority_override' => 0,
    'changefreq' => 0,
    'changecount' => 0,
529
    'language' => LANGUAGE_NONE,
530 531 532 533 534 535 536 537 538
  );

  // 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
539
  }
540 541 542 543 544
  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;
  }

545
  $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();
546 547 548 549 550 551 552

  // 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) {
553
    drupal_write_record('xmlsitemap', $link, array('type', 'id'));
554 555
  }
  else {
556
    drupal_write_record('xmlsitemap', $link);
557 558 559 560 561 562
  }

  // 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
563 564 565
}

/**
566 567 568 569 570 571 572 573 574 575 576
 * 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
577
 */
578 579 580 581 582 583 584 585
function xmlsitemap_update_links($updates = array(), $conditions = array()) {
  // 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.
586 587 588 589 590
  $query = db_update('xmlsitemap');
  $query->fields($updates);
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
  }
591

592
  return $query->execute();
Darren Oh's avatar
Darren Oh committed
593 594
}

595
/**
596
 * Delete a specific sitemap link from the database.
597 598 599 600
 *
 * If a visible sitemap link was deleted, this will automatically set the
 * regenerate needed flag.
 *
601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618
 * @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.
 *
619
 * @param $conditions
620 621
 *   An array of conditions on the {xmlsitemap} table in the form
 *   'field' => $value.
622 623
 * @return
 *   The number of links that were deleted.
624
 */
625
function xmlsitemap_link_delete_multiple(array $conditions) {
626 627
  if (!variable_get('xmlsitemap_regenerate_needed', TRUE)) {
    _xmlsitemap_check_changed_links($conditions, array(), TRUE);
628
  }
629

630 631 632 633 634
  $query = db_delete('xmlsitemap');
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
  }
  return $query->execute();
635 636
}

Darren Oh's avatar
Darren Oh committed
637
/**
638 639 640 641
 * 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().
Darren Oh's avatar
Darren Oh committed
642
 */
643 644 645 646 647 648 649 650 651 652
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;
Darren Oh's avatar
Darren Oh committed
653 654 655 656 657
    }
  }
}

/**
658 659 660 661 662 663 664
 * Internal default variables for xmlsitemap_var().
 */
function xmlsitemap_variables() {
  return array(
    'xmlsitemap_rebuild_needed' => FALSE,
    'xmlsitemap_regenerate_needed' => FALSE,
    'xmlsitemap_minimum_lifetime' => 0,
665 666 667
    'xmlsitemap_generated_last' => 0,
    'xmlsitemap_xsl' => 1,
    'xmlsitemap_prefetch_aliases' => 1,
668 669 670 671
    'xmlsitemap_chunk_size' => 'auto',
    'xmlsitemap_batch_limit' => 100,
    'xmlsitemap_path' => 'xmlsitemap',
    'xmlsitemap_base_url' => $GLOBALS['base_url'],
672
    'xmlsitemap_developer_mode' => 0,
673
    'xmlsitemap_frontpage_priority' => 1.0,
674
    'xmlsitemap_frontpage_changefreq' => XMLSITEMAP_FREQUENCY_DAILY,
675 676
    'xmlsitemap_max_chunks' => 0,
    'xmlsitemap_max_filesize' => 0,
677
    'xmlsitemap_lastmod_format' => XMLSITEMAP_LASTMOD_MEDIUM,
678 679 680 681 682
    // Removed variables are set to NULL so they can still be deleted.
    'xmlsitemap_gz' => FALSE,
    'xmlsitemap_regenerate_last' => NULL,
    'xmlsitemap_custom_links' => NULL,
    'xmlsitemap_priority_default' => NULL,
683
    'xmlsitemap_languages' => NULL,
684 685 686 687 688 689 690
  );
}

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

696
  $name = 'xmlsitemap_' . $name;
697 698 699

  // @todo Remove when stable.
  if (!isset($defaults[$name])) {
700
    trigger_error(strtr('Default variable for %variable not found.', array('%variable' => drupal_placeholder($name))));
Darren Oh's avatar
Darren Oh committed
701
  }
702 703

  return variable_get($name, isset($default) || !isset($defaults[$name]) ? $default : $defaults[$name]);
Darren Oh's avatar
Darren Oh committed
704 705 706
}

/**
707 708 709
 * Set the current user stored in $GLOBALS['user'].
 *
 * @todo Remove when http://drupal.org/node/287292 is fixed.
Darren Oh's avatar
Darren Oh committed
710
 */
711 712
function xmlsitemap_switch_user($new_user = NULL) {
  global $user;
713
  $user_original = &drupal_static(__FUNCTION__);
714 715 716 717 718 719

  if (!isset($new_user)) {
    if (isset($user_original)) {
      // Restore the original user.
      $user = $user_original;
      $user_original = NULL;
720
      drupal_save_session(TRUE);
721 722 723
    }
    else {
      return FALSE;
Darren Oh's avatar
Darren Oh committed
724 725
    }
  }
726 727 728 729 730
  elseif (is_numeric($new_user) && $user->uid != $new_user) {
    // Get the full user object.
    if (!$new_user) {
      $new_user = drupal_anonymous_user();
    }
731
    elseif (!$new_user = user_load($new_user)) {
732 733
      return FALSE;
    }
Darren Oh's avatar
Darren Oh committed
734

735 736 737
    // Backup the original user object.
    if (!isset($user_original)) {
      $user_original = $user;
738
      drupal_save_session(FALSE);
Darren Oh's avatar
Darren Oh committed
739
    }
740 741 742 743 744 745 746

    $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;
747
      drupal_save_session(FALSE);
Darren Oh's avatar
Darren Oh committed
748
    }
749 750

    $user = $new_user;
Darren Oh's avatar
Darren Oh committed
751
  }
752 753 754 755 756
  else {
    return FALSE;
  }

  return $user;
Darren Oh's avatar
Darren Oh committed
757 758 759
}

/**
760 761 762 763 764 765 766
 * Restore the user that was originally loaded.
 *
 * @return
 *  Current user.
 */
function xmlsitemap_restore_user() {
  return xmlsitemap_switch_user();
Darren Oh's avatar
Darren Oh committed
767 768
}

769 770
function xmlsitemap_process_form_link_options($form, &$form_state) {
  $link = &$form_state['values']['xmlsitemap'];
771
  $fields = array('status' => 0, 'priority' => 0.5);
772 773 774 775 776 777 778 779 780

  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;
    }
Darren Oh's avatar
Darren Oh committed
781 782 783 784
  }
}

/**
785
 * @todo Document this function.
786
 * @todo Make these translatable
Darren Oh's avatar
Darren Oh committed
787
 */
788 789 790 791 792 793 794 795 796
function xmlsitemap_get_changefreq_options() {
  return array(
    XMLSITEMAP_FREQUENCY_ALWAYS => 'always',
    XMLSITEMAP_FREQUENCY_HOURLY => 'hourly',
    XMLSITEMAP_FREQUENCY_DAILY => 'daily',
    XMLSITEMAP_FREQUENCY_WEEKLY => 'weekly',
    XMLSITEMAP_FREQUENCY_MONTHLY => 'monthly',
    XMLSITEMAP_FREQUENCY_YEARLY => 'yearly',
  );
Darren Oh's avatar
Darren Oh committed
797 798 799
}

/**
800 801 802 803 804 805 806 807 808 809 810
 * 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
811
 */
812
function xmlsitemap_get_link_info($type = NULL, $reset = FALSE) {
813
  global $language;
814
  $link_info = &drupal_static(__FUNCTION__);
815
  module_load_all_includes('xmlsitemap.inc');
816

817 818
  if ($reset) {
    $link_info = NULL;
819
    entity_info_cache_clear();
820 821 822 823 824
  }
  elseif ($cached = cache_get('xmlsitemap:link_info:' . $language->language)) {
    $link_info = $cached->data;
  }

825
  if (!isset($link_info)) {
826 827
    $link_info = entity_get_info();
    foreach ($link_info as $key => $info) {
828
      if (empty($info['uri callback']) || !isset($info['xmlsitemap'])) {
829 830 831 832 833 834
        // 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.
835
          //unset($link_info[$key]['bundles'][$bundle_key]);
836 837 838
        }
      }
    }
839
    $link_info = array_merge($link_info, module_invoke_all('xmlsitemap_link_info'));
840 841
    foreach ($link_info as $key => &$info) {
      $info += array(
842 843 844
        'type' => $key,
        'base table' => FALSE,
        'bundles' => array(),
845
        'xmlsitemap' => array(),
846
      );
847
      if (!isset($info['xmlsitemap']['rebuild callback']) && !empty($info['base table']) && !empty($info['entity keys']['id']) && !empty($info['xmlsitemap']['process callback'])) {
848 849
        $info['xmlsitemap']['rebuild callback'] = 'xmlsitemap_rebuild_batch_fetch';
      }
850 851 852 853
      foreach ($info['bundles'] as $bundle => &$bundle_info) {
        $bundle_info += array(
          'xmlsitemap' => array(),
        );
854
        $bundle_info['xmlsitemap'] += xmlsitemap_link_bundle_load($key, $bundle);
855
      }
856 857 858 859 860
    }
    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
861
  }
862 863 864 865 866 867

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

  return $link_info;
Darren Oh's avatar
Darren Oh committed
868 869
}

870 871 872 873
function xmlsitemap_get_file_from_context(array $context, $chunk = 'index') {
  return xmlsitemap_get_directory() . '/' . md5(serialize($context)) . "-{$chunk}.xml";
}

874 875 876 877 878 879 880 881 882 883
function xmlsitemap_get_directory() {
  $directory = &drupal_static(__FUNCTION__);

  if (!isset($directory)) {
    $directory = file_directory_path() . '/' . variable_get('xmlsitemap_path', 'xmlsitemap');
  }

  return $directory;
}

884 885 886 887
/**
 * Check that the sitemap files directory exists and is writable.
 */
function xmlsitemap_check_directory() {
888 889
  $directory = xmlsitemap_get_directory();
  $result = file_prepare_directory($directory, FILE_CREATE_DIRECTORY | FILE_MODIFY_PERMISSIONS);
890
  if (!$result) {
891
    watchdog('file system', 'The directory %directory does not exist or is not writable.', array('%directory' => $directory), WATCHDOG_ERROR);
892 893
  }
  return $result;
894
}
895 896 897 898 899 900

function xmlsitemap_clear_directory($delete = FALSE) {
  $directory = xmlsitemap_get_directory();
  return _xmlsitemap_delete_recursive($directory, $delete);
}

901 902 903 904 905 906 907 908 909 910 911 912
/**
 * 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.
 */
913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929
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();
    return $delete_root ? rmdir($path) : TRUE;
  }
  return file_unmanaged_delete($path);
}
930 931 932 933

/**
 * Load a language object by its language code.
 *
934 935
 * @todo Remove when http://drupal.org/node/660736 is fixed in Drupal core.
 *
936 937 938 939 940 941
 * @param $language
 *   A language code. If not provided the default language will be returned.
 * @return
 *   A language object.
 */
function xmlsitemap_language_load($language = LANGUAGE_NONE) {
942
  $languages = &drupal_static(__FUNCTION__);
943 944 945 946 947 948

  if (!isset($languages)) {
    $languages = language_list();
    $languages[LANGUAGE_NONE] = NULL;
  }

949
  return isset($languages[$language]) ? $languages[$language] : NULL;
950
}
951

952 953 954 955
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) {
956
    $settings = xmlsitemap_link_bundle_load($entity_type, $bundle);
957 958
    if (!empty($settings['status'])) {
    //if (!empty($bundle_info['xmlsitemap']['status'])) {
959 960 961 962 963 964
      $bundles[] = $bundle;
    }
  }
  return $bundles;
}

965 966 967 968 969 970 971
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);
972
  $visible = clone $indexed;
973 974 975
  $visible->condition('status', 1);
  $visible->condition('access', 1);

976 977
  $status['indexed'] = $indexed->countQuery()->execute()->fetchField();
  $status['visible'] = $visible->countQuery()->execute()->fetchField();
978 979

  $total = db_select($info['base table']);
980 981 982 983
  $total->addField('xmlsitemap', $info['entity keys']['id']);
  $total->condition($info['entity keys']['id'], 0, '>');
  if (!empty($info['entity keys']['bundle'])) {
    $total->condition($info['entity keys']['bundle'], $bundle);
984
  }
985
  $status['total'] = $total->countQuery()->execute()->fetchField();
986 987 988

  return $status;
}
989 990 991

function xmlsitemap_link_bundle_settings_save($entity, $bundle, array $settings, $update_links = TRUE) {
  if ($update_links) {
992
    $old_settings = xmlsitemap_link_bundle_load($entity, $bundle);
993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005
    if ($settings['status'] != $old_settings['status']) {
      xmlsitemap_update_links(array('status' => $settings['status']), array('type' => $entity, 'subtype' => $bundle, 'status_override' => 0));
    }
    if ($settings['priority'] != $old_settings['priority']) {
      xmlsitemap_update_links(array('priority' => $settings['priority']), array('type' => $entity, 'subtype' => $bundle, 'priority_override' => 0));
    }
  }

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

1006 1007
function xmlsitemap_link_bundle_rename($entity, $bundle_old, $bundle_new) {
  if ($bundle_old != $bundle_new) {
1008
    $settings = xmlsitemap_link_bundle_load($entity, $bundle_old);
1009 1010 1011 1012 1013 1014
    variable_del("xmlsitemap_settings_{$entity}_{$bundle_old}");
    xmlsitemap_link_bundle_settings_save($entity, $bundle_new, $settings, FALSE);
    xmlsitemap_update_links(array('subtype' => $bundle_new), array('type' => $entity, 'subtype' => $bundle_old));
  }
}

1015
function xmlsitemap_link_bundle_load($entity, $bundle) {
1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029
  $settings = variable_get("xmlsitemap_settings_{$entity}_{$bundle}", array());
  $settings += array('status' => 0, 'priority' => 0.5);
  return $settings;
}

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);
}

1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042
function xmlsitemap_can_admin_bundle($entity, $bundle) {
  $info = xmlsitemap_get_link_info($entity);

  if (isset($info['bundles'][$bundle]['admin'])) {
    $admin = $info['bundles'][$bundle]['admin'];
    $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']);
1043 1044 1045 1046 1047
    }
  }

  return FALSE;
}
1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061

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;
  }
}
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

function xmlsitemap_get_context_info($context = NULL, $reset = FALSE) {
  global $language;
  $info = &drupal_static(__FUNCTION__);
  module_load_all_includes('xmlsitemap.inc');

  if ($reset) {
    $info = NULL;
  }
  elseif ($cached = cache_get('xmlsitemap:context_info:' . $language->language)) {
    $info = $cached->data;
  }

  if (!isset($info)) {
    $info = module_invoke_all('xmlsitemap_context_info');
    drupal_alter('xmlsitemap_context_info', $info);
    ksort($info);
    // Cache by language since this info contains translated strings.
    cache_set('xmlsitemap:context_info:' . $language->language, $info);
  }

  if (isset($context)) {
    return isset($info[$context]) ? $info[$context] : NULL;
  }

  return $info;
}

/**
 * Get the sitemap context of the current request.
 */
function xmlsitemap_get_current_context() {
  $context = &drupal_static(__FUNCTION__);

  if (!isset($context)) {
    $context = module_invoke_all('xmlsitemap_context');
    drupal_alter('xmlsitemap_context', $context);
    asort($context);
  }

  return $context;
}

function xmlsitemap_get_default_context() {
  $context = &drupal_static(__FUNCTION__);

  if (!isset($context)) {
    $context = module_invoke_all('xmlsitemap_context_fallback');
    drupal_alter('xmlsitemap_context_fallback', $context);
    asort($context);
  }

  return $context;
}

/**
 * Validate the context and use the default context if it fails validation.
 *
 * @todo Merge into xmlsitemap_get_current_context()?
 * @todo Use real default context variable instead of hard-coded default.
 */
function xmlsitemap_context_check(array $context) {
  $default = xmlsitemap_get_default_context();

  if (xmlsitemap_sitemap_load_by_context($context)) {
    return $context;
  }
  elseif (xmlsitemap_sitemap_load_by_context($default)) {
    return $default;
  }
  else {
    trigger_error("Could not find fallback XML sitemap context. Context $hash: " . print_r($context, TRUE) . ". Default context $default_hash: " . print_r($default, TRUE), E_USER_ERROR);
    return array();
  }
}
1137 1138 1139 1140 1141 1142

/**
 * Run a progressive batch operation.
 */
function xmlsitemap_run_progressive_batch() {
  $args = func_get_args();
1143
  $batch_callback = array_shift($args);
1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156

  // Build the batch array.
  $batch = call_user_func_array($batch_callback, $args);
  batch_set($batch);

  // We need to manually set the progressive variable again.
  // @todo Remove when http://drupal.org/node/638712 is fixed.
  $batch =& batch_get();
  $batch['progressive'] = FALSE;

  // Run the batch process.
  batch_process();
}