Merge branch 'develop' into update_212_Dec_merge_with_21125_chamges
[jalview.git] / src / jalview / ws / slivkaws / SlivkaWSDiscoverer.java
index 6b3856a..d21d5d1 100644 (file)
@@ -1,37 +1,42 @@
 package jalview.ws.slivkaws;
 
-import jalview.datamodel.AlignmentView;
-import jalview.gui.AlignFrame;
-import jalview.ws.WSMenuEntryProviderI;
-import jalview.ws.jws2.MsaWSClient;
-import jalview.ws.jws2.SequenceAnnotationWSClient;
-
-import java.awt.event.ActionEvent;
-import java.io.IOError;
-import java.io.IOException;
-import java.net.URISyntaxException;
-
-import javax.swing.JMenu;
-import javax.swing.JMenuItem;
+import jalview.bin.Cache;
+import jalview.bin.Console;
+import jalview.ws.ServiceChangeListener;
+import jalview.ws.WSDiscovererI;
+import jalview.ws.api.ServiceWithParameters;
+import javajs.http.HttpClientFactory;
 
+import java.io.IOException;
+import java.net.MalformedURLException;
+import java.net.URL;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+import java.util.Set;
+import java.util.Vector;
+import java.util.concurrent.CompletableFuture;
+import java.util.concurrent.CopyOnWriteArraySet;
+import java.util.concurrent.ExecutorService;
+import java.util.concurrent.Executors;
+import java.util.concurrent.Future;
+
+import compbio.data.msa.Category;
 import uk.ac.dundee.compbio.slivkaclient.SlivkaClient;
 import uk.ac.dundee.compbio.slivkaclient.SlivkaService;
 
-public class SlivkaWSDiscoverer implements Runnable, WSMenuEntryProviderI
+public class SlivkaWSDiscoverer implements WSDiscovererI
 {
+  private static final String SLIVKA_HOST_URLS = "SLIVKAHOSTURLS";
+
+  private static final String COMPBIO_SLIVKA = "https://www.compbio.dundee.ac.uk/slivka/";
+
   private static SlivkaWSDiscoverer instance = null;
 
-  private SlivkaClient client;
+  private List<ServiceWithParameters> services = List.of();
 
   private SlivkaWSDiscoverer()
   {
-    try
-    {
-      client = new SlivkaClient("gjb-www-1.cluster.lifesci.dundee.ac.uk", 3203);
-    } catch (URISyntaxException e)
-    {
-      throw new RuntimeException(e);
-    }
   }
 
   public static SlivkaWSDiscoverer getInstance()
@@ -43,109 +48,191 @@ public class SlivkaWSDiscoverer implements Runnable, WSMenuEntryProviderI
     return instance;
   }
 
+  private Set<ServiceChangeListener> serviceListeners = new CopyOnWriteArraySet<>();
+
+  @Override
+  public void addServiceChangeListener(ServiceChangeListener l)
+  {
+    serviceListeners.add(l);
+  }
+
   @Override
-  public void attachWSMenuEntry(JMenu wsmenu, final AlignFrame alignFrame)
+  public void removeServiceChangeListener(ServiceChangeListener l)
   {
-    JMenu slivkaMenu = new JMenu("Slivka");
-    wsmenu.add(slivkaMenu);
+    serviceListeners.remove(l);
+  }
 
-    JMenu alignmentMenu = new JMenu("Sequence Alignment");
-    slivkaMenu.add(alignmentMenu);
-    try
+  public void notifyServiceListeners(List<ServiceWithParameters> services)
+  {
+    for (var listener : serviceListeners)
     {
-      for (SlivkaService service : client.getServices())
+      listener.servicesChanged(this, services);
+    }
+  }
+
+  private final ExecutorService executor = Executors
+          .newSingleThreadExecutor();
+
+  private Vector<Future<?>> discoveryTasks = new Vector<>();
+
+  public CompletableFuture<WSDiscovererI> startDiscoverer()
+  {
+    CompletableFuture<WSDiscovererI> task = CompletableFuture
+            .supplyAsync(() -> {
+              reloadServices();
+              return SlivkaWSDiscoverer.this;
+            }, executor);
+    discoveryTasks.add(task);
+    return task;
+  }
+
+  private List<ServiceWithParameters> reloadServices()
+  {
+    Console.info("Reloading Slivka services");
+    notifyServiceListeners(Collections.emptyList());
+    ArrayList<ServiceWithParameters> instances = new ArrayList<>();
+
+    for (String url : getServiceUrls())
+    {
+      SlivkaClient client = new SlivkaClient(url);
+
+      List<SlivkaService> services;
+      try
+      {
+        services = client.getServices();
+      } catch (IOException e)
       {
-        msaClassifier:
+        e.printStackTrace();
+        continue;
+      }
+      for (SlivkaService service : services)
+      {
+        SlivkaWSInstance newInstance = null;
+        for (String classifier : service.classifiers)
         {
-          for (String classifier : service.classifiers)
+          String[] path = classifier.split("\\s*::\\s*");
+          if (path.length >= 3 && path[0].toLowerCase().equals("operation")
+                  && path[1].toLowerCase().equals("analysis"))
           {
-            if (classifier.contains("Multiple sequence alignment"))
+            switch (path[path.length - 1].toLowerCase())
             {
-              break msaClassifier;
+            case "rna secondary structure prediction":
+              newInstance = new RNAalifoldServiceInstance(client,
+                      service, "Secondary Structure Prediction");
+              break;
+            case "sequence alignment analysis (conservation)":
+              newInstance = new SlivkaAnnotationServiceInstance(client,
+                      service, Category.CATEGORY_CONSERVATION);
+              break;
+            case "protein sequence analysis":
+              newInstance = new SlivkaAnnotationServiceInstance(client,
+                      service, Category.CATEGORY_DISORDER);
+              break;
+            case "protein secondary structure prediction":
+              newInstance = new SlivkaAnnotationServiceInstance(client,
+                      service, "Secondary Structure Prediction");
+              break;
+            case "multiple sequence alignment":
+              newInstance = new SlivkaMsaServiceInstance(client, service,
+                      Category.CATEGORY_ALIGNMENT);
+              break;
             }
           }
-          continue;
+          if (newInstance != null)
+            break;
         }
-        SlivkaMsaServiceInstance instance = new SlivkaMsaServiceInstance(client, service);
-        JMenuItem defaultEntry = new JMenuItem(String.format("%s with defaults", service.label));
-        defaultEntry.addActionListener((ActionEvent evt) -> {
-          AlignmentView msa = alignFrame.gatherSequencesForAlignment();
-          if (msa != null)
-          {
-            new MsaWSClient(instance, alignFrame.getTitle(), msa, false, true,
-                alignFrame.getViewport().getAlignment().getDataset(), alignFrame);
-          }
-        });
-        alignmentMenu.add(defaultEntry);
+        if (newInstance != null)
+          instances.add(newInstance);
+      }
+    }
 
-        JMenuItem customEntry = new JMenuItem(String.format("%s with custom parameters", service.label));
-        customEntry.addActionListener((ActionEvent evt) -> {
-          AlignmentView msa = alignFrame.gatherSequencesForAlignment();
-          if (msa != null)
-          {
-            try
-            {
-              SlivkaParamSet paramSet = new SlivkaParamSet(service);
-              new MsaWSClient(instance, paramSet, null, true, alignFrame.getTitle(), msa, false, true,
-                  alignFrame.getViewport().getAlignment().getDataset(), alignFrame);
-            } catch (IOException exc)
-            {
-              throw new IOError(exc);
-            }
-          }
-        });
-        alignmentMenu.add(customEntry);
+    services = instances;
+    Console.info("Slivka services reloading finished");
+    notifyServiceListeners(instances);
+    return instances;
+  }
 
