MediaWiki  REL1_31
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 ( $rev)
 handleRevision ( $rev)
 handleUpload ( $revision)
 importFromFile ( $filename)
 importFromHandle ( $handle)
 importFromStdin ()
 progress ( $string)
 report ( $final=false)
 reportPage ( $page)
 setNsfilter (array $namespaces)
 showReport ()
- 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 (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...

Public Attributes

 $dryRun = false
 $imageBasePath = false
 $nsFilter = false
 $pageCount = 0
 $reportingInterval = 100
 $revCount = 0
 $uploads = false
- Public Attributes inherited from Maintenance
resource $fileHandle
 Used when creating separate schema files. More...
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

 $uploadCount = 0
- Protected Attributes inherited from Maintenance
 $mArgList = []
 $mArgs = []
int $mBatchSize = null
 Batch size. More...
 $mDescription = ''
 $mInputLoaded = false
 $mOptions = []
 $mParams = []
 $mQuiet = false
 $mShortParamsMap = []

Private Member Functions

 getNsIndex ( $namespace)
 skippedNamespace ( $obj)

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 param 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...
 setBatchSize ( $s=0)
 Set the batch size. More...
 validateParamsAndArgs ()
 Run some validation checks on the params, etc. More...

Detailed Description

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

Definition at line 34 of file importDump.php.

Constructor & Destructor Documentation

◆ __construct()

BackupReader::__construct ( )

Default constructor.

Children should call this first if implementing their own constructors

Reimplemented from Maintenance.

Definition at line 44 of file importDump.php.

References Maintenance\addArg(), Maintenance\addDescription(), Maintenance\addOption(), and(), are, as, data, directly, file, files(), from, https, in, is(), or, pages, reads(), Special, that, them, there, and wiki.

Member Function Documentation

◆ execute()

BackupReader::execute ( )

Do the actual work.

All child classes will need to implement this

Reimplemented from Maintenance.

Definition at line 94 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)

Definition at line 133 of file importDump.php.

References $wgContLang, Maintenance\fatalError(), and global.

◆ handleLogItem()

BackupReader::handleLogItem (   $rev)

Definition at line 225 of file importDump.php.

References $rev, report(), and skippedNamespace().

◆ handleRevision()

BackupReader::handleRevision (   $rev)

Definition at line 180 of file importDump.php.

References $rev, $title, progress(), report(), and skippedNamespace().

◆ handleUpload()

BackupReader::handleUpload (   $revision)

Definition at line 204 of file importDump.php.

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

◆ importFromFile()

BackupReader::importFromFile (   $filename)

Definition at line 267 of file importDump.php.

References importFromHandle().

Referenced by execute().

◆ importFromHandle()

BackupReader::importFromHandle (   $handle)

◆ importFromStdin()

BackupReader::importFromStdin ( )

Definition at line 281 of file importDump.php.

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

Referenced by execute().

◆ progress()

BackupReader::progress (   $string)

Definition at line 263 of file importDump.php.

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

◆ report()

BackupReader::report (   $final = false)

Definition at line 237 of file importDump.php.

References showReport().

Referenced by handleLogItem(), and handleRevision().

◆ reportPage()

BackupReader::reportPage (   $page)

Definition at line 173 of file importDump.php.

◆ setNsfilter()

BackupReader::setNsfilter ( array  $namespaces)

Definition at line 124 of file importDump.php.

References $namespaces.

Referenced by execute().

◆ showReport()

BackupReader::showReport ( )

Definition at line 243 of file importDump.php.

References progress(), and wfWaitForSlaves().

Referenced by report().

◆ skippedNamespace()

BackupReader::skippedNamespace (   $obj)
Title | Revision$obj

Definition at line 151 of file importDump.php.

References $title.

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

Member Data Documentation

◆ $dryRun

BackupReader::$dryRun = false

Definition at line 38 of file importDump.php.

◆ $imageBasePath

BackupReader::$imageBasePath = false

Definition at line 41 of file importDump.php.

◆ $nsFilter

BackupReader::$nsFilter = false

Definition at line 42 of file importDump.php.

◆ $pageCount

BackupReader::$pageCount = 0

Definition at line 36 of file importDump.php.

◆ $reportingInterval

BackupReader::$reportingInterval = 100

Definition at line 35 of file importDump.php.

◆ $revCount

BackupReader::$revCount = 0

Definition at line 37 of file importDump.php.

◆ $uploadCount

BackupReader::$uploadCount = 0

Definition at line 40 of file importDump.php.

◆ $uploads

BackupReader::$uploads = false

Definition at line 39 of file importDump.php.

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