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.item.server.command;
018
019import com.echothree.control.user.item.common.form.CreateItemAliasForm;
020import com.echothree.model.control.item.server.control.ItemControl;
021import com.echothree.model.control.item.server.logic.ItemAliasChecksumTypeLogic;
022import com.echothree.model.control.party.common.PartyTypes;
023import com.echothree.model.control.security.common.SecurityRoleGroups;
024import com.echothree.model.control.security.common.SecurityRoles;
025import com.echothree.model.control.uom.server.control.UomControl;
026import com.echothree.model.data.item.server.entity.Item;
027import com.echothree.model.data.item.server.entity.ItemAlias;
028import com.echothree.model.data.item.server.entity.ItemAliasType;
029import com.echothree.model.data.item.server.entity.ItemAliasTypeDetail;
030import com.echothree.model.data.item.server.entity.ItemDetail;
031import com.echothree.model.data.item.server.entity.ItemUnitOfMeasureType;
032import com.echothree.model.data.uom.server.entity.UnitOfMeasureKind;
033import com.echothree.model.data.uom.server.entity.UnitOfMeasureType;
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.BaseResult;
039import com.echothree.util.server.control.BaseSimpleCommand;
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;
047import java.util.regex.Matcher;
048import java.util.regex.Pattern;
049
050public class CreateItemAliasCommand
051        extends BaseSimpleCommand<CreateItemAliasForm> {
052
053    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
054    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
055    
056    static {
057        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
058                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
059                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
060                        new SecurityRoleDefinition(SecurityRoleGroups.ItemAlias.name(), SecurityRoles.Create.name())
061                )))
062        )));
063
064        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
065                new FieldDefinition("ItemName", FieldType.ENTITY_NAME, true, null, null),
066                new FieldDefinition("UnitOfMeasureTypeName", FieldType.ENTITY_NAME, true, null, null),
067                new FieldDefinition("ItemAliasTypeName", FieldType.ENTITY_NAME, true, null, null),
068                new FieldDefinition("Alias", FieldType.ENTITY_NAME, true, null, null)
069                ));
070    }
071    
072    /** Creates a new instance of CreateItemAliasCommand */
073    public CreateItemAliasCommand(UserVisitPK userVisitPK, CreateItemAliasForm form) {
074        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
075    }
076    
077    @Override
078    protected BaseResult execute() {
079        var itemControl = Session.getModelController(ItemControl.class);
080        String itemName = form.getItemName();
081        Item item = itemControl.getItemByName(itemName);
082        
083        if(item != null) {
084            var uomControl = Session.getModelController(UomControl.class);
085            String unitOfMeasureTypeName = form.getUnitOfMeasureTypeName();
086            ItemDetail itemDetail = item.getLastDetail();
087            UnitOfMeasureKind unitOfMeasureKind = itemDetail.getUnitOfMeasureKind();
088            UnitOfMeasureType unitOfMeasureType = uomControl.getUnitOfMeasureTypeByName(unitOfMeasureKind, unitOfMeasureTypeName);
089            
090            if(unitOfMeasureType != null) {
091                ItemUnitOfMeasureType itemUnitOfMeasureType = itemControl.getItemUnitOfMeasureType(item, unitOfMeasureType);
092                
093                if(itemUnitOfMeasureType != null) {
094                    String itemAliasTypeName = form.getItemAliasTypeName();
095                    ItemAliasType itemAliasType = itemControl.getItemAliasTypeByName(itemAliasTypeName);
096                    
097                    if(itemAliasType != null) {
098                        ItemAliasTypeDetail itemAliasTypeDetail = itemAliasType.getLastDetail();
099                        String validationPattern = itemAliasTypeDetail.getValidationPattern();
100                        String alias = form.getAlias();
101                        
102                        if(validationPattern != null) {
103                            Pattern pattern = Pattern.compile(validationPattern);
104                            Matcher m = pattern.matcher(alias);
105                            
106                            if(!m.matches()) {
107                                addExecutionError(ExecutionErrors.InvalidAlias.name(), alias);
108                            }
109                        }
110                        
111                        if(!hasExecutionErrors()) {
112                            ItemAliasChecksumTypeLogic.getInstance().checkItemAliasChecksum(this, itemAliasType, alias);
113
114                            if(!hasExecutionErrors()) {
115                                if(!itemAliasTypeDetail.getAllowMultiple()) {
116                                    if(itemControl.countItemAliases(item, unitOfMeasureType, itemAliasType) != 0) {
117                                        addExecutionError(ExecutionErrors.MultipleItemAliasesNotAllowed.name(), itemName, unitOfMeasureTypeName, itemAliasTypeName);
118                                    }
119                                }
120
121                                if(!hasExecutionErrors()) {
122                                    Item duplicateItem = itemControl.getItemByName(alias);
123
124                                    if(duplicateItem == null) {
125                                        ItemAlias itemAlias = itemControl.getItemAliasByAlias(alias);
126
127                                        if(itemAlias == null) {
128                                            itemControl.createItemAlias(item, unitOfMeasureType, itemAliasType, alias, getPartyPK());
129                                        } else {
130                                            addExecutionError(ExecutionErrors.DuplicateItemAlias.name(), itemAlias.getItem().getLastDetail().getItemName(),
131                                                    itemAlias.getUnitOfMeasureType().getLastDetail().getUnitOfMeasureTypeName(), itemAlias.getAlias());
132                                        }
133                                    } else {
134                                        addExecutionError(ExecutionErrors.AliasDuplicatesItemName.name(), duplicateItem.getLastDetail().getItemName());
135                                    }
136                                }
137                            }
138                        }
139                    } else {
140                        addExecutionError(ExecutionErrors.UnknownItemAliasType.name(), itemAliasTypeName);
141                    }
142                } else {
143                    addExecutionError(ExecutionErrors.UnknownItemUnitOfMeasureType.name(), itemName, unitOfMeasureTypeName);
144                }
145            } else {
146                addExecutionError(ExecutionErrors.UnknownUnitOfMeasureTypeName.name(), unitOfMeasureTypeName);
147            }
148        } else {
149            addExecutionError(ExecutionErrors.UnknownItemName.name(), itemName);
150        }
151        
152        return null;
153    }
154    
155}