OpenEcoLab-LasAlpujarras/farmOS
3
0
Fork 0
mirror of https://github.com/farmOS/farmOS.git synced 2024-02-23 11:37:38 +01:00
Code Wiki Activity

Add a helper function for generating entity bundle permissions lists for high-level access rules, and use it for assets, plans, and logs.

Browse source
This commit is contained in:
Michael Stenta 2018-12-20 13:48:59 -05:00
parent e9f399d178
commit bb34395d3e
2 changed files with 76 additions and 84 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

93
modules/farm/farm_access/farm_access.farm_access.inc
View file

@ -42,47 +42,10 @@ function farm_access_farm_access_roles() {
* Set up default CRUD permissions for all farm asset entity types.
*/
function farm_asset_farm_access_perms($role) {
$perms = array();
// Load the list of farm roles.
$roles = farm_access_roles();
// Load asset types.
$asset_types = farm_asset_types();
// Grant access to view and edit asset types.
$asset_access_ops = array(
'view' => array('view'),
'edit' => array('create', 'edit', 'delete'),
);
foreach ($asset_access_ops as $access => $ops) {
// If the role has access to these asset operations...
if (!empty($roles[$role]['access'][$access])) {
// Build a list of asset types that they have access to. If 'all' access
// is granted, add all permissions. Or, if specific asset types are
// provided, add them individually.
$access_types['farm_asset'] = array();
if ($roles[$role]['access'][$access] == 'all' || !empty($roles[$role]['access'][$access]['farm_asset']) && $roles[$role]['access'][$access]['farm_asset'] == 'all') {
foreach ($asset_types as $type => $data) {
$access_types['farm_asset'][] = $type;
}
}
elseif (!empty($roles[$role]['access'][$access]['farm_asset'])) {
foreach ($roles[$role]['access'][$access]['farm_asset'] as $asset_type) {
if (!empty($asset_types[$asset_type])) {
$access_types['farm_asset'][] = $asset_type;
}
}
}
// Build a list of entity permissions for the assets and operations and
// merge them into the permissions this function will return.
$asset_perms = farm_access_entity_perms($access_types, $ops);
$perms = array_merge($perms, $asset_perms);
}
}
// Use the helper function to generate a list of entity type bundles
// permissions for the given role.
$perms = farm_access_entity_bundles_role_perms('farm_asset', $role);
// Grant access to view farm assets.
$perms[] = 'view farm assets';
@ -94,29 +57,10 @@ function farm_asset_farm_access_perms($role) {
* Implements hook_farm_access_perms().
*/
function farm_plan_farm_access_perms($role) {
$perms = array();
// Set up default CRUD permissions for all farm plan entity types.
$plan_types = farm_plan_types();
$access_types = array(
'farm_plan' => array(),
);
foreach ($plan_types as $type => $data) {
$access_types['farm_plan'][] = $type;
}
switch ($role) {
// Grant full access to Farm Manager and Worker roles.
case 'farm_manager':
case 'farm_worker':
$perms = farm_access_entity_perms($access_types);
break;
// Grant read-only access to Farm Viewer role.
case 'farm_viewer':
$perms = farm_access_entity_perms($access_types, array('view'));
break;
}
// Use the helper function to generate a list of entity type bundles
// permissions for the given role.
$perms = farm_access_entity_bundles_role_perms('farm_plan', $role);
// Grant access to view farm plans.
$perms[] = 'view farm plans';
@ -128,29 +72,10 @@ function farm_plan_farm_access_perms($role) {
* Implements hook_farm_access_perms().
*/
function log_farm_access_perms($role) {
$perms = array();
// Set up default CRUD permissions for all log entity types.
$log_types = log_types();
$access_types = array(
'log' => array(),
);
foreach ($log_types as $type => $data) {
$access_types['log'][] = $type;
}
switch ($role) {
// Grant full access to Farm Manager and Worker roles.
case 'farm_manager':
case 'farm_worker':
$perms = farm_access_entity_perms($access_types);
break;
// Grant read-only access to Farm Viewer role.
case 'farm_viewer':
$perms = farm_access_entity_perms($access_types, array('view'));
break;
}
// Use the helper function to generate a list of entity type bundles
// permissions for the given role.
$perms = farm_access_entity_bundles_role_perms('log', $role);
// View all logs.
$perms[] = 'view all logs';

67
modules/farm/farm_access/farm_access.module
View file

@ -358,6 +358,73 @@ function farm_access_entity_perms(array $types, $ops = array()) {
return $perms;
}
/**
* Generate permission lists for farm entity bundles for a given role.
*
* This is a helper function to make the task of generating permission lists
* easier. It uses farm_access_entity_perms() above.
*
* @param $entity_type
* The entity type.
* @param $role
* The farm access role that will be receiving the permissions.
*
* @return array
* Returns a list of permissions for the given entity type, bundles, and role.
*/
function farm_access_entity_bundles_role_perms($entity_type, $role) {
$perms = array();
// Get a list of bundles for this entity type.
$bundles = array();
$entity_type_info = entity_get_info($entity_type);
if (!empty($entity_type_info['bundles'])) {
foreach ($entity_type_info['bundles'] as $name => $bundle) {
$bundles[] = $name;
}
}
// Load the list of farm roles.
$roles = farm_access_roles();
// Grant access to view and edit entity type bundles.
$access_ops = array(
'view' => array('view'),
'edit' => array('create', 'edit', 'delete'),
);
foreach ($access_ops as $access => $ops) {
// If the role has access to these asset operations...
if (!empty($roles[$role]['access'][$access])) {
// Build a list of entity type bundles that they have access to. If 'all'
// access is granted, add all permissions. Or, if specific bundles are
// specified, add them individually.
$access_types[$entity_type] = array();
if ($roles[$role]['access'][$access] == 'all' || !empty($roles[$role]['access'][$access][$entity_type]) && $roles[$role]['access'][$access][$entity_type] == 'all') {
foreach ($bundles as $type) {
$access_types[$entity_type][] = $type;
}
}
elseif (!empty($roles[$role]['access'][$access][$entity_type])) {
foreach ($roles[$role]['access'][$access][$entity_type] as $bundle) {
if (!empty($bundles[$bundle])) {
$access_types[$entity_type][] = $bundle;
}
}
}
// Build a list of entity permissions for the assets and operations and
// merge them into the permissions this function will return.
$entity_perms = farm_access_entity_perms($access_types, $ops);
$perms = array_merge($perms, $entity_perms);
}
}
// Return the permissions.
return $perms;
}
/**
* Implements hook_modules_enabled().
*/