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