406 lines
12 KiB
PHP
406 lines
12 KiB
PHP
|
<?php
|
||
|
|
|
||
|
|
declare(strict_types=1);
|
||
|
|
|
||
|
|
namespace PhpMyAdmin\Controllers\Table;
|
||
|
|
|
||
|
|
use PhpMyAdmin\ConfigStorage\Relation;
|
||
|
|
use PhpMyAdmin\ConfigStorage\RelationCleanup;
|
||
|
|
use PhpMyAdmin\Core;
|
||
|
|
use PhpMyAdmin\DatabaseInterface;
|
||
|
|
use PhpMyAdmin\DbTableExists;
|
||
|
|
use PhpMyAdmin\Operations;
|
||
|
|
use PhpMyAdmin\ResponseRenderer;
|
||
|
|
use PhpMyAdmin\Sql;
|
||
|
|
use PhpMyAdmin\Table\Search;
|
||
|
|
use PhpMyAdmin\Template;
|
||
|
|
use PhpMyAdmin\Transformations;
|
||
|
|
use PhpMyAdmin\Url;
|
||
|
|
use PhpMyAdmin\Util;
|
||
|
|
use PhpMyAdmin\Utils\Gis;
|
||
|
|
|
||
|
|
use function in_array;
|
||
|
|
use function intval;
|
||
|
|
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 search tab.
|
||
|
|
*
|
||
|
|
* Display table search form, create SQL query from form data
|
||
|
|
* and call Sql::executeQueryAndSendQueryResponse() to execute it.
|
||
|
|
*/
|
||
|
|
class SearchController extends AbstractController
|
||
|
|
{
|
||
|
|
/**
|
||
|
|
* Names of columns
|
||
|
|
*
|
||
|
|
* @var array
|
||
|
|
*/
|
||
|
|
private $columnNames;
|
||
|
|
/**
|
||
|
|
* Types of columns
|
||
|
|
*
|
||
|
|
* @var array
|
||
|
|
*/
|
||
|
|
private $columnTypes;
|
||
|
|
/**
|
||
|
|
* Types of columns without any replacement
|
||
|
|
*
|
||
|
|
* @var array
|
||
|
|
*/
|
||
|
|
private $originalColumnTypes;
|
||
|
|
/**
|
||
|
|
* Collations of columns
|
||
|
|
*
|
||
|
|
* @var array
|
||
|
|
*/
|
||
|
|
private $columnCollations;
|
||
|
|
/**
|
||
|
|
* Null Flags of columns
|
||
|
|
*
|
||
|
|
* @var array
|
||
|
|
*/
|
||
|
|
private $columnNullFlags;
|
||
|
|
/**
|
||
|
|
* Whether a geometry column is present
|
||
|
|
*
|
||
|
|
* @var bool
|
||
|
|
*/
|
||
|
|
private $geomColumnFlag;
|
||
|
|
/**
|
||
|
|
* Foreign Keys
|
||
|
|
*
|
||
|
|
* @var array
|
||
|
|
*/
|
||
|
|
private $foreigners;
|
||
|
|
|
||
|
|
/** @var Search */
|
||
|
|
private $search;
|
||
|
|
|
||
|
|
/** @var Relation */
|
||
|
|
private $relation;
|
||
|
|
|
||
|
|
/** @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();
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* 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);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Index action
|
||
|
|
*/
|
||
|
|
public function __invoke(): void
|
||
|
|
{
|
||
|
|
global $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',
|
||
|
|
'table/select.js',
|
||
|
|
'table/change.js',
|
||
|
|
'vendor/jquery/jquery.uitablefilter.js',
|
||
|
|
'gis_data_editor.js',
|
||
|
|
]);
|
||
|
|
|
||
|
|
if (isset($_POST['range_search'])) {
|
||
|
|
$this->rangeSearchAction();
|
||
|
|
|
||
|
|
return;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* No selection criteria received -> display the selection form
|
||
|
|
*/
|
||
|
|
if (! isset($_POST['columnsToDisplay']) && ! isset($_POST['displayAllColumns'])) {
|
||
|
|
$this->displaySelectionFormAction();
|
||
|
|
} else {
|
||
|
|
$this->doSelectionAction();
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* 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 (isset($fields_meta[$i]) && $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);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Do selection action
|
||
|
|
*/
|
||
|
|
public function doSelectionAction(): void
|
||
|
|
{
|
||
|
|
/**
|
||
|
|
* Selection criteria have been submitted -> do the work
|
||
|
|
*/
|
||
|
|
$sql_query = $this->search->buildSqlQuery();
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Add this to ensure following procedures included running correctly.
|
||
|
|
*/
|
||
|
|
$sql = new Sql(
|
||
|
|
$this->dbi,
|
||
|
|
$this->relation,
|
||
|
|
new RelationCleanup($this->dbi, $this->relation),
|
||
|
|
new Operations($this->dbi, $this->relation),
|
||
|
|
new Transformations(),
|
||
|
|
$this->template
|
||
|
|
);
|
||
|
|
|
||
|
|
$this->response->addHTML($sql->executeQueryAndSendQueryResponse(
|
||
|
|
null, // analyzed_sql_results
|
||
|
|
false, // is_gotofile
|
||
|
|
$this->db, // db
|
||
|
|
$this->table, // table
|
||
|
|
null, // find_real_end
|
||
|
|
null, // sql_query_for_bookmark
|
||
|
|
null, // extra_data
|
||
|
|
null, // message_to_show
|
||
|
|
null, // sql_data
|
||
|
|
$GLOBALS['goto'], // goto
|
||
|
|
null, // disp_query
|
||
|
|
null, // disp_message
|
||
|
|
$sql_query, // sql_query
|
||
|
|
null // complete_query
|
||
|
|
));
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Display selection form action
|
||
|
|
*/
|
||
|
|
public function displaySelectionFormAction(): void
|
||
|
|
{
|
||
|
|
global $goto, $cfg;
|
||
|
|
|
||
|
|
if (! isset($goto)) {
|
||
|
|
$goto = Util::getScriptNameForOption($cfg['DefaultTabTable'], 'table');
|
||
|
|
}
|
||
|
|
|
||
|
|
$this->render('table/search/index', [
|
||
|
|
'db' => $this->db,
|
||
|
|
'table' => $this->table,
|
||
|
|
'goto' => $goto,
|
||
|
|
'self' => $this,
|
||
|
|
'geom_column_flag' => $this->geomColumnFlag,
|
||
|
|
'column_names' => $this->columnNames,
|
||
|
|
'column_types' => $this->columnTypes,
|
||
|
|
'column_collations' => $this->columnCollations,
|
||
|
|
'default_sliders_state' => $cfg['InitialSlidersState'],
|
||
|
|
'max_rows' => intval($cfg['MaxRows']),
|
||
|
|
]);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Range search action
|
||
|
|
*/
|
||
|
|
public function rangeSearchAction(): void
|
||
|
|
{
|
||
|
|
$min_max = $this->getColumnMinMax($_POST['column']);
|
||
|
|
$this->response->addJSON('column_data', $min_max);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Finds minimum and maximum value of a given column.
|
||
|
|
*
|
||
|
|
* @param string $column Column name
|
||
|
|
*
|
||
|
|
* @return array|null
|
||
|
|
*/
|
||
|
|
public function getColumnMinMax($column): ?array
|
||
|
|
{
|
||
|
|
$sql_query = 'SELECT MIN(' . Util::backquote($column) . ') AS `min`, '
|
||
|
|
. 'MAX(' . Util::backquote($column) . ') AS `max` '
|
||
|
|
. 'FROM ' . Util::backquote($this->db) . '.'
|
||
|
|
. Util::backquote($this->table);
|
||
|
|
|
||
|
|
return $this->dbi->fetchSingleRow($sql_query);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* 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 . ', \'#tbl_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,
|
||
|
|
];
|
||
|
|
}
|
||
|
|
}
|