lib/mysqlschema.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Database schema utilities
   6  *
   7  * PHP version 5
   8  *
   9  * LICENCE: This program is free software: you can redistribute it and/or modify
  10  * it under the terms of the GNU Affero General Public License as published by
  11  * the Free Software Foundation, either version 3 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU Affero General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  *
  22  * @category  Database
  23  * @package   StatusNet
  24  * @author    Evan Prodromou <evan@status.net>
  25  * @copyright 2009 StatusNet, Inc.
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  27  * @link      http://status.net/
  28  */
  29
  30 if (!defined('STATUSNET')) {
  31     exit(1);
  32 }
  33
  34 /**
  35  * Class representing the database schema
  36  *
  37  * A class representing the database schema. Can be used to
  38  * manipulate the schema -- especially for plugins and upgrade
  39  * utilities.
  40  *
  41  * @category Database
  42  * @package  StatusNet
  43  * @author   Evan Prodromou <evan@status.net>
  44  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  45  * @link     http://status.net/
  46  */
  47
  48 class MysqlSchema extends Schema
  49 {
  50     static $_single = null;
  51     protected $conn = null;
  52
  53
  54     /**
  55      * Main public entry point. Use this to get
  56      * the singleton object.
  57      *
  58      * @return Schema the (single) Schema object
  59      */
  60
  61     static function get()
  62     {
  63         if (empty(self::$_single)) {
  64             self::$_single = new Schema();
  65         }
  66         return self::$_single;
  67     }
  68
  69     /**
  70      * Returns a TableDef object for the table
  71      * in the schema with the given name.
  72      *
  73      * Throws an exception if the table is not found.
  74      *
  75      * @param string $table Name of the table to get
  76      *
  77      * @return TableDef tabledef for that table.
  78      * @throws SchemaTableMissingException
  79      */
  80
  81     public function getTableDef($table)
  82     {
  83         $def = array();
  84         $hasKeys = false;
  85
  86         // Pull column data from INFORMATION_SCHEMA
  87         $columns = $this->fetchMetaInfo($table, 'COLUMNS', 'ORDINAL_POSITION');
  88         if (count($columns) == 0) {
  89             throw new SchemaTableMissingException("No such table: $table");
  90         }
  91
  92         foreach ($columns as $row) {
  93
  94             $name = $row['COLUMN_NAME'];
  95             $field = array();
  96
  97             // warning -- 'unsigned' attr on numbers isn't given in DATA_TYPE and friends.
  98             // It is stuck in on COLUMN_TYPE though (eg 'bigint(20) unsigned')
  99             list($type, $size) = $this->reverseMapType($row['DATA_TYPE']);
 100             $field['type'] = $type;
 101             if ($size !== null) {
 102                 $field['size'] = $size;
 103             }
 104
 105             if ($type == 'char' || $type == 'varchar') {
 106                 if ($row['CHARACTER_MAXIMUM_LENGTH'] !== null) {
 107                     $field['length'] = intval($row['CHARACTER_MAXIMUM_LENGTH']);
 108                 }
 109             }
 110             if ($type == 'numeric') {
 111                 // Other int types may report these values, but they're irrelevant.
 112                 // Just ignore them!
 113                 if ($row['NUMERIC_PRECISION'] !== null) {
 114                     $field['precision'] = intval($row['NUMERIC_PRECISION']);
 115                 }
 116                 if ($row['NUMERIC_SCALE'] !== null) {
 117                     $field['scale'] = intval($row['NUMERIC_SCALE']);
 118                 }
 119             }
 120             if ($row['IS_NULLABLE'] == 'NO') {
 121                 $field['not null'] = true;
 122             }
 123             if ($row['COLUMN_DEFAULT'] !== null) {
 124                 $field['default'] = $row['COLUMN_DEFAULT'];
 125                 if ($this->isNumericType($type)) {
 126                     $field['default'] = intval($field['default']);
 127                 }
 128             }
 129             if ($row['COLUMN_KEY'] !== null) {
 130                 // We'll need to look up key info...
 131                 $hasKeys = true;
 132             }
 133             if ($row['COLUMN_COMMENT'] !== null && $row['COLUMN_COMMENT'] != '') {
 134                 $field['description'] = $row['COLUMN_COMMENT'];
 135             }
 136
 137             $extra = $row['EXTRA'];
 138             if ($extra) {
 139                 if (preg_match('/(^|\s)auto_increment(\s|$)/i', $extra)) {
 140                     $field['type'] = 'serial';
 141                 }
 142                 // $row['EXTRA'] may contain 'on update CURRENT_TIMESTAMP'
 143                 // ^ ...... how to specify?
 144             }
 145
 146             if ($row['CHARACTER_SET_NAME'] !== null) {
 147                 // @fixme check against defaults?
 148                 //$def['charset'] = $row['CHARACTER_SET_NAME'];
 149                 //$def['collate']  = $row['COLLATION_NAME'];
 150             }
 151
 152             $def['fields'][$name] = $field;
 153         }
 154
 155         if ($hasKeys) {
 156             // INFORMATION_SCHEMA's CONSTRAINTS and KEY_COLUMN_USAGE tables give
 157             // good info on primary and unique keys but don't list ANY info on
 158             // multi-value keys, which is lame-o. Sigh.
 159             //
 160             // Let's go old school and use SHOW INDEX :D
 161             //
 162             $keyInfo = $this->fetchIndexInfo($table);
 163             $keys = array();
 164             foreach ($keyInfo as $row) {
 165                 $name = $row['Key_name'];
 166                 $column = $row['Column_name'];
 167
 168                 if (!isset($keys[$name])) {
 169                     $keys[$name] = array();
 170                 }
 171                 $keys[$name][] = $column;
 172
 173                 if ($name == 'PRIMARY') {
 174                     $type = 'primary key';
 175                 } else if ($row['Non_unique'] == 0) {
 176                     $type = 'unique keys';
 177                 } else if ($row['Index_type'] == 'FULLTEXT') {
 178                     $type = 'fulltext indexes';
 179                 } else {
 180                     $type = 'indexes';
 181                 }
 182                 $keyTypes[$name] = $type;
 183             }
 184
 185             foreach ($keyTypes as $name => $type) {
 186                 if ($type == 'primary key') {
 187                     // there can be only one
 188                     $def[$type] = $keys[$name];
 189                 } else {
 190                     $def[$type][$name] = $keys[$name];
 191                 }
 192             }
 193         }
 194         return $def;
 195     }
 196
 197     /**
 198      * Pull the given table properties from INFORMATION_SCHEMA.
 199      * Most of the good stuff is MySQL extensions.
 200      *
 201      * @return array
 202      * @throws Exception if table info can't be looked up
 203      */
 204
 205     function getTableProperties($table, $props)
 206     {
 207         $data = $this->fetchMetaInfo($table, 'TABLES');
 208         if ($data) {
 209             return $data[0];
 210         } else {
 211             throw new SchemaTableMissingException("No such table: $table");
 212         }
 213     }
 214
 215     /**
 216      * Pull some INFORMATION.SCHEMA data for the given table.
 217      *
 218      * @param string $table
 219      * @return array of arrays
 220      */
 221     function fetchMetaInfo($table, $infoTable, $orderBy=null)
 222     {
 223         $query = "SELECT * FROM INFORMATION_SCHEMA.%s " .
 224                  "WHERE TABLE_SCHEMA='%s' AND TABLE_NAME='%s'";
 225         $schema = $this->conn->dsn['database'];
 226         $sql = sprintf($query, $infoTable, $schema, $table);
 227         if ($orderBy) {
 228             $sql .= ' ORDER BY ' . $orderBy;
 229         }
 230         return $this->fetchQueryData($sql);
 231     }
 232
 233     /**
 234      * Pull 'SHOW INDEX' data for the given table.
 235      *
 236      * @param string $table
 237      * @return array of arrays
 238      */
 239     function fetchIndexInfo($table)
 240     {
 241         $query = "SHOW INDEX FROM `%s`";
 242         $sql = sprintf($query, $table);
 243         return $this->fetchQueryData($sql);
 244     }
 245
 246     /**
 247      * Close out a 'create table' SQL statement.
 248      *
 249      * @param array $sql
 250      * @param string $name
 251      * @param array $def
 252      */
 253     function appendCreateTableEnd(array &$sql, $name, array $def)
 254     {
 255         $sql[] = ") ENGINE=InnoDB CHARACTER SET utf8 COLLATE utf8_bin";
 256     }
 257
 258     /**
 259      * Get the unique index key name for a given column on this table
 260      */
 261     function _uniqueKey($tableName, $columnName)
 262     {
 263         return $this->_key($tableName, $columnName);
 264     }
 265
 266     /**
 267      * Get the index key name for a given column on this table
 268      */
 269     function _key($tableName, $columnName)
 270     {
 271         return "{$tableName}_{$columnName}_idx";
 272     }
 273
 274     /**
 275      * Ensures that a table exists with the given
 276      * name and the given column definitions.
 277      *
 278      * If the table does not yet exist, it will
 279      * create the table. If it does exist, it will
 280      * alter the table to match the column definitions.
 281      *
 282      * @param string $tableName name of the table
 283      * @param array  $columns   array of ColumnDef
 284      *                          objects for the table
 285      *
 286      * @return boolean success flag
 287      */
 288
 289     public function ensureTable($tableName, $columns)
 290     {
 291         // XXX: DB engine portability -> toilet
 292
 293         try {
 294             $td = $this->getTableDef($tableName);
 295         } catch (SchemaTableMissingException $e) {
 296             return $this->createTable($tableName, $columns);
 297         }
 298
 299         $cur = $this->_names($td->columns);
 300         $new = $this->_names($columns);
 301
 302         $dropIndex  = array();
 303         $toadd      = array_diff($new, $cur);
 304         $todrop     = array_diff($cur, $new);
 305         $same       = array_intersect($new, $cur);
 306         $tomod      = array();
 307         $addIndex   = array();
 308         $tableProps = array();
 309
 310         foreach ($same as $m) {
 311             $curCol = $this->_byName($td->columns, $m);
 312             $newCol = $this->_byName($columns, $m);
 313
 314             if (!$newCol->equals($curCol)) {
 315                 $tomod[] = $newCol->name;
 316                 continue;
 317             }
 318
 319             // Earlier versions may have accidentally left tables at default
 320             // charsets which might be latin1 or other freakish things.
 321             if ($this->_isString($curCol)) {
 322                 if ($curCol->charset != 'utf8') {
 323                     $tomod[] = $newCol->name;
 324                     continue;
 325                 }
 326             }
 327         }
 328
 329         // Find any indices we have to change...
 330         $curIdx = $this->_indexList($td->columns);
 331         $newIdx = $this->_indexList($columns);
 332
 333         if ($curIdx['primary'] != $newIdx['primary']) {
 334             if ($curIdx['primary']) {
 335                 $dropIndex[] = 'drop primary key';
 336             }
 337             if ($newIdx['primary']) {
 338                 $keys = implode(',', $newIdx['primary']);
 339                 $addIndex[] = "add constraint primary key ($keys)";
 340             }
 341         }
 342
 343         $dropUnique = array_diff($curIdx['uniques'], $newIdx['uniques']);
 344         $addUnique = array_diff($newIdx['uniques'], $curIdx['uniques']);
 345         foreach ($dropUnique as $columnName) {
 346             $dropIndex[] = 'drop key ' . $this->_uniqueKey($tableName, $columnName);
 347         }
 348         foreach ($addUnique as $columnName) {
 349             $addIndex[] = 'add constraint unique key ' . $this->_uniqueKey($tableName, $columnName) . " ($columnName)";;
 350         }
 351
 352         $dropMultiple = array_diff($curIdx['indices'], $newIdx['indices']);
 353         $addMultiple = array_diff($newIdx['indices'], $curIdx['indices']);
 354         foreach ($dropMultiple as $columnName) {
 355             $dropIndex[] = 'drop key ' . $this->_key($tableName, $columnName);
 356         }
 357         foreach ($addMultiple as $columnName) {
 358             $addIndex[] = 'add key ' . $this->_key($tableName, $columnName) . " ($columnName)";
 359         }
 360
 361         // Check for table properties: make sure we're using a sane
 362         // engine type and charset/collation.
 363         // @fixme make the default engine configurable?
 364         $oldProps = $this->getTableProperties($tableName, array('ENGINE', 'TABLE_COLLATION'));
 365         if (strtolower($oldProps['ENGINE']) != 'innodb') {
 366             $tableProps['ENGINE'] = 'InnoDB';
 367         }
 368         if (strtolower($oldProps['TABLE_COLLATION']) != 'utf8_bin') {
 369             $tableProps['DEFAULT CHARSET'] = 'utf8';
 370             $tableProps['COLLATE'] = 'utf8_bin';
 371         }
 372
 373         if (count($dropIndex) + count($toadd) + count($todrop) + count($tomod) + count($addIndex) + count($tableProps) == 0) {
 374             // nothing to do
 375             return true;
 376         }
 377
 378         // For efficiency, we want this all in one
 379         // query, instead of using our methods.
 380
 381         $phrase = array();
 382
 383         foreach ($dropIndex as $indexSql) {
 384             $phrase[] = $indexSql;
 385         }
 386
 387         foreach ($toadd as $columnName) {
 388             $cd = $this->_byName($columns, $columnName);
 389
 390             $phrase[] = 'ADD COLUMN ' . $this->_columnSql($cd);
 391         }
 392
 393         foreach ($todrop as $columnName) {
 394             $phrase[] = 'DROP COLUMN ' . $columnName;
 395         }
 396
 397         foreach ($tomod as $columnName) {
 398             $cd = $this->_byName($columns, $columnName);
 399
 400             $phrase[] = 'MODIFY COLUMN ' . $this->_columnSql($cd);
 401         }
 402
 403         foreach ($addIndex as $indexSql) {
 404             $phrase[] = $indexSql;
 405         }
 406
 407         foreach ($tableProps as $key => $val) {
 408             $phrase[] = "$key=$val";
 409         }
 410
 411         $sql = 'ALTER TABLE ' . $tableName . ' ' . implode(', ', $phrase);
 412
 413         common_log(LOG_DEBUG, __METHOD__ . ': ' . $sql);
 414         $res = $this->conn->query($sql);
 415
 416         if (PEAR::isError($res)) {
 417             throw new Exception($res->getMessage());
 418         }
 419
 420         return true;
 421     }
 422
 423     /**
 424      * Is this column a string type?
 425      */
 426     private function _isString(array $cd)
 427     {
 428         $strings = array('char', 'varchar', 'text');
 429         return in_array(strtolower($cd['type']), $strings);
 430     }
 431
 432     /**
 433      * Return the proper SQL for creating or
 434      * altering a column.
 435      *
 436      * Appropriate for use in CREATE TABLE or
 437      * ALTER TABLE statements.
 438      *
 439      * @param ColumnDef $cd column to create
 440      *
 441      * @return string correct SQL for that column
 442      */
 443
 444     function columnSql(array $cd)
 445     {
 446         $line = array();
 447         $line[] = parent::columnSql($cd);
 448
 449         if ($cd['type'] == 'serial') {
 450             $line[] = 'auto_increment';
 451         }
 452
 453         if (!empty($cd['description'])) {
 454             $line[] = 'comment';
 455             $line[] = $this->quoteValue($cd['description']);
 456         }
 457
 458         return implode(' ', $line);
 459     }
 460
 461     function mapType($column)
 462     {
 463         $map = array('serial' => 'int',
 464                      'integer' => 'int',
 465                      'numeric' => 'decimal');
 466
 467         $type = $column['type'];
 468         if (isset($map[$type])) {
 469             $type = $map[$type];
 470         }
 471
 472         if (!empty($column['size'])) {
 473             $size = $column['size'];
 474             if ($type == 'int' &&
 475                        in_array($size, array('tiny', 'small', 'medium', 'big'))) {
 476                 $type = $size . $type;
 477             } else if (in_array($type, array('blob', 'text')) &&
 478                        in_array($size, array('tiny', 'medium', 'long'))) {
 479                 $type = $size . $type;
 480             }
 481         }
 482
 483         return $type;
 484     }
 485
 486     /**
 487      * Map a MySQL native type back to an independent type + size
 488      *
 489      * @param string $type
 490      * @return array ($type, $size) -- $size may be null
 491      */
 492     protected function reverseMapType($type)
 493     {
 494         $type = strtolower($type);
 495         $map = array(
 496             'decimal' => array('numeric', null),
 497             'tinyint' => array('int', 'tiny'),
 498             'smallint' => array('int', 'small'),
 499             'mediumint' => array('int', 'medium'),
 500             'bigint' => array('int', 'big'),
 501             'tinyblob' => array('blob', 'tiny'),
 502             'mediumblob' => array('blob', 'medium'),
 503             'longblob' => array('blob', 'long'),
 504             'tinytext' => array('text', 'tiny'),
 505             'mediumtext' => array('text', 'medium'),
 506             'longtext' => array('text', 'long'),
 507         );
 508         if (isset($map[$type])) {
 509             return $map[$type];
 510         } else {
 511             return array($type, null);
 512         }
 513     }
 514
 515     function typeAndSize($column)
 516     {
 517         if ($column['type'] == 'enum') {
 518             $vals = array_map(array($this, 'quote'), $column['enum']);
 519             return 'enum(' . implode(',', $vals) . ')';
 520         } else if ($this->_isString($column)) {
 521             return parent::typeAndSize($column) . ' CHARSET utf8';
 522         } else {
 523             return parent::typeAndSize($column);
 524         }
 525     }
 526
 527     /**
 528      * Filter the given table definition array to match features available
 529      * in this database.
 530      *
 531      * This lets us strip out unsupported things like comments, foreign keys,
 532      * or type variants that we wouldn't get back from getTableDef().
 533      *
 534      * @param array $tableDef
 535      */
 536     function filterDef(array $tableDef)
 537     {
 538         // @fixme add foreign-key support for MySQL
 539         unset($tableDef['foreign keys']);
 540         return $tableDef;
 541     }
 542 }