SqlContentEntityStorage.php 65 KB
Newer Older
1 2 3 4
<?php

/**
 * @file
5
 * Contains \Drupal\Core\Entity\Sql\SqlContentEntityStorage.
6 7
 */

8
namespace Drupal\Core\Entity\Sql;
9

10
use Drupal\Component\Utility\String;
11
use Drupal\Core\Cache\Cache;
12
use Drupal\Core\Cache\CacheBackendInterface;
13
use Drupal\Core\Database\Connection;
14
use Drupal\Core\Database\Database;
15 16
use Drupal\Core\Entity\ContentEntityInterface;
use Drupal\Core\Entity\ContentEntityStorageBase;
17
use Drupal\Core\Entity\EntityBundleListenerInterface;
18 19 20 21
use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Entity\EntityManagerInterface;
use Drupal\Core\Entity\EntityStorageException;
use Drupal\Core\Entity\EntityTypeInterface;
22
use Drupal\Core\Entity\Query\QueryInterface;
23
use Drupal\Core\Entity\Schema\DynamicallyFieldableEntityStorageSchemaInterface;
24
use Drupal\Core\Field\FieldDefinitionInterface;
25
use Drupal\Core\Field\FieldStorageDefinitionInterface;
26
use Drupal\Core\Language\LanguageInterface;
27
use Drupal\field\FieldStorageConfigInterface;
28
use Drupal\Core\Language\LanguageManagerInterface;
29 30 31
use Symfony\Component\DependencyInjection\ContainerInterface;

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

  /**
   * The mapping of field columns to SQL tables.
   *
   * @var \Drupal\Core\Entity\Sql\TableMappingInterface
   */
  protected $tableMapping;
52 53 54 55 56 57 58 59 60 61

  /**
   * 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;

62 63 64 65 66 67 68
  /**
   * The entity langcode key.
   *
   * @var string|bool
   */
  protected $langcodeKey = FALSE;

69 70 71 72 73 74 75
  /**
   * The default language entity key.
   *
   * @var string
   */
  protected $defaultLangcodeKey = FALSE;

76 77 78 79 80 81 82
  /**
   * The base table of the entity.
   *
   * @var string
   */
  protected $baseTable;

83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111
  /**
   * 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;

  /**
112
   * The entity manager.
113
   *
114
   * @var \Drupal\Core\Entity\EntityManagerInterface
115
   */
116
  protected $entityManager;
117

118
  /**
119
   * The entity type's storage schema object.
120
   *
121
   * @var \Drupal\Core\Entity\Schema\EntityStorageSchemaInterface
122
   */
123
  protected $storageSchema;
124

125 126 127 128 129 130 131
  /**
   * Cache backend.
   *
   * @var \Drupal\Core\Cache\CacheBackendInterface
   */
  protected $cacheBackend;

132 133 134 135 136 137 138
  /**
   * The language manager.
   *
   * @var \Drupal\Core\Language\LanguageManagerInterface
   */
  protected $languageManager;

139 140 141
  /**
   * {@inheritdoc}
   */
142
  public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_type) {
143
    return new static(
144
      $entity_type,
145
      $container->get('database'),
146
      $container->get('entity.manager'),
147 148
      $container->get('cache.entity'),
      $container->get('language_manager')
149 150 151
    );
  }

152 153 154 155 156 157 158 159 160 161 162
  /**
   * 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);
  }

163
  /**
164
   * Constructs a SqlContentEntityStorage object.
165
   *
166 167
   * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
   *   The entity type definition.
168 169
   * @param \Drupal\Core\Database\Connection $database
   *   The database connection to be used.
170 171
   * @param \Drupal\Core\Entity\EntityManagerInterface $entity_manager
   *   The entity manager.
172 173
   * @param \Drupal\Core\Cache\CacheBackendInterface $cache_backend
   *   The cache backend to be used.
174 175
   * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
   *   The language manager.
176
   */
177
  public function __construct(EntityTypeInterface $entity_type, Connection $database, EntityManagerInterface $entity_manager, CacheBackendInterface $cache, LanguageManagerInterface $language_manager) {
178
    parent::__construct($entity_type);
179
    $this->database = $database;
180
    $this->entityManager = $entity_manager;
181
    $this->cacheBackend = $cache;
182
    $this->languageManager = $language_manager;
183 184 185 186 187 188 189 190 191 192 193 194 195 196
    $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;
197 198 199 200 201 202 203 204 205

    // @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';
      $this->revisionTable = $this->entityType->getRevisionTable() ?: $this->entityTypeId . '_revision';
    }
