modules/userreview/userreview.module

<?php
// $Id: userreview.module,v 1.23 2007/02/17 08:44:34 gerdriesselmann Exp $

/*
 * userreview.module
 * First released March 12, 2006
 *
 * by David Donohue
 * dado@drupal.org
 *
 * Maintained as of Dezember 1, 2006 
 * by Gerd Riesselmann
 * userreview@gerd-riesselmann.net
 */

define ('USERREVIEW_VOTINGAPI_VALUE_TYPE', 'percent');

/**
 * Implementation of hook_help().
 */
function userreview_help($section) {
  switch ($section) {
    case 'admin/help#userreview':
      return t('The userreview content type is a node, which is attached to another node.  It has a 0 to 10 voting scale.  You set a number of configuration options at ') . l('admin/settings/userreview', 'admin/settings/userreview') . t('.  Here, you can set which node types are reviewable, how many reviews to display beneath the reviewed node per page, and others.') . '<br/><br/>' . t('This module requires views module and the votingapi module.  Using views, it is easy to create blocks or pages which display top rated nodes of a given type, for example.') . '<br/><br/>' . t('This module was designed for Drupal version 4.7.');
     case 'node/add#userreview':
      // This description shows up when users click "create content."
      return t('To add a review, fill out the form under the content you wish to review.');
    case 'userreview_howto':
      return t('You can submit reviews of content on this site.  To submit a review, find the content you wish to review, and fill out the form below it.');
  }
}

/**
 * Implementation of hook_node_info(). This function replaces hook_node_name()
 * and hook_node_types() from 4.6.
 */
function userreview_node_info() {
  return array(
    'userreview' => array(
      'name' => t('review'), 
      'module' => 'userreview',
      'description' => t('The userreview content type is a node, which is attached to another node.  It has a 0 to 10 voting scale.  You set a number of configuration options at ') . l('admin/settings/userreview', 'admin/settings/userreview') . t('.  Here, you can set which node types are reviewable, how many reviews to display beneath the reviewed node per page, and others.') . '<br/><br/>' . t('This module requires views module and the votingapi module.  Using views, it is easy to create blocks or pages which display top rated nodes of a given type, for example.'),      
    )
  );
}

/**
 * Implementation of hook_access().
 */
function userreview_access($op, $node) {
  global $user;

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

  if ($op == 'update' || $op == 'delete') {
    if (user_access('administer user reviews') || (user_access('edit own user reviews') && ($user->uid == $node->uid))) {
      return TRUE;
    } else {
      return FALSE;
    }
  }
}

/**
 * Implementation of hook_perm().
 */
function userreview_perm() {
  return array('administer user reviews', 'create user reviews', 'edit own user reviews');
}

/**
 * Implementation of hook_menu().
 *
 * Define a callback, which shows a help message on how users can create a user
 * review.  This is a workaround to overcome the issue that Drupal forces there 
 * to be a link to create a new userreview node on the "create content" page.
 */
function userreview_menu($may_cache) {
  $items = array();
  if (!$may_cache) {
    drupal_add_css(drupal_get_path('module', 'userreview') . '/userreview.css');
  } else {
    $items[] = array(
      'path'     => 'userreview/howto',
      'callback' => 'userreview_help',
      'callback arguments' => array('userreview_howto'),
      'title'    => t('How to Submit a Review'),
      'access'   => true,
      'type'     => MENU_CALLBACK
    );
    $items[] = array(
      'path' => 'admin/settings/userreview',
      'title' => t('Userreview'),
      'description' => t('Configure userreview behavior and appearance.'),
      'callback' => 'drupal_get_form',
      'callback arguments' => array('userreview_admin_settings'),
      'access' => user_access('administer site configuration'),
      'type' => MENU_NORMAL_ITEM, // optional
    );
  }

  return $items;
}

/**
 * Define settings for this module.
 */
