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 java.util.List;
046import javax.enterprise.context.Dependent;
047import javax.inject.Inject;
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    @Inject
080    PartyControl partyControl;
081
082    @Inject
083    TrainingControl trainingControl;
084
085    @Inject
086    MimeTypeLogic mimeTypeLogic;
087
088    /** Creates a new instance of EditTrainingClassPageTranslationCommand */
089    public EditTrainingClassPageTranslationCommand() {
090        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
091    }
092
093    @Override
094    public EditTrainingClassPageTranslationResult getResult() {
095        return TrainingResultFactory.getEditTrainingClassPageTranslationResult();
096    }
097
098    @Override
099    public TrainingClassPageTranslationEdit getEdit() {
100        return TrainingEditFactory.getTrainingClassPageTranslationEdit();
101    }
102
103    TrainingClassSection trainingClassSection;
104    
105    @Override
106    public TrainingClassPageTranslation getEntity(EditTrainingClassPageTranslationResult result) {
107        TrainingClassPageTranslation trainingClassPageTranslation = null;
108        var trainingClassName = spec.getTrainingClassName();
109        var trainingClass = trainingControl.getTrainingClassByName(trainingClassName);
110
111        if(trainingClass != null) {
112            var trainingClassSectionName = spec.getTrainingClassSectionName();
113            
114            trainingClassSection = trainingControl.getTrainingClassSectionByName(trainingClass, trainingClassSectionName);
115
116            if(trainingClassSection != null) {
117                var trainingClassPageName = spec.getTrainingClassPageName();
118                var trainingClassPage = trainingControl.getTrainingClassPageByName(trainingClassSection, trainingClassPageName);
119
120                if(trainingClassPage != null) {
121                    var languageIsoName = spec.getLanguageIsoName();
122                    var language = partyControl.getLanguageByIsoName(languageIsoName);
123
124                    if(language != null) {
125                        if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
126                            trainingClassPageTranslation = trainingControl.getTrainingClassPageTranslation(trainingClassPage, language);
127                        } else { // EditMode.UPDATE
128                            trainingClassPageTranslation = trainingControl.getTrainingClassPageTranslationForUpdate(trainingClassPage, language);
129                        }
130
131                        if(trainingClassPageTranslation == null) {
132                            addExecutionError(ExecutionErrors.UnknownTrainingClassPageTranslation.name(), trainingClassName, trainingClassSectionName,
133                                    trainingClassPageName, languageIsoName);
134                        }
135                    } else {
136                        addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
137                    }
138                } else {
139                    addExecutionError(ExecutionErrors.UnknownTrainingClassPageName.name(), trainingClassName, trainingClassSectionName, trainingClassPageName);
140                }
141            } else {
142                addExecutionError(ExecutionErrors.UnknownTrainingClassSectionName.name(), trainingClassName, trainingClassSectionName);
143            }
144        } else {
145            addExecutionError(ExecutionErrors.UnknownTrainingClassName.name(), trainingClassName);
146        }
147
148        return trainingClassPageTranslation;
149    }
150
151    @Override
152    public TrainingClassPage getLockEntity(TrainingClassPageTranslation trainingClassPageTranslation) {
153        return trainingClassPageTranslation.getTrainingClassPage();
154    }
155
156    @Override
157    public void fillInResult(EditTrainingClassPageTranslationResult result, TrainingClassPageTranslation trainingClassPageTranslation) {
158        result.setTrainingClassPageTranslation(trainingControl.getTrainingClassPageTranslationTransfer(getUserVisit(), trainingClassPageTranslation));
159    }
160
161    MimeType pageMimeType;
162    MimeType introductionMimeType;
163    
164    @Override
165    public void doLock(TrainingClassPageTranslationEdit edit, TrainingClassPageTranslation trainingClassPageTranslation) {
166        pageMimeType = trainingClassPageTranslation.getPageMimeType();
167        
168        edit.setDescription(trainingClassPageTranslation.getDescription());
169        edit.setPageMimeTypeName(pageMimeType == null? null: pageMimeType.getLastDetail().getMimeTypeName());
170        edit.setPage(trainingClassPageTranslation.getPage());
171    }
172
173    @Override
174    protected void canUpdate(TrainingClassPageTranslation trainingClassPageTranslation) {
175        var pageMimeTypeName = edit.getPageMimeTypeName();
176        var page = edit.getPage();
177        
178        pageMimeType = mimeTypeLogic.checkMimeType(this, pageMimeTypeName, page, MimeTypeUsageTypes.TEXT.name(),
179                ExecutionErrors.MissingRequiredPageMimeTypeName.name(), ExecutionErrors.MissingRequiredPage.name(),
180                ExecutionErrors.UnknownPageMimeTypeName.name(), ExecutionErrors.UnknownPageMimeTypeUsage.name());
181    }
182    
183    @Override
184    public void doUpdate(TrainingClassPageTranslation trainingClassPageTranslation) {
185        var trainingClassPageTranslationValue = trainingControl.getTrainingClassPageTranslationValue(trainingClassPageTranslation);
186        
187        trainingClassPageTranslationValue.setDescription(edit.getDescription());
188        trainingClassPageTranslationValue.setPageMimeTypePK(pageMimeType == null? null: pageMimeType.getPrimaryKey());
189        trainingClassPageTranslationValue.setPage(edit.getPage());
190        
191        trainingControl.updateTrainingClassPageTranslationFromValue(trainingClassPageTranslationValue, getPartyPK());
192    }
193
194}