xmlsitemap.module 28.5 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 32 33 34 35 36
 * @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);

/**
 * The maximum number of links in one sitemap index file.
 */
define('XMLSITEMAP_MAX_SITEMAP_CHUNKS', 1000);

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
37
 */
38
function xmlsitemap_help($path, $arg) {
39 40
  $output = '';

41
  switch ($path) {
42 43 44 45
    case 'admin/help#xmlsitemap':
      $sitemaps = xmlsitemap_get_sitemaps(TRUE);
      $output .= format_plural(count($sitemaps), 'Your sitemap is located at: !sitemaps', 'Your sitemaps are located at: !sitemaps', array('!sitemaps' => theme('item_list', $sitemaps)));
      break;
Darren Oh's avatar
Darren Oh committed
46
    case 'admin/settings/xmlsitemap':
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63
      break;
    case 'admin/settings/xmlsitemap/rebuild':
      $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>';
  }

  // Use a static variable because this code may be called more than once.
  static $checked = FALSE;
  if (!$checked && arg(0) == 'admin' && strpos($path, 'xmlsitemap') !== FALSE) {
    $checked = TRUE;
    module_load_install('xmlsitemap');
    if (xmlsitemap_check_status() && user_access('administer site configuration')) {
      drupal_set_message(t('One or more problems were detected with your XML sitemap configuration. Please check the <a href="@status-report">status report</a> for more information.', array('@status-report' => url('admin/reports/status'))), 'error', FALSE);
    }
    module_load_include('inc', 'xmlsitemap');
    if ($blurb = _xmlsitemap_get_blurb()) {
      $output .= '<div class="form-item"><div class="description">' . $blurb . '</div></div>';
    }
Darren Oh's avatar
Darren Oh committed
64
  }
65 66 67 68 69 70 71 72 73

  return $output;
}

/**
 * Implements hook_perm().
 */
function xmlsitemap_perm() {
  return array('administer xmlsitemap');
Darren Oh's avatar
Darren Oh committed
74 75 76
}

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

  $items['sitemap.xml'] = array(
107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126
    'page callback' => 'xmlsitemap_output_chunk',
    'access arguments' => array('access content'),
    'type' => MENU_CALLBACK,
    'file' => 'xmlsitemap.pages.inc',
  );
  $chunks = xmlsitemap_get_chunk_count();
  if ($chunks > 1) {
    for ($i = 1; $i <= $chunks; $i++) {
      $items['sitemap-' . $i . '.xml'] = array(
        'page callback' => 'xmlsitemap_output_chunk',
        'page arguments' => array((string) $i),
        'access arguments' => array('access content'),
        'type' => MENU_CALLBACK,
        'file' => 'xmlsitemap.pages.inc',
      );
    }
  }
  $items['sitemap.xsl'] = array(
    'page callback' => 'xmlsitemap_output_xsl',
    'access callback' => TRUE,
127
    'type' => MENU_CALLBACK,
128
    'file' => 'xmlsitemap.pages.inc',
129
  );
130
<<<<<<< xmlsitemap.module
131 132 133
  $chunk_count = variable_get('xmlsitemap_chunk_count', 0);
  for ($chunk = 0; $chunk < $chunk_count; ++$chunk) {
    $items["sitemap$chunk.xml"] = array(
134 135
      'title' => 'Site map !number',
      'title arguments' => array('!number' => $chunk),
136
      'page callback' => '_xmlsitemap_output',
137
      'page arguments' => array((string)$chunk),
Darren Oh's avatar
Darren Oh committed
138
      'type' => MENU_CALLBACK,
139
      'access arguments' => $access_content
Darren Oh's avatar
Darren Oh committed
140
    );
141
=======
142

Darren Oh's avatar
Darren Oh committed
143 144 145 146
  return $items;
}

/**
147
 * Implements hook_cron().
Darren Oh's avatar
Darren Oh committed
148
 */
