Add slf4j and logback, configure a simple EclipseLogAppender

Author: adangel

kepler/kepler.target

@@ -19,6 +19,8 @@
             <unit id="org.junit.source" version="4.11.0.v201303080030"/>
             <unit id="org.slf4j.api" version="1.7.2.v20121108-1250"/>
             <unit id="org.slf4j.api.source" version="1.7.2.v20121108-1250"/>
+            <unit id="ch.qos.logback.slf4j" version="1.0.7.v20121108-1250"/>
+            <unit id="ch.qos.logback.slf4j.source" version="1.0.7.v20121108-1250"/>
         </location>
     </locations>
     <targetJRE path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-1.7"/>

net.sourceforge.pmd.eclipse.plugin/META-INF/MANIFEST.MF

@@ -17,7 +17,10 @@ Require-Bundle: org.apache.commons.logging;bundle-version="1.0.4",
  org.eclipse.help,
  org.eclipse.help.ui,
  org.eclipse.wst.xml.core,
- org.eclipse.ui.workbench.texteditor
+ org.eclipse.ui.workbench.texteditor,
+ org.slf4j.api,
+ ch.qos.logback.classic,
+ ch.qos.logback.core
 Bundle-ActivationPolicy: lazy
 Bundle-RequiredExecutionEnvironment: JavaSE-1.7
 Bundle-Vendor: %plugin.provider

net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/logging/internal/EclipseLogAppender.java

@@ -0,0 +1,54 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.eclipse.logging.internal;
+
+import org.eclipse.core.runtime.ILog;
+import org.eclipse.core.runtime.IStatus;
+import org.eclipse.core.runtime.Status;
+
+import ch.qos.logback.classic.Level;
+import ch.qos.logback.classic.spi.ILoggingEvent;
+import ch.qos.logback.core.AppenderBase;
+
+public class EclipseLogAppender extends AppenderBase<ILoggingEvent> {
+    private final ILog eclipseLog;
+    private final String pluginId;
+
+    public EclipseLogAppender(String pluginId, ILog eclipseLog) {
+        this.pluginId = pluginId;
+        this.eclipseLog = eclipseLog;
+    }
+
+    @Override
+    protected void append(ILoggingEvent eventObject) {
+        int statusSeverity = convertLevel(eventObject.getLevel());
+        Throwable throwable = getThrowable(eventObject.getArgumentArray());
+
+        this.eclipseLog.log(new Status(statusSeverity, pluginId, eventObject.getFormattedMessage(), throwable));
+    }
+
+    private Throwable getThrowable(Object[] argumentArray) {
+        if (argumentArray != null && argumentArray.length > 0) {
+            Object last = argumentArray[argumentArray.length - 1];
+            if (last instanceof Throwable) {
+                return (Throwable) last;
+            }
+        }
+        return null;
+    }
+
+    private int convertLevel(Level level) {
+        switch (level.levelInt) {
+        case Level.ERROR_INT:
+            return IStatus.ERROR;
+        case Level.WARN_INT:
+            return IStatus.WARNING;
+        case Level.INFO_INT:
+            return IStatus.INFO;
+        default:
+            return IStatus.OK;
+        }
+    }
+}

net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/plugin/PMDPlugin.java

@@ -56,6 +56,7 @@
 import org.eclipse.ui.plugin.AbstractUIPlugin;
 import org.osgi.framework.Bundle;
 import org.osgi.framework.BundleContext;
+import org.slf4j.LoggerFactory;
 
 import net.sourceforge.pmd.PMDConfiguration;
 import net.sourceforge.pmd.RuleSet;
@@ -64,6 +65,7 @@
 import net.sourceforge.pmd.eclipse.core.IRuleSetManager;
 import net.sourceforge.pmd.eclipse.core.ext.RuleSetsExtensionProcessor;
 import net.sourceforge.pmd.eclipse.core.impl.RuleSetManagerImpl;
+import net.sourceforge.pmd.eclipse.logging.internal.EclipseLogAppender;
 import net.sourceforge.pmd.eclipse.runtime.cmd.JavaProjectClassLoader;
 import net.sourceforge.pmd.eclipse.runtime.preferences.IPreferences;
 import net.sourceforge.pmd.eclipse.runtime.preferences.IPreferencesFactory;
@@ -88,10 +90,13 @@
 import net.sourceforge.pmd.lang.LanguageVersion;
 import net.sourceforge.pmd.lang.java.JavaLanguageModule;
 
+import ch.qos.logback.classic.LoggerContext;
+
 /**
  * The activator class controls the plug-in life cycle
  */
 public class PMDPlugin extends AbstractUIPlugin {
+    private static final org.slf4j.Logger LOGGER = LoggerFactory.getLogger(PMDPlugin.class);
 
     private static File pluginFolder;
 
@@ -124,6 +129,8 @@ public class PMDPlugin extends AbstractUIPlugin {
 
     private final IRuleSetManager ruleSetManager = new RuleSetManagerImpl(); // NOPMD:SingularField
 
+    private EclipseLogAppender logbackEclipseAppender;
+
     /**
      * The constructor
      */
@@ -234,6 +241,7 @@ public static File getPluginFolder() {
      */
     public void start(BundleContext context) throws Exception {
         super.start(context);
+        configureLogback();
 
         // this needs to be executed before the preferences are loaded, because
         // the standard
@@ -259,6 +267,32 @@ public void resourceChanged(IResourceChangeEvent arg0) {
         PriorityFilter.getInstance().initialize();
 
         version = context.getBundle().getHeaders().get("Bundle-Version");
+        LOGGER.debug("PMD Plugin {} has started...", version);
+    }
+
+    private void configureLogback() {
+        unconfigureLogback();
+
+        LoggerContext logbackContext = (LoggerContext) LoggerFactory.getILoggerFactory();
+        logbackEclipseAppender = new EclipseLogAppender(PLUGIN_ID, getLog());
+        logbackEclipseAppender.setContext(logbackContext);
+        logbackEclipseAppender.setName(PLUGIN_ID);
+        logbackEclipseAppender.start();
+
+        ch.qos.logback.classic.Logger l = logbackContext.getLogger("net.sourceforge.pmd");
+        l.addAppender(logbackEclipseAppender);
+    }
+
+    private void unconfigureLogback() {
+        if (logbackEclipseAppender == null) {
+            return;
+        }
+
+        LoggerContext logbackContext = (LoggerContext) LoggerFactory.getILoggerFactory();
+        ch.qos.logback.classic.Logger l = logbackContext.getLogger("net.sourceforge.pmd");
+        l.detachAppender(logbackEclipseAppender);
+        logbackEclipseAppender.stop();
+        logbackEclipseAppender = null;
     }
 
     /**
@@ -380,6 +414,7 @@ public void stop(BundleContext context) throws Exception {
         ShapePainter.disposeAll();
         ResourceManager.dispose();
         PriorityDescriptorCache.INSTANCE.dispose();
+        unconfigureLogback();
         super.stop(context);
     }