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->error(
  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                                 true );
  76                 }
  77
  78                 $test = new PhpXmlBugTester();
  79                 if ( !$test->ok ) {
  80                         $this->error(
  81                                 "Your system has a combination of PHP and libxml2 versions that is buggy\n" .
  82                                 "and can cause hidden data corruption in MediaWiki and other web apps.\n" .
  83                                 "Upgrade to libxml2 2.7.3 or later.\n" .
  84                                 "ABORTING (see https://bugs.php.net/bug.php?id=45996).\n",
  85                                 true );
  86                 }
  87         }
  88
  89         function execute() {
  90                 global $wgVersion, $wgLang, $wgAllowSchemaUpdates;
  91
  92                 if ( !$wgAllowSchemaUpdates
  93                         && !( $this->hasOption( 'force' )
  94                                 || $this->hasOption( 'schema' )
  95                                 || $this->hasOption( 'noschema' ) )
  96                 ) {
  97                         $this->error( "Do not run update.php on this wiki. If you're seeing this you should\n"
  98                                 . "probably ask for some help in performing your schema updates or use\n"
  99                                 . "the --noschema and --schema options to get an SQL file for someone\n"
 100                                 . "else to inspect and run.\n\n"
 101                                 . "If you know what you are doing, you can continue with --force\n", true );
 102                 }
 103
 104                 $this->fileHandle = null;
 105                 if ( substr( $this->getOption( 'schema' ), 0, 2 ) === "--" ) {
 106                         $this->error( "The --schema option requires a file as an argument.\n", true );
 107                 } elseif ( $this->hasOption( 'schema' ) ) {
 108                         $file = $this->getOption( 'schema' );
 109                         $this->fileHandle = fopen( $file, "w" );
 110                         if ( $this->fileHandle === false ) {
 111                                 $err = error_get_last();
 112                                 $this->error( "Problem opening the schema file for writing: $file\n\t{$err['message']}", true );
 113                         }
 114                 }
 115
 116                 $lang = Language::factory( 'en' );
 117                 // Set global language to ensure localised errors are in English (T22633)
 118                 RequestContext::getMain()->setLanguage( $lang );
 119                 $wgLang = $lang; // BackCompat
 120
 121                 define( 'MW_UPDATER', true );
 122
 123                 $this->output( "MediaWiki {$wgVersion} Updater\n\n" );
 124
 125                 wfWaitForSlaves();
 126
 127                 if ( !$this->hasOption( 'skip-compat-checks' ) ) {
 128                         $this->compatChecks();
 129                 } else {
 130                         $this->output( "Skipping compatibility checks, proceed at your own risk (Ctrl+C to abort)\n" );
 131                         wfCountDown( 5 );
 132                 }
 133
 134                 // Check external dependencies are up to date
 135                 if ( !$this->hasOption( 'skip-external-dependencies' ) ) {
 136                         $composerLockUpToDate = $this->runChild( 'CheckComposerLockUpToDate' );
 137                         $composerLockUpToDate->execute();
 138                 } else {
 139                         $this->output(
 140                                 "Skipping checking whether external dependencies are up to date, proceed at your own risk\n"
 141                         );
 142                 }
 143
 144                 # Attempt to connect to the database as a privileged user
 145                 # This will vomit up an error if there are permissions problems
 146                 $db = $this->getDB( DB_MASTER );
 147
 148                 # Check to see whether the database server meets the minimum requirements
 149                 /** @var DatabaseInstaller $dbInstallerClass */
 150                 $dbInstallerClass = Installer::getDBInstallerClass( $db->getType() );
 151                 $status = $dbInstallerClass::meetsMinimumRequirement( $db->getServerVersion() );
 152                 if ( !$status->isOK() ) {
 153                         // This might output some wikitext like <strong> but it should be comprehensible
 154                         $text = $status->getWikiText();
 155                         $this->error( $text, 1 );
 156                 }
 157
 158                 $this->output( "Going to run database updates for " . wfWikiID() . "\n" );
 159                 if ( $db->getType() === 'sqlite' ) {
 160                         /** @var IMaintainableDatabase|DatabaseSqlite $db */
 161                         $this->output( "Using SQLite file: '{$db->getDbFilePath()}'\n" );
 162                 }
 163                 $this->output( "Depending on the size of your database this may take a while!\n" );
 164
 165                 if ( !$this->hasOption( 'quick' ) ) {
 166                         $this->output( "Abort with control-c in the next five seconds "
 167                                 . "(skip this countdown with --quick) ... " );
 168                         wfCountDown( 5 );
 169                 }
 170
 171                 $time1 = microtime( true );
 172
 173                 $badPhpUnit = dirname( __DIR__ ) . '/vendor/phpunit/phpunit/src/Util/PHP/eval-stdin.php';
 174                 if ( file_exists( $badPhpUnit ) ) {
 175                         // @codingStandardsIgnoreStart Generic.Files.LineLength.TooLong
 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                         // @codingStandardsIgnoreEnd
 180                         $md5 = md5_file( $badPhpUnit );
 181                         if ( $md5 === '120ac49800671dc383b6f3709c25c099'
 182                                 || $md5 === '28af792cb38fc9a1b236b91c1aad2876'
 183                         ) {
 184                                 $success = unlink( $badPhpUnit );
 185                                 if ( $success ) {
 186                                         $this->output( "Removed PHPUnit eval-stdin.php to protect against CVE-2017-9841\n" );
 187                                 } else {
 188                                         $this->error( "Unable to remove $badPhpUnit, you should manually. See CVE-2017-9841" );
 189                                 }
 190                         }
 191                 }
 192
 193                 $shared = $this->hasOption( 'doshared' );
 194
 195                 $updates = [ 'core', 'extensions' ];
 196                 if ( !$this->hasOption( 'schema' ) ) {
 197                         if ( $this->hasOption( 'noschema' ) ) {
 198                                 $updates[] = 'noschema';
 199                         }
 200                         $updates[] = 'stats';
 201                 }
 202
 203                 $updater = DatabaseUpdater::newForDB( $db, $shared, $this );
 204                 $updater->doUpdates( $updates );
 205
 206                 foreach ( $updater->getPostDatabaseUpdateMaintenance() as $maint ) {
 207                         $child = $this->runChild( $maint );
 208
 209                         // LoggedUpdateMaintenance is checking the updatelog itself
 210                         $isLoggedUpdate = $child instanceof LoggedUpdateMaintenance;
 211
 212                         if ( !$isLoggedUpdate && $updater->updateRowExists( $maint ) ) {
 213                                 continue;
 214                         }
 215
 216                         $child->execute();
 217                         if ( !$isLoggedUpdate ) {
 218                                 $updater->insertUpdateRow( $maint );
 219                         }
 220                 }
 221
 222                 $updater->setFileAccess();
 223                 if ( !$this->hasOption( 'nopurge' ) ) {
 224                         $updater->purgeCache();
 225                 }
 226
 227                 $time2 = microtime( true );
 228
 229                 $timeDiff = $lang->formatTimePeriod( $time2 - $time1 );
 230                 $this->output( "\nDone in $timeDiff.\n" );
 231         }
 232
 233         function afterFinalSetup() {
 234                 global $wgLocalisationCacheConf;
 235
 236                 # Don't try to access the database
 237                 # This needs to be disabled early since extensions will try to use the l10n
 238                 # cache from $wgExtensionFunctions (T22471)
 239                 $wgLocalisationCacheConf = [
 240                         'class' => 'LocalisationCache',
 241                         'storeClass' => 'LCStoreNull',
 242                         'storeDirectory' => false,
 243                         'manualRecache' => false,
 244                 ];
 245         }
 246 }
 247
 248 $maintClass = 'UpdateMediaWiki';
 249 require_once RUN_MAINTENANCE_IF_MAIN;