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 use Wikimedia\Rdbms\Database;
  24 use Wikimedia\Rdbms\IDatabase;
  25 use MediaWiki\MediaWikiServices;
  26
  27 require_once __DIR__ . '/../../maintenance/Maintenance.php';
  28
  29 /**
  30  * Class for handling database updates. Roughly based off of updaters.inc, with
  31  * a few improvements :)
  32  *
  33  * @ingroup Deployment
  34  * @since 1.17
  35  */
  36 abstract class DatabaseUpdater {
  37         const REPLICATION_WAIT_TIMEOUT = 300;
  38
  39         /**
  40          * Array of updates to perform on the database
  41          *
  42          * @var array
  43          */
  44         protected $updates = [];
  45
  46         /**
  47          * Array of updates that were skipped
  48          *
  49          * @var array
  50          */
  51         protected $updatesSkipped = [];
  52
  53         /**
  54          * List of extension-provided database updates
  55          * @var array
  56          */
  57         protected $extensionUpdates = [];
  58
  59         /**
  60          * Handle to the database subclass
  61          *
  62          * @var Database
  63          */
  64         protected $db;
  65
  66         /**
  67          * @var Maintenance
  68          */
  69         protected $maintenance;
  70
  71         protected $shared = false;
  72
  73         /**
  74          * @var string[] Scripts to run after database update
  75          * Should be a subclass of LoggedUpdateMaintenance
  76          */
  77         protected $postDatabaseUpdateMaintenance = [
  78                 DeleteDefaultMessages::class,
  79                 PopulateRevisionLength::class,
  80                 PopulateRevisionSha1::class,
  81                 PopulateImageSha1::class,
  82                 FixExtLinksProtocolRelative::class,
  83                 PopulateFilearchiveSha1::class,
  84                 PopulateBacklinkNamespace::class,
  85                 FixDefaultJsonContentPages::class,
  86                 CleanupEmptyCategories::class,
  87                 AddRFCandPMIDInterwiki::class,
  88                 PopulatePPSortKey::class,
  89                 PopulateIpChanges::class,
  90                 RefreshExternallinksIndex::class,
  91         ];
  92
  93         /**
  94          * File handle for SQL output.
  95          *
  96          * @var resource
  97          */
  98         protected $fileHandle = null;
  99
 100         /**
 101          * Flag specifying whether or not to skip schema (e.g. SQL-only) updates.
 102          *
 103          * @var bool
 104          */
 105         protected $skipSchema = false;
 106
 107         /**
 108          * Hold the value of $wgContentHandlerUseDB during the upgrade.
 109          */
 110         protected $holdContentHandlerUseDB = true;
 111
 112         /**
 113          * @param Database &$db To perform updates on
 114          * @param bool $shared Whether to perform updates on shared tables
 115          * @param Maintenance|null $maintenance Maintenance object which created us
 116          */
 117         protected function __construct( Database &$db, $shared, Maintenance $maintenance = null ) {
 118                 $this->db = $db;
 119                 $this->db->setFlag( DBO_DDLMODE ); // For Oracle's handling of schema files
 120                 $this->shared = $shared;
 121                 if ( $maintenance ) {
 122                         $this->maintenance = $maintenance;
 123                         $this->fileHandle = $maintenance->fileHandle;
 124                 } else {
 125                         $this->maintenance = new FakeMaintenance;
 126                 }
 127                 $this->maintenance->setDB( $db );
 128                 $this->initOldGlobals();
 129                 $this->loadExtensions();
 130                 Hooks::run( 'LoadExtensionSchemaUpdates', [ $this ] );
 131         }
 132
 133         /**
 134          * Initialize all of the old globals. One day this should all become
 135          * something much nicer
 136          */
 137         private function initOldGlobals() {
 138                 global $wgExtNewTables, $wgExtNewFields, $wgExtPGNewFields,
 139                         $wgExtPGAlteredFields, $wgExtNewIndexes, $wgExtModifiedFields;
 140
 141                 # For extensions only, should be populated via hooks
 142                 # $wgDBtype should be checked to specify the proper file
 143                 $wgExtNewTables = []; // table, dir
 144                 $wgExtNewFields = []; // table, column, dir
 145                 $wgExtPGNewFields = []; // table, column, column attributes; for PostgreSQL
 146                 $wgExtPGAlteredFields = []; // table, column, new type, conversion method; for PostgreSQL
 147                 $wgExtNewIndexes = []; // table, index, dir
 148                 $wgExtModifiedFields = []; // table, index, dir
 149         }
 150
 151         /**
 152          * Loads LocalSettings.php, if needed, and initialises everything needed for
 153          * LoadExtensionSchemaUpdates hook.
 154          */
 155         private function loadExtensions() {
 156                 if ( !defined( 'MEDIAWIKI_INSTALL' ) || defined( 'MW_EXTENSIONS_LOADED' ) ) {
 157                         return; // already loaded
 158                 }
 159                 $vars = Installer::getExistingLocalSettings();
 160
 161                 $registry = ExtensionRegistry::getInstance();
 162                 $queue = $registry->getQueue();
 163                 // Don't accidentally load extensions in the future
 164                 $registry->clearQueue();
 165
 166                 // This will automatically add "AutoloadClasses" to $wgAutoloadClasses
 167                 $data = $registry->readFromQueue( $queue );
 168                 $hooks = $data['globals']['wgHooks']['LoadExtensionSchemaUpdates'] ?? [];
 169                 if ( $vars && isset( $vars['wgHooks']['LoadExtensionSchemaUpdates'] ) ) {
 170                         $hooks = array_merge_recursive( $hooks, $vars['wgHooks']['LoadExtensionSchemaUpdates'] );
 171                 }
 172                 global $wgHooks, $wgAutoloadClasses;
 173                 $wgHooks['LoadExtensionSchemaUpdates'] = $hooks;
 174                 if ( $vars && isset( $vars['wgAutoloadClasses'] ) ) {
 175                         $wgAutoloadClasses += $vars['wgAutoloadClasses'];
 176                 }
 177         }
 178
 179         /**
 180          * @param Database $db
 181          * @param bool $shared
 182          * @param Maintenance|null $maintenance
 183          *
 184          * @throws MWException
 185          * @return DatabaseUpdater
 186          */
 187         public static function newForDB( Database $db, $shared = false, Maintenance $maintenance = null ) {
 188                 $type = $db->getType();
 189                 if ( in_array( $type, Installer::getDBTypes() ) ) {
 190                         $class = ucfirst( $type ) . 'Updater';
 191
 192                         return new $class( $db, $shared, $maintenance );
 193                 } else {
 194                         throw new MWException( __METHOD__ . ' called for unsupported $wgDBtype' );
 195                 }
 196         }
 197
 198         /**
 199          * Get a database connection to run updates
 200          *
 201          * @return Database
 202          */
 203         public function getDB() {
 204                 return $this->db;
 205         }
 206
 207         /**
 208          * Output some text. If we're running from web, escape the text first.
 209          *
 210          * @param string $str Text to output
 211          * @param-taint $str escapes_html
 212          */
 213         public function output( $str ) {
 214                 if ( $this->maintenance->isQuiet() ) {
 215                         return;
 216                 }
 217                 global $wgCommandLineMode;
 218                 if ( !$wgCommandLineMode ) {
 219                         $str = htmlspecialchars( $str );
 220                 }
 221                 echo $str;
 222                 flush();
 223         }
 224
 225         /**
 226          * Add a new update coming from an extension. This should be called by
 227          * extensions while executing the LoadExtensionSchemaUpdates hook.
 228          *
 229          * @since 1.17
 230          *
 231          * @param array $update The update to run. Format is [ $callback, $params... ]
 232          *   $callback is the method to call; either a DatabaseUpdater method name or a callable.
 233          *   Must be serializable (ie. no anonymous functions allowed). The rest of the parameters
 234          *   (if any) will be passed to the callback. The first parameter passed to the callback
 235          *   is always this object.
 236          */
 237         public function addExtensionUpdate( array $update ) {
 238                 $this->extensionUpdates[] = $update;
 239         }
 240
 241         /**
 242          * Convenience wrapper for addExtensionUpdate() when adding a new table (which
 243          * is the most common usage of updaters in an extension)
 244          *
 245          * @since 1.18
 246          *
 247          * @param string $tableName Name of table to create
 248          * @param string $sqlPath Full path to the schema file
 249          */
 250         public function addExtensionTable( $tableName, $sqlPath ) {
 251                 $this->extensionUpdates[] = [ 'addTable', $tableName, $sqlPath, true ];
 252         }
 253
 254         /**
 255          * @since 1.19
 256          *
 257          * @param string $tableName
 258          * @param string $indexName
 259          * @param string $sqlPath
 260          */
 261         public function addExtensionIndex( $tableName, $indexName, $sqlPath ) {
 262                 $this->extensionUpdates[] = [ 'addIndex', $tableName, $indexName, $sqlPath, true ];
 263         }
 264
 265         /**
 266          *
 267          * @since 1.19
 268          *
 269          * @param string $tableName
 270          * @param string $columnName
 271          * @param string $sqlPath
 272          */
 273         public function addExtensionField( $tableName, $columnName, $sqlPath ) {
 274                 $this->extensionUpdates[] = [ 'addField', $tableName, $columnName, $sqlPath, true ];
 275         }
 276
 277         /**
 278          *
 279          * @since 1.20
 280          *
 281          * @param string $tableName
 282          * @param string $columnName
 283          * @param string $sqlPath
 284          */
 285         public function dropExtensionField( $tableName, $columnName, $sqlPath ) {
 286                 $this->extensionUpdates[] = [ 'dropField', $tableName, $columnName, $sqlPath, true ];
 287         }
 288
 289         /**
 290          * Drop an index from an extension table
 291          *
 292          * @since 1.21
 293          *
 294          * @param string $tableName The table name
 295          * @param string $indexName The index name
 296          * @param string $sqlPath The path to the SQL change path
 297          */
 298         public function dropExtensionIndex( $tableName, $indexName, $sqlPath ) {
 299                 $this->extensionUpdates[] = [ 'dropIndex', $tableName, $indexName, $sqlPath, true ];
 300         }
 301
 302         /**
 303          *
 304          * @since 1.20
 305          *
 306          * @param string $tableName
 307          * @param string $sqlPath
 308          */
 309         public function dropExtensionTable( $tableName, $sqlPath ) {
 310                 $this->extensionUpdates[] = [ 'dropTable', $tableName, $sqlPath, true ];
 311         }
 312
 313         /**
 314          * Rename an index on an extension table
 315          *
 316          * @since 1.21
 317          *
 318          * @param string $tableName The table name
 319          * @param string $oldIndexName The old index name
 320          * @param string $newIndexName The new index name
 321          * @param string $sqlPath The path to the SQL change path
 322          * @param bool $skipBothIndexExistWarning Whether to warn if both the old
 323          * and the new indexes exist. [facultative; by default, false]
 324          */
 325         public function renameExtensionIndex( $tableName, $oldIndexName, $newIndexName,
 326                 $sqlPath, $skipBothIndexExistWarning = false
 327         ) {
 328                 $this->extensionUpdates[] = [
 329                         'renameIndex',
 330                         $tableName,
 331                         $oldIndexName,
 332                         $newIndexName,
 333                         $skipBothIndexExistWarning,
 334                         $sqlPath,
 335                         true
 336                 ];
 337         }
 338
 339         /**
 340          * @since 1.21
 341          *
 342          * @param string $tableName The table name
 343          * @param string $fieldName The field to be modified
 344          * @param string $sqlPath The path to the SQL patch
 345          */
 346         public function modifyExtensionField( $tableName, $fieldName, $sqlPath ) {
 347                 $this->extensionUpdates[] = [ 'modifyField', $tableName, $fieldName, $sqlPath, true ];
 348         }
 349
 350         /**
 351          * @since 1.31
 352          *
 353          * @param string $tableName The table name
 354          * @param string $sqlPath The path to the SQL patch
 355          */
 356         public function modifyExtensionTable( $tableName, $sqlPath ) {
 357                 $this->extensionUpdates[] = [ 'modifyTable', $tableName, $sqlPath, true ];
 358         }
 359
 360         /**
 361          *
 362          * @since 1.20
 363          *
 364          * @param string $tableName
 365          * @return bool
 366          */
 367         public function tableExists( $tableName ) {
 368                 return ( $this->db->tableExists( $tableName, __METHOD__ ) );
 369         }
 370
 371         /**
 372          * Add a maintenance script to be run after the database updates are complete.
 373          *
 374          * Script should subclass LoggedUpdateMaintenance
 375          *
 376          * @since 1.19
 377          *
 378          * @param string $class Name of a Maintenance subclass
 379          */
 380         public function addPostDatabaseUpdateMaintenance( $class ) {
 381                 $this->postDatabaseUpdateMaintenance[] = $class;
 382         }
 383
 384         /**
 385          * Get the list of extension-defined updates
 386          *
 387          * @return array
 388          */
 389         protected function getExtensionUpdates() {
 390                 return $this->extensionUpdates;
 391         }
 392
 393         /**
 394          * @since 1.17
 395          *
 396          * @return string[]
 397          */
 398         public function getPostDatabaseUpdateMaintenance() {
 399                 return $this->postDatabaseUpdateMaintenance;
 400         }
 401
 402         /**
 403          * @since 1.21
 404          *
 405          * Writes the schema updates desired to a file for the DB Admin to run.
 406          * @param array $schemaUpdate
 407          */
 408         private function writeSchemaUpdateFile( array $schemaUpdate = [] ) {
 409                 $updates = $this->updatesSkipped;
 410                 $this->updatesSkipped = [];
 411
 412                 foreach ( $updates as $funcList ) {
 413                         list( $func, $args, $origParams ) = $funcList;
 414                         $func( ...$args );
 415                         flush();
 416                         $this->updatesSkipped[] = $origParams;
 417                 }
 418         }
 419
 420         /**
 421          * Get appropriate schema variables in the current database connection.
 422          *
 423          * This should be called after any request data has been imported, but before
 424          * any write operations to the database. The result should be passed to the DB
 425          * setSchemaVars() method.
 426          *
 427          * @return array
 428          * @since 1.28
 429          */
 430         public function getSchemaVars() {
 431                 return []; // DB-type specific
 432         }
 433
 434         /**
 435          * Do all the updates
 436          *
 437          * @param array $what What updates to perform
 438          */
 439         public function doUpdates( array $what = [ 'core', 'extensions', 'stats' ] ) {
 440                 $this->db->setSchemaVars( $this->getSchemaVars() );
 441
 442                 $what = array_flip( $what );
 443                 $this->skipSchema = isset( $what['noschema'] ) || $this->fileHandle !== null;
 444                 if ( isset( $what['core'] ) ) {
 445                         $this->runUpdates( $this->getCoreUpdateList(), false );
 446                 }
 447                 if ( isset( $what['extensions'] ) ) {
 448                         $this->runUpdates( $this->getOldGlobalUpdates(), false );
 449                         $this->runUpdates( $this->getExtensionUpdates(), true );
 450                 }
 451
 452                 if ( isset( $what['stats'] ) ) {
 453                         $this->checkStats();
 454                 }
 455
 456                 if ( $this->fileHandle ) {
 457                         $this->skipSchema = false;
 458                         $this->writeSchemaUpdateFile();
 459                 }
 460         }
 461
 462         /**
 463          * Helper function for doUpdates()
 464          *
 465          * @param array $updates Array of updates to run
 466          * @param bool $passSelf Whether to pass this object we calling external functions
 467          */
 468         private function runUpdates( array $updates, $passSelf ) {
 469                 $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
 470
 471                 $updatesDone = [];
 472                 $updatesSkipped = [];
 473                 foreach ( $updates as $params ) {
 474                         $origParams = $params;
 475                         $func = array_shift( $params );
 476                         if ( !is_array( $func ) && method_exists( $this, $func ) ) {
 477                                 $func = [ $this, $func ];
 478                         } elseif ( $passSelf ) {
 479                                 array_unshift( $params, $this );
 480                         }
 481                         $ret = $func( ...$params );
 482                         flush();
 483                         if ( $ret !== false ) {
 484                                 $updatesDone[] = $origParams;
 485                                 $lbFactory->waitForReplication( [ 'timeout' => self::REPLICATION_WAIT_TIMEOUT ] );
 486                         } else {
 487                                 $updatesSkipped[] = [ $func, $params, $origParams ];
 488                         }
 489                 }
 490                 $this->updatesSkipped = array_merge( $this->updatesSkipped, $updatesSkipped );
 491                 $this->updates = array_merge( $this->updates, $updatesDone );
 492         }
 493
 494         /**
 495          * Helper function: check if the given key is present in the updatelog table.
 496          * Obviously, only use this for updates that occur after the updatelog table was
 497          * created!
 498          * @param string $key Name of the key to check for
 499          * @return bool
 500          */
 501         public function updateRowExists( $key ) {
 502                 $row = $this->db->selectRow(
 503                         'updatelog',
 504                         # T67813
 505                         '1 AS X',
 506                         [ 'ul_key' => $key ],
 507                         __METHOD__
 508                 );
 509
 510                 return (bool)$row;
 511         }
 512
 513         /**
 514          * Helper function: Add a key to the updatelog table
 515          * Obviously, only use this for updates that occur after the updatelog table was
 516          * created!
 517          * @param string $key Name of key to insert
 518          * @param string|null $val [optional] Value to insert along with the key
 519          */
 520         public function insertUpdateRow( $key, $val = null ) {
 521                 $this->db->clearFlag( DBO_DDLMODE );
 522                 $values = [ 'ul_key' => $key ];
 523                 if ( $val && $this->canUseNewUpdatelog() ) {
 524                         $values['ul_value'] = $val;
 525                 }
 526                 $this->db->insert( 'updatelog', $values, __METHOD__, 'IGNORE' );
 527                 $this->db->setFlag( DBO_DDLMODE );
 528         }
 529
 530         /**
 531          * Updatelog was changed in 1.17 to have a ul_value column so we can record
 532          * more information about what kind of updates we've done (that's what this
 533          * class does). Pre-1.17 wikis won't have this column, and really old wikis
 534          * might not even have updatelog at all
 535          *
 536          * @return bool
 537          */
 538         protected function canUseNewUpdatelog() {
 539                 return $this->db->tableExists( 'updatelog', __METHOD__ ) &&
 540                         $this->db->fieldExists( 'updatelog', 'ul_value', __METHOD__ );
 541         }
 542
 543         /**
 544          * Returns whether updates should be executed on the database table $name.
 545          * Updates will be prevented if the table is a shared table and it is not
 546          * specified to run updates on shared tables.
 547          *
 548          * @param string $name Table name
 549          * @return bool
 550          */
 551         protected function doTable( $name ) {
 552                 global $wgSharedDB, $wgSharedTables;
 553
 554                 // Don't bother to check $wgSharedTables if there isn't a shared database
 555                 // or the user actually also wants to do updates on the shared database.
 556                 if ( $wgSharedDB === null || $this->shared ) {
 557                         return true;
 558                 }
 559
 560                 if ( in_array( $name, $wgSharedTables ) ) {
 561                         $this->output( "...skipping update to shared table $name.\n" );
 562                         return false;
 563                 } else {
 564                         return true;
 565                 }
 566         }
 567
 568         /**
 569          * Before 1.17, we used to handle updates via stuff like
 570          * $wgExtNewTables/Fields/Indexes. This is nasty :) We refactored a lot
 571          * of this in 1.17 but we want to remain back-compatible for a while. So
 572          * load up these old global-based things into our update list.
 573          *
 574          * @return array
 575          */
 576         protected function getOldGlobalUpdates() {
 577                 global $wgExtNewFields, $wgExtNewTables, $wgExtModifiedFields,
 578                         $wgExtNewIndexes;
 579
 580                 $updates = [];
 581
 582                 foreach ( $wgExtNewTables as $tableRecord ) {
 583                         $updates[] = [
 584                                 'addTable', $tableRecord[0], $tableRecord[1], true
 585                         ];
 586                 }
 587
 588                 foreach ( $wgExtNewFields as $fieldRecord ) {
 589                         $updates[] = [
 590                                 'addField', $fieldRecord[0], $fieldRecord[1],
 591                                 $fieldRecord[2], true
 592                         ];
 593                 }
 594
 595                 foreach ( $wgExtNewIndexes as $fieldRecord ) {
 596                         $updates[] = [
 597                                 'addIndex', $fieldRecord[0], $fieldRecord[1],
 598                                 $fieldRecord[2], true
 599                         ];
 600                 }
 601
 602                 foreach ( $wgExtModifiedFields as $fieldRecord ) {
 603                         $updates[] = [
 604                                 'modifyField', $fieldRecord[0], $fieldRecord[1],
 605                                 $fieldRecord[2], true
 606                         ];
 607                 }
 608
 609                 return $updates;
 610         }
 611
 612         /**
 613          * Get an array of updates to perform on the database. Should return a
 614          * multi-dimensional array. The main key is the MediaWiki version (1.12,
 615          * 1.13...) with the values being arrays of updates, identical to how
 616          * updaters.inc did it (for now)
 617          *
 618          * @return array[]
 619          */
 620         abstract protected function getCoreUpdateList();
 621
 622         /**
 623          * Append an SQL fragment to the open file handle.
 624          *
 625          * @param string $filename File name to open
 626          */
 627         public function copyFile( $filename ) {
 628                 $this->db->sourceFile(
 629                         $filename,
 630                         null,
 631                         null,
 632                         __METHOD__,
 633                         [ $this, 'appendLine' ]
 634                 );
 635         }
 636
 637         /**
 638          * Append a line to the open filehandle.  The line is assumed to
 639          * be a complete SQL statement.
 640          *
 641          * This is used as a callback for sourceLine().
 642          *
 643          * @param string $line Text to append to the file
 644          * @return bool False to skip actually executing the file
 645          * @throws MWException
 646          */
 647         public function appendLine( $line ) {
 648                 $line = rtrim( $line ) . ";\n";
 649                 if ( fwrite( $this->fileHandle, $line ) === false ) {
 650                         throw new MWException( "trouble writing file" );
 651                 }
 652
 653                 return false;
 654         }
 655
 656         /**
 657          * Applies a SQL patch
 658          *
 659          * @param string $path Path to the patch file
 660          * @param bool $isFullPath Whether to treat $path as a relative or not
 661          * @param string|null $msg Description of the patch
 662          * @return bool False if patch is skipped.
 663          */
 664         protected function applyPatch( $path, $isFullPath = false, $msg = null ) {
 665                 if ( $msg === null ) {
 666                         $msg = "Applying $path patch";
 667                 }
 668                 if ( $this->skipSchema ) {
 669                         $this->output( "...skipping schema change ($msg).\n" );
 670
 671                         return false;
 672                 }
 673
 674                 $this->output( "$msg ..." );
 675
 676                 if ( !$isFullPath ) {
 677                         $path = $this->patchPath( $this->db, $path );
 678                 }
 679                 if ( $this->fileHandle !== null ) {
 680                         $this->copyFile( $path );
 681                 } else {
 682                         $this->db->sourceFile( $path );
 683                 }
 684                 $this->output( "done.\n" );
 685
 686                 return true;
 687         }
 688
 689         /**
 690          * Get the full path of a patch file. Originally based on archive()
 691          * from updaters.inc. Keep in mind this always returns a patch, as
 692          * it fails back to MySQL if no DB-specific patch can be found
 693          *
 694          * @param IDatabase $db
 695          * @param string $patch The name of the patch, like patch-something.sql
 696          * @return string Full path to patch file
 697          */
 698         public function patchPath( IDatabase $db, $patch ) {
 699                 global $IP;
 700
 701                 $dbType = $db->getType();
 702                 if ( file_exists( "$IP/maintenance/$dbType/archives/$patch" ) ) {
 703                         return "$IP/maintenance/$dbType/archives/$patch";
 704                 } else {
 705                         return "$IP/maintenance/archives/$patch";
 706                 }
 707         }
 708
 709         /**
 710          * Add a new table to the database
 711          *
 712          * @param string $name Name of the new table
 713          * @param string $patch Path to the patch file
 714          * @param bool $fullpath Whether to treat $patch path as a relative or not
 715          * @return bool False if this was skipped because schema changes are skipped
 716          */
 717         protected function addTable( $name, $patch, $fullpath = false ) {
 718                 if ( !$this->doTable( $name ) ) {
 719                         return true;
 720                 }
 721
 722                 if ( $this->db->tableExists( $name, __METHOD__ ) ) {
 723                         $this->output( "...$name table already exists.\n" );
 724                 } else {
 725                         return $this->applyPatch( $patch, $fullpath, "Creating $name table" );
 726                 }
 727
 728                 return true;
 729         }
 730
 731         /**
 732          * Add a new field to an existing table
 733          *
 734          * @param string $table Name of the table to modify
 735          * @param string $field Name of the new field
 736          * @param string $patch Path to the patch file
 737          * @param bool $fullpath Whether to treat $patch path as a relative or not
 738          * @return bool False if this was skipped because schema changes are skipped
 739          */
 740         protected function addField( $table, $field, $patch, $fullpath = false ) {
 741                 if ( !$this->doTable( $table ) ) {
 742                         return true;
 743                 }
 744
 745                 if ( !$this->db->tableExists( $table, __METHOD__ ) ) {
 746                         $this->output( "...$table table does not exist, skipping new field patch.\n" );
 747                 } elseif ( $this->db->fieldExists( $table, $field, __METHOD__ ) ) {
 748                         $this->output( "...have $field field in $table table.\n" );
 749                 } else {
 750                         return $this->applyPatch( $patch, $fullpath, "Adding $field field to table $table" );
 751                 }
 752
 753                 return true;
 754         }
 755
 756         /**
 757          * Add a new index to an existing table
 758          *
 759          * @param string $table Name of the table to modify
 760          * @param string $index Name of the new index
 761          * @param string $patch Path to the patch file
 762          * @param bool $fullpath Whether to treat $patch path as a relative or not
 763          * @return bool False if this was skipped because schema changes are skipped
 764          */
 765         protected function addIndex( $table, $index, $patch, $fullpath = false ) {
 766                 if ( !$this->doTable( $table ) ) {
 767                         return true;
 768                 }
 769
 770                 if ( !$this->db->tableExists( $table, __METHOD__ ) ) {
 771                         $this->output( "...skipping: '$table' table doesn't exist yet.\n" );
 772                 } elseif ( $this->db->indexExists( $table, $index, __METHOD__ ) ) {
 773                         $this->output( "...index $index already set on $table table.\n" );
 774                 } else {
 775                         return $this->applyPatch( $patch, $fullpath, "Adding index $index to table $table" );
 776                 }
 777
 778                 return true;
 779         }
 780
 781         /**
 782          * Add a new index to an existing table if none of the given indexes exist
 783          *
 784          * @param string $table Name of the table to modify
 785          * @param string[] $indexes Name of the indexes to check. $indexes[0] should
 786          *  be the one actually being added.
 787          * @param string $patch Path to the patch file
 788          * @param bool $fullpath Whether to treat $patch path as a relative or not
 789          * @return bool False if this was skipped because schema changes are skipped
 790          */
 791         protected function addIndexIfNoneExist( $table, $indexes, $patch, $fullpath = false ) {
 792                 if ( !$this->doTable( $table ) ) {
 793                         return true;
 794                 }
 795
 796                 if ( !$this->db->tableExists( $table, __METHOD__ ) ) {
 797                         $this->output( "...skipping: '$table' table doesn't exist yet.\n" );
 798                         return true;
 799                 }
 800
 801                 $newIndex = $indexes[0];
 802                 foreach ( $indexes as $index ) {
 803                         if ( $this->db->indexExists( $table, $index, __METHOD__ ) ) {
 804                                 $this->output(
 805                                         "...skipping index $newIndex because index $index already set on $table table.\n"
 806                                 );
 807                                 return true;
 808                         }
 809                 }
 810
 811                 return $this->applyPatch( $patch, $fullpath, "Adding index $index to table $table" );
 812         }
 813
 814         /**
 815          * Drop a field from an existing table
 816          *
 817          * @param string $table Name of the table to modify
 818          * @param string $field Name of the old field
 819          * @param string $patch Path to the patch file
 820          * @param bool $fullpath Whether to treat $patch path as a relative or not
 821          * @return bool False if this was skipped because schema changes are skipped
 822          */
 823         protected function dropField( $table, $field, $patch, $fullpath = false ) {
 824                 if ( !$this->doTable( $table ) ) {
 825                         return true;
 826                 }
 827
 828                 if ( $this->db->fieldExists( $table, $field, __METHOD__ ) ) {
 829                         return $this->applyPatch( $patch, $fullpath, "Table $table contains $field field. Dropping" );
 830                 } else {
 831                         $this->output( "...$table table does not contain $field field.\n" );
 832                 }
 833
 834                 return true;
 835         }
 836
 837         /**
 838          * Drop an index from an existing table
 839          *
 840          * @param string $table Name of the table to modify
 841          * @param string $index Name of the index
 842          * @param string $patch Path to the patch file
 843          * @param bool $fullpath Whether to treat $patch path as a relative or not
 844          * @return bool False if this was skipped because schema changes are skipped
 845          */
 846         protected function dropIndex( $table, $index, $patch, $fullpath = false ) {
 847                 if ( !$this->doTable( $table ) ) {
 848                         return true;
 849                 }
 850
 851                 if ( $this->db->indexExists( $table, $index, __METHOD__ ) ) {
 852                         return $this->applyPatch( $patch, $fullpath, "Dropping $index index from table $table" );
 853                 } else {
 854                         $this->output( "...$index key doesn't exist.\n" );
 855                 }
 856
 857                 return true;
 858         }
 859
 860         /**
 861          * Rename an index from an existing table
 862          *
 863          * @param string $table Name of the table to modify
 864          * @param string $oldIndex Old name of the index
 865          * @param string $newIndex New name of the index
 866          * @param bool $skipBothIndexExistWarning Whether to warn if both the
 867          * old and the new indexes exist.
 868          * @param string $patch Path to the patch file
 869          * @param bool $fullpath Whether to treat $patch path as a relative or not
 870          * @return bool False if this was skipped because schema changes are skipped
 871          */
 872         protected function renameIndex( $table, $oldIndex, $newIndex,
 873                 $skipBothIndexExistWarning, $patch, $fullpath = false
 874         ) {
 875                 if ( !$this->doTable( $table ) ) {
 876                         return true;
 877                 }
 878
 879                 // First requirement: the table must exist
 880                 if ( !$this->db->tableExists( $table, __METHOD__ ) ) {
 881                         $this->output( "...skipping: '$table' table doesn't exist yet.\n" );
 882
 883                         return true;
 884                 }
 885
 886                 // Second requirement: the new index must be missing
 887                 if ( $this->db->indexExists( $table, $newIndex, __METHOD__ ) ) {
 888                         $this->output( "...index $newIndex already set on $table table.\n" );
 889                         if ( !$skipBothIndexExistWarning &&
 890                                 $this->db->indexExists( $table, $oldIndex, __METHOD__ )
 891                         ) {
 892                                 $this->output( "...WARNING: $oldIndex still exists, despite it has " .
 893                                         "been renamed into $newIndex (which also exists).\n" .
 894                                         "            $oldIndex should be manually removed if not needed anymore.\n" );
 895                         }
 896
 897                         return true;
 898                 }
 899
 900                 // Third requirement: the old index must exist
 901                 if ( !$this->db->indexExists( $table, $oldIndex, __METHOD__ ) ) {
 902                         $this->output( "...skipping: index $oldIndex doesn't exist.\n" );
 903
 904                         return true;
 905                 }
 906
 907                 // Requirements have been satisfied, patch can be applied
 908                 return $this->applyPatch(
 909                         $patch,
 910                         $fullpath,
 911                         "Renaming index $oldIndex into $newIndex to table $table"
 912                 );
 913         }
 914
 915         /**
 916          * If the specified table exists, drop it, or execute the
 917          * patch if one is provided.
 918          *
 919          * Public @since 1.20
 920          *
 921          * @param string $table Table to drop.
 922          * @param string|bool $patch String of patch file that will drop the table. Default: false.
 923          * @param bool $fullpath Whether $patch is a full path. Default: false.
 924          * @return bool False if this was skipped because schema changes are skipped
 925          */
 926         public function dropTable( $table, $patch = false, $fullpath = false ) {
 927                 if ( !$this->doTable( $table ) ) {
 928                         return true;
 929                 }
 930
 931                 if ( $this->db->tableExists( $table, __METHOD__ ) ) {
 932                         $msg = "Dropping table $table";
 933
 934                         if ( $patch === false ) {
 935                                 $this->output( "$msg ..." );
 936                                 $this->db->dropTable( $table, __METHOD__ );
 937                                 $this->output( "done.\n" );
 938                         } else {
 939                                 return $this->applyPatch( $patch, $fullpath, $msg );
 940                         }
 941                 } else {
 942                         $this->output( "...$table doesn't exist.\n" );
 943                 }
 944
 945                 return true;
 946         }
 947
 948         /**
 949          * Modify an existing field
 950          *
 951          * @param string $table Name of the table to which the field belongs
 952          * @param string $field Name of the field to modify
 953          * @param string $patch Path to the patch file
 954          * @param bool $fullpath Whether to treat $patch path as a relative or not
 955          * @return bool False if this was skipped because schema changes are skipped
 956          */
 957         public function modifyField( $table, $field, $patch, $fullpath = false ) {
 958                 if ( !$this->doTable( $table ) ) {
 959                         return true;
 960                 }
 961
 962                 $updateKey = "$table-$field-$patch";
 963                 if ( !$this->db->tableExists( $table, __METHOD__ ) ) {
 964                         $this->output( "...$table table does not exist, skipping modify field patch.\n" );
 965                 } elseif ( !$this->db->fieldExists( $table, $field, __METHOD__ ) ) {
 966                         $this->output( "...$field field does not exist in $table table, " .
 967                                 "skipping modify field patch.\n" );
 968                 } elseif ( $this->updateRowExists( $updateKey ) ) {
 969                         $this->output( "...$field in table $table already modified by patch $patch.\n" );
 970                 } else {
 971                         $apply = $this->applyPatch( $patch, $fullpath, "Modifying $field field of table $table" );
 972                         if ( $apply ) {
 973                                 $this->insertUpdateRow( $updateKey );
 974                         }
 975                         return $apply;
 976                 }
 977                 return true;
 978         }
 979
 980         /**
 981          * Modify an existing table, similar to modifyField. Intended for changes that
 982          *  touch more than one column on a table.
 983          *
 984          * @param string $table Name of the table to modify
 985          * @param string $patch Name of the patch file to apply
 986          * @param string|bool $fullpath Whether to treat $patch path as relative or not, defaults to false
 987          * @return bool False if this was skipped because of schema changes being skipped
 988          */
 989         public function modifyTable( $table, $patch, $fullpath = false ) {
 990                 if ( !$this->doTable( $table ) ) {
 991                         return true;
 992                 }
 993
 994                 $updateKey = "$table-$patch";
 995                 if ( !$this->db->tableExists( $table, __METHOD__ ) ) {
 996                         $this->output( "...$table table does not exist, skipping modify table patch.\n" );
 997                 } elseif ( $this->updateRowExists( $updateKey ) ) {
 998                         $this->output( "...table $table already modified by patch $patch.\n" );
 999                 } else {
1000                         $apply = $this->applyPatch( $patch, $fullpath, "Modifying table $table" );
1001                         if ( $apply ) {
1002                                 $this->insertUpdateRow( $updateKey );
1003                         }
1004                         return $apply;
1005                 }
1006                 return true;
1007         }
1008
1009         /**
1010          * Run a maintenance script
1011          *
1012          * This should only be used when the maintenance script must run before
1013          * later updates. If later updates don't depend on the script, add it to
1014          * DatabaseUpdater::$postDatabaseUpdateMaintenance instead.
1015          *
1016          * The script's execute() method must return true to indicate successful
1017          * completion, and must return false (or throw an exception) to indicate
1018          * unsuccessful completion.
1019          *
1020          * @since 1.32
1021          * @param string $class Maintenance subclass
1022          * @param string $script Script path and filename, usually "maintenance/fooBar.php"
1023          */
1024         public function runMaintenance( $class, $script ) {
1025                 $this->output( "Running $script...\n" );
1026                 $task = $this->maintenance->runChild( $class );
1027                 $ok = $task->execute();
1028                 if ( !$ok ) {
1029                         throw new RuntimeException( "Execution of $script did not complete successfully." );
1030                 }
1031                 $this->output( "done.\n" );
1032         }
1033
1034         /**
1035          * Set any .htaccess files or equivilent for storage repos
1036          *
1037          * Some zones (e.g. "temp") used to be public and may have been initialized as such
1038          */
1039         public function setFileAccess() {
1040                 $repo = RepoGroup::singleton()->getLocalRepo();
1041                 $zonePath = $repo->getZonePath( 'temp' );
1042                 if ( $repo->getBackend()->directoryExists( [ 'dir' => $zonePath ] ) ) {
1043                         // If the directory was never made, then it will have the right ACLs when it is made
1044                         $status = $repo->getBackend()->secure( [
1045                                 'dir' => $zonePath,
1046                                 'noAccess' => true,
1047                                 'noListing' => true
1048                         ] );
1049                         if ( $status->isOK() ) {
1050                                 $this->output( "Set the local repo temp zone container to be private.\n" );
1051                         } else {
1052                                 $this->output( "Failed to set the local repo temp zone container to be private.\n" );
1053                         }
1054                 }
1055         }
1056
1057         /**
1058          * Purge various database caches
1059          */
1060         public function purgeCache() {
1061                 global $wgLocalisationCacheConf;
1062                 // We can't guarantee that the user will be able to use TRUNCATE,
1063                 // but we know that DELETE is available to us
1064                 $this->output( "Purging caches..." );
1065
1066                 // ObjectCache
1067                 $this->db->delete( 'objectcache', '*', __METHOD__ );
1068
1069                 // LocalisationCache
1070                 if ( $wgLocalisationCacheConf['manualRecache'] ) {
1071                         $this->rebuildLocalisationCache();
1072                 }
1073
1074                 // ResourceLoader: Message cache
1075                 $blobStore = new MessageBlobStore(
1076                         MediaWikiServices::getInstance()->getResourceLoader()
1077                 );
1078                 $blobStore->clear();
1079
1080                 // ResourceLoader: File-dependency cache
1081                 $this->db->delete( 'module_deps', '*', __METHOD__ );
1082                 $this->output( "done.\n" );
1083         }
1084
1085         /**
1086          * Check the site_stats table is not properly populated.
1087          */
1088         protected function checkStats() {
1089                 $this->output( "...site_stats is populated..." );
1090                 $row = $this->db->selectRow( 'site_stats', '*', [ 'ss_row_id' => 1 ], __METHOD__ );
1091                 if ( $row === false ) {
1092                         $this->output( "data is missing! rebuilding...\n" );
1093                 } elseif ( isset( $row->site_stats ) && $row->ss_total_pages == -1 ) {
1094                         $this->output( "missing ss_total_pages, rebuilding...\n" );
1095                 } else {
1096                         $this->output( "done.\n" );
1097
1098                         return;
1099                 }
1100                 SiteStatsInit::doAllAndCommit( $this->db );
1101         }
1102
1103         # Common updater functions
1104
1105         /**
1106          * Sets the number of active users in the site_stats table
1107          */
1108         protected function doActiveUsersInit() {
1109                 $activeUsers = $this->db->selectField( 'site_stats', 'ss_active_users', '', __METHOD__ );
1110                 if ( $activeUsers == -1 ) {
1111                         $activeUsers = $this->db->selectField( 'recentchanges',
1112                                 'COUNT( DISTINCT rc_user_text )',
1113                                 [ 'rc_user != 0', 'rc_bot' => 0, "rc_log_type != 'newusers'" ], __METHOD__
1114                         );
1115                         $this->db->update( 'site_stats',
1116                                 [ 'ss_active_users' => intval( $activeUsers ) ],
1117                                 [ 'ss_row_id' => 1 ], __METHOD__, [ 'LIMIT' => 1 ]
1118                         );
1119                 }
1120                 $this->output( "...ss_active_users user count set...\n" );
1121         }
1122
1123         /**
1124          * Populates the log_user_text field in the logging table
1125          */
1126         protected function doLogUsertextPopulation() {
1127                 if ( !$this->updateRowExists( 'populate log_usertext' ) ) {
1128                         $this->output(
1129                                 "Populating log_user_text field, printing progress markers. For large\n" .
1130                                 "databases, you may want to hit Ctrl-C and do this manually with\n" .
1131                                 "maintenance/populateLogUsertext.php.\n"
1132                         );
1133
1134                         $task = $this->maintenance->runChild( PopulateLogUsertext::class );
1135                         $task->execute();
1136                         $this->output( "done.\n" );
1137                 }
1138         }
1139
1140         /**
1141          * Migrate log params to new table and index for searching
1142          */
1143         protected function doLogSearchPopulation() {
1144                 if ( !$this->updateRowExists( 'populate log_search' ) ) {
1145                         $this->output(
1146                                 "Populating log_search table, printing progress markers. For large\n" .
1147                                 "databases, you may want to hit Ctrl-C and do this manually with\n" .
1148                                 "maintenance/populateLogSearch.php.\n" );
1149
1150                         $task = $this->maintenance->runChild( PopulateLogSearch::class );
1151                         $task->execute();
1152                         $this->output( "done.\n" );
1153                 }
1154         }
1155
1156         /**
1157          * Update CategoryLinks collation
1158          */
1159         protected function doCollationUpdate() {
1160                 global $wgCategoryCollation;
1161                 if ( $this->db->fieldExists( 'categorylinks', 'cl_collation', __METHOD__ ) ) {
1162                         if ( $this->db->selectField(
1163                                 'categorylinks',
1164                                 'COUNT(*)',
1165                                 'cl_collation != ' . $this->db->addQuotes( $wgCategoryCollation ),
1166                                 __METHOD__
1167                                 ) == 0
1168                         ) {
1169                                 $this->output( "...collations up-to-date.\n" );
1170
1171                                 return;
1172                         }
1173
1174                         $this->output( "Updating category collations..." );
1175                         $task = $this->maintenance->runChild( UpdateCollation::class );
1176                         $task->execute();
1177                         $this->output( "...done.\n" );
1178                 }
1179         }
1180
1181         /**
1182          * Migrates user options from the user table blob to user_properties
1183          */
1184         protected function doMigrateUserOptions() {
1185                 if ( $this->db->tableExists( 'user_properties' ) ) {
1186                         $cl = $this->maintenance->runChild( ConvertUserOptions::class, 'convertUserOptions.php' );
1187                         $cl->execute();
1188                         $this->output( "done.\n" );
1189                 }
1190         }
1191
1192         /**
1193          * Enable profiling table when it's turned on
1194          */
1195         protected function doEnableProfiling() {
1196                 global $wgProfiler;
1197
1198                 if ( !$this->doTable( 'profiling' ) ) {
1199                         return;
1200                 }
1201
1202                 $profileToDb = false;
1203                 if ( isset( $wgProfiler['output'] ) ) {
1204                         $out = $wgProfiler['output'];
1205                         if ( $out === 'db' ) {
1206                                 $profileToDb = true;
1207                         } elseif ( is_array( $out ) && in_array( 'db', $out ) ) {
1208                                 $profileToDb = true;
1209                         }
1210                 }
1211
1212                 if ( $profileToDb && !$this->db->tableExists( 'profiling', __METHOD__ ) ) {
1213                         $this->applyPatch( 'patch-profiling.sql', false, 'Add profiling table' );
1214                 }
1215         }
1216
1217         /**
1218          * Rebuilds the localisation cache
1219          */
1220         protected function rebuildLocalisationCache() {
1221                 /**
1222                  * @var $cl RebuildLocalisationCache
1223                  */
1224                 $cl = $this->maintenance->runChild(
1225                         RebuildLocalisationCache::class, 'rebuildLocalisationCache.php'
1226                 );
1227                 $this->output( "Rebuilding localisation cache...\n" );
1228                 $cl->setForce();
1229                 $cl->execute();
1230                 $this->output( "done.\n" );
1231         }
1232
1233         /**
1234          * Turns off content handler fields during parts of the upgrade
1235          * where they aren't available.
1236          */
1237         protected function disableContentHandlerUseDB() {
1238                 global $wgContentHandlerUseDB;
1239
1240                 if ( $wgContentHandlerUseDB ) {
1241                         $this->output( "Turning off Content Handler DB fields for this part of upgrade.\n" );
1242                         $this->holdContentHandlerUseDB = $wgContentHandlerUseDB;
1243                         $wgContentHandlerUseDB = false;
1244                 }
1245         }
1246
1247         /**
1248          * Turns content handler fields back on.
1249          */
1250         protected function enableContentHandlerUseDB() {
1251                 global $wgContentHandlerUseDB;
1252
1253                 if ( $this->holdContentHandlerUseDB ) {
1254                         $this->output( "Content Handler DB fields should be usable now.\n" );
1255                         $wgContentHandlerUseDB = $this->holdContentHandlerUseDB;
1256                 }
1257         }
1258
1259         /**
1260          * Migrate comments to the new 'comment' table
1261          * @since 1.30
1262          */
1263         protected function migrateComments() {
1264                 if ( !$this->updateRowExists( 'MigrateComments' ) ) {
1265                         $this->output(
1266                                 "Migrating comments to the 'comments' table, printing progress markers. For large\n" .
1267                                 "databases, you may want to hit Ctrl-C and do this manually with\n" .
1268                                 "maintenance/migrateComments.php.\n"
1269                         );
1270                         $task = $this->maintenance->runChild( MigrateComments::class, 'migrateComments.php' );
1271                         $ok = $task->execute();
1272                         $this->output( $ok ? "done.\n" : "errors were encountered.\n" );
1273                 }
1274         }
1275
1276         /**
1277          * Merge `image_comment_temp` into the `image` table
1278          * @since 1.32
1279          */
1280         protected function migrateImageCommentTemp() {
1281                 if ( $this->tableExists( 'image_comment_temp' ) ) {
1282                         $this->output( "Merging image_comment_temp into the image table\n" );
1283                         $task = $this->maintenance->runChild(
1284                                 MigrateImageCommentTemp::class, 'migrateImageCommentTemp.php'
1285                         );
1286                         $task->setForce();
1287                         $ok = $task->execute();
1288                         $this->output( $ok ? "done.\n" : "errors were encountered.\n" );
1289                         if ( $ok ) {
1290                                 $this->dropTable( 'image_comment_temp' );
1291                         }
1292                 }
1293         }
1294
1295         /**
1296          * Migrate actors to the new 'actor' table
1297          * @since 1.31
1298          */
1299         protected function migrateActors() {
1300                 global $wgActorTableSchemaMigrationStage;
1301                 if ( ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_NEW ) &&
1302                         !$this->updateRowExists( 'MigrateActors' )
1303                 ) {
1304                         $this->output(
1305                                 "Migrating actors to the 'actor' table, printing progress markers. For large\n" .
1306                                 "databases, you may want to hit Ctrl-C and do this manually with\n" .
1307                                 "maintenance/migrateActors.php.\n"
1308                         );
1309                         $task = $this->maintenance->runChild( 'MigrateActors', 'migrateActors.php' );
1310                         $ok = $task->execute();
1311                         $this->output( $ok ? "done.\n" : "errors were encountered.\n" );
1312                 }
1313         }
1314
1315         /**
1316          * Migrate ar_text to modern storage
1317          * @since 1.31
1318          */
1319         protected function migrateArchiveText() {
1320                 if ( $this->db->fieldExists( 'archive', 'ar_text', __METHOD__ ) ) {
1321                         $this->output( "Migrating archive ar_text to modern storage.\n" );
1322                         $task = $this->maintenance->runChild( MigrateArchiveText::class, 'migrateArchiveText.php' );
1323                         $task->setForce();
1324                         if ( $task->execute() ) {
1325                                 $this->applyPatch( 'patch-drop-ar_text.sql', false,
1326                                         'Dropping ar_text and ar_flags columns' );
1327                         }
1328                 }
1329         }
1330
1331         /**
1332          * Populate ar_rev_id, then make it not nullable
1333          * @since 1.31
1334          */
1335          protected function populateArchiveRevId() {
1336                  $info = $this->db->fieldInfo( 'archive', 'ar_rev_id', __METHOD__ );
1337                  if ( !$info ) {
1338                          throw new MWException( 'Missing ar_rev_id field of archive table. Should not happen.' );
1339                  }
1340                  if ( $info->isNullable() ) {
1341                          $this->output( "Populating ar_rev_id.\n" );
1342                          $task = $this->maintenance->runChild( 'PopulateArchiveRevId', 'populateArchiveRevId.php' );
1343                          if ( $task->execute() ) {
1344                                  $this->applyPatch( 'patch-ar_rev_id-not-null.sql', false,
1345                                          'Making ar_rev_id not nullable' );
1346                          }
1347                  }
1348          }
1349
1350         /**
1351          * Populates the externallinks.el_index_60 field
1352          * @since 1.32
1353          */
1354         protected function populateExternallinksIndex60() {
1355                 if ( !$this->updateRowExists( 'populate externallinks.el_index_60' ) ) {
1356                         $this->output(
1357                                 "Populating el_index_60 field, printing progress markers. For large\n" .
1358                                 "databases, you may want to hit Ctrl-C and do this manually with\n" .
1359                                 "maintenance/populateExternallinksIndex60.php.\n"
1360                         );
1361                         $task = $this->maintenance->runChild( 'PopulateExternallinksIndex60',
1362                                 'populateExternallinksIndex60.php' );
1363                         $task->execute();
1364                         $this->output( "done.\n" );
1365                 }
1366         }
1367
1368         /**
1369          * Populates the MCR content tables
1370          * @since 1.32
1371          */
1372         protected function populateContentTables() {
1373                 global $wgMultiContentRevisionSchemaMigrationStage;
1374                 if ( ( $wgMultiContentRevisionSchemaMigrationStage & SCHEMA_COMPAT_WRITE_NEW ) &&
1375                         !$this->updateRowExists( 'PopulateContentTables' )
1376                 ) {
1377                         $this->output(
1378                                 "Migrating revision data to the MCR 'slot' and 'content' tables, printing progress markers.\n" .
1379                                 "For large databases, you may want to hit Ctrl-C and do this manually with\n" .
1380                                 "maintenance/populateContentTables.php.\n"
1381                         );
1382                         $task = $this->maintenance->runChild(
1383                                 PopulateContentTables::class, 'populateContentTables.php'
1384                         );
1385                         $ok = $task->execute();
1386                         $this->output( $ok ? "done.\n" : "errors were encountered.\n" );
1387                         if ( $ok ) {
1388                                 $this->insertUpdateRow( 'PopulateContentTables' );
1389                         }
1390                 }
1391         }
1392 }