/*
    *  XNap - A P2P framework and client.
    *
    *  See the file AUTHORS for copyright information.
    *
    *  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.
    *
   *  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, write to the Free Software
   *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
   */
  
  package org.xnap.plugin.opennap.net;
  
  import javax.swing.Action;
  
  import org.xnap.XNap;
  import org.xnap.plugin.opennap.net.msg.ExceptionListener;
  import org.xnap.plugin.opennap.net.msg.MessageHandler;
  import org.xnap.plugin.opennap.net.msg.MessageListener;
  import org.xnap.plugin.opennap.net.msg.client.BrowseRequestMessage;
  import org.xnap.plugin.opennap.net.msg.server.BrowseResponseMessage;
  import org.xnap.plugin.opennap.net.msg.server.ServerMessage;
  import org.xnap.plugin.opennap.net.msg.server.UserSignoffMessage;
  import org.xnap.plugin.opennap.user.OpenNapUser;
  import org.xnap.search.SearchFilter;
  import org.xnap.search.SearchHandler;
  import org.xnap.search.SearchResult;
  
  /***
   * Implements an OpenNap search on set of servers.
   */
  public class OpenNapBrowse 
  	implements ExceptionListener, MessageListener, OpenNapBrowseInterface {
  
      // --- Constants(s) ---
  
      //--- Data Field(s) ---
      
      private SearchHandler handler;
  	private boolean done;
  	private boolean failed;
  
  	private OpenNapUser user;
      private BrowseRequestMessage request;
  
  	
      
      //--- Constructor(s) ---
  
      public OpenNapBrowse(OpenNapUser user)
      {
  		this.user = user;
  
  		request = new BrowseRequestMessage(user.getName());
  		request.setExceptionListener(this);
      }
  
      // --- Method(s) ---
  
      public void exceptionThrown(Exception e)
      {
  		failed = true;
  		finished();
      }
  
  	/***
  	 * Returns <code>null</code>.
  	 */
  	public Action[] getActions()
  	{
  		return null;
  	}
  
      /***
       * Returns <code>null</code>.
       */
      public SearchFilter getFilter()
      {
  		return null;
      }
  
      /***
       * Returns the name of the user that is browsed.
       */
      public String getName()
      {
  		return user.getName();
      }
  
  	public BrowseRequestMessage getRequest()
  	{
 		return request;
 	}
 
     /***
      * Returns <code>true</code>.
      */
     public boolean showTree()
     {
 		return true;
     }
 
     /***
      * Returns a string that describes the current status. 
      */
     public String getStatus()
     {
 		return (isDone()) 
 			? XNap.tr("finished")
 			: XNap.tr("receiving results") + "...";
     }
 
     /***
      * Returns true, if this search can not be canceled.
      */
     public boolean isDone()
     {
 		return done;
     }
 
 	public boolean isFailed()
 	{
 		return failed;
 	}
 
     /***
      * Starts this search.
      *
      * @param handler the object that handles the results
      */
     public void start(SearchHandler handler)
     {
 		this.handler = handler;
 
 		done = false;
 		failed = false;
 
 		OpenNapServerRunner r = user.getServer().getRunner();
 		if (r != null) {
 			r.enqueue(this);
 			MessageHandler.subscribe(UserSignoffMessage.TYPE, this);
 		}
 		else {
 			getRequest().failed();
 		}
     }
 
     /***
      * Cancels this search.
      */
     public void stop()
     {
 		MessageHandler.unsubscribe(UserSignoffMessage.TYPE, this);
 		done = true;
     }
 
 	/***
 	 * Invoked by {@link OpenNapServer}.
 	 */
     void finished()
     {
 		done = true;
 		handler.stateChanged(this);
     }
 
     void received(BrowseResponseMessage msg)
     {
 		if (done) {
 			return;
 		}
 
  		OpenNapUser user = msg.getServer().getUser(msg.nick);
 
 		SearchResult result = new OpenNapSearchResult
 			(null, msg.filesize, msg.bitrate, msg.frequency, 
 			 msg.length, user, msg.filename, msg.md5);
 
 		handler.resultReceived(result);
     }
 
 	/***
 	 *  @see xnap.plugin.nap.net.msg.server.MessageListener#messageReceived(xnap.plugin.nap.net.msg.server.ServerMessage)
 	 */
 	public void messageReceived(ServerMessage msg) 
 	{
 		// the user has signed off
 		failed = true;
 		finished();
 	}
 
     // --- Inner Class(es) ---
 
 }