Simplesitemap.php 14 KB
Newer Older
1 2
<?php

Pawel G's avatar
Pawel G committed
3
namespace Drupal\simple_sitemap;
4

5
use Drupal\Core\Entity\ContentEntityTypeInterface;
6

7
/**
Pawel G's avatar
Pawel G committed
8 9
 * Class Simplesitemap
 * @package Drupal\simple_sitemap
10 11 12
 */
class Simplesitemap {

13
  private $configFactory;
14
  private $config;
15 16
  private $db;
  private $entityTypeManager;
17 18 19
  private static $allowed_link_settings = [
    'entity' => ['index', 'priority'],
    'custom' => ['priority']];
20

21 22 23
  /**
   * Simplesitemap constructor.
   *
24
   * @param \Drupal\Core\Config\ConfigFactoryInterface $configFactoryInterface
Pawel G's avatar
Pawel G committed
25 26
   * @param \Drupal\Core\Database\Database $database
   * @param \Drupal\Core\Entity\EntityTypeManager $entityTypeManager
27
   */
28
  public function __construct(
Pawel G's avatar
Pawel G committed
29
    \Drupal\Core\Config\ConfigFactoryInterface $configFactoryInterface,
30
    $database,
Pawel G's avatar
Pawel G committed
31
    \Drupal\Core\Entity\EntityTypeManager $entityTypeManager) {
32 33 34 35 36

    $this->configFactory = $configFactoryInterface;
    $this->db = $database;
    $this->entityTypeManager = $entityTypeManager;
    $this->config = $this->configFactory->get('simple_sitemap.settings');
37 38
  }

39
  /**
40
   * Gets a specific sitemap configuration from the configuration storage.
41
   *
Pawel G's avatar
Pawel G committed
42
   * @param string $key
43
   *  Configuration key, like 'entity_types'.
44 45
   * @return mixed
   *  The requested configuration.
46
   */
47
  public function getConfig($key) {
48
    return $this->config->get($key);
49 50
  }

Pawel G's avatar
Pawel G committed
51
  private function fetchSitemapChunks() {
52
    return $this->db
53 54 55 56
      ->query("SELECT * FROM {simple_sitemap}")
      ->fetchAllAssoc('id');
  }

57
  /**
58
   * Saves a specific sitemap configuration to db.
59
   *
60
   * @param string $key
61
   *  Configuration key, like 'entity_types'.
62 63
   * @param mixed $value
   *  The configuration to be saved.
Pawel G's avatar
Pawel G committed
64 65
   *
   * @return $this
66
   */
67
  public function saveConfig($key, $value) {
68
    $this->configFactory->getEditable('simple_sitemap.settings')
69
      ->set($key, $value)->save();
70
    // Refresh config object after making changes.
71
    $this->config = $this->configFactory->get('simple_sitemap.settings');
Pawel G's avatar
Pawel G committed
72
    return $this;
73 74
  }

Pawel G's avatar
Pawel G committed
75

76 77 78 79 80 81 82 83 84
  /**
   * Enables sitemap support for an entity type. Enabled entity types show
   * sitemap settings on their bundles. If an enabled entity type does not
   * featured bundles (e.g. 'user'), it needs to be set up with
   * setBundleSettings() as well.
   *
   * @param string $entity_type_id
   *  Entity type id like 'node'.
   *
Pawel G's avatar
Pawel G committed
85
   * @return $this
86 87 88 89 90 91 92
   */
  public function enableEntityType($entity_type_id) {
    $entity_types = $this->getConfig('entity_types');
    if (empty($entity_types[$entity_type_id])) {
      $entity_types[$entity_type_id] = [];
      $this->saveConfig('entity_types', $entity_types);
    }
Pawel G's avatar
Pawel G committed
93
    return $this;
94 95 96 97 98 99 100 101 102 103
  }

  /**
   * Disables sitemap support for an entity type. Disabling support for an
   * entity type deletes its sitemap settings permanently and removes sitemap
   * settings from entity forms.
   *
   * @param string $entity_type_id
   *  Entity type id like 'node'.
   *
Pawel G's avatar
Pawel G committed
104
   * @return $this
105 106 107 108 109 110 111
   */
  public function disableEntityType($entity_type_id) {
    $entity_types = $this->getConfig('entity_types');
    if (isset($entity_types[$entity_type_id])) {
      unset($entity_types[$entity_type_id]);
      $this->saveConfig('entity_types', $entity_types);
    }
Pawel G's avatar
Pawel G committed
112
    return $this;
113 114 115
  }

  /**
Pawel G's avatar
Pawel G committed
116
   * Sets sitemap settings for a non-bundle entity type (e.g. user) or a bundle
117 118 119 120 121 122 123 124 125
   * of an entity type (e.g. page).
   *
   * @param string $entity_type_id
   *  Entity type id like 'node' the bundle belongs to.
   * @param string $bundle_name
   *  Name of the bundle. NULL if entity type has no bundles.
   * @param array $settings
   *  An array of sitemap settings for this bundle/entity type.
   *  Example: ['index' => TRUE, 'priority' => 0.5]
Pawel G's avatar
Pawel G committed
126 127
   *
   * @return $this
128 129
   */
  public function setBundleSettings($entity_type_id, $bundle_name = NULL, $settings) {
130
    $bundle_name = is_null($bundle_name) ? $entity_type_id : $bundle_name;
131
    $entity_types = $this->getConfig('entity_types');
132
    $this->addLinkSettings('entity', $settings, $entity_types[$entity_type_id][$bundle_name]);
133
    $this->saveConfig('entity_types', $entity_types);
Pawel G's avatar
Pawel G committed
134
    return $this;
135 136
  }

Pawel G's avatar
Pawel G committed
137 138 139
  /**
   * Overrides entity bundle/entity type sitemap settings for a single entity.
   *
Pawel G's avatar
Pawel G committed
140 141 142
   * @param string $entity_type_id
   * @param int $id
   * @param array $settings
Pawel G's avatar
Pawel G committed
143 144
   * @return $this
   */
145 146
  public function setEntityInstanceSettings($entity_type_id, $id, $settings) {
    $entity_types = $this->getConfig('entity_types');
147 148
    $entity = $this->entityTypeManager->getStorage($entity_type_id)->load($id);
    $bundle_name = $this->getEntityInstanceBundleName($entity);
149 150 151 152 153 154 155 156 157 158 159
    if (isset($entity_types[$entity_type_id][$bundle_name])) {

      // Check if overrides are different from bundle setting before saving.
      $override = FALSE;
      foreach ($settings as $key => $setting) {
        if ($setting != $entity_types[$entity_type_id][$bundle_name][$key]) {
          $override = TRUE;
          break;
        }
      }
      if ($override) { //Save overrides for this entity if something is different.
160
        $this->addLinkSettings('entity', $settings, $entity_types[$entity_type_id][$bundle_name]['entities'][$id]);
161 162 163 164 165 166
      }
      else { // Else unset override.
        unset($entity_types[$entity_type_id][$bundle_name]['entities'][$id]);
      }
      $this->saveConfig('entity_types', $entity_types);
    }
Pawel G's avatar
Pawel G committed
167
    return $this;
168 169
  }

Pawel G's avatar
Pawel G committed
170 171 172
  /**
   * Gets sitemap settings for an entity bundle or a non-bundle entity type.
   *
Pawel G's avatar
Pawel G committed
173 174 175
   * @param string $entity_type_id
   * @param string|null $bundle_name
   * @return array|false
Pawel G's avatar
Pawel G committed
176
   */
177 178
  public function getBundleSettings($entity_type_id, $bundle_name = NULL) {
    $bundle_name = is_null($bundle_name) ? $entity_type_id : $bundle_name;
179 180 181 182 183 184 185 186 187
    $entity_types = $this->getConfig('entity_types');
    if (isset($entity_types[$entity_type_id][$bundle_name])) {
      $settings = $entity_types[$entity_type_id][$bundle_name];
      unset($settings['entities']);
      return $settings;
    }
    return FALSE;
  }

Pawel G's avatar
Pawel G committed
188 189 190 191 192 193 194 195
  /**
   * Checks if an entity bundle (or a non-bundle entity type) is set to be
   * indexed in the sitemap settings.
   *
   * @param $entity_type_id
   * @param null $bundle_name
   * @return bool
   */
196
  public function bundleIsIndexed($entity_type_id, $bundle_name = NULL) {
197 198 199 200
    $settings = $this->getBundleSettings($entity_type_id, $bundle_name);
    return !empty($settings['index']);
  }

Pawel G's avatar
Pawel G committed
201 202 203 204 205 206
  /**
   * Checks if an entity type is enabled in the sitemap settings.
   *
   * @param $entity_type_id
   * @return bool
   */
207 208 209 210 211
  public function entityTypeIsEnabled($entity_type_id) {
    $entity_types = $this->getConfig('entity_types');
    return isset($entity_types[$entity_type_id]);
  }

Pawel G's avatar
Pawel G committed
212 213 214 215
  /**
   * Gets sitemap settings for an entity instance which overrides bundle
   * settings.
   *
Pawel G's avatar
Pawel G committed
216 217 218
   * @param string $entity_type_id
   * @param int $id
   * @return array
Pawel G's avatar
Pawel G committed
219
   */
220 221
  public function getEntityInstanceSettings($entity_type_id, $id) {
    $entity_types = $this->getConfig('entity_types');
222 223
    $entity = $this->entityTypeManager->getStorage($entity_type_id)->load($id);
    $bundle_name = $this->getEntityInstanceBundleName($entity);
224 225 226 227 228 229 230 231
    if (isset($entity_types[$entity_type_id][$bundle_name]['entities'][$id])) {
      return $entity_types[$entity_type_id][$bundle_name]['entities'][$id];
    }
    else {
      return $this->getBundleSettings($entity_type_id, $bundle_name);
    }
  }

Pawel G's avatar
Pawel G committed
232 233 234
  /**
   * Adds a custom path to the sitemap settings.
   *
Pawel G's avatar
Pawel G committed
235 236 237
   * @param string $path
   * @param array $settings
   * @return $this
Pawel G's avatar
Pawel G committed
238
   */
239 240
  public function addCustomLink($path, $settings) {
    if (!\Drupal::service('path.validator')->isValid($path))
Pawel G's avatar
Pawel G committed
241
      return $this; // todo: log error
242
    if ($path[0] != '/')
Pawel G's avatar
Pawel G committed
243 244
      return $this; // todo: log error

245 246 247 248 249 250 251 252 253 254 255
    $custom_links = $this->getConfig('custom');
    foreach($custom_links as $key => $link) {
      if ($link['path'] == $path) {
        $link_key = $key;
        break;
      }
    }
    $link_key = isset($link_key) ? $link_key : count($custom_links);
    $custom_links[$link_key]['path'] = $path;
    $this->addLinkSettings('entity', $settings, $custom_links[$link_key]);
    $this->saveConfig('custom', $custom_links);
Pawel G's avatar
Pawel G committed
256
    return $this;
257 258
  }

Pawel G's avatar
Pawel G committed
259 260 261
  /**
   * Returns settings for a custom path added to the sitemap settings.
   *
Pawel G's avatar
Pawel G committed
262 263
   * @param string $path
   * @return array|false
Pawel G's avatar
Pawel G committed
264
   */
265 266 267 268 269 270 271 272 273 274
  public function getCustomLink($path) {
    $custom_links = $this->getConfig('custom');
    foreach($custom_links as $key => $link) {
      if ($link['path'] == $path) {
        return $custom_links[$key];
      }
    }
    return FALSE;
  }

Pawel G's avatar
Pawel G committed
275 276 277
  /**
   * Removes a custom path from the sitemap settings.
   *
Pawel G's avatar
Pawel G committed
278
   * @param string $path
Pawel G's avatar
Pawel G committed
279 280
   * @return $this
   */
281 282 283 284 285 286 287 288 289
  public function removeCustomLink($path) {
    $custom_links = $this->getConfig('custom');
    foreach($custom_links as $key => $link) {
      if ($link['path'] == $path) {
        unset($custom_links[$key]);
        $custom_links = array_values($custom_links);
        $this->saveConfig('custom', $custom_links);
      }
    }
Pawel G's avatar
Pawel G committed
290
    return $this;
291 292
  }

Pawel G's avatar
Pawel G committed
293 294
  /**
   * Removes all custom paths from the sitemap settings.
Pawel G's avatar
Pawel G committed
295 296
   *
   * @return $this
Pawel G's avatar
Pawel G committed
297
   */
298 299
  public function removeCustomLinks() {
    $this->saveConfig('custom', []);
Pawel G's avatar
Pawel G committed
300
    return $this;
301 302 303 304 305 306 307
  }

