MediaWiki REL1_37
|
Public Member Functions | |
__construct ( $args=null) | |
dump ( $history, $text=WikiExporter::TEXT) | |
execute () | |
Do the actual work. | |
finalSetup () | |
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. | |
![]() | |
__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. | |
![]() | |
__construct () | |
Default constructor. | |
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. | |
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 () | |
This method used to be for internal use by doMaintenance.php to apply some optional global state to LBFactory for debugging purposes. | |
setConfig (Config $config) | |
setup () | |
Do some sanity checking and basic setup. | |
shutdown () | |
Call before shutdown to run any deferred updates. | |
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) | |
BaseDump | $prefetch = null |
![]() | |
$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 |
![]() | |
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 | 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) | |
![]() | |
backupDb () | |
backupServer () | |
progress ( $string) | |
![]() | |
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 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. | |
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. | |
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 | |
$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 |
![]() | |
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 |
![]() | |
bool | $mAllowUnregisteredOptions = false |
Allow arbitrary options to be passed, or only specified ones? | |
array | $mArgList = [] |
Desired/allowed args. | |
array | $mArgs = [] |
This is the list of arguments that were actually passed. | |
int null | $mBatchSize = null |
Batch size. | |
$mDbPass | |
$mDbUser | |
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 = [] |
Array of desired/allowed params. | |
bool | $mQuiet = false |
Special vars for params that are always used. | |
string null | $mSelf |
Name of the script currently running. | |
array | $mShortParamsMap = [] |
Mapping short parameters to long ones. | |
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 | 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 | 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) | |
Definition at line 42 of file TextPassDumper.php.
TextPassDumper::__construct | ( | $args = null | ) |
array | null | $args | For backward compatibility |
Reimplemented from BackupDumper.
Definition at line 116 of file TextPassDumper.php.
References $args, Maintenance\addDescription(), Maintenance\addOption(), Maintenance\loadWithArgv(), Maintenance\output(), processOptions(), and BackupDumper\progress().
|
protected |
Definition at line 1018 of file TextPassDumper.php.
References clearOpenElement().
Referenced by startElement().
|
private |
Definition at line 412 of file TextPassDumper.php.
Referenced by readDump().
|
protected |
Definition at line 1050 of file TextPassDumper.php.
Referenced by characterData(), endElement(), and startElement().
|
private |
Definition at line 808 of file TextPassDumper.php.
TextPassDumper::dump | ( | $history, | |
$text = WikiExporter::TEXT |
|||
) |
Reimplemented from BackupDumper.
Definition at line 269 of file TextPassDumper.php.
References $input, closeSpawn(), finalOptionCheck(), initProgress(), BackupDumper\progress(), readDump(), BackupDumper\report(), and rotateDb().
Referenced by execute().
|
protected |
Definition at line 957 of file TextPassDumper.php.
References $fileinfo, BackupDumper\$lastTime, and clearOpenElement().
TextPassDumper::execute | ( | ) |
Do the actual work.
All child classes will need to implement this
Reimplemented from BackupDumper.
Definition at line 167 of file TextPassDumper.php.
References dump(), and processOptions().
|
private |
Applies applicable export transformations to $text.
string | $text | |
string | $model | |
string | null | $format |
Definition at line 537 of file TextPassDumper.php.
References BackupDumper\progress(), and wfWarn().
Referenced by getText().
|
private |
Definition at line 422 of file TextPassDumper.php.
Referenced by dump().
TextPassDumper::finalSetup | ( | ) |
Handle some last-minute setup here.
Reimplemented from Maintenance.
Definition at line 154 of file TextPassDumper.php.
References SevenZipStream\register().
|
private |
|
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.
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 |
MWException |
Definition at line 577 of file TextPassDumper.php.
References $thisRev, closeSpawn(), exportTransform(), getTextDb(), getTextSpawned(), isValidTextId(), openSpawn(), BackupDumper\progress(), and rotateDb().
Referenced by startElement().
|
private |
Loads the serialized content from storage.
int | string | $id | Content address, or text row ID. |
Definition at line 726 of file TextPassDumper.php.
References getBlobStore().
Referenced by getText().
|
private |
int | string | $address | Content address, or text row ID. |
Definition at line 750 of file TextPassDumper.php.
References getTextSpawnedOnce(), and openSpawn().
Referenced by getText().
|
private |
int | string | $address | Content address, or text row ID. |
Definition at line 833 of file TextPassDumper.php.
References BackupDumper\$buffer, and BackupDumper\progress().
Referenced by getTextSpawned().
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.
int | $history | WikiExporter::CURRENT or WikiExporter::FULL |
Reimplemented from BackupDumper.
Definition at line 264 of file TextPassDumper.php.
References BackupDumper\$startTime.
Referenced by dump().
|
private |
Definition at line 1057 of file TextPassDumper.php.
Referenced by getText().
|
protected |
Definition at line 762 of file TextPassDumper.php.
References $IP, $spawnRead, $spawnWrite, and BackupDumper\progress().
Referenced by getText(), and getTextSpawned().
|
protected |
Definition at line 310 of file TextPassDumper.php.
Referenced by processOptions().
|
protected |
Processes arguments and sets $this->$sink accordingly.
Reimplemented from BackupDumper.
Definition at line 172 of file TextPassDumper.php.
References WikiExporter\CURRENT, WikiExporter\FULL, Maintenance\getOption(), Maintenance\hasOption(), and processFileOpt().
Referenced by __construct(), and execute().
|
protected |
MWException | Failure to parse XML input |
resource | $input |
Definition at line 451 of file TextPassDumper.php.
References $fileinfo, $input, checkIfTimeExceeded(), setTimeExceeded(), wfDebug(), and wfMessage().
Referenced by dump().
|
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.
MWException |
Definition at line 225 of file TextPassDumper.php.
References BackupDumper\$forcedDb, and DB_REPLICA.
|
private |
Definition at line 408 of file TextPassDumper.php.
Referenced by readDump().
TextPassDumper::showReport | ( | ) |
Overridden to include prefetch ratio if enabled.
Reimplemented from BackupDumper.
Definition at line 346 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().
|
protected |
Definition at line 903 of file TextPassDumper.php.
References characterData(), clearOpenElement(), CONTENT_MODEL_WIKITEXT, and getText().
|
protected |
Definition at line 70 of file TextPassDumper.php.
|
protected |
Definition at line 106 of file TextPassDumper.php.
|
protected |
Definition at line 104 of file TextPassDumper.php.
|
protected |
Definition at line 111 of file TextPassDumper.php.
|
protected |
Definition at line 68 of file TextPassDumper.php.
|
protected |
Definition at line 61 of file TextPassDumper.php.
Referenced by showReport().
|
protected |
Definition at line 64 of file TextPassDumper.php.
Referenced by showReport().
|
protected |
Definition at line 102 of file TextPassDumper.php.
|
protected |
Definition at line 60 of file TextPassDumper.php.
|
protected |
Definition at line 59 of file TextPassDumper.php.
Referenced by dump(), and readDump().
|
protected |
Definition at line 103 of file TextPassDumper.php.
|
protected |
Definition at line 67 of file TextPassDumper.php.
|
protected |
Definition at line 66 of file TextPassDumper.php.
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)
Definition at line 57 of file TextPassDumper.php.
|
protected |
Definition at line 73 of file TextPassDumper.php.
BaseDump TextPassDumper::$prefetch = null |
Definition at line 44 of file TextPassDumper.php.
|
protected |
Definition at line 62 of file TextPassDumper.php.
Referenced by showReport().
|
protected |
Definition at line 63 of file TextPassDumper.php.
|
protected |
Definition at line 74 of file TextPassDumper.php.
|
protected |
Definition at line 94 of file TextPassDumper.php.
|
protected |
Definition at line 79 of file TextPassDumper.php.
|
protected |
Definition at line 89 of file TextPassDumper.php.
Referenced by openSpawn().
|
protected |
Definition at line 84 of file TextPassDumper.php.
Referenced by openSpawn().
|
private |
Definition at line 46 of file TextPassDumper.php.
|
private |
Definition at line 48 of file TextPassDumper.php.
Referenced by getText().
|
private |
Definition at line 50 of file TextPassDumper.php.
|
protected |
Definition at line 101 of file TextPassDumper.php.
|
protected |
Definition at line 99 of file TextPassDumper.php.