summaryrefslogtreecommitdiff
path: root/web/lib/cachefuncs.inc.php
blob: 3485b013c432fadcab15673047504b0d3d3b9a01 (plain)
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
<?php

if (!defined('CACHE_TYPE')) {
	define('CACHE_TYPE', 'NONE');
}

# Check if APC extension is loaded, and set cache prefix if it is.
if (CACHE_TYPE == 'APC' && !defined('EXTENSION_LOADED_APC')) {
	define('EXTENSION_LOADED_APC', extension_loaded('apc'));
	define('CACHE_PREFIX', 'aur:');
}

# Check if memcache extension is loaded, and set cache prefix if it is.
if (CACHE_TYPE == 'MEMCACHE' && !defined('EXTENSION_LOADED_MEMCACHE')) {
	define('EXTENSION_LOADED_MEMCACHE', extension_loaded('memcached'));
	define('CACHE_PREFIX', 'aur:');
	global $memcache;
	$memcache = new Memcached();
	$mcs = defined('MEMCACHE_SERVERS') ? MEMCACHE_SERVERS : '127.0.0.1:11211';
	foreach (explode(',', $mcs) as $elem) {
		$telem = trim($elem);
		$mcserver = explode(':', $telem);
		$memcache->addServer($mcserver[0], intval($mcserver[1]));
	}
}

# Set a value in the cache (currently APC) if cache is available for use. If
# not available, this becomes effectively a no-op (return value is
# false). Accepts an optional TTL (defaults to 600 seconds).
function set_cache_value($key, $value, $ttl=600) {
	$status = false;
	if (defined('EXTENSION_LOADED_APC')) {
		$status = apc_store(CACHE_PREFIX.$key, $value, $ttl);
	}
	if (defined('EXTENSION_LOADED_MEMCACHE')) {
		global $memcache;
		$status = $memcache->set(CACHE_PREFIX.$key, $value, $ttl);
	}
	return $status;
}

# Get a value from the cache (currently APC) if cache is available for use. If
# not available, this returns false (optionally sets passed in variable $status
# to false, much like apc_fetch() behaves). This allows for testing the fetch
# result appropriately even in the event that a 'false' value was the value in
# the cache.
function get_cache_value($key, &$status=false) {
	if(defined('EXTENSION_LOADED_APC')) {
		$ret = apc_fetch(CACHE_PREFIX.$key, $status);
		if ($status) {
			return $ret;
		}
	}
	if (defined('EXTENSION_LOADED_MEMCACHE')) {
		global $memcache;
		$ret = $memcache->get(CACHE_PREFIX.$key);
		if (!$ret) {
			$status = false;
		}
		else {
			$status = true;
		}
		return $ret;
	}
	return $status;
}

# Run a simple db query, retrieving and/or caching the value if APC is
# available for use. Accepts an optional TTL value (defaults to 600 seconds).
function db_cache_value($dbq, $dbh, $key, $ttl=600) {
	$status = false;
	$value = get_cache_value($key, $status);
	if (!$status) {
		$result = db_query($dbq, $dbh);
		$row = mysql_fetch_row($result);
		$value = $row[0];
		set_cache_value($key, $value, $ttl);
	}
	return $value;
}

?>