1 package org.apache.turbine.modules;
2
3 /* ====================================================================
4 * The Apache Software License, Version 1.1
5 *
6 * Copyright (c) 2001 The Apache Software Foundation. All rights
7 * reserved.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 *
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 *
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in
18 * the documentation and/or other materials provided with the
19 * distribution.
20 *
21 * 3. The end-user documentation included with the redistribution,
22 * if any, must include the following acknowledgment:
23 * "This product includes software developed by the
24 * Apache Software Foundation (http://www.apache.org/)."
25 * Alternately, this acknowledgment may appear in the software itself,
26 * if and wherever such third-party acknowledgments normally appear.
27 *
28 * 4. The names "Apache" and "Apache Software Foundation" and
29 * "Apache Turbine" must not be used to endorse or promote products
30 * derived from this software without prior written permission. For
31 * written permission, please contact apache@apache.org.
32 *
33 * 5. Products derived from this software may not be called "Apache",
34 * "Apache Turbine", nor may "Apache" appear in their name, without
35 * prior written permission of the Apache Software Foundation.
36 *
37 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
38 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
39 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
40 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
41 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
42 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
43 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
44 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
45 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
46 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
47 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
48 * SUCH DAMAGE.
49 * ====================================================================
50 *
51 * This software consists of voluntary contributions made by many
52 * individuals on behalf of the Apache Software Foundation. For more
53 * information on the Apache Software Foundation, please see
54 * <http://www.apache.org/>.
55 */
56
57 // Turbine Utility Classes
58 import org.apache.turbine.util.RunData;
59
60 // ECS Classes
61 import org.apache.ecs.ConcreteElement;
62 import org.apache.ecs.Entities;
63 import org.apache.ecs.filter.CharacterFilter;
64
65 /***
66 * This is an interface that defines what a Navigation module is.
67 *
68 * @author <a href="mailto:mbryson@mont.mindspring.com">Dave Bryson</a>
69 * @version $Id: Navigation.java,v 1.1.1.1 2001/08/16 05:08:29 jvanzyl Exp $
70 */
71 public abstract class Navigation extends Assembler
72 {
73 private static final CharacterFilter filter = htmlFilter();
74
75 /***
76 * A subclass must override this method to build itself.
77 * Subclasses override this method to store the navigation in
78 * RunData or to write the navigation to the output stream
79 * referenced in RunData.
80 *
81 * @param data Turbine information.
82 * @exception Exception a generic exception.
83 */
84 protected abstract ConcreteElement doBuild( RunData data )
85 throws Exception;
86
87 /***
88 * Subclasses can override this method to add additional
89 * functionality. This method is protected to force clients to
90 * use NavigationLoader to build a Navigation.
91 *
92 * @param data Turbine information.
93 * @exception Exception a generic exception.
94 */
95 protected ConcreteElement build( RunData data )
96 throws Exception
97 {
98 return doBuild( data );
99 }
100
101 /***
102 * This function can/should be used in any screen that will output
103 * User entered text. This will help prevent users from entering
104 * html (<SCRIPT>) tags that will get executed by the browser.
105 *
106 * @param s A string to be filtered.
107 * @return A string with the input already filtered.
108 */
109 public static String prepareText(String s)
110 {
111 return filter.process(s);
112 }
113
114 /***
115 * These attributes are supposed to be the default, but they are
116 * not, at least in ECS 1.2. Include them all just to be safe.
117 */
118 private static CharacterFilter htmlFilter()
119 {
120 CharacterFilter filter = new CharacterFilter();
121 filter.addAttribute("\"", Entities.QUOT);
122 filter.addAttribute("'", Entities.LSQUO);
123 filter.addAttribute("&", Entities.AMP);
124 filter.addAttribute("<", Entities.LT);
125 filter.addAttribute(">", Entities.GT);
126 return filter;
127 }
128 }
This page was automatically generated by Maven