BackupDumper.php

Go to the documentation of this file.

<?php
require_once __DIR__ . '/../Maintenance.php';
require_once __DIR__ . '/../../includes/export/WikiExporter.php';
 
use MediaWiki\MainConfigNames;
use MediaWiki\MediaWikiServices;
use MediaWiki\Settings\SettingsBuilder;
use Wikimedia\Rdbms\IMaintainableDatabase;
use Wikimedia\Rdbms\LoadBalancer;
 
abstract class BackupDumper extends Maintenance {
    public $reporting = true;
    public $pages = null;
    public $skipHeader = false;
    public $skipFooter = false;
    public $startId = 0;
    public $endId = 0;
    public $revStartId = 0;
    public $revEndId = 0;
    public $dumpUploads = false;
    public $dumpUploadFileContents = false;
    public $orderRevs = false;
    public $limitNamespaces = [];
    public $stderr;
 
    protected $reportingInterval = 100;
    protected $pageCount = 0;
    protected $revCount = 0;
    protected $schemaVersion = null;
    protected $server = null;
    protected $sink = null;
    protected $lastTime = 0;
    protected $pageCountLast = 0;
    protected $revCountLast = 0;
 
    protected $outputTypes = [];
    protected $filterTypes = [];
 
    protected $ID = 0;
 
    protected $startTime;
    protected $pageCountPart;
    protected $revCountPart;
    protected $maxCount;
    protected $timeOfCheckpoint;
    protected $egress;
    protected $buffer;
    protected $openElement;
    protected $atStart;
    protected $thisRevModel;
    protected $thisRevFormat;
    protected $lastName;
    protected $state;
 
    protected $forcedDb = null;
 
    protected $lb;
 
    public function __construct( $args = null ) {
        parent::__construct();
        $this->stderr = fopen( "php://stderr", "wt" );
 
        // Built-in output and filter plugins
        $this->registerOutput( 'file', DumpFileOutput::class );
        $this->registerOutput( 'gzip', DumpGZipOutput::class );
        $this->registerOutput( 'bzip2', DumpBZip2Output::class );
        $this->registerOutput( 'dbzip2', DumpDBZip2Output::class );
        $this->registerOutput( 'lbzip2', DumpLBZip2Output::class );
        $this->registerOutput( '7zip', Dump7ZipOutput::class );
 
        $this->registerFilter( 'latest', DumpLatestFilter::class );
        $this->registerFilter( 'notalk', DumpNotalkFilter::class );
        $this->registerFilter( 'namespace', DumpNamespaceFilter::class );
 
        // These three can be specified multiple times
        $this->addOption( 'plugin', 'Load a dump plugin class. Specify as <class>[:<file>].',
            false, true, false, true );
        $this->addOption( 'output', 'Begin a filtered output stream; Specify as <type>:<file>. ' .
            '<type>s: file, gzip, bzip2, 7zip, dbzip2, lbzip2', false, true, 'o', true );
        $this->addOption( 'filter', 'Add a filter on an output branch. Specify as ' .
            '<type>[:<options>]. <types>s: latest, notalk, namespace', false, true, false, true );
        $this->addOption( 'report', 'Report position and speed after every n pages processed. ' .
            'Default: 100.', false, true );
        $this->addOption( 'server', 'Force reading from MySQL server', false, true );
        $this->addOption( '7ziplevel', '7zip compression level for all 7zip outputs. Used for ' .
            '-mx option to 7za command.', false, true );
        // NOTE: we can't know the default schema version yet, since configuration has not been
        //       loaded when this constructor is called. To work around this, we re-declare
        //       this option in validateParamsAndArgs().
        $this->addOption( 'schema-version', 'Schema version to use for output.', false, true );
 
        if ( $args ) {
            // Args should be loaded and processed so that dump() can be called directly
            // instead of execute()
            $this->loadWithArgv( $args );
            $this->processOptions();
        }
    }
 
    public function finalSetup( SettingsBuilder $settingsBuilder = null ) {
        parent::finalSetup( $settingsBuilder );
        // re-declare the --schema-version option to include the default schema version
        // in the description.
        $schemaVersion = $settingsBuilder->getConfig()->get( MainConfigNames::XmlDumpSchemaVersion );
        $this->addOption( 'schema-version', 'Schema version to use for output. ' .
            'Default: ' . $schemaVersion, false, true );
    }
 
