Inherited by DumpBackup, and TextPassDumper.

Collaboration diagram for BackupDumper:

[legend]

Public Member Functions
	__construct ( $args=null)

	__destruct ()

	dump ( $history, $text=WikiExporter::TEXT)

	execute ()
	Do the actual work.

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

	initProgress ( $history=WikiExporter::FULL)
	Initialise starting time and maximum revision count.

	loadPlugin ( $class, $file)
	Load a plugin and register it.

	registerFilter ( $name, $class)

	registerOutput ( $name, $class)

	report ( $final=false)

	reportPage ()

	revCount ()

	setDB (IMaintainableDatabase $db)
	Force the dump to use the provided database connection for database operations, wherever possible.

	showReport ()

Public Member Functions inherited from Maintenance
	__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.

	getConfig ()

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

	getName ()
	Get the script's name.

	getParameters ()

	globals ()
	Potentially debug globals.

	isQuiet ()

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

	loadSettings ()

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

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

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

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

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

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

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

	setConfig (Config $config)

	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.

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

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

Public Attributes
bool	$dumpUploadFileContents = false

bool	$dumpUploads = false

int	$endId = 0

array null	$limitNamespaces = []

bool	$orderRevs = false

string[] null	$pages = null
	null means all pages

bool	$reporting = true

int	$revEndId = 0

int	$revStartId = 0

bool	$skipFooter = false
	don't output </mediawiki>

bool	$skipHeader = false
	don't output <mediawiki> and <siteinfo>

int	$startId = 0

resource false	$stderr

Public Attributes inherited from Maintenance
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
	backupDb ()

	backupServer ()

	processOptions ()
	Processes arguments and sets $this->$sink accordingly.

	progress ( $string)

Protected Member Functions inherited from Maintenance
	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.

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

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

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

	commitTransaction (IDatabase $dbw, $fname)
	Commit the transaction on a DB handle and wait for replica DBs 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, $die=0)
	Throw an error to the user.

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

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

	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.

	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.

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

	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.

	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 DBs to catch up.

Protected Attributes
bool	$atStart

string	$buffer

ExportProgressFilter	$egress

string[]	$filterTypes = []

IMaintainableDatabase null	$forcedDb = null
	The dependency-injected database to use.

int	$ID = 0

string	$lastName

float	$lastTime = 0

LoadBalancer	$lb

int	$maxCount

array false	$openElement

string[]	$outputTypes = []

int	$pageCount = 0

int	$pageCountLast = 0

int	$pageCountPart

int	$reportingInterval = 100

int	$revCount = 0

int	$revCountLast = 0

int	$revCountPart

string null	$schemaVersion = null
	null means use default

string null	$server = null
	null means use default

DumpMultiWriter DumpOutput null	$sink = null
	Output filters.

float	$startTime

string	$state

string null	$thisRevFormat

string null	$thisRevModel

float	$timeOfCheckpoint

Protected Attributes inherited from Maintenance
array	$mArgList = []
	Empty.

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

int null	$mBatchSize = null
	Batch size.

	$mDbPass

	$mDbUser

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

Additional Inherited Members
Static Public Member Functions inherited from Maintenance
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.

static	shouldExecute ()

Detailed Description

Definition at line 42 of file BackupDumper.php.

Constructor & Destructor Documentation

◆ __construct()

BackupDumper::__construct ( $args = null )

Parameters

array | null $args For backward compatibility

Reimplemented in DumpBackup, and TextPassDumper.

Definition at line 139 of file BackupDumper.php.

References Maintenance\addOption(), Maintenance\loadWithArgv(), processOptions(), registerFilter(), and registerOutput().

◆ __destruct()

BackupDumper::__destruct ( )

Definition at line 431 of file BackupDumper.php.

Member Function Documentation

◆ backupDb()

BackupDumper::backupDb ( )

protected

Todo: Fixme: the –server parameter is currently not respected, as it doesn't seem terribly easy to ask the load balancer for a particular connection by name.

