001// --------------------------------------------------------------------------------
002// Copyright 2002-2025 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.geo.server.command;
018
019import com.echothree.control.user.geo.common.form.CreateGeoCodeAliasForm;
020import com.echothree.model.control.geo.server.control.GeoControl;
021import com.echothree.model.control.party.common.PartyTypes;
022import com.echothree.model.control.security.common.SecurityRoleGroups;
023import com.echothree.model.control.security.common.SecurityRoles;
024import com.echothree.model.data.user.common.pk.UserVisitPK;
025import com.echothree.util.common.message.ExecutionErrors;
026import com.echothree.util.common.validation.FieldDefinition;
027import com.echothree.util.common.validation.FieldType;
028import com.echothree.util.common.command.BaseResult;
029import com.echothree.util.server.control.BaseSimpleCommand;
030import com.echothree.util.server.control.CommandSecurityDefinition;
031import com.echothree.util.server.control.PartyTypeDefinition;
032import com.echothree.util.server.control.SecurityRoleDefinition;
033import com.echothree.util.server.persistence.Session;
034import java.util.Arrays;
035import java.util.Collections;
036import java.util.List;
037import java.util.regex.Pattern;
038import javax.enterprise.context.RequestScoped;
039
040@RequestScoped
041public class CreateGeoCodeAliasCommand
042        extends BaseSimpleCommand<CreateGeoCodeAliasForm> {
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(Collections.unmodifiableList(Arrays.asList(
049                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
050                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
051                        new SecurityRoleDefinition(SecurityRoleGroups.GeoCodeAlias.name(), SecurityRoles.Create.name())
052                        )))
053                )));
054        
055        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
056                new FieldDefinition("GeoCodeName", FieldType.ENTITY_NAME, true, null, null),
057                new FieldDefinition("GeoCodeAliasTypeName", FieldType.ENTITY_NAME, true, null, null),
058                new FieldDefinition("Alias", FieldType.ENTITY_NAME, true, null, null)
059                ));
060    }
061    
062    /** Creates a new instance of CreateGeoCodeAliasCommand */
063    public CreateGeoCodeAliasCommand() {
064        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
065    }
066    
067    @Override
068    protected BaseResult execute() {
069        var geoControl = Session.getModelController(GeoControl.class);
070        var geoCodeName = form.getGeoCodeName();
071        var geoCode = geoControl.getGeoCodeByName(geoCodeName);
072
073        if(geoCode != null) {
074            var geoCodeType = geoCode.getLastDetail().getGeoCodeType();
075            var geoCodeAliasTypeName = form.getGeoCodeAliasTypeName();
076            var geoCodeAliasType = geoControl.getGeoCodeAliasTypeByNameForUpdate(geoCodeType, geoCodeAliasTypeName);
077
078            if(geoCodeAliasType != null) {
079                var geoCodeScope = geoCode.getLastDetail().getGeoCodeScope();
080                var geoCodeAlias = geoControl.getGeoCodeAliasForUpdate(geoCode, geoCodeAliasType);
081                var alias = form.getAlias();
082
083                if(geoCodeAlias == null) {
084                    geoCodeAlias = geoControl.getGeoCodeAliasByAliasWithinScope(geoCodeScope, geoCodeAliasType, alias);
085
086                    if(geoCodeAlias == null) {
087                        var validationPattern = geoCodeAliasType.getLastDetail().getValidationPattern();
088
089                        if(validationPattern != null) {
090                            var pattern = Pattern.compile(validationPattern);
091                            var m = pattern.matcher(alias);
092
093                            if(!m.matches()) {
094                                addExecutionError(ExecutionErrors.InvalidAlias.name(), alias);
095                            }
096                        }
097
098                        if(!hasExecutionErrors()) {
099                            geoControl.createGeoCodeAlias(geoCode, geoCodeAliasType, alias, getPartyPK());
100                        }
101                    } else {
102                        addExecutionError(ExecutionErrors.DuplicateGeoCodeAlias.name(), geoCodeName, geoCodeScope.getLastDetail().getGeoCodeScopeName(), geoCodeAliasTypeName, alias);
103                    }
104                } else {
105                    addExecutionError(ExecutionErrors.DuplicateGeoCodeAlias.name(), geoCodeName, geoCodeScope.getLastDetail().getGeoCodeScopeName(), geoCodeAliasTypeName, alias);
106                }
107            } else {
108                addExecutionError(ExecutionErrors.UnknownGeoCodeAliasTypeName.name(), geoCodeType.getLastDetail().getGeoCodeTypeName(), geoCodeAliasTypeName);
109            }
110        } else {
111            addExecutionError(ExecutionErrors.UnknownGeoCodeName.name(), geoCodeName);
112        }
113        
114        return null;
115    }
116    
117}