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