function userreview_admin_settings() {
  $form = array();

  $node_types = node_get_types('names');
  unset($node_types['userreview']);
  $form['userreview_node_types'] = array(
    '#title' => t('Node types to expose user reviewing.'),
    '#type' => 'checkboxes',
    '#options' => $node_types,
    '#default_value' => variable_get('userreview_node_types', array()),
    '#description' => t('Check all node types you wish users to review.')
  );

  $form['review form'] = array('#type' => 'fieldset', '#title' => t('Review Form'), '#collapsible' => true, '#collapsed' => true);
  $form['review form']['userreview_form_title'] = array(
    '#type' => 'textfield', 
    '#default_value' => variable_get('userreview_form_title',t('Share your opinion!')), 
    '#title' => t('Title for the user review form'),
    '#description' => t('This is shown before the user review form.  %node_type is replaced with the node type being reviewed, and %node_title is replaced with the title of the node being reviewed.  Example: Please rate %node_type %node_title!')
  );  
  $form['review form']['userreview_vote_description'] = array(
    '#type' => 'textarea', 
    '#default_value' => variable_get('userreview_vote_description',t('Select a value from 0 (worst) to 10 (best)')), 
    '#title' => 'Description for vote element',
    '#description' => t('This is shown after the voting element in the user review form')
  );
  $form['review form']['userreview_default_vote'] = array(
    '#type' => 'textfield', 
    '#default_value' => variable_get('userreview_default_vote','5'), 
    '#title' => 'Default vote value',
    '#description' => t('This should be a number, within the voting range')
  );
  $form['review form']['userreview_vote_title'] = array(
    '#type' => 'textfield', 
    '#default_value' => variable_get('userreview_vote_title',t('Your vote')), 
    '#title' => t('Title for the vote selector element'),
    '#description' => t('This is shown before the voting element in the user review form.  Example: Select a number from 0 to 10.')
  );
  $form['review form']['userreview_title_required'] = array(
    '#type' => 'checkbox',
    '#title' => t('Review Title is required'),
    '#description' => t('When a user fills out a userreview, is the title field required?'),
    '#default_value' => variable_get('userreview_title_required', false)
  );
  $form['review form']['userreview_review_text_required'] = array(
    '#type' => 'checkbox',
    '#title' => t('Review Text is required'),
    '#description' => t('When a user fills out a userreview, is the descriptive textarea field required?'),
    '#default_value' => variable_get('userreview_review_text_required', false)
  );
  $form['review form']['userreview_form_collapsible'] = array(
    '#type' => 'checkbox',
    '#title' => t('User Review form is in a collapsible field set'),
    '#description' => t('When showing a reviewable node (in full page view), should the user review form be in a collapsible field set?'),
    '#default_value' => variable_get('userreview_form_collapsible', true)
  );
  $form['review form']['userreview_form_collapsed'] = array(
    '#type' => 'checkbox',
    '#title' => t('User review form is in a collapsed field set'),
    '#description' => t('When showing a reviewable node (in full page view), should the user review form be in a collapsed field set?'),
    '#default_value' => variable_get('userreview_form_collapsed', true)
  );
  
  $form['review list'] = array('#type' => 'fieldset', '#title' => t('Review List'), '#collapsible' => true, '#collapsed' => true);
  $form['review list']['userreview_review_list_title'] = array(
    '#type' => 'textfield', 
    '#default_value' => variable_get('userreview_review_list_title', t('User Reviews')), 
    '#title' => t('Title for the list of user reviews displayed'),
    '#description' => t('This is shown before the listing of user reviews.')
  );
  $form['review list']['userreview_otheruser_label'] = array(
    '#type' => 'textfield', 
    '#default_value' => variable_get('userreview_otheruser_label',t('Review of %node_type: %node_title by %user_name')), 
    '#title' => t('Title for displaying a user\'s review of a particular node'),
    '#description' => t('This is shown when viewing a user review in full page mode, of the non-current user.  %node_type is replaced with the node type being reviewed, and %node_title is replaced with the title of the node being reviewed, and %user_name is replaced with the user\'s name.  Example: Review of %node_type: %node_title by %user_name')
  );
  $form['review list']['userreview_vote_number_caption'] = array(
    '#type' => 'textfield',
    '#size' => 15,
    '#default_value' => variable_get('userreview_vote_number_caption',t('out of 10')), 
    '#title' => 'Caption under vote value',
    '#description' => t('This is shown under each vote, when showing user reviews.')
  );
  $form['review list']['userreview_vote_decimal'] = array(
    '#type' => 'textfield',
    '#default_value' => variable_get('userreview_vote_decimal','1'),
    '#title' => 'Vote Decimal Places',
    '#description' => t('Number of decimal places to include with the vote value.'),
  );  
  $form['review list']['userreview_display_num'] = array(
    '#type' => 'textfield', 
    '#default_value' => variable_get('userreview_display_num','10'), 
    '#title' => 'Number of reviews to display',
    '#description' => t('When viewing a reviewed node, this number of user reviews will be displayed on that node\'s page, with a pager link to the next page.')
  );
  $form['review list']['userreview_show_review_teasers'] = array(
    '#type' => 'checkbox',
    '#title' => t('Show previews only'),
    '#description' => t('If the review is longer than the system wide teaser length, shorten it and display a "read more" link.'),
    '#default_value' => variable_get('userreview_show_review_teasers', false)
  );
  $form['review list']['userreview_list_collapsible'] = array(
    '#type' => 'checkbox',
    '#title' => t('List of user reviews is in a collapsible field set'),
    '#description' => t('When showing a reviewed node (in full page view), should the list of user reviews be in a collapsible field set?'),
    '#default_value' => variable_get('userreview_list_collapsible', true)
  );
  $form['review list']['userreview_list_collapsed'] = array(
    '#type' => 'checkbox',
    '#title' => t('List of user reviews is in a collapsed field set'),
    '#description' => t('When showing a reviewed node (in full page view), should the list of user reviews be in a collapsed field set?'),
    '#default_value' => variable_get('userreview_list_collapsed', true)
  );
 
  $form['current review'] = array('#type' => 'fieldset', '#title' => t('Current User\'s Review'), '#collapsible' => true, '#collapsed' => true);
  $form['current review']['userreview_currentuser_label'] = array(
    '#type' => 'textfield', 
    '#default_value' => variable_get('userreview_currentuser_label',t('Your Review')), 
    '#title' => t('Title of the current user\'s review when viewing the reviewed node'),
    '#description' => t('This is shown before the current user\'s review, when displayin the reviewed node\s page.  %node_type is replaced with the node type being reviewed, and %node_title is replaced with the title of the node being reviewed')
  );
  $form['current review']['userreview_show_currentuser_review'] = array(
    '#type' => 'checkbox',
    '#title' => t('Show current user\'s review'),
    '#description' => t('When showing a reviewed node (in full page view), should current\'s user review be shown?'),
    '#default_value' => variable_get('userreview_show_currentuser_review', true)
  );

  $form['review node'] = array('#type' => 'fieldset', '#title' => t('Reviewed Node Teaser'), '#collapsible' => true, '#collapsed' => true);
  $form['review node']['userreview_show_average_vote_in_teaser'] = array(
    '#type' => 'checkbox',
    '#title' => t('Show average vote in teaser'),
    '#description' => t('When showing a teaser of a reviewed node, should the average vote be shown?'),
    '#default_value' => variable_get('userreview_show_average_vote_in_teaser', true)
  );
  $form['review node']['userreview_show_count_votes_in_teaser'] = array(
    '#type' => 'checkbox',
    '#title' => t('Show number of votes or "rate it" link in teaser'),
    '#description' => t('When showing a teaser of a reviewed node, should the number of votes or "add new review" be shown as a link?'),
    '#default_value' => variable_get('userreview_show_count_votes_in_teaser', false)
  );

  $form['standalone view'] = array('#type' => 'fieldset', '#title' => t('Userreview Standalone Display'), '#collapsible' => true, '#collapsed' => true);
  $form['standalone view']['userreview_show_link_to_reviewed'] = array(
    '#type' => 'checkbox',
    '#title' => t('Show link to reviewed item'),
    '#description' => t('Show link to reviewed item on review details page?'),
    '#default_value' => variable_get('userreview_show_link_to_reviewed', false)
  );
    
  return system_settings_form($form);
}