206
    $translatable = $this->entityType->isTranslatable();
207 208
    if ($translatable) {
      $this->dataTable = $this->entityType->getDataTable() ?: $this->entityTypeId . '_field_data';
209
      $this->langcodeKey = $this->entityType->getKey('langcode');
210
      $this->defaultLangcodeKey = $this->entityType->getKey('default_langcode');
211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255
    }
    if ($revisionable && $translatable) {
      $this->revisionDataTable = $this->entityType->getRevisionDataTable() ?: $this->entityTypeId . '_field_revision';
    }
  }

  /**
   * Returns the base table name.
   *
   * @return string
   *   The table name.
   */
  public function getBaseTable() {
    return $this->baseTable;
  }

  /**
   * Returns the revision table name.
   *
   * @return string|false
   *   The table name or FALSE if it is not available.
   */
  public function getRevisionTable() {
    return $this->revisionTable;
  }

  /**
   * Returns the data table name.
   *
   * @return string|false
   *   The table name or FALSE if it is not available.
   */
  public function getDataTable() {
    return $this->dataTable;
  }

  /**
   * Returns the revision data table name.
   *
   * @return string|false
   *   The table name or FALSE if it is not available.
   */
  public function getRevisionDataTable() {
    return $this->revisionDataTable;
  }
256

257
  /**
258
   * Returns the entity type's storage schema object.
259
   *
260
   * @return \Drupal\Core\Entity\Sql\SqlContentEntityStorageSchema
261
   *   The schema object.
262
   */
263 264 265 266
  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);
267
    }
268
    return $this->storageSchema;
269
  }
270

271
  /**
272 273 274 275 276 277 278
   * Updates the wrapped entity type definition.
   *
   * @param \Drupal\Core\Entity\EntityTypeInterface $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.
279
   */
280 281 282 283 284 285 286 287 288
  public function setEntityType(EntityTypeInterface $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())));
    }
  }
289

290 291 292 293 294 295 296 297 298 299 300 301 302 303
  /**
   * {@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) {
      $definitions = $storage_definitions ?: $this->entityManager->getFieldStorageDefinitions($this->entityTypeId);
304
      $table_mapping = new DefaultTableMapping($this->entityType, $definitions);
305 306 307

      $definitions = array_filter($definitions, function (FieldStorageDefinitionInterface $definition) use ($table_mapping) {
        return $table_mapping->allowsSharedTableStorage($definition);
308 309 310 311 312 313 314 315 316 317 318 319 320 321
      });

      $key_fields = array_values(array_filter(array($this->idKey, $this->revisionKey, $this->bundleKey, $this->uuidKey, $this->langcodeKey)));
      $all_fields = array_keys($definitions);
      $revisionable_fields = array_keys(array_filter($definitions, function (FieldStorageDefinitionInterface $definition) {
        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));

      // Nodes have all three of these fields, while custom blocks only have
      // log.
      // @todo Provide automatic definitions for revision metadata fields in
      //   https://drupal.org/node/2248983.
322 323 324 325 326
      $revision_metadata_fields = array_intersect(array(
        'revision_timestamp',
        'revision_uid',
        'revision_log',
      ), $all_fields);
327 328

      $revisionable = $this->entityType->isRevisionable();
329
      $translatable = $this->entityType->isTranslatable();
330 331
      if (!$revisionable && !$translatable) {
        // The base layout stores all the base field values in the base table.
332
        $table_mapping->setFieldNames($this->baseTable, $all_fields);
333 334 335 336 337 338
      }
      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.
339
        $table_mapping->setFieldNames($this->baseTable, array_diff($all_fields, $revision_metadata_fields));
340
        $revision_key_fields = array($this->idKey, $this->revisionKey);
341
        $table_mapping->setFieldNames($this->revisionTable, array_merge($revision_key_fields, $revisionable_fields));
342 343 344 345 346 347 348 349
      }
      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.
350
        $table_mapping
351
          ->setFieldNames($this->baseTable, $key_fields)
352
          ->setFieldNames($this->dataTable, array_values(array_diff($all_fields, array($this->uuidKey))));
353 354 355 356 357 358 359 360 361
      }
      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.
362
        $table_mapping->setFieldNames($this->baseTable, array_values($key_fields));
363 364 365 366 367

        // 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));
368
        $table_mapping->setFieldNames($this->dataTable, $data_fields);
369 370

        $revision_base_fields = array_merge(array($this->idKey, $this->revisionKey, $this->langcodeKey), $revision_metadata_fields);
371
        $table_mapping->setFieldNames($this->revisionTable, $revision_base_fields);
372 373

        $revision_data_key_fields = array($this->idKey, $this->revisionKey, $this->langcodeKey);
374
        $revision_data_fields = array_diff($revisionable_fields, $revision_metadata_fields, array($this->langcodeKey));
375
        $table_mapping->setFieldNames($this->revisionDataTable, array_merge($revision_data_key_fields, $revision_data_fields));
376
      }
377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401

      // 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);
        }
      }

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

404
    return $table_mapping;
405 406 407 408 409
  }

  /**
   * {@inheritdoc}
   */
