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

Inherited by AddChangeTag, AddSite, AllTrans, AlterSharedConstraints, AttachLatest, BackupDumper, BackupReader, Benchmarker, BenchmarkParse, CategoryChangesAsRdf, ChangePassword, CheckBadRedirects, CheckComposerLockUpToDate, CheckImages, CheckLess, CheckUsernames, CleanupAncientTables, CleanupBlocks, CleanupInvalidDbKeys, CleanupPreferences, CleanupRemovedModules, CleanupSpam, CleanupUploadStash, ClearInterwikiCache, CLIParser, CommandLineInc, CommandLineInstaller, CompareParserCache, CompressOld, ConvertExtensionToRegistration, ConvertLinks, ConvertUserOptions, CopyFileBackend, CopyJobQueue, CreateAndPromote, CreateCommonPasswordCdb, DatabaseLag, DateFormats, DeleteArchivedFiles, DeleteArchivedRevisions, DeleteAutoPatrolLogs, DeleteBatch, DeleteDefaultMessages, DeleteEqualMessages, DeleteLocalPasswords, DeleteOldRevisions, DeleteOrphanedRevisions, DeleteSelfExternals, Digit2Html, DumpCategoriesAsRdf, DumpIterator, DumpLinks, DumpMessages, DumpRenderer, DumpRev, DumpUploads, EditCLI, EmptyUserGroup, EraseArchivedFile, ExportSites, FakeMaintenance, FetchText, FileOpPerfTest, FindDeprecated, FindHooks, FindMissingFiles, FindOrphanedFiles, FixDoubleRedirects, FixT22757, FixTimestamps, FixUserRegistration, FormatInstallDoc, GenerateCollationData, GenerateJqueryMsgData, GenerateJsonI18n, GenerateNormalizerDataAr, GenerateNormalizerDataMl, GeneratePhpCharToUpperMappings, GenerateRandomImages, GenerateSitemap, GenerateUcfirstOverrides, GenerateUpperCharTable, GetConfiguration, GetLagTimes, GetReplicaServer, GetTextMaint, HHVMMakeRepo, ImageBuilder, ImportImages, ImportSites, ImportSiteScripts, ImportTextFiles, InitEditCount, InitSiteStats, InitUserPreference, InvalidateUserSesssions, JSParseHelper, LangMemUsage, ListVariants, LoggedUpdateMaintenance, MakeTestEdits, ManageForeignResources, ManageJobs, McTest, MediaWikiShell, MergeMessageFileList, MigrateFileRepoLayout, MigrateUserGroup, MinifyScript, MoveBatch, MWDocGen, MwSql, MysqlMaintenance, NamespaceDupes, NukeNS, NukePage, Orphans, OrphanStats, PageExists, ParserEditTests, ParserFuzzTest, ParserTestsMaintenance, PatchSql, PHPUnitMaintClass, PopulateCategory, PopulateContentModel, PopulateContentTables, PopulateInterwiki, Protect, PruneFileCache, PurgeChangedFiles, PurgeChangedPages, PurgeExpiredUserrights, PurgeList, PurgeModuleDeps, PurgeOldText, PurgePage, PurgeParserCache, ReassignEdits, RebuildAll, RebuildFileCache, RebuildLocalisationCache, RebuildMessages, RebuildRecentchanges, RebuildTextIndex, RecountCategories, RefreshFileHeaders, RefreshImageMetadata, RefreshLinks, RemoveInvalidEmails, RemoveUnusedAccounts, RenameDbPrefix, ResetAuthenticationThrottle, ResetPageRandom, ResetUserEmail, ResetUserTokens, RollbackEdits, RunBatchedQuery, RunJobs, ShowJobs, ShowSiteStats, SqliteMaintenance, StorageTypeStats, SyncFileBackend, TableCleanup, TidyUpT39714, Undelete, UpdateArticleCount, UpdateCollation, UpdateDoubleWidthSearch, UpdateExtensionJsonSchema, UpdateMediaWiki, UpdateRestrictions, UpdateSearchIndex, UpdateSpecialPages, UserOptionsMaintenance, ValidateRegistrationFile, ViewCLI, and WrapOldPasswords.

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 ()
	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 ()
	Set triggers like when to try to run deferred updates. More...

	setConfig (Config $config)

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

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

	updateSearchIndex ( $maxLockTime, $callback, $dbw, $results)
	Perform a search index update with locking. More...

	updateSearchIndexForPage ( $dbw, $pageId)
	Update the searchindex table for a given pageid. 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	setLBFactoryTriggers (LBFactory $LBFactory, Config $config)

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	$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 = 'all'

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 ()
	Execute a callback function at the end of initialisation. More...

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

	commitTransaction (IDatabase $dbw, $fname)
	Commit the transcation 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=[], $wiki=false)
	Returns a database to be used by current maintenance script. More...

	getDir ()
	Get the maintenance directory. 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 exists. More...

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

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

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

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

	rollbackTransaction (IDatabase $dbw, $fname)
	Rollback the transcation 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)
	Set the batch size. More...

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

Protected Attributes
	$mAllowUnregisteredOptions = false

	$mArgList = []

	$mArgs = []

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

	$mDbUser

	$mDescription = ''

	$mInputLoaded = false

	$mOptions = []

	$mParams = []

	$mQuiet = false

	$mSelf

	$mShortParamsMap = []

Private Member Functions
public function	__construct ()

public function	execute ()

	lockSearchindex ( $db)
	Lock the search index. More...

	relockSearchindex ( $db)
	Unlock and lock again Since the lock is low-priority, queued reads will be able to complete. More...

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

	unlockSearchindex ( $db)
	Unlock the tables. More...

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

Private Attributes
	$atLineStart = true

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

	$lastChannel = null

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

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

	$mDependantParameters = []

	$mGenericParameters = []

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

Since: 1.16

Definition at line 39 of file maintenance.txt.

Constructor & Destructor Documentation

◆ __construct()

Maintenance::__construct ( )

Default constructor.

Children should call this first if implementing their own constructors

Definition at line 180 of file Maintenance.php.

References $IP, and addDefaultParams().

Member Function Documentation

◆ __construct()

public function Maintenance::__construct ( )

inlineprivate

Definition at line 41 of file maintenance.txt.

◆ activateProfiler()

Maintenance::activateProfiler ( )

protected

Activate the profiler (assuming $wgProfiler is set)

Definition at line 817 of file Maintenance.php.

References $output, $wgProfileLimit, $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 304 of file Maintenance.php.

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

◆ addDefaultParams()

Maintenance::addDefaultParams ( )

protected

Add the default parameters to the scripts.

Definition at line 555 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 333 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 252 of file Maintenance.php.

References $name.

