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
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 146 147 148 149 150 151 152 153 154 155
/**
 * Implements hook_theme().
 */
function xmlsitemap_theme() {
  return array(
    'xmlsitemap_content_settings_table' => array(
      'render element' => 'element',
      'file' => 'xmlsitemap.module',
    ),
  );
}

156 157 158 159 160 161
/**
 * 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();
162
  return !empty($rebuild_types) && \Drupal::currentUser()->hasPermission('administer xmlsitemap');
163 164
}

Darren Oh's avatar
Darren Oh committed
165
/**
166
 * Implements hook_cron().
167 168 169
 *
 * @todo Use new Queue system. Need to add {sitemap}.queued.
 * @todo Regenerate one at a time?
Darren Oh's avatar
Darren Oh committed
170
 */
171
function xmlsitemap_cron() {
172
  // If there were no new or changed links, skip.
173
  if (!\Drupal::config('xmlsitemap.settings')->get('regenerate_needed')) {
174 175 176
    return;
  }

177
  // If the minimum sitemap lifetime hasn't been passed, skip.
178
  $lifetime = REQUEST_TIME - \Drupal::config('xmlsitemap.settings')->get('generated_last');
179
  if ($lifetime < \Drupal::config('xmlsitemap.settings')->get('minimum_lifetime')) {
180 181
    return;
  }
182
  xmlsitemap_xmlsitemap_index_links(\Drupal::config('xmlsitemap.settings')->get('batch_limit'));
183
  // Regenerate the sitemap XML files.
184
  module_load_include('generate.inc', 'xmlsitemap');
185
  xmlsitemap_run_unprogressive_batch('xmlsitemap_regenerate_batch');
Darren Oh's avatar
Darren Oh committed
186 187
}

188 189 190 191 192 193 194 195 196 197 198 199 200 201
/**
 * 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
202
/**
203
 * Implements hook_robotstxt().
Darren Oh's avatar
Darren Oh committed
204
 */
205
function xmlsitemap_robotstxt() {
206
  if ($sitemap = xmlsitemap_sitemap_load_by_context()) {
207 208
    $uri = xmlsitemap_sitemap_uri($sitemap);
    $robotstxt[] = 'Sitemap: ' . url($uri['path'], $uri['options']);
209
    return $robotstxt;
210
  }
Darren Oh's avatar
Darren Oh committed
211 212
}

213
/**
214
 * Internal default variables for xmlsitemap_var().
215
 */
216 217
function xmlsitemap_variables() {
  return array(
218 219
    'rebuild_needed' => FALSE,
    'regenerate_needed' => FALSE,
220
    'minimum_lifetime' => 0,
221 222 223 224 225 226 227 228 229 230 231 232
    '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,
233
    // Removed variables are set to NULL so they can still be deleted.
234 235 236 237 238 239
    'regenerate_last' => NULL,
    'custom_links' => NULL,
    'priority_default' => NULL,
    'languages' => NULL,
    'max_chunks' => NULL,
    'max_filesize' => NULL,
240 241 242 243 244 245 246 247 248 249
  );
}

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

252 253 254
  // @todo Remove when stable.
  if (!isset($defaults[$name])) {
    trigger_error(strtr('Default variable for %variable not found.', array('%variable' => drupal_placeholder($name))));
255 256
  }

257
  return \Drupal::config('xmlsitemap.settings')->get($name);
258 259
}

Darren Oh's avatar
Darren Oh committed
260
/**
261
 * @defgroup xmlsitemap_api XML sitemap API.
262
 * @{
263 264
 * 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
265
 */
266 267 268 269 270 271

/**
 * Load an XML sitemap array from the database.
 *
 * @param $smid
 *   An XML sitemap ID.
272 273 274
 *
 * @return
 *   The XML sitemap object.
275 276 277 278
 */
function xmlsitemap_sitemap_load($smid) {
  $sitemap = xmlsitemap_sitemap_load_multiple(array($smid));
  return $sitemap ? reset($sitemap) : FALSE;
Darren Oh's avatar
Darren Oh committed
279 280 281
}

