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.20
  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 = false;
  66                 if ( isset( $wgJobTypeConf[$type] ) ) {
  67                         $conf = $wgJobTypeConf[$type];
  68                 } else {
  69                         $conf = $wgJobTypeConf['default'];
  70                 }
  71
  72                 return JobQueue::factory( array(
  73                         'class' => $conf['class'],
  74                         'wiki'  => $this->wiki,
  75                         'type'  => $type,
  76                 ) );
  77         }
  78
  79         /**
  80          * Insert jobs into the respective queues of with the belong
  81          *
  82          * @param $jobs Job|array A single Job or a list of Jobs
  83          * @return bool
  84          */
  85         public function push( $jobs ) {
  86                 $jobs = is_array( $jobs ) ? $jobs : array( $jobs );
  87
  88                 $jobsByType = array(); // (job type => list of jobs)
  89                 foreach ( $jobs as $job ) {
  90                         if ( $job instanceof Job ) {
  91                                 $jobsByType[$job->getType()][] = $job;
  92                         } else {
  93                                 throw new MWException( "Attempted to push a non-Job object into a queue." );
  94                         }
  95                 }
  96
  97                 $ok = true;
  98                 foreach ( $jobsByType as $type => $jobs ) {
  99                         if ( !$this->get( $type )->batchPush( $jobs ) ) {
 100                                 $ok = false;
 101                         }
 102                 }
 103
 104                 return $ok;
 105         }
 106
 107         /**
 108          * Pop a job off one of the job queues
 109          *
 110          * @param $type integer JobQueueGroup::TYPE_* constant
 111          * @return Job|bool Returns false on failure
 112          */
 113         public function pop( $type = self::TYPE_DEFAULT ) {
 114                 $types = ( $type == self::TYPE_DEFAULT )
 115                         ? $this->getDefaultQueueTypes()
 116                         : $this->getQueueTypes();
 117                 shuffle( $types ); // avoid starvation
 118
 119                 foreach ( $types as $type ) { // for each queue...
 120                         $job = $this->get( $type )->pop();
 121                         if ( $job ) {
 122                                 return $job; // found
 123                         }
 124                 }
 125
 126                 return false; // no jobs found
 127         }
 128
 129         /**
 130          * Acknowledge that a job was completed
 131          *
 132          * @param $job Job
 133          * @return bool
 134          */
 135         public function ack( Job $job ) {
 136                 return $this->get( $job->getType() )->ack( $job );
 137         }
 138
 139         /**
 140          * Get the list of queue types
 141          *
 142          * @return array List of strings
 143          */
 144         public function getQueueTypes() {
 145                 global $wgJobClasses;
 146
 147                 return array_keys( $wgJobClasses );
 148         }
 149
 150         /**
 151          * Get the list of default queue types
 152          *
 153          * @return array List of strings
 154          */
 155         public function getDefaultQueueTypes() {
 156                 global $wgJobTypesExcludedFromDefaultQueue;
 157
 158                 return array_diff( $this->getQueueTypes(), $wgJobTypesExcludedFromDefaultQueue );
 159         }
 160 }