modules/dpistudy/dpistudy.module

<?php
// $Id$

/**
 * @file
 * Distribution method for the Digital Propensity Index Questionanire
 * and the instructional intervention for David Kent Norman's dissertation
 *
 * @author David Kent Norman
 * @link http://deekayen.net
 * @link http://dpistudy.com
 * @copyright Copyright 2008 David Kent Norman
 */

define('DPISTUDY_ALT_IRB_URL', 'http://education.ucf.edu/insttech/');
define('DPISTUDY_NUM_QUESTIONS', 6);

/**
 * Implementation of hook_perm().
 *
 * @return array
 */
function dpistudy_perm() {
  return array('access dpistudy');
}

/**
 * Implementation of hook_init().
 *
 * Adds the timer javascript to the output and start the timer.
 */
function dpistudy_init() {
  if (arg(0) != 'admin') {
    _dpistudy_js_timer();
    _dpistudy_js_timer_start();
  }
}

/**
 * Implementation of hook_menu().
 *
 * @return array
 */
function dpistudy_menu() {
  $items = array();

  $items['dpistudy'] = array(
    'page callback' => 'dpistudy_hub',
    'page arguments' => array(),
    'access callback' => 'user_access',
    'access arguments' => array('access dpistudy'),
    'type' => MENU_CALLBACK,
    'title' => 'Get your Digital Propensity Index score!',
    'title callback' => 't',
    'title arguments' => array()
  );
  $items['dpistudy/dpi'] = array(
    'page callback' => 'drupal_get_form',
    'page arguments' => array('dpistudy_dpi_questionnaire_form'),
    'access callback' => 'user_access',
    'access arguments' => array('access dpistudy'),
    'title' => 'Digital Propensity Index Questionnaire',
    'title callback' => 't',
    'title arguments' => array(),
    'type' => MENU_CALLBACK
  );
  $items['dpistudy/instruction'] = array(
    'page callback' => 'drupal_get_form',
    'page arguments' => array('dpistudy_instruction_form'),
    'access callback' => 'user_access',
    'access arguments' => array('access dpistudy'),
    'title' => 'Just @num more!', // not ideal, but this or arguments have to be passed for the callback to be executed
    'title callback' => 'dpistudy_instruction_title',
    'type' => MENU_CALLBACK
  );
  $items['dpistudy/score'] = array(
    'page callback' => 'dpistudy_score',
    'page arguments' => array(),
    'access callback' => 'user_access',
    'access arguments' => array('access dpistudy'),
    'title' => 'Your Digital Propensity Index score!',
    'title callback' => 't',
    'title arguments' => array(),
    'type' => MENU_CALLBACK
  );
  $items['admin/settings/dpistudy'] = array(
    'page callback' => 'drupal_get_form',
    'page arguments' => array('dpistudy_admin_settings'),
    'access callback' => 'user_access',
    'access arguments' => array('administer site configuration'),
    'description' => 'Toggle features of the DPI questionnaire.',
    'title' => 'DPI Study',
    'title callback' => 't',
    'title arguments' => array(),
    'type' => MENU_NORMAL_ITEM
  );
  $items['admin/settings/dpistudy/settings'] = array(
    'page callback' => 'drupal_get_form',
    'page arguments' => array('dpistudy_admin_settings'),
    'access callback' => 'user_access',
    'access arguments' => array('administer site configuration'),
    'title' => 'Settings',
    'title callback' => 't',
    'title arguments' => array(),
    'type' => MENU_DEFAULT_LOCAL_TASK,
    'weight' => 0
  );
  $items['admin/settings/dpistudy/keys'] = array(
    'page callback' => 'dpistudy_admin_settings_invite_keys',
    'page arguments' => array(),
    'access callback' => 'user_access',
    'access arguments' => array('administer site configuration'),
    'title' => 'Invite Keys',
    'title callback' => 't',
    'title arguments' => array(),
    'type' => MENU_LOCAL_TASK,
    'weight' => 3
  );
  $items['admin/settings/dpistudy/keys/delete'] = array(
    'page callback' => 'dpistudy_admin_settings_invite_keys_delete',
    'page arguments' => array(5),
    'access callback' => 'user_access',
    'access arguments' => array('administer site configuration'),
    'title' => 'Delete a key',
    'title callback' => 't',
    'title arguments' => array(),
    'type' => MENU_LOCAL_TASK,
    'weight' => 3
  );
  $items['admin/settings/dpistudy/questions'] = array(
    'page callback' => 'dpistudy_admin_settings_list_questions',
    'page arguments' => array(),
    'access callback' => 'user_access',
    'access arguments' => array('administer site configuration'),
    'description' => 'Manage questions on the questionnaire.',
    'title' => 'Questionnaire',
    'title callback' => 't',
    'title arguments' => array(),
    'type' => MENU_LOCAL_TASK,
    'weight' => 5
  );
  $items['admin/settings/dpistudy/questions/list'] = array(
    'page callback' => 'dpistudy_admin_settings_list_questions',
    'page arguments' => array(),
    'access callback' => 'user_access',
    'access arguments' => array('administer site configuration'),
    'description' => 'Manage questions on the questionnaire.',
    'title' => 'List questions',
    'title callback' => 't',
    'title arguments' => array(),
    'type' => MENU_DEFAULT_LOCAL_TASK,
    'weight' => 0
  );
  $items['admin/settings/dpistudy/questions/add'] = array(
    'page callback' => 'drupal_get_form',
    'page arguments' => array('dpistudy_admin_settings_add_question_form'),
    'access callback' => 'user_access',
    'access arguments' => array('administer site configuration'),
    'description' => 'Adds a question to the questionnaire.',
    'title' => 'Add question',
    'title callback' => 't',
    'title arguments' => array(),
    'type' => MENU_LOCAL_TASK,
    'weight' => 5
  );
  $items['admin/reports/dpistudy'] = array(
    'page callback' => 'dpistudy_report',
    'page arguments' => array(),
    'access callback' => 'user_access',
    'access arguments' => array('administer site configuration'),
    'description' => 'View the breakdown of responses for each invite key and copy quick links for keyed visitors.',
    'title' => 'DPI Study',
    'title callback' => 't',
    'title arguments' => array(),
    'type' => MENU_NORMAL_ITEM
  );
  $items['admin/reports/dpistudy/visits'] = array(
    'page callback' => 'dpistudy_report',
    'page arguments' => array(),
    'access callback' => 'user_access',
    'access arguments' => array('administer site configuration'),
    'title' => 'Visits',
    'title callback' => 't',
    'title arguments' => array(),
    'type' => MENU_DEFAULT_LOCAL_TASK,
    'weight' => 0
  );
  $items['admin/reports/dpistudy/export'] = array(
    'page callback' => 'dpistudy_csv_export',
    'page arguments' => array(),
    'access callback' => 'user_access',
    'access arguments' => array('administer site configuration'),
    'description' => 'Export survey results to a spreadsheet.',
    'title' => 'Export',
    'title callback' => 't',
    'title arguments' => array(),
    'type' => MENU_LOCAL_TASK,
    'weight' => 10
  );
  return $items;
}

