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.search.server.command;
018
019import com.echothree.control.user.search.common.form.SearchForumMessagesForm;
020import com.echothree.control.user.search.common.result.SearchForumMessagesResult;
021import com.echothree.control.user.search.common.result.SearchResultFactory;
022import com.echothree.model.control.forum.common.ForumConstants;
023import com.echothree.model.control.forum.server.control.ForumControl;
024import com.echothree.model.control.forum.server.logic.ForumRoleTypeLogic;
025import com.echothree.model.control.party.server.logic.LanguageLogic;
026import com.echothree.model.control.search.common.SearchKinds;
027import com.echothree.model.control.search.server.control.SearchControl;
028import com.echothree.model.control.forum.server.search.ForumMessageSearchEvaluator;
029import com.echothree.model.control.search.server.logic.SearchLogic;
030import com.echothree.util.common.message.ExecutionErrors;
031import com.echothree.util.common.validation.FieldDefinition;
032import com.echothree.util.common.validation.FieldType;
033import com.echothree.util.common.command.BaseResult;
034import com.google.common.base.Splitter;
035import java.util.List;
036import javax.enterprise.context.Dependent;
037import javax.inject.Inject;
038
039@Dependent
040public class SearchForumMessagesCommand
041        extends BaseSearchCommand<SearchForumMessagesForm, SearchForumMessagesResult> {
042    
043    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
044
045    static {
046        FORM_FIELD_DEFINITIONS = List.of(
047                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, false, null, null),
048                new FieldDefinition("SearchDefaultOperatorName", FieldType.ENTITY_NAME, false, null, null),
049                new FieldDefinition("SearchSortDirectionName", FieldType.ENTITY_NAME, false, null, null),
050                new FieldDefinition("SearchTypeName", FieldType.ENTITY_NAME, true, null, null),
051                new FieldDefinition("SearchSortOrderName", FieldType.ENTITY_NAME, false, null, null),
052                new FieldDefinition("ForumName", FieldType.ENTITY_NAME, true, null, null),
053                new FieldDefinition("ForumMessageType", FieldType.ENTITY_NAME, false, null, null),
054                new FieldDefinition("IncludeFutureForumThreads", FieldType.BOOLEAN, true, null, null),
055                new FieldDefinition("Q", FieldType.STRING, false, null, null),
056                new FieldDefinition("CreatedSince", FieldType.DATE_TIME, false, null, null),
057                new FieldDefinition("ModifiedSince", FieldType.DATE_TIME, false, null, null),
058                new FieldDefinition("Fields", FieldType.STRING, false, null, null),
059                new FieldDefinition("RememberPreferences", FieldType.BOOLEAN, false, null, null),
060                new FieldDefinition("SearchUseTypeName", FieldType.ENTITY_NAME, false, null, null)
061        );
062    }
063
064    @Inject
065    ForumControl forumControl;
066
067    @Inject
068    SearchControl searchControl;
069
070    @Inject
071    ForumRoleTypeLogic forumRoleTypeLogic;
072
073    @Inject
074    LanguageLogic languageLogic;
075
076    @Inject
077    SearchLogic searchLogic;
078
079    /** Creates a new instance of SearchForumMessagesCommand */
080    public SearchForumMessagesCommand() {
081        super(null, FORM_FIELD_DEFINITIONS, false);
082    }
083    
084    @Override
085    protected BaseResult execute() {
086        var result = SearchResultFactory.getSearchForumMessagesResult();
087        var searchKind = searchLogic.getSearchKindByName(this, SearchKinds.FORUM_MESSAGE.name());
088
089        if(!hasExecutionErrors()) {
090            var searchTypeName = form.getSearchTypeName();
091            var searchType = searchLogic.getSearchTypeByName(this, searchKind, searchTypeName);
092
093            if(!hasExecutionErrors()) {
094                var languageIsoName = form.getLanguageIsoName();
095                var language = languageIsoName == null ? null : languageLogic.getLanguageByName(this, languageIsoName);
096                
097                if(!hasExecutionErrors()) {
098                    var partySearchTypePreference = getPartySearchTypePreference(searchControl, searchType);
099                    var partySearchTypePreferenceDetail = partySearchTypePreference == null ? null : partySearchTypePreference.getLastDetail();
100                    boolean rememberPreferences = Boolean.valueOf(form.getRememberPreferences());
101                    var searchDefaultOperatorName = form.getSearchDefaultOperatorName();
102                    var searchDefaultOperator = searchDefaultOperatorName == null
103                            ? getDefaultSearchDefaultOperator(searchLogic, rememberPreferences, partySearchTypePreferenceDetail)
104                            : searchLogic.getSearchDefaultOperatorByName(this, searchDefaultOperatorName);
105
106                    if(!hasExecutionErrors()) {
107                        var searchSortOrderName = form.getSearchSortOrderName();
108                        var searchSortOrder = searchSortOrderName == null
109                                ? getDefaultSearchSortOrder(searchLogic, rememberPreferences, searchKind, partySearchTypePreferenceDetail)
110                                : searchLogic.getSearchSortOrderByName(this, searchKind, searchSortOrderName);
111
112                        if(!hasExecutionErrors()) {
113                            var searchSortDirectionName = form.getSearchSortDirectionName();
114                            var searchSortDirection = searchSortDirectionName == null
115                                    ? getDefaultSearchSortDirection(searchLogic, rememberPreferences, partySearchTypePreferenceDetail)
116                                    : searchLogic.getSearchSortDirectionByName(this, searchSortDirectionName);
117
118                            if(!hasExecutionErrors()) {
119                                var searchUseTypeName = form.getSearchUseTypeName();
120                                var searchUseType = searchUseTypeName == null ? null : searchLogic.getSearchUseTypeByName(this, searchUseTypeName);
121
122                                if(!hasExecutionErrors()) {
123                                    var forumName = form.getForumName();
124                                    var forum = forumControl.getForumByName(forumName);
125
126                                    if(forum != null) {
127                                        if(forumRoleTypeLogic.isForumRoleTypePermitted(this, forum, getParty(), ForumConstants.ForumRoleType_READER)) {
128                                            var forumMessageTypeName = form.getForumMessageTypeName();
129                                            var forumMessageType = forumMessageTypeName == null ? null : forumControl.getForumMessageTypeByName(forumMessageTypeName);
130
131                                            if(forumMessageTypeName == null || forumMessageType != null) {
132                                                var forumType = forum.getLastDetail().getForumType();
133                                                var forumTypeMessageType = forumMessageType == null ? forumControl.getDefaultForumTypeMessageType(forumType)
134                                                        : forumControl.getForumTypeMessageType(forumType, forumMessageType);
135
136                                                if(forumTypeMessageType != null) {
137                                                    var forumMessageSearchEvaluator = new ForumMessageSearchEvaluator(getUserVisit(),
138                                                            language, searchType, searchDefaultOperator, searchSortOrder, searchSortDirection, searchUseType,
139                                                            forum, forumTypeMessageType.getForumMessageType());
140                                                    var createdSince = form.getCreatedSince();
141                                                    var modifiedSince = form.getModifiedSince();
142                                                    var fields = form.getFields();
143
144                                                    forumMessageSearchEvaluator.setIncludeFutureForumThreads(Boolean.parseBoolean(form.getIncludeFutureForumThreads()));
145                                                    forumMessageSearchEvaluator.setQ(this, form.getQ());
146                                                    forumMessageSearchEvaluator.setCreatedSince(createdSince == null ? null : Long.valueOf(createdSince));
147                                                    forumMessageSearchEvaluator.setModifiedSince(modifiedSince == null ? null : Long.valueOf(modifiedSince));
148                                                    forumMessageSearchEvaluator.setFields(fields == null ? null : Splitter.on(':').trimResults().omitEmptyStrings().splitToList(fields).toArray(new String[0]));
149
150                                                    if(!hasExecutionErrors()) {
151                                                        result.setCount(forumMessageSearchEvaluator.execute(this));
152                                                    }
153                                                } else {
154                                                    if(forumMessageTypeName == null) {
155                                                        addExecutionError(ExecutionErrors.UnknownDefaultForumTypeMessageType.name(), forumType.getForumTypeName());
156                                                    } else {
157                                                        addExecutionError(ExecutionErrors.UnknownForumTypeMessageType.name(), forumType.getForumTypeName(), forumMessageTypeName);
158                                                    }
159                                                }
160                                            } else {
161                                                addExecutionError(ExecutionErrors.UnknownForumMessageTypeName.name(), forumMessageTypeName);
162                                            }
163                                        } else {
164                                            addExecutionError(ExecutionErrors.MissingRequiredForumRoleType.name(), ForumConstants.ForumRoleType_READER);
165                                        }
166                                    } else {
167                                        addExecutionError(ExecutionErrors.UnknownForumName.name(), forumName);
168                                    }
169                                }
170                            }
171                        }
172                    }
173                }
174            }
175        }
176        
177        return result;
178    }
179}