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.GetForumsForm;
020import com.echothree.control.user.forum.common.result.ForumResultFactory;
021import com.echothree.control.user.forum.common.result.GetForumsResult;
022import com.echothree.model.control.forum.server.control.ForumControl;
023import com.echothree.model.data.forum.server.entity.Forum;
024import com.echothree.model.data.forum.server.entity.ForumGroup;
025import com.echothree.model.data.forum.server.entity.ForumGroupForum;
026import com.echothree.model.data.forum.server.factory.ForumFactory;
027import com.echothree.model.data.forum.server.factory.ForumGroupForumFactory;
028import com.echothree.model.data.user.common.pk.UserVisitPK;
029import com.echothree.model.data.user.server.entity.UserVisit;
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.ArrayList;
037import java.util.Arrays;
038import java.util.Collections;
039import java.util.List;
040
041public class GetForumsCommand
042        extends BaseSimpleCommand<GetForumsForm> {
043    
044    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
045    
046    static {
047        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
048            new FieldDefinition("ForumGroupName", FieldType.ENTITY_NAME, false, null, null)
049        ));
050    }
051    
052    /** Creates a new instance of GetForumsCommand */
053    public GetForumsCommand(UserVisitPK userVisitPK, GetForumsForm form) {
054        super(userVisitPK, form, null, FORM_FIELD_DEFINITIONS, true);
055    }
056    
057    @Override
058    protected BaseResult execute() {
059        var forumControl = Session.getModelController(ForumControl.class);
060        GetForumsResult result = ForumResultFactory.getGetForumsResult();
061        String forumGroupName = form.getForumGroupName();
062        ForumGroup forumGroup = forumControl.getForumGroupByName(forumGroupName);
063        
064        if(forumGroupName == null || forumGroup != null) {
065            UserVisit userVisit = getUserVisit();
066            
067            if(forumGroup == null) {
068                if(session.hasLimit(ForumFactory.class)) {
069                    result.setForumCount(forumControl.countForums());
070                }
071
072                result.setForums(forumControl.getForumTransfers(userVisit));
073            } else {
074                List<ForumGroupForum> forumGroupForums = forumControl.getForumGroupForumsByForumGroup(forumGroup);
075                List<Forum> forums = new ArrayList<>(forumGroupForums.size());
076                
077                forumGroupForums.forEach((forumGroupForum) -> {
078                    forums.add(forumGroupForum.getForum());
079                });
080                
081                if(session.hasLimit(ForumGroupForumFactory.class)) {
082                    result.setForumCount(forumControl.countForumGroupForumsByForumGroup(forumGroup));
083                }
084
085                result.setForumGroup(forumControl.getForumGroupTransfer(userVisit, forumGroup));
086                result.setForums(forumControl.getForumTransfers(userVisit, forums));
087            }
088        } else {
089            addExecutionError(ExecutionErrors.UnknownForumGroupName.name(), forumGroupName);
090        }
091        
092        return result;
093    }
094    
095}