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.wiki;
031:
032: import org.apache.commons.logging.Log;
033: import org.apache.commons.logging.LogFactory;
034: import org.blojsom.blog.Blog;
035: import org.blojsom.blog.Entry;
036: import org.blojsom.plugin.Plugin;
037: import org.blojsom.plugin.PluginException;
038: import org.blojsom.util.BlojsomUtils;
039: import org.radeox.EngineManager;
040: import org.radeox.api.engine.RenderEngine;
041: import org.radeox.api.engine.context.RenderContext;
042: import org.radeox.engine.context.BaseRenderContext;
043:
044: import javax.servlet.http.HttpServletRequest;
045: import javax.servlet.http.HttpServletResponse;
046: import java.util.Map;
047:
048: /**
049: * WikiPlugin
050: *
051: * @author David Czarnecki
052: * @version $Id: WikiPlugin.java,v 1.2 2007/01/17 02:35:07 czarneckid Exp $
053: * @since blojsom 3.0
054: */
055: public class WikiPlugin implements Plugin {
056:
057: private Log _logger = LogFactory.getLog(WikiPlugin.class);
058:
059: /**
060: * Entry extension of a Wiki post
061: */
062: private static final String WIKI_EXTENSION = ".wiki";
063:
064: /**
065: * MetaData Key to identify a Wiki post
066: */
067: public static final String METADATA_RUN_WIKI = "run-wiki";
068:
069: /**
070: * Initialize this plugin. This method only called when the plugin is instantiated.
071: *
072: * @throws PluginException If there is an error initializing the plugin
073: */
074: public void init() throws PluginException {
075: }
076:
077: /**
078: * Process the blog entries
079: *
080: * @param httpServletRequest Request
081: * @param httpServletResponse Response
082: * @param blog {@link Blog} instance
083: * @param context Context
084: * @param entries Blog entries retrieved for the particular request
085: * @return Modified set of blog entries
086: * @throws PluginException If there is an error processing the blog entries
087: */
088: public Entry[] process(HttpServletRequest httpServletRequest,
089: HttpServletResponse httpServletResponse, Blog blog,
090: Map context, Entry[] entries) throws PluginException {
091: RenderEngine engine = EngineManager.getInstance();
092: RenderContext renderContext = new BaseRenderContext();
093:
094: for (int i = 0; i < entries.length; i++) {
095: Entry entry = entries[i];
096: if (entry.getPostSlug().endsWith(WIKI_EXTENSION)
097: || BlojsomUtils.checkMapForKey(entry.getMetaData(),
098: METADATA_RUN_WIKI)) {
099: if (_logger.isDebugEnabled()) {
100: _logger.debug("Wiki processing: " + entry.getId());
101: }
102:
103: String description = entry.getDescription();
104: entry.setDescription(engine.render(description,
105: renderContext));
106: }
107: }
108:
109: return entries;
110: }
111:
112: /**
113: * Perform any cleanup for the plugin. Called after {@link #process}.
114: *
115: * @throws PluginException If there is an error performing cleanup for this plugin
116: */
117: public void cleanup() throws PluginException {
118: }
119:
120: /**
121: * Called when BlojsomServlet is taken out of service
122: *
123: * @throws PluginException If there is an error in finalizing this plugin
124: */
125: public void destroy() throws PluginException {
126: }
127: }
|