SCM-Manager/scm-webapp/src/main/java/sonia/scm/ScmServletModule.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.inject.multibindings.Multibinder;
import com.google.inject.servlet.ServletModule;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import sonia.scm.api.rest.UriExtensionsConfig;
import sonia.scm.cache.CacheManager;
import sonia.scm.cache.CacheRepositoryManagerDecorator;
import sonia.scm.cache.EhCacheManager;
import sonia.scm.filter.SecurityFilter;
import sonia.scm.plugin.ScriptResourceServlet;
import sonia.scm.repository.BasicRepositoryManager;
import sonia.scm.repository.RepositoryHandler;
import sonia.scm.repository.RepositoryManager;
import sonia.scm.security.EncryptionHandler;
import sonia.scm.security.MessageDigestEncryptionHandler;
import sonia.scm.user.BasicUserManager;
import sonia.scm.user.UserHandler;
import sonia.scm.user.UserManager;
import sonia.scm.user.xml.XmlUserHandler;
import sonia.scm.util.DebugServlet;
import sonia.scm.util.Util;
import sonia.scm.web.plugin.SCMPlugin;
import sonia.scm.web.plugin.SCMPluginManager;
import sonia.scm.web.plugin.ScmWebPluginContext;
import sonia.scm.web.plugin.SecurityConfig;
import sonia.scm.web.security.Authenticator;
import sonia.scm.web.security.BasicSecurityContext;
import sonia.scm.web.security.SecurityContext;
import sonia.scm.web.security.XmlAuthenticator;

//~--- JDK imports ------------------------------------------------------------

import com.sun.jersey.api.core.PackagesResourceConfig;
import com.sun.jersey.api.core.ResourceConfig;
import com.sun.jersey.guice.spi.container.servlet.GuiceContainer;
import com.sun.jersey.spi.container.servlet.ServletContainer;

import java.util.Collection;
import java.util.HashMap;
import java.util.LinkedHashSet;
import java.util.Map;
import java.util.Set;

/**
 *
 * @author Sebastian Sdorra
 */
public class ScmServletModule extends ServletModule
{

  /** Field description */
  public static final String PATTERN_DEBUG = "/debug.html";

  /** Field description */
  public static final String PATTERN_PAGE = "*.html";

  /** Field description */
  public static final String PATTERN_PLUGIN_SCRIPT = "/plugins/sonia.plugin.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 REST_PACKAGE = "sonia.scm.api.rest";

  /** 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 Logger logger =
    LoggerFactory.getLogger(ScmServletModule.class);

  //~--- constructors ---------------------------------------------------------

  /**
   * Constructs ...
   *
   *
   *
   * @param pluginManager
   * @param webPluginContext
   */
  ScmServletModule(SCMPluginManager pluginManager,
                   ScmWebPluginContext webPluginContext)
  {
    this.pluginManager = pluginManager;
    this.webPluginContext = webPluginContext;
  }

  //~--- methods --------------------------------------------------------------

