Browse Source

Add hook_islandora_datastream_access()...

...  Also, start using our new access functions in a few places.
pull/352/head
Adam Vessey 12 years ago
parent
commit
9459899105
  1. 4
      includes/datastream.inc
  2. 45
      islandora.api.php
  3. 72
      islandora.module

4
includes/datastream.inc

@ -85,7 +85,7 @@ function islandora_datastream_get_url(AbstractDatastream $datastream, $type = 'd
*/ */
function islandora_datastream_get_delete_link(AbstractDatastream $datastream) { function islandora_datastream_get_delete_link(AbstractDatastream $datastream) {
$datastreams = module_invoke_all('islandora_undeletable_datastreams', $datastream->parent->models); $datastreams = module_invoke_all('islandora_undeletable_datastreams', $datastream->parent->models);
$can_delete = !in_array($datastream->id, $datastreams); $can_delete = !in_array($datastream->id, $datastreams) && islandora_datastream_access(FEDORA_PURGE, $datastream);
return $can_delete ? l(t('delete'), "islandora/object/{$datastream->parent->id}/datastream/{$datastream->id}/delete") : ''; return $can_delete ? l(t('delete'), "islandora/object/{$datastream->parent->id}/datastream/{$datastream->id}/delete") : '';
} }
@ -97,7 +97,7 @@ function islandora_datastream_get_delete_link(AbstractDatastream $datastream) {
*/ */
function islandora_datastream_edit_get_link(AbstractDatastream $datastream) { function islandora_datastream_edit_get_link(AbstractDatastream $datastream) {
$edit_registry = module_invoke_all('islandora_edit_datastream_registry', $datastream->parent, $datastream); $edit_registry = module_invoke_all('islandora_edit_datastream_registry', $datastream->parent, $datastream);
$can_edit = count($edit_registry) > 0 && user_access(FEDORA_METADATA_EDIT); $can_edit = count($edit_registry) > 0 && islandora_datastream_access(FEDORA_METADATA_EDIT, $datastream);
return $can_edit ? l(t('edit'), "islandora/object/{$datastream->parent->id}/datastream/{$datastream->id}/edit") : ''; return $can_edit ? l(t('edit'), "islandora/object/{$datastream->parent->id}/datastream/{$datastream->id}/edit") : '';
} }

45
islandora.api.php

@ -460,7 +460,7 @@ function hook_CMODEL_PID_islandora_ingest_steps(array $form_state) {
* the given object, or NULL to indicate that we are making no assertion * the given object, or NULL to indicate that we are making no assertion
* about the outcome. * about the outcome.
*/ */
function hook_islandora_access($op, $object, $user) { function hook_islandora_object_access($op, $object, $user) {
switch ($op) { switch ($op) {
case 'create stuff': case 'create stuff':
return TRUE; return TRUE;
@ -475,10 +475,47 @@ function hook_islandora_access($op, $object, $user) {
} }
/** /**
* Content model specific version of hook_islandora_access(). * Content model specific version of hook_islandora_object_access().
* *
* @see hook_islandora_access * @see hook_islandora_object_access()
*/ */
function hook_CMODEL_PID_islandora_access($op, $object, $user) { function hook_CMODEL_PID_islandora_object_access($op, $object, $user) {
}
/**
* Hookable access hook.
*
* @param string $op
* A string define an operation to check. Should be defined via
* hook_permission().
* @param AbstractDatastream $object
* An object to check the operation on.
* @param object $user
* A loaded user object, as the global $user variable might contain.
*
* @return bool|NULL
* Either boolean TRUE or FALSE to explicitly allow or deny the operation on
* the given object, or NULL to indicate that we are making no assertion
* about the outcome.
*/
function hook_islandora_datastream_access($op, $object, $user) {
switch ($op) {
case 'create stuff':
return TRUE;
case 'break stuff':
return FALSE;
case 'do a barrel roll!':
return NULL;
}
}
/**
* Content model specific version of hook_islandora_datastream_access().
*
* @see hook_islandora_datastream_access()
*/
function hook_CMODEL_PID_islandora_datastream_access($op, $object, $user) {
} }

72
islandora.module

@ -475,7 +475,7 @@ function islandora_object_access_callback($perm, $object = NULL) {
return FALSE; return FALSE;
} }
return user_access($perm) && is_object($object) && islandora_namespace_accessible($object->id); return islandora_object_access($perm);
} }
/** /**
@ -499,8 +499,7 @@ function islandora_object_access_callback($perm, $object = NULL) {
* TRUE if the user is allowed to access this object, FALSE otherwise. * TRUE if the user is allowed to access this object, FALSE otherwise.
*/ */
function islandora_object_datastream_access_callback($perm, $object = NULL, $datastream = NULL, $account = NULL) { function islandora_object_datastream_access_callback($perm, $object = NULL, $datastream = NULL, $account = NULL) {
module_load_include('inc', 'islandora', 'includes/utilities'); return islandora_datastream_access($perm, $datastream, $account);
return user_access($perm, $account) && is_object($object) && islandora_namespace_accessible($object->id) && is_object($datastream);
} }
/** /**
@ -554,10 +553,10 @@ function islandora_object_manage_access_callback($perms, $object = NULL) {
$has_access = FALSE; $has_access = FALSE;
for ($i = 0; $i < count($perms) && !$has_access; $i++) { for ($i = 0; $i < count($perms) && !$has_access; $i++) {
$has_access = $has_access || user_access($perms[$i]); $has_access = $has_access || islandora_object_access($perms[$i], $object);
} }
return $has_access && is_object($object) && islandora_namespace_accessible($object->id); return $has_access;
} }
/** /**
@ -1128,7 +1127,7 @@ function islandora_file_mimetype_mapping_alter(&$mapping) {
} }
/** /**
* Hookable access callback. * Hookable object access callback.
* *
* @param string $op * @param string $op
* String identifying an operation to check. Should correspond to a * String identifying an operation to check. Should correspond to a
@ -1139,17 +1138,13 @@ function islandora_file_mimetype_mapping_alter(&$mapping) {
* An optional loaded user object. Defaults to the global $user. * An optional loaded user object. Defaults to the global $user.
* *
* @return bool * @return bool
* TRUE if at least one implementation of hook_islandora_access() returned * TRUE if at least one implementation of hook_islandora_object_access() returned
* TRUE, and no implementation return FALSE; FALSE otherwise. * TRUE, and no implementation return FALSE; FALSE otherwise.
*/ */
function islandora_access($op, $object = NULL, $user = NULL) { function islandora_object_access($op, $object, $user = NULL) {
$cache = &drupal_static(__FUNCTION__); $cache = &drupal_static(__FUNCTION__);
if (empty($object)) { if (!is_object($object)) {
$pid = variable_get('islandora_repository_pid', 'islandora:root');
$object = islandora_object_load($pid);
}
if (!$object) {
// The object could not be loaded... Presumably, we don't have // The object could not be loaded... Presumably, we don't have
// permission. // permission.
return FALSE; return FALSE;
@ -1162,7 +1157,7 @@ function islandora_access($op, $object = NULL, $user = NULL) {
if (!isset($cache[$op][$object->id][$user->uid])) { if (!isset($cache[$op][$object->id][$user->uid])) {
module_load_include('inc', 'islandora', 'includes/utilities'); module_load_include('inc', 'islandora', 'includes/utilities');
$results = islandora_invoke_hook_list('islandora_access', $object->models, array( $results = islandora_invoke_hook_list('islandora_object_access', $object->models, array(
$op, $op,
$object, $object,
$user, $user,
@ -1176,13 +1171,13 @@ function islandora_access($op, $object = NULL, $user = NULL) {
} }
/** /**
* Implements hook_islandora_access(). * Implements hook_islandora_object_access().
* *
* Denies according to PID namespace restrictions, passes according to * Denies according to PID namespace restrictions, passes according to
* user_access(), and makes no indication if namespace restrictions passed but * user_access(), and makes no indication if namespace restrictions passed but
* user_access() returned a fail, to allow other modules to allow an operation. * user_access() returned a fail, to allow other modules to allow an operation.
*/ */
function islandora_islandora_access($op, $object, $user) { function islandora_islandora_object_access($op, $object, $user) {
module_load_include('inc', 'islandora', 'includes/utilities'); module_load_include('inc', 'islandora', 'includes/utilities');
$to_return = islandora_namespace_accessible($object->id); $to_return = islandora_namespace_accessible($object->id);
@ -1199,3 +1194,48 @@ function islandora_islandora_access($op, $object, $user) {
return NULL; return NULL;
} }
} }
/**
* Hookable access callback for datastreams.
*
* Requires the equivalent permissions on the object.
*/
function islandora_datastream_access($op, $datastream, $user = NULL) {
$cache = &drupal_static(__FUNCTION__);
if (!$datastream) {
// The object could not be loaded... Presumably, we don't have
// permission.
return NULL;
}
if ($user === NULL) {
global $user;
}
// Populate the cache on a miss.
if (!isset($cache[$op][$object->id][$user->uid])) {
if ($cache[$op][$datastream->parent->id][$datastream->id][$user->uid]) {
module_load_include('inc', 'islandora', 'includes/utilities');
$object_results = islandora_invoke_hook_list('islandora_object_access', $datastream->parent->models, array(
$op,
$datastream->parent,
$user,
));
$datastream_results = islandora_invoke_hook_list('islandora_datastream_access', $datastream->parent->models, array(
$op,
$datastream,
$user,
));
// Neither the object nor the datastream check returned FALSE, and one in
// the object or datastream checks returned TRUE.
$cache[$op][$datastream->parent->id][$datastream->id][$user->uid] =
!in_array(FALSE, $object_results, TRUE) &&
!in_array(FALSE, $datastream_results, TRUE) &&
(in_array(TRUE, $object_results, TRUE) || in_array(TRUE, $datastream_results, TRUE));
}
}
return $cache[$op][$datastream->parent->id][$datastream->id][$user->uid];
}

Loading…
Cancel
Save