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

Inheritance diagram for Maintenance:

[legend]

Collaboration diagram for Maintenance:

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...

	getParameters ()

	globals ()
	Potentially debug globals. More...

	isQuiet ()

	loadParamsAndArgs ( $self=null, $opts=null, $args=null)
	Process command line arguments when running as a child script. More...

	loadSettings ()

	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...

	setArg ( $argId, $value)
	Programmatically set the value of the given argument. More...

	setConfig (Config $config)

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

	setName (string $name)

	setOption (string $name, $value)
	Programmatically set the value of the given option. More...

	setup ()
	Provides subclasses with an opportunity to perform initial checks. 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 @stable to override. 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 ()

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	GENERIC_MAINTENANCE_PARAMETERS = 'Script runner options'

const	SCRIPT_DEPENDENT_PARAMETERS = 'Common options'

const	STDIN_ALL = -1

Protected Member Functions
	addArg ( $arg, $description, $required=true, $multi=false)
	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
array	$mArgList = []
	Empty. 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 = []
	Empty. More...

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

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

MaintenanceParameters	$parameters

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 66 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, WikiBirthday, ViewCLI, Version, ValidateRegistrationFile, UserOptionsMaintenance, UppercaseTitlesForUnicodeTransition, UpdateSpecialPages, UpdateSearchIndex, UpdateRestrictions, UpdateExtensionJsonSchema, UpdateCollation, UpdateArticleCount, UpdateMediaWiki, Undelete, TableCleanup, ResolveStubs, OrphanStats, MoveToExternal, DumpRev, CompressOld, SqliteMaintenance, MwSql, ShowSiteStats, ShowJobs, MediaWikiShell, RunJobs, RunBatchedQuery, RollbackEdits, 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, PruneUnusedLinkTargetRows, PruneFileCache, Protect, PopulateRevisionSha1, PopulateRevisionLength, PopulateRecentChangesSource, PopulatePPSortKey, PopulateIpChanges, PopulateInterwiki, PopulateImageSha1, PopulateFilearchiveSha1, PopulateChangeTagDef, PopulateBacklinkNamespace, PatchSql, CLIParser, PageExists, NukePage, NukeNS, NamespaceDupes, MysqlMaintenance, MWDocGen, MoveBatch, MigrateUserGroup, MigrateRevisionCommentTemp, MigrateRevisionActorTemp, MigrateLinksTable, MigrateFileRepoLayout, MigrateExternallinks, MergeMessageFileList, GeneratePhpCharToUpperMappings, McTest, Mcc, ManageJobs, ManageForeignResources, MakeTestEdits, ListVariants, LangMemUsage, GenerateUpperCharTable, GenerateUcfirstOverrides, GenerateNormalizerDataMl, GenerateNormalizerDataAr, GenerateCollationData, DumpMessages, Digit2Html, DateFormats, AllTrans, DatabaseLag, JSParseHelper, InvalidateUserSessions, InvalidateBotPasswords, CommandLineInstaller, InitUserPreference, InitSiteStats, InitEditCount, SchemaMaintenance, LoggedUpdateMaintenance, DeleteLocalPasswords, Benchmarker, ImportTextFiles, ImportSiteScripts, ImportSites, ImportImages, BackupReader, GrepPages, GetTextMaint, GetReplicaServer, GetLagTimes, GetConfiguration, GenerateSitemap, GenerateSchemaSql, GenerateSchemaChangeSql, GenerateJsonI18n, GenerateConfigSchema, 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, CreateBotPassword, CreateAndPromote, CopyJobQueue, CopyFileBackend, ConvertExtensionToRegistration, CompareParsers, CompareParserCache, CompareLanguageConverterOutput, CommandLineInc, ClearInterwikiCache, CleanupWatchlist, CleanupUsersWithNoId, CleanupUploadStash, TitleCleanup, CleanupSpam, CleanupRemovedModules, CleanupPreferences, CleanupInvalidDbKeys, CleanupImages, CleanupEmptyCategories, CleanupCaps, CleanupBlocks, CheckUsernames, CheckImages, CheckDependencies, CheckComposerLockUpToDate, CheckBadRedirects, ChangePassword, CategoryChangesAsRdf, BlockUsers, BenchmarkTitleValue, BenchmarkTidy, BenchmarkSettings, BenchmarkSanitizer, BenchmarkPurge, BenchmarkParse, BenchmarkLruHash, BenchmarkJsonCodec, BenchmarkJSMinPlus, BenchmarkHooks, BenchmarkEval, BenchmarkCommentFormatter, AttachLatest, AddSite, AddRFCandPMIDInterwiki, and AddChangeTag.

