Simplesitemap.php 15.6 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\FormHelper;
Pawel G's avatar
Pawel G committed
7
use Drupal\simple_sitemap\SitemapGenerator;
8

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

16
  private $sitemapGenerator;
17 18 19
  private $configFactory;
  private $db;
  private $entityTypeManager;
20
  private $pathValidator;
21 22
  private static $allowed_link_settings = [
    'entity' => ['index', 'priority'],
Pawel G's avatar
Pawel G committed
23
    'custom' => ['priority'],
24
  ];
25

26 27
  /**
   * Simplesitemap constructor.
Pawel G's avatar
Pawel G committed
28
   *
29
   * @param $sitemapGenerator
30
   * @param $configFactoryInterface
31
   * @param $database
32
   * @param $entityTypeManager
33 34
   * @param $pathValidator
   * @param $dateFormatter
35
   */
36
  public function __construct(
Pawel G's avatar
Pawel G committed
37
    SitemapGenerator $sitemapGenerator,
38
    $configFactoryInterface,
39
    $database,
40
    $entityTypeManager,
41 42
    $pathValidator,
    $dateFormatter
43 44
  ) {
    $this->sitemapGenerator = $sitemapGenerator;
45 46 47
    $this->configFactory = $configFactoryInterface;
    $this->db = $database;
    $this->entityTypeManager = $entityTypeManager;
48
    $this->pathValidator = $pathValidator;
49
    $this->dateFormatter = $dateFormatter;
50 51
  }

52
  /**
53
   * Gets a specific sitemap configuration from the configuration storage.
54
   *
Pawel G's avatar
Pawel G committed
55
   * @param string $key
Pawel G's avatar
Pawel G committed
56 57
   *   Configuration key, like 'entity_types'.
   *
58
   * @return mixed
Pawel G's avatar
Pawel G committed
59
   *   The requested configuration.
60
   */
61
  public function getConfig($key) {
62 63 64
    $config = $this->configFactory->get("simple_sitemap.$key")->get();
    unset($config['_core']);
    return $config;
65 66
  }

Pawel G's avatar
Pawel G committed
67 68 69
  /**
   *
   */
Pawel G's avatar
Pawel G committed
70
  private function fetchSitemapChunks() {
71
    return $this->db
72 73 74 75
      ->query("SELECT * FROM {simple_sitemap}")
      ->fetchAllAssoc('id');
  }

76
  /**
77
   * Saves a specific sitemap configuration to db.
78
   *
79
   * @param string $key
Pawel G's avatar
Pawel G committed
80
   *   Configuration key, like 'entity_types'.
81
   * @param mixed $value
Pawel G's avatar
Pawel G committed
82
   *   The configuration to be saved.
Pawel G's avatar
Pawel G committed
83 84
   *
   * @return $this
85
   */
86
  public function saveConfig($key, $value) {
87 88
    $this->configFactory->getEditable("simple_sitemap.$key")
      ->setData($value)->save();
Pawel G's avatar
Pawel G committed
89
    return $this;
90 91
  }

92 93 94 95 96 97 98
  /**
   * 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
Pawel G's avatar
Pawel G committed
99
   *   Entity type id like 'node'.
100
   *
Pawel G's avatar
Pawel G committed
101
   * @return $this
102 103 104 105 106 107 108
   */
  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
109
    return $this;
110 111 112 113 114 115 116 117
  }

  /**
   * 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
Pawel G's avatar
Pawel G committed
118
   *   Entity type id like 'node'.
119
   *
Pawel G's avatar
Pawel G committed
120
   * @return $this
121 122 123 124 125 126
   */
  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);
127 128 129 130
      // todo: test
      $this->db->delete('simple_sitemap_entity_overrides')
        ->condition('entity_type', $entity_type_id)
        ->execute();
131
    }
Pawel G's avatar
Pawel G committed
132
    return $this;
