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