PrecompiledTemplateLoader.java revision 56ed4167b942ec265f9cee70ac4d71d10b3835ce
156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson/* 256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * Copyright (C) 2010 Google Inc. 356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * 456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * Licensed under the Apache License, Version 2.0 (the "License"); 556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * you may not use this file except in compliance with the License. 656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * You may obtain a copy of the License at 756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * 856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * http://www.apache.org/licenses/LICENSE-2.0 956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * 1056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * Unless required by applicable law or agreed to in writing, software 1156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * distributed under the License is distributed on an "AS IS" BASIS, 1256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 1356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * See the License for the specific language governing permissions and 1456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * limitations under the License. 1556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson */ 1656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 1756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodsonpackage com.google.clearsilver.jsilver.precompiler; 1856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 1956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodsonimport com.google.clearsilver.jsilver.autoescape.AutoEscapeOptions; 2056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodsonimport com.google.clearsilver.jsilver.autoescape.EscapeMode; 2156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodsonimport com.google.clearsilver.jsilver.compiler.BaseCompiledTemplate; 2256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodsonimport com.google.clearsilver.jsilver.functions.FunctionExecutor; 2356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodsonimport com.google.clearsilver.jsilver.resourceloader.ResourceLoader; 2456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodsonimport com.google.clearsilver.jsilver.template.DelegatingTemplateLoader; 2556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodsonimport com.google.clearsilver.jsilver.template.Template; 2656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodsonimport com.google.clearsilver.jsilver.template.TemplateLoader; 2756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodsonimport com.google.common.annotations.VisibleForTesting; 2856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodsonimport com.google.common.collect.ImmutableMap; 2956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodsonimport java.util.HashMap; 3056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodsonimport java.util.Map; 3156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 3256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson/** 3356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * TemplateLoader that stores objects from precompiled Template classes and serves them when asked 3456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * for them. If not found, it passes the request on to the delegate TemplateLoader. 3556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson */ 3656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodsonpublic class PrecompiledTemplateLoader implements DelegatingTemplateLoader { 3756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 3856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson /** 3956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * This is the next TemplateLoader to ask if we don't find the template. 4056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson */ 4156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson private final TemplateLoader nextLoader; 4256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 4356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson private final Map<Object, BaseCompiledTemplate> templateMap; 4456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson private final AutoEscapeOptions autoEscapeOptions; 4556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 4656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson public PrecompiledTemplateLoader(TemplateLoader nextLoader, 4756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson Map<Object, String> templateToClassNameMap, FunctionExecutor globalFunctionExecutor, 4856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson AutoEscapeOptions autoEscapeOptions) { 4956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson this.nextLoader = nextLoader; 5056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson this.autoEscapeOptions = autoEscapeOptions; 5156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson this.templateMap = makeTemplateMap(templateToClassNameMap, globalFunctionExecutor); 5256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 5356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 5456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson private Map<Object, BaseCompiledTemplate> makeTemplateMap( 5556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson Map<Object, String> templateToClassNameMap, FunctionExecutor globalFunctionExecutor) { 5656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson Map<Object, BaseCompiledTemplate> templateMap = new HashMap<Object, BaseCompiledTemplate>(); 5756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson ClassLoader classLoader = getClass().getClassLoader(); 5856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson for (Map.Entry<Object, String> entry : templateToClassNameMap.entrySet()) { 5956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson String className = entry.getValue(); 6056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson BaseCompiledTemplate compiledTemplate = loadTemplateObject(className, classLoader); 6156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson // Fill in the necessary 6256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson compiledTemplate.setFunctionExecutor(globalFunctionExecutor); 6356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson compiledTemplate.setTemplateName(entry.getKey().toString()); 6456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson compiledTemplate.setTemplateLoader(this); 6556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson if (entry.getKey() instanceof PrecompiledTemplateMapKey) { 6656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson PrecompiledTemplateMapKey mapKey = (PrecompiledTemplateMapKey) entry.getKey(); 6756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson // The template's escapeMode is not currently used as the autoescaping is all 6856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson // handled at compile time. Still set it in case it is needed later on. 6956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson compiledTemplate.setEscapeMode(mapKey.getEscapeMode()); 7056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } else { 7156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson compiledTemplate.setEscapeMode(EscapeMode.ESCAPE_NONE); 7256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 7356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson compiledTemplate.setAutoEscapeOptions(autoEscapeOptions); 7456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson templateMap.put(entry.getKey(), compiledTemplate); 7556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 7656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson return ImmutableMap.copyOf(templateMap); 7756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 7856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 7956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson @VisibleForTesting 8056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson protected BaseCompiledTemplate loadTemplateObject(String className, ClassLoader classLoader) { 8156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson try { 8256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson Class<?> templateClass = classLoader.loadClass(className); 8356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson // TODO: Not safe to use in untrusted environments 8456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson // Does not handle ClassCastException or 8556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson // verify class type before calling newInstance. 8656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson return (BaseCompiledTemplate) templateClass.newInstance(); 8756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } catch (ClassNotFoundException e) { 8856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson throw new IllegalArgumentException("Class not found: " + className, e); 8956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } catch (IllegalAccessException e) { 9056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson throw new Error(e); 9156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } catch (InstantiationException e) { 9256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson throw new Error(e); 9356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 9456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 9556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 9656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson @Override 9756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson public void setTemplateLoaderDelegate(TemplateLoader templateLoaderDelegate) { 9856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson for (BaseCompiledTemplate template : templateMap.values()) { 9956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson template.setTemplateLoader(templateLoaderDelegate); 10056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 10156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 10256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 10356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson @Override 10456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson public Template load(String templateName, ResourceLoader resourceLoader, EscapeMode escapeMode) { 10556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson Object key = resourceLoader.getKey(templateName); 10656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson PrecompiledTemplateMapKey mapKey = new PrecompiledTemplateMapKey(key, escapeMode); 10756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson Template template = templateMap.get(mapKey); 10856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson if (template != null) { 10956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson return template; 11056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } else { 11156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson return nextLoader.load(templateName, resourceLoader, escapeMode); 11256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 11356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 11456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 11556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson /** 11656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * We don't cache temporary templates here so we just call delegate TemplateLoader. 11756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson */ 11856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson @Override 11956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson public Template createTemp(String name, String content, EscapeMode escapeMode) { 12056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson return nextLoader.createTemp(name, content, escapeMode); 12156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 12256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson} 123