SqlContentEntityStorage.php 65.3 KB
Newer Older
1 2
<?php

3
namespace Drupal\Core\Entity\Sql;
4

5
use Drupal\Core\Cache\CacheBackendInterface;
6
use Drupal\Core\Database\Connection;
7
use Drupal\Core\Database\Database;
8 9
use Drupal\Core\Database\DatabaseExceptionWrapper;
use Drupal\Core\Database\SchemaException;
10 11
use Drupal\Core\Entity\ContentEntityInterface;
use Drupal\Core\Entity\ContentEntityStorageBase;
12
use Drupal\Core\Entity\EntityBundleListenerInterface;
13 14 15 16
use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Entity\EntityManagerInterface;
use Drupal\Core\Entity\EntityStorageException;
use Drupal\Core\Entity\EntityTypeInterface;
17
use Drupal\Core\Entity\Query\QueryInterface;
18
use Drupal\Core\Entity\Schema\DynamicallyFieldableEntityStorageSchemaInterface;
19
use Drupal\Core\Field\FieldDefinitionInterface;
20
use Drupal\Core\Field\FieldStorageDefinitionInterface;
21
use Drupal\Core\Language\LanguageInterface;
22
use Drupal\Core\Language\LanguageManagerInterface;
23 24 25
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
26
 * A content entity database storage implementation.
27
 *
28
 * This class can be used as-is by most content entity types. Entity types
29
 * requiring special handling can extend the class.
30
 *
31
 * The class uses \Drupal\Core\Entity\Sql\SqlContentEntityStorageSchema
32
 * internally in order to automatically generate the database schema based on
33 34
 * the defined base fields. Entity types can override the schema handler to
 * customize the generated schema; e.g., to add additional indexes.
35 36
 *
 * @ingroup entity_api
37
 */
38
class SqlContentEntityStorage extends ContentEntityStorageBase implements SqlEntityStorageInterface, DynamicallyFieldableEntityStorageSchemaInterface, EntityBundleListenerInterface {
39 40 41 42 43 44 45

  /**
   * The mapping of field columns to SQL tables.
   *
   * @var \Drupal\Core\Entity\Sql\TableMappingInterface
   */
  protected $tableMapping;
46 47 48 49 50 51 52 53 54 55

  /**
   * Name of entity's revision database table field, if it supports revisions.
   *
   * Has the value FALSE if this entity does not use revisions.
   *
   * @var string
   */
  protected $revisionKey = FALSE;

56 57 58 59 60 61 62
  /**
   * The entity langcode key.
   *
   * @var string|bool
   */
  protected $langcodeKey = FALSE;

63 64 65 66 67 68 69
  /**
   * The default language entity key.
   *
   * @var string
   */
  protected $defaultLangcodeKey = FALSE;

70 71 72 73 74 75 76
  /**
   * The base table of the entity.
   *
   * @var string
   */
  protected $baseTable;

77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104
  /**
   * The table that stores revisions, if the entity supports revisions.
   *
   * @var string
   */
  protected $revisionTable;

  /**
   * The table that stores properties, if the entity has multilingual support.
   *
   * @var string
   */
  protected $dataTable;

  /**
   * The table that stores revision field data if the entity supports revisions.
   *
   * @var string
   */
  protected $revisionDataTable;

  /**
   * Active database connection.
   *
   * @var \Drupal\Core\Database\Connection
   */
  protected $database;

105
  /**
106
   * The entity type's storage schema object.
107
   *
108
   * @var \Drupal\Core\Entity\Schema\EntityStorageSchemaInterface
109
   */
110
  protected $storageSchema;
111

112 113 114 115 116 117 118
  /**
   * The language manager.
   *
   * @var \Drupal\Core\Language\LanguageManagerInterface
   */
  protected $languageManager;

119 120 121 122 123 124 125
  /**
   * Whether this storage should use the temporary table mapping.
   *
   * @var bool
   */
  protected $temporary = FALSE;

126 127 128
  /**
   * {@inheritdoc}
   */
129
  public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_type) {
130
    return new static(
131
      $entity_type,
132
      $container->get('database'),
133
      $container->get('entity.manager'),
134 135
      $container->get('cache.entity'),
      $container->get('language_manager')
136 137 138
    );
  }

139 140 141 142 143 144 145 146 147 148 149
  /**
   * Gets the base field definitions for a content entity type.
   *
   * @return \Drupal\Core\Field\FieldDefinitionInterface[]
   *   The array of base field definitions for the entity type, keyed by field
   *   name.
   */
  public function getFieldStorageDefinitions() {
    return $this->entityManager->getBaseFieldDefinitions($this->entityTypeId);
  }

150
  /**
151
   * Constructs a SqlContentEntityStorage object.
152
   *
153 154
   * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
   *   The entity type definition.
155 156
   * @param \Drupal\Core\Database\Connection $database
   *   The database connection to be used.
157 158
   * @param \Drupal\Core\Entity\EntityManagerInterface $entity_manager
   *   The entity manager.
159
   * @param \Drupal\Core\Cache\CacheBackendInterface $cache
160
   *   The cache backend to be used.
161 162
   * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
   *   The language manager.
163
   */