Referenced by BenchmarkTidy\__construct(), HHVMMakeRepo\__construct(), ParserFuzzTest\__construct(), InitUserPreference\__construct(), AddSite\__construct(), RemoveInvalidEmails\__construct(), ParserEditTests\__construct(), FindMissingFiles\__construct(), FindOrphanedFiles\__construct(), Undelete\__construct(), DeleteAutoPatrolLogs\__construct(), BenchmarkSanitizer\__construct(), InitEditCount\__construct(), GenerateUpperCharTable\__construct(), CompareParserCache\__construct(), PopulateChangeTagDef\__construct(), BenchmarkCSSMin\__construct(), MakeTestEdits\__construct(), ManageForeignResources\__construct(), BenchmarkLruHash\__construct(), SqliteMaintenance\__construct(), DumpBackup\__construct(), ManageJobs\__construct(), PopulateBacklinkNamespace\__construct(), Protect\__construct(), PurgeList\__construct(), PurgePage\__construct(), ResetPageRandom\__construct(), ResetUserEmail\__construct(), SyncFileBackend\__construct(), DeleteOldRevisions\__construct(), DeleteEqualMessages\__construct(), BenchmarkJSMinPlus\__construct(), ListVariants\__construct(), CleanupSpam\__construct(), DumpUploads\__construct(), MigrateArchiveText\__construct(), FileOpPerfTest\__construct(), BenchmarkJavaScriptMinifier\__construct(), PurgeOldText\__construct(), RollbackEdits\__construct(), DeleteDefaultMessages\__construct(), InitSiteStats\__construct(), DatabaseLag\__construct(), UserOptionsMaintenance\__construct(), McTest\__construct(), MigrateFileRepoLayout\__construct(), MinifyScript\__construct(), EditCLI\__construct(), NukePage\__construct(), FormatInstallDoc\__construct(), PopulateImageSha1\__construct(), GetLagTimes\__construct(), CleanupAncientTables\__construct(), GetTextMaint\__construct(), GetReplicaServer\__construct(), RefreshFileHeaders\__construct(), DeleteArchivedFiles\__construct(), RemoveUnusedAccounts\__construct(), RenameDbPrefix\__construct(), BenchWikimediaBaseConvert\__construct(), DeleteArchivedRevisions\__construct(), CleanupPreferences\__construct(), UpdateSpecialPages\__construct(), ImportTextFiles\__construct(), AddChangeTag\__construct(), EraseArchivedFile\__construct(), MysqlMaintenance\__construct(), UpdateDoubleWidthSearch\__construct(), PruneFileCache\__construct(), CopyJobQueue\__construct(), ImportSiteScripts\__construct(), ChangePassword\__construct(), ResetUserTokens\__construct(), RunBatchedQuery\__construct(), UpdateArticleCount\__construct(), ParserTestsMaintenance\__construct(), WrapOldPasswords\__construct(), FixDoubleRedirects\__construct(), GenerateJsonI18n\__construct(), RebuildFileCache\__construct(), CreateAndPromote\__construct(), InvalidateUserSesssions\__construct(), FixT22757\__construct(), ReassignEdits\__construct(), DeleteOrphanedRevisions\__construct(), MwSql\__construct(), AttachLatest\__construct(), UpdateMediaWiki\__construct(), ResetAuthenticationThrottle\__construct(), PopulateContentModel\__construct(), PopulateInterwiki\__construct(), MigrateActors\__construct(), CommandLineInstaller\__construct(), PurgeParserCache\__construct(), GenerateUcfirstOverrides\__construct(), CreateCommonPasswordCdb\__construct(), PurgeChangedPages\__construct(), CleanupUsersWithNoId\__construct(), MergeMessageFileList\__construct(), RecountCategories\__construct(), PopulateIpChanges\__construct(), ImportImages\__construct(), RunJobs\__construct(), UpdateSearchIndex\__construct(), RebuildLocalisationCache\__construct(), RefreshLinks\__construct(), DeleteBatch\__construct(), CommandLineInc\__construct(), DumpIterator\__construct(), CopyFileBackend\__construct(), GenerateNormalizerDataAr\__construct(), DumpCategoriesAsRdf\__construct(), RebuildRecentchanges\__construct(), Orphans\__construct(), CompareParsers\__construct(), DumpRenderer\__construct(), Benchmarker\__construct(), ShowJobs\__construct(), UpdateCollation\__construct(), NukeNS\__construct(), TableCleanup\__construct(), BackupReader\__construct(), MoveBatch\__construct(), RefreshImageMetadata\__construct(), CleanupCaps\__construct(), CleanupWatchlist\__construct(), MediaWikiShell\__construct(), BenchmarkParse\__construct(), MWDocGen\__construct(), PreprocessDump\__construct(), GetConfiguration\__construct(), ImageBuilder\__construct(), DeleteLocalPasswords\__construct(), PopulateContentTables\__construct(), CleanupInvalidDbKeys\__construct(), NamespaceDupes\__construct(), CompressOld\__construct(), FindHooks\__construct(), GenerateCollationData\__construct(), ConvertExtensionToRegistration\__construct(), PurgeChangedFiles\__construct(), CLIParser\__construct(), BackupDumper\__construct(), CategoryChangesAsRdf\__construct(), TextPassDumper\__construct(), GenerateSitemap\__construct(), SearchDump\__construct(), LoggedUpdateMaintenance\__construct(), addDefaultParams(), setBatchSize(), and UpdateMediaWiki\validateParamsAndArgs().

◆ adjustMemoryLimit()

Maintenance::adjustMemoryLimit ( )

protected

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

Definition at line 804 of file Maintenance.php.

References memoryLimit().

Referenced by finalSetup(), and setup().

◆ afterFinalSetup()

Maintenance::afterFinalSetup ( )

protected

Execute a callback function at the end of initialisation.

Definition at line 1235 of file Maintenance.php.

Referenced by finalSetup().

◆ beginTransaction()

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

protected

Begin a transcation 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 1403 of file Maintenance.php.

References $fname, and Wikimedia\Rdbms\IDatabase\begin().

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

◆ checkRequiredExtensions()

Maintenance::checkRequiredExtensions ( )

Verify that the required extensions are installed.

Since: 1.28

Definition at line 632 of file Maintenance.php.

References $name, as, fatalError(), and ExtensionRegistry\getInstance().

◆ cleanupChanneled()

Maintenance::cleanupChanneled ( )

Clean up channeled output.

Output a newline if necessary.

Definition at line 500 of file Maintenance.php.

References print.

Referenced by output(), and outputChanneled().

◆ clearParamsAndArgs()

Maintenance::clearParamsAndArgs ( )

Clear all params and arguments.

Definition at line 845 of file Maintenance.php.

◆ commitTransaction()

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

protected

Commit the transcation 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 1418 of file Maintenance.php.

References $fname, and Wikimedia\Rdbms\IDatabase\commit().

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

◆ 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

Parameters

int $seconds

Definition at line 1549 of file Maintenance.php.

References isQuiet(), and output().

Referenced by ResetUserTokens\execute(), 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 316 of file Maintenance.php.

References $name.

◆ 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

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(), print, 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(), PopulateRecentChangesSource\doDBUpdates(), PopulateParentId\doDBUpdates(), FixExtLinksProtocolRelative\doDBUpdates(), RefreshExternallinksIndex\doDBUpdates(), MigrateImageCommentTemp\doDBUpdates(), MigrateActors\doDBUpdates(), PopulateLogSearch\doDBUpdates(), MigrateArchiveText\doDBUpdates(), CleanupUploadStash\doOperations(), UpdateSpecialPages\doSpecialPageCacheUpdates(), BenchmarkPurge\execute(), DeleteSelfExternals\execute(), CleanupAncientTables\execute(), DeleteArchivedFiles\execute(), MigrateFileRepoLayout\execute(), ImportSiteScripts\execute(), FixDoubleRedirects\execute(), PatchSql\execute(), ReassignEdits\execute(), Digit2Html\execute(), GenerateJsonI18n\execute(), RollbackEdits\execute(), DumpIterator\execute(), MinifyScript\execute(), MysqlMaintenance\execute(), ImportTextFiles\execute(), PurgeChangedPages\execute(), GenerateNormalizerDataAr\execute(), CreateCommonPasswordCdb\execute(), DumpRenderer\execute(), SqliteMaintenance\execute(), MergeMessageFileList\execute(), MoveBatch\execute(), CreateAndPromote\execute(), PopulateInterwiki\execute(), UpdateSearchIndex\execute(), BenchmarkParse\execute(), ConvertLinks\execute(), PurgeChangedFiles\execute(), UpdateMediaWiki\execute(), CompressOld\execute(), CategoryChangesAsRdf\execute(), fatalError(), DumpRenderer\handleRevision(), DumpIterator\handleRevision(), SqliteMaintenance\integrityCheck(), loadWithArgv(), MigrateActors\migrate(), MigrateActors\migrateLogSearch(), MigrateActors\migrateToTemp(), MinifyScript\minify(), CleanupImages\pokeFile(), PopulateContentModel\populateRevisionOrArchive(), PreprocessDump\processRevision(), CompareParsers\processRevision(), PurgePage\purge(), PurgeChangedFiles\purgeFromArchiveTable(), PurgeChangedFiles\purgeFromLogType(), MergeMessageFileList\readFile(), RefreshLinks\refreshTrackingCategory(), UpdateSpecialPages\reopenAndWaitForReplicas(), runChild(), MysqlMaintenance\runMysql(), CommandLineInstaller\setDbPassOption(), setParam(), CommandLineInstaller\setPassOption(), MwSql\sqlDoQuery(), SyncFileBackend\syncBackends(), SyncFileBackend\syncFileBatch(), RefreshFileHeaders\updateFileHeaders(), GetConfiguration\validateParamsAndArgs(), validateParamsAndArgs(), and CLIParser\Wikitext().

