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

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

/**
9 10 11 12 13 14 15 16 17 18 19 20 21 22
 * @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);

23 24 25 26 27 28 29 30 31 32
// 60 * 60 * 24 * 7 * 52.
define('XMLSITEMAP_FREQUENCY_YEARLY', 31449600);
// 60 * 60 * 24 * 7 * 4.
define('XMLSITEMAP_FREQUENCY_MONTHLY', 2419200);
// 60 * 60 * 24 * 7.
define('XMLSITEMAP_FREQUENCY_WEEKLY', 604800);
// 60 * 60 * 24.
define('XMLSITEMAP_FREQUENCY_DAILY', 86400);
// 60 * 60.
define('XMLSITEMAP_FREQUENCY_HOURLY', 3600);
33 34
define('XMLSITEMAP_FREQUENCY_ALWAYS', 60);

35 36 37 38 39 40 41 42 43 44 45 46 47 48 49
/**
 * 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');

50 51 52 53 54 55 56 57 58 59
/**
 * 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);

60 61 62 63
/**
 * Implements hook_hook_info().
 */
function xmlsitemap_hook_info() {
64 65 66 67 68 69 70
  $hooks = array(
    'xmlsitemap_link_info',
    'xmlsitemap_link_info_alter',
    'xmlsitemap_link_alter',
    'xmlsitemap_index_links',
    'xmlsitemap_context_info',
    'xmlsitemap_context_info_alter',
71
    'xmlsitemap_context_url_options',
72
    'xmlsitemap_context',
73 74
    'xmlsitemap_element_alter',
    'xmlsitemap_root_attributes_alter',
75 76
    'xmlsitemap_sitemap_insert',
    'xmlsitemap_sitemap_update',
77 78 79 80
    'xmlsitemap_sitemap_operations',
    'xmlsitemap_sitemap_delete',
    'xmlsitemap_sitemap_link_url_options_alter',
    'query_xmlsitemap_generate_alter',
81
    'query_xmlsitemap_link_bundle_access_alter',
82
    'form_xmlsitemap_sitemap_edit_form_alter',
83
    'xmlsitemap_rebuild_clear',
84
  );
85 86 87 88 89

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

91 92 93
  return $hooks;
}

94 95
/**
 * Implements hook_help().
Darren Oh's avatar
Darren Oh committed
96
 */
97
function xmlsitemap_help($path, $arg) {
98 99
  $output = '';

100
  switch ($path) {
101
    case 'admin/help/xmlsitemap':
102
    case 'admin/config/search/xmlsitemap/settings/%/%/%':
103 104
    case 'admin/config/search/xmlsitemap/edit/%':
    case 'admin/config/search/xmlsitemap/delete/%':
105
      return;
106

107 108
    case 'admin/help#xmlsitemap':
      break;
109

110
    case 'admin/config/search/xmlsitemap':
111
      break;
112

113
    case 'admin/config/search/xmlsitemap/rebuild':
114 115 116
      $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>';
  }

117
  if (arg(0) == 'admin' && strpos($path, 'xmlsitemap') !== FALSE && user_access('administer xmlsitemap')) {
118
    module_load_include('inc', 'xmlsitemap');
119 120 121
    if ($arg[1] == 'config') {
      // Alert the user to any potential problems detected by hook_requirements.
      xmlsitemap_check_status();
122
    }
123
    $output .= _xmlsitemap_get_blurb();
Darren Oh's avatar
Darren Oh committed
124
  }
125 126 127 128 129 130 131

  return $output;
}

/**
 * Implements hook_perm().
 */
132
function xmlsitemap_permission() {
133 134
  $permissions['administer xmlsitemap'] = array(
    'title' => t('Administer XML sitemap settings.'),
135
  );
136
  return $permissions;
Darren Oh's avatar
Darren Oh committed
137 138 139
}

/**
140
 * Implements hook_menu().
Darren Oh's avatar
Darren Oh committed
141
 */
