Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effort. More...

Inheritance diagram for Maintenance:

[legend]

Collaboration diagram for Maintenance:

[legend]

Public Member Functions
	__construct ()
	Default constructor. More...

	checkRequiredExtensions ()
	Verify that the required extensions are installed. More...

	cleanupChanneled ()
	Clean up channeled output. More...

	clearParamsAndArgs ()
	Clear all params and arguments. More...

	execute ()
	Do the actual work. More...

	finalSetup (SettingsBuilder $settingsBuilder=null)
	Handle some last-minute setup here. More...

	getConfig ()

	getDbType ()
	Does the script need different DB access? By default, we give Maintenance scripts normal rights to the DB. More...

	getName ()
	Get the script's name. More...

	globals ()
	Potentially debug globals. More...

	isQuiet ()

	loadParamsAndArgs ( $self=null, $opts=null, $args=null)
	Process command line arguments $mOptions becomes an array with keys set to the option names $mArgs becomes a zero-based array containing the non-option arguments. More...

	loadSettings ()
	Generic setup for most installs. More...

	loadWithArgv ( $argv)
	Load params and arguments from a given array of command-line arguments. More...

	memoryLimit ()
	Normally we disable the memory_limit when running admin scripts. More...

	outputChanneled ( $msg, $channel=null)
	Message outputter with channeled message support. More...

	purgeRedundantText ( $delete=true)
	Support function for cleaning up redundant text records. More...

	runChild ( $maintClass, $classFile=null)
	Run a child maintenance script. More...

	setAgentAndTriggers ()
	This method used to be for internal use by doMaintenance.php to apply some optional global state to LBFactory for debugging purposes. More...

	setConfig (Config $config)

	setDB (IMaintainableDatabase $db)
	Sets database object to be returned by getDB(). More...

	setup ()
	Do some checking and basic setup. More...

	shutdown ()
	Call before exiting CLI process for the last DB commit, and flush any remaining buffers and other deferred work. More...

	validateParamsAndArgs ()
	Run some validation checks on the params, etc. More...

Static Public Member Functions
static	getTermSize ()
	Get the terminal size as a two-element array where the first element is the width (number of columns) and the second element is the height (number of rows). More...

static	posix_isatty ( $fd)
	Wrapper for posix_isatty() We default as considering stdin a tty (for nice readline methods) but treating stout as not a tty to avoid color codes. More...

static	readconsole ( $prompt='> ')
	Prompt the console for input. More...

static	requireTestsAutoloader ()
	Call this to set up the autoloader to allow classes to be used from the tests directory. More...

static	shouldExecute ()
	Should we execute the maintenance script, or just allow it to be included as a standalone class? It checks that the call stack only includes this function and "requires" (meaning was called from the file scope) More...

Public Attributes
resource null	$fileHandle
	Used when creating separate schema files. More...

	$mDbPass

array	$orderedOptions = []
	Used to read the options in the order they were passed. More...

const	DB_ADMIN = 2

const	DB_NONE = 0
	Constants for DB access type. More...

const	DB_STD = 1

const	STDIN_ALL = -1

