Sql.php 59.1 KB
Newer Older
merlinofchaos's avatar
merlinofchaos committed
1
2
3
4
<?php

/**
 * @file
5
 * Definition of Drupal\views\Plugin\views\query\Sql.
merlinofchaos's avatar
merlinofchaos committed
6
7
 */

8
namespace Drupal\views\Plugin\views\query;
9

10
use Drupal\Component\Utility\NestedArray;
11
use Drupal\Core\Database\Database;
12
use Drupal\views\Plugin\views\display\DisplayPluginBase;
13
use Drupal\Core\Database\DatabaseExceptionWrapper;
14
use Drupal\views\Plugin\views\join\JoinPluginBase;
15
use Drupal\views\Plugin\views\HandlerBase;
16
use Drupal\views\Annotation\ViewsQuery;
17
use Drupal\Core\Annotation\Translation;
18
use Drupal\views\ViewExecutable;
19
use Drupal\views\Views;
20

21
/**
22
23
 * @todo.
 *
24
 * @ViewsQuery(
aspilicious's avatar
aspilicious committed
25
 *   id = "views_query",
26
27
28
29
 *   title = @Translation("SQL Query"),
 *   help = @Translation("Query will be generated and run using the Drupal database API.")
 * )
 */
30
class Sql extends QueryPluginBase {
tim.plunkett's avatar
tim.plunkett committed
31

merlinofchaos's avatar
merlinofchaos committed
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
  /**
   * A list of tables in the order they should be added, keyed by alias.
   */
  var $table_queue = array();

  /**
   * Holds an array of tables and counts added so that we can create aliases
   */
  var $tables = array();

  /**
   * Holds an array of relationships, which are aliases of the primary
   * table that represent different ways to join the same table in.
   */
  var $relationships = array();

  /**
   * An array of sections of the WHERE query. Each section is in itself
   * an array of pieces and a flag as to whether or not it should be AND
   * or OR.
   */
  var $where = array();
  /**
   * An array of sections of the HAVING query. Each section is in itself
   * an array of pieces and a flag as to whether or not it should be AND
   * or OR.
   */
  var $having = array();
  /**
   * The default operator to use when connecting the WHERE groups. May be
   * AND or OR.
   */
  var $group_operator = 'AND';

  /**
   * A simple array of order by clauses.
   */
  var $orderby = array();

  /**
   * A simple array of group by clauses.
   */
  var $groupby = array();


  /**
   * An array of fields.
   */
  var $fields = array();

  /**
   * A flag as to whether or not to make the primary field distinct.
   */
  var $distinct = FALSE;

  var $has_aggregate = FALSE;

  /**
   * Should this query be optimized for counts, for example no sorts.
   */
  var $get_count_optimized = NULL;

94
95
96
  /**
   * An array mapping table aliases and field names to field aliases.
   */
97
  var $field_aliases = array();
merlinofchaos's avatar
merlinofchaos committed
98

99
100
101
  /**
   * Query tags which will be passed over to the dbtng query object.
   */
102
  var $tags = array();
merlinofchaos's avatar
merlinofchaos committed
103
104
105
106
107
108
109
110
111

  /**
   * Is the view marked as not distinct.
   *
   * @var bool
   */
  var $no_distinct;

  /**
112
   * Overrides \Drupal\views\Plugin\views\PluginBase::init().
merlinofchaos's avatar
merlinofchaos committed
113
   */
114
  public function init(ViewExecutable $view, DisplayPluginBase $display, array &$options = NULL) {
115
    parent::init($view, $display, $options);
116

117
118
    $base_table = $this->view->storage->get('base_table');
    $base_field = $this->view->storage->get('base_field');
merlinofchaos's avatar
merlinofchaos committed
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
    $this->relationships[$base_table] = array(
      'link' => NULL,
      'table' => $base_table,
      'alias' => $base_table,
      'base' => $base_table
    );

    // init the table queue with our primary table.
    $this->table_queue[$base_table] = array(
      'alias' => $base_table,
      'table' => $base_table,
      'relationship' => $base_table,
      'join' => NULL,
    );

    // init the tables with our primary table
    $this->tables[$base_table][$base_table] = array(
      'count' => 1,
      'alias' => $base_table,
    );

    $this->count_field = array(
      'table' => $base_table,
      'field' => $base_field,
      'alias' => $base_field,
      'count' => TRUE,
    );
  }

  /**
149
   * Set the view to be distinct (per base field).
merlinofchaos's avatar
merlinofchaos committed
150
151
152
153
   *
   * @param bool $value
   *   Should the view by distincted.
   */
154
  protected function setDistinct($value = TRUE) {
merlinofchaos's avatar
merlinofchaos committed
155
156
157
158
159
160
161
162
    if (!(isset($this->no_distinct) && $value)) {
      $this->distinct = $value;
    }
  }

