xmlsitemap.module 46.5 KB
Newer Older
Darren Oh's avatar
Darren Oh committed
1 2 3
<?php

/**
4
 * @defgroup xmlsitemap XML sitemap
Darren Oh's avatar
Darren Oh committed
5 6 7
 */

/**
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
 * @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);

29 30 31 32 33 34 35 36 37 38 39 40 41 42 43
/**
 * 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');

44 45 46 47 48 49 50 51 52 53
/**
 * 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);

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

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

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 your site's XML sitemaps to help search engines find and index pages on your site.",
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
    'options' => array('modal' => TRUE),
153 154
  );
  $items['admin/config/search/xmlsitemap/edit/%xmlsitemap_sitemap'] = array(
155
    'title' => 'Edit XML sitemap',
156 157 158 159
    'page callback' => 'drupal_get_form',
    'page arguments' => array('xmlsitemap_sitemap_edit_form', 5),
    'access arguments' => array('administer xmlsitemap'),
    'file' => 'xmlsitemap.admin.inc',
160
    'modal' => TRUE,
161 162
  );
  $items['admin/config/search/xmlsitemap/delete/%xmlsitemap_sitemap'] = array(
163
    'title' => 'Delete XML sitemap',
164 165 166 167
    'page callback' => 'drupal_get_form',
    'page arguments' => array('xmlsitemap_sitemap_delete_form', 5),
    'access arguments' => array('administer xmlsitemap'),
    'file' => 'xmlsitemap.admin.inc',
168
    'modal' => TRUE,
169
  );
170

171
  $items['admin/config/search/xmlsitemap/settings'] = array(
172
    'title' => 'Settings',
173 174
    'page callback' => 'drupal_get_form',
    'page arguments' => array('xmlsitemap_settings_form'),
175
    'access arguments' => array('administer xmlsitemap'),
176
    'type' => MENU_LOCAL_TASK,
177
    'file' => 'xmlsitemap.admin.inc',
178
    'weight' => 10,
179
  );
180 181 182 183 184 185 186 187 188 189
  $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,
  );

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

  $items['sitemap.xml'] = array(
202
    'page callback' => 'xmlsitemap_output_chunk',
203
    'access callback' => TRUE,
204 205 206 207 208 209
    'type' => MENU_CALLBACK,
    'file' => 'xmlsitemap.pages.inc',
  );
  $items['sitemap.xsl'] = array(
    'page callback' => 'xmlsitemap_output_xsl',
    'access callback' => TRUE,
210
    'type' => MENU_CALLBACK,
211
    'file' => 'xmlsitemap.pages.inc',
212 213
  );

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

217 218 219 220 221 222 223 224 225
/**
 * 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
226
/**
227
 * Implements hook_cron().
228 229 230
 *
 * @todo Use new Queue system. Need to add {sitemap}.queued.
 * @todo Regenerate one at a time?
Darren Oh's avatar
Darren Oh committed
231
 */
232
function xmlsitemap_cron() {
233 234
  // If there were no new or changed links, skip.
  if (!variable_get('xmlsitemap_regenerate_needed', FALSE)) {
235 236 237
    return;
  }

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

249 250 251 252 253 254 255 256 257 258 259 260 261 262
/**
 * 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
263
/**
264
 * Implements hook_robotstxt().
Darren Oh's avatar
Darren Oh committed
265
 */
266
function xmlsitemap_robotstxt() {
267
  if ($sitemap = xmlsitemap_sitemap_load_by_context()) {
268
    $robotstxt[] = 'Sitemap: ' . url($sitemap->uri['path'], $sitemap->uri['options']);
269
    return $robotstxt;
270
  }
Darren Oh's avatar
Darren Oh committed
271 272
}

273
/**
274
 * Internal default variables for xmlsitemap_var().
275
 */
276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292
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,
293
    // Removed variables are set to NULL so they can still be deleted.
294 295 296 297
    'xmlsitemap_regenerate_last' => NULL,
    'xmlsitemap_custom_links' => NULL,
    'xmlsitemap_priority_default' => NULL,
    'xmlsitemap_languages' => NULL,
298 299
    'xmlsitemap_max_chunks' => NULL,
    'xmlsitemap_max_filesize' => NULL,
300 301 302 303 304 305 306 307 308 309
  );
}

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

312 313 314 315 316
  $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))));
317 318
  }

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

Darren Oh's avatar
Darren Oh committed
322
/**
323
 * @defgroup xmlsitemap_api XML sitemap API.
324
 * @{
325 326
 * This is the XML sitemap API to be used by modules wishing to work with
 * XML sitemap and/or link data.
Darren Oh's avatar
Darren Oh committed
327
 */
