xmlsitemap.module 44.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
 * @file
 * Main file for the xmlsitemap module.
 */

/**
 * The maximum number of links in one sitemap chunk file.
 */
define('XMLSITEMAP_MAX_SITEMAP_LINKS', 50000);

/**
 * The maximum filesize of a sitemap chunk file.
 */
define('XMLSITEMAP_MAX_SITEMAP_FILESIZE', 10485760);

define('XMLSITEMAP_FREQUENCY_YEARLY', 31449600); // 60 * 60 * 24 * 7 * 52
define('XMLSITEMAP_FREQUENCY_MONTHLY', 2419200); // 60 * 60 * 24 * 7 * 4
define('XMLSITEMAP_FREQUENCY_WEEKLY', 604800); // 60 * 60 * 24 * 7
define('XMLSITEMAP_FREQUENCY_DAILY', 86400); // 60 * 60 * 24
define('XMLSITEMAP_FREQUENCY_HOURLY', 3600); // 60 * 60
define('XMLSITEMAP_FREQUENCY_ALWAYS', 60);

30 31 32 33 34 35 36 37 38 39 40 41 42 43 44
/**
 * Short lastmod timestamp format.
 */
define('XMLSITEMAP_LASTMOD_SHORT', 'Y-m-d');

/**
 * Medium lastmod timestamp format.
 */
define('XMLSITEMAP_LASTMOD_MEDIUM', 'Y-m-d\TH:i\Z');

/**
 * Long lastmod timestamp format.
 */
define('XMLSITEMAP_LASTMOD_LONG', 'c');

45 46 47 48 49 50 51 52 53 54
/**
 * The default inclusion status for link types in the sitemaps.
 */
define('XMLSITEMAP_STATUS_DEFAULT', 0);

/**
 * The default priority for link types in the sitemaps.
 */
define('XMLSITEMAP_PRIORITY_DEFAULT', 0.5);

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

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

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

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

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

  return $output;
}

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

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

170
  $items['admin/config/search/xmlsitemap/settings'] = array(
171
    'title' => 'Settings',
172 173
    'page callback' => 'drupal_get_form',
    'page arguments' => array('xmlsitemap_settings_form'),
174
    'access arguments' => array('administer xmlsitemap'),
175
    'type' => MENU_LOCAL_TASK,
176
    'file' => 'xmlsitemap.admin.inc',
177
    'weight' => 10,
178
  );
179 180 181 182 183 184 185 186 187 188
  $items['admin/config/search/xmlsitemap/settings/%xmlsitemap_link_bundle/%'] = array(
    'load arguments' => array(6),
    'page callback' => 'drupal_get_form',
    'page arguments' => array('xmlsitemap_link_bundle_settings_form', 5),
    'access callback' => 'xmlsitemap_link_bundle_access',
    'access arguments' => array(5),
    'file' => 'xmlsitemap.admin.inc',
    'modal' => TRUE,
  );

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

  $items['sitemap.xml'] = array(
201 202 203 204 205 206 207 208
    '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,
209
    'type' => MENU_CALLBACK,
210
    'file' => 'xmlsitemap.pages.inc',
211 212
  );

Darren Oh's avatar
Darren Oh committed
213 214 215
  return $items;
}

216 217 218 219 220 221 222 223 224
/**
 * Menu access callback; determines if the user can use the rebuild links page.
 */
function _xmlsitemap_rebuild_form_access() {
  module_load_include('generate.inc', 'xmlsitemap');
  $rebuild_types = xmlsitemap_get_rebuildable_link_types();
  return !empty($rebuild_types) && user_access('administer xmlsitemap');
}

Darren Oh's avatar
Darren Oh committed
225
/**
226
 * Implements hook_cron().
227 228 229
 *
 * @todo Use new Queue system. Need to add {sitemap}.queued.
 * @todo Regenerate one at a time?
Darren Oh's avatar
Darren Oh committed
230
 */
231
function xmlsitemap_cron() {
232 233
  // If there were no new or changed links, skip.
  if (!variable_get('xmlsitemap_regenerate_needed', FALSE)) {
234 235 236
    return;
  }

237 238 239 240 241 242 243
  // 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.
244 245
  module_load_include('generate.inc', 'xmlsitemap');
  xmlsitemap_run_progressive_batch('xmlsitemap_regenerate_batch');
Darren Oh's avatar
Darren Oh committed
246 247
}

