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