/usr/share/php/Horde/Kolab/Storage/Object.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 | <?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
*/
/**
* Represents a single Kolab object.
*
* @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_Object implements ArrayAccess, Serializable
{
/** Indicates an invalid object. */
const TYPE_INVALID = 'INVALID';
/** Indicates a missing Kolab data MIME part. */
const ERROR_MISSING_KOLAB_PART = 1;
/** Indicates an unreadable Kolab part. */
const ERROR_INVALID_KOLAB_PART = 2;
/** Serialization elements */
const SERIALIZATION_DATA = 'D';
const SERIALIZATION_ERRORS = 'E';
const SERIALIZATION_TYPE = 'T';
const SERIALIZATION_STRUCTURE = 'S';
const SERIALIZATION_FOLDER = 'F';
const SERIALIZATION_BACKENDID = 'B';
const SERIALIZATION_MIMEPARTID = 'P';
/**
* The driver for accessing the backend.
*
* @var Horde_Kolab_Storage_Driver
*/
protected $_driver;
/**
* The folder that holds the object within the backend.
*
* @var string
*/
protected $_folder;
/**
* The object ID within the backend.
*
* @var string
*/
protected $_backend_id;
/**
* The ID of the MIME part carrying the object data.
*
* @var string
*/
protected $_mime_part_id;
/**
* The object type.
*
* @var string
*/
protected $_type;
/**
* The MIME headers of the object envelope.
*
* @var Horde_Mime_Headers
*/
protected $_headers;
/**
* The message structure.
*
* @var Horde_Mime_Part
*/
protected $_structure;
/**
* The content string representing the object data.
*
* @var resource
*/
protected $_content;
/**
* The object data.
*
* @var array
*/
protected $_data = array();
/**
* The collection of parse errors (if any).
*
* @var array
*/
protected $_errors = array();
/**
* Return the driver for accessing the backend.
*
* @return Horde_Kolab_Storage_Driver The driver.
*/
protected function _getDriver()
{
if ($this->_driver === null) {
throw new Horde_Kolab_Storage_Object_Exception(
'The driver has not been set!'
);
}
return $this->_driver;
}
/**
* Set the driver for accessing the backend.
*
* @param Horde_Kolab_Storage_Driver $driver The driver.
*/
public function setDriver(Horde_Kolab_Storage_Driver $driver)
{
$this->_driver = $driver;
}
protected function _getFolder()
{
if (empty($this->_folder)) {
throw new Horde_Kolab_Storage_Object_Exception(
'The folder containing the object has been left unspecified!'
);
}
return $this->_folder;
}
/**
* @since Horde_Kolab_Storage 2.1.0
*/
public function getBackendId()
{
if (empty($this->_backend_id)) {
throw new Horde_Kolab_Storage_Object_Exception(
'The message containing the object has been left unspecified!'
);
}
return $this->_backend_id;
}
protected function _getMimePartId()
{
if (empty($this->_mime_part_id)) {
throw new Horde_Kolab_Storage_Object_Exception(
'There is no indication which message part might contain the object data!'
);
}
return $this->_mime_part_id;
}
/**
* Return the object type.
*
* @return string The object type.
*/
public function getType()
{
return $this->_type;
}
/**
* Return the MIME headers of the object envelope.
*
* @return Horde_Mime_Headers The MIME headers.
*/
public function getHeaders()
{
if ($this->_headers === null) {
$this->_headers = $this->_getDriver()->fetchHeaders(
$this->_getFolder(),
$this->getBackendId()
);
}
return $this->_headers;
}
/**
* Set the content representing the object data.
*
* @param resource $content The object content.
*/
public function setContent($content)
{
$this->_content = $content;
}
/**
* Fetch the raw content representing the object data.
*
* @return resource The raw object content.
*/
public function getContent()
{
if ($this->_content === null) {
$this->_content = $this->_getDriver()->fetchBodypart(
$this->_getFolder(),
$this->getBackendId(),
$this->_getMimePartId()
);
}
return $this->_content;
}
/**
* Return the current content value representing the object data. This call
* does not attempt to fetch the content from the backend.
*
* @return resource The raw object content.
*/
public function getCurrentContent()
{
return $this->_content;
}
/**
* Set the object data.
*
* @param array $data The object data.
*/
public function setData(array $data)
{
$this->_data = $data;
if (!isset($this->_data['uid'])) {
$this->getUid();
}
}
/**
* Fetch the object data.
*
* @return array The object data.
*/
public function getData()
{
return $this->_data;
}
/**
* Return the UID of the object. If no UID has been set a valid UID will be
* autogenerated.
*
* @return string The object UID.
*/
public function getUid()
{
if (!isset($this->_data['uid'])) {
$this->_data['uid'] = $this->generateUid();
}
return $this->_data['uid'];
}
/**
* Generate a unique object ID.
*
* @return string The unique ID.
*/
public function generateUid()
{
return strval(new Horde_Support_Uuid());
}
protected function addParseError($error, $message = '')
{
$this->_errors[$error] = $message;
}
public function getParseErrors()
{
return $this->_errors;
}
public function hasParseErrors()
{
return !empty($this->_errors);
}
/**
* Create a new object in the backend.
*
* @param Horde_Kolab_Storage_Folder $folder The folder to retrieve the
* data object from.
* @param Horde_Kolab_Storage_Object_Writer $data The data writer.
* @param string $type The type of object to be stored.
*
* @return boolean|string The return value of the append operation.
*/
public function create(Horde_Kolab_Storage_Folder $folder,
Horde_Kolab_Storage_Object_Writer $data,
$type)
{
$this->_folder = $folder->getPath();
$this->_type = $type;
$envelope = $this->createEnvelope();
$envelope->addPart($this->createFreshKolabPart($data->save($this)));
if (isset($this['_attachments'])) {
foreach ($this['_attachments'] as $name => $attachment) {
$part = new Horde_Mime_Part();
$part->setType($attachment['type']);
$part->setContents($attachment['content']);
$part->setName($name);
$envelope->addPart($part);
}
}
$envelope->buildMimeIds();
$this->_mime_part_id = Horde_Kolab_Storage_Object_MimeType::matchMimePartToObjectType(
$envelope, $this->getType()
);
return $this->_appendMessage($envelope, $this->createEnvelopeHeaders());
}
/**
* Loads the object from the backend.
*
* @param string $backend_id The object ID within the
* backend.
* @param Horde_Kolab_Storage_Folder $folder The folder to retrieve
* the data object from.
* @param Horde_Kolab_Storage_Object_Writer $data The data parser.
* @param Horde_Mime_Part $structure The MIME message
* structure of the object.
*/
public function load($backend_id,
Horde_Kolab_Storage_Folder $folder,
Horde_Kolab_Storage_Object_Writer $data,
Horde_Mime_Part $structure = null)
{
$this->_folder = $folder->getPath();
$this->_backend_id = $backend_id;
$result = Horde_Kolab_Storage_Object_MimeType::matchMimePartToFolderType(
$structure, $folder->getType()
);
/* No object content matching the folder type: Try fetching the header
* and look for a Kolab type deviating from the folder type. */
if ($result === false || $result[0] === false) {
$result = Horde_Kolab_Storage_Object_MimeType::matchMimePartToHeaderType(
$structure,
$this->getHeaders()
);
/* Seems to have no Kolab data part: mark invalid. */
if ($result === false || $result[0] === false) {
$this->_type = self::TYPE_INVALID;
$this->addParseError(self::ERROR_MISSING_KOLAB_PART);
return;
}
}
$this->_type = $result[1];
$mime_part = $structure->getPart($result[0]);
if (empty($mime_part)) {
$this->_type = self::TYPE_INVALID;
$this->addParseError(self::ERROR_MISSING_KOLAB_PART);
return;
}
$this->_mime_part_id = $result[0];
$mime_part->setContents($this->getContent(), array('encoding' => '8bit'));
$result = $data->load($mime_part->getContents(array('stream' => true)), $this);
if ($result instanceof Exception) {
$this->addParseError(self::ERROR_INVALID_KOLAB_PART, $result->getMessage());
} else {
foreach ($structure->getParts() as $part) {
if ($part->getMimeId() == $this->_mime_part_id ||
!$part->getName()) {
continue;
}
$this->_data['_attachments'][$part->getName()] = array(
'type' => $part->getType(),
'content' => $this->_getDriver()->fetchBodypart(
$this->_getFolder(),
$this->getBackendId(),
$part->getMimeId()
)
);
}
}
$this->_structure = $structure;
}
/**
* Store the modified object in the backend.
*
* @param Horde_Kolab_Storage_Folder $folder The folder to retrieve the
* data object from.
* @param Horde_Kolab_Storage_Object_Writer $data The data writer.
* @param Horde_Mime_Part $structure The MIME message structure of the object.
*
* @return boolean|string The return value of the append operation.
* @throws Horde_Kolab_Storage_Object_Exception
*/
public function save(Horde_Kolab_Storage_Object_Writer $data)
{
list($headers, $body) = $this->_getDriver()->fetchComplete(
$this->_getFolder(), $this->getBackendId()
);
$mime_id = Horde_Kolab_Storage_Object_MimeType::matchMimePartToObjectType(
$body, $this->getType()
);
if ($mime_id === false) {
throw new Horde_Kolab_Storage_Object_Exception(
sprintf(
'Missing expected mime type (%s) in object "%s" in folder "%s"!',
Horde_Kolab_Storage_Object_MimeType::getMimeTypeFromObjectType($this->getType()),
$this->getBackendId(),
$this->_getFolder()
)
);
}
$this->_content = $body->getPart($mime_id)->getContents(array('stream' => true));
$body->alterPart($mime_id, $this->createFreshKolabPart($data->save($this)));
$body->buildMimeIds();
// Update attachments.
if (isset($this['_attachments'])) {
foreach ($this['_attachments'] as $name => $attachment) {
foreach ($body->getParts() as $part) {
if ($part->getName() === $name) {
$body->removePart($part->getMimeId());
break;
}
}
if (!is_null($attachment)) {
$part = new Horde_Mime_Part();
$part->setType($attachment['type']);
$part->setContents($attachment['content']);
$part->setName($name);
$body->addPart($part);
}
$body->buildMimeIds();
}
}
$this->_mime_part_id = Horde_Kolab_Storage_Object_MimeType::matchMimePartToObjectType(
$body, $this->getType()
);
$old_uid = $this->getBackendId();
// Save message.
$result = $this->_appendMessage($body, $headers);
$this->_getDriver()->deleteMessages($this->_getFolder(), array($old_uid));
$this->_getDriver()->expunge($this->_getFolder());
return $result;
}
/**
* Append a new message.
*
* @param Horde_Mime_Part $message The message.
* @param Horde_Mime_Headers $headers The message headers.
*
* @return boolean|string The return value of the append operation.
* @throws Horde_Kolab_Storage_Object_Exception
*/
protected function _appendMessage(Horde_Mime_Part $message,
Horde_Mime_Headers $headers)
{
$result = $this->_getDriver()->appendMessage(
$this->_getFolder(),
$message->toString(
array(
'canonical' => true,
'stream' => true,
'headers' => $headers
)
)
);
if (is_object($result) || $result === false || $result === null) {
throw new Horde_Kolab_Storage_Object_Exception(
sprintf(
'Unexpected return value (%s) when creating an object in folder "%s"!',
print_r($result, true), $this->_getFolder()
)
);
}
if ($result !== true) {
$this->_backend_id = $result;
}
return $result;
}
/**
* Generates a new MIME messages that will wrap a Kolab groupware object.
*
* @return Horde_Mime_Part The new MIME message.
*/
protected function createEnvelope()
{
$envelope = new Horde_Mime_Part();
$envelope->setName('Kolab Groupware Data');
$envelope->setType('multipart/mixed');
$description = new Horde_Mime_Part();
$description->setName('Kolab Groupware Information');
$description->setType('text/plain');
$description->setDisposition('inline');
$description->setCharset('utf-8');
$description->setContents(
sprintf(
Horde_Kolab_Storage_Translation::t(
"This is a Kolab Groupware object. To view this object you will need an email client that understands the Kolab Groupware format. For a list of such email clients please visit %s"
),
'http://www.kolab.org/content/kolab-clients'
),
array('encoding' => 'quoted-printable')
);
$envelope->addPart($description);
return $envelope;
}
/**
* Generate the headers for the MIME envelope of a Kolab groupware object.
*
* @param string $user The current user.
*
* @return Horde_Mime_Headers The headers for the MIME envelope.
*/
protected function createEnvelopeHeaders()
{
$headers = new Horde_Mime_Headers();
$headers->setEOL("\r\n");
$headers->addHeader('From', $this->_getDriver()->getAuth());
$headers->addHeader('To', $this->_getDriver()->getAuth());
$headers->addHeader('Date', date('r'));
$headers->addHeader('Subject', $this->getUid());
$headers->addHeader('User-Agent', 'Horde_Kolab_Storage ' . Horde_Kolab_Storage::VERSION);
$headers->addHeader('MIME-Version', '1.0');
$headers->addHeader(
'X-Kolab-Type',
Horde_Kolab_Storage_Object_MimeType::getMimeTypeFromObjectType($this->getType())
);
return $headers;
}
/**
* Embed the Kolab content into a new MIME Part.
*
* @param resource $content The Kolab content.
*
* @return Horde_Mime_Part The MIME part that encapsules the Kolab content.
*/
protected function createFreshKolabPart($content)
{
$part = new Horde_Mime_Part();
$part->setCharset('utf-8');
$part->setDisposition('inline');
$part->setDispositionParameter('x-kolab-type', 'xml');
$part->setName('kolab.xml');
$part->setType(
Horde_Kolab_Storage_Object_MimeType::getMimeTypeFromObjectType($this->getType())
);
$part->setContents(
$content, array('encoding' => 'quoted-printable')
);
return $part;
}
/* ArrayAccess methods. */
public function offsetExists($offset)
{
return isset($this->_data[$offset]);
}
public function offsetGet($offset)
{
return isset($this->_data[$offset]) ? $this->_data[$offset] : '';
}
public function offsetSet($offset, $value)
{
$this->_data[$offset] = $value;
}
public function offsetUnset($offset)
{
unset($this->_data[$offset]);
}
/* Serializable methods. */
/**
* Serialization.
*
* @return string Serialized data.
*/
public function serialize()
{
return serialize(
array(
self::SERIALIZATION_DATA => $this->_data,
self::SERIALIZATION_ERRORS => $this->_errors,
self::SERIALIZATION_TYPE => $this->_type,
self::SERIALIZATION_FOLDER => $this->_folder,
self::SERIALIZATION_BACKENDID => $this->_backend_id,
self::SERIALIZATION_MIMEPARTID => $this->_mime_part_id,
)
);
}
/**
* Unserialization.
*
* @param string $data Serialized data.
*
* @throws Horde_Kolab_Storage_Object_Exception
*/
public function unserialize($data)
{
$data = @unserialize($data);
if (!is_array($data)) {
throw new Horde_Kolab_Storage_Object_Exception('Cache data invalid');
}
if (isset($data[self::SERIALIZATION_DATA])) {
$this->_data = $data[self::SERIALIZATION_DATA];
}
if (isset($data[self::SERIALIZATION_ERRORS])) {
$this->_errors = $data[self::SERIALIZATION_ERRORS];
}
if (isset($data[self::SERIALIZATION_TYPE])) {
$this->_type = $data[self::SERIALIZATION_TYPE];
}
if (isset($data[self::SERIALIZATION_FOLDER])) {
$this->_folder = $data[self::SERIALIZATION_FOLDER];
}
if (isset($data[self::SERIALIZATION_BACKENDID])) {
$this->_backend_id = $data[self::SERIALIZATION_BACKENDID];
}
if (isset($data[self::SERIALIZATION_MIMEPARTID])) {
$this->_mime_part_id = $data[self::SERIALIZATION_MIMEPARTID];
}
}
}
|