scholar.install

<?php

/**
 * @file
 */

define('ISLANDORA_SCHOLAR_JOURNAL_FORM_NAME', 'Islandora Scholar Journal Form');
define('ISLANDORA_SCHOLAR_THESIS_FORM_NAME', 'Islandora Scholar Thesis Form');
define('ISLANDORA_SCHOLAR_BOOK_FORM_NAME', 'Islandora Scholar Book Form');
define('ISLANDORA_SCHOLAR_CHAPTER_FORM_NAME', 'Islandora Scholar Book Chapter Form');
define('ISLANDORA_SCHOLAR_CONFERENCE_FORM_NAME', 'Islandora Scholar Conference Paper Form');
define('ISLANDORA_SCHOLAR_MADS_FORM_NAME', 'Islandora Scholar MADS Form');
define('ISLANDORA_SCHOLAR_MADS_DEPT_FORM_NAME', 'Islandora Scholar MADS Dept Form');
define('ISLANDORA_SCHOLAR_SIGNATURE_PROJECT_FORM', 'Islandora Scholar Signature Project Form');

/**
 * Implementation of hook_install
 * @global type $base_url 
 */
function scholar_install() {
  $module_path = drupal_get_path('module', 'scholar');

  // Put the form in the database
  module_load_include('inc', 'xml_form_builder', 'XMLFormDatabase');
  if (!XMLFormDatabase::Exists(ISLANDORA_SCHOLAR_JOURNAL_FORM_NAME)) {
    $definition = new DOMDocument();
    $definition->load($module_path . '/forms/journal_article_form.xml');
    XMLFormDatabase::Create(ISLANDORA_SCHOLAR_JOURNAL_FORM_NAME, $definition);
  }
  if (!XMLFormDatabase::Exists(ISLANDORA_SCHOLAR_THESIS_FORM_NAME)) {
    $definition = new DOMDocument();
    $definition->load($module_path . '/forms/thesis_form.xml');
    XMLFormDatabase::Create(ISLANDORA_SCHOLAR_THESIS_FORM_NAME, $definition);
  }
  if (!XMLFormDatabase::Exists(ISLANDORA_SCHOLAR_BOOK_FORM_NAME)) {
    $definition = new DOMDocument();
    $definition->load($module_path . '/forms/book_form.xml');
    XMLFormDatabase::Create(ISLANDORA_SCHOLAR_BOOK_FORM_NAME, $definition);
  }
  if (!XMLFormDatabase::Exists(ISLANDORA_SCHOLAR_CHAPTER_FORM_NAME)) {
    $definition = new DOMDocument();
    $definition->load($module_path . '/forms/book_chapter_form.xml');
    XMLFormDatabase::Create(ISLANDORA_SCHOLAR_CHAPTER_FORM_NAME, $definition);
  }
  if (!XMLFormDatabase::Exists(ISLANDORA_SCHOLAR_CONFERENCE_FORM_NAME)) {
    $definition = new DOMDocument();
    $definition->load($module_path . '/forms/conference_paper_form.xml');
    XMLFormDatabase::Create(ISLANDORA_SCHOLAR_CONFERENCE_FORM_NAME, $definition);
  }
  if (!XMLFormDatabase::Exists(ISLANDORA_SCHOLAR_MADS_FORM_NAME)) {
    $definition = new DOMDocument();
    $definition->load($module_path . '/forms/mads_scholar.xml');
    XMLFormDatabase::Create(ISLANDORA_SCHOLAR_MADS_FORM_NAME, $definition);
  }
  if (!XMLFormDatabase::Exists(ISLANDORA_SCHOLAR_MADS_DEPT_FORM_NAME)) {
    $definition = new DOMDocument();
    $definition->load($module_path . '/forms/MADS_dept_form.xml');
    XMLFormDatabase::Create(ISLANDORA_SCHOLAR_MADS_DEPT_FORM_NAME, $definition);
  }
  if (!XMLFormDatabase::Exists(ISLANDORA_SCHOLAR_SIGNATURE_PROJECT_FORM)) {
    $definition = new DOMDocument();
    $definition->load($module_path . '/forms/signature_project_form.xml');
    XMLFormDatabase::Create(ISLANDORA_SCHOLAR_SIGNATURE_PROJECT_FORM, $definition);
  }
  // Associates the form with the content model
  $result = db_result(db_query('Select content_model from {islandora_content_model_forms} where  content_model = "%s" and form_name = "%s"', 'islandora:citationCModel', 'Islandora Scholar Journal Form'));
  if (!$result) {
    $object = new stdClass();
    $object->content_model = 'islandora:citationCModel';
    $object->form_name = 'Islandora Scholar Journal Form';
    $object->dsid = 'MODS';
    $object->title_field = "['titleInfo']['title']";
    $object->transform = 'mods_to_dc.xsl';
    $result = drupal_write_record('islandora_content_model_forms', $object);
  }

  $result = db_result(db_query('Select content_model from {islandora_content_model_forms} where  content_model = "%s" and form_name = "%s"', 'islandora:thesisCModel', 'Islandora Scholar Thesis Form'));
  if (!$result) {
    $object = new stdClass();
    $object->content_model = 'islandora:thesisCModel';
    $object->form_name = 'Islandora Scholar Thesis Form';
    $object->dsid = 'MODS';
    $object->title_field = "['titleInfo']['title']";
    $object->transform = 'mods_to_dc.xsl';
    $result = drupal_write_record('islandora_content_model_forms', $object);
  }
  
  $result = db_result(db_query('Select content_model from {islandora_content_model_forms} where  content_model = "%s" and form_name = "%s"', 'islandora:thesisCModel', 'Islandora Scholar Signature Project Form'));
  if (!$result) {
    $object = new stdClass();
    $object->content_model = 'islandora:thesisCModel';
    $object->form_name = 'Islandora Scholar Signature Project Form';
    $object->dsid = 'MODS';
    $object->title_field = "['titleInfo']['title']";
    $object->transform = 'mods_to_dc.xsl';
    $result = drupal_write_record('islandora_content_model_forms', $object);
  }
  
  $result = db_result(db_query('Select content_model from {islandora_content_model_forms} where  content_model = "%s" and form_name = "%s"', 'islandora:citationCModel', 'Islandora Scholar Book Form'));
  if (!$result) {
    $object = new stdClass();
    $object->content_model = 'islandora:citationCModel';
    $object->form_name = 'Islandora Scholar Book Form';
    $object->dsid = 'MODS';
    $object->title_field = "['titleInfo']['title']";
    $object->transform = 'mods_to_dc.xsl';
    $result = drupal_write_record('islandora_content_model_forms', $object);
  }
  
  $result = db_result(db_query('Select content_model from {islandora_content_model_forms} where  content_model = "%s" and form_name = "%s"', 'islandora:citationCModel', 'Islandora Scholar Book Chapter Form'));
  if (!$result) {
    $object = new stdClass();
    $object->content_model = 'islandora:citationCModel';
    $object->form_name = 'Islandora Scholar Book Chapter Form';
    $object->dsid = 'MODS';
    $object->title_field = "['titleInfo']['title']";
    $object->transform = 'mods_to_dc.xsl';
    $result = drupal_write_record('islandora_content_model_forms', $object);
  }
  
  $result = db_result(db_query('Select content_model from {islandora_content_model_forms} where  content_model = "%s" and form_name = "%s"', 'islandora:citationCModel', 'Islandora Scholar Book Conference Paper Form'));
  if (!$result) {
    $object = new stdClass();
    $object->content_model = 'islandora:citationCModel';
    $object->form_name = 'Islandora Scholar Book Conference Paper Form';
    $object->dsid = 'MODS';
    $object->title_field = "['titleInfo']['title']";
    $object->transform = 'mods_to_dc.xsl';
    $result = drupal_write_record('islandora_content_model_forms', $object);
  }
  
  $result = db_result(db_query('Select content_model from {islandora_content_model_forms} where  content_model = "%s" and form_name = "%s"', 'islandora:researcherCModel', 'Islandora Scholar MADS Form'));
  if (!$result) {
    $object = new stdClass();
    $object->content_model = 'islandora:researcherCModel';
    $object->form_name = 'Islandora Scholar MADS Form';
    $object->dsid = 'MADS';
    $object->title_field = "['titleInfo']['title']";
    $object->transform = 'mads_to_dc.xsl';
    $result = drupal_write_record('islandora_content_model_forms', $object);
  }
  
  $result = db_result(db_query('Select content_model from {islandora_content_model_forms} where  content_model = "%s" and form_name = "%s"', 'islandora:departmentCModel', 'Islandora Scholar MADS Dept Form'));
  if (!$result) {
    $object = new stdClass();
    $object->content_model = 'islandora:departmentCModel';
    $object->form_name = 'Islandora Scholar MADS Dept Form';
    $object->dsid = 'MADS';
    $object->title_field = "['titleInfo']['title']";
    $object->transform = 'dept_mads_to_dc.xsl';
    $result = drupal_write_record('islandora_content_model_forms', $object);
  }
  
  if (drupal_install_schema('scholar')) {
    drupal_set_message(t('Database tables created!'));
  }
}