Definition at line 195 of file Maintenance.php.

References addDefaultParams().

Member Function Documentation

◆ addArg()

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

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?
bool	$multi	Does it allow multiple values? (Last arg only)

Definition at line 295 of file Maintenance.php.

Referenced by AddSite\__construct(), BenchmarkEval\__construct(), BenchmarkParse\__construct(), BlockUsers\__construct(), CleanupSpam\__construct(), CompareLanguageConverterOutput\__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(), MoveToExternal\__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 567 of file Maintenance.php.

Referenced by __construct().

◆ addDescription()

Maintenance::addDescription ( $text )

protected

Set the description text.

Parameters

string $text The text of the description

Definition at line 320 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 250 of file Maintenance.php.

Referenced by DumpBackup\__construct(), BackupDumper\__construct(), TextPassDumper\__construct(), AddChangeTag\__construct(), AddSite\__construct(), AttachLatest\__construct(), BenchmarkCommentFormatter\__construct(), BenchmarkEval\__construct(), BenchmarkJSMinPlus\__construct(), BenchmarkJsonCodec\__construct(), BenchmarkLruHash\__construct(), BenchmarkParse\__construct(), BenchmarkSanitizer\__construct(), BenchmarkTidy\__construct(), BlockUsers\__construct(), CategoryChangesAsRdf\__construct(), ChangePassword\__construct(), CheckDependencies\__construct(), CleanupCaps\__construct(), CleanupInvalidDbKeys\__construct(), CleanupPreferences\__construct(), CleanupSpam\__construct(), CleanupUsersWithNoId\__construct(), CleanupWatchlist\__construct(), CommandLineInc\__construct(), CompareParserCache\__construct(), CompareParsers\__construct(), ConvertExtensionToRegistration\__construct(), CopyFileBackend\__construct(), CopyJobQueue\__construct(), CreateAndPromote\__construct(), CreateBotPassword\__construct(), DeleteArchivedFiles\__construct(), DeleteArchivedRevisions\__construct(), DeleteAutoPatrolLogs\__construct(), DeleteBatch\__construct(), DeleteDefaultMessages\__construct(), DeleteEqualMessages\__construct(), DeleteOldRevisions\__construct(), DeleteOrphanedRevisions\__construct(), DumpCategoriesAsRdf\__construct(), DumpIterator\__construct(), SearchDump\__construct(), DumpUploads\__construct(), EditCLI\__construct(), EraseArchivedFile\__construct(), FileOpPerfTest\__construct(), FindBadBlobs\__construct(), FindMissingActors\__construct(), FindMissingFiles\__construct(), FindOrphanedFiles\__construct(), FixDoubleRedirects\__construct(), FixMergeHistoryCorruption\__construct(), FormatInstallDoc\__construct(), GenerateConfigSchema\__construct(), GenerateJsonI18n\__construct(), GenerateSitemap\__construct(), GetConfiguration\__construct(), GetLagTimes\__construct(), GetReplicaServer\__construct(), GetTextMaint\__construct(), GrepPages\__construct(), BackupReader\__construct(), ImportImages\__construct(), ImportSiteScripts\__construct(), ImportTextFiles\__construct(), Benchmarker\__construct(), DeleteLocalPasswords\__construct(), LoggedUpdateMaintenance\__construct(), SchemaMaintenance\__construct(), InitEditCount\__construct(), InitSiteStats\__construct(), InitUserPreference\__construct(), CommandLineInstaller\__construct(), InvalidateBotPasswords\__construct(), InvalidateUserSessions\__construct(), DatabaseLag\__construct(), GenerateCollationData\__construct(), GenerateNormalizerDataAr\__construct(), GenerateUcfirstOverrides\__construct(), GenerateUpperCharTable\__construct(), ListVariants\__construct(), MakeTestEdits\__construct(), ManageForeignResources\__construct(), ManageJobs\__construct(), Mcc\__construct(), McTest\__construct(), MergeMessageFileList\__construct(), MigrateExternallinks\__construct(), MigrateFileRepoLayout\__construct(), MigrateLinksTable\__construct(), MigrateRevisionActorTemp\__construct(), MigrateRevisionCommentTemp\__construct(), MoveBatch\__construct(), MWDocGen\__construct(), MysqlMaintenance\__construct(), NamespaceDupes\__construct(), NukeNS\__construct(), NukePage\__construct(), CLIParser\__construct(), PopulateBacklinkNamespace\__construct(), PopulateChangeTagDef\__construct(), PopulateImageSha1\__construct(), PopulateInterwiki\__construct(), PopulateIpChanges\__construct(), Protect\__construct(), PruneFileCache\__construct(), PruneUnusedLinkTargetRows\__construct(), PurgeChangedFiles\__construct(), PurgeChangedPages\__construct(), PurgeList\__construct(), PurgeOldText\__construct(), PurgePage\__construct(), PurgeParserCache\__construct(), ReassignEdits\__construct(), RebuildFileCache\__construct(), ImageBuilder\__construct(), RebuildLocalisationCache\__construct(), RebuildRecentchanges\__construct(), RecountCategories\__construct(), RefreshFileHeaders\__construct(), RefreshImageMetadata\__construct(), RefreshLinks\__construct(), RemoveInvalidEmails\__construct(), RemoveUnusedAccounts\__construct(), RenameDbPrefix\__construct(), DumpRenderer\__construct(), ResetAuthenticationThrottle\__construct(), ResetPageRandom\__construct(), ResetUserEmail\__construct(), RollbackEdits\__construct(), RunBatchedQuery\__construct(), RunJobs\__construct(), MediaWikiShell\__construct(), ShowJobs\__construct(), MwSql\__construct(), SqliteMaintenance\__construct(), CompressOld\__construct(), MoveToExternal\__construct(), ResolveStubs\__construct(), TableCleanup\__construct(), Undelete\__construct(), UpdateMediaWiki\__construct(), UpdateArticleCount\__construct(), UpdateCollation\__construct(), UpdateSearchIndex\__construct(), UpdateSpecialPages\__construct(), UppercaseTitlesForUnicodeTransition\__construct(), UserOptionsMaintenance\__construct(), WrapOldPasswords\__construct(), BackupDumper\finalSetup(), and UpdateMediaWiki\validateParamsAndArgs().