142
function xmlsitemap_menu() {
143
  $items['admin/config/search/xmlsitemap'] = array(
144
    'title' => 'XML sitemap',
145
    'description' => "Configure your site's XML sitemaps to help search engines find and index pages on your site.",
146
    'page callback' => 'drupal_get_form',
147
    'page arguments' => array('xmlsitemap_sitemap_list_form'),
148 149
    'access arguments' => array('administer xmlsitemap'),
    'file' => 'xmlsitemap.admin.inc',
150
  );
151 152 153 154 155 156 157 158 159 160 161 162
  $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',
163
    'modal' => TRUE,
164
    'options' => array('modal' => TRUE),
165 166
  );
  $items['admin/config/search/xmlsitemap/edit/%xmlsitemap_sitemap'] = array(
167
    'title' => 'Edit XML sitemap',
168 169 170 171
    'page callback' => 'drupal_get_form',
    'page arguments' => array('xmlsitemap_sitemap_edit_form', 5),
    'access arguments' => array('administer xmlsitemap'),
    'file' => 'xmlsitemap.admin.inc',
172
    'modal' => TRUE,
173 174
  );
  $items['admin/config/search/xmlsitemap/delete/%xmlsitemap_sitemap'] = array(
175
    'title' => 'Delete XML sitemap',
176 177 178 179
    'page callback' => 'drupal_get_form',
    'page arguments' => array('xmlsitemap_sitemap_delete_form', 5),
    'access arguments' => array('administer xmlsitemap'),
    'file' => 'xmlsitemap.admin.inc',
180
    'modal' => TRUE,
181
  );
182

183
  $items['admin/config/search/xmlsitemap/settings'] = array(
184
    'title' => 'Settings',
185 186
    'page callback' => 'drupal_get_form',
    'page arguments' => array('xmlsitemap_settings_form'),
187
    'access arguments' => array('administer xmlsitemap'),
188
    'type' => MENU_LOCAL_TASK,
189
    'file' => 'xmlsitemap.admin.inc',
190
    'weight' => 10,
191
  );
192 193 194 195 196 197 198 199 200 201
  $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,
  );

202
  $items['admin/config/search/xmlsitemap/rebuild'] = array(
203
    'title' => 'Rebuild links',
204
    'description' => 'Rebuild the site map.',
205
    'page callback' => 'drupal_get_form',
206
    'page arguments' => array('xmlsitemap_rebuild_form'),
207
    'access callback' => '_xmlsitemap_rebuild_form_access',
208
    'type' => MENU_LOCAL_TASK,
209
    'file' => 'xmlsitemap.admin.inc',
210
    'weight' => 20,
211 212 213
  );

  $items['sitemap.xml'] = array(
214
    'page callback' => 'xmlsitemap_output_chunk',
215
    'access callback' => TRUE,
216 217 218 219 220 221
    'type' => MENU_CALLBACK,
    'file' => 'xmlsitemap.pages.inc',
  );
  $items['sitemap.xsl'] = array(
    'page callback' => 'xmlsitemap_output_xsl',
    'access callback' => TRUE,
222
    'type' => MENU_CALLBACK,
223
    'file' => 'xmlsitemap.pages.inc',
224 225
  );

Darren Oh's avatar
Darren Oh committed
226 227 228
  return $items;
}

229 230 231 232 233 234 235 236 237
/**
 * 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
238
/**
239
 * Implements hook_cron().
240 241 242
 *
 * @todo Use new Queue system. Need to add {sitemap}.queued.
 * @todo Regenerate one at a time?
Darren Oh's avatar
Darren Oh committed
243
 */
244
function xmlsitemap_cron() {
245 246
  // If there were no new or changed links, skip.
  if (!variable_get('xmlsitemap_regenerate_needed', FALSE)) {
247 248
    return;
  }
249 250 251 252
  // If cron sitemap file regeneration is disabled, stop.
  if (variable_get('xmlsitemap_disable_cron_regeneration', 0)) {
    return;
  }
253

254 255 256 257 258 259 260
  // 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.
261
  module_load_include('generate.inc', 'xmlsitemap');
262
  xmlsitemap_run_unprogressive_batch('xmlsitemap_regenerate_batch');
Darren Oh's avatar
Darren Oh committed
263 264
}

