/*
  File: PreferencesDialog.java

  Copyright (c) 2006, The Cytoscape Consortium (www.cytoscape.org)

  The Cytoscape Consortium is:
  - Institute for Systems Biology
  - University of California San Diego
  - Memorial Sloan-Kettering Cancer Center
  - Institut Pasteur
  - Agilent Technologies

  This library is free software; you can redistribute it and/or modify it
  under the terms of the GNU Lesser General Public License as published
  by the Free Software Foundation; either version 2.1 of the License, or
  any later version.

  This library 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.  The software and
  documentation provided hereunder is on an "as is" basis, and the
  Institute for Systems Biology and the Whitehead Institute
  have no obligations to provide maintenance, support,
  updates, enhancements or modifications.  In no event shall the
  Institute for Systems Biology and the Whitehead Institute
  be liable to any party for direct, indirect, special,
  incidental or consequential damages, including lost profits, arising
  out of the use of this software and its documentation, even if the
  Institute for Systems Biology and the Whitehead Institute
  have been advised of the possibility of such damage.  See
  the GNU Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public License
  along with this library; if not, write to the Free Software Foundation,
  Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
*/
package cytoscape.dialogs.preferences;

import cytoscape.Cytoscape;
import cytoscape.CytoscapeInit;

import cytoscape.logger.CyLogger;

import java.awt.BorderLayout;
import java.awt.Color;
import java.awt.Component;
import java.awt.Dimension;
import java.awt.FlowLayout;
import java.awt.Font;
import java.awt.Frame;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.awt.event.ItemEvent;
import java.awt.event.ItemListener;

import java.beans.PropertyChangeEvent;
import java.beans.PropertyChangeListener;

import java.io.File;
import java.io.FileOutputStream;

import java.util.Properties;

import javax.swing.BorderFactory;
import javax.swing.Box;
import javax.swing.JButton;
import javax.swing.JCheckBox;
import javax.swing.JDialog;
import javax.swing.JLabel;
import javax.swing.JOptionPane;
import javax.swing.JPanel;
import javax.swing.JScrollPane;
import javax.swing.JTable;
import javax.swing.JTextArea;
import javax.swing.ListSelectionModel;
import javax.swing.SwingConstants;
import javax.swing.event.ListSelectionEvent;
import javax.swing.event.ListSelectionListener;
import javax.swing.table.DefaultTableCellRenderer;
import javax.swing.table.TableCellRenderer;
import javax.swing.table.TableColumn;
import javax.swing.table.TableModel;


/**
 *
 */
public class PreferencesDialog extends JDialog implements PropertyChangeListener {
	private static final int[] alignment = new int[] { JLabel.LEFT, JLabel.LEFT };
	private static final int[] columnWidth = new int[] { 200, 350 };
	
	private static final Color SELECTED_CELL_COLOR = new Color(0, 100, 255, 40);
	private static CyLogger logger = CyLogger.getLogger(PreferencesDialog.class);
	
	int[] selection = null;
	JScrollPane propsTablePane = new JScrollPane();
	JTable prefsTable = new JTable();
	JPanel propBtnPane = new JPanel(new FlowLayout());
	JPanel okButtonPane = new JPanel(new FlowLayout());
	JPanel vizmapPane = new JPanel(new FlowLayout());
	JPanel cyPropsPane = new JPanel(new FlowLayout());
	JCheckBox saveVizmapBtn = new JCheckBox("Make Current Visual Styles Default", false);
	JCheckBox saveCyPropsBtn = new JCheckBox("Make Current Cytoscape Properties Default", false);
	JTextArea vizmapText = new JTextArea("Only check this option if you want the current visual styles to be defaults in ALL future cytoscape sessions.  Your current visual styles are automatically saved in your Cytoscape session file and won't be lost.");
	JTextArea cyPropsText = new JTextArea("Only check this option if you want the current Cytoscape properties to be defaults in ALL future cytoscape sessions.  Your current Cytoscape properties are automatically saved in your Cytoscape session file and won't be lost.");
	JButton addPropBtn = new JButton("Add");
	JButton deletePropBtn = new JButton("Delete");
	JButton modifyPropBtn = new JButton("Modify");
	JButton okButton = new JButton("OK");
	JButton cancelButton = new JButton("Cancel");

