DatabaseStorageControllerNG.php 22 KB
Newer Older
1 2 3 4
<?php

/**
 * @file
5
 * Contains \Drupal\Core\Entity\DatabaseStorageControllerNG.
6 7 8 9
 */

namespace Drupal\Core\Entity;

10
use Drupal\Core\Language\Language;
11 12
use PDO;

13
use Drupal\Core\Entity\Query\QueryInterface;
14 15 16
use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Entity\DatabaseStorageController;
use Drupal\Core\Entity\EntityStorageException;
17
use Drupal\Core\TypedData\ComplexDataInterface;
18
use Drupal\Component\Uuid\Uuid;
19
use Drupal\Core\Database\Connection;
20 21 22 23 24 25

/**
 * Implements Field API specific enhancements to the DatabaseStorageController class.
 *
 * @todo: Once all entity types have been converted, merge improvements into the
 * DatabaseStorageController class.
26 27 28 29
 *
 * See the EntityNG documentation for an explanation of "NG".
 *
 * @see \Drupal\Core\EntityNG
30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46
 */
class DatabaseStorageControllerNG extends DatabaseStorageController {

  /**
   * The entity class to use.
   *
   * @var string
   */
  protected $entityClass;

  /**
   * The entity bundle key.
   *
   * @var string|bool
   */
  protected $bundleKey;

47 48 49 50 51 52 53
  /**
   * The table that stores properties, if the entity has multilingual support.
   *
   * @var string
   */
  protected $dataTable;

54 55 56
  /**
   * Overrides DatabaseStorageController::__construct().
   */
57 58
  public function __construct($entity_type, array $entity_info, Connection $database) {
    parent::__construct($entity_type,$entity_info, $database);
59 60
    $this->bundleKey = !empty($this->entityInfo['entity_keys']['bundle']) ? $this->entityInfo['entity_keys']['bundle'] : FALSE;
    $this->entityClass = $this->entityInfo['class'];
61

62 63 64 65 66
    // Check if the entity type has a dedicated table for properties.
    if (!empty($this->entityInfo['data_table'])) {
      $this->dataTable = $this->entityInfo['data_table'];
    }

67 68 69 70
    // Work-a-round to let load() get stdClass storage records without having to
    // override it. We map storage records to entities in
    // DatabaseStorageControllerNG:: mapFromStorageRecords().
    // @todo: Remove this once this is moved in the main controller.
71
    unset($this->entityInfo['class']);
72 73 74 75 76 77 78 79 80 81
  }

  /**
   * Overrides DatabaseStorageController::create().
   *
   * @param array $values
   *   An array of values to set, keyed by field name. The value has to be
   *   the plain value of an entity field, i.e. an array of field items.
   *   If no numerically indexed array is given, the value will be set for the
   *   first field item. For example, to set the first item of a 'name'
82
   *   field one can pass:
83 84 85 86 87 88 89 90
   *   @code
   *     $values = array('name' => array(0 => array('value' => 'the name')));
   *   @endcode
   *   or
   *   @code
   *     $values = array('name' => array('value' => 'the name'));
   *   @endcode
   *   If the 'name' field is a defined as 'string_item' which supports
91 92
   *   setting its value by a string, it's also possible to just pass the name
   *   string:
93 94 95 96
   *   @code
   *     $values = array('name' => 'the name');
   *   @endcode
   *
97
   * @return \Drupal\Core\Entity\EntityInterface
98 99 100
   *   A new entity object.
   */
  public function create(array $values) {
101
    // We have to determine the bundle first.
102 103 104 105 106 107 108
    $bundle = FALSE;
    if ($this->bundleKey) {
      if (!isset($values[$this->bundleKey])) {
        throw new EntityStorageException(t('Missing bundle for entity type @type', array('@type' => $this->entityType)));
      }
      $bundle = $values[$this->bundleKey];
    }
109
    $entity = new $this->entityClass(array(), $this->entityType, $bundle);
110 111 112 113 114 115 116

    // Set all other given values.
    foreach ($values as $name => $value) {
      $entity->$name = $value;
    }

    // Assign a new UUID if there is none yet.
117
    if ($this->uuidKey && !isset($entity->{$this->uuidKey}->value)) {
118
      $uuid = new Uuid();
119
      $entity->{$this->uuidKey} = $uuid->generate();
120
    }
121 122 123 124 125

    // Modules might need to add or change the data initially held by the new
    // entity object, for instance to fill-in default values.
    $this->invokeHook('create', $entity);

126 127 128
    return $entity;
  }

129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156
  /**
   * Builds an entity query.
   *
   * @param \Drupal\Core\Entity\Query\QueryInterface $entity_query
   *   EntityQuery instance.
   * @param array $values
   *   An associative array of properties of the entity, where the keys are the
   *   property names and the values are the values those properties must have.
   */
  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.
      if (!array_key_exists('default_langcode', $values)) {
        $values['default_langcode'] = 1;
      }
      // 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.
      elseif ($values['default_langcode'] === NULL) {
        unset($values['default_langcode']);
      }
    }

    parent::buildPropertyQuery($entity_query, $values);
  }

