Handle possible NPE when extracting WAR resources into a new directory

James Moger

2015-11-25 d1eb00e7e98ec4d932a632e52d336c43a4351cb4

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

@@ -23,57 +23,63 @@
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 java.util.Set;

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

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

import com.gitblit.Constants;
import com.gitblit.DaggerModule;
import com.gitblit.FileSettings;
import com.gitblit.IStoredSettings;
import com.gitblit.Keys;
import com.gitblit.WebXmlSettings;
import com.gitblit.dagger.DaggerContextListener;
import com.gitblit.git.GitServlet;
import com.gitblit.extensions.LifeCycleListener;
import com.gitblit.guice.CoreModule;
import com.gitblit.guice.WebModule;
import com.gitblit.manager.IAuthenticationManager;
import com.gitblit.manager.IFederationManager;
import com.gitblit.manager.IGitblitManager;
import com.gitblit.manager.IFilestoreManager;
import com.gitblit.manager.IGitblit;
import com.gitblit.manager.IManager;
import com.gitblit.manager.INotificationManager;
import com.gitblit.manager.IPluginManager;
import com.gitblit.manager.IProjectManager;
import com.gitblit.manager.IRepositoryManager;
import com.gitblit.manager.IRuntimeManager;
import com.gitblit.manager.IServicesManager;
import com.gitblit.manager.IUserManager;
import com.gitblit.tickets.ITicketService;
import com.gitblit.transport.ssh.IPublicKeyManager;
import com.gitblit.utils.ContainerUtils;
import com.gitblit.utils.StringUtils;
import com.gitblit.wicket.GitblitWicketFilter;

import dagger.ObjectGraph;
import com.google.inject.AbstractModule;
import com.google.inject.Guice;
import com.google.inject.Injector;
import com.google.inject.servlet.GuiceServletContextListener;

/**
 * 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 followed by
 * instantiating and registering all servlets and filters.
 * container.  This class instantiates and starts all managers.
 *
 * Leveraging Servlet 3 and Dagger static dependency injection allows Gitblit to
 * be modular and completely code-driven rather then relying on the fragility of
 * a web.xml descriptor and the static & monolithic design previously used.
 * Servlets and filters are injected which allows Gitblit to be completely
 * code-driven.
 *
 * @author James Moger
 *
 */
@WebListener
public class GitblitContext extends DaggerContextListener {
public class GitblitContext extends GuiceServletContextListener {

   private static GitblitContext gitblit;

   protected final Logger logger = LoggerFactory.getLogger(getClass());

   private final List<IManager> managers = new ArrayList<IManager>();

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

   /**
@@ -118,23 +122,40 @@
      return null;
   }

   @Override
   protected Injector getInjector() {
      return Guice.createInjector(getModules());
   }

   /**
    * Returns Gitblit's Dagger injection modules.
    * Returns Gitblit's Guice injection modules.
    */
   protected AbstractModule [] getModules() {
      return new AbstractModule [] { new CoreModule(), new WebModule() };
   }