265 266 267 268 269 270 271 272 273 274 275 276 277 278
/**
 * 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
279
/**
280
 * Implements hook_robotstxt().
Darren Oh's avatar
Darren Oh committed
281
 */
282
function xmlsitemap_robotstxt() {
283
  if ($sitemap = xmlsitemap_sitemap_load_by_context()) {
284
    $robotstxt[] = 'Sitemap: ' . url($sitemap->uri['path'], $sitemap->uri['options']);
285
    return $robotstxt;
286
  }
Darren Oh's avatar
Darren Oh committed
287 288
}

289
/**
290
 * Internal default variables for xmlsitemap_var().
291
 */
292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308
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,
309
    'xmlsitemap_disable_cron_regeneration' => 0,
310
    'xmlsitemap_output_elements' => array('lastmod', 'changefreq', 'priority'),
311
    // Removed variables are set to NULL so they can still be deleted.
312 313 314 315
    'xmlsitemap_regenerate_last' => NULL,
    'xmlsitemap_custom_links' => NULL,
    'xmlsitemap_priority_default' => NULL,
    'xmlsitemap_languages' => NULL,
316 317
    'xmlsitemap_max_chunks' => NULL,
    'xmlsitemap_max_filesize' => NULL,
318 319 320 321 322 323 324 325 326 327
  );
}

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

330 331 332 333 334
  $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))));
335 336
  }

337
  return variable_get($name, isset($default) || !isset($defaults[$name]) ? $default : $defaults[$name]);
338 339
}

Darren Oh's avatar
Darren Oh committed
340
/**
341
 * @defgroup xmlsitemap_api XML sitemap API.
342
 * @{
343 344
 * 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
345
 */
346 347 348 349

/**
 * Load an XML sitemap array from the database.
 *
350
 * @param array $smid
351
 *   An XML sitemap ID.
352
 *
353
 * @return object
354
 *   The XML sitemap object.
355 356
 *
 * @codingStandardsIgnoreStart
357 358
 */
function xmlsitemap_sitemap_load($smid) {
359
  // @codingStandardsIgnoreEnd
360 361
  $sitemap = xmlsitemap_sitemap_load_multiple(array($smid));
  return $sitemap ? reset($sitemap) : FALSE;
Darren Oh's avatar
Darren Oh committed
362 363 364
}

/**
365 366
 * Load multiple XML sitemaps from the database.
 *
367
 * @param array $smids
368
 *   An array of XML sitemap IDs, or FALSE to load all XML sitemaps.
369
 * @param array $conditions
370
 *   An array of conditions in the form 'field' => $value.
371
 *
372
 * @return array
373
 *   An array of XML sitemap objects.
374 375
 *
 * @codingStandardsIgnoreStart
Darren Oh's avatar
Darren Oh committed
376
 */
377
function xmlsitemap_sitemap_load_multiple($smids = array(), array $conditions = array()) {
378
  // @codingStandardsIgnoreEnd
379 380 381
  if ($smids !== FALSE) {
    $conditions['smid'] = $smids;
  }
382 383 384

  $query = db_select('xmlsitemap_sitemap');
  $query->fields('xmlsitemap_sitemap');
385 386 387 388
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
  }

389
  $sitemaps = $query->execute()->fetchAllAssoc('smid');
390
  foreach ($sitemaps as $smid => $sitemap) {
391 392
    $sitemaps[$smid]->context = unserialize($sitemap->context);
    $sitemaps[$smid]->uri = xmlsitemap_sitemap_uri($sitemaps[$smid]);
Darren Oh's avatar
Darren Oh committed
393
  }
394

395
  return $sitemaps;
396 397 398
}

/**
399
 * Load an XML sitemap array from the database based on its context.
400
 *
401
 * @param array $context
402
 *   An optional XML sitemap context array to use to find the correct XML
403
 *   sitemap. If not provided, the current site's context will be used.
404
 *
405
 * @see xmlsitemap_get_current_context()
406
 */