◆ execute() [1/2]

public function Maintenance::execute ( )

inlineprivate

Definition at line 45 of file maintenance.txt.

Referenced by shouldExecute().

◆ execute() [2/2]

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.

◆ fatalError()

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

protected

Output a message and terminate the current script.

Parameters

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

Since: 1.31

Definition at line 489 of file Maintenance.php.

References error().

Referenced by CompareParsers\checkOptions(), checkRequiredExtensions(), ResetAuthenticationThrottle\clearLoginThrottle(), UpdateMediaWiki\compatChecks(), CopyFileBackend\copyFileBatch(), CopyFileBackend\delFileBatch(), PopulateRevisionSha1\doDBUpdates(), PopulateRevisionLength\doDBUpdates(), PopulateIpChanges\doDBUpdates(), PopulateImageSha1\doDBUpdates(), error(), UpdateExtensionJsonSchema\execute(), ValidateRegistrationFile\execute(), BenchmarkTidy\execute(), CheckComposerLockUpToDate\execute(), ExportSites\execute(), HHVMMakeRepo\execute(), FindOrphanedFiles\execute(), Undelete\execute(), ViewCLI\execute(), BenchmarkJavaScriptMinifier\execute(), BenchmarkJSMinPlus\execute(), ManageJobs\execute(), MigrateUserGroup\execute(), MakeTestEdits\execute(), FormatInstallDoc\execute(), GetTextMaint\execute(), RemoveUnusedAccounts\execute(), DeleteDefaultMessages\execute(), DumpRev\execute(), LangMemUsage\execute(), PruneFileCache\execute(), UpdateRestrictions\execute(), MigrateFileRepoLayout\execute(), Protect\execute(), AddChangeTag\execute(), ResetUserEmail\execute(), ChangePassword\execute(), EraseArchivedFile\execute(), McTest\execute(), CleanupSpam\execute(), FixDoubleRedirects\execute(), UpdateSpecialPages\execute(), CopyJobQueue\execute(), CleanupUploadStash\execute(), RenameDbPrefix\execute(), FixTimestamps\execute(), WrapOldPasswords\execute(), PopulateContentModel\execute(), InvalidateUserSesssions\execute(), GenerateJsonI18n\execute(), SyncFileBackend\execute(), OrphanStats\execute(), MinifyScript\execute(), RollbackEdits\execute(), DumpIterator\execute(), DeleteBatch\execute(), EditCLI\execute(), UpdateDoubleWidthSearch\execute(), ResetAuthenticationThrottle\execute(), ImportTextFiles\execute(), GenerateNormalizerDataAr\execute(), CreateCommonPasswordCdb\execute(), PurgeParserCache\execute(), MwSql\execute(), MergeMessageFileList\execute(), RebuildTextIndex\execute(), MoveBatch\execute(), RefreshLinks\execute(), CopyFileBackend\execute(), CreateAndPromote\execute(), MediaWikiShell\execute(), RebuildLocalisationCache\execute(), RebuildRecentchanges\execute(), RunJobs\execute(), RebuildFileCache\execute(), GenerateCollationData\execute(), FindHooks\execute(), BenchmarkParse\execute(), ConvertExtensionToRegistration\execute(), RecountCategories\execute(), DumpBackup\execute(), UpdateMediaWiki\execute(), CompressOld\execute(), BackupReader\execute(), RefreshImageMetadata\execute(), DeleteEqualMessages\execute(), MWDocGen\execute(), ImportImages\execute(), GenerateSitemap\execute(), GenerateCollationData\generateFirstChars(), MinifyScript\getExtension(), CopyFileBackend\getListingDiffRel(), BackupReader\getNsIndex(), RefreshLinks\getPossibleCategories(), PopulateContentTables\getTables(), ConvertExtensionToRegistration\handleExtensionFunctions(), ConvertExtensionToRegistration\handleHooks(), BackupReader\importFromHandle(), ReassignEdits\initialiseUser(), DeleteLocalPasswords\initialize(), GenerateUcfirstOverrides\loadJson(), loadSettings(), MinifyScript\minify(), TitleCleanup\moveInconsistentPage(), PopulateContentTables\populateContentTablesForRowBatch(), DumpBackup\processOptions(), BackupDumper\processOptions(), CommandLineInstaller\setDbPassOption(), CommandLineInstaller\setPassOption(), setup(), RefreshImageMetadata\setupParameters(), UserOptionsMaintenance\showUsageStats(), MwSql\sqlDoQuery(), SyncFileBackend\syncBackends(), GenerateJsonI18n\transformI18nFile(), and SqliteMaintenance\vacuum().

◆ finalSetup()

Maintenance::finalSetup ( )

Handle some last-minute setup here.

Definition at line 1162 of file Maintenance.php.

References $mDbPass, $mDbUser, $wgCommandLineMode, $wgDBadminpassword, $wgDBadminuser, $wgDBDefaultGroup, $wgDBpassword, $wgDBservers, $wgDBuser, $wgLBFactoryConf, $wgServer, $wgShowExceptionDetails, $wgShowHostnames, activateProfiler(), adjustMemoryLimit(), afterFinalSetup(), as, getDbType(), getOption(), hasOption(), and null.

◆ 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

Definition at line 356 of file Maintenance.php.

References hasArg(), and wfDeprecated().

Referenced by UpdateExtensionJsonSchema\execute(), ValidateRegistrationFile\execute(), ImportSites\execute(), ExportSites\execute(), PageExists\execute(), Undelete\execute(), EmptyUserGroup\execute(), ViewCLI\execute(), AddSite\execute(), MigrateUserGroup\execute(), DumpRev\execute(), FormatInstallDoc\execute(), NukePage\execute(), GetTextMaint\execute(), ResetUserEmail\execute(), ImportSiteScripts\execute(), McTest\execute(), Protect\execute(), CleanupSpam\execute(), FixTimestamps\execute(), ReassignEdits\execute(), GenerateJsonI18n\execute(), MinifyScript\execute(), EditCLI\execute(), DeleteBatch\execute(), ImportTextFiles\execute(), CreateCommonPasswordCdb\execute(), MwSql\execute(), MoveBatch\execute(), RefreshLinks\execute(), CreateAndPromote\execute(), BenchmarkParse\execute(), ConvertLinks\execute(), ConvertExtensionToRegistration\execute(), BackupReader\execute(), CommandLineInstaller\execute(), ImportImages\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 371 of file Maintenance.php.

References $mBatchSize.

