/******************************************************************************
    * User.java - Extend BSAccountUser with BuckoVidLib specific attributes
    * $Id: User.java,v 1.8 2015/05/10 19:03:31 dick Exp $
    * 
    * BuckoVidLib - The BuckoSoft Video Library
    * Copyright(c) 2015 - Dick Balaska
    * 
    * $Log: User.java,v $
    * Revision 1.8  2015/05/10 19:03:31  dick
   * Let's see if add a default to the switch will cover all the branches of it.
   *
   * Revision 1.7  2015/05/07 00:15:38  dick
   * findMaxResults is a user config option.
   *
   * Revision 1.6  2015/05/06 03:36:53  dick
   * hideRestricted allows a user with restricted access to temporarily turn it off.
   *
   * Revision 1.5  2015/05/05 04:26:00  dick
   * Persist backgroundDelay and artShowDelay.
   *
   * Revision 1.4  2015/05/04 23:38:17  dick
   * Add backgroundDelay and artShowDelay
   *
   * Revision 1.3  2015/05/04 20:36:08  dick
   * getBackgroundFit() needs to know if we are running the ArtShow, which may be different
   * than the normal backgroundFit.
   *
   * Revision 1.2  2015/05/03 18:01:03  dick
   * Locally we keep attributes as normal bools/ints.  But we persist them as a list of key/value pairs. Manage the in and out of the User attributes.
   *
   * Revision 1.1  2015/04/27 02:25:14  dick
   * Extend BSAccountUser with BuckoVidLib specific attributes.
   *
   */
  package com.buckosoft.BuckoVidLib.domain;
  
  import java.util.ArrayList;
  import java.util.List;
  
  import org.apache.commons.logging.Log;
  import org.apache.commons.logging.LogFactory;
  
  import com.buckosoft.BSAccount.domain.BSAccount;
  import com.buckosoft.BSAccount.domain.BSAccountUser;
  
  /** Extend BSAccountUser with BuckoVidLib specific attributes
   * @author dick
   * @since 2015-04-26
   * @version $Revision: 1.8 $ <br/> $Date: 2015/05/10 19:03:31 $  
   */
  public class User extends BSAccountUser {
  	private static final Log log = LogFactory.getLog(User.class);
  	private static final long serialVersionUID = 42;
  
  	private	boolean	admin = false;
  	private	boolean	unrestricted = false;
  	private	int		backgroundFit = 1;
  	private	int		artShowFit = 1;
  	private	int		backgroundDelay = 30;
  	private	int		artShowDelay = 10;
  	private	boolean	hideRestricted = false;
  	private	int		findMaxResults = 40;
  
  	private	List<UserAttribute>	userAttributes;
  
  	public User(BSAccount account) {
  		super(account);
  	}
  
  	/** Is this user an admin?
  	 * @return the admin
  	 */
  	public boolean isAdmin() {
  		return admin;
  	}
  
  	/** Declare this user to be an admin
  	 * @param admin the admin to set
  	 */
  	public void setAdmin(boolean admin) {
  		this.admin = admin;
  	}
  
  	/** Is this user allowed access to the restricted areas of the library?
  	 * @return default = false, true = allow access
  	 */
  	public boolean isUnrestricted() {
  		return unrestricted;
  	}
  
  	/** Declare this user's access to the restricted areas.
  	 * @param unrestricted the unrestricted to set
  	 */
  	public void setUnrestricted(boolean unrestricted) {
  		this.unrestricted = unrestricted;
  	}
  
  	/** Perhaps the User wants to hide the restricted sections, even though he's authorized.
  	 * @return the hideRestricted
 	 */
 	public boolean isHideRestricted() {
 		return hideRestricted;
 	}
 
 	/**
 	 * @param hideRestricted the hideRestricted to set
 	 */
 	public void setHideRestricted(boolean hideRestricted) {
 		this.hideRestricted = hideRestricted;
 	}
 
 	/** Get the User's preference for background type
 	 * 0 = fit the image to the screen
 	 * 1 = fill the screen with the image (default)
 	 * 2 = no background image
 	 * @return the backgroundFit
 	 */
 	public int getBackgroundFit() {
 		return backgroundFit;
 	}
 
 	/**
 	 * @param backgroundFit the backgroundFit to set
 	 */
 	public void setBackgroundFit(int backgroundFit) {
 		this.backgroundFit = backgroundFit;
 	}
 
 	/**
 	 * @return the artShowFit
 	 */
 	public int getArtShowFit() {
 		return artShowFit;
 	}
 
 	/** User's preference for the ArtShow background type.
 	 * If the user is running the grey background, then he may still want to style the ArtShow.
 	 * @param artShowFit the artShowFit to set
 	 */
 	public void setArtShowFit(int artShowFit) {
 		this.artShowFit = artShowFit;
 	}
 
 	/**
 	 * @return the backgroundDelay
 	 */
 	public int getBackgroundDelay() {
 		return backgroundDelay;
 	}
 
 	/**
 	 * @param backgroundDelay the backgroundDelay to set
 	 */
 	public void setBackgroundDelay(int backgroundDelay) {
 		this.backgroundDelay = backgroundDelay;
 	}
 
 	/**
 	 * @return the artShowDelay
 	 */
 	public int getArtShowDelay() {
 		return artShowDelay;
 	}
 
 	/**
 	 * @param artShowDelay the artShowDelay to set
 	 */
 	public void setArtShowDelay(int artShowDelay) {
 		this.artShowDelay = artShowDelay;
 	}
 
 	/**
 	 * @return the findMaxResults
 	 */
 	public int getFindMaxResults() {
 		return findMaxResults;
 	}
 
 	/**
 	 * @param findMaxResults the findMaxResults to set
 	 */
 	public void setFindMaxResults(int findMaxResults) {
 		this.findMaxResults = findMaxResults;
 	}
 
 	/** Get the attributes as a List of UserAttribute.
 	 * These should not be directly accessed by the api. They are internal for hibernate to persist a User. <br>
 	 * Key/value pairs are used so that the User object can grow without having to redefine the User in the database table.
 	 * @return the attributes
 	 */
 	public List<UserAttribute> getUserAttributes() {
 		if (userAttributes == null)
 			userAttributes = new ArrayList<UserAttribute>();
 		setAttribute("admin", "" + admin);
 		setAttribute("unrestricted", "" + unrestricted);
 		setAttribute("hideRestricted", "" + hideRestricted);
 		setAttribute("backgroundFit", "" + backgroundFit);
 		setAttribute("artShowFit", "" + artShowFit);
 		setAttribute("backgroundDelay", "" + backgroundDelay);
 		setAttribute("artShowDelay", "" + artShowDelay);
 		setAttribute("findMaxResults", "" + findMaxResults);
 		return userAttributes;
 	}
 
 	/**
 	 * @param attributes the attributes to set
 	 */
 	public void setUserAttributes(List<UserAttribute> userAttributes) {
 		this.userAttributes = userAttributes;
 		if (userAttributes == null)
 			return;
 		for (UserAttribute ua : userAttributes) {
 			switch (ua.getKey()) {
 			case "admin":
 				this.admin = Boolean.parseBoolean(ua.getValue());
 				break;
 			case "unrestricted":
 				this.unrestricted = Boolean.parseBoolean(ua.getValue());
 				break;
 			case "hideRestricted":
 				this.hideRestricted = Boolean.parseBoolean(ua.getValue());
 				break;
 			case "backgroundFit":
 				this.backgroundFit = Integer.parseInt(ua.getValue());
 				break;
 			case "artShowFit":
 				this.artShowFit = Integer.parseInt(ua.getValue());
 				break;
 			case "backgroundDelay":
 				this.backgroundDelay = Integer.parseInt(ua.getValue());
 				break;
 			case "artShowDelay":
 				this.artShowDelay = Integer.parseInt(ua.getValue());
 				break;
 			case "findMaxResults":
 				this.findMaxResults = Integer.parseInt(ua.getValue());
 				break;
 			default:
 				log.error("Unknown UserAttribute" + ua.getKey());
 				break;
 			}
 		}
 	}
 	
 	private void setAttribute(String key, String value) {
 		for (UserAttribute ua : userAttributes) {
 			if (ua.getKey().equals(key)) {
 				ua.setValue(value);
 				return;
 			}
 		}
 		UserAttribute ua = new UserAttribute();
 		ua.setUserId(this.getUserId());
 		ua.setKey(key);
 		ua.setValue(value);
 		userAttributes.add(ua);
 	}
 }