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

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

Pawel G's avatar
Pawel G committed
5 6 7
use Drupal\Core\Database\Connection;
use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Core\Path\PathValidator;
Pawel G's avatar
Pawel G committed
8 9
use Drupal\Core\Config\ConfigFactory;
use Drupal\Core\Datetime\DateFormatter;
10
use Drupal\Component\Datetime\Time;
11
use Drupal\simple_sitemap\Plugin\simple_sitemap\UrlGenerator\UrlGeneratorManager;
12

13
/**
Pawel G's avatar
Pawel G committed
14
 * Class Simplesitemap
Pawel G's avatar
Pawel G committed
15
 * @package Drupal\simple_sitemap
16 17 18
 */
class Simplesitemap {

Pawel G's avatar
Pawel G committed
19 20 21
  /**
   * @var \Drupal\simple_sitemap\SitemapGenerator
   */
22
  protected $sitemapGenerator;
Pawel G's avatar
Pawel G committed
23 24 25 26

  /**
   * @var \Drupal\simple_sitemap\EntityHelper
   */
27
  protected $entityHelper;
Pawel G's avatar
Pawel G committed
28 29 30 31

  /**
   * @var \Drupal\Core\Config\ConfigFactory
   */
32
  protected $configFactory;
Pawel G's avatar
Pawel G committed
33 34 35 36

  /**
   * @var \Drupal\Core\Database\Connection
   */
37
  protected $db;
Pawel G's avatar
Pawel G committed
38 39 40 41

  /**
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
42
  protected $entityTypeManager;
Pawel G's avatar
Pawel G committed
43 44 45 46

  /**
   * @var \Drupal\Core\Path\PathValidator
   */
47
  protected $pathValidator;
Pawel G's avatar
Pawel G committed
48

49 50 51 52 53
  /**
   * @var \Drupal\Core\Datetime\DateFormatter
   */
  protected $dateFormatter;

54 55 56 57 58
  /**
   * @var \Drupal\Component\Datetime\Time
   */
  protected $time;

59
  /**
60
   * @var \Drupal\simple_sitemap\Batch
61 62 63 64 65 66 67 68
   */
  protected $batch;

  /**
   * @var \Drupal\Core\Extension\ModuleHandler
   */
  protected $moduleHandler;

69 70 71 72 73
  /**
   * @var \Drupal\simple_sitemap\Plugin\simple_sitemap\UrlGenerator\UrlGeneratorManager
   */
  protected $urlGeneratorManager;

Pawel G's avatar
Pawel G committed
74 75 76
  /**
   * @var array
   */
Pawel G's avatar
Pawel G committed
77
  protected static $allowedLinkSettings = [
78
    'entity' => ['index', 'priority', 'changefreq', 'include_images'],
79 80 81
    'custom' => ['priority', 'changefreq'],
  ];

Pawel G's avatar
Pawel G committed
82 83 84 85
  /**
   * @var array
   */
  protected static $linkSettingDefaults = [
86
    'index' => 1,
87
    'priority' => 0.5,
88
    'changefreq' => '',
89
    'include_images' => 0,
90
  ];
91

92 93
  /**
   * Simplesitemap constructor.
Pawel G's avatar
Pawel G committed
94
   * @param \Drupal\simple_sitemap\SitemapGenerator $sitemapGenerator
95
   * @param \Drupal\simple_sitemap\EntityHelper $entityHelper
Pawel G's avatar
Pawel G committed
96 97 98 99 100
   * @param \Drupal\Core\Config\ConfigFactory $configFactory
   * @param \Drupal\Core\Database\Connection $database
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entityTypeManager
   * @param \Drupal\Core\Path\PathValidator $pathValidator
   * @param \Drupal\Core\Datetime\DateFormatter $dateFormatter
101
   * @param \Drupal\Component\Datetime\Time $time
102 103
   * @param \Drupal\simple_sitemap\Batch $batch
   * @param \Drupal\simple_sitemap\Plugin\simple_sitemap\UrlGenerator\UrlGeneratorManager $urlGeneratorManager
104
   */
105
  public function __construct(
Pawel G's avatar
Pawel G committed
106
    SitemapGenerator $sitemapGenerator,
107
    EntityHelper $entityHelper,
Pawel G's avatar
Pawel G committed
108
    ConfigFactory $configFactory,
Pawel G's avatar
Pawel G committed
109 110 111
    Connection $database,
    EntityTypeManagerInterface $entityTypeManager,
    PathValidator $pathValidator,
112
    DateFormatter $dateFormatter,
113 114
    Time $time,
    Batch $batch,
115
    UrlGeneratorManager $urlGeneratorManager
116 117
  ) {
    $this->sitemapGenerator = $sitemapGenerator;
118
    $this->entityHelper = $entityHelper;
Pawel G's avatar
Pawel G committed
119
    $this->configFactory = $configFactory;
120 121
    $this->db = $database;
    $this->entityTypeManager = $entityTypeManager;
122
    $this->pathValidator = $pathValidator;
123
    $this->dateFormatter = $dateFormatter;
124
    $this->time = $time;
125
    $this->batch = $batch;
126
    $this->urlGeneratorManager = $urlGeneratorManager;
127 128
  }

129
  /**
130 131
   * Returns a specific sitemap setting or a default value if setting does not
   * exist.
Pawel G's avatar
Pawel G committed
132
   *
133 134 135 136 137 138 139 140
   * @param string $name
   *   Name of the setting, like 'max_links'.
   *
   * @param mixed $default
   *   Value to be returned if the setting does not exist in the configuration.
   *
   * @return mixed
   *   The current setting from configuration or a default value.
Pawel G's avatar
Pawel G committed
141
   */
142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159
  public function getSetting($name, $default = FALSE) {
    $setting = $this->configFactory
      ->get('simple_sitemap.settings')
      ->get($name);
    return NULL !== $setting ? $setting : $default;
  }

