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.core.server.command;
018
019import com.echothree.control.user.core.common.edit.CoreEditFactory;
020import com.echothree.control.user.core.common.edit.EntityAliasEdit;
021import com.echothree.control.user.core.common.form.EditEntityAliasForm;
022import com.echothree.control.user.core.common.result.CoreResultFactory;
023import com.echothree.control.user.core.common.spec.EntityAliasSpec;
024import com.echothree.model.control.core.server.control.EntityAliasControl;
025import com.echothree.model.control.core.server.logic.EntityAliasTypeLogic;
026import com.echothree.model.control.core.server.logic.EntityInstanceLogic;
027import com.echothree.model.control.party.common.PartyTypes;
028import com.echothree.model.control.security.common.SecurityRoleGroups;
029import com.echothree.model.control.security.common.SecurityRoles;
030import com.echothree.model.data.core.server.entity.EntityAlias;
031import com.echothree.model.data.user.common.pk.UserVisitPK;
032import com.echothree.util.common.command.BaseResult;
033import com.echothree.util.common.command.EditMode;
034import com.echothree.util.common.message.ExecutionErrors;
035import com.echothree.util.common.validation.FieldDefinition;
036import com.echothree.util.common.validation.FieldType;
037import com.echothree.util.server.control.BaseEditCommand;
038import com.echothree.util.server.control.CommandSecurityDefinition;
039import com.echothree.util.server.control.PartyTypeDefinition;
040import com.echothree.util.server.control.SecurityRoleDefinition;
041import com.echothree.util.server.persistence.PersistenceUtils;
042import com.echothree.util.server.persistence.Session;
043import java.util.List;
044import java.util.regex.Pattern;
045import javax.enterprise.context.RequestScoped;
046
047@RequestScoped
048public class EditEntityAliasCommand
049        extends BaseEditCommand<EntityAliasSpec, EntityAliasEdit> {
050
051    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
052    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
053    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
054
055    static {
056        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
057                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
058                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
059                        new SecurityRoleDefinition(SecurityRoleGroups.EntityAlias.name(), SecurityRoles.Edit.name())
060                ))
061        ));
062
063        SPEC_FIELD_DEFINITIONS = List.of(
064                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
065                new FieldDefinition("Uuid", FieldType.UUID, false, null, null),
066                new FieldDefinition("EntityAliasTypeName", FieldType.ENTITY_NAME, false, null, null),
067                new FieldDefinition("EntityAliasTypeUuid", FieldType.UUID, false, null, null)
068        );
069
070        EDIT_FIELD_DEFINITIONS = List.of(
071                new FieldDefinition("Alias", FieldType.ENTITY_NAME, true, null, null)
072        );
073    }
074
075    /** Creates a new instance of EditEntityAliasCommand */
076    public EditEntityAliasCommand() {
077        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
078    }
079    
080    @Override
081    protected BaseResult execute() {
082        var result = CoreResultFactory.getEditEntityAliasResult();
083        var parameterCount = EntityInstanceLogic.getInstance().countPossibleEntitySpecs(spec);
084
085        if(parameterCount == 1) {
086            var entityInstance = EntityInstanceLogic.getInstance().getEntityInstance(this, spec);
087
088            if(!hasExecutionErrors()) {
089                var entityAliasTypeName = spec.getEntityAliasTypeName();
090                var entityAliasTypeUuid = spec.getEntityAliasTypeUuid();
091
092                parameterCount = (entityAliasTypeName == null ? 0 : 1) + (entityAliasTypeUuid == null ? 0 : 1);
093
094                if(parameterCount == 1) {
095                    var entityAliasType = entityAliasTypeName == null ?
096                            EntityAliasTypeLogic.getInstance().getEntityAliasTypeByUuid(this, entityAliasTypeUuid) :
097                            EntityAliasTypeLogic.getInstance().getEntityAliasTypeByName(this, entityInstance.getEntityType(), entityAliasTypeName);
098
099                    if(!hasExecutionErrors()) {
100                        if(entityInstance.getEntityType().equals(entityAliasType.getLastDetail().getEntityType())) {
101                            var entityAliasControl = Session.getModelController(EntityAliasControl.class);
102                            EntityAlias entityAlias = null;
103                            var basePK = PersistenceUtils.getInstance().getBasePKFromEntityInstance(entityInstance);
104
105                            if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
106                                entityAlias = entityAliasControl.getEntityAlias(entityInstance, entityAliasType);
107
108                                if(entityAlias != null) {
109                                    if(editMode.equals(EditMode.LOCK)) {
110                                        result.setEntityAlias(entityAliasControl.getEntityAliasTransfer(getUserVisit(), entityAlias));
111
112                                        if(lockEntity(basePK)) {
113                                            var edit = CoreEditFactory.getEntityAliasEdit();
114
115                                            result.setEdit(edit);
116                                            edit.setAlias(entityAlias.getAlias());
117                                        } else {
118                                            addExecutionError(ExecutionErrors.EntityLockFailed.name());
119                                        }
120                                    } else { // EditMode.ABANDON
121                                        unlockEntity(basePK);
122                                        basePK = null;
123                                    }
124                                } else {
125                                    addExecutionError(ExecutionErrors.UnknownEntityAlias.name(),
126                                            EntityInstanceLogic.getInstance().getEntityRefFromEntityInstance(entityInstance), entityAliasTypeName);
127                                }
128                            } else if(editMode.equals(EditMode.UPDATE)) {
129                                var validationPattern = entityAliasType.getLastDetail().getValidationPattern();
130                                var alias = edit.getAlias();
131
132                                if(validationPattern != null) {
133                                    var pattern = Pattern.compile(validationPattern);
134                                    var matcher = pattern.matcher(alias);
135
136                                    if(!matcher.matches()) {
137                                        addExecutionError(ExecutionErrors.InvalidAlias.name(), alias);
138                                    }
139                                }
140
141                                if(!hasExecutionErrors()) {
142                                    entityAlias = entityAliasControl.getEntityAliasForUpdate(entityInstance, entityAliasType);
143
144                                    if(entityAlias != null) {
145
146                                        var duplicateEntityAlias = entityAliasControl.getEntityAliasByEntityAliasTypeAndAlias(entityAliasType, alias);
147
148                                        if(duplicateEntityAlias != null && !entityAlias.equals(duplicateEntityAlias)) {
149                                            addExecutionError(ExecutionErrors.DuplicateEntityAlias.name(),
150                                                    EntityInstanceLogic.getInstance().getEntityRefFromEntityInstance(entityInstance),
151                                                    entityAliasType.getLastDetail().getEntityAliasTypeName(), alias);
152                                        } else {
153                                            if(lockEntityForUpdate(basePK)) {
154                                                try {
155                                                    var entityAliasValue = entityAliasControl.getEntityAliasValueForUpdate(entityAlias);
156
157                                                    entityAliasValue.setAlias(alias);
158
159                                                    entityAliasControl.updateEntityAliasFromValue(entityAliasValue, getPartyPK());
160                                                } finally {
161                                                    unlockEntity(basePK);
162                                                    basePK = null;
163                                                }
164                                            } else {
165                                                addExecutionError(ExecutionErrors.EntityLockStale.name());
166                                            }
167                                        }
168                                    } else {
169                                        addExecutionError(ExecutionErrors.UnknownEntityAlias.name(),
170                                                EntityInstanceLogic.getInstance().getEntityRefFromEntityInstance(entityInstance), entityAliasTypeName);
171                                    }
172                                }
173                            }
174
175                            if(basePK != null) {
176                                result.setEntityLock(getEntityLockTransfer(basePK));
177                            }
178
179                            if(entityAlias != null) {
180                                result.setEntityAlias(entityAliasControl.getEntityAliasTransfer(getUserVisit(), entityAlias));
181                            }
182                        } else {
183                            addExecutionError(ExecutionErrors.MismatchedEntityType.name());
184                        }
185                    }
186                } else {
187                    addExecutionError(ExecutionErrors.InvalidParameterCount.name());
188                }
189            }
190        } else {
191            addExecutionError(ExecutionErrors.InvalidParameterCount.name());
192        }
193
194        return result;
195    }
196    
197}