468 lines
16 KiB
PHP
468 lines
16 KiB
PHP
|
<?php
|
||
|
|
||
|
declare(strict_types=1);
|
||
|
|
||
|
namespace PhpMyAdmin\Controllers\Table;
|
||
|
|
||
|
use PhpMyAdmin\ConfigStorage\Relation;
|
||
|
use PhpMyAdmin\Core;
|
||
|
use PhpMyAdmin\DatabaseInterface;
|
||
|
use PhpMyAdmin\DbTableExists;
|
||
|
use PhpMyAdmin\ResponseRenderer;
|
||
|
use PhpMyAdmin\Table\Search;
|
||
|
use PhpMyAdmin\Template;
|
||
|
use PhpMyAdmin\Url;
|
||
|
use PhpMyAdmin\Util;
|
||
|
use PhpMyAdmin\Utils\Gis;
|
||
|
|
||
|
use function array_search;
|
||
|
use function array_values;
|
||
|
use function count;
|
||
|
use function htmlspecialchars;
|
||
|
use function in_array;
|
||
|
use function intval;
|
||
|
use function is_numeric;
|
||
|
use function json_encode;
|
||
|
use function mb_strtolower;
|
||
|
use function md5;
|
||
|
use function preg_match;
|
||
|
use function preg_replace;
|
||
|
use function str_ireplace;
|
||
|
use function str_replace;
|
||
|
use function strncasecmp;
|
||
|
use function strtoupper;
|
||
|
|
||
|
/**
|
||
|
* Handles table zoom search tab.
|
||
|
*
|
||
|
* Display table zoom search form, create SQL queries from form data.
|
||
|
*/
|
||
|
class ZoomSearchController extends AbstractController
|
||
|
{
|
||
|
/** @var Search */
|
||
|
private $search;
|
||
|
|
||
|
/** @var Relation */
|
||
|
private $relation;
|
||
|
|
||
|
/** @var array */
|
||
|
private $columnNames;
|
||
|
|
||
|
/** @var array */
|
||
|
private $columnTypes;
|
||
|
|
||
|
/** @var array */
|
||
|
private $originalColumnTypes;
|
||
|
|
||
|
/** @var array */
|
||
|
private $columnCollations;
|
||
|
|
||
|
/** @var array */
|
||
|
private $columnNullFlags;
|
||
|
|
||
|
/** @var bool Whether a geometry column is present */
|
||
|
private $geomColumnFlag;
|
||
|
|
||
|
/** @var array Foreign keys */
|
||
|
private $foreigners;
|
||
|
|
||
|
/** @var DatabaseInterface */
|
||
|
private $dbi;
|
||
|
|
||
|
public function __construct(
|
||
|
ResponseRenderer $response,
|
||
|
Template $template,
|
||
|
string $db,
|
||
|
string $table,
|
||
|
Search $search,
|
||
|
Relation $relation,
|
||
|
DatabaseInterface $dbi
|
||
|
) {
|
||
|
parent::__construct($response, $template, $db, $table);
|
||
|
$this->search = $search;
|
||
|
$this->relation = $relation;
|
||
|
$this->dbi = $dbi;
|
||
|
|
||
|
$this->columnNames = [];
|
||
|
$this->columnTypes = [];
|
||
|
$this->originalColumnTypes = [];
|
||
|
$this->columnCollations = [];
|
||
|
$this->columnNullFlags = [];
|
||
|
$this->geomColumnFlag = false;
|
||
|
$this->foreigners = [];
|
||
|
$this->loadTableInfo();
|
||
|
}
|
||
|
|
||
|
public function __invoke(): void
|
||
|
{
|
||
|
global $goto, $db, $table, $urlParams, $cfg, $errorUrl;
|
||
|
|
||
|
Util::checkParameters(['db', 'table']);
|
||
|
|
||
|
$urlParams = ['db' => $db, 'table' => $table];
|
||
|
$errorUrl = Util::getScriptNameForOption($cfg['DefaultTabTable'], 'table');
|
||
|
$errorUrl .= Url::getCommon($urlParams, '&');
|
||
|
|
||
|
DbTableExists::check();
|
||
|
|
||
|
$this->addScriptFiles([
|
||
|
'makegrid.js',
|
||
|
'sql.js',
|
||
|
'vendor/jqplot/jquery.jqplot.js',
|
||
|
'vendor/jqplot/plugins/jqplot.canvasTextRenderer.js',
|
||
|
'vendor/jqplot/plugins/jqplot.canvasAxisLabelRenderer.js',
|
||
|
'vendor/jqplot/plugins/jqplot.dateAxisRenderer.js',
|
||
|
'vendor/jqplot/plugins/jqplot.highlighter.js',
|
||
|
'vendor/jqplot/plugins/jqplot.cursor.js',
|
||
|
'table/zoom_plot_jqplot.js',
|
||
|
'table/change.js',
|
||
|
]);
|
||
|
|
||
|
/**
|
||
|
* Handle AJAX request for data row on point select
|
||
|
*/
|
||
|
if (isset($_POST['get_data_row']) && $_POST['get_data_row'] == true) {
|
||
|
$this->getDataRowAction();
|
||
|
|
||
|
return;
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Handle AJAX request for changing field information
|
||
|
* (value,collation,operators,field values) in input form
|
||
|
*/
|
||
|
if (isset($_POST['change_tbl_info']) && $_POST['change_tbl_info'] == true) {
|
||
|
$this->changeTableInfoAction();
|
||
|
|
||
|
return;
|
||
|
}
|
||
|
|
||
|
//Set default datalabel if not selected
|
||
|
if (! isset($_POST['zoom_submit']) || $_POST['dataLabel'] == '') {
|
||
|
$dataLabel = $this->relation->getDisplayField($this->db, $this->table);
|
||
|
} else {
|
||
|
$dataLabel = $_POST['dataLabel'];
|
||
|
}
|
||
|
|
||
|
// Displays the zoom search form
|
||
|
$this->displaySelectionFormAction($dataLabel);
|
||
|
|
||
|
/**
|
||
|
* Handle the input criteria and generate the query result
|
||
|
* Form for displaying query results
|
||
|
*/
|
||
|
if (
|
||
|
! isset($_POST['zoom_submit'])
|
||
|
|| $_POST['criteriaColumnNames'][0] === 'pma_null'
|
||
|
|| $_POST['criteriaColumnNames'][1] === 'pma_null'
|
||
|
|| $_POST['criteriaColumnNames'][0] == $_POST['criteriaColumnNames'][1]
|
||
|
) {
|
||
|
return;
|
||
|
}
|
||
|
|
||
|
if (! isset($goto)) {
|
||
|
$goto = Util::getScriptNameForOption($GLOBALS['cfg']['DefaultTabTable'], 'table');
|
||
|
}
|
||
|
|
||
|
$this->zoomSubmitAction($dataLabel, $goto);
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Gets all the columns of a table along with their types, collations
|
||
|
* and whether null or not.
|
||
|
*/
|
||
|
private function loadTableInfo(): void
|
||
|
{
|
||
|
// Gets the list and number of columns
|
||
|
$columns = $this->dbi->getColumns($this->db, $this->table, true);
|
||
|
// Get details about the geometry functions
|
||
|
$geom_types = Gis::getDataTypes();
|
||
|
|
||
|
foreach ($columns as $row) {
|
||
|
// set column name
|
||
|
$this->columnNames[] = $row['Field'];
|
||
|
|
||
|
$type = (string) $row['Type'];
|
||
|
// before any replacement
|
||
|
$this->originalColumnTypes[] = mb_strtolower($type);
|
||
|
// check whether table contains geometric columns
|
||
|
if (in_array($type, $geom_types)) {
|
||
|
$this->geomColumnFlag = true;
|
||
|
}
|
||
|
|
||
|
// reformat mysql query output
|
||
|
if (strncasecmp($type, 'set', 3) == 0 || strncasecmp($type, 'enum', 4) == 0) {
|
||
|
$type = str_replace(',', ', ', $type);
|
||
|
} else {
|
||
|
// strip the "BINARY" attribute, except if we find "BINARY(" because
|
||
|
// this would be a BINARY or VARBINARY column type
|
||
|
if (! preg_match('@BINARY[\(]@i', $type)) {
|
||
|
$type = str_ireplace('BINARY', '', $type);
|
||
|
}
|
||
|
|
||
|
$type = str_ireplace('ZEROFILL', '', $type);
|
||
|
$type = str_ireplace('UNSIGNED', '', $type);
|
||
|
$type = mb_strtolower($type);
|
||
|
}
|
||
|
|
||
|
if (empty($type)) {
|
||
|
$type = ' ';
|
||
|
}
|
||
|
|
||
|
$this->columnTypes[] = $type;
|
||
|
$this->columnNullFlags[] = $row['Null'];
|
||
|
$this->columnCollations[] = ! empty($row['Collation']) && $row['Collation'] !== 'NULL'
|
||
|
? $row['Collation']
|
||
|
: '';
|
||
|
}
|
||
|
|
||
|
// Retrieve foreign keys
|
||
|
$this->foreigners = $this->relation->getForeigners($this->db, $this->table);
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Display selection form action
|
||
|
*
|
||
|
* @param string $dataLabel Data label
|
||
|
*/
|
||
|
public function displaySelectionFormAction($dataLabel = null): void
|
||
|
{
|
||
|
global $goto;
|
||
|
|
||
|
if (! isset($goto)) {
|
||
|
$goto = Util::getScriptNameForOption($GLOBALS['cfg']['DefaultTabTable'], 'table');
|
||
|
}
|
||
|
|
||
|
$column_names = $this->columnNames;
|
||
|
$criteria_column_names = $_POST['criteriaColumnNames'] ?? null;
|
||
|
$keys = [];
|
||
|
for ($i = 0; $i < 4; $i++) {
|
||
|
if (! isset($criteria_column_names[$i])) {
|
||
|
continue;
|
||
|
}
|
||
|
|
||
|
if ($criteria_column_names[$i] === 'pma_null') {
|
||
|
continue;
|
||
|
}
|
||
|
|
||
|
$keys[$criteria_column_names[$i]] = array_search($criteria_column_names[$i], $column_names);
|
||
|
}
|
||
|
|
||
|
$this->render('table/zoom_search/index', [
|
||
|
'db' => $this->db,
|
||
|
'table' => $this->table,
|
||
|
'goto' => $goto,
|
||
|
'self' => $this,
|
||
|
'geom_column_flag' => $this->geomColumnFlag,
|
||
|
'column_names' => $column_names,
|
||
|
'data_label' => $dataLabel,
|
||
|
'keys' => $keys,
|
||
|
'criteria_column_names' => $criteria_column_names,
|
||
|
'criteria_column_types' => $_POST['criteriaColumnTypes'] ?? null,
|
||
|
'max_plot_limit' => ! empty($_POST['maxPlotLimit'])
|
||
|
? intval($_POST['maxPlotLimit'])
|
||
|
: intval($GLOBALS['cfg']['maxRowPlotLimit']),
|
||
|
]);
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Get data row action
|
||
|
*/
|
||
|
public function getDataRowAction(): void
|
||
|
{
|
||
|
if (! Core::checkSqlQuerySignature($_POST['where_clause'], $_POST['where_clause_sign'])) {
|
||
|
return;
|
||
|
}
|
||
|
|
||
|
$extra_data = [];
|
||
|
$row_info_query = 'SELECT * FROM ' . Util::backquote($_POST['db']) . '.'
|
||
|
. Util::backquote($_POST['table']) . ' WHERE ' . $_POST['where_clause'];
|
||
|
$result = $this->dbi->query($row_info_query . ';');
|
||
|
$fields_meta = $this->dbi->getFieldsMeta($result);
|
||
|
while ($row = $result->fetchAssoc()) {
|
||
|
// for bit fields we need to convert them to printable form
|
||
|
$i = 0;
|
||
|
foreach ($row as $col => $val) {
|
||
|
if ($fields_meta[$i]->isMappedTypeBit) {
|
||
|
$row[$col] = Util::printableBitValue((int) $val, (int) $fields_meta[$i]->length);
|
||
|
}
|
||
|
|
||
|
$i++;
|
||
|
}
|
||
|
|
||
|
$extra_data['row_info'] = $row;
|
||
|
}
|
||
|
|
||
|
$this->response->addJSON($extra_data);
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Change table info action
|
||
|
*/
|
||
|
public function changeTableInfoAction(): void
|
||
|
{
|
||
|
$field = $_POST['field'];
|
||
|
if ($field === 'pma_null') {
|
||
|
$this->response->addJSON('field_type', '');
|
||
|
$this->response->addJSON('field_collation', '');
|
||
|
$this->response->addJSON('field_operators', '');
|
||
|
$this->response->addJSON('field_value', '');
|
||
|
|
||
|
return;
|
||
|
}
|
||
|
|
||
|
$key = array_search($field, $this->columnNames);
|
||
|
$search_index = (isset($_POST['it']) && is_numeric($_POST['it'])
|
||
|
? intval($_POST['it']) : 0);
|
||
|
|
||
|
$properties = $this->getColumnProperties($search_index, $key);
|
||
|
$this->response->addJSON(
|
||
|
'field_type',
|
||
|
htmlspecialchars($properties['type'])
|
||
|
);
|
||
|
$this->response->addJSON('field_collation', $properties['collation']);
|
||
|
$this->response->addJSON('field_operators', $properties['func']);
|
||
|
$this->response->addJSON('field_value', $properties['value']);
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Zoom submit action
|
||
|
*
|
||
|
* @param string $dataLabel Data label
|
||
|
* @param string $goto Goto
|
||
|
*/
|
||
|
public function zoomSubmitAction($dataLabel, $goto): void
|
||
|
{
|
||
|
//Query generation part
|
||
|
$sql_query = $this->search->buildSqlQuery();
|
||
|
$sql_query .= ' LIMIT ' . $_POST['maxPlotLimit'];
|
||
|
|
||
|
//Query execution part
|
||
|
$result = $this->dbi->query($sql_query . ';');
|
||
|
$fields_meta = $this->dbi->getFieldsMeta($result);
|
||
|
$data = [];
|
||
|
while ($row = $result->fetchAssoc()) {
|
||
|
//Need a row with indexes as 0,1,2 for the getUniqueCondition
|
||
|
// hence using a temporary array
|
||
|
$tmpRow = array_values($row);
|
||
|
|
||
|
//Get unique condition on each row (will be needed for row update)
|
||
|
$uniqueCondition = Util::getUniqueCondition(
|
||
|
count($this->columnNames),
|
||
|
$fields_meta,
|
||
|
$tmpRow,
|
||
|
true
|
||
|
);
|
||
|
//Append it to row array as where_clause
|
||
|
$row['where_clause'] = $uniqueCondition[0];
|
||
|
$row['where_clause_sign'] = Core::signSqlQuery($uniqueCondition[0]);
|
||
|
|
||
|
$tmpData = [
|
||
|
$_POST['criteriaColumnNames'][0] => $row[$_POST['criteriaColumnNames'][0]],
|
||
|
$_POST['criteriaColumnNames'][1] => $row[$_POST['criteriaColumnNames'][1]],
|
||
|
'where_clause' => $uniqueCondition[0],
|
||
|
'where_clause_sign' => Core::signSqlQuery($uniqueCondition[0]),
|
||
|
];
|
||
|
$tmpData[$dataLabel] = $dataLabel ? $row[$dataLabel] : '';
|
||
|
$data[] = $tmpData;
|
||
|
}
|
||
|
|
||
|
unset($tmpData);
|
||
|
|
||
|
$column_names_hashes = [];
|
||
|
|
||
|
foreach ($this->columnNames as $columnName) {
|
||
|
$column_names_hashes[$columnName] = md5($columnName);
|
||
|
}
|
||
|
|
||
|
$this->render('table/zoom_search/result_form', [
|
||
|
'db' => $this->db,
|
||
|
'table' => $this->table,
|
||
|
'column_names' => $this->columnNames,
|
||
|
'column_names_hashes' => $column_names_hashes,
|
||
|
'foreigners' => $this->foreigners,
|
||
|
'column_null_flags' => $this->columnNullFlags,
|
||
|
'column_types' => $this->columnTypes,
|
||
|
'goto' => $goto,
|
||
|
'data' => $data,
|
||
|
'data_json' => json_encode($data),
|
||
|
'zoom_submit' => isset($_POST['zoom_submit']),
|
||
|
'foreign_max_limit' => $GLOBALS['cfg']['ForeignKeyMaxLimit'],
|
||
|
]);
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Provides a column's type, collation, operators list, and criteria value
|
||
|
* to display in table search form
|
||
|
*
|
||
|
* @param int $search_index Row number in table search form
|
||
|
* @param int $column_index Column index in ColumnNames array
|
||
|
*
|
||
|
* @return array Array containing column's properties
|
||
|
*/
|
||
|
public function getColumnProperties($search_index, $column_index)
|
||
|
{
|
||
|
$selected_operator = ($_POST['criteriaColumnOperators'][$search_index] ?? '');
|
||
|
$entered_value = ($_POST['criteriaValues'] ?? '');
|
||
|
//Gets column's type and collation
|
||
|
$type = $this->columnTypes[$column_index];
|
||
|
$collation = $this->columnCollations[$column_index];
|
||
|
$cleanType = preg_replace('@\(.*@s', '', $type);
|
||
|
//Gets column's comparison operators depending on column type
|
||
|
$typeOperators = $this->dbi->types->getTypeOperatorsHtml(
|
||
|
$cleanType,
|
||
|
$this->columnNullFlags[$column_index],
|
||
|
$selected_operator
|
||
|
);
|
||
|
$func = $this->template->render('table/search/column_comparison_operators', [
|
||
|
'search_index' => $search_index,
|
||
|
'type_operators' => $typeOperators,
|
||
|
]);
|
||
|
//Gets link to browse foreign data(if any) and criteria inputbox
|
||
|
$foreignData = $this->relation->getForeignData(
|
||
|
$this->foreigners,
|
||
|
$this->columnNames[$column_index],
|
||
|
false,
|
||
|
'',
|
||
|
''
|
||
|
);
|
||
|
$htmlAttributes = '';
|
||
|
if (in_array($cleanType, $this->dbi->types->getIntegerTypes())) {
|
||
|
$extractedColumnspec = Util::extractColumnSpec($this->originalColumnTypes[$column_index]);
|
||
|
$is_unsigned = $extractedColumnspec['unsigned'];
|
||
|
$minMaxValues = $this->dbi->types->getIntegerRange($cleanType, ! $is_unsigned);
|
||
|
$htmlAttributes = 'data-min="' . $minMaxValues[0] . '" '
|
||
|
. 'data-max="' . $minMaxValues[1] . '"';
|
||
|
}
|
||
|
|
||
|
$htmlAttributes .= ' onfocus="return '
|
||
|
. 'verifyAfterSearchFieldChange(' . $search_index . ', \'#zoom_search_form\')"';
|
||
|
|
||
|
$value = $this->template->render('table/search/input_box', [
|
||
|
'str' => '',
|
||
|
'column_type' => (string) $type,
|
||
|
'column_data_type' => strtoupper($cleanType),
|
||
|
'html_attributes' => $htmlAttributes,
|
||
|
'column_id' => 'fieldID_',
|
||
|
'in_zoom_search_edit' => false,
|
||
|
'foreigners' => $this->foreigners,
|
||
|
'column_name' => $this->columnNames[$column_index],
|
||
|
'column_name_hash' => md5($this->columnNames[$column_index]),
|
||
|
'foreign_data' => $foreignData,
|
||
|
'table' => $this->table,
|
||
|
'column_index' => $search_index,
|
||
|
'foreign_max_limit' => $GLOBALS['cfg']['ForeignKeyMaxLimit'],
|
||
|
'criteria_values' => $entered_value,
|
||
|
'db' => $this->db,
|
||
|
'in_fbs' => true,
|
||
|
]);
|
||
|
|
||
|
return [
|
||
|
'type' => $type,
|
||
|
'collation' => $collation,
|
||
|
'func' => $func,
|
||
|
'value' => $value,
|
||
|
];
|
||
|
}
|
||
|
}
|