modules/wowroster/wowroster.module

<?php
/**
 * $Id: wowroster.module,v 1.2 2006/11/27 16:52:26 mosh Exp $
 */


/**
 * Display help and module information
 * @param section which section of the site we're displaying help 
 * @return help text for section
 */
function wowroster_help($section='') {
  $output = '';

  switch ($section) {
    case "admin/modules#description":
    case "admin/help#wowroster":
      $output = t("Allows the retrieval and display of some information from your WoWRoster.");
      break;
  }

  return $output;
}
/** END: function wowroster_help **********************************************/


/**
 * Valid permissions for wowroster
 * @return An array of valid permissions for the wowroster module
 */
function wowroster_perm() {
  return array('administer wowroster', 'view wowroster');
}
/** END: function wowroster_perm **********************************************/


/**
 * Implementation of hook_menu().
 * @return array of menu items
 */
function wowroster_menu($may_cache) {
  $items   = array();
  if ($may_cache) {
    // wowroster_iframe
    $items[] = array(
      'path' => 'wowroster_iframe',
      'title' => t('WoWRoster'),
      'callback' => 'wowroster_iframe',
      'access' => user_access('view wowroster'),
      'type' => MENU_NORMAL_ITEM,
    );
    // simpleroster
    $items[] = array(
      'path' => 'wowroster',
      'title' => t('complete roster'),
      'callback' => 'wowroster_simpleroster',
      'access' => user_access('view wowroster'),
      'type' => MENU_CALLBACK,
    );
    // profile
    $items[] = array(
      'path' => 'wowroster/profile',
      'callback' => 'wowroster_player',
      'access' => user_access('view wowroster'),
      'type' => MENU_CALLBACK,
    );
    // installer
    $items[] = array(
      'path' => 'admin/wowroster/installer',
      'title' => t('WoWRoster Installer'),
      'callback' => 'wowroster_installer',
      'access' => user_access('access administration pages'),
      'access' => user_access('administer wowroster'),
      'type' => MENU_NORMAL_ITEM,
    );
  } else {
    // user/uid/wowroster/profile
    if (arg(0) == 'user' && is_numeric(arg(1))) {
      include_once('wowroster.inc');

      // determine if the current drupal-user has a drupal_char-text-field
      // corresponding to a valid wow player
      $roster_id = _wowroster_drupaluser_to_wowplayer();

      if (is_numeric($roster_id)) {
        $items[] = array(
          'path' => 'user/'. arg(1) .'/wowroster/profile',
          'title' => t('WoWRoster Profiles'),
          'callback' => 'wowroster_player',
          'callback arguments' => array($roster_id),
          'access' => $access,
          'type' => MENU_LOCAL_TASK,
          'weight' => -1,
        );
      }
    }
  }
  return $items;
}
/** END: function wowroster_menu **********************************************/


/**
 * Module configuration settings
 * @return settings HTML or deny access
 */
