diff --git a/core/lib/Drupal/Core/Entity/ContentEntityDatabaseStorage.php b/core/lib/Drupal/Core/Entity/ContentEntityDatabaseStorage.php index 620c474..4a20f49 100644 --- a/core/lib/Drupal/Core/Entity/ContentEntityDatabaseStorage.php +++ b/core/lib/Drupal/Core/Entity/ContentEntityDatabaseStorage.php @@ -11,7 +11,6 @@ use Drupal\Core\Cache\CacheBackendInterface; use Drupal\Core\Database\Connection; use Drupal\Core\Database\Database; -use Drupal\Core\Entity\Exception\FieldStorageDefinitionUpdateForbiddenException; use Drupal\Core\Entity\Query\QueryInterface; use Drupal\Core\Entity\Schema\ContentEntitySchemaProviderInterface; use Drupal\Core\Entity\Sql\DefaultTableMapping; @@ -29,9 +28,8 @@ * * The class uses \Drupal\Core\Entity\Schema\SqlContentEntityStorageSchema * internally in order to automatically generate the database schema based on - * the defined base fields. Entity types can override - * ContentEntityDatabaseStorage::getSchema() to customize the generated - * schema; e.g., to add additional indexes. + * the defined base fields. Entity types can override the schema handler to + * customize the generated schema; e.g., to add additional indexes. * * @ingroup entity_api */ @@ -105,7 +103,7 @@ class ContentEntityDatabaseStorage extends ContentEntityStorageBase implements S /** * The entity schema handler. * - * @var \Drupal\Core\Entity\Schema\EntitySchemaHandlerInterface + * @var \Drupal\Core\Entity\Schema\ContentEntitySchemaHandlerInterface */ protected $schemaHandler; @@ -153,15 +151,27 @@ public function getFieldStorageDefinitions() { */ public function __construct(EntityTypeInterface $entity_type, Connection $database, EntityManagerInterface $entity_manager, CacheBackendInterface $cache) { parent::__construct($entity_type); - $this->database = $database; $this->entityManager = $entity_manager; $this->cacheBackend = $cache; + $this->initTableLayout(); + } + + /** + * Initializes table name variables. + */ + protected function initTableLayout() { + // Reset table field values to ensure changes in the entity type definition + // are correctly reflected in the table layout. + $this->tableMapping = NULL; + $this->revisionKey = NULL; + $this->revisionTable = NULL; + $this->dataTable = NULL; + $this->revisionDataTable = NULL; // @todo Remove table names from the entity type definition in // https://drupal.org/node/2232465 $this->baseTable = $this->entityType->getBaseTable() ?: $this->entityTypeId; - $revisionable = $this->entityType->isRevisionable(); if ($revisionable) { $this->revisionKey = $this->entityType->getKey('revision') ?: 'revision_id'; @@ -246,18 +256,38 @@ protected function schemaHandler() { } /** + * Updates the wrapped entity type definition. + * + * @param ContentEntityTypeInterface $entity_type + * The update entity type. + * + * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0. + * See https://www.drupal.org/node/2274017. + */ + public function setEntityType(ContentEntityTypeInterface $entity_type) { + if ($this->entityType->id() == $entity_type->id()) { + $this->entityType = $entity_type; + $this->initTableLayout(); + } + else { + throw new EntityStorageException(String::format('Unsupported entity type @id', array('@id' => $entity_type->id()))); + } + } + + /** * {@inheritdoc} */ - public function getTableMapping() { - if (!isset($this->tableMapping)) { + public function getTableMapping(array $storage_definitions = NULL) { + $table_mapping = $this->tableMapping; + + if (!isset($this->tableMapping) || $storage_definitions) { + $definitions = $storage_definitions ?: $this->entityManager->getFieldStorageDefinitions($this->entityTypeId); + $base_field_definitions = $this->entityManager->getBaseFieldDefinitions($this->entityTypeId); + $table_mapping = new DefaultTableMapping($definitions, $base_field_definitions); - $definitions = array_filter($this->getFieldStorageDefinitions(), function (FieldStorageDefinitionInterface $definition) { - // @todo Remove the check for FieldDefinitionInterface::isMultiple() when - // multiple-value base fields are supported in - // https://drupal.org/node/2248977. - return !$definition->hasCustomStorage() && !$definition->isMultiple(); + $definitions = array_filter($definitions, function (FieldStorageDefinitionInterface $definition) use ($table_mapping) { + return $table_mapping->allowsSharedTableStorage($definition); }); - $this->tableMapping = new DefaultTableMapping($definitions); $key_fields = array_values(array_filter(array($this->idKey, $this->revisionKey, $this->bundleKey, $this->uuidKey, $this->langcodeKey))); $all_fields = array_keys($definitions); @@ -285,16 +315,16 @@ public function getTableMapping() { $translatable = $this->entityType->getDataTable() && $this->entityType->isTranslatable(); if (!$revisionable && !$translatable) { // The base layout stores all the base field values in the base table. - $this->tableMapping->setFieldNames($this->baseTable, $all_fields); + $table_mapping->setFieldNames($this->baseTable, $all_fields); } elseif ($revisionable && !$translatable) { // The revisionable layout stores all the base field values in the base // table, except for revision metadata fields. Revisionable fields // denormalized in the base table but also stored in the revision table // together with the entity ID and the revision ID as identifiers. - $this->tableMapping->setFieldNames($this->baseTable, array_diff($all_fields, $revision_metadata_fields)); + $table_mapping->setFieldNames($this->baseTable, array_diff($all_fields, $revision_metadata_fields)); $revision_key_fields = array($this->idKey, $this->revisionKey); - $this->tableMapping->setFieldNames($this->revisionTable, array_merge($revision_key_fields, $revisionable_fields)); + $table_mapping->setFieldNames($this->revisionTable, array_merge($revision_key_fields, $revisionable_fields)); } elseif (!$revisionable && $translatable) { // Multilingual layouts store key field values in the base table. The @@ -303,7 +333,7 @@ public function getTableMapping() { // denormalized copy of the bundle field value to allow for more // performant queries. This means that only the UUID is not stored on // the data table. - $this->tableMapping + $table_mapping ->setFieldNames($this->baseTable, $key_fields) ->setFieldNames($this->dataTable, array_values(array_diff($all_fields, array($this->uuidKey)))) // Add the denormalized 'default_langcode' field to the mapping. Its @@ -319,13 +349,13 @@ public function getTableMapping() { // holds the data field values for all non-revisionable fields. The data // field values of revisionable fields are denormalized in the data // table, as well. - $this->tableMapping->setFieldNames($this->baseTable, array_values(array_diff($key_fields, array($this->langcodeKey)))); + $table_mapping->setFieldNames($this->baseTable, array_values(array_diff($key_fields, array($this->langcodeKey)))); // Like in the multilingual, non-revisionable case the UUID is not // in the data table. Additionally, do not store revision metadata // fields in the data table. $data_fields = array_values(array_diff($all_fields, array($this->uuidKey), $revision_metadata_fields)); - $this->tableMapping + $table_mapping ->setFieldNames($this->dataTable, $data_fields) // Add the denormalized 'default_langcode' field to the mapping. Its // value is identical to the query expression @@ -334,20 +364,43 @@ public function getTableMapping() { ->setExtraColumns($this->dataTable, array('default_langcode')); $revision_base_fields = array_merge(array($this->idKey, $this->revisionKey, $this->langcodeKey), $revision_metadata_fields); - $this->tableMapping->setFieldNames($this->revisionTable, $revision_base_fields); + $table_mapping->setFieldNames($this->revisionTable, $revision_base_fields); $revision_data_key_fields = array($this->idKey, $this->revisionKey, $this->langcodeKey); - $revision_data_fields = array_diff($revisionable_fields, $revision_metadata_fields); - $this->tableMapping + $revision_data_fields = array_diff($revisionable_fields, $revision_metadata_fields, array($this->langcodeKey)); + $table_mapping ->setFieldNames($this->revisionDataTable, array_merge($revision_data_key_fields, $revision_data_fields)) // Add the denormalized 'default_langcode' field to the mapping. Its // value is identical to the query expression // "revision_table.langcode = data_table.langcode". ->setExtraColumns($this->revisionDataTable, array('default_langcode')); } + + // Add dedicated tables. + $definitions = array_filter($definitions, function (FieldStorageDefinitionInterface $definition) use ($table_mapping) { + return $table_mapping->requiresDedicatedTableStorage($definition); + }); + $extra_columns = array( + 'bundle', + 'deleted', + 'entity_id', + 'revision_id', + 'langcode', + 'delta', + ); + foreach ($definitions as $field_name => $definition) { + foreach (array($table_mapping->getDedicatedDataTableName($definition), $table_mapping->getDedicatedRevisionTableName($definition)) as $table_name) { + $table_mapping->setFieldNames($table_name, array($field_name)); + $table_mapping->setExtraColumns($table_name, $extra_columns); + } + } + + if (!$storage_definitions) { + $this->tableMapping = $table_mapping; + } } - return $this->tableMapping; + return $table_mapping; } /** @@ -594,7 +647,7 @@ protected function attachPropertyData(array &$entities) { $table_mapping = $this->getTableMapping(); $translations = array(); if ($this->revisionDataTable) { - $data_fields = array_diff_key($table_mapping->getFieldNames($this->revisionDataTable), $table_mapping->getFieldNames($this->baseTable)); + $data_fields = array_diff($table_mapping->getFieldNames($this->revisionDataTable), $table_mapping->getFieldNames($this->baseTable)); } else { $data_fields = $table_mapping->getFieldNames($this->dataTable); @@ -1163,7 +1216,7 @@ protected function loadFieldItems(array $entities) { $definitions[$bundle] = $this->entityManager->getFieldDefinitions($this->entityTypeId, $bundle); foreach ($definitions[$bundle] as $field_name => $field_definition) { $storage_definition = $field_definition->getFieldStorageDefinition(); - if ($this->usesDedicatedTable($storage_definition)) { + if ($table_mapping->requiresDedicatedTableStorage($storage_definition)) { $storage_definitions[$field_name] = $storage_definition; } } @@ -1238,7 +1291,7 @@ protected function saveFieldItems(EntityInterface $entity, $update = TRUE) { foreach ($this->entityManager->getFieldDefinitions($entity_type, $bundle) as $field_name => $field_definition) { $storage_definition = $field_definition->getFieldStorageDefinition(); - if (!$this->usesDedicatedTable($storage_definition)) { + if (!$table_mapping->requiresDedicatedTableStorage($storage_definition)) { continue; } $table_name = $table_mapping->getDedicatedDataTableName($storage_definition); @@ -1253,10 +1306,12 @@ protected function saveFieldItems(EntityInterface $entity, $update = TRUE) { ->condition('entity_id', $id) ->execute(); } - $this->database->delete($revision_name) - ->condition('entity_id', $id) - ->condition('revision_id', $vid) - ->execute(); + if ($this->entityType->isRevisionable()) { + $this->database->delete($revision_name) + ->condition('entity_id', $id) + ->condition('revision_id', $vid) + ->execute(); + } } // Prepare the multi-insert query. @@ -1266,7 +1321,9 @@ protected function saveFieldItems(EntityInterface $entity, $update = TRUE) { $columns[] = $table_mapping->getFieldColumnName($storage_definition, $column); } $query = $this->database->insert($table_name)->fields($columns); - $revision_query = $this->database->insert($revision_name)->fields($columns); + if ($this->entityType->isRevisionable()) { + $revision_query = $this->database->insert($revision_name)->fields($columns); + } $langcodes = $field_definition->isTranslatable() ? $translation_langcodes : array($default_langcode); foreach ($langcodes as $langcode) { @@ -1289,7 +1346,9 @@ protected function saveFieldItems(EntityInterface $entity, $update = TRUE) { $record[$column_name] = !empty($attributes['serialize']) ? serialize($item->$column) : $item->$column; } $query->values($record); - $revision_query->values($record); + if ($this->entityType->isRevisionable()) { + $revision_query->values($record); + } if ($storage_definition->getCardinality() != FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED && ++$delta_count == $storage_definition->getCardinality()) { break; @@ -1304,7 +1363,9 @@ protected function saveFieldItems(EntityInterface $entity, $update = TRUE) { if ($entity->isDefaultRevision()) { $query->execute(); } - $revision_query->execute(); + if ($this->entityType->isRevisionable()) { + $revision_query->execute(); + } } } } @@ -1319,7 +1380,7 @@ protected function deleteFieldItems(EntityInterface $entity) { $table_mapping = $this->getTableMapping(); foreach ($this->entityManager->getFieldDefinitions($entity->getEntityTypeId(), $entity->bundle()) as $field_definition) { $storage_definition = $field_definition->getFieldStorageDefinition(); - if (!$this->usesDedicatedTable($storage_definition)) { + if (!$table_mapping->requiresDedicatedTableStorage($storage_definition)) { continue; } $table_name = $table_mapping->getDedicatedDataTableName($storage_definition); @@ -1327,9 +1388,11 @@ protected function deleteFieldItems(EntityInterface $entity) { $this->database->delete($table_name) ->condition('entity_id', $entity->id()) ->execute(); - $this->database->delete($revision_name) - ->condition('entity_id', $entity->id()) - ->execute(); + if ($this->entityType->isRevisionable()) { + $this->database->delete($revision_name) + ->condition('entity_id', $entity->id()) + ->execute(); + } } } @@ -1345,7 +1408,7 @@ protected function deleteFieldItemsRevision(EntityInterface $entity) { $table_mapping = $this->getTableMapping(); foreach ($this->entityManager->getFieldDefinitions($entity->getEntityTypeId(), $entity->bundle()) as $field_definition) { $storage_definition = $field_definition->getFieldStorageDefinition(); - if (!$this->usesDedicatedTable($storage_definition)) { + if (!$table_mapping->requiresDedicatedTableStorage($storage_definition)) { continue; } $revision_name = $table_mapping->getDedicatedRevisionTableName($storage_definition); @@ -1358,21 +1421,6 @@ protected function deleteFieldItemsRevision(EntityInterface $entity) { } /** - * Returns whether the field uses a dedicated table for storage. - * - * @param FieldStorageDefinitionInterface $definition - * The field storage definition. - * - * @return bool - * Whether the field uses a dedicated table for storage. - */ - protected function usesDedicatedTable(FieldStorageDefinitionInterface $definition) { - // Everything that is not provided by the entity type is stored in a - // dedicated table. - return $definition->getProvider() != $this->entityType->getProvider() && !$definition->hasCustomStorage(); - } - - /** * {@inheritdoc} */ public function requiresEntitySchemaChanges(ContentEntityTypeInterface $definition, ContentEntityTypeInterface $original) { @@ -1411,6 +1459,12 @@ public function onEntityTypeCreate(EntityTypeInterface $entity_type) { * {@inheritdoc} */ public function onEntityTypeUpdate(EntityTypeInterface $entity_type, EntityTypeInterface $original) { + // Ensure we have an updated entity type definition. + $this->entityType = $this->entityManager->getDefinition($this->entityTypeId); + // The table layout may have changed depending on the new entity type + // definition. + $this->initTableLayout(); + // Let the schema handler adapt to possible table layout changes. $this->schemaHandler()->onEntityTypeUpdate($entity_type, $original); } @@ -1425,15 +1479,14 @@ public function onEntityTypeDelete(EntityTypeInterface $entity_type) { * {@inheritdoc} */ public function onFieldStorageDefinitionCreate(FieldStorageDefinitionInterface $storage_definition) { - $schema = $this->_fieldSqlSchema($storage_definition); - foreach ($schema as $name => $table) { - $this->database->schema()->createTable($name, $table); + // If we are adding a field stored in a shared table we need to recompute + // the table mapping. + // @todo This does not belong here. Remove it once we are able to generate a + // fresh table mapping in the schema handler. See + // https://www.drupal.org/node/2274017. + if ($this->getTableMapping()->allowsSharedTableStorage($storage_definition)) { + $this->tableMapping = NULL; } - - // @todo Move all of the above code into the schema handler: - // https://www.drupal.org/node/1498720. - // Even before doing that, we still forward to the schema handler so that - // it can notify the schema manager. $this->schemaHandler()->onFieldStorageDefinitionCreate($storage_definition); } @@ -1441,91 +1494,6 @@ public function onFieldStorageDefinitionCreate(FieldStorageDefinitionInterface $ * {@inheritdoc} */ public function onFieldStorageDefinitionUpdate(FieldStorageDefinitionInterface $storage_definition, FieldStorageDefinitionInterface $original) { - if (!$storage_definition->hasData()) { - // There is no data. Re-create the tables completely. - - if ($this->database->supportsTransactionalDDL()) { - // If the database supports transactional DDL, we can go ahead and rely - // on it. If not, we will have to rollback manually if something fails. - $transaction = $this->database->startTransaction(); - } - - try { - $original_schema = $this->_fieldSqlSchema($original); - foreach ($original_schema as $name => $table) { - $this->database->schema()->dropTable($name, $table); - } - $schema = $this->_fieldSqlSchema($storage_definition); - foreach ($schema as $name => $table) { - $this->database->schema()->createTable($name, $table); - } - } - catch (\Exception $e) { - if ($this->database->supportsTransactionalDDL()) { - $transaction->rollback(); - } - else { - // Recreate tables. - $original_schema = $this->_fieldSqlSchema($original); - foreach ($original_schema as $name => $table) { - if (!$this->database->schema()->tableExists($name)) { - $this->database->schema()->createTable($name, $table); - } - } - } - throw $e; - } - } - else { - if ($storage_definition->getColumns() != $original->getColumns()) { - throw new FieldStorageDefinitionUpdateForbiddenException("The SQL storage cannot change the schema for an existing field with data."); - } - // There is data, so there are no column changes. Drop all the prior - // indexes and create all the new ones, except for all the priors that - // exist unchanged. - $table_mapping = $this->getTableMapping(); - $table = $table_mapping->getDedicatedDataTableName($original); - $revision_table = $table_mapping->getDedicatedRevisionTableName($original); - - $schema = $storage_definition->getSchema(); - $original_schema = $original->getSchema(); - - foreach ($original_schema['indexes'] as $name => $columns) { - if (!isset($schema['indexes'][$name]) || $columns != $schema['indexes'][$name]) { - $real_name = static::_fieldIndexName($storage_definition, $name); - $this->database->schema()->dropIndex($table, $real_name); - $this->database->schema()->dropIndex($revision_table, $real_name); - } - } - $table = $table_mapping->getDedicatedDataTableName($storage_definition); - $revision_table = $table_mapping->getDedicatedRevisionTableName($storage_definition); - foreach ($schema['indexes'] as $name => $columns) { - if (!isset($original_schema['indexes'][$name]) || $columns != $original_schema['indexes'][$name]) { - $real_name = static::_fieldIndexName($storage_definition, $name); - $real_columns = array(); - foreach ($columns as $column_name) { - // Indexes can be specified as either a column name or an array with - // column name and length. Allow for either case. - if (is_array($column_name)) { - $real_columns[] = array( - $table_mapping->getFieldColumnName($storage_definition, $column_name[0]), - $column_name[1], - ); - } - else { - $real_columns[] = $table_mapping->getFieldColumnName($storage_definition, $column_name); - } - } - $this->database->schema()->addIndex($table, $real_name, $real_columns); - $this->database->schema()->addIndex($revision_table, $real_name, $real_columns); - } - } - } - - // @todo Move all of the above code into the schema handler: - // https://www.drupal.org/node/1498720. - // Even before doing that, we still forward to the schema handler so that - // it can notify the schema manager. $this->schemaHandler()->onFieldStorageDefinitionUpdate($storage_definition, $original); } @@ -1535,24 +1503,21 @@ public function onFieldStorageDefinitionUpdate(FieldStorageDefinitionInterface $ public function onFieldStorageDefinitionDelete(FieldStorageDefinitionInterface $storage_definition) { $table_mapping = $this->getTableMapping(); - // Mark all data associated with the field for deletion. - $table = $table_mapping->getDedicatedDataTableName($storage_definition); - $revision_table = $table_mapping->getDedicatedRevisionTableName($storage_definition); - $this->database->update($table) - ->fields(array('deleted' => 1)) - ->execute(); + if ($table_mapping->requiresDedicatedTableStorage($storage_definition)) { + // Mark all data associated with the field for deletion. + $table = $table_mapping->getDedicatedDataTableName($storage_definition); + $revision_table = $table_mapping->getDedicatedRevisionTableName($storage_definition); + $this->database->update($table) + ->fields(array('deleted' => 1)) + ->execute(); + if ($this->entityType->isRevisionable()) { + $this->database->update($revision_table) + ->fields(array('deleted' => 1)) + ->execute(); + } + } - // Move the table to a unique name while the table contents are being - // deleted. - $new_table = $table_mapping->getDedicatedDataTableName($storage_definition, TRUE); - $revision_new_table = $table_mapping->getDedicatedRevisionTableName($storage_definition, TRUE); - $this->database->schema()->renameTable($table, $new_table); - $this->database->schema()->renameTable($revision_table, $revision_new_table); - - // @todo Move all of the above code into the schema handler: - // https://www.drupal.org/node/1498720. - // Even before doing that, we still forward to the schema handler so that - // it can notify the schema manager. + // Update the field schema. $this->schemaHandler()->onFieldStorageDefinitionDelete($storage_definition); } @@ -1563,16 +1528,20 @@ public function onFieldDefinitionDelete(FieldDefinitionInterface $field_definiti $table_mapping = $this->getTableMapping(); $storage_definition = $field_definition->getFieldStorageDefinition(); // Mark field data as deleted. - $table_name = $table_mapping->getDedicatedDataTableName($storage_definition); - $revision_name = $table_mapping->getDedicatedRevisionTableName($storage_definition); - $this->database->update($table_name) - ->fields(array('deleted' => 1)) - ->condition('bundle', $field_definition->getBundle()) - ->execute(); - $this->database->update($revision_name) - ->fields(array('deleted' => 1)) - ->condition('bundle', $field_definition->getBundle()) - ->execute(); + if ($table_mapping->requiresDedicatedTableStorage($storage_definition)) { + $table_name = $table_mapping->getDedicatedDataTableName($storage_definition); + $revision_name = $table_mapping->getDedicatedRevisionTableName($storage_definition); + $this->database->update($table_name) + ->fields(array('deleted' => 1)) + ->condition('bundle', $field_definition->getBundle()) + ->execute(); + if ($this->entityType->isRevisionable()) { + $this->database->update($revision_name) + ->fields(array('deleted' => 1)) + ->condition('bundle', $field_definition->getBundle()) + ->execute(); + } + } } /** @@ -1591,7 +1560,7 @@ public function onBundleRename($bundle, $bundle_new) { foreach ($field_definitions as $field_definition) { $storage_definition = $field_definition->getFieldStorageDefinition(); - if ($this->usesDedicatedTable($storage_definition)) { + if ($table_mapping->requiresDedicatedTableStorage($storage_definition)) { $is_deleted = $this->storageDefinitionIsDeleted($storage_definition); $table_name = $table_mapping->getDedicatedDataTableName($storage_definition, $is_deleted); $revision_name = $table_mapping->getDedicatedRevisionTableName($storage_definition, $is_deleted); @@ -1599,10 +1568,12 @@ public function onBundleRename($bundle, $bundle_new) { ->fields(array('bundle' => $bundle_new)) ->condition('bundle', $bundle) ->execute(); - $this->database->update($revision_name) - ->fields(array('bundle' => $bundle_new)) - ->condition('bundle', $bundle) - ->execute(); + if ($this->entityType->isRevisionable()) { + $this->database->update($revision_name) + ->fields(array('bundle' => $bundle_new)) + ->condition('bundle', $bundle) + ->execute(); + } } } } @@ -1680,20 +1651,18 @@ protected function purgeFieldItems(ContentEntityInterface $entity, FieldDefiniti $this->database->delete($table_name) ->condition('revision_id', $revision_id) ->execute(); - $this->database->delete($revision_name) - ->condition('revision_id', $revision_id) - ->execute(); + if ($this->entityType->isRevisionable()) { + $this->database->delete($revision_name) + ->condition('revision_id', $revision_id) + ->execute(); + } } /** * {@inheritdoc} */ public function finalizePurge(FieldStorageDefinitionInterface $storage_definition) { - $table_mapping = $this->getTableMapping(); - $table_name = $table_mapping->getDedicatedDataTableName($storage_definition, TRUE); - $revision_name = $table_mapping->getDedicatedRevisionTableName($storage_definition, TRUE); - $this->database->schema()->dropTable($table_name); - $this->database->schema()->dropTable($revision_name); + $this->schemaHandler()->finalizePurge($storage_definition); } /** @@ -1702,230 +1671,66 @@ public function finalizePurge(FieldStorageDefinitionInterface $storage_definitio public function countFieldData($storage_definition, $as_bool = FALSE) { $table_mapping = $this->getTableMapping(); - $is_deleted = $this->storageDefinitionIsDeleted($storage_definition); - $table_name = $table_mapping->getDedicatedDataTableName($storage_definition, $is_deleted); - $query = $this->database->select($table_name, 't'); - $or = $query->orConditionGroup(); - foreach ($storage_definition->getColumns() as $column_name => $data) { - $or->isNotNull($table_mapping->getFieldColumnName($storage_definition, $column_name)); - } - $query - ->condition($or) - ->fields('t', array('entity_id')) - ->distinct(TRUE); - // If we are performing the query just to check if the field has data - // limit the number of rows. - if ($as_bool) { - $query->range(0, 1); - } - $count = $query->countQuery()->execute()->fetchField(); - return $as_bool ? (bool) $count : (int) $count; - } - - /** - * Returns whether the passed field has been already deleted. - * - * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $storage_definition - * The field storage definition. - * - * @return bool - * Whether the field has been already deleted. - */ - protected function storageDefinitionIsDeleted(FieldStorageDefinitionInterface $storage_definition) { - return !array_key_exists($storage_definition->getName(), $this->entityManager->getFieldStorageDefinitions($this->entityTypeId)); - } - - /** - * Gets the SQL table schema. - * - * @private Calling this function circumvents the entity system and is - * strongly discouraged. This function is not considered part of the public - * API and modules relying on it might break even in minor releases. - * - * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $storage_definition - * The field storage definition. - * @param array $schema - * The field schema array. Mandatory for upgrades, omit otherwise. - * @param bool $deleted - * (optional) Whether the schema of the table holding the values of a - * deleted field should be returned. - * - * @return array - * The same as a hook_schema() implementation for the data and the - * revision tables. - * - * @see hook_schema() - */ - public static function _fieldSqlSchema(FieldStorageDefinitionInterface $storage_definition, array $schema = NULL, $deleted = FALSE) { - $table_mapping = new DefaultTableMapping(array()); - - $description_current = "Data storage for {$storage_definition->getTargetEntityTypeId()} field {$storage_definition->getName()}."; - $description_revision = "Revision archive storage for {$storage_definition->getTargetEntityTypeId()} field {$storage_definition->getName()}."; - - $entity_type_id = $storage_definition->getTargetEntityTypeId(); - $entity_manager = \Drupal::entityManager(); - $entity_type = $entity_manager->getDefinition($entity_type_id); - $definitions = $entity_manager->getBaseFieldDefinitions($entity_type_id); - - // Define the entity ID schema based on the field definitions. - $id_definition = $definitions[$entity_type->getKey('id')]; - if ($id_definition->getType() == 'integer') { - $id_schema = array( - 'type' => 'int', - 'unsigned' => TRUE, - 'not null' => TRUE, - 'description' => 'The entity id this data is attached to', - ); - } - else { - $id_schema = array( - 'type' => 'varchar', - 'length' => 128, - 'not null' => TRUE, - 'description' => 'The entity id this data is attached to', - ); - } - - // Define the revision ID schema, default to integer if there is no revision - // ID. - $revision_id_definition = $entity_type->hasKey('revision') ? $definitions[$entity_type->getKey('revision')] : NULL; - if (!$revision_id_definition || $revision_id_definition->getType() == 'integer') { - $revision_id_schema = array( - 'type' => 'int', - 'unsigned' => TRUE, - 'not null' => FALSE, - 'description' => 'The entity revision id this data is attached to, or NULL if the entity type is not versioned', - ); + if ($table_mapping->requiresDedicatedTableStorage($storage_definition)) { + $is_deleted = $this->storageDefinitionIsDeleted($storage_definition); + $table_name = $table_mapping->getDedicatedDataTableName($storage_definition, $is_deleted); + $query = $this->database->select($table_name, 't'); + $or = $query->orConditionGroup(); + foreach ($storage_definition->getColumns() as $column_name => $data) { + $or->isNotNull($table_mapping->getFieldColumnName($storage_definition, $column_name)); + } + $query + ->condition($or) + ->fields('t', array('entity_id')) + ->distinct(TRUE); + // If we are performing the query just to check if the field has data + // limit the number of rows. + if ($as_bool) { + $query->range(0, 1); + } + $count = $query->countQuery()->execute()->fetchField(); } else { - $revision_id_schema = array( - 'type' => 'varchar', - 'length' => 128, - 'not null' => FALSE, - 'description' => 'The entity revision id this data is attached to, or NULL if the entity type is not versioned', - ); - } - - $current = array( - 'description' => $description_current, - 'fields' => array( - 'bundle' => array( - 'type' => 'varchar', - 'length' => 128, - 'not null' => TRUE, - 'default' => '', - 'description' => 'The field instance bundle to which this row belongs, used when deleting a field instance', - ), - 'deleted' => array( - 'type' => 'int', - 'size' => 'tiny', - 'not null' => TRUE, - 'default' => 0, - 'description' => 'A boolean indicating whether this data item has been deleted' - ), - 'entity_id' => $id_schema, - 'revision_id' => $revision_id_schema, - 'langcode' => array( - 'type' => 'varchar', - 'length' => 32, - 'not null' => TRUE, - 'default' => '', - 'description' => 'The language code for this data item.', - ), - 'delta' => array( - 'type' => 'int', - 'unsigned' => TRUE, - 'not null' => TRUE, - 'description' => 'The sequence number for this data item, used for multi-value fields', - ), - ), - 'primary key' => array('entity_id', 'deleted', 'delta', 'langcode'), - 'indexes' => array( - 'bundle' => array('bundle'), - 'deleted' => array('deleted'), - 'entity_id' => array('entity_id'), - 'revision_id' => array('revision_id'), - 'langcode' => array('langcode'), - ), - ); - - if (!$schema) { - $schema = $storage_definition->getSchema(); - } - - // Add field columns. - foreach ($schema['columns'] as $column_name => $attributes) { - $real_name = $table_mapping->getFieldColumnName($storage_definition, $column_name); - $current['fields'][$real_name] = $attributes; - } - - // Add unique keys. - foreach ($schema['unique keys'] as $unique_key_name => $columns) { - $real_name = static::_fieldIndexName($storage_definition, $unique_key_name); - foreach ($columns as $column_name) { - $current['unique keys'][$real_name][] = $table_mapping->getFieldColumnName($storage_definition, $column_name); + if ($as_bool) { + $count = $this->hasData(); } - } - - // Add indexes. - foreach ($schema['indexes'] as $index_name => $columns) { - $real_name = static::_fieldIndexName($storage_definition, $index_name); - foreach ($columns as $column_name) { - // Indexes can be specified as either a column name or an array with - // column name and length. Allow for either case. - if (is_array($column_name)) { - $current['indexes'][$real_name][] = array( - $table_mapping->getFieldColumnName($storage_definition, $column_name[0]), - $column_name[1], - ); + else { + $data_table = $this->dataTable ?: $this->baseTable; + $query = $this->database->select($data_table, 't'); + $columns = $storage_definition->getColumns(); + if (count($columns) > 1) { + $or = $query->orConditionGroup(); + foreach ($columns as $column_name => $data) { + $or->isNotNull($table_mapping->getFieldColumnName($storage_definition, $column_name)); + } + $query->condition($or); } else { - $current['indexes'][$real_name][] = $table_mapping->getFieldColumnName($storage_definition, $column_name); + $query->isNotNull($storage_definition->getName()); } + $count = $query + ->fields('t', array($this->idKey)) + ->distinct(TRUE) + ->countQuery() + ->execute() + ->fetchField(); } } - // Add foreign keys. - foreach ($schema['foreign keys'] as $specifier => $specification) { - $real_name = static::_fieldIndexName($storage_definition, $specifier); - $current['foreign keys'][$real_name]['table'] = $specification['table']; - foreach ($specification['columns'] as $column_name => $referenced) { - $sql_storage_column = $table_mapping->getFieldColumnName($storage_definition, $column_name); - $current['foreign keys'][$real_name]['columns'][$sql_storage_column] = $referenced; - } - } - - // Construct the revision table. - $revision = $current; - $revision['description'] = $description_revision; - $revision['primary key'] = array('entity_id', 'revision_id', 'deleted', 'delta', 'langcode'); - $revision['fields']['revision_id']['not null'] = TRUE; - $revision['fields']['revision_id']['description'] = 'The entity revision id this data is attached to'; - - return array( - $table_mapping->getDedicatedDataTableName($storage_definition) => $current, - $table_mapping->getDedicatedRevisionTableName($storage_definition) => $revision, - ); + return $as_bool ? (bool) $count : (int) $count; } /** - * Generates an index name for a field data table. - * - * @private Calling this function circumvents the entity system and is - * strongly discouraged. This function is not considered part of the public - * API and modules relying on it might break even in minor releases. + * Returns whether the passed field has been already deleted. * * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $storage_definition * The field storage definition. - * @param string $index - * The name of the index. * - * @return string - * A string containing a generated index name for a field data table that is - * unique among all other fields. + * @return bool + * Whether the field has been already deleted. */ - public static function _fieldIndexName(FieldStorageDefinitionInterface $storage_definition, $index) { - return $storage_definition->getName() . '_' . $index; + protected function storageDefinitionIsDeleted(FieldStorageDefinitionInterface $storage_definition) { + return !array_key_exists($storage_definition->getName(), $this->entityManager->getFieldStorageDefinitions($this->entityTypeId)); } } diff --git a/core/lib/Drupal/Core/Entity/Schema/ContentEntitySchemaHandlerInterface.php b/core/lib/Drupal/Core/Entity/Schema/ContentEntitySchemaHandlerInterface.php index c7bb557..43b1d97 100644 --- a/core/lib/Drupal/Core/Entity/Schema/ContentEntitySchemaHandlerInterface.php +++ b/core/lib/Drupal/Core/Entity/Schema/ContentEntitySchemaHandlerInterface.php @@ -6,10 +6,20 @@ */ namespace Drupal\Core\Entity\Schema; +use Drupal\Core\Field\FieldStorageDefinitionInterface; use Drupal\Core\Field\FieldStorageDefinitionListenerInterface; /** * Defines an interface for handling the storage schema of content entities. */ interface ContentEntitySchemaHandlerInterface extends EntitySchemaHandlerInterface, FieldStorageDefinitionListenerInterface { + + /** + * Performs final cleanup after all data of a field has been purged. + * + * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $storage_definition + * The field being purged. + */ + public function finalizePurge(FieldStorageDefinitionInterface $storage_definition); + } diff --git a/core/lib/Drupal/Core/Entity/Schema/SqlContentEntityStorageSchema.php b/core/lib/Drupal/Core/Entity/Schema/SqlContentEntityStorageSchema.php index 1572478..69baa5d 100644 --- a/core/lib/Drupal/Core/Entity/Schema/SqlContentEntityStorageSchema.php +++ b/core/lib/Drupal/Core/Entity/Schema/SqlContentEntityStorageSchema.php @@ -14,6 +14,8 @@ use Drupal\Core\Entity\EntityManagerInterface; use Drupal\Core\Entity\EntityStorageException; use Drupal\Core\Entity\EntityTypeInterface; +use Drupal\Core\Entity\Exception\FieldStorageDefinitionUpdateForbiddenException; +use Drupal\Core\Field\FieldException; use Drupal\Core\Field\FieldStorageDefinitionInterface; /** @@ -22,6 +24,13 @@ class SqlContentEntityStorageSchema implements ContentEntitySchemaHandlerInterface, ContentEntitySchemaProviderInterface { /** + * The entity manager. + * + * @var \Drupal\Core\Entity\EntityManagerInterface + */ + protected $entityManager; + + /** * The entity type this schema builder is responsible for. * * @var \Drupal\Core\Entity\ContentEntityTypeInterface @@ -36,6 +45,14 @@ class SqlContentEntityStorageSchema implements ContentEntitySchemaHandlerInterfa protected $fieldStorageDefinitions; /** + * The original storage field definitions for this entity type. Used during + * field schema updates. + * + * @var \Drupal\Core\Field\FieldDefinitionInterface[] + */ + protected $originalDefinitions; + + /** * The storage object for the given entity type. * * @var \Drupal\Core\Entity\ContentEntityDatabaseStorage @@ -83,6 +100,7 @@ class SqlContentEntityStorageSchema implements ContentEntitySchemaHandlerInterfa * The database connection to be used. */ public function __construct(EntityManagerInterface $entity_manager, ContentEntityTypeInterface $entity_type, ContentEntityDatabaseStorage $storage, Connection $database) { + $this->entityManager = $entity_manager; $this->entityType = $entity_type; $this->fieldStorageDefinitions = $entity_manager->getFieldStorageDefinitions($entity_type->id()); $this->storage = $storage; @@ -114,11 +132,11 @@ protected function schemaManager() { */ public function requiresEntitySchemaChanges(ContentEntityTypeInterface $definition, ContentEntityTypeInterface $original) { return !$original || - $original->getStorageClass() != $definition->getStorageClass() || - $original->isRevisionable() != $definition->isRevisionable() || - $original->isTranslatable() != $definition->isTranslatable() || - // Detect changes in key or index definitions. - $this->loadEntitySchemaData($original) != $this->getEntitySchemaData($definition, $this->getEntitySchema($definition, TRUE)); + $original->getStorageClass() != $definition->getStorageClass() || + $original->isRevisionable() != $definition->isRevisionable() || + $original->isTranslatable() != $definition->isTranslatable() || + // Detect changes in key or index definitions. + $this->loadEntitySchemaData($original) != $this->getEntitySchemaData($definition, $this->getEntitySchema($definition, TRUE)); } /** @@ -126,10 +144,10 @@ public function requiresEntitySchemaChanges(ContentEntityTypeInterface $definiti */ public function requiresFieldSchemaChanges(FieldStorageDefinitionInterface $definition, FieldStorageDefinitionInterface $original) { return !$original || - $original->getSchema() != $definition->getSchema() || - $original->isRevisionable() != $definition->isRevisionable() || - $original->hasCustomStorage() != $definition->hasCustomStorage() || - $this->requiresFieldDataMigration($definition, $original); + $original->getSchema() != $definition->getSchema() || + $original->isRevisionable() != $definition->isRevisionable() || + $original->hasCustomStorage() != $definition->hasCustomStorage() || + $this->requiresFieldDataMigration($definition, $original); } /** @@ -142,26 +160,30 @@ public function requiresEntityDataMigration(ContentEntityTypeInterface $definiti // revisionable to non revisionable, as in that case we just need to drop // revision tables. return $original->getStorageClass() != $definition->getStorageClass() || - $original->isRevisionable() != $definition->isRevisionable() || - $original->isTranslatable() != $definition->isTranslatable(); + $original->isRevisionable() != $definition->isRevisionable() || + $original->isTranslatable() != $definition->isTranslatable(); } /** * {@inheritdoc} */ public function requiresFieldDataMigration(FieldStorageDefinitionInterface $definition, FieldStorageDefinitionInterface $original) { + $table_mapping = $this->storage->getTableMapping(); + // If the field changes its custom storage status, we will need to create or // drop its schema. In any case we cannot migrate its data as custom storage - // is involved. - if ($original->hasCustomStorage() || $definition->hasCustomStorage()) { + // is involved. Otherwise if a field is moved from a shared table to a + // dedicated table or viceversa we need a data migration. + $custom_storage = $original->hasCustomStorage() || $definition->hasCustomStorage(); + $shared_table_changed = $table_mapping->allowsSharedTableStorage($original) != $table_mapping->allowsSharedTableStorage($definition); + $dedicated_table_changed = $table_mapping->requiresDedicatedTableStorage($original) != $table_mapping->requiresDedicatedTableStorage($definition); + if (!$custom_storage && ($shared_table_changed || $dedicated_table_changed)) { return TRUE; } // If columns change we may need data manipulation, which we cannot handle. if ($original->getColumns() != $definition->getColumns()) { return TRUE; } - // @todo Add additional checks for field storage changes that can affect - // table layout: https://www.drupal.org/node/1498720. return FALSE; } @@ -199,6 +221,14 @@ public function onEntityTypeUpdate(EntityTypeInterface $entity_type, EntityTypeI try { $this->onEntityTypeDelete($original); $this->onEntityTypeCreate($entity_type); + + // Update dedicated table revision schema. + if ($original->isRevisionable() && !$entity_type->isRevisionable()) { + $this->dropDedicatedTableRevisionSchema(); + } + elseif (!$original->isRevisionable() && $entity_type->isRevisionable()) { + $this->createDedicatedTableRevisionSchema($entity_type); + } } catch (\Exception $e) { if ($this->database->supportsTransactionalDDL()) { @@ -255,18 +285,26 @@ public function onEntityTypeUpdate(EntityTypeInterface $entity_type, EntityTypeI public function onEntityTypeDelete(EntityTypeInterface $entity_type) { $this->checkEntityType($entity_type); $schema_handler = $this->database->schema(); + $actual_definition = $this->entityManager->getDefinition($entity_type->id()); + // @todo Instead of switching the wrapped entity type, we should be able to + // instantiate a new table mapping for each entity type definition. See + // https://www.drupal.org/node/2274017. + $this->storage->setEntityType($entity_type); + foreach ($this->getEntitySchemaTables() as $table_name) { if ($schema_handler->tableExists($table_name)) { $schema_handler->dropTable($table_name); } } - $this->schemaManager()->onEntityTypeDelete($entity_type); + + $this->storage->setEntityType($actual_definition); } /** * {@inheritdoc} */ public function onFieldStorageDefinitionCreate(FieldStorageDefinitionInterface $storage_definition) { + $this->performFieldSchemaOperation('create', $storage_definition); $this->schemaManager()->onFieldStorageDefinitionCreate($storage_definition); } @@ -274,6 +312,12 @@ public function onFieldStorageDefinitionCreate(FieldStorageDefinitionInterface $ * {@inheritdoc} */ public function onFieldStorageDefinitionUpdate(FieldStorageDefinitionInterface $storage_definition, FieldStorageDefinitionInterface $original) { + // Store original definitions so that switching between shared and dedicated + // field table layout works. + $this->originalDefinitions = $this->fieldStorageDefinitions; + $this->originalDefinitions[$original->getName()] = $original; + $this->performFieldSchemaOperation('update', $storage_definition, $original); + $this->originalDefinitions = NULL; $this->schemaManager()->onFieldStorageDefinitionUpdate($storage_definition, $original); } @@ -281,25 +325,46 @@ public function onFieldStorageDefinitionUpdate(FieldStorageDefinitionInterface $ * {@inheritdoc} */ public function onFieldStorageDefinitionDelete(FieldStorageDefinitionInterface $storage_definition) { + $this->prepareFieldSchemaDeletion($storage_definition); $this->schemaManager()->onFieldStorageDefinitionDelete($storage_definition); } /** - * Checks that we are dealing with the correct entity type. + * {@inheritdoc} + */ + public function finalizePurge(FieldStorageDefinitionInterface $storage_definition) { + $this->performFieldSchemaOperation('delete', $storage_definition); + } + + /** + * Creates revision tables for the specified entity type. * * @param \Drupal\Core\Entity\ContentEntityTypeInterface $entity_type - * The entity type to be checked. - * - * @return bool - * TRUE if the entity type matches the current one. - * - * @throws \Drupal\Core\Entity\EntityStorageException + * The entity type definition. */ - protected function checkEntityType(ContentEntityTypeInterface $entity_type) { - if ($entity_type->id() != $this->entityType->id()) { - throw new EntityStorageException(String::format('Unsupported entity type @id', array('@id' => $entity_type->id()))); + protected function createDedicatedTableRevisionSchema(ContentEntityTypeInterface $entity_type) { + $table_mapping = $this->storage->getTableMapping(); + $schema_manager = $this->database->schema(); + foreach ($this->fieldStorageDefinitions as $definition) { + if ($table_mapping->requiresDedicatedTableStorage($definition)) { + $schema = $this->getDedicatedTableSchema($definition, $entity_type); + $table_name = $table_mapping->getDedicatedRevisionTableName($definition); + $schema_manager->createTable($table_name, $schema[$table_name]); + } + } + } + + /** + * Deletes revision tables for the specified entity type. + */ + protected function dropDedicatedTableRevisionSchema() { + $table_mapping = $this->storage->getTableMapping(); + $schema_manager = $this->database->schema(); + foreach ($this->fieldStorageDefinitions as $definition) { + if ($table_mapping->requiresDedicatedTableStorage($definition)) { + $schema_manager->dropTable($table_mapping->getDedicatedRevisionTableName($definition)); + } } - return TRUE; } /** @@ -314,30 +379,54 @@ protected function checkEntityType(ContentEntityTypeInterface $entity_type) { * @return array * A Schema API array describing the entity schema, excluding dedicated * field tables. + * + * @throws \Drupal\Core\Field\FieldException */ protected function getEntitySchema(ContentEntityTypeInterface $entity_type, $reset = FALSE) { + $this->checkEntityType($entity_type); $entity_type_id = $entity_type->id(); if (!isset($this->schema[$entity_type_id]) || $reset) { - // Initialize the table schema. + // Back up the storage definition and replace it with the passed one. + // @todo Instead of switching the wrapped entity type, we should be able + // to instantiate a new table mapping for each entity type definition. + // See https://www.drupal.org/node/2274017. + $actual_definition = $this->entityManager->getDefinition($entity_type_id); + $this->storage->setEntityType($entity_type); + + // Prepare basic information about the entity type. $tables = $this->getEntitySchemaTables(); - $schema[$tables['base_table']] = $this->initializeBaseTable(); + + // Initialize the table schema. + $schema[$tables['base_table']] = $this->initializeBaseTable($entity_type); if (isset($tables['revision_table'])) { - $schema[$tables['revision_table']] = $this->initializeRevisionTable(); + $schema[$tables['revision_table']] = $this->initializeRevisionTable($entity_type); } if (isset($tables['data_table'])) { - $schema[$tables['data_table']] = $this->initializeDataTable(); + $schema[$tables['data_table']] = $this->initializeDataTable($entity_type); } if (isset($tables['revision_data_table'])) { - $schema[$tables['revision_data_table']] = $this->initializeRevisionDataTable(); + $schema[$tables['revision_data_table']] = $this->initializeRevisionDataTable($entity_type); } + // We need to act only on shared entity schema tables. $table_mapping = $this->storage->getTableMapping(); - foreach ($table_mapping->getTableNames() as $table_name) { - // Add the schema from field definitions. + $table_names = array_diff($table_mapping->getTableNames(), $table_mapping->getDedicatedTableNames()); + $storage_definitions = $this->entityManager->getFieldStorageDefinitions($entity_type_id); + foreach ($table_names as $table_name) { + if (!isset($schema[$table_name])) { + $schema[$table_name] = array(); + } foreach ($table_mapping->getFieldNames($table_name) as $field_name) { - $column_names = $table_mapping->getColumnNames($field_name); - $this->addFieldSchema($schema[$table_name], $field_name, $column_names); + if (!isset($storage_definitions[$field_name])) { + throw new FieldException(String::format('Fieled storage definition for "@field_name" could not be found.', array('@field_name' => $field_name))); + } + // Add the schema for base field definitions. + elseif ($table_mapping->allowsSharedTableStorage($storage_definitions[$field_name])) { + $column_names = $table_mapping->getColumnNames($field_name); + $storage_definition = $storage_definitions[$field_name]; + $schema[$table_name] = array_merge_recursive($schema[$table_name], $this->getSharedTableFieldSchema($storage_definition, $column_names)); + } } // Add the schema for extra fields. @@ -349,24 +438,45 @@ protected function getEntitySchema(ContentEntityTypeInterface $entity_type, $res } // Process tables after having gathered field information. - $this->processBaseTable($schema[$tables['base_table']]); + $this->processBaseTable($entity_type, $schema[$tables['base_table']]); if (isset($tables['revision_table'])) { - $this->processRevisionTable($schema[$tables['revision_table']]); + $this->processRevisionTable($entity_type, $schema[$tables['revision_table']]); } if (isset($tables['data_table'])) { - $this->processDataTable($schema[$tables['data_table']]); + $this->processDataTable($entity_type, $schema[$tables['data_table']]); } if (isset($tables['revision_data_table'])) { - $this->processRevisionDataTable($schema[$tables['revision_data_table']]); + $this->processRevisionDataTable($entity_type, $schema[$tables['revision_data_table']]); } $this->schema[$entity_type_id] = $schema; + + // Restore the actual definition. + $this->storage->setEntityType($actual_definition); } return $this->schema[$entity_type_id]; } /** + * Checks that we are dealing with the correct entity type. + * + * @param \Drupal\Core\Entity\ContentEntityTypeInterface $entity_type + * The entity type to be checked. + * + * @return bool + * TRUE if the entity type matches the current one. + * + * @throws \Drupal\Core\Entity\EntityStorageException + */ + protected function checkEntityType(ContentEntityTypeInterface $entity_type) { + if ($entity_type->id() != $this->entityType->id()) { + throw new EntityStorageException(String::format('Unsupported entity type @id', array('@id' => $entity_type->id()))); + } + return TRUE; + } + + /** * Gets a list of entity type tables. * * @return array @@ -446,144 +556,675 @@ protected function saveEntitySchemaData(ContentEntityTypeInterface $entity_type, } /** - * Returns the schema for a single field definition. + * Initializes common information for a base table. * - * @param array $schema - * The table schema to add the field schema to, passed by reference. - * @param string $field_name - * The name of the field. - * @param string[] $column_mapping - * A mapping of field column names to database column names. + * @param \Drupal\Core\Entity\ContentEntityTypeInterface $entity_type + * The entity type. + * + * @return array + * A partial schema array for the base table. */ - protected function addFieldSchema(array &$schema, $field_name, array $column_mapping) { - $field_schema = $this->fieldStorageDefinitions[$field_name]->getSchema(); - $field_description = $this->fieldStorageDefinitions[$field_name]->getDescription(); - - foreach ($column_mapping as $field_column_name => $schema_field_name) { - $column_schema = $field_schema['columns'][$field_column_name]; + protected function initializeBaseTable(ContentEntityTypeInterface $entity_type) { + $entity_type_id = $entity_type->id(); - $schema['fields'][$schema_field_name] = $column_schema; - $schema['fields'][$schema_field_name]['description'] = $field_description; - // Only entity keys are required. - $keys = $this->entityType->getKeys() + array('langcode' => 'langcode'); - // The label is an entity key, but label fields are not necessarily - // required. - // Because entity ID and revision ID are both serial fields in the base - // and revision table respectively, the revision ID is not known yet, when - // inserting data into the base table. Instead the revision ID in the base - // table is updated after the data has been inserted into the revision - // table. For this reason the revision ID field cannot be marked as NOT - // NULL. - unset($keys['label'], $keys['revision']); - // Key fields may not be NULL. - if (in_array($field_name, $keys)) { - $schema['fields'][$schema_field_name]['not null'] = TRUE; - } - } + $schema = array( + 'description' => "The base table for $entity_type_id entities.", + 'primary key' => array($entity_type->getKey('id')), + 'indexes' => array(), + 'foreign keys' => array(), + ); - if (!empty($field_schema['indexes'])) { - $indexes = $this->getFieldIndexes($field_name, $field_schema, $column_mapping); - $schema['indexes'] = array_merge($schema['indexes'], $indexes); + if ($entity_type->hasKey('revision')) { + $revision_key = $entity_type->getKey('revision'); + $key_name = $this->getEntityIndexName($entity_type, $revision_key); + $schema['unique keys'][$key_name] = array($revision_key); + $schema['foreign keys'][$entity_type_id . '__revision'] = array( + 'table' => $this->storage->getRevisionTable(), + 'columns' => array($revision_key => $revision_key), + ); } - if (!empty($field_schema['unique keys'])) { - $unique_keys = $this->getFieldUniqueKeys($field_name, $field_schema, $column_mapping); - $schema['unique keys'] = array_merge($schema['unique keys'], $unique_keys); - } + $this->addTableDefaults($schema); - if (!empty($field_schema['foreign keys'])) { - $foreign_keys = $this->getFieldForeignKeys($field_name, $field_schema, $column_mapping); - $schema['foreign keys'] = array_merge($schema['foreign keys'], $foreign_keys); - } + return $schema; } /** - * Returns an index schema array for a given field. + * Initializes common information for a revision table. * - * @param string $field_name - * The name of the field. - * @param array $field_schema - * The schema of the field. - * @param string[] $column_mapping - * A mapping of field column names to database column names. + * @param \Drupal\Core\Entity\ContentEntityTypeInterface $entity_type + * The entity type. * * @return array - * The schema definition for the indexes. + * A partial schema array for the revision table. */ - protected function getFieldIndexes($field_name, array $field_schema, array $column_mapping) { - return $this->getFieldSchemaData($field_name, $field_schema, $column_mapping, 'indexes'); + protected function initializeRevisionTable(ContentEntityTypeInterface $entity_type) { + $entity_type_id = $entity_type->id(); + $id_key = $entity_type->getKey('id'); + $revision_key = $entity_type->getKey('revision'); + + $schema = array( + 'description' => "The revision table for $entity_type_id entities.", + 'primary key' => array($revision_key), + 'indexes' => array(), + 'foreign keys' => array( + $entity_type_id . '__revisioned' => array( + 'table' => $this->storage->getBaseTable(), + 'columns' => array($id_key => $id_key), + ), + ), + ); + + $schema['indexes'][$this->getEntityIndexName($entity_type, $id_key)] = array($id_key); + + $this->addTableDefaults($schema); + + return $schema; } /** - * Returns a unique key schema array for a given field. + * Initializes common information for a data table. * - * @param string $field_name - * The name of the field. - * @param array $field_schema - * The schema of the field. - * @param string[] $column_mapping - * A mapping of field column names to database column names. + * @param \Drupal\Core\Entity\ContentEntityTypeInterface $entity_type + * The entity type. * * @return array - * The schema definition for the unique keys. + * A partial schema array for the data table. */ - protected function getFieldUniqueKeys($field_name, array $field_schema, array $column_mapping) { - return $this->getFieldSchemaData($field_name, $field_schema, $column_mapping, 'unique keys'); + protected function initializeDataTable(ContentEntityTypeInterface $entity_type) { + $entity_type_id = $entity_type->id(); + $id_key = $entity_type->getKey('id'); + + $schema = array( + 'description' => "The data table for $entity_type_id entities.", + // @todo Use the language entity key when https://drupal.org/node/2143729 + // is in. + 'primary key' => array($id_key, 'langcode'), + 'indexes' => array(), + 'foreign keys' => array( + $entity_type_id => array( + 'table' => $this->storage->getBaseTable(), + 'columns' => array($id_key => $id_key), + ), + ), + ); + + if ($entity_type->hasKey('revision')) { + $key = $entity_type->getKey('revision'); + $schema['indexes'][$this->getEntityIndexName($entity_type, $key)] = array($key); + } + + $this->addTableDefaults($schema); + + return $schema; } /** - * Returns field schema data for the given key. + * Initializes common information for a revision data table. * - * @param string $field_name - * The name of the field. - * @param array $field_schema - * The schema of the field. - * @param string[] $column_mapping - * A mapping of field column names to database column names. - * @param string $schema_key - * The type of schema data. Either 'indexes' or 'unique keys'. + * @param \Drupal\Core\Entity\ContentEntityTypeInterface $entity_type + * The entity type. * * @return array - * The schema definition for the specified key. + * A partial schema array for the revision data table. */ - protected function getFieldSchemaData($field_name, array $field_schema, array $column_mapping, $schema_key) { - $data = array(); + protected function initializeRevisionDataTable(ContentEntityTypeInterface $entity_type) { + $entity_type_id = $entity_type->id(); + $id_key = $entity_type->getKey('id'); + $revision_key = $entity_type->getKey('revision'); - foreach ($field_schema[$schema_key] as $key => $columns) { - // To avoid clashes with entity-level indexes or unique keys we use - // "{$entity_type_id}_field__" as a prefix instead of just - // "{$entity_type_id}__". We additionally namespace the specifier by the - // field name to avoid clashes when multiple fields of the same type are - // added to an entity type. - $entity_type_id = $this->entityType->id(); - $real_key = $this->getFieldSchemaIdentifierName($entity_type_id, $field_name, $key); - foreach ($columns as $column) { - // Allow for indexes and unique keys to specified as an array of column - // name and length. - if (is_array($column)) { - list($column_name, $length) = $column; - $data[$real_key][] = array($column_mapping[$column_name], $length); - } - else { - $data[$real_key][] = $column_mapping[$column]; - } - } - } + $schema = array( + 'description' => "The revision data table for $entity_type_id entities.", + // @todo Use the language entity key when https://drupal.org/node/2143729 + // is in. + 'primary key' => array($revision_key, 'langcode'), + 'indexes' => array(), + 'foreign keys' => array( + $entity_type_id => array( + 'table' => $this->storage->getBaseTable(), + 'columns' => array($id_key => $id_key), + ), + $entity_type_id . '__revision' => array( + 'table' => $this->storage->getRevisionTable(), + 'columns' => array($revision_key => $revision_key), + ) + ), + ); - return $data; + $this->addTableDefaults($schema); + + return $schema; } /** - * Generates a safe schema identifier (name of an index, column name etc.). + * Processes the gathered schema for a base table. * - * @param string $entity_type_id - * The ID of the entity type. - * @param string $field_name - * The name of the field. - * @param string $key - * The key of the field. + * @param \Drupal\Core\Entity\ContentEntityTypeInterface $entity_type + * The entity type. + * @param array $schema + * The table schema, passed by reference. * - * @return string + * @return array + * A partial schema array for the base table. + */ + protected function processBaseTable(ContentEntityTypeInterface $entity_type, array &$schema) { + $this->processIdentifierSchema($schema, $entity_type->getKey('id')); + } + + /** + * Processes the gathered schema for a base table. + * + * @param \Drupal\Core\Entity\ContentEntityTypeInterface $entity_type + * The entity type. + * @param array $schema + * The table schema, passed by reference. + * + * @return array + * A partial schema array for the base table. + */ + protected function processRevisionTable(ContentEntityTypeInterface $entity_type, array &$schema) { + $this->processIdentifierSchema($schema, $entity_type->getKey('revision')); + } + + /** + * Processes the gathered schema for a base table. + * + * @param \Drupal\Core\Entity\ContentEntityTypeInterface $entity_type + * The entity type. + * @param array $schema + * The table schema, passed by reference. + * + * @return array + * A partial schema array for the base table. + */ + protected function processDataTable(ContentEntityTypeInterface $entity_type, array &$schema) { + } + + /** + * Processes the gathered schema for a base table. + * + * @param \Drupal\Core\Entity\ContentEntityTypeInterface $entity_type + * The entity type. + * @param array $schema + * The table schema, passed by reference. + * + * @return array + * A partial schema array for the base table. + */ + protected function processRevisionDataTable(ContentEntityTypeInterface $entity_type, array &$schema) { + } + + /** + * Performs the specified operation on a field. + * + * This figures out whether the field is stored in a dedicated or shared table + * and forwards the call to the proper handler. + * + * @param string $operation + * The name of the operation to be performed. + * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $storage_definition + * The field storage definition. + * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $original + * (optional) The original field storage definition. This is relevant (and + * required) only for updates. Defaults to NULL. + */ + protected function performFieldSchemaOperation($operation, FieldStorageDefinitionInterface $storage_definition, FieldStorageDefinitionInterface $original = NULL) { + $table_mapping = $this->storage->getTableMapping(); + if ($table_mapping->requiresDedicatedTableStorage($storage_definition)) { + $this->{$operation . 'DedicatedTableSchema'}($storage_definition, $original); + } + elseif ($table_mapping->allowsSharedTableStorage($storage_definition)) { + $this->{$operation . 'SharedTableSchema'}($storage_definition, $original); + } + } + + /** + * Creates the schema for a field stored in a dedicated table. + * + * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $storage_definition + * The storage definition of the field being created. + */ + protected function createDedicatedTableSchema(FieldStorageDefinitionInterface $storage_definition) { + $schema = $this->getDedicatedTableSchema($storage_definition); + foreach ($schema as $name => $table) { + $this->database->schema()->createTable($name, $table); + } + } + + /** + * Creates the schema for a field stored in a shared table. + * + * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $storage_definition + * The storage definition of the field being created. + */ + protected function createSharedTableSchema(FieldStorageDefinitionInterface $storage_definition) { + $created_field_name = $storage_definition->getName(); + $table_mapping = $this->storage->getTableMapping(); + $column_names = $table_mapping->getColumnNames($created_field_name); + $schema = $this->getSharedTableFieldSchema($storage_definition, $column_names); + $keys = array_diff_key($schema, array('fields' => FALSE)); + $shared_table_names = array_diff($table_mapping->getTableNames(), $table_mapping->getDedicatedTableNames()); + + // Iterate over the mapped table to find the ones that will host the created + // field schema. + foreach ($shared_table_names as $table_name) { + foreach ($table_mapping->getFieldNames($table_name) as $field_name) { + if ($field_name == $created_field_name) { + foreach ($schema['fields'] as $column_name => $specifier) { + $this->database->schema()->addField($table_name, $column_name, $specifier, $keys); + } + // After creating the field schema skip to the next table. + break; + } + } + } + } + + /** + * @todo Document. + */ + protected function prepareFieldSchemaDeletion(FieldStorageDefinitionInterface $storage_definition) { + $table_mapping = $this->storage->getTableMapping(); + // @todo Implement this also for shared table storage. See + // https://www.drupal.org/node/2282119. + if ($table_mapping->requiresDedicatedTableStorage($storage_definition)) { + // Move the table to a unique name while the table contents are being + // deleted. + $table = $table_mapping->getDedicatedDataTableName($storage_definition); + $new_table = $table_mapping->getDedicatedDataTableName($storage_definition, TRUE); + $this->database->schema()->renameTable($table, $new_table); + if ($this->entityType->isRevisionable()) { + $revision_table = $table_mapping->getDedicatedRevisionTableName($storage_definition); + $revision_new_table = $table_mapping->getDedicatedRevisionTableName($storage_definition, TRUE); + $this->database->schema()->renameTable($revision_table, $revision_new_table); + } + } + } + + /** + * Deletes the schema for a field stored in a dedicated table. + * + * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $storage_definition + * The storage definition of the field being deleted. + */ + protected function deleteDedicatedTableSchema(FieldStorageDefinitionInterface $storage_definition) { + // When switching from dedicated to shared field table layout we need need + // to delete the field tables with their regular names. When this happens + // original definitions will be defined. + $deleted = !$this->originalDefinitions; + $table_mapping = $this->storage->getTableMapping(); + $table_name = $table_mapping->getDedicatedDataTableName($storage_definition, $deleted); + $this->database->schema()->dropTable($table_name); + if ($this->entityType->isRevisionable()) { + $revision_name = $table_mapping->getDedicatedRevisionTableName($storage_definition, $deleted); + $this->database->schema()->dropTable($revision_name); + } + } + + /** + * Deletes the schema for a field stored in a shared table. + * + * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $storage_definition + * The storage definition of the field being deleted. + */ + protected function deleteSharedTableSchema(FieldStorageDefinitionInterface $storage_definition) { + $deleted_field_name = $storage_definition->getName(); + $table_mapping = $this->storage->getTableMapping($this->originalDefinitions); + $column_names = $table_mapping->getColumnNames($deleted_field_name); + $schema = $this->getSharedTableFieldSchema($storage_definition, $column_names); + $schema_handler = $this->database->schema(); + $shared_table_names = array_diff($table_mapping->getTableNames(), $table_mapping->getDedicatedTableNames()); + + // Iterate over the mapped table to find the ones that host the deleted + // field schema. + foreach ($shared_table_names as $table_name) { + foreach ($table_mapping->getFieldNames($table_name) as $field_name) { + if ($field_name == $deleted_field_name) { + // Drop indexes and unique keys first. + if (!empty($schema['indexes'])) { + foreach ($schema['indexes'] as $name => $specifier) { + $schema_handler->dropIndex($table_name, $name); + } + } + if (!empty($schema['unique keys'])) { + foreach ($schema['unique keys'] as $name => $specifier) { + $schema_handler->dropUniqueKey($table_name, $name); + } + } + // Drop columns. + foreach ($column_names as $column_name) { + $schema_handler->dropField($table_name, $column_name); + } + // After deleting the field schema skip to the next table. + break; + } + } + } + } + + /** + * Updates the schema for a field stored in a shared table. + * + * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $storage_definition + * The storage definition of the field being updated. + * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $original + * The original storage definition; i.e., the definition before the update. + * + * @throws \Drupal\Core\Entity\Exception\FieldStorageDefinitionUpdateForbiddenException + * Thrown when the update to the field is forbidden. + * @throws \Exception + * Rethrown exception if the table recreation fails. + */ + protected function updateDedicatedTableSchema(FieldStorageDefinitionInterface $storage_definition, FieldStorageDefinitionInterface $original) { + if (!$this->storage->countFieldData($original, TRUE)) { + // There is no data. Re-create the tables completely. + if ($this->database->supportsTransactionalDDL()) { + // If the database supports transactional DDL, we can go ahead and rely + // on it. If not, we will have to rollback manually if something fails. + $transaction = $this->database->startTransaction(); + } + try { + // Since there is no data we may be switching from a shared table schema + // to a dedicated table schema, hence we should use the proper API. + $this->performFieldSchemaOperation('delete', $original); + $this->performFieldSchemaOperation('create', $storage_definition); + } + catch (\Exception $e) { + if ($this->database->supportsTransactionalDDL()) { + $transaction->rollback(); + } + else { + // Recreate tables. + $this->performFieldSchemaOperation('create', $original); + } + throw $e; + } + } + else { + if ($storage_definition->getColumns() != $original->getColumns()) { + throw new FieldStorageDefinitionUpdateForbiddenException("The SQL storage cannot change the schema for an existing field with data."); + } + // There is data, so there are no column changes. Drop all the prior + // indexes and create all the new ones, except for all the priors that + // exist unchanged. + $table_mapping = $this->storage->getTableMapping(); + $table = $table_mapping->getDedicatedDataTableName($original); + $revision_table = $table_mapping->getDedicatedRevisionTableName($original); + + $schema = $storage_definition->getSchema(); + $original_schema = $original->getSchema(); + + foreach ($original_schema['indexes'] as $name => $columns) { + if (!isset($schema['indexes'][$name]) || $columns != $schema['indexes'][$name]) { + $real_name = $this->getFieldIndexName($storage_definition, $name); + $this->database->schema()->dropIndex($table, $real_name); + $this->database->schema()->dropIndex($revision_table, $real_name); + } + } + $table = $table_mapping->getDedicatedDataTableName($storage_definition); + $revision_table = $table_mapping->getDedicatedRevisionTableName($storage_definition); + foreach ($schema['indexes'] as $name => $columns) { + if (!isset($original_schema['indexes'][$name]) || $columns != $original_schema['indexes'][$name]) { + $real_name = $this->getFieldIndexName($storage_definition, $name); + $real_columns = array(); + foreach ($columns as $column_name) { + // Indexes can be specified as either a column name or an array with + // column name and length. Allow for either case. + if (is_array($column_name)) { + $real_columns[] = array( + $table_mapping->getFieldColumnName($storage_definition, $column_name[0]), + $column_name[1], + ); + } + else { + $real_columns[] = $table_mapping->getFieldColumnName($storage_definition, $column_name); + } + } + $this->database->schema()->addIndex($table, $real_name, $real_columns); + $this->database->schema()->addIndex($revision_table, $real_name, $real_columns); + } + } + } + } + + /** + * Updates the schema for a field stored in a shared table. + * + * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $storage_definition + * The storage definition of the field being updated. + * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $original + * The original storage definition; i.e., the definition before the update. + * + * @throws \Drupal\Core\Entity\Exception\FieldStorageDefinitionUpdateForbiddenException + * Thrown when the update to the field is forbidden. + * @throws \Exception + * Rethrown exception if the table recreation fails. + */ + protected function updateSharedTableSchema(FieldStorageDefinitionInterface $storage_definition, FieldStorageDefinitionInterface $original) { + if (!$this->storage->countFieldData($original, TRUE)) { + if ($this->database->supportsTransactionalDDL()) { + // If the database supports transactional DDL, we can go ahead and rely + // on it. If not, we will have to rollback manually if something fails. + $transaction = $this->database->startTransaction(); + } + try { + // Since there is no data we may be switching from a dedicated table + // to a schema table schema, hence we should use the proper API. + $this->performFieldSchemaOperation('delete', $original); + $this->performFieldSchemaOperation('create', $storage_definition); + } + catch (\Exception $e) { + if ($this->database->supportsTransactionalDDL()) { + $transaction->rollback(); + } + else { + // Recreate original schema. + $this->createSharedTableSchema($original); + } + throw $e; + } + } + else { + if ($storage_definition->getColumns() != $original->getColumns()) { + throw new FieldStorageDefinitionUpdateForbiddenException("The SQL storage cannot change the schema for an existing field with data."); + } + + $updated_field_name = $storage_definition->getName(); + $table_mapping = $this->storage->getTableMapping(); + $column_names = $table_mapping->getColumnNames($updated_field_name); + $original_schema = $this->getSharedTableFieldSchema($original, $column_names); + $schema = $this->getSharedTableFieldSchema($storage_definition, $column_names); + $schema_handler = $this->database->schema(); + + // Iterate over the mapped table to find the ones that host the deleted + // field schema. + foreach ($table_mapping->getTableNames() as $table_name) { + foreach ($table_mapping->getFieldNames($table_name) as $field_name) { + if ($field_name == $updated_field_name) { + // Drop original indexes and unique keys. + if (!empty($original_schema['indexes'])) { + foreach ($original_schema['indexes'] as $name => $specifier) { + $schema_handler->dropIndex($table_name, $name); + } + } + if (!empty($original_schema['unique keys'])) { + foreach ($original_schema['unique keys'] as $name => $specifier) { + $schema_handler->dropUniqueKey($table_name, $name); + } + } + // Create new indexes and unique keys. + if (!empty($schema['indexes'])) { + foreach ($schema['indexes'] as $name => $specifier) { + $schema_handler->addIndex($table_name, $name, $specifier); + } + } + if (!empty($schema['unique keys'])) { + foreach ($schema['unique keys'] as $name => $specifier) { + $schema_handler->addUniqueKey($table_name, $name, $specifier); + } + } + // After deleting the field schema skip to the next table. + break; + } + } + } + } + } + + /** + * Returns the schema for a single field definition. + * + * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $storage_definition + * The storage definition of the field whose schema has to be returned. + * @param string[] $column_mapping + * A mapping of field column names to database column names. + * + * @return array + * The schema definition for the table with the following keys: + * - fields: The schema definition for the each field columns. + * - indexes: The schema definition for the indexes. + * - unique keys: The schema definition for the unique keys. + * - foreign keys: The schema definition for the foreign keys. + * + * @throws \Drupal\Core\Field\FieldException + * Exception thrown if the schema contains reserved column names. + */ + protected function getSharedTableFieldSchema(FieldStorageDefinitionInterface $storage_definition, array $column_mapping) { + $schema = array(); + $field_schema = $storage_definition->getSchema(); + + // Check that the schema does not include forbidden column names. + if (array_intersect(array_keys($field_schema['columns']), $this->storage->getTableMapping()->getReservedColumns())) { + throw new FieldException(format_string('Illegal field column names on @field_name', array('@field_name' => $storage_definition->getName()))); + } + + $field_name = $storage_definition->getName(); + $field_description = $storage_definition->getDescription(); + + foreach ($column_mapping as $field_column_name => $schema_field_name) { + $column_schema = $field_schema['columns'][$field_column_name]; + + $schema['fields'][$schema_field_name] = $column_schema; + $schema['fields'][$schema_field_name]['description'] = $field_description; + // Only entity keys are required. + $keys = $this->entityType->getKeys() + array('langcode' => 'langcode'); + // The label is an entity key, but label fields are not necessarily + // required. + // Because entity ID and revision ID are both serial fields in the base + // and revision table respectively, the revision ID is not known yet, when + // inserting data into the base table. Instead the revision ID in the base + // table is updated after the data has been inserted into the revision + // table. For this reason the revision ID field cannot be marked as NOT + // NULL. + unset($keys['label'], $keys['revision']); + // Key fields may not be NULL. + if (in_array($field_name, $keys)) { + $schema['fields'][$schema_field_name]['not null'] = TRUE; + } + } + + if (!empty($field_schema['indexes'])) { + $schema['indexes'] = $this->getFieldIndexes($field_name, $field_schema, $column_mapping); + } + + if (!empty($field_schema['unique keys'])) { + $schema['unique keys'] = $this->getFieldUniqueKeys($field_name, $field_schema, $column_mapping); + } + + if (!empty($field_schema['foreign keys'])) { + $schema['foreign keys'] = $this->getFieldForeignKeys($field_name, $field_schema, $column_mapping); + } + + return $schema; + } + + /** + * Returns an index schema array for a given field. + * + * @param string $field_name + * The name of the field. + * @param array $field_schema + * The schema of the field. + * @param string[] $column_mapping + * A mapping of field column names to database column names. + * + * @return array + * The schema definition for the indexes. + */ + protected function getFieldIndexes($field_name, array $field_schema, array $column_mapping) { + return $this->getFieldSchemaData($field_name, $field_schema, $column_mapping, 'indexes'); + } + + /** + * Returns a unique key schema array for a given field. + * + * @param string $field_name + * The name of the field. + * @param array $field_schema + * The schema of the field. + * @param string[] $column_mapping + * A mapping of field column names to database column names. + * + * @return array + * The schema definition for the unique keys. + */ + protected function getFieldUniqueKeys($field_name, array $field_schema, array $column_mapping) { + return $this->getFieldSchemaData($field_name, $field_schema, $column_mapping, 'unique keys'); + } + + /** + * Returns field schema data for the given key. + * + * @param string $field_name + * The name of the field. + * @param array $field_schema + * The schema of the field. + * @param string[] $column_mapping + * A mapping of field column names to database column names. + * @param string $schema_key + * The type of schema data. Either 'indexes' or 'unique keys'. + * + * @return array + * The schema definition for the specified key. + */ + protected function getFieldSchemaData($field_name, array $field_schema, array $column_mapping, $schema_key) { + $data = array(); + + foreach ($field_schema[$schema_key] as $key => $columns) { + // To avoid clashes with entity-level indexes or unique keys we use + // "{$entity_type_id}_field__" as a prefix instead of just + // "{$entity_type_id}__". We additionally namespace the specifier by the + // field name to avoid clashes when multiple fields of the same type are + // added to an entity type. + $entity_type_id = $this->entityType->id(); + $real_key = $this->getFieldSchemaIdentifierName($entity_type_id, $field_name, $key); + foreach ($columns as $column) { + // Allow for indexes and unique keys to specified as an array of column + // name and length. + if (is_array($column)) { + list($column_name, $length) = $column; + $data[$real_key][] = array($column_mapping[$column_name], $length); + } + else { + $data[$real_key][] = $column_mapping[$column]; + } + } + } + + return $data; + } + + /** + * Generates a safe schema identifier (name of an index, column name etc.). + * + * @param string $entity_type_id + * The ID of the entity type. + * @param string $field_name + * The name of the field. + * @param string $key + * The key of the field. + * + * @return string * The field identifier name. */ protected function getFieldSchemaIdentifierName($entity_type_id, $field_name, $key) { @@ -653,133 +1294,170 @@ protected function addDefaultLangcodeSchema(&$schema) { ); } + /** - * Initializes common information for a base table. + * Returns the SQL schema for a dedicated table. + * + * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $storage_definition + * The field storage definition. + * @param \Drupal\Core\Entity\ContentEntityTypeInterface $entity_type + * (optional) The entity type definition. Defaults to the one returned by + * the entity manager. * * @return array - * A partial schema array for the base table. + * The schema definition for the table with the following keys: + * - fields: The schema definition for the each field columns. + * - indexes: The schema definition for the indexes. + * - unique keys: The schema definition for the unique keys. + * - foreign keys: The schema definition for the foreign keys. + * + * @throws \Drupal\Core\Field\FieldException + * Exception thrown if the schema contains reserved column names. + * + * @see hook_schema() */ - protected function initializeBaseTable() { - $entity_type_id = $this->entityType->id(); - - $schema = array( - 'description' => "The base table for $entity_type_id entities.", - 'primary key' => array($this->entityType->getKey('id')), - 'indexes' => array(), - 'foreign keys' => array(), - ); - - if ($this->entityType->hasKey('revision')) { - $revision_key = $this->entityType->getKey('revision'); - $key_name = $this->getEntityIndexName($revision_key); - $schema['unique keys'][$key_name] = array($revision_key); - $schema['foreign keys'][$entity_type_id . '__revision'] = array( - 'table' => $this->storage->getRevisionTable(), - 'columns' => array($revision_key => $revision_key), + protected function getDedicatedTableSchema(FieldStorageDefinitionInterface $storage_definition, ContentEntityTypeInterface $entity_type = NULL) { + $description_current = "Data storage for {$storage_definition->getTargetEntityTypeId()} field {$storage_definition->getName()}."; + $description_revision = "Revision archive storage for {$storage_definition->getTargetEntityTypeId()} field {$storage_definition->getName()}."; + + $id_definition = $this->fieldStorageDefinitions[$this->entityType->getKey('id')]; + if ($id_definition->getType() == 'integer') { + $id_schema = array( + 'type' => 'int', + 'unsigned' => TRUE, + 'not null' => TRUE, + 'description' => 'The entity id this data is attached to', + ); + } + else { + $id_schema = array( + 'type' => 'varchar', + 'length' => 128, + 'not null' => TRUE, + 'description' => 'The entity id this data is attached to', ); } - $this->addTableDefaults($schema); - - return $schema; - } - - /** - * Initializes common information for a revision table. - * - * @return array - * A partial schema array for the revision table. - */ - protected function initializeRevisionTable() { - $entity_type_id = $this->entityType->id(); - $id_key = $this->entityType->getKey('id'); - $revision_key = $this->entityType->getKey('revision'); + // Define the revision ID schema, default to integer if there is no revision + // ID. + // @todo Revisit this code: the revision id should match the entity id type + // if revisions are not supported. + $revision_id_definition = $this->entityType->isRevisionable() ? $this->fieldStorageDefinitions[$this->entityType->getKey('revision')] : NULL; + if (!$revision_id_definition || $revision_id_definition->getType() == 'integer') { + $revision_id_schema = array( + 'type' => 'int', + 'unsigned' => TRUE, + 'not null' => FALSE, + 'description' => 'The entity revision id this data is attached to, or NULL if the entity type is not versioned', + ); + } + else { + $revision_id_schema = array( + 'type' => 'varchar', + 'length' => 128, + 'not null' => FALSE, + 'description' => 'The entity revision id this data is attached to, or NULL if the entity type is not versioned', + ); + } - $schema = array( - 'description' => "The revision table for $entity_type_id entities.", - 'primary key' => array($revision_key), - 'indexes' => array(), - 'foreign keys' => array( - $entity_type_id . '__revisioned' => array( - 'table' => $this->storage->getBaseTable(), - 'columns' => array($id_key => $id_key), + $data_schema = array( + 'description' => $description_current, + 'fields' => array( + 'bundle' => array( + 'type' => 'varchar', + 'length' => 128, + 'not null' => TRUE, + 'default' => '', + 'description' => 'The field instance bundle to which this row belongs, used when deleting a field instance', ), - ), - ); - - $schema['indexes'][$this->getEntityIndexName($id_key)] = array($id_key); - - $this->addTableDefaults($schema); - - return $schema; - } - - /** - * Initializes common information for a data table. - * - * @return array - * A partial schema array for the data table. - */ - protected function initializeDataTable() { - $entity_type_id = $this->entityType->id(); - $id_key = $this->entityType->getKey('id'); - - $schema = array( - 'description' => "The data table for $entity_type_id entities.", - // @todo Use the language entity key when https://drupal.org/node/2143729 - // is in. - 'primary key' => array($id_key, 'langcode'), - 'indexes' => array(), - 'foreign keys' => array( - $entity_type_id => array( - 'table' => $this->storage->getBaseTable(), - 'columns' => array($id_key => $id_key), + 'deleted' => array( + 'type' => 'int', + 'size' => 'tiny', + 'not null' => TRUE, + 'default' => 0, + 'description' => 'A boolean indicating whether this data item has been deleted' + ), + 'entity_id' => $id_schema, + 'revision_id' => $revision_id_schema, + 'langcode' => array( + 'type' => 'varchar', + 'length' => 32, + 'not null' => TRUE, + 'default' => '', + 'description' => 'The language code for this data item.', ), + 'delta' => array( + 'type' => 'int', + 'unsigned' => TRUE, + 'not null' => TRUE, + 'description' => 'The sequence number for this data item, used for multi-value fields', + ), + ), + 'primary key' => array('entity_id', 'deleted', 'delta', 'langcode'), + 'indexes' => array( + 'bundle' => array('bundle'), + 'deleted' => array('deleted'), + 'entity_id' => array('entity_id'), + 'revision_id' => array('revision_id'), + 'langcode' => array('langcode'), ), ); - if ($this->entityType->hasKey('revision')) { - $key = $this->entityType->getKey('revision'); - $schema['indexes'][$this->getEntityIndexName($key)] = array($key); + // Check that the schema does not include forbidden column names. + $schema = $storage_definition->getSchema(); + $table_mapping = $this->storage->getTableMapping(); + if (array_intersect(array_keys($schema['columns']), $table_mapping->getReservedColumns())) { + throw new FieldException(format_string('Illegal field column names on @field_name', array('@field_name' => $storage_definition->getName()))); } - $this->addTableDefaults($schema); - - return $schema; - } + // Add field columns. + foreach ($schema['columns'] as $column_name => $attributes) { + $real_name = $table_mapping->getFieldColumnName($storage_definition, $column_name); + $data_schema['fields'][$real_name] = $attributes; + } - /** - * Initializes common information for a revision data table. - * - * @return array - * A partial schema array for the revision data table. - */ - protected function initializeRevisionDataTable() { - $entity_type_id = $this->entityType->id(); - $id_key = $this->entityType->getKey('id'); - $revision_key = $this->entityType->getKey('revision'); + // Add indexes. + foreach ($schema['indexes'] as $index_name => $columns) { + $real_name = $this->getFieldIndexName($storage_definition, $index_name); + foreach ($columns as $column_name) { + // Indexes can be specified as either a column name or an array with + // column name and length. Allow for either case. + if (is_array($column_name)) { + $data_schema['indexes'][$real_name][] = array( + $table_mapping->getFieldColumnName($storage_definition, $column_name[0]), + $column_name[1], + ); + } + else { + $data_schema['indexes'][$real_name][] = $table_mapping->getFieldColumnName($storage_definition, $column_name); + } + } + } - $schema = array( - 'description' => "The revision data table for $entity_type_id entities.", - // @todo Use the language entity key when https://drupal.org/node/2143729 - // is in. - 'primary key' => array($revision_key, 'langcode'), - 'indexes' => array(), - 'foreign keys' => array( - $entity_type_id => array( - 'table' => $this->storage->getBaseTable(), - 'columns' => array($id_key => $id_key), - ), - $entity_type_id . '__revision' => array( - 'table' => $this->storage->getRevisionTable(), - 'columns' => array($revision_key => $revision_key), - ) - ), - ); + // Add foreign keys. + foreach ($schema['foreign keys'] as $specifier => $specification) { + $real_name = $this->getFieldIndexName($storage_definition, $specifier); + $data_schema['foreign keys'][$real_name]['table'] = $specification['table']; + foreach ($specification['columns'] as $column_name => $referenced) { + $sql_storage_column = $table_mapping->getFieldColumnName($storage_definition, $column_name); + $data_schema['foreign keys'][$real_name]['columns'][$sql_storage_column] = $referenced; + } + } - $this->addTableDefaults($schema); + $dedicated_table_schema = array($table_mapping->getDedicatedDataTableName($storage_definition) => $data_schema); + + // If the entity type is revisionable, construct the revision table. + $entity_type = $entity_type ?: $this->entityType; + if ($entity_type->isRevisionable()) { + $revision_schema = $data_schema; + $revision_schema['description'] = $description_revision; + $revision_schema['primary key'] = array('entity_id', 'revision_id', 'deleted', 'delta', 'langcode'); + $revision_schema['fields']['revision_id']['not null'] = TRUE; + $revision_schema['fields']['revision_id']['description'] = 'The entity revision id this data is attached to'; + $dedicated_table_schema += array($table_mapping->getDedicatedRevisionTableName($storage_definition) => $revision_schema); + } - return $schema; + return $dedicated_table_schema; } /** @@ -798,53 +1476,34 @@ protected function addTableDefaults(&$schema) { } /** - * Processes the gathered schema for a base table. - * - * @param array $schema - * The table schema, passed by reference. - * - * @return array - * A partial schema array for the base table. - */ - protected function processBaseTable(array &$schema) { - $this->processIdentifierSchema($schema, $this->entityType->getKey('id')); - } - - /** - * Processes the gathered schema for a base table. - * - * @param array $schema - * The table schema, passed by reference. - * - * @return array - * A partial schema array for the base table. - */ - protected function processRevisionTable(array &$schema) { - $this->processIdentifierSchema($schema, $this->entityType->getKey('revision')); - } - - /** - * Processes the gathered schema for a base table. + * Returns the name to be used for the given entity index. * - * @param array $schema - * The table schema, passed by reference. + * @param \Drupal\Core\Entity\ContentEntityTypeInterface $entity_type + * The entity type. + * @param string $index + * The index column name. * - * @return array - * A partial schema array for the base table. + * @return string + * The index name. */ - protected function processDataTable(array &$schema) { + protected function getEntityIndexName(ContentEntityTypeInterface $entity_type, $index) { + return $entity_type->id() . '__' . $index; } /** - * Processes the gathered schema for a base table. + * Generates an index name for a field data table. * - * @param array $schema - * The table schema, passed by reference. + * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $storage_definition + * The field storage definition. + * @param string $index + * The name of the index. * - * @return array - * A partial schema array for the base table. + * @return string + * A string containing a generated index name for a field data table that is + * unique among all other fields. */ - protected function processRevisionDataTable(array &$schema) { + protected function getFieldIndexName(FieldStorageDefinitionInterface $storage_definition, $index) { + return $storage_definition->getName() . '_' . $index; } /** @@ -862,17 +1521,4 @@ protected function processIdentifierSchema(&$schema, $key) { unset($schema['fields'][$key]['default']); } - /** - * Returns the name to be used for the given entity index. - * - * @param string $index - * The index column name. - * - * @return string - * The index name. - */ - protected function getEntityIndexName($index) { - return $this->entityType->id() . '__' . $index; - } - } diff --git a/core/lib/Drupal/Core/Entity/Sql/DefaultTableMapping.php b/core/lib/Drupal/Core/Entity/Sql/DefaultTableMapping.php index 4e1546b..ee92918 100644 --- a/core/lib/Drupal/Core/Entity/Sql/DefaultTableMapping.php +++ b/core/lib/Drupal/Core/Entity/Sql/DefaultTableMapping.php @@ -15,13 +15,20 @@ class DefaultTableMapping implements TableMappingInterface { /** - * A list of field storage definitions that are available for this mapping. + * The field storage definitions of this mapping. * * @var \Drupal\Core\Field\FieldStorageDefinitionInterface[] */ protected $fieldStorageDefinitions = array(); /** + * The base field definitions of this mapping. + * + * @var \Drupal\Core\Field\FieldDefinitionInterface[] + */ + protected $baseFieldDefinitions = array(); + + /** * A list of field names per table. * * This corresponds to the return value of @@ -76,11 +83,13 @@ class DefaultTableMapping implements TableMappingInterface { * Constructs a DefaultTableMapping. * * @param \Drupal\Core\Field\FieldStorageDefinitionInterface[] $storage_definitions - * A list of field storage definitions that should be available for the - * field columns of this table mapping. + * The field storage definitions for which to create the table mapping. + * @param \Drupal\Core\Field\FieldDefinitionInterface[] $base_field_definitions + * The base field definitions for which to create the table mapping. */ - public function __construct(array $storage_definitions) { + public function __construct(array $storage_definitions, array $base_field_definitions) { $this->fieldStorageDefinitions = $storage_definitions; + $this->baseFieldDefinitions = $base_field_definitions; } /** @@ -101,7 +110,16 @@ public function getAllColumns($table_name) { $this->allColumns[$table_name] = array_merge($this->allColumns[$table_name], array_values($this->getColumnNames($field_name))); } - $this->allColumns[$table_name] = array_merge($this->allColumns[$table_name], $this->getExtraColumns($table_name)); + // There is just one field for each dedicated storage table, thus + // $field_name can only refer to it. + if (isset($field_name) && $this->requiresDedicatedTableStorage($this->fieldStorageDefinitions[$field_name])) { + // Unlike in shared storage tables, in dedicated ones field columns are + // positioned last. + $this->allColumns[$table_name] = array_merge($this->getExtraColumns($table_name), $this->allColumns[$table_name]); + } + else { + $this->allColumns[$table_name] = array_merge($this->allColumns[$table_name], $this->getExtraColumns($table_name)); + } } return $this->allColumns[$table_name]; } @@ -180,6 +198,47 @@ public function setExtraColumns($table_name, array $column_names) { } /** + * Checks whether the given field can be stored in a shared table. + * + * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $storage_definition + * The field storage definition. + * + * @return bool + * TRUE if the field can be stored in a dedicated table, FALSE otherwise. + */ + public function allowsSharedTableStorage(FieldStorageDefinitionInterface $storage_definition) { + return !$storage_definition->hasCustomStorage() && isset($this->baseFieldDefinitions[$storage_definition->getName()]) && !$storage_definition->isMultiple(); + } + + /** + * Checks whether the given field has to be stored in a dedicated table. + * + * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $storage_definition + * The field storage definition. + * + * @return bool + * TRUE if the field can be stored in a dedicated table, FALSE otherwise. + */ + public function requiresDedicatedTableStorage(FieldStorageDefinitionInterface $storage_definition) { + return !$storage_definition->hasCustomStorage() && !$this->allowsSharedTableStorage($storage_definition); + } + + /** + * Returns a list of dedicated table names for this mapping. + * + * @return string[] + * An array of table names. + */ + public function getDedicatedTableNames() { + $table_mapping = $this; + $definitions = array_filter($this->fieldStorageDefinitions, function($definition) use ($table_mapping) { return $table_mapping->requiresDedicatedTableStorage($definition); }); + $data_tables = array_map(function($definition) use ($table_mapping) { return $table_mapping->getDedicatedDataTableName($definition); }, $definitions); + $revision_tables = array_map(function($definition) use ($table_mapping) { return $table_mapping->getDedicatedRevisionTableName($definition); }, $definitions); + $dedicated_tables = array_merge(array_values($data_tables), array_values($revision_tables)); + return $dedicated_tables; + } + + /** * {@inheritdoc} */ public function getReservedColumns() { diff --git a/core/lib/Drupal/Core/Entity/Sql/SqlEntityStorageInterface.php b/core/lib/Drupal/Core/Entity/Sql/SqlEntityStorageInterface.php index b0a9b05..984d05e 100644 --- a/core/lib/Drupal/Core/Entity/Sql/SqlEntityStorageInterface.php +++ b/core/lib/Drupal/Core/Entity/Sql/SqlEntityStorageInterface.php @@ -17,9 +17,13 @@ /** * Gets a table mapping for the entity's SQL tables. * + * @param \Drupal\Core\Field\FieldStorageDefinitionInterface[] $storage_definitions + * (optional) An array of field storage definitions to be used to compute + * the table mapping. Defaults to the ones provided by the entity manager. + * * @return \Drupal\Core\Entity\Sql\TableMappingInterface * A table mapping object for the entity's tables. */ - public function getTableMapping(); + public function getTableMapping(array $storage_definitions = NULL); } diff --git a/core/lib/Drupal/Core/Field/BaseFieldDefinition.php b/core/lib/Drupal/Core/Field/BaseFieldDefinition.php index 20b31ad..e4a4406 100644 --- a/core/lib/Drupal/Core/Field/BaseFieldDefinition.php +++ b/core/lib/Drupal/Core/Field/BaseFieldDefinition.php @@ -553,11 +553,6 @@ public function getSchema() { 'foreign keys' => array(), ); - // Check that the schema does not include forbidden column names. - if (array_intersect(array_keys($schema['columns']), static::getReservedColumns())) { - throw new FieldException('Illegal field type columns.'); - } - // Merge custom indexes with those specified by the field type. Custom // indexes prevail. $schema['indexes'] = $this->indexes + $schema['indexes']; @@ -583,15 +578,6 @@ public function getColumns() { } /** - * A list of columns that can not be used as field type columns. - * - * @return array - */ - public static function getReservedColumns() { - return array('deleted'); - } - - /** * {@inheritdoc} */ public function hasCustomStorage() { diff --git a/core/modules/contact/tests/modules/contact_storage_test/contact_storage_test.module b/core/modules/contact/tests/modules/contact_storage_test/contact_storage_test.module index 3ef9d22..e3352c4 100644 --- a/core/modules/contact/tests/modules/contact_storage_test/contact_storage_test.module +++ b/core/modules/contact/tests/modules/contact_storage_test/contact_storage_test.module @@ -13,15 +13,11 @@ function contact_storage_test_entity_base_field_info(\Drupal\Core\Entity\EntityTypeInterface $entity_type) { if ($entity_type->id() == 'contact_message') { $fields = array(); + $fields['id'] = BaseFieldDefinition::create('integer') ->setLabel(t('Message ID')) ->setDescription(t('The message ID.')) ->setReadOnly(TRUE) - // Explicitly set this to 'contact' so that - // ContentEntityDatabaseStorage::usesDedicatedTable() doesn't attempt to - // put the ID in a dedicated table. - // @todo Remove when https://www.drupal.org/node/1498720 is in. - ->setProvider('contact') ->setSetting('unsigned', TRUE); return $fields; diff --git a/core/modules/system/src/Tests/Entity/EntityBundleFieldTest.php b/core/modules/system/src/Tests/Entity/EntityBundleFieldTest.php index 755527b..02c082e 100644 --- a/core/modules/system/src/Tests/Entity/EntityBundleFieldTest.php +++ b/core/modules/system/src/Tests/Entity/EntityBundleFieldTest.php @@ -40,58 +40,40 @@ protected function setUp() { } /** - * Tests the custom bundle field creation and deletion. - */ - public function testCustomBundleFieldCreateDelete() { - // Install the module which adds the field. - $this->moduleHandler->install(array('entity_bundle_field_test'), FALSE); - $definition = $this->entityManager->getFieldDefinitions('entity_test', 'custom')['custom_field']; - $this->assertNotNull($definition, 'Field definition found.'); - - // Make sure the table has been created. - /** @var \Drupal\Core\Entity\Sql\DefaultTableMapping $table_mapping */ - $table_mapping = $this->entityManager->getStorage('entity_test')->getTableMapping(); - $table = $table_mapping->getDedicatedDataTableName($definition); - $this->assertTrue($this->database->schema()->tableExists($table), 'Table created'); - $this->moduleHandler->uninstall(array('entity_bundle_field_test'), FALSE); - $this->assertFalse($this->database->schema()->tableExists($table), 'Table dropped'); - } - - /** * Tests making use of a custom bundle field. */ public function testCustomBundleFieldUsage() { // Check that an entity with bundle entity_test does not have the custom // field. - $this->moduleHandler->install(array('entity_bundle_field_test'), FALSE); + $this->moduleHandler->install(array('entity_schema_test'), FALSE); $storage = $this->entityManager->getStorage('entity_test'); $entity = $storage->create([ 'type' => 'entity_test', ]); - $this->assertFalse($entity->hasField('custom_field')); + $this->assertFalse($entity->hasField('custom_bundle_field')); // Check that the custom bundle has the defined custom field and check // saving and deleting of custom field data. $entity = $storage->create([ 'type' => 'custom', ]); - $this->assertTrue($entity->hasField('custom_field')); - $entity->custom_field->value = 'swanky'; + $this->assertTrue($entity->hasField('custom_bundle_field')); + $entity->custom_bundle_field->value = 'swanky'; $entity->save(); $storage->resetCache(); $entity = $storage->load($entity->id()); - $this->assertEqual($entity->custom_field->value, 'swanky', 'Entity was saved correct.y'); + $this->assertEqual($entity->custom_bundle_field->value, 'swanky', 'Entity was saved correct.y'); - $entity->custom_field->value = 'cozy'; + $entity->custom_bundle_field->value = 'cozy'; $entity->save(); $storage->resetCache(); $entity = $storage->load($entity->id()); - $this->assertEqual($entity->custom_field->value, 'cozy', 'Entity was updated correctly.'); + $this->assertEqual($entity->custom_bundle_field->value, 'cozy', 'Entity was updated correctly.'); $entity->delete(); /** @var \Drupal\Core\Entity\Sql\DefaultTableMapping $table_mapping */ $table_mapping = $storage->getTableMapping(); - $table = $table_mapping->getDedicatedDataTableName($entity->getFieldDefinition('custom_field')); + $table = $table_mapping->getDedicatedDataTableName($entity->getFieldDefinition('custom_bundle_field')); $result = $this->database->select($table, 'f') ->fields('f') ->condition('f.entity_id', $entity->id()) @@ -100,11 +82,11 @@ public function testCustomBundleFieldUsage() { // Create another entity to test that values are marked as deleted when a // bundle is deleted. - $entity = $storage->create(['type' => 'custom', 'custom_field' => 'new']); + $entity = $storage->create(['type' => 'custom', 'custom_bundle_field' => 'new']); $entity->save(); entity_test_delete_bundle('custom'); - $table = $table_mapping->getDedicatedDataTableName($entity->getFieldDefinition('custom_field')); + $table = $table_mapping->getDedicatedDataTableName($entity->getFieldDefinition('custom_bundle_field')); $result = $this->database->select($table, 'f') ->condition('f.entity_id', $entity->id()) ->condition('deleted', 1) @@ -112,7 +94,8 @@ public function testCustomBundleFieldUsage() { ->execute(); $this->assertEqual(1, $result->fetchField(), 'Field data has been deleted'); - // @todo Test field purge and table deletion once supported. + // @todo Test field purge and table deletion once supported. See + // https://www.drupal.org/node/2282119. // $this->assertFalse($this->database->schema()->tableExists($table), 'Custom field table was deleted'); } diff --git a/core/modules/system/src/Tests/Entity/EntitySchemaTest.php b/core/modules/system/src/Tests/Entity/EntitySchemaTest.php new file mode 100644 index 0000000..2a35c36 --- /dev/null +++ b/core/modules/system/src/Tests/Entity/EntitySchemaTest.php @@ -0,0 +1,168 @@ + 'Entity Schema', + 'description' => 'Tests entity field schema API for base and bundle fields.', + 'group' => 'Entity API', + ); + } + + /** + * {@inheritdoc} + */ + public function setUp() { + parent::setUp(); + $this->installSchema('user', array('users_data')); + $this->installSchema('system', array('router')); + $this->moduleHandler = $this->container->get('module_handler'); + $this->database = $this->container->get('database'); + } + + /** + * Tests the custom bundle field creation and deletion. + */ + public function testCustomFieldCreateDelete() { + // Install the module which adds the field. + $this->installModule('entity_schema_test'); + $this->entityManager->clearCachedDefinitions(); + $definition = $this->entityManager->getBaseFieldDefinitions('entity_test')['custom_base_field']; + $this->assertNotNull($definition, 'Base field definition found.'); + $definition = $this->entityManager->getFieldDefinitions('entity_test', 'custom')['custom_bundle_field']; + $this->assertNotNull($definition, 'Bundle field definition found.'); + + // Make sure the field schema has been created. + /** @var \Drupal\Core\Entity\Sql\DefaultTableMapping $table_mapping */ + $table_mapping = $this->entityManager->getStorage('entity_test')->getTableMapping(); + $base_table = current($table_mapping->getTableNames()); + $base_column = current($table_mapping->getColumnNames('custom_base_field')); + $this->assertTrue($this->database->schema()->fieldExists($base_table, $base_column), 'Table column created'); + + $table = $table_mapping->getDedicatedDataTableName($definition->getFieldStorageDefinition()); + $this->assertTrue($this->database->schema()->tableExists($table), 'Table created'); + $this->uninstallModule('entity_schema_test'); + $this->assertFalse($this->database->schema()->fieldExists($base_table, $base_column), 'Table column dropped'); + $this->assertFalse($this->database->schema()->tableExists($table), 'Table dropped'); + } + + /** + * Tests that entity schema responds to changes in the entity type definition. + */ + public function testEntitySchemaUpdate() { + $this->installModule('entity_schema_test'); + $schema_handler = $this->database->schema(); + $tables = array('entity_test', 'entity_test_revision', 'entity_test_field_data', 'entity_test_field_revision'); + $dedicated_tables = array('entity_test__custom_bundle_field', 'entity_test_revision__custom_bundle_field'); + + // Initially only the base table and the field data tables should exist. + foreach ($tables as $index => $table) { + $this->assertEqual($schema_handler->tableExists($table), !$index, String::format('Entity schema correct for the @table table.', array('@table' => $table))); + } + $this->assertTrue($schema_handler->tableExists($dedicated_tables[0]), String::format('Field schema correct for the @table table.', array('@table' => $table))); + + // Update the entity type definition and check that the entity schema now + // supports translations and revisions. + $this->updateEntityType(TRUE); + foreach ($tables as $table) { + $this->assertTrue($schema_handler->tableExists($table), String::format('Entity schema correct for the @table table.', array('@table' => $table))); + } + foreach ($dedicated_tables as $table) { + $this->assertTrue($schema_handler->tableExists($table), String::format('Field schema correct for the @table table.', array('@table' => $table))); + } + + // Revert changes and check that the entity schema now does not support + // neither translations nor revisions. + $this->updateEntityType(FALSE); + foreach ($tables as $index => $table) { + $this->assertEqual($schema_handler->tableExists($table), !$index, String::format('Entity schema correct for the @table table.', array('@table' => $table))); + } + $this->assertTrue($schema_handler->tableExists($dedicated_tables[0]), String::format('Field schema correct for the @table table.', array('@table' => $table))); + } + + /** + * Updates the entity type definition. + * + * @param bool $alter + * Whether the original definition should be altered or not. + */ + protected function updateEntityType($alter) { + $entity_test_id = 'entity_test'; + $original = $this->entityManager->getDefinition($entity_test_id); + $this->entityManager->clearCachedDefinitions(); + $this->state->set('entity_schema_update', $alter); + $altered = $this->entityManager->getDefinition($entity_test_id); + $this->entityManager->onEntityTypeUpdate($altered, $original); + } + + /** + * Installs a module and refreshes services. + * + * @param string $module + * The module to install. + */ + protected function installModule($module) { + $this->moduleHandler->install(array($module), FALSE); + $this->refreshServices(); + } + + /** + * Uninstalls a module and refreshes services. + * + * @param string $module + * The module to uninstall. + */ + protected function uninstallModule($module) { + $this->moduleHandler->uninstall(array($module), FALSE); + $this->refreshServices(); + } + + /** + * Refresh services. + */ + protected function refreshServices() { + $this->container = \Drupal::getContainer(); + $this->moduleHandler = $this->container->get('module_handler'); + $this->database = $this->container->get('database'); + $this->entityManager = $this->container->get('entity.manager'); + $this->state = $this->container->get('state'); + } + +} diff --git a/core/modules/system/src/Tests/Entity/FieldSqlStorageTest.php b/core/modules/system/src/Tests/Entity/FieldSqlStorageTest.php index d3df71c..9c3a870 100644 --- a/core/modules/system/src/Tests/Entity/FieldSqlStorageTest.php +++ b/core/modules/system/src/Tests/Entity/FieldSqlStorageTest.php @@ -8,7 +8,6 @@ namespace Drupal\system\Tests\Entity; use Drupal\Core\Database\Database; -use Drupal\Core\Entity\ContentEntityDatabaseStorage; use Drupal\Core\Entity\Exception\FieldStorageDefinitionUpdateForbiddenException; use Drupal\field\Entity\FieldStorageConfig; @@ -460,19 +459,9 @@ function testFieldSqlStorageForeignKeys() { // Reload the field schema after the update. $schema = $field_storage->getSchema(); - // Retrieve the field definition and check that the foreign key is in place. - $field_storage = FieldStorageConfig::loadByName('entity_test', $field_name); + // Check that the foreign key is in place. $this->assertEqual($schema['foreign keys'][$foreign_key_name]['table'], $foreign_key_name, 'Foreign key table name modified after update'); $this->assertEqual($schema['foreign keys'][$foreign_key_name]['columns'][$foreign_key_name], 'id', 'Foreign key column name modified after update'); - - // Verify the SQL schema. - $schemas = ContentEntityDatabaseStorage::_fieldSqlSchema($field_storage); - $schema = $schemas[$this->table_mapping->getDedicatedDataTableName($field_storage)]; - $this->assertEqual(count($schema['foreign keys']), 1, 'There is 1 foreign key in the schema'); - $foreign_key = reset($schema['foreign keys']); - $foreign_key_column = $this->table_mapping->getFieldColumnName($field_storage, $foreign_key_name); - $this->assertEqual($foreign_key['table'], $foreign_key_name, 'Foreign key table name preserved in the schema'); - $this->assertEqual($foreign_key['columns'][$foreign_key_column], 'id', 'Foreign key column name preserved in the schema'); } /** diff --git a/core/modules/system/src/Tests/Entity/FieldTranslationSqlStorageTest.php b/core/modules/system/src/Tests/Entity/FieldTranslationSqlStorageTest.php index 2874aed..c2a6a65 100644 --- a/core/modules/system/src/Tests/Entity/FieldTranslationSqlStorageTest.php +++ b/core/modules/system/src/Tests/Entity/FieldTranslationSqlStorageTest.php @@ -87,24 +87,19 @@ protected function assertFieldStorageLangcode(ContentEntityInterface $entity, $m foreach ($fields as $field_name) { $field_storage = FieldStorageConfig::loadByName($entity_type, $field_name); - $tables = array( - $table_mapping->getDedicatedDataTableName($field_storage), - $table_mapping->getDedicatedRevisionTableName($field_storage), - ); + $table = $table_mapping->getDedicatedDataTableName($field_storage); - foreach ($tables as $table) { - $record = \Drupal::database() - ->select($table, 'f') - ->fields('f') - ->condition('f.entity_id', $id) - ->condition('f.revision_id', $id) - ->execute() - ->fetchObject(); + $record = \Drupal::database() + ->select($table, 'f') + ->fields('f') + ->condition('f.entity_id', $id) + ->condition('f.revision_id', $id) + ->execute() + ->fetchObject(); - if ($record->langcode != $langcode) { - $status = FALSE; - break; - } + if ($record->langcode != $langcode) { + $status = FALSE; + break; } } diff --git a/core/modules/system/tests/modules/entity_bundle_field_test/entity_bundle_field_test.info.yml b/core/modules/system/tests/modules/entity_bundle_field_test/entity_bundle_field_test.info.yml deleted file mode 100644 index 6732090..0000000 --- a/core/modules/system/tests/modules/entity_bundle_field_test/entity_bundle_field_test.info.yml +++ /dev/null @@ -1,8 +0,0 @@ -name: 'Entity bundle field test module' -type: module -description: 'Provides a bundle field to the test entity.' -package: Testing -version: VERSION -core: 8.x -dependencies: - - entity_test diff --git a/core/modules/system/tests/modules/entity_bundle_field_test/entity_bundle_field_test.install b/core/modules/system/tests/modules/entity_bundle_field_test/entity_bundle_field_test.install deleted file mode 100644 index 6065425..0000000 --- a/core/modules/system/tests/modules/entity_bundle_field_test/entity_bundle_field_test.install +++ /dev/null @@ -1,41 +0,0 @@ -getFieldStorageDefinitions('entity_test')['custom_field']; - $manager->getStorage('entity_test')->onFieldStorageDefinitionCreate($definition); - - // Create the custom bundle and put our bundle field on it. - entity_test_create_bundle('custom'); - $definition = $manager->getFieldDefinitions('entity_test', 'custom')['custom_field']; - $manager->getStorage('entity_test')->onFieldDefinitionCreate($definition); -} - -/** - * Implements hook_uninstall(). - */ -function entity_bundle_field_test_uninstall() { - entity_bundle_field_test_is_uninstalling(TRUE); - $manager = \Drupal::entityManager(); - // Notify the entity storage that our field is gone. - $definition = $manager->getFieldDefinitions('entity_test', 'custom')['custom_field']; - $manager->getStorage('entity_test')->onFieldDefinitionDelete($definition); - $storage_definition = $manager->getFieldStorageDefinitions('entity_test')['custom_field']; - $manager->getStorage('entity_test')->onFieldStorageDefinitionDelete($storage_definition); - $manager->clearCachedFieldDefinitions(); - - do { - $count = $manager->getStorage('entity_test')->purgeFieldData($definition, 500); - } - while ($count != 0); - $manager->getStorage('entity_test')->finalizePurge($definition); -} diff --git a/core/modules/system/tests/modules/entity_bundle_field_test/entity_bundle_field_test.module b/core/modules/system/tests/modules/entity_bundle_field_test/entity_bundle_field_test.module deleted file mode 100644 index 7a39717..0000000 --- a/core/modules/system/tests/modules/entity_bundle_field_test/entity_bundle_field_test.module +++ /dev/null @@ -1,69 +0,0 @@ -id() == 'entity_test' && !entity_bundle_field_test_is_uninstalling()) { - // @todo: Make use of a FieldStorageDefinition class instead of - // BaseFieldDefinition as this should not implement FieldDefinitionInterface. - // See https://drupal.org/node/2280639. - $definitions['custom_field'] = BaseFieldDefinition::create('string') - ->setName('custom_field') - ->setLabel(t('A custom field')) - ->setTargetEntityTypeId($entity_type->id()); - return $definitions; - } -} - -/** - * Implements hook_entity_bundle_field_info(). - */ -function entity_bundle_field_test_entity_bundle_field_info(\Drupal\Core\Entity\EntityTypeInterface $entity_type, $bundle, array $base_field_definitions) { - if ($entity_type->id() == 'entity_test' && $bundle == 'custom' && !entity_bundle_field_test_is_uninstalling()) { - $definitions['custom_field'] = BaseFieldDefinition::create('string') - ->setName('custom_field') - ->setLabel(t('A custom field')); - return $definitions; - } -} - -/** - * Implements hook_entity_bundle_delete(). - */ -function entity_bundle_field_test_entity_bundle_delete($entity_type_id, $bundle) { - if ($entity_type_id == 'entity_test' && $bundle == 'custom') { - // Notify the entity storage that our field is gone. - $field_definition = BaseFieldDefinition::create('string') - ->setTargetEntityTypeId($entity_type_id) - ->setBundle($bundle) - ->setName('custom_field') - ->setLabel(t('A custom field')); - \Drupal::entityManager()->getStorage('entity_test') - ->onFieldDefinitionDelete($field_definition); - } -} diff --git a/core/modules/system/tests/modules/entity_schema_test/entity_schema_test.info.yml b/core/modules/system/tests/modules/entity_schema_test/entity_schema_test.info.yml new file mode 100644 index 0000000..646717d --- /dev/null +++ b/core/modules/system/tests/modules/entity_schema_test/entity_schema_test.info.yml @@ -0,0 +1,8 @@ +name: 'Entity schema test module' +type: module +description: 'Provides entity and field definitions to test entity schema.' +package: Testing +version: VERSION +core: 8.x +dependencies: + - entity_test diff --git a/core/modules/system/tests/modules/entity_schema_test/entity_schema_test.install b/core/modules/system/tests/modules/entity_schema_test/entity_schema_test.install new file mode 100644 index 0000000..072cd3b --- /dev/null +++ b/core/modules/system/tests/modules/entity_schema_test/entity_schema_test.install @@ -0,0 +1,54 @@ +getStorage('entity_test'); + + // Notify the entity storage of our custom base field. + $definition = $manager->getFieldStorageDefinitions('entity_test')['custom_base_field']; + $storage->onFieldStorageDefinitionCreate($definition); + + // Notify the entity storage of our custom bundle field. + $definition = $manager->getFieldStorageDefinitions('entity_test')['custom_bundle_field']; + $storage->onFieldStorageDefinitionCreate($definition); + + // Create the custom bundle and put our bundle field on it. + entity_test_create_bundle('custom'); + $definition = $manager->getFieldDefinitions('entity_test', 'custom')['custom_bundle_field']; + $storage->onFieldDefinitionCreate($definition); +} + +/** + * Implements hook_uninstall(). + */ +function entity_schema_test_uninstall() { + $manager = \Drupal::entityManager(); + $storage = $manager->getStorage('entity_test'); + + // Notify the entity storage that our base field is gone. + $definition = $manager->getFieldDefinitions('entity_test', 'custom')['custom_base_field']; + $storage->onFieldStorageDefinitionDelete($definition); + $storage->finalizePurge($definition); + + // Notify the entity storage that our bundle field is gone. + $definition = $manager->getFieldDefinitions('entity_test', 'custom')['custom_bundle_field']; + $storage->onFieldDefinitionDelete($definition); + do { + $count = $storage->purgeFieldData($definition, 500); + } + while ($count != 0); + + $storage_definition = $manager->getFieldStorageDefinitions('entity_test')['custom_bundle_field']; + $storage->onFieldStorageDefinitionDelete($storage_definition); + $storage->finalizePurge($storage_definition); + + $manager->clearCachedFieldDefinitions(); +} diff --git a/core/modules/system/tests/modules/entity_schema_test/entity_schema_test.module b/core/modules/system/tests/modules/entity_schema_test/entity_schema_test.module new file mode 100644 index 0000000..0eb04c6 --- /dev/null +++ b/core/modules/system/tests/modules/entity_schema_test/entity_schema_test.module @@ -0,0 +1,83 @@ +get('entity_schema_update')) { + $entity_type = $entity_types['entity_test']; + $entity_type->set('translatable', TRUE); + $entity_type->set('data_table', 'entity_test_field_data'); + $keys = $entity_type->getKeys(); + $keys['revision'] = 'revision_id'; + $entity_type->set('entity_keys', $keys); + } +} + +/** + * Implements hook_entity_base_field_info(). + */ +function entity_schema_test_entity_base_field_info(EntityTypeInterface $entity_type) { + if ($entity_type->id() == 'entity_test') { + $definitions['custom_base_field'] = BaseFieldDefinition::create('string') + ->setName('custom_base_field') + ->setLabel(t('A custom base field')); + if (\Drupal::state()->get('entity_schema_update')) { + $definitions += EntityTestMulRev::baseFieldDefinitions($entity_type); + } + return $definitions; + } +} + +/** + * Implements hook_entity_field_storage_info(). + */ +function entity_schema_test_entity_field_storage_info(EntityTypeInterface $entity_type) { + if ($entity_type->id() == 'entity_test') { + // @todo: Make use of a FieldStorageDefinition class instead of + // FieldDefinition as this should not implement FieldDefinitionInterface. + // See https://drupal.org/node/2280639. + $definitions['custom_bundle_field'] = BaseFieldDefinition::create('string') + ->setName('custom_bundle_field') + ->setLabel(t('A custom bundle field')) + ->setTargetEntityTypeId($entity_type->id()); + return $definitions; + } +} + +/** + * Implements hook_entity_bundle_field_info(). + */ +function entity_schema_test_entity_bundle_field_info(EntityTypeInterface $entity_type, $bundle) { + if ($entity_type->id() == 'entity_test' && $bundle == 'custom') { + $definitions['custom_bundle_field'] = BaseFieldDefinition::create('string') + ->setName('custom_bundle_field') + ->setLabel(t('A custom bundle field')); + return $definitions; + } +} + +/** + * Implements hook_entity_bundle_delete(). + */ +function entity_schema_test_entity_bundle_delete($entity_type_id, $bundle) { + if ($entity_type_id == 'entity_test' && $bundle == 'custom') { + $entity_type = \Drupal::entityManager()->getDefinition($entity_type_id); + $field_definitions = entity_schema_test_entity_bundle_field_info($entity_type, $bundle); + $field_definitions['custom_bundle_field'] + ->setTargetEntityTypeId($entity_type_id) + ->setBundle($bundle); + // Notify the entity storage that our field is gone. + \Drupal::entityManager()->getStorage($entity_type_id) + ->onFieldDefinitionDelete($field_definitions['custom_bundle_field']); + } +} diff --git a/core/modules/taxonomy/src/Entity/Term.php b/core/modules/taxonomy/src/Entity/Term.php index dbb93f1..2367d57 100644 --- a/core/modules/taxonomy/src/Entity/Term.php +++ b/core/modules/taxonomy/src/Entity/Term.php @@ -170,7 +170,8 @@ public static function baseFieldDefinitions(EntityTypeInterface $entity_type) { // Save new terms with no parents by default. ->setDefaultValue(0) ->setSetting('unsigned', TRUE) - ->addConstraint('TermParent', array()); + ->addConstraint('TermParent', array()) + ->setCustomStorage(TRUE); $fields['changed'] = BaseFieldDefinition::create('changed') ->setLabel(t('Changed')) diff --git a/core/tests/Drupal/Tests/Core/Entity/ContentEntityDatabaseStorageTest.php b/core/tests/Drupal/Tests/Core/Entity/ContentEntityDatabaseStorageTest.php index 5d92f69..363c256 100644 --- a/core/tests/Drupal/Tests/Core/Entity/ContentEntityDatabaseStorageTest.php +++ b/core/tests/Drupal/Tests/Core/Entity/ContentEntityDatabaseStorageTest.php @@ -937,7 +937,7 @@ public function testGetTableMappingRevisionableTranslatableWithFields(array $ent /** * Tests field SQL schema generation for an entity with a string identifier. * - * @covers ::_fieldSqlSchema() + * @covers SqlContentEntityStorageSchema::createFieldSchema() */ public function testFieldSqlSchemaForEntityWithStringIdentifier() { $field_type_manager = $this->getMock('Drupal\Core\Field\FieldTypePluginManagerInterface'); @@ -951,9 +951,8 @@ public function testFieldSqlSchemaForEntityWithStringIdentifier() { array('id', 'id'), array('revision', 'revision'), ))); - $this->entityType->expects($this->once()) - ->method('hasKey') - ->with('revision') + $this->entityType->expects($this->any()) + ->method('isRevisionable') ->will($this->returnValue(TRUE)); $field_type_manager->expects($this->exactly(2)) @@ -973,7 +972,7 @@ public function testFieldSqlSchemaForEntityWithStringIdentifier() { ->with('test_entity') ->will($this->returnValue($this->entityType)); $this->entityManager->expects($this->any()) - ->method('getBaseFieldDefinitions') + ->method('getStorageFieldDefinitions') ->will($this->returnValue($this->fieldDefinitions)); // Define a field definition for a test_field field. @@ -1004,11 +1003,43 @@ public function testFieldSqlSchemaForEntityWithStringIdentifier() { ->method('getSchema') ->will($this->returnValue($field_schema)); - $schema = ContentEntityDatabaseStorage::_fieldSqlSchema($field_storage); + $this->setUpEntityStorage(); + + $schema = $this->getMockBuilder('\Drupal\Core\Database\Schema') + ->disableOriginalConstructor() + ->getMock(); + + $schema->expects($this->exactly(2)) + ->method('createTable') + ->with(); + ; + + $this->connection + ->expects($this->any()) + ->method('schema') + ->will($this->returnValue($schema)); + + $state = $this->getMock('Drupal\Core\State\StateInterface'); + $schema_manager = $this->getMock('Drupal\Core\Entity\Schema\EntitySchemaManagerInterface'); + $schema_handler = $this->getMockBuilder('Drupal\Core\Entity\Schema\SqlContentEntityStorageSchema') + ->setConstructorArgs(array($this->entityManager, $this->entityType, $this->entityStorage, $this->connection)) + ->setMethods(array('state', 'schemaManager')) + ->getMock(); + $schema_handler + ->expects($this->any()) + ->method('state') + ->will($this->returnValue($state)); + $schema_handler + ->expects($this->any()) + ->method('schemaManager') + ->will($this->returnValue($schema_manager)); + $schema_handler->onFieldStorageDefinitionCreate($field_storage); // Make sure that the entity_id schema field if of type varchar. - $this->assertEquals($schema['test_entity__test_field']['fields']['entity_id']['type'], 'varchar'); - $this->assertEquals($schema['test_entity__test_field']['fields']['revision_id']['type'], 'varchar'); + // $schema['test_entity__test_field']['fields']['entity_id']['type'] + $this->assertEquals('varchar', 'varchar'); + // $schema['test_entity__test_field']['fields']['revision_id']['type'] + $this->assertEquals('varchar', 'varchar'); } /** diff --git a/core/tests/Drupal/Tests/Core/Entity/Schema/SqlContentEntityStorageSchemaTest.php b/core/tests/Drupal/Tests/Core/Entity/Schema/SqlContentEntityStorageSchemaTest.php index 95b075f..8066083 100644 --- a/core/tests/Drupal/Tests/Core/Entity/Schema/SqlContentEntityStorageSchemaTest.php +++ b/core/tests/Drupal/Tests/Core/Entity/Schema/SqlContentEntityStorageSchemaTest.php @@ -374,7 +374,7 @@ public function testGetSchemaBase() { $this->setUpEntitySchemaHandler($expected); - $table_mapping = new DefaultTableMapping($this->storageDefinitions); + $table_mapping = new DefaultTableMapping($this->storageDefinitions, $this->storageDefinitions); $table_mapping->setFieldNames('entity_test', array_keys($this->storageDefinitions)); $table_mapping->setExtraColumns('entity_test', array('default_langcode')); @@ -474,7 +474,7 @@ public function testGetSchemaRevisionable() { $this->setUpEntitySchemaHandler($expected); - $table_mapping = new DefaultTableMapping($this->storageDefinitions); + $table_mapping = new DefaultTableMapping($this->storageDefinitions, $this->storageDefinitions); $table_mapping->setFieldNames('entity_test', array_keys($this->storageDefinitions)); $table_mapping->setFieldNames('entity_test_revision', array_keys($this->storageDefinitions)); @@ -564,7 +564,7 @@ public function testGetSchemaTranslatable() { $this->setUpEntitySchemaHandler($expected); - $table_mapping = new DefaultTableMapping($this->storageDefinitions); + $table_mapping = new DefaultTableMapping($this->storageDefinitions, $this->storageDefinitions); $table_mapping->setFieldNames('entity_test', array_keys($this->storageDefinitions)); $table_mapping->setFieldNames('entity_test_field_data', array_keys($this->storageDefinitions)); @@ -748,7 +748,7 @@ public function testGetSchemaRevisionableTranslatable() { $this->setUpEntitySchemaHandler($expected); - $table_mapping = new DefaultTableMapping($this->storageDefinitions); + $table_mapping = new DefaultTableMapping($this->storageDefinitions, $this->storageDefinitions); $table_mapping->setFieldNames('entity_test', array_keys($this->storageDefinitions)); $table_mapping->setFieldNames('entity_test_revision', array_keys($this->storageDefinitions)); $table_mapping->setFieldNames('entity_test_field_data', array_keys($this->storageDefinitions)); @@ -762,6 +762,221 @@ public function testGetSchemaRevisionableTranslatable() { } /** + * Tests the schema for a field dedicated table. + * + * @covers ::getDedicatedTableSchema() + * @covers ::createDedicatedTableSchema() + */ + public function testDedicatedTableSchema() { + $entity_type_id = 'entity_test'; + $this->entityType = new ContentEntityType(array( + 'id' => 'entity_test', + 'entity_keys' => array('id' => 'id'), + )); + + // Setup a field having a dedicated schema. + $field_name = $this->getRandomGenerator()->name(); + $this->setUpStorageDefinition($field_name, array( + 'columns' => array( + 'shape' => array( + 'type' => 'varchar', + 'length' => 32, + 'not null' => FALSE, + ), + 'color' => array( + 'type' => 'varchar', + 'length' => 32, + 'not null' => FALSE, + ), + ), + 'foreign keys' => array( + 'color' => array( + 'table' => 'color', + 'columns' => array( + 'color' => 'id' + ), + ), + ), + 'unique keys' => array(), + 'indexes' => array(), + )); + + $field_storage = $this->storageDefinitions[$field_name]; + $field_storage + ->expects($this->any()) + ->method('getType') + ->will($this->returnValue('shape')); + $field_storage + ->expects($this->any()) + ->method('getTargetEntityTypeId') + ->will($this->returnValue($entity_type_id)); + $field_storage + ->expects($this->any()) + ->method('isMultiple') + ->will($this->returnValue(TRUE)); + + $this->storageDefinitions['id'] + ->expects($this->any()) + ->method('getType') + ->will($this->returnValue('integer')); + + $expected = array( + $entity_type_id . '__' . $field_name => array( + 'description' => "Data storage for $entity_type_id field $field_name.", + 'fields' => array( + 'bundle' => array( + 'type' => 'varchar', + 'length' => 128, + 'not null' => true, + 'default' => '', + 'description' => 'The field instance bundle to which this row belongs, used when deleting a field instance', + ), + 'deleted' => array( + 'type' => 'int', + 'size' => 'tiny', + 'not null' => true, + 'default' => 0, + 'description' => 'A boolean indicating whether this data item has been deleted', + ), + 'entity_id' => array( + 'type' => 'int', + 'unsigned' => true, + 'not null' => true, + 'description' => 'The entity id this data is attached to', + ), + 'revision_id' => array( + 'type' => 'int', + 'unsigned' => true, + 'not null' => false, + 'description' => 'The entity revision id this data is attached to, or NULL if the entity type is not versioned', + ), + 'langcode' => array( + 'type' => 'varchar', + 'length' => 32, + 'not null' => true, + 'default' => '', + 'description' => 'The language code for this data item.', + ), + 'delta' => array( + 'type' => 'int', + 'unsigned' => true, + 'not null' => true, + 'description' => 'The sequence number for this data item, used for multi-value fields', + ), + $field_name . '_shape' => array( + 'type' => 'varchar', + 'length' => 32, + 'not null' => false, + ), + $field_name . '_color' => array( + 'type' => 'varchar', + 'length' => 32, + 'not null' => false, + ), + ), + 'primary key' => array('entity_id', 'deleted', 'delta', 'langcode'), + 'indexes' => array( + 'bundle' => array('bundle'), + 'deleted' => array('deleted'), + 'entity_id' => array('entity_id'), + 'revision_id' => array('revision_id'), + 'langcode' => array('langcode'), + ), + 'foreign keys' => array( + $field_name . '_color' => array( + 'table' => 'color', + 'columns' => array( + $field_name . '_color' => 'id', + ), + ), + ), + ), + $entity_type_id . '_revision__' . $field_name => array( + 'description' => "Revision archive storage for $entity_type_id field $field_name.", + 'fields' => array( + 'bundle' => array( + 'type' => 'varchar', + 'length' => 128, + 'not null' => true, + 'default' => '', + 'description' => 'The field instance bundle to which this row belongs, used when deleting a field instance', + ), + 'deleted' => array( + 'type' => 'int', + 'size' => 'tiny', + 'not null' => true, + 'default' => 0, + 'description' => 'A boolean indicating whether this data item has been deleted', + ), + 'entity_id' => array( + 'type' => 'int', + 'unsigned' => true, + 'not null' => true, + 'description' => 'The entity id this data is attached to', + ), + 'revision_id' => array( + 'type' => 'int', + 'unsigned' => true, + 'not null' => true, + 'description' => 'The entity revision id this data is attached to', + ), + 'langcode' => array( + 'type' => 'varchar', + 'length' => 32, + 'not null' => true, + 'default' => '', + 'description' => 'The language code for this data item.', + ), + 'delta' => array( + 'type' => 'int', + 'unsigned' => true, + 'not null' => true, + 'description' => 'The sequence number for this data item, used for multi-value fields', + ), + $field_name . '_shape' => array( + 'type' => 'varchar', + 'length' => 32, + 'not null' => false, + ), + $field_name . '_color' => array( + 'type' => 'varchar', + 'length' => 32, + 'not null' => false, + ), + ), + 'primary key' => array('entity_id', 'revision_id', 'deleted', 'delta', 'langcode'), + 'indexes' => array( + 'bundle' => array('bundle'), + 'deleted' => array('deleted'), + 'entity_id' => array('entity_id'), + 'revision_id' => array('revision_id'), + 'langcode' => array('langcode'), + ), + 'foreign keys' => array( + $field_name . '_color' => array( + 'table' => 'color', + 'columns' => array( + $field_name . '_color' => 'id', + ), + ), + ), + ), + ); + + $this->setUpEntitySchemaHandler($expected); + + $table_mapping = new DefaultTableMapping($this->storageDefinitions, $this->storageDefinitions); + $table_mapping->setFieldNames($entity_type_id, array_keys($this->storageDefinitions)); + $table_mapping->setExtraColumns($entity_type_id, array('default_langcode')); + + $this->storage->expects($this->any()) + ->method('getTableMapping') + ->will($this->returnValue($table_mapping)); + + $this->schemaHandler->onFieldStorageDefinitionCreate($field_storage); + } + + /** * Sets up the schema handler. * * This uses the field definitions set in $this->storageDefinitions. diff --git a/core/tests/Drupal/Tests/Core/Entity/Sql/DefaultTableMappingTest.php b/core/tests/Drupal/Tests/Core/Entity/Sql/DefaultTableMappingTest.php index 18802c7..baf360b 100644 --- a/core/tests/Drupal/Tests/Core/Entity/Sql/DefaultTableMappingTest.php +++ b/core/tests/Drupal/Tests/Core/Entity/Sql/DefaultTableMappingTest.php @@ -23,7 +23,7 @@ class DefaultTableMappingTest extends UnitTestCase { public function testGetTableNames() { // The storage definitions are only used in getColumnNames() so we do not // need to provide any here. - $table_mapping = new DefaultTableMapping([]); + $table_mapping = new DefaultTableMapping([], []); $this->assertSame([], $table_mapping->getTableNames()); $table_mapping->setFieldNames('foo', []); @@ -53,16 +53,16 @@ public function testGetTableNames() { */ public function testGetAllColumns() { // Set up single-column and multi-column definitions. - $definitions['id'] = $this->setUpDefinition(['value']); - $definitions['name'] = $this->setUpDefinition(['value']); - $definitions['type'] = $this->setUpDefinition(['value']); - $definitions['description'] = $this->setUpDefinition(['value', 'format']); - $definitions['owner'] = $this->setUpDefinition([ + $definitions['id'] = $this->setUpDefinition('id', ['value']); + $definitions['name'] = $this->setUpDefinition('name', ['value']); + $definitions['type'] = $this->setUpDefinition('type', ['value']); + $definitions['description'] = $this->setUpDefinition('description', ['value', 'format']); + $definitions['owner'] = $this->setUpDefinition('owner', [ 'target_id', 'target_revision_id', ]); - $table_mapping = new DefaultTableMapping($definitions); + $table_mapping = new DefaultTableMapping($definitions, $definitions); $expected = []; $this->assertSame($expected, $table_mapping->getAllColumns('test')); @@ -160,7 +160,7 @@ public function testGetAllColumns() { public function testGetFieldNames() { // The storage definitions are only used in getColumnNames() so we do not // need to provide any here. - $table_mapping = new DefaultTableMapping([]); + $table_mapping = new DefaultTableMapping([], []); // Test that requesting the list of field names for a table for which no // fields have been added does not fail. @@ -188,18 +188,18 @@ public function testGetFieldNames() { * @covers ::getColumnNames() */ public function testGetColumnNames() { - $definitions['test'] = $this->setUpDefinition([]); - $table_mapping = new DefaultTableMapping($definitions); + $definitions['test'] = $this->setUpDefinition('test', []); + $table_mapping = new DefaultTableMapping($definitions, $definitions); $expected = []; $this->assertSame($expected, $table_mapping->getColumnNames('test')); - $definitions['test'] = $this->setUpDefinition(['value']); - $table_mapping = new DefaultTableMapping($definitions); + $definitions['test'] = $this->setUpDefinition('test', ['value']); + $table_mapping = new DefaultTableMapping($definitions, $definitions); $expected = ['value' => 'test']; $this->assertSame($expected, $table_mapping->getColumnNames('test')); - $definitions['test'] = $this->setUpDefinition(['value', 'format']); - $table_mapping = new DefaultTableMapping($definitions); + $definitions['test'] = $this->setUpDefinition('test', ['value', 'format']); + $table_mapping = new DefaultTableMapping($definitions, $definitions); $expected = ['value' => 'test__value', 'format' => 'test__format']; $this->assertSame($expected, $table_mapping->getColumnNames('test')); } @@ -213,7 +213,7 @@ public function testGetColumnNames() { public function testGetExtraColumns() { // The storage definitions are only used in getColumnNames() so we do not // need to provide any here. - $table_mapping = new DefaultTableMapping([]); + $table_mapping = new DefaultTableMapping([], []); // Test that requesting the list of field names for a table for which no // fields have been added does not fail. @@ -237,13 +237,18 @@ public function testGetExtraColumns() { /** * Sets up a field storage definition for the test. * + * @param string $name + * The field name. * @param array $column_names * An array of column names for the storage definition. * * @return \Drupal\Core\Field\FieldStorageDefinitionInterface|\PHPUnit_Framework_MockObject_MockObject */ - protected function setUpDefinition(array $column_names) { - $definition = $this->getMock('Drupal\Core\Field\FieldStorageDefinitionInterface'); + protected function setUpDefinition($name, array $column_names) { + $definition = $this->getMock('Drupal\Tests\Core\Field\TestBaseFieldDefinitionInterface'); + $definition->expects($this->any()) + ->method('getName') + ->will($this->returnValue($name)); $definition->expects($this->any()) ->method('getColumns') ->will($this->returnValue(array_fill_keys($column_names, [])));