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.textile;
031:
032: import net.sf.textile4j.Textile;
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:
041: import javax.servlet.http.HttpServletRequest;
042: import javax.servlet.http.HttpServletResponse;
043: import java.util.Map;
044:
045: /**
046: * Textile Plugin
047: *
048: * An implementation of the Textism's Textile. See http://www.textism.com/tools/textile
049: *
050: * @author David Czarnecki
051: * @author Mark Lussier
052: * @since blojsom 3.0
053: * @version $Id: TextilePlugin.java,v 1.3 2007/01/17 02:35:14 czarneckid Exp $
054: */
055: public class TextilePlugin implements Plugin {
056:
057: private static final String PLUGIN_TEXTILE_PROCESS_ALL_ENTRIES = "plugin-textile-process-all-entries";
058:
059: /**
060: * MetaData Key to identify a Textile post
061: */
062: public static final String METADATA_RUN_TEXTILE = "run-textile";
063:
064: /**
065: * Extension of Textile Post
066: */
067: public static final String TEXTILE_EXTENSION = ".textile";
068:
069: /**
070: * Textile Instance
071: */
072: private Textile _textile;
073:
074: /**
075: * Logger instance
076: */
077: private Log _logger = LogFactory.getLog(TextilePlugin.class);
078:
079: /**
080: * Initialize this plugin. This method only called when the plugin is instantiated.
081: *
082: * @throws PluginException If there is an error initializing the plugin
083: */
084: public void init() throws PluginException {
085: _textile = new Textile();
086: }
087:
088: /**
089: * Process the blog entries
090: *
091: * @param httpServletRequest Request
092: * @param httpServletResponse Response
093: * @param blog {@link Blog} instance
094: * @param context Context
095: * @param entries Blog entries retrieved for the particular request
096: * @return Modified set of blog entries
097: * @throws PluginException If there is an error processing the blog entries
098: */
099: public Entry[] process(HttpServletRequest httpServletRequest,
100: HttpServletResponse httpServletResponse, Blog blog,
101: Map context, Entry[] entries) throws PluginException {
102: for (int x = 0; x < entries.length; x++) {
103: Entry entry = entries[x];
104: if (entry.getPostSlug().endsWith(TEXTILE_EXTENSION)
105: || BlojsomUtils.checkMapForKey(entry.getMetaData(),
106: METADATA_RUN_TEXTILE)
107: || Boolean
108: .valueOf(
109: blog
110: .getProperty(PLUGIN_TEXTILE_PROCESS_ALL_ENTRIES))
111: .booleanValue()) {
112: if (_logger.isDebugEnabled()) {
113: _logger.debug("Textile processing: "
114: + entry.getId());
115: }
116: entry.setDescription(_textile.process(entry
117: .getDescription()));
118: }
119: }
120:
121: return entries;
122: }
123:
124: /**
125: * Perform any cleanup for the plugin. Called after {@link #process}.
126: *
127: * @throws PluginException If there is an error performing cleanup for this plugin
128: */
129: public void cleanup() throws PluginException {
130: }
131:
132: /**
133: * Called when BlojsomServlet is taken out of service
134: *
135: * @throws PluginException If there is an error in finalizing this plugin
136: */
137: public void destroy() throws PluginException {
138: }
139: }
|