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

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

use Drupal\Core\Database\Query\SelectInterface;
use Drupal\Core\Entity\Query\QueryException;
7
use Drupal\Core\Entity\Sql\SqlEntityStorageInterface;
8
9
10
11

/**
 * Adds tables and fields to the SQL entity query.
 */
12
class Tables implements TablesInterface {
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37

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

  /**
   * Entity table array, key is table name, value is alias.
   *
   * This array contains at most two entries: one for the data, one for the
   * properties.
   *
   * @var array
   */
  protected $entityTables = array();

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

38
39
40
41
42
43
44
  /**
   * The entity manager.
   *
   * @var \Drupal\Core\Entity\EntityManager
   */
  protected $entityManager;

45
46
47
48
49
50
51
  /**
   * List of case sensitive fields.
   *
   * @var array
   */
  protected $caseSensitiveFields = array();

52
53
54
  /**
   * @param \Drupal\Core\Database\Query\SelectInterface $sql_query
   */
55
  public function __construct(SelectInterface $sql_query) {
56
    $this->sqlQuery = $sql_query;
57
    $this->entityManager = \Drupal::entityManager();
58
59
60
  }

  /**
61
   * {@inheritdoc}
62
   */
63
  public function addField($field, $type, $langcode) {
64
    $entity_type_id = $this->sqlQuery->getMetaData('entity_type');
65
    $all_revisions = $this->sqlQuery->getMetaData('all_revisions');
66
67
68
69
70
71
72
73
74
75
76
77
78
79
    // 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.
    $propertyDefinitions = array();
80
    $entity_type = $this->entityManager->getDefinition($entity_type_id);
81

82
    $field_storage_definitions = $this->entityManager->getFieldStorageDefinitions($entity_type_id);
83
    for ($key = 0; $key <= $count; $key ++) {
84
85
86
87
88
89
90
91
92
93
94
95
96
97
      // 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];
      }
      else {
        $field_storage = FALSE;
      }

      // 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()) {
98
99
        // This contains the relevant SQL field to be used when joining entity
        // tables.
100
        $entity_id_field = $revision_key;
101
102
103
104
105
        // This contains the relevant SQL field to be used when joining field
        // tables.
        $field_id_field = 'revision_id';
      }
      else {
106
        $entity_id_field = $entity_type->getKey('id');
107
108
        $field_id_field = 'entity_id';
      }
109
110
111
112
113
114

