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