/**
282 283 284
 * Load multiple XML sitemaps from the database.
 *
 * @param $smids
285 286 287
 *   An array of XML sitemap IDs, or FALSE to load all XML sitemaps.
 * @param $conditions
 *   An array of conditions in the form 'field' => $value.
288 289 290
 *
 * @return
 *   An array of XML sitemap objects.
Darren Oh's avatar
Darren Oh committed
291
 */
292 293 294 295
function xmlsitemap_sitemap_load_multiple($smids = array(), array $conditions = array()) {
  if ($smids !== FALSE) {
    $conditions['smid'] = $smids;
  }
296
  else {
297
    $conditions['smid'] = NULL;
298
  }
299
  $storage = Drupal::entityManager()->getStorage('xmlsitemap');
300

301
  $sitemaps = $storage->loadMultiple($conditions['smid']);
302 303 304 305 306 307
  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
308
  }
309

310
  return $sitemaps;
311 312 313
}

/**
314
 * Load an XML sitemap array from the database based on its context.
315
 *
316 317
 * @param $context
 *   An optional XML sitemap context array to use to find the correct XML
318
 *   sitemap. If not provided, the current site's context will be used.
319
 *
320
 * @see xmlsitemap_get_current_context()
321
 */
322 323 324
function xmlsitemap_sitemap_load_by_context(array $context = NULL) {
  if (!isset($context)) {
    $context = xmlsitemap_get_current_context();
Darren Oh's avatar
Darren Oh committed
325
  }
326 327
  $sitemaps = \Drupal::entityManager()->getStorage('xmlsitemap')->loadMultiple();
  foreach ($sitemaps as $sitemap) {
328
    if ($sitemap->context == $context) {
329 330 331 332
      return $sitemap;
    }
  }
  return NULL;
Darren Oh's avatar
Darren Oh committed
333 334 335
}

/**
336
 * Save changes to an XML sitemap or add a new XML sitemap.
337
 *
338
 * @param $sitemap
339
 *   The XML sitemap array to be saved. If $sitemap->smid is omitted, a new
340 341 342
 *   XML sitemap will be added.
 *
 * @todo Save the sitemap's URL as a column?
Darren Oh's avatar
Darren Oh committed
343
 */
344
function xmlsitemap_sitemap_save(XmlSitemapInterface $sitemap) {
345
  $context = $sitemap->context;
346
  if (!isset($context) || !$context) {
347
    $sitemap->context = array();
348 349
  }

350
  // Make sure context is sorted before saving the hash.
351 352
  //$sitemap->is_new = empty($sitemap->getId());
  //$sitemap->old_smid = $sitemap->is_new ? NULL : $sitemap->smid;
353
  $sitemap->setOriginalId($sitemap->isNew() ? NULL : $sitemap->getId());
354
  $sitemap->setId(xmlsitemap_sitemap_get_context_hash($context));
355
  // If the context was changed, we need to perform additional actions.
356
  if (!$sitemap->isNew() && $sitemap->getId() != $sitemap->getOriginalId()) {
357
    // Rename the files directory so the sitemap does not break.
358
    $old_sitemap = (object) array('smid' => $sitemap->old_smid);
359
    $old_dir = xmlsitemap_get_directory($old_sitemap);
360 361 362 363
    $new_dir = xmlsitemap_get_directory($sitemap);
    xmlsitemap_directory_move($old_dir, $new_dir);

    // Mark the sitemaps as needing regeneration.
364
    \Drupal::config('xmlsitemap.settings')->set('regenerate_needed', TRUE)->save();
365
  }
366
  $sitemap->save();
367 368

  return $sitemap;
369 370 371
}

/**
372
 * Delete an XML sitemap.
373
 *
374 375
 * @param $smid
 *   An XML sitemap ID.
376
 */
377 378
function xmlsitemap_sitemap_delete($smid) {
  xmlsitemap_sitemap_delete_multiple(array($smid));
379 380
}

