You are here

Home » API reference » Multiversion 8 » AliasStorage.php

class AliasStorage in Multiversion 8

Extends the core AliasStore class. We need this to make possible aliases to work with Multiversion and Replication.

Hierarchy

Expanded class hierarchy of AliasStorage

1 string reference to 'AliasStorage'
multiversion.services.yml in ./multiversion.services.yml
multiversion.services.yml
1 service uses AliasStorage
multiversion.alias_storage in ./multiversion.services.yml
Drupal\multiversion\AliasStorage

File

src/AliasStorage.php, line 22

Namespace

Drupal\multiversion
View source 
class AliasStorage extends CoreAliasStorage {

  /**
   * The workspace manager.
   *
   * @var \Drupal\multiversion\Workspace\WorkspaceManagerInterface
   */
  private $workspaceManager;

  /**
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The state service.
   *
   * @var \Drupal\Core\State\StateInterface
   */
  protected $state;

  /**
   * {@inheritdoc}
   */
  public function __construct(Connection $connection, ModuleHandlerInterface $module_handler, WorkspaceManagerInterface $workspace_manager, EntityTypeManagerInterface $entity_type_manager, StateInterface $state) {
    parent::__construct($connection, $module_handler);
    $this->workspaceManager = $workspace_manager;
    $this->entityTypeManager = $entity_type_manager;
    $this->state = $state;
  }

