Tables.php 18.1 KB
Newer Older
1 2
<?php

3
namespace Drupal\Core\Entity\Query\Sql;
4 5

use Drupal\Core\Database\Query\SelectInterface;
6
use Drupal\Core\Entity\EntityType;
7
use Drupal\Core\Entity\Query\QueryException;
8
use Drupal\Core\Entity\Sql\SqlEntityStorageInterface;
9
use Drupal\Core\Entity\Sql\TableMappingInterface;
10
use Drupal\Core\Entity\TypedData\EntityDataDefinitionInterface;
11
use Drupal\Core\Field\FieldStorageDefinitionInterface;
12
use Drupal\Core\TypedData\DataReferenceDefinitionInterface;
13 14 15 16

/**
 * Adds tables and fields to the SQL entity query.
 */
17
class Tables implements TablesInterface {
18 19 20 21 22 23 24

  /**
   * @var \Drupal\Core\Database\Query\SelectInterface
   */
  protected $sqlQuery;

  /**
25
   * Entity table array.
26 27
   *
   * This array contains at most two entries: one for the data, one for the
28 29 30 31
   * properties. Its keys are unique references to the tables, values are
   * aliases.
   *
   * @see \Drupal\Core\Entity\Query\Sql\Tables::ensureEntityTable().
32 33 34
   *
   * @var array
   */
35
  protected $entityTables = [];
36 37 38 39 40 41 42 43

  /**
   * Field table array, key is table name, value is alias.
   *
   * This array contains one entry per field table.
   *
   * @var array
   */
44
  protected $fieldTables = [];
45

46 47 48 49 50 51 52
  /**
   * The entity manager.
   *
   * @var \Drupal\Core\Entity\EntityManager
   */
  protected $entityManager;

53 54 55 56 57
  /**
   * List of case sensitive fields.
   *
   * @var array
   */
58
  protected $caseSensitiveFields = [];
59

60 61 62
  /**
   * @param \Drupal\Core\Database\Query\SelectInterface $sql_query
   */
63
  public function __construct(SelectInterface $sql_query) {
64
    $this->sqlQuery = $sql_query;
65
    $this->entityManager = \Drupal::entityManager();
66 67 68
  }

