/usr/share/php/Horde/Kolab/Storage/Cache/Data.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 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 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 | <?php
/**
* A cache backend for Kolab storage data handlers.
*
* PHP version 5
*
* @category Kolab
* @package Kolab_Storage
* @author Thomas Jarosch <thomas.jarosch@intra2net.com>
* @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 data handlers.
*
* 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 Thomas Jarosch <thomas.jarosch@intra2net.com>
* @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_Data
{
/** Key for the backend ID to object ID mapping. */
const B2O = 'M';
/** Key for the object ID to backend ID mapping. */
const O2B = 'B';
/** Key for the objects. */
const OBJECTS = 'O';
/** Key for recording duplicate objects. */
const DUPLICATES = 'U';
/** Key for recording error objects. */
const ERRORS = 'E';
/** Key for the stamp. */
const STAMP = 'P';
/** Key for the data format version. */
const DATA_VERSION = 'D';
/** Key for the last time the data was synchronized. */
const SYNC = 'S';
/** Key for the cache format version. */
const VERSION = 'V';
/** Key for the data set parameters associated with this cache. */
const ID = 'I';
/** Holds the version number of the cache format. */
const FORMAT_VERSION = '1';
/** Holds query results. */
const QUERIES = 'Q';
/**
* The core cache driver.
*
* @var Horde_Kolab_Storage_Cache
*/
private $_cache;
/**
* Data parameters that will be recorded in the cache.
*
* @var array
*/
private $_parameters;
/**
* Data ID.
*
* @var string
*/
private $_data_id;
/**
* The cache data.
*
* @var array
*/
private $_data = false;
/**
* Constructor.
*
* @param Horde_Kolab_Storage_Cache $cache The core cache driver.
* @param array $parameters Data set parameters that
* are only recorded and have
* no further impact.
*/
public function __construct(Horde_Kolab_Storage_Cache $cache,
$parameters = null)
{
$this->_cache = $cache;
$this->_parameters = $parameters;
}
/**
* The ID for the data cache.
*
* @param string $data_id The unique ID for the data used when caching it.
*
* @return NULL
*/
public function setDataId($data_id)
{
$this->_data_id = $data_id;
}
/**
* Return the ID for the data cache.
*
* @return string The unique ID for the data used when caching it.
*/
public function getDataId()
{
if ($this->_data_id === null) {
throw new Horde_Kolab_Storage_Exception(
'You must set the ID of the data cache!'
);
}
return $this->_data_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->loadData($this->getDataId()));
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 data.
*
* @return NULL
*/
public function save()
{
$this->_cache->storeData($this->getDataId(), 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);
}
/**
* Retrieve the object list from the cache.
*
* @return array The list of objects.
*/
public function getObjects()
{
return $this->_fetchCacheEntry(self::OBJECTS);
}
/**
* Retrieve the specified object from the cache.
*
* @param string $obid The object ID to fetch.
*
* @return array The list of objects.
*/
public function getObjectByBackendId($obid)
{
$obids = $this->getBackendToObject();
if (isset($obids[$obid])) {
$objects = $this->getObjects();
return $objects[$obids[$obid]];
} else {
throw new Horde_Kolab_Storage_Exception(
sprintf ('No such object %s!', $obid)
);
}
}
/**
* Return the object ID to backend ID mapping.
*
* @return array The mapping.
*/
public function getObjectToBackend()
{
return $this->_fetchCacheEntry(self::O2B);
}
/**
* Return the backend ID to object ID mapping.
*
* @return array The mapping.
*/
public function getBackendToObject()
{
return $this->_fetchCacheEntry(self::B2O);
}
/**
* Retrieve the last stamp.
*
* @return Horde_Kolab_Storage_Folder_Stamp The last recorded stamp.
*/
public function getStamp()
{
$this->_checkInit(self::STAMP);
return $this->_data[self::STAMP];
}
/**
* Retrieve the data version.
*
* @return string The version of the stored data.
*/
public function getVersion()
{
$this->_checkInit(self::DATA_VERSION);
return $this->_data[self::DATA_VERSION];
}
/**
* Retrieve the list of object duplicates.
*
* @return array The list of duplicates.
*/
public function getDuplicates()
{
return $this->_fetchCacheEntry(self::DUPLICATES);
}
/**
* Retrieve the list of object errors.
*
* @return array The list of errors.
*/
public function getErrors()
{
return $this->_fetchCacheEntry(self::ERRORS);
}
/**
* Retrieve an attachment.
*
* @param string $obid Object backend id.
* @param string $attachment_id Attachment ID.
*
* @return resource A stream opened to the attachement data.
*/
public function getAttachment($obid, $attachment_id)
{
return $this->_cache->loadAttachment(
$this->getDataId(), $obid, $attachment_id
);
}
/**
* Retrieve an attachment by name.
*
* @param string $obid Object backend id.
* @param string $attachment_id Attachment ID.
*
* @return array An array of attachment resources.
*/
public function getAttachmentByName($obid, $name)
{
$object = $this->getObjectByBackendId($obid);
if (!isset($object['_attachments']['name'][$name])) {
throw new Horde_Kolab_Storage_Exception(
sprintf(
'No attachment named "%s" for object id %s!',
$name,
$obid
)
);
}
$result = array();
foreach ($object['_attachments']['name'][$name] as $attachment_id) {
$result[$attachment_id] = $this->_cache->loadAttachment(
$this->getDataId(), $obid, $attachment_id
);
}
return $result;
}
/**
* Retrieve an attachment by name.
*
* @param string $obid Object backend id.
* @param string $attachment_id Attachment ID.
*
* @return array An array of attachment resources.
*/
public function getAttachmentByType($obid, $type)
{
$object = $this->getObjectByBackendId($obid);
if (!isset($object['_attachments']['type'][$type])) {
throw new Horde_Kolab_Storage_Exception(
sprintf(
'No attachment with type "%s" for object id %s!',
$type,
$obid
)
);
}
$result = array();
foreach ($object['_attachments']['type'][$type] as $attachment_id) {
$result[$attachment_id] = $this->_cache->loadAttachment(
$this->getDataId(), $obid, $attachment_id
);
}
return $result;
}
/**
* Return the timestamp of the last synchronization.
*
* @return int Timestamp of the last sync.
*/
public function getLastSync()
{
$this->_load();
return isset($this->_data[self::SYNC]) ? $this->_data[self::SYNC] : false;
}
/**
* 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;
}
/**
* Fetch the specified cache entry in case it is present. Returns an empty
* array otherwise.
*
* @param string $key The key in the cached data array.
*
* @return array The cache entry.
*/
private function _fetchCacheEntry($key)
{
$this->_checkInit($key);
if (isset($this->_data[$key])) {
return $this->_data[$key];
} else {
return array();
}
}
/**
* Verify that the data cache is initialized.
*
* @param string $key The key in the cached data array.
*
* @return NULL
*
* @throws Horde_Kolab_Storage_Exception In case the cache has not been
* initialized.
*/
private function _checkInit($key)
{
if (!$this->isInitialized()) {
throw new Horde_Kolab_Storage_Exception(
sprintf('Missing cache data (Key: %s). Synchronize first!', $key)
);
}
}
/**
* Map backend IDs to object ids.
*
* @param array $backend_ids The list of backend IDs
*
* @return array A list that associates object IDs (values) to backend IDs
* (keys).
*/
public function backendMap($backend_ids)
{
if (empty($backend_ids)) {
return array();
}
$map = array();
foreach ($backend_ids as $item) {
$map[$item] = $this->_data[self::B2O][$item];
}
return $map;
}
/**
* Store the objects list in the cache.
*
* @param array $object The object data to store.
* @param Horde_Kolab_Storage_Folder_Stamp $stamp The current stamp.
* @param string $version The format version of
* the provided data.
* @param array $delete Backend IDs that were removed.
*
* @return NULL
*/
public function store(array $objects,
Horde_Kolab_Storage_Folder_Stamp $stamp,
$version,
array $delete = array())
{
$this->_load();
if (!empty($delete)) {
foreach ($delete as $obid => $object_id) {
$object = $this->_data[self::OBJECTS][$object_id];
if (isset($object['_attachments'])) {
foreach ($object['_attachments']['id'] as $id) {
$this->_cache->deleteAttachment(
$this->getDataId(), $obid, $id
);
}
}
unset($this->_data[self::O2B][$object_id]);
unset($this->_data[self::OBJECTS][$object_id]);
unset($this->_data[self::B2O][$obid]);
}
}
foreach ($objects as $obid => $object) {
if (!empty($object) && isset($object['uid'])) {
if (isset($this->_data[self::O2B][$object['uid']])) {
if (!isset($this->_data[self::DUPLICATES][$object['uid']])) {
$this->_data[self::DUPLICATES][$object['uid']][] = $this->_data[self::O2B][$object['uid']];
}
$this->_data[self::DUPLICATES][$object['uid']][] = $obid;
}
$this->_data[self::B2O][$obid] = $object['uid'];
$this->_data[self::O2B][$object['uid']] = $obid;
if (isset($object['_attachments'])) {
$attachments = array();
foreach ($object['_attachments'] as $id => $attachment) {
$attachments['id'][] = $id;
if (isset($attachment['name'])) {
$attachments['name'][$attachment['name']][] = $id;
}
if (isset($attachment['type'])) {
$attachments['type'][$attachment['type']][] = $id;
}
$this->_cache->storeAttachment($this->getDataId(), $obid, $id, $attachment['content']);
}
$object['_attachments'] = $attachments;
}
$this->_data[self::OBJECTS][$object['uid']] = $object;
} else {
$this->_data[self::B2O][$obid] = false;
$this->_data[self::ERRORS][] = $obid;
}
}
$this->_data[self::QUERIES] = array();
$this->_data[self::STAMP] = serialize($stamp);
$this->_data[self::DATA_VERSION] = $version;
$this->_data[self::VERSION] = self::FORMAT_VERSION;
$this->_data[self::ID] = serialize($this->_parameters);
$this->_data[self::SYNC] = time();
}
/**
* Initialize the cache structure.
*
* @return NULL
*/
public function reset()
{
$this->_data = array();
}
}
|