SqlContentEntityStorage.php 63.8 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 471
   * @param array $records
   *   Associative array of query results, keyed on the entity ID.
472 473
   * @param bool $load_from_revision
   *   Flag to indicate whether revisions should be loaded or not.
474 475 476 477
   *
   * @return array
   *   An array of entity objects implementing the EntityInterface.
   */
478
  protected function mapFromStorageRecords(array $records, $load_from_revision = FALSE) {
479
    if (!$records) {
480
      return [];
481 482
    }

483
    $values = [];
484
    foreach ($records as $id => $record) {
485
      $values[$id] = [];
486 487 488
      // 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.
489
      foreach ($record as $name => $value) {
490 491 492 493
        // 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);
494
          $values[$id][$field_name][LanguageInterface::LANGCODE_DEFAULT][$property_name] = $value;
495 496 497 498
        }
        else {
          // Handle columns named directly after the field (e.g if the field
          // type only stores one property).
499
          $values[$id][$name][LanguageInterface::LANGCODE_DEFAULT] = $value;
500
        }
501 502
      }
    }
503

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

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

511
    $entities = [];
512 513 514 515 516
    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]));
    }
517

518 519 520 521
    return $entities;
  }

  /**
522
   * Loads values for fields stored in the shared data tables.
523
   *
524 525 526 527
   * @param array &$values
   *   Associative array of entities values, keyed on the entity ID.
   * @param array &$translations
   *   List of translations, keyed on the entity ID.
528
   */
529
  protected function loadFromSharedTables(array &$values, array &$translations) {
530 531 532 533
    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;
534
      $alias = $this->revisionDataTable ? 'revision' : 'data';
535
      $query = $this->database->select($table, $alias, ['fetch' => \PDO::FETCH_ASSOC])
536
        ->fields($alias)
537
        ->condition($alias . '.' . $this->idKey, array_keys($values), 'IN')
538
        ->orderBy($alias . '.' . $this->idKey);
539

540
      $table_mapping = $this->getTableMapping();
541
      if ($this->revisionDataTable) {
542 543
        // Find revisioned fields that are not entity keys. Exclude the langcode
        // key as the base table holds only the default language.
544
        $base_fields = array_diff($table_mapping->getFieldNames($this->baseTable), [$this->langcodeKey]);
545
        $revisioned_fields = array_diff($table_mapping->getFieldNames($this->revisionDataTable), $base_fields);
546 547 548

        // Find fields that are not revisioned or entity keys. Data fields have
        // the same value regardless of entity revision.
549 550 551 552 553
        $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;
554
        if ($data_fields) {
555
          $all_fields = array_merge($revisioned_fields, $data_fields);
556
          $query->leftJoin($this->dataTable, 'data', "(revision.$this->idKey = data.$this->idKey and revision.$this->langcodeKey = data.$this->langcodeKey)");
557 558 559 560 561 562 563 564 565 566 567
          $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);
568 569
        }

570
        // Get the revision IDs.
571
        $revision_ids = [];
572 573
        foreach ($values as $entity_values) {
          $revision_ids[] = $entity_values[$this->revisionKey][LanguageInterface::LANGCODE_DEFAULT];
574
        }
575
        $query->condition('revision.' . $this->revisionKey, $revision_ids, 'IN');
576 577
      }
      else {
578
        $all_fields = $table_mapping->getFieldNames($this->dataTable);
579 580
      }