/**
 * Implementation of hook_form().
 * 
 * This node type is not intended to be accessed by the standard node creation
 * page ("node/add/nodetype").  Rather, it is created in association with the
 * node being reviewed.
 */
function userreview_form(&$node) {
  //if this form is being called without the proper added fields 
  //(i.e. it is being created de novo from the "create content" page) 
  //then display a help message instead.
  if (!is_numeric($node->content_id) || !$node->vote_tag) {
    drupal_goto('userreview/howto');
  }
  
  //capture the vote value from the request object, if present
  if (isset($_REQUEST['edit']['vote_value'])) {
    $node->vote_value = (int)$_REQUEST['edit']['vote_value'];
  }
  if (!$node->content_type) {
    $node->content_type = 'node';
  }
  
  //set the breadcrumb
  userreview_set_breadcrumb($node);
  
  drupal_add_js(drupal_get_path('module', 'userreview') . '/userreview.js');
  $add_elements = array();
  $add_elements['vote_value'] = array(
    '#type' => 'select',
    '#title' => variable_get('userreview_vote_title',t('Your vote')),
    '#description' => variable_get('userreview_vote_description',t('Select a value from 0 (worst) to 10 (best)')), 
    '#default_value' => ($node->vote_value == null) ? variable_get('userreview_default_vote','') : (string)($node->vote_value),
    '#options' => array('0'=>'0', '1'=>'1', '2'=>'2', '3'=>'3', '4'=>'4', '5'=>'5', '6'=>'6', '7'=>'7', '8'=>'8', '9'=>'9', '10'=>'10'),
    '#required' => TRUE,
    '#weight' => -5
  );
  $add_elements['title'] = array(
    '#type' => 'textfield', 
    '#title' => t('Title'),
    '#size' => 60, 
    '#maxlength' => 128, 
    '#required' => variable_get('userreview_title_required', FALSE), 
    '#weight' => -2,
    '#default_value' => $node->title
  );
  $add_elements['review_text'] = array(
    '#type' => 'textarea', 
    '#title' => t('Comments'),
    '#default_value' => $node->review_text, 
    '#required' => variable_get('userreview_review_text_required', FALSE),
    '#weight' => -1,
    '#description' => t('Please enter your comments.') 
  );
  $add_elements['content_id'] = array('#type' => 'value', '#value' => $node->content_id);
  $add_elements['content_type'] = array('#type' => 'value', '#value' => $node->content_type);
  $add_elements['vote_tag'] = array('#type' => 'value', '#value' => $node->vote_tag);
  
  $add_elements['format'] = filter_form($node->format);
  
  return $add_elements;
}

/**
 * Implementation oh hook_nodeapi
 *
 * Here we add the review list to the reviewed item's body, when it is views
 */