149 150 151 152 153 154 155 156 157
function xmlsitemap_cron() {
  if (!xmlsitemap_var('regenerate_needed')
      || (REQUEST_TIME - xmlsitemap_var('generated_last')) < xmlsitemap_var('minimum_lifetime')) {
    return;
>>>>>>> 1.20.2.45.2.122
  }

  module_load_include('inc', 'xmlsitemap');
  xmlsitemap_regenerate();
Darren Oh's avatar
Darren Oh committed
158 159 160
}

/**
161
 * Implements hook_xmlsitemap_links().
Darren Oh's avatar
Darren Oh committed
162
 */
163 164 165 166 167 168 169 170
function xmlsitemap_xmlsitemap_links() {
  // Frontpage link.
  $links[] = array(
    'type' => 'frontpage',
    'id' => 0,
    'loc' => '',
  );
  return $links;
Darren Oh's avatar
Darren Oh committed
171 172 173
}

/**
174
 * Implements hook_xmlsitemap_link_alter().
Darren Oh's avatar
Darren Oh committed
175
 */
176 177 178 179 180 181
function xmlsitemap_xmlsitemap_link_alter(&$link) {
  // Alter the frontpage priority.
  if ($link['type'] == 'frontpage' || $link['loc'] == '' || $link['loc'] == drupal_get_normal_path(variable_get('site_frontpage', 'node'))) {
    $link['priority'] = xmlsitemap_var('frontpage_priority');
    $link['changefreq'] = xmlsitemap_var('frontpage_changefreq');
  }
Darren Oh's avatar
Darren Oh committed
182 183 184
}

/**
185
 * Implements hook_robotstxt().
Darren Oh's avatar
Darren Oh committed
186
 */
187 188 189 190 191 192 193
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
194 195 196
}

/**
197 198 199 200 201 202
 * 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
203
 */
204 205 206 207 208 209 210 211 212 213 214 215 216 217
function xmlsitemap_get_sitemaps($links = FALSE) {
  static $sitemaps = array();

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

    foreach ($sitemap_languages as $language) {
      $url_options['language'] = $languages[$language];
      $sitemap = url('sitemap.xml', $url_options);
      $sitemaps[$language] = $links ? l($sitemap, $sitemap) : $sitemap;
    }
Darren Oh's avatar
Darren Oh committed
218
  }
219 220

  return $sitemaps;
Darren Oh's avatar
Darren Oh committed
221 222 223
}

/**
224 225 226
 * Return a list of commonly used parameters for url() used by XML sitemap.
 *
 * @see url()
Darren Oh's avatar
Darren Oh committed
227
 */
228 229 230 231
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
232 233 234
  );
}

235
/**
236 237 238 239 240 241 242
 * 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.
243
 */
244 245 246 247 248 249 250 251 252 253 254 255
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';
256 257
}

Darren Oh's avatar
Darren Oh committed
258
/**
259
 * Get the current number of sitemap chunks.
Darren Oh's avatar
Darren Oh committed
260
 */
261 262 263 264 265 266 267
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
268 269 270
}

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

/**
306 307 308 309
 * Recalculate the changefreq of a sitemap link.
 *
 * @param $link
 *   A sitemap link array.
Darren Oh's avatar
Darren Oh committed
310
 */
311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331
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
332
  }
333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350

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

/**
 * Given an {xmlsitemap} field, return the correct %-placeholder.
 *
 * @param $field
 *   The {xmlsitemap} schema field name.
 * @return
 *   The placeholder string to embed in a query for that type.
 *
 * @see db_type_placeholder()
 */
function _xmlsitemap_get_placeholder($field) {
  static $schema;
  if (!isset($schema)) {
    $schema = drupal_get_schema('xmlsitemap');
Darren Oh's avatar
Darren Oh committed
351
  }
352
  return db_type_placeholder($schema['fields'][$field]['type']);
Darren Oh's avatar
Darren Oh committed
353 354 355
}

/**
356 357 358 359 360 361 362 363 364
 * 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
365
 */
366 367 368 369 370 371 372 373 374 375 376 377 378 379
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;

  $args = _xmlsitemap_build_conditions($conditions);
  $sql = "SELECT 1 FROM {xmlsitemap} WHERE ". implode(' AND ', $conditions);
  $changed = db_result(db_query_range($sql, $args, 0, 1));

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

  return $changed;
