Go to the documentation of this file.
28 require_once __DIR__ .
'/Maintenance.php';
39 parent::__construct();
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'
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" .
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",
92 if ( !$wgAllowSchemaUpdates
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' ) ) {
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 );
121 define(
'MW_UPDATER',
true );
123 $this->
output(
"MediaWiki {$wgVersion} Updater\n\n" );
127 if ( !$this->
hasOption(
'skip-compat-checks' ) ) {
130 $this->
output(
"Skipping compatibility checks, proceed at your own risk (Ctrl+C to abort)\n" );
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
148 $this->
output(
"Going to run database updates for " .
wfWikiID() .
"\n" );
149 if ( $db->getType() ===
'sqlite' ) {
151 $this->
output(
"Using SQLite file: '{$db->getDbFilePath()}'\n" );
153 $this->
output(
"Depending on the size of your database this may take a while!\n" );
156 $this->
output(
"Abort with control-c in the next five seconds "
157 .
"(skip this countdown with --quick) ... " );
161 $time1 = microtime(
true );
163 $shared = $this->
hasOption(
'doshared' );
165 $updates = [
'core',
'extensions' ];
168 $updates[] =
'noschema';
170 $updates[] =
'stats';
174 $updater->doUpdates( $updates );
176 foreach ( $updater->getPostDatabaseUpdateMaintenance()
as $maint ) {
182 if ( !$isLoggedUpdate && $updater->updateRowExists( $maint ) ) {
187 if ( !$isLoggedUpdate ) {
188 $updater->insertUpdateRow( $maint );
192 $updater->setFileAccess();
194 $updater->purgeCache();
197 $time2 = microtime(
true );
199 $timeDiff =
$lang->formatTimePeriod( $time2 - $time1 );
200 $this->
output(
"\nDone in $timeDiff.\n" );
206 # Don't try to access the database
207 # This needs to be disabled early since extensions will try to use the l10n
208 # cache from $wgExtensionFunctions (T22471)
209 $wgLocalisationCacheConf = [
210 'class' =>
'LocalisationCache',
211 'storeClass' =>
'LCStoreNull',
212 'storeDirectory' =>
false,
213 'manualRecache' =>
false,
if(!isset( $args[0])) $lang
addDescription( $text)
Set the description text.
runChild( $maintClass, $classFile=null)
Run a child maintenance script.
$wgVersion
MediaWiki version number.
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
require_once RUN_MAINTENANCE_IF_MAIN
$wgAllowSchemaUpdates
Allow schema updates.
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
wfWaitForSlaves( $ifWritesSince=null, $wiki=false, $cluster=false, $timeout=null)
Waits for the replica DBs to catch up to the master position.
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Class for scripts that perform database maintenance and want to log the update in updatelog so we can...
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as $wgLang
$wgLocalisationCacheConf
Localisation cache configuration.
when a variable name is used in a it is silently declared as a new masking the global
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
execute()
Do the actual work.
wfWikiID()
Get an ASCII string identifying this wiki This is used as a prefix in memcached keys.
static newForDB(Database $db, $shared=false, $maintenance=null)
static getMain()
Static methods.
Test for PHP+libxml2 bug which breaks XML input subtly with certain versions.
getOption( $name, $default=null)
Get an option, or return the default.
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
getDB( $db, $groups=[], $wiki=false)
Returns a database to be used by current maintenance script.
error( $err, $die=0)
Throw an error to the user.
output( $out, $channel=null)
Throw some output to the user.
const MINIMUM_PCRE_VERSION
The oldest version of PCRE we can support.
static factory( $code)
Get a cached or new language object for a given language code.
hasOption( $name)
Checks to see if a particular param exists.
Advanced database interface for IDatabase handles that include maintenance methods.
wfCountDown( $seconds)
Count down from $seconds to zero on the terminal, with a one-second pause between showing each number...