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.rating.server.command;
018
019import com.echothree.control.user.rating.common.form.CreateRatingForm;
020import com.echothree.control.user.rating.common.result.CreateRatingResult;
021import com.echothree.control.user.rating.common.result.RatingResultFactory;
022import com.echothree.model.control.rating.server.control.RatingControl;
023import com.echothree.model.control.sequence.common.SequenceTypes;
024import com.echothree.model.control.sequence.server.control.SequenceControl;
025import com.echothree.model.control.sequence.server.logic.SequenceGeneratorLogic;
026import com.echothree.model.control.user.server.control.UserControl;
027import com.echothree.model.data.core.server.entity.EntityInstance;
028import com.echothree.model.data.rating.server.entity.Rating;
029import com.echothree.model.data.rating.server.entity.RatingType;
030import com.echothree.model.data.rating.server.entity.RatingTypeListItem;
031import com.echothree.model.data.sequence.server.entity.Sequence;
032import com.echothree.model.data.user.common.pk.UserVisitPK;
033import com.echothree.model.data.user.server.entity.UserLogin;
034import com.echothree.util.common.command.BaseResult;
035import com.echothree.util.common.message.ExecutionErrors;
036import com.echothree.util.common.persistence.BasePK;
037import com.echothree.util.common.validation.FieldDefinition;
038import com.echothree.util.common.validation.FieldType;
039import com.echothree.util.server.control.BaseSimpleCommand;
040import com.echothree.util.server.persistence.Session;
041import java.util.Arrays;
042import java.util.Collections;
043import java.util.List;
044
045public class CreateRatingCommand
046        extends BaseSimpleCommand<CreateRatingForm> {
047    
048    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
049    
050    static {
051        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
052            new FieldDefinition("RatedByUsername", FieldType.STRING, false, 1L, 80L),
053            new FieldDefinition("EntityRef", FieldType.ENTITY_REF, true, null, null),
054            new FieldDefinition("RatingTypeName", FieldType.ENTITY_NAME, true, null, null),
055            new FieldDefinition("RatingTypeListItemName", FieldType.ENTITY_NAME, true, null, null)
056        ));
057    }
058    
059    /** Creates a new instance of CreateRatingCommand */
060    public CreateRatingCommand(UserVisitPK userVisitPK, CreateRatingForm form) {
061        super(userVisitPK, form, null, FORM_FIELD_DEFINITIONS, false);
062    }
063    
064    @Override
065    protected BaseResult execute() {
066        CreateRatingResult result = RatingResultFactory.getCreateRatingResult();
067        var coreControl = getCoreControl();
068        String ratingName = null;
069        String entityRef = form.getEntityRef();
070        EntityInstance ratedEntityInstance = coreControl.getEntityInstanceByEntityRef(entityRef);
071        
072        if(ratedEntityInstance != null) {
073            var ratingControl = Session.getModelController(RatingControl.class);
074            EntityInstance ratedByEntityInstance = null;
075            BasePK createdBy = getPartyPK();
076            String ratedByUsername = form.getRatedByUsername();
077            
078            if(ratedByUsername != null) {
079                UserControl userControl = getUserControl();
080                UserLogin userLogin = userControl.getUserLoginByUsername(ratedByUsername);
081                
082                if(userLogin != null) {
083                    ratedByEntityInstance = coreControl.getEntityInstanceByBasePK(userLogin.getPartyPK());
084                } else {
085                    addExecutionError(ExecutionErrors.UnknownRatedByUsername.name(), ratedByUsername);
086                }
087            } else {
088                ratedByEntityInstance = coreControl.getEntityInstanceByBasePK(createdBy);
089            }
090            
091            if(!hasExecutionErrors()) {
092                Rating rating = ratingControl.getRating(ratedEntityInstance, ratedByEntityInstance);
093                
094                if(rating == null) {
095                    String ratingTypeName = form.getRatingTypeName();
096                    RatingType ratingType = ratingControl.getRatingTypeByName(ratedEntityInstance.getEntityType(),
097                            ratingTypeName);
098                    
099                    if(ratingType != null) {
100                        String ratingTypeListItemName = form.getRatingTypeListItemName();
101                        RatingTypeListItem ratingTypeListItem = ratingControl.getRatingTypeListItemByName(ratingType, ratingTypeListItemName);
102                        
103                        if(ratingTypeListItem != null) {
104                            var sequenceControl = Session.getModelController(SequenceControl.class);
105                            Sequence ratingSequence = ratingType.getLastDetail().getRatingSequence();
106                            
107                            if(ratingSequence == null) {
108                                ratingSequence = sequenceControl.getDefaultSequenceUsingNames(SequenceTypes.RATING.name());
109                            }
110                            
111                            ratingName = SequenceGeneratorLogic.getInstance().getNextSequenceValue(ratingSequence);
112                            
113                            ratingControl.createRating(ratingName, ratingTypeListItem, ratedEntityInstance, ratedByEntityInstance,
114                                    createdBy);
115                        } else {
116                            addExecutionError(ExecutionErrors.UnknownRatingTypeListItemName.name(), ratingTypeListItemName);
117                        }
118                    } else {
119                        addExecutionError(ExecutionErrors.UnknownRatingTypeName.name(), ratingTypeName);
120                    }
121                } else {
122                    addExecutionError(ExecutionErrors.DuplicateRating.name());
123                }
124            }
125        } else {
126            addExecutionError(ExecutionErrors.UnknownEntityRef.name(), entityRef);
127        }
128        
129        result.setRatingName(ratingName);
130        
131        return result;
132    }
133    
134}