modules/project_issue_voting/project_issue_voting.module

<?php
// $Id: project_issue_voting.module,v 1.28 2008/10/09 22:06:33 thehunmonkgroup Exp $


/**
 * @file
 * This module adds a widget for voting on project issue nodes.
 * It depends on the Project issue tracking module and Voting API.
 */

/**
 * Implementation of hook_help().
 */
function project_issue_voting_help($section) {
  switch ($section) {
    case 'admin/help#project_issue_voting':
      return '<p>'. t('This module is used to add a simple voting widget to Project issue node types.') .'</p>';

    case 'user/'. arg(1) .'/project-issue-votes':
      return '<p>'. t('This page shows a summary of voting for project issues.  Total votes used is listed at the top, then the table shows how many votes were used for each issue.  A user can reclaim all votes from an issue (to be used for voting on other issues) by clicking the <em>Reclaim votes</em> link.') .'</p>';
  }
}

/**
 * Implementation of hook_perm().
 */
function project_issue_voting_perm() {
  return array('vote on issues', 'view issue votes', 'administer issue voting');
}

/**
 * Form builder for the administrative settings form.
 */
function project_issue_voting_admin_settings() {
  $form['project_issue_voting_allowed_user_votes'] = array(
    '#type' => 'textfield',
    '#title' => t('Total votes per user'),
    '#size' => 5,
    '#maxlength' => 5,
    '#required' => TRUE,
    '#default_value' => variable_get('project_issue_voting_allowed_user_votes', 20),
    '#description' => t('The total number of votes that a user is allowed to place across all project issues.'),
    '#validate' => array('project_issue_voting_validate_numeric' => array()),
  );

  $form['vote_node_types'] = array(
    '#type' => 'fieldset',
    '#title' => t('Types'),
    '#description' => t('Set the issue types you want to activate voting on.  For each type of filtering, leaving all boxes unchecked will result in no filtering for that type.'),
    '#collapsible' => TRUE,
  );

  // Add limit by project type if we're using taxonomy.
  if (project_use_taxonomy()) {
    $vid = _project_get_vid();
    $tree = taxonomy_get_tree($vid, 0, -1, 1);
    $options = array();
    foreach ($tree as $term) {
      $options[$term->tid] = $term->name;
    }

    $form['vote_node_types']['project_issue_voting_project_types'] = array(
      '#type' => 'checkboxes',
      '#title' => t('Project types'),
      '#default_value' => variable_get('project_issue_voting_project_types', array()),
      '#options' => $options,
    );
  }

  $form['vote_node_types']['project_issue_voting_issue_categories'] = array(
    '#type' => 'checkboxes',
    '#title' => t('Categories'),
    '#default_value' => variable_get('project_issue_voting_issue_categories', array()),
    '#options' => project_issue_category(0),
  );

  $form['vote_node_types']['project_issue_voting_issue_states'] = array(
    '#type' => 'checkboxes',
    '#title' => t('States'),
    '#default_value' => variable_get('project_issue_voting_issue_states', array()),
    '#options' => project_issue_state(),
  );

  $form['vote_widget_settings_node'] = array(
    '#type' => 'fieldset',
    '#title' => t('Vote widget settings for nodes'),
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
  );

  $widget_options = array(
    'disabled' => t('Disabled'),
    'teaser' => t('Teaser view'),
    'full' => t('Full-page view'),
    'teaser-full' => t('Teasers and full-page view'),
  );
  $form['vote_widget_settings_node']['project_issue_voting_widget_node'] = array(
    '#type' => 'select',
    '#title' => t('Vote widget display'),
    '#default_value' => variable_get('project_issue_voting_widget_node', 'full'),
    '#options' => $widget_options,
    '#description' => t('When to display the vote widget for nodes.'),
  );
  $form['vote_widget_settings_node']['project_issue_voting_link_node'] = array(
    '#type' => 'select',
    '#title' => t('Link display of total votes for an issue'),
    '#default_value' => variable_get('project_issue_voting_link_node', 'teaser'),
    '#options' => $widget_options,
    '#description' => t('When to display total issue votes for nodes.'),
  );

  $form['vote_widget_settings_advanced'] = array(
    '#type' => 'fieldset',
    '#title' => t('Advanced settings'),
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
  );

/*
  Decided to not expose this setting to admins.

  $form['vote_widget_settings_advanced']['project_issue_voting_tag'] = array(
    '#type' => 'textfield',
    '#title' => t('Vote tag'),
    '#default_value' => variable_get('project_issue_voting_tag', 'issue'),
    '#description' => t('All votes from the Project issue voting module will be tagged with this term. Using a unique value here may be useful when you deploy various voting modules that all use the Voting API. (Default: issue)'),
  );
*/

  $form['vote_widget_settings_advanced']['project_issue_voting_reset_votes'] = array(
    '#type' => 'radios',
    '#title' => t("Provide a 'Reset votes' link on issues"),
    '#default_value' => variable_get('project_issue_voting_reset_votes', 0),
    '#options' => array(0 => t('No'), 1 => t('Yes')),
    '#description' => t('If yes a link will be displayd on nodes that will reset the users votes on that node.'),
  );

  return system_settings_form($form);
}