Darren Oh's avatar
Darren Oh committed
380 381 382
}

/**
383 384 385 386 387 388 389 390 391 392 393 394 395
 * 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
396
 */
397 398 399 400 401 402
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.
    $original_link = db_fetch_array(db_query_range("SELECT loc, access, status, lastmod, priority, changefreq, changecount, language FROM {xmlsitemap} WHERE type = '%s' AND id = %d", $link['type'], $link['id'], 0, 1));
Darren Oh's avatar
Darren Oh committed
403
  }
404 405 406 407 408

  if (!$original_link) {
    if ($link['access'] && $link['status']) {
      // Adding a new visible link.
      $changed = TRUE;
Darren Oh's avatar
Darren Oh committed
409
    }
410 411 412 413 414
  }
  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
415
    }
416 417 418
    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
419 420
    }
  }
421 422 423

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

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

/**
430 431 432
 * Condition builder for queries.
 *
 * @todo (Drupal7) Replace with DBTNG
Darren Oh's avatar
Darren Oh committed
433
 */
434 435 436 437
function _xmlsitemap_build_conditions(array &$conditions = array(), array &$args = array(), $operator = '=', $null_operator = 'IS') {
  foreach ($conditions as $field => $value) {
    if (is_int($field)) {
      continue;
Darren Oh's avatar
Darren Oh committed
438
    }
439 440
    elseif ($value === NULL) {
      $conditions[$field] = "$field $null_operator NULL";
Darren Oh's avatar
Darren Oh committed
441
    }
442 443 444 445
    else {
      $placeholder = _xmlsitemap_get_placeholder($field);
      $conditions[$field] = "$field $operator $placeholder";
      $args[] = $value;
Darren Oh's avatar
Darren Oh committed
446 447
    }
  }
448
  return $args;
Darren Oh's avatar
Darren Oh committed
449 450 451
}

/**
452 453 454 455 456 457 458 459
 * Load a specific sitemap link.
 *
 * @param $conditions
 *   An array of values to match keyed by field.
 * @return
 *   An array representing the first sitemap link matching the conditions found.
 *
 * @todo Convert to use $type and $id as parameters.
Darren Oh's avatar
Darren Oh committed
460
 */
461 462 463 464 465 466 467 468
function xmlsitemap_load_link(array $conditions) {
  $args = _xmlsitemap_build_conditions($conditions);
  $link = db_fetch_array(db_query_range("SELECT * FROM {xmlsitemap} WHERE ". implode(' AND ', $conditions), $args, 0, 1));

  // Allow other modules to respond after loading the link.
  //module_invoke_all('xmlsitemap_load_link', $link, $conditions, $args);

  return $link;
Darren Oh's avatar
Darren Oh committed
469 470 471
}

/**
472 473 474 475
 * Saves or updates a sitemap link.
 *
 * @param $link
 *   An array with a sitemap link.
Darren Oh's avatar
Darren Oh committed
476
 */
477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496
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,
    'language' => '',
  );

  // 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
497
  }
498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520
  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;
  }

  $existing = db_fetch_array(db_query_range("SELECT loc, access, status, lastmod, priority, changefreq, changecount, language FROM {xmlsitemap} WHERE type = '%s' AND id = %d", $link['type'], $link['id'], 0, 1));

  // 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) {
    xmlsitemap_write_record('xmlsitemap', $link, array('type', 'id'));
  }
  else {
    xmlsitemap_write_record('xmlsitemap', $link);
  }

  // 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
521 522 523
}

/**
524 525 526 527 528 529 530 531 532 533 534
 * 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
535
 */
536 537 538 539 540 541 542 543 544 545 546 547 548 549 550
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.
  $args = array();
  _xmlsitemap_build_conditions($updates, $args, '=', '=');
  _xmlsitemap_build_conditions($conditions, $args);
  $sql = "UPDATE {xmlsitemap} SET " . implode(', ', $updates) . " WHERE " . implode(' AND ', $conditions);
  db_query($sql, $args);

  return db_affected_rows();
