Add orphaned objects capability to core

7 years ago · 56c2afc39c
2 changed files with 276 additions and 1 deletions
--- a/includes/orphaned_objects.inc
+++ b/includes/orphaned_objects.inc
@ -0,0 +1,268 @@
+<?php
+
+/**
+ * @file
+ * A list of orphaned Islandora objects.
+ */
+
+/**
+ * Implements hook_permission().
+ */
+function islandora_orphaned_objects_permission() {
+  return array(
+    'manage orphaned objects' => array(
+      'title' => t('Manage orphaned objects'),
+      'description' => t('View a list of orphaned objects.'),
+    ),
+  );
+}
+
+/**
+ * Builds the management form for the Orphaned Objects module.
+ *
+ * @param array $form
+ *   An array representing a form within Drupal.
+ * @param array $form_state
+ *   An array containing the Drupal form state.
+ *
+ * @return array
+ *   An array containing the form to be rendered.
+ */
+function islandora_orphaned_objects_manage_form($form, $form_state) {
+  if (isset($form_state['show_confirm'])) {
+    $form['confirm_message'] = array(
+      '#type' => 'item',
+      '#markup' => format_plural(count($form_state['pids_to_delete']),
+      'Are you sure you want to delete the 1 object?',
+      'Are you sure you want to delete the @count objects?'),
+    );
+    $form['confirm_submit'] = array(
+      '#type' => 'submit',
+      '#value' => t('Confirm'),
+      '#weight' => 2,
+      '#submit' => array('islandora_orphaned_objects_manage_confirm_submit'),
+    );
+    $form['cancel_submit'] = array(
+      '#type' => 'submit',
+      '#value' => t('Cancel'),
+      '#weight' => 3,
+    );
+  }
+  else {
+    $orphaned_objects = islandora_orphaned_objects_get_orphaned_objects();
+    $rows = array();
+    foreach ($orphaned_objects as $orphaned_object) {
+      $pid = $orphaned_object['object']['value'];
+      if (islandora_namespace_accessible($pid)) {
+        $rows[$pid] = array(l($orphaned_object['title']['value'] . " (" . $pid . ")", "islandora/object/$pid"));
+      }
+    }
+    ksort($rows);
+    $form['management_table'] = array(
+      '#type' => 'tableselect',
+      '#header' => array(t('Object')),
+      '#options' => $rows,
+      '#attributes' => array(),
+      '#empty' => t('No orphaned objects were found.'),
+    );
+    if (!empty($rows)) {
+      $form['submit_selected'] = array(
+        '#type' => 'submit',
+        '#name' => 'islandora-orphaned-objects-submit-selected',
+        '#validate' => array('islandora_orphaned_objects_manage_delete_selected_validate'),
+        '#submit' => array('islandora_orphaned_objects_manage_delete_submit'),
+        '#value' => t('Delete Selected'),
+      );
+      $form['submit_all'] = array(
+        '#type' => 'submit',
+        '#name' => 'islandora-orphaned-objects-submit-all',
+        '#submit' => array('islandora_orphaned_objects_manage_delete_submit'),
+        '#value' => t('Delete All'),
+      );
+    }
+  }
+  return $form;
+}
+/**
+ * Validation for the Islandora Orphaned Objects management form.
+ *
+ * @param array $form
+ *   An array representing a form within Drupal.
+ * @param array $form_state
+ *   An array containing the Drupal form state.
+ */
+function islandora_orphaned_objects_manage_delete_selected_validate($form, $form_state) {
+  $selected = array_filter($form_state['values']['management_table']);
+  if (empty($selected)) {
+    form_error($form['management_table'], t('At least one object must be selected to delete!'));
+  }
+}
+/**
+ * Submit handler for the delete buttons in the workflow management form.
+ *
+ * @param array $form
+ *   An array representing a form within Drupal.
+ * @param array $form_state
+ *   An array containing the Drupal form state.
+ */
+function islandora_orphaned_objects_manage_delete_submit(&$form, &$form_state) {
+  if ($form_state['triggering_element']['#name'] == 'islandora-orphaned-objects-submit-selected') {
+    $selected = array_keys(array_filter($form_state['values']['management_table']));
+  }
+  else {
+    $selected = array_keys($form_state['values']['management_table']);
+  }
+  $form_state['pids_to_delete'] = $selected;
+  // Rebuild to show the confirm form.
+  $form_state['rebuild'] = TRUE;
+  $form_state['show_confirm'] = TRUE;
+}
+/**
+ * Submit handler for the workflow management confirm form.
+ *
+ * @param array $form
+ *   An array representing a form within Drupal.
+ * @param array $form_state
+ *   An array containing the Drupal form state.
+ */
+function islandora_orphaned_objects_manage_confirm_submit($form, &$form_state) {
+  $batch = islandora_orphaned_objects_delete_create_batch($form_state['pids_to_delete']);
+  batch_set($batch);
+}
+
+/**
+ * Query for orphaned objects.
+ *
+ * @return array
+ *   An array containing the results of the orphaned objects queries.
+ */
+function islandora_orphaned_objects_get_orphaned_objects() {
+  $connection = islandora_get_tuque_connection();
+  // First query: get standard objects.
+  $object_query = <<<EOQ
+SELECT ?object ?collection ?title
+WHERE {
+  ?object <fedora-model:hasModel> <info:fedora/fedora-system:FedoraObject-3.0> ;
+               <fedora-rels-ext:isMemberOfCollection> ?collection .
+  ?object <fedora-model:label> ?title;
+  OPTIONAL {
+    ?collection <fedora-model:hasModel> ?model .
+  }
+  FILTER(!bound(?model))
+}
+EOQ;
+  // Second query: get paged objects.
+  $paged_query = <<<EOQ
+SELECT ?object ?book ?title
+WHERE {
+  ?object <fedora-model:hasModel> <info:fedora/fedora-system:FedoraObject-3.0> ;
+             <fedora-rels-ext:isMemberOf> ?book .
+  ?object <fedora-model:label> ?title;
+  OPTIONAL {
+    ?book <fedora-model:hasModel> ?model .
+  }
+   FILTER(!bound(?model))
+  }
+EOQ;
+  $optionals = (array) module_invoke('islandora_xacml_api', 'islandora_basic_collection_get_query_optionals', 'view');
+  $filter_modules = array(
+    'islandora_xacml_api',
+    'islandora',
+  );
+  $filters = array();
+  foreach ($filter_modules as $module) {
+    $filters = array_merge_recursive($filters, (array) module_invoke($module, 'islandora_basic_collection_get_query_filters', 'view'));
+  }
+  $filter_map = function ($filter) {
+    return "FILTER($filter)";
+  };
+  // Use separate queries for different object types.
+  $sparql_query_objects = format_string($object_query, array(
+    '!optionals' => !empty($optionals) ? ('OPTIONAL {{' . implode('} UNION {', $optionals) . '}}') : '',
+    '!filters' => !empty($filters) ? implode(' ', array_map($filter_map, $filters)) : '',
+  ));
+  $sparql_query_paged = format_string($paged_query, array(
+    '!optionals' => !empty($optionals) ? ('OPTIONAL {{' . implode('} UNION {', $optionals) . '}}') : '',
+    '!filters' => !empty($filters) ? implode(' ', array_map($filter_map, $filters)) : '',
+  ));
+  $object_results = $connection->repository->ri->sparqlQuery($sparql_query_objects);
+  $paged_results = $connection->repository->ri->sparqlQuery($sparql_query_paged);
+  // Merge results of both queries into a single variable and return.
+  $results = array_merge($object_results, $paged_results);
+  return $results;
+}
+
+/**
+ * Constructs the batch that will go out and delete objects.
+ *
+ * @param array $pids
+ *   The array of pids to be deleted.
+ *
+ * @return array
+ *   An array detailing the batch that is about to be run.
+ */
+function islandora_orphaned_objects_delete_create_batch($pids) {
+  // Set up a batch operation.
+  $batch = array(
+    'operations' => array(
+      array('islandora_orphaned_objects_delete_batch_operation', array($pids)),
+    ),
+    'title' => t('Deleting the selected objects...'),
+    'init_message' => t('Preparing to delete objects.'),
+    'progress_message' => t('Time elapsed: @elapsed <br/>Estimated time remaining @estimate.'),
+    'error_message' => t('An error has occurred.'),
+    'finished' => 'islandora_orphaned_objects_delete_batch_finished',
+    'file' => drupal_get_path('module', 'islandora_orphaned_objects') . '/includes/batch.inc',
+  );
+  return $batch;
+}
+/**
+ * Constructs and performs the deleting batch operation.
+ *
+ * @param array $pids
+ *   An array of pids to be deleted.
+ * @param array $context
+ *   The context of the Drupal batch.
+ */
+function islandora_orphaned_objects_delete_batch_operation($pids, &$context) {
+  if (empty($context['sandbox'])) {
+    $context['sandbox'] = array();
+    $context['sandbox']['progress'] = 0;
+    $context['sandbox']['pids'] = $pids;
+    $context['sandbox']['total'] = count($pids);
+    $context['results']['success'] = array();
+  }
+  if (!empty($context['sandbox']['pids'])) {
+    $target_pid = array_pop($context['sandbox']['pids']);
+    $target_object = islandora_object_load($target_pid);
+    $context['message'] = t('Deleting @label (@pid) (@current of @total)...', array(
+        '@label' => $target_object->label,
+        '@pid' => $target_object->pid,
+        '@current' => $context['sandbox']['progress'],
+        '@total' => $context['sandbox']['total'],
+    ));
+    islandora_delete_object($target_object);
+    $context['results']['success'][] = $target_pid;
+    $context['sandbox']['progress']++;
+  }
+  $context['finished'] = ($context['sandbox']['total'] == 0) ? 1 : ($context['sandbox']['progress'] / $context['sandbox']['total']);
+}
+/**
+ * Finished function for the orphaned objects delete batch.
+ *
+ * @param bool $success
+ *   Whether the batch was successful or not.
+ * @param array $results
+ *   An array containing the results of the batch operations.
+ * @param array $operations
+ *   The operations array that was used in the batch.
+ */
+function islandora_orphaned_objects_delete_batch_finished($success, $results, $operations) {
+  if ($success) {
+    $message = format_plural(count($results['success']), 'One object deleted.', '@count objects deleted.');
+  }
+  else {
+    $message = t('Finished with an error.');
+  }
+  drupal_set_message($message);
+}
--- a/islandora.module
+++ b/islandora.module
@ -397,7 +397,14 @@ function islandora_menu() {
    'type' => MENU_NORMAL_ITEM,
    'access arguments' => array(ISLANDORA_MANAGE_DELETED_OBJECTS),
  );
-
+  $items['admin/reports/orphaned_objects/list'] = array(
+    'title' => 'Orphaned objects',
+    'description' => 'List of orphaned objects.',
+    'page callback' => 'drupal_get_form',
+    'page arguments' => array('islandora_orphaned_objects_manage_form'),
+    'access arguments' => array('manage orphaned objects'),
+    'file' => 'includes/orphaned_objects.inc',
+  );
  $items['admin/islandora/restore/manage'] = array(
    'description' => 'Restore or permanantly remove objects with Deleted status',
    'title' => 'Manage Deleted Objects',