MediaWiki  1.29.1
Go to the documentation of this file.
1 <?php
23 use Psr\Log\LoggerInterface;
36  protected $redisPool;
38  protected $logger;
40  protected $servers;
51  public function __construct( array $params ) {
52  parent::__construct( $params );
53  $this->servers = isset( $params['redisServers'] )
54  ? $params['redisServers']
55  : [ $params['redisServer'] ]; // b/c
56  $params['redisConfig']['serializer'] = 'none';
57  $this->redisPool = RedisConnectionPool::singleton( $params['redisConfig'] );
58  $this->logger = \MediaWiki\Logger\LoggerFactory::getInstance( 'redis' );
59  }
61  protected function doNotifyQueueEmpty( $wiki, $type ) {
62  return true; // managed by the service
63  }
65  protected function doNotifyQueueNonEmpty( $wiki, $type ) {
66  return true; // managed by the service
67  }
69  protected function doGetAllReadyWikiQueues() {
70  $conn = $this->getConnection();
71  if ( !$conn ) {
72  return [];
73  }
74  try {
75  $map = $conn->hGetAll( $this->getReadyQueueKey() );
77  if ( is_array( $map ) && isset( $map['_epoch'] ) ) {
78  unset( $map['_epoch'] ); // ignore
79  $pendingDBs = []; // (type => list of wikis)
80  foreach ( $map as $key => $time ) {
81  list( $type, $wiki ) = $this->decodeQueueName( $key );
82  $pendingDBs[$type][] = $wiki;
83  }
84  } else {
85  throw new UnexpectedValueException(
86  "No queue listing found; make sure redisJobChronService is running."
87  );
88  }
90  return $pendingDBs;
91  } catch ( RedisException $e ) {
92  $this->redisPool->handleError( $conn, $e );
94  return [];
95  }
96  }
98  protected function doPurge() {
99  return true; // fully and only refreshed by the service
100  }
108  protected function getConnection() {
109  $conn = false;
110  foreach ( $this->servers as $server ) {
111  $conn = $this->redisPool->getConnection( $server, $this->logger );
112  if ( $conn ) {
113  break;
114  }
115  }
117  return $conn;
118  }
123  private function getReadyQueueKey() {
124  return "jobqueue:aggregator:h-ready-queues:v2"; // global
125  }
131  private function decodeQueueName( $name ) {
132  list( $type, $wiki ) = explode( '/', $name, 2 );
134  return [ rawurldecode( $type ), rawurldecode( $wiki ) ];
135  }
136 }
static singleton(array $options)
Definition: RedisConnectionPool.php:148
doNotifyQueueEmpty( $wiki, $type)
Definition: JobQueueAggregatorRedis.php:61
Definition: JobQueueAggregatorRedis.php:69
storage can be distributed across multiple servers
Definition: memcached.txt:33
static getInstance( $channel)
Get a named logger instance from the currently configured logger factory.
Definition: LoggerFactory.php:93
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
Definition: MIT-LICENSE.txt:10
Definition: styleTest.css.php:40
Definition: JobQueueAggregatorRedis.php:98
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:304
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled allows for interception of redirect as a string mapping parameter names to values & $type
Definition: hooks.txt:2536
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
Class to handle tracking information about all queues.
Definition: JobQueueAggregator.php:30
array $servers
List of Redis server addresses.
Definition: JobQueueAggregatorRedis.php:40
decodeQueueName( $name)
Definition: JobQueueAggregatorRedis.php:131
see documentation in includes Linker php for Linker::makeImageLink & $time
Definition: hooks.txt:1769
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition: deferred.txt:11
LoggerInterface $logger
Definition: JobQueueAggregatorRedis.php:38
Class to handle tracking information about all queues using PhpRedis.
Definition: JobQueueAggregatorRedis.php:34
Helper class to manage Redis connections.
Definition: RedisConnectionPool.php:41
RedisConnectionPool $redisPool
Definition: JobQueueAggregatorRedis.php:36
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Definition: hooks.txt:2122
__construct(array $params)
Definition: JobQueueAggregatorRedis.php:51
Get a connection to the server that handles all sub-queues for this queue.
Definition: JobQueueAggregatorRedis.php:108
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
doNotifyQueueNonEmpty( $wiki, $type)
Definition: JobQueueAggregatorRedis.php:65
the array() calling protocol came about after MediaWiki 1.4rc1.
Definition: JobQueueAggregatorRedis.php:123