Java tutorial
///////////////////////////////////////////////////////////////////////////// // // Project ProjectForge Community Edition // www.projectforge.org // // Copyright (C) 2001-2014 Kai Reinhard (k.reinhard@micromata.de) // // ProjectForge is dual-licensed. // // This community edition is free software; you can redistribute it and/or // modify it under the terms of the GNU General Public License as published // by the Free Software Foundation; version 3 of the License. // // This community edition is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General // Public License for more details. // // You should have received a copy of the GNU General Public License along // with this program; if not, see http://www.gnu.org/licenses/. // ///////////////////////////////////////////////////////////////////////////// package org.projectforge.business.scripting; import java.io.FileNotFoundException; import java.io.IOException; import java.io.StringWriter; import java.util.Map; import org.apache.commons.lang.StringUtils; import org.codehaus.groovy.control.CompilationFailedException; import org.projectforge.business.refactoring.RefactoringService; import org.projectforge.framework.access.AccessException; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Service; import groovy.lang.Binding; import groovy.lang.GroovyClassLoader; import groovy.lang.Script; import groovy.lang.Writable; import groovy.text.SimpleTemplateEngine; import groovy.text.Template; import groovy.text.TemplateEngine; /** * Executes groovy templates. For more functionality please refer GroovyEngine. * * @author Kai Reinhard (k.reinhard@micromata.de) * */ @Service public class GroovyExecutor { private static final org.apache.log4j.Logger log = org.apache.log4j.Logger.getLogger(GroovyExecutor.class); @Autowired private RefactoringService refService; public GroovyResult execute(final String script, final Map<String, Object> variables) { if (script == null) { return new GroovyResult(); } final Script groovyObject = compileGroovy(script, true); if (groovyObject == null) { return new GroovyResult(); } return execute(groovyObject, variables); } public GroovyResult execute(final GroovyResult result, final String script, final Map<String, Object> variables) { if (script == null) { return result; } final Script groovyObject = compileGroovy(result, script, true); if (groovyObject == null) { return result; } return execute(result, groovyObject, variables); } public String executeTemplate(final String template, final Map<String, Object> variables) { securityChecks(template); return executeTemplate(new SimpleTemplateEngine(), template, variables); } public String executeTemplate(final TemplateEngine templateEngine, final String template, final Map<String, Object> variables) { securityChecks(template); if (template == null) { return null; } try { final Template templateObject = templateEngine.createTemplate(template); final Writable writable = templateObject.make(variables); final StringWriter writer = new StringWriter(); writable.writeTo(writer); writer.flush(); if (log.isDebugEnabled() == true) { log.debug(writer.toString()); } return writer.toString(); } catch (final CompilationFailedException ex) { log.error(ex.getMessage() + " while executing template: " + template, ex); } catch (final FileNotFoundException ex) { log.error(ex.getMessage() + " while executing template: " + template, ex); } catch (final ClassNotFoundException ex) { log.error(ex.getMessage() + " while executing template: " + template, ex); } catch (final IOException ex) { log.error(ex.getMessage() + " while executing template: " + template, ex); } return null; } /** * @param script * @param bindScriptResult If true then "scriptResult" from type GroovyResult is binded. * @return */ public Script compileGroovy(final String script, final boolean bindScriptResult) { return compileGroovy(null, script, bindScriptResult); } /** * @param script * @param bindScriptResult If true then "scriptResult" from type GroovyResult is binded. * @return */ public Script compileGroovy(final GroovyResult result, final String script, final boolean bindScriptResult) { securityChecks(script); final GroovyClassLoader gcl = new GroovyClassLoader() { @SuppressWarnings("rawtypes") @Override public Class loadClass(String name, boolean lookupScriptFiles, boolean preferClassOverScript, boolean resolve) throws ClassNotFoundException, CompilationFailedException { Class loadClass = null; try { loadClass = super.loadClass(name, lookupScriptFiles, preferClassOverScript, resolve); } catch (ClassNotFoundException e) { if (name.startsWith("org.projectforge")) { String refClassName = null; String[] nameParts = name.split("\\."); refClassName = refService.getNewPackageNameForClass(nameParts[nameParts.length - 1]); if (refClassName != null) { loadClass = super.loadClass(refClassName, lookupScriptFiles, preferClassOverScript, resolve); if (loadClass == null) { log.error("Error while resolving Class: " + name); throw e; } } } } return loadClass; } }; Class<?> groovyClass = null; try { groovyClass = gcl.parseClass(script); } catch (final CompilationFailedException ex) { log.info("Groovy-CompilationFailedException: " + ex.getMessage()); if (result != null) { result.setException(ex); } return null; } Script groovyObject = null; try { groovyObject = (Script) groovyClass.newInstance(); } catch (final InstantiationException ex) { log.error(ex.getMessage(), ex); if (result != null) { result.setException(ex); } return null; } catch (final IllegalAccessException ex) { log.error(ex.getMessage(), ex); if (result != null) { result.setException(ex); } return null; } if (bindScriptResult == true) { final Binding binding = groovyObject.getBinding(); final GroovyResult scriptResult = new GroovyResult(); binding.setVariable("scriptResult", scriptResult); } return groovyObject; } public GroovyResult execute(final Script groovyScript) { return execute(groovyScript, null); } public GroovyResult execute(final Script groovyScript, final Map<String, Object> variables) { return execute((GroovyResult) null, groovyScript, variables); } public GroovyResult execute(GroovyResult result, final Script groovyScript, final Map<String, Object> variables) { if (variables != null) { final Binding binding = groovyScript.getBinding(); for (final Map.Entry<String, Object> entry : variables.entrySet()) { binding.setVariable(entry.getKey(), entry.getValue()); } } if (result == null) { result = new GroovyResult(); } Object res = null; try { res = groovyScript.run(); } catch (final Exception ex) { log.info("Groovy-Execution-Exception: " + ex.getMessage(), ex); return new GroovyResult(ex); } result.setResult(res); return result; } /** * Better than nothing... * * @param script */ private void securityChecks(final String script) { final String[] forbiddenKeyWords = { "__baseDao", "__baseObject", "System.ex" }; for (final String forbiddenKeyWord : forbiddenKeyWords) { if (StringUtils.contains(script, forbiddenKeyWord) == true) { throw new AccessException("access.exception.violation", forbiddenKeyWord); } } } }