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