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.CreateForumForm;
020import com.echothree.model.control.forum.server.control.ForumControl;
021import com.echothree.model.control.icon.common.IconConstants;
022import com.echothree.model.control.icon.server.control.IconControl;
023import com.echothree.model.control.sequence.common.SequenceTypes;
024import com.echothree.model.control.sequence.server.control.SequenceControl;
025import com.echothree.model.data.sequence.server.entity.Sequence;
026import com.echothree.model.data.user.common.pk.UserVisitPK;
027import com.echothree.util.common.message.ExecutionErrors;
028import com.echothree.util.common.validation.FieldDefinition;
029import com.echothree.util.common.validation.FieldType;
030import com.echothree.util.common.command.BaseResult;
031import com.echothree.util.server.control.BaseSimpleCommand;
032import com.echothree.util.server.persistence.Session;
033import java.util.List;
034import javax.enterprise.context.Dependent;
035
036@Dependent
037public class CreateForumCommand
038        extends BaseSimpleCommand<CreateForumForm> {
039    
040    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
041    
042    static {
043        FORM_FIELD_DEFINITIONS = List.of(
044                new FieldDefinition("ForumName", FieldType.ENTITY_NAME, true, null, null),
045                new FieldDefinition("ForumTypeName", FieldType.ENTITY_NAME, true, null, null),
046                new FieldDefinition("IconName", FieldType.ENTITY_NAME, false, null, null),
047                new FieldDefinition("ForumThreadSequenceName", FieldType.ENTITY_NAME, false, null, null),
048                new FieldDefinition("ForumMessageSequenceName", FieldType.ENTITY_NAME, false, null, null),
049                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
050                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
051                );
052    }
053    
054    /** Creates a new instance of CreateForumCommand */
055    public CreateForumCommand() {
056        super(null, FORM_FIELD_DEFINITIONS, false);
057    }
058    
059    @Override
060    protected BaseResult execute() {
061        var forumControl = Session.getModelController(ForumControl.class);
062        var forumName = form.getForumName();
063        var forum = forumControl.getForumByName(forumName);
064        
065        if(forum == null) {
066            var forumTypeName = form.getForumTypeName();
067            var forumType = forumControl.getForumTypeByName(forumTypeName);
068            
069            if(forumType != null) {
070                var iconControl = Session.getModelController(IconControl.class);
071                var iconName = form.getIconName();
072                var icon = iconName == null? null: iconControl.getIconByName(iconName);
073                
074                if(iconName == null || icon != null) {
075                    if(icon != null) {
076                        var iconUsageType = iconControl.getIconUsageTypeByName(IconConstants.IconUsageType_FORUM);
077                        var iconUsage = iconControl.getIconUsage(iconUsageType, icon);
078                        
079                        if(iconUsage == null) {
080                            addExecutionError(ExecutionErrors.UnknownIconUsage.name());
081                        }
082                    }
083                    
084                    if(!hasExecutionErrors()) {
085                        SequenceControl sequenceControl = null;
086                        var forumThreadSequenceName = form.getForumThreadSequenceName();
087                        Sequence forumThreadSequence = null;
088                        var forumMessageSequenceName = form.getForumMessageSequenceName();
089                        
090                        if(forumThreadSequenceName != null || forumMessageSequenceName != null) {
091                            sequenceControl = Session.getModelController(SequenceControl.class);
092                            
093                            if(forumThreadSequenceName != null) {
094                                var sequenceType = sequenceControl.getSequenceTypeByName(SequenceTypes.FORUM_THREAD.name());
095                                forumThreadSequence = sequenceControl.getSequenceByName(sequenceType, forumThreadSequenceName);
096                            }
097                        }
098                        
099                        if(forumThreadSequenceName == null || forumThreadSequence != null) {
100                            Sequence forumMessageSequence = null;
101                            
102                            if(forumMessageSequenceName != null) {
103                                var sequenceType = sequenceControl.getSequenceTypeByName(SequenceTypes.FORUM_MESSAGE.name());
104                                forumMessageSequence = sequenceControl.getSequenceByName(sequenceType, forumMessageSequenceName);
105                            }
106                            
107                            if(forumMessageSequenceName == null || forumMessageSequence != null) {
108                                var partyPK = getPartyPK();
109                                var sortOrder = Integer.valueOf(form.getSortOrder());
110                                var description = form.getDescription();
111                                
112                                forum = forumControl.createForum(forumName, forumType, icon, forumThreadSequence, forumMessageSequence,
113                                        sortOrder, partyPK);
114                                
115                                if(description != null) {
116                                    forumControl.createForumDescription(forum, getPreferredLanguage(), description, partyPK);
117                                }
118                            } else {
119                                addExecutionError(ExecutionErrors.UnknownForumMessageSequenceName.name(), forumMessageSequenceName);
120                            }
121                        } else {
122                            addExecutionError(ExecutionErrors.UnknownForumThreadSequenceName.name(), forumThreadSequenceName);
123                        }
124                    }
125                } else {
126                    addExecutionError(ExecutionErrors.UnknownIconName.name(), iconName);
127                }
128            } else {
129                addExecutionError(ExecutionErrors.UnknownForumTypeName.name(), forumTypeName);
130            }
131        } else {
132            addExecutionError(ExecutionErrors.DuplicateForumName.name(), forumName);
133        }
134        
135        return null;
136    }
137    
138}