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.ForumLogic;
024import com.echothree.model.control.party.server.control.PartyControl;
025import com.echothree.model.data.user.common.pk.UserVisitPK;
026import com.echothree.util.common.message.ExecutionErrors;
027import com.echothree.util.common.validation.FieldDefinition;
028import com.echothree.util.common.validation.FieldType;
029import com.echothree.util.common.command.BaseResult;
030import com.echothree.util.server.control.BaseSimpleCommand;
031import com.echothree.util.server.persistence.Session;
032import java.util.List;
033import javax.enterprise.context.Dependent;
034
035@Dependent
036public class GetForumMessageAttachmentDescriptionCommand
037        extends BaseSimpleCommand<GetForumMessageAttachmentDescriptionForm> {
038    
039    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
040    
041    static {
042        FORM_FIELD_DEFINITIONS = List.of(
043                new FieldDefinition("ForumMessageName", FieldType.ENTITY_NAME, true, null, null),
044                new FieldDefinition("ForumMessageAttachmentSequence", FieldType.UNSIGNED_INTEGER, true, null, null),
045                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
046                );
047    }
048    
049    /** Creates a new instance of GetForumMessageAttachmentDescriptionCommand */
050    public GetForumMessageAttachmentDescriptionCommand() {
051        super(null, FORM_FIELD_DEFINITIONS, false);
052    }
053    
054    @Override
055    protected BaseResult execute() {
056        var forumControl = Session.getModelController(ForumControl.class);
057        var result = ForumResultFactory.getGetForumMessageAttachmentDescriptionResult();
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                    var partyControl = Session.getModelController(PartyControl.class);
068                    var languageIsoName = form.getLanguageIsoName();
069                    var language = partyControl.getLanguageByIsoName(languageIsoName);
070
071                    if(language != null) {
072                        var forumMessageAttachmentDescription = forumControl.getForumMessageAttachmentDescription(forumMessageAttachment, language);
073
074                        if(forumMessageAttachmentDescription != null) {
075                            result.setForumMessageAttachmentDescription(forumControl.getForumMessageAttachmentDescriptionTransfer(getUserVisit(), forumMessageAttachmentDescription));
076                        } else {
077                            addExecutionError(ExecutionErrors.UnknownForumMessageAttachmentDescription.name(), forumMessageName,
078                                    forumMessageAttachmentSequence.toString(), languageIsoName);
079                        }
080                    } else {
081                        addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
082                    }
083                } else {
084                    addExecutionError(ExecutionErrors.UnknownForumMessageAttachment.name(), forumMessageName, forumMessageAttachmentSequence.toString());
085                }
086            } else {
087                addExecutionError(ExecutionErrors.MissingRequiredForumRoleType.name(), ForumConstants.ForumRoleType_READER);
088            }
089        } else {
090            addExecutionError(ExecutionErrors.UnknownForumMessageName.name(), forumMessageName);
091        }
092
093        return result;
094    }
095    
096}