xmlsitemap.module 66.9 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
 * @file
 * Main file for the xmlsitemap module.
 */
11
use Symfony\Component\HttpFoundation\Request;
12
use Drupal\Component\Utility\Crypt;
13
use Drupal\Core\Session\UserSession;
14
use Drupal\Core\Language\LanguageInterface;
15
use Drupal\xmlsitemap\XmlSitemapInterface;
16 17
use Drupal\user\Entity\User;
use Drupal\user\UserInterface;
18 19
use Drupal\Component\Utility\String;
use Drupal\Core\Render\Element;
20 21
use Drupal\Core\Entity\EntityFormBuilderInterface;
use Drupal\Core\Entity\EntityForm;
22 23
use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Entity\Entity;
24
use Drupal\Core\Session\AnonymousUserSession;
25
use Drupal\Core\Routing\RouteMatchInterface;
26
use Drupal\Core\Database\Query\AlterableInterface;
27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44

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

45 46 47 48 49 50 51 52 53 54 55 56 57 58 59
/**
 * 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');

60 61 62 63 64 65 66 67 68 69
/**
 * 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);

70 71 72 73
/**
 * Implements hook_hook_info().
 */
function xmlsitemap_hook_info() {
74 75 76 77 78 79 80
  $hooks = array(
    'xmlsitemap_link_info',
    'xmlsitemap_link_info_alter',
    'xmlsitemap_link_alter',
    'xmlsitemap_index_links',
    'xmlsitemap_context_info',
    'xmlsitemap_context_info_alter',
81
    'xmlsitemap_context_url_options',
82
    'xmlsitemap_context',
83 84
    'xmlsitemap_sitemap_insert',
    'xmlsitemap_sitemap_update',
85 86 87 88
    'xmlsitemap_sitemap_operations',
    'xmlsitemap_sitemap_delete',
    'xmlsitemap_sitemap_link_url_options_alter',
    'query_xmlsitemap_generate_alter',
89
    'query_xmlsitemap_link_bundle_access_alter',
90
    'form_xmlsitemap_sitemap_edit_form_alter',
91
  );
92 93 94 95 96

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

98 99 100
  return $hooks;
}

101 102
/**
 * Implements hook_help().
Darren Oh's avatar
Darren Oh committed
103
 */
104
function xmlsitemap_help($route_name, RouteMatchInterface $route_match) {
105 106
  $output = '';

107
  switch ($route_name) {
108
    case 'help.page.xmlsitemap':
109 110 111 112
    case 'xmlsitemap.admin_settings':
    case 'xmlsitemap.entities_settings':
    case 'xmlsitemap.admin_edit':
    case 'xmlsitemap.admin_delete':
113
      return;
114
    case 'xmlsitemap.admin_search':
115
      break;
116
    case 'xmlsitemap.admin_search_list':
117
      break;
118
    case 'xmlsitemap.admin_rebuild':
119 120 121
      $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>';
  }

122
  $currentUser = \Drupal::currentUser();
123
  if (strpos($route_name, 'xmlsitemap') !== FALSE && $currentUser->hasPermission('administer xmlsitemap')) {
124
    module_load_include('inc', 'xmlsitemap');
125 126
    // Alert the user to any potential problems detected by hook_requirements.
    xmlsitemap_check_status();
127
    $output .= _xmlsitemap_get_blurb();
Darren Oh's avatar
Darren Oh committed
128
  }
129 130 131 132 133 134 135

  return $output;
}

/**
 * Implements hook_perm().
 */
Dave Reid's avatar
Dave Reid committed
136
function xmlsitemap_permission() {
137 138
  $permissions['administer xmlsitemap'] = array(
    'title' => t('Administer XML sitemap settings.'),
Dave Reid's avatar
Dave Reid committed
139
  );
140
  return $permissions;
Darren Oh's avatar
Darren Oh committed
141 142 143
}

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

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

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

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

Darren Oh's avatar
Darren Oh committed
230 231 232
  return $items;
}

233 234 235 236 237 238 239 240 241 242 243 244
/**
 * Implements hook_theme().
 */
function xmlsitemap_theme() {
  return array(
    'xmlsitemap_content_settings_table' => array(
      'render element' => 'element',
      'file' => 'xmlsitemap.module',
    ),
  );
}

245 246 247 248 249 250 251 252 253
/**
 * 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
254
/**
255
 * Implements hook_cron().
256 257 258
 *
 * @todo Use new Queue system. Need to add {sitemap}.queued.
 * @todo Regenerate one at a time?
Darren Oh's avatar
Darren Oh committed
259
 */