	/**
	 *
	 */
	public PreferenceTableModel prefsTM = null;
	private ListSelectionModel lsm = null;
	private boolean saveCyPropsAsDefault = false;
	private boolean saveVizmapAsDefault = false;

	// When properties are changed, it will be processed here.
	/**
	 *  DOCUMENT ME!
	 *
	 * @param e DOCUMENT ME!
	 */
	public void propertyChange(PropertyChangeEvent e) {
		if (e.getPropertyName().equals(Cytoscape.PREFERENCE_MODIFIED)) {
			String info = "Cytoscape Prop. has changed: \n";
			info += " - Old value is " + e.getOldValue()+"\n";
			info += " - New value is " + e.getNewValue();
			logger.info(info);

			String propName = null;

			if ((CytoscapeInit.getProperties().getProperty("defaultSpeciesName") == e.getOldValue())
			    || (CytoscapeInit.getProperties().getProperty("defaultSpeciesName") == e.getNewValue())) {
				propName = "defaultSpeciesName";
			} else if ((CytoscapeInit.getProperties().getProperty("defaultWebBrowser") == e.getOldValue())
			           || (CytoscapeInit.getProperties().getProperty("defaultWebBrowser") == e.getNewValue())) {
				propName = "defaultWebBrowser";
			}

			if (propName != null) {
				// Set to new val
				CytoscapeInit.getProperties().setProperty(propName, (String) e.getNewValue());
				prefsTM.setProperty(propName, (String) e.getNewValue());
				// refresh();
				logger.info(propName + " updated to "
				            + CytoscapeInit.getProperties().getProperty(propName));
			}
		}
	}

	/**
	 *  DOCUMENT ME!
	 *
	 * @param tm DOCUMENT ME!
	 * @param preferenceName DOCUMENT ME!
	 * @param preferenceValue DOCUMENT ME!
	 */
	public void setParameter(TableModel tm, String preferenceName, String preferenceValue) {
		// preferences/properties
		if (tm == prefsTM) {
			Cytoscape.firePropertyChange(Cytoscape.PREFERENCE_MODIFIED,
			                             prefsTM.getProperty(preferenceName), preferenceValue);
			prefsTM.setProperty(preferenceName, preferenceValue);
		}

		refresh();

		// reset state of Modify and Delete buttons to inactive
		// since update of parameter will clear any selections
		modifyPropBtn.setEnabled(false);
		deletePropBtn.setEnabled(false);
	}

	/**
	 *  DOCUMENT ME!
	 */
	public void refresh() {
		// refresh the view
		prefsTable.setModel(prefsTM);

		prefsTable.clearSelection();
		prefsTable.revalidate();
		prefsTable.repaint();
	}

	private void initButtonPane() {
		propBtnPane.add(addPropBtn);
		propBtnPane.add(modifyPropBtn);
		propBtnPane.add(deletePropBtn);

		okButtonPane.add(okButton);
		okButtonPane.add(cancelButton);

		modifyPropBtn.setEnabled(false);
		deletePropBtn.setEnabled(false);
		addPropBtn.addActionListener(new AddPropertyListener(this));
		modifyPropBtn.addActionListener(new ModifyPropertyListener(this));
		deletePropBtn.addActionListener(new DeletePropertyListener(this));
		okButton.addActionListener(new OkButtonListener(this));
		cancelButton.addActionListener(new CancelButtonListener(this));
		saveVizmapBtn.addItemListener(new CheckBoxListener());
		saveCyPropsBtn.addItemListener(new CheckBoxListener());
	}

	/**
	 *  DOCUMENT ME!
	 *
	 * @return  DOCUMENT ME!
	 */
	public PreferenceTableModel getPTM() {
		return prefsTM;
	}

