2 * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3 * Copyright (C) $$Year-Rel$$ The Jalview Authors
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
10 * of the License, or (at your option) any later version.
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.
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.
23 import java.awt.BorderLayout;
24 import java.awt.Color;
26 import java.awt.Graphics;
27 import java.awt.Graphics2D;
28 import java.awt.GridLayout;
29 import java.awt.Image;
30 import java.awt.MediaTracker;
31 import java.awt.event.ActionEvent;
32 import java.awt.image.BufferedImage;
33 import java.util.Vector;
35 import javax.swing.JComponent;
36 import javax.swing.JEditorPane;
37 import javax.swing.JInternalFrame;
38 import javax.swing.JOptionPane;
39 import javax.swing.JPanel;
40 import javax.swing.JScrollPane;
41 import javax.swing.JTabbedPane;
42 import javax.swing.JTextArea;
43 import javax.swing.event.HyperlinkEvent;
44 import javax.swing.event.HyperlinkListener;
45 import javax.swing.text.html.HTMLEditorKit;
46 import javax.swing.text.html.StyleSheet;
48 import jalview.jbgui.GWebserviceInfo;
49 import jalview.util.MessageManager;
50 import jalview.ws.WSClientI;
53 * Base class for web service client thread and gui TODO: create StAX parser to
54 * extract html body content reliably when preparing html formatted job statuses
59 public class WebserviceInfo extends GWebserviceInfo implements
60 HyperlinkListener, IProgressIndicator
64 public static final int STATE_QUEUING = 0;
67 public static final int STATE_RUNNING = 1;
69 /** Job has finished with no errors */
70 public static final int STATE_STOPPED_OK = 2;
72 /** Job has been cancelled with no errors */
73 public static final int STATE_CANCELLED_OK = 3;
75 /** job has stopped because of some error */
76 public static final int STATE_STOPPED_ERROR = 4;
78 /** job has failed because of some unavoidable service interruption */
79 public static final int STATE_STOPPED_SERVERERROR = 5;
81 int currentStatus = STATE_QUEUING;
89 jalview.ws.WSClientI thisService;
91 boolean serviceIsCancellable;
95 private IProgressIndicator progressBar;
98 public void setVisible(boolean aFlag)
100 super.setVisible(aFlag);
101 frame.setVisible(aFlag);
104 JTabbedPane subjobs = null;
106 java.util.Vector jobPanes = null;
108 private boolean serviceCanMergeResults = false;
110 private boolean viewResultsImmediatly = true;
116 * to indicate if results will be shown in a new window as soon as
117 * they are available.
119 public boolean isViewResultsImmediatly()
121 return viewResultsImmediatly;
128 * to indicate if results will be shown in a new window as soon as
129 * they are available.
131 public void setViewResultsImmediatly(boolean viewResultsImmediatly)
133 this.viewResultsImmediatly = viewResultsImmediatly;
136 private StyleSheet getStyleSheet(HTMLEditorKit editorKit)
139 // Copied blatantly from
140 // http://www.velocityreviews.com/forums/t132265-string-into-htmldocument.html
141 StyleSheet myStyleSheet = new StyleSheet();
143 myStyleSheet.addStyleSheet(editorKit.getStyleSheet());
145 editorKit.setStyleSheet(myStyleSheet);
148 * Set the style sheet rules here by reading them from the constants
152 * for (int ix=0; ix<CSS_RULES.length; ix++) {
154 * myStyleSheet.addRule(CSS_RULES[ix]);
163 public synchronized int addJobPane()
165 JScrollPane jobpane = new JScrollPane();
166 JComponent _progressText;
169 JEditorPane progressText = new JEditorPane("text/html", "");
170 progressText.addHyperlinkListener(this);
171 _progressText = progressText;
172 // progressText.setFont(new java.awt.Font("Verdana", 0, 10));
173 // progressText.setBorder(null);
174 progressText.setEditable(false);
176 * HTMLEditorKit myEditorKit = new HTMLEditorKit();
178 * StyleSheet myStyleSheet = getStyleSheet(myEditorKit);
180 * HTMLDocument tipDocument = (HTMLDocument)
181 * (myEditorKit.createDefaultDocument());
183 * progressText.setDocument(tipDocument);
184 */progressText.setText("<html><h1>WS Job</h1></html>");
188 JTextArea progressText = new JTextArea();
189 _progressText = progressText;
191 progressText.setFont(new java.awt.Font("Verdana", 0, 10));
192 progressText.setBorder(null);
193 progressText.setEditable(false);
194 progressText.setText("WS Job");
195 progressText.setLineWrap(true);
196 progressText.setWrapStyleWord(true);
198 jobpane.setName("JobPane");
199 jobpane.getViewport().add(_progressText, null);
200 jobpane.setBorder(null);
201 if (jobPanes == null)
203 jobPanes = new Vector();
205 int newpane = jobPanes.size();
206 jobPanes.add(jobpane);
210 this.add(jobpane, BorderLayout.CENTER);
216 // revert to a tabbed pane.
217 JScrollPane firstpane;
218 this.remove(firstpane = (JScrollPane) jobPanes.get(0));
219 subjobs = new JTabbedPane();
220 this.add(subjobs, BorderLayout.CENTER);
221 subjobs.add(firstpane);
222 subjobs.setTitleAt(0, firstpane.getName());
224 subjobs.add(jobpane);
226 return newpane; // index for accessor methods below
230 * Creates a new WebserviceInfo object.
233 * short name and job type
235 * reference or other human readable description
237 * true to display the webservices window immediatly (otherwise need
238 * to call setVisible(true))
240 public WebserviceInfo(String title, String info, boolean makeVisible)
242 init(title, info, 520, 500, makeVisible);
246 * Creates a new WebserviceInfo object.
257 public WebserviceInfo(String title, String info, int width, int height,
260 init(title, info, width, height, makeVisible);
266 * @return DOCUMENT ME!
268 public jalview.ws.WSClientI getthisService()
274 * Update state of GUI based on client capabilities (like whether the job is
275 * cancellable, whether the 'merge results' button is shown.
278 * service client to query for capabilities
280 public void setthisService(jalview.ws.WSClientI newservice)
282 thisService = newservice;
283 serviceIsCancellable = newservice.isCancellable();
284 frame.setClosable(!serviceIsCancellable);
285 serviceCanMergeResults = newservice.canMergeResults();
286 rebuildButtonPanel();
289 private void rebuildButtonPanel()
291 if (buttonPanel != null)
293 buttonPanel.removeAll();
294 if (serviceIsCancellable)
296 buttonPanel.add(cancel);
297 frame.setClosable(false);
301 frame.setClosable(true);
318 void init(String title, String info, int width, int height,
321 frame = new JInternalFrame();
322 frame.setContentPane(this);
323 Desktop.addInternalFrame(frame, title, makeVisible, width, height);
324 frame.setClosable(false);
326 progressBar = new ProgressBar(statusPanel, statusBar);
331 java.net.URL url = getClass().getResource(
332 "/images/Jalview_Logo_small.png");
333 image = java.awt.Toolkit.getDefaultToolkit().createImage(url);
335 MediaTracker mt = new MediaTracker(this);
336 mt.addImage(image, 0);
341 } catch (Exception ex)
345 AnimatedPanel ap = new AnimatedPanel();
346 titlePanel.add(ap, BorderLayout.CENTER);
348 Thread thread = new Thread(ap);
350 final WebserviceInfo thisinfo = this;
351 frame.addInternalFrameListener(new javax.swing.event.InternalFrameAdapter()
353 public void internalFrameClosed(
354 javax.swing.event.InternalFrameEvent evt)
356 // System.out.println("Shutting down webservice client");
357 WSClientI service = thisinfo.getthisService();
358 if (service != null && service.isCancellable())
372 * integer status from state constants
374 public void setStatus(int status)
376 currentStatus = status;
380 * subjob status indicator
385 public void setStatus(int jobpane, int status)
387 if (jobpane < 0 || jobpane >= jobPanes.size())
389 throw new Error(MessageManager.formatMessage("error.setstatus_called_non_existent_job_pane", new String[]{Integer.valueOf(jobpane).toString()}));
394 setProgressName(jobpane + " - QUEUED", jobpane);
397 setProgressName(jobpane + " - RUNNING", jobpane);
399 case STATE_STOPPED_OK:
400 setProgressName(jobpane + " - FINISHED", jobpane);
402 case STATE_CANCELLED_OK:
403 setProgressName(jobpane + " - CANCELLED", jobpane);
405 case STATE_STOPPED_ERROR:
406 setProgressName(jobpane + " - BROKEN", jobpane);
408 case STATE_STOPPED_SERVERERROR:
409 setProgressName(jobpane + " - ALERT", jobpane);
412 setProgressName(jobpane + " - UNKNOWN STATE", jobpane);
419 * @return DOCUMENT ME!
421 public String getInfoText()
423 return infoText.getText();
432 public void setInfoText(String text)
434 infoText.setText(text);
443 public void appendInfoText(String text)
445 infoText.append(text);
451 * @return DOCUMENT ME!
453 public String getProgressText(int which)
455 if (jobPanes == null)
461 return ((JEditorPane) ((JScrollPane) jobPanes.get(which))
462 .getViewport().getComponent(0)).getText();
466 return ((JTextArea) ((JScrollPane) jobPanes.get(which)).getViewport()
467 .getComponent(0)).getText();
477 public void setProgressText(int which, String text)
479 if (jobPanes == null)
485 ((JEditorPane) ((JScrollPane) jobPanes.get(which)).getViewport()
486 .getComponent(0)).setText(ensureHtmlTagged(text));
490 ((JTextArea) ((JScrollPane) jobPanes.get(which)).getViewport()
491 .getComponent(0)).setText(text);
496 * extract content from <body> content </body>
500 * - set to leave the initial html tag intact
502 * - set to leave the final html tag intact
505 private String getHtmlFragment(String text, boolean leaveFirst,
512 String lowertxt = text.toLowerCase();
513 int htmlpos = leaveFirst ? -1 : lowertxt.indexOf("<body");
515 int htmlend = leaveLast ? -1 : lowertxt.indexOf("</body");
516 int htmlpose = lowertxt.indexOf(">", htmlpos), htmlende = lowertxt
517 .indexOf(">", htmlend);
518 if (htmlend == -1 && htmlpos == -1)
524 return text.substring((htmlpos == -1 ? 0 : htmlpose + 1), htmlend);
526 return text.substring(htmlpos == -1 ? 0 : htmlpose + 1);
530 * very simple routine for adding/ensuring html tags are present in text.
533 * @return properly html tag enclosed text
535 private String ensureHtmlTagged(String text)
541 String lowertxt = text.toLowerCase();
542 int htmlpos = lowertxt.indexOf("<body");
543 int htmlend = lowertxt.indexOf("</body");
544 int doctype = lowertxt.indexOf("<!doctype");
545 int xmltype = lowertxt.indexOf("<?xml");
548 text = text + "</body></html>";
552 if ((doctype > -1 && htmlpos > doctype)
553 || (xmltype > -1 && htmlpos > xmltype))
555 text = "<html><head></head><body>\n" + text.substring(htmlpos - 1);
560 text = "<html><head></head><body>\n" + text;
562 if (text.indexOf("<meta") > -1)
564 System.err.println("HTML COntent: \n" + text
565 + "<< END HTML CONTENT\n");
577 public void appendProgressText(int which, String text)
579 if (jobPanes == null)
585 String txt = getHtmlFragment(
586 ((JEditorPane) ((JScrollPane) jobPanes.get(which))
587 .getViewport().getComponent(0)).getText(), true,
589 ((JEditorPane) ((JScrollPane) jobPanes.get(which)).getViewport()
590 .getComponent(0)).setText(ensureHtmlTagged(txt
591 + getHtmlFragment(text, false, true)));
595 ((JTextArea) ((JScrollPane) jobPanes.get(which)).getViewport()
596 .getComponent(0)).append(text);
601 * setProgressText(0, text)
603 public void setProgressText(String text)
605 setProgressText(0, text);
609 * appendProgressText(0, text)
611 public void appendProgressText(String text)
613 appendProgressText(0, text);
619 public String getProgressText()
621 return getProgressText(0);
625 * get the tab title for a subjob
631 public String getProgressName(int which)
633 if (jobPanes == null)
639 return subjobs.getTitleAt(which);
643 return ((JScrollPane) jobPanes.get(which)).getViewport()
644 .getComponent(0).getName();
649 * set the tab title for a subjob
656 public void setProgressName(String name, int which)
660 subjobs.setTitleAt(which, name);
661 subjobs.revalidate();
664 JScrollPane c = (JScrollPane) jobPanes.get(which);
665 c.getViewport().getComponent(0).setName(name);
670 * Gui action for cancelling the current job, if possible.
675 protected void cancel_actionPerformed(ActionEvent e)
677 if (!serviceIsCancellable)
679 // JBPNote : TODO: We should REALLY just tell the WSClientI to cancel
680 // anyhow - it has to stop threads and clean up
681 // JBPNote : TODO: Instead of a warning, we should have an optional 'Are
683 warnUser(MessageManager.getString("warn.job_cannot_be_cancelled_close_window"),
684 MessageManager.getString("action.cancel_job"));
688 thisService.cancelJob();
690 frame.setClosable(true);
694 * Spawns a thread that pops up a warning dialog box with the given message
700 public void warnUser(final String message, final String title)
702 javax.swing.SwingUtilities.invokeLater(new Runnable()
706 JOptionPane.showInternalMessageDialog(Desktop.desktop, message,
707 title, JOptionPane.WARNING_MESSAGE);
714 * Set up GUI for user to get at results - and possibly automatically display
715 * them if viewResultsImmediatly is set.
717 public void setResultsReady()
719 frame.setClosable(true);
720 buttonPanel.remove(cancel);
721 buttonPanel.add(showResultsNewFrame);
722 if (serviceCanMergeResults)
724 buttonPanel.add(mergeResults);
725 buttonPanel.setLayout(new GridLayout(2, 1, 5, 5));
727 buttonPanel.validate();
729 if (viewResultsImmediatly)
731 showResultsNewFrame.doClick();
736 * called when job has finished but no result objects can be passed back to
739 public void setFinishedNoResults()
741 frame.setClosable(true);
742 buttonPanel.remove(cancel);
743 buttonPanel.validate();
747 class AnimatedPanel extends JPanel implements Runnable
751 BufferedImage offscreen;
755 startTime = System.currentTimeMillis();
757 while (currentStatus < STATE_STOPPED_OK)
763 int units = (int) ((System.currentTimeMillis() - startTime) / 10f);
766 startTime = System.currentTimeMillis();
768 if (currentStatus >= STATE_STOPPED_OK)
774 } catch (Exception ex)
779 cancel.setEnabled(false);
784 if (offscreen == null || offscreen.getWidth(this) != getWidth()
785 || offscreen.getHeight(this) != getHeight())
787 offscreen = new BufferedImage(getWidth(), getHeight(),
788 BufferedImage.TYPE_INT_ARGB);
791 Graphics2D g = (Graphics2D) offscreen.getGraphics();
793 g.setColor(Color.white);
794 g.fillRect(0, 0, getWidth(), getHeight());
796 g.setFont(new Font("Arial", Font.BOLD, 12));
797 g.setColor(Color.black);
799 switch (currentStatus)
803 title.concat(" - ").concat(
804 MessageManager.getString("label.state_queueing")),
811 title.concat(" - ").concat(
812 MessageManager.getString("label.state_running")),
817 case STATE_STOPPED_OK:
819 title.concat(" - ").concat(
820 MessageManager.getString("label.state_completed")),
825 case STATE_CANCELLED_OK:
827 title.concat(" - ").concat(
829 .getString("label.state_job_cancelled")),
834 case STATE_STOPPED_ERROR:
836 title.concat(" - ").concat(
837 MessageManager.getString("label.state_job_error")),
842 case STATE_STOPPED_SERVERERROR:
844 title.concat(" - ").concat(
846 .getString("label.server_error_try_later")),
854 int x = image.getWidth(this) / 2, y = image.getHeight(this) / 2;
855 g.rotate(Math.toRadians(angle), 10 + x, 10 + y);
856 g.drawImage(image, 10, 10, this);
857 g.rotate(-Math.toRadians(angle), 10 + x, 10 + y);
861 public void paintComponent(Graphics g1)
865 g1.drawImage(offscreen, 0, 0, this);
869 boolean renderAsHtml = false;
871 public void setRenderAsHtml(boolean b)
876 public void hyperlinkUpdate(HyperlinkEvent e)
878 Desktop.hyperlinkUpdate(e);
884 * @see jalview.gui.IProgressIndicator#setProgressBar(java.lang.String, long)
887 public void setProgressBar(String message, long id)
889 progressBar.setProgressBar(message, id);
893 public void registerHandler(final long id,
894 final IProgressIndicatorHandler handler)
896 progressBar.registerHandler(id, handler);
901 * @return true if any progress bars are still active
904 public boolean operationInProgress()
906 return progressBar.operationInProgress();