1 files changed, 189 insertions, 0 deletions
diff --git a/includes/jobqueue/JobSpecification.php b/includes/jobqueue/JobSpecification.php
new file mode 100644
index 00000000..9fa7747f
--- /dev/null
+++ b/includes/jobqueue/JobSpecification.php
@@ -0,0 +1,189 @@
+<?php
+/**
+ * Job queue task description base code.
+ *
+ * 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 JobQueue
+ */
+
+/**
+ * Job queue task description interface
+ *
+ * @ingroup JobQueue
+ * @since 1.23
+ */
+interface IJobSpecification {
+	/**
+	 * @return string Job type
+	 */
+	public function getType();
+
+	/**
+	 * @return array
+	 */
+	public function getParams();
+
+	/**
+	 * @return int|null UNIX timestamp to delay running this job until, otherwise null
+	 */
+	public function getReleaseTimestamp();
+
+	/**
+	 * @return bool Whether only one of each identical set of jobs should be run
+	 */
+	public function ignoreDuplicates();
+
+	/**
+	 * Subclasses may need to override this to make duplication detection work.
+	 * The resulting map conveys everything that makes the job unique. This is
+	 * only checked if ignoreDuplicates() returns true, meaning that duplicate
+	 * jobs are supposed to be ignored.
+	 *
+	 * @return array Map of key/values
+	 */
+	public function getDeduplicationInfo();
+
+	/**
+	 * @return Title Descriptive title (this can simply be informative)
+	 */
+	public function getTitle();
+}
+
+/**
+ * Job queue task description base code
+ *
+ * Example usage:
+ * <code>
+ * $job = new JobSpecification(
+ *		'null',
+ *		array( 'lives' => 1, 'usleep' => 100, 'pi' => 3.141569 ),
+ *		array( 'removeDuplicates' => 1 ),
+ *		Title::makeTitle( NS_SPECIAL, 'nullity' )
+ * );
+ * JobQueueGroup::singleton()->push( $job )
+ * </code>
+ *
+ * @ingroup JobQueue
+ * @since 1.23
+ */
+class JobSpecification implements IJobSpecification {
+	/** @var string */
+	protected $type;
+
+	/** @var array Array of job parameters or false if none */
+	protected $params;
+
+	/** @var Title */
+	protected $title;
+
+	/** @var bool Expensive jobs may set this to true */
+	protected $ignoreDuplicates;
+
+	/**
+	 * @param string $type
+	 * @param array $params Map of key/values
+	 * @param array $opts Map of key/values
+	 * @param Title $title Optional descriptive title
+	 */
+	public function __construct(
+		$type, array $params, array $opts = array(), Title $title = null
+	) {
+		$this->validateParams( $params );
+
+		$this->type = $type;
+		$this->params = $params;
+		$this->title = $title ?: Title::newMainPage();
+		$this->ignoreDuplicates = !empty( $opts['removeDuplicates'] );
+	}
+
+	/**
+	 * @param array $params
+	 */
+	protected function validateParams( array $params ) {
+		foreach ( $params as $p => $v ) {
+			if ( is_array( $v ) ) {
+				$this->validateParams( $v );
+			} elseif ( !is_scalar( $v ) && $v !== null ) {
+				throw new UnexpectedValueException( "Job parameter $p is not JSON serializable." );
+			}
+		}
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getType() {
+		return $this->type;
+	}
+
+	/**
+	 * @return Title
+	 */
+	public function getTitle() {
+		return $this->title;
+	}
+
+	/**
+	 * @return array
+	 */
+	public function getParams() {
+		return $this->params;
+	}
+
+	/**
+	 * @return int|null UNIX timestamp to delay running this job until, otherwise null
+	 */
+	public function getReleaseTimestamp() {
+		return isset( $this->params['jobReleaseTimestamp'] )
+			? wfTimestampOrNull( TS_UNIX, $this->params['jobReleaseTimestamp'] )
+			: null;
+	}
+
+	/**
+	 * @return bool Whether only one of each identical set of jobs should be run
+	 */
+	public function ignoreDuplicates() {
+		return $this->ignoreDuplicates;
+	}
+
+	/**
+	 * Subclasses may need to override this to make duplication detection work.
+	 * The resulting map conveys everything that makes the job unique. This is
+	 * only checked if ignoreDuplicates() returns true, meaning that duplicate
+	 * jobs are supposed to be ignored.
+	 *
+	 * @return array Map of key/values
+	 */
+	public function getDeduplicationInfo() {
+		$info = array(
+			'type' => $this->getType(),
+			'namespace' => $this->getTitle()->getNamespace(),
+			'title' => $this->getTitle()->getDBkey(),
+			'params' => $this->getParams()
+		);
+		if ( is_array( $info['params'] ) ) {
+			// Identical jobs with different "root" jobs should count as duplicates
+			unset( $info['params']['rootJobSignature'] );
+			unset( $info['params']['rootJobTimestamp'] );
+			// Likewise for jobs with different delay times
+			unset( $info['params']['jobReleaseTimestamp'] );
+		}
+
+		return $info;
+	}
+}