248 249 250 251 252 253 254 255 256 257 258 259 260 261
/**
 * Implements hook_modules_enabled().
 */
function xmlsitemap_modules_enabled(array $modules) {
  cache_clear_all('xmlsitemap:', 'cache', TRUE);
}

/**
 * Implements hook_modules_disabled().
 */
function xmlsitemap_modules_disabled(array $modules) {
  cache_clear_all('xmlsitemap:', 'cache', TRUE);
}

Darren Oh's avatar
Darren Oh committed
262
/**
263
 * Implements hook_robotstxt().
Darren Oh's avatar
Darren Oh committed
264
 */
265
function xmlsitemap_robotstxt() {
266
  if ($sitemap = xmlsitemap_sitemap_load_by_context()) {
267
    $robotstxt[] = 'Sitemap: ' . url($sitemap['uri']['path'], $sitemap['uri']['options']);
268
    return $robotstxt;
269
  }
Darren Oh's avatar
Darren Oh committed
270 271
}

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

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

311 312 313 314 315
  $name = 'xmlsitemap_' . $name;

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

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

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

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

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

  $query = db_select('xmlsitemap_sitemap');
  $query->fields('xmlsitemap_sitemap');
352 353 354 355 356 357 358 359
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
  }

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

362
  return $sitemaps;
363 364 365
}

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

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

397 398 399 400 401 402 403 404 405 406 407 408 409 410 411
  // If the context was changed, we need to perform additional actions.
  if (isset($smid_old) && $sitemap['smid'] != $smid_old) {
    // Rename the files directory so the sitemap does not break.
    $old_dir = xmlsitemap_get_directory(array('smid' => $smid_old));
    $new_dir = xmlsitemap_get_directory($sitemap);
    xmlsitemap_directory_move($old_dir, $new_dir);

    // Change the smid field so drupal_write_record() does not fail.
    db_update('xmlsitemap_sitemap')
      ->fields(array('smid' => $sitemap['smid']))
      ->condition('smid', $smid_old)
      ->execute();

    // Mark the sitemaps as needing regeneration.
    variable_set('xmlsitemap_regenerate_needed', TRUE);
412
  }
413 414

  if (empty($sitemap['smid'])) {
415
    drupal_write_record('xmlsitemap_sitemap', $sitemap);
416 417 418 419 420
    module_invoke_all('xmlsitemap_sitemap_insert', $sitemap);
  }
  else {
    drupal_write_record('xmlsitemap_sitemap', $sitemap, array('smid'));
    module_invoke_all('xmlsitemap_sitemap_update', $sitemap);
421
  }
422 423

  return $sitemap;
424 425 426
}

/**
427
 * Delete an XML sitemap.
428
 *
429 430
 * @param $smid
 *   An XML sitemap ID.
431
 */
432 433
function xmlsitemap_sitemap_delete($smid) {
  xmlsitemap_sitemap_delete_multiple(array($smid));
434 435
}

Darren Oh's avatar
Darren Oh committed
436
/**
437
 * Delete multiple XML sitemaps.
438
 *
439 440
 * @param $smids
 *   An array of XML sitemap IDs.
Darren Oh's avatar
Darren Oh committed
441
 */
442 443 444 445 446 447
function xmlsitemap_sitemap_delete_multiple(array $smids) {
  if (!empty($smids)) {
    $sitemaps = xmlsitemap_sitemap_load_multiple($smids);
    db_delete('xmlsitemap_sitemap')
        ->condition('smid', $smids)
        ->execute();
448

449 450 451 452
    foreach ($sitemaps as $sitemap) {
      xmlsitemap_clear_directory($sitemap, TRUE);
      module_invoke_all('xmlsitemap_sitemap_delete', $sitemap);
    }
453
  }
454
}
455

456 457 458 459 460 461 462 463 464 465
/**
 * Return the expected file path for a specific sitemap chunk.
 *
 * @param $sitemap
 *   An XML sitemap array.
 * @param $chunk
 *   An optional specific chunk in the sitemap. Defaults to the index page.
 */
function xmlsitemap_sitemap_get_file(array $sitemap, $chunk = 'index') {
  return xmlsitemap_get_directory($sitemap) . "/{$chunk}.xml";
Darren Oh's avatar
Darren Oh committed
466 467
}

