modules/tapatio/comms.module

<?php
// $Id$

/**
 * @file
 * Enables the comms module wich creates a new content type that will hold 
 * communications data which can then be searched, moderated, and dispatched
 * in a number of different fashions.
 *
 * This module is for Drupal 5.x only.
 *
 * Some notes on modifying this file:
 * a) before checking into the repo make sure you do a checkout first and 
 *    merge any changes
 *
 * b) make liberal use of the watchdog() function in your code 
 *    (http://api.drupal.org/api/function/watchdog/5)
 *
 * c) When working with debug values, use this form:
 *   0 - no messages
 *   1 - function tracing w/ simple argument dump (no arrays, objects, or long texts)
 *   2 - undefined
 *   3 - function tracing w/ argument dump
 *   4 - undefined
 *   5 - undefined
 *
 * d) When making twitter api calls make sure that the twitter_api_calls
 *    table is updated with comms_add_twitter_api_call().  We use this so that
 *    we can monitor our rate usage.
 *
 * TODO: start integrating in simple test : http://drupal.org/project/simpletest
 * TODO: write dispatch functionality
      there are two ways we will dispatch something:
      1) If the dispatch button is pressed - check!
      2) If the dispatch level for a node is reached, after voting - check!
      3) A user with points greater then comms_dispatchlevel submits a comms node - test
      4) test without a net connection.
 * TODO: theme any user interface that refers to the comms data type to use
      the system wide configured name.
 * TODO: groups should have free tagging keywords that specify the interests 
      of their groups
 */

/*****************************/
/* HOOK_* AND CORE FUNCTIONS */
/*****************************/

function comms_init() {
  // views_menu is executed
  if (module_exists('views')) {
    include_once('./'. drupal_get_path('module', 'comms') .'/comms_views.inc');
  }
}


function comms_node_info() {
   return array(
      'comms' => array(
      'name' => t('Comms'),
      'module' => 'comms',
      'description' => t("Create communications data."),
    )
  );
}

function comms_perm() {
    return array(
      "add comms data", 
      "edit comms data", 
      "edit own comms data", 
      "vote comms data", 
      "has operator view",
      "has admin view");
}

//we can automatically add the users points to the node vote on submit here
//we can automatically dispatch here as well if the user has enough points
function comms_insert($node) {
  if (variable_get('comms_debuglevel', 0) > 0) {
    drupal_set_message('comms_insert()');
  }

  if (! ($result = db_query("INSERT INTO {comms_additions} (nid, sms_message) VALUES (%d, '%s')", 
    $node->nid, $node->sms_message))) {
    watchdog('comms', t('Could not insert the sms message, source, or tmid into db for node->nid: @nid', array('@nid' => $node->nid)));
  } 
      
  $vote->value = userpoints_get_current_points($node->uid);
  //at this point there are no groups associated with the node
  //so we can't dispatch the node yet
  
  //if the user has 0 points there is no sence in casting a vote
  if ($vote->value != 0) {
    $vote->value_type = 'points';
    $vote->tag = 'vote';
    $result = votingapi_set_vote('comms', $node->nid, $vote, $node->uid);
  }
    
}

//we need to update the sms message if it is set
function comms_update($node) {
  if (variable_get('comms_debuglevel', 0) > 0) {
    drupal_set_message('comms_update()');
  } 

  //check to see if a row for this node has been added
  $query = 'SELECT * from {comms_additions} WHERE nid=%d';
  if (! ($result = db_query_range($query, $node->nid, 0, 1))) {
    //Note that for mysql this will return a numeric value, pgsql a string
    watchdog("comms_group", t("There was a problem selecting from comms_additions. Error: %db_error", 
      array('%db_error' => db_error())));
    drupal_set_message(t("There is a database problem.  Your sms message was not set for this data.  Have one of the admins check the logs."));
    return;
  }

  if (db_num_rows($result) < 1) {
    comms_insert($node);
  } 
  else {

    //update the sms message
    if (! db_query("UPDATE {comms_additions} set sms_message='%s' WHERE nid=%d",
      $node->sms_message, $node->nid)) {
      //Note that for mysql this will return a numeric value, pgsql a string
      watchdog("comms", t("There was a problem updating the comms_additions table with nid=@nid. Error: %db_error", 
        array('@nid' => $node->nid, '%db_error' => db_error())));
    }//if
  }//else
}

//this does not delete votes associated with nodes, because they really belong
//to the users
function comms_delete($node) {
  if (variable_get('comms_debuglevel', 0) > 0) {
    drupal_set_message("comms_delete()");
  }

  if (! ($result = db_query('DELETE from {comms_additions} WHERE nid=%d', $node->nid ) ) ) {
    //Note that for mysql this will return a numeric value, pgsql a string
    watchdog("comms_group", t("There was a problem deleting a row from comms_additions with nid:@nid. Error: %db_error",  
      array('@nid' => $node->nid, '%db_error' => db_error())));
    drupal_set_message(t("There is a database problem. Have one of the admins check the logs."));
    return;
  }

}