◆ adjustMemoryLimit()

Maintenance::adjustMemoryLimit ( )

protected

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

Deprecated:: since 1.39, now controlled by MaintenanceRunner

Definition at line 726 of file Maintenance.php.

References wfDeprecated().

◆ 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 975 of file Maintenance.php.

◆ 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 1142 of file Maintenance.php.

References Wikimedia\Rdbms\IDatabase\begin().

Referenced by NukePage\deleteRevisions(), PopulatePPSortKey\doDBUpdates(), PopulateRevisionLength\doLenUpdates(), PopulateRevisionSha1\doSha1Updates(), CleanupRemovedModules\execute(), DeleteArchivedFiles\execute(), DeleteOrphanedRevisions\execute(), MigrateUserGroup\execute(), MoveBatch\execute(), NukeNS\execute(), NukePage\execute(), PurgeModuleDeps\execute(), RebuildFileCache\execute(), UpdateRestrictions\execute(), and WrapOldPasswords\execute().

◆ checkRequiredExtensions()

Maintenance::checkRequiredExtensions ( )

Verify that the required extensions are installed.

Since: 1.28

Definition at line 634 of file Maintenance.php.

References ExtensionRegistry\getInstance().

◆ cleanupChanneled()

Maintenance::cleanupChanneled ( )

Clean up channeled output.

Output a newline if necessary.

Definition at line 511 of file Maintenance.php.