468 469 470 471 472 473 474 475 476 477 478 479 480 481 482
/**
 * Find the maximum file size of all a sitemap's XML files.
 *
 * @param $sitemap
 *   The XML sitemap array.
 */
function xmlsitemap_sitemap_get_max_filesize(array &$sitemap) {
  $dir = xmlsitemap_get_directory($sitemap);
  $sitemap['max_filesize'] = 0;
  foreach (file_scan_directory($dir, '/\.xml$/') as $file) {
    $sitemap['max_filesize'] = max($sitemap['max_filesize'], filesize($file->uri));
  }
  return $sitemap['max_filesize'];
}

483 484 485 486 487
function xmlsitemap_sitemap_get_context_hash(array &$context) {
  asort($context);
  return drupal_hash_base64(serialize($context));
}

Darren Oh's avatar
Darren Oh committed
488
/**
489
 * Returns the uri elements of an XML sitemap.
490
 *
491 492
 * @param $sitemap
 *   An unserialized data array for an XML sitemap.
493
 * @return
494 495
 *   An array containing the 'path' and 'options' keys used to build the uri of
 *   the XML sitemap, and matching the signature of url().
Darren Oh's avatar
Darren Oh committed
496
 */
497 498 499 500 501 502 503 504 505 506
function xmlsitemap_sitemap_uri(array $sitemap) {
  $uri['path'] = 'sitemap.xml';
  $uri['options'] = module_invoke_all('xmlsitemap_context_url_options', $sitemap['context']);
  drupal_alter('xmlsitemap_context_url_options', $uri['options'], $sitemap['context']);
  $uri['options'] += array(
    'absolute' => TRUE,
    'base_url' => variable_get('xmlsitemap_base_url', $GLOBALS['base_url']),
  );
  return $uri;
}
507

508 509 510
/**
 * @} End of "defgroup xmlsitemap_sitemap_api"
 */
Darren Oh's avatar
Darren Oh committed
511

512 513 514 515
/**
 * @defgroup xmlsitemap_link_api XML sitemap API for sitemap links.
 * @{
 */
Darren Oh's avatar
Darren Oh committed
516

517 518 519 520 521 522 523 524 525 526 527 528 529 530 531
/**
 * 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
532
/**
533
 * Load sitemap links from the database.
534 535
 *
 * @param $conditions
536 537
 *   An array of conditions on the {xmlsitemap} table in the form
 *   'field' => $value.
538
 * @return
539
 *   An array of sitemap link arrays.
Darren Oh's avatar
Darren Oh committed
540
 */
541
function xmlsitemap_link_load_multiple(array $conditions = array()) {
542 543
  $query = db_select('xmlsitemap');
  $query->fields('xmlsitemap');
544

545 546 547
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
  }
548

549
  $links = $query->execute()->fetchAll(PDO::FETCH_ASSOC);
550

551 552 553
  return $links;
}

Darren Oh's avatar
Darren Oh committed
554
/**
555 556 557 558
 * Saves or updates a sitemap link.
 *
 * @param $link
 *   An array with a sitemap link.
Darren Oh's avatar
Darren Oh committed
559
 */
560
function xmlsitemap_link_save(array $link) {
561 562
  $link += array(
    'access' => 1,
Dave Reid's avatar
Dave Reid committed
563
    'status' => 1,
564 565
    'status_override' => 0,
    'lastmod' => 0,
566
    'priority' => XMLSITEMAP_PRIORITY_DEFAULT,
567 568 569
    'priority_override' => 0,
    'changefreq' => 0,
    'changecount' => 0,
570
    'language' => LANGUAGE_NONE,
571 572 573 574 575 576 577 578 579
  );

  // 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
580
  }
581 582 583 584 585
  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;
  }

586
  $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();
587 588 589 590 591 592 593

  // 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) {
594
    drupal_write_record('xmlsitemap', $link, array('type', 'id'));
595 596
  }
  else {
597
    drupal_write_record('xmlsitemap', $link);
598 599 600 601 602 603
  }

  // 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
604 605 606
}

/**
607 608 609 610 611 612 613 614 615 616 617
 * 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
618
 */
619
function xmlsitemap_link_update_multiple($updates = array(), $conditions = array()) {
620 621 622 623 624 625 626
  // 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.
627 628 629 630 631
  $query = db_update('xmlsitemap');
  $query->fields($updates);
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
  }