Darren Oh's avatar
Darren Oh committed
381
/**
382
 * Delete multiple XML sitemaps.
383
 *
384 385
 * @param $smids
 *   An array of XML sitemap IDs.
Darren Oh's avatar
Darren Oh committed
386
 */
387 388 389 390 391
function xmlsitemap_sitemap_delete_multiple(array $smids) {
  if (!empty($smids)) {
    $sitemaps = xmlsitemap_sitemap_load_multiple($smids);
    foreach ($sitemaps as $sitemap) {
      xmlsitemap_clear_directory($sitemap, TRUE);
392
      $sitemap->delete();
393
      \Drupal::moduleHandler()->invokeAll('xmlsitemap_sitemap_delete', array($sitemap));
394
    }
395
  }
396
}
397

398 399 400 401
/**
 * Return the expected file path for a specific sitemap chunk.
 *
 * @param $sitemap
402
 *   An XmlSitemapInterface sitemap object.
403 404 405
 * @param $chunk
 *   An optional specific chunk in the sitemap. Defaults to the index page.
 */
406
function xmlsitemap_sitemap_get_file(XmlSitemapInterface $sitemap, $chunk = 'index') {
407
  return xmlsitemap_get_directory($sitemap) . "/{$chunk}.xml";
Darren Oh's avatar
Darren Oh committed
408 409
}

410 411 412 413 414 415
/**
 * Find the maximum file size of all a sitemap's XML files.
 *
 * @param $sitemap
 *   The XML sitemap array.
 */
416
function xmlsitemap_sitemap_get_max_filesize(XmlSitemapInterface $sitemap) {
417
  $dir = xmlsitemap_get_directory($sitemap);
418
  $sitemap->setMaxFileSize(0);
419
  foreach (file_scan_directory($dir, '/\.xml$/') as $file) {
420
    $sitemap->setMaxFileSize(max($sitemap->getMaxFileSize(), filesize($file->uri)));
421
  }
422
  return $sitemap->getMaxFileSize();
423 424
}

425 426
function xmlsitemap_sitemap_get_context_hash(array &$context) {
  asort($context);
427
  return Crypt::hashBase64(serialize($context));
428 429
}

Darren Oh's avatar
Darren Oh committed
430
/**
431
 * Returns the uri elements of an XML sitemap.
432
 *
433 434
 * @param \Drupal\xmlsitemap\XmlSitemapInterface $sitemap
 *   The sitemap represented by and XmlSitemapInterface object.
435
 * @return
436 437
 *   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
438
 */
439
function xmlsitemap_sitemap_uri(XmlSitemapInterface $sitemap) {
440
  $uri['path'] = 'sitemap.xml';
441 442
  $uri['options'] = \Drupal::moduleHandler()->invokeAll('xmlsitemap_context_url_options', array($sitemap->context));
  $context = $sitemap->context;
443
  \Drupal::moduleHandler()->alter('xmlsitemap_context_url_options', $uri['options'], $context);
444 445
  $uri['options'] += array(
    'absolute' => TRUE,
446
    'base_url' => \Drupal::state()->get('base_url')
447 448 449
  );
  return $uri;
}
450

451 452 453 454 455 456 457 458 459 460 461 462 463 464 465
/**
 * 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
466
/**
467
 * Load sitemap links from the database.
468 469
 *
 * @param $conditions
470 471
 *   An array of conditions on the {xmlsitemap} table in the form
 *   'field' => $value.
472
 * @return
473
 *   An array of sitemap link arrays.
Darren Oh's avatar
Darren Oh committed
474
 */
475
function xmlsitemap_link_load_multiple(array $conditions = array()) {
476 477
  $query = db_select('xmlsitemap');
  $query->fields('xmlsitemap');
478

479 480 481
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
  }
482

483
  $links = $query->execute()->fetchAll(PDO::FETCH_ASSOC);
484

485 486 487
  return $links;
}