164
  public function __construct(EntityTypeInterface $entity_type, Connection $database, EntityManagerInterface $entity_manager, CacheBackendInterface $cache, LanguageManagerInterface $language_manager) {
165
    parent::__construct($entity_type, $entity_manager, $cache);
166
    $this->database = $database;
167
    $this->languageManager = $language_manager;
168 169 170 171 172 173 174 175 176 177 178 179 180 181
    $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;
182 183

    // @todo Remove table names from the entity type definition in
184
    //   https://www.drupal.org/node/2232465.
185 186 187 188 189 190
    $this->baseTable = $this->entityType->getBaseTable() ?: $this->entityTypeId;
    $revisionable = $this->entityType->isRevisionable();
    if ($revisionable) {
      $this->revisionKey = $this->entityType->getKey('revision') ?: 'revision_id';
      $this->revisionTable = $this->entityType->getRevisionTable() ?: $this->entityTypeId . '_revision';
    }
191
    $translatable = $this->entityType->isTranslatable();
192 193
    if ($translatable) {
      $this->dataTable = $this->entityType->getDataTable() ?: $this->entityTypeId . '_field_data';
194
      $this->langcodeKey = $this->entityType->getKey('langcode');
195
      $this->defaultLangcodeKey = $this->entityType->getKey('default_langcode');
196 197 198 199 200 201 202
    }
    if ($revisionable && $translatable) {
      $this->revisionDataTable = $this->entityType->getRevisionDataTable() ?: $this->entityTypeId . '_field_revision';
    }
  }

  /**
203
   * Gets the base table name.
204 205 206 207 208 209 210 211 212
   *
   * @return string
   *   The table name.
   */
  public function getBaseTable() {
    return $this->baseTable;
  }

  /**
213
   * Gets the revision table name.
214 215 216 217 218 219 220 221 222
   *
   * @return string|false
   *   The table name or FALSE if it is not available.
   */
  public function getRevisionTable() {
    return $this->revisionTable;
  }

  /**
223
   * Gets the data table name.
224 225 226 227 228 229 230 231 232
   *
   * @return string|false
   *   The table name or FALSE if it is not available.
   */
  public function getDataTable() {
    return $this->dataTable;
  }

  /**
233
   * Gets the revision data table name.
234 235 236 237 238 239 240
   *
   * @return string|false
   *   The table name or FALSE if it is not available.
   */
  public function getRevisionDataTable() {
    return $this->revisionDataTable;
  }
241

242
  /**
243
   * Gets the entity type's storage schema object.
244
   *
245
   * @return \Drupal\Core\Entity\Sql\SqlContentEntityStorageSchema
246
   *   The schema object.
247
   */
248 249 250 251
  protected function getStorageSchema() {
    if (!isset($this->storageSchema)) {
      $class = $this->entityType->getHandlerClass('storage_schema') ?: 'Drupal\Core\Entity\Sql\SqlContentEntityStorageSchema';
      $this->storageSchema = new $class($this->entityManager, $this->entityType, $this, $this->database);
252
    }
253
    return $this->storageSchema;
254
  }
255

256
  /**
257 258 259 260 261
   * Updates the wrapped entity type definition.
   *
   * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
   *   The update entity type.
   *
262 263
   * @internal Only to be used internally by Entity API. Expected to be
   *   removed by https://www.drupal.org/node/2274017.
264
   */
265 266 267 268 269 270
  public function setEntityType(EntityTypeInterface $entity_type) {
    if ($this->entityType->id() == $entity_type->id()) {
      $this->entityType = $entity_type;
      $this->initTableLayout();
    }
    else {
271
      throw new EntityStorageException("Unsupported entity type {$entity_type->id()}");
272 273
    }
  }
274

275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299
  /**
   * Sets the wrapped table mapping definition.
   *
   * @param \Drupal\Core\Entity\Sql\TableMappingInterface $table_mapping
   *   The table mapping.
   *
   * @internal Only to be used internally by Entity API. Expected to be removed
   *   by https://www.drupal.org/node/2554235.
   */
  public function setTableMapping(TableMappingInterface $table_mapping) {
    $this->tableMapping = $table_mapping;
  }

  /**
   * Changes the temporary state of the storage.
   *
   * @param bool $temporary
   *   Whether to use a temporary table mapping or not.
   *
   * @internal Only to be used internally by Entity API.
   */
  public function setTemporary($temporary) {
    $this->temporary = $temporary;
  }