function comms_nodeapi(&$node, $op, $teaser = NULL, $page = NULL) {
  global $user;
  if (variable_get('comms_debuglevel', 0) > 0) {
    drupal_set_message("comms_nodeapi()");
  }

  if ($node->type == 'group') {
    drupal_add_css(drupal_get_path('module', 'comms') .'/comms_group.css', 'module', 'all', TRUE);
  } 
  else if ($node->type == 'comms') {
    drupal_add_css(drupal_get_path('module', 'comms') .'/comms.css', 'module', 'all', TRUE);
  }

  //lets handle the validation for group nodes to make sure that all 
  //that twiiter shit is valid
  if ($node->type == 'group' && $op == 'validate') {
    comms_group_form_validate($node);
    return;
  }

  //the associated twitter data validated and now we insert it into the db
  if ($node->type == 'group' && $op == 'insert') {
    comms_group_form_insert($node);
    return;
  }

  //the associated twitter data validated and now we insert it into the db
  if ($node->type == 'group' && $op == 'update') {
    comms_group_form_update($node);
    return;
  }
  
  //the associated twitter data validated and now we insert it into the db
  if ($node->type == 'group' && $op == 'view') {
    comms_group_view($node);
    return;
  }
  
  //the associated twitter data validated and now we insert it into the db
  if ($node->type == 'group' && $op == 'delete') {
    comms_group_delete($node);
    return;
  }
  
}

//TODO: as far as I can tell this is the best place to add specific dispatching scenarios
//- when a node is added and a users points is already >= dispatchlevel
//- when a node has already been dispatched and new groups are added to the node (this is the
//same as a group being added to the node when vote is >= dispatchlevel)
function comms_load($node) {
  if (variable_get('comms_debuglevel', 0) > 0) {
    drupal_set_message('comms_load()');
  }

  $additions = db_fetch_object(
    db_query('SELECT `sms_message` FROM {comms_additions} WHERE `nid` = %d', $node->nid));

  return $additions;
}

function comms_help($section = NULL) {
   switch ($section) {
      case 'admin/help#comms':
      $output = '<p>'. t('The comms module can be used to help organize data for a comunications team.  Incoming data can be associated with different groups which members can subscribe to.') .'</p>';      

      $output = '<p>'. t('This module was developed by the !hbteam<p>', array(
        '!hbteam' => l('hackbloc team', 'http://hackbloc.org') ));
   return $output;
   break;
   }
}

//creates a block of all comms nodes
function comms_block($op = 'list', $delta = 0, $edit = array()) {
  switch ($op) {
  case 'list' :
    $blocks[0]['info'] = t("Comms");
    return $blocks;

  case 'configure':
    
    if ($delta == 0) {
      $form['comms_block_count'] = array(
        '#type' => 'textfield',
        '#title' => 'Count',
        '#size' => 4,
        '#description' => 'Number of nodes to show, 0 will show all',
        '#default_value' => variable_get('comms_block_count', '0'),
      );
    }
    return $form;

  case 'save':
    if ($delta == 0) {
      // Have Drupal save the string to the database.
      variable_set('comms_block_count', $edit['comms_block_count']);
    }
    return;
    
  case 'view': default:
    $block['subject'] = t('Comms');
    // The content of the block is typically generated by calling a custom
    // function.
    $block['content'] = comms_block_contents();
    return $block;
  }
}

//this supplies the contents of the comms block.
//Namely all of the comms nodes
function comms_block_contents() {
  //2008-08-26, evoltech: this query makes sure that we do not pull
  //anything that has already been dispatched, is not enabled, or is
  //not a comms node
  //2008-10-21, evoltech: verified that this is valid pgsql/mysql sql
  $count = variable_get('comms_block_count', 0);
  $sql = "SELECT * FROM {node} AS n WHERE (n.type = 'comms') AND (n.status = 1) AND (n.nid NOT IN (SELECT nid from {comms_group_dispatch})) ORDER BY nid DESC";
  if ($count > 0) {
    $result = db_query_range($sql, 0, $count);
  } 
  else {
    $result = db_query($sql);
  }

  while ($node = db_fetch_object($result)) {
    
    $node->sms_message = comms_load($node);
    $node = node_prepare($node);
    $node = comms_view($node);
    $build .= node_view($node);

  }
  return $build;
}

//responsible for overriding different forms in the
//drupal system
function comms_form_alter($form_id, &$form) {
  if (variable_get('comms_debuglevel', 0) > 0) {
    drupal_set_message("comms_form_alter()");
  }
   
  switch ($form_id) {
    case 'group_node_form':
      comms_group_form_alter($form);
      break;
    default:
  }//switch

}//hook_form_alter

//responsible for responding to different submits on the site
function comms_submit($form_id, &$form = NULL) {
  if (variable_get('comms_debuglevel', 0) > 0) {
    drupal_set_message("comms_submit()");
  }
}

