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
use Drupal\simple_sitemap\Form\Form;
7

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

14
  private $sitemapGenerator;
15 16 17
  private $configFactory;
  private $db;
  private $entityTypeManager;
18
  private $pathValidator;
19 20
  private static $allowed_link_settings = [
    'entity' => ['index', 'priority'],
21 22
    'custom' => ['priority']
  ];
23

24 25 26
  /**
   * Simplesitemap constructor.
   *
27
   * @param \Drupal\Core\Config\ConfigFactoryInterface $configFactoryInterface
Pawel G's avatar
Pawel G committed
28 29
   * @param \Drupal\Core\Database\Database $database
   * @param \Drupal\Core\Entity\EntityTypeManager $entityTypeManager
30
   */
31
  public function __construct(
32
    $sitemapGenerator,
Pawel G's avatar
Pawel G committed
33
    \Drupal\Core\Config\ConfigFactoryInterface $configFactoryInterface,
34
    $database,
35 36 37 38
    \Drupal\Core\Entity\EntityTypeManager $entityTypeManager,
    $pathValidator
  ) {
    $this->sitemapGenerator = $sitemapGenerator;
39 40 41
    $this->configFactory = $configFactoryInterface;
    $this->db = $database;
    $this->entityTypeManager = $entityTypeManager;
42
    $this->pathValidator = $pathValidator;
43 44
  }

45
  /**
46
   * Gets a specific sitemap configuration from the configuration storage.
47
   *
Pawel G's avatar
Pawel G committed
48
   * @param string $key
49
   *  Configuration key, like 'entity_types'.
50 51
   * @return mixed
   *  The requested configuration.
52
   */
53
  public function getConfig($key) {
54
    return $this->configFactory->get('simple_sitemap.settings')->get($key);
55 56
  }

Pawel G's avatar
Pawel G committed
57
  private function fetchSitemapChunks() {
58
    return $this->db
59 60 61 62
      ->query("SELECT * FROM {simple_sitemap}")
      ->fetchAllAssoc('id');
  }

63
  /**
64
   * Saves a specific sitemap configuration to db.
65
   *
66
   * @param string $key
67
   *  Configuration key, like 'entity_types'.
68 69
   * @param mixed $value
   *  The configuration to be saved.
Pawel G's avatar
Pawel G committed
70 71
   *
   * @return $this
72
   */
73
  public function saveConfig($key, $value) {
74
    $this->configFactory->getEditable('simple_sitemap.settings')
75
      ->set($key, $value)->save();
Pawel G's avatar
Pawel G committed
76
    return $this;
77 78
  }

Pawel G's avatar
Pawel G committed
79

80 81 82 83 84 85 86 87 88
  /**
   * 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
89
   * @return $this
90 91 92 93 94 95 96
   */
  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
97
    return $this;
98 99 100 101 102 103 104 105 106 107
  }

  /**
   * 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
108
   * @return $this
109 110 111 112 113 114 115
   */
  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
116
    return $this;
117 118 119
  }

  /**
Pawel G's avatar
Pawel G committed
120
   * Sets sitemap settings for a non-bundle entity type (e.g. user) or a bundle
121 122 123 124 125 126 127 128 129
   * 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
130 131
   *
   * @return $this
132 133
   */
  public function setBundleSettings($entity_type_id, $bundle_name = NULL, $settings) {
134
    $bundle_name = empty($bundle_name) ? $entity_type_id : $bundle_name;
135
    $entity_types = $this->getConfig('entity_types');
136
    $this->addLinkSettings('entity', $settings, $entity_types[$entity_type_id][$bundle_name]);
137
    $this->saveConfig('entity_types', $entity_types);
Pawel G's avatar
Pawel G committed
138
    return $this;
139 140
  }

Pawel G's avatar
Pawel G committed
141 142 143
  /**
   * Overrides entity bundle/entity type sitemap settings for a single entity.
   *
Pawel G's avatar
Pawel G committed
144 145 146
   * @param string $entity_type_id
   * @param int $id
   * @param array $settings
Pawel G's avatar
Pawel G committed
147 148
   * @return $this
   */
149 150
  public function setEntityInstanceSettings($entity_type_id, $id, $settings) {
    $entity_types = $this->getConfig('entity_types');
151 152
    $entity = $this->entityTypeManager->getStorage($entity_type_id)->load($id);
    $bundle_name = $this->getEntityInstanceBundleName($entity);
153 154 155 156 157 158 159 160 161 162 163
    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.
164
        $this->addLinkSettings('entity', $settings, $entity_types[$entity_type_id][$bundle_name]['entities'][$id]);
165 166 167 168 169 170
      }
      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
171
    return $this;
172 173
  }

Pawel G's avatar
Pawel G committed
174 175 176
  /**
   * Gets sitemap settings for an entity bundle or a non-bundle entity type.
   *
Pawel G's avatar
Pawel G committed
177 178 179
   * @param string $entity_type_id
   * @param string|null $bundle_name
   * @return array|false
Pawel G's avatar
Pawel G committed
180
   */