  /**
   * Stores a specific sitemap setting in configuration.
   *
   * @param string $name
   *   Setting name, like 'max_links'.
   * @param mixed $setting
   *   The setting to be saved.
   *
   * @return $this
   */
  public function saveSetting($name, $setting) {
Pawel G's avatar
Pawel G committed
160
    $this->configFactory->getEditable('simple_sitemap.settings')
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207
      ->set($name, $setting)->save();
    return $this;
  }

  /**
   * Returns the whole sitemap, a requested sitemap chunk,
   * or the sitemap index file.
   *
   * @param int $chunk_id
   *
   * @return string|false
   *   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.
   */
  public function getSitemap($chunk_id = NULL) {
    $chunk_info = $this->fetchSitemapChunkInfo();

    if (NULL === $chunk_id || !isset($chunk_info[$chunk_id])) {

      if (count($chunk_info) > 1) {
        // Return sitemap index, if there are multiple sitemap chunks.
        return $this->getSitemapIndex($chunk_info);
      }
      else {
        // Return sitemap if there is only one chunk.
        return count($chunk_info) === 1
        && isset($chunk_info[SitemapGenerator::FIRST_CHUNK_INDEX])
          ? $this->fetchSitemapChunk(SitemapGenerator::FIRST_CHUNK_INDEX)
            ->sitemap_string
          : FALSE;
      }
    }
    else {
      // Return specific sitemap chunk.
      return $this->fetchSitemapChunk($chunk_id)->sitemap_string;
    }
  }

  /**
   * Fetches all sitemap chunk timestamps keyed by chunk ID.
   *
   * @return array
   *   An array containing chunk creation timestamps keyed by chunk ID.
   */
  protected function fetchSitemapChunkInfo() {
208
    return $this->db
Pawel G's avatar
Pawel G committed
209
      ->query('SELECT id, sitemap_created FROM {simple_sitemap}')
210 211 212
      ->fetchAllAssoc('id');
  }

213 214 215 216 217 218 219 220 221
  /**
   * Fetches a single sitemap chunk by ID.
   *
   * @param int $id
   *   The chunk ID.
   *
   * @return object
   *   A sitemap chunk object.
   */
222
  protected function fetchSitemapChunk($id) {
223 224 225 226 227
    return $this->db->query('SELECT * FROM {simple_sitemap} WHERE id = :id',
      [':id' => $id])->fetchObject();
  }

