by Dave Reid: Split generation functions into xmlsitemap.generate.inc.

xmlsitemap.admin.inc

@@ -270,7 +270,7 @@ function xmlsitemap_rebuild_form_submit($form, &$form_state) {
   // Set the rebuild flag incase something fails during the rebuild.
   variable_set('xmlsitemap_rebuild_needed', TRUE);
 
-  module_load_include('inc', 'xmlsitemap');
+  module_load_include('inc', 'xmlsitemap', 'xmlsitemap.generate');
   $batch = xmlsitemap_rebuild_batch($form_state['values']['entities'], $form_state['values']['callbacks'], $form_state['values']['save_custom']);
   batch_set($batch);
   $form_state['redirect'] = 'admin/config/search/xmlsitemap';

xmlsitemap.drush.inc

@@ -34,7 +34,7 @@ function xmlsitemap_drush_command() {
  * Regenerate the sitemap files from existing data.
  */
 function drush_xmlsitemap_regenerate() {
-  module_load_include('inc', 'xmlsitemap');
+  module_load_include('inc', 'xmlsitemap', 'xmlsitemap.generate');
   xmlsitemap_regenerate();
 
   $vars = array(
@@ -48,7 +48,7 @@ function drush_xmlsitemap_regenerate() {
  * Dump and rebuild all the sitemap data, then regenerate the files.
  */
 function drush_xmlsitemap_rebuild() {
-  module_load_include('inc', 'xmlsitemap');
+  module_load_include('inc', 'xmlsitemap', 'xmlsitemap.generate');
   timer_start('xmlsitemap_rebuild');
 
   // Set the rebuild flag incase something fails during the rebuild.

xmlsitemap.generate.inc

+<?php
+// $Id$
+
+/**
+ * @file
+ * Sitemap generation and rebuilding functions for the xmlsitemap module.
+ *
+ * @ingroup xmlsitemap
+ */
+
+/**
+ * Given an internal Drupal path, return the alias for the path.
+ *
+ * This is similar to drupal_get_path_alias(), but designed to fetch all alises
+ * at once so that only one database query is executed instead of several or
+ * possibly thousands during sitemap generation.
+ *
+ * @param $path
+ *   An internal Drupal path.
+ * @param $language
+ *   A language code to look use when looking up the paths.
+ */
+function xmlsitemap_get_path_alias($path, $language) {
+  static $aliases;
+  static $last_language;
+
+  if (!isset($aliases)) {
+    $aliases[LANGUAGE_NONE] = db_query("SELECT source, alias FROM {url_alias} WHERE language = :language ORDER BY pid", array(':language' => LANGUAGE_NONE))->fetchAllKeyed();
+  }
+  if ($language != LANGUAGE_NONE && $last_language != $language) {
+    unset($aliases[$last_language]);
+    $aliases[$language] = db_query("SELECT source, alias FROM {url_alias} WHERE language = :language ORDER BY pid", array(':language' => $language))->fetchAllKeyed();
+    $last_language = $language;
+  }
+
+  if ($language != LANGUAGE_NONE && isset($aliases[$language][$path])) {
+    return $aliases[$language][$path];
+  }
+  elseif (isset($aliases[LANGUAGE_NONE][$path])) {
+    return $aliases[LANGUAGE_NONE][$path];
+  }
+  else {
+    return $path;
+  }
+}
+
+/**
+ * Delete and regenerate the sitemap files.
+ */
+function xmlsitemap_regenerate() {
+  _xmlsitemap_regenerate_before();
+
+  // Generate the sitemap pages.
+  $chunk_count = xmlsitemap_get_chunk_count(TRUE);
+  foreach (xmlsitemap_var('languages') as $langcode) {
+    $language = xmlsitemap_language_load($langcode);
+    // Generate index.
+    if ($chunk_count > 1) {
+      xmlsitemap_generate('index', $language);
+    }
+    for ($i = 1; $i <= $chunk_count; $i++) {
+      xmlsitemap_generate($i, $language);
+    }
+  }
+
+  _xmlsitemap_regenerate_after();
+}
+
+/**
+ * Perform operations before rebuilding the sitemap.
+ */
+function _xmlsitemap_regenerate_before() {
+  // Attempt to increase the available processing time and memory limit.
+  drupal_set_time_limit(240);
+  _xmlsitemap_set_memory_limit();
+
+  // Set a timer so we can track how long this takes.
+  timer_start('xmlsitemap_regenerate');
+
+  // Get the current memory usage so we can track how much memory is used.
+  _xmlsitemap_get_memory_usage(TRUE);
+
+  // Clear all cached sitemap files.
+  xmlsitemap_clear_directory();
+  xmlsitemap_check_directory();
+
+  // Clear the maximum chunk and file size variables.
+  variable_set('xmlsitemap_max_chunks', 0);
+  variable_set('xmlsitemap_max_filesize', 0);
+}
+
+function _xmlsitemap_get_memory_usage($start = FALSE) {
+  static $memory_start;
+  $current = memory_get_peak_usage(TRUE);
+  if (!isset($memory_start) || $start) {
+    $memory_start = $current;
+  }
+  return $current - $memory_start;
+}
+
+function _xmlsitemap_get_optimal_memory_limit() {
+  static $optimal_limit;
+  if (!isset($optimal_limit)) {
+    // Set the base memory amount from the provided core constant.
+    $optimal_limit = parse_size(DRUPAL_MINIMUM_PHP_MEMORY_LIMIT);
+
+    // Add memory based on the chunk size.
+    $optimal_limit += xmlsitemap_get_chunk_size() * 500;
+
+    // Add memory for storing the url aliases.
+    $aliases = db_query("SELECT COUNT(pid) FROM {url_alias}")->fetchField();
+    $optimal_limit += $aliases * 250;
+  }
+  return $optimal_limit;
+}
+
+/**
+ * Calculate the optimal memory level for sitemap generation.
+ */
+function _xmlsitemap_set_memory_limit() {
+  $memory_limit = @ini_get('memory_limit');
+  if ($memory_limit && $memory_limit != -1) {
+    $optimal_limit = _xmlsitemap_get_optimal_memory_limit();
+    if (parse_size($memory_limit) < $optimal_limit) {
+      @ini_set('memory_limit', $optimal_limit);
+    }
+  }
+}
+
+/**
+ * Perform operations after rebuilding the sitemap.
+ */
+function _xmlsitemap_regenerate_after() {
+  // Show a watchdog message that the sitemap was regenerated.
+  watchdog('xmlsitemap',
+    'XML sitemap files regenerated in @timer ms. Peak memory usage: @memory-peak.',
+    array(
+      '@timer' => timer_read('xmlsitemap_regenerate'),
+      '@memory-peak' => format_size(memory_get_peak_usage(TRUE)),
+    ),
+    WATCHDOG_NOTICE,
+    l(t('View sitemap'), 'sitemap.xml')
+  );
+
+  // Unset the regenerate flag.
+  variable_set('xmlsitemap_regenerate_needed', FALSE);
+
+  variable_set('xmlsitemap_generated_last', REQUEST_TIME);
+}
+
+/**
+ * Fetch the data from {xmlsitemap}, generates the sitemap, then caches it.
+ *
+ * @param $chunk
+ *   An integer representing the integer of the sitemap page chunk.
+ * @param $language
+ *   A language object, defaults to the default language.
+ * @return
+ *   TRUE on success; otherwise FALSE
+ *
+ * @todo Revise/simplify or remove the function.
+ */
+function xmlsitemap_generate($chunk, $language = NULL) {
+  if (($chunk == 'index' && xmlsitemap_get_chunk_count() < 2) || ($chunk != 'index' && (!is_numeric($chunk) || $chunk > xmlsitemap_get_chunk_count()))) {
+    // Don't bother translating this string.
+    trigger_error('Improper condition hit in xmlsitemap_generate(). Chunk: ' . $chunk . ', Chunk Count: ' . xmlsitemap_get_chunk_count());
+    return FALSE;
+  }
+
+  if (!isset($language)) {
+    $language = language_default();
+  }
+
+  $context = array();
+  if (module_exists('xmlsitemap_i18n')) {
+    $context['language'] = $language->language;
+  }
+  $file = xmlsitemap_get_file_from_context($context, $chunk);
+
+  if (!$handle = fopen($file, 'wb')) {
+    trigger_error(t('Could not open file @file for writing.', array('@file' => $file)));
+    return FALSE;
+  }
+
+  $status = TRUE;
+  if ($chunk == 'index') {
+    xmlsitemap_generate_index($handle, $status, $language);
+  }
+  else {
+    xmlsitemap_generate_chunk($handle, $status, $chunk, $language);
+  }
+  fclose($handle);
+
+  // Track the maximum filesize.
+  $filesize = filesize($file);
+  if ($filesize > variable_get('xmlsitemap_max_filesize', 0)) {
+    variable_set('xmlsitemap_max_filesize', $filesize);
+  }
+
+  if (!$status) {
+    trigger_error(t('Unknown error occurred while writing to file @file.', array('@file' => $file)));
+  }
+  elseif (xmlsitemap_var('gz')) {
+    $file_gz = $file . '.gz';
+    file_put_contents($file_gz, gzencode(file_get_contents($file), 9));
+  }
+
+  return $status;
+}
+
+//function xmlsitemap_fwrite($handle, &$status, $string) {
+//  $status &= (bool) fwrite($handle, $string);
+//}
+
+/**
+ * Write the proper XML sitemap header.
+ *
+ * @param $type
+ * @param $handle
+ *   A file system pointer resource that is typically created using fopen().
+ * @param $status
+ * @param $language
+ */
+function xmlsitemap_generate_chunk_header($type, $handle, &$status, $language) {
+  $output = '<?xml version="1.0" encoding="UTF-8"?>' . PHP_EOL;
+
+  // Add the stylesheet link.
+  if (xmlsitemap_var('xsl')) {
+    $xsl_url = url('sitemap.xsl', array('language' => $language, 'base_url' => xmlsitemap_var('base_url')));
+    $output .= '<?xml-stylesheet type="text/xsl" href="' . $xsl_url . '"?>' . PHP_EOL;
+  }
+
+  $output .= '<' . $type . ' xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">' . PHP_EOL;
+
+  // This is the full XML header required for schema validation.
+  //$schemas = array('sitemapindex' => 'siteindex.xsd', 'urlset' => 'sitemap.xsd');
+  //$output .= '<' . $type . ' xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"' . PHP_EOL;
+  //$output .= '  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"' . PHP_EOL;
+  //$output .= '  xsi:schemaLocation="http://www.sitemaps.org/schemas/sitemap/0.9' . PHP_EOL;
+  //$output .= '  http://www.sitemaps.org/schemas/sitemap/0.9/' . $schemas[$type] . '">' . PHP_EOL;
+
+  $status &= (bool) fwrite($handle, $output);
+  return $status;
+}
+
+/**
+ * Generate one page (chunk) of the sitemap.
+ *
+ * @param $handle
+ *   A file system pointer resource that is typically created using fopen().
+ * @param $status
+ *   A boolean that will be altered by reference with the success status of
+ *   writing to $handle.
+ * @param $chunk
+ *   An integer representing the integer of the sitemap page chunk.
+ * @param $language
+ *   A language object for the sitemap chunk.
+ */
+function xmlsitemap_generate_chunk($handle, &$status, $chunk, $language) {
+  $last_url = '';
+  $url_options = xmlsitemap_get_url_options(array('alias' => TRUE));
+  $lastmod_format = variable_get('xmlsitemap_lastmod_format', DATE_W3C);
+
+  $query = db_select('xmlsitemap', 'x');
+  $query->fields('x', array('loc', 'lastmod', 'changefreq', 'changecount', 'priority', 'language', 'access', 'status'));
+  $query->condition('access', 1);
+  $query->condition('status', 1);
+  $query->orderBy('language', 'DESC');
+  $query->orderBy('loc');
+  $query->addTag('xmlsitemap');
+  $query->addMetaData('language', $language);
+
+  $offset = max($chunk - 1, 0) * xmlsitemap_get_chunk_size();
+  $limit = xmlsitemap_get_chunk_size();
+  $query->range($offset, $limit);
+  $links = $query->execute();
+
+  // Add the XML header and XSL if desired.
+  xmlsitemap_generate_chunk_header('urlset', $handle, $status, $language);
+
+  while ($link = $links->fetchAssoc()) {
+    $url_options['language'] = ($link['language'] != LANGUAGE_NONE ? xmlsitemap_language_load($link['language']) : $language);
+    // @todo $url_options['langauge'] could be NULL if language was not found.
+    $link['alias'] = xmlsitemap_get_path_alias($link['loc'], $url_options['language']->language);
+    $link_url = url($link['alias'], $url_options);
+
+    // Skip this link if it was a duplicate of the last one.
+    // @todo Figure out a way to do this before generation so we can report
+    // back to the user about this.
+    if ($link_url == $last_url) {
+      continue;
+    }
+    else {
+      $last_url = $link_url;
+    }
+
+    $link_output = '<url><loc>' . $link_url . '</loc>';
+    if ($link['lastmod']) {
+      $link_output .= '<lastmod>' . gmdate($lastmod_format, $link['lastmod']) . '</lastmod>';
+      // If the link has a lastmod value, update the changefreq so that links
+      // with a short changefreq but updated two years ago show decay.
+      // We use abs() here just incase items were created on this same cron run
+      // because lastmod would be greater than REQUEST_TIME.
+      $link['changefreq'] = (abs(REQUEST_TIME - $link['lastmod']) + $link['changefreq']) / 2;
+    }
+    if ($link['changefreq']) {
+      $link_output .= '<changefreq>' . xmlsitemap_get_changefreq($link['changefreq']) . '</changefreq>';
+    }
+    if (isset($link['priority']) && $link['priority'] != 0.5) {
+      // Don't output the priority value for links that have 0.5 priority. This
+      // is the default 'assumed' value if priority is not included as per the
+      // sitemaps.org specification.
+      $link_output .= '<priority>' . number_format($link['priority'], 1) . '</priority>';
+    }
+    $link_output .= '</url>' . PHP_EOL;
+    $status &= (bool) fwrite($handle, $link_output);
+  }
+
+  // Close the XML file.
+  $status &= (bool) fwrite($handle, '</urlset>' . PHP_EOL);
+
+  return $status;
+}
+
+/**
+ * Generate the index sitemap.
+ *
+ * @param $handle
+ *   A file system pointer resource that is typically created using fopen().
+ * @param $status
+ * @param $language
+ *   A language object, defaults to the default language.
+ */
+function xmlsitemap_generate_index($handle, &$status, $language) {
+  $url_options = xmlsitemap_get_url_options(array('language' => $language, 'alias' => TRUE));
+  $chunk_count = xmlsitemap_get_chunk_count(TRUE);
+  $lastmod_format = variable_get('xmlsitemap_lastmod_format', DATE_W3C);
+
+  // Add the XML header and XSL if desired.
+  xmlsitemap_generate_chunk_header('sitemapindex', $handle, $status, $language);
+
+  for ($i = 1; $i <= $chunk_count; $i++) {
+    $output = '<sitemap>';
+    $url_options['query']['page'] = $i;
+    $output .= '<loc>' . url('sitemap.xml', $url_options) . '</loc>';
+    // @todo Use the actual lastmod value of the chunk file.
+    $output .= '<lastmod>' . gmdate($lastmod_format, REQUEST_TIME) . '</lastmod>';
+    $output .= '</sitemap>' . PHP_EOL;
+    $status &= (bool) fwrite($handle, $output);
+  }
+
+  // Close the XML file.
+  $status &= (bool) fwrite($handle, '</sitemapindex>' . PHP_EOL);
+
+  return $status;
+}
+
+/**
+ * Batch information callback.
+ */
+function xmlsitemap_rebuild_batch(array $entities, array $callbacks, $save_custom = FALSE) {
+  $batch = array(
+    'operations' => array(),
+    'finished' => 'xmlsitemap_rebuild_batch_finished',
+    'title' => t('Rebuilding Sitemap'),
+    'file' => drupal_get_path('module', 'xmlsitemap') . '/xmlsitemap.generate.inc',
+  );
+
+  // Purge any links first.
+  $batch['operations'][] = array('xmlsitemap_rebuild_batch_clear', array($entities, (bool) $save_custom));
+
+  // Fetch all the sitemap links and save them to the {xmlsitemap} table.
+  foreach ($entities as $entity) {
+    $batch['operations'][] = array($callbacks[$entity], array($entity));
+  }
+
+  // Generate all the sitemap pages.
+  $batch['operations'][] = array('_xmlsitemap_regenerate_before', array());
+  foreach (xmlsitemap_var('languages') as $language) {
+    $batch['operations'][] = array('xmlsitemap_rebuild_batch_generate', array(xmlsitemap_language_load($language)));
+  }
+  $batch['operations'][] = array('_xmlsitemap_regenerate_after', array());
+
+  return $batch;
+}
+
+/**
+ * Batch callback; clear sitemap links for entites.
+ */
+function xmlsitemap_rebuild_batch_clear(array $entities, $save_custom, &$context) {
+  if (!empty($entities)) {
+    $query = db_delete('xmlsitemap');
+    $query->condition('type', $entities);
+
+    // If we want to save the custom data, make sure to exclude any links
+    // that are not using default inclusion or priority.
+    if ($save_custom) {
+      $query->condition('status_override', 0);
+      $query->condition('priority_override', 0);
+    }
+
+    $query->execute();
+  }
+
+  $context['message'] = t('Purging links.');
+}
+
+/**
+ * Batch callback; fetch and add the sitemap links for a specific entity.
+ */
+function xmlsitemap_rebuild_batch_fetch($entity, &$context) {
+  if (!isset($context['sandbox']['info'])) {
+    $context['sandbox']['info'] = xmlsitemap_get_link_info($entity);
+    $context['sandbox']['progress'] = 0;
+    $context['sandbox']['last_id'] = 0;
+  }
+  $info = $context['sandbox']['info'];
+
+  $query = db_select($info['base table']);
+  $query->addField($info['base table'], $info['object keys']['id']);
+  $query->condition($info['object keys']['id'], $context['sandbox']['last_id'], '>');
+  if (!empty($info['object keys']['bundle'])) {
+    $bundles = xmlsitemap_get_link_type_enabled_bundles($entity);
+    $query->condition($info['object keys']['bundle'], $bundles);
+  }
+  $query->orderBy($info['object keys']['id']);
+  $query->addTag('xmlsitemap_rebuild');
+  $query->addMetaData('entity', $entity);
+  $query->addMetaData('entity_info', $info);
+
+  if (!isset($context['sandbox']['max'])) {
+    $context['sandbox']['max'] = $query->countQuery()->execute()->fetchField();
+  }
+
+  $query->range(0, variable_get('xmlsitemap_batch_limit', 100));
+
+  $ids = $query->execute()->fetchCol();
+  $info['xmlsitemap']['process callback']($ids);
+  $context['sandbox']['last_id'] = end($ids);
+  $context['sandbox']['progress'] += count($ids);
+  $context['message'] = t('Now processing %entity @last_id (@progress of @count).', array('%entity' => $entity, '@last_id' => $context['sandbox']['last_id'], '@progress' => $context['sandbox']['progress'], '@count' => $context['sandbox']['max']));
+
+  if ($context['sandbox']['progress'] != $context['sandbox']['max']) {
+    $context['finished'] = $context['sandbox']['progress'] / $context['sandbox']['max'];
+  }
+}
+
+/**
+ * Batch callback; generate the sitemap chunks for a language.
+ */
+function xmlsitemap_rebuild_batch_generate($language, &$context) {
+  if (!isset($context['sandbox']['progress'])) {
+    $context['sandbox']['progress'] = 1;
+    $context['sandbox']['max'] = xmlsitemap_get_chunk_count(TRUE);
+    if ($context['sandbox']['max'] > 1) {
+      xmlsitemap_generate('index', $language);
+    }
+    // Bump the max number up by one since it gets incremented after generation.
+    $context['sandbox']['max']++;
+  }
+
+  xmlsitemap_generate($context['sandbox']['progress'], $language);
+  $context['message'] = t('Now generating @language sitemap page @chunk.', array('@language' => $language->name, '@chunk' => $context['sandbox']['progress']));
+  $context['sandbox']['progress']++;
+
+  if ($context['sandbox']['progress'] != $context['sandbox']['max']) {
+    $context['finished'] = $context['sandbox']['progress'] / $context['sandbox']['max'];
+  }
+}
+
+/**
+ * Batch callback; sitemap rebuild finished.
+ */
+function xmlsitemap_rebuild_batch_finished($success, $results, $operations) {
+  if ($success) {
+    // Reset the rebuild flag since it was successful.
+    variable_set('xmlsitemap_rebuild_needed', FALSE);
+    drupal_set_message(t('The sitemap was rebuilt.'));
+  }
+  else {
+    drupal_set_message(t('The sitemap was not successfully rebuilt.'), 'error');
+  }
+}

xmlsitemap.inc

@@ -8,479 +8,6 @@
  * @ingroup xmlsitemap
  */
 
-/**
- * Given an internal Drupal path, return the alias for the path.
- *
- * This is similar to drupal_get_path_alias(), but designed to fetch all alises
- * at once so that only one database query is executed instead of several or
- * possibly thousands during sitemap generation.
- *
- * @param $path
- *   An internal Drupal path.
- * @param $language
- *   A language code to look use when looking up the paths.
- */
-function xmlsitemap_get_path_alias($path, $language) {
-  static $aliases;
-  static $last_language;
-
-  if (!isset($aliases)) {
-    $aliases[LANGUAGE_NONE] = db_query("SELECT source, alias FROM {url_alias} WHERE language = :language ORDER BY pid", array(':language' => LANGUAGE_NONE))->fetchAllKeyed();
-  }
-  if ($language != LANGUAGE_NONE && $last_language != $language) {
-    unset($aliases[$last_language]);
-    $aliases[$language] = db_query("SELECT source, alias FROM {url_alias} WHERE language = :language ORDER BY pid", array(':language' => $language))->fetchAllKeyed();
-    $last_language = $language;
-  }
-
-  if ($language != LANGUAGE_NONE && isset($aliases[$language][$path])) {
-    return $aliases[$language][$path];
-  }
-  elseif (isset($aliases[LANGUAGE_NONE][$path])) {
-    return $aliases[LANGUAGE_NONE][$path];
-  }
-  else {
-    return $path;
-  }
-}
-
-/**
- * Delete and regenerate the sitemap files.
- */
-function xmlsitemap_regenerate() {
-  _xmlsitemap_regenerate_before();
-
-  // Generate the sitemap pages.
-  $chunk_count = xmlsitemap_get_chunk_count(TRUE);
-  foreach (xmlsitemap_var('languages') as $langcode) {
-    $language = xmlsitemap_language_load($langcode);
-    if ($chunk_count > 1) {
-      xmlsitemap_generate('index', $language);
-    }
-    for ($i = 1; $i <= $chunk_count; $i++) {
-      xmlsitemap_generate($i, $language);
-    }
-  }
-
-  _xmlsitemap_regenerate_after();
-}
-
-/**
- * Perform operations before rebuilding the sitemap.
- */
-function _xmlsitemap_regenerate_before() {
-  // Attempt to increase the available processing time and memory limit.
-  drupal_set_time_limit(240);
-  _xmlsitemap_set_memory_limit();
-
-  // Set a timer so we can track how long this takes.
-  timer_start('xmlsitemap_regenerate');
-
-  // Get the current memory usage so we can track how much memory is used.
-  _xmlsitemap_get_memory_usage(TRUE);
-
-  // Clear all cached sitemap files.
-  xmlsitemap_clear_directory();
-  xmlsitemap_check_directory();
-
-  // Clear the maximum chunk and file size variables.
-  variable_set('xmlsitemap_max_chunks', 0);
-  variable_set('xmlsitemap_max_filesize', 0);
-}
-
-function _xmlsitemap_get_memory_usage($start = FALSE) {
-  static $memory_start;
-  $current = memory_get_peak_usage(TRUE);
-  if (!isset($memory_start) || $start) {
-    $memory_start = $current;
-  }
-  return $current - $memory_start;
-}
-
-function _xmlsitemap_get_optimal_memory_limit() {
-  static $optimal_limit;
-  if (!isset($optimal_limit)) {
-    // Set the base memory amount from the provided core constant.
-    $optimal_limit = parse_size(DRUPAL_MINIMUM_PHP_MEMORY_LIMIT);
-
-    // Add memory based on the chunk size.
-    $optimal_limit += xmlsitemap_get_chunk_size() * 500;
-
-    // Add memory for storing the url aliases.
-    $aliases = db_query("SELECT COUNT(pid) FROM {url_alias}")->fetchField();
-    $optimal_limit += $aliases * 250;
-  }
-  return $optimal_limit;
-}
-
-/**