◆ clearParamsAndArgs()

Maintenance::clearParamsAndArgs ( )

Clear all params and arguments.

Definition at line 747 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 1157 of file Maintenance.php.

References Wikimedia\Rdbms\IDatabase\commit().

Referenced by NukePage\deleteRevisions(), PopulatePPSortKey\doDBUpdates(), PopulateRevisionLength\doLenUpdates(), PopulateRevisionSha1\doSha1Updates(), CleanupRemovedModules\execute(), DeleteArchivedFiles\execute(), DeleteOrphanedRevisions\execute(), DeleteSelfExternals\execute(), MigrateUserGroup\execute(), MoveBatch\execute(), NukeNS\execute(), NukePage\execute(), PurgeModuleDeps\execute(), RebuildFileCache\execute(), UpdateRestrictions\execute(), and WrapOldPasswords\execute().

◆ 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 1211 of file Maintenance.php.

Referenced by DeleteAutoPatrolLogs\execute(), and UpdateMediaWiki\execute().

◆ 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 303 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 475 of file Maintenance.php.

References wfDeprecated().

Referenced by FindOrphanedFiles\checkFiles(), CompareParsers\conclusions(), CopyFileBackend\copyFileBatch(), CopyFileBackend\delFileBatch(), FixExtLinksProtocolRelative\doDBUpdates(), MigrateRevisionActorTemp\doDBUpdates(), PopulateRecentChangesSource\doDBUpdates(), RefreshExternallinksIndex\doDBUpdates(), CleanupUploadStash\doOperations(), UpdateSpecialPages\doSpecialPageCacheUpdates(), AddSite\execute(), BenchmarkPurge\execute(), CategoryChangesAsRdf\execute(), CreateAndPromote\execute(), DeleteArchivedFiles\execute(), DumpIterator\execute(), FixDoubleRedirects\execute(), GenerateJsonI18n\execute(), GrepPages\execute(), ImportSiteScripts\execute(), ImportTextFiles\execute(), SchemaMaintenance\execute(), CommandLineInstaller\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(), DumpIterator\handleRevision(), DumpRenderer\handleRevision(), CompareParsers\processRevision(), PurgeChangedFiles\purgeFromArchiveTable(), PurgeChangedFiles\purgeFromLogType(), MwSql\sqlDoQuery(), RefreshFileHeaders\updateFileHeaders(), GetConfiguration\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, WikiBirthday, ViewCLI, Version, ValidateRegistrationFile, UserOptionsMaintenance, UppercaseTitlesForUnicodeTransition, UpdateSpecialPages, UpdateSearchIndex, UpdateRestrictions, UpdateExtensionJsonSchema, UpdateCollation, UpdateArticleCount, UpdateMediaWiki, Undelete, TableCleanup, StorageTypeStats, ResolveStubs, OrphanStats, MoveToExternal, DumpRev, CompressOld, SqliteMaintenance, MwSql, ShowSiteStats, ShowJobs, MediaWikiShell, RunJobs, RunBatchedQuery, RollbackEdits, 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, PruneUnusedLinkTargetRows, PruneFileCache, Protect, PopulateInterwiki, PopulateImageSha1, PatchSql, CLIParser, PageExists, NukePage, NukeNS, NamespaceDupes, MysqlMaintenance, MWDocGen, MoveBatch, MigrateUserGroup, MigrateFileRepoLayout, MergeMessageFileList, GeneratePhpCharToUpperMappings, McTest, Mcc, 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, GenerateConfigSchema, 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, CompareLanguageConverterOutput, 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, BenchmarkJsonCodec, 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 500 of file Maintenance.php.