  /**
Pawel G's avatar
Pawel G committed
228
   * Generates the XML sitemap and saves it to the db.
229 230
   *
   * @param string $from
Pawel G's avatar
Pawel G committed
231
   *   Can be 'form', 'backend', 'drush' or 'nobatch'.
232
   *   This decides how the batch process is to be run.
Pawel G's avatar
Pawel G committed
233 234
   *
   * @return bool|\Drupal\simple_sitemap\Simplesitemap
235 236
   */
  public function generateSitemap($from = 'form') {
237

Pawel G's avatar
Pawel G committed
238
    $this->batch->setBatchSettings([
239 240 241 242 243 244 245 246 247
      'base_url' => $this->getSetting('base_url', ''),
      'batch_process_limit' => $this->getSetting('batch_process_limit', NULL),
      'max_links' => $this->getSetting('max_links', 2000),
      'skip_untranslated' => $this->getSetting('skip_untranslated', FALSE),
      'remove_duplicates' => $this->getSetting('remove_duplicates', TRUE),
      'excluded_languages' => $this->getSetting('excluded_languages', []),
      'from' => $from,
    ]);

Pawel G's avatar
Pawel G committed
248 249 250 251 252 253 254
    $plugins = $this->urlGeneratorManager->getDefinitions();

    usort($plugins, function($a, $b) {
      return $a['weight'] - $b['weight'];
    });

    foreach ($plugins as $plugin) {
255 256 257 258 259 260 261 262
      if ($plugin['instantiateForEachDataSet']) {
        foreach ($this->urlGeneratorManager->createInstance($plugin['id'])->getDataSets() as $data_sets) {
          $this->batch->addOperation($plugin['id'], $data_sets);
        }
      }
      else {
        $this->batch->addOperation($plugin['id']);
      }
263 264
    }

Pawel G's avatar
Pawel G committed
265 266
    $success = $this->batch->start();
    return $from === 'nobatch' ? $this : $success;
267 268 269 270 271
  }

  /**
   * Generates and returns the sitemap index as string.
   *
Pawel G's avatar
Pawel G committed
272 273
   * @param array $chunk_info
   *   Array containing chunk creation timestamps keyed by chunk ID.
274 275 276
   *
   * @return string
   *   The sitemap index.
277 278
   *
   * @todo Need to make sure response is cached.
279
   */
Pawel G's avatar
Pawel G committed
280
  protected function getSitemapIndex($chunk_info) {
281
    return $this->sitemapGenerator
Pawel G's avatar
Pawel G committed
282
      ->setSettings(['base_url' => $this->getSetting('base_url', '')])
Pawel G's avatar
Pawel G committed
283
      ->generateSitemapIndex($chunk_info);
284 285 286 287 288 289 290 291 292 293 294 295
  }

  /**
   * Returns a 'time ago' string of last timestamp generation.
   *
   * @return string|false
   *   Formatted timestamp of last sitemap generation, otherwise FALSE.
   */
  public function getGeneratedAgo() {
    $chunks = $this->fetchSitemapChunkInfo();
    if (isset($chunks[SitemapGenerator::FIRST_CHUNK_INDEX]->sitemap_created)) {
      return $this->dateFormatter
296
        ->formatInterval($this->time->getRequestTime() - $chunks[SitemapGenerator::FIRST_CHUNK_INDEX]
297 298 299 300 301
            ->sitemap_created);
    }
    return FALSE;
  }

302 303
  /**
   * Enables sitemap support for an entity type. Enabled entity types show
304 305
   * sitemap settings on their bundle setting forms. If an enabled entity type
   * features bundles (e.g. 'node'), it needs to be set up with
306 307 308
   * setBundleSettings() as well.
   *
   * @param string $entity_type_id
Pawel G's avatar
Pawel G committed
309
   *  Entity type id like 'node'.
310
   *
Pawel G's avatar
Pawel G committed
311
   * @return $this
312 313
   */
  public function enableEntityType($entity_type_id) {
314 315 316 317
    $enabled_entity_types = $this->getSetting('enabled_entity_types');
    if (!in_array($entity_type_id, $enabled_entity_types)) {
      $enabled_entity_types[] = $entity_type_id;
      $this->saveSetting('enabled_entity_types', $enabled_entity_types);
318
    }
Pawel G's avatar
Pawel G committed
319
    return $this;
320 321 322 323 324 325 326 327
  }

