package org.musicontroller.core;
   
   import java.util.Date;
   import java.util.HashSet;
   import java.util.Set;
   import java.util.TreeSet;
   
   import org.musicontroller.security.IUser;
   import org.varienaja.util.DateTools;
  
  /**
   * @author Varienaja
   */
  public class Song extends LinkableAbs {
  	private String _comments;
  	private int _bpm,_length;
  	private Song _parent;
  	private Band _band;
  	private Link _link;
  	private Keywordbag _keywordbag;
  	private AIBag _aibag;
  	private Set<Contract_PS> _playlists;
  	private Set<Event> _events;
  	private EventCountLookup _lookup;
  
  	public Song() {
  		_comments="";
  		_bpm=-1;
  		_length=-1;
  		_parent=null;
  		_band=null;
  		_link=null;
  		_aibag=null;
  		_keywordbag=null;
  		_lookup=null;
  		_playlists=new HashSet<Contract_PS>();
  		_events=new TreeSet<Event>(); //To preserve ordering (see mapping-file), this is a TreeSet
  	}
  	
  	public Event addEvent(Date moment, IUser user, int eventkind) {
  		if (user==null) throw new IllegalArgumentException("Cannot add events without a user.");
  		Event event = new Event();
  		event.setUser(user);
  		event.setSong(this);
  		event.setMoment(moment);
  		event.setEventkind(eventkind);
  		getLookup().addEvent(event);
  		_events.add(event);
  		return event;
  	}
  	
  	public Event addPlayedEvent(Date moment, IUser user) {
  		return addEvent(moment,user,Event.played);
  	}
  	
  	public Event addRequestedEvent(Date moment, IUser user) {
  		return addEvent(moment,user,Event.requested);
  	}
  
  	public Event addSkippedEvent(Date moment, IUser user) {
  		return addEvent(moment,user,Event.skipped);
  	}
  	
  	public Event addDownloadedEvent(Date moment, IUser user) {
  		return addEvent(moment,user,Event.downloaded);
  	}
  	
  	public Band getBand() {
  		return _band;
  	}
  	
  	public void setBand(Band band) {
  		_band = band;
  	}
  	
  	public int getBpm() {
  		return _bpm;
  	}
  	
  	public void setBpm(int bpm) {
  		_bpm = bpm;
  	}
  	
  	public String getComments() {
  		return _comments;
  	}
  	
  	public void setComments(String comments) {
  		_comments = comments;
  	}
  	
  	public Link getLink() {
  		return _link;
  	}
  	
  	public void setLink(Link link) {
  		_link = link;
  	}
  	
 	/**
 	 * Returns the song length in milliseconds.
 	 * @return The songs length in milliseconds.
 	 */
 	public int getLength() {
 		return _length;
 	}
 	
 	/**
 	 * Sets the song length in milliseconds. Negative lengths are multiplied by -1.
 	 * @param length The new length in milliseconds.
 	 */
 	public void setLength(int length) {
 		_length = Math.abs(length);
 	}
 	
 	/**
 	 * Sets the Songs length. The input has to be in the format hh:mm:ss or 
 	 * mm:ss or ss.
 	 * @param formattedLength The length in string-format.
 	 */
 	public void setLength(String formattedLength) {
 		if (formattedLength !=null) {
 			String[] parts = formattedLength.split(":");
 			try {
 				if (parts.length==1) {
 					_length = 1000 * (Integer.parseInt(parts[0]));
 				} else if (parts.length==2) {
 					_length = 1000 * (Integer.parseInt(parts[0]) * 60 + 
 					         	Integer.parseInt(parts[1]));
 				} else if (parts.length==3) {
 					_length = 1000 * (Integer.parseInt(parts[0]) * 3600 + 
 								Integer.parseInt(parts[1]) * 60 +
 								Integer.parseInt(parts[2]));
 					
 				}
 			} catch (NumberFormatException e) {
 				//silently ignore.
 			}
 		}
 	}
 	
 	public Song getParent() {
 		return _parent;
 	}
 	
 	public void setParent(Song parent) {
 		_parent = parent;
 	}
 
 	/**
 	 * Getter for the bag of keywords associated with the song.
 	 * @return The bag of keywords of this song.
 	 */
 	public Keywordbag getKeywordbag() {
 		return _keywordbag;
 	}
 	
 	/**
 	 * Setter for the bag of keywords associated with this song.
 	 * @param keywordbag The bag of keywords.
 	 */
 	public void setKeywordbag(Keywordbag keywordbag) {
 		_keywordbag = keywordbag;
 	}
 
 	/**
 	 * Getter for the set of events of the song.
 	 * @return The set of events.
 	 */
 	public Set<Event> getEvents() {
 		return _events;
 	}
 	
 	/**
 	 * Setter for the set of events of the song.
 	 * @param events The set of events (not null).
 	 */
 	public void setEvents(Set<Event> events) {
 		if (events!=null) {
 			_events = events;
 		}
 	}
 	
 	/**
 	 * Get (and create when neccessary) the lookup-object, which contains the
 	 * counts for our Events.
 	 * @return The EventCountLookup-object.
 	 */
 	private EventCountLookup getLookup() {
 		if (_lookup==null) {
 			_lookup = EventCountLookup.create(_events,getId());
 		}				
 		return _lookup;
 	}
 
 	public Set<Contract_PS> getPlaylists() {
 		return _playlists;
 	}
 
 	public void setPlaylists(Set<Contract_PS> playlists) {
 		if (playlists!=null) _playlists = playlists;
 	}
 	
 	/**
 	 * Returns the songs' keywords as a comma separated
 	 * list of keywords. 
 	 * @return A string with the songs keywords separated by commas.
 	 */
 	public String listKeywords() {
 		String keywords="";
 		Keywordbag bag = getKeywordbag();
 		if(bag==null) {
 			return "";
 		}
 		for (Keyword key : bag.getKeywords()) {
 			keywords+=key.getName()+", ";
 		}
 		return (keywords.length()>=2) ? keywords.substring(0,keywords.length()-2) : "";
 	}
 	
 	public String listPlaylists() {
 		String lists="";
 		for(Contract_PS c_ps: getPlaylists()) {
 			Playlist pl = c_ps.getPlaylist();
 			if(pl!=null && pl.getName()!=null && pl.getName().length()>0) {
 				lists+=pl.getName()+", ";
 			}
 		}
 		return (lists.length()>=2) ? lists.substring(0,lists.length()-2) : "";
 	}
 	
 	public static String getFormattedLength(int lengthinmillis) {
 		int L = lengthinmillis / 1000;
 		int M = L / 60;
 		int S = L % 60;
 		
 		return Integer.toString(M)+":"+ ( (S<10) ? "0"+S : Integer.toString(S));
 	}
 	
 	public String getFormattedLength() {
 		return getFormattedLength(_length);
 	}
 	
 	public int getPlaycount(IUser user) {
 		return getPlaycount(user,null,null);
 	}
 	
 	public int getRequestcount(IUser user) {
 		return getRequestcount(user,null,null);
 	}
 	
 	public int getSkipcount(IUser user) {
 		return getSkipcount(user,null,null);
 	}
 	
 	public int getPlaycount(IUser user, Date begin, Date end) {
 		return getEventCount(user,Event.played,begin, end);
 	}
 	
 	public int getRequestcount(IUser user, Date begin, Date end) {
 		return getEventCount(user,Event.requested, begin, end);
 	}
 	
 	public int getSkipcount(IUser user, Date begin, Date end) {
 		return getEventCount(user,Event.skipped, begin, end);
 	}
 	
 	public int getDownloadcount(IUser user, Date begin, Date end) {
 		return getEventCount(user,Event.downloaded, begin, end);
 	}
 	
 	public int getEventcount(IUser user, int kind) {
 		return getEventCount(user,kind,null,null);
 	}
 	
 	/**
 	 * Returns an int-representation of the popularity of a song during a
 	 * certain period. The popularity is defined as follows:
 	 * <code>popularity = playcount + requestcount + downloadcount - skipcount</code>
 	 * <p>Only events after the begin-parameter and before the end-parameter are
 	 * taken into account. These parameters can be left null. When both are null,
 	 * all events are counted. When begin is null, all events untill end are
 	 * counted. If end is null, all events after begin are counted.
 	 * </p>
 	 * @param user The user to calculate the popularity for.
 	 * @param begin The begindate, or rather a timestamp.
 	 * @param end The enddate, also a timestamp
 	 * @return The popularity of the song.
 	 */
 	public int getPopularity(IUser user, Date begin, Date end) {
 		int score = getPlaycount(user, begin, end) + 
 		getRequestcount(user, begin, end) +
 		getDownloadcount(user, begin, end) -
 		getSkipcount(user, begin, end);
 		return score;
 	}
 	
 	/**
 	 * Counts the amount of events of a certain kind by a certain User
 	 * @param user The User, if null then the events of all user are added up
 	 * @param kind The eventkind
 	 * @param begin The Date after which events will be counted
 	 * @param end The Date before which events will be counted
 	 * @return The amount of events
 	 */
 	public int getEventCount(IUser user, int kind, Date begin, Date end) {
 		if (user==null) return 0;
 		
 		if (begin==null && end==null) { //Total count
 			return getLookup().getEventCount(user.getId(), kind);
 		} else {
 			if (end==null && begin!=null) { //Count for last year?
 				if (DateTools.sameDay(begin, DateTools.lastYear())) { //Last year!
 					return getLookup().getEventCountLastYear(user.getId(), kind);
 				}
 			}
 		}
 		
 		//Old fashioned and slow way of counting.
 		int count=0;
 		for (Event ev: getEvents()) {
 			if (user==null ? true : user.equals(ev.getUser())) {
 				if (kind==ev.getEventkind()) {
 					if (begin==null) {
 						if (end==null) {
 							count++;
 						} else {
 							if (ev.getMoment().before(end)) count++;
 						}
 					} else {
 						if (end==null) {
 							if (ev.getMoment().after(begin)) count++;
 						} else {
 							if (ev.getMoment().after(begin) && (ev.getMoment().before(end))) count++;
 						}
 					}
 				}
 			}
 		}
 		return count;
 	}
 	
 	/**
 	 * Returns the Date of the last Played-event of this song
 	 * @param user The user to return the last Played-event for, if null the last played-event is returned
 	 * @return The Date of the last Played-event
 	 */
 	public Date getLastPlay(IUser user) {
 		if (user==null) return null;
 		return getLookup().getLastPlay(user.getId());
 	}
 
 	public AIBag getAibag() {
 		return _aibag;
 	}
 	
 
 	public void setAibag(AIBag aibag) {
 		_aibag = aibag;
 	}
 		
 	public boolean equals(Object o) {
 		if (o==null) return false;
 		
 		if (o instanceof Song) {
 			Song other = (Song) o;
 			return getId()==other.getId() && getName().equals(other.getName());
 		} else {
 			return false;
 		}
 	}
 	
 	/*
 	 * (non-Javadoc)
 	 * @see java.lang.Object#hashCode()
 	 */
 	@Override
 	public int hashCode() {
 		return Long.valueOf(getId()).hashCode();
 	}
 
 	/*
 	 * (non-Javadoc)
 	 * @see java.lang.Object#toString()
 	 */
 	@Override
 	public String toString() {
 		StringBuilder sb = new StringBuilder();
 		if (_band!=null) {
 			sb.append(_band);
 			sb.append(" - ");
 		}
 		sb.append("[");
 		sb.append(getId());
 		sb.append("] ");
 		sb.append(getName());
 		sb.append(" (");
 		sb.append(getFormattedLength());
 		sb.append(") [");
 		if (_keywordbag!=null) {
 			sb.append(_keywordbag);
 		}
 		sb.append("] ");
 		if (_link!=null) {
 			sb.append(" ");
 			sb.append(_link);
 		}
 		return sb.toString();
 	}
 
 	public String getType() {
 		return "S";
 	}
 
 }