001// --------------------------------------------------------------------------------
002// Copyright 2002-2026 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.control.user.authentication.server.command;
018
019import com.echothree.control.user.authentication.common.form.CustomerLoginForm;
020import com.echothree.model.control.party.common.PartyTypes;
021import com.echothree.model.control.party.server.logic.LockoutPolicyLogic;
022import com.echothree.model.control.party.server.logic.PartyLogic;
023import com.echothree.model.control.user.server.logic.UserLoginLogic;
024import com.echothree.model.data.user.common.pk.UserVisitPK;
025import com.echothree.util.common.command.BaseResult;
026import com.echothree.util.common.validation.FieldDefinition;
027import com.echothree.util.common.validation.FieldType;
028import java.util.List;
029import javax.enterprise.context.Dependent;
030import javax.inject.Inject;
031
032@Dependent
033public class CustomerLoginCommand
034        extends BaseLoginCommand<CustomerLoginForm> {
035
036    // No COMMAND_SECURITY_DEFINITION, anyone may execute this command.
037    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
038    
039    static {
040        FORM_FIELD_DEFINITIONS = List.of(
041                new FieldDefinition("Username", FieldType.STRING, true, 1L, 80L),
042                new FieldDefinition("Password", FieldType.STRING, true, 1L, 40L),
043                new FieldDefinition("RemoteInet4Address", FieldType.INET_4_ADDRESS, false, null, null)
044        );
045    }
046
047    @Inject
048    LockoutPolicyLogic lockoutPolicyLogic;
049
050    @Inject
051    PartyLogic partyLogic;
052
053    @Inject
054    UserLoginLogic userLoginLogic;
055
056    
057    /** Creates a new instance of CustomerLoginCommand */
058    public CustomerLoginCommand() {
059        super(null, FORM_FIELD_DEFINITIONS);
060    }
061    
062    @Override
063    protected BaseResult execute() {
064        var userLogin = userLoginLogic.getUserLoginByUsername(this, form.getUsername());
065        
066        if(!hasExecutionErrors()) {
067            var party = userLogin.getParty();
068
069            partyLogic.checkPartyType(this, party, PartyTypes.CUSTOMER.name());
070
071            if(!hasExecutionErrors()) {
072                var userLoginStatus = userControl.getUserLoginStatusForUpdate(party);
073
074                lockoutPolicyLogic.checkUserLogin(session, this, party, userLoginStatus);
075                
076                if(!hasExecutionErrors()) {
077                    if(checkPasswords(userLoginStatus, form.getPassword(), party, true)) {
078                        var strRemoteInet4Address = form.getRemoteInet4Address();
079                        var remoteInet4Address = strRemoteInet4Address == null ? null : Integer.valueOf(form.getRemoteInet4Address());
080                        
081                        successfulLogin(userLoginStatus, party, null, remoteInet4Address);
082                    }
083                }
084                
085                if(hasExecutionErrors()) {
086                    unsuccessfulLogin(userLoginStatus);
087                }
088            }
089        }
090        
091        return null;
092    }
093    
094}