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

Public Member Functions

 __construct ( $args=null)
 
 characterData ( $parser, $data)
 
 checkIfTimeExceeded ()
 
 clearOpenElement ( $style)
 
 dump ( $history, $text=WikiExporter::TEXT)
 
 endElement ( $parser, $name)
 
 execute ()
 
 finalOptionCheck ()
 
 getText ( $id, $model=null, $format=null)
 Tries to load revision text. More...
 
 initProgress ( $history=WikiExporter::FULL)
 
 openSpawn ()
 
 processFileOpt ( $opt)
 
 processOptions ()
 
 readDump ( $input)
 
 rotateDb ()
 Drop the database connection $this->db and try to get a new one. More...
 
 setTimeExceeded ()
 
 showReport ()
 Overridden to include prefetch ratio if enabled. More...
 
 startElement ( $parser, $name, $attribs)
 
- Public Member Functions inherited from BackupDumper
 __construct ( $args=null)
 
 __destruct ()
 
 backupDb ()
 
 backupServer ()
 
 dump ( $history, $text=WikiExporter::TEXT)
 
 execute ()
 
 initProgress ( $history=WikiExporter::FULL)
 Initialise starting time and maximum revision count. More...
 
 loadPlugin ( $class, $file)
 Load a plugin and register it. More...
 
 processOptions ()
 Processes arguments and sets $this->$sink accordingly. More...
 
 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. 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...
 
 execute ()
 Do the actual work. More...
 
 finalSetup ()
 Handle some last-minute setup here. 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...
 
 globals ()
 Potentially debug globals. More...
 
 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. More...
 
 loadSettings ()
 Generic setup for most installs. More...
 
 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 ()
 Set triggers like when to try to run deferred updates. More...
 
 setConfig (Config $config)
 
 setDB (IDatabase $db)
 Sets database object to be returned by getDB(). More...
 
 setup ()
 Do some sanity checking and basic setup. More...
 
 updateSearchIndex ( $maxLockTime, $callback, $dbw, $results)
 Perform a search index update with locking. More...
 
 updateSearchIndexForPage ( $dbw, $pageId)
 Update the searchindex table for a given pageid. More...
 
 validateParamsAndArgs ()
 Run some validation checks on the params, etc. More...
 

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
 
- Public Attributes inherited from Maintenance
resource $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 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. More...
 
 $ID = 0
 
 $lastTime = 0
 
LoadBalancer $lb
 
 $outputTypes = []
 
 $pageCount = 0
 
 $pageCountLast = 0
 
 $reportingInterval = 100
 
 $revCount = 0
 
 $revCountLast = 0
 
 $schemaVersion = null
 
 $server = null
 
 $sink = null
 
- Protected Attributes inherited from Maintenance
 $mAllowUnregisteredOptions = false
 
 $mArgList = []
 
 $mArgs = []
 
int $mBatchSize = null
 Batch size. More...
 
 $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. More...
 
 getBlobStore ()
 
 getTextDb ( $id)
 Loads the serialized content from storage. More...
 
 getTextSpawned ( $address)
 
 getTextSpawnedOnce ( $address)
 

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). 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 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) More...
 
- Protected Member Functions inherited from Maintenance
 activateProfiler ()
 Activate the profiler (assuming $wgProfiler is set) More...
 
 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 ()
 Execute a callback function at the end of initialisation. More...
 
 beginTransaction (IDatabase $dbw, $fname)
 Begin a transcation on a DB. More...
 
 commitTransaction (IDatabase $dbw, $fname)
 Commit the transcation 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=[], $wiki=false)
 Returns a database to be used by current maintenance script. More...
 
 getDir ()
 Get the maintenance directory. 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 exists. 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...
 
 requireExtension ( $name)
 Indicate that the specified extension must be loaded before the script can run. More...
 
 rollbackTransaction (IDatabase $dbw, $fname)
 Rollback the transcation 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)
 Set the batch size. More...
 
 supportsOption ( $name)
 Checks to see if a particular option in supported. More...
 