  /**
   * Set what field the query will count() on for paging.
   */
163
  public function setCountField($table, $field, $alias = NULL) {
merlinofchaos's avatar
merlinofchaos committed
164
165
166
167
168
169
170
171
172
173
174
    if (empty($alias)) {
      $alias = $table . '_' . $field;
    }
    $this->count_field = array(
      'table' => $table,
      'field' => $field,
      'alias' => $alias,
      'count' => TRUE,
    );
  }

175
176
  protected function defineOptions() {
    $options = parent::defineOptions();
merlinofchaos's avatar
merlinofchaos committed
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
    $options['disable_sql_rewrite'] = array(
      'default' => FALSE,
      'translatable' => FALSE,
      'bool' => TRUE,
    );
    $options['distinct'] = array(
      'default' => FALSE,
      'bool' => TRUE,
    );
    $options['slave'] = array(
      'default' => FALSE,
      'bool' => TRUE,
    );
    $options['query_comment'] = array(
      'default' => '',
    );
    $options['query_tags'] = array(
      'default' => array(),
    );

    return $options;
  }

  /**
   * Add settings for the ui.
   */
203
204
  public function buildOptionsForm(&$form, &$form_state) {
    parent::buildOptionsForm($form, $form_state);
merlinofchaos's avatar
merlinofchaos committed
205
206
207
208
209
210

    $form['disable_sql_rewrite'] = array(
      '#title' => t('Disable SQL rewriting'),
      '#description' => t('Disabling SQL rewriting will disable node_access checks as well as other modules that implement hook_query_alter().'),
      '#type' => 'checkbox',
      '#default_value' => !empty($this->options['disable_sql_rewrite']),
211
      '#suffix' => '<div class="messages messages--warning sql-rewrite-warning js-hide">' . t('WARNING: Disabling SQL rewriting means that node access security is disabled. This may allow users to see data they should not be able to see if your view is misconfigured. Use this option only if you understand and accept this security risk.') . '</div>',
merlinofchaos's avatar
merlinofchaos committed
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
    );
    $form['distinct'] = array(
      '#type' => 'checkbox',
      '#title' => t('Distinct'),
      '#description' => t('This will make the view display only distinct items. If there are multiple identical items, each will be displayed only once. You can use this to try and remove duplicates from a view, though it does not always work. Note that this can slow queries down, so use it with caution.'),
      '#default_value' => !empty($this->options['distinct']),
    );
    $form['slave'] = array(
      '#type' => 'checkbox',
      '#title' => t('Use Slave Server'),
      '#description' => t('This will make the query attempt to connect to a slave server if available.  If no slave server is defined or available, it will fall back to the default server.'),
      '#default_value' => !empty($this->options['slave']),
    );
    $form['query_comment'] = array(
      '#type' => 'textfield',
      '#title' => t('Query Comment'),
      '#description' => t('If set, this comment will be embedded in the query and passed to the SQL server. This can be helpful for logging or debugging.'),
      '#default_value' => $this->options['query_comment'],
    );
    $form['query_tags'] = array(
      '#type' => 'textfield',
      '#title' => t('Query Tags'),
      '#description' => t('If set, these tags will be appended to the query and can be used to identify the query in a module. This can be helpful for altering queries.'),
      '#default_value' => implode(', ', $this->options['query_tags']),
      '#element_validate' => array('views_element_validate_tags'),
    );
  }

  /**
   * Special submit handling.
   */
243
  public function submitOptionsForm(&$form, &$form_state) {
merlinofchaos's avatar
merlinofchaos committed
244
    $element = array('#parents' => array('query', 'options', 'query_tags'));
245
    $value = explode(',', NestedArray::getValue($form_state['values'], $element['#parents']));
merlinofchaos's avatar
merlinofchaos committed
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
    $value = array_filter(array_map('trim', $value));
    form_set_value($element, $value, $form_state);
  }

