001// --------------------------------------------------------------------------------
002// Copyright 2002-2024 Echo Three, LLC
003//
004// Licensed under the Apache License, Version 2.0 (the "License");
005// you may not use this file except in compliance with the License.
006// You may obtain a copy of the License at
007//
008//     http://www.apache.org/licenses/LICENSE-2.0
009//
010// Unless required by applicable law or agreed to in writing, software
011// distributed under the License is distributed on an "AS IS" BASIS,
012// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013// See the License for the specific language governing permissions and
014// limitations under the License.
015// --------------------------------------------------------------------------------
016
017package com.echothree.model.control.party.server.logic;
018
019import com.echothree.model.control.party.server.control.PartyControl;
020import com.echothree.model.data.party.server.entity.Party;
021import com.echothree.model.data.party.server.entity.PartyTypeLockoutPolicy;
022import com.echothree.model.data.party.server.entity.PartyTypeLockoutPolicyDetail;
023import com.echothree.model.data.user.server.entity.UserLoginStatus;
024import com.echothree.util.common.message.ExecutionErrors;
025import com.echothree.util.server.message.ExecutionErrorAccumulator;
026import com.echothree.util.server.persistence.Session;
027
028public class LockoutPolicyLogic {
029    
030    private LockoutPolicyLogic() {
031        super();
032    }
033    
034    private static class LockoutPolicyLogicHolder {
035        static LockoutPolicyLogic instance = new LockoutPolicyLogic();
036    }
037    
038    public static LockoutPolicyLogic getInstance() {
039        return LockoutPolicyLogicHolder.instance;
040    }
041    
042    private void resetFailureCount(final Session session, final UserLoginStatus userLoginStatus,
043            final PartyTypeLockoutPolicyDetail policyDetail) {
044        if(!policyDetail.getManualLockoutReset()) {
045            Long resetFailureCountTime = policyDetail.getResetFailureCountTime();
046            
047            if(resetFailureCountTime != null && userLoginStatus.getFailureCount() != 0) {
048                if(session.START_TIME - userLoginStatus.getLastFailureTime() > resetFailureCountTime) {
049                    userLoginStatus.setFailureCount(0);
050                }
051            }
052        }
053    }
054    
055    private void checkLockoutFailureCount(final ExecutionErrorAccumulator ema, final UserLoginStatus userLoginStatus,
056            final PartyTypeLockoutPolicyDetail policyDetail) {
057        Integer lockoutFailureCount = policyDetail.getLockoutFailureCount();
058        
059        if(lockoutFailureCount != null && userLoginStatus.getFailureCount() >= lockoutFailureCount) {
060            ema.addExecutionError(ExecutionErrors.LockoutFailureCountExceeded.name());
061            
062            if(policyDetail.getManualLockoutReset()) {
063                ema.addExecutionError(ExecutionErrors.LockoutManualResetRequired.name());
064            }
065        }
066    }
067    
068    private void checkLockoutInactiveTime(final Session session, final ExecutionErrorAccumulator ema,
069            final UserLoginStatus userLoginStatus, final PartyTypeLockoutPolicyDetail policyDetail) {
070        Long lockoutInactiveTime = policyDetail.getLockoutInactiveTime();
071        Long lastLoginTime = userLoginStatus.getLastLoginTime();
072        
073        if(lockoutInactiveTime != null && lastLoginTime != null && session.START_TIME - userLoginStatus.getLastLoginTime() >= lockoutInactiveTime) {
074            ema.addExecutionError(ExecutionErrors.LockoutInactiveTimeExceeded.name());
075        }
076    }
077    
078    public void checkUserLogin(final Session session, final ExecutionErrorAccumulator ema, final Party party,
079            final UserLoginStatus userLoginStatus) {
080        var partyControl = Session.getModelController(PartyControl.class);
081        PartyTypeLockoutPolicy policy = partyControl.getPartyTypeLockoutPolicy(party.getLastDetail().getPartyType());
082        
083        if(policy != null) {
084            PartyTypeLockoutPolicyDetail policyDetail = policy.getLastDetail();
085            
086            resetFailureCount(session, userLoginStatus, policyDetail);
087            checkLockoutFailureCount(ema, userLoginStatus, policyDetail);
088            checkLockoutInactiveTime(session, ema, userLoginStatus, policyDetail);
089        }
090    }
091    
092}