260
function xmlsitemap_cron() {
261
  // If there were no new or changed links, skip.
262
  if (!\Drupal::config('xmlsitemap.settings')->get('regenerate_needed')) {
263 264 265
    return;
  }

266
  // If the minimum sitemap lifetime hasn't been passed, skip.
267 268
  $lifetime = REQUEST_TIME - \Drupal::config('xmlsitemap.settings')->get('generated_last');
  if ($lifetime < \Drupal::config('xmlsitemap.settings')->get('minimum_lifetine')) {
269 270
    return;
  }
271
  xmlsitemap_xmlsitemap_index_links(100);
272
  // Regenerate the sitemap XML files.
273
  module_load_include('generate.inc', 'xmlsitemap');
274
  xmlsitemap_run_unprogressive_batch('xmlsitemap_regenerate_batch');
275

Darren Oh's avatar
Darren Oh committed
276 277
}

278 279 280 281 282 283 284 285 286 287 288 289 290 291
/**
 * 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
292
/**
293
 * Implements hook_robotstxt().
Darren Oh's avatar
Darren Oh committed
294
 */
295
function xmlsitemap_robotstxt() {
296
  if ($sitemap = xmlsitemap_sitemap_load_by_context()) {
297 298
    $uri = xmlsitemap_sitemap_uri($sitemap);
    $robotstxt[] = 'Sitemap: ' . url($uri['path'], $uri['options']);
299
    return $robotstxt;
300
  }
Darren Oh's avatar
Darren Oh committed
301 302
}

303
/**
304
 * Internal default variables for xmlsitemap_var().
305
 */
306 307
function xmlsitemap_variables() {
  return array(
308 309 310 311 312 313 314 315 316 317 318 319 320 321 322
    'rebuild_needed' => FALSE,
    'regenerate_needed' => FALSE,
    'minimum_lifetine' => 0,
    'generated_last' => 0,
    'xsl' => 1,
    'prefetch_aliases' => 1,
    'chunk_size' => 'auto',
    'batch_limit' => 100,
    'path' => 'xmlsitemap',
    'base_url' => $GLOBALS['base_url'],
    'developer_mode' => 0,
    'frontpage_priority' => 1.0,
    'frontpage_changefreq' => XMLSITEMAP_FREQUENCY_DAILY,
    'lastmod_format' => XMLSITEMAP_LASTMOD_MEDIUM,
    'gz' => FALSE,
323
    // Removed variables are set to NULL so they can still be deleted.
324 325 326 327 328 329
    'regenerate_last' => NULL,
    'custom_links' => NULL,
    'priority_default' => NULL,
    'languages' => NULL,
    'max_chunks' => NULL,
    'max_filesize' => NULL,
330 331 332 333 334 335 336 337 338 339
  );
}

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

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

347
  return \Drupal::config('xmlsitemap.settings')->get($name);
348
  return variable_get($name, isset($default) || !isset($defaults[$name]) ? $default : $defaults[$name]);
349 350
}

Darren Oh's avatar
Darren Oh committed
351
/**
352
 * @defgroup xmlsitemap_api XML sitemap API.
353
 * @{
354 355
 * 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
356
 */
357 358 359 360 361 362

/**
 * Load an XML sitemap array from the database.
 *
 * @param $smid
 *   An XML sitemap ID.
363 364 365
 *
 * @return
 *   The XML sitemap object.
366 367 368 369
 */
function xmlsitemap_sitemap_load($smid) {
  $sitemap = xmlsitemap_sitemap_load_multiple(array($smid));
  return $sitemap ? reset($sitemap) : FALSE;
Darren Oh's avatar
Darren Oh committed
370 371 372
}

/**
373 374 375
 * Load multiple XML sitemaps from the database.
 *
 * @param $smids
376 377 378
 *   An array of XML sitemap IDs, or FALSE to load all XML sitemaps.
 * @param $conditions
 *   An array of conditions in the form 'field' => $value.
379 380 381
 *
 * @return
 *   An array of XML sitemap objects.
Darren Oh's avatar
Darren Oh committed
382
 */
