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