MediaWiki  1.33.0
Go to the documentation of this file.
1 #!/usr/bin/env php
2 <?php
28 require_once __DIR__ . '/Maintenance.php';
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  }
60  function getDbType() {
61  return Maintenance::DB_ADMIN;
62  }
64  function compatChecks() {
65  $minimumPcreVersion = Installer::MINIMUM_PCRE_VERSION;
67  list( $pcreVersion ) = explode( ' ', PCRE_VERSION, 2 );
68  if ( version_compare( $pcreVersion, $minimumPcreVersion, '<' ) ) {
69  $this->fatalError(
70  "PCRE $minimumPcreVersion or later is required.\n" .
71  "Your PHP binary is linked with PCRE $pcreVersion.\n\n" .
72  "More information:\n" .
73  "\n\n" .
74  "ABORTING.\n" );
75  }
77  $test = new PhpXmlBugTester();
78  if ( !$test->ok ) {
79  $this->fatalError(
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\n" );
84  }
85  }
87  function execute() {
91  && !( $this->hasOption( 'force' )
92  || $this->hasOption( 'schema' )
93  || $this->hasOption( 'noschema' ) )
94  ) {
95  $this->fatalError( "Do not run update.php on this wiki. If you're seeing this you should\n"
96  . "probably ask for some help in performing your schema updates or use\n"
97  . "the --noschema and --schema options to get an SQL file for someone\n"
98  . "else to inspect and run.\n\n"
99  . "If you know what you are doing, you can continue with --force\n" );
100  }
102  $this->fileHandle = null;
103  if ( substr( $this->getOption( 'schema' ), 0, 2 ) === "--" ) {
104  $this->fatalError( "The --schema option requires a file as an argument.\n" );
105  } elseif ( $this->hasOption( 'schema' ) ) {
106  $file = $this->getOption( 'schema' );
107  $this->fileHandle = fopen( $file, "w" );
108  if ( $this->fileHandle === false ) {
109  $err = error_get_last();
110  $this->fatalError( "Problem opening the schema file for writing: $file\n\t{$err['message']}" );
111  }
112  }
114  // T206765: We need to load the installer i18n files as some of errors come installer/updater code
115  $wgMessagesDirs['MediawikiInstaller'] = dirname( __DIR__ ) . '/includes/installer/i18n';
117  $lang = Language::factory( 'en' );
118  // Set global language to ensure localised errors are in English (T22633)
119  RequestContext::getMain()->setLanguage( $lang );
120  $wgLang = $lang; // BackCompat
122  define( 'MW_UPDATER', true );
124  $this->output( "MediaWiki {$wgVersion} Updater\n\n" );
126  wfWaitForSlaves();
128  if ( !$this->hasOption( 'skip-compat-checks' ) ) {
129  $this->compatChecks();
130  } else {
131  $this->output( "Skipping compatibility checks, proceed at your own risk (Ctrl+C to abort)\n" );
132  $this->countDown( 5 );
133  }
135  // Check external dependencies are up to date
136  if ( !$this->hasOption( 'skip-external-dependencies' ) ) {
137  $composerLockUpToDate = $this->runChild( CheckComposerLockUpToDate::class );
138  $composerLockUpToDate->execute();
139  } else {
140  $this->output(
141  "Skipping checking whether external dependencies are up to date, proceed at your own risk\n"
142  );
143  }
145  # Attempt to connect to the database as a privileged user
146  # This will vomit up an error if there are permissions problems
147  $db = $this->getDB( DB_MASTER );
149  # Check to see whether the database server meets the minimum requirements
151  $dbInstallerClass = Installer::getDBInstallerClass( $db->getType() );
152  $status = $dbInstallerClass::meetsMinimumRequirement( $db->getServerVersion() );
153  if ( !$status->isOK() ) {
154  // This might output some wikitext like <strong> but it should be comprehensible
155  $text = $status->getWikiText();
156  $this->fatalError( $text );
157  }
159  $this->output( "Going to run database updates for " . wfWikiID() . "\n" );
160  if ( $db->getType() === 'sqlite' ) {
162  $this->output( "Using SQLite file: '{$db->getDbFilePath()}'\n" );
163  }
164  $this->output( "Depending on the size of your database this may take a while!\n" );
166  if ( !$this->hasOption( 'quick' ) ) {
167  $this->output( "Abort with control-c in the next five seconds "
168  . "(skip this countdown with --quick) ... " );
169  $this->countDown( 5 );
170  }
172  $time1 = microtime( true );
174  $badPhpUnit = dirname( __DIR__ ) . '/vendor/phpunit/phpunit/src/Util/PHP/eval-stdin.php';
175  if ( file_exists( $badPhpUnit ) ) {
176  // Bad versions of the file are:
177  //
178  //
179  $md5 = md5_file( $badPhpUnit );
180  if ( $md5 === '120ac49800671dc383b6f3709c25c099'
181  || $md5 === '28af792cb38fc9a1b236b91c1aad2876'
182  ) {
183  $success = unlink( $badPhpUnit );
184  if ( $success ) {
185  $this->output( "Removed PHPUnit eval-stdin.php to protect against CVE-2017-9841\n" );
186  } else {
187  $this->error( "Unable to remove $badPhpUnit, you should manually. See CVE-2017-9841" );
188  }
189  }
190  }
192  $shared = $this->hasOption( 'doshared' );
194  $updates = [ 'core', 'extensions' ];
195  if ( !$this->hasOption( 'schema' ) ) {
196  if ( $this->hasOption( 'noschema' ) ) {
197  $updates[] = 'noschema';
198  }
199  $updates[] = 'stats';
200  }
202  $updater = DatabaseUpdater::newForDB( $db, $shared, $this );
203  $updater->doUpdates( $updates );
205  foreach ( $updater->getPostDatabaseUpdateMaintenance() as $maint ) {
206  $child = $this->runChild( $maint );
208  // LoggedUpdateMaintenance is checking the updatelog itself
209  $isLoggedUpdate = $child instanceof LoggedUpdateMaintenance;
211  if ( !$isLoggedUpdate && $updater->updateRowExists( $maint ) ) {
212  continue;
213  }
215  $child->execute();
216  if ( !$isLoggedUpdate ) {
217  $updater->insertUpdateRow( $maint );
218  }
219  }
221  $updater->setFileAccess();
222  if ( !$this->hasOption( 'nopurge' ) ) {
223  $updater->purgeCache();
224  }
226  $time2 = microtime( true );
228  $timeDiff = $lang->formatTimePeriod( $time2 - $time1 );
229  $this->output( "\nDone in $timeDiff.\n" );
230  }
232  function afterFinalSetup() {
235  # Don't try to access the database
236  # This needs to be disabled early since extensions will try to use the l10n
237  # cache from $wgExtensionFunctions (T22471)
239  'class' => LocalisationCache::class,
240  'storeClass' => LCStoreNull::class,
241  'storeDirectory' => false,
242  'manualRecache' => false,
243  ];
244  }
246  public function validateParamsAndArgs() {
247  // Allow extensions to add additional params.
248  $params = [];
249  Hooks::run( 'MaintenanceUpdateAddParams', [ &$params ] );
250  foreach ( $params as $name => $param ) {
251  $this->addOption(
252  $name,
253  $param['desc'],
254  $param['require'] ?? false,
255  $param['withArg'] ?? false,
256  $param['shortName'] ?? false,
257  $param['multiOccurrence'] ?? false
258  );
259  }
261  parent::validateParamsAndArgs();
262  }
263 }
266 require_once RUN_MAINTENANCE_IF_MAIN;
Status::newGood()` to allow deletion, and then `return false` from the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry out custom deletion actions. $tag:name of the tag $user:user initiating the action & $status:Status object. See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use. & $tags:list of all active tags. Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function. Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action, or null $user:User who performed the tagging when the tagging is subsequent to the action, or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change. & $allowedTags:List of all the tags the user is allowed to add. Any tags the user wants to add( $addTags) that are not in this array will cause it to fail. You may add or remove tags to this array as required. $addTags:List of tags user intends to add. $user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed. $performer:The User who will perform the change $user:The User whose groups will be changed & $add:The groups that will be added & $remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation. $collationName:Name of the collation in question & $collationObject:Null. Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user 's email has been confirmed successfully. $user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object. Called by Content::getParserOutput after parsing has finished. Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML). $content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput. May be used to override the normal model-specific rendering of page content. $content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering. To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state. $generateHtml:boolean, indicating whether full HTML should be generated. If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object. & $output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title. May be used to assign a different model for that title. $title:the Title in question & $model:the model name. Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers. Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core. $modeName:the requested content model name & $handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page. This is especially useful to prevent some content models to be used in some special location. $contentModel:ID of the content model in question $title:the Title in question. & $ok:Output parameter, whether it is OK to use $contentModel on $title. Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok. 'ContribsPager::getQueryInfo':Before the contributions query is about to run & $pager:Pager object for contributions & $queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions & $data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title & $tools:Array of tool links $specialPage:SpecialPage instance for context and services. Can be either SpecialContributions or DeletedContributionsPage. Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested. Handler functions that modify $result should generally return false to disable further attempts at conversion. $content:The Content object to be converted. $toModel:The ID of the content model to convert to. $lossy:boolean indicating whether lossy conversion is allowed. & $result:Output parameter, in case the handler function wants to provide a converted Content object. Note that $result->getContentModel() must return $toModel. 'ContentSecurityPolicyDefaultSource':Modify the allowed CSP load sources. This affects all directives except for the script directive. If you want to add a script source, see ContentSecurityPolicyScriptSource hook. & $defaultSrc:Array of Content-Security-Policy allowed sources $policyConfig:Current configuration for the Content-Security-Policy header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyDirectives':Modify the content security policy directives. Use this only if ContentSecurityPolicyDefaultSource and ContentSecurityPolicyScriptSource do not meet your needs. & $directives:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyScriptSource':Modify the allowed CSP script sources. Note that you also have to use ContentSecurityPolicyDefaultSource if you want non-script sources to be loaded from whatever you add. & $scriptSrc:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g. for a special namespace, etc. $article:Article being edited $user:User performing the edit 'DatabaseOraclePostInit':Called after initialising an Oracle database $db:the DatabaseOracle object 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery & $data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished. Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'DeleteUnknownPreferences':Called by the cleanupPreferences.php maintenance script to build a WHERE clause with which to delete preferences that are not known about. This hook is used by extensions that have dynamically-named preferences that should not be deleted in the usual cleanup process. For example, the Gadgets extension creates preferences prefixed with 'gadget-', and so anything with that prefix is excluded from the deletion. &where:An array that will be passed as the $cond parameter to IDatabase::select() to determine what will be deleted from the user_properties table. $db:The IDatabase object, useful for accessing $db->buildLike() etc. 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function. $differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable 's value is null. This hook can be used to inject content into said class member variable. $differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the "mark as patrolled" link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink". $differenceEngine:DifferenceEngine object & $markAsPatrolledLink:The "mark as patrolled" link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter. For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions. & $rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision 's author, whether the revision was marked as a minor edit or not, etc. $differenceEngine:DifferenceEngine object & $newHeader:The string containing the various #mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any) $status
Definition: hooks.txt:1266
Does the script need different DB access? By default, we give Maintenance scripts normal rights to th...
Definition: update.php:60
static newForDB(IMaintainableDatabase $db, $shared=false, Maintenance $maintenance=null)
Definition: DatabaseUpdater.php:191
if(PHP_SAPI !='cli-server') if(!isset( $_SERVER['SCRIPT_FILENAME'])) $file
Definition: router.php:42
Maintenance script to run database schema updates.
Definition: update.php:37
if(!isset( $args[0])) $lang
Definition: testCompression.php:33
fatalError( $msg, $exitCode=1)
Output a message and terminate the current script.
Definition: Maintenance.php:485
addDescription( $text)
Set the description text.
Definition: Maintenance.php:329
runChild( $maintClass, $classFile=null)
Run a child maintenance script.
Definition: Maintenance.php:708
MediaWiki version number.
Definition: DefaultSettings.php:75
Definition: maintenance.txt:50
Definition: styleTest.css.php:44
Allow schema updates.
Definition: DefaultSettings.php:2281
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
Definition: maintenance.txt:39
Definition: NoLocalSettings.php:42
wfWaitForSlaves( $ifWritesSince=null, $wiki=false, $cluster=false, $timeout=null)
Waits for the replica DBs to catch up to the master position.
Definition: GlobalFunctions.php:2790
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
Definition: injection.txt:35
Default constructor.
Definition: update.php:38
Class for scripts that perform database maintenance and want to log the update in updatelog so we can...
Definition: Maintenance.php:1700
Definition: Setup.php:875
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
Definition: Maintenance.php:248
Definition: update.php:92
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
Definition: MIT-LICENSE.txt:10
Localisation cache configuration.
Definition: DefaultSettings.php:2587
Definition: defines.php:26
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
Definition: deferred.txt:11
countDown( $seconds)
Count down from $seconds to zero on the terminal, with a one-second pause between showing each number...
Definition: Maintenance.php:1545
const DB_ADMIN
Definition: Maintenance.php:79
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
Definition: ReplaceText.php:50
Do the actual work.
Definition: Maintenance.php:1707
Get an ASCII string identifying this wiki This is used as a prefix in memcached keys.
Definition: GlobalFunctions.php:2602
Execute a callback function at the end of initialisation.
Definition: update.php:232
Definition: update.php:64
static getMain()
Get the RequestContext object associated with the main request.
Definition: RequestContext.php:430
Test for PHP+libxml2 bug which breaks XML input subtly with certain versions.
Definition: PhpBugTests.php:32
getOption( $name, $default=null)
Get an option, or return the default.
Definition: Maintenance.php:283
Do the actual work.
Definition: update.php:87
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
Definition: distributors.txt:9
getDB( $db, $groups=[], $wiki=false)
Returns a database to be used by current maintenance script.
Definition: Maintenance.php:1373
$page->newPageUpdater($user) $updater
Definition: pageupdater.txt:63
error( $err, $die=0)
Throw an error to the user.
Definition: Maintenance.php:462
output( $out, $channel=null)
Throw some output to the user.
Definition: Maintenance.php:434
The oldest version of PCRE we can support.
Definition: Installer.php:54
static factory( $code)
Get a cached or new language object for a given language code.
Definition: Language.php:215
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:52
hasOption( $name)
Checks to see if a particular option exists.
Definition: Maintenance.php:269
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:200
Advanced database interface for IDatabase handles that include maintenance methods.
Definition: IMaintainableDatabase.php:38
Run some validation checks on the params, etc.
Definition: update.php:246
static getDBInstallerClass( $type)
Get the DatabaseInstaller class name for this type.
Definition: Installer.php:559