(JAL-976) - consistent ordering of services according to server URLs and debugging...
[jalview.git] / src / jalview / ws / jws2 / Jws2Discoverer.java
index 8907b58..afeb53a 100644 (file)
@@ -44,6 +44,7 @@ import jalview.gui.AlignFrame;
 import jalview.gui.Desktop;
 import jalview.gui.JalviewChangeSupport;
 import jalview.gui.JvSwingUtils;
+import jalview.util.jarInputStreamProvider;
 import jalview.ws.WSMenuEntryProviderI;
 import jalview.ws.jws2.jabaws2.Jws2Instance;
 import compbio.data.msa.JABAService;
@@ -132,6 +133,7 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
       Cache.log.debug("Old discovery thread has finished.");
     }
     running = true;
+    changeSupport.firePropertyChange("services", services, new Vector());
     oldthread = Thread.currentThread();
     try
     {
@@ -158,17 +160,28 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
     {
       invalidServiceUrls.removeAllElements();
     }
+    ArrayList<String> svctypes=new ArrayList<String>();
 
     List<JabaWsServerQuery> qrys = new ArrayList<JabaWsServerQuery>();
     for (final String jwsservers : getServiceUrls())
     {
       JabaWsServerQuery squery = new JabaWsServerQuery(this, jwsservers);
+      if (svctypes.size()==0)
+      {
+        // TODO: remove this ugly hack to get Canonical JABA service ordering for all possible services 
+        for (Services sv:squery.JABAWS2SERVERS)
+        {
+          svctypes.add(sv.toString());
+        }
+
+      }
       qrys.add(squery);
       new Thread(squery).start();
     }
-    boolean finished = false;
+    boolean finished = true;
     do
     {
+      finished=true;
       try
       {
         Thread.sleep(100);
@@ -178,7 +191,7 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
       ;
       for (JabaWsServerQuery squery : qrys)
       {
-        finished |= !squery.isRunning();
+        finished = finished && !squery.isRunning();
       }
       if (aborted)
       {
@@ -190,12 +203,32 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
         }
       }
     } while (!aborted && !finished);
-    oldthread = null;
-    running = false;
     if (!aborted)
     {
-      changeSupport.firePropertyChange("services", new Vector(), services);
+      // resort services according to order found in jabaws service list
+      // also ensure servics for each host are ordered in same way.
+      
+      if (services!=null && services.size()>0)
+      {
+        Jws2Instance[] svcs=new Jws2Instance[services.size()];
+        int[] spos=new int[services.size()];
+        int ipos=0;
+        Vector svcUrls = getServiceUrls();
+        for (Jws2Instance svc:services)
+        {
+          svcs[ipos]=svc;
+          spos[ipos++]=1000*svcUrls.indexOf(svc.getHost()) + 1+svctypes.indexOf(svc.serviceType);
+        }
+        jalview.util.QuickSort.sort(spos, svcs);
+        services=new Vector<Jws2Instance>();
+        for (Jws2Instance svc:svcs) {
+          services.add(svc);
+        }
+      }
     }
+    oldthread = null;
+    running = false;
+    changeSupport.firePropertyChange("services", new Vector(), services);
   }
 
   /**
@@ -205,17 +238,16 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
    * @param srv
    * @param service2
    */
-  synchronized void addService(String jwsservers, Services srv,
-          MsaWS service2)
+  synchronized void addService(String jwsservers, Jws2Instance service)
   {
     if (services == null)
     {
       services = new Vector<Jws2Instance>();
     }
     System.out.println("Discovered service: " + jwsservers + " "
-            + srv.toString());
-    Jws2Instance service = new Jws2Instance(jwsservers, srv.toString(),
-            service2);
+            + service.toString());
+//    Jws2Instance service = new Jws2Instance(jwsservers, srv.toString(),
+//            service2);
 
     services.add(service);
     // retrieve the presets and parameter set and cache now
@@ -227,41 +259,16 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
    * holds list of services.
    */
   protected Vector<Jws2Instance> services;
-
+  /**
+   * attach all available web services to the appropriate submenu in the given JMenu
+   */
   public void attachWSMenuEntry(JMenu wsmenu, final AlignFrame alignFrame)
   {
     // dynamically regenerate service list.
-    final JMenu jws2al = wsmenu; // 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);
-
+    populateWSMenuEntry(wsmenu, alignFrame, null);
   }
 
