Collaboration diagram for TextPassDumper:

[legend]

Public Member Functions
	__construct ( $args=null)

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

	execute ()
	Do the actual work.

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

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

	showReport ()
	Overridden to include prefetch ratio if enabled.

Public Member Functions inherited from BackupDumper
	__destruct ()

	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.

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

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

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

	setConfig (Config $config)

	setDBProvider (IConnectionProvider $dbProvider)

	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.

Public Attributes
int	$maxTimeAllowed = 0
	when we spend more than maxTimeAllowed seconds on this run, we continue processing until we write out the next complete page, then save output file(s), rename it/them and open new one(s); 0 = no limit

BaseDump null	$prefetch = null

Public Attributes inherited from BackupDumper
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
	characterData ( $parser, $data)

	clearOpenElement ( $style)

	endElement ( $parser, $name)

	getText ( $id, $model=null, $format=null, $expSize=null)
	Tries to load revision text.

	openSpawn ()

	processFileOpt ( $opt)

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

	readDump ( $input)

	rotateDb ()
	Drop the database connection $this->db and try to get a new one.

	startElement ( $parser, $name, $attribs)

Protected Member Functions inherited from BackupDumper
	backupDb ()

	backupServer ()

	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.

	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.

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

	getReplicaDB ()

	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.

	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
int	$bufferSize = 524_288
	In bytes.

string[]	$checkpointFiles = []

bool	$checkpointJustWritten = false

IMaintainableDatabase	$db

int	$failureTimeout = 5
	Seconds to sleep after db failure.

int	$fetchCount = 0

int	$fetchCountLast = 0

string false	$firstPageWritten = false

int	$history = WikiExporter::FULL

string	$input = "php://stdin"

string false	$lastPageWritten = false

int	$maxConsecutiveFailedTextRetrievals = 200

int	$maxFailures = 5

array	$php = [ PHP_BINARY ]

int	$prefetchCount = 0

int	$prefetchCountLast = 0

bool	$spawn = false

resource false	$spawnErr = false

resource false	$spawnProc = false

resource null	$spawnRead

resource null	$spawnWrite

bool	$timeExceeded = false

XmlDumpWriter false	$xmlwriterobj = false

Protected Attributes inherited from BackupDumper
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	$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

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.

Detailed Description

Definition at line 44 of file TextPassDumper.php.

Constructor & Destructor Documentation

◆ __construct()

TextPassDumper::__construct ( $args = null )

Parameters

array | null $args For backward compatibility

Reimplemented from BackupDumper.

Definition at line 133 of file TextPassDumper.php.

References Maintenance\addDescription(), Maintenance\addOption(), Maintenance\loadWithArgv(), Maintenance\output(), processOptions(), and BackupDumper\progress().

Member Function Documentation

◆ characterData()

TextPassDumper::characterData	(		$parser,
			$data )

protected

Definition at line 1035 of file TextPassDumper.php.

References clearOpenElement().

Referenced by startElement().

◆ clearOpenElement()

TextPassDumper::clearOpenElement ( $style )

protected

Definition at line 1067 of file TextPassDumper.php.

Referenced by characterData(), endElement(), and startElement().

◆ dump()

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

Reimplemented from BackupDumper.

Definition at line 285 of file TextPassDumper.php.

References $input, initProgress(), BackupDumper\progress(), readDump(), BackupDumper\report(), and rotateDb().

Referenced by execute().

◆ endElement()

TextPassDumper::endElement	(		$parser,
			$name )

protected

Definition at line 974 of file TextPassDumper.php.

References BackupDumper\$lastTime, and clearOpenElement().

◆ execute()

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

Definition at line 184 of file TextPassDumper.php.

References dump(), and processOptions().

◆ finalSetup()

TextPassDumper::finalSetup ( SettingsBuilder $settingsBuilder )

Handle some last-minute setup here.

Stability: stable: to override

Parameters

SettingsBuilder $settingsBuilder

Reimplemented from BackupDumper.

Definition at line 171 of file TextPassDumper.php.

References SevenZipStream\register().

◆ getText()

TextPassDumper::getText	(	$id,
		$model = null,
		$format = null,
		$expSize = null )

protected