632

633
  return $query->execute();
Darren Oh's avatar
Darren Oh committed
634 635
}

636
/**
637
 * Delete a specific sitemap link from the database.
638 639 640 641
 *
 * If a visible sitemap link was deleted, this will automatically set the
 * regenerate needed flag.
 *
642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659
 * @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.
 *
660
 * @param $conditions
661 662
 *   An array of conditions on the {xmlsitemap} table in the form
 *   'field' => $value.
663 664
 * @return
 *   The number of links that were deleted.
665
 */
666
function xmlsitemap_link_delete_multiple(array $conditions) {
667 668 669
  // Because this function is called from sub-module uninstall hooks, we have
  // to manually check if the table exists since it could have been removed
  // in xmlsitemap_uninstall().
670
  // @todo Remove this check when http://drupal.org/node/151452 is fixed.
671 672 673 674
  if (!db_table_exists('xmlsitemap')) {
    return FALSE;
  }

675 676
  if (!variable_get('xmlsitemap_regenerate_needed', TRUE)) {
    _xmlsitemap_check_changed_links($conditions, array(), TRUE);
677
  }
678

679 680 681 682
  $query = db_delete('xmlsitemap');
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
  }
683

684
  return $query->execute();
685 686
}

Darren Oh's avatar
Darren Oh committed
687
/**
688
 * Check if there is a visible sitemap link given a certain set of conditions.
689
 *
690 691 692 693 694 695 696
 * @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.
697
 */
698 699 700 701
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;
702

703 704 705 706
  $query = db_select('xmlsitemap');
  $query->addExpression('1');
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
707
  }
708 709
  $query->range(0, 1);
  $changed = $query->execute()->fetchField();
710

711 712
  if ($changed && $flag) {
    variable_set('xmlsitemap_regenerate_needed', TRUE);
Darren Oh's avatar
Darren Oh committed
713
  }
714

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

/**
719
 * Check if there is sitemap link is changed from the existing data.
720
 *
721 722 723 724 725 726 727 728 729 730 731
 * @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
732
 */
733 734
function _xmlsitemap_check_changed_link(array $link, $original_link = NULL, $flag = FALSE) {
  $changed = FALSE;
735

736 737 738 739
  if ($original_link === NULL) {
    // Load only the fields necessary for data to be changed in the sitemap.
    $original_link = db_query_range("SELECT loc, access, status, lastmod, priority, changefreq, changecount, language FROM {xmlsitemap} WHERE type = :type AND id = :id", 0, 1, array(':type' => $link['type'], ':id' => $link['id']))->fetchAssoc();
  }
Darren Oh's avatar
Darren Oh committed
740

741 742 743 744
  if (!$original_link) {
    if ($link['access'] && $link['status']) {
      // Adding a new visible link.
      $changed = TRUE;
Darren Oh's avatar
Darren Oh committed
745
    }
746
  }
747 748 749 750 751 752 753 754
  else {
    if (!($original_link['access'] && $original_link['status']) && $link['access'] && $link['status']) {
      // Changing a non-visible link to a visible link.
      $changed = TRUE;
    }
    elseif ($original_link['access'] && $original_link['status'] && array_diff_assoc($original_link, $link)) {
      // Changing a visible link
      $changed = TRUE;
Darren Oh's avatar
Darren Oh committed
755 756
    }
  }
757 758 759

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

762
  return $changed;
Darren Oh's avatar
Darren Oh committed
763 764 765
}

/**
766
 * @} End of "defgroup xmlsitemap_link_api"
767
 */
Darren Oh's avatar
Darren Oh committed
768

769 770
function xmlsitemap_get_directory(array $sitemap = NULL) {
  $directory = &drupal_static(__FUNCTION__);
771

772
  if (!isset($directory)) {
773
    $directory = variable_get('xmlsitemap_path', 'xmlsitemap');
Darren Oh's avatar
Darren Oh committed
774
  }
775

776 777 778 779 780 781
  if (!empty($sitemap['smid'])) {
    return file_build_uri($directory . '/' . $sitemap['smid']);
  }
  else {
    return file_build_uri($directory);
  }
Darren Oh's avatar
Darren Oh committed
782 783 784
}

/**
785
 * Check that the sitemap files directory exists and is writable.
Darren Oh's avatar
Darren Oh committed
786
 */
