[10649] | 1 | // License: GPL. For details, see LICENSE file.
|
---|
| 2 | package org.openstreetmap.josm.tools.bugreport;
|
---|
| 3 |
|
---|
| 4 | import static org.openstreetmap.josm.tools.I18n.tr;
|
---|
| 5 |
|
---|
| 6 | import java.awt.Component;
|
---|
| 7 | import java.awt.Frame;
|
---|
| 8 | import java.awt.GridBagConstraints;
|
---|
| 9 | import java.awt.GridBagLayout;
|
---|
[10720] | 10 | import java.awt.event.ActionEvent;
|
---|
[10649] | 11 |
|
---|
[10720] | 12 | import javax.swing.AbstractAction;
|
---|
[10649] | 13 | import javax.swing.BorderFactory;
|
---|
| 14 | import javax.swing.Icon;
|
---|
| 15 | import javax.swing.JButton;
|
---|
| 16 | import javax.swing.JCheckBox;
|
---|
| 17 | import javax.swing.JDialog;
|
---|
| 18 | import javax.swing.JLabel;
|
---|
[10819] | 19 | import javax.swing.JOptionPane;
|
---|
[10649] | 20 | import javax.swing.JPanel;
|
---|
| 21 | import javax.swing.UIManager;
|
---|
| 22 |
|
---|
| 23 | import org.openstreetmap.josm.Main;
|
---|
| 24 | import org.openstreetmap.josm.actions.ExpertToggleAction;
|
---|
[10819] | 25 | import org.openstreetmap.josm.gui.preferences.plugin.PluginPreference;
|
---|
| 26 | import org.openstreetmap.josm.gui.util.GuiHelper;
|
---|
[10649] | 27 | import org.openstreetmap.josm.gui.widgets.JMultilineLabel;
|
---|
| 28 | import org.openstreetmap.josm.gui.widgets.UrlLabel;
|
---|
[10819] | 29 | import org.openstreetmap.josm.plugins.PluginDownloadTask;
|
---|
| 30 | import org.openstreetmap.josm.plugins.PluginHandler;
|
---|
[10649] | 31 | import org.openstreetmap.josm.tools.GBC;
|
---|
| 32 | import org.openstreetmap.josm.tools.ImageProvider;
|
---|
[10791] | 33 | import org.openstreetmap.josm.tools.InputMapUtils;
|
---|
[10819] | 34 | import org.openstreetmap.josm.tools.bugreport.BugReportQueue.SuppressionMode;
|
---|
[10649] | 35 |
|
---|
| 36 | /**
|
---|
| 37 | * This is a dialog that can be used to display a bug report.
|
---|
| 38 | * <p>
|
---|
| 39 | * It displays the bug to the user and asks the user to submit a bug report.
|
---|
| 40 | * @author Michael Zangl
|
---|
| 41 | * @since 10649
|
---|
| 42 | */
|
---|
| 43 | public class BugReportDialog extends JDialog {
|
---|
| 44 | private static final int MAX_MESSAGE_SIZE = 500;
|
---|
| 45 | // This is explicitly not an ExtendedDialog - we still want to be able to display bug reports if there are problems with preferences/..
|
---|
| 46 | private final JPanel content = new JPanel(new GridBagLayout());
|
---|
| 47 | private final BugReport report;
|
---|
| 48 | private final DebugTextDisplay textPanel;
|
---|
[10819] | 49 | private JCheckBox cbSuppressSingle;
|
---|
| 50 | private JCheckBox cbSuppressAll;
|
---|
[10649] | 51 |
|
---|
| 52 | /**
|
---|
| 53 | * Create a new dialog.
|
---|
| 54 | * @param report The report to display the dialog for.
|
---|
| 55 | */
|
---|
| 56 | public BugReportDialog(BugReport report) {
|
---|
| 57 | super(findParent(), tr("You have encountered a bug in JOSM"));
|
---|
| 58 | this.report = report;
|
---|
| 59 | textPanel = new DebugTextDisplay(report);
|
---|
| 60 | setContentPane(content);
|
---|
| 61 |
|
---|
| 62 | addMessageSection();
|
---|
| 63 |
|
---|
| 64 | addUpToDateSection();
|
---|
[10819] | 65 | // TODO: Notify user about plugin updates, then remove that notification that is displayed before this dialog is displayed.
|
---|
[10649] | 66 |
|
---|
| 67 | addCreateTicketSection();
|
---|
| 68 |
|
---|
| 69 | if (ExpertToggleAction.isExpert()) {
|
---|
| 70 | addDebugTextSection();
|
---|
| 71 | }
|
---|
| 72 |
|
---|
| 73 | addIgnoreButton();
|
---|
| 74 |
|
---|
| 75 | pack();
|
---|
| 76 | setModal(true);
|
---|
| 77 | setDefaultCloseOperation(DISPOSE_ON_CLOSE);
|
---|
[10720] | 78 |
|
---|
[10791] | 79 | InputMapUtils.addEscapeAction(getRootPane(), new AbstractAction() {
|
---|
[10720] | 80 | @Override
|
---|
| 81 | public void actionPerformed(ActionEvent e) {
|
---|
| 82 | closeDialog();
|
---|
| 83 | }
|
---|
| 84 | });
|
---|
[10649] | 85 | }
|
---|
| 86 |
|
---|
| 87 | /**
|
---|
| 88 | * The message informing the user what happened.
|
---|
| 89 | */
|
---|
| 90 | private void addMessageSection() {
|
---|
| 91 | String message = tr(
|
---|
| 92 | "An unexpected exception occurred.\n" + "This is always a coding error. If you are running the latest "
|
---|
| 93 | + "version of JOSM, please consider being kind and file a bug report.");
|
---|
| 94 | Icon icon = UIManager.getIcon("OptionPane.errorIcon");
|
---|
| 95 |
|
---|
| 96 | JPanel panel = new JPanel(new GridBagLayout());
|
---|
| 97 |
|
---|
| 98 | panel.add(new JLabel(icon), GBC.std().insets(0, 0, 10, 0));
|
---|
| 99 | JMultilineLabel messageLabel = new JMultilineLabel(message);
|
---|
| 100 | messageLabel.setMaxWidth(MAX_MESSAGE_SIZE);
|
---|
| 101 | panel.add(messageLabel, GBC.eol().fill());
|
---|
[11196] | 102 | content.add(panel, GBC.eop().fill(GBC.HORIZONTAL).insets(20, 10, 10, 10));
|
---|
[10649] | 103 | }
|
---|
| 104 |
|
---|
| 105 | private void addDebugTextSection() {
|
---|
| 106 | JPanel panel = new JPanel(new GridBagLayout());
|
---|
| 107 | addBorder(panel, tr("Debug information"));
|
---|
| 108 | panel.add(textPanel, GBC.eop().fill());
|
---|
| 109 |
|
---|
[11196] | 110 | panel.add(new JLabel(tr("Manually report at:")+' '), GBC.std());
|
---|
[10649] | 111 | panel.add(new UrlLabel(Main.getJOSMWebsite() + "/newticket"), GBC.std().fill(GBC.HORIZONTAL));
|
---|
| 112 | JButton copy = new JButton("Copy to clipboard");
|
---|
[11102] | 113 | copy.addActionListener(e -> textPanel.copyToClipboard());
|
---|
[10649] | 114 | panel.add(copy, GBC.eol().anchor(GBC.EAST));
|
---|
| 115 | content.add(panel, GBC.eop().fill());
|
---|
| 116 | }
|
---|
| 117 |
|
---|
| 118 | private void addUpToDateSection() {
|
---|
| 119 | JPanel panel = new JosmUpdatePanel();
|
---|
| 120 | addBorder(panel, tr("Is JOSM up to date?"));
|
---|
| 121 | content.add(panel, GBC.eop().fill(GBC.HORIZONTAL));
|
---|
| 122 | }
|
---|
| 123 |
|
---|
| 124 | private void addCreateTicketSection() {
|
---|
| 125 | JPanel panel = new JPanel(new GridBagLayout());
|
---|
| 126 | addBorder(panel, tr("Send bug report"));
|
---|
| 127 |
|
---|
| 128 | JMultilineLabel helpText = new JMultilineLabel(
|
---|
| 129 | tr("If you are running the latest version of JOSM and the plugins, "
|
---|
| 130 | + "please file a bug report in our bugtracker.\n"
|
---|
| 131 | + "There the error information should already be "
|
---|
| 132 | + "filled in for you. Please include information on how to reproduce "
|
---|
| 133 | + "the error and try to supply as much detail as possible."));
|
---|
| 134 | helpText.setMaxWidth(MAX_MESSAGE_SIZE);
|
---|
| 135 | panel.add(helpText, GBC.eop().fill(GridBagConstraints.HORIZONTAL));
|
---|
| 136 |
|
---|
[11196] | 137 | Component settings = GBC.glue(0, 0);
|
---|
[10649] | 138 | if (ExpertToggleAction.isExpert()) {
|
---|
| 139 | // The default settings should be fine in most situations.
|
---|
[11196] | 140 | settings = new BugReportSettingsPanel(report);
|
---|
[10649] | 141 | }
|
---|
[11196] | 142 | panel.add(settings);
|
---|
[10649] | 143 |
|
---|
| 144 | JButton sendBugReportButton = new JButton(tr("Report Bug"), ImageProvider.get("bug"));
|
---|
| 145 | sendBugReportButton.addActionListener(e -> sendBug());
|
---|
[11196] | 146 | panel.add(sendBugReportButton, GBC.eol().insets(0, 0, 0, 0).anchor(GBC.SOUTHEAST));
|
---|
[10649] | 147 | content.add(panel, GBC.eop().fill(GBC.HORIZONTAL));
|
---|
| 148 | }
|
---|
| 149 |
|
---|
| 150 | private static void addBorder(JPanel panel, String title) {
|
---|
| 151 | panel.setBorder(BorderFactory.createCompoundBorder(BorderFactory.createTitledBorder(title), BorderFactory
|
---|
[11196] | 152 | .createEmptyBorder(5, 5, 5, 5)));
|
---|
[10649] | 153 | }
|
---|
| 154 |
|
---|
| 155 | private void addIgnoreButton() {
|
---|
| 156 | JPanel panel = new JPanel(new GridBagLayout());
|
---|
[10819] | 157 | cbSuppressSingle = new JCheckBox(tr("Suppress this error for this session."));
|
---|
| 158 | cbSuppressSingle.setVisible(false);
|
---|
| 159 | panel.add(cbSuppressSingle, GBC.std(0, 0).fill(GBC.HORIZONTAL));
|
---|
| 160 | cbSuppressAll = new JCheckBox(tr("Suppress further error dialogs for this session."));
|
---|
| 161 | cbSuppressAll.setVisible(false);
|
---|
| 162 | panel.add(cbSuppressAll, GBC.std(0, 1).fill(GBC.HORIZONTAL));
|
---|
[10649] | 163 | JButton ignore = new JButton(tr("Ignore this error."));
|
---|
| 164 | ignore.addActionListener(e -> closeDialog());
|
---|
[10819] | 165 | panel.add(ignore, GBC.std(1, 0).span(1, 2).anchor(GBC.CENTER));
|
---|
[11196] | 166 | content.add(panel, GBC.eol().fill(GBC.HORIZONTAL).insets(0, 0, 10, 10));
|
---|
[10649] | 167 | }
|
---|
| 168 |
|
---|
| 169 | /**
|
---|
| 170 | * Shows or hides the suppress errors button
|
---|
| 171 | * @param showSuppress <code>true</code> to show the suppress errors checkbox.
|
---|
| 172 | */
|
---|
| 173 | public void setShowSuppress(boolean showSuppress) {
|
---|
[10819] | 174 | cbSuppressSingle.setVisible(showSuppress);
|
---|
[10649] | 175 | pack();
|
---|
| 176 | }
|
---|
| 177 |
|
---|
| 178 | /**
|
---|
[10819] | 179 | * Shows or hides the suppress all errors button
|
---|
| 180 | * @param showSuppress <code>true</code> to show the suppress errors checkbox.
|
---|
| 181 | * @since 10819
|
---|
| 182 | */
|
---|
| 183 | public void setShowSuppressAll(boolean showSuppress) {
|
---|
| 184 | cbSuppressAll.setVisible(showSuppress);
|
---|
| 185 | pack();
|
---|
| 186 | }
|
---|
| 187 |
|
---|
| 188 | /**
|
---|
[10649] | 189 | * Check if the checkbox to suppress further errors was selected
|
---|
| 190 | * @return <code>true</code> if the user wishes to suppress errors.
|
---|
| 191 | */
|
---|
[10819] | 192 | public SuppressionMode shouldSuppressFurtherErrors() {
|
---|
| 193 | if (cbSuppressAll.isSelected()) {
|
---|
| 194 | return SuppressionMode.ALL;
|
---|
| 195 | } else if (cbSuppressSingle.isSelected()) {
|
---|
| 196 | return SuppressionMode.SAME;
|
---|
| 197 | } else {
|
---|
| 198 | return SuppressionMode.NONE;
|
---|
| 199 | }
|
---|
[10649] | 200 | }
|
---|
| 201 |
|
---|
| 202 | private void closeDialog() {
|
---|
| 203 | setVisible(false);
|
---|
| 204 | }
|
---|
| 205 |
|
---|
| 206 | private void sendBug() {
|
---|
| 207 | BugReportSender.reportBug(textPanel.getCodeText());
|
---|
| 208 | }
|
---|
| 209 |
|
---|
| 210 | /**
|
---|
| 211 | * A safe way to find a matching parent frame.
|
---|
| 212 | * @return The parent frame.
|
---|
| 213 | */
|
---|
| 214 | private static Frame findParent() {
|
---|
| 215 | Component current = Main.parent;
|
---|
| 216 | try {
|
---|
| 217 | // avoid cycles/invalid hirarchies
|
---|
| 218 | for (int i = 0; i < 20 && current != null; i++) {
|
---|
| 219 | if (current instanceof Frame) {
|
---|
| 220 | return (Frame) current;
|
---|
| 221 | }
|
---|
| 222 | current = current.getParent();
|
---|
| 223 | }
|
---|
[11746] | 224 | } catch (RuntimeException e) { // NOPMD
|
---|
[10649] | 225 | BugReport.intercept(e).put("current", current).warn();
|
---|
| 226 | }
|
---|
| 227 | return null;
|
---|
| 228 | }
|
---|
[10819] | 229 |
|
---|
| 230 | /**
|
---|
| 231 | * Show the bug report for a given exception
|
---|
| 232 | * @param e The exception to display
|
---|
| 233 | * @param exceptionCounter A counter of how many exceptions have already been worked on
|
---|
| 234 | * @return The new suppression status
|
---|
| 235 | * @since 10819
|
---|
| 236 | */
|
---|
| 237 | public static SuppressionMode showFor(ReportedException e, int exceptionCounter) {
|
---|
| 238 | if (e.isOutOfMemory()) {
|
---|
| 239 | // do not translate the string, as translation may raise an exception
|
---|
| 240 | JOptionPane.showMessageDialog(Main.parent, "JOSM is out of memory. " +
|
---|
| 241 | "Strange things may happen.\nPlease restart JOSM with the -Xmx###M option,\n" +
|
---|
| 242 | "where ### is the number of MB assigned to JOSM (e.g. 256).\n" +
|
---|
| 243 | "Currently, " + Runtime.getRuntime().maxMemory()/1024/1024 + " MB are available to JOSM.",
|
---|
| 244 | "Error",
|
---|
| 245 | JOptionPane.ERROR_MESSAGE
|
---|
| 246 | );
|
---|
| 247 | return SuppressionMode.NONE;
|
---|
| 248 | } else {
|
---|
| 249 | return GuiHelper.runInEDTAndWaitAndReturn(() -> {
|
---|
| 250 | PluginDownloadTask downloadTask = PluginHandler.updateOrdisablePluginAfterException(e);
|
---|
| 251 | if (downloadTask != null) {
|
---|
| 252 | // Ask for restart to install new plugin
|
---|
| 253 | PluginPreference.notifyDownloadResults(
|
---|
| 254 | Main.parent, downloadTask, !downloadTask.getDownloadedPlugins().isEmpty());
|
---|
| 255 | return SuppressionMode.NONE;
|
---|
| 256 | }
|
---|
| 257 |
|
---|
| 258 | BugReport report = new BugReport(e);
|
---|
| 259 | BugReportDialog dialog = new BugReportDialog(report);
|
---|
| 260 | dialog.setShowSuppress(exceptionCounter > 0);
|
---|
| 261 | dialog.setShowSuppressAll(exceptionCounter > 1);
|
---|
| 262 | dialog.setVisible(true);
|
---|
| 263 | return dialog.shouldSuppressFurtherErrors();
|
---|
| 264 | });
|
---|
| 265 | }
|
---|
| 266 | }
|
---|
[10649] | 267 | }
|
---|