-        alignmentMenu.addSeparator();
-      }
-    } catch (IOException e)
+  @Override
+  public List<ServiceWithParameters> getServices()
+  {
+    return services;
+  }
+
+  @Override
+  public boolean hasServices()
+  {
+    return !isRunning() && services.size() > 0;
+  }
+
+  @Override
+  public boolean isRunning()
+  {
+    return !discoveryTasks.stream().allMatch(Future::isDone);
+  }
+
+  @Override
+  public void setServiceUrls(List<String> wsUrls)
+  {
+    if (wsUrls != null && !wsUrls.isEmpty())
     {
-      // TODO Auto-generated catch block
-      e.printStackTrace();
+      Cache.setProperty(SLIVKA_HOST_URLS, String.join(",", wsUrls));
     }
+    else
+    {
+      Cache.removeProperty(SLIVKA_HOST_URLS);
+    }
+  }
 
-    JMenu disorderMenu = new JMenu("Protein sequence analysis");
-    slivkaMenu.add(disorderMenu);
-    try
+  @Override
+  public List<String> getServiceUrls()
+  {
+    String surls = Cache.getDefault(SLIVKA_HOST_URLS, COMPBIO_SLIVKA);
+    String[] urls = surls.split(",");
+    ArrayList<String> valid = new ArrayList<>(urls.length);
+    for (String url : urls)
     {
-      for (SlivkaService service : client.getServices())
+      try
       {
-        msaClassifier:
-        {
-          for (String classifier : service.classifiers)
-          {
-            if (classifier.contains("Protein sequence analysis"))
-            {
-              break msaClassifier;
-            }
-          }
-          continue;
-        }
-        JMenuItem menuEntry = new JMenuItem(String.format("%s with custom parameters", service.label));
-        disorderMenu.add(menuEntry);
-        SlivkaAnnotationServiceInstance serviceInstance = new SlivkaAnnotationServiceInstance(client, service);
-        menuEntry.addActionListener((ActionEvent evt) -> {
-          try
-          {
-            SlivkaParamSet paramSet = new SlivkaParamSet(service);
-            SequenceAnnotationWSClient client = new SequenceAnnotationWSClient();
-            client.initSequenceAnnotationWSClient(serviceInstance, alignFrame, paramSet, true);
-          } catch (IOException e)
-          {
-            throw new IOError(e);
-          }
-
-        });
+        new URL(url);
+        valid.add(url);
+      } catch (MalformedURLException e)
+      {
+        Console.warn("Problem whilst trying to make a URL from '"
+                + ((url != null) ? url : "<null>") + "'");
+        Console.warn(
+                "This was probably due to a malformed comma separated list"
+                        + " in the " + SLIVKA_HOST_URLS
+                        + " entry of $(HOME)/.jalview_properties)");
+        Console.debug("Exception was ", e);
       }
-    } catch (IOException e)
-    {
-      throw new IOError(e);
     }
+    return valid;
   }
 
   @Override
-  public void run()
+  public boolean testServiceUrl(URL url)
   {
+    return getServerStatusFor(url.toString()) == STATUS_OK;
+  }
 
+  @Override
+  public int getServerStatusFor(String url)
+  {
+    try
+    {
+      List<?> services = new SlivkaClient(url).getServices();
+      return services.isEmpty() ? STATUS_NO_SERVICES : STATUS_OK;
+    } catch (IOException | org.json.JSONException e)
+    {
+      Console.error("Slivka could not retrieve services list", e);
+      return STATUS_INVALID;
+    }
+  }
+
+  @Override
+  public String getErrorMessages()
+  {
+    // TODO Auto-generated method stub
+    return "";
   }
 }