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