27require_once __DIR__ .
'/../../maintenance/Maintenance.php';
76 DeleteDefaultMessages::class,
77 PopulateRevisionLength::class,
78 PopulateRevisionSha1::class,
79 PopulateImageSha1::class,
80 FixExtLinksProtocolRelative::class,
81 PopulateFilearchiveSha1::class,
82 PopulateBacklinkNamespace::class,
83 FixDefaultJsonContentPages::class,
84 CleanupEmptyCategories::class,
85 AddRFCAndPMIDInterwiki::class,
127 Hooks::run(
'LoadExtensionSchemaUpdates', [ $this ] );
135 global $wgExtNewTables, $wgExtNewFields, $wgExtPGNewFields,
136 $wgExtPGAlteredFields, $wgExtNewIndexes, $wgExtModifiedFields;
138 # For extensions only, should be populated via hooks
139 # $wgDBtype should be checked to specifiy the proper file
140 $wgExtNewTables = [];
141 $wgExtNewFields = [];
142 $wgExtPGNewFields = [];
143 $wgExtPGAlteredFields = [];
144 $wgExtNewIndexes = [];
145 $wgExtModifiedFields = [];
153 if ( !defined(
'MEDIAWIKI_INSTALL' ) ) {
159 $queue = $registry->getQueue();
161 $registry->clearQueue();
164 $data = $registry->readFromQueue(
$queue );
165 $hooks = [
'wgHooks' => [
'LoadExtensionSchemaUpdates' => [] ] ];
166 if ( isset( $data[
'globals'][
'wgHooks'][
'LoadExtensionSchemaUpdates'] ) ) {
167 $hooks = $data[
'globals'][
'wgHooks'][
'LoadExtensionSchemaUpdates'];
169 if (
$vars && isset(
$vars[
'wgHooks'][
'LoadExtensionSchemaUpdates'] ) ) {
170 $hooks = array_merge_recursive( $hooks,
$vars[
'wgHooks'][
'LoadExtensionSchemaUpdates'] );
173 $wgHooks[
'LoadExtensionSchemaUpdates'] = $hooks;
174 if (
$vars && isset(
$vars[
'wgAutoloadClasses'] ) ) {
190 $class = ucfirst(
$type ) .
'Updater';
194 throw new MWException( __METHOD__ .
' called for unsupported $wgDBtype' );
213 if ( $this->maintenance->isQuiet() ) {
218 $str = htmlspecialchars( $str );
237 $this->extensionUpdates[] = $update;
250 $this->extensionUpdates[] = [
'addTable', $tableName, $sqlPath,
true ];
261 $this->extensionUpdates[] = [
'addIndex', $tableName, $indexName, $sqlPath,
true ];
273 $this->extensionUpdates[] = [
'addField', $tableName, $columnName, $sqlPath,
true ];
285 $this->extensionUpdates[] = [
'dropField', $tableName, $columnName, $sqlPath,
true ];
298 $this->extensionUpdates[] = [
'dropIndex', $tableName, $indexName, $sqlPath,
true ];
309 $this->extensionUpdates[] = [
'dropTable', $tableName, $sqlPath,
true ];
325 $sqlPath, $skipBothIndexExistWarning =
false
327 $this->extensionUpdates[] = [
332 $skipBothIndexExistWarning,
346 $this->extensionUpdates[] = [
'modifyField', $tableName, $fieldName, $sqlPath,
true ];
357 return ( $this->db->tableExists( $tableName, __METHOD__ ) );
370 $this->postDatabaseUpdateMaintenance[] = $class;
399 $this->updatesSkipped = [];
402 $func = $funcList[0];
404 $origParams = $funcList[2];
405 call_user_func_array( $func, $arg );
407 $this->updatesSkipped[] = $origParams;
433 $what = array_flip( $what );
434 $this->skipSchema = isset( $what[
'noschema'] ) || $this->fileHandle !==
null;
435 if ( isset( $what[
'core'] ) ) {
438 if ( isset( $what[
'extensions'] ) ) {
443 if ( isset( $what[
'stats'] ) ) {
447 if ( $this->fileHandle ) {
448 $this->skipSchema =
false;
460 $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
466 $func = array_shift(
$params );
467 if ( !is_array( $func ) && method_exists( $this, $func ) ) {
468 $func = [ $this, $func ];
469 } elseif ( $passSelf ) {
470 array_unshift(
$params, $this );
474 if (
$ret !==
false ) {
475 $updatesDone[] = $origParams;
481 $this->updatesSkipped = array_merge( $this->updatesSkipped,
$updatesSkipped );
493 $row = $this->db->selectRow(
497 [
'ul_key' => $key ],
513 $values = [
'ul_key' => $key ];
515 $values[
'ul_value'] = $val;
517 $this->db->insert(
'updatelog', $values, __METHOD__,
'IGNORE' );
530 return $this->db->tableExists(
'updatelog', __METHOD__ ) &&
531 $this->db->fieldExists(
'updatelog',
'ul_value', __METHOD__ );
552 $this->
output(
"...skipping update to shared table $name.\n" );
568 global $wgExtNewFields, $wgExtNewTables, $wgExtModifiedFields,
573 foreach ( $wgExtNewTables
as $tableRecord ) {
575 'addTable', $tableRecord[0], $tableRecord[1],
true
579 foreach ( $wgExtNewFields
as $fieldRecord ) {
581 'addField', $fieldRecord[0], $fieldRecord[1],
582 $fieldRecord[2],
true
586 foreach ( $wgExtNewIndexes
as $fieldRecord ) {
588 'addIndex', $fieldRecord[0], $fieldRecord[1],
589 $fieldRecord[2],
true
593 foreach ( $wgExtModifiedFields
as $fieldRecord ) {
595 'modifyField', $fieldRecord[0], $fieldRecord[1],
596 $fieldRecord[2],
true
619 $this->db->sourceFile(
624 [ $this,
'appendLine' ]
640 if ( fwrite( $this->fileHandle,
$line ) ===
false ) {
655 protected function applyPatch( $path, $isFullPath =
false, $msg =
null ) {
656 if ( $msg ===
null ) {
657 $msg =
"Applying $path patch";
659 if ( $this->skipSchema ) {
660 $this->
output(
"...skipping schema change ($msg).\n" );
665 $this->
output(
"$msg ..." );
667 if ( !$isFullPath ) {
670 if ( $this->fileHandle !==
null ) {
673 $this->db->sourceFile(
$path );
675 $this->
output(
"done.\n" );
693 if ( file_exists(
"$IP/maintenance/$dbType/archives/$patch" ) ) {
694 return "$IP/maintenance/$dbType/archives/$patch";
696 return "$IP/maintenance/archives/$patch";
708 protected function addTable( $name, $patch, $fullpath =
false ) {
713 if ( $this->db->tableExists(
$name, __METHOD__ ) ) {
714 $this->
output(
"...$name table already exists.\n" );
716 return $this->
applyPatch( $patch, $fullpath,
"Creating $name table" );
731 protected function addField( $table, $field, $patch, $fullpath =
false ) {
732 if ( !$this->
doTable( $table ) ) {
736 if ( !$this->db->tableExists( $table, __METHOD__ ) ) {
737 $this->
output(
"...$table table does not exist, skipping new field patch.\n" );
738 } elseif ( $this->db->fieldExists( $table, $field, __METHOD__ ) ) {
739 $this->
output(
"...have $field field in $table table.\n" );
741 return $this->
applyPatch( $patch, $fullpath,
"Adding $field field to table $table" );
756 protected function addIndex( $table, $index, $patch, $fullpath =
false ) {
757 if ( !$this->
doTable( $table ) ) {
761 if ( !$this->db->tableExists( $table, __METHOD__ ) ) {
762 $this->
output(
"...skipping: '$table' table doesn't exist yet.\n" );
763 } elseif ( $this->db->indexExists( $table, $index, __METHOD__ ) ) {
764 $this->
output(
"...index $index already set on $table table.\n" );
766 return $this->
applyPatch( $patch, $fullpath,
"Adding index $index to table $table" );
781 protected function dropField( $table, $field, $patch, $fullpath =
false ) {
782 if ( !$this->
doTable( $table ) ) {
786 if ( $this->db->fieldExists( $table, $field, __METHOD__ ) ) {
787 return $this->
applyPatch( $patch, $fullpath,
"Table $table contains $field field. Dropping" );
789 $this->
output(
"...$table table does not contain $field field.\n" );
804 protected function dropIndex( $table, $index, $patch, $fullpath =
false ) {
805 if ( !$this->
doTable( $table ) ) {
809 if ( $this->db->indexExists( $table, $index, __METHOD__ ) ) {
810 return $this->
applyPatch( $patch, $fullpath,
"Dropping $index index from table $table" );
812 $this->
output(
"...$index key doesn't exist.\n" );
831 $skipBothIndexExistWarning, $patch, $fullpath =
false
833 if ( !$this->
doTable( $table ) ) {
838 if ( !$this->db->tableExists( $table, __METHOD__ ) ) {
839 $this->
output(
"...skipping: '$table' table doesn't exist yet.\n" );
845 if ( $this->db->indexExists( $table, $newIndex, __METHOD__ ) ) {
846 $this->
output(
"...index $newIndex already set on $table table.\n" );
847 if ( !$skipBothIndexExistWarning &&
848 $this->db->indexExists( $table, $oldIndex, __METHOD__ )
850 $this->
output(
"...WARNING: $oldIndex still exists, despite it has " .
851 "been renamed into $newIndex (which also exists).\n" .
852 " $oldIndex should be manually removed if not needed anymore.\n" );
859 if ( !$this->db->indexExists( $table, $oldIndex, __METHOD__ ) ) {
860 $this->
output(
"...skipping: index $oldIndex doesn't exist.\n" );
869 "Renaming index $oldIndex into $newIndex to table $table"
884 public function dropTable( $table, $patch =
false, $fullpath =
false ) {
885 if ( !$this->
doTable( $table ) ) {
889 if ( $this->db->tableExists( $table, __METHOD__ ) ) {
890 $msg =
"Dropping table $table";
892 if ( $patch ===
false ) {
893 $this->
output(
"$msg ..." );
894 $this->db->dropTable( $table, __METHOD__ );
895 $this->
output(
"done.\n" );
897 return $this->
applyPatch( $patch, $fullpath, $msg );
900 $this->
output(
"...$table doesn't exist.\n" );
915 public function modifyField( $table, $field, $patch, $fullpath =
false ) {
916 if ( !$this->
doTable( $table ) ) {
920 $updateKey =
"$table-$field-$patch";
921 if ( !$this->db->tableExists( $table, __METHOD__ ) ) {
922 $this->
output(
"...$table table does not exist, skipping modify field patch.\n" );
923 } elseif ( !$this->db->fieldExists( $table, $field, __METHOD__ ) ) {
924 $this->
output(
"...$field field does not exist in $table table, " .
925 "skipping modify field patch.\n" );
927 $this->
output(
"...$field in table $table already modified by patch $patch.\n" );
931 return $this->
applyPatch( $patch, $fullpath,
"Modifying $field field of table $table" );
944 $zonePath = $repo->getZonePath(
'temp' );
945 if ( $repo->getBackend()->directoryExists( [
'dir' => $zonePath ] ) ) {
947 $status = $repo->getBackend()->secure( [
953 $this->
output(
"Set the local repo temp zone container to be private.\n" );
955 $this->
output(
"Failed to set the local repo temp zone container to be private.\n" );
965 # We can't guarantee that the user will be able to use TRUNCATE,
966 # but we know that DELETE is available to us
967 $this->
output(
"Purging caches..." );
968 $this->db->delete(
'objectcache',
'*', __METHOD__ );
974 $this->db->delete(
'module_deps',
'*', __METHOD__ );
975 $this->
output(
"done.\n" );
982 $this->
output(
"...site_stats is populated..." );
983 $row = $this->db->selectRow(
'site_stats',
'*', [
'ss_row_id' => 1 ], __METHOD__ );
984 if ( $row ===
false ) {
985 $this->
output(
"data is missing! rebuilding...\n" );
986 } elseif ( isset( $row->site_stats ) && $row->ss_total_pages == -1 ) {
987 $this->
output(
"missing ss_total_pages, rebuilding...\n" );
989 $this->
output(
"done.\n" );
996 # Common updater functions
1002 $activeUsers = $this->db->selectField(
'site_stats',
'ss_active_users',
false, __METHOD__ );
1003 if ( $activeUsers == -1 ) {
1004 $activeUsers = $this->db->selectField(
'recentchanges',
1005 'COUNT( DISTINCT rc_user_text )',
1006 [
'rc_user != 0',
'rc_bot' => 0,
"rc_log_type != 'newusers'" ], __METHOD__
1008 $this->db->update(
'site_stats',
1009 [
'ss_active_users' => intval( $activeUsers ) ],
1010 [
'ss_row_id' => 1 ], __METHOD__, [
'LIMIT' => 1 ]
1013 $this->
output(
"...ss_active_users user count set...\n" );
1022 "Populating log_user_text field, printing progress markers. For large\n" .
1023 "databases, you may want to hit Ctrl-C and do this manually with\n" .
1024 "maintenance/populateLogUsertext.php.\n"
1027 $task = $this->maintenance->runChild(
'PopulateLogUsertext' );
1029 $this->
output(
"done.\n" );
1039 "Populating log_search table, printing progress markers. For large\n" .
1040 "databases, you may want to hit Ctrl-C and do this manually with\n" .
1041 "maintenance/populateLogSearch.php.\n" );
1043 $task = $this->maintenance->runChild(
'PopulateLogSearch' );
1045 $this->
output(
"done.\n" );
1055 $this->
output(
"...transcache tc_time already converted.\n" );
1060 return $this->
applyPatch(
'patch-tc-timestamp.sql',
false,
1061 "Converting tc_time from UNIX epoch to MediaWiki timestamp" );
1069 if ( $this->db->fieldExists(
'categorylinks',
'cl_collation', __METHOD__ ) ) {
1070 if ( $this->db->selectField(
1077 $this->
output(
"...collations up-to-date.\n" );
1082 $this->
output(
"Updating category collations..." );
1083 $task = $this->maintenance->runChild(
'UpdateCollation' );
1085 $this->
output(
"...done.\n" );
1093 if ( $this->db->tableExists(
'user_properties' ) ) {
1094 $cl = $this->maintenance->runChild(
'ConvertUserOptions',
'convertUserOptions.php' );
1096 $this->
output(
"done.\n" );
1106 if ( !$this->
doTable(
'profiling' ) ) {
1110 $profileToDb =
false;
1113 if (
$out ===
'db' ) {
1114 $profileToDb =
true;
1115 } elseif ( is_array(
$out ) && in_array(
'db',
$out ) ) {
1116 $profileToDb =
true;
1120 if ( $profileToDb && !$this->db->tableExists(
'profiling', __METHOD__ ) ) {
1121 $this->
applyPatch(
'patch-profiling.sql',
false,
'Add profiling table' );
1132 $cl = $this->maintenance->runChild(
'RebuildLocalisationCache',
'rebuildLocalisationCache.php' );
1133 $this->
output(
"Rebuilding localisation cache...\n" );
1136 $this->
output(
"done.\n" );
1147 $this->
output(
"Turning off Content Handler DB fields for this part of upgrade.\n" );
1159 if ( $this->holdContentHandlerUseDB ) {
1160 $this->
output(
"Content Handler DB fields should be usable now.\n" );
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
$wgAutoloadClasses
Array mapping class names to filenames, for autoloading.
$wgCategoryCollation
Specify how category names should be sorted, when listed on a category page.
$wgSharedDB
Shared database for multiple wikis.
$wgContentHandlerUseDB
Set to false to disable use of the database fields introduced by the ContentHandler facility.
$wgLocalisationCacheConf
Localisation cache configuration.
global $wgCommandLineMode
Class for handling database updates.
purgeCache()
Purge the objectcache table.
addExtensionTable( $tableName, $sqlPath)
Convenience wrapper for addExtensionUpdate() when adding a new table (which is the most common usage ...
getDB()
Get a database connection to run updates.
setFileAccess()
Set any .htaccess files or equivilent for storage repos.
loadExtensions()
Loads LocalSettings.php, if needed, and initialises everything needed for LoadExtensionSchemaUpdates ...
addIndex( $table, $index, $patch, $fullpath=false)
Add a new index to an existing table.
array $updates
Array of updates to perform on the database.
$holdContentHandlerUseDB
Hold the value of $wgContentHandlerUseDB during the upgrade.
disableContentHandlerUseDB()
Turns off content handler fields during parts of the upgrade where they aren't available.
bool $skipSchema
Flag specifying whether or not to skip schema (e.g.
addField( $table, $field, $patch, $fullpath=false)
Add a new field to an existing table.
addExtensionIndex( $tableName, $indexName, $sqlPath)
doUpdates(array $what=[ 'core', 'extensions', 'stats'])
Do all the updates.
updateRowExists( $key)
Helper function: check if the given key is present in the updatelog table.
runUpdates(array $updates, $passSelf)
Helper function for doUpdates()
getCoreUpdateList()
Get an array of updates to perform on the database.
enableContentHandlerUseDB()
Turns content handler fields back on.
output( $str)
Output some text.
doLogSearchPopulation()
Migrate log params to new table and index for searching.
getPostDatabaseUpdateMaintenance()
doLogUsertextPopulation()
Populates the log_user_text field in the logging table.
getExtensionUpdates()
Get the list of extension-defined updates.
insertUpdateRow( $key, $val=null)
Helper function: Add a key to the updatelog table Obviously, only use this for updates that occur aft...
canUseNewUpdatelog()
Updatelog was changed in 1.17 to have a ul_value column so we can record more information about what ...
patchPath(IDatabase $db, $patch)
Get the full path of a patch file.
copyFile( $filename)
Append an SQL fragment to the open file handle.
string[] $postDatabaseUpdateMaintenance
Scripts to run after database update Should be a subclass of LoggedUpdateMaintenance.
renameIndex( $table, $oldIndex, $newIndex, $skipBothIndexExistWarning, $patch, $fullpath=false)
Rename an index from an existing table.
writeSchemaUpdateFile(array $schemaUpdate=[])
rebuildLocalisationCache()
Rebuilds the localisation cache.
addExtensionField( $tableName, $columnName, $sqlPath)
__construct(Database &$db, $shared, Maintenance $maintenance=null)
Constructor.
dropExtensionTable( $tableName, $sqlPath)
addTable( $name, $patch, $fullpath=false)
Add a new table to the database.
modifyField( $table, $field, $patch, $fullpath=false)
Modify an existing field.
doActiveUsersInit()
Sets the number of active users in the site_stats table.
dropExtensionField( $tableName, $columnName, $sqlPath)
static newForDB(Database $db, $shared=false, $maintenance=null)
getOldGlobalUpdates()
Before 1.17, we used to handle updates via stuff like $wgExtNewTables/Fields/Indexes.
addPostDatabaseUpdateMaintenance( $class)
Add a maintenance script to be run after the database updates are complete.
dropField( $table, $field, $patch, $fullpath=false)
Drop a field from an existing table.
doCollationUpdate()
Update CategoryLinks collation.
renameExtensionIndex( $tableName, $oldIndexName, $newIndexName, $sqlPath, $skipBothIndexExistWarning=false)
Rename an index on an extension table.
addExtensionUpdate(array $update)
Add a new update coming from an extension.
array $updatesSkipped
Array of updates that were skipped.
Database $db
Handle to the database subclass.
resource $fileHandle
File handle for SQL output.
appendLine( $line)
Append a line to the open filehandle.
dropExtensionIndex( $tableName, $indexName, $sqlPath)
Drop an index from an extension table.
initOldGlobals()
Initialize all of the old globals.
doEnableProfiling()
Enable profiling table when it's turned on.
array $extensionUpdates
List of extension-provided database updates.
checkStats()
Check the site_stats table is not properly populated.
modifyExtensionField( $tableName, $fieldName, $sqlPath)
applyPatch( $path, $isFullPath=false, $msg=null)
Applies a SQL patch.
dropIndex( $table, $index, $patch, $fullpath=false)
Drop an index from an existing table.
doUpdateTranscacheField()
Updates the timestamps in the transcache table.
dropTable( $table, $patch=false, $fullpath=false)
If the specified table exists, drop it, or execute the patch if one is provided.
getSchemaVars()
Get appropriate schema variables in the current database connection.
doTable( $name)
Returns whether updates should be executed on the database table $name.
doMigrateUserOptions()
Migrates user options from the user table blob to user_properties.
Fake maintenance wrapper, mostly used for the web installer/updater.
static getExistingLocalSettings()
Determine if LocalSettings.php exists.
static getDBTypes()
Get a list of known DB types.
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
setDB(IDatabase $db)
Sets database object to be returned by getDB().
This class generates message blobs for use by ResourceLoader modules.
static singleton()
Get a RepoGroup instance.
static doAllAndCommit( $database, array $options=[])
Do all updates and commit them.
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 updates(as a Java servelet could)
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add in any and then calling output() to send it all. It could be easily changed to send incrementally if that becomes useful
when a variable name is used in a it is silently declared as a new local masking the global
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
the array() calling protocol came about after MediaWiki 1.4rc1.
static configuration should be added through ResourceLoaderGetConfigVars instead & $vars
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return true
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled allows for interception of redirect as a string mapping parameter names to values & $type
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses & $ret
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output $out
$wgHooks['ArticleShow'][]
Allows to change the fields on the form that will be generated $name
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set $status
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