content_model_viewer.admin.inc

<?php

// $Id$

/**
 * @file
 *
 * Defines a collection of functions and forms that appear in the admin section of the site. They allow the user 
 * to provided settings for this module.
 */
function template_preprocess_content_model_viewer_custom_settings(array &$variables) {
  module_load_include('inc', 'fedora_repository', 'api/fedora_item');
  $pid = $variables['pid'];
  $item = new Fedora_Item($pid);
  if (!$item->exists()) {
    drupal_set_message(t('The Fedora Object %pid does not exist.', array('%pid' => $pid)), 'error');
    drupal_not_found();
    exit();
  }
  if (!content_model_viewer_model_has_settings($pid)) {
    drupal_set_message(t('The Fedora Object %pid doesn\'t have any custom settings.', array('%pid' => $pid)), 'error');
    drupal_not_found();
    exit();
  }
  $variables['model_id'] = content_model_viewer_get_model_id($pid);
}

/**
 * Provides a form that allows the user to add/remove Custom Settings for this module, on a per Content Model basis.
 * 
 * List all Content Model's that have defined custom settings. 
 * 
 * @param array $form_state
 *   The Drupal Form State.
 * 
 * @return array 
 *   A Drupal Form.
 */
function content_model_viewer_custom_settings_form(array &$form_state) {
  module_load_include('inc', 'fedora_repository', 'api/fedora_item');
  $variables['content_models'] = array();
  $result = db_query('SELECT * FROM {content_model_viewer_models} WHERE id > 1');
  $models = array(
    '#header' => array('Content Model', 'PID', 'Edit Settings', 'Delete Settings'),
    '#theme' => 'content_model_viewer_form_table',
  );
  while ($row = db_fetch_object($result)) {
    $item = new Fedora_Item($row->pid);
    $models[] = array(
      '#tree' => TRUE,
      'label' => array('#value' => $item->objectProfile->objLabel),
      'pid' => array('#value' => $row->pid),
      'edit' => array('#value' => l('Edit', "admin/settings/content_model_viewer/{$row->pid}/edit")),
      'delete' => array(
        '#type' => 'submit',
        '#value' => 'Delete',
        '#pid' => $row->pid, // Default.
        '#name' => 'delete-dsid-rule' . $row->pid,
        '#submit' => array('content_model_viewer_delete_setting'),
      )
    );
  }
  $models['add'] = array(
    'content_model' => array(
      '#type' => 'textfield',
      '#title' => 'Content Model',
      '#autocomplete_path' => 'admin/settings/content_model_viewer/form/autocomplete/models',
      '#description' => 'Choose a Content Model to customize. If the content model is already listed please follow the <b>Edit</b> link.',
      '#default_value' => isset($form_state['values']['content_model']) ? $form_state['values']['content_model'] : NULL,
    ),
    0 => array('#value' => ''), // Filler
    1 => array('#value' => ''), // Filler
    'submit' => array(
      '#type' => 'submit',
      '#value' => 'Customize',
      '#model_id' => 1, // Default.
      '#submit' => array('content_model_viewer_add_setting'),
      '#validate' => array('content_model_viewer_add_setting_validate'),
    ),
  );
  $form = array(
    'fieldset' => array(
      '#type' => 'fieldset',
      '#title' => 'Content Model Custom Settings',
      '#description' => t('Listed below are all the Content Model that implement custom rules for the Content Viewer.'),
      'models' => $models
    )
  );
  return $form;
}

/**
 * Autocomplete the Content Model name.
 * 
 * Used by the 'content_model_viewer_custom_settings_form'.
 * 
 * @param string $string
 *   The users input.
 * 
 * @return string
 *   A json encoded string containing all the options the user can select.
 */
function content_model_viewer_autocomplete_models($string) {
  $content_models = content_model_viewer_get_available_models();
  $output = array($string => $string);
  $match = strtolower($string);
  foreach ($content_models as $key => $content_model) {
    if (preg_match("/^{$match}/i", $content_model) !== 0 && !content_model_viewer_model_has_settings($content_model)) {
      $output[$content_model] = $content_model;
    }
  }
  return drupal_json($output);
}

/**
 * Validates the add custom setting form.
 * 
 * Called from the 'content_model_viewer_custom_settings_form', when the Customize button is pressed.
 * 
 * @param array $form
 *   The Drupal Form.
 * @param array $form_state
 *   The Drupal Form State.
 */
