Skip to content
Navigation Menu
{{ message }}
-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
Expand file tree
/
Copy pathStorageEngine.php
More file actions
479 lines (412 loc) · 15 KB
/
Copy pathStorageEngine.php
File metadata and controls
479 lines (412 loc) · 15 KB
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
<?php
declare(strict_types=1);
namespace PhpMyAdmin;
use PhpMyAdmin\Dbal\DatabaseInterface;
use PhpMyAdmin\Engines\Binlog;
use PhpMyAdmin\Engines\Innobase;
use PhpMyAdmin\Engines\Innodb;
use PhpMyAdmin\Engines\Memory;
use PhpMyAdmin\Engines\Merge;
use PhpMyAdmin\Engines\MrgMyisam;
use PhpMyAdmin\Engines\Myisam;
use PhpMyAdmin\Engines\Ndbcluster;
use PhpMyAdmin\Engines\Pbxt;
use PhpMyAdmin\Engines\PerformanceSchema;
use PhpMyAdmin\Html\Generator;
use PhpMyAdmin\Utils\SessionCache;
use function __;
use function array_key_exists;
use function array_keys;
use function explode;
use function htmlspecialchars;
use function in_array;
use function json_decode;
use function mb_stripos;
use function mb_strtolower;
use function sprintf;
use function strlen;
use function strncmp;
/**
* Library for extracting information about the available storage engines
*/
class StorageEngine
{
protected const SUPPORT_NO = 0;
protected const SUPPORT_DISABLED = 1;
protected const SUPPORT_YES = 2;
protected const SUPPORT_DEFAULT = 3;
protected const DETAILS_TYPE_PLAINTEXT = 0;
protected const DETAILS_TYPE_SIZE = 1;
protected const DETAILS_TYPE_NUMERIC = 2; // Has no effect yet...
protected const DETAILS_TYPE_BOOLEAN = 3; // 'ON' or 'OFF'
/** @var string engine name */
public string $engine = 'dummy';
/** @var string engine title/description */
public string $title = 'PMA Dummy Engine Class';
/** @var string engine lang description */
public string $comment = 'If you read this text inside phpMyAdmin, something went wrong...';
/**
* Engine supported by current server.
*
* @psalm-var self::SUPPORT_NO|self::SUPPORT_DISABLED|self::SUPPORT_YES|self::SUPPORT_DEFAULT
*/
public int $support = self::SUPPORT_NO;
/** @psalm-var array<string, array{Engine: string, Comment: string, Support: string}>|null */
private static array|null $storageEngines = null;
/** @param string $engine The engine ID */
public function __construct(string $engine)
{
$storageEngines = self::getStorageEngines();
if (! array_key_exists($engine, $storageEngines)) {
return;
}
$this->engine = $engine;
$this->title = $storageEngines[$engine]['Engine'];
$this->comment = $storageEngines[$engine]['Comment'];
$this->support = match ($storageEngines[$engine]['Support']) {
'DEFAULT' => self::SUPPORT_DEFAULT,
'YES' => self::SUPPORT_YES,
'DISABLED' => self::SUPPORT_DISABLED,
default => self::SUPPORT_NO,
};
}
/**
* Returns array of storage engines
*
* @return array<string, array{Engine: string, Comment: string, Support: string}>
*/
public static function getStorageEngines(): array
{
if (self::$storageEngines === null) {
$dbi = DatabaseInterface::getInstance();
/** @var array<string, array{Engine: string, Comment: string, Support: string}> $storageEngines */
$storageEngines = $dbi->fetchResult('SHOW STORAGE ENGINES', 'Engine');
if (! $dbi->isMariaDB() && $dbi->getVersion() >= 50708) {
$disabled = (string) SessionCache::get(
'disabled_storage_engines',
static fn () => DatabaseInterface::getInstance()->fetchValue(
'SELECT @@disabled_storage_engines',
),
);
foreach (explode(',', $disabled) as $engine) {
if (! isset($storageEngines[$engine])) {
continue;
}
$storageEngines[$engine]['Support'] = 'DISABLED';
}
}
self::$storageEngines = $storageEngines;
}
return self::$storageEngines;
}
/**
* Returns if Mroonga is available to be used
*
* This is public to be used in the StructureComtroller, the first release
* of this function was looking Mroonga in the engines list but this second
* method checks too that mroonga is installed successfully
*/
public static function hasMroongaEngine(): bool
{
$cacheKey = 'storage-engine.mroonga.has.mroonga_command';
if (Cache::has($cacheKey)) {
return (bool) Cache::get($cacheKey, false);
}
$dbi = DatabaseInterface::getInstance();
$supportsMroonga = $dbi->tryQuery('SELECT mroonga_command(\'object_list\');') !== false;
Cache::set($cacheKey, $supportsMroonga);
return $supportsMroonga;
}
/**
* Get the lengths of a table of database
*
* @param string $dbName DB name
* @param string $tableName Table name
*
* @return int[]
*/
public static function getMroongaLengths(string $dbName, string $tableName): array
{
$cacheKey = 'storage-engine.mroonga.object_list.' . $dbName;
$dbi = DatabaseInterface::getInstance();
$dbi->selectDb($dbName);// Needed for mroonga_command calls
if (! Cache::has($cacheKey)) {
$result = $dbi->fetchValue('SELECT mroonga_command(\'object_list\');', 0);
$objectList = (array) json_decode((string) $result, true);
foreach ($objectList as $mroongaName => $mroongaData) {
/**
* We only need the objects of table or column types, more info:
* - https://groonga.org/docs/reference/commands/object_list.html#object-type
* - https://groonga.org/docs/reference/commands/object_inspect.html#table-type-id
* - https://groonga.org/docs/reference/commands/object_inspect.html#column-type-raw-id
*/
if (in_array($mroongaData['type']['id'], [48, 49, 50, 51, 64, 65, 72])) {
continue;
}
unset($objectList[$mroongaName]);
}
// At this point, we can remove all the data because only need the mroongaName values
Cache::set($cacheKey, array_keys($objectList));
}
/** @var string[] $objectList */
$objectList = Cache::get($cacheKey, []);
$dataLength = 0;
$indexLength = 0;
foreach ($objectList as $mroongaName) {
if (strncmp($tableName, $mroongaName, strlen($tableName)) !== 0) {
continue;
}
$result = $dbi->fetchValue('SELECT mroonga_command(\'object_inspect ' . $mroongaName . '\');', 0);
$decodedData = json_decode((string) $result, true);
if ($decodedData === null) {
// Invalid for some strange reason, maybe query failed
continue;
}
$indexPrefix = $tableName . '#' . $tableName;
if (strncmp($indexPrefix, $mroongaName, strlen($indexPrefix)) === 0) {
$indexLength += $decodedData['disk_usage'];
continue;
}
$dataLength += $decodedData['disk_usage'];
}
return [$dataLength, $indexLength];
}
/** @return array<string, array{name: string, comment: string, is_default: bool}> */
public static function getArray(): array
{
$engines = [];
foreach (self::getStorageEngines() as $details) {
// Don't show PERFORMANCE_SCHEMA engine (MySQL 5.5)
if (
$details['Support'] === 'NO'
|| $details['Support'] === 'DISABLED'
|| $details['Engine'] === 'PERFORMANCE_SCHEMA'
) {
continue;
}
$engines[$details['Engine']] = [
'name' => $details['Engine'],
'comment' => $details['Comment'],
'is_default' => $details['Support'] === 'DEFAULT',
];
}
return $engines;
}
/**
* Loads the corresponding engine plugin, if available.
*
* @param string $engine The engine ID
*
* @return StorageEngine The engine plugin
*/
public static function getEngine(string $engine): StorageEngine
{
return match (mb_strtolower($engine)) {
'binlog' => new Binlog($engine),
'innobase' => new Innobase($engine),
'innodb' => new Innodb($engine),
'memory' => new Memory($engine),
'merge' => new Merge($engine),
'mrg_myisam' => new MrgMyisam($engine),
'myisam' => new Myisam($engine),
'ndbcluster' => new Ndbcluster($engine),
'pbxt' => new Pbxt($engine),
'performance_schema' => new PerformanceSchema($engine),
default => new StorageEngine($engine),
};
}
/**
* Returns true if given engine name is supported/valid, otherwise false
*
* @param string $engine name of engine
*/
public static function isValid(string $engine): bool
{
if ($engine === 'PBMS') {
return true;
}
return array_key_exists($engine, self::getStorageEngines());
}
/**
* Returns as HTML table of the engine's server variables
*
* @return string The table that was generated based on the retrieved
* information
*/
public function getHtmlVariables(): string
{
$ret = '';
foreach ($this->getVariablesStatus() as $details) {
$ret .= '<tr>' . "\n"
. ' <td>' . "\n";
if (! empty($details['desc'])) {
$ret .= ' '
. Generator::showHint($details['desc'])
. "\n";
}
$ret .= ' </td>' . "\n"
. ' <th scope="row">' . htmlspecialchars($details['title']) . '</th>'
. "\n"
. ' <td class="font-monospace text-end">';
switch ($details['type']) {
case self::DETAILS_TYPE_SIZE:
$parsedSize = $this->resolveTypeSize($details['value']);
$ret .= $parsedSize[0] . ' ' . $parsedSize[1];
break;
case self::DETAILS_TYPE_NUMERIC:
$ret .= Util::formatNumber($details['value']) . ' ';
break;
default:
$ret .= htmlspecialchars($details['value']) . ' ';
}
$ret .= '</td>' . "\n"
. '</tr>' . "\n";
}
if ($ret === '') {
return '<p>' . "\n"
. ' '
. __('There is no detailed status information available for this storage engine.')
. "\n"
. '</p>' . "\n";
}
return '<table class="table table-striped table-hover w-auto">'
. "\n" . $ret . '</table>' . "\n";
}
/**
* Returns the engine specific handling for
* DETAILS_TYPE_SIZE type variables.
*
* This function should be overridden when
* DETAILS_TYPE_SIZE type needs to be
* handled differently for a particular engine.
*
* @param int|string $value Value to format
*
* @return string[] the formatted value and its unit
* @psalm-return array{string, string}
*/
public function resolveTypeSize(int|string $value): array
{
return Util::formatByteDown($value);
}
/**
* Returns array with detailed info about engine specific server variables
*
* @return mixed[] array with detailed info about specific engine server variables
*/
public function getVariablesStatus(): array
{
$variables = $this->getVariables();
$like = $this->getVariablesLikePattern();
if ($like !== '') {
$like = " LIKE '" . $like . "' ";
}
$mysqlVars = [];
$sqlQuery = 'SHOW GLOBAL VARIABLES ' . $like . ';';
$res = DatabaseInterface::getInstance()->query($sqlQuery);
foreach ($res as $row) {
if (isset($variables[$row['Variable_name']])) {
$mysqlVars[$row['Variable_name']] = $variables[$row['Variable_name']];
} elseif ($like === '' && mb_stripos($row['Variable_name'], $this->engine) !== 0) {
continue;
}
$mysqlVars[$row['Variable_name']]['value'] = $row['Value'];
if (empty($mysqlVars[$row['Variable_name']]['title'])) {
$mysqlVars[$row['Variable_name']]['title'] = $row['Variable_name'];
}
if (isset($mysqlVars[$row['Variable_name']]['type'])) {
continue;
}
$mysqlVars[$row['Variable_name']]['type'] = self::DETAILS_TYPE_PLAINTEXT;
}
return $mysqlVars;
}
/**
* Reveals the engine's title
*
* @return string The title
*/
public function getTitle(): string
{
return $this->title;
}
/**
* Fetches the server's comment about this engine
*
* @return string The comment
*/
public function getComment(): string
{
return $this->comment;
}
/**
* Information message on whether this storage engine is supported
*
* @return string The localized message.
*/
public function getSupportInformationMessage(): string
{
$message = match ($this->support) {
self::SUPPORT_DEFAULT => __('%s is the default storage engine on this MySQL server.'),
self::SUPPORT_YES => __('%s is available on this MySQL server.'),
self::SUPPORT_DISABLED => __('%s has been disabled for this MySQL server.'),
default => __('This MySQL server does not support the %s storage engine.'),
};
return sprintf($message, htmlspecialchars($this->title));
}
/**
* Generates a list of MySQL variables that provide information about this
* engine. This function should be overridden when extending this class
* for a particular engine.
*
* @return mixed[] The list of variables.
*/
public function getVariables(): array
{
return [];
}
/**
* Returns string with filename for the MySQL helppage
* about this storage engine
*
* @return string MySQL help page filename
*/
public function getMysqlHelpPage(): string
{
return $this->engine . '-storage-engine';
}
/**
* Returns the pattern to be used in the query for SQL variables
* related to the storage engine
*
* @return string SQL query LIKE pattern
*/
public function getVariablesLikePattern(): string
{
return '';
}
/**
* Returns a list of available information pages with labels
*
* @return string[] The list
*/
public function getInfoPages(): array
{
return [];
}
/**
* Generates the requested information page
*
* @param string $id page id
*
* @return string html output
*/
public function getPage(string $id): string
{
if (! array_key_exists($id, $this->getInfoPages())) {
return '';
}
$id = 'getPage' . $id;
return $this->$id();
}
}
You can’t perform that action at this time.