"Varchar", "Arg" => "Int", "Type" => "Int(1)" ); static $has_one = array( "Group" => "Group" ); static $indexes = array( "Code" => true ); static $defaults = array( "Type" => 1 ); /** * This is the value to use for the "Type" field if a permission should be * granted. */ const GRANT_PERMISSION = 1; /** * This is the value to use for the "Type" field if a permission should be * denied. */ const DENY_PERMISSION = -1; /** * This is the value to use for the "Type" field if a permission should be * inherited. */ const INHERIT_PERMISSION = 0; /** * Method to globally disable "strict" checking, which means a permission * will be granted if the key does not exist at all. * * @var bool */ static $declared_permissions = null; /** * Linear list of declared permissions in the system. * * @var array */ protected static $declared_permissions_list = null; /** * @var $strict_checking Boolean Method to globally disable "strict" checking, * which means a permission will be granted if the key does not exist at all. */ static $strict_checking = true; /** * If this setting is set, then permissions can imply other permissions * * @var bool */ static $implied_permissions = false; /** * Set to false to prevent the 'ADMIN' permission from implying all * permissions in the system * * @var bool */ static $admin_implies_all = true; /** * Check that the current member has the given permission * * @param string $code Code of the permission to check * @param string $arg Optional argument (e.g. a permissions for a specific * page) * @param int|Member $member Optional member instance or ID. If set to NULL, the permssion * will be checked for the current user * @param bool $strict Use "strict" checking (which means a permission * will be granted if the key does not exist at all)? * @return int|bool The ID of the permission record if the permission * exists; FALSE otherwise. If "strict" checking is * disabled, TRUE will be returned if the permission does * not exist at all. */ public static function check($code, $arg = "any", $member = null, $strict = true) { if(!$member) { if(!Member::currentUser()) { return false; } $member = Member::currentUser(); } return self::checkMember($member, $code, $arg, $strict); } /** * Check that the given member has the given permission * @param int|Member memberID The ID of the member to check. Leave blank for the current member. * Alternatively you can use a member object. * @param string|array $code Code of the permission to check * @param string $arg Optional argument (e.g. a permissions for a specific * page) * @param bool $strict Use "strict" checking (which means a permission * will be granted if the key does not exist at all)? * @return int|bool The ID of the permission record if the permission * exists; FALSE otherwise. If "strict" checking is * disabled, TRUE will be returned if the permission does * not exist at all. */ public static function checkMember($member, $code, $arg = "any", $strict = true) { $perms_list = self::get_declared_permissions_list(); $memberID = (is_object($member)) ? $member->ID : $member; if(self::$declared_permissions && is_array($perms_list) && !in_array($code, $perms_list)) { //user_error("Permission '$code' has not been declared. Use " . // "Permission::declare_permissions() to add this permission", // E_USER_WARNING); } $groupList = self::groupList($memberID); if($groupList) { $groupCSV = implode(", ", $groupList); // Arg component switch($arg) { case "any": $argClause = ""; break; case "all": $argClause = " AND Arg = -1"; break; default: if(is_numeric($arg)) { $argClause = "AND Arg IN (-1, $arg) "; } else { user_error("Permission::checkMember: bad arg '$arg'", E_USER_ERROR); } } if(is_array($code)) $SQL_codeList = "'" . implode("', '", Convert::raw2sql($code)) . "'"; else $SQL_codeList = "'" . Convert::raw2sql($code) . "'"; $SQL_code = Convert::raw2sql($code); $adminFilter = (self::$admin_implies_all) ? ",'ADMIN'" : ''; // Raw SQL for efficiency $permission = DB::query(" SELECT ID FROM Permission WHERE ( Code IN ($SQL_codeList $adminFilter) AND Type = " . self::GRANT_PERMISSION . " AND GroupID IN ($groupCSV) $argClause ) ")->value(); if($permission) return $permission; // Strict checking disabled? if(!self::$strict_checking || !$strict) { $hasPermission = DB::query(" SELECT COUNT(*) FROM Permission WHERE ( (Code IN '$SQL_code')' AND (Type = " . self::GRANT_PERMISSION . ") ) ")->value(); if(!$hasPermission) { return true; } } return false; } } /** * Get the list of groups that the given member belongs to. * * Call without an argument to get the groups that the current member * belongs to. In this case, the results will be session-cached. * * @param int $memberID The ID of the member. Leave blank for the current * member. * @return array Returns a list of group IDs to which the member belongs * to or NULL. */ public static function groupList($memberID = null) { // Default to current member, with session-caching if(!$memberID) { $member = Member::currentUser(); if($member && isset($_SESSION['Permission_groupList'][$member->ID])) return $_SESSION['Permission_groupList'][$member->ID]; } else { $member = DataObject::get_by_id("Member", $memberID); } if($member) { // Build a list of the IDs of the groups. Most of the heavy lifting // is done by Member::Groups // NOTE: This isn't effecient; but it's called once per session so // it's a low priority to fix. $groups = $member->Groups(); $groupList = array(); if($groups) { foreach($groups as $group) $groupList[] = $group->ID; } // Session caching if(!$memberID) { $_SESSION['Permission_groupList'][$member->ID] = $groupList; } return isset($groupList) ? $groupList : null; } } /** * Grant the given permission code/arg to the given group * * @param int $groupID The ID of the group * @param string $code The permission code * @param string Optional: The permission argument (e.g. a page ID). * @returns Permission Returns the new permission object. */ public static function grant($groupID, $code, $arg = "any") { $perm = new Permission(); $perm->GroupID = $groupID; $perm->Code = $code; $perm->Type = self::GRANT_PERMISSION; // Arg component switch($arg) { case "any": break; case "all": $perm->Arg = -1; default: if(is_numeric($arg)) { $perm->Arg = $arg; } else { use_error("Permission::checkMember: bad arg '$arg'", E_USER_ERROR); } } $perm->write(); return $perm; } /** * Deny the given permission code/arg to the given group * * @param int $groupID The ID of the group * @param string $code The permission code * @param string Optional: The permission argument (e.g. a page ID). * @returns Permission Returns the new permission object. */ public static function deny($groupID, $code, $arg = "any") { $perm = new Permission(); $perm->GroupID = $groupID; $perm->Code = $code; $perm->Type = self::DENY_PERMISSION; // Arg component switch($arg) { case "any": break; case "all": $perm->Arg = -1; default: if(is_numeric($arg)) { $perm->Arg = $arg; } else { use_error("Permission::checkMember: bad arg '$arg'", E_USER_ERROR); } } $perm->write(); return $perm; } /** * Add default records to database. * * This function is called whenever the database is built, after the * database tables have all been created. */ public function requireDefaultRecords() { parent::requireDefaultRecords(); // Add default content if blank if(!DB::query("SELECT ID FROM Permission")->value() && array_key_exists('CanCMSAdmin', DB::fieldList('Group'))) { $admins = DB::query("SELECT ID FROM \"Group\" WHERE CanCMSAdmin = 1") ->column(); if(isset($admins)) { foreach($admins as $admin) Permission::grant($admin, "ADMIN"); } $authors = DB::query("SELECT ID FROM \"Group\" WHERE CanCMS = 1") ->column(); if(isset($authors)) { foreach($authors as $author) { Permission::grant($author, "CMS_ACCESS_CMSMain"); Permission::grant($author, "CMS_ACCESS_AssetAdmin"); Permission::grant($author, "CMS_ACCESS_NewsletterAdmin"); Permission::grant($author, "CMS_ACCESS_ReportAdmin"); } } } } /** * Returns all members for a specific permission. * * @param $code String|array Either a single permission code, or a list of permission codes * @return DataObjectSet Returns a set of member that have the specified * permission. */ public static function get_members_by_permission($code) { $groupIDs = array(); $SQL_codeList = (is_array($code)) ? implode("','", Convert::raw2sql($code)) : Convert::raw2sql($code); $SQL_filter = "Permission.Code IN ('" . $SQL_codeList . "') " . "AND Permission.Type = " . self::GRANT_PERMISSION; $toplevelGroups = DataObject::get( 'Group', $SQL_filter, // filter null, // limit "LEFT JOIN \"Permission\" ON \"Group\".\"ID\" = \"Permission\".\"GroupID\"" ); if(!$toplevelGroups) return false; foreach($toplevelGroups as $group) { $familyIDs = $group->collateFamilyIDs(); if(is_array($familyIDs)) { $groupIDs = array_merge($groupIDs, array_values($familyIDs)); } } if(!count($groupIDs)) return false; $members = DataObject::get( Object::getCustomClass('Member'), $_filter = "\"Group\".ID IN (" . implode(",",$groupIDs) . ")", $_sort = "", $_join = "LEFT JOIN \"Group_Members\" ON \"Member\".\"ID\" = \"Group_Members\".\"MemberID\" " . "LEFT JOIN \"Group\" ON \"Group_Members\".\"GroupID\" = \"Group\".\"ID\" " ); return $members; } /** * Return all of the groups that have one of the given permission codes * @param $codes array|string Either a single permission code, or an array of permission codes * @return DataObjectSet The matching group objects */ static function get_groups_by_permission($codes) { if(!is_array($codes)) $codes = array($codes); $SQLa_codes = Convert::raw2sql($codes); $SQL_codes = join("','", $SQLa_codes); return DataObject::get( 'Group', "Permission.Code IN ('$SQL_codes')", "", "LEFT JOIN Permission ON Group.ID = Permission.GroupID" ); } /** * Get a list of all available permission codes * * @param bool|string $blankItemText Text for permission with the empty * code (""). If set to TRUE it will be * set to "(select)"; if set to NULL or * FALSE the empty permission is not * included in the list. * @return array Returns an array of all available permission codes. The * array indicies are the permission codes as used in * {@link Permission::check()}. The value is a description * suitable for using in an interface. */ public static function get_codes($blankItemText = null) { $classes = ClassInfo::implementorsOf('PermissionProvider'); $allCodes = array(); if($blankItemText){ $allCodes[''] = ($blankItemText === true) ? '(select)' : $blankItemText; } $allCodes['ADMIN'] = _t('Permission.FULLADMINRIGHTS', 'Full administrative rights'); if($classes) foreach($classes as $class) { $SNG = singleton($class); if($SNG instanceof TestOnly) continue; $someCodes = $SNG->providePermissions(); if($someCodes) foreach($someCodes as $k => $v) { $allCodes[$k] = $v; } } $otherPerms = DB::query("SELECT DISTINCT Code From Permission") ->column(); if($otherPerms) foreach($otherPerms as $otherPerm) { if(!array_key_exists($otherPerm, $allCodes)) $allCodes[$otherPerm] = $otherPerm; } asort($allCodes); return $allCodes; } /* * Controller action to list the codes available * * @see Permission::get_codes() */ public function listcodes() { if(!Permission::check('ADMIN')) Security::permissionFailure(); echo '
";
print_r($codes);
}
/**
* Declare an array of permissions for the system.
*
* Permissions can be grouped by nesting arrays. Scalar values are always
* treated as permissions.
*
* @param array $permArray A (possibly nested) array of permissions to
* declare for the system.
*/
static function declare_permissions($permArray) {
if(is_array(self::$declared_permissions)) {
self::$declared_permissions =
array_merge_recursive(self::$declared_permissions, $permArray);
}
else {
self::$declared_permissions = $permArray;
}
}
/**
* Get a linear list of the permissions in the system.
*
* @return array Linear list of declared permissions in the system.
*/
public static function get_declared_permissions_list() {
if(!self::$declared_permissions)
return null;
if(self::$declared_permissions_list)
return self::$declared_permissions_list;
self::$declared_permissions_list = array();
self::traverse_declared_permissions(self::$declared_permissions,
self::$declared_permissions_list);
return self::$declared_permissions_list;
}
/**
* Look up the human-readable title for the permission as defined by Permission::declare_permissions
*
* @param $perm Permission code
* @return Label for the given permission, or the permission itself if the label doesn't exist
*/
public static function get_label_for_permission($perm) {
$list = self::get_declared_permissions_list();
if(array_key_exists($perm, $list)) return $list[$perm];
return $perm;
}
/**
* Recursively traverse the nested list of declared permissions and create
* a linear list.
*
* @param aeeay $declared Nested structure of permissions.
* @param $list List of permissions in the structure. The result will be
* written to this array.
*/
protected static function traverse_declared_permissions($declared,
&$list) {
if(!is_array($declared))
return;
foreach($declared as $perm => $value) {
if($value instanceof Permission_Group) {
$list[] = $value->getName();
self::traverse_declared_permissions($value->getPermissions(), $list);
} else {
$list[$perm] = $value;
}
}
}
}
/**
* Permission_Group class
*
* This class is used to group permissions together for showing on an
* interface.
* @package sapphire
* @subpackage security
*/
class Permission_Group {
/**
* Name of the permission group (can be used as label in an interface)
* @var string
*/
protected $name;
/**
* Associative array of permissions in this permission group. The array
* indicies are the permission codes as used in
* {@link Permission::check()}. The value is suitable for using in an
* interface.
* @var string
*/
protected $permissions = array();
/**
* Constructor
*
* @param string $name Text that could be used as label used in an
* interface
* @param array $permissions Associative array of permissions in this
* permission group. The array indicies are the
* permission codes as used in
* {@link Permission::check()}. The value is
* suitable for using in an interface.
*/
public function __construct($name, $permissions) {
$this->name = $name;
$this->permissions = $permissions;
}
/**
* Get the name of the permission group
*
* @return string Name (label) of the permission group
*/
public function getName() {
return $this->name;
}
/**
* Get permissions
*
* @return array Associative array of permissions in this permission
* group. The array indicies are the permission codes as
* used in {@link Permission::check()}. The value is
* suitable for using in an interface.
*/
public function getPermissions() {
return $this->permissions;
}
}
?>