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.core.server.command;
018
019import com.echothree.control.user.core.common.form.SendEventForm;
020import com.echothree.model.control.core.common.ComponentVendors;
021import com.echothree.model.control.core.common.EventTypes;
022import com.echothree.model.control.core.server.control.CoreControl;
023import com.echothree.model.control.core.server.logic.EntityInstanceLogic;
024import com.echothree.model.control.core.server.logic.EventTypeLogic;
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.data.core.server.entity.EntityInstance;
029import com.echothree.model.data.user.common.pk.UserVisitPK;
030import com.echothree.util.common.command.BaseResult;
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.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.List;
040
041public class SendEventCommand
042        extends BaseSimpleCommand<SendEventForm> {
043
044    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
045    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
046
047    static {
048        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
049                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
050                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
051                        new SecurityRoleDefinition(SecurityRoleGroups.Event.name(), SecurityRoles.Send.name())
052                ))
053        ));
054
055        FORM_FIELD_DEFINITIONS = List.of(
056                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
057                new FieldDefinition("Key", FieldType.KEY, false, null, null),
058                new FieldDefinition("Guid", FieldType.GUID, false, null, null),
059                new FieldDefinition("Ulid", FieldType.ULID, false, null, null),
060                new FieldDefinition("EventTypeName", FieldType.ENTITY_NAME, true, null, null)
061        );
062    }
063
064    /** Creates a new instance of SendEventCommand */
065    public SendEventCommand(UserVisitPK userVisitPK, SendEventForm form) {
066        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
067    }
068
069    @Override
070    protected BaseResult execute() {
071        var entityInstance = EntityInstanceLogic.getInstance().getEntityInstance(this, form);
072        var eventType = EventTypeLogic.getInstance().getEventTypeByName(this, form.getEventTypeName());
073
074        if(!hasExecutionErrors()) {
075            var componentVendorName = entityInstance.getEntityType().getLastDetail().getComponentVendor().getLastDetail().getComponentVendorName();
076
077            if(!ComponentVendors.ECHO_THREE.name().equals(componentVendorName)) {
078                var eventTypeName = eventType.getEventTypeName();
079                var eventTypeEnum = EventTypes.valueOf(eventTypeName);
080
081                switch(eventTypeEnum) {
082                    case READ:
083                    case MODIFY:
084                    case TOUCH: {
085                        var coreControl = Session.getModelController(CoreControl.class);
086
087                        coreControl.sendEvent(entityInstance, eventTypeEnum, (EntityInstance)null, null, getPartyPK());
088                    }
089                    break;
090                    default:
091                        addExecutionError(ExecutionErrors.InvalidEventType.name(), eventTypeName);
092                        break;
093                }
094            } else {
095                addExecutionError(ExecutionErrors.InvalidComponentVendor.name(), componentVendorName);
096            }
097        }
098
099        return null;
100    }
101
102}