/*
 * Jalview - A Sequence Alignment Editor and Viewer (Version 2.6)
 * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle
 * 
 * This file is part of Jalview.
 * 
 * Jalview 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.
 * 
 * Jalview 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 Jalview.  If not, see <http://www.gnu.org/licenses/>.
 */
package jalview.ws.jws2;

import java.awt.Color;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.beans.PropertyChangeEvent;
import java.beans.PropertyChangeListener;
import java.io.Closeable;
import java.net.ConnectException;
import java.net.URL;
import java.util.HashSet;
import java.util.Hashtable;
import java.util.StringTokenizer;
import java.util.Vector;

import javax.swing.JMenu;
import javax.swing.JMenuItem;
import javax.swing.event.MenuEvent;
import javax.swing.event.MenuListener;

import org.apache.log4j.Level;

import jalview.bin.Cache;
import jalview.datamodel.AlignmentView;
import jalview.gui.AlignFrame;
import jalview.gui.Desktop;
import jalview.ws.WSMenuEntryProviderI;
import jalview.ws.params.ParamDatastoreI;
import compbio.data.msa.MsaWS;
import compbio.metadata.Option;
import compbio.metadata.Preset;
import compbio.metadata.PresetManager;
import compbio.metadata.RunnerConfig;
import compbio.ws.client.Jws2Client;
import compbio.ws.client.Services;

/**
 * discoverer for jws2 services. Follows the lightweight service discoverer
 * pattern (archetyped by EnfinEnvision2OneWay)
 * 
 * @author JimP
 * 
 */
