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.CreateTrainingClassPageForm;
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.security.common.SecurityRoleGroups;
024import com.echothree.model.control.security.common.SecurityRoles;
025import com.echothree.model.control.training.server.control.TrainingControl;
026import com.echothree.model.data.core.server.entity.MimeType;
027import com.echothree.model.data.party.common.pk.PartyPK;
028import com.echothree.model.data.training.server.entity.TrainingClass;
029import com.echothree.model.data.training.server.entity.TrainingClassPage;
030import com.echothree.model.data.training.server.entity.TrainingClassSection;
031import com.echothree.model.data.user.common.pk.UserVisitPK;
032import com.echothree.util.common.message.ExecutionErrors;
033import com.echothree.util.common.validation.FieldDefinition;
034import com.echothree.util.common.validation.FieldType;
035import com.echothree.util.common.command.BaseResult;
036import com.echothree.util.server.control.BaseSimpleCommand;
037import com.echothree.util.server.control.CommandSecurityDefinition;
038import com.echothree.util.server.control.PartyTypeDefinition;
039import com.echothree.util.server.control.SecurityRoleDefinition;
040import com.echothree.util.server.persistence.Session;
041import java.util.Arrays;
042import java.util.Collections;
043import java.util.List;
044
045public class CreateTrainingClassPageCommand
046        extends BaseSimpleCommand<CreateTrainingClassPageForm> {
047    
048    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
049    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
050    
051    static {
052        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
053                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
054                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
055                        new SecurityRoleDefinition(SecurityRoleGroups.TrainingClassPage.name(), SecurityRoles.Create.name())
056                        )))
057                )));
058
059        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
060                new FieldDefinition("TrainingClassName", FieldType.ENTITY_NAME, true, null, null),
061                new FieldDefinition("TrainingClassSectionName", FieldType.ENTITY_NAME, true, null, null),
062                new FieldDefinition("TrainingClassPageName", FieldType.ENTITY_NAME, true, null, null),
063                new FieldDefinition("PercentageToPass", FieldType.FRACTIONAL_PERCENT, false, null, null),
064                new FieldDefinition("QuestionCount", FieldType.UNSIGNED_INTEGER, false, null, null),
065                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
066                new FieldDefinition("Description", FieldType.STRING, false, 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 CreateTrainingClassPageCommand */
073    public CreateTrainingClassPageCommand(UserVisitPK userVisitPK, CreateTrainingClassPageForm 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                    MimeTypeLogic mimeTypeLogic = MimeTypeLogic.getInstance();
093                    String page = form.getPage();
094                    MimeType pageMimeType = mimeTypeLogic.checkMimeType(this, form.getPageMimeTypeName(), page, MimeTypeUsageTypes.TEXT.name(),
095                            ExecutionErrors.MissingRequiredPageMimeTypeName.name(), ExecutionErrors.MissingRequiredPage.name(),
096                            ExecutionErrors.UnknownPageMimeTypeName.name(), ExecutionErrors.UnknownPageMimeTypeUsage.name());
097
098                    if(!hasExecutionErrors()) {
099                        PartyPK createdBy = getPartyPK();
100                        var sortOrder = Integer.valueOf(form.getSortOrder());
101                        var description = form.getDescription();
102
103                        trainingClassPage = trainingControl.createTrainingClassPage(trainingClassSection, trainingClassPageName, sortOrder, createdBy);
104
105                        if(description != null || page != null) {
106                            trainingControl.createTrainingClassPageTranslation(trainingClassPage, getPreferredLanguage(), description, pageMimeType,
107                                    page, createdBy);
108                        }
109                    }
110                } else {
111                    addExecutionError(ExecutionErrors.DuplicateTrainingClassPageName.name(), trainingClassName, trainingClassPageName);
112                }
113            } else {
114                addExecutionError(ExecutionErrors.UnknownTrainingClassSectionName.name(), trainingClassName, trainingClassSectionName);
115            }
116        } else {
117            addExecutionError(ExecutionErrors.UnknownTrainingClassName.name(), trainingClassName);
118        }
119
120        return null;
121    }
122    
123}