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.edit.ForumEdit;
020import com.echothree.control.user.forum.common.edit.ForumEditFactory;
021import com.echothree.control.user.forum.common.form.EditForumForm;
022import com.echothree.control.user.forum.common.result.EditForumResult;
023import com.echothree.control.user.forum.common.result.ForumResultFactory;
024import com.echothree.control.user.forum.common.spec.ForumSpec;
025import com.echothree.model.control.forum.server.control.ForumControl;
026import com.echothree.model.control.icon.server.control.IconControl;
027import com.echothree.model.control.sequence.common.SequenceTypes;
028import com.echothree.model.control.sequence.server.control.SequenceControl;
029import com.echothree.model.data.forum.server.entity.Forum;
030import com.echothree.model.data.icon.server.entity.Icon;
031import com.echothree.model.data.sequence.server.entity.Sequence;
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.EditMode;
037import com.echothree.util.server.control.BaseAbstractEditCommand;
038import java.util.List;
039import javax.enterprise.context.Dependent;
040import javax.inject.Inject;
041
042@Dependent
043public class EditForumCommand
044        extends BaseAbstractEditCommand<ForumSpec, ForumEdit, EditForumResult, Forum, Forum> {
045    
046    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
047    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
048    
049    static {
050        SPEC_FIELD_DEFINITIONS = List.of(
051                new FieldDefinition("ForumName", FieldType.ENTITY_NAME, true, null, null)
052        );
053        
054        EDIT_FIELD_DEFINITIONS = List.of(
055                new FieldDefinition("ForumName", FieldType.ENTITY_NAME, true, null, null),
056                new FieldDefinition("IconName", FieldType.ENTITY_NAME, false, null, null),
057                new FieldDefinition("ForumThreadSequenceName", FieldType.ENTITY_NAME, false, null, null),
058                new FieldDefinition("ForumMessageSequenceName", FieldType.ENTITY_NAME, false, null, null),
059                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
060                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
061        );
062    }
063
064    @Inject
065    ForumControl forumControl;
066
067    @Inject
068    IconControl iconControl;
069
070    @Inject
071    SequenceControl sequenceControl;
072
073    
074    /** Creates a new instance of EditForumCommand */
075    public EditForumCommand() {
076        super(null, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
077    }
078    
079    @Override
080    public EditForumResult getResult() {
081        return ForumResultFactory.getEditForumResult();
082    }
083
084    @Override
085    public ForumEdit getEdit() {
086        return ForumEditFactory.getForumEdit();
087    }
088
089    @Override
090    public Forum getEntity(EditForumResult result) {
091        Forum forum;
092        var forumName = spec.getForumName();
093
094        if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
095            forum = forumControl.getForumByName(forumName);
096        } else { // EditMode.UPDATE
097            forum = forumControl.getForumByNameForUpdate(forumName);
098        }
099
100        if(forum == null) {
101            addExecutionError(ExecutionErrors.UnknownForumName.name(), forumName);
102        }
103
104        return forum;
105    }
106
107    @Override
108    public Forum getLockEntity(Forum forum) {
109        return forum;
110    }
111
112    @Override
113    public void fillInResult(EditForumResult result, Forum forum) {
114        result.setForum(forumControl.getForumTransfer(getUserVisit(), forum));
115    }
116
117    @Override
118    public void doLock(ForumEdit edit, Forum forum) {
119        var forumDescription = forumControl.getForumDescription(forum, getPreferredLanguage());
120        var forumDetail = forum.getLastDetail();
121
122        icon = forumDetail.getIcon();
123        forumMessageSequence = forumDetail.getForumMessageSequence();
124        forumThreadSequence = forumDetail.getForumThreadSequence();
125
126        edit.setForumName(forumDetail.getForumName());
127        edit.setIconName(icon == null? null: icon.getLastDetail().getIconName());
128        edit.setForumThreadSequenceName(forumThreadSequence == null? null: forumThreadSequence.getLastDetail().getSequenceName());
129        edit.setForumMessageSequenceName(forumMessageSequence == null? null: forumMessageSequence.getLastDetail().getSequenceName());
130        edit.setSortOrder(forumDetail.getSortOrder().toString());
131
132        if(forumDescription != null) {
133            edit.setDescription(forumDescription.getDescription());
134        }
135    }
136
137    Icon icon = null;
138    Sequence forumThreadSequence = null;
139    Sequence forumMessageSequence = null;
140
141    @Override
142    public void canUpdate(Forum forum) {
143        var forumName = edit.getForumName();
144        var duplicateForum = forumControl.getForumByName(forumName);
145
146        if(duplicateForum == null || forum.equals(duplicateForum)) {
147            var iconName = edit.getIconName();
148
149            icon = iconName == null? null: iconControl.getIconByName(iconName);
150
151            if(iconName == null || icon != null) {
152                SequenceControl sequenceControl = null;
153                var forumThreadSequenceName = edit.getForumThreadSequenceName();
154                var forumMessageSequenceName = edit.getForumMessageSequenceName();
155
156                if(forumThreadSequenceName != null || forumMessageSequenceName != null) {
157                    sequenceControl = this.sequenceControl;
158
159                    if(forumThreadSequenceName != null) {
160                        var sequenceType = sequenceControl.getSequenceTypeByName(SequenceTypes.FORUM_THREAD.name());
161                        forumThreadSequence = sequenceControl.getSequenceByName(sequenceType, forumThreadSequenceName);
162                    }
163                }
164
165                if(forumThreadSequenceName == null || forumThreadSequence != null) {
166
167                    if(forumMessageSequenceName != null) {
168                        var sequenceType = sequenceControl.getSequenceTypeByName(SequenceTypes.FORUM_MESSAGE.name());
169                        forumMessageSequence = sequenceControl.getSequenceByName(sequenceType, forumMessageSequenceName);
170                    }
171
172                    if(forumMessageSequenceName != null && forumMessageSequence == null) {
173                        addExecutionError(ExecutionErrors.UnknownForumMessageSequenceName.name(), forumMessageSequenceName);
174                    }
175                } else {
176                    addExecutionError(ExecutionErrors.UnknownForumThreadSequenceName.name(), forumThreadSequenceName);
177                }
178            } else {
179                addExecutionError(ExecutionErrors.UnknownIconName.name(), iconName);
180            }
181        } else {
182            addExecutionError(ExecutionErrors.DuplicateForumName.name(), forumName);
183        }
184    }
185
186    @Override
187    public void doUpdate(Forum forum) {
188        var partyPK = getPartyPK();
189        var forumDetailValue = forumControl.getForumDetailValueForUpdate(forum);
190        var forumDescription = forumControl.getForumDescriptionForUpdate(forum, getPreferredLanguage());
191        var description = edit.getDescription();
192
193        forumDetailValue.setForumName(edit.getForumName());
194        forumDetailValue.setIconPK(icon == null? null: icon.getPrimaryKey());
195        forumDetailValue.setForumThreadSequencePK(forumThreadSequence == null? null: forumThreadSequence.getPrimaryKey());
196        forumDetailValue.setForumMessageSequencePK(forumMessageSequence == null? null: forumMessageSequence.getPrimaryKey());
197        forumDetailValue.setSortOrder(Integer.valueOf(edit.getSortOrder()));
198
199        forumControl.updateForumFromValue(forumDetailValue, partyPK);
200
201        if(forumDescription == null && description != null) {
202            forumControl.createForumDescription(forum, getPreferredLanguage(), description, partyPK);
203        } else if(forumDescription != null && description == null) {
204            forumControl.deleteForumDescription(forumDescription, partyPK);
205        } else if(forumDescription != null && description != null) {
206            var forumDescriptionValue = forumControl.getForumDescriptionValue(forumDescription);
207
208            forumDescriptionValue.setDescription(description);
209            forumControl.updateForumDescriptionFromValue(forumDescriptionValue, partyPK);
210        }
211    }
212    
213}