MediaWiki  master
BackupDumper Class Reference
Inheritance diagram for BackupDumper:
Collaboration diagram for BackupDumper:

Public Member Functions

 __construct ( $args=null)
 
 __destruct ()
 
 dump ( $history, $text=WikiExporter::TEXT)
 
 execute ()
 Do the actual work. More...
 
 finalSetup (SettingsBuilder $settingsBuilder=null)
 Handle some last-minute setup here. More...
 
 initProgress ( $history=WikiExporter::FULL)
 Initialise starting time and maximum revision count. More...
 
 loadPlugin ( $class, $file)
 Load a plugin and register it. More...
 
 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. More...
 
 showReport ()
 
- Public Member Functions inherited from Maintenance
 __construct ()
 Default constructor. More...
 
 checkRequiredExtensions ()
 Verify that the required extensions are installed. More...
 
 cleanupChanneled ()
 Clean up channeled output. More...
 
 clearParamsAndArgs ()
 Clear all params and arguments. More...
 
 getConfig ()
 
 getDbType ()
 Does the script need different DB access? By default, we give Maintenance scripts normal rights to the DB. More...
 
 getName ()
 Get the script's name. More...
 
 getParameters ()
 
 globals ()
 Potentially debug globals. More...
 
 isQuiet ()
 
 loadParamsAndArgs ( $self=null, $opts=null, $args=null)
 Process command line arguments. More...
 
 loadSettings ()
 
 loadWithArgv ( $argv)
 Load params and arguments from a given array of command-line arguments. More...
 
 memoryLimit ()
 Normally we disable the memory_limit when running admin scripts. More...
 
 outputChanneled ( $msg, $channel=null)
 Message outputter with channeled message support. More...
 
 purgeRedundantText ( $delete=true)
 Support function for cleaning up redundant text records. More...
 
 runChild ( $maintClass, $classFile=null)
 Run a child maintenance script. More...
 
 setAgentAndTriggers ()
 This method used to be for internal use by doMaintenance.php to apply some optional global state to LBFactory for debugging purposes. More...
 
 setArg ( $argId, $value)
 Programmatically set the value of the given argument. More...
 
 setConfig (Config $config)
 
 setOption (string $name, $value)
 Programmatically set the value of the given option. More...
 
 setup ()
 Do some checking and basic setup. More...
 
 shutdown ()
 Call before exiting CLI process for the last DB commit, and flush any remaining buffers and other deferred work. More...
 
 validateParamsAndArgs ()
 Run some validation checks on the params, etc. More...
 

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 More...
 
bool $reporting = true
 
int $revEndId = 0
 
int $revStartId = 0
 
bool $skipFooter = false
 don't output </mediawiki> More...
 
bool $skipHeader = false
 don't output <mediawiki> and <siteinfo> More...
 
int $startId = 0
 
resource false $stderr
 
- Public Attributes inherited from Maintenance
resource null $fileHandle
 Used when creating separate schema files. More...
 
 $mDbPass
 
array $orderedOptions = []
 Used to read the options in the order they were passed. More...
 
const DB_ADMIN = 2
 
const DB_NONE = 0
 Constants for DB access type. More...
 
const DB_STD = 1
 
const GENERIC_MAINTENANCE_PARAMETERS = 'Generic maintenance parameters'
 
const SCRIPT_DEPENDENT_PARAMETERS = 'Script dependent parameters'
 
const STDIN_ALL = -1
 

Protected Member Functions

 backupDb ()
 
 backupServer ()
 
 processOptions ()
 Processes arguments and sets $this->$sink accordingly. More...
 
 progress ( $string)
 
- Protected Member Functions inherited from Maintenance
 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 ()
 Override to perform any required operation at the end of initialisation. More...
 
 beginTransaction (IDatabase $dbw, $fname)
 Begin a transaction on a DB. More...
 
 commitTransaction (IDatabase $dbw, $fname)
 Commit the transaction on a DB handle and wait for replica DBs to catch up. More...
 
 countDown ( $seconds)
 Count down from $seconds to zero on the terminal, with a one-second pause between showing each number. More...
 
 deleteOption ( $name)
 Remove an option. More...
 
 error ( $err, $die=0)
 Throw an error to the user. More...
 
 fatalError ( $msg, $exitCode=1)
 Output a message and terminate the current script. More...
 
 getArg ( $argId=0, $default=null)
 Get an argument. More...
 
 getBatchSize ()
 Returns batch size. More...
 
 getDB ( $db, $groups=[], $dbDomain=false)
 Returns a database to be used by current maintenance script. More...
 
 getDir ()
 Get the maintenance directory. More...
 
 getHookContainer ()
 Get a HookContainer, for running extension hooks or for hook metadata. More...
 
 getHookRunner ()
 Get a HookRunner for running core hooks. More...
 
 getOption ( $name, $default=null)
 Get an option, or return the default. More...
 
 getStdin ( $len=null)
 Return input from stdin. More...
 
 hasArg ( $argId=0)
 Does a given argument exist? More...
 
 hasOption ( $name)
 Checks to see if a particular option was set. More...
 
 loadSpecialVars ()
 Handle the special variables that are global to all scripts. More...
 
 maybeHelp ( $force=false)
 Maybe show the help. More...
 
 output ( $out, $channel=null)
 Throw some output to the user. More...
 
 parseIntList ( $text)
 Utility function to parse a string (perhaps from a command line option) into a list of integers (perhaps some kind of numeric IDs). More...
 
 requireExtension ( $name)
 Indicate that the specified extension must be loaded before the script can run. More...
 
 rollbackTransaction (IDatabase $dbw, $fname)
 Rollback the transaction on a DB handle. More...
 
 setAllowUnregisteredOptions ( $allow)
 Sets whether to allow unregistered options, which are options passed to a script that do not match an expected parameter. More...
 
 setBatchSize ( $s=0)
 
 showHelp ()
 Definitely show the help. More...
 
 supportsOption ( $name)
 Checks to see if a particular option in supported. More...
 
 validateUserOption ( $errorMsg)
 
 waitForReplication ()
 Wait for replica DBs to catch up. More...
 

