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.form.GetContentPageDescriptionForm;
020import com.echothree.control.user.content.common.result.ContentResultFactory;
021import com.echothree.model.control.content.server.control.ContentControl;
022import com.echothree.model.control.party.common.PartyTypes;
023import com.echothree.model.control.party.server.control.PartyControl;
024import com.echothree.model.control.security.common.SecurityRoleGroups;
025import com.echothree.model.control.security.common.SecurityRoles;
026import com.echothree.model.data.user.common.pk.UserVisitPK;
027import com.echothree.util.common.message.ExecutionErrors;
028import com.echothree.util.common.validation.FieldDefinition;
029import com.echothree.util.common.validation.FieldType;
030import com.echothree.util.common.command.BaseResult;
031import com.echothree.util.server.control.BaseSimpleCommand;
032import com.echothree.util.server.control.CommandSecurityDefinition;
033import com.echothree.util.server.control.PartyTypeDefinition;
034import com.echothree.util.server.control.SecurityRoleDefinition;
035import java.util.List;
036import javax.enterprise.context.Dependent;
037import javax.inject.Inject;
038
039@Dependent
040public class GetContentPageDescriptionCommand
041        extends BaseSimpleCommand<GetContentPageDescriptionForm> {
042    
043    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
044    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
045    
046    static {
047        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
048                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
049                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
050                        new SecurityRoleDefinition(SecurityRoleGroups.ContentPage.name(), SecurityRoles.Description.name())
051                ))
052        ));
053        
054        FORM_FIELD_DEFINITIONS = List.of(
055                new FieldDefinition("ContentCollectionName", FieldType.ENTITY_NAME, true, null, null),
056                new FieldDefinition("ContentSectionName", FieldType.ENTITY_NAME, true, null, null),
057                new FieldDefinition("ContentPageName", FieldType.ENTITY_NAME, true, null, null),
058                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
059        );
060    }
061
062    @Inject
063    ContentControl contentControl;
064
065    @Inject
066    PartyControl partyControl;
067
068    
069    /** Creates a new instance of GetContentPageDescriptionCommand */
070    public GetContentPageDescriptionCommand() {
071        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
072    }
073    
074    @Override
075    protected BaseResult execute() {
076        var result = ContentResultFactory.getGetContentPageDescriptionResult();
077        var contentCollectionName = form.getContentCollectionName();
078        var contentCollection = contentControl.getContentCollectionByName(contentCollectionName);
079        
080        if(contentCollection != null) {
081            var contentSectionName = form.getContentSectionName();
082            var contentSection = contentControl.getContentSectionByName(contentCollection, contentSectionName);
083            
084            if(contentSection != null) {
085                var contentPageName = form.getContentPageName();
086                var contentPage = contentControl.getContentPageByName(contentSection, contentPageName);
087                
088                if(contentPage != null) {
089                    var languageIsoName = form.getLanguageIsoName();
090                    var language = partyControl.getLanguageByIsoName(languageIsoName);
091                    
092                    if(language != null) {
093                        var contentPageDescription = contentControl.getContentPageDescription(contentPage, language);
094                        
095                        if(contentPageDescription != null) {
096                            result.setContentPageDescription(contentControl.getContentPageDescriptionTransfer(getUserVisit(), contentPageDescription));
097                        } else {
098                            addExecutionError(ExecutionErrors.UnknownContentPageDescription.name(), contentCollectionName, contentSectionName, contentPageName,
099                                    languageIsoName);
100                        }
101                    } else {
102                        addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
103                    }
104                } else {
105                    addExecutionError(ExecutionErrors.UnknownContentPageName.name(), contentCollectionName, contentSectionName, contentPageName);
106                }
107            } else {
108                addExecutionError(ExecutionErrors.UnknownContentSectionName.name(), contentCollectionName, contentSectionName);
109            }
110        } else {
111            addExecutionError(ExecutionErrors.UnknownContentCollectionName.name(), contentCollectionName);
112        }
113        
114        return result;
115    }
116    
117}