/**
 * Copyright (c) 2010 The Regents of the University of California.
 * All rights reserved.
 *
 * '$Author: tao $'
 * '$Date: 2010-06-03 16:45:10 -0700 (Thu, 03 Jun 2010) $' 
 * '$Revision: 24730 $'
 * 
 * Permission is hereby granted, without written agreement and without
 * license or royalty fees, to use, copy, modify, and distribute this
 * software and its documentation for any purpose, provided that the above
 * copyright notice and the following two paragraphs appear in all copies
 * of this software.
 *
 * IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
 * FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
 * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
 * THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 * THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
 * PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
 * CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
 * ENHANCEMENTS, OR MODIFICATIONS.
 *
 */
package org.kepler.workflowscheduler.gui.configurationwizard;

import java.awt.BorderLayout;
import java.awt.Cursor;
import java.awt.Dimension;
import java.awt.GridBagConstraints;
import java.awt.GridBagLayout;
import java.awt.Insets;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.awt.event.WindowAdapter;
import java.awt.event.WindowEvent;
import java.util.Vector;

import javax.swing.BorderFactory;
import javax.swing.Box;
import javax.swing.BoxLayout;
import javax.swing.JButton;
import javax.swing.JDialog;
import javax.swing.JLabel;
import javax.swing.JOptionPane;
import javax.swing.JPanel;
import javax.swing.JTextField;
import javax.swing.border.Border;
import javax.swing.border.EtchedBorder;

import org.kepler.configuration.ConfigurationManagerException;
import org.kepler.configuration.ConfigurationProperty;
import org.kepler.configuration.NamespaceException;
import org.kepler.gui.state.StateChangeEvent;
import org.kepler.gui.state.StateChangeMonitor;
import org.kepler.module.workflowschedulergui.Initialize;
import org.kepler.workflowscheduler.gui.WorkflowRunEngine;
import org.kepler.workflowscheduler.gui.WorkflowSchedulerPanel;

import ptolemy.actor.gui.TableauFrame;
import ptolemy.kernel.util.NamedObj;


/**
 * A dialog to configure the workflow run engines.
 * @author tao
 *
 */
public class WorkflowRunEngineConfigurationDialog extends JDialog
{
  private static final String TITLE = "Workflow Run Engine Configuration";
  private static final String DEFAULTNAME = "The Run Engine Name";
  private static final String DEFAULTURL = "http://yourhostname/workflowrunengine/services/KeplerWebService";
  public static final String URLAPPENDIX = "?wsdl";
  private static final int WIDTH = 800;
  private static final int HEIGHT = 500;
  static final int LEADSPACESIZE = 50; // leading space of each row
  static final int TEXTFIELDSIZE = 600;
  private TableauFrame parent = null;
  private GridBagConstraints textFieldConstraint = null;
  private GridBagConstraints labelConstraint = null;
  private GridBagConstraints lastConstraint = null;
  private JTextField nameTextField = null;
  private JTextField urlTextField = null;
  private JPanel mainPanel = null;
  private JPanel addingEnginePanel = null;
  private KnownWorkflowRunEnginePanel knownRunEnginePanel = null;
  //private CompletingConfigurationListenerInterface completeListener = null;
  
  /**
   * Constructor
   */
  public WorkflowRunEngineConfigurationDialog(TableauFrame parent)
  {
    //super(parent);
    this.parent = parent;
    //this.completeListener = completeListener;
    init();
    this.pack();
    this.setVisible(true);
  }
  
  
  /*
   * Initialize the dialog
   */
  private void init()
  {
    setPreferredSize(new Dimension(WIDTH, HEIGHT));    
    if(parent != null)
    {
      setLocation(parent.getLocation());
    }
    setTitle(TITLE);
    setModal(true);
    setLayout(new BorderLayout());
    addWindowListener(new DialogWindowAdapter(this));
    initializeGridBagLayout();
    initMainPanel();
    initCloseButtonPanel();
  }
  
  /*
   * Initialize the grid bag layout manager
   */
  private void initializeGridBagLayout()
  {
    textFieldConstraint = new GridBagConstraints();
    textFieldConstraint.fill = GridBagConstraints.HORIZONTAL;
    //lastConstraint.anchor = GridBagConstraints.NORTHWEST;
    // Give the "last" component as much space as possible
    textFieldConstraint.weightx = 1.0;
    //textFieldConstraint.gridwidth = GridBagConstraints.RELATIVE;     
    textFieldConstraint.insets = new Insets(4, 4, 4, 4);

    lastConstraint = (GridBagConstraints) textFieldConstraint.clone();
    //These still get as much space as possible, but do
    //not close out a row
    lastConstraint.gridwidth = GridBagConstraints.REMAINDER;

    // first component (usually it is a label) on each row
    labelConstraint = (GridBagConstraints) textFieldConstraint.clone();
    // Give these as little space as necessary
    labelConstraint.weightx = 0.0;
    labelConstraint.gridwidth = 1;

  }
  
