Inherits MediaWiki\Maintenance\BackupDumper.

Collaboration diagram for MediaWiki\Maintenance\TextPassDumper:

[legend]

Public Member Functions

__construct ( $args=null)

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

Parameters

int	$history
int	$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.We'll make ETA calculations based on progress, assuming relatively constant per-revision rate.

Parameters

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

showReport ()

Overridden to include prefetch ratio if enabled.

Public Member Functions inherited from MediaWiki\Maintenance\BackupDumper

loadPlugin ( $class, $file)

Load a plugin and register it.

registerFilter ( $name, $class)

registerOutput ( $name, $class)

report (bool $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 MediaWiki\Maintenance\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.

createChild (string $maintClass, ?string $classFile=null)

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

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

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.

runChild ( $maintClass, $classFile=null)

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

setArg ( $argId, $value)

Programmatically set the value of the given argument.

setConfig (Config $config)

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.

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 MediaWiki\Maintenance\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 MediaWiki\Maintenance\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, string $data)

	clearOpenElement (?string $style)

	endElement ( $parser, string $name)

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

	openSpawn ()

	processFileOpt (string $opt)

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

	readDump ( $input)

	startElement ( $parser, string $name, array $attribs)

Protected Member Functions inherited from MediaWiki\Maintenance\BackupDumper
	getBackupDatabase ()

	progress (string $string)

Protected Member Functions inherited from MediaWiki\Maintenance\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 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, $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.

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

string[]	$checkpointFiles = []

bool	$checkpointJustWritten = false

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 MediaWiki\Maintenance\BackupDumper
bool	$atStart

string	$buffer

ExportProgressFilter	$egress

array< string, class-string< DumpFilter > >	$filterTypes = []

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

int	$ID = 0

string	$lastName

float	$lastTime = 0

int	$maxCount

array false	$openElement

array< string, class-string< DumpOutput > >	$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

DumpMultiWriter DumpOutput null	$sink = null
	Output filters.

float	$startTime

string	$state

string null	$thisRevFormat

string null	$thisRevModel

float	$timeOfCheckpoint

Protected Attributes inherited from MediaWiki\Maintenance\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 MediaWiki\Maintenance\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 46 of file TextPassDumper.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Maintenance\TextPassDumper::__construct ( $args = null )

Parameters

array | null $args For backward compatibility

Reimplemented from MediaWiki\Maintenance\BackupDumper.

Definition at line 130 of file TextPassDumper.php.

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

Member Function Documentation

◆ characterData()

MediaWiki\Maintenance\TextPassDumper::characterData	(		$parser,
		string	$data )

protected

Parameters

XMLParser	$parser
string	$data

Definition at line 990 of file TextPassDumper.php.

◆ clearOpenElement()

MediaWiki\Maintenance\TextPassDumper::clearOpenElement ( ?string $style )

protected

Definition at line 1022 of file TextPassDumper.php.

◆ dump()

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

Parameters

int	$history
int	$text

Reimplemented from MediaWiki\Maintenance\BackupDumper.

Definition at line 241 of file TextPassDumper.php.

References MediaWiki\Maintenance\TextPassDumper\$input, MediaWiki\Maintenance\TextPassDumper\initProgress(), MediaWiki\Maintenance\TextPassDumper\readDump(), and MediaWiki\Maintenance\BackupDumper\report().

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

◆ endElement()

MediaWiki\Maintenance\TextPassDumper::endElement	(		$parser,
		string	$name )

protected

Parameters

XMLParser	$parser
string	$name

Definition at line 925 of file TextPassDumper.php.

◆ execute()

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

Definition at line 188 of file TextPassDumper.php.

References MediaWiki\Maintenance\TextPassDumper\dump(), and MediaWiki\Maintenance\TextPassDumper\processOptions().

◆ finalSetup()

MediaWiki\Maintenance\TextPassDumper::finalSetup ( SettingsBuilder $settingsBuilder )

Handle some last-minute setup here.

Stability: stable: to override

Parameters

SettingsBuilder $settingsBuilder

Reimplemented from MediaWiki\Maintenance\BackupDumper.

Definition at line 168 of file TextPassDumper.php.

References MediaWiki\Maintenance\SevenZipStream\register().

◆ getText()

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

◆ initProgress()

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

Definition at line 235 of file TextPassDumper.php.

References MediaWiki\Maintenance\TextPassDumper\$history, and MediaWiki\Maintenance\BackupDumper\$startTime.

Referenced by MediaWiki\Maintenance\TextPassDumper\dump().

◆ openSpawn()

MediaWiki\Maintenance\TextPassDumper::openSpawn ( )

protected

Definition at line 721 of file TextPassDumper.php.

◆ processFileOpt()

MediaWiki\Maintenance\TextPassDumper::processFileOpt ( string $opt )

protected

Definition at line 268 of file TextPassDumper.php.

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

◆ processOptions()

MediaWiki\Maintenance\TextPassDumper::processOptions ( )

protected

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

Reimplemented from MediaWiki\Maintenance\BackupDumper.

Definition at line 193 of file TextPassDumper.php.

References $url, MediaWiki\Maintenance\Maintenance\getOption(), MediaWiki\Maintenance\Maintenance\hasOption(), and MediaWiki\Maintenance\TextPassDumper\processFileOpt().

Referenced by MediaWiki\Maintenance\TextPassDumper\__construct(), and MediaWiki\Maintenance\TextPassDumper\execute().

◆ readDump()

MediaWiki\Maintenance\TextPassDumper::readDump ( $input )

protected

Exceptions

MWException Failure to parse XML input

Parameters

resource $input

Returns: bool

Definition at line 392 of file TextPassDumper.php.

References wfDebug(), and wfMessage().

