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