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.GetForumMessagesForm;
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.server.logic.EntityInstanceLogic;
024import com.echothree.model.control.forum.common.ForumConstants;
025import com.echothree.model.control.forum.server.control.ForumControl;
026import com.echothree.model.control.forum.server.logic.ForumLogic;
027import com.echothree.model.control.party.common.PartyTypes;
028import com.echothree.model.data.forum.server.entity.ForumThread;
029import com.echothree.model.data.user.common.pk.UserVisitPK;
030import com.echothree.util.common.message.ExecutionErrors;
031import com.echothree.util.common.validation.FieldDefinition;
032import com.echothree.util.common.validation.FieldType;
033import com.echothree.util.common.command.BaseResult;
034import com.echothree.util.server.control.BaseSimpleCommand;
035import com.echothree.util.server.persistence.Session;
036import java.util.Arrays;
037import java.util.Collections;
038import java.util.List;
039import javax.enterprise.context.RequestScoped;
040
041@RequestScoped
042public class GetForumMessagesCommand
043        extends BaseSimpleCommand<GetForumMessagesForm> {
044    
045    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
046    
047    static {
048        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
049                new FieldDefinition("ForumThreadName", FieldType.ENTITY_NAME, false, null, null),
050                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
051                new FieldDefinition("Uuid", FieldType.UUID, false, null, null)
052                ));
053    }
054    
055    /** Creates a new instance of GetForumMessagesCommand */
056    public GetForumMessagesCommand() {
057        super(null, FORM_FIELD_DEFINITIONS, true);
058    }
059    
060    @Override
061    protected BaseResult execute() {
062        var result = ForumResultFactory.getGetForumMessagesResult();
063        var forumThreadName = form.getForumThreadName();
064        var parameterCount = (forumThreadName == null ? 0 : 1) + EntityInstanceLogic.getInstance().countPossibleEntitySpecs(form);
065
066        if(parameterCount == 1) {
067            var forumControl = Session.getModelController(ForumControl.class);
068            ForumThread forumThread = null;
069
070            if(forumThreadName == null) {
071                var entityInstance = EntityInstanceLogic.getInstance().getEntityInstance(this, form, ComponentVendors.ECHO_THREE.name(),
072                        EntityTypes.ForumThread.name());
073                
074                if(!hasExecutionErrors()) {
075                    forumThread = forumControl.getForumThreadByEntityInstance(entityInstance);
076                }
077            } else {
078                forumThread = forumControl.getForumThreadByName(forumThreadName);
079
080                if(forumThread == null) {
081                    addExecutionError(ExecutionErrors.UnknownForumThreadName.name(), forumThreadName);
082                }
083            }
084
085            if(!hasExecutionErrors()) {
086                if(forumThread.getLastDetail().getPostedTime() <= session.START_TIME
087                        || (getParty() == null ? false : getPartyTypeName().equals(PartyTypes.EMPLOYEE.name()))) {
088                    if(form.getUuid() != null || ForumLogic.getInstance().isForumRoleTypePermitted(this, forumThread, getParty(), ForumConstants.ForumRoleType_READER)) {
089                        result.setForumMessages(forumControl.getForumMessageTransfersByForumThread(getUserVisit(), forumThread));
090                    }
091                } else {
092                    addExecutionError(ExecutionErrors.UnpublishedForumThread.name(), forumThread.getLastDetail().getForumThreadName());
093                }
094            }
095        } else {
096            addExecutionError(ExecutionErrors.InvalidParameterCount.name());
097        }
098        
099        return result;
100    }
101    
102}