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.GetContentCatalogForm;
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.ContentCatalog;
025import com.echothree.model.data.content.server.entity.ContentCollection;
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 com.echothree.util.server.persistence.Session;
033import java.util.List;
034import javax.enterprise.context.Dependent;
035
036@Dependent
037public class GetContentCatalogCommand
038        extends BaseSingleEntityCommand<ContentCatalog, GetContentCatalogForm> {
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("ContentCatalogName", 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    /** Creates a new instance of GetContentCatalogCommand */
055    public GetContentCatalogCommand() {
056        super(null, FORM_FIELD_DEFINITIONS, true);
057    }
058    
059    @Override
060    protected ContentCatalog getEntity() {
061        var contentWebAddressName = form.getContentWebAddressName();
062        var contentCollectionName = form.getContentCollectionName();
063        var parameterCount = (contentWebAddressName == null ? 0 : 1) + (contentCollectionName == null ? 0 : 1);
064        ContentCatalog contentCatalog = null;
065
066        if(parameterCount == 1) {
067            var contentControl = Session.getModelController(ContentControl.class);
068            ContentCollection contentCollection = null;
069
070            if(contentWebAddressName != null) {
071                var contentWebAddress = contentControl.getContentWebAddressByName(contentWebAddressName);
072
073                if(contentWebAddress != null) {
074                    contentCollection = contentWebAddress.getLastDetail().getContentCollection();
075                } else {
076                    addExecutionError(ExecutionErrors.UnknownContentWebAddressName.name(), contentWebAddressName);
077                }
078            } else {
079                contentCollection = contentControl.getContentCollectionByName(contentCollectionName);
080
081                if(contentCollection == null) {
082                    addExecutionError(ExecutionErrors.UnknownContentCollectionName.name(), contentCollectionName);
083                }
084            }
085
086            if(!hasExecutionErrors()) {
087                var contentCatalogName = form.getContentCatalogName();
088                var partyPK = getPartyPK();
089                
090                contentCatalog = contentCatalogName == null ? contentControl.getDefaultContentCatalog(contentCollection)
091                        : contentControl.getContentCatalogByName(contentCollection, contentCatalogName);
092
093                if(contentCatalog != null) {
094                    AssociateReferralLogic.getInstance().handleAssociateReferral(session, this, form, getUserVisitForUpdate(),
095                            contentCatalog.getPrimaryKey(), partyPK);
096
097                    if(!hasExecutionErrors()) {
098                        sendEvent(contentCatalog.getPrimaryKey(), EventTypes.READ, null, null, partyPK);
099                    }
100                } else {
101                    addExecutionError(ExecutionErrors.UnknownContentCatalogName.name(),
102                            contentCollection.getLastDetail().getContentCollectionName(), contentCatalogName);
103                }
104            }
105        } else {
106            addExecutionError(ExecutionErrors.InvalidParameterCount.name());
107        }
108
109        return contentCatalog;
110    }
111    
112    @Override
113    protected BaseResult getResult(ContentCatalog contentCatalog) {
114        var result = ContentResultFactory.getGetContentCatalogResult();
115
116        if(contentCatalog != null) {
117            var contentControl = Session.getModelController(ContentControl.class);
118
119            result.setContentCatalog(contentControl.getContentCatalogTransfer(getUserVisit(), contentCatalog));
120        }
121
122        return result;
123    }
124
125}