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