/**
 * Enter description here...
 *
 * @param string $title
 */
function dpistudy_instruction_title($title) {
  if ($_SESSION['instruction_number'] == 6) {
    return t('Last one!');
  }
  else {
    return t($title, array('@num' => (empty($_SESSION['instruction_number']) ? DPISTUDY_NUM_QUESTIONS - 1 : DPISTUDY_NUM_QUESTIONS - $_SESSION['instruction_number'])));
  }
}

/**
 * @return array
 */
function dpistudy_admin_settings() {
  $form = array();
  $form['dpistudy_add_form_num_questions'] = array(
    '#type' => 'textfield',
    '#title' => t('Number of answers on add question form'),
    '#size' => 4,
    '#default_value' => variable_get('dpistudy_add_form_num_questions', 5)
  );
  $form['consent'] = array(
    '#type' => 'fieldset',
    '#title' => t('Consent form'),
    '#collapsible' => true,
    '#collapsed' => true
  );
  $form['consent']['dpistudy_irb_consent_active'] = array(
    '#type' => 'radios',
    '#options' => array('disabled', 'enabled'),
    '#title' => t('Toggle IRB consent screen'),
    '#default_value' => variable_get('dpistudy_irb_consent_active', 0),
    '#description' => t('Enabling the IRB form will require people to view .')
  );
  $form['consent']['dpistudy_irb_text'] = array(
    '#type' => 'textarea',
    '#rows' => 25,
    '#title' => t('Text to output on the IRB consent form.'),
    '#default_value' => variable_get('dpistudy_irb_text', ''),
    '#description' => t('HTML is allowed.')
  );
  $form['dpistudy_score_screen'] = array(
    '#type' => 'textarea',
    '#rows' => 10,
    '#title' => t('Score screen text'),
    '#description' => t('Text to output on the final screen where the DPI score is presented. Use @score as the placeholder for the numerical score. HTML is allowed.'),
    '#default_value' => variable_get('dpistudy_score_screen', ''),
  );
  $form['dpistudy_alt_irb_url'] = array(
    '#type' => 'textfield',
    '#title' => t('Alternate IRB URL'),
    '#default_value' => variable_get('dpistudy_alt_irb_url', DPISTUDY_ALT_IRB_URL),
    '#description' => t('Alternate URL to link users to under the "I Consent" button on the IRB consent form.')
  );
  return system_settings_form($form);
}

/**
 * Handles new key adding and displays current invite keys
 *
 * @return string
 */
function dpistudy_admin_settings_invite_keys() {
  $headers = array(
    array('data' => t('Invite Key'), 'field' => 'invite_key', 'sort' => 'asc'),
    array('data' => t('Notes'), 'field' => 'notes'),
    array('data' => t('Action'))
  );

  $sql = 'SELECT invite_key, notes FROM {dpistudy_keys}';
  $sql .= tablesort_sql($headers);

  $count  = 'SELECT COUNT(*) FROM {dpistudy_keys}';
  $result = pager_query($sql, 15, 0, $count);

  while ($key = db_fetch_object($result)) {
    $rows[] = array($key->invite_key, $key->notes, l(t('delete'), 'admin/settings/dpistudy/keys/delete/' . $key->invite_key));
  }

  $pager = theme('pager', NULL, 15);

  if (!empty($pager)) {
    $rows[] = array(array('data' => $pager, 'colspan' => 3));
  }

  $output = theme('table', $headers, $rows);
  return $output . drupal_get_form('dpistudy_admin_settings_invite_keys_form');
}

/**
 * Handles new key removing current invite keys
 *
 * @return string
 */
function dpistudy_admin_settings_invite_keys_delete($key) {
  db_query("DELETE FROM {dpistudy_keys} WHERE invite_key = '%s'", $key);
  drupal_set_message(t('!key deleted.', array('!key' => $key)), 'status');
  drupal_goto('admin/settings/dpistudy/keys');
}

/**
 * @return array
 */
function dpistudy_admin_settings_invite_keys_form() {
  $form = array();
  $form['add_key'] = array(
    '#type' => 'fieldset',
    '#title' => t('Add new invite key'),
    '#collapsible' => true,
    '#collapsed' => true
  );
  $form['add_key']['dpistudy_new_invite_key'] = array(
    '#type' => 'textfield',
    '#title' => t('New invite key'),
    '#size' => 4,
    '#default_value' => '',
    '#required' => true,
    '#maxlength' => 50,
    '#description' => t('Entry can be alphanumeric.')
  );
  $form['add_key']['dpistudy_new_invite_key_notes'] = array(
    '#type' => 'textfield',
    '#title' => t('Key notes'),
    '#description' => t('Notes on the audience to be associated with the key.'),
    '#maxlength' => 255,
    '#default_value' => ''
  );
  $form['add_key']['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Add key')
  );
  return $form;
}

/**
 * Validate the form submission from dpistudy_admin_settings_invite_keys_form()
 *
 * @param array $form
 * @param array $form_state
 */
