KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > Yasna > forum > filter > FilterURLConverter


1 /**
2  * Copyright (C) 2001 Yasna.com. All rights reserved.
3  *
4  * ===================================================================
5  * The Apache Software License, Version 1.1
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright
12  * notice, this list of conditions and the following disclaimer.
13  *
14  * 2. Redistributions in binary form must reproduce the above copyright
15  * notice, this list of conditions and the following disclaimer in
16  * the documentation and/or other materials provided with the
17  * distribution.
18  *
19  * 3. The end-user documentation included with the redistribution,
20  * if any, must include the following acknowledgment:
21  * "This product includes software developed by
22  * Yasna.com (http://www.yasna.com)."
23  * Alternately, this acknowledgment may appear in the software itself,
24  * if and wherever such third-party acknowledgments normally appear.
25  *
26  * 4. The names "Yazd" and "Yasna.com" must not be used to
27  * endorse or promote products derived from this software without
28  * prior written permission. For written permission, please
29  * contact yazd@yasna.com.
30  *
31  * 5. Products derived from this software may not be called "Yazd",
32  * nor may "Yazd" appear in their name, without prior written
33  * permission of Yasna.com.
34  *
35  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
36  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
37  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
38  * DISCLAIMED. IN NO EVENT SHALL YASNA.COM OR
39  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
41  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
42  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
43  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
44  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
45  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
46  * SUCH DAMAGE.
47  * ====================================================================
48  *
49  * This software consists of voluntary contributions made by many
50  * individuals on behalf of Yasna.com. For more information
51  * on Yasna.com, please see <http://www.yasna.com>.
52  */
53
54 /**
55  * Copyright (C) 2000 CoolServlets.com. All rights reserved.
56  *
57  * ===================================================================
58  * The Apache Software License, Version 1.1
59  *
60  * Redistribution and use in source and binary forms, with or without
61  * modification, are permitted provided that the following conditions
62  * are met:
63  *
64  * 1. Redistributions of source code must retain the above copyright
65  * notice, this list of conditions and the following disclaimer.
66  *
67  * 2. Redistributions in binary form must reproduce the above copyright
68  * notice, this list of conditions and the following disclaimer in
69  * the documentation and/or other materials provided with the
70  * distribution.
71  *
72  * 3. The end-user documentation included with the redistribution,
73  * if any, must include the following acknowledgment:
74  * "This product includes software developed by
75  * CoolServlets.com (http://www.coolservlets.com)."
76  * Alternately, this acknowledgment may appear in the software itself,
77  * if and wherever such third-party acknowledgments normally appear.
78  *
79  * 4. The names "Jive" and "CoolServlets.com" must not be used to
80  * endorse or promote products derived from this software without
81  * prior written permission. For written permission, please
82  * contact webmaster@coolservlets.com.
83  *
84  * 5. Products derived from this software may not be called "Jive",
85  * nor may "Jive" appear in their name, without prior written
86  * permission of CoolServlets.com.
87  *
88  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
89  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
90  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
91  * DISCLAIMED. IN NO EVENT SHALL COOLSERVLETS.COM OR
92  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
93  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
94  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
95  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
96  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
97  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
98  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
99  * SUCH DAMAGE.
100  * ====================================================================
101  *
102  * This software consists of voluntary contributions made by many
103  * individuals on behalf of CoolServlets.com. For more information
104  * on CoolServlets.com, please see <http://www.coolservlets.com>.
105  */
106  
107 package com.Yasna.forum.filter;
108
109 import com.Yasna.forum.*;
110 import java.util.*;
111
112 /**
113  * A ForumMessageFilter that converts URL's to working HTML web links.
114  */
115 public class FilterURLConverter extends ForumMessageFilter {
116
117     /**
118      * Property values of the filter.
119      */
120     private Properties props;
121
122     /**
123      * Property descriptions of the filter.
124      */
125     private Properties propDescriptions;
126
127    /**
128     * Creates a new filter not associated with a message. This is
129     * generally only useful for defining a template filter that other
130     * fitlers will be cloned from.
131     */
132     public FilterURLConverter() {
133         super();
134         props = new Properties();
135         propDescriptions = new Properties();
136         initializeProperties();
137     }
138
139     /**
140      * Creates a new filter wrapped around the specified message. This
141      * constructor is normally called when cloning a filter template.
142      *
143      * @param message the ForumMessage to wrap the new filter around.
144      * @param properties the property values for the filter.
145      * @param propertyDescriptions the property descriptions for the filter.
146      */
147     public FilterURLConverter(ForumMessage message, Properties properties,
148             Properties propertyDescriptions)
149     {
150         super(message);
151         this.props = new Properties(properties);
152         this.propDescriptions = new Properties(propertyDescriptions);
153     }
154
155     /**
156      * Clones a new filter that will have the same properties and that
157      * will wrap around the specified message.
158      *
159      * @param message the ForumMessage to wrap the new filter around.
160      */
161     public ForumMessageFilter clone(ForumMessage message){
162         return new FilterURLConverter(message, props, propDescriptions);
163     }
164
165     /**
166      * Returns the name of the filter.
167      */
168     public String JavaDoc getName() {
169         return "URL Converter";
170     }
171
172     /**
173      * Returns a description of the filter.
174      */
175     public String JavaDoc getDescription() {
176         return "Converts URL's to working web links.";
177     }
178
179     /**
180      * Returns the author of the filter.
181      */
182     public String JavaDoc getAuthor() {
183         return "CoolServlets.com";
184     }
185
186     /**
187      * Returns the major version number of the filter.
188      */
189     public int getMajorVersion() {
190         return 1;
191     }
192
193     /**
194      * Returns the minor version number of the filter.
195      */
196     public int getMinorVersion() {
197         return 0;
198     }
199
200     /**
201      * Returns the value of a property of the filter.
202      *
203      * @param name the name of the property.
204      * @returns the value of the property.
205      */
206     public String JavaDoc getFilterProperty(String JavaDoc name) {
207         return props.getProperty(name);
208     }
209
210     /**
211      * Returns the description of a property of the filter.
212      *
213      * @param name the name of the property.
214      * @return the description of the property.
215      */
216     public String JavaDoc getFilterPropertyDescription(String JavaDoc name) {
217         return propDescriptions.getProperty(name);
218     }
219
220     /**
221      * Returns an Enumeration of all the property names.
222      */
223     public Enumeration filterPropertyNames() {
224         return props.propertyNames();
225     }
226
227     /**
228      * Sets a property of the filter. Each filter has a set number of
229      * properties that are determined by the filter author.
230      *
231      * @param name the name of the property to set.
232      * @param value the new value for the property.
233      *
234      * @throws IllegalArgumentException if the property trying to be set doesn't
235      * exist.
236      */
237     public void setFilterProperty(String JavaDoc name, String JavaDoc value)
238             throws IllegalArgumentException JavaDoc
239     {
240         if (props.getProperty(name) == null) {
241             throw new IllegalArgumentException JavaDoc();
242         }
243         props.put(name, value);
244     }
245
246     /**
247      * <b>Overloaded</b> to return the body of message with URLs changed
248      * to working links.
249      */
250     public String JavaDoc getBody() {
251         return convertURL(message.getBody());
252     }
253
254     /**
255      * Creates properties and sets their descriptions.
256      */
257     private void initializeProperties() {
258     }
259
260     /**
261      * This method takes a string which may contain URLs
262      * and replaces them with working links. It does this
263      * by adding the html tags <a href> and </a>.
264      *
265      * @param input the text to be converted.
266      * @returns the input string with the URLs replaced with links.
267      */
268     private String JavaDoc convertURL( String JavaDoc input ) {
269         //Check if the string is null or zero length -- if so, return
270 //what was sent in.
271 if( input == null || input.length() == 0 ) {
272             return input;
273         }
274         else {
275             StringBuffer JavaDoc buf = new StringBuffer JavaDoc();
276             
277             int i = 0, j = 0, oldend = 0;
278             int len = input.length();
279             char cur;
280
281             while ( ( i=input.indexOf( "http://", oldend) ) >= 0 ) {
282                 j=i+7;
283                 cur = input.charAt(j);
284                 while (j < len) {
285                     //Is a space?
286 if (cur == ' ') break;
287                     //Is html?
288 if (cur == '<') break;
289                     //Is a Win32 newline?
290 if (cur == '\n') break;
291                     //Is Unix newline?
292 if (cur == '\r' && j<len-1 && input.charAt(j+1) == '\n')
293                         break;
294
295                     j++;
296                     if (j<len) {
297                         cur = input.charAt(j);
298                     }
299                 }
300                 buf.append(input.substring(oldend,i));
301                 buf.append("<a href =\"");
302                 buf.append(input.substring(i,j));
303                 buf.append("\">");
304                 buf.append(input.substring(i,j));
305                 buf.append("</a>");
306                 oldend = j;
307             }
308             buf.append(input.substring(j,len));
309             return buf.toString();
310         }
311     }
312 }
313
Popular Tags