gian/phpmyadmin
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

plugins and OOP: create general class structure and ExportXML

Browse Source
This commit is contained in:
Alex Marin 2012-05-10 15:48:43 +03:00
parent 35c0fe5b8d
commit a87f283a23
14 changed files with 1313 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
export.php
View File

@ -22,9 +22,11 @@ foreach ($_POST as $one_post_param => $one_post_value) {
PMA_checkParameters(array('what', 'export_type'));
// Scan plugins
$export_list = PMA_getPlugins(
'libraries/export/',
// export class instance, not array of properties, as before
$export_plugin = PMA_getPlugin(
"export",
$what,
'libraries/plugins/export/',
array(
'export_type' => $export_type,
'single_table' => isset($single_table)
@ -35,8 +37,10 @@ $export_list = PMA_getPlugins(
$type = $what;
// Check export type
if (! isset($export_list[$type])) {
if (! isset($export_plugin)) {
PMA_fatalError(__('Bad type!'));
} else {
$export_plugin_properties = $export_plugin->getProperties();
}
/**
@ -83,7 +87,8 @@ if ($_REQUEST['output_format'] == 'astext') {
}
// Does export require to be into file?
if (isset($export_list[$type]['force_file']) && ! $asfile) {
if (isset($export_plugin_properties['force_file']) && ! $asfile) {
$message = PMA_Message::error(__('Selected export type has to be saved in file!'));
include_once 'libraries/header.inc.php';
if ($export_type == 'server') {
@ -297,13 +302,13 @@ if ($asfile) {
// Grab basic dump extension and mime type
// Check if the user already added extension; get the substring where the extension would be if it was included
$extension_start_pos = strlen($filename) - strlen($export_list[$type]['extension']) - 1;
$extension_start_pos = strlen($filename) - strlen($export_plugin_properties['extension']) - 1;
$user_extension = substr($filename, $extension_start_pos, strlen($filename));
$required_extension = "." . $export_list[$type]['extension'];
$required_extension = "." . $export_plugin_properties['extension'];
if (strtolower($user_extension) != $required_extension) {
$filename .= $required_extension;
}
$mime_type = $export_list[$type]['mime_type'];
$mime_type = $export_plugin_properties['mime_type'];
// If dump is going to be compressed, set correct mime_type and add
// compression to extension
@ -424,7 +429,7 @@ if (!$save_on_server) {
do {
// Add possibly some comments to export
if (!PMA_exportHeader()) {
if (! $export_plugin->exportHeader($db)) {
break;
}
@ -456,10 +461,10 @@ do {
if ((isset($tmp_select) && strpos(' ' . $tmp_select, '|' . $current_db . '|'))
|| ! isset($tmp_select)
) {
if (!PMA_exportDBHeader($current_db)) {
if (! $export_plugin->exportDBHeader($current_db)) {
break 2;
}
if (!PMA_exportDBCreate($current_db)) {
if (! $export_plugin->exportDBCreate($current_db)) {
break 2;
}
if (function_exists('PMA_exportRoutines') && strpos($GLOBALS['sql_structure_or_data'], 'structure') !== false && isset($GLOBALS['sql_procedure_function'])) {
@ -489,7 +494,7 @@ do {
// if this is a view or a merge table, don't export data
if (($GLOBALS[$what . '_structure_or_data'] == 'data' || $GLOBALS[$what . '_structure_or_data'] == 'structure_and_data') && !($is_view || PMA_Table::isMerge($current_db, $table))) {
$local_query = 'SELECT * FROM ' . PMA_backquote($current_db) . '.' . PMA_backquote($table);
if (!PMA_exportData($current_db, $table, $crlf, $err_url, $local_query)) {
if (! $export_plugin->exportData($current_db, $table, $crlf, $err_url, $local_query)) {
break 3;
}
}
@ -555,7 +560,7 @@ do {
// if this is a view or a merge table, don't export data
if (($GLOBALS[$what . '_structure_or_data'] == 'data' || $GLOBALS[$what . '_structure_or_data'] == 'structure_and_data') && !($is_view || PMA_Table::isMerge($db, $table))) {
$local_query = 'SELECT * FROM ' . PMA_backquote($db) . '.' . PMA_backquote($table);
if (!PMA_exportData($db, $table, $crlf, $err_url, $local_query)) {
if (! $export_plugin->exportData($db, $table, $crlf, $err_url, $local_query)) {
break 2;
}
}
@ -626,7 +631,7 @@ do {
} else {
$local_query = 'SELECT * FROM ' . PMA_backquote($db) . '.' . PMA_backquote($table) . $add_query;
}
if (!PMA_exportData($db, $table, $crlf, $err_url, $local_query)) {
if (! $export_plugin->exportData($db, $table, $crlf, $err_url, $local_query)) {
break;
}
}
@ -641,11 +646,11 @@ do {
break 2;
}
}
if (!PMA_exportDBFooter($db)) {
if (! $export_plugin->exportDBFooter($db)) {
break;
}
}
if (!PMA_exportFooter()) {
if (! $export_plugin->exportFooter()) {
break;
}

15
import.php
View File

@ -409,13 +409,20 @@ if (! $error && isset($skip)) {
if (! $error) {
// Check for file existance
if (!file_exists('libraries/import/' . $format . '.php')) {
require_once("libraries/plugin_interface.lib.php");
$import_plugin = PMA_getPlugin(
"import",
$format,
'libraries/plugins/import/'
);
if ($import_plugin == null) {
$error = true;
$message = PMA_Message::error(__('Could not load import plugins, please check your installation!'));
$message = PMA_Message::error(
__('Could not load import plugins, please check your installation!')
);
} else {
// Do the real import
$plugin_param = $import_type;
include 'libraries/import/' . $format . '.php';
$import_plugin->doImport();
}
}

9
libraries/common.lib.php
View File

@ -3337,16 +3337,19 @@ function PMA_selectUploadFile($import_list, $uploaddir)
)
. '</label>';
$extensions = '';
foreach ($import_list as $val) {
foreach ($import_list as $plugin) {
$properties = $plugin->getProperties();
if (! empty($extensions)) {
$extensions .= '|';
}
$extensions .= $val['extension'];
$extensions .= $properties['extension'];
}
$matcher = '@\.(' . $extensions . ')(\.('
. PMA_supportedDecompressions() . '))?$@';
$active = (isset($GLOBALS['timeout_passed']) && $GLOBALS['timeout_passed'] && isset($local_import_file))
$active = (isset($GLOBALS['timeout_passed'])
&& $GLOBALS['timeout_passed']
&& isset($local_import_file))
? $local_import_file
: '';
$files = PMA_getFileSelectOptions(

13
libraries/display_export.lib.php
View File

@ -33,11 +33,20 @@ function PMA_exportIsActive($what, $val)
}
/* Scan for plugins */
$export_list = PMA_getPlugins('./libraries/export/', array('export_type' => $export_type, 'single_table' => isset($single_table)));
$export_list = PMA_getPlugins(
"export",
'libraries/plugins/export/',
array(
'export_type' => $export_type,
'single_table' => isset($single_table)
)
);
/* Fail if we didn't find any plugin */
if (empty($export_list)) {
PMA_Message::error(__('Could not load export plugins, please check your installation!'))->display();
PMA_Message::error(__(
'Could not load export plugins, please check your installation!'
))->display();
include './libraries/footer.inc.php';
}
?>

10
libraries/display_import.lib.php
View File

@ -16,11 +16,17 @@ require_once './libraries/plugin_interface.lib.php';
require_once './libraries/display_import_ajax.lib.php';
/* Scan for plugins */
$import_list = PMA_getPlugins('./libraries/import/', $import_type);
$import_list = PMA_getPlugins(
"import",
'libraries/plugins/import/',
$import_type
);
/* Fail if we didn't find any plugin */
if (empty($import_list)) {
PMA_Message::error(__('Could not load import plugins, please check your installation!'))->display();
PMA_Message::error(__(
'Could not load import plugins, please check your installation!'
))->display();
include './libraries/footer.inc.php';
}
?>

4
libraries/import.lib.php
View File

@ -316,7 +316,9 @@ function PMA_importGetNextChunk($size = 32768)
if (strncmp($result, "\xEF\xBB\xBF", 3) == 0) {
$result = substr($result, 3);
// UTF-16 BE, LE
} elseif (strncmp($result, "\xFE\xFF", 2) == 0 || strncmp($result, "\xFF\xFE", 2) == 0) {
} elseif (strncmp($result, "\xFE\xFF", 2) == 0
|| strncmp($result, "\xFF\xFE", 2) == 0
) {
$result = substr($result, 2);
}
}

98
libraries/plugin_interface.lib.php
View File

@ -7,15 +7,41 @@
*/
/**
* Reads all plugin information from directory $plugins_dir.
* Includes and instantiates the specified plugin type for a certain format
*
* @param string $plugins_dir directrory with plugins
* @param mixed $plugin_param parameter to plugin by which they can
* decide whether they can work
* @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 directrory with plugins
* @param mixed $plugin_param parameter to plugin by which they can
* decide whether they can work
*
* @return array list of plugins
* @return new plugin instance
*/
function PMA_getPlugins($plugins_dir, $plugin_param)
function PMA_getPlugin($plugin_type, $plugin_format, $plugins_dir, $plugin_param = false)
{
// todo replace strtoupper with CamelCaps (ex: HtmlWord)
$class_name = strtoupper($plugin_type[0])
. strtolower(substr($plugin_type, 1))
. strtoupper($plugin_format);
$file = $class_name . ".class.php";
if (is_file($plugins_dir . $file)) {
include_once $plugins_dir . $file;
return new $class_name;
}
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 directrory with plugins
* @param mixed $plugin_param parameter to plugin by which they can
* decide whether they can work
*
* @return array list of plugin instances
*/
function PMA_getPlugins($plugin_type, $plugins_dir, $plugin_param)
{
/* Scan for plugins */
$plugin_list = array();
@ -25,8 +51,18 @@ function PMA_getPlugins($plugins_dir, $plugin_param)
// (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('@^[^\.](.)*\.php$@i', $file)) {
$class_type = strtoupper($plugin_type[0])
. strtolower(substr($plugin_type, 1));
if (is_file($plugins_dir . $file)
&& preg_match(
'@^' . $class_type . '(.+)\.class\.php$@i',
$file,
$matches
)
) {
include_once $plugins_dir . $file;
$class_name = $class_type . $matches[1];
$plugin_list [] = new $class_name;
}
}
}
@ -61,8 +97,11 @@ function PMA_pluginCheckboxCheck($section, $opt)
// If the form is being repopulated using $_GET data, that is priority
if (isset($_GET[$opt])
|| ! isset($_GET['repopulate'])
&& ((isset($GLOBALS['timeout_passed']) && $GLOBALS['timeout_passed'] && isset($_REQUEST[$opt]))
|| (isset($GLOBALS['cfg'][$section][$opt]) && $GLOBALS['cfg'][$section][$opt]))
&& ((isset($GLOBALS['timeout_passed'])
&& $GLOBALS['timeout_passed']
&& isset($_REQUEST[$opt]))
|| (isset($GLOBALS['cfg'][$section][$opt])
&& $GLOBALS['cfg'][$section][$opt]))
) {
return ' checked="checked"';
}
@ -109,7 +148,7 @@ function PMA_pluginGetDefault($section, $opt)
* @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 configuration defined in plugin file
* @param array &$list array with plugin instances
* @param string $cfgname name of config value, if none same as $name
*
* @return string html select tag
@ -121,20 +160,30 @@ function PMA_pluginGetChoice($section, $name, &$list, $cfgname = null)
}
$ret = '<select id="plugins" name="' . $name . '">';
$default = PMA_pluginGetDefault($section, $cfgname);
foreach ($list as $plugin_name => $val) {
foreach ($list as $plugin) {
$plugin_name = strtolower(substr(get_class($plugin), strlen($section)));
$properties = $plugin->getProperties();
$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) {
if (isset($_GET[$name])
&& $plugin_name == $_GET[$name]
|| ! isset($_GET[$name])
&& $plugin_name == $default
) {
$ret .= ' selected="selected"';
}
$ret .= ' value="' . $plugin_name . '">' . PMA_getString($val['text']) . '</option>' . "\n";
$ret .= ' value="' . $plugin_name . '">'
. PMA_getString($properties['text'])
. '</option>' . "\n";
}
$ret .= '</select>' . "\n";
// Whether each plugin has to be saved as a file
foreach ($list as $plugin_name => $val) {
foreach ($list as $plugin) {
$plugin_name = strtolower(substr(get_class($plugin), strlen($section)));
$properties = $plugin->getProperties();
$ret .= '<input type="hidden" id="force_file_' . $plugin_name . '" value="';
if (isset($val['force_file'])) {
if (isset($properties['force_file'])) {
$ret .= 'true';
} else {
$ret .= 'false';
@ -259,7 +308,7 @@ function PMA_pluginGetOneOption($section, $plugin_name, $id, &$opt)
* 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 configuration defined in plugin file
* @param array &$list array with plugin instances
*
* @return string html fieldset with plugin options
*/
@ -268,13 +317,20 @@ function PMA_pluginGetOptions($section, &$list)
$ret = '';
$default = PMA_pluginGetDefault('Export', 'format');
// Options for plugins that support them
foreach ($list as $plugin_name => $val) {
foreach ($list as $plugin) {
$plugin_name = strtolower(substr(get_class($plugin), strlen($section)));
$properties = $plugin->getProperties();
$ret .= '<div id="' . $plugin_name . '_options" class="format_specific_options">';
$count = 0;
$ret .= '<h3>' . PMA_getString($val['text']) . '</h3>';
if (isset($val['options']) && count($val['options']) > 0) {
foreach ($val['options'] as $id => $opt) {
if ($opt['type'] != 'hidden' && $opt['type'] != 'begin_group' && $opt['type'] != 'end_group' && $opt['type'] != 'begin_subgroup' && $opt['type'] != 'end_subgroup') {
$ret .= '<h3>' . PMA_getString($properties['text']) . '</h3>';
if (isset($properties['options']) && count($properties['options']) > 0) {
foreach ($properties['options'] as $id => $opt) {
if ($opt['type'] != 'hidden'
&& $opt['type'] != 'begin_group'
&& $opt['type'] != 'end_group'
&& $opt['type'] != 'begin_subgroup'
&& $opt['type'] != 'end_subgroup'
) {
$count++;
}
$ret .= PMA_pluginGetOneOption($section, $plugin_name, $id, $opt);

51
libraries/plugins/AuthenticationPlugin.class.php Normal file
View File

@ -0,0 +1,51 @@
<?php
/* vim: set expandtab sw=4 ts=4 sts=4: */
/**
* Abstract class for the authentication plugins
*
* @package PhpMyAdmin
*/
if (! defined('PHPMYADMIN')) {
exit;
}
/* This class extends the PluginObserver class */
require_once "PluginObserver.class.php";
/**
* Provides a common interface that will have to implemented by all of the
* authentication plugins.
*
* @package PhpMyAdmin
*/
abstract class AuthenticationPlugin extends PluginObserver
{
/**
*
*
* @return void
*/
abstract public function auth();
/**
*
*
* @return void
*/
abstract public function authCheck();
/**
*
*
* @return void
*/
abstract public function authSetUser();
/**
*
*
* @return void
*/
abstract public function authFails();
}
?>

215
libraries/plugins/ExportPlugin.class.php Normal file
View File

@ -0,0 +1,215 @@
<?php
/* vim: set expandtab sw=4 ts=4 sts=4: */
/**
* Abstract class for the export plugins
*
* @package PhpMyAdmin
*/
if (! defined('PHPMYADMIN')) {
exit;
}
/* This class extends the PluginObserver class */
require_once "PluginObserver.class.php";
/**
* Provides a common interface that will have to implemented by all of the
* export plugins. Some of the plugins will also implement other public
* methods, but those are not declared here, because they are not implemented
* by all export plugins.
*
* @package PhpMyAdmin
*/
abstract class ExportPlugin extends PluginObserver
{
/**
* Array containing the specific export plugin type properties
*
* @var type array
*/
protected $properties;
/**
* Type of the newline character
*
* @var type string
*/
private $_crlf;
/**
* Contains configuration settings
*
* @var type array
*/
private $_cfg;
/**
* Database name
*
* @var type string
*/
private $_db;
/**
* Outputs export header
*
* @return bool Whether it succeeded
*/
abstract public function exportHeader ();
/**
* Outputs export footer
*
* @return bool Whether it succeeded
*/
abstract public function exportFooter ();
/**
* Outputs database header
*
* @param string $db Database name
*
* @return bool Whether it succeeded
*/
abstract public function exportDBHeader ($db);
/**
* Outputs database footer
*
* @param string $db Database name
*
* @return bool Whether it succeeded
*/
abstract public function exportDBFooter ($db);
/**
* Outputs CREATE DATABASE statement
*
* @param string $db Database name
*
* @return bool Whether it succeeded
*/
abstract public function exportDBCreate($db);
/**
* Outputs the content of a table
*
* @param string $db database name
* @param string $table table name
* @param string $crlf the end of line sequence
* @param string $error_url the url to go back in case of error
* @param string $sql_query SQL query for obtaining data
*
* @return bool Whether it succeeded
*/
abstract public function exportData ($db, $table, $crlf, $error_url, $sql_query);
/**
* Initializes the local variables with the global values.
* These are variables that are used by all of the export plugins.
*
* @global String $crlf type of the newline character
* @global array $cfg array with configuration settings
* @global String $db database name
*
* @return void
*/
protected function initExportCommonVariables()
{
global $crlf;
global $cfg;
global $db;
$this->setCrlf($crlf);
$this->setCfg($cfg);
$this->setDb($db);
}
/* ~~~~~~~~~~~~~~~~~~~~ Getters and Setters ~~~~~~~~~~~~~~~~~~~~ */
/**
* Gets the export specific format plugin properties
*
* @return array
*/
public function getProperties()
{
return $this->properties;
}
/**
* Sets the export plugins properties and is implemented by each export
* plugin
*
* @return void
*/
abstract protected function setProperties();
/**
* Gets the type of the newline character
*
* @return string
*/
public function getCrlf()
{
return $this->_crlf;
}
/**
* Sets the type of the newline character
*
* @param String $crlf type of the newline character
*
* @return void
*/
protected function setCrlf($crlf)
{
$this->_crlf = $crlf;
}
/**
* Gets the configuration settings
*
* @return array
*/
public function getCfg()
{
return $this->_cfg;
}
/**
* Sets the configuration settings
*
* @param array $cfg array with configuration settings
*
* @return void
*/
protected function setCfg($cfg)
{
$this->_cfg = $cfg;
}
/**
* Gets the database name
*
* @return string
*/
public function getDb()
{
return $this->_db;
}
/**
* Sets the database name
*
* @param String $db database name
*
* @return void
*/
protected function setDb($db)
{
$this->_db = $db;
}
}
?>

112
libraries/plugins/ImportPlugin.class.php Normal file
View File

@ -0,0 +1,112 @@
<?php
/* vim: set expandtab sw=4 ts=4 sts=4: */
/**
* Abstract class for the import plugins
*
* @package PhpMyAdmin
*/
if (! defined('PHPMYADMIN')) {
exit;
}
/* This class extends the PluginObserver class */
require_once "PluginObserver.class.php";
/**
* Provides a common interface that will have to implemented by all of the
* import plugins.
*
* @todo descriptions
* @package PhpMyAdmin
*/
abstract class ImportPlugin extends PluginObserver
{
/**
* Array containing the import plugin properties
*
* @var type array
*/
protected $properties;
/**
*
*
* @var type
*/
private $_error;
/**
*
*
* @var type
*/
private $_timeout_passed;
/**
* Handles the whole import logic
*
* @return void
*/
abstract public function doImport();
/**
* Initializes the local variables with the global values.
* These are variables that are used by all of the import plugins.
*
* @global type $error
* @global type $timeout_passed
* @global type $finished
*
* @return void
*/
protected function initImportCommonVariables()
{
global $error;
global $timeout_passed;
$this->setError($error);
$this->setTimeout_passed($timeout_passed);
}
/* ~~~~~~~~~~~~~~~~~~~~ Getters and Setters ~~~~~~~~~~~~~~~~~~~~ */
/**
* Gets the import specific format plugin properties
*
* @return array
*/
public function getProperties()
{
return $this->properties;
}
/**
* Sets the export plugins properties and is implemented by each import
* plugin
*
* @return void
*/
abstract protected function setProperties();
public function getError()
{
return $this->_error;
}
public function setError($error)
{
$this->_error = $error;
}
public function getTimeout_passed()
{
return $this->_timeout_passed;
}
public function setTimeout_passed($timeout_passed)
{
$this->_timeout_passed = $timeout_passed;
}
}
?>

130
libraries/plugins/PluginManager.class.php Normal file
View File

@ -0,0 +1,130 @@
<?php
/* vim: set expandtab sw=4 ts=4 sts=4: */
/**
* The PluginManager class is used alongside PluginObserver to implement
* the Observer Design Pattern.
*
* @package PhpMyAdmin
*/
if (! defined('PHPMYADMIN')) {
exit;
}
/**
* This class implements the SplSubject interface
*
* @link http://php.net/manual/en/class.splsubject.php
* @todo implement all methods
* @package PhpMyAdmin
*/
class PluginManager implements SplSubject
{
/**
* Contains a list with all the plugins that attach to it
*
* @var type SplObjectStorage
*/
private $_storage;
/**
* Contains information about the current plugin state
*
* @var type string
*/
private $_status;
/**
* Constructor
* Initializes $_storage with an empty SplObjectStorage
*/
public function __construct()
{
$this->_storage = new SplObjectStorage();
}
/**
* Attaches an SplObserver so that it can be notified of updates
*
* @param SplObserver $observer The SplObserver to attach
*
* @return void
*/
function attach (SplObserver $observer )
{
$this->_storage->attach($observer);
}
/**
* Detaches an observer from the subject to no longer notify it of updates
*
* @param SplObserver $observer The SplObserver to detach
*
* @return void
*/
function detach (SplObserver $observer)
{
$this->_storage->detach($observer);
}
/**
* It is called after setStatus() was run by a certain plugin, and has
* the role of sending a notification to all of the plugins in $_storage,
* by calling the update() method for each of them.
*
* @return void
*/
function notify ()
{
}
/* ~~~~~~~~~~~~~~~~~~~~ Getters and Setters ~~~~~~~~~~~~~~~~~~~~ */
/**
* Gets the list with all the plugins that attach to it
*
* @return type SplObjectStorage
*/
public function getStorage()
{
return $this->_storage;
}
/**
* Setter for $_storage
*
* @param SplObjectStorage $_storage the list with all the plugins that
* attach to it
*
* @return void
*/
public function setStorage($_storage)
{
$this->_storage = $_storage;
}
/**
* Gets the information about the current plugin state
* It is called by all the plugins in $_storage in their update() method
*
* @return type mixed
*/
public function getStatus()
{
return $this->_status;
}
/**
* Setter for $_status
* If a plugin changes its status, this has to be remembered in order to
* notify the rest of the plugins that they should update
*
* @param mixed $_status contains information about the current plugin state
*
* @return void
*/
public function setStatus($_status)
{
$this->_status = $_status;
}
}
?>

81
libraries/plugins/PluginObserver.class.php Normal file
View File

@ -0,0 +1,81 @@
<?php
/* vim: set expandtab sw=4 ts=4 sts=4: */
/**
* The PluginObserver class is used alongside PluginManager to implement
* the Observer Design Pattern.
*
* @package PhpMyAdmin
*/
if (! defined('PHPMYADMIN')) {
exit;
}
/* Each PluginObserver instance contains a PluginManager instance */
require_once "PluginManager.class.php";
/**
* This class implements the SplObserver interface
*
* @link http://php.net/manual/en/class.splobserver.php
* @package PhpMyAdmin
*/
abstract class PluginObserver implements SplObserver
{
/**
* PluginManager instance that contains a list with all the observer
* plugins that attach to it
*
* @var type PluginManager
*/
private $_pluginManager;
/**
* Constructor
*
* @param PluginManager $pluginManager The Plugin Manager instance
*/
public function __construct($pluginManager)
{
$this->_pluginManager = $pluginManager;
}
/**
* This method is called when any PluginManager to which the observer
* is attached calls PluginManager::notify()
*
* @param SplSubject $subject The PluginManager notifying the observer
* of an update.
*
* @return void
*/
abstract public function update (SplSubject $subject);
/* ~~~~~~~~~~~~~~~~~~~~ Getters and Setters ~~~~~~~~~~~~~~~~~~~~ */
/**
* Gets the PluginManager instance that contains the list with all the
* plugins that attached to it
*
* @return type PluginManager
*/
public function getPluginManager()
{
return $this->_pluginManager;
}
/**
* Setter for $_pluginManager
*
* @param PluginManager $_pluginManager the private instance that it will
* attach to
*
* @return void
*/
public function setPluginManager($_pluginManager)
{
$this->_pluginManager = $_pluginManager;
}
}
?>

66
libraries/plugins/TransformationsPlugin.class.php Normal file
View File

@ -0,0 +1,66 @@
<?php
/* vim: set expandtab sw=4 ts=4 sts=4: */
/**
* Abstract class for the transformations plugins
*
* @package PhpMyAdmin
*/
if (! defined('PHPMYADMIN')) {
exit;
}
/* This class extends the PluginObserver class */
require_once "PluginObserver.class.php";
/**
* Provides a common interface that will have to implemented by all of the
* transformations plugins.
*
* @package PhpMyAdmin
*/
abstract class TransformationsPlugin extends PluginObserver
{
/**
* Does the actual work of each specific transformations plugin.
*
* @param string $buffer text to be transformed
* @param array $options transformation options
* @param string $meta meta information
*
* @return void
*/
abstract public function applyTransformation($buffer, $options, $meta);
/* ~~~~~~~~~~~~~~~~~~~~ Getters and Setters ~~~~~~~~~~~~~~~~~~~~ */
/**
* Gets the transformation description
*
* @return string
*/
abstract public function getInfo();
/**
* Gets the specific MIME type
*
* @return string
*/
abstract public function getMimeType();
/**
* Gets the specific MIME subtype
*
* @return string
*/
abstract public function getMimeSubType();
/**
* Gets the transformation name of the specific plugin
*
* @return string
*/
abstract public function getName();
}
?>

521
libraries/plugins/export/ExportXML.class.php Normal file
View File

@ -0,0 +1,521 @@
<?php
/* vim: set expandtab sw=4 ts=4 sts=4: */
/**
* Set of functions used to build XML dumps of tables
*
* @package PhpMyAdmin-Export
* @subpackage XML
*/
if (! defined('PHPMYADMIN')) {
exit;
}
if (! strlen($GLOBALS['db'])) { /* Can't do server export */
return;
}
/* Get the export interface */
require_once "libraries/plugins/ExportPlugin.class.php";
/**
* Handles the export for the XML class
*
* @todo add descriptions for all vars/methods
* @package PhpMyAdmin-Export
*/
class ExportXML extends ExportPlugin
{
/**
* Table name
*
* @var type String
*/
private $table;
/**
*
*
* @var type
*/
private $tables;
/**
* Constructor
*/
public function __construct()
{
$this->setProperties();
}
/**
* Initialize the local variables that are used specific for export SQL
*
* @global type $table
* @global type $tables
*
* @return void
*/
private function initLocalVariables()
{
global $table;
global $tables;
$this->setTable($table);
$this->setTables($tables);
}
/**
* Sets the export XML properties
*
* @return void
*/
protected function setProperties()
{
$this->properties = array(
'text' => __('XML'),
'extension' => 'xml',
'mime_type' => 'text/xml',
'options' => array(),
'options_text' => __('Options')
);
$this->properties['options'] = array(
array(
'type' => 'begin_group',
'name' => 'general_opts'
),
array(
'type' => 'hidden',
'name' => 'structure_or_data'
),
array(
'type' => 'end_group'
)
);
/* Export structure */
$this->properties['options'][] = array(
'type' => 'begin_group',
'name' => 'structure',
'text' => __('Object creation options (all are recommended)')
);
if (! PMA_DRIZZLE) {
$this->properties['options'][] = array(
'type' => 'bool',
'name' => 'export_functions',
'text' => __('Functions')
);
$this->properties['options'][] = array(
'type' => 'bool',
'name' => 'export_procedures',
'text' => __('Procedures')
);
}
$this->properties['options'][] = array(
'type' => 'bool',
'name' => 'export_tables',
'text' => __('Tables')
);
if (! PMA_DRIZZLE) {
$this->properties['options'][] = array(
'type' => 'bool',
'name' => 'export_triggers',
'text' => __('Triggers')
);
$this->properties['options'][] = array(
'type' => 'bool',
'name' => 'export_views',
'text' => __('Views')
);
}
$this->properties['options'][] = array(
'type' => 'end_group'
);
/* Data */
$this->properties['options'][] = array(
'type' => 'begin_group',
'name' => 'data',
'text' => __('Data dump options')
);
$this->properties['options'][] = array(
'type' => 'bool',
'name' => 'export_contents',
'text' => __('Export contents')
);
$this->properties['options'][] = array(
'type' => 'end_group'
);
}
/**
* This method is called when any PluginManager to which the observer
* is attached calls PluginManager::notify()
*
* @param SplSubject $subject The PluginManager notifying the observer
* of an update.
*
* @return void
*/
public function update (SplSubject $subject)
{
}
/**
* Outputs export header. It is the first method to be called, so all
* the required variables are initialized here.
*
* @return bool Whether it succeeded
*/
public function exportHeader ()
{
// initialize the general export variables
$this->initExportCommonVariables();
// initialize the specific export sql variables
$this->initLocalVariables();
$crlf = $this->getCrlf();
$cfg = $this->getCfg();
$db = $this->getDb();
$table = $this->getTable();
$tables = $this->getTables();
$export_struct = isset($GLOBALS['xml_export_functions'])
|| isset($GLOBALS['xml_export_procedures'])
|| isset($GLOBALS['xml_export_tables'])
|| isset($GLOBALS['xml_export_triggers'])
|| isset($GLOBALS['xml_export_views']);
$export_data = isset($GLOBALS['xml_export_contents']) ? true : false;
if ($GLOBALS['output_charset_conversion']) {
$charset = $GLOBALS['charset_of_file'];
} else {
$charset = 'utf-8';
}
$head = '<?xml version="1.0" encoding="' . $charset . '"?>' . $crlf
. '<!--' . $crlf
. '- phpMyAdmin XML Dump' . $crlf
. '- version ' . PMA_VERSION . $crlf
. '- http://www.phpmyadmin.net' . $crlf
. '-' . $crlf
. '- ' . __('Host') . ': ' . $cfg['Server']['host'];
if (! empty($cfg['Server']['port'])) {
$head .= ':' . $cfg['Server']['port'];
}
$head .= $crlf
. '- ' . __('Generation Time') . ': ' . PMA_localisedDate() . $crlf
. '- ' . __('Server version') . ': ' . PMA_MYSQL_STR_VERSION . $crlf
. '- ' . __('PHP Version') . ': ' . phpversion() . $crlf
. '-->' . $crlf . $crlf;
$head .= '<pma_xml_export version="1.0"'
. (($export_struct)
? ' xmlns:pma="http://www.phpmyadmin.net/some_doc_url/"'
: '')
. '>' . $crlf;
if ($export_struct) {
if (PMA_DRIZZLE) {
$result = PMA_DBI_fetch_result(
"SELECT
'utf8' AS DEFAULT_CHARACTER_SET_NAME,
DEFAULT_COLLATION_NAME
FROM data_dictionary.SCHEMAS
WHERE SCHEMA_NAME = '" . PMA_sqlAddSlashes($db) . "'"
);
} else {
$result = PMA_DBI_fetch_result(
'SELECT `DEFAULT_CHARACTER_SET_NAME`, `DEFAULT_COLLATION_NAME`'
. ' FROM `information_schema`.`SCHEMATA` WHERE `SCHEMA_NAME`'
. ' = \''.PMA_sqlAddSlashes($db).'\' LIMIT 1'
);
}
$db_collation = $result[0]['DEFAULT_COLLATION_NAME'];
$db_charset = $result[0]['DEFAULT_CHARACTER_SET_NAME'];
$head .= ' <!--' . $crlf;
$head .= ' - Structure schemas' . $crlf;
$head .= ' -->' . $crlf;
$head .= ' <pma:structure_schemas>' . $crlf;
$head .= ' <pma:database name="' . htmlspecialchars($db)
. '" collation="' . $db_collation . '" charset="' . $db_charset
. '">' . $crlf;
if (count($tables) == 0) {
$tables[] = $table;
}
foreach ($tables as $table) {
// Export tables and views
$result = PMA_DBI_fetch_result(
'SHOW CREATE TABLE ' . PMA_backquote($db) . '.'
. PMA_backquote($table),
0
);
$tbl = $result[$table][1];
$is_view = PMA_Table::isView($db, $table);
if ($is_view) {
$type = 'view';
} else {
$type = 'table';
}
if ($is_view && ! isset($GLOBALS['xml_export_views'])) {
continue;
}
if (! $is_view && ! isset($GLOBALS['xml_export_tables'])) {
continue;
}
$head .= ' <pma:' . $type . ' name="' . $table . '">'
. $crlf;
$tbl = " " . htmlspecialchars($tbl);
$tbl = str_replace("\n", "\n ", $tbl);
$head .= $tbl . ';' . $crlf;
$head .= ' </pma:' . $type . '>' . $crlf;
if (isset($GLOBALS['xml_export_triggers'])
&& $GLOBALS['xml_export_triggers']
) {
// Export triggers
$triggers = PMA_DBI_get_triggers($db, $table);
if ($triggers) {
foreach ($triggers as $trigger) {
$code = $trigger['create'];
$head .= ' <pma:trigger name="'
. $trigger['name'] . '">' . $crlf;
// Do some formatting
$code = substr(rtrim($code), 0, -3);
$code = " " . htmlspecialchars($code);
$code = str_replace("\n", "\n ", $code);
$head .= $code . $crlf;
$head .= ' </pma:trigger>' . $crlf;
}
unset($trigger);
unset($triggers);
}
}
}
if (isset($GLOBALS['xml_export_functions'])
&& $GLOBALS['xml_export_functions']
) {
// Export functions
$functions = PMA_DBI_get_procedures_or_functions($db, 'FUNCTION');
if ($functions) {
foreach ($functions as $function) {
$head .= ' <pma:function name="'
. $function . '">' . $crlf;
// Do some formatting
$sql = PMA_DBI_get_definition($db, 'FUNCTION', $function);
$sql = rtrim($sql);
$sql = " " . htmlspecialchars($sql);
$sql = str_replace("\n", "\n ", $sql);
$head .= $sql . $crlf;
$head .= ' </pma:function>' . $crlf;
}
unset($function);
unset($functions);
}
}
if (isset($GLOBALS['xml_export_procedures'])
&& $GLOBALS['xml_export_procedures']
) {
// Export procedures
$procedures = PMA_DBI_get_procedures_or_functions($db, 'PROCEDURE');
if ($procedures) {
foreach ($procedures as $procedure) {
$head .= ' <pma:procedure name="'
. $procedure . '">' . $crlf;
// Do some formatting
$sql = PMA_DBI_get_definition($db, 'PROCEDURE', $procedure);
$sql = rtrim($sql);
$sql = " " . htmlspecialchars($sql);
$sql = str_replace("\n", "\n ", $sql);
$head .= $sql . $crlf;
$head .= ' </pma:procedure>' . $crlf;
}
unset($procedure);
unset($procedures);
}
}
unset($result);
$head .= ' </pma:database>' . $crlf;
$head .= ' </pma:structure_schemas>' . $crlf;
if ($export_data) {
$head .= $crlf;
}
}
return PMA_exportOutputHandler($head);
}
/**
* Outputs export footer
*
* @return bool Whether it succeeded
*/
public function exportFooter ()
{
$foot = '</pma_xml_export>';
return PMA_exportOutputHandler($foot);
}
/**
* Outputs database header
*
* @param string $db Database name
*
* @return bool Whether it succeeded
*/
public function exportDBHeader ($db)
{
$crlf = $this->getCrlf();
if (isset($GLOBALS['xml_export_contents'])
&& $GLOBALS['xml_export_contents']
) {
$head = ' <!--' . $crlf
. ' - ' . __('Database') . ': ' . '\'' . $db . '\'' . $crlf
. ' -->' . $crlf
. ' <database name="' . htmlspecialchars($db) . '">' . $crlf;
return PMA_exportOutputHandler($head);
} else {
return true;
}
}
/**
* Outputs database footer
*
* @param string $db Database name
*
* @return bool Whether it succeeded
*/
public function exportDBFooter ($db)
{
$crlf = $this->getCrlf();
if (isset($GLOBALS['xml_export_contents'])
&& $GLOBALS['xml_export_contents']
) {
return PMA_exportOutputHandler(' </database>' . $crlf);
} else {
return true;
}
}
/**
* Outputs CREATE DATABASE statement
*
* @param string $db Database name
*
* @return bool Whether it succeeded
*/
public function exportDBCreate($db)
{
return true;
}
/**
* Outputs the content of a table in XML format
*
* @param string $db database name
* @param string $table table name
* @param string $crlf the end of line sequence
* @param string $error_url the url to go back in case of error
* @param string $sql_query SQL query for obtaining data
*
* @return bool Whether it succeeded
*/
public function exportData ($db, $table, $crlf, $error_url, $sql_query)
{
if (isset($GLOBALS['xml_export_contents'])
&& $GLOBALS['xml_export_contents']
) {
$result = PMA_DBI_query($sql_query, null, PMA_DBI_QUERY_UNBUFFERED);
$columns_cnt = PMA_DBI_num_fields($result);
$columns = array();
for ($i = 0; $i < $columns_cnt; $i++) {
$columns[$i] = stripslashes(PMA_DBI_field_name($result, $i));
}
unset($i);
$buffer = ' <!-- ' . __('Table') . ' ' . $table . ' -->' . $crlf;
if (! PMA_exportOutputHandler($buffer)) {
return false;
}
while ($record = PMA_DBI_fetch_row($result)) {
$buffer = ' <table name="'
. htmlspecialchars($table) . '">' . $crlf;
for ($i = 0; $i < $columns_cnt; $i++) {
// If a cell is NULL, still export it to preserve
// the XML structure
if (! isset($record[$i]) || is_null($record[$i])) {
$record[$i] = 'NULL';
}
$buffer .= ' <column name="'
. htmlspecialchars($columns[$i]) . '">'
. htmlspecialchars((string)$record[$i])
. '</column>' . $crlf;
}
$buffer .= ' </table>' . $crlf;
if (! PMA_exportOutputHandler($buffer)) {
return false;
}
}
PMA_DBI_free_result($result);
}
return true;
}
/* ~~~~~~~~~~~~~~~~~~~~ Getters and Setters ~~~~~~~~~~~~~~~~~~~~ */
private function getTable()
{
return $this->table;
}
private function setTable($table)
{
$this->table = $table;
}
private function getTables()
{
return $this->tables;
}
private function setTables($tables)
{
$this->tables = $tables;
}
}
?>