2 * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8)
3 * Copyright (C) 2012 J Procter, AM Waterhouse, LM Lui, J Engelhardt, 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/>.
23 import java.awt.event.*;
24 import java.awt.image.*;
26 import javax.swing.event.HyperlinkEvent;
27 import javax.swing.event.HyperlinkListener;
28 import javax.swing.text.html.HTMLEditorKit;
29 import javax.swing.text.html.StyleSheet;
31 import jalview.jbgui.*;
32 import jalview.util.MessageManager;
33 import jalview.ws.WSClientI;
36 * Base class for web service client thread and gui TODO: create StAX parser to
37 * extract html body content reliably when preparing html formatted job statuses
42 public class WebserviceInfo extends GWebserviceInfo implements
43 HyperlinkListener, IProgressIndicator
47 public static final int STATE_QUEUING = 0;
50 public static final int STATE_RUNNING = 1;
52 /** Job has finished with no errors */
53 public static final int STATE_STOPPED_OK = 2;
55 /** Job has been cancelled with no errors */
56 public static final int STATE_CANCELLED_OK = 3;
58 /** job has stopped because of some error */
59 public static final int STATE_STOPPED_ERROR = 4;
61 /** job has failed because of some unavoidable service interruption */
62 public static final int STATE_STOPPED_SERVERERROR = 5;
64 int currentStatus = STATE_QUEUING;
72 jalview.ws.WSClientI thisService;
74 boolean serviceIsCancellable;
78 JTabbedPane subjobs = null;
80 java.util.Vector jobPanes = null;
82 private boolean serviceCanMergeResults = false;
84 private boolean viewResultsImmediatly = true;
90 * to indicate if results will be shown in a new window as soon as
93 public boolean isViewResultsImmediatly()
95 return viewResultsImmediatly;
102 * to indicate if results will be shown in a new window as soon as
103 * they are available.
105 public void setViewResultsImmediatly(boolean viewResultsImmediatly)
107 this.viewResultsImmediatly = viewResultsImmediatly;
110 private StyleSheet getStyleSheet(HTMLEditorKit editorKit)
113 // Copied blatantly from
114 // http://www.velocityreviews.com/forums/t132265-string-into-htmldocument.html
115 StyleSheet myStyleSheet = new StyleSheet();
117 myStyleSheet.addStyleSheet(editorKit.getStyleSheet());
119 editorKit.setStyleSheet(myStyleSheet);
122 * Set the style sheet rules here by reading them from the constants
126 * for (int ix=0; ix<CSS_RULES.length; ix++) {
128 * myStyleSheet.addRule(CSS_RULES[ix]);
137 public synchronized int addJobPane()
139 JScrollPane jobpane = new JScrollPane();
140 JComponent _progressText;
143 JEditorPane progressText = new JEditorPane("text/html", "");
144 progressText.addHyperlinkListener(this);
145 _progressText = progressText;
146 // progressText.setFont(new java.awt.Font("Verdana", 0, 10));
147 // progressText.setBorder(null);
148 progressText.setEditable(false);
150 * HTMLEditorKit myEditorKit = new HTMLEditorKit();
152 * StyleSheet myStyleSheet = getStyleSheet(myEditorKit);
154 * HTMLDocument tipDocument = (HTMLDocument)
155 * (myEditorKit.createDefaultDocument());
157 * progressText.setDocument(tipDocument);
158 */progressText.setText("<html><h1>WS Job</h1></html>");
162 JTextArea progressText = new JTextArea();
163 _progressText = progressText;
165 progressText.setFont(new java.awt.Font("Verdana", 0, 10));
166 progressText.setBorder(null);
167 progressText.setEditable(false);
168 progressText.setText("WS Job");
169 progressText.setLineWrap(true);
170 progressText.setWrapStyleWord(true);
172 jobpane.setName("JobPane");
173 jobpane.getViewport().add(_progressText, null);
174 jobpane.setBorder(null);
175 if (jobPanes == null)
177 jobPanes = new Vector();
179 int newpane = jobPanes.size();
180 jobPanes.add(jobpane);
184 this.add(jobpane, BorderLayout.CENTER);
190 // revert to a tabbed pane.
191 JScrollPane firstpane;
192 this.remove(firstpane = (JScrollPane) jobPanes.get(0));
193 subjobs = new JTabbedPane();
194 this.add(subjobs, BorderLayout.CENTER);
195 subjobs.add(firstpane);
196 subjobs.setTitleAt(0, firstpane.getName());
198 subjobs.add(jobpane);
200 return newpane; // index for accessor methods below
204 * Creates a new WebserviceInfo object.
207 * short name and job type
209 * reference or other human readable description
211 public WebserviceInfo(String title, String info)
213 init(title, info, 520, 500);
217 * Creates a new WebserviceInfo object.
228 public WebserviceInfo(String title, String info, int width, int height)
230 init(title, info, width, height);
236 * @return DOCUMENT ME!
238 public jalview.ws.WSClientI getthisService()
244 * Update state of GUI based on client capabilities (like whether the job is
245 * cancellable, whether the 'merge results' button is shown.
248 * service client to query for capabilities
250 public void setthisService(jalview.ws.WSClientI newservice)
252 thisService = newservice;
253 serviceIsCancellable = newservice.isCancellable();
254 frame.setClosable(!serviceIsCancellable);
255 serviceCanMergeResults = newservice.canMergeResults();
256 rebuildButtonPanel();
259 private void rebuildButtonPanel()
261 if (buttonPanel != null)
263 buttonPanel.removeAll();
264 if (serviceIsCancellable)
266 buttonPanel.add(cancel);
267 frame.setClosable(false);
271 frame.setClosable(true);
288 void init(String title, String info, int width, int height)
290 frame = new JInternalFrame();
291 frame.setContentPane(this);
292 Desktop.addInternalFrame(frame, title, width, height);
293 frame.setClosable(false);
298 java.net.URL url = getClass().getResource(
299 "/images/Jalview_Logo_small.png");
300 image = java.awt.Toolkit.getDefaultToolkit().createImage(url);
302 MediaTracker mt = new MediaTracker(this);
303 mt.addImage(image, 0);
308 } catch (Exception ex)
312 AnimatedPanel ap = new AnimatedPanel();
313 titlePanel.add(ap, BorderLayout.CENTER);
315 Thread thread = new Thread(ap);
317 final WebserviceInfo thisinfo = this;
318 frame.addInternalFrameListener(new javax.swing.event.InternalFrameAdapter()
320 public void internalFrameClosed(
321 javax.swing.event.InternalFrameEvent evt)
323 // System.out.println("Shutting down webservice client");
324 WSClientI service = thisinfo.getthisService();
325 if (service != null && service.isCancellable())
339 * integer status from state constants
341 public void setStatus(int status)
343 currentStatus = status;
347 * subjob status indicator
352 public void setStatus(int jobpane, int status)
354 if (jobpane < 0 || jobpane >= jobPanes.size())
356 throw new Error("setStatus called for non-existent job pane."
362 setProgressName(jobpane + " - QUEUED", jobpane);
365 setProgressName(jobpane + " - RUNNING", jobpane);
367 case STATE_STOPPED_OK:
368 setProgressName(jobpane + " - FINISHED", jobpane);
370 case STATE_CANCELLED_OK:
371 setProgressName(jobpane + " - CANCELLED", jobpane);
373 case STATE_STOPPED_ERROR:
374 setProgressName(jobpane + " - BROKEN", jobpane);
376 case STATE_STOPPED_SERVERERROR:
377 setProgressName(jobpane + " - ALERT", jobpane);
380 setProgressName(jobpane + " - UNKNOWN STATE", jobpane);
387 * @return DOCUMENT ME!
389 public String getInfoText()
391 return infoText.getText();
400 public void setInfoText(String text)
402 infoText.setText(text);
411 public void appendInfoText(String text)
413 infoText.append(text);
419 * @return DOCUMENT ME!
421 public String getProgressText(int which)
423 if (jobPanes == null)
429 return ((JEditorPane) ((JScrollPane) jobPanes.get(which))
430 .getViewport().getComponent(0)).getText();
434 return ((JTextArea) ((JScrollPane) jobPanes.get(which)).getViewport()
435 .getComponent(0)).getText();
445 public void setProgressText(int which, String text)
447 if (jobPanes == null)
453 ((JEditorPane) ((JScrollPane) jobPanes.get(which)).getViewport()
454 .getComponent(0)).setText(ensureHtmlTagged(text));
458 ((JTextArea) ((JScrollPane) jobPanes.get(which)).getViewport()
459 .getComponent(0)).setText(text);
464 * extract content from <body> content </body>
468 * - set to leave the initial html tag intact
470 * - set to leave the final html tag intact
473 private String getHtmlFragment(String text, boolean leaveFirst,
480 String lowertxt = text.toLowerCase();
481 int htmlpos = leaveFirst ? -1 : lowertxt.indexOf("<body");
483 int htmlend = leaveLast ? -1 : lowertxt.indexOf("</body");
484 int htmlpose = lowertxt.indexOf(">", htmlpos), htmlende = lowertxt
485 .indexOf(">", htmlend);
486 if (htmlend == -1 && htmlpos == -1)
492 return text.substring((htmlpos == -1 ? 0 : htmlpose + 1), htmlend);
494 return text.substring(htmlpos == -1 ? 0 : htmlpose + 1);
498 * very simple routine for adding/ensuring html tags are present in text.
501 * @return properly html tag enclosed text
503 private String ensureHtmlTagged(String text)
509 String lowertxt = text.toLowerCase();
510 int htmlpos = lowertxt.indexOf("<body");
511 int htmlend = lowertxt.indexOf("</body");
512 int doctype = lowertxt.indexOf("<!doctype");
513 int xmltype = lowertxt.indexOf("<?xml");
516 text = text + "</body></html>";
520 if ((doctype > -1 && htmlpos > doctype)
521 || (xmltype > -1 && htmlpos > xmltype))
523 text = "<html><head></head><body>\n" + text.substring(htmlpos - 1);
528 text = "<html><head></head><body>\n" + text;
530 if (text.indexOf("<meta") > -1)
532 System.err.println("HTML COntent: \n" + text
533 + "<< END HTML CONTENT\n");
545 public void appendProgressText(int which, String text)
547 if (jobPanes == null)
553 String txt = getHtmlFragment(
554 ((JEditorPane) ((JScrollPane) jobPanes.get(which))
555 .getViewport().getComponent(0)).getText(), true,
557 ((JEditorPane) ((JScrollPane) jobPanes.get(which)).getViewport()
558 .getComponent(0)).setText(ensureHtmlTagged(txt
559 + getHtmlFragment(text, false, true)));
563 ((JTextArea) ((JScrollPane) jobPanes.get(which)).getViewport()
564 .getComponent(0)).append(text);
569 * setProgressText(0, text)
571 public void setProgressText(String text)
573 setProgressText(0, text);
577 * appendProgressText(0, text)
579 public void appendProgressText(String text)
581 appendProgressText(0, text);
587 public String getProgressText()
589 return getProgressText(0);
593 * get the tab title for a subjob
599 public String getProgressName(int which)
601 if (jobPanes == null)
607 return subjobs.getTitleAt(which);
611 return ((JScrollPane) jobPanes.get(which)).getViewport()
612 .getComponent(0).getName();
617 * set the tab title for a subjob
624 public void setProgressName(String name, int which)
628 subjobs.setTitleAt(which, name);
629 subjobs.revalidate();
632 JScrollPane c = (JScrollPane) jobPanes.get(which);
633 c.getViewport().getComponent(0).setName(name);
638 * Gui action for cancelling the current job, if possible.
643 protected void cancel_actionPerformed(ActionEvent e)
645 if (!serviceIsCancellable)
647 // JBPNote : TODO: We should REALLY just tell the WSClientI to cancel
648 // anyhow - it has to stop threads and clean up
649 // JBPNote : TODO: Instead of a warning, we should have an optional 'Are
651 warnUser("This job cannot be cancelled.\nJust close the window.",
656 thisService.cancelJob();
658 frame.setClosable(true);
662 * Spawns a thread that pops up a warning dialog box with the given message
668 public void warnUser(final String message, final String title)
670 javax.swing.SwingUtilities.invokeLater(new Runnable()
674 JOptionPane.showInternalMessageDialog(Desktop.desktop, message,
675 title, JOptionPane.WARNING_MESSAGE);
682 * Set up GUI for user to get at results - and possibly automatically display
683 * them if viewResultsImmediatly is set.
685 public void setResultsReady()
687 frame.setClosable(true);
688 buttonPanel.remove(cancel);
689 buttonPanel.add(showResultsNewFrame);
690 if (serviceCanMergeResults)
692 buttonPanel.add(mergeResults);
693 buttonPanel.setLayout(new GridLayout(2, 1, 5, 5));
695 buttonPanel.validate();
697 if (viewResultsImmediatly)
699 showResultsNewFrame.doClick();
704 * called when job has finished but no result objects can be passed back to
707 public void setFinishedNoResults()
709 frame.setClosable(true);
710 buttonPanel.remove(cancel);
711 buttonPanel.validate();
715 class AnimatedPanel extends JPanel implements Runnable
719 BufferedImage offscreen;
723 startTime = System.currentTimeMillis();
725 while (currentStatus < STATE_STOPPED_OK)
731 int units = (int) ((System.currentTimeMillis() - startTime) / 10f);
734 startTime = System.currentTimeMillis();
736 if (currentStatus >= STATE_STOPPED_OK)
742 } catch (Exception ex)
747 cancel.setEnabled(false);
752 if (offscreen == null || offscreen.getWidth(this) != getWidth()
753 || offscreen.getHeight(this) != getHeight())
755 offscreen = new BufferedImage(getWidth(), getHeight(),
756 BufferedImage.TYPE_INT_ARGB);
759 Graphics2D g = (Graphics2D) offscreen.getGraphics();
761 g.setColor(Color.white);
762 g.fillRect(0, 0, getWidth(), getHeight());
764 g.setFont(new Font("Arial", Font.BOLD, 12));
765 g.setColor(Color.black);
767 switch (currentStatus)
770 g.drawString(title.concat(" - ").concat(MessageManager.getString("label.state_queueing")), 60, 30);
775 g.drawString(title.concat(" - ").concat(MessageManager.getString("label.state_running")), 60, 30);
779 case STATE_STOPPED_OK:
780 g.drawString(title.concat(" - ").concat(MessageManager.getString("label.state_completed")), 60, 30);
784 case STATE_CANCELLED_OK:
785 g.drawString(title.concat(" - ").concat(MessageManager.getString("label.state_job_cancelled")), 60, 30);
789 case STATE_STOPPED_ERROR:
790 g.drawString(title.concat(" - ").concat(MessageManager.getString("label.state_job_error")), 60, 30);
794 case STATE_STOPPED_SERVERERROR:
795 g.drawString(title.concat(" - ").concat(MessageManager.getString("label.server_error_try_later")), 60, 30);
802 int x = image.getWidth(this) / 2, y = image.getHeight(this) / 2;
803 g.rotate(Math.toRadians(angle), 10 + x, 10 + y);
804 g.drawImage(image, 10, 10, this);
805 g.rotate(-Math.toRadians(angle), 10 + x, 10 + y);
809 public void paintComponent(Graphics g1)
813 g1.drawImage(offscreen, 0, 0, this);
817 boolean renderAsHtml = false;
819 public void setRenderAsHtml(boolean b)
824 public void hyperlinkUpdate(HyperlinkEvent e)
826 Desktop.hyperlinkUpdate(e);
829 // methods for implementing IProgressIndicator
830 // need to refactor to a reusable stub class
831 Hashtable progressBars, progressBarHandlers;
836 * @see jalview.gui.IProgressIndicator#setProgressBar(java.lang.String, long)
839 public void setProgressBar(String message, long id)
841 if (progressBars == null)
843 progressBars = new Hashtable();
844 progressBarHandlers = new Hashtable();
847 JPanel progressPanel;
848 Long lId = new Long(id);
849 GridLayout layout = (GridLayout) statusPanel.getLayout();
850 if (progressBars.get(lId) != null)
852 progressPanel = (JPanel) progressBars.get(new Long(id));
853 statusPanel.remove(progressPanel);
854 progressBars.remove(lId);
855 progressPanel = null;
858 statusBar.setText(message);
860 if (progressBarHandlers.contains(lId))
862 progressBarHandlers.remove(lId);
864 layout.setRows(layout.getRows() - 1);
868 progressPanel = new JPanel(new BorderLayout(10, 5));
870 JProgressBar progressBar = new JProgressBar();
871 progressBar.setIndeterminate(true);
873 progressPanel.add(new JLabel(message), BorderLayout.WEST);
874 progressPanel.add(progressBar, BorderLayout.CENTER);
876 layout.setRows(layout.getRows() + 1);
877 statusPanel.add(progressPanel);
879 progressBars.put(lId, progressPanel);
882 // setMenusForViewport();
887 public void registerHandler(final long id,
888 final IProgressIndicatorHandler handler)
890 if (progressBarHandlers == null || !progressBars.contains(new Long(id)))
893 "call setProgressBar before registering the progress bar's handler.");
895 progressBarHandlers.put(new Long(id), handler);
896 final JPanel progressPanel = (JPanel) progressBars.get(new Long(id));
897 if (handler.canCancel())
899 JButton cancel = new JButton(MessageManager.getString("action.cancel"));
900 final IProgressIndicator us = this;
901 cancel.addActionListener(new ActionListener()
905 public void actionPerformed(ActionEvent e)
907 handler.cancelActivity(id);
910 + ((JLabel) progressPanel.getComponent(0))
914 progressPanel.add(cancel, BorderLayout.EAST);
920 * @return true if any progress bars are still active
923 public boolean operationInProgress()
925 if (progressBars != null && progressBars.size() > 0)