X-Git-Url: http://git.cyclocoop.org/?a=blobdiff_plain;f=maintenance%2Fbackup.inc;h=30bd0d88f8fc24e7a8f864cbedb9e79475267c97;hb=fc46b81e3f1ebdf9f93a6539a56a54b0c417ef7b;hp=df9821839bd5d237f2f3ce3a0ca8d8be24da9838;hpb=ee372c39513f5153696ccad2b6f4aa69531b5632;p=lhc%2Fweb%2Fwiklou.git diff --git a/maintenance/backup.inc b/maintenance/backup.inc index df9821839b..30bd0d88f8 100644 --- a/maintenance/backup.inc +++ b/maintenance/backup.inc @@ -2,27 +2,38 @@ /** * Copyright (C) 2005 Brion Vibber * http://www.mediawiki.org/ - * + * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by - * the Free Software Foundation; either version 2 of the License, or + * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. - * + * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. - * + * * You should have received a copy of the GNU General Public License along * with this program; if not, write to the Free Software Foundation, Inc., - * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. * http://www.gnu.org/copyleft/gpl.html * - * @package MediaWiki - * @subpackage SpecialPage + * @file + * @ingroup Dump Maintenance */ +/** + * @ingroup Dump Maintenance + */ +class DumpDBZip2Output extends DumpPipeOutput { + function DumpDBZip2Output( $file ) { + parent::DumpPipeOutput( "dbzip2", $file ); + } +} +/** + * @ingroup Dump Maintenance + */ class BackupDumper { var $reportingInterval = 100; var $reporting = true; @@ -36,41 +47,79 @@ class BackupDumper { var $endId = 0; var $sink = null; // Output filters var $stubText = false; // include rev_text_id instead of text; for 2-pass dump - + var $dumpUploads = false; + function BackupDumper( $args ) { $this->stderr = fopen( "php://stderr", "wt" ); + + // Built-in output and filter plugins + $this->registerOutput( 'file', 'DumpFileOutput' ); + $this->registerOutput( 'gzip', 'DumpGZipOutput' ); + $this->registerOutput( 'bzip2', 'DumpBZip2Output' ); + $this->registerOutput( 'dbzip2', 'DumpDBZip2Output' ); + $this->registerOutput( '7zip', 'Dump7ZipOutput' ); + + $this->registerFilter( 'latest', 'DumpLatestFilter' ); + $this->registerFilter( 'notalk', 'DumpNotalkFilter' ); + $this->registerFilter( 'namespace', 'DumpNamespaceFilter' ); + $this->sink = $this->processArgs( $args ); } - + + /** + * @param string $name + * @param string $class name of output filter plugin class + */ + function registerOutput( $name, $class ) { + $this->outputTypes[$name] = $class; + } + + /** + * @param string $name + * @param string $class name of filter plugin class + */ + function registerFilter( $name, $class ) { + $this->filterTypes[$name] = $class; + } + + /** + * Load a plugin and register it + * @param string $class Name of plugin class; must have a static 'register' + * method that takes a BackupDumper as a parameter. + * @param string $file Full or relative path to the PHP file to load, or empty + */ + function loadPlugin( $class, $file ) { + if( $file != '' ) { + require_once( $file ); + } + $register = array( $class, 'register' ); + call_user_func_array( $register, array( &$this ) ); + } + /** * @param array $args * @return array * @static */ function processArgs( $args ) { - $outputTypes = array( - 'file' => 'DumpFileOutput', - 'gzip' => 'DumpGZipOutput', - 'bzip2' => 'DumpBZip2Output', - '7zip' => 'Dump7ZipOutput' ); - $filterTypes = array( - 'latest' => 'DumpLatestFilter', - 'notalk' => 'DumpNotalkFilter', - 'namespace' => 'DumpNamespaceFilter' ); $sink = null; $sinks = array(); foreach( $args as $arg ) { + $matches = array(); if( preg_match( '/^--(.+?)(?:=(.+?)(?::(.+?))?)?$/', $arg, $matches ) ) { - @list( $full, $opt, $val, $param ) = $matches; + @list( /* $full */ , $opt, $val, $param ) = $matches; switch( $opt ) { + case "plugin": + $this->loadPlugin( $val, $param ); + break; case "output": if( !is_null( $sink ) ) { $sinks[] = $sink; } - if( !isset( $outputTypes[$val] ) ) { - die( "Unrecognized output sink type '$val'\n" ); + if( !isset( $this->outputTypes[$val] ) ) { + wfDie( "Unrecognized output sink type '$val'\n" ); } - $type = $outputTypes[$val]; + $type = $this->outputTypes[$val]; $sink = new $type( $param ); break; case "filter": @@ -78,88 +127,132 @@ class BackupDumper { $this->progress( "Warning: assuming stdout for filter output\n" ); $sink = new DumpOutput(); } - if( !isset( $filterTypes[$val] ) ) { - die( "Unrecognized filter type '$val'\n" ); + if( !isset( $this->filterTypes[$val] ) ) { + wfDie( "Unrecognized filter type '$val'\n" ); } - $type = $filterTypes[$val]; + $type = $this->filterTypes[$val]; $filter = new $type( $sink, $param ); - + // references are lame in php... unset( $sink ); $sink = $filter; - + + break; + case "report": + $this->reportingInterval = intval( $val ); + break; + case "server": + $this->server = $val; + break; + case "force-normal": + if( !function_exists( 'utf8_normalize' ) ) { + dl( "php_utfnormal.so" ); + if( !function_exists( 'utf8_normalize' ) ) { + wfDie( "Failed to load UTF-8 normalization extension. " . + "Install or remove --force-normal parameter to use slower code.\n" ); + } + } break; default: $this->processOption( $opt, $val, $param ); } } } - + if( is_null( $sink ) ) { $sink = new DumpOutput(); } $sinks[] = $sink; - + if( count( $sinks ) > 1 ) { return new DumpMultiWriter( $sinks ); } else { return $sink; } } - + function processOption( $opt, $val, $param ) { // extension point for subclasses to add options } - - function dump( $history, $text = MW_EXPORT_TEXT ) { - # This shouldn't happen if on console... ;) - header( 'Content-type: text/html; charset=UTF-8' ); - + + function dump( $history, $text = WikiExporter::TEXT ) { # Notice messages will foul up your XML output even if they're # relatively harmless. - ini_set( 'display_errors', false ); - - $this->startTime = wfTime(); - - $dbr =& wfGetDB( DB_SLAVE ); - $this->maxCount = $dbr->selectField( 'page', 'MAX(page_id)', '', 'BackupDumper::dump' ); - $this->startTime = wfTime(); - - $db =& $this->backupDb(); - $exporter = new WikiExporter( $db, $history, MW_EXPORT_STREAM, $text ); - + if( ini_get( 'display_errors' ) ) + ini_set( 'display_errors', 'stderr' ); + + $this->initProgress( $history ); + + $db = $this->backupDb(); + $exporter = new WikiExporter( $db, $history, WikiExporter::STREAM, $text ); + $exporter->dumpUploads = $this->dumpUploads; + $wrapper = new ExportProgressFilter( $this->sink, $this ); $exporter->setOutputSink( $wrapper ); - + if( !$this->skipHeader ) $exporter->openStream(); - - if( is_null( $this->pages ) ) { + # Log item dumps: all or by range + if( $history & WikiExporter::LOGS ) { + if( $this->startId || $this->endId ) { + $exporter->logsByRange( $this->startId, $this->endId ); + } else { + $exporter->allLogs(); + } + # Page dumps: all or by page ID range + } else if( is_null( $this->pages ) ) { if( $this->startId || $this->endId ) { $exporter->pagesByRange( $this->startId, $this->endId ); } else { $exporter->allPages(); } + # Dump of specific pages } else { $exporter->pagesByName( $this->pages ); } if( !$this->skipFooter ) $exporter->closeStream(); - + $this->report( true ); } - function &backupDb() { - global $wgDBadminuser, $wgDBadminpassword; - global $wgDBname; - $db =& new Database( $this->backupServer(), $wgDBadminuser, $wgDBadminpassword, $wgDBname ); - $timeout = 3600 * 24; - $db->query( "SET net_read_timeout=$timeout" ); - $db->query( "SET net_write_timeout=$timeout" ); + /** + * Initialise starting time and maximum revision count. + * We'll make ETA calculations based an progress, assuming relatively + * constant per-revision rate. + * @param int $history WikiExporter::CURRENT or WikiExporter::FULL + */ + function initProgress( $history = WikiExporter::FULL ) { + $table = ($history == WikiExporter::CURRENT) ? 'page' : 'revision'; + $field = ($history == WikiExporter::CURRENT) ? 'page_id' : 'rev_id'; + + $dbr = wfGetDB( DB_SLAVE ); + $this->maxCount = $dbr->selectField( $table, "MAX($field)", '', 'BackupDumper::dump' ); + $this->startTime = wfTime(); + } + + /** + * @fixme the --server parameter is currently not respected, as it doesn't seem + * terribly easy to ask the load balancer for a particular connection by name. + */ + function backupDb() { + $this->lb = wfGetLBFactory()->newMainLB(); + $db = $this->lb->getConnection( DB_SLAVE, 'backup' ); + + // Discourage the server from disconnecting us if it takes a long time + // to read out the big ol' batch query. + $db->setTimeout( 3600 * 24 ); + return $db; } + function __destruct() { + if( isset( $this->lb ) ) { + $this->lb->closeAll(); + } + } + function backupServer() { global $wgDBserver; return $this->server @@ -169,19 +262,19 @@ class BackupDumper { function reportPage() { $this->pageCount++; - $this->report(); } - + function revCount() { $this->revCount++; + $this->report(); } - + function report( $final = false ) { - if( $final xor ( $this->pageCount % $this->reportingInterval == 0 ) ) { + if( $final xor ( $this->revCount % $this->reportingInterval == 0 ) ) { $this->showReport(); } } - + function showReport() { if( $this->reporting ) { $delta = wfTime() - $this->startTime; @@ -189,7 +282,7 @@ class BackupDumper { if( $delta ) { $rate = $this->pageCount / $delta; $revrate = $this->revCount / $delta; - $portion = $this->pageCount / $this->maxCount; + $portion = $this->revCount / $this->maxCount; $eta = $this->startTime + $delta / $portion; $etats = wfTimestamp( TS_DB, intval( $eta ) ); } else { @@ -197,11 +290,11 @@ class BackupDumper { $revrate = '-'; $etats = '-'; } - global $wgDBname; - $this->progress( "$now: $wgDBname $this->pageCount, ETA $etats ($rate pages/sec $revrate revs/sec)" ); + $this->progress( sprintf( "%s: %s %d pages (%0.3f/sec), %d revs (%0.3f/sec), ETA %s [max %d]", + $now, wfWikiID(), $this->pageCount, $rate, $this->revCount, $revrate, $etats, $this->maxCount ) ); } } - + function progress( $string ) { fwrite( $this->stderr, $string . "\n" ); } @@ -217,11 +310,9 @@ class ExportProgressFilter extends DumpFilter { parent::writeClosePage( $string ); $this->progress->reportPage(); } - + function writeRevision( $rev, $string ) { parent::writeRevision( $rev, $string ); $this->progress->revCount(); } } - -?>