Darren Oh's avatar
Darren Oh committed
551 552
}

553
/**
554 555 556 557 558 559 560 561 562
 * Delete one or more sitemap links.
 *
 * If a visible sitemap link was deleted, this will automatically set the
 * regenerate needed flag.
 *
 * @param $conditions
 *   An array of values to match keyed by field.
 * @return
 *   The number of links that were deleted.
563
 */
564 565 566
function xmlsitemap_delete_link(array $conditions) {
  if (!variable_get('xmlsitemap_regenerate_needed', TRUE)) {
    _xmlsitemap_check_changed_links($conditions, array(), TRUE);
567
  }
568 569 570 571 572 573 574 575

  $args = _xmlsitemap_build_conditions($conditions);
  db_query("DELETE FROM {xmlsitemap} WHERE " . implode(' AND ', $conditions), $args);

  // Allow other modules to respond after deleting the link.
  //module_invoke_all('xmlsitemap_delete_link', $conditions, $args);

  return db_affected_rows();
576 577
}

Darren Oh's avatar
Darren Oh committed
578
/**
579 580 581 582 583 584
 * Delete all cached sitemap XML files.
 *
 * @param $rmdir
 *   A boolean that if TRUE the directory will be removed after emptying.
 * @param $path
 *   An optional directory path, defaults to the xmlsiteamp cache directory.
Darren Oh's avatar
Darren Oh committed
585
 */
586 587 588 589 590 591 592 593
function xmlsitemap_clear_cache($rmdir = FALSE, $path = NULL) {
  if (!isset($path)) {
    $path = file_create_path(xmlsitemap_var('path'));
  }

  file_scan_directory($path, '.*', array('.', '..', 'CVS', '.svn'), 'file_delete', TRUE);
  if ($rmdir) {
    rmdir($path);
Darren Oh's avatar
Darren Oh committed
594 595 596 597
  }
}

/**
598 599 600 601 602 603 604 605 606 607
 * Get the filename of a specific sitemap page chunk.
 *
 * @param $chunk
 *   An integer representing the integer of the sitemap page chunk.
 * @param $language
 *   A language object, defaults to the default language.
 * @return
 *   A file path to the expected chunk file.
 *
 * @todo Move to xmlsitemap.inc
Darren Oh's avatar
Darren Oh committed
608
 */
609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624
function xmlsitemap_get_chunk_file($chunk = 0, $language, $compressed = FALSE) {
  return file_create_path(xmlsitemap_var('path')) .'/xmlsitemap-' . $language->language . '-' . $chunk . ($compressed ? '.gz' : '.xml');
}

/**
 * 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
625 626 627 628
  }
}

/**
629 630 631 632
 * 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
633
 */
634 635 636 637 638 639 640 641 642 643
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
644 645 646 647 648
    }
  }
}

/**
649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675
 * 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,
    // 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,
  );
}

/**
<<<<<<< xmlsitemap.module
Darren Oh's avatar
Darren Oh committed
676 677 678 679 680 681 682 683 684 685 686 687 688 689 690
 * Determine the frequency of updates to a link.
 * @param $interval: The number of seconds since last change
 * @return A string representing the update frequency according to the
 * sitemaps.org protocol
 */
