CrashHandler.java

/*
 * SPDX-FileCopyrightText: 2011-2024 Minicraft+ contributors
 * SPDX-License-Identifier: GPL-3.0-only
 */

package minicraft.core;

import kong.unirest.Empty;
import kong.unirest.HttpResponse;
import minicraft.core.CrashHandler.ErrorInfo.ErrorType;
import minicraft.core.io.ClipboardHandler;
import minicraft.network.Analytics;
import minicraft.util.Logging;
import org.jetbrains.annotations.Nullable;

import javax.swing.BorderFactory;
import javax.swing.BoxLayout;
import javax.swing.JButton;
import javax.swing.JDialog;
import javax.swing.JLabel;
import javax.swing.JPanel;
import javax.swing.JScrollPane;
import javax.swing.JTextArea;
import javax.swing.UIManager;
import javax.swing.WindowConstants;

import java.awt.BorderLayout;
import java.awt.Font;
import java.awt.GraphicsEnvironment;
import java.awt.GridBagLayout;
import java.io.PrintWriter;
import java.io.StringWriter;
import java.util.concurrent.Future;

public class CrashHandler {
	public static void crashHandle(Thread thread, Throwable throwable) {
		crashHandle(throwable);
	}

	public static void crashHandle(Throwable throwable) {
		crashHandle(throwable, new ErrorInfo(true));
	}

	/**
	 * This handles application crashing errors by giving notification to the user clearly.<br>
	 * The user can only exit the program.
	 */
	public static void crashHandle(Throwable throwable, ErrorInfo info) {
		Logging.CRASHHANDLER.error(throwable);

		StringWriter string = new StringWriter();
		PrintWriter printer = new PrintWriter(string);
		throwable.printStackTrace(printer);

		Future<HttpResponse<Empty>> ping = Analytics.Crashes.ping();

		// Ensure ping finishes before program closes.
		if (GraphicsEnvironment.isHeadless() && ping != null) {
			try {
				ping.get();
			} catch (Exception ignored) {
			}
			return;
		}

		Logging.CRASHHANDLER.error("Crash: " + info.type.name + ": " + info.title + (info.message != null ? ": " + info.message : ""));

		JDialog dialog = new JDialog(Initializer.frame, "Crash: " + info.type.name, true); // Displays the error type.

		JLabel icon = new JLabel(UIManager.getIcon(info.serious ? "OptionPane.errorIcon" : "OptionPane.warningIcon"));
		icon.setBorder(BorderFactory.createEmptyBorder(8, 8, 8, 8));
		JPanel boxPanel1 = new JPanel(); // Styling the icon.
		boxPanel1.setLayout(new BoxLayout(boxPanel1, BoxLayout.Y_AXIS));
		boxPanel1.add(icon);
		dialog.getContentPane().add(boxPanel1, BorderLayout.WEST);

		JLabel title = new JLabel(info.title);
		title.setFont(title.getFont().deriveFont(20.0f));
		title.setAlignmentX(JLabel.CENTER_ALIGNMENT);

		JPanel gridPanel = new JPanel(new GridBagLayout()); // Centers the components.
		JPanel boxPanel2 = new JPanel();
		boxPanel2.setLayout(new BoxLayout(boxPanel2, BoxLayout.Y_AXIS));
		gridPanel.add(boxPanel2);
		boxPanel2.add(title);
		if (info.message != null && info.message.length() > 0) { // Displays the error message when available.
			JLabel msg = new JLabel(info.message);
			msg.setFont(title.getFont().deriveFont(12.5f).deriveFont(Font.PLAIN));
			msg.setAlignmentX(JLabel.CENTER_ALIGNMENT);
			boxPanel2.add(msg);
		}

		// Add all components to the dialog.
		gridPanel.setBorder(BorderFactory.createEmptyBorder(3, 0, 3, 0));
		dialog.getContentPane().add(gridPanel, BorderLayout.NORTH);
		dialog.getContentPane().add(getCrashPanel(info, getErrorScrollPane(string.toString()), dialog, string.toString()));

		dialog.setDefaultCloseOperation(WindowConstants.DO_NOTHING_ON_CLOSE); // Disables the close button.
		dialog.pack();
		dialog.setLocationRelativeTo(null);
		dialog.setVisible(true); // Shows the dialog.
		dialog.dispose();

		// Ensure ping finishes before program closes.
		if (ping != null) {
			try {
				ping.get();
			} catch (Exception ignored) {
			}
		}

		// Exits the program when the dialog closes.
		Logging.CRASHHANDLER.error("Application closes due to the crash.");
		System.exit(info.type.exitCode);
	}