function dpistudy_admin_settings_invite_keys_form_validate($form, &$form_state) {
  if ($form_state['values']['dpistudy_new_invite_key'] == '') {
    form_set_error('dpistudy_new_invite_key', t('You must add some text to the key value.'));
  }
  $existing = db_result(db_query("SELECT COUNT(*) FROM {dpistudy_keys} WHERE invite_key = '%s'", $form_state['values']['dpistudy_new_invite_key']));
  if ($existing > 0) {
    form_set_error('dpistudy_new_invite_key', t('"!key" is already a key! You must delete the old one first.', array('!key' => $form_state['values']['dpistudy_new_invite_key'])));
  }
}

/**
 * Process the form submission from dpistudy_admin_settings_invite_keys_form()
 *
 * @param array $form
 * @param array $form_state
 */
function dpistudy_admin_settings_invite_keys_form_submit($form, &$form_state) {
  db_query("INSERT INTO {dpistudy_keys} (invite_key, notes) VALUES ('%s', '%s')", $form_state['values']['dpistudy_new_invite_key'], $form_state['values']['dpistudy_new_invite_key_notes']);
  drupal_set_message(t('Invite key "!key" added', array('!key' => $form_state['values']['dpistudy_new_invite_key'])));
  cache_clear_all('dpistudy-', 'cache', TRUE);
}

/**
 * Lists questions on the questionnaire and allows weight adjustment
 * active/deactivate
 *
 * @return string
 */
function dpistudy_admin_settings_list_questions() {
  $headers = array(
    array('data' => t('Weight'), 'field' => 'weight'),
    array('data' => t('Title'), 'field' => 'title')
  );

  $sql = 'SELECT pkid, weight, title FROM {dpistudy_questions} GROUP BY weight, title';
  $sql .= tablesort_sql($headers);

  $count  = 'SELECT COUNT(*) FROM {dpistudy_questions}';
  $result = pager_query($sql, 50, 0, $count);

  while ($question = db_fetch_object($result)) {
    $weight = $question->weight;
//    $weight .= drupal_render(array(['my_elements'][$delta]['weight']['#attributes']['class'] = 'my-elements-weight'));

    $title  = l($question->title, "admin/settings/dpistudy/question/view/{$question->pkid}", array('attributes' => array('title' => t('View detailed question information'))));
    $rows[] = array(
      'data' => array($weight, $title),
      'class' => 'draggable'
    );
  }

  $pager = theme('pager', NULL, 50);

  if (!empty($pager)) {
    $rows[] = array(array('data' => $pager, 'colspan' => 2));
  }

  $output = theme('table', $headers, $rows, array('id' => 'dpistudy-questions'));
  return $output;
}

/**
 * Form for modifying the content of the questionnaire
 *
 * @param integer $pkid
 * @param integer $weight
 * @return array
 */
function dpistudy_admin_settings_list_questions_weight($pkid, $weight = 0) {
  $form = array();
  $form["question_{$pkid}_weight"] = array(
    '#type' => 'select',
    '#title' => '',
    '#default_value' => $weight,
    '#options' => drupal_map_assoc(range(-50, 50))
  );
  return $form;
}

/**
 * Form for modifying the content of the questionnaire
 *
 * @return array
 */
function dpistudy_admin_settings_list_questions_form() {
  $form = array();
  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Update questions')
  );
  return $form;
}

/**
 * Form to add a question to the questionnaire.
 * Defaults to 10 question answers.
 *
 * @todo de-hardcode the question type
 * @return array
 */
function dpistudy_admin_settings_add_question_form() {
  $form = array();
  $form['question_type'] = array(
    '#type' => 'radios',
    '#options' => array('Radio buttons', 'Checkbox'),
    '#title' => t('Question type'),
    '#description' => t('Select radio buttons for a single response per question or checkbox for multiple answers to the question. Currently, only radio buttons are supported.'),
    '#weight' => 0,
    // currently only radio is supported
    '#default_value' => 0,
    '#disabled' => true
  );
  $form['question_title'] = array(
    '#type' => 'textfield',
    '#title' => t('Question title'),
    '#description' => t('Note: A colon is automatically appended to the question text.'),
    '#weight' => 1,
    '#maxlength' => 250
  );
  $form['answers'] = array(
    '#type' => 'fieldset',
    '#title' => t('Answers'),
    '#collapsible' => true,
    '#collapsed' => false,
    '#weight' => 2
  );
  for ($i=1, $j = variable_get('dpistudy_add_form_num_questions', 5); $i <= $j; $i++) {
    $form['answers']['answer'][$i] = array(
      '#type' => 'fieldset',
      '#collapsible' => false,
      '#collapsed' => false
    );
    $form['answers']['answer'][$i][$i] = array(
      '#type' => 'textfield',
      '#title' => t('Answer %i', array('%i' => $i)),
      '#weight' => $i,
      '#maxlength' => 250
    );
    $form['answers']['answer'][$i]["{$i}_weight"] = array(
      '#type' => 'select',
      '#title' => t('Weight'),
      '#default_value' => $i,
      '#options' => drupal_map_assoc(range(-15, 15))
    );
  }
  $form['question_weight'] = array(
    '#type' => 'textfield',
    '#size' => 4,
    '#title' => t('Question weight'),
    '#default_value' => '0', // text value will convert to integer in database
    '#description' => t('Integer to dictate the order of the questions in the questionnaire. Questions with higher weight will be lower in the question order. Questions with the same weight will order alphabetically. For example, question number 20 would likely have a weight of 20.'),
    '#weight' => $i
  );
  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Add question'),
    '#weight' => $i + 1
  );
  return $form;
}

/**
 * Process the form submission from dpistudy_admin_settings_add_question_form()
 *
 * @param array $form
 * @param array $form_status
 */
function dpistudy_admin_settings_add_question_form_submit($form, &$form_status) {
  $answers = array();
  while (list($key, $value) = each($form_status['values'])) {
    if (is_integer($key)) {
      $answers[$key] = $value;
    }
  }
  ksort($answers);
  db_query("INSERT INTO {dpistudy_questions} (weight, title) VALUES (%d, '%s')", $form_status['values']['question_weight'], $form_status['values']['question_title']);
  $id = db_last_insert_id('dpistudy_questions', 'pkid');
  while (list($key, $value) = each($answers)) {
    // todo - format like this:
    // INSERT INTO tbl_name (a,b,c) VALUES(1,2,3),(4,5,6),(7,8,9);
    db_query("INSERT INTO {dpistudy_answers} (parent, weight, answer) VALUES (%d, %d, '%s')", $id, $key . '_weight', $value);
  }
  drupal_set_message(t('Question "%title" added', array('%title' => $form_status['values']['question_title'])));
  cache_clear_all('dpistudy-', 'cache', TRUE);
}