Darren Oh's avatar
Darren Oh committed
488
/**
489 490 491 492
 * Saves or updates a sitemap link.
 *
 * @param $link
 *   An array with a sitemap link.
Darren Oh's avatar
Darren Oh committed
493
 */
494
function xmlsitemap_link_save(array $link) {
495 496
  $link += array(
    'access' => 1,
Dave Reid's avatar
Dave Reid committed
497
    'status' => 1,
498 499
    'status_override' => 0,
    'lastmod' => 0,
500
    'priority' => XMLSITEMAP_PRIORITY_DEFAULT,
501 502 503
    'priority_override' => 0,
    'changefreq' => 0,
    'changecount' => 0,
504
    'language' => LanguageInterface::LANGCODE_NOT_SPECIFIED,
505 506 507
  );

  // Allow other modules to alter the link before saving.
508
  \Drupal::moduleHandler()->alter('xmlsitemap_link', $link);
509 510 511 512 513

  // 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
514
  }
515 516 517 518 519
  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;
  }

520
  $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();
521 522

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

527
  // Save the link and allow other modules to respond to the link being saved.
528
  if ($existing) {
529
    drupal_write_record('xmlsitemap', $link, array('type', 'id'));
530
    \Drupal::moduleHandler()->invokeAll('xmlsitemap_link_update', array($link));
531 532
  }
  else {
533
    $result = drupal_write_record('xmlsitemap', $link);
534
    \Drupal::moduleHandler()->invokeAll('xmlsitemap_link_insert', array($link));
535 536 537
  }

  return $link;
Darren Oh's avatar
Darren Oh committed
538 539 540
}

/**
541 542 543 544 545 546 547 548 549 550 551
 * 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
552
 */
553
function xmlsitemap_link_update_multiple($updates = array(), $conditions = array(), $check_flag = TRUE) {
554 555
  // If we are going to modify a visible sitemap link, we will need to set
  // the regenerate needed flag.
556
  if ($check_flag && !\Drupal::config('xmlsitemap.settings')->get('regenerate_needed')) {
557 558 559 560
    _xmlsitemap_check_changed_links($conditions, $updates, TRUE);
  }

  // Process updates.
561 562 563 564 565
  $query = db_update('xmlsitemap');
  $query->fields($updates);
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
  }
566

567
  return $query->execute();
Darren Oh's avatar
Darren Oh committed
568 569
}

570
/**
571
 * Delete a specific sitemap link from the database.
572 573 574 575
 *
 * If a visible sitemap link was deleted, this will automatically set the
 * regenerate needed flag.
 *
576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593
 * @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.
 *
594
 * @param $conditions
595 596
 *   An array of conditions on the {xmlsitemap} table in the form
 *   'field' => $value.
597 598
 * @return
 *   The number of links that were deleted.
599
 */
600
function xmlsitemap_link_delete_multiple(array $conditions) {
601 602 603
  // 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().
604
  // @todo Remove this check when http://drupal.org/node/151452 is fixed.
605 606 607 608
  if (!db_table_exists('xmlsitemap')) {
    return FALSE;
  }

609
  if (!\Drupal::config('xmlsitemap.settings')->get('regenerate_needed')) {
610
    _xmlsitemap_check_changed_links($conditions, array(), TRUE);
611
  }
612

613 614
  // @todo Add a hook_xmlsitemap_link_delete() hook invoked here.

615 616 617 618
  $query = db_delete('xmlsitemap');
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
  }
619

620
  return $query->execute();
621 622
}

Darren Oh's avatar
Darren Oh committed
623
/**
624
 * Check if there is a visible sitemap link given a certain set of conditions.
625
 *
626 627 628 629 630 631 632
 * @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.
633
 */
634 635
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.
636 637
  $conditions['status'] = (!empty($updates['status']) && empty($conditions['status'])) ? 0 : 1;
  $conditions['access'] = (!empty($updates['access']) && empty($conditions['access'])) ? 0 : 1;
638

639 640 641 642
  $query = db_select('xmlsitemap');
  $query->addExpression('1');
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
643
  }
