1 files changed, 98 insertions, 0 deletions
diff --git a/www/wiki/includes/jobqueue/jobs/EnqueueJob.php b/www/wiki/includes/jobqueue/jobs/EnqueueJob.php
new file mode 100644
index 00000000..ea7a8d78
--- /dev/null
+++ b/www/wiki/includes/jobqueue/jobs/EnqueueJob.php
@@ -0,0 +1,98 @@
+<?php
+/**
+ * Router job that takes jobs and enqueues them.
+ *
+ * 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
+ */
+
+/**
+ * Router job that takes jobs and enqueues them to their proper queues
+ *
+ * This can be used for getting sets of multiple jobs or sets of jobs intended for multiple
+ * queues to be inserted more robustly. This is a single job that, upon running, enqueues the
+ * wrapped jobs. If some of those fail to enqueue then the EnqueueJob will be retried. Due to
+ * the possibility of duplicate enqueues, the wrapped jobs should be idempotent.
+ *
+ * @ingroup JobQueue
+ * @since 1.25
+ */
+final class EnqueueJob extends Job {
+	/**
+	 * Callers should use the factory methods instead
+	 *
+	 * @param Title $title
+	 * @param array $params Job parameters
+	 */
+	function __construct( Title $title, array $params ) {
+		parent::__construct( 'enqueue', $title, $params );
+	}
+
+	/**
+	 * @param JobSpecification|JobSpecification[] $jobs
+	 * @return EnqueueJob
+	 */
+	public static function newFromLocalJobs( $jobs ) {
+		$jobs = is_array( $jobs ) ? $jobs : [ $jobs ];
+
+		return self::newFromJobsByWiki( [ wfWikiID() => $jobs ] );
+	}
+
+	/**
+	 * @param array $jobsByWiki Map of (wiki => JobSpecification list)
+	 * @return EnqueueJob
+	 */
+	public static function newFromJobsByWiki( array $jobsByWiki ) {
+		$deduplicate = true;
+
+		$jobMapsByWiki = [];
+		foreach ( $jobsByWiki as $wiki => $jobs ) {
+			$jobMapsByWiki[$wiki] = [];
+			foreach ( $jobs as $job ) {
+				if ( $job instanceof JobSpecification ) {
+					$jobMapsByWiki[$wiki][] = $job->toSerializableArray();
+				} else {
+					throw new InvalidArgumentException( "Jobs must be of type JobSpecification." );
+				}
+				$deduplicate = $deduplicate && $job->ignoreDuplicates();
+			}
+		}
+
+		$eJob = new self(
+			Title::makeTitle( NS_SPECIAL, 'Badtitle/' . __CLASS__ ),
+			[ 'jobsByWiki' => $jobMapsByWiki ]
+		);
+		// If *all* jobs to be pushed are to be de-duplicated (a common case), then
+		// de-duplicate this whole job itself to avoid build up in high traffic cases
+		$eJob->removeDuplicates = $deduplicate;
+
+		return $eJob;
+	}
+
+	public function run() {
+		foreach ( $this->params['jobsByWiki'] as $wiki => $jobMaps ) {
+			$jobSpecs = [];
+			foreach ( $jobMaps as $jobMap ) {
+				$jobSpecs[] = JobSpecification::newFromArray( $jobMap );
+			}
+			JobQueueGroup::singleton( $wiki )->push( $jobSpecs );
+		}
+
+		return true;
+	}
+}