6 * This is used when the database schema is modified and we need to apply patches.
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.
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.
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
25 * @ingroup Maintenance
28 require_once __DIR__
. '/Maintenance.php';
30 use Wikimedia\Rdbms\IMaintainableDatabase
;
33 * Maintenance script to run database schema updates.
35 * @ingroup Maintenance
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' );
48 'Output SQL to do the schema updates instead of doing them. Works '
49 . 'even when $wgAllowSchemaUpdates is false',
53 $this->addOption( 'force', 'Override when $wgAllowSchemaUpdates disables this script' );
55 'skip-external-dependencies',
56 'Skips checking whether external dependencies are up to date, mostly for developers'
60 function getDbType() {
61 return Maintenance
::DB_ADMIN
;
64 function compatChecks() {
65 $minimumPcreVersion = Installer
::MINIMUM_PCRE_VERSION
;
67 list( $pcreVersion ) = explode( ' ', PCRE_VERSION
, 2 );
68 if ( version_compare( $pcreVersion, $minimumPcreVersion, '<' ) ) {
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" .
78 $test = new PhpXmlBugTester();
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",
90 global $wgVersion, $wgLang, $wgAllowSchemaUpdates;
92 if ( !$wgAllowSchemaUpdates
93 && !( $this->hasOption( 'force' )
94 ||
$this->hasOption( 'schema' )
95 ||
$this->hasOption( 'noschema' ) )
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 );
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 );
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
121 define( 'MW_UPDATER', true );
123 $this->output( "MediaWiki {$wgVersion} Updater\n\n" );
127 if ( !$this->hasOption( 'skip-compat-checks' ) ) {
128 $this->compatChecks();
130 $this->output( "Skipping compatibility checks, proceed at your own risk (Ctrl+C to abort)\n" );
131 $this->countDown( 5 );
134 // Check external dependencies are up to date
135 if ( !$this->hasOption( 'skip-external-dependencies' ) ) {
136 $composerLockUpToDate = $this->runChild( 'CheckComposerLockUpToDate' );
137 $composerLockUpToDate->execute();
140 "Skipping checking whether external dependencies are up to date, proceed at your own risk\n"
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
);
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 );
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" );
163 $this->output( "Depending on the size of your database this may take a while!\n" );
165 if ( !$this->hasOption( 'quick' ) ) {
166 $this->output( "Abort with control-c in the next five seconds "
167 . "(skip this countdown with --quick) ... " );
168 $this->countDown( 5 );
171 $time1 = microtime( true );
173 $badPhpUnit = dirname( __DIR__
) . '/vendor/phpunit/phpunit/src/Util/PHP/eval-stdin.php';
174 if ( file_exists( $badPhpUnit ) ) {
175 // Bad versions of the file are:
176 // https://raw.githubusercontent.com/sebastianbergmann/phpunit/c820f91/src/Util/PHP/eval-stdin.php
177 // https://raw.githubusercontent.com/sebastianbergmann/phpunit/3aaddb1/src/Util/PHP/eval-stdin.php
178 $md5 = md5_file( $badPhpUnit );
179 if ( $md5 === '120ac49800671dc383b6f3709c25c099'
180 ||
$md5 === '28af792cb38fc9a1b236b91c1aad2876'
182 $success = unlink( $badPhpUnit );
184 $this->output( "Removed PHPUnit eval-stdin.php to protect against CVE-2017-9841\n" );
186 $this->error( "Unable to remove $badPhpUnit, you should manually. See CVE-2017-9841" );
191 $shared = $this->hasOption( 'doshared' );
193 $updates = [ 'core', 'extensions' ];
194 if ( !$this->hasOption( 'schema' ) ) {
195 if ( $this->hasOption( 'noschema' ) ) {
196 $updates[] = 'noschema';
198 $updates[] = 'stats';
201 $updater = DatabaseUpdater
::newForDB( $db, $shared, $this );
202 $updater->doUpdates( $updates );
204 foreach ( $updater->getPostDatabaseUpdateMaintenance() as $maint ) {
205 $child = $this->runChild( $maint );
207 // LoggedUpdateMaintenance is checking the updatelog itself
208 $isLoggedUpdate = $child instanceof LoggedUpdateMaintenance
;
210 if ( !$isLoggedUpdate && $updater->updateRowExists( $maint ) ) {
215 if ( !$isLoggedUpdate ) {
216 $updater->insertUpdateRow( $maint );
220 $updater->setFileAccess();
221 if ( !$this->hasOption( 'nopurge' ) ) {
222 $updater->purgeCache();
225 $time2 = microtime( true );
227 $timeDiff = $lang->formatTimePeriod( $time2 - $time1 );
228 $this->output( "\nDone in $timeDiff.\n" );
231 function afterFinalSetup() {
232 global $wgLocalisationCacheConf;
234 # Don't try to access the database
235 # This needs to be disabled early since extensions will try to use the l10n
236 # cache from $wgExtensionFunctions (T22471)
237 $wgLocalisationCacheConf = [
238 'class' => 'LocalisationCache',
239 'storeClass' => 'LCStoreNull',
240 'storeDirectory' => false,
241 'manualRecache' => false,
246 $maintClass = 'UpdateMediaWiki';
247 require_once RUN_MAINTENANCE_IF_MAIN
;