/**
 * Implementation of hook_menu().
 */
function project_issue_voting_menu($may_cache) {
  $items = array();

  $vote_access = user_access('vote on issues');
  $view_votes_access = user_access('view issue votes');
  $admin_votes_access = user_access('administer issue voting');

  $types = node_get_types();
  $name = $types['project_issue']->name;

  if ($may_cache) {
    $items[] = array(
      'path' => 'admin/project/project-issue-voting',
      'title' => t('@project_issue_type voting', array('@project_issue_type' => $name)),
      'description' => t('Set up voting on @project_issue_type nodes.', array('@project_issue_type' => $name)),
      'callback' => 'drupal_get_form',
      'callback arguments' => 'project_issue_voting_admin_settings',
      'access' => $admin_votes_access,
    );
    $items[] = array(
      'path' => 'project-issue-voting-vote',
      'callback' => 'project_issue_voting_vote',
      'access' => $vote_access,
      'type' => MENU_CALLBACK,
    );
    $items[] = array(
      'path' => 'project/issues/votes',
      'title' => t('@project_issue_type votes', array('@project_issue_type' => $name)),
      'description' => t('@project_issue_type vote summaries.', array('@project_issue_type' => $name)),
      'callback' => 'project_issue_voting_page',
      'access' => $view_votes_access,
    );
    $items[] = array(
      'path' => 'project/issues/votes/users',
      'title' => t('Users by votes'),
      'callback' => 'project_issue_voting_users_votes',
      'access' => $view_votes_access,
    );
  }
  else {
    if (arg(0) == 'node' && is_numeric(arg(1))) {
      $node = node_load(arg(1));
      if (project_issue_voting_check_issue_for_voting($node)) {
        $items[] = array(
          'path' => 'node/'. arg(1) .'/project-issue-votes',
          'title' => t('Votes'),
          'callback' => 'project_issue_voting_issue_votes',
          'callback arguments' => array($node),
          'access' => $view_votes_access,
          'weight' => 5,
          'type' => MENU_LOCAL_TASK,
        );
        drupal_add_css(drupal_get_path('module', 'project_issue_voting') .'/project_issue_voting.css');
        drupal_add_js(drupal_get_path('module', 'project_issue_voting') .'/project_issue_voting.js');
        drupal_add_js(
          array(
            'projectIssueVotingURL' => url('project-issue-voting-vote'),
            'projectIssueVotingToken' => project_issue_voting_get_token(),
          ),
          'setting'
        );
      }
    }
    if (arg(0) == 'user' && is_numeric(arg(1))) {
      $account = user_load(array('uid' => arg(1)));
      $items[] = array(
        'path' => 'user/'. arg(1) .'/project-issue-votes',
        'title' => t('@project_issue_type votes', array('@project_issue_type' => $name)),
        'callback' => 'project_issue_voting_user_votes',
        'callback arguments' => array($account),
        'access' => $view_votes_access,
        'weight' => 5,
        'type' => MENU_LOCAL_TASK,
      );
    }
    if (module_exists('views')) {
      drupal_add_css(drupal_get_path('module', 'project_issue_voting') .'/project_issue_voting.views.css');
    }
  }
  return $items;
}

/**
 * Implementation of hook_nodeapi().
 */
function project_issue_voting_nodeapi(&$node, $op, $teaser = NULL, $page = NULL) {
  switch ($op) {
    case 'view':
      if (project_issue_voting_check_issue_for_voting($node) && project_issue_voting_display('node', $teaser)) {
        $node->content['project_issue_voting'] = array(
          '#value' => project_issue_voting_interface($node),
          '#weight' => -50,
        );
      }
      break;

    case 'delete':
      project_issue_voting_delete_votes($node);
      break;
  }
}

