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