Referenced by PopulateChangeTagDef\backpopulateChangeTagPerTag(), CleanupInvalidDbKeys\cleanupTable(), CopyJobQueue\copyJobs(), DeduplicateArchiveRevId\doDBUpdates(), PopulatePPSortKey\doDBUpdates(), PopulateRecentChangesSource\doDBUpdates(), FixDefaultJsonContentPages\doDBUpdates(), PopulateChangeTagDef\doDBUpdates(), PopulateBacklinkNamespace\doDBUpdates(), PopulateFilearchiveSha1\doDBUpdates(), PopulateParentId\doDBUpdates(), PopulateLogUsertext\doDBUpdates(), PopulateArchiveRevId\doDBUpdates(), MigrateImageCommentTemp\doDBUpdates(), PopulateLogSearch\doDBUpdates(), MigrateArchiveText\doDBUpdates(), PopulateIpChanges\doDBUpdates(), PopulateImageSha1\doDBUpdates(), PopulateRevisionLength\doLenUpdates(), PopulateRevisionSha1\doSha1Updates(), RecountCategories\doWork(), RemoveInvalidEmails\execute(), FindOrphanedFiles\execute(), FindMissingFiles\execute(), InitUserPreference\execute(), CheckImages\execute(), FixUserRegistration\execute(), MakeTestEdits\execute(), CleanupBlocks\execute(), MigrateUserGroup\execute(), UpdateRestrictions\execute(), CheckUsernames\execute(), PurgeModuleDeps\execute(), MigrateFileRepoLayout\execute(), ConvertUserOptions\execute(), CleanupUploadStash\execute(), CleanupRemovedModules\execute(), WrapOldPasswords\execute(), InvalidateUserSesssions\execute(), ResetPageRandom\execute(), PurgeChangedPages\execute(), ResetUserTokens\execute(), RefreshFileHeaders\execute(), RefreshLinks\execute(), CopyFileBackend\execute(), DeleteAutoPatrolLogs\execute(), RebuildFileCache\execute(), RefreshImageMetadata\execute(), DumpCategoriesAsRdf\getCategoryIterator(), DumpCategoriesAsRdf\getCategoryLinksIterator(), DeleteAutoPatrolLogs\getRows(), DeleteAutoPatrolLogs\getRowsOld(), DeleteLocalPasswords\getUserBatches(), PopulateContentTables\loadContentMap(), MigrateComments\migrate(), MigrateComments\migrateToTemp(), PopulateContentModel\populatePage(), PopulateContentModel\populateRevisionOrArchive(), PopulateContentTables\populateTable(), PurgeChangedFiles\purgeFromLogType(), PurgeList\purgeNamespace(), RebuildRecentchanges\rebuildRecentChangesTablePass1(), RebuildRecentchanges\rebuildRecentChangesTablePass2(), RebuildRecentchanges\rebuildRecentChangesTablePass3(), RebuildRecentchanges\rebuildRecentChangesTablePass4(), RebuildRecentchanges\rebuildRecentChangesTablePass5(), RefreshLinks\refreshCategory(), ManageJobs\repushAbandoned(), and SyncFileBackend\syncBackends().

◆ getConfig()

Maintenance::getConfig ( )

Since: 1.24

Returns: Config

Definition at line 598 of file Maintenance.php.

References $config, and null.

Referenced by ResetAuthenticationThrottle\clearLoginThrottle(), ResetAuthenticationThrottle\clearSignupThrottle(), FixDefaultJsonContentPages\doDBUpdates(), AddRFCandPMIDInterwiki\doDBUpdates(), Undelete\execute(), DumpIterator\execute(), DumpRenderer\execute(), RefreshLinks\getPossibleCategories(), BackupReader\importFromHandle(), output(), and setAgentAndTriggers().

◆ getDB()

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

protected

Returns a database to be used by current maintenance script.

It can be set by setDB(). If not set, wfGetDB() will be used. This function has the same parameters as wfGetDB()

Parameters

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

Returns: IMaintainableDatabase

Definition at line 1377 of file Maintenance.php.

References $mDb, null, and wfGetDB().

Referenced by ImageBuilder\buildTable(), Orphans\checkOrphans(), Orphans\checkSeparation(), CleanupUsersWithNoId\cleanup(), CleanupSpam\cleanupArticle(), CleanupInvalidDbKeys\cleanupTable(), CompressOld\compressOldPages(), CompressOld\compressPage(), CompressOld\compressWithConcat(), ConvertLinks\createTempTable(), RefreshLinks\deleteLinksFromNonexistent(), NukePage\deleteRevisions(), RefreshLinks\dfnCheckInterval(), DeduplicateArchiveRevId\doDBUpdates(), PopulatePPSortKey\doDBUpdates(), PopulateRecentChangesSource\doDBUpdates(), FixDefaultJsonContentPages\doDBUpdates(), PopulateRevisionSha1\doDBUpdates(), AddRFCandPMIDInterwiki\doDBUpdates(), PopulateBacklinkNamespace\doDBUpdates(), PopulateFilearchiveSha1\doDBUpdates(), PopulateRevisionLength\doDBUpdates(), PopulateParentId\doDBUpdates(), PopulateExternallinksIndex60\doDBUpdates(), FixExtLinksProtocolRelative\doDBUpdates(), PopulateArchiveRevId\doDBUpdates(), PopulateLogUsertext\doDBUpdates(), RefreshExternallinksIndex\doDBUpdates(), MigrateImageCommentTemp\doDBUpdates(), MigrateActors\doDBUpdates(), PopulateLogSearch\doDBUpdates(), MigrateArchiveText\doDBUpdates(), PopulateIpChanges\doDBUpdates(), PopulateImageSha1\doDBUpdates(), DeleteOldRevisions\doDelete(), PopulateRevisionLength\doLenUpdates(), ReassignEdits\doReassignEdits(), RefreshLinks\doRefreshLinks(), PopulateRevisionSha1\doSha1LegacyUpdates(), PopulateRevisionSha1\doSha1Updates(), UpdateSearchIndex\doUpdateSearchIndex(), RecountCategories\doWork(), TidyUpT39714\execute(), StorageTypeStats\execute(), RemoveInvalidEmails\execute(), CompareParserCache\execute(), CheckBadRedirects\execute(), InitUserPreference\execute(), ClearInterwikiCache\execute(), CheckImages\execute(), DeleteSelfExternals\execute(), FixUserRegistration\execute(), CleanupAncientTables\execute(), MigrateUserGroup\execute(), CleanupBlocks\execute(), GetReplicaServer\execute(), DeleteDefaultMessages\execute(), NukePage\execute(), DeleteArchivedFiles\execute(), RemoveUnusedAccounts\execute(), CheckUsernames\execute(), UpdateRestrictions\execute(), PurgeModuleDeps\execute(), RebuildAll\execute(), BenchmarkDeleteTruncate\execute(), InitEditCount\execute(), InitSiteStats\execute(), DeleteArchivedRevisions\execute(), UpdateArticleCount\execute(), EraseArchivedFile\execute(), CleanupSpam\execute(), AlterSharedConstraints\execute(), UpdateSpecialPages\execute(), DeleteOrphanedRevisions\execute(), FixT22757\execute(), RenameDbPrefix\execute(), FixDoubleRedirects\execute(), ConvertUserOptions\execute(), ShowSiteStats\execute(), WrapOldPasswords\execute(), FixTimestamps\execute(), CleanupRemovedModules\execute(), DumpLinks\execute(), PatchSql\execute(), PopulateContentModel\execute(), AttachLatest\execute(), ResetPageRandom\execute(), RunBatchedQuery\execute(), UpdateDoubleWidthSearch\execute(), PurgeChangedPages\execute(), ResetUserTokens\execute(), RefreshFileHeaders\execute(), NukeNS\execute(), SqliteMaintenance\execute(), RebuildTextIndex\execute(), MoveBatch\execute(), CleanupPreferences\execute(), RebuildFileCache\execute(), ImageBuilder\execute(), ConvertLinks\execute(), PopulateCategory\execute(), UpdateCollation\execute(), NamespaceDupes\execute(), PurgeChangedFiles\execute(), UpdateMediaWiki\execute(), RefreshImageMetadata\execute(), DeleteEqualMessages\execute(), CategoryChangesAsRdf\execute(), DumpCategoriesAsRdf\execute(), GenerateSitemap\execute(), LoggedUpdateMaintenance\execute(), DumpUploads\fetchLocal(), DumpUploads\fetchUsed(), TitleCleanup\fileExists(), RefreshLinks\fixRedirect(), BenchmarkParse\getRevIdForTime(), FixT22757\getRevTextMap(), RollbackEdits\getRollbackTitles(), DeleteLocalPasswords\getUserBatches(), DeleteLocalPasswords\getUserDB(), FixDefaultJsonContentPages\handleRow(), BackupReader\handleUpload(), PopulateContentTables\initServices(), RemoveUnusedAccounts\isInactiveAccount(), CleanupImages\killRow(), PopulateContentTables\loadContentMap(), MigrateComments\migrate(), MigrateActors\migrate(), MigrateActors\migrateLogSearch(), MigrateComments\migrateToTemp(), MigrateActors\migrateToTemp(), TitleCleanup\moveIllegalPage(), TitleCleanup\moveInconsistentPage(), CleanupImages\pokeFile(), PurgeChangedFiles\purgeFromLogType(), PurgeList\purgeNamespace(), purgeRedundantText(), RebuildRecentchanges\rebuildRecentChangesTablePass1(), RebuildRecentchanges\rebuildRecentChangesTablePass2(), RebuildRecentchanges\rebuildRecentChangesTablePass3(), RebuildRecentchanges\rebuildRecentChangesTablePass4(), RefreshLinks\refreshCategory(), CleanupWatchlist\removeWatch(), TableCleanup\runTable(), EraseArchivedFile\scrubAllVersions(), PopulateRevisionSha1\upgradeLegacyArchiveRow(), PopulateRevisionLength\upgradeRow(), and PopulateRevisionSha1\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

