MediaWiki  1.28.0
MemcachedPeclBagOStuff.php
Go to the documentation of this file.
1 <?php
30 
49  function __construct( $params ) {
50  parent::__construct( $params );
52 
53  if ( $params['persistent'] ) {
54  // The pool ID must be unique to the server/option combination.
55  // The Memcached object is essentially shared for each pool ID.
56  // We can only reuse a pool ID if we keep the config consistent.
57  $this->client = new Memcached( md5( serialize( $params ) ) );
58  if ( count( $this->client->getServerList() ) ) {
59  $this->logger->debug( __METHOD__ . ": persistent Memcached object already loaded." );
60  return; // already initialized; don't add duplicate servers
61  }
62  } else {
63  $this->client = new Memcached;
64  }
65 
66  if ( $params['use_binary_protocol'] ) {
67  $this->client->setOption( Memcached::OPT_BINARY_PROTOCOL, true );
68  }
69 
70  if ( isset( $params['retry_timeout'] ) ) {
71  $this->client->setOption( Memcached::OPT_RETRY_TIMEOUT, $params['retry_timeout'] );
72  }
73 
74  if ( isset( $params['server_failure_limit'] ) ) {
75  $this->client->setOption( Memcached::OPT_SERVER_FAILURE_LIMIT, $params['server_failure_limit'] );
76  }
77 
78  // The compression threshold is an undocumented php.ini option for some
79  // reason. There's probably not much harm in setting it globally, for
80  // compatibility with the settings for the PHP client.
81  ini_set( 'memcached.compression_threshold', $params['compress_threshold'] );
82 
83  // Set timeouts
84  $this->client->setOption( Memcached::OPT_CONNECT_TIMEOUT, $params['connect_timeout'] * 1000 );
85  $this->client->setOption( Memcached::OPT_SEND_TIMEOUT, $params['timeout'] );
86  $this->client->setOption( Memcached::OPT_RECV_TIMEOUT, $params['timeout'] );
87  $this->client->setOption( Memcached::OPT_POLL_TIMEOUT, $params['timeout'] / 1000 );
88 
89  // Set libketama mode since it's recommended by the documentation and
90  // is as good as any. There's no way to configure libmemcached to use
91  // hashes identical to the ones currently in use by the PHP client, and
92  // even implementing one of the libmemcached hashes in pure PHP for
93  // forwards compatibility would require MemcachedClient::get_sock() to be
94  // rewritten.
95  $this->client->setOption( Memcached::OPT_LIBKETAMA_COMPATIBLE, true );
96 
97  // Set the serializer
98  switch ( $params['serializer'] ) {
99  case 'php':
100  $this->client->setOption( Memcached::OPT_SERIALIZER, Memcached::SERIALIZER_PHP );
101  break;
102  case 'igbinary':
103  if ( !Memcached::HAVE_IGBINARY ) {
104  throw new InvalidArgumentException(
105  __CLASS__ . ': the igbinary extension is not available ' .
106  'but igbinary serialization was requested.'
107  );
108  }
109  $this->client->setOption( Memcached::OPT_SERIALIZER, Memcached::SERIALIZER_IGBINARY );
110  break;
111  default:
112  throw new InvalidArgumentException(
113  __CLASS__ . ': invalid value for serializer parameter'
114  );
115  }
116  $servers = [];
117  foreach ( $params['servers'] as $host ) {
118  if ( preg_match( '/^\[(.+)\]:(\d+)$/', $host, $m ) ) {
119  $servers[] = [ $m[1], (int)$m[2] ]; // (ip, port)
120  } elseif ( preg_match( '/^([^:]+):(\d+)$/', $host, $m ) ) {
121  $servers[] = [ $m[1], (int)$m[2] ]; // (ip or path, port)
122  } else {
123  $servers[] = [ $host, false ]; // (ip or path, port)
124  }
125  }
126  $this->client->addServers( $servers );
127  }
128 
129  protected function applyDefaultParams( $params ) {
130  $params = parent::applyDefaultParams( $params );
131 
132  if ( !isset( $params['use_binary_protocol'] ) ) {
133  $params['use_binary_protocol'] = false;
134  }
135 
136  if ( !isset( $params['serializer'] ) ) {
137  $params['serializer'] = 'php';
138  }
139 
140  return $params;
141  }
142 
143  protected function getWithToken( $key, &$casToken, $flags = 0 ) {
144  $this->debugLog( "get($key)" );
145  $result = $this->client->get( $this->validateKeyEncoding( $key ), null, $casToken );
146  $result = $this->checkResult( $key, $result );
147  return $result;
148  }
149 
150  public function set( $key, $value, $exptime = 0, $flags = 0 ) {
151  $this->debugLog( "set($key)" );
152  return $this->checkResult( $key, parent::set( $key, $value, $exptime ) );
153  }
154 
155  protected function cas( $casToken, $key, $value, $exptime = 0 ) {
156  $this->debugLog( "cas($key)" );
157  return $this->checkResult( $key, parent::cas( $casToken, $key, $value, $exptime ) );
158  }
159 
160  public function delete( $key ) {
161  $this->debugLog( "delete($key)" );
162  $result = parent::delete( $key );
163  if ( $result === false && $this->client->getResultCode() === Memcached::RES_NOTFOUND ) {
164  // "Not found" is counted as success in our interface
165  return true;
166  } else {
167  return $this->checkResult( $key, $result );
168  }
169  }
170 
171  public function add( $key, $value, $exptime = 0 ) {
172  $this->debugLog( "add($key)" );
173  return $this->checkResult( $key, parent::add( $key, $value, $exptime ) );
174  }
175 
176  public function incr( $key, $value = 1 ) {
177  $this->debugLog( "incr($key)" );
178  $result = $this->client->increment( $key, $value );
179  return $this->checkResult( $key, $result );
180  }
181 
182  public function decr( $key, $value = 1 ) {
183  $this->debugLog( "decr($key)" );
184  $result = $this->client->decrement( $key, $value );
185  return $this->checkResult( $key, $result );
186  }
187 
199  protected function checkResult( $key, $result ) {
200  if ( $result !== false ) {
201  return $result;
202  }
203  switch ( $this->client->getResultCode() ) {
204  case Memcached::RES_SUCCESS:
205  break;
206  case Memcached::RES_DATA_EXISTS:
207  case Memcached::RES_NOTSTORED:
208  case Memcached::RES_NOTFOUND:
209  $this->debugLog( "result: " . $this->client->getResultMessage() );
210  break;
211  default:
212  $msg = $this->client->getResultMessage();
213  $logCtx = [];
214  if ( $key !== false ) {
215  $server = $this->client->getServerByKey( $key );
216  $logCtx['memcached-server'] = "{$server['host']}:{$server['port']}";
217  $logCtx['memcached-key'] = $key;
218  $msg = "Memcached error for key \"{memcached-key}\" on server \"{memcached-server}\": $msg";
219  } else {
220  $msg = "Memcached error: $msg";
221  }
222  $this->logger->error( $msg, $logCtx );
224  }
225  return $result;
226  }
227 
228  public function getMulti( array $keys, $flags = 0 ) {
229  $this->debugLog( 'getMulti(' . implode( ', ', $keys ) . ')' );
230  foreach ( $keys as $key ) {
231  $this->validateKeyEncoding( $key );
232  }
233  $result = $this->client->getMulti( $keys ) ?: [];
234  return $this->checkResult( false, $result );
235  }
236 
242  public function setMulti( array $data, $exptime = 0 ) {
243  $this->debugLog( 'setMulti(' . implode( ', ', array_keys( $data ) ) . ')' );
244  foreach ( array_keys( $data ) as $key ) {
245  $this->validateKeyEncoding( $key );
246  }
247  $result = $this->client->setMulti( $data, $this->fixExpiry( $exptime ) );
248  return $this->checkResult( false, $result );
249  }
250 
251  public function changeTTL( $key, $expiry = 0 ) {
252  $this->debugLog( "touch($key)" );
253  $result = $this->client->touch( $key, $expiry );
254  return $this->checkResult( $key, $result );
255  }
256 }
const ERR_UNEXPECTED
Definition: BagOStuff.php:80
the array() calling protocol came about after MediaWiki 1.4rc1.
__construct($params)
Constructor.
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:189
getMulti(array $keys, $flags=0)
A wrapper class for the PECL memcached client.
$value
it s the revision text itself In either if gzip is the revision text is gzipped $flags
Definition: hooks.txt:2703
fixExpiry($expiry)
TTLs higher than 30 days will be detected as absolute TTLs (UNIX timestamps), and will result in the ...
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
An extension or a local will often add custom code to the function with or without a global variable For someone wanting email notification when an article is shown may add
Definition: hooks.txt:51
checkResult($key, $result)
Check the return value from a client method call and take any necessary action.
it s the revision text itself In either if gzip is set
Definition: hooks.txt:2703
$params
add($key, $value, $exptime=0)
validateKeyEncoding($key)
Ensure that a key is safe to use (contains no control characters and no characters above the ASCII ra...
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
setMulti(array $data, $exptime=0)
cas($casToken, $key, $value, $exptime=0)
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
Base class for memcached clients.
getWithToken($key, &$casToken, $flags=0)
set($key, $value, $exptime=0, $flags=0)
serialize()
Definition: ApiMessage.php:94
setLastError($err)
Set the "last error" registry.
Definition: BagOStuff.php:630
debugLog($text)
Send a debug message to the log.