X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fws%2Fjws2%2FMsaWSThread.java;h=6ef07c60ec98ffdf2d597386d7dad3ee99a5281d;hb=a883b8a87fe965a1d04f67b6f82c985b0b2c8605;hp=416c5d7fc03e2541ab3323acfef668abfbd6b8d7;hpb=244588b87ac3818d6ff13050aa947feb823f5cd4;p=jalview.git diff --git a/src/jalview/ws/jws2/MsaWSThread.java b/src/jalview/ws/jws2/MsaWSThread.java index 416c5d7..6ef07c6 100644 --- a/src/jalview/ws/jws2/MsaWSThread.java +++ b/src/jalview/ws/jws2/MsaWSThread.java @@ -1,6 +1,6 @@ /* - * Jalview - A Sequence Alignment Editor and Viewer (Version 2.5) - * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle + * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7) + * Copyright (C) 2011 J Procter, AM Waterhouse, J Engelhardt, LM Lui, G Barton, M Clamp, S Searle * * This file is part of Jalview. * @@ -34,27 +34,9 @@ import jalview.gui.*; import jalview.ws.AWsJob; import jalview.ws.WSClientI; import jalview.ws.JobStateSummary; +import jalview.ws.jws2.dm.JabaWsParamSet; +import jalview.ws.params.WsParamSetI; -/** - *

- * Title: - *

- * - *

- * Description: - *

- * - *

- * Copyright: Copyright (c) 2004 - *

- * - *

- * Company: Dundee University - *

- * - * @author not attributable - * @version 1.0 - */ class MsaWSThread extends AWS2Thread implements WSClientI { boolean submitGaps = false; // pass sequences including gaps to alignment @@ -67,20 +49,26 @@ class MsaWSThread extends AWS2Thread implements WSClientI class MsaWSJob extends JWs2Job { - long lastChunk=0; - Preset preset=null; - List arguments = null; + long lastChunk = 0; + + WsParamSetI preset = null; + + List arguments = null; + /** - * input + * input */ ArrayList seqs = new ArrayList(); + /** * output */ compbio.data.sequence.Alignment alignment; - // set if the job didn't get run - then the input is simply returned to the user - private boolean returnInput=false; - + + // set if the job didn't get run - then the input is simply returned to the + // user + private boolean returnInput = false; + /** * MsaWSJob * @@ -101,7 +89,7 @@ class MsaWSThread extends AWS2Thread implements WSClientI } - Hashtable SeqNames = new Hashtable(); + Hashtable SeqNames = new Hashtable(); Vector emptySeqs = new Vector(); @@ -139,15 +127,16 @@ class MsaWSThread extends AWS2Thread implements WSClientI // for // any // subjob - SeqNames.put(newname, jalview.analysis.SeqsetUtils - .SeqCharacterHash(seqs[i])); + SeqNames.put(newname, + jalview.analysis.SeqsetUtils.SeqCharacterHash(seqs[i])); if (valid && seqs[i].getEnd() - seqs[i].getStart() > minlen - 1) { // make new input sequence with or without gaps seq = new compbio.data.sequence.FastaSequence(newname, (submitGaps) ? seqs[i].getSequenceAsString() - : AlignSeq.extractGaps(jalview.util.Comparison.GapChars, - seqs[i].getSequenceAsString())); + : AlignSeq.extractGaps( + jalview.util.Comparison.GapChars, + seqs[i].getSequenceAsString())); this.seqs.add(seq); } else @@ -156,8 +145,8 @@ class MsaWSThread extends AWS2Thread implements WSClientI if (seqs[i].getEnd() >= seqs[i].getStart()) { empty = (submitGaps) ? seqs[i].getSequenceAsString() : AlignSeq - .extractGaps(jalview.util.Comparison.GapChars, seqs[i] - .getSequenceAsString()); + .extractGaps(jalview.util.Comparison.GapChars, + seqs[i].getSequenceAsString()); } emptySeqs.add(new String[] { newname, empty }); @@ -172,7 +161,10 @@ class MsaWSThread extends AWS2Thread implements WSClientI */ public boolean hasResults() { - if (subjobComplete && isFinished() && (alignment!=null || (emptySeqs!=null && emptySeqs.size()>0))) + if (subjobComplete + && isFinished() + && (alignment != null || (emptySeqs != null && emptySeqs + .size() > 0))) { return true; } @@ -181,7 +173,10 @@ class MsaWSThread extends AWS2Thread implements WSClientI /** * - * get the alignment including any empty sequences in the original order with original ids. Caller must access the alignment.getMetadata() object to annotate the final result passsed to the user. + * get the alignment including any empty sequences in the original order + * with original ids. Caller must access the alignment.getMetadata() object + * to annotate the final result passsed to the user. + * * @return { SequenceI[], AlignmentOrder } */ public Object[] getAlignment() @@ -192,15 +187,16 @@ class MsaWSThread extends AWS2Thread implements WSClientI SequenceI[] alseqs = null; char alseq_gapchar = '-'; int alseq_l = 0; - if (alignment.getSequences().size()>0) + if (alignment.getSequences().size() > 0) { alseqs = new SequenceI[alignment.getSequences().size()]; - for (compbio.data.sequence.FastaSequence seq: alignment.getSequences()) + for (compbio.data.sequence.FastaSequence seq : alignment + .getSequences()) { - alseqs[alseq_l++] = new Sequence(seq.getId(),seq.getSequence()); + alseqs[alseq_l++] = new Sequence(seq.getId(), seq.getSequence()); } alseq_gapchar = alignment.getMetadata().getGapchar(); - + } // add in the empty seqs. if (emptySeqs.size() > 0) @@ -306,14 +302,17 @@ class MsaWSThread extends AWS2Thread implements WSClientI */ public boolean hasValidInput() { - // TODO: get attributes for this MsaWS instance to check if it can do two sequence alignment. - if (seqs != null && seqs.size()>=2) // two or more sequences is valid ? + // TODO: get attributes for this MsaWS instance to check if it can do two + // sequence alignment. + if (seqs != null && seqs.size() >= 2) // two or more sequences is valid ? { return true; } return false; } - StringBuffer jobProgress=new StringBuffer(); + + StringBuffer jobProgress = new StringBuffer(); + public void setStatus(String string) { jobProgress.setLength(0); @@ -329,7 +328,7 @@ class MsaWSThread extends AWS2Thread implements WSClientI @Override public boolean hasStatus() { - return jobProgress!=null; + return jobProgress != null; } /** @@ -341,19 +340,82 @@ class MsaWSThread extends AWS2Thread implements WSClientI } /** - * @param lastChunk the lastChunk to set + * @param lastChunk + * the lastChunk to set */ public void setLastChunk(long lastChunk) { this.lastChunk = lastChunk; } - String alignmentProgram=null; + String alignmentProgram = null; + public String getAlignmentProgram() { return alignmentProgram; } - + + public boolean hasArguments() + { + return (arguments != null && arguments.size() > 0) + || (preset != null && preset instanceof JabaWsParamSet); + } + + public List getJabaArguments() + { + List newargs = new ArrayList(); + if (preset != null && preset instanceof JabaWsParamSet) + { + newargs.addAll(((JabaWsParamSet) preset).getjabaArguments()); + } + if (arguments != null && arguments.size() > 0) + { + newargs.addAll(arguments); + } + return newargs; + } + + /** + * add a progess header to status string containing presets/args used + */ + public void addInitialStatus() + { + if (preset != null) + { + jobProgress.append("Using " + + (preset instanceof JabaPreset ? "Server" : "User") + + "Preset: " + preset.getName()); + if (preset instanceof JabaWsParamSet) + { + for (Argument opt : ((JabaWsParamSet) preset).getjabaArguments()) + { + jobProgress.append(opt.getName() + " " + opt.getDefaultValue() + + "\n"); + } + } + } + if (arguments != null && arguments.size() > 0) + { + jobProgress.append("With custom parameters : \n"); + // merge arguments with preset's own arguments. + for (Argument opt : arguments) + { + jobProgress.append(opt.getName() + " " + opt.getDefaultValue() + + "\n"); + } + } + jobProgress.append("\nJob Output:\n"); + } + + public boolean isPresetJob() + { + return preset != null && preset instanceof JabaPreset; + } + + public Preset getServerPreset() + { + return (isPresetJob()) ? ((JabaPreset) preset).p : null; + } } String alTitle; // name which will be used to form new alignment window. @@ -373,10 +435,9 @@ class MsaWSThread extends AWS2Thread implements WSClientI * @param presorder * boolean */ - MsaWSThread(MsaWS server, String wsUrl, - WebserviceInfo wsinfo, jalview.gui.AlignFrame alFrame, - AlignmentView alview, String wsname, boolean subgaps, - boolean presorder) + MsaWSThread(MsaWS server, String wsUrl, WebserviceInfo wsinfo, + jalview.gui.AlignFrame alFrame, AlignmentView alview, + String wsname, boolean subgaps, boolean presorder) { super(alFrame, wsinfo, alview, wsname, wsUrl); this.server = server; @@ -398,12 +459,13 @@ class MsaWSThread extends AWS2Thread implements WSClientI * @param seqset * Alignment */ - MsaWSThread(MsaWS server2, Preset preset, List paramset, String wsUrl, - WebserviceInfo wsinfo, jalview.gui.AlignFrame alFrame, - String wsname, String title, AlignmentView _msa, boolean subgaps, - boolean presorder, Alignment seqset) + MsaWSThread(MsaWS server2, WsParamSetI preset, List paramset, + String wsUrl, WebserviceInfo wsinfo, + jalview.gui.AlignFrame alFrame, String wsname, String title, + AlignmentView _msa, boolean subgaps, boolean presorder, + Alignment seqset) { - this(server2,wsUrl, wsinfo, alFrame, _msa, wsname, subgaps, presorder); + this(server2, wsUrl, wsinfo, alFrame, _msa, wsname, subgaps, presorder); OutputHeader = wsInfo.getProgressText(); alTitle = title; dataset = seqset; @@ -428,9 +490,8 @@ class MsaWSThread extends AWS2Thread implements WSClientI ((MsaWSJob) jobs[j]).alignmentProgram = wsname; if (njobs > 0) { - wsinfo - .setProgressName("region " + jobs[j].getJobnum(), - jobs[j].getJobnum()); + wsinfo.setProgressName("region " + jobs[j].getJobnum(), + jobs[j].getJobnum()); } wsinfo.setProgressText(jobs[j].getJobnum(), OutputHeader); } @@ -454,17 +515,20 @@ class MsaWSThread extends AWS2Thread implements WSClientI String cancelledMessage = ""; try { - boolean cancelledJob = server - .cancelJob(jobs[job].getJobId()); - if (cancelledJob) + boolean cancelledJob = server.cancelJob(jobs[job].getJobId()); + if (true) // cancelledJob || true) { // CANCELLED_JOB + // if the Jaba server indicates the job can't be cancelled, its + // because its running on the server's local execution engine + // so we just close the window anyway. cancelledMessage = "Job cancelled."; - ((MsaWSJob) jobs[job]).cancel(); // TODO: refactor to avoid this ugliness - + ((MsaWSJob) jobs[job]).cancel(); // TODO: refactor to avoid this + // ugliness - wsInfo.setStatus(jobs[job].getJobnum(), WebserviceInfo.STATE_CANCELLED_OK); - } - else + } + else { // VALID UNSTOPPABLE JOB cancelledMessage += "Server cannot cancel this job. just close the window.\n"; @@ -477,7 +541,8 @@ class MsaWSThread extends AWS2Thread implements WSClientI cancelledMessage += ("\nProblems cancelling the job : Exception received...\n" + exc + "\n"); Cache.log.warn( - "Exception whilst cancelling " + jobs[job].getJobId(), exc); + "Exception whilst cancelling " + jobs[job].getJobId(), + exc); } wsInfo.setProgressText(jobs[job].getJobnum(), OutputHeader + cancelledMessage + "\n"); @@ -494,9 +559,8 @@ class MsaWSThread extends AWS2Thread implements WSClientI { if (!jobComplete) { - wsInfo - .setProgressText(OutputHeader - + "Server cannot cancel this job because it has not been submitted properly. just close the window.\n"); + wsInfo.setProgressText(OutputHeader + + "Server cannot cancel this job because it has not been submitted properly. just close the window.\n"); } } } @@ -504,26 +568,47 @@ class MsaWSThread extends AWS2Thread implements WSClientI public void pollJob(AWsJob job) throws Exception { // TODO: investigate if we still need to cast here in J1.6 - MsaWSJob j=((MsaWSJob) job); - // this is standard code, but since the interface doesn't comprise of a basic one that implements (getJobStatus, pullExecStatistics) we have to repeat the code for all jw2s services. + MsaWSJob j = ((MsaWSJob) job); + // this is standard code, but since the interface doesn't comprise of a + // basic one that implements (getJobStatus, pullExecStatistics) we have to + // repeat the code for all jw2s services. j.setjobStatus(server.getJobStatus(job.getJobId())); updateJobProgress(j); } - protected void updateJobProgress(MsaWSJob j) throws Exception { + + /** + * + * @param j + * @return true if more job progress data was available + * @throws Exception + */ + protected boolean updateJobProgress(MsaWSJob j) throws Exception + { StringBuffer response = j.jobProgress; long lastchunk = j.getLastChunk(); - do { + boolean changed=false; + do + { j.setLastChunk(lastchunk); - ChunkHolder chunk = server.pullExecStatistics(j.getJobId(), lastchunk); - if (chunk!=null) { + ChunkHolder chunk = server + .pullExecStatistics(j.getJobId(), lastchunk); + if (chunk != null) + { + changed|=chunk.getChunk().length()>0; response.append(chunk.getChunk()); lastchunk = chunk.getNextPosition(); - }; - } while (lastchunk>=0 && j.getLastChunk()!=lastchunk); + try { + Thread.sleep(50); + } catch (InterruptedException x){}; + } + ; + } while (lastchunk >= 0 && j.getLastChunk() != lastchunk); + return changed; } public void StartJob(AWsJob job) { + Exception lex = null; // boiler plate template if (!(job instanceof MsaWSJob)) { @@ -541,8 +626,8 @@ class MsaWSThread extends AWS2Thread implements WSClientI return; } // end boilerplate - - if (j.seqs == null || j.seqs.size()==0) + + if (j.seqs == null || j.seqs.size() == 0) { // special case - selection consisted entirely of empty sequences... j.setjobStatus(JobStatus.FINISHED); @@ -550,58 +635,102 @@ class MsaWSThread extends AWS2Thread implements WSClientI } try { - // TODO: get the parameters (if any) for this job and submit the job - if (j.arguments!=null && j.arguments.size()>0) + j.addInitialStatus(); // list the presets/parameters used for the job in + // status + if (j.isPresetJob()) { - j.setJobId(server.customAlign(j.seqs, j.arguments)); - } else - if (j.preset!=null) - { - j.setJobId(server.presetAlign(j.seqs, j.preset)); - } else { - j.setJobId(server.align(j.seqs)); - } + j.setJobId(server.presetAlign(j.seqs, j.getServerPreset())); + } + else if (j.hasArguments()) + { + j.setJobId(server.customAlign(j.seqs,j.getJabaArguments())); + } + else + { + j.setJobId(server.align(j.seqs)); + } - if (j.getJobId()!= null) + if (j.getJobId() != null) { j.setSubmitted(true); j.setSubjobComplete(false); // System.out.println(WsURL + " Job Id '" + jobId + "'"); + return; } else { throw new Exception( - "Server at " - + WsUrl - + " returned null string for job id, it probably cannot be contacted. Try again later ?"); - } + "Server at " + + WsUrl + + " returned null string for job id, it probably cannot be contacted. Try again later ?"); + } + } catch (compbio.metadata.UnsupportedRuntimeException _lex) + { + lex = _lex; + wsInfo.appendProgressText("Job could not be run because the server doesn't support this program.\n" + + _lex.getMessage()); + wsInfo.warnUser(_lex.getMessage(), "Service not supported!"); + wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_SERVERERROR); + wsInfo.setStatus(j.getJobnum(), + WebserviceInfo.STATE_STOPPED_SERVERERROR); + } catch (compbio.metadata.LimitExceededException _lex) + { + lex = _lex; + wsInfo.appendProgressText("Job could not be run because it exceeded a hard limit on the server.\n" + + _lex.getMessage()); + wsInfo.warnUser(_lex.getMessage(), "Input is too big!"); + wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_ERROR); + wsInfo.setStatus(j.getJobnum(), WebserviceInfo.STATE_STOPPED_ERROR); + } catch (compbio.metadata.WrongParameterException _lex) + { + lex = _lex; + wsInfo.warnUser(_lex.getMessage(), "Invalid job parameter set!"); + wsInfo.appendProgressText("Job could not be run because some of the parameter settings are not supported by the server.\n" + + _lex.getMessage() + + "\nPlease check to make sure you have used the correct parameter set for this service!\n"); + wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_ERROR); + wsInfo.setStatus(j.getJobnum(), WebserviceInfo.STATE_STOPPED_ERROR); + } catch (Error e) + { + // For unexpected errors + System.err + .println(WebServiceName + + "Client: Failed to submit the sequences for alignment (probably a server side problem)\n" + + "When contacting Server:" + WsUrl + "\n"); + e.printStackTrace(System.err); + wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_SERVERERROR); + wsInfo.setStatus(j.getJobnum(), + WebserviceInfo.STATE_STOPPED_SERVERERROR); } catch (Exception e) { - // Boilerplate code here - // TODO: JBPNote catch timeout or other fault types explicitly // For unexpected errors System.err .println(WebServiceName + "Client: Failed to submit the sequences for alignment (probably a server side problem)\n" + "When contacting Server:" + WsUrl + "\n"); e.printStackTrace(System.err); - j.setAllowedServerExceptions(0); wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_SERVERERROR); - wsInfo.setStatus(j.getJobnum(), WebserviceInfo.STATE_STOPPED_SERVERERROR); - wsInfo - .appendProgressText( - j.getJobnum(), - "Failed to submit sequences for alignment.\n" - + "It is most likely that there is a problem with the server.\n" - + "Just close the window\n"); + wsInfo.setStatus(j.getJobnum(), + WebserviceInfo.STATE_STOPPED_SERVERERROR); + } finally + { + if (!j.isSubmitted()) + { + // Boilerplate code here + // TODO: JBPNote catch timeout or other fault types explicitly - // e.printStackTrace(); // TODO: JBPNote DEBUG + j.setAllowedServerExceptions(0); + wsInfo.appendProgressText(j.getJobnum(), + "Failed to submit sequences for alignment.\n" + + "Just close the window\n"); + } } } - public void parseResult() { + long progbar=System.currentTimeMillis(); + wsInfo.setProgressBar("Collecting job results.", progbar); int results = 0; // number of result sets received JobStateSummary finalState = new JobStateSummary(); try @@ -609,28 +738,71 @@ class MsaWSThread extends AWS2Thread implements WSClientI for (int j = 0; j < jobs.length; j++) { MsaWSJob msjob = ((MsaWSJob) jobs[j]); - if (jobs[j].isFinished() && msjob.alignment==null) + if (jobs[j].isFinished() && msjob.alignment == null) { - try { - updateJobProgress(msjob); - } catch (Exception e) - { - Cache.log.warn("Exception when retrieving remaining Job progress data for job "+msjob.getJobId()+" on server "+WsUrl); - e.printStackTrace(); - } + int nunchanged=3,nexcept=3; + boolean jpchanged=false,jpex=false; + do { + try + { + jpchanged = updateJobProgress(msjob); + jpex=false; + if (jpchanged) { + nexcept=3; + } + } catch (Exception e) + { + + Cache.log + .warn("Exception when retrieving remaining Job progress data for job " + + msjob.getJobId() + " on server " + WsUrl); + e.printStackTrace(); + nexcept--; + nunchanged=3; + // set flag remember that we've had an exception. + jpex=true; + jpchanged=false; + } + if (!jpchanged) + { + try + { + Thread.sleep(jpex ? 2400 : 1200); // wait a bit longer if we experienced an exception. + } catch (Exception ex) + { + } + ; + nunchanged--; + } + } while (nunchanged>0 && nexcept>0); + if (Cache.log.isDebugEnabled()) { - System.out.println("Job Execution file for job: "+msjob.getJobId()+" on server "+WsUrl); + System.out.println("Job Execution file for job: " + + msjob.getJobId() + " on server " + WsUrl); System.out.println(msjob.getStatus()); System.out.println("*** End of status"); - + } - try { + try + { msjob.alignment = server.getResult(msjob.getJobId()); - } - catch (Exception e) + } catch (compbio.metadata.ResultNotAvailableException e) { - Cache.log.error("Couldn't get Alignment for job.",e); + // job has failed for some reason - probably due to invalid + // parameters + Cache.log + .debug("Results not available for finished job - marking as broken job.", + e); + msjob.jobProgress + .append("\nResult not available. Probably due to invalid input or parameter settings. Server error message below:\n\n" + + e.getLocalizedMessage()); + msjob.setjobStatus(JobStatus.FAILED); + } catch (Exception e) + { + Cache.log.error("Couldn't get Alignment for job.", e); + // TODO: Increment count and retry ? + msjob.setjobStatus(JobStatus.UNDEFINED); } } finalState.updateJobPanelState(wsInfo, OutputHeader, jobs[j]); @@ -641,9 +813,11 @@ class MsaWSThread extends AWS2Thread implements WSClientI compbio.data.sequence.Alignment alignment = ((MsaWSJob) jobs[j]).alignment; if (alignment != null) { - wsInfo.appendProgressText(jobs[j].getJobnum(), - "\nAlignment Object Method Notes\n"); - wsInfo.appendProgressText(jobs[j].getJobnum(), "Calculated with "+alignment.getMetadata().getProgram().toString()); + // server.close(jobs[j].getJobnum()); + // wsInfo.appendProgressText(jobs[j].getJobnum(), + // "\nAlignment Object Method Notes\n"); + // wsInfo.appendProgressText(jobs[j].getJobnum(), + // "Calculated with "+alignment.getMetadata().getProgram().toString()); // JBPNote The returned files from a webservice could be // hidden behind icons in the monitor window that, // when clicked, pop up their corresponding data @@ -681,6 +855,8 @@ class MsaWSThread extends AWS2Thread implements WSClientI { wsInfo.setFinishedNoResults(); } + updateGlobalStatus(finalState); + wsInfo.setProgressBar(null, progbar); } void displayResults(boolean newFrame) @@ -695,7 +871,7 @@ class MsaWSThread extends AWS2Thread implements WSClientI { if (jobs[j].hasResults()) { - msjob = (MsaWSJob)jobs[j]; + msjob = (MsaWSJob) jobs[j]; Object[] res = msjob.getAlignment(); lastProgram = msjob.getAlignmentProgram(); alorders.add(res[1]); @@ -720,7 +896,8 @@ class MsaWSThread extends AWS2Thread implements WSClientI ColumnSelection columnselection = (ColumnSelection) newview[1]; Alignment al = new Alignment(alignment); // TODO: add 'provenance' property to alignment from the method notes - if (lastProgram!=null) { + if (lastProgram != null) + { al.setProperty("Alignment Program", lastProgram); } // accompanying each subjob @@ -782,8 +959,8 @@ class MsaWSThread extends AWS2Thread implements WSClientI } for (int i = 0, l = alorders.size(); i < l; i++) { - af.addSortByOrderMenuItem(WebServiceName - + ((String) names.get(i)) + " Ordering", + af.addSortByOrderMenuItem( + WebServiceName + ((String) names.get(i)) + " Ordering", (AlignmentOrder) alorders.get(i)); } }