MediaWiki  master
PoolCounterRedis.php
Go to the documentation of this file.
1 <?php
21 
55  protected $ring;
57  protected $pool;
59  protected $logger;
61  protected $serversByLabel;
63  protected $keySha1;
65  protected $lockTTL;
66 
68  protected $conn;
70  protected $slot;
72  protected $onRelease;
74  protected $session;
76  protected $slotTime;
77 
78  const AWAKE_ONE = 1; // wake-up if when a slot can be taken from an existing process
79  const AWAKE_ALL = 2; // wake-up if an existing process finishes and wake up such others
80 
82  protected static $active = null;
83 
84  function __construct( $conf, $type, $key ) {
85  parent::__construct( $conf, $type, $key );
86 
87  $this->serversByLabel = $conf['servers'];
88 
89  $serverLabels = array_keys( $conf['servers'] );
90  $this->ring = new HashRing( array_fill_keys( $serverLabels, 10 ) );
91 
92  $conf['redisConfig']['serializer'] = 'none'; // for use with Lua
93  $this->pool = RedisConnectionPool::singleton( $conf['redisConfig'] );
94  $this->logger = \MediaWiki\Logger\LoggerFactory::getInstance( 'redis' );
95 
96  $this->keySha1 = sha1( $this->key );
97  $met = ini_get( 'max_execution_time' ); // usually 0 in CLI mode
98  $this->lockTTL = $met ? 2 * $met : 3600;
99 
100  if ( self::$active === null ) {
101  self::$active = [];
102  register_shutdown_function( [ __CLASS__, 'releaseAll' ] );
103  }
104  }
105 
109  protected function getConnection() {
110  if ( !isset( $this->conn ) ) {
111  $conn = false;
112  $servers = $this->ring->getLocations( $this->key, 3 );
113  ArrayUtils::consistentHashSort( $servers, $this->key );
114  foreach ( $servers as $server ) {
115  $conn = $this->pool->getConnection( $this->serversByLabel[$server], $this->logger );
116  if ( $conn ) {
117  break;
118  }
119  }
120  if ( !$conn ) {
121  return Status::newFatal( 'pool-servererror', implode( ', ', $servers ) );
122  }
123  $this->conn = $conn;
124  }
125  return Status::newGood( $this->conn );
126  }
127 
128  function acquireForMe() {
129  $status = $this->precheckAcquire();
130  if ( !$status->isGood() ) {
131  return $status;
132  }
133 
134  return $this->waitForSlotOrNotif( self::AWAKE_ONE );
135  }
136 
137  function acquireForAnyone() {
138  $status = $this->precheckAcquire();
139  if ( !$status->isGood() ) {
140  return $status;
141  }
142 
143  return $this->waitForSlotOrNotif( self::AWAKE_ALL );
144  }
145 
146  function release() {
147  if ( $this->slot === null ) {
148  return Status::newGood( PoolCounter::NOT_LOCKED ); // not locked
149  }
150 
151  $status = $this->getConnection();
152  if ( !$status->isOK() ) {
153  return $status;
154  }
155  $conn = $status->value;
156 
157  // phpcs:disable Generic.Files.LineLength
158  static $script =
160 <<<LUA
161  local kSlots,kSlotsNextRelease,kWakeup,kWaiting = unpack(KEYS)
162  local rMaxWorkers,rExpiry,rSlot,rSlotTime,rAwakeAll,rTime = unpack(ARGV)
163  -- Add the slots back to the list (if rSlot is "w" then it is not a slot).
164  -- Treat the list as expired if the "next release" time sorted-set is missing.
165  if rSlot ~= 'w' and redis.call('exists',kSlotsNextRelease) == 1 then
166  if 1*redis.call('zScore',kSlotsNextRelease,rSlot) ~= (rSlotTime + rExpiry) then
167  -- Slot lock expired and was released already
168  elseif redis.call('lLen',kSlots) >= 1*rMaxWorkers then
169  -- Slots somehow got out of sync; reset the list for sanity
170  redis.call('del',kSlots,kSlotsNextRelease)
171  elseif redis.call('lLen',kSlots) == (1*rMaxWorkers - 1) and redis.call('zCard',kWaiting) == 0 then
172  -- Slot list will be made full; clear it to save space (it re-inits as needed)
173  -- since nothing is waiting on being unblocked by a push to the list
174  redis.call('del',kSlots,kSlotsNextRelease)
175  else
176  -- Add slot back to pool and update the "next release" time
177  redis.call('rPush',kSlots,rSlot)
178  redis.call('zAdd',kSlotsNextRelease,rTime + 30,rSlot)
179  -- Always keep renewing the expiry on use
180  redis.call('expireAt',kSlots,math.ceil(rTime + rExpiry))
181  redis.call('expireAt',kSlotsNextRelease,math.ceil(rTime + rExpiry))
182  end
183  end
184  -- Update an ephemeral list to wake up other clients that can
185  -- reuse any cached work from this process. Only do this if no
186  -- slots are currently free (e.g. clients could be waiting).
187  if 1*rAwakeAll == 1 then
188  local count = redis.call('zCard',kWaiting)
189  for i = 1,count do
190  redis.call('rPush',kWakeup,'w')
191  end
192  redis.call('pexpire',kWakeup,1)
193  end
194  return 1
195 LUA;
196  // phpcs:enable
197 
198  try {
199  $conn->luaEval( $script,
200  [
201  $this->getSlotListKey(),
202  $this->getSlotRTimeSetKey(),
203  $this->getWakeupListKey(),
204  $this->getWaitSetKey(),
205  $this->workers,
206  $this->lockTTL,
207  $this->slot,
208  $this->slotTime, // used for CAS-style sanity check
209  ( $this->onRelease === self::AWAKE_ALL ) ? 1 : 0,
210  microtime( true )
211  ],
212  4 # number of first argument(s) that are keys
213  );
214  } catch ( RedisException $e ) {
215  return Status::newFatal( 'pool-error-unknown', $e->getMessage() );
216  }
217 
218  $this->slot = null;
219  $this->slotTime = null;
220  $this->onRelease = null;
221  unset( self::$active[$this->session] );
222 
223  $this->onRelease();
224 
226  }
227 
232  protected function waitForSlotOrNotif( $doWakeup ) {
233  if ( $this->slot !== null ) {
234  return Status::newGood( PoolCounter::LOCK_HELD ); // already acquired
235  }
236 
237  $status = $this->getConnection();
238  if ( !$status->isOK() ) {
239  return $status;
240  }
241  $conn = $status->value;
242 
243  $now = microtime( true );
244  try {
245  $slot = $this->initAndPopPoolSlotList( $conn, $now );
246  if ( ctype_digit( $slot ) ) {
247  // Pool slot acquired by this process
248  $slotTime = $now;
249  } elseif ( $slot === 'QUEUE_FULL' ) {
250  // Too many processes are waiting for pooled processes to finish
252  } elseif ( $slot === 'QUEUE_WAIT' ) {
253  // This process is now registered as waiting
254  $keys = ( $doWakeup == self::AWAKE_ALL )
255  // Wait for an open slot or wake-up signal (preferring the latter)
256  ? [ $this->getWakeupListKey(), $this->getSlotListKey() ]
257  // Just wait for an actual pool slot
258  : [ $this->getSlotListKey() ];
259 
260  $res = $conn->blPop( $keys, $this->timeout );
261  if ( $res === [] ) {
262  $conn->zRem( $this->getWaitSetKey(), $this->session ); // no longer waiting
264  }
265 
266  $slot = $res[1]; // pool slot or "w" for wake-up notifications
267  $slotTime = microtime( true ); // last microtime() was a few RTTs ago
268  // Unregister this process as waiting and bump slot "next release" time
270  } else {
271  return Status::newFatal( 'pool-error-unknown', "Server gave slot '$slot'." );
272  }
273  } catch ( RedisException $e ) {
274  return Status::newFatal( 'pool-error-unknown', $e->getMessage() );
275  }
276 
277  if ( $slot !== 'w' ) {
278  $this->slot = $slot;
279  $this->slotTime = $slotTime;
280  $this->onRelease = $doWakeup;
281  self::$active[$this->session] = $this;
282  }
283 
284  $this->onAcquire();
285 
287  }
288 
294  protected function initAndPopPoolSlotList( RedisConnRef $conn, $now ) {
295  static $script =
297 <<<LUA
298  local kSlots,kSlotsNextRelease,kSlotWaits = unpack(KEYS)
299  local rMaxWorkers,rMaxQueue,rTimeout,rExpiry,rSess,rTime = unpack(ARGV)
300  -- Initialize if the "next release" time sorted-set is empty. The slot key
301  -- itself is empty if all slots are busy or when nothing is initialized.
302  -- If the list is empty but the set is not, then it is the latter case.
303  -- For sanity, if the list exists but not the set, then reset everything.
304  if redis.call('exists',kSlotsNextRelease) == 0 then
305  redis.call('del',kSlots)
306  for i = 1,1*rMaxWorkers do
307  redis.call('rPush',kSlots,i)
308  redis.call('zAdd',kSlotsNextRelease,-1,i)
309  end
310  -- Otherwise do maintenance to clean up after network partitions
311  else
312  -- Find stale slot locks and add free them (avoid duplicates for sanity)
313  local staleLocks = redis.call('zRangeByScore',kSlotsNextRelease,0,rTime)
314  for k,slot in ipairs(staleLocks) do
315  redis.call('lRem',kSlots,0,slot)
316  redis.call('rPush',kSlots,slot)
317  redis.call('zAdd',kSlotsNextRelease,rTime + 30,slot)
318  end
319  -- Find stale wait slot entries and remove them
320  redis.call('zRemRangeByScore',kSlotWaits,0,rTime - 2*rTimeout)
321  end
322  local slot
323  -- Try to acquire a slot if possible now
324  if redis.call('lLen',kSlots) > 0 then
325  slot = redis.call('lPop',kSlots)
326  -- Update the slot "next release" time
327  redis.call('zAdd',kSlotsNextRelease,rTime + rExpiry,slot)
328  elseif redis.call('zCard',kSlotWaits) >= 1*rMaxQueue then
329  slot = 'QUEUE_FULL'
330  else
331  slot = 'QUEUE_WAIT'
332  -- Register this process as waiting
333  redis.call('zAdd',kSlotWaits,rTime,rSess)
334  redis.call('expireAt',kSlotWaits,math.ceil(rTime + 2*rTimeout))
335  end
336  -- Always keep renewing the expiry on use
337  redis.call('expireAt',kSlots,math.ceil(rTime + rExpiry))
338  redis.call('expireAt',kSlotsNextRelease,math.ceil(rTime + rExpiry))
339  return slot
340 LUA;
341  return $conn->luaEval( $script,
342  [
343  $this->getSlotListKey(),
344  $this->getSlotRTimeSetKey(),
345  $this->getWaitSetKey(),
346  $this->workers,
347  $this->maxqueue,
348  $this->timeout,
349  $this->lockTTL,
350  $this->session,
351  $now
352  ],
353  3 # number of first argument(s) that are keys
354  );
355  }
356 
363  protected function registerAcquisitionTime( RedisConnRef $conn, $slot, $now ) {
364  static $script =
366 <<<LUA
367  local kSlots,kSlotsNextRelease,kSlotWaits = unpack(KEYS)
368  local rSlot,rExpiry,rSess,rTime = unpack(ARGV)
369  -- If rSlot is 'w' then the client was told to wake up but got no slot
370  if rSlot ~= 'w' then
371  -- Update the slot "next release" time
372  redis.call('zAdd',kSlotsNextRelease,rTime + rExpiry,rSlot)
373  -- Always keep renewing the expiry on use
374  redis.call('expireAt',kSlots,math.ceil(rTime + rExpiry))
375  redis.call('expireAt',kSlotsNextRelease,math.ceil(rTime + rExpiry))
376  end
377  -- Unregister this process as waiting
378  redis.call('zRem',kSlotWaits,rSess)
379  return 1
380 LUA;
381  return $conn->luaEval( $script,
382  [
383  $this->getSlotListKey(),
384  $this->getSlotRTimeSetKey(),
385  $this->getWaitSetKey(),
386  $slot,
387  $this->lockTTL,
388  $this->session,
389  $now
390  ],
391  3 # number of first argument(s) that are keys
392  );
393  }
394 
398  protected function getSlotListKey() {
399  return "poolcounter:l-slots-{$this->keySha1}-{$this->workers}";
400  }
401 
405  protected function getSlotRTimeSetKey() {
406  return "poolcounter:z-renewtime-{$this->keySha1}-{$this->workers}";
407  }
408 
412  protected function getWaitSetKey() {
413  return "poolcounter:z-wait-{$this->keySha1}-{$this->workers}";
414  }
415 
419  protected function getWakeupListKey() {
420  return "poolcounter:l-wakeup-{$this->keySha1}-{$this->workers}";
421  }
422 
426  public static function releaseAll() {
427  foreach ( self::$active as $poolCounter ) {
428  try {
429  if ( $poolCounter->slot !== null ) {
430  $poolCounter->release();
431  }
432  } catch ( Exception $e ) {
433  }
434  }
435  }
436 }
LoggerInterface $logger
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:1535
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
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
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title e g db for database replication lag or jobqueue for job queue size converted to pseudo seconds It is possible to add more fields and they will be returned to the user in the API response after the basic globals have been set up
Definition: hooks.txt:2216
precheckAcquire()
Checks that the lock request is sane.
const LOCKED
Definition: PoolCounter.php:47
array $serversByLabel
(server label => host) map
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
onRelease()
Update any lock tracking information when the lock is released.
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Definition: hooks.txt:2158
__construct( $conf, $type, $key)
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for and distribution as defined by Sections through of this document Licensor shall mean the copyright owner or entity authorized by the copyright owner that is granting the License Legal Entity shall mean the union of the acting entity and all other entities that control are controlled by or are under common control with that entity For the purposes of this definition control direct or to cause the direction or management of such whether by contract or including but not limited to software source documentation and configuration files Object form shall mean any form resulting from mechanical transformation or translation of a Source including but not limited to compiled object generated and conversions to other media types Work shall mean the work of whether in Source or Object made available under the as indicated by a copyright notice that is included in or attached to the whether in Source or Object that is based or other modifications as a an original work of authorship For the purposes of this Derivative Works shall not include works that remain separable from
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
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for and distribution as defined by Sections through of this document Licensor shall mean the copyright owner or entity authorized by the copyright owner that is granting the License Legal Entity shall mean the union of the acting entity and all other entities that control are controlled by or are under common control with that entity For the purposes of this definition control direct or to cause the direction or management of such whether by contract or including but not limited to software source documentation and configuration files Object form shall mean any form resulting from mechanical transformation or translation of a Source including but not limited to compiled object generated and conversions to other media types Work shall mean the work of whether in Source or Object made available under the as indicated by a copyright notice that is included in or attached to the work(an example is provided in the Appendix below). "Derivative Works" shall mean any work
MediaWiki has optional support for a high distributed memory object caching system For general information on but for a larger site with heavy like it should help lighten the load on the database servers by caching data and objects in Ubuntu and probably other Linux distributions If there s no package available for your you can compile it from epoll rt patch for Linux is current Memcached and libevent are under BSD style licenses The server should run on Linux and other Unix like systems you can run multiple servers on one machine or on multiple machines on a network
Definition: memcached.txt:16
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 which defines all default service and specifies how they depend on each other("wiring"). When a new service is added to MediaWiki core
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation use $formDescriptor instead default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message key
Definition: hooks.txt:2150
static getInstance( $channel)
Get a named logger instance from the currently configured logger factory.
luaEval( $script, array $params, $numKeys)
in this case you re responsible for computing and outputting the entire conflict i e
Definition: hooks.txt:1407
this hook is for auditing only RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing them
Definition: hooks.txt:966
This document provides an overview of the usage of PageUpdater and that is
Definition: pageupdater.txt:3
int $slotTime
UNIX timestamp.
const NOT_LOCKED
Definition: PoolCounter.php:52
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
An extension or a local will often add custom code to the function with or without a global variable For someone wanting email notification when an article is shown may add
Definition: hooks.txt:51
static singleton(array $options)
static newFatal( $message)
Factory function for fatal errors.
Definition: StatusValue.php:68
Convenience class for weighted consistent hash rings.
Definition: HashRing.php:39
Status::newGood()` to allow deletion, and then `return false` from the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry out custom deletion actions. $tag:name of the tag $user:user initiating the action & $status:Status object. See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use. & $tags:list of all active tags. Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function. Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action, or null $user:User who performed the tagging when the tagging is subsequent to the action, or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change. & $allowedTags:List of all the tags the user is allowed to add. Any tags the user wants to add( $addTags) that are not in this array will cause it to fail. You may add or remove tags to this array as required. $addTags:List of tags user intends to add. $user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed. $performer:The User who will perform the change $user:The User whose groups will be changed & $add:The groups that will be added & $remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation. $collationName:Name of the collation in question & $collationObject:Null. Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user 's email has been confirmed successfully. $user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object. Called by Content::getParserOutput after parsing has finished. Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML). $content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput. May be used to override the normal model-specific rendering of page content. $content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering. To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state. $generateHtml:boolean, indicating whether full HTML should be generated. If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object. & $output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title. May be used to assign a different model for that title. $title:the Title in question & $model:the model name. Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers. Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core. $modeName:the requested content model name & $handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page. This is especially useful to prevent some content models to be used in some special location. $contentModel:ID of the content model in question $title:the Title in question. & $ok:Output parameter, whether it is OK to use $contentModel on $title. Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok. 'ContribsPager::getQueryInfo':Before the contributions query is about to run & $pager:Pager object for contributions & $queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions & $data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title & $tools:Array of tool links $specialPage:SpecialPage instance for context and services. Can be either SpecialContributions or DeletedContributionsPage. Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested. Handler functions that modify $result should generally return false to disable further attempts at conversion. $content:The Content object to be converted. $toModel:The ID of the content model to convert to. $lossy:boolean indicating whether lossy conversion is allowed. & $result:Output parameter, in case the handler function wants to provide a converted Content object. Note that $result->getContentModel() must return $toModel. 'ContentSecurityPolicyDefaultSource':Modify the allowed CSP load sources. This affects all directives except for the script directive. If you want to add a script source, see ContentSecurityPolicyScriptSource hook. & $defaultSrc:Array of Content-Security-Policy allowed sources $policyConfig:Current configuration for the Content-Security-Policy header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyDirectives':Modify the content security policy directives. Use this only if ContentSecurityPolicyDefaultSource and ContentSecurityPolicyScriptSource do not meet your needs. & $directives:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyScriptSource':Modify the allowed CSP script sources. Note that you also have to use ContentSecurityPolicyDefaultSource if you want non-script sources to be loaded from whatever you add. & $scriptSrc:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g. for a special namespace, etc. $article:Article being edited $user:User performing the edit 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery & $data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished. Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'DeleteUnknownPreferences':Called by the cleanupPreferences.php maintenance script to build a WHERE clause with which to delete preferences that are not known about. This hook is used by extensions that have dynamically-named preferences that should not be deleted in the usual cleanup process. For example, the Gadgets extension creates preferences prefixed with 'gadget-', and so anything with that prefix is excluded from the deletion. &where:An array that will be passed as the $cond parameter to IDatabase::select() to determine what will be deleted from the user_properties table. $db:The IDatabase object, useful for accessing $db->buildLike() etc. 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function. $differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable 's value is null. This hook can be used to inject content into said class member variable. $differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the "mark as patrolled" link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink". $differenceEngine:DifferenceEngine object & $markAsPatrolledLink:The "mark as patrolled" link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter. For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions. & $rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision 's author, whether the revision was marked as a minor edit or not, etc. $differenceEngine:DifferenceEngine object & $newHeader:The string containing the various #mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any) $status
Definition: hooks.txt:1250
int $onRelease
AWAKE_* constant.
static PoolCounterRedis [] $active
List of active PoolCounterRedis objects in this script.
string $keySha1
SHA-1 of the key.
$res
Definition: database.txt:21
string $key
All workers with the same key share the lock.
Definition: PoolCounter.php:58
static newGood( $value=null)
Factory function for good results.
Definition: StatusValue.php:81
Version of PoolCounter that uses Redis.
RedisConnectionPool $pool
and(b) You must cause any modified files to carry prominent notices stating that You changed the files
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 save
Definition: deferred.txt:4
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:773
int $lockTTL
TTL for locks to expire (work should finish in this time)
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for and distribution as defined by Sections through of this document Licensor shall mean the copyright owner or entity authorized by the copyright owner that is granting the License Legal Entity shall mean the union of the acting entity and all other entities that control are controlled by or are under common control with that entity For the purposes of this definition control direct or to cause the direction or management of such whether by contract or including but not limited to software source documentation and configuration files Object form shall mean any form resulting from mechanical transformation or translation of a Source including but not limited to compiled object generated and conversions to other media types Work shall mean the work of whether in Source or Object made available under the as indicated by a copyright notice that is included in or attached to the whether in Source or Object that is based or other modifications as a an original work of authorship For the purposes of this Derivative Works shall not include works that remain separable or merely the Work and Derivative Works thereof Contribution shall mean any work of including the original version of the Work and any modifications or additions to that Work or Derivative Works that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner For the purposes of this submitted means any form of or written communication sent to the Licensor or its including but not limited to communication on electronic mailing source code control and issue tracking systems that are managed by
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for and distribution as defined by Sections through of this document Licensor shall mean the copyright owner or entity authorized by the copyright owner that is granting the License Legal Entity shall mean the union of the acting entity and all other entities that control are controlled by or are under common control with that entity For the purposes of this definition control direct or to cause the direction or management of such whether by contract or including but not limited to software source documentation and configuration files Object form shall mean any form resulting from mechanical transformation or translation of a Source including but not limited to compiled object generated and conversions to other media types Work shall mean the work of whether in Source or Object made available under the as indicated by a copyright notice that is included in or attached to the whether in Source or Object that is based or other modifications as a an original work of authorship For the purposes of this Derivative Works shall not include works that remain separable or merely the Work and Derivative Works thereof Contribution shall mean any work of including the original version of the Work and any modifications or additions to that Work or Derivative Works that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner For the purposes of this submitted means any form of or written communication sent to the Licensor or its including but not limited to communication on electronic mailing source code control and issue tracking systems that are managed or on behalf the Licensor for the purpose of discussing and improving the but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as Not a Contribution Contributor shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work Grant of Copyright License Subject to the terms and conditions of this each Contributor hereby grants to You a non no royalty irrevocable copyright license to prepare Derivative Works publicly publicly and distribute the Work and such Derivative Works in Source or Object form Grant of Patent License Subject to the terms and conditions of this each Contributor hereby grants to You a non no royalty have made
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
RedisConnRef $conn
string $slot
Pool slot value.
string $session
Unique string to identify this process.
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
waitForSlotOrNotif( $doWakeup)
static consistentHashSort(&$array, $key, $separator="\0")
Sort the given array in a pseudo-random order which depends only on the given key and each element va...
Definition: ArrayUtils.php:49
const QUEUE_FULL
Definition: PoolCounter.php:53
Helper class to handle automatically marking connectons as reusable (via RAII pattern) ...
Using a hook running we can avoid having all this option specific stuff in our mainline code Using the function We ve cleaned up the code here by removing clumps of infrequently used code and moving them off somewhere else It s much easier for someone working with this code to see what s _really_ going on
Definition: hooks.txt:77
When you have many workers (threads/servers) giving service, and a cached item expensive to produce e...
Definition: PoolCounter.php:45
const TIMEOUT
Definition: PoolCounter.php:54
</td >< td > &</td >< td > t want your writing to be edited mercilessly and redistributed at will
=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
onAcquire()
Update any lock tracking information when the lock is acquired.
initAndPopPoolSlotList(RedisConnRef $conn, $now)
const RELEASED
Definition: PoolCounter.php:48
const LOCK_HELD
Definition: PoolCounter.php:55
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for and distribution as defined by Sections through of this document Licensor shall mean the copyright owner or entity authorized by the copyright owner that is granting the License Legal Entity shall mean the union of the acting entity and all other entities that control are controlled by or are under common control with that entity For the purposes of this definition control direct or to cause the direction or management of such whether by contract or including but not limited to software source documentation and configuration files Object form shall mean any form resulting from mechanical transformation or translation of a Source including but not limited to compiled object generated and conversions to other media types Work shall mean the work of whether in Source or Object made available under the as indicated by a copyright notice that is included in or attached to the whether in Source or Object that is based or other modifications as a an original work of authorship For the purposes of this Derivative Works shall not include works that remain separable or merely the Work and Derivative Works thereof Contribution shall mean any work of including the original version of the Work and any modifications or additions to that Work or Derivative Works that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner For the purposes of this submitted means any form of or written communication sent to the Licensor or its including but not limited to communication on electronic mailing source code control and issue tracking systems that are managed or on behalf the Licensor for the purpose of discussing and improving the but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as Not a Contribution Contributor shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work Grant of Copyright License Subject to the terms and conditions of this each Contributor hereby grants to You a non no royalty free
static releaseAll()
Try to make sure that locks get released (even with exceptions and fatals)
registerAcquisitionTime(RedisConnRef $conn, $slot, $now)