Inheritance diagram for TextPassDumper:

[legend]

Collaboration diagram for TextPassDumper:

[legend]

Public Member Functions
	__construct ( $args=null)

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

	execute ()
	Do the actual work.

	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.

	checkRequiredExtensions ()
	Verify that the required extensions are installed.

	cleanupChanneled ()
	Clean up channeled output.

	clearParamsAndArgs ()
	Clear all params and arguments.

	finalSetup ()
	Handle some last-minute setup here.

	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.

	globals ()
	Potentially debug globals.

	isQuiet ()

	loadParamsAndArgs ( $self=null, $opts=null, $args=null)
	Process command line arguments $mOptions becomes an array with keys set to the option names $mArgs becomes a zero-based array containing the non-option arguments.

	loadSettings ()
	Generic setup for most installs.

	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 ()
	Set triggers like when to try to run deferred updates.

	setConfig (Config $config)

	setup ()
	Do some sanity checking and basic setup.

	updateSearchIndex ( $maxLockTime, $callback, $dbw, $results)
	Perform a search index update with locking.

	updateSearchIndexForPage (int $pageId)
	Update the searchindex table for a given pageid.

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

Public Attributes
	$maxTimeAllowed = 0

BaseDump	$prefetch = null

Public Attributes inherited from BackupDumper
	$dumpUploadFileContents = false

	$dumpUploads = false

	$endId = 0

	$limitNamespaces = []

	$orderRevs = false

	$pages = null

	$reporting = true

	$revEndId = 0

	$revStartId = 0

	$skipFooter = false

	$skipHeader = false

	$startId = 0

bool resource	$stderr

Public Attributes inherited from Maintenance
resource	$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	STDIN_ALL = 'all'

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
	activateProfiler ()
	Activate the profiler (assuming $wgProfiler is set)

	addArg ( $arg, $description, $required=true)
	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 ()
	Execute a callback function at the end of initialisation Stable for overriding.

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

	commitTransaction (IDatabase $dbw, $fname)
	Commit the transcation 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 Stable for overriding.

	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 transcation 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)
	Set the batch size.

	showHelp ()
	Definitely show the help.

	supportsOption ( $name)
	Checks to see if a particular option in supported.

Protected Attributes
	$bufferSize = 524288

string[]	$checkpointFiles = []

	$checkpointJustWritten = false

IMaintainableDatabase	$db

	$failureTimeout = 5

	$fetchCount = 0

	$fetchCountLast = 0

	$firstPageWritten = false

	$history = WikiExporter::FULL

	$input = "php://stdin"

	$lastPageWritten = false

	$maxConsecutiveFailedTextRetrievals = 200

	$maxFailures = 5

array	$php = [ PHP_BINARY ]

	$prefetchCount = 0

	$prefetchCountLast = 0

	$spawn = false

bool resource	$spawnErr = false

bool resource	$spawnProc = false

resource	$spawnRead

resource	$spawnWrite

	$timeExceeded = false

bool XmlDumpWriter	$xmlwriterobj = false

Protected Attributes inherited from BackupDumper
bool	$atStart

string	$buffer

ExportProgressFilter	$egress

	$filterTypes = []

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

	$ID = 0

string	$lastName

	$lastTime = 0

LoadBalancer	$lb

int	$maxCount

array false	$openElement

	$outputTypes = []

	$pageCount = 0

	$pageCountLast = 0

int	$pageCountPart

	$reportingInterval = 100

	$revCount = 0

	$revCountLast = 0

int	$revCountPart

	$schemaVersion = null

	$server = null

	$sink = null

int	$startTime

string	$state

string null	$thisRevFormat

string null	$thisRevModel

int	$timeOfCheckpoint

Protected Attributes inherited from Maintenance
	$mAllowUnregisteredOptions = false

	$mArgList = []

	$mArgs = []

int	$mBatchSize = null
	Batch size.

	$mDbPass

	$mDbUser

	$mDescription = ''

	$mInputLoaded = false

	$mOptions = []

array[]	$mParams = []
	Array of desired/allowed params.

	$mQuiet = false

	$mSelf

	$mShortParamsMap = []

Private Member Functions
	checkIfTimeExceeded ()

	closeSpawn ()

	exportTransform ( $text, $model, $format=null)
	Applies applicable export transformations to $text.

	finalOptionCheck ()

	getBlobStore ()

	getTextDb ( $id)
	Loads the serialized content from storage.

	getTextSpawned ( $address)

	getTextSpawnedOnce ( $address)

	isValidTextId ( $id)

	setTimeExceeded ()

Private Attributes
string bool	$thisPage

string bool	$thisRev

string bool	$thisRole = null

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	setLBFactoryTriggers (LBFactory $LBFactory, Config $config)

