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

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

5
use Drupal\Core\Config\ConfigFactoryInterface;
6
use Drupal\Core\Database\Database;
7
use Drupal\Core\Entity\ContentEntityTypeInterface;
8
use Drupal\Core\Entity\EntityTypeManager;
9

10 11
/**
 * Simplesitemap class.
12 13
 *
 * Main module class.
14 15 16
 */
class Simplesitemap {

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

25 26 27
  /**
   * Simplesitemap constructor.
   *
28
   * @param \Drupal\Core\Config\ConfigFactoryInterface $configFactoryInterface
29
   *   The config factory from the container.
30 31 32
   *
   * @param $database
   *   The database from the container.
33
   */
34 35 36 37 38 39 40 41 42
  function __construct(
    ConfigFactoryInterface $configFactoryInterface,
    $database,
    EntityTypeManager $entityTypeManager) {

    $this->configFactory = $configFactoryInterface;
    $this->db = $database;
    $this->entityTypeManager = $entityTypeManager;
    $this->config = $this->configFactory->get('simple_sitemap.settings');
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->config->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.
70
   */
71
  public function saveConfig($key, $value) {
72
    $this->configFactory->getEditable('simple_sitemap.settings')
73
      ->set($key, $value)->save();
74
    // Refresh config object after making changes.
75
    $this->config = $this->configFactory->get('simple_sitemap.settings');
76 77
  }

78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133
  /**
   * 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);
      return TRUE;
    }
    return FALSE;
  }

  /**
   * 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);
      return TRUE;
    }
    return FALSE;
  }

  /**
   * Sets sitemap settings for a bundle less entity type (e.g. user) or a bundle
   * 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]
   */
  public function setBundleSettings($entity_type_id, $bundle_name = NULL, $settings) {
134
    $bundle_name = is_null($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 138 139
    $this->saveConfig('entity_types', $entity_types);
  }

140
  public function getEntityInstanceBundleName($entity) {
141 142 143 144
    return $entity->getEntityTypeId() == 'menu_link_content'
      ? $entity->getMenuName() : $entity->bundle(); // Menu fix.
  }

145
  public function getBundleEntityTypeId($entity) {
146 147 148 149 150 151
    return $entity->getEntityTypeId() == 'menu'
      ? 'menu_link_content' : $entity->getEntityType()->getBundleOf(); // Menu fix.
  }

  public function setEntityInstanceSettings($entity_type_id, $id, $settings) {
    $entity_types = $this->getConfig('entity_types');
152 153
    $entity = $this->entityTypeManager->getStorage($entity_type_id)->load($id);
    $bundle_name = $this->getEntityInstanceBundleName($entity);
154 155 156 157 158 159 160 161 162 163 164
    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.
165
        $this->addLinkSettings('entity', $settings, $entity_types[$entity_type_id][$bundle_name]['entities'][$id]);
166 167 168 169 170 171 172 173 174 175
      }
      else { // Else unset override.
        unset($entity_types[$entity_type_id][$bundle_name]['entities'][$id]);
      }
      $this->saveConfig('entity_types', $entity_types);
      return TRUE;
    }
    return FALSE;
  }

176 177
  public function getBundleSettings($entity_type_id, $bundle_name = NULL) {
    $bundle_name = is_null($bundle_name) ? $entity_type_id : $bundle_name;
178 179 180 181 182 183 184 185 186
    $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;
  }

187
  public function bundleIsIndexed($entity_type_id, $bundle_name = NULL) {
188 189 190 191 192 193 194 195 196 197 198
    $settings = $this->getBundleSettings($entity_type_id, $bundle_name);
    return !empty($settings['index']);
  }

  public function entityTypeIsEnabled($entity_type_id) {
    $entity_types = $this->getConfig('entity_types');
    return isset($entity_types[$entity_type_id]);
  }

  public function getEntityInstanceSettings($entity_type_id, $id) {
    $entity_types = $this->getConfig('entity_types');
199 200
    $entity = $this->entityTypeManager->getStorage($entity_type_id)->load($id);
    $bundle_name = $this->getEntityInstanceBundleName($entity);
201 202 203 204 205 206 207 208
    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);
    }
  }

209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259
  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);
    return TRUE;
  }

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

  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);
        return TRUE;
      }
    }
    return FALSE;
  }

  public function removeCustomLinks() {
    $this->saveConfig('custom', []);
  }

  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':
260
            if (Form::isValidPriority($setting)) {
261 262 263 264 265 266 267 268 269 270 271 272
              // todo: register error
              continue;
            }
            break;
          //todo: add index check
        }
        $target[$setting_key] = $setting;
      }

    }
  }

