Inheritance diagram for TextPassDumper:

[legend]

Collaboration diagram for TextPassDumper:

[legend]

Public Member Functions
	__construct ( $args=null)

	characterData ( $parser, $data)

	checkIfTimeExceeded ()

	clearOpenElement ( $style)

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

	endElement ( $parser, $name)

	execute ()
	Do the actual work.

	finalOptionCheck ()

	getText ( $id, $model=null, $format=null)
	Tries to get the revision text for a revision id.

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

	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.

	setTimeExceeded ()

	showReport ()
	Overridden to include prefetch ratio if enabled.

	startElement ( $parser, $name, $attribs)

Public Member Functions inherited from BackupDumper
	__destruct ()

	backupDb ()

	backupServer ()

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

	progress ( $string)

	registerFilter ( $name, $class)

	registerOutput ( $name, $class)

	report ( $final=false)

	reportPage ()

	revCount ()

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

Public Member Functions inherited from Maintenance
function	__construct ()

	__construct ()
	Default constructor.

	checkRequiredExtensions ()
	Verify that the required extensions are installed.

	cleanupChanneled ()
	Clean up channeled output.

	clearParamsAndArgs ()
	Clear all params and arguments.

function	execute ()

	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 ( $dbw, $pageId)
	Update the searchindex table for a given pageid.

Public Attributes
	$maxTimeAllowed = 0

BaseDump	$prefetch = null

Public Attributes inherited from BackupDumper
	$dumpUploadFileContents = false

	$dumpUploads = false

	$endId = 0

	$orderRevs = false

	$pages = null

	$reporting = true

	$revEndId = 0

	$revStartId = 0

	$skipFooter = false

	$skipHeader = false

	$startId = 0

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 Attributes
	$bufferSize = 524288

	$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

	$php = "php"

	$prefetchCount = 0

	$prefetchCountLast = 0

	$spawn = false

bool resource	$spawnErr = false

bool resource	$spawnProc = false

bool resource	$spawnRead = false

bool resource	$spawnWrite = false

	$timeExceeded = false

bool XmlDumpWriter	$xmlwriterobj = false

Protected Attributes inherited from BackupDumper
	$filterTypes = []

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

	$ID = 0

	$lastTime = 0

LoadBalancer	$lb

	$outputTypes = []

	$pageCount = 0

	$pageCountLast = 0

	$reportingInterval = 100

	$revCount = 0

	$revCountLast = 0

	$server = null

	$sink = null

Protected Attributes inherited from Maintenance
	$mAllowUnregisteredOptions = false

	$mArgList = []

	$mArgs = []

int	$mBatchSize = null
	Batch size.

	$mDbPass

	$mDbUser

	$mDescription = ''

	$mInputLoaded = false

	$mOptions = []

	$mParams = []

	$mQuiet = false

	$mSelf

	$mShortParamsMap = []

Private Member Functions
	closeSpawn ()

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

	getTextDb ( $id)
	May throw a database error if, say, the server dies during query.

	getTextSpawned ( $id)

	getTextSpawnedOnce ( $id)

Private Attributes
string bool	$thisPage

string bool	$thisRev

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)

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.

	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=[], $wiki=false)
	Returns a database to be used by current maintenance script.

	getDir ()
	Get the maintenance directory.

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

	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.

	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.

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

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

Detailed Description

Definition at line 37 of file dumpTextPass.php.

Constructor & Destructor Documentation

◆ __construct()

TextPassDumper::__construct ( $args = null )

Parameters

array | null $args For backward compatibility

Reimplemented from BackupDumper.

Definition at line 105 of file dumpTextPass.php.

References $args, add, Maintenance\addDescription(), Maintenance\addOption(), are, from, is, Maintenance\loadWithArgv(), on, Maintenance\output(), page, processOptions(), BackupDumper\progress(), and text.

Member Function Documentation

◆ characterData()

TextPassDumper::characterData	(	$parser,
		$data
	)

Definition at line 958 of file dumpTextPass.php.

References clearOpenElement().

Referenced by startElement().

◆ checkIfTimeExceeded()

TextPassDumper::checkIfTimeExceeded ( )

Definition at line 383 of file dumpTextPass.php.

Referenced by readDump().