407 408 409
function xmlsitemap_sitemap_load_by_context(array $context = NULL) {
  if (!isset($context)) {
    $context = xmlsitemap_get_current_context();
Darren Oh's avatar
Darren Oh committed
410
  }
411 412
  $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();
413
  return xmlsitemap_sitemap_load($smid);
Darren Oh's avatar
Darren Oh committed
414 415 416
}

/**
417
 * Save changes to an XML sitemap or add a new XML sitemap.
418
 *
419
 * @param object $sitemap
420
 *   The XML sitemap array to be saved. If $sitemap->smid is omitted, a new
421 422 423
 *   XML sitemap will be added.
 *
 * @todo Save the sitemap's URL as a column?
Darren Oh's avatar
Darren Oh committed
424
 */
425
function xmlsitemap_sitemap_save(stdClass $sitemap) {
426 427 428 429
  if (!isset($sitemap->context)) {
    $sitemap->context = array();
  }

430
  // Make sure context is sorted before saving the hash.
431 432
  $sitemap->is_new = empty($sitemap->smid);
  $sitemap->old_smid = $sitemap->is_new ? NULL : $sitemap->smid;
433
  $sitemap->smid = xmlsitemap_sitemap_get_context_hash($sitemap->context);
434

435
  // If the context was changed, we need to perform additional actions.
436
  if (!$sitemap->is_new && $sitemap->smid != $sitemap->old_smid) {
437
    // Rename the files directory so the sitemap does not break.
438
    $old_sitemap = (object) array('smid' => $sitemap->old_smid);
439
    $old_dir = xmlsitemap_get_directory($old_sitemap);
440 441 442 443 444
    $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')
445
      ->fields(array('smid' => $sitemap->smid))
446
      ->condition('smid', $sitemap->old_smid)
447 448 449 450
      ->execute();

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

453
  if ($sitemap->is_new) {
454
    drupal_write_record('xmlsitemap_sitemap', $sitemap);
455 456 457 458 459
    module_invoke_all('xmlsitemap_sitemap_insert', $sitemap);
  }
  else {
    drupal_write_record('xmlsitemap_sitemap', $sitemap, array('smid'));
    module_invoke_all('xmlsitemap_sitemap_update', $sitemap);
460
  }
461 462

  return $sitemap;
463 464 465
}

/**
466
 * Delete an XML sitemap.
467
 *
468
 * @param array $smid
469
 *   An XML sitemap ID.
470 471
 *
 * @codingStandardsIgnoreStart
472
 */
473
function xmlsitemap_sitemap_delete($smid) {
474
  // @codingStandardsIgnoreEnd
475
  xmlsitemap_sitemap_delete_multiple(array($smid));
476 477
}

Darren Oh's avatar
Darren Oh committed
478
/**
479
 * Delete multiple XML sitemaps.
480
 *
481
 * @param array $smids
482
 *   An array of XML sitemap IDs.
Darren Oh's avatar
Darren Oh committed
483
 */
484 485 486 487
function xmlsitemap_sitemap_delete_multiple(array $smids) {
  if (!empty($smids)) {
    $sitemaps = xmlsitemap_sitemap_load_multiple($smids);
    db_delete('xmlsitemap_sitemap')
488 489
      ->condition('smid', $smids)
      ->execute();
490

491 492 493 494
    foreach ($sitemaps as $sitemap) {
      xmlsitemap_clear_directory($sitemap, TRUE);
      module_invoke_all('xmlsitemap_sitemap_delete', $sitemap);
    }
495
  }
496
}
497

498 499 500
/**
 * Return the expected file path for a specific sitemap chunk.
 *
501
 * @param object $sitemap
502
 *   An XML sitemap array.
503
 * @param string $chunk
504 505
 *   An optional specific chunk in the sitemap. Defaults to the index page.
 */
506
function xmlsitemap_sitemap_get_file(stdClass $sitemap, $chunk = 'index') {
507
  return xmlsitemap_get_directory($sitemap) . "/{$chunk}.xml";
Darren Oh's avatar
Darren Oh committed
508 509
}

510 511 512
/**
 * Find the maximum file size of all a sitemap's XML files.
 *
513
 * @param object $sitemap
514 515
 *   The XML sitemap array.
 */
516
function xmlsitemap_sitemap_get_max_filesize(stdClass $sitemap) {
517
  $dir = xmlsitemap_get_directory($sitemap);
518
  $sitemap->max_filesize = 0;
519
  foreach (file_scan_directory($dir, '/\.xml$/') as $file) {
520
    $sitemap->max_filesize = max($sitemap->max_filesize, filesize($file->uri));
521
  }
522
  return $sitemap->max_filesize;
523 524
}

525 526 527
/**
 * Get context.
 */
528 529 530 531 532
function xmlsitemap_sitemap_get_context_hash(array &$context) {
  asort($context);
  return drupal_hash_base64(serialize($context));
}

Darren Oh's avatar
Darren Oh committed
533
/**
534
 * Returns the uri elements of an XML sitemap.
535
 *
536
 * @param object $sitemap
537
 *   An unserialized data array for an XML sitemap.
538 539
 *
 * @return array
540 541
 *   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
542
 */
543
function xmlsitemap_sitemap_uri(stdClass $sitemap) {
544
  $uri['path'] = 'sitemap.xml';
545 546
  $uri['options'] = module_invoke_all('xmlsitemap_context_url_options', $sitemap->context);
  drupal_alter('xmlsitemap_context_url_options', $uri['options'], $sitemap->context);
547 548 549 550 551 552
  $uri['options'] += array(
    'absolute' => TRUE,
    'base_url' => variable_get('xmlsitemap_base_url', $GLOBALS['base_url']),
  );
  return $uri;
}
553

554 555 556
/**
 * Load a specific sitemap link from the database.
 *
557
 * @param string $entity_type
558
 *   A string with the entity type.
559
 * @param int $entity_id
560
 *   An integer with the entity ID.
561 562
 *
 * @return array
563 564 565 566 567 568 569
 *   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
570
/**
571
 * Load sitemap links from the database.
572
 *
573
 * @param array $conditions
574 575
 *   An array of conditions on the {xmlsitemap} table in the form
 *   'field' => $value.
576 577
 *
 * @return array
578
 *   An array of sitemap link arrays.
Darren Oh's avatar
Darren Oh committed
579
 */
580
function xmlsitemap_link_load_multiple(array $conditions = array()) {
581 582
  $query = db_select('xmlsitemap');
  $query->fields('xmlsitemap');
583

584 585 586
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
  }
587

588
  $links = $query->execute()->fetchAll(PDO::FETCH_ASSOC);
589

590 591 592
  return $links;
}

