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

added api to disabled proxy setting for specified hosts

Browse Source
This commit is contained in:
Sebastian Sdorra
2012-12-09 14:54:45 +01:00
parent 0b9d4908f4
commit 5de4ee9fc0
3 changed files with 297 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
scm-core/src/main/java/sonia/scm/config/ScmConfiguration.java
View File

@@ -35,6 +35,7 @@ package sonia.scm.config;
//~--- non-JDK imports --------------------------------------------------------
import com.google.common.collect.Sets;
import com.google.inject.Singleton;
import org.slf4j.Logger;
@@ -69,7 +70,7 @@ import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
@XmlRootElement(name = "scm-config")
@XmlAccessorType(XmlAccessType.FIELD)
public class ScmConfiguration
implements ListenerSupport<ConfigChangedListener<ScmConfiguration>>
implements ListenerSupport<ConfigChangedListener<ScmConfiguration>>
{
/** Default JavaScript date format */
@@ -115,7 +116,7 @@ public class ScmConfiguration
*/
@Override
public void addListeners(
Collection<ConfigChangedListener<ScmConfiguration>> listeners)
Collection<ConfigChangedListener<ScmConfiguration>> listeners)
{
listeners.addAll(listeners);
}
@@ -265,6 +266,24 @@ public class ScmConfiguration
return pluginUrl;
}
/**
* Returns a set of glob patterns for urls which should excluded from
* proxy settings.
*
*
* @return set of glob patterns
* @since 1.23
*/
public Set<String> getProxyExcludes()
{
if (proxyExcludes == null)
{
proxyExcludes = Sets.newHashSet();
}
return proxyExcludes;
}
/**
* Method description
*
@@ -573,6 +592,19 @@ public class ScmConfiguration
this.pluginUrl = pluginUrl;
}
/**
* Set glob patterns for urls which are should be excluded from proxy
* settings.
*
*
* @param proxyExcludes glob patterns
* @since 1.23
*/
public void setProxyExcludes(Set<String> proxyExcludes)
{
this.proxyExcludes = proxyExcludes;
}
/**
* Method description
*
@@ -675,6 +707,11 @@ public class ScmConfiguration
@XmlElement(name = "plugin-url")
private String pluginUrl = DEFAULT_PLUGINURL;
/** glob patterns for urls which are excluded from proxy */
@XmlElement(name = "admin-groups")
@XmlJavaTypeAdapter(XmlSetStringAdapter.class)
private Set<String> proxyExcludes;
/** Field description */
private String proxyPassword;

127
scm-core/src/main/java/sonia/scm/net/Proxies.java Normal file
View File

@@ -0,0 +1,127 @@
/**
* 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.net;
//~--- non-JDK imports --------------------------------------------------------
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import sonia.scm.config.ScmConfiguration;
import sonia.scm.util.GlobUtil;
//~--- JDK imports ------------------------------------------------------------
import java.net.URL;
/**
* Util class for proxy settings.
*
* @author Sebastian Sdorra
* @since 1.23
*/
public class Proxies
{
/**
* the logger for Proxies
*/
private static final Logger logger = LoggerFactory.getLogger(Proxies.class);
//~--- get methods ----------------------------------------------------------
/**
* Returns true if proxy settings should be used to access the given url.
*
*
* @param configuration scm-manager main configuration
* @param url url to check
*
* @return true if proxy settings should be used
*/
public static boolean isEnabled(ScmConfiguration configuration, String url)
{
boolean result = false;
if (configuration.isEnableProxy())
{
result = true;
int index = url.indexOf("://");
if (index > 0)
{
url = url.substring(index + 3);
}
index = url.indexOf("/");
if (index > 0)
{
url = url.substring(0, index);
}
for (String exclude : configuration.getProxyExcludes())
{
if (GlobUtil.matches(exclude, url))
{
logger.debug(
"disable proxy settings for url {}, because exclude {} matches",
url, exclude);
result = false;
break;
}
}
}
else
{
logger.trace("proxy settings are disabled");
}
return result;
}
/**
* Returns true if proxy settings should be used to access the given url.
*
*
* @param configuration scm-manager main configuration
* @param url url to check
*
* @return true if proxy settings should be used
*/
public static boolean isEnabled(ScmConfiguration configuration, URL url)
{
return isEnabled(configuration, url.getHost());
}
}

131
scm-core/src/test/java/sonia/scm/net/ProxiesTest.java Normal file
View File

@@ -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.net;
//~--- non-JDK imports --------------------------------------------------------
import com.google.common.collect.Sets;
import org.junit.Test;
import sonia.scm.config.ScmConfiguration;
import static org.junit.Assert.*;
/**
*
* @author Sebastian Sdorra
*/
public class ProxiesTest
{
/**
* Method description
*
*/
@Test
public void testDisabledWithoutExcludes()
{
ScmConfiguration config = createConfiguration(false);
assertFalse(Proxies.isEnabled(config, "localhost"));
assertFalse(Proxies.isEnabled(config, "download.scm-manager.org"));
assertFalse(Proxies.isEnabled(config, "http://127.0.0.1"));
assertFalse(Proxies.isEnabled(config, "http://127.0.0.1/test/ka"));
}
/**
* Method description
*
*/
@Test
public void testEnabledWithoutExcludes()
{
ScmConfiguration config = createConfiguration(true);
assertTrue(Proxies.isEnabled(config, "localhost"));
assertTrue(Proxies.isEnabled(config, "download.scm-manager.org"));
assertTrue(Proxies.isEnabled(config, "http://127.0.0.1"));
assertTrue(Proxies.isEnabled(config, "http://127.0.0.1/test/ka"));
}
/**
* Method description
*
*/
@Test
public void testWithExcludes()
{
ScmConfiguration config = createConfiguration(true, "127.0.0.1",
"localhost");
assertFalse(Proxies.isEnabled(config, "localhost"));
assertTrue(Proxies.isEnabled(config, "download.scm-manager.org"));
assertFalse(Proxies.isEnabled(config, "http://127.0.0.1"));
assertFalse(Proxies.isEnabled(config, "http://127.0.0.1/test/ka"));
}
/**
* Method description
*
*/
@Test
public void testWithGlobExcludes()
{
ScmConfiguration config = createConfiguration(true, "127.*", "*host");
assertFalse(Proxies.isEnabled(config, "localhost"));
assertTrue(Proxies.isEnabled(config, "download.scm-manager.org"));
assertFalse(Proxies.isEnabled(config, "http://127.0.0.1"));
assertFalse(Proxies.isEnabled(config, "http://127.0.0.1/test/ka"));
}
/**
* Method description
*
*
* @param enabled
* @param excludes
*
* @return
*/
private ScmConfiguration createConfiguration(boolean enabled,
String... excludes)
{
ScmConfiguration configuration = new ScmConfiguration();
configuration.setEnableProxy(enabled);
configuration.setProxyExcludes(Sets.newHashSet(excludes));
return configuration;
}
}