xmlsitemap.module 52.5 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 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35

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

36 37 38 39 40 41 42 43 44 45 46 47 48 49 50
/**
 * 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');

51 52 53 54 55 56 57 58 59 60
/**
 * 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);

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

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

89 90 91
  return $hooks;
}

92 93
/**
 * Implements hook_help().
Darren Oh's avatar
Darren Oh committed
94
 */
95
function xmlsitemap_help($path, Request $request) {
96 97
  $output = '';

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

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

  return $output;
}

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

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

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

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

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

Darren Oh's avatar
Darren Oh committed
220 221 222
  return $items;
}

223 224 225 226 227 228 229 230 231
/**
 * 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
232
/**
233
 * Implements hook_cron().
234 235 236
 *
 * @todo Use new Queue system. Need to add {sitemap}.queued.
 * @todo Regenerate one at a time?
Darren Oh's avatar
Darren Oh committed
237
 */
238
function xmlsitemap_cron() {
239
  // If there were no new or changed links, skip.
240
  if (!\Drupal::config('xmlsitemap.settings')->get('regenerate_needed')) {
241 242 243
    return;
  }

244
  // If the minimum sitemap lifetime hasn't been passed, skip.
245 246
  $lifetime = REQUEST_TIME - \Drupal::config('xmlsitemap.settings')->get('generated_last');
  if ($lifetime < \Drupal::config('xmlsitemap.settings')->get('minimum_lifetine')) {
247 248
    return;
  }
249 250 251
  if (\Drupal::state()->get('xmlsitemap_entity_user')) {
    xmlsitemap_xmlsitemap_index_links(xmlsitemap_var('batch_limit'));
  }
252 253

  // Regenerate the sitemap XML files.
254
  module_load_include('generate.inc', 'xmlsitemap');
255
  xmlsitemap_run_unprogressive_batch('xmlsitemap_regenerate_batch');
Darren Oh's avatar
Darren Oh committed
256 257
}

258 259 260 261 262 263 264 265 266 267 268 269 270 271
/**
 * 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
272
/**
273
 * Implements hook_robotstxt().
Darren Oh's avatar
Darren Oh committed
274
 */
275
function xmlsitemap_robotstxt() {
276
  if ($sitemap = xmlsitemap_sitemap_load_by_context()) {
277
    $robotstxt[] = 'Sitemap: ' . url($sitemap->uri['path'], $sitemap->uri['options']);
278
    return $robotstxt;
279
  }
Darren Oh's avatar
Darren Oh committed
280 281
}

282
/**
283
 * Internal default variables for xmlsitemap_var().
284
 */
285 286
function xmlsitemap_variables() {
  return array(
287 288 289 290 291 292 293 294 295 296 297 298 299 300 301
    '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,
302
    // Removed variables are set to NULL so they can still be deleted.
303 304 305 306 307 308
    'regenerate_last' => NULL,
    'custom_links' => NULL,
    'priority_default' => NULL,
    'languages' => NULL,
    'max_chunks' => NULL,
    'max_filesize' => NULL,
309 310 311 312 313 314 315 316 317 318
  );
}

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

321 322 323
  // @todo Remove when stable.
  if (!isset($defaults[$name])) {
    trigger_error(strtr('Default variable for %variable not found.', array('%variable' => drupal_placeholder($name))));
324 325
  }

326
  return \Drupal::config('xmlsitemap.settings')->get($name);
327
  return variable_get($name, isset($default) || !isset($defaults[$name]) ? $default : $defaults[$name]);
328 329
}

Darren Oh's avatar
Darren Oh committed
330
/**
331
 * @defgroup xmlsitemap_api XML sitemap API.
332
 * @{
333 334
 * 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
335
 */
336 337 338 339 340 341

/**
 * Load an XML sitemap array from the database.
 *
 * @param $smid
 *   An XML sitemap ID.
342 343 344
 *
 * @return
 *   The XML sitemap object.
345 346 347 348
 */
function xmlsitemap_sitemap_load($smid) {
  $sitemap = xmlsitemap_sitemap_load_multiple(array($smid));
  return $sitemap ? reset($sitemap) : FALSE;
Darren Oh's avatar
Darren Oh committed
349 350 351
}

/**
352 353 354
 * Load multiple XML sitemaps from the database.
 *
 * @param $smids
355 356 357
 *   An array of XML sitemap IDs, or FALSE to load all XML sitemaps.
 * @param $conditions
 *   An array of conditions in the form 'field' => $value.
358 359 360
 *
 * @return
 *   An array of XML sitemap objects.
Darren Oh's avatar
Darren Oh committed
361
 */