  /**
   * 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
328
   *  Entity type id like 'node'.
329
   *
Pawel G's avatar
Pawel G committed
330
   * @return $this
331 332
   */
  public function disableEntityType($entity_type_id) {
333 334 335

    // Updating settings.
    $enabled_entity_types = $this->getSetting('enabled_entity_types');
336
    if (FALSE !== ($key = array_search($entity_type_id, $enabled_entity_types))) {
337
      unset ($enabled_entity_types[$key]);
338
      $this->saveSetting('enabled_entity_types', array_values($enabled_entity_types));
339 340 341
    }

    // Deleting inclusion settings.
342
    $config_names = $this->configFactory->listAll("simple_sitemap.bundle_settings.$entity_type_id.");
343 344
    foreach($config_names as $config_name) {
      $this->configFactory->getEditable($config_name)->delete();
345
    }
346 347 348

    // Deleting entity overrides.
    $this->removeEntityInstanceSettings($entity_type_id);
Pawel G's avatar
Pawel G committed
349
    return $this;
350 351 352
  }

  /**
Pawel G's avatar
Pawel G committed
353
   * Sets sitemap settings for a non-bundle entity type (e.g. user) or a bundle
354 355 356
   * of an entity type (e.g. page).
   *
   * @param string $entity_type_id
Pawel G's avatar
Pawel G committed
357
   *  Entity type id like 'node' the bundle belongs to.
358
   * @param string $bundle_name
Pawel G's avatar
Pawel G committed
359
   *  Name of the bundle. NULL if entity type has no bundles.
360
   * @param array $settings
Pawel G's avatar
Pawel G committed
361 362
   *  An array of sitemap settings for this bundle/entity type.
   *  Example: ['index' => TRUE, 'priority' => 0.5, 'changefreq' => 'never', 'include_images' => FALSE].
Pawel G's avatar
Pawel G committed
363 364
   *
   * @return $this
365 366
   *
   * @todo: enableEntityType automatically
367
   */
368
  public function setBundleSettings($entity_type_id, $bundle_name = NULL, $settings = []) {
369
    $bundle_name = empty($bundle_name) ? $entity_type_id : $bundle_name;
370

Pawel G's avatar
Pawel G committed
371 372 373 374 375 376
    if (!empty($old_settings = $this->getBundleSettings($entity_type_id, $bundle_name))) {
      $settings = array_merge($old_settings, $settings);
    }
    else {
      self::supplementDefaultSettings('entity', $settings);
    }
377 378 379

    $bundle_settings = $this->configFactory
      ->getEditable("simple_sitemap.bundle_settings.$entity_type_id.$bundle_name");
380
    foreach($settings as $setting_key => $setting) {
381
      if ($setting_key === 'index') {
382 383
        $setting = intval($setting);
      }
384
      $bundle_settings->set($setting_key, $setting);
385
    }
386
    $bundle_settings->save();
387 388

    // Delete entity overrides which are identical to new bundle setting.
Pawel G's avatar
Pawel G committed
389
    $sitemap_entity_types = $this->entityHelper->getSupportedEntityTypes();
390 391 392
    if (isset($sitemap_entity_types[$entity_type_id])) {
      $entity_type = $sitemap_entity_types[$entity_type_id];
      $keys = $entity_type->getKeys();
393 394

      // Menu fix.
395 396
      $keys['bundle'] = $entity_type_id == 'menu_link_content' ? 'menu_name' : $keys['bundle'];

397
      $query = $this->entityTypeManager->getStorage($entity_type_id)->getQuery();
398
      if (!$this->entityHelper->entityTypeIsAtomic($entity_type_id)) {
399
        $query->condition($keys['bundle'], $bundle_name);
400
      }
401 402 403 404 405 406 407 408 409
      $entity_ids = $query->execute();

      $query = $this->db->select('simple_sitemap_entity_overrides', 'o')
        ->fields('o', ['id', 'inclusion_settings'])
        ->condition('o.entity_type', $entity_type_id);
      if (!empty($entity_ids)) {
        $query->condition('o.entity_id', $entity_ids, 'IN');
      }

410
      $delete_instances = [];
411
      foreach($query->execute()->fetchAll() as $result) {
412 413 414
        $delete = TRUE;
        $instance_settings = unserialize($result->inclusion_settings);
        foreach ($instance_settings as $setting_key => $instance_setting) {
415
          if ($instance_setting != $settings[$setting_key]) {
416 417 418 419 420
            $delete = FALSE;
            break;
          }
        }
        if ($delete) {
421
          $delete_instances[] = $result->id;
422
        }
423
      }
424 425 426 427 428
      if (!empty($delete_instances)) {
        $this->db->delete('simple_sitemap_entity_overrides')
          ->condition('id', $delete_instances, 'IN')
          ->execute();
      }
429
    }
430 431 432
    else {
      //todo: log error
    }
Pawel G's avatar
Pawel G committed
433
    return $this;
434 435
  }

436
  /**
437 438
   * Gets sitemap settings for an entity bundle, a non-bundle entity type or for
   * all entity types and their bundles.
439
   *
440 441 442
   * @param string|null $entity_type_id
   *  If set to null, sitemap settings for all entity types and their bundles
   *  are fetched.
443 444 445
   * @param string|null $bundle_name
   *
   * @return array|false
Pawel G's avatar
Pawel G committed
446 447
   *  Array of sitemap settings for an entity bundle, a non-bundle entity type
   *  or for all entity types and their bundles.
448
   *  False if entity type does not exist.
449
   */
450
  public function getBundleSettings($entity_type_id = NULL, $bundle_name = NULL) {
451
    if (NULL !== $entity_type_id) {
452
      $bundle_name = empty($bundle_name) ? $entity_type_id : $bundle_name;
453
      $bundle_settings = $this->configFactory
454 455
        ->get("simple_sitemap.bundle_settings.$entity_type_id.$bundle_name")
        ->get();
456
      return !empty($bundle_settings) ? $bundle_settings : FALSE;
457
    }
458
    else {
Pawel G's avatar
Pawel G committed
459
      $config_names = $this->configFactory->listAll('simple_sitemap.bundle_settings.');
460
      $all_settings = [];
461 462
      foreach($config_names as $config_name) {
        $config_name_parts = explode('.', $config_name);
463
        $all_settings[$config_name_parts[2]][$config_name_parts[3]] = $this->configFactory->get($config_name)->get();
464 465 466 467 468 469
      }
      return $all_settings;
    }
  }

