284 lines
8.9 KiB
PHP
284 lines
8.9 KiB
PHP
<?php
|
|
/**
|
|
* Shows a categorized list of available permissions (through {@link Permission::get_codes()}).
|
|
* Permissions which are assigned to a given {@link Group} record
|
|
* (either directly, inherited from parent groups, or through a {@link PermissionRole})
|
|
* will be checked automatically. All checkboxes for "inherited" permissions will be readonly.
|
|
*
|
|
* The field can gets its assignment data either from {@link Group} or {@link PermissionRole} records.
|
|
*
|
|
* @package sapphire
|
|
* @subpackage security
|
|
*/
|
|
class PermissionCheckboxSetField extends FormField {
|
|
|
|
/**
|
|
* @var Array Filter certain permission codes from the output.
|
|
* Useful to simplify the interface
|
|
*/
|
|
protected $hiddenPermissions = array();
|
|
|
|
/**
|
|
* @var SS_List
|
|
*/
|
|
protected $records = null;
|
|
|
|
/**
|
|
* @var array Array Nested array in same notation as {@link CheckboxSetField}.
|
|
*/
|
|
protected $source = null;
|
|
|
|
/**
|
|
* @param String $name
|
|
* @param String $title
|
|
* @param String $managedClass
|
|
* @param String $filterField
|
|
* @param Group|SS_List $records One or more {@link Group} or {@link PermissionRole} records
|
|
* used to determine permission checkboxes.
|
|
* Caution: saveInto() can only be used with a single record, all inherited permissions will be marked readonly.
|
|
* Setting multiple groups only makes sense in a readonly context. (Optional)
|
|
*/
|
|
function __construct($name, $title, $managedClass, $filterField, $records = null) {
|
|
$this->filterField = $filterField;
|
|
$this->managedClass = $managedClass;
|
|
|
|
if($records instanceof SS_List) {
|
|
$this->records = $records;
|
|
} elseif($records instanceof Group) {
|
|
$this->records = new ArrayList(array($records));
|
|
} elseif($records) {
|
|
throw new InvalidArgumentException('$record should be either a Group record, or a SS_List of Group records');
|
|
}
|
|
|
|
// Get all available codes in the system as a categorized nested array
|
|
$this->source = Permission::get_codes(true);
|
|
|
|
parent::__construct($name, $title);
|
|
}
|
|
|
|
/**
|
|
* @param Array $codes
|
|
*/
|
|
function setHiddenPermissions($codes) {
|
|
$this->hiddenPermissions = $codes;
|
|
}
|
|
|
|
/**
|
|
* @return Array
|
|
*/
|
|
function getHiddenPermissions() {
|
|
return $this->hiddenPermissions;
|
|
}
|
|
|
|
function Field() {
|
|
Requirements::css(SAPPHIRE_DIR . '/css/CheckboxSetField.css');
|
|
Requirements::javascript(SAPPHIRE_DIR . '/javascript/PermissionCheckboxSetField.js');
|
|
|
|
$uninheritedCodes = array();
|
|
$inheritedCodes = array();
|
|
$records = ($this->records) ? $this->records : new ArrayList();
|
|
|
|
// Get existing values from the form record (assuming the formfield name is a join field on the record)
|
|
if(is_object($this->form)) {
|
|
$record = $this->form->getRecord();
|
|
if(
|
|
$record
|
|
&& (is_a($record, 'Group') || is_a($record, 'PermissionRole'))
|
|
&& !$records->find('ID', $record->ID)
|
|
) {
|
|
$records->push($record);
|
|
}
|
|
}
|
|
|
|
// Get all 'inherited' codes not directly assigned to the group (which is stored in $values)
|
|
foreach($records as $record) {
|
|
// Get all uninherited permissions
|
|
$relationMethod = $this->name;
|
|
foreach($record->$relationMethod() as $permission) {
|
|
if(!isset($uninheritedCodes[$permission->Code])) $uninheritedCodes[$permission->Code] = array();
|
|
$uninheritedCodes[$permission->Code][] = sprintf(
|
|
_t('PermissionCheckboxSetField.AssignedTo', 'assigned to "%s"'),
|
|
$record->Title
|
|
);
|
|
}
|
|
|
|
// Special case for Group records (not PermissionRole):
|
|
// Determine inherited assignments
|
|
if(is_a($record, 'Group')) {
|
|
// Get all permissions from roles
|
|
if ($record->Roles()->Count()) {
|
|
foreach($record->Roles() as $role) {
|
|
foreach($role->Codes() as $code) {
|
|
if (!isset($inheritedCodes[$code->Code])) $inheritedCodes[$code->Code] = array();
|
|
$inheritedCodes[$code->Code][] = sprintf(
|
|
_t(
|
|
'PermissionCheckboxSetField.FromRole',
|
|
'inherited from role "%s"',
|
|
PR_MEDIUM,
|
|
'A permission inherited from a certain permission role'
|
|
),
|
|
$role->Title
|
|
);
|
|
}
|
|
}
|
|
}
|
|
|
|
// Get from parent groups
|
|
$parentGroups = $record->getAncestors();
|
|
if ($parentGroups) {
|
|
foreach ($parentGroups as $parent) {
|
|
if (!$parent->Roles()->Count()) continue;
|
|
foreach($parent->Roles() as $role) {
|
|
if ($role->Codes()) {
|
|
foreach($role->Codes() as $code) {
|
|
if (!isset($inheritedCodes[$code->Code])) $inheritedCodes[$code->Code] = array();
|
|
$inheritedCodes[$code->Code][] = sprintf(
|
|
_t(
|
|
'PermissionCheckboxSetField.FromRoleOnGroup',
|
|
'inherited from role "%s" on group "%s"',
|
|
PR_MEDIUM,
|
|
'A permission inherited from a role on a certain group'
|
|
),
|
|
$role->Title,
|
|
$parent->Title
|
|
);
|
|
}
|
|
}
|
|
}
|
|
if ($parent->Permissions()->Count()) {
|
|
foreach($parent->Permissions() as $permission) {
|
|
if (!isset($inheritedCodes[$permission->Code])) $inheritedCodes[$permission->Code] = array();
|
|
$inheritedCodes[$permission->Code][] =
|
|
sprintf(
|
|
_t(
|
|
'PermissionCheckboxSetField.FromGroup',
|
|
'inherited from group "%s"',
|
|
PR_MEDIUM,
|
|
'A permission inherited from a certain group'
|
|
),
|
|
$parent->Title
|
|
);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
$odd = 0;
|
|
$options = '';
|
|
if($this->source) {
|
|
// loop through all available categorized permissions and see if they're assigned for the given groups
|
|
foreach($this->source as $categoryName => $permissions) {
|
|
$options .= "<li><h5>$categoryName</h5></li>";
|
|
foreach($permissions as $code => $permission) {
|
|
if(in_array($code, $this->hiddenPermissions)) continue;
|
|
if(in_array($code, Permission::$hidden_permissions)) continue;
|
|
|
|
$value = $permission['name'];
|
|
|
|
$odd = ($odd + 1) % 2;
|
|
$extraClass = $odd ? 'odd' : 'even';
|
|
$extraClass .= ' val' . str_replace(' ', '', $code);
|
|
$itemID = $this->id() . '_' . ereg_replace('[^a-zA-Z0-9]+', '', $code);
|
|
$checked = $disabled = $inheritMessage = '';
|
|
$checked = (isset($uninheritedCodes[$code]) || isset($inheritedCodes[$code])) ? ' checked="checked"' : '';
|
|
$title = $permission['help'] ? 'title="' . htmlentities($permission['help'], ENT_COMPAT, 'UTF-8') . '" ' : '';
|
|
|
|
if (isset($inheritedCodes[$code])) {
|
|
// disable inherited codes, as any saving logic would be too complicate to express in this interface
|
|
$disabled = ' disabled="true"';
|
|
$inheritMessage = ' (' . join(', ', $inheritedCodes[$code]) . ')';
|
|
} elseif($this->records && $this->records->Count() > 1 && isset($uninheritedCodes[$code])) {
|
|
// If code assignments are collected from more than one "source group",
|
|
// show its origin automatically
|
|
$inheritMessage = ' (' . join(', ', $uninheritedCodes[$code]).')';
|
|
}
|
|
|
|
// If the field is readonly, always mark as "disabled"
|
|
if($this->readonly) $disabled = ' disabled="true"';
|
|
|
|
$inheritMessage = '<small>' . $inheritMessage . '</small>';
|
|
$options .= "<li class=\"$extraClass\">" .
|
|
"<input id=\"$itemID\"$disabled name=\"$this->name[$code]\" type=\"checkbox\" value=\"$code\"$checked class=\"checkbox\" />" .
|
|
"<label {$title}for=\"$itemID\">$value$inheritMessage</label>" .
|
|
"</li>\n";
|
|
}
|
|
}
|
|
}
|
|
|
|
return "<ul id=\"{$this->id()}\" class=\"optionset checkboxsetfield{$this->extraClass()}\">\n$options</ul>\n";
|
|
}
|
|
|
|
/**
|
|
* Update the permission set associated with $record DataObject
|
|
*
|
|
* @param DataObject $record
|
|
*/
|
|
function saveInto(DataObject $record) {
|
|
$fieldname = $this->name;
|
|
$managedClass = $this->managedClass;
|
|
|
|
// remove all permissions and re-add them afterwards
|
|
$permissions = $record->$fieldname();
|
|
foreach ( $permissions as $permission ) {
|
|
$permission->delete();
|
|
}
|
|
|
|
if($fieldname && $record && ($record->has_many($fieldname) || $record->many_many($fieldname))) {
|
|
$idList = array();
|
|
if($this->value) foreach($this->value as $id => $bool) {
|
|
if($bool) {
|
|
$perm = new $managedClass();
|
|
$perm->{$this->filterField} = $record->ID;
|
|
$perm->Code = $id;
|
|
$perm->write();
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @return PermissionCheckboxSetField_Readonly
|
|
*/
|
|
function performReadonlyTransformation() {
|
|
$readonly = new PermissionCheckboxSetField_Readonly(
|
|
$this->name,
|
|
$this->title,
|
|
$this->managedClass,
|
|
$this->filterField,
|
|
$this->records
|
|
);
|
|
|
|
return $readonly;
|
|
}
|
|
|
|
/**
|
|
* Retrieves all permission codes for the currently set records
|
|
*
|
|
* @return array
|
|
*/
|
|
function getAssignedPermissionCodes() {
|
|
if(!$this->records) return false;
|
|
|
|
// TODO
|
|
|
|
return $codes;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Readonly version of a {@link PermissionCheckboxSetField} -
|
|
* uses the same structure, but has all checkboxes disabled.
|
|
*
|
|
* @package sapphire
|
|
* @subpackage security
|
|
*/
|
|
class PermissionCheckboxSetField_Readonly extends PermissionCheckboxSetField {
|
|
|
|
protected $readonly = true;
|
|
|
|
function saveInto($record) {
|
|
return false;
|
|
}
|
|
} |