islandora_checksum_audit.module

<?php

/**
 * @file
 * The Islandora Checksum Audit module file.
 */

/**
 * Implements hook_menu().
 */
function islandora_checksum_audit_menu() {
  $items = array();
  $items['islandora/object/%islandora_object/manage/checksum_audit_details/%'] = array(
    'title callback' => 'islandora_checksum_audit_details_title',
    'title arguments' => array(2, 5),
    'page callback' => 'islandora_checksum_audit_details',
    'access arguments' => array(ISLANDORA_METADATA_EDIT),
    'type' => MENU_NORMAL_ITEM,
    'page arguments' => array(2, 5),
  );
  return $items;
}

/**
 * Implements hook_admin_paths_alter().
 */
function islandora_checksum_audit_admin_paths_alter(&$paths) {
  $paths['islandora/object/%islandora_object/manage/checksum_audit_details/%'] = TRUE;
}

/**
 * Page callback.
 *
 * @param AbstractObject $islandora_object
 *   The Islandora object.
 * @param string $dsid
 *   The datastream ID.
 *
 * @return string
 *   The overlay page content.
 */
function islandora_checksum_audit_details(AbstractObject $islandora_object, $dsid) {
  $dsid = trim($dsid);
  module_load_include('inc', 'islandora_checksum_audit', 'includes/utilities');
  $foxml = islandora_checksum_audit_get_foxml($islandora_object->id);
  $fixity_checks = islandora_checksum_audit_get_fixity_checks($foxml);

  $header = array(
    'audit_id' => t('Audit record ID'),
    'date' => t('Date'),
    'event' => t('Event'),
  );

  if (isset($fixity_checks[$dsid]['valid'])) {
    $valid_subset = $fixity_checks[$dsid]['valid'];
    $valid_rows = array();
    foreach ($valid_subset as $valid_id => $valid_details) {
      $valid_rows[] = array(
        'audit_id' => $valid_id,
        'date' => $valid_details['date'],
        'event' => $valid_details['event'],
      );
    }
  }

  if (isset($fixity_checks[$dsid]['invalid'])) {
    $invalid_subset = $fixity_checks[$dsid]['invalid'];
    $invalid_rows = array();
    foreach ($invalid_subset as $invalid_id => $invalid_details) {
      $invalid_rows[] = array(
        'audit_id' => $invalid_id,
        'date' => $invalid_details['date'],
        'event' => $invalid_details['event'],
      );
    }
  }

  $output = '';
  if (isset($fixity_checks[$dsid]['valid'])) {
    $output .= '<h4>' . t('Successful validation events') . '</h4>';
    $output .= theme('table', array('header' => $header, 'rows' => $valid_rows));
  }

  if (isset($fixity_checks[$dsid]['invalid'])) {
    $output .= '<h4>' . t('Failed validation events') . '</h4>';
    $output .= theme('table', array('header' => $header, 'rows' => $invalid_rows));
  }

  return $output;
}

/**
 * Page title callback function.
 */
function islandora_checksum_audit_details_title(AbstractObject $islandora_object, $dsid) {
  return t('Checksum events for @pid / @dsid', array('@pid' => $islandora_object->id, '@dsid' => $dsid));
}

/**
 * Theme preprocess function.
 */
function islandora_checksum_audit_preprocess_islandora_default_edit(&$variables) {
  module_load_include('inc', 'islandora_checksum_audit', 'includes/utilities');

  $variables['datastream_table']['header'][] = array('data' => t('Checksum audit'));
  $islandora_object = $variables['islandora_object'];
  $rows = $variables['datastream_table']['rows'];

  $foxml = islandora_checksum_audit_get_foxml($islandora_object->id);
  $fixity_checks = islandora_checksum_audit_get_fixity_checks($foxml);

  foreach ($islandora_object as $ds) {
    $data = '';
    if (isset($fixity_checks[$ds->id])) {
      if (isset($fixity_checks[$ds->id]['valid'])) {
        $num_valid_fixity_checks = count($fixity_checks[$ds->id]['valid']);
        $link = l(t('events'), 'islandora/object/' . $islandora_object->id . '/manage/checksum_audit_details/' . $ds->id);
        $data = '<img src="/misc/watchdog-ok.png" /> (' . $num_valid_fixity_checks . ' ' . $link . ')';
      }
      if (isset($fixity_checks[$ds->id]['invalid'])) {
        $num_invalid_fixity_checks = count($fixity_checks[$ds->id]['invalid']);
        $link = l(t('events'), 'islandora/object/' . $islandora_object->id . '/manage/checksum_audit_details/' . $ds->id);
        $data .= '<br /><img src="/misc/watchdog-warning.png" /> (' . $num_invalid_fixity_checks . ' ' . $link . ')';
      }
    }
    else {
      $num_fixity_checks = 0;
      $data = '';
    }

    $checksum_data = array(
      'class' => 'datastream-checksum-audit',
      'data' => $data,
    );

    $checksums[] = $checksum_data;
  }

  for ($i = 0; $i < count($rows); $i++) {
    $rows[$i][] = $checksums[$i];
  }
  $variables['datastream_table']['rows'] = $rows;
}