/*
    * Copyright (c) 2002-2022, City of Paris
    * All rights reserved.
    *
    * Redistribution and use in source and binary forms, with or without
    * modification, are permitted provided that the following conditions
    * are met:
    *
    *  1. Redistributions of source code must retain the above copyright notice
   *     and the following disclaimer.
   *
   *  2. Redistributions in binary form must reproduce the above copyright notice
   *     and the following disclaimer in the documentation and/or other materials
   *     provided with the distribution.
   *
   *  3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
   *     contributors may be used to endorse or promote products derived from
   *     this software without specific prior written permission.
   *
   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
   * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
   * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
   * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
   * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
   * POSSIBILITY OF SUCH DAMAGE.
   *
   * License 1.0
   */
  package fr.paris.lutece.portal.business.user.authentication;
  
  import fr.paris.lutece.portal.business.user.AdminUser;
  import fr.paris.lutece.portal.business.user.log.UserLog;
  import fr.paris.lutece.portal.business.user.log.UserLogHome;
  import fr.paris.lutece.portal.service.admin.AdminUserService;
  import fr.paris.lutece.util.http.SecurityUtil;
  import fr.paris.lutece.util.password.IPassword;
  import fr.paris.lutece.util.password.IPasswordFactory;
  
  import java.util.Collection;
  
  import javax.inject.Inject;
  import javax.security.auth.login.FailedLoginException;
  import javax.security.auth.login.LoginException;
  
  import javax.servlet.http.HttpServletRequest;
  
  /**
   * Default authentication module for admin authentication
   */
  public class LuteceDefaultAdminAuthentication implements AdminAuthentication
  {
      private static final String CONSTANT_LOST_PASSWORD_URL = "jsp/admin/AdminForgotPassword.jsp";
      private static final String CONSTANT_LOST_LOGIN_URL = "jsp/admin/AdminForgotLogin.jsp";
      private ILuteceDefaultAdminUserDAO _dao;
  
      @Inject
      private IPasswordFactory _passwordFactory;
  
      /**
       * Setter used by Spring IoC
       * 
       * @param dao
       *            The DAO (defined in the Spring context)
       */
      public void setDao( ILuteceDefaultAdminUserDAO dao )
      {
          _dao = dao;
      }
  
      /**
       * {@inheritDoc}
       */
      @Override
      public String getAuthServiceName( )
      {
          return "LUTECE DEFAULT AUTHENTICATION";
      }
  
      /**
       * {@inheritDoc}
       */
      @Override
      public String getAuthType( HttpServletRequest request )
      {
          return HttpServletRequest.BASIC_AUTH;
      }
  
      /**
       * {@inheritDoc}
       */
      @Override
      public AdminUser login( String strAccessCode, String strUserPassword, HttpServletRequest request ) throws LoginException
      {
          // Test the number of errors during an interval of minutes
         int nMaxFailed = AdminUserService.getIntegerSecurityParameter( AdminUserService.DSKEY_ACCES_FAILURES_MAX );
         int nIntervalMinutes = AdminUserService.getIntegerSecurityParameter( AdminUserService.DSKEY_ACCES_FAILURES_INTERVAL );
 
         if ( ( nMaxFailed > 0 ) && ( nIntervalMinutes > 0 ) )
         {
             // Creating a record of connections log
             UserLogl/business/user/log/UserLog.html#UserLog">UserLog userLog = new UserLog( );
             userLog.setAccessCode( strAccessCode );
             userLog.setIpAddress( SecurityUtil.getRealIp( request ) );
             userLog.setDateLogin( new java.sql.Timestamp( new java.util.Date( ).getTime( ) ) );
 
             int nNbFailed = UserLogHome.getLoginErrors( userLog, nIntervalMinutes );
 
             if ( nNbFailed > nMaxFailed )
             {
                 throw new FailedLoginException( );
             }
         }
 
         IPassword pasword = _dao.loadPassword( strAccessCode );
 
         if ( !pasword.check( strUserPassword ) )
         {
             throw new FailedLoginException( );
         }
 
         if ( pasword.isLegacy( ) )
         {
             // upgrade password storage
             IPassword upgradedPassword = _passwordFactory.getPasswordFromCleartext( strUserPassword );
             _dao.store( strAccessCode, upgradedPassword );
         }
 
         LuteceDefaultAdminUser user = _dao.load( strAccessCode, this );
 
         if ( ( user.getPasswordMaxValidDate( ) != null ) && ( user.getPasswordMaxValidDate( ).getTime( ) < new java.util.Date( ).getTime( ) ) )
         {
             _dao.updateResetPassword( user, Boolean.TRUE );
         }
 
         AdminUserService.updateUserExpirationDate( user );
 
         return user;
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public void logout( AdminUser user )
     {
         // Nothing
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public AdminUser getAnonymousUser( )
     {
         return null;
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public boolean isExternalAuthentication( )
     {
         return false;
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public AdminUser getHttpAuthenticatedUser( HttpServletRequest request )
     {
         return null;
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public String getLoginPageUrl( )
     {
         return "jsp/admin/AdminLogin.jsp";
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public String getChangePasswordPageUrl( )
     {
         return "jsp/admin/user/ModifyDefaultUserPassword.jsp";
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public String getDoLoginUrl( )
     {
         return null;
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public String getDoLogoutUrl( )
     {
         return null;
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public String getNewAccountPageUrl( )
     {
         return null;
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public String getViewAccountPageUrl( )
     {
         return null;
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public String getLostPasswordPageUrl( )
     {
         return CONSTANT_LOST_PASSWORD_URL;
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public String getLostLoginPageUrl( )
     {
         return CONSTANT_LOST_LOGIN_URL;
     }
 
     /**
      * Not used - Return null always for this module
      * 
      * @param strLastName
      *            The last name
      * @param strFirstName
      *            The first name
      * @param strEmail
      *            The email
      * @see fr.paris.lutece.portal.business.user.authentication.AdminAuthentication#getUserList(String strLastName, String strFirstName, String strEmail )
      * @return null
      */
     @Override
     public Collection<AdminUser> getUserList( String strLastName, String strFirstName, String strEmail )
     {
         return null;
     }
 
     /**
      * Not used - Return null always for this module
      * 
      * @param strLogin
      *            The login
      * @see fr.paris.lutece.portal.business.user.authentication.AdminAuthentication#getUserPublicData(java.lang.String)
      * @return null
      */
     @Override
     public AdminUser getUserPublicData( String strLogin )
     {
         return null;
     }
 }