Dépôt officiel du code source de l'ERP OpenConcerto

/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

 *

 * Copyright 2011 OpenConcerto, by ILM Informatique. All rights reserved.

 *

 * The contents of this file are subject to the terms of the GNU General Public License Version 3

 * only ("GPL"). You may not use this file except in compliance with the License. You can obtain a

 * copy of the License at http://www.gnu.org/licenses/gpl-3.0.html See the License for the specific

 * language governing permissions and limitations under the License.

 *

 * When distributing the software, include this License Header Notice in each file.

 */

 /*

 * ExceptionHandler created on 7 mai 2004

 */

package org.openconcerto.utils;

import org.openconcerto.utils.SystemInfo.Info;

import org.openconcerto.utils.cc.IFactory;

import org.openconcerto.utils.io.PercentEncoder;

import java.awt.Component;

import java.awt.Desktop;

import java.awt.Desktop.Action;

import java.awt.Dialog;

import java.awt.Dimension;

import java.awt.FlowLayout;

import java.awt.Font;

import java.awt.Frame;

import java.awt.GraphicsEnvironment;

import java.awt.GridBagConstraints;

import java.awt.GridBagLayout;

import java.awt.Insets;

import java.awt.Toolkit;

import java.awt.Window;

import java.awt.datatransfer.Clipboard;

import java.awt.datatransfer.StringSelection;

import java.awt.event.ActionEvent;

import java.awt.event.ActionListener;

import java.awt.event.WindowAdapter;

import java.awt.event.WindowEvent;

import java.io.BufferedReader;

import java.io.InputStreamReader;

import java.io.OutputStream;

import java.net.HttpURLConnection;

import java.net.URI;

import java.net.URL;

import java.nio.charset.Charset;

import java.util.Locale;

import java.util.Map;

import java.util.concurrent.CompletableFuture;

import java.util.concurrent.Future;

import java.util.concurrent.FutureTask;

import java.util.concurrent.atomic.AtomicInteger;

import java.util.logging.Level;

import java.util.logging.Logger;

import java.util.regex.Pattern;

import javax.swing.AbstractAction;

import javax.swing.ImageIcon;

import javax.swing.JButton;

import javax.swing.JDialog;

import javax.swing.JLabel;

import javax.swing.JOptionPane;

import javax.swing.JPanel;

import javax.swing.JScrollPane;

import javax.swing.JSeparator;

import javax.swing.JTextArea;

import javax.swing.ScrollPaneConstants;

import javax.swing.SwingUtilities;

import javax.swing.UIManager;

/**

 * Allow to display an exception both on the GUI and on the console.

 *

 * @author ILM Informatique 7 mai 2004

 */

public class ExceptionHandler extends RuntimeException {

    private static final Pattern NL_PATTERN = Pattern.compile("\r?\n");

    private static final String ILM_CONTACT = "http://www.ilm-informatique.fr/contact";

    private static String forumURL = null;

    private static boolean showProbably = false;

    private static IFactory<String> softwareInfos = null;

    private static ThrowableHandler tHandler = null;

    private static boolean safeToExit = false;

    private static final CompletableFuture<Boolean> FALSE_FUTURE = CompletableFuture.completedFuture(Boolean.FALSE);

    private static final CompletableFuture<Boolean> TRUE_FUTURE = CompletableFuture.completedFuture(Boolean.TRUE);

    public static void setThrowableHandler(ThrowableHandler handler) {

        tHandler = handler;

    }

    public static void setForumURL(String url) {

        forumURL = url;

    }

    public static void setSafeToExit(boolean b) {

        safeToExit = b;

    }

    public static void setSubmitErrorAutoEnabled(boolean b) {

        submitErrorAuto = b;

    }

    public static synchronized void setShowProbably(boolean showProbably) {

        ExceptionHandler.showProbably = showProbably;

    }

    public static synchronized boolean isShowProbably() {

        return ExceptionHandler.showProbably;

    }

    public synchronized static void setSoftwareInformations(final IFactory<String> f) {

        softwareInfos = f;

    }

    public synchronized static String computeSoftwareInformations() {

        if (softwareInfos == null)

            return "";

        return softwareInfos.createChecked();

    }

    static private void copyToClipboard(final String s) {

        final Clipboard clipboard = Toolkit.getDefaultToolkit().getSystemClipboard();

        final StringSelection data = new StringSelection(s);

        clipboard.setContents(data, data);

    }