300 301 302 303 304 305 306 307 308 309 310 311 312
  /**
   * {@inheritdoc}
   */
  public function getTableMapping(array $storage_definitions = NULL) {
    $table_mapping = $this->tableMapping;

    // If we are using our internal storage definitions, which is our main use
    // case, we can statically cache the computed table mapping. If a new set
    // of field storage definitions is passed, for instance when comparing old
    // and new storage schema, we compute the table mapping without caching.
    // @todo Clean-up this in https://www.drupal.org/node/2274017 so we can
    //   easily instantiate a new table mapping whenever needed.
    if (!isset($this->tableMapping) || $storage_definitions) {
313
      $table_mapping_class = $this->temporary ? TemporaryTableMapping::class : DefaultTableMapping::class;
314
      $definitions = $storage_definitions ?: $this->entityManager->getFieldStorageDefinitions($this->entityTypeId);
315 316
      /** @var \Drupal\Core\Entity\Sql\DefaultTableMapping|\Drupal\Core\Entity\Sql\TemporaryTableMapping $table_mapping */
      $table_mapping = new $table_mapping_class($this->entityType, $definitions);
317

318
      $shared_table_definitions = array_filter($definitions, function (FieldStorageDefinitionInterface $definition) use ($table_mapping) {
319
        return $table_mapping->allowsSharedTableStorage($definition);
320 321
      });

322
      $key_fields = array_values(array_filter([$this->idKey, $this->revisionKey, $this->bundleKey, $this->uuidKey, $this->langcodeKey]));
323 324
      $all_fields = array_keys($shared_table_definitions);
      $revisionable_fields = array_keys(array_filter($shared_table_definitions, function (FieldStorageDefinitionInterface $definition) {
325 326 327 328 329
        return $definition->isRevisionable();
      }));
      // Make sure the key fields come first in the list of fields.
      $all_fields = array_merge($key_fields, array_diff($all_fields, $key_fields));

330 331
      // If the entity is revisionable, gather the fields that need to be put
      // in the revision table.
332
      $revisionable = $this->entityType->isRevisionable();
333 334
      $revision_metadata_fields = $revisionable ? array_values($this->entityType->getRevisionMetadataKeys()) : [];

335
      $translatable = $this->entityType->isTranslatable();
336 337
      if (!$revisionable && !$translatable) {
        // The base layout stores all the base field values in the base table.
338
        $table_mapping->setFieldNames($this->baseTable, $all_fields);
339 340 341 342 343 344
      }
      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.
345
        $table_mapping->setFieldNames($this->baseTable, array_diff($all_fields, $revision_metadata_fields));
346
        $revision_key_fields = [$this->idKey, $this->revisionKey];
347
        $table_mapping->setFieldNames($this->revisionTable, array_merge($revision_key_fields, $revisionable_fields));
348 349 350 351 352 353 354 355
      }
      elseif (!$revisionable && $translatable) {
        // Multilingual layouts store key field values in the base table. The
        // other base field values are stored in the data table, no matter
        // whether they are translatable or not. The data table holds also a
        // 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.
356
        $table_mapping
357
          ->setFieldNames($this->baseTable, $key_fields)
358
          ->setFieldNames($this->dataTable, array_values(array_diff($all_fields, [$this->uuidKey])));
359 360 361 362 363 364 365 366 367
      }
      elseif ($revisionable && $translatable) {
        // The revisionable multilingual layout stores key field values in the
        // base table, except for language, which is stored in the revision
        // table along with revision metadata. The revision data table holds
        // data field values for all the revisionable fields and the data table
        // 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.
368
        $table_mapping->setFieldNames($this->baseTable, array_values($key_fields));
369 370 371 372

        // 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.
373
        $data_fields = array_values(array_diff($all_fields, [$this->uuidKey], $revision_metadata_fields));
374
        $table_mapping->setFieldNames($this->dataTable, $data_fields);
375

376
        $revision_base_fields = array_merge([$this->idKey, $this->revisionKey, $this->langcodeKey], $revision_metadata_fields);
377
        $table_mapping->setFieldNames($this->revisionTable, $revision_base_fields);
378

379 380
        $revision_data_key_fields = [$this->idKey, $this->revisionKey, $this->langcodeKey];
        $revision_data_fields = array_diff($revisionable_fields, $revision_metadata_fields, [$this->langcodeKey]);
381
        $table_mapping->setFieldNames($this->revisionDataTable, array_merge($revision_data_key_fields, $revision_data_fields));
382
      }
383 384

      // Add dedicated tables.
385
      $dedicated_table_definitions = array_filter($definitions, function (FieldStorageDefinitionInterface $definition) use ($table_mapping) {
386 387
        return $table_mapping->requiresDedicatedTableStorage($definition);
      });
388
      $extra_columns = [
389 390 391 392 393 394
        'bundle',
        'deleted',
        'entity_id',
        'revision_id',
        'langcode',
        'delta',
395
      ];
396 397 398 399 400 401
      foreach ($dedicated_table_definitions as $field_name => $definition) {
        $tables = [$table_mapping->getDedicatedDataTableName($definition)];
        if ($revisionable && $definition->isRevisionable()) {
          $tables[] = $table_mapping->getDedicatedRevisionTableName($definition);
        }
        foreach ($tables as $table_name) {
402
          $table_mapping->setFieldNames($table_name, [$field_name]);
403 404 405 406 407 408 409 410 411
          $table_mapping->setExtraColumns($table_name, $extra_columns);
        }
      }

      // Cache the computed table mapping only if we are using our internal
      // storage definitions.
      if (!$storage_definitions) {
        $this->tableMapping = $table_mapping;
      }
412
    }
