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.index.server.command;
018
019import com.echothree.control.user.index.common.form.CreateIndexForm;
020import com.echothree.model.control.index.server.control.IndexControl;
021import com.echothree.model.control.index.server.logic.IndexLogic;
022import com.echothree.model.control.index.server.logic.IndexTypeLogic;
023import com.echothree.model.control.party.common.PartyTypes;
024import com.echothree.model.control.party.server.logic.LanguageLogic;
025import com.echothree.model.control.security.common.SecurityRoleGroups;
026import com.echothree.model.control.security.common.SecurityRoles;
027import com.echothree.model.data.core.server.entity.EntityType;
028import com.echothree.model.data.index.server.entity.Index;
029import com.echothree.model.data.index.server.entity.IndexType;
030import com.echothree.model.data.party.server.entity.Language;
031import com.echothree.model.data.user.common.pk.UserVisitPK;
032import com.echothree.util.common.message.ExecutionErrors;
033import com.echothree.util.common.validation.FieldDefinition;
034import com.echothree.util.common.validation.FieldType;
035import com.echothree.util.common.command.BaseResult;
036import com.echothree.util.server.control.BaseSimpleCommand;
037import com.echothree.util.server.control.CommandSecurityDefinition;
038import com.echothree.util.server.control.PartyTypeDefinition;
039import com.echothree.util.server.control.SecurityRoleDefinition;
040import com.echothree.util.server.persistence.Session;
041import java.util.Arrays;
042import java.util.Collections;
043import java.util.List;
044
045public class CreateIndexCommand
046        extends BaseSimpleCommand<CreateIndexForm> {
047    
048    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
049    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
050    
051    static {
052        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
053                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
054                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
055                        new SecurityRoleDefinition(SecurityRoleGroups.Index.name(), SecurityRoles.Create.name())
056                        )))
057                )));
058        
059        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
060                new FieldDefinition("IndexName", FieldType.ENTITY_NAME, true, null, null),
061                new FieldDefinition("IndexTypeName", FieldType.ENTITY_NAME, true, null, null),
062                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, false, null, null),
063                new FieldDefinition("Directory", FieldType.STRING, true, null, 80L),
064                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
065                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
066                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
067                ));
068    }
069    
070    /** Creates a new instance of CreateIndexCommand */
071    public CreateIndexCommand(UserVisitPK userVisitPK, CreateIndexForm form) {
072        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
073    }
074    
075    @Override
076    protected BaseResult execute() {
077        var indexControl = Session.getModelController(IndexControl.class);
078        String indexName = form.getIndexName();
079        Index index = indexControl.getIndexByName(indexName);
080        
081        if(index == null) {
082            String directory = form.getDirectory();
083            
084            index = indexControl.getIndexByDirectory(directory);
085            
086            if(index == null) {
087                String indexTypeName = form.getIndexTypeName();
088                IndexType indexType = IndexTypeLogic.getInstance().getIndexTypeByName(this, indexTypeName);
089
090                if(!hasExecutionErrors()) {
091                    String languageIsoName = form.getLanguageIsoName();
092                    Language language = languageIsoName == null ? null : LanguageLogic.getInstance().getLanguageByName(this, languageIsoName);
093
094                    if(!hasExecutionErrors()) {
095                        index = language == null ? null : indexControl.getIndex(indexType, language);
096
097                        if(index == null) {
098                            EntityType entityType = indexType.getLastDetail().getEntityType();
099                            var partyPK = getPartyPK();
100                            var isDefault = Boolean.valueOf(form.getIsDefault());
101                            var sortOrder = Integer.valueOf(form.getSortOrder());
102                            var description = form.getDescription();
103
104                            index = indexControl.createIndex(indexName, indexType, language, directory, isDefault, sortOrder, partyPK);
105
106                            if(description != null) {
107                                indexControl.createIndexDescription(index, getPreferredLanguage(), description, partyPK);
108                            }
109                            
110                            if(entityType != null) {
111                                IndexLogic.getInstance().reindex(session, this, entityType);
112                            }
113                        } else {
114                            addExecutionError(ExecutionErrors.DuplicateIndex.name(), indexTypeName, languageIsoName);
115                        }
116                    }
117                }
118            } else {
119                addExecutionError(ExecutionErrors.DuplicateDirectory.name(), directory);
120            }
121        } else {
122            addExecutionError(ExecutionErrors.DuplicateIndexName.name(), indexName);
123        }
124        
125        return null;
126    }
127    
128}