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.hyperlink;
031:
032: import org.blojsom.blog.*;
033: import org.blojsom.plugin.Plugin;
034: import org.blojsom.plugin.PluginException;
035:
036: import javax.servlet.http.HttpServletRequest;
037: import javax.servlet.http.HttpServletResponse;
038: import java.util.Map;
039:
040: /**
041: * Hyperlink HREFing Plugin
042: *
043: * @author David Czarnecki
044: * @author Mark Lussier
045: * @since blojsom 3.0
046: * @version $Id: HyperlinkURLPlugin.java,v 1.3 2007/01/17 02:35:10 czarneckid Exp $
047: */
048: public class HyperlinkURLPlugin implements Plugin {
049:
050: /**
051: * Protocol support for HREF links
052: */
053: private static final String URL_PROTOCOLS = "((ftp|http|https|gopher|mailto|news|nntp|telnet|wais|file)";
054:
055: /**
056: * Regular expression to identify URLs in the entry
057: */
058: private static final String URL_REGEX = "(^|[\t\r\n ])"
059: + URL_PROTOCOLS
060: + ":[A-Za-z0-9/](([A-Za-z0-9$_.+!*(),;/?:@&~=-])|%[A-Fa-f0-9]{2})+)";
061:
062: /**
063: * The resulting replace string for formatting the href
064: */
065: private static final String HREF_EXPRESSION = " <a href=\"$2\">$2</a>";
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: for (int i = 0; i < entries.length; i++) {
090: Entry entry = entries[i];
091:
092: entry.setDescription(entry.getDescription().replaceAll(
093: URL_REGEX, HREF_EXPRESSION));
094: }
095:
096: return entries;
097: }
098:
099: /**
100: * Perform any cleanup for the plugin. Called after {@link #process}.
101: *
102: * @throws PluginException If there is an error performing cleanup for this plugin
103: */
104: public void cleanup() throws PluginException {
105: }
106:
107: /**
108: * Called when BlojsomServlet is taken out of service
109: *
110: * @throws PluginException If there is an error in finalizing this plugin
111: */
112: public void destroy() throws PluginException {
113: }
114: }
|