328 329 330 331 332 333

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

/**
344 345 346
 * Load multiple XML sitemaps from the database.
 *
 * @param $smids
347 348 349
 *   An array of XML sitemap IDs, or FALSE to load all XML sitemaps.
 * @param $conditions
 *   An array of conditions in the form 'field' => $value.
350 351 352
 *
 * @return
 *   An array of XML sitemap objects.
Darren Oh's avatar
Darren Oh committed
353
 */
354 355 356 357
function xmlsitemap_sitemap_load_multiple($smids = array(), array $conditions = array()) {
  if ($smids !== FALSE) {
    $conditions['smid'] = $smids;
  }
358 359 360

  $query = db_select('xmlsitemap_sitemap');
  $query->fields('xmlsitemap_sitemap');
361 362 363 364
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
  }

365
  $sitemaps = $query->execute()->fetchAllAssoc('smid');
366
  foreach ($sitemaps as $smid => $sitemap) {
367 368
    $sitemaps[$smid]->context = unserialize($sitemap->context);
    $sitemaps[$smid]->uri = xmlsitemap_sitemap_uri($sitemaps[$smid]);
Darren Oh's avatar
Darren Oh committed
369
  }
370

371
  return $sitemaps;
372 373 374
}

/**
375
 * Load an XML sitemap array from the database based on its context.
376
 *
377 378
 * @param $context
 *   An optional XML sitemap context array to use to find the correct XML
379
 *   sitemap. If not provided, the current site's context will be used.
380
 *
381
 * @see xmlsitemap_get_current_context()
382
 */
383 384 385
function xmlsitemap_sitemap_load_by_context(array $context = NULL) {
  if (!isset($context)) {
    $context = xmlsitemap_get_current_context();
Darren Oh's avatar
Darren Oh committed
386
  }
387 388
  $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();
389
  return xmlsitemap_sitemap_load($smid);
Darren Oh's avatar
Darren Oh committed
390 391 392
}

/**
393
 * Save changes to an XML sitemap or add a new XML sitemap.
394
 *
395
 * @param $sitemap
396
 *   The XML sitemap array to be saved. If $sitemap->smid is omitted, a new
397 398 399
 *   XML sitemap will be added.
 *
 * @todo Save the sitemap's URL as a column?
Darren Oh's avatar
Darren Oh committed
400
 */
401
function xmlsitemap_sitemap_save(stdClass $sitemap) {
402 403 404 405
  if (!isset($sitemap->context)) {
    $sitemap->context = array();
  }

406
  // Make sure context is sorted before saving the hash.
407 408
  $sitemap->is_new = empty($sitemap->smid);
  $sitemap->old_smid = $sitemap->is_new ? NULL : $sitemap->smid;
409
  $sitemap->smid = xmlsitemap_sitemap_get_context_hash($sitemap->context);
410

411
  // If the context was changed, we need to perform additional actions.
412
  if (!$sitemap->is_new && $sitemap->smid != $sitemap->old_smid) {
413
    // Rename the files directory so the sitemap does not break.
414
    $old_sitemap = (object) array('smid' => $sitemap->old_smid);
415
    $old_dir = xmlsitemap_get_directory($old_sitemap);
416 417 418 419 420
    $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')
421
      ->fields(array('smid' => $sitemap->smid))
422
      ->condition('smid', $sitemap->old_smid)
423 424 425 426
      ->execute();

    // Mark the sitemaps as needing regeneration.
    variable_set('xmlsitemap_regenerate_needed', TRUE);
427
  }
428

429
  if ($sitemap->is_new) {
430
    drupal_write_record('xmlsitemap_sitemap', $sitemap);
431 432 433 434 435
    module_invoke_all('xmlsitemap_sitemap_insert', $sitemap);
  }
  else {
    drupal_write_record('xmlsitemap_sitemap', $sitemap, array('smid'));
    module_invoke_all('xmlsitemap_sitemap_update', $sitemap);
436
  }
437 438

  return $sitemap;
439 440 441
}

/**
442
 * Delete an XML sitemap.
443
 *
444 445
 * @param $smid
 *   An XML sitemap ID.
446
 */
447 448
function xmlsitemap_sitemap_delete($smid) {
  xmlsitemap_sitemap_delete_multiple(array($smid));
449 450
}

