mirror of
https://github.com/scm-manager/scm-manager.git
synced 2025-11-13 08:55:44 +01:00
481 lines
16 KiB
Java
481 lines
16 KiB
Java
/**
|
|
* 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;
|
|
|
|
//~--- non-JDK imports --------------------------------------------------------
|
|
|
|
import com.google.common.collect.Maps;
|
|
import com.google.inject.Provider;
|
|
import com.google.inject.multibindings.Multibinder;
|
|
import com.google.inject.name.Names;
|
|
import com.google.inject.servlet.RequestScoped;
|
|
import com.google.inject.throwingproviders.ThrowingProviderBinder;
|
|
|
|
import org.slf4j.Logger;
|
|
import org.slf4j.LoggerFactory;
|
|
|
|
import sonia.scm.api.rest.UriExtensionsConfig;
|
|
import sonia.scm.cache.CacheManager;
|
|
import sonia.scm.cache.GuavaCacheManager;
|
|
import sonia.scm.config.ScmConfiguration;
|
|
import sonia.scm.event.ScmEventBus;
|
|
import sonia.scm.group.DefaultGroupManager;
|
|
import sonia.scm.group.GroupDAO;
|
|
import sonia.scm.group.GroupManager;
|
|
import sonia.scm.group.GroupManagerProvider;
|
|
import sonia.scm.group.xml.XmlGroupDAO;
|
|
import sonia.scm.io.DefaultFileSystem;
|
|
import sonia.scm.io.FileSystem;
|
|
import sonia.scm.net.HttpClient;
|
|
import sonia.scm.net.URLHttpClient;
|
|
import sonia.scm.plugin.DefaultPluginLoader;
|
|
import sonia.scm.plugin.DefaultPluginManager;
|
|
import sonia.scm.plugin.PluginLoader;
|
|
import sonia.scm.plugin.PluginManager;
|
|
import sonia.scm.repository.DefaultRepositoryManager;
|
|
import sonia.scm.repository.DefaultRepositoryProvider;
|
|
import sonia.scm.repository.HealthCheckContextListener;
|
|
import sonia.scm.repository.Repository;
|
|
import sonia.scm.repository.RepositoryDAO;
|
|
import sonia.scm.repository.RepositoryManager;
|
|
import sonia.scm.repository.RepositoryManagerProvider;
|
|
import sonia.scm.repository.RepositoryProvider;
|
|
import sonia.scm.repository.api.HookContextFactory;
|
|
import sonia.scm.repository.api.RepositoryServiceFactory;
|
|
import sonia.scm.repository.spi.HookEventFacade;
|
|
import sonia.scm.repository.xml.XmlRepositoryDAO;
|
|
import sonia.scm.resources.DefaultResourceManager;
|
|
import sonia.scm.resources.DevelopmentResourceManager;
|
|
import sonia.scm.resources.ResourceManager;
|
|
import sonia.scm.resources.ScriptResourceServlet;
|
|
import sonia.scm.security.CipherHandler;
|
|
import sonia.scm.security.CipherUtil;
|
|
import sonia.scm.security.DefaultKeyGenerator;
|
|
import sonia.scm.security.DefaultSecuritySystem;
|
|
import sonia.scm.security.KeyGenerator;
|
|
import sonia.scm.security.SecuritySystem;
|
|
import sonia.scm.store.BlobStoreFactory;
|
|
import sonia.scm.store.ConfigurationEntryStoreFactory;
|
|
import sonia.scm.store.DataStoreFactory;
|
|
import sonia.scm.store.FileBlobStoreFactory;
|
|
import sonia.scm.store.JAXBConfigurationEntryStoreFactory;
|
|
import sonia.scm.store.JAXBDataStoreFactory;
|
|
import sonia.scm.store.JAXBStoreFactory;
|
|
import sonia.scm.store.StoreFactory;
|
|
import sonia.scm.template.MustacheTemplateEngine;
|
|
import sonia.scm.template.TemplateEngine;
|
|
import sonia.scm.template.TemplateEngineFactory;
|
|
import sonia.scm.template.TemplateServlet;
|
|
import sonia.scm.url.RestJsonUrlProvider;
|
|
import sonia.scm.url.RestXmlUrlProvider;
|
|
import sonia.scm.url.UrlProvider;
|
|
import sonia.scm.url.UrlProviderFactory;
|
|
import sonia.scm.url.WebUIUrlProvider;
|
|
import sonia.scm.user.DefaultUserManager;
|
|
import sonia.scm.user.UserDAO;
|
|
import sonia.scm.user.UserManager;
|
|
import sonia.scm.user.UserManagerProvider;
|
|
import sonia.scm.user.xml.XmlUserDAO;
|
|
import sonia.scm.util.DebugServlet;
|
|
import sonia.scm.util.ScmConfigurationUtil;
|
|
import sonia.scm.web.cgi.CGIExecutorFactory;
|
|
import sonia.scm.web.cgi.DefaultCGIExecutorFactory;
|
|
import sonia.scm.web.filter.LoggingFilter;
|
|
import sonia.scm.web.security.AdministrationContext;
|
|
import sonia.scm.web.security.DefaultAdministrationContext;
|
|
|
|
//~--- JDK imports ------------------------------------------------------------
|
|
|
|
import com.sun.jersey.api.core.PackagesResourceConfig;
|
|
import com.sun.jersey.api.core.ResourceConfig;
|
|
import com.sun.jersey.api.json.JSONConfiguration;
|
|
import com.sun.jersey.guice.JerseyServletModule;
|
|
import com.sun.jersey.guice.spi.container.servlet.GuiceContainer;
|
|
import com.sun.jersey.spi.container.servlet.ServletContainer;
|
|
|
|
import java.util.Map;
|
|
|
|
import javax.servlet.ServletContext;
|
|
|
|
/**
|
|
*
|
|
* @author Sebastian Sdorra
|
|
*/
|
|
public class ScmServletModule extends JerseyServletModule
|
|
{
|
|
|
|
/** Field description */
|
|
public static final String[] PATTERN_ADMIN = new String[] {
|
|
"/api/rest/groups*",
|
|
"/api/rest/users*", "/api/rest/plguins*" };
|
|
|
|
/** Field description */
|
|
public static final String PATTERN_ALL = "/*";
|
|
|
|
/** Field description */
|
|
public static final String PATTERN_CONFIG = "/api/rest/config*";
|
|
|
|
/** Field description */
|
|
public static final String PATTERN_DEBUG = "/debug.html";
|
|
|
|
/** Field description */
|
|
public static final String PATTERN_INDEX = "/index.html";
|
|
|
|
/** Field description */
|
|
public static final String PATTERN_PAGE = "*.html";
|
|
|
|
/** Field description */
|
|
public static final String PATTERN_PLUGIN_SCRIPT = "/plugins/resources/js/*";
|
|
|
|
/** Field description */
|
|
public static final String PATTERN_RESTAPI = "/api/rest/*";
|
|
|
|
/** Field description */
|
|
public static final String PATTERN_SCRIPT = "*.js";
|
|
|
|
/** Field description */
|
|
public static final String PATTERN_STYLESHEET = "*.css";
|
|
|
|
/** Field description */
|
|
public static final String RESOURCE_REGEX =
|
|
"^/(?:resources|api|plugins|index)[\\./].*(?:html|\\.css|\\.js|\\.xml|\\.json|\\.txt)";
|
|
|
|
/** Field description */
|
|
public static final String REST_PACKAGE = "sonia.scm.api.rest";
|
|
|
|
/** Field description */
|
|
public static final String SYSTEM_PROPERTY_DEBUG_HTTP = "scm.debug.http";
|
|
|
|
/** Field description */
|
|
public static final String[] PATTERN_STATIC_RESOURCES = new String[] {
|
|
PATTERN_SCRIPT,
|
|
PATTERN_STYLESHEET, "*.jpg", "*.gif", "*.png" };
|
|
|
|
/** Field description */
|
|
public static final String[] PATTERN_COMPRESSABLE = new String[] {
|
|
PATTERN_SCRIPT,
|
|
PATTERN_STYLESHEET, "*.json", "*.xml", "*.txt" };
|
|
|
|
/** Field description */
|
|
private static final Logger logger =
|
|
LoggerFactory.getLogger(ScmServletModule.class);
|
|
|
|
//~--- constructors ---------------------------------------------------------
|
|
|
|
/**
|
|
* Constructs ...
|
|
*
|
|
*
|
|
*
|
|
* @param servletContext
|
|
* @param pluginLoader
|
|
* @param overrides
|
|
*/
|
|
ScmServletModule(ServletContext servletContext,
|
|
DefaultPluginLoader pluginLoader, ClassOverrides overrides)
|
|
{
|
|
this.servletContext = servletContext;
|
|
this.pluginLoader = pluginLoader;
|
|
this.overrides = overrides;
|
|
}
|
|
|
|
//~--- methods --------------------------------------------------------------
|
|
|
|
/**
|
|
* Method description
|
|
*
|
|
*/
|
|
@Override
|
|
protected void configureServlets()
|
|
{
|
|
install(ThrowingProviderBinder.forModule(this));
|
|
|
|
SCMContextProvider context = SCMContext.getContext();
|
|
|
|
bind(SCMContextProvider.class).toInstance(context);
|
|
|
|
ScmConfiguration config = getScmConfiguration();
|
|
CipherUtil cu = CipherUtil.getInstance();
|
|
|
|
// bind repository provider
|
|
ThrowingProviderBinder.create(binder()).bind(
|
|
RepositoryProvider.class, Repository.class).to(
|
|
DefaultRepositoryProvider.class).in(RequestScoped.class);
|
|
|
|
// bind servlet context
|
|
bind(ServletContext.class).annotatedWith(Default.class).toInstance(
|
|
servletContext);
|
|
|
|
// bind event api
|
|
bind(ScmEventBus.class).toInstance(ScmEventBus.getInstance());
|
|
|
|
// bind core
|
|
bind(StoreFactory.class, JAXBStoreFactory.class);
|
|
bind(ConfigurationEntryStoreFactory.class,
|
|
JAXBConfigurationEntryStoreFactory.class);
|
|
bind(DataStoreFactory.class, JAXBDataStoreFactory.class);
|
|
bind(BlobStoreFactory.class, FileBlobStoreFactory.class);
|
|
bind(ScmConfiguration.class).toInstance(config);
|
|
bind(PluginLoader.class).toInstance(pluginLoader);
|
|
bind(PluginManager.class, DefaultPluginManager.class);
|
|
|
|
// note CipherUtil uses an other generator
|
|
bind(KeyGenerator.class).to(DefaultKeyGenerator.class);
|
|
bind(CipherHandler.class).toInstance(cu.getCipherHandler());
|
|
bind(FileSystem.class, DefaultFileSystem.class);
|
|
|
|
// bind health check stuff
|
|
bind(HealthCheckContextListener.class);
|
|
|
|
// bind extensions
|
|
pluginLoader.getExtensionProcessor().processAutoBindExtensions(binder());
|
|
|
|
// bind security stuff
|
|
bind(SecuritySystem.class).to(DefaultSecuritySystem.class);
|
|
bind(AdministrationContext.class, DefaultAdministrationContext.class);
|
|
|
|
// bind cache
|
|
bind(CacheManager.class, GuavaCacheManager.class);
|
|
|
|
// bind dao
|
|
bind(GroupDAO.class, XmlGroupDAO.class);
|
|
bind(UserDAO.class, XmlUserDAO.class);
|
|
bind(RepositoryDAO.class, XmlRepositoryDAO.class);
|
|
|
|
bindDecorated(RepositoryManager.class, DefaultRepositoryManager.class,
|
|
RepositoryManagerProvider.class);
|
|
bindDecorated(UserManager.class, DefaultUserManager.class,
|
|
UserManagerProvider.class);
|
|
bindDecorated(GroupManager.class, DefaultGroupManager.class,
|
|
GroupManagerProvider.class);
|
|
bind(CGIExecutorFactory.class, DefaultCGIExecutorFactory.class);
|
|
|
|
// bind httpclient
|
|
bind(HttpClient.class, URLHttpClient.class);
|
|
|
|
// bind resourcemanager
|
|
if (context.getStage() == Stage.DEVELOPMENT)
|
|
{
|
|
bind(ResourceManager.class, DevelopmentResourceManager.class);
|
|
}
|
|
else
|
|
{
|
|
bind(ResourceManager.class, DefaultResourceManager.class);
|
|
}
|
|
|
|
// bind url provider staff
|
|
bind(UrlProvider.class).annotatedWith(
|
|
Names.named(UrlProviderFactory.TYPE_RESTAPI_JSON)).toProvider(
|
|
RestJsonUrlProvider.class);
|
|
bind(UrlProvider.class).annotatedWith(
|
|
Names.named(UrlProviderFactory.TYPE_RESTAPI_XML)).toProvider(
|
|
RestXmlUrlProvider.class);
|
|
bind(UrlProvider.class).annotatedWith(
|
|
Names.named(UrlProviderFactory.TYPE_WUI)).toProvider(
|
|
WebUIUrlProvider.class);
|
|
|
|
// bind repository service factory
|
|
bind(RepositoryServiceFactory.class);
|
|
|
|
// bind new hook api
|
|
bind(HookContextFactory.class);
|
|
bind(HookEventFacade.class);
|
|
|
|
// bind debug logging filter
|
|
if ("true".equalsIgnoreCase(System.getProperty(SYSTEM_PROPERTY_DEBUG_HTTP)))
|
|
{
|
|
filter(PATTERN_ALL).through(LoggingFilter.class);
|
|
}
|
|
|
|
// debug servlet
|
|
serve(PATTERN_DEBUG).with(DebugServlet.class);
|
|
|
|
// plugin resources
|
|
serve(PATTERN_PLUGIN_SCRIPT).with(ScriptResourceServlet.class);
|
|
|
|
// template
|
|
serve(PATTERN_INDEX, "/").with(TemplateServlet.class);
|
|
|
|
Multibinder<TemplateEngine> engineBinder =
|
|
Multibinder.newSetBinder(binder(), TemplateEngine.class);
|
|
|
|
engineBinder.addBinding().to(MustacheTemplateEngine.class);
|
|
bind(TemplateEngine.class).annotatedWith(Default.class).to(
|
|
MustacheTemplateEngine.class);
|
|
bind(TemplateEngineFactory.class);
|
|
|
|
// bind events
|
|
// bind(LastModifiedUpdateListener.class);
|
|
|
|
// jersey
|
|
Map<String, String> params = Maps.newHashMap();
|
|
|
|
/*
|
|
* params.put("com.sun.jersey.spi.container.ContainerRequestFilters",
|
|
* "com.sun.jersey.api.container.filter.LoggingFilter");
|
|
* params.put("com.sun.jersey.spi.container.ContainerResponseFilters",
|
|
* "com.sun.jersey.api.container.filter.LoggingFilter");
|
|
* params.put("com.sun.jersey.config.feature.Trace", "true");
|
|
* params.put("com.sun.jersey.config.feature.TracePerRequest", "true");
|
|
*/
|
|
params.put(JSONConfiguration.FEATURE_POJO_MAPPING, Boolean.TRUE.toString());
|
|
params.put(ResourceConfig.FEATURE_REDIRECT, Boolean.TRUE.toString());
|
|
params.put(ResourceConfig.FEATURE_DISABLE_WADL, Boolean.TRUE.toString());
|
|
|
|
/*
|
|
* TODO remove UriExtensionsConfig and PackagesResourceConfig
|
|
* to stop jersey classpath scanning
|
|
*/
|
|
params.put(ServletContainer.RESOURCE_CONFIG_CLASS,
|
|
UriExtensionsConfig.class.getName());
|
|
params.put(PackagesResourceConfig.PROPERTY_PACKAGES, "unbound");
|
|
serve(PATTERN_RESTAPI).with(GuiceContainer.class, params);
|
|
}
|
|
|
|
/**
|
|
* Method description
|
|
*
|
|
*
|
|
* @param clazz
|
|
* @param defaultImplementation
|
|
* @param <T>
|
|
*/
|
|
private <T> void bind(Class<T> clazz,
|
|
Class<? extends T> defaultImplementation)
|
|
{
|
|
Class<? extends T> implementation = find(clazz, defaultImplementation);
|
|
|
|
if (logger.isDebugEnabled())
|
|
{
|
|
logger.debug("bind {} to {}", clazz, implementation);
|
|
}
|
|
|
|
bind(clazz).to(implementation);
|
|
}
|
|
|
|
/**
|
|
* Method description
|
|
*
|
|
*
|
|
* @param clazz
|
|
* @param defaultImplementation
|
|
* @param providerClass
|
|
* @param <T>
|
|
*/
|
|
private <T> void bindDecorated(Class<T> clazz,
|
|
Class<? extends T> defaultImplementation,
|
|
Class<? extends Provider<T>> providerClass)
|
|
{
|
|
Class<? extends T> implementation = find(clazz, defaultImplementation);
|
|
|
|
if (logger.isDebugEnabled())
|
|
{
|
|
logger.debug("bind undecorated {} to {}", clazz, implementation);
|
|
}
|
|
|
|
bind(clazz).annotatedWith(Undecorated.class).to(implementation);
|
|
|
|
if (logger.isDebugEnabled())
|
|
{
|
|
logger.debug("bind {} to provider {}", clazz, providerClass);
|
|
}
|
|
|
|
bind(clazz).toProvider(providerClass);
|
|
}
|
|
|
|
/**
|
|
* Method description
|
|
*
|
|
*
|
|
* @param clazz
|
|
* @param defaultImplementation
|
|
* @param <T>
|
|
*
|
|
* @return
|
|
*/
|
|
private <T> Class<? extends T> find(Class<T> clazz,
|
|
Class<? extends T> defaultImplementation)
|
|
{
|
|
Class<? extends T> implementation = overrides.getOverride(clazz);
|
|
|
|
if (implementation != null)
|
|
{
|
|
logger.info("found override {} for {}", implementation, clazz);
|
|
}
|
|
else
|
|
{
|
|
implementation = defaultImplementation;
|
|
|
|
if (logger.isTraceEnabled())
|
|
{
|
|
logger.trace(
|
|
"no override available for {}, using default implementation {}",
|
|
clazz, implementation);
|
|
}
|
|
}
|
|
|
|
return implementation;
|
|
}
|
|
|
|
//~--- get methods ----------------------------------------------------------
|
|
|
|
/**
|
|
* Load ScmConfiguration with JAXB
|
|
*
|
|
*
|
|
* @param context
|
|
*
|
|
* @return
|
|
*/
|
|
private ScmConfiguration getScmConfiguration()
|
|
{
|
|
ScmConfiguration configuration = new ScmConfiguration();
|
|
|
|
ScmConfigurationUtil.getInstance().load(configuration);
|
|
|
|
return configuration;
|
|
}
|
|
|
|
//~--- fields ---------------------------------------------------------------
|
|
|
|
/** Field description */
|
|
private final ClassOverrides overrides;
|
|
|
|
/** Field description */
|
|
private final DefaultPluginLoader pluginLoader;
|
|
|
|
/** Field description */
|
|
private final ServletContext servletContext;
|
|
}
|