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.meta;
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: import org.blojsom.util.BlojsomUtils;
039:
040: import javax.servlet.http.HttpServletRequest;
041: import javax.servlet.http.HttpServletResponse;
042: import java.io.BufferedReader;
043: import java.io.IOException;
044: import java.io.StringReader;
045: import java.util.HashMap;
046: import java.util.Map;
047:
048: /**
049: * MetaPlugin
050: *
051: * @author David Czarnecki
052: * @version $Id: MetaPlugin.java,v 1.2 2007/01/17 02:35:11 czarneckid Exp $
053: * @since blojsom 3.0
054: */
055: public class MetaPlugin implements Plugin {
056:
057: private Log _logger = LogFactory.getLog(MetaPlugin.class);
058:
059: private String _metaPrefix = "meta-";
060:
061: /**
062: * Default constructor
063: */
064: public MetaPlugin() {
065: }
066:
067: /**
068: * Initialize this plugin. This method only called when the plugin is instantiated.
069: *
070: * @throws PluginException If there is an error initializing the plugin
071: */
072: public void init() throws PluginException {
073: }
074:
075: /**
076: * Process the blog entries
077: *
078: * @param httpServletRequest Request
079: * @param httpServletResponse Response
080: * @param blog {@link Blog} instance
081: * @param context Context
082: * @param entries Blog entries retrieved for the particular request
083: * @return Modified set of blog entries
084: * @throws PluginException If there is an error processing the blog entries
085: */
086: public Entry[] process(HttpServletRequest httpServletRequest,
087: HttpServletResponse httpServletResponse, Blog blog,
088: Map context, Entry[] entries) throws PluginException {
089: String description;
090: Entry entry;
091: BufferedReader br;
092: StringReader sr;
093: String line;
094: StringBuffer noMetaDescription;
095:
096: for (int i = 0; i < entries.length; i++) {
097: entry = entries[i];
098: description = entry.getDescription();
099: sr = new StringReader(description);
100: br = new BufferedReader(sr);
101:
102: try {
103: int equalIndex;
104: String key;
105: String value;
106: Map metadata;
107: noMetaDescription = new StringBuffer();
108:
109: while ((line = br.readLine()) != null) {
110: if (line.trim().startsWith(_metaPrefix)) {
111: equalIndex = line.indexOf("=", _metaPrefix
112: .length());
113: if (equalIndex != -1) {
114: key = line.substring(_metaPrefix.length(),
115: equalIndex);
116: value = line.substring(equalIndex + 1);
117: metadata = entry.getMetaData();
118: if (metadata != null) {
119: metadata.put(key, value);
120: entry.setMetaData(metadata);
121: } else {
122: metadata = new HashMap();
123: metadata.put(key, value);
124: entry.setMetaData(metadata);
125: }
126: } else {
127: noMetaDescription.append(line).append(
128: BlojsomUtils.LINE_SEPARATOR);
129: }
130: } else {
131: noMetaDescription.append(line).append(
132: BlojsomUtils.LINE_SEPARATOR);
133: }
134: }
135:
136: entry.setDescription(noMetaDescription.toString());
137: } catch (IOException e) {
138: if (_logger.isErrorEnabled()) {
139: _logger.error(e);
140: }
141: }
142: }
143:
144: return entries;
145: }
146:
147: /**
148: * Perform any cleanup for the plugin. Called after {@link #process}.
149: *
150: * @throws PluginException If there is an error performing cleanup for this plugin
151: */
152: public void cleanup() throws PluginException {
153: }
154:
155: /**
156: * Called when BlojsomServlet is taken out of service
157: *
158: * @throws PluginException If there is an error in finalizing this plugin
159: */
160: public void destroy() throws PluginException {
161: }
162: }
|