modules/dodge/dodge.module

<?php
// $Id: dodge.module,v 1.19 2008/04/18 12:12:54 davyvandenbremt Exp $

/**
 * @file
 * Dodge module.
 *
 * The dodge module mimics the Twitter functionality in a very basic way.
 *
 * Users can publish what they're doing, how they feel, their state (= dodge)...
 *
 * For each user a for in provided in a new category where he/she can set his state. State can be one of a list of predefined stated (provided by the webmaster) or a state typed in by the user in a free text box.
 *
 * A history of user states is kept so you can always see what someone's states was some time ago. The size of the history can be set.
 *
 * A few blocks are provided:
 * - Most popular dodges.
 * - Most recent dodges.
 * - On a profile page: the user's history.
 * - On every page: your own history (if you are logged in)
 *
 * Before version 1.0 is released we need : 
 * - all bugs resolved in the issue queue
 * - a block (ajax) where you can specify your current dodge
 *
 * Then dodge will be ported to Drupal 6.
 *
 * In Drupal 6 version all blocks will have an ajax alternative.
 * 
 * @todo add indexes ... but take care, because submitting them has a problem with age updating
 * @todo 'show all dodges' should show all popular dodges when on popular block and all history on 'recent block'. on the user's blocks it should redirect to user block page
 * @todo make a new block : random dodge  where a random dodge of 1 user is displayed (with his picture if available)
 * @todo provide a help function
 * @todo let admin choose if forced_dodges are necessary
 * @todo let admin choose if 'No dodge at this moment' is possible.
 * @todo make a paged list with all states and the ability to delete them
 * @todo bug: dodge_dodge_delete_confirm_submit -> do different query depending on type (free/forced), pass type via delete/1/free
 * @todo all blocks should refresh by ajax
 * @todo ?but should all existing free dodges be destoryed then?: let admin choose if user can define free dodges
 * @todo let user choose if he wants his status to be shown on profile page
 * @todo make button : remove all free dodges
 * @todo make button : converted forced to free / free to forced
 */

require_once 'dodge.inc';

define('DODGE_DEFAULT_MAX_BLOCK_SIZE', 5);
define('DODGE_LIMIT_AUTOCOMPLETE', 10);

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

  if ($may_cache) {
    $items[] = array(
      'path' => 'dodge/autocomplete',
      'title' => t('Dodge autocomplete'),
      'callback' => 'dodge_autocomplete',
      'access' => TRUE,
      'type' => MENU_CALLBACK
    );
    $items[] = array(
      'path' => 'dodge/browse',
      'title' => t('Dodge user list'),
      'callback' => 'dodge_browse',
      'access' => TRUE,
      'type' => MENU_SUGGESTED_ITEM
    );
    $items[] = array(
      'path' => 'dodge/all',
      'title' => t('All dodges'),
      'callback' => 'dodge_dodge_list',
      'access' => TRUE,
      'type' => MENU_SUGGESTED_ITEM
    );

    /*
     * Options.
     */
    $items[] = array(
      'path' => 'admin/settings/dodge',
      'title' => t('Dodge'),
      'callback' => 'drupal_get_form',
      'callback arguments' => array('dodge_settings_form'),
      'access' => user_access('administer dodge'),
      'type' => MENU_NORMAL_ITEM
    );
    $items[] = array(
      'path' => 'admin/settings/dodge/general',
      'title' => t('General'),
      'callback' => 'drupal_get_form',
      'callback arguments' => array('dodge_settings_form'),
      'access' => user_access('administer dodge'),
      'weight' => 0,
      'type' => MENU_DEFAULT_LOCAL_TASK
    );
    $items[] = array(
      'path' => 'admin/settings/dodge/options',
      'title' => t('Presets'),
      'callback' => 'dodge_preset_list',
      'access' => user_access('administer dodge'),
      'weight' => 1,
      'type' => MENU_LOCAL_TASK
    );
    $items[] = array(
      'path' => 'admin/settings/dodge/options/list',
      'title' => t('List'),
      'callback' => 'dodge_preset_list',
      'access' => user_access('administer dodge'),
      'weight' => 0,
      'type' => MENU_DEFAULT_LOCAL_TASK
    );
    $items[] = array(
      'path' => 'admin/settings/dodge/options/new',
      'title' => t('New'),
      'callback' => 'drupal_get_form',
      'callback arguments' => array('dodge_preset_edit', 'new'),
      'access' => user_access('administer dodge'),
      'weight' => 1,
      'type' => MENU_LOCAL_TASK
    );
    $items[] = array(
      'path' => 'admin/settings/dodge/options/edit',
      'title' => t('Edit option'),
      'callback' => 'drupal_get_form',
      'callback arguments' => array('dodge_preset_edit'),
      'access' => user_access('administer dodge'),
      'type' => MENU_CALLBACK,
    );
    $items[] = array(
      'path' => 'admin/settings/dodge/options/delete',
      'title' => t('Delete option'),
      'callback' => 'drupal_get_form',
      'callback arguments' => array('dodge_preset_delete_confirm'),
      'access' => user_access('administer dodge'),
      'type' => MENU_CALLBACK,
    );
    $items[] = array(
      'path' => 'admin/settings/dodge/dodges',
      'title' => t('Dodges'),
      'callback' => 'dodge_dodge_list',
      'callback arguments' => array(TRUE),
      'access' => user_access('administer dodge'),
      'weight' => 1,
      'type' => MENU_LOCAL_TASK
    );
    $items[] = array(
      'path' => 'admin/settings/dodge/dodges/list',
      'title' => t('List'),
      'callback' => 'dodge_dodge_list',
      'callback arguments' => array(TRUE),
      'access' => user_access('administer dodge'),
      'weight' => 0,
      'type' => MENU_DEFAULT_LOCAL_TASK
    );
    $items[] = array(
      'path' => 'admin/settings/dodge/dodges/delete',
      'title' => t('Delete dodge'),
      'callback' => 'drupal_get_form',
      'callback arguments' => array('dodge_dodge_delete_confirm'),
      'access' => user_access('administer dodge'),
      'type' => MENU_CALLBACK,
    );
  }
  else {
    if(arg(0) == 'user' && is_numeric(arg(1)) && arg(2) == 'dodge') {
      $display_user = user_load((array('uid' => arg(1))));
      if($user->uid) {
        $items[] = array(
          'path' => 'user/'.arg(1).'/dodge',
          'title' => t('@name\'s dodges', array('@name'=>$display_user->name)),
          'callback' => 'dodge_user_dodge',
          'access' => TRUE,
          'type' => MENU_CALLBACK,
        );
        /*if(arg(3) == 'rss.xml') {
          $items[] = array(
            'path' => 'user/'.arg(1).'/dodge/rss.xml',
            'title' => t('@name\'s dodges', array('@name'=>$user->name)),
            'callback' => 'dodge_user_dodge_feed',
            'access' => TRUE,
            'type' => MENU_CALLBACK,
          );
        }*/
      }
    }
  }

  return $items;
}