Returns: IMaintainableDatabase

Definition at line 404 of file BackupDumper.php.

References $forcedDb, DB_REPLICA, and Wikimedia\Rdbms\IDatabase\setSessionOptions().

Referenced by dump().

◆ backupServer()

BackupDumper::backupServer ( )

protected

Definition at line 437 of file BackupDumper.php.

References $wgDBserver.

◆ dump()

BackupDumper::dump	(		$history,
			$text = WikiExporter::TEXT )

Reimplemented in TextPassDumper.

Definition at line 323 of file BackupDumper.php.

References $dumpUploadFileContents, $dumpUploads, backupDb(), initProgress(), and report().

Referenced by DumpBackup\__construct(), and DumpBackup\execute().

◆ execute()

BackupDumper::execute ( )

Do the actual work.

All child classes will need to implement this

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

Reimplemented from Maintenance.

Reimplemented in DumpBackup, and TextPassDumper.

Definition at line 220 of file BackupDumper.php.

◆ finalSetup()

BackupDumper::finalSetup ( SettingsBuilder $settingsBuilder = null )

Handle some last-minute setup here.

Stability: stable: to override

Parameters

SettingsBuilder | null $settingsBuilder

Reimplemented from Maintenance.

Reimplemented in TextPassDumper.

Definition at line 180 of file BackupDumper.php.

References $schemaVersion, and Maintenance\addOption().

◆ initProgress()

BackupDumper::initProgress ( $history = WikiExporter::FULL )

Initialise starting time and maximum revision count.

We'll make ETA calculations based an progress, assuming relatively constant per-revision rate.

Parameters

int $history WikiExporter::CURRENT or WikiExporter::FULL

Reimplemented in TextPassDumper.

Definition at line 384 of file BackupDumper.php.

References $dbr, $forcedDb, $startTime, DB_REPLICA, and getDB().

Referenced by dump().

◆ loadPlugin()

BackupDumper::loadPlugin	(		$class,
			$file )

Load a plugin and register it.

Parameters

string	$class	Name of plugin class; must have a static 'register' method that takes a BackupDumper as a parameter.
string	$file	Full or relative path to the PHP file to load, or empty

Definition at line 212 of file BackupDumper.php.

References $file.

Referenced by processOptions().

◆ processOptions()

BackupDumper::processOptions ( )

protected

Processes arguments and sets $this->$sink accordingly.

Reimplemented in DumpBackup, and TextPassDumper.

Definition at line 227 of file BackupDumper.php.

References $file, Maintenance\$orderedOptions, $sink, $type, Maintenance\fatalError(), Maintenance\getOption(), Maintenance\hasOption(), and loadPlugin().

Referenced by __construct().

◆ progress()

BackupDumper::progress ( $string )

protected

Definition at line 499 of file BackupDumper.php.

Referenced by DumpBackup\__construct(), TextPassDumper\__construct(), TextPassDumper\dump(), TextPassDumper\getText(), TextPassDumper\openSpawn(), showReport(), and TextPassDumper\showReport().

◆ registerFilter()

BackupDumper::registerFilter	(		$name,
			$class )

Parameters

string	$name
string	$class	Name of filter plugin class

Definition at line 201 of file BackupDumper.php.

Referenced by __construct().

◆ registerOutput()

BackupDumper::registerOutput	(		$name,
			$class )

Parameters

string	$name
string	$class	Name of output filter plugin class

Definition at line 193 of file BackupDumper.php.

Referenced by __construct().

◆ report()

BackupDumper::report ( $final = false )

Definition at line 452 of file BackupDumper.php.

References revCount(), and showReport().

Referenced by dump(), TextPassDumper\dump(), and revCount().

◆ reportPage()

BackupDumper::reportPage ( )

Definition at line 443 of file BackupDumper.php.

◆ revCount()

BackupDumper::revCount ( )

Definition at line 447 of file BackupDumper.php.

References report(), and revCount().

