compressOld.php

Go to the documentation of this file.

<?php
use MediaWiki\Maintenance\Maintenance;
use MediaWiki\Revision\SlotRecord;
use MediaWiki\Title\Title;
use Wikimedia\Rdbms\IExpression;
use Wikimedia\Rdbms\LikeValue;
 
// @codeCoverageIgnoreStart
require_once __DIR__ . '/../Maintenance.php';
// @codeCoverageIgnoreEnd
 
class CompressOld extends Maintenance {
    public function __construct() {
        parent::__construct();
        $this->addDescription( 'Compress the text of a wiki' );
        $this->addOption( 'type', 'Set compression type to either: gzip|concat', false, true, 't' );
        $this->addOption(
            'chunksize',
            'Maximum number of revisions in a concat chunk',
            false,
            true,
            'c'
        );
        $this->addOption(
            'begin-date',
            'Earliest date to check for uncompressed revisions',
            false,
            true,
            'b'
        );
        $this->addOption( 'end-date', 'Latest revision date to compress', false, true, 'e' );
        $this->addOption(
            'startid',
            'The id to start from (gzip -> text table, concat -> page table)',
            false,
            true,
            's'
        );
        $this->addOption(
            'extdb',
            'Store specified revisions in an external cluster (untested)',
            false,
            true
        );
        $this->addOption(
            'endid',
            'The page_id to stop at (only when using concat compression type)',
            false,
            true,
            'n'
        );
    }
 
    public function execute() {
        global $wgDBname;
        if ( !function_exists( "gzdeflate" ) ) {
            $this->fatalError( "You must enable zlib support in PHP to compress old revisions!\n" .
                "Please see https://www.php.net/manual/en/ref.zlib.php\n" );
        }
 
        $type = $this->getOption( 'type', 'concat' );
        $chunkSize = $this->getOption( 'chunksize', 20 );
        $startId = $this->getOption( 'startid', 0 );
        $beginDate = $this->getOption( 'begin-date', '' );
        $endDate = $this->getOption( 'end-date', '' );
        $extDB = $this->getOption( 'extdb', '' );
        $endId = $this->getOption( 'endid', false );
 
        if ( $type != 'concat' && $type != 'gzip' ) {
            $this->error( "Type \"{$type}\" not supported" );
        }
 
        if ( $extDB != '' ) {
            $this->output( "Compressing database {$wgDBname} to external cluster {$extDB}\n"
                . str_repeat( '-', 76 ) . "\n\n" );
        } else {
            $this->output( "Compressing database {$wgDBname}\n"
                . str_repeat( '-', 76 ) . "\n\n" );
        }
 
        $success = true;
        if ( $type == 'concat' ) {
            $success = $this->compressWithConcat( $startId, $chunkSize, $beginDate,
                $endDate, $extDB, $endId );
        } else {
            $this->compressOldPages( $startId, $extDB );
        }
 
        if ( $success ) {
            $this->output( "Done.\n" );
        }
    }
 
    private function compressOldPages( $start = 0, $extdb = '' ) {
        $chunksize = 50;
        $this->output( "Starting from old_id $start...\n" );
        $dbw = $this->getPrimaryDB();
        do {
            $res = $dbw->newSelectQueryBuilder()
                ->select( [ 'old_id', 'old_flags', 'old_text' ] )
                ->forUpdate()
                ->from( 'text' )
                ->where( "old_id>=$start" )
                ->orderBy( 'old_id' )
                ->limit( $chunksize )
                ->caller( __METHOD__ )->fetchResultSet();
 
            if ( $res->numRows() == 0 ) {
                break;
            }
 
            $last = $start;
 
            foreach ( $res as $row ) {
                # print "  {$row->old_id} - {$row->old_namespace}:{$row->old_title}\n";
                $this->compressPage( $row, $extdb );
                $last = $row->old_id;
            }
 
            $start = $last + 1; # Deletion may leave long empty stretches
            $this->output( "$start...\n" );
        } while ( true );
    }
 
    private function compressPage( $row, $extdb ) {
        if ( str_contains( $row->old_flags, 'gzip' )
            || str_contains( $row->old_flags, 'object' )
        ) {
            # print "Already compressed row {$row->old_id}\n";
            return false;
        }
        $dbw = $this->getPrimaryDB();
        $flags = $row->old_flags ? "{$row->old_flags},gzip" : "gzip";
        $compress = gzdeflate( $row->old_text );
 
        # Store in external storage if required
        if ( $extdb !== '' ) {
            $esFactory = $this->getServiceContainer()->getExternalStoreFactory();
            $storeObj = $esFactory->getDatabaseStore();
            $compress = $storeObj->store( $extdb, $compress );
            if ( $compress === false ) {
                $this->error( "Unable to store object" );
 
                return false;
            }
        }
 
        # Update text row
        $dbw->newUpdateQueryBuilder()
            ->update( 'text' )
            ->set( [
                'old_flags' => $flags,
                'old_text' => $compress
            ] )
            ->where( [
                'old_id' => $row->old_id
            ] )
            ->caller( __METHOD__ )
            ->execute();
 
        return true;
    }
 
