KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > blojsom > plugin > macro > MacroExpansionPlugin


1 /**
2  * Copyright (c) 2003-2006, David A. Czarnecki
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *
8  * Redistributions of source code must retain the above copyright notice, this list of conditions and the
9  * following disclaimer.
10  * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
11  * following disclaimer in the documentation and/or other materials provided with the distribution.
12  * Neither the name of "David A. Czarnecki" and "blojsom" nor the names of its contributors may be used to
13  * endorse or promote products derived from this software without specific prior written permission.
14  * Products derived from this software may not be called "blojsom", nor may "blojsom" appear in their name,
15  * without prior written permission of David A. Czarnecki.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
18  * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
19  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
20  * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
21  * EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
26  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
27  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
29  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  */
31 package org.blojsom.plugin.macro;
32
33 import org.blojsom.blog.Blog;
34 import org.blojsom.blog.Entry;
35 import org.blojsom.plugin.Plugin;
36 import org.blojsom.plugin.PluginException;
37 import org.blojsom.util.BlojsomUtils;
38
39 import javax.servlet.http.HttpServletRequest JavaDoc;
40 import javax.servlet.http.HttpServletResponse JavaDoc;
41 import java.util.Map JavaDoc;
42 import java.util.regex.Matcher JavaDoc;
43 import java.util.regex.Pattern JavaDoc;
44
45 /**
46  * Macro Expansion Plugin
47  *
48  * @author David Czarnecki
49  * @author Mark Lussier
50  * @since blojsom 3.0
51  * @version $Id: MacroExpansionPlugin.java,v 1.1 2006/03/20 21:30:56 czarneckid Exp $
52  */
53 public class MacroExpansionPlugin implements Plugin {
54
55     /**
56      * Regular expression to identify macros as $MACRO$ and DOES NOT ignore escaped $'s
57      */
58     private static final String JavaDoc MACRO_REGEX = "(\\$[^\\$]*\\$)";
59
60     /**
61      * Default constructor. Compiles the macro regular expression pattern, $MACRO$
62      */
63     public MacroExpansionPlugin() {
64     }
65
66     /**
67      * Initialize this plugin. This method only called when the plugin is instantiated.
68      *
69      * @throws PluginException If there is an error initializing the plugin
70      */
71     public void init() throws PluginException {
72     }
73
74     /**
75      * Expand macro tokens in an entry
76      *
77      * @param content Entry to process
78      * @param macros Macros to expand in the content
79      * @return The macro expanded string
80      */
81     private String JavaDoc replaceMacros(String JavaDoc content, Map JavaDoc macros) {
82         if (BlojsomUtils.checkNullOrBlank(content)) {
83             return content;
84         }
85
86         Pattern JavaDoc macroPattern = Pattern.compile(MACRO_REGEX);
87         Matcher JavaDoc matcher = macroPattern.matcher(content);
88
89         while (matcher.find()) {
90             String JavaDoc token = matcher.group();
91             String JavaDoc macro = token.substring(1, token.length() - 1);
92             if (macros.containsKey(macro)) {
93                 content = BlojsomUtils.replace(content, token, (String JavaDoc) macros.get(macro));
94             }
95         }
96
97         return content;
98     }
99
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 JavaDoc httpServletRequest,
112                                HttpServletResponse JavaDoc httpServletResponse,
113                                Blog blog,
114                                Map JavaDoc context,
115                                Entry[] entries) throws PluginException {
116         Map JavaDoc macros = MacroExpansionUtilities.readMacros(blog);
117
118         for (int i = 0; i < entries.length; i++) {
119             Entry entry = entries[i];
120             entry.setTitle(replaceMacros(entry.getTitle(), macros));
121             entry.setDescription(replaceMacros(entry.getDescription(), macros));
122         }
123
124         return entries;
125     }
126
127     /**
128      * Perform any cleanup for the plugin. Called after {@link #process}.
129      *
130      * @throws PluginException If there is an error performing cleanup for this plugin
131      */
132     public void cleanup() throws PluginException {
133     }
134
135     /**
136      * Called when BlojsomServlet is taken out of service
137      *
138      * @throws PluginException If there is an error in finalizing this plugin
139      */
140     public void destroy() throws PluginException {
141     }
142 }
143
144
145
Popular Tags