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
|
<?php
/**
* Interface to the MySQL Improved extension (MySQLi)
*/
declare(strict_types=1);
namespace PhpMyAdmin\Dbal;
use mysqli;
use mysqli_result;
use mysqli_stmt;
use PhpMyAdmin\DatabaseInterface;
use PhpMyAdmin\FieldMetadata;
use PhpMyAdmin\Query\Utilities;
use stdClass;
use function __;
use function defined;
use function is_array;
use function is_bool;
use function mysqli_connect_errno;
use function mysqli_connect_error;
use function mysqli_get_client_info;
use function mysqli_init;
use function mysqli_report;
use function stripos;
use function trigger_error;
use const E_USER_WARNING;
use const MYSQLI_ASSOC;
use const MYSQLI_BOTH;
use const MYSQLI_CLIENT_COMPRESS;
use const MYSQLI_CLIENT_SSL;
use const MYSQLI_CLIENT_SSL_DONT_VERIFY_SERVER_CERT;
use const MYSQLI_NUM;
use const MYSQLI_OPT_LOCAL_INFILE;
use const MYSQLI_OPT_SSL_VERIFY_SERVER_CERT;
use const MYSQLI_REPORT_OFF;
use const MYSQLI_STORE_RESULT;
use const MYSQLI_USE_RESULT;
use const PHP_VERSION_ID;
/**
* Interface to the MySQL Improved extension (MySQLi)
*/
class DbiMysqli implements DbiExtension
{
/**
* 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_report(MYSQLI_REPORT_OFF);
$mysqli = mysqli_init();
if ($mysqli === false) {
return false;
}
$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,
(int) $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) {
/*
* 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.
*/
// phpcs:disable Squiz.NamingConventions.ValidVariableName.MemberNotCamelCaps
$error_number = $mysqli->connect_errno;
$error_message = $mysqli->connect_error;
// phpcs:enable
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;
}
$mysqli->options(MYSQLI_OPT_LOCAL_INFILE, (int) defined('PMA_ENABLE_LDI'));
return $mysqli;
}
/**
* selects given database
*
* @param string|DatabaseName $databaseName database name to select
* @param mysqli $link the mysqli object
*
* @return bool
*/
public function selectDb($databaseName, $link)
{
return $link->select_db((string) $databaseName);
}
/**
* runs a query and returns the result
*
* @param string $query query to execute
* @param mysqli $link mysqli object
* @param int $options query options
*
* @return mysqli_result|bool
*/
public function realQuery($query, $link, $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 $link->query($query, $method);
}
/**
* Run the multi query and output the results
*
* @param mysqli $link mysqli object
* @param string $query multi query statement to execute
*
* @return bool
*/
public function realMultiQuery($link, $query)
{
return $link->multi_query($query);
}
/**
* returns array of rows with associative and numeric keys from $result
*
* @param mysqli_result $result result set identifier
*/
public function fetchArray($result): ?array
{
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
*/
public function fetchAssoc($result): ?array
{
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
*/
public function fetchRow($result): ?array
{
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 int $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
*/
public function freeResult($result): void
{
if (! ($result instanceof mysqli_result)) {
return;
}
$result->close();
}
/**
* Check if there are any more query results from a multi query
*
* @param mysqli $link the mysqli object
*
* @return bool true or false
*/
public function moreResults($link)
{
return $link->more_results();
}
/**
* Prepare next result from multi_query
*
* @param mysqli $link the mysqli object
*
* @return bool true or false
*/
public function nextResult($link)
{
return $link->next_result();
}
/**
* Store the result returned from multi query
*
* @param mysqli $link the mysqli object
*
* @return mysqli_result|bool false when empty results / result set when not empty
*/
public function storeResult($link)
{
return $link->store_result();
}
/**
* Returns a string representing the type of connection used
*
* @param mysqli $link mysql link
*
* @return string type of connection used
*/
public function getHostInfo($link)
{
// phpcs:ignore Squiz.NamingConventions.ValidVariableName.MemberNotCamelCaps
return $link->host_info;
}
/**
* Returns the version of the MySQL protocol used
*
* @param mysqli $link mysql link
*
* @return string version of the MySQL protocol used
*/
public function getProtoInfo($link)
{
// phpcs:ignore Squiz.NamingConventions.ValidVariableName.MemberNotCamelCaps
return $link->protocol_version;
}
/**
* returns a string that represents the client library version
*
* @param mysqli $link mysql link
*
* @return string MySQL client library version
*/
public function getClientInfo($link)
{
// See: https://github.com/phpmyadmin/phpmyadmin/issues/16911
if (PHP_VERSION_ID < 80100) {
return $link->get_client_info();
}
return mysqli_get_client_info();
}
/**
* returns last error message or false if no errors occurred
*
* @param mysqli|false|null $link mysql link
*
* @return string|bool error or false
*/
public function getError($link)
{
$GLOBALS['errno'] = 0;
if ($link !== null && $link !== false) {
$error_number = $link->errno;
$error_message = $link->error;
} else {
$error_number = mysqli_connect_errno();
$error_message = (string) mysqli_connect_error();
}
if ($error_number === 0 || $error_message === '') {
return false;
}
// keep the error number for further check after
// the call to getError()
$GLOBALS['errno'] = $error_number;
return Utilities::formatError($error_number, $error_message);
}
/**
* returns the number of rows returned by last query
*
* @param mysqli_result|bool $result result set identifier
*
* @return string|int
* @psalm-return int|numeric-string
*/
public function numRows($result)
{
// see the note for tryQuery();
if (is_bool($result)) {
return 0;
}
// phpcs:ignore Squiz.NamingConventions.ValidVariableName.MemberNotCamelCaps
return $result->num_rows;
}
/**
* returns the number of rows affected by last query
*
* @param mysqli $link the mysqli object
*
* @return int|string
* @psalm-return int|numeric-string
*/
public function affectedRows($link)
{
// phpcs:ignore Squiz.NamingConventions.ValidVariableName.MemberNotCamelCaps
return $link->affected_rows;
}
/**
* returns meta info for fields in $result
*
* @param mysqli_result $result result set identifier
*
* @return FieldMetadata[]|null meta info for fields in $result
*/
public function getFieldsMeta($result): ?array
{
if (! $result instanceof mysqli_result) {
return null;
}
$fields = $result->fetch_fields();
if (! is_array($fields)) {
return null;
}
foreach ($fields as $k => $field) {
$fields[$k] = new FieldMetadata($field->type, $field->flags, $field);
}
return $fields;
}
/**
* return number of fields in given $result
*
* @param mysqli_result $result result set identifier
*
* @return int field count
*/
public function numFields($result)
{
// phpcs:ignore Squiz.NamingConventions.ValidVariableName.MemberNotCamelCaps
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|false $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 name of $i. field in $result
*/
public function fieldName($result, $i)
{
if ($i >= $this->numFields($result)) {
return '';
}
/** @var stdClass|false $fieldDefinition */
$fieldDefinition = $result->fetch_field_direct($i);
if ($fieldDefinition !== false) {
return $fieldDefinition->name;
}
return '';
}
/**
* returns properly escaped string for use in MySQL queries
*
* @param mysqli $link database link
* @param string $string string to be escaped
*
* @return string a MySQL escaped string
*/
public function escapeString($link, $string)
{
return $link->real_escape_string($string);
}
/**
* Prepare an SQL statement for execution.
*
* @param mysqli $link database link
* @param string $query The query, as a string.
*
* @return mysqli_stmt|false A statement object or false.
*/
public function prepare($link, string $query)
{
return $link->prepare($query);
}
}
|