function dodge_user_dodge() {
  // add feed icon
  $user = user_load(array('uid' => arg(1)));
  /*$feed_url = url('user/'.arg(1).'/dodge/rss.xml', NULL, NULL, TRUE);
  drupal_add_feed($feed_url, t('@name\'s dodges', array('@name'=>$user->name)) . ' | '.variable_get('site_name', 'Drupal') .' '. t('RSS'));*/
  $dodges = _dodge_history_of_user(arg(1), variable_get('dodge_max_log_size', 20), TRUE);
  return theme('dodge_user_dodge', $dodges);
}

/**
 * Format the page of user dodges.
 *
 * @ingroup themeable
 */
function theme_dodge_user_dodge($dodges) {
  $items = array();
  foreach ($dodges as $dodge) {
    $items[] = sprintf('%s %s %s %s',
      _dodget_format_date_time_ago($dodge->time),
      l($dodge->name, 'user/'. $dodge->uid),
      t('was'),
      l($dodge->dodge, 'dodge/browse/'. $dodge->dodge)
    );
  }
  return theme('item_list', $items);
}

/*function dodge_user_dodge_feed() {
  $dodges = _dodge_history_of_user(arg(1), variable_get('feed_default_items', 10), TRUE);
  dodge_feed($dodges);
}*/

/**
 * A generic function for generating RSS feeds from a set of nodes.
 *
 * @param $nodes
 *   An object as returned by db_query() which contains the nid field.
 * @param $channel
 *   An associative array containing title, link, description and other keys.
 *   The link should be an absolute URL.
 */
/*function dodge_feed($dodges) {
  global $base_url, $locale;

  $namespaces = array('xmlns:dc="http://purl.org/dc/elements/1.1/"');

  foreach($dodges as $dodge) {
    $link = url("dodge/$dodge->did", NULL, NULL, 1);

    // Allow modules to add additional item fields and/or modify $item
    //$extra = node_invoke_nodeapi($item, 'rss item');
    $extra = array(
      array(
        'key' => 'pubDate', 
        'value' =>  date('r', $dodge->time)
      ), 
      array(
        'key' => 'guid', 
        'value' => $dodge->time . 'x' . $dodge->uid .' at '. $base_url, 
        'attributes' => array('isPermaLink' => 'false')
      )
    );
    foreach ($extra as $element) {
      if ($element['namespace']) {
        $namespaces = array_merge($namespaces, $element['namespace']);
      }
    }

    $item_text = sprintf('%s %s %s %s',
      format_date($dodge->time),
      $dodge->name,
      t('was'),
      $dodge->dodge
    );

    $items .= format_rss_item($item_text, $link, $item_text, $extra);
  }

  $channel = array(
    'version'     => '2.0',
    'title'       => variable_get('site_name', 'Drupal') .' - '. variable_get('site_slogan', ''),
    'link'        => $base_url,
    'description' => variable_get('site_mission', ''),
    'language'    => $locale
  );
  
  $output = "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n";
  $output .= "<rss version=\"". $channel["version"] ."\" xml:base=\"". $base_url ."\" ". implode(' ', $namespaces) .">\n";
  $output .= format_rss_channel($channel['title'], $channel['link'], $channel['description'], $items, $channel['language']);
  $output .= "</rss>\n";

  drupal_set_header('Content-Type: application/rss+xml; charset=utf-8');
  print $output;
}*/

/**
 * Implementation of hook_perm().
 */
function dodge_perm() {
  return array('can dodge', 'administer dodge');
}

/**
 * Drupal settings form for specifying the general settings for this module.
 */
