FilterFontStyle


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 com.Yasna.util.*;
111 import java.util.*;
112 import java.io.*;
113 
114 /**
115  * A ForumMessageFilter that replaces [b][/b] and [i][/i] tags with their HTML
116  * tag equivalents. This filter should only be run after any HTML stripping
117  * filters are.
118  */
119 public class FilterFontStyle extends ForumMessageFilter implements Serializable {
120 
121     /**
122      * Property values of the filter.
123      */
124     private Properties props;
125 
126     /**
127      * Property descriptions of the filter.
128      */
129     private Properties propDescriptions;
130 
131     /**
132      * Creates a new filter not associated with a message. This is
133      * generally only useful for defining a template filter that other
134      * fitlers will be cloned from.
135      */
136     public FilterFontStyle() {
137         super();
138         this.props = new Properties(props);
139         this.propDescriptions = new Properties(propDescriptions);
140         initializeProperties();
141     }
142 
143     /**
144      * Creates a new filter wrapped around the specified message. This
145      * constructor is normally called when cloning a filter template.
146      *
147      * @param message the ForumMessage to wrap the new filter around.
148      * @param properties the property values for the filter.
149      * @param propertyDescriptions the property descriptions for the filter.
150      */
151     public FilterFontStyle(ForumMessage message, Properties props,
152             Properties propDescriptions)
153     {
154         super(message);
155         this.props = new Properties(props);
156         this.propDescriptions = new Properties(propDescriptions);
157     }
158 
159     /**
160      * Clones a new filter that will have the same properties and that
161      * will wrap around the specified message.
162      *
163      * @param message the ForumMessage to wrap the new filter around.
164      */
165     public ForumMessageFilter clone(ForumMessage message){
166         return new FilterFontStyle(message, props, propDescriptions);
167     }
168 
169     /**
170      * Returns the name of the filter.
171      */
172     public String   getName() {
173         return "Font Stylizer";
174     }
175 
176     /**
177      * Returns a description of the filter.
178      */
179     public String   getDescription() {
180         return "Converts custom font tags into HTML equivalents. It " +
181                 "currently supports [b][/b] and [i][/i] tags.";
182     }
183 
184     /**
185      * Returns the author of the filter.
186      */
187     public String   getAuthor() {
188         return "CoolServlets.com";
189     }
190 
191     /**
192      * Returns the major version number of the filter.
193      */
194     public int getMajorVersion() {
195         return 1;
196     }
197 
198     /**
199      * Returns the minor version number of the filter.
200      */
201     public int getMinorVersion() {
202         return 0;
203     }
204 
205     /**
206      * Returns the value of a property of the filter.
207      *
208      * @param name the name of the property.
209      * @returns the value of the property.
210      */
211     public String   getFilterProperty(String   name) {
212         return props.getProperty(name);
213     }
214 
215     /**
216      * Returns the description of a property of the filter.
217      *
218      * @param name the name of the property.
219      * @return the description of the property.
220      */
221     public String   getFilterPropertyDescription(String   name) {
222         return propDescriptions.getProperty(name);
223     }
224 
225     /**
226      * Returns an Enumeration of all the property names.
227      */
228     public Enumeration filterPropertyNames() {
229         return props.propertyNames();
230     }
231 
232     /**
233      * Sets a property of the filter. Each filter has a set number of
234      * properties that are determined by the filter author. 
235      *
236      * @param name the name of the property to set.
237      * @param value the new value for the property.
238      *
239      * @throws IllegalArgumentException if the property trying to be set doesn't
240      *    exist.
241      */
242     public void setFilterProperty(String   name, String   value)
243             throws IllegalArgumentException  
244     {
245         if (props.getProperty(name) == null) {
246             throw new IllegalArgumentException  ();
247         }
248         props.put(name, value);
249     }
250 
251     /**
252      * <b>Overloaded</b> to return the body of the message with custom font
253      * stylizing tags translated to HTML.
254      */
255     public String   getBody() {
256         return fontStyleToHTML(message.getBody());
257     }
258 
259     /**
260      * Creates properties and sets their descriptions.
261      */
262     private void initializeProperties() {
263         props.put("Bold","on");
264         props.put("Italics","on");
265 
266         propDescriptions.put(
267             "Bold", "Toggles translation of [b][/b] to HTML bold tags."
268         );
269         propDescriptions.put(
270             "Italics", "Toggles translation of [i][/i] to HTML bold tags."
271         );
272     }
273   
274    /**
275     * This method takes a string which may contain CoolServlets tags that
276     * the style of a font.  These will be converted to HTML tags.
277     *
278     * @param input The text to be converted.
279     * @return The input string with the CoolServlets tags [b] (indicating
280     * bold, and [i] (indicating italics) changed to the HTML tags <b> and
281     * <i>, respectively. In addition, the corresponding tags [/b] and [/i]
282     * will be changed to </b> and </i>
283     */
284     private String   fontStyleToHTML( String   input ) {
285         // Check if the string is null or zero length -- if so, return what was sent in.
286         if( input == null || input.length() == 0 ) {
287             return input;
288         }
289         else {
290             // Create int [] objects to determine if all bold and italic
291             // tags have been closed
292             int [] boldStartCount = new int[1];
293             int [] italicsStartCount = new int[1];
294             int [] boldEndCount = new int[1];
295             int [] italicsEndCount = new int[1];
296             if (props.getProperty("Bold").equals("on")) {
297                 input = StringUtils.replace( input, "[b]", "<b>", boldStartCount );
298                 input = StringUtils.replace( input, "[/b]", "</b>", boldEndCount );
299                 int bStartCount = boldStartCount[0];
300                 int bEndCount = boldEndCount[0];
301                 while (bStartCount > bEndCount) {
302                     input = input.concat("</b>");
303                     bEndCount++;
304                 }
305             }
306             if (props.getProperty("Italics").equals("on")) {
307                 input = StringUtils.replace( input, "[i]", "<i>", italicsStartCount );
308                 input = StringUtils.replace( input, "[/i]", "</i>", italicsEndCount );
309                 int iStartCount = italicsStartCount[0];
310                 int iEndCount = italicsEndCount[0];
311                 while (iStartCount > iEndCount) {
312                     input = input.concat("</i>");
313                     iEndCount++;
314                 }
315             }
316         }
317         return input;
318     }
319 }
320 
321
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags