2 * put your module comment here
12 import freemarker.template.*;
15 import javax.servlet.http.*;
19 * Hilfsklasse zum Mergen von Template und Daten
21 public final class HTMLTemplateProcessor {
23 public static String templateDir;
24 private static FileTemplateCache templateCache;
25 private static Logfile theLog;
26 private static String docRoot;
27 private static String actionRoot;
28 private static String productionHost;
29 private static String audioHost;
30 private static String videoHost;
31 private static String imageHost;
32 private static String openAction;
33 protected static String producerDocRoot = Configuration.getProperty("Producer.DocRoot");
34 protected static String producerStorageRoot = Configuration.getProperty("Producer.StorageRoot");
41 templateDir = Configuration.getProperty("Home") + Configuration.getProperty("HTMLTemplateProcessor.Dir");
42 templateCache = new FileTemplateCache(templateDir);
43 templateCache.setLoadingPolicy(templateCache.LOAD_ON_DEMAND);
44 //templateCache.startAutoUpdate();
45 theLog = Logfile.getInstance(Configuration.getProperty("Home") + Configuration.getProperty("HTMLTemplateProcessor.Logfile"));
46 docRoot = Configuration.getProperty("HTMLTemplateProcessor.DocRoot");
47 actionRoot = Configuration.getProperty("HTMLTemplateProcessor.ActionRoot");
48 openAction = Configuration.getProperty("Producer.OpenAction");
49 productionHost = Configuration.getProperty("Producer.ProductionHost");
50 videoHost = Configuration.getProperty("Producer.VideoHost");
51 audioHost = Configuration.getProperty("Producer.AudioHost");
52 imageHost = Configuration.getProperty("Producer.Image.Host");
53 producerDocRoot = Configuration.getProperty("Producer.DocRoot");
54 producerStorageRoot = Configuration.getProperty("Producer.StorageRoot");
60 * Privater Konstruktor, um versehentliche Instantiierung zu verhindern
62 private HTMLTemplateProcessor () {
67 // process-Methoden zum Mischen verschiedener Datenstrukturen mit HTML-Templates
71 * Wandelt <code>anEntity</code> in freemarker-Struktur um, mischt die Daten mit
72 * Template <code>templateFilename</code> und gibt das Ergebnis an den PrintWriter
75 * @param templateFilename
78 * @exception HTMLParseException
81 public static void process(String templateFilename, Entity anEntity, PrintWriter out)
82 throws HTMLParseException {
83 if (anEntity == null) throw new HTMLParseException("Entity leer!");
84 else process(templateFilename, anEntity, out);
89 * Wandelt Liste mit Entities <code>entList</code> in freemarker-Struktur um, mischt die Daten mit
90 * Template <code>templateFilename</code> und gibt das Ergebnis an den PrintWriter
93 * @param templateFilename
96 * @exception HTMLParseException
98 public static void process(HttpServletResponse res,String templateFilename, EntityList entList, PrintWriter out)
99 throws HTMLParseException {
100 process(res, templateFilename, entList, (String)null, (TemplateModelRoot)null, out);
104 * Wandelt Entitylist in freemarker-Struktur um, fügt <code>additionalModel</code>
105 * unter dem Namen <code>additionalModelName</code> ein und mischt die Daten mit
106 * Template <code>templateFilename</code> und gibt das Ergebnis an den PrintWriter
109 * @param templateFilename
111 * @param additionalModelName
112 * @param additionalModel
114 * @exception HTMLParseException
116 public static void process(HttpServletResponse res,String templateFilename, EntityList entList, String additionalModelName,
117 TemplateModelRoot additionalModel, PrintWriter out)
118 throws HTMLParseException {
120 SimpleHash modelRoot = new SimpleHash();
122 if (entList == null) {
123 //theLog.printInfo("Keine Daten! Suche erfolglos.");
124 process(null,templateFilename, modelRoot, out);
127 modelRoot = makeSimpleHashWithEntitylistInfos(entList);
129 // Hilfskruecke um mal ein Popup mit reinzunhemen ..
130 if (additionalModelName != null && additionalModel != null)
131 modelRoot.put(additionalModelName, additionalModel);
133 process(res,templateFilename, modelRoot, out);
134 } catch (StorageObjectException e) {
135 throw new HTMLParseException(e.toString());
141 * Wandelt HashMap <code>mergeData</code> in freemarker-Struktur und mischt diese mit
142 * Template <code>templateFilename</code> und gibt das Ergebnis an den PrintWriter
145 * @param templateFilename
148 * @exception HTMLParseException
150 public static void process(HttpServletResponse res,String templateFilename, HashMap mergeData, PrintWriter out)
151 throws HTMLParseException {
152 process(res,templateFilename, makeSimpleHash(mergeData), out);
156 * Gibt Template <code>templateFilename</code> an den PrintWriter
159 * @param templateFilename
162 * @exception HTMLParseException
164 public static void process(String templateFilename, PrintWriter out)
165 throws HTMLParseException {
166 process(null,templateFilename, (TemplateModelRoot)null, out);
171 * Mischt die freemarker-Struktur <code>tmr</code> mit
172 * Template <code>templateFilename</code> und gibt das Ergebnis an den PrintWriter
175 * @param templateFilename
178 * @exception HTMLParseException
180 public static void process(HttpServletResponse res,String templateFilename, TemplateModelRoot tmr, PrintWriter out)
181 throws HTMLParseException {
182 if (out==null) throw new HTMLParseException("KEIN OUTPUTSTREAM");
183 Template tmpl = getTemplateFor(templateFilename);
184 if (tmpl == null) throw new HTMLParseException("KEIN TEMPLATE: " + templateFilename);
185 if (tmr==null) tmr = new SimpleHash();
188 session=res.encodeURL("");
191 // put standard configuration into tempalteRootmodel
192 SimpleHash configHash = new SimpleHash();
193 configHash.put("docroot", new SimpleScalar(producerDocRoot));
194 configHash.put("storageroot", new SimpleScalar(producerStorageRoot));
195 configHash.put("productionhost", new SimpleScalar(productionHost));
196 configHash.put("openaction", new SimpleScalar(openAction));
199 tmr.put("docRoot", new SimpleScalar(docRoot));
200 tmr.put("now", new SimpleScalar(StringUtil.date2readableDateTime(new GregorianCalendar())));
201 tmr.put("actionRoot", new SimpleScalar(actionRoot+session));
202 tmr.put("openAction", new SimpleScalar(openAction));
203 tmr.put("productionHost", new SimpleScalar(productionHost));
204 tmr.put("videoHost", new SimpleScalar(videoHost));
205 tmr.put("audioHost", new SimpleScalar(audioHost));
206 tmr.put("imageHost", new SimpleScalar(imageHost));
208 tmr.put("config", configHash);
209 tmpl.process(tmr, out);
215 * Wandelt eine Entity-Liste in eine SimpleList von SimpleHashes um.
216 * @param aList ist eine Liste von Entity
217 * @return eine freemarker.template.SimpleList von SimpleHashes.
219 public static SimpleList makeSimpleList(EntityList aList) throws StorageObjectException
221 SimpleList simpleList = new SimpleList();
223 for(int i=0;i<aList.size();i++){
224 simpleList.add(makeSimpleHash(aList.elementAt(i)));
231 * Konvertiert ein EntityList in ein freemarker.template.SimpleHash-Modell. Im Hash
232 * sind die einzelnen Entities ueber ihre id zu erreichen.
233 * @param aList ist die EntityList
234 * @return SimpleHash mit den entsprechenden freemarker Daten
237 public static SimpleHash makeSimpleHash(EntityList aList) throws StorageObjectException
239 SimpleHash simpleHash = new SimpleHash();
240 Entity currentEntity;
243 for (int i=0;i<aList.size();i++) {
244 currentEntity = (Entity)aList.elementAt(i);
245 simpleHash.put(currentEntity.getId(), makeSimpleHash(currentEntity));
252 * Konvertiert ein Entity in ein freemarker.template.SimpleHash-Modell
253 * @param entity ist die Entity
254 * @return SimpleHash mit den entsprechenden freemarker Daten
257 public static SimpleHash makeSimpleHash(Entity entity) {
258 if (entity != null) {
259 return makeSimpleHash(entity.getValues());
262 //theLog.printWarning("Entity ist <null>");
268 * Konvertiert ein Hashtable mit den keys und values als String
269 * in ein freemarker.template.SimpleHash-Modell
270 * @param mergeData der HashMap mit den String / String Daten
271 * @return SimpleHash mit den entsprechenden freemarker Daten
274 public static SimpleHash makeSimpleHash(HashMap mergeData)
276 SimpleHash modelRoot = new SimpleHash();
278 if (mergeData != null) {
279 Set set = mergeData.keySet();
280 Iterator it = set.iterator();
281 for (int i=0; i<set.size();i++) {
282 aField = (String)it.next();
283 modelRoot.put(aField, (String)mergeData.get(aField));
291 * Wandelt EntityListe in SimpleHash um, und versieht die Liste mit StandardInfos,
292 * die aus EntityList kommen.
295 * @return SimpleHash mit Entity-Daten und ZusatzInfos.
296 * @exception StorageObjectException
298 public static SimpleHash makeSimpleHashWithEntitylistInfos(EntityList entList) throws StorageObjectException {
299 SimpleHash modelRoot = new SimpleHash();
301 modelRoot.put("contentlist", makeSimpleList(entList));
302 modelRoot.put("count", new SimpleScalar((new Integer(entList.getCount())).toString()));
303 if (entList.getWhere()!=null) {
304 modelRoot.put("where", new SimpleScalar(entList.getWhere()));
305 modelRoot.put("where_encoded", new SimpleScalar(URLEncoder.encode(entList.getWhere())));
308 if(entList.getOrder()!=null) {
309 modelRoot.put("order", new SimpleScalar(entList.getOrder()));
310 modelRoot.put("order_encoded", new SimpleScalar(URLEncoder.encode(entList.getOrder())));
312 modelRoot.put("from", new SimpleScalar((new Integer(entList.getFrom())).toString()));
313 modelRoot.put("to", new SimpleScalar((new Integer(entList.getTo())).toString()));
315 if (entList.hasNextBatch())
316 modelRoot.put("next", new SimpleScalar((new Integer(entList.getNextBatch())).toString()));
317 if (entList.hasPrevBatch())
318 modelRoot.put("prev", new SimpleScalar((new Integer(entList.getPrevBatch())).toString()));
324 * Private Methode, um für templateFilename das Template zu bekommen.
325 * @param templateFilename
327 * @exception HTMLParseException
329 private static Template getTemplateFor(String templateFilename) throws HTMLParseException
331 if (templateFilename!=null) return templateCache.getTemplate(templateFilename);
333 theLog.printError("CACHE (ERR): Unknown template: " + templateFilename);
334 throw new HTMLParseException("Templatedatei: "+ templateFilename + " nicht gefunden!");
339 public static void stopAutoUpdate(){
340 templateCache.stopAutoUpdate();