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.forum.server.command;
018
019import com.echothree.control.user.forum.common.edit.ForumEditFactory;
020import com.echothree.control.user.forum.common.edit.ForumMessageAttachmentEdit;
021import com.echothree.control.user.forum.common.form.EditForumMessageAttachmentForm;
022import com.echothree.control.user.forum.common.result.EditForumMessageAttachmentResult;
023import com.echothree.control.user.forum.common.result.ForumResultFactory;
024import com.echothree.control.user.forum.common.spec.ForumMessageAttachmentSpec;
025import com.echothree.model.control.core.common.EntityAttributeTypes;
026import com.echothree.model.control.core.server.control.MimeTypeControl;
027import com.echothree.model.control.forum.server.control.ForumControl;
028import com.echothree.model.data.core.server.entity.MimeType;
029import com.echothree.model.data.forum.server.entity.ForumMessageAttachment;
030import com.echothree.model.data.item.server.entity.Item;
031import com.echothree.model.data.item.server.entity.ItemDescriptionType;
032import com.echothree.model.data.user.common.pk.UserVisitPK;
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.BaseAbstractEditCommand;
038import com.echothree.util.server.persistence.Session;
039import java.util.List;
040import javax.enterprise.context.Dependent;
041
042@Dependent
043public class EditForumMessageAttachmentCommand
044        extends BaseAbstractEditCommand<ForumMessageAttachmentSpec, ForumMessageAttachmentEdit, EditForumMessageAttachmentResult, ForumMessageAttachment, ForumMessageAttachment> {
045    
046    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
047    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
048    
049    static {
050        SPEC_FIELD_DEFINITIONS = List.of(
051                new FieldDefinition("ForumMessageName", FieldType.ENTITY_NAME, true, null, null),
052                new FieldDefinition("ForumMessageAttachmentSequence", FieldType.UNSIGNED_INTEGER, true, null, null)
053                );
054        
055        EDIT_FIELD_DEFINITIONS = List.of(
056                new FieldDefinition("MimeTypeName", FieldType.MIME_TYPE, true, null, null),
057                new FieldDefinition("Clob", FieldType.STRING, false, 1L, null),
058                new FieldDefinition("String", FieldType.STRING, false, 1L, 512L)
059                );
060    }
061    
062    /** Creates a new instance of EditForumMessageAttachmentCommand */
063    public EditForumMessageAttachmentCommand() {
064        super(null, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
065    }
066
067    @Override
068    public EditForumMessageAttachmentResult getResult() {
069        return ForumResultFactory.getEditForumMessageAttachmentResult();
070    }
071
072    @Override
073    public ForumMessageAttachmentEdit getEdit() {
074        return ForumEditFactory.getForumMessageAttachmentEdit();
075    }
076
077    ItemDescriptionType itemDescriptionType;
078    Item item;
079
080    @Override
081    public ForumMessageAttachment getEntity(EditForumMessageAttachmentResult result) {
082        var forumControl = Session.getModelController(ForumControl.class);
083        ForumMessageAttachment forumMessageAttachment = null;
084        var forumMessageName = spec.getForumMessageName();
085        var forumMessage = forumControl.getForumMessageByNameForUpdate(forumMessageName);
086
087        if(forumMessage != null) {
088            var forumMessageAttachmentSequence = Integer.valueOf(spec.getForumMessageAttachmentSequence());
089
090            if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
091                forumMessageAttachment = forumControl.getForumMessageAttachmentBySequence(forumMessage, forumMessageAttachmentSequence);
092            } else { // EditMode.UPDATE
093                forumMessageAttachment = forumControl.getForumMessageAttachmentBySequenceForUpdate(forumMessage, forumMessageAttachmentSequence);
094            }
095
096            if(forumMessageAttachment == null) {
097                addExecutionError(ExecutionErrors.UnknownForumMessageAttachment.name(), forumMessageName, forumMessageAttachmentSequence.toString());
098            }
099        } else {
100            addExecutionError(ExecutionErrors.UnknownForumMessageName.name(), forumMessageName);
101        }
102
103        return forumMessageAttachment;
104    }
105
106    @Override
107    public ForumMessageAttachment getLockEntity(ForumMessageAttachment forumMessageAttachment) {
108        return forumMessageAttachment;
109    }
110
111    @Override
112    public void fillInResult(EditForumMessageAttachmentResult result, ForumMessageAttachment forumMessageAttachment) {
113        var forumControl = Session.getModelController(ForumControl.class);
114
115        result.setForumMessageAttachment(forumControl.getForumMessageAttachmentTransfer(getUserVisit(), forumMessageAttachment));
116    }
117
118    MimeType mimeType;
119
120    @Override
121    public void doLock(ForumMessageAttachmentEdit edit, ForumMessageAttachment forumMessageAttachment) {
122        var forumControl = Session.getModelController(ForumControl.class);
123        
124        mimeType = forumMessageAttachment.getLastDetail().getMimeType();
125
126        edit.setMimeTypeName(mimeType == null? null: mimeType.getLastDetail().getMimeTypeName());
127
128        var entityAttributeTypeName = mimeType.getLastDetail().getEntityAttributeType().getEntityAttributeTypeName();
129
130        // EntityAttributeTypes.BLOB.name() does not return anything in edit
131        if(entityAttributeTypeName.equals(EntityAttributeTypes.CLOB.name())) {
132            var forumMessageAttachmentClob = forumControl.getForumMessageClobAttachment(forumMessageAttachment);
133
134            if(forumMessageAttachmentClob != null) {
135                edit.setClob(forumMessageAttachmentClob.getClob());
136            }
137        }
138    }
139
140    @Override
141    public void canUpdate(ForumMessageAttachment forumMessageAttachment) {
142        var mimeTypeControl = Session.getModelController(MimeTypeControl.class);
143        var mimeTypeName = edit.getMimeTypeName();
144
145        mimeType = mimeTypeControl.getMimeTypeByName(mimeTypeName);
146
147        if(mimeType != null) {
148            var entityAttributeTypeName = mimeType.getLastDetail().getEntityAttributeType().getEntityAttributeTypeName();
149            var blob = edit.getBlob();
150            var clob = edit.getClob();
151
152            if(entityAttributeTypeName.equals(EntityAttributeTypes.BLOB.name()) && blob == null) {
153                addExecutionError(ExecutionErrors.MissingBlob.name());
154            } else {
155                if(entityAttributeTypeName.equals(EntityAttributeTypes.CLOB.name()) && clob == null) {
156                    addExecutionError(ExecutionErrors.MissingClob.name());
157                }
158            }
159        } else {
160            addExecutionError(ExecutionErrors.UnknownMimeTypeName.name(), mimeTypeName);
161        }
162    }
163
164    @Override
165    public void doUpdate(ForumMessageAttachment forumMessageAttachment) {
166        var forumControl = Session.getModelController(ForumControl.class);
167        var forumMessageAttachmentDetailValue = forumControl.getForumMessageAttachmentDetailValueForUpdate(forumMessageAttachment);
168        var entityAttributeTypeName = mimeType.getLastDetail().getEntityAttributeType().getEntityAttributeTypeName();
169        var updatedBy = getPartyPK();
170
171        forumMessageAttachmentDetailValue.setMimeTypePK(mimeType.getPrimaryKey());
172        forumControl.updateForumMessageAttachmentFromValue(forumMessageAttachmentDetailValue, updatedBy);
173
174        var forumMessageAttachmentBlob = forumControl.getForumMessageBlobAttachmentForUpdate(forumMessageAttachment);
175        var forumMessageAttachmentClob = forumControl.getForumMessageClobAttachmentForUpdate(forumMessageAttachment);
176
177        if(entityAttributeTypeName.equals(EntityAttributeTypes.BLOB.name())) {
178            var blob = edit.getBlob();
179
180            if(forumMessageAttachmentClob != null) {
181                forumControl.deleteForumMessageClobAttachment(forumMessageAttachmentClob, updatedBy);
182            }
183
184            if(forumMessageAttachmentBlob == null) {
185                forumControl.createForumMessageBlobAttachment(forumMessageAttachment, blob, updatedBy);
186            } else {
187                var forumMessageAttachmentBlobValue = forumControl.getForumMessageBlobAttachmentValue(forumMessageAttachmentBlob);
188
189                forumMessageAttachmentBlobValue.setBlob(blob);
190            }
191        } else if(entityAttributeTypeName.equals(EntityAttributeTypes.CLOB.name())) {
192            var clob = edit.getClob();
193            
194            if(forumMessageAttachmentBlob != null) {
195                forumControl.deleteForumMessageBlobAttachment(forumMessageAttachmentBlob, updatedBy);
196            }
197
198            if(forumMessageAttachmentClob == null) {
199                forumControl.createForumMessageClobAttachment(forumMessageAttachment, clob, updatedBy);
200            } else {
201                var forumMessageAttachmentClobValue = forumControl.getForumMessageClobAttachmentValue(forumMessageAttachmentClob);
202
203                forumMessageAttachmentClobValue.setClob(clob);
204            }
205        }
206    }
207    
208}