273 274 275 276
  /**
   * Returns the whole sitemap, a requested sitemap chunk,
   * or the sitemap index file.
   *
Pawel G's avatar
Pawel G committed
277
   * @param int $chunk_id
278 279 280 281 282 283
   *
   * @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
284 285 286
  public function getSitemap($chunk_id = NULL) {
    $chunks = $this->fetchSitemapChunks();
    if (is_null($chunk_id) || !isset($chunks[$chunk_id])) {
287 288

      // Return sitemap index, if there are multiple sitemap chunks.
Pawel G's avatar
Pawel G committed
289 290
      if (count($chunks) > 1) {
        return $this->getSitemapIndex($chunks);
291
      }
292
      else { // Return sitemap if there is only one chunk.
Pawel G's avatar
Pawel G committed
293 294
        if (isset($chunks[1])) {
          return $chunks[1]->sitemap_string;
295 296
        }
        return FALSE;
297 298
      }
    }
299
    else { // Return specific sitemap chunk.
Pawel G's avatar
Pawel G committed
300
      return $chunks[$chunk_id]->sitemap_string;
301
    }
302 303
  }

304 305
  /**
   * Generates the sitemap for all languages and saves it to the db.
306 307
   *
   * @param string $from
308 309
   *  Can be 'form', 'cron', 'drush' or 'nobatch'.
   *  This decides how the batch process is to be run.
310
   */
311
  public function generateSitemap($from = 'form') {
312
    $generator = \Drupal::service('simple_sitemap.sitemap_generator');
313 314
    $generator->setGenerateFrom($from);
    $generator->startGeneration();
315 316
  }

317
  /**
318 319
   * Generates and returns the sitemap index as string.
   *
Pawel G's avatar
Pawel G committed
320
   * @param array $chunks
321 322
   *  Sitemap chunks which to generate the index from.
   *
323 324
   * @return string
   *  The sitemap index.
325
   */
Pawel G's avatar
Pawel G committed
326
  private function getSitemapIndex($chunks) {
327
    $generator = \Drupal::service('simple_sitemap.sitemap_generator');
Pawel G's avatar
Pawel G committed
328
    return $generator->generateSitemapIndex($chunks);
Pawel G's avatar
Pawel G committed
329 330
  }

331
  /**
332 333 334 335 336 337 338
   * Gets a specific sitemap setting.
   *
   * @param string $name
   *  Name of the setting, like 'max_links'.
   *
   * @return mixed
   *  The current setting from db or FALSE if setting does not exist.
339
   */
340 341
  public function getSetting($name) {
    $settings = $this->getConfig('settings');
342
    return isset($settings[$name]) ? $settings[$name] : FALSE;
343
  }
344

345
  /**
346 347 348 349 350 351
   * Saves a specific sitemap setting to db.
   *
   * @param $name
   *  Setting name, like 'max_links'.
   * @param $setting
   *  The setting to be saved.
352
   */
353 354
  public function saveSetting($name, $setting) {
    $settings = $this->getConfig('settings');
355
    $settings[$name] = $setting;
356
    $this->saveConfig('settings', $settings);
357
  }
358

Pawel G's avatar
Pawel G committed
359 360
  /**
   * Returns a 'time ago' string of last timestamp generation.
361
   *
Pawel G's avatar
Pawel G committed
362 363 364
   * @return mixed
   *  Formatted timestamp of last sitemap generation, otherwise FALSE.
   */
365
  public function getGeneratedAgo() {
366
    $chunks = $this->fetchSitemapChunks();
Pawel G's avatar
Pawel G committed
367
    if (isset($chunks[1]->sitemap_created)) {
368
      return \Drupal::service('date.formatter')
Pawel G's avatar
Pawel G committed
369
        ->formatInterval(REQUEST_TIME - $chunks[1]->sitemap_created);
370 371 372
    }
    return FALSE;
  }
Pawel G's avatar
Pawel G committed
373

374 375 376 377 378 379
  /**
   * 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.
   */
380 381
  public function getSitemapEntityTypes() {
    $entity_types = $this->entityTypeManager->getDefinitions();
382 383 384 385 386 387 388 389

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

391
  public function entityTypeIsAtomic($entity_type_id) {
392 393
    if ($entity_type_id == 'menu_link_content') // Menu fix.
      return FALSE;
394
    $sitemap_entity_types = $this->getSitemapEntityTypes();
395 396 397 398 399 400 401 402
    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
  }
403
}