Referenced by report(), revCount(), showReport(), and TextPassDumper\showReport().

◆ setDB()

BackupDumper::setDB ( IMaintainableDatabase $db )

Force the dump to use the provided database connection for database operations, wherever possible.

Parameters

IMaintainableDatabase $db The database connection to use

Reimplemented from Maintenance.

Definition at line 426 of file BackupDumper.php.

◆ showReport()

BackupDumper::showReport ( )

Reimplemented in TextPassDumper.

Definition at line 458 of file BackupDumper.php.

References $lastTime, $maxCount, $pageCountLast, $revCount, $revCountLast, $startTime, progress(), revCount(), and wfTimestamp().

Referenced by report().

Member Data Documentation

◆ $atStart

bool BackupDumper::$atStart

protected

Definition at line 114 of file BackupDumper.php.

◆ $buffer

string BackupDumper::$buffer

protected

Definition at line 110 of file BackupDumper.php.

◆ $dumpUploadFileContents

bool BackupDumper::$dumpUploadFileContents = false

Definition at line 62 of file BackupDumper.php.

Referenced by dump().

◆ $dumpUploads

bool BackupDumper::$dumpUploads = false

Definition at line 60 of file BackupDumper.php.

Referenced by dump().

◆ $egress

ExportProgressFilter BackupDumper::$egress

protected

Definition at line 108 of file BackupDumper.php.

◆ $endId

int BackupDumper::$endId = 0

Definition at line 54 of file BackupDumper.php.

◆ $filterTypes

string [] BackupDumper::$filterTypes = []

protected

Definition at line 92 of file BackupDumper.php.

◆ $forcedDb

IMaintainableDatabase null BackupDumper::$forcedDb = null

protected

The dependency-injected database to use.

See also: self::setDB

Definition at line 131 of file BackupDumper.php.

Referenced by backupDb(), initProgress(), and TextPassDumper\rotateDb().

◆ $ID

int BackupDumper::$ID = 0

protected

Definition at line 95 of file BackupDumper.php.

◆ $lastName

string BackupDumper::$lastName

protected

Definition at line 120 of file BackupDumper.php.

◆ $lastTime

float BackupDumper::$lastTime = 0

protected

Definition at line 83 of file BackupDumper.php.

Referenced by TextPassDumper\endElement(), showReport(), and TextPassDumper\showReport().

◆ $lb

LoadBalancer BackupDumper::$lb

protected

Definition at line 134 of file BackupDumper.php.

◆ $limitNamespaces

array null BackupDumper::$limitNamespaces = []

Definition at line 66 of file BackupDumper.php.

◆ $maxCount

int BackupDumper::$maxCount

protected

Definition at line 104 of file BackupDumper.php.

Referenced by showReport(), and TextPassDumper\showReport().

◆ $openElement

array false BackupDumper::$openElement

protected

Definition at line 112 of file BackupDumper.php.

◆ $orderRevs

bool BackupDumper::$orderRevs = false

Definition at line 64 of file BackupDumper.php.

◆ $outputTypes

string [] BackupDumper::$outputTypes = []

protected

Definition at line 90 of file BackupDumper.php.

◆ $pageCount

int BackupDumper::$pageCount = 0

protected

Definition at line 73 of file BackupDumper.php.

◆ $pageCountLast

int BackupDumper::$pageCountLast = 0

protected

Definition at line 85 of file BackupDumper.php.

Referenced by showReport(), and TextPassDumper\showReport().

◆ $pageCountPart

int BackupDumper::$pageCountPart

protected

Definition at line 100 of file BackupDumper.php.

◆ $pages

string [] null BackupDumper::$pages = null

null means all pages

Definition at line 46 of file BackupDumper.php.

Referenced by DumpBackup\processOptions().

◆ $reporting

bool BackupDumper::$reporting = true

Definition at line 44 of file BackupDumper.php.

◆ $reportingInterval

int BackupDumper::$reportingInterval = 100