Darren Oh's avatar
Darren Oh committed
593
/**
594 595
 * Saves or updates a sitemap link.
 *
596
 * @param array $link
597
 *   An array with a sitemap link.
598 599 600 601 602
 * @param array $context
 *   An optional context array containing data related to the link.
 *
 * @return array
 *   The saved sitemap link.
Darren Oh's avatar
Darren Oh committed
603
 */
604
function xmlsitemap_link_save(array $link, array $context = array()) {
605 606
  $link += array(
    'access' => 1,
607
    'status' => 1,
608 609
    'status_override' => 0,
    'lastmod' => 0,
610
    'priority' => XMLSITEMAP_PRIORITY_DEFAULT,
611 612 613
    'priority_override' => 0,
    'changefreq' => 0,
    'changecount' => 0,
614
    'language' => LANGUAGE_NONE,
615 616 617
  );

  // Allow other modules to alter the link before saving.
618
  drupal_alter('xmlsitemap_link', $link, $context);
619 620 621 622

  // Temporary validation checks.
  // @todo Remove in final?
  if ($link['priority'] < 0 || $link['priority'] > 1) {
623 624 625 626
    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
627
  }
628
  if ($link['changecount'] < 0) {
629 630 631 632
    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);
633 634 635
    $link['changecount'] = 0;
  }

