includes/jobqueue/JobQueueDB.php

   1 <?php
   2 /**
   3  * Database-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 the DB
  26  *
  27  * @ingroup JobQueue
  28  * @since 1.21
  29  */
  30 class JobQueueDB extends JobQueue {
  31         const CACHE_TTL_SHORT = 30; // integer; seconds to cache info without re-validating
  32         const MAX_AGE_PRUNE = 604800; // integer; seconds a job can live once claimed
  33         const MAX_JOB_RANDOM = 2147483647; // integer; 2^31 - 1, used for job_random
  34         const MAX_OFFSET = 255; // integer; maximum number of rows to skip
  35
  36         /** @var BagOStuff */
  37         protected $cache;
  38
  39         /** @var bool|string Name of an external DB cluster. False if not set */
  40         protected $cluster = false;
  41
  42         /**
  43          * Additional parameters include:
  44          *   - cluster : The name of an external cluster registered via LBFactory.
  45          *               If not specified, the primary DB cluster for the wiki will be used.
  46          *               This can be overridden with a custom cluster so that DB handles will
  47          *               be retrieved via LBFactory::getExternalLB() and getConnection().
  48          * @param array $params
  49          */
  50         protected function __construct( array $params ) {
  51                 global $wgMemc;
  52
  53                 parent::__construct( $params );
  54
  55                 $this->cluster = isset( $params['cluster'] ) ? $params['cluster'] : false;
  56                 // Make sure that we don't use the SQL cache, which would be harmful
  57                 $this->cache = ( $wgMemc instanceof SqlBagOStuff ) ? new EmptyBagOStuff() : $wgMemc;
  58         }
  59
  60         protected function supportedOrders() {
  61                 return array( 'random', 'timestamp', 'fifo' );
  62         }
  63
  64         protected function optimalOrder() {
  65                 return 'random';
  66         }
  67
  68         /**
  69          * @see JobQueue::doIsEmpty()
  70          * @return bool
  71          */
  72         protected function doIsEmpty() {
  73                 $dbr = $this->getSlaveDB();
  74                 try {
  75                         $found = $dbr->selectField( // unclaimed job
  76                                 'job', '1', array( 'job_cmd' => $this->type, 'job_token' => '' ), __METHOD__
  77                         );
  78                 } catch ( DBError $e ) {
  79                         $this->throwDBException( $e );
  80                 }
  81
  82                 return !$found;
  83         }
  84
  85         /**
  86          * @see JobQueue::doGetSize()
  87          * @return int
  88          */
  89         protected function doGetSize() {
  90                 $key = $this->getCacheKey( 'size' );
  91
  92                 $size = $this->cache->get( $key );
  93                 if ( is_int( $size ) ) {
  94                         return $size;
  95                 }
  96
  97                 try {
  98                         $dbr = $this->getSlaveDB();
  99                         $size = (int)$dbr->selectField( 'job', 'COUNT(*)',
 100                                 array( 'job_cmd' => $this->type, 'job_token' => '' ),
 101                                 __METHOD__
 102                         );
 103                 } catch ( DBError $e ) {
 104                         $this->throwDBException( $e );
 105                 }
 106                 $this->cache->set( $key, $size, self::CACHE_TTL_SHORT );
 107
 108                 return $size;
 109         }
 110
 111         /**
 112          * @see JobQueue::doGetAcquiredCount()
 113          * @return int
 114          */
 115         protected function doGetAcquiredCount() {
 116                 if ( $this->claimTTL <= 0 ) {
 117                         return 0; // no acknowledgements
 118                 }
 119
 120                 $key = $this->getCacheKey( 'acquiredcount' );
 121
 122                 $count = $this->cache->get( $key );
 123                 if ( is_int( $count ) ) {
 124                         return $count;
 125                 }
 126
 127                 $dbr = $this->getSlaveDB();
 128                 try {
 129                         $count = (int)$dbr->selectField( 'job', 'COUNT(*)',
 130                                 array( 'job_cmd' => $this->type, "job_token != {$dbr->addQuotes( '' )}" ),
 131                                 __METHOD__
 132                         );
 133                 } catch ( DBError $e ) {
 134                         $this->throwDBException( $e );
 135                 }
 136                 $this->cache->set( $key, $count, self::CACHE_TTL_SHORT );
 137
 138                 return $count;
 139         }
 140
 141         /**
 142          * @see JobQueue::doGetAbandonedCount()
 143          * @return int
 144          * @throws MWException
 145          */
 146         protected function doGetAbandonedCount() {
 147                 global $wgMemc;
 148
 149                 if ( $this->claimTTL <= 0 ) {
 150                         return 0; // no acknowledgements
 151                 }
 152
 153                 $key = $this->getCacheKey( 'abandonedcount' );
 154
 155                 $count = $wgMemc->get( $key );
 156                 if ( is_int( $count ) ) {
 157                         return $count;
 158                 }
 159
 160                 $dbr = $this->getSlaveDB();
 161                 try {
 162                         $count = (int)$dbr->selectField( 'job', 'COUNT(*)',
 163                                 array(
 164                                         'job_cmd' => $this->type,
 165                                         "job_token != {$dbr->addQuotes( '' )}",
 166                                         "job_attempts >= " . $dbr->addQuotes( $this->maxTries )
 167                                 ),
 168                                 __METHOD__
 169                         );
 170                 } catch ( DBError $e ) {
 171                         $this->throwDBException( $e );
 172                 }
 173                 $wgMemc->set( $key, $count, self::CACHE_TTL_SHORT );
 174
 175                 return $count;
 176         }
 177
 178         /**
 179          * @see JobQueue::doBatchPush()
 180          * @param array $jobs
 181          * @param int $flags
 182          * @throws DBError|Exception
 183          * @return void
 184          */
 185         protected function doBatchPush( array $jobs, $flags ) {
 186                 $dbw = $this->getMasterDB();
 187
 188                 $that = $this;
 189                 $method = __METHOD__;
 190                 $dbw->onTransactionIdle(
 191                         function () use ( $dbw, $that, $jobs, $flags, $method ) {
 192                                 $that->doBatchPushInternal( $dbw, $jobs, $flags, $method );
 193                         }
 194                 );
 195         }
 196
 197         /**
 198          * This function should *not* be called outside of JobQueueDB
 199          *
 200          * @param IDatabase $dbw
 201          * @param array $jobs
 202          * @param int $flags
 203          * @param string $method
 204          * @throws DBError
 205          * @return void
 206          */
 207         public function doBatchPushInternal( IDatabase $dbw, array $jobs, $flags, $method ) {
 208                 if ( !count( $jobs ) ) {
 209                         return;
 210                 }
 211
 212                 $rowSet = array(); // (sha1 => job) map for jobs that are de-duplicated
 213                 $rowList = array(); // list of jobs for jobs that are not de-duplicated
 214                 foreach ( $jobs as $job ) {
 215                         $row = $this->insertFields( $job );
 216                         if ( $job->ignoreDuplicates() ) {
 217                                 $rowSet[$row['job_sha1']] = $row;
 218                         } else {
 219                                 $rowList[] = $row;
 220                         }
 221                 }
 222
 223                 if ( $flags & self::QOS_ATOMIC ) {
 224                         $dbw->begin( $method ); // wrap all the job additions in one transaction
 225                 }
 226                 try {
 227                         // Strip out any duplicate jobs that are already in the queue...
 228                         if ( count( $rowSet ) ) {
 229                                 $res = $dbw->select( 'job', 'job_sha1',
 230                                         array(
 231                                                 // No job_type condition since it's part of the job_sha1 hash
 232                                                 'job_sha1' => array_keys( $rowSet ),
 233                                                 'job_token' => '' // unclaimed
 234                                         ),
 235                                         $method
 236                                 );
 237                                 foreach ( $res as $row ) {
 238                                         wfDebug( "Job with hash '{$row->job_sha1}' is a duplicate.\n" );
 239                                         unset( $rowSet[$row->job_sha1] ); // already enqueued
 240                                 }
 241                         }
 242                         // Build the full list of job rows to insert
 243                         $rows = array_merge( $rowList, array_values( $rowSet ) );
 244                         // Insert the job rows in chunks to avoid slave lag...
 245                         foreach ( array_chunk( $rows, 50 ) as $rowBatch ) {
 246                                 $dbw->insert( 'job', $rowBatch, $method );
 247                         }
 248                         JobQueue::incrStats( 'job-insert', $this->type, count( $rows ) );
 249                         JobQueue::incrStats(
 250                                 'job-insert-duplicate',
 251                                 $this->type,
 252                                 count( $rowSet ) + count( $rowList ) - count( $rows )
 253                         );
 254                 } catch ( DBError $e ) {
 255                         if ( $flags & self::QOS_ATOMIC ) {
 256                                 $dbw->rollback( $method );
 257                         }
 258                         throw $e;
 259                 }
 260                 if ( $flags & self::QOS_ATOMIC ) {
 261                         $dbw->commit( $method );
 262                 }
 263
 264                 return;
 265         }
 266
 267         /**
 268          * @see JobQueue::doPop()
 269          * @return Job|bool
 270          */
 271         protected function doPop() {
 272                 $dbw = $this->getMasterDB();
 273                 try {
 274                         $dbw->commit( __METHOD__, 'flush' ); // flush existing transaction
 275                         $autoTrx = $dbw->getFlag( DBO_TRX ); // get current setting
 276                         $dbw->clearFlag( DBO_TRX ); // make each query its own transaction
 277                         $scopedReset = new ScopedCallback( function () use ( $dbw, $autoTrx ) {
 278                                 $dbw->setFlag( $autoTrx ? DBO_TRX : 0 ); // restore old setting
 279                         } );
 280
 281                         $uuid = wfRandomString( 32 ); // pop attempt
 282                         $job = false; // job popped off
 283                         do { // retry when our row is invalid or deleted as a duplicate
 284                                 // Try to reserve a row in the DB...
 285                                 if ( in_array( $this->order, array( 'fifo', 'timestamp' ) ) ) {
 286                                         $row = $this->claimOldest( $uuid );
 287                                 } else { // random first
 288                                         $rand = mt_rand( 0, self::MAX_JOB_RANDOM ); // encourage concurrent UPDATEs
 289                                         $gte = (bool)mt_rand( 0, 1 ); // find rows with rand before/after $rand
 290                                         $row = $this->claimRandom( $uuid, $rand, $gte );
 291                                 }
 292                                 // Check if we found a row to reserve...
 293                                 if ( !$row ) {
 294                                         break; // nothing to do
 295                                 }
 296                                 JobQueue::incrStats( 'job-pop', $this->type );
 297                                 // Get the job object from the row...
 298                                 $title = Title::makeTitle( $row->job_namespace, $row->job_title );
 299                                 $job = Job::factory( $row->job_cmd, $title,
 300                                         self::extractBlob( $row->job_params ), $row->job_id );
 301                                 $job->metadata['id'] = $row->job_id;
 302                                 $job->metadata['timestamp'] = $row->job_timestamp;
 303                                 break; // done
 304                         } while ( true );
 305
 306                         if ( !$job || mt_rand( 0, 9 ) == 0 ) {
 307                                 // Handled jobs that need to be recycled/deleted;
 308                                 // any recycled jobs will be picked up next attempt
 309                                 $this->recycleAndDeleteStaleJobs();
 310                         }
 311                 } catch ( DBError $e ) {
 312                         $this->throwDBException( $e );
 313                 }
 314
 315                 return $job;
 316         }
 317
 318         /**
 319          * Reserve a row with a single UPDATE without holding row locks over RTTs...
 320          *
 321          * @param string $uuid 32 char hex string
 322          * @param int $rand Random unsigned integer (31 bits)
 323          * @param bool $gte Search for job_random >= $random (otherwise job_random <= $random)
 324          * @return stdClass|bool Row|false
 325          */
 326         protected function claimRandom( $uuid, $rand, $gte ) {
 327                 $dbw = $this->getMasterDB();
 328                 // Check cache to see if the queue has <= OFFSET items
 329                 $tinyQueue = $this->cache->get( $this->getCacheKey( 'small' ) );
 330
 331                 $row = false; // the row acquired
 332                 $invertedDirection = false; // whether one job_random direction was already scanned
 333                 // This uses a replication safe method for acquiring jobs. One could use UPDATE+LIMIT
 334                 // instead, but that either uses ORDER BY (in which case it deadlocks in MySQL) or is
 335                 // not replication safe. Due to http://bugs.mysql.com/bug.php?id=6980, subqueries cannot
 336                 // be used here with MySQL.
 337                 do {
 338                         if ( $tinyQueue ) { // queue has <= MAX_OFFSET rows
 339                                 // For small queues, using OFFSET will overshoot and return no rows more often.
 340                                 // Instead, this uses job_random to pick a row (possibly checking both directions).
 341                                 $ineq = $gte ? '>=' : '<=';
 342                                 $dir = $gte ? 'ASC' : 'DESC';
 343                                 $row = $dbw->selectRow( 'job', self::selectFields(), // find a random job
 344                                         array(
 345                                                 'job_cmd' => $this->type,
 346                                                 'job_token' => '', // unclaimed
 347                                                 "job_random {$ineq} {$dbw->addQuotes( $rand )}" ),
 348                                         __METHOD__,
 349                                         array( 'ORDER BY' => "job_random {$dir}" )
 350                                 );
 351                                 if ( !$row && !$invertedDirection ) {
 352                                         $gte = !$gte;
 353                                         $invertedDirection = true;
 354                                         continue; // try the other direction
 355                                 }
 356                         } else { // table *may* have >= MAX_OFFSET rows
 357                                 // Bug 42614: "ORDER BY job_random" with a job_random inequality causes high CPU
 358                                 // in MySQL if there are many rows for some reason. This uses a small OFFSET
 359                                 // instead of job_random for reducing excess claim retries.
 360                                 $row = $dbw->selectRow( 'job', self::selectFields(), // find a random job
 361                                         array(
 362                                                 'job_cmd' => $this->type,
 363                                                 'job_token' => '', // unclaimed
 364                                         ),
 365                                         __METHOD__,
 366                                         array( 'OFFSET' => mt_rand( 0, self::MAX_OFFSET ) )
 367                                 );
 368                                 if ( !$row ) {
 369                                         $tinyQueue = true; // we know the queue must have <= MAX_OFFSET rows
 370                                         $this->cache->set( $this->getCacheKey( 'small' ), 1, 30 );
 371                                         continue; // use job_random
 372                                 }
 373                         }
 374
 375                         if ( $row ) { // claim the job
 376                                 $dbw->update( 'job', // update by PK
 377                                         array(
 378                                                 'job_token' => $uuid,
 379                                                 'job_token_timestamp' => $dbw->timestamp(),
 380                                                 'job_attempts = job_attempts+1' ),
 381                                         array( 'job_cmd' => $this->type, 'job_id' => $row->job_id, 'job_token' => '' ),
 382                                         __METHOD__
 383                                 );
 384                                 // This might get raced out by another runner when claiming the previously
 385                                 // selected row. The use of job_random should minimize this problem, however.
 386                                 if ( !$dbw->affectedRows() ) {
 387                                         $row = false; // raced out
 388                                 }
 389                         } else {
 390                                 break; // nothing to do
 391                         }
 392                 } while ( !$row );
 393
 394                 return $row;
 395         }
 396
 397         /**
 398          * Reserve a row with a single UPDATE without holding row locks over RTTs...
 399          *
 400          * @param string $uuid 32 char hex string
 401          * @return stdClass|bool Row|false
 402          */
 403         protected function claimOldest( $uuid ) {
 404                 $dbw = $this->getMasterDB();
 405
 406                 $row = false; // the row acquired
 407                 do {
 408                         if ( $dbw->getType() === 'mysql' ) {
 409                                 // Per http://bugs.mysql.com/bug.php?id=6980, we can't use subqueries on the
 410                                 // same table being changed in an UPDATE query in MySQL (gives Error: 1093).
 411                                 // Oracle and Postgre have no such limitation. However, MySQL offers an
 412                                 // alternative here by supporting ORDER BY + LIMIT for UPDATE queries.
 413                                 $dbw->query( "UPDATE {$dbw->tableName( 'job' )} " .
 414                                         "SET " .
 415                                                 "job_token = {$dbw->addQuotes( $uuid ) }, " .
 416                                                 "job_token_timestamp = {$dbw->addQuotes( $dbw->timestamp() )}, " .
 417                                                 "job_attempts = job_attempts+1 " .
 418                                         "WHERE ( " .
 419                                                 "job_cmd = {$dbw->addQuotes( $this->type )} " .
 420                                                 "AND job_token = {$dbw->addQuotes( '' )} " .
 421                                         ") ORDER BY job_id ASC LIMIT 1",
 422                                         __METHOD__
 423                                 );
 424                         } else {
 425                                 // Use a subquery to find the job, within an UPDATE to claim it.
 426                                 // This uses as much of the DB wrapper functions as possible.
 427                                 $dbw->update( 'job',
 428                                         array(
 429                                                 'job_token' => $uuid,
 430                                                 'job_token_timestamp' => $dbw->timestamp(),
 431                                                 'job_attempts = job_attempts+1' ),
 432                                         array( 'job_id = (' .
 433                                                 $dbw->selectSQLText( 'job', 'job_id',
 434                                                         array( 'job_cmd' => $this->type, 'job_token' => '' ),
 435                                                         __METHOD__,
 436                                                         array( 'ORDER BY' => 'job_id ASC', 'LIMIT' => 1 ) ) .
 437                                                 ')'
 438                                         ),
 439                                         __METHOD__
 440                                 );
 441                         }
 442                         // Fetch any row that we just reserved...
 443                         if ( $dbw->affectedRows() ) {
 444                                 $row = $dbw->selectRow( 'job', self::selectFields(),
 445                                         array( 'job_cmd' => $this->type, 'job_token' => $uuid ), __METHOD__
 446                                 );
 447                                 if ( !$row ) { // raced out by duplicate job removal
 448                                         wfDebug( "Row deleted as duplicate by another process.\n" );
 449                                 }
 450                         } else {
 451                                 break; // nothing to do
 452                         }
 453                 } while ( !$row );
 454
 455                 return $row;
 456         }
 457
 458         /**
 459          * @see JobQueue::doAck()
 460          * @param Job $job
 461          * @throws MWException
 462          * @return Job|bool
 463          */
 464         protected function doAck( Job $job ) {
 465                 if ( !isset( $job->metadata['id'] ) ) {
 466                         throw new MWException( "Job of type '{$job->getType()}' has no ID." );
 467                 }
 468
 469                 $dbw = $this->getMasterDB();
 470                 try {
 471                         $dbw->commit( __METHOD__, 'flush' ); // flush existing transaction
 472                         $autoTrx = $dbw->getFlag( DBO_TRX ); // get current setting
 473                         $dbw->clearFlag( DBO_TRX ); // make each query its own transaction
 474                         $scopedReset = new ScopedCallback( function () use ( $dbw, $autoTrx ) {
 475                                 $dbw->setFlag( $autoTrx ? DBO_TRX : 0 ); // restore old setting
 476                         } );
 477
 478                         // Delete a row with a single DELETE without holding row locks over RTTs...
 479                         $dbw->delete( 'job',
 480                                 array( 'job_cmd' => $this->type, 'job_id' => $job->metadata['id'] ), __METHOD__ );
 481
 482                         JobQueue::incrStats( 'job-ack', $this->type );
 483                 } catch ( DBError $e ) {
 484                         $this->throwDBException( $e );
 485                 }
 486
 487                 return true;
 488         }
 489
 490         /**
 491          * @see JobQueue::doDeduplicateRootJob()
 492          * @param IJobSpecification $job
 493          * @throws MWException
 494          * @return bool
 495          */
 496         protected function doDeduplicateRootJob( IJobSpecification $job ) {
 497                 $params = $job->getParams();
 498                 if ( !isset( $params['rootJobSignature'] ) ) {
 499                         throw new MWException( "Cannot register root job; missing 'rootJobSignature'." );
 500                 } elseif ( !isset( $params['rootJobTimestamp'] ) ) {
 501                         throw new MWException( "Cannot register root job; missing 'rootJobTimestamp'." );
 502                 }
 503                 $key = $this->getRootJobCacheKey( $params['rootJobSignature'] );
 504                 // Callers should call batchInsert() and then this function so that if the insert
 505                 // fails, the de-duplication registration will be aborted. Since the insert is
 506                 // deferred till "transaction idle", do the same here, so that the ordering is
 507                 // maintained. Having only the de-duplication registration succeed would cause
 508                 // jobs to become no-ops without any actual jobs that made them redundant.
 509                 $dbw = $this->getMasterDB();
 510                 $cache = $this->dupCache;
 511                 $dbw->onTransactionIdle( function () use ( $cache, $params, $key, $dbw ) {
 512                         $timestamp = $cache->get( $key ); // current last timestamp of this job
 513                         if ( $timestamp && $timestamp >= $params['rootJobTimestamp'] ) {
 514                                 return true; // a newer version of this root job was enqueued
 515                         }
 516
 517                         // Update the timestamp of the last root job started at the location...
 518                         return $cache->set( $key, $params['rootJobTimestamp'], JobQueueDB::ROOTJOB_TTL );
 519                 } );
 520
 521                 return true;
 522         }
 523
 524         /**
 525          * @see JobQueue::doDelete()
 526          * @return bool
 527          */
 528         protected function doDelete() {
 529                 $dbw = $this->getMasterDB();
 530                 try {
 531                         $dbw->delete( 'job', array( 'job_cmd' => $this->type ) );
 532                 } catch ( DBError $e ) {
 533                         $this->throwDBException( $e );
 534                 }
 535
 536                 return true;
 537         }
 538
 539         /**
 540          * @see JobQueue::doWaitForBackups()
 541          * @return void
 542          */
 543         protected function doWaitForBackups() {
 544                 wfWaitForSlaves( false, $this->wiki, $this->cluster ?: false );
 545         }
 546
 547         /**
 548          * @return void
 549          */
 550         protected function doFlushCaches() {
 551                 foreach ( array( 'size', 'acquiredcount' ) as $type ) {
 552                         $this->cache->delete( $this->getCacheKey( $type ) );
 553                 }
 554         }
 555
 556         /**
 557          * @see JobQueue::getAllQueuedJobs()
 558          * @return Iterator
 559          */
 560         public function getAllQueuedJobs() {
 561                 return $this->getJobIterator( array( 'job_cmd' => $this->getType(), 'job_token' => '' ) );
 562         }
 563
 564         /**
 565          * @see JobQueue::getAllAcquiredJobs()
 566          * @return Iterator
 567          */
 568         public function getAllAcquiredJobs() {
 569                 return $this->getJobIterator( array( 'job_cmd' => $this->getType(), "job_token > ''" ) );
 570         }
 571
 572         /**
 573          * @param array $conds Query conditions
 574          * @return Iterator
 575          */
 576         protected function getJobIterator( array $conds ) {
 577                 $dbr = $this->getSlaveDB();
 578                 try {
 579                         return new MappedIterator(
 580                                 $dbr->select( 'job', self::selectFields(), $conds ),
 581                                 function ( $row ) {
 582                                         $job = Job::factory(
 583                                                 $row->job_cmd,
 584                                                 Title::makeTitle( $row->job_namespace, $row->job_title ),
 585                                                 strlen( $row->job_params ) ? unserialize( $row->job_params ) : array()
 586                                         );
 587                                         $job->metadata['id'] = $row->job_id;
 588                                         $job->metadata['timestamp'] = $row->job_timestamp;
 589
 590                                         return $job;
 591                                 }
 592                         );
 593                 } catch ( DBError $e ) {
 594                         $this->throwDBException( $e );
 595                 }
 596         }
 597
 598         public function getCoalesceLocationInternal() {
 599                 return $this->cluster
 600                         ? "DBCluster:{$this->cluster}:{$this->wiki}"
 601                         : "LBFactory:{$this->wiki}";
 602         }
 603
 604         protected function doGetSiblingQueuesWithJobs( array $types ) {
 605                 $dbr = $this->getSlaveDB();
 606                 // @note: this does not check whether the jobs are claimed or not.
 607                 // This is useful so JobQueueGroup::pop() also sees queues that only
 608                 // have stale jobs. This lets recycleAndDeleteStaleJobs() re-enqueue
 609                 // failed jobs so that they can be popped again for that edge case.
 610                 $res = $dbr->select( 'job', 'DISTINCT job_cmd',
 611                         array( 'job_cmd' => $types ), __METHOD__ );
 612
 613                 $types = array();
 614                 foreach ( $res as $row ) {
 615                         $types[] = $row->job_cmd;
 616                 }
 617
 618                 return $types;
 619         }
 620
 621         protected function doGetSiblingQueueSizes( array $types ) {
 622                 $dbr = $this->getSlaveDB();
 623                 $res = $dbr->select( 'job', array( 'job_cmd', 'COUNT(*) AS count' ),
 624                         array( 'job_cmd' => $types ), __METHOD__, array( 'GROUP BY' => 'job_cmd' ) );
 625
 626                 $sizes = array();
 627                 foreach ( $res as $row ) {
 628                         $sizes[$row->job_cmd] = (int)$row->count;
 629                 }
 630
 631                 return $sizes;
 632         }
 633
 634         /**
 635          * Recycle or destroy any jobs that have been claimed for too long
 636          *
 637          * @return int Number of jobs recycled/deleted
 638          */
 639         public function recycleAndDeleteStaleJobs() {
 640                 $now = time();
 641                 $count = 0; // affected rows
 642                 $dbw = $this->getMasterDB();
 643
 644                 try {
 645                         if ( !$dbw->lock( "jobqueue-recycle-{$this->type}", __METHOD__, 1 ) ) {
 646                                 return $count; // already in progress
 647                         }
 648
 649                         // Remove claims on jobs acquired for too long if enabled...
 650                         if ( $this->claimTTL > 0 ) {
 651                                 $claimCutoff = $dbw->timestamp( $now - $this->claimTTL );
 652                                 // Get the IDs of jobs that have be claimed but not finished after too long.
 653                                 // These jobs can be recycled into the queue by expiring the claim. Selecting
 654                                 // the IDs first means that the UPDATE can be done by primary key (less deadlocks).
 655                                 $res = $dbw->select( 'job', 'job_id',
 656                                         array(
 657                                                 'job_cmd' => $this->type,
 658                                                 "job_token != {$dbw->addQuotes( '' )}", // was acquired
 659                                                 "job_token_timestamp < {$dbw->addQuotes( $claimCutoff )}", // stale
 660                                                 "job_attempts < {$dbw->addQuotes( $this->maxTries )}" ), // retries left
 661                                         __METHOD__
 662                                 );
 663                                 $ids = array_map(
 664                                         function ( $o ) {
 665                                                 return $o->job_id;
 666                                         }, iterator_to_array( $res )
 667                                 );
 668                                 if ( count( $ids ) ) {
 669                                         // Reset job_token for these jobs so that other runners will pick them up.
 670                                         // Set the timestamp to the current time, as it is useful to now that the job
 671                                         // was already tried before (the timestamp becomes the "released" time).
 672                                         $dbw->update( 'job',
 673                                                 array(
 674                                                         'job_token' => '',
 675                                                         'job_token_timestamp' => $dbw->timestamp( $now ) ), // time of release
 676                                                 array(
 677                                                         'job_id' => $ids ),
 678                                                 __METHOD__
 679                                         );
 680                                         $affected = $dbw->affectedRows();
 681                                         $count += $affected;
 682                                         JobQueue::incrStats( 'job-recycle', $this->type, $affected );
 683                                         $this->aggr->notifyQueueNonEmpty( $this->wiki, $this->type );
 684                                 }
 685                         }
 686
 687                         // Just destroy any stale jobs...
 688                         $pruneCutoff = $dbw->timestamp( $now - self::MAX_AGE_PRUNE );
 689                         $conds = array(
 690                                 'job_cmd' => $this->type,
 691                                 "job_token != {$dbw->addQuotes( '' )}", // was acquired
 692                                 "job_token_timestamp < {$dbw->addQuotes( $pruneCutoff )}" // stale
 693                         );
 694                         if ( $this->claimTTL > 0 ) { // only prune jobs attempted too many times...
 695                                 $conds[] = "job_attempts >= {$dbw->addQuotes( $this->maxTries )}";
 696                         }
 697                         // Get the IDs of jobs that are considered stale and should be removed. Selecting
 698                         // the IDs first means that the UPDATE can be done by primary key (less deadlocks).
 699                         $res = $dbw->select( 'job', 'job_id', $conds, __METHOD__ );
 700                         $ids = array_map(
 701                                 function ( $o ) {
 702                                         return $o->job_id;
 703                                 }, iterator_to_array( $res )
 704                         );
 705                         if ( count( $ids ) ) {
 706                                 $dbw->delete( 'job', array( 'job_id' => $ids ), __METHOD__ );
 707                                 $affected = $dbw->affectedRows();
 708                                 $count += $affected;
 709                                 JobQueue::incrStats( 'job-abandon', $this->type, $affected );
 710                         }
 711
 712                         $dbw->unlock( "jobqueue-recycle-{$this->type}", __METHOD__ );
 713                 } catch ( DBError $e ) {
 714                         $this->throwDBException( $e );
 715                 }
 716
 717                 return $count;
 718         }
 719
 720         /**
 721          * @param IJobSpecification $job
 722          * @return array
 723          */
 724         protected function insertFields( IJobSpecification $job ) {
 725                 $dbw = $this->getMasterDB();
 726
 727                 return array(
 728                         // Fields that describe the nature of the job
 729                         'job_cmd' => $job->getType(),
 730                         'job_namespace' => $job->getTitle()->getNamespace(),
 731                         'job_title' => $job->getTitle()->getDBkey(),
 732                         'job_params' => self::makeBlob( $job->getParams() ),
 733                         // Additional job metadata
 734                         'job_id' => $dbw->nextSequenceValue( 'job_job_id_seq' ),
 735                         'job_timestamp' => $dbw->timestamp(),
 736                         'job_sha1' => wfBaseConvert(
 737                                 sha1( serialize( $job->getDeduplicationInfo() ) ),
 738                                 16, 36, 31
 739                         ),
 740                         'job_random' => mt_rand( 0, self::MAX_JOB_RANDOM )
 741                 );
 742         }
 743
 744         /**
 745          * @throws JobQueueConnectionError
 746          * @return DBConnRef
 747          */
 748         protected function getSlaveDB() {
 749                 try {
 750                         return $this->getDB( DB_SLAVE );
 751                 } catch ( DBConnectionError $e ) {
 752                         throw new JobQueueConnectionError( "DBConnectionError:" . $e->getMessage() );
 753                 }
 754         }
 755
 756         /**
 757          * @throws JobQueueConnectionError
 758          * @return DBConnRef
 759          */
 760         protected function getMasterDB() {
 761                 try {
 762                         return $this->getDB( DB_MASTER );
 763                 } catch ( DBConnectionError $e ) {
 764                         throw new JobQueueConnectionError( "DBConnectionError:" . $e->getMessage() );
 765                 }
 766         }
 767
 768         /**
 769          * @param int $index (DB_SLAVE/DB_MASTER)
 770          * @return DBConnRef
 771          */
 772         protected function getDB( $index ) {
 773                 $lb = ( $this->cluster !== false )
 774                         ? wfGetLBFactory()->getExternalLB( $this->cluster, $this->wiki )
 775                         : wfGetLB( $this->wiki );
 776
 777                 return $lb->getConnectionRef( $index, array(), $this->wiki );
 778         }
 779
 780         /**
 781          * @param string $property
 782          * @return string
 783          */
 784         private function getCacheKey( $property ) {
 785                 list( $db, $prefix ) = wfSplitWikiID( $this->wiki );
 786                 $cluster = is_string( $this->cluster ) ? $this->cluster : 'main';
 787
 788                 return wfForeignMemcKey( $db, $prefix, 'jobqueue', $cluster, $this->type, $property );
 789         }
 790
 791         /**
 792          * @param array|bool $params
 793          * @return string
 794          */
 795         protected static function makeBlob( $params ) {
 796                 if ( $params !== false ) {
 797                         return serialize( $params );
 798                 } else {
 799                         return '';
 800                 }
 801         }
 802
 803         /**
 804          * @param string $blob
 805          * @return bool|mixed
 806          */
 807         protected static function extractBlob( $blob ) {
 808                 if ( (string)$blob !== '' ) {
 809                         return unserialize( $blob );
 810                 } else {
 811                         return false;
 812                 }
 813         }
 814
 815         /**
 816          * @param DBError $e
 817          * @throws JobQueueError
 818          */
 819         protected function throwDBException( DBError $e ) {
 820                 throw new JobQueueError( get_class( $e ) . ": " . $e->getMessage() );
 821         }
 822
 823         /**
 824          * Return the list of job fields that should be selected.
 825          * @since 1.23
 826          * @return array
 827          */
 828         public static function selectFields() {
 829                 return array(
 830                         'job_id',
 831                         'job_cmd',
 832                         'job_namespace',
 833                         'job_title',
 834                         'job_timestamp',
 835                         'job_params',
 836                         'job_random',
 837                         'job_attempts',
 838                         'job_token',
 839                         'job_token_timestamp',
 840                         'job_sha1',
 841                 );
 842         }
 843 }