3 * Script that dumps wiki pages or logging database into an XML interchange
4 * wrapper format for export or backup
6 * Copyright © 2005 Brion Vibber <brion@pobox.com>
7 * http://www.mediawiki.org/
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22 * http://www.gnu.org/copyleft/gpl.html
25 * @ingroup Dump Maintenance
28 $originalDir = getcwd();
30 $optionsWithArgs = array( 'pagelist', 'start', 'end' );
32 require_once( dirname( __FILE__
) . '/commandLine.inc' );
33 require_once( 'backup.inc' );
35 $dumper = new BackupDumper( $argv );
37 if ( isset( $options['quiet'] ) ) {
38 $dumper->reporting
= false;
41 if ( isset( $options['pagelist'] ) ) {
43 chdir( $originalDir );
44 $pages = file( $options['pagelist'] );
46 if ( $pages === false ) {
47 wfDie( "Unable to open file {$options['pagelist']}\n" );
49 $pages = array_map( 'trim', $pages );
50 $dumper->pages
= array_filter( $pages, create_function( '$x', 'return $x !== "";' ) );
53 if ( isset( $options['start'] ) ) {
54 $dumper->startId
= intval( $options['start'] );
56 if ( isset( $options['end'] ) ) {
57 $dumper->endId
= intval( $options['end'] );
59 $dumper->skipHeader
= isset( $options['skip-header'] );
60 $dumper->skipFooter
= isset( $options['skip-footer'] );
61 $dumper->dumpUploads
= isset( $options['uploads'] );
62 $dumper->dumpUploadFileContents
= isset( $options['include-files'] );
64 $textMode = isset( $options['stub'] ) ? WikiExporter
::STUB
: WikiExporter
::TEXT
;
66 if ( isset( $options['full'] ) ) {
67 $dumper->dump( WikiExporter
::FULL
, $textMode );
68 } elseif ( isset( $options['current'] ) ) {
69 $dumper->dump( WikiExporter
::CURRENT
, $textMode );
70 } elseif ( isset( $options['stable'] ) ) {
71 $dumper->dump( WikiExporter
::STABLE
, $textMode );
72 } elseif ( isset( $options['logs'] ) ) {
73 $dumper->dump( WikiExporter
::LOGS
);
75 $dumper->progress( <<<ENDS
76 This script dumps the wiki page or logging database into an
77 XML interchange wrapper format for export or backup.
79 XML output is sent to stdout; progress reports are sent to stderr.
81 Usage: php dumpBackup.php <action> [<options>]
83 --full Dump all revisions of every page.
84 --current Dump only the latest revision of every page.
85 --logs Dump all log events.
86 --stable Stable versions of pages?
88 Where <file> is a list of page titles to be dumped
91 --quiet Don't dump status reports to stderr.
92 --report=n Report position and speed after every n pages processed.
94 --server=h Force reading from MySQL server h
95 --start=n Start from page_id or log_id n
96 --end=n Stop before page_id or log_id n (exclusive)
97 --skip-header Don't output the <mediawiki> header
98 --skip-footer Don't output the </mediawiki> footer
99 --stub Don't perform old_text lookups; for 2-pass dump
100 --uploads Include upload records without files
101 --include-files Include files within the XML stream
102 --conf=<file> Use the specified configuration file (LocalSettings.php)
104 --wiki=<wiki> Only back up the specified <wiki>
106 Fancy stuff: (Works? Add examples please.)
107 --plugin=<class>[:<file>] Load a dump plugin class
108 --output=<type>:<file> Begin a filtered output stream;
109 <type>s: file, gzip, bzip2, 7zip
110 --filter=<type>[:<options>] Add a filter on an output branch