Improve WAR resource extraction by using ServletContext.getResourcePaths

James Moger

2013-05-10 d55ce81623ec318e4956bdb8ff543e3d9ffbb67e

 src/main/java/com/gitblit/GitBlit.java

@@ -18,9 +18,12 @@
import java.io.BufferedReader;

import java.io.File;

import java.io.FileFilter;

import java.io.FileNotFoundException;

import java.io.FileOutputStream;

import java.io.IOException;

import java.io.InputStream;

import java.io.InputStreamReader;

import java.io.OutputStream;

import java.lang.reflect.Field;

import java.lang.reflect.Type;

import java.net.URI;

@@ -3412,7 +3415,8 @@
         // Gitblit is running in a servlet container

         ServletContext context = contextEvent.getServletContext();

         WebXmlSettings webxmlSettings = new WebXmlSettings(context);

         File contextFolder = new File(context.getRealPath("/"));

         String contextRealPath = context.getRealPath("/");

         File contextFolder = (contextRealPath != null) ? new File(contextRealPath) : null;

         String openShift = System.getenv("OPENSHIFT_DATA_DIR");

         

         if (!StringUtils.isEmpty(openShift)) {

@@ -3444,27 +3448,29 @@
            configureContext(webxmlSettings, base, true);

         } else {

            // Gitblit is running in a standard servlet container

            logger.info("WAR contextFolder is " + contextFolder.getAbsolutePath());

            logger.info("WAR contextFolder is " + ((contextFolder != null) ? contextFolder.getAbsolutePath() : "<empty>"));

            

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

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

            base.mkdirs();

            

            // try to copy the data folder contents to the baseFolder

            File localSettings = new File(base, "gitblit.properties");

            if (!localSettings.exists()) {

               File contextData = new File(contextFolder, "/WEB-INF/data");

               if (!base.equals(contextData)) {

                  try {

                     com.gitblit.utils.FileUtils.copy(base, contextData.listFiles());

                  } catch (IOException e) {

                     logger.error(MessageFormat.format(

                           "Failed to copy included data from {0} to {1}",

                        contextData, base));

                  }

               }

            if (path.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}\"!",

                     Constants.baseFolder, Constants.contextFolder$, context.getServerInfo()));

               logger.error(MessageFormat.format("Please specify a non-parameterized path for <context-param> {0} in web.xml!!", Constants.baseFolder));

               logger.error(MessageFormat.format("OR configure your servlet container to specify a \"{0}\" parameter in the context configuration!!", Constants.baseFolder));

               logger.error("");

            }

            

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

            base.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);

            }



            // delegate all config to baseFolder/gitblit.properties file

            FileSettings settings = new FileSettings(localSettings.getAbsolutePath());            

            configureContext(settings, base, true);

@@ -3474,6 +3480,38 @@
      settingsModel = loadSettingModels();

      serverStatus.servletContainer = servletContext.getServerInfo();

   }

	
   protected void extractResources(ServletContext context, String path, File toDir) {

      for (String resource : context.getResourcePaths(path)) {

         // extract the resource to the directory if it does not exist

         File f = new File(toDir, resource.substring(path.length()));

         if (!f.exists()) {

            try {

               if (resource.charAt(resource.length() - 1) == '/') {

                  // directory

                  f.mkdirs();

                  extractResources(context, resource, f);

               } else {

                  // file

                  f.getParentFile().mkdirs();

                  InputStream is = context.getResourceAsStream(resource);

                  OutputStream os = new FileOutputStream(f);

                  byte [] buffer = new byte[4096];

                  int len = 0;

                  while ((len = is.read(buffer)) > -1) {

                     os.write(buffer, 0, len);

                  }

                  is.close();

                  os.close();

               }

            } catch (FileNotFoundException e) {

               logger.error("Failed to find resource \"" + resource + "\"", e);

            } catch (IOException e) {

               logger.error("Failed to copy resource \"" + resource + "\" to " + f, e);

            }

         }

      }

   }



   /**

    * Gitblit is being shutdown either because the servlet container is