KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > blojsom > plugin > hyperlink > HyperlinkURLPlugin


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.hyperlink;
32
33 import org.blojsom.blog.*;
34 import org.blojsom.plugin.Plugin;
35 import org.blojsom.plugin.PluginException;
36
37 import javax.servlet.http.HttpServletRequest JavaDoc;
38 import javax.servlet.http.HttpServletResponse JavaDoc;
39 import java.util.Map JavaDoc;
40
41 /**
42  * Hyperlink HREFing Plugin
43  *
44  * @author David Czarnecki
45  * @author Mark Lussier
46  * @since blojsom 3.0
47  * @version $Id: HyperlinkURLPlugin.java,v 1.2 2006/03/20 22:50:40 czarneckid Exp $
48  */
49 public class HyperlinkURLPlugin implements Plugin {
50
51     /**
52      * Protocol support for HREF links
53      */
54     private static final String JavaDoc URL_PROTOCOLS = "((ftp|http|https|gopher|mailto|news|nntp|telnet|wais|file)";
55
56     /**
57      * Regular expression to identify URLs in the entry
58      */
59     private static final String JavaDoc URL_REGEX = "(^|[\t\r\n ])" + URL_PROTOCOLS
60             + ":[A-Za-z0-9/](([A-Za-z0-9$_.+!*(),;/?:@&~=-])|%[A-Fa-f0-9]{2})+)";
61
62     /**
63      * The resulting replace string for formatting the href
64      */
65     private static final String JavaDoc HREF_EXPRESSION = " <a HREF=\"$2\">$2</a>";
66
67     /**
68      * Initialize this plugin. This method only called when the plugin is instantiated.
69      *
70      * @throws PluginException If there is an error initializing the plugin
71      */
72     public void init() throws PluginException {
73     }
74
75     /**
76      * Process the blog entries
77      *
78      * @param httpServletRequest Request
79      * @param httpServletResponse Response
80      * @param blog {@link Blog} instance
81      * @param context Context
82      * @param entries Blog entries retrieved for the particular request
83      * @return Modified set of blog entries
84      * @throws PluginException If there is an error processing the blog entries
85      */
86     public Entry[] process(HttpServletRequest JavaDoc httpServletRequest,
87                                HttpServletResponse JavaDoc httpServletResponse,
88                                Blog blog,
89                                Map JavaDoc context,
90                                Entry[] entries) throws PluginException {
91         for (int i = 0; i < entries.length; i++) {
92             Entry entry = entries[i];
93
94             entry.setDescription(entry.getDescription().replaceAll(URL_REGEX, HREF_EXPRESSION));
95         }
96
97         return entries;
98     }
99
100     /**
101      * Perform any cleanup for the plugin. Called after {@link #process}.
102      *
103      * @throws PluginException If there is an error performing cleanup for this plugin
104      */
105     public void cleanup() throws PluginException {
106     }
107
108     /**
109      * Called when BlojsomServlet is taken out of service
110      *
111      * @throws PluginException If there is an error in finalizing this plugin
112      */
113     public void destroy() throws PluginException {
114     }
115 }
116
Popular Tags