    public function registerOutput( $name, $class ) {
        $this->outputTypes[$name] = $class;
    }
 
    public function registerFilter( $name, $class ) {
        $this->filterTypes[$name] = $class;
    }
 
    public function loadPlugin( $class, $file ) {
        if ( $file != '' ) {
            require_once $file;
        }
        $register = [ $class, 'register' ];
        $register( $this );
    }
 
    public function execute() {
        throw new MWException( 'execute() must be overridden in subclasses' );
    }
 
    protected function processOptions() {
        $sink = null;
        $sinks = [];
 
        $this->schemaVersion = WikiExporter::schemaVersion();
 
        $options = $this->orderedOptions;
        foreach ( $options as [ $opt, $param ] ) {
            switch ( $opt ) {
                case 'plugin':
                    $val = explode( ':', $param, 2 );
 
                    if ( count( $val ) === 1 ) {
                        $this->loadPlugin( $val[0], '' );
                    } elseif ( count( $val ) === 2 ) {
                        $this->loadPlugin( $val[0], $val[1] );
                    }
 
                    break;
                case 'output':
                    $split = explode( ':', $param, 2 );
                    if ( count( $split ) !== 2 ) {
                        $this->fatalError( 'Invalid output parameter' );
                    }
                    list( $type, $file ) = $split;
                    if ( $sink !== null ) {
                        $sinks[] = $sink;
                    }
                    if ( !isset( $this->outputTypes[$type] ) ) {
                        $this->fatalError( "Unrecognized output sink type '$type'" );
                    }
                    $class = $this->outputTypes[$type];
                    if ( $type === "7zip" ) {
                        $sink = new $class( $file, intval( $this->getOption( '7ziplevel' ) ) );
                    } else {
                        $sink = new $class( $file );
                    }
 
                    break;
                case 'filter':
                    if ( $sink === null ) {
                        $sink = new DumpOutput();
                    }
 
                    $split = explode( ':', $param, 2 );
                    $key = $split[0];
 
                    if ( !isset( $this->filterTypes[$key] ) ) {
                        $this->fatalError( "Unrecognized filter type '$key'" );
                    }
 
                    $type = $this->filterTypes[$key];
 
                    if ( count( $split ) === 2 ) {
                        $filter = new $type( $sink, $split[1] );
                    } else {
                        $filter = new $type( $sink );
                    }
 
                    // references are lame in php...
                    unset( $sink );
                    $sink = $filter;
 
                    break;
                case 'schema-version':
                    if ( !in_array( $param, XmlDumpWriter::$supportedSchemas ) ) {
                        $this->fatalError(
                            "Unsupported schema version $param. Supported versions: " .
                            implode( ', ', XmlDumpWriter::$supportedSchemas )
                        );
                    }
                    $this->schemaVersion = $param;
                    break;
            }
        }
 
        if ( $this->hasOption( 'report' ) ) {
            $this->reportingInterval = intval( $this->getOption( 'report' ) );
        }
 
        if ( $this->hasOption( 'server' ) ) {
            $this->server = $this->getOption( 'server' );
        }
 
        if ( $sink === null ) {
            $sink = new DumpOutput();
        }
        $sinks[] = $sink;
 
        if ( count( $sinks ) > 1 ) {
            $this->sink = new DumpMultiWriter( $sinks );
        } else {
            $this->sink = $sink;
        }
    }
 
