added option to encode svn responses with gzip

This commit is contained in:
Sebastian Sdorra
2012-05-13 12:53:09 +02:00
parent 0ce1497cc5
commit 0854f07ced
4 changed files with 180 additions and 1 deletions

View File

@@ -35,6 +35,9 @@ package sonia.scm.repository;
//~--- JDK imports ------------------------------------------------------------
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
/**
@@ -42,6 +45,7 @@ import javax.xml.bind.annotation.XmlRootElement;
* @author Sebastian Sdorra
*/
@XmlRootElement(name = "config")
@XmlAccessorType(XmlAccessType.FIELD)
public class SvnConfig extends SimpleRepositoryConfig
{
@@ -61,6 +65,17 @@ public class SvnConfig extends SimpleRepositoryConfig
return compatibility;
}
/**
* Method description
*
*
* @return
*/
public boolean isEnabledGZip()
{
return enabledGZip;
}
//~--- set methods ----------------------------------------------------------
/**
@@ -74,8 +89,23 @@ public class SvnConfig extends SimpleRepositoryConfig
this.compatibility = compatibility;
}
/**
* Method description
*
*
* @param enabledGZip
*/
public void setEnabledGZip(boolean enabledGZip)
{
this.enabledGZip = enabledGZip;
}
//~--- fields ---------------------------------------------------------------
/** Field description */
@XmlElement(name = "enable-gzip")
private boolean enabledGZip = false;
/** Field description */
private Compatibility compatibility = Compatibility.NONE;
}

View File

@@ -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.web;
//~--- non-JDK imports --------------------------------------------------------
import com.google.inject.Inject;
import com.google.inject.Singleton;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import sonia.scm.filter.GZipFilter;
import sonia.scm.repository.SvnRepositoryHandler;
//~--- JDK imports ------------------------------------------------------------
import java.io.IOException;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
/**
*
* @author Sebastian Sdorra
*/
@Singleton
public class SvnGZipFilter extends GZipFilter
{
/**
* the logger for SvnGZipFilter
*/
private static final Logger logger =
LoggerFactory.getLogger(SvnGZipFilter.class);
//~--- constructors ---------------------------------------------------------
/**
* Constructs ...
*
*
* @param handler
*/
@Inject
public SvnGZipFilter(SvnRepositoryHandler handler)
{
this.handler = handler;
}
//~--- methods --------------------------------------------------------------
/**
* Method description
*
*
* @param filterConfig
*
* @throws ServletException
*/
@Override
public void init(FilterConfig filterConfig) throws ServletException
{
super.init(filterConfig);
getConfig().setBufferRequest(false);
}
/**
* 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
{
if (handler.getConfig().isEnabledGZip())
{
if (logger.isTraceEnabled())
{
logger.trace("encode svn request with gzip");
}
super.doFilter(request, response, chain);
}
else
{
if (logger.isTraceEnabled())
{
logger.trace("skip gzip encoding");
}
chain.doFilter(request, response);
}
}
//~--- fields ---------------------------------------------------------------
/** Field description */
private SvnRepositoryHandler handler;
}

View File

@@ -37,13 +37,13 @@ package sonia.scm.web;
import com.google.inject.servlet.ServletModule;
import sonia.scm.plugin.ext.Extension;
import sonia.scm.web.filter.BasicAuthenticationFilter;
//~--- JDK imports ------------------------------------------------------------
import java.util.HashMap;
import java.util.Map;
import sonia.scm.plugin.ext.Extension;
/**
*
@@ -68,6 +68,7 @@ public class SvnServletModule extends ServletModule
@Override
protected void configureServlets()
{
filter(PATTERN_SVN).through(SvnGZipFilter.class);
filter(PATTERN_SVN).through(BasicAuthenticationFilter.class);
filter(PATTERN_SVN).through(SvnPermissionFilter.class);

View File

@@ -40,12 +40,14 @@ Sonia.svn.ConfigPanel = Ext.extend(Sonia.config.SimpleConfigForm, {
pre14CompatibleText: 'Pre 1.4 Compatible',
pre15CompatibleText: 'Pre 1.5 Compatible',
pre16CompatibleText: 'Pre 1.6 Compatible',
enableGZipText: 'Enable GZip Encoding',
disabledText: 'Disabled',
// helpTexts
repositoryDirectoryHelpText: 'Location of the Suberversion repositories.',
disabledHelpText: 'Enable or disable the Subversion plugin.\n\
Note you have to reload the page, after changing this value.',
enableGZipHelpText: 'Enable GZip encoding for svn responses.',
initComponent: function(){
@@ -79,6 +81,12 @@ Sonia.svn.ConfigPanel = Ext.extend(Sonia.config.SimpleConfigForm, {
inputValue: 'PRE16',
name: 'compatibility'
}]
},{
xtype: 'checkbox',
name: 'enable-gzip',
fieldLabel: this.enableGZipText,
inputValue: 'true',
helpText: this.enableGZipHelpText
},{
xtype: 'checkbox',
name: 'disabled',