581 582 583
      $result = $query->execute();
      foreach ($result as $row) {
        $id = $row[$this->idKey];
584 585

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

589 590
        $translations[$id][$langcode] = TRUE;

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

  /**
608
   * {@inheritdoc}
609
   */
610 611 612
  protected function doLoadRevisionFieldItems($revision_id) {
    $revision = NULL;

613
    // Build and execute the query.
614
    $query_result = $this->buildQuery([], $revision_id)->execute();
615
    $records = $query_result->fetchAllAssoc($this->idKey);
616

617 618
    if (!empty($records)) {
      // Convert the raw records to entity objects.
619
      $entities = $this->mapFromStorageRecords($records, TRUE);
620
      $revision = reset($entities) ?: NULL;
621
    }
622 623

    return $revision;
624 625 626
  }

  /**
627
   * {@inheritdoc}
628
   */
629 630 631 632
  protected function doDeleteRevisionFieldItems(ContentEntityInterface $revision) {
    $this->database->delete($this->revisionTable)
      ->condition($this->revisionKey, $revision->getRevisionId())
      ->execute();
633 634 635 636 637 638 639

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

640
    $this->deleteRevisionFromDedicatedTables($revision);
641 642 643
  }

  /**
644
   * {@inheritdoc}
645 646 647 648
   */
  protected function buildPropertyQuery(QueryInterface $entity_query, array $values) {
    if ($this->dataTable) {
      // @todo We should not be using a condition to specify whether conditions
649 650
      //   apply to the default language. See
      //   https://www.drupal.org/node/1866330.
651 652
      // Default to the original entity language if not explicitly specified
      // otherwise.
653 654
      if (!array_key_exists($this->defaultLangcodeKey, $values)) {
        $values[$this->defaultLangcodeKey] = 1;
655 656 657
      }
      // 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.
658 659
      elseif ($values[$this->defaultLangcodeKey] === NULL) {
        unset($values[$this->defaultLangcodeKey]);
660 661 662
      }
    }

663
    parent::buildPropertyQuery($entity_query, $values);
664 665 666 667 668 669 670 671 672 673 674
  }

  /**
   * 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.
675
   * See Drupal\comment\CommentStorage::buildQuery() for an example.
676 677 678 679 680 681 682
   *
   * @param array|null $ids
   *   An array of entity IDs, or NULL to load all entities.
   * @param $revision_id
   *   The ID of the revision to load, or FALSE if this query is asking for the
   *   most current revision(s).
   *
683
   * @return \Drupal\Core\Database\Query\Select
684 685 686
   *   A SelectQuery object for loading the entity.
   */
  protected function buildQuery($ids, $revision_id = FALSE) {
687
    $query = $this->database->select($this->entityType->getBaseTable(), 'base');
688

689
    $query->addTag($this->entityTypeId . '_load_multiple');
690 691

    if ($revision_id) {
692
      $query->join($this->revisionTable, 'revision', "revision.{$this->idKey} = base.{$this->idKey} AND revision.{$this->revisionKey} = :revisionId", [':revisionId' => $revision_id]);
693 694 695 696 697 698
    }
    elseif ($this->revisionTable) {
      $query->join($this->revisionTable, 'revision', "revision.{$this->revisionKey} = base.{$this->revisionKey}");
    }

    // Add fields from the {entity} table.
699 700
    $table_mapping = $this->getTableMapping();
    $entity_fields = $table_mapping->getAllColumns($this->baseTable);
701 702 703

    if ($this->revisionTable) {
      // Add all fields from the {entity_revision} table.
704
      $entity_revision_fields = $table_mapping->getAllColumns($this->revisionTable);
705
      $entity_revision_fields = array_combine($entity_revision_fields, $entity_revision_fields);
706 707 708 709 710 711 712 713 714 715 716 717 718 719 720
      // 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.
721
      $query->addExpression('CASE base.' . $this->revisionKey . ' WHEN revision.' . $this->revisionKey . ' THEN 1 ELSE 0 END', 'isDefaultRevision');
722 723 724 725 726 727 728 729 730 731 732 733
    }

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

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

    return $query;
  }

  /**
734
   * {@inheritdoc}
735 736 737 738 739 740 741 742 743
   */
  public function delete(array $entities) {
    if (!$entities) {
      // If no IDs or invalid IDs were passed, do nothing.
      return;
    }

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

746 747
      // Ignore replica server temporarily.
      db_ignore_replica();
748 749
    }
    catch (\Exception $e) {
750
      $transaction->rollBack();
751
      watchdog_exception($this->entityTypeId, $e);
752 753 754 755 756 757 758
      throw new EntityStorageException($e->getMessage(), $e->getCode(), $e);
    }
  }

  /**
   * {@inheritdoc}
   */
759
  protected function doDeleteFieldItems($entities) {
760
    $ids = array_keys($entities);
761

762
    $this->database->delete($this->entityType->getBaseTable())
763
      ->condition($this->idKey, $ids, 'IN')
764
      ->execute();
765

766 767
    if ($this->revisionTable) {
      $this->database->delete($this->revisionTable)
768
        ->condition($this->idKey, $ids, 'IN')
769 770
        ->execute();
    }
771

772 773
    if ($this->dataTable) {
      $this->database->delete($this->dataTable)
774
        ->condition($this->idKey, $ids, 'IN')
775 776
        ->execute();
    }
777

778 779
    if ($this->revisionDataTable) {
      $this->database->delete($this->revisionDataTable)
780
        ->condition($this->idKey, $ids, 'IN')
781 782
        ->execute();
    }
783

784
    foreach ($entities as $entity) {
785
      $this->deleteFromDedicatedTables($entity);
786 787 788 789 790 791 792 793 794 795
    }
  }

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

797 798
      // Ignore replica server temporarily.
      db_ignore_replica();
