diff --git a/CollectionClass.inc b/CollectionClass.inc
index 87f1f4b6..fe5528eb 100644
--- a/CollectionClass.inc
+++ b/CollectionClass.inc
@@ -102,7 +102,7 @@ class CollectionClass {
function getRelatedItems($pid, $query_string = NULL, $limit = NULL, $offset = NULL) {
module_load_include('inc', 'fedora_repository', 'api/fedora_utils');
module_load_include('inc', 'fedora_repository', 'ObjectHelper');
- if (!fedora_repository_access(OBJECTHELPER :: $OBJECT_HELPER_VIEW_FEDORA, $pid)) {
+ if (!fedora_repository_check_perm(OBJECTHELPER :: $OBJECT_HELPER_VIEW_FEDORA, $pid)) {
drupal_set_message(t("You do not have access to Fedora objects within the attempted namespace or access to Fedora denied."), 'error');
return ' ';
}
@@ -321,7 +321,7 @@ class CollectionClass {
* @return type
*/
function getAndDoRules($file, $mimetype, $pid, $dsid) {
- if (!user_access('ingest new fedora objects')) {
+ if (!fedora_repository_check_perm('ingest new fedora objects', $pid)) {
drupal_set_message(t('You do not have permission to ingest objects.'));
return FALSE;
}
@@ -586,7 +586,7 @@ class CollectionClass {
function getIngestInterface() {
module_load_include('inc', 'fedora_repository', 'CollectionPolicy');
$collectionPolicyExists = $this->collectionObject->getMimeType($this->pid, CollectionPolicy::getDefaultDSID());
- if (user_access(ObjectHelper :: $INGEST_FEDORA_OBJECTS) && $collectionPolicyExists) {
+ if (fedora_repository_check_perm(ObjectHelper :: $INGEST_FEDORA_OBJECTS, $this->pid) && $collectionPolicyExists) {
if (!empty($collectionPolicyExists)) {
$allow = TRUE;
if (module_exists('fedora_fesl')) {
diff --git a/ObjectHelper.inc b/ObjectHelper.inc
index 698e5d42..1fe1ae7b 100644
--- a/ObjectHelper.inc
+++ b/ObjectHelper.inc
@@ -93,7 +93,7 @@ class ObjectHelper {
return ' ';
}
- if (!fedora_repository_access(OBJECTHELPER :: $OBJECT_HELPER_VIEW_FEDORA, $pid, $user)) {
+ if (!fedora_repository_check_perm(OBJECTHELPER :: $OBJECT_HELPER_VIEW_FEDORA, $pid, $user)) {
drupal_set_message(t("You do not have access Fedora objects within the attempted namespace."), 'error');
drupal_access_denied();
return ' ';
@@ -298,7 +298,7 @@ class ObjectHelper {
drupal_set_message(t('You must specify an object pid and datastream ID.'), 'error');
return '';
}
- if (!fedora_repository_access(ObjectHelper :: $OBJECT_HELPER_VIEW_FEDORA, $pid, $user)) {
+ if (!fedora_repository_check_perm(ObjectHelper :: $OBJECT_HELPER_VIEW_FEDORA, $pid, $user)) {
drupal_set_message(t('You do not have the appropriate permissions'), 'error');
return;
}
@@ -333,7 +333,7 @@ class ObjectHelper {
drupal_set_message(t('You must specify an object pid and datastream ID.'), 'error');
return '';
}
- if (!fedora_repository_access(ObjectHelper :: $OBJECT_HELPER_VIEW_FEDORA, $pid, $user)) {
+ if (!fedora_repository_check_perm(ObjectHelper :: $OBJECT_HELPER_VIEW_FEDORA, $pid, $user)) {
drupal_set_message(t('You do not have the appropriate permissions'), 'error');
return;
}
@@ -368,7 +368,7 @@ class ObjectHelper {
$item = new Fedora_Item($pid);
$purge_image = ' ';
- if (user_access(ObjectHelper :: $PURGE_FEDORA_OBJECTSANDSTREAMS)) {
+ if (fedora_repository_check_perm(ObjectHelper :: $PURGE_FEDORA_OBJECTSANDSTREAMS, $pid)) {
$allow = TRUE;
if (module_exists('fedora_fesl')) {
$allow = fedora_fesl_check_roles($pid, 'write');
@@ -388,7 +388,7 @@ class ObjectHelper {
// Add an icon to replace a datastream
// @TODO Note: using l(theme_image(..), ...); for these image links (and other links) may remove the need to have clean urls enabled.
$replace_image = ' ';
- if (user_access(ObjectHelper :: $ADD_FEDORA_STREAMS)) {
+ if (fedora_repository_check_perm(ObjectHelper :: $ADD_FEDORA_STREAMS, $pid)) {
$allow = TRUE;
if (module_exists('fedora_fesl')) {
$allow = fedora_fesl_check_roles($pid, 'write');
@@ -533,7 +533,7 @@ class ObjectHelper {
$dsid = array_key_exists('QDC', $ds_list) ? 'QDC' : 'DC';
$path = drupal_get_path('module', 'fedora_repository');
- if (user_access(ObjectHelper :: $EDIT_FEDORA_METADATA)) {
+ if (fedora_repository_check_perm(ObjectHelper :: $EDIT_FEDORA_METADATA, $pid)) {
$allow = TRUE;
if (module_exists('fedora_fesl')) {
$allow = fedora_fesl_check_roles($pid, 'write');
@@ -573,7 +573,7 @@ class ObjectHelper {
$dataStreamBody = '';
$fedoraItem = new Fedora_Item($object_pid);
- if (user_access(ObjectHelper :: $VIEW_DETAILED_CONTENT_LIST)) {
+ if (fedora_repository_check_perm(ObjectHelper :: $VIEW_DETAILED_CONTENT_LIST, $object_pid)) {
$availableDataStreamsText = 'Detailed List of Content';
$mainStreamLabel = NULL;
@@ -606,7 +606,7 @@ class ObjectHelper {
$dataStreamBody = theme('table', $headers, $DSs);
//if they have access let them add a datastream
- if (user_access(ObjectHelper::$ADD_FEDORA_STREAMS) && //If allowed throw Drupal
+ if (fedora_repository_check_perm(ObjectHelper::$ADD_FEDORA_STREAMS, $object_pid) && //If allowed throw Drupal
((module_exists('fedora_fesl') && fedora_fesl_check_roles($object_pid, 'write')) || //And allowed throw FESL
!module_exists('fedora_fesl'))) { //Or not using FESL, draw the add datastream form.
$dataStreamBody .= drupal_get_form('add_stream_form', $object_pid);
@@ -673,36 +673,6 @@ class ObjectHelper {
return $cmodels;
}
- /**
- * determines whether we can see the object or not
- * checks PID namespace permissions, and user permissions
- * @global type $user
- * @param type $op
- * @param type $pid
- * @return type
- */
- function fedora_repository_access($op, $pid = NULL, $as_user = NULL) {
- $returnValue = FALSE;
-
- if ($pid == NULL) {
- $pid = variable_get('fedora_repository_pid', 'islandora:root');
- }
-
- $isRestricted = variable_get('fedora_namespace_restriction_enforced', TRUE);
- $namespace_access = NULL;
- if (!$isRestricted) {
- $namespace_access = TRUE;
- }
- else {
- $pid_namespace = substr($pid, 0, strpos($pid, ':') + 1); //Get the namespace (with colon)
- $allowed_namespaces = explode(" ", variable_get('fedora_pids_allowed', 'default: demo: changeme: islandora: ilives: islandora-book: books: newspapers: '));
-
- $namespace_access = in_array($pid_namespace, $allowed_namespaces);
- }
-
- return ($namespace_access && user_access($op, $as_user));
- }
-
/**
* Get the query to find parent objects.
*
@@ -795,7 +765,7 @@ class ObjectHelper {
* @return boolean
*/
function get_and_do_datastream_rules($pid, $dsid, $file = '') {
- if (!user_access('ingest new fedora objects')) {
+ if (!fedora_repository_check_perm('ingest new fedora objects', $pid)) {
drupal_set_message(t('You do not have permission to add datastreams.'));
return FALSE;
}
diff --git a/SearchClass.inc b/SearchClass.inc
index 473076a1..4230257b 100644
--- a/SearchClass.inc
+++ b/SearchClass.inc
@@ -187,7 +187,7 @@ class SearchClass {
function quickSearch($type, $query, $showForm = 1, $orderBy = 0, & $userArray) {
module_load_include('inc', 'fedora_repository', 'ObjectHelper');
module_load_include('inc', 'fedora_repository', 'api/fedora_utils');
- if (user_access('view fedora collection')) {
+ if (fedora_repository_check_perm('view fedora collection')) {
$numberOfHistPerPage = '5000'; //hack for IR they do not want next button
$luceneQuery = NULL;
// Demo search string ?operation=gfindObjects&indexName=DemoOnLucene&query=fgs.DS.first.text%3Achristmas&hitPageStart=11&hitPageSize=10
@@ -272,7 +272,7 @@ class SearchClass {
module_load_include('inc', 'fedora_repository', 'ObjectHelper');
module_load_include('inc', 'fedora_repository', 'api/fedora_utils');
- if (user_access('view fedora collection')) {
+ if (fedora_repository_check_perm('view fedora collection')) {
//$numberOfHistPerPage = '50';//hack for IR they do not want next button
$luceneQuery = NULL;
$indexName = variable_get('fedora_index_name', 'DemoOnLucene');
diff --git a/api/fedora_collection.inc b/api/fedora_collection.inc
index 200fb324..52b830df 100644
--- a/api/fedora_collection.inc
+++ b/api/fedora_collection.inc
@@ -70,8 +70,7 @@ function export_collection($collection_pid, $relationship = 'isMemberOfCollectio
function get_related_items_as_xml($collection_pid, $relationship = array('isMemberOfCollection'), $limit = 10000, $offset = 0, $active_objects_only = TRUE, $cmodel = NULL, $orderby = '$title') {
module_load_include('inc', 'fedora_repository', 'ObjectHelper');
- global $user;
- if (!fedora_repository_access(OBJECTHELPER :: $OBJECT_HELPER_VIEW_FEDORA, $pid, $user)) {
+ if (!fedora_repository_check_perm(OBJECTHELPER :: $OBJECT_HELPER_VIEW_FEDORA, $pid)) {
drupal_set_message(t("You do not have access to Fedora objects within the attempted namespace or access to Fedora denied."), 'error');
return array();
}
diff --git a/fedora_repository.api.php b/fedora_repository.api.php
index 724078b2..190c9ec1 100644
--- a/fedora_repository.api.php
+++ b/fedora_repository.api.php
@@ -95,6 +95,8 @@ function hook_required_fedora_objects() {
* Override ingest permissions.
* (from islandora_workflow)
*
+ * @deprecated
+ * Deprecated in favour of hook_fedora_repository_check_perm().
* @param string $collection_pid
* The PID of the collection
*
@@ -107,3 +109,29 @@ function hook_fedora_repository_can_ingest($collection_pid) {
return (islandora_workflow_user_collection_permission_check($collection_pid) !== FALSE);
}
+
+/**
+ * Implements hook_fedora_repository_check_perm().
+ *
+ * Hook to allow other modules to allow or deny operations on conditions other
+ * than the explicit Drupal permissions.
+ *
+ * @param string $op
+ * A string representing the operation to be performed.
+ * @param string|null $pid
+ * A string containing the Fedora PID on which the operation is to be
+ * performed. The (default) value of NULL will use the PID indicated by the
+ * fedora_repository_pid Drupal variable.
+ * @param object|null $as_user
+ * An object representing the user for whom to check the permissions (as
+ * given by user_load or the $user global). The (default) value of NULL will
+ * cause permissions to be evaluated for the current user (from the $user
+ * global).
+ *
+ * @return boolean|null
+ * Either a boolean permitting (TRUE) or forbidding (FALSE) an operation, or
+ * NULL to make no assertion.
+ */
+function hook_fedora_repository_check_perm($op, $pid = NULL, $as_user = NULL) {
+ return NULL;
+}
diff --git a/fedora_repository.module b/fedora_repository.module
index d794c20c..6463e18e 100644
--- a/fedora_repository.module
+++ b/fedora_repository.module
@@ -54,15 +54,11 @@ function fedora_repository_help($path, $arg) {
*
* @return type
*/
-function fedora_repository_purge_object($pid = NULL, $name = NULL) {
- if (!user_access('purge objects and datastreams')) {
+function fedora_repository_purge_object($pid, $name = NULL) {
+ if (!fedora_repository_check_perm('purge objects and datastreams', $pid)) {
drupal_set_message(t('You do not have access to add a datastream to this object.'), 'error');
return '';
}
- if ($pid == NULL) {
- drupal_set_message(t('You must specify an object pid to purge an object.'), 'error');
- return '';
- }
$output = t('Are you sure you wish to purge object %name %pid!
This cannot be undone
', array(
'%name' => $name,
'%pid' => $pid)
@@ -75,16 +71,18 @@ function fedora_repository_purge_object($pid = NULL, $name = NULL) {
/**
* fedora repository ingest object
*
+ * XXX: Is this even used?
+ *
* @param type $collection_pid
* @param type $collection_label
* @param type $content_model
*
* @return type
*/
-function fedora_repository_ingest_object($collection_pid=NULL, $collection_label = NULL, $content_model = NULL) {
+function fedora_repository_ingest_object($collection_pid, $collection_label = NULL, $content_model = NULL) {
module_load_include('inc', 'fedora_repository', 'api/fedora_utils');
module_load_include('inc', 'fedora_repository', 'ObjectHelper');
- if (!user_access('ingest new fedora objects')) {
+ if (!fedora_repository_check_perm('ingest new fedora objects', $collection_pid)) {
drupal_set_message(t('You do not have permission to ingest.'), 'error');
return '';
}
@@ -298,10 +296,7 @@ function fedora_repository_ingest_form(&$form_state, $collection_pid, $collectio
*/
function fedora_repository_purge_object_form(&$form_state, $pid, $referrer = NULL) {
global $base_url;
- if (!user_access('purge objects and datastreams')) {
- return NULL;
- }
- if ($pid == NULL) {
+ if (!fedora_repository_check_perm('purge objects and datastreams', $pid)) {
return NULL;
}
$form['pid'] = array(
@@ -341,25 +336,21 @@ function fedora_repository_purge_object_form(&$form_state, $pid, $referrer = NUL
/**
* add stream
*
- * @param type $collection_pid
+ * @param type $pid
* @param type $collectionName
*
* @return type
*/
-function add_stream($collection_pid=NULL, $collectionName=NULL) {
+function add_stream($pid, $collectionName=NULL) {
module_load_include('inc', 'fedora_repository', 'api/fedora_utils');
if (!valid_pid($collection_pid)) {
drupal_set_message(t("This PID is not valid!"), 'error');
return ' ';
}
- if (!user_access('ingest new fedora objects')) {
+ if (!fedora_repository_check_perm('add fedora datastreams', $pid)) {
drupal_set_message(t('You do not have permission to ingest.'), 'error');
return '';
}
- if ($collection_pid == NULL) {
- drupal_set_message(t('You must specify an collection object pid to ingest an object.'), 'error');
- return '';
- }
$output .= drupal_get_form('fedora_repository_add_stream_form', $pid);
return $output;
@@ -508,7 +499,7 @@ function fedora_repository_purge_stream($pid = NULL, $dsId = NULL, $name = NULL)
drupal_set_message(t('You must specify an object pid and DataStream ID to purge a datastream'), 'error');
return ' ';
}
- if (!fedora_repository_access(OBJECTHELPER :: $PURGE_FEDORA_OBJECTSANDSTREAMS, $pid, $user)) {
+ if (!fedora_repository_check_perm(OBJECTHELPER :: $PURGE_FEDORA_OBJECTSANDSTREAMS, $pid, $user)) {
drupal_set_message(t("You do not have access to Fedora objects within the attempted namespace or you do not have permission to purge objects."), 'error');
return ' ';
}
@@ -660,7 +651,7 @@ function fedora_repository_download_datastream_form(&$form_state, $pid, $dsid, $
),
);
- if (user_access(ObjectHelper::$EDIT_FEDORA_METADATA)) {
+ if (fedora_repository_check_perm(ObjectHelper::$EDIT_FEDORA_METADATA, $pid)) {
$item = new Fedora_Item($pid);
$versions = $item->get_datastream_history($dsid);
$version_array = array();
@@ -811,7 +802,7 @@ function fedora_repository_edit_qdc_page($pid = NULL, $dsId = NULL) {
drupal_set_message(t('You must specify an object pid and a Dublin Core DataStream ID to edit metadata'), 'error');
return ' ';
}
- if (!fedora_repository_access(OBJECTHELPER :: $EDIT_FEDORA_METADATA, $pid, $user)) {
+ if (!fedora_repository_check_perm(OBJECTHELPER :: $EDIT_FEDORA_METADATA, $pid, $user)) {
drupal_set_message(t("You do not have access to Fedora objects within the attempted namespace or you do not have permission to edit meta data for this object."), 'error');
return ' ';
}
@@ -835,7 +826,7 @@ function fedora_repository_edit_qdc_form(&$form_state, $pid, $dsId = NULL) {
drupal_set_message(t('You must specify an object pid!'), 'error');
}
global $user;
- if (!fedora_repository_access(OBJECTHELPER :: $EDIT_FEDORA_METADATA, $pid, $user)) {
+ if (!fedora_repository_check_perm(OBJECTHELPER :: $EDIT_FEDORA_METADATA, $pid, $user)) {
drupal_set_message(t("You do not have access to Fedora objects within the attempted namespace or you do not have permission to edit meta data for this object."), 'error');
return ' ';
}
@@ -938,21 +929,6 @@ function fedora_repository_perm() {
);
}
-/**
- * drupal hook
- * determines if a user has access to what they are asking for
- *
- * @param type $op
- * @param type $node
- * @param type $account
- * @return type
- */
-function fedora_repository_access($op, $node = NULL, $account = NULL) {
- module_load_include('inc', 'fedora_repository', 'ObjectHelper');
- $objectHelper = new ObjectHelper();
- return $objectHelper->fedora_repository_access($op, $node, $account);
-}
-
/**
* Grabs a stream from fedora sets the mimetype and returns it. $dsID is the
* datastream id.
@@ -977,7 +953,7 @@ function makeObject($pid, $dsID) {
return ' ';
}
global $user, $conf;
- if (!fedora_repository_access(OBJECTHELPER :: $OBJECT_HELPER_VIEW_FEDORA, $pid, $user)) {
+ if (!fedora_repository_check_perm(OBJECTHELPER :: $OBJECT_HELPER_VIEW_FEDORA, $pid, $user)) {
drupal_access_denied();
return;
drupal_set_message(t("You do not have access to Fedora objects within the attempted namespace."), 'error');
@@ -1120,7 +1096,7 @@ function fedora_repository_get_items($pid = NULL, $dsId = NULL, $collection = NU
drupal_set_message(t("Invalid dsID!"), 'error');
return ' ';
}
- if (!fedora_repository_access(OBJECTHELPER::$OBJECT_HELPER_VIEW_FEDORA, $pid, $user)) {
+ if (!fedora_repository_check_perm(OBJECTHELPER::$OBJECT_HELPER_VIEW_FEDORA, $pid, $user)) {
if (user_access('access administration pages')) {
drupal_set_message(t("PIDs may be added to allowed namespaces, or all namespace restrictions removed !here", array('!here' => l('here', 'admin/settings/fedora_repository'))), 'warning');
}
@@ -1187,7 +1163,7 @@ function fedora_repository_urlencode_string($str) {
* Uses makeobject to get a stream. Sets the Content Disposition in the header so it suggests a filename
* and sends it as an attachment. This should prompt for a download of the object.
*
- * @global type $user
+ * @global type $conf
* @param type $pid
* @param type $dsId
* @param type $label
@@ -1211,6 +1187,7 @@ function fedora_object_as_attachment($pid, $dsId, $label=NULL, $version=NULL) {
/**
* repository page
+ *
* @param type $pid
* @param type $dsId
* @param type $collection
@@ -1225,6 +1202,9 @@ function repository_page($pid = NULL, $dsId = NULL, $collection = NULL, $pageNum
/**
* repository service
+ *
+ * XXX: Is this even used?
+ *
* @global type $user
* @param type $pid
* @param type $servicePid
@@ -1236,7 +1216,7 @@ function repository_service($pid = NULL, $servicePid = NULL, $serviceMethod = NU
module_load_include('inc', 'fedora_repository', 'ObjectHelper');
global $user;
- if (!fedora_repository_access(OBJECTHELPER::$OBJECT_HELPER_VIEW_FEDORA, $pid, $user)) {
+ if (!fedora_repository_check_perm(OBJECTHELPER::$OBJECT_HELPER_VIEW_FEDORA, $pid, $user)) {
//drupal_set_message(t("You do not have access to Fedora objects within the attempted namespace or access to Fedora denied"), 'error');
drupal_access_denied();
if (user_access('access administration pages')) {
@@ -1605,238 +1585,6 @@ function fedora_repository_mnpl_advanced_search_form_submit($form, &$form_state)
drupal_goto("fedora/repository/mnpl_advanced_search/$searchString");
}
-/**
- * fedora repository install demo page
- * @return type
- */
-function fedora_repository_install_demos_page() {
- $output = drupal_get_form('fedora_repository_demo_objects_form');
- return $output;
-}
-
-/**
- * fedora repository demo objects form
- * @return string
- */
-function fedora_repository_demo_objects_form() {
- module_load_include('inc', 'fedora_repository', 'ObjectHelper');
- module_load_include('inc', 'fedora_repository', 'api/fedora_item');
- $form = array();
- $existing_demos = array();
-
- $form['install_demos'] = array(
- '#title' => t('Islandora Demo Collections'),
- '#type' => 'fieldset',
- '#description' => t('Install demo image and document collections and content models.'),
- );
- $demo_objects = array();
-// Check if the top-level islandora collection exists. If not, display a button to ingest.
-
- $form['install_demos']['demo_collections'] = array(
- '#type' => 'checkboxes',
- '#title' => t('Collections to ingest'),
- '#options' => array(),
- '#description' => t('Choose which demo collections you would like ingested into the repository.'),
- );
-
- foreach (array(
-'islandora:collectionCModel' => 'Islandora default content models',
- 'islandora:root' => 'Islandora top-level collection',
- 'islandora:demos' => 'Islandora demos collection',
- 'islandora:largeimages' => 'Sample large image content model (requires Djatoka and Kakadu.)',
- )
- as $available_demo => $available_demo_desc) {
- try {
- $demo_objects[$available_demo] = new Fedora_Item($available_demo);
- } catch (exception $e) {
-
- }
-
- if (empty($demo_objects[$available_demo]->objectProfile)) {
-//The demo objects collection does not exist in the repository, display a button to ingest them.
- $form['install_demos']['demo_collections']['#options'][$available_demo] = $available_demo_desc;
- }
- else {
- array_push($existing_demos, $demo_objects[$available_demo]);
- }
- }
-
-// Check if the SmileyStuff collectoin exists, and if it has a COLLECTION_VIEW datastream. If it doesn't then we can add it.
-
- $smiley_stuff = new Fedora_Item('demo:SmileyStuff');
- if (!empty($smiley_stuff->objectProfile)) {
- $datastreams_list = $smiley_stuff->get_datastreams_list_as_array();
- if (empty($datastreams_list['COLLECTION_VIEW'])) {
- $form['install_demos']['demo_collections']['#options']['demo:SmileyStuff'] = 'Add Islandora Collection View to Fedora Smiley Stuff Collection';
- }
- else {
- $demo_objects['demo:SmileyStuff'] = $smiley_stuff;
- }
- }
- else {
- $form['install_demos']['smileynote'] = array(
- '#value' => '
If you install the ' . l('fedora demo objects', 'https://wiki.duraspace.org/display/FCR30/Demonstration+Objects') . ' Islandora can display them as a collection.
' - ); - } - - $form['install_demos']['ingest'] = array( - '#type' => 'submit', - '#name' => 'install_demos', - '#value' => 'Install Selected Demos', - '#disabled' => (empty($form['install_demos']['demo_collections']['#options'])) ? TRUE : FALSE, - ); - - $form['existing_demos'] = array( - '#prefix' => 'Demo collections already installed in this repository: