-
Notifications
You must be signed in to change notification settings - Fork 3.4k
/
Connection.php
469 lines (425 loc) · 11.7 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
<?php
/**
* PHP Version 5.4
*
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
* @link http://cakephp.org CakePHP(tm) Project
* @package Cake.Model
* @since CakePHP(tm) v 3.0.0
* @license MIT License (http://www.opensource.org/licenses/mit-license.php)
*/
namespace Cake\Model\Datasource\Database;
use Cake\Model\Datasource\Database\Exception\MissingConnectionException;
use Cake\Model\Datasource\Database\Exception\MissingDriverException;
use Cake\Model\Datasource\Database\Exception\MissingExtensionException;
use Cake\Model\Datasource\Database\Query;
/**
* Represents a connection with a database server
*/
class Connection {
use TypeConverterTrait;
/**
* Contains the configuration params for this connection
*
* @var array
*/
protected $_config;
/**
* Driver object, responsible for creating the real connection
* and provide specific SQL dialect
*
* @var \Cake\Model\Datasource\Database\Driver
*/
protected $_driver;
/**
* Whether connection was established or not
*
* @var boolean
*/
protected $_connected = false;
/**
* Contains how many nested transactions have been started
*
* @var int
*/
protected $_transactionLevel = 0;
/**
* Whether a transaction is active in this connection
*
* @var int
*/
protected $_transactionStarted = false;
/**
* Whether this connection can and should use savepoints for nested
* transactions
*
* @var boolean
*/
protected $_useSavePoints = false;
/**
* Constructor
*
* @param array $config configuration for connecting to database
* @throws MissingDriverException if driver class can not be found
* @throws MissingExtensionException if driver cannot be used
* @return self
*/
public function __construct($config) {
$this->_config = $config;
if (!class_exists($config['datasource'])) {
throw new MissingDriverException(['driver' => $config['datasource']]);
}
$this->driver($config['datasource']);
if (!$this->_driver->enabled()) {
throw new MissingExtensionException(['driver' => get_class($this->_driver)]);
}
}
/**
* Sets the driver instance. If an string is passed it will be treated
* as a class name and will be instantiated.
*
* If no params are passed it will return the current driver instance
*
* @param string|Driver $driver
* @return Driver
*/
public function driver($driver = null) {
if ($driver === null) {
return $this->_driver;
}
if (is_string($driver)) {
$driver = new $driver;
}
return $this->_driver = $driver;
}
/**
* Connects to the configured database
*
* @throws MissingConnectionException if credentials are invalid
* @return boolean true on success or false if already connected.
*/
public function connect() {
if ($this->_connected) {
return false;
}
try {
return $this->_connected = $this->_driver->connect($this->_config);
} catch(\Exception $e) {
throw new MissingConnectionException(['reason' => $e->getMessage()]);
}
}
/**
* Disconnects from database server
*
* @return void
*/
public function disconnect() {
$this->_driver->disconnect();
$this->_connected = false;
}
/**
* Returns whether connection to database server was already stablished
*
* @return boolean
*/
public function isConnected() {
return $this->_connected;
}
/**
* Prepares a sql statement to be executed
*
* @param string $sql
* @return \Cake\Model\Datasource\Database\Statement
*/
public function prepare($sql) {
$this->connect();
return $this->_driver->prepare($sql);
}
/**
* Executes a query using $params for interpolating values and $types as a hint for each
* those params
*
* @param string $query SQL to be executed and interpolated with $params
* @param array $params list or associative array of params to be interpolated in $query as values
* @param array $types list or associative array of types to be used for casting values in query
* @return \Cake\Model\Datasource\Database\Statement executed statement
*/
public function execute($query, array $params = [], array $types = []) {
$this->connect();
if ($params) {
$statement = $this->prepare($query);
$statement->bind($params, $types);
$statement->execute();
} else {
$statement = $this->query($query);
}
return $statement;
}
/**
* Executes a SQL statement and returns the Statement object as result
*
* @param string $sql
* @return \Cake\Model\Datasource\Database\Statement
*/
public function query($sql) {
$this->connect();
$statement = $this->prepare($sql);
$statement->execute();
return $statement;
}
/**
* Create a new Query instance for this connection.
*
* @return Query
*/
public function newQuery() {
return new Query($this);
}
/**
* Executes an INSERT query on the specified table
*
* @param string $table the table to update values in
* @param array $data values to be inserted
* @param array $types list of associative array containing the types to be used for casting
* @return \Cake\Model\Datasource\Database\Statement
*/
public function insert($table, array $data, array $types = []) {
$this->connect();
$columns = array_keys($data);
return $this->newQuery()->insert($table, $columns, $types)
->values($data)
->execute();
}
/**
* Executes an UPDATE statement on the specified table
*
* @param string $table the table to delete rows from
* @param array $data values to be updated
* @param array $conditions conditions to be set for update statement
* @param array $types list of associative array containing the types to be used for casting
* @return \Cake\Model\Datasource\Database\Statement
*/
public function update($table, array $data, array $conditions = [], $types = []) {
$this->connect();
$columns = array_keys($data);
return $this->newQuery()->update($table)
->set($data, $types)
->where($conditions, $types)
->execute();
}
/**
* Executes a DELETE statement on the specified table
*
* @param string $table the table to delete rows from
* @param array $conditions conditions to be set for delete statement
* @param array $types list of associative array containing the types to be used for casting
* @return \Cake\Model\Datasource\Database\Statement
*/
public function delete($table, $conditions = [], $types = []) {
$this->connect();
return $this->newQuery()->delete($table)
->where($conditions, $types)
->execute();
}
/**
* Starts a new transaction
*
* @return void
*/
public function begin() {
$this->connect();
if (!$this->_transactionStarted) {
$this->_driver->beginTransaction();
$this->_transactionLevel = 0;
$this->_transactionStarted = true;
return;
}
$this->_transactionLevel++;
if ($this->useSavePoints()) {
$this->createSavePoint($this->_transactionLevel);
}
}
/**
* Commits current transaction
*
* @return boolean true on success, false otherwise
*/
public function commit() {
if (!$this->_transactionStarted) {
return false;
}
$this->connect();
if ($this->_transactionLevel === 0) {
$this->_transactionStarted = false;
return $this->_driver->commitTransaction();
}
if ($this->useSavePoints()) {
$this->releaseSavePoint($this->_transactionLevel);
}
$this->_transactionLevel--;
return true;
}
/**
* Rollback current transaction
*
* @return boolean
*/
public function rollback() {
if (!$this->_transactionStarted) {
return false;
}
$this->connect();
$useSavePoint = $this->useSavePoints();
if ($this->_transactionLevel === 0 || !$useSavePoint) {
$this->_transactionLevel = 0;
$this->_transactionStarted = false;
$this->_driver->rollbackTransaction();
return true;
}
if ($useSavePoint) {
$this->rollbackSavepoint($this->_transactionLevel--);
}
return true;
}
/**
* Returns whether this connection is using savepoints for nested transactions
* If a boolean is passed as argument it will enable/disable the usage of savepoints
* only if driver the allows it.
*
* If you are trying to enable this feature, make sure you check the return value of this
* function to verify it was enabled successfuly
*
* ## Example:
*
* `$connection->useSavePoints(true)` Returns true if drivers supports save points, false otherwise
* `$connection->useSavePoints(false)` Disables usage of savepoints and returns false
* `$connection->useSavePoints()` Returns current status
*
* @param boolean|null $enable
* @return boolean true if enabled, false otherwise
*/
public function useSavePoints($enable = null) {
if ($enable === null) {
return $this->_useSavePoints;
}
if ($enable === false) {
return $this->_useSavePoints = false;
}
return $this->_useSavePoints = $this->_driver->supportsSavePoints();
}
/**
* Creates a new save point for nested transactions
*
* @param string $name
* @return void
*/
public function createSavePoint($name) {
$this->connect();
$this->execute($this->_driver->savePointSQL($name));
}
/**
* Releases a save point by its name
*
* @param string $name
* @return void
*/
public function releaseSavePoint($name) {
$this->connect();
$this->execute($this->_driver->releaseSavePointSQL($name));
}
/**
* Rollsback a save point by its name
*
* @param string $name
* @return void
*/
public function rollbackSavepoint($name) {
$this->connect();
$this->execute($this->_driver->rollbackSavePointSQL($name));
}
/**
* Quotes value to be used safely in database query
*
* @param mixed $value
* @param string $type Type to be used for determining kind of quoting to perform
* @return mixed quoted value
*/
public function quote($value, $type = null) {
$this->connect();
list($value, $type) = $this->cast($value, $type);
return $this->_driver->quote($value, $type);
}
/**
* Checks if the driver supports quoting
*
* @return boolean
*/
public function supportsQuoting() {
$this->connect();
return $this->_driver->supportsQuoting();
}
/**
* Quotes a database identifier (a column name, table name, etc..) to
* be used safely in queries without the risk of using reserver words
*
* @param string $identifier
* @return string
*/
public function quoteIdentifier($identifier) {
return $this->_driver->quoteIdentifier($identifier);
}
/**
* Returns last id generated for a table or sequence in database
*
* @param string $table table name or sequence to get last insert value from
* @return string|integer
*/
public function lastInsertId($table) {
$this->connect();
return $this->_driver->lastInsertId($table);
}
/**
* Get the list of tables available in the current connection.
*
* @return array The list of tables in the connected database/schema.
*/
public function listTables() {
list($sql, $params) = $this->_driver->listTablesSql($this->_config);
$result = [];
$statement = $this->execute($sql, $params);
while ($row = $statement->fetch()) {
$result[] = $row[0];
}
return $result;
}
/**
* Get the schema information for a given table/collection
*
* @param string $table The table/collection you want schema information for.
* @return array The schema data for the requested table.
*/
public function describe($table) {
list($sql, $params) = $this->_driver->describeTableSql($table);
$statement = $this->execute($sql, $params);
$schema = [];
// TODO complete.
// TODO add tableParameters for platform specific features.
while ($row = $statement->fetch('assoc')) {
list($type, $length) = $this->_driver->columnType($row['Type']);
$schema[$row['Field']] = [
'type' => $type,
'null' => $row['Null'] === 'YES' ? true : false,
'default' => $row['Default'],
'length' => $length,
];
}
return $schema;
}
}