383 384 385 386
function xmlsitemap_sitemap_load_multiple($smids = array(), array $conditions = array()) {
  if ($smids !== FALSE) {
    $conditions['smid'] = $smids;
  }
387
  else {
388
    $conditions['smid'] = NULL;
389
  }
390
  $storage = Drupal::entityManager()->getStorage('xmlsitemap');
391

392 393 394 395 396 397 398 399
  $sitemaps = $storage->loadMultiple($conditions['smid']);
  /* $query = db_select('xmlsitemap_sitemap');
    $query->fields('xmlsitemap_sitemap');
    foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
    }
    $sitemaps = $query->execute()->fetchAllAssoc('smid');
   */
400 401 402 403 404 405
  if (count($sitemaps) <= 0) {
    return array();
  }
  foreach ($sitemaps as &$sitemap) {
    $uri = xmlsitemap_sitemap_uri($sitemap);
    $sitemap->uri = $uri;
Darren Oh's avatar
Darren Oh committed
406
  }
407

408
  return $sitemaps;
409 410 411
}

/**
412
 * Load an XML sitemap array from the database based on its context.
413
 *
414 415
 * @param $context
 *   An optional XML sitemap context array to use to find the correct XML
416
 *   sitemap. If not provided, the current site's context will be used.
417
 *
418
 * @see xmlsitemap_get_current_context()
419
 */
420 421 422
function xmlsitemap_sitemap_load_by_context(array $context = NULL) {
  if (!isset($context)) {
    $context = xmlsitemap_get_current_context();
Darren Oh's avatar
Darren Oh committed
423
  }
424 425
  $sitemaps = \Drupal::entityManager()->getStorage('xmlsitemap')->loadMultiple();
  foreach ($sitemaps as $sitemap) {
426
    if ($sitemap->context == $context) {
427 428 429 430
      return $sitemap;
    }
  }
  return NULL;
Darren Oh's avatar
Darren Oh committed
431 432 433
}

/**
434
 * Save changes to an XML sitemap or add a new XML sitemap.
435
 *
436
 * @param $sitemap
437
 *   The XML sitemap array to be saved. If $sitemap->smid is omitted, a new
438 439 440
 *   XML sitemap will be added.
 *
 * @todo Save the sitemap's URL as a column?
Darren Oh's avatar
Darren Oh committed
441
 */
442
function xmlsitemap_sitemap_save(XmlSitemapInterface $sitemap) {
443
  $context = $sitemap->context;
444
  if (!isset($context) || !$context) {
445
    $sitemap->context = array();
446 447
  }

448
  // Make sure context is sorted before saving the hash.
449 450
  //$sitemap->is_new = empty($sitemap->getId());
  //$sitemap->old_smid = $sitemap->is_new ? NULL : $sitemap->smid;
451
  $sitemap->setOriginalId($sitemap->isNew() ? NULL : $sitemap->getId());
452
  $sitemap->setId(xmlsitemap_sitemap_get_context_hash($context));
453
  // If the context was changed, we need to perform additional actions.
454
  if (!$sitemap->isNew() && $sitemap->getId() != $sitemap->getOriginalId()) {
455
    // Rename the files directory so the sitemap does not break.
456
    $old_sitemap = (object) array('smid' => $sitemap->old_smid);
457
    $old_dir = xmlsitemap_get_directory($old_sitemap);
458 459 460 461
    $new_dir = xmlsitemap_get_directory($sitemap);
    xmlsitemap_directory_move($old_dir, $new_dir);

    // Mark the sitemaps as needing regeneration.
462
    \Drupal::config('xmlsitemap.settings')->set('regenerate_needed', TRUE)->save();
463
  }
464
  $sitemap->save();
465 466

  return $sitemap;
467 468 469
}

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

Darren Oh's avatar
Darren Oh committed
479
/**
480
 * Delete multiple XML sitemaps.
481
 *
482 483
 * @param $smids
 *   An array of XML sitemap IDs.
Darren Oh's avatar
Darren Oh committed
484
 */
485 486 487
function xmlsitemap_sitemap_delete_multiple(array $smids) {
  if (!empty($smids)) {
    $sitemaps = xmlsitemap_sitemap_load_multiple($smids);
488 489 490 491 492
    /*
      db_delete('xmlsitemap_sitemap')
      ->condition('smid', $smids)
      ->execute();
     */
493 494
    foreach ($sitemaps as $sitemap) {
      xmlsitemap_clear_directory($sitemap, TRUE);
495
      $sitemap->delete();
496
      \Drupal::moduleHandler()->invokeAll('xmlsitemap_sitemap_delete', array($sitemap));
497
    }
498
  }
499
}
500

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

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

