Check bounds of loaded comp
[jalview.git] / src / jalview / ws / MsaWSThread.java
1 /*
2  * Jalview - A Sequence Alignment Editor and Viewer
3  * Copyright (C) 2007 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License
7  * as published by the Free Software Foundation; either version 2
8  * of the License, or (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
18  */
19 package jalview.ws;
20
21 import java.util.*;
22
23 import jalview.analysis.*;
24 import jalview.bin.*;
25 import jalview.datamodel.*;
26 import jalview.datamodel.Alignment;
27 import jalview.gui.*;
28 import vamsas.objects.simple.MsaResult;
29
30 /**
31  * <p>
32  * Title:
33  * </p>
34  *
35  * <p>
36  * Description:
37  * </p>
38  *
39  * <p>
40  * Copyright: Copyright (c) 2004
41  * </p>
42  *
43  * <p>
44  * Company: Dundee University
45  * </p>
46  *
47  * @author not attributable
48  * @version 1.0
49  */
50 class MsaWSThread
51     extends WSThread implements WSClientI
52 {
53   boolean submitGaps = false; // pass sequences including gaps to alignment
54
55   // service
56
57   boolean preserveOrder = true; // and always store and recover sequence
58
59   // order
60
61   class MsaWSJob
62       extends WSThread.WSJob
63   {
64     // hold special input for this
65     vamsas.objects.simple.SequenceSet seqs = new vamsas.objects.simple.
66         SequenceSet();
67
68     /**
69      * MsaWSJob
70      *
71      * @param jobNum
72      *            int
73      * @param jobId
74      *            String
75      */
76     public MsaWSJob(int jobNum, SequenceI[] inSeqs)
77     {
78       this.jobnum = jobNum;
79       if (!prepareInput(inSeqs, 2))
80       {
81         submitted = true;
82         subjobComplete = true;
83         result = new MsaResult();
84         result.setFinished(true);
85         result.setStatus("Job never ran - input returned to user.");
86       }
87
88     }
89
90     Hashtable SeqNames = new Hashtable();
91     Vector emptySeqs = new Vector();
92     /**
93      * prepare input sequences for MsaWS service
94      * @param seqs jalview sequences to be prepared
95      * @param minlen minimum number of residues required for this MsaWS service
96      * @return true if seqs contains sequences to be submitted to service.
97      */
98     private boolean prepareInput(SequenceI[] seqs, int minlen)
99     {
100       int nseqs = 0;
101       if (minlen < 0)
102       {
103         throw new Error("Implementation error: minlen must be zero or more.");
104       }
105       for (int i = 0; i < seqs.length; i++)
106       {
107         if (seqs[i].getEnd() - seqs[i].getStart() > minlen - 1)
108         {
109           nseqs++;
110         }
111       }
112       boolean valid = nseqs > 1; // need at least two seqs
113       vamsas.objects.simple.Sequence[] seqarray =
114           (valid)
115           ? new vamsas.objects.simple.Sequence[nseqs]
116           : null;
117       for (int i = 0, n = 0; i < seqs.length; i++)
118       {
119
120         String newname = jalview.analysis.SeqsetUtils.unique_name(i); // same
121         // for
122         // any
123         // subjob
124         SeqNames.put(newname, jalview.analysis.SeqsetUtils
125                      .SeqCharacterHash(seqs[i]));
126         if (valid && seqs[i].getEnd() - seqs[i].getStart() > minlen - 1)
127         {
128           seqarray[n] = new vamsas.objects.simple.Sequence();
129           seqarray[n].setId(newname);
130           seqarray[n++].setSeq( (submitGaps) ? seqs[i].getSequenceAsString()
131                                : AlignSeq.extractGaps(
132                                    jalview.util.Comparison.GapChars, seqs[i]
133                                    .getSequenceAsString()));
134         }
135         else
136         {
137           String empty = null;
138           if (seqs[i].getEnd() >= seqs[i].getStart())
139           {
140             empty = (submitGaps) ? seqs[i].getSequenceAsString()
141                 : AlignSeq.extractGaps(
142                     jalview.util.Comparison.GapChars, seqs[i]
143                     .getSequenceAsString());
144           }
145           emptySeqs.add(new String[]
146                         {newname, empty});
147         }
148       }
149       this.seqs = new vamsas.objects.simple.SequenceSet();
150       this.seqs.setSeqs(seqarray);
151       return valid;
152     }
153
154     /**
155      *
156      * @return true if getAlignment will return a valid alignment result.
157      */
158     public boolean hasResults()
159     {
160       if (subjobComplete && result != null && result.isFinished()
161           && ( (MsaResult) result).getMsa() != null &&
162           ( (MsaResult) result).getMsa().getSeqs() != null)
163       {
164         return true;
165       }
166       return false;
167     }
168
169     public Object[] getAlignment()
170     {
171
172       if (result != null && result.isFinished())
173       {
174         SequenceI[] alseqs = null;
175         char alseq_gapchar = '-';
176         int alseq_l = 0;
177         if ( ( (MsaResult) result).getMsa() != null)
178         {
179           alseqs = getVamsasAlignment( ( (MsaResult) result).getMsa());
180           alseq_gapchar = ( (MsaResult) result).getMsa().getGapchar().charAt(0);
181           alseq_l = alseqs.length;
182         }
183         if (emptySeqs.size() > 0)
184         {
185           SequenceI[] t_alseqs = new SequenceI[alseq_l + emptySeqs.size()];
186           // get width
187           int i, w = 0;
188           if (alseq_l > 0)
189           {
190             for (i = 0, w = alseqs[0].getLength(); i < alseq_l; i++)
191             {
192               if (w < alseqs[i].getLength())
193               {
194                 w = alseqs[i].getLength();
195               }
196               t_alseqs[i] = alseqs[i];
197               alseqs[i] = null;
198             }
199           }
200           // check that aligned width is at least as wide as emptySeqs width.
201           int ow = w, nw = w;
202           for (i = 0, w = emptySeqs.size(); i < w; i++)
203           {
204             String[] es = (String[]) emptySeqs.get(i);
205             if (es != null && es[1] != null)
206             {
207               int sw = es[1].length();
208               if (nw < sw)
209               {
210                 nw = sw;
211               }
212             }
213           }
214           // make a gapped string.
215           StringBuffer insbuff = new StringBuffer(w);
216           for (i = 0; i < nw; i++)
217           {
218             insbuff.append(alseq_gapchar);
219           }
220           if (ow < nw)
221           {
222             for (i = 0; i < alseq_l; i++)
223             {
224               int sw = t_alseqs[i].getLength();
225               if (nw > sw)
226               {
227                 // pad at end
228                 alseqs[i].setSequence(t_alseqs[i].getSequenceAsString() +
229                                       insbuff.substring(0, sw - nw));
230               }
231             }
232           }
233           for (i = 0, w = emptySeqs.size(); i < w; i++)
234           {
235             String[] es = (String[]) emptySeqs.get(i);
236             if (es[1] == null)
237             {
238               t_alseqs[i +
239                   alseq_l] = new jalview.datamodel.Sequence(es[0],
240                   insbuff.toString(), 1, 0);
241             }
242             else
243             {
244               if (es[1].length() < nw)
245               {
246                 t_alseqs[i +
247                     alseq_l] = new jalview.datamodel.Sequence(es[0],
248                     es[1] + insbuff.substring(0, nw - es[1].length()), 1,
249                     1 + es[1].length());
250               }
251               else
252               {
253                 t_alseqs[i +
254                     alseq_l] = new jalview.datamodel.Sequence(es[0], es[1]);
255               }
256             }
257           }
258           alseqs = t_alseqs;
259         }
260         AlignmentOrder msaorder = new AlignmentOrder(alseqs);
261         // always recover the order - makes parseResult()'s life easier.
262         jalview.analysis.AlignmentSorter.recoverOrder(alseqs);
263         // account for any missing sequences
264         jalview.analysis.SeqsetUtils.deuniquify(SeqNames, alseqs);
265         return new Object[]
266             {
267             alseqs, msaorder};
268       }
269       return null;
270     }
271
272     /**
273      * mark subjob as cancelled and set result object appropriatly
274      */
275     void cancel()
276     {
277       cancelled = true;
278       subjobComplete = true;
279       result = null;
280     }
281
282     /**
283      *
284      * @return boolean true if job can be submitted.
285      */
286     boolean hasValidInput()
287     {
288       if (seqs.getSeqs() != null)
289       {
290         return true;
291       }
292       return false;
293     }
294   }
295
296   String alTitle; // name which will be used to form new alignment window.
297   Alignment dataset; // dataset to which the new alignment will be
298
299   // associated.
300
301   ext.vamsas.MuscleWS server = null;
302   /**
303    * set basic options for this (group) of Msa jobs
304    *
305    * @param subgaps
306    *            boolean
307    * @param presorder
308    *            boolean
309    */
310   MsaWSThread(ext.vamsas.MuscleWS server, String wsUrl,
311               WebserviceInfo wsinfo, jalview.gui.AlignFrame alFrame,
312               AlignmentView alview,
313               String wsname, boolean subgaps, boolean presorder)
314   {
315     this.server = server;
316     this.WsUrl = wsUrl;
317     this.wsInfo = wsinfo;
318     this.WebServiceName = wsname;
319     this.input = alview;
320     this.submitGaps = subgaps;
321     this.preserveOrder = presorder;
322     this.alignFrame = alFrame;
323   }
324
325   /**
326    * create one or more Msa jobs to align visible seuqences in _msa
327    *
328    * @param title
329    *            String
330    * @param _msa
331    *            AlignmentView
332    * @param subgaps
333    *            boolean
334    * @param presorder
335    *            boolean
336    * @param seqset
337    *            Alignment
338    */
339   MsaWSThread(ext.vamsas.MuscleWS server, String wsUrl,
340               WebserviceInfo wsinfo, jalview.gui.AlignFrame alFrame,
341               String wsname, String title, AlignmentView _msa, boolean subgaps,
342               boolean presorder, Alignment seqset)
343   {
344     this(server, wsUrl, wsinfo, alFrame, _msa, wsname, subgaps, presorder);
345     OutputHeader = wsInfo.getProgressText();
346     alTitle = title;
347     dataset = seqset;
348
349     SequenceI[][] conmsa = _msa.getVisibleContigs('-');
350     if (conmsa != null)
351     {
352       int njobs = conmsa.length;
353       jobs = new MsaWSJob[njobs];
354       for (int j = 0; j < njobs; j++)
355       {
356         if (j != 0)
357         {
358           jobs[j] = new MsaWSJob(wsinfo.addJobPane(), conmsa[j]);
359         }
360         else
361         {
362           jobs[j] = new MsaWSJob(0, conmsa[j]);
363         }
364         if (njobs > 0)
365         {
366           wsinfo.setProgressName("region " + jobs[j].jobnum, jobs[j].jobnum);
367         }
368         wsinfo.setProgressText(jobs[j].jobnum, OutputHeader);
369       }
370     }
371   }
372
373   public boolean isCancellable()
374   {
375     return true;
376   }
377
378   public void cancelJob()
379   {
380     if (!jobComplete && jobs != null)
381     {
382       boolean cancelled = true;
383       for (int job = 0; job < jobs.length; job++)
384       {
385         if (jobs[job].submitted && !jobs[job].subjobComplete)
386         {
387           String cancelledMessage = "";
388           try
389           {
390             vamsas.objects.simple.WsJobId cancelledJob = server
391                 .cancel(jobs[job].jobId);
392             if (cancelledJob.getStatus() == 2)
393             {
394               // CANCELLED_JOB
395               cancelledMessage = "Job cancelled.";
396               ( (MsaWSJob) jobs[job]).cancel();
397               wsInfo.setStatus(jobs[job].jobnum,
398                                WebserviceInfo.STATE_CANCELLED_OK);
399             }
400             else if (cancelledJob.getStatus() == 3)
401             {
402               // VALID UNSTOPPABLE JOB
403               cancelledMessage +=
404                   "Server cannot cancel this job. just close the window.\n";
405               cancelled = false;
406               // wsInfo.setStatus(jobs[job].jobnum,
407               //                 WebserviceInfo.STATE_RUNNING);
408             }
409
410             if (cancelledJob.getJobId() != null)
411             {
412               cancelledMessage += ("[" + cancelledJob.getJobId() + "]");
413             }
414
415             cancelledMessage += "\n";
416           }
417           catch (Exception exc)
418           {
419             cancelledMessage +=
420                 ("\nProblems cancelling the job : Exception received...\n"
421                  + exc + "\n");
422             Cache.log.warn("Exception whilst cancelling " + jobs[job].jobId,
423                            exc);
424           }
425           wsInfo.setProgressText(jobs[job].jobnum, OutputHeader
426                                  + cancelledMessage + "\n");
427         }
428       }
429       if (cancelled)
430       {
431         wsInfo.setStatus(WebserviceInfo.STATE_CANCELLED_OK);
432         jobComplete = true;
433       }
434       this.interrupt(); // kick thread to update job states.
435     }
436     else
437     {
438       if (!jobComplete)
439       {
440         wsInfo
441             .setProgressText(OutputHeader
442                              + "Server cannot cancel this job because it has not been submitted properly. just close the window.\n");
443       }
444     }
445   }
446
447   void pollJob(WSJob job)
448       throws Exception
449   {
450     ( (MsaWSJob) job).result = server.getResult( ( (MsaWSJob) job).jobId);
451   }
452
453   void StartJob(WSJob job)
454   {
455     if (! (job instanceof MsaWSJob))
456     {
457       throw new Error("StartJob(MsaWSJob) called on a WSJobInstance " +
458                       job.getClass());
459     }
460     MsaWSJob j = (MsaWSJob) job;
461     if (j.submitted)
462     {
463       if (Cache.log.isDebugEnabled())
464       {
465         Cache.log.debug("Tried to submit an already submitted job " + j.jobId);
466       }
467       return;
468     }
469     if (j.seqs.getSeqs() == null)
470     {
471       // special case - selection consisted entirely of empty sequences...
472       j.submitted = true;
473       j.result = new MsaResult();
474       j.result.setFinished(true);
475       j.result.setStatus("Empty Alignment Job");
476       ( (MsaResult) j.result).setMsa(null);
477     }
478     try
479     {
480       vamsas.objects.simple.WsJobId jobsubmit = server.align(j.seqs);
481
482       if ( (jobsubmit != null) && (jobsubmit.getStatus() == 1))
483       {
484         j.jobId = jobsubmit.getJobId();
485         j.submitted = true;
486         j.subjobComplete = false;
487         // System.out.println(WsURL + " Job Id '" + jobId + "'");
488       }
489       else
490       {
491         if (jobsubmit == null)
492         {
493           throw new Exception(
494               "Server at "
495               + WsUrl
496               +
497               " returned null object, it probably cannot be contacted. Try again later ?");
498         }
499
500         throw new Exception(jobsubmit.getJobId());
501       }
502     }
503     catch (Exception e)
504     {
505       // TODO: JBPNote catch timeout or other fault types explicitly
506       // For unexpected errors
507       System.err
508           .println(WebServiceName
509                    + "Client: Failed to submit the sequences for alignment (probably a server side problem)\n"
510                    + "When contacting Server:" + WsUrl + "\n"
511                    + e.toString() + "\n");
512       j.allowedServerExceptions = 0;
513       wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_SERVERERROR);
514       wsInfo.setStatus(j.jobnum, WebserviceInfo.STATE_STOPPED_SERVERERROR);
515       wsInfo
516           .appendProgressText(
517               j.jobnum,
518               "Failed to submit sequences for alignment.\n"
519               + "It is most likely that there is a problem with the server.\n"
520               + "Just close the window\n");
521
522       // e.printStackTrace(); // TODO: JBPNote DEBUG
523     }
524   }
525
526   private jalview.datamodel.Sequence[] getVamsasAlignment(
527       vamsas.objects.simple.Alignment valign)
528   {
529     vamsas.objects.simple.Sequence[] seqs = valign.getSeqs().getSeqs();
530     jalview.datamodel.Sequence[] msa = new jalview.datamodel.Sequence[seqs.
531         length];
532
533     for (int i = 0, j = seqs.length; i < j; i++)
534     {
535       msa[i] = new jalview.datamodel.Sequence(seqs[i].getId(), seqs[i]
536                                               .getSeq());
537     }
538
539     return msa;
540   }
541
542   void parseResult()
543   {
544     int results = 0; // number of result sets received
545     JobStateSummary finalState = new JobStateSummary();
546     try
547     {
548       for (int j = 0; j < jobs.length; j++)
549       {
550         finalState.updateJobPanelState(wsInfo, OutputHeader, jobs[j]);
551         if (jobs[j].submitted && jobs[j].subjobComplete && jobs[j].hasResults())
552         {
553           results++;
554           vamsas.objects.simple.Alignment valign = ( (MsaResult) jobs[j].result).
555               getMsa();
556           if (valign != null)
557           {
558             wsInfo.appendProgressText(jobs[j].jobnum,
559                                       "\nAlignment Object Method Notes\n");
560             String[] lines = valign.getMethod();
561             for (int line = 0; line < lines.length; line++)
562             {
563               wsInfo.appendProgressText(jobs[j].jobnum, lines[line] + "\n");
564             }
565             // JBPNote The returned files from a webservice could be
566             //  hidden behind icons in the monitor window that,
567             // when clicked, pop up their corresponding data
568           }
569         }
570       }
571     }
572     catch (Exception ex)
573     {
574
575       Cache.log.error("Unexpected exception when processing results for " +
576                       alTitle, ex);
577       wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_ERROR);
578     }
579     if (results > 0)
580     {
581       wsInfo.showResultsNewFrame
582           .addActionListener(new java.awt.event.ActionListener()
583       {
584         public void actionPerformed(
585             java.awt.event.ActionEvent evt)
586         {
587           displayResults(true);
588         }
589       });
590       wsInfo.mergeResults
591           .addActionListener(new java.awt.event.ActionListener()
592       {
593         public void actionPerformed(
594             java.awt.event.ActionEvent evt)
595         {
596           displayResults(false);
597         }
598       });
599       wsInfo.setResultsReady();
600     }
601     else
602     {
603       wsInfo.setFinishedNoResults();
604     }
605   }
606
607   void displayResults(boolean newFrame)
608   {
609     // view input or result data for each block
610     Vector alorders = new Vector();
611     SequenceI[][] results = new SequenceI[jobs.length][];
612     AlignmentOrder[] orders = new AlignmentOrder[jobs.length];
613
614     for (int j = 0; j < jobs.length; j++)
615     {
616       if (jobs[j].hasResults())
617       {
618         Object[] res = ( (MsaWSJob) jobs[j]).getAlignment();
619         alorders.add(res[1]);
620         results[j] = (SequenceI[]) res[0];
621         orders[j] = (AlignmentOrder) res[1];
622 //    SequenceI[] alignment = input.getUpdated
623       }
624       else
625       {
626         results[j] = null;
627       }
628     }
629     Object[] newview = input.getUpdatedView(results, orders, '-');
630     // trash references to original result data
631     for (int j = 0; j < jobs.length; j++)
632     {
633       results[j] = null;
634       orders[j] = null;
635     }
636     SequenceI[] alignment = (SequenceI[]) newview[0];
637     ColumnSelection columnselection = (ColumnSelection) newview[1];
638     Alignment al = new Alignment(alignment);
639     if (dataset != null)
640     {
641       al.setDataset(dataset);
642     }
643
644     // JBNote- TODO: warn user if a block is input rather than aligned data ?
645
646     if (newFrame)
647     {
648       AlignFrame af = new AlignFrame(al, columnselection,
649                                      AlignFrame.DEFAULT_WIDTH,
650                                      AlignFrame.DEFAULT_HEIGHT);
651
652       // >>>This is a fix for the moment, until a better solution is
653       // found!!<<<
654       af.getFeatureRenderer().transferSettings(
655           alignFrame.getFeatureRenderer());
656       // update orders
657       if (alorders.size() > 0)
658       {
659         if (alorders.size() == 1)
660         {
661           af.addSortByOrderMenuItem(WebServiceName + " Ordering",
662                                     (AlignmentOrder) alorders.get(0));
663         }
664         else
665         {
666           // construct a non-redundant ordering set
667           Vector names = new Vector();
668           for (int i = 0, l = alorders.size(); i < l; i++)
669           {
670             String orderName = new String(" Region " + i);
671             int j = i + 1;
672
673             while (j < l)
674             {
675               if ( ( (AlignmentOrder) alorders.get(i)).equals( ( (
676                   AlignmentOrder) alorders.get(j))))
677               {
678                 alorders.remove(j);
679                 l--;
680                 orderName += "," + j;
681               }
682               else
683               {
684                 j++;
685               }
686             }
687
688             if (i == 0 && j == 1)
689             {
690               names.add(new String(""));
691             }
692             else
693             {
694               names.add(orderName);
695             }
696           }
697           for (int i = 0, l = alorders.size(); i < l; i++)
698           {
699             af.addSortByOrderMenuItem(WebServiceName
700                                       + ( (String) names.get(i)) +
701                                       " Ordering",
702                                       (AlignmentOrder) alorders.get(i));
703           }
704         }
705       }
706
707       Desktop.addInternalFrame(af, alTitle,
708                                AlignFrame.DEFAULT_WIDTH,
709                                AlignFrame.DEFAULT_HEIGHT);
710
711     }
712     else
713     {
714       System.out.println("MERGE WITH OLD FRAME");
715
716     }
717   }
718
719   public boolean canMergeResults()
720   {
721     return false;
722   }
723 }