/**
 * Implementation of hook_link().
 */
function project_issue_voting_link($type, $node = NULL, $teaser = FALSE) {
  $links = array();
  switch ($type) {
    case 'node':
      if (project_issue_voting_check_issue_for_voting($node) && user_access('view issue votes')) {
        $user_votes = project_issue_voting_get_issue_user_votes($node->nid);
        // Users get a reclaim link if it's enabled and they have any votes on
        // the issue.
        if ($user_votes !== FALSE) {
          if (variable_get('project_issue_voting_reset_votes', 0) && user_access('vote on issues')) {
            $token = project_issue_voting_get_token();
            $links['project_issue_voting_reset'] = array(
              'title' => t('Reclaim votes'),
              'href' => "project-issue-voting-vote/$node->nid/0/$token",
              'attributes' => array('title' => t('Reset your votes on this issue to zero.')),
              'query' => drupal_get_destination(),
            );
          }
        }
        $total_votes = project_issue_voting_get_total_votes($node->nid);
        if (project_issue_voting_display('link', $teaser)) {
          $links['project_issue_voting_user_votes'] = array(
            'title' => format_plural($total_votes, '@count total vote', '@count total votes'),
            'href' => "node/$node->nid/project-issue-votes",
            'attributes' => array('id' => "project-issue-voting-total-votes-link-$node->nid", 'title' => t('View all votes for this issue.')),
          );
        }
      }
      break;
  }
  return $links;
}

/**
 * Menu callback; Handles main project issue voting page.
 *
 * This just prints out all the visible menu items in the subtree
 * under /project/issues/votes so that as other pages are added
 * (e.g. via views and/or panels) they will show up automatically.
 */
function project_issue_voting_page() {
  $mid = menu_get_active_item();
  $menu = menu_get_menu();
  $items = array();
  foreach ($menu['visible'][$mid]['children'] as $child_mid) {
    $item = menu_get_item($child_mid);
    $items[] = l($item['title'], $item['path']);
  }
  return theme('item_list', $items);
}

/**
 * Users votes page for the project_issue_voting data.
 */
function project_issue_voting_users_votes() {
  $issue_states = array_filter(variable_get('project_issue_voting_issue_states', array()));
  $placeholders = implode(',', array_fill(0, count($issue_states), '%d'));
  $sql = "SELECT COUNT(v.value) AS number_votes, SUM(v.value) AS total_votes, v.tag, u.uid, u.name FROM {votingapi_vote} v INNER JOIN {users} u on v.uid = u.uid INNER JOIN {project_issues} pi ON pi.nid = v.content_id WHERE v.content_type = '%s' AND v.tag = '%s' AND pi.sid IN ($placeholders) GROUP BY u.name, u.uid, v.tag";

  $args = array('content_type' => 'node', 'tag' => variable_get('project_issue_voting_tag', 'issue')) + $issue_states;
  $sql_cnt = "SELECT COUNT(DISTINCT(uid)) FROM {votingapi_vote}";
  $header = array(
    array('data' => t('User'), 'field' => 'u.name'),
    array('data' => t('# of issues voted'), 'field' => 'number_votes', 'sort' => 'desc'),
    array('data' => t('Total votes'), 'field' => 'total_votes'),
  );
  $sql .= tablesort_sql($header);
  $result = pager_query($sql, 30, 0, $sql_cnt, $args);

  $allowed_votes = variable_get('project_issue_voting_allowed_user_votes', 20);

  while ($vote = db_fetch_object($result)) {
    $rows[] = array(
      theme('username', $vote),
      $vote->number_votes,
      $vote->total_votes .'/'. check_plain($allowed_votes),
    );
  }
  drupal_set_title(t('Users by votes'));
  $output = theme('table', $header, $rows);
  $output .= theme('pager', NULL, 30, 0);

  return $output;
}

/**
 * Menu callback; display all votes for an issue node.
 */