function dodge_settings_form() {

  $form['dodge_max_log_size'] = array(
    '#type' => 'textfield',
    '#title' => t('Maximum log size'),
    '#default_value' =>  variable_get('dodge_max_log_size', 20),
    '#size' => 3,
    '#maxlength' => 5,
    '#description' => t('Maximum number of dodges that will be remembered. To specify that no dodges should ever be removed, use -1.'),
    '#validate' => array("_dodge_number_validate" => array()),
  );

  $form['dodge_dodges_per_page'] = array(
    '#type' => 'textfield',
    '#title' => t('Dodges per page'),
    '#default_value' =>  variable_get('dodge_dodges_per_page', 20),
    '#size' => 3,
    '#maxlength' => 5,
    '#description' => t('Maximum number of dodges that will be displayed on a page in a listing of dodges like dodge/all.'),
    '#validate' => array("_dodge_number_validate" => array()),
  );

  $form['dodge_allow_free_dodge'] = array(
    '#type' => 'checkbox',
    '#title' => t('Should a user be allowed to free dodges?'),
    '#default_value' => variable_get('dodge_allow_free_dodge', 1),
    '#description' => t('Uncheck to only allow users to use the dodges you define.'),
  );

  $form['dodge_expire'] = array(
    '#type' => 'textfield',
    '#title' => t('Number of days after which dodges will be purged from the database'),
    '#default_value' => variable_get('dodge_expire', 0),
    '#size' => 4,
    '#maxlength' => 4,
    '#description' => t("Dodges will be permanently deleted after the number of days specified.  Dodges will never expire when this is set to zero."),
    '#validate' => array("_dodge_number_validate" => array()),
  );

  return system_settings_form($form);
}

/**
 * Implementation of hook_cron().
 */
function dodge_cron() {
  $expiration = variable_get('dodge_expire', 0);
  if ($expiration > 0) {
    db_query('DELETE FROM {dodge} WHERE time < %d', time() - 60*60*24*$expiration);
  }
}

function dodge_dodge_list($administer = FALSE) {
  $sql = 'SELECT dodge, count(uid) AS count, if (MIN(forced_dodge) = 1, \'free\', \'forced\') as type FROM {dodge} GROUP BY dodge ORDER BY dodge ASC';
  $sql_counter = 'SELECT COUNT(DISTINCT dodge) FROM {dodge}';
  $result = pager_query($sql, variable_get('dodge_dodges_per_page', 20), 0, $sql_counter, $filter['args']);
  $header = array(t('Dodge'), t('Occurences'));
  if($administer) {
    $header[] = t('Operations');
  }
  $rows = array();

  while ($dodge = db_fetch_object($result)) {
    $row = array();
    $row[] = l($dodge->dodge, 'dodge/browse/'.$dodge->dodge);
    $row[] = $dodge->count;
    if($administer) {
      $row[] = l(t('delete'), 'admin/settings/dodge/dodges/delete/'. $dodge->dodge);
    }

    $rows[] = $row;
  }

  if (empty($rows)) {
    $rows[] = array(array('data' => t('No dodges specified yet.'), 'colspan' => '3', 'class' => 'message'));
  }

  return theme('table', $header, $rows) . theme('pager', NULL, variable_get('dodge_dodges_per_page', 20), 0);
}

function dodge_preset_list() {
  $options = _dodge_get_forced_dodge_custom_options();
  $header = array(t('Dodge'), array('data' => t('Operations'), 'colspan' => '2'));
  $rows = array();

  foreach ($options as $key => $option) {
    $row = array();
    $row[] = $option;
    $row[] = l(t('edit'), 'admin/settings/dodge/options/edit/'. $key);
    $row[] = l(t('delete'), 'admin/settings/dodge/options/delete/'. $key);

    $rows[] = $row;
  }

  if (empty($rows)) {
    $rows[] = array(array('data' => t('No options defined. <a href="!url">Create a new option</a>.', array('!url' => url('admin/settings/dodge/options/new'))), 'colspan' => '3', 'class' => 'message'));
  }

  return theme('table', $header, $rows);
}

function dodge_dodge_delete_confirm($dodge) {
  $form['dodge'] = array('#type' => 'value', '#value' => $dodge);

  return confirm_form($form,
    t('Are you sure you want to delete the dodge %selector?', array('%selector' => $dodge)),
    $_GET['destination'] ? $_GET['destination'] : 'admin/settings/dodge/dodges/list',
    t('This action cannot be undone.'),
    t('Delete'), t('Cancel')
  );
}

function dodge_dodge_delete_confirm_submit($form_id, $form_values) {
  $options = _dodge_get_forced_dodge_options();
  $sql = 'UPDATE {dodge} SET dodge = \'%s\', free_dodge = \'\', forced_dodge = 0 WHERE free_dodge = \'%s\'';
  db_query($sql, $dodge->dodge, $dodge->dodge);

  drupal_set_message(t('Deleted dodge %name', array('%name' => $form_values['dodge'])));
  drupal_goto('admin/settings/dodge/dodges/list');
}

function dodge_preset_delete_confirm($did) {
  $dodges = _dodge_get_forced_dodge_custom_options();
  $dodge = $dodges[$did];

  $form['did'] = array('#type' => 'value', '#value' => $did);
  $form['dodge'] = array('#type' => 'value', '#value' => $dodge);

  return confirm_form($form,
    t('Are you sure you want to delete the option %selector?', array('%selector' => $dodge)),
    $_GET['destination'] ? $_GET['destination'] : 'admin/settings/dodge/options/list',
    t('This action cannot be undone.'),
    t('Delete'), t('Cancel')
  );
}

