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