Protected Attributes

bool $atStart
 
string $buffer
 
ExportProgressFilter $egress
 
string[] $filterTypes = []
 
IMaintainableDatabase null $forcedDb = null
 The dependency-injected database to use. More...
 
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 More...
 
string null $server = null
 null means use default More...
 
DumpMultiWriter DumpOutput null $sink = null
 Output filters. More...
 
float $startTime
 
string $state
 
string null $thisRevFormat
 
string null $thisRevModel
 
float $timeOfCheckpoint
 
- Protected Attributes inherited from Maintenance
array $mArgList = []
 Empty. More...
 
array $mArgs = []
 This is the list of arguments that were actually passed. More...
 
int null $mBatchSize = null
 Batch size. More...
 
 $mDbUser
 
string $mDescription = ''
 A description of the script, children should change this via addDescription() More...
 
bool $mInputLoaded = false
 Have we already loaded our user input? More...
 
array $mOptions = []
 This is the list of options that were actually passed. More...
 
array[] $mParams = []
 Empty. More...
 
bool $mQuiet = false
 Special vars for params that are always used. More...
 
string null $mSelf
 Name of the script currently running. More...
 
MaintenanceParameters $parameters
 

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). More...
 
static posix_isatty ( $fd)
 Wrapper for posix_isatty() We default as considering stdin a tty (for nice readline methods) but treating stout as not a tty to avoid color codes. More...
 
static readconsole ( $prompt='> ')
 Prompt the console for input. More...
 
static requireTestsAutoloader ()
 Call this to set up the autoloader to allow classes to be used from the tests directory. More...
 
static shouldExecute ()
 

Detailed Description

Definition at line 41 of file BackupDumper.php.

Constructor & Destructor Documentation

◆ __construct()

BackupDumper::__construct (   $args = null)
Parameters
array | null$argsFor backward compatibility

Reimplemented in TextPassDumper, and DumpBackup.

Definition at line 138 of file BackupDumper.php.

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

◆ __destruct()

BackupDumper::__destruct ( )

Definition at line 430 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 403 of file BackupDumper.php.

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

Referenced by dump().

◆ backupServer()

BackupDumper::backupServer ( )
protected

Definition at line 436 of file BackupDumper.php.

References $wgDBserver.

◆ dump()

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

◆ 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 TextPassDumper, and DumpBackup.

Definition at line 219 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 179 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$historyWikiExporter::CURRENT or WikiExporter::FULL

Reimplemented in TextPassDumper.

Definition at line 383 of file BackupDumper.php.

References $dbr, $forcedDb, $startTime, WikiExporter\CURRENT, DB_REPLICA, and Maintenance\getDB().

Referenced by dump().

◆ loadPlugin()

BackupDumper::loadPlugin (   $class,
  $file 
)

Load a plugin and register it.

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

Definition at line 211 of file BackupDumper.php.

References $file.

Referenced by processOptions().

◆ processOptions()

BackupDumper::processOptions ( )
protected

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

Reimplemented in TextPassDumper, and DumpBackup.

Definition at line 226 of file BackupDumper.php.

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

Referenced by __construct().

◆ progress()

◆ registerFilter()

BackupDumper::registerFilter (   $name,
  $class 
)
Parameters
string$name
string$className of filter plugin class

Definition at line 200 of file BackupDumper.php.

Referenced by __construct().

◆ registerOutput()

BackupDumper::registerOutput (   $name,
  $class 
)
Parameters
string$name
string$className of output filter plugin class

Definition at line 192 of file BackupDumper.php.

Referenced by __construct().

◆ report()

BackupDumper::report (   $final = false)

Definition at line 451 of file BackupDumper.php.

References revCount(), and showReport().

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

◆ reportPage()

BackupDumper::reportPage ( )

Definition at line 442 of file BackupDumper.php.

◆ revCount()

BackupDumper::revCount ( )

Definition at line 446 of file BackupDumper.php.

References report().

Referenced by report(), 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$dbThe database connection to use

Reimplemented from Maintenance.

Definition at line 425 of file BackupDumper.php.

◆ showReport()

BackupDumper::showReport ( )

Member Data Documentation

