001// --------------------------------------------------------------------------------
002// Copyright 2002-2026 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.content.server.command;
018
019import com.echothree.control.user.content.common.edit.ContentEditFactory;
020import com.echothree.control.user.content.common.edit.ContentWebAddressDescriptionEdit;
021import com.echothree.control.user.content.common.form.EditContentWebAddressDescriptionForm;
022import com.echothree.control.user.content.common.result.ContentResultFactory;
023import com.echothree.control.user.content.common.result.EditContentWebAddressDescriptionResult;
024import com.echothree.control.user.content.common.spec.ContentWebAddressDescriptionSpec;
025import com.echothree.model.control.content.server.control.ContentControl;
026import com.echothree.model.control.party.common.PartyTypes;
027import com.echothree.model.control.party.server.control.PartyControl;
028import com.echothree.model.control.security.common.SecurityRoleGroups;
029import com.echothree.model.control.security.common.SecurityRoles;
030import com.echothree.model.data.content.server.entity.ContentWebAddress;
031import com.echothree.model.data.content.server.entity.ContentWebAddressDescription;
032import com.echothree.model.data.user.common.pk.UserVisitPK;
033import com.echothree.util.common.message.ExecutionErrors;
034import com.echothree.util.common.validation.FieldDefinition;
035import com.echothree.util.common.validation.FieldType;
036import com.echothree.util.common.command.EditMode;
037import com.echothree.util.server.control.BaseAbstractEditCommand;
038import com.echothree.util.server.control.CommandSecurityDefinition;
039import com.echothree.util.server.control.PartyTypeDefinition;
040import com.echothree.util.server.control.SecurityRoleDefinition;
041import java.util.List;
042import javax.enterprise.context.Dependent;
043import javax.inject.Inject;
044
045@Dependent
046public class EditContentWebAddressDescriptionCommand
047        extends BaseAbstractEditCommand<ContentWebAddressDescriptionSpec, ContentWebAddressDescriptionEdit, EditContentWebAddressDescriptionResult, ContentWebAddressDescription, ContentWebAddress> {
048    
049    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
050    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
051    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
052    
053    static {
054        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
055                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
056                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
057                        new SecurityRoleDefinition(SecurityRoleGroups.ContentWebAddress.name(), SecurityRoles.Description.name())
058                ))
059        ));
060        
061        SPEC_FIELD_DEFINITIONS = List.of(
062                new FieldDefinition("ContentWebAddressName", FieldType.HOST_NAME, true, null, null),
063                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
064        );
065        
066        EDIT_FIELD_DEFINITIONS = List.of(
067                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
068        );
069    }
070
071    @Inject
072    ContentControl contentControl;
073
074    @Inject
075    PartyControl partyControl;
076
077    
078    /** Creates a new instance of EditContentWebAddressDescriptionCommand */
079    public EditContentWebAddressDescriptionCommand() {
080        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
081    }
082    
083    @Override
084    public EditContentWebAddressDescriptionResult getResult() {
085        return ContentResultFactory.getEditContentWebAddressDescriptionResult();
086    }
087    
088    @Override
089    public ContentWebAddressDescriptionEdit getEdit() {
090        return ContentEditFactory.getContentWebAddressDescriptionEdit();
091    }
092    
093    @Override
094    public ContentWebAddressDescription getEntity(EditContentWebAddressDescriptionResult result) {
095        ContentWebAddressDescription contentWebAddressDescription = null;
096        var contentWebAddressName = spec.getContentWebAddressName();
097        var contentWebAddress = contentControl.getContentWebAddressByName(contentWebAddressName);
098        
099        if(contentWebAddress != null) {
100            var languageIsoName = spec.getLanguageIsoName();
101            var language = partyControl.getLanguageByIsoName(languageIsoName);
102
103            result.setContentWebAddress(contentControl.getContentWebAddressTransfer(getUserVisit(), contentWebAddress));
104
105            if(language != null) {
106                if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
107                    contentWebAddressDescription = contentControl.getContentWebAddressDescription(contentWebAddress, language);
108                } else { // EditMode.UPDATE
109                    contentWebAddressDescription = contentControl.getContentWebAddressDescriptionForUpdate(contentWebAddress, language);
110                }
111
112                if(contentWebAddressDescription == null) {
113                    addExecutionError(ExecutionErrors.UnknownContentWebAddressDescription.name());
114                }
115            } else {
116                addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
117            }
118        } else {
119            addExecutionError(ExecutionErrors.UnknownContentWebAddressName.name(), contentWebAddressName);
120        }
121
122        return contentWebAddressDescription;
123    }
124    
125    @Override
126    public ContentWebAddress getLockEntity(ContentWebAddressDescription contentWebAddressDescription) {
127        return contentWebAddressDescription.getContentWebAddress();
128    }
129    
130    @Override
131    public void fillInResult(EditContentWebAddressDescriptionResult result, ContentWebAddressDescription contentWebAddressDescription) {
132        result.setContentWebAddressDescription(contentControl.getContentWebAddressDescriptionTransfer(getUserVisit(), contentWebAddressDescription));
133    }
134    
135    @Override
136    public void doLock(ContentWebAddressDescriptionEdit edit, ContentWebAddressDescription contentWebAddressDescription) {
137        edit.setDescription(contentWebAddressDescription.getDescription());
138    }
139    
140    @Override
141    public void doUpdate(ContentWebAddressDescription contentWebAddressDescription) {
142        var contentWebAddressDescriptionValue = contentControl.getContentWebAddressDescriptionValue(contentWebAddressDescription);
143        contentWebAddressDescriptionValue.setDescription(edit.getDescription());
144
145        contentControl.updateContentWebAddressDescriptionFromValue(contentWebAddressDescriptionValue, getPartyPK());
146    }
147    
148}