islandora/fedora_repository.solutionpacks.inc

<?php

/**
 * @file
 * Invokes a hook to any dependent modules asking them if their
 * installations require any fedora objects to be present.
 * Modules implementing this hook should return an array
 * of arrays of the form:
 *
 * array( 'pid', 'path-to-foxml-file',
 *   'dsid',
 *   'path-to-datastream-file',
 *   int dsversion)
 *
 * where the last three options are optional.
 * A module can either point to a simple foxml file to install,
 * or can specify a datastreamstream to check for, with a
 * path to load the datastream from if it isn't there.
 * Optionally a version number can be included,
 * to enable updating of content model or collection policy streams
 * that may have been updated.
 * This is a simple whole number that should be incremented when changed.
 * This value appears in as an attribute of the topmost element of the stream,
 * e.g.,:
 *
 * <?xml version="1.0" encoding="utf-8"?>
 * <content_model name="Collection" version="2" ...
 *
 * Datastreams which don't have this element are assumed to be at version 0.
 */

/**
 * Builds the tab for the solution packs.
 */
function fedora_repository_solution_packs_page() {
  $enabled_solution_packs = module_invoke_all('fedora_repository_required_fedora_objects');
  $output = '';
  foreach ($enabled_solution_packs as $solution_pack_module => $solution_pack_info) {
    $objects = array();
    foreach ($solution_pack_info as $field => $value) {
      switch ($field) {
        case 'title':
          $solution_pack_name = $value;
          break;
        case 'objects':
          $objects = $value;
          break;
      }
    }
    $output .= drupal_get_form('fedora_repository_solution_pack_form_' . $solution_pack_module, $solution_pack_module, $solution_pack_name, $objects);
  }

  return $output;
}

/**
 * Check for installed objects and add a 'Update' or 'Install' button if
 * some objects are missing.
 *
 * @param array &$form_state
 *   The current state of the form.
 * @param unknown $solution_pack_module
 *   Module name of that solution pack.
 * @param string $solution_pack_name
 *   Human readable name for the solution pack.
 * @param array $objects
 *   Defaults to an empty array.
 */
function fedora_repository_solution_pack_form(&$form_state, $solution_pack_module, $solution_pack_name, $objects = array()) {

  // Check each object to see if it is in the repository.
  module_load_include('inc', 'fedora_repository', 'api/fedora_item');
  global $base_path;
  $needs_update = FALSE;
  $needs_install = FALSE;
  $form = array();

  $form['solution_pack_module'] = array(
    '#type' => 'hidden',
    '#value' => $solution_pack_module,
  );

  if (!$form_state['submitted']) {
    $form['solution_pack_name'] = array(
      '#type' => 'markup',
      '#value' => t($solution_pack_name),
      '#prefix' => '<h3>',
      '#suffix' => '</h3>',
    );
    $form['objects'] = array(
      '#type' => 'fieldset',
      '#title' => "Objects",
      '#weight' => 10,
      '#attributes' => array('class' => 'collapsed'),
      '#collapsible' => TRUE,
      '#collapsed' => TRUE,
    );
    $table_header = array('PID', 'Status');
    $table_rows = array();

    foreach ($objects as $object) {
      $datastreams = NULL;
      if (isset($object['pid'])) {
        $pid = $object['pid'];

        $item = new Fedora_Item($pid);
        $table_row = array($object['pid']);
        $object_status = t('Up-to-date');
        if (!$item->exists()) {
          $object_status = 'Missing';
          $needs_install = TRUE;
        }
        else {
          if (isset($object['dsid']) && isset($object['datastream_file']) && isset($object['dsversion'])) {
            $datastreams = array(
              array(
                'dsid' => $object['dsid'],
                'datastream_file' => $object['datastream_file'],
                'dsversion' => $object['dsversion'],
              ),
            );
          }
          elseif (!empty($object['datastreams'])) {
            $datastreams = $object['datastreams'];
          }
          if (!empty($datastreams) && is_array($datastreams)) {
            foreach ($datastreams as $ds) {
              $ds_list = $item->get_datastreams_list_as_array();
              if (!array_key_exists($ds['dsid'], $ds_list)) {
                $needs_update = TRUE;
                $object_status = 'Missing datastream';
                break;
              }
              elseif (isset($ds['dsversion'])) {
                // Check if the datastream is versioned and needs updating.
                $installed_version = fedora_repository_get_islandora_datastream_version($item, $ds['dsid']);
                $available_version = fedora_repository_get_islandora_datastream_version(NULL, NULL, $ds['datastream_file']);

                if ($available_version > $installed_version) {
                  $needs_update = TRUE;
                  $object_status = 'Out of date';
                  break;
                }
              }
            }
          }
        }
        array_push($table_row, $object_status);
        $table_rows[] = $table_row;
      }
    }
    $form['objects']['table'] = array(
      '#type' => 'markup',
      '#value' => theme_table($table_header, $table_rows),
    );
  }

  $form['install_status'] = array(
    '#type' => 'markup',
    '#prefix' => '<strong>' . t('Object status:') . '&nbsp;</strong>',
    '#suffix' => '&nbsp;',
  );
  if (!$needs_install && !$needs_update) {
    $form['install_status']['#value'] = theme_image('misc/watchdog-ok.png') . t('All required objects are installed and up-to-date.');
        $submit_button_text = t("Force Reinstallation of Fedora Objects");

  }
  else {
    $form['install_status']['#value'] = theme_image('misc/watchdog-warning.png') . t('Some objects must be re-ingested. See Objects list for details.');
        $submit_button_text = t("Install Fedora Objects");

  }
  $form['submit'] = array(
    '#value' => $submit_button_text,
    '#type' => 'submit',
    '#name' => $solution_pack_module,
  );

  $form['#submit'] = array(
    'fedora_repository_solution_pack_form_submit',
  );
  return $form;
}

