source/mir/misc/HTMLTemplateProcessor.java

   1 /*
   2  * put your module comment here
   3  */
   4
   5
   6 package mir.misc;
   7
   8 import  java.lang.*;
   9 import  java.util.*;
  10 import  java.io.*;
  11 import  java.net.*;
  12 import  freemarker.template.*;
  13 import  mir.entity.*;
  14 import  mir.storage.*;
  15 import javax.servlet.http.*;
  16
  17
  18 /**
  19  * Hilfsklasse zum Mergen von Template und Daten
  20  */
  21 public final class HTMLTemplateProcessor {
  22
  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 = MirConfig.getProp("Producer.DocRoot");
  34   protected static String producerStorageRoot = MirConfig.getProp("Producer.StorageRoot");
  35
  36
  37   //
  38   // init
  39
  40   static {
  41
  42     templateDir = MirConfig.getPropWithHome("HTMLTemplateProcessor.Dir");
  43     templateCache = new FileTemplateCache(templateDir);
  44     templateCache.setLoadingPolicy(templateCache.LOAD_ON_DEMAND);
  45     templateCache.startAutoUpdate();
  46     theLog = Logfile.getInstance(MirConfig.getPropWithHome("HTMLTemplateProcessor.Logfile"));
  47     docRoot = MirConfig.getProp("RootUri");
  48     actionRoot = docRoot + "/servlet/" + MirConfig.getProp("ServletName");
  49
  50     openAction = MirConfig.getProp("Producer.OpenAction");
  51     productionHost = MirConfig.getProp("Producer.ProductionHost");
  52     videoHost = MirConfig.getProp("Producer.VideoHost");
  53     audioHost = MirConfig.getProp("Producer.AudioHost");
  54     imageHost = MirConfig.getProp("Producer.Image.Host");
  55     producerDocRoot = MirConfig.getProp("Producer.DocRoot");
  56     producerStorageRoot = MirConfig.getProp("Producer.StorageRoot");
  57
  58   }
  59
  60   /**
  61    * empty private constructor, to avoid instantiation
  62    */
  63   private HTMLTemplateProcessor () { }
  64
  65
  66   // process-methods to merge different datastructures
  67   // with freemarker templates
  68
  69
  70   /**
  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
  73    * <code>out</code>
  74    *
  75    * @param templateFilename
  76    * @param anEntity
  77    * @param out
  78    * @exception HTMLParseException
  79    */
  80
  81     public static void process(String templateFilename, Entity anEntity, PrintWriter out)
  82       throws HTMLParseException {
  83         if (anEntity == null)  throw new HTMLParseException("entity is empty!");
  84         else process(templateFilename, anEntity, out);
  85     }
  86
  87
  88   /**
  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
  91    * <code>out</code>
  92    *
  93    * @param templateFilename
  94    * @param entList
  95    * @param out
  96    * @exception HTMLParseException
  97    */
  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);
 101   }
 102
 103   /**
 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
 107    * <code>out</code>
 108    *
 109    * @param templateFilename
 110    * @param entList
 111    * @param additionalModelName
 112    * @param additionalModel
 113    * @param out
 114    * @exception HTMLParseException
 115    */
 116     public static void process(HttpServletResponse res,String templateFilename, EntityList entList, String additionalModelName,
 117              TemplateModelRoot additionalModel, PrintWriter out)
 118       throws HTMLParseException {
 119
 120       SimpleHash modelRoot = new SimpleHash();
 121
 122       if (entList == null) {
 123          process(null,templateFilename, modelRoot, out);
 124       } else {
 125         try {
 126           modelRoot = makeSimpleHashWithEntitylistInfos(entList);
 127
 128           // Quickhack um mal ein Popup mit reinzunhemen ..
 129           if (additionalModelName != null && additionalModel != null)
 130               modelRoot.put(additionalModelName, additionalModel);
 131
 132           process(res,templateFilename, modelRoot, out);
 133         } catch (StorageObjectException e) {
 134           throw new HTMLParseException(e.toString());
 135         }
 136       }
 137     }
 138
 139   /**
 140    * Wandelt HashMap <code>mergeData</code> in freemarker-Struktur und mischt diese mit
 141    * Template <code>templateFilename</code> und gibt das Ergebnis an den PrintWriter
 142    * <code>out</code>
 143    *
 144    * @param templateFilename
 145    * @param mergeData - a HashMap with mergeData to be converted in SimpleHash
 146    * @param out
 147    * @exception HTMLParseException
 148    */
 149     public static void process(HttpServletResponse res,String templateFilename, HashMap mergeData, PrintWriter out)
 150       throws HTMLParseException {
 151       process(res,templateFilename, makeSimpleHash(mergeData), out);
 152     }
 153
 154   /**
 155    * Gibt Template <code>templateFilename</code> an den PrintWriter
 156    * <code>out</code>
 157    *
 158    * @param templateFilename
 159    * @param mergeData
 160    * @param out
 161    * @exception HTMLParseException
 162    */
 163     public static void process(String templateFilename, PrintWriter out)
 164       throws HTMLParseException {
 165       process(null,templateFilename, (TemplateModelRoot)null, out);
 166     }
 167
 168
 169   /**
 170    * Mischt die freemarker-Struktur <code>tmr</code> mit
 171    * Template <code>templateFilename</code> und gibt das Ergebnis an den PrintWriter
 172    * <code>out</code>
 173    *
 174    * @param templateFilename
 175    * @param mergeData
 176    * @param out
 177    * @exception HTMLParseException
 178    */
 179     public static void process(HttpServletResponse res,String templateFilename, TemplateModelRoot tmr, PrintWriter out)
 180       throws HTMLParseException {
 181       if (out==null) throw new HTMLParseException("no outputstream");
 182       Template tmpl = getTemplateFor(templateFilename);
 183       if (tmpl == null) throw new HTMLParseException("no template: " + templateFilename);
 184       if (tmr==null) tmr = new SimpleHash();
 185
 186       /** @todo  what is this for? (rk) */
 187       String session="";
 188       if (res!=null) {
 189         session=res.encodeURL("");
 190       }
 191
 192       // put standard configuration into tempalteRootmodel
 193       SimpleHash configHash = new SimpleHash();
 194       configHash.put("docroot", new SimpleScalar(producerDocRoot));
 195       configHash.put("storageroot", new SimpleScalar(producerStorageRoot));
 196       configHash.put("productionhost", new SimpleScalar(productionHost));
 197       configHash.put("openaction", new SimpleScalar(openAction));
 198       configHash.put("actionRootLogin",new SimpleScalar(actionRoot));
 199
 200
 201       tmr.put("docRoot", new SimpleScalar(docRoot));
 202       tmr.put("now", new SimpleScalar(StringUtil.date2readableDateTime(new GregorianCalendar())));
 203       tmr.put("actionRoot", new SimpleScalar(actionRoot+session));
 204       tmr.put("openAction", new SimpleScalar(openAction));
 205       tmr.put("productionHost", new SimpleScalar(productionHost));
 206       tmr.put("videoHost", new SimpleScalar(videoHost));
 207       tmr.put("audioHost", new SimpleScalar(audioHost));
 208       tmr.put("imageHost", new SimpleScalar(imageHost));
 209
 210       tmr.put("config", configHash);
 211       tmpl.process(tmr, out);
 212
 213     }
 214
 215
 216   /**
 217    *   Converts Entity-List to SimpleList of SimpleHashes.
 218    *   @param aList ist eine Liste von Entity
 219    *   @return eine freemarker.template.SimpleList von SimpleHashes.
 220    */
 221   public static SimpleList makeSimpleList(EntityList aList) throws StorageObjectException
 222   {
 223     SimpleList  simpleList = new SimpleList();
 224     if (aList != null) {
 225       for(int i=0;i<aList.size();i++) {
 226         simpleList.add(makeSimpleHash(aList.elementAt(i)));
 227       }
 228     }
 229     return simpleList;
 230   }
 231
 232   /**
 233    *  Konvertiert ein EntityList in ein freemarker.template.SimpleHash-Modell. Im Hash
 234    *  sind die einzelnen Entities ueber ihre id zu erreichen.
 235    *  @param aList ist die EntityList
 236    *  @return SimpleHash mit den entsprechenden freemarker Daten
 237    *
 238    */
 239   public static SimpleHash makeSimpleHash(EntityList aList) throws StorageObjectException
 240   {
 241     SimpleHash      simpleHash = new SimpleHash();
 242     Entity          currentEntity;
 243
 244     if (aList != null) {
 245       for (int i=0;i<aList.size();i++) {
 246          currentEntity = (Entity)aList.elementAt(i);
 247          simpleHash.put(currentEntity.getId(), makeSimpleHash(currentEntity));
 248       }
 249     }
 250     return simpleHash;
 251   }
 252
 253   /**
 254    *  Konvertiert ein Entity in ein freemarker.template.SimpleHash-Modell
 255    *  @param entity ist die Entity
 256    *  @return SimpleHash mit den entsprechenden freemarker Daten
 257    *
 258    */
 259   public static SimpleHash makeSimpleHash(Entity entity) {
 260     if (entity != null)
 261       return makeSimpleHash(entity.getValues());
 262     else
 263       return null;
 264   }
 265
 266   /**
 267    *  Konvertiert ein Hashtable mit den keys und values als String
 268    *  in ein freemarker.template.SimpleHash-Modell
 269    *  @param mergeData der HashMap mit den String / String Daten
 270    *  @return SimpleHash mit den entsprechenden freemarker Daten
 271    *
 272    */
 273   public static SimpleHash makeSimpleHash(HashMap mergeData)
 274   {
 275     SimpleHash modelRoot = new SimpleHash();
 276     String aField;
 277     if (mergeData != null) {
 278       Set set = mergeData.keySet();
 279       Iterator it =  set.iterator();
 280       for (int i=0; i<set.size();i++)  {
 281         aField = (String)it.next();
 282         modelRoot.put(aField, (String)mergeData.get(aField));
 283       }
 284     }
 285     return modelRoot;
 286   }
 287
 288
 289   /**
 290    * Converts EntityList in SimpleHash and adds additional information
 291    * to the returned SimpleHash
 292    *
 293    * @param entList
 294    * @return SimpleHash returns SimpleHash with the converted EntityList plus
 295    *        additional Data about the list.
 296    * @exception StorageObjectException
 297    */
 298
 299   public static SimpleHash makeSimpleHashWithEntitylistInfos(EntityList entList) throws StorageObjectException {
 300     SimpleHash modelRoot = new SimpleHash();
 301     if (entList!=null) {
 302       modelRoot.put("contentlist", makeSimpleList(entList));
 303       modelRoot.put("count", new SimpleScalar((new Integer(entList.getCount())).toString()));
 304       if (entList.getWhere()!=null) {
 305         modelRoot.put("where", new SimpleScalar(entList.getWhere()));
 306         modelRoot.put("where_encoded", new SimpleScalar(URLEncoder.encode(entList.getWhere())));
 307       }
 308       if(entList.getOrder()!=null) {
 309         modelRoot.put("order", new SimpleScalar(entList.getOrder()));
 310         modelRoot.put("order_encoded", new SimpleScalar(URLEncoder.encode(entList.getOrder())));
 311       }
 312       modelRoot.put("from", new SimpleScalar((new Integer(entList.getFrom())).toString()));
 313       modelRoot.put("to", new SimpleScalar((new Integer(entList.getTo())).toString()));
 314
 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()));
 319     }
 320     return modelRoot;
 321   }
 322
 323   /**
 324    * Private methods to get template from a templateFilename
 325    * @param templateFilename
 326    * @return Template
 327    * @exception HTMLParseException
 328    */
 329   private static Template getTemplateFor(String templateFilename) throws HTMLParseException
 330   {
 331     if (templateFilename!=null) return templateCache.getTemplate(templateFilename);
 332     else {
 333       theLog.printError("CACHE (ERR): Unknown template: " + templateFilename);
 334       throw new HTMLParseException("Templatefile: "+ templateFilename + " not found.");
 335     }
 336   }
 337
 338   public static void stopAutoUpdate(){
 339     templateCache.stopAutoUpdate();
 340     templateCache=null;
 341   }
 342
 343 }