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.training.server.command;
018
019import com.echothree.control.user.training.common.edit.TrainingClassPageEdit;
020import com.echothree.control.user.training.common.edit.TrainingEditFactory;
021import com.echothree.control.user.training.common.form.EditTrainingClassPageForm;
022import com.echothree.control.user.training.common.result.EditTrainingClassPageResult;
023import com.echothree.control.user.training.common.result.TrainingResultFactory;
024import com.echothree.control.user.training.common.spec.TrainingClassPageSpec;
025import com.echothree.model.control.core.common.MimeTypeUsageTypes;
026import com.echothree.model.control.core.server.logic.MimeTypeLogic;
027import com.echothree.model.control.party.common.PartyTypes;
028import com.echothree.model.control.security.common.SecurityRoleGroups;
029import com.echothree.model.control.security.common.SecurityRoles;
030import com.echothree.model.control.training.server.control.TrainingControl;
031import com.echothree.model.data.core.server.entity.MimeType;
032import com.echothree.model.data.training.server.entity.TrainingClassPage;
033import com.echothree.model.data.training.server.entity.TrainingClassSection;
034import com.echothree.model.data.user.common.pk.UserVisitPK;
035import com.echothree.util.common.message.ExecutionErrors;
036import com.echothree.util.common.validation.FieldDefinition;
037import com.echothree.util.common.validation.FieldType;
038import com.echothree.util.common.command.EditMode;
039import com.echothree.util.server.control.BaseAbstractEditCommand;
040import com.echothree.util.server.control.CommandSecurityDefinition;
041import com.echothree.util.server.control.PartyTypeDefinition;
042import com.echothree.util.server.control.SecurityRoleDefinition;
043import com.echothree.util.server.persistence.Session;
044import java.util.List;
045import javax.enterprise.context.Dependent;
046
047@Dependent
048public class EditTrainingClassPageCommand
049        extends BaseAbstractEditCommand<TrainingClassPageSpec, TrainingClassPageEdit, EditTrainingClassPageResult, TrainingClassPage, TrainingClassPage> {
050    
051    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
052    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
053    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
054    
055    static {
056        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
057                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
058                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
059                        new SecurityRoleDefinition(SecurityRoleGroups.TrainingClassPage.name(), SecurityRoles.Edit.name())
060                        ))
061                ));
062
063        SPEC_FIELD_DEFINITIONS = List.of(
064                new FieldDefinition("TrainingClassName", FieldType.ENTITY_NAME, true, null, null),
065                new FieldDefinition("TrainingClassSectionName", FieldType.ENTITY_NAME, true, null, null),
066                new FieldDefinition("TrainingClassPageName", FieldType.ENTITY_NAME, true, null, null)
067                );
068
069        EDIT_FIELD_DEFINITIONS = List.of(
070                new FieldDefinition("TrainingClassPageName", FieldType.ENTITY_NAME, true, null, null),
071                new FieldDefinition("PercentageToPass", FieldType.FRACTIONAL_PERCENT, false, null, null),
072                new FieldDefinition("QuestionCount", FieldType.UNSIGNED_INTEGER, false, null, null),
073                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
074                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L),
075                new FieldDefinition("PageMimeTypeName", FieldType.MIME_TYPE, false, null, null),
076                new FieldDefinition("Page", FieldType.STRING, false, null, null)
077                );
078    }
079    
080    /** Creates a new instance of EditTrainingClassPageCommand */
081    public EditTrainingClassPageCommand() {
082        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
083    }
084    
085    @Override
086    public EditTrainingClassPageResult getResult() {
087        return TrainingResultFactory.getEditTrainingClassPageResult();
088    }
089
090    @Override
091    public TrainingClassPageEdit getEdit() {
092        return TrainingEditFactory.getTrainingClassPageEdit();
093    }
094
095    TrainingClassSection trainingClassSection;
096    
097    @Override
098    public TrainingClassPage getEntity(EditTrainingClassPageResult result) {
099        var trainingControl = Session.getModelController(TrainingControl.class);
100        TrainingClassPage trainingClassPage = null;
101        var trainingClassName = spec.getTrainingClassName();
102        var trainingClass = trainingControl.getTrainingClassByName(trainingClassName);
103
104        if(trainingClass != null) {
105            var trainingClassSectionName = spec.getTrainingClassSectionName();
106            
107            trainingClassSection = trainingControl.getTrainingClassSectionByName(trainingClass, trainingClassSectionName);
108
109            if(trainingClassSection != null) {
110                var trainingClassPageName = spec.getTrainingClassPageName();
111
112                if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
113                    trainingClassPage = trainingControl.getTrainingClassPageByName(trainingClassSection, trainingClassPageName);
114                } else { // EditMode.UPDATE
115                    trainingClassPage = trainingControl.getTrainingClassPageByNameForUpdate(trainingClassSection, trainingClassPageName);
116                }
117
118                if(trainingClassPage != null) {
119                    result.setTrainingClassPage(trainingControl.getTrainingClassPageTransfer(getUserVisit(), trainingClassPage));
120                } else {
121                    addExecutionError(ExecutionErrors.UnknownTrainingClassPageName.name(), trainingClassName, trainingClassSectionName, trainingClassPageName);
122                }
123            } else {
124                addExecutionError(ExecutionErrors.UnknownTrainingClassSectionName.name(), trainingClassName, trainingClassSectionName);
125            }
126        } else {
127            addExecutionError(ExecutionErrors.UnknownTrainingClassName.name(), trainingClassName);
128        }
129
130        return trainingClassPage;
131    }
132
133    @Override
134    public TrainingClassPage getLockEntity(TrainingClassPage trainingClassPage) {
135        return trainingClassPage;
136    }
137
138    @Override
139    public void fillInResult(EditTrainingClassPageResult result, TrainingClassPage trainingClassPage) {
140        var trainingControl = Session.getModelController(TrainingControl.class);
141
142        result.setTrainingClassPage(trainingControl.getTrainingClassPageTransfer(getUserVisit(), trainingClassPage));
143    }
144
145    MimeType pageMimeType;
146    MimeType introductionMimeType;
147    
148    @Override
149    public void doLock(TrainingClassPageEdit edit, TrainingClassPage trainingClassPage) {
150        var trainingControl = Session.getModelController(TrainingControl.class);
151        var trainingClassPageTranslation = trainingControl.getTrainingClassPageTranslation(trainingClassPage, getPreferredLanguage());
152        var trainingClassPageDetail = trainingClassPage.getLastDetail();
153
154        edit.setTrainingClassPageName(trainingClassPageDetail.getTrainingClassPageName());
155        edit.setSortOrder(trainingClassPageDetail.getSortOrder().toString());
156
157        if(trainingClassPageTranslation != null) {
158            pageMimeType = trainingClassPageTranslation.getPageMimeType();
159
160            edit.setDescription(trainingClassPageTranslation.getDescription());
161            edit.setPageMimeTypeName(pageMimeType == null? null: pageMimeType.getLastDetail().getMimeTypeName());
162            edit.setPage(trainingClassPageTranslation.getPage());
163        }
164    }
165
166    @Override
167    public void canUpdate(TrainingClassPage trainingClassPage) {
168        var trainingControl = Session.getModelController(TrainingControl.class);
169        var trainingClassPageName = edit.getTrainingClassPageName();
170        var duplicateTrainingClassPage = trainingControl.getTrainingClassPageByName(trainingClassSection, trainingClassPageName);
171
172        if(duplicateTrainingClassPage != null && !trainingClassPage.equals(duplicateTrainingClassPage)) {
173            addExecutionError(ExecutionErrors.DuplicateTrainingClassPageName.name(), trainingClassPageName);
174        } else {
175            var mimeTypeLogic = MimeTypeLogic.getInstance();
176            var pageMimeTypeName = edit.getPageMimeTypeName();
177            var page = edit.getPage();
178
179            pageMimeType = mimeTypeLogic.checkMimeType(this, pageMimeTypeName, page, MimeTypeUsageTypes.TEXT.name(),
180                    ExecutionErrors.MissingRequiredPageMimeTypeName.name(), ExecutionErrors.MissingRequiredPage.name(),
181                    ExecutionErrors.UnknownPageMimeTypeName.name(), ExecutionErrors.UnknownPageMimeTypeUsage.name());
182        }
183    }
184    
185    @Override
186    public void doUpdate(TrainingClassPage trainingClassPage) {
187        var trainingControl = Session.getModelController(TrainingControl.class);
188        var partyPK = getPartyPK();
189        var trainingClassPageDetailValue = trainingControl.getTrainingClassPageDetailValueForUpdate(trainingClassPage);
190        var trainingClassPageTranslation = trainingControl.getTrainingClassPageTranslationForUpdate(trainingClassPage, getPreferredLanguage());
191        var description = edit.getDescription();
192        var page = edit.getPage();
193
194        trainingClassPageDetailValue.setTrainingClassPageName(edit.getTrainingClassPageName());
195        trainingClassPageDetailValue.setSortOrder(Integer.valueOf(edit.getSortOrder()));
196
197        trainingControl.updateTrainingClassPageFromValue(trainingClassPageDetailValue, partyPK);
198
199        if(trainingClassPageTranslation == null && (description != null || page != null)) {
200            trainingControl.createTrainingClassPageTranslation(trainingClassPage, getPreferredLanguage(), description, pageMimeType, page,
201                    partyPK);
202        } else if(trainingClassPageTranslation != null && (description == null && page == null)) {
203            trainingControl.deleteTrainingClassPageTranslation(trainingClassPageTranslation, partyPK);
204        } else if(trainingClassPageTranslation != null && (description != null || page != null)) {
205            var trainingClassPageTranslationValue = trainingControl.getTrainingClassPageTranslationValue(trainingClassPageTranslation);
206
207            trainingClassPageTranslationValue.setDescription(description);
208            trainingClassPageTranslationValue.setPageMimeTypePK(pageMimeType == null? null: pageMimeType.getPrimaryKey());
209            trainingClassPageTranslationValue.setPage(page);
210            trainingControl.updateTrainingClassPageTranslationFromValue(trainingClassPageTranslationValue, partyPK);
211        }
212    }
213
214}