/******************************************************************************
    * Document - Primary document in an MVC model 
    * $Id$
    * 
    * BuckoFIBS - Backgammon by BuckoSoft
    * Copyright© 2009,2010 - Dick Balaska - BuckoSoft, Corp.
    * 
    * $Log$
    * Revision 1.4  2011/06/02 12:36:46  dick
   * Javadoc.
   *
   */
  
  /* 
   * This program is free software: you can redistribute it and/or modify
   * it under the terms of the GNU General Public License as published by
   * the Free Software Foundation, either version 3 of the License, or
   * (at your option) any later version.
   *
   * This program is distributed in the hope that it will be useful,
   * but WITHOUT ANY WARRANTY; without even the implied warranty of
   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   * GNU General Public License for more details.
   *
   * You should have received a copy of the GNU General Public License
   * along with this program.  If not, see <http://www.gnu.org/licenses/>.
   *
   * The Original Code is BuckoFIBS, <http://www.buckosoft.com/BuckoFIBS/>.
   * The Initial Developer of the Original Code is Dick Balaska and BuckoSoft, Corp.
   * 
   */
  package com.buckosoft.fibs.document;
  
  import java.util.LinkedList;
  
  import com.buckosoft.fibs.domain.Board;
  import com.buckosoft.fibs.domain.SavedMatch;
  
  /** Primary document in an MVC model 
   * @author Dick Balaska
   * @since 2011/03/14
   * @version $Revision$ <br> $Date$
   * @see <a href="http://cvs.buckosoft.com/Projects/BuckoFIBS/BuckoFIBS/src/main/java/com/buckosoft/fibs/document/Document.java">cvs Document.java</a>
   * @see <a href="http://www.fibs.com/fibs_interface.html#board_state" target="_top">FIBS Client Protocol Detailed Specification</a>
   */
  public class Document {
  	//private final static boolean DEBUG = false;
  
  	// These are user settings 
  	// They are game settings.
  	private	String	name = "?";
  	private boolean allowPip;
  	private	boolean autoBoard;
  	private	boolean autoDouble;
  	private boolean autoMove;
  	private	boolean	away;
  	private	boolean bell;
  	private boolean crawford;
  	private	boolean	askDouble;
  	private	int		experience;
  	private	boolean greedy;
  	private	boolean moreBoards;
  	private	boolean moves;
  	private	boolean notify;
  	private	double	rating;
  	private	boolean ratings;
  	private	boolean ready;
  	private	int		redoubles;
  	private	boolean	report;
  	private	boolean	silent;
  	private	String	timezone;
  	
  	private	Board	board = new Board();
  	private	LinkedList<SavedMatch>	savedMatches = new LinkedList<SavedMatch>();
  	// Reuse SavedMatch Object
  	private	LinkedList<SavedMatch>	missManners = new LinkedList<SavedMatch>();
  
  	
  	/** Get the Board.  This is the latest board we have received from FIBS
  	 * @return the board
  	 */
  	public Board getBoard() {
  		return board;
  	}
  
  	/**
  	 * @param board the board to set
  	 */
  	public void setBoard(Board board) {
  		this.board = board;
  	}
  
  	/** Called at the beginning of a game, resets game user attributes
  	 */
  	public void resetGame() {
  		this.greedy = false;
  		this.askDouble = true;
  	//	this.wasDoubled[0] = false;
  	//	this.wasDoubled[1] = false;
 		this.board.setYourTurnToRollOrDouble(false);
 	}
 
 	/** Set and clear the state where You push a double to Your opponent.
 	 * @param doubleFlag true = you have doubled
 	 */ 
 	public void setYouDouble(boolean doubleFlag) {
 		this.board.setYourTurnToRollOrDouble(false);
 	//	this.wasDoubled[0] = doubleFlag;
 	}
 
 	/** Return the userid that this player logged in as.
 	 * @return the name
 	 */
 	public String getName() {
 		return name;
 	}
 
 	/**
 	 * @return the allowPip
 	 */
 	public boolean isAllowPip() {
 		return allowPip;
 	}
 
 	/**
 	 * @return the autoBoard
 	 */
 	public boolean isAutoBoard() {
 		return autoBoard;
 	}
 
 	/**
 	 * @param autoBoard the autoBoard to set
 	 */
 	public void setAutoBoard(boolean autoBoard) {
 		this.autoBoard = autoBoard;
 	}
 
 	/**
 	 * @return the autoDouble
 	 */
 	public boolean isAutoDouble() {
 		return autoDouble;
 	}
 
 	/**
 	 * @return the autoMove
 	 */
 	public boolean isAutoMove() {
 		return autoMove;
 	}
 
 	/** Have You tagged yourself as away?
 	 * @return true if You are not accepting invitations
 	 */
 	public boolean isAway() {
 		return away;
 	}
 
 	/** Like, totally ignored.
 	 * @return the bell
 	 */
 	public boolean isBell() {
 		return bell;
 	}
 
 	/** Is this a crawford game?
 	 * @return the crawford
 	 */
 	public boolean isCrawford() {
 		return crawford;
 	}
 
 	/** Does the server push dice at you or wait to see if you want to roll or double
 	 * @return the askDouble
 	 */
 	public boolean isAskDouble() {
 		return this.askDouble;
 	}
 
 	public void setAskDouble(boolean askDoubles) {
 		this.askDouble = askDoubles;
 	}
 
 	/** How many games have You played?
 	 * @return the experience
 	 */
 	public int getExperience() {
 		return experience;
 	}
 
 	/** Are You using greedy bearoffs?
 	 * @return the greedy
 	 */
 	public boolean isGreedy() {
 		return greedy;
 	}
 
 	public void setGreedy(boolean greedy) {
 		this.greedy = greedy;
 	}
 
 	/** This is pretty darn useful for client programs, so if you see it toggled off you probably want to toggle it back on.
 	 * @return the moreBoards
 	 */
 	public boolean isMoreBoards() {
 		return moreBoards;
 	}
 
 	/**
 	 * @return the moves
 	 */
 	public boolean isMoves() {
 		return moves;
 	}
 
 	/** Are we being notified when new users log on and off?
 	 * @return the notify
 	 */
 	public boolean isNotify() {
 		return notify;
 	}
 
 	/** What is Your FIBS rating?
 	 * @return the rating
 	 */
 	public double getRating() {
 		return rating;
 	}
 
 	/**
 	 * @return the ratings
 	 */
 	public boolean isRatings() {
 		return ratings;
 	}
 
 	/** Are you ready to play?
 	 * @return the ready
 	 */
 	public boolean isReady() {
 		return ready;
 	}
 
 	/** Set whether we are ready to play
 	 * @param ready the ready to set
 	 */
 	public void setReady(boolean ready) {
 		this.ready = ready;
 	}
 
 	/** Je ne comprends pas
 	 * @return the redoubles
 	 */
 	public int getRedoubles() {
 		return redoubles;
 	}
 
 	/** Are we being notified about the starting and ending of other matches? 
 	 * @return the report
 	 */
 	public boolean isReport() {
 		return report;
 	}
 
 	/** Do we receive the shout messages (general chat)?<br>
 	 * Note that BuckoFIBS always receives the shouts and filters them from display.
 	 * @return the silent
 	 */
 	public boolean isSilent() {
 		return silent;
 	}
 
 	/** Get your timezone.
 	 * @return the timezone
 	 */
 	public String getTimezone() {
 		return timezone;
 	}
 
 
 	/** If you have a saved match against this player, this is a tooltip string describing it.
 	 * @param playerName The player to check for saved matches.
 	 * @return A tooltip String or null if no saved match found
 	 */ 
 	public String	getSavedMatchString(String playerName) {
 		for (SavedMatch sm : savedMatches) {
 			if (sm.getOpponentName().equals(playerName)) {
 				StringBuffer sb = new StringBuffer();
 				sb.append("Saved Match. Length: ");
 				sb.append(sm.getMatchLength());
 				sb.append(" Score: (you) ");
 				sb.append(sm.getYourScore());
 				sb.append(" - (");
 				sb.append(sm.getOpponentName());
 				sb.append(") ");
 				sb.append(sm.getOpponentScore());
 				return(sb.toString());
 			}
 		}
 		return(null);
 	}
 
 	/** Parse a saved match line from FIBS.
 	 * Store the match in our local list and return it
 	 * @param s The string
 	 * @return The parsed SavedMatch
 	 */
 	public SavedMatch parseSavedMatch(String s) {
 		try {
 			String[] ss = s.split(" +");
 			SavedMatch sm = new SavedMatch();
 			if (ss[0].startsWith("**")) {
 				sm.setOpponentName(ss[0].substring(2));
 				sm.setMatchLength(Integer.parseInt(ss[1]));
 				sm.setYourScore(Integer.parseInt(ss[2]));
 				sm.setOpponentScore(Integer.parseInt(ss[4]));				
 			} else if (ss[1].startsWith("*")){
 				sm.setOpponentName(ss[1].substring(1));
 				sm.setMatchLength(Integer.parseInt(ss[2]));
 				sm.setYourScore(Integer.parseInt(ss[3]));
 				sm.setOpponentScore(Integer.parseInt(ss[5]));
 			} else {
 				sm.setOpponentName(ss[1]);
 				sm.setMatchLength(Integer.parseInt(ss[2]));
 				sm.setYourScore(Integer.parseInt(ss[3]));
 				sm.setOpponentScore(Integer.parseInt(ss[5]));
 			}
 			this.savedMatches.add(sm);
 			return(sm);
 		} catch (Exception ex) {
 			throw new RuntimeException("Failed to parseSavedMatch '" + s + "'", ex);
 		}
 	}
 
 
 	/** Remove a player from the savedMatches list.
 	 * Call this after completing any match.
 	 * @param playerName The name of the player you just finished a match with.
 	 */
 	public void removeSavedMatch(String playerName) {
 		for (SavedMatch sm : savedMatches) {
 			if (sm.getOpponentName().equals(playerName)) {
 				savedMatches.remove(sm);
 				break;
 			}	
 		}
 	}
 
 	/** If MissManners issued a warning about a player, this is a tooltip string describing it.
 	 * @param playerName The player to check for a MissManners warning.
 	 * @return A tooltip String or null if no warning found
 	 */
 	public String	getMissMannersString(String playerName) {
 		for (SavedMatch sm : missManners) {
 			if (sm.getOpponentName().equals(playerName)) {
 				StringBuffer sb = new StringBuffer();
 				sb.append("MissManners warns: ");
 				sb.append(playerName);
 				sb.append(" has ");
 				sb.append(sm.getMatchLength());
 				sb.append(" saved games");
 				return(sb.toString());
 			}
 		}
 		return(null);
 	}
 
 	/** Parse a MissManners warning line from FIBS.
 	 * Store the warning in our local list and return it
 	 * @param s The string
 	 * @return The parsed SavedMatch
 	 */
 	public SavedMatch parseMissManners(String s) {
 		try {
 			String[] ss = s.split(" +");
 			if (!ss[1].equals("MissManners"))
 				return(null);
 			SavedMatch sm = new SavedMatch();
 			sm.setOpponentName(ss[4]);
 			sm.setMatchLength(Integer.parseInt(ss[6]));
 			this.missManners.add(sm);
 			return(sm);
 		} catch (Exception ex) {
 			throw new RuntimeException("Failed to parseMissManners '" + s + "'", ex);
 		}
 	}
 	
 	/** Parse the Own Info command from FIBS.
 	 * @param s The Own Info line received from FIBS
 	 * @see <a href="http://www.fibs.com/fibs_interface.html#clip_own_info" target="_top">FIBS Client Protocol Detailed Specification</a>
 	 * <pre>
 	 * 0 1    2        3         4          5        6    7    8        9      10         11     12         13    14     15     16      17    18        19     20     21
 	 * 2 name allowpip autoboard autodouble automove away bell crawford double experience greedy moreboards moves notify rating ratings ready redoubles report silent timezone
 	 * 2 myself 1 1 0 0 0 0 1 1 2396 0 1 0 1 3457.85 0 0 0 0 0 Australia/Melbourne
 	 * </pre>
 	 */
 	public void parseOwnInfo(String s) {
 		String[] t = s.split(" ");
 		this.name		= t[1];
 		this.allowPip	= Integer.parseInt(t[2]) == 1 ? true : false;
 		this.autoBoard	= Integer.parseInt(t[3]) == 1 ? true : false;
 		this.autoDouble	= Integer.parseInt(t[4]) == 1 ? true : false;
 		this.autoMove	= Integer.parseInt(t[5]) == 1 ? true : false;
 		this.away		= Integer.parseInt(t[6]) == 1 ? true : false;
 		this.bell		= Integer.parseInt(t[7]) == 1 ? true : false;
 		this.crawford	= Integer.parseInt(t[8]) == 1 ? true : false;
 		this.askDouble	= Integer.parseInt(t[9]) == 1 ? true : false;
 		this.experience = Integer.parseInt(t[10]);
 		this.greedy		= Integer.parseInt(t[11]) == 1 ? true : false;
 		this.moreBoards	= Integer.parseInt(t[12]) == 1 ? true : false;
 		this.moves		= Integer.parseInt(t[13]) == 1 ? true : false;
 		this.notify		= Integer.parseInt(t[14]) == 1 ? true : false;
 		this.rating		= Double.parseDouble(t[15]);
 		this.ratings	= Integer.parseInt(t[16]) == 1 ? true : false;
 		this.ready		= Integer.parseInt(t[17]) == 1 ? true : false;
 		this.redoubles	= t[18].equals("unlimited") ? -1 : Integer.parseInt(t[19]);
 		this.report		= Integer.parseInt(t[19]) == 1 ? true : false;
 		this.silent		= Integer.parseInt(t[20]) == 1 ? true : false;
 		this.timezone	= t[21];
 	}
 
 }