001: package org.apache.turbine.modules.actions.sessionvalidator;
002:
003: /*
004: * Licensed to the Apache Software Foundation (ASF) under one
005: * or more contributor license agreements. See the NOTICE file
006: * distributed with this work for additional information
007: * regarding copyright ownership. The ASF licenses this file
008: * to you under the Apache License, Version 2.0 (the
009: * "License"); you may not use this file except in compliance
010: * with the License. You may obtain a copy of the License at
011: *
012: * http://www.apache.org/licenses/LICENSE-2.0
013: *
014: * Unless required by applicable law or agreed to in writing,
015: * software distributed under the License is distributed on an
016: * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017: * KIND, either express or implied. See the License for the
018: * specific language governing permissions and limitations
019: * under the License.
020: */
021:
022: import org.apache.commons.configuration.Configuration;
023:
024: import org.apache.commons.lang.StringUtils;
025:
026: import org.apache.commons.logging.Log;
027: import org.apache.commons.logging.LogFactory;
028:
029: import org.apache.turbine.Turbine;
030: import org.apache.turbine.TurbineConstants;
031:
032: import org.apache.turbine.services.security.TurbineSecurity;
033:
034: import org.apache.turbine.util.RunData;
035: import org.apache.turbine.util.TurbineException;
036:
037: /**
038: * The SessionValidator attempts to retrieve the User object from the
039: * Servlet API session that is associated with the request. If the
040: * data cannot be retrieved, it is handled here. If the user has not
041: * been marked as being logged into the system, the user is rejected
042: * and the screen is set to the screen.homepage value in
043: * TurbineResources.properties.
044: *
045: * <p>
046: *
047: * Other systems generally have a database table which stores this
048: * information, but we take advantage of the Servlet API here to save
049: * a hit to the database for each and every connection that a user
050: * makes.
051: *
052: * <p>
053: *
054: * This action is special in that it should only be executed by the
055: * Turbine servlet.
056: *
057: * @author <a href="mailto:mbryson@mont.mindspring.com">Dave Bryson</a>
058: * @author <a href="mailto:hps@intermeta.de">Henning P. Schmiedehausen</a>
059: * @version $Id: DefaultSessionValidator.java 534527 2007-05-02 16:10:59Z tv $
060: */
061: public class DefaultSessionValidator extends SessionValidator {
062: /** Logging */
063: private static Log log = LogFactory
064: .getLog(DefaultSessionValidator.class);
065:
066: /**
067: * Execute the action. The default is to populate the RunData
068: * object and, if the user is unknown, to force a login screen (as
069: * set in the tr.props).
070: *
071: * @see org.apache.turbine.modules.screens.error.InvalidState
072: * @param data Turbine RunData context information.
073: * @throws TurbineException The anonymous user could not be obtained
074: * from the security service
075: */
076: public void doPerform(RunData data) throws TurbineException {
077: Configuration conf = Turbine.getConfiguration();
078:
079: // Pull user from session.
080: data.populate();
081:
082: // The user may have not logged in, so create a "guest/anonymous" user.
083: if (data.getUser() == null) {
084: log.debug("Fixing up empty User Object!");
085: data.setUser(TurbineSecurity.getAnonymousUser());
086: data.save();
087: }
088:
089: // Make sure the User has logged into the system.
090: if (!data.getUser().hasLoggedIn()) {
091: // only set the message if nothing else has already set it
092: // (e.g. the LogoutUser action).
093: if (StringUtils.isEmpty(data.getMessage())) {
094: data.setMessage(conf
095: .getString(TurbineConstants.LOGIN_MESSAGE));
096: }
097:
098: // set the screen to be the login page
099: data.setScreen(conf
100: .getString(TurbineConstants.SCREEN_LOGIN));
101:
102: // We're not doing any actions buddy! (except action.login which
103: // will have been performed already)
104: data.setAction(null);
105: }
106:
107: if (!data.hasScreen()) {
108: data
109: .setMessage(conf
110: .getString(TurbineConstants.LOGIN_MESSAGE_NOSCREEN));
111: data.setScreen(conf
112: .getString(TurbineConstants.SCREEN_HOMEPAGE));
113: }
114:
115: if (data.getParameters().containsKey("_session_access_counter")) {
116: // See comments in screens.error.InvalidState.
117: if (data.getParameters().getInt("_session_access_counter") < (((Integer) data
118: .getUser().getTemp("_session_access_counter"))
119: .intValue() - 1)) {
120: data.getUser().setTemp("prev_screen", data.getScreen());
121: data.getUser().setTemp("prev_parameters",
122: data.getParameters());
123: data
124: .setScreen(conf
125: .getString(TurbineConstants.SCREEN_INVALID_STATE));
126: data.setAction("");
127: }
128: }
129: }
130: }
|