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

Inherited by AllTrans, AlterSharedConstraints, AttachLatest, BackupDumper, BackupReader, BatchedQueryRunner, Benchmarker, BenchmarkParse, ChangePassword, CheckBadRedirects, CheckComposerLockUpToDate, CheckImages, CheckLess, CheckSyntax, CheckUsernames, CleanupAncientTables, CleanupBlocks, CleanupPreferences, CleanupRemovedModules, CleanupSpam, ClearInterwikiCache, CLIParser, CommandLineInc, CommandLineInstaller, CompareParserCache, CompressOld, ConvertExtensionToRegistration, ConvertLinks, ConvertUserOptions, CopyFileBackend, CopyJobQueue, CreateAndPromote, DatabaseLag, DateFormats, DeleteArchivedFiles, DeleteArchivedRevisions, DeleteBatch, DeleteDefaultMessages, DeleteEqualMessages, DeleteOldRevisions, DeleteOrphanedRevisions, DeleteRevision, DeleteSelfExternals, Digit2Html, DumpIterator, DumpLinks, DumpMessages, DumpRenderer, DumpRev, EditCLI, EraseArchivedFile, ExportSites, FakeMaintenance, FetchText, FindDeprecated, FindHooks, FindMissingFiles, FindOrphanedFiles, FixBug20757, FixDoubleRedirects, FixTimestamps, FixUserRegistration, GenerateCollationData, GenerateCommonPassword, GenerateJqueryMsgData, GenerateJsonI18n, GenerateNormalizerDataAr, GenerateNormalizerDataMl, GenerateRandomImages, GenerateSitemap, GetConfiguration, GetLagTimes, GetSlaveServer, GetTextMaint, ImageBuilder, ImportSites, ImportSiteScripts, ImportTextFiles, InitEditCount, InitSiteStats, JSParseHelper, LangMemUsage, ListVariants, LoggedUpdateMaintenance, MaintenanceFixup, MaintenanceFormatInstallDoc, MakeTestEdits, McTest, MergeMessageFileList, MigrateFileRepoLayout, MigrateUserGroup, MinifyScript, MoveBatch, MWDocGen, MwSql, NamespaceConflictChecker, NukeNS, NukePage, Orphans, OrphanStats, PageExists, PatchSql, PHPUnitMaintClass, PopulateCategory, PopulateContentModel, Protect, PruneFileCache, PurgeChangedFiles, PurgeChangedPages, PurgeList, PurgeOldText, PurgeParserCache, ReassignEdits, RebuildAll, RebuildFileCache, RebuildLocalisationCache, RebuildMessages, RebuildRecentchanges, RebuildSitesCache, RebuildTextIndex, RefreshFileHeaders, RefreshImageMetadata, RefreshLinks, RemoveInvalidEmails, RemoveUnusedAccounts, RenameDbPrefix, ResetUserEmail, ResetUserTokens, RollbackEdits, RunJobs, ShowJobs, ShowSiteStats, SqliteMaintenance, StorageTypeStats, SyncFileBackend, TableCleanup, TestFileOpPerformance, TidyUpBug37714, Undelete, UpdateArticleCount, UpdateCollation, UpdateDoubleWidthSearch, UpdateMediaWiki, UpdateRestrictions, UpdateSearchIndex, UpdateSpecialPages, UploadDumper, UploadStashCleanup, ValidateRegistrationFile, and WrapOldPasswords.

Collaboration diagram for Maintenance:

[legend]

Public Member Functions
	__construct ()
	Default constructor. 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...

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

Static Public Member Functions
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	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 slaves to catch up. More...

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

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

	getArg ($argId=0, $default=null)
	Get an argument. 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 param 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...

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

	setBatchSize ($s=0)
	Set the batch size. More...

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

Protected Attributes
	$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	$lastSlaveWait = 0.0
	UNIX timestamp. More...

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

	$mDependantParameters = []

	$mGenericParameters = []

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.

Author: Chad Horohoe chad@.nosp@m.anyo.nosp@m.necan.nosp@m.edit.nosp@m..org

Since: 1.16

Definition at line 39 of file maintenance.txt.

Constructor & Destructor Documentation

Maintenance::__construct ( )

Default constructor.

Children should call this first if implementing their own constructors

Definition at line 145 of file Maintenance.php.

References $IP, addDefaultParams(), and global.

Member Function Documentation

public function Maintenance::__construct ( )

inlineprivate

Definition at line 41 of file maintenance.txt.

Maintenance::activateProfiler ( )

protected

Activate the profiler (assuming $wgProfiler is set)

Definition at line 627 of file Maintenance.php.

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

Referenced by finalSetup().

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

Referenced by ValidateRegistrationFile\__construct(), ExportSites\__construct(), ImportSites\__construct(), Undelete\__construct(), PageExists\__construct(), EditCLI\__construct(), MaintenanceFormatInstallDoc\__construct(), MigrateUserGroup\__construct(), Protect\__construct(), RefreshLinks\__construct(), DumpRev\__construct(), ImportSiteScripts\__construct(), CleanupSpam\__construct(), ImportTextFiles\__construct(), PatchSql\__construct(), ResetUserEmail\__construct(), JSParseHelper\__construct(), McTest\__construct(), NukePage\__construct(), GetTextMaint\__construct(), ReassignEdits\__construct(), CreateAndPromote\__construct(), GenerateJsonI18n\__construct(), ConvertLinks\__construct(), GenerateCommonPassword\__construct(), FixTimestamps\__construct(), DeleteBatch\__construct(), BenchmarkParse\__construct(), CommandLineInstaller\__construct(), BackupReader\__construct(), MoveBatch\__construct(), ConvertExtensionToRegistration\__construct(), and CLIParser\__construct().

Maintenance::addDefaultParams ( )

protected

Add the default parameters to the scripts.

Definition at line 456 of file Maintenance.php.

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

Referenced by __construct().

Maintenance::addDescription ( $text )

protected

Set the description text.

Parameters

string $text The text of the description

Definition at line 277 of file Maintenance.php.

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	$shortName	Character to use as short name
bool	$multiOccurrence	Can this option be passed multiple times?

Definition at line 205 of file Maintenance.php.

References $name.

