MediaWiki  master
BackupReader Class Reference

Maintenance script that imports XML dump files into the current wiki. More...

Inheritance diagram for BackupReader:
Collaboration diagram for BackupReader:

Public Member Functions

 __construct ()
 Default constructor. More...
 
 execute ()
 Do the actual work. More...
 
 handleLogItem (WikiRevision $rev)
 
 handleRevision (WikiRevision $rev)
 
 handleUpload (WikiRevision $revision)
 
 reportPage ( $page)
 
- Public Member Functions inherited from Maintenance
 checkRequiredExtensions ()
 Verify that the required extensions are installed. More...
 
 cleanupChanneled ()
 Clean up channeled output. More...
 
 clearParamsAndArgs ()
 Clear all params and arguments. 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 (IMaintainableDatabase $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 (int $pageId)
 Update the searchindex table for a given pageid. More...
 
 validateParamsAndArgs ()
 Run some validation checks on the params, etc Stable for overriding. More...
 

Public Attributes

 $dryRun = false
 
 $imageBasePath = false
 
array false $nsFilter = false
 
 $pageCount = 0
 
 $reportingInterval = 100
 
 $revCount = 0
 
bool resource $stderr
 
 $uploads = false
 
- 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

callable null $importCallback
 
callable null $logItemCallback
 
int $startTime
 
callable null $uploadCallback
 
 $uploadCount = 0
 
- Protected Attributes inherited from Maintenance
 $mAllowUnregisteredOptions = false
 
 $mArgList = []
 
 $mArgs = []
 
int $mBatchSize = null
 Batch size. More...
 
 $mDbUser
 
 $mDescription = ''
 
 $mInputLoaded = false
 
 $mOptions = []
 
array[] $mParams = []
 Array of desired/allowed params. More...
 
 $mQuiet = false
 
 $mSelf
 
 $mShortParamsMap = []
 

Private Member Functions

 getNsIndex ( $namespace)
 
 importFromFile ( $filename)
 
 importFromHandle ( $handle)
 
 importFromStdin ()
 
 progress ( $string)
 
 report ( $final=false)
 
 setNsfilter (array $namespaces)
 
 showReport ()
 
 skippedNamespace ( $title)
 

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 @stable for overriding. 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=[], $dbDomain=false)
 Returns a database to be used by current maintenance script. More...
 
 getDir ()
 Get the maintenance directory. More...
 
 getHookContainer ()
 Get a HookContainer, for running extension hooks or for hook metadata. More...
 
 getHookRunner ()
 Get a HookRunner for running core hooks. 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 @stable for overriding. More...
 
 maybeHelp ( $force=false)
 Maybe show the help. More...
 
 output ( $out, $channel=null)
 Throw some output to the user. More...
 
 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). 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...
 
 showHelp ()
 Definitely show the help. More...
 
 supportsOption ( $name)
 Checks to see if a particular option in supported. More...
 

Detailed Description

Maintenance script that imports XML dump files into the current wiki.

Definition at line 37 of file importDump.php.

Constructor & Destructor Documentation

◆ __construct()

BackupReader::__construct ( )

Default constructor.

Children should call this first if implementing their own constructors

Stable for calling

Reimplemented from Maintenance.

Definition at line 58 of file importDump.php.

References Maintenance\addArg(), Maintenance\addDescription(), and Maintenance\addOption().

Member Function Documentation

◆ execute()

BackupReader::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 Maintenance.

Definition at line 108 of file importDump.php.

References Maintenance\fatalError(), Maintenance\getArg(), Maintenance\getOption(), Maintenance\hasArg(), Maintenance\hasOption(), importFromFile(), importFromStdin(), Maintenance\output(), setNsfilter(), and wfReadOnly().

◆ getNsIndex()

BackupReader::getNsIndex (   $namespace)
private

Definition at line 149 of file importDump.php.

References Maintenance\fatalError().

◆ handleLogItem()

BackupReader::handleLogItem ( WikiRevision  $rev)
Parameters
WikiRevision$rev

Definition at line 233 of file importDump.php.

References WikiRevision\getTitle(), report(), and skippedNamespace().

◆ handleRevision()

BackupReader::handleRevision ( WikiRevision  $rev)
Parameters
WikiRevision$rev

Definition at line 185 of file importDump.php.

References $title, WikiRevision\getTitle(), progress(), report(), and skippedNamespace().

◆ handleUpload()

BackupReader::handleUpload ( WikiRevision  $revision)
Parameters
WikiRevision$revision
Returns
bool

Definition at line 209 of file importDump.php.

References DB_MASTER, Maintenance\getDB(), WikiRevision\getFilename(), WikiRevision\getTitle(), progress(), and skippedNamespace().

◆ importFromFile()

BackupReader::importFromFile (   $filename)
private

Definition at line 275 of file importDump.php.

References $file, and importFromHandle().

Referenced by execute().

◆ importFromHandle()

BackupReader::importFromHandle (   $handle)
private

◆ importFromStdin()

BackupReader::importFromStdin ( )
private

Definition at line 289 of file importDump.php.

References $file, importFromHandle(), and Maintenance\maybeHelp().

Referenced by execute().

◆ progress()

BackupReader::progress (   $string)
private

Definition at line 271 of file importDump.php.

Referenced by handleRevision(), handleUpload(), and showReport().

◆ report()

BackupReader::report (   $final = false)
private

Definition at line 245 of file importDump.php.

References showReport().

Referenced by handleLogItem(), and handleRevision().

◆ reportPage()

BackupReader::reportPage (   $page)

Definition at line 178 of file importDump.php.

◆ setNsfilter()

BackupReader::setNsfilter ( array  $namespaces)
private

Definition at line 140 of file importDump.php.

Referenced by execute().

◆ showReport()

BackupReader::showReport ( )
private

Definition at line 251 of file importDump.php.

References $startTime, and progress().

Referenced by report().

◆ skippedNamespace()

BackupReader::skippedNamespace (   $title)
private
Parameters
LinkTarget | null$title
Exceptions
MWException
Returns
bool

Definition at line 167 of file importDump.php.

References $title.

Referenced by handleLogItem(), handleRevision(), and handleUpload().

Member Data Documentation

◆ $dryRun

BackupReader::$dryRun = false

Definition at line 41 of file importDump.php.

◆ $imageBasePath

BackupReader::$imageBasePath = false

Definition at line 44 of file importDump.php.

◆ $importCallback

callable null BackupReader::$importCallback
protected

Definition at line 50 of file importDump.php.

◆ $logItemCallback

callable null BackupReader::$logItemCallback
protected

Definition at line 52 of file importDump.php.

◆ $nsFilter

array false BackupReader::$nsFilter = false

Definition at line 46 of file importDump.php.

◆ $pageCount

BackupReader::$pageCount = 0

Definition at line 39 of file importDump.php.

◆ $reportingInterval

BackupReader::$reportingInterval = 100

Definition at line 38 of file importDump.php.

◆ $revCount

BackupReader::$revCount = 0

Definition at line 40 of file importDump.php.

◆ $startTime

int BackupReader::$startTime
protected

Definition at line 56 of file importDump.php.

Referenced by showReport().

◆ $stderr

bool resource BackupReader::$stderr

Definition at line 48 of file importDump.php.

◆ $uploadCallback

callable null BackupReader::$uploadCallback
protected

Definition at line 54 of file importDump.php.

◆ $uploadCount

BackupReader::$uploadCount = 0
protected

Definition at line 43 of file importDump.php.

◆ $uploads

BackupReader::$uploads = false

Definition at line 42 of file importDump.php.


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