Returns: int

Definition at line 548 of file Maintenance.php.

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

◆ getDir()

Maintenance::getDir ( )

protected

Get the maintenance directory.

Returns: string

Definition at line 1363 of file Maintenance.php.

◆ getName()

Maintenance::getName ( )

Get the script's name.

Returns: string

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

Definition at line 287 of file Maintenance.php.

References $name, and hasOption().

Referenced by activateProfiler(), PopulateChangeTagDef\backpopulateChangeTagPerTag(), Benchmarker\bench(), PreprocessDump\checkOptions(), CompareParsers\checkOptions(), SqliteMaintenance\checkSyntax(), PopulateChangeTagDef\doDBUpdates(), PopulateBacklinkNamespace\doDBUpdates(), CleanupUsersWithNoId\doDBUpdates(), MigrateActors\doDBUpdates(), PopulateIpChanges\doDBUpdates(), PopulateImageSha1\doDBUpdates(), FileOpPerfTest\doPerfTest(), PurgeList\doPurge(), UpdateSpecialPages\doSpecialPageCacheUpdates(), BenchmarkTidy\execute(), ParserFuzzTest\execute(), HHVMMakeRepo\execute(), ParserEditTests\execute(), FindMissingFiles\execute(), FindOrphanedFiles\execute(), Undelete\execute(), GenerateUpperCharTable\execute(), CompareParserCache\execute(), BenchmarkPurge\execute(), InitUserPreference\execute(), BenchmarkLruHash\execute(), BenchmarkCSSMin\execute(), BenchmarkSanitizer\execute(), ManageJobs\execute(), BenchmarkJavaScriptMinifier\execute(), BenchmarkJSMinPlus\execute(), MakeTestEdits\execute(), AddSite\execute(), GetReplicaServer\execute(), FormatInstallDoc\execute(), RemoveUnusedAccounts\execute(), PruneFileCache\execute(), AddChangeTag\execute(), DumpUploads\execute(), McTest\execute(), MigrateFileRepoLayout\execute(), EraseArchivedFile\execute(), BenchWikimediaBaseConvert\execute(), Protect\execute(), ImportSiteScripts\execute(), PurgeList\execute(), ChangePassword\execute(), FixT22757\execute(), UpdateSpecialPages\execute(), FileOpPerfTest\execute(), FixDoubleRedirects\execute(), CopyJobQueue\execute(), RenameDbPrefix\execute(), WrapOldPasswords\execute(), PHPUnitMaintClass\execute(), PopulateContentModel\execute(), InvalidateUserSesssions\execute(), GenerateUcfirstOverrides\execute(), GenerateJsonI18n\execute(), SyncFileBackend\execute(), ResetPageRandom\execute(), DumpIterator\execute(), MinifyScript\execute(), RollbackEdits\execute(), RunBatchedQuery\execute(), EditCLI\execute(), DeleteBatch\execute(), UpdateDoubleWidthSearch\execute(), MysqlMaintenance\execute(), PurgeChangedPages\execute(), ImportTextFiles\execute(), ResetAuthenticationThrottle\execute(), GenerateNormalizerDataAr\execute(), CreateCommonPasswordCdb\execute(), RefreshFileHeaders\execute(), ResetUserTokens\execute(), DumpRenderer\execute(), NukeNS\execute(), PurgeParserCache\execute(), MwSql\execute(), MergeMessageFileList\execute(), SqliteMaintenance\execute(), ShowJobs\execute(), MoveBatch\execute(), CopyFileBackend\execute(), PopulateImageSha1\execute(), DeleteAutoPatrolLogs\execute(), RefreshLinks\execute(), CreateAndPromote\execute(), PopulateInterwiki\execute(), RebuildLocalisationCache\execute(), RebuildFileCache\execute(), RunJobs\execute(), UpdateSearchIndex\execute(), GenerateCollationData\execute(), BenchmarkParse\execute(), PopulateCategory\execute(), UpdateCollation\execute(), ConvertExtensionToRegistration\execute(), NamespaceDupes\execute(), PopulateContentTables\execute(), RecountCategories\execute(), PurgeChangedFiles\execute(), CleanupInvalidDbKeys\execute(), ParserTestsMaintenance\execute(), UpdateMediaWiki\execute(), CompressOld\execute(), BackupReader\execute(), RefreshImageMetadata\execute(), DeleteEqualMessages\execute(), CommandLineInstaller\execute(), GetConfiguration\execute(), CategoryChangesAsRdf\execute(), ImportImages\execute(), DumpCategoriesAsRdf\execute(), GenerateSitemap\execute(), GetConfiguration\finalSetup(), finalSetup(), RefreshImageMetadata\getConditions(), DeleteAutoPatrolLogs\getRows(), DeleteAutoPatrolLogs\getRowsOld(), PopulateContentTables\getTables(), CLIParser\getTitle(), BackupReader\importFromHandle(), MWDocGen\init(), DeleteLocalPasswords\initialize(), loadSpecialVars(), memoryLimit(), CLIParser\parse(), PopulateContentTables\populateTable(), DumpBackup\processOptions(), TextPassDumper\processOptions(), BackupDumper\processOptions(), CompareParsers\processRevision(), SearchDump\processRevision(), DeleteLocalPasswords\processUsers(), PurgePage\purge(), PurgeChangedFiles\purgeFromLogType(), RebuildRecentchanges\rebuildRecentChangesTablePass1(), PurgeList\sendPurgeRequest(), CommandLineInstaller\setDbPassOption(), CommandLineInstaller\setPassOption(), MediaWikiShell\setupLegacy(), SyncFileBackend\syncFileBatch(), UserOptionsMaintenance\updateOptions(), and GetConfiguration\validateParamsAndArgs().

◆ 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 length

Returns: mixed

Definition at line 411 of file Maintenance.php.

References $f, and $input.

Referenced by PurgeList\doPurge(), PurgePage\execute(), DumpIterator\execute(), DeleteBatch\execute(), EditCLI\execute(), DumpRenderer\execute(), MoveBatch\execute(), and FetchText\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 1655 of file Maintenance.php.

References wfIsWindows().

Referenced by ParserEditTests\execute().

◆ globals()

Maintenance::globals ( )

Potentially debug globals.

Originally a feature only for refreshLinks

Definition at line 1245 of file Maintenance.php.

References $GLOBALS, and 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 342 of file Maintenance.php.

References wfDeprecated().

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

◆ hasOption()

Maintenance::hasOption ( $name )

protected

Checks to see if a particular option exists.

Parameters

string $name The name of the option

Returns: bool

Definition at line 273 of file Maintenance.php.

References $name.

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

◆ isQuiet()

Maintenance::isQuiet ( )

Returns: bool

Definition at line 428 of file Maintenance.php.

References $mQuiet.

Referenced by countDown(), and SyncFileBackend\execute().

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

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

Referenced by ClearUserWatchlistJobTest\runJobs(), CategoryMembershipChangeJobTest\runJobs(), setup(), ApiDeleteTest\testBatchedDelete(), WikiPageDbTestBase\testDoDeleteArticle(), WikiPageDbTestBase\testDoDeleteUpdates(), TemplateCategoriesTest\testTemplateCategories(), and WatchedItemStoreIntegrationTest\testUpdateResetAndSetNotificationTimestamp().

