tripal_jbrowse/tripal_jbrowse_mgmt/includes/tripal_jbrowse_mgmt_add.form.inc

<?php

function tripal_jbrowse_mgmt_add_form($form, &$form_state) {
  $settings = tripal_jbrowse_mgmt_get_settings();

  // Ensure the module is configured.
  if (empty(array_filter($settings))) {
    $form['incomplete'] = [
      '#type' => 'item',
      '#prefix' => '<div class="messages error">',
      '#markup' => t(
        'You have not configured the module yet. Please visit the
            <a href="@url">settings page</a> and submit the form before continuing.',
        ['@url' => url('admin/tripal/extension/tripal_jbrowse/management/configure')]
      ),
      '#suffix' => '</div>',
    ];

    return $form;
  }

  // Check to see if this is an edit form.
  $edit_form = FALSE;
  if (isset($form_state['build_info']['args'][0]) AND is_numeric($form_state['build_info']['args'][0])) {
    $instance_id = $form_state['build_info']['args'][0];
    $result = tripal_jbrowse_mgmt_get_instances(['id' => $instance_id]);
    if (!empty($result)) {
      $instance = $result[0];
      $edit_form = TRUE;
    }
    else {
      drupal_set_message('Unable to access the instance you would like to edit.', 'error');
      return $form;
    }
  }

  $organisms = tripal_jbrowse_mgmt_get_organisms_list();
  $mapped_organisms = [];
  foreach ($organisms as $organism) {
    $mapped_organisms[$organism->organism_id] = tripal_jbrowse_mgmt_construct_organism_name(
      $organism
    );
  }

  $form_description = 'Create a new JBrowse instance for a given organism. Submitting this form
  creates all the necessary files for a new JBrowse instance.';
  if ($edit_form) {
    $form_description = 'Edit details regarding the current JBrowse instance.';
  }
  $form['description_of_form'] = [
    '#type' => 'item',
    '#markup' => t($form_description),
  ];

  $form['organism'] = [
    '#title' => t('Organism'),
    '#description' => t('Select the organism'),
    '#type' => 'select',
    '#options' => $mapped_organisms,
    '#required' => TRUE,
    '#default_value' => ($edit_form) ? $instance->organism_id : NULL,
  ];

  $form['description'] = [
    '#title' => t('Description'),
    '#description' => t('Optional description for the instance.'),
    '#type' => 'textarea',
    '#default_value' => ($edit_form) ? $instance->description : NULL,
  ];

  $form['data'] = [
    '#type' => 'fieldset',
    '#title' => t('Reference Sequence File'),
    '#collabsible' => FALSE,
  ];

  $form['data']['data_desc'] = [
    '#type' => 'item',
    '#markup' => t(
      'You may either upload a file below or provide
       the path to the reference sequence fasta file.'
    ),
  ];

  $form['data']['ref_seq_file'] = [
    '#type' => 'file',
    '#title' => t('Reference Sequence FASTA File'),
    '#disabled' => ($edit_form) ? TRUE : FALSE,
  ];

  $form['data']['ref_seq_path'] = [
    '#type' => 'textfield',
    '#title' => t('OR Path to File on Server'),
    '#maxlength' => 255,
    '#description' => t(
      'This path will be ignored if a file is provided above. Ex: sites/default/files/file.fasta or /data/file.fasta'
    ),
    '#disabled' => ($edit_form) ? TRUE : FALSE,
  ];

  $form['page'] = [
    '#type' => 'fieldset',
    '#tree' => TRUE,
    '#title' => 'Instance Page Settings',
    '#description' => 'The following settings pertain to link directing users to this instance (either embedded or the original).',
  ];

  $form['page']['start-loc'] = [
    '#type' => 'textfield',
    '#title' => 'Start Location',
    '#description' => "<p>The initial genomic position which will be visible in
      the viewing field. Possible input strings are:</p>\r\n
    <strong>\"Chromosome\": \"start point\"..\"end point\"</strong>\r\n<p>A
      chromosome name/ID followed by “:”, starting position, “..” and end
      position of the genome to be viewed in the browser is used as an input.
      Chromosome ID can be either a string or a mix of string and numbers.
      “CHR” to indicate chromosome may or may not be used. Strings are not
      case-sensitive. If the chromosome ID is found in the database reference
      sequence (RefSeq), the chromosome will be shown from the starting
      position to the end position given in URL.</p>\r\n
      <pre>     ctgA:100..200</pre>\r\n
      <p>Chromosome ctgA will be displayed from position 100 to 200.</p>\r\n
    OR <strong>start point\"..\"end point</strong>\r\n<p>A string of
      numerical value, “..” and another numerical value is given with the loc
      option. JBrowse navigates through the currently selected chromosome from
      the first numerical value, start point, to the second numerical value,
      end point.</p>\r\n<pre>     200..600</pre>\r\n<p>Displays position 200
      to 600 of the current chromosome.</p>\r\n
    OR <strong>center base</strong>\r\n<p>If only one numerical value is given
      as an input, JBrowse treats the input as the center position. Then an
      arbitrary region of the currently selected gene is displayed in the
      viewing field with the given input position as basepair position on
      which to center the view.</p>\r\n
    OR <strong>feature name/ID</strong>\r\n<p>If a string or a mix of string
      and numbers are entered as an input, JBrowse treats the input as a
      feature name/ID of a gene. If the ID exists in the database RefSeq,
      JBrowser displays an arbitrary region of the feature from the the
      position 0, starting position of the gene, to a certain end point.</p>\r\n
      <pre>     ctgA</pre>\r\n<p>Displays an arbitrary region from the ctgA
      reference.</p>",
    '#default_value' => ($edit_form) ? tripal_jbrowse_mgmt_get_instance_property($instance_id, 'start-loc') : NULL,
  ];

  $form['page']['start-tracks'] = [
    '#type' => 'textarea',
    '#rows' => 2,
    '#title' => 'Tracks to Display',
    '#description' => "<p>A comma-delimited strings containing track names,
      each of which should correspond to the \"label\" element of the track
      information dictionaries that are currently viewed in the viewing field.</p>\r\n
      <pre>     DNA,knownGene,ccdsGene,snp131,pgWatson,simpleRepeat</pre>",
    '#default_value' => ($edit_form) ? tripal_jbrowse_mgmt_get_instance_property($instance_id, 'start-tracks') : NULL,
  ];

  $button = 'Create New Instance';
  if ($edit_form) {
    $button = 'Save Changes';
  }
  $form['submit'] = [
    '#type' => 'submit',
    '#value' => $button,
  ];

  return $form;
}

