29use Psr\Log\LoggerAwareInterface;
30use Psr\Log\LoggerInterface;
31use Psr\Log\NullLogger;
32use Wikimedia\ScopedCallback;
33use Wikimedia\WaitConditionLoop;
101 if ( isset(
$params[
'logger'] ) ) {
107 if ( isset(
$params[
'keyspace'] ) ) {
108 $this->keyspace =
$params[
'keyspace'];
111 $this->asyncHandler = isset(
$params[
'asyncHandler'] )
115 if ( !empty(
$params[
'reportDupes'] ) && is_callable( $this->asyncHandler ) ) {
116 $this->reportDupes =
true;
119 $this->syncTimeout = isset(
$params[
'syncTimeout'] ) ?
$params[
'syncTimeout'] : 3;
127 $this->logger = $logger;
134 $this->debugMode = $bool;
153 if ( !is_callable( $callback ) ) {
154 throw new InvalidArgumentException(
"Invalid cache miss callback provided." );
156 $value = call_user_func( $callback );
158 $this->
set( $key,
$value, $ttl );
179 public function get( $key,
$flags = 0, $oldFlags = null ) {
193 if ( !$this->reportDupes ) {
197 if ( !isset( $this->duplicateKeyLookups[$key] ) ) {
200 $this->duplicateKeyLookups[$key] = 0;
202 $this->duplicateKeyLookups[$key] += 1;
204 if ( $this->dupeTrackScheduled ===
false ) {
205 $this->dupeTrackScheduled =
true;
207 call_user_func( $this->asyncHandler,
function () {
208 $dups = array_filter( $this->duplicateKeyLookups );
209 foreach ( $dups
as $key => $count ) {
210 $this->logger->warning(
211 'Duplicate get(): "{key}" fetched {count} times',
213 [
'key' => $key,
'count' => $count + 1, ]
238 throw new Exception( __METHOD__ .
' not implemented.' );
250 abstract public function set( $key,
$value, $exptime = 0,
$flags = 0 );
258 abstract public function delete( $key );
276 public function merge( $key, callable $callback, $exptime = 0, $attempts = 10,
$flags = 0 ) {
289 protected function mergeViaCas( $key, $callback, $exptime = 0, $attempts = 10 ) {
293 $this->reportDupes =
false;
295 $currentValue = $this->
getWithToken( $key, $casToken, self::READ_LATEST );
303 $value = call_user_func( $callback, $this, $key, $currentValue, $exptime );
308 } elseif ( $currentValue ===
false ) {
318 }
while ( !
$success && --$attempts );
333 protected function cas( $casToken, $key,
$value, $exptime = 0 ) {
334 throw new Exception(
"CAS is not implemented in " . __CLASS__ );
348 if ( !$this->
lock( $key, 6 ) ) {
354 $this->reportDupes =
false;
355 $currentValue = $this->
get( $key, self::READ_LATEST );
362 $value = call_user_func( $callback, $this, $key, $currentValue, $exptime );
370 if ( !$this->
unlock( $key ) ) {
372 trigger_error(
"Could not release lock for key '$key'." );
387 $value = $this->
get( $key );
403 public function lock( $key, $timeout = 6, $expiry = 6, $rclass =
'' ) {
405 if ( isset( $this->locks[$key] ) ) {
406 if ( $rclass !=
'' && $this->locks[$key][
'class'] === $rclass ) {
407 ++$this->locks[$key][
'depth'];
414 $expiry = min( $expiry ?: INF, self::TTL_DAY );
415 $loop =
new WaitConditionLoop(
416 function ()
use ( $key, $timeout, $expiry ) {
418 if ( $this->
add(
"{$key}:lock", 1, $expiry ) ) {
421 return WaitConditionLoop::CONDITION_ABORTED;
424 return WaitConditionLoop::CONDITION_CONTINUE;
429 $locked = ( $loop->invoke() === $loop::CONDITION_REACHED );
431 $this->locks[$key] = [
'class' => $rclass,
'depth' => 1 ];
444 if ( isset( $this->locks[$key] ) && --$this->locks[$key][
'depth'] <= 0 ) {
445 unset( $this->locks[$key] );
447 return $this->
delete(
"{$key}:lock" );
469 final public function getScopedLock( $key, $timeout = 6, $expiry = 30, $rclass =
'' ) {
470 $expiry = min( $expiry ?: INF, self::TTL_DAY );
472 if ( !$this->
lock( $key, $timeout, $expiry, $rclass ) ) {
476 $lSince = microtime(
true );
478 return new ScopedCallback(
function ()
use ( $key, $lSince, $expiry ) {
480 $age = ( microtime(
true ) - $lSince + $latency );
481 if ( ( $age + $latency ) >= $expiry ) {
482 $this->logger->warning(
"Lock for $key held too long ($age sec)." );
512 $val = $this->
get( $key );
513 if ( $val !==
false ) {
529 foreach ( $data
as $key =>
$value ) {
530 if ( !$this->
set( $key,
$value, $exptime ) ) {
544 if ( $this->
get( $key ) ===
false ) {
545 return $this->
set( $key,
$value, $exptime );
557 if ( !$this->
lock( $key ) ) {
560 $n = $this->
get( $key );
563 $this->
set( $key, max( 0, $n ) );
596 if ( $newValue ===
false ) {
598 $newValue = $this->
add( $key, (
int)$init, $ttl ) ? $init :
false;
600 if ( $newValue ===
false ) {
614 return $this->lastError;
622 $this->lastError = self::ERR_NONE;
631 $this->lastError = $err;
655 $this->busyCallbacks[] = $workCallback;
680 if ( $this->debugMode ) {
681 $this->logger->debug(
"{class} debug: $text", [
682 'class' => static::class,
693 if ( $exptime != 0 && $exptime < ( 10 * self::TTL_YEAR ) ) {
694 return time() + $exptime;
708 if ( $exptime >= ( 10 * self::TTL_YEAR ) ) {
710 if ( $exptime <= 0 ) {
740 $arg = str_replace(
':',
'%3A', $arg );
741 $key = $key .
':' . $arg;
743 return strtr( $key,
' ',
'_' );
774 return isset( $this->attrMap[$flag] ) ? $this->attrMap[$flag] : self::QOS_UNKNOWN;
785 foreach ( $bags
as $bag ) {
786 foreach ( $bag->attrMap
as $attr => $rank ) {
787 if ( isset( $map[$attr] ) ) {
788 $map[$attr] = min( $map[$attr], $rank );
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
interface is intended to be more or less compatible with the PHP memcached client.
int[] $attrMap
Map of (ATTR_* class constant => QOS_* class constant)
getWithSetCallback( $key, $ttl, $callback, $flags=0)
Get an item with the given key, regenerating and setting it if not found.
__construct(array $params=[])
$params include:
getScopedLock( $key, $timeout=6, $expiry=30, $rclass='')
Get a lightweight exclusive self-unlocking lock.
unlock( $key)
Release an advisory lock on a key string.
incrWithInit( $key, $ttl, $value=1, $init=1)
Increase stored value of $key by $value while preserving its TTL.
isInteger( $value)
Check if a value is an integer.
lock( $key, $timeout=6, $expiry=6, $rclass='')
Acquire an advisory lock on a key string.
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.
decr( $key, $value=1)
Decrease stored value of $key by $value while preserving its TTL.
modifySimpleRelayEvent(array $event)
Modify a cache update operation array for EventRelayer::notify()
const READ_LATEST
Bitfield constants for get()/getMulti()
deleteObjectsExpiringBefore( $date, $progressCallback=false)
Delete all objects expiring before a certain date.
trackDuplicateKeys( $key)
Track the number of times that a given key has been used.
convertExpiry( $exptime)
Convert an optionally relative time to an absolute time.
callable[] $busyCallbacks
callback null $asyncHandler
getWithToken( $key, &$casToken, $flags=0)
setMulti(array $data, $exptime=0)
Batch insertion.
const ERR_NONE
Possible values for getLastError()
convertToRelative( $exptime)
Convert an optionally absolute expiry time to a relative time.
setLogger(LoggerInterface $logger)
makeGlobalKey()
Make a global cache key.
const WRITE_SYNC
Bitfield constants for set()/merge()
mergeFlagMaps(array $bags)
Merge the flag maps of one or more BagOStuff objects into a "lowest common denominator" map.
getLastError()
Get the "last error" registered; clearLastError() should be called manually.
makeKey()
Make a cache key, scoped to this instance's keyspace.
setLastError( $err)
Set the "last error" registry.
changeTTL( $key, $expiry=0)
Reset the TTL on a key if it exists.
mergeViaLock( $key, $callback, $exptime=0, $attempts=10, $flags=0)
clearLastError()
Clear the "last error" registry.
addBusyCallback(callable $workCallback)
Let a callback be run to avoid wasting time on special blocking calls.
cas( $casToken, $key, $value, $exptime=0)
Check and set an item.
makeKeyInternal( $keyspace, $args)
Construct a cache key.
int $lastError
ERR_* class constant.
array[] $locks
Lock tracking.
mergeViaCas( $key, $callback, $exptime=0, $attempts=10)
incr( $key, $value=1)
Increase stored value of $key by $value while preserving its TTL.
merge( $key, callable $callback, $exptime=0, $attempts=10, $flags=0)
Merge changes into the existing cache value (possibly creating a new one)
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
the array() calling protocol came about after MediaWiki 1.4rc1.
it s the revision text itself In either if gzip is the revision text is gzipped $flags
processing should stop and the error should be shown to the user * false
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
Generic base class for storage interfaces.