/
Connection.php
557 lines (497 loc) · 15.5 KB
/
Connection.php
1
2
3
4
5
6
7
8
9
10
11
12
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
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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
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
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
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
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
<?php
namespace Concrete\Core\Database\Connection;
use Doctrine\DBAL\Exception\UniqueConstraintViolationException;
use Doctrine\DBAL\Schema\Column as DbalColumn;
use Doctrine\DBAL\Schema\Table as DbalTable;
use Doctrine\DBAL\Types\Type as DbalType;
use Doctrine\ORM\EntityManager;
use Exception;
use ORM;
use PDO;
use Throwable;
class Connection extends \Doctrine\DBAL\Connection
{
/** @var EntityManager */
protected $entityManager;
/**
* The supported character sets and associated default collation.
*
* @var null|array NULL if not yet initialized; an array with keys (character set - always lower case) and values (default collation for the character set - always lower case) otherwise
*/
protected $supportedCharsets;
/**
* The supported collations and the associated character sets.
*
* @var null|array NULL if not yet initialized; an array with keys (collation) and values (associated character set) otherwise
*/
protected $supportedCollations;
/**
* Overridden params.
*
* @var array
*/
private $overriddenParams = [];
/**
* @deprecated Please use the ORM facade instead of this method:
* - ORM::entityManager() in the application/site code and core
* - $pkg->getEntityManager() in packages
*
* @return EntityManager
*/
public function getEntityManager()
{
if (!$this->entityManager) {
$this->entityManager = $this->createEntityManager();
}
return $this->entityManager;
}
/**
* @throws \Doctrine\ORM\ORMException
*
* @return EntityManager
*/
public function createEntityManager()
{
return ORM::entityManager();
}
/**
* Returns true if a table exists – is NOT case sensitive.
*
* @param mixed $tableName
*
* @return bool
*/
public function tableExists($tableName)
{
$sm = $this->getSchemaManager();
$schemaTables = $sm->listTableNames();
return in_array(strtolower($tableName), array_map('strtolower', $schemaTables));
}
/**
* @deprecated
*
* @param mixed $q
* @param mixed $arguments
*/
public function Execute($q, $arguments = [])
{
if ($q instanceof \Doctrine\DBAL\Statement) {
return $q->execute($arguments);
} else {
if (!is_array($arguments)) {
$arguments = [$arguments]; // adodb backward compatibility
}
return $this->executeQuery($q, $arguments);
}
}
public function query()
{
$args = func_get_args();
if (isset($args) && isset($args[1]) && (is_string($args[1]) || is_array($args[1]))) {
return $this->executeQuery($args[0], $args[1]);
} else {
return call_user_func_array('parent::query', $args);
}
}
/**
* This is essentially a workaround for not being able to define indexes on TEXT fields with the current version of Doctrine DBAL.
* This feature will be removed when DBAL will support it, so don't use this feature.
*
* @param array $textIndexes
*/
public function createTextIndexes(array $textIndexes)
{
if (!empty($textIndexes)) {
$sm = $this->getSchemaManager();
foreach ($textIndexes as $tableName => $indexes) {
if ($sm->tablesExist([$tableName])) {
$existingIndexNames = array_map(
function (\Doctrine\DBAL\Schema\Index $index) {
return $index->getShortestName('');
},
$sm->listTableIndexes($tableName)
);
$chunks = [];
foreach ($indexes as $indexName => $indexColumns) {
if (!in_array(strtolower($indexName), $existingIndexNames, true)) {
$newIndexColumns = [];
foreach ((array) $indexColumns as $indexColumn) {
$indexColumn = (array) $indexColumn;
$s = $this->quoteIdentifier($indexColumn[0]);
if (!empty($indexColumn[1])) {
$s .= '(' . (int) $indexColumn[1] . ')';
}
$newIndexColumns[] = $s;
}
$chunks[] = $this->quoteIdentifier($indexName) . ' (' . implode(', ', $newIndexColumns) . ')';
}
}
if (!empty($chunks)) {
$sql = 'ALTER TABLE ' . $this->quoteIdentifier($tableName) . ' ADD INDEX ' . implode(', ADD INDEX ', $chunks);
$this->executeQuery($sql);
}
}
}
}
}
/**
* @deprecated
* alias to old ADODB method
*
* @param mixed $q
* @param mixed $arguments
*/
public function GetRow($q, $arguments = [])
{
if (!is_array($arguments)) {
$arguments = [$arguments]; // adodb backward compatibility
}
$r = $this->executeQuery($q, $arguments)->fetchAssociative();
if (!is_array($r)) {
$r = [];
}
return $r;
}
/**
* @deprecated
* alias to old ADODB method
*
* @param mixed $string
*/
public function qstr($string)
{
return $this->quote($string);
}
/**
* @deprecated
* alias to old ADODB method
*
* @param mixed $q
* @param mixed $arguments
*/
public function GetOne($q, $arguments = [])
{
if (!is_array($arguments)) {
$arguments = [$arguments]; // adodb backward compatibility
}
return $this->fetchColumn($q, $arguments, 0);
}
/**
* @deprecated
* alias to old ADODB method
*/
public function ErrorMsg()
{
if ($this->errorCode() > 0) {
return $this->errorCode();
}
return false;
}
/**
* @deprecated
* alias to old ADODB method
*
* @param mixed $q
* @param mixed $arguments
*/
public function GetAll($q, $arguments = [])
{
if (!is_array($arguments)) {
$arguments = [$arguments]; // adodb backward compatibility
}
return $this->fetchAll($q, $arguments);
}
/**
* @deprecated
* alias to old ADODB method
*
* @param mixed $q
* @param mixed $arguments
*/
public function GetArray($q, $arguments = [])
{
return $this->GetAll($q, $arguments);
}
/**
* @deprecated
* alias to old ADODB method
*
* @param mixed $q
* @param mixed $arguments
*/
public function GetAssoc($q, $arguments = [])
{
$query = $this->query($q, $arguments);
return $query->fetchAll(\PDO::FETCH_KEY_PAIR);
}
/**
* @deprecated
* Returns an associative array of all columns in a table
*
* @param mixed $table
*/
public function MetaColumnNames($table)
{
$sm = $this->getSchemaManager();
$columnNames = [];
$columns = $sm->listTableColumns($table);
foreach ($columns as $column) {
$columnNames[] = $column->getName();
}
return $columnNames;
}
/**
* Insert or update a row in a database table.
*
* @param string $table the name of the database table
* @param array $fieldArray array keys are the field names, array values are the field values
* @param string|string[] $keyCol the names of the primary key fields
* @param bool $autoQuote set to true to quote the field values
*/
public function replace($table, $fieldArray, $keyCol, $autoQuote = true)
{
$qb = $this->createQueryBuilder();
$qb->select('count(*)')->from($table, 't');
$where = $qb->expr()->andX();
$updateKeys = [];
if (!is_array($keyCol)) {
$keyCol = [$keyCol];
}
foreach ($keyCol as $key) {
if (isset($fieldArray[$key])) {
$field = $fieldArray[$key];
} else {
$field = null;
}
$updateKeys[$key] = $field;
if ($autoQuote) {
$field = $qb->expr()->literal($field === null ? '' : $field);
}
$where->add($qb->expr()->eq($key, $field));
}
$qb->where($where);
$sql = $qb->getSql();
$num = parent::query($sql)->fetchColumn();
if ($num) {
$update = true;
} else {
try {
$this->insert($table, $fieldArray);
$update = false;
} catch (UniqueConstraintViolationException $x) {
$update = true;
}
}
if ($update) {
$this->update($table, $fieldArray, $updateKeys);
}
}
/**
* @deprecated -
* alias to old ADODB method
*
* @param mixed $q
* @param mixed $arguments
*/
public function GetCol($q, $arguments = [])
{
$r = $this->fetchAll($q, $arguments);
$return = [];
foreach ($r as $value) {
$return[] = $value[key($value)];
}
return $return;
}
/**
* @deprecated
* alias to old ADODB method
*/
public function Insert_ID()
{
return $this->lastInsertId();
}
/**
* @deprecated
*/
public function MetaTables()
{
$sm = $this->getSchemaManager();
$schemaTables = $sm->listTables();
$tables = [];
foreach ($schemaTables as $table) {
$tables[] = $table->getName();
}
return $tables;
}
/**
* @deprecated
*
* @param mixed $table
*/
public function MetaColumns($table)
{
$sm = $this->getSchemaManager();
$schemaColumns = $sm->listTableColumns($table);
return $schemaColumns;
}
/**
* @deprecated Alias to old ADODB method
*/
public function BeginTrans()
{
$this->beginTransaction();
return true;
}
/**
* @deprecated Alias to old ADODB method
*/
public function StartTrans()
{
$this->beginTransaction();
return true;
}
/**
* @deprecated Alias to old ADODB method
*/
public function CommitTrans()
{
$this->commit();
return true;
}
/**
* @deprecated Alias to old ADODB method
*/
public function CompleteTrans()
{
$this->commit();
return true;
}
/**
* @deprecated Alias to old ADODB method
*/
public function RollbackTrans()
{
$this->rollBack();
return true;
}
/**
* @deprecated Alias to old ADODB method
*/
public function FailTrans()
{
$this->rollBack();
return true;
}
/**
* Get the supported character sets and associated default collation.
*
* @throws \Exception throws an exception in case of errors
*
* @return array keys: character set (always lower case); array values: default collation for the character set (always lower case)
*/
public function getSupportedCharsets()
{
if ($this->supportedCharsets === null) {
$supportedCharsets = [];
$rs = $this->executeQuery('SHOW CHARACTER SET');
while (($row = $rs->fetch(PDO::FETCH_ASSOC)) !== false) {
if (!isset($row['Charset']) || !isset($row['Default collation'])) {
throw new Exception(t('Unrecognized result of the "%s" database query.', 'SHOW CHARACTER SET'));
}
$supportedCharsets[strtolower($row['Charset'])] = strtolower($row['Default collation']);
}
$this->supportedCharsets = $supportedCharsets;
}
return $this->supportedCharsets;
}
/**
* Get the supported collations and the associated character sets.
*
* @throws \Exception throws an exception in case of errors
*
* @return array keys: collation (always lower case); array values: associated character set (always lower case)
*/
public function getSupportedCollations()
{
if ($this->supportedCollations === null) {
$supportedCollations = [];
$rs = $this->executeQuery('SHOW COLLATION');
while (($row = $rs->fetch(PDO::FETCH_ASSOC)) !== false) {
if (!isset($row['Collation']) || !isset($row['Charset'])) {
throw new Exception(t('Unrecognized result of the "%s" database query.', 'SHOW COLLATION'));
}
$supportedCollations[strtolower($row['Collation'])] = strtolower($row['Charset']);
}
$this->supportedCollations = $supportedCollations;
}
return $this->supportedCollations;
}
/**
* {@inheritdoc}
*
* @see \Doctrine\DBAL\Connection::getParams()
*/
public function getParams()
{
$result = $this->overriddenParams + parent::getParams();
// Forward the connection charset/collate to the default table options
if (!isset($result['defaultTableOptions']['charset']) && !isset($result['defaultTableOptions']['collate'])) {
if (isset($result['character_set']) && isset($result['collation'])) {
if (!isset($result['defaultTableOptions'])) {
$result['defaultTableOptions'] = [];
}
$result['defaultTableOptions']['charset'] = $result['character_set'];
$result['defaultTableOptions']['collate'] = $result['collation'];
}
}
return $result;
}
/**
* Check if a collation can be used for keys of a specific length.
*
* @param string $collation the name of a collation
* @param int $fieldLength the length (in chars) of a field to be used as key/index
*
* @return bool
*/
public function isCollationSupportedForKeys($collation, $fieldLength)
{
$sm = $this->getSchemaManager();
$existingTables = array_map('strtolower', $sm->listTableNames());
for ($i = 0; ; ++$i) {
$tableName = 'tmp_checkCollationFieldLength' . $i;
if (!in_array(strtolower($tableName), $existingTables)) {
break;
}
}
$column = new DbalColumn('ColumnName', DbalType::getType(DbalType::STRING), ['length' => (int) $fieldLength]);
$column->setPlatformOption('collation', (string) $collation);
$table = new DbalTable($tableName, [$column]);
$table->setPrimaryKey([$column->getName()]);
try {
$sm->createTable($table);
return true;
} catch (Throwable $x) {
// SQLSTATE[42000]: Syntax error or access violation: 1071 Specified key was too long; max key length is XYZ bytes
return false;
} finally {
try {
$sm->dropTable($tableName);
} catch (Throwable $x) {
}
}
return true;
}
/**
* @param string $characterSet
* @param string $collation
*
* @internal
*/
public function refreshCharactersetCollation($characterSet, $collation)
{
$this->executeQuery('SET NAMES ' . $this->quote($characterSet) . ' COLLATE ' . $this->quote($collation));
$this->overriddenParams['character_set'] = $characterSet;
$this->overriddenParams['collation'] = $collation;
}
}