function dodge_preset_delete_confirm_submit($form_id, $form_values) {
  _dodge_preset_delete($form_values['did']);

  $sql = 'UPDATE {dodge} SET dodge = \'%s\', free_dodge = \'%s\', forced_dodge = 1 WHERE forced_dodge = %d';
  db_query($sql, $form_values['dodge'], $form_values['dodge'], $form_values['did']);

  drupal_set_message(t('Deleted option %name', array('%name' => $form_values['dodge'])));
  drupal_goto('admin/settings/dodge/options/list');
}

/**
 * FAPI definition for the dodge preset edit form.
 *
 * @ingroup forms
 * @see dodge_preset_edit_validate()
 * @see dodge_preset_edit_submit()
 */
function dodge_preset_edit($did) {
  $dodge;
  if (is_numeric($did)) {
    $dodges = _dodge_get_forced_dodge_custom_options();
    $dodge = $dodges[$did];
  }
  else {
    $dodge = '';
  }

  $form = array();

  $form['did'] = array(
    '#type' => 'value',
    '#value' => $did,
  );

  $form['dodge'] = array(
    '#type' => 'textfield',
    '#title' => t('Dodge'),
    '#description' => t('Specify a dodge.'),
    '#default_value' => $dodge,
    '#maxlength' => DODGE_MAX_DODGE_LENGTH,
    '#required' => TRUE,
  );

  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Submit'),
  );

  return $form;
}

function dodge_preset_edit_validate($form_id, $form_values) {
  $sql = 'SELECT did FROM {dodge_options} WHERE LOWER(dodge) = LOWER(\'%s\')';
  $result = db_query($sql, $form_values['dodge']);
  if (db_num_rows($result) > 0) {
    form_set_error('dodge', t('This dodge already exist.'));
  }
}

function dodge_preset_edit_submit($form_id, $form_values) {
  if ($form_values['did'] == 'new') {
    $next_id = -1;
    $return = _dodge_preset_create($form_values['dodge'], $next_id);
    $sql = 'UPDATE {dodge} SET dodge = \'%s\', free_dodge = \'\', forced_dodge = %d WHERE free_dodge LIKE \'%s\'';
    db_query($sql, $form_values['dodge'], $next_id, $form_values['dodge']);
  }
  elseif (is_numeric($form_values['did'])) {
    $return = _dodge_preset_update($form_values['did'], $form_values['dodge']);
    $sql = 'UPDATE {dodge} SET dodge = \'%s\' WHERE forced_dodge = %d';
    db_query($sql, $form_values['dodge'], $form_values['did']);
  }

  if ($return) {
    drupal_set_message(t('Updated preset %selector', array('%selector' => $form_values['dodge'])));
    drupal_goto('admin/settings/dodge/options/list');
  }
  else {
    drupal_set_message(t('The option was unable to be updated.', 'error'));
  }
}

function _dodge_preset_create($dodge, &$next_id) {
  $next_id = db_next_id('{dodge_options}_did');
  return db_query('INSERT INTO {dodge_options} (did, dodge) VALUES (%d, \'%s\')', $next_id, $dodge);
}

function _dodge_preset_update($did, $dodge) {
  return db_query('UPDATE {dodge_options} SET dodge =\'%s\' WHERE did = %d', $dodge, $did);
}

function _dodge_preset_delete($did) {
  return db_query('DELETE FROM {dodge_options} where did = %d', $did);
}

function dodge_autocomplete($string = '') {
  if (user_access('can dodge')) {
    $matches = array();
    if ($string) {
      global $user;
      $result = db_query_range("SELECT DISTINCT dodge FROM (SELECT dodge, if (uid = %d, 0, 1) AS weight FROM {dodge} WHERE uid = 1 UNION SELECT dodge, 2 AS weight FROM {dodge_options}) AS all_dodges WHERE LOWER(dodge) LIKE LOWER('%s%') ORDER BY weight ASC, dodge ASC", $user->uid, $string, 0, DODGE_LIMIT_AUTOCOMPLETE);
      while ($dodge = db_fetch_object($result)) {
        $matches[$dodge->dodge] = check_plain($dodge->dodge);
      }
    }
    print drupal_to_js($matches);
  }
  exit();

}

function _dodget_format_date_time_ago($time) {
  return t('@time ago', array('@time' => format_interval(time() - $time)));
}

/**
 * Format the block of recent dodges.
 *
 * @ingroup themeable
 */
function theme_dodge_block_recent_dodges($dodges) {
  $items = array();
  foreach ($dodges as $dodge) {
    $items[] = sprintf('%s %s %s %s',
      _dodget_format_date_time_ago($dodge->time),
      l($dodge->name, 'user/'. $dodge->uid),
      t('was'),
      l($dodge->dodge, 'dodge/browse/'. $dodge->dodge)
    );
  }
  return theme('item_list', $items).(variable_get('dodge_block_all_dodgesrecent_dodges', 1) ? l(t('Show all dodges'), 'dodge/all') : '');
}

/**
 * Format the block of popular dodges.
 *
 * @ingroup themeable
 */
