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 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42

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

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

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

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

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

96 97 98
  return $hooks;
}

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

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

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

  return $output;
}

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

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

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

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

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

Darren Oh's avatar
Darren Oh committed
227 228 229
  return $items;
}

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

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

263
  // If the minimum sitemap lifetime hasn't been passed, skip.
264 265
  $lifetime = REQUEST_TIME - \Drupal::config('xmlsitemap.settings')->get('generated_last');
  if ($lifetime < \Drupal::config('xmlsitemap.settings')->get('minimum_lifetine')) {
266 267
    return;
  }
268
  xmlsitemap_xmlsitemap_index_links(100);
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 399 400
  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
401
  }
402

403
  return $sitemaps;
404 405 406
}

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

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

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

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

  return $sitemap;
463 464 465
}

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

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

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

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

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

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

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

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

582
  $links = $query->execute()->fetchAll(PDO::FETCH_ASSOC);
583

584 585 586
  return $links;
}

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

  // 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
613
  }
614 615 616 617 618
  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;
  }

619
  $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();
620 621

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

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

  return $link;
Darren Oh's avatar
Darren Oh committed
637 638 639
}

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

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

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

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

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

712 713
  // @todo Add a hook_xmlsitemap_link_delete() hook invoked here.

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

719
  return $query->execute();
720 721
}

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

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

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

750
  return $changed;
Darren Oh's avatar
Darren Oh committed
751 752 753
}

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

771 772 773 774
  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
775

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

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

797
  return $changed;
Darren Oh's avatar
Darren Oh committed
798 799 800
}

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

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

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

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

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

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

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

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

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

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