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 java.util.List;
039import javax.enterprise.context.Dependent;
040import javax.inject.Inject;
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    @Inject
063    ForumControl forumControl;
064
065    @Inject
066    MimeTypeControl mimeTypeControl;
067
068    
069    /** Creates a new instance of EditForumMessageAttachmentCommand */
070    public EditForumMessageAttachmentCommand() {
071        super(null, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
072    }
073
074    @Override
075    public EditForumMessageAttachmentResult getResult() {
076        return ForumResultFactory.getEditForumMessageAttachmentResult();
077    }
078
079    @Override
080    public ForumMessageAttachmentEdit getEdit() {
081        return ForumEditFactory.getForumMessageAttachmentEdit();
082    }
083
084    ItemDescriptionType itemDescriptionType;
085    Item item;
086
087    @Override
088    public ForumMessageAttachment getEntity(EditForumMessageAttachmentResult result) {
089        ForumMessageAttachment forumMessageAttachment = null;
090        var forumMessageName = spec.getForumMessageName();
091        var forumMessage = forumControl.getForumMessageByNameForUpdate(forumMessageName);
092
093        if(forumMessage != null) {
094            var forumMessageAttachmentSequence = Integer.valueOf(spec.getForumMessageAttachmentSequence());
095
096            if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
097                forumMessageAttachment = forumControl.getForumMessageAttachmentBySequence(forumMessage, forumMessageAttachmentSequence);
098            } else { // EditMode.UPDATE
099                forumMessageAttachment = forumControl.getForumMessageAttachmentBySequenceForUpdate(forumMessage, forumMessageAttachmentSequence);
100            }
101
102            if(forumMessageAttachment == null) {
103                addExecutionError(ExecutionErrors.UnknownForumMessageAttachment.name(), forumMessageName, forumMessageAttachmentSequence.toString());
104            }
105        } else {
106            addExecutionError(ExecutionErrors.UnknownForumMessageName.name(), forumMessageName);
107        }
108
109        return forumMessageAttachment;
110    }
111
112    @Override
113    public ForumMessageAttachment getLockEntity(ForumMessageAttachment forumMessageAttachment) {
114        return forumMessageAttachment;
115    }
116
117    @Override
118    public void fillInResult(EditForumMessageAttachmentResult result, ForumMessageAttachment forumMessageAttachment) {
119        result.setForumMessageAttachment(forumControl.getForumMessageAttachmentTransfer(getUserVisit(), forumMessageAttachment));
120    }
121
122    MimeType mimeType;
123
124    @Override
125    public void doLock(ForumMessageAttachmentEdit edit, ForumMessageAttachment forumMessageAttachment) {
126        mimeType = forumMessageAttachment.getLastDetail().getMimeType();
127
128        edit.setMimeTypeName(mimeType == null? null: mimeType.getLastDetail().getMimeTypeName());
129
130        var entityAttributeTypeName = mimeType.getLastDetail().getEntityAttributeType().getEntityAttributeTypeName();
131
132        // EntityAttributeTypes.BLOB.name() does not return anything in edit
133        if(entityAttributeTypeName.equals(EntityAttributeTypes.CLOB.name())) {
134            var forumMessageAttachmentClob = forumControl.getForumMessageClobAttachment(forumMessageAttachment);
135
136            if(forumMessageAttachmentClob != null) {
137                edit.setClob(forumMessageAttachmentClob.getClob());
138            }
139        }
140    }
141
142    @Override
143    public void canUpdate(ForumMessageAttachment forumMessageAttachment) {
144        var mimeTypeName = edit.getMimeTypeName();
145
146        mimeType = mimeTypeControl.getMimeTypeByName(mimeTypeName);
147
148        if(mimeType != null) {
149            var entityAttributeTypeName = mimeType.getLastDetail().getEntityAttributeType().getEntityAttributeTypeName();
150            var blob = edit.getBlob();
151            var clob = edit.getClob();
152
153            if(entityAttributeTypeName.equals(EntityAttributeTypes.BLOB.name()) && blob == null) {
154                addExecutionError(ExecutionErrors.MissingBlob.name());
155            } else {
156                if(entityAttributeTypeName.equals(EntityAttributeTypes.CLOB.name()) && clob == null) {
157                    addExecutionError(ExecutionErrors.MissingClob.name());
158                }
159            }
160        } else {
161            addExecutionError(ExecutionErrors.UnknownMimeTypeName.name(), mimeTypeName);
162        }
163    }
164
165    @Override
166    public void doUpdate(ForumMessageAttachment forumMessageAttachment) {
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}