summaryrefslogtreecommitdiff
path: root/hugo/libraries/plugins/export/ExportMediawiki.class.php
diff options
context:
space:
mode:
Diffstat (limited to 'hugo/libraries/plugins/export/ExportMediawiki.class.php')
-rw-r--r--hugo/libraries/plugins/export/ExportMediawiki.class.php364
1 files changed, 364 insertions, 0 deletions
diff --git a/hugo/libraries/plugins/export/ExportMediawiki.class.php b/hugo/libraries/plugins/export/ExportMediawiki.class.php
new file mode 100644
index 0000000..89afe71
--- /dev/null
+++ b/hugo/libraries/plugins/export/ExportMediawiki.class.php
@@ -0,0 +1,364 @@
+<?php
+/* vim: set expandtab sw=4 ts=4 sts=4: */
+/**
+ * Set of functions used to build MediaWiki dumps of tables
+ *
+ * @package PhpMyAdmin-Export
+ * @subpackage MediaWiki
+ */
+if (! defined('PHPMYADMIN')) {
+ exit;
+}
+
+/* Get the export interface */
+require_once 'libraries/plugins/ExportPlugin.class.php';
+
+/**
+ * Handles the export for the MediaWiki class
+ *
+ * @package PhpMyAdmin-Export
+ * @subpackage MediaWiki
+ */
+class ExportMediawiki extends ExportPlugin
+{
+ /**
+ * Constructor
+ */
+ public function __construct()
+ {
+ $this->setProperties();
+ }
+
+ /**
+ * Sets the export MediaWiki properties
+ *
+ * @return void
+ */
+ protected function setProperties()
+ {
+ $props = 'libraries/properties/';
+ include_once "$props/plugins/ExportPluginProperties.class.php";
+ include_once "$props/options/groups/OptionsPropertyRootGroup.class.php";
+ include_once "$props/options/groups/OptionsPropertyMainGroup.class.php";
+ include_once "$props/options/groups/OptionsPropertySubgroup.class.php";
+ include_once "$props/options/items/MessageOnlyPropertyItem.class.php";
+ include_once "$props/options/items/RadioPropertyItem.class.php";
+ include_once "$props/options/items/BoolPropertyItem.class.php";
+
+ $exportPluginProperties = new ExportPluginProperties();
+ $exportPluginProperties->setText('MediaWiki Table');
+ $exportPluginProperties->setExtension('mediawiki');
+ $exportPluginProperties->setMimeType('text/plain');
+ $exportPluginProperties->setOptionsText(__('Options'));
+
+ // create the root group that will be the options field for
+ // $exportPluginProperties
+ // this will be shown as "Format specific options"
+ $exportSpecificOptions = new OptionsPropertyRootGroup();
+ $exportSpecificOptions->setName("Format Specific Options");
+
+ // general options main group
+ $generalOptions = new OptionsPropertyMainGroup();
+ $generalOptions->setName("general_opts");
+ $generalOptions->setText(__('Dump table'));
+
+ // what to dump (structure/data/both)
+ $subgroup = new OptionsPropertySubgroup();
+ $subgroup->setName("dump_table");
+ $subgroup->setText("Dump table");
+ $leaf = new RadioPropertyItem();
+ $leaf->setName('structure_or_data');
+ $leaf->setValues(
+ array(
+ 'structure' => __('structure'),
+ 'data' => __('data'),
+ 'structure_and_data' => __('structure and data')
+ )
+ );
+ $subgroup->setSubgroupHeader($leaf);
+ $generalOptions->addProperty($subgroup);
+
+ // export table name
+ $leaf = new BoolPropertyItem();
+ $leaf->setName("caption");
+ $leaf->setText(__('Export table names'));
+ $generalOptions->addProperty($leaf);
+
+ // export table headers
+ $leaf = new BoolPropertyItem();
+ $leaf->setName("headers");
+ $leaf->setText(__('Export table headers'));
+ $generalOptions->addProperty($leaf);
+ //add the main group to the root group
+ $exportSpecificOptions->addProperty($generalOptions);
+
+ // set the options for the export plugin property item
+ $exportPluginProperties->setOptions($exportSpecificOptions);
+ $this->properties = $exportPluginProperties;
+ }
+
+ /**
+ * 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
+ *
+ * @return bool Whether it succeeded
+ */
+ public function exportHeader ()
+ {
+ return true;
+ }
+
+ /**
+ * Outputs export footer
+ *
+ * @return bool Whether it succeeded
+ */
+ public function exportFooter ()
+ {
+ return true;
+ }
+
+ /**
+ * Outputs database header
+ *
+ * @param string $db Database name
+ *
+ * @return bool Whether it succeeded
+ */
+ public function exportDBHeader ($db)
+ {
+ return true;
+ }
+
+ /**
+ * Outputs database footer
+ *
+ * @param string $db Database name
+ *
+ * @return bool Whether it succeeded
+ */
+ public function exportDBFooter ($db)
+ {
+ return true;
+ }
+
+ /**
+ * Outputs CREATE DATABASE statement
+ *
+ * @param string $db Database name
+ *
+ * @return bool Whether it succeeded
+ */
+ public function exportDBCreate($db)
+ {
+ return true;
+ }
+
+ /**
+ * Outputs table's structure
+ *
+ * @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 $export_mode 'create_table','triggers','create_view',
+ * 'stand_in'
+ * @param string $export_type 'server', 'database', 'table'
+ * @param bool $do_relation whether to include relation comments
+ * @param bool $do_comments whether to include the pmadb-style column
+ * comments as comments in the structure; this is
+ * deprecated but the parameter is left here
+ * because export.php calls exportStructure()
+ * also for other export types which use this
+ * parameter
+ * @param bool $do_mime whether to include mime comments
+ * @param bool $dates whether to include creation/update/check dates
+ *
+ * @return bool Whether it succeeded
+ */
+ public function exportStructure(
+ $db,
+ $table,
+ $crlf,
+ $error_url,
+ $export_mode,
+ $export_type,
+ $do_relation = false,
+ $do_comments = false,
+ $do_mime = false,
+ $dates = false
+ ) {
+ switch($export_mode) {
+ case 'create_table':
+ $columns = PMA_DBI_get_columns($db, $table);
+ $columns = array_values($columns);
+ $row_cnt = count($columns);
+
+ // Print structure comment
+ $output = $this->_exportComment(
+ "Table structure for "
+ . PMA_Util::backquote($table)
+ );
+
+ // Begin the table construction
+ $output .= "{| class=\"wikitable\" style=\"text-align:center;\""
+ . $this->_exportCRLF();
+
+ // Add the table name
+ if ($GLOBALS['mediawiki_caption']) {
+ $output .= "|+'''" . $table . "'''" . $this->_exportCRLF();
+ }
+
+ // Add the table headers
+ if ($GLOBALS['mediawiki_headers']) {
+ $output .= "|- style=\"background:#ffdead;\"" . $this->_exportCRLF();
+ $output .= "! style=\"background:#ffffff\" | "
+ . $this->_exportCRLF();
+ for ($i = 0; $i < $row_cnt; ++$i) {
+ $output .= " | " . $columns[$i]['Field']. $this->_exportCRLF();
+ }
+ }
+
+ // Add the table structure
+ $output .= "|-" . $this->_exportCRLF();
+ $output .= "! Type" . $this->_exportCRLF();
+ for ($i = 0; $i < $row_cnt; ++$i) {
+ $output .= " | " . $columns[$i]['Type'] . $this->_exportCRLF();
+ }
+
+ $output .= "|-" . $this->_exportCRLF();
+ $output .= "! Null" . $this->_exportCRLF();
+ for ($i = 0; $i < $row_cnt; ++$i) {
+ $output .= " | " . $columns[$i]['Null'] . $this->_exportCRLF();
+ }
+
+ $output .= "|-" . $this->_exportCRLF();
+ $output .= "! Default" . $this->_exportCRLF();
+ for ($i = 0; $i < $row_cnt; ++$i) {
+ $output .= " | " . $columns[$i]['Default'] . $this->_exportCRLF();
+ }
+
+ $output .= "|-" . $this->_exportCRLF();
+ $output .= "! Extra" . $this->_exportCRLF();
+ for ($i = 0; $i < $row_cnt; ++$i) {
+ $output .= " | " . $columns[$i]['Extra'] . $this->_exportCRLF();
+ }
+
+ $output .= "|}" . str_repeat($this->_exportCRLF(), 2);
+ break;
+ } // end switch
+
+ return PMA_exportOutputHandler($output);
+ }
+
+ /**
+ * Outputs the content of a table in MediaWiki 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
+ ) {
+ // Print data comment
+ $output = $this->_exportComment(
+ "Table data for ". PMA_Util::backquote($table)
+ );
+
+ // Begin the table construction
+ // Use the "wikitable" class for style
+ // Use the "sortable" class for allowing tables to be sorted by column
+ $output .= "{| class=\"wikitable sortable\" style=\"text-align:center;\""
+ . $this->_exportCRLF();
+
+ // Add the table name
+ if ($GLOBALS['mediawiki_caption']) {
+ $output .= "|+'''" . $table . "'''" . $this->_exportCRLF();
+ }
+
+ // Add the table headers
+ if ($GLOBALS['mediawiki_headers']) {
+ // Get column names
+ $column_names = PMA_DBI_get_column_names($db, $table);
+
+ // Add column names as table headers
+ if ( ! is_null($column_names) ) {
+ // Use '|-' for separating rows
+ $output .= "|-" . $this->_exportCRLF();
+
+ // Use '!' for separating table headers
+ foreach ($column_names as $column) {
+ $output .= " ! " . $column . "" . $this->_exportCRLF();
+ }
+ }
+ }
+
+ // Get the table data from the database
+ $result = PMA_DBI_query($sql_query, null, PMA_DBI_QUERY_UNBUFFERED);
+ $fields_cnt = PMA_DBI_num_fields($result);
+
+ while ($row = PMA_DBI_fetch_row($result)) {
+ $output .= "|-" . $this->_exportCRLF();
+
+ // Use '|' for separating table columns
+ for ($i = 0; $i < $fields_cnt; ++ $i) {
+ $output .= " | " . $row[$i] . "" . $this->_exportCRLF();
+ }
+ }
+
+ // End table construction
+ $output .= "|}" . str_repeat($this->_exportCRLF(), 2);
+ return PMA_exportOutputHandler($output);
+ }
+
+ /**
+ * Outputs comments containing info about the exported tables
+ *
+ * @param string $text Text of comment
+ *
+ * @return string The formatted comment
+ */
+ private function _exportComment($text = '')
+ {
+ // see http://www.mediawiki.org/wiki/Help:Formatting
+ $comment = $this->_exportCRLF();
+ $comment .= '<!--' . $this->_exportCRLF();
+ $comment .= $text . $this->_exportCRLF();
+ $comment .= '-->' . str_repeat($this->_exportCRLF(), 2);
+
+ return $comment;
+ }
+
+ /**
+ * Outputs CRLF
+ *
+ * @return string CRLF
+ */
+ private function _exportCRLF()
+ {
+ // The CRLF expected by the mediawiki format is "\n"
+ return "\n";
+ }
+}
+?>