Referenced by RemoveInvalidEmails\__construct(), FindMissingFiles\__construct(), FindOrphanedFiles\__construct(), Undelete\__construct(), CompareParserCache\__construct(), InitEditCount\__construct(), PopulateContentModel\__construct(), DeleteEqualMessages\__construct(), DumpBackup\__construct(), MakeTestEdits\__construct(), PopulateBacklinkNamespace\__construct(), EditCLI\__construct(), PopulateImageSha1\__construct(), Protect\__construct(), PurgeList\__construct(), RebuildFileCache\__construct(), RebuildSitesCache\__construct(), MaintenanceFormatInstallDoc\__construct(), GetSlaveServer\__construct(), RefreshLinks\__construct(), SqliteMaintenance\__construct(), DatabaseLag\__construct(), PHPUnitMaintClass\__construct(), TestFileOpPerformance\__construct(), UploadDumper\__construct(), PurgeOldText\__construct(), ImportSiteScripts\__construct(), ResetUserEmail\__construct(), ImportTextFiles\__construct(), CleanupSpam\__construct(), MwSql\__construct(), DeleteOldRevisions\__construct(), SyncFileBackend\__construct(), ListVariants\__construct(), UpdateSpecialPages\__construct(), WrapOldPasswords\__construct(), InitSiteStats\__construct(), NukePage\__construct(), CleanupAncientTables\__construct(), GetTextMaint\__construct(), RemoveUnusedAccounts\__construct(), RollbackEdits\__construct(), RunJobs\__construct(), GenerateNormalizerDataAr\__construct(), RenameDbPrefix\__construct(), McTest\__construct(), MigrateFileRepoLayout\__construct(), MinifyScript\__construct(), CopyJobQueue\__construct(), PruneFileCache\__construct(), PurgeParserCache\__construct(), BenchWikimediaBaseConvert\__construct(), ReassignEdits\__construct(), DeleteArchivedFiles\__construct(), RefreshFileHeaders\__construct(), CleanupRemovedModules\__construct(), ResetUserTokens\__construct(), UpdateDoubleWidthSearch\__construct(), DeleteOrphanedRevisions\__construct(), ChangePassword\__construct(), EraseArchivedFile\__construct(), DeleteArchivedRevisions\__construct(), FixDoubleRedirects\__construct(), CreateAndPromote\__construct(), AttachLatest\__construct(), GenerateJsonI18n\__construct(), UpdateArticleCount\__construct(), PurgeChangedPages\__construct(), GenerateCommonPassword\__construct(), FixBug20757\__construct(), UpdateMediaWiki\__construct(), CheckSyntax\__construct(), CommandLineInc\__construct(), RebuildRecentchanges\__construct(), Benchmarker\__construct(), UpdateSearchIndex\__construct(), RebuildLocalisationCache\__construct(), DeleteBatch\__construct(), BenchmarkParse\__construct(), Orphans\__construct(), UpdateCollation\__construct(), CopyFileBackend\__construct(), DumpIterator\__construct(), CompareParsers\__construct(), CapsCleanup\__construct(), CommandLineInstaller\__construct(), BackupReader\__construct(), DumpRenderer\__construct(), MergeMessageFileList\__construct(), RefreshImageMetadata\__construct(), ShowJobs\__construct(), NukeNS\__construct(), TableCleanup\__construct(), MoveBatch\__construct(), WatchlistCleanup\__construct(), MWDocGen\__construct(), ImageBuilder\__construct(), PreprocessDump\__construct(), NamespaceConflictChecker\__construct(), GetConfiguration\__construct(), FindHooks\__construct(), GenerateCollationData\__construct(), ConvertExtensionToRegistration\__construct(), CLIParser\__construct(), PurgeChangedFiles\__construct(), CompressOld\__construct(), BackupDumper\__construct(), TextPassDumper\__construct(), GenerateSitemap\__construct(), SearchDump\__construct(), LoggedUpdateMaintenance\__construct(), addDefaultParams(), and setBatchSize().

Maintenance::adjustMemoryLimit ( )

protected

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

Definition at line 614 of file Maintenance.php.

References $limit, and memoryLimit().

Referenced by finalSetup(), and setup().

Maintenance::afterFinalSetup ( )

protected

Execute a callback function at the end of initialisation.

Definition at line 1033 of file Maintenance.php.

Referenced by finalSetup().

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

References $fname, and IDatabase\begin().

Referenced by CleanupSpam\cleanupArticle(), CompressOld\compressWithConcat(), NukePage\deleteRevisions(), PopulateLogUsertext\doDBUpdates(), DeleteOldRevisions\doDelete(), PopulateRevisionLength\doLenUpdates(), ReassignEdits\doReassignEdits(), PopulateRevisionSha1\doSha1LegacyUpdates(), PopulateRevisionSha1\doSha1Updates(), CleanupPreferences\execute(), MigrateUserGroup\execute(), NukePage\execute(), WrapOldPasswords\execute(), DeleteArchivedFiles\execute(), DeleteOrphanedRevisions\execute(), FixBug20757\execute(), RebuildFileCache\execute(), NukeNS\execute(), MoveBatch\execute(), UpdateCollation\execute(), RemoveUnusedAccounts\isInactiveAccount(), NamespaceConflictChecker\mergePage(), ImageCleanup\pokeFile(), and purgeRedundantText().

Maintenance::cleanupChanneled ( )

Clean up channeled output.

Output a newline if necessary.

Definition at line 401 of file Maintenance.php.

References print.

Referenced by output(), and outputChanneled().

Maintenance::clearParamsAndArgs ( )

Clear all params and arguments.

Definition at line 654 of file Maintenance.php.

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

protected

Commit the transcation on a DB handle and wait for slaves 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 slave wait succeeded

Since: 1.27

Definition at line 1196 of file Maintenance.php.

References $fname, IDatabase\commit(), and wfWaitForSlaves().

Referenced by CleanupSpam\cleanupArticle(), CompressOld\compressWithConcat(), NukePage\deleteRevisions(), PopulateLogUsertext\doDBUpdates(), DeleteOldRevisions\doDelete(), PopulateRevisionLength\doLenUpdates(), ReassignEdits\doReassignEdits(), PopulateRevisionSha1\doSha1LegacyUpdates(), PopulateRevisionSha1\doSha1Updates(), CleanupPreferences\execute(), DeleteSelfExternals\execute(), MigrateUserGroup\execute(), NukePage\execute(), DeleteArchivedFiles\execute(), WrapOldPasswords\execute(), DeleteOrphanedRevisions\execute(), FixBug20757\execute(), RebuildFileCache\execute(), NukeNS\execute(), MoveBatch\execute(), UpdateCollation\execute(), RemoveUnusedAccounts\isInactiveAccount(), NamespaceConflictChecker\mergePage(), ImageCleanup\pokeFile(), and purgeRedundantText().

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

References $name.

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	If > 0, go ahead and die out using this int as the code

Definition at line 382 of file Maintenance.php.

References outputChanneled(), and print.

Referenced by SqliteMaintenance\backup(), CheckSyntax\buildFileList(), ImageCleanup\buildSafeTitle(), FindOrphanedFiles\checkFiles(), CompareParsers\checkOptions(), SqliteMaintenance\checkSyntax(), CleanupSpam\cleanupArticle(), UpdateMediaWiki\compatChecks(), CompressOld\compressPage(), CompressOld\compressWithConcat(), CompareParsers\conclusions(), CopyFileBackend\copyFileBatch(), CopyFileBackend\delFileBatch(), PopulateRecentChangesSource\doDBUpdates(), PopulateRevisionLength\doDBUpdates(), PopulateRevisionSha1\doDBUpdates(), PopulateParentId\doDBUpdates(), FixExtLinksProtocolRelative\doDBUpdates(), PopulateLogSearch\doDBUpdates(), PopulateImageSha1\doDBUpdates(), UploadStashCleanup\doOperations(), UpdateSpecialPages\doSpecialPageCacheUpdates(), ValidateRegistrationFile\execute(), CheckComposerLockUpToDate\execute(), ExportSites\execute(), PageExists\execute(), Undelete\execute(), FindOrphanedFiles\execute(), BenchmarkPurge\execute(), GetLagTimes\execute(), DumpRev\execute(), DeleteRevision\execute(), PopulateContentModel\execute(), MaintenanceFormatInstallDoc\execute(), DeleteDefaultMessages\execute(), CleanupAncientTables\execute(), MakeTestEdits\execute(), MigrateUserGroup\execute(), LangMemUsage\execute(), GetTextMaint\execute(), RemoveUnusedAccounts\execute(), BatchedQueryRunner\execute(), ImportSiteScripts\execute(), UpdateSpecialPages\execute(), UpdateRestrictions\execute(), PruneFileCache\execute(), WrapOldPasswords\execute(), McTest\execute(), MigrateFileRepoLayout\execute(), ChangePassword\execute(), Protect\execute(), ResetUserEmail\execute(), MwSql\execute(), EraseArchivedFile\execute(), FixDoubleRedirects\execute(), CleanupSpam\execute(), UploadStashCleanup\execute(), RenameDbPrefix\execute(), CopyJobQueue\execute(), OrphanStats\execute(), FixTimestamps\execute(), ReassignEdits\execute(), GenerateNormalizerDataAr\execute(), EditCLI\execute(), PatchSql\execute(), Digit2Html\execute(), PurgeParserCache\execute(), SyncFileBackend\execute(), GenerateJsonI18n\execute(), CapsCleanup\execute(), DumpIterator\execute(), MinifyScript\execute(), RollbackEdits\execute(), PurgeChangedPages\execute(), ImportTextFiles\execute(), RebuildFileCache\execute(), GenerateCommonPassword\execute(), DeleteBatch\execute(), UpdateDoubleWidthSearch\execute(), RebuildTextIndex\execute(), DumpRenderer\execute(), SqliteMaintenance\execute(), RunJobs\execute(), MoveBatch\execute(), CopyFileBackend\execute(), BenchmarkParse\execute(), CreateAndPromote\execute(), RebuildRecentchanges\execute(), MergeMessageFileList\execute(), RebuildLocalisationCache\execute(), GenerateCollationData\execute(), FindHooks\execute(), UpdateSearchIndex\execute(), ConvertLinks\execute(), ConvertExtensionToRegistration\execute(), DumpBackup\execute(), PurgeChangedFiles\execute(), BackupReader\execute(), RefreshImageMetadata\execute(), UpdateMediaWiki\execute(), CommandLineInstaller\execute(), DeleteEqualMessages\execute(), CompressOld\execute(), MWDocGen\execute(), GenerateSitemap\execute(), BackupDumper\fatalError(), GenerateCollationData\generateFirstChars(), RebuildSitesCache\getCacheFile(), MinifyScript\getExtension(), CheckSyntax\getGitModifiedFiles(), CopyFileBackend\getListingDiffRel(), BackupReader\getNsIndex(), ConvertExtensionToRegistration\handleExtensionFunctions(), ConvertExtensionToRegistration\handleHooks(), DumpRenderer\handleRevision(), DumpIterator\handleRevision(), BackupReader\importFromHandle(), ReassignEdits\initialiseUser(), SqliteMaintenance\integrityCheck(), loadSettings(), loadWithArgv(), MinifyScript\minify(), TitleCleanup\moveInconsistentPage(), ImageCleanup\pokeFile(), PopulateContentModel\populateRevisionOrArchive(), PreprocessDump\processRevision(), CompareParsers\processRevision(), PurgeChangedFiles\purgeFromArchiveTable(), PurgeChangedFiles\purgeFromLogType(), MergeMessageFileList\readFile(), runChild(), setParam(), setup(), RefreshImageMetadata\setupParameters(), MwSql\sqlDoQuery(), SyncFileBackend\syncBackends(), SyncFileBackend\syncFileBatch(), GenerateJsonI18n\transformI18nFile(), RefreshFileHeaders\updateFileHeaders(), SqliteMaintenance\vacuum(), GetConfiguration\validateParamsAndArgs(), validateParamsAndArgs(), and CLIParser\Wikitext().

public function Maintenance::execute ( )

inlineprivate

Definition at line 45 of file maintenance.txt.

Maintenance::execute ( )

abstract

Do the actual work.

All child classes will need to implement this

Maintenance::finalSetup ( )

Handle some last-minute setup here.

Definition at line 971 of file Maintenance.php.

References $mDbPass, $mDbUser, $wgCommandLineMode, $wgDBadminpassword, $wgDBadminuser, $wgDBpassword, $wgDBservers, $wgDBuser, $wgLBFactoryConf, $wgServer, activateProfiler(), adjustMemoryLimit(), afterFinalSetup(), as, LBFactory\destroyInstance(), getDbType(), getOption(), global, and hasOption().

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

protected

Get an argument.

Parameters

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

Returns: mixed

Definition at line 296 of file Maintenance.php.

References hasArg().

