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.GetForumForm;
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.data.forum.server.entity.Forum;
029import com.echothree.util.common.command.BaseResult;
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.server.control.BaseSimpleCommand;
034import java.util.List;
035import javax.enterprise.context.Dependent;
036import javax.inject.Inject;
037
038@Dependent
039public class GetForumCommand
040        extends BaseSimpleCommand<GetForumForm> {
041    
042    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
043    
044    static {
045        FORM_FIELD_DEFINITIONS = List.of(
046                new FieldDefinition("ForumName", FieldType.ENTITY_NAME, false, null, null),
047                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
048                new FieldDefinition("Uuid", FieldType.UUID, false, null, null)
049        );
050    }
051
052    @Inject
053    ForumControl forumControl;
054
055    @Inject
056    EntityInstanceLogic entityInstanceLogic;
057
058    @Inject
059    ForumRoleTypeLogic forumRoleTypeLogic;
060
061    
062    /** Creates a new instance of GetForumCommand */
063    public GetForumCommand() {
064        super(null, FORM_FIELD_DEFINITIONS, true);
065    }
066    
067    @Override
068    protected BaseResult execute() {
069        var result = ForumResultFactory.getGetForumResult();
070        var forumName = form.getForumName();
071        var parameterCount = (forumName == null ? 0 : 1) + entityInstanceLogic.countPossibleEntitySpecs(form);
072
073        if(parameterCount == 1) {
074            Forum forum = null;
075
076            if(forumName == null) {
077                var entityInstance = entityInstanceLogic.getEntityInstance(this, form, ComponentVendors.ECHO_THREE.name(),
078                        EntityTypes.Forum.name());
079                
080                if(!hasExecutionErrors()) {
081                    forum = forumControl.getForumByEntityInstance(entityInstance);
082                }
083            } else {
084                forum = forumControl.getForumByName(forumName);
085
086                if(forum == null) {
087                    addExecutionError(ExecutionErrors.UnknownForumName.name(), forumName);
088                }
089            }
090
091            // If the UUID for the Forum is specified, then bypass the ForumRoleType check.
092            if(!hasExecutionErrors()) {
093                if(form.getUuid() != null || forumRoleTypeLogic.isForumRoleTypePermitted(this, forum, getParty(), ForumConstants.ForumRoleType_READER)) {
094                    result.setForum(forumControl.getForumTransfer(getUserVisit(), forum));
095                    sendEvent(forum.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
096                }
097            } else {
098                addExecutionError(ExecutionErrors.MissingRequiredForumRoleType.name(), ForumConstants.ForumRoleType_READER);
099            }
100        } else {
101            addExecutionError(ExecutionErrors.InvalidParameterCount.name());
102        }
103
104        return result;
105    }
106    
107}