133 134 135
  }

  /**
Pawel G's avatar
Pawel G committed
136
   * Sets sitemap settings for a non-bundle entity type (e.g. user) or a bundle
137 138 139
   * of an entity type (e.g. page).
   *
   * @param string $entity_type_id
Pawel G's avatar
Pawel G committed
140
   *   Entity type id like 'node' the bundle belongs to.
141
   * @param string $bundle_name
Pawel G's avatar
Pawel G committed
142
   *   Name of the bundle. NULL if entity type has no bundles.
143
   * @param array $settings
Pawel G's avatar
Pawel G committed
144 145
   *   An array of sitemap settings for this bundle/entity type.
   *   Example: ['index' => TRUE, 'priority' => 0.5].
Pawel G's avatar
Pawel G committed
146 147
   *
   * @return $this
148 149
   */
  public function setBundleSettings($entity_type_id, $bundle_name = NULL, $settings) {
150

151
    $bundle_name = empty($bundle_name) ? $entity_type_id : $bundle_name;
152
    $entity_types = $this->getConfig('entity_types');
153
    $this->addLinkSettings('entity', $settings, $entity_types[$entity_type_id][$bundle_name]);
154
    $this->saveConfig('entity_types', $entity_types);
155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178

    $results = $this->db->select('simple_sitemap_entity_overrides', 'o')
      ->fields('o', ['id', 'inclusion_settings'])
      ->condition('o.entity_type', $entity_type_id)
      ->execute()
      ->fetchAll();

    // Delete entity overrides which are identical to new bundle setting.
    foreach($results as $result) {
      $delete = TRUE;
      $instance_settings = unserialize($result->inclusion_settings);
      foreach ($instance_settings as $key => $instance_setting) {
        if ($instance_setting != $entity_types[$entity_type_id][$bundle_name][$key]) {
          $delete = FALSE;
          break;
        }
      }
      if ($delete) {
        $this->db->delete('simple_sitemap_entity_overrides')
          ->condition('id', $result->id)
          ->execute();
      }
    }

Pawel G's avatar
Pawel G committed
179
    return $this;
180 181
  }

182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199
  /**
   * Gets sitemap settings for an entity bundle or a non-bundle entity type.
   *
   * @param string $entity_type_id
   * @param string|null $bundle_name
   *
   * @return array|false
   */
  public function getBundleSettings($entity_type_id, $bundle_name = NULL) {
    $bundle_name = empty($bundle_name) ? $entity_type_id : $bundle_name;
    $entity_types = $this->getConfig('entity_types');
    if (isset($entity_types[$entity_type_id][$bundle_name])) {
      $settings = $entity_types[$entity_type_id][$bundle_name];
      return $settings;
    }
    return FALSE;
  }

Pawel G's avatar
Pawel G committed
200 201 202
  /**
   * Overrides entity bundle/entity type sitemap settings for a single entity.
   *
Pawel G's avatar
Pawel G committed
203 204 205
   * @param string $entity_type_id
   * @param int $id
   * @param array $settings
Pawel G's avatar
Pawel G committed
206
   *
Pawel G's avatar
Pawel G committed
207 208
   * @return $this
   */
209 210
  public function setEntityInstanceSettings($entity_type_id, $id, $settings) {
    $entity_types = $this->getConfig('entity_types');
211 212
    $entity = $this->entityTypeManager->getStorage($entity_type_id)->load($id);
    $bundle_name = $this->getEntityInstanceBundleName($entity);
213 214 215 216 217 218 219 220 221 222
    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;
        }
      }
Pawel G's avatar
Pawel G committed
223 224
      // Save overrides for this entity if something is different.
      if ($override) {
225 226 227 228 229 230 231 232 233 234
        $this->db->merge('simple_sitemap_entity_overrides')
          ->key([
            'entity_type' => $entity_type_id,
            'entity_id' => $id])
          ->fields([
            'entity_type' => $entity_type_id,
            'entity_id' => $id,
            'inclusion_settings' => serialize($settings),
          ])
          ->execute();
235
      }
Pawel G's avatar
Pawel G committed
236 237
      // Else unset override.
      else {
238 239 240 241
        $this->db->delete('simple_sitemap_entity_overrides')
          ->condition('entity_type', $entity_type_id)
          ->condition('entity_id', $id)
          ->execute();
242
      }
243 244 245
    }
    else {
      //todo: log error
246
    }
Pawel G's avatar
Pawel G committed
247
    return $this;
248 249
  }

