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.GetForumMessageAttachmentDescriptionsForm;
020import com.echothree.control.user.forum.common.result.ForumResultFactory;
021import com.echothree.control.user.forum.common.result.GetForumMessageAttachmentDescriptionsResult;
022import com.echothree.model.control.forum.common.ForumConstants;
023import com.echothree.model.control.forum.server.control.ForumControl;
024import com.echothree.model.control.forum.server.logic.ForumLogic;
025import com.echothree.model.data.forum.server.entity.ForumMessage;
026import com.echothree.model.data.forum.server.entity.ForumMessageAttachment;
027import com.echothree.model.data.user.common.pk.UserVisitPK;
028import com.echothree.util.common.message.ExecutionErrors;
029import com.echothree.util.common.validation.FieldDefinition;
030import com.echothree.util.common.validation.FieldType;
031import com.echothree.util.common.command.BaseResult;
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 GetForumMessageAttachmentDescriptionsCommand
039        extends BaseSimpleCommand<GetForumMessageAttachmentDescriptionsForm> {
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, true, null, null)
047                ));
048    }
049    
050    /** Creates a new instance of GetForumMessageAttachmentDescriptionsCommand */
051    public GetForumMessageAttachmentDescriptionsCommand(UserVisitPK userVisitPK, GetForumMessageAttachmentDescriptionsForm form) {
052        super(userVisitPK, form, null, FORM_FIELD_DEFINITIONS, true);
053    }
054    
055    @Override
056    protected BaseResult execute() {
057        var forumControl = Session.getModelController(ForumControl.class);
058        GetForumMessageAttachmentDescriptionsResult result = ForumResultFactory.getGetForumMessageAttachmentDescriptionsResult();
059        String forumMessageName = form.getForumMessageName();
060        ForumMessage forumMessage = forumControl.getForumMessageByNameForUpdate(forumMessageName);
061
062        if(forumMessage != null) {
063            if(ForumLogic.getInstance().isForumRoleTypePermitted(this, forumMessage, getParty(), ForumConstants.ForumRoleType_READER)) {
064                Integer forumMessageAttachmentSequence = Integer.valueOf(form.getForumMessageAttachmentSequence());
065                ForumMessageAttachment forumMessageAttachment = forumControl.getForumMessageAttachmentBySequence(forumMessage, forumMessageAttachmentSequence);
066
067                if(forumMessageAttachment != null) {
068                    result.setForumMessageAttachment(forumControl.getForumMessageAttachmentTransfer(getUserVisit(), forumMessageAttachment));
069                    result.setForumMessageAttachmentDescriptions(forumControl.getForumMessageAttachmentDescriptionTransfersByForumMessageAttachment(getUserVisit(), forumMessageAttachment));
070                } else {
071                    addExecutionError(ExecutionErrors.UnknownForumMessageAttachment.name(), forumMessageName, forumMessageAttachmentSequence.toString());
072                }
073            } else {
074                addExecutionError(ExecutionErrors.MissingRequiredForumRoleType.name(), ForumConstants.ForumRoleType_READER);
075            }
076        } else {
077            addExecutionError(ExecutionErrors.UnknownForumMessageName.name(), forumMessageName);
078        }
079        
080        return result;
081    }
082    
083}