maintenance/backup.inc

   1 <?php
   2 /**
   3  * Copyright (C) 2005 Brion Vibber <brion@pobox.com>
   4  * http://www.mediawiki.org/
   5  *
   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.
  10  *
  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.
  15  *
  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
  20  *
  21  * @addtogroup SpecialPage
  22  */
  23
  24 class DumpDBZip2Output extends DumpPipeOutput {
  25         function DumpDBZip2Output( $file ) {
  26                 parent::DumpPipeOutput( "dbzip2", $file );
  27         }
  28 }
  29
  30 class BackupDumper {
  31         var $reportingInterval = 100;
  32         var $reporting = true;
  33         var $pageCount = 0;
  34         var $revCount  = 0;
  35         var $server    = null; // use default
  36         var $pages     = null; // all pages
  37         var $skipHeader = false; // don't output <mediawiki> and <siteinfo>
  38         var $skipFooter = false; // don't output </mediawiki>
  39         var $startId    = 0;
  40         var $endId      = 0;
  41         var $sink       = null; // Output filters
  42         var $stubText   = false; // include rev_text_id instead of text; for 2-pass dump
  43
  44         function BackupDumper( $args ) {
  45                 $this->stderr = fopen( "php://stderr", "wt" );
  46
  47                 // Built-in output and filter plugins
  48                 $this->registerOutput( 'file', 'DumpFileOutput' );
  49                 $this->registerOutput( 'gzip', 'DumpGZipOutput' );
  50                 $this->registerOutput( 'bzip2', 'DumpBZip2Output' );
  51                 $this->registerOutput( 'dbzip2', 'DumpDBZip2Output' );
  52                 $this->registerOutput( '7zip', 'Dump7ZipOutput' );
  53
  54                 $this->registerFilter( 'latest', 'DumpLatestFilter' );
  55                 $this->registerFilter( 'notalk', 'DumpNotalkFilter' );
  56                 $this->registerFilter( 'namespace', 'DumpNamespaceFilter' );
  57
  58                 $this->sink = $this->processArgs( $args );
  59         }
  60
  61         /**
  62          * @param string $name
  63          * @param string $class name of output filter plugin class
  64          */
  65         function registerOutput( $name, $class ) {
  66                 $this->outputTypes[$name] = $class;
  67         }
  68
  69         /**
  70          * @param string $name
  71          * @param string $class name of filter plugin class
  72          */
  73         function registerFilter( $name, $class ) {
  74                 $this->filterTypes[$name] = $class;
  75         }
  76
  77         /**
  78          * Load a plugin and register it
  79          * @param string $class Name of plugin class; must have a static 'register'
  80          *                      method that takes a BackupDumper as a parameter.
  81          * @param string $file Full or relative path to the PHP file to load, or empty
  82          */
  83         function loadPlugin( $class, $file ) {
  84                 if( $file != '' ) {
  85                         require_once( $file );
  86                 }
  87                 $register = array( $class, 'register' );
  88                 call_user_func_array( $register, array( &$this ) );
  89         }
  90
  91         /**
  92          * @param array $args
  93          * @return array
  94          * @static
  95          */
  96         function processArgs( $args ) {
  97                 $sink = null;
  98                 $sinks = array();
  99                 foreach( $args as $arg ) {
 100                         $matches = array();
 101                         if( preg_match( '/^--(.+?)(?:=(.+?)(?::(.+?))?)?$/', $arg, $matches ) ) {
 102                                 @list( /* $full */ , $opt, $val, $param ) = $matches;
 103                                 switch( $opt ) {
 104                                 case "plugin":
 105                                         $this->loadPlugin( $val, $param );
 106                                         break;
 107                                 case "output":
 108                                         if( !is_null( $sink ) ) {
 109                                                 $sinks[] = $sink;
 110                                         }
 111                                         if( !isset( $this->outputTypes[$val] ) ) {
 112                                                 wfDie( "Unrecognized output sink type '$val'\n" );
 113                                         }
 114                                         $type = $this->outputTypes[$val];
 115                                         $sink = new $type( $param );
 116                                         break;
 117                                 case "filter":
 118                                         if( is_null( $sink ) ) {
 119                                                 $this->progress( "Warning: assuming stdout for filter output\n" );
 120                                                 $sink = new DumpOutput();
 121                                         }
 122                                         if( !isset( $this->filterTypes[$val] ) ) {
 123                                                 wfDie( "Unrecognized filter type '$val'\n" );
 124                                         }
 125                                         $type = $this->filterTypes[$val];
 126                                         $filter = new $type( $sink, $param );
 127
 128                                         // references are lame in php...
 129                                         unset( $sink );
 130                                         $sink = $filter;
 131
 132                                         break;
 133                                 case "report":
 134                                         $this->reportingInterval = intval( $val );
 135                                         break;
 136                                 case "server":
 137                                         $this->server = $val;
 138                                         break;
 139                                 case "force-normal":
 140                                         if( !function_exists( 'utf8_normalize' ) ) {
 141                                                 dl( "php_utfnormal.so" );
 142                                                 if( !function_exists( 'utf8_normalize' ) ) {
 143                                                         wfDie( "Failed to load UTF-8 normalization extension. " .
 144                                                                 "Install or remove --force-normal parameter to use slower code.\n" );
 145                                                 }
 146                                         }
 147                                         break;
 148                                 default:
 149                                         $this->processOption( $opt, $val, $param );
 150                                 }
 151                         }
 152                 }
 153
 154                 if( is_null( $sink ) ) {
 155                         $sink = new DumpOutput();
 156                 }
 157                 $sinks[] = $sink;
 158
 159                 if( count( $sinks ) > 1 ) {
 160                         return new DumpMultiWriter( $sinks );
 161                 } else {
 162                         return $sink;
 163                 }
 164         }
 165
 166         function processOption( $opt, $val, $param ) {
 167                 // extension point for subclasses to add options
 168         }
 169
 170         function dump( $history, $text = MW_EXPORT_TEXT ) {
 171                 # Notice messages will foul up your XML output even if they're
 172                 # relatively harmless.
 173                 if( ini_get( 'display_errors' ) )
 174                         ini_set( 'display_errors', 'stderr' );
 175
 176                 $this->initProgress( $history );
 177
 178                 $db = $this->backupDb();
 179                 $exporter = new WikiExporter( $db, $history, WikiExporter::STREAM, $text );
 180
 181                 $wrapper = new ExportProgressFilter( $this->sink, $this );
 182                 $exporter->setOutputSink( $wrapper );
 183
 184                 if( !$this->skipHeader )
 185                         $exporter->openStream();
 186
 187                 if( is_null( $this->pages ) ) {
 188                         if( $this->startId || $this->endId ) {
 189                                 $exporter->pagesByRange( $this->startId, $this->endId );
 190                         } else {
 191                                 $exporter->allPages();
 192                         }
 193                 } else {
 194                         $exporter->pagesByName( $this->pages );
 195                 }
 196
 197                 if( !$this->skipFooter )
 198                         $exporter->closeStream();
 199
 200                 $this->report( true );
 201         }
 202
 203         /**
 204          * Initialise starting time and maximum revision count.
 205          * We'll make ETA calculations based an progress, assuming relatively
 206          * constant per-revision rate.
 207          * @param int $history WikiExporter::CURRENT or WikiExporter::FULL
 208          */
 209         function initProgress( $history = WikiExporter::FULL ) {
 210                 $table = ($history == WikiExporter::CURRENT) ? 'page' : 'revision';
 211                 $field = ($history == WikiExporter::CURRENT) ? 'page_id' : 'rev_id';
 212
 213                 $dbr = wfGetDB( DB_SLAVE );
 214                 $this->maxCount = $dbr->selectField( $table, "MAX($field)", '', 'BackupDumper::dump' );
 215                 $this->startTime = wfTime();
 216         }
 217
 218         function backupDb() {
 219                 global $wgDBadminuser, $wgDBadminpassword;
 220                 global $wgDBname, $wgDebugDumpSql, $wgDBtype;
 221                 $flags = ($wgDebugDumpSql ? DBO_DEBUG : 0) | DBO_DEFAULT; // god-damn hack
 222
 223                 $class = 'Database' . ucfirst($wgDBtype);
 224                 $db = new $class( $this->backupServer(), $wgDBadminuser, $wgDBadminpassword, $wgDBname, false, $flags );
 225
 226                 // Discourage the server from disconnecting us if it takes a long time
 227                 // to read out the big ol' batch query.
 228                 $db->setTimeout( 3600 * 24 );
 229
 230                 return $db;
 231         }
 232
 233         function backupServer() {
 234                 global $wgDBserver;
 235                 return $this->server
 236                         ? $this->server
 237                         : $wgDBserver;
 238         }
 239
 240         function reportPage() {
 241                 $this->pageCount++;
 242         }
 243
 244         function revCount() {
 245                 $this->revCount++;
 246                 $this->report();
 247         }
 248
 249         function report( $final = false ) {
 250                 if( $final xor ( $this->revCount % $this->reportingInterval == 0 ) ) {
 251                         $this->showReport();
 252                 }
 253         }
 254
 255         function showReport() {
 256                 if( $this->reporting ) {
 257                         $delta = wfTime() - $this->startTime;
 258                         $now = wfTimestamp( TS_DB );
 259                         if( $delta ) {
 260                                 $rate = $this->pageCount / $delta;
 261                                 $revrate = $this->revCount / $delta;
 262                                 $portion = $this->revCount / $this->maxCount;
 263                                 $eta = $this->startTime + $delta / $portion;
 264                                 $etats = wfTimestamp( TS_DB, intval( $eta ) );
 265                         } else {
 266                                 $rate = '-';
 267                                 $revrate = '-';
 268                                 $etats = '-';
 269                         }
 270                         $this->progress( sprintf( "%s: %s %d pages (%0.3f/sec), %d revs (%0.3f/sec), ETA %s [max %d]",
 271                                 $now, wfWikiID(), $this->pageCount, $rate, $this->revCount, $revrate, $etats, $this->maxCount ) );
 272                 }
 273         }
 274
 275         function progress( $string ) {
 276                 fwrite( $this->stderr, $string . "\n" );
 277         }
 278 }
 279
 280 class ExportProgressFilter extends DumpFilter {
 281         function ExportProgressFilter( &$sink, &$progress ) {
 282                 parent::DumpFilter( $sink );
 283                 $this->progress = $progress;
 284         }
 285
 286         function writeClosePage( $string ) {
 287                 parent::writeClosePage( $string );
 288                 $this->progress->reportPage();
 289         }
 290
 291         function writeRevision( $rev, $string ) {
 292                 parent::writeRevision( $rev, $string );
 293                 $this->progress->revCount();
 294         }
 295 }
 296
 297 ?>