/usr/share/php/Horde/Imap/Client/Cache/Backend/Cache.php is in php-horde-imap-client 2.25.2-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 | <?php
/**
* Copyright 2005-2014 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 Horde
* @copyright 2005-2014 Horde LLC
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @package Imap_Client
*/
/**
* A Horde_Cache implementation for caching IMAP/POP data.
* Requires the Horde_Cache package.
*
* @author Michael Slusarz <slusarz@horde.org>
* @category Horde
* @copyright 2005-2014 Horde LLC
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @package Imap_Client
*/
class Horde_Imap_Client_Cache_Backend_Cache extends Horde_Imap_Client_Cache_Backend
{
/** Cache structure version. */
const VERSION = 3;
/**
* The cache object.
*
* @var Horde_Cache
*/
protected $_cache;
/**
* The working data for the current pageload. All changes take place to
* this data.
*
* @var array
*/
protected $_data = array();
/**
* The list of cache slices loaded.
*
* @var array
*/
protected $_loaded = array();
/**
* The mapping of UIDs to slices.
*
* @var array
*/
protected $_slicemap = array();
/**
* The list of items to update:
* - add: (array) List of IDs that were added.
* - slice: (array) List of slices that were modified.
* - slicemap: (boolean) Was slicemap info changed?
*
* @var array
*/
protected $_update = array();
/**
* Constructor.
*
* @param array $params Configuration parameters:
* <pre>
* - REQUIRED Parameters:
* - cacheob: (Horde_Cache) The cache object to use.
*
* - Optional Parameters:
* - lifetime: (integer) The lifetime of the cache data (in seconds).
* DEFAULT: 1 week (604800 seconds)
* - slicesize: (integer) The slicesize to use.
* DEFAULT: 50
* </pre>
*/
public function __construct(array $params = array())
{
// Default parameters.
$params = array_merge(array(
'lifetime' => 604800,
'slicesize' => 50
), array_filter($params));
if (!isset($params['cacheob'])) {
throw new InvalidArgumentException('Missing cacheob parameter.');
}
foreach (array('lifetime', 'slicesize') as $val) {
$params[$val] = intval($params[$val]);
}
parent::__construct($params);
}
/**
* Initialization tasks.
*/
protected function _initOb()
{
$this->_cache = $this->_params['cacheob'];
register_shutdown_function(array($this, 'save'));
}
/**
* Updates the cache.
*/
public function save()
{
$lifetime = $this->_params['lifetime'];
foreach ($this->_update as $mbox => $val) {
$s = &$this->_slicemap[$mbox];
if (!empty($val['add'])) {
if ($s['c'] <= $this->_params['slicesize']) {
$val['slice'][] = $s['i'];
$this->_loadSlice($mbox, $s['i']);
}
$val['slicemap'] = true;
foreach (array_keys(array_flip($val['add'])) as $uid) {
if ($s['c']++ > $this->_params['slicesize']) {
$s['c'] = 0;
$val['slice'][] = ++$s['i'];
$this->_loadSlice($mbox, $s['i']);
}
$s['s'][$uid] = $s['i'];
}
}
if (!empty($val['slice'])) {
$d = &$this->_data[$mbox];
$val['slicemap'] = true;
foreach (array_keys(array_flip($val['slice'])) as $slice) {
$data = array();
foreach (array_keys($s['s'], $slice) as $uid) {
$data[$uid] = is_array($d[$uid])
? serialize($d[$uid])
: $d[$uid];
}
$this->_cache->set($this->_getCid($mbox, $slice), serialize($data), $lifetime);
}
}
if (!empty($val['slicemap'])) {
$this->_cache->set($this->_getCid($mbox, 'slicemap'), serialize($s), $lifetime);
}
}
$this->_update = array();
}
/**
*/
public function get($mailbox, $uids, $fields, $uidvalid)
{
$ret = array();
$this->_loadUids($mailbox, $uids, $uidvalid);
if (empty($this->_data[$mailbox])) {
return $ret;
}
if (!empty($fields)) {
$fields = array_flip($fields);
}
$ptr = &$this->_data[$mailbox];
foreach (array_intersect($uids, array_keys($ptr)) as $val) {
if (is_string($ptr[$val])) {
$ptr[$val] = @unserialize($ptr[$val]);
}
$ret[$val] = (empty($fields) || empty($ptr[$val]))
? $ptr[$val]
: array_intersect_key($ptr[$val], $fields);
}
return $ret;
}
/**
*/
public function getCachedUids($mailbox, $uidvalid)
{
$this->_loadSliceMap($mailbox, $uidvalid);
return array_unique(array_merge(
array_keys($this->_slicemap[$mailbox]['s']),
(isset($this->_update[$mailbox]) ? $this->_update[$mailbox]['add'] : array())
));
}
/**
*/
public function set($mailbox, $data, $uidvalid)
{
$update = array_keys($data);
try {
$this->_loadUids($mailbox, $update, $uidvalid);
} catch (Horde_Imap_Client_Exception $e) {
// Ignore invalidity - just start building the new cache
}
$d = &$this->_data[$mailbox];
$s = &$this->_slicemap[$mailbox]['s'];
$add = $updated = array();
foreach ($data as $k => $v) {
if (isset($d[$k])) {
if (is_string($d[$k])) {
$d[$k] = @unserialize($d[$k]);
}
$d[$k] = is_array($d[$k])
? array_merge($d[$k], $v)
: $v;
if (isset($s[$k])) {
$updated[$s[$k]] = true;
}
} else {
$d[$k] = $v;
$add[] = $k;
}
}
$this->_toUpdate($mailbox, 'add', $add);
$this->_toUpdate($mailbox, 'slice', array_keys($updated));
}
/**
*/
public function getMetaData($mailbox, $uidvalid, $entries)
{
$this->_loadSliceMap($mailbox, $uidvalid);
return empty($entries)
? $this->_slicemap[$mailbox]['d']
: array_intersect_key($this->_slicemap[$mailbox]['d'], array_flip($entries));
}
/**
*/
public function setMetaData($mailbox, $data)
{
$this->_loadSliceMap($mailbox, isset($data['uidvalid']) ? $data['uidvalid'] : null);
$this->_slicemap[$mailbox]['d'] = array_merge($this->_slicemap[$mailbox]['d'], $data);
$this->_toUpdate($mailbox, 'slicemap', true);
}
/**
*/
public function deleteMsgs($mailbox, $uids)
{
if (empty($uids)) {
return;
}
$this->_loadSliceMap($mailbox);
$slicemap = &$this->_slicemap[$mailbox];
$deleted = array_intersect_key($slicemap['s'], array_flip($uids));
if (isset($this->_update[$mailbox])) {
$this->_update[$mailbox]['add'] = array_diff(
$this->_update[$mailbox]['add'],
$uids
);
}
if (empty($deleted)) {
return;
}
$this->_loadUids($mailbox, array_keys($deleted));
$d = &$this->_data[$mailbox];
foreach (array_keys($deleted) as $id) {
unset($d[$id], $slicemap['s'][$id]);
}
foreach (array_unique($deleted) as $slice) {
/* Get rid of slice if less than 10% of capacity. */
if (($slice != $slicemap['i']) &&
($slice_uids = array_keys($slicemap['s'], $slice)) &&
($this->_params['slicesize'] * 0.1) > count($slice_uids)) {
$this->_toUpdate($mailbox, 'add', $slice_uids);
$this->_cache->expire($this->_getCid($mailbox, $slice));
foreach ($slice_uids as $val) {
unset($slicemap['s'][$val]);
}
} else {
$this->_toUpdate($mailbox, 'slice', array($slice));
}
}
}
/**
*/
public function deleteMailbox($mailbox)
{
$this->_loadSliceMap($mailbox);
$this->_deleteMailbox($mailbox);
}
/**
*/
public function clear($lifetime)
{
$this->_cache->clear();
$this->_data = $this->_loaded = $this->_slicemap = $this->_update = array();
}
/**
* Create the unique ID used to store the data in the cache.
*
* @param string $mailbox The mailbox to cache.
* @param string $slice The cache slice.
*
* @return string The cache ID.
*/
protected function _getCid($mailbox, $slice)
{
return implode('|', array(
'horde_imap_client',
$this->_params['username'],
$mailbox,
$this->_params['hostspec'],
$this->_params['port'],
$slice,
self::VERSION
));
}
/**
* Delete a mailbox from the cache.
*
* @param string $mbox The mailbox to delete.
*/
protected function _deleteMailbox($mbox)
{
foreach (array_merge(array_keys(array_flip($this->_slicemap[$mbox]['s'])), array('slicemap')) as $slice) {
$cid = $this->_getCid($mbox, $slice);
$this->_cache->expire($cid);
unset($this->_loaded[$cid]);
}
unset(
$this->_data[$mbox],
$this->_slicemap[$mbox],
$this->_update[$mbox]
);
}
/**
* Load UIDs by regenerating from the cache.
*
* @param string $mailbox The mailbox to load.
* @param array $uids The UIDs to load.
* @param integer $uidvalid The IMAP uidvalidity value of the mailbox.
*/
protected function _loadUids($mailbox, $uids, $uidvalid = null)
{
if (!isset($this->_data[$mailbox])) {
$this->_data[$mailbox] = array();
}
$this->_loadSliceMap($mailbox, $uidvalid);
if (!empty($uids)) {
foreach (array_unique(array_intersect_key($this->_slicemap[$mailbox]['s'], array_flip($uids))) as $slice) {
$this->_loadSlice($mailbox, $slice);
}
}
}
/**
* Load UIDs from a cache slice.
*
* @param string $mailbox The mailbox to load.
* @param integer $slice The slice to load.
*/
protected function _loadSlice($mailbox, $slice)
{
$cache_id = $this->_getCid($mailbox, $slice);
if (!empty($this->_loaded[$cache_id])) {
return;
}
if ((($data = $this->_cache->get($cache_id, 0)) !== false) &&
($data = @unserialize($data)) &&
is_array($data)) {
$this->_data[$mailbox] += $data;
$this->_loaded[$cache_id] = true;
} else {
$ptr = &$this->_slicemap[$mailbox];
// Slice data is corrupt; remove from slicemap.
foreach (array_keys($ptr['s'], $slice) as $val) {
unset($ptr['s'][$val]);
}
if ($slice == $ptr['i']) {
$ptr['c'] = 0;
}
}
}
/**
* Load the slicemap for a given mailbox. The slicemap contains
* the uidvalidity information, the UIDs->slice lookup table, and any
* metadata that needs to be saved for the mailbox.
*
* @param string $mailbox The mailbox.
* @param integer $uidvalid The IMAP uidvalidity value of the mailbox.
*/
protected function _loadSliceMap($mailbox, $uidvalid = null)
{
if (!isset($this->_slicemap[$mailbox]) &&
(($data = $this->_cache->get($this->_getCid($mailbox, 'slicemap'), 0)) !== false) &&
($slice = @unserialize($data)) &&
is_array($slice)) {
$this->_slicemap[$mailbox] = $slice;
}
if (isset($this->_slicemap[$mailbox])) {
$ptr = &$this->_slicemap[$mailbox];
if (is_null($ptr['d']['uidvalid'])) {
$ptr['d']['uidvalid'] = $uidvalid;
return;
} elseif (!is_null($uidvalid) &&
($ptr['d']['uidvalid'] != $uidvalid)) {
$this->_deleteMailbox($mailbox);
} else {
return;
}
}
$this->_slicemap[$mailbox] = array(
// Tracking count for purposes of determining slices
'c' => 0,
// Metadata storage
// By default includes UIDVALIDITY of mailbox.
'd' => array('uidvalid' => $uidvalid),
// The ID of the last slice.
'i' => 0,
// The slice list.
's' => array()
);
}
/**
* Add update entry for a mailbox.
*
* @param string $mailbox The mailbox.
* @param string $type 'add', 'slice', or 'slicemap'.
* @param mixed $data The data to update.
*/
protected function _toUpdate($mailbox, $type, $data)
{
if (!isset($this->_update[$mailbox])) {
$this->_update[$mailbox] = array(
'add' => array(),
'slice' => array()
);
}
$this->_update[$mailbox][$type] = ($type == 'slicemap')
? $data
: array_merge($this->_update[$mailbox][$type], $data);
}
/* Serializable methods. */
/**
*/
public function serialize()
{
$this->save();
return parent::serialize();
}
}
|