function userreview_nodeapi(&$node, $op, $teaser = NULL, $page = NULL) {
  //if this node type is not a reviewable one (as configured in settings page) then return
  $reviewable_node_types = variable_get('userreview_node_types', array());
  if (!array_key_exists($node->type, $reviewable_node_types) || $reviewable_node_types[$node->type] == '0') {
    return;
  }
  
  global $user;
  switch ($op) {
    case 'view':
      $count_votes = _userreview_nodeapi_view_prepare(
        $node, 
        $page || variable_get('userreview_show_average_vote_in_teaser', true), 
        $teaser && variable_get('userreview_show_count_votes_in_teaser', false)
      ); 
      if ($page) {  
        $node->content['userreview_average'] = array(
          '#value' => $node->userreview->average_vote,
          '#weight' => 8,
        );
        
        //get the current user's review for this content node
        $userreviewnode = get_userreview_node($node, $user->uid);
        //if a review exists by this user, show it...
        if ($userreviewnode) {
          if (variable_get('userreview_show_currentuser_review', true)) {
            $node->userreview->current_user_review = theme('userreview', $userreviewnode, true, true);
            $node->content['userreview_current_user_review'] = array(
              '#value' => $node->userreview->current_user_review,
              '#weight' => 9,
            );
          }
          //...otherwise show the form to create a user review IF we are not printing the page (print module)
        } else if(user_access('create user reviews') && !$node->printing) { 
          $userreviewnode = new StdClass();
          $userreviewnode->content_id = $node->nid;
          $userreviewnode->vote_tag = 'userreview:'.$node->type;
          $userreviewnode->content_type = 'node';
          $userreviewnode->type = 'userreview';
          $userreviewnode->uid = $user->uid;
          $userreviewnode->name = $user->name;
          $display_title = get_userreview_form_title($node);
          $node->userreview->review_form = theme('userreview_included_form', $display_title, drupal_get_form('userreview_node_form', $userreviewnode));

          $node->content['userreview_review_form'] = array(
            '#value' => $node->userreview->review_form,
            '#weight' => 9,
          );
        }
        
        //next, show a list of user reviews if any reviews
        if ($count_votes->value > 0) {          
          $node->userreview->review_list .= theme('userreview_list', $node, variable_get('userreview_list_collapsible', true), variable_get('userreview_list_collapsed', true));
          $node->content['userreview_review_list'] = array(
            '#value' => $node->userreview->review_list,
            '#weight' => 10,
          );
        }
      } else {//teaser
        $node->content['userreview_average'] = array(
          '#value' => $node->userreview->average_vote,
          '#weight' => 8,
        );
      }
      break; 
  }
}

/**
 * Prepare userreview part of node when viewing reviewed node
 *
 * This function sets count_votes and average_vote properties on $node->userreview, if module settings state so
 *
 * @param Object The node to extend
 * @param Boolean True, if the average voting should be displayed
 * @param Boolean True, if the count of votes should be displayed
 *
 * @return Object Count of votes as result object as returned by votingapi_get_voting_result()
 */
function _userreview_nodeapi_view_prepare(&$node, $show_average, $show_count) {
  $count_votes = new StdClass();
  $count_votes->value = 0;
  if ($show_average || $show_count) {
    //first, show the average vote
    $count_votes = votingapi_get_voting_result('node', $node->nid, USERREVIEW_VOTINGAPI_VALUE_TYPE, 'userreview:'.$node->type, 'count');
    $node->userreview->count_votes = $count_votes;
  }
  if ($show_average && $count_votes->value > 0) {
	  $avg_vote = votingapi_get_voting_result('node', $node->nid, USERREVIEW_VOTINGAPI_VALUE_TYPE, 'userreview:'.$node->type, 'average');
	  $node->userreview->average_vote = theme('userreview_voting_results', $avg_vote->value, $count_votes->value);
  }
  return $count_votes;
} 

/**
 * Themes the list of userreviews displayed after a node
 */
function theme_userreview_list($node, $collapsible = true, $collapsed = true) {
  $view = views_get_view('userreview');
  $o = views_build_view('embed', $view, array($node->nid), true, variable_get('userreview_display_num',10));
  $display = array(
    '#collapsible' => $collapsible,
    '#collapsed' => $collapsed,
    '#title' => variable_get('userreview_review_list_title', t('User Reviews')),
    '#children' => $o
  );
  return theme('fieldset', $display);
}

/**
 * Compute form title from node and  user settings
 *
 * @param object Node to append review to
 * @return string Title for form as plain text
 */
function get_userreview_form_title($node) {
  $display_title = variable_get('userreview_form_title', t('Share your opinion!'));
  $node_translation_terms = array(
    '%node_type' => node_get_types('name', $node),
    '%node_title' => $node->title,
  );
  $display_title = t($display_title, $node_translation_terms);
  /*
  $display_title = str_replace('%node_type', node_get_name($node->type),
  $display_title);
  $display_title = str_replace('%node_title', $node->title, $display_title);
  */
  return check_plain($display_title); 
}

/**
 * Given a reviewable node's object and a user ID, retrieves the userreview node
 * submitted by that user on that reviewable node.  If no review has been
 * submitted, returns $default
 */
