2 * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7)
3 * Copyright (C) 2011 J Procter, AM Waterhouse, J Engelhardt, LM Lui, G Barton, M Clamp, S Searle
5 * This file is part of Jalview.
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 of the License, or (at your option) any later version.
11 * Jalview is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty
13 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
14 * PURPOSE. See the GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License along with Jalview. If not, see <http://www.gnu.org/licenses/>.
20 import jalview.bin.Cache;
21 import jalview.datamodel.DBRefEntry;
22 import jalview.datamodel.SequenceGroup;
23 import jalview.datamodel.SequenceI;
24 import jalview.gui.AlignFrame;
25 import jalview.gui.Desktop;
26 import jalview.gui.JvSwingUtils;
27 import jalview.util.GroupUrlLink;
28 import jalview.util.GroupUrlLink.UrlStringTooLongException;
30 import java.awt.Component;
31 import java.awt.Cursor;
32 import java.awt.event.ActionEvent;
33 import java.awt.event.ActionListener;
34 import java.awt.event.ItemEvent;
35 import java.awt.event.ItemListener;
36 import java.io.BufferedOutputStream;
37 import java.io.BufferedReader;
38 import java.io.InputStreamReader;
39 import java.io.OutputStreamWriter;
40 import java.io.PrintWriter;
41 import java.io.StringWriter;
42 import java.io.UnsupportedEncodingException;
44 import java.net.URLEncoder;
45 import java.nio.charset.Charset;
46 import java.nio.charset.CharsetEncoder;
47 import java.util.Hashtable;
49 import java.util.Vector;
50 import java.util.regex.Pattern;
52 import javax.swing.JMenu;
53 import javax.swing.JMenuItem;
54 import javax.swing.JOptionPane;
55 import javax.swing.event.MenuEvent;
56 import javax.swing.event.MenuListener;
57 import javax.xml.parsers.SAXParser;
58 import javax.xml.parsers.SAXParserFactory;
60 import org.apache.axis.utils.StringUtils;
61 import org.apache.http.client.utils.URLEncodedUtils;
62 import org.apache.http.entity.StringEntity;
63 import org.xml.sax.Attributes;
64 import org.xml.sax.SAXException;
65 import org.xml.sax.helpers.DefaultHandler;
67 import com.lowagie.text.html.HtmlEncoder;
70 * Lightweight runnable to discover dynamic 'one way' group URL services
75 public class EnfinEnvision2OneWay extends DefaultHandler implements
76 Runnable, WSMenuEntryProviderI
78 private static EnfinEnvision2OneWay groupURLLinksGatherer = null;
80 public static EnfinEnvision2OneWay getInstance()
82 if (groupURLLinksGatherer == null)
84 groupURLLinksGatherer = new EnfinEnvision2OneWay();
86 return groupURLLinksGatherer;
89 private void waitForCompletion()
91 if (groupURLLinksGatherer.isRunning())
93 // wait around and show a visual delay indicator
94 Cursor oldCursor = Desktop.instance.getCursor();
95 Desktop.instance.setCursor(new Cursor(Cursor.WAIT_CURSOR));
96 while (groupURLLinksGatherer.isRunning())
101 } catch (InterruptedException e)
106 Desktop.instance.setCursor(oldCursor);
110 public Vector getEnvisionServiceGroupURLS()
113 return groupURLLinks;
119 private static String BACKGROUND = "BACKGROUNDPARAM";
122 * contains null strings or one of the above constants - indicate if this URL
125 private Vector additionalPar = new Vector();
128 * the enfin service URL
130 private String enfinService = null;
132 private String description = null;
134 private String wfname;
139 * @see org.xml.sax.helpers.DefaultHandler#endElement(java.lang.String,
140 * java.lang.String, java.lang.String)
142 public void endElement(String uri, String localName, String qName)
146 // System.err.println("End element: : '"+uri+" "+localName+" "+qName);
147 if (qName.equalsIgnoreCase("workflow") && description != null
148 && description.length() > 0)
150 // 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|,");
151 // 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|,");
152 System.err.println("Adding entry for " + wfname + " " + description);
153 if (wfname.toLowerCase().indexOf("funcnet") == -1)
155 description = Pattern.compile("\\s+", Pattern.MULTILINE)
156 .matcher(description).replaceAll(" ");
157 groupURLdescr.addElement(description);
158 groupURLdescr.addElement(description);
159 String urlstub = wfname;
160 if (wfname.indexOf(" ") > -1)
162 // make the name safe!
165 urlstub = URLEncoder.encode(wfname, "utf-8");
166 } catch (UnsupportedEncodingException e)
168 // TODO Auto-generated catch block
175 + "http://www.ebi.ac.uk/enfin-srv/envision2/pages/linkin.jsf?tool=Jalview&workflow="
177 + "&datasetName=JalviewSeqs$DATASETID$&input=$SEQUENCEIDS$&inputType=0|,"); // #"+description+"#");
181 + "http://www.ebi.ac.uk/enfin-srv/envision2/pages/linkin.jsf?tool=Jalview&workflow="
183 + "&datasetName=JalviewSeqs$DATASETID$&input=$SEQUENCES=/([A-Za-z]+)+/=$&inputType=1|,"); // #"+description+"#");
191 * @see org.xml.sax.helpers.DefaultHandler#characters(char[], int, int)
193 public void characters(char[] ch, int start, int length)
196 if (description != null)
198 for (int i = start; i < start + length; i++)
200 description += ch[i];
208 * @see org.xml.sax.helpers.DefaultHandler#startElement(java.lang.String,
209 * java.lang.String, java.lang.String, org.xml.sax.Attributes)
211 public void startElement(String uri, String localName, String qName,
212 Attributes attributes) throws SAXException
214 if (qName.equalsIgnoreCase("workflow"))
217 wfname = attributes.getValue("name");
219 if (qName.equalsIgnoreCase("description"))
224 // System.err.println("Start element: : '"+uri+" "+localName+" "+qName+" attributes"+attributes);
225 // super.startElement(uri,localName,qname,attributes);
228 private boolean started = false;
230 private boolean running = false;
232 private Vector groupURLLinks = null;
234 private Vector groupURLdescr = null;
236 private static String[] allowedDb = new String[]
237 { "UNIPROT", "EMBL", "PDB" };
239 public EnfinEnvision2OneWay()
241 groupURLLinks = new Vector();
242 groupURLdescr = new Vector();
244 enfinService = Cache.getDefault("ENVISION2_WORKFLOWSERVICE",
245 "http://www.ebi.ac.uk/enfin-srv/envision2/pages/workflows.xml");
246 new Thread(this).start();
255 SAXParserFactory spf = SAXParserFactory.newInstance();
256 SAXParser sp = spf.newSAXParser();
257 sp.parse(new URL(enfinService).openStream(), this);
258 } catch (Exception e)
260 Cache.log.warn("Exception when discovering One Way services: ", e);
263 Cache.log.warn("Error when discovering One Way services: ", e);
266 Cache.log.debug("Finished running.");
270 * have we finished running yet ?
272 * @return false if we have been run.
274 public boolean isRunning()
277 // TODO Auto-generated method stub
278 return !started || running;
281 public static void main(String[] args)
284 EnfinEnvision2OneWay ow = new EnfinEnvision2OneWay();
285 while (ow.isRunning())
290 } catch (Exception e)
296 for (int i = 0; i < ow.groupURLLinks.size(); i++)
298 System.err.println("Description" + ow.groupURLdescr.elementAt(i)
299 + "Service URL: " + ow.groupURLLinks.elementAt(i));
303 // / Copied from jalview.gui.PopupMenu
305 * add a late bound URL service item to the given menu
309 * - menu label string
310 * @param urlgenerator
311 * GroupURLLink used to generate URL
313 * Object array returned from the makeUrlStubs function.
315 private void addshowLink(JMenu linkMenu, String label, String descr,
316 String dbname, final GroupUrlLink urlgenerator,
317 final Object[] urlstub)
319 Component[] jmi = linkMenu.getMenuComponents();
320 for (int i = 0; i < jmi.length; i++)
322 if (jmi[i] instanceof JMenuItem
323 && ((JMenuItem) jmi[i]).getText().equalsIgnoreCase(label))
325 // don't add this - its a repeat of an existing URL.
331 descr = HtmlEncoder.encode(descr);
332 } catch (Exception e)
337 boolean seqsorids = (urlgenerator.getGroupURLType() & urlgenerator.SEQUENCEIDS) == 0;
338 int i = urlgenerator.getNumberInvolved(urlstub);
339 JMenuItem item = new JMenuItem(label);
341 if (dbname == null || dbname.trim().length() == 0)
345 item.setToolTipText("<html>"
346 + JvSwingUtils.wrapTooltip("Submit " + i + " " + dbname + " "
347 + (seqsorids ? "sequence" : "sequence id")
350 + " to<br/>" + descr) + "</html>");
351 item.addActionListener(new java.awt.event.ActionListener()
353 public void actionPerformed(ActionEvent e)
355 new Thread(new Runnable()
362 showLink(urlgenerator.constructFrom(urlstub));
363 } catch (UrlStringTooLongException ex)
365 Cache.log.warn("Not showing link: URL is too long!", ex);
377 * open the given link in a new browser window
381 public void showLink(String url)
385 jalview.util.BrowserLauncher.openURL(url);
386 } catch (Exception ex)
389 .showInternalMessageDialog(
391 "Unixers: Couldn't find default web browser."
392 + "\nAdd the full path to your browser in Preferences.",
393 "Web browser not found", JOptionPane.WARNING_MESSAGE);
395 ex.printStackTrace();
400 * called by a web service menu instance when it is opened.
402 * @param enfinServiceMenu
405 private void buildGroupLinkMenu(JMenu enfinServiceMenu,
406 AlignFrame alignFrame)
408 if (running || !started)
412 SequenceI[] seqs = alignFrame.getViewport().getSelectionAsNewSequence();
413 SequenceGroup sg = alignFrame.getViewport().getSelectionGroup();
416 // consider visible regions here/
418 enfinServiceMenu.removeAll();
419 JMenu entries = buildGroupURLMenu(seqs, sg);
422 for (int i = 0, iSize = entries.getMenuComponentCount(); i < iSize; i++)
424 // transfer - menu component is removed from entries automatically
425 enfinServiceMenu.add(entries.getMenuComponent(0));
427 // entries.removeAll();
428 enfinServiceMenu.setEnabled(true);
432 enfinServiceMenu.setEnabled(false);
437 * construct a dynamic enfin services menu given a sequence selection
444 private JMenu buildGroupURLMenu(SequenceI[] seqs, SequenceGroup sg)
446 if (groupURLdescr == null || groupURLLinks == null)
448 // TODO: usability: thread off the generation of group url content so root
450 // sequence only URLs
451 // ID/regex match URLs
452 JMenu groupLinksMenu = new JMenu("Group Link");
453 String[][] idandseqs = GroupUrlLink.formStrings(seqs);
454 Hashtable commonDbrefs = new Hashtable();
455 for (int sq = 0; sq < seqs.length; sq++)
461 start = seqs[sq].findPosition(sg.getStartRes());
462 end = seqs[sq].findPosition(sg.getEndRes());
466 // get total width of alignment.
467 start = seqs[sq].getStart();
468 end = seqs[sq].findPosition(seqs[sq].getLength());
470 // we skip sequences which do not have any non-gaps in the region of
476 // just collect ids from dataset sequence
477 // TODO: check if IDs collected from selecton group intersects with the
478 // current selection, too
479 SequenceI sqi = seqs[sq];
480 while (sqi.getDatasetSequence() != null)
482 sqi = sqi.getDatasetSequence();
484 DBRefEntry[] dbr = sqi.getDBRef();
485 if (dbr != null && dbr.length > 0)
487 for (int d = 0; d < dbr.length; d++)
489 String src = dbr[d].getSource(); // jalview.util.DBRefUtils.getCanonicalName(dbr[d].getSource()).toUpperCase();
490 Object[] sarray = (Object[]) commonDbrefs.get(src);
493 sarray = new Object[2];
494 sarray[0] = new int[]
496 sarray[1] = new String[seqs.length];
498 commonDbrefs.put(src, sarray);
501 if (((String[]) sarray[1])[sq] == null)
504 || (dbr[d].getMap().locateMappedRange(start, end) != null))
506 ((String[]) sarray[1])[sq] = dbr[d].getAccessionId();
507 ((int[]) sarray[0])[0]++;
513 // now create group links for all distinct ID/sequence sets.
514 Hashtable<String, JMenu[]> gurlMenus = new Hashtable<String, JMenu[]>();
516 * last number of sequences where URL generation failed
518 int[] nsqtype = new int[]
519 { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 };
520 for (int i = 0; i < groupURLLinks.size(); i++)
522 String link = (String) groupURLLinks.elementAt(i);
523 String descr = (String) groupURLdescr.elementAt(i);
525 // boolean specialCase =
526 // additionalPar.elementAt(i).toString().equals(BACKGROUND);
527 GroupUrlLink urlLink = null;
530 urlLink = new GroupUrlLink(link);
531 } catch (Exception foo)
533 jalview.bin.Cache.log.error("Exception for GroupURLLink '" + link
538 if (!urlLink.isValid())
540 jalview.bin.Cache.log.error(urlLink.getInvalidMessage());
543 final String label = urlLink.getLabel();
544 // create/recover the sub menus that might be populated for this link.
545 JMenu[] wflinkMenus = gurlMenus.get(label);
546 if (wflinkMenus == null)
548 // three types of url that might be
550 wflinkMenus = new JMenu[]
551 { null, new JMenu("IDS"), new JMenu("Sequences"),
552 new JMenu("IDS and Sequences") };
553 gurlMenus.put(label, wflinkMenus);
556 boolean usingNames = false;
557 // Now see which parts of the group apply for this URL
559 String[] seqstr, ids; // input to makeUrl
560 for (int t = 0; t < allowedDb.length; t++)
562 ltarget = allowedDb[t]; // jalview.util.DBRefUtils.getCanonicalName(urlLink.getTarget());
563 Object[] idset = (Object[]) commonDbrefs.get(ltarget.toUpperCase());
566 int numinput = ((int[]) idset[0])[0];
567 String[] allids = ((String[]) idset[1]);
568 seqstr = new String[numinput];
569 ids = new String[numinput];
570 if (nsqtype[urlLink.getGroupURLType()] > 0
571 && numinput >= nsqtype[urlLink.getGroupURLType()])
575 for (int sq = 0, idcount = 0; sq < seqs.length; sq++)
577 if (allids[sq] != null)
579 ids[idcount] = allids[sq];
580 seqstr[idcount++] = idandseqs[1][sq];
585 createAndAddLinks(wflinkMenus, false, urlLink, ltarget, null,
587 } catch (UrlStringTooLongException ex)
589 nsqtype[urlLink.getGroupURLType()] = numinput;
593 // also do names only.
594 seqstr = idandseqs[1];
596 if (nsqtype[urlLink.getGroupURLType()] > 0
597 && idandseqs[0].length >= nsqtype[urlLink.getGroupURLType()])
604 createAndAddLinks(wflinkMenus, true, urlLink, "Any", null, descr,
606 } catch (UrlStringTooLongException ex)
608 nsqtype[urlLink.getGroupURLType()] = idandseqs[0].length;
611 boolean anyadded = false; // indicates if there are any group links to give
613 for (Map.Entry<String, JMenu[]> menues : gurlMenus.entrySet())
615 JMenu grouplinkset = new JMenu(menues.getKey());
616 JMenu[] wflinkMenus = menues.getValue();
617 for (int m = 0; m < wflinkMenus.length; m++)
619 if (wflinkMenus[m] != null
620 && wflinkMenus[m].getMenuComponentCount() > 0)
623 grouplinkset.add(wflinkMenus[m]);
626 groupLinksMenu.add(grouplinkset);
630 return groupLinksMenu;
635 private boolean createAndAddLinks(JMenu[] linkMenus, boolean usingNames,
636 GroupUrlLink urlLink, String label, String ltarget, String descr,
637 String[] ids, String[] seqstr) throws UrlStringTooLongException
639 Object[] urlset = urlLink.makeUrlStubs(ids, seqstr, "FromJalview"
640 + System.currentTimeMillis(), false);
644 int type = urlLink.getGroupURLType() & 3;
645 // System.out.println(urlLink.getGroupURLType()
646 // +" "+((String[])urlset[3])[0]);
647 // first two bits ofurlLink type bitfield are sequenceids and sequences
648 // TODO: FUTURE: ensure the groupURL menu structure can be generalised
653 + (ltarget == null ? (((type & 1) == 1 ? "ID"
654 : "Sequence") + (urlLink
655 .getNumberInvolved(urlset) > 1 ? "s" : ""))
656 : (usingNames ? (((type & 1) == 1) ? "(Names)"
658 : ("(" + ltarget + ")"))), descr,
659 usingNames ? null : label, urlLink, urlset);
665 // / end of stuff copied from popupmenu
666 public void attachWSMenuEntry(final JMenu wsmenu,
667 final AlignFrame alignFrame)
669 final JMenu enfinServiceMenu = new JMenu("Envision 2");
670 wsmenu.add(enfinServiceMenu);
671 enfinServiceMenu.setEnabled(false);
672 wsmenu.addMenuListener(new MenuListener()
674 // this listener remembers when the menu was first selected, and
675 // doesn't rebuild the session list until it has been cleared and
677 boolean refresh = true;
679 public void menuCanceled(MenuEvent e)
684 public void menuDeselected(MenuEvent e)
689 public void menuSelected(MenuEvent e)
691 if (refresh && !isRunning())
693 new Thread(new Runnable()
699 buildGroupLinkMenu(enfinServiceMenu, alignFrame);
700 } catch (OutOfMemoryError ex)
703 .error("Out of memory when calculating the Envision2 links.",
705 enfinServiceMenu.setEnabled(false);