KickJava   Java API By Example, From Geeks To Geeks.

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


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 java.util.*;
110 import java.io.*;
111
112 import com.Yasna.forum.*;
113 import com.Yasna.codeviewer.*;
114
115 /**
116  * A ForumMessageFilter that Translates normal text into 'Hacker Speak'.
117  */
118 public class FilterHackerSpeak extends ForumMessageFilter implements Serializable {
119
120     /**
121      * Property values of the filter.
122      */
123     private Properties props;
124
125     /**
126      * Property descriptions of the filter.
127      */
128     private Properties propDescriptions;
129
130     /**
131      * Creates a new filter not associated with a message. This is
132      * generally only useful for defining a template filter that other
133      * fitlers will be cloned from.
134      */
135     public FilterHackerSpeak() {
136         super();
137         props = new Properties();
138         propDescriptions = new Properties();
139     }
140
141     /**
142      * Creates a new filter wrapped around the specified message. This
143      * constructor is normally called when cloning a filter template.
144      *
145      * @param message the ForumMessage to wrap the new filter around.
146      * @param properties the property values for the filter.
147      * @param propertyDescriptions the property descriptions for the filter.
148      */
149     public FilterHackerSpeak(ForumMessage message, Properties props,
150             Properties propDescriptions)
151     {
152         super(message);
153         this.props = new Properties(props);
154         this.propDescriptions = new Properties(propDescriptions);
155     }
156
157     /**
158      * Clones a new filter that will have the same properties and that
159      * will wrap around the specified message.
160      *
161      * @param message the ForumMessage to wrap the new filter around.
162      */
163     public ForumMessageFilter clone(ForumMessage message){
164         return new FilterHackerSpeak(message,props,propDescriptions);
165     }
166
167     /**
168      * Returns the name of the filter.
169      */
170     public String JavaDoc getName() {
171         return "Hacker Speak";
172     }
173
174     /**
175      * Returns a description of the filter.
176      */
177     public String JavaDoc getDescription() {
178         return "Translates normal text into 'Hacker Speak'.";
179     }
180
181     /**
182      * Returns the author of the filter.
183      */
184     public String JavaDoc getAuthor() {
185         return "CoolServlets.com";
186     }
187
188     /**
189      * Returns the major version number of the filter.
190      */
191     public int getMajorVersion() {
192         return 1;
193     }
194
195     /**
196      * Returns a description of the filter.
197      */
198     public int getMinorVersion() {
199         return 0;
200     }
201
202     /**
203      * Returns the value of a property of the filter.
204      *
205      * @param name the name of the property.
206      * @returns the value of the property.
207      */
208     public String JavaDoc getFilterProperty(String JavaDoc name) {
209         return props.getProperty(name);
210     }
211
212     /**
213      * Returns the description of a property of the filter.
214      *
215      * @param name the name of the property.
216      * @return the description of the property.
217      */
218     public String JavaDoc getFilterPropertyDescription(String JavaDoc name) {
219         return propDescriptions.getProperty(name);
220     }
221
222     /**
223      * Returns an Enumeration of all the property names.
224      */
225     public Enumeration filterPropertyNames() {
226         //No properties, so return null.
227 return null;
228     }
229
230     /**
231      * Sets a property of the filter. Each filter has a set number of
232      * properties that are determined by the filter author.
233      *
234      * @param name the name of the property to set.
235      * @param value the new value for the property.
236      *
237      * @throws IllegalArgumentException if the property trying to be set doesn't
238      * exist.
239      */
240     public void setFilterProperty(String JavaDoc name, String JavaDoc value)
241             throws IllegalArgumentException JavaDoc
242     {
243         if (props.getProperty(name) == null) {
244             throw new IllegalArgumentException JavaDoc();
245         }
246         props.put(name, value);
247     }
248
249     /**
250      * <b>Overloaded</b> to return the subject of the message with HTML tags
251      * escaped.
252      */
253     public String JavaDoc getSubject() {
254         return makeHacker(message.getSubject());
255     }
256
257     /**
258      * <b>Overloaded</b> to return the body of the message with HTML tags
259      * escaped.
260      */
261     public String JavaDoc getBody() {
262         return makeHacker(message.getBody());
263     }
264
265     /**
266      * This method takes a string which may contain HTML tags (ie, <b>, <table>,
267      * etc) and converts the '<' and '>' characters to their HTML escape
268      * sequences.
269      *
270      * @param input The text to be converted.
271      * @return The input string with the characters '<' and '>' replaced with
272      * &lt; and &gt; respectively.
273      */
274     private String JavaDoc makeHacker( String JavaDoc input ) {
275         //Check if the string is null or zero length -- if so, return
276 //what was sent in.
277 if( input == null || input.length() == 0 ) {
278             return input;
279         }
280         //Use a StringBuffer in lieu of String concatenation -- it is
281 //much more efficient this way.
282 StringBuffer JavaDoc buf = new StringBuffer JavaDoc(input.length());
283         char ch = ' ';
284         for( int i=0; i<input.length(); i++ ) {
285             ch = input.charAt(i);
286             if (Math.random() < .20) {
287                 if( ch == 'a' ) {
288                     buf.append( "@" );
289                 }
290                 else if( ch == 'e' ) {
291                     buf.append( "3" );
292                 }
293                 else if( ch == 'g' ) {
294                     buf.append( "6" );
295                 }
296                 else if( ch == 'i' ) {
297                     buf.append( "1" );
298                 }
299                 else if( ch == 'o' ) {
300                     buf.append( "0" );
301                 }
302                 else if( ch == 't' ) {
303                     buf.append( "7" );
304                 }
305                 else if( ch == 's' ) {
306                     buf.append( "$" );
307                 }
308                 else {
309                     buf.append( ch );
310                 }
311             }
312             else {
313                 buf.append( ch );
314             }
315         }
316         return buf.toString();
317     }
318 }
319
Popular Tags