Referenced by ResetAuthenticationThrottle\clearLoginThrottle(), CopyFileBackend\copyFileBatch(), CopyFileBackend\delFileBatch(), PopulateImageSha1\doDBUpdates(), PopulateIpChanges\doDBUpdates(), PopulateRevisionLength\doDBUpdates(), PopulateRevisionSha1\doDBUpdates(), AddChangeTag\execute(), BenchmarkCommentFormatter\execute(), BenchmarkEval\execute(), BenchmarkJSMinPlus\execute(), BenchmarkParse\execute(), BenchmarkTidy\execute(), BlockUsers\execute(), ChangePassword\execute(), CheckComposerLockUpToDate\execute(), CleanupSpam\execute(), CleanupUploadStash\execute(), CompareLanguageConverterOutput\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(), Mcc\execute(), McTest\execute(), GeneratePhpCharToUpperMappings\execute(), MergeMessageFileList\execute(), MigrateFileRepoLayout\execute(), MigrateUserGroup\execute(), MoveBatch\execute(), MWDocGen\execute(), MysqlMaintenance\execute(), Protect\execute(), PruneFileCache\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(), MoveToExternal\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(), CopyFileBackend\getListingDiffRel(), ConvertExtensionToRegistration\handleExtensionFunctions(), ConvertExtensionToRegistration\handleHooks(), DeleteLocalPasswords\initialize(), TitleCleanup\moveInconsistentPage(), DumpBackup\processOptions(), BackupDumper\processOptions(), MwSql\sqlDoQuery(), and GenerateJsonI18n\transformI18nFile().

◆ 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 882 of file Maintenance.php.

◆ getArg()

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

protected

Get an argument.

Parameters

int \| string	$argId	The index (from zero) of the argument, or the name declared for the argument by addArg().
mixed \| null	$default	The default if it doesn't exist

Returns: mixed; -taint none

Definition at line 342 of file Maintenance.php.

Referenced by AddSite\execute(), BenchmarkEval\execute(), BenchmarkParse\execute(), BlockUsers\execute(), CleanupSpam\execute(), CompareLanguageConverterOutput\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(), MoveToExternal\execute(), Undelete\execute(), UpdateExtensionJsonSchema\execute(), ValidateRegistrationFile\execute(), ViewCLI\execute(), ImportSiteScripts\fetchScriptList(), and CLIParser\Wikitext().

◆ getBatchSize()

Maintenance::getBatchSize ( )

protected

Returns batch size.

Since: 1.31

Returns: int|null

Definition at line 379 of file Maintenance.php.

◆ getConfig()

Maintenance::getConfig ( )

◆ 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 1111 of file Maintenance.php.

◆ 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, GenerateConfigSchema, and SearchDump.

Definition at line 560 of file Maintenance.php.

Referenced by DumpIterator\finalSetup().

◆ getDir()

Maintenance::getDir ( )

protected

Get the maintenance directory.

Returns: string

Definition at line 1093 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 1367 of file Maintenance.php.

◆ 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 1382 of file Maintenance.php.

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

◆ getName()

Maintenance::getName ( )

Get the script's name.

Returns: string

Definition at line 408 of file Maintenance.php.

◆ 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 284 of file Maintenance.php.

◆ getParameters()

Maintenance::getParameters ( )

Since: 1.39

Returns: MaintenanceParameters

Definition at line 207 of file Maintenance.php.

References $parameters.

◆ 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 418 of file Maintenance.php.

Referenced by 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 1317 of file Maintenance.php.

References wfIsWindows().

◆ globals()

Maintenance::globals ( )

Potentially debug globals.

Originally a feature only for refreshLinks

Deprecated:: since 1.39, now controlled by MaintenanceRunner.

Definition at line 983 of file Maintenance.php.

References wfDeprecated().

◆ hasArg()

Maintenance::hasArg ( $argId = 0 )

protected

Does a given argument exist?

Parameters

int | string $argId The index (from zero) of the argument, or the name declared for the argument by addArg().

Returns: bool

Definition at line 330 of file Maintenance.php.

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

◆ 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 269 of file Maintenance.php.

Referenced by Benchmarker\bench(), CompareParsers\checkOptions(), CleanupInvalidDbKeys\cleanupTable(), CopyFileBackend\copyFileBatch(), PopulateChangeTagDef\doDBUpdates(), PopulateImageSha1\doDBUpdates(), FileOpPerfTest\doPerfTest(), 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(), Mcc\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(), CommandLineInstaller\getDbType(), RebuildLocalisationCache\getDbType(), ConvertExtensionToRegistration\handleResourceModules(), MWDocGen\init(), DeleteLocalPasswords\initialize(), RunJobs\memoryLimit(), DumpBackup\processOptions(), BackupDumper\processOptions(), TextPassDumper\processOptions(), PurgeChangedFiles\purgeFromLogType(), EraseArchivedFile\scrubVersion(), MwSql\sqlPrintResult(), CommandLineInstaller\validateParamsAndArgs(), and PurgeChangedFiles\verbose().