Referenced by MediaWiki\Maintenance\TextPassDumper\dump().

◆ showReport()

MediaWiki\Maintenance\TextPassDumper::showReport ( )

Overridden to include prefetch ratio if enabled.

Reimplemented from MediaWiki\Maintenance\BackupDumper.

Definition at line 287 of file TextPassDumper.php.

References wfTimestamp().

◆ startElement()

MediaWiki\Maintenance\TextPassDumper::startElement	(		$parser,
		string	$name,
		array	$attribs )

protected

Parameters

XMLParser	$parser
string	$name
array	$attribs

Definition at line 867 of file TextPassDumper.php.

References CONTENT_MODEL_WIKITEXT.

Member Data Documentation

◆ $bufferSize

int MediaWiki\Maintenance\TextPassDumper::$bufferSize = 524_288

protected

In bytes.

Maximum size to read from the stub in on go.

Definition at line 84 of file TextPassDumper.php.

◆ $checkpointFiles

string [] MediaWiki\Maintenance\TextPassDumper::$checkpointFiles = []

protected

Definition at line 125 of file TextPassDumper.php.

◆ $checkpointJustWritten

bool MediaWiki\Maintenance\TextPassDumper::$checkpointJustWritten = false

protected

Definition at line 123 of file TextPassDumper.php.

◆ $failureTimeout

int MediaWiki\Maintenance\TextPassDumper::$failureTimeout = 5

protected

Seconds to sleep after db failure.

Definition at line 81 of file TextPassDumper.php.

◆ $fetchCount

int MediaWiki\Maintenance\TextPassDumper::$fetchCount = 0

protected

Definition at line 68 of file TextPassDumper.php.

◆ $fetchCountLast

int MediaWiki\Maintenance\TextPassDumper::$fetchCountLast = 0

protected

Definition at line 74 of file TextPassDumper.php.

◆ $firstPageWritten

string false MediaWiki\Maintenance\TextPassDumper::$firstPageWritten = false

protected

Definition at line 119 of file TextPassDumper.php.

◆ $history

int MediaWiki\Maintenance\TextPassDumper::$history = WikiExporter::FULL

protected

Definition at line 66 of file TextPassDumper.php.

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

◆ $input

string MediaWiki\Maintenance\TextPassDumper::$input = "php://stdin"

protected

Definition at line 64 of file TextPassDumper.php.

Referenced by MediaWiki\Maintenance\TextPassDumper\dump().

◆ $lastPageWritten

string false MediaWiki\Maintenance\TextPassDumper::$lastPageWritten = false

protected

Definition at line 121 of file TextPassDumper.php.

◆ $maxConsecutiveFailedTextRetrievals

int MediaWiki\Maintenance\TextPassDumper::$maxConsecutiveFailedTextRetrievals = 200

protected

Definition at line 79 of file TextPassDumper.php.

◆ $maxFailures

int MediaWiki\Maintenance\TextPassDumper::$maxFailures = 5

protected

Definition at line 77 of file TextPassDumper.php.

◆ $maxTimeAllowed

int MediaWiki\Maintenance\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 61 of file TextPassDumper.php.

◆ $php

array MediaWiki\Maintenance\TextPassDumper::$php = [ PHP_BINARY ]

protected

Definition at line 87 of file TextPassDumper.php.

◆ $prefetch

BaseDump null MediaWiki\Maintenance\TextPassDumper::$prefetch = null

Definition at line 48 of file TextPassDumper.php.

◆ $prefetchCount

int MediaWiki\Maintenance\TextPassDumper::$prefetchCount = 0

protected

Definition at line 70 of file TextPassDumper.php.

◆ $prefetchCountLast

int MediaWiki\Maintenance\TextPassDumper::$prefetchCountLast = 0

protected

Definition at line 72 of file TextPassDumper.php.

◆ $spawn

bool MediaWiki\Maintenance\TextPassDumper::$spawn = false

protected

Definition at line 89 of file TextPassDumper.php.

◆ $spawnErr

resource false MediaWiki\Maintenance\TextPassDumper::$spawnErr = false

protected

Definition at line 109 of file TextPassDumper.php.

◆ $spawnProc

resource false MediaWiki\Maintenance\TextPassDumper::$spawnProc = false

protected

Definition at line 94 of file TextPassDumper.php.

◆ $spawnRead

resource null MediaWiki\Maintenance\TextPassDumper::$spawnRead

protected

Definition at line 104 of file TextPassDumper.php.

◆ $spawnWrite

resource null MediaWiki\Maintenance\TextPassDumper::$spawnWrite

protected

Definition at line 99 of file TextPassDumper.php.

◆ $timeExceeded

bool MediaWiki\Maintenance\TextPassDumper::$timeExceeded = false

protected

Definition at line 117 of file TextPassDumper.php.

◆ $xmlwriterobj

XmlDumpWriter false MediaWiki\Maintenance\TextPassDumper::$xmlwriterobj = false

protected

Definition at line 114 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()

◆ showReport()

◆ startElement()

Member Data Documentation

◆ $bufferSize

◆ $checkpointFiles

◆ $checkpointJustWritten

◆ $failureTimeout

◆ $fetchCount

◆ $fetchCountLast

◆ $firstPageWritten

◆ $history

◆ $input

◆ $lastPageWritten

◆ $maxConsecutiveFailedTextRetrievals

◆ $maxFailures

◆ $maxTimeAllowed

◆ $php

◆ $prefetch

◆ $prefetchCount

◆ $prefetchCountLast

◆ $spawn

◆ $spawnErr

◆ $spawnProc

◆ $spawnRead

◆ $spawnWrite

◆ $timeExceeded

◆ $xmlwriterobj