/usr/share/php/Horde/Kolab/Storage/Data/Decorator/Log.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 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 | <?php
/**
* A log decorator for the data 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 log decorator for the data handlers.
*
* Copyright 2011-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_Data_Decorator_Log
implements Horde_Kolab_Storage_Data, Horde_Kolab_Storage_Data_Query
{
/**
* Decorated data handler.
*
* @var Horde_Kolab_Storage_Data
*/
private $_data;
/**
* A log handler.
*
* @var mixed
*/
private $_logger;
/**
* Constructor.
*
* @param Horde_Kolab_Storage_Data $data The original data handler.
* @param mixed $logger The log handler. This instance
* must provide the debug() and
* debug() methods.
*/
public function __construct(Horde_Kolab_Storage_Data $data,
$logger)
{
$this->_data = $data;
$this->_logger = $logger;
}
/**
* Return the folder path for this data handler.
*
* @return string The folder path.
*/
public function getPath()
{
return $this->_data->getPath();
}
/**
* Return the ID of the current user.
*
* @return string The current user.
*/
public function getAuth()
{
return $this->_data->getAuth();
}
/**
* Return the ID of this data handler.
*
* @return string The ID.
*/
public function getId()
{
return $this->_data->getId();
}
/**
* Return the ID parameters for this data handler.
*
* @return array The ID parameters.
*/
public function getIdParameters()
{
return $this->_data->getIdParameters();
}
/**
* Return the data type represented by this object.
*
* @return string The type of data this instance handles.
*/
public function getType()
{
return $this->_data->getType();
}
/**
* Return the data version.
*
* @return string The data version.
*/
public function getVersion()
{
return $this->_data->getVersion();
}
/**
* Report the status of this folder.
*
* @return Horde_Kolab_Storage_Folder_Stamp The stamp that can be used for
* detecting folder changes.
*/
public function getStamp()
{
return $this->_data->getStamp();
}
/**
* Create a new object.
*
* @param array &$object The array that holds the object data.
* @param boolean $raw True if the data to be stored has been provided in
* raw format.
*
* @return string The ID of the new object or true in case the backend does
* not support this return value.
*
* @throws Horde_Kolab_Storage_Exception In case an error occured while
* saving the data.
*/
public function create(&$object, $raw = false)
{
$this->_logger->debug(
sprintf('Creating new data object in %s.', $this->_data->getPath())
);
$result = $this->_data->create($object, $raw);
$this->_logger->debug(
sprintf(
'Created data object %s in %s [backend: %s].',
$object['uid'],
$this->_data->getPath(),
$result
)
);
return $result;
}
/**
* Modify an existing object.
*
* @param array $object The array that holds the updated object data.
* @param boolean $raw True if the data to be stored has been provided in
* raw format.
*
* @return NULL
*
* @throws Horde_Kolab_Storage_Exception In case an error occured while
* saving the data.
*/
public function modify($object, $raw = false)
{
$this->_logger->debug(
sprintf(
'Modifying data object %s in %s.',
$object['uid'],
$this->_data->getPath()
)
);
$this->_data->modify($object, $raw);
$this->_logger->debug(
sprintf(
'Modified data object %s in %s.',
$object['uid'],
$this->_data->getPath()
)
);
}
/**
* Retrieves the objects for the given UIDs.
*
* @param array $uids The message UIDs.
*
* @return array An array of objects.
*/
public function fetch($uids)
{
$this->_logger->debug(
sprintf(
'Fetching data objects %s in %s.',
join(',', $uids),
$this->_data->getPath()
)
);
return $this->_data->fetch($uids);
}
/**
* Retrieves the complete message for the given UID.
*
* @param string $uid The message UID.
*
* @return array The message encapsuled as an array that contains a
* Horde_Mime_Headers and a Horde_Mime_Part object.
*/
public function fetchComplete($uid)
{
$this->_logger->debug(
sprintf(
'Fetching complete message id %s in %s.',
$uid,
$this->_data->getPath()
)
);
return $this->_data->fetchComplete($uid);
}
/**
* 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)
{
$result = $this->_data->getBackendId($object_id);
$this->_logger->debug(
sprintf(
'Backend id for object %s is %s in %s.',
$object_id,
$result,
$this->_data->getPath()
)
);
return $result;
}
/**
* 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)
{
return $this->_data->objectIdExists($object_id);
}
/**
* Return the specified object.
*
* @param string $object_id The object id.
*
* @return array The object data as an array.
*/
public function getObject($object_id)
{
return $this->_data->getObject($object_id);
}
/**
* Return the specified attachment.
*
* @param string $attachment_id The attachment id.
*
* @return resource An open stream to the attachment data.
*/
public function getAttachment($attachment_id)
{
return $this->_data->getAttachment($attachment_id);
}
/**
* Retrieve all object ids in the current folder.
*
* @return array The object ids.
*/
public function getObjectIds()
{
$result = $this->_data->getObjectIds();
if (count($result < 20)) {
$ids = '[' . join(', ', $result) . ']';
} else {
$ids = '[too many to list]';
}
$this->_logger->debug(
sprintf(
'%s has %s objects %s.',
$this->_data->getPath(),
count($result),
$ids
)
);
return $result;
}
/**
* Retrieve all objects in the current folder.
*
* @return array An array of all objects.
*/
public function getObjects()
{
$result = $this->_data->getObjects();
if (count($result < 20)) {
$ids = '[' . join(', ', array_keys($result)) . ']';
} else {
$ids = '[too many to list]';
}
$this->_logger->debug(
sprintf(
'%s has %s objects %s.',
$this->_data->getPath(),
count($result),
$ids
)
);
return $result;
}
/**
* Retrieve all objects in the current folder by backend id.
*
* @return array An array of all objects.
*/
public function getObjectsByBackendId()
{
$result = $this->_data->getObjectsByBackendId();
if (count($result < 20)) {
$ids = '[backend ids: ' . join(', ', array_keys($result)) . ']';
} else {
$ids = '[too many to list]';
}
$this->_logger->debug(
sprintf(
'%s has %s objects %s.',
$this->_data->getPath(),
count($result),
$ids
)
);
return $result;
}
/**
* Retrieve an object in the current folder by backend id.
*
* @param string $uid Backend id of the object to be returned.
*
* @return array An array of all objects.
*/
public function getObjectByBackendId($uid)
{
return $this->_data->getObjectByBackendId($uid);
}
/**
* Return the mapping of object IDs to backend IDs.
*
* @return array The object to backend mapping.
*/
public function getObjectToBackend()
{
return $this->_data->getObjectToBackend();
}
/**
* Retrieve the list of object duplicates.
*
* @return array The list of duplicates.
*/
public function getDuplicates()
{
return $this->_data->getDuplicates();
}
/**
* Retrieve the list of object errors.
*
* @return array The list of errors.
*/
public function getErrors()
{
return $this->_data->getErrors();
}
/**
* Move the specified message from the current folder into a new
* folder.
*
* @param string $object_id ID of the message to be moved.
* @param string $new_folder Target folder.
*
* @return NULL
*/
public function move($object_id, $new_folder)
{
$this->_logger->debug(
sprintf(
'Moving data object %s in %s to %s.',
$object_id,
$this->_data->getPath(),
$new_folder
)
);
$this->_data->move($object_id, $new_folder);
$this->_logger->debug(
sprintf(
'Moved data object %s in %s to %s.',
$object_id,
$this->_data->getPath(),
$new_folder
)
);
}
/**
* Delete the specified objects from this data set.
*
* @param array|string $object_ids Id(s) of the object to be deleted.
*
* @return NULL
*/
public function delete($object_ids)
{
if (is_array($object_ids)) {
$ids = join(', ', $object_ids);
} else {
$ids = $object_ids;
}
$this->_logger->debug(
sprintf(
'Deleting data object(s) %s in %s.',
$ids,
$this->_data->getPath()
)
);
$this->_data->delete($object_ids);
$this->_logger->debug(
sprintf(
'Deleted data object(s) %s in %s.',
$ids,
$this->_data->getPath()
)
);
}
/**
* Delete all objects from this data set.
*
* @return NULL
*/
public function deleteAll()
{
$this->_logger->debug(
sprintf(
'Deleting all data objects in %s.',
$this->_data->getPath()
)
);
$this->_data->deleteAll();
$this->_logger->debug(
sprintf(
'Deleted all data objects in %s.',
$this->_data->getPath()
)
);
}
/**
* Delete the specified messages from this folder.
*
* @param array|string $uids Backend id(s) of the message to be deleted.
*
* @return NULL
*/
public function deleteBackendIds($uids)
{
if (is_array($uids)) {
$ids = join(', ', $uids);
} else {
$ids = $uids;
}
$this->_logger->debug(
sprintf(
'Deleting backend data object(s) %s in %s.',
$ids,
$this->_data->getPath()
)
);
$this->_data->deleteBackendIds($uids);
$this->_logger->debug(
sprintf(
'Deleted backend data object(s) %s in %s.',
$ids,
$this->_data->getPath()
)
);
}
/**
* Synchronize the list information with the information from the backend.
*
* @param array $params Additional parameters.
*
* @return NULL
*/
public function synchronize($params = array())
{
$this->_data->synchronize();
$this->_logger->debug(
sprintf(
'Synchronized data cache for %s.',
$this->_data->getPath()
)
);
}
/**
* Register a query to be updated if the underlying data changes.
*
* @param string $name The query name.
* @param Horde_Kolab_Storage_Query $query The query to register.
*
* @return NULL
*/
public function registerQuery($name, Horde_Kolab_Storage_Query $query)
{
$this->_data->registerQuery($name, $query);
}
/**
* Return a registered query.
*
* @param string $name The query name.
*
* @return Horde_Kolab_Storage_Query The requested query.
*
* @throws Horde_Kolab_Storage_Exception In case the requested query does
* not exist.
*/
public function getQuery($name = null)
{
return $this->_data->getQuery($name);
}
}
|