package org.apache.turbine.modules.actions.sessionvalidator;

 /*

  * 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.lang3.StringUtils;

 import org.apache.logging.log4j.Logger;

 import org.apache.logging.log4j.LogManager;

 import org.apache.turbine.Turbine;

 import org.apache.turbine.TurbineConstants;

 import org.apache.turbine.annotation.TurbineConfiguration;

 import org.apache.turbine.om.security.User;

 import org.apache.turbine.pipeline.PipelineData;

 import org.apache.turbine.util.RunData;

 /**

  * The SessionValidator attempts to retrieve the User object from the

  * Servlet API session that is associated with the request.  If the

  * data cannot be retrieved, it is handled here.  If the user has not

  * been marked as being logged into the system, the user is rejected

  * and the screen is set to the screen.homepage value in

  * TurbineResources.properties.

  *

  * <p>

  *

  * Other systems generally have a database table which stores this

  * information, but we take advantage of the Servlet API here to save

  * a hit to the database for each and every connection that a user

  * makes.

  *

  * <p>

  *

  * This action is special in that it should only be executed by the

  * Turbine servlet.

  *

  * @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:peter@courcoux.biz">Peter Courcoux</a>

  * @version $Id: DefaultSessionValidator.java 1854797 2019-03-04 20:41:39Z tv $

  */

 public class DefaultSessionValidator

     extends SessionValidator

 {

     /** Logging */

     private static Logger log = LogManager.getLogger(DefaultSessionValidator.class);

     @TurbineConfiguration( TurbineConstants.LOGIN_MESSAGE )

     private String loginMessage;

     @TurbineConfiguration( TurbineConstants.SCREEN_LOGIN )

     private String screenLogin;

     @TurbineConfiguration( TurbineConstants.LOGIN_MESSAGE_NOSCREEN )

     private String loginMessageNoScreen;

     /**

      * Execute the action. The default behavior is to populate the PipelineData

      * object, and if the user is unknown, to then force a redirect

      * to the login screen (as set in the tr.props).

      *

      * @see org.apache.turbine.modules.screens.error.InvalidState

      * @param pipelineData Turbine PipelineData context information.

      * @throws Exception The anonymous user could not be obtained

      *         from the security service

      */

     @Override

     public void doPerform(PipelineData pipelineData)

             throws Exception

     {

         RunData data = pipelineData.getRunData();

         // Pull user from session.

         data.populate();

         // The user may have not logged in, so create a "guest/anonymous" user.

         if (data.getUser() == null)

         {

             log.debug("Creating an anonymous user object!");

             User anonymousUser = security.getAnonymousUser();

             data.setUser(anonymousUser);

             data.save();

         }

         // Make sure the User has logged into the system.

         if (!data.getUser().hasLoggedIn())

         {

             // only set the message if nothing else has already set it

             // (e.g. the LogoutUser action).

             if (StringUtils.isEmpty(data.getMessage()))

             {

                 data.setMessage(loginMessage);

             }

             // set the screen to be the login page

             data.setScreen(screenLogin);

             // We're not doing any actions buddy! (except action.login which

             // will have been performed already)

             data.setAction(null);

         }

         if (!data.hasScreen())

         {

             data.setMessage(loginMessageNoScreen);

             data.setScreen(screenHomepage);

         }

         handleFormCounterToken(data,true);

         // Comply with Turbine 4.0 standards

         pipelineData.get(Turbine.class).put(User.class, data.getUser());

     }

 }