001// --------------------------------------------------------------------------------
002// Copyright 2002-2025 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.GetForumMessageForm;
020import com.echothree.control.user.forum.common.result.ForumResultFactory;
021import com.echothree.model.control.core.common.ComponentVendors;
022import com.echothree.model.control.core.common.EntityTypes;
023import com.echothree.model.control.core.common.EventTypes;
024import com.echothree.model.control.core.server.logic.EntityInstanceLogic;
025import com.echothree.model.control.forum.common.ForumConstants;
026import com.echothree.model.control.forum.server.control.ForumControl;
027import com.echothree.model.control.forum.server.logic.ForumLogic;
028import com.echothree.model.control.party.common.PartyTypes;
029import com.echothree.model.data.forum.server.entity.ForumMessage;
030import com.echothree.model.data.user.common.pk.UserVisitPK;
031import com.echothree.util.common.command.BaseResult;
032import com.echothree.util.common.message.ExecutionErrors;
033import com.echothree.util.common.validation.FieldDefinition;
034import com.echothree.util.common.validation.FieldType;
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;
040import javax.enterprise.context.RequestScoped;
041
042@RequestScoped
043public class GetForumMessageCommand
044        extends BaseSimpleCommand<GetForumMessageForm> {
045    
046    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
047    
048    static {
049        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
050                new FieldDefinition("ForumMessageName", FieldType.ENTITY_NAME, false, null, null),
051                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
052                new FieldDefinition("Uuid", FieldType.UUID, false, null, null)
053                ));
054    }
055    
056    /** Creates a new instance of GetForumMessageCommand */
057    public GetForumMessageCommand() {
058        super(null, FORM_FIELD_DEFINITIONS, true);
059    }
060    
061    @Override
062    protected BaseResult execute() {
063        var result = ForumResultFactory.getGetForumMessageResult();
064        var forumMessageName = form.getForumMessageName();
065        var parameterCount = (forumMessageName == null ? 0 : 1) + EntityInstanceLogic.getInstance().countPossibleEntitySpecs(form);
066
067        if(parameterCount == 1) {
068            var forumControl = Session.getModelController(ForumControl.class);
069            ForumMessage forumMessage = null;
070
071            if(forumMessageName == null) {
072                var entityInstance = EntityInstanceLogic.getInstance().getEntityInstance(this, form, ComponentVendors.ECHO_THREE.name(),
073                        EntityTypes.ForumMessage.name());
074                
075                if(!hasExecutionErrors()) {
076                    forumMessage = forumControl.getForumMessageByEntityInstance(entityInstance);
077                }
078            } else {
079                forumMessage = forumControl.getForumMessageByName(forumMessageName);
080
081                if(forumMessage == null) {
082                    addExecutionError(ExecutionErrors.UnknownForumMessageName.name(), forumMessageName);
083                }
084            }
085            
086            if(!hasExecutionErrors()) {
087                if(forumMessage.getLastDetail().getPostedTime() <= session.START_TIME
088                        || (getParty() == null ? false : getPartyTypeName().equals(PartyTypes.EMPLOYEE.name()))) {
089                    if(form.getUuid() != null || ForumLogic.getInstance().isForumRoleTypePermitted(this, forumMessage, getParty(), ForumConstants.ForumRoleType_READER)) {
090                        result.setForumMessage(forumControl.getForumMessageTransfer(getUserVisit(), forumMessage));
091                        sendEvent(forumMessage.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
092                    } else {
093                        addExecutionError(ExecutionErrors.MissingRequiredForumRoleType.name(), ForumConstants.ForumRoleType_READER);
094                    }
095                } else {
096                    addExecutionError(ExecutionErrors.UnpublishedForumMessage.name(), forumMessage.getLastDetail().getForumMessageName());
097                }
098            }
099        } else {
100            addExecutionError(ExecutionErrors.InvalidParameterCount.name());
101        }
102        
103        return result;
104    }
105    
106}