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