Referenced by ValidateRegistrationFile\execute(), ExportSites\execute(), ImportSites\execute(), PageExists\execute(), Undelete\execute(), DumpRev\execute(), MaintenanceFormatInstallDoc\execute(), MigrateUserGroup\execute(), ImportSiteScripts\execute(), NukePage\execute(), GetTextMaint\execute(), BatchedQueryRunner\execute(), ResetUserEmail\execute(), MwSql\execute(), McTest\execute(), Protect\execute(), CleanupSpam\execute(), FixTimestamps\execute(), ReassignEdits\execute(), RefreshLinks\execute(), EditCLI\execute(), GenerateJsonI18n\execute(), ImportTextFiles\execute(), MinifyScript\execute(), DeleteBatch\execute(), GenerateCommonPassword\execute(), MoveBatch\execute(), BenchmarkParse\execute(), CreateAndPromote\execute(), ConvertLinks\execute(), ConvertExtensionToRegistration\execute(), BackupReader\execute(), CommandLineInstaller\execute(), ImportSiteScripts\fetchScriptList(), and CLIParser\Wikitext().

Maintenance::getConfig ( )

Since: 1.24

Returns: Config

Definition at line 495 of file Maintenance.php.

References $config, and ConfigFactory\getDefaultInstance().

Referenced by FixDefaultJsonContentPages\doDBUpdates(), Undelete\execute(), WrapOldPasswords\execute(), DumpIterator\execute(), DumpRenderer\execute(), RebuildSitesCache\getCacheFile(), and BackupReader\importFromHandle().

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

integer	$db	DB index (DB_SLAVE/DB_MASTER)
array	$groups,;	default: empty array
string \| bool	$wiki,;	default: current wiki

Returns: IDatabase

Definition at line 1154 of file Maintenance.php.

References $mDb, and wfGetDB().

Referenced by ImageBuilder\buildTable(), Orphans\checkOrphans(), Orphans\checkSeparation(), Orphans\checkWidows(), CleanupSpam\cleanupArticle(), CompressOld\compressOldPages(), CompressOld\compressPage(), CompressOld\compressWithConcat(), ConvertLinks\createTempTable(), RefreshLinks\deleteLinksFromNonexistent(), NukePage\deleteRevisions(), RefreshLinks\dfnCheckInterval(), PopulateRecentChangesSource\doDBUpdates(), PopulateRevisionLength\doDBUpdates(), PopulateRevisionSha1\doDBUpdates(), FixDefaultJsonContentPages\doDBUpdates(), PopulateFilearchiveSha1\doDBUpdates(), PopulateBacklinkNamespace\doDBUpdates(), PopulateParentId\doDBUpdates(), FixExtLinksProtocolRelative\doDBUpdates(), PopulateLogUsertext\doDBUpdates(), PopulateLogSearch\doDBUpdates(), PopulateImageSha1\doDBUpdates(), DeleteOldRevisions\doDelete(), PopulateRevisionLength\doLenUpdates(), ReassignEdits\doReassignEdits(), RefreshLinks\doRefreshLinks(), PopulateRevisionSha1\doSha1LegacyUpdates(), PopulateRevisionSha1\doSha1Updates(), UpdateSearchIndex\doUpdateSearchIndex(), TidyUpBug37714\execute(), RemoveInvalidEmails\execute(), StorageTypeStats\execute(), CleanupPreferences\execute(), CompareParserCache\execute(), CheckBadRedirects\execute(), BenchmarkDeleteTruncate\execute(), ClearInterwikiCache\execute(), CheckImages\execute(), GetSlaveServer\execute(), DumpRev\execute(), DeleteRevision\execute(), DeleteSelfExternals\execute(), PopulateContentModel\execute(), FixUserRegistration\execute(), CleanupBlocks\execute(), MigrateUserGroup\execute(), CleanupAncientTables\execute(), DeleteDefaultMessages\execute(), NukePage\execute(), InitEditCount\execute(), RemoveUnusedAccounts\execute(), BatchedQueryRunner\execute(), ConvertUserOptions\execute(), DeleteArchivedFiles\execute(), RebuildAll\execute(), WrapOldPasswords\execute(), CleanupRemovedModules\execute(), InitSiteStats\execute(), UpdateRestrictions\execute(), CheckUsernames\execute(), AlterSharedConstraints\execute(), UpdateSpecialPages\execute(), DeleteOrphanedRevisions\execute(), DeleteArchivedRevisions\execute(), UpdateArticleCount\execute(), AttachLatest\execute(), EraseArchivedFile\execute(), FixBug20757\execute(), FixDoubleRedirects\execute(), RenameDbPrefix\execute(), CleanupSpam\execute(), RefreshFileHeaders\execute(), ShowSiteStats\execute(), FixTimestamps\execute(), DumpLinks\execute(), PatchSql\execute(), PurgeChangedPages\execute(), ResetUserTokens\execute(), RebuildFileCache\execute(), DeleteBatch\execute(), FetchText\execute(), UpdateDoubleWidthSearch\execute(), RebuildTextIndex\execute(), NukeNS\execute(), SqliteMaintenance\execute(), MoveBatch\execute(), ImageBuilder\execute(), ConvertLinks\execute(), UpdateCollation\execute(), PopulateCategory\execute(), NamespaceConflictChecker\execute(), PurgeChangedFiles\execute(), RefreshImageMetadata\execute(), UpdateMediaWiki\execute(), DeleteEqualMessages\execute(), GenerateSitemap\execute(), LoggedUpdateMaintenance\execute(), UploadDumper\fetchLocal(), UploadDumper\fetchUsed(), TitleCleanup\fileExists(), RefreshLinks\fixRedirect(), BenchmarkParse\getRevIdForTime(), FixBug20757\getRevTextMap(), RollbackEdits\getRollbackTitles(), FixDefaultJsonContentPages\handleRow(), BackupReader\handleUpload(), RemoveUnusedAccounts\isInactiveAccount(), ImageCleanup\killRow(), TitleCleanup\moveIllegalPage(), TitleCleanup\moveInconsistentPage(), ImageCleanup\pokeFile(), PurgeChangedFiles\purgeFromLogType(), PurgeList\purgeNamespace(), purgeRedundantText(), RebuildRecentchanges\rebuildRecentChangesTablePass1(), RebuildRecentchanges\rebuildRecentChangesTablePass2(), RebuildRecentchanges\rebuildRecentChangesTablePass3(), RebuildRecentchanges\rebuildRecentChangesTablePass4(), WatchlistCleanup\removeWatch(), TableCleanup\runTable(), EraseArchivedFile\scrubAllVersions(), PopulateRevisionSha1\upgradeLegacyArchiveRow(), PopulateRevisionLength\upgradeRow(), and PopulateRevisionSha1\upgradeRow().

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

References DB_STD.

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

Maintenance::getDir ( )

protected

Get the maintenance directory.

Returns: string

Definition at line 1140 of file Maintenance.php.

Maintenance::getName ( )

Get the script's name.

Returns: string