static	shouldExecute ()
	Should we execute the maintenance script, or just allow it to be included as a standalone class? It checks that the call stack only includes this function and "requires" (meaning was called from the file scope)

Detailed Description

Definition at line 42 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 114 of file TextPassDumper.php.

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

Member Function Documentation

◆ characterData()

TextPassDumper::characterData	(		$parser,
			$data )

protected

Definition at line 1010 of file TextPassDumper.php.

References clearOpenElement().

Referenced by startElement().

◆ checkIfTimeExceeded()

TextPassDumper::checkIfTimeExceeded ( )

private

Definition at line 404 of file TextPassDumper.php.

Referenced by readDump().

◆ clearOpenElement()

TextPassDumper::clearOpenElement ( $style )

protected

Definition at line 1042 of file TextPassDumper.php.

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

◆ closeSpawn()

TextPassDumper::closeSpawn ( )

private

Definition at line 800 of file TextPassDumper.php.

Referenced by dump(), and getText().

◆ dump()

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

Reimplemented from BackupDumper.

Definition at line 261 of file TextPassDumper.php.

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

Referenced by execute().

◆ endElement()

TextPassDumper::endElement	(		$parser,
			$name )

protected

Definition at line 949 of file TextPassDumper.php.

References $fileinfo, 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 BackupDumper.

Definition at line 159 of file TextPassDumper.php.

References dump(), and processOptions().

◆ exportTransform()

TextPassDumper::exportTransform	(	$text,
		$model,
		$format = null )

private

Applies applicable export transformations to $text.

Parameters

string	$text
string	$model
string \| null	$format

Returns: string

Definition at line 529 of file TextPassDumper.php.

References BackupDumper\progress(), and wfWarn().

Referenced by getText().

◆ finalOptionCheck()

TextPassDumper::finalOptionCheck ( )

private

Definition at line 414 of file TextPassDumper.php.

Referenced by dump().

◆ getBlobStore()

TextPassDumper::getBlobStore ( )

private

Returns: SqlBlobStore

Definition at line 155 of file TextPassDumper.php.

Referenced by getTextDb().

◆ 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 \| bool \| 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 sanity checks

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

Exceptions

MWException

Definition at line 569 of file TextPassDumper.php.

References $thisRev, closeSpawn(), exportTransform(), getTextDb(), getTextSpawned(), isValidTextId(), openSpawn(), BackupDumper\progress(), and rotateDb().

Referenced by startElement().

◆ getTextDb()

TextPassDumper::getTextDb ( $id )

private

Loads the serialized content from storage.

Parameters

int | string $id Content address, or text row ID.

Returns: bool|string

Definition at line 718 of file TextPassDumper.php.

References getBlobStore().

Referenced by getText().

◆ getTextSpawned()

TextPassDumper::getTextSpawned ( $address )

private

Parameters

int | string $address Content address, or text row ID.

Returns: bool|string

Definition at line 742 of file TextPassDumper.php.

References getTextSpawnedOnce(), and openSpawn().

Referenced by getText().

◆ getTextSpawnedOnce()

TextPassDumper::getTextSpawnedOnce ( $address )

private

Parameters

int | string $address Content address, or text row ID.

Returns: bool|string

Definition at line 825 of file TextPassDumper.php.

References BackupDumper\$buffer, and BackupDumper\progress().

Referenced by getTextSpawned().

◆ initProgress()

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

Definition at line 256 of file TextPassDumper.php.

References BackupDumper\$startTime.

Referenced by dump().

◆ isValidTextId()

TextPassDumper::isValidTextId ( $id )

private

Definition at line 1049 of file TextPassDumper.php.

Referenced by getText().

◆ openSpawn()

TextPassDumper::openSpawn ( )

protected

Definition at line 754 of file TextPassDumper.php.

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

Referenced by getText(), and getTextSpawned().

◆ processFileOpt()

TextPassDumper::processFileOpt ( $opt )

protected

Definition at line 302 of file TextPassDumper.php.

Referenced by processOptions().

◆ processOptions()

TextPassDumper::processOptions ( )

protected

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

Reimplemented from BackupDumper.

Definition at line 164 of file TextPassDumper.php.

References WikiExporter\CURRENT, WikiExporter\FULL, 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 443 of file TextPassDumper.php.

References $fileinfo, $input, checkIfTimeExceeded(), setTimeExceeded(), 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.

Exceptions

MWException PhanTypeObjectUnsetDeclaredProperty

Definition at line 217 of file TextPassDumper.php.

References BackupDumper\$forcedDb, and DB_REPLICA.

Referenced by dump(), and getText().

◆ setTimeExceeded()

TextPassDumper::setTimeExceeded ( )

private

Definition at line 400 of file TextPassDumper.php.

Referenced by readDump().

◆ showReport()

TextPassDumper::showReport ( )

Overridden to include prefetch ratio if enabled.

