MediaWiki  master
JobQueueRedis.php
Go to the documentation of this file.
1 <?php
25 
68 class JobQueueRedis extends JobQueue {
70  protected $redisPool;
72  protected $logger;
73 
75  protected $server;
77  protected $compression;
78 
79  const MAX_PUSH_SIZE = 25; // avoid tying up the server
80 
94  public function __construct( array $params ) {
95  parent::__construct( $params );
96  $params['redisConfig']['serializer'] = 'none'; // make it easy to use Lua
97  $this->server = $params['redisServer'];
98  $this->compression = $params['compression'] ?? 'none';
99  $this->redisPool = RedisConnectionPool::singleton( $params['redisConfig'] );
100  if ( empty( $params['daemonized'] ) ) {
101  throw new InvalidArgumentException(
102  "Non-daemonized mode is no longer supported. Please install the " .
103  "mediawiki/services/jobrunner service and update \$wgJobTypeConf as needed." );
104  }
105  $this->logger = LoggerFactory::getInstance( 'redis' );
106  }
107 
108  protected function supportedOrders() {
109  return [ 'timestamp', 'fifo' ];
110  }
111 
112  protected function optimalOrder() {
113  return 'fifo';
114  }
115 
116  protected function supportsDelayedJobs() {
117  return true;
118  }
119 
125  protected function doIsEmpty() {
126  return $this->doGetSize() == 0;
127  }
128 
134  protected function doGetSize() {
135  $conn = $this->getConnection();
136  try {
137  return $conn->lSize( $this->getQueueKey( 'l-unclaimed' ) );
138  } catch ( RedisException $e ) {
139  throw $this->handleErrorAndMakeException( $conn, $e );
140  }
141  }
142 
148  protected function doGetAcquiredCount() {
149  $conn = $this->getConnection();
150  try {
151  $conn->multi( Redis::PIPELINE );
152  $conn->zSize( $this->getQueueKey( 'z-claimed' ) );
153  $conn->zSize( $this->getQueueKey( 'z-abandoned' ) );
154 
155  return array_sum( $conn->exec() );
156  } catch ( RedisException $e ) {
157  throw $this->handleErrorAndMakeException( $conn, $e );
158  }
159  }
160 
166  protected function doGetDelayedCount() {
167  $conn = $this->getConnection();
168  try {
169  return $conn->zSize( $this->getQueueKey( 'z-delayed' ) );
170  } catch ( RedisException $e ) {
171  throw $this->handleErrorAndMakeException( $conn, $e );
172  }
173  }
174 
180  protected function doGetAbandonedCount() {
181  $conn = $this->getConnection();
182  try {
183  return $conn->zSize( $this->getQueueKey( 'z-abandoned' ) );
184  } catch ( RedisException $e ) {
185  throw $this->handleErrorAndMakeException( $conn, $e );
186  }
187  }
188 
196  protected function doBatchPush( array $jobs, $flags ) {
197  // Convert the jobs into field maps (de-duplicated against each other)
198  $items = []; // (job ID => job fields map)
199  foreach ( $jobs as $job ) {
200  $item = $this->getNewJobFields( $job );
201  if ( strlen( $item['sha1'] ) ) { // hash identifier => de-duplicate
202  $items[$item['sha1']] = $item;
203  } else {
204  $items[$item['uuid']] = $item;
205  }
206  }
207 
208  if ( $items === [] ) {
209  return; // nothing to do
210  }
211 
212  $conn = $this->getConnection();
213  try {
214  // Actually push the non-duplicate jobs into the queue...
215  if ( $flags & self::QOS_ATOMIC ) {
216  $batches = [ $items ]; // all or nothing
217  } else {
218  $batches = array_chunk( $items, self::MAX_PUSH_SIZE );
219  }
220  $failed = 0;
221  $pushed = 0;
222  foreach ( $batches as $itemBatch ) {
223  $added = $this->pushBlobs( $conn, $itemBatch );
224  if ( is_int( $added ) ) {
225  $pushed += $added;
226  } else {
227  $failed += count( $itemBatch );
228  }
229  }
230  $this->incrStats( 'inserts', $this->type, count( $items ) );
231  $this->incrStats( 'inserts_actual', $this->type, $pushed );
232  $this->incrStats( 'dupe_inserts', $this->type,
233  count( $items ) - $failed - $pushed );
234  if ( $failed > 0 ) {
235  $err = "Could not insert {$failed} {$this->type} job(s).";
236  wfDebugLog( 'JobQueueRedis', $err );
237  throw new RedisException( $err );
238  }
239  } catch ( RedisException $e ) {
240  throw $this->handleErrorAndMakeException( $conn, $e );
241  }
242  }
243 
250  protected function pushBlobs( RedisConnRef $conn, array $items ) {
251  $args = [ $this->encodeQueueName() ];
252  // Next args come in 4s ([id, sha1, rtime, blob [, id, sha1, rtime, blob ... ] ] )
253  foreach ( $items as $item ) {
254  $args[] = (string)$item['uuid'];
255  $args[] = (string)$item['sha1'];
256  $args[] = (string)$item['rtimestamp'];
257  $args[] = (string)$this->serialize( $item );
258  }
259  static $script =
261 <<<LUA
262  local kUnclaimed, kSha1ById, kIdBySha1, kDelayed, kData, kQwJobs = unpack(KEYS)
263  -- First argument is the queue ID
264  local queueId = ARGV[1]
265  -- Next arguments all come in 4s (one per job)
266  local variadicArgCount = #ARGV - 1
267  if variadicArgCount % 4 ~= 0 then
268  return redis.error_reply('Unmatched arguments')
269  end
270  -- Insert each job into this queue as needed
271  local pushed = 0
272  for i = 2,#ARGV,4 do
273  local id,sha1,rtimestamp,blob = ARGV[i],ARGV[i+1],ARGV[i+2],ARGV[i+3]
274  if sha1 == '' or redis.call('hExists',kIdBySha1,sha1) == 0 then
275  if 1*rtimestamp > 0 then
276  -- Insert into delayed queue (release time as score)
277  redis.call('zAdd',kDelayed,rtimestamp,id)
278  else
279  -- Insert into unclaimed queue
280  redis.call('lPush',kUnclaimed,id)
281  end
282  if sha1 ~= '' then
283  redis.call('hSet',kSha1ById,id,sha1)
284  redis.call('hSet',kIdBySha1,sha1,id)
285  end
286  redis.call('hSet',kData,id,blob)
287  pushed = pushed + 1
288  end
289  end
290  -- Mark this queue as having jobs
291  redis.call('sAdd',kQwJobs,queueId)
292  return pushed
293 LUA;
294  return $conn->luaEval( $script,
295  array_merge(
296  [
297  $this->getQueueKey( 'l-unclaimed' ), # KEYS[1]
298  $this->getQueueKey( 'h-sha1ById' ), # KEYS[2]
299  $this->getQueueKey( 'h-idBySha1' ), # KEYS[3]
300  $this->getQueueKey( 'z-delayed' ), # KEYS[4]
301  $this->getQueueKey( 'h-data' ), # KEYS[5]
302  $this->getGlobalKey( 's-queuesWithJobs' ), # KEYS[6]
303  ],
304  $args
305  ),
306  6 # number of first argument(s) that are keys
307  );
308  }
309 
315  protected function doPop() {
316  $job = false;
317 
318  $conn = $this->getConnection();
319  try {
320  do {
321  $blob = $this->popAndAcquireBlob( $conn );
322  if ( !is_string( $blob ) ) {
323  break; // no jobs; nothing to do
324  }
325 
326  $this->incrStats( 'pops', $this->type );
327  $item = $this->unserialize( $blob );
328  if ( $item === false ) {
329  wfDebugLog( 'JobQueueRedis', "Could not unserialize {$this->type} job." );
330  continue;
331  }
332 
333  // If $item is invalid, the runner loop recyling will cleanup as needed
334  $job = $this->getJobFromFields( $item ); // may be false
335  } while ( !$job ); // job may be false if invalid
336  } catch ( RedisException $e ) {
337  throw $this->handleErrorAndMakeException( $conn, $e );
338  }
339 
340  return $job;
341  }
342 
348  protected function popAndAcquireBlob( RedisConnRef $conn ) {
349  static $script =
351 <<<LUA
352  local kUnclaimed, kSha1ById, kIdBySha1, kClaimed, kAttempts, kData = unpack(KEYS)
353  local rTime = unpack(ARGV)
354  -- Pop an item off the queue
355  local id = redis.call('rPop',kUnclaimed)
356  if not id then
357  return false
358  end
359  -- Allow new duplicates of this job
360  local sha1 = redis.call('hGet',kSha1ById,id)
361  if sha1 then redis.call('hDel',kIdBySha1,sha1) end
362  redis.call('hDel',kSha1ById,id)
363  -- Mark the jobs as claimed and return it
364  redis.call('zAdd',kClaimed,rTime,id)
365  redis.call('hIncrBy',kAttempts,id,1)
366  return redis.call('hGet',kData,id)
367 LUA;
368  return $conn->luaEval( $script,
369  [
370  $this->getQueueKey( 'l-unclaimed' ), # KEYS[1]
371  $this->getQueueKey( 'h-sha1ById' ), # KEYS[2]
372  $this->getQueueKey( 'h-idBySha1' ), # KEYS[3]
373  $this->getQueueKey( 'z-claimed' ), # KEYS[4]
374  $this->getQueueKey( 'h-attempts' ), # KEYS[5]
375  $this->getQueueKey( 'h-data' ), # KEYS[6]
376  time(), # ARGV[1] (injected to be replication-safe)
377  ],
378  6 # number of first argument(s) that are keys
379  );
380  }
381 
389  protected function doAck( RunnableJob $job ) {
390  $uuid = $job->getMetadata( 'uuid' );
391  if ( $uuid === null ) {
392  throw new UnexpectedValueException( "Job of type '{$job->getType()}' has no UUID." );
393  }
394 
395  $conn = $this->getConnection();
396  try {
397  static $script =
399 <<<LUA
400  local kClaimed, kAttempts, kData = unpack(KEYS)
401  local id = unpack(ARGV)
402  -- Unmark the job as claimed
403  local removed = redis.call('zRem',kClaimed,id)
404  -- Check if the job was recycled
405  if removed == 0 then
406  return 0
407  end
408  -- Delete the retry data
409  redis.call('hDel',kAttempts,id)
410  -- Delete the job data itself
411  return redis.call('hDel',kData,id)
412 LUA;
413  $res = $conn->luaEval( $script,
414  [
415  $this->getQueueKey( 'z-claimed' ), # KEYS[1]
416  $this->getQueueKey( 'h-attempts' ), # KEYS[2]
417  $this->getQueueKey( 'h-data' ), # KEYS[3]
418  $uuid # ARGV[1]
419  ],
420  3 # number of first argument(s) that are keys
421  );
422 
423  if ( !$res ) {
424  wfDebugLog( 'JobQueueRedis', "Could not acknowledge {$this->type} job $uuid." );
425 
426  return false;
427  }
428 
429  $this->incrStats( 'acks', $this->type );
430  } catch ( RedisException $e ) {
431  throw $this->handleErrorAndMakeException( $conn, $e );
432  }
433 
434  return true;
435  }
436 
445  if ( !$job->hasRootJobParams() ) {
446  throw new LogicException( "Cannot register root job; missing parameters." );
447  }
448  $params = $job->getRootJobParams();
449 
450  $key = $this->getRootJobCacheKey( $params['rootJobSignature'] );
451 
452  $conn = $this->getConnection();
453  try {
454  $timestamp = $conn->get( $key ); // last known timestamp of such a root job
455  if ( $timestamp && $timestamp >= $params['rootJobTimestamp'] ) {
456  return true; // a newer version of this root job was enqueued
457  }
458 
459  // Update the timestamp of the last root job started at the location...
460  return $conn->set( $key, $params['rootJobTimestamp'], self::ROOTJOB_TTL ); // 2 weeks
461  } catch ( RedisException $e ) {
462  throw $this->handleErrorAndMakeException( $conn, $e );
463  }
464  }
465 
473  if ( !$job->hasRootJobParams() ) {
474  return false; // job has no de-deplication info
475  }
476  $params = $job->getRootJobParams();
477 
478  $conn = $this->getConnection();
479  try {
480  // Get the last time this root job was enqueued
481  $timestamp = $conn->get( $this->getRootJobCacheKey( $params['rootJobSignature'] ) );
482  } catch ( RedisException $e ) {
483  throw $this->handleErrorAndMakeException( $conn, $e );
484  }
485 
486  // Check if a new root job was started at the location after this one's...
487  return ( $timestamp && $timestamp > $params['rootJobTimestamp'] );
488  }
489 
495  protected function doDelete() {
496  static $props = [ 'l-unclaimed', 'z-claimed', 'z-abandoned',
497  'z-delayed', 'h-idBySha1', 'h-sha1ById', 'h-attempts', 'h-data' ];
498 
499  $conn = $this->getConnection();
500  try {
501  $keys = [];
502  foreach ( $props as $prop ) {
503  $keys[] = $this->getQueueKey( $prop );
504  }
505 
506  $ok = ( $conn->delete( $keys ) !== false );
507  $conn->sRem( $this->getGlobalKey( 's-queuesWithJobs' ), $this->encodeQueueName() );
508 
509  return $ok;
510  } catch ( RedisException $e ) {
511  throw $this->handleErrorAndMakeException( $conn, $e );
512  }
513  }
514 
520  public function getAllQueuedJobs() {
521  $conn = $this->getConnection();
522  try {
523  $uids = $conn->lRange( $this->getQueueKey( 'l-unclaimed' ), 0, -1 );
524  } catch ( RedisException $e ) {
525  throw $this->handleErrorAndMakeException( $conn, $e );
526  }
527 
528  return $this->getJobIterator( $conn, $uids );
529  }
530 
536  public function getAllDelayedJobs() {
537  $conn = $this->getConnection();
538  try {
539  $uids = $conn->zRange( $this->getQueueKey( 'z-delayed' ), 0, -1 );
540  } catch ( RedisException $e ) {
541  throw $this->handleErrorAndMakeException( $conn, $e );
542  }
543 
544  return $this->getJobIterator( $conn, $uids );
545  }
546 
552  public function getAllAcquiredJobs() {
553  $conn = $this->getConnection();
554  try {
555  $uids = $conn->zRange( $this->getQueueKey( 'z-claimed' ), 0, -1 );
556  } catch ( RedisException $e ) {
557  throw $this->handleErrorAndMakeException( $conn, $e );
558  }
559 
560  return $this->getJobIterator( $conn, $uids );
561  }
562 
568  public function getAllAbandonedJobs() {
569  $conn = $this->getConnection();
570  try {
571  $uids = $conn->zRange( $this->getQueueKey( 'z-abandoned' ), 0, -1 );
572  } catch ( RedisException $e ) {
573  throw $this->handleErrorAndMakeException( $conn, $e );
574  }
575 
576  return $this->getJobIterator( $conn, $uids );
577  }
578 
584  protected function getJobIterator( RedisConnRef $conn, array $uids ) {
585  return new MappedIterator(
586  $uids,
587  function ( $uid ) use ( $conn ) {
588  return $this->getJobFromUidInternal( $uid, $conn );
589  },
590  [ 'accept' => function ( $job ) {
591  return is_object( $job );
592  } ]
593  );
594  }
595 
596  public function getCoalesceLocationInternal() {
597  return "RedisServer:" . $this->server;
598  }
599 
600  protected function doGetSiblingQueuesWithJobs( array $types ) {
601  return array_keys( array_filter( $this->doGetSiblingQueueSizes( $types ) ) );
602  }
603 
604  protected function doGetSiblingQueueSizes( array $types ) {
605  $sizes = []; // (type => size)
606  $types = array_values( $types ); // reindex
607  $conn = $this->getConnection();
608  try {
609  $conn->multi( Redis::PIPELINE );
610  foreach ( $types as $type ) {
611  $conn->lSize( $this->getQueueKey( 'l-unclaimed', $type ) );
612  }
613  $res = $conn->exec();
614  if ( is_array( $res ) ) {
615  foreach ( $res as $i => $size ) {
616  $sizes[$types[$i]] = $size;
617  }
618  }
619  } catch ( RedisException $e ) {
620  throw $this->handleErrorAndMakeException( $conn, $e );
621  }
622 
623  return $sizes;
624  }
625 
635  public function getJobFromUidInternal( $uid, $conn ) {
636  try {
637  $data = $conn->hGet( $this->getQueueKey( 'h-data' ), $uid );
638  if ( $data === false ) {
639  return false; // not found
640  }
641  $item = $this->unserialize( $data );
642  if ( !is_array( $item ) ) { // this shouldn't happen
643  throw new UnexpectedValueException( "Could not unserialize job with ID '$uid'." );
644  }
645 
646  $params = $item['params'];
647  $params += [ 'namespace' => $item['namespace'], 'title' => $item['title'] ];
648  $job = $this->factoryJob( $item['type'], $params );
649  $job->setMetadata( 'uuid', $item['uuid'] );
650  $job->setMetadata( 'timestamp', $item['timestamp'] );
651  // Add in attempt count for debugging at showJobs.php
652  $job->setMetadata( 'attempts',
653  $conn->hGet( $this->getQueueKey( 'h-attempts' ), $uid ) );
654 
655  return $job;
656  } catch ( RedisException $e ) {
657  throw $this->handleErrorAndMakeException( $conn, $e );
658  }
659  }
660 
666  public function getServerQueuesWithJobs() {
667  $queues = [];
668 
669  $conn = $this->getConnection();
670  try {
671  $set = $conn->sMembers( $this->getGlobalKey( 's-queuesWithJobs' ) );
672  foreach ( $set as $queue ) {
673  $queues[] = $this->decodeQueueName( $queue );
674  }
675  } catch ( RedisException $e ) {
676  throw $this->handleErrorAndMakeException( $conn, $e );
677  }
678 
679  return $queues;
680  }
681 
686  protected function getNewJobFields( IJobSpecification $job ) {
687  return [
688  // Fields that describe the nature of the job
689  'type' => $job->getType(),
690  'namespace' => $job->getParams()['namespace'] ?? NS_SPECIAL,
691  'title' => $job->getParams()['title'] ?? '',
692  'params' => $job->getParams(),
693  // Some jobs cannot run until a "release timestamp"
694  'rtimestamp' => $job->getReleaseTimestamp() ?: 0,
695  // Additional job metadata
697  'sha1' => $job->ignoreDuplicates()
698  ? Wikimedia\base_convert( sha1( serialize( $job->getDeduplicationInfo() ) ), 16, 36, 31 )
699  : '',
700  'timestamp' => time() // UNIX timestamp
701  ];
702  }
703 
708  protected function getJobFromFields( array $fields ) {
709  $params = $fields['params'];
710  $params += [ 'namespace' => $fields['namespace'], 'title' => $fields['title'] ];
711 
712  $job = $this->factoryJob( $fields['type'], $params );
713  $job->setMetadata( 'uuid', $fields['uuid'] );
714  $job->setMetadata( 'timestamp', $fields['timestamp'] );
715 
716  return $job;
717  }
718 
723  protected function serialize( array $fields ) {
724  $blob = serialize( $fields );
725  if ( $this->compression === 'gzip'
726  && strlen( $blob ) >= 1024
727  && function_exists( 'gzdeflate' )
728  ) {
729  $object = (object)[ 'blob' => gzdeflate( $blob ), 'enc' => 'gzip' ];
730  $blobz = serialize( $object );
731 
732  return ( strlen( $blobz ) < strlen( $blob ) ) ? $blobz : $blob;
733  } else {
734  return $blob;
735  }
736  }
737 
742  protected function unserialize( $blob ) {
743  $fields = unserialize( $blob );
744  if ( is_object( $fields ) ) {
745  if ( $fields->enc === 'gzip' && function_exists( 'gzinflate' ) ) {
746  $fields = unserialize( gzinflate( $fields->blob ) );
747  } else {
748  $fields = false;
749  }
750  }
751 
752  return is_array( $fields ) ? $fields : false;
753  }
754 
761  protected function getConnection() {
762  $conn = $this->redisPool->getConnection( $this->server, $this->logger );
763  if ( !$conn ) {
764  throw new JobQueueConnectionError(
765  "Unable to connect to redis server {$this->server}." );
766  }
767 
768  return $conn;
769  }
770 
776  protected function handleErrorAndMakeException( RedisConnRef $conn, $e ) {
777  $this->redisPool->handleError( $conn, $e );
778  return new JobQueueError( "Redis server error: {$e->getMessage()}\n" );
779  }
780 
784  private function encodeQueueName() {
785  return json_encode( [ $this->type, $this->domain ] );
786  }
787 
792  private function decodeQueueName( $name ) {
793  return json_decode( $name );
794  }
795 
800  private function getGlobalKey( $name ) {
801  $parts = [ 'global', 'jobqueue', $name ];
802  foreach ( $parts as $part ) {
803  if ( !preg_match( '/[a-zA-Z0-9_-]+/', $part ) ) {
804  throw new InvalidArgumentException( "Key part characters are out of range." );
805  }
806  }
807 
808  return implode( ':', $parts );
809  }
810 
816  private function getQueueKey( $prop, $type = null ) {
817  $type = is_string( $type ) ? $type : $this->type;
818 
819  // Use wiki ID for b/c
820  $keyspace = WikiMap::getWikiIdFromDbDomain( $this->domain );
821 
822  $parts = [ $keyspace, 'jobqueue', $type, $prop ];
823 
824  // Parts are typically ASCII, but encode for sanity to escape ":"
825  return implode( ':', array_map( 'rawurlencode', $parts ) );
826  }
827 }
Class to handle job queues stored in Redis.
pushBlobs(RedisConnRef $conn, array $items)
return true to allow those checks to and false if checking is done remove or add to the links of a group of changes in EnhancedChangesList Hook subscribers can return false to omit this line from recentchanges use this to change the tables headers change it to an object instance and return false override the list derivative used $groups Array of ChangesListFilterGroup objects(added in 1.34) 'FileDeleteComplete' null for the local wiki Added in
Definition: hooks.txt:1529
factoryJob( $command, $params)
Definition: JobQueue.php:704
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 then executing the whole list after the page is displayed We don t do anything smart like collating updates to the same table or such because the list is almost always going to have just one item on if that
Definition: deferred.txt:11
and how to run hooks for an and one after Each event has a preferably in CamelCase For ArticleDelete hook A clump of code and data that should be run when an event happens This can be either a function and a chunk of data
Definition: hooks.txt:6
getQueueKey( $prop, $type=null)
getJobIterator(RedisConnRef $conn, array $uids)
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:187
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
string $compression
Compression method to use.
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Definition: hooks.txt:2147
globals txt Globals are evil The original MediaWiki code relied on globals for processing context far too often MediaWiki development since then has been a story of slowly moving context out of global variables and into objects Storing processing context in object member variables allows those objects to be reused in a much more flexible way Consider the elegance of
database rows
Definition: globals.txt:10
globals will be eliminated from MediaWiki replaced by an application object which would be passed to constructors Whether that would be an convenient solution remains to be but certainly PHP makes such object oriented programming models easier than they were in previous versions For the time being MediaWiki programmers will have to work in an environment with some global context At the time of globals were initialised on startup by MediaWiki of these were configuration which are documented in DefaultSettings php There is no comprehensive documentation for the remaining however some of the most important ones are listed below They are typically initialised either in index php or in Setup php $wgTitle Title object created from the request URL $wgOut OutputPage object for HTTP response $wgUser User object for the user associated with the current request $wgLang Language object selected by user preferences $wgContLang Language object associated with the wiki being viewed $wgParser Parser object Parser extensions register their hooks here $wgRequest WebRequest object
Definition: globals.txt:25
RedisConnectionPool $redisPool
static getWikiIdFromDbDomain( $domain)
Get the wiki ID of a database domain.
Definition: WikiMap.php:269
incrStats( $key, $type, $delta=1)
Call wfIncrStats() for the queue overall and for the queue type.
Definition: JobQueue.php:726
This code would result in ircNotify being run twice when an article is and once for brion Hooks can return three possible true was required This is the default since MediaWiki *some string
Definition: hooks.txt:175
const NS_SPECIAL
Definition: Defines.php:49
The First
Definition: primes.txt:1
decodeQueueName( $name)
luaEval( $script, array $params, $numKeys)
doGetSiblingQueueSizes(array $types)
This document provides an overview of the usage of PageUpdater and that is
Definition: pageupdater.txt:3
if( $line===false) $args
Definition: cdb.php:64
The ContentHandler facility adds support for arbitrary content types on wiki instead of relying on wikitext for everything It was introduced in MediaWiki Each kind of and so on Built in content types are
serialize(array $fields)
static singleton(array $options)
string $type
Job type.
Definition: JobQueue.php:35
getNewJobFields(IJobSpecification $job)
getGlobalKey( $name)
getMetadata( $field=null)
getRootJobCacheKey( $signature)
Definition: JobQueue.php:531
unserialize( $blob)
getJobFromUidInternal( $uid, $conn)
This function should not be called outside JobQueueRedis.
doDeduplicateRootJob(IJobSpecification $job)
$res
Definition: database.txt:21
getDeduplicationInfo()
Subclasses may need to override this to make duplication detection work.
string $server
Server address.
$params
popAndAcquireBlob(RedisConnRef $conn)
and(b) You must cause any modified files to carry prominent notices stating that You changed the files
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:767
Job that has a run() method and metadata accessors for JobQueue::pop() and JobQueue::ack() ...
Definition: RunnableJob.php:35
static newRawUUIDv4( $flags=0)
Return an RFC4122 compliant v4 UUID.
Convenience class for generating iterators from iterators.
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
__construct(array $params)
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
This document describes the state of Postgres support in and is fairly well maintained The main code is very well while extensions are very hit and miss it is probably the most supported database after MySQL Much of the work in making MediaWiki database agnostic came about through the work of creating Postgres as and are nearing end of but without copying over all the usage comments General notes on the but these can almost always be programmed around *Although Postgres has a true BOOLEAN type
Definition: postgres.txt:22
Class to handle enqueueing and running of background jobs.
Definition: JobQueue.php:31
wfDebugLog( $logGroup, $text, $dest='all', array $context=[])
Send a line to a supplementary debug log file, if configured, or main debug log if not...
if(count( $args)< 1) $job
skin txt MediaWiki includes four core it has been set as the default in MediaWiki since the replacing Monobook it had been the default skin since before being replaced by Vector largely rewritten in while keeping its appearance Several legacy skins were removed in the release
Definition: skin.txt:10
doGetSiblingQueuesWithJobs(array $types)
getJobFromFields(array $fields)
Helper class to handle automatically marking connectons as reusable (via RAII pattern) ...
MediaWiki Logger LoggerFactory implements a PSR [0] compatible message logging system Named Psr Log LoggerInterface instances can be obtained from the MediaWiki Logger LoggerFactory::getInstance() static method. MediaWiki\Logger\LoggerFactory expects a class implementing the MediaWiki\Logger\Spi interface to act as a factory for new Psr\Log\LoggerInterface instances. The "Spi" in MediaWiki\Logger\Spi stands for "service provider interface". An SPI is an API intended to be implemented or extended by a third party. This software design pattern is intended to enable framework extension and replaceable components. It is specifically used in the MediaWiki\Logger\LoggerFactory service to allow alternate PSR-3 logging implementations to be easily integrated with MediaWiki. The service provider interface allows the backend logging library to be implemented in multiple ways. The $wgMWLoggerDefaultSpi global provides the classname of the default MediaWiki\Logger\Spi implementation to be loaded at runtime. This can either be the name of a class implementing the MediaWiki\Logger\Spi with a zero argument const ructor or a callable that will return an MediaWiki\Logger\Spi instance. Alternately the MediaWiki\Logger\LoggerFactory MediaWiki Logger LoggerFactory
Definition: logger.txt:5
Interface for serializable objects that describe a job queue task.
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 and we might be restricted by PHP settings such as safe mode or open_basedir We cannot assume that the software even has read access anywhere useful Many shared hosts run all users web applications under the same so they can t rely on Unix and must forbid reads to even standard directories like tmp lest users read each others files We cannot assume that the user has the ability to install or run any programs not written as web accessible PHP scripts Since anything that works on cheap shared hosting will work if you have shell or root access MediaWiki s design is based around catering to the lowest common denominator Although we support higher end setups as the way many things work by default is tailored toward shared hosting These defaults are unconventional from the point of view of and they certainly aren t ideal for someone who s installing MediaWiki as MediaWiki does not conform to normal Unix filesystem layout Hopefully we ll offer direct support for standard layouts in the but for now *any change to the location of files is unsupported *Moving things and leaving symlinks will *probably *not break but it is *strongly *advised not to try any more intrusive changes to get MediaWiki to conform more closely to your filesystem hierarchy Any such attempt will almost certainly result in unnecessary bugs The standard recommended location to install relative to the web is it should be possible to enable the appropriate rewrite rules by if you can reconfigure the web server
getConnection()
Get a connection to the server that handles all sub-queues for this queue.
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
doAck(RunnableJob $job)
doIsRootJobOldDuplicate(IJobSpecification $job)
=Architecture==Two class hierarchies are used to provide the functionality associated with the different content models:*Content interface(and AbstractContent base class) define functionality that acts on the concrete content of a page, and *ContentHandler base class provides functionality specific to a content model, but not acting on concrete content. The most important function of ContentHandler is to act as a factory for the appropriate implementation of Content. These Content objects are to be used by MediaWiki everywhere, instead of passing page content around as text. All manipulation and analysis of page content must be done via the appropriate methods of the Content object. For each content model, a subclass of ContentHandler has to be registered with $wgContentHandlers. The ContentHandler object for a given content model can be obtained using ContentHandler::getForModelID($id). Also Title, WikiPage and Revision now have getContentHandler() methods for convenience. ContentHandler objects are singletons that provide functionality specific to the content type, but not directly acting on the content of some page. ContentHandler::makeEmptyContent() and ContentHandler::unserializeContent() can be used to create a Content object of the appropriate type. However, it is recommended to instead use WikiPage::getContent() resp. Revision::getContent() to get a page 's content as a Content object. These two methods should be the ONLY way in which page content is accessed. Another important function of ContentHandler objects is to define custom action handlers for a content model, see ContentHandler::getActionOverrides(). This is similar to what WikiPage::getActionOverrides() was already doing.==Serialization==With the ContentHandler facility, page content no longer has to be text based. Objects implementing the Content interface are used to represent and handle the content internally. For storage and data exchange, each content model supports at least one serialization format via ContentHandler::serializeContent($content). The list of supported formats for a given content model can be accessed using ContentHandler::getSupportedFormats(). Content serialization formats are identified using MIME type like strings. The following formats are built in:*text/x-wiki - wikitext *text/javascript - for js pages *text/css - for css pages *text/plain - for future use, e.g. with plain text messages. *text/html - for future use, e.g. with plain html messages. *application/vnd.php.serialized - for future use with the api and for extensions *application/json - for future use with the api, and for use by extensions *application/xml - for future use with the api, and for use by extensions In PHP, use the corresponding CONTENT_FORMAT_XXX constant. Note that when using the API to access page content, especially action=edit, action=parse and action=query &prop=revisions, the model and format of the content should always be handled explicitly. Without that information, interpretation of the provided content is not reliable. The same applies to XML dumps generated via maintenance/dumpBackup.php or Special:Export. Also note that the API will provide encapsulated, serialized content - so if the API was called with format=json, and contentformat is also json(or rather, application/json), the page content is represented as a string containing an escaped json structure. Extensions that use JSON to serialize some types of page content may provide specialized API modules that allow access to that content in a more natural form.==Compatibility==The ContentHandler facility is introduced in a way that should allow all existing code to keep functioning at least for pages that contain wikitext or other text based content. However, a number of functions and hooks have been deprecated in favor of new versions that are aware of the page 's content model, and will now generate warnings when used. Most importantly, the following functions have been deprecated:*Revisions::getText() is deprecated in favor Revisions::getContent() *WikiPage::getText() is deprecated in favor WikiPage::getContent() Also, the old Article::getContent()(which returns text) is superceded by Article::getContentObject(). However, both methods should be avoided since they do not provide clean access to the page 's actual content. For instance, they may return a system message for non-existing pages. Use WikiPage::getContent() instead. Code that relies on a textual representation of the page content should eventually be rewritten. However, ContentHandler::getContentText() provides a stop-gap that can be used to get text for a page. Its behavior is controlled by $wgContentHandlerTextFallback it
skin txt MediaWiki includes four core it has been set as the default in MediaWiki since the replacing Monobook it had been the default skin since then
Definition: skin.txt:10
const QUICK_RAND
doBatchPush(array $jobs, $flags)
handleErrorAndMakeException(RedisConnRef $conn, $e)
LoggerInterface $logger