source/mir/generator/FreemarkerGenerator.java

   1 /*
   2  * Copyright (C) 2001, 2002 The Mir-coders group
   3  *
   4  * This file is part of Mir.
   5  *
   6  * Mir is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * Mir is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with Mir; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  *
  20  * In addition, as a special exception, The Mir-coders gives permission to link
  21  * the code of this program with  any library licensed under the Apache Software License,
  22  * The Sun (tm) Java Advanced Imaging library (JAI), The Sun JIMI library
  23  * (or with modified versions of the above that use the same license as the above),
  24  * and distribute linked combinations including the two.  You must obey the
  25  * GNU General Public License in all respects for all of the code used other than
  26  * the above mentioned libraries.  If you modify this file, you may extend this
  27  * exception to your version of the file, but you are not obligated to do so.
  28  * If you do not wish to do so, delete this exception statement from your version.
  29  */
  30 package mir.generator;
  31
  32 import java.io.File;
  33 import java.io.PrintWriter;
  34 import java.util.ArrayList;
  35 import java.util.Date;
  36 import java.util.HashMap;
  37 import java.util.Iterator;
  38 import java.util.List;
  39 import java.util.Map;
  40
  41 import mir.log.LoggerWrapper;
  42 import mir.util.GeneratorFormatAdapters;
  43 import mir.util.RewindableIterator;
  44
  45 import org.apache.commons.beanutils.MethodUtils;
  46 import org.apache.commons.beanutils.PropertyUtils;
  47
  48 import freemarker.template.FileTemplateCache;
  49 import freemarker.template.SimpleScalar;
  50 import freemarker.template.Template;
  51 import freemarker.template.TemplateHashModel;
  52 import freemarker.template.TemplateListModel;
  53 import freemarker.template.TemplateMethodModel;
  54 import freemarker.template.TemplateModel;
  55 import freemarker.template.TemplateModelException;
  56 import freemarker.template.TemplateModelRoot;
  57 import freemarker.template.TemplateScalarModel;
  58
  59
  60 public class FreemarkerGenerator implements Generator {
  61   private Template template;
  62
  63   public FreemarkerGenerator(Template aTemplate) {
  64     template = aTemplate;
  65   }
  66
  67   public void generate(Object anOutputWriter, Map aValues, LoggerWrapper aLogger) throws GeneratorExc, GeneratorFailure {
  68     if (!(anOutputWriter instanceof PrintWriter))
  69       throw new GeneratorExc("Writer for a FreemarkerGenerator must be a PrintWriter");
  70
  71     try {
  72       template.process((TemplateModelRoot) makeMapAdapter(aValues), (PrintWriter) anOutputWriter);
  73     }
  74     catch (Throwable t) {
  75       t.printStackTrace();
  76       aLogger.error("Exception occurred: "+t.getMessage());
  77       t.printStackTrace(aLogger.asPrintWriter(LoggerWrapper.DEBUG_MESSAGE));
  78       throw new GeneratorFailure( t );
  79     }
  80   }
  81
  82   private static TemplateScalarModel makeStringAdapter(String aString) {
  83     return new SimpleScalar(aString);
  84   }
  85
  86   private static TemplateHashModel makeMapAdapter(Map aMap)  {
  87     return new MapAdapter(aMap);
  88   }
  89
  90   private static TemplateListModel makeIteratorAdapter(Iterator anIterator) {
  91     return new IteratorAdapter(anIterator);
  92   }
  93
  94   private static TemplateMethodModel makeFunctionAdapter(Generator.Function aFunction) {
  95     return new FunctionAdapter(aFunction);
  96   }
  97
  98   private static TemplateHashModel makeBeanAdapter(Object anObject)  {
  99     return new BeanAdapter(anObject);
 100   }
 101
 102   public static TemplateModel makeAdapter(Object anObject) throws TemplateModelException {
 103     if (anObject == null)
 104       return null;
 105
 106     if (anObject instanceof TemplateModel)
 107       return (TemplateModel) anObject;
 108     else if (anObject instanceof Generator.Function)
 109       return makeFunctionAdapter((Generator.Function) anObject);
 110     else if (anObject instanceof Integer)
 111       return makeStringAdapter(anObject.toString());
 112     else if (anObject instanceof Boolean) {
 113       if (((Boolean) anObject).booleanValue())
 114         return makeStringAdapter("1");
 115       else
 116         return makeStringAdapter("0");
 117     }
 118     else if (anObject instanceof String)
 119       return makeStringAdapter((String) anObject);
 120     else if (anObject instanceof Map)
 121       return makeMapAdapter((Map) anObject);
 122     else if (anObject instanceof Iterator)
 123       return makeIteratorAdapter((Iterator) anObject);
 124     else if (anObject instanceof List)
 125       return makeIteratorAdapter(((List) anObject).iterator());
 126     else if (anObject instanceof Number)
 127       return makeAdapter(new GeneratorFormatAdapters.NumberFormatAdapter((Number) anObject));
 128     else if (anObject instanceof Date)
 129       return makeAdapter(new GeneratorFormatAdapters.DateFormatAdapter((Date) anObject));
 130     else
 131       return makeBeanAdapter(anObject);
 132   }
 133
 134   private static class MapAdapter implements TemplateModelRoot {
 135     private Map map;
 136     private Map valuesCache;
 137
 138     private MapAdapter(Map aMap) {
 139       map = aMap;
 140       valuesCache = new HashMap();
 141     }
 142
 143     public void put(String aKey, TemplateModel aModel) {
 144       valuesCache.put(aKey, aModel);
 145     }
 146
 147     public void remove(String aKey) {
 148     }
 149
 150     public boolean isEmpty() {
 151       return map.isEmpty();
 152     }
 153
 154     public TemplateModel get(String aKey) throws TemplateModelException {
 155       try {
 156         if (!valuesCache.containsKey(aKey)) {
 157           Object value = map.get(aKey);
 158
 159           if (value == null && !map.containsKey(aKey)) {
 160             throw new TemplateModelException("MapAdapter: no key "+aKey+" available");
 161           }
 162
 163           valuesCache.put(aKey, makeAdapter(value));
 164         }
 165
 166         return (TemplateModel) valuesCache.get(aKey);
 167       }
 168       catch (TemplateModelException e) {
 169         throw e;
 170       }
 171       catch (Throwable t) {
 172         throw new TemplateModelException(t.getMessage());
 173       }
 174     }
 175   }
 176
 177   private static class IteratorAdapter implements TemplateListModel {
 178     private Iterator iterator;
 179     private List valuesCache;
 180     private int position;
 181
 182     private IteratorAdapter(Iterator anIterator) {
 183       iterator = anIterator;
 184
 185       valuesCache = new ArrayList();
 186       position=0;
 187
 188
 189       if (iterator instanceof RewindableIterator) {
 190         ((RewindableIterator) iterator).rewind();
 191       }
 192     }
 193
 194     public boolean isEmpty() {
 195       return valuesCache.isEmpty() && !iterator.hasNext();
 196     }
 197
 198     private void getUntil(int anIndex) throws TemplateModelException {
 199       while (valuesCache.size()<=anIndex && iterator.hasNext())
 200       {
 201         valuesCache.add(makeAdapter(iterator.next()));
 202       }
 203     }
 204
 205     public TemplateModel get(int anIndex) throws TemplateModelException {
 206       TemplateModel result;
 207
 208       getUntil(anIndex);
 209
 210       if (anIndex<valuesCache.size())
 211       {
 212         result = (TemplateModel) valuesCache.get(anIndex);
 213
 214         return result;
 215       }
 216                         throw new TemplateModelException( "Iterator out of bounds" );
 217     }
 218
 219     public boolean hasNext() {
 220       return position<valuesCache.size() || iterator.hasNext();
 221     }
 222
 223     public boolean isRewound() {
 224       return position==0;
 225     }
 226
 227     public TemplateModel next() throws TemplateModelException {
 228       TemplateModel result;
 229
 230       if (hasNext()) {
 231         result = get(position);
 232         position++;
 233       }
 234       else
 235         throw new TemplateModelException( "Iterator out of bounds" );
 236
 237       return result;
 238     }
 239
 240     public void rewind() {
 241       position=0;
 242     }
 243   }
 244
 245   private static class ListAdapter implements TemplateListModel {
 246     List list;
 247     List valuesCache;
 248     int position;
 249
 250     private ListAdapter(List aList) {
 251       list = aList;
 252       valuesCache = new ArrayList();
 253       position=0;
 254     }
 255
 256     public boolean isEmpty() {
 257       return list.isEmpty();
 258     }
 259
 260     public TemplateModel get(int i) throws TemplateModelException {
 261
 262       if (i>=valuesCache.size() && i<list.size()) {
 263         for(int j=valuesCache.size(); j<=i; j++) {
 264           valuesCache.add(makeAdapter(list.get(j)));
 265         }
 266       }
 267
 268       if (i<valuesCache.size())
 269         return (TemplateModel) valuesCache.get(i);
 270
 271                         throw new TemplateModelException( "Iterator out of bounds" );
 272     }
 273
 274     public boolean hasNext() {
 275       return position<list.size();
 276     }
 277
 278     public boolean isRewound() {
 279       return position==0;
 280     }
 281
 282     public TemplateModel next() throws TemplateModelException {
 283       TemplateModel result;
 284
 285       if (hasNext()) {
 286         result = get(position);
 287         position++;
 288       }
 289       else {
 290         throw new TemplateModelException( "Iterator out of bounds" );
 291       }
 292
 293       return result;
 294     }
 295
 296     public void rewind() {
 297       position = 0;
 298     }
 299   }
 300
 301   private static class FunctionAdapter implements TemplateMethodModel {
 302     private Generator.Function function;
 303
 304     public FunctionAdapter(Generator.Function aFunction) {
 305       function = aFunction;
 306     }
 307
 308     public TemplateModel exec(List anArguments) throws TemplateModelException {
 309       try {
 310         return makeAdapter(function.perform(anArguments));
 311       }
 312       catch (Throwable t) {
 313         throw new TemplateModelException(t.getMessage());
 314       }
 315     }
 316
 317     public boolean isEmpty() {
 318       return false;
 319     }
 320
 321   }
 322
 323   private static class BeanAdapter implements TemplateHashModel {
 324     private Object object;
 325
 326     public BeanAdapter(Object anObject) {
 327       object = anObject;
 328     }
 329
 330     public void put(String aKey, TemplateModel aModel)  throws TemplateModelException  {
 331       throw new TemplateModelException("FreemarkerGenerator$BeanAdapter.put not supported");
 332     }
 333
 334     public void remove(String aKey) throws TemplateModelException  {
 335       throw new TemplateModelException("FreemarkerGenerator$BeanAdapter.remove not supported");
 336     }
 337
 338     public boolean isEmpty() {
 339       return false;
 340     }
 341
 342     public TemplateModel get(String aKey) throws TemplateModelException {
 343       try {
 344         if (PropertyUtils.isReadable(object, aKey))
 345           return makeAdapter(PropertyUtils.getSimpleProperty(object, aKey));
 346                                 return makeAdapter(MethodUtils.invokeExactMethod(object, "get", aKey));
 347       }
 348       catch (Throwable t) {
 349         throw new TemplateModelException(t.getMessage());
 350       }
 351     }
 352   }
 353
 354   public static class FreemarkerGeneratorLibrary implements Library {
 355     private FileTemplateCache templateCache;
 356
 357     public FreemarkerGeneratorLibrary(File aTemplateRoot) {
 358       templateCache = new FileTemplateCache(aTemplateRoot);
 359       templateCache.setLoadingPolicy(FileTemplateCache.LOAD_ON_DEMAND);
 360     }
 361
 362     public Generator makeGenerator(String anIdentifier) throws GeneratorExc, GeneratorFailure {
 363       Template template = (Template) templateCache.getItem(anIdentifier, "template");
 364
 365       if (template==null) {
 366         throw new GeneratorExc("FreemarkerGeneratorLibrary: Can't find template " +
 367             templateCache.getDirectory() + File.separatorChar + anIdentifier);
 368       }
 369
 370       return new FreemarkerGenerator(template);
 371     }
 372   }
 373
 374   public static class FreemarkerGeneratorLibraryFactory implements LibraryFactory {
 375     private File basePath;
 376
 377     public FreemarkerGeneratorLibraryFactory(File aBasePath) {
 378       basePath = aBasePath;
 379     }
 380
 381     public Library makeLibrary(String anInitializationString) {
 382       // todo: the initialization string should be parsed
 383       return new FreemarkerGeneratorLibrary(new File(basePath, anInitializationString));
 384     }
 385   }
 386 }