636
  $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();
637 638 639 640 641 642

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

643
  // Save the link and allow other modules to respond to the link being saved.
644
  if ($existing) {
645
    drupal_write_record('xmlsitemap', $link, array('type', 'id'));
646
    module_invoke_all('xmlsitemap_link_update', $link, $context);
647 648
  }
  else {
649
    drupal_write_record('xmlsitemap', $link);
650
    module_invoke_all('xmlsitemap_link_insert', $link, $context);
651 652 653
  }

  return $link;
Darren Oh's avatar
Darren Oh committed
654 655 656
}

/**
657 658 659 660 661
 * Perform a mass update of sitemap data.
 *
 * If visible links are updated, this will automatically set the regenerate
 * needed flag to TRUE.
 *
662
 * @param array $updates
663
 *   An array of values to update fields to, keyed by field name.
664
 * @param array $conditions
665
 *   An array of values to match keyed by field.
666 667
 *
 * @return int
668
 *   The number of links that were updated.
669 670
 *
 * @codingStandardsIgnoreStart
Darren Oh's avatar
Darren Oh committed
671
 */
672
function xmlsitemap_link_update_multiple($updates = array(), $conditions = array(), $check_flag = TRUE) {
673
  // @codingStandardsIgnoreEnd
674 675
  // If we are going to modify a visible sitemap link, we will need to set
  // the regenerate needed flag.
676
  if ($check_flag && !variable_get('xmlsitemap_regenerate_needed', FALSE)) {
677 678 679 680
    _xmlsitemap_check_changed_links($conditions, $updates, TRUE);
  }

  // Process updates.
681 682 683 684 685
  $query = db_update('xmlsitemap');
  $query->fields($updates);
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
  }
686

687
  return $query->execute();
Darren Oh's avatar
Darren Oh committed
688 689
}

690
/**
691
 * Delete a specific sitemap link from the database.
692 693 694 695
 *
 * If a visible sitemap link was deleted, this will automatically set the
 * regenerate needed flag.
 *
696
 * @param string $entity_type
697
 *   A string with the entity type.
698
 * @param int $entity_id
699
 *   An integer with the entity ID.
700 701
 *
 * @return int
702 703 704 705 706 707 708 709 710 711 712 713 714
 *   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.
 *
715
 * @param array $conditions
716 717
 *   An array of conditions on the {xmlsitemap} table in the form
 *   'field' => $value.
718 719
 *
 * @return int
720
 *   The number of links that were deleted.
721
 */
722
function xmlsitemap_link_delete_multiple(array $conditions) {
723 724 725
  // 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().
726
  // @todo Remove this check when http://drupal.org/node/151452 is fixed.
727 728 729 730
  if (!db_table_exists('xmlsitemap')) {
    return FALSE;
  }

731 732
  if (!variable_get('xmlsitemap_regenerate_needed', TRUE)) {
    _xmlsitemap_check_changed_links($conditions, array(), TRUE);
733
  }
734

735 736
  // @todo Add a hook_xmlsitemap_link_delete() hook invoked here.

737 738 739 740
  $query = db_delete('xmlsitemap');
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
  }
741

742
  return $query->execute();
743 744
}

Darren Oh's avatar
Darren Oh committed
745
/**
746
 * Check if there is a visible sitemap link given a certain set of conditions.
747
 *
748
 * @param array $conditions
749
 *   An array of values to match keyed by field.
750
 * @param string $flag
751 752
 *   An optional boolean that if TRUE, will set the regenerate needed flag if
 *   there is a match. Defaults to FALSE.
753 754
 *
 * @return bool
755
 *   TRUE if there is a visible link, or FALSE otherwise.
756
 */
757 758
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.
759 760
  $conditions['status'] = (!empty($updates['status']) && empty($conditions['status'])) ? 0 : 1;
  $conditions['access'] = (!empty($updates['access']) && empty($conditions['access'])) ? 0 : 1;
