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');
Darren Oh's avatar
Darren Oh committed
275 276
}

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

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

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

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

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

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

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

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

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

406
  return $sitemaps;
407 408 409
}

/**
410
 * Load an XML sitemap array from the database based on its context.
411
 *
412 413
 * @param $context
 *   An optional XML sitemap context array to use to find the correct XML
414
 *   sitemap. If not provided, the current site's context will be used.
415
 *
416
 * @see xmlsitemap_get_current_context()
417
 */
418 419 420
function xmlsitemap_sitemap_load_by_context(array $context = NULL) {
  if (!isset($context)) {
    $context = xmlsitemap_get_current_context();
Darren Oh's avatar
Darren Oh committed
421
  }
422 423
  $sitemaps = \Drupal::entityManager()->getStorage('xmlsitemap')->loadMultiple();
  foreach ($sitemaps as $sitemap) {
424
    if ($sitemap->context == $context) {
425 426 427 428
      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 451
  $context = $sitemap->getContext();
  $sitemap->setId(xmlsitemap_sitemap_get_context_hash($context));
452
  // If the context was changed, we need to perform additional actions.
453
  if (!$sitemap->isNew() && $sitemap->getId() != $sitemap->getOriginalId()) {
454
    // Rename the files directory so the sitemap does not break.
455
    $old_sitemap = (object) array('smid' => $sitemap->old_smid);
456
    $old_dir = xmlsitemap_get_directory($old_sitemap);
457 458 459 460
    $new_dir = xmlsitemap_get_directory($sitemap);
    xmlsitemap_directory_move($old_dir, $new_dir);

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

  return $sitemap;
466 467 468
}

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

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

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

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

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

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

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

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

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

587 588 589
  return $links;
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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