includes/installer/DatabaseUpdater.php

   1 <?php
   2 /**
   3  * DBMS-specific updater helper.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @ingroup Deployment
  22  */
  23
  24 require_once __DIR__ . '/../../maintenance/Maintenance.php';
  25
  26 /**
  27  * Class for handling database updates. Roughly based off of updaters.inc, with
  28  * a few improvements :)
  29  *
  30  * @ingroup Deployment
  31  * @since 1.17
  32  */
  33 abstract class DatabaseUpdater {
  34
  35         /**
  36          * Array of updates to perform on the database
  37          *
  38          * @var array
  39          */
  40         protected $updates = array();
  41
  42         /**
  43          * Array of updates that were skipped
  44          *
  45          * @var array
  46          */
  47         protected $updatesSkipped = array();
  48
  49         /**
  50          * List of extension-provided database updates
  51          * @var array
  52          */
  53         protected $extensionUpdates = array();
  54
  55         /**
  56          * Handle to the database subclass
  57          *
  58          * @var DatabaseBase
  59          */
  60         protected $db;
  61
  62         protected $shared = false;
  63
  64         /**
  65          * Scripts to run after database update
  66          * Should be a subclass of LoggedUpdateMaintenance
  67          */
  68         protected $postDatabaseUpdateMaintenance = array(
  69                 'DeleteDefaultMessages',
  70                 'PopulateRevisionLength',
  71                 'PopulateRevisionSha1',
  72                 'PopulateImageSha1',
  73                 'FixExtLinksProtocolRelative',
  74                 'PopulateFilearchiveSha1',
  75         );
  76
  77         /**
  78          * File handle for SQL output.
  79          *
  80          * @var resource
  81          */
  82         protected $fileHandle = null;
  83
  84         /**
  85          * Flag specifying whether or not to skip schema (e.g. SQL-only) updates.
  86          *
  87          * @var bool
  88          */
  89         protected $skipSchema = false;
  90
  91         /**
  92          * Hold the value of $wgContentHandlerUseDB during the upgrade.
  93          */
  94         protected $holdContentHandlerUseDB = true;
  95
  96         /**
  97          * Constructor
  98          *
  99          * @param DatabaseBase $db To perform updates on
 100          * @param bool $shared Whether to perform updates on shared tables
 101          * @param Maintenance $maintenance Maintenance object which created us
 102          */
 103         protected function __construct( DatabaseBase &$db, $shared, Maintenance $maintenance = null ) {
 104                 $this->db = $db;
 105                 $this->db->setFlag( DBO_DDLMODE ); // For Oracle's handling of schema files
 106                 $this->shared = $shared;
 107                 if ( $maintenance ) {
 108                         $this->maintenance = $maintenance;
 109                         $this->fileHandle = $maintenance->fileHandle;
 110                 } else {
 111                         $this->maintenance = new FakeMaintenance;
 112                 }
 113                 $this->maintenance->setDB( $db );
 114                 $this->initOldGlobals();
 115                 $this->loadExtensions();
 116                 wfRunHooks( 'LoadExtensionSchemaUpdates', array( $this ) );
 117         }
 118
 119         /**
 120          * Initialize all of the old globals. One day this should all become
 121          * something much nicer
 122          */
 123         private function initOldGlobals() {
 124                 global $wgExtNewTables, $wgExtNewFields, $wgExtPGNewFields,
 125                         $wgExtPGAlteredFields, $wgExtNewIndexes, $wgExtModifiedFields;
 126
 127                 # For extensions only, should be populated via hooks
 128                 # $wgDBtype should be checked to specifiy the proper file
 129                 $wgExtNewTables = array(); // table, dir
 130                 $wgExtNewFields = array(); // table, column, dir
 131                 $wgExtPGNewFields = array(); // table, column, column attributes; for PostgreSQL
 132                 $wgExtPGAlteredFields = array(); // table, column, new type, conversion method; for PostgreSQL
 133                 $wgExtNewIndexes = array(); // table, index, dir
 134                 $wgExtModifiedFields = array(); // table, index, dir
 135         }
 136
 137         /**
 138          * Loads LocalSettings.php, if needed, and initialises everything needed for
 139          * LoadExtensionSchemaUpdates hook.
 140          */
 141         private function loadExtensions() {
 142                 if ( !defined( 'MEDIAWIKI_INSTALL' ) ) {
 143                         return; // already loaded
 144                 }
 145                 $vars = Installer::getExistingLocalSettings();
 146                 if ( !$vars ) {
 147                         return; // no LocalSettings found
 148                 }
 149                 if ( !isset( $vars['wgHooks'] ) || !isset( $vars['wgHooks']['LoadExtensionSchemaUpdates'] ) ) {
 150                         return;
 151                 }
 152                 global $wgHooks, $wgAutoloadClasses;
 153                 $wgHooks['LoadExtensionSchemaUpdates'] = $vars['wgHooks']['LoadExtensionSchemaUpdates'];
 154                 $wgAutoloadClasses = $wgAutoloadClasses + $vars['wgAutoloadClasses'];
 155         }
 156
 157         /**
 158          * @throws MWException
 159          * @param DatabaseBase $db
 160          * @param bool $shared
 161          * @param null $maintenance
 162          * @return DatabaseUpdater
 163          */
 164         public static function newForDB( &$db, $shared = false, $maintenance = null ) {
 165                 $type = $db->getType();
 166                 if ( in_array( $type, Installer::getDBTypes() ) ) {
 167                         $class = ucfirst( $type ) . 'Updater';
 168
 169                         return new $class( $db, $shared, $maintenance );
 170                 } else {
 171                         throw new MWException( __METHOD__ . ' called for unsupported $wgDBtype' );
 172                 }
 173         }
 174
 175         /**
 176          * Get a database connection to run updates
 177          *
 178          * @return DatabaseBase
 179          */
 180         public function getDB() {
 181                 return $this->db;
 182         }
 183
 184         /**
 185          * Output some text. If we're running from web, escape the text first.
 186          *
 187          * @param string $str Text to output
 188          */
 189         public function output( $str ) {
 190                 if ( $this->maintenance->isQuiet() ) {
 191                         return;
 192                 }
 193                 global $wgCommandLineMode;
 194                 if ( !$wgCommandLineMode ) {
 195                         $str = htmlspecialchars( $str );
 196                 }
 197                 echo $str;
 198                 flush();
 199         }
 200
 201         /**
 202          * Add a new update coming from an extension. This should be called by
 203          * extensions while executing the LoadExtensionSchemaUpdates hook.
 204          *
 205          * @since 1.17
 206          *
 207          * @param array $update The update to run. Format is the following:
 208          *                first item is the callback function, it also can be a
 209          *                simple string with the name of a function in this class,
 210          *                following elements are parameters to the function.
 211          *                Note that callback functions will receive this object as
 212          *                first parameter.
 213          */
 214         public function addExtensionUpdate( array $update ) {
 215                 $this->extensionUpdates[] = $update;
 216         }
 217
 218         /**
 219          * Convenience wrapper for addExtensionUpdate() when adding a new table (which
 220          * is the most common usage of updaters in an extension)
 221          *
 222          * @since 1.18
 223          *
 224          * @param string $tableName Name of table to create
 225          * @param string $sqlPath Full path to the schema file
 226          */
 227         public function addExtensionTable( $tableName, $sqlPath ) {
 228                 $this->extensionUpdates[] = array( 'addTable', $tableName, $sqlPath, true );
 229         }
 230
 231         /**
 232          * @since 1.19
 233          *
 234          * @param $tableName string
 235          * @param $indexName string
 236          * @param $sqlPath string
 237          */
 238         public function addExtensionIndex( $tableName, $indexName, $sqlPath ) {
 239                 $this->extensionUpdates[] = array( 'addIndex', $tableName, $indexName, $sqlPath, true );
 240         }
 241
 242         /**
 243          *
 244          * @since 1.19
 245          *
 246          * @param $tableName string
 247          * @param $columnName string
 248          * @param $sqlPath string
 249          */
 250         public function addExtensionField( $tableName, $columnName, $sqlPath ) {
 251                 $this->extensionUpdates[] = array( 'addField', $tableName, $columnName, $sqlPath, true );
 252         }
 253
 254         /**
 255          *
 256          * @since 1.20
 257          *
 258          * @param $tableName string
 259          * @param $columnName string
 260          * @param $sqlPath string
 261          */
 262         public function dropExtensionField( $tableName, $columnName, $sqlPath ) {
 263                 $this->extensionUpdates[] = array( 'dropField', $tableName, $columnName, $sqlPath, true );
 264         }
 265
 266         /**
 267          * Drop an index from an extension table
 268          *
 269          * @since 1.21
 270          *
 271          * @param string $tableName The table name
 272          * @param string $indexName The index name
 273          * @param string $sqlPath The path to the SQL change path
 274          */
 275         public function dropExtensionIndex( $tableName, $indexName, $sqlPath ) {
 276                 $this->extensionUpdates[] = array( 'dropIndex', $tableName, $indexName, $sqlPath, true );
 277         }
 278
 279         /**
 280          *
 281          * @since 1.20
 282          *
 283          * @param $tableName string
 284          * @param $sqlPath string
 285          */
 286         public function dropExtensionTable( $tableName, $sqlPath ) {
 287                 $this->extensionUpdates[] = array( 'dropTable', $tableName, $sqlPath, true );
 288         }
 289
 290         /**
 291          * Rename an index on an extension table
 292          *
 293          * @since 1.21
 294          *
 295          * @param string $tableName The table name
 296          * @param string $oldIndexName The old index name
 297          * @param string $newIndexName The new index name
 298          * @param $skipBothIndexExistWarning Boolean: Whether to warn if both the old
 299          * and the new indexes exist. [facultative; by default, false]
 300          * @param string $sqlPath The path to the SQL change path
 301          */
 302         public function renameExtensionIndex( $tableName, $oldIndexName, $newIndexName,
 303                 $sqlPath, $skipBothIndexExistWarning = false
 304         ) {
 305                 $this->extensionUpdates[] = array(
 306                         'renameIndex',
 307                         $tableName,
 308                         $oldIndexName,
 309                         $newIndexName,
 310                         $skipBothIndexExistWarning,
 311                         $sqlPath,
 312                         true
 313                 );
 314         }
 315
 316         /**
 317          * @since 1.21
 318          *
 319          * @param string $tableName The table name
 320          * @param string $fieldName The field to be modified
 321          * @param string $sqlPath The path to the SQL change path
 322          */
 323         public function modifyExtensionField( $tableName, $fieldName, $sqlPath ) {
 324                 $this->extensionUpdates[] = array( 'modifyField', $tableName, $fieldName, $sqlPath, true );
 325         }
 326
 327         /**
 328          *
 329          * @since 1.20
 330          *
 331          * @param $tableName string
 332          * @return bool
 333          */
 334         public function tableExists( $tableName ) {
 335                 return ( $this->db->tableExists( $tableName, __METHOD__ ) );
 336         }
 337
 338         /**
 339          * Add a maintenance script to be run after the database updates are complete.
 340          *
 341          * Script should subclass LoggedUpdateMaintenance
 342          *
 343          * @since 1.19
 344          *
 345          * @param string $class Name of a Maintenance subclass
 346          */
 347         public function addPostDatabaseUpdateMaintenance( $class ) {
 348                 $this->postDatabaseUpdateMaintenance[] = $class;
 349         }
 350
 351         /**
 352          * Get the list of extension-defined updates
 353          *
 354          * @return Array
 355          */
 356         protected function getExtensionUpdates() {
 357                 return $this->extensionUpdates;
 358         }
 359
 360         /**
 361          * @since 1.17
 362          *
 363          * @return array
 364          */
 365         public function getPostDatabaseUpdateMaintenance() {
 366                 return $this->postDatabaseUpdateMaintenance;
 367         }
 368
 369         /**
 370          * @since 1.21
 371          *
 372          * Writes the schema updates desired to a file for the DB Admin to run.
 373          */
 374         private function writeSchemaUpdateFile( $schemaUpdate = array() ) {
 375                 $updates = $this->updatesSkipped;
 376                 $this->updatesSkipped = array();
 377
 378                 foreach ( $updates as $funcList ) {
 379                         $func = $funcList[0];
 380                         $arg = $funcList[1];
 381                         $origParams = $funcList[2];
 382                         call_user_func_array( $func, $arg );
 383                         flush();
 384                         $this->updatesSkipped[] = $origParams;
 385                 }
 386         }
 387
 388         /**
 389          * Do all the updates
 390          *
 391          * @param array $what What updates to perform
 392          */
 393         public function doUpdates( $what = array( 'core', 'extensions', 'stats' ) ) {
 394                 global $wgVersion;
 395
 396                 $this->db->begin( __METHOD__ );
 397                 $what = array_flip( $what );
 398                 $this->skipSchema = isset( $what['noschema'] ) || $this->fileHandle !== null;
 399                 if ( isset( $what['core'] ) ) {
 400                         $this->runUpdates( $this->getCoreUpdateList(), false );
 401                 }
 402                 if ( isset( $what['extensions'] ) ) {
 403                         $this->runUpdates( $this->getOldGlobalUpdates(), false );
 404                         $this->runUpdates( $this->getExtensionUpdates(), true );
 405                 }
 406
 407                 if ( isset( $what['stats'] ) ) {
 408                         $this->checkStats();
 409                 }
 410
 411                 $this->setAppliedUpdates( $wgVersion, $this->updates );
 412
 413                 if ( $this->fileHandle ) {
 414                         $this->skipSchema = false;
 415                         $this->writeSchemaUpdateFile();
 416                         $this->setAppliedUpdates( "$wgVersion-schema", $this->updatesSkipped );
 417                 }
 418
 419                 $this->db->commit( __METHOD__ );
 420         }
 421
 422         /**
 423          * Helper function for doUpdates()
 424          *
 425          * @param array $updates of updates to run
 426          * @param bool $passSelf Whether to pass this object we calling external
 427          *                  functions
 428          */
 429         private function runUpdates( array $updates, $passSelf ) {
 430                 $updatesDone = array();
 431                 $updatesSkipped = array();
 432                 foreach ( $updates as $params ) {
 433                         $origParams = $params;
 434                         $func = array_shift( $params );
 435                         if ( !is_array( $func ) && method_exists( $this, $func ) ) {
 436                                 $func = array( $this, $func );
 437                         } elseif ( $passSelf ) {
 438                                 array_unshift( $params, $this );
 439                         }
 440                         $ret = call_user_func_array( $func, $params );
 441                         flush();
 442                         if ( $ret !== false ) {
 443                                 $updatesDone[] = $origParams;
 444                         } else {
 445                                 $updatesSkipped[] = array( $func, $params, $origParams );
 446                         }
 447                 }
 448                 $this->updatesSkipped = array_merge( $this->updatesSkipped, $updatesSkipped );
 449                 $this->updates = array_merge( $this->updates, $updatesDone );
 450         }
 451
 452         /**
 453          * @param string $version
 454          * @param array $updates
 455          */
 456         protected function setAppliedUpdates( $version, $updates = array() ) {
 457                 $this->db->clearFlag( DBO_DDLMODE );
 458                 if ( !$this->canUseNewUpdatelog() ) {
 459                         return;
 460                 }
 461                 $key = "updatelist-$version-" . time();
 462                 $this->db->insert( 'updatelog',
 463                         array( 'ul_key' => $key, 'ul_value' => serialize( $updates ) ),
 464                         __METHOD__ );
 465                 $this->db->setFlag( DBO_DDLMODE );
 466         }
 467
 468         /**
 469          * Helper function: check if the given key is present in the updatelog table.
 470          * Obviously, only use this for updates that occur after the updatelog table was
 471          * created!
 472          * @param string $key Name of the key to check for
 473          * @return bool
 474          */
 475         public function updateRowExists( $key ) {
 476                 $row = $this->db->selectRow(
 477                         'updatelog',
 478                         '1',
 479                         array( 'ul_key' => $key ),
 480                         __METHOD__
 481                 );
 482
 483                 return (bool)$row;
 484         }
 485
 486         /**
 487          * Helper function: Add a key to the updatelog table
 488          * Obviously, only use this for updates that occur after the updatelog table was
 489          * created!
 490          * @param string $key Name of key to insert
 491          * @param string $val [optional] Value to insert along with the key
 492          */
 493         public function insertUpdateRow( $key, $val = null ) {
 494                 $this->db->clearFlag( DBO_DDLMODE );
 495                 $values = array( 'ul_key' => $key );
 496                 if ( $val && $this->canUseNewUpdatelog() ) {
 497                         $values['ul_value'] = $val;
 498                 }
 499                 $this->db->insert( 'updatelog', $values, __METHOD__, 'IGNORE' );
 500                 $this->db->setFlag( DBO_DDLMODE );
 501         }
 502
 503         /**
 504          * Updatelog was changed in 1.17 to have a ul_value column so we can record
 505          * more information about what kind of updates we've done (that's what this
 506          * class does). Pre-1.17 wikis won't have this column, and really old wikis
 507          * might not even have updatelog at all
 508          *
 509          * @return boolean
 510          */
 511         protected function canUseNewUpdatelog() {
 512                 return $this->db->tableExists( 'updatelog', __METHOD__ ) &&
 513                         $this->db->fieldExists( 'updatelog', 'ul_value', __METHOD__ );
 514         }
 515
 516         /**
 517          * Returns whether updates should be executed on the database table $name.
 518          * Updates will be prevented if the table is a shared table and it is not
 519          * specified to run updates on shared tables.
 520          *
 521          * @param string $name Table name
 522          * @return bool
 523          */
 524         protected function doTable( $name ) {
 525                 global $wgSharedDB, $wgSharedTables;
 526
 527                 // Don't bother to check $wgSharedTables if there isn't a shared database
 528                 // or the user actually also wants to do updates on the shared database.
 529                 if ( $wgSharedDB === null || $this->shared ) {
 530                         return true;
 531                 }
 532
 533                 return !in_array( $name, $wgSharedTables );
 534         }
 535
 536         /**
 537          * Before 1.17, we used to handle updates via stuff like
 538          * $wgExtNewTables/Fields/Indexes. This is nasty :) We refactored a lot
 539          * of this in 1.17 but we want to remain back-compatible for a while. So
 540          * load up these old global-based things into our update list.
 541          *
 542          * @return array
 543          */
 544         protected function getOldGlobalUpdates() {
 545                 global $wgExtNewFields, $wgExtNewTables, $wgExtModifiedFields,
 546                         $wgExtNewIndexes;
 547
 548                 $updates = array();
 549
 550                 foreach ( $wgExtNewTables as $tableRecord ) {
 551                         $updates[] = array(
 552                                 'addTable', $tableRecord[0], $tableRecord[1], true
 553                         );
 554                 }
 555
 556                 foreach ( $wgExtNewFields as $fieldRecord ) {
 557                         $updates[] = array(
 558                                 'addField', $fieldRecord[0], $fieldRecord[1],
 559                                 $fieldRecord[2], true
 560                         );
 561                 }
 562
 563                 foreach ( $wgExtNewIndexes as $fieldRecord ) {
 564                         $updates[] = array(
 565                                 'addIndex', $fieldRecord[0], $fieldRecord[1],
 566                                 $fieldRecord[2], true
 567                         );
 568                 }
 569
 570                 foreach ( $wgExtModifiedFields as $fieldRecord ) {
 571                         $updates[] = array(
 572                                 'modifyField', $fieldRecord[0], $fieldRecord[1],
 573                                 $fieldRecord[2], true
 574                         );
 575                 }
 576
 577                 return $updates;
 578         }
 579
 580         /**
 581          * Get an array of updates to perform on the database. Should return a
 582          * multi-dimensional array. The main key is the MediaWiki version (1.12,
 583          * 1.13...) with the values being arrays of updates, identical to how
 584          * updaters.inc did it (for now)
 585          *
 586          * @return array
 587          */
 588         abstract protected function getCoreUpdateList();
 589
 590         /**
 591          * Append an SQL fragment to the open file handle.
 592          *
 593          * @param string $filename File name to open
 594          */
 595         public function copyFile( $filename ) {
 596                 $this->db->sourceFile( $filename, false, false, false,
 597                         array( $this, 'appendLine' )
 598                 );
 599         }
 600
 601         /**
 602          * Append a line to the open filehandle.  The line is assumed to
 603          * be a complete SQL statement.
 604          *
 605          * This is used as a callback for for sourceLine().
 606          *
 607          * @param string $line Text to append to the file
 608          * @return bool False to skip actually executing the file
 609          * @throws MWException
 610          */
 611         public function appendLine( $line ) {
 612                 $line = rtrim( $line ) . ";\n";
 613                 if ( fwrite( $this->fileHandle, $line ) === false ) {
 614                         throw new MWException( "trouble writing file" );
 615                 }
 616
 617                 return false;
 618         }
 619
 620         /**
 621          * Applies a SQL patch
 622          *
 623          * @param string $path Path to the patch file
 624          * @param $isFullPath Boolean Whether to treat $path as a relative or not
 625          * @param string $msg Description of the patch
 626          * @return bool False if patch is skipped.
 627          */
 628         protected function applyPatch( $path, $isFullPath = false, $msg = null ) {
 629                 if ( $msg === null ) {
 630                         $msg = "Applying $path patch";
 631                 }
 632                 if ( $this->skipSchema ) {
 633                         $this->output( "...skipping schema change ($msg).\n" );
 634
 635                         return false;
 636                 }
 637
 638                 $this->output( "$msg ..." );
 639
 640                 if ( !$isFullPath ) {
 641                         $path = $this->db->patchPath( $path );
 642                 }
 643                 if ( $this->fileHandle !== null ) {
 644                         $this->copyFile( $path );
 645                 } else {
 646                         $this->db->sourceFile( $path );
 647                 }
 648                 $this->output( "done.\n" );
 649
 650                 return true;
 651         }
 652
 653         /**
 654          * Add a new table to the database
 655          *
 656          * @param string $name Name of the new table
 657          * @param string $patch Path to the patch file
 658          * @param bool $fullpath Whether to treat $patch path as a relative or not
 659          * @return bool False if this was skipped because schema changes are skipped
 660          */
 661         protected function addTable( $name, $patch, $fullpath = false ) {
 662                 if ( !$this->doTable( $name ) ) {
 663                         return true;
 664                 }
 665
 666                 if ( $this->db->tableExists( $name, __METHOD__ ) ) {
 667                         $this->output( "...$name table already exists.\n" );
 668                 } else {
 669                         return $this->applyPatch( $patch, $fullpath, "Creating $name table" );
 670                 }
 671
 672                 return true;
 673         }
 674
 675         /**
 676          * Add a new field to an existing table
 677          *
 678          * @param string $table Name of the table to modify
 679          * @param string $field Name of the new field
 680          * @param string $patch Path to the patch file
 681          * @param bool $fullpath Whether to treat $patch path as a relative or not
 682          * @return bool False if this was skipped because schema changes are skipped
 683          */
 684         protected function addField( $table, $field, $patch, $fullpath = false ) {
 685                 if ( !$this->doTable( $table ) ) {
 686                         return true;
 687                 }
 688
 689                 if ( !$this->db->tableExists( $table, __METHOD__ ) ) {
 690                         $this->output( "...$table table does not exist, skipping new field patch.\n" );
 691                 } elseif ( $this->db->fieldExists( $table, $field, __METHOD__ ) ) {
 692                         $this->output( "...have $field field in $table table.\n" );
 693                 } else {
 694                         return $this->applyPatch( $patch, $fullpath, "Adding $field field to table $table" );
 695                 }
 696
 697                 return true;
 698         }
 699
 700         /**
 701          * Add a new index to an existing table
 702          *
 703          * @param string $table Name of the table to modify
 704          * @param string $index Name of the new index
 705          * @param string $patch Path to the patch file
 706          * @param bool $fullpath Whether to treat $patch path as a relative or not
 707          * @return bool False if this was skipped because schema changes are skipped
 708          */
 709         protected function addIndex( $table, $index, $patch, $fullpath = false ) {
 710                 if ( !$this->doTable( $table ) ) {
 711                         return true;
 712                 }
 713
 714                 if ( !$this->db->tableExists( $table, __METHOD__ ) ) {
 715                         $this->output( "...skipping: '$table' table doesn't exist yet.\n" );
 716                 } elseif ( $this->db->indexExists( $table, $index, __METHOD__ ) ) {
 717                         $this->output( "...index $index already set on $table table.\n" );
 718                 } else {
 719                         return $this->applyPatch( $patch, $fullpath, "Adding index $index to table $table" );
 720                 }
 721
 722                 return true;
 723         }
 724
 725         /**
 726          * Drop a field from an existing table
 727          *
 728          * @param string $table Name of the table to modify
 729          * @param string $field Name of the old field
 730          * @param string $patch Path to the patch file
 731          * @param bool $fullpath Whether to treat $patch path as a relative or not
 732          * @return bool False if this was skipped because schema changes are skipped
 733          */
 734         protected function dropField( $table, $field, $patch, $fullpath = false ) {
 735                 if ( !$this->doTable( $table ) ) {
 736                         return true;
 737                 }
 738
 739                 if ( $this->db->fieldExists( $table, $field, __METHOD__ ) ) {
 740                         return $this->applyPatch( $patch, $fullpath, "Table $table contains $field field. Dropping" );
 741                 } else {
 742                         $this->output( "...$table table does not contain $field field.\n" );
 743                 }
 744
 745                 return true;
 746         }
 747
 748         /**
 749          * Drop an index from an existing table
 750          *
 751          * @param string $table Name of the table to modify
 752          * @param string $index Name of the index
 753          * @param string $patch Path to the patch file
 754          * @param bool $fullpath Whether to treat $patch path as a relative or not
 755          * @return bool False if this was skipped because schema changes are skipped
 756          */
 757         protected function dropIndex( $table, $index, $patch, $fullpath = false ) {
 758                 if ( !$this->doTable( $table ) ) {
 759                         return true;
 760                 }
 761
 762                 if ( $this->db->indexExists( $table, $index, __METHOD__ ) ) {
 763                         return $this->applyPatch( $patch, $fullpath, "Dropping $index index from table $table" );
 764                 } else {
 765                         $this->output( "...$index key doesn't exist.\n" );
 766                 }
 767
 768                 return true;
 769         }
 770
 771         /**
 772          * Rename an index from an existing table
 773          *
 774          * @param string $table Name of the table to modify
 775          * @param string $oldIndex Old name of the index
 776          * @param string $newIndex New name of the index
 777          * @param $skipBothIndexExistWarning Boolean: Whether to warn if both the
 778          * old and the new indexes exist.
 779          * @param string $patch Path to the patch file
 780          * @param bool $fullpath Whether to treat $patch path as a relative or not
 781          * @return bool False if this was skipped because schema changes are skipped
 782          */
 783         protected function renameIndex( $table, $oldIndex, $newIndex,
 784                 $skipBothIndexExistWarning, $patch, $fullpath = false
 785         ) {
 786                 if ( !$this->doTable( $table ) ) {
 787                         return true;
 788                 }
 789
 790                 // First requirement: the table must exist
 791                 if ( !$this->db->tableExists( $table, __METHOD__ ) ) {
 792                         $this->output( "...skipping: '$table' table doesn't exist yet.\n" );
 793
 794                         return true;
 795                 }
 796
 797                 // Second requirement: the new index must be missing
 798                 if ( $this->db->indexExists( $table, $newIndex, __METHOD__ ) ) {
 799                         $this->output( "...index $newIndex already set on $table table.\n" );
 800                         if ( !$skipBothIndexExistWarning &&
 801                                 $this->db->indexExists( $table, $oldIndex, __METHOD__ )
 802                         ) {
 803                                 $this->output( "...WARNING: $oldIndex still exists, despite it has " .
 804                                         "been renamed into $newIndex (which also exists).\n" .
 805                                         "            $oldIndex should be manually removed if not needed anymore.\n" );
 806                         }
 807
 808                         return true;
 809                 }
 810
 811                 // Third requirement: the old index must exist
 812                 if ( !$this->db->indexExists( $table, $oldIndex, __METHOD__ ) ) {
 813                         $this->output( "...skipping: index $oldIndex doesn't exist.\n" );
 814
 815                         return true;
 816                 }
 817
 818                 // Requirements have been satisfied, patch can be applied
 819                 return $this->applyPatch(
 820                         $patch,
 821                         $fullpath,
 822                         "Renaming index $oldIndex into $newIndex to table $table"
 823                 );
 824         }
 825
 826         /**
 827          * If the specified table exists, drop it, or execute the
 828          * patch if one is provided.
 829          *
 830          * Public @since 1.20
 831          *
 832          * @param string $table Table to drop.
 833          * @param string|bool $patch String of patch file that will drop the table. Default: false.
 834          * @param bool $fullpath Whether $patch is a full path. Default: false.
 835          * @return bool False if this was skipped because schema changes are skipped
 836          */
 837         public function dropTable( $table, $patch = false, $fullpath = false ) {
 838                 if ( !$this->doTable( $table ) ) {
 839                         return true;
 840                 }
 841
 842                 if ( $this->db->tableExists( $table, __METHOD__ ) ) {
 843                         $msg = "Dropping table $table";
 844
 845                         if ( $patch === false ) {
 846                                 $this->output( "$msg ..." );
 847                                 $this->db->dropTable( $table, __METHOD__ );
 848                                 $this->output( "done.\n" );
 849                         } else {
 850                                 return $this->applyPatch( $patch, $fullpath, $msg );
 851                         }
 852                 } else {
 853                         $this->output( "...$table doesn't exist.\n" );
 854                 }
 855
 856                 return true;
 857         }
 858
 859         /**
 860          * Modify an existing field
 861          *
 862          * @param string $table Name of the table to which the field belongs
 863          * @param string $field Name of the field to modify
 864          * @param string $patch Path to the patch file
 865          * @param bool $fullpath Whether to treat $patch path as a relative or not
 866          * @return bool False if this was skipped because schema changes are skipped
 867          */
 868         public function modifyField( $table, $field, $patch, $fullpath = false ) {
 869                 if ( !$this->doTable( $table ) ) {
 870                         return true;
 871                 }
 872
 873                 $updateKey = "$table-$field-$patch";
 874                 if ( !$this->db->tableExists( $table, __METHOD__ ) ) {
 875                         $this->output( "...$table table does not exist, skipping modify field patch.\n" );
 876                 } elseif ( !$this->db->fieldExists( $table, $field, __METHOD__ ) ) {
 877                         $this->output( "...$field field does not exist in $table table, " .
 878                                 "skipping modify field patch.\n" );
 879                 } elseif ( $this->updateRowExists( $updateKey ) ) {
 880                         $this->output( "...$field in table $table already modified by patch $patch.\n" );
 881                 } else {
 882                         $this->insertUpdateRow( $updateKey );
 883
 884                         return $this->applyPatch( $patch, $fullpath, "Modifying $field field of table $table" );
 885                 }
 886
 887                 return true;
 888         }
 889
 890         /**
 891          * Purge the objectcache table
 892          */
 893         public function purgeCache() {
 894                 global $wgLocalisationCacheConf;
 895                 # We can't guarantee that the user will be able to use TRUNCATE,
 896                 # but we know that DELETE is available to us
 897                 $this->output( "Purging caches..." );
 898                 $this->db->delete( 'objectcache', '*', __METHOD__ );
 899                 if ( $wgLocalisationCacheConf['manualRecache'] ) {
 900                         $this->rebuildLocalisationCache();
 901                 }
 902                 MessageBlobStore::clear();
 903                 $this->output( "done.\n" );
 904         }
 905
 906         /**
 907          * Check the site_stats table is not properly populated.
 908          */
 909         protected function checkStats() {
 910                 $this->output( "...site_stats is populated..." );
 911                 $row = $this->db->selectRow( 'site_stats', '*', array( 'ss_row_id' => 1 ), __METHOD__ );
 912                 if ( $row === false ) {
 913                         $this->output( "data is missing! rebuilding...\n" );
 914                 } elseif ( isset( $row->site_stats ) && $row->ss_total_pages == -1 ) {
 915                         $this->output( "missing ss_total_pages, rebuilding...\n" );
 916                 } else {
 917                         $this->output( "done.\n" );
 918
 919                         return;
 920                 }
 921                 SiteStatsInit::doAllAndCommit( $this->db );
 922         }
 923
 924         # Common updater functions
 925
 926         /**
 927          * Sets the number of active users in the site_stats table
 928          */
 929         protected function doActiveUsersInit() {
 930                 $activeUsers = $this->db->selectField( 'site_stats', 'ss_active_users', false, __METHOD__ );
 931                 if ( $activeUsers == -1 ) {
 932                         $activeUsers = $this->db->selectField( 'recentchanges',
 933                                 'COUNT( DISTINCT rc_user_text )',
 934                                 array( 'rc_user != 0', 'rc_bot' => 0, "rc_log_type != 'newusers'" ), __METHOD__
 935                         );
 936                         $this->db->update( 'site_stats',
 937                                 array( 'ss_active_users' => intval( $activeUsers ) ),
 938                                 array( 'ss_row_id' => 1 ), __METHOD__, array( 'LIMIT' => 1 )
 939                         );
 940                 }
 941                 $this->output( "...ss_active_users user count set...\n" );
 942         }
 943
 944         /**
 945          * Populates the log_user_text field in the logging table
 946          */
 947         protected function doLogUsertextPopulation() {
 948                 if ( !$this->updateRowExists( 'populate log_usertext' ) ) {
 949                         $this->output(
 950                                 "Populating log_user_text field, printing progress markers. For large\n" .
 951                                 "databases, you may want to hit Ctrl-C and do this manually with\n" .
 952                                 "maintenance/populateLogUsertext.php.\n"
 953                         );
 954
 955                         $task = $this->maintenance->runChild( 'PopulateLogUsertext' );
 956                         $task->execute();
 957                         $this->output( "done.\n" );
 958                 }
 959         }
 960
 961         /**
 962          * Migrate log params to new table and index for searching
 963          */
 964         protected function doLogSearchPopulation() {
 965                 if ( !$this->updateRowExists( 'populate log_search' ) ) {
 966                         $this->output(
 967                                 "Populating log_search table, printing progress markers. For large\n" .
 968                                 "databases, you may want to hit Ctrl-C and do this manually with\n" .
 969                                 "maintenance/populateLogSearch.php.\n" );
 970
 971                         $task = $this->maintenance->runChild( 'PopulateLogSearch' );
 972                         $task->execute();
 973                         $this->output( "done.\n" );
 974                 }
 975         }
 976
 977         /**
 978          * Updates the timestamps in the transcache table
 979          */
 980         protected function doUpdateTranscacheField() {
 981                 if ( $this->updateRowExists( 'convert transcache field' ) ) {
 982                         $this->output( "...transcache tc_time already converted.\n" );
 983
 984                         return true;
 985                 }
 986
 987                 return $this->applyPatch( 'patch-tc-timestamp.sql', false,
 988                         "Converting tc_time from UNIX epoch to MediaWiki timestamp" );
 989         }
 990
 991         /**
 992          * Update CategoryLinks collation
 993          */
 994         protected function doCollationUpdate() {
 995                 global $wgCategoryCollation;
 996                 if ( $this->db->fieldExists( 'categorylinks', 'cl_collation', __METHOD__ ) ) {
 997                         if ( $this->db->selectField(
 998                                 'categorylinks',
 999                                 'COUNT(*)',
1000                                 'cl_collation != ' . $this->db->addQuotes( $wgCategoryCollation ),
1001                                 __METHOD__
1002                                 ) == 0
1003                         ) {
1004                                 $this->output( "...collations up-to-date.\n" );
1005
1006                                 return;
1007                         }
1008
1009                         $this->output( "Updating category collations..." );
1010                         $task = $this->maintenance->runChild( 'UpdateCollation' );
1011                         $task->execute();
1012                         $this->output( "...done.\n" );
1013                 }
1014         }
1015
1016         /**
1017          * Migrates user options from the user table blob to user_properties
1018          */
1019         protected function doMigrateUserOptions() {
1020                 if ( $this->db->tableExists( 'user_properties' ) ) {
1021                         $cl = $this->maintenance->runChild( 'ConvertUserOptions', 'convertUserOptions.php' );
1022                         $cl->execute();
1023                         $this->output( "done.\n" );
1024                 }
1025         }
1026
1027         /**
1028          * Rebuilds the localisation cache
1029          */
1030         protected function rebuildLocalisationCache() {
1031                 /**
1032                  * @var $cl RebuildLocalisationCache
1033                  */
1034                 $cl = $this->maintenance->runChild( 'RebuildLocalisationCache', 'rebuildLocalisationCache.php' );
1035                 $this->output( "Rebuilding localisation cache...\n" );
1036                 $cl->setForce();
1037                 $cl->execute();
1038                 $this->output( "done.\n" );
1039         }
1040
1041         /**
1042          * Turns off content handler fields during parts of the upgrade
1043          * where they aren't available.
1044          */
1045         protected function disableContentHandlerUseDB() {
1046                 global $wgContentHandlerUseDB;
1047
1048                 if ( $wgContentHandlerUseDB ) {
1049                         $this->output( "Turning off Content Handler DB fields for this part of upgrade.\n" );
1050                         $this->holdContentHandlerUseDB = $wgContentHandlerUseDB;
1051                         $wgContentHandlerUseDB = false;
1052                 }
1053         }
1054
1055         /**
1056          * Turns content handler fields back on.
1057          */
1058         protected function enableContentHandlerUseDB() {
1059                 global $wgContentHandlerUseDB;
1060
1061                 if ( $this->holdContentHandlerUseDB ) {
1062                         $this->output( "Content Handler DB fields should be usable now.\n" );
1063                         $wgContentHandlerUseDB = $this->holdContentHandlerUseDB;
1064                 }
1065         }
1066 }