001// --------------------------------------------------------------------------------
002// Copyright 2002-2026 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 java.util.List;
040import javax.enterprise.context.Dependent;
041import javax.inject.Inject;
042
043@Dependent
044public class EditSecurityRoleGroupCommand
045        extends BaseAbstractEditCommand<SecurityRoleGroupSpec, SecurityRoleGroupEdit, EditSecurityRoleGroupResult, SecurityRoleGroup, SecurityRoleGroup> {
046    
047    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
048    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
049    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
050    
051    static {
052        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
053                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
054                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
055                        new SecurityRoleDefinition(SecurityRoleGroups.SecurityRoleGroup.name(), SecurityRoles.Edit.name())
056                ))
057        ));
058        
059        SPEC_FIELD_DEFINITIONS = List.of(
060                new FieldDefinition("SecurityRoleGroupName", FieldType.ENTITY_NAME, true, null, null)
061        );
062        
063        EDIT_FIELD_DEFINITIONS = List.of(
064                new FieldDefinition("SecurityRoleGroupName", FieldType.ENTITY_NAME, true, null, null),
065                new FieldDefinition("ParentSecurityRoleGroupName", FieldType.ENTITY_NAME, false, null, null),
066                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
067                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
068                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
069        );
070    }
071
072    @Inject
073    SecurityControl securityControl;
074
075    
076    /** Creates a new instance of EditSecurityRoleGroupCommand */
077    public EditSecurityRoleGroupCommand() {
078        super(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        SecurityRoleGroup securityRoleGroup;
094        var securityRoleGroupName = spec.getSecurityRoleGroupName();
095
096        if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
097            securityRoleGroup = securityControl.getSecurityRoleGroupByName(securityRoleGroupName);
098        } else { // EditMode.UPDATE
099            securityRoleGroup = securityControl.getSecurityRoleGroupByNameForUpdate(securityRoleGroupName);
100        }
101
102        if(securityRoleGroup != null) {
103            result.setSecurityRoleGroup(securityControl.getSecurityRoleGroupTransfer(getUserVisit(), securityRoleGroup));
104        } else {
105            addExecutionError(ExecutionErrors.UnknownSecurityRoleGroupName.name(), securityRoleGroupName);
106        }
107
108        return securityRoleGroup;
109    }
110    
111    @Override
112    public SecurityRoleGroup getLockEntity(SecurityRoleGroup securityRoleGroup) {
113        return securityRoleGroup;
114    }
115    
116    @Override
117    public void fillInResult(EditSecurityRoleGroupResult result, SecurityRoleGroup securityRoleGroup) {
118        result.setSecurityRoleGroup(securityControl.getSecurityRoleGroupTransfer(getUserVisit(), securityRoleGroup));
119    }
120    
121    SecurityRoleGroup parentSecurityRoleGroup = null;
122    
123    @Override
124    public void doLock(SecurityRoleGroupEdit edit, SecurityRoleGroup securityRoleGroup) {
125        var securityRoleGroupDescription = securityControl.getSecurityRoleGroupDescription(securityRoleGroup, getPreferredLanguage());
126        var securityRoleGroupDetail = securityRoleGroup.getLastDetail();
127        
128        parentSecurityRoleGroup = securityRoleGroupDetail.getParentSecurityRoleGroup();
129        if(parentSecurityRoleGroup != null && SecurityRoleGroups.ROOT.name().equals(parentSecurityRoleGroup.getLastDetail().getSecurityRoleGroupName())) {
130            parentSecurityRoleGroup = null;
131        }
132        
133        edit.setSecurityRoleGroupName(securityRoleGroupDetail.getSecurityRoleGroupName());
134        edit.setParentSecurityRoleGroupName(parentSecurityRoleGroup == null? null: parentSecurityRoleGroup.getLastDetail().getSecurityRoleGroupName());
135        edit.setIsDefault(securityRoleGroupDetail.getIsDefault().toString());
136        edit.setSortOrder(securityRoleGroupDetail.getSortOrder().toString());
137
138        if(securityRoleGroupDescription != null) {
139            edit.setDescription(securityRoleGroupDescription.getDescription());
140        }
141    }
142        
143    @Override
144    public void canUpdate(SecurityRoleGroup securityRoleGroup) {
145        var securityRoleGroupName = edit.getSecurityRoleGroupName();
146        var duplicateSecurityRoleGroup = securityControl.getSecurityRoleGroupByName(securityRoleGroupName);
147
148        if(duplicateSecurityRoleGroup == null || securityRoleGroup.equals(duplicateSecurityRoleGroup)) {
149            var parentSecurityRoleGroupName = edit.getParentSecurityRoleGroupName();
150            
151            parentSecurityRoleGroup = securityControl.getSecurityRoleGroupByName(parentSecurityRoleGroupName == null? SecurityRoleGroups.ROOT.name(): parentSecurityRoleGroupName);
152
153            if(parentSecurityRoleGroup != null) {
154                if(!securityControl.isParentSecurityRoleGroupSafe(securityRoleGroup, parentSecurityRoleGroup)) {
155                    addExecutionError(ExecutionErrors.InvalidParentSecurityRoleGroup.name());
156                }
157            } else {
158                addExecutionError(ExecutionErrors.UnknownParentSecurityRoleGroupName.name(), parentSecurityRoleGroupName);
159            }
160        } else {
161            addExecutionError(ExecutionErrors.DuplicateSecurityRoleGroupName.name(), securityRoleGroupName);
162        }
163    }
164    
165    @Override
166    public void doUpdate(SecurityRoleGroup securityRoleGroup) {
167        var partyPK = getPartyPK();
168        var securityRoleGroupDetailValue = securityControl.getSecurityRoleGroupDetailValueForUpdate(securityRoleGroup);
169        var securityRoleGroupDescription = securityControl.getSecurityRoleGroupDescriptionForUpdate(securityRoleGroup, getPreferredLanguage());
170        var description = edit.getDescription();
171
172        securityRoleGroupDetailValue.setSecurityRoleGroupName(edit.getSecurityRoleGroupName());
173        securityRoleGroupDetailValue.setParentSecurityRoleGroupPK(parentSecurityRoleGroup == null? null: parentSecurityRoleGroup.getPrimaryKey());
174        securityRoleGroupDetailValue.setIsDefault(Boolean.valueOf(edit.getIsDefault()));
175        securityRoleGroupDetailValue.setSortOrder(Integer.valueOf(edit.getSortOrder()));
176
177        securityControl.updateSecurityRoleGroupFromValue(securityRoleGroupDetailValue, partyPK);
178
179        if(securityRoleGroupDescription == null && description != null) {
180            securityControl.createSecurityRoleGroupDescription(securityRoleGroup, getPreferredLanguage(), description, partyPK);
181        } else if(securityRoleGroupDescription != null && description == null) {
182            securityControl.deleteSecurityRoleGroupDescription(securityRoleGroupDescription, partyPK);
183        } else if(securityRoleGroupDescription != null && description != null) {
184            var securityRoleGroupDescriptionValue = securityControl.getSecurityRoleGroupDescriptionValue(securityRoleGroupDescription);
185
186            securityRoleGroupDescriptionValue.setDescription(description);
187            securityControl.updateSecurityRoleGroupDescriptionFromValue(securityRoleGroupDescriptionValue, partyPK);
188        }
189    }
190    
191}