1   /*
    2    * Copyright (c) 2003 The Visigoth Software Society. All rights
    3    * reserved.
    4    *
    5    * Redistribution and use in source and binary forms, with or without
    6    * modification, are permitted provided that the following conditions
    7    * are met:
    8    *
    9    * 1. Redistributions of source code must retain the above copyright
   10    *    notice, this list of conditions and the following disclaimer.
   11    *
   12    * 2. Redistributions in binary form must reproduce the above copyright
   13    *    notice, this list of conditions and the following disclaimer in
   14    *    the documentation and/or other materials provided with the
   15    *    distribution.
   16    *
   17    * 3. The end-user documentation included with the redistribution, if
   18    *    any, must include the following acknowledgement:
   19    *       "This product includes software developed by the
   20    *        Visigoth Software Society (http://www.visigoths.org/)."
   21    *    Alternately, this acknowledgement may appear in the software itself,
   22    *    if and wherever such third-party acknowledgements normally appear.
   23    *
   24    * 4. Neither the name "FreeMarker", "Visigoth", nor any of the names of the 
   25    *    project contributors may be used to endorse or promote products derived
   26    *    from this software without prior written permission. For written
   27    *    permission, please contact visigoths@visigoths.org.
   28    *
   29    * 5. Products derived from this software may not be called "FreeMarker" or "Visigoth"
   30    *    nor may "FreeMarker" or "Visigoth" appear in their names
   31    *    without prior written permission of the Visigoth Software Society.
   32    *
   33    * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
   34    * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
   35    * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
   36    * DISCLAIMED.  IN NO EVENT SHALL THE VISIGOTH SOFTWARE SOCIETY OR
   37    * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   38    * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   39    * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
   40    * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
   41    * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
   42    * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
   43    * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   44    * SUCH DAMAGE.
   45    * ====================================================================
   46    *
   47    * This software consists of voluntary contributions made by many
   48    * individuals on behalf of the Visigoth Software Society. For more
   49    * information on the Visigoth Software Society, please see
   50    * http://www.visigoths.org/
   51    */
   52   
   53   package freemarker.ext.ant;
   54   
   55   import java.io;
   56   import java.util.Map;
   57   
   58   import org.apache.tools.ant.BuildException;
   59   import org.apache.tools.ant.ProjectHelper;
   60   import org.apache.tools.ant.Task;
   61   
   62   import freemarker.template.utility.ClassUtil;
   63   
   64   /**
   65    * Used internally, public for technical reasons only.
   66    * 
   67    * <p>This is an Ant sub-task of the {@link FreemarkerXmlTask} task.
   68    * 
   69    * <p><b>Warning! It must not be statically linked with Jython classes</b>,
   70    * so users can use the XML ant task even if Jython is not installed. 
   71    */
   72   public class JythonAntTask extends Task {
   73       
   74       private File scriptFile;
   75       private String script = "";
   76       private UnlinkedJythonOperations jythonOps;
   77       
   78       public void setFile(File scriptFile) throws BuildException {
   79           ensureJythonOpsExists();
   80           this.scriptFile = scriptFile;
   81       }
   82       
   83       public void addText(String text) {
   84           script += text;
   85       }
   86       
   87       public void execute(Map vars) throws BuildException {
   88           if (scriptFile != null) {
   89               ensureJythonOpsExists();
   90               jythonOps.execute(scriptFile, vars);
   91           } 
   92           if (script.trim().length() >0) {
   93               ensureJythonOpsExists();
   94               String finalScript = ProjectHelper.replaceProperties(
   95                       project, script, project.getProperties());
   96               jythonOps.execute(finalScript, vars);
   97           }
   98       }
   99   
  100       private void ensureJythonOpsExists() {
  101           if (jythonOps == null) {
  102               Class clazz;
  103               try {
  104                   clazz = ClassUtil.forName(
  105                           "freemarker.ext.ant.UnlinkedJythonOperationsImpl");
  106               } catch (ClassNotFoundException e) {
  107                   throw new RuntimeException(
  108                           "A ClassNotFoundException has been thrown when trying "
  109                           + "to get the "
  110                           + "freemarker.ext.ant.UnlinkedJythonOperationsImpl class. "
  111                           + "The error message was: " + e.getMessage());
  112               }
  113               try {
  114                   jythonOps
  115                           = (UnlinkedJythonOperations) clazz.newInstance();
  116               } catch (Exception e) {
  117                   throw new RuntimeException(
  118                           "An exception has been thrown when trying "
  119                           + "to create a freemarker.ext.ant.JythonAntTask "
  120                           + "object. The exception was: " + e);
  121               }
  122           }
  123       }
  124       
  125   }