24 require_once __DIR__ .
'/../../maintenance/Maintenance.php';
116 $this->maintenance->
setDB( $db );
119 Hooks::run(
'LoadExtensionSchemaUpdates', [ $this ] );
127 global $wgExtNewTables, $wgExtNewFields, $wgExtPGNewFields,
128 $wgExtPGAlteredFields, $wgExtNewIndexes, $wgExtModifiedFields;
130 # For extensions only, should be populated via hooks
131 # $wgDBtype should be checked to specifiy the proper file
132 $wgExtNewTables = [];
133 $wgExtNewFields = [];
134 $wgExtPGNewFields = [];
135 $wgExtPGAlteredFields = [];
136 $wgExtNewIndexes = [];
137 $wgExtModifiedFields = [];
145 if ( !defined(
'MEDIAWIKI_INSTALL' ) ) {
151 $queue = $registry->getQueue();
153 $registry->clearQueue();
156 $data = $registry->readFromQueue(
$queue );
157 $hooks = [
'wgHooks' => [
'LoadExtensionSchemaUpdates' => [] ] ];
158 if ( isset( $data[
'globals'][
'wgHooks'][
'LoadExtensionSchemaUpdates'] ) ) {
159 $hooks = $data[
'globals'][
'wgHooks'][
'LoadExtensionSchemaUpdates'];
161 if (
$vars && isset(
$vars[
'wgHooks'][
'LoadExtensionSchemaUpdates'] ) ) {
162 $hooks = array_merge_recursive( $hooks,
$vars[
'wgHooks'][
'LoadExtensionSchemaUpdates'] );
165 $wgHooks[
'LoadExtensionSchemaUpdates'] = $hooks;
166 if (
$vars && isset(
$vars[
'wgAutoloadClasses'] ) ) {
167 $wgAutoloadClasses +=
$vars[
'wgAutoloadClasses'];
182 $class = ucfirst(
$type ) .
'Updater';
186 throw new MWException( __METHOD__ .
' called for unsupported $wgDBtype' );
205 if ( $this->maintenance->isQuiet() ) {
209 if ( !$wgCommandLineMode ) {
210 $str = htmlspecialchars( $str );
230 $this->extensionUpdates[] = $update;
243 $this->extensionUpdates[] = [
'addTable', $tableName, $sqlPath,
true ];
254 $this->extensionUpdates[] = [
'addIndex', $tableName, $indexName, $sqlPath,
true ];
266 $this->extensionUpdates[] = [
'addField', $tableName, $columnName, $sqlPath,
true ];
278 $this->extensionUpdates[] = [
'dropField', $tableName, $columnName, $sqlPath,
true ];
291 $this->extensionUpdates[] = [
'dropIndex', $tableName, $indexName, $sqlPath,
true ];
302 $this->extensionUpdates[] = [
'dropTable', $tableName, $sqlPath,
true ];
318 $sqlPath, $skipBothIndexExistWarning =
false
320 $this->extensionUpdates[] = [
325 $skipBothIndexExistWarning,
339 $this->extensionUpdates[] = [
'modifyField', $tableName, $fieldName, $sqlPath,
true ];
350 return ( $this->db->tableExists( $tableName, __METHOD__ ) );
363 $this->postDatabaseUpdateMaintenance[] = $class;
392 $this->updatesSkipped = [];
395 $func = $funcList[0];
397 $origParams = $funcList[2];
398 call_user_func_array( $func, $arg );
400 $this->updatesSkipped[] = $origParams;
409 public function doUpdates( $what = [
'core',
'extensions',
'stats' ] ) {
412 $this->db->begin( __METHOD__ );
413 $what = array_flip( $what );
414 $this->skipSchema = isset( $what[
'noschema'] ) || $this->fileHandle !== null;
415 if ( isset( $what[
'core'] ) ) {
418 if ( isset( $what[
'extensions'] ) ) {
423 if ( isset( $what[
'stats'] ) ) {
429 if ( $this->fileHandle ) {
430 $this->skipSchema =
false;
435 $this->db->commit( __METHOD__ );
449 $func = array_shift( $params );
450 if ( !is_array( $func ) && method_exists( $this, $func ) ) {
451 $func = [ $this, $func ];
452 } elseif ( $passSelf ) {
453 array_unshift( $params, $this );
455 $ret = call_user_func_array( $func, $params );
457 if (
$ret !==
false ) {
458 $updatesDone[] = $origParams;
464 $this->updatesSkipped = array_merge( $this->updatesSkipped,
$updatesSkipped );
477 $key =
"updatelist-$version-" . time() . self::$updateCounter;
478 self::$updateCounter++;
479 $this->db->insert(
'updatelog',
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__ );
547 if ( $wgSharedDB === null || $this->shared ) {
551 if ( in_array(
$name, $wgSharedTables ) ) {
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( $filename,
false,
false,
false,
620 [ $this,
'appendLine' ]
636 if ( fwrite( $this->fileHandle,
$line ) ===
false ) {
652 if ( $msg === null ) {
653 $msg =
"Applying $path patch";
655 if ( $this->skipSchema ) {
656 $this->
output(
"...skipping schema change ($msg).\n" );
661 $this->
output(
"$msg ..." );
663 if ( !$isFullPath ) {
666 if ( $this->fileHandle !== null ) {
669 $this->db->sourceFile(
$path );
671 $this->
output(
"done.\n" );
689 if ( $this->db->tableExists(
$name, __METHOD__ ) ) {
690 $this->
output(
"...$name table already exists.\n" );
692 return $this->
applyPatch( $patch, $fullpath,
"Creating $name table" );
707 protected function addField( $table, $field, $patch, $fullpath =
false ) {
708 if ( !$this->
doTable( $table ) ) {
712 if ( !$this->db->tableExists( $table, __METHOD__ ) ) {
713 $this->
output(
"...$table table does not exist, skipping new field patch.\n" );
714 } elseif ( $this->db->fieldExists( $table, $field, __METHOD__ ) ) {
715 $this->
output(
"...have $field field in $table table.\n" );
717 return $this->
applyPatch( $patch, $fullpath,
"Adding $field field to table $table" );
732 protected function addIndex( $table, $index, $patch, $fullpath =
false ) {
733 if ( !$this->
doTable( $table ) ) {
737 if ( !$this->db->tableExists( $table, __METHOD__ ) ) {
738 $this->
output(
"...skipping: '$table' table doesn't exist yet.\n" );
739 } elseif ( $this->db->indexExists( $table, $index, __METHOD__ ) ) {
740 $this->
output(
"...index $index already set on $table table.\n" );
742 return $this->
applyPatch( $patch, $fullpath,
"Adding index $index to table $table" );
757 protected function dropField( $table, $field, $patch, $fullpath =
false ) {
758 if ( !$this->
doTable( $table ) ) {
762 if ( $this->db->fieldExists( $table, $field, __METHOD__ ) ) {
763 return $this->
applyPatch( $patch, $fullpath,
"Table $table contains $field field. Dropping" );
765 $this->
output(
"...$table table does not contain $field field.\n" );
780 protected function dropIndex( $table, $index, $patch, $fullpath =
false ) {
781 if ( !$this->
doTable( $table ) ) {
785 if ( $this->db->indexExists( $table, $index, __METHOD__ ) ) {
786 return $this->
applyPatch( $patch, $fullpath,
"Dropping $index index from table $table" );
788 $this->
output(
"...$index key doesn't exist.\n" );
807 $skipBothIndexExistWarning, $patch, $fullpath =
false
809 if ( !$this->
doTable( $table ) ) {
814 if ( !$this->db->tableExists( $table, __METHOD__ ) ) {
815 $this->
output(
"...skipping: '$table' table doesn't exist yet.\n" );
821 if ( $this->db->indexExists( $table, $newIndex, __METHOD__ ) ) {
822 $this->
output(
"...index $newIndex already set on $table table.\n" );
823 if ( !$skipBothIndexExistWarning &&
824 $this->db->indexExists( $table, $oldIndex, __METHOD__ )
826 $this->
output(
"...WARNING: $oldIndex still exists, despite it has " .
827 "been renamed into $newIndex (which also exists).\n" .
828 " $oldIndex should be manually removed if not needed anymore.\n" );
835 if ( !$this->db->indexExists( $table, $oldIndex, __METHOD__ ) ) {
836 $this->
output(
"...skipping: index $oldIndex doesn't exist.\n" );
845 "Renaming index $oldIndex into $newIndex to table $table"
860 public function dropTable( $table, $patch =
false, $fullpath =
false ) {
861 if ( !$this->
doTable( $table ) ) {
865 if ( $this->db->tableExists( $table, __METHOD__ ) ) {
866 $msg =
"Dropping table $table";
868 if ( $patch ===
false ) {
869 $this->
output(
"$msg ..." );
870 $this->db->dropTable( $table, __METHOD__ );
871 $this->
output(
"done.\n" );
873 return $this->
applyPatch( $patch, $fullpath, $msg );
876 $this->
output(
"...$table doesn't exist.\n" );
891 public function modifyField( $table, $field, $patch, $fullpath =
false ) {
892 if ( !$this->
doTable( $table ) ) {
896 $updateKey =
"$table-$field-$patch";
897 if ( !$this->db->tableExists( $table, __METHOD__ ) ) {
898 $this->
output(
"...$table table does not exist, skipping modify field patch.\n" );
899 } elseif ( !$this->db->fieldExists( $table, $field, __METHOD__ ) ) {
900 $this->
output(
"...$field field does not exist in $table table, " .
901 "skipping modify field patch.\n" );
903 $this->
output(
"...$field in table $table already modified by patch $patch.\n" );
907 return $this->
applyPatch( $patch, $fullpath,
"Modifying $field field of table $table" );
920 $zonePath = $repo->getZonePath(
'temp' );
921 if ( $repo->getBackend()->directoryExists( [
'dir' => $zonePath ] ) ) {
923 $status = $repo->getBackend()->secure( [
929 $this->
output(
"Set the local repo temp zone container to be private.\n" );
931 $this->
output(
"Failed to set the local repo temp zone container to be private.\n" );
941 # We can't guarantee that the user will be able to use TRUNCATE,
942 # but we know that DELETE is available to us
943 $this->
output(
"Purging caches..." );
944 $this->db->delete(
'objectcache',
'*', __METHOD__ );
945 if ( $wgLocalisationCacheConf[
'manualRecache'] ) {
950 $this->db->delete(
'module_deps',
'*', __METHOD__ );
951 $this->
output(
"done.\n" );
958 $this->
output(
"...site_stats is populated..." );
959 $row = $this->db->selectRow(
'site_stats',
'*', [
'ss_row_id' => 1 ], __METHOD__ );
960 if ( $row ===
false ) {
961 $this->
output(
"data is missing! rebuilding...\n" );
962 } elseif ( isset( $row->site_stats ) && $row->ss_total_pages == -1 ) {
963 $this->
output(
"missing ss_total_pages, rebuilding...\n" );
965 $this->
output(
"done.\n" );
972 # Common updater functions
978 $activeUsers = $this->db->selectField(
'site_stats',
'ss_active_users',
false, __METHOD__ );
979 if ( $activeUsers == -1 ) {
980 $activeUsers = $this->db->selectField(
'recentchanges',
981 'COUNT( DISTINCT rc_user_text )',
982 [
'rc_user != 0',
'rc_bot' => 0,
"rc_log_type != 'newusers'" ], __METHOD__
984 $this->db->update(
'site_stats',
985 [
'ss_active_users' => intval( $activeUsers ) ],
986 [
'ss_row_id' => 1 ], __METHOD__, [
'LIMIT' => 1 ]
989 $this->
output(
"...ss_active_users user count set...\n" );
998 "Populating log_user_text field, printing progress markers. For large\n" .
999 "databases, you may want to hit Ctrl-C and do this manually with\n" .
1000 "maintenance/populateLogUsertext.php.\n"
1003 $task = $this->maintenance->runChild(
'PopulateLogUsertext' );
1005 $this->
output(
"done.\n" );
1015 "Populating log_search table, printing progress markers. For large\n" .
1016 "databases, you may want to hit Ctrl-C and do this manually with\n" .
1017 "maintenance/populateLogSearch.php.\n" );
1019 $task = $this->maintenance->runChild(
'PopulateLogSearch' );
1021 $this->
output(
"done.\n" );
1031 $this->
output(
"...transcache tc_time already converted.\n" );
1036 return $this->
applyPatch(
'patch-tc-timestamp.sql',
false,
1037 "Converting tc_time from UNIX epoch to MediaWiki timestamp" );
1044 global $wgCategoryCollation;
1045 if ( $this->db->fieldExists(
'categorylinks',
'cl_collation', __METHOD__ ) ) {
1046 if ( $this->db->selectField(
1049 'cl_collation != ' . $this->db->addQuotes( $wgCategoryCollation ),
1053 $this->
output(
"...collations up-to-date.\n" );
1058 $this->
output(
"Updating category collations..." );
1059 $task = $this->maintenance->runChild(
'UpdateCollation' );
1061 $this->
output(
"...done.\n" );
1069 if ( $this->db->tableExists(
'user_properties' ) ) {
1070 $cl = $this->maintenance->runChild(
'ConvertUserOptions',
'convertUserOptions.php' );
1072 $this->
output(
"done.\n" );
1082 if ( !$this->
doTable(
'profiling' ) ) {
1086 $profileToDb =
false;
1087 if ( isset( $wgProfiler[
'output'] ) ) {
1088 $out = $wgProfiler[
'output'];
1089 if (
$out ===
'db' ) {
1090 $profileToDb =
true;
1091 } elseif ( is_array(
$out ) && in_array(
'db',
$out ) ) {
1092 $profileToDb =
true;
1096 if ( $profileToDb && !$this->db->tableExists(
'profiling', __METHOD__ ) ) {
1097 $this->
applyPatch(
'patch-profiling.sql',
false,
'Add profiling table' );
1108 $cl = $this->maintenance->runChild(
'RebuildLocalisationCache',
'rebuildLocalisationCache.php' );
1109 $this->
output(
"Rebuilding localisation cache...\n" );
1112 $this->
output(
"done.\n" );
1120 global $wgContentHandlerUseDB;
1122 if ( $wgContentHandlerUseDB ) {
1123 $this->
output(
"Turning off Content Handler DB fields for this part of upgrade.\n" );
1124 $this->holdContentHandlerUseDB = $wgContentHandlerUseDB;
1125 $wgContentHandlerUseDB =
false;
1133 global $wgContentHandlerUseDB;
1135 if ( $this->holdContentHandlerUseDB ) {
1136 $this->
output(
"Content Handler DB fields should be usable now.\n" );
This class generates message blobs for use by ResourceLoader modules.
doUpdates($what=[ 'core', 'extensions', 'stats'])
Do all the updates.
array $extensionUpdates
List of extension-provided database updates.
copyFile($filename)
Append an SQL fragment to the open file handle.
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
the array() calling protocol came about after MediaWiki 1.4rc1.
magic word the default is to use $key to get the and $key value or $key value text $key value html to format the value $key
$wgVersion
MediaWiki version number.
getExtensionUpdates()
Get the list of extension-defined updates.
canUseNewUpdatelog()
Updatelog was changed in 1.17 to have a ul_value column so we can record more information about what ...
dropExtensionField($tableName, $columnName, $sqlPath)
loadExtensions()
Loads LocalSettings.php, if needed, and initialises everything needed for LoadExtensionSchemaUpdates ...
applyPatch($path, $isFullPath=false, $msg=null)
Applies a SQL patch.
dropTable($table, $patch=false, $fullpath=false)
If the specified table exists, drop it, or execute the patch if one is provided.
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
addExtensionTable($tableName, $sqlPath)
Convenience wrapper for addExtensionUpdate() when adding a new table (which is the most common usage ...
Class for handling database updates.
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
resource $fileHandle
File handle for SQL output.
rebuildLocalisationCache()
Rebuilds the localisation cache.
$wgHooks['ArticleShow'][]
string[] $postDatabaseUpdateMaintenance
Scripts to run after database update Should be a subclass of LoggedUpdateMaintenance.
output($str)
Output some text.
checkStats()
Check the site_stats table is not properly populated.
when a variable name is used in a it is silently declared as a new local masking the global
doUpdateTranscacheField()
Updates the timestamps in the transcache table.
dropIndex($table, $index, $patch, $fullpath=false)
Drop an index from an existing table.
getType()
Get the type of the DBMS, as it appears in $wgDBtype.
addPostDatabaseUpdateMaintenance($class)
Add a maintenance script to be run after the database updates are complete.
static doAllAndCommit($database, array $options=[])
Do all updates and commit them.
__construct(DatabaseBase &$db, $shared, Maintenance $maintenance=null)
Constructor.
bool $skipSchema
Flag specifying whether or not to skip schema (e.g.
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
Fake maintenance wrapper, mostly used for the web installer/updater.
getDB()
Get a database connection to run updates.
global $wgCommandLineMode
dropExtensionIndex($tableName, $indexName, $sqlPath)
Drop an index from an extension table.
DatabaseBase $db
Handle to the database subclass.
$wgLocalisationCacheConf
Localisation cache configuration.
disableContentHandlerUseDB()
Turns off content handler fields during parts of the upgrade where they aren't available.
initOldGlobals()
Initialize all of the old globals.
array $updates
Array of updates to perform on the database.
dropField($table, $field, $patch, $fullpath=false)
Drop a field from an existing table.
array $updatesSkipped
Array of updates that were skipped.
static singleton()
Get a RepoGroup instance.
addExtensionIndex($tableName, $indexName, $sqlPath)
static getExistingLocalSettings()
Determine if LocalSettings.php exists.
setDB(IDatabase $db)
Sets database object to be returned by getDB().
addIndex($table, $index, $patch, $fullpath=false)
Add a new index to an existing table.
purgeCache()
Purge the objectcache table.
$wgSharedDB
Shared database for multiple wikis.
getPostDatabaseUpdateMaintenance()
addField($table, $field, $patch, $fullpath=false)
Add a new field to an existing table.
setAppliedUpdates($version, $updates=[])
global $wgAutoloadClasses
static run($event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
addTable($name, $patch, $fullpath=false)
Add a new table to the database.
insertUpdateRow($key, $val=null)
Helper function: Add a key to the updatelog table Obviously, only use this for updates that occur aft...
doEnableProfiling()
Enable profiling table when it's turned on.
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
appendLine($line)
Append a line to the open filehandle.
getCoreUpdateList()
Get an array of updates to perform on the database.
dropExtensionTable($tableName, $sqlPath)
doActiveUsersInit()
Sets the number of active users in the site_stats table.
setFlag($flag)
Set a flag for this connection.
Database abstraction object.
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
wfGetLBFactory()
Get the load balancer factory object.
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
doMigrateUserOptions()
Migrates user options from the user table blob to user_properties.
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)
addExtensionField($tableName, $columnName, $sqlPath)
renameExtensionIndex($tableName, $oldIndexName, $newIndexName, $sqlPath, $skipBothIndexExistWarning=false)
Rename an index on an extension table.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist 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
modifyField($table, $field, $patch, $fullpath=false)
Modify an existing field.
doLogSearchPopulation()
Migrate log params to new table and index for searching.
runUpdates(array $updates, $passSelf)
Helper function for doUpdates()
updateRowExists($key)
Helper function: check if the given key is present in the updatelog table.
static newForDB(&$db, $shared=false, $maintenance=null)
static getDBTypes()
Get a list of known DB types.
$holdContentHandlerUseDB
Hold the value of $wgContentHandlerUseDB during the upgrade.
enableContentHandlerUseDB()
Turns content handler fields back on.
writeSchemaUpdateFile($schemaUpdate=[])
addExtensionUpdate(array $update)
Add a new update coming from an extension.
renameIndex($table, $oldIndex, $newIndex, $skipBothIndexExistWarning, $patch, $fullpath=false)
Rename an index from an existing table.
setFileAccess()
Set any .htaccess files or equivilent for storage repos.
static configuration should be added through ResourceLoaderGetConfigVars instead & $vars
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 one of or reset 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
modifyExtensionField($tableName, $fieldName, $sqlPath)
doCollationUpdate()
Update CategoryLinks collation.
getOldGlobalUpdates()
Before 1.17, we used to handle updates via stuff like $wgExtNewTables/Fields/Indexes.
doLogUsertextPopulation()
Populates the log_user_text field in the logging table.
doTable($name)
Returns whether updates should be executed on the database table $name.
Allows to change the fields on the form that will be generated $name