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  * https://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 require_once __DIR__ . '/backup.inc';
  29
  30 class DumpBackup extends BackupDumper {
  31         function __construct( $args = null ) {
  32                 parent::__construct();
  33
  34                 $this->addDescription( <<<TEXT
  35 This script dumps the wiki page or logging database into an
  36 XML interchange wrapper format for export or backup.
  37
  38 XML output is sent to stdout; progress reports are sent to stderr.
  39
  40 WARNING: 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
  43 TEXT
  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';
 137 require_once RUN_MAINTENANCE_IF_MAIN;