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.CreateForumGroupForm;
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.data.user.common.pk.UserVisitPK;
024import com.echothree.util.common.message.ExecutionErrors;
025import com.echothree.util.common.validation.FieldDefinition;
026import com.echothree.util.common.validation.FieldType;
027import com.echothree.util.common.command.BaseResult;
028import com.echothree.util.server.control.BaseSimpleCommand;
029import com.echothree.util.server.persistence.Session;
030import java.util.List;
031import javax.enterprise.context.Dependent;
032
033@Dependent
034public class CreateForumGroupCommand
035        extends BaseSimpleCommand<CreateForumGroupForm> {
036    
037    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
038    
039    static {
040        FORM_FIELD_DEFINITIONS = List.of(
041                new FieldDefinition("ForumGroupName", FieldType.ENTITY_NAME, true, null, null),
042                new FieldDefinition("IconName", FieldType.ENTITY_NAME, false, null, null),
043                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
044                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
045                );
046    }
047    
048    /** Creates a new instance of CreateForumGroupCommand */
049    public CreateForumGroupCommand() {
050        super(null, FORM_FIELD_DEFINITIONS, false);
051    }
052    
053    @Override
054    protected BaseResult execute() {
055        var forumControl = Session.getModelController(ForumControl.class);
056        var forumGroupName = form.getForumGroupName();
057        var forumGroup = forumControl.getForumGroupByName(forumGroupName);
058        
059        if(forumGroup == null) {
060            var iconControl = Session.getModelController(IconControl.class);
061            var iconName = form.getIconName();
062            var icon = iconName == null? null: iconControl.getIconByName(iconName);
063            
064            if(iconName == null || icon != null) {
065                if(icon != null) {
066                    var iconUsageType = iconControl.getIconUsageTypeByName(IconConstants.IconUsageType_FORUM_GROUP);
067                    var iconUsage = iconControl.getIconUsage(iconUsageType, icon);
068                    
069                    if(iconUsage == null) {
070                        addExecutionError(ExecutionErrors.UnknownIconUsage.name());
071                    }
072                }
073                
074                if(!hasExecutionErrors()) {
075                    var partyPK = getPartyPK();
076                    var sortOrder = Integer.valueOf(form.getSortOrder());
077                    var description = form.getDescription();
078                    
079                    forumGroup = forumControl.createForumGroup(forumGroupName, icon, sortOrder, partyPK);
080                    
081                    if(description != null) {
082                        forumControl.createForumGroupDescription(forumGroup, getPreferredLanguage(), description, partyPK);
083                    }
084                }
085            } else {
086                addExecutionError(ExecutionErrors.UnknownIconName.name(), iconName);
087            }
088        } else {
089            addExecutionError(ExecutionErrors.DuplicateForumGroupName.name(), forumGroupName);
090        }
091        
092        return null;
093    }
094    
095}