function project_issue_voting_issue_votes($node) {
  $header = array(
    array('data' => t('User')),
    array('data' => t('Votes')),
    array('data' => t('Date')),
  );
  $votes = votingapi_get_content_votes('node', $node->nid);
  $args = array_keys($votes);
  $placeholders = implode(', ', array_fill(0, count($args), '%d'));
  $args[] = 1;
  $result = db_query("SELECT uid, name FROM {users} WHERE uid IN (". $placeholders .") AND status = %d ORDER BY name", $args);
  while ($user = db_fetch_object($result)) {
    $vote = $votes[$user->uid][0];
    $rows[] = array(
      theme('username', $user),
      check_plain($vote->value),
      array('data' => format_date($vote->timestamp, 'small'), 'class' => 'nowrap'),
    );
  }
  drupal_set_title(check_plain($node->title));
  return theme('table', $header, $rows);
}

/**
 * Menu callback; display all votes for a user.
 */
function project_issue_voting_user_votes($account) {
  global $user;

  $output = '';
  if (!empty($account)) {
    if (($account->uid == $user->uid && $account->status == 1) || user_access('administer issue voting')) {
      $votes_used = project_issue_voting_get_total_user_votes($account->uid);
      $allowed_votes = variable_get('project_issue_voting_allowed_user_votes', 20);
      $output .= theme('project_issue_voting_user_votes_summary', $votes_used, $allowed_votes);

      $header = array(
        array('data' => t('Issue'), 'field' => 'title', 'sort' => 'asc'),
        array('data' => t('Status'), 'field' => 'sid'),
        array('data' => t('Votes'), 'field' => 'value'),
        array('data' => t('Operations')),
      );
      $sql = db_rewrite_sql("SELECT n.nid, n.title, pi.sid, v.value FROM {node} n INNER JOIN {project_issues} pi ON n.nid = pi.nid INNER JOIN {votingapi_vote} v ON n.nid = v.content_id WHERE v.uid = %d AND v.tag = '%s' AND v.content_type = 'node' AND n.status = 1". tablesort_sql($header));
      $result = pager_query($sql, 25, 0, NULL, $account->uid, variable_get('project_issue_voting_tag', 'issue'));
      $reset = variable_get('project_issue_voting_reset_votes', 0);
      $token = project_issue_voting_get_token();
      while ($node = db_fetch_object($result)) {
        $operations = ($reset ? l(t('Reclaim votes'), "project-issue-voting-vote/{$node->nid}/0/$token", array(), drupal_get_destination()) : '');
        $rows[] = array(
          l($node->title, 'node/'. $node->nid),
          project_issue_state($node->sid),
          check_plain($node->value),
          $operations,
        );
      }
      drupal_set_title(check_plain($account->name));
      $output .= theme('table', $header, $rows);
      $output .= theme('pager', NULL, 25);

      return $output;
    }
    else {
      return drupal_access_denied();
    }
  }
  else {
    return drupal_not_found();
  }
}

/**
 * A voting get handler with AJAX support.
 */
function project_issue_voting_vote($nid, $value, $token = '', $ajax = FALSE) {
  if (is_numeric($nid) && is_numeric($value) && project_issue_voting_valid_token($token)) {
    $node = node_load($nid);

    if (($uid = _project_issue_voting_get_uid()) && project_issue_voting_check_issue_for_voting($node) && user_access('vote on issues')) {
      // Sanity-check the incoming values.
      if ($value > 0) {
        $vote->value = 1;
      }
      elseif ($value < 0) {
        $vote->value = -1;
        $subtracting_votes = TRUE;
      }
      else {
        $vote->value = 0;
      }

      $current_votes = votingapi_get_user_votes('node', $nid, $uid);
      // Increment or decrement the user's votes as necessary.
      if ($vote->value != 0 && isset($current_votes[0])) {
        $vote->value = $current_votes[0]->value + $vote->value;
      }
      // Make sure users can't set an issue's total points to a negative value.
      elseif ($vote->value < 1) {
        $vote->value = 0;
      }

      if ($vote->value == 0) {
        votingapi_unset_vote('node', $nid, $uid);
      }
      else {
        // Make sure the user is trying to add a vote that they
        // still have available votes to add.
        if (isset($subtracting_votes) || project_issue_voting_user_can_add_votes($uid)) {
          // We have to manually add the type/tag here.
          $vote->value_type = 'points';
          $vote->tag = variable_get('project_issue_voting_tag', 'issue');
          votingapi_set_vote('node', $nid, $vote, $uid);
        }
        else {
          $vote->value = $current_votes[0]->value;
        }
      }
    }
    // For some reason this user can't vote, so kick 'em out.
    else {
      if ($ajax) {
        return;
      }
      else {
        drupal_set_message(t('An illegal voting action has occured'), 'error');
        drupal_goto(drupal_get_destination());
      }
    }

    if ($ajax) {
      $issue_total_votes = project_issue_voting_get_total_votes($nid);
      $total_user_votes_used = project_issue_voting_get_total_user_votes($uid);
      $total_user_votes = variable_get('project_issue_voting_allowed_user_votes', 20);
      $vote_subtract = $vote->value == 0 ? FALSE : TRUE;
      $ajax_votes = array(
        'total' => theme("project_issue_voting_issue_total_votes", $nid, $issue_total_votes),
        'user' => theme("project_issue_voting_issue_user_votes", $nid, $total_user_votes_used, $vote->value, $total_user_votes),
        'vote_add' => project_issue_voting_user_can_add_votes($uid),
        'vote_subtract' => $vote_subtract,
        'total_votes_link_votes' => format_plural($issue_total_votes, '@count total vote', '@count total votes'),
        'total_votes_metadata_table' => check_plain($issue_total_votes),
      );
      drupal_set_header('Content-type: text/javascript');
      print drupal_to_js($ajax_votes);
      exit();
    }
    else {
      drupal_goto(drupal_get_destination());
    }
  }
}