/**
 * Sends the survey results in CSV format
 * Requires PHP5
 *
 */
function dpistudy_csv_export() {
  // http://support.microsoft.com/kb/318756 says not to add charset
  // but http://api.drupal.org/api/5/function/drupal_set_header says the charset prevents XSS
  drupal_set_header('Content-type: application/vnd.ms-excel; charset=utf-8');
  drupal_set_header('Content-Disposition: attachment; filename=dpistudy_' . date('YmdHis') . '.csv');
  drupal_set_header('Expires: 0');
  drupal_set_header('Cache-Control: must-revalidate, post-check=0,pre-check=0');
  drupal_set_header('Pragma: public');

  $out = fopen('php://output', 'w');

  // set column headings for the CSV file
  $headers = array();
  $headers[] = 'sessid';
  $headers[] = 'invite_key';
  $headers[] = 'key_notes';
  $headers[] = 'agent';
  $headers[] = 'referer';
  $headers[] = 'irb_php';
  $headers[] = 'irb_http';
  $headers[] = 'irb_js';
  for ($i=1; $i<47; $i++) {
    $headers[] = "q$i";
  }
  $headers[] = 'dpi_php';
  $headers[] = 'dpi_http';
  $headers[] = 'dpi_js';
  for ($i=100; $i<106; $i++) {
    $headers[] = "q$i";
    $headers[] = "php_q$i";
    $headers[] = "http_q$i";
    $headers[] = "js_q$i";
  }
  fputcsv($out, $headers);
  unset($headers);

  // pre-populate default participant as non-response
  // for every question
  $populated_answer = array();
  $populated_answer['invite_key'] = '';
  $populated_answer['key_notes']  = '';
  $populated_answer['agent'] = '';
  $populated_answer['referer']  = '';
  $populated_answer['irb_php'] = '';
  $populated_answer['irb_http']  = '';
  $populated_answer['irb_js'] = '';
  for ($i=1; $i<47; $i++) {
    // 9 will be set as a missing value in SPSS
    $populated_answer["q$i"] = 9;
  }
  $populated_answer['dpi_php']  = 0;
  $populated_answer['dpi_http'] = 0;
  $populated_answer['dpi_js']   = 0;
  for ($i=100; $i<106; $i++) {
    $populated_answer["q$i"] = 6;
    $populated_answer["php_q$i"]  = 0;
    $populated_answer["http_q$i"] = 0;
    $populated_answer["js_q$i"]   = 0;
  }
  unset($i);

  /**
   * Replace non-response values with actual responses.
   * Non-response values will stay. Using this method
   * because the database doesn't store non-responses,
   * just actual values. If the participant never
   * submits their responses, there won't be a session
   * id value to fire the fputcsv() that would represent
   * a participant.
   */

  $answer = array();

  // just DPI questionnaire results
  $result = db_query('SELECT r.sessid, l.invite_key, k.notes, l.agent, l.referer, l.irb_php_timer AS irb_php, l.irb_apache_timer AS irb_http, l.irb_js_timer AS irb_js, r.question, r.answer, r.php_timer, r.apache_timer, r.js_timer FROM {dpistudy_responses} AS r LEFT JOIN {dpistudy_login} AS l ON r.sessid = l.sessid LEFT JOIN {dpistudy_keys} AS k ON l.invite_key = k.invite_key WHERE r.question < 100 ORDER BY l.invite_key, r.sessid, r.question');
  while ($r = db_fetch_object($result)) {
    // storing to an array like this could kill available
    // RAM, so hopefully it won't get out of control
    if (!isset($answer[$r->sessid])) {
      $answer[$r->sessid] = $populated_answer;
    }
    $answer[$r->sessid]['invite_key']      = $r->invite_key;
    $answer[$r->sessid]['key_notes']       = $r->notes;
    $answer[$r->sessid]['agent']           = $r->agent;
    $answer[$r->sessid]['referer']         = $r->referer;
    $answer[$r->sessid]['irb_php']         = $r->irb_php;
    $answer[$r->sessid]['irb_http']        = $r->irb_http;
    $answer[$r->sessid]['irb_js']          = $r->irb_js;
    $answer[$r->sessid]['dpi_php']         = $r->php_timer;
    $answer[$r->sessid]['dpi_http']        = $r->apache_timer;
    $answer[$r->sessid]['dpi_js']          = $r->js_timer;
    $answer[$r->sessid]["q{$r->question}"] = $r->answer;
  }

  // add on the instructional responses
  $result = db_query('SELECT r.sessid, l.invite_key, k.notes, l.agent, l.referer, l.irb_php_timer AS irb_php, l.irb_apache_timer AS irb_http, l.irb_js_timer AS irb_js, r.question, r.answer, r.php_timer, r.apache_timer, r.js_timer FROM {dpistudy_responses} AS r LEFT JOIN {dpistudy_login} AS l ON r.sessid = l.sessid LEFT JOIN {dpistudy_keys} AS k ON l.invite_key = k.invite_key WHERE r.question > 99 ORDER BY l.invite_key, r.sessid, r.question');
  while ($r = db_fetch_object($result)) {
    // storing to an array like this could kill available
    // RAM, so hopefully it won't get out of control
    if (!isset($answer[$r->sessid])) {
      $answer[$r->sessid] = $populated_answer;
    }
    $answer[$r->sessid]['invite_key']           = $r->invite_key;
    $answer[$r->sessid]['key_notes']            = $r->notes;
    $answer[$r->sessid]['agent']                = $r->agent;
    $answer[$r->sessid]['referer']              = $r->referer;
    $answer[$r->sessid]['irb_php']              = $r->irb_php;
    $answer[$r->sessid]['irb_http']             = $r->irb_http;
    $answer[$r->sessid]['irb_js']               = $r->irb_js;
    $answer[$r->sessid]["q{$r->question}"]      = $r->answer;
    $answer[$r->sessid]["php_q{$r->question}"]  = $r->php_timer;
    $answer[$r->sessid]["http_q{$r->question}"] = $r->apache_timer;
    $answer[$r->sessid]["js_q{$r->question}"]   = $r->js_timer;
  }
  while (list($sessid, $response) = each($answer)) {
    fputcsv($out, array_merge(array($sessid), $response));
    unset($answer[$sessid]);
  }
  fclose($out);
}

