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