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.CreateCommandMessageTranslationForm;
020import com.echothree.model.control.party.common.PartyTypes;
021import com.echothree.model.control.party.server.control.PartyControl;
022import com.echothree.model.control.security.common.SecurityRoleGroups;
023import com.echothree.model.control.security.common.SecurityRoles;
024import com.echothree.model.data.core.server.entity.CommandMessage;
025import com.echothree.model.data.core.server.entity.CommandMessageTranslation;
026import com.echothree.model.data.core.server.entity.CommandMessageType;
027import com.echothree.model.data.party.server.entity.Language;
028import com.echothree.model.data.user.common.pk.UserVisitPK;
029import com.echothree.util.common.message.ExecutionErrors;
030import com.echothree.util.common.validation.FieldDefinition;
031import com.echothree.util.common.validation.FieldType;
032import com.echothree.util.common.command.BaseResult;
033import com.echothree.util.server.control.BaseSimpleCommand;
034import com.echothree.util.server.control.CommandSecurityDefinition;
035import com.echothree.util.server.control.PartyTypeDefinition;
036import com.echothree.util.server.control.SecurityRoleDefinition;
037import com.echothree.util.server.persistence.Session;
038import java.util.Arrays;
039import java.util.Collections;
040import java.util.List;
041
042public class CreateCommandMessageTranslationCommand
043        extends BaseSimpleCommand<CreateCommandMessageTranslationForm> {
044    
045    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
046    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
047    
048    static {
049        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
050                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
051                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
052                        new SecurityRoleDefinition(SecurityRoleGroups.CommandMessage.name(), SecurityRoles.Translation.name())
053                        )))
054                )));
055        
056        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
057                new FieldDefinition("CommandMessageTypeName", FieldType.ENTITY_NAME, true, null, null),
058                new FieldDefinition("CommandMessageKey", FieldType.KEY, true, null, null),
059                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null),
060                new FieldDefinition("Translation", FieldType.STRING, true, 1L, 512L)
061                ));
062    }
063    
064    /** Creates a new instance of CreateCommandMessageTranslationCommand */
065    public CreateCommandMessageTranslationCommand(UserVisitPK userVisitPK, CreateCommandMessageTranslationForm form) {
066        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
067    }
068    
069    @Override
070    protected BaseResult execute() {
071        var coreControl = getCoreControl();
072        String commandMessageTypeName = form.getCommandMessageTypeName();
073        CommandMessageType commandMessageType = coreControl.getCommandMessageTypeByName(commandMessageTypeName);
074
075        if(commandMessageType != null) {
076            String commandMessageKey = form.getCommandMessageKey();
077            CommandMessage commandMessage = coreControl.getCommandMessageByKey(commandMessageType, commandMessageKey);
078
079            if(commandMessage != null) {
080                var partyControl = Session.getModelController(PartyControl.class);
081                String languageIsoName = form.getLanguageIsoName();
082                Language language = partyControl.getLanguageByIsoName(languageIsoName);
083
084                if(language != null) {
085                    CommandMessageTranslation commandMessageTranslation = coreControl.getCommandMessageTranslation(commandMessage, language);
086
087                    if(commandMessageTranslation == null) {
088                        String translation = form.getTranslation();
089
090                        coreControl.createCommandMessageTranslation(commandMessage, language, translation, getPartyPK());
091                    } else {
092                        addExecutionError(ExecutionErrors.DuplicateCommandMessageTranslation.name(), commandMessageTypeName, commandMessageKey, languageIsoName);
093                    }
094                } else {
095                    addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
096                }
097            } else {
098                addExecutionError(ExecutionErrors.UnknownCommandMessageKey.name(), commandMessageTypeName, commandMessageKey);
099            }
100        } else {
101            addExecutionError(ExecutionErrors.UnknownCommandMessageTypeName.name(), commandMessageTypeName);
102        }
103
104        return null;
105    }
106
107}