644 645
  $query->range(0, 1);
  $changed = $query->execute()->fetchField();
646

647
  if ($changed && $flag) {
648
    \Drupal::config('xmlsitemap.settings')->set('regenerate_needed', TRUE)->save();
Darren Oh's avatar
Darren Oh committed
649
  }
650

651
  return $changed;
Darren Oh's avatar
Darren Oh committed
652 653 654
}

/**
655
 * Check if there is sitemap link is changed from the existing data.
656
 *
657 658 659 660 661 662 663 664 665 666 667
 * @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
668
 */
669 670
function _xmlsitemap_check_changed_link(array $link, $original_link = NULL, $flag = FALSE) {
  $changed = FALSE;
671

672 673 674 675
  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
676

677 678 679 680
  if (!$original_link) {
    if ($link['access'] && $link['status']) {
      // Adding a new visible link.
      $changed = TRUE;
Darren Oh's avatar
Darren Oh committed
681
    }
682
  }
683 684 685 686 687 688 689 690
  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
691 692
    }
  }
693 694

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

698
  return $changed;
Darren Oh's avatar
Darren Oh committed
699 700 701
}

/**
702
 * @} End of "defgroup xmlsitemap_api"
703
 */
704
function xmlsitemap_get_directory(XmlSitemapInterface $sitemap = NULL) {
705 706
  $directory = &drupal_static(__FUNCTION__);
  if (!isset($directory)) {
707
    $directory = \Drupal::config('xmlsitemap.settings')->get('path');
Darren Oh's avatar
Darren Oh committed
708
  }
709

710
  if ($sitemap != NULL && !empty($sitemap->id)) {
711
    return file_build_uri($directory . '/' . $sitemap->id);
712 713 714 715
  }
  else {
    return file_build_uri($directory);
  }
Darren Oh's avatar
Darren Oh committed
716 717 718
}

/**
719
 * Check that the sitemap files directory exists and is writable.
Darren Oh's avatar
Darren Oh committed
720
 */
721
function xmlsitemap_check_directory(XmlSitemapInterface $sitemap = NULL) {
722 723 724 725 726 727 728 729
  $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;
}

730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751
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;
}

752
function xmlsitemap_clear_directory(XmlSitemapInterface $sitemap = NULL, $delete = FALSE) {
753 754 755 756
  $directory = xmlsitemap_get_directory($sitemap);
  return _xmlsitemap_delete_recursive($directory, $delete);
}

757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789
/**
 * 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;
}

790 791 792 793 794 795 796 797
/**
 * 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
798
 *   A filepath relative to the Drupal root directory.
799 800 801 802 803 804 805 806 807 808 809 810 811
 * @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;
812
      file_unmanaged_delete_recursive($entry_path, NULL);
813 814
    }
    $dir->close();
815
    return $delete_root ? drupal_rmdir($path) : TRUE;
816 817
  }
  return file_unmanaged_delete($path);
Darren Oh's avatar
Darren Oh committed
818 819 820
}

/**
821 822 823 824 825 826 827 828 829 830 831
 * 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
832
 */
833
function xmlsitemap_get_link_info($type = NULL, $reset = FALSE) {
834
  $language = \Drupal::languageManager()->getCurrentLanguage();
835
  $link_info = &drupal_static(__FUNCTION__);
836

837 838
  if ($reset) {
    $link_info = NULL;
839 840 841
    foreach (\Drupal::languageManager()->getLanguages() as $lang) {
      \Drupal::cache()->delete('xmlsitemap:link_info:' . $lang->getId());
    }
842 843
  }

844
  if (!isset($link_info)) {
845
    $cid = 'xmlsitemap:link_info:' . $language->getId();
846
    if ($cache = \Drupal::cache()->get($cid)) {
847
      $link_info = $cache->data;
848
    }
849
    else {
850
      \Drupal::entityManager()->clearCachedDefinitions();
851 852 853 854 855 856 857 858 859 860 861
      $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)) {
862
          // Remove any non URL-able or XML sitemap un-supported entites.
863 864
          //unset($entity_types[$key]);
          //unset($link_info[$key]);
865
        }
866
        foreach (\Drupal::entityManager()->getBundleInfo($entity_type->id()) as $bundle_key => $bundle) {
867 868 869 870 871
          if (!isset($bundle['xmlsitemap'])) {
            // Remove any un-supported entity bundles.
            //unset($link_info[$key]['bundles'][$bundle_key]);
          }
        }
872 873
        //unset($entity_types[$key]);
        //unset($link_info[$key]);
874
      }
