2 files changed, 348 insertions, 0 deletions
diff --git a/includes/filebackend/filejournal/DBFileJournal.php b/includes/filebackend/filejournal/DBFileJournal.php
new file mode 100644
index 00000000..f6268c25
--- /dev/null
+++ b/includes/filebackend/filejournal/DBFileJournal.php
@@ -0,0 +1,152 @@
+<?php
+/**
+ * Version of FileJournal that logs to a DB table.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ * @ingroup FileJournal
+ * @author Aaron Schulz
+ */
+
+/**
+ * Version of FileJournal that logs to a DB table
+ * @since 1.20
+ */
+class DBFileJournal extends FileJournal {
+	/** @var DatabaseBase */
+	protected $dbw;
+
+	protected $wiki = false; // string; wiki DB name
+
+	/**
+	 * Construct a new instance from configuration.
+	 * $config includes:
+	 *     'wiki' : wiki name to use for LoadBalancer
+	 *
+	 * @param $config Array
+	 */
+	protected function __construct( array $config ) {
+		parent::__construct( $config );
+
+		$this->wiki = $config['wiki'];
+	}
+
+	/**
+	 * @see FileJournal::logChangeBatch()
+	 * @return Status
+	 */
+	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__ );
+		} catch ( DBError $e ) {
+			$status->fatal( 'filejournal-fail-dbquery', $this->backend );
+			return $status;
+		}
+
+		return $status;
+	}
+
+	/**
+	 * @see FileJournal::doGetChangeEntries()
+	 * @return Array
+	 * @throws DBError
+	 */
+	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;
+	}
+
+	/**
+	 * @see FileJournal::purgeOldLogs()
+	 * @return Status
+	 * @throws DBError
+	 */
+	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;
+	}
+
+	/**
+	 * Get a master connection to the logging DB
+	 *
+	 * @return DatabaseBase
+	 * @throws DBError
+	 */
+	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;
+	}
+}
diff --git a/includes/filebackend/filejournal/FileJournal.php b/includes/filebackend/filejournal/FileJournal.php
new file mode 100644
index 00000000..ce029bbe
--- /dev/null
+++ b/includes/filebackend/filejournal/FileJournal.php
@@ -0,0 +1,196 @@
+<?php
+/**
+ * @defgroup FileJournal File journal
+ * @ingroup FileBackend
+ */
+
+/**
+ * File operation journaling.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ * @ingroup FileJournal
+ * @author Aaron Schulz
+ */
+
+/**
+ * @brief Class for handling file operation journaling.
+ *
+ * Subclasses should avoid throwing exceptions at all costs.
+ *
+ * @ingroup FileJournal
+ * @since 1.20
+ */
+abstract class FileJournal {
+	protected $backend; // string
+	protected $ttlDays; // integer
+
+	/**
+	 * Construct a new instance from configuration.
+	 * $config includes:
+	 *     'ttlDays' : days to keep log entries around (false means "forever")
+	 *
+	 * @param $config Array
+	 */
+	protected function __construct( array $config ) {
+		$this->ttlDays = isset( $config['ttlDays'] ) ? $config['ttlDays'] : false;
+	}
+
+	/**
+	 * Create an appropriate FileJournal object from config
+	 *
+	 * @param $config Array
+	 * @param $backend string A registered file backend name
+	 * @throws MWException
+	 * @return FileJournal
+	 */
+	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;
+	}
+
+	/**
+	 * Get a statistically unique ID string
+	 *
+	 * @return string <9 char TS_MW timestamp in base 36><22 random base 36 chars>
+	 */
+	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 );
+	}
+
+	/**
+	 * Log changes made by a batch file operation.
+	 * $entries is an array of log entries, each of which contains:
+	 *     op      : Basic operation name (create, store, copy, delete)
+	 *     path    : The storage path of the file
+	 *     newSha1 : The final base 36 SHA-1 of the file
+	 * Note that 'false' should be used as the SHA-1 for non-existing files.
+	 *
+	 * @param $entries Array List of file operations (each an array of parameters)
+	 * @param $batchId string UUID string that identifies the operation batch
+	 * @return Status
+	 */
+	final public function logChangeBatch( array $entries, $batchId ) {
+		if ( !count( $entries ) ) {
+			return Status::newGood();
+		}
+		return $this->doLogChangeBatch( $entries, $batchId );
+	}
+
+	/**
+	 * @see FileJournal::logChangeBatch()
+	 *
+	 * @param $entries Array List of file operations (each an array of parameters)
+	 * @param $batchId string UUID string that identifies the operation batch
+	 * @return Status
+	 */
+	abstract protected function doLogChangeBatch( array $entries, $batchId );
+
+	/**
+	 * Get an array of file change log entries.
+	 * A starting change ID and/or limit can be specified.
+	 *
+	 * The result as a list of associative arrays, each having:
+	 *     id         : unique, monotonic, ID for this change
+	 *     batch_uuid : UUID for an operation batch
+	 *     backend    : the backend name
+	 *     op         : primitive operation (create,update,delete,null)
+	 *     path       : affected storage path
+	 *     new_sha1   : base 36 sha1 of the new file had the operation succeeded
+	 *     timestamp  : TS_MW timestamp of the batch change
+
+	 * Also, $next is updated to the ID of the next entry.
+	 *
+	 * @param $start integer Starting change ID or null
+	 * @param $limit integer Maximum number of items to return
+	 * @param &$next string
+	 * @return Array
+	 */
+	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;
+	}
+
+	/**
+	 * @see FileJournal::getChangeEntries()
+	 * @return Array
+	 */
+	abstract protected function doGetChangeEntries( $start, $limit );
+
+	/**
+	 * Purge any old log entries
+	 *
+	 * @return Status
+	 */
+	final public function purgeOldLogs() {
+		return $this->doPurgeOldLogs();
+	}
+
+	/**
+	 * @see FileJournal::purgeOldLogs()
+	 * @return Status
+	 */
+	abstract protected function doPurgeOldLogs();
+}
+
+/**
+ * Simple version of FileJournal that does nothing
+ * @since 1.20
+ */
+class NullFileJournal extends FileJournal {
+	/**
+	 * @see FileJournal::logChangeBatch()
+	 * @param $entries array
+	 * @param $batchId string
+	 * @return Status
+	 */
+	protected function doLogChangeBatch( array $entries, $batchId ) {
+		return Status::newGood();
+	}
+
+	/**
+	 * @see FileJournal::doGetChangeEntries()
+	 * @return Array
+	 */
+	protected function doGetChangeEntries( $start, $limit ) {
+		return array();
+	}
+
+	/**
+	 * @see FileJournal::purgeOldLogs()
+	 * @return Status
+	 */
+	protected function doPurgeOldLogs() {
+		return Status::newGood();
+	}
+}