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.form.CreateTrainingClassPageTranslationForm;
020import com.echothree.model.control.core.common.MimeTypeUsageTypes;
021import com.echothree.model.control.core.server.logic.MimeTypeLogic;
022import com.echothree.model.control.party.common.PartyTypes;
023import com.echothree.model.control.party.server.control.PartyControl;
024import com.echothree.model.control.security.common.SecurityRoleGroups;
025import com.echothree.model.control.security.common.SecurityRoles;
026import com.echothree.model.control.training.server.control.TrainingControl;
027import com.echothree.model.data.core.server.entity.MimeType;
028import com.echothree.model.data.party.server.entity.Language;
029import com.echothree.model.data.training.server.entity.TrainingClass;
030import com.echothree.model.data.training.server.entity.TrainingClassPage;
031import com.echothree.model.data.training.server.entity.TrainingClassPageTranslation;
032import com.echothree.model.data.training.server.entity.TrainingClassSection;
033import com.echothree.model.data.user.common.pk.UserVisitPK;
034import com.echothree.util.common.message.ExecutionErrors;
035import com.echothree.util.common.validation.FieldDefinition;
036import com.echothree.util.common.validation.FieldType;
037import com.echothree.util.common.command.BaseResult;
038import com.echothree.util.server.control.BaseSimpleCommand;
039import com.echothree.util.server.control.CommandSecurityDefinition;
040import com.echothree.util.server.control.PartyTypeDefinition;
041import com.echothree.util.server.control.SecurityRoleDefinition;
042import com.echothree.util.server.persistence.Session;
043import java.util.Arrays;
044import java.util.Collections;
045import java.util.List;
046
047public class CreateTrainingClassPageTranslationCommand
048        extends BaseSimpleCommand<CreateTrainingClassPageTranslationForm> {
049    
050    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
051    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
052    
053    static {
054        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
055                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
056                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
057                        new SecurityRoleDefinition(SecurityRoleGroups.TrainingClassPage.name(), SecurityRoles.Translation.name())
058                        )))
059                )));
060
061        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
062                new FieldDefinition("TrainingClassName", FieldType.ENTITY_NAME, true, null, null),
063                new FieldDefinition("TrainingClassSectionName", FieldType.ENTITY_NAME, true, null, null),
064                new FieldDefinition("TrainingClassPageName", FieldType.ENTITY_NAME, true, null, null),
065                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null),
066                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L),
067                new FieldDefinition("PageMimeTypeName", FieldType.MIME_TYPE, false, null, null),
068                new FieldDefinition("Page", FieldType.STRING, false, null, null)
069                ));
070    }
071    
072    /** Creates a new instance of CreateTrainingClassPageTranslationCommand */
073    public CreateTrainingClassPageTranslationCommand(UserVisitPK userVisitPK, CreateTrainingClassPageTranslationForm form) {
074        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
075    }
076    
077    @Override
078    protected BaseResult execute() {
079        var trainingControl = Session.getModelController(TrainingControl.class);
080        String trainingClassName = form.getTrainingClassName();
081        TrainingClass trainingClass = trainingControl.getTrainingClassByName(trainingClassName);
082
083        if(trainingClass != null) {
084            String trainingClassSectionName = form.getTrainingClassSectionName();
085            TrainingClassSection trainingClassSection = trainingControl.getTrainingClassSectionByName(trainingClass, trainingClassSectionName);
086
087            if(trainingClassSection != null) {
088                String trainingClassPageName = form.getTrainingClassPageName();
089                TrainingClassPage trainingClassPage = trainingControl.getTrainingClassPageByName(trainingClassSection, trainingClassPageName);
090
091                if(trainingClassPage != null) {
092                    var partyControl = Session.getModelController(PartyControl.class);
093                    String languageIsoName = form.getLanguageIsoName();
094                    Language language = partyControl.getLanguageByIsoName(languageIsoName);
095
096                    if(language != null) {
097                        TrainingClassPageTranslation trainingClassPageTranslation = trainingControl.getTrainingClassPageTranslation(trainingClassPage, language);
098
099                        if(trainingClassPageTranslation == null) {
100                            MimeTypeLogic mimeTypeLogic = MimeTypeLogic.getInstance();
101                            String pageMimeTypeName = form.getPageMimeTypeName();
102                            String page = form.getPage();
103
104                            MimeType pageMimeType = mimeTypeLogic.checkMimeType(this, pageMimeTypeName, page, MimeTypeUsageTypes.TEXT.name(),
105                                    ExecutionErrors.MissingRequiredPageMimeTypeName.name(), ExecutionErrors.MissingRequiredPage.name(),
106                                    ExecutionErrors.UnknownPageMimeTypeName.name(), ExecutionErrors.UnknownPageMimeTypeUsage.name());
107
108                            if(!hasExecutionErrors()) {
109                                var description = form.getDescription();
110
111                                trainingControl.createTrainingClassPageTranslation(trainingClassPage, language, description, pageMimeType, page,
112                                        getPartyPK());
113                            }
114                        } else {
115                            addExecutionError(ExecutionErrors.DuplicateTrainingClassPageTranslation.name(), trainingClassName, trainingClassPageName, languageIsoName);
116                        }
117                    } else {
118                        addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
119                    }
120                } else {
121                    addExecutionError(ExecutionErrors.UnknownTrainingClassPageName.name(), trainingClassName, trainingClassPageName);
122                }
123            } else {
124                addExecutionError(ExecutionErrors.UnknownTrainingClassSectionName.name(), trainingClassName, trainingClassSectionName);
125            }
126        } else {
127            addExecutionError(ExecutionErrors.UnknownTrainingClassName.name(), trainingClassName);
128        }
129
130        return null;
131    }
132    
133}