413

414
    return $table_mapping;
415 416 417 418 419
  }

  /**
   * {@inheritdoc}
   */
420
  protected function doLoadMultiple(array $ids = NULL) {
421 422 423 424 425
    // Attempt to load entities from the persistent cache. This will remove IDs
    // that were loaded from $ids.
    $entities_from_cache = $this->getFromPersistentCache($ids);

    // Load any remaining entities from the database.
426 427 428 429
    if ($entities_from_storage = $this->getFromStorage($ids)) {
      $this->invokeStorageLoadHook($entities_from_storage);
      $this->setPersistentCache($entities_from_storage);
    }
430 431 432 433 434 435 436 437 438 439 440 441 442 443 444

    return $entities_from_cache + $entities_from_storage;
  }

  /**
   * Gets entities from the storage.
   *
   * @param array|null $ids
   *   If not empty, return entities that match these IDs. Return all entities
   *   when NULL.
   *
   * @return \Drupal\Core\Entity\ContentEntityInterface[]
   *   Array of entities from the storage.
   */
  protected function getFromStorage(array $ids = NULL) {
445
    $entities = [];
446

447 448 449 450 451 452
    if (!empty($ids)) {
      // Sanitize IDs. Before feeding ID array into buildQuery, check whether
      // it is empty as this would load all entities.
      $ids = $this->cleanIds($ids);
    }

453 454 455 456 457 458 459 460 461 462 463 464 465 466
    if ($ids === NULL || $ids) {
      // Build and execute the query.
      $query_result = $this->buildQuery($ids)->execute();
      $records = $query_result->fetchAllAssoc($this->idKey);

      // Map the loaded records into entity objects and according fields.
      if ($records) {
        $entities = $this->mapFromStorageRecords($records);
      }
    }

    return $entities;
  }

467
  /**
468
   * Maps from storage records to entity objects, and attaches fields.
469
   *
470
   * @param array $records
471 472
   *   Associative array of query results, keyed on the entity ID or revision
   *   ID.
473
   * @param bool $load_from_revision
474 475
   *   (optional) Flag to indicate whether revisions should be loaded or not.
   *   Defaults to FALSE.
476 477 478 479
   *
   * @return array
   *   An array of entity objects implementing the EntityInterface.
   */
480
  protected function mapFromStorageRecords(array $records, $load_from_revision = FALSE) {
481
    if (!$records) {
482
      return [];
483 484
    }

485
    $values = [];
486
    foreach ($records as $id => $record) {
487
      $values[$id] = [];
488 489 490
      // Skip the item delta and item value levels (if possible) but let the
      // field assign the value as suiting. This avoids unnecessary array
      // hierarchies and saves memory here.
491
      foreach ($record as $name => $value) {
492 493 494 495
        // Handle columns named [field_name]__[column_name] (e.g for field types
        // that store several properties).
        if ($field_name = strstr($name, '__', TRUE)) {
          $property_name = substr($name, strpos($name, '__') + 2);
496
          $values[$id][$field_name][LanguageInterface::LANGCODE_DEFAULT][$property_name] = $value;
497 498 499 500
        }
        else {
          // Handle columns named directly after the field (e.g if the field
          // type only stores one property).
501
          $values[$id][$name][LanguageInterface::LANGCODE_DEFAULT] = $value;
502
        }
503 504
      }
    }
505

506
    // Initialize translations array.
507
    $translations = array_fill_keys(array_keys($values), []);
508 509

    // Load values from shared and dedicated tables.
510
    $this->loadFromSharedTables($values, $translations, $load_from_revision);
511 512
    $this->loadFromDedicatedTables($values, $load_from_revision);

513
    $entities = [];
514 515 516 517 518
    foreach ($values as $id => $entity_values) {
      $bundle = $this->bundleKey ? $entity_values[$this->bundleKey][LanguageInterface::LANGCODE_DEFAULT] : FALSE;
      // Turn the record into an entity class.
      $entities[$id] = new $this->entityClass($entity_values, $this->entityTypeId, $bundle, array_keys($translations[$id]));
    }
519

520 521 522 523
    return $entities;
  }

  /**
524
   * Loads values for fields stored in the shared data tables.
525
   *
526
   * @param array &$values
527 528
   *   Associative array of entities values, keyed on the entity ID or the
   *   revision ID.
529 530
   * @param array &$translations
   *   List of translations, keyed on the entity ID.
531 532
   * @param bool $load_from_revision
   *   Flag to indicate whether revisions should be loaded or not.
533
   */