◆ $atStart

bool BackupDumper::$atStart
protected

Definition at line 113 of file BackupDumper.php.

◆ $buffer

string BackupDumper::$buffer
protected

Definition at line 109 of file BackupDumper.php.

◆ $dumpUploadFileContents

bool BackupDumper::$dumpUploadFileContents = false

Definition at line 61 of file BackupDumper.php.

Referenced by dump().

◆ $dumpUploads

bool BackupDumper::$dumpUploads = false

Definition at line 59 of file BackupDumper.php.

Referenced by dump().

◆ $egress

ExportProgressFilter BackupDumper::$egress
protected

Definition at line 107 of file BackupDumper.php.

◆ $endId

int BackupDumper::$endId = 0

Definition at line 53 of file BackupDumper.php.

◆ $filterTypes

string [] BackupDumper::$filterTypes = []
protected

Definition at line 91 of file BackupDumper.php.

◆ $forcedDb

IMaintainableDatabase null BackupDumper::$forcedDb = null
protected

The dependency-injected database to use.

See also
self::setDB

Definition at line 130 of file BackupDumper.php.

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

◆ $ID

int BackupDumper::$ID = 0
protected

Definition at line 94 of file BackupDumper.php.

◆ $lastName

string BackupDumper::$lastName
protected

Definition at line 119 of file BackupDumper.php.

◆ $lastTime

float BackupDumper::$lastTime = 0
protected

◆ $lb

LoadBalancer BackupDumper::$lb
protected

Definition at line 133 of file BackupDumper.php.

◆ $limitNamespaces

array null BackupDumper::$limitNamespaces = []

Definition at line 65 of file BackupDumper.php.

◆ $maxCount

int BackupDumper::$maxCount
protected

Definition at line 103 of file BackupDumper.php.

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

◆ $openElement

array false BackupDumper::$openElement
protected

Definition at line 111 of file BackupDumper.php.

◆ $orderRevs

bool BackupDumper::$orderRevs = false

Definition at line 63 of file BackupDumper.php.

◆ $outputTypes

string [] BackupDumper::$outputTypes = []
protected

Definition at line 89 of file BackupDumper.php.

◆ $pageCount

int BackupDumper::$pageCount = 0
protected

Definition at line 72 of file BackupDumper.php.

◆ $pageCountLast

int BackupDumper::$pageCountLast = 0
protected

Definition at line 84 of file BackupDumper.php.

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

◆ $pageCountPart

int BackupDumper::$pageCountPart
protected

Definition at line 99 of file BackupDumper.php.

◆ $pages

string [] null BackupDumper::$pages = null

null means all pages

Definition at line 45 of file BackupDumper.php.

Referenced by DumpBackup\processOptions().

◆ $reporting

bool BackupDumper::$reporting = true

Definition at line 43 of file BackupDumper.php.

◆ $reportingInterval

int BackupDumper::$reportingInterval = 100
protected

Definition at line 70 of file BackupDumper.php.

◆ $revCount

int BackupDumper::$revCount = 0
protected

Definition at line 74 of file BackupDumper.php.

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

◆ $revCountLast

int BackupDumper::$revCountLast = 0
protected

Definition at line 86 of file BackupDumper.php.

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

◆ $revCountPart

int BackupDumper::$revCountPart
protected

Definition at line 101 of file BackupDumper.php.

◆ $revEndId

int BackupDumper::$revEndId = 0

Definition at line 57 of file BackupDumper.php.

◆ $revStartId

int BackupDumper::$revStartId = 0

Definition at line 55 of file BackupDumper.php.

◆ $schemaVersion

string null BackupDumper::$schemaVersion = null
protected

null means use default

Definition at line 76 of file BackupDumper.php.

Referenced by finalSetup().

◆ $server

string null BackupDumper::$server = null
protected

null means use default

Definition at line 78 of file BackupDumper.php.

◆ $sink

DumpMultiWriter DumpOutput null BackupDumper::$sink = null
protected

Output filters.

Definition at line 80 of file BackupDumper.php.

Referenced by processOptions().

◆ $skipFooter

bool BackupDumper::$skipFooter = false

don't output </mediawiki>

Definition at line 49 of file BackupDumper.php.

◆ $skipHeader

bool BackupDumper::$skipHeader = false

don't output <mediawiki> and <siteinfo>

Definition at line 47 of file BackupDumper.php.

◆ $startId

int BackupDumper::$startId = 0

Definition at line 51 of file BackupDumper.php.

◆ $startTime

float BackupDumper::$startTime
protected

◆ $state

string BackupDumper::$state
protected

Definition at line 121 of file BackupDumper.php.

◆ $stderr

resource false BackupDumper::$stderr

Definition at line 67 of file BackupDumper.php.

◆ $thisRevFormat

string null BackupDumper::$thisRevFormat
protected

Definition at line 117 of file BackupDumper.php.

◆ $thisRevModel

string null BackupDumper::$thisRevModel
protected

Definition at line 115 of file BackupDumper.php.

◆ $timeOfCheckpoint

float BackupDumper::$timeOfCheckpoint
protected

Definition at line 105 of file BackupDumper.php.


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