	private void initTable() {
		prefsTM = new PreferenceTableModel();

		prefsTable.setAutoCreateColumnsFromModel(false);
		prefsTable.setRowSelectionAllowed(true);
		lsm = prefsTable.getSelectionModel();
		lsm.setSelectionMode(ListSelectionModel.SINGLE_SELECTION);
		lsm.addListSelectionListener(new TableListener(this, lsm));

		prefsTable.setModel(prefsTM);

		prefsTable.setRowHeight(16);
		TableColumn column;
		DefaultTableCellRenderer renderer = new DefaultTableCellRenderer() {

			public Component getTableCellRendererComponent(JTable table,
					Object value, boolean isSelected, boolean hasFocus,
					int row, int column) {
				
				setFont(new Font("SansSerif", Font.PLAIN, 12));
				setVerticalTextPosition(SwingConstants.CENTER);
				if(isSelected)
					setBackground(SELECTED_CELL_COLOR);
				else
					setBackground(Color.WHITE);
				
				if(value != null) {
					setToolTipText(value.toString());
					setText(value.toString());
				} else
					setText("");
				return this;
			}};

		for (int i = 0; i < PreferenceTableModel.columnHeader.length; i++) {
			renderer.setHorizontalAlignment(alignment[i]);
			column = new TableColumn(i, columnWidth[i], renderer, null);
			column.setIdentifier(PreferenceTableModel.columnHeader[i]);
			prefsTable.addColumn(column);
		}
	}

	/**
	 * Creates a new PreferencesDialog object.
	 *
	 * @param owner  DOCUMENT ME!
	 */
	public PreferencesDialog(Frame owner) {
		super(owner);

		Cytoscape.getSwingPropertyChangeSupport().addPropertyChangeListener(this);

		initButtonPane();
		initTable();

		try {
			prefPopupInit();
		} catch (Exception e) {
			logger.warn("Unable to initialize preferences popup: "+e.getMessage(), e);
		}

		this.setTitle("Cytoscape Preferences Editor");
		pack();
		// set location relative to owner/parent
		this.setLocationRelativeTo(owner);
		this.setVisible(true);
	}