Pawel G's avatar
Pawel G committed
250
  /**
251 252
   * Gets sitemap settings for an entity instance which overrides bundle
   * settings.
Pawel G's avatar
Pawel G committed
253
   *
Pawel G's avatar
Pawel G committed
254
   * @param string $entity_type_id
255
   * @param int $id
Pawel G's avatar
Pawel G committed
256
   *
257
   * @return array
Pawel G's avatar
Pawel G committed
258
   */
259 260 261 262 263 264 265 266 267 268 269 270 271 272 273
  public function getEntityInstanceSettings($entity_type_id, $id) {
    $results = $this->db->select('simple_sitemap_entity_overrides', 'o')
      ->fields('o', ['inclusion_settings'])
      ->condition('o.entity_type', $entity_type_id)
      ->condition('o.entity_id', $id)
      ->execute()
      ->fetchField();

    if (!empty($results)) {
      return unserialize($results);
    }
    else {
      $entity = $this->entityTypeManager->getStorage($entity_type_id)->load($id);
      $bundle_name = $this->getEntityInstanceBundleName($entity);
      return $this->getBundleSettings($entity_type_id, $bundle_name);
274 275 276
    }
  }

Pawel G's avatar
Pawel G committed
277 278 279 280 281 282
  /**
   * 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
Pawel G's avatar
Pawel G committed
283
   *
Pawel G's avatar
Pawel G committed
284 285
   * @return bool
   */
286
  public function bundleIsIndexed($entity_type_id, $bundle_name = NULL) {
287 288 289 290
    $settings = $this->getBundleSettings($entity_type_id, $bundle_name);
    return !empty($settings['index']);
  }

Pawel G's avatar
Pawel G committed
291 292 293 294
  /**
   * Checks if an entity type is enabled in the sitemap settings.
   *
   * @param $entity_type_id
Pawel G's avatar
Pawel G committed
295
   *
Pawel G's avatar
Pawel G committed
296 297
   * @return bool
   */
298 299 300 301 302
  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
303 304 305
  /**
   * Adds a custom path to the sitemap settings.
   *
Pawel G's avatar
Pawel G committed
306 307
   * @param string $path
   * @param array $settings
Pawel G's avatar
Pawel G committed
308
   *
Pawel G's avatar
Pawel G committed
309
   * @return $this
Pawel G's avatar
Pawel G committed
310
   */