function comms_form(&$node) {
  if (variable_get('comms_debuglevel', 0) > 0) {
    drupal_set_message("comms_form()");
  }
  
  $type = node_get_types('type', $node);

   // We need to define form elements for the node's title and body.
   $form['title'] = array(
      '#type' => 'textfield',
      '#title' => check_plain($type->title_label),
      '#required' => TRUE,
      '#default_value' => $node->title,
      '#weight' => -5
   );
   
  $form['sms_message'] = array(
    '#type' => 'textfield',
    '#maxlength' => 140,
    '#title' => t('SMS Message'),
    '#default_value' => check_plain($node->sms_message),
    '#required' => FALSE
  );

   // We want the body and filter elements to be adjacent. We could try doing
   // this by setting their weights, but another module might add elements to the
   // form with the same weights and end up between ours. By putting them into a
   // sub-array together, we're able force them to be rendered together.
   $form['body_filter']['body'] = array(
      '#type' => 'textarea',
      '#title' => check_plain($type->body_label),
      '#default_value' => $node->body,
      '#required' => FALSE
  );

   return $form;
}

function comms_access($op, $node) {
  global $user;

   if ($op == 'create') {
      // Only users with permission to do so may create this node type.
      return user_access('add comms data');
   }

   // Users who create a node may edit or delete it later, assuming they have the
   // necessary permissions.
   if ($op == 'update' || $op == 'delete') {
      if (user_access('edit own comms data') && ($user->uid == $node->uid)) {
         return TRUE;
      } 
      else {
       return user_access('edit comms data');
      }//else
  }//if

}//comms_access

/* this gives us a list of all comms nodes and their nids, shamefully stolen from og */
//2008-08-26, evoltech: implemented cacheing for this query ala:
//http://www.lullabot.com/articles/a_beginners_guide_to_caching_data
function comms_all_nodes_options($nid_omit=NULL, $reset=NULL) {
  //2008-08-26, evoltech: this query makes sure that we do not pull
  //anything that has already been dispatched, is not enabled, or is
  //not a comms node
  //2008-10-21, evoltech: verified this is valid pgsql/mysql sql
  $sql = "SELECT n.title, n.nid FROM {node} n WHERE (n.type = 'comms') AND (n.status = 1) AND (n.nid NOT IN (SELECT nid from {comms_group_dispatch}))";
  if (is_numeric($nid_omit)) {
    $sql .= " AND (n.nid != $nid_omit)";
  }
  $sql .= " ORDER BY n.title ASC";
  $result = db_query($sql);
  while ($row = db_fetch_object($result)) {
    $options[$row->nid] = $row->title;
  }
  return $options ? $options : array();
}

/* hook_user() : http://api.drupal.org/api/function/hook_user/5
 * we use this to make sure all users have at least one point when
 * they are created
 */
function comms_user($op, $edit, $account, $category = NULL) {
  if (variable_get('comms_debuglevel', 0) > 0) {
    drupal_set_message("comms_user()");
  }
  
  switch ($op) {
  //"insert": The user account is being added. The module should save 
  //its custom additions to the user object into the database and set 
  //the saved fields to NULL in $edit. 
  case 'insert':
    $param = array(
      'points' => 1,
      'uid' => $account->uid
    );  
    userpoints_userpointsapi($param);
    break;
  }//switch

}

/*****************************/
/* COMS DISPLAY FUNCTIONS */
/*****************************/

//this is where we should implement the following requirement: http://rnc08coms.hackbloc.org/node/45
//TODO: how do you use the theming functions here?
//TODO: also make sure that the use has permission to see the vote form
function comms_view($node, $teaser = FALSE, $page = FALSE) {
  if (variable_get('comms_debuglevel', 0) > 0) {
    drupal_set_message("comms_view()");
  }
  
  $node = node_prepare($node, $teaser);

  $node->content['comms_sms_message'] = array(
    '#value' => theme('comms_sms_message', 
    comms_get_sms_message($node->nid))
  );

  //include a node delete form button
  $node->content['comms_delete'] = array(
    '#weight' => 3,
    '#value' => theme('comms_delete',
      l('Delete', "node/$node->nid/delete", NULL, drupal_get_destination()))
  );

  //function that will generate the themed section that holds
  //the Rating, Groups, Dispatch section of a comms node
  //this shit should not even get displayed if the node has already been 
  //dispatched
  $node->content['rgd_section'] = array(
    '#value' => create_rgd_section($node)
  );

  return $node;

}

/*****************************/
/* COMS ADMIN FORM FUNCTIONS */
/*****************************/