   /**
    * Configure Gitblit from the web.xml, if no configuration has already been
    * specified.
    *
    * @see ServletContextListener.contextInitialize(ServletContextEvent)
    */
   @Override
   protected Object [] getModules() {
      return new Object [] { new DaggerModule() };
   public final void contextInitialized(ServletContextEvent contextEvent) {
      super.contextInitialized(contextEvent);

      ServletContext context = contextEvent.getServletContext();
      startCore(context);
   }

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

      // create the runtime settings object
      IStoredSettings runtimeSettings = injector.get(IStoredSettings.class);
      IStoredSettings runtimeSettings = injector.getInstance(IStoredSettings.class);
      final File baseFolder;

      if (goSettings != null) {
@@ -146,7 +167,11 @@
         String contextRealPath = context.getRealPath("/");
         File contextFolder = (contextRealPath != null) ? new File(contextRealPath) : null;

         if (!StringUtils.isEmpty(System.getenv("OPENSHIFT_DATA_DIR"))) {
         // if the base folder dosen't match the default assume they don't want to use express,
         // this allows for other containers to customise the basefolder per context.
         String defaultBase = Constants.contextFolder$ + "/WEB-INF/data";
         String base = getBaseFolderPath(defaultBase);
         if (!StringUtils.isEmpty(System.getenv("OPENSHIFT_DATA_DIR")) && defaultBase.equals(base)) {
            // RedHat OpenShift
            baseFolder = configureExpress(context, webxmlSettings, contextFolder, runtimeSettings);
         } else {
@@ -160,34 +185,92 @@

      // Manually configure IRuntimeManager
      logManager(IRuntimeManager.class);
      IRuntimeManager runtime = injector.get(IRuntimeManager.class);
      IRuntimeManager runtime = injector.getInstance(IRuntimeManager.class);
      runtime.setBaseFolder(baseFolder);
      runtime.getStatus().isGO = goSettings != null;
      runtime.getStatus().servletContainer = context.getServerInfo();
      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, INotificationManager.class);
      startManager(injector, IUserManager.class);
      startManager(injector, IAuthenticationManager.class);
      startManager(injector, IPublicKeyManager.class);
      startManager(injector, IRepositoryManager.class);
      startManager(injector, IProjectManager.class);
      startManager(injector, IGitblitManager.class);
      startManager(injector, IFederationManager.class);
      startManager(injector, ITicketService.class);
      startManager(injector, IGitblit.class);
      startManager(injector, IServicesManager.class);
      startManager(injector, IFilestoreManager.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.getInstance(IPluginManager.class);
      for (LifeCycleListener listener : pluginManager.getExtensions(LifeCycleListener.class)) {
         try {
            listener.onStartup();
         } catch (Throwable t) {
            logger.error(null, t);
         }
      }
   }

   protected <X extends IManager> X startManager(ObjectGraph injector, Class<X> clazz) {
      logManager(clazz);
      X x = injector.get(clazz);
      x.start();
      managers.add(x);
   private String lookupBaseFolderFromJndi() {
      try {
         // try to lookup JNDI env-entry for the baseFolder
         InitialContext ic = new InitialContext();
         Context env = (Context) ic.lookup("java:comp/env");
         return (String) env.lookup("baseFolder");
      } catch (NamingException n) {
         logger.error("Failed to get JNDI env-entry: " + n.getExplanation());
      }
      return null;
   }

   protected String getBaseFolderPath(String defaultBaseFolder) {
      // try a system property or a JNDI property
      String specifiedBaseFolder = System.getProperty("GITBLIT_HOME", lookupBaseFolderFromJndi());

      if (!StringUtils.isEmpty(System.getenv("GITBLIT_HOME"))) {
         // try an environment variable
         specifiedBaseFolder = System.getenv("GITBLIT_HOME");
      }

      if (!StringUtils.isEmpty(specifiedBaseFolder)) {
         // use specified base folder path
         return specifiedBaseFolder;
      }

      // use default base folder path
      return defaultBaseFolder;
   }

   protected <X extends IManager> X loadManager(Injector injector, Class<X> clazz) {
      X x = injector.getInstance(clazz);
      return x;
   }

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

   protected <X extends IManager> X startManager(X x) {
       x.start();
       managers.add(x);
       return x;
   }

   protected void logManager(Class<? extends IManager> clazz) {
@@ -195,45 +278,29 @@
      logger.info("----[{}]----", clazz.getName());
   }

   /**
    * 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.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);
      file(context, "/robots.txt", RobotsTxtServlet.class);
      file(context, "/logo.png", LogoServlet.class);

      // optional force basic authentication
      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);
   public final void contextDestroyed(ServletContextEvent contextEvent) {
      super.contextDestroyed(contextEvent);
      ServletContext context = contextEvent.getServletContext();
      destroyContext(context);
   }

   /**
    * 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();
@@ -286,9 +353,9 @@
      logger.debug("configuring Gitblit WAR");
      logger.info("WAR contextFolder is " + ((contextFolder != null) ? contextFolder.getAbsolutePath() : "<empty>"));

      String path = webxmlSettings.getString(Constants.baseFolder, Constants.contextFolder$ + "/WEB-INF/data");
      String webXmlPath = webxmlSettings.getString(Constants.baseFolder, Constants.contextFolder$ + "/WEB-INF/data");

      if (path.contains(Constants.contextFolder$) && contextFolder == null) {
      if (webXmlPath.contains(Constants.contextFolder$) && contextFolder == null) {
         // warn about null contextFolder (issue-199)
         logger.error("");
         logger.error(MessageFormat.format("\"{0}\" depends on \"{1}\" but \"{2}\" is returning NULL for \"{1}\"!",
@@ -298,28 +365,16 @@
         logger.error("");
      }

      try {
         // try to lookup JNDI env-entry for the baseFolder
         InitialContext ic = new InitialContext();
         Context env = (Context) ic.lookup("java:comp/env");
         String val = (String) env.lookup("baseFolder");
         if (!StringUtils.isEmpty(val)) {
            path = val;
         }
      } catch (NamingException n) {
         logger.error("Failed to get JNDI env-entry: " + n.getExplanation());
      }
      String baseFolderPath = getBaseFolderPath(webXmlPath);

      File base = com.gitblit.utils.FileUtils.resolveParameter(Constants.contextFolder$, contextFolder, path);
      base.mkdirs();
      File baseFolder = com.gitblit.utils.FileUtils.resolveParameter(Constants.contextFolder$, contextFolder, baseFolderPath);
      baseFolder.mkdirs();

      // try to extract the data folder resource to the baseFolder
      File localSettings = new File(base, "gitblit.properties");
      if (!localSettings.exists()) {
         extractResources(context, "/WEB-INF/data/", base);
      }
      extractResources(context, "/WEB-INF/data/", baseFolder);

      // delegate all config to baseFolder/gitblit.properties file
      File localSettings = new File(baseFolder, "gitblit.properties");
      FileSettings fileSettings = new FileSettings(localSettings.getAbsolutePath());

      // merge the stored settings into the runtime settings
@@ -328,7 +383,7 @@
      // the target file for runtimeSettings is set to "localSettings".
      runtimeSettings.merge(fileSettings);

      return base;
      return baseFolder;
   }

   /**
@@ -368,6 +423,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);

@@ -385,7 +456,12 @@
   }

   protected void extractResources(ServletContext context, String path, File toDir) {
      for (String resource : context.getResourcePaths(path)) {
      Set<String> resources = context.getResourcePaths(path);
      if (resources == null) {
         logger.warn("There are no WAR resources to extract from {}", path);
         return;
      }
      for (String resource : resources) {
         // extract the resource to the directory if it does not exist
         File f = new File(toDir, resource.substring(path.length()));
         if (!f.exists()) {