maintenance/update.php

   1 #!/usr/bin/env php
   2 <?php
   3 /**
   4  * Run all updaters.
   5  *
   6  * This is used when the database schema is modified and we need to apply patches.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License along
  19  * with this program; if not, write to the Free Software Foundation, Inc.,
  20  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  21  * http://www.gnu.org/copyleft/gpl.html
  22  *
  23  * @file
  24  * @todo document
  25  * @ingroup Maintenance
  26  */
  27
  28 require_once __DIR__ . '/Maintenance.php';
  29
  30 use Wikimedia\Rdbms\IMaintainableDatabase;
  31
  32 /**
  33  * Maintenance script to run database schema updates.
  34  *
  35  * @ingroup Maintenance
  36  */
  37 class UpdateMediaWiki extends Maintenance {
  38         function __construct() {
  39                 parent::__construct();
  40                 $this->addDescription( 'MediaWiki database updater' );
  41                 $this->addOption( 'skip-compat-checks', 'Skips compatibility checks, mostly for developers' );
  42                 $this->addOption( 'quick', 'Skip 5 second countdown before starting' );
  43                 $this->addOption( 'doshared', 'Also update shared tables' );
  44                 $this->addOption( 'nopurge', 'Do not purge the objectcache table after updates' );
  45                 $this->addOption( 'noschema', 'Only do the updates that are not done during schema updates' );
  46                 $this->addOption(
  47                         'schema',
  48                         'Output SQL to do the schema updates instead of doing them. Works '
  49                                 . 'even when $wgAllowSchemaUpdates is false',
  50                         false,
  51                         true
  52                 );
  53                 $this->addOption( 'force', 'Override when $wgAllowSchemaUpdates disables this script' );
  54                 $this->addOption(
  55                         'skip-external-dependencies',
  56                         'Skips checking whether external dependencies are up to date, mostly for developers'
  57                 );
  58         }
  59
  60         function getDbType() {
  61                 return Maintenance::DB_ADMIN;
  62         }
  63
  64         function compatChecks() {
  65                 $minimumPcreVersion = Installer::MINIMUM_PCRE_VERSION;
  66
  67                 list( $pcreVersion ) = explode( ' ', PCRE_VERSION, 2 );
  68                 if ( version_compare( $pcreVersion, $minimumPcreVersion, '<' ) ) {
  69                         $this->fatalError(
  70                                 "PCRE $minimumPcreVersion or later is required.\n" .
  71                                 "Your PHP binary is linked with PCRE $pcreVersion.\n\n" .
  72                                 "More information:\n" .
  73                                 "https://www.mediawiki.org/wiki/Manual:Errors_and_symptoms/PCRE\n\n" .
  74                                 "ABORTING.\n" );
  75                 }
  76
  77                 $test = new PhpXmlBugTester();
  78                 if ( !$test->ok ) {
  79                         $this->fatalError(
  80                                 "Your system has a combination of PHP and libxml2 versions that is buggy\n" .
  81                                 "and can cause hidden data corruption in MediaWiki and other web apps.\n" .
  82                                 "Upgrade to libxml2 2.7.3 or later.\n" .
  83                                 "ABORTING (see https://bugs.php.net/bug.php?id=45996).\n" );
  84                 }
  85         }
  86
  87         function execute() {
  88                 global $wgVersion, $wgLang, $wgAllowSchemaUpdates, $wgMessagesDirs;
  89
  90                 if ( !$wgAllowSchemaUpdates
  91                         && !( $this->hasOption( 'force' )
  92                                 || $this->hasOption( 'schema' )
  93                                 || $this->hasOption( 'noschema' ) )
  94                 ) {
  95                         $this->fatalError( "Do not run update.php on this wiki. If you're seeing this you should\n"
  96                                 . "probably ask for some help in performing your schema updates or use\n"
  97                                 . "the --noschema and --schema options to get an SQL file for someone\n"
  98                                 . "else to inspect and run.\n\n"
  99                                 . "If you know what you are doing, you can continue with --force\n" );
 100                 }
 101
 102                 $this->fileHandle = null;
 103                 if ( substr( $this->getOption( 'schema' ), 0, 2 ) === "--" ) {
 104                         $this->fatalError( "The --schema option requires a file as an argument.\n" );
 105                 } elseif ( $this->hasOption( 'schema' ) ) {
 106                         $file = $this->getOption( 'schema' );
 107                         $this->fileHandle = fopen( $file, "w" );
 108                         if ( $this->fileHandle === false ) {
 109                                 $err = error_get_last();
 110                                 $this->fatalError( "Problem opening the schema file for writing: $file\n\t{$err['message']}" );
 111                         }
 112                 }
 113
 114                 // T206765: We need to load the installer i18n files as some of errors come installer/updater code
 115                 $wgMessagesDirs['MediawikiInstaller'] = dirname( __DIR__ ) . '/includes/installer/i18n';
 116
 117                 $lang = Language::factory( 'en' );
 118                 // Set global language to ensure localised errors are in English (T22633)
 119                 RequestContext::getMain()->setLanguage( $lang );
 120                 $wgLang = $lang; // BackCompat
 121
 122                 define( 'MW_UPDATER', true );
 123
 124                 $this->output( "MediaWiki {$wgVersion} Updater\n\n" );
 125
 126                 wfWaitForSlaves();
 127
 128                 if ( !$this->hasOption( 'skip-compat-checks' ) ) {
 129                         $this->compatChecks();
 130                 } else {
 131                         $this->output( "Skipping compatibility checks, proceed at your own risk (Ctrl+C to abort)\n" );
 132                         $this->countDown( 5 );
 133                 }
 134
 135                 // Check external dependencies are up to date
 136                 if ( !$this->hasOption( 'skip-external-dependencies' ) ) {
 137                         $composerLockUpToDate = $this->runChild( CheckComposerLockUpToDate::class );
 138                         $composerLockUpToDate->execute();
 139                 } else {
 140                         $this->output(
 141                                 "Skipping checking whether external dependencies are up to date, proceed at your own risk\n"
 142                         );
 143                 }
 144
 145                 # Attempt to connect to the database as a privileged user
 146                 # This will vomit up an error if there are permissions problems
 147                 $db = $this->getDB( DB_MASTER );
 148
 149                 # Check to see whether the database server meets the minimum requirements
 150                 /** @var DatabaseInstaller $dbInstallerClass */
 151                 $dbInstallerClass = Installer::getDBInstallerClass( $db->getType() );
 152                 $status = $dbInstallerClass::meetsMinimumRequirement( $db->getServerVersion() );
 153                 if ( !$status->isOK() ) {
 154                         // This might output some wikitext like <strong> but it should be comprehensible
 155                         $text = $status->getWikiText();
 156                         $this->fatalError( $text );
 157                 }
 158
 159                 $this->output( "Going to run database updates for " . wfWikiID() . "\n" );
 160                 if ( $db->getType() === 'sqlite' ) {
 161                         /** @var IMaintainableDatabase|DatabaseSqlite $db */
 162                         $this->output( "Using SQLite file: '{$db->getDbFilePath()}'\n" );
 163                 }
 164                 $this->output( "Depending on the size of your database this may take a while!\n" );
 165
 166                 if ( !$this->hasOption( 'quick' ) ) {
 167                         $this->output( "Abort with control-c in the next five seconds "
 168                                 . "(skip this countdown with --quick) ... " );
 169                         $this->countDown( 5 );
 170                 }
 171
 172                 $time1 = microtime( true );
 173
 174                 $badPhpUnit = dirname( __DIR__ ) . '/vendor/phpunit/phpunit/src/Util/PHP/eval-stdin.php';
 175                 if ( file_exists( $badPhpUnit ) ) {
 176                         // Bad versions of the file are:
 177                         // https://raw.githubusercontent.com/sebastianbergmann/phpunit/c820f915bfae34e5a836f94967a2a5ea5ef34f21/src/Util/PHP/eval-stdin.php
 178                         // https://raw.githubusercontent.com/sebastianbergmann/phpunit/3aaddb1c5bd9b9b8d070b4cf120e71c36fd08412/src/Util/PHP/eval-stdin.php
 179                         $md5 = md5_file( $badPhpUnit );
 180                         if ( $md5 === '120ac49800671dc383b6f3709c25c099'
 181                                 || $md5 === '28af792cb38fc9a1b236b91c1aad2876'
 182                         ) {
 183                                 $success = unlink( $badPhpUnit );
 184                                 if ( $success ) {
 185                                         $this->output( "Removed PHPUnit eval-stdin.php to protect against CVE-2017-9841\n" );
 186                                 } else {
 187                                         $this->error( "Unable to remove $badPhpUnit, you should manually. See CVE-2017-9841" );
 188                                 }
 189                         }
 190                 }
 191
 192                 $shared = $this->hasOption( 'doshared' );
 193
 194                 $updates = [ 'core', 'extensions' ];
 195                 if ( !$this->hasOption( 'schema' ) ) {
 196                         if ( $this->hasOption( 'noschema' ) ) {
 197                                 $updates[] = 'noschema';
 198                         }
 199                         $updates[] = 'stats';
 200                 }
 201
 202                 $updater = DatabaseUpdater::newForDB( $db, $shared, $this );
 203                 $updater->doUpdates( $updates );
 204
 205                 foreach ( $updater->getPostDatabaseUpdateMaintenance() as $maint ) {
 206                         $child = $this->runChild( $maint );
 207
 208                         // LoggedUpdateMaintenance is checking the updatelog itself
 209                         $isLoggedUpdate = $child instanceof LoggedUpdateMaintenance;
 210
 211                         if ( !$isLoggedUpdate && $updater->updateRowExists( $maint ) ) {
 212                                 continue;
 213                         }
 214
 215                         $child->execute();
 216                         if ( !$isLoggedUpdate ) {
 217                                 $updater->insertUpdateRow( $maint );
 218                         }
 219                 }
 220
 221                 $updater->setFileAccess();
 222                 if ( !$this->hasOption( 'nopurge' ) ) {
 223                         $updater->purgeCache();
 224                 }
 225
 226                 $time2 = microtime( true );
 227
 228                 $timeDiff = $lang->formatTimePeriod( $time2 - $time1 );
 229                 $this->output( "\nDone in $timeDiff.\n" );
 230         }
 231
 232         function afterFinalSetup() {
 233                 global $wgLocalisationCacheConf;
 234
 235                 # Don't try to access the database
 236                 # This needs to be disabled early since extensions will try to use the l10n
 237                 # cache from $wgExtensionFunctions (T22471)
 238                 $wgLocalisationCacheConf = [
 239                         'class' => LocalisationCache::class,
 240                         'storeClass' => LCStoreNull::class,
 241                         'storeDirectory' => false,
 242                         'manualRecache' => false,
 243                 ];
 244         }
 245 }
 246
 247 $maintClass = UpdateMediaWiki::class;
 248 require_once RUN_MAINTENANCE_IF_MAIN;