/**
 * Return the voting widget display and total issue votes if neccessary.
 */
function project_issue_voting_interface($node) {
  global $user;

  $nid = $node->nid;

  $output = '';

  if (user_access('view issue votes')) {
    $issue_total_votes = project_issue_voting_get_total_votes($nid);
    $output .= theme('project_issue_voting_issue_total_votes_wrapper', $nid, $issue_total_votes);
  }

  if (user_access('vote on issues')) {
    $total_user_votes_used = project_issue_voting_get_total_user_votes($user->uid);
    if ($total_user_votes_used !== FALSE) {
      $issue_user_votes = project_issue_voting_get_issue_user_votes($nid);
      $total_user_votes = variable_get('project_issue_voting_allowed_user_votes', 20);
      // Determine if the add/remove votes selectors are enabled/disabled
      // users can't add more if they've used all their available votes,
      // and can't subtract more if they currently have no votes on the issue.
      $up_class = project_issue_voting_user_can_add_votes($user->uid) ? 'act' : 'inact';
      $down_class = $issue_user_votes ? 'act' : 'inact';
      $output .= theme('project_issue_voting_widget', $nid, $total_user_votes_used, $issue_user_votes, $total_user_votes, $up_class, $down_class);
    }
  }

  // Put everything in a wrapper div so it can stay together.
  $output = theme('project_issue_voting_widget_wrapper', $output);

  return $output;
}

/**
 * Themes the user voting widget on project issue nodes.
 *
 * @param $nid
 *   Issue node ID.
 * @param $total_user_votes_used
 *   The total votes a user has used across all issues.
 * @param unknown_type $issue_user_votes
 *   The total votes the user has used on the current issue.
 * @param unknown_type $total_user_votes
 *   The total votes that a user has to allocate across all issues.
 * @param unknown_type $up_class
 *   The CSS class for increasing a vote, should be 'act' or 'inact'.
 * @param unknown_type $down_class
 *   The CSS class for decreasing a vote, should be 'act' or 'inact'.
 */
function theme_project_issue_voting_widget($nid, $total_user_votes_used, $issue_user_votes, $total_user_votes, $up_class, $down_class) {
  $token = project_issue_voting_get_token();

  $output = '';
  $output .= '<div id="project-issue-voting-widget-'. $nid .'" class="project-issue-voting-widget">';
  $output .= theme('project_issue_voting_issue_user_votes', $nid, $total_user_votes_used, $issue_user_votes, $total_user_votes);
  $output .= '<span id="project-issue-voting-vote-up-'. $nid .'" class="project-issue-voting-vote-up project-issue-voting-vote-up-'. $up_class .'" title="'. t('Add 1 vote') .'" nid="'. $nid .'">'. l('', "project-issue-voting-vote/$nid/1/$token", array('class' => "project-issue-voting-vote-up-$up_class", 'title' => t('Add 1 vote')), drupal_get_destination(), NULL, FALSE, TRUE) .'</span>';
  $output .= '<span id="project-issue-voting-vote-down-'. $nid .'" class="project-issue-voting-vote-down project-issue-voting-vote-down-'. $down_class .'" title="'. t('Subtract 1 vote') .'" nid="'. $nid .'">'. l('', "project-issue-voting-vote/$nid/-1/$token", array('class' => "project-issue-voting-vote-down-$down_class", 'title' => t('Subtract 1 vote')), drupal_get_destination(), NULL, FALSE, TRUE) .'</span>';
  $output .= '</div>';

  return $output;
}

