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.forum.server.command;
018
019import com.echothree.control.user.forum.common.form.CreateForumMessageAttachmentForm;
020import com.echothree.model.control.core.common.EntityAttributeTypes;
021import com.echothree.model.control.forum.server.control.ForumControl;
022import com.echothree.model.data.core.server.entity.MimeType;
023import com.echothree.model.data.forum.server.entity.ForumMessage;
024import com.echothree.model.data.forum.server.entity.ForumMessageAttachment;
025import com.echothree.model.data.forum.server.entity.ForumMessageStatus;
026import com.echothree.model.data.user.common.pk.UserVisitPK;
027import com.echothree.util.common.message.ExecutionErrors;
028import com.echothree.util.common.validation.FieldDefinition;
029import com.echothree.util.common.validation.FieldType;
030import com.echothree.util.common.command.BaseResult;
031import com.echothree.util.common.persistence.type.ByteArray;
032import com.echothree.util.server.control.BaseSimpleCommand;
033import com.echothree.util.server.persistence.Session;
034import java.util.Arrays;
035import java.util.Collections;
036import java.util.List;
037
038public class CreateForumMessageAttachmentCommand
039        extends BaseSimpleCommand<CreateForumMessageAttachmentForm> {
040    
041    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
042    
043    static {
044        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
045                new FieldDefinition("ForumMessageName", FieldType.ENTITY_NAME, true, null, null),
046                new FieldDefinition("ForumMessageAttachmentSequence", FieldType.UNSIGNED_INTEGER, false, null, null),
047                new FieldDefinition("MimeTypeName", FieldType.MIME_TYPE, true, null, null),
048                new FieldDefinition("Clob", FieldType.STRING, false, 1L, null),
049                new FieldDefinition("String", FieldType.STRING, false, 1L, 512L)
050                ));
051    }
052    
053    /** Creates a new instance of CreateForumMessageAttachmentCommand */
054    public CreateForumMessageAttachmentCommand(UserVisitPK userVisitPK, CreateForumMessageAttachmentForm form) {
055        super(userVisitPK, form, null, FORM_FIELD_DEFINITIONS, false);
056    }
057    
058    @Override
059    protected BaseResult execute() {
060        var forumControl = Session.getModelController(ForumControl.class);
061        String forumMessageName = form.getForumMessageName();
062        ForumMessage forumMessage = forumControl.getForumMessageByNameForUpdate(forumMessageName);
063
064        if(forumMessage != null) {
065            var coreControl = getCoreControl();
066            String mimeTypeName = form.getMimeTypeName();
067            MimeType mimeType = coreControl.getMimeTypeByName(mimeTypeName);
068
069            if(mimeType != null) {
070                String entityAttributeTypeName = mimeType.getLastDetail().getEntityAttributeType().getEntityAttributeTypeName();
071                ByteArray blob = form.getBlob();
072                String clob = form.getClob();
073
074                if(entityAttributeTypeName.equals(EntityAttributeTypes.BLOB.name()) && blob == null) {
075                    addExecutionError(ExecutionErrors.MissingBlob.name());
076                } else {
077                    if(entityAttributeTypeName.equals(EntityAttributeTypes.CLOB.name()) && clob == null) {
078                        addExecutionError(ExecutionErrors.MissingClob.name());
079                    }
080                }
081
082                if(!hasExecutionErrors()) {
083                    var partyPK = getPartyPK();
084                    String strForumMessageAttachmentSequence = form.getForumMessageAttachmentSequence();
085                    Integer forumMessageAttachmentSequence = strForumMessageAttachmentSequence == null ? null : Integer.valueOf(strForumMessageAttachmentSequence);
086                    ForumMessageAttachment forumMessageAttachment = null;
087                    ForumMessageStatus forumMessageStatus = forumControl.getOrCreateForumMessageStatusForUpdate(forumMessage);
088
089                    if(forumMessageAttachmentSequence == null) {
090                        forumMessageAttachmentSequence = forumMessageStatus.getForumMessageAttachmentSequence() + 1;
091                        forumMessageStatus.setForumMessageAttachmentSequence(forumMessageAttachmentSequence);
092                    } else {
093                        forumMessageAttachment = forumControl.getForumMessageAttachmentBySequence(forumMessage, forumMessageAttachmentSequence);
094
095                        if(forumMessageAttachment == null) {
096                            // If the forumMessageAttachmentSequence is > the last one that was recorded in the OrderStatus, jump the
097                            // one in OrderStatus forward - it should always record the greatest forumMessageAttachmentSequence used.
098                            if(forumMessageAttachmentSequence > forumMessageStatus.getForumMessageAttachmentSequence()) {
099                                forumMessageStatus.setForumMessageAttachmentSequence(forumMessageAttachmentSequence);
100                            }
101                        } else {
102                            addExecutionError(ExecutionErrors.DuplicateForumMessageAttachmentSequence.name(), forumMessageName, forumMessageAttachmentSequence.toString());
103                        }
104                    }
105
106                    forumMessageAttachment = forumControl.createForumMessageAttachment(forumMessage, forumMessageAttachmentSequence, mimeType, partyPK);
107
108                    if(entityAttributeTypeName.equals(EntityAttributeTypes.BLOB.name())) {
109                        forumControl.createForumMessageBlobAttachment(forumMessageAttachment, blob, partyPK);
110                    } else {
111                        if(entityAttributeTypeName.equals(EntityAttributeTypes.CLOB.name())) {
112                            forumControl.createForumMessageClobAttachment(forumMessageAttachment, clob, partyPK);
113                        }
114                    }
115                }
116            } else {
117                addExecutionError(ExecutionErrors.UnknownMimeTypeName.name(), mimeTypeName);
118            }
119        } else {
120            addExecutionError(ExecutionErrors.UnknownForumMessageName.name(), forumMessageName);
121        }
122        
123        return null;
124    }
125    
126}