◆ clearOpenElement()

TextPassDumper::clearOpenElement ( $style )

Definition at line 983 of file dumpTextPass.php.

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

◆ closeSpawn()

TextPassDumper::closeSpawn ( )

private

Definition at line 779 of file dumpTextPass.php.

Referenced by dump(), and getText().

◆ dump()

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

Reimplemented from BackupDumper.

Reimplemented in MediaWiki\Tests\Maintenance\TextPassDumperAccessor.

Definition at line 243 of file dumpTextPass.php.

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

Referenced by execute().

◆ endElement()

TextPassDumper::endElement	(	$parser,
		$name
	)

Definition at line 898 of file dumpTextPass.php.

References $fileinfo, $name, array(), 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 142 of file dumpTextPass.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 507 of file dumpTextPass.php.

References $handler, and BackupDumper\progress().

Referenced by getText().

◆ finalOptionCheck()

TextPassDumper::finalOptionCheck ( )

Definition at line 393 of file dumpTextPass.php.

References array(), and as.

Referenced by dump().

◆ getText()

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

Tries to get the revision text for a revision id.

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

Upon errors, retries (Up to $this->maxFailures tries each call). If still no good revision get 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

string	$id	The revision id to get the text for
string \| bool \| null	$model	The content model used to determine applicable export transformations. If $model is null, it will be determined from the database.
string \| null	$format	The content format used when applying export transformations.

Exceptions

MWException

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

Definition at line 542 of file dumpTextPass.php.

References $e, $wgContentHandlerUseDB, closeSpawn(), CONTENT_MODEL_WIKITEXT, exportTransform(), getTextDb(), getTextSpawned(), openSpawn(), BackupDumper\progress(), and rotateDb().

Referenced by startElement().

◆ getTextDb()

TextPassDumper::getTextDb ( $id )

private

May throw a database error if, say, the server dies during query.

Parameters

int $id

Returns: bool|string

Exceptions

MWException

Definition at line 708 of file dumpTextPass.php.

References Revision\getRevisionText().

Referenced by getText().

◆ getTextSpawned()

TextPassDumper::getTextSpawned ( $id )

private

Definition at line 727 of file dumpTextPass.php.

References getTextSpawnedOnce(), and openSpawn().

Referenced by getText().

◆ getTextSpawnedOnce()

TextPassDumper::getTextSpawnedOnce ( $id )

private

Definition at line 800 of file dumpTextPass.php.

References $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 238 of file dumpTextPass.php.

Referenced by dump().

◆ openSpawn()

TextPassDumper::openSpawn ( )

Definition at line 739 of file dumpTextPass.php.

References $IP, list, php, BackupDumper\progress(), and wfWikiID().

Referenced by getText(), and getTextSpawned().

◆ processFileOpt()

TextPassDumper::processFileOpt ( $opt )

Definition at line 284 of file dumpTextPass.php.

References $opt, and as.

Referenced by processOptions().

◆ processOptions()

TextPassDumper::processOptions ( )

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

Reimplemented from BackupDumper.

Definition at line 147 of file dumpTextPass.php.

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

Referenced by __construct(), and execute().

◆ readDump()

TextPassDumper::readDump ( $input )

Exceptions

MWException Failure to parse XML input

Parameters

string $input

Returns: bool

Definition at line 422 of file dumpTextPass.php.

References $fileinfo, $input, $parser, array(), checkIfTimeExceeded(), setTimeExceeded(), wfDebug(), and wfMessage().

Referenced by dump().

◆ rotateDb()

TextPassDumper::rotateDb ( )

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

Definition at line 199 of file dumpTextPass.php.

References $e, and DB_REPLICA.

Referenced by dump(), and getText().

◆ setTimeExceeded()

TextPassDumper::setTimeExceeded ( )

Definition at line 379 of file dumpTextPass.php.

Referenced by readDump().

◆ showReport()

TextPassDumper::showReport ( )

Overridden to include prefetch ratio if enabled.

Reimplemented from BackupDumper.

Definition at line 319 of file dumpTextPass.php.

References BackupDumper\progress(), BackupDumper\revCount(), wfTimestamp(), and wfWikiID().

◆ startElement()

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

