MediaWiki  1.32.0
RedisBagOStuff.php
Go to the documentation of this file.
1 <?php
31 class RedisBagOStuff extends BagOStuff {
33  protected $redisPool;
35  protected $servers;
37  protected $serverTagMap;
39  protected $automaticFailover;
40 
69  function __construct( $params ) {
70  parent::__construct( $params );
71  $redisConf = [ 'serializer' => 'none' ]; // manage that in this class
72  foreach ( [ 'connectTimeout', 'persistent', 'password' ] as $opt ) {
73  if ( isset( $params[$opt] ) ) {
74  $redisConf[$opt] = $params[$opt];
75  }
76  }
77  $this->redisPool = RedisConnectionPool::singleton( $redisConf );
78 
79  $this->servers = $params['servers'];
80  foreach ( $this->servers as $key => $server ) {
81  $this->serverTagMap[is_int( $key ) ? $server : $key] = $server;
82  }
83 
84  if ( isset( $params['automaticFailover'] ) ) {
85  $this->automaticFailover = $params['automaticFailover'];
86  } else {
87  $this->automaticFailover = true;
88  }
89 
91  }
92 
93  protected function doGet( $key, $flags = 0 ) {
94  $casToken = null;
95 
96  return $this->getWithToken( $key, $casToken, $flags );
97  }
98 
99  protected function getWithToken( $key, &$casToken, $flags = 0 ) {
100  list( $server, $conn ) = $this->getConnection( $key );
101  if ( !$conn ) {
102  return false;
103  }
104  try {
105  $value = $conn->get( $key );
106  $casToken = $value;
107  $result = $this->unserialize( $value );
108  } catch ( RedisException $e ) {
109  $result = false;
110  $this->handleException( $conn, $e );
111  }
112 
113  $this->logRequest( 'get', $key, $server, $result );
114  return $result;
115  }
116 
117  public function set( $key, $value, $expiry = 0, $flags = 0 ) {
118  list( $server, $conn ) = $this->getConnection( $key );
119  if ( !$conn ) {
120  return false;
121  }
122  $expiry = $this->convertToRelative( $expiry );
123  try {
124  if ( $expiry ) {
125  $result = $conn->setex( $key, $expiry, $this->serialize( $value ) );
126  } else {
127  // No expiry, that is very different from zero expiry in Redis
128  $result = $conn->set( $key, $this->serialize( $value ) );
129  }
130  } catch ( RedisException $e ) {
131  $result = false;
132  $this->handleException( $conn, $e );
133  }
134 
135  $this->logRequest( 'set', $key, $server, $result );
136  return $result;
137  }
138 
139  public function delete( $key ) {
140  list( $server, $conn ) = $this->getConnection( $key );
141  if ( !$conn ) {
142  return false;
143  }
144  try {
145  $conn->delete( $key );
146  // Return true even if the key didn't exist
147  $result = true;
148  } catch ( RedisException $e ) {
149  $result = false;
150  $this->handleException( $conn, $e );
151  }
152 
153  $this->logRequest( 'delete', $key, $server, $result );
154  return $result;
155  }
156 
157  public function getMulti( array $keys, $flags = 0 ) {
158  $batches = [];
159  $conns = [];
160  foreach ( $keys as $key ) {
161  list( $server, $conn ) = $this->getConnection( $key );
162  if ( !$conn ) {
163  continue;
164  }
165  $conns[$server] = $conn;
166  $batches[$server][] = $key;
167  }
168  $result = [];
169  foreach ( $batches as $server => $batchKeys ) {
170  $conn = $conns[$server];
171  try {
172  $conn->multi( Redis::PIPELINE );
173  foreach ( $batchKeys as $key ) {
174  $conn->get( $key );
175  }
176  $batchResult = $conn->exec();
177  if ( $batchResult === false ) {
178  $this->debug( "multi request to $server failed" );
179  continue;
180  }
181  foreach ( $batchResult as $i => $value ) {
182  if ( $value !== false ) {
183  $result[$batchKeys[$i]] = $this->unserialize( $value );
184  }
185  }
186  } catch ( RedisException $e ) {
187  $this->handleException( $conn, $e );
188  }
189  }
190 
191  $this->debug( "getMulti for " . count( $keys ) . " keys " .
192  "returned " . count( $result ) . " results" );
193  return $result;
194  }
195 
201  public function setMulti( array $data, $expiry = 0 ) {
202  $batches = [];
203  $conns = [];
204  foreach ( $data as $key => $value ) {
205  list( $server, $conn ) = $this->getConnection( $key );
206  if ( !$conn ) {
207  continue;
208  }
209  $conns[$server] = $conn;
210  $batches[$server][] = $key;
211  }
212 
213  $expiry = $this->convertToRelative( $expiry );
214  $result = true;
215  foreach ( $batches as $server => $batchKeys ) {
216  $conn = $conns[$server];
217  try {
218  $conn->multi( Redis::PIPELINE );
219  foreach ( $batchKeys as $key ) {
220  if ( $expiry ) {
221  $conn->setex( $key, $expiry, $this->serialize( $data[$key] ) );
222  } else {
223  $conn->set( $key, $this->serialize( $data[$key] ) );
224  }
225  }
226  $batchResult = $conn->exec();
227  if ( $batchResult === false ) {
228  $this->debug( "setMulti request to $server failed" );
229  continue;
230  }
231  foreach ( $batchResult as $value ) {
232  if ( $value === false ) {
233  $result = false;
234  }
235  }
236  } catch ( RedisException $e ) {
237  $this->handleException( $server, $conn, $e );
238  $result = false;
239  }
240  }
241 
242  return $result;
243  }
244 
245  public function add( $key, $value, $expiry = 0 ) {
246  list( $server, $conn ) = $this->getConnection( $key );
247  if ( !$conn ) {
248  return false;
249  }
250  $expiry = $this->convertToRelative( $expiry );
251  try {
252  if ( $expiry ) {
253  $result = $conn->set(
254  $key,
255  $this->serialize( $value ),
256  [ 'nx', 'ex' => $expiry ]
257  );
258  } else {
259  $result = $conn->setnx( $key, $this->serialize( $value ) );
260  }
261  } catch ( RedisException $e ) {
262  $result = false;
263  $this->handleException( $conn, $e );
264  }
265 
266  $this->logRequest( 'add', $key, $server, $result );
267  return $result;
268  }
269 
270  public function merge( $key, callable $callback, $exptime = 0, $attempts = 10, $flags = 0 ) {
271  return $this->mergeViaCas( $key, $callback, $exptime, $attempts );
272  }
273 
286  public function incr( $key, $value = 1 ) {
287  list( $server, $conn ) = $this->getConnection( $key );
288  if ( !$conn ) {
289  return false;
290  }
291  try {
292  if ( !$conn->exists( $key ) ) {
293  return false;
294  }
295  // @FIXME: on races, the key may have a 0 TTL
296  $result = $conn->incrBy( $key, $value );
297  } catch ( RedisException $e ) {
298  $result = false;
299  $this->handleException( $conn, $e );
300  }
301 
302  $this->logRequest( 'incr', $key, $server, $result );
303  return $result;
304  }
305 
306  public function changeTTL( $key, $expiry = 0 ) {
307  list( $server, $conn ) = $this->getConnection( $key );
308  if ( !$conn ) {
309  return false;
310  }
311 
312  $expiry = $this->convertToRelative( $expiry );
313  try {
314  $result = $conn->expire( $key, $expiry );
315  } catch ( RedisException $e ) {
316  $result = false;
317  $this->handleException( $conn, $e );
318  }
319 
320  $this->logRequest( 'expire', $key, $server, $result );
321  return $result;
322  }
323 
324  public function modifySimpleRelayEvent( array $event ) {
325  if ( array_key_exists( 'val', $event ) ) {
326  $event['val'] = serialize( $event['val'] ); // this class uses PHP serialization
327  }
328 
329  return $event;
330  }
331 
336  protected function serialize( $data ) {
337  // Serialize anything but integers so INCR/DECR work
338  // Do not store integer-like strings as integers to avoid type confusion (T62563)
339  return is_int( $data ) ? $data : serialize( $data );
340  }
341 
346  protected function unserialize( $data ) {
347  $int = intval( $data );
348  return $data === (string)$int ? $int : unserialize( $data );
349  }
350 
356  protected function getConnection( $key ) {
357  $candidates = array_keys( $this->serverTagMap );
358 
359  if ( count( $this->servers ) > 1 ) {
360  ArrayUtils::consistentHashSort( $candidates, $key, '/' );
361  if ( !$this->automaticFailover ) {
362  $candidates = array_slice( $candidates, 0, 1 );
363  }
364  }
365 
366  while ( ( $tag = array_shift( $candidates ) ) !== null ) {
367  $server = $this->serverTagMap[$tag];
368  $conn = $this->redisPool->getConnection( $server, $this->logger );
369  if ( !$conn ) {
370  continue;
371  }
372 
373  // If automatic failover is enabled, check that the server's link
374  // to its master (if any) is up -- but only if there are other
375  // viable candidates left to consider. Also, getMasterLinkStatus()
376  // does not work with twemproxy, though $candidates will be empty
377  // by now in such cases.
378  if ( $this->automaticFailover && $candidates ) {
379  try {
380  if ( $this->getMasterLinkStatus( $conn ) === 'down' ) {
381  // If the master cannot be reached, fail-over to the next server.
382  // If masters are in data-center A, and replica DBs in data-center B,
383  // this helps avoid the case were fail-over happens in A but not
384  // to the corresponding server in B (e.g. read/write mismatch).
385  continue;
386  }
387  } catch ( RedisException $e ) {
388  // Server is not accepting commands
389  $this->handleException( $conn, $e );
390  continue;
391  }
392  }
393 
394  return [ $server, $conn ];
395  }
396 
398 
399  return [ false, false ];
400  }
401 
408  protected function getMasterLinkStatus( RedisConnRef $conn ) {
409  $info = $conn->info();
410  return $info['master_link_status'] ?? null;
411  }
412 
417  protected function logError( $msg ) {
418  $this->logger->error( "Redis error: $msg" );
419  }
420 
429  protected function handleException( RedisConnRef $conn, $e ) {
431  $this->redisPool->handleError( $conn, $e );
432  }
433 
441  public function logRequest( $method, $key, $server, $result ) {
442  $this->debug( "$method $key on $server: " .
443  ( $result === false ? "failure" : "success" ) );
444  }
445 }
ArrayUtils\consistentHashSort
static consistentHashSort(&$array, $key, $separator="\000")
Sort the given array in a pseudo-random order which depends only on the given key and each element va...
Definition: ArrayUtils.php:49
RedisBagOStuff
Redis-based caching module for redis server >= 2.6.12.
Definition: RedisBagOStuff.php:31
RedisConnectionPool\singleton
static singleton(array $options)
Definition: RedisConnectionPool.php:145
RedisBagOStuff\setMulti
setMulti(array $data, $expiry=0)
Definition: RedisBagOStuff.php:201
false
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:187
RedisBagOStuff\changeTTL
changeTTL( $key, $expiry=0)
Reset the TTL on a key if it exists.
Definition: RedisBagOStuff.php:306
servers
storage can be distributed across multiple servers
Definition: memcached.txt:33
RedisBagOStuff\incr
incr( $key, $value=1)
Non-atomic implementation of incr().
Definition: RedisBagOStuff.php:286
BagOStuff\ERR_UNREACHABLE
const ERR_UNREACHABLE
Definition: BagOStuff.php:93
$opt
$opt
Definition: postprocess-phan.php:115
captcha-old.count
count
Definition: captcha-old.py:249
RedisBagOStuff\getMulti
getMulti(array $keys, $flags=0)
Get an associative array containing the item for each of the keys that have items.
Definition: RedisBagOStuff.php:157
$result
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetMagic':DEPRECATED since 1.16! Use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language & $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetSpecialPageAliases':DEPRECATED! Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language & $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED since 1.28! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:2034
RedisBagOStuff\unserialize
unserialize( $data)
Definition: RedisBagOStuff.php:346
BagOStuff\debug
debug( $text)
Definition: BagOStuff.php:756
RedisBagOStuff\$redisPool
RedisConnectionPool $redisPool
Definition: RedisBagOStuff.php:33
$params
$params
Definition: styleTest.css.php:44
BagOStuff
Class representing a cache/ephemeral data store.
Definition: BagOStuff.php:58
RedisBagOStuff\$automaticFailover
bool $automaticFailover
Definition: RedisBagOStuff.php:39
RedisBagOStuff\$servers
array $servers
List of server names.
Definition: RedisBagOStuff.php:35
RedisBagOStuff\getWithToken
getWithToken( $key, &$casToken, $flags=0)
Definition: RedisBagOStuff.php:99
php
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
RedisBagOStuff\doGet
doGet( $key, $flags=0)
Definition: RedisBagOStuff.php:93
RedisBagOStuff\add
add( $key, $value, $expiry=0)
Definition: RedisBagOStuff.php:245
RedisBagOStuff\getConnection
getConnection( $key)
Get a Redis object with a connection suitable for fetching the specified key.
Definition: RedisBagOStuff.php:356
RedisBagOStuff\logError
logError( $msg)
Log a fatal error.
Definition: RedisBagOStuff.php:417
RedisBagOStuff\merge
merge( $key, callable $callback, $exptime=0, $attempts=10, $flags=0)
Merge changes into the existing cache value (possibly creating a new one)
Definition: RedisBagOStuff.php:270
RedisBagOStuff\logRequest
logRequest( $method, $key, $server, $result)
Send information about a single request to the debug log.
Definition: RedisBagOStuff.php:441
array
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))
string
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
RedisBagOStuff\serialize
serialize( $data)
Definition: RedisBagOStuff.php:336
list
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
RedisBagOStuff\handleException
handleException(RedisConnRef $conn, $e)
The redis extension throws an exception in response to various read, write and protocol errors.
Definition: RedisBagOStuff.php:429
RedisConnectionPool
Helper class to manage Redis connections.
Definition: RedisConnectionPool.php:40
$e
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Definition: hooks.txt:2213
$value
$value
Definition: styleTest.css.php:49
RedisBagOStuff\$serverTagMap
array $serverTagMap
Map of (tag => server name)
Definition: RedisBagOStuff.php:37
IExpiringStore\ATTR_SYNCWRITES
const ATTR_SYNCWRITES
Definition: IExpiringStore.php:52
BagOStuff\mergeViaCas
mergeViaCas( $key, $callback, $exptime=0, $attempts=10)
Definition: BagOStuff.php:301
RedisBagOStuff\getMasterLinkStatus
getMasterLinkStatus(RedisConnRef $conn)
Check the master link status of a Redis server that is configured as a replica DB.
Definition: RedisBagOStuff.php:408
RedisBagOStuff\__construct
__construct( $params)
Construct a RedisBagOStuff object.
Definition: RedisBagOStuff.php:69
as
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
Helper class to handle automatically marking connectons as reusable (via RAII pattern)
Definition: RedisConnRef.php:31
$keys
$keys
Definition: testCompression.php:67
IExpiringStore\QOS_SYNCWRITES_NONE
const QOS_SYNCWRITES_NONE
Definition: IExpiringStore.php:53
BagOStuff\setLastError
setLastError( $err)
Set the "last error" registry.
Definition: BagOStuff.php:707
BagOStuff\ERR_UNEXPECTED
const ERR_UNEXPECTED
Definition: BagOStuff.php:94
RedisBagOStuff\modifySimpleRelayEvent
modifySimpleRelayEvent(array $event)
Modify a cache update operation array for EventRelayer::notify()
Definition: RedisBagOStuff.php:324
BagOStuff\convertToRelative
convertToRelative( $exptime)
Convert an optionally absolute expiry time to a relative time.
Definition: BagOStuff.php:784