function theme_dodge_block_popular_dodges($dodges) {
  $items = array();
  foreach ($dodges as $dodge) {
    $items[] = sprintf('%s %s %s %s',
      $dodge->count,
      t(format_plural($dodge->count, t('person'), t('people'))),
      format_plural($dodge->count, t('is'), t('are')),
      l($dodge->dodge, 'dodge/browse/'. $dodge->dodge)
    );
  }
  return theme('item_list', $items).(variable_get('dodge_block_all_dodgespopular_dodges', 1) ? l(t('Show all dodges'), 'dodge/all') : '');
}

/**
 * Format the block of recent dodges for a specific user.
 *
 * @ingroup themeable
 */
function theme_dodge_block_history_of_user($dodges, $display_user) {
  global $user;
  $is_current_user = ($display_user->uid == $user->uid);
  $items = array();
  foreach ($dodges as $dodge) {
    $items[] = sprintf('%s %s %s %s',
      _dodget_format_date_time_ago($dodge->time),
      !$is_current_user ? $display_user->name : t('You'),
      !$is_current_user ? t('was') : t('were'),
      l($dodge->dodge, 'dodge/browse/'. $dodge->dodge)
    );
  }
  return theme('item_list', $items).(variable_get('dodge_block_all_dodgeshistory_of_user', 1) ? l(t('Show all dodges'), 'user/'.$display_user->uid.'/dodge') : '');
}

/**
 * Format the block of recent dodges of the current user.
 *
 * @ingroup themeable
 */
function theme_dodge_block_history_of_current_user($dodges) {
  global $user;
  if (count($dodges) == 0) {
    return t('You have not set a dodge yet. Set your dodge !link.', array('!link' => l(t('in your user settings'), 'user/'. $user->uid .'/edit/dodge')));
  }
  return theme('dodge_block_history_of_user', $dodges, $user);
}

function theme_dodge_user_view($dodges, $user) {
  return theme('dodge_block_history_of_user', $dodges, $user);
}

function dodge_block_admin_configure_validate($form_values) {
  if (variable_get('dodge_max_log_size', 20) > 0 && $form_values['#post']['limit'] > variable_get('dodge_max_log_size', 20)) {
    form_set_error('limit', t('Value can be maximum !dodge_max_log_size', array('!dodge_max_log_size' => variable_get('dodge_max_log_size', 20))));
  }
}

/**
 * Implementation of hook_block().
 */
function dodge_block($op = 'list', $delta = 0, $edit = array()) {

  $blocks = array(
    'dodge_form' =>
      array('info' => t('What\'s your current dodge?')),
    'history_of_user' =>
      array('info' => t('User\'s dodge history')),
    'history_of_current_user' =>
      array('info' => t('Your dodge history')),
    'recent_dodges' =>
      array('info' => t('Recent dodges')),
    'popular_dodges' =>
      array('info' => t('Popular dodges'))
  );

  switch ($op) {
    case 'list':
      return $blocks;

    case 'view':

      $block = array();
      $block['subject'] = $blocks[$delta]['info'];

      if ($delta == 'dodge_form') {
        $block['content'] = drupal_get_form('dodge_user_form', 'block');
      }

      if ($delta == 'popular_dodges') {
        $dodges = _dodge_popular_dodges(variable_get('dodge_block_limit_popular_dodges', DODGE_DEFAULT_MAX_BLOCK_SIZE), variable_get('dodge_block_no_dodgepopular_dodges', 1));
        if (count($dodges) > 0) {
          $block['content'] = theme('dodge_block_popular_dodges', $dodges);
        }
      }

      if ($delta == 'recent_dodges') {
        $dodges = _dodge_recent_dodges(variable_get('dodge_block_limit_recent_dodges', DODGE_DEFAULT_MAX_BLOCK_SIZE), variable_get('dodge_block_no_dodgerecent_dodges', 1));
        if (count($dodges) > 0) {
          $block['content'] = theme('dodge_block_recent_dodges', $dodges);
        }
      }

      if ($delta == 'history_of_user') {
        global $user;
        if (strpos($_GET['q'], 'user') !== FALSE && is_numeric(arg(1)) && $user->uid != arg(1)) {
          $page_user = user_load(array('uid' => arg(1)));
          $dodges = _dodge_history_of_user(arg(1), variable_get('dodge_block_limit_history_of_user', DODGE_DEFAULT_MAX_BLOCK_SIZE), variable_get('dodge_block_no_dodgehistory_of_user', 1));
          $block['title'] = t('!user\'s dodge history', array('!user' => $page_user->name));
          if (count($dodges) > 0) {
            $block['content'] = theme('dodge_block_history_of_user', $dodges, $page_user);
          }
        }
      }

      if ($delta == 'history_of_current_user') {
        global $user;
        if ($user->uid != 0) {
          $dodges = _dodge_history_of_user($user->uid, variable_get('dodge_block_limit_history_of_current_user', DODGE_DEFAULT_MAX_BLOCK_SIZE), variable_get('dodge_block_no_dodgehistory_of_current_user', 1));
          $block['content'] = theme('dodge_block_history_of_current_user', $dodges);
        }
      }
      if (!isset($block['content'])) return;
        return $block;

    case 'configure':
      if ($delta == 'recent_dodges' || $delta == 'history_of_user' || $delta == 'history_of_current_user' || $delta == 'popular_dodges') {
        $form = array();
        $form['#validate'] = array('dodge_block_admin_configure_validate' => array());
        $form['limit'] = array(
          '#type' => 'textfield',
          '#title' => t('Number of dodges to display'),
          '#size' => 4,
          '#description' => t('Up to this many dodges will be displayed in the block.'),
          '#default_value' => variable_get('dodge_block_limit_'. $delta, 5),
        );
        $form['show_no_dodge'] = array(
          '#type' => 'checkbox',
          '#title' => t('Show \'No dodge at this moment.\''),
          '#description' => t('Should the \'No dodge at this moment.\' state be displayed in this block?'),
          '#default_value' => variable_get('dodge_block_no_dodge'. $delta, 1),
        );
        $form['show_all_dodges'] = array(
          '#type' => 'checkbox',
          '#title' => t('Show \'Show all dodges.\''),
          '#description' => t('Should the \'Show all dodges.\' state be displayed in this block?'),
          '#default_value' => variable_get('dodge_block_all_dodges'. $delta, 1),
        );
        return $form;
      }

    case 'save':
      if ($delta == 'recent_dodges' || $delta == 'history_of_user' || $delta == 'history_of_current_user' || $delta == 'popular_dodges') {
        variable_set('dodge_block_limit_'. $delta, $edit['limit']);
        variable_set('dodge_block_no_dodge'. $delta, $edit['show_no_dodge']);
        variable_set('dodge_block_all_dodges'. $delta, $edit['show_all_dodges']);
      }
      break;

    default:
      break;
  }
}