528 529
function xmlsitemap_sitemap_get_context_hash(array &$context) {
  asort($context);
530
  return Crypt::hashBase64(serialize($context));
531 532
}

Darren Oh's avatar
Darren Oh committed
533
/**
534
 * Returns the uri elements of an XML sitemap.
535
 *
536 537
 * @param \Drupal\xmlsitemap\XmlSitemapInterface $sitemap
 *   The sitemap represented by and XmlSitemapInterface object.
538
 * @return
539 540
 *   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
541
 */
542
function xmlsitemap_sitemap_uri(XmlSitemapInterface $sitemap) {
543
  $uri['path'] = 'sitemap.xml';
544 545
  $uri['options'] = \Drupal::moduleHandler()->invokeAll('xmlsitemap_context_url_options', array($sitemap->context));
  $context = $sitemap->context;
546
  \Drupal::moduleHandler()->alter('xmlsitemap_context_url_options', $uri['options'], $context);
547 548
  $uri['options'] += array(
    'absolute' => TRUE,
549
    'base_url' => \Drupal::state()->get('base_url')
550 551 552
  );
  return $uri;
}
553

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

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

586
  $links = $query->execute()->fetchAll(PDO::FETCH_ASSOC);
587

588 589 590
  return $links;
}

Darren Oh's avatar
Darren Oh committed
591
/**
592 593 594 595
 * Saves or updates a sitemap link.
 *
 * @param $link
 *   An array with a sitemap link.
Darren Oh's avatar
Darren Oh committed
596
 */
597
function xmlsitemap_link_save(array $link) {
598 599
  $link += array(
    'access' => 1,
Dave Reid's avatar
Dave Reid committed
600
    'status' => 1,
601 602
    'status_override' => 0,
    'lastmod' => 0,
603
    'priority' => XMLSITEMAP_PRIORITY_DEFAULT,
604 605 606
    'priority_override' => 0,
    'changefreq' => 0,
    'changecount' => 0,
607
    'language' => LanguageInterface::LANGCODE_NOT_SPECIFIED,
608 609 610 611 612 613 614 615 616
  );

  // 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
617
  }
618 619 620 621 622
  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;
  }

623
  $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();
624 625

  // Check if this is a changed link and set the regenerate flag if necessary.
626
  if (!\Drupal::config('xmlsitemap.settings')->get('regenerate_needed')) {
627 628 629
    _xmlsitemap_check_changed_link($link, $existing, TRUE);
  }

630
  // Save the link and allow other modules to respond to the link being saved.
631
  if ($existing) {
632
    drupal_write_record('xmlsitemap', $link, array('type', 'id'));
633
    \Drupal::moduleHandler()->invokeAll('xmlsitemap_link_update', array($link));
634 635
  }
  else {
636
    $result = drupal_write_record('xmlsitemap', $link);
637
    \Drupal::moduleHandler()->invokeAll('xmlsitemap_link_insert', array($link));
638 639 640
  }

  return $link;
Darren Oh's avatar
Darren Oh committed
641 642 643
}

/**
644 645 646 647 648 649 650 651 652 653 654
 * 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
655
 */
656
function xmlsitemap_link_update_multiple($updates = array(), $conditions = array(), $check_flag = TRUE) {
657 658
  // If we are going to modify a visible sitemap link, we will need to set
  // the regenerate needed flag.
659
  if ($check_flag && !\Drupal::config('xmlsitemap.settings')->get('regenerate_needed')) {
660 661 662 663
    _xmlsitemap_check_changed_links($conditions, $updates, TRUE);
  }

  // Process updates.
664 665 666 667 668
  $query = db_update('xmlsitemap');
  $query->fields($updates);
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
  }
669

670
  return $query->execute();
Darren Oh's avatar
Darren Oh committed
671 672
}

673
/**
674
 * Delete a specific sitemap link from the database.
675 676 677 678
 *
 * If a visible sitemap link was deleted, this will automatically set the
 * regenerate needed flag.
 *
679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696
 * @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.
 *
697
 * @param $conditions
698 699
 *   An array of conditions on the {xmlsitemap} table in the form
 *   'field' => $value.
700 701
 * @return
 *   The number of links that were deleted.
702
 */
