Add pdb ref
[jalview.git] / src / jalview / ws / MsaWSClient.java
1 /*\r
2  * Jalview - A Sequence Alignment Editor and Viewer\r
3  * Copyright (C) 2005 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
4  *\r
5  * This program is free software; you can redistribute it and/or\r
6  * modify it under the terms of the GNU General Public License\r
7  * as published by the Free Software Foundation; either version 2\r
8  * of the License, or (at your option) any later version.\r
9  *\r
10  * This program is distributed in the hope that it will be useful,\r
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
13  * GNU General Public License for more details.\r
14  *\r
15  * You should have received a copy of the GNU General Public License\r
16  * along with this program; if not, write to the Free Software\r
17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA\r
18  */\r
19 package jalview.ws;\r
20 \r
21 import ext.vamsas.*;\r
22 \r
23 import jalview.analysis.AlignSeq;\r
24 \r
25 import jalview.datamodel.*;\r
26 \r
27 import jalview.gui.*;\r
28 \r
29 import java.util.*;\r
30 \r
31 import javax.swing.*;\r
32 \r
33 /**\r
34  * DOCUMENT ME!\r
35  *\r
36  * @author $author$\r
37  * @version $Revision$\r
38  */\r
39 public class MsaWSClient\r
40     extends WSClient\r
41 {\r
42   /**\r
43    * server is a WSDL2Java generated stub for an archetypal MsaWSI service.\r
44    */\r
45   ext.vamsas.MuscleWS server;\r
46   AlignFrame alignFrame;\r
47 \r
48 \r
49   /**\r
50    * Creates a new MsaWSClient object that uses a service\r
51    * given by an externally retrieved ServiceHandle\r
52    *\r
53    * @param sh service handle of type AbstractName(MsaWS)\r
54    * @param altitle DOCUMENT ME!\r
55    * @param msa DOCUMENT ME!\r
56    * @param submitGaps DOCUMENT ME!\r
57    * @param preserveOrder DOCUMENT ME!\r
58    */\r
59 \r
60   public MsaWSClient(ext.vamsas.ServiceHandle sh, String altitle,\r
61                      SequenceI[] msa,\r
62                      boolean submitGaps, boolean preserveOrder,\r
63                      Alignment seqdataset,\r
64                      AlignFrame _alignFrame)\r
65   {\r
66 \r
67     alignFrame = _alignFrame;\r
68     if (!sh.getAbstractName().equals("MsaWS"))\r
69     {\r
70       JOptionPane.showMessageDialog(Desktop.desktop,\r
71                                     "The Service called \n" + sh.getName() +\r
72           "\nis not a \nMultiple Sequence Alignment Service !",\r
73                                     "Internal Jalview Error",\r
74                                     JOptionPane.WARNING_MESSAGE);\r
75 \r
76       return;\r
77     }\r
78 \r
79     if ((wsInfo = this.setWebService(sh))==null)\r
80      {\r
81        JOptionPane.showMessageDialog(Desktop.desktop,\r
82                                      "The Multiple Sequence Alignment Service named " +\r
83                                      sh.getName() +\r
84                                      " is unknown", "Internal Jalview Error",\r
85                                      JOptionPane.WARNING_MESSAGE);\r
86 \r
87        return;\r
88      }\r
89     startMsaWSClient(altitle, msa, submitGaps, preserveOrder, seqdataset);\r
90 \r
91   }\r
92 \r
93 \r
94   private void startMsaWSClient(String altitle, SequenceI[] msa,\r
95                      boolean submitGaps, boolean preserveOrder, Alignment seqdataset)\r
96   {\r
97     if (!locateWebService())\r
98     {\r
99       return;\r
100     }\r
101 \r
102     wsInfo.setProgressText( ( (submitGaps) ? "Re-alignment" : "Alignment") +\r
103                            " of " + altitle + "\nJob details\n");\r
104 \r
105     MsaWSThread musclethread = new MsaWSThread(WebServiceName +\r
106                                                " alignment of " + altitle, msa,\r
107                                                submitGaps, preserveOrder, seqdataset);\r
108     wsInfo.setthisService(musclethread);\r
109     musclethread.start();\r
110   }\r
111 \r
112   /**\r
113    * Initializes the server field with a valid service implementation.\r
114    *\r
115    * @return true if service was located.\r
116    */\r
117   private boolean locateWebService()\r
118   {\r
119     // TODO: MuscleWS transmuted to generic MsaWS client\r
120     MuscleWSServiceLocator loc = new MuscleWSServiceLocator(); // Default\r
121 \r
122     try\r
123     {\r
124       this.server = (MuscleWS) loc.getMuscleWS(new java.net.URL(WsURL));\r
125       ( (MuscleWSSoapBindingStub)this.server).setTimeout(60000); // One minute timeout\r
126     }\r
127     catch (Exception ex)\r
128     {\r
129       wsInfo.setProgressText("Serious! " + WebServiceName +\r
130                              " Service location failed\nfor URL :" + WsURL +\r
131                              "\n" +\r
132                              ex.getMessage());\r
133       wsInfo.setStatus(WebserviceInfo.ERROR);\r
134       ex.printStackTrace();\r
135 \r
136       return false;\r
137     }\r
138 \r
139     loc.getEngine().setOption("axis", "1");\r
140 \r
141     return true;\r
142   }\r
143 \r
144   protected class MsaWSThread\r
145       extends Thread implements WSClientI\r
146   {\r
147     String ServiceName = WebServiceName;\r
148     String OutputHeader;\r
149     vamsas.objects.simple.MsaResult result = null;\r
150     vamsas.objects.simple.SequenceSet seqs = new vamsas.objects.simple.\r
151         SequenceSet();\r
152     Hashtable SeqNames = null;\r
153     boolean submitGaps = false; // pass sequences including gaps to alignment service\r
154     boolean preserveOrder = true; // and always store and recover sequence order\r
155     String jobId;\r
156     String alTitle; // name which will be used to form new alignment window.\r
157     int allowedServerExceptions = 3; // thread dies if too many exceptions.\r
158     boolean jobComplete = false;\r
159 \r
160     Alignment dataset; // dataset to which the new alignment will be associated.\r
161 \r
162     MsaWSThread(String title, SequenceI[] msa, boolean subgaps,\r
163                 boolean presorder, Alignment seqset)\r
164     {\r
165       alTitle = title;\r
166       submitGaps = subgaps;\r
167       preserveOrder = presorder;\r
168       dataset = seqset;\r
169       OutputHeader = wsInfo.getProgressText();\r
170       SeqNames = new Hashtable();\r
171 \r
172       vamsas.objects.simple.Sequence[] seqarray = new vamsas.objects.simple.\r
173           Sequence[msa.length];\r
174 \r
175       for (int i = 0; i < msa.length; i++)\r
176       {\r
177         String newname = jalview.analysis.SeqsetUtils.unique_name(i);\r
178 \r
179         // uniquify as we go\r
180         // TODO: JBPNote: this is a ubiquitous transformation - set of jalview seq objects to vamsas sequences with name preservation\r
181         SeqNames.put(newname,\r
182                      jalview.analysis.SeqsetUtils.SeqCharacterHash(msa[i]));\r
183         seqarray[i] = new vamsas.objects.simple.Sequence();\r
184         seqarray[i].setId(newname);\r
185         seqarray[i].setSeq( (submitGaps) ? msa[i].getSequence()\r
186                            : AlignSeq.extractGaps(\r
187                                jalview.util.Comparison.GapChars,\r
188                                msa[i].getSequence()));\r
189       }\r
190 \r
191       this.seqs = new vamsas.objects.simple.SequenceSet();\r
192       this.seqs.setSeqs(seqarray);\r
193     }\r
194 \r
195     public boolean isCancellable()\r
196     {\r
197       return true;\r
198     }\r
199 \r
200     public void cancelJob()\r
201     {\r
202       if ( (jobId != null) && !jobId.equals("") && !jobComplete)\r
203       {\r
204         String cancelledMessage = "";\r
205 \r
206         try\r
207         {\r
208           vamsas.objects.simple.WsJobId cancelledJob = server.cancel(jobId);\r
209 \r
210           if (cancelledJob.getStatus() == 2)\r
211           {\r
212             // CANCELLED_JOB\r
213             cancelledMessage = "Job cancelled.";\r
214             wsInfo.setStatus(WebserviceInfo.STATE_CANCELLED_OK);\r
215             jobComplete = true;\r
216             jobsRunning--;\r
217             result = null;\r
218           }\r
219           else if (cancelledJob.getStatus() == 3)\r
220           {\r
221             // VALID UNSTOPPABLE JOB\r
222             cancelledMessage +=\r
223                 "Server cannot cancel this job. just close the window.\n";\r
224           }\r
225 \r
226           if (cancelledJob.getJobId() != null)\r
227           {\r
228             cancelledMessage += ("[" + cancelledJob.getJobId() +\r
229                                  "]");\r
230           }\r
231 \r
232           cancelledMessage += "\n";\r
233         }\r
234         catch (Exception exc)\r
235         {\r
236           cancelledMessage +=\r
237               ("\nProblems cancelling the job : Exception received...\n" +\r
238                exc + "\n");\r
239           exc.printStackTrace();\r
240         }\r
241 \r
242         wsInfo.setProgressText(OutputHeader + cancelledMessage + "\n");\r
243       }\r
244       else\r
245       {\r
246         if (!jobComplete)\r
247         {\r
248           wsInfo.setProgressText(OutputHeader +\r
249                                  "Server cannot cancel this job because it has not been submitted properly. just close the window.\n");\r
250         }\r
251       }\r
252     }\r
253 \r
254     public void run()\r
255     {\r
256       StartJob();\r
257 \r
258       while (!jobComplete && (allowedServerExceptions > 0))\r
259       {\r
260         try\r
261         {\r
262           if ( (result = server.getResult(jobId)) == null)\r
263           {\r
264             throw (new Exception(\r
265                 "Timed out when communicating with server\nTry again later.\n"));\r
266           }\r
267           jalview.bin.Cache.log.debug("Result state " + result.getState() +\r
268                                         "(ServerError=" + result.isServerError() +\r
269                                         ")");\r
270           if (result.isRunning())\r
271           {\r
272             wsInfo.setStatus(WebserviceInfo.STATE_RUNNING);\r
273           }\r
274           else if (result.isQueued())\r
275           {\r
276             wsInfo.setStatus(WebserviceInfo.STATE_QUEUING);\r
277           }\r
278 \r
279           if (result.isFinished())\r
280           {\r
281             wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_OK);\r
282             wsInfo.showResultsNewFrame.addActionListener(new java.awt.event.ActionListener()\r
283                 {\r
284                   public void actionPerformed(java.awt.event.ActionEvent evt)\r
285                   {\r
286                     displayResults(true);\r
287                   }\r
288                 });\r
289            wsInfo.mergeResults.addActionListener(new java.awt.event.ActionListener()\r
290                 {\r
291                   public void actionPerformed(java.awt.event.ActionEvent evt)\r
292                   {\r
293                     displayResults(false);\r
294                   }\r
295                 });\r
296            wsInfo.setResultsReady();\r
297             parseResult();\r
298             jobComplete = true;\r
299             jobsRunning--;\r
300           }\r
301           else\r
302           {\r
303             if (result.getStatus() != null)\r
304             {\r
305               wsInfo.setProgressText(OutputHeader + "\n"+   result.getStatus());\r
306             }\r
307             if (result.isServerError())\r
308             {\r
309               jobComplete = true;\r
310               jobsRunning--;\r
311 \r
312               break;\r
313             }\r
314             if (! (result.isJobFailed() || result.isServerError() ||\r
315                    result.isBroken() || result.isFailed()))\r
316             {\r
317               Thread.sleep(5000);\r
318 \r
319               //  System.out.println("I'm alive "+seqid+" "+jobid);\r
320             }\r
321             else\r
322             {\r
323               jobComplete = true;\r
324               jobsRunning--;\r
325               break;\r
326             }\r
327           }\r
328         }\r
329         catch (Exception ex)\r
330         {\r
331           allowedServerExceptions--;\r
332           wsInfo.appendProgressText("\n" + ServiceName +\r
333                                     " Server exception!\n" + ex.getMessage());\r
334           System.err.println(ServiceName + " Server exception: " +\r
335                              ex.getMessage());\r
336 \r
337           //          ex.printStackTrace(); JBPNote Debug\r
338           try\r
339           {\r
340             if (allowedServerExceptions > 0)\r
341             {\r
342               Thread.sleep(5000);\r
343             }\r
344           }\r
345           catch (InterruptedException ex1)\r
346           {\r
347           }\r
348         }\r
349         catch(OutOfMemoryError er)\r
350         {\r
351           jobComplete = true;\r
352           wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_ERROR);\r
353           JOptionPane.showInternalMessageDialog(Desktop.desktop,\r
354               "Out of memory handling result!!"\r
355              +"\nSee help files for increasing Java Virtual Machine memory."\r
356              ,"Out of memory", JOptionPane.WARNING_MESSAGE );\r
357           System.out.println("MsaWSClient: "+er);\r
358           System.gc();\r
359         }\r
360       }\r
361 \r
362       if (allowedServerExceptions == 0)\r
363       {\r
364         wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_SERVERERROR);\r
365       }\r
366       else\r
367       {\r
368         if (result != null)\r
369         {\r
370           if ( !(result.isJobFailed() || result.isServerError()))\r
371           {\r
372             wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_OK);\r
373           }\r
374 \r
375           if (result.isBroken() || result.isFailed())\r
376           {\r
377             wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_ERROR);\r
378           }\r
379 \r
380           if (result.isServerError())\r
381           {\r
382             wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_SERVERERROR);\r
383           }\r
384         }\r
385       }\r
386     }\r
387 \r
388     void StartJob()\r
389     {\r
390       try\r
391       {\r
392         vamsas.objects.simple.WsJobId jobsubmit = server.align(seqs);\r
393 \r
394         if ( (jobsubmit != null) && (jobsubmit.getStatus() == 1))\r
395         {\r
396           jobId = jobsubmit.getJobId();\r
397           System.out.println(WsURL + " Job Id '" + jobId + "'");\r
398         }\r
399         else\r
400         {\r
401           if (jobsubmit == null)\r
402           {\r
403             throw new Exception("Server at " + WsURL +\r
404                                 " returned null object, it probably cannot be contacted. Try again later ?");\r
405           }\r
406 \r
407           throw new Exception(jobsubmit.getJobId());\r
408         }\r
409       }\r
410       catch (Exception e)\r
411       {\r
412         // TODO: JBPNote catch timeout or other fault types explicitly\r
413         // For unexpected errors\r
414         System.err.println(WebServiceName +\r
415                            "Client: Failed to submit the sequences for alignment (probably a server side problem)\n" +\r
416                            "When contacting Server:" + WsURL + "\n" +\r
417                            e.toString() +\r
418                            "\n");\r
419         this.allowedServerExceptions = 0;\r
420         wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_SERVERERROR);\r
421         wsInfo.appendProgressText(\r
422             "Failed to submit sequences for alignment.\n" +\r
423             "It is most likely that there is a problem with the server.\n" +\r
424             "Just close the window\n");\r
425 \r
426         // e.printStackTrace(); // TODO: JBPNote DEBUG\r
427       }\r
428     }\r
429 \r
430     private jalview.datamodel.Sequence[] getVamsasAlignment(\r
431         vamsas.objects.simple.Alignment valign)\r
432     {\r
433       vamsas.objects.simple.Sequence[] seqs = valign.getSeqs().getSeqs();\r
434       jalview.datamodel.Sequence[] msa = new jalview.datamodel.Sequence[seqs.\r
435           length];\r
436 \r
437       for (int i = 0, j = seqs.length; i < j; i++)\r
438       {\r
439         msa[i] = new jalview.datamodel.Sequence(seqs[i].getId(),\r
440                                                 seqs[i].getSeq());\r
441       }\r
442 \r
443       return msa;\r
444     }\r
445 \r
446     void parseResult()\r
447     {\r
448 \r
449       try\r
450       {\r
451         // OutputHeader = output.getText();\r
452         if (result.isFailed())\r
453         {\r
454           OutputHeader += "Job failed.\n";\r
455         }\r
456 \r
457         if (result.getStatus() != null)\r
458         {\r
459           OutputHeader += ("\n" + result.getStatus());\r
460         }\r
461 \r
462         if (result.getMsa() != null)\r
463         {\r
464           OutputHeader += "\nAlignment Object Method Notes\n";\r
465 \r
466           String[] lines = result.getMsa().getMethod();\r
467 \r
468           for (int line = 0; line < lines.length; line++)\r
469           {\r
470             OutputHeader += (lines[line] + "\n");\r
471           }\r
472 \r
473           // JBPNote The returned files from a webservice could be\r
474           // hidden behind icons in the monitor window that,\r
475           // when clicked, pop up their corresponding data\r
476         }\r
477 \r
478         wsInfo.setProgressText(OutputHeader);\r
479       }\r
480       catch (Exception ex)\r
481       {\r
482         ex.printStackTrace();\r
483       }\r
484     }\r
485 \r
486     void displayResults(boolean newFrame)\r
487     {\r
488       SequenceI [] seqs = getVamsasAlignment(result.getMsa());\r
489 \r
490       if (seqs != null)\r
491        {\r
492          AlignmentOrder msaorder = new AlignmentOrder(seqs);\r
493 \r
494          if (preserveOrder)\r
495          {\r
496            jalview.analysis.AlignmentSorter.recoverOrder(seqs);\r
497          }\r
498 \r
499          jalview.analysis.SeqsetUtils.deuniquify(SeqNames, seqs);\r
500 \r
501          Alignment al = new Alignment(seqs);\r
502          if (dataset!=null)\r
503          {\r
504            al.setDataset(dataset);\r
505          }\r
506 \r
507          if(newFrame)\r
508          {\r
509            // TODO: JBPNote Should also rename the query sequence sometime...\r
510            AlignFrame af = new AlignFrame(al);\r
511 \r
512          //>>>This is a fix for the moment, until a better solution is found!!<<<\r
513            af.getFeatureRenderer().transferSettings(alignFrame.getFeatureRenderer());\r
514 \r
515            af.addSortByOrderMenuItem(ServiceName + " Ordering",\r
516                                      msaorder);\r
517 \r
518            Desktop.addInternalFrame(af, alTitle,\r
519                                     AlignFrame.NEW_WINDOW_WIDTH,\r
520                                     AlignFrame.NEW_WINDOW_HEIGHT);\r
521 \r
522          }\r
523          else\r
524          {\r
525            System.out.println("MERGE WITH OLD FRAME");\r
526 \r
527          }\r
528        }\r
529     }\r
530   }\r
531 }\r