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: * SessionValidator that requires login for use with Template Services
039: * like Velocity or WebMacro.
040: *
041: * <br>
042: *
043: * Templating services requires a different Session Validator
044: * because of the way it handles screens. If you use the WebMacro or
045: * Velocity Service with the DefaultSessionValidator, users will be able to
046: * bypass login by directly addressing the template using
047: * template/index.wm. This is because the Page class looks for the
048: * keyword "template" in the Path information and if it finds it will
049: * reset the screen using it's lookup mechanism and thereby bypass
050: * Login.
051: *
052: * Note that you will need to set the template.login property to the
053: * login template.
054: *
055: * @author <a href="mailto:john.mcnally@clearink.com">John D. McNally</a>
056: * @author <a href="mailto:mbryson@mont.mindspring.com">Dave Bryson</a>
057: * @author <a href="mailto:hps@intermeta.de">Henning P. Schmiedehausen</a>
058: * @version $Id: TemplateSecureSessionValidator.java 534527 2007-05-02 16:10:59Z tv $
059: */
060: public class TemplateSecureSessionValidator extends SessionValidator {
061: /** Logging */
062: private static Log log = LogFactory
063: .getLog(TemplateSecureSessionValidator.class);
064:
065: /**
066: * doPerform is virtually identical to DefaultSessionValidator
067: * except that it calls template methods instead of bare screen
068: * methods. For example, it uses <code>setScreenTemplate</code> to
069: * load the tr.props TEMPLATE_LOGIN instead of the default's
070: * setScreen to TurbineConstants.SCREEN_LOGIN.
071: *
072: * @see DefaultSessionValidator
073: * @param data Turbine information.
074: * @throws TurbineException The anonymous user could not be obtained
075: * from the security service
076: */
077: public void doPerform(RunData data) throws TurbineException {
078: Configuration conf = Turbine.getConfiguration();
079:
080: // Pull user from session.
081: data.populate();
082:
083: // The user may have not logged in, so create a "guest/anonymous" user.
084: if (data.getUser() == null) {
085: log.debug("Fixing up empty User Object!");
086: data.setUser(TurbineSecurity.getAnonymousUser());
087: data.save();
088: }
089:
090: // This is the secure sessionvalidator, so user must be logged in.
091: if (!data.getUser().hasLoggedIn()) {
092: log.debug("User is not logged in!");
093:
094: // only set the message if nothing else has already set it
095: // (e.g. the LogoutUser action).
096: if (StringUtils.isEmpty(data.getMessage())) {
097: data.setMessage(conf
098: .getString(TurbineConstants.LOGIN_MESSAGE));
099: }
100:
101: // Set the screen template to the login page.
102: String loginTemplate = conf
103: .getString(TurbineConstants.TEMPLATE_LOGIN);
104:
105: log.debug("Sending User to the Login Screen ("
106: + loginTemplate + ")");
107: data.getTemplateInfo().setScreenTemplate(loginTemplate);
108:
109: // We're not doing any actions buddy! (except action.login which
110: // will have been performed already)
111: data.setAction(null);
112: }
113:
114: log.debug("Login Check finished!");
115:
116: // Make sure we have some way to return a response.
117: if (!data.hasScreen()
118: && StringUtils.isEmpty(data.getTemplateInfo()
119: .getScreenTemplate())) {
120: String template = conf
121: .getString(TurbineConstants.TEMPLATE_HOMEPAGE);
122:
123: if (StringUtils.isNotEmpty(template)) {
124: data.getTemplateInfo().setScreenTemplate(template);
125: } else {
126: data.setScreen(conf
127: .getString(TurbineConstants.SCREEN_HOMEPAGE));
128: }
129: }
130:
131: // The session_access_counter can be placed as a hidden field in
132: // forms. This can be used to prevent a user from using the
133: // browsers back button and submitting stale data.
134: // FIXME!! a template needs to be written to use this with templates.
135:
136: if (data.getParameters().containsKey("_session_access_counter")
137: && !TurbineSecurity.isAnonymousUser(data.getUser())) {
138: // See comments in screens.error.InvalidState.
139: if (data.getParameters().getInt("_session_access_counter") < (((Integer) data
140: .getUser().getTemp("_session_access_counter"))
141: .intValue() - 1)) {
142: if (data.getTemplateInfo().getScreenTemplate() != null) {
143: data.getUser().setTemp(
144: "prev_template",
145: data.getTemplateInfo().getScreenTemplate()
146: .replace('/', ','));
147: data
148: .getTemplateInfo()
149: .setScreenTemplate(
150: conf
151: .getString(TurbineConstants.TEMPLATE_INVALID_STATE));
152: } else {
153: data.getUser().setTemp("prev_screen",
154: data.getScreen().replace('/', ','));
155: data
156: .setScreen(conf
157: .getString(TurbineConstants.SCREEN_INVALID_STATE));
158: }
159: data.getUser().setTemp("prev_parameters",
160: data.getParameters());
161: data.setAction("");
162: }
163: }
164:
165: // We do not want to allow both a screen and template parameter.
166: // The template parameter is dominant.
167: if (data.getTemplateInfo().getScreenTemplate() != null) {
168: data.setScreen(null);
169: }
170: }
171: }
|