protected

Definition at line 71 of file BackupDumper.php.

◆ $revCount

int BackupDumper::$revCount = 0

protected

Definition at line 75 of file BackupDumper.php.

Referenced by showReport(), and TextPassDumper\showReport().

◆ $revCountLast

int BackupDumper::$revCountLast = 0

protected

Definition at line 87 of file BackupDumper.php.

Referenced by showReport(), and TextPassDumper\showReport().

◆ $revCountPart

int BackupDumper::$revCountPart

protected

Definition at line 102 of file BackupDumper.php.

◆ $revEndId

int BackupDumper::$revEndId = 0

Definition at line 58 of file BackupDumper.php.

◆ $revStartId

int BackupDumper::$revStartId = 0

Definition at line 56 of file BackupDumper.php.

◆ $schemaVersion

string null BackupDumper::$schemaVersion = null

protected

null means use default

Definition at line 77 of file BackupDumper.php.

Referenced by finalSetup().

◆ $server

string null BackupDumper::$server = null

protected

null means use default

Definition at line 79 of file BackupDumper.php.

◆ $sink

DumpMultiWriter DumpOutput null BackupDumper::$sink = null

protected

Output filters.

Definition at line 81 of file BackupDumper.php.

Referenced by processOptions().

◆ $skipFooter

bool BackupDumper::$skipFooter = false

don't output </mediawiki>

Definition at line 50 of file BackupDumper.php.

◆ $skipHeader

bool BackupDumper::$skipHeader = false

don't output <mediawiki> and <siteinfo>

Definition at line 48 of file BackupDumper.php.

◆ $startId

int BackupDumper::$startId = 0

Definition at line 52 of file BackupDumper.php.

◆ $startTime

float BackupDumper::$startTime

protected

Definition at line 98 of file BackupDumper.php.

Referenced by initProgress(), TextPassDumper\initProgress(), showReport(), and TextPassDumper\showReport().

◆ $state

string BackupDumper::$state

protected

Definition at line 122 of file BackupDumper.php.

◆ $stderr

resource false BackupDumper::$stderr

Definition at line 68 of file BackupDumper.php.

◆ $thisRevFormat

string null BackupDumper::$thisRevFormat

protected

Definition at line 118 of file BackupDumper.php.

◆ $thisRevModel

string null BackupDumper::$thisRevModel

protected

Definition at line 116 of file BackupDumper.php.

◆ $timeOfCheckpoint

float BackupDumper::$timeOfCheckpoint

protected

Definition at line 106 of file BackupDumper.php.

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

maintenance/includes/BackupDumper.php

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

◆ __destruct()

Member Function Documentation

◆ backupDb()

◆ backupServer()

◆ dump()

◆ execute()

◆ finalSetup()

◆ initProgress()

◆ loadPlugin()

◆ processOptions()

◆ progress()

◆ registerFilter()

◆ registerOutput()

◆ report()

◆ reportPage()

◆ revCount()

◆ setDB()

◆ showReport()

Member Data Documentation

◆ $atStart

◆ $buffer

◆ $dumpUploadFileContents

◆ $dumpUploads

◆ $egress

◆ $endId

◆ $filterTypes

◆ $forcedDb

◆ $ID

◆ $lastName

◆ $lastTime

◆ $lb

◆ $limitNamespaces

◆ $maxCount

◆ $openElement

◆ $orderRevs

◆ $outputTypes

◆ $pageCount

◆ $pageCountLast

◆ $pageCountPart

◆ $pages

◆ $reporting

◆ $reportingInterval

◆ $revCount

◆ $revCountLast

◆ $revCountPart

◆ $revEndId

◆ $revStartId

◆ $schemaVersion

◆ $server

◆ $sink

◆ $skipFooter

◆ $skipHeader

◆ $startId

◆ $startTime

◆ $state

◆ $stderr

◆ $thisRevFormat

◆ $thisRevModel

◆ $timeOfCheckpoint