181
  public function getBundleSettings($entity_type_id, $bundle_name = NULL) {
182
    $bundle_name = empty($bundle_name) ? $entity_type_id : $bundle_name;
183 184 185 186 187 188 189 190 191
    $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
192 193 194 195 196 197 198 199
  /**
   * 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
   */
200
  public function bundleIsIndexed($entity_type_id, $bundle_name = NULL) {
201 202 203 204
    $settings = $this->getBundleSettings($entity_type_id, $bundle_name);
    return !empty($settings['index']);
  }

Pawel G's avatar
Pawel G committed
205 206 207 208 209 210
  /**
   * Checks if an entity type is enabled in the sitemap settings.
   *
   * @param $entity_type_id
   * @return bool
   */
211 212 213 214 215
  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
216 217 218 219
  /**
   * Gets sitemap settings for an entity instance which overrides bundle
   * settings.
   *
Pawel G's avatar
Pawel G committed
220 221 222
   * @param string $entity_type_id
   * @param int $id
   * @return array
Pawel G's avatar
Pawel G committed
223
   */
224 225
  public function getEntityInstanceSettings($entity_type_id, $id) {
    $entity_types = $this->getConfig('entity_types');
226 227
    $entity = $this->entityTypeManager->getStorage($entity_type_id)->load($id);
    $bundle_name = $this->getEntityInstanceBundleName($entity);
228 229 230 231 232 233 234 235
    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
236 237 238
  /**
   * Adds a custom path to the sitemap settings.
   *
Pawel G's avatar
Pawel G committed
239 240 241
   * @param string $path
   * @param array $settings
   * @return $this
Pawel G's avatar
Pawel G committed
242
   */
243
  public function addCustomLink($path, $settings) {
244
    if (!$this->pathValidator->isValid($path))
Pawel G's avatar
Pawel G committed
245
      return $this; // todo: log error
246
    if ($path[0] != '/')
Pawel G's avatar
Pawel G committed
247 248
      return $this; // todo: log error

249 250 251 252 253 254 255 256 257 258 259
    $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
260
    return $this;
261 262
  }

Pawel G's avatar
Pawel G committed
263 264 265
  /**
   * Returns settings for a custom path added to the sitemap settings.
   *
Pawel G's avatar
Pawel G committed
266 267
   * @param string $path
   * @return array|false
Pawel G's avatar
Pawel G committed
268
   */
269 270 271 272 273 274 275 276 277 278
  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
279 280 281
  /**
   * Removes a custom path from the sitemap settings.
   *
Pawel G's avatar
Pawel G committed
282
   * @param string $path
Pawel G's avatar
Pawel G committed
283 284
   * @return $this
   */
285 286 287 288 289 290 291 292 293
  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
294
    return $this;
295 296
  }

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

  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':
312
            if (!Form::isValidPriority($setting)) {
313 314 315 316 317 318 319 320 321 322 323
              // todo: register error
              continue;
            }
            break;
          //todo: add index check
        }
        $target[$setting_key] = $setting;
      }
    }
  }

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

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

342 343 344 345
  /**
   * Returns the whole sitemap, a requested sitemap chunk,
   * or the sitemap index file.
   *
Pawel G's avatar
Pawel G committed
346
   * @param int $chunk_id
347
   *
Pawel G's avatar
Pawel G committed
348
   * @return string|false
349 350 351 352
   *  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
353 354 355
  public function getSitemap($chunk_id = NULL) {
    $chunks = $this->fetchSitemapChunks();
    if (is_null($chunk_id) || !isset($chunks[$chunk_id])) {
356 357

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

373 374
  /**
   * Generates the sitemap for all languages and saves it to the db.
375 376
   *
   * @param string $from
377 378
   *  Can be 'form', 'cron', 'drush' or 'nobatch'.
   *  This decides how the batch process is to be run.
379
   */
380
  public function generateSitemap($from = 'form') {
381 382 383 384
    $this->sitemapGenerator
      ->setGenerator($this)
      ->setGenerateFrom($from)
      ->startGeneration();
385 386
  }

387
  /**
388 389
   * Generates and returns the sitemap index as string.
   *
Pawel G's avatar
Pawel G committed
390
   * @param array $chunks
391 392
   *  Sitemap chunks which to generate the index from.
   *
393 394
   * @return string
   *  The sitemap index.
395
   */
Pawel G's avatar
Pawel G committed
396
  private function getSitemapIndex($chunks) {
397 398
    return $this->sitemapGenerator
      ->setGenerator($this)
Pawel G's avatar
Pawel G committed
399
      ->generateSitemapIndex($chunks);
Pawel G's avatar
Pawel G committed
400 401
  }

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

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

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

451 452 453 454 455 456
  /**
   * 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.
   */
457 458
  public function getSitemapEntityTypes() {
    $entity_types = $this->entityTypeManager->getDefinitions();
459 460 461 462 463 464 465 466

    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;
  }
467

Pawel G's avatar
Pawel G committed
468 469 470 471
  /**
   * @param $entity_type_id
   * @return bool
   */
472
  public function entityTypeIsAtomic($entity_type_id) {
473 474
    if ($entity_type_id == 'menu_link_content') // Menu fix.
      return FALSE;
475
    $sitemap_entity_types = $this->getSitemapEntityTypes();
476 477 478 479 480 481 482 483
    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
  }
484
}