Return of Servlet3 servlet and filter loading

James Moger

2014-05-16 17e2d3407065a7433c7512c37a7cf7e7df63f337

 src/main/java/com/gitblit/servlet/GitblitContext.java

@@ -23,13 +23,15 @@
import java.io.OutputStream;
import java.text.MessageFormat;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import javax.naming.Context;
import javax.naming.InitialContext;
import javax.naming.NamingException;
import javax.servlet.ServletContext;
import javax.servlet.ServletContextEvent;
import javax.servlet.annotation.WebListener;

import com.gitblit.Constants;
import com.gitblit.DaggerModule;
@@ -38,6 +40,7 @@
import com.gitblit.Keys;
import com.gitblit.WebXmlSettings;
import com.gitblit.dagger.DaggerContext;
import com.gitblit.extensions.LifeCycleListener;
import com.gitblit.manager.IAuthenticationManager;
import com.gitblit.manager.IFederationManager;
import com.gitblit.manager.IGitblit;
@@ -51,20 +54,22 @@
import com.gitblit.transport.ssh.IPublicKeyManager;
import com.gitblit.utils.ContainerUtils;
import com.gitblit.utils.StringUtils;
import com.gitblit.wicket.GitblitWicketFilter;

import dagger.ObjectGraph;

/**
 * This class is the main entry point for the entire webapp.  It is a singleton
 * created manually by Gitblit GO or dynamically by the WAR/Express servlet
 * container.  This class instantiates and starts all managers.  Servlets and
 * filters are instantiated defined in web.xml and instantiated by the servlet
 * container, but those servlets and filters use Dagger to manually inject their
 * dependencies.
 * container.  This class instantiates and starts all managers.
 *
 * Servlets and filters are injected which allows Gitblit to be completely
 * code-driven.
 *
 * @author James Moger
 *
 */
@WebListener
public class GitblitContext extends DaggerContext {

   private static GitblitContext gitblit;
@@ -79,9 +84,7 @@
    * Construct a Gitblit WAR/Express context.
    */
   public GitblitContext() {
      this.goSettings = null;
      this.goBaseFolder = null;
      gitblit = this;
      this(null, null);
   }

   /**
@@ -121,21 +124,10 @@
   }

   /**
    * Configure Gitblit from the web.xml, if no configuration has already been
    * specified.
    *
    * @see ServletContextListener.contextInitialize(ServletContextEvent)
    */
   @Override
   public final void contextInitialized(ServletContextEvent contextEvent) {
      ServletContext context = contextEvent.getServletContext();
      configureContext(context);
   }

