376 lines
10 KiB
PHP
376 lines
10 KiB
PHP
<?php
|
|
/**
|
|
* Set of methods used to build dumps of tables as JSON
|
|
*/
|
|
|
|
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\Items\BoolPropertyItem;
|
|
use PhpMyAdmin\Properties\Options\Items\HiddenPropertyItem;
|
|
use PhpMyAdmin\Properties\Plugins\ExportPluginProperties;
|
|
use const JSON_PRETTY_PRINT;
|
|
use const JSON_UNESCAPED_UNICODE;
|
|
use function bin2hex;
|
|
use function explode;
|
|
use function json_encode;
|
|
use function stripslashes;
|
|
|
|
/**
|
|
* Handles the export for the JSON format
|
|
*/
|
|
class ExportJson extends ExportPlugin
|
|
{
|
|
/** @var bool */
|
|
private $first = true;
|
|
|
|
public function __construct()
|
|
{
|
|
parent::__construct();
|
|
$this->setProperties();
|
|
}
|
|
|
|
/**
|
|
* Encodes the data into JSON
|
|
*
|
|
* @param mixed $data Data to encode
|
|
*
|
|
* @return string
|
|
*/
|
|
public function encode($data)
|
|
{
|
|
$options = 0;
|
|
if (isset($GLOBALS['json_pretty_print'])
|
|
&& $GLOBALS['json_pretty_print']
|
|
) {
|
|
$options |= JSON_PRETTY_PRINT;
|
|
}
|
|
if (isset($GLOBALS['json_unicode'])
|
|
&& $GLOBALS['json_unicode']
|
|
) {
|
|
$options |= JSON_UNESCAPED_UNICODE;
|
|
}
|
|
|
|
return json_encode($data, $options);
|
|
}
|
|
|
|
/**
|
|
* Sets the export JSON properties
|
|
*
|
|
* @return void
|
|
*/
|
|
protected function setProperties()
|
|
{
|
|
$exportPluginProperties = new ExportPluginProperties();
|
|
$exportPluginProperties->setText('JSON');
|
|
$exportPluginProperties->setExtension('json');
|
|
$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');
|
|
// create primary items and add them to the group
|
|
$leaf = new HiddenPropertyItem('structure_or_data');
|
|
$generalOptions->addProperty($leaf);
|
|
|
|
$leaf = new BoolPropertyItem(
|
|
'pretty_print',
|
|
__('Output pretty-printed JSON (Use human-readable formatting)')
|
|
);
|
|
$generalOptions->addProperty($leaf);
|
|
|
|
$leaf = new BoolPropertyItem(
|
|
'unicode',
|
|
__('Output unicode characters unescaped')
|
|
);
|
|
$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;
|
|
}
|
|
|
|
/**
|
|
* Outputs export header
|
|
*
|
|
* @return bool Whether it succeeded
|
|
*/
|
|
public function exportHeader()
|
|
{
|
|
global $crlf;
|
|
|
|
$meta = [
|
|
'type' => 'header',
|
|
'version' => PMA_VERSION,
|
|
'comment' => 'Export to JSON plugin for PHPMyAdmin',
|
|
];
|
|
|
|
return $this->export->outputHandler(
|
|
'[' . $crlf . $this->encode($meta) . ',' . $crlf
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Outputs export footer
|
|
*
|
|
* @return bool Whether it succeeded
|
|
*/
|
|
public function exportFooter()
|
|
{
|
|
global $crlf;
|
|
|
|
return $this->export->outputHandler(']' . $crlf);
|
|
}
|
|
|
|
/**
|
|
* Outputs database header
|
|
*
|
|
* @param string $db Database name
|
|
* @param string $db_alias Aliases of db
|
|
*
|
|
* @return bool Whether it succeeded
|
|
*/
|
|
public function exportDBHeader($db, $db_alias = '')
|
|
{
|
|
global $crlf;
|
|
|
|
if (empty($db_alias)) {
|
|
$db_alias = $db;
|
|
}
|
|
|
|
$meta = [
|
|
'type' => 'database',
|
|
'name' => $db_alias,
|
|
];
|
|
|
|
return $this->export->outputHandler(
|
|
$this->encode($meta) . ',' . $crlf
|
|
);
|
|
}
|
|
|
|
/**
|
|
* 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
|
|
* @param string $export_type 'server', 'database', 'table'
|
|
* @param string $db_alias Aliases of db
|
|
*
|
|
* @return bool Whether it succeeded
|
|
*/
|
|
public function exportDBCreate($db, $export_type, $db_alias = '')
|
|
{
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Outputs the content of a table in JSON 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
|
|
* @param array $aliases Aliases of db/table/columns
|
|
*
|
|
* @return bool Whether it succeeded
|
|
*/
|
|
public function exportData(
|
|
$db,
|
|
$table,
|
|
$crlf,
|
|
$error_url,
|
|
$sql_query,
|
|
array $aliases = []
|
|
) {
|
|
global $dbi;
|
|
|
|
$db_alias = $db;
|
|
$table_alias = $table;
|
|
$this->initAlias($aliases, $db_alias, $table_alias);
|
|
|
|
if (! $this->first) {
|
|
if (! $this->export->outputHandler(',')) {
|
|
return false;
|
|
}
|
|
} else {
|
|
$this->first = false;
|
|
}
|
|
|
|
$buffer = $this->encode(
|
|
[
|
|
'type' => 'table',
|
|
'name' => $table_alias,
|
|
'database' => $db_alias,
|
|
'data' => '@@DATA@@',
|
|
]
|
|
);
|
|
|
|
return $this->doExportForQuery(
|
|
$dbi,
|
|
$sql_query,
|
|
$buffer,
|
|
$crlf,
|
|
$aliases,
|
|
$db,
|
|
$table
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Export to JSON
|
|
*
|
|
* @return bool False on export fail and true on export end success
|
|
*
|
|
* @phpstan-param array{
|
|
* string: array{
|
|
* 'tables': array{
|
|
* string: array{
|
|
* 'columns': array{string: string}
|
|
* }
|
|
* }
|
|
* }
|
|
* }|array|null $aliases
|
|
*/
|
|
protected function doExportForQuery(
|
|
DatabaseInterface $dbi,
|
|
string $sql_query,
|
|
string $buffer,
|
|
string $crlf,
|
|
?array $aliases,
|
|
?string $db,
|
|
?string $table
|
|
): bool {
|
|
[$header, $footer] = explode('"@@DATA@@"', $buffer);
|
|
|
|
if (! $this->export->outputHandler($header . $crlf . '[' . $crlf)) {
|
|
return false;
|
|
}
|
|
|
|
$result = $dbi->query(
|
|
$sql_query,
|
|
DatabaseInterface::CONNECT_USER,
|
|
DatabaseInterface::QUERY_UNBUFFERED
|
|
);
|
|
$columns_cnt = $dbi->numFields($result);
|
|
$fieldsMeta = $dbi->getFieldsMeta($result);
|
|
|
|
$columns = [];
|
|
for ($i = 0; $i < $columns_cnt; $i++) {
|
|
$col_as = $dbi->fieldName($result, $i);
|
|
if ($db !== null && $table !== null && $aliases !== null
|
|
&& ! empty($aliases[$db]['tables'][$table]['columns'][$col_as])
|
|
) {
|
|
$col_as = $aliases[$db]['tables'][$table]['columns'][$col_as];
|
|
}
|
|
$columns[$i] = stripslashes($col_as);
|
|
}
|
|
|
|
$record_cnt = 0;
|
|
while ($record = $dbi->fetchRow($result)) {
|
|
$record_cnt++;
|
|
|
|
// Output table name as comment if this is the first record of the table
|
|
if ($record_cnt > 1) {
|
|
if (! $this->export->outputHandler(',' . $crlf)) {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
$data = [];
|
|
|
|
for ($i = 0; $i < $columns_cnt; $i++) {
|
|
// 63 is the binary charset, see: https://dev.mysql.com/doc/internals/en/charsets.html
|
|
$isBlobAndIsBinaryCharset = $fieldsMeta[$i]->type === 'blob' && $fieldsMeta[$i]->charsetnr === 63;
|
|
// This can occur for binary fields
|
|
$isBinaryString = $fieldsMeta[$i]->type === 'string' && $fieldsMeta[$i]->charsetnr === 63;
|
|
if (
|
|
(
|
|
$fieldsMeta[$i]->type === 'geometry'
|
|
|| $isBlobAndIsBinaryCharset
|
|
|| $isBinaryString
|
|
)
|
|
&& $record[$i] !== null
|
|
) {
|
|
// export GIS and blob types as hex
|
|
$record[$i] = '0x' . bin2hex($record[$i]);
|
|
}
|
|
$data[$columns[$i]] = $record[$i];
|
|
}
|
|
|
|
$encodedData = $this->encode($data);
|
|
if (! $encodedData) {
|
|
return false;
|
|
}
|
|
if (! $this->export->outputHandler($encodedData)) {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
if (! $this->export->outputHandler($crlf . ']' . $crlf . $footer . $crlf)) {
|
|
return false;
|
|
}
|
|
|
|
$dbi->freeResult($result);
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Outputs result raw query in JSON format
|
|
*
|
|
* @param string $err_url the url to go back in case of error
|
|
* @param string $sql_query the rawquery to output
|
|
* @param string $crlf the end of line sequence
|
|
*
|
|
* @return bool if succeeded
|
|
*/
|
|
public function exportRawQuery(string $err_url, string $sql_query, string $crlf): bool
|
|
{
|
|
global $dbi;
|
|
|
|
$buffer = $this->encode(
|
|
[
|
|
'type' => 'raw',
|
|
'data' => '@@DATA@@',
|
|
]
|
|
);
|
|
|
|
return $this->doExportForQuery(
|
|
$dbi,
|
|
$sql_query,
|
|
$buffer,
|
|
$crlf,
|
|
null,
|
|
null,
|
|
null
|
|
);
|
|
}
|
|
}
|