function wowroster_settings() {
  include_once('wowroster.inc');
  // only administrators can access this function
  if (!user_access('administer wowroster')) {
  return drupal_set_message(t('access denied'));
  }

  // settings_roster
  $form['settings_roster'] = array(
    '#type' => 'fieldset',
    '#title' => t('Roster Information'),
    '#collapsible' => TRUE,
  );
    $form['settings_roster']['wowroster_roster_tableprefix'] = array(
      '#type' => 'textfield',
      '#title' => t("WoWRosters table prefix"),
      '#default_value' => variable_get('wowroster_roster_tableprefix', ''),
      '#description' => t("The table prefix for WoWRoster. Include the trailing underscore. ex: roster_"),
      '#size' => '15',
    );

	// settings_simpleroster
  $form['settings_simpleroster'] = array(
    '#type' => 'fieldset',
    '#title' => t("Simple Roster Options"),
    '#collapsible' => TRUE,
  );
    $form['settings_simpleroster']['wowroster_simpleroster_max'] = array(
      '#type' => 'textfield',
      '#title' => t("Maximum members per page"),
      '#default_value' => variable_get('wowroster_simpleroster_max', 25),
      '#description' => t("The maxmimum users that will be displayed on each page"),
      '#size' => '3',
    );

  // settings_roster_profiles
	$form['settings_roster_profiles'] = array(
    '#type' => 'fieldset',
    '#title' => t("Roster Profiles"),
    '#collapsible' => TRUE,
  );
    $profile_fields = _drupal_get_profile_fields();
    if (is_array($profile_fields)) {
      array_unshift($profile_fields, t('Drupal-User'));
    } else {
      $profile_fields = array(t('Drupal-User'));
    }
    $form['settings_roster_profiles']['drupal_char-text_field'] = array(
      '#type' => 'select', 
      '#title' => t("drupal-profile-field to associate with wow-charname"),
      '#default_value' => variable_get('drupal_char-text_field', t('Drupal-User')), 
      '#options' => $profile_fields, 
      '#description' => '',
    );
    $form['settings_roster_profiles']['wowroster_main-text_search'] = array(
      '#type' => 'textfield',
      '#title' => t("Text used to designate mainchars"),
      '#default_value' => variable_get('wowroster_main-text_search', 'Main'),
      '#description' => t("Text used to designate mainchars"),
      '#size' => '5',
    );
    $form['settings_roster_profiles']['wowroster_main-text_field'] = array(
      '#type' => 'textfield',
      '#title' => t("What field to search for main-text"),
      '#default_value' => variable_get('wowroster_main-text_field', 'note'),
      '#description' => t("What field to search for main-text"),
      '#size' => '5',
    );
    $form['settings_roster_profiles']['wowroster_alt-text_search'] = array(
      '#type' => 'textfield',
      '#title' => t("Text used to designate alts"),
      '#default_value' => variable_get('wowroster_alt-text_search', 'Twink'),
      '#description' => t("Text used to designate alts"),
      '#size' => '5',
    );
    $form['settings_roster_profiles']['wowroster_alt-text_field'] = array(
      '#type' => 'textfield',
      '#title' => t("What field to search for alt-text"),
      '#default_value' => variable_get('wowroster_alt-text_field', 'note'),
      '#description' => t("What field to search for alt-text"),
      '#size' => '5',
    );

  return $form;
}
/** END: function wowroster_settings ******************************************/


/**
 * WoWRoster Installer IFrame integration.
 */
function wowroster_installer() {
  // check if WoWRoster is marked as installed for this module
  include_once('wowroster.inc');
  if (TRUE === _wowroster_get_status()) {
    $output = t('WoWRoster seems to be properly installed.');
  } else if (!is_dir(drupal_get_path('module', 'wowroster').'/roster')) {
    drupal_set_message(t('You have to unpack WoWRoster into').' '.drupal_get_path('module', 'wowroster').'/roster', 'error');
  } else {
    $output  = "<div style='text-align:center;'>";
    $output .= t('Follow the normal WoWRoster installation process.<br />When it points you to "Remove Install Files", click on "finish WoWRoster installation".<br /><br />');
    $output .= wowroster_installer_form($form_id);
    $output .= "</div><br />";
    
    $frame  = "<iframe src=\"".url(drupal_get_path('module','wowroster'))."/roster/install.php\" width=\"100%\" height=\"600px\">";
    $frame .= "<!-- Alternate content for non-supporting browsers -->";
    $frame .= "Your browser won't work here. You'll need IE5.5+";
    $frame .= "</iframe>";
    
    $output .= $frame;
  }
  print theme("page", $output);
}

function wowroster_installer_form($form_id) {
  $form['submit'] = array('#type' => 'submit',
                          '#value' => t('finish WoWRoster installation'));
  $output = drupal_get_form('wowroster_installer_form', $form);
  return $output;
}