Reimplemented from BackupDumper.

Definition at line 338 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 895 of file TextPassDumper.php.

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

Member Data Documentation

◆ $bufferSize

TextPassDumper::$bufferSize = 524288

protected

Definition at line 68 of file TextPassDumper.php.

◆ $checkpointFiles

string [] TextPassDumper::$checkpointFiles = []

protected

Definition at line 104 of file TextPassDumper.php.

◆ $checkpointJustWritten

TextPassDumper::$checkpointJustWritten = false

protected

Definition at line 102 of file TextPassDumper.php.

◆ $db

IMaintainableDatabase TextPassDumper::$db

protected

Definition at line 109 of file TextPassDumper.php.

◆ $failureTimeout

TextPassDumper::$failureTimeout = 5

protected

Definition at line 66 of file TextPassDumper.php.

◆ $fetchCount

TextPassDumper::$fetchCount = 0

protected

Definition at line 59 of file TextPassDumper.php.

Referenced by showReport().

◆ $fetchCountLast

TextPassDumper::$fetchCountLast = 0

protected

Definition at line 62 of file TextPassDumper.php.

Referenced by showReport().

◆ $firstPageWritten

TextPassDumper::$firstPageWritten = false

protected

Definition at line 100 of file TextPassDumper.php.

◆ $history

TextPassDumper::$history = WikiExporter::FULL

protected

Definition at line 58 of file TextPassDumper.php.

◆ $input

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

protected

Definition at line 57 of file TextPassDumper.php.

Referenced by dump(), and readDump().

◆ $lastPageWritten

TextPassDumper::$lastPageWritten = false

protected

Definition at line 101 of file TextPassDumper.php.

◆ $maxConsecutiveFailedTextRetrievals

TextPassDumper::$maxConsecutiveFailedTextRetrievals = 200

protected

Definition at line 65 of file TextPassDumper.php.

◆ $maxFailures

TextPassDumper::$maxFailures = 5

protected

Definition at line 64 of file TextPassDumper.php.

◆ $maxTimeAllowed

TextPassDumper::$maxTimeAllowed = 0

Definition at line 55 of file TextPassDumper.php.

◆ $php

array TextPassDumper::$php = [ PHP_BINARY ]

protected

Definition at line 71 of file TextPassDumper.php.

◆ $prefetch

BaseDump TextPassDumper::$prefetch = null

Definition at line 44 of file TextPassDumper.php.

◆ $prefetchCount

TextPassDumper::$prefetchCount = 0

protected

Definition at line 60 of file TextPassDumper.php.

Referenced by showReport().

◆ $prefetchCountLast

TextPassDumper::$prefetchCountLast = 0

protected

Definition at line 61 of file TextPassDumper.php.

◆ $spawn

TextPassDumper::$spawn = false

protected

Definition at line 72 of file TextPassDumper.php.

◆ $spawnErr

bool resource TextPassDumper::$spawnErr = false

protected

Definition at line 92 of file TextPassDumper.php.

◆ $spawnProc

bool resource TextPassDumper::$spawnProc = false

protected

Definition at line 77 of file TextPassDumper.php.

◆ $spawnRead

resource TextPassDumper::$spawnRead

protected

Definition at line 87 of file TextPassDumper.php.

Referenced by openSpawn().

◆ $spawnWrite

resource TextPassDumper::$spawnWrite

protected

Definition at line 82 of file TextPassDumper.php.

Referenced by openSpawn().

◆ $thisPage

string bool TextPassDumper::$thisPage

private

Definition at line 46 of file TextPassDumper.php.

◆ $thisRev

string bool TextPassDumper::$thisRev

private

Definition at line 48 of file TextPassDumper.php.

Referenced by getText().

◆ $thisRole

string bool TextPassDumper::$thisRole = null

private

Definition at line 50 of file TextPassDumper.php.

◆ $timeExceeded

TextPassDumper::$timeExceeded = false

protected

Definition at line 99 of file TextPassDumper.php.

◆ $xmlwriterobj

bool XmlDumpWriter TextPassDumper::$xmlwriterobj = false

protected

Definition at line 97 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

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ characterData()

◆ checkIfTimeExceeded()

◆ clearOpenElement()

◆ closeSpawn()

◆ dump()

◆ endElement()

◆ execute()

◆ exportTransform()

◆ finalOptionCheck()

◆ getBlobStore()

◆ getText()

◆ getTextDb()

◆ getTextSpawned()

◆ getTextSpawnedOnce()

◆ initProgress()

◆ isValidTextId()

◆ openSpawn()

◆ processFileOpt()

◆ processOptions()

◆ readDump()

◆ rotateDb()

◆ setTimeExceeded()

◆ 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

◆ $thisPage

◆ $thisRev

◆ $thisRole

◆ $timeExceeded

◆ $xmlwriterobj