/usr/share/php/Horde/Perms/Permission.php is in php-horde-perms 2.1.7-2.
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 | <?php
/**
* Instance of a single permissioning object.
*
* Copyright 2009-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.
*
* @author Chuck Hagenbuch <chuck@horde.org>
* @author Jan Schneider <jan@horde.org>
* @category Horde
* @package Perms
*/
class Horde_Perms_Permission
{
/**
* TODO
*/
public $data;
/**
* TODO
*/
public $name;
/**
* Incrementing version number if cached classes change.
*
* @var integer
*/
protected $_cacheVersion;
/**
* Constructor.
*
* @param string $name The name of the perm.
* @param integer $cacheVersion The revision number of the class.
* @param string $type The permission type.
* @param array $params A hash with any parameters that the
* permission type needs.
*/
public function __construct($name, $cacheVersion = null, $type = 'matrix',
$params = null)
{
$this->setName($name);
$this->setCacheVersion($cacheVersion);
$this->data['type'] = $type;
if (is_array($params)) {
$this->data['params'] = $params;
}
}
/**
* Sets the revision number of the class.
*
* @param integer $cacheVersion The revision number of the class.
*/
public function setCacheVersion($cacheVersion)
{
$this->_cacheVersion = $cacheVersion;
}
/**
* Gets one of the attributes of the object, or null if it isn't defined.
*
* @param string $attribute The attribute to get.
*
* @return mixed The value of the attribute, or null.
*/
public function get($attribute)
{
if (isset($this->data[$attribute])) {
return $this->data[$attribute];
}
return ($attribute == 'type') ? 'matrix' : null;
}
/**
* Get permission name.
*
* @return string Permission name.
*/
public function getName()
{
return $this->name;
}
/**
* Set permission name
*
* @param string $name Permission name.
*/
public function setName($name)
{
$this->name = $name;
}
/**
* Get permission details.
*
* @return array Permission details.
*/
public function getData()
{
return $this->data;
}
/**
* Set permission details.
*
* @param string $data Permission details.
*/
public function setData($data)
{
$this->data = $data;
}
/**
* Updates the permissions based on data passed in the array.
*
* @param array $perms An array containing the permissions which are to
* be updated.
*/
public function updatePermissions($perms)
{
$type = $this->get('type');
if ($type == 'matrix') {
/* Array of permission types to iterate through. */
$perm_types = Horde_Perms::getPermsArray();
}
foreach ($perms as $perm_class => $perm_values) {
switch ($perm_class) {
case 'default':
case 'guest':
case 'creator':
if ($type == 'matrix') {
foreach ($perm_types as $val => $label) {
if (!empty($perm_values[$val])) {
$this->setPerm($perm_class, $val, false);
} else {
$this->unsetPerm($perm_class, $val, false);
}
}
} elseif (!empty($perm_values)) {
$this->setPerm($perm_class, $perm_values, false);
} else {
$this->unsetPerm($perm_class, null, false);
}
break;
case 'u':
case 'g':
$permId = array('class' => $perm_class == 'u' ? 'users' : 'groups');
/* Figure out what names that are stored in this permission
* class have not been submitted for an update, ie. have been
* removed entirely. */
$current_names = isset($this->data[$permId['class']])
? array_keys($this->data[$permId['class']])
: array();
$updated_names = array_keys($perm_values);
$removed_names = array_diff($current_names, $updated_names);
/* Remove any names that have been completely unset. */
foreach ($removed_names as $name) {
unset($this->data[$permId['class']][$name]);
}
/* If nothing to actually update finish with this case. */
if (is_null($perm_values)) {
continue;
}
/* Loop through the names and update permissions for each. */
// @todo for Horde 6 - allow integer 0 values?
foreach ($perm_values as $name => $name_values) {
$permId['name'] = $name;
if ($type == 'matrix') {
foreach ($perm_types as $val => $label) {
if ($name_values[$val] === '0' || !empty($name_values[$val])) {
$this->setPerm($permId, $val, false);
} else {
$this->unsetPerm($permId, $val, false);
}
}
} elseif ($name_values === '0' || !empty($name_values)) {
$this->setPerm($permId, $name_values, false);
} else {
$this->unsetPerm($permId, null, false);
}
}
break;
}
}
}
/**
* TODO
*/
public function setPerm($permId, $permission, $update = true)
{
if (is_array($permId)) {
if (empty($permId['name'])) {
return;
}
if ($this->get('type') == 'matrix' &&
isset($this->data[$permId['class']][$permId['name']])) {
$this->data[$permId['class']][$permId['name']] |= $permission;
} else {
$this->data[$permId['class']][$permId['name']] = $permission;
}
} else {
if ($this->get('type') == 'matrix' &&
isset($this->data[$permId])) {
$this->data[$permId] |= $permission;
} else {
$this->data[$permId] = $permission;
}
}
if ($update) {
$this->save();
}
}
/**
* TODO
*/
public function unsetPerm($permId, $permission, $update = true)
{
if (is_array($permId)) {
if (empty($permId['name'])) {
return;
}
if ($this->get('type') == 'matrix') {
if (isset($this->data[$permId['class']][$permId['name']])) {
$this->data[$permId['class']][$permId['name']] &= ~$permission;
if (empty($this->data[$permId['class']][$permId['name']])) {
unset($this->data[$permId['class']][$permId['name']]);
}
} else {
$update = false;
}
} else {
unset($this->data[$permId['class']][$permId['name']]);
}
} else {
if ($this->get('type') == 'matrix') {
if (isset($this->data[$permId])) {
$this->data[$permId] &= ~$permission;
} else {
$update = false;
}
} else {
unset($this->data[$permId]);
}
}
if ($update) {
$this->save();
}
}
/**
* Grants a user additional permissions to this object.
*
* @param string $uer The user to grant additional permissions
* to.
* @param integer $permission The permission (DELETE, etc.) to add.
* @param boolean $update Whether to automatically update the
* backend.
*/
public function addUserPermission($user, $permission, $update = true)
{
if (empty($user)) {
return;
}
if ($this->get('type') == 'matrix' &&
isset($this->data['users'][$user])) {
$this->data['users'][$user] |= $permission;
} else {
$this->data['users'][$user] = $permission;
}
if ($update) {
$this->save();
}
}
/**
* Grants guests additional permissions to this object.
*
* @param integer $permission The permission (DELETE, etc.) to add.
* @param boolean $update Whether to automatically update the
* backend.
*/
public function addGuestPermission($permission, $update = true)
{
if ($this->get('type') == 'matrix' &&
isset($this->data['guest'])) {
$this->data['guest'] |= $permission;
} else {
$this->data['guest'] = $permission;
}
if ($update) {
$this->save();
}
}
/**
* Grants creators additional permissions to this object.
*
* @param integer $permission The permission (DELETE, etc.) to add.
* @param boolean $update Whether to automatically update the
* backend.
*/
public function addCreatorPermission($permission, $update = true)
{
if ($this->get('type') == 'matrix' &&
isset($this->data['creator'])) {
$this->data['creator'] |= $permission;
} else {
$this->data['creator'] = $permission;
}
if ($update) {
$this->save();
}
}
/**
* Grants additional default permissions to this object.
*
* @param integer $permission The permission (DELETE, etc.) to add.
* @param boolean $update Whether to automatically update the
* backend.
*/
public function addDefaultPermission($permission, $update = true)
{
if ($this->get('type') == 'matrix' &&
isset($this->data['default'])) {
$this->data['default'] |= $permission;
} else {
$this->data['default'] = $permission;
}
if ($update) {
$this->save();
}
}
/**
* Grants a group additional permissions to this object.
*
* @param integer $groupId The id of the group to grant additional
* permissions to.
* @param integer $permission The permission (DELETE, etc.) to add.
* @param boolean $update Whether to automatically update the
* backend.
*/
public function addGroupPermission($groupId, $permission, $update = true)
{
if (empty($groupId)) {
return;
}
if ($this->get('type') == 'matrix' &&
isset($this->data['groups'][$groupId])) {
$this->data['groups'][$groupId] |= $permission;
} else {
$this->data['groups'][$groupId] = $permission;
}
if ($update) {
$this->save();
}
}
/**
* Removes a permission that a user currently has on this object.
*
* @param string $user The user to remove the permission from.
* Defaults to all users.
* @param integer $permission The permission (DELETE, etc.) to
* remove. Defaults to all permissions.
* @param boolean $update Whether to automatically update the
* backend.
*/
public function removeUserPermission($user = null, $permission = null,
$update = true)
{
if (is_null($user)) {
$this->data['users'] = array();
} else {
if (!isset($this->data['users'][$user])) {
return;
}
if ($permission && $this->get('type') == 'matrix') {
$this->data['users'][$user] &= ~$permission;
if (empty($this->data['users'][$user])) {
unset($this->data['users'][$user]);
}
} else {
unset($this->data['users'][$user]);
}
}
if ($update) {
$this->save();
}
}
/**
* Removes a permission that guests currently have on this object.
*
* @param integer $permission The permission (DELETE, etc.) to
* remove. Defaults to all permissions.
* @param boolean $update Whether to automatically update the
* backend.
*/
public function removeGuestPermission($permission = null, $update = true)
{
if (!isset($this->data['guest'])) {
return;
}
if ($permission && $this->get('type') == 'matrix') {
$this->data['guest'] &= ~$permission;
} else {
unset($this->data['guest']);
}
if ($update) {
$this->save();
}
}
/**
* Removes a permission that creators currently have on this object.
*
* @param integer $permission The permission (DELETE, etc.) to
* remove. Defaults to all permissions.
* @param boolean $update Whether to automatically update the
* backend.
*/
public function removeCreatorPermission($permission = null, $update = true)
{
if (!isset($this->data['creator'])) {
return;
}
if ($permission && $this->get('type') == 'matrix') {
$this->data['creator'] &= ~$permission;
} else {
unset($this->data['creator']);
}
if ($update) {
$this->save();
}
}
/**
* Removes a default permission on this object.
*
* @param integer $permission The permission (DELETE, etc.) to
* remove. Defaults to all permissions.
* @param boolean $update Whether to automatically update the
* backend.
*/
public function removeDefaultPermission($permission = null, $update = true)
{
if (!isset($this->data['default'])) {
return;
}
if ($permission && $this->get('type') == 'matrix') {
$this->data['default'] &= ~$permission;
} else {
unset($this->data['default']);
}
if ($update) {
$this->save();
}
}
/**
* Removes a permission that a group currently has on this object.
*
* @param integer $groupId The id of the group to remove the
* permission from. Defaults to all groups.
* @param integer $permission The permission (DELETE, etc.) to
* remove. Defaults to all permissions.
* @param boolean $update Whether to automatically update the
* backend.
*/
public function removeGroupPermission($groupId = null, $permission = null,
$update = true)
{
if (is_null($groupId)) {
$this->data['groups'] = array();
} else {
if (!isset($this->data['groups'][$groupId])) {
return;
}
if ($permission && $this->get('type') == 'matrix') {
$this->data['groups'][$groupId] &= ~$permission;
if (empty($this->data['groups'][$groupId])) {
unset($this->data['groups'][$groupId]);
}
} else {
unset($this->data['groups'][$groupId]);
}
}
if ($update) {
$this->save();
}
}
/**
* Returns an array of all user permissions on this object.
*
* @param integer $perm List only users with this permission level.
* Defaults to all users.
*
* @return array All user permissions for this object, indexed by user.
*/
public function getUserPermissions($perm = null)
{
if (!isset($this->data['users']) || !is_array($this->data['users'])) {
return array();
} elseif (!$perm) {
return $this->data['users'];
}
$users = array();
foreach ($this->data['users'] as $user => $uperm) {
if ($uperm & $perm) {
$users[$user] = $uperm;
}
}
return $users;
}
/**
* Returns the guest permissions on this object.
*
* @return integer The guest permissions on this object.
*/
public function getGuestPermissions()
{
return empty($this->data['guest'])
? null
: $this->data['guest'];
}
/**
* Returns the creator permissions on this object.
*
* @return integer The creator permissions on this object.
*/
public function getCreatorPermissions()
{
return empty($this->data['creator'])
? null
: $this->data['creator'];
}
/**
* Returns the default permissions on this object.
*
* @return integer The default permissions on this object.
*/
public function getDefaultPermissions()
{
return empty($this->data['default'])
? null
: $this->data['default'];
}
/**
* Returns an array of all group permissions on this object.
*
* @param integer $perm List only users with this permission level.
* Defaults to all users.
*
* @return array All group permissions for this object, indexed by group.
*/
public function getGroupPermissions($perm = null)
{
if (!isset($this->data['groups']) ||
!is_array($this->data['groups'])) {
return array();
} elseif (!$perm) {
return $this->data['groups'];
}
$groups = array();
foreach ($this->data['groups'] as $group => $gperm) {
if ($gperm & $perm) {
$groups[$group] = $gperm;
}
}
return $groups;
}
/**
* TODO
*/
public function save()
{
}
}
|