Page MenuHomeWickedGov Phorge
Files F5951273

JobQueueMemory.php
No OneTemporary
Actions

Size
4 KB
Referenced Files
None
Subscribers
None

JobQueueMemory.php
View Options

<?php
/**
* @license GPL-2.0-or-later
* @file
*/
namespace MediaWiki\JobQueue;
use ArrayIterator;
use MappedIterator;
use Wikimedia\ObjectCache\HashBagOStuff;
use Wikimedia\ObjectCache\WANObjectCache;
/**
* PHP memory-backed job queue storage, for testing.
*
* JobQueueGroup does not remember every queue instance, so statically track it here.
*
* @since 1.27
* @ingroup JobQueue
*/
class JobQueueMemory extends JobQueue {
/** @var array[] */
protected static $data = [];
public function __construct( array $params ) {
$params['wanCache'] = new WANObjectCache( [ 'cache' => new HashBagOStuff() ] );
parent::__construct( $params );
}
/**
* @see JobQueue::doBatchPush
*
* @param IJobSpecification[] $jobs
* @param int $flags
*/
protected function doBatchPush( array $jobs, $flags ) {
$unclaimed =& $this->getQueueData( 'unclaimed', [] );
foreach ( $jobs as $job ) {
if ( $job->ignoreDuplicates() ) {
$sha1 = sha1( serialize( $job->getDeduplicationInfo() ) );
if ( !isset( $unclaimed[$sha1] ) ) {
$unclaimed[$sha1] = $job;
}
} else {
$unclaimed[] = $job;
}
}
}
/**
* @see JobQueue::supportedOrders
*
* @return string[]
*/
protected function supportedOrders() {
return [ 'random', 'timestamp', 'fifo' ];
}
/**
* @see JobQueue::optimalOrder
*
* @return string
*/
protected function optimalOrder() {
return 'fifo';
}
/**
* @see JobQueue::doIsEmpty
*
* @return bool
*/
protected function doIsEmpty() {
return ( $this->doGetSize() == 0 );
}
/**
* @see JobQueue::doGetSize
*
* @return int
*/
protected function doGetSize() {
$unclaimed = $this->getQueueData( 'unclaimed' );
return $unclaimed ? count( $unclaimed ) : 0;
}
/**
* @see JobQueue::doGetAcquiredCount
*
* @return int
*/
protected function doGetAcquiredCount() {
$claimed = $this->getQueueData( 'claimed' );
return $claimed ? count( $claimed ) : 0;
}
/**
* @see JobQueue::doPop
*
* @return RunnableJob|false
*/
protected function doPop() {
if ( $this->doGetSize() == 0 ) {
return false;
}
$unclaimed =& $this->getQueueData( 'unclaimed' );
$claimed =& $this->getQueueData( 'claimed', [] );
if ( $this->order === 'random' ) {
$key = array_rand( $unclaimed );
} else {
$key = array_key_first( $unclaimed );
}
$spec = $unclaimed[$key];
unset( $unclaimed[$key] );
$claimed[] = $spec;
$job = $this->jobFromSpecInternal( $spec );
$job->setMetadata( 'claimId', array_key_last( $claimed ) );
return $job;
}
/**
* @see JobQueue::doAck
*
* @param RunnableJob $job
*/
protected function doAck( RunnableJob $job ) {
if ( $this->getAcquiredCount() == 0 ) {
return;
}
$claimed =& $this->getQueueData( 'claimed' );
unset( $claimed[$job->getMetadata( 'claimId' )] );
}
/**
* @inheritDoc
*/
protected function doDelete() {
if ( isset( self::$data[$this->type][$this->domain] ) ) {
unset( self::$data[$this->type][$this->domain] );
if ( !self::$data[$this->type] ) {
unset( self::$data[$this->type] );
}
}
}
/**
* @see JobQueue::getAllQueuedJobs
*
* @return \Iterator<RunnableJob> of Job objects.
*/
public function getAllQueuedJobs() {
$unclaimed = $this->getQueueData( 'unclaimed' );
if ( !$unclaimed ) {
return new ArrayIterator( [] );
}
return new MappedIterator(
$unclaimed,
function ( $value ) {
return $this->jobFromSpecInternal( $value );
}
);
}
/**
* @see JobQueue::getAllAcquiredJobs
*
* @return \Iterator<RunnableJob> of Job objects.
*/
public function getAllAcquiredJobs() {
$claimed = $this->getQueueData( 'claimed' );
if ( !$claimed ) {
return new ArrayIterator( [] );
}
return new MappedIterator(
$claimed,
function ( $value ) {
return $this->jobFromSpecInternal( $value );
}
);
}
/**
* @param IJobSpecification $spec
* @return RunnableJob
*/
public function jobFromSpecInternal( IJobSpecification $spec ) {
return $this->factoryJob( $spec->getType(), $spec->getParams() );
}
/**
* @param string $field
* @param mixed|null $init
*
* @return mixed
*/
private function &getQueueData( $field, $init = null ) {
if ( !isset( self::$data[$this->type][$this->domain][$field] ) ) {
if ( $init !== null ) {
self::$data[$this->type][$this->domain][$field] = $init;
} else {
return $init;
}
}
return self::$data[$this->type][$this->domain][$field];
}
}
/** @deprecated class alias since 1.44 */
class_alias( JobQueueMemory::class, 'JobQueueMemory' );

File Metadata

Mime Type
text/x-php
Expires
Oct 3 2026, 00:41 (5 w, 17 h ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
46/41/b4c8035b208c97abb67365be4739
Default Alt Text
JobQueueMemory.php (4 KB)

Event Timeline