   /**
    * Prepare runtime settings and start all manager instances.
    */
   protected void configureContext(ServletContext context) {
   @Override
   protected void beforeServletInjection(ServletContext context) {
      ObjectGraph injector = getInjector(context);

      // create the runtime settings object
@@ -176,8 +168,10 @@
      runtime.start();
      managers.add(runtime);

      // create the plugin manager instance but do not start it
      loadManager(injector, IPluginManager.class);

      // start all other managers
      startManager(injector, IPluginManager.class);
      startManager(injector, INotificationManager.class);
      startManager(injector, IUserManager.class);
      startManager(injector, IAuthenticationManager.class);
@@ -187,9 +181,22 @@
      startManager(injector, IFederationManager.class);
      startManager(injector, IGitblit.class);

      // start the plugin manager last so that plugins can depend on
      // deterministic access to all other managers in their start() methods
      startManager(injector, IPluginManager.class);

      logger.info("");
      logger.info("All managers started.");
      logger.info("");

      IPluginManager pluginManager = injector.get(IPluginManager.class);
      for (LifeCycleListener listener : pluginManager.getExtensions(LifeCycleListener.class)) {
         try {
            listener.onStartup();
         } catch (Throwable t) {
            logger.error(null, t);
         }
      }
   }

   private String lookupBaseFolderFromJndi() {
@@ -204,9 +211,14 @@
      return null;
   }

   protected <X extends IManager> X startManager(ObjectGraph injector, Class<X> clazz) {
      logManager(clazz);
   protected <X extends IManager> X loadManager(ObjectGraph injector, Class<X> clazz) {
      X x = injector.get(clazz);
      return x;
   }

   protected <X extends IManager> X startManager(ObjectGraph injector, Class<X> clazz) {
      X x = loadManager(injector, clazz);
      logManager(clazz);
      x.start();
      managers.add(x);
      return x;
@@ -218,12 +230,57 @@
   }

   /**
    * Instantiate and inject all filters and servlets into the container using
    * the servlet 3 specification.
    */
   @Override
   protected void injectServlets(ServletContext context) {
      // access restricted servlets
      serve(context, Constants.R_PATH, GitServlet.class, GitFilter.class);
      serve(context, Constants.GIT_PATH, GitServlet.class, GitFilter.class);
      serve(context, Constants.RAW_PATH, RawServlet.class, RawFilter.class);
      serve(context, Constants.PAGES, PagesServlet.class, PagesFilter.class);
      serve(context, Constants.RPC_PATH, RpcServlet.class, RpcFilter.class);
      serve(context, Constants.ZIP_PATH, DownloadZipServlet.class, DownloadZipFilter.class);
      serve(context, Constants.SYNDICATION_PATH, SyndicationServlet.class, SyndicationFilter.class);

      // servlets
      serve(context, Constants.FEDERATION_PATH, FederationServlet.class);
      serve(context, Constants.SPARKLESHARE_INVITE_PATH, SparkleShareInviteServlet.class);
      serve(context, Constants.BRANCH_GRAPH_PATH, BranchGraphServlet.class);
      serve(context, Constants.PT_PATH, PtServlet.class);
      file(context, "/robots.txt", RobotsTxtServlet.class);
      file(context, "/logo.png", LogoServlet.class);

      // global filters
      filter(context, "/*", ProxyFilter.class, null);
      filter(context, "/*", EnforceAuthenticationFilter.class, null);

      // Wicket
      String toIgnore = StringUtils.flattenStrings(getRegisteredPaths(), ",");
      Map<String, String> params = new HashMap<String, String>();
      params.put(GitblitWicketFilter.FILTER_MAPPING_PARAM, "/*");
      params.put(GitblitWicketFilter.IGNORE_PATHS_PARAM, toIgnore);
      filter(context, "/*", GitblitWicketFilter.class, params);
   }

   /**
    * Gitblit is being shutdown either because the servlet container is
    * shutting down or because the servlet container is re-deploying Gitblit.
    */
   @Override
   protected void destroyContext(ServletContext context) {
      logger.info("Gitblit context destroyed by servlet container.");

      IPluginManager pluginManager = getManager(IPluginManager.class);
      for (LifeCycleListener listener : pluginManager.getExtensions(LifeCycleListener.class)) {
         try {
            listener.onShutdown();
         } catch (Throwable t) {
            logger.error(null, t);
         }
      }

      for (IManager manager : managers) {
         logger.debug("stopping {}", manager.getClass().getSimpleName());
         manager.stop();
@@ -351,6 +408,22 @@
         }
      }

      // Copy the included gitignore files to the configured gitignore folder
      String gitignorePath = webxmlSettings.getString(Keys.git.gitignoreFolder, "gitignore");
      File localGitignores = com.gitblit.utils.FileUtils.resolveParameter(Constants.baseFolder$, base, gitignorePath);
      if (!localGitignores.exists()) {
         File warGitignores = new File(contextFolder, "/WEB-INF/data/gitignore");
         if (!warGitignores.equals(localGitignores)) {
            try {
               com.gitblit.utils.FileUtils.copy(localGitignores, warGitignores.listFiles());
            } catch (IOException e) {
               logger.error(MessageFormat.format(
                     "Failed to copy included .gitignore files from {0} to {1}",
                     warGitignores, localGitignores));
            }
         }
      }

      // merge the WebXmlSettings into the runtime settings (for backwards-compatibilty)
      runtimeSettings.merge(webxmlSettings);