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.GetForumMessageAttachmentForm;
020import com.echothree.control.user.forum.common.result.ForumResultFactory;
021import com.echothree.model.control.content.server.logic.ContentLogic;
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.ForumRoleTypeLogic;
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 GetForumMessageAttachmentCommand
036        extends BaseSimpleCommand<GetForumMessageAttachmentForm> {
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                new FieldDefinition("Referrer", FieldType.URL, false, null, null)
045                );
046    }
047    
048    /** Creates a new instance of GetForumMessageAttachmentCommand */
049    public GetForumMessageAttachmentCommand() {
050        super(null, FORM_FIELD_DEFINITIONS, true);
051    }
052    
053    @Override
054    protected BaseResult execute() {
055        var result = ForumResultFactory.getGetForumMessageAttachmentResult();
056        ContentLogic.getInstance().checkReferrer(this, form.getReferrer());
057
058        if(!hasExecutionErrors()) {
059            var forumControl = Session.getModelController(ForumControl.class);
060            var forumMessageName = form.getForumMessageName();
061            var forumMessage = forumControl.getForumMessageByNameForUpdate(forumMessageName);
062
063            if(forumMessage != null) {
064                if(ForumRoleTypeLogic.getInstance().isForumRoleTypePermitted(this, forumMessage, getParty(), ForumConstants.ForumRoleType_READER)) {
065                    var forumMessageAttachmentSequence = Integer.valueOf(form.getForumMessageAttachmentSequence());
066                    var forumMessageAttachment = forumControl.getForumMessageAttachmentBySequence(forumMessage, forumMessageAttachmentSequence);
067
068                    if(forumMessageAttachment != null) {
069                        result.setForumMessageAttachment(forumControl.getForumMessageAttachmentTransfer(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
081        return result;
082    }
083    
084}