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.security.server.command;
018
019import com.echothree.control.user.security.common.edit.SecurityEditFactory;
020import com.echothree.control.user.security.common.edit.SecurityRoleGroupEdit;
021import com.echothree.control.user.security.common.form.EditSecurityRoleGroupForm;
022import com.echothree.control.user.security.common.result.EditSecurityRoleGroupResult;
023import com.echothree.control.user.security.common.result.SecurityResultFactory;
024import com.echothree.control.user.security.common.spec.SecurityRoleGroupSpec;
025import com.echothree.model.control.party.common.PartyTypes;
026import com.echothree.model.control.security.common.SecurityRoleGroups;
027import com.echothree.model.control.security.common.SecurityRoles;
028import com.echothree.model.control.security.server.control.SecurityControl;
029import com.echothree.model.data.security.server.entity.SecurityRoleGroup;
030import com.echothree.model.data.user.common.pk.UserVisitPK;
031import com.echothree.util.common.message.ExecutionErrors;
032import com.echothree.util.common.validation.FieldDefinition;
033import com.echothree.util.common.validation.FieldType;
034import com.echothree.util.common.command.EditMode;
035import com.echothree.util.server.control.BaseAbstractEditCommand;
036import com.echothree.util.server.control.CommandSecurityDefinition;
037import com.echothree.util.server.control.PartyTypeDefinition;
038import com.echothree.util.server.control.SecurityRoleDefinition;
039import com.echothree.util.server.persistence.Session;
040import java.util.Arrays;
041import java.util.Collections;
042import java.util.List;
043import javax.enterprise.context.RequestScoped;
044
045@RequestScoped
046public class EditSecurityRoleGroupCommand
047        extends BaseAbstractEditCommand<SecurityRoleGroupSpec, SecurityRoleGroupEdit, EditSecurityRoleGroupResult, SecurityRoleGroup, SecurityRoleGroup> {
048    
049    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
050    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
051    private final static List<FieldDefinition> EDIT_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.SecurityRoleGroup.name(), SecurityRoles.Edit.name())
058                        )))
059                )));
060        
061        SPEC_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
062                new FieldDefinition("SecurityRoleGroupName", FieldType.ENTITY_NAME, true, null, null)
063                ));
064        
065        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
066                new FieldDefinition("SecurityRoleGroupName", FieldType.ENTITY_NAME, true, null, null),
067                new FieldDefinition("ParentSecurityRoleGroupName", FieldType.ENTITY_NAME, false, null, null),
068                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
069                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
070                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
071                ));
072    }
073    
074    /** Creates a new instance of EditSecurityRoleGroupCommand */
075    public EditSecurityRoleGroupCommand() {
076        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
077    }
078    
079    @Override
080    public EditSecurityRoleGroupResult getResult() {
081        return SecurityResultFactory.getEditSecurityRoleGroupResult();
082    }
083    
084    @Override
085    public SecurityRoleGroupEdit getEdit() {
086        return SecurityEditFactory.getSecurityRoleGroupEdit();
087    }
088    
089    @Override
090    public SecurityRoleGroup getEntity(EditSecurityRoleGroupResult result) {
091        var securityControl = Session.getModelController(SecurityControl.class);
092        SecurityRoleGroup securityRoleGroup;
093        var securityRoleGroupName = spec.getSecurityRoleGroupName();
094
095        if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
096            securityRoleGroup = securityControl.getSecurityRoleGroupByName(securityRoleGroupName);
097        } else { // EditMode.UPDATE
098            securityRoleGroup = securityControl.getSecurityRoleGroupByNameForUpdate(securityRoleGroupName);
099        }
100
101        if(securityRoleGroup != null) {
102            result.setSecurityRoleGroup(securityControl.getSecurityRoleGroupTransfer(getUserVisit(), securityRoleGroup));
103        } else {
104            addExecutionError(ExecutionErrors.UnknownSecurityRoleGroupName.name(), securityRoleGroupName);
105        }
106
107        return securityRoleGroup;
108    }
109    
110    @Override
111    public SecurityRoleGroup getLockEntity(SecurityRoleGroup securityRoleGroup) {
112        return securityRoleGroup;
113    }
114    
115    @Override
116    public void fillInResult(EditSecurityRoleGroupResult result, SecurityRoleGroup securityRoleGroup) {
117        var securityControl = Session.getModelController(SecurityControl.class);
118        
119        result.setSecurityRoleGroup(securityControl.getSecurityRoleGroupTransfer(getUserVisit(), securityRoleGroup));
120    }
121    
122    SecurityRoleGroup parentSecurityRoleGroup = null;
123    
124    @Override
125    public void doLock(SecurityRoleGroupEdit edit, SecurityRoleGroup securityRoleGroup) {
126        var securityControl = Session.getModelController(SecurityControl.class);
127        var securityRoleGroupDescription = securityControl.getSecurityRoleGroupDescription(securityRoleGroup, getPreferredLanguage());
128        var securityRoleGroupDetail = securityRoleGroup.getLastDetail();
129        
130        parentSecurityRoleGroup = securityRoleGroupDetail.getParentSecurityRoleGroup();
131        if(parentSecurityRoleGroup != null && SecurityRoleGroups.ROOT.name().equals(parentSecurityRoleGroup.getLastDetail().getSecurityRoleGroupName())) {
132            parentSecurityRoleGroup = null;
133        }
134        
135        edit.setSecurityRoleGroupName(securityRoleGroupDetail.getSecurityRoleGroupName());
136        edit.setParentSecurityRoleGroupName(parentSecurityRoleGroup == null? null: parentSecurityRoleGroup.getLastDetail().getSecurityRoleGroupName());
137        edit.setIsDefault(securityRoleGroupDetail.getIsDefault().toString());
138        edit.setSortOrder(securityRoleGroupDetail.getSortOrder().toString());
139
140        if(securityRoleGroupDescription != null) {
141            edit.setDescription(securityRoleGroupDescription.getDescription());
142        }
143    }
144        
145    @Override
146    public void canUpdate(SecurityRoleGroup securityRoleGroup) {
147        var securityControl = Session.getModelController(SecurityControl.class);
148        var securityRoleGroupName = edit.getSecurityRoleGroupName();
149        var duplicateSecurityRoleGroup = securityControl.getSecurityRoleGroupByName(securityRoleGroupName);
150
151        if(duplicateSecurityRoleGroup == null || securityRoleGroup.equals(duplicateSecurityRoleGroup)) {
152            var parentSecurityRoleGroupName = edit.getParentSecurityRoleGroupName();
153            
154            parentSecurityRoleGroup = securityControl.getSecurityRoleGroupByName(parentSecurityRoleGroupName == null? SecurityRoleGroups.ROOT.name(): parentSecurityRoleGroupName);
155
156            if(parentSecurityRoleGroup != null) {
157                if(!securityControl.isParentSecurityRoleGroupSafe(securityRoleGroup, parentSecurityRoleGroup)) {
158                    addExecutionError(ExecutionErrors.InvalidParentSecurityRoleGroup.name());
159                }
160            } else {
161                addExecutionError(ExecutionErrors.UnknownParentSecurityRoleGroupName.name(), parentSecurityRoleGroupName);
162            }
163        } else {
164            addExecutionError(ExecutionErrors.DuplicateSecurityRoleGroupName.name(), securityRoleGroupName);
165        }
166    }
167    
168    @Override
169    public void doUpdate(SecurityRoleGroup securityRoleGroup) {
170        var securityControl = Session.getModelController(SecurityControl.class);
171        var partyPK = getPartyPK();
172        var securityRoleGroupDetailValue = securityControl.getSecurityRoleGroupDetailValueForUpdate(securityRoleGroup);
173        var securityRoleGroupDescription = securityControl.getSecurityRoleGroupDescriptionForUpdate(securityRoleGroup, getPreferredLanguage());
174        var description = edit.getDescription();
175
176        securityRoleGroupDetailValue.setSecurityRoleGroupName(edit.getSecurityRoleGroupName());
177        securityRoleGroupDetailValue.setParentSecurityRoleGroupPK(parentSecurityRoleGroup == null? null: parentSecurityRoleGroup.getPrimaryKey());
178        securityRoleGroupDetailValue.setIsDefault(Boolean.valueOf(edit.getIsDefault()));
179        securityRoleGroupDetailValue.setSortOrder(Integer.valueOf(edit.getSortOrder()));
180
181        securityControl.updateSecurityRoleGroupFromValue(securityRoleGroupDetailValue, partyPK);
182
183        if(securityRoleGroupDescription == null && description != null) {
184            securityControl.createSecurityRoleGroupDescription(securityRoleGroup, getPreferredLanguage(), description, partyPK);
185        } else if(securityRoleGroupDescription != null && description == null) {
186            securityControl.deleteSecurityRoleGroupDescription(securityRoleGroupDescription, partyPK);
187        } else if(securityRoleGroupDescription != null && description != null) {
188            var securityRoleGroupDescriptionValue = securityControl.getSecurityRoleGroupDescriptionValue(securityRoleGroupDescription);
189
190            securityRoleGroupDescriptionValue.setDescription(description);
191            securityControl.updateSecurityRoleGroupDescriptionFromValue(securityRoleGroupDescriptionValue, partyPK);
192        }
193    }
194    
195}