MediaWiki master
MediaWiki\Maintenance\Maintenance Class Reference

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

Inherited by MediaWiki\Maintenance\ApplyChangeTag, MediaWiki\Maintenance\BackupDumper, MediaWiki\Maintenance\Benchmarker, MediaWiki\Maintenance\DeleteLocalPasswords, MediaWiki\Maintenance\FakeMaintenance, MediaWiki\Maintenance\LoggedUpdateMaintenance, MediaWiki\Maintenance\SchemaMaintenance, MediaWiki\Maintenance\UpdateCredits, and MediaWiki\Maintenance\Version.

Collaboration diagram for MediaWiki\Maintenance\Maintenance:

Public Member Functions

 __construct ()
 Default constructor.
 canExecuteWithoutLocalSettings ()
 Whether this script can run without LocalSettings.php.
 checkRequiredExtensions ()
 Verify that the required extensions are installed.
 cleanupChanneled ()
 Clean up channeled output.
 clearParamsAndArgs ()
 Clear all params and arguments.
 createChild (string $maintClass, ?string $classFile=null)
 Returns an instance of the given maintenance script, with all of the current arguments passed to it.
 execute ()
 Do the actual work.
 finalSetup (SettingsBuilder $settingsBuilder)
 Handle some last-minute setup here.
 getConfig ()
 getDbType ()
 Does the script need different DB access?
 getName ()
 Get the script's name.
 getParameters ()
 isQuiet ()
 loadParamsAndArgs ( $self=null, $opts=null, $args=null)
 Process command line arguments when running as a child script.
 loadWithArgv ( $argv)
 Load params and arguments from a given array of command-line arguments.
 memoryLimit ()
 Override memory_limit from php.ini on maintenance scripts.
 outputChanneled ( $msg, $channel=null)
 Message outputter with channeled message support.
 purgeRedundantText ( $delete=true)
 Support function for cleaning up redundant text records.
 setArg ( $argId, $value)
 Programmatically set the value of the given argument.
 setConfig (Config $config)
 setDB (IMaintainableDatabase $db)
 Sets database object to be returned by getDB().
 setLBFactory (ILBFactory $lbFactory)
 setName (string $name)
 setOption (string $name, $value)
 Programmatically set the value of the given option.
 setup ()
 Provides subclasses with an opportunity to perform initial checks.
 validateParamsAndArgs ()
 Run some validation checks on the params, etc.

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).
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.
static readconsole ( $prompt='> ')
 Prompt the console for input.
static requireTestsAutoloader ()
 Call this to set up the autoloader to allow classes to be used from the tests directory.

Public Attributes

resource null $fileHandle
 Used when creating separate schema files.
array $orderedOptions = []
 Used to read the options in the order they were passed.
const DB_ADMIN = 2
const DB_NONE = 0
 Constants for DB access type.
const DB_STD = 1
const GENERIC_MAINTENANCE_PARAMETERS = 'Script runner options'
const SCRIPT_DEPENDENT_PARAMETERS = 'Common options'
const STDIN_ALL = -1