    /**

     * Display the passed message. Note: this method doesn't block.

     *

     * @param comp the modal parent of the error window.

     * @param msg the message to display.

     * @param originalExn the cause, can be <code>null</code>.

     * @return a future completed when the error is handled (e.g. the user clicked on the dialog),

     *         <code>false</code> if the error couldn't be displayed to the user.

     */

    static public Future<Boolean> handle(Component comp, String msg, Throwable originalExn) {

        final Future<Boolean> res;

        if (tHandler != null && tHandler.handle(msg, originalExn)) {

            res = TRUE_FUTURE;

        } else {

            res = new ExceptionHandler(comp, msg, originalExn, false).display();

        }

        assert res != null;

        return res;

    }

    static public Future<Boolean> handle(String msg, Throwable originalExn) {

        return handle(null, msg, originalExn);

    }

    static public Future<Boolean> handle(String msg) {

        return handle(msg, null);

    }

    /**

     * Display the passed message and quit. Note: this method blocks until the user closes the

     * window (then exits).

     *

     * @param msg the message to display.

     * @param originalExn the cause, can be <code>null</code>.

     * @return an exception.

     */

    static public RuntimeException die(String msg, Throwable originalExn) {

        final ExceptionHandler res = new ExceptionHandler(null, msg, originalExn);

        res.display();

        return res;

    }

    static public RuntimeException die(String msg) {

        return die(msg, null);

    }

    private static Logger getLogger() {

        return Logger.getLogger(Logger.GLOBAL_LOGGER_NAME);

    }

    // the comp on which to display the popup, may be null

    private final Component comp;

    private final boolean quit;

    protected static AtomicInteger openedWindows = new AtomicInteger(0);

    private static boolean forceUI;

    private static boolean submitErrorAuto = false;

    public static void setForceUI(boolean forceUI) {

        ExceptionHandler.forceUI = forceUI;

    }

    private Future<Boolean> display() {

        final boolean error = this.quit;

        final String msg = this.getMessage();

        // write out the message as soon as possible

        getLogger().log(error ? Level.SEVERE : Level.INFO, null, this);

        // then show it to the user

        if (!GraphicsEnvironment.isHeadless() || forceUI) {

            if (openedWindows.get() > 3) {

                return FALSE_FUTURE;

            }

            final FutureTask<Boolean> run = new FutureTask<>(() -> {

                return showMsgHardened(msg, error);

            });

            if (SwingUtilities.isEventDispatchThread()) {

                run.run();

            } else {

                if (error) {

                    try {

                        SwingUtilities.invokeAndWait(run);

                    } catch (Exception e) {

                        e.printStackTrace();

                        System.exit(1);

                    }

                } else {

                    SwingUtilities.invokeLater(run);

                }

            }

            return run;

        }

        return TRUE_FUTURE;

    }

    protected final Boolean showMsgHardened(final String msg, final boolean error) {

        try {

            showMsg(msg, error);

            return Boolean.TRUE;

        } catch (Throwable e) {

            // sometimes the VM cannot display the dialog, in that case don't crash the EDT as the

            // message has already been logged. Further if this class is used in

            // Thread.setDefaultUncaughtExceptionHandler(), it will create an infinite loop.

            e = new Exception("Couldn't display message", e);

            e.printStackTrace();

            try {

                // last ditch effort

                JOptionPane.showMessageDialog(null, e.getMessage() + " : " + msg);

            } catch (Throwable e2) {

                // nothing

            }

        }

        return Boolean.FALSE;

    }

