<?php
/**
- * Copyright (C) 2005 Brion Vibber <brion@pobox.com>
- * http://www.mediawiki.org/
- *
+ * Script that dumps wiki pages or logging database into an XML interchange
+ * wrapper format for export or backup
+ *
+ * Copyright © 2005 Brion Vibber <brion@pobox.com>
+ * https://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
*/
-$originalDir = getcwd();
+require_once __DIR__ . '/backup.inc';
-$optionsWithArgs = array( 'server', 'pagelist' );
+class DumpBackup extends BackupDumper {
+ function __construct( $args = null ) {
+ parent::__construct();
-require_once( 'commandLine.inc' );
-require_once( 'SpecialExport.php' );
+ $this->addDescription( <<<TEXT
+This script dumps the wiki page or logging database into an
+XML interchange wrapper format for export or backup.
-class BackupDumper {
- var $reportingInterval = 100;
- var $reporting = true;
- var $pageCount = 0;
- var $revCount = 0;
- var $server = null; // use default
- var $pages = null; // all pages
-
- function BackupDumper() {
+XML output is sent to stdout; progress reports are sent to stderr.
+
+WARNING: this is not a full database dump! It is merely for public export
+ of your wiki. For full backup, see our online help at:
+ https://www.mediawiki.org/wiki/Backup
+TEXT
+ );
$this->stderr = fopen( "php://stderr", "wt" );
- }
-
- function dump( $history ) {
- # This shouldn't happen if on console... ;)
- header( 'Content-type: text/html; charset=UTF-8' );
-
- # 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 );
- $exporter->setPageCallback( array( &$this, 'reportPage' ) );
- $exporter->setRevisionCallback( array( &$this, 'revCount' ) );
-
- $exporter->openStream();
-
- if ( is_null( $this->pages ) ) {
- $exporter->allPages();
- } else {
- $exporter->pagesByName( $this->pages );
- }
+ // Actions
+ $this->addOption( 'full', 'Dump all revisions of every page' );
+ $this->addOption( 'current', 'Dump only the latest revision of every page.' );
+ $this->addOption( 'logs', 'Dump all log events' );
+ $this->addOption( 'stable', 'Dump stable versions of pages' );
+ $this->addOption( 'revrange', 'Dump range of revisions specified by revstart and ' .
+ 'revend parameters' );
+ $this->addOption( 'orderrevs', 'Dump revisions in ascending revision order ' .
+ '(implies dump of a range of pages)' );
+ $this->addOption( 'pagelist',
+ 'Dump only pages included in the file', false, true );
+ // Options
+ $this->addOption( 'start', 'Start from page_id or log_id', false, true );
+ $this->addOption( 'end', 'Stop before page_id or log_id n (exclusive)', false, true );
+ $this->addOption( 'revstart', 'Start from rev_id', false, true );
+ $this->addOption( 'revend', 'Stop before rev_id n (exclusive)', false, true );
+ $this->addOption( 'skip-header', 'Don\'t output the <mediawiki> header' );
+ $this->addOption( 'skip-footer', 'Don\'t output the </mediawiki> footer' );
+ $this->addOption( 'stub', 'Don\'t perform old_text lookups; for 2-pass dump' );
+ $this->addOption( 'uploads', 'Include upload records without files' );
+ $this->addOption( 'include-files', 'Include files within the XML stream' );
- $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" );
- return $db;
- }
-
- function backupServer() {
- global $wgDBserver;
- return $this->server
- ? $this->server
- : $wgDBserver;
+ if ( $args ) {
+ $this->loadWithArgv( $args );
+ $this->processOptions();
+ }
}
- function reportPage( $page ) {
- $this->pageCount++;
- $this->report();
- }
-
- function revCount( $rev ) {
- $this->revCount++;
- }
-
- function report( $final = false ) {
- if( $final xor ( $this->pageCount % $this->reportingInterval == 0 ) ) {
- $this->showReport();
+ function execute() {
+ $this->processOptions();
+
+ $textMode = $this->hasOption( 'stub' ) ? WikiExporter::STUB : WikiExporter::TEXT;
+
+ if ( $this->hasOption( 'full' ) ) {
+ $this->dump( WikiExporter::FULL, $textMode );
+ } elseif ( $this->hasOption( 'current' ) ) {
+ $this->dump( WikiExporter::CURRENT, $textMode );
+ } elseif ( $this->hasOption( 'stable' ) ) {
+ $this->dump( WikiExporter::STABLE, $textMode );
+ } elseif ( $this->hasOption( 'logs' ) ) {
+ $this->dump( WikiExporter::LOGS );
+ } elseif ( $this->hasOption( 'revrange' ) ) {
+ $this->dump( WikiExporter::RANGE, $textMode );
+ } else {
+ $this->error( 'No valid action specified.', 1 );
}
}
-
- function showReport() {
- if( $this->reporting ) {
- $delta = wfTime() - $this->startTime;
- $now = wfTimestamp( TS_DB );
- if( $delta ) {
- $rate = $this->pageCount / $delta;
- $revrate = $this->revCount / $delta;
- $portion = $this->pageCount / $this->maxCount;
- $eta = $this->startTime + $delta / $portion;
- $etats = wfTimestamp( TS_DB, intval( $eta ) );
- } else {
- $rate = '-';
- $revrate = '-';
- $etats = '-';
+
+ function processOptions() {
+ parent::processOptions();
+
+ // Evaluate options specific to this class
+ $this->reporting = !$this->hasOption( 'quiet' );
+
+ if ( $this->hasOption( 'pagelist' ) ) {
+ $filename = $this->getOption( 'pagelist' );
+ $pages = file( $filename );
+ if ( $pages === false ) {
+ $this->fatalError( "Unable to open file {$filename}\n" );
}
- global $wgDBname;
- $this->progress( "$now: $wgDBname $this->pageCount, ETA $etats ($rate pages/sec $revrate revs/sec)" );
+ $pages = array_map( 'trim', $pages );
+ $this->pages = array_filter( $pages, function ( $x ) {
+ return $x !== '';
+ } );
}
- }
-
- function progress( $string ) {
- fwrite( $this->stderr, $string . "\n" );
- }
-}
-$dumper = new BackupDumper();
-if( isset( $options['quiet'] ) ) {
- $dumper->reporting = false;
-}
-if( isset( $options['report'] ) ) {
- $dumper->reportingInterval = IntVal( $options['report'] );
-}
-if( isset( $options['server'] ) ) {
- $dumper->server = $options['server'];
-}
+ if ( $this->hasOption( 'start' ) ) {
+ $this->startId = intval( $this->getOption( 'start' ) );
+ }
-if ( isset( $options['pagelist'] ) ) {
- $olddir = getcwd();
- chdir( $originalDir );
- $pages = file( $options['pagelist'] );
- chdir( $olddir );
- if ( $pages === false ) {
- print "Unable to open file {$options['pagelist']}\n";
- exit;
- }
- $pages = array_map( 'trim', $pages );
- $dumper->pages = array_filter( $pages, create_function( '$x', 'return $x !== "";' ) );
-}
+ if ( $this->hasOption( 'end' ) ) {
+ $this->endId = intval( $this->getOption( 'end' ) );
+ }
-if( isset( $options['full'] ) ) {
- $dumper->dump( MW_EXPORT_FULL );
-} elseif( isset( $options['current'] ) ) {
- $dumper->dump( MW_EXPORT_CURRENT );
-} else {
- $dumper->progress( <<<END
-This script dumps the wiki page database into an XML interchange wrapper
-format for export or backup.
+ if ( $this->hasOption( 'revstart' ) ) {
+ $this->revStartId = intval( $this->getOption( 'revstart' ) );
+ }
-XML output is sent to stdout; progress reports are sent to stderr.
+ if ( $this->hasOption( 'revend' ) ) {
+ $this->revEndId = intval( $this->getOption( 'revend' ) );
+ }
-Usage: php dumpBackup.php <action> [<options>]
-Actions:
- --full Dump complete history of every page.
- --current Includes only the latest revision of each page.
-Options:
- --quiet Don't dump status reports to stderr.
- --report=n Report position and speed after every n pages processed.
- (Default: 100)
-END
-);
+ $this->skipHeader = $this->hasOption( 'skip-header' );
+ $this->skipFooter = $this->hasOption( 'skip-footer' );
+ $this->dumpUploads = $this->hasOption( 'uploads' );
+ $this->dumpUploadFileContents = $this->hasOption( 'include-files' );
+ $this->orderRevs = $this->hasOption( 'orderrevs' );
+ }
}
-?>
+$maintClass = 'DumpBackup';
+require_once RUN_MAINTENANCE_IF_MAIN;
scripts.mit.edu / autoinstallsdev / mediawiki.git / blobdiff