Merge branch 'improvement/JAL-3848_slivka_0.8' into alpha/JAL-3066_Jalview_212_slivka...
[jalview.git] / src / jalview / ws / slivkaws / SlivkaWSInstance.java
index b9f375f..80e928a 100644 (file)
@@ -1,22 +1,40 @@
 package jalview.ws.slivkaws;
 
+import java.io.ByteArrayInputStream;
+import java.io.ByteArrayOutputStream;
+import java.io.IOError;
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.Arrays;
+import java.util.EnumMap;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Set;
+
+import jalview.datamodel.AlignmentI;
+import jalview.datamodel.SequenceI;
 import jalview.gui.WebserviceInfo;
+import jalview.io.DataSourceType;
+import jalview.io.FileFormat;
+import jalview.io.FormatAdapter;
 import jalview.ws.api.JalviewServiceEndpointProviderI;
 import jalview.ws.api.JalviewWebServiceI;
+import jalview.ws.api.JobId;
 import jalview.ws.api.ServiceWithParameters;
 import jalview.ws.gui.WsJob;
+import jalview.ws.params.ArgumentI;
 import jalview.ws.params.ParamDatastoreI;
 import jalview.ws.params.ParamManager;
+import jalview.ws.params.WsParamSetI;
+import javajs.http.ClientProtocolException;
 
-import java.io.IOError;
-import java.io.IOException;
-import java.util.EnumMap;
-
-import uk.ac.dundee.compbio.slivkaclient.FormValidationException;
-import uk.ac.dundee.compbio.slivkaclient.JobState;
+import java.util.Collection;
+import uk.ac.dundee.compbio.slivkaclient.Job;
+import uk.ac.dundee.compbio.slivkaclient.JobRequest;
+import uk.ac.dundee.compbio.slivkaclient.Parameter;
+import uk.ac.dundee.compbio.slivkaclient.RemoteFile;
 import uk.ac.dundee.compbio.slivkaclient.SlivkaClient;
 import uk.ac.dundee.compbio.slivkaclient.SlivkaService;
-import uk.ac.dundee.compbio.slivkaclient.ValidationException;
 
 public abstract class SlivkaWSInstance extends ServiceWithParameters
     implements JalviewServiceEndpointProviderI, JalviewWebServiceI
@@ -27,31 +45,98 @@ public abstract class SlivkaWSInstance extends ServiceWithParameters
 
   protected SlivkaDatastore store = null;
 
-  protected static final EnumMap<JobState, WsJob.JobState> stateMap = new EnumMap<>(JobState.class);
+  protected static final EnumMap<Job.Status, WsJob.JobState> stateMap = new EnumMap<>(Job.Status.class);
   {
-    stateMap.put(JobState.PENDING, WsJob.JobState.QUEUED);
-    stateMap.put(JobState.QUEUED, WsJob.JobState.QUEUED);
-    stateMap.put(JobState.RUNNING, WsJob.JobState.RUNNING);
-    stateMap.put(JobState.COMPLETED, WsJob.JobState.FINISHED);
-    stateMap.put(JobState.FAILED, WsJob.JobState.FAILED);
-    stateMap.put(JobState.ERROR, WsJob.JobState.SERVERERROR);
-    stateMap.put(JobState.UNKNOWN, WsJob.JobState.UNKNOWN);
+    stateMap.put(Job.Status.PENDING, WsJob.JobState.QUEUED);
+    stateMap.put(Job.Status.REJECTED, WsJob.JobState.INVALID);
+    stateMap.put(Job.Status.ACCEPTED, WsJob.JobState.QUEUED);
+    stateMap.put(Job.Status.QUEUED, WsJob.JobState.QUEUED);
+    stateMap.put(Job.Status.RUNNING, WsJob.JobState.RUNNING);
+    stateMap.put(Job.Status.COMPLETED, WsJob.JobState.FINISHED);
+    stateMap.put(Job.Status.INTERRUPTED, WsJob.JobState.CANCELLED);
+    stateMap.put(Job.Status.DELETED, WsJob.JobState.CANCELLED);
+    stateMap.put(Job.Status.FAILED, WsJob.JobState.FAILED);
+    stateMap.put(Job.Status.ERROR, WsJob.JobState.SERVERERROR);
+    stateMap.put(Job.Status.UNKNOWN, WsJob.JobState.UNKNOWN);
   }
+  protected final Set<WsJob.JobState> failedStates = new HashSet<>(Arrays.asList(
+      WsJob.JobState.INVALID, WsJob.JobState.BROKEN, WsJob.JobState.FAILED,
+      WsJob.JobState.SERVERERROR, WsJob.JobState.CANCELLED
+  ));
 
   public SlivkaWSInstance(SlivkaClient client, SlivkaService service, String action)
   {
-    super(service.getLabel(), action, service.getName(), "Slivka",
-            client.getUrl().toString());
+    super(action, action, service.getName(), "Slivka", client.getUrl().toString());
     this.client = client;
     this.service = service;
   }
 
