Completed
Push — yii2-stable ( 27a08d...bdff50 )
by Edgard
12:44
created

QueryBuilder::renameTable()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 2
CRAP Score 1

Importance

Changes 2
Bugs 0 Features 0
Metric Value
c 2
b 0
f 0
dl 0
loc 4
ccs 2
cts 2
cp 1
rs 10
cc 1
eloc 2
nc 1
nop 2
crap 1
1
<?php
2
3
/**
4
 * @link http://www.yiiframework.com/
5
 * @copyright Copyright (c) 2008 Yii Software LLC
6
 * @license http://www.yiiframework.com/license/
7
 */
8
9
namespace edgardmessias\db\firebird;
10
11
use yii\base\InvalidParamException;
12
use yii\db\Expression;
13
use yii\db\Query;
14
15
/**
16
 *
17
 * @author Edgard Lorraine Messias <[email protected]>
18
 * @since 2.0
19
 */
20
class QueryBuilder extends \yii\db\QueryBuilder
21
{
22
23
    /**
24
     * @var array mapping from abstract column types (keys) to physical column types (values).
25
     */
26
    public $typeMap = [
27
        Schema::TYPE_PK        => 'integer NOT NULL PRIMARY KEY',
28
        Schema::TYPE_UPK       => 'integer NOT NULL PRIMARY KEY',
29
        Schema::TYPE_BIGPK     => 'bigint NOT NULL PRIMARY KEY',
30
        Schema::TYPE_UBIGPK    => 'bigint NOT NULL PRIMARY KEY',
31
        Schema::TYPE_CHAR      => 'char(1)',
32
        Schema::TYPE_STRING    => 'varchar(255)',
33
        Schema::TYPE_TEXT      => 'blob sub_type text',
34
        Schema::TYPE_SMALLINT  => 'smallint',
35
        Schema::TYPE_INTEGER   => 'integer',
36
        Schema::TYPE_BIGINT    => 'bigint',
37
        Schema::TYPE_FLOAT     => 'float',
38
        Schema::TYPE_DOUBLE    => 'double precision',
39
        Schema::TYPE_DECIMAL   => 'numeric(10,0)',
40
        Schema::TYPE_DATETIME  => 'timestamp',
41
        Schema::TYPE_TIMESTAMP => 'timestamp',
42
        Schema::TYPE_TIME      => 'time',
43
        Schema::TYPE_DATE      => 'date',
44
        Schema::TYPE_BINARY    => 'blob',
45
        Schema::TYPE_BOOLEAN   => 'smallint',
46
        Schema::TYPE_MONEY     => 'numeric(18,4)',
47
    ];
48
49
    /**
50
     * Generates a SELECT SQL statement from a [[Query]] object.
51
     * @param Query $query the [[Query]] object from which the SQL statement will be generated.
52
     * @param array $params the parameters to be bound to the generated SQL statement. These parameters will
53
     * be included in the result with the additional parameters generated during the query building process.
54
     * @return array the generated SQL statement (the first array element) and the corresponding
55
     * parameters to be bound to the SQL statement (the second array element). The parameters returned
56
     * include those provided in `$params`.
57
     */
58 175
    public function build($query, $params = [])
59
    {
60 175
        $query = $query->prepare($this);
61
62 175
        $params = empty($params) ? $query->params : array_merge($params, $query->params);
63
64
        $clauses = [
65 175
            $this->buildSelect($query->select, $params, $query->distinct, $query->selectOption),
66 175
            $this->buildFrom($query->from, $params),
67 175
            $this->buildJoin($query->join, $params),
68 175
            $this->buildWhere($query->where, $params),
69 175
            $this->buildGroupBy($query->groupBy),
70 175
            $this->buildHaving($query->having, $params),
71 175
        ];
72
73 175
        $sql = implode($this->separator, array_filter($clauses));
74 175
        $sql = $this->buildOrderByAndLimit($sql, $query->orderBy, $query->limit, $query->offset);
75
76 175
        if (!empty($query->orderBy)) {
77 32
            foreach ($query->orderBy as $expression) {
78 32
                if ($expression instanceof Expression) {
79 1
                    $params = array_merge($params, $expression->params);
80 1
                }
81 32
            }
82 32
        }
83 175
        if (!empty($query->groupBy)) {
84 2
            foreach ($query->groupBy as $expression) {
85 2
                if ($expression instanceof Expression) {
86 1
                    $params = array_merge($params, $expression->params);
87 1
                }
88 2
            }
89 2
        }
90
91 175
        $union = $this->buildUnion($query->union, $params);
92 175
        if ($union !== '') {
93 2
            $sql = "$sql{$this->separator}$union";
94 2
        }
95
96 175
        return [$sql, $params];
97
    }
98
99
    /**
100
     * @inheritdoc
101
     */
102 175
    public function buildSelect($columns, &$params, $distinct = false, $selectOption = null)
103
    {
104 175
        if (is_array($columns)) {
105 48
            foreach ($columns as $i => $column) {
106 48
                if (!is_string($column)) {
107 3
                    continue;
108
                }
109 47
                $matches = [];
110 47
                if (preg_match("/^(COUNT|SUM|AVG|MIN|MAX)\([\{\[]{0,2}(\w+|\*)[\}\]]{0,2}\)$/i", $column, $matches)) {
111 17
                    $function = $matches[1];
112 17
                    $alias = $matches[2] != '*' ? $matches[2] : 'ALL';
113
114 17
                    $columns[$i] = "{$column} AS {$function}_{$alias}";
115 17
                }
116 48
            }
117 48
        }
118
119 175
        return parent::buildSelect($columns, $params, $distinct, $selectOption);
120
    }
121
122
    /**
123
     * @inheritdoc
124
     */
125 5
    protected function buildCompositeInCondition($operator, $columns, $values, &$params)
126
    {
127 5
        $quotedColumns = [];
128 5
        foreach ($columns as $i => $column) {
129 5
            $quotedColumns[$i] = strpos($column, '(') === false ? $this->db->quoteColumnName($column) : $column;
130 5
        }
131 5
        $vss = [];
132 5
        foreach ($values as $value) {
133 5
            $vs = [];
134 5
            foreach ($columns as $i => $column) {
135 5
                if (isset($value[$column])) {
136 5
                    $phName = self::PARAM_PREFIX . count($params);
137 5
                    $params[$phName] = $value[$column];
138 5
                    $vs[] = $quotedColumns[$i] . ($operator === 'IN' ? ' = ' : ' != ') . $phName;
139 5
                } else {
140
                    $vs[] = $quotedColumns[$i] . ($operator === 'IN' ? ' IS' : ' IS NOT') . ' NULL';
141
                }
142 5
            }
143 5
            $vss[] = '(' . implode($operator === 'IN' ? ' AND ' : ' OR ', $vs) . ')';
144 5
        }
145 5
        return '(' . implode($operator === 'IN' ? ' OR ' : ' AND ', $vss) . ')';
146
    }
147
148
    /**
149
     * @inheritdoc
150
     */
151 175
    public function buildOrderByAndLimit($sql, $orderBy, $limit, $offset)
152
    {
153
154 175
        $orderBy = $this->buildOrderBy($orderBy);
155 175
        if ($orderBy !== '') {
156 32
            $sql .= $this->separator . $orderBy;
157 32
        }
158
159 175
        $limit = $limit !== null ? intval($limit) : -1;
160 175
        $offset = $offset !== null ? intval($offset) : -1;
161
        // If ignoring both params then do nothing
162 175
        if ($offset < 0 && $limit < 0) {
163 174
            return $sql;
164
        }
165
        // If we are ignoring limit then return full result set starting
166
        // from $offset. In Firebird this can only be done with SKIP
167 3
        if ($offset >= 0 && $limit < 0) {
168 2
            $count = 1; //Only do it once
169 2
            $sql = preg_replace('/^SELECT /i', 'SELECT SKIP ' . (int) $offset . ' ', $sql, $count);
170 2
            return $sql;
171
        }
172
        // If we are ignoring $offset then return $limit rows.
173
        // ie, return the first $limit rows in the set.
174 2
        if ($offset < 0 && $limit >= 0) {
175 2
            $count = 1; //Only do it once
176 2
            $sql = preg_replace('/^SELECT /i', 'SELECT FIRST ' . (int) $limit . ' ', $sql, $count);
177 2
            return $sql;
178
        }
179
        // Otherwise apply the params and return the amended sql.
180 1
        if ($offset >= 0 && $limit >= 0) {
181 1
            $count = 1; //Only do it once
182 1
            $sql = preg_replace('/^SELECT /i', 'SELECT FIRST ' . (int) $limit . ' SKIP ' . (int) $offset, $sql, $count);
183 1
            return $sql;
184
        }
185
        // If we have fallen through the cracks then just pass
186
        // the sql back.
187
        return $sql;
188
    }
189
190
    /**
191
     * @param array $unions
192
     * @param array $params the binding parameters to be populated
193
     * @return string the UNION clause built from [[Query::$union]].
194
     */
195 175
    public function buildUnion($unions, &$params)
196
    {
197 175
        if (empty($unions)) {
198 175
            return '';
199
        }
200
201 2
        $result = '';
202
203 2
        foreach ($unions as $i => $union) {
204 2
            $query = $union['query'];
205 2
            if ($query instanceof Query) {
206 2
                list($unions[$i]['query'], $params) = $this->build($query, $params);
207 2
            }
208
209 2
            $result .= 'UNION ' . ($union['all'] ? 'ALL ' : '') . $unions[$i]['query'] . ' ';
210 2
        }
211
212 2
        return trim($result);
213
    }
214
215
    /**
216
     *
217
     * @param Expression $value
218
     * @return Expression
219
     */
220 3
    protected function convertExpression($value)
221
    {
222 3
        if (!($value instanceof Expression)) {
223
            return $value;
224
        }
225
        
226
        $expressionMap = [
227
            "strftime('%Y')" => "EXTRACT(YEAR FROM TIMESTAMP 'now')"
228 3
        ];
229
        
230 3
        if (isset($expressionMap[$value->expression])) {
231
            return new Expression($expressionMap[$value->expression]);
232
        }
233 3
        return $value;
234
    }
235
236
    /**
237
     * @inheritdoc
238
     */
239 22
    public function insert($table, $columns, &$params)
240
    {
241 22
        $schema = $this->db->getSchema();
242 22
        if (($tableSchema = $schema->getTableSchema($table)) !== null) {
243 22
            $columnSchemas = $tableSchema->columns;
244 22
        } else {
245
            $columnSchemas = [];
246
        }
247
248 22
        foreach ($columns as $name => $value) {
249 21
            if ($value instanceof Expression) {
250 1
                $columns[$name] = $this->convertExpression($value);
251 21
            } elseif (isset($columnSchemas[$name]) && in_array($columnSchemas[$name]->type, [Schema::TYPE_TEXT, Schema::TYPE_BINARY])) {
252
                $columns[$name] = [$value, 'blob'];
253
            }
254 22
        }
255
256 22
        return parent::insert($table, $columns, $params);
257
    }
258
259
    /**
260
     * @inheritdoc
261
     */
262 13
    public function update($table, $columns, $condition, &$params)
263
    {
264 13
        $schema = $this->db->getSchema();
265 13
        if (($tableSchema = $schema->getTableSchema($table)) !== null) {
266 13
            $columnSchemas = $tableSchema->columns;
267 13
        } else {
268
            $columnSchemas = [];
269
        }
270 13
        foreach ($columns as $name => $value) {
271 13
            if ($value instanceof Expression) {
272 2
                $columns[$name] = $this->convertExpression($value);
273 13
            } elseif (isset($columnSchemas[$name]) && in_array($columnSchemas[$name]->type, [Schema::TYPE_TEXT, Schema::TYPE_BINARY])) {
274
                $columns[$name] = [$value, 'blob'];
275
            }
276 13
        }
277 13
        return parent::update($table, $columns, $condition, $params);
278
    }
279
280
    /**
281
     * @inheritdoc
282
     */
283
    public function batchInsert($table, $columns, $rows)
284
    {
285
        if (empty($rows)) {
286
            return '';
287
        }
288
289
        $schema = $this->db->getSchema();
290
        if (($tableSchema = $schema->getTableSchema($table)) !== null) {
291
            $columnSchemas = $tableSchema->columns;
292
        } else {
293
            $columnSchemas = [];
294
        }
295
296
        $values = [];
297
        foreach ($rows as $row) {
298
            $vs = [];
299
            foreach ($row as $i => $value) {
300
                if (isset($columns[$i], $columnSchemas[$columns[$i]]) && !is_array($value)) {
301
                    $value = $columnSchemas[$columns[$i]]->dbTypecast($value);
302
                }
303
                if (is_string($value)) {
304
                    $value = $schema->quoteValue($value);
305
                } elseif ($value === false) {
306
                    $value = 0;
307
                } elseif ($value === null) {
308
                    $value = 'NULL';
309
                }
310
                $vs[] = $value;
311
            }
312
            $values[] = 'INSERT INTO ' . $schema->quoteTableName($table)
313
                    . ' (' . implode(', ', $columns) . ') VALUES (' . implode(', ', $vs) . ');';
314
        }
315
316
        foreach ($columns as $i => $name) {
317
            $columns[$i] = $schema->quoteColumnName($name);
318
        }
319
320
        return 'EXECUTE block AS BEGIN ' . implode(' ', $values) . ' END;';
321
    }
322
    
323
    /**
324
     * @inheritdoc
325
     */
326 1
    public function renameTable($oldName, $newName)
327
    {
328 1
        throw new \yii\base\NotSupportedException($this->db->getDriverName() . ' does not support rename table.');
329
    }
330
    
331
    /**
332
     * @inheritdoc
333
     */
334 2
    public function truncateTable($table)
335
    {
336 2
        return "DELETE FROM " . $this->db->quoteTableName($table);
337
    }
338
    
339
    /**
340
     * @inheritdoc
341
     */
342 1
    public function dropColumn($table, $column)
343
    {
344 1
        return "ALTER TABLE " . $this->db->quoteTableName($table)
345 1
            . " DROP " . $this->db->quoteColumnName($column);
346
    }
347
    
348
    /**
349
     * @inheritdoc
350
     */
351 1
    public function renameColumn($table, $oldName, $newName)
352
    {
353 1
        return "ALTER TABLE " . $this->db->quoteTableName($table)
354 1
            . " ALTER " . $this->db->quoteColumnName($oldName)
355 1
            . " TO " . $this->db->quoteColumnName($newName);
356
    }
357
    
358
    /**
359
     * @inheritdoc
360
     */
361 3
    public function alterColumn($table, $column, $type)
362
    {
363 3
        $schema = $this->db->getSchema();
364 3
        $tableSchema = $schema->getTableSchema($table);
365 3
        $columnSchema = $tableSchema->getColumn($column);
366
        
367 3
        $allowNullNewType = !preg_match("/not +null/i", $type);
368
        
369 3
        $type = preg_replace("/ +(not)? *null/i", "", $type);
370
        
371 3
        $hasType = false;
372
        
373 3
        $matches = [];
374 3
        if (isset($this->typeMap[$type])) {
375 2
            $hasType = true;
376 3
        } elseif (preg_match('/^(\w+)[\( ]/', $type, $matches)) {
377 2
            if (isset($this->typeMap[$matches[1]])) {
378 2
                $hasType = true;
379 2
            }
380 2
        }
381
        
382 3
        $baseSql = 'ALTER TABLE ' . $this->db->quoteTableName($table)
383 3
        . ' ALTER '. $this->db->quoteColumnName($column)
384 3
        . (($hasType) ? ' TYPE ': ' ') .  $this->getColumnType($type);
385
        
386 3
        if ($columnSchema->allowNull == $allowNullNewType) {
387 2
            return $baseSql;
388
        } else {
389
            $sql = 'EXECUTE BLOCK AS BEGIN'
390 2
                . ' EXECUTE STATEMENT ' . $this->db->quoteValue($baseSql) . ';'
391 2
                . ' UPDATE RDB$RELATION_FIELDS SET RDB$NULL_FLAG = ' . ($allowNullNewType ? 'NULL' : '1')
392 2
                . ' WHERE UPPER(RDB$FIELD_NAME) = UPPER(\'' . $column . '\') AND UPPER(RDB$RELATION_NAME) = UPPER(\'' . $table . '\');';
393
            /**
394
             * In any case (whichever option you choose), make sure that the column doesn't have any NULLs.
395
             * Firebird will not check it for you. Later when you backup the database, everything is fine,
396
             * but restore will fail as the NOT NULL column has NULLs in it. To be safe, each time you change from NULL to NOT NULL.
397
             */
398 2
            if (!$allowNullNewType) {
399 2
                $sql .= ' UPDATE ' . $this->db->quoteTableName($table) . ' SET ' . $this->db->quoteColumnName($column) . ' = 0'
400 2
                    . ' WHERE ' . $this->db->quoteColumnName($column) . ' IS NULL;';
401 2
            }
402 2
            $sql .= ' END';
403 2
            return $sql;
404
        }
405
    }
406
    
407
    /**
408
     * @inheritdoc
409
     */
410 1
    public function dropIndex($name, $table)
411
    {
412 1
        return 'DROP INDEX ' . $this->db->quoteTableName($name);
413
    }
414
    
415
    /**
416
     * @inheritdoc
417
     */
418 1
    public function resetSequence($table, $value = null)
419
    {
420 1
        $tableSchema = $this->db->getTableSchema($table);
421 1
        if ($tableSchema === null) {
422
            throw new InvalidParamException("Table not found: $table");
423
        }
424 1
        if ($tableSchema->sequenceName === null) {
425
            throw new InvalidParamException("There is not sequence associated with table '$table'.");
426
        }
427
428 1
        if ($value !== null) {
429 1
            $value = (int) $value;
430 1
        } else {
431
            // use master connection to get the biggest PK value
432 1
            $value = $this->db->useMaster(function(Connection $db) use ($tableSchema) {
433 1
                $key = false;
434 1
                foreach ($tableSchema->primaryKey as $name) {
435 1
                    if ($tableSchema->columns[$name]->autoIncrement) {
436 1
                        $key = $name;
437 1
                        break;
438
                    }
439 1
                }
440 1
                if ($key === false){
441
                    return 0;
442
                }
443 1
                return $db->createCommand("SELECT MAX({$this->db->quoteColumnName($key)}) FROM {$this->db->quoteTableName($tableSchema->name)}")->queryScalar();
444 1
            }) + 1;
445
        }
446
447 1
        return "ALTER SEQUENCE {$this->db->quoteColumnName($tableSchema->sequenceName)} RESTART WITH $value";
448
    }
449
    
450
    /**
451
     * @inheritdoc
452
     */
453 5
    public function createTable($table, $columns, $options = null)
454
    {
455 5
        $sql = parent::createTable($table, $columns, $options);
456
        
457 5
        foreach ($columns as $name => $type) {
458 5
            if (!is_string($name)) {
459
                continue;
460
            }
461
            
462 5
            if (strpos($type, Schema::TYPE_PK) === 0 || strpos($type, Schema::TYPE_BIGPK) === 0) {
463
                $sqlTrigger = <<<SQLTRIGGER
464 4
CREATE TRIGGER tr_{$table}_{$name} FOR {$this->db->quoteTableName($table)}
465
ACTIVE BEFORE INSERT POSITION 0
466
AS
467
BEGIN
468 4
    if (NEW.{$this->db->quoteColumnName($name)} is NULL) then NEW.{$this->db->quoteColumnName($name)} = NEXT VALUE FOR seq_{$table}_{$name};
469 4
END
470 4
SQLTRIGGER;
471
                
472
                $sqlBlock = <<<SQL
473
EXECUTE block AS
474
BEGIN
475 4
    EXECUTE STATEMENT {$this->db->quoteValue($sql)};
476 4
    EXECUTE STATEMENT {$this->db->quoteValue("CREATE SEQUENCE seq_{$table}_{$name}")};
477 4
    EXECUTE STATEMENT {$this->db->quoteValue($sqlTrigger)};
478 4
END;
479 4
SQL;
480
481 4
                return $sqlBlock;
482
            }
483 1
        }
484
        
485 1
        return $sql;
486
    }
487
    
488
    /**
489
     * @inheritdoc
490
     */
491 3
    public function dropTable($table)
492
    {
493 3
        $sql = parent::dropTable($table);
494
        
495 3
        $tableSchema = $this->db->getTableSchema($table);
496 3
        if ($tableSchema === null || $tableSchema->sequenceName === null) {
497 1
            return $sql;
498
        }
499
        
500
        $sqlBlock = <<<SQL
501
EXECUTE block AS
502
BEGIN
503 2
    EXECUTE STATEMENT {$this->db->quoteValue($sql)};
504 2
    EXECUTE STATEMENT {$this->db->quoteValue("DROP SEQUENCE {$tableSchema->sequenceName}")};
505 2
END;
506 2
SQL;
507 2
                return $sqlBlock;
508
        
509
    }
510
511
    /**
512
     * Creates a SELECT EXISTS() SQL statement.
513
     * @param string $rawSql the subquery in a raw form to select from.
514
     * @return string the SELECT EXISTS() SQL statement.
515
     *
516
     * @since 2.0.8
517
     */
518 3
    public function selectExists($rawSql)
519
    {
520 3
        return 'SELECT CASE WHEN EXISTS(' . $rawSql . ') THEN 1 ELSE 0 END FROM RDB$DATABASE';
521
    }
522
}
523