function _xmlsitemap_frequency($interval) {
  $frequencies = array(
    'always' => 3600,
    'hourly' => 86400,
    'daily' => 604800,
    'weekly' => 2419200,
    'monthly' => 29030400,
    'yearly' => 100000000,
    'never' => 0,
  );
691
  $frequency = 'never';
Darren Oh's avatar
Darren Oh committed
692 693
  if (array_key_exists($interval, $frequencies)) {
    $frequency = $interval;
694 695 696 697 698 699 700 701
=======
 * Internal implementation of variable_get().
 */
function xmlsitemap_var($name, $default = NULL) {
  static $defaults = NULL;
  if (!isset($defaults)) {
    $defaults = xmlsitemap_variables();
>>>>>>> 1.20.2.45.2.122
Darren Oh's avatar
Darren Oh committed
702
  }
703
<<<<<<< xmlsitemap.module
704
  elseif (is_numeric($interval)) {
Darren Oh's avatar
Darren Oh committed
705
    foreach ($frequencies as $frequency => $value) {
706
      if ($interval < $value) {
Darren Oh's avatar
Darren Oh committed
707 708 709
        break;
      }
    }
710 711 712 713 714 715 716 717
=======

  $name = 'xmlsitemap_'. $name;

  // @todo Remove when stable.
  if (!isset($defaults[$name])) {
    trigger_error(t('Default variable for %variable not found.', array('%variable' => $name)));
>>>>>>> 1.20.2.45.2.122
Darren Oh's avatar
Darren Oh committed
718
  }
719 720

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

/**
724 725 726
 * 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
727
 */
728 729 730 731 732 733 734 735 736 737 738 739 740
function xmlsitemap_switch_user($new_user = NULL) {
  global $user;
  static $user_original;

  if (!isset($new_user)) {
    if (isset($user_original)) {
      // Restore the original user.
      $user = $user_original;
      $user_original = NULL;
      session_save_session(TRUE);
    }
    else {
      return FALSE;
Darren Oh's avatar
Darren Oh committed
741 742
    }
  }
743 744 745 746 747 748 749 750
  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(array('uid' => $new_user))) {
      return FALSE;
    }
Darren Oh's avatar
Darren Oh committed
751

752 753 754 755
    // Backup the original user object.
    if (!isset($user_original)) {
      $user_original = $user;
      session_save_session(FALSE);
Darren Oh's avatar
Darren Oh committed
756
    }
757 758 759 760 761 762 763 764

    $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;
      session_save_session(FALSE);
Darren Oh's avatar
Darren Oh committed
765
    }
766 767

    $user = $new_user;
Darren Oh's avatar
Darren Oh committed
768
  }
769 770 771 772 773
  else {
    return FALSE;
  }

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

/**
777 778 779 780 781 782 783
 * 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
784 785 786
}

/**
787 788 789
 * Special implementation of drupal_write_record() to allow NULL values.
 *
 * @todo Remove when http://drupal.org/node/227677 is fixed.
Darren Oh's avatar
Darren Oh committed
790
 */
791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808
function xmlsitemap_write_record($table, &$object, $update = array()) {
  // Standardize $update to an array.
  if (is_string($update)) {
    $update = array($update);
  }

  $schema = drupal_get_schema($table);
  if (empty($schema)) {
    return FALSE;
  }

  // Convert to an object if needed.
  if (is_array($object)) {
    $object = (object) $object;
    $array = TRUE;
  }
  else {
    $array = FALSE;
Darren Oh's avatar
Darren Oh committed
809
  }
810 811 812 813 814 815 816 817 818 819 820 821

  $fields = $defs = $values = $serials = $placeholders = array();
  $object_fields = get_object_vars($object);

  // Go through our schema, build SQL, and when inserting, fill in defaults for
  // fields that are not set.
  foreach ($schema['fields'] as $field => $info) {
    // Special case -- skip serial types if we are updating.
    if ($info['type'] == 'serial') {
      if (empty($update)) {
        // Track serial fields so we can helpfully populate them after the query.
        $serials[] = $field;
Darren Oh's avatar
Darren Oh committed
822
      }
823
      continue;
Darren Oh's avatar
Darren Oh committed
824
    }
825 826 827 828

    // For inserts, populate defaults from Schema if not already provided
    if (!isset($object->$field) && !count($update) && isset($info['default']) && !array_key_exists($field, $object_fields)) {
      $object->$field = $info['default'];
Darren Oh's avatar
Darren Oh committed
829
    }
830 831 832 833 834 835 836

    // Build arrays for the fields, placeholders, and values in our query.
    if (isset($object->$field) || (array_key_exists($field, $object_fields) && empty($info['not null']))) {
      $fields[] = $field;
      if (isset($object->$field)) {
        $placeholders[] = db_type_placeholder($info['type']);
        $values[] = empty($info['serialize']) ? $object->$field : serialize($object->$field);
Darren Oh's avatar
Darren Oh committed
837 838
      }
      else {
839 840
        $placeholders[] = '%s';
        $values[] = 'NULL';
Darren Oh's avatar
Darren Oh committed
841 842 843
      }
    }
  }
844 845 846 847 848 849 850

  // Build the SQL.
  $query = '';
  if (!count($update)) {
    $query = "INSERT INTO {". $table ."} (". implode(', ', $fields) .') VALUES ('. implode(', ', $placeholders) .')';
    $return = SAVED_NEW;
  }
Darren Oh's avatar
Darren Oh committed
851
  else {
852 853 854 855 856 857
    $query = '';
    foreach ($fields as $id => $field) {
      if ($query) {
        $query .= ', ';
      }
      $query .= $field .' = '. $placeholders[$id];
Darren Oh's avatar
Darren Oh committed
858
    }
859 860 861 862

    foreach ($update as $key) {
      $conditions[] = "$key = ". db_type_placeholder($schema['fields'][$key]['type']);
      $values[] = $object->$key;
Darren Oh's avatar
Darren Oh committed
863
    }
864 865 866

    $query = "UPDATE {". $table ."} SET $query WHERE ". implode(' AND ', $conditions);
    $return = SAVED_UPDATED;
Darren Oh's avatar
Darren Oh committed
867 868
  }

869 870 871 872 873 874 875 876
  // Execute the SQL.
  if (db_query($query, $values)) {
    if ($serials) {
      // Get last insert ids and fill them in.
      foreach ($serials as $field) {
        $object->$field = db_last_insert_id($table, $field);
      }
    }
Darren Oh's avatar
Darren Oh committed
877
  }
878 879
  else {
    $return = FALSE;
Darren Oh's avatar
Darren Oh committed
880 881
  }

882 883 884
  // If we began with an array, convert back so we don't surprise the caller.
  if ($array) {
    $object = (array) $object;
Darren Oh's avatar
Darren Oh committed
885
  }
886 887

  return $return;
Darren Oh's avatar
Darren Oh committed
888 889
}

890 891 892 893 894 895 896 897 898 899 900 901
function xmlsitemap_process_form_link_options($form, &$form_state) {
  $link = &$form_state['values']['xmlsitemap'];
  $fields = array('status' => 1, 'priority' => 0.5);

  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
902 903 904 905
  }
}

/**
906
 * @todo Document this function.
Darren Oh's avatar
Darren Oh committed
907
 */
908 909 910 911 912 913 914 915 916
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
917 918 919
}

