MediaWiki  1.33.0
dumpBackup.php
Go to the documentation of this file.
1 <?php
29 require_once __DIR__ . '/includes/BackupDumper.php';
30 
31 class DumpBackup extends BackupDumper {
32  function __construct( $args = null ) {
33  parent::__construct();
34 
35  $this->addDescription( <<<TEXT
36 This script dumps the wiki page or logging database into an
37 XML interchange wrapper format for export or backup.
38 
39 XML output is sent to stdout; progress reports are sent to stderr.
40 
41 WARNING: this is not a full database dump! It is merely for public export
42  of your wiki. For full backup, see our online help at:
43  https://www.mediawiki.org/wiki/Backup
44 TEXT
45  );
46  $this->stderr = fopen( "php://stderr", "wt" );
47  // Actions
48  $this->addOption( 'full', 'Dump all revisions of every page' );
49  $this->addOption( 'current', 'Dump only the latest revision of every page.' );
50  $this->addOption( 'logs', 'Dump all log events' );
51  $this->addOption( 'stable', 'Dump stable versions of pages' );
52  $this->addOption( 'revrange', 'Dump range of revisions specified by revstart and ' .
53  'revend parameters' );
54  $this->addOption( 'orderrevs', 'Dump revisions in ascending revision order ' .
55  '(implies dump of a range of pages)' );
56  $this->addOption( 'pagelist',
57  'Dump only pages included in the file', false, true );
58  // Options
59  $this->addOption( 'start', 'Start from page_id or log_id', false, true );
60  $this->addOption( 'end', 'Stop before page_id or log_id n (exclusive)', false, true );
61  $this->addOption( 'revstart', 'Start from rev_id', false, true );
62  $this->addOption( 'revend', 'Stop before rev_id n (exclusive)', false, true );
63  $this->addOption( 'skip-header', 'Don\'t output the <mediawiki> header' );
64  $this->addOption( 'skip-footer', 'Don\'t output the </mediawiki> footer' );
65  $this->addOption( 'stub', 'Don\'t perform old_text lookups; for 2-pass dump' );
66  $this->addOption( 'uploads', 'Include upload records without files' );
67  $this->addOption( 'include-files', 'Include files within the XML stream' );
68 
69  if ( $args ) {
70  $this->loadWithArgv( $args );
71  $this->processOptions();
72  }
73  }
74 
75  function execute() {
76  $this->processOptions();
77 
78  $textMode = $this->hasOption( 'stub' ) ? WikiExporter::STUB : WikiExporter::TEXT;
79 
80  if ( $this->hasOption( 'full' ) ) {
81  $this->dump( WikiExporter::FULL, $textMode );
82  } elseif ( $this->hasOption( 'current' ) ) {
83  $this->dump( WikiExporter::CURRENT, $textMode );
84  } elseif ( $this->hasOption( 'stable' ) ) {
85  $this->dump( WikiExporter::STABLE, $textMode );
86  } elseif ( $this->hasOption( 'logs' ) ) {
87  $this->dump( WikiExporter::LOGS );
88  } elseif ( $this->hasOption( 'revrange' ) ) {
89  $this->dump( WikiExporter::RANGE, $textMode );
90  } else {
91  $this->fatalError( 'No valid action specified.' );
92  }
93  }
94 
95  function processOptions() {
96  parent::processOptions();
97 
98  // Evaluate options specific to this class
99  $this->reporting = !$this->hasOption( 'quiet' );
100 
101  if ( $this->hasOption( 'pagelist' ) ) {
102  $filename = $this->getOption( 'pagelist' );
103  $pages = file( $filename );
104  if ( $pages === false ) {
105  $this->fatalError( "Unable to open file {$filename}\n" );
106  }
107  $pages = array_map( 'trim', $pages );
108  $this->pages = array_filter( $pages, function ( $x ) {
109  return $x !== '';
110  } );
111  }
112 
113  if ( $this->hasOption( 'start' ) ) {
114  $this->startId = intval( $this->getOption( 'start' ) );
115  }
116 
117  if ( $this->hasOption( 'end' ) ) {
118  $this->endId = intval( $this->getOption( 'end' ) );
119  }
120 
121  if ( $this->hasOption( 'revstart' ) ) {
122  $this->revStartId = intval( $this->getOption( 'revstart' ) );
123  }
124 
125  if ( $this->hasOption( 'revend' ) ) {
126  $this->revEndId = intval( $this->getOption( 'revend' ) );
127  }
128 
129  $this->skipHeader = $this->hasOption( 'skip-header' );
130  $this->skipFooter = $this->hasOption( 'skip-footer' );
131  $this->dumpUploads = $this->hasOption( 'uploads' );
132  $this->dumpUploadFileContents = $this->hasOption( 'include-files' );
133  $this->orderRevs = $this->hasOption( 'orderrevs' );
134  }
135 }
136 
138 require_once RUN_MAINTENANCE_IF_MAIN;
interchange
the intent is to exercise the right to control the distribution of derivative or collective works based on the Program In mere aggregation of another work not based on the Program with the under Section in object code or executable form under the terms of Sections and above provided that you also do one of the which must be distributed under the terms of Sections and above on a medium customarily used for software interchange
Definition: COPYING.txt:139
file
Using a hook running we can avoid having all this option specific stuff in our mainline code Using the function We ve cleaned up the code here by removing clumps of infrequently used code and moving them off somewhere else It s much easier for someone working with this code to see what s _really_ going and make changes or fix bugs In we can take all the code that deals with the little used title reversing we can concentrate it all in an extension file
Definition: hooks.txt:91
captcha-old.help
help
Definition: captcha-old.py:211
Maintenance\fatalError
fatalError( $msg, $exitCode=1)
Output a message and terminate the current script.
Definition: Maintenance.php:485
WikiExporter\CURRENT
const CURRENT
Definition: WikiExporter.php:50
Maintenance\addDescription
addDescription( $text)
Set the description text.
Definition: Maintenance.php:329
wiki
Prior to maintenance scripts were a hodgepodge of code that had no cohesion or formal method of action Beginning maintenance scripts have been cleaned up to use a unified class Directory structure How to run a script How to write your own DIRECTORY STRUCTURE The maintenance directory of a MediaWiki installation contains several all of which have unique purposes HOW TO RUN A SCRIPT Ridiculously just call php someScript php that s in the top level maintenance directory if not default wiki
Definition: maintenance.txt:1
DumpBackup\processOptions
processOptions()
Processes arguments and sets $this->$sink accordingly.
Definition: dumpBackup.php:95
$maintClass
$maintClass
Definition: dumpBackup.php:128
DumpBackup
Definition: dumpBackup.php:31
RUN_MAINTENANCE_IF_MAIN
require_once RUN_MAINTENANCE_IF_MAIN
Definition: maintenance.txt:50
a
</source > ! result< div class="mw-highlight mw-content-ltr" dir="ltr">< pre >< span ></span >< span class="kd"> var</span >< span class="nx"> a</span >< span class="p"></span ></pre ></div > ! end ! test Multiline< source/> in lists !input *< source > a b</source > *foo< source > a b</source > ! html< ul >< li >< div class="mw-highlight mw-content-ltr" dir="ltr">< pre > a b</pre ></div ></li ></ul >< ul >< li > foo< div class="mw-highlight mw-content-ltr" dir="ltr">< pre > a b</pre ></div ></li ></ul > ! html tidy< ul >< li >< div class="mw-highlight mw-content-ltr" dir="ltr">< pre > a b</pre ></div ></li ></ul >< ul >< li > foo< div class="mw-highlight mw-content-ltr" dir="ltr">< pre > a b</pre ></div ></li ></ul > ! end ! test Custom attributes !input< source lang="javascript" id="foo" class="bar" dir="rtl" style="font-size: larger;"> var a
Definition: parserTests.txt:85
page
target page
Definition: All_system_messages.txt:1267
is
This document provides an overview of the usage of PageUpdater and that is
Definition: pageupdater.txt:3
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
pages
The ContentHandler facility adds support for arbitrary content types on wiki pages
Definition: contenthandler.txt:1
Maintenance\loadWithArgv
loadWithArgv( $argv)
Load params and arguments from a given array of command-line arguments.
Definition: Maintenance.php:854
script
script(document.cookie)%253c/script%253e</pre ></div > !! end !! test XSS is escaped(inline) !!input< source lang
WikiExporter\STUB
const STUB
Definition: WikiExporter.php:56
https
scripts txt MediaWiki primary scripts are in the root directory of the software Users should only use these scripts to access the wiki There are also some php that aren t primary scripts but helper files and won t work if they are accessed directly by the web Primary see https
Definition: scripts.txt:21
WikiExporter\TEXT
const TEXT
Definition: WikiExporter.php:55
not
if not
Definition: COPYING.txt:307
Maintenance\addOption
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
Definition: Maintenance.php:248
WikiExporter\STABLE
const STABLE
Definition: WikiExporter.php:51
DumpBackup\execute
execute()
Do the actual work.
Definition: dumpBackup.php:75
or
or
Definition: COPYING.txt:140
see
Some information about database access in MediaWiki By Tim January Database layout For information about the MediaWiki database such as a description of the tables and their please see
Definition: database.txt:2
BackupDumper\$pages
$pages
Definition: BackupDumper.php:41
WikiExporter\FULL
const FULL
Definition: WikiExporter.php:49
BackupDumper\progress
progress( $string)
Definition: BackupDumper.php:426
format
if the prop value should be in the metadata multi language array format
Definition: hooks.txt:1644
DumpBackup\__construct
__construct( $args=null)
Definition: dumpBackup.php:32
WikiExporter\RANGE
const RANGE
Definition: WikiExporter.php:53
$args
if( $line===false) $args
Definition: cdb.php:64
BackupDumper
Definition: BackupDumper.php:39
Maintenance\getOption
getOption( $name, $default=null)
Get an option, or return the default.
Definition: Maintenance.php:283
WikiExporter\LOGS
const LOGS
Definition: WikiExporter.php:52
are
The ContentHandler facility adds support for arbitrary content types on wiki instead of relying on wikitext for everything It was introduced in MediaWiki Each kind of and so on Built in content types are
Definition: contenthandler.txt:5
Maintenance\output
output( $out, $channel=null)
Throw some output to the user.
Definition: Maintenance.php:434
BackupDumper\dump
dump( $history, $text=WikiExporter::TEXT)
Definition: BackupDumper.php:257
of
globals txt Globals are evil The original MediaWiki code relied on globals for processing context far too often MediaWiki development since then has been a story of slowly moving context out of global variables and into objects Storing processing context in object member variables allows those objects to be reused in a much more flexible way Consider the elegance of
Definition: globals.txt:10
class
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:52
Maintenance\hasOption
hasOption( $name)
Checks to see if a particular option exists.
Definition: Maintenance.php:269