DBFileJournal.php

Go to the documentation of this file.

<?php
use MediaWiki\MediaWikiServices;
use Wikimedia\Rdbms\DBError;
use Wikimedia\Rdbms\IDatabase;
use Wikimedia\Timestamp\ConvertibleTimestamp;
 
class DBFileJournal extends FileJournal {
    protected $dbw;
    protected $domain;
 
    public function __construct( array $config ) {
        parent::__construct( $config );
 
        $this->domain = $config['domain'] ?? $config['wiki']; // b/c
    }
 
    protected function doLogChangeBatch( array $entries, $batchId ) {
        $status = StatusValue::newGood();
 
        try {
            $dbw = $this->getMasterDB();
        } catch ( DBError $e ) {
            $status->fatal( 'filejournal-fail-dbconnect', $this->backend );
 
            return $status;
        }
 
        $now = ConvertibleTimestamp::time();
 
        $data = [];
        foreach ( $entries as $entry ) {
            $data[] = [
                'fj_batch_uuid' => $batchId,
                'fj_backend' => $this->backend,
                'fj_op' => $entry['op'],
                'fj_path' => $entry['path'],
                'fj_new_sha1' => $entry['newSha1'],
                'fj_timestamp' => $dbw->timestamp( $now )
            ];
        }
 
        try {
            $dbw->insert( 'filejournal', $data, __METHOD__ );
            // XXX Should we do this deterministically so it's testable? Maybe look at the last two
            // digits of a hash of a bunch of the data?
            if ( mt_rand( 0, 99 ) == 0 ) {
                // occasionally delete old logs
                $this->purgeOldLogs(); // @codeCoverageIgnore
            }
        } catch ( DBError $e ) {
            $status->fatal( 'filejournal-fail-dbquery', $this->backend );
 
            return $status;
        }
 
        return $status;
    }
 
    protected function doGetCurrentPosition() {
        $dbw = $this->getMasterDB();
 
        return $dbw->selectField( 'filejournal', 'MAX(fj_id)',
            [ 'fj_backend' => $this->backend ],
            __METHOD__
        );
    }
 
    protected function doGetPositionAtTime( $time ) {
        $dbw = $this->getMasterDB();
 
        $encTimestamp = $dbw->addQuotes( $dbw->timestamp( $time ) );
 
        return $dbw->selectField( 'filejournal', 'fj_id',
            [ 'fj_backend' => $this->backend, "fj_timestamp <= $encTimestamp" ],
            __METHOD__,
            [ 'ORDER BY' => 'fj_timestamp DESC' ]
        );
    }
 
    protected function doGetChangeEntries( $start, $limit ) {
        $dbw = $this->getMasterDB();
 
        $res = $dbw->select( 'filejournal', '*',
            [
                'fj_backend' => $this->backend,
                'fj_id >= ' . $dbw->addQuotes( (int)$start ) ], // $start may be 0
            __METHOD__,
            array_merge( [ 'ORDER BY' => 'fj_id ASC' ],
                $limit ? [ 'LIMIT' => $limit ] : [] )
        );
 
        $entries = [];
        foreach ( $res as $row ) {
            $item = [];
            foreach ( (array)$row as $key => $value ) {
                $item[substr( $key, 3 )] = $value; // "fj_op" => "op"
            }
            $entries[] = $item;
        }
 
        return $entries;
    }
 
    protected function doPurgeOldLogs() {
        $status = StatusValue::newGood();
        if ( $this->ttlDays <= 0 ) {
            return $status; // nothing to do
        }
 
        $dbw = $this->getMasterDB();
        $dbCutoff = $dbw->timestamp( ConvertibleTimestamp::time() - 86400 * $this->ttlDays );
 
        $dbw->delete( 'filejournal',
            [ 'fj_timestamp < ' . $dbw->addQuotes( $dbCutoff ) ],
            __METHOD__
        );
 
        return $status;
    }
 
    protected function getMasterDB() {
        if ( !$this->dbw ) {
            // Get a separate connection in autocommit mode
            $lb = MediaWikiServices::getInstance()->getDBLoadBalancerFactory()->newMainLB();
            $this->dbw = $lb->getConnection( DB_MASTER, [], $this->domain );
            $this->dbw->clearFlag( DBO_TRX );
        }
 
        return $this->dbw;
    }
}