1 package net.sf.openrocket.gui.dialogs;
3 import java.awt.Desktop;
4 import java.awt.Dialog;
5 import java.awt.Dimension;
6 import java.awt.Window;
7 import java.awt.event.ActionEvent;
8 import java.awt.event.ActionListener;
9 import java.io.IOException;
10 import java.io.PrintWriter;
11 import java.io.StringWriter;
12 import java.io.UnsupportedEncodingException;
14 import java.net.URISyntaxException;
15 import java.net.URLEncoder;
16 import java.util.List;
17 import java.util.Locale;
18 import java.util.SortedSet;
19 import java.util.TreeSet;
21 import javax.swing.JButton;
22 import javax.swing.JDialog;
23 import javax.swing.JLabel;
24 import javax.swing.JOptionPane;
25 import javax.swing.JPanel;
26 import javax.swing.JScrollPane;
27 import javax.swing.JTextArea;
29 import net.miginfocom.swing.MigLayout;
30 import net.sf.openrocket.communication.BugReporter;
31 import net.sf.openrocket.gui.components.SelectableLabel;
32 import net.sf.openrocket.gui.components.StyledLabel;
33 import net.sf.openrocket.l10n.Translator;
34 import net.sf.openrocket.logging.LogLevelBufferLogger;
35 import net.sf.openrocket.logging.LogLine;
36 import net.sf.openrocket.startup.Application;
37 import net.sf.openrocket.util.BugException;
38 import net.sf.openrocket.util.GUIUtil;
39 import net.sf.openrocket.util.JarUtil;
40 import net.sf.openrocket.util.Prefs;
42 public class BugReportDialog extends JDialog {
44 private static final String REPORT_EMAIL = "openrocket-bugs@lists.sourceforge.net";
45 private static final Translator trans = Application.getTranslator();
48 public BugReportDialog(Window parent, String labelText, String message) {
50 super(parent, trans.get("bugreport.dlg.title"), Dialog.ModalityType.APPLICATION_MODAL);
52 JPanel panel = new JPanel(new MigLayout("fill"));
54 // Some fscking Swing bug that makes html labels initially way too high
55 JLabel label = new JLabel(labelText);
56 Dimension d = label.getPreferredSize();
58 label.setMaximumSize(d);
59 panel.add(label, "gapleft para, wrap para");
61 //// <html>If connected to the Internet, you can simply click
62 //// <em>Send bug report</em>.
63 label = new JLabel(trans.get("bugreport.dlg.connectedInternet"));
64 d = label.getPreferredSize();
66 label.setMaximumSize(d);
67 panel.add(label, "gapleft para, wrap");
69 //// Otherwise, send the text below to the address:
70 panel.add(new JLabel(trans.get("bugreport.dlg.otherwise") +" "),
71 "gapleft para, split 2, gapright rel");
72 panel.add(new SelectableLabel(REPORT_EMAIL), "growx, wrap para");
75 final JTextArea textArea = new JTextArea(message, 20, 70);
76 textArea.setEditable(true);
77 panel.add(new JScrollPane(textArea), "grow, wrap");
80 panel.add(new StyledLabel(trans.get("bugreport.lbl.Theinformation"), -1), "wrap para");
85 JButton close = new JButton(trans.get("dlg.but.close"));
86 close.addActionListener(new ActionListener() {
88 public void actionPerformed(ActionEvent e) {
89 BugReportDialog.this.dispose();
92 panel.add(close, "right, sizegroup buttons, split");
96 // if (Desktop.isDesktopSupported() && Desktop.getDesktop().isSupported(Action.MAIL)) {
97 // JButton mail = new JButton("Open email");
98 // mail.setToolTipText("Open email client with the suitable email ready.");
99 // mail.addActionListener(new ActionListener() {
101 // public void actionPerformed(ActionEvent e) {
102 // String text = textArea.getText();
106 // panel.add(mail, "right, sizegroup buttons");
110 //// Send bug report button
111 JButton send = new JButton(trans.get("bugreport.dlg.but.Sendbugreport"));
112 //// Automatically send the bug report to the OpenRocket developers.
113 send.setToolTipText(trans.get("bugreport.dlg.but.Sendbugreport.Ttip"));
114 send.addActionListener(new ActionListener() {
116 public void actionPerformed(ActionEvent e) {
117 String text = textArea.getText();
120 BugReporter.sendBugReport(text);
122 // Success if we came here
123 //bugreport.dlg.successmsg
124 /*JOptionPane.showMessageDialog(BugReportDialog.this,
125 new Object[] { "Bug report successfully sent.",
126 "Thank you for helping make OpenRocket better!" },
127 "Bug report sent", JOptionPane.INFORMATION_MESSAGE);*/
128 JOptionPane.showMessageDialog(BugReportDialog.this,
129 new Object[] { trans.get("bugreport.dlg.successmsg1"),
130 trans.get("bugreport.dlg.successmsg2") },
131 trans.get("bugreport.dlg.successmsg3"), JOptionPane.INFORMATION_MESSAGE);
133 } catch (Exception ex) {
134 // Sending the message failed.
135 JOptionPane.showMessageDialog(BugReportDialog.this,
136 //// OpenRocket was unable to send the bug report:
137 new Object[] { trans.get("bugreport.dlg.failedmsg1"),
138 ex.getClass().getSimpleName() + ": " + ex.getMessage(), " ",
139 //// Please send the report manually to
140 trans.get("bugreport.dlg.failedmsg2") +" " + REPORT_EMAIL },
141 //// Error sending report
142 trans.get("bugreport.dlg.failedmsg3"), JOptionPane.ERROR_MESSAGE);
146 panel.add(send, "right, sizegroup buttons");
153 this.setLocationRelativeTo(parent);
155 GUIUtil.setDisposableDialogOptions(this, send);
161 * Show a general bug report dialog allowing the user to input information about
162 * the bug they encountered.
164 * @param parent the parent window (may be null).
166 public static void showBugReportDialog(Window parent) {
168 StringBuilder sb = new StringBuilder();
170 sb.append("---------- Bug report ----------\n");
172 sb.append("Include detailed steps on how to trigger the bug:\n");
179 sb.append("What does the software do and what in your opinion should it do in the " +
180 "case described above:\n");
185 sb.append("Include your email address (optional; it helps if we can " +
186 "contact you in case we need additional information):\n");
192 sb.append("(Do not modify anything below this line.)\n");
193 sb.append("---------- System information ----------\n");
194 addSystemInformation(sb);
195 sb.append("---------- Error log ----------\n");
197 sb.append("---------- End of bug report ----------\n");
200 BugReportDialog reportDialog =
201 new BugReportDialog(parent,
202 //// <html><b>You can report a bug in OpenRocket by filling in and submitting the form below.</b><br>You can also report bugs and include attachments on the project web site.
203 trans.get("bugreport.reportDialog.txt"), sb.toString());
204 reportDialog.setVisible(true);
209 * Show a dialog presented when an uncaught exception occurs.
211 * @param parent the parent window (may be null).
212 * @param t the thread that encountered the exception (may be null).
213 * @param e the exception.
215 public static void showExceptionDialog(Window parent, Thread t, Throwable e) {
216 StringBuilder sb = new StringBuilder();
218 sb.append("---------- Bug report ----------\n");
220 sb.append("Please include a description about what actions you were " +
221 "performing when the exception occurred:\n");
228 sb.append("Include your email address (optional; it helps if we can " +
229 "contact you in case we need additional information):\n");
235 sb.append("(Do not modify anything below this line.)\n");
236 sb.append("---------- Exception stack trace ----------\n");
237 StringWriter sw = new StringWriter();
238 PrintWriter pw = new PrintWriter(sw);
239 e.printStackTrace(pw);
240 sb.append(sw.getBuffer());
244 sb.append("---------- Thread information ----------\n");
246 sb.append("Thread is not specified.");
253 sb.append("---------- System information ----------\n");
254 addSystemInformation(sb);
255 sb.append("---------- Error log ----------\n");
257 sb.append("---------- End of bug report ----------\n");
260 BugReportDialog reportDialog =
261 //// <html><b>Please include a short description about what you were doing when the exception occurred.</b>
262 new BugReportDialog(parent, trans.get("bugreport.reportDialog.txt2"), sb.toString());
263 reportDialog.setVisible(true);
267 private static void addSystemInformation(StringBuilder sb) {
268 sb.append("OpenRocket version: " + Prefs.getVersion() + "\n");
269 sb.append("OpenRocket source: " + Prefs.getBuildSource() + "\n");
270 sb.append("OpenRocket location: " + JarUtil.getCurrentJarFile() + "\n");
271 sb.append("Current default locale: " + Locale.getDefault() + "\n");
272 sb.append("System properties:\n");
275 SortedSet<String> keys = new TreeSet<String>();
276 for (Object key : System.getProperties().keySet()) {
277 keys.add((String) key);
280 for (String key : keys) {
281 String value = System.getProperty(key);
282 sb.append(" " + key + "=");
283 if (key.equals("line.separator")) {
284 for (char c : value.toCharArray()) {
285 sb.append(String.format("\\u%04x", (int) c));
295 private static void addErrorLog(StringBuilder sb) {
296 LogLevelBufferLogger buffer = Application.getLogBuffer();
297 List<LogLine> logs = buffer.getLogs();
298 for (LogLine l : logs) {
299 sb.append(l.toString()).append('\n');
306 * Open the default email client with the suitable bug report.
307 * Note that this does not work on some systems even if Desktop.isSupported()
310 * @param text the bug report text.
311 * @return whether opening the client succeeded.
313 private boolean openEmail(String text) {
317 text = URLEncoder.encode(text, "UTF-8");
318 version = URLEncoder.encode(Prefs.getVersion(), "UTF-8");
319 } catch (UnsupportedEncodingException e) {
320 throw new BugException(e);
325 String mailto = "mailto:" + REPORT_EMAIL
326 + "?subject=Bug%20report%20for%20OpenRocket%20" + version
330 uri = new URI(mailto);
331 } catch (URISyntaxException e) {
336 Desktop desktop = Desktop.getDesktop();
339 } catch (IOException e) {