/usr/share/php/Horde/Kolab/Storage/Data/Cached.php is in php-horde-kolab-storage 2.2.3-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 | <?php
/**
* The cache decorator for Kolab storage data handlers.
*
* PHP version 5
*
* @category Kolab
* @package Kolab_Storage
* @author Gunnar Wrobel <wrobel@pardus.de>
* @author Thomas Jarosch <thomas.jarosch@intra2net.com>
* @author Michael J Rubinsky <mrubinsk@horde.org>
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @link http://pear.horde.org/index.php?package=Kolab_Storage
*/
/**
* The cache decorator for Kolab storage data handlers.
*
* Copyright 2011-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>
* @author Thomas Jarosch <thomas.jarosch@intra2net.com>
* @author Michael J Rubinsky <mrubinsk@horde.org>
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @link http://pear.horde.org/index.php?package=Kolab_Storage
*/
class Horde_Kolab_Storage_Data_Cached
extends Horde_Kolab_Storage_Data_Base
{
/**
* The data cache.
*
* @var Horde_Kolab_Storage_Cache_Data
*/
protected $_data_cache;
/**
* Has the cache already been loaded and validated?
*
* @var boolean
*/
protected $_init = false;
/**
* Constructor.
*
* @param Horde_Kolab_Storage_Folder $folder The folder to retrieve the
* data from.
* @param Horde_Kolab_Storage_Driver $driver The primary connection driver.
* @param Horde_Kolab_Storage_Factory $factory The factory.
* @param Horde_Kolab_Storage_Cache $cache The cache storing data for
* this decorator.
* @param string $type The type of data we want to
* access in the folder.
* @param int $version Format version of the object
* data.
*/
public function __construct(Horde_Kolab_Storage_Folder $folder,
Horde_Kolab_Storage_Driver $driver,
Horde_Kolab_Storage_Factory $factory,
Horde_Kolab_Storage_Cache $cache,
$type = null,
$version = 1)
{
parent::__construct($folder, $driver, $factory, $type, $version);
$this->_data_cache = $cache->getDataCache($this->getIdParameters());
}
/**
* Check if the cache has been initialized.
*
* @return NULL
*/
protected function _isInitialized()
{
return ($this->_init || $this->_data_cache->isInitialized());
}
/**
* Check if the cache has been initialized at all and synchronize it if not.
*/
protected function _init()
{
if (!$this->_isInitialized()) {
$this->synchronize();
}
}
/**
* Return the backend ID for the given object ID.
*
* @param string $object_uid The object ID.
*
* @return string The backend ID for the object.
*/
public function getBackendId($object_id)
{
$this->_init();
$mapping = $this->_data_cache->getObjectToBackend();
if (isset($mapping[$object_id])) {
return $mapping[$object_id];
} else {
throw new Horde_Kolab_Storage_Exception(
sprintf('Object ID %s does not exist!', $object_id)
);
}
}
/**
* Check if the given object ID exists.
*
* @param string $object_id The object ID.
*
* @return boolean True if the ID was found, false otherwise.
*/
public function objectIdExists($object_id)
{
$this->_init();
return array_key_exists(
$object_id, $this->_data_cache->getObjects()
);
}
/**
* Return the specified object.
*
* @param string $object_id The object id.
*
* @return array The object data as an array.
*/
public function getObject($object_id)
{
$this->_init();
$objects = $this->_data_cache->getObjects();
if (isset($objects[$object_id])) {
return $objects[$object_id];
} else {
throw new Horde_Kolab_Storage_Exception(
sprintf('Object ID %s does not exist!', $object_id)
);
}
}
/**
* Returns the specified attachment.
*
* @param string $object_id The object id. @since Kolab_Storage 2.1.0
* @param string $attachment_id The attachment id.
*
* @return resource An open stream to the attachment data.
*/
public function getAttachment($object_id, $attachment_id)
{
$this->_init();
return $this->_data_cache->getAttachment($object_id, $attachment_id)
?: parent::getAttachment($object_id, $attachment_id);
}
/**
* Retrieve all object ids in the current folder.
*
* @return array The object ids.
*/
public function getObjectIds()
{
$this->_init();
return array_keys($this->_data_cache->getObjects());
}
/**
* Retrieve all objects in the current folder.
*
* @return array An array of all objects.
*/
public function getObjects()
{
$this->_init();
return $this->_data_cache->getObjects();
}
/**
* Return the mapping of object IDs to backend IDs.
*
* @return array The object to backend mapping.
*/
public function getObjectToBackend()
{
$this->_init();
return $this->_data_cache->getObjectToBackend();
}
/**
* Retrieve the list of object duplicates.
*
* @return array The list of duplicates.
*/
public function getDuplicates()
{
$this->_init();
return $this->_data_cache->getDuplicates();
}
/**
* Retrieve the list of object errors.
*
* @return array The list of errors.
*/
public function getErrors()
{
$this->_init();
return $this->_data_cache->getErrors();
}
/**
* Synchronize the query data with the information from the backend.
*
* @see Horde_Kolab_Storage_Query
*
* In addition to the parameters of the base class(es), the following may
* be passed as well:
* - logger: (Horde_Log_Logger) A logger instance.
*
* @return NULL
*/
public function synchronize($params = array())
{
$this->_logger = !empty($this->_logger)
? $this->_logger
: (!empty($params['logger'])
? $params['logger']
: new Horde_Support_Stub());
// For logging
$user = $this->getAuth();
$folder_path = $this->getPath();
if (!$this->_data_cache->isInitialized()) {
$this->_logger->debug(sprintf(
'[KOLAB_STORAGE]: Initial folder sync: user: %s, folder: %s',
$user,
$folder_path)
);
$this->_completeSynchronization($this->getStamp());
return;
}
$previous = unserialize($this->_data_cache->getStamp());
$current = $this->getStamp($previous);
// check if UIDVALIDITY changed
$is_reset = false;
if ($previous !== false) {
$is_reset = $previous->isReset($current);
}
if ($previous === false || $is_reset) {
$this->_logger->debug(sprintf(
'[KOLAB_STORAGE] Complete folder sync: user: %s, folder: %s, is_reset: %d',
$user, $folder_path, $is_reset)
);
$this->_completeSynchronization($current, array('is_reset' => $is_reset));
return;
}
if (!isset($params['changes'])) {
$changes = $previous->getChanges($current);
$params['changes'][Horde_Kolab_Storage_Folder_Stamp::ADDED] = $this->fetch(
$changes[Horde_Kolab_Storage_Folder_Stamp::ADDED]
);
$params['changes'][Horde_Kolab_Storage_Folder_Stamp::DELETED] = $this->_data_cache->backendMap(
$changes[Horde_Kolab_Storage_Folder_Stamp::DELETED]
);
}
if ($params['changes'] !== false) {
$params['last_sync'] = $this->_data_cache->getLastSync();
$this->_data_cache->store(
$params['changes'][Horde_Kolab_Storage_Folder_Stamp::ADDED],
$current,
$this->getVersion(),
$params['changes'][Horde_Kolab_Storage_Folder_Stamp::DELETED]
);
$params['current_sync'] = $this->_data_cache->getLastSync();
if (!empty($params['changes'][Horde_Kolab_Storage_Folder_Stamp::ADDED]) ||
!empty($params['changes'][Horde_Kolab_Storage_Folder_Stamp::DELETED])) {
$changes_to_log = array('add' => array(), 'del' => array());
foreach ($params['changes'][Horde_Kolab_Storage_Folder_Stamp::ADDED] as $uid => $object) {
$changes_to_log['add'][$uid] = $object['uid'];
}
foreach ($params['changes'][Horde_Kolab_Storage_Folder_Stamp::DELETED] as $uid => $object_uid) {
$changes_to_log['del'][$uid] = $object_uid;
}
$this->_logger->debug(sprintf(
'[KOLAB_STORAGE] Incremental folder sync: user: %s, folder: %s, last_sync: %d, current_sync: %d, changes: %s',
$user,
$folder_path,
$params['last_sync'],
$params['current_sync'],
print_r($changes_to_log, true))
);
}
parent::synchronize($params);
$this->_data_cache->save();
}
$this->_init = true;
}
/**
* Perform a complete synchronization.
*
* @param Horde_Kolab_Storage_Folder_Stamp $stamp The current stamp.
* @param array $params Additional parameters.
*
* @return NULL
*/
private function _completeSynchronization(Horde_Kolab_Storage_Folder_Stamp $stamp,
$params = array())
{
$this->_data_cache->reset();
$ids = $stamp->ids();
$params['last_sync'] = false;
$params['changes'][Horde_Kolab_Storage_Folder_Stamp::ADDED] = empty($ids) ? array() : $this->fetch($ids);
// logging
$uids_to_log = array_keys($params['changes'][Horde_Kolab_Storage_Folder_Stamp::ADDED]);
$this->_logger->debug(sprintf(
'[KOLAB_STORAGE] Full folder sync details: user: %s, folder: %s, uids: %s',
$this->getAuth(),
$this->getPath(),
implode(', ', $uids_to_log))
);
$this->_data_cache->store(
$params['changes'][Horde_Kolab_Storage_Folder_Stamp::ADDED],
$stamp,
$this->getVersion()
);
$params['current_sync'] = $this->_data_cache->getLastSync();
parent::synchronize($params);
$this->_data_cache->save();
}
}
|