modules/volunteer/volunteer.module

<?php
// $Id: volunteer.module,v 1.57 2006/05/12 22:22:26 killes Exp $


/**
 * Provides help information for the volunteer module.
 */
function volunteer_help($section) {
  switch($section) {
    case 'admin/help#volunteer':
      $output = '<p>'. t('Volunteer module helps you organize people for events.  There is a managed email  correspondence with the volunteer, as well as the ability to rate their volunteer performance at the end. It allows admins to further designate users as <em>volunteer coordinators</em> who can be designated as the contact person for volunteers for an event.') .'</p>';
      $output .= '<p>'. t('This module now relies on the CiviCRM module to handle contact information for volunteers.  The volunteer module is frequently used with the RSVP module to invite community members.  The module allows for default settings, contact settings, message settings, and email settings.') .'</p>';
      $output .= t('<p>You can</p>
<ul>
<li>administer default, contact, message and email settings at <a href="%admin-settings-volunteer">administer &gt;&gt; settings &gt;&gt; volunteer.</a></li>
<li>create an event at <a href="%node-add">create content &gt;&gt; event</a>.</li>
<li>volunteer for an event by clicking on the volunteer link below an event.</li>
<li>enable the calendar block for browsing events at <a href="%admin-block">administer >> block >> calendar for browing events</a>.</li>
<li>give user roles volunteer coordinate and volunteer maintain permissions at <a href="%admin-access">administer >> access control</a>.</li>
<li>see events that may allow volunteering at <a href="%event">events</a>.</li>
<li>rate volunteers for an event at events &gt;&gt; select an event &gt;&gt; volunteer admin &gt;&gt;<br />
Volunteer Status &gt;&gt; select a volunteer &gt;&gt; Avg. rating.</li>
<li>create a CiviCRM group for volunteers to be added to (when volunteering for an event) at <a href="%civicrm-group-add">CiviCRM &gt;&gt; Manage Groups &gt;&gt; New Group</a>.</li>
<li>create a CiviCRM profile&nbsp;for volunteers to register to (when volunteering for an event) at <a href="%civicrm-admin-uf-group">CiviCRM &gt;&gt; Administer CiviCRM &gt;&gt; CiviCRM Profile &gt;&gt; New CiviCRM Profile</a>.</li>
<li>select a CiviCRM group for volunteers to be added to (when volunteering for an event) at <a href="%admin-settings-volunteer">administer &gt;&gt; settings &gt;&gt; volunteer &gt;&gt; Contact Settings</a>.</li>
<li>select a CiviCRM profile form for volunteers to register to (when volunteering for an event) at <a href="%admin-settings-volunteer">administer &gt;&gt; settings &gt;&gt; volunteer &gt;&gt; Contact Settings</a>.</li>
<li>see a list of all contacts who have volunteered for events at CiviCRM &gt;&gt; Manage Groups &gt;&gt; select a group of volunteers &gt;&gt; Show Group Members.</li>
', array('%admin-settings-volunteer' => url('admin/settings/volunteer'), '%node-add' => url('node/add'), '%admin-block' => url('admin/block'), '%admin-access' => url('admin/access'), '%event' => url('event'), '%civicrm-group-add' => url('civicrm/group/add?reset=1'), '%civicrm-admin-uf-group' => url('civicrm/admin/uf/group?action=add&amp;reset=1'))) .'</ul>';
      $output .= '<p>'. t('For more information please read the configuration and customization handbook <a href="%volunteer">Volunteer page</a>.', array('%volunteer' => 'http://www.drupal.org/handbook/modules/volunteer/')) .'</p>';
      return $output;
    case 'admin/modules#description':
        return t('Provides volunteer functionality for events.');
    case 'volunteer/overview':
        return t('This page shows you all volunteers together with the events for which they volunteered and when they signed up.');
  }
}

/**
 * Allows the admin to set different defaults & settings for the module on the module config page
 */
function volunteer_settings() {
  $all_volunteer_coordinators = _volunteer_get_volunteer_coordinators();
  $variables = _volunteer_message_vars();
  $wildcards = implode(', ',array_keys($variables));

  $form['default_settings'] = array(
    '#type' => 'fieldset',
    '#title' => t('Default Settings'),
  );
  $form['default_settings']['volunteer_event_default'] = array(
    '#type' => 'radios',
    '#title' => t('Events volunteer-enabled by default'),
    '#default_value' => variable_get('volunteer_event_default',1),
    '#options' => array('no','yes'),
    '#description' => t('Should events be volunteer-enabled (with these settings) by default?'),
  );
  $form['default_settings']['volunteer_wanted'] = array(
    '#type' => 'textfield',
    '#title' => t('Default number of volunteers wanted'),
    '#default_value' => variable_get('volunteer_wanted', '2'),
    '#size' => 3,
    '#maxlength' => 6,
    '#description' => t('This will be the default number of volunteers entered into new events.'),
  );
  $form['default_settings']['volunteer_coordinator'] = array(
    '#type' => 'select',
    '#title' => t('Default volunteer coordinator'),
    '#default_value' => variable_get('volunteer_coordinator', ''),
    '#options' => $all_volunteer_coordinators,
    '#description' => t('Select the default volunteer to coordinate events'),
    '#extra' => 0,
    '#multiple' => FALSE,
    '#required' => TRUE,
  );

  if (module_exist('civicrm')) {
    civicrm_initialize(TRUE);
    $contact_groups = array();
    db_set_active('civicrm');
    $groups = crm_get_groups(array('is_active' => 1));
    db_set_active();
    $group_form = '';
    if (is_array($groups) && count($groups)) {
      foreach ($groups as $group) {
        $contact_sources[$group->id] = $group->title;
      }
      $form['contact_settings'] = array(
        '#type' => 'fieldset',
        '#title' => t('Contact Settings'),
      );
      $form['contact_settings']['volunteer_contact_source'] = array(
        '#type' => 'select',
        '#title' => t('Add/Update contacts to CiviCRM group when volunteering'),
        '#default_value' => variable_get('volunteer_contact_source',''),
        '#options' => $contact_sources,
        '#description' => t('Select a CiviCRM group for users to be added or updated to as contacts when volunteering for an event. You can <a href="%url">add</a> a volunteer specific group. You can later see a list of all users that volunteered by selecting the chosen group from <a href="%search">this page</a> and clicking Show Group Members.', array('%url' => url('civicrm/group/add'), '%search' => url('civicrm/group'))),
        '#extra' => 0,
        '#multiple' => FALSE,
        '#required' => TRUE,
      );
    }
    else {
      drupal_set_message(t('You need to <a href="%url">define</a> a CiviCRM group for use with volunteer module.', array('%url' => url('civicrm/group/add'))), 'error');
    }
    // CiviCRM: Get all allowed fields for 'individual' type contact.
    $forms = array();
    db_set_active('civicrm');
    $ufGroups = crm_uf_get_profile_groups();
    db_set_active();
    if (is_array($ufGroups) && count($ufGroups)) {
      $correct_email_exists = FALSE;
      $email_exists = FALSE;
      db_set_active('civicrm');
      foreach ($ufGroups as $id => $title) {
        $profile = crm_uf_get_profile_fields($id, TRUE);
        $has_correct_email = FALSE;
        foreach ($profile as $field) {
          if (strpos($field['name'], 'email') === 0) {
            $email_exists = TRUE;
            if ($field['is_required'] == 1) {
              $has_correct_email = TRUE;
              $correct_email_exists = TRUE;
            }
          }
        }
        if ($has_correct_email) {
          $forms[$id] = $title;
        }
      }
      db_set_active();
      if ($email_exists) {
        if ($correct_email_exists) {
          $form['contact_settings']['volunteer_form'] = array(
            '#type' => 'select',
            '#title' => t('CiviCRM profile form for volunteers'),
            '#default_value' => variable_get('volunteer_form', ''),
            '#options' => $forms,
            '#description' => t('Select a CiviCRM Profile form for volunteers. Users will fill out required fields in this form when volunteering for an event. You can <a href="%url">add</a> a volunteer specific profile. The profile needs at least an email field and it needs to be set to "Required" and "Active".', array('%url' => url('civicrm/admin/uf/group'))),
            '#extra' => 0,
            '#multiple' => FALSE,
            '#required' => TRUE,
          );
        }
        else {
          drupal_set_message(t('You need to <a href="%url">define</a> a CiviCRM profile for use with the volunteer module. The profile needs at least an email field and it needs to be set to "Required" and "Active". A profile with an email field could be found, but it does not have the correct settings. ', array('%url' => url('civicrm/admin/uf/group'))), 'error');
        }
      }
      else {
        drupal_set_message(t('You need to <a href="%url">define</a> a CiviCRM profile for use with the volunteer module. The profile needs at least an email field and it needs to be set to "Required" and "Active". No profile with an email field could be found.', array('%url' => url('civicrm/admin/uf/group'))), 'error');
      }
    }
    else {
      drupal_set_message(t('You need to <a href="%url">define</a> a CiviCRM profile for use with the volunteer module. The profile needs at least an email field and it needs to be set to "Required" and "Active".', array('%url' => url('civicrm/admin/uf/group'))), 'error');
    }
  }
  else {
    drupal_set_message(t('You need to enable the CiviCRM module in order to use the volunteer module.'), 'error');
  }
  $form['message_settings'] = array(
    '#type' => 'fieldset',
    '#title' => t('Message Settings'),
  );
  $form['message_settings']['volunteer_message_sign_up'] = array(
    '#type' => 'textarea',
    '#title' => t('Volunteer message'),
    '#default_value' => variable_get('volunteer_message_sign_up', t('Fill out this quick form to volunteer for this event.')),
    '#cols' => 75,
    '#rows' => 5,
    '#description' => t('Message to display when volunteers are signing up'),
  );
  $form['message_settings']['volunteer_message_thanks'] = array(
    '#type' => 'textarea',
    '#title' => t('Volunteer thank you message'),
    '#default_value' => variable_get('volunteer_message_thanks', t('Thank you for offering to volunteer! Someone will be in touch with you shortly with details.')),
    '#cols' => 75,
    '#rows' => 5,
    '#description' => t('Message to display to user after they have signed up to volunteer for an event.'),
  );
  $form['message_settings']['wildcards'] = array(
    '#value' => '<p>'. t("NOTE - wildcards are <b>inactive</b> for these messages.") .'</p>',
  );

  $form['email_settings'] = array(
    '#type' => 'fieldset',
    '#title' => t('Email Settings'),
  );
  $form['email_settings']['volunteer_default_from'] = array(
    '#type' => 'textfield',
    '#title' => t('Default email from address for automailer'),
    '#default_value' => variable_get('volunteer_default_from', 'VOLUNTEER_AUTO_MAILER'),
    '#size' => 30,
    '#maxlength' => 75,
    '#description' => t("This is the from address that the coordinator's will see when they get automated messages from the module"),
  );
  $form['email_settings']['volunteer_message_approve'] = array(
    '#type' => 'textarea',
    '#title' => t('Default message for approval'),
    '#default_value' => variable_get('volunteer_message_approve', t(_volunteer_default_messages('approve'))),
    '#cols' => 75,
    '#rows' => 5,
    '#description' => t('Default message sent to users when they have been approved to volunteer for an event'),
  );
  $form['email_settings']['volunteer_message_denial'] = array(
    '#type' => 'textarea',
    '#title' => t('Default message for denial'),
    '#default_value' => variable_get('volunteer_message_deny', t(_volunteer_default_messages('deny'))),
    '#cols' => 75,
    '#rows' => 5,
    '#description' => t('Default message sent to users when they have been denied to volunteer for an event'),
  );
  $form['email_settings']['volunteer_message_wait'] = array(
    '#type' => 'textarea',
    '#title' => t('Default message for waiting list'),
    '#default_value' => variable_get('volunteer_message_wait', t(_volunteer_default_messages('wait'))),
    '#cols' => 75,
    '#rows' => 5,
    '#description' => t('Default message sent to users to notify them that they have been put on the wait list for an event'),
  );
  $form['email_settings']['volunteer_message_reminder'] = array(
    '#type' => 'textarea',
    '#title' => t('Default message for reminder'),
    '#default_value' => variable_get('volunteer_message_reminder', t(_volunteer_default_messages('reminder'))),
    '#cols' => 75,
    '#rows' => 5,
    '#description' => t('Default message sent to users to remind them of event 24 hours before hand'),
  );
  $form['email_settings']['volunteer_message_follow_up'] = array(
    '#type' => 'textarea',
    '#title' => t('Default message for follow-up'),
    '#default_value' => variable_get('volunteer_message_follow_up', t(_volunteer_default_messages('follow_up'))),
    '#cols' => 75,
    '#rows' => 5,
    '#description' => t('Default message sent to users 24 hours after the event'),
  );
  $form['email_settings']['wildcards'] = array(
    '#value' => '<p>'. t("FYI - The following 'Wildcards' can be used in messages to insert live data about the volunteer event: $wildcards") .'</p>',
  );

  return $form;
}

/**
 * Provides the volunteer permission information for the drupal system.
 *
 * @ingroup volunteer_core
 */
function volunteer_perm() {
  return array('volunteer coordinate');
}

/**
 * Provides the volunteer link information for the drupal system.
 *
 * @ingroup volunteer_core
 */
function volunteer_link($type, $node = 0, $main = 0) {
  switch ($type) {
  case 'node' :
    if (module_invoke('event', 'is_enabled', $node->type)) {
      if (volunteer_event_is_volunteer($node)) {
        if (volunteer_count($node->nid) >= $node->volunteer['wanted']) {
           $links[] = l(t('volunteer (full)'), "volunteer/volunteer/$node->nid/wait_list", array("title" => t('you can volunteer for this event, but the event is already full.')) );
        }
        else {
          $links[] = l(t('volunteer'), "volunteer/volunteer/$node->nid",
          array("title" => t('volunteer for this event')) );
        }
      }
    }
    break;
    case 'event_node_table' :
    case 'event_node_day' :
    case 'event_node_week' :
    case 'event_node_month' :
      if (volunteer_event_is_volunteer($node)) {
        if (volunteer_count($node->nid) >= $node->volunteer['wanted']) {
           $links[] = theme('volunteer_calendar_link', 'waitlist', $node->nid);
        }
        else {
          $links[] = theme('volunteer_calendar_link', 'volunteer', $node->nid);
        }
      }
    break;
  }
  return $links ? $links : array();
}


/**
 * Implementation of hook_menu().
 *
 * @ingroup volunteer_core
 */
function volunteer_menu($may_cache) {
  $items = array();

  if (function_exists('civicrm_initialize')) {
    if ($may_cache) {
      $items[] = array('path' => 'volunteer/question_coordinator', 'title' => t('volunteer approve'),
                       'callback' => 'volunteer_question_coordinator',
                       'type' => MENU_CALLBACK,
                       'access' => user_access('volunteer coordinate'));
      $items[] = array('path' => 'volunteer/volunteer', 'title' => t('volunteer'),
                       'callback' => 'volunteer_volunteer',
                       'type' => MENU_CALLBACK,
                       'access' => user_access('access content'));

     $items[] = array('path' => 'volunteer/rating', 'title' => t('volunteer rate'),
                       'callback' => 'volunteer_rate',
                       'type' => MENU_CALLBACK,
                       'access' => user_access('volunteer coordinate'));
      $items[] = array('path' => 'volunteer', 'title' => t('volunteer overview'),
                       'callback' => 'volunteer_overview',
                       'access' => user_access('volunteer coordinate'));
    }
    elseif (arg(0)=='node' && is_numeric(arg(1))) {
      $node = node_load(arg(1));
      if (function_exists('event_is_enabled') && event_is_enabled($node->type)) {
        $items[] = array('path' => 'node/'. arg(1) .'/volunteer', 'title' => t('volunteer admin'),
                         'callback' => 'volunteer_form', 'access' => user_access('volunteer coordinate'),
                         'type' => MENU_LOCAL_TASK, 'weight' => 10);
      }
    }
  }

  return $items;
}

/**
 * Implementation of hook_civicrm_post
 * Delete contacts from volunteer dataset that get deleted in CiviCRM
 */
function volunteer_civicrm_post( $op, $objectName, $objectId, $objectRef ) {
  if ($objectName == 'Individual') {
    switch ($op) {
      case 'delete':
        db_query('DELETE FROM {volunteer_contact_event} WHERE cid = %d', $objectId);
      default:
        break;
    }
  }
}

/**
 * Menu callback,
 */
function volunteer_overview() {
  $sql = 'SELECT v.cid, v.nid, v.timestamp, v.stage, n.title FROM {volunteer_contact_event} v INNER JOIN {node} n ON n.nid = v.nid ';
  $header = array(
    array('data' => t('Name')),
    array('data' => t('Event'), 'field' => 'n.title'),
    array('data' => t('Date'), 'field' => 'v.timestamp', 'sort' => 'desc'),
    array('data' => t('Stage'), 'field' => 'v.stage')
  );
  $sql .= tablesort_sql($header);
  $result = pager_query($sql, 50);

  $rows = array();
  while ($data = db_fetch_object($result)) {
    switch ($data->stage) {
      case '1':
        $stage = l(t('Wait List'), "volunteer/question_coordinator/$data->cid/$data->nid");
        break;
      case '2':
        $stage = l(t('Waiting Approval'), "volunteer/question_coordinator/$data->cid/$data->nid");
        break;
      case '3':
        $stage = l(t('Approved'), "volunteer/question_coordinator/$data->cid/$data->nid");
        break;
      case '4':
        $stage = l(t('Reminded'), "volunteer/question_coordinator/$data->cid/$data->nid");
        break;
      case '5':
        $stage = l(t('Follow Up'), "volunteer/question_coordinator/$data->cid/$data->nid");
    }
    $rows[] = array($data->cid,
                    l($data->title, "node/$data->nid", array('title' => t('view this event'))),
                    format_date($data->timestamp, 'medium'),
                    $stage
                    );
  }

  $new_rows = array();
  civicrm_initialize(TRUE);
  foreach ($rows as $row) {
    db_set_active('civicrm');
    $contact = crm_get_contact(array('contact_id' => $row[0]));
    db_set_active();
    $row[0] = (isset($contact->display_name) && strlen($contact->display_name)) ? $contact->display_name : $contact->location[1]->email[1]->email;
    $new_rows[] = $row;
  }

  if ($pager = theme('pager', NULL, 50, 0)) {
    $new_rows[] = array(array('data' => $pager, 'colspan' => '3'));
  }

  if (!$new_rows) {
    $new_rows[] = array(array('data' => t('Nobody volunteered yet.'), 'colspan' => '3'));
  }

  drupal_set_title(t('Volunteer Overview'));
  print theme('page', theme('table', $header, $new_rows));
}

function volunteer_question_coordinator($cid, $nid) {
  civicrm_initialize(TRUE);

  if(isset($_POST['op'])) {
    switch ($_POST['op']) {
      case t('Approve'):
          $form = volunteer_approve_volunteer($cid, $nid);
        break;
      case t('Deny'):
          volunteer_deny_volunteer($cid, $nid);
          drupal_set_message(t('Volunteer denied'));
        break;
      case t('Wait List'):
          volunteer_wait_volunteer($cid, $nid);
          drupal_set_message(t('Volunteer set to wait list'));
        break;
      case t('Overload'):
          volunteer_approve_volunteer($cid, $nid);
        break;
    }
    if(!isset($form)) {
      drupal_goto('node/'.$nid.'/volunteer');
    }
  }
  else {
    $rating = volunteer_get_rating($cid);
    $form['average'] = array(
      '#type' => 'item',
      '#title' => t('Avg. Rating'),
      '#default_value' => l($rating['average'], "volunteer/rating/$cid/$nid"),
    );
    $form_title = variable_get('volunteer_form', '');
    db_set_active('civicrm');
    $title = crm_uf_get_profile_title($form_title);
    $form['profile'] = array(
      '#value' => crm_uf_get_profile_html( $cid, $title, CRM_CORE_ACTION_VIEW, false, true ),
    );
    db_set_active();
    $form['approve'] = array(
      '#type' => 'submit',
      '#value' => t('Approve'),
    );
    $form['wait_list'] = array(
      '#type' => 'submit',
      '#value' => t('Wait List'),
    );
    $form['deny'] = array(
      '#type' => 'submit',
      '#value' => t('Deny'),
    );
    $form['cancel'] = array(
      '#type' => 'submit',
      '#value' => t('Cancel'),
    );
  }
  drupal_set_title(t('Volunteer Status'));
  return drupal_get_form('volunteer_question_coordinator', $form);
}

/********************************/

/**
 * Check to see if a user is already signed up
 * for the event in question
 *
 * @param int $nid node_id for the event
 * @param int $contact_id CiviCRM contact_id for the user
 */

function volunteer_has_user_volunteered($nid, $contact_id){
  $sql = 'SELECT cid FROM {volunteer_contact_event} WHERE cid = %d AND nid = %d';
  return db_num_rows(db_query($sql, $contact_id, $nid)) > 0;
}

function volunteer_volunteer($nid, $wait_list = NULL) {
  global $user;
  // TODO: convert to validate/submit model for better readability
  // webchick: I tried to convert this, but because the entire form, including the submit button,
  // is generated from civicrm, I can't seem to get any Drupalish FAPI stuff to work with it...
  $edit = isset($_POST['edit']) ? $_POST['edit'] : array();
  $op = isset($_POST['op']) ? $_POST['op'] : array();

  civicrm_initialize(TRUE);
  // Not a Drupal form, so we need to let CRM have a crack
  //at it before we do
  $crm_params = array(); //user data if any
  $crm_form = volunteer_volunteer_form($nid, $crm_params);
  // check if the user has already signed up
  $contact_id = NULL;
  if ($crm_params['contact_id']) {
    //CRM knows about this user.  Is he/she signed up?
    $contact_id = $crm_params['contact_id'];
    // NOTE: I would put this into a #pre_render function, but we're not allowed
    // to pass in additional arguments ($contact_id) so I can't.
    if (volunteer_has_user_volunteered($nid, $contact_id)) {
      drupal_set_message(t('You have already signed up for this event.'), 'error');
      drupal_goto('node/'. $nid);
    }
  }
  // the form has been submitted
  if (count($edit) && $contact_id && !form_get_errors()) {
      // Go ahead and save/update and proceed
      //insert into volunteer_contact_event
      db_set_active('civicrm');
      $contact = crm_get_contact(array('contact_id' => $contact_id));
      db_set_active();
      $group_id = variable_get('volunteer_contact_source', 1);
      db_set_active('civicrm');
      $group = crm_get_groups(array('id' => $group_id));
      db_set_active();
      $group = $group[0];
      db_set_active('civicrm');
      $contact_array = array($contact);
      crm_add_group_contacts($group, $contact_array);
      db_set_active();
      $stage = $wait_list ? 1 : 2;
      db_query('INSERT INTO {volunteer_contact_event} (cid, nid, timestamp, stage) VALUES (%d, %d, %d, %d)', $contact_id, $nid, time(), $stage);
      volunteer_mail($contact_id, $nid, 'new_volunteer');
      drupal_set_message(variable_get('volunteer_message_thanks', t('Thank you for offering to volunteer! Someone will be in touch with you shortly with details.')));
      drupal_goto('node/'. $nid);
   }
   else {
     // display form
      $event = node_load($nid);
      $form['#prefix'] = '<p>'. variable_get('volunteer_message_sign_up', t('Fill out this quick form to volunteer for this event.')) .'</p>';
      $form['crm_form'] = array(
        '#value' => $crm_form,
      );
      $form['placeholder'] = array(
        '#value' => theme('box', t('Volunteer for %event', array('%event' => theme('placeholder', $event->title))), $output),
      );
  }
  drupal_set_title('Volunteering');
  return drupal_get_form('volunteer_volunteer', $form);
}

/********************************/


/**
 * Utility function to extract CRM email data from POST
 * This should probably move into civicrm.module...
 */
function _volunteer_get_email(){
  // TODO: Check if this still works/ is needed with 4.7.
  if(isset($_POST['op'])){
  	foreach($_POST as  $key => $val){
  	  if(strncmp($key, 'email', 5) == 0){
  	  	//We only need 1 email
  	  	return $val;
  	  }
  	}
  }
  return '';
}


function volunteer_volunteer_form($nid, &$edit) {
  // TODO: convert to validate/submit model for better radability
  global $user;
  //why factor this? Because the HTML 1.0 designers did not
  //care about I18n...
  $submit_value = t('Volunteer');
  //Preliminaries for getting CRM parameters
  $op = $_POST['op'];
  $form_title = variable_get('volunteer_form', '');
  db_set_active('civicrm');
  $title = crm_uf_get_profile_title($form_title);
  $reset = $op ? FALSE : TRUE;
  $register = FALSE; //always FALSE in 1.3 and later
  $userID = $user->uid ? crm_uf_get_match_id( $user->uid ) : NULL;
  $action = $userID ? CRM_CORE_ACTION_UPDATE : CRM_CORE_ACTION_ADD;

  //The following call not only generates HTML, it also
  //interacts with the CRM data store:
  $crm_form = crm_uf_get_profile_html( $userID, $title, $action, $register, $reset );
  db_set_active();
  if ( !$userID && $op) {
    //if everything went well, we have one now
     $email = $user->mail ? $user->mail : _volunteer_get_email();
     $params = array('email' => $email);
      //$contact = crm_get_contact($params);
     db_set_active('civicrm');
     list($values, $options) = crm_contact_search($params);
     db_set_active();
  }
  elseif ($userID) {
    //Fix for 51833
    $params = array('id' => $userID);
    db_set_active('civicrm');
    list($values, $options) = crm_contact_search($params);
    db_set_active();
  }

  if ($values && $op == $submit_value) {
    //We've already done what was needed with CRM
    //(?? what if there was an error), so do our business
    //with the Drupal side code:
    $param_list = array_values($values);
    $edit = $param_list[0];
    //Do we need HTML in this case?
    //I think not.
    //Redirects should go here, most likely
    return '';
  }
  else {
    //Either an error occurred, or we haven't
    //done anything yet.
    $form['#action'] = url("volunteer/volunteer/$nid");
    $form['#method'] = 'post';
    $form['crm_form'] = array(
      '#value' => $crm_form,
    );
    $form['submit'] = array(
      '#type' => 'submit',
      '#value' => t('Volunteer'),
    );

    return drupal_get_form('volunteer_form_form', $form);

/*    // We do not use Forms API here, because CiviCRM
    // ouputs HTML for the form
    $output .= '<form action="'. $url. '" method="post">';
    $output .= ;
    $output .= '<input type="submit" value="'. t('Volunteer') .'"/>';
    $output .= '</form>';

    return $output;
*/

  }
}


/********************************/

function volunteer_rate($cid, $nid = 0) {
  civicrm_initialize(TRUE);

  db_set_active('civicrm');
  $contact = crm_get_contact(array('contact_id' => $cid));
  db_set_active();
  $mail = $contact->location[1]->email[1]->email;
  if ($nid) {
    // rate a specific event
    $form['#method'] = 'post';
    $form['#action'] = url("volunteer/rating/$cid/$nid");
    $form['#submit']['volunteer_rate_submit'] = array($cid, $nid);

    $event = db_fetch_object(db_query('SELECT title FROM {node} WHERE nid = %d', $nid));
    $volunteer_contact_event = db_fetch_object(db_query('SELECT * FROM {volunteer_contact_event} WHERE cid = %d AND nid = %d', $cid, $nid));
    $rating_list = array(1 => 1,
                          2 => 2,
                          3 => 3,
                          4 => 4,
                          5 => 5);
   $form['rate'] = array(
     '#value' => t('Rate') .' '. "<a href=\"mailto:$mail\">$mail</a>". '\'s performance at: <b>' . $event->title . '</b>.',
   );
    $form[$event->title] = array(
      '#type' => 'fieldset',
      '#title' => $event->title,
    );
    $form[$event->title]['rating'] = array(
      '#type' => 'select',
      '#title' => t('Rating'),
      '#default_value' => $volunteer_contact_event->rating,
      '#options' => $rating_list,
      '#description' => '1 being the worst and 5 being the best.',
    );
    $form[$event->title]['comments'] = array(
      '#type' => 'textarea',
      '#title' => t('Comments'),
      '#default_value' => $volunteer_contact_event->comments,
      '#cols' => 70,
      '#rows' => 5,
      '#description' => 'Leave comment specific to this event here',
    );
    $form[$event->title]['submit'] = array(
      '#type' => 'submit',
      '#value' => t('Submit'),
    );
  }
  // output view of past ratings
  $data = volunteer_get_rating($cid);
  if (count($data['events'])) {
    $header = array('Event', 'Rating', 'Coordinator', 'Comments');
    $form['other_events'] = array(
      '#type' => 'fieldset',
      '#title' => t('Other Events which %name has volunteered for:', array('%name'=>$mail)),
    );
    $form['other_events']['events'] = array(
      '#value' => theme('table', $header, $data['events']),
    );
  }

  return drupal_get_form('volunteer_rate', $form);
}

function volunteer_rate_submit($form_id, $form_values, $cid, $nid) {
  db_query("UPDATE {volunteer_contact_event} SET comments = '%s', rating = %d WHERE cid = %d AND nid = %d", $form_values['comments'], $form_values['rating'], $cid, $nid);
  drupal_set_message(t('Volunteer rating updated'));
  drupal_goto("node/$nid/volunteer");
}


/**********************************/
// Needs to be rewritten to use the CiviCRM activity history.
function volunteer_get_rating($cid) {
  $result = db_query("SELECT v.*, n.title FROM {volunteer_contact_event} v LEFT JOIN {node} n ON v.nid = n.nid WHERE v.cid = %d and v.rating is NOT NULL", $cid); //data for all other events
  $count = 0;
  $rating_total = 0;

  $data['events'] = array();
  while($rating = db_fetch_object($result)) {
    $ratings = array();
    $coordinator = db_fetch_object(db_query('SELECT u.name, u.uid FROM {volunteer} v INNER JOIN {users} u ON v.uid = u.uid WHERE nid = %d', $rating->nid));
    $rating_total = $rating_total + $rating->rating;
    $ratings[] = l(t($rating->title), "node/$rating->nid");
    $ratings[] = l(t($rating->rating	), "volunteer/rating/$cid/$rating->nid");
    $ratings[] = l(t($coordinator->name), "node/$coordinator->uid");
    if (strlen($rating->comments) > 25) {
      $comments = l(t(substr($rating->comments, 0, 25) ."..."), "volunteer/rating/$cid/$rating->nid");
    }
    else{
      $comments = l(t($rating->comments), "volunteer/rating/$cid/$rating->nid");
    }
    $ratings[] = $comments;
    $data['events'][] = $ratings;
    $count++;
  }
  if($count) {
    $data['average'] = t('%ratio over %total events.', array('%ratio' => ($rating_total/$count), '%total' =>  $count));
  }
  else {
    $data['average'] = t('Not Yet Rated');
  }

  return $data;
}

/***************************/

function volunteer_cron() {
  //send reminder and set stage
  $time = time();
  $twodays = $time + (60*60*48);

  $result = db_query('SELECT c.nid, c.cid FROM {volunteer_contact_event} c INNER JOIN {event} e ON e.nid = c.nid WHERE e.event_start > %d AND e.event_start < %d AND c.stage = %d', $time, $twodays, 3);
  while($pairs = db_fetch_object($result)) {
    volunteer_mail($pairs->cid, $pairs->nid, 'reminder');
    db_query('UPDATE {volunteer_contact_event} set stage = 4 WHERE cid = %d AND nid = %d', $pairs->cid, $pairs->nid);
  }

  //send follow-up and set stage
  $result = db_query('SELECT c.nid, c.cid FROM {volunteer_contact_event} c INNER JOIN {event} e ON e.nid = c.nid WHERE e.event_end < %d AND c.stage = %d', $time, 4);
  while($pairs = db_fetch_object($result)) {
    volunteer_mail($pairs->cid, $pairs->nid, 'follow_up');
    db_query('UPDATE {volunteer_contact_event} set stage = 5 WHERE cid = %d AND nid = %d', $pairs->cid, $pairs->nid);
  }
}

/*************************/

function volunteer_mail($cid, $nid, $message) {
  global $base_url;

  $default_from = variable_get('volunteer_default_from', 'VOLUNTEER_AUTO_MAILER');

  $vcid = db_fetch_object(db_query('SELECT uid FROM {volunteer} v WHERE nid = %d', $nid));
  $coordinator = user_load(array('uid'=>$vcid->uid));

  $event = node_load($nid);

  db_set_active('civicrm');
  $volunteer = crm_get_contact(array('contact_id' => $cid));
  db_set_active();
  $volunteer_data = volunteer_get_volunteers($nid, TRUE, $cid);
  foreach($volunteer_data['data'][0] as $key => $field) {
    $volstats .= $volunteer_data['header'][$key] . ': ' . $field ."\n";
  }
  $event_link = $base_url .'/'. url("node/$nid");

  $variables = _volunteer_message_vars($event, $coordinator, $volunteer);
  $variables['%volstats'] = $volstats;
  switch ($message) {
      case 'new_volunteer':
        $subject = $subject = t("New volunteer for %event_title!", $variables);
        $recipient = $coordinator->mail;
        $message = t("%coordinator,\n\n%volunteer_mail has offered to work at %event_title. You can check the status of that event, see all available volunteers, and approve, deny or waitlist this one by clicking here:\n\n%event_link/volunteer\n\n%volstats", $variables);
        $header = "From: $default_from\nX-Mailer: Drupal\nErrors-to: $coordinator->mail";
        break;
      case 'approve':
        $subject = $subject = t("You've beeen approved for %event_title!", $variables);
        $recipient = $volunteer->location[1]->email[1]->email;
        $text = $event->volunteer['message_approve'] ? $event->volunteer['message_approve'] : variable_get('volunteer_message_approve',_volunteer_default_messages('approve'));
        $message = t($text, $variables);
        $header = 'From: '.t('%coordinator <%coordinator_mail>',$variables)."\nX-Mailer: Drupal\nErrors-to: $coordinator->mail";
        break;
      case 'deny':
        $subject = $subject = t("%event_title was full. Sorry!", $variables);
        $recipient = $volunteer->location[1]->email[1]->email;
        $text = $event->volunteer['message_deny'] ? $event->volunteer['message_deny'] : variable_get('volunteer_message_deny',_volunteer_default_messages('deny'));
        $message = t($text, $variables);
        $header = 'From: '.t('%coordinator <%coordinator_mail>',$variables)."\nX-Mailer: Drupal\nErrors-to: $coordinator->mail";
        break;
      case 'wait':
        $subject = $subject = t("You've been placed on the waiting list for %event_title", $variables);
        $recipient = $volunteer->location[1]->email[1]->email;
        $text = $event->volunteer['message_wait'] ? $event->volunteer['message_wait'] : variable_get('volunteer_message_wait',_volunteer_default_messages('wait'));
        $message = t($text, $variables);
        $header = 'From: '.t('%coordinator <%coordinator_mail>',$variables)."\nX-Mailer: Drupal\nErrors-to: $coordinator->mail";
        break;
      case 'reminder':
        $subject = $subject = t("Reminder about volunteering for %event_title", $variables);
        $recipient = $volunteer->location[1]->email[1]->email;
        $text = $event->volunteer['message_reminder'] ? $event->volunteer['message_reminder'] : variable_get('volunteer_message_reminder',_volunteer_default_messages('reminder'));
        $message = t($text, $variables);
        $header = 'From: '.t('%coordinator <%coordinator_mail>',$variables)."\nX-Mailer: Drupal\nErrors-to: $coordinator->mail";
        break;
      case 'follow_up':
        $subject = $subject = t("How was %event_title?", $variables);
        $recipient = $volunteer->location[1]->email[1]->email;
        $text = $event->volunteer['message_follow_up'] ? $event->volunteer['message_follow_up'] : variable_get('volunteer_message_follow_up',_volunteer_default_messages('follow_up'));
        $message = t($text, $variables);
        $header = 'From: '.t('%coordinator <%coordinator_mail>',$variables)."\nX-Mailer: Drupal\nErrors-to: $coordinator->mail";
        break;
      case 'created':
        $message = "A new event has been added by $user->name, and you're the coordinator!\n\n%event_link";
        $message .= "\n\nGood luck!\n-Mgmt";
        $recipient = $coordinator->mail;
        $subject = "New Event For You (from website)";
        $header = "From: $default_from\nReply-to: $coordinator->mail\nX-Mailer: Drupal\nReturn-path: $coordinator->mail\nErrors-to: $coordinator->mail";
    }

  return user_mail($recipient, $subject, $message, $header);
}


/*
 * @param $nid -> the relevant event node's nid
 * @param $single if true get a specific contact whose contact ID is $cid
 * $param $cid
 * @return -> an array of arrays contact fields for each volunteer assocaited with the event and the header.
 */
function volunteer_get_volunteers($nid, $single = TRUE, $cid = NULL) {
  $data = array();

  if ($single) {
    $result = db_query('SELECT * FROM {volunteer_contact_event} WHERE nid = %d AND cid = %d', $nid, $cid);
  }
  else{
    $result = db_query('SELECT * FROM {volunteer_contact_event} WHERE nid = %d ORDER BY stage DESC', $nid);
  }
  $form_title = variable_get('volunteer_form', '');
  db_set_active('civicrm');
  $header_fields = crm_uf_get_profile_fields($form_title);
  db_set_active();
  if (is_array($header_fields)) {
    foreach($header_fields as $field) {
      $header[$field['name']] = $field['title'];
    }
  }
  else {
    drupal_set_message(t('You need to <a href="%url">assign</a> a CiviCRM profile form for volunteer data collection.', array('%url' => url('admin/settings/volunteer'))), 'error');
  }
  if (!$single) {
    $header['stage'] = t('Stage');
    $header['rating'] = t('Avg. rating');
  }
  $data['header'] = $header;
  while ($volunteer = db_fetch_object($result)) {
    $contact_data = array();
    db_set_active('civicrm');
    $contact = crm_get_contact(array('contact_id' => $volunteer->cid));
    db_set_active();
    if (strtolower(get_class($contact)) != 'crm_contact_bao_contact') {
      continue;
    }
    // TODO @ killes: This does not populate 'first name', 'last name', etc. properly.
    // Can I refer to $contact['contact_type_object'] directly?
    $contact_data = volunteer_get_properties($contact, $header);
    if (!$single) {
      switch ($volunteer->stage) {
        case '1':
          $contact_data['stage'] = l(t('Wait List'), "volunteer/question_coordinator/$volunteer->cid/$nid");
          break;
        case '2':
          $contact_data['stage'] = l(t('Waiting Approval'), "volunteer/question_coordinator/$volunteer->cid/$nid");
          break;
        case '3':
          $contact_data['stage'] = l(t('Approved'), "volunteer/question_coordinator/$volunteer->cid/$nid");
          break;
        case '4':
          $contact_data['stage'] = l(t('Reminded'), "volunteer/question_coordinator/$volunteer->cid/$nid");
          break;
        case '5':
          $contact_data['stage'] = t('Follow Up');
          break;
      }
      $rating = volunteer_get_rating($volunteer->cid);
      $contact_data['rating'] = l($rating['average'], "volunteer/rating/$volunteer->cid/$nid");
    }
    $data['data'][] = $contact_data;
  }
  return $data;
}

function volunteer_count ($nid) {
  $result = db_fetch_object(db_query('SELECT count(cid) AS approved FROM {volunteer_contact_event} WHERE nid = %d AND stage > %d', $nid, 2));
  return $result->approved;
}

function volunteer_check_overload($nid) {
  $wanted = db_fetch_object(db_query('SELECT wanted FROM {volunteer} WHERE nid = %d', $nid));
  return ($wanted->wanted <= volunteer_count($nid)?true:false);
}

function volunteer_wait_volunteer($cid, $nid) {
  $result = db_fetch_object(db_query('SELECT stage FROM {volunteer_contact_event} WHERE cid = %d AND nid = %d', $cid, $nid));
  if ($result->stage != 1) {
    volunteer_mail($cid, $nid, 'wait');
  }
  db_query('UPDATE {volunteer_contact_event} SET stage = 1 WHERE cid = %d AND nid = %d', $cid, $nid);
}

function volunteer_approve_volunteer($cid, $nid) {
  // TODO: convert to validate/submit model for better radability
  if (!volunteer_check_overload($nid) || $_POST['op'] == 'Overload') {
    db_query('UPDATE {volunteer_contact_event} SET stage = %d WHERE cid = %d AND nid = %d', 3, $cid, $nid);
    volunteer_mail($cid, $nid,'approve');
    drupal_set_message(t('Volunteer status approved'));
    return NULL;
  }
  else {
    drupal_set_message(t('Event overloaded'));
    $form['overload'] = array(
      '#type' => 'fieldset',
      '#title' => t('Would you like to overload the event?'),
    );
    $form['cancel'] = array(
      '#type' => 'submit',
      '#value' => t('Cancel'),
    );
    $form['overload'] = array(
      '#type' => 'submit',
      '#value' => t('Overload'),
    );
    return drupal_get_form('overload_event', $form);
  }
}

function volunteer_deny_volunteer($uid, $nid) {
  volunteer_mail($uid, $nid, 'deny');
  db_query('DELETE FROM {volunteer_contact_event} WHERE nid = %d AND cid = %d', $nid, $uid);
}

function volunteer_view_volunteers($node) {
  $data = volunteer_get_volunteers($node->nid, FALSE);
  if(count($data['data'])) {
    $output = theme('table', $data['header'], $data['data']);
  }

  return $output;
}

function volunteer_initial_user_view($node) {
  $output = '<h2>'. t('volunteers wanted: ') . $node->volunteer['wanted'] .'<br />'. t('volunteers found: ') . volunteer_count($node->nid) .'</h2>';

  return $output;
}

function volunteer_event_is_volunteer($node) {
  return ($node->volunteer['wanted'] >= 1);
}

function volunteer_nodeapi(&$node, $op, $arg1 = 0, $arg2 = 0) {
  if (event_is_enabled($node->type)) {
    switch ($op) {
      case 'load':
        $result = db_query('SELECT wanted, uid, message_approve, message_deny, message_wait, message_reminder, message_follow_up FROM {volunteer} WHERE nid = %d', $node->nid);
        if (db_num_rows($result) > 0) {
          $result = db_fetch_object($result);
          $node->volunteer['wanted'] = $result->wanted;
          $node->volunteer['coordinator'] = $result->uid;
          $node->volunteer['message_approve'] = $result->message_approve;
          $node->volunteer['message_deny'] = $result->message_deny;
          $node->volunteer['message_wait'] = $result->message_wait;
          $node->volunteer['message_reminder'] = $result->message_reminder;
          $node->volunteer['message_follow_up'] = $result->message_follow_up;
        }
        break;
      case 'insert':
        if (variable_get('volunteer_event_default', 1)) {
          $author = user_load(array('uid' => $node->uid));
          $coordinator = user_access('volunteer coordinate', $author) ? $node->uid : variable_get('volunteer_coordinator', 1);
          $result = db_query("INSERT INTO {volunteer} (nid, wanted, uid) VALUES (%d, %d, %d)", $node->nid, variable_get('volunteer_wanted',2), $coordinator);
        }
        break;
      case 'view':
        if (!$arg1 && (!$node->volunteer['wanted']) && user_access('volunteer coordinate')) {
          drupal_set_message('No volunteer options have been set for this event. Site visitors and users cannot volunteer. Click the "volunteer admin" tab to set up volunteering', 'error');
        }
        break;
      case 'delete':
        db_query('DELETE FROM {volunteer} WHERE nid = %d', $node->nid);
        db_query('DELETE FROM {volunteer_contact_event} WHERE nid = %d', 