';
$form['comment']['#children'] = $comment;
$output .= drupal_render($form['comment']);
}
// Any remaining cruft (should be empty).
$output .= drupal_render($form);
return $output;
}
/**
* Implementation of hook_node_types().
*/
function fivestar_node_type($op, $info) {
$type = $info->type;
$variables = array('fivestar', 'fivestar_unvote', 'fivestar_style', 'fivestar_stars', 'fivestar_comment', 'fivestar_position', 'fivestar_position_teaser');
// Be responsible and cleanup unneeded variables.
if ($op == 'delete') {
foreach ($variables as $variable) {
variable_del($variable .'_'. $type);
}
}
// When changing the type name, update the variables.
elseif ($op == 'update' && !empty($info->old_type) && $info->old_type != $info->type) {
foreach ($variables as $variable) {
$value = variable_get($variable .'_'. $type, -1);
if ($value != -1) {
variable_del($variable .'_'. $type);
variable_set($variable .'_'. $type, $value);
}
}
}
}
/**
* Callback function for admin/settings/fivestar. Display the settings form.
*/
function fivestar_settings() {
$form = array();
$form['fivestar_widget'] = array(
'#type' => 'radios',
'#title' => t('Widget display'),
'#options' => array('default' => t('Default')) + module_invoke_all('fivestar_widgets'),
'#default_value' => variable_get('fivestar_widget', 'default'),
'#description' => t('Choose a widget set to be used on your site.'),
'#attributes' => array('class' => 'fivestar-widgets clear-block'),
);
$form = system_settings_form($form);
// Manually setting #theme is a Drupal 6 bug: http://drupal.org/node/211015
$form['#theme'] = 'fivestar_settings';
return $form;
}
function theme_fivestar_settings($form) {
fivestar_add_css();
drupal_add_css(drupal_get_path('module', 'fivestar') .'/fivestar-admin.css', 'module', 'all', FALSE);
drupal_set_title(t('Fivestar Settings'));
// Default preview.
$form['fivestar_widget']['default']['#description'] = 'Default '. t('Preview') .': ';
// Preview for each widget.
$widget_number = 0;
foreach (element_children($form['fivestar_widget']) as $widget_key) {
if ($widget_key != 'default') {
$form['fivestar_widget'][$widget_key]['#description'] = $form['fivestar_widget'][$widget_key]['#title'] .' '. t('Preview') .': ';
$widget_number++;
}
}
return drupal_render($form);
}
/**
* Callback function for fivestar/preview/widget. Outputs an entire page
* containing a preview of the passed in fivestar widget format.
*/
function fivestar_preview_page($widget_number = NULL) {
$widgets = module_invoke_all('fivestar_widgets');
$css_files = array_keys($widgets);
if (isset($css_files[$widget_number])) {
fivestar_add_css($css_files[$widget_number]);
}
else {
fivestar_add_css('default');
}
fivestar_add_js();
print theme('fivestar_preview_page');
exit;
}
function theme_fivestar_preview_page() {
$form = array();
$form['vote'] = array(
'#type' => 'fivestar',
'#stars' => 5,
'#auto_submit' => FALSE,
'#allow_clear' => TRUE,
);
$form_state = array();
$form = form_builder('fivestar_preview', $form, $form_state);
$output = "\n";
$output .= '';
$output .= '';
$output .= ' '. t('Fivestar Preview') .'';
$output .= drupal_get_html_head();
$output .= drupal_get_css();
$output .= drupal_get_js();
$output .= ' ';
$output .= ' ';
$output .= drupal_render($form);
$output .= '';
return $output;
}
/**
* Callback function for fivestar/preview/node. Outputs a JSON page containing
* a Fivestar preview of a node rating widget.
*/
function fivestar_preview() {
// Perform a few basic security checks.
$style = check_plain($_POST['style']);
$text = check_plain($_POST['text']);
$stars = (int)$_POST['stars'];
$unvote = (boolean)$_POST['unvote'];
$title = (boolean)$_POST['title'];
$labels_enable = (boolean)$_POST['labels_enable'];
$labels = (array)$_POST['labels'];
foreach ($labels as $key => $label) {
$labels[$key] = filter_xss_admin($label);
}
$output = theme('fivestar_preview', $style, $text, $stars, $unvote, $title ? NULL : FALSE, $labels_enable, $labels);
drupal_set_header('Content-Type: text/javascript; charset=utf-8');
print drupal_to_js(array('status' => TRUE, 'data' => $output));
}
function theme_fivestar_preview($style = NULL, $text = NULL, $stars = NULL, $unvote = NULL, $title = NULL, $labels_enable = TRUE, $labels = array()) {
$values = array(
'average' => 50,
'user' => 80,
'count' => 20,
);
$settings = array(
'stars' => $stars,
'allow_clear' => $unvote,
'style' => $style,
'text' => $text,
'title' => $title,
'autosubmit' => FALSE,
'labels_enable' => $labels_enable,
'labels' => $labels,
);
$form = drupal_get_form('fivestar_custom_widget', $values, $settings);
// This regex is sadly necessary because having duplicate form_tokens or
// form_id elements can cause the content type form to choke. Forms inside of
// forms is also frowned upon, so this removes the wrapping form tag as well.
$form = str_replace(array(''), array(''), $form);
$form = preg_replace('/( method=".*?")|( action=".*?")|()/', '', $form);
return $form;
}
function theme_fivestar_preview_wrapper($content, $type = 'direct') {
return '
'. $content .'
';
}
/**
* Callback function for fivestar/vote path
* @param type
* A content-type to log the vote to. 'node' is the most common.
* @param cid
* A content id to log the vote to. This would be a node ID, a comment ID, etc.
* @param value
* A value from 1-100, representing the vote cast for the content.
* @return
* An XML chunk containing the results of the vote, for use by the client-side
* javascript code.
*/
function fivestar_vote($type, $cid, $value, $tag = 'vote') {
$result = _fivestar_cast_vote($type, $cid, $value, $tag, NULL, TRUE);
if ($type == 'node') {
$node = node_load($cid);
}
$stars = variable_get('fivestar_stars_'. (!isset($node) ? 'default' : $node->type), 5);
$output = '';
$output .= '';
$output .= '';
if (count($result)) {
foreach ($result as $data) {
if ($data['tag'] == $tag) {
$output .= '<'. $data['function'] .'>'. $data['value'] .'';
$summary[$data['tag']][$data['function']] = $data['value'];
}
}
}
$output .= '';
$output .= ''. theme('fivestar_summary', NULL, $summary[$tag]['average'], $summary[$tag]['count'], $stars) .'';
$output .= ''. theme('fivestar_summary', $value, NULL, $summary[$tag]['count'], $stars) .'';
$output .= ''. theme('fivestar_summary', $value, $summary[$tag]['average'], $summary[$tag]['count'], $stars) .'';
$output .= '';
$output .= '';
$output .= '';
$output .= ''. $value .'';
$output .= ''. $type .'';
$output .= ''. $cid .'';
$output .= '';
drupal_set_header("Content-Type: text/xml");
exit($output);
}
/**
* Internal function to handle vote casting, flood control, XSS, IP based
* voting, etc...
*/
function _fivestar_cast_vote($type, $cid, $value, $tag = NULL, $uid = NULL, $result = FALSE) {
global $user;
$tag = empty($tag) ? 'vote' : $tag;
$uid = empty($uid) ? $user->uid : $uid;
// Bail out if the user's trying to vote on an invalid object.
if (!_fivestar_validate_target($type, $cid)) {
return array();
}
// Sanity-check the incoming values.
if (is_numeric($cid) && is_numeric($value)) {
if ($value > 100) {
$value = 100;
}
// Get the user's current vote.
$criteria = array('content_type' => $type, 'content_id' => $cid, 'tag' => $tag);
$user_votes = votingapi_select_votes($criteria += array('uid' => $uid));
if ($value == 0) {
votingapi_delete_votes($user_votes);
}
else {
$votes = $criteria += array('value' => $value, 'uid' => $uid);
votingapi_set_votes($votes, $user_votes);
return $votes[0];
}
}
}
function fivestar_get_votes($type, $cid, $tag = 'vote', $uid = NULL) {
global $user;
if (empty($uid)) {
$uid = $user->uid;
}
$criteria = array(
'content_type' => $type,
'content_id' => $cid,
'value_type' => 'percent',
'tag' => $tag,
);
$votes = array(
'average' => array(),
'count' => array(),
'user' => array(),
);
$results = votingapi_select_results($criteria);
foreach ($results as $result) {
if ($result['function'] == 'average') {
$votes['average'] = $result;
}
if ($result['function'] == 'count') {
$votes['count'] = $result;
}
}
if ($user->uid) {
$user_vote = votingapi_select_votes($criteria += array('uid' => $user->uid));
if ($user_vote) {
$votes['user'] = $user_vote[0];
}
}
else {
// If the user is anonymous, we never bother loading their existing votes.
// Not only would it be hit-or-miss, it would break page caching. Safer to always
// show the 'fresh' version to anon users.
$votes['user'] = array('value' => 0);
}
return $votes;
}
/**
* Internal function to check that node-type accepts votes
*
* @param text $type type of target (currently only node is supported)
* @param text $id identifier within the type (in this case node-type)
*
* @return boolean
*/
function _fivestar_validate_target($type, $id) {
switch ($type) {
case 'node':
if ($node = node_load($id)) {
if (variable_get('fivestar_'. $node->type, 0)) {
return TRUE;
}
else {
return FALSE;
}
}
else {
return FALSE;
}
default:
return FALSE;
}
}
/**
* Implementation of hook_fivestar_widgets.
*
* This hook allows other modules to create additional custom widgets for
* the fivestar module.
*
* @return array
* An array of key => value pairs suitable for inclusion as the #options in a
* select or radios form element. Each key must be the location of a css
* file for a fivestar widget. Each value should be the name of the widget.
*/
function fivestar_fivestar_widgets() {
$widgets_directory = drupal_get_path('module', 'fivestar') .'/widgets';
$files = file_scan_directory($widgets_directory, '\.css$');
$widgets = array();
foreach ($files as $file) {
$widgets[$file->filename] = drupal_ucfirst($file->name);
}
return $widgets;
}
/**
* Implementation of hook_nodeapi()
*
* Adds the fievestar widget to the node view.
*/
function fivestar_nodeapi(&$node, $op, $teaser, $page) {
switch ($op) {
case 'view':
if ($node->build_mode != NODE_BUILD_PREVIEW && variable_get('fivestar_'. $node->type, 0)) {
if ($teaser) {
$position = variable_get('fivestar_position_teaser_'. $node->type, 'above');
}
else {
$position = variable_get('fivestar_position_'. $node->type, 'above');
}
switch ($position) {
case 'above':
case 'below':
if (user_access('rate content')) {
$node->content['fivestar_widget'] = array(
'#value' => fivestar_widget_form($node),
'#weight' => $position == 'above' ? -10 : 50,
);
break;
} // Fall through to static if not allowed to rate.
case 'above_static':
case 'below_static':
$stars = variable_get('fivestar_stars_'. $node->type, 5);
$node->content['fivestar_widget'] = array(
'#value' => fivestar_static('node', $node->nid, $node->type),
'#weight' => $position == 'above_static' ? -10 : 50,
);
break;
default:
// We'll do nothing.
break;
}
}
break;
}
}
function fivestar_block($op = 'list', $delta = 0, $edit = array()) {
global $user;
switch ($op) {
case 'list':
$blocks[0]['info'] = t('Fivestar: Rate this node');
return $blocks;
case 'view':
if (user_access('access content') && user_access('rate content')) {
if (arg(0) == 'node' && is_numeric(arg(1)) && (arg(2) == '' || arg(2) == 'view')) {
$node = node_load(arg(1));
if (_fivestar_validate_target('node', $node->nid)) {
$block['subject'] = t('Rate This');
$block['content'] = fivestar_widget_form($node);
}
return $block;
}
}
break;
}
}
function fivestar_widget_form($node) {
return drupal_get_form('fivestar_form_node_'. $node->nid, 'node', $node->nid);
}
/**
* Implementation of hook_forms. This is necessary when multiple fivestar
* forms appear on the same page, each requiring a separate form_id, but all
* using the same underlying callbacks.
*/
function fivestar_forms($form_id, $args) {
if (strpos($form_id, 'fivestar_form') !== FALSE) {
if ($form_id == 'fivestar_form_'. $args[0] .'_'. $args[1]) {
$forms[$form_id] = array('callback' => 'fivestar_form');
return $forms;
}
}
}
/**
* Create the fivestar form for the current item.
* Note that this is not an implementation of hook_form(). We should probably
* change the function to reflect that.
*/
function fivestar_form(&$form_state, $content_type, $content_id) {
global $user;
if ($content_type == 'node') {
if (is_numeric($content_id)) {
$node = node_load($content_id);
}
else {
return array();
}
}
$votes = fivestar_get_votes($content_type, $content_id);
$values = array(
'user' => $votes['user']['value'],
'average' => $votes['average']['value'],
'count' => $votes['count']['value'],
);
$settings = array(
'stars' => variable_get('fivestar_stars_'. $node->type, 5),
'allow_clear' => variable_get('fivestar_unvote_'. $node->type, FALSE),
'style' => variable_get('fivestar_style_'. $node->type, 'average'),
'text' => variable_get('fivestar_text_'. $node->type, 'combo'),
'content_type' => $content_type,
'content_id' => $content_id,
'autosubmit' => TRUE,
'title' => variable_get('fivestar_title_'. $node->type, 1) ? NULL : FALSE,
'labels_enable' => variable_get('fivestar_labels_enable_'. $node->type, 1),
'labels' => variable_get('fivestar_labels_'. $node->type, array()),
);
return fivestar_custom_widget($form_state, $values, $settings);
}
function fivestar_static($content_type, $content_id, $node_type = NULL) {
global $user;
$criteria = array(
'content_type' => $content_type,
'content_id' => $content_id,
'value_type' => 'percent',
'tag' => 'vote',
);
$votes = fivestar_get_votes($content_type, $content_id);
if ($content_type == 'node') {
// Content type should always be passed to avoid this node load.
if (!isset($node_type)) {
$node = node_load($content_id);
$node_type = $node->type;
}
$star_display = variable_get('fivestar_style_'. $node_type, 'average');
$text_display = variable_get('fivestar_text_'. $node_type, 'dual');
$title_display = variable_get('fivestar_title_'. $node_type, 1);
$stars = variable_get('fivestar_stars_'. $node_type, 5);
switch ($star_display) {
case 'average':
case 'dual':
$star_value = $votes['average']['value'];
$title = $title_display ? t('Average') : NULL;
break;
case 'user':
$star_value = $votes['user']['value'];
$title = $title_display ? t('Your rating') : NULL;
break;
case 'smart':
$star_value = $votes['user']['value'] ? $votes['user']['value'] : $votes['average']['value'];
$title = $title_display ? $votes['user']['value'] ? t('Your rating') : t('Average') : NULL;
break;
}
// Set all text values, then unset the unnecessary ones.
$user_value = $votes['user']['value'];
$average_value = $votes['average']['value'];
$count_value = $votes['count']['value'];
switch ($text_display) {
case 'average':
$user_value = NULL;
break;
case 'user':
$average_value = NULL;
break;
case 'smart':
if ($votes['user']['value']) {
$average_value = NULL;
}
else {
$user_value = NULL;
}
break;
}
}
// Possibly add other content types here (comment, user, etc).
else {
$stars = 5;
$star_value = $votes['average']['value'];
$user_value = $votes['user']['value'];
$average_value = $votes['average']['value'];
$count_value = $votes['count']['value'];
}
$star_display = theme('fivestar_static', $star_value, $stars);
$text_display = $text_display == 'none' ? NULL : theme('fivestar_summary', $user_value, $average_value, $count_value, $stars);
return theme('fivestar_static_element', $star_display, $title, $text_display);
}
function fivestar_custom_widget(&$form_state, $values, $settings) {
$form = array(
'#attributes' => array('class' => 'fivestar-widget'),
'#redirect' => FALSE,
'#theme' => 'fivestar_widget',
);
$form['#submit'][] = 'fivestar_form_submit';
if (isset($settings['content_type'])) {
$form['content_type'] = array(
'#type' => 'hidden',
'#value' => $settings['content_type'],
'#id' => $settings['content_id'] ? 'edit-content-type-'. $settings['content_id'] : NULL,
);
}
if (isset($settings['content_id'])) {
$form['content_id'] = array(
'#type' => 'hidden',
'#value' => $settings['content_id'],
'#id' => $settings['content_id'] ? 'edit-content-id-'. $settings['content_id'] : NULL,
);
}
$form['vote'] = array(
'#type' => 'fivestar',
'#stars' => $settings['stars'],
'#vote_count' => $values['count'],
'#vote_average' => $values['average'],
'#auto_submit' => isset($settings['autosubmit']) ? $settings['autosubmit'] : TRUE,
'#auto_submit_path' => 'fivestar/vote/'. $settings['content_type'] .'/'. $settings['content_id'],
'#allow_clear' => $settings['allow_clear'],
'#content_id' => $settings['content_id'],
'#required' => isset($settings['required']) ? $settings['required'] : FALSE,
'#labels_enable' => isset($settings['labels_enable']) ? $settings['labels_enable'] : TRUE,
'#labels' => isset($settings['labels']) ? $settings['labels'] : NULL,
);
$form['destination'] = array(
'#type' => 'hidden',
'#value' => $_GET['q'],
);
$form['fivestar_submit'] = array(
'#type' => 'submit',
'#value' => t('Rate'),
'#attributes' => array('class' => 'fivestar-submit'),
'#id' => $settings['content_id'] ? 'edit-fivestar-submit-'. $settings['content_id'] : NULL,
);
switch ($settings['text']) {
case 'user':
$form['vote']['#description'] = theme('fivestar_summary', $values['user'], NULL, $values['count'], $settings['stars']);
$form['vote']['#attributes']['class'] .= ' fivestar-user-text';
break;
case 'average':
$form['vote']['#description'] = theme('fivestar_summary', NULL, $values['average'], $values['count'], $settings['stars']);
$form['vote']['#attributes']['class'] .= ' fivestar-average-text';
break;
case 'smart':
$form['vote']['#description'] = theme('fivestar_summary', $values['user'], $values['user'] ? NULL : $values['average'], $values['count'], $settings['stars']);
$form['vote']['#attributes']['class'] .= ' fivestar-smart-text '. ($values['user'] ? 'fivestar-user-text' : 'fivestar-average-text');
break;
case 'dual':
$form['vote']['#description'] = theme('fivestar_summary', $values['user'], $values['average'], $values['count'], $settings['stars']);
$form['vote']['#attributes']['class'] .= ' fivestar-combo-text';
break;
}
switch ($settings['style']) {
case 'average':
$form['vote']['#title'] = t('Average');
$form['vote']['#default_value'] = $values['average'];
$form['vote']['#attributes']['class'] .= ' fivestar-average-stars';
break;
case 'user':
$form['vote']['#title'] = t('Your rating');
$form['vote']['#default_value'] = $values['user'];
$form['vote']['#attributes']['class'] .= ' fivestar-user-stars';
break;
case 'smart':
$form['vote']['#title'] = $values['user'] ? t('Your rating') : t('Average');
$form['vote']['#default_value'] = $values['user'] ? $values['user'] : $values['average'];
$form['vote']['#attributes']['class'] .= ' fivestar-smart-stars '. ($values['user'] ? 'fivestar-user-stars' : 'fivestar-average-stars');
break;
case 'dual':
$form['vote']['#title'] = t('Your rating');
$form['vote']['#default_value'] = $values['user'];
$form['vote']['#attributes']['class'] .= ' fivestar-combo-stars';
$form['#attributes']['class'] .= ' fivestar-combo-stars';
$static_average = theme('fivestar_static', $values['average'], $settings['stars']);
$form['average'] = array(
'#type' => 'markup',
'#value' => theme('fivestar_static_element', $static_average, $settings['title'] !== FALSE ? t('Average') : NULL),
'#weight' => -1,
);
break;
}
// Set an over-ridding title if passed in.
// An empty title won't change the default, a string will set a new title,
// and title === FALSE will unset the title entirely.
if (isset($settings['title'])) {
if ($settings['title'] !== FALSE) {
$form['vote']['#title'] = $settings['title'];
}
else {
unset($form['vote']['#title']);
unset($form['average']['#title']);
}
}
return $form;
}
/**
* Submit handler for the above form (non-javascript version).
*/
function fivestar_form_submit($form, &$form_state) {
if ($form_state['values']['form_id'] == 'fivestar_form_'. $form_state['values']['content_type'] .'_'. $form_state['values']['content_id']) {
// Cast the vote.
_fivestar_cast_vote($form_state['values']['content_type'], $form_state['values']['content_id'], $form_state['values']['vote']);
// Set a message that the vote was received.
if ($form_state['values']['vote'] === '0') {
drupal_set_message(t('Your vote has been cleared.'));
}
elseif (is_numeric($form_state['values']['vote'])) {
drupal_set_message(t('Thank you for your vote.'));
}
// Regenerate the page with a drupal_goto() to update the current values.
drupal_goto();
}
}
/**
* Implementation of hook_elements
*
* Defines 'fivestar' form element type
*/
function fivestar_elements() {
$type['fivestar'] = array(
'#input' => TRUE,
'#stars' => 5,
'#widget' => 'stars',
'#allow_clear' => FALSE,
'#auto_submit' => FALSE,
'#auto_submit_path' => '',
'#labels_enable' => TRUE,
'#process' => array('fivestar_expand'),
);
return $type;
}
/**
* Theme the fivestar form element by adding necessary css and javascript.
*/
function theme_fivestar($element) {
// Add necessary CSS.
fivestar_add_css();
// Add necessary javascript.
if ($element['#widget'] == 'stars' ) {
fivestar_add_js();
}
return theme('form_element', $element, $element['#children']);
}
/**
* Theme the straight HTML version of the fivestar select list. This is used
* to remove the wrapping 'form-item' div from the select list.
*/
function theme_fivestar_select($element) {
$select = '';
$size = $element['#size'] ? ' size="'. $element['#size'] .'"' : '';
_form_set_class($element, array('form-select'));
$multiple = isset($element['#multiple']) && $element['#multiple'];
return '';
}
/**
* Theme an entire fivestar widget, including the submit button and the normal
* fivestar widget themed in the theme_fivestar() function.
*/
function theme_fivestar_widget($form) {
// Move the description outside of the vote element.
$description = empty($form['vote']['#description']) ? ' ' : $form['vote']['#description'];
unset($form['vote']['#description']);
$output = '';
$output .= '
';
$output .= drupal_render($form);
// Only print out the summary if text is being displayed or using rollover text.
if ($form['#parameters'][2]['text'] != 'none' || !empty($form['#parameters'][2]['labels'])) {
$output .= '
'. $description .'
';
}
$output .= '
';
return $output;
}
/**
* Display a plain HTML VIEW ONLY version of the widget
* with the specified rating
*
* @param $rating
* The desired rating to display out of 100 (i.e. 80 is 4 out of 5 stars)
* @param $stars
* The total number of stars this rating is out of
* @return
* A themed HTML string representing the star widget
*
*/
function theme_fivestar_static($rating, $stars = 5) {
// Add necessary CSS.
fivestar_add_css();
$output = '';
$output .= '
';
return $output;
}
/**
* Display a static fivestar value as stars with a title and description.
*/
function theme_fivestar_static_element($value, $title = NULL, $description = NULL) {
$output .= '