X-Git-Url: http://erislabs.net/gitweb/?a=blobdiff_plain;f=source%2Fmir%2Fmisc%2FHTMLTemplateProcessor.java;h=3f014cc396fcf1e58ca29a565915a2fbc019cb33;hb=d388c9c6286a9d9dda70e05535d5321fc20ef1c8;hp=70ec150daf5a71033f654563a918698c071294ca;hpb=5bf2a1fa11c1529a731ab6b4521b8254c1fa100f;p=mir.git
diff --git a/source/mir/misc/HTMLTemplateProcessor.java b/source/mir/misc/HTMLTemplateProcessor.java
index 70ec150d..3f014cc3 100755
--- a/source/mir/misc/HTMLTemplateProcessor.java
+++ b/source/mir/misc/HTMLTemplateProcessor.java
@@ -1,17 +1,48 @@
/*
- * put your module comment here
+ * Copyright (C) 2001, 2002 The Mir-coders group
+ *
+ * This file is part of Mir.
+ *
+ * Mir is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * Mir is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Mir; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+ *
+ * In addition, as a special exception, The Mir-coders gives permission to link
+ * the code of this program with the com.oreilly.servlet library, any library
+ * licensed under the Apache Software License, The Sun (tm) Java Advanced
+ * Imaging library (JAI), The Sun JIMI library (or with modified versions of
+ * the above that use the same license as the above), and distribute linked
+ * combinations including the two. You must obey the GNU General Public
+ * License in all respects for all of the code used other than the above
+ * mentioned libraries. If you modify this file, you may extend this exception
+ * to your version of the file, but you are not obligated to do so. If you do
+ * not wish to do so, delete this exception statement from your version.
*/
-
package mir.misc;
-import java.lang.*;
-import java.util.*;
-import java.io.*;
-import java.net.*;
-import freemarker.template.*;
-import mir.entity.*;
-import mir.storage.*;
+import freemarker.template.*;
+import mir.util.*;
+import mir.generator.*;
+import mir.entity.Entity;
+import mir.entity.EntityList;
+import mir.storage.StorageObjectException;
+import org.apache.struts.util.MessageResources;
+
+import javax.servlet.http.HttpServletResponse;
+import java.io.PrintWriter;
+import java.net.URLEncoder;
+import java.util.*;
/**
@@ -19,325 +50,373 @@ import mir.storage.*;
*/
public final class HTMLTemplateProcessor {
- public static String templateDir;
- private static FileTemplateCache templateCache;
- private static Logfile theLog;
- private static String docRoot;
- private static String actionRoot;
- private static String productionHost;
- private static String audioHost;
- private static String videoHost;
- private static String imageHost;
- private static String openAction;
- protected static String producerDocRoot = Configuration.getProperty("Producer.DocRoot");
- protected static String producerStorageRoot = Configuration.getProperty("Producer.StorageRoot");
-
-
- //
- // Initialisierung
-
- static {
- templateDir = Configuration.getProperty("Home") + Configuration.getProperty("HTMLTemplateProcessor.Dir");
- templateCache = new FileTemplateCache(templateDir);
- templateCache.setLoadingPolicy(templateCache.LOAD_ON_DEMAND);
- //templateCache.startAutoUpdate();
- theLog = Logfile.getInstance(Configuration.getProperty("Home") + Configuration.getProperty("HTMLTemplateProcessor.Logfile"));
- docRoot = Configuration.getProperty("HTMLTemplateProcessor.DocRoot");
- actionRoot = Configuration.getProperty("HTMLTemplateProcessor.ActionRoot");
- openAction = Configuration.getProperty("Producer.OpenAction");
- productionHost = Configuration.getProperty("Producer.ProductionHost");
- videoHost = Configuration.getProperty("Producer.VideoHost");
- audioHost = Configuration.getProperty("Producer.AudioHost");
- imageHost = Configuration.getProperty("Producer.Image.Host");
- producerDocRoot = Configuration.getProperty("Producer.DocRoot");
- producerStorageRoot = Configuration.getProperty("Producer.StorageRoot");
-
-
- }
-
- /**
- * Privater Konstruktor, um versehentliche Instantiierung zu verhindern
- */
- private HTMLTemplateProcessor () {
- }
-
-
- //
- // process-Methoden zum Mischen verschiedener Datenstrukturen mit HTML-Templates
-
-
- /**
- * Wandelt anEntity in freemarker-Struktur um, mischt die Daten mit
- * Template templateFilename und gibt das Ergebnis an den PrintWriter
- * out
- *
- * @param templateFilename
- * @param anEntity
- * @param out
- * @exception HTMLParseException
- */
-
- public static void process(String templateFilename, Entity anEntity, PrintWriter out)
- throws HTMLParseException {
- if (anEntity == null) throw new HTMLParseException("Entity leer!");
- else process(templateFilename, anEntity, out);
- }
-
-
- /**
- * Wandelt Liste mit Entities entList in freemarker-Struktur um, mischt die Daten mit
- * Template templateFilename und gibt das Ergebnis an den PrintWriter
- * out
- *
- * @param templateFilename
- * @param entList
- * @param out
- * @exception HTMLParseException
- */
- public static void process(String templateFilename, EntityList entList, PrintWriter out)
- throws HTMLParseException {
- process( templateFilename, entList, (String)null, (TemplateModelRoot)null, out);
- }
-
- /**
- * Wandelt Entitylist in freemarker-Struktur um, fügt additionalModel
- * unter dem Namen additionalModelName ein und mischt die Daten mit
- * Template templateFilename und gibt das Ergebnis an den PrintWriter
- * out
- *
- * @param templateFilename
- * @param entList
- * @param additionalModelName
- * @param additionalModel
- * @param out
- * @exception HTMLParseException
- */
- public static void process(String templateFilename, EntityList entList, String additionalModelName,
- TemplateModelRoot additionalModel, PrintWriter out)
- throws HTMLParseException {
-
- SimpleHash modelRoot = new SimpleHash();
-
- if (entList == null) {
- //theLog.printInfo("Keine Daten! Suche erfolglos.");
- process(templateFilename, modelRoot, out);
- } else {
- try {
- modelRoot = makeSimpleHashWithEntitylistInfos(entList);
- //
- // Hilfskruecke um mal ein Popup mit reinzunhemen ..
- if (additionalModelName != null && additionalModel != null)
- modelRoot.put(additionalModelName, additionalModel);
-
- process(templateFilename, modelRoot, out);
- } catch (StorageObjectException e) {
- throw new HTMLParseException(e.toString());
- }
- }
- }
-
- /**
- * Wandelt HashMap mergeData in freemarker-Struktur und mischt diese mit
- * Template templateFilename und gibt das Ergebnis an den PrintWriter
- * out
- *
- * @param templateFilename
- * @param mergeData
- * @param out
- * @exception HTMLParseException
- */
- public static void process(String templateFilename, HashMap mergeData, PrintWriter out)
- throws HTMLParseException {
- process(templateFilename, makeSimpleHash(mergeData), out);
- }
-
- /**
- * Gibt Template templateFilename an den PrintWriter
- * out
- *
- * @param templateFilename
- * @param mergeData
- * @param out
- * @exception HTMLParseException
- */
- public static void process(String templateFilename, PrintWriter out)
- throws HTMLParseException {
- process(templateFilename, (TemplateModelRoot)null, out);
- }
-
-
- /**
- * Mischt die freemarker-Struktur tmr mit
- * Template templateFilename und gibt das Ergebnis an den PrintWriter
- * out
- *
- * @param templateFilename
- * @param mergeData
- * @param out
- * @exception HTMLParseException
- */
- public static void process(String templateFilename, TemplateModelRoot tmr, PrintWriter out)
- throws HTMLParseException {
- if (out==null) throw new HTMLParseException("KEIN OUTPUTSTREAM");
- Template tmpl = getTemplateFor(templateFilename);
- if (tmpl == null) throw new HTMLParseException("KEIN TEMPLATE: " + templateFilename);
- if (tmr==null) tmr = new SimpleHash();
-
- //some utilities
- SimpleHash utilityHash = new SimpleHash();
- utilityHash.put("htmlEscape",new freemarker.template.utility.HtmlEscape());
-
- // put standard configuration into tempalteRootmodel
- SimpleHash configHash = new SimpleHash();
- configHash.put("docroot", new SimpleScalar(producerDocRoot));
- configHash.put("storageroot", new SimpleScalar(producerStorageRoot));
- configHash.put("productionhost", new SimpleScalar(productionHost));
- configHash.put("openaction", new SimpleScalar(openAction));
-
-
- tmr.put("docRoot", new SimpleScalar(docRoot));
- tmr.put("now", new SimpleScalar(StringUtil.date2readableDateTime(new GregorianCalendar())));
- tmr.put("actionRoot", new SimpleScalar(actionRoot));
- tmr.put("openAction", new SimpleScalar(openAction));
- tmr.put("productionHost", new SimpleScalar(productionHost));
- tmr.put("videoHost", new SimpleScalar(videoHost));
- tmr.put("audioHost", new SimpleScalar(audioHost));
- tmr.put("imageHost", new SimpleScalar(imageHost));
-
- tmr.put("config", configHash);
- tmr.put("utility",utilityHash);
- tmpl.process(tmr, out);
-
- }
-
-
- /**
- * Wandelt eine Entity-Liste in eine SimpleList von SimpleHashes um.
- * @param aList ist eine Liste von Entity
- * @return eine freemarker.template.SimpleList von SimpleHashes.
- */
- public static SimpleList makeSimpleList(EntityList aList) throws StorageObjectException
- {
- SimpleList simpleList = new SimpleList();
- if (aList != null) {
- for(int i=0;i");
- return null;
- }
- }
-
- /**
- * Konvertiert ein Hashtable mit den keys und values als String
- * in ein freemarker.template.SimpleHash-Modell
- * @param mergeData der HashMap mit den String / String Daten
- * @return SimpleHash mit den entsprechenden freemarker Daten
- *
- */
- public static SimpleHash makeSimpleHash(HashMap mergeData)
- {
- SimpleHash modelRoot = new SimpleHash();
- String aField;
- if (mergeData != null) {
- Set set = mergeData.keySet();
- Iterator it = set.iterator();
- for (int i=0; ianEntity in freemarker-Struktur um, mischt die Daten mit
+ * Template templateFilename und gibt das Ergebnis an den PrintWriter
+ * out
+ *
+ * @param templateFilename
+ * @param anEntity
+ * @param out
+ * @exception HTMLParseException
+ */
+
+ public static void process(String templateFilename, Entity anEntity, PrintWriter out)
+ throws HTMLParseException {
+ if (anEntity == null)
+ throw new HTMLParseException("entity is empty!");
+ else
+ process(templateFilename, anEntity, out);
+ }
+
+
+ /**
+ * Wandelt Liste mit Entities entList in freemarker-Struktur um, mischt die Daten mit
+ * Template templateFilename und gibt das Ergebnis an den PrintWriter
+ * out
+ *
+ * @param templateFilename
+ * @param entList
+ * @param out
+ * @exception HTMLParseException
+ */
+ public static void process(HttpServletResponse res, String templateFilename,
+ EntityList entList, PrintWriter out, Locale locale)
+ throws HTMLParseException {
+ process(res, templateFilename, entList, (String) null, (TemplateModelRoot) null, out, locale);
+ }
+
+ /**
+ * Wandelt Entitylist in freemarker-Struktur um, fügt additionalModel
+ * unter dem Namen additionalModelName ein und mischt die Daten mit
+ * Template templateFilename und gibt das Ergebnis an den PrintWriter
+ * out
+ *
+ * @param templateFilename
+ * @param entList
+ * @param additionalModelName
+ * @param additionalModel
+ * @param out
+ * @exception HTMLParseException
+ */
+ public static void process(HttpServletResponse res, String templateFilename,
+ EntityList entList, String additionalModelName,
+ TemplateModelRoot additionalModel, PrintWriter out,
+ Locale locale)
+ throws HTMLParseException {
+
+ SimpleHash modelRoot = new SimpleHash();
+
+ if (entList == null) {
+ process(null, templateFilename, modelRoot, out, locale);
+ } else {
+ try {
+ modelRoot = makeSimpleHashWithEntitylistInfos(entList);
+
+ // Quickhack um mal ein Popup mit reinzunhemen ..
+ if (additionalModelName != null && additionalModel != null)
+ modelRoot.put(additionalModelName, additionalModel);
+
+ process(res, templateFilename, modelRoot, out, locale);
+ } catch (StorageObjectException e) {
+ throw new HTMLParseException(e.toString());
+ }
+ }
+ }
+
+ /**
+ * Wandelt HashMap mergeData in freemarker-Struktur und mischt diese mit
+ * Template templateFilename und gibt das Ergebnis an den PrintWriter
+ * out
+ *
+ * @param templateFilename
+ * @param mergeData - a HashMap with mergeData to be converted in SimpleHash
+ * @param out
+ * @exception HTMLParseException
+ */
+ public static void process(HttpServletResponse res, String templateFilename,
+ HashMap mergeData, PrintWriter out, Locale locale)
+ throws HTMLParseException {
+ process(res, templateFilename, makeSimpleHash(mergeData), out, locale);
+ }
+
+ /**
+ * Gibt Template templateFilename an den PrintWriter
+ * out
+ *
+ * @param templateFilename
+ * @param mergeData
+ * @param out
+ * @exception HTMLParseException
+ */
+ public static void process(String templateFilename, PrintWriter out,
+ Locale locale)
+ throws HTMLParseException {
+ process(null, templateFilename, (TemplateModelRoot) null, out, locale);
+ }
+
+
+ /**
+ * Mischt die freemarker-Struktur tmr mit
+ * Template templateFilename und gibt das Ergebnis an den PrintWriter
+ * out
+ *
+ * @param templateFilename
+ * @param mergeData
+ * @param out
+ * @exception HTMLParseException
+ */
+ public static void process(HttpServletResponse res, String templateFilename,
+ TemplateModelRoot tmr, PrintWriter out, Locale locale)
+ throws HTMLParseException {
+ process(res, templateFilename, tmr, null, out, locale, "bundles.admin");
+ // this method is
}
+
+ /**
+ * Mischt die freemarker-Struktur tmr mit
+ * Template templateFilename und gibt das Ergebnis an den PrintWriter
+ * out
+ *
+ * @param templateFilename
+ * @param mergeData
+ * @param out
+ * @exception HTMLParseException
+ */
+ public static void process(HttpServletResponse res, String templateFilename,
+ TemplateModelRoot tmr, TemplateModelRoot extra,
+ PrintWriter out, Locale locale, String bundles)
+ throws HTMLParseException {
+ if (out == null) throw new HTMLParseException("no outputstream");
+ Template tmpl = getTemplateFor(templateFilename);
+ if (tmpl == null) throw new HTMLParseException("no template: " + templateFilename);
+ if (tmr == null) tmr = new SimpleHash();
+
+ /** @todo what is this for? (rk) */
+ String session = "";
+ if (res != null) {
+ session = res.encodeURL("");
+ }
+
+ SimpleHash configHash = new SimpleHash();
+
+ // pass the whole config hash to the templates
+ Enumeration en = MirConfig.getResourceKeys();
+ String key;
+ while (en.hasMoreElements()) {
+ key = (String) en.nextElement();
+ configHash.put(key, new SimpleScalar(MirConfig.getProp(key)));
+ }
+
+ // this does not come directly from the config file
+ configHash.put("docRoot", new SimpleScalar(docRoot));
+ configHash.put("actionRoot", new SimpleScalar(actionRoot + session));
+ configHash.put("now", new SimpleScalar(StringUtil.date2readableDateTime(new GregorianCalendar())));
+
+ // this conform to updated freemarker syntax
+ configHash.put("compressWhitespace", new freemarker.template.utility.CompressWhitespace());
+
+ SimpleHash utilityHash = new SimpleHash();
+ try {
+ utilityHash.put("compressWhitespace", new freemarker.template.utility.CompressWhitespace());
+ utilityHash.put("encodeURI", FreemarkerGenerator.makeAdapter(new GeneratorHTMLFunctions.encodeURIGeneratorFunction()));
+ utilityHash.put("encodeHTML", FreemarkerGenerator.makeAdapter(new GeneratorHTMLFunctions.encodeHTMLGeneratorFunction()));
+ }
+ catch (Throwable t) {
+ throw new HTMLParseException(t.getMessage());
+ }
+
+
+ SimpleHash outPutHash = new SimpleHash();
+
+ if (extra != null) {
+ outPutHash.put("extra", extra);
+ try {
+ while (((SimpleList) extra).hasNext()) {
+ theLog.printDebugInfo(((SimpleList) extra).next().toString());
+ }
+ } catch (Exception e) {
+ }
+ }
+ outPutHash.put("data", tmr);
+ outPutHash.put("config", configHash);
+ outPutHash.put("utility", utilityHash);
+
+ MessageResources messages = MessageResources.getMessageResources(bundles);
+ outPutHash.put("lang", new MessageMethodModel(locale, messages));
+
+ tmpl.process(outPutHash, out);
+ }
+
+
+ /**
+ * Converts Entity-List to SimpleList of SimpleHashes.
+ * @param aList ist eine Liste von Entity
+ * @return eine freemarker.template.SimpleList von SimpleHashes.
+ *
+ * @deprecated EntityLists comply with TemplateListModel now.
+ */
+ public static SimpleList makeSimpleList(EntityList aList) throws StorageObjectException {
+ theLog.printWarning("## using deprecated makeSimpleList(entityList) - a waste of resources");
+ SimpleList simpleList = new SimpleList();
+ if (aList != null) {
+ for (int i = 0; i < aList.size(); i++) {
+ simpleList.add(aList.elementAt(i));
+ }
+ }
+ return simpleList;
+ }
+
+ /**
+ * Konvertiert ein EntityList in ein freemarker.template.SimpleHash-Modell. Im Hash
+ * sind die einzelnen Entities ueber ihre id zu erreichen.
+ * @param aList ist die EntityList
+ * @return SimpleHash mit den entsprechenden freemarker Daten
+ *
+ */
+ public static SimpleHash makeSimpleHash(EntityList aList) throws StorageObjectException {
+ SimpleHash simpleHash = new SimpleHash();
+ Entity currentEntity;
+
+ if (aList != null) {
+ for (int i = 0; i < aList.size(); i++) {
+ currentEntity = (Entity) aList.elementAt(i);
+ simpleHash.put(currentEntity.getId(), currentEntity);
+ }
+ }
+ return simpleHash;
+ }
+
+ /**
+ * Konvertiert ein Entity in ein freemarker.template.SimpleHash-Modell
+ * @param entity ist die Entity
+ * @return SimpleHash mit den entsprechenden freemarker Daten
+ *
+ * @deprecated This method is deprecated and will be deleted in the next
+ * release. Entity interfaces freemarker.template.TemplateHashModel now
+ * and can be used in the same way as SimpleHash. It is not necessary any
+ * more to make a SimpleHash from an Entity
+ */
+ public static SimpleHash makeSimpleHash(Entity entity) {
+ if (entity != null) {
+ theLog.printWarning("## using deprecated makeSimpleHash(entity) - a waste of resources");
+ return makeSimpleHash(entity.getValues());
+ } else
+ return null;
+ }
+
+ /**
+ * Konvertiert ein Hashtable mit den keys und values als String
+ * in ein freemarker.template.SimpleHash-Modell
+ * @param mergeData der HashMap mit den String / String Daten
+ * @return SimpleHash mit den entsprechenden freemarker Daten
+ *
+ */
+ public static SimpleHash makeSimpleHash(HashMap mergeData) {
+ SimpleHash modelRoot = new SimpleHash();
+ String aField;
+ if (mergeData != null) {
+ Set set = mergeData.keySet();
+ Iterator it = set.iterator();
+ for (int i = 0; i < set.size(); i++) {
+ aField = (String) it.next();
+ modelRoot.put(aField, (String) mergeData.get(aField));
+ }
+ }
+ return modelRoot;
+ }
+
+
+ /**
+ * Converts EntityList in SimpleHash and adds additional information
+ * to the returned SimpleHash
+ *
+ * @param entList
+ * @return SimpleHash returns SimpleHash with the converted EntityList plus
+ * additional Data about the list.
+ * @exception StorageObjectException
+ */
+
+ public static SimpleHash makeSimpleHashWithEntitylistInfos(EntityList entList) throws StorageObjectException {
+ SimpleHash modelRoot = new SimpleHash();
+ if (entList != null) {
+ modelRoot.put("contentlist", entList);
+ modelRoot.put("count", new SimpleScalar((new Integer(entList.getCount())).toString()));
+ if (entList.getWhere() != null) {
+ modelRoot.put("where", new SimpleScalar(entList.getWhere()));
+ modelRoot.put("where_encoded", new SimpleScalar(URLEncoder.encode(entList.getWhere())));
+ }
+ if (entList.getOrder() != null) {
+ modelRoot.put("order", new SimpleScalar(entList.getOrder()));
+ modelRoot.put("order_encoded", new SimpleScalar(URLEncoder.encode(entList.getOrder())));
+ }
+ modelRoot.put("from", new SimpleScalar((new Integer(entList.getFrom())).toString()));
+ modelRoot.put("to", new SimpleScalar((new Integer(entList.getTo())).toString()));
+
+ if (entList.hasNextBatch())
+ modelRoot.put("next", new SimpleScalar((new Integer(entList.getNextBatch())).toString()));
+ if (entList.hasPrevBatch())
+ modelRoot.put("prev", new SimpleScalar((new Integer(entList.getPrevBatch())).toString()));
+ }
+ return modelRoot;
+ }
+
+ /**
+ * Private methods to get template from a templateFilename
+ * @param templateFilename
+ * @return Template
+ * @exception HTMLParseException
+ */
+ private static Template getTemplateFor(String templateFilename) throws HTMLParseException {
+ Template returnTemplate = null;
+ if (templateFilename != null)
+ returnTemplate = (Template) templateCache.getItem(templateFilename, "template");
+
+
+ if (returnTemplate == null) {
+ theLog.printError("CACHE (ERR): Unknown template: " + templateFilename);
+ throw new HTMLParseException("Templatefile: " + templateFilename + " not found.");
+ }
+
+ return returnTemplate;
+ }
+
+ public static void stopAutoUpdate() {
+ templateCache.stopAutoUpdate();
+ templateCache = null;
+ }
+
}