◆ loadSettings()

Maintenance::loadSettings ( )

Generic setup for most installs.

Returns the location of LocalSettings

Returns: string

Definition at line 1255 of file Maintenance.php.

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

◆ loadSpecialVars()

Maintenance::loadSpecialVars ( )

protected

Handle the special variables that are global to all scripts.

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

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

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

◆ lockSearchindex()

Maintenance::lockSearchindex ( $db )

private

Lock the search index.

Parameters

IMaintainableDatabase &$db

Definition at line 1446 of file Maintenance.php.

Referenced by relockSearchindex(), and updateSearchIndex().

◆ maybeHelp()

Maintenance::maybeHelp ( $force = false )

protected

Maybe show the help.

Parameters

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

Definition at line 1047 of file Maintenance.php.

References $mDependantParameters, $output, as, hasOption(), and output().

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

Returns: string

Definition at line 795 of file Maintenance.php.

References getOption().

Referenced by adjustMemoryLimit(), and ParserFuzzTest\fuzzTest().

◆ 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

Parameters

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

Definition at line 438 of file Maintenance.php.

References $out, class, cleanupChanneled(), MediaWiki\emitBufferedStatsdData(), getConfig(), null, outputChanneled(), and print.

Referenced by DumpBackup\__construct(), TextPassDumper\__construct(), ImageBuilder\addMissingImage(), Benchmarker\addResult(), PopulateChangeTagDef\backpopulateChangeTagPerTag(), SqliteMaintenance\backup(), ImageBuilder\buildTable(), NamespaceDupes\checkAll(), FindOrphanedFiles\checkFiles(), NamespaceDupes\checkLinkTable(), NamespaceDupes\checkNamespace(), Orphans\checkOrphans(), NamespaceDupes\checkPrefix(), Orphans\checkSeparation(), SqliteMaintenance\checkSyntax(), CleanupUsersWithNoId\cleanup(), CleanupSpam\cleanupArticle(), ResetAuthenticationThrottle\clearLoginThrottle(), RebuildTextIndex\clearSearchIndex(), ResetAuthenticationThrottle\clearSignupThrottle(), CompressOld\compressOldPages(), CompressOld\compressWithConcat(), CompareParsers\conclusions(), CopyFileBackend\copyFileBatch(), countDown(), RebuildTextIndex\createMysqlTextIndex(), ConvertLinks\createTempTable(), RunJobs\debugInternal(), ManageJobs\delete(), CleanupPreferences\deleteByWhere(), RefreshLinks\deleteLinksFromNonexistent(), CopyFileBackend\delFileBatch(), RefreshLinks\dfnCheckInterval(), DeduplicateArchiveRevId\doDBUpdates(), PopulatePPSortKey\doDBUpdates(), PopulateRecentChangesSource\doDBUpdates(), FixDefaultJsonContentPages\doDBUpdates(), PopulateRevisionSha1\doDBUpdates(), PopulateBacklinkNamespace\doDBUpdates(), PopulateFilearchiveSha1\doDBUpdates(), PopulateRevisionLength\doDBUpdates(), PopulateParentId\doDBUpdates(), FixExtLinksProtocolRelative\doDBUpdates(), PopulateExternallinksIndex60\doDBUpdates(), PopulateArchiveRevId\doDBUpdates(), PopulateLogUsertext\doDBUpdates(), RefreshExternallinksIndex\doDBUpdates(), MigrateImageCommentTemp\doDBUpdates(), MigrateActors\doDBUpdates(), PopulateLogSearch\doDBUpdates(), MigrateArchiveText\doDBUpdates(), PopulateIpChanges\doDBUpdates(), PopulateImageSha1\doDBUpdates(), DeleteOldRevisions\doDelete(), PopulateRevisionLength\doLenUpdates(), FileOpPerfTest\doPerfTest(), PopulateInterwiki\doPopulate(), PurgeList\doPurge(), ReassignEdits\doReassignEdits(), RebuildLocalisationCache\doRebuild(), RefreshLinks\doRefreshLinks(), PopulateRevisionSha1\doSha1LegacyUpdates(), PopulateRevisionSha1\doSha1Updates(), UpdateSpecialPages\doSpecialPageCacheUpdates(), UpdateSearchIndex\doUpdateSearchIndex(), RecountCategories\doWork(), RebuildTextIndex\dropMysqlTextIndex(), TidyUpT39714\execute(), UpdateExtensionJsonSchema\execute(), ValidateRegistrationFile\execute(), CheckComposerLockUpToDate\execute(), RemoveInvalidEmails\execute(), ExportSites\execute(), ImportSites\execute(), PageExists\execute(), FindMissingFiles\execute(), FindOrphanedFiles\execute(), Undelete\execute(), EmptyUserGroup\execute(), CheckBadRedirects\execute(), CompareParserCache\execute(), PurgeExpiredUserrights\execute(), BenchmarkPurge\execute(), RebuildMessages\execute(), InitUserPreference\execute(), ViewCLI\execute(), ClearInterwikiCache\execute(), CheckImages\execute(), AllTrans\execute(), DeleteSelfExternals\execute(), FixUserRegistration\execute(), DumpMessages\execute(), MakeTestEdits\execute(), MigrateUserGroup\execute(), GetLagTimes\execute(), GetReplicaServer\execute(), CleanupAncientTables\execute(), CleanupBlocks\execute(), DatabaseLag\execute(), DateFormats\execute(), JSParseHelper\execute(), DeleteOldRevisions\execute(), DumpRev\execute(), NukePage\execute(), GetTextMaint\execute(), DeleteArchivedFiles\execute(), RemoveUnusedAccounts\execute(), LangMemUsage\execute(), DeleteDefaultMessages\execute(), GeneratePhpCharToUpperMappings\execute(), UpdateRestrictions\execute(), CheckUsernames\execute(), PruneFileCache\execute(), PurgeModuleDeps\execute(), RebuildAll\execute(), InitSiteStats\execute(), DeleteArchivedRevisions\execute(), InitEditCount\execute(), McTest\execute(), UpdateArticleCount\execute(), AddChangeTag\execute(), EraseArchivedFile\execute(), ChangePassword\execute(), Protect\execute(), PurgeList\execute(), ImportSiteScripts\execute(), ResetUserEmail\execute(), MigrateFileRepoLayout\execute(), DeleteOrphanedRevisions\execute(), UpdateSpecialPages\execute(), AlterSharedConstraints\execute(), CleanupUploadStash\execute(), FixDoubleRedirects\execute(), ConvertUserOptions\execute(), CopyJobQueue\execute(), CleanupSpam\execute(), RenameDbPrefix\execute(), WrapOldPasswords\execute(), FixTimestamps\execute(), CleanupRemovedModules\execute(), ShowSiteStats\execute(), DumpLinks\execute(), PatchSql\execute(), AttachLatest\execute(), ReassignEdits\execute(), InvalidateUserSesssions\execute(), Digit2Html\execute(), SyncFileBackend\execute(), ResetPageRandom\execute(), GenerateJsonI18n\execute(), OrphanStats\execute(), RunBatchedQuery\execute(), RollbackEdits\execute(), DeleteBatch\execute(), EditCLI\execute(), TableCleanup\execute(), UpdateDoubleWidthSearch\execute(), PurgeChangedPages\execute(), ImportTextFiles\execute(), CreateCommonPasswordCdb\execute(), RefreshFileHeaders\execute(), ResetUserTokens\execute(), NukeNS\execute(), PurgeParserCache\execute(), CleanupCaps\execute(), ShowJobs\execute(), CleanupWatchlist\execute(), RebuildTextIndex\execute(), MoveBatch\execute(), DeleteAutoPatrolLogs\execute(), CopyFileBackend\execute(), CreateAndPromote\execute(), CleanupPreferences\execute(), RebuildLocalisationCache\execute(), RebuildFileCache\execute(), RunJobs\execute(), RebuildRecentchanges\execute(), ManageForeignResources\execute(), FetchText\execute(), FindHooks\execute(), ConvertLinks\execute(), PopulateCategory\execute(), UpdateCollation\execute(), ConvertExtensionToRegistration\execute(), NamespaceDupes\execute(), RecountCategories\execute(), UpdateMediaWiki\execute(), CompressOld\execute(), BackupReader\execute(), DeleteLocalPasswords\execute(), RefreshImageMetadata\execute(), DeleteEqualMessages\execute(), GetConfiguration\execute(), MWDocGen\execute(), ImportImages\execute(), LoggedUpdateMaintenance\execute(), DeleteEqualMessages\fetchMessageInfo(), ImportSiteScripts\fetchScriptList(), GetConfiguration\formatVarDump(), DeleteLocalPasswords\getUserBatches(), ConvertExtensionToRegistration\handleExtensionMessagesFiles(), ConvertExtensionToRegistration\handleHooks(), DumpRenderer\handleRevision(), DumpIterator\handleRevision(), FixDefaultJsonContentPages\handleRow(), MWDocGen\init(), SqliteMaintenance\integrityCheck(), CleanupImages\killRow(), UserOptionsMaintenance\listAvailableOptions(), GenerateSitemap\main(), maybeHelp(), MigrateComments\migrate(), MigrateActors\migrate(), MigrateActors\migrateLogSearch(), MigrateComments\migrateToTemp(), MigrateActors\migrateToTemp(), MinifyScript\minify(), TitleCleanup\moveIllegalPage(), TitleCleanup\moveInconsistentPage(), CleanupCaps\movePage(), ImageBuilder\oldimageCallback(), DumpUploads\outputItem(), CleanupImages\pokeFile(), PopulateContentModel\populatePage(), PopulateContentModel\populateRevisionOrArchive(), RebuildTextIndex\populateSearchIndex(), FindHooks\printArray(), DeduplicateArchiveRevId\processArRevIds(), CompareParsers\processRevision(), SearchDump\processRevision(), TitleCleanup\processRow(), CleanupImages\processRow(), CleanupWatchlist\processRow(), CleanupCaps\processRowToLowercase(), CleanupCaps\processRowToUppercase(), TableCleanup\progress(), ImageBuilder\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(), EraseArchivedFile\scrubVersion(), PurgeList\sendPurgeRequest(), PopulateChangeTagDef\setUserDefinedTags(), PurgeParserCache\showProgressAndWait(), UpdateCollation\showSortKeySizeHistogram(), UserOptionsMaintenance\showUsageStats(), MwSql\sqlPrintResult(), Benchmarker\startBench(), SyncFileBackend\syncBackends(), SyncFileBackend\syncFileBatch(), GenerateJsonI18n\transformI18nFile(), PopulateChangeTagDef\updateCountTag(), PopulateChangeTagDef\updateCountTagId(), UserOptionsMaintenance\updateOptions(), PopulateContentModel\updatePageRows(), PopulateContentModel\updateRevisionOrArchiveRows(), updateSearchIndex(), updateSearchIndexForPage(), ResetUserTokens\updateUser(), PopulateRevisionSha1\upgradeLegacyArchiveRow(), PopulateRevisionLength\upgradeRow(), PopulateRevisionSha1\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	$msg	The message without trailing newline
string \| null	$channel	Channel identifier or null for no channel. Channel comparison uses ===.