function get_userreview_node($content_node, $uid = 0, $default = false) {
  global $user;
  $sql = 'select nid from {userreview} where content_id = %d and uid = %d';
  $result = db_fetch_object(db_query($sql, $content_node->nid, $uid));
  if (!$result) return $default;
  $userreview_node = node_load($result->nid);
  if ($uid == $user->uid) {
    $display_title = variable_get('userreview_currentuser_label', t('Your Review'));
  } else {
    $display_title = variable_get('userreview_otheruser_label', t('Review of %node_type: %node_title by %user_name'));
  }
  $display_title = str_replace('%node_type', node_get_types('name', $content_node), $display_title);
  $display_title = str_replace('%node_title', $content_node->title, $display_title);
  if (strpos($display_title, '%user_name') >= 0) {
    $user_criteria = array('uid'=>$uid);
    $reviewer_obj = user_load($user_criteria);
    $display_title = str_replace('%user_name', $reviewer_obj->name, $display_title);
  }
  $userreview_node->userreview_label = check_plain($display_title);
  return $userreview_node;
}

/**
 * Find all the userreviews for a given reviewable node. Not used in module due to views,
 * but useful when building custom themes.
 */
function get_userreviews($node) {
  $sql = db_rewrite_sql("
    SELECT n.nid 
    FROM  
      node n
    LEFT JOIN userreview ON n.nid = userreview.nid 
    LEFT JOIN users ON n.uid = users.uid 
    WHERE 
      (n.status = '1') 
    AND 
      (userreview.content_id = %d)
    ORDER BY changed DESC",
    'n');
  $result = pager_query($sql, variable_get('userreview_display_num','10'), 0, NULL, $node->nid);
  $ret = array();
  while ($node = db_fetch_object($result)) {
    $ret[] = node_load($node->nid);
  }
  return $ret;	
} 

/**
 * Implementation of hook_insert().
 *
 * As a new node is being inserted into the database, add userreview field data
 * to the userreview table.  Also, insert a new vote using the votingapi.
 */
function userreview_insert($node) {
  global $user;

  //store the vote using votingapi
  $vobj = new stdClass();
  $vobj->value = $node->vote_value;
  $vobj->value_type = USERREVIEW_VOTINGAPI_VALUE_TYPE;
  $vobj->tag = $node->vote_tag;
  votingapi_set_vote($node->content_type, $node->content_id, $vobj, $user->uid);

  //get the new vote's vid
  $inserted_vobj = votingapi_get_vote($node->content_type, $node->content_id, $vobj->value_type, $vobj->tag, $user->uid);
  $next_id = db_next_id('userreview');
  db_query("INSERT INTO {userreview} (nid, content_id, content_type, vote_id, vote_value, vote_tag, uid, review_text) VALUES (%d, %d, '%s', %d, %d, '%s', %d, '%s')", $node->nid, $node->content_id, $node->content_type, $inserted_vobj->vote_id, $node->vote_value, $node->vote_tag, $user->uid, $node->review_text);
  
  // Update path to usrereview lsit page
  if (function_exists('pathauto_create_alias')) {
    $placeholders = userreview_get_placeholders($node);
    pathauto_create_alias(
      'userreview', 
      'insert',
      $placeholders, 
      'userreview/of/' . $node->content_id, 
      'userreview_list');  	
  }
  
  //forward to the reviewed node
  $_REQUEST['destination'] = 'node/' . $node->content_id;
}

/**
 * Implementation of hook_update().
 *
 * Update the userreview table with all changable info (vote value and review
 * text only).  Also set the new vote value & update the vote cache using the
 * votingapi.
 */
function userreview_update($node) {
  if (isset($_REQUEST['edit']['vote_value'])) {
    $node->vote_value = (int)$_REQUEST['edit']['vote_value'];
  }

  //update only the vote value in the userreview table.
  db_query("UPDATE {userreview} set vote_value = %d, review_text = '%s' where nid = %d", $node->vote_value, $node->review_text, $node->nid);
    
  //store the vote using votingapi
  $vote = new stdClass();
  $vote->value = $node->vote_value;
  $vote->value_type = USERREVIEW_VOTINGAPI_VALUE_TYPE;
  $vote->tag = $node->vote_tag;
  votingapi_set_vote($node->content_type, $node->content_id, $vote, $user->uid);
  
  //forward to the reviewed node
  $_REQUEST['destination'] = 'node/' . $node->content_id;
}

/**
 * Implementation of hook_delete().
 * Deletes the record in table userreviwew.  
 * Also deletes the associated votes and updates the vote cache
 */
function userreview_delete($node) {
  db_query('DELETE FROM {userreview} WHERE nid = %d', $node->nid);
  $vote = new stdClass();
  $vote->vote_id = $node->vote_id;
  $vote->content_id = $node->content_id;
  $vote->content_type = 'node';
  votingapi_delete_vote($vote);
  votingapi_recalculate_results($vote->content_type, $vote->content_id);
}

/**
 * Implementation of hook_load().
 */
function userreview_load($node) {
  $additions = db_fetch_object(db_query('SELECT * FROM {userreview} WHERE nid = %d', $node->nid));
  
  $vote_value = (int)$_REQUEST['edit']['vote_value'];
  if ($vote_value && is_numeric($vote_value)) {
    $additions->vote_value = $vote_value;
  }
  return $additions;
}

/**
 * Set the breadcrumb, given the userreview node.  This should be called on
 * pages where the userreview node or form is being displayed.  Since the
 * userreview is alwasy subordinate to the node it is reviewing, the breadcrumb
 * should reflect this.  This function sets the breadcrumb as simply "Home ->
 * [reviewed node's title]"
 */
