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.geo.server.command;
018
019import com.echothree.control.user.geo.common.edit.GeoCodeAliasEdit;
020import com.echothree.control.user.geo.common.edit.GeoEditFactory;
021import com.echothree.control.user.geo.common.form.EditGeoCodeAliasForm;
022import com.echothree.control.user.geo.common.result.EditGeoCodeAliasResult;
023import com.echothree.control.user.geo.common.result.GeoResultFactory;
024import com.echothree.control.user.geo.common.spec.GeoCodeAliasSpec;
025import com.echothree.model.control.geo.server.control.GeoControl;
026import com.echothree.model.control.party.common.PartyTypes;
027import com.echothree.model.control.security.common.SecurityRoleGroups;
028import com.echothree.model.control.security.common.SecurityRoles;
029import com.echothree.model.data.geo.server.entity.GeoCode;
030import com.echothree.model.data.geo.server.entity.GeoCodeAlias;
031import com.echothree.model.data.geo.server.entity.GeoCodeAliasType;
032import com.echothree.model.data.geo.server.entity.GeoCodeScope;
033import com.echothree.model.data.geo.server.entity.GeoCodeType;
034import com.echothree.model.data.geo.server.value.GeoCodeAliasValue;
035import com.echothree.model.data.user.common.pk.UserVisitPK;
036import com.echothree.util.common.message.ExecutionErrors;
037import com.echothree.util.common.validation.FieldDefinition;
038import com.echothree.util.common.validation.FieldType;
039import com.echothree.util.common.command.EditMode;
040import com.echothree.util.server.control.BaseAbstractEditCommand;
041import com.echothree.util.server.control.CommandSecurityDefinition;
042import com.echothree.util.server.control.PartyTypeDefinition;
043import com.echothree.util.server.control.SecurityRoleDefinition;
044import com.echothree.util.server.persistence.Session;
045import java.util.Arrays;
046import java.util.Collections;
047import java.util.List;
048import java.util.regex.Matcher;
049import java.util.regex.Pattern;
050
051public class EditGeoCodeAliasCommand
052        extends BaseAbstractEditCommand<GeoCodeAliasSpec, GeoCodeAliasEdit, EditGeoCodeAliasResult, GeoCodeAlias, GeoCodeAlias> {
053    
054    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
055    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
056    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
057    
058    static {
059        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
060                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
061                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
062                        new SecurityRoleDefinition(SecurityRoleGroups.GeoCodeAlias.name(), SecurityRoles.Edit.name())
063                        )))
064                )));
065
066        SPEC_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
067                new FieldDefinition("GeoCodeName", FieldType.ENTITY_NAME, true, null, null),
068                new FieldDefinition("GeoCodeAliasTypeName", FieldType.ENTITY_NAME, true, null, null)
069                ));
070        
071        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
072                new FieldDefinition("Alias", FieldType.ENTITY_NAME, true, null, null)
073                ));
074    }
075    
076    /** Creates a new instance of EditGeoCodeAliasCommand */
077    public EditGeoCodeAliasCommand(UserVisitPK userVisitPK, EditGeoCodeAliasForm form) {
078        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
079    }
080    
081    @Override
082    public EditGeoCodeAliasResult getResult() {
083        return GeoResultFactory.getEditGeoCodeAliasResult();
084    }
085
086    @Override
087    public GeoCodeAliasEdit getEdit() {
088        return GeoEditFactory.getGeoCodeAliasEdit();
089    }
090
091    GeoCode geoCode;
092    GeoCodeAliasType geoCodeAliasType;
093    
094    @Override
095    public GeoCodeAlias getEntity(EditGeoCodeAliasResult result) {
096        var geoControl = Session.getModelController(GeoControl.class);
097        GeoCodeAlias geoCodeAlias = null;
098        String geoCodeName = spec.getGeoCodeName();
099
100        geoCode = geoControl.getGeoCodeByName(geoCodeName);
101
102        if(geoCode != null) {
103            GeoCodeType geoCodeType = geoCode.getLastDetail().getGeoCodeType();
104            String geoCodeAliasTypeName = spec.getGeoCodeAliasTypeName();
105
106            geoCodeAliasType = geoControl.getGeoCodeAliasTypeByNameForUpdate(geoCodeType, geoCodeAliasTypeName);
107
108            if(geoCodeAliasType != null) {
109                if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
110                    geoCodeAlias = geoControl.getGeoCodeAlias(geoCode, geoCodeAliasType);
111                } else { // EditMode.UPDATE
112                    geoCodeAlias = geoControl.getGeoCodeAliasForUpdate(geoCode, geoCodeAliasType);
113                }
114
115                if(geoCodeAlias != null) {
116                    result.setGeoCodeAlias(geoControl.getGeoCodeAliasTransfer(getUserVisit(), geoCodeAlias));
117                } else {
118                    addExecutionError(ExecutionErrors.UnknownGeoCodeAlias.name(), geoCodeName, geoCodeAliasTypeName);
119                }
120            } else {
121                addExecutionError(ExecutionErrors.UnknownGeoCodeAliasTypeName.name(), geoCodeType.getLastDetail().getGeoCodeTypeName(), geoCodeAliasTypeName);
122            }
123        } else {
124            addExecutionError(ExecutionErrors.UnknownGeoCodeName.name(), geoCodeName);
125        }
126
127        return geoCodeAlias;
128    }
129
130    @Override
131    public GeoCodeAlias getLockEntity(GeoCodeAlias geoCodeAlias) {
132        return geoCodeAlias;
133    }
134
135    @Override
136    public void fillInResult(EditGeoCodeAliasResult result, GeoCodeAlias geoCodeAlias) {
137        var geoControl = Session.getModelController(GeoControl.class);
138
139        result.setGeoCodeAlias(geoControl.getGeoCodeAliasTransfer(getUserVisit(), geoCodeAlias));
140    }
141
142    @Override
143    public void doLock(GeoCodeAliasEdit edit, GeoCodeAlias geoCodeAlias) {
144        edit.setAlias(geoCodeAlias.getAlias());
145    }
146
147    @Override
148    public void canUpdate(GeoCodeAlias geoCodeAlias) {
149        var geoControl = Session.getModelController(GeoControl.class);
150        GeoCodeScope geoCodeScope = geoCode.getLastDetail().getGeoCodeScope();
151        String alias = edit.getAlias();
152        GeoCodeAlias duplicateGeoCodeAlias = geoControl.getGeoCodeAliasByAliasWithinScope(geoCodeScope, geoCodeAliasType, alias);
153
154        if(duplicateGeoCodeAlias != null && !geoCodeAlias.equals(duplicateGeoCodeAlias)) {
155            addExecutionError(ExecutionErrors.DuplicateGeoCodeAlias.name(), geoCode.getLastDetail().getGeoCodeName(),
156                    geoCodeScope.getLastDetail().getGeoCodeScopeName(), geoCodeAliasType.getLastDetail().getGeoCodeAliasTypeName(), alias);
157        } else {
158            String validationPattern = geoCodeAliasType.getLastDetail().getValidationPattern();
159
160            if(validationPattern != null) {
161                Pattern pattern = Pattern.compile(validationPattern);
162                Matcher m = pattern.matcher(alias);
163
164                if(!m.matches()) {
165                    addExecutionError(ExecutionErrors.InvalidAlias.name(), alias);
166                }
167            }
168        }
169    }
170
171    @Override
172    public void doUpdate(GeoCodeAlias geoCodeAlias) {
173        var geoControl = Session.getModelController(GeoControl.class);
174        GeoCodeAliasValue geoCodeAliasValue = geoControl.getGeoCodeAliasValue(geoCodeAlias);
175
176        geoCodeAliasValue.setAlias(edit.getAlias());
177
178        geoControl.updateGeoCodeAliasFromValue(geoCodeAliasValue, getPartyPK());
179    }
180
181}