Detailed Description

Definition at line 41 of file TextPassDumper.php.

Constructor & Destructor Documentation

◆ __construct()

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

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

References clearOpenElement(), and null.

Referenced by startElement().

◆ checkIfTimeExceeded()

TextPassDumper::checkIfTimeExceeded ( )

Definition at line 395 of file TextPassDumper.php.

Referenced by readDump().

◆ clearOpenElement()

TextPassDumper::clearOpenElement (   $style)

Definition at line 1019 of file TextPassDumper.php.

References Xml\element().

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

◆ closeSpawn()

TextPassDumper::closeSpawn ( )
private

Definition at line 802 of file TextPassDumper.php.

Referenced by dump(), and getText().

◆ dump()

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

◆ endElement()

TextPassDumper::endElement (   $parser,
  $name 
)

Definition at line 934 of file TextPassDumper.php.

References $fileinfo, BackupDumper\$lastTime, $name, clearOpenElement(), and null.

◆ execute()

TextPassDumper::execute ( )

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

References $handler, ContentHandler\getForModelID(), and BackupDumper\progress().

Referenced by getText().

◆ finalOptionCheck()

TextPassDumper::finalOptionCheck ( )

Definition at line 405 of file TextPassDumper.php.

References as.

Referenced by dump().

◆ getBlobStore()

TextPassDumper::getBlobStore ( )
private
Returns
SqlBlobStore

Definition at line 150 of file TextPassDumper.php.

Referenced by getTextDb().

◆ getText()

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

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$idContent address, or text row ID.
string | bool | null$modelThe content model used to determine applicable export transformations. If $model is null, it will be determined from the database.
string | null$formatThe content format used when applying export transformations.
Exceptions
MWException
Returns
string The revision text for $id, or ""

Definition at line 554 of file TextPassDumper.php.

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

Referenced by startElement().

◆ getTextDb()

TextPassDumper::getTextDb (   $id)
private

Loads the serialized content from storage.

Parameters
int | string$idContent address, or text row ID.
Returns
bool|string

Definition at line 721 of file TextPassDumper.php.

References false, and getBlobStore().

Referenced by getText().

◆ getTextSpawned()

TextPassDumper::getTextSpawned (   $address)
private
Parameters
int | string$addressContent address, or text row ID.
Returns
bool|string

Definition at line 745 of file TextPassDumper.php.

References getTextSpawnedOnce(), and openSpawn().

Referenced by getText().

◆ getTextSpawnedOnce()

TextPassDumper::getTextSpawnedOnce (   $address)
private
Parameters
int | string$addressContent address, or text row ID.
Returns
bool|string

Definition at line 827 of file TextPassDumper.php.

References $buffer, and BackupDumper\progress().

Referenced by getTextSpawned().

◆ initProgress()

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

Definition at line 250 of file TextPassDumper.php.

Referenced by dump().

◆ openSpawn()

TextPassDumper::openSpawn ( )

Definition at line 757 of file TextPassDumper.php.

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

Referenced by getText(), and getTextSpawned().

◆ processFileOpt()

TextPassDumper::processFileOpt (   $opt)

Definition at line 296 of file TextPassDumper.php.

References $opt, and as.

Referenced by processOptions().

◆ processOptions()

TextPassDumper::processOptions ( )

◆ readDump()

TextPassDumper::readDump (   $input)
Exceptions
MWExceptionFailure to parse XML input
Parameters
string$input
Returns
bool

Definition at line 434 of file TextPassDumper.php.

References $fileinfo, $input, $parser, checkIfTimeExceeded(), null, 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 211 of file TextPassDumper.php.

References $e, BackupDumper\$forcedDb, DB_REPLICA, and null.

Referenced by dump(), and getText().

◆ setTimeExceeded()

TextPassDumper::setTimeExceeded ( )

Definition at line 391 of file TextPassDumper.php.