function wowroster_installer_form_submit($form_id,$form_values) {
  include_once('wowroster.inc');
  $roster_dir = drupal_get_path('module','wowroster')."/roster/";
  _removeDir($roster_dir."install");
  @unlink($roster_dir."install.php");
  @unlink($roster_dir."upgrade.php");
  db_query("UPDATE {wowroster_status} SET wowroster_is_installed = 1");
  drupal_goto();
}
/** END: WoWRoster Installer IFrame integtation *******************************/


/**
 * Generate HTML for the wowroster blocks
 * @param op the operation from the URL
 * @param delta offset
 * @return block HTML
 */
function wowroster_block($op='list', $delta = 0, $edit = array()) {
  include_once('wowroster.inc');

  // admin/blocks
	if ($op == 'list' && TRUE === _wowroster_get_status()) {
		$blocks[0]['info'] = t('Roster Player Listing');
		$blocks[1]['info'] = t('Roster Realm Status');
		$blocks[2]['info'] = t('Roster Richest Players');
		$blocks[3]['info'] = t('Roster Guild MOTD');
		return $blocks;

	// Roster Player Listing block configuration
	} elseif ($op == 'configure' && $delta == 0) {
	  // Configures how many members to show on the roster block
		$form['wowroster_block_rostermaxdisp'] = array(
			'#type' => 'textfield',
			'#title' => t("Number of members to display"),
			'#default_value' => variable_get('wowroster_block_rostermaxdisp', 5),
			'#description' => t("The maximum number of members to display in roster block."),
			'#maxlength' => '2',
			'#size' => '2'
		);
		 // Show only uploaded characters?
		 $form['wowroster_block_rosterdispul'] = array(
		  '#type' => 'checkbox',
		  '#title' => t("Show uploaded characters only"),
		  '#default_value' => variable_get('wowroster_block_rosterdispul', false),
		  '#description' => t("If this box is selected, only characters that have uploaded their profiles will be displayed.")
		 );
		return $form;

	// Roster Richest Players block configuration
	} elseif ($op == 'configure' && $delta == 2) {
		$form['wowroster_block_richmaxdisp'] = array(
			'#type' => 'textfield',
			'#title' => t("Number of members to display"),
			'#default_value' => variable_get('wowroster_block_richmaxdisp', 5),
			'#description' => t("The maximum number of members to display in richest players block."),
			'#maxlength' => '2',
			'#size' => '2'
		);
		$form['wowroster_block_richmondisp'] = array(
			'#type' => 'checkbox',
			'#title' => t("Show money"),
			'#default_value' => variable_get('wowroster_block_richmondisp', true),
			'#description' => t("Whether to display the members money.")
		);
		return $form;

	// Roster Guild MOTD block configuration
	} elseif ($op == 'configure' && $delta == 3) {
		$form['wowroster_block_motd_as_img'] = array(
			'#type' => 'checkbox',
			'#title' => t("Display guild MOTD as image"),
			'#default_value' => variable_get('wowroster_block_motd_as_img', true),
			'#description' => t("Display guild MOTD as image or as text.")
		);
		return $form;

	// Save Roster Player Listing block configuration
	} elseif ($op == 'save' && $delta == 0) {
		variable_set('wowroster_block_rostermaxdisp', $edit['wowroster_block_rostermaxdisp']);
		variable_set('wowroster_block_rosterdispul', $edit['wowroster_block_rosterdispul']);
		return;

	// Save Roster Richest Players block configuration
	} elseif ($op == 'save' && $delta == 2) {
		variable_set('wowroster_block_richmaxdisp', $edit['wowroster_block_richmaxdisp']);
		variable_set('wowroster_block_richmondisp', $edit['wowroster_block_richmondisp']);
		return;

	// Save Guild MOTD block configuration
	} elseif ($op == 'save' && $delta == 3) {
		variable_set('wowroster_block_motd_as_img', $edit['wowroster_block_motd_as_img']);
		return;
	}

	elseif ($op == 'view' && TRUE == user_access('view wowroster')) {
	  $roster_url = base_path() . drupal_get_path('module', 'wowroster').'/roster';
		$roster_tblpref = variable_get('wowroster_roster_tableprefix', '');
		$roster_disul = variable_get('wowroster_block_rosterdispul', false);
		switch($delta) {
			// Display a list of members in the roster
			case 0:
			$block_content = '';
			$block_limitnum = variable_get('wowroster_block_rostermaxdisp', 5);

			// Only print the uploaded characters
			if ($roster_disul) {
			  $block_content .= "<h3>Uploaded Characters</h3>";
        $query = '
          SELECT    '.$roster_tblpref.'members.member_id, 
                    '.$roster_tblpref.'members.name, 
                    '.$roster_tblpref.'members.guild_title 
          FROM      '.$roster_tblpref.'members 
          LEFT JOIN '.$roster_tblpref.'players 
          ON        '.$roster_tblpref.'members.member_id = '.$roster_tblpref.'players.member_id
          WHERE     '.$roster_tblpref.'members.member_id = '.$roster_tblpref.'players.member_id
          ORDER BY  '.$roster_tblpref.'members.name ASC';
        db_set_active('wowroster');
        $queryResult =  db_query_range($query, 1, $block_limitnum);
        db_set_active('default');

			  while ($row = db_fetch_object($queryResult)) {
			      $block_content .= _wowroster_simpleroster_link($row->name, $row->member_id). " - ".$row->guild_title. "<br />";
			  }
			}
			else {
        $query = 'SELECT    member_id, name, guild_title 
                  FROM      '.$roster_tblpref.'members 
                  ORDER BY  name ASC';
        db_set_active('wowroster');
        $queryResult =  db_query_range($query, 1, $block_limitnum);
        db_set_active('default');

			  while ($row = db_fetch_object($queryResult)) {
			    if (_wowroster_is_uploaded($row->member_id)) {
            $block_content .= _wowroster_simpleroster_link($row->name, $row->member_id). " - ".$row->guild_title. "<br />";
          } else {
			      $block_content .= $row->name."<br />";
          }
        }
			}
			if ($block_content == "") {
				$block_content .= "There are no members in the roster.";
				return;
			}

			$block_content .= "<div class=\"more-link\">".
			l(t("Full Roster"), "wowroster", array("title" => t("Full Roster")))
			."</div>";

			$block['subject'] = 'Roster Listing';
			$block['content'] = $block_content;
			break;

			// Display the realm status image
			case 1:
			$block_content .= '<div align="center"><img src="'.$roster_url.'/realmstatus.php" alt="realmstatus" /></div>';

			$block['subject'] = 'Realm Status';
			$block['content'] = $block_content;
			break;

			// Display the richest members
			case 2:
			$block_content .= '';
			$block_limitrich = variable_get("wowroster_block_richmaxdisp", 5);
			$block_displaymon = variable_get("wowroster_block_richmondisp", true);

			$query = 'SELECT member_id,name, money_c, money_s, money_g FROM '.$roster_tblpref.'players ORDER BY money_g DESC, money_s DESC, money_c DESC LIMIT '.$block_limitrich.'';
      db_set_active('wowroster');
			$queryResult = db_query($query);
      db_set_active('default');

			while ($row = db_fetch_object($queryResult)) {
				$block_content .= _wowroster_simpleroster_link($row->name, $row->member_id);

				if ($block_displaymon){
				 	$block_content .= '<br />With: ' .$row->money_g. '<img src="'.$roster_url.'/img/bagcoingold.gif" alt="" />' .$row->money_s. '<img src="'.$roster_url.'/img/bagcoinsilver.gif" alt="" />' .$row->money_c. '<img src="'.$roster_url.'/img/bagcoinbronze.gif" alt="" /><br />';
					}
				else {
					$block_content .= '<br />';
				}
			}
			if ($block_content == '') {
				$block_content .= 'There are no rich players!';
				return;
			}
			$block['subject'] = 'Top '.$block_limitrich.' Richest Players';
			$block['content'] = $block_content;
			break;

			// Display the guild motd
			case 3:
      $roster_motd_as_img = variable_get('wowroster_block_motd_as_img', TRUE);

      $path = base_path() . drupal_get_path('module', 'wowroster');
      $style = theme_stylesheet_import($path.'/wowroster.css', $media = 'all');
      drupal_set_html_head($style);

      if ($roster_motd_as_img) {
        $block_content .= '<img src="'.$roster_url.'/motd.php" alt="realmstatus" />';
      } else {
	      $roster_tblpref = variable_get('wowroster_roster_tableprefix', '');
        $query = 'SELECT guild_motd FROM '.$roster_tblpref.'guild';
        db_set_active('wowroster');
        $result = db_query($query);
        db_set_active('default');
        $motd = db_fetch_array($result);
        $block_content = "<div id='text-motd'>".$motd['guild_motd']."</div>";
      }

			$block['content'] = $block_content;
			break;


		}
		return $block;
	}
}
/** END: wowroster_block ******************************************************/