157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205
  /**
   * {@inheritdoc}
   */
  protected function buildQuery($ids, $revision_id = FALSE) {
    $query = $this->database->select($this->entityInfo['base_table'], 'base');
    $is_revision_query = $this->revisionKey && ($revision_id || !$this->dataTable);

    $query->addTag($this->entityType . '_load_multiple');

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

    // Add fields from the {entity} table.
    $entity_fields = drupal_schema_fields_sql($this->entityInfo['base_table']);

    if ($is_revision_query) {
      // Add all fields from the {entity_revision} table.
      $entity_revision_fields = drupal_map_assoc(drupal_schema_fields_sql($this->entityInfo['revision_table']));
      // 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 $key => $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.
      $query->addExpression('base.' . $this->revisionKey . ' = revision.' . $this->revisionKey, 'isDefaultRevision');
    }

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

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

    return $query;
  }

206 207 208 209 210 211
  /**
   * Overrides DatabaseStorageController::attachLoad().
   *
   * Added mapping from storage records to entities.
   */
  protected function attachLoad(&$queried_entities, $load_revision = FALSE) {
212
    // Map the loaded stdclass records into entity objects and according fields.
213
    $queried_entities = $this->mapFromStorageRecords($queried_entities, $load_revision);
214 215 216

    if ($this->entityInfo['fieldable']) {
      if ($load_revision) {
217
        field_attach_load_revision($this->entityType, $queried_entities);
218 219
      }
      else {
220
        field_attach_load($this->entityType, $queried_entities);
221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240
      }
    }

    // Call hook_entity_load().
    foreach (module_implements('entity_load') as $module) {
      $function = $module . '_entity_load';
      $function($queried_entities, $this->entityType);
    }
    // Call hook_TYPE_load(). The first argument for hook_TYPE_load() are
    // always the queried entities, followed by additional arguments set in
    // $this->hookLoadArguments.
    $args = array_merge(array($queried_entities), $this->hookLoadArguments);
    foreach (module_implements($this->entityType . '_load') as $module) {
      call_user_func_array($module . '_' . $this->entityType . '_load', $args);
    }
  }

  /**
   * Maps from storage records to entity objects.
   *
241 242 243 244 245
   * @param array $records
   *   Associative array of query results, keyed on the entity ID.
   * @param boolean $load_revision
   *   (optional) TRUE if the revision should be loaded, defaults to FALSE.
   *
246 247 248
   * @return array
   *   An array of entity objects implementing the EntityInterface.
   */
249
  protected function mapFromStorageRecords(array $records, $load_revision = FALSE) {
250
    $entities = array();
251
    foreach ($records as $id => $record) {
252
      $entities[$id] = array();
253
      foreach ($record as $name => $value) {
254 255 256
        // Skip the item delta and item value levels but let the field assign
        // the value as suiting. This avoids unnecessary array hierarchies and
        // saves memory here.
257 258 259 260 261 262 263 264
        $entities[$id][$name][Language::LANGCODE_DEFAULT] = $value;
      }
      // If we have no multilingual values we can instantiate entity objecs
      // 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.
        $entities[$id] = new $this->entityClass($entities[$id], $this->entityType, $bundle);
265
      }
266 267 268 269 270 271 272 273 274 275
    }
    $this->attachPropertyData($entities, $load_revision);
    return $entities;
  }

  /**
   * Attaches property data in all languages for translatable properties.
   *
   * @param array &$entities
   *   Associative array of entities, keyed on the entity ID.
276 277
   * @param int $revision_id
   *   (optional) The revision to be loaded. Defaults to FALSE.
278
   */