Protected Member Functions
	activateProfiler ()
	Activate the profiler (assuming $wgProfiler is set) More...

	addArg ( $arg, $description, $required=true)
	Add some args that are needed. More...

	addDefaultParams ()
	Add the default parameters to the scripts. More...

	addDescription ( $text)
	Set the description text. More...

	addOption ( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
	Add a parameter to the script. More...

	adjustMemoryLimit ()
	Adjusts PHP's memory limit to better suit our needs, if needed. More...

	afterFinalSetup ()
	Override to perform any required operation at the end of initialisation. More...

	beginTransaction (IDatabase $dbw, $fname)
	Begin a transaction on a DB. More...

	commitTransaction (IDatabase $dbw, $fname)
	Commit the transaction on a DB handle and wait for replica DBs to catch up. More...

	countDown ( $seconds)
	Count down from $seconds to zero on the terminal, with a one-second pause between showing each number. More...

	deleteOption ( $name)
	Remove an option. More...

	error ( $err, $die=0)
	Throw an error to the user. More...

	fatalError ( $msg, $exitCode=1)
	Output a message and terminate the current script. More...

	getArg ( $argId=0, $default=null)
	Get an argument. More...

	getBatchSize ()
	Returns batch size. More...

	getDB ( $db, $groups=[], $dbDomain=false)
	Returns a database to be used by current maintenance script. More...

	getDir ()
	Get the maintenance directory. More...

	getHookContainer ()
	Get a HookContainer, for running extension hooks or for hook metadata. More...

	getHookRunner ()
	Get a HookRunner for running core hooks. More...

	getOption ( $name, $default=null)
	Get an option, or return the default. More...

	getStdin ( $len=null)
	Return input from stdin. More...

	hasArg ( $argId=0)
	Does a given argument exist? More...

	hasOption ( $name)
	Checks to see if a particular option was set. More...

	loadSpecialVars ()
	Handle the special variables that are global to all scripts @stable to override. More...

	maybeHelp ( $force=false)
	Maybe show the help. More...

	output ( $out, $channel=null)
	Throw some output to the user. More...

	parseIntList ( $text)
	Utility function to parse a string (perhaps from a command line option) into a list of integers (perhaps some kind of numeric IDs). More...

	requireExtension ( $name)
	Indicate that the specified extension must be loaded before the script can run. More...

	rollbackTransaction (IDatabase $dbw, $fname)
	Rollback the transaction on a DB handle. More...

	setAllowUnregisteredOptions ( $allow)
	Sets whether to allow unregistered options, which are options passed to a script that do not match an expected parameter. More...

	setBatchSize ( $s=0)

	showHelp ()
	Definitely show the help. More...

	supportsOption ( $name)
	Checks to see if a particular option in supported. More...

	validateUserOption ( $errorMsg)

	waitForReplication ()
	Wait for replica DBs to catch up. More...

Protected Attributes
bool	$mAllowUnregisteredOptions = false
	Allow arbitrary options to be passed, or only specified ones? More...

array	$mArgList = []
	Desired/allowed args. More...

array	$mArgs = []
	This is the list of arguments that were actually passed. More...

int null	$mBatchSize = null
	Batch size. More...

	$mDbUser

string	$mDescription = ''
	A description of the script, children should change this via addDescription() More...

bool	$mInputLoaded = false
	Have we already loaded our user input? More...

array	$mOptions = []
	This is the list of options that were actually passed. More...

array[]	$mParams = []
	Array of desired/allowed params. More...

bool	$mQuiet = false
	Special vars for params that are always used. More...

string null	$mSelf
	Name of the script currently running. More...

array	$mShortParamsMap = []
	Mapping short parameters to long ones. More...

Private Member Functions
	formatHelpItems (array $items, $heading, $descWidth, $tab)

	setParam (&$options, $option, $value)
	Helper function used solely by loadParamsAndArgs to prevent code duplication. More...

Static Private Member Functions
static	readlineEmulation ( $prompt)
	Emulate readline() More...

Private Attributes
	$atLineStart = true

Config null	$config
	Accessible via getConfig() More...

HookContainer null	$hookContainer

HookRunner null	$hookRunner

	$lastChannel = null

float	$lastReplicationWait = 0.0
	UNIX timestamp. More...

IMaintainableDatabase null	$mDb = null
	Used by getDB() / setDB() More...

array[]	$mDependentParameters = []
	Generic options which might or not be supported by the script. More...

array[]	$mGenericParameters = []
	Generic options added by addDefaultParams() More...

array	$requiredExtensions = []

Detailed Description

Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effort.

All that must be defined is the execute() method. See docs/maintenance.txt for more info and a quick demo of how to use it.

Terminology: params: registry of named values that may be passed to the script arg list: registry of positional values that may be passed to the script options: passed param values args: passed positional values

In the command: mwscript somescript.php –foo=bar baz foo is a param bar is the option value of the option for param foo baz is the arg value at index 0 in the arg list

WARNING: the constructor, shouldExecute(), setup(), finalSetup(), getName() and loadSettings() are called before Setup.php is complete, which means most of the common infrastructure, like logging or autoloading, is not available. Be careful when changing these methods or the ones called from them. Likewise, be careful with the constructor when subclassing. MediaWikiServices instance is not yet available at this point.

Stability: stable: to extend

Since: 1.16

Definition at line 61 of file Maintenance.php.

Constructor & Destructor Documentation

◆ __construct()

Maintenance::__construct ( )

Default constructor.

Children should call this first if implementing their own constructors

Stability: stable: to call

Reimplemented in WrapOldPasswords, ViewCLI, Version, ValidateRegistrationFile, UserOptionsMaintenance, UppercaseTitlesForUnicodeTransition, UpdateSpecialPages, UpdateSearchIndex, UpdateRestrictions, UpdateExtensionJsonSchema, UpdateCollation, UpdateArticleCount, UpdateMediaWiki, Undelete, TableCleanup, OrphanStats, DumpRev, CompressOld, SqliteMaintenance, MwSql, ShowSiteStats, ShowJobs, MediaWikiShell, RunJobs, RunBatchedQuery, RollbackEdits, ResetUserTokens, ResetUserEmail, ResetPageRandom, ResetAuthenticationThrottle, DumpRenderer, RenameRestrictions, RenameDbPrefix, RemoveUnusedAccounts, RemoveInvalidEmails, RefreshLinks, RefreshImageMetadata, RefreshFileHeaders, RefreshExternallinksIndex, RecountCategories, RebuildTextIndex, RebuildRecentchanges, RebuildMessages, RebuildLocalisationCache, ImageBuilder, RebuildFileCache, RebuildAll, ReassignEdits, PurgeParserCache, PurgePage, PurgeOldText, PurgeModuleDeps, PurgeList, PurgeExpiredWatchlistItems, PurgeExpiredUserrights, PurgeExpiredBlocks, PurgeChangedPages, PurgeChangedFiles, PruneFileCache, Protect, PopulateRevisionSha1, PopulateRevisionLength, PopulateRecentChangesSource, PopulatePPSortKey, PopulateIpChanges, PopulateInterwiki, PopulateImageSha1, PopulateFilearchiveSha1, PopulateExternallinksIndex60, PopulateContentTables, PopulateChangeTagDef, PopulateBacklinkNamespace, PopulateArchiveRevId, PatchSql, CLIParser, PageExists, NukePage, NukeNS, NamespaceDupes, MysqlMaintenance, MWDocGen, MoveBatch, MigrateUserGroup, MigrateRevisionActorTemp, MigrateLinksTable, MigrateImageCommentTemp, MigrateFileRepoLayout, MigrateComments, MigrateArchiveText, MergeMessageFileList, GeneratePhpCharToUpperMappings, McTest, ManageJobs, ManageForeignResources, MakeTestEdits, ListVariants, LangMemUsage, GenerateUpperCharTable, GenerateUcfirstOverrides, GenerateNormalizerDataMl, GenerateNormalizerDataAr, GenerateCollationData, DumpMessages, Digit2Html, DateFormats, AllTrans, DatabaseLag, JSParseHelper, InvalidateUserSessions, InvalidateBotPasswords, CommandLineInstaller, InitUserPreference, InitSiteStats, InitEditCount, SchemaMaintenance, MigrateActors, LoggedUpdateMaintenance, DeleteLocalPasswords, Benchmarker, ImportTextFiles, ImportSiteScripts, ImportSites, ImportImages, BackupReader, GrepPages, GetTextMaint, GetReplicaServer, GetLagTimes, GetConfiguration, GenerateSitemap, GenerateSchemaSql, GenerateSchemaChangeSql, GenerateJsonI18n, GenerateConfigVars, GenerateConfigSchemaYaml, GenerateConfigSchemaArray, GenerateConfigNames, FormatInstallDoc, FixUserRegistration, FixTimestamps, FixMergeHistoryCorruption, FixExtLinksProtocolRelative, FixDoubleRedirects, FixDefaultJsonContentPages, FindOrphanedFiles, FindMissingFiles, FindMissingActors, FindDeprecated, FindClasses, FindBadBlobs, FileOpPerfTest, FetchText, ExportSites, EraseArchivedFile, EmptyUserGroup, EditCLI, DumpUploads, DumpLinks, SearchDump, DumpIterator, DumpCategoriesAsRdf, DeleteUserEmail, DeleteTag, DeleteSelfExternals, DeleteOrphanedRevisions, DeleteOldRevisions, DeleteEqualMessages, DeleteDefaultMessages, DeleteBatch, DeleteAutoPatrolLogs, DeleteArchivedRevisions, DeleteArchivedFiles, DeduplicateArchiveRevId, CreateBotPassword, CreateAndPromote, CopyJobQueue, CopyFileBackend, ConvertExtensionToRegistration, CompareParsers, CompareParserCache, CommandLineInc, ClearInterwikiCache, CleanupWatchlist, CleanupUsersWithNoId, CleanupUploadStash, TitleCleanup, CleanupSpam, CleanupRevActorPage, CleanupRemovedModules, CleanupPreferences, CleanupInvalidDbKeys, CleanupImages, CleanupEmptyCategories, CleanupCaps, CleanupBlocks, CheckUsernames, CheckImages, CheckDependencies, CheckComposerLockUpToDate, CheckBadRedirects, ChangePassword, CategoryChangesAsRdf, BlockUsers, BenchmarkTitleValue, BenchmarkTidy, BenchmarkSettings, BenchmarkSanitizer, BenchmarkPurge, BenchmarkParse, BenchmarkLruHash, BenchmarkJSMinPlus, BenchmarkHooks, BenchmarkEval, BenchmarkCommentFormatter, AttachLatest, AddSite, AddRFCandPMIDInterwiki, and AddChangeTag.

Definition at line 182 of file Maintenance.php.

References addDefaultParams().

Member Function Documentation

◆ activateProfiler()

Maintenance::activateProfiler ( )

protected

Activate the profiler (assuming $wgProfiler is set)

Definition at line 779 of file Maintenance.php.

References $wgProfiler, $wgTrxProfilerLimits, getOption(), Profiler\instance(), and Profiler\replaceStubInstance().

Referenced by finalSetup().

◆ addArg()

Maintenance::addArg	(	$arg,
		$description,
		$required = `true`
	)

protected

Add some args that are needed.

Parameters

string	$arg	Name of the arg, like 'start'
string	$description	Short description of the arg
bool	$required	Is this required?

Definition at line 302 of file Maintenance.php.

Referenced by AddSite\__construct(), BenchmarkEval\__construct(), BenchmarkParse\__construct(), BlockUsers\__construct(), CleanupSpam\__construct(), ConvertExtensionToRegistration\__construct(), CreateAndPromote\__construct(), CreateBotPassword\__construct(), DeleteBatch\__construct(), DeleteTag\__construct(), DeleteUserEmail\__construct(), EditCLI\__construct(), EmptyUserGroup\__construct(), ExportSites\__construct(), FixTimestamps\__construct(), FormatInstallDoc\__construct(), GenerateJsonI18n\__construct(), GetTextMaint\__construct(), GrepPages\__construct(), BackupReader\__construct(), ImportImages\__construct(), ImportSites\__construct(), ImportSiteScripts\__construct(), ImportTextFiles\__construct(), CommandLineInstaller\__construct(), JSParseHelper\__construct(), ManageForeignResources\__construct(), McTest\__construct(), MigrateUserGroup\__construct(), MoveBatch\__construct(), MysqlMaintenance\__construct(), NukePage\__construct(), PageExists\__construct(), CLIParser\__construct(), PatchSql\__construct(), Protect\__construct(), ReassignEdits\__construct(), RefreshLinks\__construct(), RenameRestrictions\__construct(), ResetUserEmail\__construct(), DumpRev\__construct(), Undelete\__construct(), UpdateExtensionJsonSchema\__construct(), UserOptionsMaintenance\__construct(), ValidateRegistrationFile\__construct(), and ViewCLI\__construct().

◆ addDefaultParams()

Maintenance::addDefaultParams ( )

protected

Add the default parameters to the scripts.

Definition at line 558 of file Maintenance.php.

References $mParams, addOption(), and getDbType().

Referenced by __construct().

◆ addDescription()

Maintenance::addDescription ( $text )

protected

Set the description text.

Parameters

string $text The text of the description

Definition at line 331 of file Maintenance.php.

◆ addOption()

Maintenance::addOption	(	$name,
		$description,
		$required = `false`,
		$withArg = `false`,
		$shortName = `false`,
		$multiOccurrence = `false`
	)

protected

Add a parameter to the script.

Will be displayed on –help with the associated description

Parameters

string	$name	The name of the param (help, version, etc)
string	$description	The description of the param to show on –help
bool	$required	Is the param required?
bool	$withArg	Is an argument required with this option?
string \| bool	$shortName	Character to use as short name
bool	$multiOccurrence	Can this option be passed multiple times?

Definition at line 251 of file Maintenance.php.

◆ adjustMemoryLimit()

Maintenance::adjustMemoryLimit ( )

protected

Adjusts PHP's memory limit to better suit our needs, if needed.

Definition at line 766 of file Maintenance.php.

References memoryLimit().

Referenced by finalSetup(), and setup().

◆ afterFinalSetup()

Maintenance::afterFinalSetup ( )

protected

Override to perform any required operation at the end of initialisation.

Stability: stable: to override

Reimplemented in UpdateMediaWiki.

Definition at line 1236 of file Maintenance.php.

Referenced by finalSetup().

◆ beginTransaction()

Maintenance::beginTransaction	(	IDatabase	$dbw,
			$fname
	)

protected

Begin a transaction on a DB.

This method makes it clear that begin() is called from a maintenance script, which has outermost scope. This is safe, unlike $dbw->begin() called in other places.

Parameters

IDatabase	$dbw
string	$fname	Caller name

Since: 1.27

Definition at line 1429 of file Maintenance.php.

References Wikimedia\Rdbms\IDatabase\begin().

Referenced by CleanupSpam\cleanupArticle(), CompressOld\compressWithConcat(), UpdateCollation\copyBatch(), NukePage\deleteRevisions(), DeduplicateArchiveRevId\doDBUpdates(), MigrateArchiveText\doDBUpdates(), MigrateImageCommentTemp\doDBUpdates(), PopulatePPSortKey\doDBUpdates(), DeleteOldRevisions\doDelete(), PopulateRevisionLength\doLenUpdates(), ReassignEdits\doReassignEdits(), PopulateRevisionSha1\doSha1LegacyUpdates(), PopulateRevisionSha1\doSha1Updates(), CleanupRemovedModules\execute(), DeleteArchivedFiles\execute(), DeleteOrphanedRevisions\execute(), MigrateUserGroup\execute(), MoveBatch\execute(), NukeNS\execute(), NukePage\execute(), PurgeModuleDeps\execute(), RebuildFileCache\execute(), UpdateRestrictions\execute(), WrapOldPasswords\execute(), RemoveUnusedAccounts\isInactiveAccount(), NamespaceDupes\mergePage(), MigrateActors\migrateToTemp(), MigrateComments\migrateToTemp(), CleanupImages\pokeFile(), PopulateContentTables\populateContentTablesForRowBatch(), purgeRedundantText(), and UpdateCollation\updateBatch().

◆ checkRequiredExtensions()

Maintenance::checkRequiredExtensions ( )

Verify that the required extensions are installed.

Since: 1.28

Definition at line 634 of file Maintenance.php.

References fatalError(), and ExtensionRegistry\getInstance().

◆ cleanupChanneled()

Maintenance::cleanupChanneled ( )

Clean up channeled output.

Output a newline if necessary.

Definition at line 502 of file Maintenance.php.

Referenced by output(), and outputChanneled().

◆ clearParamsAndArgs()

Maintenance::clearParamsAndArgs ( )

Clear all params and arguments.

Definition at line 807 of file Maintenance.php.

◆ commitTransaction()

Maintenance::commitTransaction	(	IDatabase	$dbw,
			$fname
	)

protected

Commit the transaction on a DB handle and wait for replica DBs to catch up.

This method makes it clear that commit() is called from a maintenance script, which has outermost scope. This is safe, unlike $dbw->commit() called in other places.

Parameters

IDatabase	$dbw
string	$fname	Caller name

Returns: bool Whether the replica DB wait succeeded

Since: 1.27

Definition at line 1444 of file Maintenance.php.

References Wikimedia\Rdbms\IDatabase\commit(), and waitForReplication().

Referenced by CleanupSpam\cleanupArticle(), CompressOld\compressWithConcat(), UpdateCollation\copyBatch(), NukePage\deleteRevisions(), DeduplicateArchiveRevId\doDBUpdates(), MigrateArchiveText\doDBUpdates(), MigrateImageCommentTemp\doDBUpdates(), PopulatePPSortKey\doDBUpdates(), DeleteOldRevisions\doDelete(), PopulateRevisionLength\doLenUpdates(), ReassignEdits\doReassignEdits(), PopulateRevisionSha1\doSha1LegacyUpdates(), PopulateRevisionSha1\doSha1Updates(), CleanupRemovedModules\execute(), DeleteArchivedFiles\execute(), DeleteOrphanedRevisions\execute(), DeleteSelfExternals\execute(), MigrateUserGroup\execute(), MoveBatch\execute(), NukeNS\execute(), NukePage\execute(), PurgeModuleDeps\execute(), RebuildFileCache\execute(), UpdateRestrictions\execute(), WrapOldPasswords\execute(), RemoveUnusedAccounts\isInactiveAccount(), NamespaceDupes\mergePage(), MigrateActors\migrateToTemp(), MigrateComments\migrateToTemp(), CleanupImages\pokeFile(), PopulateContentTables\populateContentTablesForRowBatch(), purgeRedundantText(), and UpdateCollation\updateBatch().

◆ countDown()

Maintenance::countDown ( $seconds )

protected

Count down from $seconds to zero on the terminal, with a one-second pause between showing each number.

If the maintenance script is in quiet mode, this function does nothing.

Since: 1.31

@codeCoverageIgnore

Parameters

int $seconds

Definition at line 1488 of file Maintenance.php.

References isQuiet(), and output().

Referenced by DeleteAutoPatrolLogs\execute(), ResetUserTokens\execute(), UpdateMediaWiki\execute(), and UserOptionsMaintenance\warn().

◆ deleteOption()

Maintenance::deleteOption ( $name )

protected

Remove an option.

Useful for removing options that won't be used in your script.

Parameters

string $name The option to remove.

Definition at line 314 of file Maintenance.php.

◆ error()

Maintenance::error	(	$err,
		$die = `0`
	)

protected

Throw an error to the user.

Doesn't respect –quiet, so don't use this for non-error output

Stability: stable: to override

Parameters

string	$err	The error to display
int	$die	Deprecated since 1.31, use Maintenance::fatalError() instead

Definition at line 466 of file Maintenance.php.

References fatalError(), outputChanneled(), and wfDeprecated().

Referenced by MigrateActors\addActorsForRows(), SqliteMaintenance\backup(), CleanupImages\buildSafeTitle(), FindOrphanedFiles\checkFiles(), SqliteMaintenance\checkSyntax(), CleanupSpam\cleanupArticle(), CompressOld\compressPage(), CompressOld\compressWithConcat(), CompareParsers\conclusions(), CopyFileBackend\copyFileBatch(), CopyFileBackend\delFileBatch(), FixExtLinksProtocolRelative\doDBUpdates(), MigrateActors\doDBUpdates(), MigrateArchiveText\doDBUpdates(), MigrateImageCommentTemp\doDBUpdates(), MigrateRevisionActorTemp\doDBUpdates(), PopulateRecentChangesSource\doDBUpdates(), RefreshExternallinksIndex\doDBUpdates(), UppercaseTitlesForUnicodeTransition\doMove(), CleanupUploadStash\doOperations(), UpdateSpecialPages\doSpecialPageCacheUpdates(), UppercaseTitlesForUnicodeTransition\doUpdate(), AddSite\execute(), BenchmarkPurge\execute(), CategoryChangesAsRdf\execute(), CreateAndPromote\execute(), DeleteArchivedFiles\execute(), DumpIterator\execute(), FixDoubleRedirects\execute(), GenerateJsonI18n\execute(), GrepPages\execute(), ImportSiteScripts\execute(), ImportTextFiles\execute(), SchemaMaintenance\execute(), Digit2Html\execute(), GenerateNormalizerDataAr\execute(), ManageForeignResources\execute(), MergeMessageFileList\execute(), MigrateFileRepoLayout\execute(), MoveBatch\execute(), PatchSql\execute(), PopulateInterwiki\execute(), PurgeChangedFiles\execute(), PurgeChangedPages\execute(), PurgeExpiredWatchlistItems\execute(), ReassignEdits\execute(), DumpRenderer\execute(), ResetUserEmail\execute(), RollbackEdits\execute(), SqliteMaintenance\execute(), CompressOld\execute(), UpdateSearchIndex\execute(), UppercaseTitlesForUnicodeTransition\execute(), fatalError(), DumpIterator\handleRevision(), DumpRenderer\handleRevision(), FindBadBlobs\handleStatus(), SqliteMaintenance\integrityCheck(), loadWithArgv(), MigrateActors\migrate(), MigrateActors\migrateLogSearch(), MigrateActors\migrateToTemp(), UppercaseTitlesForUnicodeTransition\mungeTitle(), CleanupImages\pokeFile(), CompareParsers\processRevision(), UppercaseTitlesForUnicodeTransition\processUsers(), PurgePage\purge(), PurgeChangedFiles\purgeFromArchiveTable(), PurgeChangedFiles\purgeFromLogType(), MergeMessageFileList\readFile(), RefreshLinks\refreshTrackingCategory(), UpdateSpecialPages\reopenAndWaitForReplicas(), CommandLineInstaller\setDbPassOption(), setParam(), CommandLineInstaller\setPassOption(), MwSql\sqlDoQuery(), RefreshFileHeaders\updateFileHeaders(), GetConfiguration\validateParamsAndArgs(), validateParamsAndArgs(), and CLIParser\Wikitext().

◆ execute()

Maintenance::execute ( )

abstract

Do the actual work.

All child classes will need to implement this

Returns: bool|null|void True for success, false for failure. Not returning a value, or returning null, is also interpreted as success. Returning false for failure will cause doMaintenance.php to exit the process with a non-zero exit status.

Reimplemented in WrapOldPasswords, ViewCLI, Version, ValidateRegistrationFile, UserOptionsMaintenance, UppercaseTitlesForUnicodeTransition, UpdateSpecialPages, UpdateSearchIndex, UpdateRestrictions, UpdateExtensionJsonSchema, UpdateCollation, UpdateArticleCount, UpdateMediaWiki, Undelete, TidyUpT39714, TableCleanup, StorageTypeStats, OrphanStats, DumpRev, CompressOld, SqliteMaintenance, MwSql, ShowSiteStats, ShowJobs, MediaWikiShell, RunJobs, RunBatchedQuery, RollbackEdits, ResetUserTokens, ResetUserEmail, ResetPageRandom, ResetAuthenticationThrottle, DumpRenderer, RenameRestrictions, RenameDbPrefix, RemoveUnusedAccounts, RemoveInvalidEmails, RefreshLinks, RefreshImageMetadata, RefreshFileHeaders, RecountCategories, RebuildTextIndex, RebuildRecentchanges, RebuildMessages, RebuildLocalisationCache, ImageBuilder, RebuildFileCache, RebuildAll, ReassignEdits, PurgeParserCache, PurgePage, PurgeOldText, PurgeModuleDeps, PurgeMessageBlobStore, PurgeList, PurgeExpiredWatchlistItems, PurgeExpiredUserrights, PurgeExpiredBlocks, PurgeChangedPages, PurgeChangedFiles, PruneFileCache, Protect, PopulateInterwiki, PopulateImageSha1, PopulateContentTables, PatchSql, CLIParser, PageExists, NukePage, NukeNS, NamespaceDupes, MysqlMaintenance, MWDocGen, MoveBatch, MigrateUserGroup, MigrateFileRepoLayout, MergeMessageFileList, GeneratePhpCharToUpperMappings, McTest, ManageJobs, ManageForeignResources, MakeTestEdits, ListVariants, LangMemUsage, GenerateUpperCharTable, GenerateUcfirstOverrides, GenerateNormalizerDataMl, GenerateNormalizerDataAr, GenerateCollationData, DumpMessages, Digit2Html, DateFormats, AllTrans, DatabaseLag, JSParseHelper, InvalidateUserSessions, InvalidateBotPasswords, CommandLineInstaller, InitUserPreference, InitSiteStats, InitEditCount, TextPassDumper, SchemaMaintenance, LoggedUpdateMaintenance, FakeMaintenance, DeleteLocalPasswords, BackupDumper, ImportTextFiles, ImportSiteScripts, ImportSites, ImportImages, BackupReader, GrepPages, GetTextMaint, GetReplicaServer, GetLagTimes, GetConfiguration, GenerateSitemap, GenerateJsonI18n, GenerateConfigVars, GenerateConfigSchemaYaml, GenerateConfigSchemaArray, GenerateConfigNames, FormatInstallDoc, FixUserRegistration, FixTimestamps, FixMergeHistoryCorruption, FixDoubleRedirects, FindOrphanedFiles, FindMissingFiles, FindMissingActors, FindDeprecated, FindClasses, FindBadBlobs, FileOpPerfTest, FetchText, ExportSites, EraseArchivedFile, EmptyUserGroup, EditCLI, DumpUploads, DumpLinks, DumpIterator, DumpCategoriesAsRdf, DumpBackup, DeleteUserEmail, DeleteTag, DeleteSelfExternals, DeleteOrphanedRevisions, DeleteOldRevisions, DeleteEqualMessages, DeleteDefaultMessages, DeleteBatch, DeleteAutoPatrolLogs, DeleteArchivedRevisions, DeleteArchivedFiles, CreateBotPassword, CreateAndPromote, CopyJobQueue, CopyFileBackend, ConvertExtensionToRegistration, CompareParserCache, CommandLineInc, ClearInterwikiCache, CleanupWatchlist, CleanupUploadStash, CleanupSpam, CleanupRemovedModules, CleanupPreferences, CleanupInvalidDbKeys, CleanupCaps, CleanupBlocks, CheckUsernames, CheckImages, CheckDependencies, CheckComposerLockUpToDate, CheckBadRedirects, ChangePassword, CategoryChangesAsRdf, BlockUsers, BenchmarkTruncate, BenchmarkTitleValue, BenchmarkTidy, BenchmarkSettings, BenchmarkSanitizer, BenchmarkPurge, BenchmarkParse, BenchmarkLruHash, BenchmarkJSMinPlus, BenchmarkHooks, BenchmarkEval, BenchmarkCommentFormatter, AttachLatest, AddSite, and AddChangeTag.

◆ fatalError()

Maintenance::fatalError	(	$msg,
		$exitCode = `1`
	)

protected

Output a message and terminate the current script.

Stability: stable: to override

Parameters

string	$msg	Error message
int	$exitCode	PHP exit status. Should be in range 1-254.

Since: 1.31

Returns: never

Definition at line 491 of file Maintenance.php.

References error().

Referenced by checkRequiredExtensions(), ResetAuthenticationThrottle\clearLoginThrottle(), UpdateMediaWiki\compatChecks(), CopyFileBackend\copyFileBatch(), CopyFileBackend\delFileBatch(), PopulateImageSha1\doDBUpdates(), PopulateIpChanges\doDBUpdates(), PopulateRevisionLength\doDBUpdates(), PopulateRevisionSha1\doDBUpdates(), error(), AddChangeTag\execute(), BenchmarkCommentFormatter\execute(), BenchmarkEval\execute(), BenchmarkJSMinPlus\execute(), BenchmarkParse\execute(), BenchmarkTidy\execute(), BlockUsers\execute(), ChangePassword\execute(), CheckComposerLockUpToDate\execute(), CleanupSpam\execute(), CleanupUploadStash\execute(), ConvertExtensionToRegistration\execute(), CopyFileBackend\execute(), CopyJobQueue\execute(), CreateAndPromote\execute(), CreateBotPassword\execute(), DeleteBatch\execute(), DeleteDefaultMessages\execute(), DeleteEqualMessages\execute(), DeleteSelfExternals\execute(), DeleteTag\execute(), DeleteUserEmail\execute(), DumpBackup\execute(), DumpIterator\execute(), EditCLI\execute(), EraseArchivedFile\execute(), ExportSites\execute(), FindBadBlobs\execute(), FindMissingActors\execute(), FindOrphanedFiles\execute(), FixDoubleRedirects\execute(), FixMergeHistoryCorruption\execute(), FixTimestamps\execute(), FormatInstallDoc\execute(), GenerateJsonI18n\execute(), GenerateSitemap\execute(), GetReplicaServer\execute(), GetTextMaint\execute(), BackupReader\execute(), ImportImages\execute(), ImportTextFiles\execute(), SchemaMaintenance\execute(), InvalidateUserSessions\execute(), JSParseHelper\execute(), GenerateCollationData\execute(), GenerateNormalizerDataAr\execute(), LangMemUsage\execute(), MakeTestEdits\execute(), ManageForeignResources\execute(), ManageJobs\execute(), McTest\execute(), GeneratePhpCharToUpperMappings\execute(), MergeMessageFileList\execute(), MigrateFileRepoLayout\execute(), MigrateUserGroup\execute(), MoveBatch\execute(), MWDocGen\execute(), MysqlMaintenance\execute(), Protect\execute(), PruneFileCache\execute(), PurgeList\execute(), PurgeParserCache\execute(), RebuildFileCache\execute(), RebuildLocalisationCache\execute(), RebuildRecentchanges\execute(), RebuildTextIndex\execute(), RecountCategories\execute(), RefreshImageMetadata\execute(), RefreshLinks\execute(), RemoveUnusedAccounts\execute(), RenameDbPrefix\execute(), DumpRenderer\execute(), ResetAuthenticationThrottle\execute(), ResetUserEmail\execute(), RollbackEdits\execute(), RunJobs\execute(), MediaWikiShell\execute(), MwSql\execute(), CompressOld\execute(), DumpRev\execute(), OrphanStats\execute(), StorageTypeStats\execute(), Undelete\execute(), UpdateMediaWiki\execute(), UpdateExtensionJsonSchema\execute(), UpdateRestrictions\execute(), UpdateSpecialPages\execute(), UppercaseTitlesForUnicodeTransition\execute(), ValidateRegistrationFile\execute(), Version\execute(), ViewCLI\execute(), WrapOldPasswords\execute(), GenerateCollationData\generateFirstChars(), CopyFileBackend\getListingDiffRel(), FindMissingActors\getNewActorId(), BackupReader\getNsIndex(), RefreshLinks\getPossibleCategories(), FindBadBlobs\getStartTimestamp(), PopulateContentTables\getTables(), ConvertExtensionToRegistration\handleExtensionFunctions(), ConvertExtensionToRegistration\handleHooks(), FindBadBlobs\handleStatus(), BackupReader\importFromFile(), BackupReader\importFromHandle(), ReassignEdits\initialiseUser(), DeleteLocalPasswords\initialize(), GenerateUcfirstOverrides\loadJson(), loadSettings(), CheckDependencies\loadThing(), TitleCleanup\moveInconsistentPage(), RefreshImageMetadata\newLocalRepo(), PopulateContentTables\populateContentTablesForRowBatch(), DumpBackup\processOptions(), BackupDumper\processOptions(), runChild(), MysqlMaintenance\runMysql(), CommandLineInstaller\setDbPassOption(), CommandLineInstaller\setPassOption(), setup(), UserOptionsMaintenance\showUsageStats(), MwSql\sqlDoQuery(), GenerateJsonI18n\transformI18nFile(), SqliteMaintenance\vacuum(), and validateUserOption().

◆ finalSetup()

Maintenance::finalSetup ( SettingsBuilder $settingsBuilder = null )

Handle some last-minute setup here.

@stable to override

Parameters

SettingsBuilder | null $settingsBuilder

Reimplemented in RunJobs, RebuildLocalisationCache, RebuildFileCache, MergeMessageFileList, TextPassDumper, BackupDumper, GetConfiguration, FetchText, and DumpIterator.

Definition at line 1135 of file Maintenance.php.

References $config, $mDbPass, $mDbUser, activateProfiler(), adjustMemoryLimit(), afterFinalSetup(), Config\get(), getDbType(), getOption(), and hasOption().

◆ formatHelpItems()

Maintenance::formatHelpItems	(	array	$items,
			$heading,
			$descWidth,
			$tab
	)

private

Definition at line 1105 of file Maintenance.php.

References output().

Referenced by showHelp().

◆ getArg()

Maintenance::getArg	(	$argId = `0`,
		$default = `null`
	)

protected

Get an argument.

Parameters

int	$argId	The integer value (from zero) for the arg
mixed \| null	$default	The default if it doesn't exist

Returns: mixed; -taint none

Definition at line 355 of file Maintenance.php.

References wfDeprecated().

Referenced by AddSite\execute(), BenchmarkEval\execute(), BenchmarkParse\execute(), BlockUsers\execute(), CleanupSpam\execute(), ConvertExtensionToRegistration\execute(), CreateAndPromote\execute(), CreateBotPassword\execute(), DeleteBatch\execute(), DeleteTag\execute(), DeleteUserEmail\execute(), EditCLI\execute(), EmptyUserGroup\execute(), ExportSites\execute(), FixTimestamps\execute(), FormatInstallDoc\execute(), GenerateJsonI18n\execute(), GetTextMaint\execute(), GrepPages\execute(), BackupReader\execute(), ImportImages\execute(), ImportSites\execute(), ImportSiteScripts\execute(), ImportTextFiles\execute(), CommandLineInstaller\execute(), ManageForeignResources\execute(), McTest\execute(), MigrateUserGroup\execute(), MoveBatch\execute(), NukePage\execute(), PageExists\execute(), Protect\execute(), ReassignEdits\execute(), RefreshLinks\execute(), RenameRestrictions\execute(), ResetUserEmail\execute(), MwSql\execute(), DumpRev\execute(), Undelete\execute(), UpdateExtensionJsonSchema\execute(), ValidateRegistrationFile\execute(), ViewCLI\execute(), ImportSiteScripts\fetchScriptList(), UserOptionsMaintenance\showUsageStats(), UserOptionsMaintenance\updateOptions(), and CLIParser\Wikitext().

◆ getBatchSize()

Maintenance::getBatchSize ( )

protected

Returns batch size.

Since: 1.31

Returns: int|null

Definition at line 370 of file Maintenance.php.

References $mBatchSize.

Referenced by PopulateChangeTagDef\backpopulateChangeTagPerTag(), CopyJobQueue\copyJobs(), CleanupPreferences\deleteByWhere(), DeduplicateArchiveRevId\doDBUpdates(), MigrateArchiveText\doDBUpdates(), MigrateImageCommentTemp\doDBUpdates(), MigrateLinksTable\doDBUpdates(), MigrateRevisionActorTemp\doDBUpdates(), PopulateArchiveRevId\doDBUpdates(), PopulateBacklinkNamespace\doDBUpdates(), PopulateChangeTagDef\doDBUpdates(), PopulateFilearchiveSha1\doDBUpdates(), PopulateImageSha1\doDBUpdates(), PopulateIpChanges\doDBUpdates(), PopulatePPSortKey\doDBUpdates(), PopulateRecentChangesSource\doDBUpdates(), PopulateRevisionLength\doLenUpdates(), PopulateRevisionSha1\doSha1Updates(), RecountCategories\doWork(), CheckUsernames\execute(), CleanupBlocks\execute(), CleanupRemovedModules\execute(), CleanupUploadStash\execute(), CopyFileBackend\execute(), DeleteAutoPatrolLogs\execute(), DeleteTag\execute(), EmptyUserGroup\execute(), FindMissingFiles\execute(), FindOrphanedFiles\execute(), InitUserPreference\execute(), InvalidateUserSessions\execute(), MakeTestEdits\execute(), MigrateFileRepoLayout\execute(), MigrateUserGroup\execute(), PurgeChangedPages\execute(), PurgeExpiredWatchlistItems\execute(), PurgeModuleDeps\execute(), RebuildFileCache\execute(), RefreshFileHeaders\execute(), RefreshImageMetadata\execute(), RefreshLinks\execute(), ResetPageRandom\execute(), ResetUserTokens\execute(), MwSql\execute(), UpdateCollation\execute(), UpdateRestrictions\execute(), FindMissingActors\findBadActors(), DumpCategoriesAsRdf\getCategoryIterator(), DumpCategoriesAsRdf\getCategoryLinksIterator(), DeleteAutoPatrolLogs\getRows(), DeleteAutoPatrolLogs\getRowsOld(), DeleteLocalPasswords\getUserBatches(), MigrateLinksTable\handlePageBatch(), PopulateContentTables\loadContentMap(), MigrateComments\migrate(), MigrateComments\migrateToTemp(), PopulateContentTables\populateTable(), UppercaseTitlesForUnicodeTransition\processTable(), UppercaseTitlesForUnicodeTransition\processUsers(), PurgeChangedFiles\purgeFromLogType(), RebuildRecentchanges\rebuildRecentChangesTablePass1(), RebuildRecentchanges\rebuildRecentChangesTablePass2(), RebuildRecentchanges\rebuildRecentChangesTablePass3(), RebuildRecentchanges\rebuildRecentChangesTablePass4(), RebuildRecentchanges\rebuildRecentChangesTablePass5(), RefreshLinks\refreshCategory(), ManageJobs\repushAbandoned(), TableCleanup\runTable(), FindBadBlobs\scanRevisionsById(), FindBadBlobs\scanRevisionsByTimestamp(), and UserOptionsMaintenance\updateOptions().

◆ getConfig()

Maintenance::getConfig ( )

Since: 1.24

Stability: stable: to override

Returns: Config

Definition at line 600 of file Maintenance.php.

References $config.

Referenced by NamespaceDupes\checkAll(), ResetAuthenticationThrottle\clearLoginThrottle(), ResetAuthenticationThrottle\clearSignupThrottle(), AddRFCandPMIDInterwiki\doDBUpdates(), MigrateArchiveText\doDBUpdates(), PopulateImageSha1\doDBUpdates(), ReassignEdits\doReassignEdits(), UpdateSpecialPages\doSpecialPageCacheUpdates(), CategoryChangesAsRdf\execute(), CleanupPreferences\execute(), CreateBotPassword\execute(), DumpIterator\execute(), PurgeList\execute(), UpdateSpecialPages\execute(), UpdateCollation\init(), CheckDependencies\loadThing(), output(), CleanupWatchlist\removeWatch(), and shutdown().

◆ getDB()

Maintenance::getDB	(	$db,
		$groups = `[]`,
		$dbDomain = `false`
	)

protected

Returns a database to be used by current maintenance script.

This uses the main LBFactory instance by default unless overriden via setDB().

This function has the same parameters as LoadBalancer::getConnection().

@stable to override

Parameters

int	$db	DB index (DB_REPLICA/DB_PRIMARY)
string \| string[]	$groups	default: empty array
string \| bool	$dbDomain	default: current wiki

Returns: IMaintainableDatabase

Definition at line 1398 of file Maintenance.php.

References $mDb.

Referenced by ImageBuilder\buildTable(), NamespaceDupes\checkLinkTable(), CleanupUsersWithNoId\cleanup(), CleanupSpam\cleanupArticle(), CleanupInvalidDbKeys\cleanupTable(), RebuildTextIndex\clearSearchIndex(), CompressOld\compressOldPages(), CompressOld\compressPage(), CompressOld\compressWithConcat(), RebuildTextIndex\createMysqlTextIndex(), CleanupPreferences\deleteByWhere(), RefreshLinks\deleteLinksFromNonexistent(), NukePage\deleteRevisions(), RefreshLinks\dfnCheckInterval(), AddRFCandPMIDInterwiki\doDBUpdates(), CleanupRevActorPage\doDBUpdates(), DeduplicateArchiveRevId\doDBUpdates(), FixDefaultJsonContentPages\doDBUpdates(), FixExtLinksProtocolRelative\doDBUpdates(), MigrateActors\doDBUpdates(), MigrateArchiveText\doDBUpdates(), MigrateImageCommentTemp\doDBUpdates(), MigrateLinksTable\doDBUpdates(), MigrateRevisionActorTemp\doDBUpdates(), PopulateArchiveRevId\doDBUpdates(), PopulateBacklinkNamespace\doDBUpdates(), PopulateExternallinksIndex60\doDBUpdates(), PopulateFilearchiveSha1\doDBUpdates(), PopulateImageSha1\doDBUpdates(), PopulateIpChanges\doDBUpdates(), PopulatePPSortKey\doDBUpdates(), PopulateRecentChangesSource\doDBUpdates(), PopulateRevisionLength\doDBUpdates(), PopulateRevisionSha1\doDBUpdates(), RefreshExternallinksIndex\doDBUpdates(), DeleteOldRevisions\doDelete(), PopulateRevisionLength\doLenUpdates(), PopulateInterwiki\doPopulate(), ReassignEdits\doReassignEdits(), RefreshLinks\doRefreshLinks(), PopulateRevisionSha1\doSha1LegacyUpdates(), PopulateRevisionSha1\doSha1Updates(), UpdateSearchIndex\doUpdateSearchIndex(), RecountCategories\doWork(), RebuildTextIndex\dropMysqlTextIndex(), AttachLatest\execute(), BenchmarkTruncate\execute(), CategoryChangesAsRdf\execute(), CheckBadRedirects\execute(), CheckImages\execute(), CheckUsernames\execute(), CleanupBlocks\execute(), CleanupPreferences\execute(), CleanupRemovedModules\execute(), CleanupSpam\execute(), ClearInterwikiCache\execute(), CompareParserCache\execute(), DeleteArchivedFiles\execute(), DeleteArchivedRevisions\execute(), DeleteDefaultMessages\execute(), DeleteEqualMessages\execute(), DeleteOrphanedRevisions\execute(), DeleteSelfExternals\execute(), DeleteTag\execute(), DumpCategoriesAsRdf\execute(), DumpLinks\execute(), EraseArchivedFile\execute(), FixDoubleRedirects\execute(), FixMergeHistoryCorruption\execute(), FixTimestamps\execute(), FixUserRegistration\execute(), GenerateSitemap\execute(), LoggedUpdateMaintenance\execute(), InitEditCount\execute(), InitSiteStats\execute(), InitUserPreference\execute(), MigrateUserGroup\execute(), MoveBatch\execute(), NukeNS\execute(), NukePage\execute(), PatchSql\execute(), PurgeChangedFiles\execute(), PurgeChangedPages\execute(), PurgeModuleDeps\execute(), RebuildAll\execute(), RebuildFileCache\execute(), ImageBuilder\execute(), RebuildTextIndex\execute(), RefreshFileHeaders\execute(), RefreshImageMetadata\execute(), RemoveInvalidEmails\execute(), RemoveUnusedAccounts\execute(), RenameDbPrefix\execute(), ResetPageRandom\execute(), ResetUserTokens\execute(), RunBatchedQuery\execute(), ShowSiteStats\execute(), OrphanStats\execute(), StorageTypeStats\execute(), TidyUpT39714\execute(), UpdateMediaWiki\execute(), UpdateArticleCount\execute(), UpdateRestrictions\execute(), UpdateSpecialPages\execute(), UppercaseTitlesForUnicodeTransition\execute(), WrapOldPasswords\execute(), DumpUploads\fetchLocal(), DeleteEqualMessages\fetchMessageInfo(), DumpUploads\fetchUsed(), TitleCleanup\fileExists(), GrepPages\findPages(), RefreshLinks\fixRedirect(), BenchmarkParse\getRevIdForTime(), RollbackEdits\getRollbackTitles(), NamespaceDupes\getTargetList(), DeleteLocalPasswords\getUserBatches(), DeleteLocalPasswords\getUserDB(), MigrateLinksTable\handlePageBatch(), FixDefaultJsonContentPages\handleRow(), BackupReader\handleUpload(), UpdateCollation\init(), BackupDumper\initProgress(), PopulateContentTables\initServices(), RemoveUnusedAccounts\isInactiveAccount(), CleanupImages\killRow(), PopulateContentTables\loadContentMap(), NamespaceDupes\mergePage(), MigrateComments\migrate(), MigrateActors\migrate(), MigrateActors\migrateLogSearch(), MigrateActors\migrateToTemp(), MigrateComments\migrateToTemp(), TitleCleanup\moveIllegalPage(), TitleCleanup\moveInconsistentPage(), NamespaceDupes\movePage(), CleanupImages\pokeFile(), RebuildTextIndex\populateSearchIndex(), PurgeChangedFiles\purgeFromLogType(), PurgeList\purgeNamespace(), purgeRedundantText(), RebuildRecentchanges\rebuildRecentChangesTablePass1(), RebuildRecentchanges\rebuildRecentChangesTablePass2(), RebuildRecentchanges\rebuildRecentChangesTablePass3(), RebuildRecentchanges\rebuildRecentChangesTablePass4(), RebuildRecentchanges\rebuildRecentChangesTablePass5(), RefreshLinks\refreshCategory(), CleanupWatchlist\removeWatch(), TableCleanup\runTable(), EraseArchivedFile\scrubAllVersions(), MediaWikiShell\setupLegacy(), PopulateRevisionSha1\upgradeLegacyArchiveRow(), PopulateRevisionSha1\upgradeRow(), and PopulateRevisionLength\upgradeRow().

◆ getDbType()

Maintenance::getDbType ( )

Does the script need different DB access? By default, we give Maintenance scripts normal rights to the DB.

Sometimes, a script needs admin rights access for a reason and sometimes they want no access. Subclasses should override and return one of the following values, as needed: Maintenance::DB_NONE - For no DB access at all Maintenance::DB_STD - For normal DB access, default Maintenance::DB_ADMIN - For admin DB access

Stability: stable: to override

Returns: int

Reimplemented in UpdateSearchIndex, UpdateMediaWiki, MwSql, RunBatchedQuery, RenameDbPrefix, RebuildTextIndex, RebuildLocalisationCache, RebuildAll, PatchSql, MWDocGen, MergeMessageFileList, GenerateNormalizerDataMl, GenerateNormalizerDataAr, CommandLineInstaller, and SearchDump.

Definition at line 551 of file Maintenance.php.

References DB_STD.

Referenced by addDefaultParams(), DumpIterator\finalSetup(), finalSetup(), and shutdown().

◆ getDir()

Maintenance::getDir ( )

protected

Get the maintenance directory.

Returns: string

Definition at line 1380 of file Maintenance.php.

◆ getHookContainer()

Maintenance::getHookContainer ( )

protected

Get a HookContainer, for running extension hooks or for hook metadata.

Since: 1.35

Returns: HookContainer

Definition at line 1644 of file Maintenance.php.

References $hookContainer.

Referenced by getHookRunner().

◆ getHookRunner()

Maintenance::getHookRunner ( )

protected

Get a HookRunner for running core hooks.

Access: internal: This is for use by core only. Hook interfaces may be removed without notice.

Since: 1.35

Returns: HookRunner

Definition at line 1659 of file Maintenance.php.

References $hookRunner, and getHookContainer().

Referenced by CleanupUsersWithNoId\cleanup(), RefreshLinks\doRefreshLinks(), CleanupPreferences\execute(), and UpdateMediaWiki\validateParamsAndArgs().

◆ getName()

Maintenance::getName ( )

Get the script's name.

Returns: string

Definition at line 399 of file Maintenance.php.

References $mSelf.

◆ getOption()

Maintenance::getOption	(	$name,
		$default = `null`
	)

protected

Get an option, or return the default.

If the option was added to support multiple occurrences, this will return an array.

Parameters

string	$name	The name of the param
mixed \| null	$default	Anything you want, default null

Returns: mixed; -taint none

Definition at line 288 of file Maintenance.php.

References hasOption().

Referenced by activateProfiler(), PopulateChangeTagDef\backpopulateChangeTagPerTag(), Benchmarker\bench(), CompareParsers\checkOptions(), SqliteMaintenance\checkSyntax(), CleanupUsersWithNoId\doDBUpdates(), MigrateActors\doDBUpdates(), MigrateLinksTable\doDBUpdates(), MigrateRevisionActorTemp\doDBUpdates(), PopulateBacklinkNamespace\doDBUpdates(), PopulateChangeTagDef\doDBUpdates(), PopulateImageSha1\doDBUpdates(), PopulateIpChanges\doDBUpdates(), FileOpPerfTest\doPerfTest(), UpdateSpecialPages\doSpecialPageCacheUpdates(), AddChangeTag\execute(), AddSite\execute(), BenchmarkCommentFormatter\execute(), BenchmarkEval\execute(), BenchmarkJSMinPlus\execute(), BenchmarkLruHash\execute(), BenchmarkParse\execute(), BenchmarkPurge\execute(), BenchmarkSanitizer\execute(), BenchmarkTidy\execute(), BlockUsers\execute(), CategoryChangesAsRdf\execute(), ChangePassword\execute(), CheckDependencies\execute(), CleanupCaps\execute(), CleanupInvalidDbKeys\execute(), CompareParserCache\execute(), ConvertExtensionToRegistration\execute(), CopyFileBackend\execute(), CopyJobQueue\execute(), CreateAndPromote\execute(), CreateBotPassword\execute(), DeleteAutoPatrolLogs\execute(), DeleteBatch\execute(), DeleteEqualMessages\execute(), DumpCategoriesAsRdf\execute(), DumpIterator\execute(), DumpUploads\execute(), EditCLI\execute(), EraseArchivedFile\execute(), FileOpPerfTest\execute(), FindBadBlobs\execute(), FindMissingActors\execute(), FindMissingFiles\execute(), FindOrphanedFiles\execute(), FixDoubleRedirects\execute(), FixMergeHistoryCorruption\execute(), FormatInstallDoc\execute(), GenerateJsonI18n\execute(), GenerateSitemap\execute(), GetConfiguration\execute(), GetReplicaServer\execute(), GetTextMaint\execute(), GrepPages\execute(), BackupReader\execute(), ImportImages\execute(), ImportSiteScripts\execute(), ImportTextFiles\execute(), SchemaMaintenance\execute(), InitUserPreference\execute(), CommandLineInstaller\execute(), InvalidateUserSessions\execute(), GenerateCollationData\execute(), GenerateNormalizerDataAr\execute(), GenerateUcfirstOverrides\execute(), GenerateUpperCharTable\execute(), MakeTestEdits\execute(), ManageJobs\execute(), McTest\execute(), MergeMessageFileList\execute(), MigrateFileRepoLayout\execute(), MoveBatch\execute(), MysqlMaintenance\execute(), NamespaceDupes\execute(), NukeNS\execute(), PopulateContentTables\execute(), PopulateImageSha1\execute(), PopulateInterwiki\execute(), Protect\execute(), PruneFileCache\execute(), PurgeChangedFiles\execute(), PurgeChangedPages\execute(), PurgeList\execute(), PurgeParserCache\execute(), RebuildFileCache\execute(), RebuildLocalisationCache\execute(), RecountCategories\execute(), RefreshFileHeaders\execute(), RefreshImageMetadata\execute(), RefreshLinks\execute(), RemoveUnusedAccounts\execute(), RenameDbPrefix\execute(), DumpRenderer\execute(), ResetAuthenticationThrottle\execute(), ResetPageRandom\execute(), ResetUserTokens\execute(), RollbackEdits\execute(), RunBatchedQuery\execute(), RunJobs\execute(), ShowJobs\execute(), MwSql\execute(), SqliteMaintenance\execute(), CompressOld\execute(), TableCleanup\execute(), Undelete\execute(), UpdateMediaWiki\execute(), UpdateCollation\execute(), UpdateSearchIndex\execute(), UpdateSpecialPages\execute(), UppercaseTitlesForUnicodeTransition\execute(), WrapOldPasswords\execute(), GetConfiguration\finalSetup(), finalSetup(), RefreshImageMetadata\getConditions(), FindMissingActors\getNewActorId(), FindBadBlobs\getRevisionIds(), DeleteAutoPatrolLogs\getRows(), DeleteAutoPatrolLogs\getRowsOld(), FindBadBlobs\getStartTimestamp(), PopulateContentTables\getTables(), CLIParser\getTitle(), MigrateLinksTable\getUpdateKey(), MigrateLinksTable\handlePageBatch(), BackupReader\importFromHandle(), MWDocGen\init(), UpdateCollation\init(), DeleteLocalPasswords\initialize(), loadSpecialVars(), FindBadBlobs\markBlob(), memoryLimit(), PopulateContentTables\populateTable(), DumpBackup\processOptions(), BackupDumper\processOptions(), TextPassDumper\processOptions(), CompareParsers\processRevision(), SearchDump\processRevision(), DeleteLocalPasswords\processUsers(), UppercaseTitlesForUnicodeTransition\processUsers(), PurgePage\purge(), PurgeChangedFiles\purgeFromLogType(), RebuildRecentchanges\rebuildRecentChangesTablePass1(), CommandLineInstaller\setDbPassOption(), CommandLineInstaller\setPassOption(), MediaWikiShell\setupLegacy(), UserOptionsMaintenance\updateOptions(), GetConfiguration\validateParamsAndArgs(), and validateUserOption().

◆ getStdin()

Maintenance::getStdin ( $len = null )

protected

Return input from stdin.

Parameters

int | null $len The number of bytes to read. If null, just return the handle. Maintenance::STDIN_ALL returns the full content

Returns: mixed

Definition at line 409 of file Maintenance.php.

Referenced by PurgeList\doPurge(), BlockUsers\execute(), DeleteBatch\execute(), DumpIterator\execute(), EditCLI\execute(), FetchText\execute(), MoveBatch\execute(), PurgePage\execute(), and DumpRenderer\execute().

◆ getTermSize()

static Maintenance::getTermSize ( )

static

Get the terminal size as a two-element array where the first element is the width (number of columns) and the second element is the height (number of rows).

Returns: array

Definition at line 1594 of file Maintenance.php.

References wfIsWindows().

◆ globals()

Maintenance::globals ( )

Potentially debug globals.

Originally a feature only for refreshLinks

Definition at line 1243 of file Maintenance.php.

References hasOption().

◆ hasArg()

Maintenance::hasArg ( $argId = 0 )

protected

Does a given argument exist?

Parameters

int $argId The integer value (from zero) for the arg

Returns: bool

Definition at line 340 of file Maintenance.php.

References wfDeprecated().

Referenced by BenchmarkEval\execute(), BlockUsers\execute(), DeleteBatch\execute(), FormatInstallDoc\execute(), BackupReader\execute(), JSParseHelper\execute(), MoveBatch\execute(), ReassignEdits\execute(), MwSql\execute(), UserOptionsMaintenance\execute(), and validateParamsAndArgs().

◆ hasOption()

Maintenance::hasOption ( $name )

protected

Checks to see if a particular option was set.

Parameters

string $name The name of the option

Returns: bool

Definition at line 273 of file Maintenance.php.

Referenced by PopulateChangeTagDef\backpopulateChangeTagPerTag(), Benchmarker\bench(), CompareParsers\checkOptions(), FindBadBlobs\checkRevision(), FindBadBlobs\checkSlot(), CleanupSpam\cleanupArticle(), CleanupInvalidDbKeys\cleanupTable(), CopyFileBackend\copyFileBatch(), CleanupPreferences\deleteByWhere(), MigrateArchiveText\doDBUpdates(), PopulateChangeTagDef\doDBUpdates(), PopulateImageSha1\doDBUpdates(), FileOpPerfTest\doPerfTest(), RebuildLocalisationCache\doRebuild(), UpdateSpecialPages\doSpecialPageCacheUpdates(), AttachLatest\execute(), BenchmarkEval\execute(), BenchmarkParse\execute(), BenchmarkPurge\execute(), BlockUsers\execute(), CheckDependencies\execute(), CleanupCaps\execute(), CleanupInvalidDbKeys\execute(), CleanupPreferences\execute(), CleanupSpam\execute(), CleanupWatchlist\execute(), ConvertExtensionToRegistration\execute(), CopyFileBackend\execute(), CreateAndPromote\execute(), CreateBotPassword\execute(), DeleteArchivedFiles\execute(), DeleteArchivedRevisions\execute(), DeleteAutoPatrolLogs\execute(), DeleteDefaultMessages\execute(), DeleteEqualMessages\execute(), DeleteOldRevisions\execute(), DeleteOrphanedRevisions\execute(), DumpBackup\execute(), DumpIterator\execute(), DumpUploads\execute(), EditCLI\execute(), EraseArchivedFile\execute(), FindBadBlobs\execute(), FindOrphanedFiles\execute(), FixDoubleRedirects\execute(), FixMergeHistoryCorruption\execute(), FormatInstallDoc\execute(), GenerateJsonI18n\execute(), GenerateSitemap\execute(), GetLagTimes\execute(), GetReplicaServer\execute(), GetTextMaint\execute(), GrepPages\execute(), BackupReader\execute(), ImportImages\execute(), ImportTextFiles\execute(), LoggedUpdateMaintenance\execute(), SchemaMaintenance\execute(), InitEditCount\execute(), InitSiteStats\execute(), CommandLineInstaller\execute(), DatabaseLag\execute(), GenerateNormalizerDataAr\execute(), ListVariants\execute(), ManageForeignResources\execute(), MergeMessageFileList\execute(), MoveBatch\execute(), MysqlMaintenance\execute(), NamespaceDupes\execute(), NukeNS\execute(), NukePage\execute(), PopulateImageSha1\execute(), PopulateInterwiki\execute(), Protect\execute(), PurgeChangedFiles\execute(), PurgeChangedPages\execute(), PurgeList\execute(), PurgeOldText\execute(), PurgeParserCache\execute(), ReassignEdits\execute(), RebuildFileCache\execute(), ImageBuilder\execute(), RebuildLocalisationCache\execute(), RebuildRecentchanges\execute(), RecountCategories\execute(), RefreshFileHeaders\execute(), RefreshImageMetadata\execute(), RefreshLinks\execute(), RemoveInvalidEmails\execute(), RemoveUnusedAccounts\execute(), DumpRenderer\execute(), ResetUserEmail\execute(), RollbackEdits\execute(), RunJobs\execute(), MediaWikiShell\execute(), ShowJobs\execute(), MwSql\execute(), SqliteMaintenance\execute(), TableCleanup\execute(), UpdateMediaWiki\execute(), UpdateArticleCount\execute(), UpdateCollation\execute(), UpdateSearchIndex\execute(), UpdateSpecialPages\execute(), UserOptionsMaintenance\execute(), WrapOldPasswords\execute(), CopyFileBackend\filesAreSame(), GetConfiguration\finalSetup(), finalSetup(), UpdateCollation\getBatchCondition(), CommandLineInstaller\getDbType(), RebuildLocalisationCache\getDbType(), getOption(), globals(), ConvertExtensionToRegistration\handleResourceModules(), BackupReader\importFromHandle(), MWDocGen\init(), UpdateCollation\init(), DeleteLocalPasswords\initialize(), loadSpecialVars(), FindBadBlobs\markBlob(), maybeHelp(), RunJobs\memoryLimit(), PopulateContentTables\populateTable(), DumpBackup\processOptions(), BackupDumper\processOptions(), TextPassDumper\processOptions(), PurgeChangedFiles\purgeFromLogType(), RebuildRecentchanges\rebuildRecentChangesTablePass1(), CleanupWatchlist\removeWatch(), EraseArchivedFile\scrubVersion(), PurgeList\sendPurgeRequest(), PopulateChangeTagDef\setUserDefinedTags(), MwSql\sqlPrintResult(), PopulateChangeTagDef\updateCountTag(), PopulateChangeTagDef\updateCountTagId(), UserOptionsMaintenance\updateOptions(), validateParamsAndArgs(), CommandLineInstaller\validateParamsAndArgs(), validateUserOption(), PurgeChangedFiles\verbose(), and UserOptionsMaintenance\warn().

◆ isQuiet()

Maintenance::isQuiet ( )

Returns: bool

Definition at line 426 of file Maintenance.php.

References $mQuiet.

Referenced by countDown().

◆ loadParamsAndArgs()

Maintenance::loadParamsAndArgs	(	$self = `null`,
		$opts = `null`,
		$args = `null`
	)

Process command line arguments $mOptions becomes an array with keys set to the option names $mArgs becomes a zero-based array containing the non-option arguments.

Parameters

string \| null	$self	The name of the script, if any
array \| null	$opts	An array of options, in form of key=>value
array \| null	$args	An array of command line arguments

Definition at line 926 of file Maintenance.php.

References $args, $self, loadSpecialVars(), and loadWithArgv().

Referenced by setup().

◆ loadSettings()

Maintenance::loadSettings ( )

Generic setup for most installs.

Returns the location of LocalSettings

Returns: string

Definition at line 1294 of file Maintenance.php.

References $wgCommandLineMode, fatalError(), and wfDetectLocalSettingsFile().

◆ loadSpecialVars()

Maintenance::loadSpecialVars ( )

protected

Handle the special variables that are global to all scripts @stable to override.

Definition at line 992 of file Maintenance.php.

References getOption(), and hasOption().

Referenced by loadParamsAndArgs(), and loadWithArgv().

◆ loadWithArgv()

Maintenance::loadWithArgv ( $argv )

Load params and arguments from a given array of command-line arguments.

Since: 1.27

Parameters

array $argv

Definition at line 820 of file Maintenance.php.

References $args, error(), loadSpecialVars(), maybeHelp(), and setParam().

Referenced by DumpBackup\__construct(), BackupDumper\__construct(), TextPassDumper\__construct(), and loadParamsAndArgs().

◆ maybeHelp()

Maintenance::maybeHelp ( $force = false )

protected

Maybe show the help.

If the help is shown, exit.

Parameters

bool $force Whether to force the help to show, default false

Reimplemented in CommandLineInc.

Definition at line 1012 of file Maintenance.php.

References hasOption(), and showHelp().

Referenced by CreateAndPromote\execute(), GenerateJsonI18n\execute(), JSParseHelper\execute(), PurgeChangedFiles\execute(), PurgeChangedPages\execute(), UserOptionsMaintenance\execute(), BackupReader\importFromStdin(), loadWithArgv(), setParam(), GetConfiguration\validateParamsAndArgs(), and validateParamsAndArgs().

◆ memoryLimit()

Maintenance::memoryLimit ( )

Normally we disable the memory_limit when running admin scripts.

Some scripts may wish to actually set a limit, however, to avoid blowing up unexpectedly. We also support a –memory-limit option, to allow sysadmins to explicitly set one if they'd prefer to override defaults (or for people using Suhosin which yells at you for trying to disable the limits)

Stability: stable: to override

Returns: string

Reimplemented in RunJobs.

Definition at line 757 of file Maintenance.php.

References getOption().

Referenced by adjustMemoryLimit().

◆ output()

Maintenance::output	(	$out,
		$channel = `null`
	)

protected

Throw some output to the user.

Scripts can call this with no fears, as we handle all –quiet stuff here

Stability: stable: to override

Parameters

string	$out	The text to show to the user
mixed \| null	$channel	Unique identifier for the channel. See function outputChanneled.

Definition at line 437 of file Maintenance.php.

References cleanupChanneled(), MediaWiki\emitBufferedStatsdData(), getConfig(), and outputChanneled().

Referenced by DumpBackup\__construct(), TextPassDumper\__construct(), ImageBuilder\addMissingImage(), Benchmarker\addResult(), PopulateChangeTagDef\backpopulateChangeTagPerTag(), SqliteMaintenance\backup(), McTest\benchmarkMultiKeyOpsDeferredBlocking(), McTest\benchmarkMultiKeyOpsImmediateBlocking(), McTest\benchmarkSingleKeyOps(), ImageBuilder\buildTable(), NamespaceDupes\checkAll(), FindOrphanedFiles\checkFiles(), NamespaceDupes\checkLinkTable(), NamespaceDupes\checkNamespace(), NamespaceDupes\checkPrefix(), FindBadBlobs\checkRevision(), FindBadBlobs\checkSlot(), SqliteMaintenance\checkSyntax(), CleanupUsersWithNoId\cleanup(), CleanupSpam\cleanupArticle(), ResetAuthenticationThrottle\clearLoginThrottle(), RebuildTextIndex\clearSearchIndex(), ResetAuthenticationThrottle\clearSignupThrottle(), CompressOld\compressOldPages(), CompressOld\compressWithConcat(), CompareParsers\conclusions(), CopyFileBackend\copyFileBatch(), countDown(), RebuildTextIndex\createMysqlTextIndex(), RunJobs\debugInternal(), ManageJobs\delete(), CleanupPreferences\deleteByWhere(), RefreshLinks\deleteLinksFromNonexistent(), CopyFileBackend\delFileBatch(), RefreshLinks\dfnCheckInterval(), CleanupRevActorPage\doDBUpdates(), DeduplicateArchiveRevId\doDBUpdates(), FixExtLinksProtocolRelative\doDBUpdates(), MigrateActors\doDBUpdates(), MigrateArchiveText\doDBUpdates(), MigrateImageCommentTemp\doDBUpdates(), MigrateLinksTable\doDBUpdates(), MigrateRevisionActorTemp\doDBUpdates(), PopulateArchiveRevId\doDBUpdates(), PopulateBacklinkNamespace\doDBUpdates(), PopulateExternallinksIndex60\doDBUpdates(), PopulateFilearchiveSha1\doDBUpdates(), PopulateImageSha1\doDBUpdates(), PopulateIpChanges\doDBUpdates(), PopulatePPSortKey\doDBUpdates(), PopulateRecentChangesSource\doDBUpdates(), PopulateRevisionLength\doDBUpdates(), PopulateRevisionSha1\doDBUpdates(), RefreshExternallinksIndex\doDBUpdates(), DeleteOldRevisions\doDelete(), PopulateRevisionLength\doLenUpdates(), UppercaseTitlesForUnicodeTransition\doMove(), FileOpPerfTest\doPerfTest(), PopulateInterwiki\doPopulate(), PurgeList\doPurge(), ReassignEdits\doReassignEdits(), RebuildLocalisationCache\doRebuild(), RefreshLinks\doRefreshLinks(), PopulateRevisionSha1\doSha1LegacyUpdates(), PopulateRevisionSha1\doSha1Updates(), UpdateSpecialPages\doSpecialPageCacheUpdates(), UppercaseTitlesForUnicodeTransition\doUpdate(), UpdateSearchIndex\doUpdateSearchIndex(), RecountCategories\doWork(), RebuildTextIndex\dropMysqlTextIndex(), AddChangeTag\execute(), AddSite\execute(), AttachLatest\execute(), BenchmarkPurge\execute(), BlockUsers\execute(), ChangePassword\execute(), CheckBadRedirects\execute(), CheckComposerLockUpToDate\execute(), CheckDependencies\execute(), CheckImages\execute(), CheckUsernames\execute(), CleanupBlocks\execute(), CleanupCaps\execute(), CleanupPreferences\execute(), CleanupRemovedModules\execute(), CleanupSpam\execute(), CleanupUploadStash\execute(), CleanupWatchlist\execute(), ClearInterwikiCache\execute(), CompareParserCache\execute(), ConvertExtensionToRegistration\execute(), CopyFileBackend\execute(), CopyJobQueue\execute(), CreateAndPromote\execute(), CreateBotPassword\execute(), DeleteArchivedFiles\execute(), DeleteArchivedRevisions\execute(), DeleteAutoPatrolLogs\execute(), DeleteBatch\execute(), DeleteDefaultMessages\execute(), DeleteEqualMessages\execute(), DeleteOldRevisions\execute(), DeleteOrphanedRevisions\execute(), DeleteSelfExternals\execute(), DeleteTag\execute(), DeleteUserEmail\execute(), DumpLinks\execute(), EditCLI\execute(), EmptyUserGroup\execute(), EraseArchivedFile\execute(), ExportSites\execute(), FetchText\execute(), FindBadBlobs\execute(), FindMissingActors\execute(), FindMissingFiles\execute(), FindOrphanedFiles\execute(), FixDoubleRedirects\execute(), FixMergeHistoryCorruption\execute(), FixTimestamps\execute(), FixUserRegistration\execute(), GenerateJsonI18n\execute(), GetConfiguration\execute(), GetLagTimes\execute(), GetReplicaServer\execute(), GetTextMaint\execute(), BackupReader\execute(), ImportImages\execute(), ImportSites\execute(), ImportSiteScripts\execute(), ImportTextFiles\execute(), DeleteLocalPasswords\execute(), LoggedUpdateMaintenance\execute(), InitEditCount\execute(), InitSiteStats\execute(), InitUserPreference\execute(), CommandLineInstaller\execute(), InvalidateBotPasswords\execute(), InvalidateUserSessions\execute(), JSParseHelper\execute(), DatabaseLag\execute(), AllTrans\execute(), DateFormats\execute(), Digit2Html\execute(), DumpMessages\execute(), LangMemUsage\execute(), MakeTestEdits\execute(), ManageForeignResources\execute(), McTest\execute(), GeneratePhpCharToUpperMappings\execute(), MigrateFileRepoLayout\execute(), MigrateUserGroup\execute(), MoveBatch\execute(), MWDocGen\execute(), NamespaceDupes\execute(), NukeNS\execute(), NukePage\execute(), PageExists\execute(), PatchSql\execute(), Protect\execute(), PruneFileCache\execute(), PurgeChangedPages\execute(), PurgeExpiredBlocks\execute(), PurgeExpiredUserrights\execute(), PurgeExpiredWatchlistItems\execute(), PurgeList\execute(), PurgeModuleDeps\execute(), PurgeParserCache\execute(), ReassignEdits\execute(), RebuildAll\execute(), RebuildFileCache\execute(), RebuildLocalisationCache\execute(), RebuildMessages\execute(), RebuildRecentchanges\execute(), RebuildTextIndex\execute(), RecountCategories\execute(), RefreshFileHeaders\execute(), RefreshImageMetadata\execute(), RemoveInvalidEmails\execute(), RemoveUnusedAccounts\execute(), RenameDbPrefix\execute(), ResetPageRandom\execute(), ResetUserEmail\execute(), ResetUserTokens\execute(), RollbackEdits\execute(), RunBatchedQuery\execute(), RunJobs\execute(), ShowJobs\execute(), ShowSiteStats\execute(), CompressOld\execute(), DumpRev\execute(), OrphanStats\execute(), TableCleanup\execute(), TidyUpT39714\execute(), Undelete\execute(), UpdateMediaWiki\execute(), UpdateArticleCount\execute(), UpdateCollation\execute(), UpdateExtensionJsonSchema\execute(), UpdateRestrictions\execute(), UpdateSpecialPages\execute(), ValidateRegistrationFile\execute(), Version\execute(), ViewCLI\execute(), WrapOldPasswords\execute(), DeleteEqualMessages\fetchMessageInfo(), ImportSiteScripts\fetchScriptList(), FindMissingActors\findBadActors(), formatHelpItems(), FindMissingActors\getNewActorId(), DeleteLocalPasswords\getUserBatches(), ConvertExtensionToRegistration\handleExtensionMessagesFiles(), ConvertExtensionToRegistration\handleHooks(), MigrateLinksTable\handlePageBatch(), DumpIterator\handleRevision(), DumpRenderer\handleRevision(), FixDefaultJsonContentPages\handleRow(), MWDocGen\init(), SqliteMaintenance\integrityCheck(), CleanupImages\killRow(), UserOptionsMaintenance\listAvailableOptions(), GenerateSitemap\main(), MigrateComments\migrate(), MigrateActors\migrate(), MigrateActors\migrateLogSearch(), MigrateActors\migrateToTemp(), MigrateComments\migrateToTemp(), TitleCleanup\moveIllegalPage(), TitleCleanup\moveInconsistentPage(), CleanupCaps\movePage(), ImageBuilder\oldimageCallback(), DumpUploads\outputItem(), FindMissingActors\overwriteActorIDs(), CleanupImages\pokeFile(), RebuildTextIndex\populateSearchIndex(), DeduplicateArchiveRevId\processArRevIds(), CompareParsers\processRevision(), SearchDump\processRevision(), CleanupImages\processRow(), TitleCleanup\processRow(), CleanupWatchlist\processRow(), CleanupCaps\processRowToLowercase(), CleanupCaps\processRowToUppercase(), UppercaseTitlesForUnicodeTransition\processTable(), UppercaseTitlesForUnicodeTransition\processUsers(), ImageBuilder\progress(), TableCleanup\progress(), PruneFileCache\prune_directory(), PurgePage\purge(), RebuildRecentchanges\purgeFeeds(), PurgeChangedFiles\purgeFromArchiveTable(), purgeRedundantText(), FixDoubleRedirects\queueJobs(), RebuildRecentchanges\rebuildRecentChangesTablePass1(), RebuildRecentchanges\rebuildRecentChangesTablePass2(), RebuildRecentchanges\rebuildRecentChangesTablePass3(), RebuildRecentchanges\rebuildRecentChangesTablePass4(), RebuildRecentchanges\rebuildRecentChangesTablePass5(), RefreshLinks\refreshCategory(), CleanupWatchlist\removeWatch(), UpdateSpecialPages\reopenAndWaitForReplicas(), ImportSites\reportException(), ManageJobs\repushAbandoned(), MigrateFileRepoLayout\runBatch(), TableCleanup\runTable(), FindBadBlobs\scanRevisionsById(), FindBadBlobs\scanRevisionsByTimestamp(), EraseArchivedFile\scrubVersion(), PurgeList\sendPurgeRequest(), PopulateChangeTagDef\setUserDefinedTags(), CreateBotPassword\showGrants(), showHelp(), PurgeParserCache\showProgressAndWait(), UpdateCollation\showSortKeySizeHistogram(), UserOptionsMaintenance\showUsageStats(), MwSql\sqlPrintResult(), Benchmarker\startBench(), GenerateJsonI18n\transformI18nFile(), PopulateChangeTagDef\updateCountTag(), PopulateChangeTagDef\updateCountTagId(), UserOptionsMaintenance\updateOptions(), UpdateSearchIndex\updateSearchIndexForPage(), ResetUserTokens\updateUser(), PopulateRevisionSha1\upgradeLegacyArchiveRow(), PopulateRevisionSha1\upgradeRow(), PopulateRevisionLength\upgradeRow(), SqliteMaintenance\vacuum(), PurgeChangedFiles\verbose(), Benchmarker\verboseRun(), UserOptionsMaintenance\warn(), and PopulateContentTables\writeln().

◆ outputChanneled()

Maintenance::outputChanneled	(	$msg,
		$channel = `null`
	)

Message outputter with channeled message support.

Messages on the same channel are concatenated, but any intervening messages in another channel start a new line.

Parameters

string \| false	$msg	The message without trailing newline
string \| null	$channel	Channel identifier or null for no channel. Channel comparison uses ===.

Definition at line 517 of file Maintenance.php.

References cleanupChanneled().

Referenced by error(), and output().

◆ parseIntList()

Maintenance::parseIntList ( $text )

protected

Utility function to parse a string (perhaps from a command line option) into a list of integers (perhaps some kind of numeric IDs).

Since: 1.35

Parameters

string $text

Returns: int[]

Definition at line 1676 of file Maintenance.php.

Referenced by FindMissingActors\execute(), and FindBadBlobs\getRevisionIds().

◆ posix_isatty()

static Maintenance::posix_isatty ( $fd )

static

Wrapper for posix_isatty() We default as considering stdin a tty (for nice readline methods) but treating stout as not a tty to avoid color codes.

Parameters

mixed $fd File descriptor

Returns: bool

Definition at line 1512 of file Maintenance.php.

Referenced by FindDeprecated\execute(), MwSql\execute(), and readconsole().

◆ purgeRedundantText()

Maintenance::purgeRedundantText ( $delete = true )

Support function for cleaning up redundant text records.

Parameters

bool $delete Whether or not to actually delete the records

Author: Rob Church robch.nosp@m.ur@g.nosp@m.mail..nosp@m.com

Definition at line 1333 of file Maintenance.php.

References $res, beginTransaction(), commitTransaction(), DB_PRIMARY, getDB(), and output().

Referenced by DeleteOldRevisions\doDelete(), DeleteArchivedRevisions\execute(), DeleteOrphanedRevisions\execute(), NukeNS\execute(), NukePage\execute(), and PurgeOldText\execute().

◆ readconsole()

static Maintenance::readconsole	(		$prompt = `'`,
		'
	)

static

Prompt the console for input.

Parameters

string $prompt What to begin the line with, like '> '

Returns: string|false Response

Definition at line 1525 of file Maintenance.php.

References posix_isatty(), and readlineEmulation().

Referenced by FindMissingActors\execute(), and MwSql\execute().

◆ readlineEmulation()

static Maintenance::readlineEmulation ( $prompt )

staticprivate

Emulate readline()

Parameters

string $prompt What to begin the line with, like '> '

Returns: string|false

Definition at line 1554 of file Maintenance.php.

References $command, ExecutableFinder\findInDefaultPaths(), and wfIsWindows().

Referenced by readconsole().

◆ requireExtension()

Maintenance::requireExtension ( $name )

protected

Indicate that the specified extension must be loaded before the script can run.

This must be called in the constructor.

Since: 1.28

Parameters

string $name

Definition at line 625 of file Maintenance.php.

◆ requireTestsAutoloader()

static Maintenance::requireTestsAutoloader ( )

static

Call this to set up the autoloader to allow classes to be used from the tests directory.

Definition at line 1634 of file Maintenance.php.

◆ rollbackTransaction()

Maintenance::rollbackTransaction	(	IDatabase	$dbw,
			$fname
	)

protected

Rollback the transaction on a DB handle.

This method makes it clear that rollback() is called from a maintenance script, which has outermost scope. This is safe, unlike $dbw->rollback() called in other places.

Parameters

IDatabase	$dbw
string	$fname	Caller name

Since: 1.27

Definition at line 1474 of file Maintenance.php.

References Wikimedia\Rdbms\IDatabase\rollback().

Referenced by CleanupImages\pokeFile(), and PopulateContentTables\populateContentTablesForRowBatch().

◆ runChild()

Maintenance::runChild	(	$maintClass,
		$classFile = `null`
	)

Run a child maintenance script.

Pass all of the current arguments to it.

Parameters

string	$maintClass	A name of a child maintenance class
string \| null	$classFile	Full path of where the child is

Returns: Maintenance

Definition at line 675 of file Maintenance.php.

References $maintClass, and fatalError().

Referenced by NukeNS\execute(), RebuildAll\execute(), RecountCategories\execute(), and UpdateMediaWiki\execute().

◆ setAgentAndTriggers()

Maintenance::setAgentAndTriggers ( )

This method used to be for internal use by doMaintenance.php to apply some optional global state to LBFactory for debugging purposes.

This is now handled lazily by ServiceWiring.

Deprecated:: since 1.37 No longer needed.

Since: 1.28

Definition at line 664 of file Maintenance.php.

References wfDeprecated().

◆ setAllowUnregisteredOptions()

Maintenance::setAllowUnregisteredOptions ( $allow )

protected

Sets whether to allow unregistered options, which are options passed to a script that do not match an expected parameter.

Parameters

bool $allow Should we allow?

Definition at line 323 of file Maintenance.php.

Referenced by CommandLineInc\__construct().

◆ setBatchSize()

Maintenance::setBatchSize ( $s = 0 )

protected

Parameters

int $s The number of operations to do in a batch

Definition at line 377 of file Maintenance.php.

References $s, and addOption().

Referenced by CategoryChangesAsRdf\__construct(), CheckImages\__construct(), CheckUsernames\__construct(), CleanupBlocks\__construct(), CleanupInvalidDbKeys\__construct(), CleanupPreferences\__construct(), CleanupRemovedModules\__construct(), CleanupRevActorPage\__construct(), TitleCleanup\__construct(), CleanupUploadStash\__construct(), CleanupUsersWithNoId\__construct(), CopyFileBackend\__construct(), CopyJobQueue\__construct(), DeduplicateArchiveRevId\__construct(), DeleteAutoPatrolLogs\__construct(), DeleteSelfExternals\__construct(), DeleteTag\__construct(), DumpCategoriesAsRdf\__construct(), EmptyUserGroup\__construct(), FindBadBlobs\__construct(), FindMissingActors\__construct(), FindMissingFiles\__construct(), FindOrphanedFiles\__construct(), FixDefaultJsonContentPages\__construct(), FixUserRegistration\__construct(), DeleteLocalPasswords\__construct(), LoggedUpdateMaintenance\__construct(), MigrateActors\__construct(), InitUserPreference\__construct(), InvalidateUserSessions\__construct(), MakeTestEdits\__construct(), ManageJobs\__construct(), MigrateComments\__construct(), MigrateFileRepoLayout\__construct(), MigrateLinksTable\__construct(), MigrateUserGroup\__construct(), PopulateArchiveRevId\__construct(), PopulateChangeTagDef\__construct(), PopulateContentTables\__construct(), PopulateExternallinksIndex60\__construct(), PopulatePPSortKey\__construct(), PopulateRecentChangesSource\__construct(), PopulateRevisionLength\__construct(), PopulateRevisionSha1\__construct(), PurgeChangedFiles\__construct(), PurgeChangedPages\__construct(), PurgeExpiredWatchlistItems\__construct(), PurgeList\__construct(), PurgeModuleDeps\__construct(), RebuildFileCache\__construct(), RebuildRecentchanges\__construct(), RecountCategories\__construct(), RefreshExternallinksIndex\__construct(), RefreshFileHeaders\__construct(), RefreshImageMetadata\__construct(), RefreshLinks\__construct(), RemoveInvalidEmails\__construct(), ResetPageRandom\__construct(), ResetUserTokens\__construct(), MwSql\__construct(), TableCleanup\__construct(), UpdateCollation\__construct(), UpdateRestrictions\__construct(), UppercaseTitlesForUnicodeTransition\__construct(), UserOptionsMaintenance\__construct(), WrapOldPasswords\__construct(), PopulateChangeTagDef\doDBUpdates(), CopyFileBackend\execute(), and DeleteAutoPatrolLogs\execute().

◆ setConfig()

Maintenance::setConfig ( Config $config )

Since: 1.24

Parameters

Config $config

Definition at line 612 of file Maintenance.php.

References $config.

◆ setDB()

Maintenance::setDB ( IMaintainableDatabase $db )

Sets database object to be returned by getDB().

@stable to override

Parameters

IMaintainableDatabase $db

Reimplemented in BackupDumper.

Definition at line 1415 of file Maintenance.php.

Referenced by DatabaseUpdater\__construct().

◆ setParam()

Maintenance::setParam	(	&	$options,
			$option,
			$value
	)

private

Helper function used solely by loadParamsAndArgs to prevent code duplication.

This sets the param in the options array based on whether or not it can be specified multiple times.

Since: 1.27

Parameters

array	&$options
string	$option
mixed	$value

Definition at line 896 of file Maintenance.php.

References error(), and maybeHelp().

Referenced by loadWithArgv().

◆ setup()

Maintenance::setup ( )

Do some checking and basic setup.

Definition at line 701 of file Maintenance.php.

References $IP, $wgCommandLineMode, adjustMemoryLimit(), fatalError(), and loadParamsAndArgs().

◆ shouldExecute()

static Maintenance::shouldExecute ( )

static

Should we execute the maintenance script, or just allow it to be included as a standalone class? It checks that the call stack only includes this function and "requires" (meaning was called from the file scope)

Returns: bool

Definition at line 194 of file Maintenance.php.

References $wgCommandLineMode.

◆ showHelp()

Maintenance::showHelp ( )

protected

Definitely show the help.

Does not exit.

Definition at line 1023 of file Maintenance.php.

References formatHelpItems(), and output().

Referenced by maybeHelp().

◆ shutdown()

Maintenance::shutdown ( )

Call before exiting CLI process for the last DB commit, and flush any remaining buffers and other deferred work.

Equivalent to MediaWiki::restInPeace which handles shutdown for web requests, and should perform the same operations and in the same order.

Since: 1.36

Definition at line 1258 of file Maintenance.php.

References DeferredUpdates\doUpdates(), MediaWiki\emitBufferedStatsdData(), getConfig(), getDbType(), and Profiler\instance().

◆ supportsOption()

Maintenance::supportsOption ( $name )

protected

Checks to see if a particular option in supported.

Normally this means it has been registered by the script via addOption.

Parameters

string $name The name of the option

Returns: bool true if the option exists, false otherwise

Definition at line 236 of file Maintenance.php.

Referenced by validateParamsAndArgs().

◆ validateParamsAndArgs()

Maintenance::validateParamsAndArgs ( )

Run some validation checks on the params, etc.

Stability: stable: to override

Reimplemented in UpdateMediaWiki, CommandLineInstaller, and GetConfiguration.

Definition at line 959 of file Maintenance.php.

References error(), hasArg(), hasOption(), maybeHelp(), and supportsOption().

◆ validateUserOption()

Maintenance::validateUserOption ( $errorMsg )

protected

Parameters

string $errorMsg Error message to be displayed if the passed –user or –userid does not result in a valid existing user object.

Since: 1.37

Returns: User

Definition at line 1695 of file Maintenance.php.

References fatalError(), getOption(), hasOption(), User\newFromId(), and User\newFromName().

Referenced by ChangePassword\execute(), and InvalidateBotPasswords\execute().

◆ waitForReplication()

Maintenance::waitForReplication ( )

protected

Wait for replica DBs to catch up.

Returns: bool Whether the replica DB wait succeeded

Since: 1.36

Definition at line 1455 of file Maintenance.php.

Referenced by commitTransaction(), FindBadBlobs\scanRevisionsByTimestamp(), and UserOptionsMaintenance\updateOptions().

Member Data Documentation

◆ $atLineStart

Maintenance::$atLineStart = true

private

Definition at line 496 of file Maintenance.php.

◆ $config

Config null Maintenance::$config

private

Accessible via getConfig()

Definition at line 155 of file Maintenance.php.

Referenced by PopulateImageSha1\doDBUpdates(), MediaWikiShell\execute(), UpdateSpecialPages\execute(), finalSetup(), getConfig(), setConfig(), and UpdateExtensionJsonSchema\updateTo2().

◆ $fileHandle

resource null Maintenance::$fileHandle

Used when creating separate schema files.

Definition at line 142 of file Maintenance.php.

◆ $hookContainer

HookContainer null Maintenance::$hookContainer

private

Definition at line 145 of file Maintenance.php.

Referenced by getHookContainer().

◆ $hookRunner

HookRunner null Maintenance::$hookRunner

private

Definition at line 148 of file Maintenance.php.

Referenced by getHookRunner().

◆ $lastChannel

Maintenance::$lastChannel = null

private

Definition at line 497 of file Maintenance.php.

◆ $lastReplicationWait

float Maintenance::$lastReplicationWait = 0.0

private

UNIX timestamp.

Definition at line 136 of file Maintenance.php.

Referenced by UppercaseTitlesForUnicodeTransition\processTable().

◆ $mAllowUnregisteredOptions

bool Maintenance::$mAllowUnregisteredOptions = false

protected

Allow arbitrary options to be passed, or only specified ones?

Definition at line 93 of file Maintenance.php.

◆ $mArgList

array Maintenance::$mArgList = []

protected

Desired/allowed args.

Definition at line 84 of file Maintenance.php.

◆ $mArgs

array Maintenance::$mArgs = []

protected

This is the list of arguments that were actually passed.

Definition at line 90 of file Maintenance.php.

Referenced by CommandLineInc\execute(), and JSParseHelper\execute().

◆ $mBatchSize

int null Maintenance::$mBatchSize = null

protected

Batch size.

If a script supports this, they should set a default with setBatchSize()

Definition at line 114 of file Maintenance.php.

Referenced by CleanupRevActorPage\doDBUpdates(), PopulateExternallinksIndex60\doDBUpdates(), and getBatchSize().

◆ $mDb

IMaintainableDatabase null Maintenance::$mDb = null

private

Used by getDB() / setDB()

Definition at line 133 of file Maintenance.php.

Referenced by getDB().

◆ $mDbPass

Maintenance::$mDbPass

Definition at line 100 of file Maintenance.php.

Referenced by finalSetup().

◆ $mDbUser

Maintenance::$mDbUser

protected

Definition at line 100 of file Maintenance.php.

Referenced by finalSetup().

◆ $mDependentParameters

array [] Maintenance::$mDependentParameters = []

private

Generic options which might or not be supported by the script.

Definition at line 127 of file Maintenance.php.

◆ $mDescription

string Maintenance::$mDescription = ''

protected

A description of the script, children should change this via addDescription()

Definition at line 103 of file Maintenance.php.

◆ $mGenericParameters

array [] Maintenance::$mGenericParameters = []

private

Generic options added by addDefaultParams()

Definition at line 121 of file Maintenance.php.

◆ $mInputLoaded

bool Maintenance::$mInputLoaded = false

protected

Have we already loaded our user input?

Definition at line 106 of file Maintenance.php.

◆ $mOptions

array Maintenance::$mOptions = []

protected

This is the list of options that were actually passed.

Definition at line 87 of file Maintenance.php.

Referenced by CommandLineInc\execute().

◆ $mParams

array [] Maintenance::$mParams = []

protected

Array of desired/allowed params.

Definition at line 78 of file Maintenance.php.

Referenced by addDefaultParams().

◆ $mQuiet

bool Maintenance::$mQuiet = false

protected

Special vars for params that are always used.

Definition at line 99 of file Maintenance.php.

Referenced by isQuiet().

◆ $mSelf

string null Maintenance::$mSelf

protected

Name of the script currently running.

Definition at line 96 of file Maintenance.php.

Referenced by getName().

◆ $mShortParamsMap

array Maintenance::$mShortParamsMap = []

protected

Mapping short parameters to long ones.

Definition at line 81 of file Maintenance.php.

◆ $orderedOptions

array Maintenance::$orderedOptions = []

Used to read the options in the order they were passed.

Useful for option chaining (Ex. dumpBackup.php). It will be an empty array if the options are passed in through loadParamsAndArgs( $self, $opts, $args ).

This is an array of arrays where 0 => the option and 1 => parameter value.

Definition at line 174 of file Maintenance.php.

Referenced by BackupDumper\processOptions().

◆ $requiredExtensions

array Maintenance::$requiredExtensions = []

private

See also: Maintenance::requireExtension

Definition at line 161 of file Maintenance.php.

◆ DB_ADMIN

const Maintenance::DB_ADMIN = 2

Definition at line 68 of file Maintenance.php.

Referenced by PatchSql\getDbType(), RebuildAll\getDbType(), RebuildTextIndex\getDbType(), RenameDbPrefix\getDbType(), RunBatchedQuery\getDbType(), MwSql\getDbType(), UpdateMediaWiki\getDbType(), and UpdateSearchIndex\getDbType().

◆ DB_NONE

const Maintenance::DB_NONE = 0

Constants for DB access type.

See also: Maintenance::getDbType()

Definition at line 66 of file Maintenance.php.

Referenced by DumpIterator\finalSetup(), SearchDump\getDbType(), CommandLineInstaller\getDbType(), GenerateNormalizerDataAr\getDbType(), GenerateNormalizerDataMl\getDbType(), MergeMessageFileList\getDbType(), MWDocGen\getDbType(), and RebuildLocalisationCache\getDbType().

◆ DB_STD

const Maintenance::DB_STD = 1

Definition at line 67 of file Maintenance.php.

Referenced by getDbType().

◆ STDIN_ALL

const Maintenance::STDIN_ALL = -1

Definition at line 71 of file Maintenance.php.

Referenced by EditCLI\execute().

The documentation for this class was generated from the following file:

maintenance/includes/Maintenance.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ activateProfiler()

◆ addArg()

◆ addDefaultParams()

◆ addDescription()

◆ addOption()

◆ adjustMemoryLimit()

◆ afterFinalSetup()

◆ beginTransaction()

◆ checkRequiredExtensions()

◆ cleanupChanneled()

◆ clearParamsAndArgs()

◆ commitTransaction()

◆ countDown()

◆ deleteOption()

◆ error()

◆ execute()

◆ fatalError()

◆ finalSetup()

◆ formatHelpItems()

◆ getArg()

◆ getBatchSize()

◆ getConfig()

◆ getDB()

◆ getDbType()

◆ getDir()

◆ getHookContainer()

◆ getHookRunner()

◆ getName()

◆ getOption()

◆ getStdin()

◆ getTermSize()

◆ globals()

◆ hasArg()

◆ hasOption()

◆ isQuiet()

◆ loadParamsAndArgs()

◆ loadSettings()

◆ loadSpecialVars()

◆ loadWithArgv()

◆ maybeHelp()

◆ memoryLimit()

◆ output()

◆ outputChanneled()

◆ parseIntList()

◆ posix_isatty()

◆ purgeRedundantText()

◆ readconsole()

◆ readlineEmulation()

◆ requireExtension()

◆ requireTestsAutoloader()

◆ rollbackTransaction()

◆ runChild()

◆ setAgentAndTriggers()

◆ setAllowUnregisteredOptions()

◆ setBatchSize()

◆ setConfig()

◆ setDB()

◆ setParam()

◆ setup()

◆ shouldExecute()

◆ showHelp()

◆ shutdown()

◆ supportsOption()

◆ validateParamsAndArgs()

◆ validateUserOption()

◆ waitForReplication()

Member Data Documentation

◆ $atLineStart