362 363 364 365
function xmlsitemap_sitemap_load_multiple($smids = array(), array $conditions = array()) {
  if ($smids !== FALSE) {
    $conditions['smid'] = $smids;
  }
366
  else {
367
    $conditions['smid'] = NULL;
368
  }
369
  $storage = Drupal::entityManager()->getStorage('xmlsitemap');
370

371 372 373 374 375 376 377 378
  $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');
   */
379 380 381 382 383 384
  if (count($sitemaps) <= 0) {
    return array();
  }
  foreach ($sitemaps as &$sitemap) {
    $sitemap->setContext(unserialize($sitemap->getContext()));
    $uri = xmlsitemap_sitemap_uri($sitemap);
385
    $sitemap->setContext(serialize($sitemap->getContext()));
386
    $sitemap->uri = $uri;
Darren Oh's avatar
Darren Oh committed
387
  }
388

389
  return $sitemaps;
390 391 392
}

/**
393
 * Load an XML sitemap array from the database based on its context.
394
 *
395 396
 * @param $context
 *   An optional XML sitemap context array to use to find the correct XML
397
 *   sitemap. If not provided, the current site's context will be used.
398
 *
399
 * @see xmlsitemap_get_current_context()
400
 */
401 402 403
function xmlsitemap_sitemap_load_by_context(array $context = NULL) {
  if (!isset($context)) {
    $context = xmlsitemap_get_current_context();
Darren Oh's avatar
Darren Oh committed
404
  }
405
  $hash = xmlsitemap_sitemap_get_context_hash($context);
406 407 408 409 410 411 412 413
  $sitemaps = \Drupal::entityManager()->getStorage('xmlsitemap')->loadMultiple();
  return reset($sitemaps);
  foreach ($sitemaps as $sitemap) {
    if ($sitemap->getContext() == $hash) {
      return $sitemap;
    }
  }
  return NULL;
Darren Oh's avatar
Darren Oh committed
414 415 416
}

/**
417
 * Save changes to an XML sitemap or add a new XML sitemap.
418
 *
419
 * @param $sitemap
420
 *   The XML sitemap array to be saved. If $sitemap->smid is omitted, a new
421 422 423
 *   XML sitemap will be added.
 *
 * @todo Save the sitemap's URL as a column?
Darren Oh's avatar
Darren Oh committed
424
 */
425
function xmlsitemap_sitemap_save(XmlSitemapInterface $sitemap) {
426 427
  $context = $sitemap->getContext();
  if (!isset($context) || !$context) {
428
    $sitemap->setContext(array());
429 430
  }

431
  // Make sure context is sorted before saving the hash.
432 433
  //$sitemap->is_new = empty($sitemap->getId());
  //$sitemap->old_smid = $sitemap->is_new ? NULL : $sitemap->smid;
434
  $sitemap->setOriginalId($sitemap->isNew() ? NULL : $sitemap->getId());
435 436
  //$sitemap->smid = xmlsitemap_sitemap_get_context_hash($sitemap->context);
  $sitemap->setId(xmlsitemap_sitemap_get_context_hash($sitemap->getContext()));
437
  // If the context was changed, we need to perform additional actions.
438
  if (!$sitemap->isNew() && $sitemap->getId() != $sitemap->getOriginalId()) {
439
    // Rename the files directory so the sitemap does not break.
440
    $old_sitemap = (object) array('smid' => $sitemap->old_smid);
441
    $old_dir = xmlsitemap_get_directory($old_sitemap);
442 443 444 445
    $new_dir = xmlsitemap_get_directory($sitemap);
    xmlsitemap_directory_move($old_dir, $new_dir);

    // Mark the sitemaps as needing regeneration.
446
    \Drupal::config('xmlsitemap.settings')->set('regenerate_needed', TRUE);
447
  }
448
  $sitemap->save();
449 450

  return $sitemap;
451 452 453
}

/**
454
 * Delete an XML sitemap.
455
 *
456 457
 * @param $smid
 *   An XML sitemap ID.
458
 */
459 460
function xmlsitemap_sitemap_delete($smid) {
  xmlsitemap_sitemap_delete_multiple(array($smid));
461 462
}

Darren Oh's avatar
Darren Oh committed
463
/**
464
 * Delete multiple XML sitemaps.
465
 *
466 467
 * @param $smids
 *   An array of XML sitemap IDs.
Darren Oh's avatar
Darren Oh committed
468
 */
469 470 471
function xmlsitemap_sitemap_delete_multiple(array $smids) {
  if (!empty($smids)) {
    $sitemaps = xmlsitemap_sitemap_load_multiple($smids);
472 473 474 475 476
    /*
      db_delete('xmlsitemap_sitemap')
      ->condition('smid', $smids)
      ->execute();
     */
477 478
    foreach ($sitemaps as $sitemap) {
      xmlsitemap_clear_directory($sitemap, TRUE);
479
      $sitemap->delete();
480
      \Drupal::moduleHandler()->invokeAll('xmlsitemap_sitemap_delete', $sitemap);
481
    }
482
  }
483
}
484