◆ isQuiet()

Maintenance::isQuiet ( )

Returns: bool

Definition at line 435 of file Maintenance.php.

◆ loadParamsAndArgs()

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

Process command line arguments when running as a child script.

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 793 of file Maintenance.php.

References $self.

◆ loadSettings()

Maintenance::loadSettings ( )

Deprecated:: since 1.39.

Does nothing. Unused.

Returns: string

Definition at line 1036 of file Maintenance.php.

◆ loadSpecialVars()

Maintenance::loadSpecialVars ( )

protected

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

Definition at line 832 of file Maintenance.php.

◆ loadWithArgv()

Maintenance::loadWithArgv ( $argv )

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

Since: 1.27

Parameters

array $argv The argument array, not including the script itself.

Definition at line 769 of file Maintenance.php.

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

◆ 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 852 of file Maintenance.php.

Referenced by CreateAndPromote\execute(), GenerateJsonI18n\execute(), JSParseHelper\execute(), PurgeChangedFiles\execute(), PurgeChangedPages\execute(), UserOptionsMaintenance\execute(), and GetConfiguration\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.

Stability: stable: to override

Returns: string

Reimplemented in RunJobs.

Definition at line 718 of file Maintenance.php.

◆ 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 446 of file Maintenance.php.

References MediaWiki\emitBufferedStatsdData().

◆ 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 526 of file Maintenance.php.

◆ 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 1399 of file Maintenance.php.

Referenced by FindMissingActors\execute().

◆ 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 1235 of file Maintenance.php.

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

◆ 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 1046 of file Maintenance.php.

References $res, DB_PRIMARY, and getDB().

Referenced by 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 1248 of file Maintenance.php.

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

◆ 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 1357 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 1197 of file Maintenance.php.

References Wikimedia\Rdbms\IDatabase\rollback().

◆ 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

Stability: stable: to override

Returns: Maintenance

Definition at line 676 of file Maintenance.php.

References $maintClass.

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 312 of file Maintenance.php.

Referenced by CommandLineInc\__construct().

◆ setArg()

Maintenance::setArg	(	$argId,
		$value
	)

Programmatically set the value of the given argument.

Useful for setting up child scripts, see runChild().

Since: 1.39

Parameters

string \| int	$argId	Arg index or name
mixed \| null	$value

Definition at line 368 of file Maintenance.php.

◆ setBatchSize()

Maintenance::setBatchSize ( $s = 0 )

protected

Parameters

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

Definition at line 386 of file Maintenance.php.

References $s.

Referenced by CategoryChangesAsRdf\__construct(), CheckImages\__construct(), CheckUsernames\__construct(), CleanupBlocks\__construct(), CleanupInvalidDbKeys\__construct(), CleanupPreferences\__construct(), CleanupRemovedModules\__construct(), TitleCleanup\__construct(), CleanupUploadStash\__construct(), CleanupUsersWithNoId\__construct(), CopyFileBackend\__construct(), CopyJobQueue\__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(), InitUserPreference\__construct(), InvalidateUserSessions\__construct(), MakeTestEdits\__construct(), ManageJobs\__construct(), MigrateExternallinks\__construct(), MigrateFileRepoLayout\__construct(), MigrateLinksTable\__construct(), MigrateUserGroup\__construct(), PopulateChangeTagDef\__construct(), PopulatePPSortKey\__construct(), PopulateRecentChangesSource\__construct(), PopulateRevisionLength\__construct(), PopulateRevisionSha1\__construct(), PruneUnusedLinkTargetRows\__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(), MwSql\__construct(), MoveToExternal\__construct(), ResolveStubs\__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.

◆ 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 1128 of file Maintenance.php.

Referenced by DatabaseUpdater\__construct().