function comms_admin_twitterAPI() {
  $default_collection_method = '';
  if (variable_get('comms_searchalltweets', 0)) {
    $default_collection_method = 0;
  }
  else if (variable_get('comms_addfromgetfollowers', 0)) {
    $default_collection_method = 1;
  }

  $form['comms_collection_method'] = array(
    '#type' => 'radios',
    '#title' => t('Comms collection method'),
    '#options' => array(t('Search All Tweets'), t('Add From getFollowers()')),
    '#default_value' => $default_collection_method,
    '#description' => t("There are two main collection methods for twitter content.  The first, <strong>search all tweets</strong>, uses the").  
      l(t("twitter search API"), 'http://search.twitter.com/api') .
      t(" to collect data from followers of groups with assigned twitter accounts. The second is to collect posts from the status returned as we poll for new followers for each group.  This may be usefull if the twitter search index is back logged."),
  );
  
  $form['comms_twitterAPI_path'] = array(
    '#type' => 'textfield',
    '#title' => t('Twitter API Path'),
    '#default_value' => variable_get('comms_twitterAPI_path', 
    drupal_get_path('module', 'comms') .'/Arc90_Service_Twitter/lib/Arc90/Service'),
    '#description' => t("The path to the Arc90 Twitter API library. For example: 'modules/comms/Arc90_Service_Twitter/lib/Arc90/Service'"),
    '#after_build' => array('_audio_twitterAPI_settings_check_path'),
  );

  $form['audio_getid3_version'] = array(
    '#type' => 'item',
    '#title' => t('Include Check'),
  );
  if (comms_twitterAPI_isfound() &&
    preg_match('/Arc90_Service_Twitter Object/', 
    print_r(_comms_twitterAPI_load(), 1))) {
    $form['audio_getid3_version']['#value'] = 'Included';
    $form['audio_getid3_version']['#description'] = 
      t("If you're seeing this it indicates that the Twitter API library was found.");
  }//if
  else {
    $form['audio_getid3_version']['#value'] = 'NOT Included';
    $form['audio_getid3_version']['#description'] = 
      t("The Twitter API library was not included.");
  }

  return system_settings_form($form);
}

function comms_admin() {


  $form['comms_debuglevel'] = array(
    '#type' => 'textfield',
    '#title' => t('Comms module debug level'),
    '#default_value' => variable_get('comms_debuglevel', 0),
    '#size' => 2,
    '#maxlength' => 2,
    '#description' => t("Comms Debug Level")
  ); 

  $form['comms_dispatchlevel'] = array(
    '#type' => 'textfield',
    '#title' => t('Rating to dispatch info at'),
    '#default_value' => variable_get('comms_dispatchlevel', 5),
    '#size' => 2,
    '#maxlength' => 2,
    '#description' => t("The rating at which to dispatch a piece of info at")
  );

  $form['comms_actionname'] = array(
    '#type' => 'textfield',
    '#title' => t('Comms action name'),
    '#default_value' => variable_get('comms_actionname', "comms"),
    '#size' => 25,
    '#maxlength' => 25,
    '#description' => t("The name of the action")
  );

  return system_settings_form($form);
}

//this should be used to validate anything that can be changed in the 
//comms_admin form. Drupal checks all input, but it is a good idea to
//provide additional checks, cause, ya know hackers and stuff
function comms_admin_validate($node, &$form) {
   $dispatchlevel = $form['comms_dispatchlevel'];
   if (!is_numeric($dispatchlevel)) {
      form_set_error('comms_dispatchlevel', t('You must select a number for the dispatch level.'));
   }
   else if ($dispatchlevel < 1) {
      form_set_error('comms_dispatchlevel', t('Minimum dispatch level must be positive.'));
   }
   else if ($dispatchlevel > 10) {
      form_set_error('comms_dispatchlevel', t('Maximum dispatch level must be less then or equal to 10.'));
  }

   $actionname = $form['comms_actionname'];
   if (!is_string($actionname)) {
      form_set_error('comms_actionname', t('The action name must be a string.'));
   }
   else if (strlen($actionname) < 4) {
      form_set_error('comms_actionname', t('The action name must be between 4 and 25 characters.'));
   }
   else if (strlen($actionname) > 25) {
      form_set_error('comms_actionname', t('The action name must be between 4 and 25 characters.'));
    
   }
  
  $debuglevel = $form['comms_debuglevel'];
   if (!is_numeric($debuglevel)) {
      form_set_error('comms_debuglevel', t('You must select a number for the debug level.'));
   }
   else if ($debuglevel < 0) {
      form_set_error('comms_debuglevel', t('Minimum debug level must at least zero.'));
   }
   else if ($debuglevel > 10) {
      form_set_error('comms_debuglevel', t('Maximum debug level must be less then or equal to 10.'));
  }

}

function comms_admin_submit($form_id, $node) {
  if ($node['comms_collection_method']) {
    variable_set('comms_searchalltweets', 0);
    variable_set('comms_addfromgetfollowers', 1);
  }
  else {
    variable_set('comms_searchalltweets', 1);
    variable_set('comms_addfromgetfollowers', 0);
  }
}//comms_admin_submit


