/usr/share/horde/turba/lib/Turba.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 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 | <?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
*/
/**
* Turba Base Class.
*
* @author Chuck Hagenbuch <chuck@horde.org>
* @author Jon Parise <jon@horde.org>
* @category Horde
* @copyright 2000-2016 Horde LLC
* @license http://www.horde.org/licenses/apache ASL
* @package Turba
*/
class Turba
{
/**
* The virtual path to use for VFS data.
*/
const VFS_PATH = '.horde/turba/documents';
/**
* The current source.
*
* @var string
*/
static public $source;
/**
* Cached data.
*
* @var array
*/
static protected $_cache = array();
/**
* Returns the source entries from config/backends.php that have been
* configured as available sources in the main Turba configuration.
*
* @return array List of available sources.
* @throws Horde_Exception
*/
static public function availableSources()
{
global $registry;
$s = $registry->loadConfigFile('backends.php', 'cfgSources', 'turba')->config['cfgSources'];
$sources = array();
foreach ($s as $key => $source) {
if (empty($source['disabled'])) {
$sources[$key] = $source;
}
}
return $sources;
}
/**
* Get all the address books the user has the requested permissions to and
* return them in the user's preferred order.
*
* @param integer $permission The Horde_Perms::* constant to filter on.
* @param array $options Any additional options.
*
* @return array The filtered, ordered $cfgSources entries.
*/
static public function getAddressBooks($permission = Horde_Perms::READ,
array $options = array())
{
return self::permissionsFilter(
$GLOBALS['cfgSources'],
$permission,
$options
);
}
/**
* Returns the current user's default address book.
*
* @return string The default address book name.
*/
static public function getDefaultAddressbook()
{
/* In case of shares select first user owned address book as default */
if (!empty($_SESSION['turba']['has_share'])) {
try {
$owned_shares = self::listShares(true);
if (count($owned_shares)) {
return key($owned_shares);
}
} catch (Exception $e) {}
}
reset($GLOBALS['cfgSources']);
return key($GLOBALS['cfgSources']);
}
/**
* Returns the sort order selected by the user.
*
* @return array TODO
*/
static public function getPreferredSortOrder()
{
return @unserialize($GLOBALS['prefs']->getValue('sortorder'));
}
/**
* Saves the sort order to the preferences backend.
*
* @param Horde_Variables $vars Variables object.
* @param string $source Source.
*/
static public function setPreferredSortOrder(Horde_Variables $vars,
$source)
{
if (!strlen($sortby = $vars->get('sortby'))) {
return;
}
$sources = self::getColumns();
$columns = isset($sources[$source])
? $sources[$source]
: array();
$column_name = self::getColumnName($sortby, $columns);
$append = true;
$ascending = ($vars->get('sortdir') == 0);
if ($vars->get('sortadd')) {
$sortorder = self::getPreferredSortOrder();
foreach ($sortorder as $i => $elt) {
if ($elt['field'] == $column_name) {
$sortorder[$i]['ascending'] = $ascending;
$append = false;
}
}
} else {
$sortorder = array();
}
if ($append) {
$sortorder[] = array(
'ascending' => $ascending,
'field' => $column_name
);
}
$GLOBALS['prefs']->setValue('sortorder', serialize($sortorder));
}
/**
* Retrieves a column's field name.
*
* @param integer $i TODO
* @param array $columns TODO
*
* @return string TODO
*/
static public function getColumnName($i, $columns)
{
return (($i == 0) || !isset($columns[$i - 1]))
? 'name'
: $columns[$i - 1];
}
/**
* TODO
*/
static public function getColumns()
{
$columns = array();
$lines = explode("\n", $GLOBALS['prefs']->getValue('columns'));
foreach ($lines as $line) {
$line = trim($line);
if ($line) {
$cols = explode("\t", $line);
if (count($cols) > 1) {
$source = array_splice($cols, 0, 1);
$columns[$source[0]] = array();
foreach ($cols as $col) {
if ($col == '__tags' ||
isset($GLOBALS['cfgSources'][$source[0]]['map'][$col])) {
$columns[$source[0]][] = $col;
}
}
}
}
}
return $columns;
}
/**
* Builds and cleans up a composite field.
*
* @param string $format The sprintf field format.
* @param array $fields The fields that compose the composite field.
*
* @return string The formatted composite field.
*/
static public function formatCompositeField($format, $fields)
{
return preg_replace('/ +/', ' ', trim(vsprintf($format, $fields), " \t\n\r\0\x0B,"));
}
/**
* Returns a best guess at the lastname in a string.
*
* @param string $name String contain the full name.
*
* @return string String containing the last name.
*/
static public function guessLastname($name)
{
$name = trim(preg_replace('|\s|', ' ', $name));
if (!empty($name)) {
/* Assume that last names are always before any commas. */
if (is_int(strpos($name, ','))) {
$name = Horde_String::substr($name, 0, strpos($name, ','));
}
/* Take out anything in parentheses. */
$name = trim(preg_replace('|\(.*\)|', '', $name));
$namelist = explode(' ', $name);
$name = $namelist[($nameindex = (count($namelist) - 1))];
while (!empty($name) &&
(($nlength = Horde_String::length($name)) < 5) &&
strspn($name[($nlength - 1)], '.:-') &&
!empty($namelist[($nameindex - 1)])) {
$name = $namelist[--$nameindex];
}
}
return strlen($name)
? $name
: null;
}
/**
* Formats the name according to the user's preference.
*
* If the format is 'none', the full name with all parts is returned. If
* the format is 'last_first' or 'first_last', only the first name and
* last name are returned.
*
* @param Turba_Object $ob The object to get a name from.
* @param string $name_format The formatting. One of 'none', 'last_first'
* or 'first_last'. Defaults to the user
* preference.
*
* @return string The formatted name, either "Firstname Lastname"
* or "Lastname, Firstname" depending on $name_format or
* the user's preference.
*/
static public function formatName(Turba_Object $ob, $name_format = null)
{
if (!$name_format) {
if (!isset(self::$_cache['defaultFormat'])) {
self::$_cache['defaultFormat'] = $GLOBALS['prefs']->getValue('name_format');
}
$name_format = self::$_cache['defaultFormat'];
}
/* If no formatting, return original name. */
if (!in_array($name_format, array('first_last', 'last_first'))) {
return $ob->getValue('name');
}
/* See if we have the name fields split out explicitly. */
if ($ob->hasValue('firstname') && $ob->hasValue('lastname')) {
return ($name_format == 'last_first')
? $ob->getValue('lastname') . ', ' . $ob->getValue('firstname')
: $ob->getValue('firstname') . ' ' . $ob->getValue('lastname');
}
/* One field, we'll have to guess. */
$name = $ob->getValue('name');
$lastname = self::guessLastname($name);
if (($name_format == 'last_first') &&
!is_int(strpos($name, ',')) &&
(Horde_String::length($name) > Horde_String::length($lastname))) {
return $lastname . ', ' . preg_replace('/\s+' . preg_quote($lastname, '/') . '/', '', $name);
}
if (($name_format == 'first_last') &&
is_int(strpos($name, ',')) &&
(Horde_String::length($name) > Horde_String::length($lastname))) {
return preg_replace('/' . preg_quote($lastname, '/') . ',\s*/', '', $name) . ' ' . $lastname;
}
return $name;
}
/**
* TODO
*
* @param mixed $data Either a single email address or an array of email
* addresses to format.
* @param string $name The personal name phrase.
*
* @return mixed Either the formatted address or an array of formatted
* addresses.
*/
static public function formatEmailAddresses($data, $name)
{
if (!isset(self::$_cache['useRegistry'])) {
self::$_cache['useRegistry'] = $GLOBALS['registry']->hasMethod('mail/batchCompose');
}
$out = array();
$rfc822 = $GLOBALS['injector']->getInstance('Horde_Mail_Rfc822');
if (!is_array($data)) {
$data = array($data);
}
foreach ($data as $email_vals) {
foreach ($rfc822->parseAddressList($email_vals) as $ob) {
$addr = strval($ob);
$tmp = null;
if (self::$_cache['useRegistry']) {
try {
$tmp = $GLOBALS['registry']->call('mail/batchCompose', array(array($addr)));
} catch (Horde_Exception $e) {
self::$_cache['useRegistry'] = false;
}
}
$tmp = empty($tmp)
? 'mailto:' . urlencode($addr)
: reset($tmp);
$out[] = Horde::link($tmp) . htmlspecialchars($addr) . '</a>';
}
}
return implode(', ', $out);
}
/**
* Returns the real name, if available, of a user.
*
* @param string $uid The uid of the name to return.
*
* @return string The user's full, real name.
*/
static public function getUserName($uid)
{
if (!isset(self::$_cache['names'])) {
self::$_cache['names'] = array();
}
if (!isset(self::$_cache['names'][$uid])) {
$ident = $GLOBALS['injector']->getInstance('Horde_Core_Factory_Identity')->create($uid);
$ident->setDefault($ident->getDefault());
$name = $ident->getValue('fullname');
self::$_cache['names'][$uid] = empty($name)
? $uid
: $name;
}
return self::$_cache['names'][$uid];
}
/**
* Gets extended permissions on an address book.
*
* @param Turba_Driver $addressBook The address book to get extended
* permissions for.
* @param string $permission What extended permission to get.
*
* @return mixed The requested extended permissions value, or true if it
* doesn't exist.
*/
static public function getExtendedPermission(Turba_Driver $addressBook,
$permission)
{
// We want to check the base source as extended permissions
// are enforced per backend, not per share.
$key = $addressBook->getName() . ':' . $permission;
$perms = $GLOBALS['injector']->getInstance('Horde_Perms');
if (!$perms->exists('turba:sources:' . $key)) {
return true;
}
$allowed = $perms->getPermissions('turba:sources:' . $key, $GLOBALS['registry']->getAuth());
if (is_array($allowed)) {
switch ($permission) {
case 'max_contacts':
$allowed = max($allowed);
break;
}
}
return $allowed;
}
/**
* Filters sources based on permissions.
*
* @param array $in The source list we want filtered.
* @param integer $permission The Horde_Perms::* constant we will filter
* on.
* @param array $options Additional options:
* - require_add: (boolean) Only return sources
* that can be added to.
*
* @return array The filtered data.
*/
static public function permissionsFilter(array $in,
$permission = Horde_Perms::READ,
array $options = array())
{
$factory = $GLOBALS['injector']->getInstance('Turba_Factory_Driver');
$out = array();
foreach ($in as $sourceId => $source) {
try {
$driver = $factory->create($source, $sourceId);
if ($driver->hasPermission($permission) &&
(empty($options['require_add']) || $driver->canAdd())) {
$out[$sourceId] = $source;
}
} catch (Turba_Exception $e) {
Horde::log($e, 'ERR');
}
}
return $out;
}
/**
* Replaces all share-enabled sources in a source list with all shares
* from this source that the current user has access to.
*
* This will only sync shares that are unique to Horde (such as a SQL or
* Kolab sources). Any backend that supports ACLs or similar mechanism
* should be configured from within backends.local.php or via Horde's
* share_* hooks.
*
* @param array $sources The default $cfgSources array.
* @param boolean $owner Only return shares that the current user owns?
*
* @return array The $cfgSources array.
*/
static public function getConfigFromShares(array $sources, $owner = false)
{
try {
$shares = self::listShares($owner);
} catch (Horde_Share_Exception $e) {
// Notify the user if we failed, but still return the $cfgSource
// array.
$GLOBALS['notification']->push($e, 'horde.error');
return $sources;
}
/* See if any of our sources are configured to handle all otherwise
* unassigned Horde_Share objects. */
$all_shares = null;
foreach ($sources as $key => $cfg) {
if (!empty($cfg['all_shares'])) {
// Indicate the source handler that catches unassigned shares.
$all_shares = $key;
}
}
$auth_user = $GLOBALS['registry']->getAuth();
$sortedSources = $vbooks = array();
$personal = false;
foreach ($shares as $name => &$share) {
if (isset($sources[$name])) {
continue;
}
$personal |= ($share->get('owner') == $auth_user);
$params = @unserialize($share->get('params'));
if (empty($params['source']) && !empty($all_shares)) {
$params['source'] = $all_shares;
}
if (isset($params['type']) && $params['type'] == 'vbook') {
// We load vbooks last in case they're based on other shares.
$params['share'] = $share;
$vbooks[$name] = $params;
} elseif (!empty($params['source']) &&
!empty($sources[$params['source']]['use_shares'])) {
if (empty($params['name'])) {
$params['name'] = $name;
$share->set('params', serialize($params));
try {
$share->save();
} catch (Horde_Share_Exception $e) {
Horde::log($e, 'ERR');
}
}
$info = $sources[$params['source']];
$info['params']['config'] = $sources[$params['source']];
$info['params']['config']['params']['share'] = $share;
$info['params']['config']['params']['name'] = $params['name'];
$info['title'] = $share->get('name');
if ($share->get('owner') != $auth_user) {
$info['title'] .= ' [' . $GLOBALS['registry']->convertUsername($share->get('owner'), false) . ']';
}
$info['type'] = 'share';
$info['use_shares'] = false;
$sortedSources[$params['source']][$name] = $info;
}
}
// Check for the user's default share and built new source list.
$newSources = array();
foreach (array_keys($sources) as $source) {
if (empty($sources[$source]['use_shares'])) {
$newSources[$source] = $sources[$source];
continue;
}
if (isset($sortedSources[$source])) {
$newSources = array_merge($newSources, $sortedSources[$source]);
}
if (!empty($GLOBALS['conf']['share']['auto_create']) &&
$auth_user &&
!$personal) {
// User's default share is missing.
try {
$driver = $GLOBALS['injector']
->getInstance('Turba_Factory_Driver')
->create($source);
} catch (Turba_Exception $e) {
$GLOBALS['notification']->push($e->getMessage(), 'horde.error');
continue;
}
$sourceKey = strval(new Horde_Support_Randomid());
try {
$share = $driver->createShare(
$sourceKey,
array(
'params' => array(
'source' => $source,
'default' => true,
'name' => $auth_user
)
)
);
$source_config = $sources[$source];
$source_config['params']['share'] = $share;
$newSources[$sourceKey] = $source_config;
$personal = true;
$GLOBALS['prefs']->setValue('default_dir', $share->getName());
} catch (Horde_Share_Exception $e) {
Horde::log($e, 'ERR');
}
}
}
// Add vbooks now that all available address books are loaded.
foreach ($vbooks as $name => $params) {
if (isset($newSources[$params['source']])) {
$newSources[$name] = array(
'title' => $shares[$name]->get('name'),
'type' => 'vbook',
'params' => $params,
'export' => true,
'browse' => true,
'map' => $newSources[$params['source']]['map'],
'search' => $newSources[$params['source']]['search'],
'strict' => $newSources[$params['source']]['strict'],
'use_shares' => false,
);
}
}
return $newSources;
}
/**
* Retrieve a new source config entry based on a Turba share.
*
* @param Horde_Share_Object object The share to base config on.
*
* @return array The $cfgSource entry for this share source.
*/
public static function getSourceFromShare(Horde_Share_Object $share)
{
// Require a fresh config file.
$cfgSources = self::availableSources();
$params = @unserialize($share->get('params'));
$newConfig = $cfgSources[$params['source']];
$newConfig['params']['config'] = $cfgSources[$params['source']];
$newConfig['params']['config']['params']['share'] = $share;
$newConfig['params']['config']['params']['name'] = $params['name'];
$newConfig['title'] = $share->get('name');
$newConfig['type'] = 'share';
$newConfig['use_shares'] = false;
return $newConfig;
}
/**
* Returns all shares the current user has specified permissions to.
*
* @param boolean $owneronly Only return address books owned by the user?
* Defaults to false.
* @param integer $permission Permissions to filter by.
*
* @return array Shares the user has the requested permissions to.
*/
static public function listShares($owneronly = false,
$permission = Horde_Perms::READ)
{
if (!$GLOBALS['session']->get('turba', 'has_share') ||
($owneronly && !$GLOBALS['registry']->getAuth())) {
return array();
}
try {
return $GLOBALS['injector']->getInstance('Turba_Shares')->listShares(
$GLOBALS['registry']->getAuth(),
array(
'attributes' => $owneronly ? $GLOBALS['registry']->getAuth() : null,
'perm' => $permission
)
);
} catch (Horde_Share_Exception $e) {
Horde::log($e, 'ERR');
return array();
}
}
/**
* Create a new Turba share.
*
* @param string $share_name The id for the new share.
* @param array $params Parameters for the new share.
*
* @return Horde_Share The new share object.
* @throws Turba_Exception
*/
static public function createShare($share_name, $params)
{
if (isset($params['name'])) {
$name = $params['name'];
unset($params['name']);
} else {
/* Sensible default for empty display names */
$name = sprintf(_("Address book of %s"), $GLOBALS['injector']->getInstance('Horde_Core_Factory_Identity')->create()->getName());
}
/* Generate the new share. */
try {
$turba_shares = $GLOBALS['injector']->getInstance('Turba_Shares');
$share = $turba_shares->newShare($GLOBALS['registry']->getAuth(), $share_name, $name);
/* Now any other params. */
foreach ($params as $key => $value) {
if (!is_scalar($value)) {
$value = serialize($value);
}
$share->set($key, $value);
}
$turba_shares->addShare($share);
$share->save();
} catch (Horde_Share_Exception $e) {
Horde::log($e, 'ERR');
throw new Turba_Exception($e);
}
return $share;
}
/**
* Add browse.js javascript to page.
*/
static public function addBrowseJs()
{
global $page_output;
$page_output->addScriptFile('browse.js');
$page_output->addInlineJsVars(array(
'TurbaBrowse.confirmdelete' => _("Are you sure that you want to delete %s?"),
'TurbaBrowse.contact1' => _("You must select at least one contact first."),
'TurbaBrowse.contact2' => _("You must select a target contact list."),
'TurbaBrowse.contact3' => _("Please name the new contact list:"),
'TurbaBrowse.copymove' => _("You must select a target address book."),
'TurbaBrowse.submit' => _("Are you sure that you want to delete the selected contacts?")
));
}
/**
* Return an array of all available attributes of type 'email'.
*
* @return array An array of email fields.
* @since 4.2.9
*/
public static function getAvailableEmailFields()
{
global $attributes;
$emailFields = array();
foreach ($attributes as $field => $data) {
if ($data['type'] == 'email') {
$emailFields[] = $field;
}
}
return $emailFields;
}
}
|