X-Git-Url: http://git.cyclocoop.org/?a=blobdiff_plain;f=maintenance%2FimportDump.php;h=b6e0fe09e5e40199c0aff5773391b66ce0434162;hb=d266f40a2f828810d0249de1fdd7107a026066d4;hp=21894a62a48010400c78be6736eabb5b9c38b9d1;hpb=af2177edfd9b108eca8598f9ace57672f0521942;p=lhc%2Fweb%2Fwiklou.git

diff --git a/maintenance/importDump.php b/maintenance/importDump.php
index 21894a62a4..b6e0fe09e5 100644
--- a/maintenance/importDump.php
+++ b/maintenance/importDump.php
@@ -1,6 +1,8 @@
 <?php
 /**
- * Copyright (C) 2005 Brion Vibber <brion@pobox.com>
+ * Import XML dump files into the current wiki.
+ *
+ * Copyright © 2005 Brion Vibber <brion@pobox.com>
  * http://www.mediawiki.org/
  *
  * This program is free software; you can redistribute it and/or modify
@@ -15,68 +17,215 @@
  *
  * 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 Maintenance
+ * @file
+ * @ingroup Maintenance
  */
 
-$optionsWithArgs = array( 'report' );
-
-require_once( 'commandLine.inc' );
-require_once( 'SpecialImport.php' );
+require_once( dirname( __FILE__ ) . '/Maintenance.php' );
 
