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.common;
031:
032: import org.blojsom.blog.Blog;
033: import org.blojsom.blog.Entry;
034: import org.blojsom.plugin.Plugin;
035: import org.blojsom.plugin.PluginException;
036: import org.blojsom.util.BlojsomUtils;
037:
038: import javax.servlet.http.HttpServletRequest;
039: import javax.servlet.http.HttpServletResponse;
040: import java.util.Map;
041:
042: /**
043: * Convert Line Breaks Plugin
044: *
045: * @author David Czarnecki
046: * @version $Id: ConvertLineBreaksPlugin.java,v 1.2 2007/01/17 02:35:09 czarneckid Exp $
047: * @since blojsom 3.0
048: */
049: public class ConvertLineBreaksPlugin implements Plugin {
050:
051: /**
052: * Default constructor.
053: */
054: public ConvertLineBreaksPlugin() {
055: }
056:
057: /**
058: * Initialize this plugin. This method only called when the plugin is instantiated.
059: *
060: * @throws org.blojsom.plugin.PluginException
061: * If there is an error initializing the plugin
062: */
063: public void init() throws PluginException {
064: }
065:
066: /**
067: * Process the blog entries
068: *
069: * @param httpServletRequest Request
070: * @param httpServletResponse Response
071: * @param blog {@link Blog} instance
072: * @param context Context
073: * @param entries Blog entries retrieved for the particular request
074: * @return Modified set of blog entries
075: * @throws PluginException If there is an error processing the blog entries
076: */
077: public Entry[] process(HttpServletRequest httpServletRequest,
078: HttpServletResponse httpServletResponse, Blog blog,
079: Map context, Entry[] entries) throws PluginException {
080: for (int i = 0; i < entries.length; i++) {
081: Entry entry = entries[i];
082: String description = entry.getDescription();
083: if (!BlojsomUtils.checkNullOrBlank(description)) {
084: description = BlojsomUtils.replace(description, "\n",
085: "<br />");
086: entry.setDescription(description);
087: }
088: }
089:
090: return entries;
091: }
092:
093: /**
094: * Perform any cleanup for the plugin. Called after {@link #process}.
095: *
096: * @throws org.blojsom.plugin.PluginException
097: * If there is an error performing cleanup for this plugin
098: */
099: public void cleanup() throws PluginException {
100: }
101:
102: /**
103: * Called when BlojsomServlet is taken out of service
104: *
105: * @throws org.blojsom.plugin.PluginException
106: * If there is an error in finalizing this plugin
107: */
108: public void destroy() throws PluginException {
109: }
110: }
|