remove duplicate host URLs in service list when not indexing services by host
[jalview.git] / src / jalview / ws / jws2 / Jws2Discoverer.java
index 784ff49..ceff8e4 100644 (file)
@@ -1,28 +1,38 @@
 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.ws.client.Jws2Base;
-import compbio.ws.client.Jws2Base.Services;
+import compbio.metadata.RunnerConfig;
+import compbio.ws.client.Jws2Client;
+import compbio.ws.client.Services;
 
 /**
  * discoverer for jws2 services. Follows the lightweight service discoverer
@@ -61,11 +71,12 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
   }
 
   boolean running = false;
-  Thread oldthread=null;
-  @Override
+
+  Thread oldthread = null;
+
   public void run()
   {
-    if (running && oldthread!=null && oldthread.isAlive())
+    if (running && oldthread != null && oldthread.isAlive())
     {
       return;
     }
@@ -74,7 +85,7 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
     try
     {
       Class foo = getClass().getClassLoader().loadClass(
-              "compbio.ws.client.Jws2Base");
+              "compbio.ws.client.Jws2Client");
     } catch (ClassNotFoundException e)
     {
       System.err
@@ -91,15 +102,15 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
     {
       try
       {
-        if (Jws2Base.validURL(jwsservers))
+        if (Jws2Client.validURL(jwsservers))
         {
           // look for services
-          for (Services srv : Jws2Base.Services.values())
+          for (Services srv : Services.values())
           {
             MsaWS service = null;
             try
             {
-              service = Jws2Base.connect(jwsservers, srv);
+              service = Jws2Client.connect(jwsservers, srv);
             } catch (Exception e)
             {
               System.err.println("Jws2 Discoverer: Problem on "
@@ -151,17 +162,19 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
     }
     System.out.println("Discovered service: " + jwsservers + " "
             + srv.toString());
-    services.add(new Jws2Instance(jwsservers, "Align with "
-            + srv.toString(), service2));
+    Jws2Instance service = new Jws2Instance(jwsservers, srv.toString(), service2);
+
+    services.add(service);
+    service.getParamStore();
   }
 
   public class Jws2Instance
   {
-    String hosturl;
+    public String hosturl;
 
-    String serviceType;
+    public String serviceType;
 
-    MsaWS service;
+    public MsaWS service;
 
     public Jws2Instance(String hosturl, String serviceType, MsaWS service)
     {
@@ -173,6 +186,8 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
 
     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)
@@ -195,29 +210,199 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
       }
       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+"/"+serviceType;
+    }
   };
 
   /**
    * holds list of services.
    */
-  Vector<Jws2Instance> 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;
+
+  }
 
-  @Override
   public void attachWSMenuEntry(JMenu wsmenu, final AlignFrame alignFrame)
   {
+    // dynamically regenerate service list.
+    final JMenu jws2al = new JMenu("JABA 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 jws2 = new JMenu("JWS2 Alignment");
+    JMenu atpoint;
     MsaWSClient msacl = new MsaWSClient();
+    Vector hostLabels = new Vector();
+    jws2al.removeAll();
+    String lasthost=null;
     for (final Jws2Instance service : services)
     {
-      msacl.attachWSMenuEntry(jws2, service, alignFrame);
+      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.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);
+        }
+        hostLabels.addElement(lasthost=host);
+      }
+      msacl.attachWSMenuEntry(atpoint, service, alignFrame);
       /*
        * JMenuItem sitem = new JMenuItem(service.serviceType);
        * sitem.setToolTipText("Hosted at " + service.hosturl);
@@ -230,11 +415,6 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
        * alignFrame); } });
        */
     }
-    if (services.size() > 0)
-    {
-      wsmenu.add(jws2);
-    }
-
   }
 
   public static void main(String[] args)
@@ -243,7 +423,6 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
     getDiscoverer().addPropertyChangeListener(new PropertyChangeListener()
     {
 
-      @Override
       public void propertyChange(PropertyChangeEvent evt)
       {
         System.out.println("Changesupport: There are now "
@@ -313,7 +492,7 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
   public static Vector<String> getServiceUrls()
   {
     String surls = Cache.getDefault(JWS2HOSTURLS,
-            "http://webservices.compbio.dundee.ac.uk:8084/jws2");
+            "http://www.compbio.dundee.ac.uk/jabaws");
     Vector<String> urls = new Vector<String>();
     try
     {
@@ -359,4 +538,35 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
     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;
+  }
+
 }