001: /**
002: * Copyright (c) 2003-2007, David A. Czarnecki
003: * All rights reserved.
004: *
005: * Redistribution and use in source and binary forms, with or without
006: * modification, are permitted provided that the following conditions are met:
007: *
008: * Redistributions of source code must retain the above copyright notice, this list of conditions and the
009: * following disclaimer.
010: * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
011: * following disclaimer in the documentation and/or other materials provided with the distribution.
012: * Neither the name of "David A. Czarnecki" and "blojsom" nor the names of its contributors may be used to
013: * endorse or promote products derived from this software without specific prior written permission.
014: * Products derived from this software may not be called "blojsom", nor may "blojsom" appear in their name,
015: * without prior written permission of David A. Czarnecki.
016: *
017: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
018: * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
019: * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
020: * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
021: * EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
022: * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
023: * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
024: * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
025: * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
026: * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
027: * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
028: * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
029: * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
030: */package org.blojsom.plugin.scripting;
031:
032: import groovy.lang.GroovyClassLoader;
033: import org.apache.commons.logging.Log;
034: import org.apache.commons.logging.LogFactory;
035: import org.blojsom.blog.Blog;
036: import org.blojsom.blog.Entry;
037: import org.blojsom.plugin.Plugin;
038: import org.blojsom.plugin.PluginException;
039: import org.blojsom.util.BlojsomUtils;
040: import org.blojsom.util.BlojsomConstants;
041:
042: import javax.servlet.http.HttpServletRequest;
043: import javax.servlet.http.HttpServletResponse;
044: import javax.servlet.ServletConfig;
045: import java.io.File;
046: import java.util.Map;
047:
048: /**
049: * GroovyPlugin
050: *
051: * @author David Czarnecki
052: * @version $Id: GroovyPlugin.java,v 1.2 2007/01/17 02:35:06 czarneckid Exp $
053: * @since blojsom 3.0
054: */
055: public class GroovyPlugin implements Plugin {
056:
057: private Log _logger = LogFactory.getLog(GroovyPlugin.class);
058:
059: private static final String GROOVY_SCRIPTS_PARAM = "groovy-scripts";
060: private static final String GROOVY_SCRIPTS_COUNTER = "BLOJSOM_GROOVY_PLUGIN_SCRIPTS_COUNTER";
061: private static final String GROOVY_SCRIPTS_LIST = "BLOJSOM_GROOVY_PLUGIN_SCRIPTS_LIST";
062:
063: private ServletConfig _servletConfig;
064:
065: /**
066: * Default constructor.
067: */
068: public GroovyPlugin() {
069: }
070:
071: /**
072: * Set the {@link ServletConfig}
073: *
074: * @param servletConfig {@link ServletConfig}
075: */
076: public void setServletConfig(ServletConfig servletConfig) {
077: _servletConfig = servletConfig;
078: }
079:
080: /**
081: * Initialize this plugin. This method only called when the plugin is instantiated.
082: *
083: * @throws org.blojsom.plugin.PluginException
084: * If there is an error initializing the plugin
085: */
086: public void init() throws PluginException {
087: }
088:
089: /**
090: * Process the blog entries
091: *
092: * @param httpServletRequest Request
093: * @param httpServletResponse Response
094: * @param blog {@link Blog} instance
095: * @param context Context
096: * @param entries Blog entries retrieved for the particular request
097: * @return Modified set of blog entries
098: * @throws PluginException If there is an error processing the blog entries
099: */
100: public Entry[] process(HttpServletRequest httpServletRequest,
101: HttpServletResponse httpServletResponse, Blog blog,
102: Map context, Entry[] entries) throws PluginException {
103: String[] scripts = null;
104:
105: // Parse the scripts to execute
106: if (context.containsKey(GROOVY_SCRIPTS_LIST)) {
107: scripts = (String[]) context.get(GROOVY_SCRIPTS_LIST);
108: } else {
109: String scriptsParam = BlojsomUtils.getRequestValue(
110: GROOVY_SCRIPTS_PARAM, httpServletRequest);
111: if (scriptsParam != null) {
112: scripts = BlojsomUtils.parseCommaList(scriptsParam);
113: context.put(GROOVY_SCRIPTS_LIST, scripts);
114: }
115: }
116:
117: if (scripts == null) {
118: if (_logger.isInfoEnabled()) {
119: _logger.info("No scripts to process");
120: }
121:
122: return entries;
123: }
124:
125: // Check for which script we should process if there was more than one
126: Integer scriptToProcess;
127: if (context.containsKey(GROOVY_SCRIPTS_COUNTER)) {
128: scriptToProcess = (Integer) context
129: .get(GROOVY_SCRIPTS_COUNTER);
130: } else {
131: scriptToProcess = new Integer(0);
132: }
133:
134: if (scriptToProcess == null || scriptToProcess.intValue() < 0
135: || scriptToProcess.intValue() > scripts.length) {
136: if (_logger.isErrorEnabled()) {
137: _logger
138: .error("Groovy scripts counter is null or value is out of range");
139: }
140:
141: return entries;
142: }
143:
144: File scriptFile = new File(
145: _servletConfig
146: .getServletContext()
147: .getRealPath(
148: BlojsomConstants.DEFAULT_CONFIGURATION_BASE_DIRECTORY)
149: + BlojsomConstants.DEFAULT_BLOGS_DIRECTORY
150: + blog.getBlogId()
151: + "/"
152: + BlojsomUtils
153: .normalize(scripts[scriptToProcess
154: .intValue()]));
155: if (_logger.isDebugEnabled()) {
156: _logger.debug("Processing script file: "
157: + scriptFile.toString());
158: }
159:
160: GroovyClassLoader groovyClassLoader = new GroovyClassLoader(
161: this .getClass().getClassLoader());
162: Plugin plugin;
163: try {
164: Class scriptPluginClazz = groovyClassLoader
165: .parseClass(scriptFile);
166: plugin = (Plugin) scriptPluginClazz.newInstance();
167: plugin.init();
168: entries = plugin.process(httpServletRequest,
169: httpServletResponse, blog, context, entries);
170: plugin.cleanup();
171: plugin.destroy();
172:
173: // Increment the script to process counter
174: scriptToProcess = new Integer(
175: scriptToProcess.intValue() + 1);
176: context.put(GROOVY_SCRIPTS_COUNTER, scriptToProcess);
177: } catch (Exception e) {
178: if (_logger.isErrorEnabled()) {
179: _logger.error(e);
180: }
181: }
182:
183: return entries;
184: }
185:
186: /**
187: * Perform any cleanup for the plugin. Called after {@link #process}.
188: *
189: * @throws org.blojsom.plugin.PluginException
190: * If there is an error performing cleanup for this plugin
191: */
192: public void cleanup() throws PluginException {
193: }
194:
195: /**
196: * Called when BlojsomServlet is taken out of service
197: *
198: * @throws org.blojsom.plugin.PluginException
199: * If there is an error in finalizing this plugin
200: */
201: public void destroy() throws PluginException {
202: }
203: }
|