JAL-3848 don’t include sequence limits in sequence id as it confuses slivka-0.8’s...
[jalview.git] / src / jalview / ws / slivkaws / SlivkaWSInstance.java
index 952aab6..0c71c35 100644 (file)
@@ -2,6 +2,8 @@ package jalview.ws.slivkaws;
 
 import jalview.datamodel.SequenceI;
 import jalview.gui.WebserviceInfo;
+import jalview.io.FileFormat;
+import jalview.io.FormatAdapter;
 import jalview.ws.api.JalviewServiceEndpointProviderI;
 import jalview.ws.api.JalviewWebServiceI;
 import jalview.ws.api.JobId;
@@ -11,28 +13,26 @@ 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.ByteArrayInputStream;
+import java.io.ByteArrayOutputStream;
 import java.io.IOError;
 import java.io.IOException;
 import java.io.InputStream;
-import java.io.InputStreamReader;
 import java.util.Arrays;
+import java.util.Collection;
 import java.util.EnumMap;
 import java.util.HashSet;
 import java.util.List;
-import java.util.Optional;
 import java.util.Set;
 
-import uk.ac.dundee.compbio.slivkaclient.FieldType;
-import uk.ac.dundee.compbio.slivkaclient.FormField;
-import uk.ac.dundee.compbio.slivkaclient.FormValidationException;
-import uk.ac.dundee.compbio.slivkaclient.JobState;
+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.SlivkaForm;
 import uk.ac.dundee.compbio.slivkaclient.SlivkaService;
-import uk.ac.dundee.compbio.slivkaclient.ValidationException;
 
 public abstract class SlivkaWSInstance extends ServiceWithParameters
     implements JalviewServiceEndpointProviderI, JalviewWebServiceI
@@ -43,19 +43,19 @@ 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.REJECTED, WsJob.JobState.INVALID);
-    stateMap.put(JobState.ACCEPTED, 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.INTERRUPED, WsJob.JobState.CANCELLED);
-    stateMap.put(JobState.DELETED, WsJob.JobState.CANCELLED);
-    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,
@@ -64,7 +64,7 @@ public abstract class SlivkaWSInstance extends ServiceWithParameters
 
   public SlivkaWSInstance(SlivkaClient client, SlivkaService service, String action)
   {
-    super(service.getName(), action, service.getLabel(), "Slivka", client.getUrl().toString());
+    super(action, action, service.getName(), "Slivka", client.getUrl().toString());
     this.client = client;
     this.service = service;
   }
@@ -72,22 +72,37 @@ public abstract class SlivkaWSInstance extends ServiceWithParameters
   protected final JobId submit(List<SequenceI> sequences,
           WsParamSetI preset, List<ArgumentI> args) throws Throwable
   {
-    SlivkaForm form = service.getForm();
-    Optional<FormField> inputField = form.getFields().stream()
-            .filter(f -> f.getType() == FieldType.FILE).findFirst();
-    if (inputField.isPresent())
+    var parameters = service.getParameters();
+    var request = new JobRequest();
+    for (Parameter param : parameters)
     {
-      StringBuilder builder = new StringBuilder();
-      for (SequenceI seq : sequences)
+      if (param instanceof Parameter.FileParameter)
       {
-        builder.append(">").append(seq.getName()).append("\n")
-                .append(seq.getSequence()).append("\n");
+        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);
       }
-      InputStream stream = new ByteArrayInputStream(
-              builder.toString().getBytes());
-      RemoteFile file = client.uploadFile(stream, "input.fa",
-              "application/fasta");
-      form.insert(inputField.get().getName(), file);
     }
     if (args != null)
     {
@@ -95,22 +110,22 @@ public abstract class SlivkaWSInstance extends ServiceWithParameters
       {
         // multiple choice field names are name$number to avoid duplications
         // the number is stripped here
-        String fieldName = arg.getName().split("\\$", 2)[0];
-        FormField field = form.getField(fieldName);
-        if (field.getType() == FieldType.BOOLEAN)
-        {
-          form.insert(fieldName,
-                  (arg.getValue() != null && !arg.getValue().isBlank())
-                          ? true
-                          : false);
+        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
         {
-          form.insert(fieldName, field.valueOf(arg.getValue()));
+          request.addData(paramId, arg.getValue());
         }
       }
     }
-    return new JobId(service.getName(), service.getName(), form.submit());
+    var job = service.submitJob(request);
+    return new JobId(service.getName(), service.getName(), job.getId());
   }
 
   @Override
@@ -118,7 +133,8 @@ public abstract class SlivkaWSInstance extends ServiceWithParameters
   {
     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);
@@ -127,61 +143,64 @@ public abstract class SlivkaWSInstance extends ServiceWithParameters
 
   @Override
   public final boolean updateJobProgress(WsJob job) throws IOException
-  {
-    List<RemoteFile> files = client.getJobResults(job.getJobId());
-    Optional<RemoteFile> logFile = files.stream()
-        .filter(f -> f.getLabel().equals("log")).findFirst();
+  {      
+    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.isPresent())
+    if (logFile!=null)
     {
-      InputStream stream = logFile.get().getContent();
-      long nextChunk = stream.skip(job.getNextChunk());
-      int len = appendJobStatus(job, stream);
-      job.setnextChunk(nextChunk + len);
-      newContent |= len > 0;
+      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()))
     {
-      Optional<RemoteFile> errLogFile = files.stream()
-          .filter(f -> f.getLabel().equals("error-log")).findFirst();
-      if (errLogFile.isPresent())
+      
+      RemoteFile errLogFile = null;
+      for (RemoteFile f : files)
       {
-        newContent |= appendJobStatus(job, errLogFile.get().getContent()) > 0;
+        if (f.getLabel().equals("error-log"))
+        {
+          errLogFile = f;
+          break;
+        }
       }
-    }
-    return newContent;
-  }
 
-  private int appendJobStatus(WsJob job, InputStream stream) throws IOException
-  {
-    StringBuilder builder = new StringBuilder(job.getStatus());
-    InputStreamReader reader = new InputStreamReader(stream);
-    char[] buffer = new char[4096];
-    int chunkLen = 0;
-    int len = 0;
-    while ((len = reader.read(buffer)) != -1)
-    {
-      chunkLen += len;
-      builder.append(buffer, 0, len);
+      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"));
+        }
+      }
     }
-    job.setStatus(builder.toString());
-    return chunkLen;
+    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;