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
|
<?php
/* vim: set expandtab sw=4 ts=4 sts=4: */
/**
* Library for extracting information about the available storage engines
*
* @version $Id$
* @package phpMyAdmin
*/
/**
* defines
*/
define('PMA_ENGINE_SUPPORT_NO', 0);
define('PMA_ENGINE_SUPPORT_DISABLED', 1);
define('PMA_ENGINE_SUPPORT_YES', 2);
define('PMA_ENGINE_SUPPORT_DEFAULT', 3);
define('PMA_ENGINE_DETAILS_TYPE_PLAINTEXT', 0);
define('PMA_ENGINE_DETAILS_TYPE_SIZE', 1);
define('PMA_ENGINE_DETAILS_TYPE_NUMERIC', 2); //Has no effect yet...
define('PMA_ENGINE_DETAILS_TYPE_BOOLEAN', 3); // 'ON' or 'OFF'
/**
* base Storage Engine Class
* @package phpMyAdmin
*/
class PMA_StorageEngine
{
/**
* @var string engine name
*/
var $engine = 'dummy';
/**
* @var string engine title/description
*/
var $title = 'PMA Dummy Engine Class';
/**
* @var string engine lang description
*/
var $comment = 'If you read this text inside phpMyAdmin, something went wrong...';
/**
* @var integer engine supported by current server
*/
var $support = PMA_ENGINE_SUPPORT_NO;
/**
* returns array of storage engines
*
* @static
* @staticvar array $storage_engines storage engines
* @access public
* @uses PMA_DBI_fetch_result()
* @return array of storage engines
*/
static public function getStorageEngines()
{
static $storage_engines = null;
if (null !== $storage_engines) {
return $storage_engines;
}
return PMA_DBI_fetch_result('SHOW STORAGE ENGINES', 'Engine');
}
/**
* returns HTML code for storage engine select box
*
* @static
* @uses PMA_StorageEngine::getStorageEngines()
* @uses strtolower()
* @uses htmlspecialchars()
* @param string $name The name of the select form element
* @param string $id The ID of the form field
* @param string $selected The selected engine
* @param boolean $offerUnavailableEngines
* Should unavailable storage engines be offered?
* @return string html selectbox
*/
static public function getHtmlSelect($name = 'engine', $id = null,
$selected = null, $offerUnavailableEngines = false)
{
$selected = strtolower($selected);
$output = '<select name="' . $name . '"'
. (empty($id) ? '' : ' id="' . $id . '"') . '>' . "\n";
foreach (PMA_StorageEngine::getStorageEngines() as $key => $details) {
if (!$offerUnavailableEngines
&& ($details['Support'] == 'NO' || $details['Support'] == 'DISABLED')) {
continue;
}
// currently (MySQL 5.1.26) there is no way we can be informed
// that PBMS does not support normal table creation so
// we use an exception here
if ('PBMS' == $details['Engine']) {
continue;
}
$output .= ' <option value="' . htmlspecialchars($key). '"'
. (empty($details['Comment'])
? '' : ' title="' . htmlspecialchars($details['Comment']) . '"')
. (strtolower($key) == $selected || (empty($selected) && $details['Support'] == 'DEFAULT')
? ' selected="selected"' : '') . '>' . "\n"
. ' ' . htmlspecialchars($details['Engine']) . "\n"
. ' </option>' . "\n";
}
$output .= '</select>' . "\n";
return $output;
}
/**
* public static final PMA_StorageEngine getEngine()
*
* Loads the corresponding engine plugin, if available.
*
* @uses str_replace()
* @uses file_exists()
* @uses PMA_StorageEngine
* @param string $engine The engine ID
* @return object The engine plugin
*/
static public function getEngine($engine)
{
$engine = str_replace('/', '', str_replace('.', '', $engine));
$engine_lowercase_filename = strtolower($engine);
if (file_exists('./libraries/engines/' . $engine_lowercase_filename . '.lib.php')
&& include_once './libraries/engines/' . $engine_lowercase_filename . '.lib.php') {
$class_name = 'PMA_StorageEngine_' . $engine;
$engine_object = new $class_name($engine);
} else {
$engine_object = new PMA_StorageEngine($engine);
}
return $engine_object;
}
/**
* return true if given engine name is supported/valid, otherwise false
*
* @static
* @uses PMA_StorageEngine::getStorageEngines()
* @param string $engine name of engine
* @return boolean whether $engine is valid or not
*/
static public function isValid($engine)
{
$storage_engines = PMA_StorageEngine::getStorageEngines();
return isset($storage_engines[$engine]);
}
/**
* returns as HTML table of the engine's server variables
*
* @uses PMA_ENGINE_DETAILS_TYPE_SIZE
* @uses PMA_ENGINE_DETAILS_TYPE_NUMERIC
* @uses PMA_StorageEngine::getVariablesStatus()
* @uses __('There is no detailed status information available for this storage engine.')
* @uses PMA_showHint()
* @uses PMA_formatByteDown()
* @uses PMA_formatNumber()
* @uses htmlspecialchars()
* @return string The table that was generated based on the retrieved information
*/
function getHtmlVariables()
{
$odd_row = false;
$ret = '';
foreach ($this->getVariablesStatus() as $details) {
$ret .= '<tr class="' . ($odd_row ? 'odd' : 'even') . '">' . "\n"
. ' <td>' . "\n";
if (!empty($details['desc'])) {
$ret .= ' ' . PMA_showHint($details['desc']) . "\n";
}
$ret .= ' </td>' . "\n"
. ' <th>' . htmlspecialchars($details['title']) . '</th>' . "\n"
. ' <td class="value">';
switch ($details['type']) {
case PMA_ENGINE_DETAILS_TYPE_SIZE:
$parsed_size = $this->resolveTypeSize($details['value']);
$ret .= $parsed_size[0] . ' ' . $parsed_size[1];
unset($parsed_size);
break;
case PMA_ENGINE_DETAILS_TYPE_NUMERIC:
$ret .= PMA_formatNumber($details['value']) . ' ';
break;
default:
$ret .= htmlspecialchars($details['value']) . ' ';
}
$ret .= '</td>' . "\n"
. '</tr>' . "\n";
$odd_row = !$odd_row;
}
if (! $ret) {
$ret = '<p>' . "\n"
. ' ' . __('There is no detailed status information available for this storage engine.') . "\n"
. '</p>' . "\n";
} else {
$ret = '<table class="data">' . "\n" . $ret . '</table>' . "\n";
}
return $ret;
}
/**
* returns the engine specific handling for
* PMA_ENGINE_DETAILS_TYPE_SIZE type variables.
*
* This function should be overridden when
* PMA_ENGINE_DETAILS_TYPE_SIZE type needs to be
* handled differently for a particular engine.
*
* @return string the formatted value and its unit
*/
function resolveTypeSize($value)
{
return PMA_formatByteDown($value);
}
/**
* returns array with detailed info about engine specific server variables
*
* @uses PMA_ENGINE_DETAILS_TYPE_PLAINTEXT
* @uses PMA_StorageEngine::getVariables()
* @uses PMA_StorageEngine::getVariablesLikePattern()
* @uses PMA_DBI_query()
* @uses PMA_DBI_fetch_assoc()
* @uses PMA_DBI_free_result()
* @return array with detailed info about specific engine server variables
*/
function getVariablesStatus()
{
$variables = $this->getVariables();
$like = $this->getVariablesLikePattern();
if ($like) {
$like = " LIKE '" . $like . "' ";
} else {
$like = '';
}
$mysql_vars = array();
$sql_query = 'SHOW GLOBAL VARIABLES ' . $like . ';';
$res = PMA_DBI_query($sql_query);
while ($row = PMA_DBI_fetch_assoc($res)) {
if (isset($variables[$row['Variable_name']])) {
$mysql_vars[$row['Variable_name']] = $variables[$row['Variable_name']];
} elseif (! $like
&& strpos(strtolower($row['Variable_name']), strtolower($this->engine)) !== 0) {
continue;
}
$mysql_vars[$row['Variable_name']]['value'] = $row['Value'];
if (empty($mysql_vars[$row['Variable_name']]['title'])) {
$mysql_vars[$row['Variable_name']]['title'] = $row['Variable_name'];
}
if (! isset($mysql_vars[$row['Variable_name']]['type'])) {
$mysql_vars[$row['Variable_name']]['type'] = PMA_ENGINE_DETAILS_TYPE_PLAINTEXT;
}
}
PMA_DBI_free_result($res);
return $mysql_vars;
}
/**
* Constructor
*
* @uses PMA_StorageEngine::getStorageEngines()
* @uses PMA_ENGINE_SUPPORT_DEFAULT
* @uses PMA_ENGINE_SUPPORT_YES
* @uses PMA_ENGINE_SUPPORT_DISABLED
* @uses PMA_ENGINE_SUPPORT_NO
* @uses $this->engine
* @uses $this->title
* @uses $this->comment
* @uses $this->support
* @param string $engine The engine ID
*/
function __construct($engine)
{
$storage_engines = PMA_StorageEngine::getStorageEngines();
if (!empty($storage_engines[$engine])) {
$this->engine = $engine;
$this->title = $storage_engines[$engine]['Engine'];
$this->comment =
(isset($storage_engines[$engine]['Comment'])
? $storage_engines[$engine]['Comment']
: '');
switch ($storage_engines[$engine]['Support']) {
case 'DEFAULT':
$this->support = PMA_ENGINE_SUPPORT_DEFAULT;
break;
case 'YES':
$this->support = PMA_ENGINE_SUPPORT_YES;
break;
case 'DISABLED':
$this->support = PMA_ENGINE_SUPPORT_DISABLED;
break;
case 'NO':
default:
$this->support = PMA_ENGINE_SUPPORT_NO;
}
}
}
/**
* public String getTitle()
*
* Reveals the engine's title
* @uses $this->title
* @return string The title
*/
function getTitle()
{
return $this->title;
}
/**
* public String getComment()
*
* Fetches the server's comment about this engine
* @uses $this->comment
* @return string The comment
*/
function getComment()
{
return $this->comment;
}
/**
* public String getSupportInformationMessage()
*
* @uses __('%s is the default storage engine on this MySQL server.')
* @uses __('%s is available on this MySQL server.')
* @uses __('%s has been disabled for this MySQL server.')
* @uses __('This MySQL server does not support the %s storage engine.')
* @uses __('This MySQL server does not support the %s storage engine.')
* @uses PMA_ENGINE_SUPPORT_DEFAULT
* @uses PMA_ENGINE_SUPPORT_YES
* @uses PMA_ENGINE_SUPPORT_DISABLED
* @uses PMA_ENGINE_SUPPORT_NO
* @uses $this->support
* @uses $this->title
* @uses sprintf
* @return string The localized message.
*/
function getSupportInformationMessage()
{
switch ($this->support) {
case PMA_ENGINE_SUPPORT_DEFAULT:
$message = __('%s is the default storage engine on this MySQL server.');
break;
case PMA_ENGINE_SUPPORT_YES:
$message = __('%s is available on this MySQL server.');
break;
case PMA_ENGINE_SUPPORT_DISABLED:
$message = __('%s has been disabled for this MySQL server.');
break;
case PMA_ENGINE_SUPPORT_NO:
default:
$message = __('This MySQL server does not support the %s storage engine.');
}
return sprintf($message, htmlspecialchars($this->title));
}
/**
* public string[][] getVariables()
*
* 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.
*
* @abstract
* @return Array The list of variables.
*/
function getVariables()
{
return array();
}
/**
* returns string with filename for the MySQL helppage
* about this storage engne
*
* @return string mysql helppage filename
*/
function getMysqlHelpPage()
{
return $this->engine . '-storage-engine';
}
/**
* public string getVariablesLikePattern()
*
* @abstract
* @return string SQL query LIKE pattern
*/
function getVariablesLikePattern()
{
return false;
}
/**
* public String[] getInfoPages()
*
* Returns a list of available information pages with labels
*
* @abstract
* @return array The list
*/
function getInfoPages()
{
return array();
}
/**
* public String getPage()
*
* Generates the requested information page
*
* @abstract
* @param string $id The page ID
*
* @return string The page
* boolean or false on error.
*/
function getPage($id)
{
return false;
}
}
?>
|