function content_model_viewer_add_setting_validate(array $form, array &$form_state) {
  $pid = $form_state['values']['content_model'];
  if (empty($pid)) {
    form_set_error('content_model', t('field is required.'));
  }
  $item = new Fedora_Item($pid);
  if (!$item->exists()) {
    form_set_error('content_model', "The fedora object {$pid} does not exists.");
  }
  if (content_model_viewer_model_has_settings($pid)) {
    form_set_error('content_model', "The content model {$pid} already has custom settings. Click on the edit link above to change them.");
  }
}

/**
 * Submits the add custom setting form.
 * 
 * Called from the 'content_model_viewer_custom_settings_form', when the Customize button is pressed.
 * Redirects the user to the edit page for the new custom setting form.
 * 
 * @param array $form
 *   The Drupal Form.
 * @param array $form_state
 *   The Drupal Form State.
 */
function content_model_viewer_add_setting(array $form, array &$form_state) {
  $pid = $form_state['values']['content_model'];
  $object = new stdClass();
  $object->pid = $pid;
  drupal_write_record('content_model_viewer_models', $object);
  $model_id = content_model_viewer_get_model_id($pid);
  $row = new stdClass();
  $row->model_id = $model_id; // @todo incorporate this into its own function, so external modules can install defaults...
  $hidden = array('^POLICY$', '^DC$', '^RELS-EXT$', '^RELS-INT$', '^ISLANDORACM$');
  foreach ($hidden as $hide) {
    $row->dsid = $hide;
    $row->view = $row->download = 0;
    drupal_write_record(CONTENT_MODEL_VIEWER_DATASTREAM_DSID_RULES_TABLE, $row);
  }
  $form_state['redirect'] = "admin/settings/content_model_viewer/$pid/edit";
}

/**
 * Deletes the settings associated with a given model.
 * 
 * Called from the 'content_model_viewer_custom_settings_form', when a Delete button is pressed.
 * 
 * @param array $form
 *   The Drupal Form.
 * @param array $form_state 
 *   The Drupal Form State.
 */
function content_model_viewer_delete_setting(array $form, array &$form_state) {
  $pid = $form_state['clicked_button']['#pid'];
  db_query('DELETE FROM content_model_viewer_models WHERE pid = "%s"', $pid);
  drupal_set_message(t('Successfully removed settings for ') . $pid . '.');
  drupal_goto('admin/settings/content_model_viewer');
}

/**
 * Gets the default datastream rules form. Responsible for setting the default View/Download behavior of datastreams.
 * 
 * @param array $form_state
 *   The Drupal Form State.
 * @param int $model_id
 *   The settings ID.
 * 
 * @return array
 *   The Drupal Form.
 */
