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.adaptor; 1856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 1956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodsonimport com.google.clearsilver.jsilver.JSilver; 2056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodsonimport com.google.clearsilver.jsilver.autoescape.EscapeMode; 2156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodsonimport com.google.clearsilver.jsilver.data.Data; 2256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodsonimport com.google.clearsilver.jsilver.data.LocalAndGlobalData; 2356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodsonimport com.google.clearsilver.jsilver.exceptions.JSilverIOException; 2456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodsonimport com.google.clearsilver.jsilver.template.HtmlWhiteSpaceStripper; 2556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodsonimport com.google.clearsilver.jsilver.template.Template; 2656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 2756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodsonimport org.clearsilver.CS; 2856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodsonimport org.clearsilver.CSFileLoader; 2956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodsonimport org.clearsilver.HDF; 3056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 3156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodsonimport java.io.IOException; 3256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 3356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson/** 3456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * Adaptor that wraps a JSilver object so it can be used as an CS object. 3556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson */ 3656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodsonclass JCs implements CS { 3756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 3856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson private final JHdf localHdf; 3956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson private JHdf globalHdf; 4056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson private final JSilver jSilver; 4156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson private final LoadPathToFileCache loadPathCache; 4256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson private Template template = null; 4356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson private CSFileLoader csFileLoader; 4456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson private ResourceLoaderAdaptor resourceLoaderAdaptor; 4556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 4656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson JCs(JHdf hdf, JSilver jSilver, LoadPathToFileCache loadPathCache) { 4756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson this.localHdf = hdf; 4856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson this.jSilver = jSilver; 4956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson this.loadPathCache = loadPathCache; 5056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 5156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson resourceLoaderAdaptor = localHdf.getResourceLoaderAdaptor(); 5256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson csFileLoader = resourceLoaderAdaptor.getCSFileLoader(); 5356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 5456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 5556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson /** 5656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * Want to delay creating the JSilver object so we can specify necessary parameters. 5756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson */ 5856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson private JSilver getJSilver() { 5956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson return jSilver; 6056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 6156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 6256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson @Override 6356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson public void setGlobalHDF(HDF global) { 6456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson globalHdf = JHdf.cast(global); 6556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 6656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 6756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson @Override 6856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson public HDF getGlobalHDF() { 6956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson return globalHdf; 7056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 7156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 7256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson @Override 7356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson public void close() { 7456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson // Removing unneeded reference, although this is not expected to have the 7556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson // performance impact seen in JHdf as in production configurations users 7656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson // should be using cached templates so they are long-lived. 7756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson template = null; 7856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 7956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 8056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson @Override 8156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson public void parseFile(String filename) throws IOException { 8256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson try { 8356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson if (getEscapeMode().isAutoEscapingMode()) { 8456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson if (localHdf.getData().getValue("Config.PropagateEscapeStatus") != null) { 8556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson throw new IllegalArgumentException( 8656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson "Config.PropagateEscapeStatus does not work with JSilver." 8756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson + "Use JSilverOptions.setPropagateEscapeStatus instead"); 8856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 8956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 9056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson template = 9156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson getJSilver().getTemplateLoader().load(filename, resourceLoaderAdaptor, getEscapeMode()); 9256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } catch (RuntimeException e) { 9356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson Throwable th = e; 9456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson if (th instanceof JSilverIOException) { 9556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson // JSilverIOException always has an IOException as its cause. 9656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson throw ((IOException) th.getCause()); 9756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 9856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson throw e; 9956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 10056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 10156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 10256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson @Override 10356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson public void parseStr(String content) { 10456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson if (getEscapeMode().isAutoEscapingMode()) { 10556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson if (localHdf.getData().getValue("Config.PropagateEscapeStatus") != null) { 10656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson throw new IllegalArgumentException( 10756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson "Config.PropagateEscapeStatus does not work with JSilver." 10856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson + "Use JSilverOptions.setPropagateEscapeStatus instead"); 10956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 11056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 11156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson template = getJSilver().getTemplateLoader().createTemp("parseStr", content, getEscapeMode()); 11256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 11356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 11456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson private EscapeMode getEscapeMode() { 11556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson Data data = localHdf.getData(); 11656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson return getJSilver().getEscapeMode(data); 11756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 11856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 11956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson @Override 12056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson public String render() { 12156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson if (template == null) { 12256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson throw new IllegalStateException("Call parseFile() or parseStr() before " + "render()"); 12356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 12456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 12556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson Data data; 12656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson if (globalHdf != null) { 12756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson // For legacy support we allow users to pass in this option to disable 12856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson // the new modification protection for global HDF. 12956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson data = 13056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson new LocalAndGlobalData(localHdf.getData(), globalHdf.getData(), jSilver.getOptions() 13156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson .getAllowGlobalDataModification()); 13256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } else { 13356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson data = localHdf.getData(); 13456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 13556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson Appendable buffer = jSilver.createAppendableBuffer(); 13656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson try { 13756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson Appendable output = buffer; 13856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson // For Clearsilver compatibility we check this HDF variable to see if we 13956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson // need to turn on whitespace stripping. The preferred approach would be 14056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson // to turn it on in the JSilverOptions passed to JSilverFactory 14156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson int wsStripLevel = localHdf.getIntValue("ClearSilver.WhiteSpaceStrip", 0); 14256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson if (wsStripLevel > 0) { 14356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson output = new HtmlWhiteSpaceStripper(output, wsStripLevel); 14456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 14556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson jSilver.render(template, data, output, resourceLoaderAdaptor); 14656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson return output.toString(); 14756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } catch (IOException ioe) { 14856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson throw new RuntimeException(ioe); 14956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } finally { 15056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson jSilver.releaseAppendableBuffer(buffer); 15156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 15256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 15356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 15456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson @Override 15556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson public CSFileLoader getFileLoader() { 15656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson return csFileLoader; 15756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 15856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 15956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson @Override 16056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson public void setFileLoader(CSFileLoader fileLoader) { 16156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson if (fileLoader == null && csFileLoader == null) { 16256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson return; 16356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 16456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson if (fileLoader != null && fileLoader.equals(csFileLoader)) { 16556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson return; 16656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 16756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson csFileLoader = fileLoader; 16856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson resourceLoaderAdaptor = new ResourceLoaderAdaptor(localHdf, loadPathCache, csFileLoader); 16956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 17056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson} 171