534 535
  protected function loadFromSharedTables(array &$values, array &$translations, $load_from_revision) {
    $record_key = !$load_from_revision ? $this->idKey : $this->revisionKey;
536 537 538 539
    if ($this->dataTable) {
      // If a revision table is available, we need all the properties of the
      // latest revision. Otherwise we fall back to the data table.
      $table = $this->revisionDataTable ?: $this->dataTable;
540
      $alias = $this->revisionDataTable ? 'revision' : 'data';
541
      $query = $this->database->select($table, $alias, ['fetch' => \PDO::FETCH_ASSOC])
542
        ->fields($alias)
543 544
        ->condition($alias . '.' . $record_key, array_keys($values), 'IN')
        ->orderBy($alias . '.' . $record_key);
545

546
      $table_mapping = $this->getTableMapping();
547
      if ($this->revisionDataTable) {
548 549
        // Find revisioned fields that are not entity keys. Exclude the langcode
        // key as the base table holds only the default language.
550
        $base_fields = array_diff($table_mapping->getFieldNames($this->baseTable), [$this->langcodeKey]);
551
        $revisioned_fields = array_diff($table_mapping->getFieldNames($this->revisionDataTable), $base_fields);
552 553 554

        // Find fields that are not revisioned or entity keys. Data fields have
        // the same value regardless of entity revision.
555 556 557 558 559
        $data_fields = array_diff($table_mapping->getFieldNames($this->dataTable), $revisioned_fields, $base_fields);
        // If there are no data fields then only revisioned fields are needed
        // else both data fields and revisioned fields are needed to map the
        // entity values.
        $all_fields = $revisioned_fields;
560
        if ($data_fields) {
561
          $all_fields = array_merge($revisioned_fields, $data_fields);
562
          $query->leftJoin($this->dataTable, 'data', "(revision.$this->idKey = data.$this->idKey and revision.$this->langcodeKey = data.$this->langcodeKey)");
563 564 565 566 567 568 569 570 571 572 573
          $column_names = [];
          // Some fields can have more then one columns in the data table so
          // column names are needed.
          foreach ($data_fields as $data_field) {
            // \Drupal\Core\Entity\Sql\TableMappingInterface:: getColumNames()
            // returns an array keyed by property names so remove the keys
            // before array_merge() to avoid losing data with fields having the
            // same columns i.e. value.
            $column_names = array_merge($column_names, array_values($table_mapping->getColumnNames($data_field)));
          }
          $query->fields('data', $column_names);
574 575
        }

576
        // Get the revision IDs.
577
        $revision_ids = [];
578 579
        foreach ($values as $entity_values) {
          $revision_ids[] = $entity_values[$this->revisionKey][LanguageInterface::LANGCODE_DEFAULT];
580
        }
581
        $query->condition('revision.' . $this->revisionKey, $revision_ids, 'IN');
582 583
      }
      else {
584
        $all_fields = $table_mapping->getFieldNames($this->dataTable);
585 586
      }

587 588
      $result = $query->execute();
      foreach ($result as $row) {
589
        $id = $row[$record_key];
590 591

        // Field values in default language are stored with
592
        // LanguageInterface::LANGCODE_DEFAULT as key.
593 594
        $langcode = empty($row[$this->defaultLangcodeKey]) ? $row[$this->langcodeKey] : LanguageInterface::LANGCODE_DEFAULT;

595 596
        $translations[$id][$langcode] = TRUE;

597
        foreach ($all_fields as $field_name) {
598 599 600
          $columns = $table_mapping->getColumnNames($field_name);
          // Do not key single-column fields by property name.
          if (count($columns) == 1) {
601
            $values[$id][$field_name][$langcode] = $row[reset($columns)];
602 603
          }
          else {
604
            foreach ($columns as $property_name => $column_name) {
605
              $values[$id][$field_name][$langcode][$property_name] = $row[$column_name];
606
            }
607 608 609 610 611 612 613
          }
        }
      }
    }
  }

  /**
614
   * {@inheritdoc}
615
   */
616
  protected function doLoadRevisionFieldItems($revision_id) {
617
    @trigger_error('"\Drupal\Core\Entity\ContentEntityStorageBase::doLoadRevisionFieldItems()" is deprecated in Drupal 8.5.x and will be removed before Drupal 9.0.0. "\Drupal\Core\Entity\ContentEntityStorageBase::doLoadMultipleRevisionsFieldItems()" should be implemented instead. See https://www.drupal.org/node/2924915.', E_USER_DEPRECATED);
618

619 620 621 622 623 624 625 626 627 628
    $revisions = $this->doLoadMultipleRevisionsFieldItems([$revision_id]);

    return !empty($revisions) ? reset($revisions) : NULL;
  }

  /**
   * {@inheritdoc}
   */
  protected function doLoadMultipleRevisionsFieldItems($revision_ids) {
    $revisions = [];
629

630 631 632 633 634 635 636 637 638 639 640 641 642
    // Sanitize IDs. Before feeding ID array into buildQuery, check whether
    // it is empty as this would load all entity revisions.
    $revision_ids = $this->cleanIds($revision_ids, 'revision');

    if (!empty($revision_ids)) {
      // Build and execute the query.
      $query_result = $this->buildQuery(NULL, $revision_ids)->execute();
      $records = $query_result->fetchAllAssoc($this->revisionKey);

      // Map the loaded records into entity objects and according fields.
      if ($records) {
        $revisions = $this->mapFromStorageRecords($records, TRUE);
      }
643
    }
644

645
    return $revisions;
646 647 648
  }

  /**
649
   * {@inheritdoc}
650
   */
