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
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
|
<?php
/**
* 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
*/
namespace Wikimedia\ObjectCache;
use MemcachedClient;
/**
* Store data on memcached servers(s) via a pure-PHP memcached client.
*
* In configuration, the CACHE_MEMCACHED will activate the MemcachedPhpBagOStuff
* class. This works out of the box without any PHP extension or other PECL
* dependencies. If you can install the php-memcached PECL extension,
* it is recommended to use MemcachedPeclBagOStuff instead.
*
* @ingroup Cache
*/
class MemcachedPhpBagOStuff extends MemcachedBagOStuff {
/** @var MemcachedClient */
protected $client;
/**
* Available parameters are:
* - servers: The list of IP:port combinations holding the memcached servers.
* - persistent: Whether to use a persistent connection
* - compress_threshold: The minimum size an object must be before it is compressed
* - timeout: The read timeout in microseconds
* - connect_timeout: The connect timeout in seconds
*
* @param array $params
*/
public function __construct( $params ) {
parent::__construct( $params );
// Default class-specific parameters
$params += [
'compress_threshold' => 1500,
'connect_timeout' => 0.5,
'timeout' => 500000,
];
$this->client = new MemcachedClient( $params );
$this->client->set_servers( $params['servers'] );
$this->client->set_debug( true );
}
protected function doGet( $key, $flags = 0, &$casToken = null ) {
$getToken = ( $casToken === self::PASS_BY_REF );
$casToken = null;
$routeKey = $this->validateKeyAndPrependRoute( $key );
// T257003: only require "gets" (instead of "get") when a CAS token is needed
$res = $getToken // @phan-suppress-next-line PhanTypeMismatchArgument False positive
? $this->client->get( $routeKey, $casToken ) : $this->client->get( $routeKey );
if ( $this->client->_last_cmd_status !== self::ERR_NONE ) {
$this->setLastError( $this->client->_last_cmd_status );
}
return $res;
}
protected function doSet( $key, $value, $exptime = 0, $flags = 0 ) {
$routeKey = $this->validateKeyAndPrependRoute( $key );
$res = $this->client->set( $routeKey, $value, $this->fixExpiry( $exptime ) );
if ( $this->client->_last_cmd_status !== self::ERR_NONE ) {
$this->setLastError( $this->client->_last_cmd_status );
}
return $res;
}
protected function doDelete( $key, $flags = 0 ) {
$routeKey = $this->validateKeyAndPrependRoute( $key );
$res = $this->client->delete( $routeKey );
if ( $this->client->_last_cmd_status !== self::ERR_NONE ) {
$this->setLastError( $this->client->_last_cmd_status );
}
return $res;
}
protected function doAdd( $key, $value, $exptime = 0, $flags = 0 ) {
$routeKey = $this->validateKeyAndPrependRoute( $key );
$res = $this->client->add( $routeKey, $value, $this->fixExpiry( $exptime ) );
if ( $this->client->_last_cmd_status !== self::ERR_NONE ) {
$this->setLastError( $this->client->_last_cmd_status );
}
return $res;
}
protected function doCas( $casToken, $key, $value, $exptime = 0, $flags = 0 ) {
$routeKey = $this->validateKeyAndPrependRoute( $key );
$res = $this->client->cas( $casToken, $routeKey, $value, $this->fixExpiry( $exptime ) );
if ( $this->client->_last_cmd_status !== self::ERR_NONE ) {
$this->setLastError( $this->client->_last_cmd_status );
}
return $res;
}
protected function doIncrWithInitAsync( $key, $exptime, $step, $init ) {
$routeKey = $this->validateKeyAndPrependRoute( $key );
$watchPoint = $this->watchErrors();
$this->client->add( $routeKey, $init - $step, $this->fixExpiry( $exptime ) );
$this->client->incr( $routeKey, $step );
return !$this->getLastError( $watchPoint );
}
protected function doIncrWithInitSync( $key, $exptime, $step, $init ) {
$routeKey = $this->validateKeyAndPrependRoute( $key );
$watchPoint = $this->watchErrors();
$newValue = $this->client->incr( $routeKey, $step ) ?? false;
if ( $newValue === false && !$this->getLastError( $watchPoint ) ) {
// No key set; initialize
$success = $this->client->add( $routeKey, $init, $this->fixExpiry( $exptime ) );
$newValue = $success ? $init : false;
if ( $newValue === false && !$this->getLastError( $watchPoint ) ) {
// Raced out initializing; increment
$newValue = $this->client->incr( $routeKey, $step ) ?? false;
}
}
return $newValue;
}
protected function doChangeTTL( $key, $exptime, $flags ) {
$routeKey = $this->validateKeyAndPrependRoute( $key );
$res = $this->client->touch( $routeKey, $this->fixExpiry( $exptime ) );
if ( $this->client->_last_cmd_status !== self::ERR_NONE ) {
$this->setLastError( $this->client->_last_cmd_status );
}
return $res;
}
protected function doGetMulti( array $keys, $flags = 0 ) {
$routeKeys = [];
foreach ( $keys as $key ) {
$routeKeys[] = $this->validateKeyAndPrependRoute( $key );
}
$resByRouteKey = $this->client->get_multi( $routeKeys );
$res = [];
foreach ( $resByRouteKey as $routeKey => $value ) {
$res[$this->stripRouteFromKey( $routeKey )] = $value;
}
if ( $this->client->_last_cmd_status !== self::ERR_NONE ) {
$this->setLastError( $this->client->_last_cmd_status );
}
return $res;
}
protected function serialize( $value ) {
return is_int( $value ) ? $value : $this->client->serialize( $value );
}
protected function unserialize( $value ) {
return $this->isInteger( $value ) ? (int)$value : $this->client->unserialize( $value );
}
}
/** @deprecated class alias since 1.43 */
class_alias( MemcachedPhpBagOStuff::class, 'MemcachedPhpBagOStuff' );
|