/**
 * Breakout of how many people responded in each invite key.
 */
function dpistudy_report() {
  $headers = array(
    array('data' => t('Invite Key'), 'field' => 'invite_key', 'sort' => 'asc'),
    array('data' => t('Visits')),
    array('data' => t('Invite link'))
  );

  $sql = 'SELECT invite_key, COUNT(sessid) AS responses FROM {dpistudy_login} GROUP BY invite_key';
  $sql .= tablesort_sql($headers);

  $count  = 'SELECT COUNT(DISTINCT(invite_key)) FROM {dpistudy_login}';
  $result = pager_query($sql, 15, 0, $count);

  while ($response = db_fetch_object($result)) {
    // str_replace()ing # is kind of hacky, but passing '?key=' to url() translates
    // the ? and = through drupal_urlencode() and no longer shows ? and =
    // in the output, rather the translated urlencode equivalents
    $rows[] = array($response->invite_key, $response->responses, l(str_replace('#', '', url('<front>', array('absolute' => true, 'fragment' => '?k=' . $response->invite_key))), '?k=' . $response->invite_key, array('absolute' => true)));
  }

  $pager = theme('pager', NULL, 15);

  if (!empty($pager)) {
    $rows[] = array(array('data' => $pager, 'colspan' => 3));
  }

  $output = theme('table', $headers, $rows);
  return $output;
}

/**
 * Gateway function to control what is displayed.
 * 1. IRB
 * 2. DPI
 * 3. Instruction
 *
 * This function uses $_SESSION as a checklist of things
 * the user has completed. If nothing is set for the dpistudy
 * array element, nothing has been completed. When IRB is set, it
 * means the user has accepted the risks involved with the project
 * and is ready to move on to the questionnaire.
 * When $_SESSION['questionnaire'] is DPI, the user has submitted
 * their DPI questionnaire and is ready for instruction, and so on.
 *
 * @return string
 */
function dpistudy_hub() {
  if (empty($_SESSION['logged_in'])) {
    if (isset($_REQUEST['k'])) {
      db_query("INSERT INTO {dpistudy_login} (sessid, invite_key, agent, referer) VALUES ('%s', '%s', '%s', '%s')", session_id(), $_REQUEST['k'], $_SERVER['HTTP_USER_AGENT'], $_SERVER['HTTP_REFERER']);
    }
    else {
      db_query("INSERT INTO {dpistudy_login} (sessid, agent, referer) VALUES ('%s', '%s', '%s')", session_id(), $_SERVER['HTTP_USER_AGENT'], $_SERVER['HTTP_REFERER']);
    }
  }
  $_SESSION['logged_in'] = TRUE;

  if (variable_get('dpistudy_irb_consent_active', 0) && !isset($_SESSION['dpistudy']['irb_consent'])) {
    return drupal_get_form('dpistudy_irb_form');
  }
  else {
    drupal_goto('dpistudy/dpi');
  }
}

/**
 * @return array
 */
function dpistudy_irb_form() {
  $form = array();
  $form['irb_text'] = array(
    '#value' => variable_get('dpistudy_irb_text', '')
  );
  $form['microtime'] = array(
    '#type' => 'hidden',
    '#value' => microtime(true)
  );
  $form['request_time'] = array(
    '#type' => 'hidden',
    '#value' => $_SERVER['REQUEST_TIME']
  );
  $form['js_timer'] = array(
    '#type' => 'hidden'
  );
  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => t('I consent'),
    '#weight' => 1,
    '#suffix' => '<p class="alt_consent">' . l(t("I'm not sure. Take me somewhere else."), variable_get('disseration_alt_irb_url', DPISTUDY_ALT_IRB_URL)) . '</p>'
  );
  $form['#attributes'] = array('name' => 'dpistudy');
  $form['#redirect'] = 'dpistudy/dpi';
  return $form;
}

function dpistudy_irb_form_submit($form, &$form_status) {
  $_SESSION['dpistudy']['irb_consent'] = true;

  $times = _dpistudy_calculate_times(
    $form_status['clicked_button']['#post']['microtime'],
    $form_status['clicked_button']['#post']['request_time'],
    $form_status['values']['js_timer']
  );

  db_query("UPDATE {dpistudy_login} SET irb_php_timer = '%f', irb_apache_timer = %d, irb_js_timer = %d WHERE sessid = '%s'", $times['microtime'], $times['http_header'], $times['javascript'], session_id());
}

/**
 * Displays the DPI questionnaire. When the responses are submitted, it
 * commits them to the database and forwards on to the instructional unit.
 *
 * @return array
 */