//hook_forms
//this will act as a dispatcher for all comms_vote forms when they are displayed
//as a list.  Niether of the forms validate or submit functions are getting called???
function comms_forms() {
  $args = func_get_args();

  if (variable_get('comms_debuglevel', 0) > 0) {
    drupal_set_message("comms_forms()");
  }

  //handle the voteing forms
  if (strpos($args[0][0], 'comms_vote') !== FALSE) {
    if ($args[0][0] == 'comms_vote_'. $args[0][1] .'_'. $args[0][2]) {
      $forms[$args[0][0]] = array('callback' => 'comms_vote');
      return $forms;
    }
  }
  //handle the dispatching forms
  else if (strpos($args[0][0], 'comms_dispatch') !== FALSE) {
    if ($args[0][0] == 'comms_dispatch_'. $args[0][1] .'_'. $args[0][2]) {
      $forms[$args[0][0]] = array('callback' => 'comms_dispatch');
      return $forms;
    }
  }
  //handle the groups forms
  else if (strpos($args[0][0], 'comms_groups') !== FALSE) {
    if ($args[0][0] == 'comms_groups_'. $args[0][1] .'_'. $args[0][2]) {
      $forms[$args[0][0]] = array('callback' => 'comms_groups');
      return $forms;
    }
  }
  //handle the deduplication forms
  else if (strpos($args[0][0], 'comms_dedup') !== FALSE) {
    if ($args[0][0] == 'comms_dedup_'. $args[0][1] .'_'. $args[0][2]) {
      $forms[$args[0][0]] = array('callback' => 'comms_dedup');
      return $forms;
    }
  }
  //handle the priority forms
  else if (strpos($args[0][0], 'comms_priority') !== FALSE) {
    if ($args[0][0] == 'comms_priority_'. $args[0][1] .'_'. $args[0][2]) {
      $forms[$args[0][0]] = array('callback' => 'comms_priority');
      return $forms;
    }
  }
}

/********************************/
/* COMMS PRIORITY FORM FUNCTIONS */
/********************************/
function comms_priority($content_type, $content_id) {
  if (variable_get('comms_debuglevel', 0) > 0) {
    drupal_set_message("comms_priority()");
  }
  
  if (user_access('edit comms data')) {
    $form['#base'] = 'comms_priority_'. $content_type .'_'. $content_id;  
    $form['#theme'] = 'comms_priority';  

    $default_value = array_keys(taxonomy_node_get_terms($content_id));
    $form['comms_priority'] = taxonomy_form(1, $default_value[0]);

    $form['comms_priority_submit'] = array(
      '#id' => 'comms_priority_submit_'. $content_id,
      '#type' => 'submit',
      '#value' => 'Update Priority'
    );

    //this is some ninja shit here.  For an explanation of why we need to
    //use #submit see: http://tinyurl.com/472gcp
    $form['#submit']  = array(
      'comms_priority_submit' => array());

    $form['#validate']  = array(
      'comms_priority_validate' => array());
  }//if
  return $form;
}

function comms_priority_validate($form_id, $form_values=NULL, $form=NULL) {
  //make sure we have form values
  if (is_null($form_values)) {
    form_set_error('comms_priority_submit', 'You have sumbitted invalid data');
  }

  if (!preg_match('/(\d+)$/', $form_id)) {
    form_set_error('comms_priority_submit', 'You have sumbitted invalid data');
  }
}

function comms_priority_submit($form_id, &$form) {
  if (preg_match('/(\d+)$/', $form_id, $matches)) {
    taxonomy_node_save($matches[1], array($form['comms_priority']));
  }
}

/*****************************/
/* COMS VOTE FORM FUNCTIONS */
/*****************************/

//This will contain all the form data for casting a vote on a piece of 
//information.  These have to be of type 'submit' instead of 'button' so that
//the comms_vote_submit gets called when they are pressed
//drupal 5.x form api docs: http://api.drupal.org/api/file/developer/topics/forms_api_reference.html/5
//TODO: we could do some fancy stuff here like only displaying one of the
//buttons if a user already voted
function comms_vote($content_type, $content_id) {
  global $user;
  if (variable_get('comms_debuglevel', 0) > 0) {
    drupal_set_message("comms_vote()");
  }
  
  static $js_added = FALSE;
  if (!$js_added) {
    drupal_add_js(drupal_get_path('module', 'comms') .'/js/comms.js');
    $js_added = TRUE;
  }//if

  //get a list of all votes indexed by user that cast them
  //for some reason $content_type here is always $node ???
  $votes = votingapi_get_content_votes('comms', $content_id);
  
  $form['#theme'] = 'comms_vote';
  
  $form['content_type'] = array(
    '#type' => 'hidden',
    '#value' => $content_type,
    '#id' => $content_id ? 'edit-content-type-'. $content_id : NULL,
    '#prefix' => '<div id="comms_vote" class="comms-form-item">',
  );

  //2008-08-29, evoltech: it was decided that users should vote multiple times
  //we do not list include the form for users who have already voted
  //or who are not permitted to vote
  if (
    user_access('vote comms data')
  ) {
    $form['comms_vote_select'] = array(
     '#type' => 'select',
     '#options' => array(
       '1' => '/'. drupal_get_path('module', 'comms') .'/plus1.jpg',
       '-1' => '/'. drupal_get_path('module', 'comms') .'/minus1.jpg',
       ),
     '#id' => 'edit-comms-vote-'. $content_id,
    );

    $form['auto_submit_path'] = array(
      '#type' => 'hidden',
      '#value' => url('comms/vote/comms/'. $content_id),
      '#id' => 'edit-auto-submit-path-'. $content_id,
      '#attributes' => array('class' => 'comms-vote-path'),
    );
  }//if
    
  $form['content_id'] = array(
    '#type' => 'hidden',
    '#value' => $content_id,
    '#id' => $content_id ? 'edit-content-id-'. $content_id : NULL,
  );

  $result = votingapi_get_voting_results('comms', $content_id);
  $vote_ct = $result[2]->value;
  $point_ct = $result[1]->value;

  if (is_array($votes) && count($votes) > 0) {
    $total_vote = "<label>". t("Rating") 
      .":</label> <div class=\"value\">$point_ct</div>";
  }
  else {
    $total_vote = "<label>". t("Rating") 
      .":</label> <div class=\"value\">0</div>"; 
  }
  
  //the #prefix here should really be done in a theming form, 
  //but I can't seem to get it working
  $form['destination'] = array(
    '#type' => 'hidden',
    '#value' => $_GET['q'], 
    '#id' => isset($content_id) ? 'edit-destination-'. $content_id : NULL,
    '#prefix' => '<div class="comms-vote-summary" id="comms-vote-summary-'. $content_id .'">'. 
      $total_vote .'</div>',
    '#suffix' => '</div>'
  );

  return $form;
}

