/usr/share/php/Horde/Share/Base.php is in php-horde-share 2.0.8-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 | <?php
/**
* Base class for all Horde_Share drivers.
*
* Copyright 2002-2016 Horde LLC (http://www.horde.org/)
* Copyright 2002-2007 Infoteck Internet <webmaster@infoteck.qc.ca>
*
* See the enclosed file COPYING for license information (LGPL). If you
* did not receive this file, see http://www.horde.org/licenses/lgpl21.
*
* @author Joel Vandal <joel@scopserv.com>
* @author Mike Cochrame <mike@graftonhall.co.nz>
* @author Chuck Hagenbuch <chuck@horde.org>
* @author Jan Schneider <jan@horde.org>
* @author Gunnar Wrobel <wrobel@pardus.de>
* @author Michael J. Rubinsky <mrubinsk@horde.org>
* @package Share
*/
abstract class Horde_Share_Base
{
/**
* The application we're managing shares for.
*
* @var string
*/
protected $_app;
/**
* The root of the Share tree.
*
* @var mixed
*/
protected $_root = null;
/**
* A cache of all shares that have been retrieved, so we don't hit the
* backend again and again for them.
*
* @var array
*/
protected $_cache = array();
/**
* Id-name-map of already cached share objects.
*
* @var array
*/
protected $_shareMap = array();
/**
* Cache used for listShares().
*
* @var array
*/
protected $_listcache = array();
/**
* A list of objects that we're currently sorting, for reference during the
* sorting algorithm.
*
* @var array
*/
protected $_sortList;
/**
* The Horde_Share_Object subclass to instantiate objects as
*
* @var string
*/
protected $_shareObject;
/**
* The Horde_Perms object
*
* @var Horde_Perms_Base
*/
protected $_permsObject;
/**
* The current user
*
* @var string
*/
protected $_user;
/**
* The Horde_Group driver
*
* @var Horde_Group_Base
*/
protected $_groups;
/**
* A callback that is passed to the share objects for setting the objects'
* Horde_Share object.
*
* @var callback
*/
protected $_shareCallback;
/**
* Logger
*
* @var Horde_Log_Logger
*/
protected $_logger;
/**
* Configured callbacks. We currently support:
*<pre>
* add - Called immediately before a new share is added. Receives the
* share object as a parameter.
* modify - Called immediately before a share object's changes are saved
* to storage. Receives the share object as a parameter.
* remove - Called immediately before a share is removed from storage.
* Receives the share object as a parameter.
* list - Called immediately after a list of shares is received from
* storage. Passed the userid, share list, and any parameters
* passed to the listShare call. Should return the (possibly
* modified) share list. @see listShares() for more
* info.
*</pre>
*
* @var array
*/
protected $_callbacks;
/**
* Constructor.
*
* @param string $app The application that the shares belong
* to.
* @param string $user The current user.
* @param Horde_Perms_Base $perms The permissions object.
* @param Horde_Group_Base $groups The Horde_Group driver.
*
*/
public function __construct($app, $user, Horde_Perms_Base $perms,
Horde_Group_Base $groups)
{
$this->_app = $app;
$this->_user = $user;
$this->_permsObject = $perms;
$this->_groups = $groups;
$this->_logger = new Horde_Support_Stub();
}
/**
* Set a logger object.
*
* @inject
*
* @var Horde_Log_Logger $logger The logger object.
*/
public function setLogger(Horde_Log_Logger $logger)
{
$this->_logger = $logger;
}
/**
* (Re)connects the share object to this share driver.
*
* @param Horde_Share_Object $object
*/
public function initShareObject(Horde_Share_Object $object)
{
$object->setShareOb(empty($this->_shareCallback) ? $this : $this->_shareCallback);
}
public function setShareCallback($callback)
{
$this->_shareCallback = $callback;
}
/**
* Returns the application we're managing shares for.
*
* @return string The application this share belongs to.
*/
public function getApp()
{
return $this->_app;
}
/**
* Returns a Horde_Share_Object object corresponding to the given share
* name, with the details retrieved appropriately.
*
* @param string $name The name of the share to retrieve.
*
* @return Horde_Share_Object The requested share.
*/
public function getShare($name)
{
if (isset($this->_cache[$name])) {
return $this->_cache[$name];
}
$share = $this->_getShare($name);
$this->_shareMap[$share->getId()] = $name;
$this->_cache[$name] = $share;
return $share;
}
/**
* Returns a Horde_Share_Object object corresponding to the given
* share name, with the details retrieved appropriately.
*
* @param string $name The name of the share to retrieve.
*
* @return Horde_Share_Object The requested share.
* @throws Horde_Exception_NotFound
* @throws Horde_Share_Exception
*/
abstract protected function _getShare($name);
/**
* Returns a Horde_Share_Object object corresponding to the given unique
* ID, with the details retrieved appropriately.
*
* @param string $cid The id of the share to retrieve.
*
* @return Horde_Share_Object The requested share.
*/
public function getShareById($cid)
{
if (!isset($this->_shareMap[$cid])) {
$share = $this->_getShareById($cid);
$name = $share->getName();
$this->_cache[$name] = $share;
$this->_shareMap[$cid] = $name;
}
return $this->_cache[$this->_shareMap[$cid]];
}
/**
* Returns a Horde_Share_Object object corresponding to the given
* unique ID, with the details retrieved appropriately.
*
* @param integer $id The id of the share to retrieve.
*
* @return Horde_Share_Object_sql The requested share.
* @throws Horde_Share_Exception, Horde_Exception_NotFound
*/
abstract protected function _getShareById($id);
/**
* Returns an array of Horde_Share_Object objects corresponding to the
* given set of unique IDs, with the details retrieved appropriately.
*
* @param array $cids The array of ids to retrieve.
*
* @return array The requested shares.
*/
public function getShares(array $cids)
{
$all_shares = $missing_ids = array();
foreach ($cids as $cid) {
if (!isset($this->_shareMap[$cid])) {
$missing_ids[] = $cid;
}
}
if (count($missing_ids)) {
$shares = $this->_getShares($missing_ids);
foreach (array_keys($shares) as $key) {
$this->_cache[$key] = $shares[$key];
$this->_shareMap[$shares[$key]->getId()] = $key;
}
}
foreach ($cids as $cid) {
$all_shares[$this->_shareMap[$cid]] = $this->_cache[$this->_shareMap[$cid]];
}
return $all_shares;
}
/**
* Returns an array of Horde_Share_Object objects corresponding
* to the given set of unique IDs, with the details retrieved
* appropriately.
*
* @param array $ids The array of ids to retrieve.
*
* @return array The requested shares.
* @throws Horde_Share_Exception
*/
abstract protected function _getShares(array $ids);
/**
* Lists *all* shares for the current app/share, regardless of
* permissions.
*
* This is for admin functionality and scripting tools, and shouldn't be
* called from user-level code!
*
* @return array All shares for the current app/share.
*/
public function listAllShares()
{
$shares = $this->_listAllShares();
$this->_sortList = $shares;
uasort($shares, array($this, '_sortShares'));
$this->_sortList = null;
return $shares;
}
/**
* Lists *all* shares for the current app/share, regardless of permissions.
*
* @return array All shares for the current app/share.
* @throws Horde_Share_Exception
*/
abstract protected function _listAllShares();
/**
* Returns an array of all shares that $userid has access to.
*
* @param string $userid The userid of the user to check access for. An
* empty value for the userid will only return shares
* with guest access.
* @param array $params Additional parameters for the search.
*<pre>
* 'perm' Require this level of permissions. Horde_Perms constant.
* 'attributes' Restrict shares to these attributes. A hash or username.
* 'from' Offset. Start at this share
* 'count' Limit. Only return this many.
* 'sort_by' Sort by attribute.
* 'direction' Sort by direction.
*</pre>
*
* @return array The shares the user has access to.
*/
public function listShares($userid, array $params = array())
{
$params = array_merge(array('perm' => Horde_Perms::SHOW,
'attributes' => null,
'from' => 0,
'count' => 0,
'sort_by' => null,
'direction' => 0),
$params);
$shares = $this->_listShares($userid, $params);
if (!count($shares)) {
return $shares;
}
$shares = $this->getShares($shares);
if (is_null($params['sort_by'])) {
$this->_sortList = $shares;
uasort($shares, array($this, '_sortShares'));
$this->_sortList = null;
}
// Run the results through the callback, if configured.
if (!empty($this->_callbacks['list'])) {
return $this->runCallback('list', array($userid, $shares, $params));
}
return $shares;
}
/**
* Returns an array of all shares that $userid has access to.
*
* @param string $userid The userid of the user to check access for.
* @param array $params See listShares().
*
* @return array The shares the user has access to.
*/
abstract protected function _listShares($userid, array $params = array());
/**
* Returns an array of all system shares.
*
* @return array All system shares.
*/
public function listSystemShares()
{
return array();
}
/**
* Returns the number of shares that $userid has access to.
*
* @param string $userid The userid of the user to check access for.
* @param integer $perm The level of permissions required.
* @param mixed $attributes Restrict the shares counted to those
* matching $attributes. An array of
* attribute/values pairs or a share owner
* username.
*
* @return integer The number of shares
*/
public function countShares($userid, $perm = Horde_Perms::SHOW,
$attributes = null)
{
return count($this->_listShares($userid, array('perm' => $perm, 'attributes' => $attributes)));
}
/**
* Returns a new share object.
*
* @param string $owner The share owner name.
* @param string $share_name The share's name.
* @param string $name_attribute The name displayed to the user.
*
* @return Horde_Share_Object A new share object.
* @throws Horde_Share_Exception
*/
public function newShare($owner, $share_name = '', $name_attribute = '')
{
$share = $this->_newShare($share_name);
$share->set('owner', $owner);
$share->set('name', $name_attribute);
return $share;
}
/**
* Returns a new share object.
*
* @param string $name The share's name.
*
* @return Horde_Share_Object A new share object
* @throws InvalidArgumentException
*/
abstract protected function _newShare($name);
/**
* Adds a share to the shares system.
*
* The share must first be created with newShare(), and have any initial
* details added to it, before this function is called.
*
* @param Horde_Share_Object $share The new share object.
*
* @throws Horde_Share_Exception
*/
public function addShare(Horde_Share_Object $share)
{
// Run the results through the callback, if configured.
$this->runCallback('add', array($share));
$this->_addShare($share);
/* Store new share in the caches. */
$id = $share->getId();
$name = $share->getName();
$this->_cache[$name] = $share;
$this->_shareMap[$id] = $name;
/* Reset caches that depend on unknown criteria. */
$this->expireListCache();
}
/**
* Adds a share to the shares system.
*
* The share must first be created with
* Horde_Share_sql::_newShare(), and have any initial details added
* to it, before this function is called.
*
* @param Horde_Share_Object $share The new share object.
*/
abstract protected function _addShare(Horde_Share_Object $share);
/**
* Renames a share in the shares system.
*
* @param Horde_Share_Object $share The share to rename.
* @param string $name The share's new name.
*
* @throws Horde_Share_Exception
*/
public function renameShare(Horde_Share_Object $share, $name)
{
/* Move share in the caches. */
unset($this->_cache[$share->getName()]);
$this->_cache[$name] = $share;
/* Reset caches that depend on unknown criteria. */
$this->expireListCache();
$this->_renameShare($share, $name);
}
/**
* Renames a share in the shares system.
*
* @param Horde_Share_Object $share The share to rename.
* @param string $name The share's new name.
*
* @throws Horde_Share_Exception
*/
abstract protected function _renameShare(Horde_Share_Object $share, $name);
/**
* Removes a share from the shares system permanently.
*
* @param Horde_Share_Object $share The share to remove.
*
* @throws Horde_Share_Exception
*/
public function removeShare(Horde_Share_Object $share)
{
// Run the results through the callback, if configured.
$this->runCallback('remove', array($share));
/* Remove share from the caches. */
$id = $share->getId();
unset($this->_shareMap[$id]);
unset($this->_cache[$share->getName()]);
/* Reset caches that depend on unknown criteria. */
$this->expireListCache();
$this->_removeShare($share);
}
/**
* Removes a share from the shares system permanently.
*
* @param Horde_Share_Object $share The share to remove.
*
* @throws Horde_Share_Exception
*/
abstract protected function _removeShare(Horde_Share_Object $share);
/**
* Checks if a share name exists in the system.
*
* @param string $share The share name to check.
*
* @return boolean True if the share exists.
*/
public function exists($share)
{
if (isset($this->_cache[$share])) {
return true;
}
return $this->_exists($share);
}
/**
* Check that a share id exists in the system.
*
* @param integer $id The share id
*
* @return boolean True if the share exists.
*/
public function idExists($id)
{
if (isset($this->_shareMap[$id])) {
return true;
}
return $this->_idExists($id);
}
/**
* Checks if a share exists in the system.
*
* @param string $share The share to check.
*
* @return boolean True if the share exists.
* @throws Horde_Share_Exception
*/
abstract protected function _exists($share);
/**
* Check that a share id exists in the system.
*
* @param integer $id The share id
*
* @return boolean True if the share exists.
*/
abstract protected function _idExists($id);
/**
* Finds out what rights the given user has to this object.
*
* @see Horde_Perms::getPermissions
*
* @param mixed $share The share that should be checked for the users
* permissions.
* @param string $user The user to check for.
*
* @return mixed A bitmask of permissions, a permission value, or an array
* of permission values the user has, depending on the
* permission type and whether the permission value is
* ambiguous. False if there is no such permsission.
*/
public function getPermissions($share, $user = null)
{
if (!($share instanceof Horde_Share_Object)) {
$share = $this->getShare($share);
}
return $this->_permsObject->getPermissions($share->getPermission(), $user);
}
/**
* Set the class type to use for creating share objects.
*
* @var string $classname The classname to use.
*/
public function setShareClass($classname)
{
$this->_shareObject = $classname;
}
/**
* Getter for Horde_Perms object
*
* @return Horde_Perms_Base
*/
public function getPermsObject()
{
return $this->_permsObject;
}
/**
* Convert TO the storage driver's charset. Individual share objects should
* implement this method if needed.
*
* @param array $data Data to be converted.
*/
public function toDriverCharset($data)
{
return $data;
}
/**
* Add a callback to the collection
*
* @param string $type
* @param array $callback
*/
public function addCallback($type, $callback)
{
$this->_callbacks[$type] = $callback;
}
/**
* Returns the share's list cache.
*
* @return array
*/
public function getListCache()
{
return $this->_listcache;
}
/**
* Set the list cache.
*
* @param array $cache
*/
public function setListCache($cache)
{
$this->_listcache = $cache;
}
/**
* Resets the internal caches.
*/
public function resetCache()
{
$this->_cache = $this->_shareMap = array();
$this->expireListCache();
}
/**
* Give public access to call the share callbacks. Needed to run the
* callbacks from the Horde_Share_Object objects.
*
* @param string $type The callback to run
* @param array $params The parameters to pass to the callback.
*
* @return mixed
*/
public function runCallback($type, $params)
{
if (!empty($this->_callbacks[$type])) {
return call_user_func_array($this->_callbacks[$type], $params);
}
}
/**
* Expire the current list cache. This would be needed anytime a share is
* either added, deleted, had a change in owner, parent, or perms.
*/
public function expireListCache()
{
$this->_listcache = array();
}
/**
* Utility function to be used with uasort() for sorting arrays of
* Horde_Share objects.
*
* Example:
* <code>
* uasort($list, array('Horde_Share', '_sortShares'));
* </code>
*/
protected function _sortShares($a, $b)
{
$aParts = explode(':', $a->getName());
$bParts = explode(':', $b->getName());
$min = min(count($aParts), count($bParts));
$idA = '';
$idB = '';
for ($i = 0; $i < $min; $i++) {
if ($idA) {
$idA .= ':';
$idB .= ':';
}
$idA .= $aParts[$i];
$idB .= $bParts[$i];
if ($idA != $idB) {
$curA = isset($this->_sortList[$idA]) ? $this->_sortList[$idA]->get('name') : '';
$curB = isset($this->_sortList[$idB]) ? $this->_sortList[$idB]->get('name') : '';
return strnatcasecmp($curA, $curB);
}
}
return count($aParts) > count($bParts);
}
}
|