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.GetForumForm;
020import com.echothree.control.user.forum.common.result.ForumResultFactory;
021import com.echothree.control.user.forum.common.result.GetForumResult;
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.data.core.server.entity.EntityInstance;
030import com.echothree.model.data.forum.server.entity.Forum;
031import com.echothree.model.data.user.common.pk.UserVisitPK;
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.common.command.BaseResult;
036import com.echothree.util.server.control.BaseSimpleCommand;
037import com.echothree.util.server.persistence.Session;
038import java.util.Arrays;
039import java.util.Collections;
040import java.util.List;
041
042public class GetForumCommand
043        extends BaseSimpleCommand<GetForumForm> {
044    
045    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
046    
047    static {
048        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
049                new FieldDefinition("ForumName", FieldType.ENTITY_NAME, false, null, null),
050                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
051                new FieldDefinition("Key", FieldType.KEY, false, null, null),
052                new FieldDefinition("Guid", FieldType.GUID, false, null, null),
053                new FieldDefinition("Ulid", FieldType.ULID, false, null, null)
054                ));
055    }
056    
057    /** Creates a new instance of GetForumCommand */
058    public GetForumCommand(UserVisitPK userVisitPK, GetForumForm form) {
059        super(userVisitPK, form, null, FORM_FIELD_DEFINITIONS, true);
060    }
061    
062    @Override
063    protected BaseResult execute() {
064        GetForumResult result = ForumResultFactory.getGetForumResult();
065        String forumName = form.getForumName();
066        var parameterCount = (forumName == null ? 0 : 1) + EntityInstanceLogic.getInstance().countPossibleEntitySpecs(form);
067
068        if(parameterCount == 1) {
069            var forumControl = Session.getModelController(ForumControl.class);
070            Forum forum = null;
071
072            if(forumName == null) {
073                var entityInstance = EntityInstanceLogic.getInstance().getEntityInstance(this, form, ComponentVendors.ECHO_THREE.name(),
074                        EntityTypes.Forum.name());
075                
076                if(!hasExecutionErrors()) {
077                    forum = forumControl.getForumByEntityInstance(entityInstance);
078                }
079            } else {
080                forum = forumControl.getForumByName(forumName);
081
082                if(forum == null) {
083                    addExecutionError(ExecutionErrors.UnknownForumName.name(), forumName);
084                }
085            }
086
087            // If the Key for the Forum is specified, then bypass the ForumRoleType check.
088            if(!hasExecutionErrors()) {
089                if(form.getKey() != null || ForumLogic.getInstance().isForumRoleTypePermitted(this, forum, getParty(), ForumConstants.ForumRoleType_READER)) {
090                    result.setForum(forumControl.getForumTransfer(getUserVisit(), forum));
091                    sendEvent(forum.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
092                }
093            } else {
094                addExecutionError(ExecutionErrors.MissingRequiredForumRoleType.name(), ForumConstants.ForumRoleType_READER);
095            }
096        } else {
097            addExecutionError(ExecutionErrors.InvalidParameterCount.name());
098        }
099
100        return result;
101    }
102    
103}