extern/egroupware_official
1
0
Fork 0
mirror of https://github.com/EGroupware/egroupware.git synced 2024-11-28 10:53:39 +01:00
Code Issues Packages Projects Releases Wiki Activity
87b2725a87
egroupware_official/api/src/Acl.php

806 lines
23 KiB
PHP
Raw Blame History

<?php
/**
* EGroupware API - ACL
*
* @link http://www.egroupware.org
* @author Dan Kuykendall <seek3r@phpgroupware.org>
* Copyright (C) 2000, 2001 Dan Kuykendall
* @license http://opensource.org/licenses/lgpl-license.php LGPL - GNU Lesser General Public License
* @package api
* @subpackage acl
* @version $Id$
*/
namespace EGroupware\Api;
/**
* Access Control List System
*
* This class provides an ACL security scheme.
* This can manage rights to 'run' applications, and limit certain features within an application.
* It is also used for granting a user "membership" to a group, or making a user have the security equivilance of another user.
* It is also used for granting a user or group rights to various records, such as todo or calendar items of another user.
*
* $acl = new acl(5); // 5 is the user id
*/
class Acl
{
/**
* @var int $account_id the account-id this class is instanciated for
*/
var $account_id = 0;
/**
* @var array $data internal repository with acl rows for the given app and account-id (incl. memberships)
*/
var $data = Array();
/**
* internal reference to global db-object
*
* @var Db
*/
var $db;
/**
* @var string $table_name name of the acl_table
*/
const TABLE = 'egw_acl';
/**
* Cache for grants
* @var array
*/
var $cache = array();
/**
* Constants for acl rights, like old EGW_ACL_* defines
*/
const READ = 1; // EGW_ACL_READ
const ADD = 2; // EGW_ACL_ADD
const EDIT = 4; // EGW_ACL_EDIT
const DELETE = 8; // EGW_ACL_DELETE
const PRIVAT = 16; // EGW_ACL_PRIVATE can NOT use PRIVATE as it is a PHP keyword, using German PRIVAT instead!
const GROUPMGRS = 32; // EGW_ACL_GROUP_MANAGERS
const CUSTOM1 = 64; // EGW_ACL_CUSTOM_1
const CUSTOM2 = 128; // EGW_ACL_CUSTOM_2
const CUSTOM3 = 256; // EGW_ACL_CUSTOM_3
/**
* ACL constructor for setting account id
*
* Sets the ID for $acl->account_id. Can be used to change a current instances id as well.
* Some functions are specific to this account, and others are generic.
*
* @example acl->acl(5); // 5 is the user id
* @param int $account_id = null user id or default null to use current user from $GLOBALS['egw_info']['user']['account_id']
*/
function __construct($account_id = null)
{
if (isset($GLOBALS['egw_setup']) && is_object($GLOBALS['egw_setup']->db))
{
$this->db = $GLOBALS['egw_setup']->db;
}
else
{
$this->db = $GLOBALS['egw']->db;
}
if ((int)$this->account_id != (int)$account_id)
{
$this->account_id = get_account_id((int)$account_id,@$GLOBALS['egw_info']['user']['account_id']);
}
$this->data = array();
}
/**
* Magic method called before object get serialized
*
* We only store account_id class is constructed for (not data, which can be huge!) and
* get_rights calls read_repository automatic, if data is empty.
*/
function __sleep()
{
return array('account_id','db');
}
/**************************************************************************\
* These are the standard $this->account_id specific functions *
\**************************************************************************/
/**
* Read acl records for $acl->account_id from reposity
*
* @param boolean|array $no_groups = false if true, do not use memberships, if array do not use given groups
* @return array along with storing it in $acl->data. <br>
*/
function read_repository($no_groups=false)
{
// For some reason, calling this via XML-RPC doesn't call the constructor.
// Here is yet another work around(tm) (jengo)
if (!$this->account_id)
{
$this->__construct();
}
if ($no_groups === true || !(int)$this->account_id)
{
$acl_acc_list = $this->account_id;
}
else
{
$acl_acc_list = (array)$GLOBALS['egw']->accounts->memberships($this->account_id, true);
if (is_array($no_groups)) $acl_acc_list = array_diff($acl_acc_list,$no_groups);
array_unshift($acl_acc_list,$this->account_id);
}
$this->data = Array();
foreach($this->db->select(self::TABLE,'*',array('acl_account' => $acl_acc_list ),__LINE__,__FILE__) as $row)
{
$this->data[$row['acl_appname'].'-'.$row['acl_location'].'-'.$row['acl_account']] = Db::strip_array_keys($row,'acl_');
}
return $this->data;
}
/**
* Read acl records from $acl->data
*
* @return array all ACL records from $this->data.
*/
function read()
{
if (!count($this->data))
{
$this->read_repository();
}
return $this->data;
}
/**
* Adds ACL record to the repository of the class
*
* Adds ACL record to $this->data.
*
* @param string $appname default False derives value from $GLOBALS['egw_info']['flags']['currentapp']
* @param string $location location
* @param int $rights rights
* @return array all ACL records from $this->data.
*/
function add($appname,$location,$rights)
{
if (!$appname) $appname = $GLOBALS['egw_info']['flags']['currentapp'];
$row = array(
'appname' => $appname,
'location' => $location,
'account' => (int) $this->account_id,
'rights' => (int) $rights
);
$this->data[$row['appname'].'-'.$row['location'].'-'.$row['account']] = $row;
return $this->data;
}
/**
* Delete ACL record in the repository of the class
*
* @param string $appname appname or '' for $GLOBALS['egw_info']['flags']['currentapp']
* @param string|boolean $location location or false for all locations
* @return array all ACL records from $this->data.
*/
function delete($appname,$location)
{
if (!$appname) $appname = $GLOBALS['egw_info']['flags']['currentapp'];
foreach($this->data as $idx => $value)
{
if ($value['appname'] == $appname &&
($location === false || $value['location'] == $location) &&
$value['account'] == $this->account_id)
{
unset($this->data[$idx]);
}
}
return $this->data;
}
/**
* save the internal repository or the class
*
* @return array all ACL records from $this->data.
*/
function save_repository()
{
$this->db->delete(self::TABLE,array(
'acl_account' => $this->account_id,
),__LINE__,__FILE__);
foreach($this->data as $value)
{
if ($value['account'] == $this->account_id)
{
$this->db->insert(self::TABLE,array(
'acl_appname' => $value['appname'],
'acl_location' => $value['location'],
'acl_account' => $this->account_id,
'acl_rights' => $value['rights'],
),false,__LINE__,__FILE__);
}
}
if ($this->account_id == $GLOBALS['egw_info']['user']['account_id'] &&
method_exists($GLOBALS['egw'],'invalidate_session_cache')) // egw object in setup is limited
{
$GLOBALS['egw']->invalidate_session_cache();
}
return $this->data;
}
/**************************************************************************\
* These are the non-standard $this->account_id specific functions *
\**************************************************************************/
/**
* get rights from the class repository (included rights of $this->account_id and all it's memberships)
*
* @param string $location app location to get rights from
* @param string $appname optional defaults to $GLOBALS['egw_info']['flags']['currentapp'];
* @return int all rights or'ed together
*/
function get_rights($location,$appname = '')
{
// For XML-RPC, change this once its working correctly for passing parameters (jengo)
if (is_array($location))
{
$appname = $location['appname'];
$location = $location['location'];
}
if (!count($this->data))
{
$this->read_repository();
}
if (!$appname) $appname = $GLOBALS['egw_info']['flags']['currentapp'];
if (!count($this->data) && $GLOBALS['egw_info']['server']['acl_default'] != 'deny')
{
return True;
}
$rights = 0;
foreach($this->data as $value)
{
if ($value['appname'] == $appname)
{
if ($value['location'] == $location || $value['location'] == 'everywhere')
{
if ($value['rights'] == 0)
{
return False;
}
$rights |= $value['rights'];
}
}
}
return $rights;
}
/**
* check required rights agains the internal repository (included rights of $this->account_id and all it's memberships)
*
* @param string $location app location
* @param int $required required right to check against
* @param string|false $appname optional defaults to currentapp
* @return boolean
*/
function check($location, $required, $appname = False)
{
$rights = $this->get_rights($location,$appname);
return !!($rights & $required);
}
/**
* get specific rights for this->account_id for an app location
*
* @param string $location app location
* @param string $appname = '' optional defaults to currentapp
* @param array $memberships = array() additional account_id, eg. memberships to match beside $this->account_id, default none
* @return int $rights
*/
function get_specific_rights($location, $appname = '', $memberships=array())
{
if (!$appname) $appname = $GLOBALS['egw_info']['flags']['currentapp'];
if (!count($this->data) && $GLOBALS['egw_info']['server']['acl_default'] != 'deny')
{
return True;
}
$rights = 0;
foreach($this->data as $value)
{
if ($value['appname'] == $appname &&
($value['location'] == $location || $value['location'] == 'everywhere') &&
($value['account'] == $this->account_id || $memberships && in_array($value['account'], $memberships)))
{
if ($value['rights'] == 0)
{
return False;
}
$rights |= $value['rights'];
}
}
return $rights;
}
/**
* check specific rights
*
* @param string $location app location
* @param int $required required rights
* @param string $appname optional defaults to currentapp
* @return boolean
*/
function check_specific($location, $required, $appname = '')
{
$rights = $this->get_specific_rights($location,$appname);
return !!($rights & $required);
}
/**************************************************************************\
* These are the generic functions. Not specific to $this->account_id *
\**************************************************************************/
/**
* add repository information / rights for app/location/account_id to the database
*
* @param string $app appname
* @param string $location location
* @param int $account_id account id
* @param int $rights rights
* @param boolean $invalidate_session =true false: do NOT invalidate session
* @return int number of affected rows: 0: no change, 1: acl changed
*/
function add_repository($app, $location, $account_id, $rights, $invalidate_session=true)
{
//echo "<p>self::add_repository('$app','$location',$account_id,$rights);</p>\n";
$this->db->insert(self::TABLE,array(
'acl_rights' => $rights,
),array(
'acl_appname' => $app,
'acl_location' => $location,
'acl_account' => $account_id,
),__LINE__,__FILE__);
if ($invalidate_session && $account_id == $GLOBALS['egw_info']['user']['account_id'] &&
method_exists($GLOBALS['egw'],'invalidate_session_cache')) // egw object in setup is limited
{
$GLOBALS['egw']->invalidate_session_cache();
}
return $this->db->affected_rows();
}
/**
* delete repository information / rights for app/location[/account_id] from the DB
*
* @param string $app appname
* @param string $location location
* @param int|boolean $accountid = '' account id, default 0=$this->account_id, or false to delete all entries for $app/$location
* @param boolean $invalidate_session =true false: do NOT invalidate session
* @return int number of rows deleted
*/
function delete_repository($app, $location, $accountid='', $invalidate_session=true)
{
static $cache_accountid = array();
$where = array(
'acl_appname' => $app,
'acl_location' => $location,
);
if ($accountid !== false)
{
if(isset($cache_accountid[$accountid]) && $cache_accountid[$accountid])
{
$where['acl_account'] = $cache_accountid[$accountid];
}
else
{
$where['acl_account'] = $cache_accountid[$accountid] = get_account_id($accountid,$this->account_id);
}
}
if ($app == '%' || $app == '%%') unset($where['acl_appname']);
$this->db->delete(self::TABLE,$where,__LINE__,__FILE__);
$deleted = $this->db->affected_rows();
if ($invalidate_session && $deleted && method_exists($GLOBALS['egw'],'invalidate_session_cache')) // egw object in setup is limited
{
$GLOBALS['egw']->invalidate_session_cache();
}
return $deleted;
}
/**
* Get rights for a given account, location and application
*
* @param int $account_id
* @param string $location
* @param string $appname = '' defaults to current app
* @return int/boolean rights or false if none exist
*/
function get_specific_rights_for_account($account_id,$location,$appname='')
{
if (!$appname) $appname = $GLOBALS['egw_info']['flags']['currentapp'];
return $this->db->select(self::TABLE,'acl_rights',array(
'acl_location' => $location,
'acl_account' => $account_id,
'acl_appname' => $appname,
),__LINE__,__FILE__)->fetchColumn();
}
/**
* Get all rights for a given location and application
*
* @param string $location
* @param string $appname = '' defaults to current app
* @return array with account => rights pairs
*/
function get_all_rights($location,$appname='')
{
if (!$appname) $appname = $GLOBALS['egw_info']['flags']['currentapp'];
$rights = array();
foreach($this->db->select(self::TABLE,'acl_account,acl_rights',array(
'acl_location' => $location,
'acl_appname' => $appname,
),__LINE__,__FILE__) as $row)
{
$rights[$row['acl_account']] = $row['acl_rights'];
}
return $rights;
}
/**
* Get the rights for all locations
*
* @param int $account_id
* @param string $appname = '' defaults to current app
* @param boolean $use_memberships = true
* @return array with location => rights pairs
*/
function get_all_location_rights($account_id,$appname='',$use_memberships=true)
{
if (!$appname) $appname = $GLOBALS['egw_info']['flags']['currentapp'];
$accounts = array($account_id);
if ($use_memberships && (int)$account_id > 0)
{
$accounts = $GLOBALS['egw']->accounts->memberships($account_id, true);
$accounts[] = $account_id;
}
$rights = array();
foreach($this->db->select(self::TABLE,'acl_location,acl_rights',array(
'acl_account' => $accounts,
'acl_appname' => $appname,
),__LINE__,__FILE__) as $row)
{
if (!isset($rights[$row['acl_location']]))
{
$rights[$row['acl_location']] = 0;
}
$rights[$row['acl_location']] |= $row['acl_rights'];
}
return $rights;
}
/**
* get application list for an account id
*
* @param string $location location
* @param int $required required rights
* @param int $accountid account id defaults to $GLOBALS['egw_info']['user']['account_id'];
* @return array with app-names ([] if there are none)
*/
function get_app_list_for_id($location, $required, $accountid = '')
{
static $cache_accountid = array();
if(isset($cache_accountid[$accountid]))
{
$account_id = $cache_accountid[$accountid];
}
else
{
$account_id = get_account_id($accountid,$this->account_id);
$cache_accountid[$accountid] = $account_id;
}
$rights = 0;
$apps = [];
foreach($this->db->select(self::TABLE,array('acl_appname','acl_rights'),array(
'acl_location' => $location,
'acl_account' => $account_id,
),__LINE__,__FILE__) as $row)
{
if ($row['acl_rights'] == 0)
{
return False;
}
$rights |= $row['acl_rights'];
if (!!($rights & $required))
{
$apps[] = $row['acl_appname'];
}
}
return $apps;
}
/**
* get location list for id
*
* @param string $app app
* @param int $required required rights
* @param int $accountid optional defaults to $GLOBALS['egw_info']['user']['account_id'];
* @return array with location-strings ([] if there are none)
*/
function get_location_list_for_id($app, $required, $accountid = '')
{
static $cache_accountid = array();
if(isset($cache_accountid[$accountid]))
{
$accountid = $cache_accountid[$accountid];
}
else
{
$accountid = $cache_accountid[$accountid] = get_account_id($accountid,$this->account_id);
}
$locations = [];
foreach($this->db->select(self::TABLE,'acl_location,acl_rights',array(
'acl_appname' => $app,
'acl_account' => $accountid,
),__LINE__,__FILE__) as $row)
{
if ($row['acl_rights'] & $required)
{
$locations[] = $row['acl_location'];
}
}
return $locations;
}
/**
* get ids for location
*
* @param string $location location
* @param int $required required rights
* @param string $app app optional defaults to $GLOBALS['egw_info']['flags']['currentapp'];
* @return array of account-ids ([] if there are none in the db)
*/
function get_ids_for_location($location, $required, $app = '')
{
if (!$app) $app = $GLOBALS['egw_info']['flags']['currentapp'];
$accounts = [];
foreach($this->db->select(self::TABLE,array('acl_account','acl_rights'),array(
'acl_appname' => $app,
'acl_location' => $location,
),__LINE__,__FILE__) as $row)
{
if (!!($row['acl_rights'] & $required))
{
$accounts[] = (int) $row['acl_account'];
}
}
return $accounts;
}
/**
* get the locations for an app (excluding the run location !!!)
*
* @param string $app app optional defaults to $GLOBALS['egw_info']['flags']['currentapp'];
* @return array of locations ([] if there are none)
*/
function get_locations_for_app($app='')
{
if (!$app) $app = $GLOBALS['egw_info']['flags']['currentapp'];
$locations = [];
foreach($this->db->select(self::TABLE,'DISTINCT '.'acl_location',array(
'acl_appname' => $app,
),__LINE__,__FILE__) as $row)
{
if (($location = $row['acl_location']) != 'run')
{
$locations[] = $location;
}
}
return $locations;
}
/**
* get a list of applications a user has rights to
*
* @param int $accountid = '' optional defaults to $GLOBALS['egw_info']['user']['account_id'];
* @param boolean $use_memberships = true true: use memberships too, false: only use given account
* @param boolean $add_implicit_apps = true true: add apps every user has implicit rights
* @return array containing list of apps
*/
function get_user_applications($accountid = '', $use_memberships=true, $add_implicit_apps=true)
{
static $cache_accountid = array();
if(isset($cache_accountid[$accountid]))
{
$account_id = $cache_accountid[$accountid];
}
else
{
$account_id = get_account_id($accountid,$this->account_id);
$cache_accountid[$accountid] = $account_id;
}
if ($use_memberships && (int)$account_id > 0) $memberships = $GLOBALS['egw']->accounts->memberships($account_id, true);
$memberships[] = (int)$account_id;
$apps = array();
foreach($this->db->select(self::TABLE,array('acl_appname','acl_rights'),array(
'acl_location' => 'run',
'acl_account' => $memberships,
),__LINE__,__FILE__) as $row)
{
$app = $row['acl_appname'];
if(!isset($apps[$app]))
{
$apps[$app] = 0;
}
$apps[$app] |= (int) $row['acl_rights'];
}
if ($add_implicit_apps)
{
$apps['api'] = 1; // give everyone implicit rights for the home app
}
return $apps;
}
/**
* Read the grants other users gave $this->account_id for $app, group ACL is taken into account
*
* @param string $app optional defaults to $GLOBALS['egw_info']['flags']['currentapp']
* @param boolean|array $enum_group_acls = true should group acls be returned for all members of that group, default yes
* if an array of group-id's is given, that id's will NOT be enumerated!
* @param int $user = null user whos grants to return, default current user
* @return array with account-ids (of owners) and granted rights as values
*/
function get_grants($app='',$enum_group_acls=true,$user=null)
{
if (!$app) $app = $GLOBALS['egw_info']['flags']['currentapp'];
if (!$user) $user = $this->account_id;
$cache = $this->cache; // some caching within the request
$grants =& $cache[$app][$user];
if (!isset($grants))
{
if ((int)$user > 0) $memberships = $GLOBALS['egw']->accounts->memberships($user, true);
$memberships[] = $user;
$grants = $accounts = Array();
foreach($this->db->select(self::TABLE,array('acl_account','acl_rights','acl_location'),array(
'acl_appname' => $app,
'acl_location' => $memberships,
),__LINE__,__FILE__) as $row)
{
$grantor = $row['acl_account'];
$rights = $row['acl_rights'];
if(!isset($grants[$grantor]))
{
$grants[$grantor] = 0;
}
$grants[$grantor] |= $rights;
// if the right is granted from a group and we enummerated group ACL's
if ($GLOBALS['egw']->accounts->get_type($grantor) == 'g' && $enum_group_acls &&
(!is_array($enum_group_acls) || !in_array($grantor,$enum_group_acls)))
{
// return the grant for each member of the group (false = also for no longer active users)
foreach((array)$GLOBALS['egw']->accounts->members($grantor, true, false) as $grantor)
{
if (!$grantor) continue; // can happen if group has no members
// Don't allow to override private with group ACL's!
$rights &= ~self::PRIVAT;
if(!isset($grants[$grantor]))
{
$grants[$grantor] = 0;
}
$grants[$grantor] |= $rights;
}
}
}
// user has implizit all rights on own data
$grants[$user] = ~0;
}
//echo "self::get_grants('$app',$enum_group_acls) ".function_backtrace(); _debug_array($grants);
return $grants;
}
/**
* Get grants for a single app
*
* We use a "get-grants" hook, in case an app need more then what Acl::get_grants returns (with default parameters!).
*
* @param string $_app app-name
* @return array
*/
function ajax_get_grants($_app=null)
{
if (!($grants = Hooks::single('get-grants', $_app)))
{
$grants = $this->get_grants($_app);
}
return $grants;
}
/**
* Get grants for all apps
*
* @return array with app => array of grants pairs
*/
function ajax_get_all_grants()
{
$app_grants = [];
foreach(array_keys($GLOBALS['egw_info']['user']['apps']) as $app)
{
$app_grants[$app] = $this->get_grants($app);
}
return $app_grants;
}
/**
* Deletes all ACL entries for an account (user or group)
*
* @param int $account_id acount-id
*/
function delete_account($account_id)
{
if ((int) $account_id)
{
// Delete all grants from this account
$this->db->delete(self::TABLE,array(
'acl_account' => $account_id
),__LINE__,__FILE__);
// Delete all grants to this account
$this->db->delete(self::TABLE,array(
'acl_location' => $account_id
),__LINE__, __FILE__);
// delete all memberships in account_id (if it is a group)
$this->db->delete(self::TABLE,array(
'acl_appname' => 'phpgw_group',
'acl_location' => $account_id,
),__LINE__,__FILE__);
}
}
/**
* get the locations for an app (excluding the run location !!!)
*
* @param string $location location, can contain wildcards % or ?
* @param string $app app optional defaults to $GLOBALS['egw_info']['flags']['currentapp'];
* @return array with location => array(account => rights) pairs
*/
function get_location_grants($location,$app='')
{
if (!$app) $app = $GLOBALS['egw_info']['flags']['currentapp'];
$locations = array();
foreach($this->db->select(self::TABLE,'acl_location,acl_account,acl_rights',array(
'acl_appname' => $app,
'acl_location LIKE '.$this->db->quote($location),
),__LINE__,__FILE__) as $row)
{
if (($location = $row['acl_location']) != 'run')
{
$locations[$location][$row['acl_account']] = $row['acl_rights'];
}
}
return $locations;
}
}
Reference in New Issue View Git Blame Copy Permalink