KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > blojsom > plugin > excerpt > ExcerptPlugin


1 /**
2  * Copyright (c) 2003-2006, David A. Czarnecki
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *
8  * Redistributions of source code must retain the above copyright notice, this list of conditions and the
9  * following disclaimer.
10  * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
11  * following disclaimer in the documentation and/or other materials provided with the distribution.
12  * Neither the name of "David A. Czarnecki" and "blojsom" nor the names of its contributors may be used to
13  * endorse or promote products derived from this software without specific prior written permission.
14  * Products derived from this software may not be called "blojsom", nor may "blojsom" appear in their name,
15  * without prior written permission of David A. Czarnecki.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
18  * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
19  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
20  * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
21  * EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
26  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
27  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
29  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  */
31 package org.blojsom.plugin.excerpt;
32
33 import org.blojsom.blog.Blog;
34 import org.blojsom.blog.Entry;
35 import org.blojsom.plugin.Plugin;
36 import org.blojsom.plugin.PluginException;
37 import org.blojsom.util.BlojsomUtils;
38
39 import javax.servlet.http.HttpServletRequest JavaDoc;
40 import javax.servlet.http.HttpServletResponse JavaDoc;
41 import java.util.Map JavaDoc;
42 import java.util.regex.Matcher JavaDoc;
43 import java.util.regex.Pattern JavaDoc;
44
45 /**
46  * ExcerptPlugin
47  *
48  * @author David Czarnecki
49  * @author Mark Lussier
50  * @version $Id: ExcerptPlugin.java,v 1.2 2006/03/20 22:50:36 czarneckid Exp $
51  * @since blojsom 3.0
52  */
53 public class ExcerptPlugin implements Plugin {
54
55     private static final String JavaDoc SHOWME_PARAM = "smm";
56
57     private static final String JavaDoc EXCERPT_EXPRESSION = "(^|\\s).*<div class=\"excerpt\">(.*)</div>.*";
58     private static final String JavaDoc SHOWME_START = "$2 &nbsp;<a class=\"smm\" HREF=\"";
59     private static final String JavaDoc SHOWME_FINISH = "&amp;" + SHOWME_PARAM + "=y\">Read More</a>";
60
61     /**
62      * Default Constructor
63      */
64     public ExcerptPlugin() {
65     }
66
67     /**
68      * Initialize this plugin. This method only called when the plugin is instantiated.
69      *
70      * @throws org.blojsom.plugin.PluginException
71      * If there is an error initializing the plugin
72      */
73     public void init() throws PluginException {
74     }
75
76     /**
77      * Process the blog entries
78      *
79      * @param httpServletRequest Request
80      * @param httpServletResponse Response
81      * @param blog {@link Blog} instance
82      * @param context Context
83      * @param entries Blog entries retrieved for the particular request
84      * @return Modified set of blog entries
85      * @throws PluginException If there is an error processing the blog entries
86      */
87     public Entry[] process(HttpServletRequest JavaDoc httpServletRequest, HttpServletResponse JavaDoc httpServletResponse, Blog blog, Map JavaDoc context, Entry[] entries) throws PluginException {
88         String JavaDoc showme = BlojsomUtils.getRequestValue(SHOWME_PARAM, httpServletRequest);
89         if (showme == null) {
90             processEntries(blog, entries);
91         }
92
93         return entries;
94     }
95
96     /**
97      * Process entries
98      *
99      * @param blog {@link Blog}
100      * @param entries Array of {@link BlogEntry} objects
101      */
102     private void processEntries(Blog blog, Entry[] entries) {
103         Pattern JavaDoc p = Pattern.compile(EXCERPT_EXPRESSION, Pattern.DOTALL);
104
105         for (int i = 0; i < entries.length; i++) {
106             Entry entry = entries[i];
107             String JavaDoc originalDescription = entry.getDescription();
108             Matcher JavaDoc m = p.matcher(originalDescription);
109             if (m.matches()) {
110                 StringBuffer JavaDoc newDescription = new StringBuffer JavaDoc(m.replaceAll(SHOWME_START));
111                 newDescription.append(blog.getBlogURL()).append("?permalink=").append(entry.getPostSlug());
112                 newDescription.append(SHOWME_FINISH);
113                 entry.setDescription(newDescription.toString());
114             }
115         }
116     }
117
118     /**
119      * Perform any cleanup for the plugin. Called after {@link #process}.
120      *
121      * @throws org.blojsom.plugin.PluginException
122      * If there is an error performing cleanup for this plugin
123      */
124     public void cleanup() throws PluginException {
125     }
126
127     /**
128      * Called when BlojsomServlet is taken out of service
129      *
130      * @throws org.blojsom.plugin.PluginException
131      * If there is an error in finalizing this plugin
132      */
133     public void destroy() throws PluginException {
134     }
135 }
136
Popular Tags