MediaWiki  REL1_31
RedisConnectionPool.php
Go to the documentation of this file.
1 <?php
24 use Psr\Log\LoggerAwareInterface;
25 use Psr\Log\LoggerInterface;
26 
40 class RedisConnectionPool implements LoggerAwareInterface {
42  protected $connectTimeout;
44  protected $readTimeout;
46  protected $password;
48  protected $persistent;
50  protected $serializer;
52  protected $id;
53 
55  protected $idlePoolSize = 0;
56 
58  protected $connections = [];
60  protected $downServers = [];
61 
63  protected static $instances = [];
64 
66  const SERVER_DOWN_TTL = 30;
67 
71  protected $logger;
72 
78  protected function __construct( array $options, $id ) {
79  if ( !class_exists( 'Redis' ) ) {
80  throw new RuntimeException(
81  __CLASS__ . ' requires a Redis client library. ' .
82  'See https://www.mediawiki.org/wiki/Redis#Setup' );
83  }
84  $this->logger = isset( $options['logger'] )
85  ? $options['logger']
86  : new \Psr\Log\NullLogger();
87  $this->connectTimeout = $options['connectTimeout'];
88  $this->readTimeout = $options['readTimeout'];
89  $this->persistent = $options['persistent'];
90  $this->password = $options['password'];
91  if ( !isset( $options['serializer'] ) || $options['serializer'] === 'php' ) {
92  $this->serializer = Redis::SERIALIZER_PHP;
93  } elseif ( $options['serializer'] === 'igbinary' ) {
94  $this->serializer = Redis::SERIALIZER_IGBINARY;
95  } elseif ( $options['serializer'] === 'none' ) {
96  $this->serializer = Redis::SERIALIZER_NONE;
97  } else {
98  throw new InvalidArgumentException( "Invalid serializer specified." );
99  }
100  $this->id = $id;
101  }
102 
107  public function setLogger( LoggerInterface $logger ) {
108  $this->logger = $logger;
109  }
110 
115  protected static function applyDefaultConfig( array $options ) {
116  if ( !isset( $options['connectTimeout'] ) ) {
117  $options['connectTimeout'] = 1;
118  }
119  if ( !isset( $options['readTimeout'] ) ) {
120  $options['readTimeout'] = 1;
121  }
122  if ( !isset( $options['persistent'] ) ) {
123  $options['persistent'] = false;
124  }
125  if ( !isset( $options['password'] ) ) {
126  $options['password'] = null;
127  }
128 
129  return $options;
130  }
131 
147  public static function singleton( array $options ) {
149  // Map the options to a unique hash...
150  ksort( $options ); // normalize to avoid pool fragmentation
151  $id = sha1( serialize( $options ) );
152  // Initialize the object at the hash as needed...
153  if ( !isset( self::$instances[$id] ) ) {
154  self::$instances[$id] = new self( $options, $id );
155  }
156 
157  return self::$instances[$id];
158  }
159 
164  public static function destroySingletons() {
165  self::$instances = [];
166  }
167 
177  public function getConnection( $server, LoggerInterface $logger = null ) {
179  // Check the listing "dead" servers which have had a connection errors.
180  // Servers are marked dead for a limited period of time, to
181  // avoid excessive overhead from repeated connection timeouts.
182  if ( isset( $this->downServers[$server] ) ) {
183  $now = time();
184  if ( $now > $this->downServers[$server] ) {
185  // Dead time expired
186  unset( $this->downServers[$server] );
187  } else {
188  // Server is dead
189  $logger->debug(
190  'Server "{redis_server}" is marked down for another ' .
191  ( $this->downServers[$server] - $now ) . 'seconds',
192  [ 'redis_server' => $server ]
193  );
194 
195  return false;
196  }
197  }
198 
199  // Check if a connection is already free for use
200  if ( isset( $this->connections[$server] ) ) {
201  foreach ( $this->connections[$server] as &$connection ) {
202  if ( $connection['free'] ) {
203  $connection['free'] = false;
205 
206  return new RedisConnRef(
207  $this, $server, $connection['conn'], $logger
208  );
209  }
210  }
211  }
212 
213  if ( !$server ) {
214  throw new InvalidArgumentException(
215  __CLASS__ . ": invalid configured server \"$server\"" );
216  } elseif ( substr( $server, 0, 1 ) === '/' ) {
217  // UNIX domain socket
218  // These are required by the redis extension to start with a slash, but
219  // we still need to set the port to a special value to make it work.
220  $host = $server;
221  $port = 0;
222  } else {
223  // TCP connection
224  if ( preg_match( '/^\[(.+)\]:(\d+)$/', $server, $m ) ) {
225  list( $host, $port ) = [ $m[1], (int)$m[2] ]; // (ip, port)
226  } elseif ( preg_match( '/^([^:]+):(\d+)$/', $server, $m ) ) {
227  list( $host, $port ) = [ $m[1], (int)$m[2] ]; // (ip or path, port)
228  } else {
229  list( $host, $port ) = [ $server, 6379 ]; // (ip or path, port)
230  }
231  }
232 
233  $conn = new Redis();
234  try {
235  if ( $this->persistent ) {
236  $result = $conn->pconnect( $host, $port, $this->connectTimeout, $this->id );
237  } else {
238  $result = $conn->connect( $host, $port, $this->connectTimeout );
239  }
240  if ( !$result ) {
241  $logger->error(
242  'Could not connect to server "{redis_server}"',
243  [ 'redis_server' => $server ]
244  );
245  // Mark server down for some time to avoid further timeouts
246  $this->downServers[$server] = time() + self::SERVER_DOWN_TTL;
247 
248  return false;
249  }
250  if ( $this->password !== null ) {
251  if ( !$conn->auth( $this->password ) ) {
252  $logger->error(
253  'Authentication error connecting to "{redis_server}"',
254  [ 'redis_server' => $server ]
255  );
256  }
257  }
258  } catch ( RedisException $e ) {
259  $this->downServers[$server] = time() + self::SERVER_DOWN_TTL;
260  $logger->error(
261  'Redis exception connecting to "{redis_server}"',
262  [
263  'redis_server' => $server,
264  'exception' => $e,
265  ]
266  );
267 
268  return false;
269  }
270 
271  if ( $conn ) {
272  $conn->setOption( Redis::OPT_READ_TIMEOUT, $this->readTimeout );
273  $conn->setOption( Redis::OPT_SERIALIZER, $this->serializer );
274  $this->connections[$server][] = [ 'conn' => $conn, 'free' => false ];
275 
276  return new RedisConnRef( $this, $server, $conn, $logger );
277  } else {
278  return false;
279  }
280  }
281 
289  public function freeConnection( $server, Redis $conn ) {
290  $found = false;
291 
292  foreach ( $this->connections[$server] as &$connection ) {
293  if ( $connection['conn'] === $conn && !$connection['free'] ) {
294  $connection['free'] = true;
296  break;
297  }
298  }
299 
300  $this->closeExcessIdleConections();
301 
302  return $found;
303  }
304 
308  protected function closeExcessIdleConections() {
309  if ( $this->idlePoolSize <= count( $this->connections ) ) {
310  return; // nothing to do (no more connections than servers)
311  }
312 
313  foreach ( $this->connections as &$serverConnections ) {
314  foreach ( $serverConnections as $key => &$connection ) {
315  if ( $connection['free'] ) {
316  unset( $serverConnections[$key] );
317  if ( --$this->idlePoolSize <= count( $this->connections ) ) {
318  return; // done (no more connections than servers)
319  }
320  }
321  }
322  }
323  }
324 
334  public function handleError( RedisConnRef $cref, RedisException $e ) {
335  $server = $cref->getServer();
336  $this->logger->error(
337  'Redis exception on server "{redis_server}"',
338  [
339  'redis_server' => $server,
340  'exception' => $e,
341  ]
342  );
343  foreach ( $this->connections[$server] as $key => $connection ) {
344  if ( $cref->isConnIdentical( $connection['conn'] ) ) {
345  $this->idlePoolSize -= $connection['free'] ? 1 : 0;
346  unset( $this->connections[$server][$key] );
347  break;
348  }
349  }
350  }
351 
368  public function reauthenticateConnection( $server, Redis $conn ) {
369  if ( $this->password !== null ) {
370  if ( !$conn->auth( $this->password ) ) {
371  $this->logger->error(
372  'Authentication error connecting to "{redis_server}"',
373  [ 'redis_server' => $server ]
374  );
375 
376  return false;
377  }
378  }
379 
380  return true;
381  }
382 
389  public function resetTimeout( Redis $conn, $timeout = null ) {
390  $conn->setOption( Redis::OPT_READ_TIMEOUT, $timeout ?: $this->readTimeout );
391  }
392 
396  function __destruct() {
397  foreach ( $this->connections as $server => &$serverConnections ) {
398  foreach ( $serverConnections as $key => &$connection ) {
399  try {
401  $conn = $connection['conn'];
402  $conn->close();
403  } catch ( RedisException $e ) {
404  // The destructor can be called on shutdown when random parts of the system
405  // have been destructed already, causing weird errors. Ignore them.
406  }
407  }
408  }
409  }
410 }
RedisConnectionPool\freeConnection
freeConnection( $server, Redis $conn)
Mark a connection to a server as free to return to the pool.
Definition: RedisConnectionPool.php:289
RedisConnectionPool\SERVER_DOWN_TTL
const SERVER_DOWN_TTL
integer; seconds to cache servers as "down".
Definition: RedisConnectionPool.php:66
RedisConnectionPool\$downServers
array $downServers
(server name => UNIX timestamp)
Definition: RedisConnectionPool.php:60
RedisConnectionPool\singleton
static singleton(array $options)
Definition: RedisConnectionPool.php:147
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
array
the array() calling protocol came about after MediaWiki 1.4rc1.
RedisConnectionPool\$connections
array $connections
(server name => ((connection info array),...)
Definition: RedisConnectionPool.php:58
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:334
serialize
serialize()
Definition: ApiMessage.php:184
RedisConnectionPool\resetTimeout
resetTimeout(Redis $conn, $timeout=null)
Adjust or reset the connection handle read timeout value.
Definition: RedisConnectionPool.php:389
RedisConnectionPool\destroySingletons
static destroySingletons()
Destroy all singleton() instances.
Definition: RedisConnectionPool.php:164
RedisConnectionPool\$logger
LoggerInterface $logger
Definition: RedisConnectionPool.php:71
$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. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\d*-\d*)") will be honored when streaming the file. '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! 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:1993
RedisConnectionPool\__construct
__construct(array $options, $id)
Definition: RedisConnectionPool.php:78
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:37
RedisConnRef\isConnIdentical
isConnIdentical(Redis $conn)
Definition: RedisConnRef.php:174
RedisConnectionPool\closeExcessIdleConections
closeExcessIdleConections()
Close any extra idle connections if there are more than the limit.
Definition: RedisConnectionPool.php:308
RedisConnectionPool\$instances
static array $instances
(pool ID => RedisConnectionPool)
Definition: RedisConnectionPool.php:63
RedisConnectionPool\$password
string $password
Plaintext auth password.
Definition: RedisConnectionPool.php:46
RedisConnectionPool\$serializer
int $serializer
Serializer to use (Redis::SERIALIZER_*)
Definition: RedisConnectionPool.php:50
RedisConnectionPool\getConnection
getConnection( $server, LoggerInterface $logger=null)
Get a connection to a redis server.
Definition: RedisConnectionPool.php:177
RedisConnectionPool\applyDefaultConfig
static applyDefaultConfig(array $options)
Definition: RedisConnectionPool.php:115
RedisConnectionPool\$readTimeout
string $readTimeout
Read timeout in seconds.
Definition: RedisConnectionPool.php:44
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
$options
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped & $options
Definition: hooks.txt:2001
RedisConnectionPool\setLogger
setLogger(LoggerInterface $logger)
Definition: RedisConnectionPool.php:107
RedisConnectionPool\$idlePoolSize
int $idlePoolSize
Current idle pool size.
Definition: RedisConnectionPool.php:55
RedisConnectionPool\$id
string $id
ID for persistent connections.
Definition: RedisConnectionPool.php:52
RedisConnectionPool
Helper class to manage Redis connections.
Definition: RedisConnectionPool.php:40
RedisConnectionPool\reauthenticateConnection
reauthenticateConnection( $server, Redis $conn)
Re-send an AUTH request to the redis server (useful after disconnects).
Definition: RedisConnectionPool.php:368
RedisConnectionPool\$connectTimeout
string $connectTimeout
Connection timeout in seconds.
Definition: RedisConnectionPool.php:42
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:22
RedisConnRef
Helper class to handle automatically marking connectons as reusable (via RAII pattern)
Definition: RedisConnRef.php:31
RedisConnectionPool\$persistent
bool $persistent
Whether connections persist.
Definition: RedisConnectionPool.php:48
RedisConnectionPool\__destruct
__destruct()
Make sure connections are closed for sanity.
Definition: RedisConnectionPool.php:396
RedisConnRef\getServer
getServer()
Definition: RedisConnRef.php:68
false
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:187
$e
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Definition: hooks.txt:2171