/**
 * Submit handler for solution pack form.
 *
 * @param array $form
 *   The form submitted.
 * @param array_reference $form_state
 *   The state of the form submited.
 */
function fedora_repository_solution_pack_form_submit($form, &$form_state) {

  $module_name = $form_state['values']['solution_pack_module'];

  $solution_pack_info = module_invoke($module_name, 'required_fedora_objects');

  $batch = array(
    'title' => t('Installing / updating solution pack objects'),
    'file' => drupal_get_path('module', 'fedora_repository') . '/fedora_repository.module',
    'operations' => array(),
  );


  foreach ($solution_pack_info[$module_name]['objects'] as $object) {
    // Add this object to the batch job queue.
    // Module name is needed in the finished callback.
    $batch['operations'][] = array('fedora_repository_batch_reingest_object', array($object, $module_name));
  }

  // Tell the batch to call the function to send out a postprocess hook.
  $batch['finished'] = 'fedora_repository_solutionpack_send_postprocess';

  batch_set($batch);

}

/**
 * Writes a form entry into the database.
 *
 * @param string $form_name
 *   The name of the form.
 * @param unknown_type $form_xml
 *   The form definition.
 */
function solution_pack_add_form($form_name, $form_xml) {
  $result = db_result(db_query('Select name from {xml_forms} where name = "%s"', $form_name));
  if (!$result) {
    $object = new stdClass();
    $object->name = $form_name;
    $object->form = $form_xml;
    $result = drupal_write_record('xml_forms', $object);
    drupal_set_message(t("Added @name", array("@name" => $form_name)));
  }
}

/**
 * Writes a form association to the database
 *
 * @param string $content_model
 *   content model PID
 * @param string $form_name
 *   Name of the form
 */
function solution_pack_add_form_association($content_model, $form_name) {
  $result = db_result(db_query('Select content_model from {islandora_content_model_forms} where  content_model = "%s" and form_name = "%s"',
              $content_model, $form_name));
  if (!$result) {
    $object = new stdClass();
    $object->content_model = $content_model;
    $object->form_name = $form_name;
    $object->dsid = 'MODS';
    $object->title_field = "['titleInfo']['title']";
    $object->transform = 'mods_to_dc.xsl';
    $result = drupal_write_record('islandora_content_model_forms', $object);
    drupal_set_message(t("Added association between @cm and @name", array("@cm" => $content_model, "@name" => $form_name)));
  }
}


module_load_include('inc', 'fedora_repository', 'fedora_repository.test');

/**
 * Class containing tests that are common to all solution packs.
 */
abstract class SolutionPackTestCase extends IslandoraTestCase {
 
  /**
   *  Tests the fedora_repository_required_fedora_objects hook.
   *
   *  Validates the schema of the array returned by the hook.  The array should
   *  be roughly of the form:
   *    [
   *      module_name => 
   *      [
   *        'module' => module_name,
   *        'title' => module_title,
   *        'objects' =>
   *        [
   *          ...
   *        ]
   *      ]
   *    ]
   *
   *  Where each entry of the 'objects' sub-array should be arrays themselves,
   *  each containing the information needed for drupal_get_form().
   *
   *  Note that the root key of the array is the actual module name (e.g. 
   *  islandora_audio_sp, islandora_image_sp, etc...), not 'module_name'
   */
  public function testFedoraRepositoryRequiredFedoraObjects() {
    
    // Invoke the hook
    $results = module_invoke($this->getModuleShortFormName(), 'fedora_repository_required_fedora_objects');

    // Validate the schema of the returned data structure
    $this->assertNotNull($results, 'A non-null result was returned from the fedora_repository_required_fedora_objects hook.');
    $this->assertTrue(is_array($results), 'An array was returned from the fedora_repository_required_fedora_objects hook.');
    $this->assertTrue(array_key_exists($this->getModuleShortFormName(), $results), "Returned array has top level key that is equal to the module's short form name");
    $this->assertTrue(is_array($results[$this->getModuleShortFormName()]), "Value associated with top level key that is equal to the module's short form name is an array");
    $this->assertTrue(array_key_exists('module', $results[$this->getModuleShortFormName()]), "Top level array has 'module' key");
    $this->assertEqual($results[$this->getModuleShortFormName()]['module'], $this->getModuleShortFormName(), "Value associated with 'module' key is equal to the module's short form name");
    $this->assertTrue(array_key_exists('title', $results[$this->getModuleShortFormName()]), "Top level array has 'title' key");
    $this->assertTrue($results[$this->getModuleShortFormName()]['title'], "Title string is not empty");
    $this->assertTrue(array_key_exists('objects', $results[$this->getModuleShortFormName()]), "Returned array has second level key equal to 'object'");
    $this->assertTrue(is_array($results[$this->getModuleShortFormName()]['objects']), "Value associated with second level 'object' key is an array");
  }
}