799 800 801
      return $return;
    }
    catch (\Exception $e) {
802
      $transaction->rollBack();
803
      watchdog_exception($this->entityTypeId, $e);
804 805 806 807
      throw new EntityStorageException($e->getMessage(), $e->getCode(), $e);
    }
  }

808 809 810
  /**
   * {@inheritdoc}
   */
811 812 813
  protected function doSaveFieldItems(ContentEntityInterface $entity, array $names = []) {
    $full_save = empty($names);
    $update = !$full_save || !$entity->isNew();
814

815 816 817
    if ($full_save) {
      $shared_table_fields = TRUE;
      $dedicated_table_fields = TRUE;
818 819
    }
    else {
820 821 822 823 824 825 826 827 828 829 830 831 832 833 834
      $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;
        }
835
      }
836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871
    }

    // 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);
        }
872
      }
873 874
      else {
        $insert_id = $this->database
875
          ->insert($this->baseTable, ['return' => Database::RETURN_INSERT_ID])
876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893
          ->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);
        }
894 895 896
      }
    }

897 898 899 900
    // Update dedicated table records if necessary.
    if ($dedicated_table_fields) {
      $names = is_array($dedicated_table_fields) ? $dedicated_table_fields : [];
      $this->saveToDedicatedTables($entity, $update, $names);
901
    }
902 903 904 905 906 907 908 909 910
  }

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

911
  /**
912
   * Saves fields that use the shared tables.
913
   *
914
   * @param \Drupal\Core\Entity\ContentEntityInterface $entity
915
   *   The entity object.
916 917
   * @param string $table_name
   *   (optional) The table name to save to. Defaults to the data table.
918 919 920
   * @param bool $new_revision
   *   (optional) Whether we are dealing with a new revision. By default fetches
   *   the information from the entity object.
921
   */
922
  protected function saveToSharedTables(ContentEntityInterface $entity, $table_name = NULL, $new_revision = NULL) {
923 924 925
    if (!isset($table_name)) {
      $table_name = $this->dataTable;
    }
926 927 928
    if (!isset($new_revision)) {
      $new_revision = $entity->isNewRevision();
    }
929
    $revision = $table_name != $this->dataTable;
930

931
    if (!$revision || !$new_revision) {
932 933 934 935 936 937 938 939 940 941 942 943
      $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);
944
      $record = $this->mapToDataStorageRecord($translation, $table_name);
945 946 947 948 949 950 951 952 953 954 955 956
      $values = (array) $record;
      $query
        ->fields(array_keys($values))
        ->values($values);
    }

    $query->execute();
  }

  /**
   * Maps from an entity object to the storage record.
   *
957
   * @param \Drupal\Core\Entity\ContentEntityInterface $entity
958
   *   The entity object.
959 960
   * @param string $table_name
   *   (optional) The table name to map records to. Defaults to the base table.
961 962 963 964
   *
   * @return \stdClass
   *   The record to store.
   */
965 966 967 968 969
  protected function mapToStorageRecord(ContentEntityInterface $entity, $table_name = NULL) {
    if (!isset($table_name)) {
      $table_name = $this->baseTable;
    }

970
    $record = new \stdClass();
971 972
    $table_mapping = $this->getTableMapping();
    foreach ($table_mapping->getFieldNames($table_name) as $field_name) {
973

974
      if (empty($this->getFieldStorageDefinitions()[$field_name])) {
975
        throw new EntityStorageException("Table mapping contains invalid field $field_name.");
976
      }
977
      $definition = $this->getFieldStorageDefinitions()[$field_name];
978 979 980 981 982 983 984
      $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
985
        //   https://www.drupal.org/node/2232427.
986
        if (!$definition->getMainPropertyName() && count($columns) == 1) {
987
          $value = ($item = $entity->$field_name->first()) ? $item->getValue() : [];
988
        }
989 990
        else {
          $value = isset($entity->$field_name->$column_name) ? $entity->$field_name->$column_name : NULL;
991
        }
992 993
        if (!empty($definition->getSchema()['columns'][$column_name]['serialize'])) {
          $value = serialize($value);
994
        }
995 996 997 998 999

        // Do not set serial fields if we do not have a value. This supports all
        // SQL database drivers.
        // @see https://www.drupal.org/node/2279395
        $value = drupal_schema_get_field_value($definition->getSchema()['columns'][$column_name], $value);
1000
        if (!(empty($value) && $this->isColumnSerial($table_name, $schema_name))) {
1001 1002
          $record->$schema_name = $value;
        }
1003 1004 1005 1006 1007 1008
      }
    }

    return $record;
  }