AdminUserTag


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.util.*;
110 import javax.servlet.*;
111 import javax.servlet.jsp.*;
112 import javax.servlet.jsp.tagext.*;
113 import javax.servlet.http.*;
114 import com.Yasna.forum.*;
115 import com.Yasna.forum.tags.*;
116 
117 /**
118  * JSP Tag <b>admin</b>, used to perform user admin level functions
119  * on a user that is not logged in or not authorized for the function.
120  * <p>
121  * Uses the following yazd.tag.properties
122  * <p><ul>
123  * <li><b>yazd.admin.username</b> - username of admin user
124  * <li><b>yazd.admin.password</b> - password for admin user
125  * </ul>
126  * <p>
127  * Uses the following HTTP input parameter:
128  * <li><b>username</b> - username of user to administer
129  * <p>
130  * JSP Tag Lib Descriptor
131  * <p><pre>
132  * &lt;name&gt;admin&lt;/name&gt;
133  *   &lt;tagclass&gt;com.Yasna.forum.tags.AdminUserTag&lt;/tagclass&gt;
134  *   &lt;bodycontent&gt;JSP&lt;/bodycontent&gt;
135  *   &lt;info&gt;An account tag can be nested within this tag when you need permission to do something with a user who is not logged in.&lt;/info&gt;
136  * </pre>
137  *
138  * @see YazdState
139  * @see YazdRequest
140  * @see AccountTag
141  *
142  * @author Glenn Nielsen
143  */
144 public class AdminUserTag extends TagSupport
145 {
146   private Authorization auth = null;
147   private YazdState js = null;
148   private YazdRequest jr = null;
149   private User user = null;
150 
151   /**
152    * Login as the admin user so that a yazd user account can be administered.
153    * <p>
154    * Includes body of tag if admin user was authorized based on the yazd.tag.properties
155    * yazd.admin.username and yazd.admin.password, and a valid yazd username was found
156    * in the HTTP input parameter "username".
157    *
158    * @throws JspException on system level error
159    *
160    * @return <b>SKIP_BODY</b> on failure to authorize as admin user or user to administer could not be found, <b>EVAL_BODY_INCLUDE</b> if admin succeeded
161    */
162   public final int doStartTag() throws JspException
163   {
164     // Initialize YazdState
165     js = (YazdState)pageContext.getAttribute("yazdUserState",
166         PageContext.SESSION_SCOPE);
167     if( js == null ) {
168       throw new JspException("Yazd admin tag could not get yazd state.");
169     }
170 
171     // Initialize YazdRequest
172     jr = (YazdRequest)pageContext.getAttribute("yazdUserRequest",
173                 PageContext.REQUEST_SCOPE);
174     if( jr == null ) {
175       throw new JspException("Yazd admin tag could not get yazd request.");
176     }
177 
178     // Get username and password of admin
179     String   username = TagPropertyManager.getTagProperty("yazd.admin.username");
180     String   password = TagPropertyManager.getTagProperty("yazd.admin.password");
181     if( username == null || username.length() == 0 ||
182     password == null || password.length() == 0 )
183       return SKIP_BODY;
184 
185     // Get admin user authorization
186     try {
187       auth = AuthorizationFactory.getAuthorization( username, password );
188     }
189     catch( UnauthorizedException ue ) {
190       return SKIP_BODY;
191     }
192 
193     // Get the user to administer from the "username" HTTP input parameter
194     ServletRequest req = pageContext.getRequest();
195     String   tmp;
196     if( (tmp = req.getParameter("username")) != null )
197       return SKIP_BODY;
198 
199     try {
200       ForumFactory ff = ForumFactory.getInstance(auth);
201       ProfileManager pm = ff.getProfileManager();
202       user = pm.getUser(tmp);
203     }
204     catch( Exception   e) { }
205 
206     if( user == null ) {
207       jr.addError("User \"" + tmp + "\" not found");
208       return SKIP_BODY;
209     }
210 
211     return EVAL_BODY_INCLUDE;
212   }
213 
214   /**
215    * For use by account tag to get the user to administer
216    *
217    * @return User - Yazd user to administer
218    */
219   public final User getUser()
220   {
221     return user;
222   }
223 }
224
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags