added exception handler to cgi implementation

scm-core/src/main/java/sonia/scm/web/cgi/CGIExceptionHandler.java

@@ -0,0 +1,61 @@
+/**
+ * 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.web.cgi;
+
+//~--- JDK imports ------------------------------------------------------------
+
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+
+/**
+ * Handles exception thrown by an {@link CGIExecutor}
+ *
+ * @author Sebastian Sdorra
+ * @since 1.8
+ */
+public interface CGIExceptionHandler
+{
+
+  /**
+   * Handles a exception which is ocurred during cgi execution.
+   *
+   *
+   * @param request current http request
+   * @param response current http response
+   * @param exception exception to handle
+   */
+  public void handleException(HttpServletRequest request,
+                              HttpServletResponse response,
+                              Throwable exception);
+}

scm-core/src/main/java/sonia/scm/web/cgi/CGIExecutor.java

@@ -159,6 +159,15 @@ public interface CGIExecutor
    */
   public EnvList getEnvironment();
 
+  /**
+   * Returns the cgi exception handler.
+   *
+   *
+   * @return cgi exception handler
+   * @since 1.8
+   */
+  public CGIExceptionHandler getExceptionHandler();
+
   /**
    * Method description
    *
@@ -209,6 +218,15 @@ public interface CGIExecutor
    */
   public void setEnvironment(EnvList environment);
 
+  /**
+   * Sets the cgi exception handler.
+   *
+   *
+   * @param exceptionHandler cgi exception handler
+   * @since 1.8
+   */
+  public void setExceptionHandler(CGIExceptionHandler exceptionHandler);
+
   /**
    * Method description
    *

scm-webapp/src/main/java/sonia/scm/web/cgi/DefaultCGIExceptionHandler.java

@@ -0,0 +1,96 @@
+/**
+ * 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.web.cgi;
+
+//~--- non-JDK imports --------------------------------------------------------
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import sonia.scm.security.ScmSecurityException;
+
+//~--- JDK imports ------------------------------------------------------------
+
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+
+/**
+ *
+ * @author Sebastian Sdorra
+ */
+public class DefaultCGIExceptionHandler implements CGIExceptionHandler
+{
+
+  /** the logger for DefaultCGIExceptionHandler */
+  private static final Logger logger =
+    LoggerFactory.getLogger(DefaultCGIExceptionHandler.class);
+
+  //~--- methods --------------------------------------------------------------
+
+  /**
+   * Method description
+   *
+   *
+   * @param request
+   * @param response
+   * @param exception
+   */
+  @Override
+  public void handleException(HttpServletRequest request,
+                              HttpServletResponse response, Throwable exception)
+  {
+    try
+    {
+      if (logger.isErrorEnabled())
+      {
+        logger.error("exception during cgi execution", exception);
+      }
+
+      if (exception instanceof ScmSecurityException)
+      {
+        response.sendError(HttpServletResponse.SC_FORBIDDEN,
+                           exception.getMessage());
+      }
+      else
+      {
+        response.sendError(HttpServletResponse.SC_INTERNAL_SERVER_ERROR,
+                           exception.getMessage());
+      }
+    }
+    catch (Exception ex)
+    {
+      logger.error("could not handle exception", ex);
+    }
+  }
+}

scm-webapp/src/main/java/sonia/scm/web/cgi/DefaultCGIExecutor.java

@@ -47,11 +47,9 @@ import sonia.scm.util.Util;
 
 //~--- JDK imports ------------------------------------------------------------
 
-import java.io.BufferedReader;
 import java.io.File;
 import java.io.IOException;
 import java.io.InputStream;
-import java.io.InputStreamReader;
 import java.io.OutputStream;
 
 import java.util.Enumeration;
@@ -174,6 +172,10 @@ public class DefaultCGIExecutor extends AbstractCGIExecutor
                                     workDirectory);
       execute(p);
     }
+    catch (Throwable ex)
+    {
+      getExceptionHandler().handleException(request, response, ex);
+    }
     finally
     {
       if (p != null)
@@ -183,6 +185,41 @@ public class DefaultCGIExecutor extends AbstractCGIExecutor
     }
   }
 
+  //~--- get methods ----------------------------------------------------------
+
+  /**
+   * Method description
+   *
+   *
+   * @return
+   */
+  @Override
+  public CGIExceptionHandler getExceptionHandler()
+  {
+    if (exceptionHandler == null)
+    {
+      exceptionHandler = new DefaultCGIExceptionHandler();
+    }
+
+    return exceptionHandler;
+  }
+
+  //~--- set methods ----------------------------------------------------------
+
+  /**
+   * Method description
+   *
+   *
+   * @param exceptionHandler
+   */
+  @Override
+  public void setExceptionHandler(CGIExceptionHandler exceptionHandler)
+  {
+    this.exceptionHandler = exceptionHandler;
+  }
+
+  //~--- methods --------------------------------------------------------------
+
   /**
    * Method description
    *
@@ -544,6 +581,9 @@ public class DefaultCGIExecutor extends AbstractCGIExecutor
   /** Field description */
   private ServletContext context;
 
+  /** Field description */
+  private CGIExceptionHandler exceptionHandler;
+
   /** Field description */
   private HttpServletRequest request;