410
  protected function doLoadMultiple(array $ids = NULL) {
411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434
    // 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.
    $entities_from_storage = $this->getFromStorage($ids);
    $this->setPersistentCache($entities_from_storage);

    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) {
    $entities = array();

435 436 437 438 439 440
    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);
    }

441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465
    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);

        // Call hook_entity_storage_load().
        foreach ($this->moduleHandler()->getImplementations('entity_storage_load') as $module) {
          $function = $module . '_entity_storage_load';
          $function($entities, $this->entityTypeId);
        }
        // Call hook_TYPE_storage_load().
        foreach ($this->moduleHandler()->getImplementations($this->entityTypeId . '_storage_load') as $module) {
          $function = $module . '_' . $this->entityTypeId . '_storage_load';
          $function($entities);
        }
      }
    }

    return $entities;
  }

466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489
  /**
   * Ensures integer entity IDs are valid.
   *
   * The identifier sanitization provided by this method has been introduced
   * as Drupal used to rely on the database to facilitate this, which worked
   * correctly with MySQL but led to errors with other DBMS such as PostgreSQL.
   *
   * @param array $ids
   *   The entity IDs to verify.
   * @return array
   *   The sanitized list of entity IDs.
   */
  protected function cleanIds(array $ids) {
    $definitions = $this->entityManager->getBaseFieldDefinitions($this->entityTypeId);
    $id_definition = $definitions[$this->entityType->getKey('id')];
    if ($id_definition->getType() == 'integer') {
      $ids = array_filter($ids, function ($id) {
        return is_numeric($id) && $id == (int) $id;
      });
      $ids = array_map('intval', $ids);
    }
    return $ids;
  }