485 486 487 488
/**
 * Return the expected file path for a specific sitemap chunk.
 *
 * @param $sitemap
489
 *   An XmlSitemapInterface sitemap object.
490 491 492
 * @param $chunk
 *   An optional specific chunk in the sitemap. Defaults to the index page.
 */
493
function xmlsitemap_sitemap_get_file(XmlSitemapInterface $sitemap, $chunk = 'index') {
494
  return xmlsitemap_get_directory($sitemap) . "/{$chunk}.xml";
Darren Oh's avatar
Darren Oh committed
495 496
}

497 498 499 500 501 502
/**
 * Find the maximum file size of all a sitemap's XML files.
 *
 * @param $sitemap
 *   The XML sitemap array.
 */
503
function xmlsitemap_sitemap_get_max_filesize(XmlSitemapInterface $sitemap) {
504
  $dir = xmlsitemap_get_directory($sitemap);
505
  $sitemap->setMaxFileSize(0);
506
  foreach (file_scan_directory($dir, '/\.xml$/') as $file) {
507
    $sitemap->setMaxFileSize(max($sitemap->getMaxFileSize(), filesize($file->uri)));
508
  }
509
  return $sitemap->getMaxFileSize();
510 511
}

512
function xmlsitemap_sitemap_get_context_hash(array &$context) {
513 514 515
  if (is_string($context)) {
    $context = unserialize($context);
  }
516
  asort($context);
517
  return Crypt::hashBase64(serialize($context));
518 519
}

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

541 542 543 544 545 546 547 548 549 550 551 552 553 554 555
/**
 * 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
556
/**
557
 * Load sitemap links from the database.
558 559
 *
 * @param $conditions
560 561
 *   An array of conditions on the {xmlsitemap} table in the form
 *   'field' => $value.
562
 * @return
563
 *   An array of sitemap link arrays.
Darren Oh's avatar
Darren Oh committed
564
 */
565
function xmlsitemap_link_load_multiple(array $conditions = array()) {
566 567
  $query = db_select('xmlsitemap');
  $query->fields('xmlsitemap');
568

569 570 571
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
  }
572

573
  $links = $query->execute()->fetchAll(PDO::FETCH_ASSOC);
574

575 576 577
  return $links;
}

Darren Oh's avatar
Darren Oh committed
578
/**
579 580 581 582
 * Saves or updates a sitemap link.
 *
 * @param $link
 *   An array with a sitemap link.
Darren Oh's avatar
Darren Oh committed
583
 */
584
function xmlsitemap_link_save(array $link) {
585 586
  $link += array(
    'access' => 1,
Dave Reid's avatar
Dave Reid committed
587
    'status' => 1,
588 589
    'status_override' => 0,
    'lastmod' => 0,
590
    'priority' => XMLSITEMAP_PRIORITY_DEFAULT,
591 592 593
    'priority_override' => 0,
    'changefreq' => 0,
    'changecount' => 0,
594
    'language' => LanguageInterface::LANGCODE_NOT_SPECIFIED,
595 596 597 598 599 600 601 602 603
  );

  // 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
604
  }
605 606 607 608 609
  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;
  }

610
  $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();
611 612

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

617
  // Save the link and allow other modules to respond to the link being saved.
618
  if ($existing) {
619
    drupal_write_record('xmlsitemap', $link, array('type', 'id'));
620
    \Drupal::moduleHandler()->invokeAll('xmlsitemap_link_update', $link);
621 622
  }
  else {
623 624
    print "bogdan are mere" . PHP_EOL;
    $result = drupal_write_record('xmlsitemap', $link);
625
    \Drupal::moduleHandler()->invokeAll('xmlsitemap_link_insert', $link);
626 627 628
  }

  return $link;
Darren Oh's avatar
Darren Oh committed
629 630 631
}

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

  // Process updates.
652 653 654 655 656
  $query = db_update('xmlsitemap');
  $query->fields($updates);
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
  }
657

658
  return $query->execute();
Darren Oh's avatar
Darren Oh committed
659 660
}

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

700
  if (!\Drupal::config('xmlsitemap.settings')->get('regenerate_needed')) {
701
    _xmlsitemap_check_changed_links($conditions, array(), TRUE);
702
  }
703

704 705
  // @todo Add a hook_xmlsitemap_link_delete() hook invoked here.

706 707 708 709
  $query = db_delete('xmlsitemap');
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
  }
710

711
  return $query->execute();
712 713
}

Darren Oh's avatar
Darren Oh committed
714
/**
715
 * Check if there is a visible sitemap link given a certain set of conditions.
716
 *
717 718 719 720 721 722 723
 * @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.
724
 */
