xmlsitemap.module 31.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 30 31
 * @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);

/**
 * Implements hook_help().
Darren Oh's avatar
Darren Oh committed
32
 */
33
function xmlsitemap_help($path, $arg) {
34 35
  $output = '';

36
  switch ($path) {
37
    case 'admin/help/xmlsitemap':
38
    case 'admin/config/search/xmlsitemap/settings/%/%/%':
39
      return;
40 41
    case 'admin/help#xmlsitemap':
      $sitemaps = xmlsitemap_get_sitemaps(TRUE);
42
      $output .= '<p>' . format_plural(count($sitemaps), 'Your sitemap is located at !sitemap.', 'Your sitemaps are located at: !sitemaps', array('!sitemaps' => theme('item_list', array('items' => $sitemaps)), '!sitemap' => current($sitemaps))) . '</p>';
43
      break;
44
    case 'admin/config/search/xmlsitemap':
45
      break;
46
    case 'admin/config/search/xmlsitemap/rebuild':
47 48 49
      $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>';
  }

50 51 52 53
  if (arg(0) == 'admin' && strpos($path, 'xmlsitemap') !== FALSE) {
    if ($arg[1] == 'config' && user_access('administer xmlsitemap')) {
      module_load_install('xmlsitemap');
      xmlsitemap_check_status();
54 55 56
    }
    module_load_include('inc', 'xmlsitemap');
    if ($blurb = _xmlsitemap_get_blurb()) {
57
      $output .= $blurb;
58
    }
Darren Oh's avatar
Darren Oh committed
59
  }
60 61 62 63 64 65 66

  return $output;
}

/**
 * Implements hook_perm().
 */
Dave Reid's avatar
Dave Reid committed
67 68 69 70 71 72
function xmlsitemap_permission() {
  return array(
    'administer xmlsitemap' => array(
      'title' => t('Administer XML sitemap settings.'),
    ),
  );
Darren Oh's avatar
Darren Oh committed
73 74 75
}

/**
76
 * Implements hook_menu().
Darren Oh's avatar
Darren Oh committed
77
 */
78
function xmlsitemap_menu() {
79
  $items['admin/config/search/xmlsitemap'] = array(
80 81
    'title' => 'XML sitemap',
    'description' => 'Configure the XML sitemap.',
82
    'page callback' => 'drupal_get_form',
83 84 85
    'page arguments' => array('xmlsitemap_settings_form'),
    'access arguments' => array('administer xmlsitemap'),
    'file' => 'xmlsitemap.admin.inc',
86
  );
87
  $items['admin/config/search/xmlsitemap/settings'] = array(
88 89
    'title' => 'Settings',
    'access arguments' => array('administer xmlsitemap'),
90
    'type' => MENU_DEFAULT_LOCAL_TASK,
91 92
    'file' => 'xmlsitemap.admin.inc',
    'weight' => -10,
93
  );
94
  $items['admin/config/search/xmlsitemap/rebuild'] = array(
95 96
    'title' => 'Rebuild',
    'description' => 'Rebuild the site map.',
97
    'page callback' => 'drupal_get_form',
98 99
    'page arguments' => array('xmlsitemap_rebuild_form'),
    'access arguments' => array('administer xmlsitemap'),
100
    'type' => MENU_LOCAL_TASK,
101 102
    'file' => 'xmlsitemap.admin.inc',
    'weight' => 10,
103 104 105
  );

  $items['sitemap.xml'] = array(
106 107 108 109 110 111 112 113
    '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,
114
    'type' => MENU_CALLBACK,
115
    'file' => 'xmlsitemap.pages.inc',
116 117
  );

118 119 120 121 122 123 124 125 126 127 128
  // 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
129 130 131 132
  return $items;
}

/**
133
 * Implements hook_cron().
Darren Oh's avatar
Darren Oh committed
134
 */