Definition at line 515 of file Maintenance.php.

References cleanupChanneled(), null, and print.

Referenced by error(), and output().

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

Referenced by MwSql\execute(), and ParserTestsMaintenance\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 1292 of file Maintenance.php.

References $res, $wgMultiContentRevisionSchemaMigrationStage, as, beginTransaction(), commitTransaction(), DB_MASTER, getDB(), null, output(), and SCHEMA_COMPAT_READ_OLD.

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

◆ readconsole()

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

static

Prompt the console for input.

Parameters

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

Returns: string Response

Definition at line 1586 of file Maintenance.php.

References null.

Referenced by MwSql\execute(), and ParserEditTests\handleFailure().

◆ readlineEmulation()

static Maintenance::readlineEmulation ( $prompt )

staticprivate

Emulate readline()

Parameters

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

Returns: string

Definition at line 1618 of file Maintenance.php.

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

◆ relockSearchindex()

Maintenance::relockSearchindex ( $db )

private

Unlock and lock again Since the lock is low-priority, queued reads will be able to complete.

Parameters

IMaintainableDatabase &$db

Definition at line 1473 of file Maintenance.php.

References lockSearchindex(), and unlockSearchindex().

Referenced by updateSearchIndex().

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

References $name.

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

◆ rollbackTransaction()

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

protected

Rollback the transcation 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 1438 of file Maintenance.php.

References $fname, and 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 712 of file Maintenance.php.

References $maintClass, and error().

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

◆ setAgentAndTriggers()

Maintenance::setAgentAndTriggers ( )

Set triggers like when to try to run deferred updates.

Since: 1.28

Definition at line 653 of file Maintenance.php.

References getConfig(), and wfHostname().

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

Referenced by PHPUnitMaintClass\__construct(), and CommandLineInc\__construct().

◆ setBatchSize()

Maintenance::setBatchSize ( $s = 0 )

protected

Set the batch size.

Parameters

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

Definition at line 379 of file Maintenance.php.

References $s, and addOption().

Referenced by InitUserPreference\__construct(), RemoveInvalidEmails\__construct(), DeduplicateArchiveRevId\__construct(), FindMissingFiles\__construct(), FindOrphanedFiles\__construct(), DeleteAutoPatrolLogs\__construct(), PopulateChangeTagDef\__construct(), PopulatePPSortKey\__construct(), MakeTestEdits\__construct(), PurgeList\__construct(), CheckImages\__construct(), ResetPageRandom\__construct(), MigrateUserGroup\__construct(), DeleteSelfExternals\__construct(), FixDefaultJsonContentPages\__construct(), FixUserRegistration\__construct(), SyncFileBackend\__construct(), CleanupBlocks\__construct(), PopulateExternallinksIndex60\__construct(), PopulateRevisionSha1\__construct(), RefreshExternallinksIndex\__construct(), RefreshFileHeaders\__construct(), MigrateFileRepoLayout\__construct(), MigrateComments\__construct(), PopulateRecentChangesSource\__construct(), PurgeModuleDeps\__construct(), CopyJobQueue\__construct(), CleanupPreferences\__construct(), ResetUserTokens\__construct(), PopulateLogUsertext\__construct(), PopulateRevisionLength\__construct(), RebuildFileCache\__construct(), UpdateRestrictions\__construct(), CheckUsernames\__construct(), WrapOldPasswords\__construct(), InvalidateUserSesssions\__construct(), CleanupUploadStash\__construct(), PopulateContentModel\__construct(), ConvertUserOptions\__construct(), CleanupRemovedModules\__construct(), MigrateActors\__construct(), CleanupUsersWithNoId\__construct(), PurgeChangedPages\__construct(), RecountCategories\__construct(), PopulateArchiveRevId\__construct(), RefreshLinks\__construct(), CopyFileBackend\__construct(), PopulateLogSearch\__construct(), DumpCategoriesAsRdf\__construct(), RebuildRecentchanges\__construct(), RefreshImageMetadata\__construct(), DeleteLocalPasswords\__construct(), PopulateContentTables\__construct(), CleanupInvalidDbKeys\__construct(), PurgeChangedFiles\__construct(), CategoryChangesAsRdf\__construct(), LoggedUpdateMaintenance\__construct(), PopulateChangeTagDef\doDBUpdates(), DeleteAutoPatrolLogs\execute(), and CopyFileBackend\execute().

◆ setConfig()

Maintenance::setConfig ( Config $config )

Since: 1.24

Parameters

Config $config

Definition at line 610 of file Maintenance.php.

References $config.

◆ setDB()

Maintenance::setDB ( IDatabase $db )

Sets database object to be returned by getDB().

Parameters

IDatabase $db

Definition at line 1389 of file Maintenance.php.

Referenced by DatabaseUpdater\__construct().

◆ setLBFactoryTriggers()

static Maintenance::setLBFactoryTriggers	(	LBFactory	$LBFactory,
		Config	$config
	)

static

Parameters

