DBFileJournal.php

Go to the documentation of this file.

<?php
class DBFileJournal extends FileJournal {
        protected $dbw;

        protected $wiki = false; // string; wiki DB name

        protected function __construct( array $config ) {
                parent::__construct( $config );

                $this->wiki = $config['wiki'];
        }

        protected function doLogChangeBatch( array $entries, $batchId ) {
                $status = Status::newGood();

                try {
                        $dbw = $this->getMasterDB();
                } catch ( DBError $e ) {
                        $status->fatal( 'filejournal-fail-dbconnect', $this->backend );
                        return $status;
                }

                $now = wfTimestamp( TS_UNIX );

                $data = array();
                foreach ( $entries as $entry ) {
                        $data[] = array(
                                '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__ );
                        if ( mt_rand( 0, 99 ) == 0 ) {
                                $this->purgeOldLogs(); // occasionally delete old logs
                        }
                } 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)',
                        array( 'fj_backend' => $this->backend ),
                        __METHOD__
                );
        }

        protected function doGetPositionAtTime( $time ) {
                $dbw = $this->getMasterDB();

                $encTimestamp = $dbw->addQuotes( $dbw->timestamp( $time ) );
                return $dbw->selectField( 'filejournal', 'fj_id',
                        array( 'fj_backend' => $this->backend, "fj_timestamp <= $encTimestamp" ),
                        __METHOD__,
                        array( 'ORDER BY' => 'fj_timestamp DESC' )
                );
        }

        protected function doGetChangeEntries( $start, $limit ) {
                $dbw = $this->getMasterDB();

                $res = $dbw->select( 'filejournal', '*',
                        array(
                                'fj_backend' => $this->backend,
                                'fj_id >= ' . $dbw->addQuotes( (int)$start ) ), // $start may be 0
                        __METHOD__,
                        array_merge( array( 'ORDER BY' => 'fj_id ASC' ),
                                $limit ? array( 'LIMIT' => $limit ) : array() )
                );

                $entries = array();
                foreach ( $res as $row ) {
                        $item = array();
                        foreach ( (array)$row as $key => $value ) {
                                $item[substr( $key, 3 )] = $value; // "fj_op" => "op"
                        }
                        $entries[] = $item;
                }

                return $entries;
        }

        protected function doPurgeOldLogs() {
                $status = Status::newGood();
                if ( $this->ttlDays <= 0 ) {
                        return $status; // nothing to do
                }

                $dbw = $this->getMasterDB();
                $dbCutoff = $dbw->timestamp( time() - 86400 * $this->ttlDays );

                $dbw->delete( 'filejournal',
                        array( 'fj_timestamp < ' . $dbw->addQuotes( $dbCutoff ) ),
                        __METHOD__
                );

                return $status;
        }

        protected function getMasterDB() {
                if ( !$this->dbw ) {
                        // Get a separate connection in autocommit mode
                        $lb = wfGetLBFactory()->newMainLB();
                        $this->dbw = $lb->getConnection( DB_MASTER, array(), $this->wiki );
                        $this->dbw->clearFlag( DBO_TRX );
                }
                return $this->dbw;
        }
}