1 /**
2 * This file Copyright (c) 2003-2012 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.console;
35
36 import groovy.lang.Binding;
37 import groovy.lang.GroovyCodeSource;
38 import groovy.lang.GroovyShell;
39 import groovy.lang.Script;
40
41 import info.magnolia.context.MgnlContext;
42 import info.magnolia.module.groovy.support.HierarchyManagerProvider;
43 import info.magnolia.module.groovy.support.classes.MgnlGroovyClassLoader;
44
45 import java.io.InputStream;
46 import java.io.InputStreamReader;
47 import java.io.UnsupportedEncodingException;
48 import java.io.Writer;
49
50 import org.apache.commons.lang.CharEncoding;
51 import org.codehaus.groovy.control.CompilationFailedException;
52 import org.codehaus.groovy.runtime.InvokerHelper;
53
54 /**
55 * Groovy console using {@link MgnlGroovyClassLoader} to parse Groovy source.
56 */
57 public class MgnlGroovyConsole extends GroovyShell {
58
59 private static final MgnlGroovyClassLoader cl = new MgnlGroovyClassLoader(new HierarchyManagerProvider.SystemContextHierarchyManagerProvider());
60
61 public MgnlGroovyConsole(Binding binding) {
62 super(binding);
63 }
64
65 public Object evaluate(InputStream in, String fileName, Writer out) throws CompilationFailedException {
66 Script script = null;
67 try {
68 script = parse(new InputStreamReader(in, CharEncoding.UTF_8), fileName);
69 script.setProperty("out", out);
70 script.setProperty("err", out);
71 script.setProperty("ctx", MgnlContext.getInstance());
72 return script.run();
73 } catch (UnsupportedEncodingException e) {
74 throw new RuntimeException(e);
75 } finally {
76 if (script != null) {
77 InvokerHelper.removeClass(script.getClass());
78 }
79 }
80 }
81
82 /**
83 * Parses the given script and returns it ready to be run. When running in a secure environment
84 * (-Djava.security.manager) codeSource.getCodeSource() determines what policy grants should be given to the script.
85 *
86 * @param codeSource
87 * @return ready to run script
88 */
89 @Override
90 public Script parse(final GroovyCodeSource codeSource) throws CompilationFailedException {
91 return InvokerHelper.createScript(parseClass(codeSource), getContext());
92 }
93
94 @Override
95 public String generateScriptName() {
96 return super.generateScriptName();
97 }
98
99 /**
100 * Parses the groovy code contained in codeSource and returns a java class.
101 */
102 private Class parseClass(final GroovyCodeSource codeSource) throws CompilationFailedException {
103 // Don't cache scripts
104 return cl.parseClass(codeSource, false);
105 }
106 }