      /** @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)) {
115
        // Find the field column.
116
        $column = $field_storage->getMainPropertyName();
117

118
119
120
        if ($key < $count) {
          $next = $specifiers[$key + 1];
          // Is this a field column?
121
          $columns = $field_storage->getColumns();
122
          if (isset($columns[$next]) || in_array($next, $table_mapping->getReservedColumns())) {
123
124
125
126
127
128
129
130
131
132
133
134
135
136
            // 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];
137
            $propertyDefinitions = $field_storage->getPropertyDefinitions();
138

139
140
141
142
            // Prepare the next index prefix.
            $next_index_prefix = "$relationship_specifier.$column";
          }
        }
143
        $table = $this->ensureFieldTable($index_prefix, $field_storage, $type, $langcode, $base_table, $entity_id_field, $field_id_field);
144
        $sql_column = $table_mapping->getFieldColumnName($field_storage, $column);
145
146
147
148
        $property_definitions = $field_storage->getPropertyDefinitions();
        if (isset($property_definitions[$column])) {
          $this->caseSensitiveFields[$field] = $property_definitions[$column]->getSetting('case_sensitive');
        }
149
      }
150
      // The field is stored in a shared table.
151
152
153
      else {
        // ensureEntityTable() decides whether an entity property will be
        // queried from the data table or the base table based on where it
154
        // finds the property first. The data table is preferred, which is why
155
156
        // it gets added before the base table.
        $entity_tables = array();
157
158
159
160
161
162
163
164
165
        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) {
166
          $this->sqlQuery->addMetaData('simple_query', FALSE);
167
          $entity_tables[$data_table] = $this->getTableMapping($data_table, $entity_type_id);
168
        }
169
        $entity_tables[$entity_base_table] = $this->getTableMapping($entity_base_table, $entity_type_id);
170
        $sql_column = $specifier;
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186

        // 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];
          // 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);
187

188
189
        // If there is a field storage (some specifiers are not), check for case
        // sensitivity.
190
191
192
193
194
195
196
197
        if ($field_storage) {
          $column = $field_storage->getMainPropertyName();
          $base_field_property_definitions = $field_storage->getPropertyDefinitions();
          if (isset($base_field_property_definitions[$column])) {
            $this->caseSensitiveFields[$field] = $base_field_property_definitions[$column]->getSetting('case_sensitive');
          }
        }

198
199
      }
      // If there are more specifiers to come, it's a relationship.
200
      if ($field_storage && $key < $count) {
201
202
203
        // Computed fields have prepared their property definition already, do
        // it for properties as well.
        if (!$propertyDefinitions) {
204
          $propertyDefinitions = $field_storage->getPropertyDefinitions();
205
206
207
208
          $relationship_specifier = $specifiers[$key + 1];
          $next_index_prefix = $relationship_specifier;
        }
        // Check for a valid relationship.
209
        if (isset($propertyDefinitions[$relationship_specifier]) && $field_storage->getPropertyDefinition('entity')->getDataType() == 'entity_reference' ) {
210
          // If it is, use the entity type.
211
          $entity_type_id = $propertyDefinitions[$relationship_specifier]->getTargetDefinition()->getEntityTypeId();
212
213
          $entity_type = $this->entityManager->getDefinition($entity_type_id);
          $field_storage_definitions = $this->entityManager->getFieldStorageDefinitions($entity_type_id);
214
          // Add the new entity base table using the table and sql column.
215
216
          $join_condition= '%alias.' . $entity_type->getKey('id') . " = $table.$sql_column";
          $base_table = $this->sqlQuery->leftJoin($entity_type->getBaseTable(), NULL, $join_condition);
217
218
219
220
221
          $propertyDefinitions = array();
          $key++;
          $index_prefix .= "$next_index_prefix.";
        }
        else {
222
          throw new QueryException("Invalid specifier '$relationship_specifier'");
223
224
        }
      }
225
226
227
228
    }
    return "$table.$sql_column";
  }

229
230
231
232
233
234
235
236
237
  /**
   * {@inheritdoc}
   */
  public function isFieldCaseSensitive($field_name) {
    if (isset($this->caseSensitiveFields[$field_name])) {
      return $this->caseSensitiveFields[$field_name];
    }
  }

238
239
240
241
  /**
   * Join entity table if necessary and return the alias for it.
   *
   * @param string $property
242
   *
243
   * @return string
244
   *
245
246
   * @throws \Drupal\Core\Entity\Query\QueryException
   */
247
  protected function ensureEntityTable($index_prefix, $property, $type, $langcode, $base_table, $id_field, $entity_tables) {
248
249
    foreach ($entity_tables as $table => $mapping) {
      if (isset($mapping[$property])) {
250
251
        if (!isset($this->entityTables[$index_prefix . $table])) {
          $this->entityTables[$index_prefix . $table] = $this->addJoin($type, $table, "%alias.$id_field = $base_table.$id_field", $langcode);
252
        }
253
        return $this->entityTables[$index_prefix . $table];
254
255
      }
    }
256
    throw new QueryException("'$property' not found");
257
258
259
260
261
262
263
264
265
266
  }

  /**
   * Join field table if necessary.
   *
   * @param $field_name
   *   Name of the field.
   * @return string
   * @throws \Drupal\Core\Entity\Query\QueryException
   */
267
  protected function ensureFieldTable($index_prefix, &$field, $type, $langcode, $base_table, $entity_id_field, $field_id_field) {
268
    $field_name = $field->getName();
269
    if (!isset($this->fieldTables[$index_prefix . $field_name])) {
270
271
272
      $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();
273
      $table = !$this->sqlQuery->getMetaData('all_revisions') ? $table_mapping->getDedicatedDataTableName($field) : $table_mapping->getDedicatedRevisionTableName($field);
274
      if ($field->getCardinality() != 1) {
275
276
        $this->sqlQuery->addMetaData('simple_query', FALSE);
      }
277
      $this->fieldTables[$index_prefix . $field_name] = $this->addJoin($type, $table, "%alias.$field_id_field = $base_table.$entity_id_field", $langcode);
278
    }
279
    return $this->fieldTables[$index_prefix . $field_name];
280
281
282
283
284
  }

  protected function addJoin($type, $table, $join_condition, $langcode) {
    $arguments = array();
    if ($langcode) {
285
286
287
288
289
      $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';
290
      $placeholder = ':langcode' . $this->sqlQuery->nextPlaceholder();
291
      $join_condition .= ' AND %alias.' . $langcode_key . ' = ' . $placeholder;
292
293
294
295
296
      $arguments[$placeholder] = $langcode;
    }
    return $this->sqlQuery->addJoin($type, $table, NULL, $join_condition, $arguments);
  }

297
  /**
298
   * Gets the schema for the given table.
299
300
301
302
303
304
305
306
307
308
309
310
311
   *
   * @param string $table
   *   The table name.
   *
   * @return array|bool
   *   The table field mapping for the given table or FALSE if not available.
   */
  protected function getTableMapping($table, $entity_type_id) {
    $storage = $this->entityManager->getStorage($entity_type_id);
    if ($storage instanceof SqlEntityStorageInterface) {
      $mapping = $storage->getTableMapping()->getAllColumns($table);
    }
    else {
312
      return FALSE;
313
314
315
316
    }
    return array_flip($mapping);
  }

317
}