279
  protected function attachPropertyData(array &$entities, $revision_id = FALSE) {
280
    if ($this->dataTable) {
281 282 283 284
      // 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->revisionTable ?: $this->dataTable;
      $query = $this->database->select($table, 'data', array('fetch' => PDO::FETCH_ASSOC))
285 286 287
        ->fields('data')
        ->condition($this->idKey, array_keys($entities))
        ->orderBy('data.' . $this->idKey);
288 289 290 291 292 293 294 295 296 297 298 299

      if ($this->revisionTable) {
        if ($revision_id) {
          $query->condition($this->revisionKey, $revision_id);
        }
        else {
          // Get the revision IDs.
          $revision_ids = array();
          foreach ($entities as $id => $values) {
            $revision_ids[] = $values[$this->revisionKey];
          }
          $query->condition($this->revisionKey, $revision_ids);
300 301 302
        }
      }

303
      $data = $query->execute();
304
      $field_definition = $this->getFieldDefinitions(array());
305 306 307 308 309 310
      if ($this->revisionTable) {
        $data_fields = array_flip(array_diff(drupal_schema_fields_sql($this->entityInfo['revision_table']), drupal_schema_fields_sql($this->entityInfo['base_table'])));
      }
      else {
        $data_fields = array_flip(drupal_schema_fields_sql($this->entityInfo['data_table']));
      }
311 312 313

      foreach ($data as $values) {
        $id = $values[$this->idKey];
314

315 316 317
        // Field values in default language are stored with
        // Language::LANGCODE_DEFAULT as key.
        $langcode = empty($values['default_langcode']) ? $values['langcode'] : Language::LANGCODE_DEFAULT;
318 319

        foreach ($field_definition as $name => $definition) {
320 321 322 323 324 325
          // Set only translatable properties, unless we are dealing with a
          // revisable entity, in which case we did not load the untranslatable
          // data before.
          $translatable = !empty($definition['translatable']);
          if (isset($data_fields[$name]) && ($this->revisionTable || $translatable)) {
            $entities[$id][$name][$langcode] = $values[$name];
326 327 328
          }
        }
      }
329 330 331 332 333 334

      foreach ($entities as $id => $values) {
        $bundle = $this->bundleKey ? $values[$this->bundleKey][Language::LANGCODE_DEFAULT] : FALSE;
        // Turn the record into an entity class.
        $entities[$id] = new $this->entityClass($values, $this->entityType, $bundle);
      }
335 336 337 338 339 340 341 342 343
    }
  }

  /**
   * Overrides DatabaseStorageController::save().
   *
   * Added mapping from entities to storage records before saving.
   */
  public function save(EntityInterface $entity) {
344
    $transaction = $this->database->startTransaction();
345
    try {
346
      // Ensure we are dealing with the actual entity.
347
      $entity = $entity->getNGEntity();
348 349 350 351

      // Sync the changes made in the fields array to the internal values array.
      $entity->updateOriginalValues();

352 353 354 355 356 357 358 359 360
      // Load the stored entity, if any.
      if (!$entity->isNew() && !isset($entity->original)) {
        $entity->original = entity_load_unchanged($this->entityType, $entity->id());
      }

      $this->preSave($entity);
      $this->invokeHook('presave', $entity);

      // Create the storage record to be saved.
361
      $record = $this->mapToStorageRecord($entity);
362 363

      if (!$entity->isNew()) {
364 365 366 367 368 369 370 371 372 373 374
        if ($entity->isDefaultRevision()) {
          $return = drupal_write_record($this->entityInfo['base_table'], $record, $this->idKey);
        }
        else {
          // @todo, should a different value be returned when saving an entity
          // with $isDefaultRevision = FALSE?
          $return = FALSE;
        }
        if ($this->revisionKey) {
          $record->{$this->revisionKey} = $this->saveRevision($entity);
        }
375 376 377
        if ($this->dataTable) {
          $this->savePropertyData($entity);
        }
378 379 380 381 382
        $this->resetCache(array($entity->id()));
        $this->postSave($entity, TRUE);
        $this->invokeHook('update', $entity);
      }
      else {
383
        $return = drupal_write_record($this->entityInfo['base_table'], $record);
384
        $entity->{$this->idKey}->value = $record->{$this->idKey};
385 386 387
        if ($this->revisionKey) {
          $record->{$this->revisionKey} = $this->saveRevision($entity);
        }
388 389 390 391 392
        $entity->{$this->idKey}->value = $record->{$this->idKey};
        if ($this->dataTable) {
          $this->savePropertyData($entity);
        }

393 394 395 396 397 398 399 400 401 402 403 404 405 406
        // Reset general caches, but keep caches specific to certain entities.
        $this->resetCache(array());

        $entity->enforceIsNew(FALSE);
        $this->postSave($entity, FALSE);
        $this->invokeHook('insert', $entity);
      }

      // Ignore slave server temporarily.
      db_ignore_slave();
      unset($entity->original);

      return $return;
    }
407
    catch (\Exception $e) {
408 409 410 411 412 413
      $transaction->rollback();
      watchdog_exception($this->entityType, $e);
      throw new EntityStorageException($e->getMessage(), $e->getCode(), $e);
    }
  }