function _dodge_get_forced_dodge_options() {
  $options = array();
  $options[0] = t('No dodge at this moment.');
  if (variable_get('dodge_allow_free_dodge', 1)) {
    $options[1] = t('I wanna pick my own dodge.');
  }
  $custom = _dodge_get_forced_dodge_custom_options();
  foreach ($custom as $key => $option) {
    $options[$key] = $option;
  }
  return $options;
}

function _dodge_get_forced_dodge_custom_options() {
  $options = array();
  $query = db_query('SELECT did, dodge FROM {dodge_options}');
  while ($option = db_fetch_object($query)) {
    $options[$option->did] = $option->dodge;
  }
  return $options;
}

/**
 * Get the current dodge for a specific user.
 *
 * @param $uid
 *   The user id of the user the dodge is requested for.
 * @return
 *   Object with uid, dodge, forced_dodge, free_dodge if dodge is available. NULL if no dodge is available.
 */
function _dodge_get_dodge($uid) {
  $sql = 'SELECT uid, dodge, forced_dodge, free_dodge FROM {dodge} WHERE uid = %d AND age = 0';
  $result = db_query($sql, $uid);
  if ($result) {
    return db_fetch_object($result, $uid);
  }
  return NULL;
}

/**
 * Implementation of hook_user().
 */
function dodge_user($op, &$edit, &$edituser, $category = null) {
  global $user;
  
    if($op == 'view') {
      $dodges = _dodge_history_of_user(arg(1), variable_get('dodge_block_limit_history_of_user', DODGE_DEFAULT_MAX_BLOCK_SIZE), variable_get('dodge_block_no_dodgehistory_of_user', 1));
      $display_user = user_load(array('uid'=>arg(1)));
      $items['dodge'] = array(
        'value' => theme('dodge_user_view', $dodges, $display_user),
        'class' => 'dodge',
      );

      return array(t('Dodge history') => $items);
    }
  if (user_access('can dodge') && $edituser->uid == $user->uid) {
    if ($op == 'categories') {
      $data = array();
      $data[] = array(
        'name' => 'dodge',
        'title' => t('Dodge'),
        'weight' => '1'
        );
      return $data;
    }

    /* if ($category == 'account') {
      switch($op) {
        case 'form':
        //$options = _dodge_get_forced_dodge_options();
        $form = array();
        $form['dodge'] = array('#type' => 'fieldset',
        '#title' => t('Dodge'),
        '#collapsible' => TRUE,
        '#collapsed' => TRUE,
        );
        $form['dodge']['show_block_history_of_user'] = array('#type' => 'checkbox',
        '#title' => t('Show my dodge history to others'),
        '#default_value' => TRUE,//$edituser->forced_dodge,
        '#description' => t('This block shows other users your latest dodges.'),
        '#default_value' => $edituser->show_block_history_of_user,
        );
        $form['dodge']['show_block_get_log_by_currentuser'] = array('#type' => 'checkbox',
        '#title' => t('Show me my user history on every page'),
        '#default_value' => TRUE,//$edituser->forced_dodge,
        '#description' => t('This block shows your latest dodge dodges.'),
        '#default_value' => $edituser->show_block_get_log_by_currentuser,
        );
        return $form;

      }
      }*/
    if ($category == 'dodge') {
      $user_dodge = _dodge_get_dodge($edituser->uid);

      switch ($op) {
        case 'after_update':
          unset($edituser->dodge);
          unset($edituser->free_dodge);
          unset($edituser->forced_dodge);
          user_save($edituser);
          break;
        case 'submit':
          _dodge_submit($user_dodge, $edit, $edituser);

          break;

          case 'validate':
            _dodge_validate($edit);
            break;

          case 'form':
            return dodge_user_form('user');

          case 'delete':
            _dodge_delete_user_history($edituser->uid, FALSE);
            break;

        }
      }
    }
  }
  
