001// --------------------------------------------------------------------------------
002// Copyright 2002-2025 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.edit.ForumEditFactory;
020import com.echothree.control.user.forum.common.edit.ForumGroupEdit;
021import com.echothree.control.user.forum.common.form.EditForumGroupForm;
022import com.echothree.control.user.forum.common.result.EditForumGroupResult;
023import com.echothree.control.user.forum.common.result.ForumResultFactory;
024import com.echothree.control.user.forum.common.spec.ForumGroupSpec;
025import com.echothree.model.control.forum.server.control.ForumControl;
026import com.echothree.model.control.icon.server.control.IconControl;
027import com.echothree.model.data.forum.server.entity.ForumGroup;
028import com.echothree.model.data.icon.server.entity.Icon;
029import com.echothree.model.data.user.common.pk.UserVisitPK;
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.EditMode;
034import com.echothree.util.server.control.BaseAbstractEditCommand;
035import com.echothree.util.server.persistence.Session;
036import java.util.Arrays;
037import java.util.Collections;
038import java.util.List;
039import javax.enterprise.context.RequestScoped;
040
041@RequestScoped
042public class EditForumGroupCommand
043        extends BaseAbstractEditCommand<ForumGroupSpec, ForumGroupEdit, EditForumGroupResult, ForumGroup, ForumGroup> {
044    
045    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
046    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
047    
048    static {
049        SPEC_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
050                new FieldDefinition("ForumGroupName", FieldType.ENTITY_NAME, true, null, null)
051                ));
052        
053        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
054                new FieldDefinition("ForumGroupName", FieldType.ENTITY_NAME, true, null, null),
055                new FieldDefinition("IconName", FieldType.ENTITY_NAME, false, null, null),
056                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
057                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
058                ));
059    }
060    
061    /** Creates a new instance of EditForumGroupCommand */
062    public EditForumGroupCommand() {
063        super(null, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
064    }
065    
066    @Override
067    public EditForumGroupResult getResult() {
068        return ForumResultFactory.getEditForumGroupResult();
069    }
070
071    @Override
072    public ForumGroupEdit getEdit() {
073        return ForumEditFactory.getForumGroupEdit();
074    }
075
076    @Override
077    public ForumGroup getEntity(EditForumGroupResult result) {
078        var forumControl = Session.getModelController(ForumControl.class);
079        ForumGroup forumGroup;
080        var forumGroupName = spec.getForumGroupName();
081
082        if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
083            forumGroup = forumControl.getForumGroupByName(forumGroupName);
084        } else { // EditMode.UPDATE
085            forumGroup = forumControl.getForumGroupByNameForUpdate(forumGroupName);
086        }
087
088        if(forumGroup == null) {
089            addExecutionError(ExecutionErrors.UnknownForumGroupName.name(), forumGroupName);
090        }
091
092        return forumGroup;
093    }
094
095    @Override
096    public ForumGroup getLockEntity(ForumGroup forumGroup) {
097        return forumGroup;
098    }
099
100    @Override
101    public void fillInResult(EditForumGroupResult result, ForumGroup forumGroup) {
102        var forumControl = Session.getModelController(ForumControl.class);
103
104        result.setForumGroup(forumControl.getForumGroupTransfer(getUserVisit(), forumGroup));
105    }
106
107    @Override
108    public void doLock(ForumGroupEdit edit, ForumGroup forumGroup) {
109        var forumControl = Session.getModelController(ForumControl.class);
110        var forumGroupDescription = forumControl.getForumGroupDescription(forumGroup, getPreferredLanguage());
111        var forumGroupDetail = forumGroup.getLastDetail();
112
113        icon = forumGroupDetail.getIcon();
114
115        edit.setForumGroupName(forumGroupDetail.getForumGroupName());
116        edit.setIconName(icon == null? null: icon.getLastDetail().getIconName());
117        edit.setSortOrder(forumGroupDetail.getSortOrder().toString());
118
119        if(forumGroupDescription != null) {
120            edit.setDescription(forumGroupDescription.getDescription());
121        }
122    }
123
124    Icon icon = null;
125
126    @Override
127    public void canUpdate(ForumGroup forumGroup) {
128        var forumControl = Session.getModelController(ForumControl.class);
129        var forumGroupName = edit.getForumGroupName();
130        var duplicateForumGroup = forumControl.getForumGroupByName(forumGroupName);
131
132        if(duplicateForumGroup == null || forumGroup.equals(duplicateForumGroup)) {
133            var iconControl = Session.getModelController(IconControl.class);
134            var iconName = edit.getIconName();
135
136            icon = iconName == null? null: iconControl.getIconByName(iconName);
137
138            if(iconName != null && icon == null) {
139                addExecutionError(ExecutionErrors.UnknownIconName.name(), iconName);
140            }
141        } else {
142            addExecutionError(ExecutionErrors.DuplicateForumGroupName.name(), forumGroupName);
143        }
144    }
145
146    @Override
147    public void doUpdate(ForumGroup forumGroup) {
148        var forumControl = Session.getModelController(ForumControl.class);
149        var partyPK = getPartyPK();
150        var forumGroupDetailValue = forumControl.getForumGroupDetailValueForUpdate(forumGroup);
151        var forumGroupDescription = forumControl.getForumGroupDescriptionForUpdate(forumGroup, getPreferredLanguage());
152        var description = edit.getDescription();
153
154        forumGroupDetailValue.setForumGroupName(edit.getForumGroupName());
155        forumGroupDetailValue.setIconPK(icon == null? null: icon.getPrimaryKey());
156        forumGroupDetailValue.setSortOrder(Integer.valueOf(edit.getSortOrder()));
157
158        forumControl.updateForumGroupFromValue(forumGroupDetailValue, partyPK);
159
160        if(forumGroupDescription == null && description != null) {
161            forumControl.createForumGroupDescription(forumGroup, getPreferredLanguage(), description, partyPK);
162        } else if(forumGroupDescription != null && description == null) {
163            forumControl.deleteForumGroupDescription(forumGroupDescription, partyPK);
164        } else if(forumGroupDescription != null && description != null) {
165            var forumGroupDescriptionValue = forumControl.getForumGroupDescriptionValue(forumGroupDescription);
166
167            forumGroupDescriptionValue.setDescription(description);
168            forumControl.updateForumGroupDescriptionFromValue(forumGroupDescriptionValue, partyPK);
169        }
170    }
171
172}