function userreview_set_breadcrumb($node) {
  $breadcrumb = menu_get_active_breadcrumb();
  $content_node = node_load($node->content_id);
  $breadcrumb[] = l("$content_node->title", "node/$node->content_id");
  drupal_set_breadcrumb($breadcrumb);
}

/**
 * Implementation of hook_view().
 *
 * This is a typical implementation that simply runs the node text through
 * the output filters.
 */
function userreview_view(&$node, $teaser = FALSE, $page = FALSE) {
  global $user;
  if ($page) {
    /*
    if ($node->uid == $user->uid) {
      //if we are viewing the current user's userreview node, redirect to the reviewed node.
      //Thus, when a user has submitted or updated her review, she will then see the reviewed node as the next page.
      drupal_goto("node/$node->content_id");
    } else {
      userreview_set_breadcrumb($node);
    }
    */
    userreview_set_breadcrumb($node);
  }
  $node = node_prepare($node, $teaser); // is this necessary?
  if ($teaser) {
    $node->content['teaser'] = array(
      '#value' => theme('userreview_teaser', $node),
      '#weight' => 1,
    );
  } else {
    $node->content['body'] = array(
      '#value' => theme('userreview_teaser', $node),
      '#weight' => 1,
    );
  }
  
  //remove the title, since the title is shown in the above theming
  unset($node->title);
  return $node;
}


/**
 * Implementation of hook_link().
 *  
 * Appends the following links to the reviewed node:
 * - "1 review"/"n reviews"/"add new review": if userreview_show_count_votes_in_teaser is true and user has according user rights
 * 
 * Appends the following links to the userreview itself:
 * - "See reviewed item": If userreview is displayed standalone and userreview_show_link_to_reviewed is set
 */
function userreview_link($type, $node = 0, $main = 0) {
  $links = array();
  if ($type != 'node' || empty($node)) {
  	return $links;
  }
  
  if ($node->userreview) {
    if ($main) {
      // Main page: display the number of comments that have been posted.
      if (variable_get('userreview_show_count_votes_in_teaser', false) && user_access('access content')) {
        $count_votes = $node->userreview->count_votes;
        if ($count_votes) {
          $links['userreview_count_votes'] = array(
            'title' => format_plural($count_votes->value, '1 review', '@count reviews'),
            'href' => "node/$node->nid",
            'attributes' => array('title' => t('Jump to the reviews for this item.'))
          );          
        }
        else if (user_access('create user reviews')) {
          $links['userreview_count_votes'] = array(
            'title' => t('add new review'),
            'href' => "node/$node->nid",
            'attributes' => array('title' => t('Add a new review to this item.'))
          );          
        }
      }
    }
  }
  if ($node->type == 'userreview' && !$main && variable_get('userreview_show_link_to_reviewed', false)) {
  	$links['userreview_reviewed_item'] = array( 
      'title' => t('See reviewed item'),
      'href' => "node/$node->content_id",
      'attributes' => array('title' => t('Open the item that was reviewed'))
    );          
  }
  return $links;
}

/**
 * implementation of form_alter for the userreview creation form.  This simply
 * removed the "preview" button.
 */
function userreview_form_alter($form_id, &$form) {
  $op = isset($_POST['op']) ? $_POST['op'] : '';
  if ($form_id == 'userreview_node_form' && 
    !(variable_get('node_preview', 0) && (form_get_errors() || $op != t('Preview')))) {
    unset($form['preview']);
  }
}

/**
 * Themes a userreview node for full (page) view
 */
function theme_userreview($node, $collapsible = true, $collapsed = true) {
  global $user;
  $output = '<table class="userreview_view">';

  $output .= '<tr><td align="left" class="userreview_review_vote_container">';
  $output .= theme('userreview_vote', $node->vote_value);
  $output .= '</td><td>';
  if ($node->title) {
    $output .= '<div class="userreview_review_title">' . check_plain($node->title) . '</div>';
  }
   
  if ($node->review_text) {
    $output .= '<div class="userreview_review_body">' . check_markup($node->review_text) . '</div>';
  }
  $output .= '<br/><span class="userreview_byline">';
  $output .= t('by '). l($node->name, 'user/' . $node->uid);
  $output .= t(' on ') . format_date($node->changed);
  $output .= '</span>';
  if ($node->uid == $user->uid && user_access("edit own user reviews")) {
    $output .= '<span class="userreview_review_link">';
    $output .=  l(t('Edit your review'), 'node/'.$node->nid.'/edit');
    $output .= '</span>';
  }
  $output .= '</td></tr></table>';
  $display = array(
      '#collapsible' => $collapsible,
      '#collapsed' => $collapsed,
      '#title' => $node->userreview_label,
      '#children' => $output
    );
  return theme('fieldset', $display);
}

/**
 * Themes a userreview node for teaser view.  This function is also used for
 * listing user reviews under each reviewed node, via the views module
 */