◆ setName()

Maintenance::setName ( string $name )

Since: 1.40

Access: internal

Parameters

string $name

Definition at line 757 of file Maintenance.php.

◆ setOption()

Maintenance::setOption	(	string	$name,
			$value
	)

Programmatically set the value of the given option.

Useful for setting up child scripts, see runChild().

Since: 1.39

Parameters

string	$name
mixed \| null	$value

Definition at line 355 of file Maintenance.php.

◆ setup()

Maintenance::setup ( )

Provides subclasses with an opportunity to perform initial checks.

Stability: stable: to override

Definition at line 707 of file Maintenance.php.

◆ shouldExecute()

static Maintenance::shouldExecute ( )

static

Deprecated:: since 1.39, use MaintenanceRunner::shouldExecute().

Returns: bool

Definition at line 215 of file Maintenance.php.

◆ showHelp()

Maintenance::showHelp ( )

protected

Definitely show the help.

Does not exit.

Reimplemented in Mcc.

Definition at line 869 of file Maintenance.php.

◆ 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 999 of file Maintenance.php.

References DeferredUpdates\doUpdates(), MediaWiki\emitBufferedStatsdData(), 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 235 of file Maintenance.php.

◆ validateParamsAndArgs()

Maintenance::validateParamsAndArgs ( )

Run some validation checks on the params, etc @stable to override.

Reimplemented in UpdateMediaWiki, CommandLineInstaller, and GetConfiguration.

Definition at line 822 of file Maintenance.php.

◆ 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 1418 of file Maintenance.php.

References User\newFromId(), and User\newFromName().

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

◆ waitForReplication()

Maintenance::waitForReplication ( )

protected

Wait for replica DBs to catch up.

Note: Since 1.39, this also calls LBFactory::autoReconfigure().

Returns: bool Whether the replica DB wait succeeded

Since: 1.36

Definition at line 1170 of file Maintenance.php.

Referenced by CleanupUsersWithNoId\cleanup(), CleanupInvalidDbKeys\cleanupTable(), FixExtLinksProtocolRelative\doDBUpdates(), MigrateRevisionActorTemp\doDBUpdates(), MigrateRevisionCommentTemp\doDBUpdates(), PopulateBacklinkNamespace\doDBUpdates(), PopulateFilearchiveSha1\doDBUpdates(), PopulateImageSha1\doDBUpdates(), PopulateIpChanges\doDBUpdates(), PopulateRecentChangesSource\doDBUpdates(), RefreshExternallinksIndex\doDBUpdates(), RecountCategories\doWork(), AttachLatest\execute(), CleanupUploadStash\execute(), DeleteBatch\execute(), DeleteDefaultMessages\execute(), DeleteEqualMessages\execute(), EmptyUserGroup\execute(), FixUserRegistration\execute(), ImportImages\execute(), InitEditCount\execute(), InvalidateUserSessions\execute(), MakeTestEdits\execute(), PruneUnusedLinkTargetRows\execute(), RefreshImageMetadata\execute(), RemoveInvalidEmails\execute(), ResetPageRandom\execute(), RunBatchedQuery\execute(), MwSql\execute(), WrapOldPasswords\execute(), FixDefaultJsonContentPages\handleRow(), and DeleteLocalPasswords\processUsers().

Member Data Documentation

◆ $fileHandle

resource null Maintenance::$fileHandle

Used when creating separate schema files.

Definition at line 154 of file Maintenance.php.

◆ $mArgList

array Maintenance::$mArgList = []

protected

Empty.

Desired/allowed args

Deprecated:: since 1.39, use $this->parameters instead.

Definition at line 100 of file Maintenance.php.

◆ $mArgs

array Maintenance::$mArgs = []

protected

This is the list of arguments that were actually passed.

Deprecated:: since 1.39, use $this->parameters instead.

Definition at line 112 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 139 of file Maintenance.php.

◆ $mDbPass

Maintenance::$mDbPass

Definition at line 119 of file Maintenance.php.

◆ $mDbUser

Maintenance::$mDbUser

protected

Definition at line 119 of file Maintenance.php.

