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