001// --------------------------------------------------------------------------------
002// Copyright 2002-2024 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.control.user.forum.common.result.GetForumMessageAttachmentDescriptionResult;
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.ForumLogic;
025import com.echothree.model.control.party.server.control.PartyControl;
026import com.echothree.model.data.forum.server.entity.ForumMessage;
027import com.echothree.model.data.forum.server.entity.ForumMessageAttachment;
028import com.echothree.model.data.forum.server.entity.ForumMessageAttachmentDescription;
029import com.echothree.model.data.party.server.entity.Language;
030import com.echothree.model.data.user.common.pk.UserVisitPK;
031import com.echothree.util.common.message.ExecutionErrors;
032import com.echothree.util.common.validation.FieldDefinition;
033import com.echothree.util.common.validation.FieldType;
034import com.echothree.util.common.command.BaseResult;
035import com.echothree.util.server.control.BaseSimpleCommand;
036import com.echothree.util.server.persistence.Session;
037import java.util.Arrays;
038import java.util.Collections;
039import java.util.List;
040
041public class GetForumMessageAttachmentDescriptionCommand
042        extends BaseSimpleCommand<GetForumMessageAttachmentDescriptionForm> {
043    
044    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
045    
046    static {
047        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
048                new FieldDefinition("ForumMessageName", FieldType.ENTITY_NAME, true, null, null),
049                new FieldDefinition("ForumMessageAttachmentSequence", FieldType.UNSIGNED_INTEGER, true, null, null),
050                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
051                ));
052    }
053    
054    /** Creates a new instance of GetForumMessageAttachmentDescriptionCommand */
055    public GetForumMessageAttachmentDescriptionCommand(UserVisitPK userVisitPK, GetForumMessageAttachmentDescriptionForm form) {
056        super(userVisitPK, form, null, FORM_FIELD_DEFINITIONS, false);
057    }
058    
059    @Override
060    protected BaseResult execute() {
061        var forumControl = Session.getModelController(ForumControl.class);
062        GetForumMessageAttachmentDescriptionResult result = ForumResultFactory.getGetForumMessageAttachmentDescriptionResult();
063        String forumMessageName = form.getForumMessageName();
064        ForumMessage forumMessage = forumControl.getForumMessageByNameForUpdate(forumMessageName);
065
066        if(forumMessage != null) {
067            if(ForumLogic.getInstance().isForumRoleTypePermitted(this, forumMessage, getParty(), ForumConstants.ForumRoleType_READER)) {
068                Integer forumMessageAttachmentSequence = Integer.valueOf(form.getForumMessageAttachmentSequence());
069                ForumMessageAttachment forumMessageAttachment = forumControl.getForumMessageAttachmentBySequence(forumMessage, forumMessageAttachmentSequence);
070
071                if(forumMessageAttachment != null) {
072                    var partyControl = Session.getModelController(PartyControl.class);
073                    String languageIsoName = form.getLanguageIsoName();
074                    Language language = partyControl.getLanguageByIsoName(languageIsoName);
075
076                    if(language != null) {
077                        ForumMessageAttachmentDescription forumMessageAttachmentDescription = forumControl.getForumMessageAttachmentDescription(forumMessageAttachment, language);
078
079                        if(forumMessageAttachmentDescription != null) {
080                            result.setForumMessageAttachmentDescription(forumControl.getForumMessageAttachmentDescriptionTransfer(getUserVisit(), forumMessageAttachmentDescription));
081                        } else {
082                            addExecutionError(ExecutionErrors.UnknownForumMessageAttachmentDescription.name(), forumMessageName,
083                                    forumMessageAttachmentSequence.toString(), languageIsoName);
084                        }
085                    } else {
086                        addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
087                    }
088                } else {
089                    addExecutionError(ExecutionErrors.UnknownForumMessageAttachment.name(), forumMessageName, forumMessageAttachmentSequence.toString());
090                }
091            } else {
092                addExecutionError(ExecutionErrors.MissingRequiredForumRoleType.name(), ForumConstants.ForumRoleType_READER);
093            }
094        } else {
095            addExecutionError(ExecutionErrors.UnknownForumMessageName.name(), forumMessageName);
096        }
097
098        return result;
099    }
100    
101}