  /**
   * A relationship is an alternative endpoint to a series of table
   * joins. Relationships must be aliases of the primary table and
   * they must join either to the primary table or to a pre-existing
   * relationship.
   *
   * An example of a relationship would be a nodereference table.
   * If you have a nodereference named 'book_parent' which links to a
   * parent node, you could set up a relationship 'node_book_parent'
   * to 'node'. Then, anything that links to 'node' can link to
   * 'node_book_parent' instead, thus allowing all properties of
   * both nodes to be available in the query.
   *
   * @param $alias
   *   What this relationship will be called, and is also the alias
   *   for the table.
266
   * @param Drupal\views\Plugin\views\join\JoinPluginBase $join
267
   *   A Join object (or derived object) to join the alias in.
merlinofchaos's avatar
merlinofchaos committed
268
269
270
271
272
273
274
275
276
277
   * @param $base
   *   The name of the 'base' table this relationship represents; this
   *   tells the join search which path to attempt to use when finding
   *   the path to this relationship.
   * @param $link_point
   *   If this relationship links to something other than the primary
   *   table, specify that table here. For example, a 'track' node
   *   might have a relationship to an 'album' node, which might
   *   have a relationship to an 'artist' node.
   */
278
  public function addRelationship($alias, JoinPluginBase $join, $base, $link_point = NULL) {
merlinofchaos's avatar
merlinofchaos committed
279
    if (empty($link_point)) {
280
      $link_point = $this->view->storage->get('base_table');
merlinofchaos's avatar
merlinofchaos committed
281
282
283
284
285
286
287
288
289
290
291
292
293
294
    }
    elseif (!array_key_exists($link_point, $this->relationships)) {
      return FALSE;
    }

    // Make sure $alias isn't already used; if it, start adding stuff.
    $alias_base = $alias;
    $count = 1;
    while (!empty($this->relationships[$alias])) {
      $alias = $alias_base . '_' . $count++;
    }

    // Make sure this join is adjusted for our relationship.
    if ($link_point && isset($this->relationships[$link_point])) {
295
      $join = $this->adjustJoin($join, $link_point);
merlinofchaos's avatar
merlinofchaos committed
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
    }

    // Add the table directly to the queue to avoid accidentally marking
    // it.
    $this->table_queue[$alias] = array(
      'table' => $join->table,
      'num' => 1,
      'alias' => $alias,
      'join' => $join,
      'relationship' => $link_point,
    );

    $this->relationships[$alias] = array(
      'link' => $link_point,
      'table' => $join->table,
      'base' => $base,
    );

314
    $this->tables[$this->view->storage->get('base_table')][$alias] = array(
merlinofchaos's avatar
merlinofchaos committed
315
316
317
318
319
320
321
322
323
324
325
326
      'count' => 1,
      'alias' => $alias,
    );

    return $alias;
  }

  /**
   * Add a table to the query, ensuring the path exists.
   *
   * This function will test to ensure that the path back to the primary
   * table is valid and exists; if you do not wish for this testing to
327
   * occur, use $query->queueTable() instead.
merlinofchaos's avatar
merlinofchaos committed
328
329
330
331
332
333
334
335
336
337
   *
   * @param $table
   *   The name of the table to add. It needs to exist in the global table
   *   array.
   * @param $relationship
   *   An alias of a table; if this is set, the path back to this table will
   *   be tested prior to adding the table, making sure that all intermediary
   *   tables exist and are properly aliased. If set to NULL the path to
   *   the primary table will be ensured. If the path cannot be made, the
   *   table will NOT be added.
338
   * @param Drupal\views\Plugin\views\join\JoinPluginBase $join
merlinofchaos's avatar
merlinofchaos committed
339
340
341
342
343
344
345
346
347
348
349
350
351
   *   In some join configurations this table may actually join back through
   *   a different method; this is most likely to be used when tracing
   *   a hierarchy path. (node->parent->parent2->parent3). This parameter
   *   will specify how this table joins if it is not the default.
   * @param $alias
   *   A specific alias to use, rather than the default alias.
   *
   * @return $alias
   *   The alias of the table; this alias can be used to access information
   *   about the table and should always be used to refer to the table when
   *   adding parts to the query. Or FALSE if the table was not able to be
   *   added.
   */
352
  public function addTable($table, $relationship = NULL, JoinPluginBase $join = NULL, $alias = NULL) {
353
    if (!$this->ensurePath($table, $relationship, $join)) {
merlinofchaos's avatar
merlinofchaos committed
354
355
356
357
      return FALSE;
    }

    if ($join && $relationship) {
358
      $join = $this->adjustJoin($join, $relationship);
merlinofchaos's avatar
merlinofchaos committed
359
360
    }

361
    return $this->queueTable($table, $relationship, $join, $alias);
merlinofchaos's avatar
merlinofchaos committed
362
363
364
365
366
  }

