MediaWiki  REL1_31
MemcachedPeclBagOStuff.php
Go to the documentation of this file.
1 <?php
30 
47  function __construct( $params ) {
48  parent::__construct( $params );
50 
51  if ( $params['persistent'] ) {
52  // The pool ID must be unique to the server/option combination.
53  // The Memcached object is essentially shared for each pool ID.
54  // We can only reuse a pool ID if we keep the config consistent.
55  $this->client = new Memcached( md5( serialize( $params ) ) );
56  if ( count( $this->client->getServerList() ) ) {
57  $this->logger->debug( __METHOD__ . ": persistent Memcached object already loaded." );
58  return; // already initialized; don't add duplicate servers
59  }
60  } else {
61  $this->client = new Memcached;
62  }
63 
64  if ( $params['use_binary_protocol'] ) {
65  $this->client->setOption( Memcached::OPT_BINARY_PROTOCOL, true );
66  }
67 
68  if ( isset( $params['retry_timeout'] ) ) {
69  $this->client->setOption( Memcached::OPT_RETRY_TIMEOUT, $params['retry_timeout'] );
70  }
71 
72  if ( isset( $params['server_failure_limit'] ) ) {
73  $this->client->setOption( Memcached::OPT_SERVER_FAILURE_LIMIT, $params['server_failure_limit'] );
74  }
75 
76  // The compression threshold is an undocumented php.ini option for some
77  // reason. There's probably not much harm in setting it globally, for
78  // compatibility with the settings for the PHP client.
79  ini_set( 'memcached.compression_threshold', $params['compress_threshold'] );
80 
81  // Set timeouts
82  $this->client->setOption( Memcached::OPT_CONNECT_TIMEOUT, $params['connect_timeout'] * 1000 );
83  $this->client->setOption( Memcached::OPT_SEND_TIMEOUT, $params['timeout'] );
84  $this->client->setOption( Memcached::OPT_RECV_TIMEOUT, $params['timeout'] );
85  $this->client->setOption( Memcached::OPT_POLL_TIMEOUT, $params['timeout'] / 1000 );
86 
87  // Set libketama mode since it's recommended by the documentation and
88  // is as good as any. There's no way to configure libmemcached to use
89  // hashes identical to the ones currently in use by the PHP client, and
90  // even implementing one of the libmemcached hashes in pure PHP for
91  // forwards compatibility would require MemcachedClient::get_sock() to be
92  // rewritten.
93  $this->client->setOption( Memcached::OPT_LIBKETAMA_COMPATIBLE, true );
94 
95  // Set the serializer
96  switch ( $params['serializer'] ) {
97  case 'php':
98  $this->client->setOption( Memcached::OPT_SERIALIZER, Memcached::SERIALIZER_PHP );
99  break;
100  case 'igbinary':
101  if ( !Memcached::HAVE_IGBINARY ) {
102  throw new InvalidArgumentException(
103  __CLASS__ . ': the igbinary extension is not available ' .
104  'but igbinary serialization was requested.'
105  );
106  }
107  $this->client->setOption( Memcached::OPT_SERIALIZER, Memcached::SERIALIZER_IGBINARY );
108  break;
109  default:
110  throw new InvalidArgumentException(
111  __CLASS__ . ': invalid value for serializer parameter'
112  );
113  }
114  $servers = [];
115  foreach ( $params['servers'] as $host ) {
116  if ( preg_match( '/^\[(.+)\]:(\d+)$/', $host, $m ) ) {
117  $servers[] = [ $m[1], (int)$m[2] ]; // (ip, port)
118  } elseif ( preg_match( '/^([^:]+):(\d+)$/', $host, $m ) ) {
119  $servers[] = [ $m[1], (int)$m[2] ]; // (ip or path, port)
120  } else {
121  $servers[] = [ $host, false ]; // (ip or path, port)
122  }
123  }
124  $this->client->addServers( $servers );
125  }
126 
127  protected function applyDefaultParams( $params ) {
128  $params = parent::applyDefaultParams( $params );
129 
130  if ( !isset( $params['use_binary_protocol'] ) ) {
131  $params['use_binary_protocol'] = false;
132  }
133 
134  if ( !isset( $params['serializer'] ) ) {
135  $params['serializer'] = 'php';
136  }
137 
138  return $params;
139  }
140 
141  protected function getWithToken( $key, &$casToken, $flags = 0 ) {
142  $this->debugLog( "get($key)" );
143  if ( defined( Memcached::class . '::GET_EXTENDED' ) ) { // v3.0.0
144  $flags = Memcached::GET_EXTENDED;
145  $res = $this->client->get( $this->validateKeyEncoding( $key ), null, $flags );
146  if ( is_array( $res ) ) {
147  $result = $res['value'];
148  $casToken = $res['cas'];
149  } else {
150  $result = false;
151  $casToken = null;
152  }
153  } else {
154  $result = $this->client->get( $this->validateKeyEncoding( $key ), null, $casToken );
155  }
156  $result = $this->checkResult( $key, $result );
157  return $result;
158  }
159 
160  public function set( $key, $value, $exptime = 0, $flags = 0 ) {
161  $this->debugLog( "set($key)" );
162  $result = parent::set( $key, $value, $exptime );
163  if ( $result === false && $this->client->getResultCode() === Memcached::RES_NOTSTORED ) {
164  // "Not stored" is always used as the mcrouter response with AllAsyncRoute
165  return true;
166  }
167  return $this->checkResult( $key, $result );
168  }
169 
170  protected function cas( $casToken, $key, $value, $exptime = 0 ) {
171  $this->debugLog( "cas($key)" );
172  return $this->checkResult( $key, parent::cas( $casToken, $key, $value, $exptime ) );
173  }
174 
175  public function delete( $key ) {
176  $this->debugLog( "delete($key)" );
177  $result = parent::delete( $key );
178  if ( $result === false && $this->client->getResultCode() === Memcached::RES_NOTFOUND ) {
179  // "Not found" is counted as success in our interface
180  return true;
181  }
182  return $this->checkResult( $key, $result );
183  }
184 
185  public function add( $key, $value, $exptime = 0 ) {
186  $this->debugLog( "add($key)" );
187  return $this->checkResult( $key, parent::add( $key, $value, $exptime ) );
188  }
189 
190  public function incr( $key, $value = 1 ) {
191  $this->debugLog( "incr($key)" );
192  $result = $this->client->increment( $key, $value );
193  return $this->checkResult( $key, $result );
194  }
195 
196  public function decr( $key, $value = 1 ) {
197  $this->debugLog( "decr($key)" );
198  $result = $this->client->decrement( $key, $value );
199  return $this->checkResult( $key, $result );
200  }
201 
213  protected function checkResult( $key, $result ) {
214  if ( $result !== false ) {
215  return $result;
216  }
217  switch ( $this->client->getResultCode() ) {
218  case Memcached::RES_SUCCESS:
219  break;
220  case Memcached::RES_DATA_EXISTS:
221  case Memcached::RES_NOTSTORED:
222  case Memcached::RES_NOTFOUND:
223  $this->debugLog( "result: " . $this->client->getResultMessage() );
224  break;
225  default:
226  $msg = $this->client->getResultMessage();
227  $logCtx = [];
228  if ( $key !== false ) {
229  $server = $this->client->getServerByKey( $key );
230  $logCtx['memcached-server'] = "{$server['host']}:{$server['port']}";
231  $logCtx['memcached-key'] = $key;
232  $msg = "Memcached error for key \"{memcached-key}\" on server \"{memcached-server}\": $msg";
233  } else {
234  $msg = "Memcached error: $msg";
235  }
236  $this->logger->error( $msg, $logCtx );
238  }
239  return $result;
240  }
241 
242  public function getMulti( array $keys, $flags = 0 ) {
243  $this->debugLog( 'getMulti(' . implode( ', ', $keys ) . ')' );
244  foreach ( $keys as $key ) {
245  $this->validateKeyEncoding( $key );
246  }
247  $result = $this->client->getMulti( $keys ) ?: [];
248  return $this->checkResult( false, $result );
249  }
250 
256  public function setMulti( array $data, $exptime = 0 ) {
257  $this->debugLog( 'setMulti(' . implode( ', ', array_keys( $data ) ) . ')' );
258  foreach ( array_keys( $data ) as $key ) {
259  $this->validateKeyEncoding( $key );
260  }
261  $result = $this->client->setMulti( $data, $this->fixExpiry( $exptime ) );
262  return $this->checkResult( false, $result );
263  }
264 
265  public function changeTTL( $key, $expiry = 0 ) {
266  $this->debugLog( "touch($key)" );
267  $result = $this->client->touch( $key, $expiry );
268  return $this->checkResult( $key, $result );
269  }
270 }
MemcachedBagOStuff\fixExpiry
fixExpiry( $expiry)
TTLs higher than 30 days will be detected as absolute TTLs (UNIX timestamps), and will result in the ...
Definition: MemcachedBagOStuff.php:170
Memcached
The phpstorm stubs package includes the Memcached class with two parameters and docs saying that they...
Definition: memcached.php:11
MemcachedBagOStuff
Base class for memcached clients.
Definition: MemcachedBagOStuff.php:29
MemcachedPeclBagOStuff\changeTTL
changeTTL( $key, $expiry=0)
Reset the TTL on a key if it exists.
Definition: MemcachedPeclBagOStuff.php:265
array
the array() calling protocol came about after MediaWiki 1.4rc1.
MemcachedPeclBagOStuff\__construct
__construct( $params)
Available parameters are:
Definition: MemcachedPeclBagOStuff.php:47
MemcachedPeclBagOStuff\applyDefaultParams
applyDefaultParams( $params)
Fill in some defaults for missing keys in $params.
Definition: MemcachedPeclBagOStuff.php:127
$params
$params
Definition: styleTest.css.php:40
MemcachedPeclBagOStuff\getWithToken
getWithToken( $key, &$casToken, $flags=0)
Definition: MemcachedPeclBagOStuff.php:141
serialize
serialize()
Definition: ApiMessage.php:184
$res
$res
Definition: database.txt:21
MemcachedPeclBagOStuff\checkResult
checkResult( $key, $result)
Check the return value from a client method call and take any necessary action.
Definition: MemcachedPeclBagOStuff.php:213
$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
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
MemcachedBagOStuff\debugLog
debugLog( $text)
Send a debug message to the log.
Definition: MemcachedBagOStuff.php:181
MemcachedPeclBagOStuff\add
add( $key, $value, $exptime=0)
Definition: MemcachedPeclBagOStuff.php:185
MemcachedPeclBagOStuff\incr
incr( $key, $value=1)
Increase stored value of $key by $value while preserving its TTL.
Definition: MemcachedPeclBagOStuff.php:190
add
An extension or a 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:56
MemcachedPeclBagOStuff\getMulti
getMulti(array $keys, $flags=0)
Get an associative array containing the item for each of the keys that have items.
Definition: MemcachedPeclBagOStuff.php:242
$value
$value
Definition: styleTest.css.php:45
MemcachedPeclBagOStuff\cas
cas( $casToken, $key, $value, $exptime=0)
Check and set an item.
Definition: MemcachedPeclBagOStuff.php:170
MemcachedPeclBagOStuff
A wrapper class for the PECL memcached client.
Definition: MemcachedPeclBagOStuff.php:29
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
$keys
$keys
Definition: testCompression.php:67
class
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:56
MemcachedBagOStuff\validateKeyEncoding
validateKeyEncoding( $key)
Ensure that a key is safe to use (contains no control characters and no characters above the ASCII ra...
Definition: MemcachedBagOStuff.php:154
BagOStuff\setLastError
setLastError( $err)
Set the "last error" registry.
Definition: BagOStuff.php:633
BagOStuff\ERR_UNEXPECTED
const ERR_UNEXPECTED
Definition: BagOStuff.php:83
MemcachedPeclBagOStuff\setMulti
setMulti(array $data, $exptime=0)
Definition: MemcachedPeclBagOStuff.php:256
false
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:187
MemcachedPeclBagOStuff\decr
decr( $key, $value=1)
Decrease stored value of $key by $value while preserving its TTL.
Definition: MemcachedPeclBagOStuff.php:196