Darren Oh's avatar
Darren Oh committed
451
/**
452
 * Delete multiple XML sitemaps.
453
 *
454 455
 * @param $smids
 *   An array of XML sitemap IDs.
Darren Oh's avatar
Darren Oh committed
456
 */
457 458 459 460 461 462
function xmlsitemap_sitemap_delete_multiple(array $smids) {
  if (!empty($smids)) {
    $sitemaps = xmlsitemap_sitemap_load_multiple($smids);
    db_delete('xmlsitemap_sitemap')
        ->condition('smid', $smids)
        ->execute();
463

464 465 466 467
    foreach ($sitemaps as $sitemap) {
      xmlsitemap_clear_directory($sitemap, TRUE);
      module_invoke_all('xmlsitemap_sitemap_delete', $sitemap);
    }
468
  }
469
}
470

471 472 473 474 475 476 477 478
/**
 * 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.
 */
479
function xmlsitemap_sitemap_get_file(stdClass $sitemap, $chunk = 'index') {
480
  return xmlsitemap_get_directory($sitemap) . "/{$chunk}.xml";
Darren Oh's avatar
Darren Oh committed
481 482
}

483 484 485 486 487 488
/**
 * Find the maximum file size of all a sitemap's XML files.
 *
 * @param $sitemap
 *   The XML sitemap array.
 */
489
function xmlsitemap_sitemap_get_max_filesize(stdClass $sitemap) {
490
  $dir = xmlsitemap_get_directory($sitemap);
491
  $sitemap->max_filesize = 0;
492
  foreach (file_scan_directory($dir, '/\.xml$/') as $file) {
493
    $sitemap->max_filesize = max($sitemap->max_filesize, filesize($file->uri));
494
  }
495
  return $sitemap->max_filesize;
496 497
}

498 499 500 501 502
function xmlsitemap_sitemap_get_context_hash(array &$context) {
  asort($context);
  return drupal_hash_base64(serialize($context));
}

Darren Oh's avatar
Darren Oh committed
503
/**
504
 * Returns the uri elements of an XML sitemap.
505
 *
506 507
 * @param $sitemap
 *   An unserialized data array for an XML sitemap.
508
 * @return
509 510
 *   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
511
 */
512
function xmlsitemap_sitemap_uri(stdClass $sitemap) {
513
  $uri['path'] = 'sitemap.xml';
514 515
  $uri['options'] = module_invoke_all('xmlsitemap_context_url_options', $sitemap->context);
  drupal_alter('xmlsitemap_context_url_options', $uri['options'], $sitemap->context);
516 517 518 519 520 521
  $uri['options'] += array(
    'absolute' => TRUE,
    'base_url' => variable_get('xmlsitemap_base_url', $GLOBALS['base_url']),
  );
  return $uri;
}
522

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

551 552 553
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
  }
554

555
  $links = $query->execute()->fetchAll(PDO::FETCH_ASSOC);
556

557 558 559
  return $links;
}

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

  // 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
586
  }
587 588 589 590 591
  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;
  }

592
  $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();
593 594 595 596 597 598

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

599
  // Save the link and allow other modules to respond to the link being saved.
600
  if ($existing) {
601
    drupal_write_record('xmlsitemap', $link, array('type', 'id'));
602
    module_invoke_all('xmlsitemap_link_update', $link);
603 604
  }
  else {
605
    drupal_write_record('xmlsitemap', $link);
606
    module_invoke_all('xmlsitemap_link_insert', $link);
607 608 609
  }

  return $link;
Darren Oh's avatar
Darren Oh committed
610 611 612
}

/**
613 614 615 616 617 618 619 620 621 622 623
 * 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
624
 */
625
function xmlsitemap_link_update_multiple($updates = array(), $conditions = array(), $check_flag = TRUE) {
626 627
  // If we are going to modify a visible sitemap link, we will need to set
  // the regenerate needed flag.
628
  if ($check_flag && !variable_get('xmlsitemap_regenerate_needed', FALSE)) {
629 630 631 632
    _xmlsitemap_check_changed_links($conditions, $updates, TRUE);
  }

  // Process updates.
633 634 635 636 637
  $query = db_update('xmlsitemap');
  $query->fields($updates);
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
  }
638

639
  return $query->execute();
Darren Oh's avatar
Darren Oh committed
640 641
}

642
/**
643
 * Delete a specific sitemap link from the database.
644 645 646 647
 *
 * If a visible sitemap link was deleted, this will automatically set the
 * regenerate needed flag.
 *
648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665
 * @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.
 *
666
 * @param $conditions
667 668
 *   An array of conditions on the {xmlsitemap} table in the form
 *   'field' => $value.
669 670
 * @return
 *   The number of links that were deleted.
671
 */
