xmlsitemap.module 55.4 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 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39

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

40 41 42 43 44 45 46 47 48 49 50 51 52 53 54
/**
 * 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');

55 56 57 58 59 60 61 62 63 64
/**
 * 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);

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

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

93 94 95
  return $hooks;
}

96 97
/**
 * Implements hook_help().
Darren Oh's avatar
Darren Oh committed
98
 */
99
function xmlsitemap_help($path, Request $request) {
100 101
  $output = '';

102
  switch ($path) {
103
    case 'help.page.xmlsitemap':
104
    case 'admin/config/search/xmlsitemap/settings/%/%/%':
Dave Reid's avatar
Dave Reid committed
105 106
    case 'admin/config/search/xmlsitemap/edit/%':
    case 'admin/config/search/xmlsitemap/delete/%':
107
      return;
108 109
    case 'admin/help#xmlsitemap':
      break;
110
    case 'admin/config/search/xmlsitemap':
111
      break;
112
    case 'admin/config/search/xmlsitemap/rebuild':
113 114 115
      $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>';
  }

116 117
  $currentUser = \Drupal::currentUser();
  if (arg(0) == 'admin' && strpos($path, 'xmlsitemap') !== FALSE && $currentUser->hasPermission('administer xmlsitemap')) {
118
    module_load_include('inc', 'xmlsitemap');
119 120
    // Alert the user to any potential problems detected by hook_requirements.
    xmlsitemap_check_status();
121
    $output .= _xmlsitemap_get_blurb();
Darren Oh's avatar
Darren Oh committed
122
  }
123 124 125 126 127 128 129

  return $output;
}

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

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

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

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

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

Darren Oh's avatar
Darren Oh committed
224 225 226
  return $items;
}

227 228 229 230 231 232 233 234 235 236 237 238
/**
 * Implements hook_theme().
 */
function xmlsitemap_theme() {
  return array(
    'xmlsitemap_content_settings_table' => array(
      'render element' => 'element',
      'file' => 'xmlsitemap.module',
    ),
  );
}

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

260
  // If the minimum sitemap lifetime hasn't been passed, skip.
261 262
  $lifetime = REQUEST_TIME - \Drupal::config('xmlsitemap.settings')->get('generated_last');
  if ($lifetime < \Drupal::config('xmlsitemap.settings')->get('minimum_lifetine')) {
263 264
    return;
  }
265 266 267
  if (\Drupal::state()->get('xmlsitemap_entity_user')) {
    xmlsitemap_xmlsitemap_index_links(xmlsitemap_var('batch_limit'));
  }
268 269

  // Regenerate the sitemap XML files.
270
  module_load_include('generate.inc', 'xmlsitemap');
271
  xmlsitemap_run_unprogressive_batch('xmlsitemap_regenerate_batch');
Darren Oh's avatar
Darren Oh committed
272 273
}

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

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

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

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

342
  return \Drupal::config('xmlsitemap.settings')->get($name);
343
  return variable_get($name, isset($default) || !isset($defaults[$name]) ? $default : $defaults[$name]);
344 345
}

Darren Oh's avatar
Darren Oh committed
346
/**
347
 * @defgroup xmlsitemap_api XML sitemap API.
348
 * @{
349 350
 * 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
351
 */
352 353 354 355 356 357

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

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

387 388 389 390 391 392 393 394
  $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');
   */
395 396 397 398
  if (count($sitemaps) <= 0) {
    return array();
  }
  foreach ($sitemaps as &$sitemap) {
399
    $sitemap->setContext($sitemap->getContext());
400 401
    $uri = xmlsitemap_sitemap_uri($sitemap);
    $sitemap->uri = $uri;
Darren Oh's avatar
Darren Oh committed
402
  }
403

404
  return $sitemaps;
405 406 407
}

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

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

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

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

  return $sitemap;
465 466 467
}

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

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

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

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

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

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

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

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

584
  $links = $query->execute()->fetchAll(PDO::FETCH_ASSOC);
585

586 587 588
  return $links;
}

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

  // 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
615
  }
616 617 618 619 620
  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;
  }

621
  $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();
622 623

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

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

  return $link;
Darren Oh's avatar
Darren Oh committed
639 640 641
}

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

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

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

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

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

714 715
  // @todo Add a hook_xmlsitemap_link_delete() hook invoked here.

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

721
  return $query->execute();
722 723
}

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

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

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

752
  return $changed;
Darren Oh's avatar
Darren Oh committed
753 754 755
}

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

773 774 775 776
  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
777

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

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

799
  return $changed;
Darren Oh's avatar
Darren Oh committed
800 801 802
}

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

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

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

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

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

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

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

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

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

945
  if (!isset($link_info)) {
946
    $cid = 'xmlsitemap:link_info:' . $language->getId();
947
    if ($cache = \Drupal::cache()->get($cid)) {
948
      $link_info = $cache->data;
949
    }
950
    else {
951
      \Drupal::entityManager()->clearCachedDefinitions();
952 953 954 955 956 957 958 959 960 961 962
      $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)) {
963
          // Remove any non URL-able or XML sitemap un-supported entites.
964
          unset($entity_types[$key]);
965 966
          unset($link_info[$key]);
        }
967
        foreach (\Drupal::entityManager()->getBundleInfo($entity_type->id()) as $bundle_key => $bundle) {
968 969 970 971 972
          if (!isset($bundle['xmlsitemap'])) {
            // Remove any un-supported entity bundles.
            //unset($link_info[$key]['bundles'][$bundle_key]);
          }
        }
973 974
        unset($entity_types[$key]);
        unset($link_info[$key]);
975
      }
976
      $link_info