maintenance/dumpBackup.php

   1 <?php
   2 /**
   3  * Script that dumps wiki pages or logging database into an XML interchange
   4  * wrapper format for export or backup
   5  *
   6  * Copyright © 2005 Brion Vibber <brion@pobox.com>
   7  * http://www.mediawiki.org/
   8  *
   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.
  13  *
  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.
  18  *
  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
  23  *
  24  * @file
  25  * @ingroup Dump Maintenance
  26  */
  27
  28 $originalDir = getcwd();
  29
  30 $optionsWithArgs = array( 'pagelist', 'start', 'end' );
  31
  32 require_once( dirname( __FILE__ ) . '/commandLine.inc' );
  33 require_once( 'backup.inc' );
  34
  35 $dumper = new BackupDumper( $argv );
  36
  37 if ( isset( $options['quiet'] ) ) {
  38         $dumper->reporting = false;
  39 }
  40
  41 if ( isset( $options['pagelist'] ) ) {
  42         $olddir = getcwd();
  43         chdir( $originalDir );
  44         $pages = file( $options['pagelist'] );
  45         chdir( $olddir );
  46         if ( $pages === false ) {
  47                 wfDie( "Unable to open file {$options['pagelist']}\n" );
  48         }
  49         $pages = array_map( 'trim', $pages );
  50         $dumper->pages = array_filter( $pages, create_function( '$x', 'return $x !== "";' ) );
  51 }
  52
  53 if ( isset( $options['start'] ) ) {
  54         $dumper->startId = intval( $options['start'] );
  55 }
  56 if ( isset( $options['end'] ) ) {
  57         $dumper->endId = intval( $options['end'] );
  58 }
  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'] );
  63
  64 $textMode = isset( $options['stub'] ) ? WikiExporter::STUB : WikiExporter::TEXT;
  65
  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 );
  74 } else {
  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.
  78
  79 XML output is sent to stdout; progress reports are sent to stderr.
  80
  81 Usage: php dumpBackup.php <action> [<options>]
  82 Actions:
  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?
  87   --pagelist=<file>
  88                           Where <file> is a list of page titles to be dumped
  89
  90 Options:
  91   --quiet     Don't dump status reports to stderr.
  92   --report=n  Report position and speed after every n pages processed.
  93                           (Default: 100)
  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)
 103
 104   --wiki=<wiki>  Only back up the specified <wiki>
 105
 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
 111
 112 ENDS
 113 );
 114 }