  /**
69
   * {@inheritdoc}
70
   */
71
  public function addField($field, $type, $langcode) {
72
    $entity_type_id = $this->sqlQuery->getMetaData('entity_type');
73
    $all_revisions = $this->sqlQuery->getMetaData('all_revisions');
74 75 76 77 78 79 80 81 82 83 84 85 86
    // This variable ensures grouping works correctly. For example:
    // ->condition('tags', 2, '>')
    // ->condition('tags', 20, '<')
    // ->condition('node_reference.nid.entity.tags', 2)
    // The first two should use the same table but the last one needs to be a
    // new table. So for the first two, the table array index will be 'tags'
    // while the third will be 'node_reference.nid.tags'.
    $index_prefix = '';
    $specifiers = explode('.', $field);
    $base_table = 'base_table';
    $count = count($specifiers) - 1;
    // This will contain the definitions of the last specifier seen by the
    // system.
87
    $propertyDefinitions = [];
88
    $entity_type = $this->entityManager->getDefinition($entity_type_id);
89

90
    $field_storage_definitions = $this->entityManager->getFieldStorageDefinitions($entity_type_id);
91
    for ($key = 0; $key <= $count; $key++) {
92 93 94 95 96
      // This can either be the name of an entity base field or a configurable
      // field.
      $specifier = $specifiers[$key];
      if (isset($field_storage_definitions[$specifier])) {
        $field_storage = $field_storage_definitions[$specifier];
97
        $column = $field_storage->getMainPropertyName();
98 99 100
      }
      else {
        $field_storage = FALSE;
101
        $column = NULL;
102 103 104 105 106 107
      }

      // If there is revision support, only the current revisions are being
      // queried, and the field is revisionable then use the revision id.
      // Otherwise, the entity id will do.
      if (($revision_key = $entity_type->getKey('revision')) && $all_revisions && $field_storage && $field_storage->isRevisionable()) {
108 109
        // This contains the relevant SQL field to be used when joining entity
        // tables.
110
        $entity_id_field = $revision_key;
111 112 113 114 115
        // This contains the relevant SQL field to be used when joining field
        // tables.
        $field_id_field = 'revision_id';
      }
      else {
116
        $entity_id_field = $entity_type->getKey('id');
117 118
        $field_id_field = 'entity_id';
      }
119 120 121 122 123 124

      /** @var \Drupal\Core\Entity\Sql\DefaultTableMapping $table_mapping */
      $table_mapping = $this->entityManager->getStorage($entity_type_id)->getTableMapping();

      // Check whether this field is stored in a dedicated table.
      if ($field_storage && $table_mapping->requiresDedicatedTableStorage($field_storage)) {
125
        $delta = NULL;
126

127 128
        if ($key < $count) {
          $next = $specifiers[$key + 1];
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
          // If this is a numeric specifier we're adding a condition on the
          // specific delta.
          if (is_numeric($next)) {
            $delta = $next;
            $index_prefix .= ".$delta";
            // Do not process it again.
            $key++;
            $next = $specifiers[$key + 1];
          }
          // If this specifier is the reserved keyword "%delta" we're adding a
          // condition on a delta range.
          elseif ($next == TableMappingInterface::DELTA) {
            $index_prefix .= TableMappingInterface::DELTA;
            // Do not process it again.
            $key++;
            // If there are more specifiers to work with then continue
            // processing. If this is the last specifier then use the reserved
            // keyword as a column name.
            if ($key < $count) {
              $next = $specifiers[$key + 1];
            }
            else {
              $column = TableMappingInterface::DELTA;
            }
          }
154
          // Is this a field column?
155
          $columns = $field_storage->getColumns();
156
          if (isset($columns[$next]) || in_array($next, $table_mapping->getReservedColumns())) {
157 158 159 160 161 162 163 164 165 166 167 168 169 170
            // Use it.
            $column = $next;
            // Do not process it again.
            $key++;
          }
          // If there are more specifiers, the next one must be a
          // relationship. Either the field name followed by a relationship
          // specifier, for example $node->field_image->entity. Or a field
          // column followed by a relationship specifier, for example
          // $node->field_image->fid->entity. In both cases, prepare the
          // property definitions for the relationship. In the first case,
          // also use the property definitions for column.
          if ($key < $count) {
            $relationship_specifier = $specifiers[$key + 1];
171
            $propertyDefinitions = $field_storage->getPropertyDefinitions();
172

173 174 175 176
            // Prepare the next index prefix.
            $next_index_prefix = "$relationship_specifier.$column";
          }
        }
177
        $table = $this->ensureFieldTable($index_prefix, $field_storage, $type, $langcode, $base_table, $entity_id_field, $field_id_field, $delta);
178
        $sql_column = $table_mapping->getFieldColumnName($field_storage, $column);
179
      }
180
      // The field is stored in a shared table.
181 182 183
      else {
        // ensureEntityTable() decides whether an entity property will be
        // queried from the data table or the base table based on where it
184
        // finds the property first. The data table is preferred, which is why
185
        // it gets added before the base table.
186
        $entity_tables = [];
187 188 189 190 191 192 193 194 195
        if ($all_revisions && $field_storage && $field_storage->isRevisionable()) {
          $data_table = $entity_type->getRevisionDataTable();
          $entity_base_table = $entity_type->getRevisionTable();
        }
        else {
          $data_table = $entity_type->getDataTable();
          $entity_base_table = $entity_type->getBaseTable();
        }
        if ($data_table) {
196
          $this->sqlQuery->addMetaData('simple_query', FALSE);
197
          $entity_tables[$data_table] = $this->getTableMapping($data_table, $entity_type_id);
198
        }
199
        $entity_tables[$entity_base_table] = $this->getTableMapping($entity_base_table, $entity_type_id);
200
        $sql_column = $specifier;
201 202 203 204 205

        // If there are more specifiers, get the right sql column name if the
        // next one is a column of this field.
        if ($key < $count) {
          $next = $specifiers[$key + 1];
206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226
          // If this specifier is the reserved keyword "%delta" we're adding a
          // condition on a delta range.
          if ($next == TableMappingInterface::DELTA) {
            $key++;
            if ($key < $count) {
              $next = $specifiers[$key + 1];
            }
            else {
              return 0;
            }
          }
          // If this is a numeric specifier we're adding a condition on the
          // specific delta. Since we know that this is a single value base
          // field no other value than 0 makes sense.
          if (is_numeric($next)) {
            if ($next > 0) {
              $this->sqlQuery->condition('1 <> 1');
            }
            $key++;
            $next = $specifiers[$key + 1];
          }
227 228 229 230 231 232 233 234 235 236 237
          // Is this a field column?
          $columns = $field_storage->getColumns();
          if (isset($columns[$next]) || in_array($next, $table_mapping->getReservedColumns())) {
            // Use it.
            $sql_column = $table_mapping->getFieldColumnName($field_storage, $next);
            // Do not process it again.
            $key++;
          }
        }

        $table = $this->ensureEntityTable($index_prefix, $sql_column, $type, $langcode, $base_table, $entity_id_field, $entity_tables);
238
      }
239

240 241 242 243 244 245
      // If there is a field storage (some specifiers are not) and a field
      // column, check for case sensitivity.
      if ($field_storage && $column) {
        $property_definitions = $field_storage->getPropertyDefinitions();
        if (isset($property_definitions[$column])) {
          $this->caseSensitiveFields[$field] = $property_definitions[$column]->getSetting('case_sensitive');
246
        }
247
      }
248

249
      // If there are more specifiers to come, it's a relationship.
250
      if ($field_storage && $key < $count) {
251 252 253
        // Computed fields have prepared their property definition already, do
        // it for properties as well.
        if (!$propertyDefinitions) {
254
          $propertyDefinitions = $field_storage->getPropertyDefinitions();
255 256 257
          $relationship_specifier = $specifiers[$key + 1];
          $next_index_prefix = $relationship_specifier;
        }
258 259 260 261 262 263
        $entity_type_id = NULL;
        // Relationship specifier can also contain the entity type ID, i.e.
        // entity:node, entity:user or entity:taxonomy.
        if (strpos($relationship_specifier, ':') !== FALSE) {
          list($relationship_specifier, $entity_type_id) = explode(':', $relationship_specifier, 2);
        }
264
        // Check for a valid relationship.
265 266 267 268 269 270 271
        if (isset($propertyDefinitions[$relationship_specifier]) && $propertyDefinitions[$relationship_specifier] instanceof DataReferenceDefinitionInterface) {
          // If it is, use the entity type if specified already, otherwise use
          // the definition.
          $target_definition = $propertyDefinitions[$relationship_specifier]->getTargetDefinition();
          if (!$entity_type_id && $target_definition instanceof EntityDataDefinitionInterface) {
            $entity_type_id = $target_definition->getEntityTypeId();
          }
272 273
          $entity_type = $this->entityManager->getDefinition($entity_type_id);
          $field_storage_definitions = $this->entityManager->getFieldStorageDefinitions($entity_type_id);
274
          // Add the new entity base table using the table and sql column.
275
          $base_table = $this->addNextBaseTable($entity_type, $table, $sql_column, $field_storage);
276
          $propertyDefinitions = [];
277 278 279 280
          $key++;
          $index_prefix .= "$next_index_prefix.";
        }
        else {
281
          throw new QueryException("Invalid specifier '$relationship_specifier'");
282 283
        }
      }
284 285 286 287
    }
    return "$table.$sql_column";
  }

288 289 290 291 292 293 294 295 296
  /**
   * {@inheritdoc}
   */
  public function isFieldCaseSensitive($field_name) {
    if (isset($this->caseSensitiveFields[$field_name])) {
      return $this->caseSensitiveFields[$field_name];
    }
  }

297
  /**
298
   * Joins the entity table, if necessary, and returns the alias for it.
299
   *
300 301 302 303
   * @param string $index_prefix
   *   The table array index prefix. For a base table this will be empty,
   *   for a target entity reference like 'field_tags.entity:taxonomy_term.name'
   *   this will be 'entity:taxonomy_term.target_id.'.
304
   * @param string $property
305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320
   *   The field property/column.
   * @param string $type
   *   The join type, can either be INNER or LEFT.
   * @param string $langcode
   *   The langcode we use on the join.
   * @param string $base_table
   *   The table to join to. It can be either the table name, its alias or the
   *   'base_table' placeholder.
   * @param string $id_field
   *   The name of the ID field/property for the current entity. For instance:
   *   tid, nid, etc.
   * @param array $entity_tables
   *   Array of entity tables (data and base tables) where decide the entity
   *   property will be queried from. The first table containing the property
   *   will be used, so the order is important and the data table is always
   *   preferred.
321
   *
322
   * @return string
323
   *   The alias of the joined table.
324
   *
325
   * @throws \Drupal\Core\Entity\Query\QueryException
326
   *   When an invalid property has been passed.
327
   */
328
  protected function ensureEntityTable($index_prefix, $property, $type, $langcode, $base_table, $id_field, $entity_tables) {
329 330
    foreach ($entity_tables as $table => $mapping) {
      if (isset($mapping[$property])) {
331 332 333 334 335 336 337 338
        // Ensure a table joined multiple times through different index prefixes
        // has unique entityTables entries by concatenating the index prefix
        // and the base table alias. In this way i.e. if we join to the same
        // entity table several times for different entity reference fields,
        // each join gets a separate alias.
        $key = $index_prefix . ($base_table === 'base_table' ? $table : $base_table);
        if (!isset($this->entityTables[$key])) {
          $this->entityTables[$key] = $this->addJoin($type, $table, "%alias.$id_field = $base_table.$id_field", $langcode);
339
        }
340
        return $this->entityTables[$key];
341 342
      }
    }
343
    throw new QueryException("'$property' not found");
344 345 346 347 348 349 350 351 352 353
  }