  /**
   * Add a table to the query without ensuring the path.
   *
367
   * This is a pretty internal function to Views and addTable() or
368
   * ensureTable() should be used instead of this one, unless you are
merlinofchaos's avatar
merlinofchaos committed
369
370
371
372
373
374
375
376
   * absolutely sure this is what you want.
   *
   * @param $table
   *   The name of the table to add. It needs to exist in the global table
   *   array.
   * @param $relationship
   *   The primary table alias this table is related to. If not set, the
   *   primary table will be used.
377
   * @param Drupal\views\Plugin\views\join\JoinPluginBase $join
merlinofchaos's avatar
merlinofchaos committed
378
379
380
381
382
383
384
385
386
387
388
389
390
   *   In some join configurations this table may actually join back through
   *   a different method; this is most likely to be used when tracing
   *   a hierarchy path. (node->parent->parent2->parent3). This parameter
   *   will specify how this table joins if it is not the default.
   * @param $alias
   *   A specific alias to use, rather than the default alias.
   *
   * @return $alias
   *   The alias of the table; this alias can be used to access information
   *   about the table and should always be used to refer to the table when
   *   adding parts to the query. Or FALSE if the table was not able to be
   *   added.
   */
391
  public function queueTable($table, $relationship = NULL, JoinPluginBase $join = NULL, $alias = NULL) {
merlinofchaos's avatar
merlinofchaos committed
392
393
394
395
396
397
    // If the alias is set, make sure it doesn't already exist.
    if (isset($this->table_queue[$alias])) {
      return $alias;
    }

    if (empty($relationship)) {
398
      $relationship = $this->view->storage->get('base_table');
merlinofchaos's avatar
merlinofchaos committed
399
400
401
402
403
404
405
    }

    if (!array_key_exists($relationship, $this->relationships)) {
      return FALSE;
    }

    if (!$alias && $join && $relationship && !empty($join->adjusted) && $table != $join->table) {
406
      if ($relationship == $this->view->storage->get('base_table')) {
merlinofchaos's avatar
merlinofchaos committed
407
408
409
410
411
412
413
414
415
416
417
418
419
        $alias = $table;
      }
      else {
        $alias = $relationship . '_' . $table;
      }
    }

    // Check this again to make sure we don't blow up existing aliases for already
    // adjusted joins.
    if (isset($this->table_queue[$alias])) {
      return $alias;
    }

420
    $alias = $this->markTable($table, $relationship, $alias);
merlinofchaos's avatar
merlinofchaos committed
421
422
423
424
425
426
427
428
429

    // If no alias is specified, give it the default.
    if (!isset($alias)) {
      $alias = $this->tables[$relationship][$table]['alias'] . $this->tables[$relationship][$table]['count'];
    }

    // If this is a relationship based table, add a marker with
    // the relationship as a primary table for the alias.
    if ($table != $alias) {
430
      $this->markTable($alias, $this->view->storage->get('base_table'), $alias);
merlinofchaos's avatar
merlinofchaos committed
431
432
433
434
    }

    // If no join is specified, pull it from the table data.
    if (!isset($join)) {
435
      $join = $this->getJoinData($table, $this->relationships[$relationship]['base']);
merlinofchaos's avatar
merlinofchaos committed
436
437
438
439
      if (empty($join)) {
        return FALSE;
      }

440
      $join = $this->adjustJoin($join, $relationship);
merlinofchaos's avatar
merlinofchaos committed
441
442
443
444
445
446
447
448
449
450
451
452
453
    }

    $this->table_queue[$alias] = array(
      'table' => $table,
      'num' => $this->tables[$relationship][$table]['count'],
      'alias' => $alias,
      'join' => $join,
      'relationship' => $relationship,
    );

    return $alias;
  }

454
  protected function markTable($table, $relationship, $alias) {
merlinofchaos's avatar
merlinofchaos committed
455
456
457
458
    // Mark that this table has been added.
    if (empty($this->tables[$relationship][$table])) {
      if (!isset($alias)) {
        $alias = '';
459
        if ($relationship != $this->view->storage->get('base_table')) {
merlinofchaos's avatar
merlinofchaos committed
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
          // double underscore will help prevent accidental name
          // space collisions.
          $alias = $relationship . '__';
        }
        $alias .= $table;
      }
      $this->tables[$relationship][$table] = array(
        'count' => 1,
        'alias' => $alias,
      );
    }
    else {
      $this->tables[$relationship][$table]['count']++;
    }

    return $alias;
  }

