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.macro;
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.Map;
041: import java.util.regex.Matcher;
042: import java.util.regex.Pattern;
043:
044: /**
045: * Macro Expansion Plugin
046: *
047: * @author David Czarnecki
048: * @author Mark Lussier
049: * @since blojsom 3.0
050: * @version $Id: MacroExpansionPlugin.java,v 1.2 2007/01/17 02:35:11 czarneckid Exp $
051: */
052: public class MacroExpansionPlugin implements Plugin {
053:
054: /**
055: * Regular expression to identify macros as $MACRO$ and DOES NOT ignore escaped $'s
056: */
057: private static final String MACRO_REGEX = "(\\$[^\\$]*\\$)";
058:
059: /**
060: * Default constructor. Compiles the macro regular expression pattern, $MACRO$
061: */
062: public MacroExpansionPlugin() {
063: }
064:
065: /**
066: * Initialize this plugin. This method only called when the plugin is instantiated.
067: *
068: * @throws PluginException If there is an error initializing the plugin
069: */
070: public void init() throws PluginException {
071: }
072:
073: /**
074: * Expand macro tokens in an entry
075: *
076: * @param content Entry to process
077: * @param macros Macros to expand in the content
078: * @return The macro expanded string
079: */
080: private String replaceMacros(String content, Map macros) {
081: if (BlojsomUtils.checkNullOrBlank(content)) {
082: return content;
083: }
084:
085: Pattern macroPattern = Pattern.compile(MACRO_REGEX);
086: Matcher matcher = macroPattern.matcher(content);
087:
088: while (matcher.find()) {
089: String token = matcher.group();
090: String macro = token.substring(1, token.length() - 1);
091: if (macros.containsKey(macro)) {
092: content = BlojsomUtils.replace(content, token,
093: (String) macros.get(macro));
094: }
095: }
096:
097: return content;
098: }
099:
100: /**
101: * Process the blog entries
102: *
103: * @param httpServletRequest Request
104: * @param httpServletResponse Response
105: * @param blog {@link Blog} instance
106: * @param context Context
107: * @param entries Blog entries retrieved for the particular request
108: * @return Modified set of blog entries
109: * @throws PluginException If there is an error processing the blog entries
110: */
111: public Entry[] process(HttpServletRequest httpServletRequest,
112: HttpServletResponse httpServletResponse, Blog blog,
113: Map context, Entry[] entries) throws PluginException {
114: Map macros = MacroExpansionUtilities.readMacros(blog);
115:
116: for (int i = 0; i < entries.length; i++) {
117: Entry entry = entries[i];
118: entry.setTitle(replaceMacros(entry.getTitle(), macros));
119: entry.setDescription(replaceMacros(entry.getDescription(),
120: macros));
121: }
122:
123: return entries;
124: }
125:
126: /**
127: * Perform any cleanup for the plugin. Called after {@link #process}.
128: *
129: * @throws PluginException If there is an error performing cleanup for this plugin
130: */
131: public void cleanup() throws PluginException {
132: }
133:
134: /**
135: * Called when BlojsomServlet is taken out of service
136: *
137: * @throws PluginException If there is an error in finalizing this plugin
138: */
139: public void destroy() throws PluginException {
140: }
141: }
|