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.excerpt;
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: import java.util.regex.Matcher;
042: import java.util.regex.Pattern;
043:
044: /**
045: * ExcerptPlugin
046: *
047: * @author David Czarnecki
048: * @author Mark Lussier
049: * @version $Id: ExcerptPlugin.java,v 1.3 2007/01/17 02:35:10 czarneckid Exp $
050: * @since blojsom 3.0
051: */
052: public class ExcerptPlugin implements Plugin {
053:
054: private static final String SHOWME_PARAM = "smm";
055:
056: private static final String EXCERPT_EXPRESSION = "(^|\\s).*<div class=\"excerpt\">(.*)</div>.*";
057: private static final String SHOWME_START = "$2 <a class=\"smm\" href=\"";
058: private static final String SHOWME_FINISH = "&" + SHOWME_PARAM
059: + "=y\">Read More</a>";
060:
061: /**
062: * Default Constructor
063: */
064: public ExcerptPlugin() {
065: }
066:
067: /**
068: * Initialize this plugin. This method only called when the plugin is instantiated.
069: *
070: * @throws org.blojsom.plugin.PluginException
071: * If there is an error initializing the plugin
072: */
073: public void init() throws PluginException {
074: }
075:
076: /**
077: * Process the blog entries
078: *
079: * @param httpServletRequest Request
080: * @param httpServletResponse Response
081: * @param blog {@link Blog} instance
082: * @param context Context
083: * @param entries Blog entries retrieved for the particular request
084: * @return Modified set of blog entries
085: * @throws PluginException If there is an error processing the blog entries
086: */
087: public Entry[] process(HttpServletRequest httpServletRequest,
088: HttpServletResponse httpServletResponse, Blog blog,
089: Map context, Entry[] entries) throws PluginException {
090: String showme = BlojsomUtils.getRequestValue(SHOWME_PARAM,
091: httpServletRequest);
092: if (showme == null) {
093: processEntries(blog, entries);
094: }
095:
096: return entries;
097: }
098:
099: /**
100: * Process entries
101: *
102: * @param blog {@link Blog}
103: * @param entries Array of {@link BlogEntry} objects
104: */
105: private void processEntries(Blog blog, Entry[] entries) {
106: Pattern p = Pattern.compile(EXCERPT_EXPRESSION, Pattern.DOTALL);
107:
108: for (int i = 0; i < entries.length; i++) {
109: Entry entry = entries[i];
110: String originalDescription = entry.getDescription();
111: Matcher m = p.matcher(originalDescription);
112: if (m.matches()) {
113: StringBuffer newDescription = new StringBuffer(m
114: .replaceAll(SHOWME_START));
115: newDescription.append(blog.getBlogURL()).append(
116: "?permalink=").append(entry.getPostSlug());
117: newDescription.append(SHOWME_FINISH);
118: entry.setDescription(newDescription.toString());
119: }
120: }
121: }
122:
123: /**
124: * Perform any cleanup for the plugin. Called after {@link #process}.
125: *
126: * @throws org.blojsom.plugin.PluginException
127: * 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 org.blojsom.plugin.PluginException
136: * If there is an error in finalizing this plugin
137: */
138: public void destroy() throws PluginException {
139: }
140: }
|