135
function xmlsitemap_cron() {
136 137
  // If there were no new or changed links, skip.
  if (!variable_get('xmlsitemap_regenerate_needed', FALSE)) {
138 139 140
    return;
  }

141 142 143 144 145 146 147
  // 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.
148 149
  module_load_include('inc', 'xmlsitemap');
  xmlsitemap_regenerate();
Darren Oh's avatar
Darren Oh committed
150 151 152
}

/**
153
 * Implements hook_xmlsitemap_links().
Darren Oh's avatar
Darren Oh committed
154
 */
155 156 157 158 159 160 161 162
function xmlsitemap_xmlsitemap_links() {
  // Frontpage link.
  $links[] = array(
    'type' => 'frontpage',
    'id' => 0,
    'loc' => '',
  );
  return $links;
Darren Oh's avatar
Darren Oh committed
163 164 165
}

/**
166
 * Implements hook_xmlsitemap_link_alter().
Darren Oh's avatar
Darren Oh committed
167
 */
168 169
function xmlsitemap_xmlsitemap_link_alter(&$link) {
  // Alter the frontpage priority.
170
  if ($link['type'] == 'frontpage' || $link['loc'] == '' || $link['loc'] == variable_get('site_frontpage', 'node')) {
171 172 173
    $link['priority'] = xmlsitemap_var('frontpage_priority');
    $link['changefreq'] = xmlsitemap_var('frontpage_changefreq');
  }
Darren Oh's avatar
Darren Oh committed
174 175 176
}

/**
177
 * Implements hook_robotstxt().
Darren Oh's avatar
Darren Oh committed
178
 */
179 180 181 182 183 184 185
function xmlsitemap_robotstxt() {
  module_load_include('inc', 'xmlsitemap');
  $sitemaps = xmlsitemap_get_sitemaps();
  foreach ($sitemaps as $index => $sitemap) {
    $sitemaps[$index] = 'Sitemap: ' . $sitemap;
  }
  return $sitemaps;
Darren Oh's avatar
Darren Oh committed
186 187 188
}

/**
189 190 191 192 193 194
 * Get an array of the current site's sitemaps.
 *
 * @param $links
 *   A boolean if TRUE, the array elements will be HTML links.
 * @return
 *   An array of sitemaps.
Darren Oh's avatar
Darren Oh committed
195
 */
196 197 198 199 200 201 202 203 204
function xmlsitemap_get_sitemaps($links = FALSE) {
  static $sitemaps = array();

  if (!$sitemaps) {
    $url_options = xmlsitemap_get_url_options();
    $sitemap_languages = xmlsitemap_var('languages');
    natsort($sitemap_languages);

    foreach ($sitemap_languages as $language) {
205
      $url_options['language'] = xmlsitemap_language_load($language);
206 207 208
      $sitemap = url('sitemap.xml', $url_options);
      $sitemaps[$language] = $links ? l($sitemap, $sitemap) : $sitemap;
    }
Darren Oh's avatar
Darren Oh committed
209
  }
210 211

  return $sitemaps;
Darren Oh's avatar
Darren Oh committed
212 213 214
}

/**
215 216 217
 * Return a list of commonly used parameters for url() used by XML sitemap.
 *
 * @see url()
Darren Oh's avatar
Darren Oh committed
218
 */
219 220 221 222
function xmlsitemap_get_url_options($options = array()) {
  return $options + array(
    'absolute' => TRUE,
    'base_url' => xmlsitemap_var('base_url'),
Darren Oh's avatar
Darren Oh committed
223 224 225
  );
}

226
/**
227 228 229 230 231 232 233
 * 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.
234
 */
235 236 237 238 239 240 241 242 243 244 245 246
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';
247 248
}

Darren Oh's avatar
Darren Oh committed
249
/**
250
 * Get the current number of sitemap chunks.
Darren Oh's avatar
Darren Oh committed
251
 */
252 253 254 255 256 257 258
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
259 260 261
}

/**
262
 * Get the current number of sitemap links.
Darren Oh's avatar
Darren Oh committed
263
 */