  /**
   * Ensure a table exists in the queue; if it already exists it won't
   * do anything, but if it doesn't it will add the table queue. It will ensure
   * a path leads back to the relationship table.
   *
   * @param $table
   *   The unaliased name of the table to ensure.
   * @param $relationship
   *   The relationship to ensure the table links to. Each relationship will
   *   get a unique instance of the table being added. If not specified,
   *   will be the primary table.
489
   * @param Drupal\views\Plugin\views\join\JoinPluginBase $join
490
   *   A Join object (or derived object) to join the alias in.
merlinofchaos's avatar
merlinofchaos committed
491
492
493
494
495
   *
   * @return
   *   The alias used to refer to this specific table, or NULL if the table
   *   cannot be ensured.
   */
496
  public function ensureTable($table, $relationship = NULL, JoinPluginBase $join = NULL) {
merlinofchaos's avatar
merlinofchaos committed
497
498
    // ensure a relationship
    if (empty($relationship)) {
499
      $relationship = $this->view->storage->get('base_table');
merlinofchaos's avatar
merlinofchaos committed
500
501
502
503
504
505
    }

    // If the relationship is the primary table, this actually be a relationship
    // link back from an alias. We store all aliases along with the primary table
    // to detect this state, because eventually it'll hit a table we already
    // have and that's when we want to stop.
506
    if ($relationship == $this->view->storage->get('base_table') && !empty($this->tables[$relationship][$table])) {
merlinofchaos's avatar
merlinofchaos committed
507
508
509
510
511
512
513
514
515
516
517
518
519
      return $this->tables[$relationship][$table]['alias'];
    }

    if (!array_key_exists($relationship, $this->relationships)) {
      return FALSE;
    }

    if ($table == $this->relationships[$relationship]['base']) {
      return $relationship;
    }

    // If we do not have join info, fetch it.
    if (!isset($join)) {
520
      $join = $this->getJoinData($table, $this->relationships[$relationship]['base']);
merlinofchaos's avatar
merlinofchaos committed
521
522
523
524
525
526
527
528
529
530
    }

    // If it can't be fetched, this won't work.
    if (empty($join)) {
      return;
    }

    // Adjust this join for the relationship, which will ensure that the 'base'
    // table it links to is correct. Tables adjoined to a relationship
    // join to a link point, not the base table.
531
    $join = $this->adjustJoin($join, $relationship);
merlinofchaos's avatar
merlinofchaos committed
532

533
    if ($this->ensurePath($table, $relationship, $join)) {
merlinofchaos's avatar
merlinofchaos committed
534
535
536
537
538
539
540
      // Attempt to eliminate redundant joins.  If this table's
      // relationship and join exactly matches an existing table's
      // relationship and join, we do not have to join to it again;
      // just return the existing table's alias.  See
      // http://groups.drupal.org/node/11288 for details.
      //
      // This can be done safely here but not lower down in
541
      // queueTable(), because queueTable() is also used by
542
      // addTable() which requires the ability to intentionally add
merlinofchaos's avatar
merlinofchaos committed
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
      // the same table with the same join multiple times.  For
      // example, a view that filters on 3 taxonomy terms using AND
      // needs to join taxonomy_term_data 3 times with the same join.

      // scan through the table queue to see if a matching join and
      // relationship exists.  If so, use it instead of this join.

      // TODO: Scanning through $this->table_queue results in an
      // O(N^2) algorithm, and this code runs every time the view is
      // instantiated (Views 2 does not currently cache queries).
      // There are a couple possible "improvements" but we should do
      // some performance testing before picking one.
      foreach ($this->table_queue as $queued_table) {
        // In PHP 4 and 5, the == operation returns TRUE for two objects
        // if they are instances of the same class and have the same
        // attributes and values.
        if ($queued_table['relationship'] == $relationship && $queued_table['join'] == $join) {
          return $queued_table['alias'];
        }
      }

564
      return $this->queueTable($table, $relationship, $join);
merlinofchaos's avatar
merlinofchaos committed
565
566
567
568
569
570
571
572
573
574
    }
  }

  /**
   * Make sure that the specified table can be properly linked to the primary
   * table in the JOINs. This function uses recursion. If the tables
   * needed to complete the path back to the primary table are not in the
   * query they will be added, but additional copies will NOT be added
   * if the table is already there.
   */
575
  protected function ensurePath($table, $relationship = NULL, $join = NULL, $traced = array(), $add = array()) {
merlinofchaos's avatar
merlinofchaos committed
576
    if (!isset($relationship)) {
577
      $relationship = $this->view->storage->get('base_table');
merlinofchaos's avatar
merlinofchaos committed
578
579
580
581
582
583
584
585
    }

    if (!array_key_exists($relationship, $this->relationships)) {
      return FALSE;
    }

    // If we do not have join info, fetch it.
    if (!isset($join)) {
586
      $join = $this->getJoinData($table, $this->relationships[$relationship]['base']);
merlinofchaos's avatar
merlinofchaos committed
587
588
589
590
591
592
593
594
595
    }

    // If it can't be fetched, this won't work.
    if (empty($join)) {
      return FALSE;
    }

    // Does a table along this path exist?
    if (isset($this->tables[$relationship][$table]) ||
596
597
      ($join && $join->leftTable == $relationship) ||
      ($join && $join->leftTable == $this->relationships[$relationship]['table'])) {
merlinofchaos's avatar
merlinofchaos committed
598
599
600

      // Make sure that we're linking to the correct table for our relationship.
      foreach (array_reverse($add) as $table => $path_join) {
601
        $this->queueTable($table, $relationship, $this->adjustJoin($path_join, $relationship));
merlinofchaos's avatar
merlinofchaos committed
602
603
604
605
606
      }
      return TRUE;
    }

    // Have we been this way?
607
    if (isset($traced[$join->leftTable])) {
merlinofchaos's avatar
merlinofchaos committed
608
609
610
611
612
      // we looped. Broked.
      return FALSE;
    }

    // Do we have to add this table?
613
    $left_join = $this->getJoinData($join->leftTable, $this->relationships[$relationship]['base']);
614
615
    if (!isset($this->tables[$relationship][$join->leftTable])) {
      $add[$join->leftTable] = $left_join;
merlinofchaos's avatar
merlinofchaos committed
616
617
618
    }

    // Keep looking.
619
    $traced[$join->leftTable] = TRUE;
620
    return $this->ensurePath($join->leftTable, $relationship, $left_join, $traced, $add);
merlinofchaos's avatar
merlinofchaos committed
621
622
623
624
625
626
  }