function theme_userreview_teaser($node) {
  global $user;
  $output = "";
  $output .= '<table class="userreview_view_teaser">';
  $output .= '<tr><td align="left" class="userreview_review_vote_container">';
  $output .= theme('userreview_vote', $node->vote_value);
  $output .= '</td><td>';
  if ($node->title) {
    $output .= '<div class="userreview_review_title">' . check_plain($node->title) . '</div>';
  }
   
  if ($node->review_text) {
    $output .= '<div class="userreview_review_body">';
    $output .= check_markup($node->review_text);
    if ($node->readmore) {
    	$output .= l(t('Read more...'), 'node/' . $node->nid, 'Read the full review');
    }
    $output .= '</div>';
  }
  $output .= '<br/><span class="userreview_byline">';
  $output .= t('by '). l($node->name, 'user/'. $node->uid);
  $output .= t(' on ') . format_date($node->changed);
  $output .= '</span>';
  
  if ($node->uid == $user->uid && user_access("edit own user reviews")) {
    $output .= '<span class="userreview_review_link">';
    $output .=  l(t('Edit your review'), 'node/'. $node->nid .'/edit');
    $output .= '</span>';
  }
    
  $output .= '</td></tr></table>';
  return $output;
}

/**
 * Themes the userreview form.  Adds a header andplaces the form inside a div
 * tag, permitting theming of this form.  By default, the form is rendered with
 * gray background to set it apart from the reviewed node.
 */
function theme_userreview_included_form($title, $form_html) {
    $op = isset($_POST['op']) ? $_POST['op'] : '';
    $output = '';
    $display = array(
      '#collapsible' => variable_get('userreview_form_collapsible', true),
      '#collapsed' => variable_get('userreview_form_collapsed', true) && $op != t('Preview'),
      '#title' => check_plain($title),
      '#children' => $form_html
    );
    $output .= theme('fieldset', $display);
    return $output;
}

/**
 * Themes a userreview vote number.  Places the caption below the numnber.
 * Using table layout for most consistent cross-browser & cross-theme layout.
 */
function theme_userreview_vote($vote_value) {
  $output = '';
  if (is_numeric($vote_value)) {
    $output .= '<table class="userreview_review_vote">';
    $display_number = $vote_value;
    if (floor($vote_value) < $vote_value) {
      $display_number = number_format($vote_value, variable_get('userreview_vote_decimal','1'));
    }
    $score_class = 'userreview_review_number userreview_score_' . number_format($vote_value, 0);  
    $output .= '<tr><td class="' . $score_class . '">' . $display_number . '</td></tr>';
    $caption = variable_get('userreview_vote_number_caption',t('out of 10'));
    if ($caption) {
      $output .= '<tr><td class="userreview_review_number_caption">' . $caption . '</td></tr>';
    }
    $output .= '</table>';
  }
  return $output;
}

/**
 * Themes the report of average vote value of the voting on a particular node.
 */
function theme_userreview_voting_results($avg_vote, $count_votes) {
  $output = '';
  $output .= '<table class="userreview_voting_result"><tr><td>';
  $output .= '<span class="userreview_voting_result_title">';
  $output .= t('Average vote');
  $output .= '</span>';
  $output .= t(' based on ');
  $output .= '<span class="userreview_count_votes">';
  $output .= $count_votes;
  $output .= '</span>';
  $output .= format_plural($count_votes, t(' review.'), t(' reviews.'));
  $output .= '</td><td class="userreview_average_vote">';
  $output .= theme('userreview_vote', $avg_vote);
  $output .= '</td>';
  $output .= '</tr></table>';
  
  return $output;
}

/* ****************************************
 * Begin Views module functions
 * ****************************************/
 
/**
 * The core views module function.  Defines the fields, filters, sorts for
 * viewing userreview nodes
 */
function userreview_views_tables() {
  $tables['userreview'] = array(
    'name' => 'userreview', 
    'join' => array(
      'left' => array(
        'table' => 'node',
        'field' => 'nid',
      ), 
      'right' => array(
        'field' => 'nid',
      ), 
    ),
    'fields' => array(
      'review_text' => array(
        'name' => 'Userreview: Review Text', 
        'sortable' => false,
        'nid' => 'nid', 
        'addlfields' => array('nid'),
      ),
      'vote_tag' => array(
        'name' => 'Userreview: Review Type', 
        'sortable' => true,
        'nid' => 'nid', 
        'addlfields' => array('nid'),
      ),
      'vote_value' => array(
        'name' => 'Userreview: Vote Value', 
        'sortable' => true,
        'nid' => 'nid', 
        'addlfields' => array('nid'),
      ),
    ),
    'sorts' => array(
      'vote_tag' => array('name' => 'Userreview: Review Type'),
      'vote_value' => array('name' => 'Userreview: Vote Value'),
    ),
  );
  return $tables;
}

/**
 * Implementation of hook_views_arguments. Defines the content_id argument for
 * viewing userreview nodes
 */
function userreview_views_arguments() {
  $arguments = array(
    'userreview_content_id' => array(
      'name' => t("Userreview: Content ID"), 
      'handler' => "userreview_views_handler_arg_content_id"
    )
  );
  return $arguments;
}

/**
 * The handler for the content_id views argument, for viewing userreview nodes
 */