◆ $mDescription

string Maintenance::$mDescription = ''

protected

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

Deprecated:: since 1.39, use $this->parameters instead.

Definition at line 125 of file Maintenance.php.

◆ $mInputLoaded

bool Maintenance::$mInputLoaded = false

protected

Have we already loaded our user input?

Deprecated:: since 1.39, treat as private to the Maintenance base class

Definition at line 131 of file Maintenance.php.

◆ $mOptions

array Maintenance::$mOptions = []

protected

This is the list of options that were actually passed.

Deprecated:: since 1.39, use $this->parameters instead.

Definition at line 106 of file Maintenance.php.

Referenced by CommandLineInc\execute().

◆ $mParams

array [] Maintenance::$mParams = []

protected

Empty.

Deprecated:: since 1.39, use $this->parameters instead.

Definition at line 93 of file Maintenance.php.

◆ $mQuiet

bool Maintenance::$mQuiet = false

protected

Special vars for params that are always used.

Definition at line 118 of file Maintenance.php.

◆ $mSelf

string null Maintenance::$mSelf

protected

Name of the script currently running.

Definition at line 115 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.

Deprecated:: since 1.39, use $this->parameters instead.

Definition at line 187 of file Maintenance.php.

Referenced by BackupDumper\processOptions().

◆ $parameters

MaintenanceParameters Maintenance::$parameters

protected

Definition at line 85 of file Maintenance.php.

Referenced by getParameters().

◆ DB_ADMIN

const Maintenance::DB_ADMIN = 2

Definition at line 73 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 71 of file Maintenance.php.

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

◆ DB_STD

const Maintenance::DB_STD = 1

Definition at line 72 of file Maintenance.php.

◆ GENERIC_MAINTENANCE_PARAMETERS

const Maintenance::GENERIC_MAINTENANCE_PARAMETERS = 'Script runner options'

Definition at line 80 of file Maintenance.php.

Referenced by MediaWiki\Maintenance\MaintenanceRunner\addDefaultParams().

◆ SCRIPT_DEPENDENT_PARAMETERS

const Maintenance::SCRIPT_DEPENDENT_PARAMETERS = 'Common options'

Definition at line 79 of file Maintenance.php.

◆ STDIN_ALL

const Maintenance::STDIN_ALL = -1

Definition at line 76 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

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addArg()

◆ addDefaultParams()

◆ addDescription()

◆ addOption()

◆ adjustMemoryLimit()

◆ afterFinalSetup()

◆ beginTransaction()

◆ checkRequiredExtensions()

◆ cleanupChanneled()

◆ clearParamsAndArgs()

◆ commitTransaction()

◆ countDown()

◆ deleteOption()

◆ error()

◆ execute()

◆ fatalError()

◆ finalSetup()

◆ getArg()

◆ getBatchSize()

◆ getConfig()

◆ getDB()

◆ getDbType()

◆ getDir()

◆ getHookContainer()

◆ getHookRunner()

◆ getName()

◆ getOption()

◆ getParameters()

◆ getStdin()

◆ getTermSize()

◆ globals()

◆ hasArg()

◆ hasOption()

◆ isQuiet()

◆ loadParamsAndArgs()

◆ loadSettings()

◆ loadSpecialVars()

◆ loadWithArgv()

◆ maybeHelp()

◆ memoryLimit()

◆ output()

◆ outputChanneled()

◆ parseIntList()

◆ posix_isatty()

◆ purgeRedundantText()

◆ readconsole()

◆ requireExtension()

◆ requireTestsAutoloader()

◆ rollbackTransaction()

◆ runChild()

◆ setAgentAndTriggers()

◆ setAllowUnregisteredOptions()

◆ setArg()

◆ setBatchSize()

◆ setConfig()

◆ setDB()

◆ setName()

◆ setOption()

◆ setup()

◆ shouldExecute()

◆ showHelp()

◆ shutdown()

◆ supportsOption()

◆ validateParamsAndArgs()

◆ validateUserOption()

◆ waitForReplication()

Member Data Documentation

◆ $fileHandle

◆ $mArgList

◆ $mArgs

◆ $mBatchSize