MediaWiki  1.28.0
RedisConnectionPool.php
Go to the documentation of this file.
1 <?php
27 
41 class RedisConnectionPool implements LoggerAwareInterface {
43  protected $connectTimeout;
45  protected $readTimeout;
47  protected $password;
49  protected $persistent;
51  protected $serializer;
52 
54  protected $idlePoolSize = 0;
55 
57  protected $connections = [];
59  protected $downServers = [];
60 
62  protected static $instances = [];
63 
65  const SERVER_DOWN_TTL = 30;
66 
70  protected $logger;
71 
76  protected function __construct( array $options ) {
77  if ( !class_exists( 'Redis' ) ) {
78  throw new RuntimeException(
79  __CLASS__ . ' requires a Redis client library. ' .
80  'See https://www.mediawiki.org/wiki/Redis#Setup' );
81  }
82  $this->logger = isset( $options['logger'] )
83  ? $options['logger']
84  : new \Psr\Log\NullLogger();
85  $this->connectTimeout = $options['connectTimeout'];
86  $this->readTimeout = $options['readTimeout'];
87  $this->persistent = $options['persistent'];
88  $this->password = $options['password'];
89  if ( !isset( $options['serializer'] ) || $options['serializer'] === 'php' ) {
90  $this->serializer = Redis::SERIALIZER_PHP;
91  } elseif ( $options['serializer'] === 'igbinary' ) {
92  $this->serializer = Redis::SERIALIZER_IGBINARY;
93  } elseif ( $options['serializer'] === 'none' ) {
94  $this->serializer = Redis::SERIALIZER_NONE;
95  } else {
96  throw new InvalidArgumentException( "Invalid serializer specified." );
97  }
98  }
99 
104  public function setLogger( LoggerInterface $logger ) {
105  $this->logger = $logger;
106  }
107 
112  protected static function applyDefaultConfig( array $options ) {
113  if ( !isset( $options['connectTimeout'] ) ) {
114  $options['connectTimeout'] = 1;
115  }
116  if ( !isset( $options['readTimeout'] ) ) {
117  $options['readTimeout'] = 1;
118  }
119  if ( !isset( $options['persistent'] ) ) {
120  $options['persistent'] = false;
121  }
122  if ( !isset( $options['password'] ) ) {
123  $options['password'] = null;
124  }
125 
126  return $options;
127  }
128 
144  public static function singleton( array $options ) {
145  $options = self::applyDefaultConfig( $options );
146  // Map the options to a unique hash...
147  ksort( $options ); // normalize to avoid pool fragmentation
148  $id = sha1( serialize( $options ) );
149  // Initialize the object at the hash as needed...
150  if ( !isset( self::$instances[$id] ) ) {
151  self::$instances[$id] = new self( $options );
152  }
153 
154  return self::$instances[$id];
155  }
156 
161  public static function destroySingletons() {
162  self::$instances = [];
163  }
164 
174  public function getConnection( $server, LoggerInterface $logger = null ) {
176  // Check the listing "dead" servers which have had a connection errors.
177  // Servers are marked dead for a limited period of time, to
178  // avoid excessive overhead from repeated connection timeouts.
179  if ( isset( $this->downServers[$server] ) ) {
180  $now = time();
181  if ( $now > $this->downServers[$server] ) {
182  // Dead time expired
183  unset( $this->downServers[$server] );
184  } else {
185  // Server is dead
186  $logger->debug(
187  'Server "{redis_server}" is marked down for another ' .
188  ( $this->downServers[$server] - $now ) . 'seconds',
189  [ 'redis_server' => $server ]
190  );
191 
192  return false;
193  }
194  }
195 
196  // Check if a connection is already free for use
197  if ( isset( $this->connections[$server] ) ) {
198  foreach ( $this->connections[$server] as &$connection ) {
199  if ( $connection['free'] ) {
200  $connection['free'] = false;
202 
203  return new RedisConnRef(
204  $this, $server, $connection['conn'], $logger
205  );
206  }
207  }
208  }
209 
210  if ( !$server ) {
211  throw new InvalidArgumentException(
212  __CLASS__ . ": invalid configured server \"$server\"" );
213  } elseif ( substr( $server, 0, 1 ) === '/' ) {
214  // UNIX domain socket
215  // These are required by the redis extension to start with a slash, but
216  // we still need to set the port to a special value to make it work.
217  $host = $server;
218  $port = 0;
219  } else {
220  // TCP connection
221  if ( preg_match( '/^\[(.+)\]:(\d+)$/', $server, $m ) ) {
222  list( $host, $port ) = [ $m[1], (int)$m[2] ]; // (ip, port)
223  } elseif ( preg_match( '/^([^:]+):(\d+)$/', $server, $m ) ) {
224  list( $host, $port ) = [ $m[1], (int)$m[2] ]; // (ip or path, port)
225  } else {
226  list( $host, $port ) = [ $server, 6379 ]; // (ip or path, port)
227  }
228  }
229 
230  $conn = new Redis();
231  try {
232  if ( $this->persistent ) {
233  $result = $conn->pconnect( $host, $port, $this->connectTimeout );
234  } else {
235  $result = $conn->connect( $host, $port, $this->connectTimeout );
236  }
237  if ( !$result ) {
238  $logger->error(
239  'Could not connect to server "{redis_server}"',
240  [ 'redis_server' => $server ]
241  );
242  // Mark server down for some time to avoid further timeouts
243  $this->downServers[$server] = time() + self::SERVER_DOWN_TTL;
244 
245  return false;
246  }
247  if ( $this->password !== null ) {
248  if ( !$conn->auth( $this->password ) ) {
249  $logger->error(
250  'Authentication error connecting to "{redis_server}"',
251  [ 'redis_server' => $server ]
252  );
253  }
254  }
255  } catch ( RedisException $e ) {
256  $this->downServers[$server] = time() + self::SERVER_DOWN_TTL;
257  $logger->error(
258  'Redis exception connecting to "{redis_server}"',
259  [
260  'redis_server' => $server,
261  'exception' => $e,
262  ]
263  );
264 
265  return false;
266  }
267 
268  if ( $conn ) {
269  $conn->setOption( Redis::OPT_READ_TIMEOUT, $this->readTimeout );
270  $conn->setOption( Redis::OPT_SERIALIZER, $this->serializer );
271  $this->connections[$server][] = [ 'conn' => $conn, 'free' => false ];
272 
273  return new RedisConnRef( $this, $server, $conn, $logger );
274  } else {
275  return false;
276  }
277  }
278 
286  public function freeConnection( $server, Redis $conn ) {
287  $found = false;
288 
289  foreach ( $this->connections[$server] as &$connection ) {
290  if ( $connection['conn'] === $conn && !$connection['free'] ) {
291  $connection['free'] = true;
293  break;
294  }
295  }
296 
297  $this->closeExcessIdleConections();
298 
299  return $found;
300  }
301 
305  protected function closeExcessIdleConections() {
306  if ( $this->idlePoolSize <= count( $this->connections ) ) {
307  return; // nothing to do (no more connections than servers)
308  }
309 
310  foreach ( $this->connections as &$serverConnections ) {
311  foreach ( $serverConnections as $key => &$connection ) {
312  if ( $connection['free'] ) {
313  unset( $serverConnections[$key] );
314  if ( --$this->idlePoolSize <= count( $this->connections ) ) {
315  return; // done (no more connections than servers)
316  }
317  }
318  }
319  }
320  }
321 
333  public function handleException( $server, RedisConnRef $cref, RedisException $e ) {
334  $this->handleError( $cref, $e );
335  }
336 
346  public function handleError( RedisConnRef $cref, RedisException $e ) {
347  $server = $cref->getServer();
348  $this->logger->error(
349  'Redis exception on server "{redis_server}"',
350  [
351  'redis_server' => $server,
352  'exception' => $e,
353  ]
354  );
355  foreach ( $this->connections[$server] as $key => $connection ) {
356  if ( $cref->isConnIdentical( $connection['conn'] ) ) {
357  $this->idlePoolSize -= $connection['free'] ? 1 : 0;
358  unset( $this->connections[$server][$key] );
359  break;
360  }
361  }
362  }
363 
380  public function reauthenticateConnection( $server, Redis $conn ) {
381  if ( $this->password !== null ) {
382  if ( !$conn->auth( $this->password ) ) {
383  $this->logger->error(
384  'Authentication error connecting to "{redis_server}"',
385  [ 'redis_server' => $server ]
386  );
387 
388  return false;
389  }
390  }
391 
392  return true;
393  }
394 
401  public function resetTimeout( Redis $conn, $timeout = null ) {
402  $conn->setOption( Redis::OPT_READ_TIMEOUT, $timeout ?: $this->readTimeout );
403  }
404 
408  function __destruct() {
409  foreach ( $this->connections as $server => &$serverConnections ) {
410  foreach ( $serverConnections as $key => &$connection ) {
412  $conn = $connection['conn'];
413  $conn->close();
414  }
415  }
416  }
417 }
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
the array() calling protocol came about after MediaWiki 1.4rc1.
handleException($server, RedisConnRef $cref, RedisException $e)
The redis extension throws an exception in response to various read, write and protocol errors...
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:189
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
bool $persistent
Whether connections persist.
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException'returning false will NOT prevent logging $e
Definition: hooks.txt:2102
string $password
Plaintext auth password.
array $downServers
(server name => UNIX timestamp)
static destroySingletons()
Destroy all singleton() instances.
string $connectTimeout
Connection timeout in seconds.
static applyDefaultConfig(array $options)
handleError(RedisConnRef $cref, RedisException $e)
The redis extension throws an exception in response to various read, write and protocol errors...
array $connections
(server name => ((connection info array),...)
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:Associative array mapping language codes to prefixed links of the form"language:title".&$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:1934
static singleton(array $options)
int $serializer
Serializer to use (Redis::SERIALIZER_*)
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist 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:1046
const SERVER_DOWN_TTL
integer; seconds to cache servers as "down".
__destruct()
Make sure connections are closed for sanity.
string $readTimeout
Read timeout in seconds.
freeConnection($server, Redis $conn)
Mark a connection to a server as free to return to the pool.
resetTimeout(Redis $conn, $timeout=null)
Adjust or reset the connection handle read timeout value.
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
__construct(array $options)
Helper class to manage Redis connections.
closeExcessIdleConections()
Close any extra idle connections if there are more than the limit.
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
reauthenticateConnection($server, Redis $conn)
Re-send an AUTH request to the redis server (useful after disconnects).
Helper class to handle automatically marking connectons as reusable (via RAII pattern) ...
isConnIdentical(Redis $conn)
setLogger(LoggerInterface $logger)
serialize()
Definition: ApiMessage.php:94
static array $instances
(pool ID => RedisConnectionPool)
getConnection($server, LoggerInterface $logger=null)
Get a connection to a redis server.
int $idlePoolSize
Current idle pool size.