xmlsitemap.module 70 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
use Drupal\Core\Entity\Query\QueryInterface;
28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45

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

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

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

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

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

99 100 101
  return $hooks;
}

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

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

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

  return $output;
}

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

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

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

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

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

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

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

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

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

Darren Oh's avatar
Darren Oh committed
277 278
}

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

304
/**
305
 * Internal default variables for xmlsitemap_var().
306
 */
307 308
function xmlsitemap_variables() {
  return array(
309 310
    'rebuild_needed' => FALSE,
    'regenerate_needed' => FALSE,
311
    'minimum_lifetime' => 0,
312 313 314 315 316 317 318 319 320 321 322 323
    '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,
324
    // Removed variables are set to NULL so they can still be deleted.
325 326 327 328 329 330
    'regenerate_last' => NULL,
    'custom_links' => NULL,
    'priority_default' => NULL,
    'languages' => NULL,
    'max_chunks' => NULL,
    'max_filesize' => NULL,
331 332 333 334 335 336 337 338 339 340
  );
}

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

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

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

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

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

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

393 394 395 396 397 398 399 400
  $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');
   */
401 402 403 404 405 406
  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
407
  }
408

409
  return $sitemaps;
410 411 412
}

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

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

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

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

  return $sitemap;
468 469 470
}

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

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

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

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

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

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

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

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

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

589 590 591
  return $links;
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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 893
/**
 * 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;
}

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

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

941 942
  if ($reset) {
    $link_info = NULL;
943 944 945
    foreach (\Drupal::languageManager()->getLanguages() as $lang) {
      \Drupal::cache()->delete('xmlsitemap:link_info:' . $lang->getId());
    }
946 947
  }

948
  if (!isset($link_info)) {
949
    $cid = 'xmlsitemap:link_info:' . $language->getId();
950
    if ($cache = \Drupal::cache()->get($cid)) {
951
      $link_info = $cache->data;
952
    }
953
    else {
954
      \Drupal::entityManager()->clearCachedDefinitions();
955 956 957 958 959 960 961 962 963 964 965
      $link_info = array();
      $entity_types = \Drupal::entityManager()->getDefinitions();
      foreach ($entity_types as $key => $entity_type) {
        $link_info[$key] = array(
          'label' => $entity_type->getLabel(),
          'type' => $entity_type->id(),
          'base table' => $entity_type->getBaseTable(),
          'bundles' => \Drupal::entityManager()->getBundleInfo($entity_type->id())
        );
        $uri_callback = $entity_type->getUriCallback();
        if (empty($uri_callback) || !isset($entity_type->xmlsitemap)) {
966
          // Remove any non URL-able or XML sitemap un