Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\Core\Entity;
Chris@0: 
Chris@0: use Drupal\Core\Entity\Schema\DynamicallyFieldableEntityStorageSchemaInterface;
Chris@0: use Drupal\Core\Entity\Schema\EntityStorageSchemaInterface;
Chris@0: use Drupal\Core\Field\BaseFieldDefinition;
Chris@0: use Drupal\Core\Field\FieldStorageDefinitionInterface;
Chris@0: use Drupal\Core\StringTranslation\StringTranslationTrait;
Chris@0: 
Chris@0: /**
Chris@0:  * Manages entity definition updates.
Chris@0:  */
Chris@0: class EntityDefinitionUpdateManager implements EntityDefinitionUpdateManagerInterface {
Chris@0:   use StringTranslationTrait;
Chris@0: 
Chris@0:   /**
Chris@0:    * The entity manager service.
Chris@0:    *
Chris@0:    * @var \Drupal\Core\Entity\EntityManagerInterface
Chris@0:    */
Chris@0:   protected $entityManager;
Chris@0: 
Chris@0:   /**
Chris@0:    * Constructs a new EntityDefinitionUpdateManager.
Chris@0:    *
Chris@0:    * @param \Drupal\Core\Entity\EntityManagerInterface $entity_manager
Chris@0:    *   The entity manager.
Chris@0:    */
Chris@0:   public function __construct(EntityManagerInterface $entity_manager) {
Chris@0:     $this->entityManager = $entity_manager;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function needsUpdates() {
Chris@0:     return (bool) $this->getChangeList();
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getChangeSummary() {
Chris@0:     $summary = [];
Chris@0: 
Chris@0:     foreach ($this->getChangeList() as $entity_type_id => $change_list) {
Chris@0:       // Process entity type definition changes.
Chris@0:       if (!empty($change_list['entity_type'])) {
Chris@0:         $entity_type = $this->entityManager->getDefinition($entity_type_id);
Chris@0: 
Chris@0:         switch ($change_list['entity_type']) {
Chris@0:           case static::DEFINITION_CREATED:
Chris@0:             $summary[$entity_type_id][] = $this->t('The %entity_type entity type needs to be installed.', ['%entity_type' => $entity_type->getLabel()]);
Chris@0:             break;
Chris@0: 
Chris@0:           case static::DEFINITION_UPDATED:
Chris@0:             $summary[$entity_type_id][] = $this->t('The %entity_type entity type needs to be updated.', ['%entity_type' => $entity_type->getLabel()]);
Chris@0:             break;
Chris@0:         }
Chris@0:       }
Chris@0: 
Chris@0:       // Process field storage definition changes.
Chris@0:       if (!empty($change_list['field_storage_definitions'])) {
Chris@0:         $storage_definitions = $this->entityManager->getFieldStorageDefinitions($entity_type_id);
Chris@0:         $original_storage_definitions = $this->entityManager->getLastInstalledFieldStorageDefinitions($entity_type_id);
Chris@0: 
Chris@0:         foreach ($change_list['field_storage_definitions'] as $field_name => $change) {
Chris@0:           switch ($change) {
Chris@0:             case static::DEFINITION_CREATED:
Chris@0:               $summary[$entity_type_id][] = $this->t('The %field_name field needs to be installed.', ['%field_name' => $storage_definitions[$field_name]->getLabel()]);
Chris@0:               break;
Chris@0: 
Chris@0:             case static::DEFINITION_UPDATED:
Chris@0:               $summary[$entity_type_id][] = $this->t('The %field_name field needs to be updated.', ['%field_name' => $storage_definitions[$field_name]->getLabel()]);
Chris@0:               break;
Chris@0: 
Chris@0:             case static::DEFINITION_DELETED:
Chris@0:               $summary[$entity_type_id][] = $this->t('The %field_name field needs to be uninstalled.', ['%field_name' => $original_storage_definitions[$field_name]->getLabel()]);
Chris@0:               break;
Chris@0:           }
Chris@0:         }
Chris@0:       }
Chris@0:     }
Chris@0: 
Chris@0:     return $summary;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function applyUpdates() {
Chris@0:     $complete_change_list = $this->getChangeList();
Chris@0:     if ($complete_change_list) {
Chris@0:       // self::getChangeList() only disables the cache and does not invalidate.
Chris@0:       // In case there are changes, explicitly invalidate caches.
Chris@0:       $this->entityManager->clearCachedDefinitions();
Chris@0:     }
Chris@0:     foreach ($complete_change_list as $entity_type_id => $change_list) {
Chris@0:       // Process entity type definition changes before storage definitions ones
Chris@0:       // this is necessary when you change an entity type from non-revisionable
Chris@0:       // to revisionable and at the same time add revisionable fields to the
Chris@0:       // entity type.
Chris@0:       if (!empty($change_list['entity_type'])) {
Chris@0:         $this->doEntityUpdate($change_list['entity_type'], $entity_type_id);
Chris@0:       }
Chris@0: 
Chris@0:       // Process field storage definition changes.
Chris@0:       if (!empty($change_list['field_storage_definitions'])) {
Chris@0:         $storage_definitions = $this->entityManager->getFieldStorageDefinitions($entity_type_id);
Chris@0:         $original_storage_definitions = $this->entityManager->getLastInstalledFieldStorageDefinitions($entity_type_id);
Chris@0: 
Chris@0:         foreach ($change_list['field_storage_definitions'] as $field_name => $change) {
Chris@0:           $storage_definition = isset($storage_definitions[$field_name]) ? $storage_definitions[$field_name] : NULL;
Chris@0:           $original_storage_definition = isset($original_storage_definitions[$field_name]) ? $original_storage_definitions[$field_name] : NULL;
Chris@0:           $this->doFieldUpdate($change, $storage_definition, $original_storage_definition);
Chris@0:         }
Chris@0:       }
Chris@0:     }
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getEntityType($entity_type_id) {
Chris@0:     $entity_type = $this->entityManager->getLastInstalledDefinition($entity_type_id);
Chris@0:     return $entity_type ? clone $entity_type : NULL;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function installEntityType(EntityTypeInterface $entity_type) {
Chris@0:     $this->entityManager->clearCachedDefinitions();
Chris@0:     $this->entityManager->onEntityTypeCreate($entity_type);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function updateEntityType(EntityTypeInterface $entity_type) {
Chris@0:     $original = $this->getEntityType($entity_type->id());
Chris@0:     $this->entityManager->clearCachedDefinitions();
Chris@0:     $this->entityManager->onEntityTypeUpdate($entity_type, $original);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function uninstallEntityType(EntityTypeInterface $entity_type) {
Chris@0:     $this->entityManager->clearCachedDefinitions();
Chris@0:     $this->entityManager->onEntityTypeDelete($entity_type);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function installFieldStorageDefinition($name, $entity_type_id, $provider, FieldStorageDefinitionInterface $storage_definition) {
Chris@0:     // @todo Pass a mutable field definition interface when we have one. See
Chris@0:     //   https://www.drupal.org/node/2346329.
Chris@0:     if ($storage_definition instanceof BaseFieldDefinition) {
Chris@0:       $storage_definition
Chris@0:         ->setName($name)
Chris@0:         ->setTargetEntityTypeId($entity_type_id)
Chris@0:         ->setProvider($provider)
Chris@0:         ->setTargetBundle(NULL);
Chris@0:     }
Chris@0:     $this->entityManager->clearCachedDefinitions();
Chris@0:     $this->entityManager->onFieldStorageDefinitionCreate($storage_definition);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getFieldStorageDefinition($name, $entity_type_id) {
Chris@0:     $storage_definitions = $this->entityManager->getLastInstalledFieldStorageDefinitions($entity_type_id);
Chris@0:     return isset($storage_definitions[$name]) ? clone $storage_definitions[$name] : NULL;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function updateFieldStorageDefinition(FieldStorageDefinitionInterface $storage_definition) {
Chris@0:     $original = $this->getFieldStorageDefinition($storage_definition->getName(), $storage_definition->getTargetEntityTypeId());
Chris@0:     $this->entityManager->clearCachedDefinitions();
Chris@0:     $this->entityManager->onFieldStorageDefinitionUpdate($storage_definition, $original);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function uninstallFieldStorageDefinition(FieldStorageDefinitionInterface $storage_definition) {
Chris@0:     $this->entityManager->clearCachedDefinitions();
Chris@0:     $this->entityManager->onFieldStorageDefinitionDelete($storage_definition);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Performs an entity type definition update.
Chris@0:    *
Chris@0:    * @param string $op
Chris@0:    *   The operation to perform, either static::DEFINITION_CREATED or
Chris@0:    *   static::DEFINITION_UPDATED.
Chris@0:    * @param string $entity_type_id
Chris@0:    *   The entity type ID.
Chris@0:    */
Chris@0:   protected function doEntityUpdate($op, $entity_type_id) {
Chris@0:     $entity_type = $this->entityManager->getDefinition($entity_type_id);
Chris@0:     switch ($op) {
Chris@0:       case static::DEFINITION_CREATED:
Chris@0:         $this->entityManager->onEntityTypeCreate($entity_type);
Chris@0:         break;
Chris@0: 
Chris@0:       case static::DEFINITION_UPDATED:
Chris@0:         $original = $this->entityManager->getLastInstalledDefinition($entity_type_id);
Chris@0:         $this->entityManager->onEntityTypeUpdate($entity_type, $original);
Chris@0:         break;
Chris@0:     }
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Performs a field storage definition update.
Chris@0:    *
Chris@0:    * @param string $op
Chris@0:    *   The operation to perform, possible values are static::DEFINITION_CREATED,
Chris@0:    *   static::DEFINITION_UPDATED or static::DEFINITION_DELETED.
Chris@0:    * @param array|null $storage_definition
Chris@0:    *   The new field storage definition.
Chris@0:    * @param array|null $original_storage_definition
Chris@0:    *   The original field storage definition.
Chris@0:    */
Chris@0:   protected function doFieldUpdate($op, $storage_definition = NULL, $original_storage_definition = NULL) {
Chris@0:     switch ($op) {
Chris@0:       case static::DEFINITION_CREATED:
Chris@0:         $this->entityManager->onFieldStorageDefinitionCreate($storage_definition);
Chris@0:         break;
Chris@0: 
Chris@0:       case static::DEFINITION_UPDATED:
Chris@0:         $this->entityManager->onFieldStorageDefinitionUpdate($storage_definition, $original_storage_definition);
Chris@0:         break;
Chris@0: 
Chris@0:       case static::DEFINITION_DELETED:
Chris@0:         $this->entityManager->onFieldStorageDefinitionDelete($original_storage_definition);
Chris@0:         break;
Chris@0:     }
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Gets a list of changes to entity type and field storage definitions.
Chris@0:    *
Chris@0:    * @return array
Chris@0:    *   An associative array keyed by entity type id of change descriptors. Every
Chris@0:    *   entry is an associative array with the following optional keys:
Chris@0:    *   - entity_type: a scalar having only the DEFINITION_UPDATED value.
Chris@0:    *   - field_storage_definitions: an associative array keyed by field name of
Chris@0:    *     scalars having one value among:
Chris@0:    *     - DEFINITION_CREATED
Chris@0:    *     - DEFINITION_UPDATED
Chris@0:    *     - DEFINITION_DELETED
Chris@0:    */
Chris@0:   protected function getChangeList() {
Chris@0:     $this->entityManager->useCaches(FALSE);
Chris@0:     $change_list = [];
Chris@0: 
Chris@0:     foreach ($this->entityManager->getDefinitions() as $entity_type_id => $entity_type) {
Chris@0:       $original = $this->entityManager->getLastInstalledDefinition($entity_type_id);
Chris@0: 
Chris@0:       // @todo Support non-storage-schema-changing definition updates too:
Chris@0:       //   https://www.drupal.org/node/2336895.
Chris@0:       if (!$original) {
Chris@0:         $change_list[$entity_type_id]['entity_type'] = static::DEFINITION_CREATED;
Chris@0:       }
Chris@0:       else {
Chris@0:         if ($this->requiresEntityStorageSchemaChanges($entity_type, $original)) {
Chris@0:           $change_list[$entity_type_id]['entity_type'] = static::DEFINITION_UPDATED;
Chris@0:         }
Chris@0: 
Chris@0:         if ($this->entityManager->getStorage($entity_type_id) instanceof DynamicallyFieldableEntityStorageInterface) {
Chris@0:           $field_changes = [];
Chris@0:           $storage_definitions = $this->entityManager->getFieldStorageDefinitions($entity_type_id);
Chris@0:           $original_storage_definitions = $this->entityManager->getLastInstalledFieldStorageDefinitions($entity_type_id);
Chris@0: 
Chris@0:           // Detect created field storage definitions.
Chris@0:           foreach (array_diff_key($storage_definitions, $original_storage_definitions) as $field_name => $storage_definition) {
Chris@0:             $field_changes[$field_name] = static::DEFINITION_CREATED;
Chris@0:           }
Chris@0: 
Chris@0:           // Detect deleted field storage definitions.
Chris@0:           foreach (array_diff_key($original_storage_definitions, $storage_definitions) as $field_name => $original_storage_definition) {
Chris@0:             $field_changes[$field_name] = static::DEFINITION_DELETED;
Chris@0:           }
Chris@0: 
Chris@0:           // Detect updated field storage definitions.
Chris@0:           foreach (array_intersect_key($storage_definitions, $original_storage_definitions) as $field_name => $storage_definition) {
Chris@0:             // @todo Support non-storage-schema-changing definition updates too:
Chris@0:             //   https://www.drupal.org/node/2336895. So long as we're checking
Chris@0:             //   based on schema change requirements rather than definition
Chris@0:             //   equality, skip the check if the entity type itself needs to be
Chris@0:             //   updated, since that can affect the schema of all fields, so we
Chris@0:             //   want to process that update first without reporting false
Chris@0:             //   positives here.
Chris@0:             if (!isset($change_list[$entity_type_id]['entity_type']) && $this->requiresFieldStorageSchemaChanges($storage_definition, $original_storage_definitions[$field_name])) {
Chris@0:               $field_changes[$field_name] = static::DEFINITION_UPDATED;
Chris@0:             }
Chris@0:           }
Chris@0: 
Chris@0:           if ($field_changes) {
Chris@0:             $change_list[$entity_type_id]['field_storage_definitions'] = $field_changes;
Chris@0:           }
Chris@0:         }
Chris@0:       }
Chris@0:     }
Chris@0: 
Chris@0:     // @todo Support deleting entity definitions when we support base field
Chris@0:     //   purging. See https://www.drupal.org/node/2282119.
Chris@0: 
Chris@0:     $this->entityManager->useCaches(TRUE);
Chris@0: 
Chris@0:     return array_filter($change_list);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Checks if the changes to the entity type requires storage schema changes.
Chris@0:    *
Chris@0:    * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
Chris@0:    *   The updated entity type definition.
Chris@0:    * @param \Drupal\Core\Entity\EntityTypeInterface $original
Chris@0:    *   The original entity type definition.
Chris@0:    *
Chris@0:    * @return bool
Chris@0:    *   TRUE if storage schema changes are required, FALSE otherwise.
Chris@0:    */
Chris@0:   protected function requiresEntityStorageSchemaChanges(EntityTypeInterface $entity_type, EntityTypeInterface $original) {
Chris@0:     $storage = $this->entityManager->getStorage($entity_type->id());
Chris@0:     return ($storage instanceof EntityStorageSchemaInterface) && $storage->requiresEntityStorageSchemaChanges($entity_type, $original);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Checks if the changes to the storage definition requires schema changes.
Chris@0:    *
Chris@0:    * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $storage_definition
Chris@0:    *   The updated field storage definition.
Chris@0:    * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $original
Chris@0:    *   The original field storage definition.
Chris@0:    *
Chris@0:    * @return bool
Chris@0:    *   TRUE if storage schema changes are required, FALSE otherwise.
Chris@0:    */
Chris@0:   protected function requiresFieldStorageSchemaChanges(FieldStorageDefinitionInterface $storage_definition, FieldStorageDefinitionInterface $original) {
Chris@0:     $storage = $this->entityManager->getStorage($storage_definition->getTargetEntityTypeId());
Chris@0:     return ($storage instanceof DynamicallyFieldableEntityStorageSchemaInterface) && $storage->requiresFieldStorageSchemaChanges($storage_definition, $original);
Chris@0:   }
Chris@0: 
Chris@0: }