1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
|
<?php
/**
* Base class for memcached clients.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Cache
*/
/**
* Base class for memcached clients.
*
* @ingroup Cache
*/
class MemcachedBagOStuff extends BagOStuff {
protected $client;
/**
* Fill in the defaults for any parameters missing from $params, using the
* backwards-compatible global variables
* @param array $params
* @return array
*/
protected function applyDefaultParams( $params ) {
if ( !isset( $params['servers'] ) ) {
$params['servers'] = $GLOBALS['wgMemCachedServers'];
}
if ( !isset( $params['debug'] ) ) {
$params['debug'] = $GLOBALS['wgMemCachedDebug'];
}
if ( !isset( $params['persistent'] ) ) {
$params['persistent'] = $GLOBALS['wgMemCachedPersistent'];
}
if ( !isset( $params['compress_threshold'] ) ) {
$params['compress_threshold'] = 1500;
}
if ( !isset( $params['timeout'] ) ) {
$params['timeout'] = $GLOBALS['wgMemCachedTimeout'];
}
if ( !isset( $params['connect_timeout'] ) ) {
$params['connect_timeout'] = 0.5;
}
return $params;
}
/**
* @param string $key
* @param mixed $casToken [optional]
* @return mixed
*/
public function get( $key, &$casToken = null ) {
return $this->client->get( $this->encodeKey( $key ), $casToken );
}
/**
* @param string $key
* @param mixed $value
* @param int $exptime
* @return bool
*/
public function set( $key, $value, $exptime = 0 ) {
return $this->client->set( $this->encodeKey( $key ), $value,
$this->fixExpiry( $exptime ) );
}
/**
* @param mixed $casToken
* @param string $key
* @param mixed $value
* @param int $exptime
* @return bool
*/
public function cas( $casToken, $key, $value, $exptime = 0 ) {
return $this->client->cas( $casToken, $this->encodeKey( $key ),
$value, $this->fixExpiry( $exptime ) );
}
/**
* @param string $key
* @param int $time
* @return bool
*/
public function delete( $key, $time = 0 ) {
return $this->client->delete( $this->encodeKey( $key ), $time );
}
/**
* @param string $key
* @param int $value
* @param int $exptime (default 0)
* @return mixed
*/
public function add( $key, $value, $exptime = 0 ) {
return $this->client->add( $this->encodeKey( $key ), $value,
$this->fixExpiry( $exptime ) );
}
/**
* Get the underlying client object. This is provided for debugging
* purposes.
* @return BagOStuff
*/
public function getClient() {
return $this->client;
}
/**
* Encode a key for use on the wire inside the memcached protocol.
*
* We encode spaces and line breaks to avoid protocol errors. We encode
* the other control characters for compatibility with libmemcached
* verify_key. We leave other punctuation alone, to maximise backwards
* compatibility.
* @param string $key
* @return string
*/
public function encodeKey( $key ) {
return preg_replace_callback( '/[\x00-\x20\x25\x7f]+/',
array( $this, 'encodeKeyCallback' ), $key );
}
/**
* @param array $m
* @return string
*/
protected function encodeKeyCallback( $m ) {
return rawurlencode( $m[0] );
}
/**
* TTLs higher than 30 days will be detected as absolute TTLs
* (UNIX timestamps), and will result in the cache entry being
* discarded immediately because the expiry is in the past.
* Clamp expiries >30d at 30d, unless they're >=1e9 in which
* case they are likely to really be absolute (1e9 = 2011-09-09)
* @param int $expiry
* @return int
*/
function fixExpiry( $expiry ) {
if ( $expiry > 2592000 && $expiry < 1000000000 ) {
$expiry = 2592000;
}
return (int)$expiry;
}
/**
* Decode a key encoded with encodeKey(). This is provided as a convenience
* function for debugging.
*
* @param string $key
*
* @return string
*/
public function decodeKey( $key ) {
return urldecode( $key );
}
/**
* Send a debug message to the log
* @param string $text
*/
protected function debugLog( $text ) {
wfDebugLog( 'memcached', $text );
}
}
|