/**
 * Return HTML for the users voting display on a project issue node.
 *
 * This display includes a summary of their overall voting values.
 *
 * @param $nid
 *   Issue node ID.
 * @param $total_user_votes_used
 *   The total votes a user has used across all issues.
 * @param unknown_type $issue_user_votes
 *   The total votes the user has used on the current issue.
 * @param unknown_type $total_user_votes
 *   The total votes that a user has to allocate across all issues.
 */
function theme_project_issue_voting_issue_user_votes($nid, $total_user_votes_used, $issue_user_votes, $total_user_votes) {
  $output = '';
  $output .= '<div id="project-issue-voting-votes-'. $nid .'" class="project-issue-voting-user project-issue-voting-votes">';
  $output .= '<div class="project-issue-voting-votes-user-label">'. t('My issue votes') .'</div>';
  $output .= '<div class="project-issue-voting-votes-user">'. check_plain($issue_user_votes) .'</div>';
  $output .= '<div class="project-issue-voting-votes-label">'. format_plural($issue_user_votes, 'vote', 'votes') .'</div>';
  // Since format_plural doesn't support additional placeholders
  // beyond @count in Drupal 5, we have to do this in two phases with
  // a second placeholder for the total, and substitute that separately.
  $total_line = format_plural($total_user_votes_used, '@count/@total total vote used', '@count/@total total votes used');
  $total_line = strtr($total_line, array('@total' => check_plain($total_user_votes)));
  $output .= '<div class="project-issue-voting-votes-label">'. $total_line .'</div>';
  $output .= '</div>';

  return $output;
}

function theme_project_issue_voting_widget_wrapper($output) {
  $wrapper = '';
  $wrapper .= '<div class="project-issue-voting-wrapper">';
  $wrapper .= $output;
  $wrapper .= '</div>';

  return $wrapper;
}

/**
 * Wrapper for the user voting widget on project issue nodes.
 *
 * NOTE: This display is commented out by default, because
 * there's already a total vote count in the issue metadata
 * table. It's been left here in case anybody wants to uncomment
 * it to get a big themable display of the issue's total votes.
 *
 * @param $nid
 *   Issue node ID.
 * @param $issue_total_votes
 *   The total number of votes placed on the issue
 *   across all users.
 */
function theme_project_issue_voting_issue_total_votes_wrapper($nid, $issue_total_votes) {
  $output = '';
/*
  $output .= '<div id="project-issue-voting-votes-total-wrapper-'. $nid .'" class="project-issue-voting-total">';
  $output .= theme('project_issue_voting_issue_total_votes', $nid, $issue_total_votes);
  $output .= '</div>';
*/
  return $output;
}

/**
 * Return HTML for the user voting widget on project issue nodes.
 *
 * NOTE: This display is disabled by default, because
 * there's already a total vote count in the issue metadata
 * table. It's been left here in case anybody wants to uncomment
 * it to get a big themable display of the issue's total votes.
 *
 * @param $nid
 *   Issue node ID.
 * @param $issue_total_votes
 *   The total number of votes placed on the issue
 *   across all users.
 */
function theme_project_issue_voting_issue_total_votes($nid, $issue_total_votes) {
  $output = '';
  $output .= '<div class="project-issue-voting-votes">';
  $output .= '<div class="project-issue-voting-votes-total-label">'. t('Total issue votes') .'</div>';
  $output .= '<div class="project-issue-voting-votes-total">'. check_plain($issue_total_votes) .'</div>';
  $output .= '<div class="project-issue-voting-votes-label">'. format_plural($issue_total_votes, 'vote', 'votes') .'</div>';
  $output .= '</div>';
  return $output;
}

/**
 * Return HTML for the users's overall voting summary.
 *
 * @param $votes_used
 *   The total votes a user has used across all issues.
 * @param unknown_type $allowed_votes
 *   The total votes that a user has to allocate across all issues.
 */
function theme_project_issue_voting_user_votes_summary($votes_used, $allowed_votes) {
  return '<h4>'. t('Total votes used') .': '. check_plain("$votes_used/$allowed_votes") .'</h4>';
}

/**
 * Get a uid for anonymous vs. registered voting.
 */
