KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > blojsom > plugin > limiter > PreviewPlugin


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.limiter;
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.ArrayList JavaDoc;
42 import java.util.List JavaDoc;
43 import java.util.Map JavaDoc;
44
45 /**
46  * Hide preview entries from normal display.
47  * Preview entires have the word PREVIEW (by default) at the start of the title.
48  * To see the preview items along with normal entries add the parameter
49  * preview="true"
50  *
51  * @author <a HREF="http://nick.chalko.com"/>Nick Chalko</a>
52  * @author David Czarnecki
53  * @version $Id: PreviewPlugin.java,v 1.1 2006/03/20 21:30:56 czarneckid Exp $
54  * @since blojsom 3.0
55  */
56 public class PreviewPlugin implements Plugin {
57
58     private static final String JavaDoc PLUGIN_PREVIEW_TITLE_PREFIX_IP = "plugin-preview-title-prefix";
59     private static final String JavaDoc PLUGIN_PREVIEW_PREVIEW_PASSWORD_IP = "plugin-preview-preview-password";
60
61     private static final String JavaDoc DEFAULT_TITLE_PREFIX = "PREVIEW";
62     private static final String JavaDoc DEFAULT_PREVIEW_PASSWORD = "true";
63
64     /**
65      * Request parameter for the "preview"
66      */
67     private static final String JavaDoc PREVIEW_PARAM = "preview";
68
69     /**
70      * Default constructor
71      */
72     public PreviewPlugin() {
73     }
74
75     /**
76      * Initialize this plugin. This method only called when the plugin is instantiated.
77      *
78      * @throws org.blojsom.plugin.PluginException
79      * If there is an error initializing the plugin
80      */
81     public void init() throws PluginException {
82     }
83
84     /**
85      * Process the blog entries
86      *
87      * @param httpServletRequest Request
88      * @param httpServletResponse Response
89      * @param blog {@link Blog} instance
90      * @param context Context
91      * @param entries Blog entries retrieved for the particular request
92      * @return Modified set of blog entries
93      * @throws PluginException If there is an error processing the blog entries
94      */
95     public Entry[] process(HttpServletRequest JavaDoc httpServletRequest, HttpServletResponse JavaDoc httpServletResponse, Blog blog, Map JavaDoc context, Entry[] entries) throws PluginException {
96         String JavaDoc titlePrefix = blog.getProperty(PLUGIN_PREVIEW_TITLE_PREFIX_IP);
97         if (BlojsomUtils.checkNullOrBlank(titlePrefix)) {
98             titlePrefix = DEFAULT_TITLE_PREFIX;
99         }
100
101         String JavaDoc previewPassword = blog.getProperty(PLUGIN_PREVIEW_PREVIEW_PASSWORD_IP);
102         if (BlojsomUtils.checkNullOrBlank(previewPassword)) {
103             previewPassword = DEFAULT_PREVIEW_PASSWORD;
104         }
105
106         // Determine if the user wants to preview posts
107 String JavaDoc previewParam = httpServletRequest.getParameter(PREVIEW_PARAM);
108         if (previewParam != null && previewParam.equals(previewPassword)) {
109             return entries;
110         } else {
111             List JavaDoc postedEntries = new ArrayList JavaDoc(entries.length);
112             for (int i = 0; i < entries.length; i++) {
113                 Entry entry = entries[i];
114                 if (entry != null && entry.getTitle() != null && !entry.getTitle().startsWith(titlePrefix)) {
115                     postedEntries.add(entry);
116                 }
117             }
118
119             return (Entry[]) postedEntries.toArray(new Entry[postedEntries.size()]);
120         }
121     }
122
123     /**
124      * Perform any cleanup for the plugin. Called after {@link #process}.
125      *
126      * @throws PluginException If there is an error performing cleanup for this plugin
127      */
128     public void cleanup() throws PluginException {
129     }
130
131     /**
132      * Called when BlojsomServlet is taken out of service
133      *
134      * @throws PluginException If there is an error in finalizing this plugin
135      */
136     public void destroy() throws PluginException {
137     }
138 }
139
Popular Tags