function content_model_viewer_datastream_default_rules_form(array &$form_state, $model_id = 1) {
  $view = db_result(db_query('SELECT view FROM %s WHERE id = "%d"', CONTENT_MODEL_VIEWER_SETTINGS_TABLE, $model_id));
  $download = db_result(db_query('SELECT download FROM %s WHERE id = "%d"', CONTENT_MODEL_VIEWER_SETTINGS_TABLE, $model_id));
  return array(
    'datastreams' => array(
      '#type' => 'fieldset',
      '#title' => t('Default Datastream Display Rules (View/Download)'),
      '#description' => t('<p>Datastream rules only apply to datastreams shown in the Overview/Viewer tab panels.
        The <b>View</b> and <b>Download</b> properties specifiy what actions will be be avalible to the end user.
        If both <b>View</b> and <b>Download</b> are <b>Prohibited</b> then the selected datastreams won\'t appear 
        in the files section of the Overview/Viewer tab panels.</p>'),
      'view' => array(
        '#type' => 'select',
        '#title' => t('Default Datastream View Behavior'),
        '#description' => t('If no MIME type or Datastream ID rules match below then this defines if the end user is able to view the Datastream or not.'),
        '#options' => array(0 => 'Prohibit', 1 => 'Permit'),
        '#default_value' => $view,
      ),
      'download' => array(
        '#type' => 'select',
        '#title' => t('Default Datastream Download Behavior'),
        '#description' => t('If no MIME type or Datastream ID rules match below then this defines if the end user is able to download the Datastream or not.'),
        '#options' => array(0 => 'Prohibit', 1 => 'Permit'),
        '#default_value' => $download,
      ),
      'submit' => array(
        '#type' => 'submit',
        '#model_id' => $model_id,
        '#value' => 'Set Defaults'
      )
    )
  );
}

/**
 * Sets the default view/download datastream properties for this viewer.
 * 
 * @param array $form
 *   The Drupal Form.
 * @param array $form_state 
 *   The Drupal Form State.
 */
function content_model_viewer_datastream_default_rules_form_submit(array $form, array &$form_state) {
  if (isset($form_state['clicked_button']['#model_id'])) {
    $update = array(
      'view' => $form_state['values']['view'],
      'download' => $form_state['values']['download'],
    );
    foreach ($update as $column => $value) {
      db_query('UPDATE %s SET %s = "%d" where id = "%d"', CONTENT_MODEL_VIEWER_SETTINGS_TABLE, $column, $value, $form_state['clicked_button']['#model_id']);
    }
  }
}

/**
 * Gets the Datastream rules form.
 * 
 * Lists all the existing rules, and provides several fields for adding additional rules.
 * 
 * @param array $form_state
 *   The Drupal Form State.
 * @param int $model_id
 *   The Model associated with the datastream rule.
 *
 * @return array 
 *   A Drupal Form.
 */
function content_model_viewer_datastream_mimetype_rules_form($form_state, $model_id = 1) {
  /**
   * Display the existing MIME type rules.
   */
  $rows = array(
    '#header' => array(t('MIME Type'), t('View'), t('Download'), ''),
    '#theme' => 'content_model_viewer_form_table',
  );
  $query = db_query("SELECT * FROM %s WHERE model_id = '%d'", CONTENT_MODEL_VIEWER_DATASTREAM_MIMETYPE_RULES_TABLE, $model_id);
  while ($row = db_fetch_array($query)) {
    $rows[] = array(
      '#tree' => TRUE,
      'mime' => array('#value' => $row['mime']),
      'view' => array('#value' => $row['view'] ? t('Permit') : t('Prohibit')),
      'download' => array('#value' => $row['download'] ? t('Permit') : t('Prohibit')),
      'remove' => array(
        '#type' => 'submit',
        '#value' => 'Delete',
        '#name' => 'delete-mime-rule' . $row['id'],
        '#rule_id' => $row['id'],
        '#submit' => array('content_model_viewer_delete_datastream_mimetype_rule')
      )
    );
  }
  /**
   * Add a row that has input for adding additional rules.
   */
  $rows['add'] = array(
    'mime' => array(
      '#type' => 'textfield',
      '#title' => t(''),
      '#description' => t('A valid MIME Type.'),
      '#size' => 60,
    ),
    'view' => array(
      '#type' => 'select',
      '#options' => array(0 => 'Prohibit', 1 => 'Permit')
    ),
    'download' => array(
      '#type' => 'select',
      '#options' => array(0 => 'Prohibit', 1 => 'Permit')
    ),
    'add' => array(
      '#type' => 'submit',
      '#value' => 'Add',
      '#model_id' => $model_id, // Default.
      '#submit' => array('content_model_viewer_add_datastream_mimetype_rule'),
      '#validate' => array('content_model_viewer_add_datastream_mimetype_rule_validate'),
    )
  );
  return array(
    'fieldset' => array(
      '#type' => 'fieldset',
      '#title' => t('Datastream Display Rules (MIME Type)'),
      '#description' => t('<p>If a given datastream has the same MIME type as defined by one of these rules the <b>View</b> and <b>Download</b> properties defined here will take precedent over the default properties.</p>'),
      /**
       * A bit of a hack, I want the default action here to be add not delete, 
       * so I've mirrored the add button and placed it at the begining of the form. 
       * Making it hidden, so it will be the default action.
       */
      'add' => array(
        '#type' => 'submit',
        '#value' => 'Add',
        '#model_id' => $model_id, // Default.
        '#submit' => array('content_model_viewer_add_datastream_mimetype_rule'),
        '#validate' => array('content_model_viewer_add_datastream_mimetype_rule_validate'),
        '#attributes' => array('style' => 'position: absolute; left: -9999px; width: 1px; height: 1px;'),
      ),
      'rows' => $rows
    )
  );
}

/**
 * Gets the Datastream rules form.
 * 
 * Lists all the existing rules, and provides several fields for adding additional rules.
 * 
 * @param array $form_state
 *   The Drupal Form State.
 * @param int $model_id
 *   The Model associated with the datastream rule.
 *
 * @return array 
 *   A Drupal Form.
 */
function content_model_viewer_datastream_dsid_rules_form($form_state, $model_id = 1) {
  /**
   * Display the existing Datastream ID rules.
   */
  $rows = array(
    '#header' => array(t('Datastream ID'), t('Match Type'), t('View'), t('Download'), ''),
    '#theme' => 'content_model_viewer_form_table',
  );
  $query = db_query("SELECT * FROM %s WHERE model_id = '%d'", CONTENT_MODEL_VIEWER_DATASTREAM_DSID_RULES_TABLE, $model_id);
  while ($row = db_fetch_array($query)) {
    $rows[] = array(
      '#tree' => TRUE,
      'dsid' => array('#value' => $row['dsid']),
      'type' => array('#value' => $row['type'] ? t('Regex') : t('Exact')),
      'view' => array('#value' => $row['view'] ? t('Permit') : t('Prohibit')),
      'download' => array('#value' => $row['download'] ? t('Permit') : t('Prohibit')),
      'remove' => array(
        '#type' => 'submit',
        '#value' => t('Delete'),
        '#rule_id' => $row['id'],
        '#name' => 'delete-dsid-rule' . $row['id'],
        '#submit' => array('content_model_viewer_delete_datastream_dsid_rule')
      )
    );
  }
  /**
   * Add a row that has input for adding additional rules.
   */
  $rows['add'] = array(
    'dsid' => array(
      '#type' => 'textfield',
      '#title' => t(''),
      '#description' => t('The input for either Exact Match or a PCRE (Perl-Compatible Regular Expression)'),
      '#size' => 60,
    ),
    'type' => array(
      '#type' => 'select',
      '#title' => t(''),
      '#options' => array(0 => t('Exact'), 1 => t('Regex'))
    ),
    'view' => array(
      '#type' => 'select',
      '#options' => array(0 => t('Prohibit'), 1 => t('Permit'))
    ),
    'download' => array(
      '#type' => 'select',
      '#options' => array(0 => t('Prohibit'), 1 => t('Permit'))
    ),
    'add' => array(
      '#type' => 'submit',
      '#value' => t('Add'),
      '#model_id' => $model_id, // Default.
      '#submit' => array('content_model_viewer_add_datastream_dsid_rule'),
      '#validate' => array('content_model_viewer_add_datastream_dsid_rule_validate'),
    )
  );
  return array(
    'fieldset' => array(
      '#type' => 'fieldset',
      '#title' => t('Datastream Display Rules (Datastream ID)'),
      '#description' => t('<p>If a given datastream\'s ID matches one of the rules below the <b>View</b> and <b>Download</b> properties defined here will take precedent over all other rules.</p>'),
      /**
       * A bit of a hack, I want the default action here to be add not delete, 
       * so I've mirrored the add button and placed it at the begining of the form. 
       * Making it hidden, so it will be the default action.
       */
      'add' => array(
        '#type' => 'submit',
        '#value' => t('Add'),
        '#model_id' => $model_id, // Default.
        '#submit' => array('content_model_viewer_add_datastream_dsid_rule'),
        '#validate' => array('content_model_viewer_add_datastream_dsid_rule_validate'),
        '#attributes' => array('style' => 'position: absolute; left: -9999px; width: 1px; height: 1px;')
      ),
      'rows' => $rows
    )
  );
}

/**
 * 
 *
 * 
 * @param array $form_state
 *   The Drupal Form State.
 * @param int $model_id
 *   The Model associated with the datastream rule.
 *
 * @return array 
 *   A Drupal Form.
 */
function content_model_viewer_datastream_rels_view_derived_form($form_state, $model_id = 1) {
  /**
   * Display the existing Datastream ID rules.
   */
  $rows = array(
    '#header' => array(t('MIME type'), t('Select'), t('Match'), t('Match Type'), ''),
    '#theme' => 'content_model_viewer_form_table',
  );
  $query = db_query("SELECT * FROM %s WHERE model_id = '%d'", CONTENT_MODEL_VIEWER_DATASTREAM_RELS_VIEW_DERIVED_RULES_TABLE, $model_id);
  while ($row = db_fetch_array($query)) {
    $rows[] = array(
      '#tree' => TRUE,
      'mime' => array('#value' => $row['mime']),
      'xpath' => array('#value' => $row['xpath']),
      'matching' => array('#value' => $row['matching']),
      'type' => array('#value' => $row['type'] ? t('Regex') : t('Exact')),
      'remove' => array(
        '#type' => 'submit',
        '#value' => t('Delete'),
        '#rule_id' => $row['id'],
        '#name' => 'delete-dsid-rule' . $row['id'],
        '#submit' => array('content_model_viewer_delete_datastream_rels_view_derived_rule')
      )
    );
  }
  /**
   * Add a row that has input for adding additional rules.
   */
  $rows['add'] = array(
    'mime' => array(
      '#type' => 'textfield',
      '#title' => t(''),
      '#description' => t('A valid MIME Type.'),
      '#size' => 20,
    ),
    'xpath' => array(
      '#type' => 'textfield',
      '#title' => t(''),
      '#description' => t('A valid xpath for RELS-INT.'),
      '#size' => 60,
    ),
    'matching' => array(
      '#type' => 'textfield',
      '#title' => t(''),
      '#description' => t('The input for either Exact Match or a PCRE'),
      '#size' => 30,
    ),
    'type' => array(
      '#type' => 'select',
      '#title' => t(''),
      '#options' => array(0 => t('Exact'), 1 => t('Regex'))
    ),
    'add' => array(
      '#type' => 'submit',
      '#value' => t('Add'),
      '#model_id' => $model_id, // Default.
      '#submit' => array('content_model_viewer_add_datastream_rels_view_derived_rule'),
      '#validate' => array('content_model_viewer_add_datastream_rels_view_derived_rule_validate'),
    )
  );
  return array(
    'fieldset' => array(
      '#type' => 'fieldset',
      '#title' => t('Derived Datastream Display Rules (RELS-INT)'),
      '#description' => t('<p>Provides a way to match non-viewable types like PDF\'s with their viewable derived types such as SWF\'s. This set of rules queries the <b>RELS-INT</b> datastream for this relationship information. <b>%dsid%</b> and <b>%pid%</b> can be used in the <b>Select</b> and <b>Match</b> fields below to insert the Datastream ID and Object PID into the value.</p>'),
      /**
       * A bit of a hack, I want the default action here to be add not delete, 
       * so I've mirrored the add button and placed it at the begining of the form. 
       * Making it hidden, so it will be the default action.
       */
      'add' => array(
        '#type' => 'submit',
        '#value' => t('Add'),
        '#model_id' => $model_id, // Default.
        '#submit' => array('content_model_viewer_add_datastream_rels_view_derived_rule'),
        '#validate' => array('content_model_viewer_add_datastream_rels_view_derived_rule_validate'),
        '#attributes' => array('style' => 'position: absolute; left: -9999px; width: 1px; height: 1px;')
      ),
      'rows' => $rows
    )
  );
}

function content_model_viewer_datastream_dsid_view_derived_form($form_state, $model_id = 1) {
  /**
   * Display the existing Datastream ID rules.
   */
  $rows = array(
    '#header' => array(t('Source Datastream ID'), t('Match Type'), t('Derived Datastream ID'), t('Match Type'), ''),
    '#theme' => 'content_model_viewer_form_table',
  );
  $query = db_query("SELECT * FROM %s WHERE model_id = '%d'", CONTENT_MODEL_VIEWER_DATASTREAM_DSID_VIEW_DERIVED_RULES_TABLE, $model_id);
  while ($row = db_fetch_array($query)) {
    $rows[] = array(
      '#tree' => TRUE,
      'src_dsid' => array('#value' => $row['src_dsid']),
      'src_type' => array('#value' => $row['src_type'] ? t('Regex') : t('Exact')),
      'dest_dsid' => array('#value' => $row['dest_dsid']),
      'dest_type' => array('#value' => $row['dest_type'] ? t('Regex') : t('Exact')),
      'remove' => array(
        '#type' => 'submit',
        '#value' => t('Delete'),
        '#rule_id' => $row['id'],
        '#name' => 'delete-dsid-rule' . $row['id'],
        '#submit' => array('content_model_viewer_delete_datastream_dsid_view_derived_rule')
      )
    );
  }
  /**
   * Add a row that has input for adding additional rules.
   */
  $rows['add'] = array(
    'src_dsid' => array(
      '#type' => 'textfield',
      '#title' => t(''),
      '#description' => t('The input for either Exact Match or a PCRE'),
      '#size' => 30,
    ),
    'src_type' => array(
      '#type' => 'select',
      '#title' => t(''),
      '#options' => array(0 => t('Exact'), 1 => t('Regex'))
    ),
    'dest_dsid' => array(
      '#type' => 'textfield',
      '#title' => t(''),
      '#description' => t('The input for either Exact Match or a PCRE'),
      '#size' => 30,
    ),
    'dest_type' => array(
      '#type' => 'select',
      '#title' => t(''),
      '#options' => array(0 => t('Exact'), 1 => t('Regex'))
    ),
    'add' => array(
      '#type' => 'submit',
      '#value' => t('Add'),
      '#model_id' => $model_id, // Default.
      '#submit' => array('content_model_viewer_add_datastream_dsid_view_derived_rule'),
      '#validate' => array('content_model_viewer_add_datastream_dsid_view_derived_rule_validate'),
    )
  );
  return array(
    'fieldset' => array(
      '#type' => 'fieldset',
      '#title' => t('Derived Datastream Display Rules (DSID)'),
      '#description' => t('<p>Provides a way to match non-viewable types like PDF\'s with their viewable derived types such as SWF\'s. This set of rules compares the <b>Datastream ID\'s</b>. <b>%dsid%</b> and <b>%pid%</b> can be used in the <b>Source</b> and <b>Derived</b> fields below to insert the Datastream ID and Object PID into the value.</p>'),
      /**
       * A bit of a hack, I want the default action here to be add not delete, 
       * so I've mirrored the add button and placed it at the begining of the form. 
       * Making it hidden, so it will be the default action.
       */
      'add' => array(
        '#type' => 'submit',
        '#value' => t('Add'),
        '#model_id' => $model_id, // Default.
        '#submit' => array('content_model_viewer_add_datastream_dsid_view_derived_rule'),
        '#validate' => array('content_model_viewer_add_datastream_dsid_view_derived_rule_validate'),
        '#attributes' => array('style' => 'position: absolute; left: -9999px; width: 1px; height: 1px;')
      ),
      'rows' => $rows
    )
  );
}

/**
 * Get Content Models for the Autocomplete Field.
 * 
 * @return array
 */
function content_model_viewer_get_available_models() {
  module_load_include('inc', 'fedora_repository', 'api/fedora_utils');
  $offset = 0;
  $limit = 1000;
  $query = 'select $object  $model from <#ri>
  where (walk($model <fedora-model:hasModel><info:fedora/fedora-system:ContentModel-3.0>
  and $model <fedora-model:hasModel> $object))
  minus $object <mulgara:is><info:fedora/fedora-system:FedoraObject-3.0>
  minus $object <mulgara:is><info:fedora/fedora-system:ContentModel-3.0>
  minus $object <mulgara:is><info:fedora/fedora-system:ServiceDefinition-3.0>
  minus $object <mulgara:is><info:fedora/fedora-system:ServiceDeployment-3.0>
  order by $object';
  $url = variable_get('fedora_repository_url', 'http://localhost:8080/fedora/risearch');
  $url .= "?type=tuples&flush=TRUE&format=Sparql&limit=$limit&offset=$offset&lang=itql&stream=on&query=" . htmlentities(urlencode($query));
  $content = trim(do_curl($url));
  if ($content != '') {
    $doc = new DOMDocument();
    $doc->loadXML($content);
    $path = new DOMXPath($doc);
    $path->registerNamespace('sparql', 'http://www.w3.org/2001/sw/DataAccess/rf1/result');
    $results = $path->query('//sparql:result');
    if ($results->length > 0) {
      $count = $results->length;
      for ($i = 0; $i < $count; $i++) {
        $result = $results->item($i);
        $pid = substr($path->query('sparql:object/@uri', $result)->item(0)->value, 12); // 12 characteres in "info:fedora/"
        $content_models[$pid] = $pid;
      }
    }
  }
  return $content_models;
}

/**
 * Theme's a form table for this module.
 * 
 * @param array $element
 *   A Drupal Form Element.
 * 
 * @return sting
 *   HTML that renders a table of settings for datastreams.
 */
function theme_content_model_viewer_form_table(array $element) {
  $rows = array();
  foreach (element_children($element) as $child) {
    $setting = $element[$child];
    $fields = array();
    foreach (element_children($setting) as $property) {
      $field = $setting[$property];
      $fields[] = drupal_render($field);
    }
    $rows[] = array(
      'data' => $fields,
      'class' => isset($setting['#attributes']['class']) ? $setting['#attributes']['class'] : NULL
    );
  }
  $attributes = isset($element['#id']) ? array('id' => $element['#id']) : NULL;
  return theme_table($element['#header'], $rows, $attributes);
}

/**
 * Removes the given datastream mimetype rule, identified by the #rule_id property of the clicked button.
 * 
 * @param array $form
 *   The Drupal Form.
 * @param array $form_state 
 *   The Drupal Form State.
 */
function content_model_viewer_delete_datastream_mimetype_rule(array $form, array &$form_state) {
  if (isset($form_state['clicked_button']['#rule_id'])) {
    $id = $form_state['clicked_button']['#rule_id'];
    db_query('DELETE FROM %s WHERE id = "%d"', CONTENT_MODEL_VIEWER_DATASTREAM_MIMETYPE_RULES_TABLE, $id);
    drupal_set_message('Successfully Deleted Datastream Setting');
  }
}

/**
 * Removes the given datastream id rule, identified by the #rule_id property of the clicked button.
 * 
 * @param array $form
 *   The Drupal Form.
 * @param array $form_state 
 *   The Drupal Form State.
 */
function content_model_viewer_delete_datastream_dsid_rule(array $form, array &$form_state) {
  if (isset($form_state['clicked_button']['#rule_id'])) {
    $id = $form_state['clicked_button']['#rule_id'];
    db_query('DELETE FROM %s WHERE id = "%d"', CONTENT_MODEL_VIEWER_DATASTREAM_DSID_RULES_TABLE, $id);
    drupal_set_message('Successfully Deleted Datastream Setting');
  }
}

/**
 * Removes the given RELS rule, identified by the #rule_id property of the clicked button.
 * 
 * @param array $form
 *   The Drupal Form.
 * @param array $form_state 
 *   The Drupal Form State.
 */
function content_model_viewer_delete_datastream_rels_view_derived_rule(array $form, array &$form_state) {
  if (isset($form_state['clicked_button']['#rule_id'])) {
    $id = $form_state['clicked_button']['#rule_id'];
    db_query('DELETE FROM %s WHERE id = "%d"', CONTENT_MODEL_VIEWER_DATASTREAM_RELS_VIEW_DERIVED_RULES_TABLE, $id);
    drupal_set_message('Successfully Deleted Datastream Setting');
  }
}

/**
 * Removes the given DSID rule, identified by the #rule_id property of the clicked button.
 *
 * @param array $form
 *   The Drupal Form.
 * @param array $form_state 
 *   The Drupal Form State.
 */
function content_model_viewer_delete_datastream_dsid_view_derived_rule(array $form, array &$form_state) {
  if (isset($form_state['clicked_button']['#rule_id'])) {
    $id = $form_state['clicked_button']['#rule_id'];
    db_query('DELETE FROM %s WHERE id = "%d"', CONTENT_MODEL_VIEWER_DATASTREAM_DSID_VIEW_DERIVED_RULES_TABLE, $id);
    drupal_set_message('Successfully Deleted Datastream Setting');
  }
}

/**
 * Adds a MIME type datastream rule to a Model setting, identified by the #model_id property of the clicked button.
 * 
 * @param array $form
 *   The Drupal Form.
 * @param array $form_state 
 *   The Drupal Form State.
 */
function content_model_viewer_add_datastream_mimetype_rule(array $form, array &$form_state) {
  $row = new stdClass();
  $row->model_id = (int) $form_state['clicked_button']['#model_id'];
  $row->mime = (string) $form_state['values']['mime'];
  $row->view = (int) $form_state['values']['view'];
  $row->download = (int) $form_state['values']['download'];
  if (drupal_write_record(CONTENT_MODEL_VIEWER_DATASTREAM_MIMETYPE_RULES_TABLE, $row)) {
    drupal_set_message(t('Successfully Added Datastream Setting'));
  }
}

/**
 * Adds a datastream id rule to a Model setting, identified by the #model_id property of the clicked button.
 * 
 * @param array $form
 *   The Drupal Form.
 * @param array $form_state 
 *   The Drupal Form State.
 */
function content_model_viewer_add_datastream_dsid_rule(array $form, array &$form_state) {
  $row = new stdClass();
  $row->model_id = $form_state['clicked_button']['#model_id'];
  $row->dsid = (string) $form_state['values']['dsid'];
  $row->type = (int) $form_state['values']['type'];
  $row->view = (int) $form_state['values']['view'];
  $row->download = (int) $form_state['values']['download'];
  if (drupal_write_record(CONTENT_MODEL_VIEWER_DATASTREAM_DSID_RULES_TABLE, $row)) {
    drupal_set_message(t('Successfully Added Datastream Setting'));
  }
}

/**
 * Adds a rule to a Model setting, identified by the #model_id property of the clicked button.
 * 
 * @param array $form
 *   The Drupal Form.
 * @param array $form_state 
 *   The Drupal Form State.
 */
function content_model_viewer_add_datastream_rels_view_derived_rule(array $form, array &$form_state) {
  $row = new stdClass();
  $row->model_id = (int) $form_state['clicked_button']['#model_id'];
  $row->mime = (string) $form_state['values']['mime'];
  $row->xpath = (string) $form_state['values']['xpath'];
  $row->matching = (string) $form_state['values']['matching'];
  $row->type = (int) $form_state['values']['type'];
  if (drupal_write_record(CONTENT_MODEL_VIEWER_DATASTREAM_RELS_VIEW_DERIVED_RULES_TABLE, $row)) {
    drupal_set_message(t('Successfully Added Datastream Setting'));
  }
}

/**
 * Adds a rule to a Model setting, identified by the #model_id property of the clicked button.
 * 
 * @param array $form
 *   The Drupal Form.
 * @param array $form_state 
 *   The Drupal Form State.
 */
function content_model_viewer_add_datastream_dsid_view_derived_rule(array $form, array &$form_state) {
  $row = new stdClass();
  $row->model_id = $form_state['clicked_button']['#model_id'];
  $row->src_dsid = (string) $form_state['values']['src_dsid'];
  $row->src_type = (int) $form_state['values']['src_type'];
  $row->dest_dsid = (string) $form_state['values']['dest_dsid'];
  $row->dest_type = (int) $form_state['values']['dest_type'];
  if (drupal_write_record(CONTENT_MODEL_VIEWER_DATASTREAM_DSID_VIEW_DERIVED_RULES_TABLE, $row)) {
    drupal_set_message(t('Successfully Added Datastream Setting'));
  }
}

/**
 * Validates the add MIME type datastream rule portion of the form.
 * 
 * @param array $form
 *   The Drupal Form.
 * @param array $form_state 
 *   The Drupal Form State.
 */
function content_model_viewer_add_datastream_mime_rule_validate(array $form, array &$form_state) {
  if (empty($add['mime']['#value'])) {
    form_error($add['mime'], t('field is required.'));
  }
}

/**
 * Validates the add datastream id rule portion of the form.
 * 
 * @param array $form
 *   The Drupal Form.
 * @param array $form_state 
 *   The Drupal Form State.
 */
function content_model_viewer_add_datastream_dsid_rule_validate(array $form, array &$form_state) {
  $add = $form['fieldset']['rows']['add'];
  if (empty($add['dsid']['#value'])) {
    form_error($add['dsid'], t('field is required.'));
  }
  else if ($add['type']['#value'] == CONTENT_MODEL_VIEWER_DATASTREAM_DSID_RULE_TYPE_REGEX) {
    content_model_viewer_regex_validate($add['dsid'], $form_state);
  }
}

/**
 * Validates an elements input by checking if it is valid regex input.
 * 
 * @param array $element
 *   A Drupal Form Element
 * @param array $form_state 
 *   The Drupal Form State.
 */
function content_model_viewer_regex_validate(array $element, array &$form_state) {
  $pattern = '/' . $element['#value'] . '/';
  $result = @preg_match($pattern, '');
  if ($result === FALSE) {
    $message = t('This value provided "@value" is not a valid regular expression. For more information click !here', array(
      '@value' => $element['#value'],
      '!here' => l(t('here'), 'http://php.net/manual/en/reference.pcre.pattern.syntax.php'))
    );
    form_error($element, $message);
  }
}