    protected final void showMsg(final String msg, final boolean quit) {

        final JPanel p = new JPanel();

        p.setLayout(new GridBagLayout());

        final GridBagConstraints c = new GridBagConstraints();

        c.insets = new Insets(10, 10, 10, 10);

        c.gridx = 0;

        c.gridy = 0;

        c.fill = GridBagConstraints.BOTH;

        final JImage im = new JImage(new ImageIcon(ExceptionHandler.class.getResource("error.png")));

        final JLabel l = new JLabel("Une erreur est survenue");

        l.setFont(l.getFont().deriveFont(Font.BOLD));

        final JTextArea textArea = new JTextArea();

        textArea.setFont(textArea.getFont().deriveFont(11f));

        c.gridheight = 3;

        p.add(im, c);

        c.insets = new Insets(2, 4, 2, 4);

        c.gridheight = 1;

        c.gridx++;

        c.weightx = 1;

        c.gridwidth = 1;

        p.add(l, c);

        c.gridy++;

        final JLabel lError = new JLabel("<html>" + NL_PATTERN.matcher(msg).replaceAll("<br>") + "</html>");

        p.add(lError, c);

        c.gridy++;

        if (isShowProbably()) {

            p.add(new JLabel("Il s'agit probablement d'une mauvaise configuration ou installation du logiciel."), c);

            c.gridy++;

        }

        c.gridx = 0;

        c.weighty = 0;

        c.gridwidth = 2;

        final JPanel btnPanel = new JPanel();

        final Desktop desktop = Desktop.isDesktopSupported() ? Desktop.getDesktop() : null;

        final boolean browseSupported = desktop != null && desktop.isSupported(Action.BROWSE);

        if (forumURL != null) {

            final javax.swing.Action communityAction;

            if (browseSupported) {

                communityAction = new AbstractAction("Consulter le forum") {

                    @Override

                    public void actionPerformed(ActionEvent e) {

                        if (desktop != null) {

                            try {

                                desktop.browse(new URI(forumURL));

                            } catch (Exception e1) {

                                e1.printStackTrace();

                            }

                        }

                    }

                };

            } else {

                communityAction = new AbstractAction("Copier l'adresse du forum") {

                    @Override

                    public void actionPerformed(ActionEvent e) {

                        copyToClipboard(forumURL);

                    }

                };

            }

            btnPanel.add(new JButton(communityAction));

        }

        final javax.swing.Action supportAction;

        if (browseSupported) {

            supportAction = new AbstractAction("Contacter l'assistance") {

                @Override

                public void actionPerformed(ActionEvent e) {

                    if (desktop != null) {

                        try {

                            desktop.browse(URI.create(ILM_CONTACT));

                        } catch (Exception e1) {

                            e1.printStackTrace();

                        }

                    }

                }

            };

        } else {

            supportAction = new AbstractAction("Copier l'adresse de l'assistance") {

                @Override

                public void actionPerformed(ActionEvent e) {

                    copyToClipboard(ILM_CONTACT);

                }

            };

        }

        btnPanel.add(new JButton(supportAction));

        btnPanel.add(new JButton(new AbstractAction("Copier l'erreur") {

            @Override

            public void actionPerformed(ActionEvent e) {

                copyToClipboard(textArea.getText());

            }

        }));

        c.fill = GridBagConstraints.NONE;

        c.anchor = GridBagConstraints.EAST;

        p.add(btnPanel, c);

        c.gridy++;

        c.gridx = 0;

        c.gridwidth = 2;

        c.fill = GridBagConstraints.BOTH;

        c.insets = new Insets(0, 0, 0, 0);

        p.add(new JSeparator(), c);

        c.gridx = 0;

        c.gridy++;

        c.insets = new Insets(2, 4, 2, 4);

        p.add(new JLabel("Détails de l'erreur:"), c);

        c.insets = new Insets(0, 0, 0, 0);

        c.gridy++;

        String message = this.getCause() == null ? null : this.getCause().getMessage();

        if (message == null) {

            message = msg;

        } else {

            message = msg + "\n\n" + message;

        }

        message += "\n";

        message += getTrace();

        if (submitErrorAuto) {

            submitError(message);

        }

        textArea.setText(message);

        textArea.setEditable(false);

        // Scroll

        JScrollPane scroll = new JScrollPane(textArea);

        scroll.setHorizontalScrollBarPolicy(ScrollPaneConstants.HORIZONTAL_SCROLLBAR_ALWAYS);

        scroll.setVerticalScrollBarPolicy(ScrollPaneConstants.VERTICAL_SCROLLBAR_ALWAYS);

        scroll.getViewport().setMinimumSize(new Dimension(200, 300));

        c.weighty = 1;

        c.gridx = 0;

        c.gridy++;

        p.add(scroll, c);

        c.gridy++;

        c.fill = GridBagConstraints.NONE;

        c.weighty = 0;

        c.insets = new Insets(2, 4, 2, 4);

        JPanel closePanel = new JPanel();

        closePanel.setLayout(new FlowLayout());

        if (safeToExit) {

            closePanel.add(new JButton(new AbstractAction("Quitter") {

                @Override

                public void actionPerformed(ActionEvent e) {

                    System.exit(2);

                }

            }));

        }

        final JButton buttonClose = new JButton("Fermer");

        closePanel.add(buttonClose);

        p.add(closePanel, c);

        final Window window = this.comp == null ? null : SwingUtilities.getWindowAncestor(this.comp);

        final JDialog f;

        if (window instanceof Frame) {

            f = new JDialog((Frame) window, "Erreur", true);

        } else {

            f = new JDialog((Dialog) window, "Erreur", true);

        }

        f.setContentPane(p);

        f.pack();

        f.setSize(780, 580);

        f.setMinimumSize(new Dimension(380, 380));

        f.setLocationRelativeTo(this.comp);

        final ActionListener al = new ActionListener() {

            @Override

            public void actionPerformed(ActionEvent e) {

                openedWindows.decrementAndGet();

                if (quit) {

                    System.exit(1);

                } else {

                    f.dispose();

                }

            }

        };

        buttonClose.addActionListener(al);

        // cannot set EXIT_ON_CLOSE on JDialog

        f.addWindowListener(new WindowAdapter() {

            @Override

            public void windowClosing(WindowEvent e) {

                al.actionPerformed(null);

            }

        });

        openedWindows.incrementAndGet();

        f.setVisible(true);

    }