function dpistudy_dpi_questionnaire_form() {
  $i = 1;
  $form = array();
  $form['open_table'] = array(
    '#type' => 'markup',
    '#value' => '<table border="0" cellpadding="2" cellspacing="2" summary="">'
  );

  $questions = cache_get('dpistudy-questions');
  $questions = $questions->data;
  if (empty($questions)) {
    $questions = array();
    $result = db_query('SELECT pkid, title FROM {dpistudy_questions} ORDER BY weight, title');

    while ($question = db_fetch_object($result)) {
      $answers = array();
      $result2 = db_query('SELECT weight, answer FROM {dpistudy_answers} WHERE parent = %d ORDER BY weight', $question->pkid);
      while ($answer = db_fetch_object($result2)) {
        $answers[$answer->weight] = $answer->answer;
      }
      ksort($answers); // shouldn't be necessary, but just making sure
      $questions['question_' . $i] = array(
        '#type' => 'radios',
        '#options' => $answers,
        '#title' => $question->title,
        '#prefix' => "<tr><td style=\"vertical-align: top; font-weight: bold\"><div class=\"form-item\">$i.</div></td><td>",
        '#suffix' => '</td></tr>'
      );
      $i++;
    }
    cache_set('dpistudy-questions', $questions);
  }

  $form = array_merge($form, $questions);
  unset($questions);

  $form['close_table'] = array(
    '#type' => 'markup',
    '#value' => '</table>'
  );
  $form['request_time'] = array(
    '#type' => 'hidden',
    '#value' => $_SERVER['REQUEST_TIME']
  );
  $form['js_timer'] = array(
    '#type' => 'hidden'
  );
  $form['#redirect'] = 'dpistudy/instruction';
  $form['next'] = array(
    '#value' => '<p>' . t('After clicking submit, you will be presented with 6 timed questions.') . '</p>'
  );
  return array_merge($form, dpistudy_submit_form());
}

function dpistudy_dpi_questionnaire_form_submit($form, &$form_status) {
  $times = _dpistudy_calculate_times(
    $form_status['clicked_button']['#post']['microtime'],
    $form_status['clicked_button']['#post']['request_time'],
    $form_status['values']['js_timer']
  );

  $num_questions = db_result(db_query('SELECT COUNT(*) FROM {dpistudy_questions}'));
  for ($i=1; $i<=$num_questions; $i++) {
    if (isset($form_status['values']["question_$i"])) {
      db_query("INSERT INTO {dpistudy_responses} (sessid, question, answer, php_timer, apache_timer, js_timer) VALUES ('%s', %d, %d, '%f', %d, %d)", session_id(), $i, $form_status['values']["question_$i"], $times['microtime'], $times['http_header'], $times['javascript']);
    }
  }
}

/**
 * Cycle through questions for the instructional intervention
 * Multiple choice questions should have one of the following
 * sample behaviors according to Hirumi's verbal alignment:
 *
 * choose, discriminate, identify, recognize, select, solve, locate
 *
 * Verbs to match those behaviors at a verbal, knowledge level are:
 *
 * arrange, acquire, define, distinguish, duplicate,
 * identify, label, list, match, memorize, name,
 * order, recognize, recall, repeat, reproduce
 *
 * @return string
 */