651 652 653 654
  protected function doDeleteRevisionFieldItems(ContentEntityInterface $revision) {
    $this->database->delete($this->revisionTable)
      ->condition($this->revisionKey, $revision->getRevisionId())
      ->execute();
655 656 657 658 659 660 661

    if ($this->revisionDataTable) {
      $this->database->delete($this->revisionDataTable)
        ->condition($this->revisionKey, $revision->getRevisionId())
        ->execute();
    }

662
    $this->deleteRevisionFromDedicatedTables($revision);
663 664 665
  }

  /**
666
   * {@inheritdoc}
667 668 669 670
   */
  protected function buildPropertyQuery(QueryInterface $entity_query, array $values) {
    if ($this->dataTable) {
      // @todo We should not be using a condition to specify whether conditions
671 672
      //   apply to the default language. See
      //   https://www.drupal.org/node/1866330.
673 674
      // Default to the original entity language if not explicitly specified
      // otherwise.
675 676
      if (!array_key_exists($this->defaultLangcodeKey, $values)) {
        $values[$this->defaultLangcodeKey] = 1;
677 678 679
      }
      // If the 'default_langcode' flag is explicitly not set, we do not care
      // whether the queried values are in the original entity language or not.
680 681
      elseif ($values[$this->defaultLangcodeKey] === NULL) {
        unset($values[$this->defaultLangcodeKey]);
682 683 684
      }
    }

685
    parent::buildPropertyQuery($entity_query, $values);
686 687 688 689 690 691 692 693 694 695 696
  }

  /**
   * Builds the query to load the entity.
   *
   * This has full revision support. For entities requiring special queries,
   * the class can be extended, and the default query can be constructed by
   * calling parent::buildQuery(). This is usually necessary when the object
   * being loaded needs to be augmented with additional data from another
   * table, such as loading node type into comments or vocabulary machine name
   * into terms, however it can also support $conditions on different tables.
697
   * See Drupal\comment\CommentStorage::buildQuery() for an example.
698 699 700
   *
   * @param array|null $ids
   *   An array of entity IDs, or NULL to load all entities.
701 702 703
   * @param array|bool $revision_ids
   *   The IDs of the revisions to load, or FALSE if this query is asking for
   *   the default revisions. Defaults to FALSE.
704
   *
705
   * @return \Drupal\Core\Database\Query\Select
706 707
   *   A SelectQuery object for loading the entity.
   */
708
  protected function buildQuery($ids, $revision_ids = FALSE) {
709
    $query = $this->database->select($this->entityType->getBaseTable(), 'base');
710

711
    $query->addTag($this->entityTypeId . '_load_multiple');
712

713 714 715 716 717
    if ($revision_ids) {
      if (!is_array($revision_ids)) {
        @trigger_error('Passing a single revision ID to "\Drupal\Core\Entity\Sql\SqlContentEntityStorage::buildQuery()" is deprecated in Drupal 8.5.x and will be removed before Drupal 9.0.0. An array of revision IDs should be given instead. See https://www.drupal.org/node/2924915.', E_USER_DEPRECATED);
      }
      $query->join($this->revisionTable, 'revision', "revision.{$this->idKey} = base.{$this->idKey} AND revision.{$this->revisionKey} IN (:revisionIds[])", [':revisionIds[]' => (array) $revision_ids]);
718 719 720 721 722 723
    }
    elseif ($this->revisionTable) {
      $query->join($this->revisionTable, 'revision', "revision.{$this->revisionKey} = base.{$this->revisionKey}");
    }

    // Add fields from the {entity} table.
724 725
    $table_mapping = $this->getTableMapping();
    $entity_fields = $table_mapping->getAllColumns($this->baseTable);
726 727 728

    if ($this->revisionTable) {
      // Add all fields from the {entity_revision} table.
729
      $entity_revision_fields = $table_mapping->getAllColumns($this->revisionTable);
730
      $entity_revision_fields = array_combine($entity_revision_fields, $entity_revision_fields);
731 732 733 734 735 736 737 738 739 740 741 742 743 744 745
      // The ID field is provided by entity, so remove it.
      unset($entity_revision_fields[$this->idKey]);

      // Remove all fields from the base table that are also fields by the same
      // name in the revision table.
      $entity_field_keys = array_flip($entity_fields);
      foreach ($entity_revision_fields as $name) {
        if (isset($entity_field_keys[$name])) {
          unset($entity_fields[$entity_field_keys[$name]]);
        }
      }
      $query->fields('revision', $entity_revision_fields);

      // Compare revision ID of the base and revision table, if equal then this
      // is the default revision.
746
      $query->addExpression('CASE base.' . $this->revisionKey . ' WHEN revision.' . $this->revisionKey . ' THEN 1 ELSE 0 END', 'isDefaultRevision');
747 748 749 750 751 752 753 754 755 756 757 758
    }

    $query->fields('base', $entity_fields);

    if ($ids) {
      $query->condition("base.{$this->idKey}", $ids, 'IN');
    }

    return $query;
  }

  /**
759
   * {@inheritdoc}
760 761 762 763 764 765 766 767 768
   */
  public function delete(array $entities) {
    if (!$entities) {
      // If no IDs or invalid IDs were passed, do nothing.
      return;
    }

    $transaction = $this->database->startTransaction();
    try {
769
      parent::delete($entities);
770

771 772
      // Ignore replica server temporarily.
      db_ignore_replica();
773 774
    }
    catch (\Exception $e) {
775
      $transaction->rollBack();
776
      watchdog_exception($this->entityTypeId, $e);
777 778 779 780 781 782 783
      throw new EntityStorageException($e->getMessage(), $e->getCode(), $e);
    }
  }

  /**
   * {@inheritdoc}
   */