490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535
  /**
   * Gets entities from the persistent cache backend.
   *
   * @param array|null &$ids
   *   If not empty, return entities that match these IDs. IDs that were found
   *   will be removed from the list.
   *
   * @return \Drupal\Core\Entity\ContentEntityInterface[]
   *   Array of entities from the persistent cache.
   */
  protected function getFromPersistentCache(array &$ids = NULL) {
    if (!$this->entityType->isPersistentlyCacheable() || empty($ids)) {
      return array();
    }
    $entities = array();
    // Build the list of cache entries to retrieve.
    $cid_map = array();
    foreach ($ids as $id) {
      $cid_map[$id] = $this->buildCacheId($id);
    }
    $cids = array_values($cid_map);
    if ($cache = $this->cacheBackend->getMultiple($cids)) {
      // Get the entities that were found in the cache.
      foreach ($ids as $index => $id) {
        $cid = $cid_map[$id];
        if (isset($cache[$cid])) {
          $entities[$id] = $cache[$cid]->data;
          unset($ids[$index]);
        }
      }
    }
    return $entities;
  }

  /**
   * Stores entities in the persistent cache backend.
   *
   * @param \Drupal\Core\Entity\ContentEntityInterface[] $entities
   *   Entities to store in the cache.
   */
  protected function setPersistentCache($entities) {
    if (!$this->entityType->isPersistentlyCacheable()) {
      return;
    }

    $cache_tags = array(
536 537
      $this->entityTypeId . '_values',
      'entity_field_info',
538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581
    );
    foreach ($entities as $id => $entity) {
      $this->cacheBackend->set($this->buildCacheId($id), $entity, CacheBackendInterface::CACHE_PERMANENT, $cache_tags);
    }
  }

  /**
   * Invokes hook_entity_load_uncached().
   *
   * @param \Drupal\Core\Entity\ContentEntityInterface[] $entities
   *   List of entities, keyed on the entity ID.
   */
  protected function invokeLoadUncachedHook(array &$entities) {
    if (!empty($entities)) {
      // Call hook_entity_load_uncached().
      foreach ($this->moduleHandler()->getImplementations('entity_load_uncached') as $module) {
        $function = $module . '_entity_load_uncached';
        $function($entities, $this->entityTypeId);
      }
      // Call hook_TYPE_load_uncached().
      foreach ($this->moduleHandler()->getImplementations($this->entityTypeId . '_load_uncached') as $module) {
        $function = $module . '_' . $this->entityTypeId . '_load_uncached';
        $function($entities);
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function resetCache(array $ids = NULL) {
    if ($ids) {
      $cids = array();
      foreach ($ids as $id) {
        unset($this->entities[$id]);
        $cids[] = $this->buildCacheId($id);
      }
      if ($this->entityType->isPersistentlyCacheable()) {
        $this->cacheBackend->deleteMultiple($cids);
      }
    }
    else {
      $this->entities = array();
      if ($this->entityType->isPersistentlyCacheable()) {
582
        Cache::invalidateTags(array($this->entityTypeId . '_values'));
583 584 585
      }
    }
  }
586

587 588 589 590 591 592 593 594 595 596 597
  /**
   * Returns the cache ID for the passed in entity ID.
   *
   * @param int $id
   *   Entity ID for which the cache ID should be built.
   *
   * @return string
   *   Cache ID that can be passed to the cache backend.
   */
  protected function buildCacheId($id) {
    return "values:{$this->entityTypeId}:$id";
598 599 600
  }

  /**
601
   * Maps from storage records to entity objects, and attaches fields.
602
   *
603 604 605 606 607 608
   * @param array $records
   *   Associative array of query results, keyed on the entity ID.
   *
   * @return array
   *   An array of entity objects implementing the EntityInterface.
   */
609
  protected function mapFromStorageRecords(array $records) {
610 611 612 613
    if (!$records) {
      return array();
    }

614 615 616
    $entities = array();
    foreach ($records as $id => $record) {
      $entities[$id] = array();
617 618 619
      // 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.
620
      foreach ($record as $name => $value) {
621 622 623 624
        // 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);
625
          $entities[$id][$field_name][LanguageInterface::LANGCODE_DEFAULT][$property_name] = $value;
626 627 628 629
        }
        else {
          // Handle columns named directly after the field (e.g if the field
          // type only stores one property).
630
          $entities[$id][$name][LanguageInterface::LANGCODE_DEFAULT] = $value;
631
        }
632
      }
633
      // If we have no multilingual values we can instantiate entity objects
634 635 636 637
      // right now, otherwise we need to collect all the field values first.
      if (!$this->dataTable) {
        $bundle = $this->bundleKey ? $record->{$this->bundleKey} : FALSE;
        // Turn the record into an entity class.
638
        $entities[$id] = new $this->entityClass($entities[$id], $this->entityTypeId, $bundle);
639 640
      }
    }
641
    $this->attachPropertyData($entities);
642 643

    // Attach field values.
644
    $this->loadFieldItems($entities);
645

646 647 648 649 650 651 652 653 654
    return $entities;
  }

  /**
   * Attaches property data in all languages for translatable properties.
   *
   * @param array &$entities
   *   Associative array of entities, keyed on the entity ID.
   */
655
  protected function attachPropertyData(array &$entities) {
656 657 658 659
    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;
660 661 662 663 664
      $alias = $this->revisionDataTable ? 'revision' : 'data';
      $query = $this->database->select($table, $alias, array('fetch' => \PDO::FETCH_ASSOC))
        ->fields($alias)
        ->condition($alias . '.' . $this->idKey, array_keys($entities), 'IN')
        ->orderBy($alias . '.' . $this->idKey);
665

666
      $table_mapping = $this->getTableMapping();
667
      if ($this->revisionDataTable) {
668 669 670 671
        // Find revisioned fields that are not entity keys. Exclude the langcode
        // key as the base table holds only the default language.
        $base_fields = array_diff($table_mapping->getFieldNames($this->baseTable), array($this->langcodeKey));
        $fields = array_diff($table_mapping->getFieldNames($this->revisionDataTable), $base_fields);
672 673 674

        // Find fields that are not revisioned or entity keys. Data fields have
        // the same value regardless of entity revision.
675
        $data_fields = array_diff($table_mapping->getFieldNames($this->dataTable), $fields, $base_fields);
676 677 678 679 680 681
        if ($data_fields) {
          $fields = array_merge($fields, $data_fields);
          $query->leftJoin($this->dataTable, 'data', "(revision.$this->idKey = data.$this->idKey)");
          $query->fields('data', $data_fields);
        }

682 683 684
        // Get the revision IDs.
        $revision_ids = array();
        foreach ($entities as $values) {
685
          $revision_ids[] = is_object($values) ? $values->getRevisionId() : $values[$this->revisionKey][LanguageInterface::LANGCODE_DEFAULT];
686
        }
687
        $query->condition('revision.' . $this->revisionKey, $revision_ids, 'IN');
688 689
      }
      else {
690
        $fields = $table_mapping->getFieldNames($this->dataTable);
691 692
      }

693 694
      $translations = array();
      $data = $query->execute();
695 696 697 698
      foreach ($data as $values) {
        $id = $values[$this->idKey];

        // Field values in default language are stored with
699
        // LanguageInterface::LANGCODE_DEFAULT as key.
700
        $langcode = empty($values[$this->defaultLangcodeKey]) ? $values[$this->langcodeKey] : LanguageInterface::LANGCODE_DEFAULT;
701 702
        $translations[$id][$langcode] = TRUE;

703
        foreach ($fields as $field_name) {
704 705 706 707
          $columns = $table_mapping->getColumnNames($field_name);
          // Do not key single-column fields by property name.
          if (count($columns) == 1) {
            $entities[$id][$field_name][$langcode] = $values[reset($columns)];
708 709
          }
          else {
710 711
            foreach ($columns as $property_name => $column_name) {
              $entities[$id][$field_name][$langcode][$property_name] = $values[$column_name];
712
            }
713 714 715 716 717
          }
        }
      }

      foreach ($entities as $id => $values) {
718
        $bundle = $this->bundleKey ? $values[$this->bundleKey][LanguageInterface::LANGCODE_DEFAULT] : FALSE;
719
        // Turn the record into an entity class.
720
        $entities[$id] = new $this->entityClass($values, $this->entityTypeId, $bundle, array_keys($translations[$id]));
721 722 723 724 725
      }
    }
  }

  /**
726
   * {@inheritdoc}
727 728 729 730
   */
  public function loadRevision($revision_id) {
    // Build and execute the query.
    $query_result = $this->buildQuery(array(), $revision_id)->execute();
731
    $records = $query_result->fetchAllAssoc($this->idKey);
732

733 734 735 736
    if (!empty($records)) {
      // Convert the raw records to entity objects.
      $entities = $this->mapFromStorageRecords($records);
      $this->postLoad($entities);
737 738 739 740
      $entity = reset($entities);
      if ($entity) {
        return $entity;
      }
741 742 743 744
    }
  }

  /**
745
   * Implements \Drupal\Core\Entity\EntityStorageInterface::deleteRevision().
746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763
   */
  public function deleteRevision($revision_id) {
    if ($revision = $this->loadRevision($revision_id)) {
      // Prevent deletion if this is the default revision.
      if ($revision->isDefaultRevision()) {
        throw new EntityStorageException('Default revision can not be deleted');
      }

      $this->database->delete($this->revisionTable)
        ->condition($this->revisionKey, $revision->getRevisionId())
        ->execute();
      $this->invokeFieldMethod('deleteRevision', $revision);
      $this->deleteFieldItemsRevision($revision);
      $this->invokeHook('revision_delete', $revision);
    }
  }

  /**
764
   * {@inheritdoc}
765 766 767 768 769 770 771
   */
  protected function buildPropertyQuery(QueryInterface $entity_query, array $values) {
    if ($this->dataTable) {
      // @todo We should not be using a condition to specify whether conditions
      //   apply to the default language. See http://drupal.org/node/1866330.
      // Default to the original entity language if not explicitly specified
      // otherwise.
772 773
      if (!array_key_exists($this->defaultLangcodeKey, $values)) {
        $values[$this->defaultLangcodeKey] = 1;
774 775 776
      }
      // 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.
777 778
      elseif ($values[$this->defaultLangcodeKey] === NULL) {
        unset($values[$this->defaultLangcodeKey]);
779 780 781
      }
    }

782
    parent::buildPropertyQuery($entity_query, $values);
783 784 785 786 787 788 789 790 791 792 793
  }

  /**
   * 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.
794
   * See Drupal\comment\CommentStorage::buildQuery() for an example.
795 796 797 798 799 800 801
   *
   * @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).
   *
802
   * @return \Drupal\Core\Database\Query\Select
803 804 805
   *   A SelectQuery object for loading the entity.
   */
  protected function buildQuery($ids, $revision_id = FALSE) {
806
    $query = $this->database->select($this->entityType->getBaseTable(), 'base');
807

808
    $query->addTag($this->entityTypeId . '_load_multiple');
809 810 811 812 813 814 815 816 817

    if ($revision_id) {
      $query->join($this->revisionTable, 'revision', "revision.{$this->idKey} = base.{$this->idKey} AND revision.{$this->revisionKey} = :revisionId", array(':revisionId' => $revision_id));
    }
    elseif ($this->revisionTable) {
      $query->join($this->revisionTable, 'revision', "revision.{$this->revisionKey} = base.{$this->revisionKey}");
    }

    // Add fields from the {entity} table.
818 819
    $table_mapping = $this->getTableMapping();
    $entity_fields = $table_mapping->getAllColumns($this->baseTable);
820 821 822

    if ($this->revisionTable) {
      // Add all fields from the {entity_revision} table.
823
      $entity_revision_fields = $table_mapping->getAllColumns($this->revisionTable);
824
      $entity_revision_fields = array_combine($entity_revision_fields, $entity_revision_fields);
825 826 827 828 829 830 831 832 833 834 835 836 837 838 839
      // 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.
840
      $query->addExpression('CASE base.' . $this->revisionKey . ' WHEN revision.' . $this->revisionKey . ' THEN 1 ELSE 0 END', 'isDefaultRevision');
841 842 843 844 845 846 847 848 849 850 851 852
    }

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

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

    return $query;
  }

  /**
853
   * Implements \Drupal\Core\Entity\EntityStorageInterface::delete().
854 855 856 857 858 859 860 861 862
   */
  public function delete(array $entities) {
    if (!$entities) {
      // If no IDs or invalid IDs were passed, do nothing.
      return;
    }

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

865 866
      // Ignore replica server temporarily.
      db_ignore_replica();
867 868 869
    }
    catch (\Exception $e) {
      $transaction->rollback();
870
      watchdog_exception($this->entityTypeId, $e);
871 872 873 874 875 876 877
      throw new EntityStorageException($e->getMessage(), $e->getCode(), $e);
    }
  }

  /**
   * {@inheritdoc}
   */
