phpmyadmin/src/InsertEdit.php
Maurício Meneghini Fauth 5df240f767
Extract HTML from InsertEdit::getHtmlInput()
Signed-off-by: Maurício Meneghini Fauth <mauricio@mfauth.net>
2025-05-29 16:47:35 -03:00

1915 lines
69 KiB
PHP

<?php
declare(strict_types=1);
namespace PhpMyAdmin;
use PhpMyAdmin\ConfigStorage\Relation;
use PhpMyAdmin\Dbal\DatabaseInterface;
use PhpMyAdmin\Dbal\ResultInterface;
use PhpMyAdmin\Html\Generator;
use PhpMyAdmin\I18n\LanguageManager;
use PhpMyAdmin\Plugins\IOTransformationsPlugin;
use PhpMyAdmin\Plugins\TransformationsInterface;
use PhpMyAdmin\Utils\Gis;
use function __;
use function array_fill;
use function array_key_exists;
use function array_merge;
use function array_values;
use function bin2hex;
use function count;
use function htmlspecialchars;
use function implode;
use function in_array;
use function is_array;
use function is_numeric;
use function is_string;
use function json_encode;
use function max;
use function mb_stripos;
use function mb_strlen;
use function min;
use function password_hash;
use function preg_match;
use function preg_replace;
use function str_contains;
use function str_replace;
use function str_starts_with;
use function stripslashes;
use function trim;
use const ENT_COMPAT;
use const PASSWORD_DEFAULT;
class InsertEdit
{
private const FUNC_OPTIONAL_PARAM = ['NOW', 'RAND', 'UNIX_TIMESTAMP'];
private const FUNC_NO_PARAM = [
'CONNECTION_ID',
'CURRENT_USER',
'CURDATE',
'CURTIME',
'CURRENT_DATE',
'CURRENT_TIME',
'DATABASE',
'LAST_INSERT_ID',
'NOW',
'PI',
'RAND',
'SYSDATE',
'UNIX_TIMESTAMP',
'USER',
'UTC_DATE',
'UTC_TIME',
'UTC_TIMESTAMP',
'UUID',
'UUID_SHORT',
'VERSION',
];
private int $rowOffset = 0;
private int $fieldIndex = 0;
/** @var string[] */
public static array $pluginScripts = [];
public function __construct(
private readonly DatabaseInterface $dbi,
private readonly Relation $relation,
private readonly Transformations $transformations,
private readonly FileListing $fileListing,
private readonly Template $template,
private readonly Config $config,
) {
}
/**
* Retrieve form parameters for insert/edit form
*
* @param string $db name of the database
* @param string $table name of the table
* @param string[] $whereClauseArray
*
* @return array<string, string> array of insert/edit form parameters
*/
public function getFormParametersForInsertForm(
string $db,
string $table,
array $whereClauseArray,
string $errorUrl,
): array {
$formParams = [
'db' => $db,
'table' => $table,
'goto' => UrlParams::$goto,
'err_url' => $errorUrl,
'sql_query' => $_POST['sql_query'] ?? '',
];
if ($formParams['sql_query'] === '' && isset($_GET['sql_query'], $_GET['sql_signature'])) {
if (Core::checkSqlQuerySignature($_GET['sql_query'], $_GET['sql_signature'])) {
$formParams['sql_query'] = $_GET['sql_query'];
}
}
foreach ($whereClauseArray as $keyId => $whereClause) {
$formParams['where_clause[' . $keyId . ']'] = trim($whereClause);
}
if (isset($_POST['clause_is_unique'])) {
$formParams['clause_is_unique'] = $_POST['clause_is_unique'];
} elseif (isset($_GET['clause_is_unique'])) {
$formParams['clause_is_unique'] = $_GET['clause_is_unique'];
}
return $formParams;
}
/**
* Analysing where clauses array
*
* @param string[] $whereClauseArray array of where clauses
* @param string $table name of the table
* @param string $db name of the database
*
* @return array{ResultInterface[], array<string|null>[], bool}
*/
private function analyzeWhereClauses(
array $whereClauseArray,
string $table,
string $db,
): array {
$rows = [];
$result = [];
$foundUniqueKey = false;
foreach ($whereClauseArray as $keyId => $whereClause) {
$localQuery = 'SELECT * FROM '
. Util::backquote($db) . '.'
. Util::backquote($table)
. ' WHERE ' . $whereClause . ';';
$result[$keyId] = $this->dbi->query($localQuery);
$rows[$keyId] = $result[$keyId]->fetchAssoc();
if ($rows[$keyId] === []) {
ResponseRenderer::getInstance()->addHTML(
Generator::getMessage(
__('MySQL returned an empty result set (i.e. zero rows).'),
$localQuery,
),
);
/**
* @todo not sure what should be done at this point, but we must not
* exit if we want the message to be displayed
*/
continue;
}
if (! $this->hasUniqueCondition($rows[$keyId], $result[$keyId])) {
continue;
}
$foundUniqueKey = true;
}
return [$result, $rows, $foundUniqueKey];
}
/** @param array<string|null> $row */
private function hasUniqueCondition(array $row, ResultInterface $result): bool
{
$meta = $this->dbi->getFieldsMeta($result);
return (bool) (new UniqueCondition($meta, $row, true))->getWhereClause();
}
/**
* No primary key given, just load first row
*/
private function loadFirstRow(string $table, string $db): ResultInterface
{
return $this->dbi->query(
'SELECT * FROM ' . Util::backquote($db)
. '.' . Util::backquote($table) . ' LIMIT 1;',
);
}
/** @return never[][] */
private function getInsertRows(): array
{
// Can be a string on some old configuration storage settings
return array_fill(0, $this->config->settings['InsertRows'], []);
}
/**
* Show type information or function selectors in Insert/Edit
*
* @param string $which function|type
* @param array<string, bool|int|string> $urlParams containing url parameters
* @param bool $isShow whether to show the element in $which
*
* @return string an HTML snippet
*/
public function showTypeOrFunction(string $which, array $urlParams, bool $isShow): string
{
$params = [];
switch ($which) {
case 'function':
$params['ShowFunctionFields'] = $isShow ? 0 : 1;
$params['ShowFieldTypesInDataEditView'] = $this->config->settings['ShowFieldTypesInDataEditView'];
break;
case 'type':
$params['ShowFieldTypesInDataEditView'] = $isShow ? 0 : 1;
$params['ShowFunctionFields'] = $this->config->settings['ShowFunctionFields'];
break;
}
$params['goto'] = Url::getFromRoute('/sql');
$thisUrlParams = array_merge($urlParams, $params);
if (! $isShow) {
return ' : <a href="' . Url::getFromRoute('/table/change') . '" data-post="'
. Url::getCommon($thisUrlParams, '', false) . '">'
. $this->showTypeOrFunctionLabel($which)
. '</a>';
}
return '<th><a href="' . Url::getFromRoute('/table/change') . '" data-post="'
. Url::getCommon($thisUrlParams, '', false)
. '" title="' . __('Hide') . '">'
. $this->showTypeOrFunctionLabel($which)
. '</a></th>';
}
/**
* Show type information or function selectors labels in Insert/Edit
*
* @param string $which function|type
*
* @return string an HTML snippet
*/
private function showTypeOrFunctionLabel(string $which): string
{
return match ($which) {
'function' => __('Function'),
'type' => __('Type'),
default => '',
};
}
/**
* Retrieve the column title
*
* @param string $fieldName name of the column
* @param string[] $commentsMap comments for every column that has a comment
*
* @return string column title
*/
private function getColumnTitle(string $fieldName, array $commentsMap): string
{
if (isset($commentsMap[$fieldName])) {
return '<span style="border-bottom: 1px dashed black;" title="'
. htmlspecialchars($commentsMap[$fieldName]) . '">'
. htmlspecialchars($fieldName) . '</span>';
}
return htmlspecialchars($fieldName);
}
/**
* check whether the column is of a certain type
* the goal is to ensure that types such as "enum('one','two','binary',..)"
* or "enum('one','two','varbinary',..)" are not categorized as binary
*
* @param string $columnType column type as specified in the column definition
* @param string[] $types the types to verify
*/
public function isColumn(string $columnType, array $types): bool
{
foreach ($types as $oneType) {
if (mb_stripos($columnType, $oneType) === 0) {
return true;
}
}
return false;
}
/**
* Retrieve the nullify code for the null column
*
* @param InsertEditColumn $column description of column in given table
* @param mixed[] $foreigners keys into foreign fields
*/
private function getNullifyCodeForNullColumn(
InsertEditColumn $column,
array $foreigners,
bool $foreignLink,
): string {
$foreigner = $this->relation->searchColumnInForeigners($foreigners, $column->field);
if ($column->trueType === 'enum') {
$nullifyCode = mb_strlen($column->type) > 20 ? '1' : '2';
} elseif ($column->trueType === 'set') {
$nullifyCode = '3';
} elseif ($foreigner !== false && ! $foreignLink) {
// foreign key in a drop-down
$nullifyCode = '4';
} elseif ($foreigner !== false) {
// foreign key with a browsing icon
$nullifyCode = '6';
} else {
$nullifyCode = '5';
}
return $nullifyCode;
}
/**
* Get HTML textarea for insert form
*
* @param InsertEditColumn $column column information
* @param string $backupField hidden input field
* @param string $columnNameAppendix the name attribute
* @param string $onChangeClause onchange clause for fields
* @param string $specialCharsEncoded replaced char if the string starts
* with a \r\n pair (0x0d0a) add an extra \n
* @param TypeClass $dataType the html5 data-* attribute type
*
* @return string an html snippet
*/
private function getTextarea(
InsertEditColumn $column,
string $backupField,
string $columnNameAppendix,
string $onChangeClause,
string $specialCharsEncoded,
TypeClass $dataType,
): string {
$theClass = '';
$textAreaRows = $this->config->settings['TextareaRows'];
$textareaCols = $this->config->settings['TextareaCols'];
if ($column->isChar) {
/**
* @todo clarify the meaning of the "textfield" class and explain
* why character columns have the "char" class instead
*/
$theClass = 'charField';
$textAreaRows = $this->config->settings['CharTextareaRows'];
$textareaCols = $this->config->settings['CharTextareaCols'];
$extractedColumnspec = Util::extractColumnSpec($column->type);
$maxlength = $extractedColumnspec['spec_in_brackets'];
} elseif ($this->config->settings['LongtextDoubleTextarea'] && $column->trueType === 'longtext') {
$textAreaRows = $this->config->settings['TextareaRows'] * 2;
$textareaCols = $this->config->settings['TextareaCols'] * 2;
}
return $backupField . "\n"
. '<textarea name="fields' . $columnNameAppendix . '"'
. ' class="' . $theClass . '"'
. (isset($maxlength) ? ' data-maxlength="' . $maxlength . '"' : '')
. ' rows="' . $textAreaRows . '"'
. ' cols="' . $textareaCols . '"'
. ' dir="' . LanguageManager::$textDirection->value . '"'
. ' id="field_' . $this->fieldIndex . '_3"'
. ($onChangeClause !== '' ? ' onchange="' . htmlspecialchars($onChangeClause, ENT_COMPAT) . '"' : '')
. ' tabindex="' . $this->fieldIndex . '"'
. ' data-type="' . $dataType->value . '">'
. $specialCharsEncoded
. '</textarea>';
}
/** @return object{isInteger: bool, minValue: string, maxValue: string} */
private function getIntegerRange(InsertEditColumn $column): object
{
$minValue = '';
$maxValue = '';
$isInteger = in_array($column->trueType, $this->dbi->types->getIntegerTypes(), true);
if ($isInteger) {
$extractedColumnSpec = Util::extractColumnSpec($column->type);
$isUnsigned = $extractedColumnSpec['unsigned'];
$minMaxValues = $this->dbi->types->getIntegerRange($column->trueType, ! $isUnsigned);
$minValue = $minMaxValues[0];
$maxValue = $minMaxValues[1];
}
return new class ($isInteger, $minValue, $maxValue) {
public function __construct(
public readonly bool $isInteger,
public readonly string $minValue,
public readonly string $maxValue,
) {
}
};
}
/**
* Get HTML select option for upload
*
* @param string $vkey [multi_edit]['row_id']
* @param string $fieldHashMd5 array index as an MD5 to avoid having special characters
*
* @return string an HTML snippet
*/
private function getSelectOptionForUpload(string $vkey, string $fieldHashMd5): string
{
$files = $this->fileListing->getFileSelectOptions(
Util::userDir($this->config->settings['UploadDir'] ?? ''),
);
if ($files === false) {
return '<span style="color:red">' . __('Error') . '</span><br>' . "\n"
. __('The directory you set for upload work cannot be reached.') . "\n";
}
if ($files === '') {
return '';
}
return "<br>\n"
. '<i>' . __('Or') . '</i> '
. __('web server upload directory:') . '<br>' . "\n"
. '<select size="1" name="fields_uploadlocal'
. $vkey . '[' . $fieldHashMd5 . ']">' . "\n"
. '<option value="" selected></option>' . "\n"
. $files
. '</select>' . "\n";
}
/**
* Retrieve the maximum upload file size
*/
private function getMaxUploadSize(string $type): string
{
// find maximum upload size, based on field type
/**
* @todo with functions this is not so easy, as you can basically
* process any data with function like MD5
*/
$maxFieldSize = match ($type) {
'tinyblob' => 256,
'blob' => 65536,
'mediumblob' => 16777216,
'longblob' => 4294967296,// yeah, really
};
$thisFieldMaxSize = Util::getUploadSizeInBytes();
return Util::getFormattedMaximumUploadSize(min($thisFieldMaxSize, $maxFieldSize)) . "\n";
}
/**
* Get HTML for the Value column of other datatypes
* (here, "column" is used in the sense of HTML column in HTML table)
*
* @param InsertEditColumn $column description of column in given table
* @param string $defaultCharEditing default char editing mode which is stored
* in the config.inc.php script
* @param string $backupField hidden input field
* @param string $columnNameAppendix the name attribute
* @param string $onChangeClause onchange clause for fields
* @param string $specialChars special characters
* @param string $specialCharsEncoded replaced char if the string starts
* with a \r\n pair (0x0d0a) add an extra \n
* @param string $data data to edit
*
* @return string an html snippet
*/
private function getValueColumnForOtherDatatypes(
InsertEditColumn $column,
string $defaultCharEditing,
string $backupField,
string $columnNameAppendix,
string $onChangeClause,
string $specialChars,
string $specialCharsEncoded,
string $data,
string $specInBrackets,
): string {
// HTML5 data-* attribute data-type
$dataType = $this->dbi->types->getTypeClass($column->trueType);
$fieldsize = $this->getColumnSize($column, $specInBrackets);
$input = [];
$textareaHtml = '';
$isTextareaRequired = $column->isChar
&& ($this->config->settings['CharEditing'] === 'textarea' || str_contains($data, "\n"));
if ($isTextareaRequired) {
$this->config->settings['CharEditing'] = $defaultCharEditing;
$textareaHtml = $this->getTextarea(
$column,
$backupField,
$columnNameAppendix,
$onChangeClause,
$specialCharsEncoded,
$dataType,
);
} else {
$integerRange = $this->getIntegerRange($column);
$input = [
'value' => $specialChars,
'size' => $fieldsize,
'is_char' => $column->isChar,
'is_integer' => $integerRange->isInteger,
'min' => $integerRange->minValue,
'max' => $integerRange->maxValue,
'data_type' => $dataType->value,
'on_change_clause' => $onChangeClause,
'field_index' => $this->fieldIndex,
];
}
return $this->template->render('table/insert/value_column_for_other_datatype', [
'input' => $input,
'textarea_html' => $textareaHtml,
'backup_field' => $backupField,
'is_textarea' => $isTextareaRequired,
'column_name_appendix' => $columnNameAppendix,
'extra' => $column->extra,
'true_type' => $column->trueType,
]);
}
/**
* Get the field size
*
* @param InsertEditColumn $column description of column in given table
* @param string $specInBrackets text in brackets inside column definition
*
* @return int field size
*/
private function getColumnSize(InsertEditColumn $column, string $specInBrackets): int
{
if ($column->isChar) {
$fieldsize = (int) $specInBrackets;
if ($fieldsize > $this->config->settings['MaxSizeForInputField']) {
/**
* This case happens for CHAR or VARCHAR columns which have
* a size larger than the maximum size for input field.
*/
$this->config->settings['CharEditing'] = 'textarea';
}
} else {
/**
* This case happens for example for INT or DATE columns;
* in these situations, the value returned in $column['len']
* seems appropriate.
*/
$fieldsize = $column->length;
}
return min(
max($fieldsize, $this->config->settings['MinSizeForInputField']),
$this->config->settings['MaxSizeForInputField'],
);
}
/**
* get html for continue insertion form
*
* @param string $table name of the table
* @param string $db name of the database
* @param string[] $whereClauseArray
*
* @return string an html snippet
*/
public function getContinueInsertionForm(
string $table,
string $db,
array $whereClauseArray,
string $errorUrl,
): string {
return $this->template->render('table/insert/continue_insertion_form', [
'db' => $db,
'table' => $table,
'where_clause_array' => $whereClauseArray,
'err_url' => $errorUrl,
'goto' => UrlParams::$goto,
'sql_query' => $_POST['sql_query'] ?? null,
'has_where_clause' => isset($_POST['where_clause']),
'insert_rows_default' => $this->config->settings['InsertRows'],
]);
}
/**
* @param string[]|string|null $whereClause
*
* @psalm-pure
*/
public static function isWhereClauseNumeric(array|string|null $whereClause): bool
{
if ($whereClause === null) {
return false;
}
if (! is_array($whereClause)) {
$whereClause = [$whereClause];
}
// If we have just numeric primary key, we can also edit next
// we are looking for `table_name`.`field_name` = numeric_value
foreach ($whereClause as $clause) {
// preg_match() returns 1 if there is a match
$isNumeric = preg_match('@^[\s]*`[^`]*`[\.]`[^`]*` = [0-9]+@', $clause) === 1;
if ($isNumeric) {
return true;
}
}
return false;
}
/**
* Get table head and table foot for insert row table
*
* @param array<string, bool|int|string> $urlParams url parameters
*
* @return string an html snippet
*/
private function getHeadAndFootOfInsertRowTable(array $urlParams): string
{
$type = '';
$function = '';
if ($this->config->settings['ShowFieldTypesInDataEditView']) {
$type = $this->showTypeOrFunction('type', $urlParams, true);
}
if ($this->config->settings['ShowFunctionFields']) {
$function = $this->showTypeOrFunction('function', $urlParams, true);
}
$template = new Template();
return $template->render('table/insert/get_head_and_foot_of_insert_row_table', [
'type' => $type,
'function' => $function,
]);
}
/**
* Prepares the field value and retrieve special chars, backup field and data array
*
* @param array<string|null> $currentRow a row of the table
* @param InsertEditColumn $column description of column in given table
* @param string $columnNameAppendix string to append to column name in input
* @param bool $asIs use the data as is, used in repopulating
*
* @return array{bool, string, string, string, string}
*/
private function getSpecialCharsAndBackupFieldForExistingRow(
array $currentRow,
InsertEditColumn $column,
string $specInBrackets,
string $columnNameAppendix,
bool $asIs,
): array {
$specialCharsEncoded = '';
$data = '';
$realNullValue = false;
$currentValue = $currentRow[$column->field] ?? null;
// (we are editing)
if ($currentValue === null) {
$realNullValue = true;
$currentValue = '';
$specialChars = '';
$data = '';
} elseif ($column->trueType === 'bit') {
$specialChars = $asIs
? $currentValue
: Util::printableBitValue((int) $currentValue, (int) $specInBrackets);
} elseif (
($column->trueType === 'timestamp'
|| $column->trueType === 'datetime'
|| $column->trueType === 'time')
&& (str_contains($currentValue, '.'))
) {
$currentValue = $asIs
? $currentValue
: Util::addMicroseconds($currentValue);
$specialChars = htmlspecialchars($currentValue, ENT_COMPAT);
} elseif (in_array($column->trueType, Gis::getDataTypes(), true)) {
// Convert gis data to Well Know Text format
$currentValue = $asIs
? $currentValue
: Gis::convertToWellKnownText($currentValue, true);
$specialChars = htmlspecialchars($currentValue, ENT_COMPAT);
} else {
// special binary "characters"
if ($column->isBinary || ($column->isBlob && $this->config->settings['ProtectBinary'] !== 'all')) {
$currentValue = $asIs
? $currentValue
: bin2hex($currentValue);
}
$specialChars = htmlspecialchars($currentValue, ENT_COMPAT);
//We need to duplicate the first \n or otherwise we will lose
//the first newline entered in a VARCHAR or TEXT column
$specialCharsEncoded = Util::duplicateFirstNewline($specialChars);
$data = $currentValue;
}
/** @var string $defaultAction */
$defaultAction = $_POST['default_action'] ?? $_GET['default_action'] ?? '';
if (
$defaultAction === 'insert'
&& $column->key === 'PRI'
&& str_contains($column->extra, 'auto_increment')
) {
// When copying row, it is useful to empty auto-increment column to prevent duplicate key error.
$data = $specialCharsEncoded = $specialChars = '';
}
// If a timestamp field value is not included in an update
// statement MySQL auto-update it to the current timestamp;
// however, things have changed since MySQL 4.1, so
// it's better to set a fields_prev in this situation
$backupField = '<input type="hidden" name="fields_prev'
. $columnNameAppendix . '" value="'
. htmlspecialchars($currentValue, ENT_COMPAT) . '">';
return [$realNullValue, $specialCharsEncoded, $specialChars, $data, $backupField];
}
/**
* display default values
*/
private function getDefaultValue(
string|null $defaultValue,
string $trueType,
): string {
if ($defaultValue === null) {
$defaultValue = '';
}
if ($trueType === 'bit') {
return Util::convertBitDefaultValue($defaultValue);
}
if ($trueType === 'timestamp' || $trueType === 'datetime' || $trueType === 'time') {
return Util::addMicroseconds($defaultValue);
}
if ($trueType === 'binary' || $trueType === 'varbinary') {
return bin2hex($defaultValue);
}
return $defaultValue;
}
/**
* set $_SESSION for edit_next
*
* @param string $oneWhereClause one where clause from where clauses array
*/
public function setSessionForEditNext(string $oneWhereClause): void
{
$localQuery = 'SELECT * FROM ' . Util::backquote(Current::$database)
. '.' . Util::backquote(Current::$table) . ' WHERE '
. str_replace('` =', '` >', $oneWhereClause) . ' LIMIT 1;';
$res = $this->dbi->query($localQuery);
$row = $res->fetchRow();
$meta = $this->dbi->getFieldsMeta($res);
// must find a unique condition based on unique key,
// not a combination of all fields
$uniqueCondition = (new UniqueCondition($meta, $row, true))->getWhereClause();
if ($uniqueCondition === '') {
return;
}
$_SESSION['edit_next'] = $uniqueCondition;
}
/**
* set $goto_include variable for different cases and retrieve like,
* if UrlParams::$goto empty, if $goto_include previously not defined
* and new_insert, same_insert, edit_next
*
* @param string|false $gotoInclude store some script for include, otherwise it is
* boolean false
*/
public function getGotoInclude(string|false $gotoInclude): string
{
$validOptions = ['new_insert', 'same_insert', 'edit_next'];
if (isset($_POST['after_insert']) && in_array($_POST['after_insert'], $validOptions, true)) {
return '/table/change';
}
if (UrlParams::$goto !== '') {
if (preg_match('@^[a-z_]+\.php$@', UrlParams::$goto) !== 1) {
// this should NOT happen
//UrlParams::$goto = false;
$gotoInclude = str_contains(UrlParams::$goto, 'index.php?route=/sql') ? '/sql' : false;
} else {
$gotoInclude = UrlParams::$goto;
}
if (UrlParams::$goto === 'index.php?route=/database/sql' && Current::$table !== '') {
Current::$table = '';
}
}
if (! $gotoInclude) {
$gotoInclude = Current::$table === '' ? '/database/sql' : '/table/sql';
}
return $gotoInclude;
}
/**
* Defines the url to return in case of failure of the query
*
* @param mixed[] $urlParams url parameters
*
* @return string error url for query failure
*/
public function getErrorUrl(array $urlParams): string
{
return $_POST['err_url'] ?? Url::getFromRoute('/table/change', $urlParams);
}
/**
* Executes the sql query and get the result, then move back to the calling page
*
* @param string[] $query built query from buildSqlQuery()
*
* @return array{int, Message[], string[], string[]}
*/
public function executeSqlQuery(array $query): array
{
Current::$sqlQuery = implode('; ', $query) . ';';
// to ensure that the query is displayed in case of
// "insert as new row" and then "insert another new row"
Current::$displayQuery = Current::$sqlQuery;
$totalAffectedRows = 0;
$lastMessages = [];
$warningMessages = [];
$errorMessages = [];
foreach ($query as $singleQuery) {
if (isset($_POST['submit_type']) && $_POST['submit_type'] === 'showinsert') {
$lastMessages[] = Message::notice(__('Showing SQL query'));
continue;
}
if ($this->config->settings['IgnoreMultiSubmitErrors']) {
$result = $this->dbi->tryQuery($singleQuery);
} else {
$result = $this->dbi->query($singleQuery);
}
if (! $result) {
$errorMessages[] = $this->dbi->getError();
} else {
$totalAffectedRows += (int) $this->dbi->affectedRows();
$insertId = $this->dbi->insertId();
if ($insertId !== 0) {
// insert_id is id of FIRST record inserted in one insert, so if we
// inserted multiple rows, we had to increment this
if ($totalAffectedRows > 0) {
$insertId += $totalAffectedRows - 1;
}
$lastMessage = Message::notice(__('Inserted row id: %1$d'));
$lastMessage->addParam($insertId);
$lastMessages[] = $lastMessage;
}
}
$warningMessages = $this->getWarningMessages();
}
return [$totalAffectedRows, $lastMessages, $warningMessages, $errorMessages];
}
/**
* get the warning messages array
*
* @return string[]
*/
private function getWarningMessages(): array
{
$warningMessages = [];
foreach ($this->dbi->getWarnings() as $warning) {
$warningMessages[] = htmlspecialchars((string) $warning);
}
return $warningMessages;
}
/**
* Column to display from the foreign table?
*
* @param string $whereComparison string that contain relation field value
* @param mixed[] $foreigners all Relations to foreign tables for a given
* table or optionally a given column in a table
* @param string $relationField relation field
*
* @return string display value from the foreign table
*/
public function getDisplayValueForForeignTableColumn(
string $whereComparison,
array $foreigners,
string $relationField,
): string {
$foreigner = $this->relation->searchColumnInForeigners($foreigners, $relationField);
if (! is_array($foreigner)) {
return '';
}
$displayField = $this->relation->getDisplayField($foreigner['foreign_db'], $foreigner['foreign_table']);
// Field to display from the foreign table?
if ($displayField !== '') {
$dispsql = 'SELECT ' . Util::backquote($displayField)
. ' FROM ' . Util::backquote($foreigner['foreign_db'])
. '.' . Util::backquote($foreigner['foreign_table'])
. ' WHERE ' . Util::backquote($foreigner['foreign_field'])
. $whereComparison;
$dispresult = $this->dbi->tryQuery($dispsql);
if ($dispresult && $dispresult->numRows() > 0) {
return (string) $dispresult->fetchValue();
}
}
return '';
}
/**
* Display option in the cell according to user choices
*
* @param mixed[] $foreigners all Relations to foreign tables for a given
* table or optionally a given column in a table
* @param string $relationField relation field
* @param string $whereComparison string that contain relation field value
* @param string $dispval display value from the foreign table
* @param string $relationFieldValue relation field value
*
* @return string HTML <a> tag
*/
public function getLinkForRelationalDisplayField(
array $foreigners,
string $relationField,
string $whereComparison,
string $dispval,
string $relationFieldValue,
): string {
$foreigner = $this->relation->searchColumnInForeigners($foreigners, $relationField);
if (! is_array($foreigner)) {
return '';
}
if ($_SESSION['tmpval']['relational_display'] === 'K') {
// user chose "relational key" in the display options, so
// the title contains the display field
$title = $dispval !== ''
? ' title="' . htmlspecialchars($dispval) . '"'
: '';
} else {
$title = ' title="' . htmlspecialchars($relationFieldValue) . '"';
}
$sqlQuery = 'SELECT * FROM '
. Util::backquote($foreigner['foreign_db'])
. '.' . Util::backquote($foreigner['foreign_table'])
. ' WHERE ' . Util::backquote($foreigner['foreign_field'])
. $whereComparison;
$urlParams = [
'db' => $foreigner['foreign_db'],
'table' => $foreigner['foreign_table'],
'pos' => '0',
'sql_signature' => Core::signSqlQuery($sqlQuery),
'sql_query' => $sqlQuery,
];
$output = '<a href="' . Url::getFromRoute('/sql', $urlParams) . '"' . $title . '>';
if ($_SESSION['tmpval']['relational_display'] === 'D') {
// user chose "relational display field" in the
// display options, so show display field in the cell
$output .= htmlspecialchars($dispval);
} else {
// otherwise display data in the cell
$output .= htmlspecialchars($relationFieldValue);
}
$output .= '</a>';
return $output;
}
/**
* Transform edited values
*
* @param string $db db name
* @param string $table table name
* @param string[][] $editedValues transform columns list and new values
* @param string $file file containing the transformation plugin
* @param string $columnName column name
* @param string[][] $extraData extra data array
*
* @return string[][]
*/
public function transformEditedValues(
string $db,
string $table,
string $transformationOption,
array &$editedValues,
string $file,
string $columnName,
array $extraData,
): array {
// $cfg['SaveCellsAtOnce'] = true; JS code sends an array
$whereClause = is_array($_POST['where_clause']) ? $_POST['where_clause'][0] : $_POST['where_clause'];
$urlParams = [
'db' => $db,
'table' => $table,
'where_clause_sign' => Core::signSqlQuery($whereClause),
'where_clause' => $whereClause,
'transform_key' => $columnName,
];
$transformOptions = $this->transformations->getOptions($transformationOption);
$transformOptions['wrapper_link'] = Url::getCommon($urlParams);
$transformOptions['wrapper_params'] = $urlParams;
$transformationPlugin = $this->transformations->getPluginInstance($file);
if ($transformationPlugin instanceof TransformationsInterface) {
foreach ($editedValues as $cellIndex => $currCellEditedValues) {
if (! isset($currCellEditedValues[$columnName])) {
continue;
}
$extraData['transformations'][$cellIndex] = $transformationPlugin->applyTransformation(
$currCellEditedValues[$columnName],
$transformOptions,
);
$editedValues[$cellIndex][$columnName] = $extraData['transformations'][$cellIndex];
}
}
return $extraData;
}
/**
* Get value part if a function was specified
*
* @psalm-return non-empty-string
*/
private function formatAsSqlFunction(
EditField $editField,
): string {
if ($editField->function === 'PHP_PASSWORD_HASH') {
$hash = password_hash($editField->value, PASSWORD_DEFAULT);
return $this->dbi->quoteString($hash);
}
if ($editField->function === 'UUID') {
/* This way user will know what UUID new row has */
$uuid = (string) $this->dbi->fetchValue('SELECT UUID()');
return $this->dbi->quoteString($uuid);
}
if (
in_array($editField->function, $this->getGisFromTextFunctions(), true)
|| in_array($editField->function, $this->getGisFromWKBFunctions(), true)
) {
preg_match('/^(\'?)(.*?)\1(?:,(\d+))?$/', $editField->value, $matches);
$escapedParams = $this->dbi->quoteString($matches[2]) . (isset($matches[3]) ? ',' . $matches[3] : '');
return $editField->function . '(' . $escapedParams . ')';
}
if (
! in_array($editField->function, self::FUNC_NO_PARAM, true)
|| ($editField->value !== '' && in_array($editField->function, self::FUNC_OPTIONAL_PARAM, true))
) {
if (
($editField->salt !== null
&& ($editField->function === 'AES_ENCRYPT'
|| $editField->function === 'AES_DECRYPT'
|| $editField->function === 'SHA2'))
|| ($editField->salt
&& ($editField->function === 'DES_ENCRYPT'
|| $editField->function === 'DES_DECRYPT'
|| $editField->function === 'ENCRYPT'))
) {
return $editField->function . '(' . $this->dbi->quoteString($editField->value) . ','
. $this->dbi->quoteString($editField->salt) . ')';
}
if (
$editField->function === 'NOW'
&& (is_numeric($editField->value) && $editField->value >= 0 && $editField->value <= 6)
) {
return $editField->function . '(' . (int) $editField->value . ')';
}
return $editField->function . '(' . $this->dbi->quoteString($editField->value) . ')';
}
return $editField->function . '()';
}
/**
* Get the field value formatted for use in a SQL statement.
* Used in both INSERT and UPDATE statements.
*/
private function getValueFormattedAsSql(
EditField $editField,
string $protectedValue = '',
): string {
if ($editField->isUploaded) {
return $editField->value;
}
if ($editField->function !== '') {
return $this->formatAsSqlFunction($editField);
}
return $this->formatAsSqlValueBasedOnType($editField, $protectedValue);
}
/**
* Get query values array and query fields array for insert and update in multi edit
*
* @param string|int $whereClause Either a positional index or string representing selected row
*/
public function getQueryValueForInsert(
EditField $editField,
bool $usingKey,
string|int $whereClause,
): string {
$protectedValue = '';
if ($editField->type === 'protected' && $usingKey && $whereClause !== '') {
// Fetch the current values of a row to use in case we have a protected field
$protectedValue = $this->dbi->fetchValue(
'SELECT ' . Util::backquote($editField->columnName)
. ' FROM ' . Util::backquote(Current::$table)
. ' WHERE ' . $whereClause,
);
$protectedValue = is_string($protectedValue) ? $protectedValue : '';
}
return $this->getValueFormattedAsSql($editField, $protectedValue);
}
/**
* Get field-value pairs for update SQL.
* During update, we build the SQL only with the fields that should be updated.
*/
public function getQueryValueForUpdate(EditField $editField): string
{
$currentValueFormattedAsSql = $this->getValueFormattedAsSql($editField);
// avoid setting a field to NULL when it's already NULL
// (field had the null checkbox before the update; field still has the null checkbox)
if ($editField->wasPreviouslyNull && $editField->isNull) {
return '';
}
// A blob field that hasn't been changed will have no value
if ($currentValueFormattedAsSql === '') {
return '';
}
if (
// Field had the null checkbox before the update; field no longer has the null checkbox
$editField->wasPreviouslyNull ||
// Field was marked as NULL (the value will be unchanged if it was an empty string)
$editField->isNull ||
// A function was applied to the field
$editField->function !== '' ||
// The value was changed
$editField->value !== $editField->previousValue
) {
return Util::backquote($editField->columnName) . ' = ' . $currentValueFormattedAsSql;
}
return '';
}
/**
* Get the current column value in the form for different data types
*/
private function formatAsSqlValueBasedOnType(
EditField $editField,
string $protectedValue,
): string {
if ($editField->type === 'protected') {
// here we are in protected mode (asked in the config)
// so tbl_change has put this special value in the
// columns array, so we do not change the column value
// but we can still handle column upload
// when in UPDATE mode, do not alter field's contents. When in INSERT
// mode, insert empty field because no values were submitted.
// If protected blobs were set, insert original field's content.
if ($protectedValue !== '') {
return '0x' . bin2hex($protectedValue);
}
if ($editField->isNull) {
return 'NULL';
}
// The Null checkbox was unchecked for this field
if ($editField->wasPreviouslyNull) {
return "''";
}
return '';
}
if ($editField->value === '') {
// When the field is autoIncrement, the best way to avoid problems
// in strict mode is to set the value to null (works also in non-strict mode)
// If the value is empty and the null checkbox is checked, set it to null
return $editField->autoIncrement || $editField->isNull ? 'NULL' : "''";
}
if ($editField->type === 'hex') {
if (! str_starts_with($editField->value, '0x')) {
return '0x' . $editField->value;
}
return $editField->value;
}
if ($editField->type === 'bit') {
$currentValue = (string) preg_replace('/[^01]/', '0', $editField->value);
return 'b' . $this->dbi->quoteString($currentValue);
}
// For uuid type, generate uuid value
// if empty value but not set null or value is uuid() function
if (
$editField->type === 'uuid'
&& ! $editField->isNull
&& in_array($editField->value, ["''", '', "'uuid()'", 'uuid()'], true)
) {
return 'uuid()';
}
if (
($editField->type !== 'datetime' && $editField->type !== 'timestamp' && $editField->type !== 'date')
|| preg_match('/^current_timestamp(\([0-6]?\))?$/i', $editField->value) !== 1
) {
return $this->dbi->quoteString($editField->value);
}
// If there is a value, we ignore the Null checkbox;
// this could be possible if Javascript is disabled in the browser
return $editField->value;
}
/**
* Check whether inline edited value can be truncated or not,
* and add additional parameters for extra_data array if needed
*
* @param string $db Database name
* @param string $table Table name
* @param string $columnName Column name
* @param mixed[] $extraData Extra data for ajax response
*/
public function verifyWhetherValueCanBeTruncatedAndAppendExtraData(
string $db,
string $table,
string $columnName,
array &$extraData,
): void {
$extraData['isNeedToRecheck'] = false;
$sqlForRealValue = 'SELECT ' . Util::backquote($table) . '.'
. Util::backquote($columnName)
. ' FROM ' . Util::backquote($db) . '.'
. Util::backquote($table)
. ' WHERE ' . $_POST['where_clause'][0];
$result = $this->dbi->tryQuery($sqlForRealValue);
if (! $result) {
return;
}
$metadata = $this->dbi->getFieldsMeta($result)[0];
$newValue = $result->fetchValue();
if ($newValue === false) {
return;
}
if ($newValue !== null) {
if ($metadata->isTimeType()) {
$newValue = Util::addMicroseconds($newValue);
} elseif ($metadata->isBinary()) {
$newValue = '0x' . bin2hex($newValue);
}
}
$extraData['isNeedToRecheck'] = true;
$extraData['truncatableFieldValue'] = $newValue;
}
/**
* Function to get the columns of a table
*
* @param string $db current db
* @param string $table current table
*
* @return list<Column>
*/
public function getTableColumns(string $db, string $table): array
{
$this->dbi->selectDb($db);
return array_values($this->dbi->getColumns($db, $table));
}
/**
* Function to determine Insert/Edit rows
*
* @param string[]|string|null $whereClause where clause
* @param string $db current database
* @param string $table current table
*
* @return array{
* bool,
* string[]|string|null,
* ResultInterface[]|ResultInterface,
* array<string, string|null>[],
* bool,
* string|null
* }
*/
public function determineInsertOrEdit(array|string|null $whereClause, string $db, string $table): array
{
if (isset($_POST['where_clause'])) {
$whereClause = $_POST['where_clause'];
}
if (isset($_SESSION['edit_next'])) {
$whereClause = $_SESSION['edit_next'];
unset($_SESSION['edit_next']);
$afterInsert = 'edit_next';
}
if (isset($_POST['ShowFunctionFields'])) {
$this->config->settings['ShowFunctionFields'] = $_POST['ShowFunctionFields'];
}
if (isset($_POST['ShowFieldTypesInDataEditView'])) {
$this->config->settings['ShowFieldTypesInDataEditView'] = $_POST['ShowFieldTypesInDataEditView'];
}
if (isset($_POST['after_insert'])) {
$afterInsert = $_POST['after_insert'];
}
if ($whereClause !== null) {
// we are editing
$insertMode = false;
[$result, $rows, $foundUniqueKey] = $this->analyzeWhereClauses((array) $whereClause, $table, $db);
} else {
// we are inserting
$insertMode = true;
$result = $this->loadFirstRow($table, $db);
$rows = $this->getInsertRows();
$foundUniqueKey = false;
}
/** @var string $defaultAction */
$defaultAction = $_POST['default_action'] ?? $_GET['default_action'] ?? '';
if ($defaultAction === 'insert') {
// Copying a row - fetched data will be inserted as a new row, therefore the where clause is needless.
$whereClause = null;
}
return [
$insertMode,
$whereClause,
$result,
$rows,
$foundUniqueKey,
$afterInsert ?? null,
];
}
/**
* Function to get comments for the table columns
*
* @param string $db current database
* @param string $table current table
*
* @return string[] comments for columns
*/
public function getCommentsMap(string $db, string $table): array
{
if ($this->config->settings['ShowPropertyComments']) {
return $this->relation->getComments($db, $table);
}
return [];
}
/**
* Function to get html for the ignore option in insert mode
*
* @param int $rowId row id
* @param bool $checked ignore option is checked or not
*/
public function getHtmlForIgnoreOption(int $rowId, bool $checked = true): string
{
return '<input type="checkbox"'
. ($checked ? ' checked' : '')
. ' name="insert_ignore_' . $rowId . '"'
. ' id="insert_ignore_' . $rowId . '">'
. '<label for="insert_ignore_' . $rowId . '">'
. __('Ignore')
. '</label><br>' . "\n";
}
/**
* Function to get html for the insert edit form header
*
* @param bool $hasBlobField whether has blob field
* @param bool $isUpload whether is upload
*/
public function getHtmlForInsertEditFormHeader(bool $hasBlobField, bool $isUpload): string
{
$template = new Template();
return $template->render('table/insert/get_html_for_insert_edit_form_header', [
'has_blob_field' => $hasBlobField,
'is_upload' => $isUpload,
]);
}
/**
* Function to get html for each insert/edit column
*
* @param Column $tableColumn column
* @param int $columnNumber column index in table_columns
* @param string[] $commentsMap comments map
* @param int $columnLength length of the current column taken from field metadata
* @param bool $insertMode whether insert mode
* @param array<string|null> $currentRow current row
* @param int $columnsCnt columns count
* @param bool $isUpload whether upload
* @param mixed[] $foreigners foreigners
* @param string $table table
* @param string $db database
* @param int $rowId row id
* @param string $defaultCharEditing default char editing mode which is stored in config.inc.php
* @param mixed[] $repopulate the data to be repopulated
* @param string[] $columnMime the mime information of column
* @param string $whereClause the where clause
*/
private function getHtmlForInsertEditFormColumn(
Column $tableColumn,
int $columnNumber,
array $commentsMap,
int $columnLength,
bool $insertMode,
array $currentRow,
int $columnsCnt,
bool $isUpload,
array $foreigners,
string $table,
string $db,
int $rowId,
string $defaultCharEditing,
array $repopulate,
array $columnMime,
string $whereClause,
): string {
$column = new InsertEditColumn(
$tableColumn->field,
$tableColumn->type,
$tableColumn->isNull,
$tableColumn->key,
$tableColumn->default,
$tableColumn->extra,
$columnLength,
$this->isColumn($tableColumn->type, ['binary', 'varbinary']),
$this->isColumn($tableColumn->type, ['blob', 'tinyblob', 'mediumblob', 'longblob']),
$this->isColumn($tableColumn->type, ['char', 'varchar']),
$insertMode,
);
$asIs = false;
$fieldHashMd5 = $column->md5;
if ($repopulate !== [] && array_key_exists($fieldHashMd5, $currentRow)) {
$currentRow[$column->field] = $repopulate[$fieldHashMd5];
$asIs = true;
}
$extractedColumnspec = Util::extractColumnSpec($column->type);
//Call validation when the form submitted...
$onChangeClause = 'return verificationsAfterFieldChange('
. json_encode($fieldHashMd5) . ', '
. json_encode((string) $rowId) . ',' . json_encode($column->type) . ')';
$vkey = '[multi_edit][' . $rowId . ']';
// Use an MD5 as an array index to avoid having special characters
// in the name attribute (see bug #1746964 )
$columnNameAppendix = $vkey . '[' . $fieldHashMd5 . ']';
// Prepares the field value
if ($currentRow !== []) {
// (we are editing)
[
$realNullValue,
$specialCharsEncoded,
$specialChars,
$data,
$backupField,
] = $this->getSpecialCharsAndBackupFieldForExistingRow(
$currentRow,
$column,
$extractedColumnspec['spec_in_brackets'],
$columnNameAppendix,
$asIs,
);
} else {
// (we are inserting)
// display default values
$defaultValue = $repopulate[$fieldHashMd5] ?? $column->default ?? null;
$realNullValue = $defaultValue === null;
$data = (string) $defaultValue;
$specialChars = htmlspecialchars($this->getDefaultValue($defaultValue, $column->trueType));
$specialCharsEncoded = Util::duplicateFirstNewline($specialChars);
$backupField = '';
}
$this->fieldIndex = ($this->rowOffset * $columnsCnt) + $columnNumber + 1;
// The function column
// -------------------
$foreignData = $this->relation->getForeignData($foreigners, $column->field, false, '', '');
$isColumnBinary = $this->isColumnBinary($column, $isUpload);
$functionOptions = '';
if ($this->config->settings['ShowFunctionFields']) {
$defaultFunction = Generator::getDefaultFunctionForField(
$column->trueType,
$column->firstTimestamp,
$column->default,
$column->extra,
$column->isNull,
$column->key,
$column->type,
$insertMode,
);
$functionOptions = Generator::getFunctionsForField($defaultFunction, $foreignData->foreignField);
}
// nullify code is needed by the js nullify() function to be able to generate calls to nullify() in jQuery
$nullifyCode = $this->getNullifyCodeForNullColumn($column, $foreigners, $foreignData->foreignLink);
// The value column (depends on type)
// ----------------
// See bug #1667887 for the reason why we don't use the maxlength
// HTML attribute
// Check input transformation of column
$transformedHtml = '';
if (! empty($columnMime['input_transformation'])) {
$transformationPlugin = $this->transformations->getPluginInstance($columnMime['input_transformation']);
if ($transformationPlugin instanceof IOTransformationsPlugin) {
$transformationOptions = $this->transformations->getOptions(
$columnMime['input_transformation_options'],
);
$urlParams = [
'db' => $db,
'table' => $table,
'transform_key' => $column->field,
'where_clause_sign' => Core::signSqlQuery($whereClause),
'where_clause' => $whereClause,
];
$transformationOptions['wrapper_link'] = Url::getCommon($urlParams);
$transformationOptions['wrapper_params'] = $urlParams;
$transformedHtml = $transformationPlugin->getInputHtml(
$columnNameAppendix,
$transformationOptions,
$currentRow[$column->field] ?? '',
$this->fieldIndex,
);
self::$pluginScripts = array_merge(self::$pluginScripts, $transformationPlugin->getScripts());
}
}
$columnValue = '';
$foreignDropdown = '';
$dataType = TypeClass::Unknown;
$textAreaRows = $this->config->settings['TextareaRows'];
$textareaCols = $this->config->settings['TextareaCols'];
$maxlength = '';
$enumSelectedValue = '';
$enumValues = [];
$columnSetValues = [];
$setSelectSize = 0;
$isColumnProtectedBlob = false;
$blobValue = '';
$blobValueUnit = '';
$maxUploadSize = 0;
$selectOptionForUpload = '';
$hexInputSize = 0;
if ($transformedHtml === '') {
if ($foreignData->dispRow !== null) {
$foreignDropdown = $this->relation->foreignDropdown(
$foreignData->dispRow,
$foreignData->foreignField,
$foreignData->foreignDisplay,
$data,
$this->config->settings['ForeignKeyMaxLimit'],
);
}
$dataType = $this->dbi->types->getTypeClass($column->trueType);
if ($column->isChar) {
$textAreaRows = max($this->config->settings['CharTextareaRows'], 7);
$textareaCols = $this->config->settings['CharTextareaCols'];
$maxlength = $extractedColumnspec['spec_in_brackets'];
} elseif ($this->config->settings['LongtextDoubleTextarea'] && $column->trueType === 'longtext') {
$textAreaRows = $this->config->settings['TextareaRows'] * 2;
$textareaCols = $this->config->settings['TextareaCols'] * 2;
}
if ($column->trueType === 'enum') {
$enumValues = $extractedColumnspec['enum_set_values'];
foreach ($enumValues as $enumValue) {
if (
$data == $enumValue || ($data == ''
&& (! isset($_POST['where_clause']) || ! $column->isNull)
&& isset($column->default) && $enumValue == $column->default)
) {
$enumSelectedValue = $enumValue;
break;
}
}
} elseif ($column->trueType === 'set') {
$columnSetValues = $extractedColumnspec['enum_set_values'];
$setSelectSize = min(4, count($extractedColumnspec['enum_set_values']));
} elseif ($column->isBinary || $column->isBlob) {
$isColumnProtectedBlob = ($this->config->settings['ProtectBinary'] === 'blob' && $column->isBlob)
|| ($this->config->settings['ProtectBinary'] === 'all')
|| ($this->config->settings['ProtectBinary'] === 'noblob' && ! $column->isBlob);
if ($isColumnProtectedBlob) {
[$blobValue, $blobValueUnit] = Util::formatByteDown(mb_strlen(stripslashes($data)), 3, 1);
}
if ($isUpload && $column->isBlob) {
$maxUploadSize = $this->getMaxUploadSize($column->trueType);
}
if (! empty($this->config->settings['UploadDir'])) {
$selectOptionForUpload = $this->getSelectOptionForUpload($vkey, $fieldHashMd5);
}
if (
! $isColumnProtectedBlob
&& ! ($column->isBlob || ($column->length > $this->config->settings['LimitChars']))
) {
$hexInputSize = min(max($column->length * 2, 4), $this->config->settings['LimitChars']);
}
} else {
$columnValue = $this->getValueColumnForOtherDatatypes(
$column,
$defaultCharEditing,
$backupField,
$columnNameAppendix,
$onChangeClause,
$specialChars,
$specialCharsEncoded,
$data,
$extractedColumnspec['spec_in_brackets'],
);
}
}
return $this->template->render('table/insert/column_row', [
'db' => $db,
'table' => $table,
'column' => $column,
'row_id' => $rowId,
'show_field_types_in_data_edit_view' => $this->config->settings['ShowFieldTypesInDataEditView'],
'show_function_fields' => $this->config->settings['ShowFunctionFields'],
'is_column_binary' => $isColumnBinary,
'function_options' => $functionOptions,
'nullify_code' => $nullifyCode,
'real_null_value' => $realNullValue,
'id_index' => $this->fieldIndex,
'type' => $column->trueType,
'displayType' => $column->getDisplayType(),
'decimals' => $column->getFractionalSecondsPrecision(),
'special_chars' => $specialChars,
'transformed_value' => $transformedHtml,
'value' => $columnValue,
'is_value_foreign_link' => $foreignData->foreignLink,
'backup_field' => $backupField,
'data' => $data,
'gis_data_types' => Gis::getDataTypes(),
'foreign_dropdown' => $foreignDropdown,
'data_type' => $dataType->value,
'textarea_cols' => $textareaCols,
'textarea_rows' => $textAreaRows,
'max_length' => $maxlength,
'longtext_double_textarea' => $this->config->settings['LongtextDoubleTextarea'],
'enum_selected_value' => $enumSelectedValue,
'enum_values' => $enumValues,
'set_values' => $columnSetValues,
'set_select_size' => $setSelectSize,
'is_column_protected_blob' => $isColumnProtectedBlob,
'blob_value' => $blobValue,
'blob_value_unit' => $blobValueUnit,
'is_upload' => $isUpload,
'max_upload_size' => $maxUploadSize,
'select_option_for_upload' => $selectOptionForUpload,
'limit_chars' => $this->config->settings['LimitChars'],
'hex_input_size' => $hexInputSize,
'field_title' => $this->getColumnTitle($column->field, $commentsMap),
]);
}
private function isColumnBinary(InsertEditColumn $column, bool $isUpload): bool
{
if (! $this->config->settings['ShowFunctionFields']) {
return false;
}
return ($this->config->settings['ProtectBinary'] === 'blob' && $column->isBlob && ! $isUpload)
|| ($this->config->settings['ProtectBinary'] === 'all' && $column->isBinary)
|| ($this->config->settings['ProtectBinary'] === 'noblob' && $column->isBinary);
}
/**
* Function to get html for each insert/edit row
*
* @param array<string, bool|int|string> $urlParams url parameters
* @param list<Column> $tableColumns table columns
* @param string[] $commentsMap comments map
* @param FieldMetadata[] $fieldMetadata current result's field metadata
* @param bool $insertMode whether insert mode
* @param array<string|null> $currentRow current row
* @param bool $isUpload whether upload
* @param mixed[] $foreigners foreigners
* @param string $table table
* @param string $db database
* @param int $rowId row id
* @param mixed[] $repopulate the data to be repopulated
* @param string[] $whereClauseArray the array of where clauses
*/
public function getHtmlForInsertEditRow(
array $urlParams,
array $tableColumns,
array $commentsMap,
array $fieldMetadata,
bool $insertMode,
array $currentRow,
bool $isUpload,
array $foreigners,
string $table,
string $db,
int $rowId,
array $repopulate,
array $whereClauseArray,
): string {
$htmlOutput = $this->getHeadAndFootOfInsertRowTable($urlParams)
. '<tbody>';
//store the default value for CharEditing
$defaultCharEditing = $this->config->settings['CharEditing'];
$mimeMap = $this->transformations->getMime($db, $table);
$whereClause = $whereClauseArray[$rowId] ?? '';
$columnCount = count($tableColumns);
for ($columnNumber = 0; $columnNumber < $columnCount; $columnNumber++) {
$tableColumn = $tableColumns[$columnNumber];
$columnMime = $mimeMap[$tableColumn->field] ?? [];
$virtual = ['VIRTUAL', 'PERSISTENT', 'VIRTUAL GENERATED', 'STORED GENERATED'];
if (in_array($tableColumn->extra, $virtual, true)) {
continue;
}
$htmlOutput .= $this->getHtmlForInsertEditFormColumn(
$tableColumn,
$columnNumber,
$commentsMap,
$fieldMetadata[$columnNumber]->length,
$insertMode,
$currentRow,
$columnCount,
$isUpload,
$foreigners,
$table,
$db,
$rowId,
$defaultCharEditing,
$repopulate,
$columnMime,
$whereClause,
);
}
$this->rowOffset++;
return $htmlOutput . ' </tbody>'
. '</table></div><br>'
. '<div class="clearfloat"></div>';
}
/** @return array<string|null> */
public function getColumnDefaultValues(string $database, string $table): array
{
$sql = 'SELECT COLUMN_NAME, CASE WHEN INSTR(EXTRA, \'DEFAULT_GENERATED\')'
. ' THEN COLUMN_DEFAULT '
. ' ELSE CONCAT(\'\'\'\', COLUMN_DEFAULT, \'\'\'\')'
. ' END AS COLUMN_DEFAULT'
. ' FROM INFORMATION_SCHEMA.COLUMNS WHERE TABLE_NAME = '
. $this->dbi->quoteString($table)
. ' AND TABLE_SCHEMA = ' . $this->dbi->quoteString($database);
return $this->dbi->query($sql)->fetchAllKeyPair();
}
/**
* Returns list of function names that accept WKB as text
*
* @return string[]
*/
private function getGisFromTextFunctions(): array
{
return $this->dbi->getVersion() >= 50600 ?
[
'ST_GeomFromText',
'ST_GeomCollFromText',
'ST_LineFromText',
'ST_MLineFromText',
'ST_PointFromText',
'ST_MPointFromText',
'ST_PolyFromText',
'ST_MPolyFromText',
] :
[
'GeomFromText',
'GeomCollFromText',
'LineFromText',
'MLineFromText',
'PointFromText',
'MPointFromText',
'PolyFromText',
'MPolyFromText',
];
}
/**
* Returns list of function names that accept WKB as binary
*
* @return string[]
*/
private function getGisFromWKBFunctions(): array
{
return $this->dbi->getVersion() >= 50600 ?
[
'ST_GeomFromWKB',
'ST_GeomCollFromWKB',
'ST_LineFromWKB',
'ST_MLineFromWKB',
'ST_PointFromWKB',
'ST_MPointFromWKB',
'ST_PolyFromWKB',
'ST_MPolyFromWKB',
] :
[
'GeomFromWKB',
'GeomCollFromWKB',
'LineFromWKB',
'MLineFromWKB',
'PointFromWKB',
'MPointFromWKB',
'PolyFromWKB',
'MPolyFromWKB',
];
}
}