20use Psr\Log\LoggerInterface;
85 parent::__construct( $conf,
$type,
$key );
87 $this->serversByLabel = $conf[
'servers'];
88 $this->ring =
new HashRing( array_fill_keys( array_keys( $conf[
'servers'] ), 100 ) );
90 $conf[
'redisConfig'][
'serializer'] =
'none';
92 $this->logger = \MediaWiki\Logger\LoggerFactory::getInstance(
'redis' );
94 $this->keySha1 = sha1( $this->
key );
95 $met = ini_get(
'max_execution_time' );
96 $this->lockTTL = $met ? 2 * $met : 3600;
98 if ( self::$active ===
null ) {
100 register_shutdown_function( [ __CLASS__,
'releaseAll' ] );
108 if ( !isset( $this->conn ) ) {
110 $servers = $this->ring->getLocations( $this->
key, 3 );
111 ArrayUtils::consistentHashSort( $servers, $this->
key );
112 foreach ( $servers as $server ) {
113 $conn = $this->pool->getConnection( $this->serversByLabel[$server], $this->logger );
119 return Status::newFatal(
'pool-servererror', implode(
', ', $servers ) );
123 return Status::newGood( $this->conn );
145 if ( $this->slot ===
null ) {
159 local kSlots,kSlotsNextRelease,kWakeup,kWaiting = unpack(KEYS)
160 local rMaxWorkers,rExpiry,rSlot,rSlotTime,rAwakeAll,rTime = unpack(ARGV)
161 -- Add the slots back to the
list (
if rSlot is
"w" then it is not a slot).
162 -- Treat the list as expired
if the
"next release" time sorted-
set is missing.
163 if rSlot ~=
'w' and redis.call(
'exists',kSlotsNextRelease) == 1
then
164 if 1*redis.call(
'zScore',kSlotsNextRelease,rSlot) ~= (rSlotTime + rExpiry)
then
165 -- Slot lock expired and was released already
166 elseif redis.call(
'lLen',kSlots) >= 1*rMaxWorkers
then
167 -- Slots somehow got out of sync; reset the list
for sanity
168 redis.call(
'del',kSlots,kSlotsNextRelease)
169 elseif redis.call(
'lLen',kSlots) == (1*rMaxWorkers - 1) and redis.call(
'zCard',kWaiting) == 0
then
170 -- Slot list will be
made full; clear it to
save space (it re-inits as
needed)
171 -- since nothing is waiting on being unblocked by a push to the list
172 redis.call(
'del',kSlots,kSlotsNextRelease)
174 -- Add slot back to pool and update the
"next release" time
175 redis.call(
'rPush',kSlots,rSlot)
176 redis.call(
'zAdd',kSlotsNextRelease,rTime + 30,rSlot)
177 -- Always keep renewing the expiry on use
178 redis.call(
'expireAt',kSlots,math.ceil(rTime + rExpiry))
179 redis.call(
'expireAt',kSlotsNextRelease,math.ceil(rTime + rExpiry))
182 -- Update an ephemeral list to wake up other clients that can
183 -- reuse any cached work from
this process. Only
do this if no
184 -- slots are currently
free (
e.g. clients could be waiting).
185 if 1*rAwakeAll == 1
then
186 local count = redis.call(
'zCard',kWaiting)
188 redis.call(
'rPush',kWakeup,
'w')
190 redis.call(
'pexpire',kWakeup,1)
207 ( $this->
onRelease === self::AWAKE_ALL ) ? 1 : 0,
210 4 # number of first argument(s) that are keys
212 }
catch ( RedisException
$e ) {
213 return Status::newFatal(
'pool-error-unknown',
$e->getMessage() );
217 $this->slotTime =
null;
219 unset( self::$active[$this->session] );
231 if ( $this->slot !==
null ) {
241 $now = microtime(
true );
244 if ( ctype_digit(
$slot ) ) {
247 } elseif (
$slot ===
'QUEUE_FULL' ) {
250 } elseif (
$slot ===
'QUEUE_WAIT' ) {
269 return Status::newFatal(
'pool-error-unknown',
"Server gave slot '$slot'." );
271 }
catch ( RedisException
$e ) {
272 return Status::newFatal(
'pool-error-unknown',
$e->getMessage() );
275 if (
$slot !==
'w' ) {
296 local kSlots,kSlotsNextRelease,kSlotWaits = unpack(KEYS)
297 local rMaxWorkers,rMaxQueue,rTimeout,rExpiry,rSess,rTime = unpack(ARGV)
298 -- Initialize
if the
"next release" time sorted-
set is empty. The slot
key
299 -- itself is empty
if all slots are busy or when nothing is initialized.
300 -- If the list is empty but the
set is
not,
then it is the latter
case.
301 -- For sanity,
if the list exists but not the
set,
then reset everything.
302 if redis.call(
'exists',kSlotsNextRelease) == 0
then
303 redis.call(
'del',kSlots)
304 for i = 1,1*rMaxWorkers
do
305 redis.call(
'rPush',kSlots,i)
306 redis.call(
'zAdd',kSlotsNextRelease,-1,i)
308 -- Otherwise
do maintenance to clean up after
network partitions
310 -- Find stale slot locks and add free
them (avoid duplicates
for sanity)
311 local staleLocks = redis.call(
'zRangeByScore',kSlotsNextRelease,0,rTime)
312 for k,slot in ipairs(staleLocks)
do
313 redis.call(
'lRem',kSlots,0,slot)
314 redis.call(
'rPush',kSlots,slot)
315 redis.call(
'zAdd',kSlotsNextRelease,rTime + 30,slot)
317 -- Find stale wait slot entries and
remove them
318 redis.call(
'zRemRangeByScore',kSlotWaits,0,rTime - 2*rTimeout)
321 -- Try to acquire a slot
if possible now
322 if redis.call(
'lLen',kSlots) > 0
then
323 slot = redis.call(
'lPop',kSlots)
324 -- Update the slot
"next release" time
325 redis.call(
'zAdd',kSlotsNextRelease,rTime + rExpiry,slot)
326 elseif redis.call(
'zCard',kSlotWaits) >= 1*rMaxQueue
then
330 -- Register
this process as waiting
331 redis.call(
'zAdd',kSlotWaits,rTime,rSess)
332 redis.call(
'expireAt',kSlotWaits,math.ceil(rTime + 2*rTimeout))
334 -- Always keep renewing the expiry on use
335 redis.call(
'expireAt',kSlots,math.ceil(rTime + rExpiry))
336 redis.call(
'expireAt',kSlotsNextRelease,math.ceil(rTime + rExpiry))
351 3 # number of first argument(s) that are keys
365 local kSlots,kSlotsNextRelease,kSlotWaits = unpack(KEYS)
366 local rSlot,rExpiry,rSess,rTime = unpack(ARGV)
367 -- If rSlot is
'w' then the client was told to wake up but got no slot
369 -- Update the slot
"next release" time
370 redis.call(
'zAdd',kSlotsNextRelease,rTime + rExpiry,rSlot)
371 -- Always keep renewing the expiry on use
372 redis.call(
'expireAt',kSlots,math.ceil(rTime + rExpiry))
373 redis.call(
'expireAt',kSlotsNextRelease,math.ceil(rTime + rExpiry))
375 -- Unregister
this process as waiting
376 redis.call(
'zRem',kSlotWaits,rSess)
389 3 # number of first argument(s) that are keys
397 return "poolcounter:l-slots-{$this->keySha1}-{$this->workers}";
404 return "poolcounter:z-renewtime-{$this->keySha1}-{$this->workers}";
411 return "poolcounter:z-wait-{$this->keySha1}-{$this->workers}";
418 return "poolcounter:l-wakeup-{$this->keySha1}-{$this->workers}";
425 foreach ( self::$active as $poolCounter ) {
427 if ( $poolCounter->slot !==
null ) {
428 $poolCounter->release();
430 }
catch ( Exception
$e ) {
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
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
Convenience class for weighted consistent hash rings.
Version of PoolCounter that uses Redis.
int $onRelease
AWAKE_* constant.
__construct( $conf, $type, $key)
string $slot
Pool slot value.
int $slotTime
UNIX timestamp.
waitForSlotOrNotif( $doWakeup)
acquireForAnyone()
I want to do this task, but if anyone else does it instead, it's also fine for me.
initAndPopPoolSlotList(RedisConnRef $conn, $now)
array $serversByLabel
(server label => host) map
string $session
Unique string to identify this process.
static releaseAll()
Try to make sure that locks get released (even with exceptions and fatals)
release()
I have successfully finished my task.
static PoolCounterRedis[] $active
List of active PoolCounterRedis objects in this script.
registerAcquisitionTime(RedisConnRef $conn, $slot, $now)
acquireForMe()
I want to do this task and I need to do it myself.
int $lockTTL
TTL for locks to expire (work should finish in this time)
string $keySha1
SHA-1 of the key.
RedisConnectionPool $pool
When you have many workers (threads/servers) giving service, and a cached item expensive to produce e...
onAcquire()
Update any lock tracking information when the lock is acquired.
string $key
All workers with the same key share the lock.
precheckAcquire()
Checks that the lock request is sane.
onRelease()
Update any lock tracking information when the lock is released.
Helper class to handle automatically marking connectons as reusable (via RAII pattern)
luaEval( $script, array $params, $numKeys)
Helper class to manage Redis connections.
static singleton(array $options)
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
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
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when needed(most notably, OutputPage::addWikiText()). The StandardSkin object is a complete implementation
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add in any and then calling but I prefer the flexibility This should also do the output encoding The system allocates a global one in $wgOut Title Represents the title of an and does all the work of translating among various forms such as plain database key
in this case you re responsible for computing and outputting the entire conflict i e
this hook is for auditing only RecentChangesLinked and Watchlist 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
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. '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 'DatabaseOraclePostInit':Called after initialising an Oracle database $db:the DatabaseOracle object '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). '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
returning false will NOT prevent logging $e
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
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