/*
    * $HeadURL: $
    * $Date: $
    * $Revision: $
    * $Author: $
    * 
    * Copyright (c) 2005 MindTree Consulting Ltd. 
    * 
    * This file is part of Insight.
   * 
   * Insight 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.
   * 
   * Insight 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 
   * Insight.  If not, see <http://www.gnu.org/licenses/>.
   */
  
  package com.mindtree.techworks.insight.download;
  
  import java.net.MalformedURLException;
  import java.net.URL;
  import java.util.ArrayList;
  import java.util.Iterator;
  import java.util.List;
  
  import javax.swing.JOptionPane;
  
  import com.mindtree.techworks.insight.InsightConstants;
  import com.mindtree.techworks.insight.gui.Insight;
  import com.mindtree.techworks.insight.gui.action.LoadLocalFileAction;
  import com.mindtree.techworks.insight.gui.widgets.StatusBar;
  import com.mindtree.techworks.insight.model.ReceiverFormat;
  import com.mindtree.techworks.insight.preferences.util.Log4JPatternInterpeter;
  import com.mindtree.techworks.insight.spi.LogNamespace;
  
  
  /**
   * TODO
   * 
   * @see com.mindtree.techworks.insight.download.RemoteClientFactory RemoteClientFactory
   * @author Bindul Bhowmik
   * @version $Revision: 27 $ $Date: 2007-12-16 04:58:03 -0700 (Sun, 16 Dec 2007) $
   */
  public class DownloadProvider extends Thread {
  
  	//
  	// Static block to register all clients
  	//
  
  	static {
  		new FTPRemoteClient();
  		new HTTPRemoteClient();
  		new SFTPRemoteClient();
  	}
  
  	//
  	// Instance variables
  	//
  
  	/**
  	 * The insight instance
  	 */
  	private Insight insight;
  
  	/**
  	 * The client to use for downloading files
  	 */
  	private RemoteClient remoteClient;
  
  	/**
  	 * The fileset to use for download
  	 */
  	private Fileset fileset;
  
  	/**
  	 * The files to download
  	 */
  	private List files;
  
  	//
  	// Constructors
  	//
  
  	/**
  	 * Creates an instance of the DownloadProvier
  	 * 
  	 * @param insight The insight instance
  	 */
  	public DownloadProvider (Insight insight) {
  
  		this.insight = insight;
  	  	// explicitly set the priority to normal. Otherwise
 	  	// this thread will inherit the priority of the creator thread
 	  	// i.e the AWT event dispatch thread that runs with max priority
 		this.setPriority(Thread.NORM_PRIORITY);
 	}
 
 	//
 	// Public methods
 	//
 
 	/**
 	 * Loads all the remote files in the list taking host information from the
 	 * Fileset
 	 * 
 	 * @param remoteFileset The fileset to take host information from
 	 * @param filesToLoad The files to load
 	 */
 	public void loadRemoteFiles (Fileset remoteFileset, List filesToLoad) {
 
 		// Get the client
 		try {
 			remoteClient = RemoteClientFactory
 					.getClientForFileset(remoteFileset);
 		} catch (RemoteClientException e) {
 			e.printStackTrace(System.err);
 			JOptionPane.showMessageDialog(insight, InsightConstants
 					.getLiteral("DOWNLOAD_FAILED")
 					+ "\n" + e.getMessage(), InsightConstants
 					.getLiteral("ERROR"), JOptionPane.ERROR_MESSAGE);
 			return;
 		}
 
 		// Set the files to download... and go into async!
 		this.fileset = remoteFileset;
 		this.files = filesToLoad;
 
 		this.start();
 	}
 
 	//
 	// Methods to be executed asynchronously
 	//
 
 	/**
 	 * @see java.lang.Runnable#run()
 	 */
 	public void run () {
 
 		// Download the files
 		List localFiles = null;
 		
 		// The fileset does not care to have unique file locations.
 		// However, downloading the same file multiple times is wastage
 		// of network and system resources, specially between distant
 		// hosts. Further this also causes problems with the load file
 		// action (See Bugzill Bug #2960). 
 		// Hence only unique files are being loaded.
 		List uniqueFiles;
 			
 		try {
 			localFiles = remoteClient.downloadFiles(fileset, files);
 			//This code is updated such that it contains all the files from the 
 			//local file set returned by the download provider.
 			uniqueFiles = new ArrayList(localFiles.size());
 			for (Iterator fileItr = localFiles.iterator(); fileItr.hasNext(); ){
 				Object file = fileItr.next();
 				if (!uniqueFiles.contains(file)) {
 					uniqueFiles.add(file);
 				}
 			}
 		} catch (RemoteClientException e) {
 			e.printStackTrace(System.err);
 			JOptionPane.showMessageDialog(insight, InsightConstants
 					.getLiteral("DOWNLOAD_FAILED")
 					+ "\n" + e.getMessage(), InsightConstants
 					.getLiteral("ERROR"), JOptionPane.ERROR_MESSAGE);
 			// If a download would have started, then the progress is being reported. Stop it.
 			StatusBar.getInstance().clearDisplay(1);
 			return;
 		}
 
 		// Close the connection
 		try {
 			remoteClient.closeConnection();
 		} catch (RemoteClientException e) {
 			// Nothing wrong... can't do anything
 			e.printStackTrace(System.err);
 		}
 
 		// Load the files
 		LoadLocalFileAction loadLocalFileAction = LoadLocalFileAction
 				.getInstance();
 		ReceiverFormat[] receiverFormat = Log4JPatternInterpeter.getInterpretedRecieverFormat();
 		int count = 0;
 		for (Iterator localFileItr = localFiles.iterator(); localFileItr
 				.hasNext();) {
 			String fileName = (String)localFileItr.next();
 			String nodeId = null;
 			switch(fileset.getType()) {
 				case Fileset.FTP_FILESET:
 					nodeId = ((FTPFileset)fileset).getHost();
 					break;
 				case Fileset.HTTP_FILESET:
 					try {
 						nodeId = new URL((String)uniqueFiles.get(count)).getHost();
 					} catch(MalformedURLException mfe) {
 						// consume this
 					}
 					break;
 				case Fileset.SFTP_FILESET:
 					nodeId = ((SFTPFileset) fileset).getHost();
 					break;
 			}
 			loadLocalFileAction.addNamespaceForLoad(new LogNamespace((String)uniqueFiles.get(count), InsightConstants.FILE_PROTOCOL_PREFIX + fileName,
 					receiverFormat, nodeId));
 			count += 1;
 		}
 
 		loadLocalFileAction.loadNamespaces();
 	}
 }