Definition at line 326 of file Maintenance.php.

References $mSelf.

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	$default	Anything you want, default null

Returns: mixed

Definition at line 240 of file Maintenance.php.

References $name, and hasOption().

Referenced by activateProfiler(), Benchmarker\bench(), CheckSyntax\buildFileList(), PreprocessDump\checkOptions(), CompareParsers\checkOptions(), SqliteMaintenance\checkSyntax(), PopulateBacklinkNamespace\doDBUpdates(), PopulateImageSha1\doDBUpdates(), TestFileOpPerformance\doPerfTest(), PurgeList\doPurge(), UpdateSpecialPages\doSpecialPageCacheUpdates(), CompareParserCache\execute(), Undelete\execute(), FindMissingFiles\execute(), FindOrphanedFiles\execute(), BenchmarkPurge\execute(), GetSlaveServer\execute(), PopulateContentModel\execute(), MaintenanceFormatInstallDoc\execute(), MakeTestEdits\execute(), ImportSiteScripts\execute(), RemoveUnusedAccounts\execute(), NukePage\execute(), PruneFileCache\execute(), CleanupRemovedModules\execute(), UpdateSpecialPages\execute(), WrapOldPasswords\execute(), Protect\execute(), PurgeList\execute(), MwSql\execute(), UploadDumper\execute(), McTest\execute(), MigrateFileRepoLayout\execute(), ChangePassword\execute(), BenchWikimediaBaseConvert\execute(), RefreshFileHeaders\execute(), RenameDbPrefix\execute(), TestFileOpPerformance\execute(), FixBug20757\execute(), EraseArchivedFile\execute(), CopyJobQueue\execute(), FixDoubleRedirects\execute(), GenerateNormalizerDataAr\execute(), RefreshLinks\execute(), EditCLI\execute(), PurgeParserCache\execute(), SyncFileBackend\execute(), GenerateJsonI18n\execute(), PurgeChangedPages\execute(), DumpIterator\execute(), ImportTextFiles\execute(), RollbackEdits\execute(), MinifyScript\execute(), DeleteBatch\execute(), RebuildFileCache\execute(), ResetUserTokens\execute(), GenerateCommonPassword\execute(), UpdateDoubleWidthSearch\execute(), DumpRenderer\execute(), NukeNS\execute(), ShowJobs\execute(), SqliteMaintenance\execute(), RunJobs\execute(), PopulateImageSha1\execute(), MoveBatch\execute(), BenchmarkParse\execute(), CopyFileBackend\execute(), CreateAndPromote\execute(), MergeMessageFileList\execute(), RebuildLocalisationCache\execute(), GenerateCollationData\execute(), UpdateSearchIndex\execute(), UpdateCollation\execute(), PopulateCategory\execute(), NamespaceConflictChecker\execute(), PurgeChangedFiles\execute(), BackupReader\execute(), RefreshImageMetadata\execute(), UpdateMediaWiki\execute(), CommandLineInstaller\execute(), DeleteEqualMessages\execute(), CompressOld\execute(), GetConfiguration\execute(), PHPUnitMaintClass\execute(), GenerateSitemap\execute(), GetConfiguration\finalSetup(), finalSetup(), RebuildSitesCache\getCacheFile(), RefreshImageMetadata\getConditions(), CLIParser\getTitle(), BackupReader\importFromHandle(), MWDocGen\init(), loadSpecialVars(), memoryLimit(), DumpBackup\processOptions(), TextPassDumper\processOptions(), BackupDumper\processOptions(), CompareParsers\processRevision(), SearchDump\processRevision(), PurgeChangedFiles\purgeFromLogType(), RebuildRecentchanges\rebuildRecentChangesTablePass1(), PurgeList\sendPurgeRequest(), SyncFileBackend\syncFileBatch(), and GetConfiguration\validateParamsAndArgs().

Maintenance::getStdin ( $len = null )

protected

Return input from stdin.

Parameters

int $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 336 of file Maintenance.php.

References STDIN_ALL.

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

Maintenance::globals ( )

Potentially debug globals.

Originally a feature only for refreshLinks

Definition at line 1043 of file Maintenance.php.

References $GLOBALS, and hasOption().

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

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

Maintenance::hasOption ( $name )

protected

Checks to see if a particular param exists.

Parameters

string $name The name of the param

Returns: bool

Definition at line 226 of file Maintenance.php.

References $name.

Referenced by CheckSyntax\buildFileList(), PreprocessDump\checkOptions(), CompareParsers\checkOptions(), CleanupSpam\cleanupArticle(), CopyFileBackend\copyFileBatch(), ConvertLinks\createTempTable(), PopulateImageSha1\doDBUpdates(), TestFileOpPerformance\doPerfTest(), UpdateSpecialPages\doSpecialPageCacheUpdates(), RemoveInvalidEmails\execute(), FindOrphanedFiles\execute(), BenchmarkPurge\execute(), GetSlaveServer\execute(), DatabaseLag\execute(), PurgeOldText\execute(), MaintenanceFormatInstallDoc\execute(), CleanupAncientTables\execute(), DeleteOldRevisions\execute(), ListVariants\execute(), GetTextMaint\execute(), RemoveUnusedAccounts\execute(), InitEditCount\execute(), InitSiteStats\execute(), DeleteArchivedFiles\execute(), UpdateSpecialPages\execute(), WrapOldPasswords\execute(), DeleteOrphanedRevisions\execute(), UploadDumper\execute(), Protect\execute(), ChangePassword\execute(), PurgeList\execute(), ResetUserEmail\execute(), DeleteArchivedRevisions\execute(), MwSql\execute(), UpdateArticleCount\execute(), EraseArchivedFile\execute(), FixDoubleRedirects\execute(), CleanupSpam\execute(), RefreshFileHeaders\execute(), AttachLatest\execute(), ReassignEdits\execute(), GenerateNormalizerDataAr\execute(), EditCLI\execute(), RefreshLinks\execute(), SyncFileBackend\execute(), GenerateJsonI18n\execute(), MinifyScript\execute(), PurgeChangedPages\execute(), CapsCleanup\execute(), ImportTextFiles\execute(), RollbackEdits\execute(), DumpIterator\execute(), Orphans\execute(), TableCleanup\execute(), DumpRenderer\execute(), WatchlistCleanup\execute(), ShowJobs\execute(), SqliteMaintenance\execute(), PopulateImageSha1\execute(), RunJobs\execute(), CopyFileBackend\execute(), BenchmarkParse\execute(), RebuildRecentchanges\execute(), CreateAndPromote\execute(), MergeMessageFileList\execute(), ImageBuilder\execute(), RebuildLocalisationCache\execute(), UpdateSearchIndex\execute(), CheckSyntax\execute(), ConvertLinks\execute(), UpdateCollation\execute(), ConvertExtensionToRegistration\execute(), NamespaceConflictChecker\execute(), DumpBackup\execute(), PurgeChangedFiles\execute(), BackupReader\execute(), RefreshImageMetadata\execute(), UpdateMediaWiki\execute(), CommandLineInstaller\execute(), DeleteEqualMessages\execute(), PHPUnitMaintClass\execute(), LoggedUpdateMaintenance\execute(), CopyFileBackend\filesAreSame(), GetConfiguration\finalSetup(), finalSetup(), UpdateCollation\getBatchCondition(), RebuildSitesCache\getCacheFile(), FindHooks\getHooksFromDoc(), getOption(), globals(), ConvertExtensionToRegistration\handleResourceModules(), BackupReader\importFromHandle(), MWDocGen\init(), loadSpecialVars(), maybeHelp(), RunJobs\memoryLimit(), DumpBackup\processOptions(), TextPassDumper\processOptions(), BackupDumper\processOptions(), PurgeChangedFiles\purgeFromLogType(), RebuildRecentchanges\rebuildRecentChangesTablePass1(), WatchlistCleanup\removeWatch(), EraseArchivedFile\scrubVersion(), PurgeList\sendPurgeRequest(), CommandLineInstaller\validateParamsAndArgs(), validateParamsAndArgs(), and PurgeChangedFiles\verbose().