703
function xmlsitemap_link_delete_multiple(array $conditions) {
704 705 706
  // 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().
707
  // @todo Remove this check when http://drupal.org/node/151452 is fixed.
708 709 710 711
  if (!db_table_exists('xmlsitemap')) {
    return FALSE;
  }

712
  if (!\Drupal::config('xmlsitemap.settings')->get('regenerate_needed')) {
713
    _xmlsitemap_check_changed_links($conditions, array(), TRUE);
714
  }
715

716 717
  // @todo Add a hook_xmlsitemap_link_delete() hook invoked here.

718 719 720 721
  $query = db_delete('xmlsitemap');
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
  }
722

723
  return $query->execute();
724 725
}

Darren Oh's avatar
Darren Oh committed
726
/**
727
 * Check if there is a visible sitemap link given a certain set of conditions.
728
 *
729 730 731 732 733 734 735
 * @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.
736
 */
737 738
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.
739 740
  $conditions['status'] = (!empty($updates['status']) && empty($conditions['status'])) ? 0 : 1;
  $conditions['access'] = (!empty($updates['access']) && empty($conditions['access'])) ? 0 : 1;
741

742 743 744 745
  $query = db_select('xmlsitemap');
  $query->addExpression('1');
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
746
  }
747 748
  $query->range(0, 1);
  $changed = $query->execute()->fetchField();
749

750
  if ($changed && $flag) {
751
    \Drupal::config('xmlsitemap.settings')->set('regenerate_needed', TRUE)->save();
Darren Oh's avatar
Darren Oh committed
752
  }
753

754
  return $changed;
Darren Oh's avatar
Darren Oh committed
755 756 757
}

/**
758
 * Check if there is sitemap link is changed from the existing data.
759
 *
760 761 762 763 764 765 766 767 768 769 770
 * @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
771
 */
772 773
function _xmlsitemap_check_changed_link(array $link, $original_link = NULL, $flag = FALSE) {
  $changed = FALSE;
774

775 776 777 778
  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
779

780 781 782 783
  if (!$original_link) {
    if ($link['access'] && $link['status']) {
      // Adding a new visible link.
      $changed = TRUE;
Darren Oh's avatar
Darren Oh committed
784
    }
785
  }
786 787 788 789 790 791 792 793
  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
794 795
    }
  }
796 797

  if ($changed && $flag) {
798
    \Drupal::config('xmlsitemap.settings')->set('regenerate_needed', TRUE)->save();
799 800
  }

801
  return $changed;
Darren Oh's avatar
Darren Oh committed
802 803 804
}

/**
805
 * @} End of "defgroup xmlsitemap_api"
806
 */
807
function xmlsitemap_get_directory(XmlSitemapInterface $sitemap = NULL) {
808 809
  $directory = &drupal_static(__FUNCTION__);
  if (!isset($directory)) {
810
    $directory = \Drupal::config('xmlsitemap.settings')->get('path');
Darren Oh's avatar
Darren Oh committed
811
  }
812

813
  if ($sitemap != NULL && !empty($sitemap->id)) {
814
    return file_build_uri($directory . '/' . $sitemap->id);
815 816 817 818
  }
  else {
    return file_build_uri($directory);
  }
Darren Oh's avatar
Darren Oh committed
819 820 821
}

/**
822
 * Check that the sitemap files directory exists and is writable.
Darren Oh's avatar
Darren Oh committed
823
 */
824
function xmlsitemap_check_directory(XmlSitemapInterface $sitemap = NULL) {
825 826 827 828 829 830 831 832
  $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;
}

833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854
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;
}

855
function xmlsitemap_clear_directory(XmlSitemapInterface $sitemap = NULL, $delete = FALSE) {
856 857 858 859
  $directory = xmlsitemap_get_directory($sitemap);
  return _xmlsitemap_delete_recursive($directory, $delete);
}

860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892
/**
 * 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;
}

893 894 895 896 897 898 899 900
/**
 * 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
901
 *   A filepath relative to the Drupal root directory.
902 903 904 905 906 907 908 909 910 911 912 913 914
 * @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;
915
      file_unmanaged_delete_recursive($entry_path, NULL);
916 917
    }
    $dir->close();
918
    return $delete_root ? drupal_rmdir($path) : TRUE;
919 920
  }
  return file_unmanaged_delete($path);
Darren Oh's avatar
Darren Oh committed
921 922 923
}

/**
924 925 926 927 928 929 930 931 932 933 934
 * 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
935
 */
936
function xmlsitemap_get_link_info($type = NULL, $reset = FALSE) {
937
  $language = \Drupal::languageManager()->getCurrentLanguage();
938
  $link_info = &drupal_static(__FUNCTION__);
939

940 941
  if ($reset) {
    $link_info = NULL;
942