package org.apache.turbine.modules.actions;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.commons.configuration.Configuration;
import org.apache.commons.lang.StringUtils;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.turbine.Turbine;
import org.apache.turbine.TurbineConstants;
import org.apache.turbine.modules.Action;
import org.apache.turbine.om.security.User;
import org.apache.turbine.pipeline.PipelineData;
import org.apache.turbine.services.security.TurbineSecurity;
import org.apache.turbine.util.RunData;
import org.apache.turbine.util.security.DataBackendException;
import org.apache.turbine.util.security.TurbineSecurityException;
/**
* This is where we authenticate the user logging into the system
* against a user in the database. If the user exists in the database
* that users last login time will be updated.
*
* @deprecated Use PipelineData version instead.
* @author <a href="mailto:mbryson@mont.mindspring.com">Dave Bryson</a>
* @author <a href="mailto:hps@intermeta.de">Henning P. Schmiedehausen</a>
* @author <a href="mailto:quintonm@bellsouth.net">Quinton McCombs</a>
* @author <a href="mailto:peter@courcoux.biz">Peter Courcoux</a>
* @version $Id: LoginUser.java 1066529 2011-02-02 17:01:46Z ludwig $
*/
@Deprecated
public class LoginUser
extends Action
{
/** CGI Parameter for the user name */
public static final String CGI_USERNAME = "username";
/** CGI Parameter for the password */
public static final String CGI_PASSWORD = "password";
/** Logging */
private static Log log = LogFactory.getLog(LoginUser.class);
/**
* Updates the user's LastLogin timestamp, sets their state to
* "logged in" and calls RunData.setUser() . If the user cannot
* be authenticated (database error?) the user is assigned
* anonymous status and, if tr.props contains a TEMPLATE_LOGIN,
* the screenTemplate is set to this, otherwise the screen is set
* to SCREEN_LOGIN
*
* @param data Turbine information.
* @exception TurbineSecurityException could not get instance of the
* anonymous user
*/
@Override
public void doPerform(RunData data)
throws TurbineSecurityException
{
String username = data.getParameters().getString(CGI_USERNAME, "");
String password = data.getParameters().getString(CGI_PASSWORD, "");
if (StringUtils.isEmpty(username))
{
return;
}
try
{
// Authenticate the user and get the object.
User user = TurbineSecurity.getAuthenticatedUser(
username, password);
// Store the user object.
data.setUser(user);
// Mark the user as being logged in.
user.setHasLoggedIn(Boolean.TRUE);
// Set the last_login date in the database.
user.updateLastLogin();
// This only happens if the user is valid; otherwise, we
// will get a valueBound in the User object when we don't
// want to because the username is not set yet. Save the
// User object into the session.
data.save();
/*
* If the setPage("template.vm") method has not
* been used in the template to authenticate the
* user (usually Login.vm), then the user will
* be forwarded to the template that is specified
* by the "template.home" property as listed in
* TR.props for the webapp.
*/
}
catch (Exception e)
{
Configuration conf = Turbine.getConfiguration();
if (e instanceof DataBackendException)
{
log.error(e);
}
// Set Error Message and clean out the user.
data.setMessage(conf.getString(TurbineConstants.LOGIN_ERROR, ""));
data.setUser (TurbineSecurity.getAnonymousUser());
String loginTemplate = conf.getString(
TurbineConstants.TEMPLATE_LOGIN);
if (StringUtils.isNotEmpty(loginTemplate))
{
// We're running in a templating solution
data.setScreenTemplate(loginTemplate);
}
else
{
data.setScreen(conf.getString(TurbineConstants.SCREEN_LOGIN));
}
}
}
/**
* Updates the user's LastLogin timestamp, sets their state to
* "logged in" and calls RunData.setUser() . If the user cannot
* be authenticated (database error?) the user is assigned
* anonymous status and, if tr.props contains a TEMPLATE_LOGIN,
* the screenTemplate is set to this, otherwise the screen is set
* to SCREEN_LOGIN
*
* @param pipelineData Turbine information.
* @exception TurbineSecurityException could not get instance of the
* anonymous user
*/
@Override
public void doPerform(PipelineData pipelineData)
throws TurbineSecurityException
{
RunData data = getRunData(pipelineData);
doPerform(data);
}
}