-
-
Notifications
You must be signed in to change notification settings - Fork 3.4k
/
DbiMysqli.php
591 lines (546 loc) · 17.7 KB
/
DbiMysqli.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
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
<?php
/* vim: set expandtab sw=4 ts=4 sts=4: */
/**
* Interface to the MySQL Improved extension (MySQLi)
*
* @package PhpMyAdmin-DBI
* @subpackage MySQLi
*/
declare(strict_types=1);
namespace PhpMyAdmin\Dbi;
use PhpMyAdmin\DatabaseInterface;
/**
* Interface to the MySQL Improved extension (MySQLi)
*
* @package PhpMyAdmin-DBI
* @subpackage MySQLi
*/
class DbiMysqli implements DbiExtension
{
/**
* @var array
*/
private static $pma_mysqli_flag_names = [
MYSQLI_NUM_FLAG => 'num',
MYSQLI_PART_KEY_FLAG => 'part_key',
MYSQLI_SET_FLAG => 'set',
MYSQLI_TIMESTAMP_FLAG => 'timestamp',
MYSQLI_AUTO_INCREMENT_FLAG => 'auto_increment',
MYSQLI_ENUM_FLAG => 'enum',
MYSQLI_ZEROFILL_FLAG => 'zerofill',
MYSQLI_UNSIGNED_FLAG => 'unsigned',
MYSQLI_BLOB_FLAG => 'blob',
MYSQLI_MULTIPLE_KEY_FLAG => 'multiple_key',
MYSQLI_UNIQUE_KEY_FLAG => 'unique_key',
MYSQLI_PRI_KEY_FLAG => 'primary_key',
MYSQLI_NOT_NULL_FLAG => 'not_null',
];
/**
* connects to the database server
*
* @param string $user mysql user name
* @param string $password mysql user password
* @param array $server host/port/socket/persistent
*
* @return \mysqli|bool false on error or a mysqli object on success
*/
public function connect($user, $password, array $server)
{
if ($server) {
$server['host'] = empty($server['host'])
? 'localhost'
: $server['host'];
}
$mysqli = \mysqli_init();
$client_flags = 0;
/* Optionally compress connection */
if ($server['compress'] && defined('MYSQLI_CLIENT_COMPRESS')) {
$client_flags |= MYSQLI_CLIENT_COMPRESS;
}
/* Optionally enable SSL */
if ($server['ssl']) {
$client_flags |= MYSQLI_CLIENT_SSL;
if (! empty($server['ssl_key']) ||
! empty($server['ssl_cert']) ||
! empty($server['ssl_ca']) ||
! empty($server['ssl_ca_path']) ||
! empty($server['ssl_ciphers'])
) {
$mysqli->ssl_set(
$server['ssl_key'],
$server['ssl_cert'],
$server['ssl_ca'],
$server['ssl_ca_path'],
$server['ssl_ciphers']
);
}
/*
* disables SSL certificate validation on mysqlnd for MySQL 5.6 or later
* @link https://bugs.php.net/bug.php?id=68344
* @link https://github.com/phpmyadmin/phpmyadmin/pull/11838
*/
if (! $server['ssl_verify']) {
$mysqli->options(
MYSQLI_OPT_SSL_VERIFY_SERVER_CERT,
$server['ssl_verify']
);
$client_flags |= MYSQLI_CLIENT_SSL_DONT_VERIFY_SERVER_CERT;
}
}
if ($GLOBALS['cfg']['PersistentConnections']) {
$host = 'p:' . $server['host'];
} else {
$host = $server['host'];
}
$return_value = $mysqli->real_connect(
$host,
$user,
$password,
'',
$server['port'],
(string) $server['socket'],
$client_flags
);
if ($return_value === false || is_null($return_value)) {
/*
* Switch to SSL if server asked us to do so, unfortunately
* there are more ways MySQL server can tell this:
*
* - MySQL 8.0 and newer should return error 3159
* - #2001 - SSL Connection is required. Please specify SSL options and retry.
* - #9002 - SSL connection is required. Please specify SSL options and retry.
*/
$error_number = $mysqli->connect_errno;
$error_message = $mysqli->connect_error;
if (! $server['ssl'] && ($error_number == 3159 ||
(($error_number == 2001 || $error_number == 9002) && stripos($error_message, 'SSL Connection is required') !== false))
) {
trigger_error(
__('SSL connection enforced by server, automatically enabling it.'),
E_USER_WARNING
);
$server['ssl'] = true;
return self::connect($user, $password, $server);
}
return false;
}
if (defined('PMA_ENABLE_LDI')) {
$mysqli->options(MYSQLI_OPT_LOCAL_INFILE, true);
} else {
$mysqli->options(MYSQLI_OPT_LOCAL_INFILE, false);
}
return $mysqli;
}
/**
* selects given database
*
* @param string $databaseName database name to select
* @param \mysqli $mysqli the mysqli object
*
* @return boolean
*/
public function selectDb($databaseName, $mysqli)
{
return $mysqli->select_db($databaseName);
}
/**
* runs a query and returns the result
*
* @param string $query query to execute
* @param \mysqli $mysqli mysqli object
* @param int $options query options
*
* @return \mysqli_result|bool
*/
public function realQuery($query, $mysqli, $options)
{
if ($options == ($options | DatabaseInterface::QUERY_STORE)) {
$method = MYSQLI_STORE_RESULT;
} elseif ($options == ($options | DatabaseInterface::QUERY_UNBUFFERED)) {
$method = MYSQLI_USE_RESULT;
} else {
$method = 0;
}
return $mysqli->query($query, $method);
}
/**
* Run the multi query and output the results
*
* @param \mysqli $mysqli mysqli object
* @param string $query multi query statement to execute
*
* @return bool
*/
public function realMultiQuery($mysqli, $query)
{
return $mysqli->multi_query($query);
}
/**
* returns array of rows with associative and numeric keys from $result
*
* @param \mysqli_result $result result set identifier
*
* @return array|null
*/
public function fetchArray($result)
{
if (! $result instanceof \mysqli_result) {
return null;
}
return $result->fetch_array(MYSQLI_BOTH);
}
/**
* returns array of rows with associative keys from $result
*
* @param \mysqli_result $result result set identifier
*
* @return array|null
*/
public function fetchAssoc($result)
{
if (! $result instanceof \mysqli_result) {
return null;
}
return $result->fetch_array(MYSQLI_ASSOC);
}
/**
* returns array of rows with numeric keys from $result
*
* @param \mysqli_result $result result set identifier
*
* @return array|null
*/
public function fetchRow($result)
{
if (! $result instanceof \mysqli_result) {
return null;
}
return $result->fetch_array(MYSQLI_NUM);
}
/**
* Adjusts the result pointer to an arbitrary row in the result
*
* @param \mysqli_result $result database result
* @param integer $offset offset to seek
*
* @return bool true on success, false on failure
*/
public function dataSeek($result, $offset)
{
return $result->data_seek($offset);
}
/**
* Frees memory associated with the result
*
* @param \mysqli_result $result database result
*
* @return void
*/
public function freeResult($result)
{
if ($result instanceof \mysqli_result) {
$result->close();
}
}
/**
* Check if there are any more query results from a multi query
*
* @param \mysqli $mysqli the mysqli object
*
* @return bool true or false
*/
public function moreResults($mysqli)
{
return $mysqli->more_results();
}
/**
* Prepare next result from multi_query
*
* @param \mysqli $mysqli the mysqli object
*
* @return bool true or false
*/
public function nextResult($mysqli)
{
return $mysqli->next_result();
}
/**
* Store the result returned from multi query
*
* @param \mysqli $mysqli the mysqli object
*
* @return \mysqli_result|bool false when empty results / result set when not empty
*/
public function storeResult($mysqli)
{
return $mysqli->store_result();
}
/**
* Returns a string representing the type of connection used
*
* @param \mysqli $mysqli mysql link
*
* @return string type of connection used
*/
public function getHostInfo($mysqli)
{
return $mysqli->host_info;
}
/**
* Returns the version of the MySQL protocol used
*
* @param \mysqli $mysqli mysql link
*
* @return string version of the MySQL protocol used
*/
public function getProtoInfo($mysqli)
{
return $mysqli->protocol_version;
}
/**
* returns a string that represents the client library version
*
* @param \mysqli $mysqli mysql link
*
* @return string MySQL client library version
*/
public function getClientInfo($mysqli)
{
return $mysqli->get_client_info();
}
/**
* returns last error message or false if no errors occurred
*
* @param \mysqli $mysqli mysql link
*
* @return string|bool error or false
*/
public function getError($mysqli)
{
$GLOBALS['errno'] = 0;
if (null !== $mysqli && false !== $mysqli) {
$error_number = $mysqli->errno;
$error_message = $mysqli->error;
} else {
$error_number = $mysqli->connect_errno;
$error_message = $mysqli->connect_error;
}
if (0 == $error_number) {
return false;
}
// keep the error number for further check after
// the call to getError()
$GLOBALS['errno'] = $error_number;
return $GLOBALS['dbi']->formatError($error_number, $error_message);
}
/**
* returns the number of rows returned by last query
*
* @param \mysqli_result $result result set identifier
*
* @return string|int
*/
public function numRows($result)
{
// see the note for tryQuery();
if (is_bool($result)) {
return 0;
}
return $result->num_rows;
}
/**
* returns the number of rows affected by last query
*
* @param \mysqli $mysqli the mysqli object
*
* @return int
*/
public function affectedRows($mysqli)
{
return $mysqli->affected_rows;
}
/**
* returns meta info for fields in $result
*
* @param \mysqli_result $result result set identifier
*
* @return array|bool meta info for fields in $result
*/
public function getFieldsMeta($result)
{
if (! $result instanceof \mysqli_result) {
return false;
}
// Build an associative array for a type look up
$typeAr = [];
$typeAr[MYSQLI_TYPE_DECIMAL] = 'real';
$typeAr[MYSQLI_TYPE_NEWDECIMAL] = 'real';
$typeAr[MYSQLI_TYPE_BIT] = 'int';
$typeAr[MYSQLI_TYPE_TINY] = 'int';
$typeAr[MYSQLI_TYPE_SHORT] = 'int';
$typeAr[MYSQLI_TYPE_LONG] = 'int';
$typeAr[MYSQLI_TYPE_FLOAT] = 'real';
$typeAr[MYSQLI_TYPE_DOUBLE] = 'real';
$typeAr[MYSQLI_TYPE_NULL] = 'null';
$typeAr[MYSQLI_TYPE_TIMESTAMP] = 'timestamp';
$typeAr[MYSQLI_TYPE_LONGLONG] = 'int';
$typeAr[MYSQLI_TYPE_INT24] = 'int';
$typeAr[MYSQLI_TYPE_DATE] = 'date';
$typeAr[MYSQLI_TYPE_TIME] = 'time';
$typeAr[MYSQLI_TYPE_DATETIME] = 'datetime';
$typeAr[MYSQLI_TYPE_YEAR] = 'year';
$typeAr[MYSQLI_TYPE_NEWDATE] = 'date';
$typeAr[MYSQLI_TYPE_ENUM] = 'unknown';
$typeAr[MYSQLI_TYPE_SET] = 'unknown';
$typeAr[MYSQLI_TYPE_TINY_BLOB] = 'blob';
$typeAr[MYSQLI_TYPE_MEDIUM_BLOB] = 'blob';
$typeAr[MYSQLI_TYPE_LONG_BLOB] = 'blob';
$typeAr[MYSQLI_TYPE_BLOB] = 'blob';
$typeAr[MYSQLI_TYPE_VAR_STRING] = 'string';
$typeAr[MYSQLI_TYPE_STRING] = 'string';
// MySQL returns MYSQLI_TYPE_STRING for CHAR
// and MYSQLI_TYPE_CHAR === MYSQLI_TYPE_TINY
// so this would override TINYINT and mark all TINYINT as string
// see https://github.com/phpmyadmin/phpmyadmin/issues/8569
//$typeAr[MYSQLI_TYPE_CHAR] = 'string';
$typeAr[MYSQLI_TYPE_GEOMETRY] = 'geometry';
$typeAr[MYSQLI_TYPE_BIT] = 'bit';
$typeAr[MYSQLI_TYPE_JSON] = 'json';
$fields = $result->fetch_fields();
if (! is_array($fields)) {
return false;
}
foreach ($fields as $k => $field) {
$fields[$k]->_type = $field->type;
$fields[$k]->type = $typeAr[$field->type];
$fields[$k]->_flags = $field->flags;
$fields[$k]->flags = $this->fieldFlags($result, $k);
// Enhance the field objects for mysql-extension compatibility
//$flags = explode(' ', $fields[$k]->flags);
//array_unshift($flags, 'dummy');
$fields[$k]->multiple_key
= (int) (bool) ($fields[$k]->_flags & MYSQLI_MULTIPLE_KEY_FLAG);
$fields[$k]->primary_key
= (int) (bool) ($fields[$k]->_flags & MYSQLI_PRI_KEY_FLAG);
$fields[$k]->unique_key
= (int) (bool) ($fields[$k]->_flags & MYSQLI_UNIQUE_KEY_FLAG);
$fields[$k]->not_null
= (int) (bool) ($fields[$k]->_flags & MYSQLI_NOT_NULL_FLAG);
$fields[$k]->unsigned
= (int) (bool) ($fields[$k]->_flags & MYSQLI_UNSIGNED_FLAG);
$fields[$k]->zerofill
= (int) (bool) ($fields[$k]->_flags & MYSQLI_ZEROFILL_FLAG);
$fields[$k]->numeric
= (int) (bool) ($fields[$k]->_flags & MYSQLI_NUM_FLAG);
$fields[$k]->blob
= (int) (bool) ($fields[$k]->_flags & MYSQLI_BLOB_FLAG);
}
return $fields;
}
/**
* return number of fields in given $result
*
* @param \mysqli_result $result result set identifier
*
* @return int field count
*/
public function numFields($result)
{
return $result->field_count;
}
/**
* returns the length of the given field $i in $result
*
* @param \mysqli_result $result result set identifier
* @param int $i field
*
* @return int|bool length of field
*/
public function fieldLen($result, $i)
{
if ($i >= $this->numFields($result)) {
return false;
}
/** @var \stdClass $fieldDefinition */
$fieldDefinition = $result->fetch_field_direct($i);
if ($fieldDefinition !== false) {
return $fieldDefinition->length;
}
return false;
}
/**
* returns name of $i. field in $result
*
* @param \mysqli_result $result result set identifier
* @param int $i field
*
* @return string|bool name of $i. field in $result
*/
public function fieldName($result, $i)
{
if ($i >= $this->numFields($result)) {
return false;
}
/** @var \stdClass $fieldDefinition */
$fieldDefinition = $result->fetch_field_direct($i);
if ($fieldDefinition !== false) {
return $fieldDefinition->name;
}
return false;
}
/**
* returns concatenated string of human readable field flags
*
* @param \mysqli_result $result result set identifier
* @param int $i field
*
* @return string field flags
*/
public function fieldFlags($result, $i)
{
if ($i >= $this->numFields($result)) {
return false;
}
/** @var \stdClass $fieldDefinition */
$fieldDefinition = $result->fetch_field_direct($i);
if ($fieldDefinition !== false) {
$type = $fieldDefinition->type;
$charsetNumber = $fieldDefinition->charsetnr;
$fieldDefinitionFlags = $fieldDefinition->flags;
$flags = [];
foreach (self::$pma_mysqli_flag_names as $flag => $name) {
if ($fieldDefinitionFlags & $flag) {
$flags[] = $name;
}
}
// See https://dev.mysql.com/doc/refman/6.0/en/c-api-datatypes.html:
// to determine if a string is binary, we should not use MYSQLI_BINARY_FLAG
// but instead the charsetnr member of the MYSQL_FIELD
// structure. Watch out: some types like DATE returns 63 in charsetnr
// so we have to check also the type.
// Unfortunately there is no equivalent in the mysql extension.
if (($type == MYSQLI_TYPE_TINY_BLOB || $type == MYSQLI_TYPE_BLOB
|| $type == MYSQLI_TYPE_MEDIUM_BLOB || $type == MYSQLI_TYPE_LONG_BLOB
|| $type == MYSQLI_TYPE_VAR_STRING || $type == MYSQLI_TYPE_STRING)
&& 63 == $charsetNumber
) {
$flags[] = 'binary';
}
return implode(' ', $flags);
} else {
return '';
}
}
/**
* returns properly escaped string for use in MySQL queries
*
* @param \mysqli $mysqli database link
* @param string $string string to be escaped
*
* @return string a MySQL escaped string
*/
public function escapeString($mysqli, $string)
{
return $mysqli->real_escape_string($string);
}
}