2 /* vim: set expandtab sw=4 ts=4 sts=4: */
4 * set of functions with the insert/edit features in pma
8 declare(strict_types
=1);
12 use PhpMyAdmin\Plugins\TransformationsPlugin
;
15 * PhpMyAdmin\InsertEdit class
22 * DatabaseInterface instance
24 * @var DatabaseInterface
34 * @var Transformations
36 private $transformations;
51 * @param DatabaseInterface $dbi DatabaseInterface instance
53 public function __construct(DatabaseInterface
$dbi)
56 $this->relation
= new Relation($GLOBALS['dbi']);
57 $this->transformations
= new Transformations();
58 $this->fileListing
= new FileListing();
59 $this->template
= new Template();
63 * Retrieve form parameters for insert/edit form
65 * @param string $db name of the database
66 * @param string $table name of the table
67 * @param array|null $where_clauses where clauses
68 * @param array $where_clause_array array of where clauses
69 * @param string $err_url error url
71 * @return array array of insert/edit form parameters
73 public function getFormParametersForInsertForm(
76 ?
array $where_clauses,
77 array $where_clause_array,
83 'goto' => $GLOBALS['goto'],
84 'err_url' => $err_url,
85 'sql_query' => $_POST['sql_query'],
87 if (isset($where_clauses)) {
88 foreach ($where_clause_array as $key_id => $where_clause) {
89 $_form_params['where_clause[' . $key_id . ']'] = trim($where_clause);
92 if (isset($_POST['clause_is_unique'])) {
93 $_form_params['clause_is_unique'] = $_POST['clause_is_unique'];
99 * Creates array of where clauses
101 * @param array|string|null $where_clause where clause
103 * @return array whereClauseArray array of where clauses
105 private function getWhereClauseArray($where_clause)
107 if (! isset($where_clause)) {
111 if (is_array($where_clause)) {
112 return $where_clause;
115 return [0 => $where_clause];
119 * Analysing where clauses array
121 * @param array $where_clause_array array of where clauses
122 * @param string $table name of the table
123 * @param string $db name of the database
125 * @return array $where_clauses, $result, $rows, $found_unique_key
127 private function analyzeWhereClauses(
128 array $where_clause_array,
135 $found_unique_key = false;
136 foreach ($where_clause_array as $key_id => $where_clause) {
137 $local_query = 'SELECT * FROM '
138 . Util
::backquote($db) . '.'
139 . Util
::backquote($table)
140 . ' WHERE ' . $where_clause . ';';
141 $result[$key_id] = $this->dbi
->query(
143 DatabaseInterface
::CONNECT_USER
,
144 DatabaseInterface
::QUERY_STORE
146 $rows[$key_id] = $this->dbi
->fetchAssoc($result[$key_id]);
148 $where_clauses[$key_id] = str_replace('\\', '\\\\', $where_clause);
149 $has_unique_condition = $this->showEmptyResultMessageOrSetUniqueCondition(
156 if ($has_unique_condition) {
157 $found_unique_key = true;
169 * Show message for empty result or set the unique_condition
171 * @param array $rows MySQL returned rows
172 * @param string $key_id ID in current key
173 * @param array $where_clause_array array of where clauses
174 * @param string $local_query query performed
175 * @param array $result MySQL result handle
179 private function showEmptyResultMessageOrSetUniqueCondition(
182 array $where_clause_array,
186 $has_unique_condition = false;
189 if (! $rows[$key_id]) {
190 unset($rows[$key_id], $where_clause_array[$key_id]);
191 Response
::getInstance()->addHTML(
193 __('MySQL returned an empty result set (i.e. zero rows).'),
198 * @todo not sure what should be done at this point, but we must not
199 * exit if we want the message to be displayed
201 } else {// end if (no row returned)
202 $meta = $this->dbi
->getFieldsMeta($result[$key_id]);
204 list($unique_condition, $tmp_clause_is_unique)
205 = Util
::getUniqueCondition(
206 $result[$key_id], // handle
207 count($meta), // fields_cnt
208 $meta, // fields_meta
209 $rows[$key_id], // row
210 true, // force_unique
211 false, // restrict_to_table
212 null // analyzed_sql_results
215 if (! empty($unique_condition)) {
216 $has_unique_condition = true;
218 unset($unique_condition, $tmp_clause_is_unique);
220 return $has_unique_condition;
224 * No primary key given, just load first row
226 * @param string $table name of the table
227 * @param string $db name of the database
229 * @return array containing $result and $rows arrays
231 private function loadFirstRow($table, $db)
233 $result = $this->dbi
->query(
234 'SELECT * FROM ' . Util
::backquote($db)
235 . '.' . Util
::backquote($table) . ' LIMIT 1;',
236 DatabaseInterface
::CONNECT_USER
,
237 DatabaseInterface
::QUERY_STORE
239 $rows = array_fill(0, $GLOBALS['cfg']['InsertRows'], false);
247 * Add some url parameters
249 * @param array $url_params containing $db and $table as url parameters
250 * @param array $where_clause_array where clauses array
251 * @param string|null $where_clause where clause
253 * @return array Add some url parameters to $url_params array and return it
255 public function urlParamsInEditMode(
257 array $where_clause_array,
258 ?
string $where_clause
260 if (isset($where_clause)) {
261 foreach ($where_clause_array as $where_clause) {
262 $url_params['where_clause'] = trim($where_clause);
265 if (! empty($_POST['sql_query'])) {
266 $url_params['sql_query'] = $_POST['sql_query'];
272 * Show type information or function selectors in Insert/Edit
274 * @param string $which function|type
275 * @param array $url_params containing url parameters
276 * @param boolean $is_show whether to show the element in $which
278 * @return string an HTML snippet
280 public function showTypeOrFunction($which, array $url_params, $is_show)
286 $params['ShowFunctionFields'] = ($is_show ?
0 : 1);
287 $params['ShowFieldTypesInDataEditView']
288 = $GLOBALS['cfg']['ShowFieldTypesInDataEditView'];
291 $params['ShowFieldTypesInDataEditView'] = ($is_show ?
0 : 1);
292 $params['ShowFunctionFields']
293 = $GLOBALS['cfg']['ShowFunctionFields'];
297 $params['goto'] = 'sql.php';
298 $this_url_params = array_merge($url_params, $params);
301 return ' : <a href="' . Url
::getFromRoute('/table/change') . '" data-post="'
302 . Url
::getCommon($this_url_params, '') . '">'
303 . $this->showTypeOrFunctionLabel($which)
306 return '<th><a href="' . Url
::getFromRoute('/table/change') . '" data-post="'
307 . Url
::getCommon($this_url_params, '')
308 . '" title="' . __('Hide') . '">'
309 . $this->showTypeOrFunctionLabel($which)
314 * Show type information or function selectors labels in Insert/Edit
316 * @param string $which function|type
318 * @return string|null an HTML snippet
320 private function showTypeOrFunctionLabel($which)
324 return __('Function');
333 * Analyze the table column array
335 * @param array $column description of column in given table
336 * @param array $comments_map comments for every column that has a comment
337 * @param boolean $timestamp_seen whether a timestamp has been seen
339 * @return array description of column in given table
341 private function analyzeTableColumnsArray(
346 $column['Field_html'] = htmlspecialchars($column['Field']);
347 $column['Field_md5'] = md5($column['Field']);
348 // True_Type contains only the type (stops at first bracket)
349 $column['True_Type'] = preg_replace('@\(.*@s', '', $column['Type']);
350 $column['len'] = preg_match('@float|double@', $column['Type']) ?
100 : -1;
351 $column['Field_title'] = $this->getColumnTitle($column, $comments_map);
352 $column['is_binary'] = $this->isColumn(
359 $column['is_blob'] = $this->isColumn(
368 $column['is_char'] = $this->isColumn(
376 list($column['pma_type'], $column['wrap'], $column['first_timestamp'])
377 = $this->getEnumSetAndTimestampColumns($column, $timestamp_seen);
383 * Retrieve the column title
385 * @param array $column description of column in given table
386 * @param array $comments_map comments for every column that has a comment
388 * @return string column title
390 private function getColumnTitle(array $column, array $comments_map)
392 if (isset($comments_map[$column['Field']])) {
393 return '<span style="border-bottom: 1px dashed black;" title="'
394 . htmlspecialchars($comments_map[$column['Field']]) . '">'
395 . $column['Field_html'] . '</span>';
398 return $column['Field_html'];
402 * check whether the column is of a certain type
403 * the goal is to ensure that types such as "enum('one','two','binary',..)"
404 * or "enum('one','two','varbinary',..)" are not categorized as binary
406 * @param array $column description of column in given table
407 * @param array $types the types to verify
409 * @return boolean whether the column's type if one of the $types
411 public function isColumn(array $column, array $types)
413 foreach ($types as $one_type) {
414 if (mb_stripos($column['Type'], $one_type) === 0) {
422 * Retrieve set, enum, timestamp table columns
424 * @param array $column description of column in given table
425 * @param boolean $timestamp_seen whether a timestamp has been seen
427 * @return array $column['pma_type'], $column['wrap'], $column['first_timestamp']
429 private function getEnumSetAndTimestampColumns(array $column, $timestamp_seen)
431 $column['first_timestamp'] = false;
432 switch ($column['True_Type']) {
434 $column['pma_type'] = 'set';
435 $column['wrap'] = '';
438 $column['pma_type'] = 'enum';
439 $column['wrap'] = '';
442 if (! $timestamp_seen) { // can only occur once per table
443 $column['first_timestamp'] = true;
445 $column['pma_type'] = $column['Type'];
446 $column['wrap'] = ' nowrap';
450 $column['pma_type'] = $column['Type'];
451 $column['wrap'] = ' nowrap';
457 $column['first_timestamp'],
462 * The function column
463 * We don't want binary data to be destroyed
464 * Note: from the MySQL manual: "BINARY doesn't affect how the column is
465 * stored or retrieved" so it does not mean that the contents is binary
467 * @param array $column description of column in given table
468 * @param boolean $is_upload upload or no
469 * @param string $column_name_appendix the name attribute
470 * @param string $onChangeClause onchange clause for fields
471 * @param array $no_support_types list of datatypes that are not (yet)
473 * @param integer $tabindex_for_function +3000
474 * @param integer $tabindex tab index
475 * @param integer $idindex id index
476 * @param boolean $insert_mode insert mode or edit mode
477 * @param boolean $readOnly is column read only or not
478 * @param array $foreignData foreign key data
480 * @return string an html snippet
482 private function getFunctionColumn(
485 $column_name_appendix,
487 array $no_support_types,
488 $tabindex_for_function,
496 if (($GLOBALS['cfg']['ProtectBinary'] === 'blob'
497 && $column['is_blob'] && ! $is_upload)
498 ||
($GLOBALS['cfg']['ProtectBinary'] === 'all'
499 && $column['is_binary'])
500 ||
($GLOBALS['cfg']['ProtectBinary'] === 'noblob'
501 && $column['is_binary'])
503 $html_output .= '<td class="center">' . __('Binary') . '</td>' . "\n";
505 ||
mb_strstr($column['True_Type'], 'enum')
506 ||
mb_strstr($column['True_Type'], 'set')
507 ||
in_array($column['pma_type'], $no_support_types)
509 $html_output .= '<td class="center">--</td>' . "\n";
511 $html_output .= '<td>' . "\n";
513 $html_output .= '<select name="funcs' . $column_name_appendix . '"'
514 . ' ' . $onChangeClause
515 . ' tabindex="' . ($tabindex +
$tabindex_for_function) . '"'
516 . ' id="field_' . $idindex . '_1">';
517 $html_output .= Util
::getFunctionsForField(
523 $html_output .= '</select>' . "\n";
524 $html_output .= '</td>' . "\n";
532 * @param array $column description of column in given table
533 * @param string $column_name_appendix the name attribute
534 * @param boolean $real_null_value is column value null or not null
535 * @param integer $tabindex tab index
536 * @param integer $tabindex_for_null +6000
537 * @param integer $idindex id index
538 * @param string $vkey [multi_edit]['row_id']
539 * @param array $foreigners keys into foreign fields
540 * @param array $foreignData data about the foreign keys
541 * @param boolean $readOnly is column read only or not
543 * @return string an html snippet
545 private function getNullColumn(
547 $column_name_appendix,
557 if ($column['Null'] != 'YES' ||
$readOnly) {
558 return "<td></td>\n";
561 $html_output .= '<td>' . "\n";
562 $html_output .= '<input type="hidden" name="fields_null_prev'
563 . $column_name_appendix . '"';
564 if ($real_null_value && ! $column['first_timestamp']) {
565 $html_output .= ' value="on"';
567 $html_output .= '>' . "\n";
569 $html_output .= '<input type="checkbox" class="checkbox_null" tabindex="'
570 . ($tabindex +
$tabindex_for_null) . '"'
571 . ' name="fields_null' . $column_name_appendix . '"';
572 if ($real_null_value) {
573 $html_output .= ' checked="checked"';
575 $html_output .= ' id="field_' . $idindex . '_2">';
577 // nullify_code is needed by the js nullify() function
578 $nullify_code = $this->getNullifyCodeForNullColumn(
583 // to be able to generate calls to nullify() in jQuery
584 $html_output .= '<input type="hidden" class="nullify_code" name="nullify_code'
585 . $column_name_appendix . '" value="' . $nullify_code . '">';
586 $html_output .= '<input type="hidden" class="hashed_field" name="hashed_field'
587 . $column_name_appendix . '" value="' . $column['Field_md5'] . '">';
588 $html_output .= '<input type="hidden" class="multi_edit" name="multi_edit'
589 . $column_name_appendix . '" value="' . Sanitize
::escapeJsString($vkey) . '">';
590 $html_output .= '</td>' . "\n";
596 * Retrieve the nullify code for the null column
598 * @param array $column description of column in given table
599 * @param array $foreigners keys into foreign fields
600 * @param array $foreignData data about the foreign keys
604 private function getNullifyCodeForNullColumn(
609 $foreigner = $this->relation
->searchColumnInForeigners($foreigners, $column['Field']);
610 if (mb_strstr($column['True_Type'], 'enum')) {
611 if (mb_strlen((string) $column['Type']) > 20) {
616 } elseif (mb_strstr($column['True_Type'], 'set')) {
618 } elseif (! empty($foreigners)
619 && ! empty($foreigner)
620 && $foreignData['foreign_link'] == false
622 // foreign key in a drop-down
624 } elseif (! empty($foreigners)
625 && ! empty($foreigner)
626 && $foreignData['foreign_link'] == true
628 // foreign key with a browsing icon
633 return $nullify_code;
637 * Get the HTML elements for value column in insert form
638 * (here, "column" is used in the sense of HTML column in HTML table)
640 * @param array $column description of column in given table
641 * @param string $backup_field hidden input field
642 * @param string $column_name_appendix the name attribute
643 * @param string $onChangeClause onchange clause for fields
644 * @param integer $tabindex tab index
645 * @param integer $tabindex_for_value offset for the values tabindex
646 * @param integer $idindex id index
647 * @param string $data description of the column field
648 * @param string $special_chars special characters
649 * @param array $foreignData data about the foreign keys
650 * @param array $paramTableDbArray array containing $table and $db
651 * @param integer $rownumber the row number
652 * @param array $titles An HTML IMG tag for a particular icon from
653 * a theme, which may be an actual file or
654 * an icon from a sprite
655 * @param string $text_dir text direction
656 * @param string $special_chars_encoded replaced char if the string starts
657 * with a \r\n pair (0x0d0a) add an extra \n
658 * @param string $vkey [multi_edit]['row_id']
659 * @param boolean $is_upload is upload or not
660 * @param integer $biggest_max_file_size 0 integer
661 * @param string $default_char_editing default char editing mode which is stored
662 * in the config.inc.php script
663 * @param array $no_support_types list of datatypes that are not (yet)
665 * @param array $gis_data_types list of GIS data types
666 * @param array $extracted_columnspec associative array containing type,
667 * spec_in_brackets and possibly
668 * enum_set_values (another array)
669 * @param boolean $readOnly is column read only or not
671 * @return string an html snippet
673 private function getValueColumn(
676 $column_name_appendix,
684 array $paramTableDbArray,
688 $special_chars_encoded,
691 $biggest_max_file_size,
692 $default_char_editing,
693 array $no_support_types,
694 array $gis_data_types,
695 array $extracted_columnspec,
698 // HTML5 data-* attribute data-type
699 $data_type = $this->dbi
->types
->getTypeClass($column['True_Type']);
702 if ($foreignData['foreign_link'] == true) {
703 $html_output .= $this->getForeignLink(
706 $column_name_appendix,
717 } elseif (is_array($foreignData['disp_row'])) {
718 $html_output .= $this->dispRowForeignData(
721 $column_name_appendix,
730 } elseif ($GLOBALS['cfg']['LongtextDoubleTextarea']
731 && mb_strstr($column['pma_type'], 'longtext')
733 $html_output .= $this->getTextarea(
736 $column_name_appendix,
742 $special_chars_encoded,
746 } elseif (mb_strstr($column['pma_type'], 'text')) {
747 $html_output .= $this->getTextarea(
750 $column_name_appendix,
756 $special_chars_encoded,
760 $html_output .= "\n";
761 if (mb_strlen($special_chars) > 32000) {
762 $html_output .= "</td>\n";
763 $html_output .= '<td>' . __(
764 'Because of its length,<br> this column might not be editable.'
767 } elseif ($column['pma_type'] == 'enum') {
768 $html_output .= $this->getPmaTypeEnum(
771 $column_name_appendix,
772 $extracted_columnspec,
780 } elseif ($column['pma_type'] == 'set') {
781 $html_output .= $this->getPmaTypeSet(
783 $extracted_columnspec,
785 $column_name_appendix,
793 } elseif ($column['is_binary'] ||
$column['is_blob']) {
794 $html_output .= $this->getBinaryAndBlobColumn(
798 $biggest_max_file_size,
800 $column_name_appendix,
806 $special_chars_encoded,
811 } elseif (! in_array($column['pma_type'], $no_support_types)) {
812 $html_output .= $this->getValueColumnForOtherDatatypes(
814 $default_char_editing,
816 $column_name_appendix,
823 $special_chars_encoded,
825 $extracted_columnspec,
830 if (in_array($column['pma_type'], $gis_data_types)) {
831 $html_output .= $this->getHtmlForGisDataTypes();
838 * Get HTML for foreign link in insert form
840 * @param array $column description of column in given table
841 * @param string $backup_field hidden input field
842 * @param string $column_name_appendix the name attribute
843 * @param string $onChangeClause onchange clause for fields
844 * @param integer $tabindex tab index
845 * @param integer $tabindex_for_value offset for the values tabindex
846 * @param integer $idindex id index
847 * @param string $data data to edit
848 * @param array $paramTableDbArray array containing $table and $db
849 * @param integer $rownumber the row number
850 * @param array $titles An HTML IMG tag for a particular icon from
851 * a theme, which may be an actual file or
852 * an icon from a sprite
853 * @param boolean $readOnly is column read only or not
855 * @return string an html snippet
857 private function getForeignLink(
860 $column_name_appendix,
866 array $paramTableDbArray,
871 list($table, $db) = $paramTableDbArray;
873 $html_output .= $backup_field . "\n";
875 $html_output .= '<input type="hidden" name="fields_type'
876 . $column_name_appendix . '" value="foreign">';
878 $html_output .= '<input type="text" name="fields' . $column_name_appendix . '" '
879 . 'class="textfield" '
880 . $onChangeClause . ' '
881 . ($readOnly ?
'readonly="readonly" ' : '')
882 . 'tabindex="' . ($tabindex +
$tabindex_for_value) . '" '
883 . 'id="field_' . $idindex . '_3" '
884 . 'value="' . htmlspecialchars($data) . '">';
886 $html_output .= '<a class="ajax browse_foreign" href="browse_foreigners.php" data-post="'
891 'field' => $column['Field'],
892 'rownumber' => $rownumber,
897 . str_replace("'", "\'", $titles['Browse']) . '</a>';
902 * Get HTML to display foreign data
904 * @param array $column description of column in given table
905 * @param string $backup_field hidden input field
906 * @param string $column_name_appendix the name attribute
907 * @param string $onChangeClause onchange clause for fields
908 * @param integer $tabindex tab index
909 * @param integer $tabindex_for_value offset for the values tabindex
910 * @param integer $idindex id index
911 * @param string $data data to edit
912 * @param array $foreignData data about the foreign keys
913 * @param boolean $readOnly is display read only or not
915 * @return string an html snippet
917 private function dispRowForeignData(
920 $column_name_appendix,
930 $html_output .= $backup_field . "\n";
931 $html_output .= '<input type="hidden"'
932 . ' name="fields_type' . $column_name_appendix . '"';
933 if ($column['is_binary']) {
934 $html_output .= ' value="hex">';
936 $html_output .= ' value="foreign">';
939 $html_output .= '<select name="fields' . $column_name_appendix . '"'
940 . ' ' . $onChangeClause
941 . ' class="textfield"'
942 . ($readOnly ?
' disabled' : '')
943 . ' tabindex="' . ($tabindex +
$tabindex_for_value) . '"'
944 . ' id="field_' . $idindex . '_3">';
945 $html_output .= $this->relation
->foreignDropdown(
946 $foreignData['disp_row'],
947 $foreignData['foreign_field'],
948 $foreignData['foreign_display'],
950 $GLOBALS['cfg']['ForeignKeyMaxLimit']
952 $html_output .= '</select>';
954 //Add hidden input, as disabled <select> input does not included in POST.
956 $html_output .= '<input name="fields' . $column_name_appendix . '"'
957 . ' type="hidden" value="' . htmlspecialchars($data) . '">';
964 * Get HTML textarea for insert form
966 * @param array $column column information
967 * @param string $backup_field hidden input field
968 * @param string $column_name_appendix the name attribute
969 * @param string $onChangeClause onchange clause for fields
970 * @param integer $tabindex tab index
971 * @param integer $tabindex_for_value offset for the values tabindex
972 * @param integer $idindex id index
973 * @param string $text_dir text direction
974 * @param string $special_chars_encoded replaced char if the string starts
975 * with a \r\n pair (0x0d0a) add an extra \n
976 * @param string $data_type the html5 data-* attribute type
977 * @param boolean $readOnly is column read only or not
979 * @return string an html snippet
981 private function getTextarea(
984 $column_name_appendix,
990 $special_chars_encoded,
995 $textAreaRows = $GLOBALS['cfg']['TextareaRows'];
996 $textareaCols = $GLOBALS['cfg']['TextareaCols'];
998 if ($column['is_char']) {
1000 * @todo clarify the meaning of the "textfield" class and explain
1001 * why character columns have the "char" class instead
1003 $the_class = 'char charField';
1004 $textAreaRows = max($GLOBALS['cfg']['CharTextareaRows'], 7);
1005 $textareaCols = $GLOBALS['cfg']['CharTextareaCols'];
1006 $extracted_columnspec = Util
::extractColumnSpec(
1009 $maxlength = $extracted_columnspec['spec_in_brackets'];
1010 } elseif ($GLOBALS['cfg']['LongtextDoubleTextarea']
1011 && mb_strstr($column['pma_type'], 'longtext')
1013 $textAreaRows = $GLOBALS['cfg']['TextareaRows'] * 2;
1014 $textareaCols = $GLOBALS['cfg']['TextareaCols'] * 2;
1016 $html_output = $backup_field . "\n"
1017 . '<textarea name="fields' . $column_name_appendix . '"'
1018 . ' class="' . $the_class . '"'
1019 . ($readOnly ?
' readonly="readonly"' : '')
1020 . (isset($maxlength) ?
' data-maxlength="' . $maxlength . '"' : '')
1021 . ' rows="' . $textAreaRows . '"'
1022 . ' cols="' . $textareaCols . '"'
1023 . ' dir="' . $text_dir . '"'
1024 . ' id="field_' . $idindex . '_3"'
1025 . (! empty($onChangeClause) ?
' ' . $onChangeClause : '')
1026 . ' tabindex="' . ($tabindex +
$tabindex_for_value) . '"'
1027 . ' data-type="' . $data_type . '">'
1028 . $special_chars_encoded
1031 return $html_output;
1035 * Get HTML for enum type
1037 * @param array $column description of column in given table
1038 * @param string $backup_field hidden input field
1039 * @param string $column_name_appendix the name attribute
1040 * @param array $extracted_columnspec associative array containing type,
1041 * spec_in_brackets and possibly
1042 * enum_set_values (another array)
1043 * @param string $onChangeClause onchange clause for fields
1044 * @param integer $tabindex tab index
1045 * @param integer $tabindex_for_value offset for the values tabindex
1046 * @param integer $idindex id index
1047 * @param mixed $data data to edit
1048 * @param boolean $readOnly is column read only or not
1050 * @return string an html snippet
1052 private function getPmaTypeEnum(
1055 $column_name_appendix,
1056 array $extracted_columnspec,
1059 $tabindex_for_value,
1065 if (! isset($column['values'])) {
1066 $column['values'] = $this->getColumnEnumValues(
1068 $extracted_columnspec
1071 $column_enum_values = $column['values'];
1072 $html_output .= '<input type="hidden" name="fields_type'
1073 . $column_name_appendix . '" value="enum">';
1074 $html_output .= "\n" . ' ' . $backup_field . "\n";
1075 if (mb_strlen($column['Type']) > 20) {
1076 $html_output .= $this->getDropDownDependingOnLength(
1078 $column_name_appendix,
1081 $tabindex_for_value,
1084 $column_enum_values,
1088 $html_output .= $this->getRadioButtonDependingOnLength(
1089 $column_name_appendix,
1093 $tabindex_for_value,
1096 $column_enum_values,
1100 return $html_output;
1106 * @param array $column description of column in given table
1107 * @param array $extracted_columnspec associative array containing type,
1108 * spec_in_brackets and possibly enum_set_values
1111 * @return array column values as an associative array
1113 private function getColumnEnumValues(array $column, array $extracted_columnspec)
1115 $column['values'] = [];
1116 foreach ($extracted_columnspec['enum_set_values'] as $val) {
1117 $column['values'][] = [
1119 'html' => htmlspecialchars($val),
1122 return $column['values'];
1126 * Get HTML drop down for more than 20 string length
1128 * @param array $column description of column in given table
1129 * @param string $column_name_appendix the name attribute
1130 * @param string $onChangeClause onchange clause for fields
1131 * @param integer $tabindex tab index
1132 * @param integer $tabindex_for_value offset for the values tabindex
1133 * @param integer $idindex id index
1134 * @param string $data data to edit
1135 * @param array $column_enum_values $column['values']
1136 * @param boolean $readOnly is column read only or not
1138 * @return string an html snippet
1140 private function getDropDownDependingOnLength(
1142 $column_name_appendix,
1145 $tabindex_for_value,
1148 array $column_enum_values,
1151 $html_output = '<select name="fields' . $column_name_appendix . '"'
1152 . ' ' . $onChangeClause
1153 . ' class="textfield"'
1154 . ' tabindex="' . ($tabindex +
$tabindex_for_value) . '"'
1155 . ($readOnly ?
' disabled' : '')
1156 . ' id="field_' . $idindex . '_3">';
1157 $html_output .= '<option value=""> </option>' . "\n";
1159 $selected_html = '';
1160 foreach ($column_enum_values as $enum_value) {
1161 $html_output .= '<option value="' . $enum_value['html'] . '"';
1162 if ($data == $enum_value['plain']
1164 && (! isset($_POST['where_clause']) ||
$column['Null'] != 'YES')
1165 && isset($column['Default'])
1166 && $enum_value['plain'] == $column['Default'])
1168 $html_output .= ' selected="selected"';
1169 $selected_html = $enum_value['html'];
1171 $html_output .= '>' . $enum_value['html'] . '</option>' . "\n";
1173 $html_output .= '</select>';
1175 //Add hidden input, as disabled <select> input does not included in POST.
1177 $html_output .= '<input name="fields' . $column_name_appendix . '"'
1178 . ' type="hidden" value="' . $selected_html . '">';
1180 return $html_output;
1184 * Get HTML radio button for less than 20 string length
1186 * @param string $column_name_appendix the name attribute
1187 * @param string $onChangeClause onchange clause for fields
1188 * @param integer $tabindex tab index
1189 * @param array $column description of column in given table
1190 * @param integer $tabindex_for_value offset for the values tabindex
1191 * @param integer $idindex id index
1192 * @param string $data data to edit
1193 * @param array $column_enum_values $column['values']
1194 * @param boolean $readOnly is column read only or not
1196 * @return string an html snippet
1198 private function getRadioButtonDependingOnLength(
1199 $column_name_appendix,
1203 $tabindex_for_value,
1206 array $column_enum_values,
1211 foreach ($column_enum_values as $enum_value) {
1213 . '<input type="radio" name="fields' . $column_name_appendix . '"'
1214 . ' class="textfield"'
1215 . ' value="' . $enum_value['html'] . '"'
1216 . ' id="field_' . $idindex . '_3_' . $j . '"'
1217 . ' ' . $onChangeClause;
1218 if ($data == $enum_value['plain']
1220 && (! isset($_POST['where_clause']) ||
$column['Null'] != 'YES')
1221 && isset($column['Default'])
1222 && $enum_value['plain'] == $column['Default'])
1224 $html_output .= ' checked="checked"';
1225 } elseif ($readOnly) {
1226 $html_output .= ' disabled';
1228 $html_output .= ' tabindex="' . ($tabindex +
$tabindex_for_value) . '">';
1229 $html_output .= '<label for="field_' . $idindex . '_3_' . $j . '">'
1230 . $enum_value['html'] . '</label>' . "\n";
1233 return $html_output;
1237 * Get the HTML for 'set' pma type
1239 * @param array $column description of column in given table
1240 * @param array $extracted_columnspec associative array containing type,
1241 * spec_in_brackets and possibly
1242 * enum_set_values (another array)
1243 * @param string $backup_field hidden input field
1244 * @param string $column_name_appendix the name attribute
1245 * @param string $onChangeClause onchange clause for fields
1246 * @param integer $tabindex tab index
1247 * @param integer $tabindex_for_value offset for the values tabindex
1248 * @param integer $idindex id index
1249 * @param string $data description of the column field
1250 * @param boolean $readOnly is column read only or not
1252 * @return string an html snippet
1254 private function getPmaTypeSet(
1256 array $extracted_columnspec,
1258 $column_name_appendix,
1261 $tabindex_for_value,
1266 list($column_set_values, $select_size) = $this->getColumnSetValueAndSelectSize(
1268 $extracted_columnspec
1270 $vset = array_flip(explode(',', $data));
1271 $html_output = $backup_field . "\n";
1272 $html_output .= '<input type="hidden" name="fields_type'
1273 . $column_name_appendix . '" value="set">';
1274 $html_output .= '<select name="fields' . $column_name_appendix . '[]"'
1275 . ' class="textfield"'
1276 . ($readOnly ?
' disabled' : '')
1277 . ' size="' . $select_size . '"'
1278 . ' multiple="multiple"'
1279 . ' ' . $onChangeClause
1280 . ' tabindex="' . ($tabindex +
$tabindex_for_value) . '"'
1281 . ' id="field_' . $idindex . '_3">';
1283 $selected_html = '';
1284 foreach ($column_set_values as $column_set_value) {
1285 $html_output .= '<option value="' . $column_set_value['html'] . '"';
1286 if (isset($vset[$column_set_value['plain']])) {
1287 $html_output .= ' selected="selected"';
1288 $selected_html = $column_set_value['html'];
1290 $html_output .= '>' . $column_set_value['html'] . '</option>' . "\n";
1292 $html_output .= '</select>';
1294 //Add hidden input, as disabled <select> input does not included in POST.
1296 $html_output .= '<input name="fields' . $column_name_appendix . '[]"'
1297 . ' type="hidden" value="' . $selected_html . '">';
1299 return $html_output;
1303 * Retrieve column 'set' value and select size
1305 * @param array $column description of column in given table
1306 * @param array $extracted_columnspec associative array containing type,
1307 * spec_in_brackets and possibly enum_set_values
1310 * @return array $column['values'], $column['select_size']
1312 private function getColumnSetValueAndSelectSize(
1314 array $extracted_columnspec
1316 if (! isset($column['values'])) {
1317 $column['values'] = [];
1318 foreach ($extracted_columnspec['enum_set_values'] as $val) {
1319 $column['values'][] = [
1321 'html' => htmlspecialchars($val),
1324 $column['select_size'] = min(4, count($column['values']));
1328 $column['select_size'],
1333 * Get HTML for binary and blob column
1335 * @param array $column description of column in given table
1336 * @param string|null $data data to edit
1337 * @param string $special_chars special characters
1338 * @param integer $biggest_max_file_size biggest max file size for uploading
1339 * @param string $backup_field hidden input field
1340 * @param string $column_name_appendix the name attribute
1341 * @param string $onChangeClause onchange clause for fields
1342 * @param integer $tabindex tab index
1343 * @param integer $tabindex_for_value offset for the values tabindex
1344 * @param integer $idindex id index
1345 * @param string $text_dir text direction
1346 * @param string $special_chars_encoded replaced char if the string starts
1347 * with a \r\n pair (0x0d0a) add an
1349 * @param string $vkey [multi_edit]['row_id']
1350 * @param boolean $is_upload is upload or not
1351 * @param boolean $readOnly is column read only or not
1353 * @return string an html snippet
1355 private function getBinaryAndBlobColumn(
1359 $biggest_max_file_size,
1361 $column_name_appendix,
1364 $tabindex_for_value,
1367 $special_chars_encoded,
1373 // Add field type : Protected or Hexadecimal
1374 $fields_type_html = '<input type="hidden" name="fields_type'
1375 . $column_name_appendix . '" value="%s">';
1376 // Default value : hex
1377 $fields_type_val = 'hex';
1378 if (($GLOBALS['cfg']['ProtectBinary'] === 'blob' && $column['is_blob'])
1379 ||
($GLOBALS['cfg']['ProtectBinary'] === 'all')
1380 ||
($GLOBALS['cfg']['ProtectBinary'] === 'noblob' && ! $column['is_blob'])
1382 $html_output .= __('Binary - do not edit');
1384 $data_size = Util
::formatByteDown(
1385 mb_strlen(stripslashes($data)),
1389 $html_output .= ' (' . $data_size[0] . ' ' . $data_size[1] . ')';
1392 $fields_type_val = 'protected';
1393 $html_output .= '<input type="hidden" name="fields'
1394 . $column_name_appendix . '" value="">';
1395 } elseif ($column['is_blob']
1396 ||
($column['len'] > $GLOBALS['cfg']['LimitChars'])
1398 $html_output .= "\n" . $this->getTextarea(
1401 $column_name_appendix,
1404 $tabindex_for_value,
1407 $special_chars_encoded,
1412 // field size should be at least 4 and max $GLOBALS['cfg']['LimitChars']
1413 $fieldsize = min(max($column['len'], 4), $GLOBALS['cfg']['LimitChars']);
1414 $html_output .= "\n" . $backup_field . "\n" . $this->getHtmlInput(
1416 $column_name_appendix,
1421 $tabindex_for_value,
1427 $html_output .= sprintf($fields_type_html, $fields_type_val);
1429 if ($is_upload && $column['is_blob'] && ! $readOnly) {
1430 // We don't want to prevent users from using
1431 // browser's default drag-drop feature on some page(s),
1432 // so we add noDragDrop class to the input
1433 $html_output .= '<br>'
1434 . '<input type="file"'
1435 . ' name="fields_upload' . $vkey . '[' . $column['Field_md5'] . ']"'
1436 . ' class="textfield noDragDrop" id="field_' . $idindex . '_3" size="10"'
1437 . ' ' . $onChangeClause . '> ';
1438 list($html_out,) = $this->getMaxUploadSize(
1440 $biggest_max_file_size
1442 $html_output .= $html_out;
1445 if (! empty($GLOBALS['cfg']['UploadDir']) && ! $readOnly) {
1446 $html_output .= $this->getSelectOptionForUpload($vkey, $column);
1449 return $html_output;
1453 * Get HTML input type
1455 * @param array $column description of column in given table
1456 * @param string $column_name_appendix the name attribute
1457 * @param string $special_chars special characters
1458 * @param integer $fieldsize html field size
1459 * @param string $onChangeClause onchange clause for fields
1460 * @param integer $tabindex tab index
1461 * @param integer $tabindex_for_value offset for the values tabindex
1462 * @param integer $idindex id index
1463 * @param string $data_type the html5 data-* attribute type
1464 * @param boolean $readOnly is column read only or not
1466 * @return string an html snippet
1468 private function getHtmlInput(
1470 $column_name_appendix,
1475 $tabindex_for_value,
1480 $input_type = 'text';
1481 // do not use the 'date' or 'time' types here; they have no effect on some
1482 // browsers and create side effects (see bug #4218)
1484 $the_class = 'textfield';
1485 // verify True_Type which does not contain the parentheses and length
1487 if ($column['True_Type'] === 'date') {
1488 $the_class .= ' datefield';
1489 } elseif ($column['True_Type'] === 'time') {
1490 $the_class .= ' timefield';
1491 } elseif ($column['True_Type'] === 'datetime'
1492 ||
$column['True_Type'] === 'timestamp'
1494 $the_class .= ' datetimefield';
1497 $input_min_max = false;
1498 if (in_array($column['True_Type'], $this->dbi
->types
->getIntegerTypes())) {
1499 $extracted_columnspec = Util
::extractColumnSpec(
1502 $is_unsigned = $extracted_columnspec['unsigned'];
1503 $min_max_values = $this->dbi
->types
->getIntegerRange(
1504 $column['True_Type'],
1507 $input_min_max = 'min="' . $min_max_values[0] . '" '
1508 . 'max="' . $min_max_values[1] . '"';
1511 return '<input type="' . $input_type . '"'
1512 . ' name="fields' . $column_name_appendix . '"'
1513 . ' value="' . $special_chars . '" size="' . $fieldsize . '"'
1514 . (isset($column['is_char']) && $column['is_char']
1515 ?
' data-maxlength="' . $fieldsize . '"'
1517 . ($readOnly ?
' readonly="readonly"' : '')
1518 . ($input_min_max !== false ?
' ' . $input_min_max : '')
1519 . ' data-type="' . $data_type . '"'
1520 . ($input_type === 'time' ?
' step="1"' : '')
1521 . ' class="' . $the_class . '" ' . $onChangeClause
1522 . ' tabindex="' . ($tabindex +
$tabindex_for_value) . '"'
1523 . ' id="field_' . $idindex . '_3">';
1527 * Get HTML select option for upload
1529 * @param string $vkey [multi_edit]['row_id']
1530 * @param array $column description of column in given table
1532 * @return string|null an html snippet
1534 private function getSelectOptionForUpload($vkey, array $column)
1536 $files = $this->fileListing
->getFileSelectOptions(
1537 Util
::userDir($GLOBALS['cfg']['UploadDir'])
1540 if ($files === false) {
1541 return '<span style="color:red">' . __('Error') . '</span><br>' . "\n"
1542 . __('The directory you set for upload work cannot be reached.') . "\n";
1543 } elseif (! empty($files)) {
1545 . '<i>' . __('Or') . '</i> '
1546 . __('web server upload directory:') . '<br>' . "\n"
1547 . '<select size="1" name="fields_uploadlocal'
1548 . $vkey . '[' . $column['Field_md5'] . ']">' . "\n"
1549 . '<option value="" selected="selected"></option>' . "\n"
1551 . '</select>' . "\n";
1558 * Retrieve the maximum upload file size
1560 * @param array $column description of column in given table
1561 * @param integer $biggest_max_file_size biggest max file size for uploading
1563 * @return array an html snippet and $biggest_max_file_size
1565 private function getMaxUploadSize(array $column, $biggest_max_file_size)
1567 // find maximum upload size, based on field type
1569 * @todo with functions this is not so easy, as you can basically
1570 * process any data with function like MD5
1572 global $max_upload_size;
1573 $max_field_sizes = [
1574 'tinyblob' => '256',
1576 'mediumblob' => '16777216',
1577 'longblob' => '4294967296',// yeah, really
1580 $this_field_max_size = $max_upload_size; // from PHP max
1581 if ($this_field_max_size > $max_field_sizes[$column['pma_type']]) {
1582 $this_field_max_size = $max_field_sizes[$column['pma_type']];
1585 = Util
::getFormattedMaximumUploadSize(
1586 $this_field_max_size
1588 // do not generate here the MAX_FILE_SIZE, because we should
1589 // put only one in the form to accommodate the biggest field
1590 if ($this_field_max_size > $biggest_max_file_size) {
1591 $biggest_max_file_size = $this_field_max_size;
1595 $biggest_max_file_size,
1600 * Get HTML for the Value column of other datatypes
1601 * (here, "column" is used in the sense of HTML column in HTML table)
1603 * @param array $column description of column in given table
1604 * @param string $default_char_editing default char editing mode which is stored
1605 * in the config.inc.php script
1606 * @param string $backup_field hidden input field
1607 * @param string $column_name_appendix the name attribute
1608 * @param string $onChangeClause onchange clause for fields
1609 * @param integer $tabindex tab index
1610 * @param string $special_chars special characters
1611 * @param integer $tabindex_for_value offset for the values tabindex
1612 * @param integer $idindex id index
1613 * @param string $text_dir text direction
1614 * @param string $special_chars_encoded replaced char if the string starts
1615 * with a \r\n pair (0x0d0a) add an extra \n
1616 * @param string $data data to edit
1617 * @param array $extracted_columnspec associative array containing type,
1618 * spec_in_brackets and possibly
1619 * enum_set_values (another array)
1620 * @param boolean $readOnly is column read only or not
1622 * @return string an html snippet
1624 private function getValueColumnForOtherDatatypes(
1626 $default_char_editing,
1628 $column_name_appendix,
1632 $tabindex_for_value,
1635 $special_chars_encoded,
1637 array $extracted_columnspec,
1640 // HTML5 data-* attribute data-type
1641 $data_type = $this->dbi
->types
->getTypeClass($column['True_Type']);
1642 $fieldsize = $this->getColumnSize($column, $extracted_columnspec);
1643 $html_output = $backup_field . "\n";
1644 if ($column['is_char']
1645 && ($GLOBALS['cfg']['CharEditing'] == 'textarea'
1646 ||
mb_strpos($data, "\n") !== false)
1648 $html_output .= "\n";
1649 $GLOBALS['cfg']['CharEditing'] = $default_char_editing;
1650 $html_output .= $this->getTextarea(
1653 $column_name_appendix,
1656 $tabindex_for_value,
1659 $special_chars_encoded,
1664 $html_output .= $this->getHtmlInput(
1666 $column_name_appendix,
1671 $tabindex_for_value,
1677 if (preg_match('/(VIRTUAL|PERSISTENT|GENERATED)/', $column['Extra']) && $column['Extra'] !== 'DEFAULT_GENERATED') {
1678 $html_output .= '<input type="hidden" name="virtual'
1679 . $column_name_appendix . '" value="1">';
1681 if ($column['Extra'] == 'auto_increment') {
1682 $html_output .= '<input type="hidden" name="auto_increment'
1683 . $column_name_appendix . '" value="1">';
1685 if (substr($column['pma_type'], 0, 9) == 'timestamp') {
1686 $html_output .= '<input type="hidden" name="fields_type'
1687 . $column_name_appendix . '" value="timestamp">';
1689 if (substr($column['pma_type'], 0, 8) == 'datetime') {
1690 $html_output .= '<input type="hidden" name="fields_type'
1691 . $column_name_appendix . '" value="datetime">';
1693 if ($column['True_Type'] == 'bit') {
1694 $html_output .= '<input type="hidden" name="fields_type'
1695 . $column_name_appendix . '" value="bit">';
1698 return $html_output;
1702 * Get the field size
1704 * @param array $column description of column in given table
1705 * @param array $extracted_columnspec associative array containing type,
1706 * spec_in_brackets and possibly enum_set_values
1709 * @return integer field size
1711 private function getColumnSize(array $column, array $extracted_columnspec)
1713 if ($column['is_char']) {
1714 $fieldsize = $extracted_columnspec['spec_in_brackets'];
1715 if ($fieldsize > $GLOBALS['cfg']['MaxSizeForInputField']) {
1717 * This case happens for CHAR or VARCHAR columns which have
1718 * a size larger than the maximum size for input field.
1720 $GLOBALS['cfg']['CharEditing'] = 'textarea';
1724 * This case happens for example for INT or DATE columns;
1725 * in these situations, the value returned in $column['len']
1726 * seems appropriate.
1728 $fieldsize = $column['len'];
1731 max($fieldsize, $GLOBALS['cfg']['MinSizeForInputField']),
1732 $GLOBALS['cfg']['MaxSizeForInputField']
1737 * Get HTML for gis data types
1739 * @return string an html snippet
1741 private function getHtmlForGisDataTypes()
1743 $edit_str = Util
::getIcon('b_edit', __('Edit/Insert'));
1744 return '<span class="open_gis_editor">'
1745 . Util
::linkOrButton(
1755 * get html for continue insertion form
1757 * @param string $table name of the table
1758 * @param string $db name of the database
1759 * @param array $where_clause_array array of where clauses
1760 * @param string $err_url error url
1762 * @return string an html snippet
1764 public function getContinueInsertionForm(
1767 array $where_clause_array,
1770 return $this->template
->render('table/insert/continue_insertion_form', [
1773 'where_clause_array' => $where_clause_array,
1774 'err_url' => $err_url,
1775 'goto' => $GLOBALS['goto'],
1776 'sql_query' => isset($_POST['sql_query']) ?
$_POST['sql_query'] : null,
1777 'has_where_clause' => isset($_POST['where_clause']),
1778 'insert_rows_default' => $GLOBALS['cfg']['InsertRows'],
1785 * @param array|null $where_clause where clause
1786 * @param string $after_insert insert mode, e.g. new_insert, same_insert
1787 * @param integer $tabindex tab index
1788 * @param integer $tabindex_for_value offset for the values tabindex
1789 * @param boolean $found_unique_key boolean variable for unique key
1791 * @return string an html snippet
1793 public function getActionsPanel(
1797 $tabindex_for_value,
1800 $html_output = '<fieldset id="actions_panel">'
1801 . '<table cellpadding="5" cellspacing="0" class="tdblock width100">'
1803 . '<td class="nowrap vmiddle">'
1804 . $this->getSubmitTypeDropDown($where_clause, $tabindex, $tabindex_for_value)
1807 $html_output .= '</td>'
1808 . '<td class="vmiddle">'
1809 . ' <strong>'
1810 . __('and then') . '</strong> '
1812 . '<td class="nowrap vmiddle">'
1813 . $this->getAfterInsertDropDown(
1820 $html_output .= '<tr>'
1821 . $this->getSubmitAndResetButtonForActionsPanel($tabindex, $tabindex_for_value)
1825 return $html_output;
1829 * Get a HTML drop down for submit types
1831 * @param array|null $where_clause where clause
1832 * @param integer $tabindex tab index
1833 * @param integer $tabindex_for_value offset for the values tabindex
1835 * @return string an html snippet
1837 private function getSubmitTypeDropDown(
1842 $html_output = '<select name="submit_type" class="control_at_footer" tabindex="'
1843 . ($tabindex +
$tabindex_for_value +
1) . '">';
1844 if (isset($where_clause)) {
1845 $html_output .= '<option value="save">' . __('Save') . '</option>';
1847 $html_output .= '<option value="insert">'
1848 . __('Insert as new row')
1850 . '<option value="insertignore">'
1851 . __('Insert as new row and ignore errors')
1853 . '<option value="showinsert">'
1854 . __('Show insert query')
1857 return $html_output;
1861 * Get HTML drop down for after insert
1863 * @param array|null $where_clause where clause
1864 * @param string $after_insert insert mode, e.g. new_insert, same_insert
1865 * @param boolean $found_unique_key boolean variable for unique key
1867 * @return string an html snippet
1869 private function getAfterInsertDropDown($where_clause, $after_insert, $found_unique_key)
1871 $html_output = '<select name="after_insert" class="control_at_footer">'
1872 . '<option value="back" '
1873 . ($after_insert == 'back' ?
'selected="selected"' : '') . '>'
1874 . __('Go back to previous page') . '</option>'
1875 . '<option value="new_insert" '
1876 . ($after_insert == 'new_insert' ?
'selected="selected"' : '') . '>'
1877 . __('Insert another new row') . '</option>';
1879 if (isset($where_clause)) {
1880 $html_output .= '<option value="same_insert" '
1881 . ($after_insert == 'same_insert' ?
'selected="selected"' : '') . '>'
1882 . __('Go back to this page') . '</option>';
1884 // If we have just numeric primary key, we can also edit next
1885 // in 2.8.2, we were looking for `field_name` = numeric_value
1886 //if (preg_match('@^[\s]*`[^`]*` = [0-9]+@', $where_clause)) {
1887 // in 2.9.0, we are looking for `table_name`.`field_name` = numeric_value
1888 $is_numeric = false;
1889 if (! is_array($where_clause)) {
1890 $where_clause = [$where_clause];
1892 for ($i = 0, $nb = count($where_clause); $i < $nb; $i++
) {
1893 // preg_match() returns 1 if there is a match
1894 $is_numeric = (preg_match(
1895 '@^[\s]*`[^`]*`[\.]`[^`]*` = [0-9]+@',
1898 if ($is_numeric === true) {
1902 if ($found_unique_key && $is_numeric) {
1903 $html_output .= '<option value="edit_next" '
1904 . ($after_insert == 'edit_next' ?
'selected="selected"' : '') . '>'
1905 . __('Edit next row') . '</option>';
1908 $html_output .= '</select>';
1909 return $html_output;
1913 * get Submit button and Reset button for action panel
1915 * @param integer $tabindex tab index
1916 * @param integer $tabindex_for_value offset for the values tabindex
1918 * @return string an html snippet
1920 private function getSubmitAndResetButtonForActionsPanel($tabindex, $tabindex_for_value)
1925 'Use TAB key to move from value to value,'
1926 . ' or CTRL+arrows to move anywhere.'
1930 . '<td colspan="3" class="right vmiddle">'
1931 . '<input type="button" class="btn btn-secondary preview_sql" value="' . __('Preview SQL') . '"'
1932 . ' tabindex="' . ($tabindex +
$tabindex_for_value +
6) . '">'
1933 . '<input type="reset" class="btn btn-secondary control_at_footer" value="' . __('Reset') . '"'
1934 . ' tabindex="' . ($tabindex +
$tabindex_for_value +
7) . '">'
1935 . '<input type="submit" class="btn btn-primary control_at_footer" value="' . __('Go') . '"'
1936 . ' tabindex="' . ($tabindex +
$tabindex_for_value +
8) . '" id="buttonYes">'
1941 * Get table head and table foot for insert row table
1943 * @param array $url_params url parameters
1945 * @return string an html snippet
1947 private function getHeadAndFootOfInsertRowTable(array $url_params)
1949 $html_output = '<div class="responsivetable">'
1950 . '<table class="insertRowTable topmargin">'
1953 . '<th>' . __('Column') . '</th>';
1955 if ($GLOBALS['cfg']['ShowFieldTypesInDataEditView']) {
1956 $html_output .= $this->showTypeOrFunction('type', $url_params, true);
1958 if ($GLOBALS['cfg']['ShowFunctionFields']) {
1959 $html_output .= $this->showTypeOrFunction('function', $url_params, true);
1962 $html_output .= '<th>' . __('Null') . '</th>'
1963 . '<th class="fillPage">' . __('Value') . '</th>'
1968 . '<th colspan="5" class="tblFooters right">'
1969 . '<input class="btn btn-primary" type="submit" value="' . __('Go') . '">'
1973 return $html_output;
1977 * Prepares the field value and retrieve special chars, backup field and data array
1979 * @param array $current_row a row of the table
1980 * @param array $column description of column in given table
1981 * @param array $extracted_columnspec associative array containing type,
1982 * spec_in_brackets and possibly
1983 * enum_set_values (another array)
1984 * @param boolean $real_null_value whether column value null or not null
1985 * @param array $gis_data_types list of GIS data types
1986 * @param string $column_name_appendix string to append to column name in input
1987 * @param bool $as_is use the data as is, used in repopulating
1989 * @return array $real_null_value, $data, $special_chars, $backup_field,
1990 * $special_chars_encoded
1992 private function getSpecialCharsAndBackupFieldForExistingRow(
1995 array $extracted_columnspec,
1997 array $gis_data_types,
1998 $column_name_appendix,
2001 $special_chars_encoded = '';
2004 if (! isset($current_row[$column['Field']])) {
2005 $real_null_value = true;
2006 $current_row[$column['Field']] = '';
2007 $special_chars = '';
2008 $data = $current_row[$column['Field']];
2009 } elseif ($column['True_Type'] == 'bit') {
2010 $special_chars = $as_is
2011 ?
$current_row[$column['Field']]
2012 : Util
::printableBitValue(
2013 (int) $current_row[$column['Field']],
2014 (int) $extracted_columnspec['spec_in_brackets']
2016 } elseif ((substr($column['True_Type'], 0, 9) == 'timestamp'
2017 ||
$column['True_Type'] == 'datetime'
2018 ||
$column['True_Type'] == 'time')
2019 && (mb_strpos($current_row[$column['Field']], ".") !== false)
2021 $current_row[$column['Field']] = $as_is
2022 ?
$current_row[$column['Field']]
2023 : Util
::addMicroseconds(
2024 $current_row[$column['Field']]
2026 $special_chars = htmlspecialchars($current_row[$column['Field']]);
2027 } elseif (in_array($column['True_Type'], $gis_data_types)) {
2028 // Convert gis data to Well Know Text format
2029 $current_row[$column['Field']] = $as_is
2030 ?
$current_row[$column['Field']]
2032 $current_row[$column['Field']],
2035 $special_chars = htmlspecialchars($current_row[$column['Field']]);
2037 // special binary "characters"
2038 if ($column['is_binary']
2039 ||
($column['is_blob'] && $GLOBALS['cfg']['ProtectBinary'] !== 'all')
2041 $current_row[$column['Field']] = $as_is
2042 ?
$current_row[$column['Field']]
2044 $current_row[$column['Field']]
2047 $special_chars = htmlspecialchars($current_row[$column['Field']]);
2049 //We need to duplicate the first \n or otherwise we will lose
2050 //the first newline entered in a VARCHAR or TEXT column
2051 $special_chars_encoded
2052 = Util
::duplicateFirstNewline($special_chars);
2054 $data = $current_row[$column['Field']];
2055 } // end if... else...
2057 //when copying row, it is useful to empty auto-increment column
2058 // to prevent duplicate key error
2059 if (isset($_POST['default_action'])
2060 && $_POST['default_action'] === 'insert'
2062 if ($column['Key'] === 'PRI'
2063 && mb_strpos($column['Extra'], 'auto_increment') !== false
2065 $data = $special_chars_encoded = $special_chars = null;
2068 // If a timestamp field value is not included in an update
2069 // statement MySQL auto-update it to the current timestamp;
2070 // however, things have changed since MySQL 4.1, so
2071 // it's better to set a fields_prev in this situation
2072 $backup_field = '<input type="hidden" name="fields_prev'
2073 . $column_name_appendix . '" value="'
2074 . htmlspecialchars($current_row[$column['Field']]) . '">';
2078 $special_chars_encoded,
2086 * display default values
2088 * @param array $column description of column in given table
2089 * @param boolean $real_null_value whether column value null or not null
2091 * @return array $real_null_value, $data, $special_chars,
2092 * $backup_field, $special_chars_encoded
2094 private function getSpecialCharsAndBackupFieldForInsertingMode(
2098 if (! isset($column['Default'])) {
2099 $column['Default'] = '';
2100 $real_null_value = true;
2103 $data = $column['Default'];
2106 $trueType = $column['True_Type'];
2108 if ($trueType == 'bit') {
2109 $special_chars = Util
::convertBitDefaultValue(
2112 } elseif (substr($trueType, 0, 9) == 'timestamp'
2113 ||
$trueType == 'datetime'
2114 ||
$trueType == 'time'
2116 $special_chars = Util
::addMicroseconds($column['Default']);
2117 } elseif ($trueType == 'binary' ||
$trueType == 'varbinary') {
2118 $special_chars = bin2hex($column['Default']);
2120 $special_chars = htmlspecialchars($column['Default']);
2123 $special_chars_encoded = Util
::duplicateFirstNewline(
2131 $special_chars_encoded,
2136 * Prepares the update/insert of a row
2138 * @return array $loop_array, $using_key, $is_insert, $is_insertignore
2140 public function getParamsForUpdateOrInsert()
2142 if (isset($_POST['where_clause'])) {
2143 // we were editing something => use the WHERE clause
2144 $loop_array = is_array($_POST['where_clause'])
2145 ?
$_POST['where_clause']
2146 : [$_POST['where_clause']];
2148 $is_insert = isset($_POST['submit_type'])
2149 && ($_POST['submit_type'] == 'insert'
2150 ||
$_POST['submit_type'] == 'showinsert'
2151 ||
$_POST['submit_type'] == 'insertignore');
2153 // new row => use indexes
2155 if (! empty($_POST['fields'])) {
2156 foreach ($_POST['fields']['multi_edit'] as $key => $dummy) {
2157 $loop_array[] = $key;
2163 $is_insertignore = isset($_POST['submit_type'])
2164 && $_POST['submit_type'] == 'insertignore';
2174 * Check wether insert row mode and if so include tbl_changen script and set
2179 public function isInsertRow()
2181 if (isset($_POST['insert_rows'])
2182 && is_numeric($_POST['insert_rows'])
2183 && $_POST['insert_rows'] != $GLOBALS['cfg']['InsertRows']
2185 $GLOBALS['cfg']['InsertRows'] = $_POST['insert_rows'];
2186 $response = Response
::getInstance();
2187 $header = $response->getHeader();
2188 $scripts = $header->getScripts();
2189 $scripts->addFile('vendor/jquery/additional-methods.js');
2190 $scripts->addFile('table/change.js');
2191 if (! defined('TESTSUITE')) {
2192 include ROOT_PATH
. 'libraries/entry_points/table/change.php';
2199 * set $_SESSION for edit_next
2201 * @param string $one_where_clause one where clause from where clauses array
2205 public function setSessionForEditNext($one_where_clause)
2207 $local_query = 'SELECT * FROM ' . Util
::backquote($GLOBALS['db'])
2208 . '.' . Util
::backquote($GLOBALS['table']) . ' WHERE '
2209 . str_replace('` =', '` >', $one_where_clause) . ' LIMIT 1;';
2211 $res = $this->dbi
->query($local_query);
2212 $row = $this->dbi
->fetchRow($res);
2213 $meta = $this->dbi
->getFieldsMeta($res);
2214 // must find a unique condition based on unique key,
2215 // not a combination of all fields
2216 list($unique_condition, $clause_is_unique)
2217 = Util
::getUniqueCondition(
2219 count($meta), // fields_cnt
2220 $meta, // fields_meta
2222 true, // force_unique
2223 false, // restrict_to_table
2224 null // analyzed_sql_results
2226 if (! empty($unique_condition)) {
2227 $_SESSION['edit_next'] = $unique_condition;
2229 unset($unique_condition, $clause_is_unique);
2233 * set $goto_include variable for different cases and retrieve like,
2234 * if $GLOBALS['goto'] empty, if $goto_include previously not defined
2235 * and new_insert, same_insert, edit_next
2237 * @param string $goto_include store some script for include, otherwise it is
2242 public function getGotoInclude($goto_include)
2249 if (isset($_POST['after_insert'])
2250 && in_array($_POST['after_insert'], $valid_options)
2252 $goto_include = 'libraries/entry_points/table/change.php';
2253 } elseif (! empty($GLOBALS['goto'])) {
2254 if (! preg_match('@^[a-z_]+\.php$@', $GLOBALS['goto'])) {
2255 // this should NOT happen
2256 //$GLOBALS['goto'] = false;
2257 $goto_include = false;
2259 $goto_include = $GLOBALS['goto'];
2261 if ($GLOBALS['goto'] == 'db_sql.php' && strlen($GLOBALS['table']) > 0) {
2262 $GLOBALS['table'] = '';
2265 if (! $goto_include) {
2266 if (strlen($GLOBALS['table']) === 0) {
2267 $goto_include = 'db_sql.php';
2269 $goto_include = 'tbl_sql.php';
2272 return $goto_include;
2276 * Defines the url to return in case of failure of the query
2278 * @param array $url_params url parameters
2280 * @return string error url for query failure
2282 public function getErrorUrl(array $url_params)
2284 if (isset($_POST['err_url'])) {
2285 return $_POST['err_url'];
2288 return Url
::getFromRoute('/table/change', $url_params);
2292 * Builds the sql query
2294 * @param boolean $is_insertignore $_POST['submit_type'] == 'insertignore'
2295 * @param array $query_fields column names array
2296 * @param array $value_sets array of query values
2298 * @return array of query
2300 public function buildSqlQuery($is_insertignore, array $query_fields, array $value_sets)
2302 if ($is_insertignore) {
2303 $insert_command = 'INSERT IGNORE ';
2305 $insert_command = 'INSERT ';
2308 $insert_command . 'INTO '
2309 . Util
::backquote($GLOBALS['table'])
2310 . ' (' . implode(', ', $query_fields) . ') VALUES ('
2311 . implode('), (', $value_sets) . ')',
2317 * Executes the sql query and get the result, then move back to the calling page
2319 * @param array $url_params url parameters array
2320 * @param array $query built query from buildSqlQuery()
2322 * @return array $url_params, $total_affected_rows, $last_messages
2323 * $warning_messages, $error_messages, $return_to_sql_query
2325 public function executeSqlQuery(array $url_params, array $query)
2327 $return_to_sql_query = '';
2328 if (! empty($GLOBALS['sql_query'])) {
2329 $url_params['sql_query'] = $GLOBALS['sql_query'];
2330 $return_to_sql_query = $GLOBALS['sql_query'];
2332 $GLOBALS['sql_query'] = implode('; ', $query) . ';';
2333 // to ensure that the query is displayed in case of
2334 // "insert as new row" and then "insert another new row"
2335 $GLOBALS['display_query'] = $GLOBALS['sql_query'];
2337 $total_affected_rows = 0;
2338 $last_messages = [];
2339 $warning_messages = [];
2340 $error_messages = [];
2342 foreach ($query as $single_query) {
2343 if ($_POST['submit_type'] == 'showinsert') {
2344 $last_messages[] = Message
::notice(__('Showing SQL query'));
2347 if ($GLOBALS['cfg']['IgnoreMultiSubmitErrors']) {
2348 $result = $this->dbi
->tryQuery($single_query);
2350 $result = $this->dbi
->query($single_query);
2353 $error_messages[] = $this->dbi
->getError();
2355 // The next line contains a real assignment, it's not a typo
2356 if ($tmp = @$this->dbi
->affectedRows()) {
2357 $total_affected_rows +
= $tmp;
2361 $insert_id = $this->dbi
->insertId();
2362 if ($insert_id != 0) {
2363 // insert_id is id of FIRST record inserted in one insert, so if we
2364 // inserted multiple rows, we had to increment this
2366 if ($total_affected_rows > 0) {
2367 $insert_id +
= $total_affected_rows - 1;
2369 $last_message = Message
::notice(__('Inserted row id: %1$d'));
2370 $last_message->addParam($insert_id);
2371 $last_messages[] = $last_message;
2373 $this->dbi
->freeResult($result);
2375 $warning_messages = $this->getWarningMessages();
2379 $total_affected_rows,
2383 $return_to_sql_query,
2388 * get the warning messages array
2392 private function getWarningMessages()
2394 $warning_essages = [];
2395 foreach ($this->dbi
->getWarnings() as $warning) {
2396 $warning_essages[] = Message
::sanitize(
2397 $warning['Level'] . ': #' . $warning['Code'] . ' ' . $warning['Message']
2400 return $warning_essages;
2404 * Column to display from the foreign table?
2406 * @param string $where_comparison string that contain relation field value
2407 * @param array $map all Relations to foreign tables for a given
2408 * table or optionally a given column in a table
2409 * @param string $relation_field relation field
2411 * @return string display value from the foreign table
2413 public function getDisplayValueForForeignTableColumn(
2418 $foreigner = $this->relation
->searchColumnInForeigners($map, $relation_field);
2419 $display_field = $this->relation
->getDisplayField(
2420 $foreigner['foreign_db'],
2421 $foreigner['foreign_table']
2423 // Field to display from the foreign table?
2424 if ($display_field !== null && strlen($display_field) > 0) {
2425 $dispsql = 'SELECT ' . Util
::backquote($display_field)
2426 . ' FROM ' . Util
::backquote($foreigner['foreign_db'])
2427 . '.' . Util
::backquote($foreigner['foreign_table'])
2428 . ' WHERE ' . Util
::backquote($foreigner['foreign_field'])
2429 . $where_comparison;
2430 $dispresult = $this->dbi
->tryQuery(
2432 DatabaseInterface
::CONNECT_USER
,
2433 DatabaseInterface
::QUERY_STORE
2435 if ($dispresult && $this->dbi
->numRows($dispresult) > 0) {
2436 list($dispval) = $this->dbi
->fetchRow($dispresult);
2441 $this->dbi
->freeResult($dispresult);
2449 * Display option in the cell according to user choices
2451 * @param array $map all Relations to foreign tables for a given
2452 * table or optionally a given column in a table
2453 * @param string $relation_field relation field
2454 * @param string $where_comparison string that contain relation field value
2455 * @param string $dispval display value from the foreign table
2456 * @param string $relation_field_value relation field value
2458 * @return string HTML <a> tag
2460 public function getLinkForRelationalDisplayField(
2465 $relation_field_value
2467 $foreigner = $this->relation
->searchColumnInForeigners($map, $relation_field);
2468 if ('K' == $_SESSION['tmpval']['relational_display']) {
2469 // user chose "relational key" in the display options, so
2470 // the title contains the display field
2471 $title = ! empty($dispval)
2472 ?
' title="' . htmlspecialchars($dispval) . '"'
2475 $title = ' title="' . htmlspecialchars($relation_field_value) . '"';
2478 'db' => $foreigner['foreign_db'],
2479 'table' => $foreigner['foreign_table'],
2481 'sql_query' => 'SELECT * FROM '
2482 . Util
::backquote($foreigner['foreign_db'])
2483 . '.' . Util
::backquote($foreigner['foreign_table'])
2484 . ' WHERE ' . Util
::backquote($foreigner['foreign_field'])
2485 . $where_comparison,
2487 $output = '<a href="sql.php'
2488 . Url
::getCommon($_url_params) . '"' . $title . '>';
2490 if ('D' == $_SESSION['tmpval']['relational_display']) {
2491 // user chose "relational display field" in the
2492 // display options, so show display field in the cell
2493 $output .= ! empty($dispval) ?
htmlspecialchars($dispval) : '';
2495 // otherwise display data in the cell
2496 $output .= htmlspecialchars($relation_field_value);
2503 * Transform edited values
2505 * @param string $db db name
2506 * @param string $table table name
2507 * @param array $transformation mimetypes for all columns of a table
2508 * [field_name][field_key]
2509 * @param array $edited_values transform columns list and new values
2510 * @param string $file file containing the transformation plugin
2511 * @param string $column_name column name
2512 * @param array $extra_data extra data array
2513 * @param string $type the type of transformation
2517 public function transformEditedValues(
2520 array $transformation,
2521 array &$edited_values,
2527 $include_file = 'libraries/classes/Plugins/Transformations/' . $file;
2528 if (is_file($include_file)) {
2532 'where_clause' => $_POST['where_clause'],
2533 'transform_key' => $column_name,
2535 $transform_options = $this->transformations
->getOptions(
2536 isset($transformation[$type . '_options'])
2537 ?
$transformation[$type . '_options']
2540 $transform_options['wrapper_link'] = Url
::getCommon($_url_params);
2541 $class_name = $this->transformations
->getClassName($include_file);
2542 if (class_exists($class_name)) {
2543 /** @var TransformationsPlugin $transformation_plugin */
2544 $transformation_plugin = new $class_name();
2546 foreach ($edited_values as $cell_index => $curr_cell_edited_values) {
2547 if (isset($curr_cell_edited_values[$column_name])) {
2548 $edited_values[$cell_index][$column_name]
2549 = $extra_data['transformations'][$cell_index]
2550 = $transformation_plugin->applyTransformation(
2551 $curr_cell_edited_values[$column_name],
2555 } // end of loop for each transformation cell
2562 * Get current value in multi edit mode
2564 * @param array $multi_edit_funcs multiple edit functions array
2565 * @param array $multi_edit_salt multiple edit array with encryption salt
2566 * @param array $gis_from_text_functions array that contains gis from text functions
2567 * @param string $current_value current value in the column
2568 * @param array $gis_from_wkb_functions initially $val is $multi_edit_columns[$key]
2569 * @param array $func_optional_param array('RAND','UNIX_TIMESTAMP')
2570 * @param array $func_no_param array of set of string
2571 * @param string $key an md5 of the column name
2575 public function getCurrentValueAsAnArrayForMultipleEdit(
2578 $gis_from_text_functions,
2580 $gis_from_wkb_functions,
2581 $func_optional_param,
2585 if (empty($multi_edit_funcs[$key])) {
2586 return $current_value;
2587 } elseif ('UUID' === $multi_edit_funcs[$key]) {
2588 /* This way user will know what UUID new row has */
2589 $uuid = $this->dbi
->fetchValue('SELECT UUID()');
2590 return "'" . $uuid . "'";
2591 } elseif ((in_array($multi_edit_funcs[$key], $gis_from_text_functions)
2592 && substr($current_value, 0, 3) == "'''")
2593 ||
in_array($multi_edit_funcs[$key], $gis_from_wkb_functions)
2595 // Remove enclosing apostrophes
2596 $current_value = mb_substr($current_value, 1, -1);
2597 // Remove escaping apostrophes
2598 $current_value = str_replace("''", "'", $current_value);
2599 return $multi_edit_funcs[$key] . '(' . $current_value . ')';
2600 } elseif (! in_array($multi_edit_funcs[$key], $func_no_param)
2601 ||
($current_value != "''"
2602 && in_array($multi_edit_funcs[$key], $func_optional_param))
2604 if ((isset($multi_edit_salt[$key])
2605 && ($multi_edit_funcs[$key] == "AES_ENCRYPT"
2606 ||
$multi_edit_funcs[$key] == "AES_DECRYPT"))
2607 ||
(! empty($multi_edit_salt[$key])
2608 && ($multi_edit_funcs[$key] == "DES_ENCRYPT"
2609 ||
$multi_edit_funcs[$key] == "DES_DECRYPT"
2610 ||
$multi_edit_funcs[$key] == "ENCRYPT"))
2612 return $multi_edit_funcs[$key] . '(' . $current_value . ",'"
2613 . $this->dbi
->escapeString($multi_edit_salt[$key]) . "')";
2616 return $multi_edit_funcs[$key] . '(' . $current_value . ')';
2619 return $multi_edit_funcs[$key] . '()';
2623 * Get query values array and query fields array for insert and update in multi edit
2625 * @param array $multi_edit_columns_name multiple edit columns name array
2626 * @param array $multi_edit_columns_null multiple edit columns null array
2627 * @param string $current_value current value in the column in loop
2628 * @param array $multi_edit_columns_prev multiple edit previous columns array
2629 * @param array $multi_edit_funcs multiple edit functions array
2630 * @param boolean $is_insert boolean value whether insert or not
2631 * @param array $query_values SET part of the sql query
2632 * @param array $query_fields array of query fields
2633 * @param string $current_value_as_an_array current value in the column
2635 * @param array $value_sets array of valu sets
2636 * @param string $key an md5 of the column name
2637 * @param array $multi_edit_columns_null_prev array of multiple edit columns
2640 * @return array ($query_values, $query_fields)
2642 public function getQueryValuesForInsertAndUpdateInMultipleEdit(
2643 $multi_edit_columns_name,
2644 $multi_edit_columns_null,
2646 $multi_edit_columns_prev,
2651 $current_value_as_an_array,
2654 $multi_edit_columns_null_prev
2658 // no need to add column into the valuelist
2659 if (strlen($current_value_as_an_array) > 0) {
2660 $query_values[] = $current_value_as_an_array;
2661 // first inserted row so prepare the list of fields
2662 if (empty($value_sets)) {
2663 $query_fields[] = Util
::backquote(
2664 $multi_edit_columns_name[$key]
2668 } elseif (! empty($multi_edit_columns_null_prev[$key])
2669 && ! isset($multi_edit_columns_null[$key])
2673 // field had the null checkbox before the update
2674 // field no longer has the null checkbox
2676 = Util
::backquote($multi_edit_columns_name[$key])
2677 . ' = ' . $current_value_as_an_array;
2678 } elseif (! (empty($multi_edit_funcs[$key])
2679 && isset($multi_edit_columns_prev[$key])
2680 && (("'" . $this->dbi
->escapeString($multi_edit_columns_prev[$key]) . "'" === $current_value)
2681 ||
('0x' . $multi_edit_columns_prev[$key] === $current_value)))
2682 && ! empty($current_value)
2684 // avoid setting a field to NULL when it's already NULL
2685 // (field had the null checkbox before the update
2686 // field still has the null checkbox)
2687 if (empty($multi_edit_columns_null_prev[$key])
2688 ||
empty($multi_edit_columns_null[$key])
2691 = Util
::backquote($multi_edit_columns_name[$key])
2692 . ' = ' . $current_value_as_an_array;
2702 * Get the current column value in the form for different data types
2704 * @param string|false $possibly_uploaded_val uploaded file content
2705 * @param string $key an md5 of the column name
2706 * @param array|null $multi_edit_columns_type array of multi edit column types
2707 * @param string $current_value current column value in the form
2708 * @param array|null $multi_edit_auto_increment multi edit auto increment
2709 * @param integer $rownumber index of where clause array
2710 * @param array $multi_edit_columns_name multi edit column names array
2711 * @param array $multi_edit_columns_null multi edit columns null array
2712 * @param array $multi_edit_columns_null_prev multi edit columns previous null
2713 * @param boolean $is_insert whether insert or not
2714 * @param boolean $using_key whether editing or new row
2715 * @param string $where_clause where clause
2716 * @param string $table table name
2717 * @param array $multi_edit_funcs multiple edit functions array
2719 * @return string current column value in the form
2721 public function getCurrentValueForDifferentTypes(
2722 $possibly_uploaded_val,
2724 ?
array $multi_edit_columns_type,
2726 ?
array $multi_edit_auto_increment,
2728 $multi_edit_columns_name,
2729 $multi_edit_columns_null,
2730 $multi_edit_columns_null_prev,
2737 // Fetch the current values of a row to use in case we have a protected field
2739 && $using_key && isset($multi_edit_columns_type)
2740 && is_array($multi_edit_columns_type) && ! empty($where_clause)
2742 $protected_row = $this->dbi
->fetchSingleRow(
2743 'SELECT * FROM ' . Util
::backquote($table)
2744 . ' WHERE ' . $where_clause . ';'
2748 if (false !== $possibly_uploaded_val) {
2749 $current_value = $possibly_uploaded_val;
2750 } elseif (! empty($multi_edit_funcs[$key])) {
2751 $current_value = "'" . $this->dbi
->escapeString($current_value)
2754 // c o l u m n v a l u e i n t h e f o r m
2755 if (isset($multi_edit_columns_type[$key])) {
2756 $type = $multi_edit_columns_type[$key];
2761 if ($type != 'protected' && $type != 'set' && strlen($current_value) === 0) {
2762 // best way to avoid problems in strict mode
2763 // (works also in non-strict mode)
2764 if (isset($multi_edit_auto_increment, $multi_edit_auto_increment[$key])) {
2765 $current_value = 'NULL';
2767 $current_value = "''";
2769 } elseif ($type == 'set') {
2770 if (! empty($_POST['fields']['multi_edit'][$rownumber][$key])) {
2771 $current_value = implode(
2773 $_POST['fields']['multi_edit'][$rownumber][$key]
2775 $current_value = "'"
2776 . $this->dbi
->escapeString($current_value) . "'";
2778 $current_value = "''";
2780 } elseif ($type == 'protected') {
2781 // here we are in protected mode (asked in the config)
2782 // so tbl_change has put this special value in the
2783 // columns array, so we do not change the column value
2784 // but we can still handle column upload
2786 // when in UPDATE mode, do not alter field's contents. When in INSERT
2787 // mode, insert empty field because no values were submitted.
2788 // If protected blobs where set, insert original fields content.
2789 if (! empty($protected_row[$multi_edit_columns_name[$key]])) {
2790 $current_value = '0x'
2791 . bin2hex($protected_row[$multi_edit_columns_name[$key]]);
2793 $current_value = '';
2795 } elseif ($type === 'hex') {
2796 if (substr($current_value, 0, 2) != '0x') {
2797 $current_value = '0x' . $current_value;
2799 } elseif ($type == 'bit') {
2800 $current_value = preg_replace('/[^01]/', '0', $current_value);
2801 $current_value = "b'" . $this->dbi
->escapeString($current_value)
2803 } elseif (! ($type == 'datetime' ||
$type == 'timestamp')
2804 ||
($current_value != 'CURRENT_TIMESTAMP'
2805 && $current_value != 'current_timestamp()')
2807 $current_value = "'" . $this->dbi
->escapeString($current_value)
2811 // Was the Null checkbox checked for this field?
2812 // (if there is a value, we ignore the Null checkbox: this could
2813 // be possible if Javascript is disabled in the browser)
2814 if (! empty($multi_edit_columns_null[$key])
2815 && ($current_value == "''" ||
$current_value == '')
2817 $current_value = 'NULL';
2820 // The Null checkbox was unchecked for this field
2821 if (empty($current_value)
2822 && ! empty($multi_edit_columns_null_prev[$key])
2823 && ! isset($multi_edit_columns_null[$key])
2825 $current_value = "''";
2827 } // end else (column value in the form)
2828 return $current_value;
2832 * Check whether inline edited value can be truncated or not,
2833 * and add additional parameters for extra_data array if needed
2835 * @param string $db Database name
2836 * @param string $table Table name
2837 * @param string $column_name Column name
2838 * @param array $extra_data Extra data for ajax response
2842 public function verifyWhetherValueCanBeTruncatedAndAppendExtraData(
2848 $extra_data['isNeedToRecheck'] = false;
2850 $sql_for_real_value = 'SELECT ' . Util
::backquote($table) . '.'
2851 . Util
::backquote($column_name)
2852 . ' FROM ' . Util
::backquote($db) . '.'
2853 . Util
::backquote($table)
2854 . ' WHERE ' . $_POST['where_clause'][0];
2856 $result = $this->dbi
->tryQuery($sql_for_real_value);
2857 $fields_meta = $this->dbi
->getFieldsMeta($result);
2858 $meta = $fields_meta[0];
2859 if ($row = $this->dbi
->fetchRow($result)) {
2860 $new_value = $row[0];
2861 if ((substr($meta->type
, 0, 9) == 'timestamp')
2862 ||
($meta->type
== 'datetime')
2863 ||
($meta->type
== 'time')
2865 $new_value = Util
::addMicroseconds($new_value);
2866 } elseif (mb_strpos($meta->flags
, 'binary') !== false) {
2867 $new_value = '0x' . bin2hex($new_value);
2869 $extra_data['isNeedToRecheck'] = true;
2870 $extra_data['truncatableFieldValue'] = $new_value;
2872 $this->dbi
->freeResult($result);
2876 * Function to get the columns of a table
2878 * @param string $db current db
2879 * @param string $table current table
2883 public function getTableColumns($db, $table)
2885 $this->dbi
->selectDb($db);
2886 return array_values($this->dbi
->getColumns($db, $table, null, true));
2890 * Function to determine Insert/Edit rows
2892 * @param string $where_clause where clause
2893 * @param string $db current database
2894 * @param string $table current table
2898 public function determineInsertOrEdit($where_clause, $db, $table)
2900 if (isset($_POST['where_clause'])) {
2901 $where_clause = $_POST['where_clause'];
2903 if (isset($_SESSION['edit_next'])) {
2904 $where_clause = $_SESSION['edit_next'];
2905 unset($_SESSION['edit_next']);
2906 $after_insert = 'edit_next';
2908 if (isset($_POST['ShowFunctionFields'])) {
2909 $GLOBALS['cfg']['ShowFunctionFields'] = $_POST['ShowFunctionFields'];
2911 if (isset($_POST['ShowFieldTypesInDataEditView'])) {
2912 $GLOBALS['cfg']['ShowFieldTypesInDataEditView']
2913 = $_POST['ShowFieldTypesInDataEditView'];
2915 if (isset($_POST['after_insert'])) {
2916 $after_insert = $_POST['after_insert'];
2919 if (isset($where_clause)) {
2921 $insert_mode = false;
2922 $where_clause_array = $this->getWhereClauseArray($where_clause);
2923 list($where_clauses, $result, $rows, $found_unique_key)
2924 = $this->analyzeWhereClauses(
2925 $where_clause_array,
2931 $insert_mode = true;
2932 $where_clause = null;
2933 list($result, $rows) = $this->loadFirstRow($table, $db);
2934 $where_clauses = null;
2935 $where_clause_array = [];
2936 $found_unique_key = false;
2939 // Copying a row - fetched data will be inserted as a new row,
2940 // therefore the where clause is needless.
2941 if (isset($_POST['default_action'])
2942 && $_POST['default_action'] === 'insert'
2944 $where_clause = $where_clauses = null;
2950 $where_clause_array,
2955 isset($after_insert) ?
$after_insert : null,
2960 * Function to get comments for the table columns
2962 * @param string $db current database
2963 * @param string $table current table
2965 * @return array comments for columns
2967 public function getCommentsMap($db, $table)
2971 if ($GLOBALS['cfg']['ShowPropertyComments']) {
2972 $comments_map = $this->relation
->getComments($db, $table);
2975 return $comments_map;
2979 * Function to get URL parameters
2981 * @param string $db current database
2982 * @param string $table current table
2984 * @return array url parameters
2986 public function getUrlParameters($db, $table)
2990 * @todo check if we could replace by "db_|tbl_" - please clarify!?
2994 'sql_query' => $_POST['sql_query'],
2997 if (0 === strpos($goto, "tbl_")) {
2998 $url_params['table'] = $table;
3005 * Function to get html for the gis editor div
3009 public function getHtmlForGisEditor()
3011 return '<div id="gis_editor"></div>'
3012 . '<div id="popup_background"></div>'
3017 * Function to get html for the ignore option in insert mode
3019 * @param int $row_id row id
3020 * @param bool $checked ignore option is checked or not
3024 public function getHtmlForIgnoreOption($row_id, $checked = true)
3026 return '<input type="checkbox"'
3027 . ($checked ?
' checked="checked"' : '')
3028 . ' name="insert_ignore_' . $row_id . '"'
3029 . ' id="insert_ignore_' . $row_id . '">'
3030 . '<label for="insert_ignore_' . $row_id . '">'
3032 . '</label><br>' . "\n";
3036 * Function to get html for the function option
3038 * @param array $column column
3039 * @param string $column_name_appendix column name appendix
3043 private function getHtmlForFunctionOption(array $column, $column_name_appendix)
3045 return '<tr class="noclick">'
3048 . $column['Field_title']
3049 . '<input type="hidden" name="fields_name' . $column_name_appendix
3050 . '" value="' . $column['Field_html'] . '">'
3055 * Function to get html for the column type
3057 * @param array $column column
3061 private function getHtmlForInsertEditColumnType(array $column)
3063 return '<td class="center' . $column['wrap'] . '">'
3064 . '<span class="column_type" dir="ltr">' . $column['pma_type'] . '</span>'
3069 * Function to get html for the insert edit form header
3071 * @param bool $has_blob_field whether has blob field
3072 * @param bool $is_upload whether is upload
3076 public function getHtmlForInsertEditFormHeader($has_blob_field, $is_upload)
3078 $html_output = '<form id="insertForm" class="lock-page ';
3079 if ($has_blob_field && $is_upload) {
3080 $html_output .= 'disableAjax';
3082 $html_output .= '" method="post" action="tbl_replace.php" name="insertForm" ';
3084 $html_output .= ' enctype="multipart/form-data"';
3086 $html_output .= '>';
3088 return $html_output;
3092 * Function to get html for each insert/edit column
3094 * @param array $table_columns table columns
3095 * @param int $column_number column index in table_columns
3096 * @param array $comments_map comments map
3097 * @param bool $timestamp_seen whether timestamp seen
3098 * @param array $current_result current result
3099 * @param string $chg_evt_handler javascript change event handler
3100 * @param string $jsvkey javascript validation key
3101 * @param string $vkey validation key
3102 * @param bool $insert_mode whether insert mode
3103 * @param array $current_row current row
3104 * @param int $o_rows row offset
3105 * @param int $tabindex tab index
3106 * @param int $columns_cnt columns count
3107 * @param bool $is_upload whether upload
3108 * @param int $tabindex_for_function tab index offset for function
3109 * @param array $foreigners foreigners
3110 * @param int $tabindex_for_null tab index offset for null
3111 * @param int $tabindex_for_value tab index offset for value
3112 * @param string $table table
3113 * @param string $db database
3114 * @param int $row_id row id
3115 * @param array $titles titles
3116 * @param int $biggest_max_file_size biggest max file size
3117 * @param string $default_char_editing default char editing mode which is stored
3118 * in the config.inc.php script
3119 * @param string $text_dir text direction
3120 * @param array $repopulate the data to be repopulated
3121 * @param array $column_mime the mime information of column
3122 * @param string $where_clause the where clause
3126 private function getHtmlForInsertEditFormColumn(
3127 array $table_columns,
3129 array $comments_map,
3141 $tabindex_for_function,
3144 $tabindex_for_value,
3149 $biggest_max_file_size,
3150 $default_char_editing,
3156 $column = $table_columns[$column_number];
3159 if (! isset($column['processed'])) {
3160 $column = $this->analyzeTableColumnsArray(
3167 if (! empty($repopulate) && ! empty($current_row)) {
3168 $current_row[$column['Field']] = $repopulate[$column['Field_md5']];
3172 $extracted_columnspec
3173 = Util
::extractColumnSpec($column['Type']);
3175 if (-1 === $column['len']) {
3176 $column['len'] = $this->dbi
->fieldLen(
3180 // length is unknown for geometry fields,
3181 // make enough space to edit very simple WKTs
3182 if (-1 === $column['len']) {
3183 $column['len'] = 30;
3186 //Call validation when the form submitted...
3187 $onChangeClause = $chg_evt_handler
3188 . "=\"return verificationsAfterFieldChange('"
3189 . Sanitize
::escapeJsString($column['Field_md5']) . "', '"
3190 . Sanitize
::escapeJsString($jsvkey) . "','" . $column['pma_type'] . "')\"";
3192 // Use an MD5 as an array index to avoid having special characters
3193 // in the name attribute (see bug #1746964 )
3194 $column_name_appendix = $vkey . '[' . $column['Field_md5'] . ']';
3196 if ($column['Type'] === 'datetime'
3197 && ! isset($column['Default'])
3198 && $column['Default'] !== null
3201 $column['Default'] = date('Y-m-d H:i:s', time());
3204 $html_output = $this->getHtmlForFunctionOption(
3206 $column_name_appendix
3209 if ($GLOBALS['cfg']['ShowFieldTypesInDataEditView']) {
3210 $html_output .= $this->getHtmlForInsertEditColumnType($column);
3213 // Get a list of GIS data types.
3214 $gis_data_types = Util
::getGISDatatypes();
3216 // Prepares the field value
3217 $real_null_value = false;
3218 $special_chars_encoded = '';
3219 if (! empty($current_row)) {
3222 $real_null_value, $special_chars_encoded, $special_chars,
3223 $data, $backup_field
3225 = $this->getSpecialCharsAndBackupFieldForExistingRow(
3228 $extracted_columnspec,
3231 $column_name_appendix,
3235 // (we are inserting)
3236 // display default values
3238 if (isset($repopulate[$column['Field_md5']])) {
3239 $tmp['Default'] = $repopulate[$column['Field_md5']];
3241 list($real_null_value, $data, $special_chars, $backup_field,
3242 $special_chars_encoded
3244 = $this->getSpecialCharsAndBackupFieldForInsertingMode(
3251 $idindex = ($o_rows * $columns_cnt) +
$column_number +
1;
3252 $tabindex = $idindex;
3254 // Get a list of data types that are not yet supported.
3255 $no_support_types = Util
::unsupportedDatatypes();
3257 // The function column
3258 // -------------------
3259 $foreignData = $this->relation
->getForeignData(
3266 if ($GLOBALS['cfg']['ShowFunctionFields']) {
3267 $html_output .= $this->getFunctionColumn(
3270 $column_name_appendix,
3273 $tabindex_for_function,
3284 $html_output .= $this->getNullColumn(
3286 $column_name_appendix,
3297 // The value column (depends on type)
3299 // See bug #1667887 for the reason why we don't use the maxlength
3302 //add data attributes "no of decimals" and "data type"
3304 $type = current(explode("(", $column['pma_type']));
3305 if (preg_match('/\(([^()]+)\)/', $column['pma_type'], $match)) {
3306 $match[0] = trim($match[0], '()');
3307 $no_decimals = $match[0];
3309 $html_output .= '<td data-type="' . $type . '" data-decimals="'
3310 . $no_decimals . '">' . "\n";
3311 // Will be used by js/table/change.js to set the default value
3312 // for the "Continue insertion" feature
3313 $html_output .= '<span class="default_value hide">'
3314 . $special_chars . '</span>';
3316 // Check input transformation of column
3317 $transformed_html = '';
3318 if (! empty($column_mime['input_transformation'])) {
3319 $file = $column_mime['input_transformation'];
3320 $include_file = 'libraries/classes/Plugins/Transformations/' . $file;
3321 if (is_file($include_file)) {
3322 $class_name = $this->transformations
->getClassName($include_file);
3323 if (class_exists($class_name)) {
3324 $transformation_plugin = new $class_name();
3325 $transformation_options = $this->transformations
->getOptions(
3326 $column_mime['input_transformation_options']
3331 'transform_key' => $column['Field'],
3332 'where_clause' => $where_clause,
3334 $transformation_options['wrapper_link']
3335 = Url
::getCommon($_url_params);
3336 $current_value = '';
3337 if (isset($current_row[$column['Field']])) {
3338 $current_value = $current_row[$column['Field']];
3340 if (method_exists($transformation_plugin, 'getInputHtml')) {
3341 $transformed_html = $transformation_plugin->getInputHtml(
3344 $column_name_appendix,
3345 $transformation_options,
3349 $tabindex_for_value,
3353 if (method_exists($transformation_plugin, 'getScripts')) {
3354 $GLOBALS['plugin_scripts'] = array_merge(
3355 $GLOBALS['plugin_scripts'],
3356 $transformation_plugin->getScripts()
3362 if (! empty($transformed_html)) {
3363 $html_output .= $transformed_html;
3365 $html_output .= $this->getValueColumn(
3368 $column_name_appendix,
3371 $tabindex_for_value,
3383 $special_chars_encoded,
3386 $biggest_max_file_size,
3387 $default_char_editing,
3390 $extracted_columnspec,
3394 return $html_output;
3398 * Function to get html for each insert/edit row
3400 * @param array $url_params url parameters
3401 * @param array $table_columns table columns
3402 * @param array $comments_map comments map
3403 * @param bool $timestamp_seen whether timestamp seen
3404 * @param array $current_result current result
3405 * @param string $chg_evt_handler javascript change event handler
3406 * @param string $jsvkey javascript validation key
3407 * @param string $vkey validation key
3408 * @param bool $insert_mode whether insert mode
3409 * @param array $current_row current row
3410 * @param int $o_rows row offset
3411 * @param int $tabindex tab index
3412 * @param int $columns_cnt columns count
3413 * @param bool $is_upload whether upload
3414 * @param int $tabindex_for_function tab index offset for function
3415 * @param array $foreigners foreigners
3416 * @param int $tabindex_for_null tab index offset for null
3417 * @param int $tabindex_for_value tab index offset for value
3418 * @param string $table table
3419 * @param string $db database
3420 * @param int $row_id row id
3421 * @param array $titles titles
3422 * @param int $biggest_max_file_size biggest max file size
3423 * @param string $text_dir text direction
3424 * @param array $repopulate the data to be repopulated
3425 * @param array $where_clause_array the array of where clauses
3429 public function getHtmlForInsertEditRow(
3431 array $table_columns,
3432 array $comments_map,
3444 $tabindex_for_function,
3447 $tabindex_for_value,
3452 $biggest_max_file_size,
3455 array $where_clause_array
3457 $html_output = $this->getHeadAndFootOfInsertRowTable($url_params)
3460 //store the default value for CharEditing
3461 $default_char_editing = $GLOBALS['cfg']['CharEditing'];
3462 $mime_map = $this->transformations
->getMime($db, $table);
3464 if (isset($where_clause_array[$row_id])) {
3465 $where_clause = $where_clause_array[$row_id];
3467 for ($column_number = 0; $column_number < $columns_cnt; $column_number++
) {
3468 $table_column = $table_columns[$column_number];
3470 if (isset($mime_map[$table_column['Field']])) {
3471 $column_mime = $mime_map[$table_column['Field']];
3477 'VIRTUAL GENERATED',
3480 if (! in_array($table_column['Extra'], $virtual)) {
3481 $html_output .= $this->getHtmlForInsertEditFormColumn(
3496 $tabindex_for_function,
3499 $tabindex_for_value,
3504 $biggest_max_file_size,
3505 $default_char_editing,
3514 $html_output .= ' </tbody>'
3515 . '</table></div><br>'
3516 . '<div class="clearfloat"></div>';
3518 return $html_output;