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.security.server.command;
018
019import com.echothree.control.user.security.common.form.GetSecurityRoleChoicesForm;
020import com.echothree.control.user.security.common.result.GetSecurityRoleChoicesResult;
021import com.echothree.control.user.security.common.result.SecurityResultFactory;
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.security.server.control.SecurityControl;
026import com.echothree.model.control.workflow.server.control.WorkflowControl;
027import com.echothree.model.data.security.server.entity.SecurityRoleGroup;
028import com.echothree.model.data.user.common.pk.UserVisitPK;
029import com.echothree.model.data.workflow.server.entity.Workflow;
030import com.echothree.util.common.message.ExecutionErrors;
031import com.echothree.util.common.validation.FieldDefinition;
032import com.echothree.util.common.validation.FieldType;
033import com.echothree.util.common.command.BaseResult;
034import com.echothree.util.server.control.BaseSimpleCommand;
035import com.echothree.util.server.control.CommandSecurityDefinition;
036import com.echothree.util.server.control.PartyTypeDefinition;
037import com.echothree.util.server.control.SecurityRoleDefinition;
038import com.echothree.util.server.persistence.Session;
039import java.util.Arrays;
040import java.util.Collections;
041import java.util.List;
042
043public class GetSecurityRoleChoicesCommand
044        extends BaseSimpleCommand<GetSecurityRoleChoicesForm> {
045    
046    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
047    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
048    
049    static {
050        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
051                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
052                    new SecurityRoleDefinition(SecurityRoleGroups.SecurityRole.name(), SecurityRoles.Choices.name())
053                    )))
054                )));
055        
056        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
057                new FieldDefinition("SecurityRoleGroupName", FieldType.ENTITY_NAME, false, null, null),
058                new FieldDefinition("WorkflowName", FieldType.ENTITY_NAME, false, null, null),
059                new FieldDefinition("DefaultSecurityRoleChoice", FieldType.ENTITY_NAME, false, null, null),
060                new FieldDefinition("AllowNullChoice", FieldType.BOOLEAN, true, null, null)
061                ));
062    }
063    
064    /** Creates a new instance of GetSecurityRoleChoicesCommand */
065    public GetSecurityRoleChoicesCommand(UserVisitPK userVisitPK, GetSecurityRoleChoicesForm form) {
066        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
067    }
068    
069    @Override
070    protected BaseResult execute() {
071        GetSecurityRoleChoicesResult result = SecurityResultFactory.getGetSecurityRoleChoicesResult();
072        String securityRoleGroupName = form.getSecurityRoleGroupName();
073        String workflowName = form.getWorkflowName();
074        var parameterCount = (securityRoleGroupName == null ? 0 : 1) + (workflowName == null ? 0 : 1);
075        
076        if(parameterCount == 1) {
077            var securityControl = Session.getModelController(SecurityControl.class);
078            SecurityRoleGroup securityRoleGroup = null;
079            
080            if(securityRoleGroupName != null) {
081                securityRoleGroup = securityControl.getSecurityRoleGroupByName(securityRoleGroupName);
082
083                if(securityRoleGroup == null) {
084                    addExecutionError(ExecutionErrors.UnknownSecurityRoleGroupName.name(), securityRoleGroupName);
085                }
086            } else {
087                var workflowControl = Session.getModelController(WorkflowControl.class);
088                var workflow = workflowControl.getWorkflowByName(workflowName);
089
090                if(workflow != null) {
091                    securityRoleGroup = workflow.getLastDetail().getSecurityRoleGroup();
092                    
093                    if(securityRoleGroup == null) {
094                        addExecutionError(ExecutionErrors.WorkflowMissingSecurityRoleGroup.name(), workflowName);
095                    }
096                } else {
097                    addExecutionError(ExecutionErrors.UnknownWorkflowName.name(), workflowName);
098                }
099            }
100            
101            if(!hasExecutionErrors()) {
102                String defaultSecurityRoleChoice = form.getDefaultSecurityRoleChoice();
103                boolean allowNullChoice = Boolean.parseBoolean(form.getAllowNullChoice());
104
105                result.setSecurityRoleChoices(securityControl.getSecurityRoleChoices(defaultSecurityRoleChoice, getPreferredLanguage(), allowNullChoice,
106                        securityRoleGroup));
107            }
108        } else {
109            addExecutionError(ExecutionErrors.InvalidParameterCount.name());
110        }
111        
112        return result;
113    }
114    
115}