875
      $link_info = array_merge($link_info, \Drupal::moduleHandler()->invokeAll('xmlsitemap_link_info'));
876 877 878 879 880
      foreach ($link_info as $key => &$info) {
        $info += array(
          'type' => $key,
          'base table' => FALSE,
          'bundles' => array(),
881 882
          'xmlsitemap' => array(),
        );
883 884 885 886 887 888 889 890 891
        if (!isset($info['xmlsitemap']['rebuild callback']) && !empty($info['base table']) && !empty($info['entity keys']['id']) && !empty($info['xmlsitemap']['process callback'])) {
          $info['xmlsitemap']['rebuild callback'] = 'xmlsitemap_rebuild_batch_fetch';
        }
        foreach ($info['bundles'] as $bundle => &$bundle_info) {
          $bundle_info += array(
            'xmlsitemap' => array(),
          );
          $bundle_info['xmlsitemap'] += xmlsitemap_link_bundle_load($key, $bundle, FALSE);
        }
892
      }
893
      \Drupal::moduleHandler()->alter('xmlsitemap_link_info', $link_info);
894 895
      ksort($link_info);
      // Cache by language since this info contains translated strings.
896
      \Drupal::cache()->set($cid, $link_info);
897
    }
Darren Oh's avatar
Darren Oh committed
898
  }
899 900 901 902 903 904

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

  return $link_info;
Darren Oh's avatar
Darren Oh committed
905 906
}

907 908 909 910
function xmlsitemap_get_link_type_enabled_bundles($entity_type) {
  $bundles = array();
  $info = xmlsitemap_get_link_info($entity_type);
  foreach ($info['bundles'] as $bundle => $bundle_info) {
911
    $settings = xmlsitemap_link_bundle_load($entity_type, $bundle);
912
    if (!empty($settings['status'])) {
913
      //if (!empty($bundle_info['xmlsitemap']['status'])) {
914 915 916 917 918 919
      $bundles[] = $bundle;
    }
  }
  return $bundles;
}

920 921 922
function xmlsitemap_get_link_type_indexed_status($entity_type, $bundle = '') {
  $info = xmlsitemap_get_link_info($entity_type);

923 924
  $status['indexed'] = db_query("SELECT COUNT(id) FROM {xmlsitemap} WHERE type = :entity AND subtype = :bundle", array(':entity' => $entity_type, ':bundle' => $bundle))->fetchField();
  $status['visible'] = db_query("SELECT COUNT(id) FROM {xmlsitemap} WHERE type = :entity AND subtype = :bundle AND status = 1 AND access = 1", array(':entity' => $entity_type, ':bundle' => $bundle))->fetchField();
925

926 927 928 929 930 931 932 933 934 935
  $entity_query_object = \Drupal::entityQuery($entity_type);
  $entity_query_object->addTag('xmlsitemap_link_bundle_access');
  $entity_query_object->addTag('xmlsitemap_link_indexed_status');
  //$entity_query_object->addMetaData('entity', $entity_type);
  //$entity_query_object->addMetaData('type', $bundle);
  //$entity_query_object->addMetaData('entity_info', $info);
  //$entity_query_object->condition('bundle', $bundle);
  //$entity_query_object->condition('id', 0, '>');
  $entity_query_object->count();
  $status['total'] = $entity_query_object->execute();
936 937
  return $status;
}
938

939 940 941 942 943 944 945 946 947 948 949