From 290f0151e3b587b5b1f3bbb8161302e884e7eb52 Mon Sep 17 00:00:00 2001
From: Sebastian Sdorra <sebastian.sdorra@cloudogu.com>
Date: Sun, 13 Jul 2014 17:10:45 +0200
Subject: [PATCH] added mdc logging variables username, client_ip and
 client_host

---
 .../main/java/sonia/scm/ScmServletModule.java |   4 +
 .../main/java/sonia/scm/filter/MDCFilter.java | 131 ++++++++++++++++++
 2 files changed, 135 insertions(+)
 create mode 100644 scm-webapp/src/main/java/sonia/scm/filter/MDCFilter.java

diff --git a/scm-webapp/src/main/java/sonia/scm/ScmServletModule.java b/scm-webapp/src/main/java/sonia/scm/ScmServletModule.java
index 0f7fbbf822..1a11d56e6e 100644
--- a/scm-webapp/src/main/java/sonia/scm/ScmServletModule.java
+++ b/scm-webapp/src/main/java/sonia/scm/ScmServletModule.java
@@ -55,6 +55,7 @@ import sonia.scm.event.ScmEventBus;
 import sonia.scm.filter.AdminSecurityFilter;
 import sonia.scm.filter.BaseUrlFilter;
 import sonia.scm.filter.GZipFilter;
+import sonia.scm.filter.MDCFilter;
 import sonia.scm.filter.SecurityFilter;
 import sonia.scm.group.DefaultGroupManager;
 import sonia.scm.group.GroupDAO;
@@ -360,6 +361,9 @@ public class ScmServletModule extends ServletModule
     filter(PATTERN_RESTAPI, PATTERN_DEBUG).through(SecurityFilter.class);
     filter(PATTERN_CONFIG, PATTERN_ADMIN).through(AdminSecurityFilter.class);
 
+    // added mdcs for logging
+    filter(PATTERN_ALL).through(MDCFilter.class);
+
     // debug servlet
     serve(PATTERN_DEBUG).with(DebugServlet.class);
 
diff --git a/scm-webapp/src/main/java/sonia/scm/filter/MDCFilter.java b/scm-webapp/src/main/java/sonia/scm/filter/MDCFilter.java
new file mode 100644
index 0000000000..6630543bc3
--- /dev/null
+++ b/scm-webapp/src/main/java/sonia/scm/filter/MDCFilter.java
@@ -0,0 +1,131 @@
+/**
+ * Copyright (c) 2010, Sebastian Sdorra All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ * this list of conditions and the following disclaimer. 2. Redistributions in
+ * binary form must reproduce the above copyright notice, this list of
+ * conditions and the following disclaimer in the documentation and/or other
+ * materials provided with the distribution. 3. Neither the name of SCM-Manager;
+ * nor the names of its contributors may be used to endorse or promote products
+ * derived from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR
+ * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * http://bitbucket.org/sdorra/scm-manager
+ *
+ */
+
+
+
+package sonia.scm.filter;
+
+//~--- non-JDK imports --------------------------------------------------------
+
+import com.google.inject.Singleton;
+
+import org.apache.shiro.SecurityUtils;
+import org.apache.shiro.subject.Subject;
+
+import org.slf4j.MDC;
+
+import sonia.scm.SCMContext;
+import sonia.scm.web.filter.HttpFilter;
+
+//~--- JDK imports ------------------------------------------------------------
+
+import java.io.IOException;
+
+import javax.servlet.FilterChain;
+import javax.servlet.ServletException;
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+
+/**
+ *
+ * @author Sebastian Sdorra
+ */
+@Singleton
+public class MDCFilter extends HttpFilter
+{
+
+  /** Field description */
+  private static final String MDC_CLIEN_HOST = "client_host";
+
+  /** Field description */
+  private static final String MDC_CLIEN_IP = "client_ip";
+
+  /** Field description */
+  private static final String MDC_USERNAME = "username";
+
+  //~--- methods --------------------------------------------------------------
+
+  /**
+   * Method description
+   *
+   *
+   * @param request
+   * @param response
+   * @param chain
+   *
+   * @throws IOException
+   * @throws ServletException
+   */
+  @Override
+  protected void doFilter(HttpServletRequest request,
+    HttpServletResponse response, FilterChain chain)
+    throws IOException, ServletException
+  {
+    MDC.put(MDC_USERNAME, getUsername());
+    MDC.put(MDC_CLIEN_IP, request.getRemoteAddr());
+    MDC.put(MDC_CLIEN_HOST, request.getRemoteHost());
+
+    try
+    {
+      chain.doFilter(request, response);
+    }
+    finally
+    {
+      MDC.remove(MDC_USERNAME);
+      MDC.remove(MDC_CLIEN_IP);
+      MDC.remove(MDC_CLIEN_HOST);
+    }
+  }
+
+  //~--- get methods ----------------------------------------------------------
+
+  /**
+   * Method description
+   *
+   *
+   * @return
+   */
+  private String getUsername()
+  {
+    Subject subject = SecurityUtils.getSubject();
+    String username;
+    Object principal = subject.getPrincipal();
+
+    if (principal == null)
+    {
+      username = SCMContext.USER_ANONYMOUS;
+    }
+    else
+    {
+      username = principal.toString();
+    }
+
+    return username;
+  }
+}