/usr/share/horde/turba/lib/Object.php is in php-horde-turba 4.2.12-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 | <?php
/**
* Copyright 2000-2016 Horde LLC (http://www.horde.org/)
*
* See the enclosed file LICENSE for license information (ASL). If you did
* did not receive this file, see http://www.horde.org/licenses/apache.
*
* @category Horde
* @copyright 2000-2016 Horde LLC
* @license http://www.horde.org/licenses/apache ASL
* @package Turba
*/
/**
* A base implementation for Turba objects - people, groups, restaurants, etc.
*
* @author Chuck Hagenbuch <chuck@horde.org>
* @author Jon Parise <jon@csh.rit.edu>
* @category Horde
* @copyright 2000-2016 Horde LLC
* @license http://www.horde.org/licenses/apache ASL
* @package Turba
*/
class Turba_Object
{
/**
* Underlying driver.
*
* @var Turba_Driver
*/
public $driver;
/**
* Hash of attributes for this contact.
*
* @var array
*/
public $attributes;
/**
* Keeps the normalized values of sort columns.
*
* @var array
*/
public $sortValue = array();
/**
* Any additional options.
*
* @var boolean
*/
protected $_options = array();
/**
* Reference to this object's VFS instance.
*
* @var VFS
*/
protected $_vfs;
/**
* Local cache of available email addresses. Needed to ensure we
* populate the email field correctly. See See Bug: 12955 and Bug: 14046.
* A hash with turba attribute names as key.
*
* @var array
*/
protected $_emailFields = array();
/**
* Constructs a new Turba_Object object.
*
* @param Turba_Driver $driver The source that this object came from.
* @param array $attributes Hash of attributes for this object.
* @param array $options Hash of options for this object. @since
* Turba 4.2
*/
public function __construct(Turba_Driver $driver,
array $attributes = array(),
array $options = array())
{
$this->driver = $driver;
$this->attributes = $attributes;
$this->attributes['__type'] = 'Object';
$this->_options = $options;
}
/**
* Returns a key-value hash containing all properties of this object.
*
* @return array All properties of this object.
*/
public function getAttributes()
{
return $this->attributes;
}
/**
* Returns the name of the address book that this object is from.
*/
public function getSource()
{
return $this->driver->getName();
}
/**
* Get a fully qualified key for this contact.
*
* @param string $delimiter Delimiter for the parts of the key, defaults to ':'.
*
* @return string Fully qualified contact id.
*/
public function getGuid($delimiter = ':')
{
return 'turba' . $delimiter . $this->getSource() . $delimiter . $this->getValue('__uid');
}
/**
* Returns the value of the specified attribute.
*
* @param string $attribute The attribute to retrieve.
*
* @return mixed The value of $attribute, an array (for photo type)
* or the empty string.
*/
public function getValue($attribute)
{
global $attributes, $injector;
if (isset($this->attributes[$attribute]) &&
($hooks = $injector->getInstance('Horde_Core_Hooks')) &&
$hooks->hookExists('decode_attribute', 'turba')) {
try {
return $hooks->callHook(
'decode_attribute',
'turba',
array($attribute, $this->attributes[$attribute], $this)
);
} catch (Turba_Exception $e) {}
} elseif (isset($this->driver->map[$attribute]) &&
is_array($this->driver->map[$attribute])) {
$args = array();
foreach ($this->driver->map[$attribute]['fields'] as $field) {
$args[] = $this->getValue($field);
}
return Turba::formatCompositeField($this->driver->map[$attribute]['format'], $args);
} elseif (!isset($this->attributes[$attribute])) {
if (isset($attributes[$attribute]) &&
($attributes[$attribute]['type'] == 'Turba:TurbaTags') &&
($uid = $this->getValue('__uid'))) {
$this->synchronizeTags($injector->getInstance('Turba_Tagger')->getTags($uid, 'contact'));
} else {
return null;
}
} elseif (isset($attributes[$attribute]) &&
($attributes[$attribute]['type'] == 'image')) {
return empty($this->attributes[$attribute])
? null
: array(
'load' => array(
'data' => $this->attributes[$attribute],
'file' => basename(Horde::getTempFile('horde_form_', false, '', false, true))
)
);
}
return $this->attributes[$attribute];
}
/**
* Sets the value of the specified attribute.
*
* @param string $attribute The attribute to set.
* @param string $value The value of $attribute.
*/
public function setValue($attribute, $value)
{
global $injector, $attributes;
$hooks = $injector->getInstance('Horde_Core_Hooks');
if ($hooks->hookExists('encode_attribute', 'turba')) {
try {
$value = $hooks->callHook(
'encode_attribute',
'turba',
array(
$attribute,
$value,
isset($this->attributes[$attribute]) ? $this->attributes[$attribute] : null,
$this
)
);
} catch (Turba_Exception $e) {}
}
if (isset($this->driver->map[$attribute]) &&
is_array($this->driver->map[$attribute]) &&
!isset($this->driver->map[$attribute]['attribute'])) {
// If we don't know the attribute, and it's an email field, save it
// in case we need to populate an email field on save.
if (isset($attributes[$attribute]) &&
$attributes[$attribute]['type'] == 'email') {
$this->_emailFields[$attribute] = $value;
}
return;
}
$this->attributes[$attribute] = $value;
}
/**
* Determines whether or not the object has a value for the specified
* attribute.
*
* @param string $attribute The attribute to check.
*
* @return boolean Whether or not there is a value for $attribute.
*/
public function hasValue($attribute)
{
if (isset($this->driver->map[$attribute]) &&
is_array($this->driver->map[$attribute])) {
foreach ($this->driver->map[$attribute]['fields'] as $field) {
if ($this->hasValue($field)) {
return true;
}
}
return false;
} else {
return !is_null($this->getValue($attribute));
}
}
/**
* Syncronizes tags from the tagging backend with the contacts storage
* backend, if necessary.
*
* @param array $tags Tags from the tagging backend.
*/
public function synchronizeTags(array $tags)
{
if (!is_null($internaltags = $this->getValue('__internaltags'))) {
$internaltags = unserialize($internaltags);
usort($tags, 'strcoll');
if (array_diff($internaltags, $tags)) {
$GLOBALS['injector']->getInstance('Turba_Tagger')->replaceTags(
$this->getValue('__uid'),
$internaltags,
$this->driver->getContactOwner(),
'contact'
);
}
$this->setValue('__tags', implode(', ', $internaltags));
} else {
$this->setValue('__tags', implode(', ', $tags));
}
}
/**
* Returns the timestamp of the last modification, whether this was the
* creation or editing of the object and stores it as the attribute
* __modified. The value is cached for the lifetime of the object.
*
* @return integer The timestamp of the last modification or zero.
*/
public function lastModification()
{
$time = $this->getValue('__modified');
if (!is_null($time)) {
return $time;
}
if (!$this->getValue('__uid')) {
$this->setValue('__modified', 0);
return 0;
}
$time = 0;
try {
$log = $GLOBALS['injector']
->getInstance('Horde_History')
->getHistory($this->getGuid());
foreach ($log as $entry) {
if ($entry['action'] == 'add' || $entry['action'] == 'modify') {
$time = max($time, $entry['ts']);
}
}
} catch (Exception $e) {}
$this->setValue('__modified', $time);
return $time;
}
/**
* Merges another contact into this one by filling empty fields of this
* contact with values from the other.
*
* @param Turba_Object $contact Another contact.
*/
public function merge(Turba_Object $contact)
{
foreach (array_keys($contact->attributes) as $attribute) {
if (!$this->hasValue($attribute) && $contact->hasValue($attribute)) {
$this->setValue($attribute, $contact->getValue($attribute));
}
}
}
/**
* Returns history information about this contact.
*
* @return array A hash with the optional entries 'created' and 'modified'
* and human readable history information as the values.
*/
public function getHistory()
{
if (!$this->getValue('__uid')) {
return array();
}
$history = array();
try {
$log = $GLOBALS['injector']
->getInstance('Horde_History')
->getHistory($this->getGuid());
foreach ($log as $entry) {
if ($entry['action'] == 'add' || $entry['action'] == 'modify') {
if ($GLOBALS['registry']->getAuth() != $entry['who']) {
$by = sprintf(_("by %s"), Turba::getUserName($entry['who']));
} else {
$by = _("by me");
}
$history[$entry['action'] == 'add' ? 'created' : 'modified']
= strftime($GLOBALS['prefs']->getValue('date_format'), $entry['ts'])
. ' '
. date($GLOBALS['prefs']->getValue('twentyFour') ? 'G:i' : 'g:i a', $entry['ts'])
. ' '
. htmlspecialchars($by);
}
}
} catch (Exception $e) {
return array();
}
return $history;
}
/**
* Returns true if this object is a group of multiple contacts.
*
* @return boolean True if this object is a group of multiple contacts.
*/
public function isGroup()
{
return false;
}
/**
* Returns true if this object is editable by the current user.
*
* @return boolean Whether or not the current user can edit this object
*/
public function isEditable()
{
return $this->driver->hasPermission(Horde_Perms::EDIT);
}
/**
* Returns whether or not the current user has the requested permission.
*
* @param integer $perm The permission to check.
*
* @return boolean True if user has the permission.
*/
public function hasPermission($perm)
{
return $this->driver->hasPermission($perm);
}
/**
* Contact url.
*
* @param string $view The view for the url
* @param boolean $full Generate a full url?
*
* @return string
*/
public function url($view = null, $full = false)
{
$url = Horde::url('contact.php', $full)->add(array(
'source' => $this->driver->getName(),
'key' => $this->getValue('__key')
));
if (!is_null($view)) {
$url->add('view', $view);
}
return $url;
}
/**
* Saves a file into the VFS backend associated with this object.
*
* @param array $info A hash with the file information as returned from a
* Horde_Form_Type_file.
* @throws Turba_Exception
*/
public function addFile(array $info)
{
if (!$this->getValue('__uid')) {
throw new Turba_Exception('VFS not supported for this object.');
}
$vfs = $this->vfsInit();
$dir = Turba::VFS_PATH . '/' . $this->getValue('__uid');
$file = $info['name'];
while ($vfs->exists($dir, $file)) {
if (preg_match('/(.*)\[(\d+)\](\.[^.]*)?$/', $file, $match)) {
$file = $match[1] . '[' . ++$match[2] . ']' . $match[3];
} else {
$dot = strrpos($file, '.');
if ($dot === false) {
$file .= '[1]';
} else {
$file = substr($file, 0, $dot) . '[1]' . substr($file, $dot);
}
}
}
try {
$vfs->write($dir, $file, $info['tmp_name'], true);
} catch (Horde_Vfs_Exception $e) {
throw new Turba_Exception($e);
}
}
/**
* Deletes a file from the VFS backend associated with this object.
*
* @param string $file The file name.
* @throws Turba_Exception
*/
public function deleteFile($file)
{
if (!$this->getValue('__uid')) {
throw new Turba_Exception('VFS not supported for this object.');
}
try {
$this->vfsInit()->deleteFile(Turba::VFS_PATH . '/' . $this->getValue('__uid'), $file);
} catch (Horde_Vfs_Exception $e) {
throw new Turba_Exception($e);
}
}
/**
* Deletes all files from the VFS backend associated with this object.
*
* @throws Turba_Exception
*/
public function deleteFiles()
{
if (!$this->getValue('__uid')) {
throw new Turba_Exception('VFS not supported for this object.');
}
$vfs = $this->vfsInit();
if ($vfs->exists(Turba::VFS_PATH, $this->getValue('__uid'))) {
try {
$vfs->deleteFolder(Turba::VFS_PATH, $this->getValue('__uid'), true);
} catch (Horde_Vfs_Exception $e) {
throw new Turba_Exception($e);
}
}
}
/**
* Returns all files from the VFS backend associated with this object.
*
* @return array A list of hashes with file informations.
*/
public function listFiles()
{
if ($this->getValue('__uid')) {
try {
$vfs = $this->vfsInit();
if ($vfs->exists(Turba::VFS_PATH, $this->getValue('__uid'))) {
return $vfs->listFolder(Turba::VFS_PATH . '/' . $this->getValue('__uid'));
}
} catch (Turba_Exception $e) {}
}
return array();
}
/**
* Returns a link to display and download a file from the VFS backend
* associated with this object.
*
* @param string $file The file name.
*
* @return string The HTML code of the generated link.
*/
public function vfsDisplayUrl($file)
{
global $registry;
$mime_part = new Horde_Mime_Part();
$mime_part->setType(Horde_Mime_Magic::extToMime($file['type']));
$viewer = $GLOBALS['injector']->getInstance('Horde_Core_Factory_MimeViewer')->create($mime_part);
// We can always download files.
$url_params = array(
'actionID' => 'download_file',
'file' => $file['name'],
'type' => $file['type'],
'source' => $this->driver->getName(),
'key' => $this->getValue('__key')
);
$dl = Horde::link($registry->downloadUrl($file['name'], $url_params), $file['name']) . Horde_Themes_Image::tag('download.png', array('alt' => _("Download"))) . '</a>';
// Let's see if we can view this one, too.
if ($viewer && !($viewer instanceof Horde_Mime_Viewer_Default)) {
$url = Horde::url('view.php')
->add($url_params)
->add('actionID', 'view_file');
$link = Horde::link($url, $file['name'], null, '_blank') . $file['name'] . '</a>';
} else {
$link = $file['name'];
}
return $link . ' ' . $dl;
}
/**
* Returns a link to display, download, and delete a file from the VFS
* backend associated with this object.
*
* @param string $file The file name.
*
* @return string The HTML code of the generated link.
*/
public function vfsEditUrl($file)
{
$delform = '<form action="' .
Horde::url('deletefile.php') .
'" style="display:inline" method="post">' .
Horde_Util::formInput() .
'<input type="hidden" name="file" value="' . htmlspecialchars($file['name']) . '" />' .
'<input type="hidden" name="source" value="' . htmlspecialchars($this->driver->getName()) . '" />' .
'<input type="hidden" name="key" value="' . htmlspecialchars($this->getValue('__key')) . '" />' .
'<input type="image" class="img" src="' . Horde_Themes::img('delete.png') . '" />' .
'</form>';
return $this->vfsDisplayUrl($file) . ' ' . $delform;
}
/**
* Saves the current state of the object to the storage backend.
*
* @throws Turba_Exception
*/
public function store()
{
$this->_ensureEmail();
return $this->setValue('__key', $this->driver->save($this));
}
/**
* Loads the VFS configuration and initializes the VFS backend.
*
* @return Horde_Vfs A VFS object.
* @throws Turba_Exception
*/
public function vfsInit()
{
if (!isset($this->_vfs)) {
try {
$this->_vfs = $GLOBALS['injector']->getInstance('Horde_Core_Factory_Vfs')->create('documents');
} catch (Horde_Exception $e) {
throw new Turba_Exception($e);
}
}
return $this->_vfs;
}
/**
* Ensure we have an email address set, if available. Needed to cover the
* case where a contact might have been imported via vCard with email TYPEs
* that do not match the configured attributes for this source. E.g., the
* vCard contains a TYPE=HOME but we only have the generic 'email' field
* available.
*
* @return [type] [description]
*/
protected function _ensureEmail()
{
global $attributes;
foreach ($this->attributes as $attribute => $value) {
if ($attributes[$attribute]['type'] = 'email') {
// We have an email defined, no need to check.
return;
}
}
// No email defined yet, see if we have any available:
foreach ($this->_emailFields as $attribute => $email) {
if (!empty($this->driver->map[$attribute])) {
$this->attributes[$attribute] = $email;
break;
} elseif (!empty($this->driver->map['email'])) {
$this->attribute['email'] = $email;
break;
}
}
}
}
|