    private function compressWithConcat( $startId, $maxChunkSize, $beginDate,
        $endDate, $extdb = "", $maxPageId = false
    ) {
        $dbr = $this->getReplicaDB();
        $dbw = $this->getPrimaryDB();
 
        # Set up external storage
        if ( $extdb != '' ) {
            $esFactory = $this->getServiceContainer()->getExternalStoreFactory();
            $storeObj = $esFactory->getDatabaseStore();
        }
 
        $blobStore = $this->getServiceContainer()
            ->getBlobStoreFactory()
            ->newSqlBlobStore();
 
        # Get all articles by page_id
        if ( !$maxPageId ) {
            $maxPageId = $dbr->newSelectQueryBuilder()
                ->select( 'max(page_id)' )
                ->from( 'page' )
                ->caller( __METHOD__ )->fetchField();
        }
        $this->output( "Starting from $startId of $maxPageId\n" );
        $pageConds = [];
 
        /*
        if ( $exclude_ns0 ) {
            print "Excluding main namespace\n";
            $pageConds[] = 'page_namespace<>0';
        }
        if ( $queryExtra ) {
            $pageConds[] = $queryExtra;
        }
         */
 
        # For each article, get a list of revisions which fit the criteria
 
        # No recompression, use a condition on old_flags
        # Don't compress object type entities, because that might produce data loss when
        # overwriting bulk storage concat rows. Don't compress external references, because
        # the script doesn't yet delete rows from external storage.
        $slotRoleStore = $this->getServiceContainer()->getSlotRoleStore();
        $queryBuilderTemplate = $dbw->newSelectQueryBuilder()
            ->select( [ 'rev_id', 'old_id', 'old_flags', 'old_text' ] )
            ->forUpdate()
            ->from( 'revision' )
            ->join( 'slots', null, 'rev_id=slot_revision_id' )
            ->join( 'content', null, 'content_id=slot_content_id' )
            ->join( 'text', null, 'SUBSTRING(content_address, 4)=old_id' )
            ->where(
                $dbr->expr(
                    'old_flags',
                    IExpression::NOT_LIKE,
                    new LikeValue( $dbr->anyString(), 'object', $dbr->anyString() )
                )->and(
                    'old_flags',
                    IExpression::NOT_LIKE,
                    new LikeValue( $dbr->anyString(), 'external', $dbr->anyString() )
                )
            )
            ->andWhere( [
                'slot_role_id' => $slotRoleStore->getId( SlotRecord::MAIN ),
                'SUBSTRING(content_address, 1, 3)=' . $dbr->addQuotes( 'tt:' ),
            ] );
 
        if ( $beginDate ) {
            if ( !preg_match( '/^\d{14}$/', $beginDate ) ) {
                $this->error( "Invalid begin date \"$beginDate\"\n" );
 
                return false;
            }
            $queryBuilderTemplate->andWhere( $dbr->expr( 'rev_timestamp', '>', $beginDate ) );
        }
        if ( $endDate ) {
            if ( !preg_match( '/^\d{14}$/', $endDate ) ) {
                $this->error( "Invalid end date \"$endDate\"\n" );
 
                return false;
            }
            $queryBuilderTemplate->andWhere( $dbr->expr( 'rev_timestamp', '<', $endDate ) );
        }
 
        for ( $pageId = $startId; $pageId <= $maxPageId; $pageId++ ) {
            $this->waitForReplication();
 
            # Wake up
            $dbr->ping();
 
            # Get the page row
            $pageRow = $dbr->newSelectQueryBuilder()
                ->select( [ 'page_id', 'page_namespace', 'page_title', 'rev_timestamp' ] )
                ->from( 'page' )
                ->straightJoin( 'revision', null, 'page_latest = rev_id' )
                ->where( $pageConds )
                ->andWhere( [ 'page_id' => $pageId ] )
                ->caller( __METHOD__ )->fetchRow();
            if ( $pageRow === false ) {
                continue;
            }
 
            # Display progress
            $titleObj = Title::makeTitle( $pageRow->page_namespace, $pageRow->page_title );
            $this->output( "$pageId\t" . $titleObj->getPrefixedDBkey() . " " );
 
            # Load revisions
            $queryBuilder = clone $queryBuilderTemplate;
            $revRes = $queryBuilder->where(
                [
                    'rev_page' => $pageRow->page_id,
                    // Don't operate on the current revision
                    // Use < instead of <> in case the current revision has changed
                    // since the page select, which wasn't locking
                    $dbr->expr( 'rev_timestamp', '<', (int)$pageRow->rev_timestamp ),
                ] )
                ->caller( __METHOD__ )->fetchResultSet();
 
            $revs = [];
            foreach ( $revRes as $revRow ) {
                $revs[] = $revRow;
            }
 
            if ( count( $revs ) < 2 ) {
                # No revisions matching, no further processing
                $this->output( "\n" );
                continue;
            }
 
            # For each chunk
            $i = 0;
            while ( $i < count( $revs ) ) {
                if ( $i < count( $revs ) - $maxChunkSize ) {
                    $thisChunkSize = $maxChunkSize;
                } else {
                    $thisChunkSize = count( $revs ) - $i;
                }
 
                $chunk = new ConcatenatedGzipHistoryBlob();
                $stubs = [];
                $this->beginTransactionRound( __METHOD__ );
                $usedChunk = false;
                $primaryOldid = $revs[$i]->old_id;
 
                # Get the text of each revision and add it to the object
                for ( $j = 0; $j < $thisChunkSize && $chunk->isHappy(); $j++ ) {
                    $oldid = $revs[$i + $j]->old_id;
 
                    # Get text. We do not need the full `extractBlob` since the query is built
                    # to fetch non-externalstore blobs.
                    $text = $blobStore->decompressData(
                        $revs[$i + $j]->old_text,
                        explode( ',', $revs[$i + $j]->old_flags )
                    );
 
                    if ( $text === false ) {
                        $this->error( "\nError, unable to get text in old_id $oldid" );
                        # $dbw->delete( 'old', [ 'old_id' => $oldid ] );
                    }
 
                    if ( $extdb == "" && $j == 0 ) {
                        $chunk->setText( $text );
                        $this->output( '.' );
                    } else {
                        # Don't make a stub if it's going to be longer than the article
                        # Stubs are typically about 100 bytes
                        if ( strlen( $text ) < 120 ) {
                            $stub = false;
                            $this->output( 'x' );
                        } else {
                            $stub = new HistoryBlobStub( $chunk->addItem( $text ) );
                            $stub->setLocation( $primaryOldid );
                            $stub->setReferrer( $oldid );
                            $this->output( '.' );
                            $usedChunk = true;
                        }
                        $stubs[$j] = $stub;
                    }
                }
                $thisChunkSize = $j;
 
                # If we couldn't actually use any stubs because the pages were too small, do nothing
                if ( $usedChunk ) {
                    if ( $extdb != "" ) {
                        # Move blob objects to External Storage
                        // @phan-suppress-next-line PhanPossiblyUndeclaredVariable storeObj is set when used
                        $stored = $storeObj->store( $extdb, serialize( $chunk ) );
                        if ( $stored === false ) {
                            $this->error( "Unable to store object" );
 
                            return false;
                        }
                        # Store External Storage URLs instead of Stub placeholders
                        foreach ( $stubs as $stub ) {
                            if ( $stub === false ) {
                                continue;
                            }
                            # $stored should provide base path to a BLOB
                            $url = $stored . "/" . $stub->getHash();
                            $dbw->newUpdateQueryBuilder()
                                ->update( 'text' )
                                ->set( [
                                    'old_text' => $url,
                                    'old_flags' => 'external,utf-8',
                                ] )
                                ->where( [
                                    'old_id' => $stub->getReferrer(),
                                ] )
                                ->caller( __METHOD__ )
                                ->execute();
                        }
                    } else {
                        # Store the main object locally
                        $dbw->newUpdateQueryBuilder()
                            ->update( 'text' )
                            ->set( [
                                'old_text' => serialize( $chunk ),
                                'old_flags' => 'object,utf-8',
                            ] )
                            ->where( [
                                'old_id' => $primaryOldid
                            ] )
                            ->caller( __METHOD__ )
                            ->execute();
 
                        # Store the stub objects
                        for ( $j = 1; $j < $thisChunkSize; $j++ ) {
                            # Skip if not compressing and don't overwrite the first revision
                            if ( $stubs[$j] !== false && $revs[$i + $j]->old_id != $primaryOldid ) {
                                $dbw->newUpdateQueryBuilder()
                                    ->update( 'text' )
                                    ->set( [
                                        'old_text' => serialize( $stubs[$j] ),
                                        'old_flags' => 'object,utf-8',
                                    ] )
                                    ->where( [
                                        'old_id' => $revs[$i + $j]->old_id
                                    ] )
                                    ->caller( __METHOD__ )
                                    ->execute();
                            }
                        }
                    }
                }
                # Done, next
                $this->output( "/" );
                $this->commitTransactionRound( __METHOD__ );
                $i += $thisChunkSize;
            }
            $this->output( "\n" );
        }
 
        return true;
    }
}
 
// @codeCoverageIgnoreStart
$maintClass = CompressOld::class;
require_once RUN_MAINTENANCE_IF_MAIN;
// @codeCoverageIgnoreEnd