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.form.GetForumMessageAttachmentDescriptionsForm;
020import com.echothree.control.user.forum.common.result.ForumResultFactory;
021import com.echothree.model.control.forum.common.ForumConstants;
022import com.echothree.model.control.forum.server.control.ForumControl;
023import com.echothree.model.control.forum.server.logic.ForumLogic;
024import com.echothree.model.data.user.common.pk.UserVisitPK;
025import com.echothree.util.common.message.ExecutionErrors;
026import com.echothree.util.common.validation.FieldDefinition;
027import com.echothree.util.common.validation.FieldType;
028import com.echothree.util.common.command.BaseResult;
029import com.echothree.util.server.control.BaseSimpleCommand;
030import com.echothree.util.server.persistence.Session;
031import java.util.Arrays;
032import java.util.Collections;
033import java.util.List;
034import javax.enterprise.context.RequestScoped;
035
036@RequestScoped
037public class GetForumMessageAttachmentDescriptionsCommand
038        extends BaseSimpleCommand<GetForumMessageAttachmentDescriptionsForm> {
039    
040    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
041    
042    static {
043        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
044                new FieldDefinition("ForumMessageName", FieldType.ENTITY_NAME, true, null, null),
045                new FieldDefinition("ForumMessageAttachmentSequence", FieldType.UNSIGNED_INTEGER, true, null, null)
046                ));
047    }
048    
049    /** Creates a new instance of GetForumMessageAttachmentDescriptionsCommand */
050    public GetForumMessageAttachmentDescriptionsCommand() {
051        super(null, FORM_FIELD_DEFINITIONS, true);
052    }
053    
054    @Override
055    protected BaseResult execute() {
056        var forumControl = Session.getModelController(ForumControl.class);
057        var result = ForumResultFactory.getGetForumMessageAttachmentDescriptionsResult();
058        var forumMessageName = form.getForumMessageName();
059        var forumMessage = forumControl.getForumMessageByNameForUpdate(forumMessageName);
060
061        if(forumMessage != null) {
062            if(ForumLogic.getInstance().isForumRoleTypePermitted(this, forumMessage, getParty(), ForumConstants.ForumRoleType_READER)) {
063                var forumMessageAttachmentSequence = Integer.valueOf(form.getForumMessageAttachmentSequence());
064                var forumMessageAttachment = forumControl.getForumMessageAttachmentBySequence(forumMessage, forumMessageAttachmentSequence);
065
066                if(forumMessageAttachment != null) {
067                    result.setForumMessageAttachment(forumControl.getForumMessageAttachmentTransfer(getUserVisit(), forumMessageAttachment));
068                    result.setForumMessageAttachmentDescriptions(forumControl.getForumMessageAttachmentDescriptionTransfersByForumMessageAttachment(getUserVisit(), forumMessageAttachment));
069                } else {
070                    addExecutionError(ExecutionErrors.UnknownForumMessageAttachment.name(), forumMessageName, forumMessageAttachmentSequence.toString());
071                }
072            } else {
073                addExecutionError(ExecutionErrors.MissingRequiredForumRoleType.name(), ForumConstants.ForumRoleType_READER);
074            }
075        } else {
076            addExecutionError(ExecutionErrors.UnknownForumMessageName.name(), forumMessageName);
077        }
078        
079        return result;
080    }
081    
082}