878 879
  protected function doDelete($entities) {
    $ids = array_keys($entities);
880

881
    $this->database->delete($this->entityType->getBaseTable())
882
      ->condition($this->idKey, $ids, 'IN')
883
      ->execute();
884

885 886
    if ($this->revisionTable) {
      $this->database->delete($this->revisionTable)
887
        ->condition($this->idKey, $ids, 'IN')
888 889
        ->execute();
    }
890

891 892
    if ($this->dataTable) {
      $this->database->delete($this->dataTable)
893
        ->condition($this->idKey, $ids, 'IN')
894 895
        ->execute();
    }
896

897 898
    if ($this->revisionDataTable) {
      $this->database->delete($this->revisionDataTable)
899
        ->condition($this->idKey, $ids, 'IN')
900 901
        ->execute();
    }
902

903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918
    foreach ($entities as $entity) {
      $this->invokeFieldMethod('delete', $entity);
      $this->deleteFieldItems($entity);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function save(EntityInterface $entity) {
    $transaction = $this->database->startTransaction();
    try {
      // Sync the changes made in the fields array to the internal values array.
      $entity->updateOriginalValues();

      $return = parent::save($entity);
919

920 921
      // Ignore replica server temporarily.
      db_ignore_replica();
922 923 924 925
      return $return;
    }
    catch (\Exception $e) {
      $transaction->rollback();
926
      watchdog_exception($this->entityTypeId, $e);
927 928 929 930
      throw new EntityStorageException($e->getMessage(), $e->getCode(), $e);
    }
  }

931 932 933 934 935 936 937 938 939 940
  /**
   * {@inheritdoc}
   */
  protected function doSave($id, EntityInterface $entity) {
    // Create the storage record to be saved.
    $record = $this->mapToStorageRecord($entity);

    $is_new = $entity->isNew();
    if (!$is_new) {
      if ($entity->isDefaultRevision()) {
941 942 943 944 945 946
        $this->database
          ->update($this->baseTable)
          ->fields((array) $record)
          ->condition($this->idKey, $record->{$this->idKey})
          ->execute();
        $return = SAVED_UPDATED;
947 948 949 950 951 952 953
      }
      else {
        // @todo, should a different value be returned when saving an entity
        // with $isDefaultRevision = FALSE?
        $return = FALSE;
      }
      if ($this->revisionTable) {
954
        $entity->{$this->revisionKey}->value = $this->saveRevision($entity);
955 956 957 958 959
      }
      if ($this->dataTable) {
        $this->savePropertyData($entity);
      }
      if ($this->revisionDataTable) {
960
        $this->savePropertyData($entity, $this->revisionDataTable);
961 962 963 964 965 966 967 968 969
      }
      if ($this->revisionTable) {
        $entity->setNewRevision(FALSE);
      }
    }
    else {
      // Ensure the entity is still seen as new after assigning it an id,
      // while storing its data.
      $entity->enforceIsNew();
970 971 972 973 974
      $insert_id = $this->database
        ->insert($this->baseTable, array('return' => Database::RETURN_INSERT_ID))
        ->fields((array) $record)
        ->execute();
      // Even if this is a new entity the ID key might have been set, in which
975 976 977
      // 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})) {
978 979 980
        $record->{$this->idKey} = $insert_id;
      }
      $return = SAVED_NEW;
981 982 983 984 985 986 987 988 989
      $entity->{$this->idKey}->value = (string) $record->{$this->idKey};
      if ($this->revisionTable) {
        $entity->setNewRevision();
        $record->{$this->revisionKey} = $this->saveRevision($entity);
      }
      if ($this->dataTable) {
        $this->savePropertyData($entity);
      }
      if ($this->revisionDataTable) {
990
        $this->savePropertyData($entity, $this->revisionDataTable);
991
      }
992

993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013
      $entity->enforceIsNew(FALSE);
      if ($this->revisionTable) {
        $entity->setNewRevision(FALSE);
      }
    }
    $this->invokeFieldMethod($is_new ? 'insert' : 'update', $entity);
    $this->saveFieldItems($entity, !$is_new);

    if (!$is_new && $this->dataTable) {
      $this->invokeTranslationHooks($entity);
    }
    return $return;
  }

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

1014 1015 1016 1017 1018
  /**
   * Stores the entity property language-aware data.
   *
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   The entity object.
1019 1020
   * @param string $table_name
   *   (optional) The table name to save to. Defaults to the data table.
1021
   */
1022 1023 1024 1025 1026
  protected function savePropertyData(EntityInterface $entity, $table_name = NULL) {
    if (!isset($table_name)) {
      $table_name = $this->dataTable;
    }
    $revision = $table_name != $this->dataTable;
1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040

    if (!$revision || !$entity->isNewRevision()) {
      $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);
1041
      $record = $this->mapToDataStorageRecord($translation, $table_name);
1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053
      $values = (array) $record;
      $query
        ->fields(array_keys($values))
        ->values($values);
    }

    $query->execute();
  }

  /**
   * Maps from an entity object to the storage record.
   *
1054
   * @param \Drupal\Core\Entity\ContentEntityInterface $entity
1055
   *   The entity object.
1056 1057
   * @param string $table_name
   *   (optional) The table name to map records to. Defaults to the base table.
1058 1059 1060 1061
   *
   * @return \stdClass
   *   The record to store.
   */
