MediaWiki REL1_30
dumpBackup.php
Go to the documentation of this file.
1<?php
28require_once __DIR__ . '/backup.inc';
29
30class DumpBackup extends BackupDumper {
31 function __construct( $args = null ) {
32 parent::__construct();
33
34 $this->addDescription( <<<TEXT
35This script dumps the wiki page or logging database into an
36XML interchange wrapper format for export or backup.
37
38XML output is sent to stdout; progress reports are sent to stderr.
39
40WARNING: this is not a full database dump! It is merely for public export
41 of your wiki. For full backup, see our online help at:
42 https://www.mediawiki.org/wiki/Backup
43TEXT
44 );
45 $this->stderr = fopen( "php://stderr", "wt" );
46 // Actions
47 $this->addOption( 'full', 'Dump all revisions of every page' );
48 $this->addOption( 'current', 'Dump only the latest revision of every page.' );
49 $this->addOption( 'logs', 'Dump all log events' );
50 $this->addOption( 'stable', 'Dump stable versions of pages' );
51 $this->addOption( 'revrange', 'Dump range of revisions specified by revstart and ' .
52 'revend parameters' );
53 $this->addOption( 'orderrevs', 'Dump revisions in ascending revision order ' .
54 '(implies dump of a range of pages)' );
55 $this->addOption( 'pagelist',
56 'Dump only pages included in the file', false, true );
57 // Options
58 $this->addOption( 'start', 'Start from page_id or log_id', false, true );
59 $this->addOption( 'end', 'Stop before page_id or log_id n (exclusive)', false, true );
60 $this->addOption( 'revstart', 'Start from rev_id', false, true );
61 $this->addOption( 'revend', 'Stop before rev_id n (exclusive)', false, true );
62 $this->addOption( 'skip-header', 'Don\'t output the <mediawiki> header' );
63 $this->addOption( 'skip-footer', 'Don\'t output the </mediawiki> footer' );
64 $this->addOption( 'stub', 'Don\'t perform old_text lookups; for 2-pass dump' );
65 $this->addOption( 'uploads', 'Include upload records without files' );
66 $this->addOption( 'include-files', 'Include files within the XML stream' );
67
68 if ( $args ) {
69 $this->loadWithArgv( $args );
70 $this->processOptions();
71 }
72 }
73
74 function execute() {
75 $this->processOptions();
76
77 $textMode = $this->hasOption( 'stub' ) ? WikiExporter::STUB : WikiExporter::TEXT;
78
79 if ( $this->hasOption( 'full' ) ) {
80 $this->dump( WikiExporter::FULL, $textMode );
81 } elseif ( $this->hasOption( 'current' ) ) {
82 $this->dump( WikiExporter::CURRENT, $textMode );
83 } elseif ( $this->hasOption( 'stable' ) ) {
84 $this->dump( WikiExporter::STABLE, $textMode );
85 } elseif ( $this->hasOption( 'logs' ) ) {
86 $this->dump( WikiExporter::LOGS );
87 } elseif ( $this->hasOption( 'revrange' ) ) {
88 $this->dump( WikiExporter::RANGE, $textMode );
89 } else {
90 $this->error( 'No valid action specified.', 1 );
91 }
92 }
93
94 function processOptions() {
95 parent::processOptions();
96
97 // Evaluate options specific to this class
98 $this->reporting = !$this->hasOption( 'quiet' );
99
100 if ( $this->hasOption( 'pagelist' ) ) {
101 $filename = $this->getOption( 'pagelist' );
102 $pages = file( $filename );
103 if ( $pages === false ) {
104 $this->fatalError( "Unable to open file {$filename}\n" );
105 }
106 $pages = array_map( 'trim', $pages );
107 $this->pages = array_filter( $pages, function ( $x ) {
108 return $x !== '';
109 } );
110 }
111
112 if ( $this->hasOption( 'start' ) ) {
113 $this->startId = intval( $this->getOption( 'start' ) );
114 }
115
116 if ( $this->hasOption( 'end' ) ) {
117 $this->endId = intval( $this->getOption( 'end' ) );
118 }
119
120 if ( $this->hasOption( 'revstart' ) ) {
121 $this->revStartId = intval( $this->getOption( 'revstart' ) );
122 }
123
124 if ( $this->hasOption( 'revend' ) ) {
125 $this->revEndId = intval( $this->getOption( 'revend' ) );
126 }
127
128 $this->skipHeader = $this->hasOption( 'skip-header' );
129 $this->skipFooter = $this->hasOption( 'skip-footer' );
130 $this->dumpUploads = $this->hasOption( 'uploads' );
131 $this->dumpUploadFileContents = $this->hasOption( 'include-files' );
132 $this->orderRevs = $this->hasOption( 'orderrevs' );
133 }
134}
135
136$maintClass = 'DumpBackup';
137require_once RUN_MAINTENANCE_IF_MAIN;
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:140
if( $line===false) $args
Definition cdb.php:63
fatalError( $msg)
Definition backup.inc:423
dump( $history, $text=WikiExporter::TEXT)
Definition backup.inc:248
progress( $string)
Definition backup.inc:417
execute()
Do the actual work.
processOptions()
Processes arguments and sets $this->$sink accordingly.
__construct( $args=null)
hasOption( $name)
Checks to see if a particular param exists.
addDescription( $text)
Set the description text.
loadWithArgv( $argv)
Load params and arguments from a given array of command-line arguments.
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
getOption( $name, $default=null)
Get an option, or return the default.
The ContentHandler facility adds support for arbitrary content types on wiki pages
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add in any and then calling output() to send it all. It could be easily changed to send incrementally if that becomes useful
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at https
Definition design.txt:12
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults error
Definition hooks.txt:2581
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:106
$maintClass
require_once RUN_MAINTENANCE_IF_MAIN