public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
{
  private java.beans.PropertyChangeSupport changeSupport = new java.beans.PropertyChangeSupport(
          this);

  /**
   * change listeners are notified of "services" property changes
   * 
   * @param listener
   *          to be added that consumes new services Hashtable object.
   */
  public void addPropertyChangeListener(
          java.beans.PropertyChangeListener listener)
  {
    changeSupport.addPropertyChangeListener(listener);
  }

  /**
   * 
   * 
   * @param listener
   *          to be removed
   */
  public void removePropertyChangeListener(
          java.beans.PropertyChangeListener listener)
  {
    changeSupport.removePropertyChangeListener(listener);
  }

  boolean running = false;

  Thread oldthread = null;

  public void run()
  {
    if (running && oldthread != null && oldthread.isAlive())
    {
      return;
    }
    running = true;
    oldthread = Thread.currentThread();
    try
    {
      Class foo = getClass().getClassLoader().loadClass(
              "compbio.ws.client.Jws2Client");
    } catch (ClassNotFoundException e)
    {
      System.err
              .println("Not enabling Jalview Webservices version 2: client jar is not available."
                      + "\nPlease check that your webstart JNLP file is up to date!");
      running = false;
      return;
    }
    if (services != null)
    {
      services.removeAllElements();
    }
    for (String jwsservers : getServiceUrls())
    {
      try
      {
        if (Jws2Client.validURL(jwsservers))
        {
          // look for services
          for (Services srv : Services.values())
          {
            MsaWS service = null;
            try
            {
              service = Jws2Client.connect(jwsservers, srv);
            } catch (Exception e)
            {
              System.err.println("Jws2 Discoverer: Problem on "
                      + jwsservers + " with service " + srv + ":\n"
                      + e.getMessage());
              if (!(e instanceof javax.xml.ws.WebServiceException))
              {
                e.printStackTrace();
              }
            }
            ;
            if (service != null)
            {
              addService(jwsservers, srv, service);
            }
          }

        }
        else
        {
          Cache.log.info("Ignoring invalid Jws2 service url " + jwsservers);
        }
      } catch (Exception e)
      {
        e.printStackTrace();
        Cache.log.warn("Exception when discovering Jws2 services.", e);
      } catch (Error e)
      {
        Cache.log.error("Exception when discovering Jws2 services.", e);
      }
    }
    oldthread = null;
    running = false;
    changeSupport.firePropertyChange("services", new Vector(), services);
  }

  /**
   * record this service endpoint so we can use it
   * 
   * @param jwsservers
   * @param srv
   * @param service2
   */
  private void addService(String jwsservers, Services srv, MsaWS service2)
  {
    if (services == null)
    {
      services = new Vector<Jws2Instance>();
    }
    System.out.println("Discovered service: " + jwsservers + " "
            + srv.toString());
    Jws2Instance service = new Jws2Instance(jwsservers, srv.toString(),
            service2);

    services.add(service);
    // retrieve the presets and parameter set and cache now
    service.getParamStore().getPresets();
    service.hasParameters();
  }

  public class Jws2Instance
  {
    public String hosturl;

    public String serviceType;

    public MsaWS service;

    public Jws2Instance(String hosturl, String serviceType, MsaWS service)
    {
      super();
      this.hosturl = hosturl;
      this.serviceType = serviceType;
      this.service = service;
    }

    PresetManager presets = null;

    public JabaParamStore paramStore = null;

    /**
     * non thread safe - gets the presets for this service (blocks whilst it
     * calls the service to get the preset set)
     * 
     * @return service presets or null if exceptions were raised.
     */
    public PresetManager getPresets()
    {
      if (presets == null)
      {
        try
        {
          presets = service.getPresets();
        } catch (Exception ex)
        {
          System.err
                  .println("Exception when retrieving presets for service "
                          + serviceType + " at " + hosturl);
        }
      }
      return presets;
    }

    public String getHost()
    {
      return hosturl;
      /*
       * try { URL serviceurl = new URL(hosturl); if (serviceurl.getPort()!=80)
       * { return serviceurl.getHost()+":"+serviceurl.getPort(); } return
       * serviceurl.getHost(); } catch (Exception e) {
       * System.err.println("Failed to parse service URL '" + hosturl +
       * "' as a valid URL!"); } return null;
       */
    }

    /**
     * @return short description of what the service will do
     */
    public String getActionText()
    {
      return "Align with " + serviceType;
    }

    /**
     * non-thread safe - blocks whilst accessing service to get complete set of
     * available options and parameters
     * 
     * @return
     */
    public RunnerConfig getRunnerConfig()
    {
      return service.getRunnerOptions();
    }

    @Override
    protected void finalize() throws Throwable
    {
      if (service != null)
      {
        try
        {
          Closeable svc = (Closeable) service;
          service = null;
          svc.close();
        } catch (Exception e)
        {
        }
        ;
      }
      super.finalize();
    }

    public ParamDatastoreI getParamStore()
    {
      if (paramStore == null)
      {
        try
        {
          paramStore = new JabaParamStore(this,
                  (Desktop.instance != null ? Desktop
                          .getUserParameterStore() : null));
        } catch (Exception ex)
        {
        }

      }
      return paramStore;
    }

    public String getUri()
    {
      // this is only valid for Jaba 1.0 - this formula might have to change!
      return hosturl
              + (hosturl.lastIndexOf("/") == (hosturl.length() - 1) ? "/"
                      : "") + serviceType;
    }

    private boolean hasParams = false, lookedForParams = false;

    public boolean hasParameters()
    {
      if (!lookedForParams)
      {
        lookedForParams = true;
        try
        {
          hasParams = (getRunnerConfig().getArguments().size() > 0);
        } catch (Exception e)
        {

        }
      }
      return hasParams;
    }
  };

  /**
   * holds list of services.
   */
  protected Vector<Jws2Instance> services;

  /**
   * find or add a submenu with the given title in the given menu
   * 
   * @param menu
   * @param submenu
   * @return the new or existing submenu
   */
  private JMenu findOrCreateMenu(JMenu menu, String submenu)
  {
    JMenu submenuinstance = null;
    for (int i = 0, iSize = menu.getMenuComponentCount(); i < iSize; i++)
    {
      if (menu.getMenuComponent(i) instanceof JMenu
              && ((JMenu) menu.getMenuComponent(i)).getText().equals(
                      submenu))
      {
        submenuinstance = (JMenu) menu.getMenuComponent(i);
      }
    }
    if (submenuinstance == null)
    {
      submenuinstance = new JMenu(submenu);
      menu.add(submenuinstance);
    }
    return submenuinstance;

  }

  public void attachWSMenuEntry(JMenu wsmenu, final AlignFrame alignFrame)
  {
    // dynamically regenerate service list.
    final JMenu jws2al = new JMenu("JABAWS Alignment");
    jws2al.addMenuListener(new MenuListener()
    {
      // TODO: future: add menu listener to parent menu - so submenus are
      // populated *before* they are selected.
      @Override
      public void menuSelected(MenuEvent e)
      {
        populateWSMenuEntry(jws2al, alignFrame);
      }

      @Override
      public void menuDeselected(MenuEvent e)
      {
        // TODO Auto-generated method stub

      }

      @Override
      public void menuCanceled(MenuEvent e)
      {
        // TODO Auto-generated method stub

      }

    });
    wsmenu.add(jws2al);

  }

  private void populateWSMenuEntry(JMenu jws2al, final AlignFrame alignFrame)
  {
    if (running || services == null || services.size() == 0)
    {
      return;
    }
    boolean byhost = Cache.getDefault("WSMENU_BYHOST", true), bytype = Cache
            .getDefault("WSMENU_BYTYPE", true);
    /**
     * eventually, JWS2 services will appear under the same align/etc submenus.
     * for moment we keep them separate.
     */
    JMenu atpoint;
    MsaWSClient msacl = new MsaWSClient();
    Vector hostLabels = new Vector();
    jws2al.removeAll();
    String lasthost = null;
    for (final Jws2Instance service : services)
    {
      atpoint = jws2al;
      String host = service.getHost();
      String type = service.serviceType;
      if (byhost)
      {
        atpoint = findOrCreateMenu(atpoint, host);
        if (atpoint.getToolTipText() == null)
        {
          atpoint.setToolTipText("Services at " + host);
        }
      }
      if (bytype)
      {
        atpoint = findOrCreateMenu(atpoint, type);
        if (atpoint.getToolTipText() == null)
        {
          atpoint.setToolTipText(service.getActionText());
        }
      }
      if (!byhost
              && !hostLabels.contains(host + service.serviceType
                      + service.getActionText()))
      // !hostLabels.contains(host + (bytype ?
      // service.serviceType+service.getActionText() : "")))
      {
        // add a marker indicating where this service is hosted
        // relies on services from the same host being listed in a contiguous
        // group
        JMenuItem hitm;
        atpoint.addSeparator();
        if (lasthost == null || !lasthost.equals(host))
        {
          atpoint.add(hitm = new JMenuItem(host));
          hitm.setForeground(Color.blue);
          lasthost = host;
        }
        hostLabels.addElement(host + service.serviceType
                + service.getActionText());
        // hostLabels.addElement(host + (bytype ?
        // service.serviceType+service.getActionText() : ""));
      }
      msacl.attachWSMenuEntry(atpoint, service, alignFrame);
      /*
       * JMenuItem sitem = new JMenuItem(service.serviceType);
       * sitem.setToolTipText("Hosted at " + service.hosturl);
       * sitem.addActionListener(new ActionListener() {
       * 
       * @Override public void actionPerformed(ActionEvent e) { AlignmentView
       * msa = alignFrame.gatherSequencesForAlignment(); MsaWSClient client =
       * new MsaWSClient(service, "JWS2 Alignment of " + alignFrame.getTitle(),
       * msa, false, true, alignFrame.getViewport().getAlignment().getDataset(),
       * alignFrame); } });
       */
    }
  }

  public static void main(String[] args)
  {
    Thread runner = new Thread(getDiscoverer());
    getDiscoverer().addPropertyChangeListener(new PropertyChangeListener()
    {

      public void propertyChange(PropertyChangeEvent evt)
      {
        System.out.println("Changesupport: There are now "
                + getDiscoverer().services.size() + " services");
      }
    });
    runner.start();
    while (runner.isAlive())
    {
      try
      {
        Thread.sleep(50);
      } catch (InterruptedException e)
      {
      }
      ;
    }
  }

  private static Jws2Discoverer discoverer;

  public static Jws2Discoverer getDiscoverer()
  {
    if (discoverer == null)
    {
      discoverer = new Jws2Discoverer();
    }
    return discoverer;
  }

  public boolean hasServices()
  {
    // TODO Auto-generated method stub
    return !running && services != null && services.size() > 0;
  }

  public boolean isRunning()
  {
    return running;
  }

  /**
   * the jalview .properties entry for JWS2 URLS
   */
  final static String JWS2HOSTURLS = "JWS2HOSTURLS";

  public static void setServiceUrls(Vector<String> urls)
  {
    if (urls != null)
    {
      StringBuffer urlbuffer = new StringBuffer();
      String sep = "";
      for (String url : urls)
      {
        urlbuffer.append(sep);
        urlbuffer.append(url);
        sep = ",";
      }
      Cache.setProperty(JWS2HOSTURLS, urlbuffer.toString());
    }
    else
    {
      Cache.removeProperty(JWS2HOSTURLS);
    }
  }

  public static Vector<String> getServiceUrls()
  {
    String surls = Cache.getDefault(JWS2HOSTURLS,
            "http://www.compbio.dundee.ac.uk/jabaws");
    Vector<String> urls = new Vector<String>();
    try
    {
      StringTokenizer st = new StringTokenizer(surls, ",");
      while (st.hasMoreElements())
      {
        String url = null;
        try
        {
          java.net.URL u = new java.net.URL(url = st.nextToken());
          if (!urls.contains(url))
          {
            urls.add(url);
          }
          else
          {
            jalview.bin.Cache.log.info("Ignoring duplicate url in "
                    + JWS2HOSTURLS + " list");
          }
        } catch (Exception ex)
        {
          jalview.bin.Cache.log
                  .warn("Problem whilst trying to make a URL from '"
                          + ((url != null) ? url : "<null>") + "'");
          jalview.bin.Cache.log
                  .warn("This was probably due to a malformed comma separated list"
                          + " in the "
                          + JWS2HOSTURLS
                          + " entry of $(HOME)/.jalview_properties)");
          jalview.bin.Cache.log.debug("Exception was ", ex);
        }
      }
    } catch (Exception ex)
    {
      jalview.bin.Cache.log.warn(
              "Error parsing comma separated list of urls in "
                      + JWS2HOSTURLS + " preference.", ex);
    }
    if (urls.size() >= 0)
    {
      return urls;
    }
    return null;
  }

  public Vector<Jws2Instance> getServices()
  {
    return (services == null) ? new Vector<Jws2Instance>()
            : new Vector<Jws2Instance>(services);
  }

  /**
   * test the given URL with the JabaWS test code
   * 
   * @param foo
   * @return
   */
  public static boolean testServiceUrl(URL foo)
  {
    try
    {
      compbio.ws.client.WSTester.main(new String[]
      { "-h=" + foo.toString() });
    } catch (Exception e)
    {
      return false;
    } catch (OutOfMemoryError e)
    {
      return false;
    } catch (Error e)
    {
      return false;
    }
    return true;
  }

}