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.search;
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.fetcher.Fetcher;
037: import org.blojsom.fetcher.FetcherException;
038: import org.blojsom.plugin.Plugin;
039: import org.blojsom.plugin.PluginException;
040: import org.blojsom.util.BlojsomUtils;
041:
042: import javax.servlet.http.HttpServletRequest;
043: import javax.servlet.http.HttpServletResponse;
044: import java.util.Map;
045:
046: /**
047: * SimpleSearchPlugin
048: *
049: * @author David Czarnecki
050: * @version $Id: SimpleSearchPlugin.java,v 1.6 2007/01/17 02:35:13 czarneckid Exp $
051: * @since blojsom 3.0
052: */
053: public class SimpleSearchPlugin implements Plugin {
054:
055: private Log _logger = LogFactory.getLog(SimpleSearchPlugin.class);
056:
057: /**
058: * Request parameter for the "query"
059: */
060: protected static final String QUERY_PARAM = "query";
061:
062: private Fetcher _fetcher;
063:
064: /**
065: * Default constructor
066: */
067: public SimpleSearchPlugin() {
068: }
069:
070: /**
071: * Set the {@link Fetcher}
072: *
073: * @param fetcher {@link Fetcher}
074: */
075: public void setFetcher(Fetcher fetcher) {
076: _fetcher = fetcher;
077: }
078:
079: /**
080: * Initialize this plugin. This method only called when the plugin is instantiated.
081: *
082: * @throws PluginException If there is an error initializing the plugin
083: */
084: public void init() throws PluginException {
085: }
086:
087: /**
088: * Process the blog entries
089: *
090: * @param httpServletRequest Request
091: * @param httpServletResponse Response
092: * @param blog {@link Blog} instance
093: * @param context Context
094: * @param entries Blog entries retrieved for the particular request
095: * @return Modified set of blog entries
096: * @throws PluginException If there is an error processing the blog entries
097: */
098: public Entry[] process(HttpServletRequest httpServletRequest,
099: HttpServletResponse httpServletResponse, Blog blog,
100: Map context, Entry[] entries) throws PluginException {
101: String query = httpServletRequest.getParameter(QUERY_PARAM);
102: if (BlojsomUtils.checkNullOrBlank(query)) {
103: return entries;
104: } else {
105: query = query.toLowerCase();
106: }
107:
108: try {
109: return _fetcher.findEntries(blog, query);
110: } catch (FetcherException e) {
111: if (_logger.isErrorEnabled()) {
112: _logger.error(e);
113: }
114:
115: return entries;
116: }
117: }
118:
119: /**
120: * Perform any cleanup for the plugin. Called after {@link #process}.
121: *
122: * @throws PluginException 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 PluginException If there is an error in finalizing this plugin
131: */
132: public void destroy() throws PluginException {
133: }
134: }
|