function dpistudy_instruction_form() {

  $module_path = url(drupal_get_path('module', 'dpistudy'), array('absolute' => true));
  if (!isset($_SESSION['instruction_number'])) {
    $_SESSION['instruction_number'] = 1;
  }

  if (!isset($_SESSION['instructional_material_order'])) {
    // counter balancing with randomization
    $text = array(1, 2, 3);
    $graphics = array(4, 5, 6);
    shuffle($text);
    shuffle($graphics);
    if (mt_rand(0, 1)) {
      $_SESSION['instructional_material_order'] = array_merge($text, $graphics);
    }
    else {
      $_SESSION['instructional_material_order'] = array_merge($graphics, $text);
    }
  }

  $form = dpistudy_time_form();
  $form['question'] = array(
    '#type' => 'value',
    '#value' => $_SESSION['instructional_material_order'][$_SESSION['instruction_number']-1] // the key of the 1-6 questions, which is actually 0-5
  );

  switch ($form['question']['#value']) {
    case 6:
      $form['instruct_q6'] = array(
        '#type' => 'radios',
        '#prefix' => '<p><img src="' . $module_path . '/images/Graph_TravelTimes.gif" height="520" width="589" alt="Travel Times Southbound Departing St. Canards Station" title="Travel Times Southbound Departing St. Canards Station" longdesc="Travel Times Southbound Departing St. Canards Station at 6:00 am. Travel time in minutes. 14 stops are listed in a horizontal bar chart. Springfield 10. Toontown 17. Glenoak 23. Faerie 27. Emerald City 36. Whoville 42. Nottinghamshire 47. Fantasia 49. Florin 51. Hogwarts 61. Fraggle Rock 67. Bedrock 73. Southpark 78. Hotel Denouement 84." /></p>',
        '#title' => t('Based on the above chart, the travel time to Nottinghamshire is'),
        '#options' => array(
          t('<img src="' . $module_path . '/images/bar_42.gif" height="18" width="197" alt="blue bar" title="blue bar" longdesc="Horizontal blue bar matching the length of Whoville." />'),
          t('<img src="' . $module_path . '/images/bar_51.gif" height="18" width="238" alt="blue bar" title="blue bar" longdesc="Horizontal blue bar matching the length of Florin." />'),
          t('<img src="' . $module_path . '/images/bar_17.gif" height="18" width="79" alt="blue bar" title="blue bar" longdesc="Horizontal blue bar matching the length of Toontown." />'),
          t('<img src="' . $module_path . '/images/bar_47.gif" height="18" width="214" alt="blue bar" title="blue bar" longdesc="Horizontal blue bar matching the length of Nottinghamshire." />')
        ),
        '#attributes' => array('class' => 'instruction-question')
      );
      break;
    case 5:
      $form['instruct_q5_markup'] = array(
        '#value' => '<p style="background-color:yellow; font-weight:bold;">Click on the Regional Intermodal Center for the I-Drive Circulator on Toll 417.</p>'
          . '<p><map name="transit_routes_im" id="transit_routes_im">'
          . '<area shape="circle" coords="380,507,8" href="javascript:dpistudy_q5(0);" alt="I-Drive Circulator" title="I-Drive Circulator" longdesc="Black dot with description saying I-Drive Circulator" />'
          . '<area shape="circle" coords="385,554,11" href="javascript:dpistudy_q5(0);" alt="I-Drive Regional Intermodal Center" title="I-Drive Regional Intermodal Center" longdesc="White circle, with a red border, and a blue 5-point star in the center. I-Drive Regional Intermodal Center" />'
          . '<area shape="circle" coords="471,436,11" href="javascript:dpistudy_q5(1);" alt="Orlando Regional Intermodal Center" title="Orlando Regional Intermodal Center" longdesc="White circle, with a red border, and a blue 5-point star in the center. Orlando Regional Intermodal Center" />'
          . '<area shape="circle" coords="426,707,11" href="javascript:dpistudy_q5(2);" alt="Kissimmee Regional Intermodal Center" title="Kissimmee Regional Intermodal Center" longdesc="White circle, with a red border, and a blue 5-point star in the center. Kissimmee Regional Intermodal Center" />'
          . '<area shape="circle" coords="619,163,11" href="javascript:dpistudy_q5(3);" alt="Sanford Regional Intermodal Center" title="Sanford Regional Intermodal Center" longdesc="White circle, with a red border, and a blue 5-point star in the center. Sanford Regional Intermodal Center" />'
          . '<area shape="circle" coords="537,578,11" href="javascript:dpistudy_q5(4);" alt="OIA Regional Intermodal Center" title="OIA Regional Intermodal Center" longdesc="White circle, with a red border, and a blue 5-point star in the center. OIA Regional Intermodal Center" />'
          . '</map><img src="' . $module_path . '/images/transit_routes.jpg" height="734" width="750" alt="Central Florida Commuter Rail Transit Routes map" title="Central Florida Commuter Rail Transit Routes map" longdesc="Central Florida Commuter Rail Transit Routes map has a key in the top left corner." usemap="#transit_routes_im" /></p>'
          . '<p style="background-color:yellow; font-weight:bold;">Click on the Regional Intermodal Center for the I-Drive Circulator on Toll 417.</p>'
      );
      $form['instruct_q5'] = array(
        '#type' => 'hidden',
        '#value' => ''
      );
      break;
    case 4:
      $form['instruct_q4'] = array(
        '#type' => 'radios',
        '#prefix' => '<p><img src="' . $module_path . '/images/Graph_CapitalFundingDistribution.gif" height="314" width="302" alt="capital funding distribution" title="capital funding distribution" longdesc="Capital funding distribution." /><img src="' . $module_path . '/images/Graph_TypicalOMFundingSources.gif" height="314" width="300" alt="" title="" longdesc="" /></p>',
        '#title' => t('Select the pie chart representation of "Equipment 18%"'),
        '#options' => array(
          t('<img src="' . $module_path . '/images/capital_funding_equipment.gif" height="121" width="150" alt="51" title="51" longdesc="Horizontal blue bar with the number 51 on the right side in white text." />'),
          t('<img src="' . $module_path . '/images/funding_sources_subsidy.gif" height="141" width="150" alt="42" title="42" longdesc="Horizontal blue bar with the number 42 on the right side in white text." />'),
          t('<img src="' . $module_path . '/images/capital_funding_station_costs.gif" height="96" width="189" alt="17" title="17" longdesc="Horizontal blue bar with the number 17 on the right side in white text." />'),
          t('<img src="' . $module_path . '/images/funding_sources_fare_box_recovery.gif" height="107" width="151" alt="47" title="47" longdesc="Horizontal blue bar with the number 47 on the right side in white text." />')
        ),
        '#attributes' => array('class' => 'instruction-question')
      );
      break;
    case 3:
      $form['instruct_q3'] = array(
        '#type' => 'radios',
        '#prefix' => '<ul><strong>DeLand/Orange City/DeBary/Volusia County</strong>'
          . '<li style="margin-left: 2.5em">Nearly 50,000 people live in Orange City, DeBary and DeLand, one of the fastest growing areas of Volusia County</li>'
          . '<li style="margin-left: 2.5em">Nearly a quarter of the workforce commutes to jobs outside the county, primarily to Seminole and Orange counties</li></ul>'

          . '<ul><strong>Sanford/Lake Mary/Longwood/Altamonte Springs</strong>'

          . '<li style="margin-left: 2.5em">Home to two major retail malls</li>'
          . '<li style="margin-left: 2.5em">Growing business clusters along the I-4 corridor and individual communities</li>'
          . '<li style="margin-left: 2.5em">County government located in Sanford</li>'
          . '<li style="margin-left: 2.5em">Nearly 400,000 live in Seminole County</li>'
          . '<li style="margin-left: 2.5em">More than 40 percent of workforce commutes to jobs in Orange County</li>'
          . '<li style="margin-left: 2.5em">Passenger counts at Orlando-Sanford Airport nearly doubled between 2000 and 2004 Winter Park/Orlando/Orange County</li></ul>'

          . '<ul><strong>Winter Park/Orlando/Orange County</strong>'

          . '<li style="margin-left: 2.5em">Economic and cultural hub of Central Florida</li>'
          . '<li style="margin-left: 2.5em">Home to NBA\'s Orlando Magic</li>'
          . '<li style="margin-left: 2.5em">Intermodal transfers at Lynx Central Station and the Sand Lake area</li>'
          . '<li style="margin-left: 2.5em">Federal/state/local government and educational activity centers</li>'
          . '<li style="margin-left: 2.5em">Major renovations to the Citrus Bowl, the downtown arena and a new performing arts center planned</li>'
          . '<li style="margin-left: 2.5em">Station stops at Florida Hospital Orlando and Orlando Regional Medical Center, two of the region\'s largest employers</li>'
          . '<li style="margin-left: 2.5em">Ready access to retail, dining and cultural activities in Winter Park and downtown Orlando</li>'
          . '<li style="margin-left: 2.5em">Amtrak transfer stations</li></ul>'

          . '<ul><strong>Kissimmee/Osceola County</strong>'

          . '<li style="margin-left: 2.5em">Line terminates at the 1,200-acre Poinciana Industrial Park, which now employs more than 1,600 workers with major expansions planned</li>'
          . '<li style="margin-left: 2.5em">Nearly 56,000 residents live within the city limits of Kissimmee, one of the fastest growing counties in Central Florida</li>'
          . '<li style="margin-left: 2.5em">Almost three-quarters of Kissimmee residents commute to jobs outside the city</li>'
          . '<li style="margin-left: 2.5em">More than a third of residents work in the tourism or services industry</li></ul>',
        '#title' => t('Question: In which of these cities do &frac34; of residents commute to jobs outside the city'),
        '#options' => array(
          t('Lake Mary'),
          t('DeLand and Orlando'),
          t('Kissimmee'),
          t('Longwood')
        ),
        '#attributes' => array('class' => 'instruction-question')
      );
      break;
    case 2:
      $form['instruct_q2'] = array(
        '#type' => 'radios',
        '#prefix' => '<p>The clock\'s winding down on Orange County commissioners doing what the people elected them to do, and that\'s providing leadership.</p>'
          . '<p>The commissioners say they support commuter rail.</p>'
          . '<p>They say it will help relieve gridlock by speeding commuters aboard sleek Internet-fitted cars beginning in 2009.</p>'
          . '<p>But trains don\'t run on peanuts -- and that\'s all the commissioners so far say they\'re willing to give commuter rail to make it go. Unlike their counterparts in Volusia, Seminole and Osceola counties, most commissioners in Orange County say the county shouldn\'t have to assume the costs of its stations beginning in 2017. That\'s the date when localities must take on rail\'s operations and maintenance costs.</p>'
          . '<p>What they say they will do is pay just one-third of the operations and maintenance expenses of Winter Park and Maitland, two cities north of Orlando considering hosting stations. That\'s what passes for leadership? Passing the buck?</p>'
          . '<p>Orange County commissioners will meet Tuesday, one week before Winter Park residents vote on paying for and hosting a station. Residents there in a survey have said they want commuter rail. But many fear the cost.</p>'
          . '<p>County commissioners can relieve those fears by agreeing to fully fund Winter Park\'s share. They also should do the same for Maitland, which is wary of the expense of maintaining a station in 2017.</p>',
        '#title' => t('Question: According to the above editorial exerpt, trains don\'t run on'),
        '#options' => array(
          t('gasoline.'),
          t('diesel.'),
          t('peanuts.'),
          t('good intentions.')
        ),
        '#attributes' => array('class' => 'instruction-question')
      );
      break;
    case 1:
    default:
      $form['instruct_q1'] = array(
        '#type' => 'radios',
        '#prefix' => '<p>Traffic congestion is a growing concern for those who live, work and visit Central Florida. As our region continues to grow at a staggering pace, that congestion will only get worse. Though there is no one magic bullet to solve our traffic woes, several different modes of transportation options working together - known as "intermodal" in transportation-speak - is a proven way to ease the gridlock.</p>'
          . '<p>That\'s why the Florida Department of Transportation (FDOT), in cooperation with local government officials in Orange, Seminole, Volusia and Osceola counties and the federal government, is looking at a commuter rail transit project to run along a 61-mile stretch of existing rail freight tracks in the four-county area.</p>'
          . '<p>The 31-mile Phase 1 segment would serve 10 stations, linking DeBary to Orlando. Service could begin as soon as 2009 - just as FDOT starts a major I-4 reconstruction project through the heart of Central Florida, from State Road 434 in Longwood to Kirkman Road in southwest Orange County.</p>',
        '#title' => t('Question: Referencing the paragraphs above, the definition of "intermodal" is'),
        '#options' => array(
          t('multiple transportation modes working together.'),
          t('riding a railroad.'),
          t('the average of two populations.'),
          t('having a single mode of transportation.')
        ),
        '#attributes' => array('class' => 'instruction-question')
      );
      break;
  }
  $form['request_time'] = array(
    '#type' => 'hidden',
    '#value' => $_SERVER['REQUEST_TIME']
  );
  if ($_SESSION['instruction_number'] == 6) {
    $form['#redirect'] = 'dpistudy/score';
  }
  return array_merge($form, dpistudy_submit_form());
}