1062 1063 1064 1065 1066
  protected function mapToStorageRecord(ContentEntityInterface $entity, $table_name = NULL) {
    if (!isset($table_name)) {
      $table_name = $this->baseTable;
    }

1067
    $record = new \stdClass();
1068 1069
    $table_mapping = $this->getTableMapping();
    foreach ($table_mapping->getFieldNames($table_name) as $field_name) {
1070

1071
      if (empty($this->getFieldStorageDefinitions()[$field_name])) {
1072
        throw new EntityStorageException(String::format('Table mapping contains invalid field %field.', array('%field' => $field_name)));
1073
      }
1074
      $definition = $this->getFieldStorageDefinitions()[$field_name];
1075 1076 1077 1078 1079 1080 1081 1082 1083
      $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
        //   https://drupal.org/node/2232427.
        if (!$definition->getMainPropertyName() && count($columns) == 1) {
1084
          $value = ($item = $entity->$field_name->first()) ? $item->getValue() : array();
1085
        }
1086 1087
        else {
          $value = isset($entity->$field_name->$column_name) ? $entity->$field_name->$column_name : NULL;
1088
        }
1089 1090
        if (!empty($definition->getSchema()['columns'][$column_name]['serialize'])) {
          $value = serialize($value);
1091
        }
1092 1093 1094 1095 1096

        // 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);
1097
        if (!(empty($value) && $this->isColumnSerial($table_name, $schema_name))) {
1098 1099
          $record->$schema_name = $value;
        }
1100 1101 1102 1103 1104 1105
      }
    }

    return $record;
  }