//This function will be called whenever one of the vote buttons from the 
//comms_vote form are pressed.  A vote is placed by a user of the system
//most likely an operator, it should not be confused with the initial
//vote value of a user contributing a piece of information, which can
//be added to another node if the two pieces are concatenated
function comms_vote_validate($node, &$form) {
  //Votes are 1 or -1, but we recieve it from the form as a string, so we have
  //to type cast it first
  if (variable_get('comms_debuglevel', 0) > 0) {
    drupal_set_message("comms_vote_validate()");
  }
  
  $vote = (int)$form['op'];
  if ($vote != -1 && $vote != 1) {
      form_set_error('comms_vote', t('There was a illegal vote cast. Votes are +1 or -1.'));
      watchdog('comms_vote', t("There was a illegal vote cast. Votes are +1 or -1."));
  } 
}

//Not sure that this can be done like this
function comms_comms_vote($form) {
  if (variable_get('comms_debuglevel', 0) > 0) {
    drupal_set_message("comms_comms_vote()");
  }
  $output = '<div class="comms_vote_form">';
  $output .= drupal_render($form);
  $output .= '</div>';
  return $output;
}

//this will return some xml for the client side js
function comms_vote_execute($type, $cid, $value, $tag = 'vote', $ignore_user=FALSE, $rval='xml') {
   global $user;

  $user_message = '';
  $dont_query = 0;
  $dont_vote = 0;

   //make sure this is a comms node
  $node = node_load($cid);
  $type = $node->type;
  if ($type != "comms") {
    watchdog("comms_vote", t("attempting to execute comms vote for a non comms node type"));
    $user_message .= t("You tried to vote for a invalid node type.") ."<br />";
    $dont_query = 1;
  }

  //only logged in users can vote
  if (!isset($uid)) {
    if ($user->uid) {
      $uid = $user->uid;
    }
    else {
      watchdog("comms_vote", t("attempting to cast a vote for anonomous user"));
      $user_message .= t('Only !userlink users can vote', 
        array('!userlink' => l('logged in', 'user')));
      $dont_vote = 1;
    }
  }

  if ($ignore_user) 
    $uid = NULL;

  //if $value is passed in as a string we need to convert it
  if (is_string($value)) {
    $value = (int)$value;
  }

  if (!is_numeric($cid)) {
    watchdog("comms_vote", t("attempting to cast a vote for a non-numeric cid"));
    $user_message .= t('You tried to vote on an invalid node') .'.<br />';
    $dont_query = 1;
  }

  if ($value != 1 && $value != -1 && !$ignore_user) {
    watchdog("comms_vote", t("attempting to cast a vote for an invalid value: %value", array('%value' => $value)));
    $user_message .= t('You tried to cast an invalid vote') .'.<br />';
    $dont_vote = 1;
  }

  if (!$dont_vote && !$dont_query) {
    $ballot->value = $value;
    $ballot->value_type = 'points';
    $ballot->tag = 'vote';

    //2008-08-31, evoltech: we are now saying that multiple votes should be able 
    //to be cast.  We are recieving the vote object cast here not the vote result
    //we want to make sure that if this vote will put us over the dispatch level
    //then we need to not increase the vote unless the dispatch succeeds
    $vote = votingapi_get_voting_results($type, $cid);
    if ($value + $vote[1]->value >= variable_get('comms_dispatchlevel', 5)) {
      $message = comms_group_dispatch_validate($node);
      if ($message != 1) {
        $user_message .= $message; 
      }
      else {
        $message = comms_group_dispatch($node);
        if ($message != 1) {
          $user_message .= $message; 
        }
        else {
          $user_message .= t('Dispatched!') .'<br />';
          $vote_cast = votingapi_add_vote($type, $cid, $value, 'points', 'vote', $uid);
          $vote = votingapi_recalculate_results($type, $cid);
        }//else
      }//else
    }
    else {
      $vote_cast = votingapi_add_vote($type, $cid, $value, 'points', 'vote', $uid);
      $vote = votingapi_recalculate_results($type, $cid);
    }
      
  }//if
  else {
    watchdog("comms_vote", t("we could not vote"));
  }

  if (!$dont_query) {  
    $result = votingapi_get_voting_results($type, $cid);
    $votes = votingapi_get_content_votes($type, $cid); 

    $sum = $result[1]->value;
    $count = $result[2]->value;
  }

   if (count($result)) {
     foreach ($result as $data) {
       if ($data->tag == $tag) {
         $output .= '<'. $data->function .'>'. $data->value .'</'. $data->function .'>';
         $summary[$data->tag][$data->function] = $data->value;
       }//if
     }//foreach
  }//if

  $output = '';
  $output .= '<?xml version="1.0" encoding="UTF-8"?>';
  $output .= '<xml>';
  if (!$dont_query) {
    $output .= '<result><summary>';
    $output .= '<count>'. $count .  '</count>';

    $output .= '<sum>'.  $sum .'</sum>';

    $output .= '<voters>';
    foreach (array_keys($votes) as $voter) {
      $output .= '<voter><path>'. url("user/$voter") .'</path>';
      $output .= '<username>'. uid_to_username($voter) . 
      '('. 
      userpoints_get_current_points($voter) .
      ')'.
        '</username></voter>';
    }
    $output .= '</voters>';

    $output .= '</summary>';
    $output .= '</result>';
  }//!$dont_query
  
  //if (!$dont_vote) {
    $output .= '<vote>';
    $output .= '<value>'. $value .'</value>';
    $output .= '<type>'. $type .'</type>';
    $output .= '<id>'. $cid .'</id>';
    $output .= '</vote>';
  //}
    
    if (variable_get('comms_debuglevel', 0) > 0) {
      $output .= '<debug>'. print_r($votes, 1) .'</debug>';
    }

    $output .= '<debug_dont_vote>'. $dont_vote .'</debug_dont_vote>';
    $output .= '<debug_dont_query>'. $dont_query .'</debug_dont_query>';
    $output .= '<user_message>'.  $user_message .'</user_message>';
    $output .= '<params>'.  'rval: '. $rval .' user: '. $ignore_user .'</params>';
  $output .= '</xml>';
    if ($rval == 'xml') {
      drupal_set_header("Content-Type: text/xml");
      exit($output);
    }
    else {
      return ( $user_message ." ". $value ." ". t("user") .": ". $uid );
    }
} 