761

762 763 764 765
  $query = db_select('xmlsitemap');
  $query->addExpression('1');
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
766
  }
767 768
  $query->range(0, 1);
  $changed = $query->execute()->fetchField();
769

770 771
  if ($changed && $flag) {
    variable_set('xmlsitemap_regenerate_needed', TRUE);
Darren Oh's avatar
Darren Oh committed
772
  }
773

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

/**
778
 * Check if there is sitemap link is changed from the existing data.
779
 *
780
 * @param array $link
781
 *   An array of the sitemap link.
782
 * @param array $original_link
783 784 785
 *   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.
786
 * @param bool $flag
787 788
 *   An optional boolean that if TRUE, will set the regenerate needed flag if
 *   there is a match. Defaults to FALSE.
789 790
 *
 * @return bool
791
 *   TRUE if the link is changed, or FALSE otherwise.
792 793
 *
 * @codingStandardsIgnoreStart
Darren Oh's avatar
Darren Oh committed
794
 */
795
function _xmlsitemap_check_changed_link(array $link, $original_link = NULL, $flag = FALSE) {
796
  // @codingStandardsIgnoreEnd
797
  $changed = FALSE;
798

799 800 801 802
  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
803

804 805 806 807
  if (!$original_link) {
    if ($link['access'] && $link['status']) {
      // Adding a new visible link.
      $changed = TRUE;
Darren Oh's avatar
Darren Oh committed
808
    }
809
  }
810 811 812 813 814 815
  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)) {
816
      // Changing a visible link.
817
      $changed = TRUE;
Darren Oh's avatar
Darren Oh committed
818 819
    }
  }
820 821 822

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

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

/**
829
 * @} End of "defgroup xmlsitemap_api"
830
 */
831
function xmlsitemap_get_directory(stdClass $sitemap = NULL) {
832
  $directory = &drupal_static(__FUNCTION__);
833

834
  if (!isset($directory)) {
835
    $directory = variable_get('xmlsitemap_path', 'xmlsitemap');
Darren Oh's avatar
Darren Oh committed
836
  }
837

838 839
  if (!empty($sitemap->smid)) {
    return file_build_uri($directory . '/' . $sitemap->smid);
840 841 842 843
  }
  else {
    return file_build_uri($directory);
  }
Darren Oh's avatar
Darren Oh committed
844 845 846
}

/**
847
 * Check that the sitemap files directory exists and is writable.
Darren Oh's avatar
Darren Oh committed
848
 */
849
function xmlsitemap_check_directory(stdClass $sitemap = NULL) {
850 851 852 853 854 855 856 857
  $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;
}

858 859 860
/**
 * Check all directories.
 */
861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882
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;
}

883 884 885
/**
 * Clear Directory.
 */
886
function xmlsitemap_clear_directory(stdClass $sitemap = NULL, $delete = FALSE) {
887 888 889 890
  $directory = xmlsitemap_get_directory($sitemap);
  return _xmlsitemap_delete_recursive($directory, $delete);
}

891 892 893
/**
 * Move a directory to a new location.
 *
894
 * @param string $old_dir
895
 *   A string specifying the filepath or URI of the original directory.
896
 * @param string $new_dir
897
 *   A string specifying the filepath or URI of the new directory.
898
 * @param string $replace
899 900
 *   Replace behavior when the destination file already exists.
 *
901
 * @return bool
902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923
 *   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;
}

924 925 926 927 928 929 930
/**
 * 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.
 *
931
 * @param string $path
932
 *   A filepath relative to the Drupal root directory.
933
 * @param bool $delete_root
934 935 936 937 938 939 940 941 942 943 944 945 946 947 948
 *   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();
949
    return $delete_root ? drupal_rmdir($path) : TRUE;
950 951
  }
  return file_unmanaged_delete($path);
Darren Oh's avatar
Darren Oh committed
952 953 954
}

/**
955 956
 * Returns information about supported sitemap link types.
 *
957
 * @param string $type
958 959
 *   (optional) The link type to return information for. If omitted,
 *   information for all link types is returned.
960
 * @param bool $reset
961 962 963 964 965
 *   (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
966
 */