784
  protected function doDeleteFieldItems($entities) {
785
    $ids = array_keys($entities);
786

787
    $this->database->delete($this->entityType->getBaseTable())
788
      ->condition($this->idKey, $ids, 'IN')
789
      ->execute();
790

791 792
    if ($this->revisionTable) {
      $this->database->delete($this->revisionTable)
793
        ->condition($this->idKey, $ids, 'IN')
794 795
        ->execute();
    }
796

797 798
    if ($this->dataTable) {
      $this->database->delete($this->dataTable)
799
        ->condition($this->idKey, $ids, 'IN')
800 801
        ->execute();
    }
802

803 804
    if ($this->revisionDataTable) {
      $this->database->delete($this->revisionDataTable)
805
        ->condition($this->idKey, $ids, 'IN')
806 807
        ->execute();
    }
808

809
    foreach ($entities as $entity) {
810
      $this->deleteFromDedicatedTables($entity);
811 812 813 814 815 816 817 818 819 820
    }
  }

  /**
   * {@inheritdoc}
   */
  public function save(EntityInterface $entity) {
    $transaction = $this->database->startTransaction();
    try {
      $return = parent::save($entity);
821

822 823
      // Ignore replica server temporarily.
      db_ignore_replica();
824 825 826
      return $return;
    }
    catch (\Exception $e) {
827
      $transaction->rollBack();
828
      watchdog_exception($this->entityTypeId, $e);
829 830 831 832
      throw new EntityStorageException($e->getMessage(), $e->getCode(), $e);
    }
  }

833 834 835
  /**
   * {@inheritdoc}
   */
