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.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.user.common.pk.UserVisitPK;
027import com.echothree.util.common.message.ExecutionErrors;
028import com.echothree.util.common.validation.FieldDefinition;
029import com.echothree.util.common.validation.FieldType;
030import com.echothree.util.common.command.BaseResult;
031import com.echothree.util.server.control.BaseSimpleCommand;
032import com.echothree.util.server.control.CommandSecurityDefinition;
033import com.echothree.util.server.control.PartyTypeDefinition;
034import com.echothree.util.server.control.SecurityRoleDefinition;
035import com.echothree.util.server.persistence.Session;
036import java.util.Arrays;
037import java.util.Collections;
038import java.util.List;
039import javax.enterprise.context.RequestScoped;
040
041@RequestScoped
042public class CreateTrainingClassPageCommand
043        extends BaseSimpleCommand<CreateTrainingClassPageForm> {
044    
045    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
046    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
047    
048    static {
049        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
050                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
051                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
052                        new SecurityRoleDefinition(SecurityRoleGroups.TrainingClassPage.name(), SecurityRoles.Create.name())
053                        )))
054                )));
055
056        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
057                new FieldDefinition("TrainingClassName", FieldType.ENTITY_NAME, true, null, null),
058                new FieldDefinition("TrainingClassSectionName", FieldType.ENTITY_NAME, true, null, null),
059                new FieldDefinition("TrainingClassPageName", FieldType.ENTITY_NAME, true, null, null),
060                new FieldDefinition("PercentageToPass", FieldType.FRACTIONAL_PERCENT, false, null, null),
061                new FieldDefinition("QuestionCount", FieldType.UNSIGNED_INTEGER, false, null, null),
062                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
063                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L),
064                new FieldDefinition("PageMimeTypeName", FieldType.MIME_TYPE, false, null, null),
065                new FieldDefinition("Page", FieldType.STRING, false, null, null)
066                ));
067    }
068    
069    /** Creates a new instance of CreateTrainingClassPageCommand */
070    public CreateTrainingClassPageCommand() {
071        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
072    }
073    
074    @Override
075    protected BaseResult execute() {
076        var trainingControl = Session.getModelController(TrainingControl.class);
077        var trainingClassName = form.getTrainingClassName();
078        var trainingClass = trainingControl.getTrainingClassByName(trainingClassName);
079
080        if(trainingClass != null) {
081            var trainingClassSectionName = form.getTrainingClassSectionName();
082            var trainingClassSection = trainingControl.getTrainingClassSectionByName(trainingClass, trainingClassSectionName);
083
084            if(trainingClassSection != null) {
085                var trainingClassPageName = form.getTrainingClassPageName();
086                var trainingClassPage = trainingControl.getTrainingClassPageByName(trainingClassSection, trainingClassPageName);
087
088                if(trainingClassPage == null) {
089                    var mimeTypeLogic = MimeTypeLogic.getInstance();
090                    var page = form.getPage();
091                    var pageMimeType = mimeTypeLogic.checkMimeType(this, form.getPageMimeTypeName(), page, MimeTypeUsageTypes.TEXT.name(),
092                            ExecutionErrors.MissingRequiredPageMimeTypeName.name(), ExecutionErrors.MissingRequiredPage.name(),
093                            ExecutionErrors.UnknownPageMimeTypeName.name(), ExecutionErrors.UnknownPageMimeTypeUsage.name());
094
095                    if(!hasExecutionErrors()) {
096                        var createdBy = getPartyPK();
097                        var sortOrder = Integer.valueOf(form.getSortOrder());
098                        var description = form.getDescription();
099
100                        trainingClassPage = trainingControl.createTrainingClassPage(trainingClassSection, trainingClassPageName, sortOrder, createdBy);
101
102                        if(description != null || page != null) {
103                            trainingControl.createTrainingClassPageTranslation(trainingClassPage, getPreferredLanguage(), description, pageMimeType,
104                                    page, createdBy);
105                        }
106                    }
107                } else {
108                    addExecutionError(ExecutionErrors.DuplicateTrainingClassPageName.name(), trainingClassName, trainingClassPageName);
109                }
110            } else {
111                addExecutionError(ExecutionErrors.UnknownTrainingClassSectionName.name(), trainingClassName, trainingClassSectionName);
112            }
113        } else {
114            addExecutionError(ExecutionErrors.UnknownTrainingClassName.name(), trainingClassName);
115        }
116
117        return null;
118    }
119    
120}