264 265 266
function xmlsitemap_get_link_count($reset = FALSE) {
  static $count;
  if (!isset($count) || $reset) {
267
    $count = db_query("SELECT COUNT(id) FROM {xmlsitemap} WHERE access = 1 AND status = 1")->fetchField();
Darren Oh's avatar
Darren Oh committed
268
  }
269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290
  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
291 292
    }
  }
293
  return $size;
Darren Oh's avatar
Darren Oh committed
294 295 296
}

/**
297 298 299 300
 * Recalculate the changefreq of a sitemap link.
 *
 * @param $link
 *   A sitemap link array.
Darren Oh's avatar
Darren Oh committed
301
 */
302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322
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
323
  }
324 325 326 327

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

Darren Oh's avatar
Darren Oh committed
328
/**
329 330 331 332 333 334 335 336 337
 * 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
338
 */
339 340 341 342 343
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;

344 345 346 347 348 349 350
  $query = db_select('xmlsitemap');
  $query->addExpression('1');
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
  }
  $query->range(0, 1);
  $changed = $query->execute()->fetchField();
351 352 353 354 355 356

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

  return $changed;
Darren Oh's avatar
Darren Oh committed
357 358 359
}

/**
360 361 362 363 364 365 366 367 368 369 370 371 372
 * 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
373
 */
374 375 376 377 378
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.
379
    $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
380
  }
381 382 383 384 385

  if (!$original_link) {
    if ($link['access'] && $link['status']) {
      // Adding a new visible link.
      $changed = TRUE;
Darren Oh's avatar
Darren Oh committed
386
    }
387 388 389 390 391
  }
  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
392
    }
393 394 395
    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
396 397
    }
  }
398 399 400

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

403
  return $changed;
Darren Oh's avatar
Darren Oh committed
404 405
}

406 407 408 409 410 411 412 413 414 415 416 417 418 419 420
/**
 * 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
421
/**
422
 * Load sitemap links from the database.
423 424
 *
 * @param $conditions
425 426
 *   An array of conditions on the {xmlsitemap} table in the form
 *   'field' => $value.
427
 * @return
428
 *   An array of sitemap link arrays.
Darren Oh's avatar
Darren Oh committed
429
 */
430
function xmlsitemap_link_load_multiple(array $conditions = array()) {
431 432
  $query = db_select('xmlsitemap');
  $query->fields('xmlsitemap');
433

434 435 436
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
  }
437

438
  $links = $query->execute()->fetchAll(PDO::FETCH_ASSOC);
439

440 441 442
  return $links;
}

Darren Oh's avatar
Darren Oh committed
443
/**
444 445 446 447
 * Saves or updates a sitemap link.
 *
 * @param $link
 *   An array with a sitemap link.
Darren Oh's avatar
Darren Oh committed
448
 */
449 450 451 452 453 454 455 456 457 458
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,
459
    'language' => LANGUAGE_NONE,
460 461 462 463 464 465 466 467 468
  );

  // 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
469
  }
470 471 472 473 474
  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;
  }

475
  $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();
476 477 478 479 480 481 482

  // 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) {
483
    drupal_write_record('xmlsitemap', $link, array('type', 'id'));
484 485
  }
  else {
486
    drupal_write_record('xmlsitemap', $link);
487 488 489 490 491 492
  }

  // 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
493 494 495
}

/**
496 497 498 499 500 501 502 503 504 505 506
 * 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
507
 */
508 509 510 511 512 513 514 515
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.
516 517 518 519 520
  $query = db_update('xmlsitemap');
  $query->fields($updates);
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
  }
521

522
  return $query->execute();
Darren Oh's avatar
Darren Oh committed
523 524
}

525
/**
526
 * Delete a specific sitemap link from the database.
527 528 529 530
 *
 * If a visible sitemap link was deleted, this will automatically set the
 * regenerate needed flag.
 *
531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548
 * @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.
 *
549
 * @param $conditions
550 551
 *   An array of conditions on the {xmlsitemap} table in the form
 *   'field' => $value.
552 553
 * @return
 *   The number of links that were deleted.
554
 */