	public static void errorHandle(Throwable throwable) {
		errorHandle(throwable, new ErrorInfo());
	}

	public static void errorHandle(Throwable throwable, ErrorInfo info) {
		errorHandle(throwable, info, null);
	}

	/**
	 * This handles application crashing errors by giving notification to the user clearly.<br>
	 * The user can ignore the error, continue handling the error or exit the program (only in serious errors or error reports).
	 * @param handling The handling function of the error.
	 */
	public static void errorHandle(Throwable throwable, ErrorInfo info, @Nullable Action handling) {
		throwable.printStackTrace();

		StringWriter string = new StringWriter();
		PrintWriter printer = new PrintWriter(string);
		throwable.printStackTrace(printer);

		Future<HttpResponse<Empty>> ping = Analytics.Crashes.ping();

		// Ensure ping finishes before program closes.
		if (GraphicsEnvironment.isHeadless() && ping != null) {
			try {
				ping.get();
			} catch (Exception ignored) {
			}
			return;
		}

		Logging.CRASHHANDLER.error(info.type.name + ": " + info.title + (info.message != null ? ": " + info.message : ""));

		JDialog dialog = new JDialog(Initializer.frame, "Error: " + info.type.name, true); // Displays the error type.

		// Sets the icon depends on the error type.
		JLabel icon = new JLabel(info.serious ? UIManager.getIcon("OptionPane.errorIcon") : info.type == ErrorType.REPORT ? UIManager.getIcon("OptionPane.informationIcon") : UIManager.getIcon("OptionPane.warningIcon"));
		icon.setBorder(BorderFactory.createEmptyBorder(8, 8, 8, 8));
		JPanel boxPanel1 = new JPanel(); // Styling the icon.
		boxPanel1.setLayout(new BoxLayout(boxPanel1, BoxLayout.Y_AXIS));
		boxPanel1.add(icon);
		dialog.getContentPane().add(boxPanel1, BorderLayout.WEST);

		JLabel title = new JLabel(info.title);
		title.setFont(title.getFont().deriveFont(20.0f));
		title.setAlignmentX(JLabel.CENTER_ALIGNMENT);

		JPanel gridPanel = new JPanel(new GridBagLayout()); // Centers the components.
		JPanel boxPanel2 = new JPanel();
		boxPanel2.setLayout(new BoxLayout(boxPanel2, BoxLayout.Y_AXIS));
		gridPanel.add(boxPanel2);
		boxPanel2.add(title);
		if (info.message != null && info.message.length() > 0) { // Displays the error message when available.
			JLabel msg = new JLabel(info.message);
			msg.setFont(title.getFont().deriveFont(12.5f).deriveFont(Font.PLAIN));
			msg.setAlignmentX(JLabel.CENTER_ALIGNMENT);
			boxPanel2.add(msg);
		}

		// Add all components to the dialog.
		gridPanel.setBorder(BorderFactory.createEmptyBorder(3, 0, 3, 0));
		dialog.getContentPane().add(gridPanel, BorderLayout.NORTH);
		dialog.getContentPane().add(getErrorPanel(info, getErrorScrollPane(string.toString()), dialog, string.toString(), handling, ping));

		dialog.setDefaultCloseOperation(WindowConstants.DO_NOTHING_ON_CLOSE); // Disables the close button.
		dialog.pack();
		dialog.setLocationRelativeTo(null);
		dialog.setVisible(true); // Shows the dialog.
	}

	/**
	 * Getting the stack trace display component.
	 */
	private static JScrollPane getErrorScrollPane(String stackTrace) {
		JTextArea errorDisplay = new JTextArea(stackTrace);
		errorDisplay.setEditable(false);
		return new JScrollPane(errorDisplay);
	}