LBFactory	$LBFactory
Config	$config

Since: 1.28

Definition at line 674 of file Maintenance.php.

References $services, MediaWiki\emitBufferedStatsdData(), Config\get(), DeferredUpdates\tryOpportunisticExecute(), and use.

Referenced by MediaWikiTestCase\setUp().

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

References $options, $value, error(), and maybeHelp().

Referenced by loadWithArgv().

◆ setup()

Maintenance::setup ( )

Do some sanity checking and basic setup.

Definition at line 738 of file Maintenance.php.

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

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

References $wgCommandLineMode, class, and execute().

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

References $name.

Referenced by validateParamsAndArgs().

◆ unlockSearchindex()

Maintenance::unlockSearchindex ( $db )

private

Unlock the tables.

Parameters

IMaintainableDatabase &$db

Definition at line 1464 of file Maintenance.php.

Referenced by relockSearchindex(), and updateSearchIndex().

◆ updateSearchIndex()

Maintenance::updateSearchIndex	(	$maxLockTime,
		$callback,
		$dbw,
		$results
	)

Perform a search index update with locking.

Parameters

int	$maxLockTime	The maximum time to keep the search index locked.
string	$callback	The function that will update the function.
IMaintainableDatabase	$dbw
array	$results

Definition at line 1485 of file Maintenance.php.

References as, lockSearchindex(), output(), relockSearchindex(), and unlockSearchindex().

Referenced by UpdateSearchIndex\doUpdateSearchIndex(), and UpdateDoubleWidthSearch\execute().

◆ updateSearchIndexForPage()

Maintenance::updateSearchIndexForPage	(	$dbw,
		$pageId
	)

Update the searchindex table for a given pageid.

Parameters

IDatabase	$dbw	A database write handle
int	$pageId	The page ID to update.

Returns: null|string

Definition at line 1522 of file Maintenance.php.

References $rev, $title, Revision\loadFromPageId(), null, and output().

Referenced by UpdateDoubleWidthSearch\searchIndexUpdateCallback(), and UpdateSearchIndex\searchIndexUpdateCallback().

◆ validateParamsAndArgs()

Maintenance::validateParamsAndArgs ( )

Run some validation checks on the params, etc.

Definition at line 996 of file Maintenance.php.

References $opt, as, error(), hasArg(), hasOption(), maybeHelp(), and supportsOption().

Member Data Documentation

◆ $atLineStart

Maintenance::$atLineStart = true

private

Definition at line 494 of file Maintenance.php.

◆ $config

Config Maintenance::$config

private

Accessible via getConfig()

Definition at line 155 of file Maintenance.php.

Referenced by BenchmarkTidy\execute(), MediaWikiShell\execute(), getConfig(), setConfig(), and UpdateExtensionJsonSchema\updateTo2().

◆ $fileHandle

resource Maintenance::$fileHandle

Used when creating separate schema files.

Definition at line 148 of file Maintenance.php.

◆ $lastChannel

Maintenance::$lastChannel = null

private

Definition at line 495 of file Maintenance.php.

◆ $lastReplicationWait

float Maintenance::$lastReplicationWait = 0.0

private

UNIX timestamp.

Definition at line 142 of file Maintenance.php.

◆ $mAllowUnregisteredOptions

Maintenance::$mAllowUnregisteredOptions = false

protected

Definition at line 107 of file Maintenance.php.

◆ $mArgList

Maintenance::$mArgList = []

protected

Definition at line 98 of file Maintenance.php.

◆ $mArgs

Maintenance::$mArgs = []

protected

Definition at line 104 of file Maintenance.php.

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

◆ $mBatchSize

int Maintenance::$mBatchSize = null

protected

Batch size.

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

Definition at line 128 of file Maintenance.php.

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

◆ $mDb

IMaintainableDatabase Maintenance::$mDb = null

private

Used by getDB() / setDB()

Definition at line 139 of file Maintenance.php.

Referenced by getDB().

◆ $mDbPass

Maintenance::$mDbPass

Definition at line 114 of file Maintenance.php.

Referenced by finalSetup().

◆ $mDbUser

Maintenance::$mDbUser

protected

Definition at line 114 of file Maintenance.php.

Referenced by finalSetup().

◆ $mDependantParameters

Maintenance::$mDependantParameters = []

private

Definition at line 133 of file Maintenance.php.

Referenced by maybeHelp().

◆ $mDescription

Maintenance::$mDescription = ''

protected

Definition at line 117 of file Maintenance.php.

◆ $mGenericParameters

Maintenance::$mGenericParameters = []

private

Definition at line 131 of file Maintenance.php.

◆ $mInputLoaded

Maintenance::$mInputLoaded = false

protected

Definition at line 120 of file Maintenance.php.

◆ $mOptions

Maintenance::$mOptions = []

protected

Definition at line 101 of file Maintenance.php.

Referenced by CommandLineInc\execute().

◆ $mParams

Maintenance::$mParams = []

protected

Definition at line 92 of file Maintenance.php.

Referenced by addDefaultParams().

◆ $mQuiet

Maintenance::$mQuiet = false

protected

Definition at line 113 of file Maintenance.php.

Referenced by isQuiet().

◆ $mSelf

Maintenance::$mSelf

protected

Definition at line 110 of file Maintenance.php.

Referenced by getName().

◆ $mShortParamsMap

Maintenance::$mShortParamsMap = []

protected

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

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

◆ DB_NONE

const Maintenance::DB_NONE = 0

Constants for DB access type.

See also: Maintenance::getDbType()

Definition at line 84 of file Maintenance.php.

Referenced by DumpIterator\finalSetup(), GenerateRandomImages\getDbType(), GenerateNormalizerDataMl\getDbType(), GenerateNormalizerDataAr\getDbType(), SqliteMaintenance\getDbType(), PreprocessDump\getDbType(), FindHooks\getDbType(), MWDocGen\getDbType(), CommandLineInstaller\getDbType(), and SearchDump\getDbType().

◆ DB_STD

const Maintenance::DB_STD = 1

Definition at line 85 of file Maintenance.php.

◆ STDIN_ALL

const Maintenance::STDIN_ALL = 'all'

Definition at line 89 of file Maintenance.php.

Referenced by EditCLI\execute().

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

docs/maintenance.txt
maintenance/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

◆ __construct()

◆ activateProfiler()

◆ addArg()

◆ addDefaultParams()

◆ addDescription()

◆ addOption()

◆ adjustMemoryLimit()

◆ afterFinalSetup()

◆ beginTransaction()

◆ checkRequiredExtensions()

◆ cleanupChanneled()

◆ clearParamsAndArgs()

◆ commitTransaction()

◆ countDown()

◆ deleteOption()

◆ error()

◆ execute() [1/2]

◆ execute() [2/2]

◆ fatalError()

◆ finalSetup()

◆ getArg()

◆ getBatchSize()

◆ getConfig()

◆ getDB()

◆ getDbType()

◆ getDir()

◆ getName()

◆ getOption()

◆ getStdin()

◆ getTermSize()

◆ globals()

◆ hasArg()

◆ hasOption()

◆ isQuiet()

◆ loadParamsAndArgs()

◆ loadSettings()

◆ loadSpecialVars()

◆ loadWithArgv()

◆ lockSearchindex()

◆ maybeHelp()

◆ memoryLimit()

◆ output()

◆ outputChanneled()

◆ posix_isatty()

◆ purgeRedundantText()

◆ readconsole()

◆ readlineEmulation()

◆ relockSearchindex()

◆ requireExtension()

◆ requireTestsAutoloader()

◆ rollbackTransaction()

◆ runChild()

◆ setAgentAndTriggers()

◆ setAllowUnregisteredOptions()

◆ setBatchSize()

◆ setConfig()

◆ setDB()

◆ setLBFactoryTriggers()

◆ setParam()

◆ setup()

◆ shouldExecute()

◆ supportsOption()

◆ unlockSearchindex()

◆ updateSearchIndex()

◆ updateSearchIndexForPage()

◆ validateParamsAndArgs()

Member Data Documentation

◆ $atLineStart