  /**
   * Method description
   *
   */
  @Override
  protected void configureServlets()
  {
    SCMContextProvider context = SCMContext.getContext();

    bind(SCMContextProvider.class).toInstance(context);

    // bind(EncryptionHandler.class).to(MessageDigestEncryptionHandler.class);
    // bind(Authenticator.class).to(XmlAuthenticator.class);
    bind(SecurityContext.class).to(BasicSecurityContext.class);
    loadPlugins(pluginManager);
    bind(CacheManager.class).to(EhCacheManager.class);
    bind(RepositoryManager.class).annotatedWith(Undecorated.class).to(
        BasicRepositoryManager.class);
    bind(RepositoryManager.class).to(CacheRepositoryManagerDecorator.class);
    bind(UserManager.class).to(BasicUserManager.class);
    bind(ScmWebPluginContext.class).toInstance(webPluginContext);

    /*
     * filter(PATTERN_PAGE,
     *      PATTERN_STATIC_RESOURCES).through(StaticResourceFilter.class);
     * filter(PATTERN_PAGE, PATTERN_COMPRESSABLE).through(GZipFilter.class);
     * filter(PATTERN_RESTAPI).through(SecurityFilter.class);
     */
    filter(PATTERN_RESTAPI, PATTERN_DEBUG).through(SecurityFilter.class);

    // debug servlet
    serve(PATTERN_DEBUG).with(DebugServlet.class);

    // plugin resources
    serve(PATTERN_PLUGIN_SCRIPT).with(ScriptResourceServlet.class);

    // jersey
    Map<String, String> params = new HashMap<String, String>();

    /*
     * 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(ResourceConfig.FEATURE_REDIRECT, Boolean.TRUE.toString());
    params.put(ServletContainer.RESOURCE_CONFIG_CLASS,
               UriExtensionsConfig.class.getName());
    params.put(PackagesResourceConfig.PROPERTY_PACKAGES, REST_PACKAGE);
    serve(PATTERN_RESTAPI).with(GuiceContainer.class, params);
  }

  /**
   * Method description
   *
   *
   * @param repositoryHandlerBinder
   * @param handlerSet
   */
  private void bindRepositoryHandlers(
          Multibinder<RepositoryHandler> repositoryHandlerBinder,
          Set<Class<? extends RepositoryHandler>> handlerSet)
  {
    for (Class<? extends RepositoryHandler> handlerClass : handlerSet)
    {
      if (logger.isInfoEnabled())
      {
        logger.info("load RepositoryHandler {}", handlerClass.getName());
      }

      bind(handlerClass);
      repositoryHandlerBinder.addBinding().to(handlerClass);
    }
  }

  /**
   *  Method description
   *
   *
   *  @param userHandlerBinder
   *  @param handlerSet
   */
  private void bindUserHandlers(Multibinder<UserHandler> userHandlerBinder,
                                Set<Class<? extends UserHandler>> handlerSet)
  {
    for (Class<? extends UserHandler> handlerClass : handlerSet)
    {
      if (logger.isInfoEnabled())
      {
        logger.info("load UserHandler {}", handlerClass.getName());
      }

      bind(handlerClass);
      userHandlerBinder.addBinding().to(handlerClass);
    }
  }

  /**
   * Method description
   *
   *
   * @param pluginManager
   */
  private void loadPlugins(SCMPluginManager pluginManager)
  {
    Set<SCMPlugin> pluginSet = pluginManager.getPlugins();

    if (Util.isNotEmpty(pluginSet))
    {

      // repository handlers
      Multibinder<RepositoryHandler> repositoryHandlerBinder =
        Multibinder.newSetBinder(binder(), RepositoryHandler.class);
      Set<Class<? extends RepositoryHandler>> repositoryHandlerSet =
        new LinkedHashSet<Class<? extends RepositoryHandler>>();

      // user handlers
      Multibinder<UserHandler> userHandlerBinder =
        Multibinder.newSetBinder(binder(), UserHandler.class);
      Set<Class<? extends UserHandler>> userHandlerSet =
        new LinkedHashSet<Class<? extends UserHandler>>();

      userHandlerSet.add(XmlUserHandler.class);

      // security stuff
      Class<? extends EncryptionHandler> encryptionHandler =
        MessageDigestEncryptionHandler.class;
      Class<? extends Authenticator> authenticator = XmlAuthenticator.class;

      for (SCMPlugin plugin : pluginSet)
      {
        Collection<Class<? extends RepositoryHandler>> pluginRepositoryHandlers =
          plugin.getRepositoryHandlers();

        if (Util.isNotEmpty(pluginRepositoryHandlers))
        {
          repositoryHandlerSet.addAll(pluginRepositoryHandlers);
        }

        Collection<Class<? extends UserHandler>> pluginUserHandlers =
          plugin.getUserHandlers();

        if (Util.isNotEmpty(pluginUserHandlers))
        {
          userHandlerSet.addAll(pluginUserHandlers);
        }

        SecurityConfig securityConfig = plugin.getSecurityConfig();

        if (securityConfig != null)
        {
          Class<? extends EncryptionHandler> enc =
            securityConfig.getEncryptionHandler();

          if (enc != null)
          {
            encryptionHandler = enc;
          }

          Class<? extends Authenticator> auth =
            securityConfig.getAuthenticator();

          if (auth != null)
          {
            authenticator = auth;
          }
        }
      }

      bind(EncryptionHandler.class).to(encryptionHandler);
      bind(Authenticator.class).to(authenticator);
      bindRepositoryHandlers(repositoryHandlerBinder, repositoryHandlerSet);
      bindUserHandlers(userHandlerBinder, userHandlerSet);
    }
  }

  //~--- fields ---------------------------------------------------------------

  /** Field description */
  private SCMPluginManager pluginManager;

  /** Field description */
  private ScmWebPluginContext webPluginContext;
}