JAL-1759 updates for Jmol 14.2.14_25.06.11
[jalview.git] / src / jalview / ws / EnfinEnvision2OneWay.java
1 /*
2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
4  * 
5  * This file is part of Jalview.
6  * 
7  * Jalview is free software: you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License 
9  * as published by the Free Software Foundation, either version 3
10  * of the License, or (at your option) any later version.
11  *  
12  * Jalview is distributed in the hope that it will be useful, but 
13  * WITHOUT ANY WARRANTY; without even the implied warranty 
14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
15  * PURPOSE.  See the GNU General Public License for more details.
16  * 
17  * You should have received a copy of the GNU General Public License
18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
19  * The Jalview Authors are detailed in the 'AUTHORS' file.
20  */
21 package jalview.ws;
22
23 import java.awt.Component;
24 import java.awt.Cursor;
25 import java.awt.event.ActionEvent;
26 import java.io.UnsupportedEncodingException;
27 import java.net.URL;
28 import java.net.URLEncoder;
29 import java.util.Hashtable;
30 import java.util.Map;
31 import java.util.Vector;
32 import java.util.regex.Pattern;
33
34 import javax.swing.JMenu;
35 import javax.swing.JMenuItem;
36 import javax.swing.JOptionPane;
37 import javax.swing.event.MenuEvent;
38 import javax.swing.event.MenuListener;
39 import javax.xml.parsers.SAXParser;
40 import javax.xml.parsers.SAXParserFactory;
41
42 import org.xml.sax.Attributes;
43 import org.xml.sax.SAXException;
44 import org.xml.sax.helpers.DefaultHandler;
45
46 import jalview.bin.Cache;
47 import jalview.datamodel.DBRefEntry;
48 import jalview.datamodel.SequenceGroup;
49 import jalview.datamodel.SequenceI;
50 import jalview.gui.AlignFrame;
51 import jalview.gui.Desktop;
52 import jalview.gui.JvSwingUtils;
53 import jalview.util.GroupUrlLink;
54 import jalview.util.GroupUrlLink.UrlStringTooLongException;
55 import jalview.util.MessageManager;
56
57 /**
58  * Lightweight runnable to discover dynamic 'one way' group URL services
59  * 
60  * as of Jalview 2.8.1 this class is mothballed and will be dropped in v3.
61  * 
62  * @author JimP
63  * @deprecated
64  * 
65  */
66 @Deprecated
67 public class EnfinEnvision2OneWay extends DefaultHandler implements
68         Runnable, WSMenuEntryProviderI
69 {
70   private static EnfinEnvision2OneWay groupURLLinksGatherer = null;
71
72   public static EnfinEnvision2OneWay getInstance()
73   {
74     if (groupURLLinksGatherer == null)
75     {
76       groupURLLinksGatherer = new EnfinEnvision2OneWay();
77     }
78     return groupURLLinksGatherer;
79   }
80
81   private void waitForCompletion()
82   {
83     if (groupURLLinksGatherer.isRunning())
84     {
85       // wait around and show a visual delay indicator
86       Cursor oldCursor = Desktop.instance.getCursor();
87       Desktop.instance.setCursor(new Cursor(Cursor.WAIT_CURSOR));
88       while (groupURLLinksGatherer.isRunning())
89       {
90         try
91         {
92           Thread.sleep(100);
93         } catch (InterruptedException e)
94         {
95         }
96         ;
97       }
98       Desktop.instance.setCursor(oldCursor);
99     }
100   }
101
102   public Vector getEnvisionServiceGroupURLS()
103   {
104     waitForCompletion();
105     return groupURLLinks;
106   }
107
108   /**
109    * indicate if
110    */
111   private static String BACKGROUND = "BACKGROUNDPARAM";
112
113   /**
114    * contains null strings or one of the above constants - indicate if this URL
115    * is a special case.
116    */
117   private Vector additionalPar = new Vector();
118
119   /**
120    * the enfin service URL
121    */
122   private String enfinService = null;
123
124   private String description = null;
125
126   private String wfname;
127
128   /*
129    * (non-Javadoc)
130    * 
131    * @see org.xml.sax.helpers.DefaultHandler#endElement(java.lang.String,
132    * java.lang.String, java.lang.String)
133    */
134   public void endElement(String uri, String localName, String qName)
135           throws SAXException
136   {
137
138     // System.err.println("End element: : '"+uri+" "+localName+" "+qName);
139     if (qName.equalsIgnoreCase("workflow") && description != null
140             && description.length() > 0)
141     {
142       // groupURLLinks.addElement("UNIPROT|EnVision2|http://www.ebi.ac.uk/enfin-srv/envision2/pages/linkin.jsf?tool=Jalview&workflow=Default&datasetName=JalviewIDs$DATASETID$&input=$SEQUENCEIDS$&inputType=0|,");
143       // groupURLLinks.addElement("Seqs|EnVision2|http://www.ebi.ac.uk/enfin-srv/envision2/pages/linkin.jsf?tool=Jalview&workflow=Default&datasetName=JalviewSeqs$DATASETID$&input=$SEQUENCES=/([A-Za-z]+)+/=$&inputType=1|,");
144       System.err.println("Adding entry for " + wfname + " " + description);
145       if (wfname.toLowerCase().indexOf("funcnet") == -1)
146       {
147         description = Pattern.compile("\\s+", Pattern.MULTILINE)
148                 .matcher(description).replaceAll(" ");
149         groupURLdescr.addElement(description);
150         groupURLdescr.addElement(description);
151         String urlstub = wfname;
152         if (wfname.indexOf(" ") > -1)
153         {
154           // make the name safe!
155           try
156           {
157             urlstub = URLEncoder.encode(wfname, "utf-8");
158           } catch (UnsupportedEncodingException e)
159           {
160             // TODO Auto-generated catch block
161             e.printStackTrace();
162           }
163         }
164         groupURLLinks
165                 .addElement(wfname
166                         + "|"
167                         + "http://www.ebi.ac.uk/enfin-srv/envision2/pages/linkin.jsf?tool=Jalview&workflow="
168                         + urlstub
169                         + "&datasetName=JalviewSeqs$DATASETID$&input=$SEQUENCEIDS$&inputType=0|,"); // #"+description+"#");
170         groupURLLinks
171                 .addElement(wfname
172                         + "|"
173                         + "http://www.ebi.ac.uk/enfin-srv/envision2/pages/linkin.jsf?tool=Jalview&workflow="
174                         + urlstub
175                         + "&datasetName=JalviewSeqs$DATASETID$&input=$SEQUENCES=/([A-Za-z]+)+/=$&inputType=1|,"); // #"+description+"#");
176       }
177     }
178   }
179
180   /*
181    * (non-Javadoc)
182    * 
183    * @see org.xml.sax.helpers.DefaultHandler#characters(char[], int, int)
184    */
185   public void characters(char[] ch, int start, int length)
186           throws SAXException
187   {
188     if (description != null)
189     {
190       for (int i = start; i < start + length; i++)
191       {
192         description += ch[i];
193       }
194     }
195   }
196
197   /*
198    * (non-Javadoc)
199    * 
200    * @see org.xml.sax.helpers.DefaultHandler#startElement(java.lang.String,
201    * java.lang.String, java.lang.String, org.xml.sax.Attributes)
202    */
203   public void startElement(String uri, String localName, String qName,
204           Attributes attributes) throws SAXException
205   {
206     if (qName.equalsIgnoreCase("workflow"))
207     {
208       description = null;
209       wfname = attributes.getValue("name");
210     }
211     if (qName.equalsIgnoreCase("description"))
212     {
213       description = "";
214     }
215
216     // System.err.println("Start element: : '"+uri+" "+localName+" "+qName+" attributes"+attributes);
217     // super.startElement(uri,localName,qname,attributes);
218   }
219
220   private boolean started = false;
221
222   private boolean running = false;
223
224   private Vector groupURLLinks = null;
225
226   private Vector groupURLdescr = null;
227
228   private static String[] allowedDb = new String[]
229   { "UNIPROT", "EMBL", "PDB" };
230
231   public EnfinEnvision2OneWay()
232   {
233     groupURLLinks = new Vector();
234     groupURLdescr = new Vector();
235
236     enfinService = Cache.getDefault("ENVISION2_WORKFLOWSERVICE",
237             "http://www.ebi.ac.uk/enfin-srv/envision2/pages/workflows.xml");
238     new Thread(this).start();
239   }
240
241   public void run()
242   {
243     started = true;
244     running = true;
245     try
246     {
247       SAXParserFactory spf = SAXParserFactory.newInstance();
248       SAXParser sp = spf.newSAXParser();
249       sp.parse(new URL(enfinService).openStream(), this);
250     } catch (Exception e)
251     {
252       Cache.log.warn("Exception when discovering One Way services: ", e);
253     } catch (Error e)
254     {
255       Cache.log.warn("Error when discovering One Way services: ", e);
256     }
257     running = false;
258     Cache.log.debug("Finished running.");
259   }
260
261   /**
262    * have we finished running yet ?
263    * 
264    * @return false if we have been run.
265    */
266   public boolean isRunning()
267   {
268
269     // TODO Auto-generated method stub
270     return !started || running;
271   }
272
273   public static void main(String[] args)
274   {
275     Cache.initLogger();
276     EnfinEnvision2OneWay ow = new EnfinEnvision2OneWay();
277     while (ow.isRunning())
278     {
279       try
280       {
281         Thread.sleep(50);
282       } catch (Exception e)
283       {
284       }
285       ;
286
287     }
288     for (int i = 0; i < ow.groupURLLinks.size(); i++)
289     {
290       System.err.println("Description" + ow.groupURLdescr.elementAt(i)
291               + "Service URL: " + ow.groupURLLinks.elementAt(i));
292     }
293   }
294
295   // / Copied from jalview.gui.PopupMenu
296   /**
297    * add a late bound URL service item to the given menu
298    * 
299    * @param linkMenu
300    * @param label
301    *          - menu label string
302    * @param urlgenerator
303    *          GroupURLLink used to generate URL
304    * @param urlstub
305    *          Object array returned from the makeUrlStubs function.
306    */
307   private void addshowLink(JMenu linkMenu, String label, String descr,
308           String dbname, final GroupUrlLink urlgenerator,
309           final Object[] urlstub)
310   {
311     Component[] jmi = linkMenu.getMenuComponents();
312     for (int i = 0; i < jmi.length; i++)
313     {
314       if (jmi[i] instanceof JMenuItem
315               && ((JMenuItem) jmi[i]).getText().equalsIgnoreCase(label))
316       {
317         // don't add this - its a repeat of an existing URL.
318         return;
319       }
320     }
321     try
322     {
323       // TODO check with Jim if this class (EnfinEnvision) is obsolete
324       // descr = HtmlEncoder.encode(descr); // iText removed from Jmol 14.2
325     } catch (Exception e)
326     {
327     }
328     ;
329
330     boolean seqsorids = (urlgenerator.getGroupURLType() & urlgenerator.SEQUENCEIDS) == 0;
331     int i = urlgenerator.getNumberInvolved(urlstub);
332     JMenuItem item = new JMenuItem(label);
333     //
334     if (dbname == null || dbname.trim().length() == 0)
335     {
336       dbname = "";
337     }
338     item.setToolTipText(JvSwingUtils.wrapTooltip(true, MessageManager.formatMessage("label.submit_sequence", new String[]{Integer.valueOf(i).toString(), dbname, (seqsorids ? "sequence" : "sequence id"), (i > 1 ? "s" : "")})));
339     item.addActionListener(new java.awt.event.ActionListener()
340     {
341       public void actionPerformed(ActionEvent e)
342       {
343         new Thread(new Runnable()
344         {
345
346           public void run()
347           {
348             try
349             {
350               showLink(urlgenerator.constructFrom(urlstub));
351             } catch (UrlStringTooLongException ex)
352             {
353               Cache.log.warn("Not showing link: URL is too long!", ex);
354             }
355           }
356
357         }).start();
358       }
359     });
360
361     linkMenu.add(item);
362   }
363
364   /**
365    * open the given link in a new browser window
366    * 
367    * @param url
368    */
369   public void showLink(String url)
370   {
371     try
372     {
373       jalview.util.BrowserLauncher.openURL(url);
374     } catch (Exception ex)
375     {
376       JOptionPane
377               .showInternalMessageDialog(
378                       Desktop.desktop,
379                       MessageManager.getString("label.web_browser_not_found_unix"),
380                       MessageManager.getString("label.web_browser_not_found"), JOptionPane.WARNING_MESSAGE);
381
382       ex.printStackTrace();
383     }
384   }
385
386   /**
387    * called by a web service menu instance when it is opened.
388    * 
389    * @param enfinServiceMenu
390    * @param alignFrame
391    */
392   private void buildGroupLinkMenu(JMenu enfinServiceMenu,
393           AlignFrame alignFrame)
394   {
395     if (running || !started)
396     {
397       return;
398     }
399     SequenceI[] seqs = alignFrame.getViewport().getSelectionAsNewSequence();
400     SequenceGroup sg = alignFrame.getViewport().getSelectionGroup();
401     if (sg == null)
402     {
403       // consider visible regions here/
404     }
405     enfinServiceMenu.removeAll();
406     JMenu entries = buildGroupURLMenu(seqs, sg);
407     if (entries != null)
408     {
409       for (int i = 0, iSize = entries.getMenuComponentCount(); i < iSize; i++)
410       {
411         // transfer - menu component is removed from entries automatically
412         enfinServiceMenu.add(entries.getMenuComponent(0));
413       }
414       // entries.removeAll();
415       enfinServiceMenu.setEnabled(true);
416     }
417     else
418     {
419       enfinServiceMenu.setEnabled(false);
420     }
421   }
422
423   /**
424    * construct a dynamic enfin services menu given a sequence selection
425    * 
426    * @param seqs
427    * @param sg
428    * @param groupLinks
429    * @return
430    */
431   private JMenu buildGroupURLMenu(SequenceI[] seqs, SequenceGroup sg)
432   {
433     if (groupURLdescr == null || groupURLLinks == null)
434     {
435       return null;
436     }
437     // TODO: usability: thread off the generation of group url content so root
438     // menu appears asap
439     // sequence only URLs
440     // ID/regex match URLs
441     JMenu groupLinksMenu = new JMenu(MessageManager.getString("action.group_link"));
442     String[][] idandseqs = GroupUrlLink.formStrings(seqs);
443     Hashtable commonDbrefs = new Hashtable();
444     for (int sq = 0; sq < seqs.length; sq++)
445     {
446
447       int start, end;
448       if (sg != null)
449       {
450         start = seqs[sq].findPosition(sg.getStartRes());
451         end = seqs[sq].findPosition(sg.getEndRes());
452       }
453       else
454       {
455         // get total width of alignment.
456         start = seqs[sq].getStart();
457         end = seqs[sq].findPosition(seqs[sq].getLength());
458       }
459       // we skip sequences which do not have any non-gaps in the region of
460       // interest
461       if (start > end)
462       {
463         continue;
464       }
465       // just collect ids from dataset sequence
466       // TODO: check if IDs collected from selecton group intersects with the
467       // current selection, too
468       SequenceI sqi = seqs[sq];
469       while (sqi.getDatasetSequence() != null)
470       {
471         sqi = sqi.getDatasetSequence();
472       }
473       DBRefEntry[] dbr = sqi.getDBRef();
474       if (dbr != null && dbr.length > 0)
475       {
476         for (int d = 0; d < dbr.length; d++)
477         {
478           String src = dbr[d].getSource(); // jalview.util.DBRefUtils.getCanonicalName(dbr[d].getSource()).toUpperCase();
479           Object[] sarray = (Object[]) commonDbrefs.get(src);
480           if (sarray == null)
481           {
482             sarray = new Object[2];
483             sarray[0] = new int[]
484             { 0 };
485             sarray[1] = new String[seqs.length];
486
487             commonDbrefs.put(src, sarray);
488           }
489
490           if (((String[]) sarray[1])[sq] == null)
491           {
492             if (!dbr[d].hasMap()
493                     || (dbr[d].getMap().locateMappedRange(start, end) != null))
494             {
495               ((String[]) sarray[1])[sq] = dbr[d].getAccessionId();
496               ((int[]) sarray[0])[0]++;
497             }
498           }
499         }
500       }
501     }
502     // now create group links for all distinct ID/sequence sets.
503     Hashtable<String, JMenu[]> gurlMenus = new Hashtable<String, JMenu[]>();
504     /**
505      * last number of sequences where URL generation failed
506      */
507     int[] nsqtype = new int[]
508     { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 };
509     for (int i = 0; i < groupURLLinks.size(); i++)
510     {
511       String link = (String) groupURLLinks.elementAt(i);
512       String descr = (String) groupURLdescr.elementAt(i);
513
514       // boolean specialCase =
515       // additionalPar.elementAt(i).toString().equals(BACKGROUND);
516       GroupUrlLink urlLink = null;
517       try
518       {
519         urlLink = new GroupUrlLink(link);
520       } catch (Exception foo)
521       {
522         jalview.bin.Cache.log.error("Exception for GroupURLLink '" + link
523                 + "'", foo);
524         continue;
525       }
526       ;
527       if (!urlLink.isValid())
528       {
529         jalview.bin.Cache.log.error(urlLink.getInvalidMessage());
530         continue;
531       }
532       final String label = urlLink.getLabel();
533       // create/recover the sub menus that might be populated for this link.
534       JMenu[] wflinkMenus = gurlMenus.get(label);
535       if (wflinkMenus == null)
536       {
537         // three types of url that might be
538         // created.
539         wflinkMenus = new JMenu[]
540         { null, new JMenu(MessageManager.getString("action.ids")), new JMenu(MessageManager.getString("action.sequences")),
541             new JMenu(MessageManager.getString("action.ids_sequences")) };
542         gurlMenus.put(label, wflinkMenus);
543       }
544
545       boolean usingNames = false;
546       // Now see which parts of the group apply for this URL
547       String ltarget;
548       String[] seqstr, ids; // input to makeUrl
549       for (int t = 0; t < allowedDb.length; t++)
550       {
551         ltarget = allowedDb[t]; // jalview.util.DBRefUtils.getCanonicalName(urlLink.getTarget());
552         Object[] idset = (Object[]) commonDbrefs.get(ltarget.toUpperCase());
553         if (idset != null)
554         {
555           int numinput = ((int[]) idset[0])[0];
556           String[] allids = ((String[]) idset[1]);
557           seqstr = new String[numinput];
558           ids = new String[numinput];
559           if (nsqtype[urlLink.getGroupURLType()] > 0
560                   && numinput >= nsqtype[urlLink.getGroupURLType()])
561           {
562             continue;
563           }
564           for (int sq = 0, idcount = 0; sq < seqs.length; sq++)
565           {
566             if (allids[sq] != null)
567             {
568               ids[idcount] = allids[sq];
569               seqstr[idcount++] = idandseqs[1][sq];
570             }
571           }
572           try
573           {
574             createAndAddLinks(wflinkMenus, false, urlLink, ltarget, null,
575                     descr, ids, seqstr);
576           } catch (UrlStringTooLongException ex)
577           {
578             nsqtype[urlLink.getGroupURLType()] = numinput;
579           }
580         }
581       }
582       // also do names only.
583       seqstr = idandseqs[1];
584       ids = idandseqs[0];
585       if (nsqtype[urlLink.getGroupURLType()] > 0
586               && idandseqs[0].length >= nsqtype[urlLink.getGroupURLType()])
587       {
588         continue;
589       }
590
591       try
592       {
593         createAndAddLinks(wflinkMenus, true, urlLink, "Any", null, descr,
594                 ids, seqstr);
595       } catch (UrlStringTooLongException ex)
596       {
597         nsqtype[urlLink.getGroupURLType()] = idandseqs[0].length;
598       }
599     }
600     boolean anyadded = false; // indicates if there are any group links to give
601     // to user
602     for (Map.Entry<String, JMenu[]> menues : gurlMenus.entrySet())
603     {
604       JMenu grouplinkset = new JMenu(menues.getKey());
605       JMenu[] wflinkMenus = menues.getValue();
606       for (int m = 0; m < wflinkMenus.length; m++)
607       {
608         if (wflinkMenus[m] != null
609                 && wflinkMenus[m].getMenuComponentCount() > 0)
610         {
611           anyadded = true;
612           grouplinkset.add(wflinkMenus[m]);
613         }
614       }
615       groupLinksMenu.add(grouplinkset);
616     }
617     if (anyadded)
618     {
619       return groupLinksMenu;
620     }
621     return null;
622   }
623
624   private boolean createAndAddLinks(JMenu[] linkMenus, boolean usingNames,
625           GroupUrlLink urlLink, String label, String ltarget, String descr,
626           String[] ids, String[] seqstr) throws UrlStringTooLongException
627   {
628     Object[] urlset = urlLink.makeUrlStubs(ids, seqstr, "FromJalview"
629             + System.currentTimeMillis(), false);
630
631     if (urlset != null)
632     {
633       int type = urlLink.getGroupURLType() & 3;
634       // System.out.println(urlLink.getGroupURLType()
635       // +" "+((String[])urlset[3])[0]);
636       // first two bits ofurlLink type bitfield are sequenceids and sequences
637       // TODO: FUTURE: ensure the groupURL menu structure can be generalised
638       addshowLink(
639               linkMenus[type],
640               label
641                       + " "
642                       + (ltarget == null ? (((type & 1) == 1 ? "ID"
643                               : "Sequence") + (urlLink
644                               .getNumberInvolved(urlset) > 1 ? "s" : ""))
645                               : (usingNames ? (((type & 1) == 1) ? "(Names)"
646                                       : "")
647                                       : ("(" + ltarget + ")"))), descr,
648               usingNames ? null : label, urlLink, urlset);
649       return true;
650     }
651     return false;
652   }
653
654   // / end of stuff copied from popupmenu
655   public void attachWSMenuEntry(final JMenu wsmenu,
656           final AlignFrame alignFrame)
657   {
658     final JMenu enfinServiceMenu = new JMenu("Envision 2");
659     wsmenu.add(enfinServiceMenu);
660     enfinServiceMenu.setEnabled(false);
661     wsmenu.addMenuListener(new MenuListener()
662     {
663       // this listener remembers when the menu was first selected, and
664       // doesn't rebuild the session list until it has been cleared and
665       // reselected again.
666       boolean refresh = true;
667
668       public void menuCanceled(MenuEvent e)
669       {
670         refresh = true;
671       }
672
673       public void menuDeselected(MenuEvent e)
674       {
675         refresh = true;
676       }
677
678       public void menuSelected(MenuEvent e)
679       {
680         if (refresh && !isRunning())
681         {
682           new Thread(new Runnable()
683           {
684             public void run()
685             {
686               try
687               {
688                 buildGroupLinkMenu(enfinServiceMenu, alignFrame);
689               } catch (OutOfMemoryError ex)
690               {
691                 Cache.log
692                         .error("Out of memory when calculating the Envision2 links.",
693                                 ex);
694                 enfinServiceMenu.setEnabled(false);
695               }
696             }
697           }).start();
698           refresh = false;
699         }
700       }
701     });
702
703   }
704
705 }