-class BackupReader {
+/**
+ * Maintenance script that imports XML dump files into the current wiki.
+ *
+ * @ingroup Maintenance
+ */
+class BackupReader extends Maintenance {
 	var $reportingInterval = 100;
-	var $reporting = true;
 	var $pageCount = 0;
 	var $revCount  = 0;
 	var $dryRun    = false;
+	var $uploads   = false;
+	var $imageBasePath = false;
+	var $nsFilter  = false;
+
+	function __construct() {
+		parent::__construct();
+		$gz = in_array('compress.zlib', stream_get_wrappers()) ? 'ok' : '(disabled; requires PHP zlib module)';
+		$bz2 = in_array('compress.bzip2', stream_get_wrappers()) ? 'ok' : '(disabled; requires PHP bzip2 module)';
+
+		$this->mDescription = <<<TEXT
+This script reads pages from an XML file as produced from Special:Export or
+dumpBackup.php, and saves them into the current wiki.
+
+Compressed XML files may be read directly:
+  .gz $gz
+  .bz2 $bz2
+  .7z (if 7za executable is in PATH)
 
-	function BackupReader() {
+Note that for very large data sets, importDump.php may be slow; there are
+alternate methods which can be much faster for full site restoration:
+<http://www.mediawiki.org/wiki/Manual:Importing_XML_dumps>
+TEXT;
 		$this->stderr = fopen( "php://stderr", "wt" );
+		$this->addOption( 'report',
+			'Report position and speed after every n pages processed', false, true );
+		$this->addOption( 'namespaces',
+			'Import only the pages from namespaces belonging to the list of ' .
+			'pipe-separated namespace names or namespace indexes', false, true );
+		$this->addOption( 'dry-run', 'Parse dump without actually importing pages' );
+		$this->addOption( 'debug', 'Output extra verbose debug information' );
+		$this->addOption( 'uploads', 'Process file upload data if included (experimental)' );
+		$this->addOption( 'no-updates', 'Disable link table updates. Is faster but leaves the wiki in an inconsistent state' );
+		$this->addOption( 'image-base-path', 'Import files from a specified path', false, true );
+		$this->addArg( 'file', 'Dump file to import [else use stdin]', false );
+	}
+
+	public function execute() {
+		if( wfReadOnly() ) {
+			$this->error( "Wiki is in read-only mode; you'll need to disable it for import to work.", true );
+		}
+
+		$this->reportingInterval = intval( $this->getOption( 'report', 100 ) );
+		if ( !$this->reportingInterval ) {
+			$this->reportingInterval = 100; // avoid division by zero
+		}
+
+		$this->dryRun = $this->hasOption( 'dry-run' );
+		$this->uploads = $this->hasOption( 'uploads' ); // experimental!
+		if ( $this->hasOption( 'image-base-path' ) ) {
+			$this->imageBasePath = $this->getOption( 'image-base-path' );
+		}
+		if ( $this->hasOption( 'namespaces' ) ) {
+			$this->setNsfilter( explode( '|', $this->getOption( 'namespaces' ) ) );
+		}
+
+		if( $this->hasArg() ) {
+			$this->importFromFile( $this->getArg() );
+		} else {
+			$this->importFromStdin();
+		}
+
+		$this->output( "Done!\n" );
+		$this->output( "You might want to run rebuildrecentchanges.php to regenerate RecentChanges\n" );
+	}
+
+	function setNsfilter( array $namespaces ) {
+		if ( count( $namespaces ) == 0 ) {
+			$this->nsFilter = false;
+			return;
+		}
+		$this->nsFilter = array_unique( array_map( array( $this, 'getNsIndex' ), $namespaces ) );
+	}
+
+	private function getNsIndex( $namespace ) {
+		global $wgContLang;
+		if ( ( $result = $wgContLang->getNsIndex( $namespace ) ) !== false ) {
+			return $result;
+		}
+		$ns = intval( $namespace );
+		if ( strval( $ns ) === $namespace && $wgContLang->getNsText( $ns ) !== false ) {
+			return $ns;
+		}
+		$this->error( "Unknown namespace text / index specified: $namespace", true );
+	}
+
+	/**
+	 * @param $obj Title|Revision
+	 * @return bool
+	 */
+	private function skippedNamespace( $obj ) {
+		if ( $obj instanceof Title ) {
+			$ns = $obj->getNamespace();
+		} elseif ( $obj instanceof Revision ) {
+			$ns = $obj->getTitle()->getNamespace();
+		} elseif ( $obj instanceof WikiRevision ) {
+			$ns = $obj->title->getNamespace();
+		} else {
+			echo wfBacktrace();
+			$this->error( "Cannot get namespace of object in " . __METHOD__, true );
+		}
+		return is_array( $this->nsFilter ) && !in_array( $ns, $this->nsFilter );
 	}
 
 	function reportPage( $page ) {
 		$this->pageCount++;
 	}
 
+	/**
+	 * @param $rev Revision
+	 * @return mixed
+	 */
 	function handleRevision( $rev ) {
 		$title = $rev->getTitle();
-		if (!$title) {
+		if ( !$title ) {
+			$this->progress( "Got bogus revision with null title!" );
+			return;
+		}
+
+		if ( $this->skippedNamespace( $title ) ) {
 			return;
 		}
-		$display = $title->getPrefixedText();
-		$timestamp = $rev->getTimestamp();
-		#echo "$display $timestamp\n";
 
 		$this->revCount++;
 		$this->report();
 
-		if( !$this->dryRun ) {
+		if ( !$this->dryRun ) {
 			call_user_func( $this->importCallback, $rev );
 		}
 	}
 
+	/**
+	 * @param $revision Revision
+	 * @return bool
+	 */
+	function handleUpload( $revision ) {
+		if ( $this->uploads ) {
+			if ( $this->skippedNamespace( $revision ) ) {
+				return;
+			}
+			$this->uploadCount++;
+			// $this->report();
+			$this->progress( "upload: " . $revision->getFilename() );
+
+			if ( !$this->dryRun ) {
+				// bluuuh hack
+				// call_user_func( $this->uploadCallback, $revision );
+				$dbw = wfGetDB( DB_MASTER );
+				return $dbw->deadlockLoop( array( $revision, 'importUpload' ) );
+			}
+		}
+	}
+
+	function handleLogItem( $rev ) {
+		if ( $this->skippedNamespace( $rev ) ) {
+			return;
+		}
+		$this->revCount++;
+		$this->report();
+
+		if ( !$this->dryRun ) {
+			call_user_func( $this->logItemCallback, $rev );
+		}
+	}
+
 	function report( $final = false ) {
-		if( $final xor ( $this->pageCount % $this->reportingInterval == 0 ) ) {
+		if ( $final xor ( $this->pageCount % $this->reportingInterval == 0 ) ) {
 			$this->showReport();
 		}
 	}
 
 	function showReport() {
-		if( $this->reporting ) {
+		if ( !$this->mQuiet ) {
 			$delta = wfTime() - $this->startTime;
-			if( $delta ) {
-				$rate = $this->pageCount / $delta;
-				$revrate = $this->revCount / $delta;
+			if ( $delta ) {
+				$rate = sprintf( "%.2f", $this->pageCount / $delta );
+				$revrate = sprintf( "%.2f", $this->revCount / $delta );
 			} else {
 				$rate = '-';
 				$revrate = '-';
 			}
-			$this->progress( "$this->pageCount ($rate pages/sec $revrate revs/sec)" );
+			# Logs dumps don't have page tallies
+			if ( $this->pageCount ) {
+				$this->progress( "$this->pageCount ($rate pages/sec $revrate revs/sec)" );
+			} else {
+				$this->progress( "$this->revCount ($revrate revs/sec)" );
+			}
 		}
+		wfWaitForSlaves();
+		// XXX: Don't let deferred jobs array get absurdly large (bug 24375)
+		DeferredUpdates::doUpdates( 'commit' );
 	}
 
 	function progress( $string ) {
@@ -84,16 +233,24 @@ class BackupReader {
 	}
 
 	function importFromFile( $filename ) {
-		if( preg_match( '/\.gz$/', $filename ) ) {
+		if ( preg_match( '/\.gz$/', $filename ) ) {
 			$filename = 'compress.zlib://' . $filename;
+		} elseif ( preg_match( '/\.bz2$/', $filename ) ) {
+			$filename = 'compress.bzip2://' . $filename;
+		} elseif ( preg_match( '/\.7z$/', $filename ) ) {
+			$filename = 'mediawiki.compress.7z://' . $filename;
 		}
+
 		$file = fopen( $filename, 'rt' );
-		$this->importFromHandle( $file );
+		return $this->importFromHandle( $file );
 	}
 
 	function importFromStdin() {
 		$file = fopen( 'php://stdin', 'rt' );
-		$this->importFromHandle( $file );
+		if( self::posix_isatty( $file ) ) {
+			$this->maybeHelp( true );
+		}
+		return $this->importFromHandle( $file );
 	}
 
 	function importFromHandle( $handle ) {
@@ -102,29 +259,33 @@ class BackupReader {
 		$source = new ImportStreamSource( $handle );
 		$importer = new WikiImporter( $source );
 
+		if( $this->hasOption( 'debug' ) ) {
+			$importer->setDebug( true );
+		}
+		if ( $this->hasOption( 'no-updates' ) ) {
+			$importer->setNoUpdates( true );
+		}
 		$importer->setPageCallback( array( &$this, 'reportPage' ) );
 		$this->importCallback =  $importer->setRevisionCallback(
 			array( &$this, 'handleRevision' ) );
+		$this->uploadCallback = $importer->setUploadCallback(
+			array( &$this, 'handleUpload' ) );
+		$this->logItemCallback = $importer->setLogItemCallback(
+			array( &$this, 'handleLogItem' ) );
+		if ( $this->uploads ) {
+			$importer->setImportUploads( true );
+		}
+		if ( $this->imageBasePath ) {
+			$importer->setImageBasePath( $this->imageBasePath );
+		}
 
-		$importer->doImport();
-	}
-}
-
-$reader = new BackupReader();
-if( isset( $options['quiet'] ) ) {
-	$reader->reporting = false;
-}
-if( isset( $options['report'] ) ) {
-	$reader->reportingInterval = intval( $options['report'] );
-}
-if( isset( $options['dry-run'] ) ) {
-	$reader->dryRun = true;
-}
+		if ( $this->dryRun ) {
+			$importer->setPageOutCallback( null );
+		}
 
-if( isset( $args[0] ) ) {
-	$reader->importFromFile( $args[0] );
-} else {
-	$reader->importFromStdin();
+		return $importer->doImport();
+	}
 }
 
-?>
+$maintClass = 'BackupReader';
+require_once( RUN_MAINTENANCE_IF_MAIN );