123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444 |
- /*
- * Copyright (c) 2006-2014 DMDirc Developers
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
- package com.dmdirc.logger;
-
- import com.dmdirc.util.ClientInfo;
-
- import java.io.IOException;
- import java.io.OutputStream;
- import java.io.PrintWriter;
- import java.io.Serializable;
- import java.nio.file.Files;
- import java.nio.file.Path;
- import java.text.DateFormat;
- import java.text.SimpleDateFormat;
- import java.util.Date;
- import java.util.Objects;
- import java.util.concurrent.Semaphore;
- import java.util.concurrent.atomic.AtomicInteger;
-
- import javax.annotation.Nullable;
-
- /**
- * Stores a program error.
- */
- public final class ProgramError implements Serializable {
-
- /** A version number for this class. */
- private static final long serialVersionUID = 3;
- /** Directory used to store errors. */
- private static Path errorDir;
- /** Semaphore used to serialise write access. */
- private static final Semaphore WRITING_SEM = new Semaphore(1);
- /** The reporter to use to send this error. */
- private final ErrorReporter reporter;
- /** Error ID. */
- private final long id;
- /** Error icon. */
- private final ErrorLevel level;
- /** Error message. */
- private final String message;
- /** Underlying exception. */
- private final Throwable exception;
- /** Underlying details message. */
- private final String details;
- /** Date/time error first occurred. */
- private final Date firstDate;
- /** Date/time error last occurred. */
- private Date lastDate;
- /** Number of occurrences. */
- private final AtomicInteger count;
- /** Error report Status. */
- private ErrorReportStatus reportStatus;
- /** Has the error been output. */
- private boolean handled;
-
- /**
- * Creates a new instance of ProgramError.
- *
- * @param id error id
- * @param level Error level
- * @param message Error message
- * @param exception The exception that caused the error, if any.
- * @param details The detailed cause of the error, if any.
- * @param date Error time and date
- */
- public ProgramError(final long id, final ErrorLevel level, final String message,
- @Nullable final Throwable exception,
- @Nullable final String details,
- final Date date,
- final ClientInfo clientInfo) {
-
- if (id < 0) {
- throw new IllegalArgumentException("ID must be a positive integer: " + id);
- }
-
- if (level == null) {
- throw new IllegalArgumentException("Level cannot be null");
- }
-
- if (message == null || message.isEmpty()) {
- throw new IllegalArgumentException("Message cannot be null or an empty string");
- }
-
- if (date == null) {
- throw new IllegalArgumentException("date cannot be null");
- }
-
- this.id = id;
- this.level = level;
- this.message = message;
- this.exception = exception;
- this.details = details;
- this.firstDate = (Date) date.clone();
- this.lastDate = (Date) date.clone();
- this.count = new AtomicInteger(1);
- this.reportStatus = ErrorReportStatus.WAITING;
- this.reporter = new ErrorReporter(clientInfo);
- }
-
- /**
- * Returns this errors level.
- *
- * @return Error level
- */
- public ErrorLevel getLevel() {
- return level;
- }
-
- /**
- * Returns this errors message.
- *
- * @return Error message
- */
- public String getMessage() {
- return message;
- }
-
- /**
- * Returns this errors trace.
- *
- * @return Error trace
- */
- public String[] getTrace() {
- return exception == null ? (message == null ? new String[0] : new String[]{message})
- : getTrace(exception);
- }
-
- /**
- * Returns this errors time.
- *
- * @return Error time
- */
- public Date getDate() {
- return (Date) firstDate.clone();
- }
-
- /**
- * Returns the number of times this error has occurred.
- *
- * @return Error count
- */
- public int getCount() {
- return count.get();
- }
-
- /**
- * Returns the last time this error occurred.
- *
- * @return Last occurrence
- */
- public Date getLastDate() {
- return (Date) lastDate.clone();
- }
-
- /**
- * Returns the reportStatus of this error.
- *
- * @return Error reportStatus
- */
- public ErrorReportStatus getReportStatus() {
- return reportStatus;
- }
-
- /**
- * Sets the report Status of this error.
- *
- * @param newStatus new ErrorReportStatus for the error
- */
- public void setReportStatus(final ErrorReportStatus newStatus) {
- if (newStatus != null && reportStatus != newStatus) {
- reportStatus = newStatus;
- ErrorManager.getErrorManager().fireErrorStatusChanged(this);
-
- synchronized (this) {
- notifyAll();
- }
- }
- }
-
- /**
- * Returns the ID of this error.
- *
- * @return Error ID
- */
- public long getID() {
- return id;
- }
-
- /**
- * Saves this error to disk.
- *
- * @param directory The directory to save the error in.
- */
- public void save(final Path directory) {
- try (PrintWriter out = new PrintWriter(getErrorFile(directory), true)) {
- out.println("Date:" + getDate());
- out.println("Level: " + getLevel());
- out.println("Description: " + getMessage());
- out.println("Details:");
-
- for (String traceLine : getTrace()) {
- out.println('\t' + traceLine);
- }
- }
- }
-
- /**
- * Creates a new file for an error and returns the output stream.
- *
- * @param directory The directory to save the error in.
- *
- * @return BufferedOutputStream to write to the error file
- */
- @SuppressWarnings("PMD.SystemPrintln")
- private OutputStream getErrorFile(final Path directory) {
- WRITING_SEM.acquireUninterruptibly();
-
- try {
- if (errorDir == null || !Files.exists(errorDir)) {
- errorDir = directory;
- if (!Files.exists(errorDir)) {
- Files.createDirectories(errorDir);
- }
- }
-
- final String logName = getDate().getTime() + "-" + getLevel();
-
- final Path errorFile = errorDir.resolve(logName + ".log");
-
- if (Files.exists(errorFile)) {
- boolean rename = false;
- for (int i = 0; !rename; i++) {
- try {
- Files.move(errorFile, errorDir.resolve(logName + '-' + i + ".log"));
- rename = true;
- } catch (IOException ex) {
- rename = false;
- if (i > 20) {
- // Something's probably catestrophically wrong. Give up.
- throw ex;
- }
- }
- }
- }
-
- Files.createFile(errorFile);
- return Files.newOutputStream(errorFile);
- } catch (IOException ex) {
- System.err.println("Error creating new file: ");
- ex.printStackTrace();
- return new NullOutputStream();
- } finally {
- WRITING_SEM.release();
- }
- }
-
- /**
- * Sends this error report to the DMDirc developers.
- */
- public void send() {
- setReportStatus(ErrorReportStatus.SENDING);
- reporter.sendException(message, level, firstDate, exception, details);
- setReportStatus(ErrorReportStatus.FINISHED);
- }
-
- /**
- * Determines whether or not the stack trace associated with this error is from a valid source.
- * A valid source is one that is within a DMDirc package (com.dmdirc), and is not the DMDirc
- * event queue.
- *
- * @return True if the source is valid, false otherwise
- */
- public boolean isValidSource() {
- final String line = getSourceLine();
-
- return line.startsWith("com.dmdirc")
- && !line.startsWith("com.dmdirc.addons.ui_swing.DMDircEventQueue");
- }
-
- /**
- * Returns the "source line" of this error, which is defined as the first line starting with a
- * DMDirc package name (com.dmdirc). If no such line is found, returns the first line of the
- * message.
- *
- * @return This error's source line
- */
- public String getSourceLine() {
- final String[] trace = getTrace();
-
- for (String line : trace) {
- if (line.startsWith("com.dmdirc")) {
- return line;
- }
- }
-
- return trace[0];
- }
-
- /**
- * Updates the last date this error occurred.
- */
- public void updateLastDate() {
- updateLastDate(new Date());
- }
-
- /**
- * Updates the last date this error occurred.
- *
- * @param date Date error occurred
- */
- public void updateLastDate(final Date date) {
- lastDate = date;
- count.getAndIncrement();
- ErrorManager.getErrorManager().fireErrorStatusChanged(this);
-
- synchronized (this) {
- notifyAll();
- }
- }
-
- /**
- * Returns a human readable string describing the number of times this error occurred and when
- * these occurrences were.
- *
- * @return Occurrences description
- */
- public String occurrencesString() {
- final DateFormat format = new SimpleDateFormat("MMM dd hh:mm aa");
- if (count.get() == 1) {
- return "1 occurrence on " + format.format(getDate());
- } else {
- return count.get() + " occurrences between " + format.format(
- getDate()) + " and " + format.format(getLastDate()) + '.';
- }
- }
-
- /**
- * Set this error as handled.
- */
- public void setHandled() {
- handled = true;
- }
-
- /**
- * Has this error been handled?
- *
- * @return Handled state
- */
- public boolean isHandled() {
- return handled;
- }
-
- @Override
- public String toString() {
- return "ID" + id + " Level: " + getLevel() + " Status: " + getReportStatus()
- + " Message: '" + getMessage() + '\'';
- }
-
- @Override
- public boolean equals(final Object obj) {
- if (obj == null) {
- return false;
- }
-
- if (getClass() != obj.getClass()) {
- return false;
- }
-
- final ProgramError other = (ProgramError) obj;
- return this.level == other.level && this.message.equals(other.message) &&
- Objects.equals(this.exception, other.exception) &&
- Objects.equals(this.details, other.details);
-
- }
-
- @Override
- public int hashCode() {
- int hash = 7;
- hash = 67 * hash + this.level.hashCode();
- hash = 67 * hash + this.message.hashCode();
- hash = 67 * hash + (this.exception == null ? 1 : this.exception.hashCode());
- hash = 67 * hash + (this.details == null ? 1 : this.details.hashCode());
- return hash;
- }
-
- /**
- * Converts an exception into a string array.
- *
- * @param throwable Exception to convert
- *
- * @since 0.6.3m1
- * @return Exception string array
- */
- private static String[] getTrace(final Throwable throwable) {
- String[] trace;
-
- if (throwable == null) {
- trace = new String[0];
- } else {
- final StackTraceElement[] traceElements = throwable.getStackTrace();
- trace = new String[traceElements.length + 1];
-
- trace[0] = throwable.toString();
-
- for (int i = 0; i < traceElements.length; i++) {
- trace[i + 1] = traceElements[i].toString();
- }
-
- if (throwable.getCause() != null) {
- final String[] causeTrace = getTrace(throwable.getCause());
- final String[] newTrace = new String[trace.length + causeTrace.length];
- trace[0] = "\nWhich caused: " + trace[0];
-
- System.arraycopy(causeTrace, 0, newTrace, 0, causeTrace.length);
- System.arraycopy(trace, 0, newTrace, causeTrace.length, trace.length);
-
- trace = newTrace;
- }
- }
-
- return trace;
- }
-
- }
|