phpmyadmin/src/Controllers/Table/ReplaceController.php
Kamil Tekiela cf6d5ed4b5
Use getParsedBodyParamAsString (#19333)
* Use getParsedBodyParamAsString
* Remove unused stubs

---------

Signed-off-by: Kamil Tekiela <tekiela246@gmail.com>
2024-10-29 12:07:39 -03:00

516 lines
20 KiB
PHP

<?php
declare(strict_types=1);
namespace PhpMyAdmin\Controllers\Table;
use PhpMyAdmin\ConfigStorage\Relation;
use PhpMyAdmin\Controllers\Database\SqlController as DatabaseSqlController;
use PhpMyAdmin\Controllers\InvocableController;
use PhpMyAdmin\Controllers\Sql\SqlController;
use PhpMyAdmin\Controllers\Table\SqlController as TableSqlController;
use PhpMyAdmin\Core;
use PhpMyAdmin\Current;
use PhpMyAdmin\DatabaseInterface;
use PhpMyAdmin\EditField;
use PhpMyAdmin\File;
use PhpMyAdmin\Html\Generator;
use PhpMyAdmin\Http\Response;
use PhpMyAdmin\Http\ServerRequest;
use PhpMyAdmin\InsertEdit;
use PhpMyAdmin\Message;
use PhpMyAdmin\MessageType;
use PhpMyAdmin\Plugins\IOTransformationsPlugin;
use PhpMyAdmin\Query\Generator as QueryGenerator;
use PhpMyAdmin\ResponseRenderer;
use PhpMyAdmin\Table\Table;
use PhpMyAdmin\Transformations;
use PhpMyAdmin\Util;
use function __;
use function array_keys;
use function array_values;
use function implode;
use function in_array;
use function is_array;
use function parse_str;
use function sprintf;
/**
* Manipulation of table data like inserting, replacing and updating.
*/
final class ReplaceController implements InvocableController
{
public function __construct(
private readonly ResponseRenderer $response,
private readonly InsertEdit $insertEdit,
private readonly Transformations $transformations,
private readonly Relation $relation,
private readonly DatabaseInterface $dbi,
private readonly SqlController $sqlController,
private readonly DatabaseSqlController $databaseSqlController,
private readonly ChangeController $changeController,
private readonly TableSqlController $tableSqlController,
) {
}
public function __invoke(ServerRequest $request): Response
{
$GLOBALS['urlParams'] ??= null;
$GLOBALS['message'] ??= null;
if (! $this->response->checkParameters(['db', 'table', 'goto'])) {
return $this->response->response();
}
$GLOBALS['errorUrl'] ??= null;
$GLOBALS['unsaved_values'] ??= null;
$GLOBALS['disp_query'] ??= null;
$GLOBALS['disp_message'] ??= null;
$GLOBALS['query'] ??= null;
$this->dbi->selectDb(Current::$database);
$this->response->addScriptFiles(['makegrid.js', 'sql.js', 'gis_data_editor.js']);
$afterInsert = $request->getParsedBodyParamAsStringOrNull('after_insert');
if (in_array($afterInsert, ['new_insert', 'same_insert', 'edit_next'], true)) {
$GLOBALS['urlParams']['after_insert'] = $afterInsert;
$whereClause = $request->getParsedBodyParam('where_clause');
if ($whereClause !== null) {
foreach ($whereClause as $oneWhereClause) {
if ($afterInsert === 'same_insert') {
$GLOBALS['urlParams']['where_clause'][] = $oneWhereClause;
} elseif ($afterInsert === 'edit_next') {
$this->insertEdit->setSessionForEditNext($oneWhereClause);
}
}
}
}
//get $goto_include for different cases
$gotoInclude = $this->insertEdit->getGotoInclude(false);
// Defines the url to return in case of failure of the query
$GLOBALS['errorUrl'] = $this->insertEdit->getErrorUrl($GLOBALS['urlParams']);
/**
* Prepares the update/insert of a row
*/
[$loopArray, $usingKey, $isInsert] = $this->getParamsForUpdateOrInsert($request);
$isInsertignore = $request->getParsedBodyParam('submit_type') === 'insertignore';
$GLOBALS['query'] = [];
$valueSets = [];
$mimeMap = $this->transformations->getMime(Current::$database, Current::$table) ?? [];
$queryFields = [];
$insertErrors = [];
$rowSkipped = false;
$GLOBALS['unsaved_values'] = [];
/** @var string|int $whereClause */
foreach ($loopArray as $rowNumber => $whereClause) {
// skip fields to be ignored
if (! $usingKey && $request->hasBodyParam('insert_ignore_' . $whereClause)) {
continue;
}
// Defines the SET part of the sql query
$queryValues = [];
// Map multi-edit keys to single-level arrays, dependent on how we got the fields
$multiEditColumns = $request->getParsedBodyParam('fields')['multi_edit'][$rowNumber] ?? [];
$multiEditColumnsName = $request->getParsedBodyParam('fields_name')['multi_edit'][$rowNumber] ?? [];
$multiEditColumnsPrev = $request->getParsedBodyParam('fields_prev')['multi_edit'][$rowNumber] ?? [];
$multiEditFuncs = $request->getParsedBodyParam('funcs')['multi_edit'][$rowNumber] ?? [];
$multiEditSalt = $request->getParsedBodyParam('salt')['multi_edit'][$rowNumber] ?? [];
$multiEditColumnsType = $request->getParsedBodyParam('fields_type')['multi_edit'][$rowNumber] ?? [];
$multiEditColumnsNull = $request->getParsedBodyParam('fields_null')['multi_edit'][$rowNumber] ?? [];
$multiEditColumnsNullPrev =
$request->getParsedBodyParam('fields_null_prev')['multi_edit'][$rowNumber] ?? [];
$multiEditAutoIncrement = $request->getParsedBodyParam('auto_increment')['multi_edit'][$rowNumber] ?? [];
$multiEditVirtual = $request->getParsedBodyParam('virtual')['multi_edit'][$rowNumber] ?? [];
// Iterate in the order of $multi_edit_columns_name,
// not $multi_edit_columns, to avoid problems
// when inserting multiple entries
$insertFail = false;
/** @var int|string $key */
foreach ($multiEditColumnsName as $key => $columnName) {
// Note: $key is an md5 of the fieldname. The actual fieldname is
// available in $multi_edit_columns_name[$key]
// When a select field is nullified, it's not present in $_POST so initialize it
$multiEditColumns[$key] ??= '';
/** @var string[]|string $currentValue */
$currentValue = $multiEditColumns[$key];
if (is_array($currentValue)) {
// Some column types accept comma-separated values e.g. set
$currentValue = implode(',', $currentValue);
}
$fileToInsert = new File();
$fileToInsert->checkTblChangeForm((string) $key, (string) $rowNumber);
$possiblyUploadedVal = $fileToInsert->getContent();
if ($possiblyUploadedVal !== false) {
$currentValue = $possiblyUploadedVal;
}
// Apply Input Transformation if defined
if (
! empty($mimeMap[$columnName])
&& ! empty($mimeMap[$columnName]['input_transformation'])
) {
$filename = $mimeMap[$columnName]['input_transformation'];
$transformationPlugin = $this->transformations->getPluginInstance($filename);
if ($transformationPlugin instanceof IOTransformationsPlugin) {
$transformationOptions = $this->transformations->getOptions(
$mimeMap[$columnName]['input_transformation_options'],
);
$currentValue = $transformationPlugin->applyTransformation(
$currentValue,
$transformationOptions,
);
// check if transformation was successful or not
// and accordingly set error messages & insert_fail
if (! $transformationPlugin->isSuccess()) {
$insertFail = true;
$rowSkipped = true;
$insertErrors[] = sprintf(
__('Row: %1$s, Column: %2$s, Error: %3$s'),
$rowNumber,
$columnName,
$transformationPlugin->getError(),
);
}
}
}
if ($fileToInsert->isError()) {
$insertErrors[] = $fileToInsert->getError();
}
// delete $file_to_insert temporary variable
$fileToInsert->cleanUp();
$editField = new EditField(
$columnName,
$currentValue,
$multiEditColumnsType[$key] ?? '',
isset($multiEditAutoIncrement[$key]),
! empty($multiEditColumnsNull[$key]),
! empty($multiEditColumnsNullPrev[$key]),
$multiEditFuncs[$key] ?? '',
$multiEditSalt[$key] ?? null,
$multiEditColumnsPrev[$key] ?? null,
$possiblyUploadedVal !== false,
);
if (! isset($multiEditVirtual[$key])) {
if ($isInsert) {
$queryPart = $this->insertEdit->getQueryValueForInsert($editField, $usingKey, $whereClause);
if ($queryPart !== '' && $valueSets === []) {
// first inserted row so prepare the list of fields
$queryFields[] = Util::backquote($editField->columnName);
}
} else {
$queryPart = $this->insertEdit->getQueryValueForUpdate($editField);
}
if ($queryPart !== '') {
$queryValues[] = $queryPart;
}
}
// phpcs:ignore SlevomatCodingStandard.ControlStructures.EarlyExit.EarlyExitNotUsed
if ($editField->isNull) {
$multiEditColumns[$key] = null;
}
}
// temporarily store rows not inserted
// so that they can be populated again.
if ($insertFail) {
$GLOBALS['unsaved_values'][$rowNumber] = $multiEditColumns;
}
if ($insertFail || $queryValues === []) {
continue;
}
if ($isInsert) {
$valueSets[] = implode(', ', $queryValues);
} else {
// build update query
$clauseIsUnique = $request->getParam('clause_is_unique', '');// Should contain 0 or 1
$GLOBALS['query'][] = 'UPDATE ' . Util::backquote(Current::$table)
. ' SET ' . implode(', ', $queryValues)
. ' WHERE ' . $whereClause
. ($clauseIsUnique ? '' : ' LIMIT 1');
}
}
unset(
$multiEditColumnsName,
$multiEditColumnsPrev,
$multiEditFuncs,
$multiEditColumnsType,
$multiEditColumnsNull,
$multiEditAutoIncrement,
$key,
$currentValue,
$whereClause,
$multiEditColumnsNullPrev,
$insertFail,
$multiEditColumns,
);
// Builds the sql query
if ($isInsert && $valueSets !== []) {
$GLOBALS['query'] = (array) QueryGenerator::buildInsertSqlQuery(
Current::$table,
$isInsertignore,
$queryFields,
$valueSets,
);
} elseif (empty($GLOBALS['query']) && ! $request->hasBodyParam('preview_sql') && ! $rowSkipped) {
// No change -> move back to the calling script
//
// Note: logic passes here for inline edit
$GLOBALS['message'] = Message::success(__('No change'));
// Avoid infinite recursion
if ($gotoInclude === '/table/replace') {
$gotoInclude = '/table/change';
}
return $this->moveBackToCallingScript($gotoInclude, $request);
}
// If there is a request for SQL previewing.
if ($request->hasBodyParam('preview_sql')) {
Core::previewSQL($GLOBALS['query']);
return $this->response->response();
}
$returnToSqlQuery = '';
if (! empty($GLOBALS['sql_query'])) {
$GLOBALS['urlParams']['sql_query'] = $GLOBALS['sql_query'];
$returnToSqlQuery = $GLOBALS['sql_query'];
}
/**
* Executes the sql query and get the result, then move back to the calling
* page
*/
[
$totalAffectedRows,
$lastMessages,
$warningMessages,
$errorMessages,
] = $this->insertEdit->executeSqlQuery($GLOBALS['query']);
if ($isInsert && ($valueSets !== [] || $rowSkipped)) {
$GLOBALS['message'] = Message::getMessageForInsertedRows($totalAffectedRows);
$GLOBALS['unsaved_values'] = array_values($GLOBALS['unsaved_values']);
} else {
$GLOBALS['message'] = Message::getMessageForAffectedRows($totalAffectedRows);
}
if ($rowSkipped) {
$gotoInclude = '/table/change';
$GLOBALS['message']->addMessagesString($insertErrors, '<br>');
$GLOBALS['message']->setType(MessageType::Error);
}
$GLOBALS['message']->addMessages($lastMessages, '<br>');
if (! empty($warningMessages)) {
$GLOBALS['message']->addMessagesString($warningMessages, '<br>');
$GLOBALS['message']->setType(MessageType::Error);
}
if (! empty($errorMessages)) {
$GLOBALS['message']->addMessagesString($errorMessages);
$GLOBALS['message']->setType(MessageType::Error);
}
/**
* The following section only applies to grid editing.
* However, verifying isAjax() is not enough to ensure we are coming from
* grid editing. If we are coming from the Edit or Copy link in Browse mode,
* ajax_page_request is present in the POST parameters.
*/
if ($request->isAjax() && ! $request->hasBodyParam('ajax_page_request')) {
/**
* If we are in grid editing, we need to process the relational and
* transformed fields, if they were edited. After that, output the correct
* link/transformed value and exit
*/
$this->doTransformations($mimeMap, $request);
return $this->response->response();
}
if (! empty($returnToSqlQuery)) {
$GLOBALS['disp_query'] = $GLOBALS['sql_query'];
$GLOBALS['disp_message'] = $GLOBALS['message'];
unset($GLOBALS['message']);
$GLOBALS['sql_query'] = $returnToSqlQuery;
}
$this->response->addScriptFiles(['vendor/jquery/additional-methods.js', 'table/change.js']);
/**
* If user asked for "and then Insert another new row" we have to remove
* WHERE clause information so that /table/change does not go back
* to the current record
*/
if ($afterInsert === 'new_insert') {
unset($_POST['where_clause']);
}
return $this->moveBackToCallingScript($gotoInclude, $request);
}
/** @param string[][] $mimeMap */
private function doTransformations(array $mimeMap, ServerRequest $request): void
{
$relFieldsList = $request->getParsedBodyParamAsString('rel_fields_list', '');
if ($relFieldsList !== '') {
$foreigners = $this->relation->getForeigners(Current::$database, Current::$table);
/** @var array<int,array> $relationFields */
$relationFields = [];
parse_str($relFieldsList, $relationFields);
// loop for each relation cell
foreach ($relationFields as $cellIndex => $currRelField) {
foreach ($currRelField as $relationField => $relationFieldValue) {
$whereComparison = "='" . $relationFieldValue . "'";
$dispval = $this->insertEdit->getDisplayValueForForeignTableColumn(
$whereComparison,
$foreigners,
$relationField,
);
$extraData['relations'][$cellIndex] = $this->insertEdit->getLinkForRelationalDisplayField(
$foreigners,
$relationField,
$whereComparison,
$dispval,
$relationFieldValue,
);
}
}
}
if ($request->getParsedBodyParam('do_transformations') == true) {
$editedValues = [];
parse_str($request->getParsedBodyParamAsString('transform_fields_list'), $editedValues);
if (! isset($extraData)) {
$extraData = [];
}
$transformationTypes = ['input_transformation', 'transformation'];
foreach ($mimeMap as $transformation) {
$columnName = $transformation['column_name'];
foreach ($transformationTypes as $type) {
$file = Core::securePath($transformation[$type]);
$extraData = $this->insertEdit->transformEditedValues(
Current::$database,
Current::$table,
$transformation,
$editedValues,
$file,
$columnName,
$extraData,
$type,
);
}
}
}
// Need to check the inline edited value can be truncated by MySQL
// without informing while saving
$columnName = $request->getParsedBodyParam('fields_name')['multi_edit'][0][0];
$this->insertEdit->verifyWhetherValueCanBeTruncatedAndAppendExtraData(
Current::$database,
Current::$table,
$columnName,
$extraData,
);
/**Get the total row count of the table*/
$tableObj = new Table(
$request->getParsedBodyParamAsString('table'),
$request->getParsedBodyParamAsString('db'),
$this->dbi,
);
$extraData['row_count'] = $tableObj->countRecords();
$extraData['sql_query'] = Generator::getMessage($GLOBALS['message'], $GLOBALS['display_query']);
$this->response->setRequestStatus($GLOBALS['message']->isSuccess());
$this->response->addJSON('message', $GLOBALS['message']);
$this->response->addJSON($extraData);
}
private function moveBackToCallingScript(string $gotoInclude, ServerRequest $request): Response
{
if ($gotoInclude === '/sql') {
return ($this->sqlController)($request);
}
if ($gotoInclude === '/database/sql') {
return ($this->databaseSqlController)($request);
}
if ($gotoInclude === '/table/sql') {
return ($this->tableSqlController)($request);
}
return ($this->changeController)($request);
}
/**
* Prepares the update/insert of a row
*
* @return mixed[] $loop_array, $using_key, $is_insert
* @psalm-return array{array, bool, bool}
*/
private function getParamsForUpdateOrInsert(ServerRequest $request): array
{
$whereClause = $request->getParsedBodyParam('where_clause');
if ($whereClause !== null) {
// we were editing something => use the WHERE clause
$loopArray = is_array($whereClause)
? $whereClause
: [$whereClause];
$usingKey = true;
$submitType = $request->getParsedBodyParam('submit_type');
$isInsert = $submitType === 'insert'
|| $submitType === 'showinsert'
|| $submitType === 'insertignore';
} else {
// new row => use indexes
$loopArray = [];
$fields = $request->getParsedBodyParam('fields');
if (is_array($fields)) {
$loopArray = array_keys($fields['multi_edit']);
}
$usingKey = false;
$isInsert = true;
}
return [$loopArray, $usingKey, $isInsert];
}
}