  /**
470 471
   * Supplements all missing link setting with default values.
   *
472
   * @param string $type
Pawel G's avatar
Pawel G committed
473 474 475
   *  'entity'|'custom'
   * @param array &$settings
   * @param array $overrides
476
   */
Pawel G's avatar
Pawel G committed
477
  public static function supplementDefaultSettings($type, &$settings, $overrides = []) {
Pawel G's avatar
Pawel G committed
478
    foreach(self::$allowedLinkSettings[$type] as $allowed_link_setting) {
479
      if (!isset($settings[$allowed_link_setting])
Pawel G's avatar
Pawel G committed
480 481
        && isset(self::$linkSettingDefaults[$allowed_link_setting])) {
        $settings[$allowed_link_setting] = self::$linkSettingDefaults[$allowed_link_setting];
482 483
      }
    }
Pawel G's avatar
Pawel G committed
484
    $settings = array_merge($settings, $overrides);
485 486
  }

Pawel G's avatar
Pawel G committed
487 488 489
  /**
   * Overrides entity bundle/entity type sitemap settings for a single entity.
   *
Pawel G's avatar
Pawel G committed
490 491 492
   * @param string $entity_type_id
   * @param int $id
   * @param array $settings
Pawel G's avatar
Pawel G committed
493
   *
Pawel G's avatar
Pawel G committed
494 495
   * @return $this
   */
496
  public function setEntityInstanceSettings($entity_type_id, $id, $settings) {
497
    $entity = $this->entityTypeManager->getStorage($entity_type_id)->load($id);
498 499 500
    $bundle_settings = $this->getBundleSettings(
      $entity_type_id, $this->entityHelper->getEntityInstanceBundleName($entity)
    );
501
    if (!empty($bundle_settings)) {
502 503 504 505

      // Check if overrides are different from bundle setting before saving.
      $override = FALSE;
      foreach ($settings as $key => $setting) {
506
        if (!isset($bundle_settings[$key]) || $setting != $bundle_settings[$key]) {
507 508 509 510
          $override = TRUE;
          break;
        }
      }
Pawel G's avatar
Pawel G committed
511 512
      // Save overrides for this entity if something is different.
      if ($override) {
513 514 515 516 517 518 519
        $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,
520
            'inclusion_settings' => serialize(array_merge($bundle_settings, $settings)),])
521
          ->execute();
522
      }
Pawel G's avatar
Pawel G committed
523 524
      // Else unset override.
      else {
525
        $this->removeEntityInstanceSettings($entity_type_id, $id);
526
      }
527 528 529
    }
    else {
      //todo: log error
530
    }