787 788 789 790 791 792 793 794 795
function xmlsitemap_check_directory(array $sitemap = NULL) {
  $directory = xmlsitemap_get_directory($sitemap);
  $result = file_prepare_directory($directory, FILE_CREATE_DIRECTORY | FILE_MODIFY_PERMISSIONS);
  if (!$result) {
    watchdog('file system', 'The directory %directory does not exist or is not writable.', array('%directory' => $directory), WATCHDOG_ERROR);
  }
  return $result;
}

796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817
function xmlsitemap_check_all_directories() {
  $directories = array();

  $sitemaps = xmlsitemap_sitemap_load_multiple(FALSE);
  foreach ($sitemaps as $smid => $sitemap) {
    $directory = xmlsitemap_get_directory($sitemap);
    $directories[$directory] = $directory;
  }

  foreach ($directories as $directory) {
    $result = file_prepare_directory($directory, FILE_CREATE_DIRECTORY | FILE_MODIFY_PERMISSIONS);
    if ($result) {
      $directories[$directory] = TRUE;
    }
    else {
      $directories[$directory] = FALSE;
    }
  }

  return $directories;
}

818 819 820 821 822
function xmlsitemap_clear_directory(array $sitemap = NULL, $delete = FALSE) {
  $directory = xmlsitemap_get_directory($sitemap);
  return _xmlsitemap_delete_recursive($directory, $delete);
}

823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855
/**
 * Move a directory to a new location.
 *
 * @param $old_dir
 *   A string specifying the filepath or URI of the original directory.
 * @param $new_dir
 *   A string specifying the filepath or URI of the new directory.
 * @param $replace
 *   Replace behavior when the destination file already exists.
 *
 * @return
 *   TRUE if the directory was moved successfully. FALSE otherwise.
 */
function xmlsitemap_directory_move($old_dir, $new_dir, $replace = FILE_EXISTS_REPLACE) {
  $success = file_prepare_directory($new_dir, FILE_CREATE_DIRECTORY | FILE_MODIFY_PERMISSIONS);

  $old_path = drupal_realpath($old_dir);
  $new_path = drupal_realpath($new_dir);
  if (!is_dir($old_path) || !is_dir($new_path) || !$success) {
    return FALSE;
  }

  $files = file_scan_directory($old_dir, '/.*/');
  foreach ($files as $file) {
    $file->uri_new = $new_dir . '/' . basename($file->filename);
    $success &= (bool) file_unmanaged_move($file->uri, $file->uri_new, $replace);
  }

  // The remove the directory.
  $success &= drupal_rmdir($old_dir);
  return $success;
}

856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880
/**
 * Recursively delete all files and folders in the specified filepath.
 *
 * This is a backport of Drupal 7's file_unmanaged_delete_recursive().
 *
 * Note that this only deletes visible files with write permission.
 *
 * @param $path
 *   A filepath relative to file_directory_path.
 * @param $delete_root
 *   A boolean if TRUE will delete the $path directory afterwards.
 */
function _xmlsitemap_delete_recursive($path, $delete_root = FALSE) {
  // Resolve streamwrapper URI to local path.
  $path = drupal_realpath($path);
  if (is_dir($path)) {
    $dir = dir($path);
    while (($entry = $dir->read()) !== FALSE) {
      if ($entry == '.' || $entry == '..') {
        continue;
      }
      $entry_path = $path . '/' . $entry;
      file_unmanaged_delete_recursive($entry_path, TRUE);
    }
    $dir->close();
881
    return $delete_root ? drupal_rmdir($path) : TRUE;
882 883
  }
  return file_unmanaged_delete($path);
Darren Oh's avatar
Darren Oh committed
884 885 886
}

/**
887 888 889 890 891 892 893 894 895 896 897
 * 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
898
 */