725 726
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.
727 728
  $conditions['status'] = (!empty($updates['status']) && empty($conditions['status'])) ? 0 : 1;
  $conditions['access'] = (!empty($updates['access']) && empty($conditions['access'])) ? 0 : 1;
729

730 731 732 733
  $query = db_select('xmlsitemap');
  $query->addExpression('1');
  foreach ($conditions as $field => $value) {
    $query->condition($field, $value);
734
  }
735 736
  $query->range(0, 1);
  $changed = $query->execute()->fetchField();
737

738
  if ($changed && $flag) {
739
    \Drupal::config('xmlsitemap.settings')->set('regenerate_needed', TRUE);
Darren Oh's avatar
Darren Oh committed
740
  }
741

742
  return $changed;
Darren Oh's avatar
Darren Oh committed
743 744 745
}

/**
746
 * Check if there is sitemap link is changed from the existing data.
747
 *
748 749 750 751 752 753 754 755 756 757 758
 * @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
759
 */
760 761
function _xmlsitemap_check_changed_link(array $link, $original_link = NULL, $flag = FALSE) {
  $changed = FALSE;
762

763 764 765 766
  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
767

768 769 770 771
  if (!$original_link) {
    if ($link['access'] && $link['status']) {
      // Adding a new visible link.
      $changed = TRUE;
Darren Oh's avatar
Darren Oh committed
772
    }
773
  }
774 775 776 777 778 779 780 781
  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
782 783
    }
  }
784 785

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

789
  return $changed;
Darren Oh's avatar
Darren Oh committed
790 791 792
}

/**
793
 * @} End of "defgroup xmlsitemap_api"
794
 */
795
function xmlsitemap_get_directory(XmlSitemapInterface $sitemap = NULL) {
796 797
  $directory = &drupal_static(__FUNCTION__);
  if (!isset($directory)) {
798
    $directory = \Drupal::config('xmlsitemap.settings')->get('path');
Darren Oh's avatar
Darren Oh committed
799
  }
800

801
  if ($sitemap != NULL && !empty($sitemap->id)) {
802
    return file_build_uri($directory . '/' . $sitemap->id);
803 804 805 806
  }
  else {
    return file_build_uri($directory);
  }
Darren Oh's avatar
Darren Oh committed
807 808 809
}

/**
810
 * Check that the sitemap files directory exists and is writable.
Darren Oh's avatar
Darren Oh committed
811
 */
812
function xmlsitemap_check_directory(XmlSitemapInterface $sitemap = NULL) {
813 814 815 816 817 818 819 820
  $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;
}

821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842
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;
}

843
function xmlsitemap_clear_directory(XmlSitemapInterface $sitemap = NULL, $delete = FALSE) {
844 845 846 847
  $directory = xmlsitemap_get_directory($sitemap);
  return _xmlsitemap_delete_recursive($directory, $delete);
}

848 849 850 851 852 853 854 855 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
/**
 * 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;
}

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

/**
912 913 914 915 916 917 918 919 920 921 922
 * 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
923
 */
924
function xmlsitemap_get_link_info($type = NULL, $reset = FALSE) {
925
  $language = \Drupal::languageManager()->getCurrentLanguage();
926
  $link_info = &drupal_static(__FUNCTION__);
927

928 929
  if ($reset) {
    $link_info = NULL;
930 931 932
    foreach (\Drupal::languageManager()->getLanguages() as $lang) {
      \Drupal::cache()->delete('xmlsitemap:link_info:' . $lang->getId());
    }
933 934
  }

935
  if (!isset($link_info)) {
936
    $cid = 'xmlsitemap:link_info:' . $language->getId();
937
    if ($cache = \Drupal::cache()->get($cid)) {
938
      $link_info = $cache->data;
939
    }
940
    else {
941
      \Drupal::entityManager()->clearCachedDefinitions();
942 943 944 945 946 947 948 949 950 951 952
      $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)) {
953
          // Remove any non URL-able or XML sitemap un-supported entites.
954
          unset($entity_types[$key]);
955 956
          unset($link_info[$key]);
        }
957
        foreach (\Drupal::entityManager()->getBundleInfo($entity_type->id()) as $bundle_key => $bundle) {
958 959 960 961 962
          if (!isset($bundle['xmlsitemap'])) {
            // Remove any un-supported entity bundles.
            //unset($link_info[$key]['bundles'][$bundle_key]);
          }
        }
963 964
        unset($entity_types[$key]);
        unset($link_info[$key]);
965
      }
966
      $link_info = array_merge($link_info, \Drupal::moduleHandler()->invokeAll('xmlsitemap_link_info'));
967 968 969 970 971
      foreach ($link_info as $key => &$info) {
        $info += array(
          'type' => $key,
          'base table' => FALSE,
          'bundles' => array(),
Dave Reid's avatar