From cdcc594065fb073abf785ffd0050fa1c810f2f87 Mon Sep 17 00:00:00 2001 From: Alan Stanley Date: Fri, 13 Sep 2013 13:20:43 -0300 Subject: [PATCH 1/4] made derivative creation object state aware --- includes/derivatives.inc | 2 +- islandora.api.php | 43 +++++++++++++++++++++++----------------- 2 files changed, 26 insertions(+), 19 deletions(-) diff --git a/includes/derivatives.inc b/includes/derivatives.inc index fbf4b9e7..c66944b1 100644 --- a/includes/derivatives.inc +++ b/includes/derivatives.inc @@ -37,7 +37,7 @@ function islandora_do_derivatives(AbstractObject $object, array $options) { $options += array( 'force' => FALSE, ); - $hooks = islandora_invoke_hook_list(ISLANDORA_DERVIATIVE_CREATION_HOOK, $object->models, array()); + $hooks = islandora_invoke_hook_list(ISLANDORA_DERVIATIVE_CREATION_HOOK, $object->models, array($object)); uasort($hooks, 'drupal_sort_weight'); $results = array(); diff --git a/islandora.api.php b/islandora.api.php index 39c6e454..18e5643b 100644 --- a/islandora.api.php +++ b/islandora.api.php @@ -578,6 +578,8 @@ function hook_CMODEL_PID_islandora_overview_object_alter(AbstractObject &$object /* * Defines derivative functions to be executed based on certain conditions. * + * @param AbstractObject $object + * Object to which derivatives will be added * This hook fires when an object/datastream is ingested or a datastream is * modified. * @@ -611,33 +613,38 @@ function hook_CMODEL_PID_islandora_overview_object_alter(AbstractObject &$object * - file: A string denoting the path to the file where the function * is being called from. */ -function hook_islandora_derivative() { - return array( - array( - 'source_dsid' => 'OBJ', - 'destination_dsid' => 'DERIV', - 'weight' => '0', - 'function' => array( - 'islandora_derivatives_test_create_deriv_datastream', - ), +function hook_islandora_derivative(AbstractObject $object) { + + $derivatives[] = array( + 'source_dsid' => 'OBJ', + 'destination_dsid' => 'DERIV', + 'weight' => '0', + 'function' => array( + 'islandora_derivatives_test_create_deriv_datastream', ), - array( + ); + // Test object before adding this derivative. + if ($object['SOMEWEIRDDATASTREAM']->mimetype == "SOMETHING/ODD") { + $derivatives[] = array( 'source_dsid' => 'SOMEWEIRDDATASTREAM', 'destination_dsid' => 'STANLEY', 'weight' => '-1', 'function' => array( 'islandora_derivatives_test_create_some_weird_datastream', ), - ), - array( - 'source_dsid' => NULL, - 'destination_dsid' => 'NOSOURCE', - 'weight' => '-3', - 'function' => array( - 'islandora_derivatives_test_create_nosource_datastream', - ), + ); + } + + $derivatives[] = array( + 'source_dsid' => NULL, + 'destination_dsid' => 'NOSOURCE', + 'weight' => '-3', + 'function' => array( + 'islandora_derivatives_test_create_nosource_datastream', ), ); + + return $derivatives; } /** From 9e3d08615f61a176a59fc0c249e655632955b472 Mon Sep 17 00:00:00 2001 From: William Panting Date: Wed, 18 Sep 2013 12:33:25 -0300 Subject: [PATCH 2/4] undelete docs --- islandora.api.php | 9 +++++++++ islandora.module | 2 +- 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/islandora.api.php b/islandora.api.php index 18e5643b..0dff8d89 100644 --- a/islandora.api.php +++ b/islandora.api.php @@ -394,8 +394,17 @@ function hook_islandora_viewer_info() { /** * Returns a list of datastreams that are determined to be undeletable. + * + * The list is used to prevent delete links from being shown. + * + * @param array $models + * An array of content models for the current object. + * + * @return array + * An array of DSIDs that shouldn't be deleted. */ function hook_islandora_undeletable_datastreams(array $models) { + return array('DC', 'MODS'); } /** diff --git a/islandora.module b/islandora.module index 45458665..7fb3b477 100644 --- a/islandora.module +++ b/islandora.module @@ -1237,7 +1237,7 @@ function islandora_islandora_required_objects(IslandoraTuque $connection) { } /** - * Implements islandora_undeleteable_datastreams(). + * Implements hook_islandora_undeleteable_datastreams(). */ function islandora_islandora_undeletable_datastreams(array $models) { return array('DC'); From a4dd199aa153f50e70328f92ba138a44ea911e15 Mon Sep 17 00:00:00 2001 From: William Panting Date: Wed, 18 Sep 2013 12:49:30 -0300 Subject: [PATCH 3/4] preventing RELS-EXT deletion --- islandora.module | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/islandora.module b/islandora.module index 7fb3b477..ebf7f916 100644 --- a/islandora.module +++ b/islandora.module @@ -1240,7 +1240,7 @@ function islandora_islandora_required_objects(IslandoraTuque $connection) { * Implements hook_islandora_undeleteable_datastreams(). */ function islandora_islandora_undeletable_datastreams(array $models) { - return array('DC'); + return array('DC', 'RELS-EXT'); } /** From f780e964b85ef6aec8ca8e9b2096faf92723a315 Mon Sep 17 00:00:00 2001 From: Jordan Dukart Date: Fri, 20 Sep 2013 10:54:44 +0000 Subject: [PATCH 4/4] Changes required for metadata display refinements. --- includes/metadata.inc | 123 ++++++++++++++++++++ islandora.api.php | 28 +++++ islandora.module | 32 +++++ theme/islandora-dublin-core-display.tpl.php | 17 +++ theme/theme.inc | 18 +++ 5 files changed, 218 insertions(+) create mode 100644 includes/metadata.inc create mode 100644 theme/islandora-dublin-core-display.tpl.php diff --git a/includes/metadata.inc b/includes/metadata.inc new file mode 100644 index 00000000..49b6e417 --- /dev/null +++ b/includes/metadata.inc @@ -0,0 +1,123 @@ + t('None'), + 'description' => t("Don't show any metadata for displaying"), + ); + $viewers = array_merge_recursive($no_viewer, $defined_displays); + + $form['viewers'] = array( + '#type' => 'item', + '#title' => t('Select a viewer'), + '#description' => t('Preferred metadata display for Islandora. These may be provided by third-party modules.'), + '#tree' => TRUE, + '#theme' => 'islandora_viewers_table', + ); + + foreach ($viewers as $name => $profile) { + $options[$name] = ''; + $form['viewers']['name'][$name] = array( + '#type' => 'hidden', + '#value' => $name, + ); + $form['viewers']['label'][$name] = array( + '#type' => 'item', + '#markup' => $profile['label'], + ); + $form['viewers']['description'][$name] = array( + '#type' => 'item', + '#markup' => $profile['description'], + ); + $form['viewers']['configuration'][$name] = array( + '#type' => 'item', + '#markup' => (isset($profile['configuration']) AND $profile['configuration'] != '') ? l(t('configure'), $profile['configuration']) : '', + ); + } + $form['viewers']['default'] = array( + '#type' => 'radios', + '#options' => isset($options) ? $options : array(), + '#default_value' => variable_get('islandora_metadata_display', 'dublin_core'), + ); + } + else { + $form['viewers']['no_viewers'] = array( + '#markup' => t('No viewers detected.'), + ); + } + $form['submit'] = array( + '#type' => 'submit', + '#value' => t('Save configuration'), + ); + return $form; +} + +/** + * Submit handler for the metadata display form which sets the default viewer. + * + * @param array $form + * An array representing a Drupal form. + * @param array $form_state + * An array containing the Drupal form state. + */ +function islandora_metadata_display_form_submit($form, $form_state) { + variable_set('islandora_metadata_display', $form_state['values']['viewers']['default']); + drupal_set_message(t('The configuration options have been saved.')); +} + +/** + * Metadata display callback for rendering Dublin Core metadata. + * + * @param AbstractObject $object + * An AbstractObject representing an object within Fedora. + * + * @return string + * Markup representing the rendered metadata from Dublin Core. + */ +function islandora_metadata_display_callback(AbstractObject $object) { + $elements = array( + 'islandora_object' => $object, + ); + return theme('islandora_dublin_core_display', $elements); +} diff --git a/islandora.api.php b/islandora.api.php index 0dff8d89..bed9b401 100644 --- a/islandora.api.php +++ b/islandora.api.php @@ -691,3 +691,31 @@ function hook_islandora_update_related_objects_properties(AbstractObject $object function hook_islandora_breadcrumbs_alter(&$breadcrumbs, $context) { } + +/** + * Registry hook for metadata display viewers. + * + * Modules can use this hook to override the default Dublin Core display. + * This hook lets Islandora know which viewers there are available. + * + * @return array + * An associative array where the values are the following: + * -label: Human readable display label for selection. + * -description: A description of what the metadata display viewer does. + * -callback: A callable function that provides the markup to be passed + * off to the template files. + * -configuration (Optional): A path to the administration page for the + * metadata display. + + * @see islandora_retrieve_metadata_markup() + */ +function hook_islandora_metadata_display_info() { + return array( + 'hookable_displays_yay' => array( + 'label' => t('Hookable display yay!'), + 'description' => t('This is purely an example of how to implement this.'), + 'callback' => 'hookable_displays_some_function_that_returns_markup', + 'configuration' => 'admin/hookable_displays_yay/somepath', + ), + ); +} diff --git a/islandora.module b/islandora.module index ebf7f916..f8e97c71 100644 --- a/islandora.module +++ b/islandora.module @@ -99,6 +99,14 @@ function islandora_menu() { 'type' => MENU_NORMAL_ITEM, 'weight' => -1, ); + $items['admin/islandora/metadata'] = array( + 'title' => 'Metadata Display', + 'description' => 'Configure settings for metadata display on Islandora objects', + 'page callback' => 'drupal_get_form', + 'page arguments' => array('islandora_metadata_display_form'), + 'file' => 'includes/metadata.inc', + 'access arguments' => array('adminisiter site configuration'), + ); $items['admin/islandora/solution_packs'] = array( 'title' => 'Solution packs', 'description' => 'Install content models and collections required by installed solution packs.', @@ -445,6 +453,17 @@ function islandora_theme() { 'file' => 'theme/theme.inc', 'variables' => array('datastream' => NULL), ), + 'islandora_dublin_core_display' => array( + 'file' => 'theme/theme.inc', + 'template' => 'theme/islandora-dublin-core-display', + // We can add PIDs to the end of this pattern in our preprocess function + // and templates will be able to have have a pid appended to the + // template name to overide a template on a per object basis. + // An example template might be named: + // "islandora-dublin-core-display--islandora-27.tpl.php". + 'pattern' => 'islandora_dublin_core_display__', + 'variables' => array('islandora_object' => NULL), + ), ); } @@ -1602,3 +1621,16 @@ function islandora_islandora_datastream_modified(AbstractObject $object, Abstrac )); islandora_derivative_logging($logging_results); } + +/** + * Implements hook_islandora_metadata_display_info(). + */ +function islandora_islandora_metadata_display_info() { + return array( + 'dublin_core' => array( + 'label' => t('Dublin Core'), + 'description' => t('Dublin Core metadata'), + 'callback' => 'islandora_metadata_display_callback', + ), + ); +} diff --git a/theme/islandora-dublin-core-display.tpl.php b/theme/islandora-dublin-core-display.tpl.php new file mode 100644 index 00000000..63fc60a6 --- /dev/null +++ b/theme/islandora-dublin-core-display.tpl.php @@ -0,0 +1,17 @@ + \ No newline at end of file diff --git a/theme/theme.inc b/theme/theme.inc index 895ec8fe..f12814cb 100644 --- a/theme/theme.inc +++ b/theme/theme.inc @@ -423,3 +423,21 @@ function theme_islandora_datastream_version_link(array $vars) { return ''; } } + +/** + * Implements hook_preprocess(). + */ +function islandora_preprocess_islandora_dublin_core_display(array &$variables) { + $islandora_object = $variables['islandora_object']; + if (islandora_datastream_access(ISLANDORA_VIEW_OBJECTS, $islandora_object['DC'])) { + try { + $dc = $islandora_object['DC']->content; + $dc_object = DublinCore::importFromXMLString($dc); + } + catch (Exception $e) { + drupal_set_message(t('Error retrieving object %s %t', array('%s' => $islandora_object->id, '%t' => $e->getMessage())), 'error', FALSE); + } + } + $variables['islandora_dublin_core'] = isset($dc_object) ? $dc_object : NULL; + $variables['dc_array'] = isset($dc_object) ? $dc_object->asArray() : array(); +}