3 * Router job that takes jobs and enqueues them.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
25 * Router job that takes jobs and enqueues them to their proper queues
27 * This can be used for getting sets of multiple jobs or sets of jobs intended for multiple
28 * queues to be inserted more robustly. This is a single job that, upon running, enqueues the
29 * wrapped jobs. If some of those fail to enqueue then the EnqueueJob will be retried. Due to
30 * the possibility of duplicate enqueues, the wrapped jobs should be idempotent.
35 final class EnqueueJob
extends Job
{
37 * Callers should use the factory methods instead
40 * @param array $params Job parameters
42 function __construct( Title
$title, array $params ) {
43 parent
::__construct( 'enqueue', $title, $params );
47 * @param JobSpecification|JobSpecification[] $jobs
50 public static function newFromLocalJobs( $jobs ) {
51 $jobs = is_array( $jobs ) ?
$jobs : [ $jobs ];
53 return self
::newFromJobsByDomain( [
54 WikiMap
::getCurrentWikiDbDomain()->getId() => $jobs
59 * @param array $jobsByDomain Map of (wiki => JobSpecification list)
62 public static function newFromJobsByDomain( array $jobsByDomain ) {
65 $jobMapsByDomain = [];
66 foreach ( $jobsByDomain as $domain => $jobs ) {
67 $jobMapsByDomain[$domain] = [];
68 foreach ( $jobs as $job ) {
69 if ( $job instanceof JobSpecification
) {
70 $jobMapsByDomain[$domain][] = $job->toSerializableArray();
72 throw new InvalidArgumentException( "Jobs must be of type JobSpecification." );
74 $deduplicate = $deduplicate && $job->ignoreDuplicates();
79 Title
::makeTitle( NS_SPECIAL
, 'Badtitle/' . __CLASS__
),
80 [ 'jobsByDomain' => $jobMapsByDomain ]
82 // If *all* jobs to be pushed are to be de-duplicated (a common case), then
83 // de-duplicate this whole job itself to avoid build up in high traffic cases
84 $eJob->removeDuplicates
= $deduplicate;
90 * @param array $jobsByWiki
92 * @deprecated Since 1.33; use newFromJobsByDomain()
94 public static function newFromJobsByWiki( array $jobsByWiki ) {
95 return self
::newFromJobsByDomain( $jobsByWiki );
98 public function run() {
99 $jobsByDomain = $this->params
['jobsByDomain'] ??
$this->params
['jobsByWiki']; // b/c
101 foreach ( $jobsByDomain as $domain => $jobMaps ) {
103 foreach ( $jobMaps as $jobMap ) {
104 $jobSpecs[] = JobSpecification
::newFromArray( $jobMap );
106 JobQueueGroup
::singleton( $domain )->push( $jobSpecs );