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 $wgUseMasterForMaintenance = true;
  29 require_once __DIR__ . '/Maintenance.php';
  30
  31 /**
  32  * Maintenance script to run database schema updates.
  33  *
  34  * @ingroup Maintenance
  35  */
  36 class UpdateMediaWiki extends Maintenance {
  37         function __construct() {
  38                 parent::__construct();
  39                 $this->addDescription( 'MediaWiki database updater' );
  40                 $this->addOption( 'skip-compat-checks', 'Skips compatibility checks, mostly for developers' );
  41                 $this->addOption( 'quick', 'Skip 5 second countdown before starting' );
  42                 $this->addOption( 'doshared', 'Also update shared tables' );
  43                 $this->addOption( 'nopurge', 'Do not purge the objectcache table after updates' );
  44                 $this->addOption( 'noschema', 'Only do the updates that are not done during schema updates' );
  45                 $this->addOption(
  46                         'schema',
  47                         'Output SQL to do the schema updates instead of doing them. Works '
  48                                 . 'even when $wgAllowSchemaUpdates is false',
  49                         false,
  50                         true
  51                 );
  52                 $this->addOption( 'force', 'Override when $wgAllowSchemaUpdates disables this script' );
  53                 $this->addOption(
  54                         'skip-external-dependencies',
  55                         'Skips checking whether external dependencies are up to date, mostly for developers'
  56                 );
  57         }
  58
  59         function getDbType() {
  60                 return Maintenance::DB_ADMIN;
  61         }
  62
  63         function compatChecks() {
  64                 $minimumPcreVersion = Installer::MINIMUM_PCRE_VERSION;
  65
  66                 list( $pcreVersion ) = explode( ' ', PCRE_VERSION, 2 );
  67                 if ( version_compare( $pcreVersion, $minimumPcreVersion, '<' ) ) {
  68                         $this->error(
  69                                 "PCRE $minimumPcreVersion or later is required.\n" .
  70                                 "Your PHP binary is linked with PCRE $pcreVersion.\n\n" .
  71                                 "More information:\n" .
  72                                 "https://www.mediawiki.org/wiki/Manual:Errors_and_symptoms/PCRE\n\n" .
  73                                 "ABORTING.\n",
  74                                 true );
  75                 }
  76
  77                 $test = new PhpXmlBugTester();
  78                 if ( !$test->ok ) {
  79                         $this->error(
  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                                 true );
  85                 }
  86
  87                 if ( !function_exists( 'mb_strlen' ) ) {
  88                         $this->error(
  89                                 "MediaWiki now requires the mbstring PHP extension, your system doesn't have it.\n"
  90                                 . "ABORTING.\n",
  91                                 true );
  92                 }
  93         }
  94
  95         function execute() {
  96                 global $wgVersion, $wgLang, $wgAllowSchemaUpdates;
  97
  98                 if ( !$wgAllowSchemaUpdates
  99                         && !( $this->hasOption( 'force' )
 100                                 || $this->hasOption( 'schema' )
 101                                 || $this->hasOption( 'noschema' ) )
 102                 ) {
 103                         $this->error( "Do not run update.php on this wiki. If you're seeing this you should\n"
 104                                 . "probably ask for some help in performing your schema updates or use\n"
 105                                 . "the --noschema and --schema options to get an SQL file for someone\n"
 106                                 . "else to inspect and run.\n\n"
 107                                 . "If you know what you are doing, you can continue with --force\n", true );
 108                 }
 109
 110                 $this->fileHandle = null;
 111                 if ( substr( $this->getOption( 'schema' ), 0, 2 ) === "--" ) {
 112                         $this->error( "The --schema option requires a file as an argument.\n", true );
 113                 } elseif ( $this->hasOption( 'schema' ) ) {
 114                         $file = $this->getOption( 'schema' );
 115                         $this->fileHandle = fopen( $file, "w" );
 116                         if ( $this->fileHandle === false ) {
 117                                 $err = error_get_last();
 118                                 $this->error( "Problem opening the schema file for writing: $file\n\t{$err['message']}", true );
 119                         }
 120                 }
 121
 122                 $lang = Language::factory( 'en' );
 123                 // Set global language to ensure localised errors are in English (bug 20633)
 124                 RequestContext::getMain()->setLanguage( $lang );
 125                 $wgLang = $lang; // BackCompat
 126
 127                 define( 'MW_UPDATER', true );
 128
 129                 $this->output( "MediaWiki {$wgVersion} Updater\n\n" );
 130
 131                 wfWaitForSlaves();
 132
 133                 if ( !$this->hasOption( 'skip-compat-checks' ) ) {
 134                         $this->compatChecks();
 135                 } else {
 136                         $this->output( "Skipping compatibility checks, proceed at your own risk (Ctrl+C to abort)\n" );
 137                         wfCountDown( 5 );
 138                 }
 139
 140                 // Check external dependencies are up to date
 141                 if ( !$this->hasOption( 'skip-external-dependencies' ) ) {
 142                         $composerLockUpToDate = $this->runChild( 'CheckComposerLockUpToDate' );
 143                         $composerLockUpToDate->execute();
 144                 } else {
 145                         $this->output(
 146                                 "Skipping checking whether external dependencies are up to date, proceed at your own risk\n"
 147                         );
 148                 }
 149
 150                 # Attempt to connect to the database as a privileged user
 151                 # This will vomit up an error if there are permissions problems
 152                 $db = $this->getDB( DB_MASTER );
 153
 154                 $this->output( "Going to run database updates for " . wfWikiID() . "\n" );
 155                 if ( $db->getType() === 'sqlite' ) {
 156                         $this->output( "Using SQLite file: '{$db->getDbFilePath()}'\n" );
 157                 }
 158                 $this->output( "Depending on the size of your database this may take a while!\n" );
 159
 160                 if ( !$this->hasOption( 'quick' ) ) {
 161                         $this->output( "Abort with control-c in the next five seconds "
 162                                 . "(skip this countdown with --quick) ... " );
 163                         wfCountDown( 5 );
 164                 }
 165
 166                 $time1 = microtime( true );
 167
 168                 $shared = $this->hasOption( 'doshared' );
 169
 170                 $updates = [ 'core', 'extensions' ];
 171                 if ( !$this->hasOption( 'schema' ) ) {
 172                         if ( $this->hasOption( 'noschema' ) ) {
 173                                 $updates[] = 'noschema';
 174                         }
 175                         $updates[] = 'stats';
 176                 }
 177
 178                 $updater = DatabaseUpdater::newForDB( $db, $shared, $this );
 179                 $updater->doUpdates( $updates );
 180
 181                 foreach ( $updater->getPostDatabaseUpdateMaintenance() as $maint ) {
 182                         $child = $this->runChild( $maint );
 183
 184                         // LoggedUpdateMaintenance is checking the updatelog itself
 185                         $isLoggedUpdate = $child instanceof LoggedUpdateMaintenance;
 186
 187                         if ( !$isLoggedUpdate && $updater->updateRowExists( $maint ) ) {
 188                                 continue;
 189                         }
 190
 191                         $child->execute();
 192                         if ( !$isLoggedUpdate ) {
 193                                 $updater->insertUpdateRow( $maint );
 194                         }
 195                 }
 196
 197                 $updater->setFileAccess();
 198                 if ( !$this->hasOption( 'nopurge' ) ) {
 199                         $updater->purgeCache();
 200                 }
 201
 202                 $time2 = microtime( true );
 203
 204                 $timeDiff = $lang->formatTimePeriod( $time2 - $time1 );
 205                 $this->output( "\nDone in $timeDiff.\n" );
 206         }
 207
 208         function afterFinalSetup() {
 209                 global $wgLocalisationCacheConf;
 210
 211                 # Don't try to access the database
 212                 # This needs to be disabled early since extensions will try to use the l10n
 213                 # cache from $wgExtensionFunctions (bug 20471)
 214                 $wgLocalisationCacheConf = [
 215                         'class' => 'LocalisationCache',
 216                         'storeClass' => 'LCStoreNull',
 217                         'storeDirectory' => false,
 218                         'manualRecache' => false,
 219                 ];
 220         }
 221 }
 222
 223 $maintClass = 'UpdateMediaWiki';
 224 require_once RUN_MAINTENANCE_IF_MAIN;