Protected Member Functions

 addArg ( $arg, $description, $required=true, $multi=false)
 Add some args that are needed.
 addDefaultParams ()
 Add the default parameters to the scripts.
 addDescription ( $text)
 Set the description text.
 addOption ( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
 Add a parameter to the script.
 afterFinalSetup ()
 Override to perform any required operation at the end of initialisation.
 beginTransaction (IDatabase $dbw, $fname)
 Begin a transaction on a DB handle.
 beginTransactionRound ( $fname)
 Start a transactional batch of DB operations.
 commitTransaction (IDatabase $dbw, $fname)
 Commit the transaction on a DB handle and wait for replica DB servers to catch up.
 commitTransactionRound ( $fname)
 Commit a transactional batch of DB operations and wait for replica DB servers to catch up.
 countDown ( $seconds)
 Count down from $seconds to zero on the terminal, with a one-second pause between showing each number.
 deleteOption ( $name)
 Remove an option.
 error ( $err)
 Throw an error to the user.
 fatalError ( $msg, $exitCode=1)
 Output a message and terminate the current script.
 getAnalyticsReplica (string|false $virtualDomain=false)
 Get a replica connection meant for slow, long-running or analytics-style queries (the "vslow" query group, which also covers "dump").
 getArg ( $argId=0, $default=null)
 Get an argument.
 getArgName (int $argId)
 Get the name of an argument.
 getArgs ( $offset=0)
 Get arguments.
 getBatchSize ()
 Returns batch size.
 getDB ( $db, $groups=[], $dbDomain=false)
 Returns a database to be used by current maintenance script.
 getDir ()
 Get the maintenance directory.
 getHookContainer ()
 Get a HookContainer, for running extension hooks or for hook metadata.
 getHookRunner ()
 Get a HookRunner for running core hooks.
 getOption ( $name, $default=null)
 Get an option, or return the default.
 getPrimaryDB (string|false $virtualDomain=false)
 getReplicaDB (string|false $virtualDomain=false)
 getServiceContainer ()
 Returns the main service container.
 getStdin ( $len=null)
 Return input from stdin.
 hasArg ( $argId=0)
 Does a given argument exist?
 hasOption ( $name)
 Checks to see if a particular option was set.
 loadSpecialVars ()
 Handle the special variables that are global to all scripts.
 maybeHelp ( $force=false)
 Maybe show the help.
 newBatchIterator ( $source)
 Wrap an entry iterator into a generator that returns batches of said entries.
 output ( $out, $channel=null)
 Throw some output to the user.
 parseIntList ( $text)
 Utility function to parse a string (perhaps from a command line option) into a list of integers (perhaps some kind of numeric IDs).
 prompt (string $prompt, ?string $default=null)
 promptYesNo ( $prompt, $default=null)
 requireExtension ( $name)
 Indicate that the specified extension must be loaded before the script can run.
 rollbackTransaction (IDatabase $dbw, $fname)
 Rollback the transaction on a DB handle.
 rollbackTransactionRound ( $fname)
 Rollback a transactional batch of DB operations.
 setAllowUnregisteredOptions ( $allow)
 Sets whether to allow unregistered options, which are options passed to a script that do not match an expected parameter.
 setBatchSize ( $s=0)
 showHelp ()
 Definitely show the help.
 supportsOption ( $name)
 Checks to see if a particular option in supported.
 validateUserOption ( $errorMsg)
 waitForReplication ()
 Wait for replica DB servers to catch up.

Protected Attributes

array $mArgs = []
 This is the list of arguments that were actually passed.
int null $mBatchSize = null
 Batch size.
string $mDbPass = null
string $mDbUser = null
string $mDescription = ''
 A description of the script, children should change this via addDescription().
bool $mInputLoaded = false
 Have we already loaded our user input?
array $mOptions = []
 This is the list of options that were actually passed.
array[] $mParams = []
 Empty.
bool $mQuiet = false
 Special vars for params that are always used.
string null $mSelf
 Name of the script currently running.
MaintenanceParameters $parameters

Detailed Description

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

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

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

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

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

Stability: stable
to extend
Since
1.16

Definition at line 64 of file Maintenance.php.

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addArg()

MediaWiki\Maintenance\Maintenance::addArg ( $arg,
$description,
$required = true,
$multi = false )
protected

Add some args that are needed.

Parameters
string$argName of the arg, like 'start'
string$descriptionShort description of the arg
bool$requiredIs this required?
bool$multiDoes it allow multiple values? (Last arg only)

Definition at line 310 of file Maintenance.php.

Referenced by BenchmarkEval\__construct().

◆ addDefaultParams()

MediaWiki\Maintenance\Maintenance::addDefaultParams ( )
protected

Add the default parameters to the scripts.

Definition at line 627 of file Maintenance.php.

References addOption(), and getDbType().

Referenced by __construct().

◆ addDescription()

◆ addOption()

MediaWiki\Maintenance\Maintenance::addOption ( $name,
$description,
$required = false,
$withArg = false,
$shortName = false,
$multiOccurrence = false )
protected

◆ afterFinalSetup()

MediaWiki\Maintenance\Maintenance::afterFinalSetup ( )
protected

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

Stability: stable
to override

Definition at line 1001 of file Maintenance.php.

Referenced by finalSetup().

◆ beginTransaction()

MediaWiki\Maintenance\Maintenance::beginTransaction ( IDatabase $dbw,
$fname )
protected

Begin a transaction on a DB handle.

Maintenance scripts should call this method instead of IDatabase::begin(). Use of this method makes it clear that the caller is a maintenance script, which has the outermost transaction scope needed to explicitly begin transactions.

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.

Use this method for scripts with direct, straightforward, control of all writes.

Parameters
IDatabase$dbw
string$fnameCaller name
Since
1.27
Deprecated
Since 1.44 Use beginTransactionRound() instead

Definition at line 1189 of file Maintenance.php.

References Wikimedia\Rdbms\IDatabase\begin().

◆ beginTransactionRound()

MediaWiki\Maintenance\Maintenance::beginTransactionRound ( $fname)
protected

Start a transactional batch of DB operations.

Use this method for scripts that split up their work into logical transactions.

This method is suitable even for scripts lacking direct, straightforward, control of all writes. Such scripts might invoke complex methods of service objects, which might easily touch multiple DB servers. This method proves the usual best-effort distributed transactions that DBO_DEFAULT provides during web requests.

See also
ILBfactory::beginPrimaryChanges()
Parameters
string$fnameCaller name
Returns
void
Since
1.44

Definition at line 1304 of file Maintenance.php.

Referenced by purgeRedundantText().

◆ canExecuteWithoutLocalSettings()

MediaWiki\Maintenance\Maintenance::canExecuteWithoutLocalSettings ( )

Whether this script can run without LocalSettings.php.

Scripts that need to be able to run when MediaWiki has not been installed should override this to return true. Scripts that return true from this method must be able to function without a storage backend. When no LocalSettings.php file is present, any attempt to access the database will fail with a fatal error.

Note
Subclasses that override this method to return true should also override getDbType() to return self::DB_NONE, unless they are going to use the database connection when it is available.
See also
getDbType()
Since
1.40
Stability: stable
to override
Returns
bool

Reimplemented in MediaWiki\Maintenance\SchemaMaintenance, and MediaWiki\Maintenance\Version.

Definition at line 240 of file Maintenance.php.

References return.

◆ checkRequiredExtensions()

MediaWiki\Maintenance\Maintenance::checkRequiredExtensions ( )

Verify that the required extensions are installed.

Since
1.28

Definition at line 701 of file Maintenance.php.

References fatalError().

◆ cleanupChanneled()

MediaWiki\Maintenance\Maintenance::cleanupChanneled ( )

Clean up channeled output.

Output a newline if necessary.

Definition at line 565 of file Maintenance.php.

Referenced by output(), and outputChanneled().

◆ clearParamsAndArgs()

MediaWiki\Maintenance\Maintenance::clearParamsAndArgs ( )

Clear all params and arguments.

Definition at line 791 of file Maintenance.php.

◆ commitTransaction()

MediaWiki\Maintenance\Maintenance::commitTransaction ( IDatabase $dbw,
$fname )
protected

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

This method also triggers DeferredUpdates::tryOpportunisticExecute().

Maintenance scripts should call this method instead of IDatabase::commit(). Use of this method makes it clear that the caller is a maintenance script, which has the outermost transaction scope needed to explicitly commit transactions.

Use this method for scripts with direct, straightforward, control of all writes.

Parameters
IDatabase$dbw
string$fnameCaller name
Returns
bool Whether the replication wait succeeded
Since
1.27
Deprecated
Since 1.44 Use commitTransactionRound() instead

Definition at line 1210 of file Maintenance.php.

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

◆ commitTransactionRound()

MediaWiki\Maintenance\Maintenance::commitTransactionRound ( $fname)
protected

Commit a transactional batch of DB operations and wait for replica DB servers to catch up.

Use this method for scripts that split up their work into logical transactions.

This method also triggers DeferredUpdates::tryOpportunisticExecute().

See also
ILBfactory::commitPrimaryChanges()
Parameters
string$fnameCaller name
Returns
bool Whether the replication wait succeeded
Since
1.44

Definition at line 1323 of file Maintenance.php.

References MediaWiki\MediaWikiEntryPoint\emitBufferedStats(), and getServiceContainer().

Referenced by purgeRedundantText().

◆ countDown()

MediaWiki\Maintenance\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 1403 of file Maintenance.php.

References isQuiet(), and output().

◆ createChild()

MediaWiki\Maintenance\Maintenance::createChild ( string $maintClass,
?string $classFile = null )

Returns an instance of the given maintenance script, with all of the current arguments passed to it.

Callers are expected to run the returned maintenance script instance by calling Maintenance::execute

Parameters
class-string<Maintenance>$maintClass A name of a child maintenance class
string | null$classFileFull path of where the child is
Stability: stable
to override
Returns
Maintenance The created instance, which the caller is expected to run by calling Maintenance::execute on the returned object.

Definition at line 734 of file Maintenance.php.

References MediaWiki\Maintenance\$maintClass, fatalError(), and if.

◆ deleteOption()

MediaWiki\Maintenance\Maintenance::deleteOption ( $name)
protected

Remove an option.

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

Parameters
string$nameThe option to remove.

Definition at line 318 of file Maintenance.php.

◆ error()

MediaWiki\Maintenance\Maintenance::error ( $err)
protected

Throw an error to the user.

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

Stability: stable
to override
Parameters
string | StatusValue$errThe error to display

Definition at line 511 of file Maintenance.php.

References error(), outputChanneled(), and wfMessage().

Referenced by error(), BenchmarkPurge\execute(), MediaWiki\Maintenance\SchemaMaintenance\execute(), fatalError(), and maybeHelp().

◆ execute()

MediaWiki\Maintenance\Maintenance::execute ( )
abstract

◆ fatalError()

◆ finalSetup()

◆ getAnalyticsReplica()

MediaWiki\Maintenance\Maintenance::getAnalyticsReplica ( string|false $virtualDomain = false)
protected

Get a replica connection meant for slow, long-running or analytics-style queries (the "vslow" query group, which also covers "dump").

Parameters
string | false$virtualDomain
Returns
IReadableDatabase
Since
1.47

Definition at line 1134 of file Maintenance.php.

References return.

Referenced by MediaWiki\Maintenance\BackupDumper\initProgress().

◆ getArg()

MediaWiki\Maintenance\Maintenance::getArg ( $argId = 0,
$default = null )
protected

Get an argument.

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

Definition at line 357 of file Maintenance.php.

Referenced by BenchmarkEval\execute().

◆ getArgName()

MediaWiki\Maintenance\Maintenance::getArgName ( int $argId)
protected

Get the name of an argument.

Since
1.43
Parameters
int$argIdThe index (from zero) of the argument.
Returns
string|null The name of the argument, or null if the argument does not exist.

Definition at line 381 of file Maintenance.php.

References getArgName(), and return.

Referenced by getArgName().

◆ getArgs()

MediaWiki\Maintenance\Maintenance::getArgs ( $offset = 0)
protected

Get arguments.

Since
1.40
Parameters
int | string$offsetThe index (from zero) of the first argument, or the name declared for the argument by addArg().
Returns
string[]

Definition at line 369 of file Maintenance.php.

◆ getBatchSize()

◆ getConfig()

MediaWiki\Maintenance\Maintenance::getConfig ( )
Since
1.24
Stability: stable
to override
Returns
Config

Definition at line 660 of file Maintenance.php.

References getServiceContainer().

Referenced by BenchmarkRebuildLocalisationCache\execute(), and purgeRedundantText().

◆ getDB()

MediaWiki\Maintenance\Maintenance::getDB ( $db,
$groups = [],
$dbDomain = false )
protected

Returns a database to be used by current maintenance script.

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

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

For simple cases, use ::getReplicaDB() or ::getPrimaryDB() instead.

Stability: stable
to override
Parameters
int$dbDB index (DB_REPLICA/DB_PRIMARY)
string | string[]$groupsdefault: empty array
string | bool$dbDomaindefault: current wiki
Returns
IMaintainableDatabase

Definition at line 1097 of file Maintenance.php.

Referenced by MediaWiki\Maintenance\UpdateRestrictions\doDBUpdates(), MigrateBlocks\doDBUpdates(), MigrateLinksTable\doDBUpdates(), and BenchmarkTruncate\execute().

◆ getDbType()

MediaWiki\Maintenance\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

Note
Subclasses that override this method to return self::DB_NONE should also override canExecuteWithoutLocalSettings() to return true, unless they need the wiki to be set up for reasons beyond access to a database connection.
See also
canExecuteWithoutLocalSettings()
Stability: stable
to override
Returns
int

Definition at line 620 of file Maintenance.php.

Referenced by addDefaultParams(), and finalSetup().

◆ getDir()

MediaWiki\Maintenance\Maintenance::getDir ( )
protected

Get the maintenance directory.

Returns
string

Definition at line 1077 of file Maintenance.php.

◆ getHookContainer()

MediaWiki\Maintenance\Maintenance::getHookContainer ( )
protected

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

Since
1.35
Returns
HookContainer

Definition at line 1559 of file Maintenance.php.

References getServiceContainer().

Referenced by BenchmarkHooks\execute(), and getHookRunner().

◆ getHookRunner()

MediaWiki\Maintenance\Maintenance::getHookRunner ( )
protected

Get a HookRunner for running core hooks.

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

Definition at line 1574 of file Maintenance.php.

References getHookContainer().

◆ getName()

MediaWiki\Maintenance\Maintenance::getName ( )

Get the script's name.

Returns
string

Definition at line 447 of file Maintenance.php.

◆ getOption()

◆ getParameters()

MediaWiki\Maintenance\Maintenance::getParameters ( )
Since
1.39
Returns
MaintenanceParameters

Definition at line 210 of file Maintenance.php.

◆ getPrimaryDB()

◆ getReplicaDB()

MediaWiki\Maintenance\Maintenance::getReplicaDB ( string|false $virtualDomain = false)
protected
Parameters
string | false$virtualDomain
Returns
IReadableDatabase
Since
1.42

Definition at line 1122 of file Maintenance.php.

References return.

Referenced by CleanupWatchlistTemporaryAccountRows\doDBUpdates(), MediaWiki\Maintenance\FixAutoblockLogTitles\doDBUpdates(), and PopulateUserIsTemp\initServices().

◆ getServiceContainer()

◆ getStdin()

MediaWiki\Maintenance\Maintenance::getStdin ( $len = null)
protected

Return input from stdin.

Parameters
int | null$lenThe number of bytes to read. If null, just return the handle. Maintenance::STDIN_ALL returns the full content
Returns
mixed

Definition at line 457 of file Maintenance.php.

◆ getTermSize()

MediaWiki\Maintenance\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 1507 of file Maintenance.php.

References MediaWiki\Message\Message\isDisabled(), and wfIsWindows().

◆ hasArg()

MediaWiki\Maintenance\Maintenance::hasArg ( $argId = 0)
protected

Does a given argument exist?

Parameters
int | string$argIdThe index (from zero) of the argument, or the name declared for the argument by addArg().
Returns
bool

Definition at line 345 of file Maintenance.php.

Referenced by BenchmarkEval\execute().

◆ hasOption()

◆ isQuiet()

MediaWiki\Maintenance\Maintenance::isQuiet ( )
Returns
bool

Definition at line 474 of file Maintenance.php.

Referenced by countDown().

◆ loadParamsAndArgs()

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

Process command line arguments when running as a child script.

Parameters
string | null$selfThe name of the script, if any
array | null$optsAn array of options, in form of key=>value
array | null$argsAn array of command line arguments

Definition at line 836 of file Maintenance.php.

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

◆ loadSpecialVars()

MediaWiki\Maintenance\Maintenance::loadSpecialVars ( )
protected

Handle the special variables that are global to all scripts.

Stability: stable
to override

Definition at line 875 of file Maintenance.php.

References getOption(), and hasOption().

Referenced by loadParamsAndArgs(), and loadWithArgv().

◆ loadWithArgv()

MediaWiki\Maintenance\Maintenance::loadWithArgv ( $argv)

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

Since
1.27
Parameters
array$argvThe argument array, not including the script itself.

Definition at line 813 of file Maintenance.php.

References loadSpecialVars(), and maybeHelp().

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

◆ maybeHelp()

MediaWiki\Maintenance\Maintenance::maybeHelp ( $force = false)
protected

Maybe show the help.

If the help is shown, exit.

Parameters
bool$forceWhether to force the help to show, default false

Definition at line 895 of file Maintenance.php.

References error(), fatalError(), hasOption(), and showHelp().

Referenced by loadWithArgv(), and validateParamsAndArgs().

◆ memoryLimit()

MediaWiki\Maintenance\Maintenance::memoryLimit ( )

Override memory_limit from php.ini on maintenance scripts.

This defaults to max/unlimited, but some scripts may wish to set a lower limit, to avoid blowing up unexpectedly and/or taking available memory for other processes.

Stability: stable
to override
Returns
string|int Must be a shorthand string like "50M", or a number of bytes (-1 for unlimited) passed to ini_set( 'memory_limit' ), or a keyword like "max" (alias for -1) or "default" (alias for leaving memory_limit from php.ini unchanged).

Definition at line 784 of file Maintenance.php.

◆ newBatchIterator()

MediaWiki\Maintenance\Maintenance::newBatchIterator ( $source)
finalprotected

Wrap an entry iterator into a generator that returns batches of said entries.

The batch size is determined by getBatchSize().

Parameters
iterable | Generator | Closure$sourceAn iterable or a callback to get one
Returns
iterable<array> New iterable yielding entry batches from the given iterable
Since
1.44

Definition at line 1372 of file Maintenance.php.

References $source, and getBatchSize().

◆ output()

◆ outputChanneled()

MediaWiki\Maintenance\Maintenance::outputChanneled ( $msg,
$channel = null )

Message outputter with channeled message support.

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

Parameters
string | false$msgThe message without trailing newline
string | null$channelChannel identifier or null for no channel. Channel comparison uses ===.

Definition at line 580 of file Maintenance.php.

References cleanupChanneled().

Referenced by error(), and output().

◆ parseIntList()

MediaWiki\Maintenance\Maintenance::parseIntList ( $text)
protected

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

Since
1.35
Parameters
string$text
Returns
int[]

Definition at line 1591 of file Maintenance.php.

Referenced by MediaWiki\Maintenance\ApplyChangeTag\execute().

◆ posix_isatty()

MediaWiki\Maintenance\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$fdFile descriptor
Returns
bool

Definition at line 1427 of file Maintenance.php.

References posix_isatty().

Referenced by posix_isatty().

◆ prompt()

MediaWiki\Maintenance\Maintenance::prompt ( string $prompt,
?string $default = null )
protected
Parameters
string$promptThe prompt to display to the user
string | null$defaultThe default value to return if the user just presses enter
Returns
string|null
Since
1.43

Definition at line 1636 of file Maintenance.php.

◆ promptYesNo()

MediaWiki\Maintenance\Maintenance::promptYesNo ( $prompt,
$default = null )
protected
Parameters
string$promptThe prompt to display to the user
bool | null$defaultThe default value to return if the user just presses enter
Returns
?bool
Since
1.44

Definition at line 1658 of file Maintenance.php.

◆ purgeRedundantText()

MediaWiki\Maintenance\Maintenance::purgeRedundantText ( $delete = true)

Support function for cleaning up redundant text records.

Parameters
bool$deleteWhether or not to actually delete the records
Author
Rob Church robch.nosp@m.ur@g.nosp@m.mail..nosp@m.com

Definition at line 1009 of file Maintenance.php.

References beginTransactionRound(), commitTransactionRound(), getConfig(), getPrimaryDB(), getServiceContainer(), MediaWiki\MainConfigNames\MiserMode, and output().

◆ readconsole()

MediaWiki\Maintenance\Maintenance::readconsole ( $prompt = ',
'  )
static

Prompt the console for input.

Parameters
string$promptWhat to begin the line with, like '> '
Returns
string|false Response

Definition at line 1440 of file Maintenance.php.

◆ requireExtension()

MediaWiki\Maintenance\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 692 of file Maintenance.php.

◆ requireTestsAutoloader()

MediaWiki\Maintenance\Maintenance::requireTestsAutoloader ( )
static

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

Deprecated
since 1.41. Set the MW_AUTOLOAD_TEST_CLASSES in file scope instead.

Definition at line 1549 of file Maintenance.php.

◆ rollbackTransaction()

MediaWiki\Maintenance\Maintenance::rollbackTransaction ( IDatabase $dbw,
$fname )
protected

Rollback the transaction on a DB handle.

Maintenance scripts should call this method instead of IDatabase::rollback(). Use of this method makes it clear that the caller is a maintenance script, which has the outermost transaction scope needed to explicitly roll back transactions.

Use this method for scripts with direct, straightforward, control of all writes.

Parameters
IDatabase$dbw
string$fnameCaller name
Since
1.27
Deprecated
Since 1.44 Use rollbackTransactionRound() instead

Definition at line 1230 of file Maintenance.php.

References Wikimedia\Rdbms\IDatabase\rollback().

◆ rollbackTransactionRound()

MediaWiki\Maintenance\Maintenance::rollbackTransactionRound ( $fname)
protected

Rollback a transactional batch of DB operations.

Use this method for scripts that split up their work into logical transactions. Note that this does not call ILBfactory::flushPrimarySessions().

See also
ILBfactory::rollbackPrimaryChanges()
Parameters
string$fnameCaller name
Returns
void
Since
1.44

Definition at line 1357 of file Maintenance.php.

◆ setAllowUnregisteredOptions()

MediaWiki\Maintenance\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$allowShould we allow?

Definition at line 327 of file Maintenance.php.

◆ setArg()

MediaWiki\Maintenance\Maintenance::setArg ( $argId,
$value )

Programmatically set the value of the given argument.

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

Since
1.39
Parameters
string | int$argIdArg index or name
mixed | null$value

Definition at line 407 of file Maintenance.php.

References setArg().

Referenced by setArg().

◆ setBatchSize()

◆ setConfig()

MediaWiki\Maintenance\Maintenance::setConfig ( Config $config)
Since
1.24
Parameters
Config$config

Definition at line 679 of file Maintenance.php.

◆ setDB()

MediaWiki\Maintenance\Maintenance::setDB ( IMaintainableDatabase $db)

Sets database object to be returned by getDB().

Stability: stable
to override
Parameters
IMaintainableDatabase$db

Reimplemented in MediaWiki\Maintenance\BackupDumper.

Definition at line 1113 of file Maintenance.php.

◆ setLBFactory()

MediaWiki\Maintenance\Maintenance::setLBFactory ( ILBFactory $lbFactory)
Access: internal
Parameters
ILBFactory$lbFactoryLBFactory to inject in place of the service instance
Returns
void

Definition at line 1152 of file Maintenance.php.

◆ setName()

MediaWiki\Maintenance\Maintenance::setName ( string $name)
Since
1.40
Access: internal
Parameters
string$name

Definition at line 801 of file Maintenance.php.

◆ setOption()

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

Programmatically set the value of the given option.

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

Since
1.39
Parameters
string$name
mixed | null$value

Definition at line 394 of file Maintenance.php.

References setOption().

Referenced by MediaWiki\Maintenance\LoggedUpdateMaintenance\setForce(), and setOption().

◆ setup()

MediaWiki\Maintenance\Maintenance::setup ( )

Provides subclasses with an opportunity to perform initial checks.

Stability: stable
to override

Definition at line 768 of file Maintenance.php.

◆ showHelp()

MediaWiki\Maintenance\Maintenance::showHelp ( )
protected

Definitely show the help.

Does not exit.

Definition at line 919 of file Maintenance.php.

References output().

Referenced by maybeHelp().

◆ supportsOption()

MediaWiki\Maintenance\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$nameThe name of the option
Returns
bool true if the option exists, false otherwise

Definition at line 250 of file Maintenance.php.

Referenced by setBatchSize().

◆ validateParamsAndArgs()

MediaWiki\Maintenance\Maintenance::validateParamsAndArgs ( )

Run some validation checks on the params, etc.

Stability: stable
to override

Definition at line 865 of file Maintenance.php.

References maybeHelp().

◆ validateUserOption()

MediaWiki\Maintenance\Maintenance::validateUserOption ( $errorMsg)
protected
Parameters
string$errorMsgError message to be displayed if neither –user or –userid are passed.
Since
1.37
Returns
User

Definition at line 1609 of file Maintenance.php.

References fatalError(), getOption(), and hasOption().

◆ waitForReplication()

MediaWiki\Maintenance\Maintenance::waitForReplication ( )
protected

Wait for replica DB servers to catch up.

Use this method after performing a batch of autocommit writes inscripts with direct, straightforward, control of all writes.

Note
Since 1.39, this also calls LBFactory::autoReconfigure().
Returns
bool Whether the replication wait succeeded
Since
1.36
Deprecated
Since 1.44 Batch writes and use commitTransactionRound() instead

Definition at line 1268 of file Maintenance.php.

References MediaWiki\MediaWikiEntryPoint\emitBufferedStats(), and getServiceContainer().

Referenced by commitTransaction(), and MediaWiki\Maintenance\DeleteLocalPasswords\processUsers().

Member Data Documentation

◆ $fileHandle

resource null MediaWiki\Maintenance\Maintenance::$fileHandle

Used when creating separate schema files.

Definition at line 146 of file Maintenance.php.

◆ $mArgs

array MediaWiki\Maintenance\Maintenance::$mArgs = []
protected

This is the list of arguments that were actually passed.

Deprecated
since 1.39, use {
See also
addArg} instead.

Definition at line 103 of file Maintenance.php.

◆ $mBatchSize

int null MediaWiki\Maintenance\Maintenance::$mBatchSize = null
protected

Batch size.

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

Definition at line 131 of file Maintenance.php.

◆ $mDbPass

string MediaWiki\Maintenance\Maintenance::$mDbPass = null
protected

Definition at line 111 of file Maintenance.php.

◆ $mDbUser

string MediaWiki\Maintenance\Maintenance::$mDbUser = null
protected

Definition at line 110 of file Maintenance.php.

◆ $mDescription

string MediaWiki\Maintenance\Maintenance::$mDescription = ''
protected

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

Deprecated
since 1.39, use {
See also
addDescription} instead.

Definition at line 117 of file Maintenance.php.

◆ $mInputLoaded

bool MediaWiki\Maintenance\Maintenance::$mInputLoaded = false
protected

Have we already loaded our user input?

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

Definition at line 123 of file Maintenance.php.

◆ $mOptions

array MediaWiki\Maintenance\Maintenance::$mOptions = []
protected

This is the list of options that were actually passed.

Deprecated
since 1.39, use {
See also
addOption} instead.

Definition at line 97 of file Maintenance.php.

◆ $mParams

array [] MediaWiki\Maintenance\Maintenance::$mParams = []
protected

Empty.

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

Definition at line 91 of file Maintenance.php.

◆ $mQuiet

bool MediaWiki\Maintenance\Maintenance::$mQuiet = false
protected

Special vars for params that are always used.

Definition at line 109 of file Maintenance.php.

◆ $mSelf

string null MediaWiki\Maintenance\Maintenance::$mSelf
protected

Name of the script currently running.

Definition at line 106 of file Maintenance.php.

◆ $orderedOptions

array MediaWiki\Maintenance\Maintenance::$orderedOptions = []

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

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

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

Deprecated
since 1.39, use $this->getParameters()->getOptionsSequence() instead.

Definition at line 179 of file Maintenance.php.

Referenced by MediaWiki\Maintenance\BackupDumper\processOptions().

◆ $parameters

MaintenanceParameters MediaWiki\Maintenance\Maintenance::$parameters
protected

Definition at line 83 of file Maintenance.php.

◆ DB_ADMIN

const MediaWiki\Maintenance\Maintenance::DB_ADMIN = 2

Definition at line 71 of file Maintenance.php.

◆ DB_NONE

const MediaWiki\Maintenance\Maintenance::DB_NONE = 0

Constants for DB access type.

See also
Maintenance::getDbType()

Definition at line 69 of file Maintenance.php.

◆ DB_STD

const MediaWiki\Maintenance\Maintenance::DB_STD = 1

Definition at line 70 of file Maintenance.php.

◆ GENERIC_MAINTENANCE_PARAMETERS

const MediaWiki\Maintenance\Maintenance::GENERIC_MAINTENANCE_PARAMETERS = 'Script runner options'

◆ SCRIPT_DEPENDENT_PARAMETERS

const MediaWiki\Maintenance\Maintenance::SCRIPT_DEPENDENT_PARAMETERS = 'Common options'

Definition at line 77 of file Maintenance.php.

◆ STDIN_ALL

const MediaWiki\Maintenance\Maintenance::STDIN_ALL = -1

Definition at line 74 of file Maintenance.php.


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