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
|
<?php
/**
* Classes to cache objects in PHP accelerators, SQL database or DBA files
*
* Copyright © 2003-2004 Brion Vibber <brion@pobox.com>
* http://www.mediawiki.org/
*
* 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
*/
/**
* @defgroup Cache Cache
*/
/**
* interface is intended to be more or less compatible with
* the PHP memcached client.
*
* backends for local hash array and SQL table included:
* <code>
* $bag = new HashBagOStuff();
* $bag = new SqlBagOStuff(); # connect to db first
* </code>
*
* @ingroup Cache
*/
abstract class BagOStuff {
private $debugMode = false;
/**
* @param $bool bool
*/
public function setDebug( $bool ) {
$this->debugMode = $bool;
}
/* *** THE GUTS OF THE OPERATION *** */
/* Override these with functional things in subclasses */
/**
* Get an item with the given key. Returns false if it does not exist.
* @param $key string
* @return mixed Returns false on failure
*/
abstract public function get( $key );
/**
* Get an associative array containing the item for each of the given keys.
* Each item will be false if it does not exist.
* @param $keys Array List of strings
* @return Array
*/
public function getMulti( array $keys ) {
$res = array();
foreach ( $keys as $key ) {
$res[$key] = $this->get( $key );
}
return $res;
}
/**
* Set an item.
* @param $key string
* @param $value mixed
* @param $exptime int Either an interval in seconds or a unix timestamp for expiry
* @return bool success
*/
abstract public function set( $key, $value, $exptime = 0 );
/**
* Delete an item.
* @param $key string
* @param $time int Amount of time to delay the operation (mostly memcached-specific)
* @return bool True if the item was deleted or not found, false on failure
*/
abstract public function delete( $key, $time = 0 );
/**
* @param $key string
* @param $timeout integer
* @return bool success
*/
public function lock( $key, $timeout = 0 ) {
/* stub */
return true;
}
/**
* @param $key string
* @return bool success
*/
public function unlock( $key ) {
/* stub */
return true;
}
/**
* @todo: what is this?
* @return Array
*/
public function keys() {
/* stub */
return array();
}
/**
* Delete all objects expiring before a certain date.
* @param $date string The reference date in MW format
* @param $progressCallback callback|bool Optional, a function which will be called
* regularly during long-running operations with the percentage progress
* as the first parameter.
*
* @return bool on success, false if unimplemented
*/
public function deleteObjectsExpiringBefore( $date, $progressCallback = false ) {
// stub
return false;
}
/* *** Emulated functions *** */
/**
* @param $key string
* @param $value mixed
* @param $exptime integer
* @return bool success
*/
public function add( $key, $value, $exptime = 0 ) {
if ( !$this->get( $key ) ) {
return $this->set( $key, $value, $exptime );
}
return true;
}
/**
* @param $key string
* @param $value mixed
* @return bool success
*/
public function replace( $key, $value, $exptime = 0 ) {
if ( $this->get( $key ) !== false ) {
return $this->set( $key, $value, $exptime );
}
return true;
}
/**
* @param $key String: Key to increase
* @param $value Integer: Value to add to $key (Default 1)
* @return null if lock is not possible else $key value increased by $value
* @return success
*/
public function incr( $key, $value = 1 ) {
if ( !$this->lock( $key ) ) {
return null;
}
$value = intval( $value );
if ( ( $n = $this->get( $key ) ) !== false ) {
$n += $value;
$this->set( $key, $n ); // exptime?
}
$this->unlock( $key );
return $n;
}
/**
* @param $key String
* @param $value Integer
* @return bool success
*/
public function decr( $key, $value = 1 ) {
return $this->incr( $key, - $value );
}
/**
* @param $text string
*/
public function debug( $text ) {
if ( $this->debugMode ) {
$class = get_class( $this );
wfDebug( "$class debug: $text\n" );
}
}
/**
* Convert an optionally relative time to an absolute time
* @param $exptime integer
* @return int
*/
protected function convertExpiry( $exptime ) {
if ( ( $exptime != 0 ) && ( $exptime < 86400 * 3650 /* 10 years */ ) ) {
return time() + $exptime;
} else {
return $exptime;
}
}
}
|