Pawel G's avatar
Pawel G committed
531
    return $this;
532 533
  }

Pawel G's avatar
Pawel G committed
534
  /**
535
   * Gets sitemap settings for an entity instance which overrides the sitemap
536
   * settings of its bundle, or bundle settings, if they are not overridden.
Pawel G's avatar
Pawel G committed
537
   *
Pawel G's avatar
Pawel G committed
538
   * @param string $entity_type_id
539
   * @param int $id
Pawel G's avatar
Pawel G committed
540
   *
541
   * @return array|false
Pawel G's avatar
Pawel G committed
542
   */
543 544 545 546 547 548 549 550 551
  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)) {
552
      return unserialize($results);
553 554
    }
    else {
555 556 557 558 559 560
      $entity = $this->entityTypeManager->getStorage($entity_type_id)
        ->load($id);
      return $this->getBundleSettings(
        $entity_type_id,
        $this->entityHelper->getEntityInstanceBundleName($entity)
      );
561 562 563
    }
  }

564 565 566 567 568 569 570 571 572 573 574 575
  /**
   * Removes sitemap settings for an entity that overrides the sitemap settings
   * of its bundle.
   *
   * @param string $entity_type_id
   * @param string|null $entity_ids
   *
   * @return $this
   */
  public function removeEntityInstanceSettings($entity_type_id, $entity_ids = NULL) {
    $query = $this->db->delete('simple_sitemap_entity_overrides')
      ->condition('entity_type', $entity_type_id);
576
    if (NULL !== $entity_ids) {
577 578 579 580 581 582 583
      $entity_ids = !is_array($entity_ids) ? [$entity_ids] : $entity_ids;
      $query->condition('entity_id', $entity_ids, 'IN');
    }
    $query->execute();
    return $this;
  }

Pawel G's avatar
Pawel G committed
584 585 586 587
  /**
   * Checks if an entity bundle (or a non-bundle entity type) is set to be
   * indexed in the sitemap settings.
   *
588 589
   * @param string $entity_type_id
   * @param string|null $bundle_name
Pawel G's avatar
Pawel G committed
590
   *
Pawel G's avatar
Pawel G committed
591 592
   * @return bool
   */
593
  public function bundleIsIndexed($entity_type_id, $bundle_name = NULL) {
594 595 596 597
    $settings = $this->getBundleSettings($entity_type_id, $bundle_name);
    return !empty($settings['index']);
  }

Pawel G's avatar
Pawel G committed
598 599 600
  /**
   * Checks if an entity type is enabled in the sitemap settings.
   *
601
   * @param string $entity_type_id
Pawel G's avatar
Pawel G committed
602
   *
Pawel G's avatar
Pawel G committed
603 604
   * @return bool
   */
605
  public function entityTypeIsEnabled($entity_type_id) {
606
    return in_array($entity_type_id, $this->getSetting('enabled_entity_types', []));
607 608
  }