  /**
   * Fix a join to adhere to the proper relationship; the left table can vary
   * based upon what relationship items are joined in on.
   */
627
  protected function adjustJoin($join, $relationship) {
merlinofchaos's avatar
merlinofchaos committed
628
629
630
631
632
633
634
635
636
    if (!empty($join->adjusted)) {
      return $join;
    }

    if (empty($relationship) || empty($this->relationships[$relationship])) {
      return $join;
    }

    // Adjusts the left table for our relationship.
637
    if ($relationship != $this->view->storage->get('base_table')) {
merlinofchaos's avatar
merlinofchaos committed
638
639
640
641
642
643
644
      // If we're linking to the primary table, the relationship to use will
      // be the prior relationship. Unless it's a direct link.

      // Safety! Don't modify an original here.
      $join = clone $join;

      // Do we need to try to ensure a path?
645
646
647
      if ($join->leftTable != $this->relationships[$relationship]['table'] &&
        $join->leftTable != $this->relationships[$relationship]['base'] &&
        !isset($this->tables[$relationship][$join->leftTable]['alias'])) {
648
        $this->ensureTable($join->leftTable, $relationship);
merlinofchaos's avatar
merlinofchaos committed
649
650
651
      }

      // First, if this is our link point/anchor table, just use the relationship
652
653
      if ($join->leftTable == $this->relationships[$relationship]['table']) {
        $join->leftTable = $relationship;
merlinofchaos's avatar
merlinofchaos committed
654
655
      }
      // then, try the base alias.
656
657
      elseif (isset($this->tables[$relationship][$join->leftTable]['alias'])) {
        $join->leftTable = $this->tables[$relationship][$join->leftTable]['alias'];
merlinofchaos's avatar
merlinofchaos committed
658
659
660
      }
      // But if we're already looking at an alias, use that instead.
      elseif (isset($this->table_queue[$relationship]['alias'])) {
661
        $join->leftTable = $this->table_queue[$relationship]['alias'];
merlinofchaos's avatar
merlinofchaos committed
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
      }
    }

    $join->adjusted = TRUE;
    return $join;
  }

  /**
   * Retrieve join data from the larger join data cache.
   *
   * @param $table
   *   The table to get the join information for.
   * @param $base_table
   *   The path we're following to get this join.
   *
677
   * @return Drupal\views\Plugin\views\join\JoinPluginBase
678
   *   A Join object or child object, if one exists.
merlinofchaos's avatar
merlinofchaos committed
679
   */
680
  public function getJoinData($table, $base_table) {
merlinofchaos's avatar
merlinofchaos committed
681
682
683
684
685
    // Check to see if we're linking to a known alias. If so, get the real
    // table's data instead.
    if (!empty($this->table_queue[$table])) {
      $table = $this->table_queue[$table]['table'];
    }
686
    return HandlerBase::getTableJoin($table, $base_table);
merlinofchaos's avatar
merlinofchaos committed
687
688
689
690
691
692
  }

  /**
   * Get the information associated with a table.
   *
   * If you need the alias of a table with a particular relationship, use
693
   * ensureTable().
merlinofchaos's avatar
merlinofchaos committed
694
   */
695
  public function getTableInfo($table) {
merlinofchaos's avatar
merlinofchaos committed
696
697
698
699
700
    if (!empty($this->table_queue[$table])) {
      return $this->table_queue[$table];
    }

    // In rare cases we might *only* have aliased versions of the table.
701
702
    if (!empty($this->tables[$this->view->storage->get('base_table')][$table])) {
      $alias = $this->tables[$this->view->storage->get('base_table')][$table]['alias'];
merlinofchaos's avatar
merlinofchaos committed
703
704
705
706
707
708
709
710
      if (!empty($this->table_queue[$alias])) {
        return $this->table_queue[$alias];
      }
    }
  }