672
function xmlsitemap_link_delete_multiple(array $conditions) {
673 674 675
  // 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().
676
  // @todo Remove this check when http://drupal.org/node/151452 is fixed.
677 678 679 680
  if (!db_table_exists('xmlsitemap')) {
    return FALSE;
  }

681 682
  if (!variable_get('xmlsitemap_regenerate_needed', TRUE)) {
    _xmlsitemap_check_changed_links($conditions, array(), TRUE);
683
  }
684

685 686
  // @todo Add a hook_xmlsitemap_link_delete() hook invoked here.

687 688 689 690
  $query = db_delete('xmlsitemap');
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
  }
691

692
  return $query->execute();
693 694
}

Darren Oh's avatar
Darren Oh committed
695
/**
696
 * Check if there is a visible sitemap link given a certain set of conditions.
697
 *
698 699 700 701 702 703 704
 * @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.
705
 */
706 707 708 709
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;
710

711 712 713 714
  $query = db_select('xmlsitemap');
  $query->addExpression('1');
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
715
  }
716 717
  $query->range(0, 1);
  $changed = $query->execute()->fetchField();
718

719 720
  if ($changed && $flag) {
    variable_set('xmlsitemap_regenerate_needed', TRUE);
Darren Oh's avatar
Darren Oh committed
721
  }
722

723
  return $changed;
Darren Oh's avatar
Darren Oh committed
724 725 726
}

/**
727
 * Check if there is sitemap link is changed from the existing data.
728
 *
729 730 731 732 733 734 735 736 737 738 739
 * @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
740
 */
741 742
function _xmlsitemap_check_changed_link(array $link, $original_link = NULL, $flag = FALSE) {
  $changed = FALSE;
743

744 745 746 747
  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
748

749 750 751 752
  if (!$original_link) {
    if ($link['access'] && $link['status']) {
      // Adding a new visible link.
      $changed = TRUE;
Darren Oh's avatar
Darren Oh committed
753
    }
754
  }
755 756 757 758 759 760 761 762
  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
763 764
    }
  }
765 766 767

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

770
  return $changed;
Darren Oh's avatar
Darren Oh committed
771 772 773
}

/**
774
 * @} End of "defgroup xmlsitemap_api"
775
 */
Darren Oh's avatar
Darren Oh committed
776

777
function xmlsitemap_get_directory(stdClass $sitemap = NULL) {
778
  $directory = &drupal_static(__FUNCTION__);
779

780
  if (!isset($directory)) {
781
    $directory = variable_get('xmlsitemap_path', 'xmlsitemap');
Darren Oh's avatar
Darren Oh committed
782
  }
783

784 785
  if (!empty($sitemap->smid)) {
    return file_build_uri($directory . '/' . $sitemap->smid);
786 787 788 789
  }
  else {
    return file_build_uri($directory);
  }
Darren Oh's avatar
Darren Oh committed
790 791 792
}

/**
793
 * Check that the sitemap files directory exists and is writable.
Darren Oh's avatar
Darren Oh committed
794
 */
795
function xmlsitemap_check_directory(stdClass $sitemap = NULL) {
796 797 798 799 800 801 802 803
  $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;
}

804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825
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;
}

826
function xmlsitemap_clear_directory(stdClass $sitemap = NULL, $delete = FALSE) {
827 828 829 830
  $directory = xmlsitemap_get_directory($sitemap);
  return _xmlsitemap_delete_recursive($directory, $delete);
}

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 856 857 858 859 860 861 862 863
/**
 * 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;
}

864 865 866 867 868 869 870 871
/**
 * 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
872
 *   A filepath relative to the Drupal root directory.
873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888
 * @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();
889
    return $delete_root ? drupal_rmdir($path) : TRUE;
890 891
  }
  return file_unmanaged_delete($path);
Darren Oh's avatar
Darren Oh committed
892 893 894
}

/**
895 896 897 898 899 900 901 902 903 904 905
 * 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
906
 */