899
function xmlsitemap_get_link_info($type = NULL, $reset = FALSE) {
900
  global $language;
901
  $link_info = &drupal_static(__FUNCTION__);
902

903 904
  if ($reset) {
    $link_info = NULL;
905
    entity_info_cache_clear();
906 907 908 909 910
  }
  elseif ($cached = cache_get('xmlsitemap:link_info:' . $language->language)) {
    $link_info = $cached->data;
  }

911
  if (!isset($link_info)) {
912 913
    $link_info = entity_get_info();
    foreach ($link_info as $key => $info) {
914
      if (empty($info['uri callback']) || !isset($info['xmlsitemap'])) {
915 916 917 918 919 920
        // 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.
921
          //unset($link_info[$key]['bundles'][$bundle_key]);
922 923 924
        }
      }
    }
925
    $link_info = array_merge($link_info, module_invoke_all('xmlsitemap_link_info'));
926 927
    foreach ($link_info as $key => &$info) {
      $info += array(
928 929 930
        'type' => $key,
        'base table' => FALSE,
        'bundles' => array(),
931
        'xmlsitemap' => array(),
932
      );
933
      if (!isset($info['xmlsitemap']['rebuild callback']) && !empty($info['base table']) && !empty($info['entity keys']['id']) && !empty($info['xmlsitemap']['process callback'])) {
934 935
        $info['xmlsitemap']['rebuild callback'] = 'xmlsitemap_rebuild_batch_fetch';
      }
936 937 938 939
      foreach ($info['bundles'] as $bundle => &$bundle_info) {
        $bundle_info += array(
          'xmlsitemap' => array(),
        );
940
        $bundle_info['xmlsitemap'] += xmlsitemap_link_bundle_load($key, $bundle, FALSE);
941
      }
942 943 944 945 946
    }
    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
947
  }
948 949 950 951 952 953

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

  return $link_info;
Darren Oh's avatar
Darren Oh committed
954 955
}

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

969 970 971
function xmlsitemap_get_link_type_indexed_status($entity_type, $bundle = '') {
  $info = xmlsitemap_get_link_info($entity_type);

972 973
  $status['indexed'] = db_query("SELECT COUNT(id) FROM {xmlsitemap} WHERE type = :entity AND subtype = :bundle", array(':entity' => $entity_type, ':bundle' => $bundle))->fetchField();
  $status['visible'] = db_query("SELECT COUNT(id) FROM {xmlsitemap} WHERE type = :entity AND subtype = :bundle AND status = 1 AND access = 1", array(':entity' => $entity_type, ':bundle' => $bundle))->fetchField();
974

975
  // @todo Convert this query to a countQuery().
976
  $total = db_select($info['base table'], 'base');
977 978
  $total->addExpression('COUNT(:id)', 'count_expression', array(':id' => $info['entity keys']['id']));
  //$total->addField('base', $info['entity keys']['id']);
979
  $total->condition($info['entity keys']['id'], 0, '>');
980 981
  $total->addTag('xmlsitemap_link_bundle_access');
  $total->addTag('xmlsitemap_link_indexed_status');
982 983 984
  $total->addMetaData('entity', $entity_type);
  $total->addMetaData('bundle', $bundle);
  $total->addMetaData('entity_info', $info);
985
  $status['total'] = $total->/*countQuery()->*/execute()->fetchField();
986 987 988

  return $status;
}
989

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

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

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

1015 1016 1017 1018 1019 1020 1021
function xmlsitemap_link_bundle_load($entity, $bundle, $load_bundle_info = TRUE) {
  $info = array(
    'entity' => $entity,
    'bundle' => $bundle,
  );
  if ($load_bundle_info) {
    $entity_info = xmlsitemap_get_link_info($entity);
1022 1023 1024
    if (isset($entity_info['bundles'][$bundle])) {
      $info['info'] = $entity_info['bundles'][$bundle];
    }
1025 1026 1027 1028 1029 1030 1031
  }
  $info += variable_get("xmlsitemap_settings_{$entity}_{$bundle}", array());
  $info += array(
    'status' => XMLSITEMAP_STATUS_DEFAULT,
    'priority' => XMLSITEMAP_PRIORITY_DEFAULT,
  );
  return $info;
1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042
}

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

1043 1044 1045 1046 1047 1048 1049
function xmlsitemap_link_bundle_access($entity, $bundle = NULL) {
  if (is_array($entity) && !isset($bundle)) {
    $bundle = $entity;
  }
  else {
    $bundle = xmlsitemap_link_bundle_load($entity, $bundle);
  }
1050

1051 1052
  if (isset($bundle['info']['admin'])) {
    $admin = $bundle['info']['admin'];
1053 1054 1055 1056 1057 1058 1059 1060
    $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']);
1061 1062 1063 1064 1065
    }
  }

  return FALSE;
}
1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079

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

1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164