/**
 * Diplay the simple roster
 * @return simeple roster HTML
 *
 */
function wowroster_simpleroster() {
  include_once('wowroster.inc');
	$roster_url = base_path() . drupal_get_path('module', 'wowroster').'/roster';
	$roster_tblpref = variable_get('wowroster_roster_tableprefix', '');
	$page_limitnum = variable_get("wowroster_simpleroster_max", 25);

	// Query to get the list of members, and some details about them
	$query = 'SELECT member_id, name, level, class, guild_title, note FROM '.$roster_tblpref.'members';

	// Make the header array
	$header = array(
    array('data' => t('Name'), 'field' => 'name', 'sort' => 'asc'),
    array('data' => t('Level'), 'field' => 'level'),
    array('data' => t('Class'), 'field' => 'class'),
    array('data' => t('Guild Rank'), 'field' => 'guild_title'),
    array('data' => t('Note'), 'field' => 'note')
  );

  $query .= tablesort_sql($header);
  
  // Run the query with pagable results
  db_set_active('wowroster');
  $result = pager_query($query, $page_limitnum);
  db_set_active('default');


  $imgurl = $roster_url."/img/Interface/Icons";
  while ($member = db_fetch_object($result)) {

  	// Create the image depending on the class
  	switch($member->class) {
  		case 'Druid':
  		case 'Druide':
  			$classimg = "<img src='".$imgurl."/Ability_Druid_Maul.jpg' alt='[D]' width='16' height='16'> ";
  			break;
  		case 'Hunter':
  		case 'Jäger':
  			$classimg = "<img src='".$imgurl."/INV_Weapon_Bow_08.jpg' alt='[H]' width='16' height='16'> ";
  			break;
  		case 'Mage':
  		case 'Magier':
  			$classimg = "<img src='".$imgurl."/INV_Staff_13.jpg' alt='[M]' width='16' height='16'> ";
  			break;
  		case 'Paladin':
  			$classimg = "<img src='".$imgurl."/Spell_Fire_FlameTounge.jpg' alt='[P]' width='16' height='16'> ";
  			break;
  		case 'Priest':
  		case 'Priester':
  			$classimg = "<img src='".$imgurl."/Spell_Holy_LayOnHands.jpg' alt='[P]' width='16' height='16'> ";
  			break;
  		case 'Rogue':
  		case 'Schurke':
  			$classimg = "<img src='".$imgurl."/INV_ThrowingKnife_04.jpg' alt='[R]' width='16' height='16'> ";
  			break;
  		case 'Warlock':
  		case 'Hexenmeister':
  			$classimg = "<img src='".$imgurl."/Spell_Shadow_Cripple.jpg' alt='[W]' width='16' height='16'> ";
  			break;
  		case 'Warrior':
  		case 'Krieger':
  			$classimg = "<img src='".$imgurl."/INV_Sword_25.jpg' width='16' alt='[W]' height='16'> ";
  			break;
  		default:
  			$classimg = '[NA] ';
  			break;
  	}

    if (_wowroster_is_uploaded($member->member_id)) {
      $rows[] = array(_wowroster_simpleroster_link($member->name, $member->member_id), $member->level, $classimg . $member->class, $member->guild_title, $member->note);
    } else {
      $rows[] = array($member->name, $member->level, $classimg . $member->class, $member->guild_title, $member->note);
    }
  }
  
  // Output the table
  $output = theme('table', $header, $rows);
  $output .= theme('pager', NULL, $page_limitnum);
  return $output;
}
/** END: wowroster_simpleroster ***********************************************/