Definition at line 861 of file dumpTextPass.php.

References $attribs, $name, $parser, characterData(), clearOpenElement(), and getText().

Member Data Documentation

◆ $bufferSize

TextPassDumper::$bufferSize = 524288

protected

Definition at line 61 of file dumpTextPass.php.

Referenced by MediaWiki\Tests\Maintenance\TextPassDumperAccessor\getBufferSize().

◆ $checkpointFiles

TextPassDumper::$checkpointFiles = []

protected

Definition at line 95 of file dumpTextPass.php.

◆ $checkpointJustWritten

TextPassDumper::$checkpointJustWritten = false

protected

Definition at line 94 of file dumpTextPass.php.

◆ $db

IMaintainableDatabase TextPassDumper::$db

protected

Definition at line 100 of file dumpTextPass.php.

◆ $failureTimeout

TextPassDumper::$failureTimeout = 5

protected

Definition at line 59 of file dumpTextPass.php.

◆ $fetchCount

TextPassDumper::$fetchCount = 0

protected

Definition at line 52 of file dumpTextPass.php.

◆ $fetchCountLast

TextPassDumper::$fetchCountLast = 0

protected

Definition at line 55 of file dumpTextPass.php.

◆ $firstPageWritten

TextPassDumper::$firstPageWritten = false

protected

Definition at line 92 of file dumpTextPass.php.

◆ $history

TextPassDumper::$history = WikiExporter::FULL

protected

Definition at line 51 of file dumpTextPass.php.

◆ $input

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

protected

Definition at line 50 of file dumpTextPass.php.

◆ $lastPageWritten

TextPassDumper::$lastPageWritten = false

protected

Definition at line 93 of file dumpTextPass.php.

◆ $maxConsecutiveFailedTextRetrievals

TextPassDumper::$maxConsecutiveFailedTextRetrievals = 200

protected

Definition at line 58 of file dumpTextPass.php.

◆ $maxFailures

TextPassDumper::$maxFailures = 5

protected

Definition at line 57 of file dumpTextPass.php.

◆ $maxTimeAllowed

TextPassDumper::$maxTimeAllowed = 0

Definition at line 48 of file dumpTextPass.php.

◆ $php

TextPassDumper::$php = "php"

protected

Definition at line 63 of file dumpTextPass.php.

◆ $prefetch

BaseDump TextPassDumper::$prefetch = null

Definition at line 39 of file dumpTextPass.php.

◆ $prefetchCount

TextPassDumper::$prefetchCount = 0

protected

Definition at line 53 of file dumpTextPass.php.

◆ $prefetchCountLast

TextPassDumper::$prefetchCountLast = 0

protected

Definition at line 54 of file dumpTextPass.php.

◆ $spawn

TextPassDumper::$spawn = false

protected

Definition at line 64 of file dumpTextPass.php.

◆ $spawnErr

bool resource TextPassDumper::$spawnErr = false

protected

Definition at line 84 of file dumpTextPass.php.

◆ $spawnProc

bool resource TextPassDumper::$spawnProc = false

protected

Definition at line 69 of file dumpTextPass.php.

◆ $spawnRead

bool resource TextPassDumper::$spawnRead = false

protected

Definition at line 79 of file dumpTextPass.php.

◆ $spawnWrite

bool resource TextPassDumper::$spawnWrite = false

protected

Definition at line 74 of file dumpTextPass.php.

◆ $thisPage

string bool TextPassDumper::$thisPage

private

Definition at line 41 of file dumpTextPass.php.

◆ $thisRev

string bool TextPassDumper::$thisRev

private

Definition at line 43 of file dumpTextPass.php.

◆ $timeExceeded

TextPassDumper::$timeExceeded = false

protected

Definition at line 91 of file dumpTextPass.php.

◆ $xmlwriterobj

bool XmlDumpWriter TextPassDumper::$xmlwriterobj = false

protected

Definition at line 89 of file dumpTextPass.php.

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

maintenance/dumpTextPass.php

Public Member Functions

Public Attributes

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

◆ getText()

◆ getTextDb()

◆ getTextSpawned()

◆ getTextSpawnedOnce()

◆ initProgress()

◆ 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

◆ $timeExceeded

◆ $xmlwriterobj