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.content.server.command;
018
019import com.echothree.control.user.content.common.form.GetContentWebAddressDescriptionForm;
020import com.echothree.control.user.content.common.result.ContentResultFactory;
021import com.echothree.control.user.content.common.result.GetContentWebAddressDescriptionResult;
022import com.echothree.model.control.content.server.control.ContentControl;
023import com.echothree.model.control.party.common.PartyTypes;
024import com.echothree.model.control.party.server.control.PartyControl;
025import com.echothree.model.control.security.common.SecurityRoleGroups;
026import com.echothree.model.control.security.common.SecurityRoles;
027import com.echothree.model.data.content.server.entity.ContentWebAddress;
028import com.echothree.model.data.content.server.entity.ContentWebAddressDescription;
029import com.echothree.model.data.party.server.entity.Language;
030import com.echothree.model.data.user.common.pk.UserVisitPK;
031import com.echothree.util.common.message.ExecutionErrors;
032import com.echothree.util.common.validation.FieldDefinition;
033import com.echothree.util.common.validation.FieldType;
034import com.echothree.util.common.command.BaseResult;
035import com.echothree.util.server.control.BaseSimpleCommand;
036import com.echothree.util.server.control.CommandSecurityDefinition;
037import com.echothree.util.server.control.PartyTypeDefinition;
038import com.echothree.util.server.control.SecurityRoleDefinition;
039import com.echothree.util.server.persistence.Session;
040import java.util.Arrays;
041import java.util.Collections;
042import java.util.List;
043
044public class GetContentWebAddressDescriptionCommand
045        extends BaseSimpleCommand<GetContentWebAddressDescriptionForm> {
046    
047    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
048    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
049    
050    static {
051        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
052                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
053                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
054                        new SecurityRoleDefinition(SecurityRoleGroups.ContentWebAddress.name(), SecurityRoles.Description.name())
055                        )))
056                )));
057        
058        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
059                new FieldDefinition("ContentWebAddressName", FieldType.HOST_NAME, true, null, null),
060                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
061                ));
062    }
063    
064    /** Creates a new instance of GetContentWebAddressDescriptionCommand */
065    public GetContentWebAddressDescriptionCommand(UserVisitPK userVisitPK, GetContentWebAddressDescriptionForm form) {
066        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
067    }
068    
069    @Override
070    protected BaseResult execute() {
071        GetContentWebAddressDescriptionResult result = ContentResultFactory.getGetContentWebAddressDescriptionResult();
072        var contentControl = Session.getModelController(ContentControl.class);
073        String contentWebAddressName = form.getContentWebAddressName();
074        ContentWebAddress contentWebAddress = contentControl.getContentWebAddressByName(contentWebAddressName);
075        
076        if(contentWebAddress != null) {
077            var partyControl = Session.getModelController(PartyControl.class);
078            String languageIsoName = form.getLanguageIsoName();
079            Language language = partyControl.getLanguageByIsoName(languageIsoName);
080
081            if(language != null) {
082                ContentWebAddressDescription contentWebAddressDescription = contentControl.getContentWebAddressDescription(contentWebAddress, language);
083
084                if(contentWebAddressDescription != null) {
085                    result.setContentWebAddressDescription(contentControl.getContentWebAddressDescriptionTransfer(getUserVisit(), contentWebAddressDescription));
086                } else {
087                    addExecutionError(ExecutionErrors.UnknownContentWebAddressDescription.name(), contentWebAddressName, contentWebAddressName, contentWebAddressName,
088                            languageIsoName);
089                }
090            } else {
091                addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
092            }
093        } else {
094            addExecutionError(ExecutionErrors.UnknownContentWebAddressName.name(), contentWebAddressName);
095        }
096        
097        return result;
098    }
099    
100}