	private void prefPopupInit() throws Exception {
		java.awt.GridBagConstraints gridBagConstraints;

		JPanel outerPanel = new JPanel(new java.awt.GridBagLayout());

		JPanel propsTablePanel = new JPanel(new java.awt.GridBagLayout());
		propsTablePanel.setBorder(BorderFactory.createTitledBorder("Properties"));

		propsTablePane.setBorder(BorderFactory.createEmptyBorder(2, 9, 4, 9));
		propsTablePane.getViewport().add(prefsTable, null);
		prefsTable.setPreferredScrollableViewportSize(new Dimension(500, 300));

		gridBagConstraints = new java.awt.GridBagConstraints();
		gridBagConstraints.fill = java.awt.GridBagConstraints.BOTH;
		gridBagConstraints.weightx = 1.0;
		gridBagConstraints.weighty = 1.0;
		propsTablePanel.add(propsTablePane, gridBagConstraints);

		gridBagConstraints = new java.awt.GridBagConstraints();
		gridBagConstraints.gridy = 1;
		gridBagConstraints.fill = java.awt.GridBagConstraints.HORIZONTAL;
		gridBagConstraints.insets = new java.awt.Insets(10, 0, 0, 0);
		propsTablePanel.add(propBtnPane, gridBagConstraints);

		gridBagConstraints = new java.awt.GridBagConstraints();
		gridBagConstraints.fill = java.awt.GridBagConstraints.BOTH;
		gridBagConstraints.weightx = 1.0;
		gridBagConstraints.weighty = 1.0;
		gridBagConstraints.insets = new java.awt.Insets(10, 10, 10, 10);
		outerPanel.add(propsTablePanel, gridBagConstraints);

		JTextArea textArea = new JTextArea("NOTE: Changes to these properties are used in the current session ONLY unless otherwise specified below.");

		textArea.setBackground(outerPanel.getBackground());
		textArea.setEditable(false);
		textArea.setDragEnabled(false);
		textArea.setLineWrap(true);
		textArea.setWrapStyleWord(true);

		gridBagConstraints = new java.awt.GridBagConstraints();
		gridBagConstraints.gridy = 1;
		gridBagConstraints.fill = java.awt.GridBagConstraints.HORIZONTAL;
		gridBagConstraints.insets = new java.awt.Insets(0, 10, 10, 10);
		outerPanel.add(textArea, gridBagConstraints);

		Box vizmapBox = Box.createVerticalBox();
		vizmapBox.setBorder(BorderFactory.createTitledBorder("Default Visual Styles"));
		vizmapText.setBackground(outerPanel.getBackground());
		vizmapText.setEditable(false);
		vizmapText.setDragEnabled(false);
		vizmapText.setLineWrap(true);
		vizmapText.setWrapStyleWord(true);
		vizmapBox.add(vizmapText);
		vizmapBox.add(Box.createVerticalStrut(5));
		vizmapPane.add(saveVizmapBtn);
		vizmapBox.add(vizmapPane);

		gridBagConstraints = new java.awt.GridBagConstraints();
		gridBagConstraints.gridy = 2;
		gridBagConstraints.fill = java.awt.GridBagConstraints.HORIZONTAL;
		gridBagConstraints.insets = new java.awt.Insets(0, 10, 10, 10);
		outerPanel.add(vizmapBox, gridBagConstraints);

		Box cyPropsBox = Box.createVerticalBox();
		cyPropsBox.setBorder(BorderFactory.createTitledBorder("Default Cytoscape Properties"));
		cyPropsText.setBackground(outerPanel.getBackground());
		cyPropsText.setEditable(false);
		cyPropsText.setDragEnabled(false);
		cyPropsText.setLineWrap(true);
		cyPropsText.setWrapStyleWord(true);
		cyPropsBox.add(cyPropsText);
		cyPropsBox.add(Box.createVerticalStrut(5));
		cyPropsPane.add(saveCyPropsBtn);
		cyPropsBox.add(cyPropsPane);

		gridBagConstraints = new java.awt.GridBagConstraints();
		gridBagConstraints.gridy = 3;
		gridBagConstraints.fill = java.awt.GridBagConstraints.HORIZONTAL;
		gridBagConstraints.insets = new java.awt.Insets(0, 10, 10, 10);
		outerPanel.add(cyPropsBox, gridBagConstraints);

		gridBagConstraints = new java.awt.GridBagConstraints();
		gridBagConstraints.gridy = 4;
		gridBagConstraints.fill = java.awt.GridBagConstraints.HORIZONTAL;
		gridBagConstraints.insets = new java.awt.Insets(0, 10, 10, 10);
		outerPanel.add(okButtonPane, gridBagConstraints);

		this.getContentPane().add(outerPanel, BorderLayout.CENTER);
	}

	class AddPropertyListener implements ActionListener {
		PreferencesDialog callerRef = null;

		public AddPropertyListener(PreferencesDialog caller) {
			super();
			callerRef = caller;
		}

		public void actionPerformed(ActionEvent e) {
			String key = JOptionPane.showInputDialog(addPropBtn, "Enter property name:",
			                                         "Add Property", JOptionPane.QUESTION_MESSAGE);

			if (key != null) {
				String value = JOptionPane.showInputDialog(addPropBtn,
				                                           "Enter value for property " + key + ":",
				                                           "Add Property Value",
				                                           JOptionPane.QUESTION_MESSAGE);

				if (value != null) {
					String[] vals = { key, value };
					prefsTM.addProperty(vals);
					refresh(); // refresh view in table
				}
			}
		}
	}

	class ModifyPropertyListener implements ActionListener {
		PreferencesDialog callerRef = null;

		public ModifyPropertyListener(PreferencesDialog caller) {
			super();
			callerRef = caller;
		}

		public void actionPerformed(ActionEvent e) {
			for (int i = 0; i < selection.length; i++) {
				String name = new String((String) (prefsTM.getValueAt(selection[i], 0)));
				String value = new String((String) (prefsTM.getValueAt(selection[i], 1)));

				PreferenceValueDialog pd = new PreferenceValueDialog(PreferencesDialog.this, name,
				                                                     value, callerRef, prefsTM,
				                                                     "Modify value...");
			}
		}
	}

	class DeletePropertyListener implements ActionListener {
		PreferencesDialog callerRef = null;

