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.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.Arrays;
029import java.util.Collections;
030import java.util.List;
031
032public class CustomerLoginCommand
033        extends BaseLoginCommand<CustomerLoginForm> {
034
035    // No COMMAND_SECURITY_DEFINITION, anyone may execute this command.
036    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
037    
038    static {
039        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
040                new FieldDefinition("Username", FieldType.STRING, true, 1L, 80L),
041                new FieldDefinition("Password", FieldType.STRING, true, 1L, 40L),
042                new FieldDefinition("RemoteInet4Address", FieldType.INET_4_ADDRESS, false, null, null)
043                ));
044    }
045    
046    /** Creates a new instance of CustomerLoginCommand */
047    public CustomerLoginCommand(UserVisitPK userVisitPK, CustomerLoginForm form) {
048        super(userVisitPK, form, null, FORM_FIELD_DEFINITIONS);
049    }
050    
051    @Override
052    protected BaseResult execute() {
053        var userLogin = UserLoginLogic.getInstance().getUserLoginByUsername(this, form.getUsername());
054        
055        if(!hasExecutionErrors()) {
056            var party = userLogin.getParty();
057
058            PartyLogic.getInstance().checkPartyType(this, party, PartyTypes.CUSTOMER.name());
059
060            if(!hasExecutionErrors()) {
061                var userControl = getUserControl();
062                var userLoginStatus = userControl.getUserLoginStatusForUpdate(party);
063
064                LockoutPolicyLogic.getInstance().checkUserLogin(session, this, party, userLoginStatus);
065                
066                if(!hasExecutionErrors()) {
067                    if(checkPasswords(userLoginStatus, form.getPassword(), party, true)) {
068                        var strRemoteInet4Address = form.getRemoteInet4Address();
069                        var remoteInet4Address = strRemoteInet4Address == null ? null : Integer.valueOf(form.getRemoteInet4Address());
070                        
071                        successfulLogin(userLoginStatus, party, null, remoteInet4Address);
072                    }
073                }
074                
075                if(hasExecutionErrors()) {
076                    unsuccessfulLogin(userLoginStatus);
077                }
078            }
079        }
080        
081        return null;
082    }
083    
084}