414 415 416 417 418 419 420 421 422 423
  /**
   * Saves an entity revision.
   *
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   The entity object.
   *
   * @return integer
   *   The revision id.
   */
  protected function saveRevision(EntityInterface $entity) {
424 425
    $return = $entity->id();
    $default_langcode = $entity->language()->langcode;
426

427 428 429 430 431 432
    if (!$entity->isNewRevision()) {
      // Delete to handle removed values.
      $this->database->delete($this->revisionTable)
        ->condition($this->idKey, $entity->id())
        ->condition($this->revisionKey, $entity->getRevisionId())
        ->execute();
433 434
    }

435 436 437 438 439 440 441 442 443 444 445 446 447 448
    $languages = $this->dataTable ? $entity->getTranslationLanguages(TRUE) : array($default_langcode => $entity->language());
    foreach ($languages as $langcode => $language) {
      $translation = $entity->getTranslation($langcode, FALSE);
      $record = $this->mapToRevisionStorageRecord($translation);
      $record->langcode = $langcode;
      $record->default_langcode = $langcode == $default_langcode;

      // When saving a new revision, set any existing revision ID to NULL so as
      // to ensure that a new revision will actually be created.
      if ($entity->isNewRevision() && isset($record->{$this->revisionKey})) {
        $record->{$this->revisionKey} = NULL;
      }

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

450 451 452 453 454 455 456 457 458
      if ($entity->isNewRevision()) {
        drupal_write_record($this->revisionTable, $record);
        if ($entity->isDefaultRevision()) {
          $this->database->update($this->entityInfo['base_table'])
            ->fields(array($this->revisionKey => $record->{$this->revisionKey}))
            ->condition($this->idKey, $record->{$this->idKey})
            ->execute();
        }
        $entity->setNewRevision(FALSE);
459
      }
460 461 462 463 464 465 466 467
      else {
        // @todo Use multiple insertions to improve performance.
        drupal_write_record($this->revisionTable, $record);
      }

      // Make sure to update the new revision key for the entity.
      $entity->{$this->revisionKey}->value = $record->{$this->revisionKey};
      $return = $record->{$this->revisionKey};
468
    }
469 470

    return $return;
471 472
  }

473 474 475 476 477 478 479 480
  /**
   * Stores the entity property language-aware data.
   *
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   The entity object.
   */
  protected function savePropertyData(EntityInterface $entity) {
    // Delete and insert to handle removed values.
481
    $this->database->delete($this->dataTable)
482 483 484
      ->condition($this->idKey, $entity->id())
      ->execute();

485
    $query = $this->database->insert($this->dataTable);
486 487 488 489 490 491 492 493 494 495 496 497

    foreach ($entity->getTranslationLanguages() as $langcode => $language) {
      $record = $this->mapToDataStorageRecord($entity, $langcode);
      $values = (array) $record;
      $query
        ->fields(array_keys($values))
        ->values($values);
    }

    $query->execute();
  }

