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.GetForumMessageForm;
020import com.echothree.control.user.forum.common.result.ForumResultFactory;
021import com.echothree.control.user.forum.common.result.GetForumMessageResult;
022import com.echothree.model.control.core.common.ComponentVendors;
023import com.echothree.model.control.core.common.EntityTypes;
024import com.echothree.model.control.core.common.EventTypes;
025import com.echothree.model.control.core.server.logic.EntityInstanceLogic;
026import com.echothree.model.control.forum.common.ForumConstants;
027import com.echothree.model.control.forum.server.control.ForumControl;
028import com.echothree.model.control.forum.server.logic.ForumLogic;
029import com.echothree.model.control.party.common.PartyTypes;
030import com.echothree.model.data.core.server.entity.EntityInstance;
031import com.echothree.model.data.forum.server.entity.ForumMessage;
032import com.echothree.model.data.user.common.pk.UserVisitPK;
033import com.echothree.util.common.message.ExecutionErrors;
034import com.echothree.util.common.validation.FieldDefinition;
035import com.echothree.util.common.validation.FieldType;
036import com.echothree.util.common.command.BaseResult;
037import com.echothree.util.server.control.BaseSimpleCommand;
038import com.echothree.util.server.persistence.Session;
039import java.util.Arrays;
040import java.util.Collections;
041import java.util.List;
042
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("Key", FieldType.KEY, false, null, null),
053                new FieldDefinition("Guid", FieldType.GUID, false, null, null),
054                new FieldDefinition("Ulid", FieldType.ULID, false, null, null)
055                ));
056    }
057    
058    /** Creates a new instance of GetForumMessageCommand */
059    public GetForumMessageCommand(UserVisitPK userVisitPK, GetForumMessageForm form) {
060        super(userVisitPK, form, null, FORM_FIELD_DEFINITIONS, true);
061    }
062    
063    @Override
064    protected BaseResult execute() {
065        GetForumMessageResult result = ForumResultFactory.getGetForumMessageResult();
066        String forumMessageName = form.getForumMessageName();
067        var parameterCount = (forumMessageName == null ? 0 : 1) + EntityInstanceLogic.getInstance().countPossibleEntitySpecs(form);
068
069        if(parameterCount == 1) {
070            var forumControl = Session.getModelController(ForumControl.class);
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.START_TIME
090                        || (getParty() == null ? false : getPartyTypeName().equals(PartyTypes.EMPLOYEE.name()))) {
091                    if(form.getKey() != null || ForumLogic.getInstance().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}