libraries/tbl_columns_definition_form.inc.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  * Display form for changing/adding table fields/columns.
   5  * Included by tbl_addfield.php and tbl_create.php
   6  *
   7  * @package PhpMyAdmin
   8  */
   9
  10 use PhpMyAdmin\Di\Container;
  11 use PhpMyAdmin\Partition;
  12 use PhpMyAdmin\Relation;
  13 use PhpMyAdmin\Response;
  14 use PhpMyAdmin\Table;
  15 use PhpMyAdmin\Template;
  16 use PhpMyAdmin\Transformations;
  17 use PhpMyAdmin\Util;
  18
  19 if (!defined('PHPMYADMIN')) {
  20     exit;
  21 }
  22
  23 /**
  24  * Check parameters
  25  */
  26 Util::checkParameters(
  27     array('server', 'db', 'table', 'action', 'num_fields')
  28 );
  29
  30 global $db, $table;
  31
  32 $relation = new Relation();
  33
  34 /**
  35  * Initialize to avoid code execution path warnings
  36  */
  37
  38 if (!isset($num_fields)) {
  39     $num_fields = 0;
  40 }
  41 if (!isset($mime_map)) {
  42     $mime_map = null;
  43 }
  44 if (!isset($columnMeta)) {
  45     $columnMeta = array();
  46 }
  47
  48 $length_values_input_size = 8;
  49
  50 $content_cells = array();
  51
  52 /** @var string $db */
  53 $form_params = array(
  54     'db' => $db
  55 );
  56
  57 if ($action == 'tbl_create.php') {
  58     $form_params['reload'] = 1;
  59 } else {
  60     if ($action == 'tbl_addfield.php') {
  61         $form_params = array_merge(
  62             $form_params, array(
  63             'field_where' => Util::getValueByKey($_POST, 'field_where'))
  64         );
  65         if (isset($_POST['field_where'])) {
  66             $form_params['after_field'] = $_POST['after_field'];
  67         }
  68     }
  69     $form_params['table'] = $table;
  70 }
  71
  72 if (isset($num_fields)) {
  73     $form_params['orig_num_fields'] = $num_fields;
  74 }
  75
  76 $form_params = array_merge(
  77     $form_params,
  78     array(
  79         'orig_field_where' => Util::getValueByKey($_POST, 'field_where'),
  80         'orig_after_field' => Util::getValueByKey($_POST, 'after_field'),
  81     )
  82 );
  83
  84 if (isset($selected) && is_array($selected)) {
  85     foreach ($selected as $o_fld_nr => $o_fld_val) {
  86         $form_params['selected[' . $o_fld_nr . ']'] = $o_fld_val;
  87     }
  88 }
  89
  90 $is_backup = ($action != 'tbl_create.php' && $action != 'tbl_addfield.php');
  91
  92 $cfgRelation = $relation->getRelationsParam();
  93
  94 $comments_map = $relation->getComments($db, $table);
  95
  96 $move_columns = array();
  97 if (isset($fields_meta)) {
  98     /** @var PhpMyAdmin\DatabaseInterface $dbi */
  99     $dbi = Container::getDefaultContainer()->get('dbi');
 100     $move_columns = $dbi->getTable($db, $table)->getColumnsMeta();
 101 }
 102
 103 $available_mime = array();
 104 if ($cfgRelation['mimework'] && $GLOBALS['cfg']['BrowseMIME']) {
 105     $mime_map = Transformations::getMIME($db, $table);
 106     $available_mime = Transformations::getAvailableMIMEtypes();
 107 }
 108
 109 //  workaround for field_fulltext, because its submitted indices contain
 110 //  the index as a value, not a key. Inserted here for easier maintenance
 111 //  and less code to change in existing files.
 112 if (isset($field_fulltext) && is_array($field_fulltext)) {
 113     foreach ($field_fulltext as $fulltext_nr => $fulltext_indexkey) {
 114         $submit_fulltext[$fulltext_indexkey] = $fulltext_indexkey;
 115     }
 116 }
 117 if (isset($_POST['submit_num_fields'])
 118     || isset($_POST['submit_partition_change'])
 119 ) {
 120     //if adding new fields, set regenerate to keep the original values
 121     $regenerate = 1;
 122 }
 123
 124 $foreigners = $relation->getForeigners($db, $table, '', 'foreign');
 125 $child_references = null;
 126 // From MySQL 5.6.6 onwards columns with foreign keys can be renamed.
 127 // Hence, no need to get child references
 128 if ($GLOBALS['dbi']->getVersion() < 50606) {
 129     $child_references = $relation->getChildReferences($db, $table);
 130 }
 131
 132 for ($columnNumber = 0; $columnNumber < $num_fields; $columnNumber++) {
 133
 134     $type = '';
 135     $length = '';
 136     $columnMeta = array();
 137     $submit_attribute = null;
 138     $extracted_columnspec = array();
 139
 140     if (!empty($regenerate)) {
 141
 142         $columnMeta = array_merge(
 143             $columnMeta,
 144             array(
 145                 'Field'        => Util::getValueByKey(
 146                     $_POST, "field_name.${columnNumber}", false
 147                 ),
 148                 'Type'         => Util::getValueByKey(
 149                     $_POST, "field_type.${columnNumber}", false
 150                 ),
 151                 'Collation'    => Util::getValueByKey(
 152                     $_POST, "field_collation.${columnNumber}", ''
 153                 ),
 154                 'Null'         => Util::getValueByKey(
 155                     $_POST, "field_null.${columnNumber}", ''
 156                 ),
 157                 'DefaultType'  => Util::getValueByKey(
 158                     $_POST, "field_default_type.${columnNumber}", 'NONE'
 159                 ),
 160                 'DefaultValue' => Util::getValueByKey(
 161                     $_POST, "field_default_value.${columnNumber}", ''
 162                 ),
 163                 'Extra'        => Util::getValueByKey(
 164                     $_POST, "field_extra.${columnNumber}", false
 165                 ),
 166                 'Virtuality'   => Util::getValueByKey(
 167                     $_POST, "field_virtuality.${columnNumber}", ''
 168                 ),
 169                 'Expression'   => Util::getValueByKey(
 170                     $_POST, "field_expression.${columnNumber}", ''
 171                 ),
 172             )
 173         );
 174
 175         $columnMeta['Key'] = '';
 176         $parts = explode(
 177             '_', Util::getValueByKey($_POST, "field_key.${columnNumber}", ''), 2
 178         );
 179         if (count($parts) == 2 && $parts[1] == $columnNumber) {
 180             $columnMeta['Key'] = Util::getValueByKey(
 181                 array(
 182                     'primary' => 'PRI',
 183                     'index' => 'MUL',
 184                     'unique' => 'UNI',
 185                     'fulltext' => 'FULLTEXT',
 186                     'spatial' => 'SPATIAL'
 187                 ),
 188                 $parts[0], ''
 189             );
 190         }
 191
 192         $columnMeta['Comment']
 193             = isset($submit_fulltext[$columnNumber])
 194             && ($submit_fulltext[$columnNumber] == $columnNumber)
 195                 ? 'FULLTEXT' : false;
 196
 197         switch ($columnMeta['DefaultType']) {
 198         case 'NONE':
 199             $columnMeta['Default'] = null;
 200             break;
 201         case 'USER_DEFINED':
 202             $columnMeta['Default'] = $columnMeta['DefaultValue'];
 203             break;
 204         case 'NULL':
 205         case 'CURRENT_TIMESTAMP':
 206         case 'current_timestamp()':
 207             $columnMeta['Default'] = $columnMeta['DefaultType'];
 208             break;
 209         }
 210
 211         $length = Util::getValueByKey($_POST, "field_length.${columnNumber}", $length);
 212         $submit_attribute = Util::getValueByKey(
 213             $_POST, "field_attribute.${columnNumber}", false
 214         );
 215         $comments_map[$columnMeta['Field']] = Util::getValueByKey(
 216             $_POST, "field_comments.${columnNumber}"
 217         );
 218
 219         $mime_map[$columnMeta['Field']] = array_merge(
 220             isset($mime_map[$columnMeta['Field']]) ? $mime_map[$columnMeta['Field']] : [],
 221             array(
 222                 'mimetype' => Util::getValueByKey($_POST, "field_mimetype.${$columnNumber}"),
 223                 'transformation' => Util::getValueByKey(
 224                     $_POST, "field_transformation.${$columnNumber}"
 225                 ),
 226                 'transformation_options' => Util::getValueByKey(
 227                     $_POST, "field_transformation_options.${$columnNumber}"
 228                 ),
 229             )
 230         );
 231
 232     } elseif (isset($fields_meta[$columnNumber])) {
 233         $columnMeta = $fields_meta[$columnNumber];
 234         $virtual = array(
 235             'VIRTUAL', 'PERSISTENT', 'VIRTUAL GENERATED', 'STORED GENERATED'
 236         );
 237         if (in_array($columnMeta['Extra'], $virtual)) {
 238             $tableObj = new Table($GLOBALS['table'], $GLOBALS['db']);
 239             $expressions = $tableObj->getColumnGenerationExpression(
 240                 $columnMeta['Field']
 241             );
 242             $columnMeta['Expression'] = $expressions[$columnMeta['Field']];
 243         }
 244         switch ($columnMeta['Default']) {
 245         case null:
 246             if (is_null($columnMeta['Default'])) { // null
 247                 if ($columnMeta['Null'] == 'YES') {
 248                     $columnMeta['DefaultType'] = 'NULL';
 249                     $columnMeta['DefaultValue'] = '';
 250                 } else {
 251                     $columnMeta['DefaultType'] = 'NONE';
 252                     $columnMeta['DefaultValue'] = '';
 253                 }
 254             } else { // empty
 255                 $columnMeta['DefaultType'] = 'USER_DEFINED';
 256                 $columnMeta['DefaultValue'] = $columnMeta['Default'];
 257             }
 258             break;
 259         case 'CURRENT_TIMESTAMP':
 260         case 'current_timestamp()':
 261             $columnMeta['DefaultType'] = 'CURRENT_TIMESTAMP';
 262             $columnMeta['DefaultValue'] = '';
 263             break;
 264         default:
 265             $columnMeta['DefaultType'] = 'USER_DEFINED';
 266
 267             if ('text' === substr($columnMeta['Type'], -4)) {
 268                 $textDefault = substr($columnMeta['Default'], 1, -1);
 269                 $columnMeta['Default'] = stripcslashes($textDefault !== false ? $textDefault : $columnMeta['Default']);
 270             }
 271
 272             $columnMeta['DefaultValue'] = $columnMeta['Default'];
 273             break;
 274         }
 275     }
 276
 277     if (isset($columnMeta['Type'])) {
 278         $extracted_columnspec = Util::extractColumnSpec(
 279             $columnMeta['Type']
 280         );
 281         if ($extracted_columnspec['type'] == 'bit') {
 282             $columnMeta['Default']
 283                 = Util::convertBitDefaultValue($columnMeta['Default']);
 284         }
 285         $type = $extracted_columnspec['type'];
 286         if ($length == '') {
 287             $length = $extracted_columnspec['spec_in_brackets'];
 288         }
 289     } else {
 290         // creating a column
 291         $columnMeta['Type'] = '';
 292     }
 293
 294     // Variable tell if current column is bound in a foreign key constraint or not.
 295     // MySQL version from 5.6.6 allow renaming columns with foreign keys
 296     if (isset($columnMeta['Field'])
 297         && isset($form_params['table'])
 298         && $GLOBALS['dbi']->getVersion() < 50606
 299     ) {
 300         $columnMeta['column_status'] = $relation->checkChildForeignReferences(
 301             $form_params['db'],
 302             $form_params['table'],
 303             $columnMeta['Field'],
 304             $foreigners,
 305             $child_references
 306         );
 307     }
 308
 309     // some types, for example longtext, are reported as
 310     // "longtext character set latin7" when their charset and / or collation
 311     // differs from the ones of the corresponding database.
 312     // rtrim the type, for cases like "float unsigned"
 313     $type = rtrim(
 314         preg_replace('/[\s]character set[\s][\S]+/', '', $type)
 315     );
 316
 317     /**
 318      * old column attributes
 319      */
 320     if ($is_backup) {
 321
 322         // old column name
 323         if (isset($columnMeta['Field'])) {
 324             $form_params['field_orig[' . $columnNumber . ']']
 325                 = $columnMeta['Field'];
 326             if (isset($columnMeta['column_status'])
 327                 && !$columnMeta['column_status']['isEditable']
 328             ) {
 329                 $form_params['field_name[' . $columnNumber . ']']
 330                     = $columnMeta['Field'];
 331             }
 332         } else {
 333             $form_params['field_orig[' . $columnNumber . ']'] = '';
 334         }
 335
 336         // old column type
 337         if (isset($columnMeta['Type'])) {
 338             // keep in uppercase because the new type will be in uppercase
 339             $form_params['field_type_orig[' . $columnNumber . ']'] = mb_strtoupper($type);
 340             if (isset($columnMeta['column_status'])
 341                 && !$columnMeta['column_status']['isEditable']
 342             ) {
 343                 $form_params['field_type[' . $columnNumber . ']'] = mb_strtoupper($type);
 344             }
 345         } else {
 346             $form_params['field_type_orig[' . $columnNumber . ']'] = '';
 347         }
 348
 349         // old column length
 350         $form_params['field_length_orig[' . $columnNumber . ']'] = $length;
 351
 352         // old column default
 353         $form_params = array_merge(
 354             $form_params,
 355             array(
 356                 "field_default_value_orig[${columnNumber}]" => Util::getValueByKey(
 357                     $columnMeta, 'Default', ''
 358                 ),
 359                 "field_default_type_orig[${columnNumber}]"  => Util::getValueByKey(
 360                     $columnMeta, 'DefaultType', ''
 361                 ),
 362                 "field_collation_orig[${columnNumber}]"     => Util::getValueByKey(
 363                     $columnMeta, 'Collation', ''
 364                 ),
 365                 "field_attribute_orig[${columnNumber}]"     => trim(
 366                     Util::getValueByKey($extracted_columnspec, 'attribute', '')
 367                 ),
 368                 "field_null_orig[${columnNumber}]"          => Util::getValueByKey(
 369                     $columnMeta, 'Null', ''
 370                 ),
 371                 "field_extra_orig[${columnNumber}]"         => Util::getValueByKey(
 372                     $columnMeta, 'Extra', ''
 373                 ),
 374                 "field_comments_orig[${columnNumber}]"      => Util::getValueByKey(
 375                     $columnMeta, 'Comment', ''
 376                 ),
 377                 "field_virtuality_orig[${columnNumber}]"    => Util::getValueByKey(
 378                     $columnMeta, 'Virtuality', ''
 379                 ),
 380                 "field_expression_orig[${columnNumber}]"    => Util::getValueByKey(
 381                     $columnMeta, 'Expression', ''
 382                 ),
 383             )
 384         );
 385     }
 386
 387     $content_cells[$columnNumber] = array(
 388         'column_number' => $columnNumber,
 389         'column_meta' => $columnMeta,
 390         'type_upper' => mb_strtoupper($type),
 391         'length_values_input_size' => $length_values_input_size,
 392         'length' => $length,
 393         'extracted_columnspec' => $extracted_columnspec,
 394         'submit_attribute' => $submit_attribute,
 395         'comments_map' => $comments_map,
 396         'fields_meta' => isset($fields_meta) ? $fields_meta : null,
 397         'is_backup' => $is_backup,
 398         'move_columns' => $move_columns,
 399         'cfg_relation' => $cfgRelation,
 400         'available_mime' => $available_mime,
 401         'mime_map' => isset($mime_map) ? $mime_map : array()
 402     );
 403 } // end for
 404
 405 include 'libraries/tbl_partition_definition.inc.php';
 406 $html = Template::get('columns_definitions/column_definitions_form')->render([
 407     'is_backup' => $is_backup,
 408     'fields_meta' => isset($fields_meta) ? $fields_meta : null,
 409     'mimework' => $cfgRelation['mimework'],
 410     'action' => $action,
 411     'form_params' => $form_params,
 412     'content_cells' => $content_cells,
 413     'partition_details' => $partitionDetails,
 414     'primary_indexes' => isset($_POST['primary_indexes']) ? $_POST['primary_indexes'] : null,
 415     'unique_indexes' => isset($_POST['unique_indexes']) ? $_POST['unique_indexes'] : null,
 416     'indexes' => isset($_POST['indexes']) ? $_POST['indexes'] : null,
 417     'fulltext_indexes' => isset($_POST['fulltext_indexes']) ? $_POST['fulltext_indexes'] : null,
 418     'spatial_indexes' => isset($_POST['spatial_indexes']) ? $_POST['spatial_indexes'] : null,
 419     'table' => isset($_POST['table']) ? $_POST['table'] : null,
 420     'comment' => isset($_POST['comment']) ? $_POST['comment'] : null,
 421     'tbl_collation' => isset($_POST['tbl_collation']) ? $_POST['tbl_collation'] : null,
 422     'tbl_storage_engine' => isset($_POST['tbl_storage_engine']) ? $_POST['tbl_storage_engine'] : null,
 423     'connection' => isset($_POST['connection']) ? $_POST['connection'] : null,
 424     'change_column' => isset($_POST['change_column']) ? $_POST['change_column'] : null,
 425     'is_virtual_columns_supported' => Util::isVirtualColumnsSupported(),
 426     'browse_mime' => isset($GLOBALS['cfg']['BrowseMIME']) ? $GLOBALS['cfg']['BrowseMIME'] : null,
 427     'server_type' => Util::getServerType(),
 428     'max_rows' => intval($GLOBALS['cfg']['MaxRows']),
 429     'char_editing' => isset($GLOBALS['cfg']['CharEditing']) ? $GLOBALS['cfg']['CharEditing'] : null,
 430     'attribute_types' => $GLOBALS['dbi']->types->getAttributes(),
 431     'privs_available' => ((isset($GLOBALS['col_priv']) ? $GLOBALS['col_priv'] : false)
 432         && (isset($GLOBALS['is_reload_priv']) ? $GLOBALS['is_reload_priv'] : false)
 433     ),
 434     'max_length' => $GLOBALS['dbi']->getVersion() >= 50503 ? 1024 : 255,
 435     'have_partitioning' => Partition::havePartitioning(),
 436     'dbi' => $GLOBALS['dbi'],
 437     'disable_is' => $GLOBALS['cfg']['Server']['DisableIS'],
 438 ]);
 439
 440 unset($form_params);
 441
 442 $response = Response::getInstance();
 443 $response->getHeader()->getScripts()->addFiles(
 444     array(
 445         'vendor/jquery/jquery.uitablefilter.js',
 446         'indexes.js'
 447     )
 448 );
 449 $response->addHTML($html);