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