FileJournal.php

Go to the documentation of this file.

<?php
use Wikimedia\ObjectFactory;
use Wikimedia\Timestamp\ConvertibleTimestamp;
 
abstract class FileJournal {
    protected $backend;
    protected $ttlDays;
 
    public function __construct( array $config ) {
        $this->backend = $config['backend'];
        $this->ttlDays = $config['ttlDays'] ?? false;
    }
 
    final public static function factory( array $config, $backend ) {
        wfDeprecated( __METHOD__, '1.35' );
 
        $jrn = ObjectFactory::getObjectFromSpec(
            [ 'backend' => $backend ] + $config,
            [ 'specIsArg' => true, 'assertClass' => __CLASS__ ]
        );
 
        return $jrn;
    }
 
    final public function getTimestampedUUID() {
        $s = '';
        for ( $i = 0; $i < 5; $i++ ) {
            $s .= mt_rand( 0, 2147483647 );
        }
        $s = Wikimedia\base_convert( sha1( $s ), 16, 36, 31 );
 
        $timestamp = ConvertibleTimestamp::convert( TS_MW, time() );
 
        return substr( Wikimedia\base_convert( $timestamp, 10, 36, 9 ) . $s, 0, 31 );
    }
 
    final public function logChangeBatch( array $entries, $batchId ) {
        if ( $entries === [] ) {
            return StatusValue::newGood();
        }
 
        return $this->doLogChangeBatch( $entries, $batchId );
    }
 
    abstract protected function doLogChangeBatch( array $entries, $batchId );
 
    final public function getCurrentPosition() {
        return $this->doGetCurrentPosition();
    }
 
    abstract protected function doGetCurrentPosition();
 
    final public function getPositionAtTime( $time ) {
        return $this->doGetPositionAtTime( $time );
    }
 
    abstract protected function doGetPositionAtTime( $time );
 
    final public function getChangeEntries( $start = null, $limit = 0, &$next = null ) {
        $entries = $this->doGetChangeEntries( $start, $limit ? $limit + 1 : 0 );
        if ( $limit && count( $entries ) > $limit ) {
            $last = array_pop( $entries ); // remove the extra entry
            // @phan-suppress-next-line PhanTypeArraySuspiciousNullable $entries are never empty here
            $next = $last['id']; // update for next call
        } else {
            $next = null; // end of list
        }
 
        return $entries;
    }
 
    abstract protected function doGetChangeEntries( $start, $limit );
 
    final public function purgeOldLogs() {
        return $this->doPurgeOldLogs();
    }
 
    abstract protected function doPurgeOldLogs();
}