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
implements GenericParameterJob
{
37 * Callers should use the factory methods instead
39 * @param array $params Job parameters
41 public function __construct( array $params ) {
42 parent
::__construct( 'enqueue', $params );
46 * @param JobSpecification|JobSpecification[] $jobs
49 public static function newFromLocalJobs( $jobs ) {
50 $jobs = is_array( $jobs ) ?
$jobs : [ $jobs ];
52 return self
::newFromJobsByDomain( [
53 WikiMap
::getCurrentWikiDbDomain()->getId() => $jobs
58 * @param array $jobsByDomain Map of (wiki => JobSpecification list)
61 public static function newFromJobsByDomain( array $jobsByDomain ) {
64 $jobMapsByDomain = [];
65 foreach ( $jobsByDomain as $domain => $jobs ) {
66 $jobMapsByDomain[$domain] = [];
67 foreach ( $jobs as $job ) {
68 if ( $job instanceof JobSpecification
) {
69 $jobMapsByDomain[$domain][] = $job->toSerializableArray();
71 throw new InvalidArgumentException( "Jobs must be of type JobSpecification." );
73 $deduplicate = $deduplicate && $job->ignoreDuplicates();
77 $eJob = new self( [ 'jobsByDomain' => $jobMapsByDomain ] );
78 // If *all* jobs to be pushed are to be de-duplicated (a common case), then
79 // de-duplicate this whole job itself to avoid build up in high traffic cases
80 $eJob->removeDuplicates
= $deduplicate;
86 * @param array $jobsByWiki
88 * @deprecated Since 1.33; use newFromJobsByDomain()
90 public static function newFromJobsByWiki( array $jobsByWiki ) {
91 return self
::newFromJobsByDomain( $jobsByWiki );
94 public function run() {
95 $jobsByDomain = $this->params
['jobsByDomain'] ??
$this->params
['jobsByWiki']; // b/c
97 foreach ( $jobsByDomain as $domain => $jobMaps ) {
99 foreach ( $jobMaps as $jobMap ) {
100 $jobSpecs[] = JobSpecification
::newFromArray( $jobMap );
102 JobQueueGroup
::singleton( $domain )->push( $jobSpecs );