/***************************************/
/* COMS DE-DUPLICATE FORM FUNCTIONS    */
/***************************************/

// This contains all the logic for creating a form for users
// to report a duplicate node, the node is removed and then 
// the points for that node are given to the node it is a duplicate of

function comms_dedup($content_type, $content_id) {
  if (variable_get('comms_debuglevel', 0) > 0) {
    drupal_set_message('comms_dedup()');
  }
  

  //we do not list include the form for those who are not 
  //able to edit comms data
  if (user_access('edit comms data')) {
    $form['#base'] = 'comms_dedup_'. $content_type .'_'. $content_id;  
    $form['#theme'] = 'comms_dedup';  
 
    
      $form['comms_dedup_duplicate_nodeid'] = array(
        '#id' => 'comms_dedup_nodeid_'. $content_id,
        '#type' => 'hidden',
        '#value' => $content_id
      );

      $form['comms_dedup_good_nodeid'] = array(
        '#id' => 'comms_dedup_good_nodeid_'. $content_id,
        '#type' => 'select',
        '#title' => t('This is a duplicate of:'),
        '#multiple' => FALSE,
        '#attributes' => array('class' => 'comms_dedup'),
        '#default_value' => t('Select duplicate node...'),
        '#options' => comms_all_nodes_options($content_id)
      );

      $form['comms_dedup_submit'] = array(
        '#id' => 'comms_dedup_submit_'. $content_id,
        '#type' => 'submit',
        '#value' => t('Deduplicate node')
      );

      //this is some ninja shit here.  For an explanation of why we need to
      //use #submit see: http://tinyurl.com/472gcp
      $form['#submit']  = array(
        'comms_dedup_submit' => array());
      
      $form['#validate']  = array(
        'comms_dedup_validate' => array());
  } //if
  return $form;
} // end deduping form functions

