merge with branch issue-138

scm-core/src/main/java/sonia/scm/i18n/Bundle.java

@@ -0,0 +1,140 @@
+/**
+ * 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.i18n;
+
+//~--- non-JDK imports --------------------------------------------------------
+
+import sonia.scm.util.Util;
+
+//~--- JDK imports ------------------------------------------------------------
+
+import java.text.MessageFormat;
+
+import java.util.Locale;
+import java.util.ResourceBundle;
+
+/**
+ * This class is a wrapper for {@link ResourceBundle}, it applies some missing
+ * format options missing in {@link ResourceBundle}.
+ *
+ * @author Sebastian Sdorra
+ * @since 1.15
+ */
+public class Bundle
+{
+
+  /** Field description */
+  private static final String SEPARATOR = System.getProperty("line.separator");
+
+  //~--- constructors ---------------------------------------------------------
+
+  /**
+   * Constructs ...
+   *
+   *
+   * @param bundle
+   */
+  private Bundle(ResourceBundle bundle)
+  {
+    this.bundle = bundle;
+  }
+
+  //~--- get methods ----------------------------------------------------------
+
+  /**
+   * Creates a new bundle instance
+   *
+   *
+   * @param path path to the properties file
+   *
+   * @return new bundle instance
+   */
+  public static Bundle getBundle(String path)
+  {
+    return new Bundle(ResourceBundle.getBundle(path));
+  }
+
+  /**
+   * Creates a new bundle instance
+   *
+   *
+   * @param path path to the properties file
+   * @param locale locale for the properties file
+   *
+   * @return new bundle instance
+   */
+  public static Bundle getBundle(String path, Locale locale)
+  {
+    return new Bundle(ResourceBundle.getBundle(path, locale));
+  }
+
+  /**
+   * This method returns the same value as
+   * {@link #getString(java.lang.String, java.lang.Object[])}
+   * with a line separator at the end.
+   *
+   * @param key key in the properties file
+   * @param args format arguments
+   *
+   * @return formated message
+   */
+  public String getLine(String key, Object... args)
+  {
+    return getString(key, args).concat(SEPARATOR);
+  }
+
+  /**
+   * Returns the value of the key, formatted with {@link MessageFormat}
+   *
+   *
+   * @param key key in the properties file
+   * @param args format arguments
+   *
+   * @return formated message
+   */
+  public String getString(String key, Object... args)
+  {
+    String msg = bundle.getString(key);
+
+    if (Util.isNotEmpty(args))
+    {
+      msg = MessageFormat.format(msg, args);
+    }
+
+    return msg;
+  }
+
+  //~--- fields ---------------------------------------------------------------
+
+  /** Field description */
+  private ResourceBundle bundle;
+}

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

@@ -68,6 +68,19 @@ public abstract class AbstractCGIExecutor implements CGIExecutor
     return environment;
   }
 
+  /**
+   * {@inheritDoc}
+   *
+   *
+   * @return
+   * @since 1.15
+   */
+  @Override
+  public CGIExceptionHandler getExceptionHandler()
+  {
+    return exceptionHandler;
+  }
+
   /**
    * Method description
    *
@@ -80,6 +93,19 @@ public abstract class AbstractCGIExecutor implements CGIExecutor
     return interpreter;
   }
 
+  /**
+   * {@inheritDoc}
+   *
+   *
+   * @return
+   * @since 1.15
+   */
+  @Override
+  public CGIStatusCodeHandler getStatusCodeHandler()
+  {
+    return statusCodeHandler;
+  }
+
   /**
    * Method description
    *
@@ -142,6 +168,19 @@ public abstract class AbstractCGIExecutor implements CGIExecutor
     this.environment = environment;
   }
 
+  /**
+   * {@inheritDoc}
+   *
+   *
+   * @param exceptionHandler
+   * @since 1.15
+   */
+  @Override
+  public void setExceptionHandler(CGIExceptionHandler exceptionHandler)
+  {
+    this.exceptionHandler = exceptionHandler;
+  }
+
   /**
    * Method description
    *
@@ -178,6 +217,19 @@ public abstract class AbstractCGIExecutor implements CGIExecutor
     this.passShellEnvironment = passShellEnvironment;
   }
 
+  /**
+   * {@inheritDoc}
+   *
+   *
+   * @param statusCodeHandler
+   * @since 1.15
+   */
+  @Override
+  public void setStatusCodeHandler(CGIStatusCodeHandler statusCodeHandler)
+  {
+    this.statusCodeHandler = statusCodeHandler;
+  }
+
   /**
    * Method description
    *
@@ -198,6 +250,9 @@ public abstract class AbstractCGIExecutor implements CGIExecutor
   /** Field description */
   protected EnvList environment;
 
+  /** Field description */
+  protected CGIExceptionHandler exceptionHandler;
+
   /** Field description */
   protected boolean ignoreExitCode = false;
 
@@ -207,6 +262,9 @@ public abstract class AbstractCGIExecutor implements CGIExecutor
   /** Field description */
   protected boolean passShellEnvironment = false;
 
+  /** Field description */
+  protected CGIStatusCodeHandler statusCodeHandler;
+
   /** Field description */
   protected File workDirectory;
 }

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

@@ -176,6 +176,15 @@ public interface CGIExecutor
    */
   public String getInterpreter();
 
+  /**
+   * Returns the status code handler.
+   *
+   *
+   * @return status code handler
+   * @since 1.15
+   */
+  public CGIStatusCodeHandler getStatusCodeHandler();
+
   /**
    * Method description
    *
@@ -268,6 +277,15 @@ public interface CGIExecutor
    */
   public void setPassShellEnvironment(boolean passShellEnvironment);
 
+  /**
+   * Sets the status code handler.
+   *
+   *
+   * @param statusCodeHandler the handler to set
+   * @since 1.15
+   */
+  public void setStatusCodeHandler(CGIStatusCodeHandler statusCodeHandler);
+
   /**
    * Method description
    *

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

@@ -0,0 +1,82 @@
+/**
+ * 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 java.io.IOException;
+import java.io.OutputStream;
+
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+
+/**
+ * Interface for handling return codes of processes
+ * executed by the {@link CGIExecutor}.
+ *
+ * @author Sebastian Sdorra
+ * @since 1.15
+ */
+public interface CGIStatusCodeHandler
+{
+
+  /**
+   * Handles the return code of the process executed by {@link CGIExecutor}.
+   * <b>Note:</b> This method is called when the process has
+   * already written to the {@link OutputStream}.
+   *
+   *
+   * @param request the http request
+   * @param statusCode process return code
+   */
+  public void handleStatusCode(HttpServletRequest request, int statusCode);
+
+  /**
+   * Handles the return code of the process executed by {@link CGIExecutor}.
+   * <b>Note:</b> This method is only called when the process has
+   * not written to the {@link OutputStream}. Do not call
+   * {@link HttpServletResponse#getWriter()}, because there was already a call
+   * to {@link HttpServletResponse#getOutputStream()}.
+   *
+   *
+   * @param request the http request
+   * @param response the http response
+   * @param ouputStream the servlet output stream
+   * @param statusCode process return code
+   *
+   * @throws IOException
+   */
+  public void handleStatusCode(HttpServletRequest request,
+                               HttpServletResponse response,
+                               OutputStream ouputStream, int statusCode)
+          throws IOException;
+}