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