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  * It is kept compatible with php 4 parsing so that it can give out a meaningful error.
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License along
  20  * with this program; if not, write to the Free Software Foundation, Inc.,
  21  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  22  * http://www.gnu.org/copyleft/gpl.html
  23  *
  24  * @file
  25  * @todo document
  26  * @ingroup Maintenance
  27  */
  28
  29 $wgUseMasterForMaintenance = true;
  30 require_once __DIR__ . '/Maintenance.php';
  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->mDescription = "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                 // Avoid syntax error in PHP4
  66                 $minimumPcreVersion = constant( 'Installer::MINIMUM_PCRE_VERSION' );
  67
  68                 list( $pcreVersion ) = explode( ' ', PCRE_VERSION, 2 );
  69                 if ( version_compare( $pcreVersion, $minimumPcreVersion, '<' ) ) {
  70                         $this->error(
  71                                 "PCRE $minimumPcreVersion or later is required.\n" .
  72                                 "Your PHP binary is linked with PCRE $pcreVersion.\n\n" .
  73                                 "More information:\n" .
  74                                 "https://www.mediawiki.org/wiki/Manual:Errors_and_symptoms/PCRE\n\n" .
  75                                 "ABORTING.\n",
  76                                 true );
  77                 }
  78
  79                 $test = new PhpXmlBugTester();
  80                 if ( !$test->ok ) {
  81                         $this->error(
  82                                 "Your system has a combination of PHP and libxml2 versions that is buggy\n" .
  83                                 "and can cause hidden data corruption in MediaWiki and other web apps.\n" .
  84                                 "Upgrade to libxml2 2.7.3 or later.\n" .
  85                                 "ABORTING (see https://bugs.php.net/bug.php?id=45996).\n",
  86                                 true );
  87                 }
  88         }
  89
  90         function execute() {
  91                 global $wgVersion, $wgLang, $wgAllowSchemaUpdates;
  92
  93                 if ( !$wgAllowSchemaUpdates
  94                         && !( $this->hasOption( 'force' )
  95                                 || $this->hasOption( 'schema' )
  96                                 || $this->hasOption( 'noschema' ) )
  97                 ) {
  98                         $this->error( "Do not run update.php on this wiki. If you're seeing this you should\n"
  99                                 . "probably ask for some help in performing your schema updates or use\n"
 100                                 . "the --noschema and --schema options to get an SQL file for someone\n"
 101                                 . "else to inspect and run.\n\n"
 102                                 . "If you know what you are doing, you can continue with --force\n", true );
 103                 }
 104
 105                 $this->fileHandle = null;
 106                 if ( substr( $this->getOption( 'schema' ), 0, 2 ) === "--" ) {
 107                         $this->error( "The --schema option requires a file as an argument.\n", true );
 108                 } elseif ( $this->hasOption( 'schema' ) ) {
 109                         $file = $this->getOption( 'schema' );
 110                         $this->fileHandle = fopen( $file, "w" );
 111                         if ( $this->fileHandle === false ) {
 112                                 $err = error_get_last();
 113                                 $this->error( "Problem opening the schema file for writing: $file\n\t{$err['message']}", true );
 114                         }
 115                 }
 116
 117                 $wgLang = Language::factory( 'en' );
 118
 119                 define( 'MW_UPDATER', true );
 120
 121                 $this->output( "MediaWiki {$wgVersion} Updater\n\n" );
 122
 123                 wfWaitForSlaves();
 124
 125                 if ( !$this->hasOption( 'skip-compat-checks' ) ) {
 126                         $this->compatChecks();
 127                 } else {
 128                         $this->output( "Skipping compatibility checks, proceed at your own risk (Ctrl+C to abort)\n" );
 129                         wfCountdown( 5 );
 130                 }
 131
 132                 // Check external dependencies are up to date
 133                 if ( !$this->hasOption( 'skip-external-dependencies' ) ) {
 134                         $composerLockUpToDate = $this->runChild( 'CheckComposerLockUpToDate' );
 135                         $composerLockUpToDate->execute();
 136                 } else {
 137                         $this->output(
 138                                 "Skipping checking whether external dependencies are up to date, proceed at your own risk\n"
 139                         );
 140                 }
 141
 142                 # Attempt to connect to the database as a privileged user
 143                 # This will vomit up an error if there are permissions problems
 144                 $db = wfGetDB( DB_MASTER );
 145
 146                 $this->output( "Going to run database updates for " . wfWikiID() . "\n" );
 147                 if ( $db->getType() === 'sqlite' ) {
 148                         $this->output( "Using SQLite file: '{$db->getDbFilePath()}'\n" );
 149                 }
 150                 $this->output( "Depending on the size of your database this may take a while!\n" );
 151
 152                 if ( !$this->hasOption( 'quick' ) ) {
 153                         $this->output( "Abort with control-c in the next five seconds "
 154                                 . "(skip this countdown with --quick) ... " );
 155                         wfCountDown( 5 );
 156                 }
 157
 158                 $time1 = microtime( true );
 159
 160                 $shared = $this->hasOption( 'doshared' );
 161
 162                 $updates = array( 'core', 'extensions' );
 163                 if ( !$this->hasOption( 'schema' ) ) {
 164                         if ( $this->hasOption( 'noschema' ) ) {
 165                                 $updates[] = 'noschema';
 166                         }
 167                         $updates[] = 'stats';
 168                 }
 169
 170                 $updater = DatabaseUpdater::newForDb( $db, $shared, $this );
 171                 $updater->doUpdates( $updates );
 172
 173                 foreach ( $updater->getPostDatabaseUpdateMaintenance() as $maint ) {
 174                         $child = $this->runChild( $maint );
 175
 176                         // LoggedUpdateMaintenance is checking the updatelog itself
 177                         $isLoggedUpdate = is_a( $child, 'LoggedUpdateMaintenance' );
 178
 179                         if ( !$isLoggedUpdate && $updater->updateRowExists( $maint ) ) {
 180                                 continue;
 181                         }
 182
 183                         $child->execute();
 184                         if ( !$isLoggedUpdate ) {
 185                                 $updater->insertUpdateRow( $maint );
 186                         }
 187                 }
 188
 189                 $updater->setFileAccess();
 190                 if ( !$this->hasOption( 'nopurge' ) ) {
 191                         $updater->purgeCache();
 192                 }
 193
 194                 $time2 = microtime( true );
 195
 196                 $timeDiff = $wgLang->formatTimePeriod( $time2 - $time1 );
 197                 $this->output( "\nDone in $timeDiff.\n" );
 198         }
 199
 200         function afterFinalSetup() {
 201                 global $wgLocalisationCacheConf;
 202
 203                 # Don't try to access the database
 204                 # This needs to be disabled early since extensions will try to use the l10n
 205                 # cache from $wgExtensionFunctions (bug 20471)
 206                 $wgLocalisationCacheConf = array(
 207                         'class' => 'LocalisationCache',
 208                         'storeClass' => 'LCStoreNull',
 209                         'storeDirectory' => false,
 210                         'manualRecache' => false,
 211                 );
 212         }
 213 }
 214
 215 $maintClass = 'UpdateMediaWiki';
 216 require_once RUN_MAINTENANCE_IF_MAIN;