	/**
	 * Getting the panel for crashing handling dialog.
	 */
	private static JPanel getCrashPanel(ErrorInfo info, JScrollPane errorPane, JDialog dialog, String stackTrace) {
		JPanel panel = new JPanel(new BorderLayout());
		panel.add(errorPane);
		JPanel buttonPanel = new JPanel();

		JButton copyButton = new JButton("Copy Error"); // Copies the information of the error.
		ClipboardHandler clip = new ClipboardHandler();
		copyButton.addActionListener(e -> clip.setClipboardContents(info.type.name + ": " + info.title + (info.message != null ? ": " + info.message : "") + "\n" + stackTrace));
		buttonPanel.add(copyButton);

		JButton exitButton = new JButton("Exit Program"); // Closes the dialog to exit program.
		exitButton.addActionListener(e -> {
			dialog.setVisible(false);
			dialog.dispose();
		});

		dialog.getRootPane().setDefaultButton(exitButton);
		buttonPanel.add(exitButton);

		panel.add(buttonPanel, BorderLayout.SOUTH);
		return panel;
	}

	private static JPanel getErrorPanel(ErrorInfo info, JScrollPane errorPane, JDialog dialog, String stackTrace, Action callback, Future<HttpResponse<Empty>> ping) {
		JPanel panel = new JPanel(new BorderLayout());
		panel.add(errorPane);
		JPanel buttonPanel = new JPanel();

		JButton copyButton = new JButton("Copy Error"); // Copies the information of the error.
		ClipboardHandler clip = new ClipboardHandler();
		copyButton.addActionListener(e -> clip.setClipboardContents(info.type.name + ": " + info.title + (info.message != null ? ": " + info.message : "") + "\n" + stackTrace));
		buttonPanel.add(copyButton);

		if (info.serious || info.type == ErrorType.REPORT) { // Ability to exit program when the error is serious or error report.
			JButton exitButton = new JButton("Exit Program");
			exitButton.addActionListener(e -> {
				dialog.setVisible(false);
				dialog.dispose();

				// Ensure ping finishes before program closes.
				if (ping != null) {
					try {
						ping.get();
					} catch (Exception ignored) {
					}
				}

				Logging.CRASHHANDLER.error("Application closes due to the error.");
				System.exit(info.type.exitCode);
			});

			buttonPanel.add(exitButton);
		}

		if (callback != null) {
			JButton ignoreButton = new JButton("Ignore"); // Continues the program without handling the error with the callback.
			ignoreButton.addActionListener(e -> {
				dialog.setVisible(false);
				dialog.dispose();
			});
			buttonPanel.add(ignoreButton);
		}

		JButton continueButton = new JButton("Continue"); // Continues the program and also handles the error with the callback.
		continueButton.addActionListener(e -> {
			dialog.setVisible(false);
			dialog.dispose();
			if (callback != null) callback.act();
		});
		dialog.getRootPane().setDefaultButton(continueButton);
		buttonPanel.add(continueButton);

		panel.add(buttonPanel, BorderLayout.SOUTH);
		return panel;
	}

	public static class ErrorInfo {
		public final String title;
		public final ErrorType type;
		public final String message;
		public final boolean serious;

		public ErrorInfo() {
			this(false);
		}

		public ErrorInfo(boolean crashing) {
			this(crashing ? "General Application Crash" : "General Application Error",
				crashing ? ErrorType.DEFAULT : ErrorType.REPORT);
		}

		public ErrorInfo(String topic) {
			this(topic, ErrorType.DEFAULT);
		}

		public ErrorInfo(String topic, ErrorType type) {
			this(topic, type, type.exitCode != 0);
		}

		public ErrorInfo(String topic, ErrorType type, boolean serious) {
			this(topic, type, serious, null);
		}

		public ErrorInfo(String topic, ErrorType type, String message) {
			this(topic, type, type.exitCode < 0, message);
		}

		public ErrorInfo(String topic, ErrorType type, boolean serious, String message) {
			this.title = topic;
			this.type = type;
			this.message = message;
			this.serious = serious;
		}

		/**
		 * The error types. Add more types when needed.
		 */
		public static enum ErrorType {
			DEFAULT(-1, "Unhandled error"),
			UNEXPECTED(-2, "Unexpected error"),
			UNHANDLEABLE(-3, "Unhandleable error"),
			SERIOUS(1, "Serious error"),
			HANDLED(0, "Handled error"),
			REPORT(0, "Error report"),
			;

			/**
			 * The exit codes are referring to https://www.techiedelight.com/exit-codes-java-system-exit-method/
			 */
			public final int exitCode;
			public final String name;

			ErrorType(int exitCode, String message) {
				this.exitCode = exitCode;
				this.name = message;
			}
		}
	}
}