Tries to load revision text.

Export transformations are applied if the content model is given or can be determined from the database.

Upon errors, retries (Up to $this->maxFailures tries each call). If still no good revision could be found even after this retrying, "" is returned. If no good revision text could be returned for $this->maxConsecutiveFailedTextRetrievals consecutive calls to getText, MWException is thrown.

Parameters

int \| string	$id	Content address, or text row ID.
string \| false \| null	$model	The content model used to determine applicable export transformations. If $model is null, no transformation is applied.
string \| null	$format	The content format used when applying export transformations.
int \| null	$expSize	Expected length of the text, for checks

Returns: string The revision text for $id, or ""

Exceptions

MWException

Definition at line 592 of file TextPassDumper.php.

References openSpawn(), BackupDumper\progress(), and rotateDb().

Referenced by startElement().

◆ initProgress()

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

Initialise starting time and maximum revision count.

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

Parameters

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

Reimplemented from BackupDumper.

Definition at line 280 of file TextPassDumper.php.

References BackupDumper\$startTime.

Referenced by dump().

◆ openSpawn()

TextPassDumper::openSpawn ( )

protected

Definition at line 779 of file TextPassDumper.php.

References $IP, $spawnRead, $spawnWrite, and BackupDumper\progress().

Referenced by getText().

◆ processFileOpt()

TextPassDumper::processFileOpt ( $opt )

protected

Definition at line 326 of file TextPassDumper.php.

Referenced by processOptions().

◆ processOptions()

TextPassDumper::processOptions ( )

protected

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

Reimplemented from BackupDumper.

Definition at line 189 of file TextPassDumper.php.

References Maintenance\getOption(), Maintenance\hasOption(), and processFileOpt().

Referenced by __construct(), and execute().

◆ readDump()

TextPassDumper::readDump ( $input )

protected

Exceptions

MWException Failure to parse XML input

Parameters

resource $input

Returns: bool

Definition at line 467 of file TextPassDumper.php.

References $input, wfDebug(), and wfMessage().

Referenced by dump().

◆ rotateDb()

TextPassDumper::rotateDb ( )

protected

Drop the database connection $this->db and try to get a new one.

This function tries to get a /different/ connection if this is possible. Hence, (if this is possible) it switches to a different failover upon each call.

This function resets $this->lb and closes all connections on it.

Definition at line 241 of file TextPassDumper.php.

References BackupDumper\$forcedDb, DB_REPLICA, and Maintenance\getServiceContainer().

Referenced by dump(), and getText().

◆ showReport()

TextPassDumper::showReport ( )

Overridden to include prefetch ratio if enabled.

Reimplemented from BackupDumper.

Definition at line 362 of file TextPassDumper.php.

References $fetchCount, $fetchCountLast, BackupDumper\$lastTime, BackupDumper\$maxCount, BackupDumper\$pageCountLast, $prefetchCount, BackupDumper\$revCount, BackupDumper\$revCountLast, BackupDumper\$startTime, BackupDumper\progress(), BackupDumper\revCount(), and wfTimestamp().

◆ startElement()

TextPassDumper::startElement	(	$parser,
		$name,
		$attribs )

protected

Definition at line 920 of file TextPassDumper.php.

References characterData(), clearOpenElement(), CONTENT_MODEL_WIKITEXT, and getText().

Member Data Documentation

◆ $bufferSize

int TextPassDumper::$bufferSize = 524_288

protected

In bytes.

Maximum size to read from the stub in on go.

Definition at line 82 of file TextPassDumper.php.

◆ $checkpointFiles

string [] TextPassDumper::$checkpointFiles = []

protected

Definition at line 123 of file TextPassDumper.php.

◆ $checkpointJustWritten

bool TextPassDumper::$checkpointJustWritten = false

protected

Definition at line 121 of file TextPassDumper.php.

◆ $db

IMaintainableDatabase TextPassDumper::$db

protected

Definition at line 128 of file TextPassDumper.php.

◆ $failureTimeout

int TextPassDumper::$failureTimeout = 5

protected

Seconds to sleep after db failure.

Definition at line 79 of file TextPassDumper.php.

◆ $fetchCount

int TextPassDumper::$fetchCount = 0

