Merge pull request #578 from greboid/dev2

Initial work on logback logging.

build.gradle

@@ -36,6 +36,7 @@ dependencies {
     compile group: 'com.squareup.dagger', name: 'dagger-compiler', version: '1.2.1'
     compile group: 'com.google.auto.value', name: 'auto-value', version: '1.0'
 
+    bundle group: 'ch.qos.logback', name: 'logback-classic', version: '1.1.2'
     bundle group: 'org.slf4j', name: 'slf4j-api', version:'1.7.10'
     bundle group: 'com.squareup.dagger', name: 'dagger', version: '1.2.1'
     bundle group: 'com.esotericsoftware.yamlbeans', name: 'yamlbeans', version: '1.08'

src/com/dmdirc/Main.java

@@ -43,6 +43,10 @@ import com.dmdirc.plugins.ServiceManager;
 import com.dmdirc.plugins.ServiceProvider;
 import com.dmdirc.ui.WarningDialog;
 
+import ch.qos.logback.classic.LoggerContext;
+import ch.qos.logback.classic.joran.JoranConfigurator;
+import ch.qos.logback.core.spi.ContextAware;
+
 import com.google.common.util.concurrent.ThreadFactoryBuilder;
 
 import java.awt.GraphicsEnvironment;
@@ -55,6 +59,9 @@ import java.util.concurrent.TimeUnit;
 
 import javax.inject.Inject;
 
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
 import dagger.ObjectGraph;
 
 /**
@@ -62,6 +69,7 @@ import dagger.ObjectGraph;
  */
 public class Main {
 
+    private final Logger log = LoggerFactory.getLogger(Main.class);
     /** The UI to use for the client. */
     private final Collection<UIController> CONTROLLERS = new HashSet<>();
     /** The identity manager the client will use. */
@@ -90,6 +98,14 @@ public class Main {
     private final ModeAliasReporter reporter;
     private final ServiceManager serviceManager;
 
+    static {
+        // TODO: Can this go in a Dagger module?
+        final LoggerContext context = (LoggerContext) LoggerFactory.getILoggerFactory();
+        final ContextAware configurator = new JoranConfigurator();
+        configurator.setContext(context);
+        context.reset();
+    }
+
     /**
      * Creates a new instance of {@link Main}.
      */
@@ -160,6 +176,7 @@ public class Main {
      */
     public void init() {
         Thread.setDefaultUncaughtExceptionHandler(new DMDircExceptionHandler(eventBus));
+        setupLogback();
         migrators.stream().filter(Migrator::needsMigration).forEach(Migrator::migrate);
         commands.forEach(c -> commandManager.registerCommand(c.getCommand(), c.getInfo()));
 
@@ -250,10 +267,22 @@ public class Main {
             identityManager.getUserSettings().setOption("general", "firstRun", "false");
             eventBus.publish(new FirstRunEvent());
 
-            Executors.newSingleThreadScheduledExecutor(new ThreadFactoryBuilder()
-                    .setNameFormat("feedback-nag-%d").build()).schedule(
+            Executors.newSingleThreadScheduledExecutor(
+                    new ThreadFactoryBuilder().setNameFormat("feedback-nag-%d").build()).schedule(
                     () -> eventBus.publishAsync(new FeedbackNagEvent()), 5, TimeUnit.MINUTES);
         }
     }
 
+    private void setupLogback() {
+        // TODO: Add a normal logging thing, with or without runtime switching.
+        final LoggerContext context = (LoggerContext) LoggerFactory.getILoggerFactory();
+        final ProgramErrorAppender appender = new ProgramErrorAppender();
+        appender.setEventBus(eventBus);
+        appender.setContext(context);
+        appender.setName("Error Logger");
+        appender.start();
+        final ch.qos.logback.classic.Logger rootLogger = context.getLogger(Logger.ROOT_LOGGER_NAME);
+        rootLogger.addAppender(appender);
+    }
+
 }

src/com/dmdirc/ProgramErrorAppender.java

@@ -0,0 +1,80 @@
+/*
+ * Copyright (c) 2006-2015 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;
+
+import com.dmdirc.events.AppErrorEvent;
+import com.dmdirc.events.UserErrorEvent;
+import com.dmdirc.logger.ErrorLevel;
+import com.dmdirc.logger.ProgramError;
+
+import ch.qos.logback.classic.spi.ILoggingEvent;
+import ch.qos.logback.core.AppenderBase;
+
+import static com.dmdirc.util.LogUtils.APP_ERROR;
+import static com.dmdirc.util.LogUtils.FATAL_APP_ERROR;
+import static com.dmdirc.util.LogUtils.FATAL_USER_ERROR;
+import static com.dmdirc.util.LogUtils.USER_ERROR;
+import static com.dmdirc.util.LogUtils.getErrorLevel;
+import static com.dmdirc.util.LogUtils.getThrowable;
+
+/**
+ * Converts log states into {@link ProgramError}s so they can be displayed to the user.
+ */
+public class ProgramErrorAppender extends AppenderBase<ILoggingEvent> {
+
+    private DMDircMBassador eventBus;
+
+    @Override
+    public void start() {
+        if (eventBus == null) {
+            addError("No eventBus set for the appender named ["+ name +"].");
+            return;
+        }
+        super.start();
+    }
+
+    @Override
+    protected void append(final ILoggingEvent eventObject) {
+        if (eventObject.getMarker() == null) {
+            return;
+        }
+        if (eventObject.getMarker() == APP_ERROR) {
+            eventBus.publish(new AppErrorEvent(
+                    getErrorLevel(eventObject.getLevel()),
+                    getThrowable(eventObject), eventObject.getFormattedMessage(), ""));
+        } else if (eventObject.getMarker() == USER_ERROR) {
+            eventBus.publish(new UserErrorEvent(getErrorLevel(eventObject.getLevel()),
+                    getThrowable(eventObject), eventObject.getFormattedMessage(), ""));
+        } else if (eventObject.getMarker() == FATAL_APP_ERROR) {
+            eventBus.publish(new AppErrorEvent(ErrorLevel.FATAL, getThrowable(eventObject),
+                    eventObject.getFormattedMessage(), ""));
+        } else if (eventObject.getMarker() == FATAL_USER_ERROR) {
+            eventBus.publish(new UserErrorEvent(ErrorLevel.FATAL, getThrowable(eventObject),
+                    eventObject.getFormattedMessage(), ""));
+        }
+    }
+
+    public void setEventBus(final DMDircMBassador eventBus) {
+        this.eventBus = eventBus;
+    }
+}

src/com/dmdirc/util/LogUtils.java

@@ -0,0 +1,142 @@
+/*
+ * Copyright (c) 2006-2015 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.util;
+
+import com.dmdirc.logger.ErrorLevel;
+
+import ch.qos.logback.classic.Level;
+import ch.qos.logback.classic.spi.ILoggingEvent;
+import ch.qos.logback.classic.spi.IThrowableProxy;
+import ch.qos.logback.classic.spi.StackTraceElementProxy;
+
+import java.lang.reflect.Constructor;
+
+import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
+
+import org.slf4j.Marker;
+import org.slf4j.MarkerFactory;
+
+/**
+ * Utility methods for logging in the client.
+ */
+public final class LogUtils {
+
+    public static final Marker USER_ERROR = MarkerFactory.getMarker("UserError");
+    public static final Marker APP_ERROR = MarkerFactory.getMarker("AppError");
+    public static final Marker FATAL_USER_ERROR = MarkerFactory.getMarker("FatalUserError");
+    public static final Marker FATAL_APP_ERROR = MarkerFactory.getMarker("FatalAppError");
+
+    private LogUtils() {
+    }
+
+    /**
+     * Converts a SLF4J {@link Level} into a DMDirc {@link ErrorLevel}
+     *
+     * @param level Error to convert
+     *
+     * @return Converted error
+     */
+    @Nonnull
+    public static ErrorLevel getErrorLevel(@Nonnull final Level level) {
+        if (level.equals(Level.ERROR)) {
+            return ErrorLevel.HIGH;
+        } else if (level.equals(Level.WARN)) {
+            return ErrorLevel.MEDIUM;
+        } else if (level.equals(Level.INFO)) {
+            return ErrorLevel.LOW;
+        } else {
+            return ErrorLevel.UNKNOWN;
+        }
+    }
+
+    /**
+     * Converts the {@link IThrowableProxy} from an SLF4J {@link ILoggingEvent} into a
+     * {@link Throwable}.
+     *
+     * @param eventObject Event containing the {@link IThrowableProxy}
+     *
+     * @return {@link Throwable} representation of the {@link IThrowableProxy} or {@code null} if
+     *         there is no {@link IThrowableProxy} present.
+     */
+    @Nullable
+    public static Throwable getThrowable(final ILoggingEvent eventObject) {
+        if (eventObject.getThrowableProxy() == null) {
+            return null;
+        }
+        try {
+            return getThrowable(eventObject.getThrowableProxy());
+        } catch (ReflectiveOperationException ex) {
+            return new IllegalStateException("Error converting exception");
+        }
+    }
+
+    /**
+     * Converts a SLF4J {@link IThrowableProxy} into a {@link Throwable}.
+     *
+     * @param proxy {@link IThrowableProxy} to convert
+     *
+     * @return {@link Throwable} representation of the {@link IThrowableProxy}
+     *
+     * @throws ReflectiveOperationException If an error ocurred creating the real {@link Throwable}
+     */
+    @Nonnull
+    public static Throwable getThrowable(@Nonnull final IThrowableProxy proxy)
+            throws ReflectiveOperationException {
+        final Class<Throwable> clazz = getThrowableClass(proxy.getClassName());
+        final Throwable throwable;
+        if (proxy.getCause() == null) {
+            final Constructor<Throwable> ctor = clazz.getDeclaredConstructor(String.class);
+            throwable = ctor.newInstance(proxy.getMessage());
+        } else {
+            final Constructor<Throwable> ctor = clazz.getDeclaredConstructor(String.class,
+                    Throwable.class);
+            throwable = ctor.newInstance(proxy.getMessage(), getThrowable(proxy.getCause()));
+        }
+        throwable.setStackTrace(getStackTraceElements(proxy.getStackTraceElementProxyArray()));
+        return throwable;
+    }
+
+    /**
+     * Converts an SLF4F {@link StackTraceElementProxy}[] into a {@link StackTraceElement}[].
+     *
+     * @param elements {@link StackTraceElementProxy}s to convert
+     *
+     * @return Non null {@link StackTraceElement}[] of the input
+     */
+    @Nonnull
+    public static StackTraceElement[] getStackTraceElements(
+            final StackTraceElementProxy... elements) {
+        final StackTraceElement[] returnValue = new StackTraceElement[elements.length];
+        for (int i = 0; i < elements.length; i++) {
+            returnValue[i] = elements[i].getStackTraceElement();
+        }
+        return returnValue;
+    }
+
+    @SuppressWarnings("unchecked")
+    private static Class<Throwable> getThrowableClass(final String string)
+            throws ClassNotFoundException {
+        return (Class<Throwable>) Class.forName(string);
+    }
+}