  /*
   * MainPanel will contain two parts:
   * 1. AddingEnginePanel - contains text input fields and add button
   * 2. KnownWorkflowRunEngine panle - displays the known engines.
   */
  private void initMainPanel()
  {
    mainPanel = new JPanel();
    mainPanel.setLayout(new BorderLayout());
    Border compound = BorderFactory.createCompoundBorder(
        BorderFactory.createEtchedBorder(EtchedBorder.RAISED), 
        BorderFactory.createEtchedBorder(EtchedBorder.LOWERED));
    compound = BorderFactory.createCompoundBorder(
        BorderFactory.createEmptyBorder(12, 5, 5, 5), compound);
    mainPanel.setBorder(compound);
    initAddingEnginePanel();
    mainPanel.add(addingEnginePanel, BorderLayout.CENTER);
    WorkflowRunEngine[] engineList = getWorkflowRunEngineArrayFromConfig();
    knownRunEnginePanel =  new KnownWorkflowRunEnginePanel(engineList);
    mainPanel.add(knownRunEnginePanel, BorderLayout.SOUTH);
    add(mainPanel, BorderLayout.CENTER);
  }
  
  /*
   * Initialize the panel adding workflow run engine name and url.
   * It has a panel for two text fields which user can input engine name and url.
   * It also has a panel for the add button
   */
  private void initAddingEnginePanel()
  {
    addingEnginePanel = new JPanel();
    addingEnginePanel.setLayout(new BorderLayout());
    initNameAndURLInputPanel();
    initAddButtonPanel();
  }
  
  private void initNameAndURLInputPanel()
  {
    JPanel nameAndURLPanel = new JPanel();
    GridBagLayout gridbag = new GridBagLayout();
    nameAndURLPanel.setLayout(gridbag);
    
    //name row
    WorkflowSchedulerURLConfigurationDialog.addLeadingSpace(nameAndURLPanel, gridbag, labelConstraint);
    JLabel nameLabel = new JLabel("Name          ");
    WorkflowSchedulerPanel.addComponent(nameAndURLPanel, nameLabel, gridbag, labelConstraint);
    nameTextField = new JTextField();
    nameTextField.setText(DEFAULTNAME);
    WorkflowSchedulerPanel.addFixWidthComponent(nameAndURLPanel, nameTextField , gridbag, textFieldConstraint);
    WorkflowSchedulerURLConfigurationDialog.addEndingSpace(nameAndURLPanel, gridbag,lastConstraint);
    
    //url row
    WorkflowSchedulerURLConfigurationDialog.addLeadingSpace(nameAndURLPanel, gridbag, labelConstraint);
    JLabel urlLabel = new JLabel("URL          ");
    WorkflowSchedulerPanel.addComponent(nameAndURLPanel, urlLabel, gridbag, labelConstraint);
    urlTextField = new JTextField();
    urlTextField.setText(DEFAULTURL);
    WorkflowSchedulerPanel.addFixWidthComponent(nameAndURLPanel, urlTextField , gridbag, textFieldConstraint);
    WorkflowSchedulerURLConfigurationDialog.addEndingSpace(nameAndURLPanel, gridbag,lastConstraint);
    
    addingEnginePanel.add(nameAndURLPanel, BorderLayout.CENTER);
  }
  
  /*
   * Initialize the button panel which contains the add button.
   * This button panel will be added to addingEnginePanel
   */
  private void initAddButtonPanel()
  {
    JPanel buttonPanel = new JPanel();
    buttonPanel.setLayout(new BoxLayout(buttonPanel, BoxLayout.X_AXIS));
    buttonPanel.setBorder(BorderFactory.createEmptyBorder(10, 10, 10, 15));
    buttonPanel.add(Box.createHorizontalGlue());
    JButton addButton = new JButton("Add");
    addButton.setPreferredSize(new Dimension(100, 50));
    addButton.addActionListener(new ActionListener()
    {
      public void actionPerformed(ActionEvent e)
      {
        try
        {
          String url = urlTextField.getText();
          String name = nameTextField.getText();
          String urlWithAppendix = url+URLAPPENDIX;
          if(WorkflowSchedulerURLConfigurationDialog.openURL(urlWithAppendix))
          {
            if(name != null && !name.trim().equals(""))
            {
              WorkflowRunEngine engine = new WorkflowRunEngine(name);
              engine.setURL(url);
              addRunEngineToConfig(engine);
              addEngineToKnownWorkflowRunEnginePanel(engine);
             
            }
            else
            {
              JOptionPane.showMessageDialog(null, "Workflow Run Engine name couldn't be blank", "Error", JOptionPane.ERROR_MESSAGE);
            }
          }
          
        }
        catch(Exception ee)
        {
          ee.printStackTrace();
          JOptionPane.showMessageDialog(null, "Couldn't add the new Run Enginel - "+ee.getMessage(), "Error", JOptionPane.ERROR_MESSAGE);
        }
      }
    });  
    buttonPanel.add(addButton);
    addingEnginePanel.add(buttonPanel, BorderLayout.SOUTH);
  }
  
