BatchUrlGenerator.php 13.1 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
<?php

namespace Drupal\simple_sitemap\Batch;

use Drupal\Core\Url;
use Drupal\Component\Utility\Html;
use Drupal\Core\Cache\Cache;
use Drupal\Core\StringTranslation\StringTranslationTrait;

/**
 * Class BatchUrlGenerator
 * @package Drupal\simple_sitemap\Batch
 */
class BatchUrlGenerator {

  use StringTranslationTrait;

  const ANONYMOUS_USER_ID = 0;
19 20 21
  const PATH_DOES_NOT_EXIST_OR_NO_ACCESS_MESSAGE = "The path @path has been omitted from the XML sitemap as it either does not exist, or it is not accessible to anonymous users.";
  const PROCESSING_PATH_MESSAGE = 'Processing path #@current out of @max: @path';
  const REGENERATION_FINISHED_MESSAGE= "The <a href='@url' target='_blank'>XML sitemap</a> has been regenerated for all languages.";
22 23

  protected $sitemapGenerator;
24
  protected $languageManager;
25
  protected $languages;
26
  protected $defaultLanguageId;
27 28 29
  protected $entityTypeManager;
  protected $pathValidator;
  protected $entityQuery;
Pawel G's avatar
Pawel G committed
30
  protected $logger;
31 32
  protected $anonUser;

33 34 35
  protected $context;
  protected $batchInfo;

36 37 38 39 40 41 42
  /**
   * BatchUrlGenerator constructor.
   * @param $sitemap_generator
   * @param $language_manager
   * @param $entity_type_manager
   * @param $path_validator
   * @param $entity_query
Pawel G's avatar
Pawel G committed
43
   * @param $logger
44
   */
45 46 47 48 49
  public function __construct(
    $sitemap_generator,
    $language_manager,
    $entity_type_manager,
    $path_validator,
Pawel G's avatar
Pawel G committed
50 51
    $entity_query,
    $logger
52 53
  ) {
    $this->sitemapGenerator = $sitemap_generator; //todo using only one method, maybe make method static instead?
54
    $this->languageManager = $language_manager;
55
    $this->languages = $language_manager->getLanguages();
56
    $this->defaultLanguageId = $language_manager->getDefaultLanguage()->getId();
57 58 59
    $this->entityTypeManager = $entity_type_manager;
    $this->pathValidator = $path_validator;
    $this->entityQuery = $entity_query;
Pawel G's avatar
Pawel G committed
60
    $this->logger = $logger;
61 62 63
    $this->anonUser = $this->entityTypeManager->getStorage('user')->load(self::ANONYMOUS_USER_ID);
  }

64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79
  /**
   * The Drupal batch API can only call procedural functions or static methods.
   * To circumvent exclusively procedural code, on every batch iteration this
   * static method is called by the batch API and returns a freshly created
   * Drupal service object of this class. All following calls can be made on
   * the returned service the OOP way. This is is obviously trading performance
   * for cleanness. The service is created within its own class to improve
   * testability.
   *
   * @return object
   *   Symfony service object of this class
   */
  public static function service() {
    return \Drupal::service('simple_sitemap.batch_url_generator');
  }

80 81 82 83 84 85 86 87 88
  /**
   * @param $context
   * @return $this
   */
  public function setContext(&$context) {
    $this->context = &$context;
    return $this;
  }

89 90
  /**
   * @param $batch_info
91
   * @return $this
92
   */
93 94 95
  public function setBatchInfo($batch_info) {
    $this->batchInfo = $batch_info;
    return $this;
96 97 98 99 100
  }

  /**
   * @return bool
   */
101 102
  protected function isBatch() {
    return $this->batchInfo['from'] != 'nobatch';
103 104 105 106 107 108
  }

  /**
   * @param $path
   * @return bool
   */
109 110
  protected function pathProcessed($path) {
    $path_pool = isset($this->context['results']['processed_paths']) ? $this->context['results']['processed_paths'] : [];
111 112 113
    if (in_array($path, $path_pool)) {
      return TRUE;
    }
114
    $this->context['results']['processed_paths'][] = $path;
115 116 117 118 119 120
    return FALSE;
  }

  /**
   * @param $max
   */
121 122 123 124 125 126 127 128 129 130
  protected function initializeBatch($max) {
    if ($this->needsInitialization()) {
      $this->context['results']['generate'] = !empty($this->context['results']['generate']) ? $this->context['results']['generate'] : [];
      if ($this->isBatch()) {
        $this->context['sandbox']['progress'] = 0;
        $this->context['sandbox']['current_id'] = 0;
        $this->context['sandbox']['max'] = $max;
        $this->context['results']['processed_paths'] = !empty($this->context['results']['processed_paths'])
          ? $this->context['results']['processed_paths'] : [];
      }
131 132 133 134
    }
  }

  /**
135
   * @return bool
136
   */
137 138
  protected function needsInitialization() {
    return empty($this->context['sandbox']);
139 140 141
  }

