Nemcio/SCM-Manager
1
0
Fork 0
mirror of https://github.com/scm-manager/scm-manager.git synced 2025-11-11 16:05:44 +01:00
Code Issues Packages Projects Releases Activity

rebuild cgi stack

Browse Source
This commit is contained in:
Sebastian Sdorra
2011-04-14 18:43:13 +02:00
parent 48c779aa1c
commit 46d522b864
11 changed files with 1074 additions and 50 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
scm-webapp/src/main/java/sonia/scm/ScmServletModule.java
View File

@@ -70,6 +70,8 @@ import sonia.scm.template.TemplateServlet;
import sonia.scm.user.UserManager;
import sonia.scm.user.xml.XmlUserManager;
import sonia.scm.util.DebugServlet;
import sonia.scm.web.cgi.CGIExecutorFactory;
import sonia.scm.web.cgi.DefaultCGIExecutorFactory;
import sonia.scm.web.security.AuthenticationManager;
import sonia.scm.web.security.BasicSecurityContext;
import sonia.scm.web.security.ChainAuthenticatonManager;
@@ -215,8 +217,9 @@ public class ScmServletModule extends ServletModule
bind(RepositoryManager.class).to(XmlRepositoryManager.class);
bind(UserManager.class).to(XmlUserManager.class);
bind(GroupManager.class).to(XmlGroupManager.class);
bind(CGIExecutorFactory.class).to(DefaultCGIExecutorFactory.class);
// filter(PATTERN_RESTAPI).through(LoggingFilter.class);
// filter("/hg/*").through(LoggingFilter.class);
/*
* filter(PATTERN_PAGE,

487
scm-webapp/src/main/java/sonia/scm/web/cgi/DefaultCGIExecutor.java Normal file
View File

@@ -0,0 +1,487 @@
/**
* 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.SCMContext;
import sonia.scm.config.ScmConfiguration;
import sonia.scm.util.HttpUtil;
import sonia.scm.util.IOUtil;
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;
import javax.servlet.ServletContext;
import javax.servlet.ServletInputStream;
import javax.servlet.ServletOutputStream;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
/**
*
* @author Sebastian Sdorra
*/
public class DefaultCGIExecutor extends AbstractCGIExecutor
{
/** Field description */
public static final String CGI_VERSION = "CGI/1.1";
/** Field description */
public static final int DEFAULT_BUFFER_SIZE = 16264;
/** Field description */
private static final String SERVER_SOFTWARE_PREFIX = "scm-manager/";
/** the logger for DefaultCGIExecutor */
private static final Logger logger =
LoggerFactory.getLogger(DefaultCGIExecutor.class);
//~--- constructors ---------------------------------------------------------
/**
* Constructs ...
*
*
* @param configuration
* @param context
* @param request
* @param response
*/
public DefaultCGIExecutor(ScmConfiguration configuration,
ServletContext context, HttpServletRequest request,
HttpServletResponse response)
{
this.configuration = configuration;
this.context = context;
this.request = request;
this.response = response;
// set default values
this.bufferSize = DEFAULT_BUFFER_SIZE;
this.environment = createEnvironment();
}
//~--- methods --------------------------------------------------------------
/**
* Method description
*
*
*
*
* @param cmd
*
* @throws IOException
*/
@Override
public void execute(String cmd) throws IOException
{
File command = new File(cmd);
EnvList env = new EnvList(environment);
if (workDirectory == null)
{
workDirectory = command.getParentFile();
}
String path = command.getAbsolutePath();
String pathTranslated = request.getPathTranslated();
if (Util.isEmpty(pathTranslated))
{
pathTranslated = path;
}
env.set(ENV_PATH_TRANSLATED, pathTranslated);
String execCmd = path;
if ((execCmd.charAt(0) != '"') && (execCmd.indexOf(" ") >= 0))
{
execCmd = "\"" + execCmd + "\"";
}
if (interpreter != null)
{
execCmd = interpreter + " " + execCmd;
}
if (logger.isDebugEnabled())
{
logger.debug("execute cgi: {}", execCmd);
if (logger.isTraceEnabled())
{
logger.trace(environment.toString());
}
}
Process p = Runtime.getRuntime().exec(execCmd, environment.getEnvArray(),
workDirectory);
execute(p);
}
/**
* Method description
*
*
* @return
*/
private EnvList createEnvironment()
{
String pathInfo = request.getPathInfo();
int serverPort = HttpUtil.getServerPort(configuration, request);
String scriptName = request.getRequestURI().substring(0,
request.getRequestURI().length() - pathInfo.length());
String scriptPath = context.getRealPath(scriptName);
int len = request.getContentLength();
if (len < 0)
{
len = 0;
}
EnvList env = new EnvList();
env.set(ENV_AUTH_TYPE, request.getAuthType());
env.set(ENV_CONTENT_LENGTH, Integer.toString(len));
env.set(ENV_CONTENT_TYPE, request.getContentType());
env.set(ENV_GATEWAY_INTERFACE, CGI_VERSION);
env.set(ENV_PATH_INFO, pathInfo);
env.set(ENV_QUERY_STRING, request.getQueryString());
env.set(ENV_REMOTE_ADDR, request.getRemoteAddr());
env.set(ENV_REMOTE_HOST, request.getRemoteHost());
// The identity information reported about the connection by a
// RFC 1413 [11] request to the remote agent, if
// available. Servers MAY choose not to support this feature, or
// not to request the data for efficiency reasons.
// "REMOTE_IDENT" => "NYI"
env.set(ENV_REMOTE_USER, request.getRemoteUser());
env.set(ENV_REQUEST_METHOD, request.getMethod());
env.set(ENV_SCRIPT_NAME, scriptName);
env.set(ENV_SCRIPT_FILENAME, scriptPath);
env.set(ENV_SERVER_NAME, request.getServerName());
env.set(ENV_SERVER_PORT, Integer.toString(serverPort));
env.set(ENV_SERVER_PROTOCOL, request.getProtocol());
env.set(
ENV_SERVER_SOFTWARE,
SERVER_SOFTWARE_PREFIX.concat(SCMContext.getContext().getVersion()));
Enumeration enm = request.getHeaderNames();
while (enm.hasMoreElements())
{
String name = (String) enm.nextElement();
String value = request.getHeader(name);
env.set(ENV_HTTP_HEADER_PREFIX + name.toUpperCase().replace('-', '_'),
value);
}
// these extra ones were from printenv on www.dev.nomura.co.uk
env.set(ENV_HTTPS, (request.isSecure()
? ENV_HTTPS_VALUE_ON
: ENV_HTTPS_VALUE_OFF));
return env;
}
/**
* Method description
*
*
* @param process
*
* @throws IOException
*/
private void execute(Process process) throws IOException
{
InputStream processIS = null;
InputStream processES = null;
try
{
processIS = process.getInputStream();
processES = process.getErrorStream();
processServletInput(process);
processProcessInputStream(processIS);
processErrorStream(processES);
waitForFinish(process);
}
finally
{
IOUtil.close(processIS);
IOUtil.close(processES);
}
}
/**
* Method description
*
*
* @param is
*
*
* @throws IOException
*/
private void parseHeaders(InputStream is) throws IOException
{
String line = null;
while ((line = getTextLineFromStream(is)).length() > 0)
{
if (logger.isTraceEnabled())
{
logger.trace(" ".concat(line));
}
if (!line.startsWith(RESPONSE_HEADER_HTTP_PREFIX))
{
int k = line.indexOf(':');
if (k > 0)
{
String key = line.substring(0, k).trim();
String value = line.substring(k + 1).trim();
if (RESPONSE_HEADER_LOCATION.equals(key))
{
response.sendRedirect(response.encodeRedirectURL(value));
}
else if (RESPONSE_HEADER_STATUS.equals(key))
{
String[] token = value.split(" ");
int status = Integer.parseInt(token[0]);
if (logger.isDebugEnabled())
{
logger.debug("CGI returned with status {}", status);
}
if (status < 304)
{
response.setStatus(status);
}
else
{
response.sendError(status);
}
}
else
{
// add remaining header items to our response header
response.addHeader(key, value);
}
}
}
}
}
/**
* Method description
*
*
* @param in
*
* @throws IOException
*/
private void processErrorStream(InputStream in) throws IOException
{
BufferedReader reader = null;
try
{
reader = new BufferedReader(new InputStreamReader(in));
StringBuilder error = new StringBuilder();
String s = System.getProperty("line.separator");
String line = reader.readLine();
while (line != null)
{
error.append(line);
line = reader.readLine();
if (line != null)
{
error.append(s);
}
}
if (logger.isWarnEnabled())
{
logger.warn(error.toString());
}
}
finally
{
IOUtil.close(reader);
}
}
/**
* Method description
*
*
* @param is
*
* @throws IOException
*/
private void processProcessInputStream(InputStream is) throws IOException
{
parseHeaders(is);
ServletOutputStream servletOS = null;
try
{
servletOS = response.getOutputStream();
IOUtil.copy(is, servletOS, bufferSize);
}
finally
{
IOUtil.close(servletOS);
}
}
/**
* Method description
*
*
* @param process
*/
private void processServletInput(Process process)
{
OutputStream processOS = null;
ServletInputStream servletIS = null;
try
{
processOS = process.getOutputStream();
servletIS = request.getInputStream();
IOUtil.copy(servletIS, processOS, bufferSize);
}
catch (IOException ex)
{
logger.error(
"could not read from ServletInputStream and write to ProcessOutputStream",
ex);
}
finally
{
IOUtil.close(processOS);
IOUtil.close(servletIS);
}
}
/**
* Method description
*
*
* @param process
*
*/
private void waitForFinish(Process process)
{
try
{
int exitCode = process.waitFor();
if (exitCode != 0)
{
logger.warn("process ends with exit code {}", exitCode);
}
}
catch (InterruptedException ex)
{
logger.error("process interrupted", ex);
}
}
//~--- get methods ----------------------------------------------------------
/**
* Method description
*
*
* @param is
*
* @return
*
* @throws IOException
*/
private String getTextLineFromStream(InputStream is) throws IOException
{
StringBuilder buffer = new StringBuilder();
int b;
while ((b = is.read()) != -1 && (b != (int) '\n'))
{
buffer.append((char) b);
}
return buffer.toString().trim();
}
//~--- fields ---------------------------------------------------------------
/** Field description */
private ScmConfiguration configuration;
/** Field description */
private ServletContext context;
/** Field description */
private HttpServletRequest request;
/** Field description */
private HttpServletResponse response;
}

72
scm-webapp/src/main/java/sonia/scm/web/cgi/DefaultCGIExecutorFactory.java Normal file
View File

@@ -0,0 +1,72 @@
/**
* 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 sonia.scm.config.ScmConfiguration;
//~--- JDK imports ------------------------------------------------------------
import javax.servlet.ServletContext;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
/**
*
* @author Sebastian Sdorra
*/
public class DefaultCGIExecutorFactory implements CGIExecutorFactory
{
/**
* Method description
*
*
* @param configuration
* @param context
* @param request
* @param response
*
* @return
*/
@Override
public CGIExecutor createExecutor(ScmConfiguration configuration,
ServletContext context,
HttpServletRequest request,
HttpServletResponse response)
{
return new DefaultCGIExecutor(configuration, context, request, response);
}
}