function comms_dedup_validate($form_id, $form_values=NULL, $form=NULL) {
  

  //make sure we have form values
  if (is_null($form_values)) {
    form_set_error('comms_dedup_submit', 
      t('You have sumbitted invalid data for deduplication form_values'));
    return;
  }

  //make sure that the values are numeric and exist
  if (!isset($form_values['comms_dedup_duplicate_nodeid']) 
      || !isset($form_values['comms_dedup_good_nodeid'])
      || !is_numeric($form_values['comms_dedup_duplicate_nodeid']) 
      || !is_numeric($form_values['comms_dedup_good_nodeid']) ) {
        form_set_error('comms_dedup_submit', 
          t('You have sumbitted invalid data for deduplication'));
        return;
      }

  //at least they are real nodes so lets load the fuckers
  $dupe_node = node_load($form_values['comms_dedup_duplicate_nodeid']);
  $good_node = node_load($form_values['comms_dedup_good_nodeid']);
  if ($dupe_node->type != 'comms' || $good_node->type != 'comms') {
    form_set_error('comms_dedup_submit', 
      t('You have sumbitted invalid data for deduplication. One of these things is not like the other.'));
    return;
  }

  //lets also check that the node we hope to be jumping onto has a sms field 
  //and an associated group if the combined vote will be > comms_dispatchlevel
  $dupe_node_rate = votingapi_get_voting_results('comms', $dupe_node->nid);
  $dupe_node_rate = $dupe_node_rate[1]->value;
  
  $good_node_rate = votingapi_get_voting_results('comms', $good_node->nid);
  $good_node_rate = $good_node_rate[1]->value;
  if ($good_node_rate + $dupe_node_rate >=
    variable_get('comms_dispatchlevel', 0)) {

    if (is_null($good_node->sms_message) || $good_node->sms_message == '') {
      form_set_error('comms_dedup_submit', 
        t("This operation will cause the dispatching of") 
        .'"<strong>'.
        $good_node->title 
        .'</strong>"'.
        t("but it does not have a sms message to dispatch."));
    }

    $asc_groups = module_invoke('og', 'get_node_groups', $good_node);
    if (!is_array($asc_groups) || count($asc_groups) == 0) {
      form_set_error('comms_dedup_submit', 
        t("This operation will cause the dispatching of")
        ." \"<strong>".
        $good_node->title 
        ."</strong>\"".
        t("but it does not have any groups to dispatch to."));
    }
  }//if

  // if we hit here then we now definitely have a comms node that is good to go.
  return;
}

function comms_dedup_submit($form_id, &$form) {
  $dupe_node = node_load($form['comms_dedup_duplicate_nodeid']);
  $good_node = node_load($form['comms_dedup_good_nodeid']);
  
  //this next function returns an array matching votingapi_vote records for the nid we specify
  $dnode_votes = votingapi_get_content_votes('comms', $dupe_node->nid);
  $gnode_votes =  votingapi_get_content_votes('comms', $dupe_node->nid);
  foreach ($dnode_votes as $dvuid) {
    $duid = $dvuid[0]->uid;
    $dvalue = $dvuid[0]->value;
    
    //delete all votes for duplicate content
    if (isset($gnode_votes[$duid])) {
      votingapi_unset_vote("comms", $gnode_votes[$duid][0]->content_id, $duid);
    }

    //add the old votes to the new node.
    $beep = votingapi_add_vote("comms", $good_node->nid, $dvalue, 'points', 'vote', $duid);
  }

  // we have to do this to update the votingapi_cache table
  votingapi_recalculate_results("comms", $good_node->nid, TRUE);

  //if we have enough votes to dispatch we should do it now
  //hyper on red jarito!
  $rate = votingapi_get_voting_results('comms', $good_node->nid);
  $rate = $rate[1]->value;
  if ($rate >= variable_get('comms_dispatchlevel', 0)) {
    $arg['comms_dispatch_nodeid'] = $good_node->nid;
    $message = comms_group_dispatch($good_node);
    drupal_set_message(
      t("Dispatched") ." \"<strong>". 
      check_plain($good_node->title) ."</strong>\": ".
      $message);
  }//if

  // now  we take care of the groups 
  $dupe_node_groups = module_invoke('og', 'get_node_groups', $dupe_node);

  foreach ($dupe_node_groups as $gid => $v) {
    $good_node->og_groups[] = $gid;
  }
  // and save our changes
  og_save_ancestry($good_node);

  $dupe_node->status = 0;
  node_save($dupe_node);
}

/***************************************/
/* COMS SEARCH FORM FUNCTIONS          */
/***************************************/

//then we want to see if we can check the search results and generate the view dynamically
//check $form_values or $_POST['edit']
//TODO: this is a total hack ... there has to be a correct way to do this
function comms_search() {
  $return = drupal_get_form('comms_search_page');
  
  
  if ($_SESSION['comms']['submit'] == 1) {
    $timeframe = (isset($_SESSION['comms']['timeframe']) &&  
      $_SESSION['comms']['timeframe'] != '') ? 
      $_SESSION['comms']['timeframe'] : 'All';

    $rating = (isset($_SESSION['comms']['rating']) && 
      $_SESSION['comms']['rating'] != '') ? 
      $_SESSION['comms']['rating'] : 'All';

    $dispatched = 'not';
    //we check to see if either they are both set or if they are not set, I know its funky
    //maybe there is a better way to do this
    if (
      (strcmp($_SESSION['comms']['dispatched']['dispatched'], 'dispatched') == 0 &&
      strcmp($_SESSION['comms']['dispatched']['notdispatched'], 'notdispatched') == 0) ||
      
      ($_SESSION['comms']['dispatched']['notdispatched'] === 0 &&
      $_SESSION['comms']['dispatched']['dispatched'] === 0 ) 
    ) {
      $dispatched = 'All';
    }
    else if (strcmp($_SESSION['comms']['dispatched']['dispatched'], 'dispatched') == 0) { 
      $dispatched = '1';
    } 

    $categorized = 'not';
    //we check to see if either they are both set or if they are not set, I know its funky
    //maybe there is a better way to do this
    //This is not working correctly
    if (
      (strcmp($_SESSION['comms']['categorized']['categorized'], 'categorized') == 0 &&