311 lines
10 KiB
PHP
311 lines
10 KiB
PHP
<?php
|
|
/**
|
|
* Set of functions used to build MediaWiki dumps of tables
|
|
*/
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace PhpMyAdmin\Plugins\Export;
|
|
|
|
use PhpMyAdmin\Config\Settings\Export;
|
|
use PhpMyAdmin\Dbal\ConnectionType;
|
|
use PhpMyAdmin\Dbal\DatabaseInterface;
|
|
use PhpMyAdmin\Export\StructureOrData;
|
|
use PhpMyAdmin\Http\ServerRequest;
|
|
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 bin2hex;
|
|
use function htmlspecialchars;
|
|
use function str_repeat;
|
|
|
|
/**
|
|
* Handles the export for the MediaWiki class
|
|
*/
|
|
class ExportMediawiki extends ExportPlugin
|
|
{
|
|
private bool $caption = false;
|
|
private bool $headers = false;
|
|
|
|
/** @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 table's structure
|
|
*
|
|
* @param string $db database name
|
|
* @param string $table table name
|
|
* @param string $exportMode 'create_table', 'triggers', 'create_view', 'stand_in'
|
|
* @param mixed[] $aliases Aliases of db/table/columns
|
|
*
|
|
* @infection-ignore-all
|
|
*/
|
|
public function exportStructure(string $db, string $table, string $exportMode, array $aliases = []): void
|
|
{
|
|
$tableAlias = $this->getTableAlias($aliases, $db, $table);
|
|
|
|
$output = '';
|
|
if ($exportMode === 'create_table') {
|
|
$columns = $this->dbi->getColumns($db, $table);
|
|
$columns = array_values($columns);
|
|
|
|
// Print structure comment
|
|
$output = $this->exportComment(
|
|
'Table structure for '
|
|
. Util::backquote($tableAlias),
|
|
);
|
|
|
|
// Begin the table construction
|
|
$output .= '{| class="wikitable" style="text-align:center;"'
|
|
. $this->exportCRLF();
|
|
|
|
// Add the table name
|
|
if ($this->caption) {
|
|
$output .= "|+'''" . $tableAlias . "'''" . $this->exportCRLF();
|
|
}
|
|
|
|
// Add the table headers
|
|
if ($this->headers) {
|
|
$output .= '|- style="background:#ffdead;"' . $this->exportCRLF();
|
|
$output .= '! style="background:#ffffff" | '
|
|
. $this->exportCRLF();
|
|
foreach ($columns as $column) {
|
|
$colAs = $this->getColumnAlias($aliases, $db, $table, $column->field);
|
|
|
|
$output .= ' | ' . $colAs . $this->exportCRLF();
|
|
}
|
|
}
|
|
|
|
// Add the table structure
|
|
$output .= '|-' . $this->exportCRLF();
|
|
$output .= '! Type' . $this->exportCRLF();
|
|
foreach ($columns as $column) {
|
|
$output .= ' | ' . $column->type . $this->exportCRLF();
|
|
}
|
|
|
|
$output .= '|-' . $this->exportCRLF();
|
|
$output .= '! Null' . $this->exportCRLF();
|
|
foreach ($columns as $column) {
|
|
$output .= ' | ' . ($column->isNull ? 'YES' : 'NO') . $this->exportCRLF();
|
|
}
|
|
|
|
$output .= '|-' . $this->exportCRLF();
|
|
$output .= '! Default' . $this->exportCRLF();
|
|
foreach ($columns as $column) {
|
|
$output .= ' | ' . ($column->default ?? '') . $this->exportCRLF();
|
|
}
|
|
|
|
$output .= '|-' . $this->exportCRLF();
|
|
$output .= '! Extra' . $this->exportCRLF();
|
|
foreach ($columns as $column) {
|
|
$output .= ' | ' . $column->extra . $this->exportCRLF();
|
|
}
|
|
|
|
$output .= '|}' . str_repeat($this->exportCRLF(), 2);
|
|
}
|
|
|
|
$this->outputHandler->addLine($output);
|
|
}
|
|
|
|
/**
|
|
* Outputs the content of a table in MediaWiki format
|
|
*
|
|
* @param string $db database name
|
|
* @param string $table table name
|
|
* @param string $sqlQuery SQL query for obtaining data
|
|
* @param mixed[] $aliases Aliases of db/table/columns
|
|
*/
|
|
public function exportData(
|
|
string $db,
|
|
string $table,
|
|
string $sqlQuery,
|
|
array $aliases = [],
|
|
): void {
|
|
$tableAlias = $this->getTableAlias($aliases, $db, $table);
|
|
|
|
// Print data comment
|
|
$output = $this->exportComment(
|
|
$tableAlias !== ''
|
|
? 'Table data for ' . Util::backquote($tableAlias)
|
|
: '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 ($this->caption) {
|
|
$output .= "|+'''" . $tableAlias . "'''" . $this->exportCRLF();
|
|
}
|
|
|
|
// Add the table headers
|
|
if ($this->headers) {
|
|
// Get column names
|
|
$columnNames = $this->dbi->getColumnNames($db, $table);
|
|
|
|
// Add column names as table headers
|
|
if ($columnNames !== []) {
|
|
// Use '|-' for separating rows
|
|
$output .= '|-' . $this->exportCRLF();
|
|
|
|
// Use '!' for separating table headers
|
|
foreach ($columnNames as $column) {
|
|
$column = $this->getColumnAlias($aliases, $db, $table, $column);
|
|
|
|
$output .= ' ! ' . $column . $this->exportCRLF();
|
|
}
|
|
}
|
|
}
|
|
|
|
// Get the table data from the database
|
|
$result = $this->dbi->query($sqlQuery, ConnectionType::User, DatabaseInterface::QUERY_UNBUFFERED);
|
|
$fieldsCnt = $result->numFields();
|
|
$fieldsMeta = $this->dbi->getFieldsMeta($result);
|
|
|
|
while ($row = $result->fetchRow()) {
|
|
$output .= '|-' . $this->exportCRLF();
|
|
|
|
// Use '|' for separating table columns
|
|
/** @infection-ignore-all */
|
|
for ($i = 0; $i < $fieldsCnt; ++$i) {
|
|
if (! isset($row[$i])) {
|
|
$row[$i] = 'NULL';
|
|
} elseif ($fieldsMeta[$i]->isMappedTypeGeometry || $fieldsMeta[$i]->isBinary) {
|
|
$row[$i] = '0x' . bin2hex($row[$i]);
|
|
}
|
|
|
|
$output .= ' | ' . $row[$i] . $this->exportCRLF();
|
|
}
|
|
}
|
|
|
|
// End table construction
|
|
$output .= '|}' . str_repeat($this->exportCRLF(), 2);
|
|
|
|
$this->outputHandler->addLine($output);
|
|
}
|
|
|
|
/**
|
|
* Outputs result raw query in MediaWiki format
|
|
*
|
|
* @param string $db the database where the query is executed
|
|
* @param string $sqlQuery the rawquery to output
|
|
*/
|
|
public function exportRawQuery(string $db, string $sqlQuery): void
|
|
{
|
|
if ($db !== '') {
|
|
$this->dbi->selectDb($db);
|
|
}
|
|
|
|
$this->exportData($db, '', $sqlQuery);
|
|
}
|
|
|
|
/**
|
|
* Outputs comments containing info about the exported tables
|
|
*
|
|
* @param string $text Text of comment
|
|
*
|
|
* @return string The formatted comment
|
|
*/
|
|
private function exportComment(string $text = ''): string
|
|
{
|
|
// 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(): string
|
|
{
|
|
// The CRLF expected by the mediawiki format is "\n"
|
|
return "\n";
|
|
}
|
|
|
|
public function setExportOptions(ServerRequest $request, Export $exportConfig): void
|
|
{
|
|
// phpcs:disable Squiz.NamingConventions.ValidVariableName.MemberNotCamelCaps
|
|
$this->structureOrData = $this->setStructureOrData(
|
|
$request->getParsedBodyParam('mediawiki_structure_or_data'),
|
|
$exportConfig->mediawiki_structure_or_data,
|
|
StructureOrData::Data,
|
|
);
|
|
$this->caption = $request->hasBodyParam('mediawiki_caption');
|
|
$this->headers = $request->hasBodyParam('mediawiki_headers');
|
|
// phpcs:enable Squiz.NamingConventions.ValidVariableName.MemberNotCamelCaps
|
|
}
|
|
}
|