function userreview_views_handler_arg_content_id($op, &$query, $argtype, $arg = '') {
  switch($op) {
    case 'summary':
      $query->add_field("content_id");
      $query->add_groupby("userreview.content_id");
      $fieldinfo['field'] = "userreview.content_id";
      return $fieldinfo;
    case 'filter':
      $query->ensure_table("userreview");
      $query->add_where("userreview.content_id = $arg");
      break;
    case 'link':
      return l($query->type, "userreview/of/$arg");
    case 'title':
      return $query;
  }
}

/**
 * This generates the list of userreviews which is rendered beneath the reviewed
 * node.  Calls theme_userreview_teaser to render the node
 */
function theme_views_view_userreview($view, $type, $nodes) {
  if ($view->type == 'list' || $type == 'embed') {   
    $counter = 0;
    foreach ($nodes as $node) {
      if ($counter > 0) {
        $output .= '<hr class="userreview"/>';
      }
      $counter++;       
      //map views fields to node fields
      $node->title = check_plain($node->node_title);
      $node->changed = $node->node_changed;
      $node->uid = $node->users_uid;
      $node->name = $node->users_name;
      if (variable_get('userreview_show_review_teasers', false)) {
        // show a shorten version of review text
        $node->review_text = node_teaser($node->userreview_review_text, $node->format);
        $node->readmore = (strlen($node->review_text) < strlen($node->userreview_review_text));         	
      }
      else {
        $node->review_text = check_markup($node->userreview_review_text);
        $node->readmore = false;
      }
      $node->vote_value = $node->userreview_vote_value;

      $output .= theme('userreview_teaser', $node);
    }
  }
  if ($output) {
    return $output;
  }
}

/**
 * Implementation of hook_views_default_views.
 * Defines the views view, which will
 * render the lsit of userreview nodes under the reviewed node.
 */
function userreview_views_default_views() {
  $view = new stdClass();
  $view->name = 'userreview';
  $view->description = 'list the userreview nodes by node';
  $view->access = array (
    0 => '1',
    1 => '2',
  );
  $view->page = TRUE;
  $view->page_title = '';
  $view->page_header = '';
  $view->page_header_format = '1';
  $view->page_type = 'list';
  $view->url = 'userreview/of';
  $view->use_pager = TRUE;
  $view->nodes_per_page = '10';
  $view->block = FALSE;
  $view->sort = array (
    array (
      'tablename' => 'node',
      'field' => 'changed',
      'sortorder' => 'DESC',
      'options' => '',
    ),
  );
  $view->argument = array (
    array (
      'type' => 'userreview_content_id',
      'argdefault' => '1',
      'title' => '',
      'options' => '',
    ),
  );
  $view->field = array (
    array (
      'tablename' => 'node',
      'field' => 'title',
      'label' => 'Title',
      'handler' => 'views_handler_field_nodelink',
    ),
    array (
      'tablename' => 'userreview',
      'field' => 'vote_value',
      'label' => 'Vote',
    ),
    array (
      'tablename' => 'node',
      'field' => 'changed',
      'label' => 'Date',
      'handler' => 'views_handler_field_date',
      'defaultsort' => 'DESC',
    ),
    array (
      'tablename' => 'users',
      'field' => 'name',
      'label' => 'by ',
    ),
    array (
      'tablename' => 'userreview',
      'field' => 'review_text',
      'label' => 'Remarks',
    ),
  );
  $view->filter = array (
    array (
      'tablename' => 'node',
      'field' => 'status',
      'operator' => '=',
      'options' => '',
      'value' => '1',
    ),
  );
  $view->requires = array(node, userreview, users);
  $views[$view->name] = $view;
  
  return $views;
}

///////////////////////////////////////
// Pathauto integration
///////////////////////////////////////

/**
 * Register a new section "userreviews" on pathauto settings page
 */
function userreview_pathauto($op) {
  switch ($op) {
    case 'settings':
      $settings = array();
      $settings['module'] = 'userreview';
      $settings['groupheader'] = t('Userreview settings');
      $settings['patterndescr'] = t('Alias for list of reviews for a node (userreview/of/[reviewed item nid])');
      $settings['patterndefault'] = '';
      $settings['bulkname'] = t('Bulk update userreview pages');
      $settings['bulkdescr'] = 
        t('Generate aliases for all existing userreview pages which do not already have aliases.');
      $settings['placeholders'] = array(
        t('[reviewed item nid]') => t('For userreview nodes, the node id of the reviewed item.'),
        t('[reviewed item title]') => t('For userreview nodes, the title of the reviewed item.'),
        t('[reviewed item path]') => t('For userreview nodes, the path alias for of the reviewed item.')
      );

      return (object) $settings;
    default:
      break;
  }
}

/**
 * Perform a bulk update on all userreview list pages
 */
function userreview_pathauto_bulkupdate() {
	$sql = "SELECT DISTINCT content_id from {userreview}";
	$result = db_query($sql);
	$count = 0;
  while ($node = db_fetch_object($result)) {
  	$placeholders = userreview_get_placeholders($node);
    $alias = pathauto_create_alias(
      'userreview', 
      'bulkupdate',
      $placeholders, 
      'userreview/of/' .</