function _project_issue_voting_get_uid() {
  global $user;

  if ($user->uid) {
    $uid = $user->uid;
  }
  elseif (user_access('vote on issues')) {
    // Fake uid for anonymous users.
    // If the IP is valid turn it into a integer and add the number of the current day.
    // The current day is what limit anonymous voting to one vote per day and IP address.
    $hostname = (isset($_SERVER['HTTP_X_FORWARDED_FOR'])) ? $_SERVER['HTTP_X_FORWARDED_FOR'] : $_SERVER['REMOTE_ADDR'];
    if ($long = ip2long($hostname)) {
      $uid = abs($long) + date('z');
    }
  }
  else {
    $uid = FALSE;
  }
  return $uid;
}

/**
 * Checks an issue node to determine if it's enabled for voting.
 *
 * Since the function is called multiple times, cache the test results.
 *
 * @param $node
 *   The issue node.
 *
 * @return
 *   TRUE if the issue node is enabled for voting, FALSE otherwise.
 */
function project_issue_voting_check_issue_for_voting($node) {
  static $state_check = array();

  if (isset($state_check[$node->nid])) {
    return $state_check[$node->nid];
  }

  // If it's not a project issue node, they can't vote on it.
  if ($node->type != 'project_issue') {
    $state_check[$node->nid] = FALSE;
    return FALSE;
  }

  // Check for enabled project type if we're using taxonomy.
  if (project_use_taxonomy()) {
    $project_types = array_filter(variable_get('project_issue_voting_project_types', array()));

    if (count($project_types)) {
      // Pull all project categories.
      $vid = _project_get_vid();
      $tree = taxonomy_get_tree($vid, 0, -1, 1);

      foreach ($tree as $term) {
        $args[] = $term->tid;
      }
      $placeholders = implode(', ', array_fill(0, count($args), '%d'));
      $args[] = $node->pid;

      // Pull all categories associated with the issue.
      $current_project_terms = db_query("SELECT tid FROM {term_node} WHERE tid IN($placeholders) AND nid = %d", $args);
      $project_terms = array();
      while ($project_term = db_fetch_object($current_project_terms)) {
        $project_terms[] = $project_term->tid;
      }

      // Check if any of the issue's categories are enabled for voting.
      if (!array_intersect($project_types, $project_terms)) {
        $state_check[$node->nid] = FALSE;
        return FALSE;
      }
    }
  }

  // Check if the issue category type is enabled.
  $issue_categories = array_filter(variable_get('project_issue_voting_issue_categories', array()));
  // Check if the issue is in an enabled category.
  if (count($issue_categories) && !in_array($node->category, $issue_categories)) {
    $state_check[$node->nid] = FALSE;
    return FALSE;
  }

  // Check to make sure the issue has an active issue voting state.
  $issue_states = array_filter(variable_get('project_issue_voting_issue_states', array()));
  if (count($issue_states) && !in_array($node->sid, $issue_states)) {
    $state_check[$node->nid] = FALSE;
    return FALSE;
  }

  $state_check[$node->nid] = TRUE;
  return TRUE;
}

/**
 * Return the number of votes a specified user has placed on a given issue.
 *
 * @param $nid
 *   The issue node ID.
 * @param $uid
 *   The user to check votes for.
 */
function project_issue_voting_get_issue_user_votes($nid, $uid = NULL) {
  global $user;

  if (!isset($uid)) {
    $uid = $user->uid;
  }

  // Make up a uid for anonymous users.
  if ($uid == 0) {
    $uid = _project_issue_voting_get_uid();
  }

  if ($uid) {
    $vote_result = votingapi_get_user_votes('node', $nid, $uid);
    return isset($vote_result[0]) ? $vote_result[0]->value : 0;
  }

  return FALSE;
}

/**
 * Return the number of total votes on a specified issue.
 *
 * @param $nid
 *   The issue node ID.
 */
function project_issue_voting_get_total_votes($nid) {
  $vote_result = votingapi_get_voting_result('node', $nid, 'points', variable_get('project_issue_voting_tag', 'issue'), 'sum');
  return $vote_result ? $vote_result->value : 0;
}

/**
 * Validate that the entered value is a number.
 */
function project_issue_voting_validate_numeric($form) {
  if (!is_numeric($form['#value'])) {
    form_error($form, t('@element_name must be a number.', array('@element_name' => $form['#title'])));
  }
}

/**
 * Return the number of total votes a user has cast across all issues.
 *
 * @param $uid
 *   The user ID.
 */
