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.GetForumMessageAttachmentDescriptionForm;
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.model.control.party.server.control.PartyControl;
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 GetForumMessageAttachmentDescriptionCommand
036        extends BaseSimpleCommand<GetForumMessageAttachmentDescriptionForm> {
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("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
045                );
046    }
047    
048    /** Creates a new instance of GetForumMessageAttachmentDescriptionCommand */
049    public GetForumMessageAttachmentDescriptionCommand() {
050        super(null, FORM_FIELD_DEFINITIONS, false);
051    }
052    
053    @Override
054    protected BaseResult execute() {
055        var forumControl = Session.getModelController(ForumControl.class);
056        var result = ForumResultFactory.getGetForumMessageAttachmentDescriptionResult();
057        var forumMessageName = form.getForumMessageName();
058        var forumMessage = forumControl.getForumMessageByNameForUpdate(forumMessageName);
059
060        if(forumMessage != null) {
061            if(ForumRoleTypeLogic.getInstance().isForumRoleTypePermitted(this, forumMessage, getParty(), ForumConstants.ForumRoleType_READER)) {
062                var forumMessageAttachmentSequence = Integer.valueOf(form.getForumMessageAttachmentSequence());
063                var forumMessageAttachment = forumControl.getForumMessageAttachmentBySequence(forumMessage, forumMessageAttachmentSequence);
064
065                if(forumMessageAttachment != null) {
066                    var partyControl = Session.getModelController(PartyControl.class);
067                    var languageIsoName = form.getLanguageIsoName();
068                    var language = partyControl.getLanguageByIsoName(languageIsoName);
069
070                    if(language != null) {
071                        var forumMessageAttachmentDescription = forumControl.getForumMessageAttachmentDescription(forumMessageAttachment, language);
072
073                        if(forumMessageAttachmentDescription != null) {
074                            result.setForumMessageAttachmentDescription(forumControl.getForumMessageAttachmentDescriptionTransfer(getUserVisit(), forumMessageAttachmentDescription));
075                        } else {
076                            addExecutionError(ExecutionErrors.UnknownForumMessageAttachmentDescription.name(), forumMessageName,
077                                    forumMessageAttachmentSequence.toString(), languageIsoName);
078                        }
079                    } else {
080                        addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
081                    }
082                } else {
083                    addExecutionError(ExecutionErrors.UnknownForumMessageAttachment.name(), forumMessageName, forumMessageAttachmentSequence.toString());
084                }
085            } else {
086                addExecutionError(ExecutionErrors.MissingRequiredForumRoleType.name(), ForumConstants.ForumRoleType_READER);
087            }
088        } else {
089            addExecutionError(ExecutionErrors.UnknownForumMessageName.name(), forumMessageName);
090        }
091
092        return result;
093    }
094    
095}