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
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
|
<?php
/**
* Wrapper for object caching in different caches.
*
* 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
*/
/**
* A cache class that replicates all writes to multiple child caches. Reads
* are implemented by reading from the caches in the order they are given in
* the configuration until a cache gives a positive result.
*
* @ingroup Cache
*/
class MultiWriteBagOStuff extends BagOStuff {
/** @var array BagOStuff[] */
protected $caches;
/**
* Constructor. Parameters are:
*
* - caches: This should have a numbered array of cache parameter
* structures, in the style required by $wgObjectCaches. See
* the documentation of $wgObjectCaches for more detail.
*
* @param array $params
* @throws MWException
*/
public function __construct( $params ) {
if ( !isset( $params['caches'] ) ) {
throw new MWException( __METHOD__ . ': the caches parameter is required' );
}
$this->caches = array();
foreach ( $params['caches'] as $cacheInfo ) {
$this->caches[] = ObjectCache::newFromParams( $cacheInfo );
}
}
/**
* @param bool $debug
*/
public function setDebug( $debug ) {
$this->doWrite( 'setDebug', $debug );
}
/**
* @param string $key
* @param mixed $casToken [optional]
* @return bool|mixed
*/
public function get( $key, &$casToken = null ) {
foreach ( $this->caches as $cache ) {
$value = $cache->get( $key );
if ( $value !== false ) {
return $value;
}
}
return false;
}
/**
* @param mixed $casToken
* @param string $key
* @param mixed $value
* @param mixed $exptime
* @return bool
*/
public function cas( $casToken, $key, $value, $exptime = 0 ) {
throw new MWException( "CAS is not implemented in " . __CLASS__ );
}
/**
* @param string $key
* @param mixed $value
* @param int $exptime
* @return bool
*/
public function set( $key, $value, $exptime = 0 ) {
return $this->doWrite( 'set', $key, $value, $exptime );
}
/**
* @param string $key
* @param int $time
* @return bool
*/
public function delete( $key, $time = 0 ) {
return $this->doWrite( 'delete', $key, $time );
}
/**
* @param string $key
* @param mixed $value
* @param int $exptime
* @return bool
*/
public function add( $key, $value, $exptime = 0 ) {
return $this->doWrite( 'add', $key, $value, $exptime );
}
/**
* @param string $key
* @param int $value
* @return bool|null
*/
public function incr( $key, $value = 1 ) {
return $this->doWrite( 'incr', $key, $value );
}
/**
* @param string $key
* @param int $value
* @return bool
*/
public function decr( $key, $value = 1 ) {
return $this->doWrite( 'decr', $key, $value );
}
/**
* @param string $key
* @param int $timeout
* @return bool
*/
public function lock( $key, $timeout = 0 ) {
// Lock only the first cache, to avoid deadlocks
if ( isset( $this->caches[0] ) ) {
return $this->caches[0]->lock( $key, $timeout );
} else {
return true;
}
}
/**
* @param string $key
* @return bool
*/
public function unlock( $key ) {
if ( isset( $this->caches[0] ) ) {
return $this->caches[0]->unlock( $key );
} else {
return true;
}
}
/**
* @param string $key
* @param Closure $callback Callback method to be executed
* @param int $exptime Either an interval in seconds or a unix timestamp for expiry
* @param int $attempts The amount of times to attempt a merge in case of failure
* @return bool Success
*/
public function merge( $key, Closure $callback, $exptime = 0, $attempts = 10 ) {
return $this->doWrite( 'merge', $key, $callback, $exptime );
}
public function getLastError() {
return isset( $this->caches[0] ) ? $this->caches[0]->getLastError() : self::ERR_NONE;
}
public function clearLastError() {
if ( isset( $this->caches[0] ) ) {
$this->caches[0]->clearLastError();
}
}
/**
* @param string $method
* @return bool
*/
protected function doWrite( $method /*, ... */ ) {
$ret = true;
$args = func_get_args();
array_shift( $args );
foreach ( $this->caches as $cache ) {
if ( !call_user_func_array( array( $cache, $method ), $args ) ) {
$ret = false;
}
}
return $ret;
}
/**
* Delete objects expiring before a certain date.
*
* Succeed if any of the child caches succeed.
* @param string $date
* @param bool|callable $progressCallback
* @return bool
*/
public function deleteObjectsExpiringBefore( $date, $progressCallback = false ) {
$ret = false;
foreach ( $this->caches as $cache ) {
if ( $cache->deleteObjectsExpiringBefore( $date, $progressCallback ) ) {
$ret = true;
}
}
return $ret;
}
}
|