    public function dump( $history, $text = WikiExporter::TEXT ) {
        # Notice messages will foul up your XML output even if they're
        # relatively harmless.
        if ( ini_get( 'display_errors' ) ) {
            ini_set( 'display_errors', 'stderr' );
        }
 
        $this->initProgress( $history );
 
        $db = $this->backupDb();
        $services = MediaWikiServices::getInstance();
        $exporter = $services->getWikiExporterFactory()->getWikiExporter(
            $db,
            $history,
            $text,
            $this->limitNamespaces
        );
        $exporter->setSchemaVersion( $this->schemaVersion );
        $exporter->dumpUploads = $this->dumpUploads;
        $exporter->dumpUploadFileContents = $this->dumpUploadFileContents;
 
        $wrapper = new ExportProgressFilter( $this->sink, $this );
        $exporter->setOutputSink( $wrapper );
 
        if ( !$this->skipHeader ) {
            $exporter->openStream();
        }
        # 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();
            }
        } elseif ( $this->pages === null ) {
            # Page dumps: all or by page ID range
            if ( $this->startId || $this->endId ) {
                $exporter->pagesByRange( $this->startId, $this->endId, $this->orderRevs );
            } elseif ( $this->revStartId || $this->revEndId ) {
                $exporter->revsByRange( $this->revStartId, $this->revEndId );
            } else {
                $exporter->allPages();
            }
        } else {
            # Dump of specific pages
            $exporter->pagesByName( $this->pages );
        }
 
        if ( !$this->skipFooter ) {
            $exporter->closeStream();
        }
 
        $this->report( true );
    }
 
    public function initProgress( $history = WikiExporter::FULL ) {
        $table = ( $history == WikiExporter::CURRENT ) ? 'page' : 'revision';
        $field = ( $history == WikiExporter::CURRENT ) ? 'page_id' : 'rev_id';
 
        $dbr = $this->forcedDb;
        if ( $this->forcedDb === null ) {
            $dbr = $this->getDB( DB_REPLICA, [ 'dump' ] );
        }
        $this->maxCount = $dbr->selectField( $table, "MAX($field)", '', __METHOD__ );
        $this->startTime = microtime( true );
        $this->lastTime = $this->startTime;
        $this->ID = getmypid();
    }
 
    protected function backupDb() {
        if ( $this->forcedDb !== null ) {
            return $this->forcedDb;
        }
 
        $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
        $this->lb = $lbFactory->newMainLB();
        $db = $this->lb->getMaintenanceConnectionRef( DB_REPLICA, 'dump' );
 
        // Discourage the server from disconnecting us if it takes a long time
        // to read out the big ol' batch query.
        $db->setSessionOptions( [ 'connTimeout' => 3600 * 24 ] );
 
        return $db;
    }
 
    public function setDB( IMaintainableDatabase $db ) {
        parent::setDB( $db );
        $this->forcedDb = $db;
    }
 
    public function __destruct() {
        if ( isset( $this->lb ) ) {
            $this->lb->closeAll( __METHOD__ );
        }
    }
 
    protected function backupServer() {
        global $wgDBserver;
 
        return $this->server ?: $wgDBserver;
    }
 
    public function reportPage() {
        $this->pageCount++;
    }
 
    public function revCount() {
        $this->revCount++;
        $this->report();
    }
 
    public function report( $final = false ) {
        if ( $final xor ( $this->revCount % $this->reportingInterval == 0 ) ) {
            $this->showReport();
        }
    }
 
    public function showReport() {
        if ( $this->reporting ) {
            $now = wfTimestamp( TS_DB );
            $nowts = microtime( true );
            $deltaAll = $nowts - $this->startTime;
            $deltaPart = $nowts - $this->lastTime;
            $this->pageCountPart = $this->pageCount - $this->pageCountLast;
            $this->revCountPart = $this->revCount - $this->revCountLast;
 
            if ( $deltaAll ) {
                $portion = $this->revCount / $this->maxCount;
                $eta = $this->startTime + $deltaAll / $portion;
                $etats = wfTimestamp( TS_DB, intval( $eta ) );
                $pageRate = $this->pageCount / $deltaAll;
                $revRate = $this->revCount / $deltaAll;
            } else {
                $pageRate = '-';
                $revRate = '-';
                $etats = '-';
            }
            if ( $deltaPart ) {
                $pageRatePart = $this->pageCountPart / $deltaPart;
                $revRatePart = $this->revCountPart / $deltaPart;
            } else {
                $pageRatePart = '-';
                $revRatePart = '-';
            }
 
            $dbDomain = WikiMap::getCurrentWikiDbDomain()->getId();
            $this->progress( sprintf(
                "%s: %s (ID %d) %d pages (%0.1f|%0.1f/sec all|curr), "
                    . "%d revs (%0.1f|%0.1f/sec all|curr), ETA %s [max %d]",
                $now, $dbDomain, $this->ID, $this->pageCount, $pageRate,
                $pageRatePart, $this->revCount, $revRate, $revRatePart, $etats,
                $this->maxCount
            ) );
            $this->lastTime = $nowts;
            $this->revCountLast = $this->revCount;
        }
    }
 
    protected function progress( $string ) {
        if ( $this->reporting ) {
            fwrite( $this->stderr, $string . "\n" );
        }
    }
}