FileJournal.php

Go to the documentation of this file.

<?php
abstract class FileJournal {
        protected $backend; // string
        protected $ttlDays; // integer

        protected function __construct( array $config ) {
                $this->ttlDays = isset( $config['ttlDays'] ) ? $config['ttlDays'] : false;
        }

        final public static function factory( array $config, $backend ) {
                $class = $config['class'];
                $jrn = new $class( $config );
                if ( !$jrn instanceof self ) {
                        throw new MWException( "Class given is not an instance of FileJournal." );
                }
                $jrn->backend = $backend;
                return $jrn;
        }

        final public function getTimestampedUUID() {
                $s = '';
                for ( $i = 0; $i < 5; $i++ ) {
                        $s .= mt_rand( 0, 2147483647 );
                }
                $s = wfBaseConvert( sha1( $s ), 16, 36, 31 );
                return substr( wfBaseConvert( wfTimestamp( TS_MW ), 10, 36, 9 ) . $s, 0, 31 );
        }

        final public function logChangeBatch( array $entries, $batchId ) {
                if ( !count( $entries ) ) {
                        return Status::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 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
                        $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();
}

class NullFileJournal extends FileJournal {
        protected function doLogChangeBatch( array $entries, $batchId ) {
                return Status::newGood();
        }

        protected function doGetCurrentPosition() {
                return false;
        }

        protected function doGetChangeEntries( $start, $limit ) {
                return array();
        }

        protected function doPurgeOldLogs() {
                return Status::newGood();
        }
}