includes/installer/DatabaseUpdater.php

   1 <?php
   2 /**
   3  * DBMS-specific updater helper.
   4  *
   5  * @file
   6  * @ingroup Deployment
   7  */
   8
   9 require_once( dirname(__FILE__) . '/../../maintenance/Maintenance.php' );
  10
  11 /*
  12  * Class for handling database updates. Roughly based off of updaters.inc, with
  13  * a few improvements :)
  14  *
  15  * @ingroup Deployment
  16  * @since 1.17
  17  */
  18 abstract class DatabaseUpdater {
  19
  20         /**
  21          * Array of updates to perform on the database
  22          *
  23          * @var array
  24          */
  25         protected $updates = array();
  26
  27         /**
  28          * List of extension-provided database updates
  29          * @var array
  30          */
  31         protected $extensionUpdates = array();
  32
  33         /**
  34          * Used to hold schema files during installation process
  35          * @var array
  36          */
  37         protected $newExtensions = array();
  38
  39         /**
  40          * Handle to the database subclass
  41          *
  42          * @var DatabaseBase
  43          */
  44         protected $db;
  45
  46         protected $shared = false;
  47
  48         protected $postDatabaseUpdateMaintenance = array(
  49                 'DeleteDefaultMessages'
  50         );
  51
  52         /**
  53          * Constructor
  54          *
  55          * @param $db DatabaseBase object to perform updates on
  56          * @param $shared bool Whether to perform updates on shared tables
  57          * @param $maintenance Maintenance Maintenance object which created us
  58          */
  59         protected function __construct( DatabaseBase &$db, $shared, Maintenance $maintenance = null ) {
  60                 $this->db = $db;
  61                 $this->db->setFlag( DBO_DDLMODE ); // For Oracle's handling of schema files
  62                 $this->shared = $shared;
  63                 if ( $maintenance ) {
  64                         $this->maintenance = $maintenance;
  65                 } else {
  66                         $this->maintenance = new FakeMaintenance;
  67                 }
  68                 $this->initOldGlobals();
  69                 wfRunHooks( 'LoadExtensionSchemaUpdates', array( $this ) );
  70         }
  71
  72         /**
  73          * Initialize all of the old globals. One day this should all become
  74          * something much nicer
  75          */
  76         private function initOldGlobals() {
  77                 global $wgExtNewTables, $wgExtNewFields, $wgExtPGNewFields,
  78                         $wgExtPGAlteredFields, $wgExtNewIndexes, $wgExtModifiedFields;
  79
  80                 # For extensions only, should be populated via hooks
  81                 # $wgDBtype should be checked to specifiy the proper file
  82                 $wgExtNewTables = array(); // table, dir
  83                 $wgExtNewFields = array(); // table, column, dir
  84                 $wgExtPGNewFields = array(); // table, column, column attributes; for PostgreSQL
  85                 $wgExtPGAlteredFields = array(); // table, column, new type, conversion method; for PostgreSQL
  86                 $wgExtNewIndexes = array(); // table, index, dir
  87                 $wgExtModifiedFields = array(); // table, index, dir
  88         }
  89
  90         /**
  91          * @static
  92          * @throws MWException
  93          * @param DatabaseBase $db
  94          * @param bool $shared
  95          * @param null $maintenance
  96          * @return DatabaseUpdater
  97          */
  98         public static function newForDB( &$db, $shared = false, $maintenance = null ) {
  99                 $type = $db->getType();
 100                 if( in_array( $type, Installer::getDBTypes() ) ) {
 101                         $class = ucfirst( $type ) . 'Updater';
 102                         return new $class( $db, $shared, $maintenance );
 103                 } else {
 104                         throw new MWException( __METHOD__ . ' called for unsupported $wgDBtype' );
 105                 }
 106         }
 107
 108         /**
 109          * Get a database connection to run updates
 110          *
 111          * @return DatabaseBase
 112          */
 113         public function getDB() {
 114                 return $this->db;
 115         }
 116
 117         /**
 118          * Output some text. If we're running from web, escape the text first.
 119          *
 120          * @param $str String: Text to output
 121          */
 122         public function output( $str ) {
 123                 if ( $this->maintenance->isQuiet() ) {
 124                         return;
 125                 }
 126                 global $wgCommandLineMode;
 127                 if( !$wgCommandLineMode ) {
 128                         $str = htmlspecialchars( $str );
 129                 }
 130                 echo $str;
 131                 flush();
 132         }
 133
 134         /**
 135          * Add a new update coming from an extension. This should be called by
 136          * extensions while executing the LoadExtensionSchemaUpdates hook.
 137          *
 138          * @param $update Array: the update to run. Format is the following:
 139          *                first item is the callback function, it also can be a
 140          *                simple string with the name of a function in this class,
 141          *                following elements are parameters to the function.
 142          *                Note that callback functions will receive this object as
 143          *                first parameter.
 144          */
 145         public function addExtensionUpdate( Array $update ) {
 146                 $this->extensionUpdates[] = $update;
 147         }
 148
 149         /**
 150          * Convenience wrapper for addExtensionUpdate() when adding a new table (which
 151          * is the most common usage of updaters in an extension)
 152          * @param $tableName String Name of table to create
 153          * @param $sqlPath String Full path to the schema file
 154          */
 155         public function addExtensionTable( $tableName, $sqlPath ) {
 156                 $this->extensionUpdates[] = array( 'addTable', $tableName, $sqlPath, true );
 157         }
 158
 159         /**
 160          * Add a brand new extension to MediaWiki. Used during the initial install
 161          * @param $ext String Name of extension
 162          * @param $sqlPath String Full path to the schema file
 163          */
 164         public function addNewExtension( $ext, $sqlPath ) {
 165                 $this->newExtensions[ strtolower( $ext ) ] = $sqlPath;
 166         }
 167
 168         /**
 169          * Get the list of extensions that registered a schema with our DB type
 170          * @return array
 171          */
 172         public function getNewExtensions() {
 173                 return $this->newExtensions;
 174         }
 175
 176         /**
 177          * Get the list of extension-defined updates
 178          *
 179          * @return Array
 180          */
 181         protected function getExtensionUpdates() {
 182                 return $this->extensionUpdates;
 183         }
 184
 185         public function getPostDatabaseUpdateMaintenance() {
 186                 return $this->postDatabaseUpdateMaintenance;
 187         }
 188
 189         /**
 190          * Do all the updates
 191          *
 192          * @param $what Array: what updates to perform
 193          */
 194         public function doUpdates( $what = array( 'core', 'extensions', 'purge' ) ) {
 195                 global $wgVersion;
 196
 197                 $what = array_flip( $what );
 198                 if ( isset( $what['core'] ) ) {
 199                         $this->runUpdates( $this->getCoreUpdateList(), false );
 200                 }
 201                 if ( isset( $what['extensions'] ) ) {
 202                         $this->runUpdates( $this->getOldGlobalUpdates(), false );
 203                         $this->runUpdates( $this->getExtensionUpdates(), true );
 204                 }
 205
 206                 $this->setAppliedUpdates( $wgVersion, $this->updates );
 207
 208                 if( isset( $what['purge'] ) ) {
 209                         $this->purgeCache();
 210                 }
 211                 if ( isset( $what['core'] ) ) {
 212                         $this->checkStats();
 213                 }
 214         }
 215
 216         /**
 217          * Helper function for doUpdates()
 218          *
 219          * @param $updates Array of updates to run
 220          * @param $passSelf Boolean: whether to pass this object we calling external
 221          *                  functions
 222          */
 223         private function runUpdates( array $updates, $passSelf ) {
 224                 foreach ( $updates as $params ) {
 225                         $func = array_shift( $params );
 226                         if( !is_array( $func ) && method_exists( $this, $func ) ) {
 227                                 $func = array( $this, $func );
 228                         } elseif ( $passSelf ) {
 229                                 array_unshift( $params, $this );
 230                         }
 231                         call_user_func_array( $func, $params );
 232                         flush();
 233                 }
 234                 $this->updates = array_merge( $this->updates, $updates );
 235         }
 236
 237         protected function setAppliedUpdates( $version, $updates = array() ) {
 238                 if( !$this->canUseNewUpdatelog() ) {
 239                         return;
 240                 }
 241                 $key = "updatelist-$version-" . time();
 242                 $this->db->insert( 'updatelog',
 243                         array( 'ul_key' => $key, 'ul_value' => serialize( $updates ) ),
 244                          __METHOD__ );
 245         }
 246
 247         /**
 248          * Helper function: check if the given key is present in the updatelog table.
 249          * Obviously, only use this for updates that occur after the updatelog table was
 250          * created!
 251          */
 252         public function updateRowExists( $key ) {
 253                 $row = $this->db->selectRow(
 254                         'updatelog',
 255                         '1',
 256                         array( 'ul_key' => $key ),
 257                         __METHOD__
 258                 );
 259                 return (bool)$row;
 260         }
 261
 262         /**
 263          * Updatelog was changed in 1.17 to have a ul_value column so we can record
 264          * more information about what kind of updates we've done (that's what this
 265          * class does). Pre-1.17 wikis won't have this column, and really old wikis
 266          * might not even have updatelog at all
 267          *
 268          * @return boolean
 269          */
 270         protected function canUseNewUpdatelog() {
 271                 return $this->db->tableExists( 'updatelog' ) &&
 272                         $this->db->fieldExists( 'updatelog', 'ul_value' );
 273         }
 274
 275         /**
 276          * Before 1.17, we used to handle updates via stuff like
 277          * $wgExtNewTables/Fields/Indexes. This is nasty :) We refactored a lot
 278          * of this in 1.17 but we want to remain back-compatible for a while. So
 279          * load up these old global-based things into our update list.
 280          */
 281         protected function getOldGlobalUpdates() {
 282                 global $wgExtNewFields, $wgExtNewTables, $wgExtModifiedFields,
 283                         $wgExtNewIndexes, $wgSharedDB, $wgSharedTables;
 284
 285                 $doUser = $this->shared ?
 286                         $wgSharedDB && in_array( 'user', $wgSharedTables ) :
 287                         !$wgSharedDB || !in_array( 'user', $wgSharedTables );
 288
 289                 $updates = array();
 290
 291                 foreach ( $wgExtNewTables as $tableRecord ) {
 292                         $updates[] = array(
 293                                 'addTable', $tableRecord[0], $tableRecord[1], true
 294                         );
 295                 }
 296
 297                 foreach ( $wgExtNewFields as $fieldRecord ) {
 298                         if ( $fieldRecord[0] != 'user' || $doUser ) {
 299                                 $updates[] = array(
 300                                         'addField', $fieldRecord[0], $fieldRecord[1],
 301                                                 $fieldRecord[2], true
 302                                 );
 303                         }
 304                 }
 305
 306                 foreach ( $wgExtNewIndexes as $fieldRecord ) {
 307                         $updates[] = array(
 308                                 'addIndex', $fieldRecord[0], $fieldRecord[1],
 309                                         $fieldRecord[2], true
 310                         );
 311                 }
 312
 313                 foreach ( $wgExtModifiedFields as $fieldRecord ) {
 314                         $updates[] = array(
 315                                 'modifyField', $fieldRecord[0], $fieldRecord[1],
 316                                         $fieldRecord[2], true
 317                         );
 318                 }
 319
 320                 return $updates;
 321         }
 322
 323         /**
 324          * Get an array of updates to perform on the database. Should return a
 325          * multi-dimensional array. The main key is the MediaWiki version (1.12,
 326          * 1.13...) with the values being arrays of updates, identical to how
 327          * updaters.inc did it (for now)
 328          *
 329          * @return Array
 330          */
 331         protected abstract function getCoreUpdateList();
 332
 333         /**
 334          * Applies a SQL patch
 335          * @param $path String Path to the patch file
 336          * @param $isFullPath Boolean Whether to treat $path as a relative or not
 337          */
 338         protected function applyPatch( $path, $isFullPath = false ) {
 339                 if ( $isFullPath ) {
 340                         $this->db->sourceFile( $path );
 341                 } else {
 342                         $this->db->sourceFile( $this->db->patchPath( $path ) );
 343                 }
 344         }
 345
 346         /**
 347          * Add a new table to the database
 348          * @param $name String Name of the new table
 349          * @param $patch String Path to the patch file
 350          * @param $fullpath Boolean Whether to treat $patch path as a relative or not
 351          */
 352         protected function addTable( $name, $patch, $fullpath = false ) {
 353                 if ( $this->db->tableExists( $name ) ) {
 354                         $this->output( "...$name table already exists.\n" );
 355                 } else {
 356                         $this->output( "Creating $name table..." );
 357                         $this->applyPatch( $patch, $fullpath );
 358                         $this->output( "ok\n" );
 359                 }
 360         }
 361
 362         /**
 363          * Add a new field to an existing table
 364          * @param $table String Name of the table to modify
 365          * @param $field String Name of the new field
 366          * @param $patch String Path to the patch file
 367          * @param $fullpath Boolean Whether to treat $patch path as a relative or not
 368          */
 369         protected function addField( $table, $field, $patch, $fullpath = false ) {
 370                 if ( !$this->db->tableExists( $table ) ) {
 371                         $this->output( "...$table table does not exist, skipping new field patch\n" );
 372                 } elseif ( $this->db->fieldExists( $table, $field ) ) {
 373                         $this->output( "...have $field field in $table table.\n" );
 374                 } else {
 375                         $this->output( "Adding $field field to table $table..." );
 376                         $this->applyPatch( $patch, $fullpath );
 377                         $this->output( "ok\n" );
 378                 }
 379         }
 380
 381         /**
 382          * Add a new index to an existing table
 383          * @param $table String Name of the table to modify
 384          * @param $index String Name of the new index
 385          * @param $patch String Path to the patch file
 386          * @param $fullpath Boolean Whether to treat $patch path as a relative or not
 387          */
 388         protected function addIndex( $table, $index, $patch, $fullpath = false ) {
 389                 if ( $this->db->indexExists( $table, $index ) ) {
 390                         $this->output( "...$index key already set on $table table.\n" );
 391                 } else {
 392                         $this->output( "Adding $index key to table $table... " );
 393                         $this->applyPatch( $patch, $fullpath );
 394                         $this->output( "ok\n" );
 395                 }
 396         }
 397
 398         /**
 399          * Drop a field from an existing table
 400          *
 401          * @param $table String Name of the table to modify
 402          * @param $field String Name of the old field
 403          * @param $patch String Path to the patch file
 404          * @param $fullpath Boolean Whether to treat $patch path as a relative or not
 405          */
 406         protected function dropField( $table, $field, $patch, $fullpath = false ) {
 407                 if ( $this->db->fieldExists( $table, $field ) ) {
 408                         $this->output( "Table $table contains $field field. Dropping... " );
 409                         $this->applyPatch( $patch, $fullpath );
 410                         $this->output( "ok\n" );
 411                 } else {
 412                         $this->output( "...$table table does not contain $field field.\n" );
 413                 }
 414         }
 415
 416         /**
 417          * Drop an index from an existing table
 418          *
 419          * @param $table String: Name of the table to modify
 420          * @param $index String: Name of the old index
 421          * @param $patch String: Path to the patch file
 422          * @param $fullpath Boolean: Whether to treat $patch path as a relative or not
 423          */
 424         protected function dropIndex( $table, $index, $patch, $fullpath = false ) {
 425                 if ( $this->db->indexExists( $table, $index ) ) {
 426                         $this->output( "Dropping $index from table $table... " );
 427                         $this->applyPatch( $patch, $fullpath );
 428                         $this->output( "ok\n" );
 429                 } else {
 430                         $this->output( "...$index key doesn't exist.\n" );
 431                 }
 432         }
 433
 434         /**
 435          * Modify an existing field
 436          *
 437          * @param $table String: name of the table to which the field belongs
 438          * @param $field String: name of the field to modify
 439          * @param $patch String: path to the patch file
 440          * @param $fullpath Boolean: whether to treat $patch path as a relative or not
 441          */
 442         public function modifyField( $table, $field, $patch, $fullpath = false ) {
 443                 if ( !$this->db->tableExists( $table ) ) {
 444                         $this->output( "...$table table does not exist, skipping modify field patch\n" );
 445                 } elseif ( !$this->db->fieldExists( $table, $field ) ) {
 446                         $this->output( "...$field field does not exist in $table table, skipping modify field patch\n" );
 447                 } else {
 448                         $this->output( "Modifying $field field of table $table..." );
 449                         $this->applyPatch( $patch, $fullpath );
 450                         $this->output( "ok\n" );
 451                 }
 452         }
 453
 454         /**
 455          * Purge the objectcache table
 456          */
 457         protected function purgeCache() {
 458                 # We can't guarantee that the user will be able to use TRUNCATE,
 459                 # but we know that DELETE is available to us
 460                 $this->output( "Purging caches..." );
 461                 $this->db->delete( 'objectcache', '*', __METHOD__ );
 462                 $this->output( "done.\n" );
 463         }
 464
 465         /**
 466          * Check the site_stats table is not properly populated.
 467          */
 468         protected function checkStats() {
 469                 $this->output( "Checking site_stats row..." );
 470                 $row = $this->db->selectRow( 'site_stats', '*', array( 'ss_row_id' => 1 ), __METHOD__ );
 471                 if ( $row === false ) {
 472                         $this->output( "data is missing! rebuilding...\n" );
 473                 } elseif ( isset( $row->site_stats ) && $row->ss_total_pages == -1 ) {
 474                         $this->output( "missing ss_total_pages, rebuilding...\n" );
 475                 } else {
 476                         $this->output( "done.\n" );
 477                         return;
 478                 }
 479                 SiteStatsInit::doAllAndCommit( false );
 480         }
 481
 482         # Common updater functions
 483
 484         protected function doActiveUsersInit() {
 485                 $activeUsers = $this->db->selectField( 'site_stats', 'ss_active_users', false, __METHOD__ );
 486                 if ( $activeUsers == -1 ) {
 487                         $activeUsers = $this->db->selectField( 'recentchanges',
 488                                 'COUNT( DISTINCT rc_user_text )',
 489                                 array( 'rc_user != 0', 'rc_bot' => 0, "rc_log_type != 'newusers'" ), __METHOD__
 490                         );
 491                         $this->db->update( 'site_stats',
 492                                 array( 'ss_active_users' => intval( $activeUsers ) ),
 493                                 array( 'ss_row_id' => 1 ), __METHOD__, array( 'LIMIT' => 1 )
 494                         );
 495                 }
 496                 $this->output( "...ss_active_users user count set...\n" );
 497         }
 498
 499         protected function doLogUsertextPopulation() {
 500                 if ( $this->updateRowExists( 'populate log_usertext' ) ) {
 501                         $this->output( "...log_user_text field already populated.\n" );
 502                         return;
 503                 }
 504
 505                 $this->output(
 506                         "Populating log_user_text field, printing progress markers. For large\n" .
 507                         "databases, you may want to hit Ctrl-C and do this manually with\n" .
 508                         "maintenance/populateLogUsertext.php.\n" );
 509                 $task = new PopulateLogUsertext();
 510                 $task->execute();
 511                 $this->output( "Done populating log_user_text field.\n" );
 512         }
 513
 514         protected function doLogSearchPopulation() {
 515                 if ( $this->updateRowExists( 'populate log_search' ) ) {
 516                         $this->output( "...log_search table already populated.\n" );
 517                         return;
 518                 }
 519
 520                 $this->output(
 521                         "Populating log_search table, printing progress markers. For large\n" .
 522                         "databases, you may want to hit Ctrl-C and do this manually with\n" .
 523                         "maintenance/populateLogSearch.php.\n" );
 524                 $task = new PopulateLogSearch();
 525                 $task->execute();
 526                 $this->output( "Done populating log_search table.\n" );
 527         }
 528
 529         protected function doUpdateTranscacheField() {
 530                 if ( $this->updateRowExists( 'convert transcache field' ) ) {
 531                         $this->output( "...transcache tc_time already converted.\n" );
 532                         return;
 533                 }
 534
 535                 $this->output( "Converting tc_time from UNIX epoch to MediaWiki timestamp... " );
 536                 $this->applyPatch( 'patch-tc-timestamp.sql' );
 537                 $this->output( "ok\n" );
 538         }
 539
 540         protected function doCollationUpdate() {
 541                 global $wgCategoryCollation;
 542                 if ( $this->db->selectField(
 543                         'categorylinks',
 544                         'COUNT(*)',
 545                         'cl_collation != ' . $this->db->addQuotes( $wgCategoryCollation ),
 546                         __METHOD__
 547                 ) == 0 ) {
 548                         $this->output( "...collations up-to-date.\n" );
 549                         return;
 550                 }
 551
 552                 $task = new UpdateCollation();
 553                 $task->execute();
 554         }
 555 }