  /**
   * Add a field to the query table, possibly with an alias. This will
711
   * automatically call ensureTable to make sure the required table
merlinofchaos's avatar
merlinofchaos committed
712
713
714
715
   * exists, *unless* $table is unset.
   *
   * @param $table
   *   The table this field is attached to. If NULL, it is assumed this will
716
   *   be a formula; otherwise, ensureTable is used to make sure the
merlinofchaos's avatar
merlinofchaos committed
717
718
719
720
721
722
723
724
725
726
727
728
729
730
   *   table exists.
   * @param $field
   *   The name of the field to add. This may be a real field or a formula.
   * @param $alias
   *   The alias to create. If not specified, the alias will be $table_$field
   *   unless $table is NULL. When adding formulae, it is recommended that an
   *   alias be used.
   * @param $params
   *   An array of parameters additional to the field that will control items
   *   such as aggregation functions and DISTINCT.
   *
   * @return $name
   *   The name that this field can be referred to as. Usually this is the alias.
   */
731
  public function addField($table, $field, $alias = '', $params = array()) {
merlinofchaos's avatar
merlinofchaos committed
732
    // We check for this specifically because it gets a special alias.
733
734
    if ($table == $this->view->storage->get('base_table') && $field == $this->view->storage->get('base_field') && empty($alias)) {
      $alias = $this->view->storage->get('base_field');
merlinofchaos's avatar
merlinofchaos committed
735
736
737
    }

    if ($table && empty($this->table_queue[$table])) {
738
      $this->ensureTable($table);
merlinofchaos's avatar
merlinofchaos committed
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
    }

    if (!$alias && $table) {
      $alias = $table . '_' . $field;
    }

    // Make sure an alias is assigned
    $alias = $alias ? $alias : $field;

    // PostgreSQL truncates aliases to 63 characters: http://drupal.org/node/571548

    // We limit the length of the original alias up to 60 characters
    // to get a unique alias later if its have duplicates
    $alias = strtolower(substr($alias, 0, 60));

    // Create a field info array.
    $field_info = array(
      'field' => $field,
      'table' => $table,
      'alias' => $alias,
    ) + $params;

    // Test to see if the field is actually the same or not. Due to
    // differing parameters changing the aggregation function, we need
    // to do some automatic alias collision detection:
    $base = $alias;
    $counter = 0;
    while (!empty($this->fields[$alias]) && $this->fields[$alias] != $field_info) {
      $field_info['alias'] = $alias = $base . '_' . ++$counter;
    }

    if (empty($this->fields[$alias])) {
      $this->fields[$alias] = $field_info;
    }

    // Keep track of all aliases used.
    $this->field_aliases[$table][$field] = $alias;

    return $alias;
  }

  /**
   * Remove all fields that may've been added; primarily used for summary
   * mode where we're changing the query because we didn't get data we needed.
   */
784
  public function clearFields() {
merlinofchaos's avatar
merlinofchaos committed
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
    $this->fields = array();
  }

  /**
   * Add a simple WHERE clause to the query. The caller is responsible for
   * ensuring that all fields are fully qualified (TABLE.FIELD) and that
   * the table already exists in the query.
   *
   * @param $group
   *   The WHERE group to add these to; groups are used to create AND/OR
   *   sections. Groups cannot be nested. Use 0 as the default group.
   *   If the group does not yet exist it will be created as an AND group.
   * @param $field
   *   The name of the field to check.
   * @param $value
   *   The value to test the field against. In most cases, this is a scalar. For more
   *   complex options, it is an array. The meaning of each element in the array is
   *   dependent on the $operator.
   * @param $operator
   *   The comparison operator, such as =, <, or >=. It also accepts more complex
   *   options such as IN, LIKE, or BETWEEN. Defaults to IN if $value is an array
   *   = otherwise. If $field is a string you have to use 'formula' here.
   *
808
809
810
   * The $field, $value and $operator arguments can also be passed in with a
   * single DatabaseCondition object, like this:
   * @code
811
   *   $this->query->addWhere(
812
813
814
815
816
817
818
819
820
   *     $this->options['group'],
   *     db_or()
   *       ->condition($field, $value, 'NOT IN')
   *       ->condition($field, $value, 'IS NULL')
   *   );
   * @endcode
   *
   * @see Drupal\Core\Database\Query\ConditionInterface::condition()
   * @see Drupal\Core\Database\Query\Condition
merlinofchaos's avatar
merlinofchaos committed
821
   */
822
  public function addWhere($group, $field, $value = NULL, $operator = NULL) {
merlinofchaos's avatar
merlinofchaos committed
823
824
825
826
827
828
829
830
    // Ensure all variants of 0 are actually 0. Thus '', 0 and NULL are all
    // the default group.
    if (empty($group)) {
      $group = 0;
    }

    // Check for a group.
    if (!isset($this->where[$group])) {
831
      $this->setWhereGroup('AND', $group);
merlinofchaos's avatar
merlinofchaos committed
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
    }

    $this->where[$group]['conditions'][] = array(
      'field' => $field,
      'value' => $value,
      'operator' => $operator,
    );
  }

  /**
   * Add a complex WHERE clause to the query.
   *
   * The caller is reponsible for ensuring that all fields are fully qualified
   * (TABLE.FIELD) and that the table already exists in the query.
   * Internally the dbtng method "where" is used.
   *
   * @param $group
   *   The WHERE group to add these to; groups are used to create AND/OR
   *   sections. Groups cannot be nested. Use 0 as the default group.
   *   If the group does not yet exist it will be created as an AND group.
   * @param $snippet
   *   The snippet to check. This can be either a column or
   *   a complex expression like "UPPER(table.field) = 'value'"
   * @param $args
   *   An associative array of arguments.
   *
   * @see QueryConditionInterface::where()
   */
860
  public function addWhereExpression($group, $snippet, $args = array()) {
merlinofchaos's avatar
merlinofchaos committed
861
862
863
864
865
866
867
868
    // Ensure all variants of 0 are actually 0. Thus '', 0 and NULL are all
    // the default group.
    if (empty($group)) {
      $group = 0;
    }

    // Check for a group.
    if (!isset($this->where[$group])) {
869
      $this->setWhereGroup('AND', $group);
merlinofchaos's avatar
merlinofchaos committed
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
    }

    $this->where[$group]['conditions'][] = array(
      'field' => $snippet,
      'value' => $args,
      'operator' => 'formula',
    );
  }

