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.GetContentSectionForm;
020import com.echothree.control.user.content.common.result.ContentResultFactory;
021import com.echothree.model.control.associate.server.logic.AssociateReferralLogic;
022import com.echothree.model.control.content.server.control.ContentControl;
023import com.echothree.model.control.core.common.EventTypes;
024import com.echothree.model.data.content.server.entity.ContentCollection;
025import com.echothree.model.data.content.server.entity.ContentSection;
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.BaseSingleEntityCommand;
032import java.util.List;
033import javax.enterprise.context.Dependent;
034import javax.inject.Inject;
035
036@Dependent
037public class GetContentSectionCommand
038        extends BaseSingleEntityCommand<ContentSection, GetContentSectionForm> {
039    
040    // No COMMAND_SECURITY_DEFINITION, anyone may execute this command.
041    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
042    
043    static {
044        FORM_FIELD_DEFINITIONS = List.of(
045                new FieldDefinition("ContentWebAddressName", FieldType.HOST_NAME, false, null, null),
046                new FieldDefinition("ContentCollectionName", FieldType.ENTITY_NAME, false, null, null),
047                new FieldDefinition("ContentSectionName", FieldType.ENTITY_NAME, false, null, null),
048                new FieldDefinition("AssociateProgramName", FieldType.STRING, false, null, null),
049                new FieldDefinition("AssociateName", FieldType.STRING, false, null, null),
050                new FieldDefinition("AssociatePartyContactMechanismName", FieldType.STRING, false, null, null)
051        );
052    }
053
054    @Inject
055    ContentControl contentControl;
056
057    @Inject
058    AssociateReferralLogic associateReferralLogic;
059
060    
061    /** Creates a new instance of GetContentSectionCommand */
062    public GetContentSectionCommand() {
063        super(null, FORM_FIELD_DEFINITIONS, true);
064    }
065    
066    @Override
067    protected ContentSection getEntity() {
068        var contentWebAddressName = form.getContentWebAddressName();
069        var contentCollectionName = form.getContentCollectionName();
070        var parameterCount = (contentWebAddressName == null ? 0 : 1) + (contentCollectionName == null ? 0 : 1);
071        ContentSection contentSection = null;
072
073        if(parameterCount == 1) {
074            ContentCollection contentCollection = null;
075
076            if(contentWebAddressName != null) {
077                var contentWebAddress = contentControl.getContentWebAddressByName(contentWebAddressName);
078
079                if(contentWebAddress != null) {
080                    contentCollection = contentWebAddress.getLastDetail().getContentCollection();
081                } else {
082                    addExecutionError(ExecutionErrors.UnknownContentWebAddressName.name(), contentWebAddressName);
083                }
084            } else {
085                contentCollection = contentControl.getContentCollectionByName(contentCollectionName);
086
087                if(contentCollection == null) {
088                    addExecutionError(ExecutionErrors.UnknownContentCollectionName.name(), contentCollectionName);
089                }
090            }
091
092            if(!hasExecutionErrors()) {
093                var contentSectionName = form.getContentSectionName();
094                var partyPK = getPartyPK();
095                var userVisit = getUserVisitForUpdate();
096
097                contentSection = contentSectionName == null ? contentControl.getDefaultContentSection(contentCollection)
098                        : contentControl.getContentSectionByName(contentCollection, contentSectionName);
099
100                if(contentSection != null) {
101                    associateReferralLogic.handleAssociateReferral(session, this, form, userVisit, contentSection.getPrimaryKey(), partyPK);
102
103                    if(!hasExecutionErrors()) {
104                        sendEvent(contentSection.getPrimaryKey(), EventTypes.READ, null, null, partyPK);
105                    }
106                } else {
107                    addExecutionError(ExecutionErrors.UnknownContentSectionName.name(), contentCollection.getLastDetail().getContentCollectionName(), contentSectionName);
108                }
109            }
110        } else {
111            addExecutionError(ExecutionErrors.InvalidParameterCount.name());
112        }
113        
114        return contentSection;
115    }
116    
117    @Override
118    protected BaseResult getResult(ContentSection contentSection) {
119        var result = ContentResultFactory.getGetContentSectionResult();
120        
121        if(contentSection != null) {
122            result.setContentSection(contentControl.getContentSectionTransfer(getUserVisit(), contentSection));
123        }
124        
125        return result;
126    }
127}