907
function xmlsitemap_get_link_info($type = NULL, $reset = FALSE) {
908
  global $language;
909
  $link_info = &drupal_static(__FUNCTION__);
910

911 912
  if ($reset) {
    $link_info = NULL;
913
    cache_clear_all('xmlsitemap:link_info:', 'cache', TRUE);
914 915
  }

916
  if (!isset($link_info)) {
917 918 919
    $cid = 'xmlsitemap:link_info:' . $language->language;
    if ($cache = cache_get($cid)) {
      $link_info = $cache->data;
920
    }
921 922 923 924 925 926 927 928 929 930 931 932 933 934
    else {
      entity_info_cache_clear();
      $link_info = entity_get_info();
      foreach ($link_info as $key => $info) {
        if (empty($info['uri callback']) || !isset($info['xmlsitemap'])) {
          // Remove any non URL-able or XML sitemap un-supported entites.
          unset($link_info[$key]);
        }
        foreach ($info['bundles'] as $bundle_key => $bundle) {
          if (!isset($bundle['xmlsitemap'])) {
            // Remove any un-supported entity bundles.
            //unset($link_info[$key]['bundles'][$bundle_key]);
          }
        }
935
      }
936 937 938 939 940 941
      $link_info = array_merge($link_info, module_invoke_all('xmlsitemap_link_info'));
      foreach ($link_info as $key => &$info) {
        $info += array(
          'type' => $key,
          'base table' => FALSE,
          'bundles' => array(),
942 943
          'xmlsitemap' => array(),
        );
944 945 946 947 948 949 950 951 952
        if (!isset($info['xmlsitemap']['rebuild callback']) && !empty($info['base table']) && !empty($info['entity keys']['id']) && !empty($info['xmlsitemap']['process callback'])) {
          $info['xmlsitemap']['rebuild callback'] = 'xmlsitemap_rebuild_batch_fetch';
        }
        foreach ($info['bundles'] as $bundle => &$bundle_info) {
          $bundle_info += array(
            'xmlsitemap' => array(),
          );
          $bundle_info['xmlsitemap'] += xmlsitemap_link_bundle_load($key, $bundle, FALSE);
        }
953
      }
954 955 956 957
      drupal_alter('xmlsitemap_link_info', $link_info);
      ksort($link_info);
      // Cache by language since this info contains translated strings.
      cache_set($cid, $link_info);
958
    }
Darren Oh's avatar
Darren Oh committed
959
  }
960 961 962 963 964 965

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

  return $link_info;
Darren Oh's avatar
Darren Oh committed
966 967
}

968 969 970 971
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) {
972
    $settings = xmlsitemap_link_bundle_load($entity_type, $bundle);
973 974
    if (!empty($settings['status'])) {
    //if (!empty($bundle_info['xmlsitemap']['status'])) {
975 976 977 978 979 980
      $bundles[] = $bundle;
    }
  }
  return $bundles;
}

981 982 983
function xmlsitemap_get_link_type_indexed_status($entity_type, $bundle = '') {
  $info = xmlsitemap_get_link_info($entity_type);

984 985
  $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();
986

987 988 989 990 991
  $total = new EntityFieldQuery();
  $total->entityCondition('entity_type', $entity_type);
  $total->entityCondition('bundle', $bundle);
  $total->entityCondition('entity_id', 0, '>');
  //$total->addTag('xmlsitemap_link_bundle_access');
992
  $total->addTag('xmlsitemap_link_indexed_status');
993 994 995
  $total->addMetaData('entity', $entity_type);
  $total->addMetaData('bundle', $bundle);
  $total->addMetaData('entity_info', $info);
996 997
  $total->count();
  $status['total'] = $total->execute();
998 999 1000

  return $status;
}
1001

1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015
/**
 * Implements hook_entity_query_alter().
 *
 * @todo Remove when http://drupal.org/node/1054168 is fixed.
 */
function xmlsitemap_entity_query_alter($query) {
  $conditions = &$query->entityConditions;

  // Alter user entity queries only.
  if (isset($conditions['entity_type']) && $conditions['entity_type']['value'] == 'user' && isset($conditions['bundle'])) {
    unset($conditions['bundle']);
  }
}

1016 1017
function xmlsitemap_link_bundle_settings_save($entity, $bundle, array $settings, $update_links = TRUE) {
  if ($update_links) {
1018
    $old_settings = xmlsitemap_link_bundle_load($entity, $bundle);
1019
    if ($settings['status'] != $old_settings['status']) {
1020
      xmlsitemap_link_update_multiple(array('status' => $settings['status']), array('type' => $entity, 'subtype' => $bundle, 'status_override' => 0));
1021 1022
    }
    if ($settings['priority'] != $old_settings['priority']) {
1023
      xmlsitemap_link_update_multiple(array('priority' => $settings['priority']), array('type' => $entity, 'subtype' => $bundle, 'priority_override' => 0));
1024 1025 1026 1027 1028 1029 1030 1031
    }
  }

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