/usr/share/php/Horde/Kolab/Storage/List/Cache.php is in php-horde-kolab-storage 2.2.1-1ubuntu1.
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 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 | <?php
/**
* A cache backend for Kolab storage list handlers.
*
* 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
*/
/**
* A cache backend for Kolab storage list handlers.
*
* Copyright 2010-2016 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_List_Cache
{
/** Key for the folder list. */
const FOLDERS = 'F';
/** Key for the type list. */
const TYPES = 'T';
/** Key for the namespace data. */
const NAME_SPACE = 'N';
/** Key for the backend capabilities. */
const SUPPORT = 'C';
/** Holds query results. */
const QUERIES = 'Q';
/** Holds long term cache data. */
const LONG_TERM = 'L';
/** Key for the last time the list was synchronized. */
const SYNC = 'S';
/** Key for the cache format version. */
const VERSION = 'V';
/** Key for the connection ID associated with this list cache. */
const ID = 'I';
/** Holds the version number of the cache format. */
const FORMAT_VERSION = '1';
/**
* The core cache driver.
*
* @var Horde_Kolab_Storage_Cache
*/
private $_cache;
/**
* List parameters that will be recorded in the cache.
*
* @var array
*/
private $_parameters;
/**
* List ID.
*
* @var string
*/
private $_list_id;
/**
* The list data.
*
* @var array
*/
private $_data = false;
/**
* Constructor.
*
* @param Horde_Kolab_Storage_Cache $cache The core cache driver.
* @param array $parameters Connection parameters that
* are only recorded and have
* no further impact.
*/
public function __construct(Horde_Kolab_Storage_Cache $cache,
$parameters = array())
{
$this->_cache = $cache;
$this->_parameters = $parameters;
$this->_setListId();
}
/**
* Compose the list key.
*/
private function _setListId()
{
foreach (array('host', 'port', 'user') as $key) {
$this->_cache->requireParameter($this->_parameters, 'list', $key);
}
ksort($this->_parameters);
$this->_list_id = md5(serialize($this->_parameters));
}
/**
* Return the ID for the list cache.
*
* @return string The unique ID for the list used when caching it.
*/
public function getListId()
{
if ($this->_list_id === null) {
throw new Horde_Kolab_Storage_Exception(
'You must set the ID of the list cache!'
);
}
return $this->_list_id;
}
/**
* Retrieve the cached list data.
*
* @return mixed The data of the object.
*/
private function _load()
{
if ($this->_data === false) {
$this->_data = unserialize($this->_cache->loadList($this->getListId()));
if (!is_array($this->_data)
|| !isset($this->_data[self::SYNC])
|| !isset($this->_data[self::VERSION])
|| $this->_data[self::VERSION] != self::FORMAT_VERSION) {
$this->_data = array();
}
}
}
/**
* Cache the list data.
*
* @return NULL
*/
public function save()
{
$this->_cache->storeList($this->getListId(), serialize($this->_data));
}
/**
* Check if the cache has been initialized.
*
* @return boolean True if cache data is available.
*/
public function isInitialized()
{
$this->_load();
return !empty($this->_data);
}
/**
* Returns the last sync stamp.
*
* @return string The last sync stamp.
*/
public function getStamp()
{
$this->_load();
if (isset($this->_data[self::SYNC])) {
return $this->_data[self::SYNC];
}
return 0;
}
/**
* Returns the list of folders from the cache.
*
* @return array The list of folders, represented as a list of strings.
*/
public function getFolders()
{
$this->_load();
if (isset($this->_data[self::FOLDERS])) {
return $this->_data[self::FOLDERS];
} else {
throw new Horde_Kolab_Storage_Exception(
sprintf('Missing cache data (Key: %s). Synchronize first!', self::FOLDERS)
);
}
}
/**
* Returns if the folder type annotation is stored in the cache.
*
* @return boolean True if the type annotation is available.
*/
public function hasFolderTypes()
{
$this->_load();
if (isset($this->_data[self::TYPES])) {
return true;
}
return false;
}
/**
* Returns the folder type annotation from the cache.
*
* @return array The list folder types with the folder names as key and the
* folder type as values.
*/
public function getFolderTypes()
{
if ($this->hasFolderTypes()) {
return $this->_data[self::TYPES];
} else {
throw new Horde_Kolab_Storage_Exception(
sprintf('Missing cache data (Key: %s). Synchronize first!', self::TYPES)
);
}
}
/**
* Returns if the namespace information is available.
*
* @return boolean True if the information exists in the cache.
*/
public function hasNamespace()
{
$this->_load();
return isset($this->_data[self::NAME_SPACE]);
}
/**
* Return namespace information.
*
* @return mixed The namespace data.
*/
public function getNamespace()
{
if ($this->hasNamespace()) {
return $this->_data[self::NAME_SPACE];
} else {
throw new Horde_Kolab_Storage_Exception(
'Missing namespace data. Synchronize first!'
);
}
}
/**
* Set namespace information.
*
* @param mixed $data The namespace data.
*
* @return NULL
*/
public function setNamespace($data)
{
$this->_load();
$this->_data[self::NAME_SPACE] = $data;
}
/**
* Has the capability support already been cached?
*
* @return boolean True if the value is already in the cache.
*/
public function issetSupport($capability)
{
$this->_load();
return isset($this->_data[self::SUPPORT][$capability]);
}
/**
* Has the list support for the requested capability?
*
* @param string $capability The name of the requested capability.
*
* @return boolean True if the backend supports the requested capability.
*/
public function hasSupport($capability)
{
if ($this->issetSupport($capability)) {
return $this->_data[self::SUPPORT][$capability];
} else {
throw new Horde_Kolab_Storage_Exception(
'Missing support data. Synchronize first!'
);
}
}
/**
* Set if the list supports the given capability.
*
* @param string $capability The name of the requested capability.
* @param boolean $flag True if the capability is supported.
*
* @return NULL
*/
public function setSupport($capability, $flag)
{
$this->_load();
$this->_data[self::SUPPORT][$capability] = $flag;
}
/**
* Is the specified query data available in the cache?
*
* @param string $key The query key.
*
* @return boolean True in case cached data is available.
*/
public function hasQuery($key)
{
$this->_load();
return isset($this->_data[self::QUERIES][$key]);
}
/**
* Return query information.
*
* @param string $key The query key.
*
* @return mixed The query data.
*/
public function getQuery($key)
{
if ($this->hasQuery($key)) {
return $this->_data[self::QUERIES][$key];
} else {
throw new Horde_Kolab_Storage_Exception(
sprintf('Missing query cache data (Key: %s). Synchronize first!', $key)
);
}
}
/**
* Set query information.
*
* @param string $key The query key.
* @param mixed $data The query data.
*
* @return NULL
*/
public function setQuery($key, $data)
{
$this->_load();
$this->_data[self::QUERIES][$key] = $data;
}
/**
* Is the specified long term data available in the cache?
*
* @param string $key The long term key.
*
* @return boolean True in case cached data is available.
*/
public function hasLongTerm($key)
{
$this->_load();
return isset($this->_data[self::LONG_TERM][$key]);
}
/**
* Return long term information.
*
* @param string $key The long term key.
*
* @return mixed The long term data.
*/
public function getLongTerm($key)
{
if ($this->hasLongTerm($key)) {
return $this->_data[self::LONG_TERM][$key];
} else {
throw new Horde_Kolab_Storage_Exception(
sprintf('Missing long term cache data (Key: %s). Synchronize first!', $key)
);
}
}
/**
* Set long term information.
*
* @param string $key The long term key.
* @param mixed $data The long term data.
*
* @return NULL
*/
public function setLongTerm($key, $data)
{
$this->_load();
$this->_data[self::LONG_TERM][$key] = $data;
}
/**
* Store the folder list and folder type annotations in the cache.
*
* @return NULL
*/
public function store(array $folders = null, array $types = null)
{
$this->_load();
$this->_data[self::QUERIES] = array();
$this->_data[self::FOLDERS] = $folders;
$this->_data[self::TYPES] = $types;
$this->_data[self::VERSION] = self::FORMAT_VERSION;
$this->_data[self::ID] = serialize($this->_parameters);
$this->_data[self::SYNC] = pack('Nn', time(), mt_rand());
}
}
|