Simplesitemap.php 13.7 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 8
/**
 * Simplesitemap class.
9 10
 *
 * Main module class.
11 12 13
 */
class Simplesitemap {

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

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

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

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

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

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

Pawel G's avatar
Pawel G committed
76

77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94
  /**
   * 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'.
   *
   * @return bool
   *  TRUE if entity type has been enabled, FALSE if it was not.
   */
  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
95
    return $this;
96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114
  }

  /**
   * 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'.
   *
   * @return bool
   *  TRUE if entity type has been disabled, FALSE if it was not.
   */
  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
115
    return $this;
116 117 118
  }

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

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

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

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

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

Pawel G's avatar
Pawel G committed
295 296 297
  /**
   * Removes all custom paths from the sitemap settings.
   */
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 324 325 326 327 328 329
  public function getEntityInstanceBundleName($entity) {
    return $entity->getEntityTypeId() == 'menu_link_content'
      ? $entity->getMenuName() : $entity->bundle(); // Menu fix.
  }

  public function getBundleEntityTypeId($entity) {
    return $entity->getEntityTypeId() == 'menu'
      ? 'menu_link_content' : $entity->getEntityType()->getBundleOf(); // Menu fix.
  }

330 331 332 333
  /**
   * Returns the whole sitemap, a requested sitemap chunk,
   * or the sitemap index file.
   *
Pawel G's avatar
Pawel G committed
334
   * @param int $chunk_id
335 336 337 338 339 340
   *
   * @return string $sitemap
   *  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
341 342 343
  public function getSitemap($chunk_id = NULL) {
    $chunks = $this->fetchSitemapChunks();
    if (is_null($chunk_id) || !isset($chunks[$chunk_id])) {
344 345

      // Return sitemap index, if there are multiple sitemap chunks.
Pawel G's avatar
Pawel G committed
346 347
      if (count($chunks) > 1) {
        return $this->getSitemapIndex($chunks);
348
      }
349
      else { // Return sitemap if there is only one chunk.
Pawel G's avatar
Pawel G committed
350 351
        if (isset($chunks[1])) {
          return $chunks[1]->sitemap_string;
352 353
        }
        return FALSE;
354 355
      }
    }
356
    else { // Return specific sitemap chunk.
Pawel G's avatar
Pawel G committed
357
      return $chunks[$chunk_id]->sitemap_string;
358
    }
359 360
  }

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

374
  /**
375 376
   * Generates and returns the sitemap index as string.
   *
Pawel G's avatar
Pawel G committed
377
   * @param array $chunks
378 379
   *  Sitemap chunks which to generate the index from.
   *
380 381
   * @return string
   *  The sitemap index.
382
   */
Pawel G's avatar
Pawel G committed
383
  private function getSitemapIndex($chunks) {
Pawel G's avatar
Pawel G committed
384 385
    return \Drupal::service('simple_sitemap.sitemap_generator')
      ->generateSitemapIndex($chunks);
Pawel G's avatar
Pawel G committed
386 387
  }

388
  /**
Pawel G's avatar
Pawel G committed
389
   * Returns a specific sitemap setting.
390 391 392 393 394 395
   *
   * @param string $name
   *  Name of the setting, like 'max_links'.
   *
   * @return mixed
   *  The current setting from db or FALSE if setting does not exist.
396
   */
397 398
  public function getSetting($name) {
    $settings = $this->getConfig('settings');
399
    return isset($settings[$name]) ? $settings[$name] : FALSE;
400
  }
401

402
  /**
403 404 405 406 407 408
   * Saves a specific sitemap setting to db.
   *
   * @param $name
   *  Setting name, like 'max_links'.
   * @param $setting
   *  The setting to be saved.
Pawel G's avatar
Pawel G committed
409 410
   *
   * @return $this
411
   */
412 413
  public function saveSetting($name, $setting) {
    $settings = $this->getConfig('settings');
414
    $settings[$name] = $setting;
415
    $this->saveConfig('settings', $settings);
Pawel G's avatar
Pawel G committed
416
    return $this;
417
  }
418

Pawel G's avatar
Pawel G committed
419 420
  /**
   * Returns a 'time ago' string of last timestamp generation.
421
   *
Pawel G's avatar
Pawel G committed
422 423 424
   * @return mixed
   *  Formatted timestamp of last sitemap generation, otherwise FALSE.
   */
425
  public function getGeneratedAgo() {
426
    $chunks = $this->fetchSitemapChunks();
Pawel G's avatar
Pawel G committed
427
    if (isset($chunks[1]->sitemap_created)) {
428
      return \Drupal::service('date.formatter')
Pawel G's avatar
Pawel G committed
429
        ->formatInterval(REQUEST_TIME - $chunks[1]->sitemap_created);
430 431 432
    }
    return FALSE;
  }
Pawel G's avatar
Pawel G committed
433

434 435 436 437 438 439
  /**
   * 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.
   */
440 441
  public function getSitemapEntityTypes() {
    $entity_types = $this->entityTypeManager->getDefinitions();
442 443 444 445 446 447 448 449

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

451
  public function entityTypeIsAtomic($entity_type_id) {
452 453
    if ($entity_type_id == 'menu_link_content') // Menu fix.
      return FALSE;
454
    $sitemap_entity_types = $this->getSitemapEntityTypes();
455 456 457 458 459 460 461 462
    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
  }
463
}