3 # Copyright (C) 2003-2004 Brion Vibber <brion@pobox.com>
4 # http://www.mediawiki.org/
6 # This program is free software; you can redistribute it and/or modify
7 # it under the terms of the GNU General Public License as published by
8 # the Free Software Foundation; either version 2 of the License, or
9 # (at your option) any later version.
11 # This program is distributed in the hope that it will be useful,
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 # GNU General Public License for more details.
16 # You should have received a copy of the GNU General Public License along
17 # with this program; if not, write to the Free Software Foundation, Inc.,
18 # 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
19 # http://www.gnu.org/copyleft/gpl.html
26 * Simple generic object store
28 * interface is intended to be more or less compatible with
29 * the PHP memcached client.
31 * backends for local hash array and SQL table included:
32 * $bag = new HashBagOStuff();
33 * $bag = new MysqlBagOStuff($tablename); # connect to db first
41 function BagOStuff() {
42 $this->set_debug( false );
45 function set_debug($bool) {
46 $this->debugmode
= $bool;
49 /* *** THE GUTS OF THE OPERATION *** */
50 /* Override these with functional things in subclasses */
57 function set($key, $value, $exptime=0) {
62 function delete($key, $time=0) {
67 function lock($key, $timeout = 0) {
72 function unlock($key) {
77 /* *** Emulated functions *** */
78 /* Better performance can likely be got with custom written versions */
79 function get_multi($keys) {
81 foreach($keys as $key)
82 $out[$key] = $this->get($key);
86 function set_multi($hash, $exptime=0) {
87 foreach($hash as $key => $value)
88 $this->set($key, $value, $exptime);
91 function add($key, $value, $exptime=0) {
92 if( $this->get($key) == false ) {
93 $this->set($key, $value, $exptime);
98 function add_multi($hash, $exptime=0) {
99 foreach($hash as $key => $value)
100 $this->add($key, $value, $exptime);
103 function delete_multi($keys, $time=0) {
104 foreach($keys as $key)
105 $this->delete($key, $time);
108 function replace($key, $value, $exptime=0) {
109 if( $this->get($key) !== false )
110 $this->set($key, $value, $exptime);
113 function incr($key, $value=1) {
114 if ( !$this->lock($key) ) {
117 $value = intval($value);
118 if($value < 0) $value = 0;
121 if( ($n = $this->get($key)) !== false ) {
123 $this->set($key, $n); // exptime?
129 function decr($key, $value=1) {
130 if ( !$this->lock($key) ) {
133 $value = intval($value);
134 if($value < 0) $value = 0;
137 if( ($n = $this->get($key)) !== false ) {
140 $this->set($key, $m); // exptime?
146 function _debug($text) {
148 wfDebug("BagOStuff debug: $text\n");
154 * Functional versions!
158 class HashBagOStuff
extends BagOStuff
{
160 This is a test of the interface, mainly. It stores
161 things in an associative array, which is not going to
162 persist between program runs.
166 function HashBagOStuff() {
167 $this->bag
= array();
170 function _expire($key) {
171 $et = $this->bag
[$key][1];
172 if(($et == 0) ||
($et > time()))
179 if(!$this->bag
[$key])
181 if($this->_expire($key))
183 return $this->bag
[$key][0];
186 function set($key,$value,$exptime=0) {
187 if(($exptime != 0) && ($exptime < 3600*24*30))
188 $exptime = time() +
$exptime;
189 $this->bag
[$key] = array( $value, $exptime );
192 function delete($key,$time=0) {
193 if(!$this->bag
[$key])
195 unset($this->bag
[$key]);
201 CREATE TABLE objectcache (
202 keyname char(255) binary not null default '',
205 unique key (keyname),
215 class SqlBagOStuff
extends BagOStuff
{
218 function SqlBagOStuff($tablename = 'objectcache') {
219 $this->table
= $tablename;
223 /* expire old entries if any */
226 $res = $this->_query(
227 "SELECT value,exptime FROM $0 WHERE keyname='$1'", $key);
229 $this->_debug("get: ** error: " . $this->_dberror($res) . " **");
232 if($row=$this->_fetchobject($res)) {
233 $this->_debug("get: retrieved data; exp time is " . $row->exptime
);
234 return $this->_unserialize($row->value
);
236 $this->_debug('get: no matching rows');
241 function set($key,$value,$exptime=0) {
242 $exptime = intval($exptime);
243 if($exptime < 0) $exptime = 0;
245 $exp = $this->_maxdatetime();
247 if($exptime < 3600*24*30)
249 $exp = $this->_fromunixtime($exptime);
251 $this->delete( $key );
253 "INSERT INTO $0 (keyname,value,exptime) VALUES('$1','$2','$exp')",
254 $key, $this->_serialize($value));
258 function delete($key,$time=0) {
260 "DELETE FROM $0 WHERE keyname='$1'", $key );
264 function getTableName() {
268 function _query($sql) {
269 $reps = func_get_args();
270 $reps[0] = $this->getTableName();
272 for($i=0;$i<count($reps);$i++
) {
275 $this->_strencode($reps[$i]),
278 $res = $this->_doquery($sql);
280 $this->_debug('query failed: ' . $this->_dberror($res));
285 function _strencode($str) {
286 /* Protect strings in SQL */
287 return str_replace( "'", "''", $str );
290 function _doquery($sql) {
291 die( 'abstract function SqlBagOStuff::_doquery() must be defined' );
294 function _fetchrow($res) {
295 die( 'abstract function SqlBagOStuff::_fetchrow() must be defined' );
298 function _freeresult($result) {
303 function _dberror($result) {
305 return 'unknown error';
308 function _maxdatetime() {
309 die( 'abstract function SqlBagOStuff::_maxdatetime() must be defined' );
312 function _fromunixtime() {
313 die( 'abstract function SqlBagOStuff::_fromunixtime() must be defined' );
316 function expireall() {
317 /* Remove any items that have expired */
318 $now=$this->_fromunixtime(time());
319 $this->_query( "DELETE FROM $0 WHERE exptime<'$now'" );
322 function deleteall() {
323 /* Clear *all* items from cache table */
324 $this->_query( "DELETE FROM $0" );
328 * Serialize an object and, if possible, compress the representation.
329 * On typical message and page data, this can provide a 3X decrease
330 * in storage requirements.
335 function _serialize( &$data ) {
336 $serial = serialize( $data );
337 if( function_exists( 'gzdeflate' ) ) {
338 return gzdeflate( $serial );
345 * Unserialize and, if necessary, decompress an object.
346 * @param string $serial
349 function &_unserialize( $serial ) {
350 if( function_exists( 'gzinflate' ) ) {
351 $decomp = @gzinflate
( $serial );
352 if( false !== $decomp ) {
356 return unserialize( $serial );
364 class MediaWikiBagOStuff
extends SqlBagOStuff
{
365 var $tableInitialised = false;
367 function _doquery($sql) {
368 $dbw =& wfGetDB( DB_MASTER
);
369 return $dbw->query($sql, 'MediaWikiBagOStuff:_doquery');
371 function _fetchobject($result) {
372 $dbw =& wfGetDB( DB_MASTER
);
373 return $dbw->fetchObject($result);
375 function _freeresult($result) {
376 $dbw =& wfGetDB( DB_MASTER
);
377 return $dbw->freeResult($result);
379 function _dberror($result) {
380 $dbw =& wfGetDB( DB_MASTER
);
381 return $dbw->lastError();
383 function _maxdatetime() {
384 return '9999-12-31 12:59:59';
386 function _fromunixtime($ts) {
387 return gmdate( 'Y-m-d H:i:s', $ts );
389 function _strencode($s) {
390 $dbw =& wfGetDB( DB_MASTER
);
391 return $dbw->strencode($s);
393 function getTableName() {
394 if ( !$this->tableInitialised
) {
395 $dbw =& wfGetDB( DB_MASTER
);
396 $this->table
= $dbw->tableName( $this->table
);
397 $this->tableInitialised
= true;
404 * This is a wrapper for Turck MMCache's shared memory functions.
406 * You can store objects with mmcache_put() and mmcache_get(), but Turck seems
407 * to use a weird custom serializer that randomly segfaults. So we wrap calls
408 * with serialize()/unserialize().
410 * The thing I noticed about the Turck serialized data was that unlike ordinary
411 * serialize(), it contained the names of methods, and judging by the amount of
412 * binary data, perhaps even the bytecode of the methods themselves. It may be
413 * that Turck's serializer is faster, so a possible future extension would be
414 * to use it for arrays but not for objects.
418 class TurckBagOStuff
extends BagOStuff
{
420 $val = mmcache_get( $key );
421 if ( is_string( $val ) ) {
422 $val = unserialize( $val );
427 function set($key, $value, $exptime=0) {
428 mmcache_put( $key, serialize( $value ), $exptime );
432 function delete($key, $time=0) {
437 function lock($key, $waitTimeout = 0 ) {
438 mmcache_lock( $key );
442 function unlock($key) {
443 mmcache_unlock( $key );