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.trackback;
031:
032: import org.apache.commons.logging.Log;
033: import org.apache.commons.logging.LogFactory;
034: import org.blojsom.blog.Blog;
035: import org.blojsom.blog.Entry;
036: import org.blojsom.plugin.Plugin;
037: import org.blojsom.plugin.PluginException;
038:
039: import javax.servlet.http.HttpServletRequest;
040: import javax.servlet.http.HttpServletResponse;
041: import java.util.HashMap;
042: import java.util.Map;
043:
044: /**
045: * Trackback moderation plugin
046: *
047: * @author David Czarnecki
048: * @version $Id: TrackbackModerationPlugin.java,v 1.2 2007/01/17 02:35:14 czarneckid Exp $
049: * @since blojsom 3.0
050: */
051: public class TrackbackModerationPlugin implements Plugin {
052:
053: private Log _logger = LogFactory
054: .getLog(TrackbackModerationPlugin.class);
055:
056: // blog.properties property
057: public static final String TRACKBACK_MODERATION_ENABLED = "trackback-moderation-enabled";
058:
059: // Trackback meta-data
060: public static final String BLOJSOM_TRACKBACK_MODERATION_PLUGIN_APPROVED = "BLOJSOM_TRACKBACK_MODERATION_PLUGIN_APPROVED";
061:
062: /**
063: * Construct a new trackback moderation plugin
064: */
065: public TrackbackModerationPlugin() {
066: }
067:
068: /**
069: * Initialize this plugin. This method only called when the plugin is instantiated.
070: *
071: * @throws org.blojsom.plugin.PluginException
072: * If there is an error initializing the plugin
073: */
074: public void init() throws PluginException {
075: }
076:
077: /**
078: * Process the blog entries
079: *
080: * @param httpServletRequest Request
081: * @param httpServletResponse Response
082: * @param blog {@link Blog} instance
083: * @param context Context
084: * @param entries Blog entries retrieved for the particular request
085: * @return Modified set of blog entries
086: * @throws PluginException If there is an error processing the blog entries
087: */
088: public Entry[] process(HttpServletRequest httpServletRequest,
089: HttpServletResponse httpServletResponse, Blog blog,
090: Map context, Entry[] entries) throws PluginException {
091: moderateTrackback(httpServletRequest, httpServletResponse,
092: blog, context, entries);
093:
094: return entries;
095: }
096:
097: /**
098: * Simple check to see if trackback moderation is enabled
099: * <p/>
100: * @param httpServletRequest Request
101: * @param httpServletResponse Response
102: * @param blog {@link Blog} instance
103: * @param context Context
104: * @param entries Blog entries retrieved for the particular request
105: * @throws PluginException If there is an error in moderating a trackback
106: */
107: protected void moderateTrackback(
108: HttpServletRequest httpServletRequest,
109: HttpServletResponse httpServletResponse, Blog blog,
110: Map context, Entry[] entries) throws PluginException {
111: if ("true".equalsIgnoreCase(blog
112: .getProperty(TRACKBACK_MODERATION_ENABLED))) {
113: if ("y".equalsIgnoreCase(httpServletRequest
114: .getParameter(TrackbackPlugin.TRACKBACK_PARAM))
115: && blog.getBlogTrackbacksEnabled().booleanValue()) {
116: Map trackbackMetaData;
117: if (context
118: .containsKey(TrackbackPlugin.BLOJSOM_PLUGIN_TRACKBACK_METADATA)) {
119: trackbackMetaData = (Map) context
120: .get(TrackbackPlugin.BLOJSOM_PLUGIN_TRACKBACK_METADATA);
121: } else {
122: trackbackMetaData = new HashMap();
123: }
124:
125: trackbackMetaData.put(
126: BLOJSOM_TRACKBACK_MODERATION_PLUGIN_APPROVED,
127: Boolean.FALSE.toString());
128: context
129: .put(
130: TrackbackPlugin.BLOJSOM_PLUGIN_TRACKBACK_METADATA,
131: trackbackMetaData);
132:
133: if (_logger.isDebugEnabled()) {
134: _logger
135: .debug("Marking trackback as requiring approval");
136: }
137: }
138: }
139: }
140:
141: /**
142: * Perform any cleanup for the plugin. Called after {@link #process}.
143: *
144: * @throws org.blojsom.plugin.PluginException
145: * If there is an error performing cleanup for this plugin
146: */
147: public void cleanup() throws PluginException {
148: }
149:
150: /**
151: * Called when BlojsomServlet is taken out of service
152: *
153: * @throws org.blojsom.plugin.PluginException
154: * If there is an error in finalizing this plugin
155: */
156: public void destroy() throws PluginException {
157: }
158: }
|