555
function xmlsitemap_link_delete_multiple(array $conditions) {
556 557
  if (!variable_get('xmlsitemap_regenerate_needed', TRUE)) {
    _xmlsitemap_check_changed_links($conditions, array(), TRUE);
558
  }
559

560 561 562 563 564
  $query = db_delete('xmlsitemap');
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
  }
  return $query->execute();
565 566
}

Darren Oh's avatar
Darren Oh committed
567
/**
568 569 570 571 572
 * Get the filename of a specific sitemap page chunk.
 *
 * @param $chunk
 *   An integer representing the integer of the sitemap page chunk.
 * @param $language
573
 *   A string with a language code.
574 575 576 577
 * @return
 *   A file path to the expected chunk file.
 *
 * @todo Move to xmlsitemap.inc
Darren Oh's avatar
Darren Oh committed
578
 */
579 580
function xmlsitemap_get_chunk_file($chunk = 0, $language = LANGUAGE_NONE, $extension = 'xml') {
  return xmlsitemap_get_directory() . "/xmlsitemap-{$language}-{$chunk}.{$extension}";
581 582 583 584 585 586 587 588 589 590 591 592 593 594
}

/**
 * Implements hook_form_alter().
 *
 * Set the regeneration needed flag if settings are changed.
 */
function xmlsitemap_form_alter(&$form, $form_state, $form_id) {
  $forms = array(
    'locale_languages_overview_form', // Language settings
    'xmlsitemap_settings_form', // XML sitemap settings
  );
  if (in_array($form_id, $forms)) {
    array_unshift($form['#submit'], 'xmlsitemap_form_submit_flag_regenerate');
Darren Oh's avatar
Darren Oh committed
595 596 597 598
  }
}

/**
599 600 601 602
 * 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
603
 */
604 605 606 607 608 609 610 611 612 613
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
614 615 616 617 618
    }
  }
}

/**
619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635
 * Internal default variables for xmlsitemap_var().
 */
function xmlsitemap_variables() {
  return array(
    'xmlsitemap_rebuild_needed' => FALSE,
    'xmlsitemap_regenerate_needed' => FALSE,
    'xmlsitemap_generated_last' => 0,
    'xmlsitemap_minimum_lifetime' => 0,
    'xmlsitemap_xsl' => TRUE,
    'xmlsitemap_languages' => array(language_default('language')),
    'xmlsitemap_chunk_size' => 'auto',
    'xmlsitemap_batch_limit' => 100,
    'xmlsitemap_path' => 'xmlsitemap',
    'xmlsitemap_base_url' => $GLOBALS['base_url'],
    'xmlsitemap_developer_mode' => FALSE,
    'xmlsitemap_frontpage_priority' => '1.0',
    'xmlsitemap_frontpage_changefreq' => XMLSITEMAP_FREQUENCY_DAILY,
636 637
    'xmlsitemap_max_chunks' => 0,
    'xmlsitemap_max_filesize' => 0,
638 639 640 641 642 643 644 645 646 647 648 649
    // 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,
  );
}

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

655
  $name = 'xmlsitemap_' . $name;
656 657 658

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

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

/**
666 667 668
 * 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
669
 */
670 671
function xmlsitemap_switch_user($new_user = NULL) {
  global $user;
672
  $user_original = &drupal_static(__FUNCTION__);
673 674 675 676 677 678

  if (!isset($new_user)) {
    if (isset($user_original)) {
      // Restore the original user.
      $user = $user_original;
      $user_original = NULL;
679
      drupal_save_session(TRUE);
680 681 682
    }
    else {
      return FALSE;
Darren Oh's avatar
Darren Oh committed
683 684
    }
  }
685 686 687 688 689
  elseif (is_numeric($new_user) && $user->uid != $new_user) {
    // Get the full user object.
    if (!$new_user) {
      $new_user = drupal_anonymous_user();
    }
690
    elseif (!$new_user = user_load($new_user)) {
691 692
      return FALSE;
    }
Darren Oh's avatar
Darren Oh committed
693

694 695 696
    // Backup the original user object.
    if (!isset($user_original)) {
      $user_original = $user;
697
      drupal_save_session(FALSE);
Darren Oh's avatar
Darren Oh committed
698
    }
699 700 701 702 703 704 705

    $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;
706
      drupal_save_session(FALSE);
Darren Oh's avatar
Darren Oh committed
707
    }
708 709

    $user = $new_user;
Darren Oh's avatar
Darren Oh committed
710
  }
