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.core.server.command;
018
019import com.echothree.control.user.core.common.edit.CoreEditFactory;
020import com.echothree.control.user.core.common.edit.EntityBlobAttributeEdit;
021import com.echothree.control.user.core.common.form.EditEntityBlobAttributeForm;
022import com.echothree.control.user.core.common.result.CoreResultFactory;
023import com.echothree.control.user.core.common.spec.EntityBlobAttributeSpec;
024import com.echothree.model.control.core.common.EntityAttributeTypes;
025import com.echothree.model.control.core.server.control.EntityInstanceControl;
026import com.echothree.model.control.core.server.logic.MimeTypeLogic;
027import com.echothree.model.control.party.common.PartyTypes;
028import com.echothree.model.control.party.server.control.PartyControl;
029import com.echothree.model.data.core.server.entity.EntityBlobAttribute;
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.persistence.PersistenceUtils;
040import com.echothree.util.server.persistence.Session;
041import java.util.List;
042import javax.enterprise.context.Dependent;
043
044@Dependent
045public class EditEntityBlobAttributeCommand
046        extends BaseEditCommand<EntityBlobAttributeSpec, EntityBlobAttributeEdit> {
047
048    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
049    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
050    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
051    
052    static {
053        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
054                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
055                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), null)
056        ));
057
058        SPEC_FIELD_DEFINITIONS = List.of(
059                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, true, null, null),
060                new FieldDefinition("EntityAttributeName", FieldType.ENTITY_NAME, true, null, null),
061                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
062                );
063        
064        EDIT_FIELD_DEFINITIONS = List.of(
065                new FieldDefinition("MimeTypeName", FieldType.MIME_TYPE, true, null, null)
066                );
067    }
068    
069    /** Creates a new instance of EditEntityBlobAttributeCommand */
070    public EditEntityBlobAttributeCommand() {
071        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
072    }
073    
074    @Override
075    protected BaseResult execute() {
076        var entityInstanceControl = Session.getModelController(EntityInstanceControl.class);
077        var result = CoreResultFactory.getEditEntityBlobAttributeResult();
078        var entityRef = spec.getEntityRef();
079        var entityInstance = entityInstanceControl.getEntityInstanceByEntityRef(entityRef);
080
081        if(entityInstance != null) {
082            var entityAttributeName = spec.getEntityAttributeName();
083            var entityAttribute = coreControl.getEntityAttributeByName(entityInstance.getEntityType(), entityAttributeName);
084
085            if(entityAttribute != null) {
086                var partyControl = Session.getModelController(PartyControl.class);
087                var languageIsoName = spec.getLanguageIsoName();
088                var language = partyControl.getLanguageByIsoName(languageIsoName);
089
090                if(language != null) {
091                    EntityBlobAttribute entityBlobAttribute = null;
092                    var basePK = PersistenceUtils.getInstance().getBasePKFromEntityInstance(entityInstance);
093                    
094                    if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
095                        entityBlobAttribute = coreControl.getEntityBlobAttribute(entityAttribute, entityInstance, language);
096
097                        if(entityBlobAttribute != null) {
098                            if(editMode.equals(EditMode.LOCK)) {
099                                result.setEntityBlobAttribute(coreControl.getEntityBlobAttributeTransfer(getUserVisit(),
100                                        entityBlobAttribute, entityInstance));
101
102                                if(lockEntity(basePK)) {
103                                    var edit = CoreEditFactory.getEntityBlobAttributeEdit();
104
105                                    result.setEdit(edit);
106                                    edit.setMimeTypeName(entityBlobAttribute.getMimeType().getLastDetail().getMimeTypeName());
107                                } else {
108                                    addExecutionError(ExecutionErrors.EntityLockFailed.name());
109                                }
110                            } else { // EditMode.ABANDON
111                                unlockEntity(basePK);
112                                basePK = null;
113                            }
114                        } else {
115                            var entityTypeDetail = entityInstance.getEntityType().getLastDetail();
116
117                            addExecutionError(ExecutionErrors.UnknownEntityBlobAttribute.name(), entityRef,
118                                    entityTypeDetail.getComponentVendor().getLastDetail().getComponentVendorName(),
119                                    entityTypeDetail.getEntityTypeName(), entityAttributeName, languageIsoName);
120                        }
121                    } else if(editMode.equals(EditMode.UPDATE)) {
122                        entityBlobAttribute = coreControl.getEntityBlobAttributeForUpdate(entityAttribute, entityInstance, language);
123
124                        if(entityBlobAttribute != null) {
125                            var mimeType = MimeTypeLogic.getInstance().getMimeTypeByName(this, edit.getMimeTypeName());
126
127                            if(!hasExecutionErrors()) {
128                                if(mimeType.getLastDetail().getEntityAttributeType().getEntityAttributeTypeName().equals(EntityAttributeTypes.BLOB.name())) {
129                                    var blobAttribute = edit.getBlobAttribute();
130
131                                    if(blobAttribute != null) {
132                                        if(lockEntityForUpdate(basePK)) {
133                                            try {
134                                                var entityBlobAttributeValue = coreControl.getEntityBlobAttributeValueForUpdate(entityBlobAttribute);
135
136                                                entityBlobAttributeValue.setBlobAttribute(blobAttribute);
137                                                entityBlobAttributeValue.setMimeTypePK(mimeType.getPrimaryKey());
138
139                                                coreControl.updateEntityBlobAttributeFromValue(entityBlobAttributeValue, getPartyPK());
140                                            } finally {
141                                                unlockEntity(basePK);
142                                                basePK = null;
143                                            }
144                                        } else {
145                                            addExecutionError(ExecutionErrors.EntityLockStale.name());
146                                        }
147                                    } else {
148                                        addExecutionError(ExecutionErrors.MissingBlobAttribute.name());
149                                    }
150                                } else {
151                                    addExecutionError(ExecutionErrors.InvalidMimeType.name(), mimeType.getLastDetail().getMimeTypeName());
152                                }
153                            }
154                        } else {
155                            var entityTypeDetail = entityInstance.getEntityType().getLastDetail();
156
157                            addExecutionError(ExecutionErrors.UnknownEntityBlobAttribute.name(), entityRef,
158                                    entityTypeDetail.getComponentVendor().getLastDetail().getComponentVendorName(),
159                                    entityTypeDetail.getEntityTypeName(), entityAttributeName, languageIsoName);
160                        }
161                    }
162                    
163                    if(basePK != null) {
164                        result.setEntityLock(getEntityLockTransfer(basePK));
165                    }
166
167                    if(entityBlobAttribute != null) {
168                        result.setEntityBlobAttribute(coreControl.getEntityBlobAttributeTransfer(getUserVisit(), entityBlobAttribute, entityInstance));
169                    }
170                } else {
171                    addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
172                }
173            } else {
174                var entityTypeDetail = entityInstance.getEntityType().getLastDetail();
175
176                addExecutionError(ExecutionErrors.UnknownEntityAttributeName.name(), entityTypeDetail.getComponentVendor().getLastDetail().getComponentVendorName(),
177                        entityTypeDetail.getEntityTypeName(), entityAttributeName);
178            }
179        } else {
180            addExecutionError(ExecutionErrors.UnknownEntityRef.name(), entityRef);
181        }
182
183        return result;
184    }
185    
186}