  /**
   * {@inheritdoc}
   */
  public function save($source, $alias, $langcode = LanguageInterface::LANGCODE_NOT_SPECIFIED, $pid = NULL) {
    if (!$this->connection
      ->schema()
      ->fieldExists('url_alias', 'workspace')) {
      return parent::save($source, $alias, $langcode, $pid);
    }
    if ($source[0] !== '/') {
      throw new \InvalidArgumentException(sprintf('Source path %s has to start with a slash.', $source));
    }
    if ($alias[0] !== '/') {
      throw new \InvalidArgumentException(sprintf('Alias path %s has to start with a slash.', $alias));
    }

    // Skip saving a new alias if migration running.
    if ($this->state
      ->get('skip_alias_save', FALSE)) {
      return FALSE;
    }

    // Set workspace equal with the active workspace just for path aliases for
    // multiversionable entities. For all other aliases set workspace 0, they
    // will be available on all workspaces.
    $workspace = 0;

    // Don't inject this service to avoid circular reference error.
    $path_validator = \Drupal::service('path.validator');
    $url = $path_validator
      ->getUrlIfValidWithoutAccessCheck($source);
    if ($url instanceof Url) {
      $route_name = $url
        ->getRouteName();
      $route_name_parts = explode('.', $route_name);
      if ($route_name_parts[0] === 'entity' && $this
        ->isMultiversionableEntityType($route_name_parts[1])) {
        $workspace = $this->workspaceManager
          ->getActiveWorkspaceId();
      }
    }
    $fields = [
      'source' => $source,
      'alias' => $alias,
      'langcode' => $langcode,
      'workspace' => $workspace,
    ];

    // Insert or update the alias.
    if (empty($pid)) {
      $try_again = FALSE;
      try {
        $query = $this->connection
          ->merge(static::TABLE)
          ->condition('workspace', $fields['workspace'])
          ->condition('source', $fields['source'])
          ->condition('langcode', $fields['langcode'])
          ->fields($fields);
        $result = $query
          ->execute();
      } catch (\Exception $e) {

        // If there was an exception, try to create the table.
        if (!($try_again = $this
          ->ensureTableExists())) {

          // If the exception happened for other reason than the missing table,
          // propagate the exception.
          throw $e;
        }
      }

      // Now that the table has been created, try again if necessary.
      if ($try_again) {
        $query = $this->connection
          ->merge(static::TABLE)
          ->condition('workspace', $fields['workspace'])
          ->condition('source', $fields['source'])
          ->condition('langcode', $fields['langcode'])
          ->fields($fields);
        $result = $query
          ->execute();
      }
      $pid = $this->connection
        ->select(static::TABLE)
        ->fields(static::TABLE, [
        'pid',
      ])
        ->condition('workspace', $fields['workspace'])
        ->condition('source', $fields['source'])
        ->condition('langcode', $fields['langcode'])
        ->condition('alias', $fields['alias'])
        ->execute()
        ->fetchField();
      $fields['pid'] = $pid;
      if ($result == Merge::STATUS_INSERT || $result == Merge::STATUS_UPDATE) {
        $operation = 'insert';
      }
    }
    else {

      // Fetch the current values so that an update hook can identify what
      // exactly changed.
      try {
        $original = $this->connection
          ->query('SELECT source, alias, langcode FROM {url_alias} WHERE pid = :pid', [
          ':pid' => $pid,
        ])
          ->fetchAssoc();
      } catch (\Exception $e) {
        $this
          ->catchException($e);
        $original = FALSE;
      }
      $fields['pid'] = $pid;
      $query = $this->connection
        ->update(static::TABLE)
        ->fields($fields)
        ->condition('pid', $pid);
      $pid = $query
        ->execute();
      $fields['original'] = $original;
      $operation = 'update';
    }
    if ($pid) {

      // @todo Switch to using an event for this instead of a hook.
      $this->moduleHandler
        ->invokeAll('path_' . $operation, [
        $fields,
      ]);
      Cache::invalidateTags([
        'route_match',
      ]);
      return $fields;
    }
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function load($conditions) {
    if (!$this->connection
      ->schema()
      ->fieldExists('url_alias', 'workspace')) {
      return parent::load($conditions);
    }
    $select = $this->connection
      ->select(static::TABLE);
    $select
      ->condition('workspace', [
      $this->workspaceManager
        ->getActiveWorkspaceId(),
      0,
    ], 'IN');
    foreach ($conditions as $field => $value) {
      if ($field == 'source' || $field == 'alias') {

        // Use LIKE for case-insensitive matching.
        $select
          ->condition($field, $this->connection
          ->escapeLike($value), 'LIKE');
      }
      else {
        $select
          ->condition($field, $value);
      }
    }
    try {
      return $select
        ->fields(static::TABLE)
        ->orderBy('pid', 'DESC')
        ->range(0, 1)
        ->execute()
        ->fetchAssoc();
    } catch (\Exception $e) {
      $this
        ->catchException($e);
      return FALSE;
    }
  }

  /**
   * {@inheritdoc}
   */
  public function lookupPathAlias($path, $langcode) {
    if (!$this->connection
      ->schema()
      ->fieldExists('url_alias', 'workspace')) {
      return parent::lookupPathAlias($path, $langcode);
    }
    $source = $this->connection
      ->escapeLike($path);
    $langcode_list = [
      $langcode,
      LanguageInterface::LANGCODE_NOT_SPECIFIED,
    ];

    // See the queries above. Use LIKE for case-insensitive matching.
    $select = $this->connection
      ->select(static::TABLE)
      ->fields(static::TABLE, [
      'alias',
    ])
      ->condition('source', $source, 'LIKE')
      ->condition('workspace', [
      $this->workspaceManager
        ->getActiveWorkspaceId(),
      0,
    ], 'IN');
    if ($langcode == LanguageInterface::LANGCODE_NOT_SPECIFIED) {
      array_pop($langcode_list);
    }
    elseif ($langcode > LanguageInterface::LANGCODE_NOT_SPECIFIED) {
      $select
        ->orderBy('langcode', 'DESC');
    }
    else {
      $select
        ->orderBy('langcode', 'ASC');
    }
    $select
      ->orderBy('pid', 'DESC');
    $select
      ->condition('langcode', $langcode_list, 'IN');
    try {
      return $select
        ->execute()
        ->fetchField();
    } catch (\Exception $e) {
      $this
        ->catchException($e);
      return FALSE;
    }
  }

  /**
   * {@inheritdoc}
   */
  public function lookupPathSource($path, $langcode) {
    if (!$this->connection
      ->schema()
      ->fieldExists('url_alias', 'workspace')) {
      return parent::lookupPathSource($path, $langcode);
    }
    $alias = $this->connection
      ->escapeLike($path);
    $langcode_list = [
      $langcode,
      LanguageInterface::LANGCODE_NOT_SPECIFIED,
    ];

    // See the queries above. Use LIKE for case-insensitive matching.
    $select = $this->connection
      ->select(static::TABLE)
      ->fields(static::TABLE, [
      'source',
    ])
      ->condition('alias', $alias, 'LIKE')
      ->condition('workspace', [
      $this->workspaceManager
        ->getActiveWorkspaceId(),
      0,
    ], 'IN');
    if ($langcode == LanguageInterface::LANGCODE_NOT_SPECIFIED) {
      array_pop($langcode_list);
    }
    elseif ($langcode > LanguageInterface::LANGCODE_NOT_SPECIFIED) {
      $select
        ->orderBy('langcode', 'DESC');
    }
    else {
      $select
        ->orderBy('langcode', 'ASC');
    }
    $select
      ->orderBy('pid', 'DESC');
    $select
      ->condition('langcode', $langcode_list, 'IN');
    try {
      return $select
        ->execute()
        ->fetchField();
    } catch (\Exception $e) {
      $this
        ->catchException($e);
      return FALSE;
    }
  }

  /**
   * {@inheritdoc}
   */
  public function aliasExists($alias, $langcode, $source = NULL) {
    if (!$this->connection
      ->schema()
      ->fieldExists('url_alias', 'workspace')) {
      return parent::aliasExists($alias, $langcode, $source);
    }

    // Use LIKE and NOT LIKE for case-insensitive matching.
    $query = $this->connection
      ->select(static::TABLE)
      ->condition('alias', $this->connection
      ->escapeLike($alias), 'LIKE')
      ->condition('langcode', $langcode)
      ->condition('workspace', [
      $this->workspaceManager
        ->getActiveWorkspaceId(),
      0,
    ], 'IN');
    if (!empty($source)) {
      $query
        ->condition('source', $this->connection
        ->escapeLike($source), 'NOT LIKE');
    }
    $query
      ->addExpression('1');
    $query
      ->range(0, 1);
    try {
      return (bool) $query
        ->execute()
        ->fetchField();
    } catch (\Exception $e) {
      $this
        ->catchException($e);
      return FALSE;
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getAliasesForAdminListing($header, $keys = NULL) {
    if (!$this->connection
      ->schema()
      ->fieldExists('url_alias', 'workspace')) {
      return parent::getAliasesForAdminListing($header, $keys);
    }
    $query = $this->connection
      ->select(static::TABLE)
      ->extend('Drupal\\Core\\Database\\Query\\PagerSelectExtender')
      ->extend('Drupal\\Core\\Database\\Query\\TableSortExtender');
    $query
      ->condition('workspace', [
      $this->workspaceManager
        ->getActiveWorkspaceId(),
      0,
    ], 'IN');
    if ($keys) {

      // Replace wildcards with PDO wildcards.
      $query
        ->condition('alias', '%' . preg_replace('!\\*+!', '%', $keys) . '%', 'LIKE');
    }
    try {
      return $query
        ->fields(static::TABLE)
        ->orderByHeader($header)
        ->limit(50)
        ->execute()
        ->fetchAll();
    } catch (\Exception $e) {
      $this
        ->catchException($e);
      return [];
    }
  }

  /**
   * @param string $entity_type_id
   *
   * @return bool
   */
  protected function isMultiversionableEntityType($entity_type_id) {
    try {
      $storage = $this->entityTypeManager
        ->getStorage($entity_type_id);
    } catch (InvalidPluginDefinitionException $exception) {
      return FALSE;
    }
    $entity_type = $storage
      ->getEntityType();
    $enabled = $this->state
      ->get('multiversion.migration_done.' . $entity_type_id, FALSE);
    if (is_subclass_of($entity_type
      ->getStorageClass(), ContentEntityStorageInterface::class) && $enabled) {
      return TRUE;
    }
    return FALSE;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AliasStorage::$connection protected property The database connection.
AliasStorage::$entityTypeManager protected property Overrides AliasStorage::$entityTypeManager
AliasStorage::$moduleHandler protected property The module handler.
AliasStorage::$state protected property The state service.
AliasStorage::$workspaceManager private property The workspace manager.
AliasStorage::addLanguageFallback protected function Adds path alias language fallback conditions to a select query object.
AliasStorage::aliasExists public function Checks if alias already exists. Overrides AliasStorage::aliasExists
AliasStorage::delete public function Deletes a URL alias. Overrides AliasStorageInterface::delete
AliasStorage::getAliasesForAdminListing public function Loads aliases for admin listing. Overrides AliasStorage::getAliasesForAdminListing
AliasStorage::getBaseQuery protected function Returns a SELECT query for the path_alias base table.
AliasStorage::getPathAliasEntityStorage protected function Returns the path alias entity storage handler.
AliasStorage::isMultiversionableEntityType protected function
AliasStorage::languageAliasExists public function Checks if there are any aliases with language defined. Overrides AliasStorageInterface::languageAliasExists
AliasStorage::load public function Fetches a specific URL alias from the database. Overrides AliasStorage::load
AliasStorage::lookupPathAlias public function Returns an alias of Drupal system URL. Overrides AliasStorage::lookupPathAlias
AliasStorage::lookupPathSource public function Returns Drupal system URL of an alias. Overrides AliasStorage::lookupPathSource
AliasStorage::pathHasMatchingAlias public function Check if any alias exists starting with $initial_substring. Overrides AliasStorageInterface::pathHasMatchingAlias
AliasStorage::preloadPathAlias public function Pre-loads path alias information for a given list of source paths. Overrides AliasStorageInterface::preloadPathAlias
AliasStorage::save public function Saves a path alias to the database. Overrides AliasStorage::save
AliasStorage::TABLE constant The table for the url_alias storage.
AliasStorage::__construct public function Constructs a Path CRUD object. Overrides AliasStorage::__construct