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.TrainingClassPageTranslationEdit;
020import com.echothree.control.user.training.common.edit.TrainingEditFactory;
021import com.echothree.control.user.training.common.form.EditTrainingClassPageTranslationForm;
022import com.echothree.control.user.training.common.result.EditTrainingClassPageTranslationResult;
023import com.echothree.control.user.training.common.result.TrainingResultFactory;
024import com.echothree.control.user.training.common.spec.TrainingClassPageTranslationSpec;
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.party.server.control.PartyControl;
029import com.echothree.model.control.security.common.SecurityRoleGroups;
030import com.echothree.model.control.security.common.SecurityRoles;
031import com.echothree.model.control.training.server.control.TrainingControl;
032import com.echothree.model.data.core.server.entity.MimeType;
033import com.echothree.model.data.training.server.entity.TrainingClassPage;
034import com.echothree.model.data.training.server.entity.TrainingClassPageTranslation;
035import com.echothree.model.data.training.server.entity.TrainingClassSection;
036import com.echothree.model.data.user.common.pk.UserVisitPK;
037import com.echothree.util.common.message.ExecutionErrors;
038import com.echothree.util.common.validation.FieldDefinition;
039import com.echothree.util.common.validation.FieldType;
040import com.echothree.util.common.command.EditMode;
041import com.echothree.util.server.control.BaseAbstractEditCommand;
042import com.echothree.util.server.control.CommandSecurityDefinition;
043import com.echothree.util.server.control.PartyTypeDefinition;
044import com.echothree.util.server.control.SecurityRoleDefinition;
045import com.echothree.util.server.persistence.Session;
046import java.util.List;
047import javax.enterprise.context.Dependent;
048
049@Dependent
050public class EditTrainingClassPageTranslationCommand
051        extends BaseAbstractEditCommand<TrainingClassPageTranslationSpec, TrainingClassPageTranslationEdit, EditTrainingClassPageTranslationResult, TrainingClassPageTranslation, 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(List.of(
059                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
060                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
061                        new SecurityRoleDefinition(SecurityRoleGroups.TrainingClassPage.name(), SecurityRoles.Translation.name())
062                        ))
063                ));
064
065        SPEC_FIELD_DEFINITIONS = List.of(
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                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
070                );
071
072        EDIT_FIELD_DEFINITIONS = List.of(
073                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L),
074                new FieldDefinition("PageMimeTypeName", FieldType.MIME_TYPE, true, null, null),
075                new FieldDefinition("Page", FieldType.STRING, true, null, null)
076                );
077    }
078
079    /** Creates a new instance of EditTrainingClassPageTranslationCommand */
080    public EditTrainingClassPageTranslationCommand() {
081        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
082    }
083
084    @Override
085    public EditTrainingClassPageTranslationResult getResult() {
086        return TrainingResultFactory.getEditTrainingClassPageTranslationResult();
087    }
088
089    @Override
090    public TrainingClassPageTranslationEdit getEdit() {
091        return TrainingEditFactory.getTrainingClassPageTranslationEdit();
092    }
093
094    TrainingClassSection trainingClassSection;
095    
096    @Override
097    public TrainingClassPageTranslation getEntity(EditTrainingClassPageTranslationResult result) {
098        var trainingControl = Session.getModelController(TrainingControl.class);
099        TrainingClassPageTranslation trainingClassPageTranslation = null;
100        var trainingClassName = spec.getTrainingClassName();
101        var trainingClass = trainingControl.getTrainingClassByName(trainingClassName);
102
103        if(trainingClass != null) {
104            var trainingClassSectionName = spec.getTrainingClassSectionName();
105            
106            trainingClassSection = trainingControl.getTrainingClassSectionByName(trainingClass, trainingClassSectionName);
107
108            if(trainingClassSection != null) {
109                var trainingClassPageName = spec.getTrainingClassPageName();
110                var trainingClassPage = trainingControl.getTrainingClassPageByName(trainingClassSection, trainingClassPageName);
111
112                if(trainingClassPage != null) {
113                    var partyControl = Session.getModelController(PartyControl.class);
114                    var languageIsoName = spec.getLanguageIsoName();
115                    var language = partyControl.getLanguageByIsoName(languageIsoName);
116
117                    if(language != null) {
118                        if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
119                            trainingClassPageTranslation = trainingControl.getTrainingClassPageTranslation(trainingClassPage, language);
120                        } else { // EditMode.UPDATE
121                            trainingClassPageTranslation = trainingControl.getTrainingClassPageTranslationForUpdate(trainingClassPage, language);
122                        }
123
124                        if(trainingClassPageTranslation == null) {
125                            addExecutionError(ExecutionErrors.UnknownTrainingClassPageTranslation.name(), trainingClassName, trainingClassSectionName,
126                                    trainingClassPageName, languageIsoName);
127                        }
128                    } else {
129                        addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
130                    }
131                } else {
132                    addExecutionError(ExecutionErrors.UnknownTrainingClassPageName.name(), trainingClassName, trainingClassSectionName, trainingClassPageName);
133                }
134            } else {
135                addExecutionError(ExecutionErrors.UnknownTrainingClassSectionName.name(), trainingClassName, trainingClassSectionName);
136            }
137        } else {
138            addExecutionError(ExecutionErrors.UnknownTrainingClassName.name(), trainingClassName);
139        }
140
141        return trainingClassPageTranslation;
142    }
143
144    @Override
145    public TrainingClassPage getLockEntity(TrainingClassPageTranslation trainingClassPageTranslation) {
146        return trainingClassPageTranslation.getTrainingClassPage();
147    }
148
149    @Override
150    public void fillInResult(EditTrainingClassPageTranslationResult result, TrainingClassPageTranslation trainingClassPageTranslation) {
151        var trainingControl = Session.getModelController(TrainingControl.class);
152
153        result.setTrainingClassPageTranslation(trainingControl.getTrainingClassPageTranslationTransfer(getUserVisit(), trainingClassPageTranslation));
154    }
155
156    MimeType pageMimeType;
157    MimeType introductionMimeType;
158    
159    @Override
160    public void doLock(TrainingClassPageTranslationEdit edit, TrainingClassPageTranslation trainingClassPageTranslation) {
161        pageMimeType = trainingClassPageTranslation.getPageMimeType();
162        
163        edit.setDescription(trainingClassPageTranslation.getDescription());
164        edit.setPageMimeTypeName(pageMimeType == null? null: pageMimeType.getLastDetail().getMimeTypeName());
165        edit.setPage(trainingClassPageTranslation.getPage());
166    }
167
168    @Override
169    protected void canUpdate(TrainingClassPageTranslation trainingClassPageTranslation) {
170        var mimeTypeLogic = MimeTypeLogic.getInstance();
171        var pageMimeTypeName = edit.getPageMimeTypeName();
172        var page = edit.getPage();
173        
174        pageMimeType = mimeTypeLogic.checkMimeType(this, pageMimeTypeName, page, MimeTypeUsageTypes.TEXT.name(),
175                ExecutionErrors.MissingRequiredPageMimeTypeName.name(), ExecutionErrors.MissingRequiredPage.name(),
176                ExecutionErrors.UnknownPageMimeTypeName.name(), ExecutionErrors.UnknownPageMimeTypeUsage.name());
177    }
178    
179    @Override
180    public void doUpdate(TrainingClassPageTranslation trainingClassPageTranslation) {
181        var trainingControl = Session.getModelController(TrainingControl.class);
182        var trainingClassPageTranslationValue = trainingControl.getTrainingClassPageTranslationValue(trainingClassPageTranslation);
183        
184        trainingClassPageTranslationValue.setDescription(edit.getDescription());
185        trainingClassPageTranslationValue.setPageMimeTypePK(pageMimeType == null? null: pageMimeType.getPrimaryKey());
186        trainingClassPageTranslationValue.setPage(edit.getPage());
187        
188        trainingControl.updateTrainingClassPageTranslationFromValue(trainingClassPageTranslationValue, getPartyPK());
189    }
190
191}