Maintenance::isQuiet ( )

Returns: bool

Definition at line 353 of file Maintenance.php.

References $mQuiet.

Referenced by SyncFileBackend\execute().

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	$self	The name of the script, if any
array	$opts	An array of options, in form of key=>value
array	$args	An array of command line arguments

Definition at line 780 of file Maintenance.php.

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

Referenced by CategoryMembershipChangeJobTest\runJobs(), setup(), WikiPageTest\testDoDeleteArticle(), WikiPageTest\testDoDeleteUpdates(), and TemplateCategoriesTest\testTemplateCategories().

Maintenance::loadSettings ( )

Generic setup for most installs.

Returns the location of LocalSettings

Returns: string

Definition at line 1053 of file Maintenance.php.

References $IP, $wgCommandLineMode, error(), and global.

Maintenance::loadSpecialVars ( )

protected

Handle the special variables that are global to all scripts.

Definition at line 837 of file Maintenance.php.

References getOption(), and hasOption().

Referenced by loadParamsAndArgs(), and 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 667 of file Maintenance.php.

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

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

Maintenance::lockSearchindex ( $db )

private

Lock the search index.

Parameters

DatabaseBase &$db

Definition at line 1223 of file Maintenance.php.

Referenced by relockSearchindex(), and updateSearchIndex().

Maintenance::maybeHelp ( $force = false )

protected

Maybe show the help.

Parameters

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

Definition at line 856 of file Maintenance.php.

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

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

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

References $limit, and getOption().

Referenced by adjustMemoryLimit().

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	$channel	Unique identifier for the channel. See function outputChanneled.

Definition at line 363 of file Maintenance.php.

References $out, cleanupChanneled(), outputChanneled(), and print.