  private function addLinkSettings($type, $settings, &$target) {
    foreach($settings as $setting_key => $setting) {
      if (in_array($setting_key, self::$allowed_link_settings[$type])) {
        switch($setting_key) {
          case 'priority':
308
            if (Form::isValidPriority($setting)) {
309 310 311 312 313 314 315 316 317 318 319
              // todo: register error
              continue;
            }
            break;
          //todo: add index check
        }
        $target[$setting_key] = $setting;
      }
    }
  }

Pawel G's avatar
Pawel G committed
320 321 322 323
  /**
   * @param $entity
   * @return mixed
   */
Pawel G's avatar
Pawel G committed
324 325 326 327 328
  public function getEntityInstanceBundleName($entity) {
    return $entity->getEntityTypeId() == 'menu_link_content'
      ? $entity->getMenuName() : $entity->bundle(); // Menu fix.
  }

Pawel G's avatar
Pawel G committed
329 330 331 332
  /**
   * @param $entity
   * @return string
   */
Pawel G's avatar
Pawel G committed
333 334 335 336 337
  public function getBundleEntityTypeId($entity) {
    return $entity->getEntityTypeId() == 'menu'
      ? 'menu_link_content' : $entity->getEntityType()->getBundleOf(); // Menu fix.
  }

338 339 340 341
  /**
   * Returns the whole sitemap, a requested sitemap chunk,
   * or the sitemap index file.
   *
Pawel G's avatar
Pawel G committed
342
   * @param int $chunk_id
343
   *
Pawel G's avatar
Pawel G committed
344
   * @return string|false
345 346 347 348
   *  If no sitemap id provided, either a sitemap index is returned, or the
   *  whole sitemap, if the amount of links does not exceed the max links setting.
   *  If a sitemap id is provided, a sitemap chunk is returned.
   */
Pawel G's avatar
Pawel G committed
349 350 351
  public function getSitemap($chunk_id = NULL) {
    $chunks = $this->fetchSitemapChunks();
    if (is_null($chunk_id) || !isset($chunks[$chunk_id])) {
352 353

      // Return sitemap index, if there are multiple sitemap chunks.
Pawel G's avatar
Pawel G committed
354 355
      if (count($chunks) > 1) {
        return $this->getSitemapIndex($chunks);
356
      }
357
      else { // Return sitemap if there is only one chunk.
Pawel G's avatar
Pawel G committed
358 359
        if (isset($chunks[1])) {
          return $chunks[1]->sitemap_string;
360 361
        }
        return FALSE;
362 363
      }
    }
364
    else { // Return specific sitemap chunk.
Pawel G's avatar
Pawel G committed
365
      return $chunks[$chunk_id]->sitemap_string;
366
    }
367 368
  }

369 370
  /**
   * Generates the sitemap for all languages and saves it to the db.
371 372
   *
   * @param string $from
373 374
   *  Can be 'form', 'cron', 'drush' or 'nobatch'.
   *  This decides how the batch process is to be run.
375
   */
376
  public function generateSitemap($from = 'form') {
Pawel G's avatar
Pawel G committed
377 378 379
    \Drupal::service('simple_sitemap.sitemap_generator')
    ->setGenerateFrom($from)
    ->startGeneration();
380 381
  }

382
  /**
383 384
   * Generates and returns the sitemap index as string.
   *
Pawel G's avatar
Pawel G committed
385
   * @param array $chunks
386 387
   *  Sitemap chunks which to generate the index from.
   *
388 389
   * @return string
   *  The sitemap index.
390
   */
Pawel G's avatar
Pawel G committed
391
  private function getSitemapIndex($chunks) {
Pawel G's avatar
Pawel G committed
392 393
    return \Drupal::service('simple_sitemap.sitemap_generator')
      ->generateSitemapIndex($chunks);
Pawel G's avatar
Pawel G committed
394 395
  }

396
  /**
Pawel G's avatar
Pawel G committed
397
   * Returns a specific sitemap setting.
398 399 400 401
   *
   * @param string $name
   *  Name of the setting, like 'max_links'.
   *
402
   * @param mixed $default
Pawel G's avatar
Pawel G committed
403
   *  Value to be returned if the setting does not exist in the configuration.
404
   *
405
   * @return mixed
406
   *  The current setting from db or a default value.
407
   */
408
  public function getSetting($name, $default = FALSE) {
409
    $settings = $this->getConfig('settings');
410
    return isset($settings[$name]) ? $settings[$name] : $default;
411
  }
412

413
  /**
414 415
   * Saves a specific sitemap setting to db.
   *
Pawel G's avatar
Pawel G committed
416
   * @param string $name
417
   *  Setting name, like 'max_links'.
Pawel G's avatar
Pawel G committed
418
   * @param mixed $setting
419
   *  The setting to be saved.
Pawel G's avatar
Pawel G committed
420 421
   *
   * @return $this
422
   */
423 424
  public function saveSetting($name, $setting) {
    $settings = $this->getConfig('settings');
425
    $settings[$name] = $setting;
426
    $this->saveConfig('settings', $settings);
Pawel G's avatar
Pawel G committed
427
    return $this;
428
  }
429

Pawel G's avatar
Pawel G committed
430 431
  /**
   * Returns a 'time ago' string of last timestamp generation.
432
   *
Pawel G's avatar
Pawel G committed
433
   * @return string|false
Pawel G's avatar
Pawel G committed
434 435
   *  Formatted timestamp of last sitemap generation, otherwise FALSE.
   */
436
  public function getGeneratedAgo() {
437
    $chunks = $this->fetchSitemapChunks();
Pawel G's avatar
Pawel G committed
438
    if (isset($chunks[1]->sitemap_created)) {
439
      return \Drupal::service('date.formatter')
Pawel G's avatar
Pawel G committed
440
        ->formatInterval(REQUEST_TIME - $chunks[1]->sitemap_created);
441 442 443
    }
    return FALSE;
  }
Pawel G's avatar
Pawel G committed
444

445 446 447 448 449 450
  /**
   * Returns objects of entity types that can be indexed by the sitemap.
   *
   * @return array
   *  Objects of entity types that can be indexed by the sitemap.
   */
451 452
  public function getSitemapEntityTypes() {
    $entity_types = $this->entityTypeManager->getDefinitions();
453 454 455 456 457 458 459 460

    foreach ($entity_types as $entity_type_id => $entity_type) {
      if (!$entity_type instanceof ContentEntityTypeInterface || !method_exists($entity_type, 'getBundleEntityType')) {
        unset($entity_types[$entity_type_id]);
      }
    }
    return $entity_types;
  }
461

Pawel G's avatar
Pawel G committed
462 463 464 465
  /**
   * @param $entity_type_id
   * @return bool
   */
466
  public function entityTypeIsAtomic($entity_type_id) {
467 468
    if ($entity_type_id == 'menu_link_content') // Menu fix.
      return FALSE;
469
    $sitemap_entity_types = $this->getSitemapEntityTypes();
470 471 472 473 474 475 476 477
    if (isset($sitemap_entity_types[$entity_type_id])) {
      $entity_type = $sitemap_entity_types[$entity_type_id];
      if (empty($entity_type->getBundleEntityType())) {
        return TRUE;
      }
    }
    return FALSE; //todo: throw exception
  }
478
}