/usr/share/php/Horde/Kolab/Storage/Data/Base.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 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 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 | <?php
/**
* 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>
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @link http://pear.horde.org/index.php?package=Kolab_Storage
*/
/**
* The basic handler for data objects in a Kolab storage folder.
*
* @todo Clean up _attachments mess.
*
* @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_Base
implements Horde_Kolab_Storage_Data, Horde_Kolab_Storage_Data_Query
{
/**
* The link to the parent folder object.
*
* @var Horde_Kolab_Storage_Folder
*/
protected $_folder;
/**
* The driver for accessing the Kolab storage system.
*
* @var Horde_Kolab_Storage_Driver
*/
protected $_driver;
/**
* The factory for generating additional resources.
*
* @var Horde_Kolab_Storage_Factory
*/
protected $_factory;
/**
* The folder type.
*
* @var string
*/
protected $_type;
/**
* The version of the data.
*
* @var int
*/
protected $_version;
/**
* The list of registered queries.
*
* @var array
*/
protected $_queries = array();
/**
* Logger instance, or stub.
*
* @var Horde_Log_Logger | Horde_Support_Stub
*/
protected $_logger;
/**
* 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 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,
$type = null,
$version = 1)
{
$this->_folder = $folder;
$this->_driver = $driver;
$this->_factory = $factory;
$this->_type = $type;
$this->_version = $version;
}
public function setLogger(Horde_Log_Logger $logger)
{
$this->_logger = $logger;
}
/**
* Return the folder path for this data handler.
*
* @return string The folder path.
*/
public function getPath()
{
return $this->_folder->getPath();
}
/**
* Return the ID of the current user.
*
* @return string The current user.
*/
public function getAuth()
{
return $this->_driver->getAuth();
}
/**
* Return the ID of this data handler.
*
* @return string The ID.
*/
public function getId()
{
$id = $this->_driver->getParameters();
unset($id['user']);
$id['owner'] = $this->_folder->getOwner();
$id['prefix'] = $this->_folder->getPrefix();
$id['folder'] = $this->_folder->getSubpath();
$id['type'] = $this->getType();
ksort($id);
return md5(serialize($id));
}
/**
* Return the ID parameters for this data handler.
*
* @return array The ID parameters.
*/
public function getIdParameters()
{
$id = $this->_driver->getParameters();
unset($id['user']);
$id['owner'] = $this->_folder->getOwner();
$id['prefix'] = $this->_folder->getPrefix();
$id['folder'] = $this->_folder->getSubpath();
$id['type'] = $this->getType();
return $id;
}
/**
* Return the data type represented by this object.
*
* @return string The type of data this instance handles.
*/
public function getType()
{
if ($this->_type === null) {
$this->_type = $this->_folder->getType();
}
return $this->_type;
}
/**
* Return the data version.
*
* @return string The data version.
*/
public function getVersion()
{
return $this->_version;
}
/**
* Report the status of this folder.
*
* @param Horde_Kolab_Storage_Folder_Stamp $previous The previous stamp,
* if available.
*
* @return Horde_Kolab_Storage_Folder_Stamp The stamp that can be used for
* detecting folder changes.
*/
public function getStamp(Horde_Kolab_Storage_Folder_Stamp $previous = null)
{
if (empty($previous) || $previous->getToken() === false) {
$this->_logger->debug('[KOLAB_STORAGE] Fetching stamp without token.');
return $this->_driver->getStamp($this->_folder->getPath());
}
try {
$this->_logger->debug('[KOLAB_STORAGE] Fetching stamp WITH token.');
return $this->_driver->getStampFromToken(
$this->_folder->getPath(),
$previous->getToken(),
$previous->ids()
);
} catch (Horde_Kolab_Storage_Exception $e) {
// Possibly not supported with the current IMAP driver.
$this->_logger->debug('[KOLAB_STORAGE] Attempted to fetch stamp with token, but backend did not support.');
return $this->_driver->getStamp($this->_folder->getPath());
}
}
/**
* 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)
{
if ($raw === false) {
$writer = new Horde_Kolab_Storage_Object_Writer_Format(
new Horde_Kolab_Format_Factory(),
array('version' => $this->_version)
);
} else {
$writer = new Horde_Kolab_Storage_Object_Writer_Raw();
}
$storage_object = new Horde_Kolab_Storage_Object();
$storage_object->setDriver($this->_driver);
$storage_object->setData($object);
if (empty($object['uid'])) {
$object['uid'] = $storage_object->getUid();
}
$result = $storage_object->create($this->_folder, $writer, $this->getType());
if ($result === true) {
$params = array();
} else {
$params = array(
'changes' => array(
Horde_Kolab_Storage_Folder_Stamp::ADDED => array(
$result => $storage_object
),
Horde_Kolab_Storage_Folder_Stamp::DELETED => array()
)
);
}
$this->synchronize($params);
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 string The new backend ID of the modified 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 modify($object, $raw = false)
{
if (!isset($object['uid'])) {
throw new Horde_Kolab_Storage_Exception(
'The provided object data contains no ID value!'
);
}
try {
$obid = $this->getBackendId($object['uid']);
} catch (Horde_Kolab_Storage_Exception $e) {
throw new Horde_Kolab_Storage_Exception(
sprintf(
Horde_Kolab_Storage_Translation::t(
'The message with ID %s does not exist. This probably means that the Kolab object has been modified by somebody else since you retrieved the object from the backend. Original error: %s'
),
$object['uid'],
$e->getMessage()
)
);
}
if ($raw === false) {
$writer = new Horde_Kolab_Storage_Object_Writer_Format(
new Horde_Kolab_Format_Factory(),
array('version' => $this->_version)
);
} else {
$writer = new Horde_Kolab_Storage_Object_Writer_Raw();
}
// Mark removed attachments as to-be-deleted.
$oldObject = $this->getObject($object['uid']);
$oldAttachments = isset($oldObject['inline-attachments'])
? $oldObject['inline-attachments']
: array();
if ($oldObject['picture']) {
$oldAttachments[] = $oldObject['picture'];
}
$newAttachments = isset($object['inline-attachments'])
? $object['inline-attachments']
: array();
if (isset($object['picture'])) {
$newAttachments[] = $object['picture'];
}
$attachments = isset($object['_attachments'])
? $object['_attachments']
: array();
foreach (array_diff($oldAttachments, $newAttachments) as $attachment) {
$attachments[$attachment] = null;
}
$object['_attachments'] = $attachments;
if (!$object instanceof Horde_Kolab_Storage_Object) {
$object_array = $object;
$object = $oldObject;
$object->setData($object_array);
}
$object->setDriver($this->_driver);
$result = $object->save($writer);
// Filter out removed attachments so that they won't be synchronized.
$object['_attachments'] = array_filter($object['_attachments']);
if ($result === true) {
$params = array();
} else {
$params = array(
'changes' => array(
Horde_Kolab_Storage_Folder_Stamp::ADDED => array(
$result => $object
),
Horde_Kolab_Storage_Folder_Stamp::DELETED => array(
$obid => $object['uid'])
)
);
}
$this->synchronize($params);
return $result;
}
/**
* 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)
{
return $this->_driver->fetchComplete($this->_folder->getPath(), $uid);
}
/**
* Retrieves the body part for the given UID and mime part ID.
*
* @param string $uid The message UID.
* @param string $id The mime part ID.
*
* @return resource The message part as stream resource.
*/
public function fetchPart($uid, $id)
{
return $this->_driver->fetchBodypart(
$this->_folder->getPath(), $uid, $id
);
}
/**
* Retrieves the objects for the given UIDs.
*
* @param array $uids The message UIDs.
* @param boolean $raw True if the raw format should be returned rather than
* the parsed data.
*
* @return array An array of objects.
* @throws new Horde_Kolab_Storage_Exception
*/
public function fetch($uids, $raw = false)
{
if (empty($uids)) {
return array();
}
if ($raw === false) {
$writer = new Horde_Kolab_Storage_Object_Writer_Format(
new Horde_Kolab_Format_Factory(),
array('version' => $this->_version)
);
} else {
$writer = new Horde_Kolab_Storage_Object_Writer_Raw();
}
$objects = array();
$structures = $this->_driver->fetchStructure($this->_folder->getPath(), $uids);
foreach ($structures as $uid => $structure) {
if (!isset($structure['structure'])) {
throw new Horde_Kolab_Storage_Exception(
'Backend returned a structure without the expected "structure" element.'
);
}
$object = new Horde_Kolab_Storage_Object();
$object->setDriver($this->_driver);
$object->load($uid, $this->_folder, $writer, $structure['structure']);
$objects[$uid] = $object;
}
return $objects;
}
/**
* Return the backend ID for the given object ID.
*
* @param string $object_uid The object ID.
*
* @return string The backend ID for the object.
* @throws new Horde_Kolab_Storage_Exception
*/
public function getBackendId($object_id)
{
$by_obid = $this->fetch($this->getStamp()->ids());
foreach ($by_obid as $obid => $object) {
if ($object['uid'] == $object_id) {
return $obid;
}
}
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)
{
return array_key_exists(
$object_id, $this->getObjects()
);
}
/**
* Return the specified object.
*
* @param string $object_id The object id.
*
* @return array The object data as an array.
* @throws new Horde_Kolab_Storage_Exception
*/
public function getObject($object_id)
{
$objects = $this->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)
{
foreach ($this->fetch($this->getStamp()->ids()) as $object) {
if ($object->getBackendId() == $object_id &&
isset($object['_attachments'][$attachment_id])) {
return $object['_attachments'][$attachment_id]['content'];
}
}
}
/**
* Retrieve all object ids in the current folder.
*
* @return array The object ids.
*/
public function getObjectIds()
{
return array_keys($this->getObjects());
}
/**
* Retrieve all objects in the current folder.
*
* @return array An array of all objects.
*/
public function getObjects()
{
$by_oid = array();
$by_obid = $this->fetch($this->getStamp()->ids());
foreach ($by_obid as $obid => $object) {
$by_oid[$object['uid']] = $object;
}
return $by_oid;
}
/**
* Retrieve all objects in the current folder by backend id.
*
* @return array An array of all objects.
*/
public function getObjectsByBackendId()
{
return $this->fetch($this->getStamp()->ids());
}
/**
* 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)
{
$fetched = $this->fetch(array($uid));
return array_pop($fetched);
}
/**
* Return the mapping of object IDs to backend IDs.
*
* @return array The object to backend mapping.
*/
public function getObjectToBackend()
{
$bid = array();
$by_obid = $this->fetch($this->getStamp()->ids());
foreach ($by_obid as $obid => $object) {
$bid[$object['uid']] = $obid;
}
return $bid;
}
/**
* Retrieve the list of object duplicates.
*
* @return array The list of duplicates.
*/
public function getDuplicates()
{
$existing = array();
$duplicates = array();
$by_obid = $this->fetch($this->getStamp()->ids());
foreach ($by_obid as $obid => $object) {
if (isset($existing[$object['uid']])) {
if (!isset($duplicates[$object['uid']])) {
$duplicates[$object['uid']][] = $existing[$object['uid']];
}
$duplicates[$object['uid']][] = $obid;
} else {
$existing[$object['uid']] = $obid;
}
}
return $duplicates;
}
/**
* Retrieve the list of object errors.
*
* @return array The list of errors.
*/
public function getErrors()
{
$errors = array();
$by_obid = $this->fetch($this->getStamp()->ids());
foreach ($by_obid as $obid => $object) {
if ($object->hasParseErrors()) {
$errors[$obid] = $object;
}
}
return $errors;
}
/**
* 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.
*/
public function move($object_id, $new_folder)
{
if ($this->objectIdExists($object_id)) {
$uid = $this->getBackendId($object_id);
} else {
throw new Horde_Kolab_Storage_Exception(
sprintf('No such object %s!', $object_id)
);
}
$this->_driver->moveMessage(
$uid, $this->_folder->getPath(), $new_folder
);
$this->synchronize(
array(
'changes' => array(
Horde_Kolab_Storage_Folder_Stamp::ADDED => array(),
Horde_Kolab_Storage_Folder_Stamp::DELETED => array($uid => $object_id)
)
)
);
}
/**
* Delete the specified objects from this data set.
*
* @param array|string $object_ids Id(s) of the object to be deleted.
*/
public function delete($object_ids)
{
// Short circuit empty collections.
if (empty($object_ids)) {
return;
}
if (!is_array($object_ids)) {
$object_ids = array($object_ids);
}
$uids = array();
foreach ($object_ids as $id) {
if ($this->objectIdExists($id)) {
$uids[$this->getBackendId($id)] = $id;
} else {
throw new Horde_Kolab_Storage_Exception(
sprintf('No such object %s!', $id)
);
}
}
$this->deleteBackendIds(array_keys($uids));
$this->synchronize(
array(
'changes' => array(
Horde_Kolab_Storage_Folder_Stamp::ADDED => array(),
Horde_Kolab_Storage_Folder_Stamp::DELETED => $uids
)
)
);
}
/**
* Delete all objects from this data set.
*/
public function deleteAll()
{
$this->delete($this->getObjectIds());
}
/**
* Delete the specified messages from this folder.
*
* @param array|string $uids Backend id(s) of the message to be deleted.
*/
public function deleteBackendIds($uids)
{
if (!is_array($uids)) {
$uids = array($uids);
}
$this->_driver->deleteMessages($this->_folder->getPath(), $uids);
$this->_driver->expunge($this->_folder->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.
*
* @throws new Horde_Kolab_Storage_Exception
*/
public function registerQuery($name, Horde_Kolab_Storage_Query $query)
{
if (!$query instanceof Horde_Kolab_Storage_Data_Query) {
throw new Horde_Kolab_Storage_Exception(
'The provided query is no data query.'
);
}
$query->setLogger($this->_logger);
$this->_queries[$name] = $query;
}
/**
* Synchronize the data information with the information from the backend.
*
* @param array $params Additional parameters.
*/
public function synchronize($params = array())
{
foreach ($this->_queries as $name => $query) {
$query->synchronize($params);
}
}
/**
* 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)
{
if (isset($this->_queries[$name])) {
return $this->_queries[$name];
} else {
throw new Horde_Kolab_Storage_Exception('No such query!');
}
}
/**
* Generate a unique object ID.
*
* @return string The unique ID.
*/
public function generateUid()
{
return strval(new Horde_Support_Uuid());
}
}
|