function project_issue_voting_get_total_user_votes($uid = NULL) {
  global $user;

  if (!isset($uid)) {
    $uid = $user->uid;
  }

  // Make up a uid for anonymous users.
  if ($uid == 0) {
    $uid = _project_issue_voting_get_uid();
  }

  if ($uid) {
    $user_votes = db_result(db_query("SELECT SUM(value) FROM {votingapi_vote} WHERE content_type = '%s' AND value_type = '%s' AND tag = '%s' AND uid = %d", 'node', 'points', variable_get('project_issue_voting_tag', 'issue'), $uid));

    return $user_votes ? $user_votes : 0;
  }

  return FALSE;
}

/**
 * Check to see if a specified user has available votes to assign.
 *
 * @param $uid
 *   The user ID.
 */
function project_issue_voting_user_can_add_votes($uid = NULL) {
  $user_votes = project_issue_voting_get_total_user_votes($uid);
  return $user_votes !== FALSE && $user_votes < variable_get('project_issue_voting_allowed_user_votes', 20);
}

/**
 * Helper function which generates a token for voting requests.
 */
function project_issue_voting_get_token() {
  return drupal_get_token('project_issue_voting_widget');
}

/**
 * Helper function which checks a token for voting requests.
 */
function project_issue_voting_valid_token($token) {
  return drupal_valid_token($token, 'project_issue_voting_widget');
}

/**
 * Implementation of hook_project_issue_metadata().
 *
 * Adds the total votes into the issue metadata summary table in a
 * span so that the total can be updated by the jQuery when users vote.
 */
function project_issue_voting_project_issue_metadata($view, $node, &$current_data) {
  switch ($view) {
    case 'current':
      if (user_access('view issue votes')) {
        $total_issue_votes = project_issue_voting_get_total_votes($node->nid);
        $current_data['project_issue_voting_total_issue_votes'] = array(
          'label' => t('Total votes'),
          'current' => '<span id="project-issue-voting-metadata-table-total-votes-'. $node->nid .'">'. check_plain($total_issue_votes) .'</span>',
        );
      }
      break;
  }
}

/**
 * Implementation of hook_views_default_views.
 *
 * @see _project_issue_voting_views_default_views
 */
function project_issue_voting_views_default_views() {
  require_once drupal_get_path('module', 'project_issue_voting') .'/project_issue_voting.views.inc';
  return _project_issue_voting_views_default_views();
}

/**
 * Implementation of hook_panels_default_panel_views.
 *
 * @see _project_issue_voting_default_panel_views()
 */
function project_issue_voting_default_panel_views() {
  require_once drupal_get_path('module', 'project_issue_voting') .'/project_issue_voting.panels.inc';
  return _project_issue_voting_default_panel_views();
}

/**
 * Implementation of hook_panels_default_panel_views.
 *
 * @see _project_issue_voting_panels_default_panel_pages()
 */
function project_issue_voting_default_panel_pages() {
  require_once drupal_get_path('module', 'project_issue_voting') .'/project_issue_voting.panels.inc';
  return _project_issue_voting_default_panel_pages();
}

/**
 * Determine if the specified voting type should be displayed on the current page.
 *
 * @param $type
 *   The type of display we're checking.  Can be 'node' or 'link'.
 * @param $teaser
 *   TRUE if we're viewing a teaser, FALSE otherwise.
 */
function project_issue_voting_display($type, $teaser) {
  switch ($type) {
    case 'node':
      $display_type = variable_get('project_issue_voting_widget_node', 'full');
      break;

    case 'link':
      $display_type = variable_get('project_issue_voting_link_node', 'teaser');
      break;
  }
  $display = FALSE;
  if ($teaser) {
    if (in_array($display_type, array('teaser', 'teaser-full'))) {
      $display = TRUE;
    }
  }
  else {
    if (in_array($display_type, array('full', 'teaser-full'))) {
      $display = TRUE;
    }
  }
  return $display;
}

/**
 * Deletes all issue votes on a given issue node.
 */
function project_issue_voting_delete_votes($node) {
  if ($node->type == 'project_issue') {
    $issue_tag = variable_get('project_issue_voting_tag', 'issue');
    $votes = _votingapi_get_raw_votes('node', $node->nid, NULL, array($issue_tag));
    votingapi_delete_votes($votes);
    votingapi_recalculate_results('node', $node->nid, TRUE);
  }
}