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