711 712 713 714 715
  else {
    return FALSE;
  }

  return $user;
Darren Oh's avatar
Darren Oh committed
716 717 718
}

/**
719 720 721 722 723 724 725
 * 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
726 727
}

728 729
function xmlsitemap_process_form_link_options($form, &$form_state) {
  $link = &$form_state['values']['xmlsitemap'];
730
  $fields = array('status' => 0, 'priority' => 0.5);
731 732 733 734 735 736 737 738 739

  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
740 741 742 743
  }
}

/**
744
 * @todo Document this function.
745
 * @todo Make these translatable
Darren Oh's avatar
Darren Oh committed
746
 */
747 748 749 750 751 752 753 754 755
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
756 757 758
}

/**
759 760 761 762 763 764 765 766 767 768 769
 * 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
770
 */
771
function xmlsitemap_get_link_info($type = NULL, $reset = FALSE) {
772
  global $language;
773
  $link_info = &drupal_static(__FUNCTION__);
774

775 776
  if ($reset) {
    $link_info = NULL;
777
    entity_info_cache_clear();
778 779 780 781 782
  }
  elseif ($cached = cache_get('xmlsitemap:link_info:' . $language->language)) {
    $link_info = $cached->data;
  }

783
  if (!isset($link_info)) {
784 785 786 787 788 789 790 791 792
    $link_info = entity_get_info();
    foreach ($link_info as $key => $info) {
      if (empty($info['path 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.
793
          //unset($link_info[$key]['bundles'][$bundle_key]);
794 795 796
        }
      }
    }
797
    $link_info = array_merge($link_info, module_invoke_all('xmlsitemap_link_info'));
798 799
    foreach ($link_info as $key => &$info) {
      $info += array(
800 801 802
        'type' => $key,
        'base table' => FALSE,
        'bundles' => array(),
803
        'xmlsitemap' => array(),
804
      );
805 806 807
      if (!isset($info['xmlsitemap']['rebuild callback']) && !empty($info['base table']) && !empty($info['object keys']['id']) && !empty($info['xmlsitemap']['process callback'])) {
        $info['xmlsitemap']['rebuild callback'] = 'xmlsitemap_rebuild_batch_fetch';
      }
808 809 810 811
      foreach ($info['bundles'] as $bundle => &$bundle_info) {
        $bundle_info += array(
          'xmlsitemap' => array(),
        );
812
        $bundle_info['xmlsitemap'] += xmlsitemap_link_bundle_load($key, $bundle);
813
      }
814 815 816 817 818
    }
    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
819
  }
820 821 822 823 824 825

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

  return $link_info;
Darren Oh's avatar
Darren Oh committed
826 827 828
}

/**
829
 * Implements hook_xmlsitemap_link_info().
Darren Oh's avatar
Darren Oh committed
830
 */
831 832
function xmlsitemap_xmlsitemap_link_info() {
  return array(
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
    'frontpage' => array(
      'label' => t('Frontpage'),
      'xmlsitemap' => array(
        'settings callback' => 'xmlsitemap_link_frontpage_settings',
      ),
    ),
  );
}

/**
 * XML sitemap link type settings callback for frontpage link entity.
 */
function xmlsitemap_link_frontpage_settings(&$form) {
  module_load_include('inc', 'xmlsitemap', 'xmlsitemap.admin');
  if (user_access('administer site configuration')) {
    $form['#description'] = t('The front page path can be changed at <a href="@url-frontpage">@url-frontpage</a>.', array('@url-frontpage' => url('admin/settings/site-information')));
  }
  $form['xmlsitemap_frontpage_priority'] = array(
    '#type' => 'select',
    '#title' => t('Priority'),
    '#options' => xmlsitemap_get_priority_options(),
    '#default_value' => variable_get('xmlsitemap_frontpage_priority', 1.0),
  );
  $form['xmlsitemap_frontpage_changefreq'] = array(
    '#type' => 'select',
    '#title' => t('Change frequency'),
    '#options' => xmlsitemap_get_changefreq_options(),
    '#default_value' => variable_get('xmlsitemap_frontpage_changefreq', XMLSITEMAP_FREQUENCY_DAILY),
861
  );
862
  return $form;
Darren Oh's avatar
Darren Oh committed
863
}
864

865 866 867 868 869 870 871 872 873 874
function xmlsitemap_get_directory() {
  $directory = &drupal_static(__FUNCTION__);

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

  return $directory;
}

875 876 877 878
/**
 * Check that the sitemap files directory exists and is writable.
 */
function xmlsitemap_check_directory() {
879 880
  $directory = xmlsitemap_get_directory();
  $result = file_prepare_directory($directory, FILE_CREATE_DIRECTORY | FILE_MODIFY_PERMISSIONS);
881
  if (!$result) {
882
    watchdog('file system', 'The directory %directory does not exist or is not writable.', array('%directory' => $directory), WATCHDOG_ERROR);
883 884
  }
  return $result;
885
}
886 887 888 889 890 891

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

892 893 894 895 896 897 898 899 900 901 902 903
/**
 * 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.
 */
904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920
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);
}
921 922 923 924