-  private void populateWSMenuEntry(JMenu jws2al, final AlignFrame alignFrame)
+  private void populateWSMenuEntry(JMenu jws2al, final AlignFrame alignFrame, String typeFilter)
   {
     if (running || services == null || services.size() == 0)
     {
@@ -277,9 +284,9 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
     MsaWSClient msacl = new MsaWSClient();
     Vector hostLabels = new Vector();
     jws2al.removeAll();
-    String lasthost = null;
+    Hashtable<String,String> lasthostFor = new Hashtable<String,String>();
     Hashtable<String, ArrayList<Jws2Instance>> hosts = new Hashtable<String, ArrayList<Jws2Instance>>();
-    String[] sorton;
+    ArrayList<String> hostlist=new ArrayList<String>();
     for (Jws2Instance service : services)
     {
       ArrayList<Jws2Instance> hostservices = hosts.get(service.getHost());
@@ -287,12 +294,11 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
       {
         hosts.put(service.getHost(),
                 hostservices = new ArrayList<Jws2Instance>());
+        hostlist.add(service.getHost());
       }
       hostservices.add(service);
     }
-    sorton = hosts.keySet().toArray(new String[1]);
-    String hostlist[] = sorton.clone();
-    jalview.util.QuickSort.sort(sorton, hostlist);
+    // now add hosts in order of the given array
     for (String host : hostlist)
     {
       Jws2Instance orderedsvcs[] = hosts.get(host).toArray(
@@ -305,7 +311,7 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
       jalview.util.QuickSort.sort(sortbytype, orderedsvcs);
       for (final Jws2Instance service : orderedsvcs)
       {
-        atpoint = jws2al;
+        atpoint = JvSwingUtils.findOrCreateMenu(jws2al,service.action);
         String type = service.serviceType;
         if (byhost)
         {
@@ -335,7 +341,7 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
           // group
           JMenuItem hitm;
           atpoint.addSeparator();
-          if (lasthost == null || !lasthost.equals(host))
+          if (lasthostFor.get(service.action) == null || !lasthostFor.get(service.action).equals(host))
           {
             atpoint.add(hitm = new JMenuItem(host));
             hitm.setForeground(Color.blue);
@@ -350,14 +356,15 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
             });
             hitm.setToolTipText(JvSwingUtils
                     .wrapTooltip("Opens the JABAWS server's homepage in web browser"));
-            lasthost = host;
+            lasthostFor.put(service.action,host);
           }
           hostLabels.addElement(host + service.serviceType
                   + service.getActionText());
           // hostLabels.addElement(host + (bytype ?
           // service.serviceType+service.getActionText() : ""));
         }
-        msacl.attachWSMenuEntry(atpoint, service, alignFrame);
+        
+        service.attachWSMenuEntry(atpoint, alignFrame);
         /*
          * JMenuItem sitem = new JMenuItem(service.serviceType);
          * sitem.setToolTipText("Hosted at " + service.hosturl);
@@ -377,6 +384,14 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
 
   public static void main(String[] args)
   {
+    if (args.length>0)
+    {
+      testUrls = new Vector<String>();
+      for (String url:args)
+      {
+        testUrls.add(url);
+      };
+    }
     Thread runner = getDiscoverer().startDiscoverer(
             new PropertyChangeListener()
             {
@@ -387,6 +402,11 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
                 {
                   System.out.println("Changesupport: There are now "
                           + getDiscoverer().services.size() + " services");
+                  int i=1;
+                  for (Jws2Instance instance:getDiscoverer().services)
+                  {
+                    System.out.println("Service "+i+++" "+instance.getClass()+"@"+instance.getHost()+": "+instance.getActionText());
+                  }
 
                 }
               }
@@ -401,6 +421,9 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
       }
       ;
     }
+    try {
+      Thread.sleep(50);
+    } catch (InterruptedException x) {}
   }
 
   private static Jws2Discoverer discoverer;
@@ -450,8 +473,14 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
     }
   }
 
+  private static Vector<String> testUrls=null;
   public static Vector<String> getServiceUrls()
   {
+    if (testUrls!=null)
+    {
+      // return test urls, if there are any, instead of touching cache
+      return testUrls;
+    }
     String surls = Cache.getDefault(JWS2HOSTURLS,
             "http://www.compbio.dundee.ac.uk/jabaws");
     Vector<String> urls = new Vector<String>();
@@ -660,5 +689,4 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
     }
     return null;
   }
-
 }