function dpistudy_instruction_form_submit($form, &$form_status) {
  $times = _dpistudy_calculate_times(
    $form_status['clicked_button']['#post']['microtime'],
    $form_status['clicked_button']['#post']['request_time'],
    $form_status['values']['js_timer']
  );

  if (isset($form_status['values']["instruct_q{$form_status['values']['question']}"])) {
    db_query("INSERT INTO {dpistudy_responses} (sessid, question, answer, php_timer, apache_timer, js_timer) VALUES ('%s', '%s', '%s', '%f', %d, %d)", session_id(), $form_status['values']['question']+99, $form_status['values']["instruct_q{$form_status['values']['question']}"]+1, $times['microtime'], $times['http_header'], $times['javascript']);
  }

  $_SESSION['instruction_number']++;
}

function dpistudy_score() {
  $num_responses = 0;
  $dpi_score     = 0;
  $incomplete    = false;

  $result = db_query("SELECT r.answer FROM {dpistudy_responses} AS r LEFT JOIN {dpistudy_questions} AS q ON r.question = q.pkid WHERE r.question <= 34 AND r.answer <> 0 AND r.sessid = '%s'", session_id());

  while ($response = db_fetch_object($result)) {
    $num_responses++;
    $dpi_score += $response->answer;
  }
  for ($i=34; $i>$num_responses; $i--) {
    $incomplete = true;
    $dpi_score += 3;
  }
  if ($incomplete == true) {
    drupal_set_message(t('Since you did not answer every question regarding Digital Propensity, your score is estimated.'), 'status', false);
  }

  dpistudy_protect_anonymity();

  return t(variable_get('dpistudy_score_screen', ''), array('@score' => $dpi_score));
}

/**
 * Destroy the session data and cookie.
 *
 * Calling user_logout() or sess_regenerate() would be similar
 * but since this is more messy, it makes sure we don't keep a
 * link to who the user is since it sets the existing cookie to
 * expire, then sets a totally different id that we never logged
 * in the database.
 */
function dpistudy_protect_anonymity() {
  $_SESSION = array();
  sess_destroy_sid(session_id());
  if (isset($_COOKIE[session_name()])) {
    setcookie(session_name(), '', time() - 42000, '/');
  }
  session_regenerate_id(TRUE);
}

/**
 *
 *
 * @return array
 */
function dpistudy_time_form() {
  $form = array();
  $form['js_timer'] = array(
    '#type' => 'textfield',
    '#title' => t('This question is timed'),
    '#size' => 7,
    '#maxlength' => 9,
    '#default_value' => ''
  );
  return $form;
}

/**
 * Contains the form elements that make the PHP-based and