/**
 * Validate the form.
 *
 * @param $form
 * @param $form_state
 */
function tripal_jbrowse_mgmt_add_form_validate($form, &$form_state) {
  $values = $form_state['values'];
  $organism = isset($values['organism']) ? $values['organism'] : NULL;

  // Check if this is an add or edit form.
  $edit_form = FALSE;
  if (isset($form_state['build_info']['args'][0]) AND is_numeric($form_state['build_info']['args'][0])) {
    $instance_id = $form_state['build_info']['args'][0];
    $edit_form = TRUE;
  }

  if (!$edit_form) {
    $file = $_FILES['files']['tmp_name']['ref_seq_file'];
    $local_file = isset($values['ref_seq_path']) ? $values['ref_seq_path'] : NULL;

    if (empty($file) && empty($local_file)) {
      form_set_error(
        'ref_seq_file',
        'Please provide a local file path or upload a new file.'
      );
    }
    elseif (empty($file) && !empty($local_file)) {
      if (!file_exists($local_file)) {
        form_set_error('ref_seq_path', 'The file path provided does not exist.');
      }
    }
    else {
      $uploaded = tripal_jbrowse_mgmt_upload_file('ref_seq_file');
      if (!$uploaded) {
        form_set_error('ref_seq_file', 'Unable to upload file');
      }
      else {
        $uploaded = tripal_jbrowse_mgmt_move_file($uploaded);
        $form_state['values']['uploaded_file'] = $uploaded;
      }
    }
  }

  $instances = tripal_jbrowse_mgmt_get_instances(['organism_id' => $organism]);
  if (!empty($instances)) {
    if (!$edit_form OR ($edit_form AND $instances[0]->id != $instance_id)) {
      form_set_error(
        'organism',
        'A JBrowse instance for the selected organism already exists. You can edit the instance from the instances page.'
      );
    }
  }

  $organism = db_select('chado.organism', 'CO')
    ->fields('CO')
    ->condition('organism_id', $organism)
    ->execute()
    ->fetchObject();

  if (empty($organism)) {
    form_set_error('organism', 'Invalid organism selected ' . $organism);
  }
}

/**
 * @param $form
 * @param $form_state
 *
 * @throws \Exception
 */
function tripal_jbrowse_mgmt_add_form_submit($form, &$form_state) {
  global $user;

  $values = $form_state['values'];
  $organism_id = $values['organism'];
  $description = isset($values['description']) ? $values['description'] : '';

  // Check if this is an add or edit form.
  $edit_form = FALSE;
  if (isset($form_state['build_info']['args'][0]) AND is_numeric($form_state['build_info']['args'][0])) {
    $instance_id = $form_state['build_info']['args'][0];
    $edit_form = TRUE;
  }

  if ($edit_form) {

    $organism = db_select('chado.organism', 'CO')
      ->fields('CO')
      ->condition('organism_id', $organism_id)
      ->execute()
      ->fetchObject();

    $title = tripal_jbrowse_mgmt_construct_organism_name($organism);

    $data = [
      'organism_id' => $organism_id,
      'title' => $title,
      'description' => $description,
    ];
    $success = tripal_jbrowse_mgmt_update_instance($instance_id, $data);

    if ($success) {
      drupal_set_message("Successfully updated $title JBrowse instance.");
      $form_state['redirect'] = 'admin/tripal/extension/tripal_jbrowse/management/instances';
    }
    else {
      drupal_set_message('Failed to update the current instance!', 'error');
    }
  }
  else {
    if (empty($values['uploaded_file'])) {
      $file = $values['ref_seq_path'];
    }
    else {
      $file = $values['uploaded_file'];
    }

    $organism = db_select('chado.organism', 'CO')
      ->fields('CO')
      ->condition('organism_id', $organism_id)
      ->execute()
      ->fetchObject();

    $instance_id = tripal_jbrowse_mgmt_create_instance(
      [
        'organism_id' => $organism_id,
        'title' => tripal_jbrowse_mgmt_construct_organism_name($organism),
        'description' => $description,
        'created_at' => time(),
        'file' => $file,
      ]
    );

    if ($instance_id) {
      drupal_set_message('Instance created successfully!');
      $name = 'Create JBrowse instance for ';
      $name .= tripal_jbrowse_mgmt_construct_organism_name($organism);

      tripal_add_job(
        $name,
        'tripal_jbrowse_mgmt',
        'tripal_jbrowse_mgmt_create_instance_files',
        [$instance_id],
        $user->uid
      );
      $form_state['redirect'] = "admin/tripal/extension/tripal_jbrowse/management/instances/$instance_id";
    }
    else {
      drupal_set_message('Failed to create instance!', 'error');
    }
  }

  // Now save the instance properties.
  tripal_jbrowse_mgmt_save_instance_properties(
    $instance_id,
    $form_state['values']['page']
  );
}