Referenced by readDump().

◆ showReport()

◆ startElement()

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

Definition at line 897 of file TextPassDumper.php.

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

Member Data Documentation

◆ $bufferSize

TextPassDumper::$bufferSize = 524288
protected

Definition at line 65 of file TextPassDumper.php.

◆ $checkpointFiles

TextPassDumper::$checkpointFiles = []
protected

Definition at line 99 of file TextPassDumper.php.

◆ $checkpointJustWritten

TextPassDumper::$checkpointJustWritten = false
protected

Definition at line 98 of file TextPassDumper.php.

◆ $db

IMaintainableDatabase TextPassDumper::$db
protected

Definition at line 104 of file TextPassDumper.php.

◆ $failureTimeout

TextPassDumper::$failureTimeout = 5
protected

Definition at line 63 of file TextPassDumper.php.

◆ $fetchCount

TextPassDumper::$fetchCount = 0
protected

Definition at line 56 of file TextPassDumper.php.

Referenced by showReport().

◆ $fetchCountLast

TextPassDumper::$fetchCountLast = 0
protected

Definition at line 59 of file TextPassDumper.php.

Referenced by showReport().

◆ $firstPageWritten

TextPassDumper::$firstPageWritten = false
protected

Definition at line 96 of file TextPassDumper.php.

◆ $history

TextPassDumper::$history = WikiExporter::FULL
protected

Definition at line 55 of file TextPassDumper.php.

◆ $input

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

Definition at line 54 of file TextPassDumper.php.

Referenced by dump(), and readDump().

◆ $lastPageWritten

TextPassDumper::$lastPageWritten = false
protected

Definition at line 97 of file TextPassDumper.php.

◆ $maxConsecutiveFailedTextRetrievals

TextPassDumper::$maxConsecutiveFailedTextRetrievals = 200
protected

Definition at line 62 of file TextPassDumper.php.

◆ $maxFailures

TextPassDumper::$maxFailures = 5
protected

Definition at line 61 of file TextPassDumper.php.

◆ $maxTimeAllowed

TextPassDumper::$maxTimeAllowed = 0

Definition at line 52 of file TextPassDumper.php.

◆ $php

TextPassDumper::$php = "php"
protected

Definition at line 67 of file TextPassDumper.php.

◆ $prefetch

BaseDump TextPassDumper::$prefetch = null

Definition at line 43 of file TextPassDumper.php.

◆ $prefetchCount

TextPassDumper::$prefetchCount = 0
protected

Definition at line 57 of file TextPassDumper.php.

Referenced by showReport().

◆ $prefetchCountLast

TextPassDumper::$prefetchCountLast = 0
protected

Definition at line 58 of file TextPassDumper.php.

◆ $spawn

TextPassDumper::$spawn = false
protected

Definition at line 68 of file TextPassDumper.php.

◆ $spawnErr

bool resource TextPassDumper::$spawnErr = false
protected

Definition at line 88 of file TextPassDumper.php.

◆ $spawnProc

bool resource TextPassDumper::$spawnProc = false
protected

Definition at line 73 of file TextPassDumper.php.

◆ $spawnRead

bool resource TextPassDumper::$spawnRead = false
protected

Definition at line 83 of file TextPassDumper.php.

◆ $spawnWrite

bool resource TextPassDumper::$spawnWrite = false
protected

Definition at line 78 of file TextPassDumper.php.

◆ $thisPage

string bool TextPassDumper::$thisPage
private

Definition at line 45 of file TextPassDumper.php.

◆ $thisRev

string bool TextPassDumper::$thisRev
private

Definition at line 47 of file TextPassDumper.php.

◆ $timeExceeded

TextPassDumper::$timeExceeded = false
protected

Definition at line 95 of file TextPassDumper.php.

◆ $xmlwriterobj

bool XmlDumpWriter TextPassDumper::$xmlwriterobj = false
protected

Definition at line 93 of file TextPassDumper.php.


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