NIHVIVO-3200 Make the FreemarkerConfigurationLoader a static utility class with a local cache, instead of having the loader as a context attribute and the cache as another context attribute.

webapp/src/edu/cornell/mannlib/vitro/webapp/controller/ajax/VitroAjaxController.java

@@ -75,10 +75,7 @@ public abstract class VitroAjaxController extends HttpServlet {
 	 * its data through a template.
 	 */
 	protected final Configuration getFreemarkerConfiguration(VitroRequest vreq) {
-	    ServletContext context = getServletContext();
+		return FreemarkerConfigurationLoader.getConfig(vreq, getServletContext());
-        FreemarkerConfigurationLoader loader = 
-            FreemarkerConfigurationLoader.getFreemarkerConfigurationLoader(context);
-        return loader.getConfig(vreq);	    
 	}
 	
 	/**

webapp/src/edu/cornell/mannlib/vitro/webapp/controller/freemarker/FreemarkerConfigurationLoader.java

@@ -2,6 +2,7 @@
 
 package edu.cornell.mannlib.vitro.webapp.controller.freemarker;
 
+import java.util.HashMap;
 import java.util.Map;
 
 import javax.servlet.ServletContext;
@@ -11,43 +12,20 @@ import org.apache.commons.logging.LogFactory;
 
 import edu.cornell.mannlib.vitro.webapp.beans.ApplicationBean;
 import edu.cornell.mannlib.vitro.webapp.controller.VitroRequest;
-import freemarker.template.Configuration;
 
 public class FreemarkerConfigurationLoader {
-    private static final Log log = LogFactory.getLog(FreemarkerConfigurationLoader.class);
+	private static final Log log = LogFactory
+			.getLog(FreemarkerConfigurationLoader.class);
 
-    private ServletContext context;
+	private static final Map<String, FreemarkerConfiguration> themeToConfigMap = new HashMap<String, FreemarkerConfiguration>();
 
-    public FreemarkerConfigurationLoader(ServletContext context){
+	public static FreemarkerConfiguration getConfig(VitroRequest vreq,
-        this.context = context;
+			ServletContext context) {
-        context.setAttribute("FreemarkerConfigurationLoader", this);
-    }
-    
-    /**
-     * @return Under serious error conditions this will return null.
-     */
-    public static FreemarkerConfigurationLoader getFreemarkerConfigurationLoader(ServletContext context){
-        if( context!=null){
-            FreemarkerConfigurationLoader fcl = (FreemarkerConfigurationLoader)
-                context.getAttribute("FreemarkerConfigurationLoader");
-            if( fcl == null ){
-                log.error("Must be constructed before calling " +
-                        "getFreemarkerConfigurationLoader(), usually this is done by FreemarkerSetup");
-                return null;
-            }
-            return fcl;
-        }else{
-            log.error("getFreemarkerConfigurationLoader() must not be called with a null context");        
-            return null; 
-        }
-    }
-    
-    public FreemarkerConfiguration getConfig(VitroRequest vreq) { 
 		String themeDir = getThemeDir(vreq.getAppBean());
-        return getConfigForTheme(themeDir, vreq);
+		return getConfigForTheme(themeDir, vreq, context);
 	}
 
-    protected String getThemeDir(ApplicationBean appBean) {
+	private static String getThemeDir(ApplicationBean appBean) {
 		if (appBean == null) {
 			log.error("Cannot get themeDir from null application bean");
 			return null;
@@ -62,28 +40,26 @@ public class FreemarkerConfigurationLoader {
 		return themeDir.replaceAll("/$", "");
 	}
 
-    protected FreemarkerConfiguration getConfigForTheme(String themeDir, VitroRequest vreq) {
+	/**
-        
+	 * The Configuration is theme-specific because:
-        /* The Configuration is theme-specific because:
+	 * 
-         * 1. The template loader is theme-specific, since it specifies a theme directory to load templates from.
+	 * 1. The template loader is theme-specific, since it specifies a theme
+	 * directory to load templates from.
+	 * 
 	 * 2. Shared variables like stylesheets are theme-specific.
 	 */
-        @SuppressWarnings("unchecked")
+	private static FreemarkerConfiguration getConfigForTheme(String themeDir,
-        Map<String, FreemarkerConfiguration> themeToConfigMap = 
+			VitroRequest vreq, ServletContext context) {
-            (Map<String, FreemarkerConfiguration>) context.getAttribute("themeToConfigMap");
+		synchronized (themeToConfigMap) {
-        
+			if (themeToConfigMap.containsKey(themeDir)) {
-        if( themeToConfigMap == null ) {
-            log.error("The templating system is not configured correctly. Make sure that you have the FreemarkerSetup context listener in your web.xml.");
-            // We'll end up with a blank page as well as errors in the log, which is probably fine. 
-            // Doesn't seem like we should throw a checked exception in this case.
-            return null;    
-        } else if (themeToConfigMap.containsKey(themeDir)) {
 				return themeToConfigMap.get(themeDir);
 			} else {
-            FreemarkerConfiguration config = new FreemarkerConfiguration(themeDir, vreq, context); 
+				FreemarkerConfiguration config = new FreemarkerConfiguration(
+						themeDir, vreq, context);
 				themeToConfigMap.put(themeDir, config);
 				return config;
 			}
 		}
+	}
 
 }

webapp/src/edu/cornell/mannlib/vitro/webapp/controller/freemarker/FreemarkerHttpServlet.java

@@ -15,7 +15,6 @@ import javax.servlet.ServletException;
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
 
-import org.apache.commons.lang.StringUtils;
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
 
@@ -25,7 +24,6 @@ import edu.cornell.mannlib.vitro.webapp.auth.requestedAction.usepages.EditOwnAcc
 import edu.cornell.mannlib.vitro.webapp.auth.requestedAction.usepages.UseMiscellaneousAdminPages;
 import edu.cornell.mannlib.vitro.webapp.beans.ApplicationBean;
 import edu.cornell.mannlib.vitro.webapp.beans.DisplayMessage;
-import edu.cornell.mannlib.vitro.webapp.config.ConfigurationProperties;
 import edu.cornell.mannlib.vitro.webapp.controller.VitroHttpServlet;
 import edu.cornell.mannlib.vitro.webapp.controller.VitroRequest;
 import edu.cornell.mannlib.vitro.webapp.controller.freemarker.TemplateProcessingHelper.TemplateProcessingException;
@@ -198,9 +196,7 @@ public class FreemarkerHttpServlet extends VitroHttpServlet {
     }
    
     protected FreemarkerConfiguration getConfig(VitroRequest vreq) {               
-        FreemarkerConfigurationLoader loader = 
+        return FreemarkerConfigurationLoader.getConfig(vreq, getServletContext());
-            FreemarkerConfigurationLoader.getFreemarkerConfigurationLoader(getServletContext());
-        return loader.getConfig(vreq);
     }
 
     /**

webapp/src/edu/cornell/mannlib/vitro/webapp/controller/freemarker/FreemarkerSetup.java

@@ -2,8 +2,6 @@
 
 package edu.cornell.mannlib.vitro.webapp.controller.freemarker;
 
-import java.util.HashMap;
-
 import javax.servlet.ServletContext;
 import javax.servlet.ServletContextEvent;
 import javax.servlet.ServletContextListener;
@@ -17,18 +15,17 @@ public class FreemarkerSetup implements ServletContextListener {
     
     private static final Log log = LogFactory.getLog(FreemarkerSetup.class);
 
+	@Override
 	public void contextInitialized(ServletContextEvent event) {	
 		ServletContext sc = event.getServletContext();	
-		sc.setAttribute("themeToConfigMap", new HashMap<String, FreemarkerConfiguration>());
         BaseTemplateModel.setServletContext(sc);
         FreemarkerComponentGenerator.setServletContext(sc);
 		UrlBuilder.contextPath = sc.getContextPath();
 		
-		FreemarkerConfigurationLoader loader = new FreemarkerConfigurationLoader(sc);
-		
 		log.info("Freemarker templating system initialized.");
 	}
 
+	@Override
 	public void contextDestroyed(ServletContextEvent event) {
 		// nothing to do here
 	}

webapp/src/edu/cornell/mannlib/vitro/webapp/web/jsptags/InputElementFormattingTag.java

@@ -405,9 +405,7 @@ public class InputElementFormattingTag extends TagSupport {
             }
             
             //get freemarker Configuration
-            FreemarkerConfigurationLoader fConfigLoader 
+            Configuration fmConfig = FreemarkerConfigurationLoader.getConfig(vreq, pageContext.getServletContext());
-                = FreemarkerConfigurationLoader.getFreemarkerConfigurationLoader(pageContext.getServletContext());            
-            Configuration fmConfig = fConfigLoader.getConfig(vreq);
             
             /* populate the pieces */
             String classStr = doClass();