get('relation'), $container->get('export'), $container->get('transformations'), ); } return new $class(); } /** * @param string $type server|database|table|raw * @psalm-param 'server'|'database'|'table'|'raw' $type * * @return ExportPlugin[] * @psalm-return list */ public static function getExport(string $type, bool $singleTable): array { $GLOBALS['plugin_param'] = ['export_type' => $type, 'single_table' => $singleTable]; return self::getPlugins('Export'); } /** * @param string $type server|database|table * @psalm-param 'server'|'database'|'table' $type * * @return ImportPlugin[] * @psalm-return list */ public static function getImport(string $type): array { $GLOBALS['plugin_param'] = $type; return self::getPlugins('Import'); } /** * @return SchemaPlugin[] * @psalm-return list */ public static function getSchema(): array { return self::getPlugins('Schema'); } /** * Reads all plugin information * * @param string $type the type of the plugin (import, export, etc) * @psalm-param 'Export'|'Import'|'Schema' $type * * @return Plugin[] list of plugin instances * @psalm-return ( * $type is 'Export' * ? list * : ($type is 'Import' ? list : list) * ) */ private static function getPlugins(string $type): array { try { $files = new FilesystemIterator(ROOT_PATH . 'libraries/classes/Plugins/' . $type); } catch (Throwable) { return []; } $plugins = []; /** @var SplFileInfo $fileInfo */ foreach ($files as $fileInfo) { if (! $fileInfo->isReadable() || ! $fileInfo->isFile() || $fileInfo->getExtension() !== 'php') { continue; } if (! str_starts_with($fileInfo->getFilename(), $type)) { continue; } $class = sprintf('PhpMyAdmin\\Plugins\\%s\\%s', $type, $fileInfo->getBasename('.php')); if (! class_exists($class) || ! is_subclass_of($class, Plugin::class) || ! $class::isAvailable()) { continue; } if ($type === 'Export' && is_subclass_of($class, ExportPlugin::class)) { $container = Core::getContainerBuilder(); $plugins[] = new $class( $container->get('relation'), $container->get('export'), $container->get('transformations'), ); } elseif ($type === 'Import' && is_subclass_of($class, ImportPlugin::class)) { $plugins[] = new $class(); } elseif ($type === 'Schema' && is_subclass_of($class, SchemaPlugin::class)) { $plugins[] = new $class(); } } usort($plugins, static fn (Plugin $plugin1, Plugin $plugin2): int => strcasecmp( $plugin1->getProperties()->getText(), $plugin2->getProperties()->getText(), )); return $plugins; } /** * Returns locale string for $name or $name if no locale is found * * @param string|null $name for local string * * @return string locale string for $name */ public static function getString(string|null $name): string { return $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 * @psalm-param 'Export'|'Import'|'Schema' $section * * @return string html input tag option 'checked' */ public static function checkboxCheck(string $section, string $opt): string { // 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 * @psalm-param 'Export'|'Import'|'Schema' $section * * @return string default value for option $opt */ public static function getDefault(string $section, string $opt): string { 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'], $_REQUEST[$opt]) && $GLOBALS['timeout_passed']) { return htmlspecialchars($_REQUEST[$opt]); } if (! isset($GLOBALS['cfg'][$section][$opt])) { return ''; } $matches = []; /* Possibly replace localised texts */ if (! preg_match_all('/(str[A-Z][A-Za-z0-9]*)/', (string) $GLOBALS['cfg'][$section][$opt], $matches)) { return htmlspecialchars((string) $GLOBALS['cfg'][$section][$opt]); } $val = $GLOBALS['cfg'][$section][$opt]; foreach ($matches[0] as $match) { if (! isset($GLOBALS[$match])) { continue; } $val = str_replace($match, $GLOBALS[$match], $val); } return htmlspecialchars($val); } /** * @param ExportPlugin[]|ImportPlugin[]|SchemaPlugin[] $list * * @return array> * @psalm-return list */ public static function getChoice(array $list, string $default): array { $return = []; foreach ($list as $plugin) { $pluginName = $plugin->getName(); $properties = $plugin->getProperties(); $return[] = [ 'name' => $pluginName, 'text' => self::getString($properties->getText()), 'is_selected' => $pluginName === $default, 'is_binary' => $properties->getForceFile(), ]; } return $return; } /** * 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 OptionsPropertyItem $propertyGroup options property main group instance * @param bool $is_subgroup if this group is a subgroup * @psalm-param 'Export'|'Import'|'Schema' $section * * @return string table row with option */ private static function getOneOption( string $section, string $plugin_name, OptionsPropertyItem $propertyGroup, bool $is_subgroup = false, ): string { $ret = "\n"; $properties = null; if (! $is_subgroup) { // for subgroup headers if (mb_strpos($propertyGroup::class, 'PropertyItem')) { $properties = [$propertyGroup]; } else { // for main groups $ret .= '
'; $text = null; if (method_exists($propertyGroup, 'getText')) { $text = $propertyGroup->getText(); } if ($text != null) { $ret .= '
' . self::getString($text) . '
'; } $ret .= '
    '; } } $not_subgroup_header = false; if ($properties === null) { $not_subgroup_header = true; if ($propertyGroup instanceof OptionsPropertyGroup) { $properties = $propertyGroup->getProperties(); } } $property_class = null; if ($properties !== null) { /** @var OptionsPropertySubgroup $propertyItem */ foreach ($properties as $propertyItem) { $property_class = $propertyItem::class; // 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|null $subgroup_header */ $subgroup_header = $propertyItem->getSubgroupHeader(); if ($subgroup_header !== null) { $ret .= self::getOneOption($section, $plugin_name, $subgroup_header); } $ret .= '
    • 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 .= '
    • '; } elseif ($not_subgroup_header) { // end main group $ret .= '
'; } if (method_exists($propertyGroup, 'getDoc')) { $doc = $propertyGroup->getDoc(); if (is_array($doc)) { if (count($doc) === 3) { $ret .= MySQLDocumentation::show($doc[1], false, null, null, $doc[2]); } elseif (count($doc) === 1) { $ret .= MySQLDocumentation::showDocumentation('faq', $doc[0]); } else { $ret .= MySQLDocumentation::show($doc[1]); } } } // Close the list element after $doc link is displayed if ( $property_class === BoolPropertyItem::class || $property_class === MessageOnlyPropertyItem::class || $property_class === SelectPropertyItem::class || $property_class === TextPropertyItem::class ) { $ret .= ''; } return $ret . "\n"; } /** * 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 * @psalm-param 'Export'|'Import'|'Schema' $section */ public static function getHtmlForProperty( string $section, string $plugin_name, OptionsPropertyItem $propertyItem, ): string { $ret = ''; $property_class = $propertyItem::class; switch ($property_class) { case BoolPropertyItem::class: $ret .= '
  • ' . "\n"; $ret .= '
    ' . "\n"; $ret .= '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 .= '
    '; break; case DocPropertyItem::class: echo DocPropertyItem::class; break; case HiddenPropertyItem::class: $ret .= '
    • '; break; case MessageOnlyPropertyItem::class: $ret .= '
  • ' . "\n"; $ret .= self::getString($propertyItem->getText()); break; case RadioPropertyItem::class: /** @var RadioPropertyItem $pitem */ $pitem = $propertyItem; $default = self::getDefault( $section, $plugin_name . '_' . $pitem->getName(), ); $ret .= '
  • '; foreach ($pitem->getValues() as $key => $val) { $ret .= '
    getName() . '_' . $key . '">' . self::getString($val) . '
    '; } $ret .= '
    • '; break; case SelectPropertyItem::class: /** @var SelectPropertyItem $pitem */ $pitem = $propertyItem; $ret .= '
  • ' . "\n"; $ret .= ''; $ret .= ''; break; case TextPropertyItem::class: /** @var TextPropertyItem $pitem */ $pitem = $propertyItem; $ret .= '
  • ' . "\n"; $ret .= ''; $ret .= 'getSize() !== 0 ? ' size="' . $pitem->getSize() . '"' : '') . ($pitem->getLen() !== 0 ? ' maxlength="' . $pitem->getLen() . '"' : '') . '>'; break; case NumberPropertyItem::class: $ret .= '
  • ' . "\n"; $ret .= ''; $ret .= ''; 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 ExportPlugin[]|ImportPlugin[]|SchemaPlugin[] $list array with plugin instances * @psalm-param 'Export'|'Import'|'Schema' $section * * @return string html fieldset with plugin options */ public static function getOptions(string $section, array $list): string { $ret = ''; // Options for plugins that support them foreach ($list as $plugin) { $properties = $plugin->getProperties(); $text = $properties->getText(); $options = $properties->getOptions(); $plugin_name = $plugin->getName(); $ret .= '
    '; $ret .= '

    ' . self::getString($text) . '

    '; $no_options = true; if ($options !== null && count($options) > 0) { foreach ($options->getProperties() as $propertyMainGroup) { // check for hidden properties $no_options = true; foreach ($propertyMainGroup->getProperties() as $propertyItem) { if (! ($propertyItem instanceof HiddenPropertyItem)) { $no_options = false; break; } } $ret .= self::getOneOption($section, $plugin_name, $propertyMainGroup); } } if ($no_options) { $ret .= '

    ' . __('This format has no options') . '

    '; } $ret .= '
    '; } return $ret; } }