Pawel G's avatar
Pawel G committed
609
  /**
610
   * Stores a custom path along with its sitemap settings to configuration.
Pawel G's avatar
Pawel G committed
611
   *
Pawel G's avatar
Pawel G committed
612 613
   * @param string $path
   * @param array $settings
Pawel G's avatar
Pawel G committed
614
   *
Pawel G's avatar
Pawel G committed
615
   * @return $this
616 617
   *
   * @todo Validate $settings and throw exceptions
Pawel G's avatar
Pawel G committed
618
   */
619
  public function addCustomLink($path, $settings = []) {
Pawel G's avatar
Pawel G committed
620 621 622 623 624 625 626 627
    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
628

629
    $custom_links = $this->getCustomLinks(FALSE);
Pawel G's avatar
Pawel G committed
630
    foreach ($custom_links as $key => $link) {
631
      if ($link['path'] === $path) {
632 633 634 635 636
        $link_key = $key;
        break;
      }
    }
    $link_key = isset($link_key) ? $link_key : count($custom_links);
637
    $custom_links[$link_key] = ['path' => $path] + $settings;
Pawel G's avatar
Pawel G committed
638
    $this->configFactory->getEditable('simple_sitemap.custom')
639
      ->set('links', $custom_links)->save();
Pawel G's avatar
Pawel G committed
640
    return $this;
641 642
  }

643 644 645
  /**
   * Returns an array of custom paths and their sitemap settings.
   *
646
   * @param bool $supplement_default_settings
647 648
   * @return array
   */
649
  public function getCustomLinks($supplement_default_settings = TRUE) {
650 651
    $custom_links = $this->configFactory
      ->get('simple_sitemap.custom')
652
      ->get('links');
653 654 655

    if ($supplement_default_settings) {
      foreach ($custom_links as $i => $link_settings) {
Pawel G's avatar
Pawel G committed
656 657
        self::supplementDefaultSettings('custom', $link_settings);
        $custom_links[$i] = $link_settings;
658 659 660
      }
    }

661
    return $custom_links !== NULL ? $custom_links : [];
662 663
  }

Pawel G's avatar
Pawel G committed
664 665 666
  /**
   * Returns settings for a custom path added to the sitemap settings.
   *
Pawel G's avatar
Pawel G committed
667
   * @param string $path
Pawel G's avatar
Pawel G committed
668
   *
Pawel G's avatar
Pawel G committed
669
   * @return array|false
Pawel G's avatar
Pawel G committed
670
   */
671
  public function getCustomLink($path) {
672
    foreach ($this->getCustomLinks() as $key => $link) {
673
      if ($link['path'] === $path) {
674
        return $link;
675 676 677 678 679
      }
    }
    return FALSE;
  }

Pawel G's avatar
Pawel G committed
680 681 682
  /**
   * Removes a custom path from the sitemap settings.
   *
Pawel G's avatar
Pawel G committed
683
   * @param string $path
Pawel G's avatar
Pawel G committed
684
   *
Pawel G's avatar
Pawel G committed
685 686
   * @return $this
   */
687
  public function removeCustomLink($path) {
688
    $custom_links = $this->getCustomLinks(FALSE);
Pawel G's avatar
Pawel G committed
689
    foreach ($custom_links as $key => $link) {
690
      if ($link['path'] === $path) {
691 692
        unset($custom_links[$key]);
        $custom_links = array_values($custom_links);
Pawel G's avatar
Pawel G committed
693
        $this->configFactory->getEditable('simple_sitemap.custom')
694
          ->set('links', $custom_links)->save();
695
        break;
696 697
      }
    }
Pawel G's avatar
Pawel G committed
698
    return $this;
699 700
  }

Pawel G's avatar
Pawel G committed
701 702
  /**
   * Removes all custom paths from the sitemap settings.
Pawel G's avatar
Pawel G committed
703 704
   *
   * @return $this
Pawel G's avatar
Pawel G committed
705
   */
706
  public function removeCustomLinks() {
Pawel G's avatar
Pawel G committed
707
    $this->configFactory->getEditable('simple_sitemap.custom')
708
      ->set('links', [])->save();
Pawel G's avatar
Pawel G committed
709
    return $this;
710
  }
711
}