  /**
142
   * @param $id
143
   */
144 145 146 147 148 149 150 151 152 153
  protected function setCurrentId($id) {
    if ($this->isBatch()) {
      $this->context['sandbox']['progress']++;
      $this->context['sandbox']['current_id'] = $id;
    }
  }

  protected function processSegment() {
    if ($this->isBatch()) {
      $this->setProgressInfo();
Pawel G's avatar
Pawel G committed
154
    }
155 156
    if (!empty($this->batchInfo['max_links']) && count($this->context['results']['generate']) >= $this->batchInfo['max_links']) {
      $chunks = array_chunk($this->context['results']['generate'], $this->batchInfo['max_links']);
157
      foreach ($chunks as $i => $chunk_links) {
158 159
        if (count($chunk_links) == $this->batchInfo['max_links']) {
          $remove_sitemap = empty($this->context['results']['chunk_count']);
160
          $this->sitemapGenerator->generateSitemap($chunk_links, $remove_sitemap);
161 162 163
          $this->context['results']['chunk_count'] = !isset($this->context['results']['chunk_count'])
            ? 1 : $this->context['results']['chunk_count'] + 1;
          $this->context['results']['generate'] = array_slice($this->context['results']['generate'], count($chunk_links));
164 165 166 167 168
        }
      }
    }
  }

169 170
  protected function setProgressInfo() {
    if ($this->context['sandbox']['progress'] != $this->context['sandbox']['max']) {
Pawel G's avatar
Pawel G committed
171
      // Providing progress info to the batch API.
172
      $this->context['finished'] = $this->context['sandbox']['progress'] / $this->context['sandbox']['max'];
Pawel G's avatar
Pawel G committed
173
      // Adding processing message after finishing every batch segment.
174 175 176 177 178 179 180
      end($this->context['results']['generate']);
      $last_key = key($this->context['results']['generate']);
      if (!empty($this->context['results']['generate'][$last_key]['path'])) {
        $this->context['message'] = $this->t(self::PROCESSING_PATH_MESSAGE, [
          '@current' => $this->context['sandbox']['progress'],
          '@max' => $this->context['sandbox']['max'],
          '@path' => HTML::escape($this->context['results']['generate'][$last_key]['path']),
Pawel G's avatar
Pawel G committed
181 182 183 184
        ]);
      }
    }
  }
185 186 187 188 189 190

  /**
   * Batch callback function which generates urls to entity paths.
   *
   * @param array $entity_info
   */
191
  public function generateBundleUrls($entity_info) {
192

193
    $query = $this->entityQuery->get($entity_info['entity_type_name']);
194 195 196 197 198 199 200
    if (!empty($entity_info['keys']['id']))
      $query->sort($entity_info['keys']['id'], 'ASC');
    if (!empty($entity_info['keys']['bundle']))
      $query->condition($entity_info['keys']['bundle'], $entity_info['bundle_name']);
    if (!empty($entity_info['keys']['status']))
      $query->condition($entity_info['keys']['status'], 1);

201 202
    $count_query = clone $query;
    $this->initializeBatch($count_query->count()->execute());
203 204

    // Creating a query limited to n=batch_process_limit entries.
205 206
    if ($this->isBatch()) {
      $query->range($this->context['sandbox']['progress'], $this->batchInfo['batch_process_limit']);
207 208 209 210 211 212
    }

    $results = $query->execute();
    if (!empty($results)) {
      $entities = $this->entityTypeManager->getStorage($entity_info['entity_type_name'])->loadMultiple($results);

213
      foreach($entities as $entity_id => $entity) {
214
        $this->setCurrentId($entity_id);
215
        $priority = NULL;
216 217

        // Overriding entity settings if it has been overridden on entity edit page...
218
        if (isset($this->batchInfo['entity_types'][$entity_info['entity_type_name']][$entity_info['bundle_name']]['entities'][$entity_id]['index'])) {
219 220

          // Skipping entity if it has been excluded on entity edit page.
221
          if (!$this->batchInfo['entity_types'][$entity_info['entity_type_name']][$entity_info['bundle_name']]['entities'][$entity_id]['index']) {
222 223 224
            continue;
          }
          // Otherwise overriding priority settings for this entity.
225
          $priority = $this->batchInfo['entity_types'][$entity_info['entity_type_name']][$entity_info['bundle_name']]['entities'][$entity_id]['priority'];
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247
        }

        switch ($entity_info['entity_type_name']) {
          case 'menu_link_content': // Loading url object for menu links.
            if (!$entity->isEnabled())
              continue;
            $url_object = $entity->getUrlObject();
            break;
          default: // Loading url object for other entities.
            $url_object = $entity->toUrl(); //todo: file entity type does not have a canonical url and breaks generation, hopefully fixed in https://www.drupal.org/node/2402533
        }

        // Do not include external paths.
        if (!$url_object->isRouted())
          continue;

        // Do not include paths inaccessible to anonymous users.
        if (!$url_object->access($this->anonUser))
          continue;

        // Do not include paths that have been already indexed.
        $path = $url_object->getInternalPath();
248
        if ($this->batchInfo['remove_duplicates'] && $this->pathProcessed($path))
249 250 251 252 253 254 255 256 257 258
          continue;

        $url_object->setOption('absolute', TRUE);

        $path_data = [
          'path' => $path,
          'entity_info' => ['entity_type' => $entity_info['entity_type_name'], 'id' => $entity_id],
          'lastmod' => method_exists($entity, 'getChangedTime') ? date_iso8601($entity->getChangedTime()) : NULL,
          'priority' => isset($priority) ? $priority : (isset($entity_info['bundle_settings']['priority']) ? $entity_info['bundle_settings']['priority'] : NULL),
        ];
259
        $this->addUrlVariants($url_object, $path_data, $entity);
260 261
      }
    }
262
    $this->processSegment();
263 264 265 266 267 268 269
  }

