MediaWiki  master
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  $this->addOption( 'namespaces', 'Limit to this comma-separated list of namespace numbers' );
69 
70  if ( $args ) {
71  $this->loadWithArgv( $args );
72  $this->processOptions();
73  }
74  }
75 
76  function execute() {
77  $this->processOptions();
78 
79  $textMode = $this->hasOption( 'stub' ) ? WikiExporter::STUB : WikiExporter::TEXT;
80 
81  if ( $this->hasOption( 'full' ) ) {
82  $this->dump( WikiExporter::FULL, $textMode );
83  } elseif ( $this->hasOption( 'current' ) ) {
84  $this->dump( WikiExporter::CURRENT, $textMode );
85  } elseif ( $this->hasOption( 'stable' ) ) {
86  $this->dump( WikiExporter::STABLE, $textMode );
87  } elseif ( $this->hasOption( 'logs' ) ) {
88  $this->dump( WikiExporter::LOGS );
89  } elseif ( $this->hasOption( 'revrange' ) ) {
90  $this->dump( WikiExporter::RANGE, $textMode );
91  } else {
92  $this->fatalError( 'No valid action specified.' );
93  }
94  }
95 
96  function processOptions() {
97  parent::processOptions();
98 
99  // Evaluate options specific to this class
100  $this->reporting = !$this->hasOption( 'quiet' );
101 
102  if ( $this->hasOption( 'pagelist' ) ) {
103  $filename = $this->getOption( 'pagelist' );
104  $pages = file( $filename );
105  if ( $pages === false ) {
106  $this->fatalError( "Unable to open file {$filename}\n" );
107  }
108  $pages = array_map( 'trim', $pages );
109  $this->pages = array_filter( $pages, function ( $x ) {
110  return $x !== '';
111  } );
112  }
113 
114  if ( $this->hasOption( 'start' ) ) {
115  $this->startId = intval( $this->getOption( 'start' ) );
116  }
117 
118  if ( $this->hasOption( 'end' ) ) {
119  $this->endId = intval( $this->getOption( 'end' ) );
120  }
121 
122  if ( $this->hasOption( 'revstart' ) ) {
123  $this->revStartId = intval( $this->getOption( 'revstart' ) );
124  }
125 
126  if ( $this->hasOption( 'revend' ) ) {
127  $this->revEndId = intval( $this->getOption( 'revend' ) );
128  }
129 
130  $this->skipHeader = $this->hasOption( 'skip-header' );
131  $this->skipFooter = $this->hasOption( 'skip-footer' );
132  $this->dumpUploads = $this->hasOption( 'uploads' );
133  $this->dumpUploadFileContents = $this->hasOption( 'include-files' );
134  $this->orderRevs = $this->hasOption( 'orderrevs' );
135  if ( $this->hasOption( 'namespaces' ) ) {
136  $this->limitNamespaces = explode( ',', $this->getOption( 'namespaces' ) );
137  } else {
138  $this->limitNamespaces = null;
139  }
140  }
141 }
142 
144 require_once RUN_MAINTENANCE_IF_MAIN;
dump( $history, $text=WikiExporter::TEXT)
processOptions()
Definition: dumpBackup.php:96
getOption( $name, $default=null)
Get an option, or return the default.
progress( $string)
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
database rows
Definition: globals.txt:10
hasOption( $name)
Checks to see if a particular option exists.
require_once RUN_MAINTENANCE_IF_MAIN
Definition: maintenance.txt:50
target page
loadWithArgv( $argv)
Load params and arguments from a given array of command-line arguments.
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
This document provides an overview of the usage of PageUpdater and that is
Definition: pageupdater.txt:3
if( $line===false) $args
Definition: cdb.php:64
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
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
addDescription( $text)
Set the description text.
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
$maintClass
Definition: dumpBackup.php:134
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
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:767
output( $out, $channel=null)
Throw some output to the user.
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
The ContentHandler facility adds support for arbitrary content types on wiki pages
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
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
fatalError( $msg, $exitCode=1)
Output a message and terminate the current script.
__construct( $args=null)
Definition: dumpBackup.php:32
if the prop value should be in the metadata multi language array format
Definition: hooks.txt:1622