Referenced by DumpBackup\__construct(), TextPassDumper\__construct(), ImageBuilder\addMissingImage(), SqliteMaintenance\backup(), CheckSyntax\buildFileList(), ImageBuilder\buildTable(), NamespaceConflictChecker\checkAll(), CheckSyntax\checkEvilToken(), FindOrphanedFiles\checkFiles(), CheckSyntax\checkFileWithCli(), NamespaceConflictChecker\checkLinkTable(), NamespaceConflictChecker\checkNamespace(), Orphans\checkOrphans(), NamespaceConflictChecker\checkPrefix(), CheckSyntax\checkRegex(), Orphans\checkSeparation(), SqliteMaintenance\checkSyntax(), Orphans\checkWidows(), CleanupSpam\cleanupArticle(), RebuildTextIndex\clearSearchIndex(), CompressOld\compressOldPages(), CompressOld\compressWithConcat(), CompareParsers\conclusions(), CopyFileBackend\copyFileBatch(), RebuildTextIndex\createMysqlTextIndex(), ConvertLinks\createTempTable(), RunJobs\debugInternal(), RefreshLinks\deleteLinksFromNonexistent(), CopyFileBackend\delFileBatch(), RefreshLinks\dfnCheckInterval(), PopulateRecentChangesSource\doDBUpdates(), PopulateRevisionLength\doDBUpdates(), PopulateRevisionSha1\doDBUpdates(), FixDefaultJsonContentPages\doDBUpdates(), PopulateBacklinkNamespace\doDBUpdates(), PopulateFilearchiveSha1\doDBUpdates(), PopulateParentId\doDBUpdates(), FixExtLinksProtocolRelative\doDBUpdates(), PopulateLogUsertext\doDBUpdates(), PopulateLogSearch\doDBUpdates(), PopulateImageSha1\doDBUpdates(), DeleteOldRevisions\doDelete(), PopulateRevisionLength\doLenUpdates(), TestFileOpPerformance\doPerfTest(), PurgeList\doPurge(), ReassignEdits\doReassignEdits(), RebuildLocalisationCache\doRebuild(), RefreshLinks\doRefreshLinks(), PopulateRevisionSha1\doSha1LegacyUpdates(), PopulateRevisionSha1\doSha1Updates(), UpdateSpecialPages\doSpecialPageCacheUpdates(), UpdateSearchIndex\doUpdateSearchIndex(), RebuildTextIndex\dropMysqlTextIndex(), TidyUpBug37714\execute(), ValidateRegistrationFile\execute(), CheckComposerLockUpToDate\execute(), RemoveInvalidEmails\execute(), ExportSites\execute(), ImportSites\execute(), PageExists\execute(), CleanupPreferences\execute(), CompareParserCache\execute(), FindMissingFiles\execute(), FindOrphanedFiles\execute(), Undelete\execute(), BenchmarkPurge\execute(), RebuildMessages\execute(), GetLagTimes\execute(), BenchmarkHooks\execute(), CheckBadRedirects\execute(), ClearInterwikiCache\execute(), CheckImages\execute(), GetSlaveServer\execute(), DatabaseLag\execute(), AllTrans\execute(), DumpRev\execute(), FixUserRegistration\execute(), DumpMessages\execute(), DeleteRevision\execute(), DeleteSelfExternals\execute(), CleanupBlocks\execute(), JSParseHelper\execute(), DateFormats\execute(), DeleteDefaultMessages\execute(), DeleteOldRevisions\execute(), MakeTestEdits\execute(), MigrateUserGroup\execute(), CleanupAncientTables\execute(), NukePage\execute(), ConvertUserOptions\execute(), GetTextMaint\execute(), ImportSiteScripts\execute(), RemoveUnusedAccounts\execute(), InitEditCount\execute(), BatchedQueryRunner\execute(), LangMemUsage\execute(), AlterSharedConstraints\execute(), UpdateRestrictions\execute(), UpdateSpecialPages\execute(), PruneFileCache\execute(), RebuildAll\execute(), WrapOldPasswords\execute(), CleanupRemovedModules\execute(), DeleteArchivedFiles\execute(), InitSiteStats\execute(), CheckUsernames\execute(), DeleteOrphanedRevisions\execute(), Protect\execute(), PurgeList\execute(), ChangePassword\execute(), MigrateFileRepoLayout\execute(), BenchWikimediaBaseConvert\execute(), DeleteArchivedRevisions\execute(), UpdateArticleCount\execute(), McTest\execute(), AttachLatest\execute(), EraseArchivedFile\execute(), FixDoubleRedirects\execute(), RefreshFileHeaders\execute(), CleanupSpam\execute(), CopyJobQueue\execute(), RenameDbPrefix\execute(), UploadStashCleanup\execute(), ReassignEdits\execute(), OrphanStats\execute(), FixTimestamps\execute(), ShowSiteStats\execute(), DumpLinks\execute(), EditCLI\execute(), PatchSql\execute(), PurgeParserCache\execute(), Digit2Html\execute(), GenerateJsonI18n\execute(), SyncFileBackend\execute(), RollbackEdits\execute(), PurgeChangedPages\execute(), ImportTextFiles\execute(), TableCleanup\execute(), ResetUserTokens\execute(), GenerateCommonPassword\execute(), RebuildFileCache\execute(), DeleteBatch\execute(), FetchText\execute(), UpdateDoubleWidthSearch\execute(), RebuildTextIndex\execute(), WatchlistCleanup\execute(), NukeNS\execute(), ShowJobs\execute(), RunJobs\execute(), MoveBatch\execute(), CopyFileBackend\execute(), CreateAndPromote\execute(), RebuildRecentchanges\execute(), RebuildLocalisationCache\execute(), FindHooks\execute(), CheckSyntax\execute(), ConvertLinks\execute(), UpdateCollation\execute(), PopulateCategory\execute(), ConvertExtensionToRegistration\execute(), NamespaceConflictChecker\execute(), BackupReader\execute(), RefreshImageMetadata\execute(), UpdateMediaWiki\execute(), DeleteEqualMessages\execute(), CompressOld\execute(), MWDocGen\execute(), GetConfiguration\execute(), LoggedUpdateMaintenance\execute(), DeleteEqualMessages\fetchMessageInfo(), ImportSiteScripts\fetchScriptList(), GetConfiguration\formatVarDump(), ConvertExtensionToRegistration\handleExtensionMessagesFiles(), DumpRenderer\handleRevision(), DumpIterator\handleRevision(), FixDefaultJsonContentPages\handleRow(), MWDocGen\init(), SqliteMaintenance\integrityCheck(), ImageCleanup\killRow(), GenerateSitemap\main(), maybeHelp(), MinifyScript\minify(), TitleCleanup\moveIllegalPage(), TitleCleanup\moveInconsistentPage(), ImageBuilder\oldimageCallback(), UploadDumper\outputItem(), ImageCleanup\pokeFile(), PopulateContentModel\populatePage(), PopulateContentModel\populateRevisionOrArchive(), RebuildTextIndex\populateSearchIndex(), FindHooks\printArray(), CompareParsers\processRevision(), SearchDump\processRevision(), TitleCleanup\processRow(), ImageCleanup\processRow(), WatchlistCleanup\processRow(), CapsCleanup\processRow(), TableCleanup\progress(), ImageBuilder\progress(), PruneFileCache\prune_directory(), RebuildRecentchanges\purgeFeeds(), PurgeChangedFiles\purgeFromArchiveTable(), purgeRedundantText(), FixDoubleRedirects\queueJobs(), RebuildRecentchanges\rebuildRecentChangesTablePass1(), RebuildRecentchanges\rebuildRecentChangesTablePass2(), RebuildRecentchanges\rebuildRecentChangesTablePass3(), RebuildRecentchanges\rebuildRecentChangesTablePass4(), RebuildRecentchanges\rebuildRecentChangesTablePass5(), WatchlistCleanup\removeWatch(), ImportSites\reportException(), MigrateFileRepoLayout\runBatch(), TableCleanup\runTable(), EraseArchivedFile\scrubVersion(), PurgeList\sendPurgeRequest(), PurgeParserCache\showProgress(), UpdateCollation\showSortKeySizeHistogram(), MwSql\sqlPrintResult(), SyncFileBackend\syncBackends(), SyncFileBackend\syncFileBatch(), GenerateJsonI18n\transformI18nFile(), PopulateContentModel\updatePageRows(), PopulateContentModel\updateRevisionOrArchiveRows(), updateSearchIndex(), updateSearchIndexForPage(), ResetUserTokens\updateUser(), PopulateRevisionSha1\upgradeLegacyArchiveRow(), PopulateRevisionLength\upgradeRow(), PopulateRevisionSha1\upgradeRow(), SqliteMaintenance\vacuum(), and PurgeChangedFiles\verbose().

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	$channel	Channel identifier or null for no channel. Channel comparison uses ===.

Definition at line 416 of file Maintenance.php.

References cleanupChanneled(), and print.

Referenced by error(), and output().

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

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

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

References $count, $res, as, beginTransaction(), commitTransaction(), DB_MASTER, getDB(), and output().

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

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

Referenced by MwSql\execute().

static Maintenance::readlineEmulation ( $prompt )

staticprivate

Emulate readline()

Parameters

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

Returns: string

Definition at line 1375 of file Maintenance.php.

References $command, $line, $retval, Installer\locateExecutableInDefaultPaths(), print, wfEscapeShellArg(), wfIsWindows(), and wfShellExec().

Maintenance::relockSearchindex ( $db )

private

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

Parameters

DatabaseBase &$db

Definition at line 1250 of file Maintenance.php.

References lockSearchindex(), and unlockSearchindex().

Referenced by updateSearchIndex().

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

References $fname, and IDatabase\rollback().