  /**
   * Add a complex HAVING clause to the query.
   * The caller is responsible for ensuring that all fields are fully qualified
   * (TABLE.FIELD) and that the table and an appropriate GROUP BY already exist in the query.
   * Internally the dbtng method "having" is used.
   *
   * @param $group
   *   The HAVING group to add these to; groups are used to create AND/OR
   *   sections. Groups cannot be nested. Use 0 as the default group.
   *   If the group does not yet exist it will be created as an AND group.
   * @param $snippet
   *   The snippet to check. This can be either a column or
   *   a complex expression like "COUNT(table.field) > 3"
   * @param $args
   *   An associative array of arguments.
   *
   * @see QueryConditionInterface::having()
   */
897
  public function addHavingExpression($group, $snippet, $args = array()) {
merlinofchaos's avatar
merlinofchaos committed
898
899
900
901
902
903
904
905
    // Ensure all variants of 0 are actually 0. Thus '', 0 and NULL are all
    // the default group.
    if (empty($group)) {
      $group = 0;
    }

    // Check for a group.
    if (!isset($this->having[$group])) {
906
      $this->setWhereGroup('AND', $group, 'having');
merlinofchaos's avatar
merlinofchaos committed
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
    }

    // Add the clause and the args.
    $this->having[$group]['conditions'][] = array(
      'field' => $snippet,
      'value' => $args,
      'operator' => 'formula',
    );
  }

  /**
   * Add an ORDER BY clause to the query.
   *
   * @param $table
   *   The table this field is part of. If a formula, enter NULL.
   *   If you want to orderby random use "rand" as table and nothing else.
   * @param $field
   *   The field or formula to sort on. If already a field, enter NULL
   *   and put in the alias.
   * @param $order
   *   Either ASC or DESC.
   * @param $alias
   *   The alias to add the field as. In SQL, all fields in the order by
   *   must also be in the SELECT portion. If an $alias isn't specified
   *   one will be generated for from the $field; however, if the
   *   $field is a formula, this alias will likely fail.
   * @param $params
934
   *   Any params that should be passed through to the addField.
merlinofchaos's avatar
merlinofchaos committed
935
   */
936
  public function addOrderBy($table, $field = NULL, $order = 'ASC', $alias = '', $params = array()) {
merlinofchaos's avatar
merlinofchaos committed
937
    // Only ensure the table if it's not the special random key.
938
    // @todo: Maybe it would make sense to just add an addOrderByRand or something similar.
merlinofchaos's avatar
merlinofchaos committed
939
    if ($table && $table != 'rand') {
940
      $this->ensureTable($table);
merlinofchaos's avatar
merlinofchaos committed
941
942
943
944
945
946
947
948
949
950
951
952
    }

    // Only fill out this aliasing if there is a table;
    // otherwise we assume it is a formula.
    if (!$alias && $table) {
      $as = $table . '_' . $field;
    }
    else {
      $as = $alias;
    }

    if ($field) {
953
      $as = $this->addField($table, $field, $as, $params);
merlinofchaos's avatar
merlinofchaos committed
954
955
956
957
958
959
960
961
962
963
964
965
966
    }

    $this->orderby[] = array(
      'field' => $as,
      'direction' => strtoupper($order)
    );
  }

  /**
   * Add a simple GROUP BY clause to the query. The caller is responsible
   * for ensuring that the fields are fully qualified and the table is properly
   * added.
   */
967
  public function addGroupBy($clause) {
merlinofchaos's avatar
merlinofchaos committed
968
969
970
971
972
973
974
975
976
    // Only add it if it's not already in there.
    if (!in_array($clause, $this->groupby)) {
      $this->groupby[] = $clause;
    }
  }

  /**
   * Returns the alias for the given field added to $table.
   *
977
978
   * @access protected
   *
979
   * @see \Drupal\views\Plugin\views\query\Sql::addField
merlinofchaos's avatar
merlinofchaos committed
980
   */
981
  protected function getFieldAlias($table_alias, $field) {
merlinofchaos's avatar
merlinofchaos committed
982
983
984
985
986
987
988
989
    return isset($this->field_aliases[$table_alias][$field]) ? $this->field_aliases[$table_alias][$field] : FALSE;
  }

  /**
   * Adds a query tag to the sql object.
   *
   * @see SelectQuery::addTag()
   */
990
  public function addTag($tag) {
merlinofchaos's avatar
merlinofchaos committed
991
992
993
994
995
996
997
998
999
1000
    $this->tags[] = $tag;
  }

  /**
   * Generates a unique placeholder used in the db query.
   */
  function placeholder($base = 'views') {
    static $placeholders = array();
    if (!isset($placeholders[$base])) {
      $placeholders[$base] = 0;