  /*
   * Initialize the panel containing the close button which close the dialog(top level)
   */
  private void initCloseButtonPanel()
  {
    JPanel buttonPanel = new JPanel();
    buttonPanel.setLayout(new BoxLayout(buttonPanel, BoxLayout.X_AXIS));
    buttonPanel.setBorder(BorderFactory.createEmptyBorder(10, 10, 10, 10));
    buttonPanel.add(Box.createHorizontalGlue());
    JButton cancelButton = new JButton("Close");
    cancelButton.setPreferredSize(new Dimension(100, 50));
    cancelButton.addActionListener(new ActionListener()
    {
      public void actionPerformed(ActionEvent e)
      {
        /*if(completeListener != null)
        {
          //System.out.println("calling complete method .....");
          completeListener.completeConfiguration();
        }*/
        setCursor(Cursor.getPredefinedCursor(Cursor.WAIT_CURSOR));
        fireConfigChangeEvent();
        setCursor(Cursor.getPredefinedCursor(Cursor.DEFAULT_CURSOR));
        dispose();
      }
    });   
    buttonPanel.add(cancelButton);
    //buttonPanel.add(Box.createHorizontalStrut(10));
    this.add(buttonPanel, BorderLayout.SOUTH);
  }
  
  /*
   * A method will add a workflow run engine to the configuration
   */
  private void addRunEngineToConfig(WorkflowRunEngine engine) throws ConfigurationManagerException, NamespaceException
  {
    String newURL = engine.getURL();
    String name = engine.getName();
    ConfigurationProperty rootProperty = Initialize.getCurrentModuleProperty();
    ConfigurationProperty engineListProperty = rootProperty.getProperty(Initialize.WORKFLOWRUNENGINELIST);
    if(engineListProperty == null)
    {
      //add a new engine property
      engineListProperty =  new ConfigurationProperty(Initialize.getCurrentModule(), Initialize.WORKFLOWRUNENGINELIST);
      rootProperty.addProperty(engineListProperty);
      
    }
    ConfigurationProperty engineProperty = new ConfigurationProperty(Initialize.getCurrentModule(),Initialize.WORKFLOWRUNENGINE);
    //add a new engine property to the engine list property
    ConfigurationProperty urlProperty = new ConfigurationProperty(Initialize.getCurrentModule(), Initialize.URL, newURL);
    ConfigurationProperty nameProperty = new ConfigurationProperty(Initialize.getCurrentModule(), Initialize.NAME, name);
    engineProperty.addProperty(nameProperty);
    engineProperty.addProperty(urlProperty);
    engineListProperty.addProperty(engineProperty);
  }
  
  /*
   * Update the known workflow run engine panel after adding a new engine
   */
  private void addEngineToKnownWorkflowRunEnginePanel(WorkflowRunEngine engine)
  {    
    knownRunEnginePanel.add(engine);
  }
  
  /*
   * Get the array of workflow run engine from configuration.
   * null will be return if we can't find one.
   */
  private WorkflowRunEngine[] getWorkflowRunEngineArrayFromConfig()
  {
    WorkflowRunEngine[] engineList = null;
    Vector<WorkflowRunEngine> engineVector = Initialize.getWorkflowRunEngineList();
    if(engineVector != null && engineVector.size() > 0)
    {
      engineList = new WorkflowRunEngine[engineVector.size()];
      engineVector.toArray(engineList);
    }
    return engineList;
  }
  
  /*
   * Fire a configuration change event
   */
  private void fireConfigChangeEvent()
  {
    NamedObj reference = null;
    StateChangeEvent event = new StateChangeEvent(this,WorkflowSchedulerConfigEvent.MODIFYCONFIGEVENT, reference);
    StateChangeMonitor.getInstance().notifyStateChange(event);
  }
  
  /*
   * A customized window adapter: the dialog box will be set invisible
   * when users close the dialog.
   */
  private class DialogWindowAdapter extends WindowAdapter
  {
    private JDialog dialog = null;
    
    /**
     * Constructor
     * @param dialog
     */
    public DialogWindowAdapter(JDialog dialog)
    {
      this.dialog = dialog;
    }
    
    /**
     * Set the dialog box invisible
     */
    public void windowClosing(WindowEvent e) 
    {
      /*if(completeListener != null)
      {
        //System.out.println("calling complete method .....");
        completeListener.completeConfiguration();
      }*/
      fireConfigChangeEvent();
      if(dialog != null)
      {
        dialog.dispose();
      }
      
    }
  }
}