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
<?php
/* vim: set expandtab sw=4 ts=4 sts=4: */
/**
* Generic plugin interface.
*
* @package PhpMyAdmin
*/
namespace PhpMyAdmin;
use PhpMyAdmin\Properties\Options\Groups\OptionsPropertySubgroup;
use PhpMyAdmin\Properties\Options\OptionsPropertyItem;
use PhpMyAdmin\Properties\Plugins\ExportPluginProperties;
use PhpMyAdmin\Properties\Plugins\PluginPropertyItem;
use PhpMyAdmin\Properties\Plugins\SchemaPluginProperties;
/**
* PhpMyAdmin\Plugins class
*
* @package PhpMyAdmin
*/
class Plugins
{
/**
* Includes and instantiates the specified plugin type for a certain format
*
* @param string $plugin_type the type of the plugin (import, export, etc)
* @param string $plugin_format the format of the plugin (sql, xml, et )
* @param string $plugins_dir directory with plugins
* @param mixed $plugin_param parameter to plugin by which they can
* decide whether they can work
*
* @return object|null new plugin instance
*/
public static function getPlugin(
$plugin_type,
$plugin_format,
$plugins_dir,
$plugin_param = false
) {
$GLOBALS['plugin_param'] = $plugin_param;
$class_name = mb_strtoupper($plugin_type[0])
. mb_strtolower(mb_substr($plugin_type, 1))
. mb_strtoupper($plugin_format[0])
. mb_strtolower(mb_substr($plugin_format, 1));
$file = $class_name . ".php";
if (is_file($plugins_dir . $file)) {
//include_once $plugins_dir . $file;
$fqnClass = 'PhpMyAdmin\\' . str_replace('/', '\\', mb_substr($plugins_dir, 18)) . $class_name;
// check if class exists, could be caused by skip_import
if (class_exists($fqnClass)) {
return new $fqnClass;
}
}
return null;
}
/**
* Reads all plugin information from directory $plugins_dir
*
* @param string $plugin_type the type of the plugin (import, export, etc)
* @param string $plugins_dir directory with plugins
* @param mixed $plugin_param parameter to plugin by which they can
* decide whether they can work
*
* @return array list of plugin instances
*/
public static function getPlugins($plugin_type, $plugins_dir, $plugin_param)
{
$GLOBALS['plugin_param'] = $plugin_param;
/* Scan for plugins */
$plugin_list = array();
if (!($handle = @opendir($plugins_dir))) {
return $plugin_list;
}
$namespace = 'PhpMyAdmin\\' . str_replace('/', '\\', mb_substr($plugins_dir, 18));
$class_type = mb_strtoupper($plugin_type[0], 'UTF-8')
. mb_strtolower(mb_substr($plugin_type, 1), 'UTF-8');
$prefix_class_name = $namespace . $class_type;
while ($file = @readdir($handle)) {
// In some situations, Mac OS creates a new file for each file
// (for example ._csv.php) so the following regexp
// matches a file which does not start with a dot but ends
// with ".php"
if (is_file($plugins_dir . $file)
&& preg_match(
'@^' . $class_type . '([^\.]+)\.php$@i',
$file,
$matches
)
) {
$GLOBALS['skip_import'] = false;
include_once $plugins_dir . $file;
if (! $GLOBALS['skip_import']) {
$class_name = $prefix_class_name . $matches[1];
$plugin = new $class_name;
if (null !== $plugin->getProperties()) {
$plugin_list[] = $plugin;
}
}
}
}
usort($plugin_list, function($cmp_name_1, $cmp_name_2) {
return strcasecmp(
$cmp_name_1->getProperties()->getText(),
$cmp_name_2->getProperties()->getText()
);
});
return $plugin_list;
}
/**
* Returns locale string for $name or $name if no locale is found
*
* @param string $name for local string
*
* @return string locale string for $name
*/
public static function getString($name)
{
return isset($GLOBALS[$name]) ? $GLOBALS[$name] : $name;
}
/**
* Returns html input tag option 'checked' if plugin $opt
* should be set by config or request
*
* @param string $section name of config section in
* $GLOBALS['cfg'][$section] for plugin
* @param string $opt name of option
*
* @return string html input tag option 'checked'
*/
public static function checkboxCheck($section, $opt)
{
// If the form is being repopulated using $_GET data, that is priority
if (isset($_GET[$opt])
|| ! isset($_GET['repopulate'])
&& ((! empty($GLOBALS['timeout_passed']) && isset($_REQUEST[$opt]))
|| ! empty($GLOBALS['cfg'][$section][$opt]))
) {
return ' checked="checked"';
}
return '';
}
/**
* Returns default value for option $opt
*
* @param string $section name of config section in
* $GLOBALS['cfg'][$section] for plugin
* @param string $opt name of option
*
* @return string default value for option $opt
*/
public static function getDefault($section, $opt)
{
if (isset($_GET[$opt])) {
// If the form is being repopulated using $_GET data, that is priority
return htmlspecialchars($_GET[$opt]);
}
if (isset($GLOBALS['timeout_passed'])
&& $GLOBALS['timeout_passed']
&& isset($_REQUEST[$opt])
) {
return htmlspecialchars($_REQUEST[$opt]);
}
if (!isset($GLOBALS['cfg'][$section][$opt])) {
return '';
}
$matches = array();
/* Possibly replace localised texts */
if (!preg_match_all(
'/(str[A-Z][A-Za-z0-9]*)/',
$GLOBALS['cfg'][$section][$opt],
$matches
)) {
return htmlspecialchars($GLOBALS['cfg'][$section][$opt]);
}
$val = $GLOBALS['cfg'][$section][$opt];
foreach ($matches[0] as $match) {
if (isset($GLOBALS[$match])) {
$val = str_replace($match, $GLOBALS[$match], $val);
}
}
return htmlspecialchars($val);
}
/**
* Returns html select form element for plugin choice
* and hidden fields denoting whether each plugin must be exported as a file
*
* @param string $section name of config section in
* $GLOBALS['cfg'][$section] for plugin
* @param string $name name of select element
* @param array &$list array with plugin instances
* @param string $cfgname name of config value, if none same as $name
*
* @return string html select tag
*/
public static function getChoice($section, $name, array $list, $cfgname = null)
{
if (! isset($cfgname)) {
$cfgname = $name;
}
$ret = '<select id="plugins" name="' . $name . '">';
$default = self::getDefault($section, $cfgname);
$hidden = null;
foreach ($list as $plugin) {
$elem = explode('\\', get_class($plugin));
$plugin_name = array_pop($elem);
unset($elem);
$plugin_name = mb_strtolower(
mb_substr(
$plugin_name,
mb_strlen($section)
)
);
$ret .= '<option';
// If the form is being repopulated using $_GET data, that is priority
if (isset($_GET[$name])
&& $plugin_name == $_GET[$name]
|| ! isset($_GET[$name])
&& $plugin_name == $default
) {
$ret .= ' selected="selected"';
}
/** @var PluginPropertyItem $properties */
$properties = $plugin->getProperties();
$text = null;
if ($properties != null) {
$text = $properties->getText();
}
$ret .= ' value="' . $plugin_name . '">'
. self::getString($text)
. '</option>' . "\n";
// Whether each plugin has to be saved as a file
$hidden .= '<input type="hidden" id="force_file_' . $plugin_name
. '" value="';
/** @var ExportPluginProperties|SchemaPluginProperties $properties */
$properties = $plugin->getProperties();
if (! strcmp($section, 'Import')
|| ($properties != null && $properties->getForceFile() != null)
) {
$hidden .= 'true';
} else {
$hidden .= 'false';
}
$hidden .= '" />' . "\n";
}
$ret .= '</select>' . "\n" . $hidden;
return $ret;
}
/**
* Returns single option in a list element
*
* @param string $section name of config section in $GLOBALS['cfg'][$section] for plugin
* @param string $plugin_name unique plugin name
* @param array|\PhpMyAdmin\Properties\PropertyItem &$propertyGroup options property main group instance
* @param boolean $is_subgroup if this group is a subgroup
*
* @return string table row with option
*/
public static function getOneOption(
$section,
$plugin_name,
&$propertyGroup,
$is_subgroup = false
) {
$ret = "\n";
if (! $is_subgroup) {
// for subgroup headers
if (mb_strpos(get_class($propertyGroup), "PropertyItem")) {
$properties = array($propertyGroup);
} else {
// for main groups
$ret .= '<div class="export_sub_options" id="' . $plugin_name . '_'
. $propertyGroup->getName() . '">';
if (method_exists($propertyGroup, 'getText')) {
$text = $propertyGroup->getText();
}
if ($text != null) {
$ret .= '<h4>' . self::getString($text) . '</h4>';
}
$ret .= '<ul>';
}
}
if (! isset($properties)) {
$not_subgroup_header = true;
if (method_exists($propertyGroup, 'getProperties')) {
$properties = $propertyGroup->getProperties();
}
}
if (isset($properties)) {
/** @var OptionsPropertySubgroup $propertyItem */
foreach ($properties as $propertyItem) {
$property_class = get_class($propertyItem);
// if the property is a subgroup, we deal with it recursively
if (mb_strpos($property_class, "Subgroup")) {
// for subgroups
// each subgroup can have a header, which may also be a form element
/** @var OptionsPropertyItem $subgroup_header */
$subgroup_header = $propertyItem->getSubgroupHeader();
if (isset($subgroup_header)) {
$ret .= self::getOneOption(
$section,
$plugin_name,
$subgroup_header
);
}
$ret .= '<li class="subgroup"><ul';
if (isset($subgroup_header)) {
$ret .= ' id="ul_' . $subgroup_header->getName() . '">';
} else {
$ret .= '>';
}
$ret .= self::getOneOption(
$section,
$plugin_name,
$propertyItem,
true
);
continue;
}
// single property item
$ret .= self::getHtmlForProperty(
$section, $plugin_name, $propertyItem
);
}
}
if ($is_subgroup) {
// end subgroup
$ret .= '</ul></li>';
} else {
// end main group
if (! empty($not_subgroup_header)) {
$ret .= '</ul></div>';
}
}
if (method_exists($propertyGroup, "getDoc")) {
$doc = $propertyGroup->getDoc();
if ($doc != null) {
if (count($doc) == 3) {
$ret .= PhpMyAdmin\Util::showMySQLDocu(
$doc[1],
false,
$doc[2]
);
} elseif (count($doc) == 1) {
$ret .= PhpMyAdmin\Util::showDocu('faq', $doc[0]);
} else {
$ret .= PhpMyAdmin\Util::showMySQLDocu(
$doc[1]
);
}
}
}
// Close the list element after $doc link is displayed
if (isset($property_class)) {
if ($property_class == 'PhpMyAdmin\Properties\Options\Items\BoolPropertyItem'
|| $property_class == 'PhpMyAdmin\Properties\Options\Items\MessageOnlyPropertyItem'
|| $property_class == 'PhpMyAdmin\Properties\Options\Items\SelectPropertyItem'
|| $property_class == 'PhpMyAdmin\Properties\Options\Items\TextPropertyItem'
) {
$ret .= '</li>';
}
}
$ret .= "\n";
return $ret;
}
/**
* Get HTML for properties items
*
* @param string $section name of config section in
* $GLOBALS['cfg'][$section] for plugin
* @param string $plugin_name unique plugin name
* @param OptionsPropertyItem $propertyItem Property item
*
* @return string
*/
public static function getHtmlForProperty(
$section, $plugin_name, $propertyItem
) {
$ret = null;
$property_class = get_class($propertyItem);
switch ($property_class) {
case 'PhpMyAdmin\Properties\Options\Items\BoolPropertyItem':
$ret .= '<li>' . "\n";
$ret .= '<input type="checkbox" name="' . $plugin_name . '_'
. $propertyItem->getName() . '"'
. ' value="something" id="checkbox_' . $plugin_name . '_'
. $propertyItem->getName() . '"'
. ' '
. self::checkboxCheck(
$section,
$plugin_name . '_' . $propertyItem->getName()
);
if ($propertyItem->getForce() != null) {
// Same code is also few lines lower, update both if needed
$ret .= ' onclick="if (!this.checked && '
. '(!document.getElementById(\'checkbox_' . $plugin_name
. '_' . $propertyItem->getForce() . '\') '
. '|| !document.getElementById(\'checkbox_'
. $plugin_name . '_' . $propertyItem->getForce()
. '\').checked)) '
. 'return false; else return true;"';
}
$ret .= ' />';
$ret .= '<label for="checkbox_' . $plugin_name . '_'
. $propertyItem->getName() . '">'
. self::getString($propertyItem->getText()) . '</label>';
break;
case 'PhpMyAdmin\Properties\Options\Items\DocPropertyItem':
echo 'PhpMyAdmin\Properties\Options\Items\DocPropertyItem';
break;
case 'PhpMyAdmin\Properties\Options\Items\HiddenPropertyItem':
$ret .= '<li><input type="hidden" name="' . $plugin_name . '_'
. $propertyItem->getName() . '"'
. ' value="' . self::getDefault(
$section,
$plugin_name . '_' . $propertyItem->getName()
)
. '"' . ' /></li>';
break;
case 'PhpMyAdmin\Properties\Options\Items\MessageOnlyPropertyItem':
$ret .= '<li>' . "\n";
$ret .= '<p>' . self::getString($propertyItem->getText()) . '</p>';
break;
case 'PhpMyAdmin\Properties\Options\Items\RadioPropertyItem':
$default = self::getDefault(
$section,
$plugin_name . '_' . $propertyItem->getName()
);
foreach ($propertyItem->getValues() as $key => $val) {
$ret .= '<li><input type="radio" name="' . $plugin_name
. '_' . $propertyItem->getName() . '" value="' . $key
. '" id="radio_' . $plugin_name . '_'
. $propertyItem->getName() . '_' . $key . '"';
if ($key == $default) {
$ret .= ' checked="checked"';
}
$ret .= ' />' . '<label for="radio_' . $plugin_name . '_'
. $propertyItem->getName() . '_' . $key . '">'
. self::getString($val) . '</label></li>';
}
break;
case 'PhpMyAdmin\Properties\Options\Items\SelectPropertyItem':
$ret .= '<li>' . "\n";
$ret .= '<label for="select_' . $plugin_name . '_'
. $propertyItem->getName() . '" class="desc">'
. self::getString($propertyItem->getText()) . '</label>';
$ret .= '<select name="' . $plugin_name . '_'
. $propertyItem->getName() . '"'
. ' id="select_' . $plugin_name . '_'
. $propertyItem->getName() . '">';
$default = self::getDefault(
$section,
$plugin_name . '_' . $propertyItem->getName()
);
foreach ($propertyItem->getValues() as $key => $val) {
$ret .= '<option value="' . $key . '"';
if ($key == $default) {
$ret .= ' selected="selected"';
}
$ret .= '>' . self::getString($val) . '</option>';
}
$ret .= '</select>';
break;
case 'PhpMyAdmin\Properties\Options\Items\TextPropertyItem':
case 'PhpMyAdmin\Properties\Options\Items\NumberPropertyItem':
$ret .= '<li>' . "\n";
$ret .= '<label for="text_' . $plugin_name . '_'
. $propertyItem->getName() . '" class="desc">'
. self::getString($propertyItem->getText()) . '</label>';
$ret .= '<input type="text" name="' . $plugin_name . '_'
. $propertyItem->getName() . '"'
. ' value="' . self::getDefault(
$section,
$plugin_name . '_' . $propertyItem->getName()
) . '"'
. ' id="text_' . $plugin_name . '_'
. $propertyItem->getName() . '"'
. ($propertyItem->getSize() != null
? ' size="' . $propertyItem->getSize() . '"'
: '')
. ($propertyItem->getLen() != null
? ' maxlength="' . $propertyItem->getLen() . '"'
: '')
. ' />';
break;
default:
break;
}
return $ret;
}
/**
* Returns html div with editable options for plugin
*
* @param string $section name of config section in $GLOBALS['cfg'][$section]
* @param array &$list array with plugin instances
*
* @return string html fieldset with plugin options
*/
public static function getOptions($section, array $list)
{
$ret = '';
// Options for plugins that support them
foreach ($list as $plugin) {
$properties = $plugin->getProperties();
if ($properties != null) {
$text = $properties->getText();
$options = $properties->getOptions();
}
$elem = explode('\\', get_class($plugin));
$plugin_name = array_pop($elem);
unset($elem);
$plugin_name = mb_strtolower(
mb_substr(
$plugin_name,
mb_strlen($section)
)
);
$ret .= '<div id="' . $plugin_name
. '_options" class="format_specific_options">';
$ret .= '<h3>' . self::getString($text) . '</h3>';
$no_options = true;
if (! is_null($options) && count($options) > 0) {
foreach ($options->getProperties()
as $propertyMainGroup
) {
// check for hidden properties
$no_options = true;
foreach ($propertyMainGroup->getProperties() as $propertyItem) {
if (strcmp('PhpMyAdmin\Properties\Options\Items\HiddenPropertyItem', get_class($propertyItem))) {
$no_options = false;
break;
}
}
$ret .= self::getOneOption(
$section,
$plugin_name,
$propertyMainGroup
);
}
}
if ($no_options) {
$ret .= '<p>' . __('This format has no options') . '</p>';
}
$ret .= '</div>';
}
return $ret;
}
}