3 * Base class for memcached clients.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
25 * Base class for memcached clients.
29 class MemcachedBagOStuff
extends BagOStuff
{
33 * Fill in the defaults for any parameters missing from $params, using the
34 * backwards-compatible global variables
35 * @param array $params
38 protected function applyDefaultParams( $params ) {
39 if ( !isset( $params['servers'] ) ) {
40 $params['servers'] = $GLOBALS['wgMemCachedServers'];
42 if ( !isset( $params['debug'] ) ) {
43 $params['debug'] = $GLOBALS['wgMemCachedDebug'];
45 if ( !isset( $params['persistent'] ) ) {
46 $params['persistent'] = $GLOBALS['wgMemCachedPersistent'];
48 if ( !isset( $params['compress_threshold'] ) ) {
49 $params['compress_threshold'] = 1500;
51 if ( !isset( $params['timeout'] ) ) {
52 $params['timeout'] = $GLOBALS['wgMemCachedTimeout'];
54 if ( !isset( $params['connect_timeout'] ) ) {
55 $params['connect_timeout'] = 0.5;
60 protected function doGet( $key, $flags = 0 ) {
63 return $this->getWithToken( $key, $casToken, $flags );
66 protected function getWithToken( $key, &$casToken, $flags = 0 ) {
67 return $this->client
->get( $this->encodeKey( $key ), $casToken );
76 public function set( $key, $value, $exptime = 0 ) {
77 return $this->client
->set( $this->encodeKey( $key ), $value,
78 $this->fixExpiry( $exptime ) );
82 * @param mixed $casToken
88 protected function cas( $casToken, $key, $value, $exptime = 0 ) {
89 return $this->client
->cas( $casToken, $this->encodeKey( $key ),
90 $value, $this->fixExpiry( $exptime ) );
97 public function delete( $key ) {
98 return $this->client
->delete( $this->encodeKey( $key ) );
104 * @param int $exptime (default 0)
107 public function add( $key, $value, $exptime = 0 ) {
108 return $this->client
->add( $this->encodeKey( $key ), $value,
109 $this->fixExpiry( $exptime ) );
112 public function merge( $key, $callback, $exptime = 0, $attempts = 10 ) {
113 if ( !is_callable( $callback ) ) {
114 throw new Exception( "Got invalid callback." );
117 return $this->mergeViaCas( $key, $callback, $exptime, $attempts );
121 * Get the underlying client object. This is provided for debugging
125 public function getClient() {
126 return $this->client
;
130 * Encode a key for use on the wire inside the memcached protocol.
132 * We encode spaces and line breaks to avoid protocol errors. We encode
133 * the other control characters for compatibility with libmemcached
134 * verify_key. We leave other punctuation alone, to maximise backwards
139 public function encodeKey( $key ) {
140 return preg_replace_callback( '/[\x00-\x20\x25\x7f]+/',
141 array( $this, 'encodeKeyCallback' ), $key );
148 protected function encodeKeyCallback( $m ) {
149 return rawurlencode( $m[0] );
153 * TTLs higher than 30 days will be detected as absolute TTLs
154 * (UNIX timestamps), and will result in the cache entry being
155 * discarded immediately because the expiry is in the past.
156 * Clamp expires >30d at 30d, unless they're >=1e9 in which
157 * case they are likely to really be absolute (1e9 = 2011-09-09)
161 function fixExpiry( $expiry ) {
162 if ( $expiry > 2592000 && $expiry < 1000000000 ) {
169 * Decode a key encoded with encodeKey(). This is provided as a convenience
170 * function for debugging.
176 public function decodeKey( $key ) {
177 // matches %00-%20, %25, %7F (=decoded alternatives for those encoded in encodeKey)
178 return preg_replace_callback( '/%([0-1][0-9]|20|25|7F)/i', function ( $match ) {
179 return urldecode( $match[0] );
184 * Send a debug message to the log
185 * @param string $text
187 protected function debugLog( $text ) {
188 $this->logger
->debug( $text );
191 public function modifySimpleRelayEvent( array $event ) {
192 if ( array_key_exists( 'val', $event ) ) {
193 $event['flg'] = 0; // data is not serialized nor gzipped (for memcached driver)