protected

Definition at line 66 of file TextPassDumper.php.

Referenced by showReport().

◆ $fetchCountLast

int TextPassDumper::$fetchCountLast = 0

protected

Definition at line 72 of file TextPassDumper.php.

Referenced by showReport().

◆ $firstPageWritten

string false TextPassDumper::$firstPageWritten = false

protected

Definition at line 117 of file TextPassDumper.php.

◆ $history

int TextPassDumper::$history = WikiExporter::FULL

protected

Definition at line 64 of file TextPassDumper.php.

◆ $input

string TextPassDumper::$input = "php://stdin"

protected

Definition at line 62 of file TextPassDumper.php.

Referenced by dump(), and readDump().

◆ $lastPageWritten

string false TextPassDumper::$lastPageWritten = false

protected

Definition at line 119 of file TextPassDumper.php.

◆ $maxConsecutiveFailedTextRetrievals

int TextPassDumper::$maxConsecutiveFailedTextRetrievals = 200

protected

Definition at line 77 of file TextPassDumper.php.

◆ $maxFailures

int TextPassDumper::$maxFailures = 5

protected

Definition at line 75 of file TextPassDumper.php.

◆ $maxTimeAllowed

int TextPassDumper::$maxTimeAllowed = 0

when we spend more than maxTimeAllowed seconds on this run, we continue processing until we write out the next complete page, then save output file(s), rename it/them and open new one(s); 0 = no limit

Definition at line 59 of file TextPassDumper.php.

◆ $php

array TextPassDumper::$php = [ PHP_BINARY ]

protected

Definition at line 85 of file TextPassDumper.php.

◆ $prefetch

BaseDump null TextPassDumper::$prefetch = null

Definition at line 46 of file TextPassDumper.php.

◆ $prefetchCount

int TextPassDumper::$prefetchCount = 0

protected

Definition at line 68 of file TextPassDumper.php.

Referenced by showReport().

◆ $prefetchCountLast

int TextPassDumper::$prefetchCountLast = 0

protected

Definition at line 70 of file TextPassDumper.php.

◆ $spawn

bool TextPassDumper::$spawn = false

protected

Definition at line 87 of file TextPassDumper.php.

◆ $spawnErr

resource false TextPassDumper::$spawnErr = false

protected

Definition at line 107 of file TextPassDumper.php.

◆ $spawnProc

resource false TextPassDumper::$spawnProc = false

protected

Definition at line 92 of file TextPassDumper.php.

◆ $spawnRead

resource null TextPassDumper::$spawnRead

protected

Definition at line 102 of file TextPassDumper.php.

Referenced by openSpawn().

◆ $spawnWrite

resource null TextPassDumper::$spawnWrite

protected

Definition at line 97 of file TextPassDumper.php.

Referenced by openSpawn().

◆ $timeExceeded

bool TextPassDumper::$timeExceeded = false

protected

Definition at line 115 of file TextPassDumper.php.

◆ $xmlwriterobj

XmlDumpWriter false TextPassDumper::$xmlwriterobj = false

protected

Definition at line 112 of file TextPassDumper.php.

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

maintenance/includes/TextPassDumper.php

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ characterData()

◆ clearOpenElement()

◆ dump()

◆ endElement()

◆ execute()

◆ finalSetup()

◆ getText()

◆ initProgress()

◆ openSpawn()

◆ processFileOpt()

◆ processOptions()

◆ readDump()

◆ rotateDb()

◆ showReport()

◆ startElement()

Member Data Documentation

◆ $bufferSize

◆ $checkpointFiles

◆ $checkpointJustWritten

◆ $db

◆ $failureTimeout

◆ $fetchCount

◆ $fetchCountLast

◆ $firstPageWritten

◆ $history

◆ $input

◆ $lastPageWritten

◆ $maxConsecutiveFailedTextRetrievals

◆ $maxFailures

◆ $maxTimeAllowed

◆ $php

◆ $prefetch

◆ $prefetchCount

◆ $prefetchCountLast

◆ $spawn

◆ $spawnErr

◆ $spawnProc

◆ $spawnRead

◆ $spawnWrite

◆ $timeExceeded

◆ $xmlwriterobj