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.limiter;
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.ArrayList;
041: import java.util.List;
042: import java.util.Map;
043:
044: /**
045: * Hide preview entries from normal display.
046: * Preview entires have the word PREVIEW (by default) at the start of the title.
047: * To see the preview items along with normal entries add the parameter
048: * preview="true"
049: *
050: * @author <a href="http://nick.chalko.com"/>Nick Chalko</a>
051: * @author David Czarnecki
052: * @version $Id: PreviewPlugin.java,v 1.2 2007/01/17 02:35:10 czarneckid Exp $
053: * @since blojsom 3.0
054: */
055: public class PreviewPlugin implements Plugin {
056:
057: private static final String PLUGIN_PREVIEW_TITLE_PREFIX_IP = "plugin-preview-title-prefix";
058: private static final String PLUGIN_PREVIEW_PREVIEW_PASSWORD_IP = "plugin-preview-preview-password";
059:
060: private static final String DEFAULT_TITLE_PREFIX = "PREVIEW";
061: private static final String DEFAULT_PREVIEW_PASSWORD = "true";
062:
063: /**
064: * Request parameter for the "preview"
065: */
066: private static final String PREVIEW_PARAM = "preview";
067:
068: /**
069: * Default constructor
070: */
071: public PreviewPlugin() {
072: }
073:
074: /**
075: * Initialize this plugin. This method only called when the plugin is instantiated.
076: *
077: * @throws org.blojsom.plugin.PluginException
078: * If there is an error initializing the plugin
079: */
080: public void init() throws PluginException {
081: }
082:
083: /**
084: * Process the blog entries
085: *
086: * @param httpServletRequest Request
087: * @param httpServletResponse Response
088: * @param blog {@link Blog} instance
089: * @param context Context
090: * @param entries Blog entries retrieved for the particular request
091: * @return Modified set of blog entries
092: * @throws PluginException If there is an error processing the blog entries
093: */
094: public Entry[] process(HttpServletRequest httpServletRequest,
095: HttpServletResponse httpServletResponse, Blog blog,
096: Map context, Entry[] entries) throws PluginException {
097: String titlePrefix = blog
098: .getProperty(PLUGIN_PREVIEW_TITLE_PREFIX_IP);
099: if (BlojsomUtils.checkNullOrBlank(titlePrefix)) {
100: titlePrefix = DEFAULT_TITLE_PREFIX;
101: }
102:
103: String previewPassword = blog
104: .getProperty(PLUGIN_PREVIEW_PREVIEW_PASSWORD_IP);
105: if (BlojsomUtils.checkNullOrBlank(previewPassword)) {
106: previewPassword = DEFAULT_PREVIEW_PASSWORD;
107: }
108:
109: // Determine if the user wants to preview posts
110: String previewParam = httpServletRequest
111: .getParameter(PREVIEW_PARAM);
112: if (previewParam != null
113: && previewParam.equals(previewPassword)) {
114: return entries;
115: } else {
116: List postedEntries = new ArrayList(entries.length);
117: for (int i = 0; i < entries.length; i++) {
118: Entry entry = entries[i];
119: if (entry != null && entry.getTitle() != null
120: && !entry.getTitle().startsWith(titlePrefix)) {
121: postedEntries.add(entry);
122: }
123: }
124:
125: return (Entry[]) postedEntries
126: .toArray(new Entry[postedEntries.size()]);
127: }
128: }
129:
130: /**
131: * Perform any cleanup for the plugin. Called after {@link #process}.
132: *
133: * @throws PluginException If there is an error performing cleanup for this plugin
134: */
135: public void cleanup() throws PluginException {
136: }
137:
138: /**
139: * Called when BlojsomServlet is taken out of service
140: *
141: * @throws PluginException If there is an error in finalizing this plugin
142: */
143: public void destroy() throws PluginException {
144: }
145: }
|