  /**
   * Join field table if necessary.
   *
   * @param $field_name
   *   Name of the field.
   * @return string
   * @throws \Drupal\Core\Entity\Query\QueryException
   */
354
  protected function ensureFieldTable($index_prefix, &$field, $type, $langcode, $base_table, $entity_id_field, $field_id_field, $delta) {
355
    $field_name = $field->getName();
356
    if (!isset($this->fieldTables[$index_prefix . $field_name])) {
357 358 359
      $entity_type_id = $this->sqlQuery->getMetaData('entity_type');
      /** @var \Drupal\Core\Entity\Sql\DefaultTableMapping $table_mapping */
      $table_mapping = $this->entityManager->getStorage($entity_type_id)->getTableMapping();
360
      $table = !$this->sqlQuery->getMetaData('all_revisions') ? $table_mapping->getDedicatedDataTableName($field) : $table_mapping->getDedicatedRevisionTableName($field);
361
      if ($field->getCardinality() != 1) {
362 363
        $this->sqlQuery->addMetaData('simple_query', FALSE);
      }
364
      $this->fieldTables[$index_prefix . $field_name] = $this->addJoin($type, $table, "%alias.$field_id_field = $base_table.$entity_id_field", $langcode, $delta);
365
    }
366
    return $this->fieldTables[$index_prefix . $field_name];
367 368
  }

369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385
  /**
   * Adds a join to a given table.
   *
   * @param string $type
   *   The join type.
   * @param string $table
   *   The table to join to.
   * @param string $join_condition
   *   The condition on which to join to.
   * @param string $langcode
   *   The langcode we use on the join.
   * @param string|null $delta
   *   (optional) A delta which should be used as additional condition.
   *
   * @return string
   *   Returns the alias of the joined table.
   */
386
  protected function addJoin($type, $table, $join_condition, $langcode, $delta = NULL) {
387
    $arguments = [];
388
    if ($langcode) {
389 390 391 392 393
      $entity_type_id = $this->sqlQuery->getMetaData('entity_type');
      $entity_type = $this->entityManager->getDefinition($entity_type_id);
      // Only the data table follows the entity language key, dedicated field
      // tables have an hard-coded 'langcode' column.
      $langcode_key = $entity_type->getDataTable() == $table ? $entity_type->getKey('langcode') : 'langcode';
394
      $placeholder = ':langcode' . $this->sqlQuery->nextPlaceholder();
395
      $join_condition .= ' AND %alias.' . $langcode_key . ' = ' . $placeholder;
396 397
      $arguments[$placeholder] = $langcode;
    }
398 399 400 401 402
    if (isset($delta)) {
      $placeholder = ':delta' . $this->sqlQuery->nextPlaceholder();
      $join_condition .= ' AND %alias.delta = ' . $placeholder;
      $arguments[$placeholder] = $delta;
    }
403 404 405
    return $this->sqlQuery->addJoin($type, $table, NULL, $join_condition, $arguments);
  }

406
  /**
407
   * Gets the schema for the given table.
408 409 410 411
   *
   * @param string $table
   *   The table name.
   *
412 413 414 415
   * @return array|false
   *   An associative array of table field mapping for the given table, keyed by
   *   columns name and values are just incrementing integers. If the table
   *   mapping is not available, FALSE is returned.
416 417 418 419 420 421 422
   */
  protected function getTableMapping($table, $entity_type_id) {
    $storage = $this->entityManager->getStorage($entity_type_id);
    if ($storage instanceof SqlEntityStorageInterface) {
      $mapping = $storage->getTableMapping()->getAllColumns($table);
    }
    else {
423
      return FALSE;
424 425 426 427
    }
    return array_flip($mapping);
  }

428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443
  /**
   * Add the next entity base table.
   *
   * For example, when building the SQL query for
   * @code
   * condition('uid.entity.name', 'foo', 'CONTAINS')
   * @endcode
   *
   * this adds the users table.
   *
   * @param \Drupal\Core\Entity\EntityType $entity_type
   *   The entity type being joined, in the above example, User.
   * @param string $table
   *   This is the table being joined, in the above example, {users}.
   * @param string $sql_column
   *   This is the SQL column in the existing table being joined to.
444 445
   * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $field_storage
   *   The field storage definition for the field referencing this column.
446 447 448 449
   *
   * @return string
   *   The alias of the next entity table joined in.
   */
450
  protected function addNextBaseTable(EntityType $entity_type, $table, $sql_column, FieldStorageDefinitionInterface $field_storage) {
451 452 453 454
    $join_condition = '%alias.' . $entity_type->getKey('id') . " = $table.$sql_column";
    return $this->sqlQuery->leftJoin($entity_type->getBaseTable(), NULL, $join_condition);
  }

455
}