001    /**
002     * Copyright (c) 2000-2011 Liferay, Inc. All rights reserved.
003     *
004     * The contents of this file are subject to the terms of the Liferay Enterprise
005     * Subscription License ("License"). You may not use this file except in
006     * compliance with the License. You can obtain a copy of the License by
007     * contacting Liferay, Inc. See the License for the specific language governing
008     * permissions and limitations under the License, including but not limited to
009     * distribution rights of the Software.
010     *
011     *
012     *
013     */
014    
015    package com.liferay.portal.scripting.ruby;
016    
017    import com.liferay.portal.kernel.scripting.BaseScriptingExecutor;
018    import com.liferay.portal.kernel.scripting.ExecutionException;
019    import com.liferay.portal.kernel.scripting.ScriptingException;
020    import com.liferay.portal.kernel.util.PortalClassLoaderUtil;
021    import com.liferay.portal.kernel.util.StringPool;
022    import com.liferay.portal.util.PortalUtil;
023    import com.liferay.portal.util.PropsValues;
024    
025    import java.io.File;
026    import java.io.FileInputStream;
027    import java.io.FileNotFoundException;
028    
029    import java.util.ArrayList;
030    import java.util.HashMap;
031    import java.util.List;
032    import java.util.Map;
033    import java.util.Set;
034    
035    import org.jruby.RubyInstanceConfig.CompileMode;
036    import org.jruby.RubyInstanceConfig;
037    import org.jruby.embed.LocalContextScope;
038    import org.jruby.embed.ScriptingContainer;
039    import org.jruby.embed.internal.LocalContextProvider;
040    import org.jruby.exceptions.RaiseException;
041    
042    /**
043     * @author Alberto Montero
044     * @author Raymond Augé
045     */
046    public class RubyExecutor extends BaseScriptingExecutor {
047    
048            public static final String LANGUAGE = "ruby";
049    
050            public RubyExecutor() {
051                    _scriptingContainer = new ScriptingContainer(
052                            LocalContextScope.THREADSAFE);
053    
054                    LocalContextProvider localContextProvider =
055                            _scriptingContainer.getProvider();
056    
057                    RubyInstanceConfig rubyInstanceConfig =
058                            localContextProvider.getRubyInstanceConfig();
059    
060                    rubyInstanceConfig.setLoader(PortalClassLoaderUtil.getClassLoader());
061    
062                    if (PropsValues.SCRIPTING_JRUBY_COMPILE_MODE.equals(
063                                    _COMPILE_MODE_FORCE)) {
064    
065                            rubyInstanceConfig.setCompileMode(CompileMode.FORCE);
066                    }
067                    else if (PropsValues.SCRIPTING_JRUBY_COMPILE_MODE.equals(
068                                            _COMPILE_MODE_JIT)) {
069    
070                            rubyInstanceConfig.setCompileMode(CompileMode.JIT);
071                    }
072    
073                    rubyInstanceConfig.setJitThreshold(
074                            PropsValues.SCRIPTING_JRUBY_COMPILE_THRESHOLD);
075    
076                    _basePath = PortalUtil.getPortalLibDir();
077    
078                    _loadPaths = new ArrayList<String>(
079                            PropsValues.SCRIPTING_JRUBY_LOAD_PATHS.length);
080    
081                    for (String gemLibPath : PropsValues.SCRIPTING_JRUBY_LOAD_PATHS) {
082                            _loadPaths.add(gemLibPath);
083                    }
084    
085                    rubyInstanceConfig.setLoadPaths(_loadPaths);
086    
087                    _scriptingContainer.setCurrentDirectory(_basePath);
088            }
089    
090            @Override
091            public Map<String, Object> eval(
092                            Set<String> allowedClasses, Map<String, Object> inputObjects,
093                            Set<String> outputNames, File scriptFile)
094                    throws ScriptingException {
095    
096                    return eval(
097                            allowedClasses, inputObjects, outputNames, scriptFile, null);
098            }
099    
100            public Map<String, Object> eval(
101                            Set<String> allowedClasses, Map<String, Object> inputObjects,
102                            Set<String> outputNames, String script)
103                    throws ScriptingException {
104    
105                    return eval(allowedClasses, inputObjects, outputNames, null, script);
106            }
107    
108            public String getLanguage() {
109                    return LANGUAGE;
110            }
111    
112            protected Map<String, Object> eval(
113                            Set<String> allowedClasses, Map<String, Object> inputObjects,
114                            Set<String> outputNames, File scriptFile, String script)
115                    throws ScriptingException {
116    
117                    if (allowedClasses != null) {
118                            throw new ExecutionException(
119                                    "Constrained execution not supported for Ruby");
120                    }
121    
122                    try {
123                            RubyInstanceConfig rubyInstanceConfig =
124                                    _scriptingContainer.getProvider().getRubyInstanceConfig();
125    
126                            rubyInstanceConfig.setCurrentDirectory(_basePath);
127                            rubyInstanceConfig.setLoadPaths(_loadPaths);
128    
129                            for (Map.Entry<String, Object> entry : inputObjects.entrySet()) {
130                                    String inputName = entry.getKey();
131                                    Object inputObject = entry.getValue();
132    
133                                    if (!inputName.startsWith(StringPool.DOLLAR)) {
134                                            inputName = StringPool.DOLLAR + inputName;
135                                    }
136    
137                                    _scriptingContainer.put(inputName, inputObject);
138                            }
139    
140                            if (scriptFile != null) {
141                                    _scriptingContainer.runScriptlet(
142                                            new FileInputStream(scriptFile), scriptFile.toString());
143                            }
144                            else {
145                                    _scriptingContainer.runScriptlet(script);
146                            }
147    
148                            if (outputNames == null) {
149                                    return null;
150                            }
151    
152                            Map<String, Object> outputObjects = new HashMap<String, Object>();
153    
154                            for (String outputName : outputNames) {
155                                    outputObjects.put(
156                                            outputName, _scriptingContainer.get(outputName));
157                            }
158    
159                            return outputObjects;
160                    }
161                    catch (RaiseException re) {
162                            throw new ScriptingException(
163                                    re.getException().message.asJavaString() + "\n\n", re);
164                    }
165                    catch (FileNotFoundException fnfe) {
166                            throw new ScriptingException(fnfe);
167                    }
168            }
169    
170            private static final String _COMPILE_MODE_FORCE = "force";
171    
172            private static final String _COMPILE_MODE_JIT = "jit";
173    
174            private String _basePath;
175            private List<String> _loadPaths;
176            private ScriptingContainer _scriptingContainer;
177    
178    }