includes/jobqueue/JobQueueRedis.php

   1 <?php
   2 /**
   3  * Redis-backed job queue 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 job queues stored in Redis
  26  *
  27  * This is a faster and less resource-intensive job queue than JobQueueDB.
  28  * All data for a queue using this class is placed into one redis server.
  29  *
  30  * There are eight main redis keys used to track jobs:
  31  *   - l-unclaimed  : A list of job IDs used for ready unclaimed jobs
  32  *   - z-claimed    : A sorted set of (job ID, UNIX timestamp as score) used for job retries
  33  *   - z-abandoned  : A sorted set of (job ID, UNIX timestamp as score) used for broken jobs
  34  *   - z-delayed    : A sorted set of (job ID, UNIX timestamp as score) used for delayed jobs
  35  *   - h-idBySha1   : A hash of (SHA1 => job ID) for unclaimed jobs used for de-duplication
  36  *   - h-sha1ById   : A hash of (job ID => SHA1) for unclaimed jobs used for de-duplication
  37  *   - h-attempts   : A hash of (job ID => attempt count) used for job claiming/retries
  38  *   - h-data       : A hash of (job ID => serialized blobs) for job storage
  39  * A job ID can be in only one of z-delayed, l-unclaimed, z-claimed, and z-abandoned.
  40  * If an ID appears in any of those lists, it should have a h-data entry for its ID.
  41  * If a job has a SHA1 de-duplication value and its ID is in l-unclaimed or z-delayed, then
  42  * there should be no other such jobs with that SHA1. Every h-idBySha1 entry has an h-sha1ById
  43  * entry and every h-sha1ById must refer to an ID that is l-unclaimed. If a job has its
  44  * ID in z-claimed or z-abandoned, then it must also have an h-attempts entry for its ID.
  45  *
  46  * Additionally, "rootjob:* keys track "root jobs" used for additional de-duplication.
  47  * Aside from root job keys, all keys have no expiry, and are only removed when jobs are run.
  48  * All the keys are prefixed with the relevant wiki ID information.
  49  *
  50  * This class requires Redis 2.6 as it makes use Lua scripts for fast atomic operations.
  51  * Additionally, it should be noted that redis has different persistence modes, such
  52  * as rdb snapshots, journaling, and no persistence. Appropriate configuration should be
  53  * made on the servers based on what queues are using it and what tolerance they have.
  54  *
  55  * @ingroup JobQueue
  56  * @ingroup Redis
  57  * @since 1.22
  58  */
  59 class JobQueueRedis extends JobQueue {
  60         /** @var RedisConnectionPool */
  61         protected $redisPool;
  62
  63         /** @var string Server address */
  64         protected $server;
  65         /** @var string Compression method to use */
  66         protected $compression;
  67
  68         const MAX_AGE_PRUNE = 604800; // integer; seconds a job can live once claimed (7 days)
  69
  70         /** @var string Key to prefix the queue keys with (used for testing) */
  71         protected $key;
  72
  73         /**
  74          * @param array $params Possible keys:
  75          *   - redisConfig : An array of parameters to RedisConnectionPool::__construct().
  76          *                   Note that the serializer option is ignored as "none" is always used.
  77          *   - redisServer : A hostname/port combination or the absolute path of a UNIX socket.
  78          *                   If a hostname is specified but no port, the standard port number
  79          *                   6379 will be used. Required.
  80          *   - compression : The type of compression to use; one of (none,gzip).
  81          *   - daemonized  : Set to true if the redisJobRunnerService runs in the background.
  82          *                   This will disable job recycling/undelaying from the MediaWiki side
  83          *                   to avoid redundance and out-of-sync configuration.
  84          * @throws InvalidArgumentException
  85          */
  86         public function __construct( array $params ) {
  87                 parent::__construct( $params );
  88                 $params['redisConfig']['serializer'] = 'none'; // make it easy to use Lua
  89                 $this->server = $params['redisServer'];
  90                 $this->compression = isset( $params['compression'] ) ? $params['compression'] : 'none';
  91                 $this->redisPool = RedisConnectionPool::singleton( $params['redisConfig'] );
  92                 if ( empty( $params['daemonized'] ) ) {
  93                         throw new InvalidArgumentException(
  94                                 "Non-daemonized mode is no longer supported. Please install the " .
  95                                 "mediawiki/services/jobrunner service and update \$wgJobTypeConf as needed." );
  96                 }
  97         }
  98
  99         protected function supportedOrders() {
 100                 return array( 'timestamp', 'fifo' );
 101         }
 102
 103         protected function optimalOrder() {
 104                 return 'fifo';
 105         }
 106
 107         protected function supportsDelayedJobs() {
 108                 return true;
 109         }
 110
 111         /**
 112          * @see JobQueue::doIsEmpty()
 113          * @return bool
 114          * @throws JobQueueError
 115          */
 116         protected function doIsEmpty() {
 117                 return $this->doGetSize() == 0;
 118         }
 119
 120         /**
 121          * @see JobQueue::doGetSize()
 122          * @return int
 123          * @throws JobQueueError
 124          */
 125         protected function doGetSize() {
 126                 $conn = $this->getConnection();
 127                 try {
 128                         return $conn->lSize( $this->getQueueKey( 'l-unclaimed' ) );
 129                 } catch ( RedisException $e ) {
 130                         $this->throwRedisException( $conn, $e );
 131                 }
 132         }
 133
 134         /**
 135          * @see JobQueue::doGetAcquiredCount()
 136          * @return int
 137          * @throws JobQueueError
 138          */
 139         protected function doGetAcquiredCount() {
 140                 $conn = $this->getConnection();
 141                 try {
 142                         $conn->multi( Redis::PIPELINE );
 143                         $conn->zSize( $this->getQueueKey( 'z-claimed' ) );
 144                         $conn->zSize( $this->getQueueKey( 'z-abandoned' ) );
 145
 146                         return array_sum( $conn->exec() );
 147                 } catch ( RedisException $e ) {
 148                         $this->throwRedisException( $conn, $e );
 149                 }
 150         }
 151
 152         /**
 153          * @see JobQueue::doGetDelayedCount()
 154          * @return int
 155          * @throws JobQueueError
 156          */
 157         protected function doGetDelayedCount() {
 158                 $conn = $this->getConnection();
 159                 try {
 160                         return $conn->zSize( $this->getQueueKey( 'z-delayed' ) );
 161                 } catch ( RedisException $e ) {
 162                         $this->throwRedisException( $conn, $e );
 163                 }
 164         }
 165
 166         /**
 167          * @see JobQueue::doGetAbandonedCount()
 168          * @return int
 169          * @throws JobQueueError
 170          */
 171         protected function doGetAbandonedCount() {
 172                 $conn = $this->getConnection();
 173                 try {
 174                         return $conn->zSize( $this->getQueueKey( 'z-abandoned' ) );
 175                 } catch ( RedisException $e ) {
 176                         $this->throwRedisException( $conn, $e );
 177                 }
 178         }
 179
 180         /**
 181          * @see JobQueue::doBatchPush()
 182          * @param array $jobs
 183          * @param int $flags
 184          * @return void
 185          * @throws JobQueueError
 186          */
 187         protected function doBatchPush( array $jobs, $flags ) {
 188                 // Convert the jobs into field maps (de-duplicated against each other)
 189                 $items = array(); // (job ID => job fields map)
 190                 foreach ( $jobs as $job ) {
 191                         $item = $this->getNewJobFields( $job );
 192                         if ( strlen( $item['sha1'] ) ) { // hash identifier => de-duplicate
 193                                 $items[$item['sha1']] = $item;
 194                         } else {
 195                                 $items[$item['uuid']] = $item;
 196                         }
 197                 }
 198
 199                 if ( !count( $items ) ) {
 200                         return; // nothing to do
 201                 }
 202
 203                 $conn = $this->getConnection();
 204                 try {
 205                         // Actually push the non-duplicate jobs into the queue...
 206                         if ( $flags & self::QOS_ATOMIC ) {
 207                                 $batches = array( $items ); // all or nothing
 208                         } else {
 209                                 $batches = array_chunk( $items, 100 ); // avoid tying up the server
 210                         }
 211                         $failed = 0;
 212                         $pushed = 0;
 213                         foreach ( $batches as $itemBatch ) {
 214                                 $added = $this->pushBlobs( $conn, $itemBatch );
 215                                 if ( is_int( $added ) ) {
 216                                         $pushed += $added;
 217                                 } else {
 218                                         $failed += count( $itemBatch );
 219                                 }
 220                         }
 221                         if ( $failed > 0 ) {
 222                                 wfDebugLog( 'JobQueueRedis', "Could not insert {$failed} {$this->type} job(s)." );
 223
 224                                 throw new RedisException( "Could not insert {$failed} {$this->type} job(s)." );
 225                         }
 226                         JobQueue::incrStats( 'job-insert', $this->type, count( $items ) );
 227                         JobQueue::incrStats( 'job-insert-duplicate', $this->type,
 228                                 count( $items ) - $failed - $pushed );
 229                 } catch ( RedisException $e ) {
 230                         $this->throwRedisException( $conn, $e );
 231                 }
 232         }
 233
 234         /**
 235          * @param RedisConnRef $conn
 236          * @param array $items List of results from JobQueueRedis::getNewJobFields()
 237          * @return int Number of jobs inserted (duplicates are ignored)
 238          * @throws RedisException
 239          */
 240         protected function pushBlobs( RedisConnRef $conn, array $items ) {
 241                 $args = array(); // ([id, sha1, rtime, blob [, id, sha1, rtime, blob ... ] ] )
 242                 foreach ( $items as $item ) {
 243                         $args[] = (string)$item['uuid'];
 244                         $args[] = (string)$item['sha1'];
 245                         $args[] = (string)$item['rtimestamp'];
 246                         $args[] = (string)$this->serialize( $item );
 247                 }
 248                 static $script =
 249 <<<LUA
 250                 local kUnclaimed, kSha1ById, kIdBySha1, kDelayed, kData = unpack(KEYS)
 251                 if #ARGV % 4 ~= 0 then return redis.error_reply('Unmatched arguments') end
 252                 local pushed = 0
 253                 for i = 1,#ARGV,4 do
 254                         local id,sha1,rtimestamp,blob = ARGV[i],ARGV[i+1],ARGV[i+2],ARGV[i+3]
 255                         if sha1 == '' or redis.call('hExists',kIdBySha1,sha1) == 0 then
 256                                 if 1*rtimestamp > 0 then
 257                                         -- Insert into delayed queue (release time as score)
 258                                         redis.call('zAdd',kDelayed,rtimestamp,id)
 259                                 else
 260                                         -- Insert into unclaimed queue
 261                                         redis.call('lPush',kUnclaimed,id)
 262                                 end
 263                                 if sha1 ~= '' then
 264                                         redis.call('hSet',kSha1ById,id,sha1)
 265                                         redis.call('hSet',kIdBySha1,sha1,id)
 266                                 end
 267                                 redis.call('hSet',kData,id,blob)
 268                                 pushed = pushed + 1
 269                         end
 270                 end
 271                 return pushed
 272 LUA;
 273                 return $conn->luaEval( $script,
 274                         array_merge(
 275                                 array(
 276                                         $this->getQueueKey( 'l-unclaimed' ), # KEYS[1]
 277                                         $this->getQueueKey( 'h-sha1ById' ), # KEYS[2]
 278                                         $this->getQueueKey( 'h-idBySha1' ), # KEYS[3]
 279                                         $this->getQueueKey( 'z-delayed' ), # KEYS[4]
 280                                         $this->getQueueKey( 'h-data' ), # KEYS[5]
 281                                 ),
 282                                 $args
 283                         ),
 284                         5 # number of first argument(s) that are keys
 285                 );
 286         }
 287
 288         /**
 289          * @see JobQueue::doPop()
 290          * @return Job|bool
 291          * @throws JobQueueError
 292          */
 293         protected function doPop() {
 294                 $job = false;
 295
 296                 $conn = $this->getConnection();
 297                 try {
 298                         do {
 299                                 $blob = $this->popAndAcquireBlob( $conn );
 300                                 if ( !is_string( $blob ) ) {
 301                                         break; // no jobs; nothing to do
 302                                 }
 303
 304                                 JobQueue::incrStats( 'job-pop', $this->type );
 305                                 $item = $this->unserialize( $blob );
 306                                 if ( $item === false ) {
 307                                         wfDebugLog( 'JobQueueRedis', "Could not unserialize {$this->type} job." );
 308                                         continue;
 309                                 }
 310
 311                                 // If $item is invalid, the runner loop recyling will cleanup as needed
 312                                 $job = $this->getJobFromFields( $item ); // may be false
 313                         } while ( !$job ); // job may be false if invalid
 314                 } catch ( RedisException $e ) {
 315                         $this->throwRedisException( $conn, $e );
 316                 }
 317
 318                 return $job;
 319         }
 320
 321         /**
 322          * @param RedisConnRef $conn
 323          * @return array Serialized string or false
 324          * @throws RedisException
 325          */
 326         protected function popAndAcquireBlob( RedisConnRef $conn ) {
 327                 static $script =
 328 <<<LUA
 329                 local kUnclaimed, kSha1ById, kIdBySha1, kClaimed, kAttempts, kData = unpack(KEYS)
 330                 -- Pop an item off the queue
 331                 local id = redis.call('rPop',kUnclaimed)
 332                 if not id then return false end
 333                 -- Allow new duplicates of this job
 334                 local sha1 = redis.call('hGet',kSha1ById,id)
 335                 if sha1 then redis.call('hDel',kIdBySha1,sha1) end
 336                 redis.call('hDel',kSha1ById,id)
 337                 -- Mark the jobs as claimed and return it
 338                 redis.call('zAdd',kClaimed,ARGV[1],id)
 339                 redis.call('hIncrBy',kAttempts,id,1)
 340                 return redis.call('hGet',kData,id)
 341 LUA;
 342                 return $conn->luaEval( $script,
 343                         array(
 344                                 $this->getQueueKey( 'l-unclaimed' ), # KEYS[1]
 345                                 $this->getQueueKey( 'h-sha1ById' ), # KEYS[2]
 346                                 $this->getQueueKey( 'h-idBySha1' ), # KEYS[3]
 347                                 $this->getQueueKey( 'z-claimed' ), # KEYS[4]
 348                                 $this->getQueueKey( 'h-attempts' ), # KEYS[5]
 349                                 $this->getQueueKey( 'h-data' ), # KEYS[6]
 350                                 time(), # ARGV[1] (injected to be replication-safe)
 351                         ),
 352                         6 # number of first argument(s) that are keys
 353                 );
 354         }
 355
 356         /**
 357          * @see JobQueue::doAck()
 358          * @param Job $job
 359          * @return Job|bool
 360          * @throws UnexpectedValueException
 361          * @throws JobQueueError
 362          */
 363         protected function doAck( Job $job ) {
 364                 if ( !isset( $job->metadata['uuid'] ) ) {
 365                         throw new UnexpectedValueException( "Job of type '{$job->getType()}' has no UUID." );
 366                 }
 367
 368                 $conn = $this->getConnection();
 369                 try {
 370                         static $script =
 371 <<<LUA
 372                         local kClaimed, kAttempts, kData = unpack(KEYS)
 373                         -- Unmark the job as claimed
 374                         redis.call('zRem',kClaimed,ARGV[1])
 375                         redis.call('hDel',kAttempts,ARGV[1])
 376                         -- Delete the job data itself
 377                         return redis.call('hDel',kData,ARGV[1])
 378 LUA;
 379                         $res = $conn->luaEval( $script,
 380                                 array(
 381                                         $this->getQueueKey( 'z-claimed' ), # KEYS[1]
 382                                         $this->getQueueKey( 'h-attempts' ), # KEYS[2]
 383                                         $this->getQueueKey( 'h-data' ), # KEYS[3]
 384                                         $job->metadata['uuid'] # ARGV[1]
 385                                 ),
 386                                 3 # number of first argument(s) that are keys
 387                         );
 388
 389                         if ( !$res ) {
 390                                 wfDebugLog( 'JobQueueRedis', "Could not acknowledge {$this->type} job." );
 391
 392                                 return false;
 393                         }
 394
 395                         JobQueue::incrStats( 'job-ack', $this->type );
 396                 } catch ( RedisException $e ) {
 397                         $this->throwRedisException( $conn, $e );
 398                 }
 399
 400                 return true;
 401         }
 402
 403         /**
 404          * @see JobQueue::doDeduplicateRootJob()
 405          * @param IJobSpecification $job
 406          * @return bool
 407          * @throws JobQueueError
 408          * @throws LogicException
 409          */
 410         protected function doDeduplicateRootJob( IJobSpecification $job ) {
 411                 if ( !$job->hasRootJobParams() ) {
 412                         throw new LogicException( "Cannot register root job; missing parameters." );
 413                 }
 414                 $params = $job->getRootJobParams();
 415
 416                 $key = $this->getRootJobCacheKey( $params['rootJobSignature'] );
 417
 418                 $conn = $this->getConnection();
 419                 try {
 420                         $timestamp = $conn->get( $key ); // current last timestamp of this job
 421                         if ( $timestamp && $timestamp >= $params['rootJobTimestamp'] ) {
 422                                 return true; // a newer version of this root job was enqueued
 423                         }
 424
 425                         // Update the timestamp of the last root job started at the location...
 426                         return $conn->set( $key, $params['rootJobTimestamp'], self::ROOTJOB_TTL ); // 2 weeks
 427                 } catch ( RedisException $e ) {
 428                         $this->throwRedisException( $conn, $e );
 429                 }
 430         }
 431
 432         /**
 433          * @see JobQueue::doIsRootJobOldDuplicate()
 434          * @param Job $job
 435          * @return bool
 436          * @throws JobQueueError
 437          */
 438         protected function doIsRootJobOldDuplicate( Job $job ) {
 439                 if ( !$job->hasRootJobParams() ) {
 440                         return false; // job has no de-deplication info
 441                 }
 442                 $params = $job->getRootJobParams();
 443
 444                 $conn = $this->getConnection();
 445                 try {
 446                         // Get the last time this root job was enqueued
 447                         $timestamp = $conn->get( $this->getRootJobCacheKey( $params['rootJobSignature'] ) );
 448                 } catch ( RedisException $e ) {
 449                         $this->throwRedisException( $conn, $e );
 450                 }
 451
 452                 // Check if a new root job was started at the location after this one's...
 453                 return ( $timestamp && $timestamp > $params['rootJobTimestamp'] );
 454         }
 455
 456         /**
 457          * @see JobQueue::doDelete()
 458          * @return bool
 459          * @throws JobQueueError
 460          */
 461         protected function doDelete() {
 462                 static $props = array( 'l-unclaimed', 'z-claimed', 'z-abandoned',
 463                         'z-delayed', 'h-idBySha1', 'h-sha1ById', 'h-attempts', 'h-data' );
 464
 465                 $conn = $this->getConnection();
 466                 try {
 467                         $keys = array();
 468                         foreach ( $props as $prop ) {
 469                                 $keys[] = $this->getQueueKey( $prop );
 470                         }
 471
 472                         return ( $conn->delete( $keys ) !== false );
 473                 } catch ( RedisException $e ) {
 474                         $this->throwRedisException( $conn, $e );
 475                 }
 476         }
 477
 478         /**
 479          * @see JobQueue::getAllQueuedJobs()
 480          * @return Iterator
 481          * @throws JobQueueError
 482          */
 483         public function getAllQueuedJobs() {
 484                 $conn = $this->getConnection();
 485                 try {
 486                         $uids = $conn->lRange( $this->getQueueKey( 'l-unclaimed' ), 0, -1 );
 487                 } catch ( RedisException $e ) {
 488                         $this->throwRedisException( $conn, $e );
 489                 }
 490
 491                 return $this->getJobIterator( $conn, $uids );
 492         }
 493
 494         /**
 495          * @see JobQueue::getAllDelayedJobs()
 496          * @return Iterator
 497          * @throws JobQueueError
 498          */
 499         public function getAllDelayedJobs() {
 500                 $conn = $this->getConnection();
 501                 try {
 502                         $uids = $conn->zRange( $this->getQueueKey( 'z-delayed' ), 0, -1 );
 503                 } catch ( RedisException $e ) {
 504                         $this->throwRedisException( $conn, $e );
 505                 }
 506
 507                 return $this->getJobIterator( $conn, $uids );
 508         }
 509
 510         /**
 511          * @see JobQueue::getAllAcquiredJobs()
 512          * @return Iterator
 513          * @throws JobQueueError
 514          */
 515         public function getAllAcquiredJobs() {
 516                 $conn = $this->getConnection();
 517                 try {
 518                         $uids = $conn->zRange( $this->getQueueKey( 'z-claimed' ), 0, -1 );
 519                 } catch ( RedisException $e ) {
 520                         $this->throwRedisException( $conn, $e );
 521                 }
 522
 523                 return $this->getJobIterator( $conn, $uids );
 524         }
 525
 526         /**
 527          * @see JobQueue::getAllAbandonedJobs()
 528          * @return Iterator
 529          * @throws JobQueueError
 530          */
 531         public function getAllAbandonedJobs() {
 532                 $conn = $this->getConnection();
 533                 try {
 534                         $uids = $conn->zRange( $this->getQueueKey( 'z-abandoned' ), 0, -1 );
 535                 } catch ( RedisException $e ) {
 536                         $this->throwRedisException( $conn, $e );
 537                 }
 538
 539                 return $this->getJobIterator( $conn, $uids );
 540         }
 541
 542         /**
 543          * @param RedisConnRef $conn
 544          * @param array $uids List of job UUIDs
 545          * @return MappedIterator
 546          */
 547         protected function getJobIterator( RedisConnRef $conn, array $uids ) {
 548                 $that = $this;
 549
 550                 return new MappedIterator(
 551                         $uids,
 552                         function ( $uid ) use ( $that, $conn ) {
 553                                 return $that->getJobFromUidInternal( $uid, $conn );
 554                         },
 555                         array( 'accept' => function ( $job ) {
 556                                 return is_object( $job );
 557                         } )
 558                 );
 559         }
 560
 561         public function getCoalesceLocationInternal() {
 562                 return "RedisServer:" . $this->server;
 563         }
 564
 565         protected function doGetSiblingQueuesWithJobs( array $types ) {
 566                 return array_keys( array_filter( $this->doGetSiblingQueueSizes( $types ) ) );
 567         }
 568
 569         protected function doGetSiblingQueueSizes( array $types ) {
 570                 $sizes = array(); // (type => size)
 571                 $types = array_values( $types ); // reindex
 572                 $conn = $this->getConnection();
 573                 try {
 574                         $conn->multi( Redis::PIPELINE );
 575                         foreach ( $types as $type ) {
 576                                 $conn->lSize( $this->getQueueKey( 'l-unclaimed', $type ) );
 577                         }
 578                         $res = $conn->exec();
 579                         if ( is_array( $res ) ) {
 580                                 foreach ( $res as $i => $size ) {
 581                                         $sizes[$types[$i]] = $size;
 582                                 }
 583                         }
 584                 } catch ( RedisException $e ) {
 585                         $this->throwRedisException( $conn, $e );
 586                 }
 587
 588                 return $sizes;
 589         }
 590
 591         /**
 592          * This function should not be called outside JobQueueRedis
 593          *
 594          * @param string $uid
 595          * @param RedisConnRef $conn
 596          * @return Job|bool Returns false if the job does not exist
 597          * @throws JobQueueError
 598          * @throws UnexpectedValueException
 599          */
 600         public function getJobFromUidInternal( $uid, RedisConnRef $conn ) {
 601                 try {
 602                         $data = $conn->hGet( $this->getQueueKey( 'h-data' ), $uid );
 603                         if ( $data === false ) {
 604                                 return false; // not found
 605                         }
 606                         $item = $this->unserialize( $data );
 607                         if ( !is_array( $item ) ) { // this shouldn't happen
 608                                 throw new UnexpectedValueException( "Could not find job with ID '$uid'." );
 609                         }
 610                         $title = Title::makeTitle( $item['namespace'], $item['title'] );
 611                         $job = Job::factory( $item['type'], $title, $item['params'] );
 612                         $job->metadata['uuid'] = $item['uuid'];
 613                         $job->metadata['timestamp'] = $item['timestamp'];
 614
 615                         return $job;
 616                 } catch ( RedisException $e ) {
 617                         $this->throwRedisException( $conn, $e );
 618                 }
 619         }
 620
 621         /**
 622          * @param IJobSpecification $job
 623          * @return array
 624          */
 625         protected function getNewJobFields( IJobSpecification $job ) {
 626                 return array(
 627                         // Fields that describe the nature of the job
 628                         'type' => $job->getType(),
 629                         'namespace' => $job->getTitle()->getNamespace(),
 630                         'title' => $job->getTitle()->getDBkey(),
 631                         'params' => $job->getParams(),
 632                         // Some jobs cannot run until a "release timestamp"
 633                         'rtimestamp' => $job->getReleaseTimestamp() ?: 0,
 634                         // Additional job metadata
 635                         'uuid' => UIDGenerator::newRawUUIDv4( UIDGenerator::QUICK_RAND ),
 636                         'sha1' => $job->ignoreDuplicates()
 637                                 ? wfBaseConvert( sha1( serialize( $job->getDeduplicationInfo() ) ), 16, 36, 31 )
 638                                 : '',
 639                         'timestamp' => time() // UNIX timestamp
 640                 );
 641         }
 642
 643         /**
 644          * @param array $fields
 645          * @return Job|bool
 646          */
 647         protected function getJobFromFields( array $fields ) {
 648                 $title = Title::makeTitle( $fields['namespace'], $fields['title'] );
 649                 $job = Job::factory( $fields['type'], $title, $fields['params'] );
 650                 $job->metadata['uuid'] = $fields['uuid'];
 651                 $job->metadata['timestamp'] = $fields['timestamp'];
 652
 653                 return $job;
 654         }
 655
 656         /**
 657          * @param array $fields
 658          * @return string Serialized and possibly compressed version of $fields
 659          */
 660         protected function serialize( array $fields ) {
 661                 $blob = serialize( $fields );
 662                 if ( $this->compression === 'gzip'
 663                         && strlen( $blob ) >= 1024
 664                         && function_exists( 'gzdeflate' )
 665                 ) {
 666                         $object = (object)array( 'blob' => gzdeflate( $blob ), 'enc' => 'gzip' );
 667                         $blobz = serialize( $object );
 668
 669                         return ( strlen( $blobz ) < strlen( $blob ) ) ? $blobz : $blob;
 670                 } else {
 671                         return $blob;
 672                 }
 673         }
 674
 675         /**
 676          * @param string $blob
 677          * @return array|bool Unserialized version of $blob or false
 678          */
 679         protected function unserialize( $blob ) {
 680                 $fields = unserialize( $blob );
 681                 if ( is_object( $fields ) ) {
 682                         if ( $fields->enc === 'gzip' && function_exists( 'gzinflate' ) ) {
 683                                 $fields = unserialize( gzinflate( $fields->blob ) );
 684                         } else {
 685                                 $fields = false;
 686                         }
 687                 }
 688
 689                 return is_array( $fields ) ? $fields : false;
 690         }
 691
 692         /**
 693          * Get a connection to the server that handles all sub-queues for this queue
 694          *
 695          * @return RedisConnRef
 696          * @throws JobQueueConnectionError
 697          */
 698         protected function getConnection() {
 699                 $conn = $this->redisPool->getConnection( $this->server );
 700                 if ( !$conn ) {
 701                         throw new JobQueueConnectionError( "Unable to connect to redis server." );
 702                 }
 703
 704                 return $conn;
 705         }
 706
 707         /**
 708          * @param RedisConnRef $conn
 709          * @param RedisException $e
 710          * @throws JobQueueError
 711          */
 712         protected function throwRedisException( RedisConnRef $conn, $e ) {
 713                 $this->redisPool->handleError( $conn, $e );
 714                 throw new JobQueueError( "Redis server error: {$e->getMessage()}\n" );
 715         }
 716
 717         /**
 718          * @param string $prop
 719          * @param string|null $type
 720          * @return string
 721          */
 722         private function getQueueKey( $prop, $type = null ) {
 723                 $type = is_string( $type ) ? $type : $this->type;
 724                 list( $db, $prefix ) = wfSplitWikiID( $this->wiki );
 725                 if ( strlen( $this->key ) ) { // namespaced queue (for testing)
 726                         return wfForeignMemcKey( $db, $prefix, 'jobqueue', $type, $this->key, $prop );
 727                 } else {
 728                         return wfForeignMemcKey( $db, $prefix, 'jobqueue', $type, $prop );
 729                 }
 730         }
 731
 732         /**
 733          * @param string $key
 734          * @return void
 735          */
 736         public function setTestingPrefix( $key ) {
 737                 $this->key = $key;
 738         }
 739 }