Drupal modules for browsing and managing Fedora-based digital repositories.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 

402 lines
14 KiB

<?php
/**
* @file
* A list of orphaned Islandora objects.
*/
/**
* Builds the Orphaned Islandora Objects management form.
*
* @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_manage_orphaned_objects_form(array $form, array $form_state) {
if (isset($form_state['show_confirm'])) {
$pids = $form_state['pids_to_delete'];
$form['confirm_message'] = array(
'#type' => 'item',
'#markup' => format_plural(count($form_state['pids_to_delete']),
'Are you sure you want to delete this object? This action cannot be reversed.',
'Are you sure you want to delete these @count objects? This action cannot be reversed.'),
);
if (count($pids) <= 10) {
$form['pids_to_delete'] = array(
'#type' => 'markup',
'#theme' => 'item_list',
'#list_type' => 'ol',
);
$options = array('attributes' => array('target' => '_blank'));
foreach ($pids as $pid) {
$form['pids_to_delete']['#items'][] = l($pid, "/islandora/object/{$pid}", $options);
}
}
$form['confirm_submit'] = array(
'#type' => 'submit',
'#value' => t('Confirm'),
'#weight' => 2,
'#submit' => array('islandora_manage_orphaned_objects_confirm_submit'),
);
$form['cancel_submit'] = array(
'#type' => 'submit',
'#value' => t('Cancel'),
'#weight' => 3,
);
}
else {
drupal_set_message(t('This page lists objects that have at least one parent, according to their RELS-EXT, that does not
exist in the Fedora repository. These orphans might exist due to a failed batch ingest, their parents being deleted,
or a variety of other reasons. Some of these orphans may exist intentionally.
Please be cautious when deleting, as this action is irreversible.'), 'warning');
$orphaned_objects = islandora_get_orphaned_objects();
$query_method = variable_get('islandora_orphaned_objects_backend', 'SPARQL');
module_load_include('inc', 'islandora', 'includes/utilities');
$rows = array();
foreach ($orphaned_objects as $orphaned_object) {
if ($query_method == 'SPARQL') {
$pid = $orphaned_object['object']['value'];
$title = $orphaned_object['title']['value'];
}
elseif ($query_method == 'Solr') {
$pid = $orphaned_object['PID'];
$title = $orphaned_object['object_label'];
}
if (islandora_namespace_accessible($pid)) {
$rows[$pid] = array(l($title . " (" . $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_delete_selected_orphaned_objects_validate'),
'#submit' => array('islandora_delete_orphaned_objects_submit'),
'#value' => t('Delete Selected'),
);
$form['submit_all'] = array(
'#type' => 'submit',
'#name' => 'islandora-orphaned-objects-submit-all',
'#submit' => array('islandora_delete_orphaned_objects_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_delete_selected_orphaned_objects_validate(array $form, array $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_delete_orphaned_objects_submit(array &$form, array &$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_manage_orphaned_objects_confirm_submit(array $form, array &$form_state) {
$batch = islandora_delete_orphaned_objects_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_get_orphaned_objects() {
$query_method = variable_get('islandora_orphaned_objects_backend', 'SPARQL');
if ($query_method == 'Solr') {
// Solr query for all objects.
$collection_field = variable_get('islandora_solr_member_of_collection_field', 'RELS_EXT_isMemberOfCollection_uri_ms');
$label_field = variable_get('islandora_solr_object_label_field', 'fgs_label_s');
$member_field = variable_get('islandora_solr_member_of_field', 'RELS_EXT_isMemberOf_uri_ms');
$params = "PID, " . $label_field . ", " . $collection_field . ", " . $member_field;
$query = "PID:*";
$qp = new islandoraSolrQueryProcessor();
$qp->buildQuery($query);
$qp->solrParams['fl'] = $params;
$qp->solrLimit = 1000000000;
// Check islandora_compound_object filters to include compound children.
if (variable_get('islandora_compound_object_hide_child_objects_solr', TRUE)) {
$fq = variable_get('islandora_compound_object_solr_fq', '-RELS_EXT_isConstituentOf_uri_mt:[* TO *]');
if (!empty($fq)) {
// Delete islandora_compound_object_solr_fq from the list of filters.
$filters = $qp->solrParams['fq'];
if (($key = array_search($fq, $filters)) !== FALSE) {
unset($filters[$key]);
$qp->solrParams['fq'] = $filters;
}
}
}
$qp->executeQuery(FALSE);
try {
$results = $qp->islandoraSolrResult['response']['objects'];
}
catch (Exception $e) {
watchdog_exception('Islandora', $e, 'Got an exception searching for parent objects .', array(), WATCHDOG_ERROR);
$results = array();
}
$orphaned_objects = array();
$already_checked = array();
$missing_parents = array();
// Check all results for PIDs that don't exist.
foreach ($results as $result) {
if (array_key_exists($collection_field, $result['solr_doc'])) {
foreach ($result['solr_doc'][$collection_field] as $collection) {
if (in_array($collection, $missing_parents)) {
$orphaned_objects[] = $result;
}
elseif (!in_array($collection, $already_checked)) {
$test = islandora_identify_missing_parents($collection);
if (!$test) {
$orphaned_objects[] = $result;
$missing_parents[] = $collection;
}
$already_checked[] = $collection;
}
}
}
if (array_key_exists($member_field, $result['solr_doc'])) {
foreach ($result['solr_doc'][$member_field] as $membership) {
if (in_array($membership, $missing_parents)) {
$orphaned_objects[] = $result;
}
elseif (!in_array($membership, $already_checked)) {
$test = islandora_identify_missing_parents($membership);
if (!$test) {
$orphaned_objects[] = $result;
$missing_parents[] = $membership;
}
$already_checked[] = $membership;
}
}
}
}
$results = $orphaned_objects;
}
elseif ($query_method == "SPARQL") {
$connection = islandora_get_tuque_connection();
// SPARQL: get orphaned objects, exclude any with a living parent.
$object_query = <<<EOQ
!prefix
SELECT DISTINCT ?object ?title
WHERE {
?object <fedora-model:hasModel> <info:fedora/fedora-system:FedoraObject-3.0> ;
?p ?otherobject .
?object <fedora-model:label> ?title;
OPTIONAL {
?otherobject <fedora-model:hasModel> ?model .
} .
FILTER (!bound(?model))
# Filter by "parent" relationships
FILTER (!dead_parent_relationships)
# Exclude objects with live parents
OPTIONAL {
!live_parent_relationships .
?liveparent <fedora-model:hasModel> <info:fedora/fedora-system:FedoraObject-3.0> .
}
!optionals
!filters
FILTER (!bound(?liveparent))
} ORDER BY ?object
EOQ;
$parent_relationships = module_invoke_all('islandora_solution_pack_child_relationships', 'all');
$parent_relationships['prefix'] = array_unique($parent_relationships['prefix']);
$parent_relationships['predicate'] = array_unique($parent_relationships['predicate']);
if (count($parent_relationships['predicate']) == 0) {
// No predicates to search for. Exit early.
return array();
}
$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)";
};
$parent_map = function ($parent) {
return "?object $parent ?liveparent";
};
// 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)) : '',
'!dead_parent_relationships' => '?p = ' . implode(' || ?p = ', $parent_relationships['predicate']),
'!live_parent_relationships' => '{' . implode(' } UNION { ', array_map($parent_map, $parent_relationships['predicate'])) . '}',
'!prefix' => implode("\n", $parent_relationships['prefix']),
));
$results = $connection->repository->ri->sparqlQuery($sparql_query_objects);
}
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_delete_orphaned_objects_create_batch(array $pids) {
// Set up a batch operation.
$batch = array(
'operations' => array(
array('islandora_delete_orphaned_objects_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_delete_orphaned_objects_batch_finished',
'file' => drupal_get_path('module', 'islandora') . '/includes/orphaned_objects.inc',
);
return $batch;
}
/**
* Solr query to check for deceased parents.
*/
function islandora_identify_missing_parents($parent) {
$parent_params = "PID";
$parent_test = substr($parent, strpos($parent, '/') + 1);
$parent_query = 'PID:"' . $parent_test . '"';
$qp = new islandoraSolrQueryProcessor();
$qp->buildQuery($parent_query);
$qp->solrParams['fl'] = $parent_params;
$qp->solrLimit = 1000000000;
$qp->executeQuery(FALSE);
try {
$parent_results = $qp->islandoraSolrResult['response']['objects'];
}
catch (Exception $e) {
watchdog_exception('Islandora', $e, 'Got an exception searching for parent objects .', array(), WATCHDOG_ERROR);
$parent_results = array();
}
return ($parent_results);
}
/**
* 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_delete_orphaned_objects_batch_operation(array $pids, array &$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_pid,
'@current' => $context['sandbox']['progress'],
'@total' => $context['sandbox']['total'],
));
islandora_delete_object($target_object);
$object_check = islandora_object_load($target_pid);
if ($object_check) {
drupal_set_message(t('Could not delete %pid. You may not have permission to manage this object.',
array(
'%pid' => $target_pid,
)), 'error');
}
else {
$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_delete_orphaned_objects_batch_finished($success, array $results, array $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);
}