MediaWiki  1.29.1
RedisConnectionPool.php
Go to the documentation of this file.
1 <?php
25 use Psr\Log\LoggerAwareInterface;
26 use Psr\Log\LoggerInterface;
27 
41 class RedisConnectionPool implements LoggerAwareInterface {
43  protected $connectTimeout;
45  protected $readTimeout;
47  protected $password;
49  protected $persistent;
51  protected $serializer;
53  protected $id;
54 
56  protected $idlePoolSize = 0;
57 
59  protected $connections = [];
61  protected $downServers = [];
62 
64  protected static $instances = [];
65 
67  const SERVER_DOWN_TTL = 30;
68 
72  protected $logger;
73 
79  protected function __construct( array $options, $id ) {
80  if ( !class_exists( 'Redis' ) ) {
81  throw new RuntimeException(
82  __CLASS__ . ' requires a Redis client library. ' .
83  'See https://www.mediawiki.org/wiki/Redis#Setup' );
84  }
85  $this->logger = isset( $options['logger'] )
86  ? $options['logger']
87  : new \Psr\Log\NullLogger();
88  $this->connectTimeout = $options['connectTimeout'];
89  $this->readTimeout = $options['readTimeout'];
90  $this->persistent = $options['persistent'];
91  $this->password = $options['password'];
92  if ( !isset( $options['serializer'] ) || $options['serializer'] === 'php' ) {
93  $this->serializer = Redis::SERIALIZER_PHP;
94  } elseif ( $options['serializer'] === 'igbinary' ) {
95  $this->serializer = Redis::SERIALIZER_IGBINARY;
96  } elseif ( $options['serializer'] === 'none' ) {
97  $this->serializer = Redis::SERIALIZER_NONE;
98  } else {
99  throw new InvalidArgumentException( "Invalid serializer specified." );
100  }
101  $this->id = $id;
102  }
103 
108  public function setLogger( LoggerInterface $logger ) {
109  $this->logger = $logger;
110  }
111 
116  protected static function applyDefaultConfig( array $options ) {
117  if ( !isset( $options['connectTimeout'] ) ) {
118  $options['connectTimeout'] = 1;
119  }
120  if ( !isset( $options['readTimeout'] ) ) {
121  $options['readTimeout'] = 1;
122  }
123  if ( !isset( $options['persistent'] ) ) {
124  $options['persistent'] = false;
125  }
126  if ( !isset( $options['password'] ) ) {
127  $options['password'] = null;
128  }
129 
130  return $options;
131  }
132 
148  public static function singleton( array $options ) {
150  // Map the options to a unique hash...
151  ksort( $options ); // normalize to avoid pool fragmentation
152  $id = sha1( serialize( $options ) );
153  // Initialize the object at the hash as needed...
154  if ( !isset( self::$instances[$id] ) ) {
155  self::$instances[$id] = new self( $options, $id );
156  }
157 
158  return self::$instances[$id];
159  }
160 
165  public static function destroySingletons() {
166  self::$instances = [];
167  }
168 
178  public function getConnection( $server, LoggerInterface $logger = null ) {
180  // Check the listing "dead" servers which have had a connection errors.
181  // Servers are marked dead for a limited period of time, to
182  // avoid excessive overhead from repeated connection timeouts.
183  if ( isset( $this->downServers[$server] ) ) {
184  $now = time();
185  if ( $now > $this->downServers[$server] ) {
186  // Dead time expired
187  unset( $this->downServers[$server] );
188  } else {
189  // Server is dead
190  $logger->debug(
191  'Server "{redis_server}" is marked down for another ' .
192  ( $this->downServers[$server] - $now ) . 'seconds',
193  [ 'redis_server' => $server ]
194  );
195 
196  return false;
197  }
198  }
199 
200  // Check if a connection is already free for use
201  if ( isset( $this->connections[$server] ) ) {
202  foreach ( $this->connections[$server] as &$connection ) {
203  if ( $connection['free'] ) {
204  $connection['free'] = false;
206 
207  return new RedisConnRef(
208  $this, $server, $connection['conn'], $logger
209  );
210  }
211  }
212  }
213 
214  if ( !$server ) {
215  throw new InvalidArgumentException(
216  __CLASS__ . ": invalid configured server \"$server\"" );
217  } elseif ( substr( $server, 0, 1 ) === '/' ) {
218  // UNIX domain socket
219  // These are required by the redis extension to start with a slash, but
220  // we still need to set the port to a special value to make it work.
221  $host = $server;
222  $port = 0;
223  } else {
224  // TCP connection
225  if ( preg_match( '/^\[(.+)\]:(\d+)$/', $server, $m ) ) {
226  list( $host, $port ) = [ $m[1], (int)$m[2] ]; // (ip, port)
227  } elseif ( preg_match( '/^([^:]+):(\d+)$/', $server, $m ) ) {
228  list( $host, $port ) = [ $m[1], (int)$m[2] ]; // (ip or path, port)
229  } else {
230  list( $host, $port ) = [ $server, 6379 ]; // (ip or path, port)
231  }
232  }
233 
234  $conn = new Redis();
235  try {
236  if ( $this->persistent ) {
237  $result = $conn->pconnect( $host, $port, $this->connectTimeout, $this->id );
238  } else {
239  $result = $conn->connect( $host, $port, $this->connectTimeout );
240  }
241  if ( !$result ) {
242  $logger->error(
243  'Could not connect to server "{redis_server}"',
244  [ 'redis_server' => $server ]
245  );
246  // Mark server down for some time to avoid further timeouts
247  $this->downServers[$server] = time() + self::SERVER_DOWN_TTL;
248 
249  return false;
250  }
251  if ( $this->password !== null ) {
252  if ( !$conn->auth( $this->password ) ) {
253  $logger->error(
254  'Authentication error connecting to "{redis_server}"',
255  [ 'redis_server' => $server ]
256  );
257  }
258  }
259  } catch ( RedisException $e ) {
260  $this->downServers[$server] = time() + self::SERVER_DOWN_TTL;
261  $logger->error(
262  'Redis exception connecting to "{redis_server}"',
263  [
264  'redis_server' => $server,
265  'exception' => $e,
266  ]
267  );
268 
269  return false;
270  }
271 
272  if ( $conn ) {
273  $conn->setOption( Redis::OPT_READ_TIMEOUT, $this->readTimeout );
274  $conn->setOption( Redis::OPT_SERIALIZER, $this->serializer );
275  $this->connections[$server][] = [ 'conn' => $conn, 'free' => false ];
276 
277  return new RedisConnRef( $this, $server, $conn, $logger );
278  } else {
279  return false;
280  }
281  }
282 
290  public function freeConnection( $server, Redis $conn ) {
291  $found = false;
292 
293  foreach ( $this->connections[$server] as &$connection ) {
294  if ( $connection['conn'] === $conn && !$connection['free'] ) {
295  $connection['free'] = true;
297  break;
298  }
299  }
300 
301  $this->closeExcessIdleConections();
302 
303  return $found;
304  }
305 
309  protected function closeExcessIdleConections() {
310  if ( $this->idlePoolSize <= count( $this->connections ) ) {
311  return; // nothing to do (no more connections than servers)
312  }
313 
314  foreach ( $this->connections as &$serverConnections ) {
315  foreach ( $serverConnections as $key => &$connection ) {
316  if ( $connection['free'] ) {
317  unset( $serverConnections[$key] );
318  if ( --$this->idlePoolSize <= count( $this->connections ) ) {
319  return; // done (no more connections than servers)
320  }
321  }
322  }
323  }
324  }
325 
335  public function handleError( RedisConnRef $cref, RedisException $e ) {
336  $server = $cref->getServer();
337  $this->logger->error(
338  'Redis exception on server "{redis_server}"',
339  [
340  'redis_server' => $server,
341  'exception' => $e,
342  ]
343  );
344  foreach ( $this->connections[$server] as $key => $connection ) {
345  if ( $cref->isConnIdentical( $connection['conn'] ) ) {
346  $this->idlePoolSize -= $connection['free'] ? 1 : 0;
347  unset( $this->connections[$server][$key] );
348  break;
349  }
350  }
351  }
352 
369  public function reauthenticateConnection( $server, Redis $conn ) {
370  if ( $this->password !== null ) {
371  if ( !$conn->auth( $this->password ) ) {
372  $this->logger->error(
373  'Authentication error connecting to "{redis_server}"',
374  [ 'redis_server' => $server ]
375  );
376 
377  return false;
378  }
379  }
380 
381  return true;
382  }
383 
390  public function resetTimeout( Redis $conn, $timeout = null ) {
391  $conn->setOption( Redis::OPT_READ_TIMEOUT, $timeout ?: $this->readTimeout );
392  }
393 
397  function __destruct() {
398  foreach ( $this->connections as $server => &$serverConnections ) {
399  foreach ( $serverConnections as $key => &$connection ) {
401  $conn = $connection['conn'];
402  $conn->close();
403  }
404  }
405  }
406 }
RedisConnectionPool\freeConnection
freeConnection( $server, Redis $conn)
Mark a connection to a server as free to return to the pool.
Definition: RedisConnectionPool.php:290
RedisConnectionPool\SERVER_DOWN_TTL
const SERVER_DOWN_TTL
integer; seconds to cache servers as "down".
Definition: RedisConnectionPool.php:67
RedisConnectionPool\$downServers
array $downServers
(server name => UNIX timestamp)
Definition: RedisConnectionPool.php:61
RedisConnectionPool\singleton
static singleton(array $options)
Definition: RedisConnectionPool.php:148
false
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:189
captcha-old.count
count
Definition: captcha-old.py:225
RedisConnectionPool\$connections
array $connections
(server name => ((connection info array),...)
Definition: RedisConnectionPool.php:59
$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 '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! 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! 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:1954
RedisConnectionPool\handleError
handleError(RedisConnRef $cref, RedisException $e)
The redis extension throws an exception in response to various read, write and protocol errors.
Definition: RedisConnectionPool.php:335
use
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
Definition: MIT-LICENSE.txt:10
serialize
serialize()
Definition: ApiMessage.php:177
RedisConnectionPool\resetTimeout
resetTimeout(Redis $conn, $timeout=null)
Adjust or reset the connection handle read timeout value.
Definition: RedisConnectionPool.php:390
RedisConnectionPool\destroySingletons
static destroySingletons()
Destroy all singleton() instances.
Definition: RedisConnectionPool.php:165
RedisConnectionPool\$logger
LoggerInterface $logger
Definition: RedisConnectionPool.php:72
RedisConnectionPool\__construct
__construct(array $options, $id)
Definition: RedisConnectionPool.php:79
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
RedisConnRef\isConnIdentical
isConnIdentical(Redis $conn)
Definition: RedisConnRef.php:175
RedisConnectionPool\closeExcessIdleConections
closeExcessIdleConections()
Close any extra idle connections if there are more than the limit.
Definition: RedisConnectionPool.php:309
RedisConnectionPool\$instances
static array $instances
(pool ID => RedisConnectionPool)
Definition: RedisConnectionPool.php:64
RedisConnectionPool\$password
string $password
Plaintext auth password.
Definition: RedisConnectionPool.php:47
RedisConnectionPool\$serializer
int $serializer
Serializer to use (Redis::SERIALIZER_*)
Definition: RedisConnectionPool.php:51
RedisConnectionPool\getConnection
getConnection( $server, LoggerInterface $logger=null)
Get a connection to a redis server.
Definition: RedisConnectionPool.php:178
RedisConnectionPool\applyDefaultConfig
static applyDefaultConfig(array $options)
Definition: RedisConnectionPool.php:116
RedisConnectionPool\$readTimeout
string $readTimeout
Read timeout in seconds.
Definition: RedisConnectionPool.php:45
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
RedisConnectionPool\setLogger
setLogger(LoggerInterface $logger)
Definition: RedisConnectionPool.php:108
RedisConnectionPool\$idlePoolSize
int $idlePoolSize
Current idle pool size.
Definition: RedisConnectionPool.php:56
RedisConnectionPool\$id
string $id
ID for persistent connections.
Definition: RedisConnectionPool.php:53
RedisConnectionPool
Helper class to manage Redis connections.
Definition: RedisConnectionPool.php:41
$e
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Definition: hooks.txt:2122
RedisConnectionPool\reauthenticateConnection
reauthenticateConnection( $server, Redis $conn)
Re-send an AUTH request to the redis server (useful after disconnects).
Definition: RedisConnectionPool.php:369
RedisConnectionPool\$connectTimeout
string $connectTimeout
Connection timeout in seconds.
Definition: RedisConnectionPool.php:43
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:32
RedisConnectionPool\$persistent
bool $persistent
Whether connections persist.
Definition: RedisConnectionPool.php:49
RedisConnectionPool\__destruct
__destruct()
Make sure connections are closed for sanity.
Definition: RedisConnectionPool.php:397
RedisConnRef\getServer
getServer()
Definition: RedisConnRef.php:69
$options
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 you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context $options
Definition: hooks.txt:1049
array
the array() calling protocol came about after MediaWiki 1.4rc1.