967
function xmlsitemap_get_link_info($type = NULL, $reset = FALSE) {
968
  global $language;
969
  $link_info = &drupal_static(__FUNCTION__);
970

971 972
  if ($reset) {
    $link_info = NULL;
973
    cache_clear_all('xmlsitemap:link_info:', 'cache', TRUE);
974 975
  }

976
  if (!isset($link_info)) {
977 978 979
    $cid = 'xmlsitemap:link_info:' . $language->language;
    if ($cache = cache_get($cid)) {
      $link_info = $cache->data;
980
    }
981 982 983 984 985 986 987 988 989 990 991
    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.
992
            // unset($link_info[$key]['bundles'][$bundle_key]);.
993 994
          }
        }
995
      }
996 997 998 999 1000 1001
      $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(),
1002 1003
          'xmlsitemap' => array(),
        );
1004 1005 1006 1007 1008 1009 1010 1011 1012
        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);
        }
1013
      }
1014 1015 1016 1017
      drupal_alter('xmlsitemap_link_info', $link_info);
      ksort($link_info);
      // Cache by language since this info contains translated strings.
      cache_set($cid, $link_info);
1018
    }
Darren Oh's avatar
Darren Oh committed
1019
  }
1020 1021 1022 1023 1024 1025

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

  return $link_info;
Darren Oh's avatar
Darren Oh committed
1026 1027
}

1028 1029 1030
/**
 * Enabled Bundles.
 */
1031 1032 1033 1034
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) {
1035
    $settings = xmlsitemap_link_bundle_load($entity_type, $bundle);
1036
    if (!empty($settings['status'])) {
1037
      // If (!empty($bundle_info['xmlsitemap']['status'])) {.
1038 1039 1040 1041 1042 1043
      $bundles[] = $bundle;
    }
  }
  return $bundles;
}

1044 1045 1046
/**
 * Indexed Status.
 */
1047 1048 1049
function xmlsitemap_get_link_type_indexed_status($entity_type, $bundle = '') {
  $info = xmlsitemap_get_link_info($entity_type);

1050 1051
  $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();
1052

1053 1054 1055 1056
  $total = new EntityFieldQuery();
  $total->entityCondition('entity_type', $entity_type);
  $total->entityCondition('bundle', $bundle);
  $total->entityCondition('entity_id', 0, '>');
1057
  // $total->addTag('xmlsitemap_link_bundle_access');.
1058
  $total->addTag('xmlsitemap_link_indexed_status');
1059 1060 1061
  $total->addMetaData('entity', $entity_type);
  $total->addMetaData('bundle', $bundle);
  $total->addMetaData('entity_info', $info);
1062 1063
  $total->count();
  $status['total'] = $total->execute();
1064 1065 1066

  return $status;
}
1067

1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081
/**
 * 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']);
  }
}

1082 1083 1084
/**
 * Budle Settings.
 */
1085 1086
function xmlsitemap_link_bundle_settings_save($entity, $bundle, array $settings, $update_links = TRUE) {
  if ($update_links) {
1087
    $old_settings = xmlsitemap_link_bundle_load($entity, $bundle);
1088
    if ($settings['status'] != $old_settings['status']) {
1089 1090 1091 1092 1093
      xmlsitemap_link_update_multiple(array('status' => $settings['status']), array(
        'type' => $entity,
        'subtype' => $bundle,
        'status_override' => 0,
      ));
1094 1095
    }
    if ($settings['priority'] != $old_settings['priority']) {
1096 1097 1098 1099 1100 1101 1102
      xmlsitemap_link_update_multiple(array(
        'priority' => $settings['priority'],
      ), array(
        'type' => $entity,
        'subtype' => $bundle,
        'priority_override' => 0,
      ));
1103 1104 1105 1106 1107
    }
  }

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