1 package org.apache.turbine.modules.actions;
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 Classes
58 import org.apache.turbine.TurbineConstants;
59 import org.apache.turbine.modules.Action;
60 import org.apache.turbine.util.Log;
61 import org.apache.turbine.util.RunData;
62 import org.apache.turbine.services.resources.TurbineResources;
63 import org.apache.turbine.services.security.TurbineSecurity;
64 import org.apache.turbine.om.security.User;
65 import org.apache.turbine.util.security.DataBackendException;
66 import org.apache.turbine.util.security.TurbineSecurityException;
67
68 /***
69 * This is where we authenticate the user logging into the system
70 * against a user in the database. If the user exists in the database
71 * that users last login time will be updated.
72 *
73 * @author <a href="mailto:mbryson@mont.mindspring.com">Dave Bryson</a>
74 * @version $Id: LoginUser.java,v 1.1.1.1 2001/08/16 05:08:31 jvanzyl Exp $
75 */
76 public class LoginUser extends Action
77 {
78 /***
79 * Updates the user's LastLogin timestamp, sets their state to
80 * "logged in" and calls RunData.setUser() . If the user cannot
81 * be authenticated (database error?) the user is assigned
82 * anonymous status and, if tr.props contains a TEMPLATE_LOGIN,
83 * the screenTemplate is set to this, otherwise the screen is set
84 * to SCREEN_LOGIN
85 *
86 * <p><em>Note: Turbine clears the session before calling this
87 * method</em></p>
88 *
89 * @param data Turbine information.
90 * @exception Exception, a generic exception.
91 */
92 public void doPerform( RunData data )
93 throws Exception
94 {
95 // This prevents a db hit on second Action call during page
96 // generation. Turbine removes everything from the Session
97 // before calling this method, so in this case we should
98 // continue on with the Login procedure.
99 if ( data.getUserFromSession() != null )
100 {
101 return;
102 }
103
104 String username = data.getParameters().getString( "username", "" );
105 String password = data.getParameters().getString( "password", "" );
106
107 User user = null;
108 try
109 {
110 // Authenticate the user and get the object.
111 user = TurbineSecurity.getAuthenticatedUser( username, password );
112
113 // Store the user object.
114 data.setUser(user);
115
116 // Mark the user as being logged in.
117 user.setHasLoggedIn(new Boolean(true));
118
119 // Set the last_login date in the database.
120 user.updateLastLogin();
121
122 // This only happens if the user is valid; otherwise, we
123 // will get a valueBound in the User object when we don't
124 // want to because the username is not set yet. Save the
125 // User object into the session.
126 data.save();
127
128 /*
129 * If the setPage("template.vm") method has not
130 * been used in the template to authenticate the
131 * user (usually Login.vm), then the user will
132 * be forwarded to the template that is specified
133 * by the "template.home" property as listed in
134 * TR.props for the webapp.
135 */
136
137 }
138 catch ( TurbineSecurityException e )
139 {
140 if(e instanceof DataBackendException)
141 {
142 Log.error(e);
143 }
144 data.setMessage(TurbineResources.getString(
145 TurbineConstants.LOGIN_ERROR));
146 // Retrieve an anonymous user.
147 data.setUser (TurbineSecurity.getAnonymousUser());
148 String loginTemplate = TurbineResources.getString(
149 TurbineConstants.TEMPLATE_LOGIN);
150
151 if (loginTemplate != null && loginTemplate.length() > 0)
152 {
153 data.setScreenTemplate(loginTemplate);
154 }
155 else
156 {
157 data.setScreen(TurbineResources.getString(
158 TurbineConstants.SCREEN_LOGIN));
159 }
160 }
161 }
162 }
This page was automatically generated by Maven