function scholar_schema() {
  $result = @db_result(db_query("SELECT pid FROM {islandora_scholar_citation_counts}"));
  if (!$result) {
    $schema['islandora_scholar_dept_citation_counts'] = array(
      'description' => t('This table is used to store the citation counts for fedora objects'),
      'fields' => array(
        'id' => array(
          'type' => 'serial',
          'not null' => TRUE,
        ),
        'pid' => array(
          'description' => t('PID of the object'),
          'type' => 'varchar',
          'length' => 64,
          'not null' => TRUE,
        ),
        'full_name' => array(
          'description' => t('Full name'),
          'type' => 'varchar',
          'length' => 128,
        ),     
        'citation_count' => array(
          'description' => t('Number of citations'),
          'type' => 'int',
          'length' => 64,
          'not null' => TRUE,
        ),
      ),
      'primary key' => array('id'),
      'indexes' => array(
        'pid' => array('pid'),
      ),
    );
  }
  
  $schema['islandora_scholar_researcher_citation_counts'] = array(
      'description' => t('This table is used to store the citation counts for fedora objects'),
      'fields' => array(
        'id' => array(
          'type' => 'serial',
          'not null' => TRUE,
        ),
        'pid' => array(
          'description' => t('PID of the object'),
          'type' => 'varchar',
          'length' => 64,
          'not null' => TRUE,
        ),
        'full_name' => array(
          'description' => t('Full name'),
          'type' => 'varchar',
          'length' => 128,
        ),   
        'department' => array(
          'description' => t('Department'),
          'type' => 'varchar',
          'length' => 64,
        ),        
        'citation_count' => array(
          'description' => t('Number of citations'),
          'type' => 'int',
          'length' => 64,
          'not null' => TRUE,
        ),
      ),
      'primary key' => array('id'),
      'indexes' => array(
        'pid' => array('pid'),
        'department' => array('department'),
      ),
    );
  return $schema;
}

/**
 * Creates a new fedora object.
 * 
 * @param string $pid
 *   The Fedora Object's PID
 * @param string $label
 *   The Fedora Objects label.
 * @param array $relationships

 * @param array $datastreams

 */
function scholar_create_fedora_object($pid, $label, array $relationships = array(), array $datastreams = array()) {
  module_load_include('inc', 'fedora_repository', 'api/fedora_item');
  if (!Fedora_Item::fedora_item_exists($pid)) {
    $foxml = Fedora_Item::create_object_FOXML($pid, 'A', $label);
    $object = Fedora_Item::ingest_from_FOXML($foxml);
    if ($object->exists()) {
      foreach ($relationships as $type => $values) {
        $values = is_array($values) ? $values : array($values);
        foreach ($values as $value) {
          $object->add_relationship($type, $value);
        }
      }
      foreach ($datastreams as $datastream) {
        list($url, $dsid, $label, $mime, $control) = $datastream;
        $object->add_datastream_from_url($url, $dsid, $label, $mime, $control);
      }
      return;
    }
    else {
      drupal_set_message('MORE TIME NEEDED.');
    }
    drupal_set_message(t('There was an error creating %pid (%label). See watchdog for details.', array('%pid' => $pid, '%label' => $label)), 'Error');
  }
}


/**
 * Adds the required namespaces for the scholar module.
 */
function scholar_add_required_namespaces() {
  $namespaces = variable_get('fedora_pids_allowed', 'demo: changeme: islandora:');
  if (preg_match('/ir\:/', $namespaces) == 0) {
    variable_set('fedora_pids_allowed', $namespaces . ' ir:');
    drupal_set_message('Added \'ir:\' to the set of allowed namespaces.', 'info');
  }
}