/**
 * Load a language object by its language code.
 *
925 926
 * @todo Remove when http://drupal.org/node/660736 is fixed in Drupal core.
 *
927 928 929 930 931 932
 * @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) {
933
  $languages = &drupal_static(__FUNCTION__);
934 935 936 937 938 939

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

940
  return isset($languages[$language]) ? $languages[$language] : NULL;
941
}
942

943 944 945 946
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) {
947
    $settings = xmlsitemap_link_bundle_load($entity_type, $bundle);
948 949
    if (!empty($settings['status'])) {
    //if (!empty($bundle_info['xmlsitemap']['status'])) {
950 951 952 953 954 955
      $bundles[] = $bundle;
    }
  }
  return $bundles;
}

956 957 958 959 960 961 962
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);
963
  $visible = clone $indexed;
964 965 966
  $visible->condition('status', 1);
  $visible->condition('access', 1);

967 968
  $status['indexed'] = $indexed->countQuery()->execute()->fetchField();
  $status['visible'] = $visible->countQuery()->execute()->fetchField();
969 970

  $total = db_select($info['base table']);
971
  $total->addField('xmlsitemap', $info['object keys']['id']);
972
  $total->condition($info['object keys']['id'], 0, '>');
973
  if (!empty($info['object keys']['bundle'])) {
974 975
    $total->condition($info['object keys']['bundle'], $bundle);
  }
976
  $status['total'] = $total->countQuery()->execute()->fetchField();
977 978 979

  return $status;
}
980 981 982

function xmlsitemap_link_bundle_settings_save($entity, $bundle, array $settings, $update_links = TRUE) {
  if ($update_links) {
983
    $old_settings = xmlsitemap_link_bundle_load($entity, $bundle);
984 985 986 987 988 989 990 991 992 993 994 995 996
    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);
}

997 998
function xmlsitemap_link_bundle_rename($entity, $bundle_old, $bundle_new) {
  if ($bundle_old != $bundle_new) {
999
    $settings = xmlsitemap_link_bundle_load($entity, $bundle_old);
1000 1001 1002 1003 1004 1005
    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));
  }
}

1006
function xmlsitemap_link_bundle_load($entity, $bundle) {
1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020
  $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);
}

1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033
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']);
1034 1035 1036 1037 1038
    }
  }

  return FALSE;
}
1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052

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