KickJava   Java API By Example, From Geeks To Geeks.

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


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
111 import com.Yasna.forum.*;
112
113 /**
114  * A ForumMessageFilter that replaces profanity.
115  */

116 public class FilterProfanity extends ForumMessageFilter {
117
118     /**
119      * Array of all the bad words to filter.
120      */

121     private String JavaDoc [] filterList;
122
123     /**
124      * Indicates if case of words should be ignored.
125      */

126     private boolean ignoreCase = true;
127
128     /**
129      * Property values of the filter.
130      */

131     private Properties props;
132
133     /**
134      * Property descriptions of the filter.
135      */

136     private Properties propDescriptions;
137
138     /**
139      * Creates a new filter not associated with a message. This is
140      * generally only useful for defining a template filter that other
141      * fitlers will be cloned from.
142      */

143     public FilterProfanity() {
144         super();
145         this.props = new Properties();
146         this.propDescriptions = new Properties();
147         initializeProperties();
148     }
149
150     /**
151      * Creates a new filter wrapped around the specified message. This
152      * constructor is normally called when cloning a filter template.
153      *
154      * @param message the ForumMessage to wrap the new filter around.
155      * @param properties the property values for the filter.
156      * @param propertyDescriptions the property descriptions for the filter.
157      */

158     public FilterProfanity(ForumMessage message, Properties props,
159             Properties propDescriptions, String JavaDoc [] filterList, boolean ignoreCase)
160     {
161         super(message);
162         this.props = new Properties(props);
163         this.propDescriptions = new Properties(propDescriptions);
164         this.filterList = filterList;
165         this.ignoreCase = ignoreCase;
166     }
167
168     /**
169      * Clones a new filter that will have the same properties and that
170      * will wrap around the specified message.
171      *
172      * @param message the ForumMessage to wrap the new filter around.
173      */

174     public ForumMessageFilter clone(ForumMessage message){
175         return new FilterProfanity(message, props, propDescriptions,
176                 filterList, ignoreCase);
177     }
178
179     /**
180      * Returns the name of the filter.
181      */

182     public String JavaDoc getName() {
183         return "Profanity Filter";
184     }
185
186     /**
187      * Returns a description of the filter.
188      */

189     public String JavaDoc getDescription() {
190         return "Removes profanity from messages using a custom word list.";
191     }
192
193     /**
194      * Returns the author of the filter.
195      */

196     public String JavaDoc getAuthor() {
197         return "CoolServlets.com";
198     }
199
200     /**
201      * Returns the major version number of the filter.
202      */

203     public int getMajorVersion() {
204         return 1;
205     }
206
207     /**
208      * Returns the minor version number of the filter.
209      */

210     public int getMinorVersion() {
211         return 0;
212     }
213
214     /**
215      * Returns the value of a property of the filter.
216      *
217      * @param name the name of the property.
218      * @returns the value of the property.
219      */

220     public String JavaDoc getFilterProperty(String JavaDoc name) {
221         return props.getProperty(name);
222     }
223
224     /**
225      * Returns the description of a property of the filter.
226      *
227      * @param name the name of the property.
228      * @return the description of the property.
229      */

230     public String JavaDoc getFilterPropertyDescription(String JavaDoc name) {
231         return propDescriptions.getProperty(name);
232     }
233
234     /**
235      * Returns an Enumeration of all the property names.
236      */

237     public Enumeration filterPropertyNames() {
238         return props.propertyNames();
239     }
240
241     /**
242      * Sets a property of the filter. Each filter has a set number of
243      * properties that are determined by the filter author.
244      *
245      * @param name the name of the property to set.
246      * @param value the new value for the property.
247      *
248      * @throws IllegalArgumentException if the property trying to be set doesn't
249      * exist.
250      */

251     public void setFilterProperty(String JavaDoc name, String JavaDoc value)
252             throws IllegalArgumentException JavaDoc
253     {
254         if (props.getProperty(name) == null) {
255             throw new IllegalArgumentException JavaDoc();
256         }
257         props.put(name, value);
258         applyProperties();
259     }
260
261     /**
262      * <b>Overloaded</b> to return the subject of the message with profanity
263      * filtered out.
264      */

265     public String JavaDoc getSubject() {
266         return filterProfanity(message.getSubject());
267     }
268
269     /**
270      * <b>Overloaded</b> to return the body of the message with profanity
271      * filtered out.
272      */

273     public String JavaDoc getBody() {
274         return filterProfanity(message.getBody());
275     }
276
277     /**
278      * Creates properties and sets their descriptions.
279      */

280     private void initializeProperties() {
281         filterList = new String JavaDoc[0];
282         props.put("filterList","");
283         props.put("ignoreCase","on");
284
285         propDescriptions.put("filterList","A comma delimitted list of "
286             + "the bad words to filter out.");
287         propDescriptions.put("ignoreCase","Indicates whether the case "
288             + "of words should be ignored or not. For example, when on, the "
289             + "words 'CRap' and 'crap' would both be filterd if an entry of "
290             + "'CRAP' was found in the filter list.");
291     }
292
293     private void applyProperties() {
294         ignoreCase = ((String JavaDoc)props.getProperty("ignoreCase")).equals("on");
295         String JavaDoc list = (String JavaDoc)props.get("filterList");
296         StringTokenizer tokens = new StringTokenizer(list,",");
297         String JavaDoc [] newFilterList = new String JavaDoc[tokens.countTokens()];
298         for (int i=0; i<newFilterList.length; i++) {
299             if (ignoreCase) {
300                 newFilterList[i] = tokens.nextToken().toLowerCase().trim();
301             }
302             else {
303                 newFilterList[i] = tokens.nextToken().trim();
304             }
305         }
306         filterList = newFilterList;
307     }
308
309     /**
310      * Filters out bad words.
311      */

312     private String JavaDoc filterProfanity(String JavaDoc str) {
313         // Check to see if the string is null or zero-length
314
if (str == null || "".equals(str)) {
315             return str;
316         }
317         String JavaDoc lower;
318         if (ignoreCase) {
319             lower = str.toLowerCase();
320         }
321         else {
322             lower = str;
323         }
324         for (int i=0; i<filterList.length; i++) {
325             str = replace(str, lower, filterList[i], cleanWord(filterList[i].length()));
326         }
327         return str;
328     }
329
330     /**
331      * Generates a string of characters of specified length. For example:
332      * !@%$ or %!@$%!@@ or *****
333      */

334     private String JavaDoc cleanWord(int length) {
335         char[] newWord = new char[length];
336         for (int i=0; i<newWord.length; i++) {
337             newWord[i] = '*';
338         }
339         return new String JavaDoc(newWord);
340     }
341
342     /**
343      * Replaces all instances of oldString with newString in the String line.
344      */

345     private String JavaDoc replace(String JavaDoc line, String JavaDoc lowerCaseLine,
346             String JavaDoc oldString, String JavaDoc newString )
347     {
348         int i=0;
349         if ( ( i=lowerCaseLine.indexOf( oldString, i ) ) >= 0 ) {
350             int oLength = oldString.length();
351             int nLength = newString.length();
352             StringBuffer JavaDoc buf = new StringBuffer JavaDoc(line.length()+15);
353             buf.append(line.substring(0,i)).append(newString);
354             i += oLength;
355             int j = i;
356             while( ( i=lowerCaseLine.indexOf( oldString, i ) ) > 0 ) {
357                 buf.append(line.substring(j,i)).append(newString);
358                 i += oLength;
359                 j = i;
360             }
361             buf.append(line.substring(j));
362             return buf.toString();
363         }
364         return line;
365     }
366 }
367
368
Popular Tags