MediaWiki REL1_33
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
144 protected function doGet( $key, $flags = 0, &$casToken = null ) {
145 $this->debugLog( "get($key)" );
146 if ( defined( Memcached::class . '::GET_EXTENDED' ) ) { // v3.0.0
147 $flags = Memcached::GET_EXTENDED;
148 $res = $this->client->get( $this->validateKeyEncoding( $key ), null, $flags );
149 if ( is_array( $res ) ) {
150 $result = $res['value'];
151 $casToken = $res['cas'];
152 } else {
153 $result = false;
154 $casToken = null;
155 }
156 } else {
157 $result = $this->client->get( $this->validateKeyEncoding( $key ), null, $casToken );
158 }
159 $result = $this->checkResult( $key, $result );
160 return $result;
161 }
162
163 public function set( $key, $value, $exptime = 0, $flags = 0 ) {
164 $this->debugLog( "set($key)" );
165 $result = parent::set( $key, $value, $exptime, $flags = 0 );
166 if ( $result === false && $this->client->getResultCode() === Memcached::RES_NOTSTORED ) {
167 // "Not stored" is always used as the mcrouter response with AllAsyncRoute
168 return true;
169 }
170 return $this->checkResult( $key, $result );
171 }
172
173 protected function cas( $casToken, $key, $value, $exptime = 0, $flags = 0 ) {
174 $this->debugLog( "cas($key)" );
175 return $this->checkResult( $key, parent::cas( $casToken, $key, $value, $exptime, $flags ) );
176 }
177
178 public function delete( $key, $flags = 0 ) {
179 $this->debugLog( "delete($key)" );
180 $result = parent::delete( $key );
181 if ( $result === false && $this->client->getResultCode() === Memcached::RES_NOTFOUND ) {
182 // "Not found" is counted as success in our interface
183 return true;
184 }
185 return $this->checkResult( $key, $result );
186 }
187
188 public function add( $key, $value, $exptime = 0, $flags = 0 ) {
189 $this->debugLog( "add($key)" );
190 return $this->checkResult( $key, parent::add( $key, $value, $exptime ) );
191 }
192
193 public function incr( $key, $value = 1 ) {
194 $this->debugLog( "incr($key)" );
195 $result = $this->client->increment( $key, $value );
196 return $this->checkResult( $key, $result );
197 }
198
199 public function decr( $key, $value = 1 ) {
200 $this->debugLog( "decr($key)" );
201 $result = $this->client->decrement( $key, $value );
202 return $this->checkResult( $key, $result );
203 }
204
216 protected function checkResult( $key, $result ) {
217 if ( $result !== false ) {
218 return $result;
219 }
220 switch ( $this->client->getResultCode() ) {
221 case Memcached::RES_SUCCESS:
222 break;
223 case Memcached::RES_DATA_EXISTS:
224 case Memcached::RES_NOTSTORED:
225 case Memcached::RES_NOTFOUND:
226 $this->debugLog( "result: " . $this->client->getResultMessage() );
227 break;
228 default:
229 $msg = $this->client->getResultMessage();
230 $logCtx = [];
231 if ( $key !== false ) {
232 $server = $this->client->getServerByKey( $key );
233 $logCtx['memcached-server'] = "{$server['host']}:{$server['port']}";
234 $logCtx['memcached-key'] = $key;
235 $msg = "Memcached error for key \"{memcached-key}\" on server \"{memcached-server}\": $msg";
236 } else {
237 $msg = "Memcached error: $msg";
238 }
239 $this->logger->error( $msg, $logCtx );
241 }
242 return $result;
243 }
244
245 public function getMulti( array $keys, $flags = 0 ) {
246 $this->debugLog( 'getMulti(' . implode( ', ', $keys ) . ')' );
247 foreach ( $keys as $key ) {
248 $this->validateKeyEncoding( $key );
249 }
250 $result = $this->client->getMulti( $keys ) ?: [];
251 return $this->checkResult( false, $result );
252 }
253
254 public function setMulti( array $data, $exptime = 0, $flags = 0 ) {
255 $this->debugLog( 'setMulti(' . implode( ', ', array_keys( $data ) ) . ')' );
256 foreach ( array_keys( $data ) as $key ) {
257 $this->validateKeyEncoding( $key );
258 }
259 $result = $this->client->setMulti( $data, $this->fixExpiry( $exptime ) );
260 return $this->checkResult( false, $result );
261 }
262
263 public function changeTTL( $key, $expiry = 0, $flags = 0 ) {
264 $this->debugLog( "touch($key)" );
265 $result = $this->client->touch( $key, $expiry );
266 return $this->checkResult( $key, $result );
267 }
268}
serialize()
setLastError( $err)
Set the "last error" registry.
Base class for memcached clients.
validateKeyEncoding( $key)
Ensure that a key is safe to use (contains no control characters and no characters above the ASCII ra...
debugLog( $text)
Send a debug message to the log.
fixExpiry( $expiry)
TTLs higher than 30 days will be detected as absolute TTLs (UNIX timestamps), and will result in the ...
A wrapper class for the PECL memcached client.
setMulti(array $data, $exptime=0, $flags=0)
Batch insertion/replace.
doGet( $key, $flags=0, &$casToken=null)
@suppress PhanTypeNonVarPassByRef
decr( $key, $value=1)
Decrease stored value of $key by $value while preserving its TTL.
cas( $casToken, $key, $value, $exptime=0, $flags=0)
Check and set an item.
getMulti(array $keys, $flags=0)
Get an associative array containing the item for each of the keys that have items.
checkResult( $key, $result)
Check the return value from a client method call and take any necessary action.
__construct( $params)
Available parameters are:
incr( $key, $value=1)
Increase stored value of $key by $value while preserving its TTL.
add( $key, $value, $exptime=0, $flags=0)
Insert an item if it does not already exist.
applyDefaultParams( $params)
Fill in some defaults for missing keys in $params.
changeTTL( $key, $expiry=0, $flags=0)
Change the expiration on a key if it exists.
$res
Definition database.txt:21
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
$data
Utility to generate mapping file used in mw.Title (phpCharToUpper.json)
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. '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 '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 since 1.28! 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:1991
processing should stop and the error should be shown to the user * false
Definition hooks.txt:187
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
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))
$params