Referenced by ImageCleanup\pokeFile().

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	$classFile	Full path of where the child is

Returns: Maintenance

Definition at line 518 of file Maintenance.php.

References $maintClass, and error().

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

Maintenance::setBatchSize ( $s = 0 )

protected

Set the batch size.

Parameters

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

Definition at line 304 of file Maintenance.php.

References $s, and addOption().

Referenced by RemoveInvalidEmails\__construct(), FindOrphanedFiles\__construct(), FindMissingFiles\__construct(), PopulateContentModel\__construct(), MakeTestEdits\__construct(), CheckImages\__construct(), PurgeList\__construct(), RebuildFileCache\__construct(), RefreshLinks\__construct(), MigrateUserGroup\__construct(), SyncFileBackend\__construct(), WrapOldPasswords\__construct(), PopulateRecentChangesSource\__construct(), FixDefaultJsonContentPages\__construct(), FixUserRegistration\__construct(), MigrateFileRepoLayout\__construct(), PopulateRevisionLength\__construct(), PopulateRevisionSha1\__construct(), CleanupBlocks\__construct(), ConvertUserOptions\__construct(), ResetUserTokens\__construct(), RefreshFileHeaders\__construct(), CopyJobQueue\__construct(), UpdateRestrictions\__construct(), PopulateLogUsertext\__construct(), CheckUsernames\__construct(), PurgeChangedPages\__construct(), UploadStashCleanup\__construct(), RebuildRecentchanges\__construct(), PopulateLogSearch\__construct(), CopyFileBackend\__construct(), RefreshImageMetadata\__construct(), PurgeChangedFiles\__construct(), and LoggedUpdateMaintenance\__construct().

Maintenance::setConfig ( Config $config )

Since: 1.24

Parameters

Config $config

Definition at line 507 of file Maintenance.php.

References $config.

Maintenance::setDB ( IDatabase $db )

Sets database object to be returned by getDB().

Parameters

IDatabase $db Database object to be used

Definition at line 1167 of file Maintenance.php.

Referenced by DatabaseUpdater\__construct().

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

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

Referenced by loadWithArgv().

Maintenance::setup ( )

Do some sanity checking and basic setup.

Definition at line 544 of file Maintenance.php.

References $IP, $wgCommandLineMode, $wgRequestTime, adjustMemoryLimit(), error(), global, loadParamsAndArgs(), maybeHelp(), and validateParamsAndArgs().

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

References $count, $wgCommandLineMode, and global.

Maintenance::unlockSearchindex ( $db )

private

Unlock the tables.

Parameters

DatabaseBase &$db

Definition at line 1241 of file Maintenance.php.

Referenced by relockSearchindex(), and 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.
DatabaseBase	$dbw
array	$results

Definition at line 1262 of file Maintenance.php.

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

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

Maintenance::updateSearchIndexForPage	(	$dbw,
		$pageId
	)

Update the searchindex table for a given pageid.

Parameters

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

Returns: null|string

Definition at line 1299 of file Maintenance.php.

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

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

Maintenance::validateParamsAndArgs ( )

protected

Run some validation checks on the params, etc.

Definition at line 812 of file Maintenance.php.

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

Referenced by setup().

Member Data Documentation

Maintenance::$atLineStart = true

private

Definition at line 395 of file Maintenance.php.

Config Maintenance::$config

private

Accessible via getConfig()

Definition at line 126 of file Maintenance.php.

Referenced by getConfig(), and setConfig().

resource Maintenance::$fileHandle

Used when creating separate schema files.

Definition at line 119 of file Maintenance.php.

Maintenance::$lastChannel = null

private

Definition at line 396 of file Maintenance.php.

float Maintenance::$lastSlaveWait = 0.0

private

UNIX timestamp.

Definition at line 113 of file Maintenance.php.

Maintenance::$mArgList = []

protected

Definition at line 72 of file Maintenance.php.

Maintenance::$mArgs = []

protected

Definition at line 78 of file Maintenance.php.

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

int Maintenance::$mBatchSize = null

protected

Batch size.

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

Definition at line 99 of file Maintenance.php.

Referenced by PopulateRecentChangesSource\doDBUpdates(), FixDefaultJsonContentPages\doDBUpdates(), PopulateFilearchiveSha1\doDBUpdates(), PopulateParentId\doDBUpdates(), PopulateLogUsertext\doDBUpdates(), PopulateLogSearch\doDBUpdates(), PopulateRevisionLength\doLenUpdates(), PopulateRevisionSha1\doSha1Updates(), RemoveInvalidEmails\execute(), FindMissingFiles\execute(), CheckImages\execute(), FixUserRegistration\execute(), MigrateUserGroup\execute(), CleanupBlocks\execute(), ConvertUserOptions\execute(), WrapOldPasswords\execute(), UploadStashCleanup\execute(), PurgeChangedPages\execute(), ResetUserTokens\execute(), RebuildFileCache\execute(), RefreshImageMetadata\execute(), PopulateContentModel\populatePage(), PopulateContentModel\populateRevisionOrArchive(), and PurgeList\purgeNamespace().

IDatabase Maintenance::$mDb = null

private

Used by getDB() / setDB()

Definition at line 110 of file Maintenance.php.

Referenced by getDB().

Maintenance::$mDbPass

Definition at line 85 of file Maintenance.php.

Referenced by finalSetup().

Maintenance::$mDbUser

protected

Definition at line 85 of file Maintenance.php.

Referenced by finalSetup().

Maintenance::$mDependantParameters = []

private

Definition at line 104 of file Maintenance.php.

Referenced by maybeHelp().

Maintenance::$mDescription = ''

protected

Definition at line 88 of file Maintenance.php.

Maintenance::$mGenericParameters = []

private

Definition at line 102 of file Maintenance.php.

Maintenance::$mInputLoaded = false

protected

Definition at line 91 of file Maintenance.php.

Maintenance::$mOptions = []

protected

Definition at line 75 of file Maintenance.php.

Referenced by CommandLineInc\execute().

Maintenance::$mParams = []

protected

Definition at line 66 of file Maintenance.php.

Referenced by addDefaultParams().

Maintenance::$mQuiet = false

protected

Definition at line 84 of file Maintenance.php.

Referenced by isQuiet().

Maintenance::$mSelf

protected

Definition at line 81 of file Maintenance.php.

Referenced by getName().

Maintenance::$mShortParamsMap = []

protected

Definition at line 69 of file Maintenance.php.

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

Referenced by BackupDumper\processOptions().

const Maintenance::DB_ADMIN = 2

Definition at line 60 of file Maintenance.php.

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