836 837 838
  protected function doSaveFieldItems(ContentEntityInterface $entity, array $names = []) {
    $full_save = empty($names);
    $update = !$full_save || !$entity->isNew();
839

840 841 842
    if ($full_save) {
      $shared_table_fields = TRUE;
      $dedicated_table_fields = TRUE;
843 844
    }
    else {
845 846 847 848 849 850 851 852 853 854 855 856 857 858 859
      $table_mapping = $this->getTableMapping();
      $storage_definitions = $this->entityManager->getFieldStorageDefinitions($this->entityTypeId);
      $shared_table_fields = FALSE;
      $dedicated_table_fields = [];

      // Collect the name of fields to be written in dedicated tables and check
      // whether shared table records need to be updated.
      foreach ($names as $name) {
        $storage_definition = $storage_definitions[$name];
        if ($table_mapping->allowsSharedTableStorage($storage_definition)) {
          $shared_table_fields = TRUE;
        }
        elseif ($table_mapping->requiresDedicatedTableStorage($storage_definition)) {
          $dedicated_table_fields[] = $name;
        }
860
      }
861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896
    }

    // Update shared table records if necessary.
    if ($shared_table_fields) {
      $record = $this->mapToStorageRecord($entity->getUntranslated(), $this->baseTable);
      // Create the storage record to be saved.
      if ($update) {
        $default_revision = $entity->isDefaultRevision();
        if ($default_revision) {
          $this->database
            ->update($this->baseTable)
            ->fields((array) $record)
            ->condition($this->idKey, $record->{$this->idKey})
            ->execute();
        }
        if ($this->revisionTable) {
          if ($full_save) {
            $entity->{$this->revisionKey} = $this->saveRevision($entity);
          }
          else {
            $record = $this->mapToStorageRecord($entity->getUntranslated(), $this->revisionTable);
            $entity->preSaveRevision($this, $record);
            $this->database
              ->update($this->revisionTable)
              ->fields((array) $record)
              ->condition($this->revisionKey, $record->{$this->revisionKey})
              ->execute();
          }
        }
        if ($default_revision && $this->dataTable) {
          $this->saveToSharedTables($entity);
        }
        if ($this->revisionDataTable) {
          $new_revision = $full_save && $entity->isNewRevision();
          $this->saveToSharedTables($entity, $this->revisionDataTable, $new_revision);
        }
897
      }
898 899
      else {
        $insert_id = $this->database
900
          ->insert($this->baseTable, ['return' => Database::RETURN_INSERT_ID])
901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918
          ->fields((array) $record)
          ->execute();
        // Even if this is a new entity the ID key might have been set, in which
        // case we should not override the provided ID. An ID key that is not set
        // to any value is interpreted as NULL (or DEFAULT) and thus overridden.
        if (!isset($record->{$this->idKey})) {
          $record->{$this->idKey} = $insert_id;
        }
        $entity->{$this->idKey} = (string) $record->{$this->idKey};
        if ($this->revisionTable) {
          $record->{$this->revisionKey} = $this->saveRevision($entity);
        }
        if ($this->dataTable) {
          $this->saveToSharedTables($entity);
        }
        if ($this->revisionDataTable) {
          $this->saveToSharedTables($entity, $this->revisionDataTable);
        }
919 920 921
      }
    }

922 923 924 925
    // Update dedicated table records if necessary.
    if ($dedicated_table_fields) {
      $names = is_array($dedicated_table_fields) ? $dedicated_table_fields : [];
      $this->saveToDedicatedTables($entity, $update, $names);
926
    }
927 928 929 930 931 932 933 934 935
  }

  /**
   * {@inheritdoc}
   */
  protected function has($id, EntityInterface $entity) {
    return !$entity->isNew();
  }

936
  /**
937
   * Saves fields that use the shared tables.
938
   *
939
   * @param \Drupal\Core\Entity\ContentEntityInterface $entity
940
   *   The entity object.
941 942
   * @param string $table_name
   *   (optional) The table name to save to. Defaults to the data table.
943 944 945
   * @param bool $new_revision
   *   (optional) Whether we are dealing with a new revision. By default fetches
   *   the information from the entity object.
946
   */
947
  protected function saveToSharedTables(ContentEntityInterface $entity, $table_name = NULL, $new_revision = NULL) {
948 949 950
    if (!isset($table_name)) {
      $table_name = $this->dataTable;
    }
951 952 953
    if (!isset($new_revision)) {
      $new_revision = $entity->isNewRevision();
    }
954
    $revision = $table_name != $this->dataTable;
955

956
    if (!$revision || !$new_revision) {
957 958 959 960 961 962 963 964 965 966 967 968
      $key = $revision ? $this->revisionKey : $this->idKey;
      $value = $revision ? $entity->getRevisionId() : $entity->id();
      // Delete and insert to handle removed values.
      $this->database->delete($table_name)
        ->condition($key, $value)
        ->execute();
    }

    $query = $this->database->insert($table_name);

    foreach ($entity->getTranslationLanguages() as $langcode => $language) {
      $translation = $entity->getTranslation($langcode);
969
      $record = $this->mapToDataStorageRecord($translation, $table_name);
970 971 972 973 974 975 976 977 978 979 980 981
      $values = (array) $record;
      $query
        ->fields(array_keys($values))
        ->values($values);
    }

    $query->execute();
  }

  /**
   * Maps from an entity object to the storage record.
   *
982
   * @param \Drupal\Core\Entity\ContentEntityInterface $entity
983
   *   The entity object.
984 985
   * @param string $table_name
   *   (optional) The table name to map records to. Defaults to the base table.
986 987 988 989
   *
   * @return \stdClass
   *   The record to store.
   */
990 991 992 993 994
  protected function mapToStorageRecord(ContentEntityInterface $entity, $table_name = NULL) {
    if (!isset($table_name)) {
      $table_name = $this->baseTable;
    }

995
    $record = new \stdClass();
996 997
    $table_mapping = $this->getTableMapping();
    foreach ($table_mapping->getFieldNames($table_name) as $field_name) {
998

999
      if (empty($this->getFieldStorageDefinitions()[$field_name])) {
1000
        throw new EntityStorageException("Table mapping contains invalid field $field_name.");
1001
      }
1002
      $definition = $this->getFieldStorageDefinitions()[$field_name];
1003 1004 1005 1006 1007 1008 1009
      $columns = $table_mapping->getColumnNames($field_name);

      foreach ($columns as $column_name => $schema_name) {
        // If there is no main property and only a single column, get all
        // properties from the first field item and assume that they will be
        // stored serialized.
        // @todo Give field types more control over this behavior in
1010
        //   https://www.drupal.org/node/2232427.
1011
        if (!$definition->getMainPropertyName() && count($columns) == 1) {
1012