498 499 500
  /**
   * Overrides DatabaseStorageController::invokeHook().
   *
501
   * Invokes field API attachers with a BC entity.
502 503
   */
  protected function invokeHook($hook, EntityInterface $entity) {
504 505 506 507 508 509 510
    $function = 'field_attach_' . $hook;
    // @todo: field_attach_delete_revision() is named the wrong way round,
    // consider renaming it.
    if ($function == 'field_attach_revision_delete') {
      $function = 'field_attach_delete_revision';
    }
    if (!empty($this->entityInfo['fieldable']) && function_exists($function)) {
511
      $function($entity);
512 513 514 515 516 517 518 519 520 521
    }

    // Invoke the hook.
    module_invoke_all($this->entityType . '_' . $hook, $entity);
    // Invoke the respective entity-level hook.
    module_invoke_all('entity_' . $hook, $entity, $this->entityType);
  }

  /**
   * Maps from an entity object to the storage record of the base table.
522 523 524 525 526 527
   *
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   The entity object.
   *
   * @return \stdClass
   *   The record to store.
528 529 530
   */
  protected function mapToStorageRecord(EntityInterface $entity) {
    $record = new \stdClass();
531
    foreach (drupal_schema_fields_sql($this->entityInfo['base_table']) as $name) {
532 533 534 535
      $record->$name = $entity->$name->value;
    }
    return $record;
  }
536 537 538

  /**
   * Maps from an entity object to the storage record of the revision table.
539 540 541 542 543 544
   *
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   The entity object.
   *
   * @return \stdClass
   *   The record to store.
545
   */
546
  protected function mapToRevisionStorageRecord(ComplexDataInterface $entity) {
547
    $record = new \stdClass();
548
    $definitions = $entity->getPropertyDefinitions();
549
    foreach (drupal_schema_fields_sql($this->entityInfo['revision_table']) as $name) {
550
      if (isset($definitions[$name]) && isset($entity->$name->value)) {
551 552
        $record->$name = $entity->$name->value;
      }
553 554 555
    }
    return $record;
  }
556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572

  /**
   * Maps from an entity object to the storage record of the data table.
   *
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   The entity object.
   * @param $langcode
   *   The language code of the translation to get.
   *
   * @return \stdClass
   *   The record to store.
   */
  protected function mapToDataStorageRecord(EntityInterface $entity, $langcode) {
    $default_langcode = $entity->language()->langcode;
    // Don't use strict mode, this way there's no need to do checks here, as
    // non-translatable properties are replicated for each language.
    $translation = $entity->getTranslation($langcode, FALSE);
573 574
    $definitions = $translation->getPropertyDefinitions();
    $schema = drupal_get_schema($this->entityInfo['data_table']);
575 576

    $record = new \stdClass();
577
    foreach (drupal_schema_fields_sql($this->entityInfo['data_table']) as $name) {
578 579 580
      $info = $schema['fields'][$name];
      $value = isset($definitions[$name]) && isset($translation->$name->value) ? $translation->$name->value : NULL;
      $record->$name = drupal_schema_get_field_value($info, $value);
581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596
    }
    $record->langcode = $langcode;
    $record->default_langcode = intval($default_langcode == $langcode);

    return $record;
  }

  /**
   * Overwrites \Drupal\Core\Entity\DatabaseStorageController::delete().
   */
  public function delete(array $entities) {
    if (!$entities) {
      // If no IDs or invalid IDs were passed, do nothing.
      return;
    }

597
    $transaction = $this->database->startTransaction();
598
    try {
599 600
      // Ensure we are dealing with the actual entities.
      foreach ($entities as $id => $entity) {
601
        $entities[$id] = $entity->getNGEntity();
602 603
      }

604 605 606 607 608 609
      $this->preDelete($entities);
      foreach ($entities as $id => $entity) {
        $this->invokeHook('predelete', $entity);
      }
      $ids = array_keys($entities);

610
      $this->database->delete($this->entityInfo['base_table'])
611 612 613 614
        ->condition($this->idKey, $ids)
        ->execute();

      if ($this->revisionKey) {
615
        $this->database->delete($this->revisionTable)
616 617 618 619 620
          ->condition($this->idKey, $ids)
          ->execute();
      }

      if ($this->dataTable) {
621
        $this->database->delete($this->dataTable)
622 623 624 625 626 627 628 629 630 631 632 633 634 635
          ->condition($this->idKey, $ids)
          ->execute();
      }

      // Reset the cache as soon as the changes have been applied.
      $this->resetCache($ids);

      $this->postDelete($entities);
      foreach ($entities as $id => $entity) {
        $this->invokeHook('delete', $entity);
      }
      // Ignore slave server temporarily.
      db_ignore_slave();
    }
636
    catch (\Exception $e) {
637 638
      $transaction->rollback();
      watchdog_exception($this->entityType, $e);
639
      throw new EntityStorageException($e->getMessage(), $e->getCode(), $e);
640 641
    }
  }
642
}