function _dodge_submit($user_dodge, $edit, $edituser) {
  
    if (!($user_dodge->free_dodge == $edit['free_dodge'] && $user_dodge->forced_dodge == $edit['forced_dodge'])) {
      $options = _dodge_get_forced_dodge_options();
      $edit['dodge'] = $options[0];

      if (strtolower($options[0]) == strtolower(trim($edit['free_dodge']))) {
        $edit['forced_dodge'] = 0;
        $edit['free_dodge'] = '';
      }
      if (strtolower($options[1]) == strtolower(trim($edit['free_dodge']))) {
        $edit['forced_dodge'] = 1;
      }
      foreach ($options as $key => $option) {
        if (strtolower($option) == strtolower(trim($edit['free_dodge']))) {
          $edit['forced_dodge'] = $key;
        }
      }

      if (isset($edit['forced_dodge']) && $edit['forced_dodge'] != 1 && $edit['forced_dodge'] != 0) {

        $edit['dodge'] = $options[$edit['forced_dodge']];
        $edit['free_dodge'] = '';
      }
      else if (isset($edit['free_dodge']) && $edit['forced_dodge'] == 1 && trim($edit['free_dodge']) != '') {
        $edit['dodge'] = $edit['free_dodge'];
      }
      else if ($edit['forced_dodge'] == 0) {
        $edit['free_dodge'] = '';
      }

      _dodge_log_dodge($edituser->uid, $edit['dodge'], $edit['free_dodge'], $edit['forced_dodge']);
      drupal_set_message(t('Your current dodge state has been succesfully set to %state.', array('%state'=>$edit['dodge'])));
    }
}

function _dodge_validate($edit) {
  if ($edit['forced_dodge'] == 1 && trim($edit['free_dodge']) == '') {
    form_set_error('free_dodge', t('This field can not be empty. Please specify a dodge or choose one from the list.'));
  } 
}

function dodge_user_form_validate($form_id, $form_values) {
  _dodge_validate($form_values);
}

function dodge_user_form_submit($form_id, $form_values) {
  global $user;
  $user_dodge = _dodge_get_dodge($user->uid);
  _dodge_submit($user_dodge, $form_values, $user);
}

/**
 * Get a drupal form for specifying a new dodge.
 * @ingroup forms
 *
 * @param $type
 *   'block' if the form is for a block. 'user' if it is a user edit form.
 * @return
 *   Drupal form for specifying a new dodge.
 * @see dodge_preset_edit_validate()
 * @see dodge_preset_edit_submit()
 */
function dodge_user_form($type) {
  $options = _dodge_get_forced_dodge_options();
  $form = array();
  $form['forced_dodge'] = array('#type' => 'select',
    '#title' => t('Choose a dodge'),
    '#default_value' => $user_dodge->forced_dodge,
    '#options' => $options,
    '#description' => t('By specifying a dodge, you let other users know what you do, how you feel,... If your dodge is not in this list, choose !pick_my_own_dodge and fill in the field below.', array('!pick_my_own_dodge' => t('I wanna pick my own dodge'))),
  );
  if (variable_get('dodge_allow_free_dodge', 1)) {
    $form['free_dodge'] = array(
      '#prefix' => '<div id="field_free_dodge">',
      '#suffix' => '</div>',
      '#type' => 'textfield',
      '#title' => t('Or type your own dodge dodge'),
      '#maxlength' => DODGE_MAX_DODGE_LENGTH,
      '#autocomplete_path' => 'dodge/autocomplete',
      '#description' => t('The value of this field is only used when you select !pick_my_own_dodge as your dodge in the field !choose_a_dodge', array('!pick_my_own_dodge' => t('I wanna pick my own dodge'), '!choose_a_dodge' => t('Choose a dodge'))),
      '#default_value' => $user_dodge->free_dodge,
    );
    if($type == 'block') {
      $form['free_dodge']['#size'] = 20;
    }
    drupal_add_js(
      'if (Drupal.jsEnabled) {
        $(document).ready(function() {
          if ($("#edit-forced-dodge").val() != 1) {
            $("#field_free_dodge").hide();
          }
          //var oldvalue = $("#edit-forced-dodge").val();
          $("#edit-forced-dodge").change(

            function() {
              if ($("#edit-forced-dodge").val() == 1) {
                $("#field_free_dodge").show("normal");
              }
              else if (!$("#field_free_dodge").is(":hidden")) {
                $("#field_free_dodge").hide("normal");
              }
              //oldvalue = $("#edit-forced-dodge").val();
            }
          );
        });
      }',
      'inline'
    );
  }
  if ($type == 'block') {
  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Submit')
  );

  }
  return $form;
}

/**
 * Get a list of the most popular dodges.
 *
 * @param $total
 *   'block' if the form is for a block. 'user' if it is a user edit form.
 * @param $show_no_dodge
 *   Boolean to specify if the dodges that are 'No dodge at this moment.' should be included.
 * @return
 *   Array of dodges. The dodge is represented as an object with the fields dodge and count.
 */
function _dodge_popular_dodges($total, $show_no_dodge) {
  if (!$show_no_dodge) {
    $filter = 'AND d.forced_dodge <> 0 ';
  }
  $sql = 'SELECT d.dodge, count(d.uid) as count FROM {dodge} d INNER JOIN {users} u ON u.uid = d.uid WHERE d.age = 0 AND u.status = 1 '. $filter .' GROUP BY d.dodge ORDER BY count(d.uid), min(d.time) DESC';
  $result = db_query_range($sql, 0, $total);
  $dodges = array();
  while ($row = db_fetch_object($result)) {
    $dodges[] = $row;
  }
  return $dodges;
}

