includes/job/JobQueueGroup.php

   1 <?php
   2 /**
   3  * Job queue base code.
   4  *
   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.
   9  *
  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.
  14  *
  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
  19  *
  20  * @file
  21  * @author Aaron Schulz
  22  */
  23
  24 /**
  25  * Class to handle enqueueing of background jobs
  26  *
  27  * @ingroup JobQueue
  28  * @since 1.21
  29  */
  30 class JobQueueGroup {
  31         /** @var Array */
  32         protected static $instances = array();
  33
  34         protected $wiki; // string; wiki ID
  35
  36         const TYPE_DEFAULT = 1; // integer; job not in $wgJobTypesExcludedFromDefaultQueue
  37         const TYPE_ANY     = 2; // integer; any job
  38
  39         /**
  40          * @param $wiki string Wiki ID
  41          */
  42         protected function __construct( $wiki ) {
  43                 $this->wiki = $wiki;
  44         }
  45
  46         /**
  47          * @param $wiki string Wiki ID
  48          * @return JobQueueGroup
  49          */
  50         public static function singleton( $wiki = false ) {
  51                 $wiki = ( $wiki === false ) ? wfWikiID() : $wiki;
  52                 if ( !isset( self::$instances[$wiki] ) ) {
  53                         self::$instances[$wiki] = new self( $wiki );
  54                 }
  55                 return self::$instances[$wiki];
  56         }
  57
  58         /**
  59          * @param $type string
  60          * @return JobQueue Job queue object for a given queue type
  61          */
  62         public function get( $type ) {
  63                 global $wgJobTypeConf;
  64
  65                 $conf = array( 'wiki' => $this->wiki, 'type' => $type );
  66                 if ( isset( $wgJobTypeConf[$type] ) ) {
  67                         $conf = $conf + $wgJobTypeConf[$type];
  68                 } else {
  69                         $conf = $conf + $wgJobTypeConf['default'];
  70                 }
  71
  72                 return JobQueue::factory( $conf );
  73         }
  74
  75         /**
  76          * Insert jobs into the respective queues of with the belong
  77          *
  78          * @param $jobs Job|array A single Job or a list of Jobs
  79          * @return bool
  80          */
  81         public function push( $jobs ) {
  82                 $jobs = is_array( $jobs ) ? $jobs : array( $jobs );
  83
  84                 $jobsByType = array(); // (job type => list of jobs)
  85                 foreach ( $jobs as $job ) {
  86                         if ( $job instanceof Job ) {
  87                                 $jobsByType[$job->getType()][] = $job;
  88                         } else {
  89                                 throw new MWException( "Attempted to push a non-Job object into a queue." );
  90                         }
  91                 }
  92
  93                 $ok = true;
  94                 foreach ( $jobsByType as $type => $jobs ) {
  95                         if ( !$this->get( $type )->batchPush( $jobs ) ) {
  96                                 $ok = false;
  97                         }
  98                 }
  99
 100                 return $ok;
 101         }
 102
 103         /**
 104          * Pop a job off one of the job queues
 105          *
 106          * @param $type integer JobQueueGroup::TYPE_* constant
 107          * @return Job|bool Returns false on failure
 108          */
 109         public function pop( $type = self::TYPE_DEFAULT ) {
 110                 $types = ( $type == self::TYPE_DEFAULT )
 111                         ? $this->getDefaultQueueTypes()
 112                         : $this->getQueueTypes();
 113                 shuffle( $types ); // avoid starvation
 114
 115                 foreach ( $types as $type ) { // for each queue...
 116                         $job = $this->get( $type )->pop();
 117                         if ( $job ) {
 118                                 return $job; // found
 119                         }
 120                 }
 121
 122                 return false; // no jobs found
 123         }
 124
 125         /**
 126          * Acknowledge that a job was completed
 127          *
 128          * @param $job Job
 129          * @return bool
 130          */
 131         public function ack( Job $job ) {
 132                 return $this->get( $job->getType() )->ack( $job );
 133         }
 134
 135         /**
 136          * Register the "root job" of a given job into the queue for de-duplication.
 137          * This should only be called right *after* all the new jobs have been inserted.
 138          *
 139          * @param $job Job
 140          * @return bool
 141          */
 142         public function deduplicateRootJob( Job $job ) {
 143                 return $this->get( $job->getType() )->deduplicateRootJob( $job );
 144         }
 145
 146         /**
 147          * Get the list of queue types
 148          *
 149          * @return array List of strings
 150          */
 151         public function getQueueTypes() {
 152                 global $wgJobClasses;
 153
 154                 return array_keys( $wgJobClasses );
 155         }
 156
 157         /**
 158          * Get the list of default queue types
 159          *
 160          * @return array List of strings
 161          */
 162         public function getDefaultQueueTypes() {
 163                 global $wgJobTypesExcludedFromDefaultQueue;
 164
 165                 return array_diff( $this->getQueueTypes(), $wgJobTypesExcludedFromDefaultQueue );
 166         }
 167
 168         /**
 169          * @return Array List of job types that have non-empty queues
 170          */
 171         public function getQueuesWithJobs() {
 172                 $types = array();
 173                 foreach ( $this->getQueueTypes() as $type ) {
 174                         if ( !$this->get( $type )->isEmpty() ) {
 175                                 $types[] = $type;
 176                         }
 177                 }
 178                 return $types;
 179         }
 180 }