You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
377 lines
12 KiB
377 lines
12 KiB
2 years ago
|
<?php
|
||
|
|
/**
|
||
|
|
* Set of functions used to build MediaWiki dumps of tables
|
||
|
|
*/
|
||
|
|
|
||
|
|
declare(strict_types=1);
|
||
|
|
|
||
|
|
namespace PhpMyAdmin\Plugins\Export;
|
||
|
|
|
||
|
|
use PhpMyAdmin\DatabaseInterface;
|
||
|
|
use PhpMyAdmin\Plugins\ExportPlugin;
|
||
|
|
use PhpMyAdmin\Properties\Options\Groups\OptionsPropertyMainGroup;
|
||
|
|
use PhpMyAdmin\Properties\Options\Groups\OptionsPropertyRootGroup;
|
||
|
|
use PhpMyAdmin\Properties\Options\Groups\OptionsPropertySubgroup;
|
||
|
|
use PhpMyAdmin\Properties\Options\Items\BoolPropertyItem;
|
||
|
|
use PhpMyAdmin\Properties\Options\Items\RadioPropertyItem;
|
||
|
|
use PhpMyAdmin\Properties\Plugins\ExportPluginProperties;
|
||
|
|
use PhpMyAdmin\Util;
|
||
|
|
|
||
|
|
use function __;
|
||
|
|
use function array_values;
|
||
|
|
use function count;
|
||
|
|
use function htmlspecialchars;
|
||
|
|
use function str_repeat;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Handles the export for the MediaWiki class
|
||
|
|
*/
|
||
|
|
class ExportMediawiki extends ExportPlugin
|
||
|
|
{
|
||
|
|
/**
|
||
|
|
* @psalm-return non-empty-lowercase-string
|
||
|
|
*/
|
||
|
|
public function getName(): string
|
||
|
|
{
|
||
|
|
return 'mediawiki';
|
||
|
|
}
|
||
|
|
|
||
|
|
protected function setProperties(): ExportPluginProperties
|
||
|
|
{
|
||
|
|
$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('Format Specific Options');
|
||
|
|
|
||
|
|
// general options main group
|
||
|
|
$generalOptions = new OptionsPropertyMainGroup(
|
||
|
|
'general_opts',
|
||
|
|
__('Dump table')
|
||
|
|
);
|
||
|
|
|
||
|
|
// what to dump (structure/data/both)
|
||
|
|
$subgroup = new OptionsPropertySubgroup(
|
||
|
|
'dump_table',
|
||
|
|
__('Dump table')
|
||
|
|
);
|
||
|
|
$leaf = new RadioPropertyItem('structure_or_data');
|
||
|
|
$leaf->setValues(
|
||
|
|
[
|
||
|
|
'structure' => __('structure'),
|
||
|
|
'data' => __('data'),
|
||
|
|
'structure_and_data' => __('structure and data'),
|
||
|
|
]
|
||
|
|
);
|
||
|
|
$subgroup->setSubgroupHeader($leaf);
|
||
|
|
$generalOptions->addProperty($subgroup);
|
||
|
|
|
||
|
|
// export table name
|
||
|
|
$leaf = new BoolPropertyItem(
|
||
|
|
'caption',
|
||
|
|
__('Export table names')
|
||
|
|
);
|
||
|
|
$generalOptions->addProperty($leaf);
|
||
|
|
|
||
|
|
// export table headers
|
||
|
|
$leaf = new BoolPropertyItem(
|
||
|
|
'headers',
|
||
|
|
__('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);
|
||
|
|
|
||
|
|
return $exportPluginProperties;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Outputs export header
|
||
|
|
*/
|
||
|
|
public function exportHeader(): bool
|
||
|
|
{
|
||
|
|
return true;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Outputs export footer
|
||
|
|
*/
|
||
|
|
public function exportFooter(): bool
|
||
|
|
{
|
||
|
|
return true;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Outputs database header
|
||
|
|
*
|
||
|
|
* @param string $db Database name
|
||
|
|
* @param string $dbAlias Alias of db
|
||
|
|
*/
|
||
|
|
public function exportDBHeader($db, $dbAlias = ''): bool
|
||
|
|
{
|
||
|
|
return true;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Outputs database footer
|
||
|
|
*
|
||
|
|
* @param string $db Database name
|
||
|
|
*/
|
||
|
|
public function exportDBFooter($db): bool
|
||
|
|
{
|
||
|
|
return true;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Outputs CREATE DATABASE statement
|
||
|
|
*
|
||
|
|
* @param string $db Database name
|
||
|
|
* @param string $exportType 'server', 'database', 'table'
|
||
|
|
* @param string $dbAlias Aliases of db
|
||
|
|
*/
|
||
|
|
public function exportDBCreate($db, $exportType, $dbAlias = ''): bool
|
||
|
|
{
|
||
|
|
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 $errorUrl the url to go back in case of error
|
||
|
|
* @param string $exportMode 'create_table','triggers','create_view',
|
||
|
|
* 'stand_in'
|
||
|
|
* @param string $exportType '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 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
|
||
|
|
* @param array $aliases Aliases of db/table/columns
|
||
|
|
*/
|
||
|
|
public function exportStructure(
|
||
|
|
$db,
|
||
|
|
$table,
|
||
|
|
$crlf,
|
||
|
|
$errorUrl,
|
||
|
|
$exportMode,
|
||
|
|
$exportType,
|
||
|
|
$do_relation = false,
|
||
|
|
$do_comments = false,
|
||
|
|
$do_mime = false,
|
||
|
|
$dates = false,
|
||
|
|
array $aliases = []
|
||
|
|
): bool {
|
||
|
|
global $dbi;
|
||
|
|
|
||
|
|
$db_alias = $db;
|
||
|
|
$table_alias = $table;
|
||
|
|
$this->initAlias($aliases, $db_alias, $table_alias);
|
||
|
|
|
||
|
|
$output = '';
|
||
|
|
switch ($exportMode) {
|
||
|
|
case 'create_table':
|
||
|
|
$columns = $dbi->getColumns($db, $table);
|
||
|
|
$columns = array_values($columns);
|
||
|
|
$row_cnt = count($columns);
|
||
|
|
|
||
|
|
// Print structure comment
|
||
|
|
$output = $this->exportComment(
|
||
|
|
'Table structure for '
|
||
|
|
. Util::backquote($table_alias)
|
||
|
|
);
|
||
|
|
|
||
|
|
// Begin the table construction
|
||
|
|
$output .= '{| class="wikitable" style="text-align:center;"'
|
||
|
|
. $this->exportCRLF();
|
||
|
|
|
||
|
|
// Add the table name
|
||
|
|
if (isset($GLOBALS['mediawiki_caption'])) {
|
||
|
|
$output .= "|+'''" . $table_alias . "'''" . $this->exportCRLF();
|
||
|
|
}
|
||
|
|
|
||
|
|
// Add the table headers
|
||
|
|
if (isset($GLOBALS['mediawiki_headers'])) {
|
||
|
|
$output .= '|- style="background:#ffdead;"' . $this->exportCRLF();
|
||
|
|
$output .= '! style="background:#ffffff" | '
|
||
|
|
. $this->exportCRLF();
|
||
|
|
for ($i = 0; $i < $row_cnt; ++$i) {
|
||
|
|
$col_as = $columns[$i]['Field'];
|
||
|
|
if (! empty($aliases[$db]['tables'][$table]['columns'][$col_as])) {
|
||
|
|
$col_as = $aliases[$db]['tables'][$table]['columns'][$col_as];
|
||
|
|
}
|
||
|
|
|
||
|
|
$output .= ' | ' . $col_as . $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;
|
||
|
|
}
|
||
|
|
|
||
|
|
return $this->export->outputHandler($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 $errorUrl the url to go back in case of error
|
||
|
|
* @param string $sqlQuery SQL query for obtaining data
|
||
|
|
* @param array $aliases Aliases of db/table/columns
|
||
|
|
*/
|
||
|
|
public function exportData(
|
||
|
|
$db,
|
||
|
|
$table,
|
||
|
|
$crlf,
|
||
|
|
$errorUrl,
|
||
|
|
$sqlQuery,
|
||
|
|
array $aliases = []
|
||
|
|
): bool {
|
||
|
|
global $dbi;
|
||
|
|
|
||
|
|
$db_alias = $db;
|
||
|
|
$table_alias = $table;
|
||
|
|
$this->initAlias($aliases, $db_alias, $table_alias);
|
||
|
|
|
||
|
|
// Print data comment
|
||
|
|
$output = $this->exportComment(
|
||
|
|
$table_alias != ''
|
||
|
|
? 'Table data for ' . Util::backquote($table_alias)
|
||
|
|
: 'Query results'
|
||
|
|
);
|
||
|
|
|
||
|
|
// 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 (isset($GLOBALS['mediawiki_caption'])) {
|
||
|
|
$output .= "|+'''" . $table_alias . "'''" . $this->exportCRLF();
|
||
|
|
}
|
||
|
|
|
||
|
|
// Add the table headers
|
||
|
|
if (isset($GLOBALS['mediawiki_headers'])) {
|
||
|
|
// Get column names
|
||
|
|
$column_names = $dbi->getColumnNames($db, $table);
|
||
|
|
|
||
|
|
// Add column names as table headers
|
||
|
|
if ($column_names !== []) {
|
||
|
|
// Use '|-' for separating rows
|
||
|
|
$output .= '|-' . $this->exportCRLF();
|
||
|
|
|
||
|
|
// Use '!' for separating table headers
|
||
|
|
foreach ($column_names as $column) {
|
||
|
|
if (! empty($aliases[$db]['tables'][$table]['columns'][$column])) {
|
||
|
|
$column = $aliases[$db]['tables'][$table]['columns'][$column];
|
||
|
|
}
|
||
|
|
|
||
|
|
$output .= ' ! ' . $column . '' . $this->exportCRLF();
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
// Get the table data from the database
|
||
|
|
$result = $dbi->query($sqlQuery, DatabaseInterface::CONNECT_USER, DatabaseInterface::QUERY_UNBUFFERED);
|
||
|
|
$fields_cnt = $result->numFields();
|
||
|
|
|
||
|
|
while ($row = $result->fetchRow()) {
|
||
|
|
$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 $this->export->outputHandler($output);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Outputs result raw query in MediaWiki format
|
||
|
|
*
|
||
|
|
* @param string $errorUrl the url to go back in case of error
|
||
|
|
* @param string $sqlQuery the rawquery to output
|
||
|
|
* @param string $crlf the end of line sequence
|
||
|
|
*/
|
||
|
|
public function exportRawQuery(string $errorUrl, string $sqlQuery, string $crlf): bool
|
||
|
|
{
|
||
|
|
return $this->exportData('', '', $crlf, $errorUrl, $sqlQuery);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Outputs comments containing info about the exported tables
|
||
|
|
*
|
||
|
|
* @param string $text Text of comment
|
||
|
|
*
|
||
|
|
* @return string The formatted comment
|
||
|
|
*/
|
||
|
|
private function exportComment($text = '')
|
||
|
|
{
|
||
|
|
// see https://www.mediawiki.org/wiki/Help:Formatting
|
||
|
|
$comment = $this->exportCRLF();
|
||
|
|
$comment .= '<!--' . $this->exportCRLF();
|
||
|
|
$comment .= htmlspecialchars($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";
|
||
|
|
}
|
||
|
|
}
|