311
  public function addCustomLink($path, $settings) {
Pawel G's avatar
Pawel G committed
312 313 314 315 316 317 318 319
    if (!$this->pathValidator->isValid($path)) {
      // todo: log error.
      return $this;
    }
    if ($path[0] != '/') {
      // todo: log error.
      return $this;
    }
Pawel G's avatar
Pawel G committed
320

321
    $custom_links = $this->getConfig('custom');
Pawel G's avatar
Pawel G committed
322
    foreach ($custom_links as $key => $link) {
323 324 325 326 327 328 329 330 331
      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
332
    return $this;
333 334
  }

Pawel G's avatar
Pawel G committed
335 336 337
  /**
   * Returns settings for a custom path added to the sitemap settings.
   *
Pawel G's avatar
Pawel G committed
338
   * @param string $path
Pawel G's avatar
Pawel G committed
339
   *
Pawel G's avatar
Pawel G committed
340
   * @return array|false
Pawel G's avatar
Pawel G committed
341
   */
342 343
  public function getCustomLink($path) {
    $custom_links = $this->getConfig('custom');
Pawel G's avatar
Pawel G committed
344
    foreach ($custom_links as $key => $link) {
345 346 347 348 349 350 351
      if ($link['path'] == $path) {
        return $custom_links[$key];
      }
    }
    return FALSE;
  }

Pawel G's avatar
Pawel G committed
352 353 354
  /**
   * Removes a custom path from the sitemap settings.
   *
Pawel G's avatar
Pawel G committed
355
   * @param string $path
Pawel G's avatar
Pawel G committed
356
   *
Pawel G's avatar
Pawel G committed
357 358
   * @return $this
   */
359 360
  public function removeCustomLink($path) {
    $custom_links = $this->getConfig('custom');
Pawel G's avatar
Pawel G committed
361
    foreach ($custom_links as $key => $link) {
362 363 364 365 366 367
      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
368
    return $this;
369 370
  }

Pawel G's avatar
Pawel G committed
371 372
  /**
   * Removes all custom paths from the sitemap settings.
Pawel G's avatar
Pawel G committed
373 374
   *
   * @return $this
Pawel G's avatar
Pawel G committed
375
   */
376 377
  public function removeCustomLinks() {
    $this->saveConfig('custom', []);
Pawel G's avatar
Pawel G committed
378
    return $this;
379 380
  }

Pawel G's avatar
Pawel G committed
381 382 383
  /**
   *
   */
384
  private function addLinkSettings($type, $settings, &$target) {
Pawel G's avatar
Pawel G committed
385
    foreach ($settings as $setting_key => $setting) {
386
      if (in_array($setting_key, self::$allowed_link_settings[$type])) {
Pawel G's avatar
Pawel G committed
387
        switch ($setting_key) {
388
          case 'priority':
389
            if (!FormHelper::isValidPriority($setting)) {
390
              // todo: log error.
391 392 393
              continue;
            }
            break;
Pawel G's avatar
Pawel G committed
394 395

          // todo: add index check.
396 397 398 399 400 401
        }
        $target[$setting_key] = $setting;
      }
    }
  }

Pawel G's avatar
Pawel G committed
402 403 404 405
  /**
   * @param $entity
   * @return mixed
   */
Pawel G's avatar
Pawel G committed
406 407
  public function getEntityInstanceBundleName($entity) {
    return $entity->getEntityTypeId() == 'menu_link_content'
Pawel G's avatar
Pawel G committed
408 409
    // Menu fix.
      ? $entity->getMenuName() : $entity->bundle();
Pawel G's avatar
Pawel G committed
410 411
  }

Pawel G's avatar
Pawel G committed
412 413 414 415
  /**
   * @param $entity
   * @return string
   */
Pawel G's avatar
Pawel G committed
416 417
  public function getBundleEntityTypeId($entity) {
    return $entity->getEntityTypeId() == 'menu'
Pawel G's avatar
Pawel G committed
418 419
    // Menu fix.
      ? 'menu_link_content' : $entity->getEntityType()->getBundleOf();
Pawel G's avatar
Pawel G committed
420 421
  }

422 423 424 425
  /**
   * Returns the whole sitemap, a requested sitemap chunk,
   * or the sitemap index file.
   *
Pawel G's avatar
Pawel G committed
426
   * @param int $chunk_id
427
   *
Pawel G's avatar
Pawel G committed
428
   * @return string|false
Pawel G's avatar
Pawel G committed
429 430 431 432
   *   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. False
   *   if sitemap is not retrievable from the database.
433
   */
Pawel G's avatar
Pawel G committed
434 435 436
  public function getSitemap($chunk_id = NULL) {
    $chunks = $this->fetchSitemapChunks();
    if (is_null($chunk_id) || !isset($chunks[$chunk_id])) {
437 438

      // Return sitemap index, if there are multiple sitemap chunks.
Pawel G's avatar
Pawel G committed
439 440
      if (count($chunks) > 1) {
        return $this->getSitemapIndex($chunks);
441
      }
Pawel G's avatar
Pawel G committed
442 443
      // Return sitemap if there is only one chunk.
      else {
Pawel G's avatar
Pawel G committed
444 445
        if (isset($chunks[1])) {
          return $chunks[1]->sitemap_string;
446 447
        }
        return FALSE;
448 449
      }
    }
Pawel G's avatar
Pawel G committed
450 451
    // Return specific sitemap chunk.
    else {
Pawel G's avatar
Pawel G committed
452
      return $chunks[$chunk_id]->sitemap_string;
453
    }
454 455
  }

456 457
  /**
   * Generates the sitemap for all languages and saves it to the db.
458 459
   *
   * @param string $from
Pawel G's avatar
Pawel G committed
460 461
   *   Can be 'form', 'cron', 'drush' or 'nobatch'.
   *   This decides how the batch process is to be run.
462
   */
463
  public function generateSitemap($from = 'form') {
464 465 466 467
    $this->sitemapGenerator
      ->setGenerator($this)
      ->setGenerateFrom($from)
      ->startGeneration();
468 469
  }

470
  /**
471 472
   * Generates and returns the sitemap index as string.
   *
Pawel G's avatar
Pawel G committed
473
   * @param array $chunks
Pawel G's avatar
Pawel G committed
474
   *   Sitemap chunks which to generate the index from.
475
   *
476
   * @return string
Pawel G's avatar
Pawel G committed
477
   *   The sitemap index.
478
   */
Pawel G's avatar
Pawel G committed
479
  private function getSitemapIndex($chunks) {
480 481
    return $this->sitemapGenerator
      ->setGenerator($this)
Pawel G's avatar
Pawel G committed
482
      ->generateSitemapIndex($chunks);
Pawel G's avatar
Pawel G committed
483 484
  }

485
  /**
Pawel G's avatar
Pawel G committed
486
   * Returns a specific sitemap setting.
487 488
   *
   * @param string $name
Pawel G's avatar
Pawel G committed
489
   *   Name of the setting, like 'max_links'.
490
   *
491
   * @param mixed $default
Pawel G's avatar
Pawel G committed
492
   *   Value to be returned if the setting does not exist in the configuration.
493
   *
494
   * @return mixed
Pawel G's avatar
Pawel G committed
495
   *   The current setting from db or a default value.
496
   */
497
  public function getSetting($name, $default = FALSE) {
498
    $settings = $this->getConfig('settings');
499
    return isset($settings[$name]) ? $settings[$name] : $default;
500
  }
501

502
  /**
503 504
   * Saves a specific sitemap setting to db.
   *
Pawel G's avatar
Pawel G committed
505
   * @param string $name
Pawel G's avatar
Pawel G committed
506
   *   Setting name, like 'max_links'.
Pawel G's avatar
Pawel G committed
507
   * @param mixed $setting
Pawel G's avatar
Pawel G committed
508
   *   The setting to be saved.
Pawel G's avatar
Pawel G committed
509 510
   *
   * @return $this
511
   */
512 513
  public function saveSetting($name, $setting) {
    $settings = $this->getConfig('settings');
514
    $settings[$name] = $setting;
515
    $this->saveConfig('settings', $settings);
Pawel G's avatar
Pawel G committed
516
    return $this;
517
  }
518

Pawel G's avatar
Pawel G committed
519 520
  /**
   * Returns a 'time ago' string of last timestamp generation.
521
   *
Pawel G's avatar
Pawel G committed
522
   * @return string|false
Pawel G's avatar
Pawel G committed
523
   *   Formatted timestamp of last sitemap generation, otherwise FALSE.
Pawel G's avatar
Pawel G committed
524
   */
525
  public function getGeneratedAgo() {
526
    $chunks = $this->fetchSitemapChunks();
Pawel G's avatar
Pawel G committed
527
    if (isset($chunks[1]->sitemap_created)) {
528
      return $this->dateFormatter
Pawel G's avatar
Pawel G committed
529
        ->formatInterval(REQUEST_TIME - $chunks[1]->sitemap_created);
530 531 532
    }
    return FALSE;
  }
Pawel G's avatar
Pawel G committed
533

534 535 536 537
  /**
   * Returns objects of entity types that can be indexed by the sitemap.
   *
   * @return array
Pawel G's avatar
Pawel G committed
538
   *   Objects of entity types that can be indexed by the sitemap.
539
   */
540 541
  public function getSitemapEntityTypes() {
    $entity_types = $this->entityTypeManager->getDefinitions();
542 543 544 545 546 547 548 549

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

Pawel G's avatar
Pawel G committed
551 552 553 554
  /**
   * @param $entity_type_id
   * @return bool
   */
555
  public function entityTypeIsAtomic($entity_type_id) {
Pawel G's avatar
Pawel G committed
556 557
    // Menu fix.
    if ($entity_type_id == 'menu_link_content') {
558
      return FALSE;
Pawel G's avatar
Pawel G committed
559
    }
560
    $sitemap_entity_types = $this->getSitemapEntityTypes();
561 562 563 564 565 566
    if (isset($sitemap_entity_types[$entity_type_id])) {
      $entity_type = $sitemap_entity_types[$entity_type_id];
      if (empty($entity_type->getBundleEntityType())) {
        return TRUE;
      }
    }
Pawel G's avatar
Pawel G committed
567 568
    // todo: throw exception.
    return FALSE;
569
  }
Pawel G's avatar
Pawel G committed
570

571
}