/usr/share/php/Horde/Kolab/Storage/Cache.php is in php-horde-kolab-storage 2.0.5-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 | <?php
/**
* A cache for Kolab storage.
*
* PHP version 5
*
* @category Kolab
* @package Kolab_Storage
* @author Gunnar Wrobel <wrobel@pardus.de>
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @link http://pear.horde.org/index.php?package=Kolab_Storage
*/
/**
* The Kolab_Cache class provides a cache for Kolab groupware objects.
*
* The Horde_Kolab_Storage_Cache singleton instance provides caching for all
* storage folders. So before operating on the cache data it is necessary to
* load the desired folder data. Before switching the folder the cache data
* should be saved.
*
* This class does not offer a lot of safeties and is primarily intended to be
* used within the Horde_Kolab_Storage_Data class.
*
* Copyright 2007-2013 Horde LLC (http://www.horde.org/)
*
* See the enclosed file COPYING for license information (LGPL). If you
* did not receive this file, see http://www.horde.org/licenses/lgpl21.
*
* @category Kolab
* @package Kolab_Storage
* @author Gunnar Wrobel <wrobel@pardus.de>
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @link http://pear.horde.org/index.php?package=Kolab_Storage
*/
class Horde_Kolab_Storage_Cache
{
/**
* The link to the horde cache.
*
* @var Horde_Cache
*/
protected $horde_cache;
/**
* List cache instances.
*
* @var array
*/
private $_list_caches;
/**
* Data cache instances.
*
* @var array
*/
private $_data_caches;
/**
* Constructor.
*
* @param Horde_Cache $cache The global cache for temporary data storage.
*/
public function __construct($cache)
{
$this->horde_cache = $cache;
}
/**
* Return a data cache.
*
* @param array $data_params Return the data cache for a data set
* with these parameters.
*
* @return Horde_Kolab_Storage_Cache_Data The data cache.
*/
public function getDataCache($data_params)
{
$data_id = $this->_getDataId($data_params);
if (!isset($this->_data_caches[$data_id])) {
$this->_data_caches[$data_id] = new Horde_Kolab_Storage_Cache_Data(
$this, $data_params
);
$this->_data_caches[$data_id]->setDataId($data_id);
}
return $this->_data_caches[$data_id];
}
/**
* Retrieve data set.
*
* @param string $data_id ID of the data set.
*
* @return string The cached data set.
*/
public function loadData($data_id)
{
return $this->horde_cache->get($data_id, 0);
}
/**
* Cache data set.
*
* @param string $data_id ID of the data set.
* @param string $data The data to be cached.
*
* @return NULL
*/
public function storeData($data_id, $data)
{
$this->horde_cache->set($data_id, $data, 0);
}
/**
* Retrieve an attachment.
*
* @param string $data_id ID of the data set.
* @param string $obid Object backend id.
* @param string $attachment_id Attachment ID.
*
* @return resource A stream opened to the attachement data.
*/
public function loadAttachment($data_id, $obid, $attachment_id)
{
return $this->horde_cache->get(
$this->_getAttachmentId($data_id, $obid, $attachment_id),
0
);
}
/**
* Store an attachment.
*
* @param string $data_id ID of the data set.
* @param string $obid Object backend id.
* @param string $attachment_id Attachment ID.
* @param resource $data A stream opened to the attachement data.
*
* @return NULL
*/
public function storeAttachment($data_id, $obid, $attachment_id, $data)
{
$this->horde_cache->set(
$this->_getAttachmentId($data_id, $obid, $attachment_id),
$data,
0
);
}
/**
* Delete a cached attachment.
*
* @param string $data_id ID of the data set.
* @param string $obid Object backend id.
* @param string $attachment_id Attachment ID.
*
* @return NULL
*/
public function deleteAttachment($data_id, $obid, $attachment_id)
{
return $this->horde_cache->expire(
$this->_getAttachmentId($data_id, $obid, $attachment_id)
);
}
/**
* Retrieve list data.
*
* @param string $list_id ID of the connection matching the list.
*
* @return string The data of the object.
*/
public function loadList($list_id)
{
return $this->horde_cache->get($list_id, 0);
}
/**
* Cache list data.
*
* @param string $list_id ID of the connection matching the list.
* @param string $data The data to be cached.
*
* @return NULL
*/
public function storeList($list_id, $data)
{
$this->horde_cache->set($list_id, $data, 0);
}
/**
* Compose the data key.
*
* @param array $data_params Return the data ID for a data set with these
* parameters.
*
* @return string The data cache ID.
*/
private function _getDataId($data_params)
{
foreach (array('host', 'port', 'prefix', 'folder', 'type', 'owner') as $key) {
$this->requireParameter($data_params, 'data', $key);
}
ksort($data_params);
return md5(serialize($data_params));
}
/**
* Compose the attachment key.
*
* @param string $data_id ID of the data set.
* @param string $obid Object backend id.
* @param string $attachment_id Attachment ID.
*
* @return string The attachment cache ID.
*/
private function _getAttachmentId($data_id, $obid, $attachment_id)
{
return md5(
serialize(array('d' => $data_id, 'o' => (string)$obid, 'p' => (string)$attachment_id))
);
}
/**
* Determine if a necessary parameter is set.
*
* @return NULL
*
* @throws Horde_Kolab_Storage_Exception In case the parameter is missing.
*/
public function requireParameter($parameters, $type, $key)
{
if (!isset($parameters[$key])) {
throw new Horde_Kolab_Storage_Exception(
sprintf(
'Unable to determine the %s cache key: The "%s" parameter is missing!',
$type,
$key
)
);
}
}
}
|