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.item.server.command;
018
019import com.echothree.control.user.item.common.form.GetItemDescriptionForm;
020import com.echothree.control.user.item.common.result.ItemResultFactory;
021import com.echothree.model.control.content.server.logic.ContentLogic;
022import com.echothree.model.control.core.common.ComponentVendors;
023import com.echothree.model.control.core.common.EntityTypes;
024import com.echothree.model.control.core.server.logic.EntityInstanceLogic;
025import com.echothree.model.control.item.server.control.ItemControl;
026import com.echothree.model.control.item.server.logic.ItemDescriptionLogic;
027import com.echothree.model.control.item.server.logic.ItemDescriptionTypeLogic;
028import com.echothree.model.control.item.server.logic.ItemLogic;
029import com.echothree.model.control.party.server.control.PartyControl;
030import com.echothree.model.data.item.server.entity.ItemDescription;
031import com.echothree.model.data.item.server.entity.ItemDescriptionType;
032import com.echothree.model.data.user.common.pk.UserVisitPK;
033import com.echothree.util.common.command.BaseResult;
034import com.echothree.util.common.message.ExecutionErrors;
035import com.echothree.util.common.validation.FieldDefinition;
036import com.echothree.util.common.validation.FieldType;
037import com.echothree.util.server.control.BaseSingleEntityCommand;
038import com.echothree.util.server.persistence.Session;
039import com.echothree.util.server.validation.ParameterUtils;
040import java.util.List;
041
042public class GetItemDescriptionCommand
043        extends BaseSingleEntityCommand<ItemDescription, GetItemDescriptionForm> {
044
045    // No COMMAND_SECURITY_DEFINITION, anyone may execute this command.
046    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
047    
048    static {
049        FORM_FIELD_DEFINITIONS = List.of(
050                new FieldDefinition("ItemDescriptionTypeName", FieldType.ENTITY_NAME, false, null, null),
051                new FieldDefinition("ItemName", FieldType.ENTITY_NAME, false, null, null),
052                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, false, null, null),
053                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
054                new FieldDefinition("Key", FieldType.KEY, false, null, null),
055                new FieldDefinition("Guid", FieldType.GUID, false, null, null),
056                new FieldDefinition("Ulid", FieldType.ULID, false, null, null),
057                new FieldDefinition("Referrer", FieldType.URL, false, null, null)
058        );
059    }
060    
061    /** Creates a new instance of GetItemDescriptionCommand */
062    public GetItemDescriptionCommand(UserVisitPK userVisitPK, GetItemDescriptionForm form) {
063        super(userVisitPK, form, null, FORM_FIELD_DEFINITIONS, false);
064    }
065
066    private void checkReferrer(final ItemDescriptionType itemDescriptionType) {
067        if(itemDescriptionType.getLastDetail().getCheckContentWebAddress()) {
068            ContentLogic.getInstance().checkReferrer(this, form.getReferrer());
069        }
070    }
071
072    @Override
073    protected ItemDescription getEntity() {
074        var itemControl = Session.getModelController(ItemControl.class);
075        ItemDescription itemDescription = null;
076        var itemName = form.getItemName();
077        var itemDescriptionTypeName = form.getItemDescriptionTypeName();
078        var traditionalParameterCount = ParameterUtils.getInstance().countNonNullParameters(itemName, itemDescriptionTypeName);
079
080        if(traditionalParameterCount == 0 || traditionalParameterCount == 2) {
081            var possibleEntitySpecsCount = EntityInstanceLogic.getInstance().countPossibleEntitySpecs(form);
082
083            // checkReferrer(...) is called separately in the two paths since the first one can be short circuited if
084            // the referrer check fails.
085            if(traditionalParameterCount == 2 && possibleEntitySpecsCount == 0) {
086                var item = ItemLogic.getInstance().getItemByName(this, itemName);
087                var itemDescriptionType = ItemDescriptionTypeLogic.getInstance().getItemDescriptionTypeByName(this, itemDescriptionTypeName);
088
089                if(!hasExecutionErrors()) {
090                    checkReferrer(itemDescriptionType);
091
092                    if(!hasExecutionErrors()) {
093                        var partyControl = Session.getModelController(PartyControl.class);
094                        var languageIsoName = form.getLanguageIsoName();
095                        var language = languageIsoName == null ? getPreferredLanguage() : partyControl.getLanguageByIsoName(languageIsoName);
096
097                        if(languageIsoName == null || language != null) {
098                            itemDescription = itemControl.getItemDescription(itemDescriptionType, item, language);
099
100                            if(itemDescription == null) {
101                                itemDescription = ItemDescriptionLogic.getInstance().searchForItemDescription(itemDescriptionType,
102                                        item, language, getPartyPK());
103                            }
104
105                            if(itemDescription == null) {
106                                addExecutionError(ExecutionErrors.UnknownItemDescription.name(), itemDescriptionTypeName,
107                                        itemName, languageIsoName);
108                            }
109                        } else {
110                            addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
111                        }
112                    }
113                }
114            } else if(traditionalParameterCount == 0 && possibleEntitySpecsCount == 1) {
115                var entityInstance = EntityInstanceLogic.getInstance().getEntityInstance(this, form,
116                        ComponentVendors.ECHO_THREE.name(), EntityTypes.ItemDescription.name());
117
118                if(!hasExecutionErrors()) {
119                    itemDescription = itemControl.getItemDescriptionByEntityInstance(entityInstance);
120
121                    checkReferrer(itemDescription.getLastDetail().getItemDescriptionType());
122
123                    if(hasExecutionErrors()) {
124                        itemDescription = null; // pretend that didn't happen.
125                    }
126                }
127            } else {
128                addExecutionError(ExecutionErrors.InvalidParameterCount.name());
129            }
130        } else {
131            addExecutionError(ExecutionErrors.InvalidParameterCount.name());
132        }
133
134        return itemDescription;
135    }
136
137    @Override
138    protected BaseResult getResult(ItemDescription itemDescription) {
139        var itemControl = Session.getModelController(ItemControl.class);
140        var result = ItemResultFactory.getGetItemDescriptionResult();
141
142        if(itemDescription != null) {
143            result.setItemDescription(itemControl.getItemDescriptionTransfer(getUserVisit(), itemDescription));
144        }
145
146        return result;
147    }
148
149
150}