View Javadoc
1   /**
2    * This file Copyright (c) 2011-2017 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.module.groovy.task;
35  
36  import groovy.lang.Binding;
37  import groovy.lang.GroovyRuntimeException;
38  
39  import info.magnolia.cms.util.ClasspathResourcesUtil;
40  import info.magnolia.module.InstallContext;
41  import info.magnolia.module.delta.AbstractTask;
42  import info.magnolia.module.delta.TaskExecutionException;
43  import info.magnolia.module.groovy.console.MgnlGroovyConsole;
44  
45  import java.io.File;
46  import java.io.IOException;
47  import java.io.InputStream;
48  import java.io.StringWriter;
49  import java.net.URL;
50  
51  import org.slf4j.Logger;
52  import org.slf4j.LoggerFactory;
53  
54  /**
55   * This Task execute a groovy file against the groovy console. File is define as a String.
56   */
57  public class ExecuteGroovyFileTask extends AbstractTask {
58  
59      // Init Global
60      private static final Logger log = LoggerFactory.getLogger(ExecuteGroovyFileTask.class);
61  
62      private MgnlGroovyConsole console;
63  
64      private String inputFile;
65  
66      public ExecuteGroovyFileTask(String taskName, String taskDescription, String inputFile) {
67          super(taskName, taskDescription);
68          this.inputFile = inputFile;
69      }
70  
71      @Override
72      public void execute(InstallContext installContext) throws TaskExecutionException {
73          try {
74              // Init
75              console = new MgnlGroovyConsole(new Binding());
76              // Run the GroovyFile against the Groovy Console
77              executeGroovyScript(installContext);
78          } catch (Exception e) {
79              throw new TaskExecutionException("Could not execute the groovy File '" + inputFile + "': " + e.getMessage(), e);
80          }
81      }
82  
83      private void executeGroovyScript(InstallContext installContext) throws Exception {
84  
85          // Check
86          if (this.inputFile == null) {
87              throw new IOException("Input File is Null");
88          }
89  
90          // First Check
91          URL inFile = ClasspathResourcesUtil.getResource(this.inputFile);
92          if (inFile == null) {
93              throw new IOException("Can't find resource file at " + this.inputFile);
94          }
95          // Get Input Stream
96          final InputStream inputStream = ClasspathResourcesUtil.getResource(this.inputFile).openStream();
97          if (inputStream == null) {
98              throw new IOException("Can't find resource file at " + inFile.getFile());
99          }
100 
101         Object lastResult = null;
102         StringWriter outputStream = new StringWriter();
103         try {
104             lastResult = console.evaluate(inputStream, (new File(inFile.getFile())).getName(), outputStream);
105             // Shows the result of the evaluated code
106             if (lastResult != null) {
107                 outputStream.getBuffer().append(lastResult);
108             }
109             outputStream.flush();
110             installContext.info(outputStream.toString());
111         } catch (GroovyRuntimeException e) {
112             log.error("Got a Groovy Execution Error", e);
113             throw e;
114         } finally {
115             outputStream.close();
116             inputStream.close();
117         }
118     }
119 }