001// --------------------------------------------------------------------------------
002// Copyright 2002-2025 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.contact.server.command;
018
019import com.echothree.control.user.contact.common.edit.ContactEditFactory;
020import com.echothree.control.user.contact.common.edit.ContactEmailAddressEdit;
021import com.echothree.control.user.contact.common.form.EditContactEmailAddressForm;
022import com.echothree.control.user.contact.common.result.ContactResultFactory;
023import com.echothree.control.user.contact.common.result.EditContactEmailAddressResult;
024import com.echothree.control.user.contact.common.spec.PartyContactMechanismSpec;
025import com.echothree.model.control.contact.common.ContactMechanismTypes;
026import com.echothree.model.control.contact.server.control.ContactControl;
027import com.echothree.model.control.party.common.PartyTypes;
028import com.echothree.model.control.party.server.control.PartyControl;
029import com.echothree.model.control.security.common.SecurityRoleGroups;
030import com.echothree.model.control.security.common.SecurityRoles;
031import com.echothree.model.data.contact.server.entity.ContactMechanism;
032import com.echothree.model.data.contact.server.entity.PartyContactMechanism;
033import com.echothree.model.data.user.common.pk.UserVisitPK;
034import com.echothree.util.common.command.SecurityResult;
035import com.echothree.util.common.message.ExecutionErrors;
036import com.echothree.util.common.validation.FieldDefinition;
037import com.echothree.util.common.validation.FieldType;
038import com.echothree.util.common.command.EditMode;
039import com.echothree.util.server.control.BaseAbstractEditCommand;
040import com.echothree.util.server.control.CommandSecurityDefinition;
041import com.echothree.util.server.control.PartyTypeDefinition;
042import com.echothree.util.server.control.SecurityRoleDefinition;
043import com.echothree.util.server.persistence.Session;
044import java.util.Arrays;
045import java.util.Collections;
046import java.util.List;
047import javax.enterprise.context.RequestScoped;
048
049@RequestScoped
050public class EditContactEmailAddressCommand
051        extends BaseAbstractEditCommand<PartyContactMechanismSpec, ContactEmailAddressEdit, EditContactEmailAddressResult, PartyContactMechanism, ContactMechanism> {
052
053    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
054    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
055    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
056    
057    static {
058        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
059                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
060                new PartyTypeDefinition(PartyTypes.CUSTOMER.name(), null),
061                new PartyTypeDefinition(PartyTypes.VENDOR.name(), null),
062                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
063                        new SecurityRoleDefinition(SecurityRoleGroups.ContactMechanism.name(), SecurityRoles.Edit.name())
064                        )))
065                )));
066
067        SPEC_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
068                new FieldDefinition("PartyName", FieldType.ENTITY_NAME, false, null, null),
069                new FieldDefinition("ContactMechanismName", FieldType.ENTITY_NAME, true, null, null)
070                ));
071        
072        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
073                new FieldDefinition("AllowSolicitation", FieldType.BOOLEAN, true, null, null),
074                new FieldDefinition("EmailAddress", FieldType.EMAIL_ADDRESS, true, null, null),
075                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
076                ));
077    }
078    
079    /** Creates a new instance of EditContactEmailAddressCommand */
080    public EditContactEmailAddressCommand() {
081        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
082    }
083    
084    @Override
085    protected SecurityResult security() {
086        var securityResult = super.security();
087
088        return securityResult != null ? securityResult : selfOnly(spec);
089    }
090
091    @Override
092    public EditContactEmailAddressResult getResult() {
093        return ContactResultFactory.getEditContactEmailAddressResult();
094    }
095
096    @Override
097    public ContactEmailAddressEdit getEdit() {
098        return ContactEditFactory.getContactEmailAddressEdit();
099    }
100
101    @Override
102    public PartyContactMechanism getEntity(EditContactEmailAddressResult result) {
103        var partyControl = Session.getModelController(PartyControl.class);
104        PartyContactMechanism partyContactMechanism = null;
105        var partyName = spec.getPartyName();
106        var party = partyName == null ? getParty() : partyControl.getPartyByName(partyName);
107
108        if(party != null) {
109            var contactControl = Session.getModelController(ContactControl.class);
110            var contactMechanismName = spec.getContactMechanismName();
111            var contactMechanism = contactControl.getContactMechanismByName(contactMechanismName);
112
113            if(contactMechanism != null) {
114                if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
115                    partyContactMechanism = contactControl.getPartyContactMechanism(party, contactMechanism);
116                } else { // EditMode.UPDATE
117                    partyContactMechanism = contactControl.getPartyContactMechanismForUpdate(party, contactMechanism);
118                }
119
120                if(partyContactMechanism != null) {
121                    var lastContactMechanismDetail = contactMechanism.getLastDetail();
122                    var contactMechanismTypeName = lastContactMechanismDetail.getContactMechanismType().getContactMechanismTypeName();
123
124                    result.setContactMechanism(contactControl.getContactMechanismTransfer(getUserVisit(), contactMechanism));
125
126                    if(!ContactMechanismTypes.EMAIL_ADDRESS.name().equals(contactMechanismTypeName)) {
127                        addExecutionError(ExecutionErrors.InvalidContactMechanismType.name(), contactMechanismTypeName);
128                    }
129                } else {
130                    addExecutionError(ExecutionErrors.UnknownPartyContactMechanism.name(), partyName, contactMechanismName);
131                }
132            } else {
133                addExecutionError(ExecutionErrors.UnknownContactMechanismName.name(), contactMechanismName);
134            }
135        } else {
136            addExecutionError(ExecutionErrors.UnknownPartyName.name(), partyName);
137        }
138
139        return partyContactMechanism;
140    }
141
142    @Override
143    public ContactMechanism getLockEntity(PartyContactMechanism partyContactMechanism) {
144        return partyContactMechanism.getLastDetail().getContactMechanism();
145    }
146
147    @Override
148    public void fillInResult(EditContactEmailAddressResult result, PartyContactMechanism partyContactMechanism) {
149        var contactControl = Session.getModelController(ContactControl.class);
150
151        result.setContactMechanism(contactControl.getContactMechanismTransfer(getUserVisit(),
152                partyContactMechanism.getLastDetail().getContactMechanism()));
153    }
154
155    @Override
156    public void doLock(ContactEmailAddressEdit edit, PartyContactMechanism partyContactMechanism) {
157        var contactControl = Session.getModelController(ContactControl.class);
158        var contactMechanism = partyContactMechanism.getLastDetail().getContactMechanism();
159        var contactMechanismDetail = contactMechanism.getLastDetail();
160        var contactEmailAddress = contactControl.getContactEmailAddress(contactMechanism);
161        var partyContactMechanismDetail = partyContactMechanism.getLastDetail();
162
163        edit.setAllowSolicitation(contactMechanismDetail.getAllowSolicitation().toString());
164        edit.setEmailAddress(contactEmailAddress.getEmailAddress());
165        edit.setDescription(partyContactMechanismDetail.getDescription());
166    }
167
168    @Override
169    public void canUpdate(PartyContactMechanism partyContactMechanism) {
170        var contactControl = Session.getModelController(ContactControl.class);
171        var userControl = getUserControl();
172        var party = partyContactMechanism.getLastDetail().getParty();
173        var contactMechanism = partyContactMechanism.getLastDetail().getContactMechanism();
174        var contactEmailAddress = contactControl.getContactEmailAddress(contactMechanism);
175        var userLogin = userControl.getUserLoginForUpdate(party);
176
177        // The only time we care about a duplicate email address is if the current email address is in use
178        // for the Party's UserLogin, and the new email address is in use by someone else as their login.
179        if(userLogin != null && userLogin.getUsername().equals(contactEmailAddress.getEmailAddress())) {
180            var emailAddress = edit.getEmailAddress();
181            var duplicateUserLogin = userControl.getUserLoginByUsername(emailAddress);
182
183            if(duplicateUserLogin != null && !duplicateUserLogin.getParty().equals(party)) {
184                addExecutionError(ExecutionErrors.DuplicateUsername.name(), emailAddress);
185            }
186        }
187    }
188
189    @Override
190    public void doUpdate(PartyContactMechanism partyContactMechanism) {
191        var contactControl = Session.getModelController(ContactControl.class);
192        var updatedBy = getPartyPK();
193        var contactMechanism = partyContactMechanism.getLastDetail().getContactMechanism();
194        var contactMechanismDetailValue = contactControl.getContactMechanismDetailValue(contactMechanism.getLastDetail());
195        var contactEmailAddressValue = contactControl.getContactEmailAddressValueForUpdate(contactMechanism);
196        var partyContactMechanismDetailValue = contactControl.getPartyContactMechanismDetailValueForUpdate(partyContactMechanism);
197
198        contactMechanismDetailValue.setAllowSolicitation(Boolean.valueOf(edit.getAllowSolicitation()));
199        contactEmailAddressValue.setEmailAddress(edit.getEmailAddress());
200        partyContactMechanismDetailValue.setDescription(edit.getDescription());
201
202        contactControl.updateContactMechanismFromValue(contactMechanismDetailValue, updatedBy);
203        contactControl.updateContactEmailAddressFromValue(contactEmailAddressValue, updatedBy);
204        contactControl.updatePartyContactMechanismFromValue(partyContactMechanismDetailValue, updatedBy);
205    }
206
207}
208