1106 1107 1108 1109 1110 1111 1112 1113 1114
  /**
   * Checks whether a field column should be treated as serial.
   *
   * @param $table_name
   *   The name of the table the field column belongs to.
   * @param $schema_name
   *   The schema name of the field column.
   *
   * @return bool
1115
   *   TRUE if the column is serial, FALSE otherwise.
1116
   *
1117 1118
   * @see \Drupal\Core\Entity\Sql\SqlContentEntityStorageSchema::processBaseTable()
   * @see \Drupal\Core\Entity\Sql\SqlContentEntityStorageSchema::processRevisionTable()
1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135
   */
  protected function isColumnSerial($table_name, $schema_name) {
    $result = FALSE;

    switch ($table_name) {
      case $this->baseTable:
        $result = $schema_name == $this->idKey;
        break;

      case $this->revisionTable:
        $result = $schema_name == $this->revisionKey;
        break;
    }

    return $result;
  }

1136 1137 1138 1139 1140
  /**
   * Maps from an entity object to the storage record of the field data.
   *
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   The entity object.
1141 1142
   * @param string $table_name
   *   (optional) The table name to map records to. Defaults to the data table.
1143 1144 1145 1146
   *
   * @return \stdClass
   *   The record to store.
   */
1147 1148 1149 1150 1151
  protected function mapToDataStorageRecord(EntityInterface $entity, $table_name = NULL) {
    if (!isset($table_name)) {
      $table_name = $this->dataTable;
    }
    $record = $this->mapToStorageRecord($entity, $table_name);
1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164
    return $record;
  }

  /**
   * Saves an entity revision.
   *
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   The entity object.
   *
   * @return int
   *   The revision id.
   */
  protected function saveRevision(EntityInterface $entity) {
1165
    $record = $this->mapToStorageRecord($entity->getUntranslated(), $this->revisionTable);
1166 1167 1168 1169

    $entity->preSaveRevision($this, $record);

    if ($entity->isNewRevision()) {
1170 1171 1172 1173
      $insert_id = $this->database
        ->insert($this->revisionTable, array('return' => Database::RETURN_INSERT_ID))
        ->fields((array) $record)
        ->execute();
1174
      // Even if this is a new revision, the revision ID key might have been
1175 1176 1177 1178
      // set in which case we should not override the provided revision ID.
      if (!isset($record->{$this->revisionKey})) {
        $record->{$this->revisionKey} = $insert_id;
      }
1179
      if ($entity->isDefaultRevision()) {
1180
        $this->database->update($this->entityType->getBaseTable())
1181 1182 1183 1184 1185 1186
          ->fields(array($this->revisionKey => $record->{$this->revisionKey}))
          ->condition($this->idKey, $record->{$this->idKey})
          ->execute();
      }
    }
    else {
1187 1188 1189 1190 1191