    private String getTrace() {

        return ExceptionUtils.getStackTrace(this);

    }

    /**

     * Affiche l'erreur et quitte.

     *

     * @param comp the component upon which to display the popup.

     * @param msg le message d'erreur à afficher.

     * @param cause la cause de l'exception (peut être <code>null</code>).

     */

    private ExceptionHandler(Component comp, String msg, Throwable cause) {

        this(comp, msg, cause, true);

    }

    /**

     * Affiche l'erreur et quitte suivant l'option passée.

     *

     * @param comp the component upon which to display the popup.

     * @param msg the error message to display.

     * @param cause the cause of the exception (maybe <code>null</code>).

     * @param quit if the VM must exit.

     */

    private ExceptionHandler(Component comp, String msg, Throwable cause, boolean quit) {

        super(msg, cause);

        this.comp = comp;

        this.quit = quit;

    }

    private void submitError(String error) {

        final Charset cs = StringUtils.UTF8;

        try {

            ProductInfo productInfo = ProductInfo.getInstance();

            String name = "", version = "";

            if (productInfo != null) {

                name = productInfo.getName();

                version = productInfo.getProperty(ProductInfo.VERSION, version);

            }

            final Map<Info, String> systemInfos = SystemInfo.get(false, Locale.ENGLISH);

            final String os = systemInfos.remove(Info.OS);

            final String java = systemInfos.toString();

            final String encodedData = "java=" + PercentEncoder.encode(java, cs) + "&os=" + PercentEncoder.encode(os, cs) + "&software=" + PercentEncoder.encode(name + version, cs) + "&stack="

                    + PercentEncoder.encode(computeSoftwareInformations() + "\n\n" + error, cs);

            Thread t = new Thread(new Runnable() {

                @Override

                public void run() {

                    final String request = "http://bugreport.ilm-informatique.fr:5000/bugreport";

                    try {

                        System.err.println("ExceptionHandler.submitError");

                        final URL url = new URL(request);

                        final HttpURLConnection connection = (HttpURLConnection) url.openConnection();

                        connection.setDoOutput(true);

                        connection.setRequestMethod("POST");

                        connection.setRequestProperty("Content-Type", "application/x-www-form-urlencoded");

                        connection.setRequestProperty("charset", cs.name());

                        final byte[] bytes = encodedData.getBytes(cs);

                        connection.setRequestProperty("Content-Length", String.valueOf(bytes.length));

                        final OutputStream outputStream = connection.getOutputStream();

                        outputStream.write(bytes);

                        outputStream.flush();

                        // Get the response

                        final StringBuilder answer = new StringBuilder();

                        BufferedReader reader = new BufferedReader(new InputStreamReader(connection.getInputStream()));

                        String line;

                        while ((line = reader.readLine()) != null) {

                            answer.append(line);

                        }

                        outputStream.close();

                        reader.close();

                        connection.disconnect();

                    } catch (Exception e) {

                        e.printStackTrace();

                    }

                }

            });

            t.start();

        } catch (Exception ex) {

            ex.printStackTrace();

        }

    }

    public static void main(String[] args) throws Exception {

        UIManager.setLookAndFeel(UIManager.getSystemLookAndFeelClassName());

        ExceptionHandler.handle("Fichier de configuration corrompu\n\nmulti\nline", new IllegalStateException("Id manquant"));

    }

}