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.GetContentCatalogDescriptionForm;
020import com.echothree.control.user.content.common.result.ContentResultFactory;
021import com.echothree.control.user.content.common.result.GetContentCatalogDescriptionResult;
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.ContentCatalog;
028import com.echothree.model.data.content.server.entity.ContentCatalogDescription;
029import com.echothree.model.data.content.server.entity.ContentCollection;
030import com.echothree.model.data.party.server.entity.Language;
031import com.echothree.model.data.user.common.pk.UserVisitPK;
032import com.echothree.util.common.message.ExecutionErrors;
033import com.echothree.util.common.validation.FieldDefinition;
034import com.echothree.util.common.validation.FieldType;
035import com.echothree.util.common.command.BaseResult;
036import com.echothree.util.server.control.BaseSimpleCommand;
037import com.echothree.util.server.control.CommandSecurityDefinition;
038import com.echothree.util.server.control.PartyTypeDefinition;
039import com.echothree.util.server.control.SecurityRoleDefinition;
040import com.echothree.util.server.persistence.Session;
041import java.util.Arrays;
042import java.util.Collections;
043import java.util.List;
044
045public class GetContentCatalogDescriptionCommand
046        extends BaseSimpleCommand<GetContentCatalogDescriptionForm> {
047    
048    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
049    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
050    
051    static {
052        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
053                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
054                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
055                        new SecurityRoleDefinition(SecurityRoleGroups.ContentCatalog.name(), SecurityRoles.Description.name())
056                        )))
057                )));
058        
059        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
060                new FieldDefinition("ContentCollectionName", FieldType.ENTITY_NAME, true, null, null),
061                new FieldDefinition("ContentCatalogName", FieldType.ENTITY_NAME, true, null, null),
062                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
063                ));
064    }
065    
066    /** Creates a new instance of GetContentCatalogDescriptionCommand */
067    public GetContentCatalogDescriptionCommand(UserVisitPK userVisitPK, GetContentCatalogDescriptionForm form) {
068        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
069    }
070    
071    @Override
072    protected BaseResult execute() {
073        GetContentCatalogDescriptionResult result = ContentResultFactory.getGetContentCatalogDescriptionResult();
074        var contentControl = Session.getModelController(ContentControl.class);
075        String contentCollectionName = form.getContentCollectionName();
076        ContentCollection contentCollection = contentControl.getContentCollectionByName(contentCollectionName);
077        
078        if(contentCollection != null) {
079            String contentCatalogName = form.getContentCatalogName();
080            ContentCatalog contentCatalog = contentControl.getContentCatalogByName(contentCollection, contentCatalogName);
081            
082            if(contentCatalog != null) {
083                var partyControl = Session.getModelController(PartyControl.class);
084                String languageIsoName = form.getLanguageIsoName();
085                Language language = partyControl.getLanguageByIsoName(languageIsoName);
086
087                if(language != null) {
088                    ContentCatalogDescription contentCatalogDescription = contentControl.getContentCatalogDescription(contentCatalog, language);
089
090                    if(contentCatalogDescription != null) {
091                        result.setContentCatalogDescription(contentControl.getContentCatalogDescriptionTransfer(getUserVisit(), contentCatalogDescription));
092                    } else {
093                        addExecutionError(ExecutionErrors.UnknownContentCatalogDescription.name(), contentCollectionName, contentCatalogName, contentCatalogName,
094                                languageIsoName);
095                    }
096                } else {
097                    addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
098                }
099            } else {
100                addExecutionError(ExecutionErrors.UnknownContentCatalogName.name(), contentCollectionName, contentCatalogName);
101            }
102        } else {
103            addExecutionError(ExecutionErrors.UnknownContentCollectionName.name(), contentCollectionName);
104        }
105        
106        return result;
107    }
108    
109}