KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > Yasna > forum > tags > UserTag


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.tags;
108
109 import java.io.*;
110 import java.util.*;
111 import javax.servlet.*;
112 import javax.servlet.jsp.*;
113 import javax.servlet.jsp.tagext.*;
114 import javax.servlet.http.*;
115 import com.Yasna.forum.*;
116 import com.Yasna.forum.tags.*;
117
118 /**
119  * JSP Tag <b>user</b>, used to access account information for
120  * a user who posted a message.
121  * <p>
122  * Requires that attribute <b>id</b> be set to the name of a
123  * script variable for later use in JSP to retrieve User data
124  * using &lt;jsp:getProperty/&gt;.
125  * <p>
126  * If the current yazd user is not authorized to view an account
127  * property an empty string "" will be returned.
128  * <p>
129  * Uses the following HTTP input parameter:
130  * <li><b>username</b> - username of user to view public account information
131  * <p>
132  * JSP Tag Lib Descriptor
133  * <p><pre>
134  * &lt;name&gt;user&lt;/name&gt;
135  * &lt;tagclass&gt;com.Yasna.forum.tags.UserTag&lt;/tagclass&gt;
136  * &lt;teiclass&gt;com.Yasna.forum.tags.UserTEI&lt;/teiclass&gt;
137  * &lt;bodycontent&gt;JSP&lt;/bodycontent&gt;
138  * &lt;info&gt;User information for the user who posted the current message being displayed.&lt;/info&gt;
139  * &lt;attribute&gt;
140  * &lt;name&gt;id&lt;/name&gt;
141  * &lt;required&gt;true&lt;/required&gt;
142  * &lt;rtexprvalue&gt;false&lt;/rtexprvalue&gt;
143  * &lt;/attribute&gt;
144  * </pre>
145  *
146  * @see MessageTag
147  * @see YazdProperty
148  * @see GetYazdPropertyTag
149  * @see SetYazdPropertyTag
150  * @see YazdState
151  * @see YazdRequest
152  *
153  * @author Glenn Nielsen
154  */

155 public class UserTag extends TagSupport implements YazdProperty
156 {
157   private YazdRequest jr = null;
158   private YazdState js = null;
159   private User ui = null;
160
161   /**
162    * Method used at start of user Tag to get User data for
163    * person who posted a message or the user set by the
164    * HTML form input parameter "username".
165    *
166    * @throws JspException on system level error
167    *
168    * @return EVAL_BODY_INCLUDE if user is found, SKIP_BODY if user could no be found
169    */

170   public final int doStartTag() throws JspException
171   {
172     // Get the user request information
173
jr = (YazdRequest)pageContext.getAttribute("yazdUserRequest",
174                 PageContext.REQUEST_SCOPE);
175     if( jr == null )
176       throw new JspException("Yazd user tag, could not find request");
177
178     // Get the parent message tag
179
MessageTag mt = null;
180     try {
181       mt = (MessageTag)this.findAncestorWithClass(this,
182         Class.forName("com.Yasna.forum.tags.MessageTag"));
183     } catch(Exception JavaDoc e) {
184     }
185
186     if( mt != null ) {
187       ui = mt.getUser();
188     }
189
190     // Not inside an admin tag, so get a public instance of user
191
if( ui == null ) {
192      // See if we should get the user based on HTML input parameter
193
// username
194
ServletRequest req = pageContext.getRequest();
195       String JavaDoc tmp;
196       if( (tmp = req.getParameter("username")) != null ) {
197         ProfileManager pm = jr.getProfileManager();
198         try {
199           ui = pm.getUser(tmp);
200         } catch(UserNotFoundException e) {}
201       }
202     }
203
204     if( ui == null ) {
205       return SKIP_BODY;
206     }
207
208     // Save the script variable so JSP author can access user data
209
pageContext.setAttribute(id,this,PageContext.PAGE_SCOPE);
210     return EVAL_BODY_INCLUDE;
211   }
212
213   /**
214    * User Email address property which can be obtained by the JSP page
215    * using &lt;jsp:getProperty name=<i>"id"</i> property="email"/&gt;
216    *
217    * @return String - user email address if authorized to view it
218    */

219   public final String JavaDoc getEmail()
220   {
221     String JavaDoc email;
222
223     email = ui.getEmail();
224     if( email == null )
225       return "";
226     return email;
227   }
228
229   /**
230    * User Name (real name) property which can be obtained by the JSP page
231    * using &lt;jsp:getProperty name=<i>"id"</i> property="name"/&gt;
232    *
233    * @return String - user name (real name) if authorized to view it
234    */

235   public final String JavaDoc getName()
236   {
237     String JavaDoc name;
238
239     name = ui.getName();
240     if( name == null )
241       return "";
242     return name;
243   }
244
245   /**
246    * User Username (userid) property which can be obtained by the JSP page
247    * using &lt;jsp:getProperty name=<i>"id"</i> property="username"/&gt;
248    *
249    * @return String - user username (forum userid)
250    */

251   public final String JavaDoc getUsername()
252   {
253     return ui.getUsername();
254   }
255
256   public final boolean getAnonymous() {
257     return ui.isAnonymous();
258   }
259
260   /**
261    * Method used by the getYazdProperty tag to get an extended User
262    * property from the user tag script variable.
263    *
264    * @return String - value of the property
265    */

266   public final String JavaDoc getProperty(String JavaDoc name)
267   {
268     // Don't allow the special property named "password" to be returned
269
if( name.equals("password") )
270       return "";
271     String JavaDoc tmp = ui.getProperty(name);
272     if( tmp != null )return tmp;
273     return "";
274   }
275
276   /**
277    * Method required by the setYazdProperty tag to set an extended User
278    * property, disabled in user tag.
279    */

280   public final void setProperty(String JavaDoc name, String JavaDoc value)
281   {
282   }
283
284   /**
285    * Remove the script variable after forum tag closed out
286    */

287   public final void release()
288   {
289     if( id != null && id.length() > 0 )
290       pageContext.removeAttribute(id,PageContext.PAGE_SCOPE);
291   }
292 }
293
Popular Tags