97 if ( isset(
$params[
'logger'] ) ) {
103 if ( isset(
$params[
'keyspace'] ) ) {
104 $this->keyspace =
$params[
'keyspace'];
107 $this->asyncHandler = isset(
$params[
'asyncHandler'] )
111 if ( !empty(
$params[
'reportDupes'] ) && is_callable( $this->asyncHandler ) ) {
112 $this->reportDupes =
true;
128 $this->debugMode = $bool;
147 if ( !is_callable( $callback ) ) {
150 $value = call_user_func( $callback );
175 $flags = is_int( $oldFlags ) ? $oldFlags :
$flags;
187 if ( !$this->reportDupes ) {
191 if ( !isset( $this->duplicateKeyLookups[
$key] ) ) {
194 $this->duplicateKeyLookups[
$key] = 0;
196 $this->duplicateKeyLookups[
$key] += 1;
198 if ( $this->dupeTrackScheduled ===
false ) {
199 $this->dupeTrackScheduled =
true;
201 call_user_func( $this->asyncHandler,
function () {
202 $dups = array_filter( $this->duplicateKeyLookups );
203 foreach ( $dups
as $key =>
$count ) {
204 $this->logger->warning(
205 'Duplicate get(): "{key}" fetched {count} times',
207 [
'key' => $key,
'count' =>
$count + 1, ]
220 abstract protected function doGet(
$key, $flags = 0 );
232 throw new Exception( __METHOD__ .
' not implemented.' );
244 abstract public function set(
$key,
$value, $exptime = 0, $flags = 0 );
252 abstract public function delete(
$key );
268 public function merge(
$key, $callback, $exptime = 0, $attempts = 10, $flags = 0 ) {
269 if ( !is_callable( $callback ) ) {
295 $value = call_user_func( $callback, $this,
$key, $currentValue );
300 } elseif ( $currentValue ===
false ) {
310 }
while ( !
$success && --$attempts );
326 throw new Exception(
"CAS is not implemented in " . __CLASS__ );
339 protected function mergeViaLock(
$key, $callback, $exptime = 0, $attempts = 10, $flags = 0 ) {
345 $currentValue = $this->
get(
$key, self::READ_LATEST );
350 $value = call_user_func( $callback, $this,
$key, $currentValue );
360 trigger_error(
"Could not release lock for key '$key'." );
377 public function lock(
$key, $timeout = 6, $expiry = 6, $rclass =
'' ) {
379 if ( isset( $this->locks[
$key] ) ) {
380 if ( $rclass !=
'' && $this->locks[$key][
'class'] === $rclass ) {
381 ++$this->locks[
$key][
'depth'];
388 $expiry = min( $expiry ?: INF, self::TTL_DAY );
392 if ( $this->
add(
"{$key}:lock", 1, $expiry ) ) {
398 $uRTT = max( 1e3, ceil( 1e6 * ( microtime(
true ) -
$timestamp ) ) );
403 if ( ++$attempts >= 3 &&
$sleep <= 5e5 ) {
410 $locked = $this->
add(
"{$key}:lock", 1, $expiry );
415 }
while ( !$locked && ( microtime(
true ) -
$timestamp ) < $timeout );
419 $this->locks[
$key] = [
'class' => $rclass,
'depth' => 1 ];
432 if ( isset( $this->locks[
$key] ) && --$this->locks[$key][
'depth'] <= 0 ) {
433 unset( $this->locks[$key] );
435 return $this->
delete(
"{$key}:lock" );
458 $expiry = min( $expiry ?: INF, self::TTL_DAY );
460 if ( !$this->
lock(
$key, $timeout, $expiry, $rclass ) ) {
464 $lSince = microtime(
true );
468 $age = ( microtime(
true ) - $lSince + $latency );
469 if ( ( $age + $latency ) >= $expiry ) {
470 $this->logger->warning(
"Lock for $key held too long ($age sec)." );
499 foreach ( $keys
as $key ) {
500 $val = $this->
get(
$key );
501 if ( $val !==
false ) {
532 if ( $this->
get(
$key ) ===
false ) {
548 $n = $this->
get(
$key );
551 $this->
set(
$key, max( 0, $n ) );
584 if ( $newValue ===
false ) {
586 $newValue = $this->
add(
$key, (
int)$init, $ttl ) ? $init :
false;
588 if ( $newValue ===
false ) {
610 $this->lastError = self::ERR_NONE;
619 $this->lastError = $err;
644 if ( $this->debugMode ) {
645 $this->logger->debug(
"{class} debug: $text", [
646 'class' => get_class( $this ),
657 if ( $exptime != 0 && $exptime < ( 10 * self::TTL_YEAR ) ) {
658 return time() + $exptime;
672 if ( $exptime >= ( 10 * self::TTL_YEAR ) ) {
674 if ( $exptime <= 0 ) {
704 $arg = str_replace(
':',
'%3A', $arg );
707 return strtr(
$key,
' ',
'_' );
clearLastError()
Clear the "last error" registry.
the array() calling protocol came about after MediaWiki 1.4rc1.
getWithToken($key, &$casToken, $flags=0)
trackDuplicateKeys($key)
Track the number of times that a given key has been used.
magic word the default is to use $key to get the and $key value or $key value text $key value html to format the value $key
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
callback null $asyncHandler
getScopedLock($key, $timeout=6, $expiry=30, $rclass= '')
Get a lightweight exclusive self-unlocking lock.
lock($key, $timeout=6, $expiry=6, $rclass= '')
Acquire an advisory lock on a key string.
it s the revision text itself In either if gzip is the revision text is gzipped $flags
incrWithInit($key, $ttl, $value=1, $init=1)
Increase stored value of $key by $value while preserving its TTL.
set($key, $value, $exptime=0, $flags=0)
Set an item.
getWithSetCallback($key, $ttl, $callback, $flags=0)
Get an item with the given key, regenerating and setting it if not found.
deleteObjectsExpiringBefore($date, $progressCallback=false)
Delete all objects expiring before a certain date.
modifySimpleRelayEvent(array $event)
Modify a cache update operation array for EventRelayer::notify()
getLastError()
Get the "last error" registered; clearLastError() should be called manually.
Class for asserting that a callback happens when an dummy object leaves scope.
mergeViaCas($key, $callback, $exptime=0, $attempts=10)
__construct(array $params=[])
$params include:
convertExpiry($exptime)
Convert an optionally relative time to an absolute time.
array $duplicateKeyLookups
add($key, $value, $exptime=0)
getMulti(array $keys, $flags=0)
Get an associative array containing the item for each of the keys that have items.
incr($key, $value=1)
Increase stored value of $key by $value while preserving its TTL.
const WRITE_SYNC
Bitfield constants for set()/merge()
const ERR_NONE
Possible values for getLastError()
const READ_LATEST
Bitfield constants for get()/getMulti()
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
setMulti(array $data, $exptime=0)
Batch insertion.
mergeViaLock($key, $callback, $exptime=0, $attempts=10, $flags=0)
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
merge($key, $callback, $exptime=0, $attempts=10, $flags=0)
Merge changes into the existing cache value (possibly creating a new one).
decr($key, $value=1)
Decrease stored value of $key by $value while preserving its TTL.
setLogger(LoggerInterface $logger)
convertToRelative($exptime)
Convert an optionally absolute expiry time to a relative time.
makeKey()
Make a cache key, scoped to this instance's keyspace.
cas($casToken, $key, $value, $exptime=0)
Check and set an item.
Generic base class for storage interfaces.
array[] $locks
Lock tracking.
makeKeyInternal($keyspace, $args)
Construct a cache key.
setLastError($err)
Set the "last error" registry.
unlock($key)
Release an advisory lock on a key string.
isInteger($value)
Check if a value is an integer.
makeGlobalKey()
Make a global cache key.