+  protected final JobId submit(List<SequenceI> sequences,
+          WsParamSetI preset, List<ArgumentI> args) throws Throwable
+  {
+    var parameters = service.getParameters();
+    var request = new JobRequest();
+    for (Parameter param : parameters)
+    {
+      if (param instanceof Parameter.FileParameter)
+      {
+        FormatAdapter fa = new FormatAdapter();
+        fa.setNewlineString("\r\n");
+        Parameter.FileParameter fileParam = (Parameter.FileParameter) param;
+        FileFormat format;
+        switch (fileParam.getMediaType())
+        {
+        case "application/pfam":
+          format = FileFormat.Pfam;
+          break;
+        case "application/stockholm":
+          format = FileFormat.Stockholm;
+          break;
+        default:
+        case "application/fasta":
+          format = FileFormat.Fasta;
+          break;
+        }
+        
+        // we avoid any use of Jalview's user facing export routines here
+        
+        InputStream stream = new ByteArrayInputStream(format.getWriter(null)
+                .print(sequences.toArray(new SequenceI[0]), false)
+                .getBytes());
+        request.addFile(param.getId(), stream);
+      }
+    }
+    if (args != null)
+    {
+      for (ArgumentI arg : args)
+      {
+        // multiple choice field names are name$number to avoid duplications
+        // the number is stripped here
+        String paramId = arg.getName().split("\\$", 2)[0];
+        Parameter param = service.getParameter(paramId);
+        if (param instanceof Parameter.FlagParameter) {
+          if (arg.getValue() != null && !arg.getValue().isBlank())
+            request.addData(paramId, true);
+          else
+            request.addData(paramId, false);
+        }
+        else
+        {
+          request.addData(paramId, arg.getValue());
+        }
+      }
+    }
+    var job = service.submitJob(request);
+    return new JobId(service.getName(), service.getName(), job.getId());
+  }
+
   @Override
   public final void updateStatus(WsJob job)
   {
     try
     {
-      job.setState(stateMap.get(client.getJobState(job.getJobId())));
+      var slivkaJob = client.getJob(job.getJobId());
+      job.setState(stateMap.get(slivkaJob.getStatus()));
     } catch (IOException e)
     {
       throw new IOError(e);
@@ -59,25 +144,65 @@ public abstract class SlivkaWSInstance extends ServiceWithParameters
   }
 
   @Override
-  public final boolean updateJobProgress(WsJob job)
-  {
-    return false;
+  public final boolean updateJobProgress(WsJob job) throws IOException
+  {      
+    var slivkaJob = client.getJob(job.getJobId());
+    Collection<RemoteFile> files = slivkaJob.getResults();
+    RemoteFile logFile=null;
+    for (RemoteFile f : files)
+    {
+      if (f.getLabel().equals("log"))
+      {
+        logFile = f; break;
+      }
+    }
+
+    boolean newContent = false;
+    if (logFile!=null)
+    {
+      ByteArrayOutputStream output = new ByteArrayOutputStream();
+      logFile.writeTo(output);
+      if (output.size() > job.getNextChunk())
+      {
+        newContent = true;
+        job.setStatus(output.toString("UTF-8"));
+        job.setnextChunk(output.size());
+      }
+    }
+    if (failedStates.contains(job.getJobState()))
+    {
+      
+      RemoteFile errLogFile = null;
+      for (RemoteFile f : files)
+      {
+        if (f.getLabel().equals("error-log"))
+        {
+          errLogFile = f;
+          break;
+        }
+      }
+
+      if (errLogFile!=null)
+      {
+        ByteArrayOutputStream output = new ByteArrayOutputStream();
+        errLogFile.writeTo(output);
+        if (output.size() > 0)
+        {
+          newContent = true;
+          job.setStatus(job.getStatus() + "\n" + output.toString("UTF-8"));
+        }
+      }
+    }
+    return newContent;
   }
 
   @Override
   public final boolean handleSubmitError(Throwable _lex, WsJob j, WebserviceInfo wsInfo)
   {
-    if (_lex instanceof FormValidationException)
+    if (_lex instanceof ClientProtocolException)
     {
-      FormValidationException formError = (FormValidationException) _lex;
-      String[] messages = new String[formError.getErrors().size()];
-      int i = 0;
-      for (ValidationException e : formError.getErrors())
-      {
-        messages[i++] = String.format("%s: %s,", e.getField().getName(), e.getMessage());
-      }
       j.setState(WsJob.JobState.INVALID);
-      j.setStatus(String.join(", ", messages));
+      j.setStatus(_lex.getMessage());
       return true;
     }
     return false;
@@ -131,5 +256,19 @@ public abstract class SlivkaWSInstance extends ServiceWithParameters
     }
     return store;
   }
+  
+  public static AlignmentI readAlignment(RemoteFile f) throws IOException
+  {
+    final var mimetype = f.getMediaType();
+    FileFormat format;
+    if (mimetype.equals("application/clustal"))
+      format = FileFormat.Clustal;
+    else if (mimetype.equals("application/fasta"))
+      format = FileFormat.Fasta;
+    else
+      return null;
+    return new FormatAdapter().readFile(f.getContentUrl().toString(),
+        DataSourceType.URL, format);
+  }
 
 }