  /**
   * Batch function which generates urls to custom paths.
   *
   * @param array $custom_paths
   */
270
  public function generateCustomUrls($custom_paths) {
271

272
    $this->initializeBatch(count($custom_paths));
273 274

    foreach($custom_paths as $i => $custom_path) {
275
      $this->setCurrentId($i);
276 277

      if (!$this->pathValidator->isValid($custom_path['path'])) { //todo: Change to different function, as this also checks if current user has access. The user however varies depending if process was started from the web interface or via cron/drush. Use getUrlIfValidWithoutAccessCheck()?
278
        $this->logger->registerError([self::PATH_DOES_NOT_EXIST_OR_NO_ACCESS_MESSAGE, ['@path' => $custom_path['path']]], 'warning');
279 280 281 282 283 284 285 286
        continue;
      }
      $url_object = Url::fromUserInput($custom_path['path'], ['absolute' => TRUE]);

      if (!$url_object->access($this->anonUser))
        continue;

      $path = $url_object->getInternalPath();
287
      if ($this->batchInfo['remove_duplicates'] && $this->pathProcessed($path))
288 289 290 291 292
        continue;

      // Load entity object if this is an entity route.
      $route_parameters = $url_object->getRouteParameters();
      $entity = !empty($route_parameters)
293 294
        ? $this->entityTypeManager->getStorage(key($route_parameters))
          ->load($route_parameters[key($route_parameters)])
295 296 297 298 299 300 301 302 303 304
        : NULL;

      $path_data = [
        'path' => $path,
        'lastmod' => method_exists($entity, 'getChangedTime') ? date_iso8601($entity->getChangedTime()) : NULL,
        'priority' => isset($custom_path['priority']) ? $custom_path['priority'] : NULL,
      ];
      if (!is_null($entity)) {
        $path_data['entity_info'] = ['entity_type' => $entity->getEntityTypeId(), 'id' => $entity->id()];
      }
305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332
      $this->addUrlVariants($url_object, $path_data, $entity);
    }
    $this->processSegment();
  }

  /**
   * @param $url_object
   * @param $path_data
   * @param $entity
   */
  private function addUrlVariants($url_object, $path_data, $entity) {
    $alternate_urls = [];

    $translation_languages = !is_null($entity) && $this->batchInfo['skip_untranslated']
      ? $entity->getTranslationLanguages() : $this->languages;

    if (!is_null($entity) && isset($translation_languages['und'])) {
      $alternate_urls[$this->defaultLanguageId] = $url_object
        ->setOption('language', $this->languages[$this->defaultLanguageId])
        ->toString();
    }
    else {
      foreach($translation_languages as $language) {
        if (!is_null($entity) && $this->batchInfo['skip_untranslated']) {
          $translation = $entity->getTranslation($language->getId());
          if (!$translation->access('view')) {
            continue;
          }
333
        }
334 335 336
        $alternate_urls[$language->getId()] = $url_object
          ->setOption('language', $language)
          ->toString();
337 338
      }
    }
339 340 341 342

    foreach($alternate_urls as $langcode => $url) {
      $this->context['results']['generate'][] = $path_data + ['langcode' => $langcode, 'url' => $url, 'alternate_urls' => $alternate_urls];
    }
343 344 345 346 347 348 349 350 351 352 353 354 355 356
  }

  /**
   * Callback function called by the batch API when all operations are finished.
   *
   * @see https://api.drupal.org/api/drupal/core!includes!form.inc/group/batch/8
   */
  public function finishGeneration($success, $results, $operations) {
    if ($success) {
      $remove_sitemap = empty($results['chunk_count']);
      if (!empty($results['generate']) || $remove_sitemap) {
        $this->sitemapGenerator->generateSitemap($results['generate'], $remove_sitemap);
      }
      Cache::invalidateTags(['simple_sitemap']);
357
      drupal_set_message($this->t(self::REGENERATION_FINISHED_MESSAGE,
358 359 360 361 362 363 364
        ['@url' => $GLOBALS['base_url'] . '/sitemap.xml']));
    }
    else {
      //todo: register error
    }
  }
}