libraries/Table.class.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  *
   5  * @package PhpMyAdmin
   6  */
   7
   8 /**
   9  * @todo make use of PMA_Message and PMA_Error
  10  * @package PhpMyAdmin
  11  */
  12 class PMA_Table
  13 {
  14     /**
  15      * UI preferences properties
  16      */
  17     const PROP_SORTED_COLUMN = 'sorted_col';
  18     const PROP_COLUMN_ORDER = 'col_order';
  19     const PROP_COLUMN_VISIB = 'col_visib';
  20
  21     static $cache = array();
  22
  23     /**
  24      * @var string  table name
  25      */
  26     var $name = '';
  27
  28     /**
  29      * @var string  database name
  30      */
  31     var $db_name = '';
  32
  33     /**
  34      * @var string  engine (innodb, myisam, bdb, ...)
  35      */
  36     var $engine = '';
  37
  38     /**
  39      * @var string  type (view, base table, system view)
  40      */
  41     var $type = '';
  42
  43     /**
  44      * @var array   settings
  45      */
  46     var $settings = array();
  47
  48     /**
  49      * @var array UI preferences
  50      */
  51     var $uiprefs;
  52
  53     /**
  54      * @var array errors occured
  55      */
  56     var $errors = array();
  57
  58     /**
  59      * @var array messages
  60      */
  61     var $messages = array();
  62
  63     /**
  64      * Constructor
  65      *
  66      * @param string $table_name table name
  67      * @param string $db_name    database name
  68      */
  69     function __construct($table_name, $db_name)
  70     {
  71         $this->setName($table_name);
  72         $this->setDbName($db_name);
  73     }
  74
  75     /**
  76      * returns table name
  77      *
  78      * @see PMA_Table::getName()
  79      * @return  string  table name
  80      */
  81     function __toString()
  82     {
  83         return $this->getName();
  84     }
  85
  86     /**
  87      * return the last error
  88      *
  89      * @return the last error
  90      */
  91     function getLastError()
  92     {
  93         return end($this->errors);
  94     }
  95
  96     /**
  97      * return the last message
  98      *
  99      * @return the last message
 100      */
 101     function getLastMessage()
 102     {
 103         return end($this->messages);
 104     }
 105
 106     /**
 107      * sets table name
 108      *
 109      * @param string $table_name new table name
 110      *
 111      * @return nothing
 112      */
 113     function setName($table_name)
 114     {
 115         $this->name = $table_name;
 116     }
 117
 118     /**
 119      * returns table name
 120      *
 121      * @param boolean $backquoted whether to quote name with backticks ``
 122      *
 123      * @return  string  table name
 124      */
 125     function getName($backquoted = false)
 126     {
 127         if ($backquoted) {
 128             return PMA_backquote($this->name);
 129         }
 130         return $this->name;
 131     }
 132
 133     /**
 134      * sets database name for this table
 135      *
 136      * @param string $db_name database name
 137      *
 138      * @return nothing
 139      */
 140     function setDbName($db_name)
 141     {
 142         $this->db_name = $db_name;
 143     }
 144
 145     /**
 146      * returns database name for this table
 147      *
 148      * @param boolean $backquoted whether to quote name with backticks ``
 149      *
 150      * @return  string  database name for this table
 151      */
 152     function getDbName($backquoted = false)
 153     {
 154         if ($backquoted) {
 155             return PMA_backquote($this->db_name);
 156         }
 157         return $this->db_name;
 158     }
 159
 160     /**
 161      * returns full name for table, including database name
 162      *
 163      * @param boolean $backquoted whether to quote name with backticks ``
 164      *
 165      * @return string
 166      */
 167     function getFullName($backquoted = false)
 168     {
 169         return $this->getDbName($backquoted) . '.' . $this->getName($backquoted);
 170     }
 171
 172     /**
 173      * returns whether the table is actually a view
 174      *
 175      * @param string $db    database
 176      * @param string $table table
 177      *
 178      * @return whether the given is a view
 179      */
 180     static public function isView($db = null, $table = null)
 181     {
 182         if (empty($db) || empty($table)) {
 183             return false;
 184         }
 185
 186         // use cached data or load information with SHOW command
 187         if (isset(PMA_Table::$cache[$db][$table]) || $GLOBALS['cfg']['Server']['DisableIS']) {
 188             $type = PMA_Table::sGetStatusInfo($db, $table, 'TABLE_TYPE');
 189             return $type == 'VIEW';
 190         }
 191
 192         // query information_schema
 193         $result = PMA_DBI_fetch_result(
 194             "SELECT TABLE_NAME
 195             FROM information_schema.VIEWS
 196             WHERE TABLE_SCHEMA = '" . PMA_sqlAddSlashes($db) . "'
 197                 AND TABLE_NAME = '" . PMA_sqlAddSlashes($table) . "'");
 198         return $result ? true : false;
 199     }
 200
 201     /**
 202      * sets given $value for given $param
 203      *
 204      * @param string $param name
 205      * @param mixed  $value value
 206      *
 207      * @return nothing
 208      */
 209     function set($param, $value)
 210     {
 211         $this->settings[$param] = $value;
 212     }
 213
 214     /**
 215      * returns value for given setting/param
 216      *
 217      * @param string $param name for value to return
 218      *
 219      * @return  mixed   value for $param
 220      */
 221     function get($param)
 222     {
 223         if (isset($this->settings[$param])) {
 224             return $this->settings[$param];
 225         }
 226
 227         return null;
 228     }
 229
 230     /**
 231      * loads structure data
 232      * (this function is work in progress? not yet used)
 233      *
 234      * @return boolean
 235      */
 236     function loadStructure()
 237     {
 238         $table_info = PMA_DBI_get_tables_full($this->getDbName(), $this->getName());
 239
 240         if (false === $table_info) {
 241             return false;
 242         }
 243
 244         $this->settings = $table_info;
 245
 246         if ($this->get('TABLE_ROWS') === null) {
 247             $this->set(
 248                 'TABLE_ROWS',
 249                 PMA_Table::countRecords($this->getDbName(), $this->getName(), true)
 250             );
 251         }
 252
 253         $create_options = explode(' ', $this->get('TABLE_ROWS'));
 254
 255         // export create options by its name as variables into gloabel namespace
 256         // f.e. pack_keys=1 becomes available as $pack_keys with value of '1'
 257         foreach ($create_options as $each_create_option) {
 258             $each_create_option = explode('=', $each_create_option);
 259             if (isset($each_create_option[1])) {
 260                 $this->set($$each_create_option[0], $each_create_option[1]);
 261             }
 262         }
 263         return true;
 264     }
 265
 266     /**
 267      * Checks if this is a merge table
 268      *
 269      * If the ENGINE of the table is MERGE or MRG_MYISAM (alias),
 270      * this is a merge table.
 271      *
 272      * @param string $db    the database name
 273      * @param string $table the table name
 274      *
 275      * @return  boolean  true if it is a merge table
 276      */
 277     static public function isMerge($db = null, $table = null)
 278     {
 279         $engine = null;
 280         // if called static, with parameters
 281         if (! empty($db) && ! empty($table)) {
 282             $engine = PMA_Table::sGetStatusInfo($db, $table, 'ENGINE', null, true);
 283         }
 284
 285         return (! empty($engine) && ((strtoupper($engine) == 'MERGE') || (strtoupper($engine) == 'MRG_MYISAM')));
 286     }
 287
 288     static public function sGetToolTip($db, $table)
 289     {
 290         return PMA_Table::sGetStatusInfo($db, $table, 'Comment')
 291             . ' (' . PMA_Table::countRecords($db, $table) . ')';
 292     }
 293
 294     /**
 295      * Returns full table status info, or specific if $info provided
 296      * this info is collected from information_schema
 297      *
 298      * @param string  $db            database name
 299      * @param string  $table         table name
 300      * @param string  $info
 301      * @param boolean $force_read    read new rather than serving from cache
 302      * @param boolean $disable_error if true, disables error message
 303      *
 304      * @todo PMA_DBI_get_tables_full needs to be merged somehow into this class
 305      * or at least better documented
 306      *
 307      * @return mixed
 308      */
 309     static public function sGetStatusInfo($db, $table, $info = null, $force_read = false, $disable_error = false)
 310     {
 311         if (! isset(PMA_Table::$cache[$db][$table]) || $force_read) {
 312             PMA_DBI_get_tables_full($db, $table);
 313         }
 314
 315         if (! isset(PMA_Table::$cache[$db][$table])) {
 316             // happens when we enter the table creation dialog
 317             // or when we really did not get any status info, for example
 318             // when $table == 'TABLE_NAMES' after the user tried SHOW TABLES
 319             return '';
 320         }
 321
 322         if (null === $info) {
 323             return PMA_Table::$cache[$db][$table];
 324         }
 325
 326         // array_key_exists allows for null values
 327         if (!array_key_exists($info, PMA_Table::$cache[$db][$table])) {
 328             if (! $disable_error) {
 329                 trigger_error(__('unknown table status: ') . $info, E_USER_WARNING);
 330             }
 331             return false;
 332         }
 333
 334         return PMA_Table::$cache[$db][$table][$info];
 335     }
 336
 337     /**
 338      * generates column specification for ALTER or CREATE TABLE syntax
 339      *
 340      * @param string      $name           name
 341      * @param string      $type           type ('INT', 'VARCHAR', 'BIT', ...)
 342      * @param string      $length         length ('2', '5,2', '', ...)
 343      * @param string      $attribute      attribute
 344      * @param string      $collation      collation
 345      * @param bool|string $null           with 'NULL' or 'NOT NULL'
 346      * @param string      $default_type   whether default is CURRENT_TIMESTAMP,
 347      *                                    NULL, NONE, USER_DEFINED
 348      * @param string      $default_value  default value for USER_DEFINED default type
 349      * @param string      $extra          'AUTO_INCREMENT'
 350      * @param string      $comment        field comment
 351      * @param array       &$field_primary list of fields for PRIMARY KEY
 352      * @param string      $index
 353      *
 354      * @todo    move into class PMA_Column
 355      * @todo on the interface, some js to clear the default value when the default
 356      * current_timestamp is checked
 357      *
 358      * @return  string  field specification
 359      */
 360     static function generateFieldSpec($name, $type, $length = '', $attribute = '',
 361         $collation = '', $null = false, $default_type = 'USER_DEFINED',
 362         $default_value = '', $extra = '', $comment = '',
 363         &$field_primary, $index)
 364     {
 365
 366         $is_timestamp = strpos(strtoupper($type), 'TIMESTAMP') !== false;
 367
 368         $query = PMA_backquote($name) . ' ' . $type;
 369
 370         if ($length != ''
 371             && !preg_match('@^(DATE|DATETIME|TIME|TINYBLOB|TINYTEXT|BLOB|TEXT|'
 372                 . 'MEDIUMBLOB|MEDIUMTEXT|LONGBLOB|LONGTEXT|SERIAL|BOOLEAN|UUID)$@i', $type)) {
 373             $query .= '(' . $length . ')';
 374         }
 375
 376         if ($attribute != '') {
 377             $query .= ' ' . $attribute;
 378         }
 379
 380         if (! empty($collation) && $collation != 'NULL'
 381             && preg_match('@^(TINYTEXT|TEXT|MEDIUMTEXT|LONGTEXT|VARCHAR|CHAR|ENUM|SET)$@i', $type)
 382         ) {
 383             $query .= PMA_generateCharsetQueryPart($collation);
 384         }
 385
 386         if ($null !== false) {
 387             if ($null == 'NULL') {
 388                 $query .= ' NULL';
 389             } else {
 390                 $query .= ' NOT NULL';
 391             }
 392         }
 393
 394         switch ($default_type) {
 395         case 'USER_DEFINED' :
 396             if ($is_timestamp && $default_value === '0') {
 397                 // a TIMESTAMP does not accept DEFAULT '0'
 398                 // but DEFAULT 0 works
 399                 $query .= ' DEFAULT 0';
 400             } elseif ($type == 'BIT') {
 401                 $query .= ' DEFAULT b\''
 402                         . preg_replace('/[^01]/', '0', $default_value)
 403                         . '\'';
 404             } elseif ($type == 'BOOLEAN') {
 405                 if (preg_match('/^1|T|TRUE|YES$/i', $default_value)) {
 406                     $query .= ' DEFAULT TRUE';
 407                 } elseif (preg_match('/^0|F|FALSE|NO$/i', $default_value)) {
 408                     $query .= ' DEFAULT FALSE';
 409                 } else {
 410                     // Invalid BOOLEAN value
 411                     $query .= ' DEFAULT \'' . PMA_sqlAddSlashes($default_value) . '\'';
 412                 }
 413             } else {
 414                 $query .= ' DEFAULT \'' . PMA_sqlAddSlashes($default_value) . '\'';
 415             }
 416             break;
 417         case 'NULL' :
 418         case 'CURRENT_TIMESTAMP' :
 419             $query .= ' DEFAULT ' . $default_type;
 420             break;
 421         case 'NONE' :
 422         default :
 423             break;
 424         }
 425
 426         if (!empty($extra)) {
 427             $query .= ' ' . $extra;
 428             // Force an auto_increment field to be part of the primary key
 429             // even if user did not tick the PK box;
 430             if ($extra == 'AUTO_INCREMENT') {
 431                 $primary_cnt = count($field_primary);
 432                 if (1 == $primary_cnt) {
 433                     for ($j = 0; $j < $primary_cnt; $j++) {
 434                         if ($field_primary[$j] == $index) {
 435                             break;
 436                         }
 437                     }
 438                     if (isset($field_primary[$j]) && $field_primary[$j] == $index) {
 439                         $query .= ' PRIMARY KEY';
 440                         unset($field_primary[$j]);
 441                     }
 442                 } else {
 443                     // but the PK could contain other columns so do not append
 444                     // a PRIMARY KEY clause, just add a member to $field_primary
 445                     $found_in_pk = false;
 446                     for ($j = 0; $j < $primary_cnt; $j++) {
 447                         if ($field_primary[$j] == $index) {
 448                             $found_in_pk = true;
 449                             break;
 450                         }
 451                     } // end for
 452                     if (! $found_in_pk) {
 453                         $field_primary[] = $index;
 454                     }
 455                 }
 456             } // end if (auto_increment)
 457         }
 458         if (!empty($comment)) {
 459             $query .= " COMMENT '" . PMA_sqlAddSlashes($comment) . "'";
 460         }
 461         return $query;
 462     } // end function
 463
 464     /**
 465      * Counts and returns (or displays) the number of records in a table
 466      *
 467      * Revision 13 July 2001: Patch for limiting dump size from
 468      * vinay@sanisoft.com & girish@sanisoft.com
 469      *
 470      * @param string $db          the current database name
 471      * @param string $table       the current table name
 472      * @param bool   $force_exact whether to force an exact count
 473      * @param bool   $is_view     whether the table is a view
 474      *
 475      * @return mixed the number of records if "retain" param is true,
 476      *               otherwise true
 477      */
 478     static public function countRecords($db, $table, $force_exact = false, $is_view = null)
 479     {
 480         if (isset(PMA_Table::$cache[$db][$table]['ExactRows'])) {
 481             $row_count = PMA_Table::$cache[$db][$table]['ExactRows'];
 482         } else {
 483             $row_count = false;
 484
 485             if (null === $is_view) {
 486                 $is_view = PMA_Table::isView($db, $table);
 487             }
 488
 489             if (! $force_exact) {
 490                 if (! isset(PMA_Table::$cache[$db][$table]['Rows']) && ! $is_view) {
 491                     $tmp_tables = PMA_DBI_get_tables_full($db, $table);
 492                     if (isset($tmp_tables[$table])) {
 493                         PMA_Table::$cache[$db][$table] = $tmp_tables[$table];
 494                     }
 495                 }
 496                 if (isset(PMA_Table::$cache[$db][$table]['Rows'])) {
 497                     $row_count = PMA_Table::$cache[$db][$table]['Rows'];
 498                 } else {
 499                     $row_count = false;
 500                 }
 501             }
 502
 503             // for a VIEW, $row_count is always false at this point
 504             if (false === $row_count || $row_count < $GLOBALS['cfg']['MaxExactCount']) {
 505                 // Make an exception for views in I_S and D_D schema in Drizzle, as these map to
 506                 // in-memory data and should execute fast enough
 507                 if (! $is_view || (PMA_DRIZZLE && PMA_is_system_schema($db))) {
 508                     $row_count = PMA_DBI_fetch_value(
 509                         'SELECT COUNT(*) FROM ' . PMA_backquote($db) . '.'
 510                         . PMA_backquote($table)
 511                     );
 512                 } else {
 513                     // For complex views, even trying to get a partial record
 514                     // count could bring down a server, so we offer an
 515                     // alternative: setting MaxExactCountViews to 0 will bypass
 516                     // completely the record counting for views
 517
 518                     if ($GLOBALS['cfg']['MaxExactCountViews'] == 0) {
 519                         $row_count = 0;
 520                     } else {
 521                         // Counting all rows of a VIEW could be too long, so use
 522                         // a LIMIT clause.
 523                         // Use try_query because it can fail (when a VIEW is
 524                         // based on a table that no longer exists)
 525                         $result = PMA_DBI_try_query(
 526                             'SELECT 1 FROM ' . PMA_backquote($db) . '.'
 527                             . PMA_backquote($table) . ' LIMIT '
 528                             . $GLOBALS['cfg']['MaxExactCountViews'],
 529                             null,
 530                             PMA_DBI_QUERY_STORE
 531                         );
 532                         if (!PMA_DBI_getError()) {
 533                             $row_count = PMA_DBI_num_rows($result);
 534                             PMA_DBI_free_result($result);
 535                         }
 536                     }
 537                 }
 538                 PMA_Table::$cache[$db][$table]['ExactRows'] = $row_count;
 539             }
 540         }
 541
 542         return $row_count;
 543     } // end of the 'PMA_Table::countRecords()' function
 544
 545     /**
 546      * Generates column specification for ALTER syntax
 547      *
 548      * @param string      $oldcol         old column name
 549      * @param string      $newcol         new column name
 550      * @param string      $type           type ('INT', 'VARCHAR', 'BIT', ...)
 551      * @param string      $length         length ('2', '5,2', '', ...)
 552      * @param string      $attribute      attribute
 553      * @param string      $collation      collation
 554      * @param bool|string $null           with 'NULL' or 'NOT NULL'
 555      * @param string      $default_type   whether default is CURRENT_TIMESTAMP,
 556      *                                    NULL, NONE, USER_DEFINED
 557      * @param string      $default_value  default value for USER_DEFINED default type
 558      * @param string      $extra          'AUTO_INCREMENT'
 559      * @param string      $comment        field comment
 560      * @param array       &$field_primary list of fields for PRIMARY KEY
 561      * @param string      $index
 562      * @param mixed       $default_orig
 563      *
 564      * @see PMA_Table::generateFieldSpec()
 565      *
 566      * @return  string  field specification
 567      */
 568     static public function generateAlter($oldcol, $newcol, $type, $length,
 569         $attribute, $collation, $null, $default_type, $default_value,
 570         $extra, $comment = '', &$field_primary, $index, $default_orig)
 571     {
 572         return PMA_backquote($oldcol) . ' '
 573             . PMA_Table::generateFieldSpec(
 574                 $newcol, $type, $length, $attribute,
 575                 $collation, $null, $default_type, $default_value, $extra,
 576                 $comment, $field_primary, $index, $default_orig
 577             );
 578     } // end function
 579
 580     /**
 581      * Inserts existing entries in a PMA_* table by reading a value from an old entry
 582      *
 583      * @param string $work         The array index, which Relation feature to check
 584      *                             ('relwork', 'commwork', ...)
 585      * @param string $pma_table    The array index, which PMA-table to update
 586      *                             ('bookmark', 'relation', ...)
 587      * @param array  $get_fields   Which fields will be SELECT'ed from the old entry
 588      * @param array  $where_fields Which fields will be used for the WHERE query
 589      *                             (array('FIELDNAME' => 'FIELDVALUE'))
 590      * @param array  $new_fields   Which fields will be used as new VALUES. These are
 591      *                             the important keys which differ from the old entry
 592      *                             (array('FIELDNAME' => 'NEW FIELDVALUE'))
 593      *
 594      * @global relation variable
 595      *
 596      * @return int|true
 597      */
 598     static public function duplicateInfo($work, $pma_table, $get_fields, $where_fields, $new_fields)
 599     {
 600         $last_id = -1;
 601
 602         if (isset($GLOBALS['cfgRelation']) && $GLOBALS['cfgRelation'][$work]) {
 603             $select_parts = array();
 604             $row_fields = array();
 605             foreach ($get_fields as $get_field) {
 606                 $select_parts[] = PMA_backquote($get_field);
 607                 $row_fields[$get_field] = 'cc';
 608             }
 609
 610             $where_parts = array();
 611             foreach ($where_fields as $_where => $_value) {
 612                 $where_parts[] = PMA_backquote($_where) . ' = \''
 613                     . PMA_sqlAddSlashes($_value) . '\'';
 614             }
 615
 616             $new_parts = array();
 617             $new_value_parts = array();
 618             foreach ($new_fields as $_where => $_value) {
 619                 $new_parts[] = PMA_backquote($_where);
 620                 $new_value_parts[] = PMA_sqlAddSlashes($_value);
 621             }
 622
 623             $table_copy_query = '
 624                 SELECT ' . implode(', ', $select_parts) . '
 625                   FROM ' . PMA_backquote($GLOBALS['cfgRelation']['db']) . '.'
 626                   . PMA_backquote($GLOBALS['cfgRelation'][$pma_table]) . '
 627                  WHERE ' . implode(' AND ', $where_parts);
 628
 629             // must use PMA_DBI_QUERY_STORE here, since we execute another
 630             // query inside the loop
 631             $table_copy_rs = PMA_query_as_controluser(
 632                 $table_copy_query, true, PMA_DBI_QUERY_STORE
 633             );
 634
 635             while ($table_copy_row = @PMA_DBI_fetch_assoc($table_copy_rs)) {
 636                 $value_parts = array();
 637                 foreach ($table_copy_row as $_key => $_val) {
 638                     if (isset($row_fields[$_key]) && $row_fields[$_key] == 'cc') {
 639                         $value_parts[] = PMA_sqlAddSlashes($_val);
 640                     }
 641                 }
 642
 643                 $new_table_query = 'INSERT IGNORE INTO '
 644                     . PMA_backquote($GLOBALS['cfgRelation']['db'])
 645                     . '.' . PMA_backquote($GLOBALS['cfgRelation'][$pma_table]) . '
 646                     (' . implode(', ', $select_parts) . ',
 647                      ' . implode(', ', $new_parts) . ')
 648                     VALUES
 649                     (\'' . implode('\', \'', $value_parts) . '\',
 650                      \'' . implode('\', \'', $new_value_parts) . '\')';
 651
 652                 PMA_query_as_controluser($new_table_query);
 653                 $last_id = PMA_DBI_insert_id();
 654             } // end while
 655
 656             PMA_DBI_free_result($table_copy_rs);
 657
 658             return $last_id;
 659         }
 660
 661         return true;
 662     } // end of 'PMA_Table::duplicateInfo()' function
 663
 664
 665     /**
 666      * Copies or renames table
 667      *
 668      * @param string $source_db    source database
 669      * @param string $source_table source table
 670      * @param string $target_db    target database
 671      * @param string $target_table target table
 672      * @param string $what         what to be moved or copied (data, dataonly)
 673      * @param bool   $move         whether to move
 674      * @param string $mode         mode
 675      *
 676      * @return bool true if success, false otherwise
 677      */
 678     static public function moveCopy($source_db, $source_table, $target_db, $target_table, $what, $move, $mode)
 679     {
 680         global $err_url;
 681
 682         /* Try moving table directly */
 683         if ($move && $what == 'data') {
 684             $tbl = new PMA_Table($source_table, $source_db);
 685             $result = $tbl->rename(
 686                 $target_table, $target_db,
 687                 PMA_Table::isView($source_db, $source_table)
 688             );
 689             if ($result) {
 690                 $GLOBALS['message'] = $tbl->getLastMessage();
 691                 return true;
 692             }
 693         }
 694
 695         // set export settings we need
 696         $GLOBALS['sql_backquotes'] = 1;
 697         $GLOBALS['asfile']         = 1;
 698
 699         // Ensure the target is valid
 700         if (! $GLOBALS['pma']->databases->exists($source_db, $target_db)) {
 701             if (! $GLOBALS['pma']->databases->exists($source_db)) {
 702                 $GLOBALS['message'] = PMA_Message::rawError(
 703                     'source database `' . htmlspecialchars($source_db) . '` not found'
 704                 );
 705             }
 706             if (! $GLOBALS['pma']->databases->exists($target_db)) {
 707                 $GLOBALS['message'] = PMA_Message::rawError(
 708                     'target database `' . htmlspecialchars($target_db) . '` not found'
 709                 );
 710             }
 711             return false;
 712         }
 713
 714         $source = PMA_backquote($source_db) . '.' . PMA_backquote($source_table);
 715         if (! isset($target_db) || ! strlen($target_db)) {
 716             $target_db = $source_db;
 717         }
 718
 719         // Doing a select_db could avoid some problems with replicated databases,
 720         // when moving table from replicated one to not replicated one
 721         PMA_DBI_select_db($target_db);
 722
 723         $target = PMA_backquote($target_db) . '.' . PMA_backquote($target_table);
 724
 725         // do not create the table if dataonly
 726         if ($what != 'dataonly') {
 727             include_once './libraries/export/sql.php';
 728
 729             $no_constraints_comments = true;
 730             $GLOBALS['sql_constraints_query'] = '';
 731
 732             $sql_structure = PMA_getTableDef(
 733                 $source_db, $source_table, "\n", $err_url, false, false
 734             );
 735             unset($no_constraints_comments);
 736             $parsed_sql =  PMA_SQP_parse($sql_structure);
 737             $analyzed_sql = PMA_SQP_analyze($parsed_sql);
 738             $i = 0;
 739             if (empty($analyzed_sql[0]['create_table_fields'])) {
 740                 // this is not a CREATE TABLE, so find the first VIEW
 741                 $target_for_view = PMA_backquote($target_db);
 742                 while (true) {
 743                     if ($parsed_sql[$i]['type'] == 'alpha_reservedWord'
 744                         && $parsed_sql[$i]['data'] == 'VIEW'
 745                     ) {
 746                         break;
 747                     }
 748                     $i++;
 749                 }
 750             }
 751             unset($analyzed_sql);
 752             if (PMA_DRIZZLE) {
 753                 $table_delimiter = 'quote_backtick';
 754             } else {
 755                 $server_sql_mode = PMA_DBI_fetch_value("SHOW VARIABLES LIKE 'sql_mode'", 0, 1);
 756                 // ANSI_QUOTES might be a subset of sql_mode, for example
 757                 // REAL_AS_FLOAT,PIPES_AS_CONCAT,ANSI_QUOTES,IGNORE_SPACE,ANSI
 758                 if (false !== strpos($server_sql_mode, 'ANSI_QUOTES')) {
 759                     $table_delimiter = 'quote_double';
 760                 } else {
 761                     $table_delimiter = 'quote_backtick';
 762                 }
 763                 unset($server_sql_mode);
 764             }
 765
 766             /* Find table name in query and replace it */
 767             while ($parsed_sql[$i]['type'] != $table_delimiter) {
 768                 $i++;
 769             }
 770
 771             /* no need to PMA_backquote() */
 772             if (isset($target_for_view)) {
 773                 // this a view definition; we just found the first db name
 774                 // that follows DEFINER VIEW
 775                 // so change it for the new db name
 776                         $parsed_sql[$i]['data'] = $target_for_view;
 777                 // then we have to find all references to the source db
 778                 // and change them to the target db, ensuring we stay into
 779                 // the $parsed_sql limits
 780                 $last = $parsed_sql['len'] - 1;
 781                 $backquoted_source_db = PMA_backquote($source_db);
 782                 for (++$i; $i <= $last; $i++) {
 783                     if ($parsed_sql[$i]['type'] == $table_delimiter
 784                         && $parsed_sql[$i]['data'] == $backquoted_source_db
 785                     ) {
 786                         $parsed_sql[$i]['data'] = $target_for_view;
 787                     }
 788                 }
 789                 unset($last,$backquoted_source_db);
 790             } else {
 791                 $parsed_sql[$i]['data'] = $target;
 792             }
 793
 794             /* Generate query back */
 795             $sql_structure = PMA_SQP_formatHtml($parsed_sql, 'query_only');
 796             // If table exists, and 'add drop table' is selected: Drop it!
 797             $drop_query = '';
 798             if (isset($GLOBALS['drop_if_exists'])
 799                 && $GLOBALS['drop_if_exists'] == 'true'
 800             ) {
 801                 if (PMA_Table::isView($target_db, $target_table)) {
 802                     $drop_query = 'DROP VIEW';
 803                 } else {
 804                     $drop_query = 'DROP TABLE';
 805                 }
 806                 $drop_query .= ' IF EXISTS '
 807                     . PMA_backquote($target_db) . '.'
 808                     . PMA_backquote($target_table);
 809                 PMA_DBI_query($drop_query);
 810
 811                 $GLOBALS['sql_query'] .= "\n" . $drop_query . ';';
 812
 813                 // If an existing table gets deleted, maintain any
 814                 // entries for the PMA_* tables
 815                 $maintain_relations = true;
 816             }
 817
 818             @PMA_DBI_query($sql_structure);
 819             $GLOBALS['sql_query'] .= "\n" . $sql_structure . ';';
 820
 821             if (($move || isset($GLOBALS['add_constraints']))
 822                 && !empty($GLOBALS['sql_constraints_query'])
 823             ) {
 824                 $parsed_sql =  PMA_SQP_parse($GLOBALS['sql_constraints_query']);
 825                 $i = 0;
 826
 827                 // find the first $table_delimiter, it must be the source table name
 828                 while ($parsed_sql[$i]['type'] != $table_delimiter) {
 829                     $i++;
 830                     // maybe someday we should guard against going over limit
 831                     //if ($i == $parsed_sql['len']) {
 832                     //    break;
 833                     //}
 834                 }
 835
 836                 // replace it by the target table name, no need to PMA_backquote()
 837                 $parsed_sql[$i]['data'] = $target;
 838
 839                 // now we must remove all $table_delimiter that follow a CONSTRAINT
 840                 // keyword, because a constraint name must be unique in a db
 841
 842                 $cnt = $parsed_sql['len'] - 1;
 843
 844                 for ($j = $i; $j < $cnt; $j++) {
 845                     if ($parsed_sql[$j]['type'] == 'alpha_reservedWord'
 846                         && strtoupper($parsed_sql[$j]['data']) == 'CONSTRAINT'
 847                     ) {
 848                         if ($parsed_sql[$j+1]['type'] == $table_delimiter) {
 849                             $parsed_sql[$j+1]['data'] = '';
 850                         }
 851                     }
 852                 }
 853
 854                 // Generate query back
 855                 $GLOBALS['sql_constraints_query'] = PMA_SQP_formatHtml(
 856                     $parsed_sql, 'query_only'
 857                 );
 858                 if ($mode == 'one_table') {
 859                     PMA_DBI_query($GLOBALS['sql_constraints_query']);
 860                 }
 861                 $GLOBALS['sql_query'] .= "\n" . $GLOBALS['sql_constraints_query'];
 862                 if ($mode == 'one_table') {
 863                     unset($GLOBALS['sql_constraints_query']);
 864                 }
 865             }
 866         } else {
 867             $GLOBALS['sql_query'] = '';
 868         }
 869
 870         // Copy the data unless this is a VIEW
 871         if (($what == 'data' || $what == 'dataonly')
 872             && ! PMA_Table::isView($target_db, $target_table)
 873         ) {
 874             $sql_insert_data = 'INSERT INTO ' . $target . ' SELECT * FROM ' . $source;
 875             PMA_DBI_query($sql_insert_data);
 876             $GLOBALS['sql_query']      .= "\n\n" . $sql_insert_data . ';';
 877         }
 878
 879         $GLOBALS['cfgRelation'] = PMA_getRelationsParam();
 880
 881         // Drops old table if the user has requested to move it
 882         if ($move) {
 883
 884             // This could avoid some problems with replicated databases, when
 885             // moving table from replicated one to not replicated one
 886             PMA_DBI_select_db($source_db);
 887
 888             if (PMA_Table::isView($source_db, $source_table)) {
 889                 $sql_drop_query = 'DROP VIEW';
 890             } else {
 891                 $sql_drop_query = 'DROP TABLE';
 892             }
 893             $sql_drop_query .= ' ' . $source;
 894             PMA_DBI_query($sql_drop_query);
 895
 896             // Move old entries from PMA-DBs to new table
 897             if ($GLOBALS['cfgRelation']['commwork']) {
 898                 $remove_query = 'UPDATE ' . PMA_backquote($GLOBALS['cfgRelation']['db']) . '.' . PMA_backquote($GLOBALS['cfgRelation']['column_info'])
 899                               . ' SET     table_name = \'' . PMA_sqlAddSlashes($target_table) . '\', '
 900                               . '        db_name    = \'' . PMA_sqlAddSlashes($target_db) . '\''
 901                               . ' WHERE db_name  = \'' . PMA_sqlAddSlashes($source_db) . '\''
 902                               . ' AND table_name = \'' . PMA_sqlAddSlashes($source_table) . '\'';
 903                 PMA_query_as_controluser($remove_query);
 904                 unset($remove_query);
 905             }
 906
 907             // updating bookmarks is not possible since only a single table is moved,
 908             // and not the whole DB.
 909
 910             if ($GLOBALS['cfgRelation']['displaywork']) {
 911                 $table_query = 'UPDATE ' . PMA_backquote($GLOBALS['cfgRelation']['db']) . '.' . PMA_backquote($GLOBALS['cfgRelation']['table_info'])
 912                                 . ' SET     db_name = \'' . PMA_sqlAddSlashes($target_db) . '\', '
 913                                 . '         table_name = \'' . PMA_sqlAddSlashes($target_table) . '\''
 914                                 . ' WHERE db_name  = \'' . PMA_sqlAddSlashes($source_db) . '\''
 915                                 . ' AND table_name = \'' . PMA_sqlAddSlashes($source_table) . '\'';
 916                 PMA_query_as_controluser($table_query);
 917                 unset($table_query);
 918             }
 919
 920             if ($GLOBALS['cfgRelation']['relwork']) {
 921                 $table_query = 'UPDATE ' . PMA_backquote($GLOBALS['cfgRelation']['db']) . '.' . PMA_backquote($GLOBALS['cfgRelation']['relation'])
 922                                 . ' SET     foreign_table = \'' . PMA_sqlAddSlashes($target_table) . '\','
 923                                 . '         foreign_db = \'' . PMA_sqlAddSlashes($target_db) . '\''
 924                                 . ' WHERE foreign_db  = \'' . PMA_sqlAddSlashes($source_db) . '\''
 925                                 . ' AND foreign_table = \'' . PMA_sqlAddSlashes($source_table) . '\'';
 926                 PMA_query_as_controluser($table_query);
 927                 unset($table_query);
 928
 929                 $table_query = 'UPDATE ' . PMA_backquote($GLOBALS['cfgRelation']['db']) . '.' . PMA_backquote($GLOBALS['cfgRelation']['relation'])
 930                                 . ' SET     master_table = \'' . PMA_sqlAddSlashes($target_table) . '\','
 931                                 . '         master_db = \'' . PMA_sqlAddSlashes($target_db) . '\''
 932                                 . ' WHERE master_db  = \'' . PMA_sqlAddSlashes($source_db) . '\''
 933                                 . ' AND master_table = \'' . PMA_sqlAddSlashes($source_table) . '\'';
 934                 PMA_query_as_controluser($table_query);
 935                 unset($table_query);
 936             }
 937
 938             /**
 939              * @todo Can't get moving PDFs the right way. The page numbers
 940              * always get screwed up independently from duplication because the
 941              * numbers do not seem to be stored on a per-database basis. Would
 942              * the author of pdf support please have a look at it?
 943              */
 944
 945             if ($GLOBALS['cfgRelation']['pdfwork']) {
 946                 $table_query = 'UPDATE ' . PMA_backquote($GLOBALS['cfgRelation']['db']) . '.' . PMA_backquote($GLOBALS['cfgRelation']['table_coords'])
 947                                 . ' SET     table_name = \'' . PMA_sqlAddSlashes($target_table) . '\','
 948                                 . '         db_name = \'' . PMA_sqlAddSlashes($target_db) . '\''
 949                                 . ' WHERE db_name  = \'' . PMA_sqlAddSlashes($source_db) . '\''
 950                                 . ' AND table_name = \'' . PMA_sqlAddSlashes($source_table) . '\'';
 951                 PMA_query_as_controluser($table_query);
 952                 unset($table_query);
 953                 /*
 954                 $pdf_query = 'SELECT pdf_page_number '
 955                            . ' FROM ' . PMA_backquote($GLOBALS['cfgRelation']['db']) . '.' . PMA_backquote($GLOBALS['cfgRelation']['table_coords'])
 956                            . ' WHERE db_name  = \'' . PMA_sqlAddSlashes($target_db) . '\''
 957                            . ' AND table_name = \'' . PMA_sqlAddSlashes($target_table) . '\'';
 958                 $pdf_rs = PMA_query_as_controluser($pdf_query);
 959
 960                 while ($pdf_copy_row = PMA_DBI_fetch_assoc($pdf_rs)) {
 961                     $table_query = 'UPDATE ' . PMA_backquote($GLOBALS['cfgRelation']['db']) . '.' . PMA_backquote($GLOBALS['cfgRelation']['pdf_pages'])
 962                                     . ' SET     db_name = \'' . PMA_sqlAddSlashes($target_db) . '\''
 963                                     . ' WHERE db_name  = \'' . PMA_sqlAddSlashes($source_db) . '\''
 964                                     . ' AND page_nr = \'' . PMA_sqlAddSlashes($pdf_copy_row['pdf_page_number']) . '\'';
 965                     $tb_rs    = PMA_query_as_controluser($table_query);
 966                     unset($table_query);
 967                     unset($tb_rs);
 968                 }
 969                 */
 970             }
 971
 972             if ($GLOBALS['cfgRelation']['designerwork']) {
 973                 $table_query = 'UPDATE ' . PMA_backquote($GLOBALS['cfgRelation']['db']) . '.' . PMA_backquote($GLOBALS['cfgRelation']['designer_coords'])
 974                                 . ' SET     table_name = \'' . PMA_sqlAddSlashes($target_table) . '\','
 975                                 . '         db_name = \'' . PMA_sqlAddSlashes($target_db) . '\''
 976                                 . ' WHERE db_name  = \'' . PMA_sqlAddSlashes($source_db) . '\''
 977                                 . ' AND table_name = \'' . PMA_sqlAddSlashes($source_table) . '\'';
 978                 PMA_query_as_controluser($table_query);
 979                 unset($table_query);
 980             }
 981
 982             $GLOBALS['sql_query']      .= "\n\n" . $sql_drop_query . ';';
 983             // end if ($move)
 984         } else {
 985             // we are copying
 986             // Create new entries as duplicates from old PMA DBs
 987             if ($what != 'dataonly' && ! isset($maintain_relations)) {
 988                 if ($GLOBALS['cfgRelation']['commwork']) {
 989                     // Get all comments and MIME-Types for current table
 990                     $comments_copy_query = 'SELECT
 991                                                 column_name, comment' . ($GLOBALS['cfgRelation']['mimework'] ? ', mimetype, transformation, transformation_options' : '') . '
 992                                             FROM ' . PMA_backquote($GLOBALS['cfgRelation']['db']) . '.' . PMA_backquote($GLOBALS['cfgRelation']['column_info']) . '
 993                                             WHERE
 994                                                 db_name = \'' . PMA_sqlAddSlashes($source_db) . '\' AND
 995                                                 table_name = \'' . PMA_sqlAddSlashes($source_table) . '\'';
 996                     $comments_copy_rs    = PMA_query_as_controluser($comments_copy_query);
 997
 998                     // Write every comment as new copied entry. [MIME]
 999                     while ($comments_copy_row = PMA_DBI_fetch_assoc($comments_copy_rs)) {
1000                         $new_comment_query = 'REPLACE INTO ' . PMA_backquote($GLOBALS['cfgRelation']['db']) . '.' . PMA_backquote($GLOBALS['cfgRelation']['column_info'])
1001                                     . ' (db_name, table_name, column_name, comment' . ($GLOBALS['cfgRelation']['mimework'] ? ', mimetype, transformation, transformation_options' : '') . ') '
1002                                     . ' VALUES('
1003                                     . '\'' . PMA_sqlAddSlashes($target_db) . '\','
1004                                     . '\'' . PMA_sqlAddSlashes($target_table) . '\','
1005                                     . '\'' . PMA_sqlAddSlashes($comments_copy_row['column_name']) . '\''
1006                                     . ($GLOBALS['cfgRelation']['mimework'] ? ',\'' . PMA_sqlAddSlashes($comments_copy_row['comment']) . '\','
1007                                             . '\'' . PMA_sqlAddSlashes($comments_copy_row['mimetype']) . '\','
1008                                             . '\'' . PMA_sqlAddSlashes($comments_copy_row['transformation']) . '\','
1009                                             . '\'' . PMA_sqlAddSlashes($comments_copy_row['transformation_options']) . '\'' : '')
1010                                     . ')';
1011                         PMA_query_as_controluser($new_comment_query);
1012                     } // end while
1013                     PMA_DBI_free_result($comments_copy_rs);
1014                     unset($comments_copy_rs);
1015                 }
1016
1017                 // duplicating the bookmarks must not be done here, but
1018                 // just once per db
1019
1020                 $get_fields = array('display_field');
1021                 $where_fields = array('db_name' => $source_db, 'table_name' => $source_table);
1022                 $new_fields = array('db_name' => $target_db, 'table_name' => $target_table);
1023                 PMA_Table::duplicateInfo('displaywork', 'table_info', $get_fields, $where_fields, $new_fields);
1024
1025
1026                 /**
1027                  * @todo revise this code when we support cross-db relations
1028                  */
1029                 $get_fields = array('master_field', 'foreign_table', 'foreign_field');
1030                 $where_fields = array('master_db' => $source_db, 'master_table' => $source_table);
1031                 $new_fields = array('master_db' => $target_db, 'foreign_db' => $target_db, 'master_table' => $target_table);
1032                 PMA_Table::duplicateInfo('relwork', 'relation', $get_fields, $where_fields, $new_fields);
1033
1034
1035                 $get_fields = array('foreign_field', 'master_table', 'master_field');
1036                 $where_fields = array('foreign_db' => $source_db, 'foreign_table' => $source_table);
1037                 $new_fields = array('master_db' => $target_db, 'foreign_db' => $target_db, 'foreign_table' => $target_table);
1038                 PMA_Table::duplicateInfo('relwork', 'relation', $get_fields, $where_fields, $new_fields);
1039
1040
1041                 $get_fields = array('x', 'y', 'v', 'h');
1042                 $where_fields = array('db_name' => $source_db, 'table_name' => $source_table);
1043                 $new_fields = array('db_name' => $target_db, 'table_name' => $target_table);
1044                 PMA_Table::duplicateInfo('designerwork', 'designer_coords', $get_fields, $where_fields, $new_fields);
1045
1046                 /**
1047                  * @todo Can't get duplicating PDFs the right way. The
1048                  * page numbers always get screwed up independently from
1049                  * duplication because the numbers do not seem to be stored on a
1050                  * per-database basis. Would the author of pdf support please
1051                  * have a look at it?
1052                  *
1053                 $get_fields = array('page_descr');
1054                 $where_fields = array('db_name' => $source_db);
1055                 $new_fields = array('db_name' => $target_db);
1056                 $last_id = PMA_Table::duplicateInfo('pdfwork', 'pdf_pages', $get_fields, $where_fields, $new_fields);
1057
1058                 if (isset($last_id) && $last_id >= 0) {
1059                     $get_fields = array('x', 'y');
1060                     $where_fields = array('db_name' => $source_db, 'table_name' => $source_table);
1061                     $new_fields = array('db_name' => $target_db, 'table_name' => $target_table, 'pdf_page_number' => $last_id);
1062                     PMA_Table::duplicateInfo('pdfwork', 'table_coords', $get_fields, $where_fields, $new_fields);
1063                 }
1064                  */
1065             }
1066         }
1067         return true;
1068     }
1069
1070     /**
1071      * checks if given name is a valid table name,
1072      * currently if not empty, trailing spaces, '.', '/' and '\'
1073      *
1074      * @param string $table_name name to check
1075      *
1076      * @todo add check for valid chars in filename on current system/os
1077      * @see  http://dev.mysql.com/doc/refman/5.0/en/legal-names.html
1078      *
1079      * @return  boolean whether the string is valid or not
1080      */
1081     function isValidName($table_name)
1082     {
1083         if ($table_name !== trim($table_name)) {
1084             // trailing spaces
1085             return false;
1086         }
1087
1088         if (! strlen($table_name)) {
1089             // zero length
1090             return false;
1091         }
1092
1093         if (preg_match('/[.\/\\\\]+/i', $table_name)) {
1094             // illegal char . / \
1095             return false;
1096         }
1097
1098         return true;
1099     }
1100
1101     /**
1102      * renames table
1103      *
1104      * @param string $new_name new table name
1105      * @param string $new_db   new database name
1106      * @param bool   $is_view  is this for a VIEW rename?
1107      * @todo    remove the $is_view parameter (also in callers)
1108      *
1109      * @return bool success
1110      */
1111     function rename($new_name, $new_db = null, $is_view = false)
1112     {
1113         if (null !== $new_db && $new_db !== $this->getDbName()) {
1114             // Ensure the target is valid
1115             if (! $GLOBALS['pma']->databases->exists($new_db)) {
1116                 $this->errors[] = __('Invalid database') . ': ' . $new_db;
1117                 return false;
1118             }
1119         } else {
1120             $new_db = $this->getDbName();
1121         }
1122
1123         $new_table = new PMA_Table($new_name, $new_db);
1124
1125         if ($this->getFullName() === $new_table->getFullName()) {
1126             return true;
1127         }
1128
1129         if (! PMA_Table::isValidName($new_name)) {
1130             $this->errors[] = __('Invalid table name') . ': ' . $new_table->getFullName();
1131             return false;
1132         }
1133
1134         /*
1135          * tested also for a view, in MySQL 5.0.92, 5.1.55 and 5.5.13
1136          */
1137         $GLOBALS['sql_query'] = '
1138             RENAME TABLE ' . $this->getFullName(true) . '
1139                   TO ' . $new_table->getFullName(true) . ';';
1140         // I don't think a specific error message for views is necessary
1141         if (! PMA_DBI_query($GLOBALS['sql_query'])) {
1142             $this->errors[] = sprintf(
1143                 __('Error renaming table %1$s to %2$s'),
1144                 $this->getFullName(),
1145                 $new_table->getFullName()
1146             );
1147             return false;
1148         }
1149
1150         $old_name = $this->getName();
1151         $old_db = $this->getDbName();
1152         $this->setName($new_name);
1153         $this->setDbName($new_db);
1154
1155         /**
1156          * @todo move into extra function PMA_Relation::renameTable($new_name, $old_name, $new_db, $old_db)
1157          */
1158         // Move old entries from comments to new table
1159         $GLOBALS['cfgRelation'] = PMA_getRelationsParam();
1160         if ($GLOBALS['cfgRelation']['commwork']) {
1161             $remove_query = '
1162                 UPDATE ' . PMA_backquote($GLOBALS['cfgRelation']['db']) . '.'
1163                     . PMA_backquote($GLOBALS['cfgRelation']['column_info']) . '
1164                    SET `db_name`    = \'' . PMA_sqlAddSlashes($new_db) . '\',
1165                        `table_name` = \'' . PMA_sqlAddSlashes($new_name) . '\'
1166                  WHERE `db_name`    = \'' . PMA_sqlAddSlashes($old_db) . '\'
1167                    AND `table_name` = \'' . PMA_sqlAddSlashes($old_name) . '\'';
1168             PMA_query_as_controluser($remove_query);
1169             unset($remove_query);
1170         }
1171
1172         if ($GLOBALS['cfgRelation']['displaywork']) {
1173             $table_query = '
1174                 UPDATE ' . PMA_backquote($GLOBALS['cfgRelation']['db']) . '.'
1175                     . PMA_backquote($GLOBALS['cfgRelation']['table_info']) . '
1176                    SET `db_name`    = \'' . PMA_sqlAddSlashes($new_db) . '\',
1177                        `table_name` = \'' . PMA_sqlAddSlashes($new_name) . '\'
1178                  WHERE `db_name`    = \'' . PMA_sqlAddSlashes($old_db) . '\'
1179                    AND `table_name` = \'' . PMA_sqlAddSlashes($old_name) . '\'';
1180             PMA_query_as_controluser($table_query);
1181             unset($table_query);
1182         }
1183
1184         if ($GLOBALS['cfgRelation']['relwork']) {
1185             $table_query = '
1186                 UPDATE ' . PMA_backquote($GLOBALS['cfgRelation']['db']) . '.'
1187                     . PMA_backquote($GLOBALS['cfgRelation']['relation']) . '
1188                    SET `foreign_db`    = \'' . PMA_sqlAddSlashes($new_db) . '\',
1189                        `foreign_table` = \'' . PMA_sqlAddSlashes($new_name) . '\'
1190                  WHERE `foreign_db`    = \'' . PMA_sqlAddSlashes($old_db) . '\'
1191                    AND `foreign_table` = \'' . PMA_sqlAddSlashes($old_name) . '\'';
1192             PMA_query_as_controluser($table_query);
1193
1194             $table_query = '
1195                 UPDATE ' . PMA_backquote($GLOBALS['cfgRelation']['db']) . '.'
1196                     . PMA_backquote($GLOBALS['cfgRelation']['relation']) . '
1197                    SET `master_db`    = \'' . PMA_sqlAddSlashes($new_db) . '\',
1198                        `master_table` = \'' . PMA_sqlAddSlashes($new_name) . '\'
1199                  WHERE `master_db`    = \'' . PMA_sqlAddSlashes($old_db) . '\'
1200                    AND `master_table` = \'' . PMA_sqlAddSlashes($old_name) . '\'';
1201             PMA_query_as_controluser($table_query);
1202             unset($table_query);
1203         }
1204
1205         if ($GLOBALS['cfgRelation']['pdfwork']) {
1206             $table_query = '
1207                 UPDATE ' . PMA_backquote($GLOBALS['cfgRelation']['db']) . '.'
1208                     . PMA_backquote($GLOBALS['cfgRelation']['table_coords']) . '
1209                    SET `db_name`    = \'' . PMA_sqlAddSlashes($new_db) . '\',
1210                        `table_name` = \'' . PMA_sqlAddSlashes($new_name) . '\'
1211                  WHERE `db_name`    = \'' . PMA_sqlAddSlashes($old_db) . '\'
1212                    AND `table_name` = \'' . PMA_sqlAddSlashes($old_name) . '\'';
1213             PMA_query_as_controluser($table_query);
1214             unset($table_query);
1215         }
1216
1217         if ($GLOBALS['cfgRelation']['designerwork']) {
1218             $table_query = '
1219                 UPDATE ' . PMA_backquote($GLOBALS['cfgRelation']['db']) . '.'
1220                     . PMA_backquote($GLOBALS['cfgRelation']['designer_coords']) . '
1221                    SET `db_name`    = \'' . PMA_sqlAddSlashes($new_db) . '\',
1222                        `table_name` = \'' . PMA_sqlAddSlashes($new_name) . '\'
1223                  WHERE `db_name`    = \'' . PMA_sqlAddSlashes($old_db) . '\'
1224                    AND `table_name` = \'' . PMA_sqlAddSlashes($old_name) . '\'';
1225             PMA_query_as_controluser($table_query);
1226             unset($table_query);
1227         }
1228
1229         $this->messages[] = sprintf(
1230             __('Table %s has been renamed to %s'),
1231             htmlspecialchars($old_name),
1232             htmlspecialchars($new_name)
1233         );
1234         return true;
1235     }
1236
1237     /**
1238      * Get all unique columns
1239      *
1240      * returns an array with all columns with unqiue content, in fact these are
1241      * all columns being single indexed in PRIMARY or UNIQUE
1242      *
1243      * e.g.
1244      *  - PRIMARY(id) // id
1245      *  - UNIQUE(name) // name
1246      *  - PRIMARY(fk_id1, fk_id2) // NONE
1247      *  - UNIQUE(x,y) // NONE
1248      *
1249      * @param bool $backquoted whether to quote name with backticks ``
1250      *
1251      * @return array
1252      */
1253     public function getUniqueColumns($backquoted = true)
1254     {
1255         $sql = PMA_DBI_get_table_indexes_sql($this->getDbName(), $this->getName(), 'Non_unique = 0');
1256         $uniques = PMA_DBI_fetch_result($sql, array('Key_name', null), 'Column_name');
1257
1258         $return = array();
1259         foreach ($uniques as $index) {
1260             if (count($index) > 1) {
1261                 continue;
1262             }
1263             $return[] = $this->getFullName($backquoted) . '.'
1264                 . ($backquoted ? PMA_backquote($index[0]) : $index[0]);
1265         }
1266
1267         return $return;
1268     }
1269
1270     /**
1271      * Get all indexed columns
1272      *
1273      * returns an array with all columns make use of an index, in fact only
1274      * first columns in an index
1275      *
1276      * e.g. index(col1, col2) would only return col1
1277      *
1278      * @param bool $backquoted whether to quote name with backticks ``
1279      *
1280      * @return array
1281      */
1282     public function getIndexedColumns($backquoted = true)
1283     {
1284         $sql = PMA_DBI_get_table_indexes_sql($this->getDbName(), $this->getName(), 'Seq_in_index = 1');
1285         $indexed = PMA_DBI_fetch_result($sql, 'Column_name', 'Column_name');
1286
1287         $return = array();
1288         foreach ($indexed as $column) {
1289             $return[] = $this->getFullName($backquoted) . '.'
1290                 . ($backquoted ? PMA_backquote($column) : $column);
1291         }
1292
1293         return $return;
1294     }
1295
1296     /**
1297      * Get all columns
1298      *
1299      * returns an array with all columns
1300      *
1301      * @param bool $backquoted whether to quote name with backticks ``
1302      *
1303      * @return array
1304      */
1305     public function getColumns($backquoted = true)
1306     {
1307         $sql = 'SHOW COLUMNS FROM ' . $this->getFullName(true);
1308         $indexed = PMA_DBI_fetch_result($sql, 'Field', 'Field');
1309
1310         $return = array();
1311         foreach ($indexed as $column) {
1312             $return[] = $this->getFullName($backquoted) . '.'
1313                 . ($backquoted ? PMA_backquote($column) : $column);
1314         }
1315
1316         return $return;
1317     }
1318
1319     /**
1320      * Return UI preferences for this table from phpMyAdmin database.
1321      *
1322      * @return array
1323      */
1324     protected function getUiPrefsFromDb()
1325     {
1326         $pma_table = PMA_backquote($GLOBALS['cfg']['Server']['pmadb']) .".".
1327                      PMA_backquote($GLOBALS['cfg']['Server']['table_uiprefs']);
1328
1329         // Read from phpMyAdmin database
1330         $sql_query = " SELECT `prefs` FROM " . $pma_table
1331             . " WHERE `username` = '" . $GLOBALS['cfg']['Server']['user'] . "'"
1332             . " AND `db_name` = '" . PMA_sqlAddSlashes($this->db_name) . "'"
1333             . " AND `table_name` = '" . PMA_sqlAddSlashes($this->name) . "'";
1334
1335         $row = PMA_DBI_fetch_array(PMA_query_as_controluser($sql_query));
1336         if (isset($row[0])) {
1337             return json_decode($row[0], true);
1338         } else {
1339             return array();
1340         }
1341     }
1342
1343     /**
1344      * Save this table's UI preferences into phpMyAdmin database.
1345      *
1346      * @return true|PMA_Message
1347      */
1348     protected function saveUiPrefsToDb()
1349     {
1350         $pma_table = PMA_backquote($GLOBALS['cfg']['Server']['pmadb']) . "."
1351             . PMA_backquote($GLOBALS['cfg']['Server']['table_uiprefs']);
1352
1353         $username = $GLOBALS['cfg']['Server']['user'];
1354         $sql_query = " REPLACE INTO " . $pma_table
1355             . " VALUES ('" . $username . "', '" . PMA_sqlAddSlashes($this->db_name)
1356             . "', '" . PMA_sqlAddSlashes($this->name) . "', '"
1357             . PMA_sqlAddSlashes(json_encode($this->uiprefs)) . "', NULL)";
1358
1359         $success = PMA_DBI_try_query($sql_query, $GLOBALS['controllink']);
1360
1361         if (!$success) {
1362             $message = PMA_Message::error(__('Could not save table UI preferences'));
1363             $message->addMessage('<br /><br />');
1364             $message->addMessage(
1365                 PMA_Message::rawError(PMA_DBI_getError($GLOBALS['controllink']))
1366             );
1367             return $message;
1368         }
1369
1370         // Remove some old rows in table_uiprefs if it exceeds the configured maximum rows
1371         $sql_query = 'SELECT COUNT(*) FROM ' . $pma_table;
1372         $rows_count = PMA_DBI_fetch_value($sql_query);
1373         $max_rows = $GLOBALS['cfg']['Server']['MaxTableUiprefs'];
1374         if ($rows_count > $max_rows) {
1375             $num_rows_to_delete = $rows_count - $max_rows;
1376             $sql_query =
1377                 ' DELETE FROM ' . $pma_table .
1378                 ' ORDER BY last_update ASC' .
1379                 ' LIMIT ' . $num_rows_to_delete;
1380             $success = PMA_DBI_try_query($sql_query, $GLOBALS['controllink']);
1381
1382             if (!$success) {
1383                 $message = PMA_Message::error(
1384                     sprintf(
1385                         __('Failed to cleanup table UI preferences (see $cfg[\'Servers\'][$i][\'MaxTableUiprefs\'] %s)'),
1386                         PMA_showDocu('cfg_Servers_MaxTableUiprefs')
1387                     )
1388                 );
1389                 $message->addMessage('<br /><br />');
1390                 $message->addMessage(PMA_Message::rawError(PMA_DBI_getError($GLOBALS['controllink'])));
1391                 print_r($message);
1392                 return $message;
1393             }
1394         }
1395
1396         return true;
1397     }
1398
1399     /**
1400      * Loads the UI preferences for this table.
1401      * If pmadb and table_uiprefs is set, it will load the UI preferences from
1402      * phpMyAdmin database.
1403      *
1404      * @return nothing
1405      */
1406     protected function loadUiPrefs()
1407     {
1408         $server_id = $GLOBALS['server'];
1409         // set session variable if it's still undefined
1410         if (! isset($_SESSION['tmp_user_values']['table_uiprefs'][$server_id][$this->db_name][$this->name])) {
1411             $_SESSION['tmp_user_values']['table_uiprefs'][$server_id][$this->db_name][$this->name] =
1412                 // check whether we can get from pmadb
1413                 (strlen($GLOBALS['cfg']['Server']['pmadb'])
1414                 && strlen($GLOBALS['cfg']['Server']['table_uiprefs']))
1415                     ?  $this->getUiPrefsFromDb()
1416                     : array();
1417         }
1418         $this->uiprefs =& $_SESSION['tmp_user_values']['table_uiprefs'][$server_id][$this->db_name][$this->name];
1419     }
1420
1421     /**
1422      * Get a property from UI preferences.
1423      * Return false if the property is not found.
1424      * Available property:
1425      * - PROP_SORTED_COLUMN
1426      * - PROP_COLUMN_ORDER
1427      * - PROP_COLUMN_VISIB
1428      *
1429      * @param string $property property
1430      *
1431      * @return mixed
1432      */
1433     public function getUiProp($property)
1434     {
1435         if (! isset($this->uiprefs)) {
1436             $this->loadUiPrefs();
1437         }
1438         // do checking based on property
1439         if ($property == self::PROP_SORTED_COLUMN) {
1440             if (isset($this->uiprefs[$property])) {
1441                 // check if the column name is exist in this table
1442                 $tmp = explode(' ', $this->uiprefs[$property]);
1443                 $colname = $tmp[0];
1444                 $avail_columns = $this->getColumns();
1445                 foreach ($avail_columns as $each_col) {
1446                     // check if $each_col ends with $colname
1447                     if (substr_compare($each_col, $colname, strlen($each_col) - strlen($colname)) === 0) {
1448                         return $this->uiprefs[$property];
1449                     }
1450                 }
1451                 // remove the property, since it is not exist anymore in database
1452                 $this->removeUiProp(self::PROP_SORTED_COLUMN);
1453                 return false;
1454             } else {
1455                 return false;
1456             }
1457         } elseif ($property == self::PROP_COLUMN_ORDER
1458             || $property == self::PROP_COLUMN_VISIB
1459         ) {
1460             if (! PMA_Table::isView($this->db_name, $this->name) && isset($this->uiprefs[$property])) {
1461                 // check if the table has not been modified
1462                 if (self::sGetStatusInfo($this->db_name, $this->name, 'Create_time') == $this->uiprefs['CREATE_TIME']) {
1463                     return $this->uiprefs[$property];
1464                 } else {
1465                     // remove the property, since the table has been modified
1466                     $this->removeUiProp(self::PROP_COLUMN_ORDER);
1467                     return false;
1468                 }
1469             } else {
1470                 return false;
1471             }
1472         }
1473         // default behaviour for other property:
1474         return isset($this->uiprefs[$property]) ? $this->uiprefs[$property] : false;
1475     }
1476
1477     /**
1478      * Set a property from UI preferences.
1479      * If pmadb and table_uiprefs is set, it will save the UI preferences to
1480      * phpMyAdmin database.
1481      * Available property:
1482      * - PROP_SORTED_COLUMN
1483      * - PROP_COLUMN_ORDER
1484      * - PROP_COLUMN_VISIB
1485      *
1486      * @param string $property          Property
1487      * @param mixed  $value             Value for the property
1488      * @param string $table_create_time Needed for PROP_COLUMN_ORDER and PROP_COLUMN_VISIB
1489      *
1490      * @return boolean|PMA_Message
1491      */
1492     public function setUiProp($property, $value, $table_create_time = null)
1493     {
1494         if (! isset($this->uiprefs)) {
1495             $this->loadUiPrefs();
1496         }
1497         // we want to save the create time if the property is PROP_COLUMN_ORDER
1498         if (! PMA_Table::isView($this->db_name, $this->name)
1499             && ($property == self::PROP_COLUMN_ORDER || $property == self::PROP_COLUMN_VISIB)
1500         ) {
1501             $curr_create_time = self::sGetStatusInfo($this->db_name, $this->name, 'CREATE_TIME');
1502             if (isset($table_create_time)
1503                 && $table_create_time == $curr_create_time
1504             ) {
1505                 $this->uiprefs['CREATE_TIME'] = $curr_create_time;
1506             } else {
1507                 // there is no $table_create_time, or
1508                 // supplied $table_create_time is older than current create time,
1509                 // so don't save
1510                 return PMA_Message::error(sprintf(
1511                     __('Cannot save UI property "%s". The changes made will not be persistent after you refresh this page. Please check if the table structure has been changed.'), $property));
1512             }
1513         }
1514         // save the value
1515         $this->uiprefs[$property] = $value;
1516         // check if pmadb is set
1517         if (strlen($GLOBALS['cfg']['Server']['pmadb'])
1518             && strlen($GLOBALS['cfg']['Server']['table_uiprefs'])
1519         ) {
1520             return $this->saveUiprefsToDb();
1521         }
1522         return true;
1523     }
1524
1525     /**
1526      * Remove a property from UI preferences.
1527      *
1528      * @param string $property the property
1529      *
1530      * @return true|PMA_Message
1531      */
1532     public function removeUiProp($property)
1533     {
1534         if (! isset($this->uiprefs)) {
1535             $this->loadUiPrefs();
1536         }
1537         if (isset($this->uiprefs[$property])) {
1538             unset($this->uiprefs[$property]);
1539             // check if pmadb is set
1540             if (strlen($GLOBALS['cfg']['Server']['pmadb'])
1541                 && strlen($GLOBALS['cfg']['Server']['table_uiprefs'])
1542             ) {
1543                 return $this->saveUiprefsToDb();
1544             }
1545         }
1546         return true;
1547     }
1548 }
1549 ?>