/*
    * $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.gui.preferences;
  
  import java.awt.Component;
  import java.awt.GridBagConstraints;
  import java.awt.GridBagLayout;
  import java.awt.Insets;
  import java.awt.event.ActionEvent;
  import java.awt.event.ActionListener;
  import java.util.ArrayList;
  import java.util.Iterator;
  
  import javax.swing.AbstractListModel;
  import javax.swing.BorderFactory;
  import javax.swing.JButton;
  import javax.swing.JCheckBox;
  import javax.swing.JLabel;
  import javax.swing.JList;
  import javax.swing.JPanel;
  import javax.swing.JPasswordField;
  import javax.swing.JScrollPane;
  import javax.swing.JTextField;
  import javax.swing.ListSelectionModel;
  
  import com.mindtree.techworks.insight.InsightConstants;
  import com.mindtree.techworks.insight.gui.widgets.StatusBar;
  import com.mindtree.techworks.insight.preferences.PreferenceManager;
  import com.mindtree.techworks.insight.preferences.model.Preference;
  import com.mindtree.techworks.insight.preferences.model.PreferenceAttribute;
  import com.mindtree.techworks.insight.preferences.model.PreferenceAttributeType;
  import com.mindtree.techworks.insight.preferences.model.PreferenceInfo;
  
  
  /**
  *
  * The <code>RemoteFilesUIPanel</code> displays the UI for editing 
  * remote file set preferences.
  *
  * @see com.mindtree.techworks.insight.preferences.model.Preference
  * @see com.mindtree.techworks.insight.gui.preferences.AbstractPreferencesUIPanel
  *
  * @author  Regunath B
  * @version 1.0, 05/03/22
  */
  public class RemoteFilesUIPanel extends AbstractPreferencesUIPanel implements  ActionListener {
  	
  	/**
  	 * Used for object serialization
  	 */
  	private static final long serialVersionUID = 3816413009678139497L;
  	
  	/**
  	 * Constants for attribute Ids and prefixes of the remote file 
  	 * set preference 
  	 */
  	private static final String REQUIRES_AUTHENTICATION = "authentication";
  	private static final String REQUIRES_AUTHENTICATION_NAME = "Requires Authentication";
  	private static final String USER = "username";
  	private static final String USER_NAME = "User Name";
  	private static final String PASSWORD = "password";
  	private static final String PASSWORD_NAME = "Password";
  	private static final String URL_PREFIX = "urlId";
  //	private static final String URL_ATTRIB_NAME_PREFIX = "urlName";
  	private static final String IGNORE_PROXY = "ignoreProxy";
  	private static final String IGNORE_PROXY_NAME = "Ignore Proxy";
  	
  	/**
  	 * Constants to identify the file set edit action
  	 */
  	private static final int NONE = 0;
  	private static final int ADD = 1;
  	private static final int EDIT = 2;
  	private static final int REMOVE = 3;
  	
  	/**
  	 * State that holds the action type
  	 */
 	private int action = NONE;
 	
 	/**
 	 * The display widgets
 	 */
 	private JList configuredFilesetsList;
 	private JButton addButton;
 	private JButton editButton;
 	private JButton removeButton;
 	private JTextField nameField;
 	private JList urlList;
 	private JTextField newURLField;
 	private JButton addURLButton;
 	private JButton removeURLButton;
 	private JCheckBox requiresAuthentication;
 	private JTextField userField;
 	private JPasswordField passwordField;
 	private JCheckBox ignoreProxy;
 	private JButton applyChangesButton;
 	
 	/**
 	 * Layout definition for the fileset details
 	 */
 	private GridBagLayout gl;
 	private GridBagConstraints gc;		
 	
 //	private FilesetModel filesetModel;
 	
 	/**
 	 * No args constructor
 	 */
 	public RemoteFilesUIPanel() {
 	}
 
 	/** 
 	 * ActionListener interface method implementation
 	 * @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)
 	 */
 	public void actionPerformed(ActionEvent event) {
 		Object source = event.getSource();
 		if (source == this.addButton) {
 			this.action = ADD;
 			this.configuredFilesetsList.removeSelectionInterval(0,this.configuredFilesetsList.getModel().getSize() - 1);
 			setDetailsWidgetsEnable(true);
 		} else if (source == this.editButton) {
 			if (this.configuredFilesetsList.getSelectedIndex() > -1) {
 				this.action = EDIT;
 				PreferenceInfo prefInfo = (PreferenceInfo)this.configuredFilesetsList
 					.getModel().getElementAt(this.configuredFilesetsList
 							.getSelectedIndex());
 				displayFilesetInfoForEdit(PreferenceManager.getInstance().getPreference(prefInfo.getCompleteId()));
 			}
 		} else if (source == this.removeButton) {
 			if (this.configuredFilesetsList.getSelectedIndex() > -1) {
 				this.action = REMOVE;
 				((FilesetModel)this.configuredFilesetsList.getModel())
 					.removeFileset(this.configuredFilesetsList.getSelectedIndex());
 				setDetailsWidgetsEnable(false);
 			}
 		} else if (source == this.removeURLButton) {
 			if (this.urlList.getSelectedIndex() > -1) {
 				((URLListModel)this.urlList.getModel())
 				.removeURL(this.urlList.getSelectedIndex());
 			}
 		} else if (source == this.addURLButton) {
 			if (newURLField.getText().trim().length() > 0) {
 				((URLListModel)this.urlList.getModel()).addURL(newURLField.getText());
 				newURLField.setText("");
 			}
 		} else if (source == this.requiresAuthentication) {
 			if (this.configuredFilesetsList.getSelectedIndex() > -1) {
 				PreferenceInfo prefInfo = (PreferenceInfo)this.configuredFilesetsList.getModel().
 				getElementAt(this.configuredFilesetsList.getSelectedIndex());
 				checkAuthenticationEnable(PreferenceManager.getInstance().getPreference(prefInfo.getCompleteId()));
 			} else {
 				checkAuthenticationEnable(null);
 			}
 		} else if (source == applyChangesButton) {
 			if (this.nameField.getText().trim().length() < InsightConstants.PREFERENCE_NAME_MIN_SIZE) {
 				StatusBar.getInstance().setDisplayText(0,InsightConstants.getLiteral("ERROR_FILESET_NAME") + 
 						InsightConstants.PREFERENCE_NAME_MIN_SIZE, false);
 				return;
 			}
 			Preference childPreference = null;
 			switch(this.action) {
 				case ADD:
 					childPreference = new Preference(String.valueOf(new Object().hashCode()), true, true, this.nameField.getText());
 					createAndAddBooleanAttribute(childPreference, REQUIRES_AUTHENTICATION, 
 							REQUIRES_AUTHENTICATION_NAME, this.requiresAuthentication);				
 					createAndAddBooleanAttribute(childPreference, IGNORE_PROXY, 
 							IGNORE_PROXY_NAME, this.ignoreProxy);
 					createAndAddTextAttribute(childPreference, USER, USER_NAME, this.userField);
 					createAndAddPasswordAttribute(childPreference, PASSWORD, PASSWORD_NAME, this.passwordField);
 					
 					this.preference.addChildPreference(childPreference);
 					
 					// update the GUI
 					((FilesetModel)this.configuredFilesetsList.getModel()).addFileset(childPreference);
 					
 					break;
 				case EDIT:
 					childPreference = (Preference)((FilesetModel)this.configuredFilesetsList.
 						getModel()).getPreference(this.configuredFilesetsList.getSelectedIndex());
 					childPreference.setName(this.nameField.getText());
 					childPreference.getPreferenceAttributeById(REQUIRES_AUTHENTICATION).setValue(this.requiresAuthentication.isSelected() ? TRUE : FALSE);
 					childPreference.getPreferenceAttributeById(IGNORE_PROXY).setValue(this.ignoreProxy.isSelected() ? TRUE : FALSE);
 					childPreference.getPreferenceAttributeById(USER).setValue(this.userField.getText());
 					childPreference.getPreferenceAttributeById(PASSWORD).setValue(new String(this.passwordField.getPassword()));
 					((FilesetModel)this.configuredFilesetsList.getModel()).listDataUpdated(this.configuredFilesetsList.getSelectedIndex());
 					break;
 			}
 			// Remove all old URLs and add the new ones
 			updateURLListToPreference(childPreference);
 			setDetailsWidgetsEnable(false);
 			this.action = NONE;
 		}
 	}
 		
 	
 	/**
 	 *  Overriden super class method
 	 * @see com.mindtree.techworks.insight.gui.preferences.AbstractPreferencesUIPanel#initializeDisplay()
 	 */
 	protected void initializeDisplay() {
 		this.configuredFilesetsList = new JList(new FilesetModel());
 		this.configuredFilesetsList.setSelectionMode(ListSelectionModel.SINGLE_SELECTION);
 		addComponent(new JLabel(InsightConstants.getLiteral("CONFIGURED_FILESETS")),0,0,0,0,1,1);		
 		addComponent(new JScrollPane(configuredFilesetsList),1,0,1,1,1,4);	
 		this.addButton = new JButton(InsightConstants.getLiteral("ADD"));
 		this.editButton = new JButton(InsightConstants.getLiteral("EDIT"));
 		this.removeButton = new JButton(InsightConstants.getLiteral("REMOVE"));
 		this.addButton.addActionListener(this);
 		this.editButton.addActionListener(this);
 		this.removeButton.addActionListener(this);
 		addComponent(addButton,2,0,0,0,1,1);	
 		addComponent(editButton,2,1,0,0,1,1);	
 		addComponent(removeButton,2,2,0,0,1,1);	
 		
 		// add the widgets for the fileset details
 		JPanel filesetDetailsPanel = new JPanel();
 		this.gl = new GridBagLayout();
 		this.gc = new GridBagConstraints();
 		filesetDetailsPanel.setLayout(gl);
 		filesetDetailsPanel.setBorder(BorderFactory.createTitledBorder(InsightConstants.getLiteral("FILESET_DETAILS")));
 		addComponent(filesetDetailsPanel,0,4,1,1,3,1);	
 		
 		addComponent(filesetDetailsPanel,new JLabel(InsightConstants.getLiteral("NAME")),0,0,0,0,1,1);
 		this.nameField = new JTextField();
 		addComponent(filesetDetailsPanel,nameField,1,0,1,0,4,1);
 		this.urlList = new JList(new URLListModel());
 		this.urlList.setSelectionMode(ListSelectionModel.SINGLE_SELECTION);
 		addComponent(filesetDetailsPanel,new JLabel(InsightConstants.getLiteral("URLS")),0,1,0,0,1,1);		
 		addComponent(filesetDetailsPanel,new JScrollPane(urlList),1,1,1,1,4,2);			
 		this.removeURLButton = new JButton(InsightConstants.getLiteral("REMOVE"));
 		this.removeURLButton.addActionListener(this);
 		addComponent(filesetDetailsPanel,removeURLButton,5,1,0,0,1,1);	
 		addComponent(filesetDetailsPanel,new JLabel(InsightConstants.getLiteral("NEW_URL")),0,3,0,0,1,1);
 		this.newURLField = new JTextField();
 		addComponent(filesetDetailsPanel,newURLField,1,3,1,0,4,1);
 		this.addURLButton = new JButton(InsightConstants.getLiteral("ADD"));
 		this.addURLButton.addActionListener(this);
 		addComponent(filesetDetailsPanel,addURLButton,5,3,0,0,1,1);	
 		this.requiresAuthentication = new JCheckBox(InsightConstants.getLiteral("REQUIRES_AUTHENTICATION"));
 		this.requiresAuthentication.addActionListener(this);
 		addComponent(filesetDetailsPanel,requiresAuthentication,0,4,1,0,6,1);
 		addComponent(filesetDetailsPanel,new JLabel(InsightConstants.getLiteral("USER")),0,5,0,0,1,1);
 		this.userField = new JTextField();
 		addComponent(filesetDetailsPanel,userField,1,5,1,0,1,1);
 		addComponent(filesetDetailsPanel,new JLabel(InsightConstants.getLiteral("PASSWORD")),2,5,0,0,1,1);
 		this.passwordField = new JPasswordField();
 		addComponent(filesetDetailsPanel,passwordField,3,5,1,0,1,1);
 		this.ignoreProxy = new JCheckBox(InsightConstants.getLiteral("IGNORE_PROXY"));
 		addComponent(filesetDetailsPanel,ignoreProxy,0,6,1,0,6,1);
 		this.applyChangesButton = new JButton(InsightConstants.getLiteral("APPLY_FILESET_CHANGES"));
 		this.applyChangesButton.addActionListener(this);
 		addComponent(filesetDetailsPanel,applyChangesButton,3,7,1,0,3,1);
 		// disable the details widgets
 		setDetailsWidgetsEnable(false);		
 	}
 	
 
 	/**
 	 *  Overriden super class method
 	 * @see com.mindtree.techworks.insight.gui.preferences.AbstractPreferencesUIPanel#setPreferenceValues()
 	 */
 	protected  void setPreferenceValues() {
 		// update the fileset list change
 		updateFilesetListToPreference();
 	}
 	
 	/**
 	 * Helper method to update the list of filesets in the Preference for this panel
 	 */
 	private final void updateFilesetListToPreference() {
 		ArrayList oldValues = new ArrayList();
 		Iterator iterator = this.preference.iterateChildPreferenceIds();
 		while(iterator.hasNext()) {
 			oldValues.add(iterator.next());
 		}
 		iterator = oldValues.iterator();
 		while(iterator.hasNext()) {
 			this.preference.removePreference(
 					this.preference.getPreferenceById(
 							(String)iterator.next()));
 		}
 		for (int i = 0; i < this.configuredFilesetsList.getModel().getSize(); i++) {
 			this.preference.addChildPreference(((FilesetModel)this.configuredFilesetsList.getModel()).getPreference(i));
 		}				
 	}
 	
 	/**
 	 * Helper method to update the list of URLs in the specified file set Preference
 	 * @param childPreference the Preference to be updated with URL list
 	 */
 	private final void updateURLListToPreference(Preference childPreference) {
 		ArrayList oldValues = new ArrayList();
 		Iterator iterator = childPreference.iteratePreferenceAttributeIds();
 		while(iterator.hasNext()) {
 			String id = (String)iterator.next();
 			if (id.startsWith(URL_PREFIX)) {
 				oldValues.add(id);
 			}
 		}
 		iterator = oldValues.iterator();
 		while(iterator.hasNext()) {
 			childPreference.removePreferenceAttribute(
 					childPreference.getPreferenceAttributeById(
 							(String)iterator.next()));
 		}
 		for (int i = 0; i < this.urlList.getModel().getSize(); i++) {
 			String identifier = (String)this.urlList.getModel().getElementAt(i);
 			PreferenceAttribute newAttribute = new PreferenceAttribute(PreferenceAttributeType.TEXT,
 					URL_PREFIX + i, identifier, false,
 					true, true, childPreference);
 			newAttribute.setName(URL_PREFIX + i);
 			childPreference.addPreferenceAttribute(newAttribute);
 		}		
 	}
 	
 	/**
 	 * Helper method that displays the specified file set information for
 	 * editing
 	 * @param filesetInfo Presefernce containing the file set information
 	 */
 	private final void displayFilesetInfoForEdit(Preference filesetInfo) {
 		setDetailsWidgetsEnable(true);
 		this.nameField.setText(filesetInfo.getName());
 		Iterator iterator = filesetInfo.iteratePreferenceAttributeIds();
 		while(iterator.hasNext()) {			
 			String id = (String)iterator.next();
 			PreferenceAttribute prefAttribute = filesetInfo.getPreferenceAttributeById(id);
 			if (id.startsWith(URL_PREFIX)) {
 				((URLListModel)this.urlList.getModel()).addURL(prefAttribute.getValue());
 			} else if (id.equals(REQUIRES_AUTHENTICATION)) {
 				this.requiresAuthentication.setSelected(prefAttribute.getValue().equals(TRUE));
 			} else if (id.equals(IGNORE_PROXY)) {
 				this.ignoreProxy.setSelected(prefAttribute.getValue().equals(TRUE));
 			}
 		}
 		checkAuthenticationEnable(filesetInfo);
 	}
 	
 	/**
 	 * Adds the specified component to the specified panel using the specified constraints.
 	 **/
 	private final void addComponent(JPanel panel, Component c, int gridx, int gridy, int weightx,
 		int weighty, int width, int height) {
 		gc.fill = GridBagConstraints.BOTH;
 		gc.anchor = GridBagConstraints.NORTHWEST;
 		gc.insets = new Insets(5,5,5,5);		
 		gc.gridx = gridx;
 		gc.gridy = gridy;
 		gc.weightx = weightx;
 		gc.weighty = weighty;
 		gc.gridwidth = width;
 		gc.gridheight = height;		
 		gl.setConstraints( c, gc);
 		panel.add(c);
 	}	
 
 	/**
 	 * Helper method to set the enable status of file set details widgest
 	 * @param enable true to enable, false to disable
 	 */
 	private void setDetailsWidgetsEnable(boolean enable) {
 		this.nameField.setText("");
 		this.nameField.setEditable(enable);
 		this.nameField.setEnabled(enable);		
 		((URLListModel)this.urlList.getModel()).clearAll();
 		this.urlList.setEnabled(enable);
 		this.newURLField.setText("");
 		this.newURLField.setEditable(enable);
 		this.newURLField.setEnabled(enable);		
 		this.requiresAuthentication.setEnabled(enable);
 		this.ignoreProxy.setEnabled(enable);
 		this.ignoreProxy.setSelected(false);
 		this.requiresAuthentication.setSelected(false);
 		// pass null so that only enabling/disabling is done
 		checkAuthenticationEnable(null);
 		this.removeURLButton.setEnabled(enable);
 		this.addURLButton.setEnabled(enable);
 		this.applyChangesButton.setEnabled(enable);
 		if (enable) {
 			this.nameField.requestFocus();
 		}
 	}
 	
 	/**
 	 * Helper method that checks enabling and disabling of the user credential widgets
 	 */
 	private void checkAuthenticationEnable(Preference filesetInfo) {
 		boolean authenticationEnabled = this.requiresAuthentication.isSelected();
 		this.userField.setEditable(authenticationEnabled);
 		this.passwordField.setEditable(authenticationEnabled);
 		this.userField.setEnabled(authenticationEnabled);
 		this.passwordField.setEnabled(authenticationEnabled);
 		this.userField.setText((authenticationEnabled && filesetInfo != null) ? 
 				filesetInfo.getPreferenceAttributeById(USER).getValue() : "");
 		this.passwordField.setText((authenticationEnabled && filesetInfo != null) ? 
 				filesetInfo.getPreferenceAttributeById(PASSWORD).getValue() : "");
 	}	
 
 	/**
 	 * Helper class to that acts as the model for the fileset JList 
 	 */
 	private class FilesetModel extends AbstractListModel {
 		
 		/**
 		 * Used for object serialization
 		 */
 		private static final long serialVersionUID = 4136861131212594441L;
 		
 		/**
 		 * Collection that holds the configured fileset data
 		 */
 		private ArrayList configuredFilesets = new ArrayList();
 
 		/**
 		 * No args constructor
 		 */
 		public FilesetModel() {
 			Iterator iterator = preference.iterateChildPreferences();
 			while(iterator.hasNext()) {
 				Preference filesetPreference = (Preference)iterator.next();
 				configuredFilesets.add(filesetPreference);
 			}			
 		}
 
 		/**
 		 * Adds the specified fileset information to this model
 		 * @param filesetInfo Preference containing the file set information to be added
 		 */
 		public void addFileset(Preference filesetInfo) {
 			configuredFilesets.add(filesetInfo);
 			super.fireIntervalAdded(this, configuredFilesets.size() - 1, configuredFilesets.size() - 1);
 		}
 		
 		/**
 		 * Informs this model that the data at the specified index has changed
 		 * @param index index at which the data has changed
 		 */
 		public void listDataUpdated(int index) {
 			super.fireContentsChanged(this, index, index);
 		}		
 		
 		/**
 		 * Removes the specified fileset information to this model
 		 * @param index from where to remove the file set information
 		 */
 		public void removeFileset(int index) {
 			if (index < 0 || index >= configuredFilesets.size()) {
 				return;
 			}
 			configuredFilesets.remove(index);
 			super.fireIntervalRemoved(this, index, index);
 		}
 		
 		
 		/** 
 		 * Superclass abstract method implementation
 		 * @see javax.swing.ListModel#getSize()
 		 */
 		public int getSize() {
 			return configuredFilesets.size();
 		}
 		
 		/**
 		 * Returns the Preference at the sepcified index
 		 * @param index index of the required Preference
 		 * @return Preference at the specified index
 		 */
 		public Preference getPreference(int index) {
 			return (Preference)configuredFilesets.get(index);
 		}
 
 		/** 
 		 * Superclass abstract method implementation
 		 * @see javax.swing.ListModel#getElementAt(int)
 		 */
 		public Object getElementAt(int index) {
 			return ((Preference)configuredFilesets.get(index)).getPreferenceInfo();
 		}
 	}
 	
 	/**
 	 * Helper class to that acts as the model for the URL JList 
 	 */
 	private class URLListModel extends AbstractListModel {
 		
 		/**
 		 * Used for object serialization
 		 */
 		private static final long serialVersionUID = 897042512829232835L;
 		
 		/**
 		 * Collection that holds the configured URL data
 		 */
 		private ArrayList configuredURLs = new ArrayList();
 
 		/**
 		 * No args constructor
 		 */
 		public URLListModel() {
 		}
 
 		/**
 		 * Adds the specified URL information to this model
 		 * @param url the URL string
 		 */
 		public void addURL(String url) {
 			configuredURLs.add(url);
 			super.fireIntervalAdded(this, configuredURLs.size() - 1, configuredURLs.size() - 1);
 		}
 		
 		/**
 		 * Removes the specified URL information to this model
 		 * @param index from where to remove the URL information
 		 */
 		public void removeURL(int index) {
 			if (index < 0 || index >= configuredURLs.size()) {
 				return;
 			}			
 			configuredURLs.remove(index);
 			super.fireIntervalRemoved(this, index, index);
 		}
 		
 		/**
 		 * Clears the entire list contents
 		 */
 		public void clearAll() {
 			if (configuredURLs.size() > 0) {
 				int lastIndex = configuredURLs.size() - 1;
 				configuredURLs.clear();
 				super.fireIntervalRemoved(this, 0, lastIndex);
 			}
 		}
 		
 		/** 
 		 * Superclass abstract method implementation
 		 * @see javax.swing.ListModel#getSize()
 		 */
 		public int getSize() {
 			return configuredURLs.size();
 		}
 
 		/** 
 		 * Superclass abstract method implementation
 		 * @see javax.swing.ListModel#getElementAt(int)
 		 */
 		public Object getElementAt(int index) {
 			return configuredURLs.get(index);
 		}
 	}
 
 }