/**
 * WoWRoster iframe integration
 */
function wowroster_iframe() {
  $frame = "<iframe src=\"".drupal_get_path('module','wowroster')."/roster/index.php\" width=\"100%\" height=\"600px\">";
  $frame .= "<!-- Alternate content for non-supporting browsers -->";
  $frame .= "Your browser won't work here. You'll need IE5.5+";
  $frame .= "</iframe>";

  print theme("page", $frame);
}
/** END: function wowroster ***************************************************/


/**
 * Display a short description of all characters related to $memberid
 *
 * @param profile_id the profile_id of the user
 * @return player(s) HTML
 */
function wowroster_player($memberid) {
  include_once('wowroster.inc');
  // Get the variables we need
	$roster_url = base_path().drupal_get_path('module', 'wowroster').'/roster';

  $roster_tblpref     = variable_get('wowroster_roster_tableprefix', '');
  $main_text_field    = variable_get('wowroster_main-text-field',   'note');
  $main_text_search   = variable_get('wowroster_main-text-search',  'Main');
  $alt_text_field     = variable_get('wowroster_alt-text-field',    'note');
  $alt_text_search    = variable_get('wowroster_alt-text-search',   'Twink');

  // check if chartype member is main, alt or undefined
  $chartype = _wowroster_player_is_chartype($memberid);

  switch($chartype) {
    // member is main
    case 'main':
    case 'alt':
      // get main char
      $chars[$main_text_search] = _wowroster_get_main($memberid, $chartype);

      // get related twinks
      $chars[$alt_text_search] = _wowroster_get_alts($chars[$main_text_search]['name']);
      
      // DEBUG
      #echo "<pre>";print_r($chars);echo "</pre>";
      // DEBUG
      break;

    // member is undefined
    case 'undefined':
      // get only this char
      $chars[$main_text_search] = _wowroster_get_main($memberid, $chartype);
      break;
  }

  $output = theme('wowroster_player', $chars[$main_text_search], $memberid);
  if ($chartype !== 'undefined') {
    foreach ($chars[$alt_text_search] as $char) {
      $output .= theme('wowroster_player', $char, $memberid);
    }
  }

  // Output the users profiles
	return $output;
}
/** END: wowroster_player *****************************************************/


/**
 * Theme the data for one member into a fieldset
 */
function theme_wowroster_player($char, $memberid) {

  // DEBUG
  #echo "<pre>";print_r($char);echo "</pre>";
  // DEBUG

  // Generate the user profile
  $table = "
    <table summary='' width='100%' border='1' cellspacing='0' cellpadding='4'>
    <tr>
      <td width='155'>".t('Character Description:')." </td>
      <td>".$char['RankName']." ".$char['name']." ".t('is a level')." ".$char['level']." ".$char['sex']." ".$char['race']." ".$char['class'].".</td>
    </tr>
    <tr>
      <td>Character Details: </td>
      <td></td>
		</tr>
    </table>";

  $collapsed = ($memberid == $char['member_id']) ? FALSE : TRUE;

  $output .= theme(
    'fieldset',
    array('#title' => $char['name'],
          '#collapsible' => TRUE,
          '#collapsed' => $collapsed,
          '#children' => $table)
  );

  return $output;
}
/** END: theme_wowroster_player ***********************************************/