		public DeletePropertyListener(PreferencesDialog caller) {
			super();
			callerRef = caller;
		}

		public void actionPerformed(ActionEvent e) {
			for (int i = 0; i < selection.length; i++) {
				String name = new String((String) (prefsTM.getValueAt(selection[i], 0)));
				prefsTM.deleteProperty(name);
			}

			refresh();
		}
	}

	class OkButtonListener implements ActionListener {
		PreferencesDialog callerRef = null;

		public OkButtonListener(PreferencesDialog caller) {
			super();
			callerRef = caller;
		}

		public void actionPerformed(ActionEvent e) {
			// just saving via putAll() doesn't handle deletes...
			// therefore use TableModel's putAll() into new Properties obj
			// then clear Cytoscape's properties and
			Properties newProps = new Properties();
			callerRef.prefsTM.save(newProps);
			CytoscapeInit.getProperties().clear();
			CytoscapeInit.getProperties().putAll(newProps);
			callerRef.setVisible(false);

			if (saveVizmapAsDefault) {
				Cytoscape.firePropertyChange(Cytoscape.SAVE_VIZMAP_PROPS, null, null);
				saveVizmapAsDefault = false;
				saveVizmapBtn.setSelected(false);
			}

			if (saveCyPropsAsDefault) {
				try {
					File file = CytoscapeInit.getConfigFile("cytoscape.props");
					FileOutputStream output = null;
                    try {
						output = new FileOutputStream(file);
                        CytoscapeInit.getProperties().store(output, "Cytoscape Property File");
                        logger.info("wrote Cytoscape properties file to: " + file.getAbsolutePath());
                    }
                    finally {
                        if (output != null) {
                            output.close();
                        }
                    }
				} catch (Exception ex) {
					logger.error("Could not write cytoscape.props file!", ex);
				}

				saveCyPropsAsDefault = false;
				saveCyPropsBtn.setSelected(false);
			}

			Cytoscape.firePropertyChange(Cytoscape.PREFERENCES_UPDATED, null, null);
		}
	}

	class CheckBoxListener implements ItemListener {
		public CheckBoxListener() {
			super();
		}

		public void itemStateChanged(ItemEvent e) {
			Object source = e.getItemSelectable();

			if (e.getStateChange() == ItemEvent.SELECTED) {
				if (source == saveVizmapBtn)
					saveVizmapAsDefault = true;

				if (source == saveCyPropsBtn)
					saveCyPropsAsDefault = true;
			}
		}
	}

	class CancelButtonListener implements ActionListener {
		PreferencesDialog callerRef = null;

		public CancelButtonListener(PreferencesDialog caller) {
			super();
			callerRef = caller;
		}

		public void actionPerformed(ActionEvent e) {
			Properties oldProps = CytoscapeInit.getProperties();
			callerRef.prefsTM.restore(oldProps);
			callerRef.setVisible(false);
		}
	}

	class TableListener implements ListSelectionListener {
		private ListSelectionModel model = null;
		private PreferencesDialog motherRef = null;

		public TableListener(PreferencesDialog mother, ListSelectionModel lsm) {
			motherRef = mother;
			model = lsm;
		}

		public void valueChanged(ListSelectionEvent lse) {
			if (!lse.getValueIsAdjusting()) {
				selection = getSelectedIndices(model.getMinSelectionIndex(),
				                               model.getMaxSelectionIndex());

				if (selection.length == 0) {
				} else {
					modifyPropBtn.setEnabled(true);
					deletePropBtn.setEnabled(true);
				}
			}
		}

		protected int[] getSelectedIndices(int start, int stop) {
			if ((start == -1) || (stop == -1)) {
				return new int[0];
			}

			int[] guesses = new int[stop - start + 1];
			int index = 0;

			for (int i = start; i <= stop; i++) {
				if (model.isSelectedIndex(i)) {
					guesses[index++] = i;
				}
			}

			int[] realthing = new int[index];
			System.arraycopy(guesses, 0, realthing, 0, index);

			return realthing;
		}

		public void actionPerformed(ActionEvent e) {
		}
	}
}