/**
 * Get a list of the most recent dodges.
 *
 * @param $total
 *   'block' if the form is for a block. 'user' if it is a user edit form.
 * @param $show_no_dodge
 *   Boolean to specify if the dodges that are 'No dodge at this moment.' should be included.
 * @return
 *   Array of dodges. The dodge is represented as an object with the fields dodge and count.
 */
function _dodge_recent_dodges($total, $show_no_dodge) {
  if (!$show_no_dodge) {
    $filter = 'AND d.forced_dodge <> 0 ';
  }
  $sql = 'SELECT d.uid, u.name, d.dodge, d.time FROM {dodge} d INNER JOIN {users} u ON u.uid = d.uid WHERE d.age = 0 AND u.status = 1  '. $filter .'ORDER BY time DESC';
  $result = db_query_range($sql, 0, $total);
  $dodges = array();
  while ($row = db_fetch_object($result)) {
    $dodges[] = $row;
  }
  return $dodges;
}

/**
 * Get a list of the most recent dodges of a specfic user.
 *
 * @param $uid
 *   The user id of the user the dodges are requested for.
 * @param $total
 *   'block' if the form is for a block. 'user' if it is a user edit form.
 * @param $show_no_dodge
 *   Boolean to specify if the dodges that are 'No dodge at this moment.' should be included.
 * @return
 *   Array of dodges. The dodge is represented as an object with the fields dodge and count.
 */
function _dodge_history_of_user($uid, $total, $show_no_dodge) {
  if (!$show_no_dodge) {
    $filter = 'AND d.forced_dodge <> 0 ';
  }
  $sql = 'SELECT d.uid, u.name, d.dodge, d.time FROM {dodge} d INNER JOIN {users} u ON u.uid = d.uid WHERE u.uid = %d '. $filter .'ORDER BY time DESC';
  $result = db_query_range($sql, $uid, 0, $total);
  $dodges = array();
  while ($row = db_fetch_object($result)) {
    $dodges[] = $row;
  }
  return $dodges;
}

/**
 * Delete the dodge history for a specific user.
 *
 * @param $uid
 *   The user id of the action is requested for.
 */
function _dodge_delete_user_history($uid) {
  $sql = 'DELETE FROM {dodge} WHERE uid = %d';
  db_query($sql);
}

/**
 * Add a new dodge for a specific user.
 *
 * @param $uid
 *   The user id of the action is requested for.
 * @param $dodge
 *   The resulting.
 * @param $free_dodge
 *   The original free dodge if the current dodge is a free dodge. Empty if not.
 * @param $forced_dodge
 *   The forced dodge id. 0 for no dodge, 1 for free dodge, above 1 for admin defined dodges.
 */
function _dodge_log_dodge($uid, $dodge, $free_dodge, $forced_dodge) {
  $sql = 'UPDATE {dodge} SET age = age + 1 WHERE uid = %d';
  db_query($sql, $uid);

  $sql = 'INSERT INTO {dodge} (uid, dodge, free_dodge, forced_dodge, age, time) values (%d, \'%s\', \'%s\', %d, %d, %d)';
  db_query($sql, $uid, $dodge, $free_dodge, $forced_dodge, 0, time());

  if (variable_get('dodge_max_log_size', 20) > 0) {
    $sql = 'DELETE FROM {dodge} WHERE age > %d';
    db_query($sql, variable_get('dodge_max_log_size', 20));
  }
}

function dodge_browse() {
  if (arg(2) == '' || !user_access('access user profiles')) {
    drupal_not_found();
  }
  // Extract the affected users:
  $result = pager_query("SELECT u.uid, u.access FROM {users} u INNER JOIN {dodge} d ON u.uid = d.uid WHERE d.dodge = '%s' AND d.age = 0 AND u.access <> 0 AND u.status <> 0 ORDER BY u.access DESC", 20, 0, NULL, arg(2));
  
  $users = array();
  while ($account = db_fetch_object($result)) {
    $users[] = $account->uid;
  }

  return theme('dodge_browse', $users);
}

function theme_dodge_browse($users) {
  if(module_exists('profile')) {
    $fields = array();
    $result_fields = db_query('SELECT name, title, type, weight, page FROM {profile_fields} WHERE visibility = %d ORDER BY weight', 3);
    while ($record = db_fetch_object($result_fields)) {
      $fields[] = $record;
    }

    $output = '<div id="profile">';
    foreach($users as $user) {
      $account = user_load(array('uid' => $user));
      $profile = _profile_update_user_fields($fields, $account);
      $output .= theme('profile_listing', $account, $profile);
    }

    $output .= '</div>';
  } else {
    $items = array();
    foreach($users as $user) {
      $account = user_load(array('uid' => $user));
      $items[] = l($account->name, 'user/'.$account->uid);
    }
    $output .= theme('item_list', $items);
  }
  
  $output .= theme('pager', NULL, 20);
  
  $title = t('People having dodge %title',  array('%title' => arg(2)));
  drupal_set_title($title);
  
  return $output;
}

/**
 * Validate a form field to make sure it's a number.
 *
 * @param $field
 *   The field to be validated.
 */
function _dodge_number_validate($field) {
  if (!empty($field['#value']) && !is_numeric($field['#value'])) {
    form_error($field, t('The value for %field must be a number.', array('%field' => $field['#title'])));
  }
}