/**
920 921 922 923 924 925 926 927 928 929 930
 * 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
931
 */
932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960
function xmlsitemap_get_link_info($type = NULL, $reset = FALSE) {
  global $language;
  static $link_info;

  if ($reset) {
    $link_info = NULL;
  }

  if (!isset($link_info)) {
    if ($cached = cache_get('xmlsitemap:link_info:' . $language->language)) {
      $link_info = $cached->data;
    }
    else {
      $link_info = array();
      foreach (module_implements('xmlsitemap_link_info') as $module) {
        $module_link_info = module_invoke($module, 'xmlsitemap_link_info');
        foreach ($module_link_info as $type => $info) {
          $module_link_info[$type] += array(
            'type' => $type,
            'module' => $module,
            'purge' => TRUE, //module_hook($module, 'xmlsitemap_link_data'),
            'table' => FALSE,
          );
        }
        $link_info = array_merge($link_info, $module_link_info);
      }
      drupal_alter('xmlsitemap_link_info', $link_info);
      cache_set('xmlsitemap:link_info:' . $language->language, $link_info);
    }
Darren Oh's avatar
Darren Oh committed
961
  }
962 963 964 965 966 967

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

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

/**
971
 * Implements hook_xmlsitemap_link_info().
Darren Oh's avatar
Darren Oh committed
972
 */
973 974 975 976
function xmlsitemap_xmlsitemap_link_info() {
  return array(
    'frontpage' => array(),
  );
Darren Oh's avatar
Darren Oh committed
977
}