DCausse has uploaded a new change for review. (
https://gerrit.wikimedia.org/r/404429 )
Change subject: Switch FullTextQueryBuilder to profile management
......................................................................
Switch FullTextQueryBuilder to profile management
Bug: T183279
Change-Id: I561a4aaea30c98db851db5a921584ee524eb4b18
---
M CirrusSearch.php
M autoload.php
M docs/settings.txt
M includes/Hooks.php
M includes/Profile/SearchProfileService.php
M includes/Profile/SearchProfileServiceFactory.php
M includes/Search/SearchContext.php
M includes/Searcher.php
M profiles/FullTextQueryBuilderProfiles.config.php
D profiles/FullTextQueryBuilderProfiles.php
M tests/unit/Profile/SearchProfileServiceFactoryTest.php
11 files changed, 59 insertions(+), 37 deletions(-)
git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/CirrusSearch
refs/changes/29/404429/1
diff --git a/CirrusSearch.php b/CirrusSearch.php
index b9dea5e..de1ee9c 100644
--- a/CirrusSearch.php
+++ b/CirrusSearch.php
@@ -1167,6 +1167,12 @@
$wgCirrusSearchFullTextQueryBuilderProfile = 'default';
/**
+ * List of additional fulltext query builder profiles
+ * see profiles/FullTextQueryBuilderProfiles.config.php
+ */
+$wgCirrusSearchFullTextQueryBuilderProfiles = [];
+
+/**
* Transitionary flag for converting between older style
* doc ids (page ids) to the newer style ids (wikiid|pageid).
* Changing this from false to true requires first turning
diff --git a/autoload.php b/autoload.php
index f834d86..6976384 100644
--- a/autoload.php
+++ b/autoload.php
@@ -52,7 +52,6 @@
'CirrusSearch\\Extra\\Query\\SourceRegex' => __DIR__ .
'/includes/Extra/Query/SourceRegex.php',
'CirrusSearch\\Extra\\Query\\TokenCountRouter' => __DIR__ .
'/includes/Extra/Query/TokenCountRouter.php',
'CirrusSearch\\ForceSearchIndex' => __DIR__ .
'/maintenance/forceSearchIndex.php',
- 'CirrusSearch\\FullTextQueryBuilderProfiles' => __DIR__ .
'/profiles/FullTextQueryBuilderProfiles.php',
'CirrusSearch\\HTMLCompletionProfileSettings' => __DIR__ .
'/includes/HTMLCompletionProfileSettings.php',
'CirrusSearch\\HashSearchConfig' => __DIR__ .
'/includes/HashSearchConfig.php',
'CirrusSearch\\Hooks' => __DIR__ . '/includes/Hooks.php',
diff --git a/docs/settings.txt b/docs/settings.txt
index 5f3874c..9fcc794 100644
--- a/docs/settings.txt
+++ b/docs/settings.txt
@@ -1341,6 +1341,14 @@
Elasticsearch QueryBuilder to use when when building FullText queries.
+; $wgCirrusSearchFullTextQueryBuilderProfiles
+
+Default:
+ $wgCirrusSearchFullTextQueryBuilderProfiles = [];
+
+List of additional fulltext query builder profiles
+see profiles/FullTextQueryBuilderProfiles.config.php
+
; $wgCirrusSearchPrefixIds
Default:
diff --git a/includes/Hooks.php b/includes/Hooks.php
index 8a45925..c72bf08 100644
--- a/includes/Hooks.php
+++ b/includes/Hooks.php
@@ -118,7 +118,6 @@
self::overrideYesNo(
$wgCirrusSearchAllFieldsForRescore, $request, 'cirrusUseAllFieldsForRescore' );
self::overrideUseExtraPluginForRegex( $request );
self::overrideMoreLikeThisOptions( $request );
- FullTextQueryBuilderProfiles::overrideOptions( $request
);
self::overrideSecret(
$wgCirrusSearchLogElasticRequests, $wgCirrusSearchLogElasticRequestsSecret,
$request, 'cirrusLogElasticRequests', false );
self::overrideYesNo( $wgCirrusSearchEnableAltLanguage,
$request, 'cirrusAltLanguage' );
}
diff --git a/includes/Profile/SearchProfileService.php
b/includes/Profile/SearchProfileService.php
index 804b1be..797f9e3 100644
--- a/includes/Profile/SearchProfileService.php
+++ b/includes/Profile/SearchProfileService.php
@@ -2,6 +2,7 @@
namespace CirrusSearch\Profile;
+use CirrusSearch\Search\SearchContext;
use \Config;
use \RequestContext;
use \User;
@@ -12,6 +13,7 @@
* Search profiles are arranged by type identified by a string constant:
* - COMPLETION: profiles used for autocomplete search when running the
completion suggester
* - CROSS_PROJECT_BLOCK_SCORER: used when reordering blocks of crossproject
search results
+ * - FT_QUERY_BUILDER: used when building fulltext search queries
* - PHRASE_SUGGESTER: Controls the behavior of the phrase suggester (did you
mean suggestions)
* - RESCORE: Controls how elasticsearch rescore queries are built
* - RESCORE_FUNCTION_CHAINS: Controls the list of functions used by a rescore
profile
@@ -83,6 +85,12 @@
const SANEITIZER = 'saneitizer';
/**
+ * Profiles used for building fulltext search queries
+ * @see SearchContext::getFulltextQueryBuilderProfile()
+ */
+ const FT_QUERY_BUILDER = 'ft_query_builder';
+
+ /**
* Profile context used for prefix search queries
*/
const CONTEXT_PREFIXSEARCH = 'prefixsearch';
diff --git a/includes/Profile/SearchProfileServiceFactory.php
b/includes/Profile/SearchProfileServiceFactory.php
index e5fecf3..fdb6530 100644
--- a/includes/Profile/SearchProfileServiceFactory.php
+++ b/includes/Profile/SearchProfileServiceFactory.php
@@ -32,6 +32,7 @@
$this->loadCompletionProfiles( $service, $config );
$this->loadPhraseSuggesterProfiles( $service, $config );
$this->loadSaneitizerProfiles( $service );
+ $this->loadFullTextQueryProfiles( $service, $config );
if ( $forceHook || $config->isLocalWiki() ) {
\Hooks::run( 'CirrusSearchProfileService', [ $service ]
);
@@ -163,4 +164,23 @@
require __DIR__ .
'/../../profiles/SaneitizeProfiles.config.php' );
// no name resolver, profile is automatically chosen based on
wiki
}
+
+ /**
+ * @param SearchProfileService $service
+ * @param SearchConfig $config
+ */
+ private function loadFullTextQueryProfiles( SearchProfileService
$service, SearchConfig $config ) {
+ $service->registerArrayRepository(
SearchProfileService::FT_QUERY_BUILDER, self::CIRRUS_BASE,
+ require __DIR__ .
'/../../profiles/FullTextQueryBuilderProfiles.config.php' );
+
+ $service->registerRepository( new ConfigProfileRepository(
SearchProfileService::FT_QUERY_BUILDER, self::CIRRUS_CONFIG,
+ 'CirrusSearchFullTextQueryBuilderProfiles', $config ) );
+
+ $service->registerDefaultProfile(
SearchProfileService::FT_QUERY_BUILDER,
+ SearchProfileService::CONTEXT_DEFAULT, 'default' );
+ $service->registerConfigOverride(
SearchProfileService::FT_QUERY_BUILDER,
+ SearchProfileService::CONTEXT_DEFAULT, $config,
'CirrusSearchFullTextQueryBuilderProfile' );
+ $service->registerUriParamOverride(
SearchProfileService::FT_QUERY_BUILDER,
+ SearchProfileService::CONTEXT_DEFAULT,
'cirrusFTQBProfile' );
+ }
}
diff --git a/includes/Search/SearchContext.php
b/includes/Search/SearchContext.php
index c59cdbe..cb37e9d 100644
--- a/includes/Search/SearchContext.php
+++ b/includes/Search/SearchContext.php
@@ -842,6 +842,10 @@
* @return string the name of the fulltext query builder profile
*/
public function getFulltextQueryBuilderProfile() {
+ if ( $this->fulltextQueryBuilderProfile === null ) {
+ $this->fulltextQueryBuilderProfile =
$this->config->getProfileService()
+ ->getProfileNameFromContext(
SearchProfileService::FT_QUERY_BUILDER, SearchProfileService::CONTEXT_FULLTEXT
);
+ }
return $this->fulltextQueryBuilderProfile;
}
diff --git a/includes/Searcher.php b/includes/Searcher.php
index 51f2a19..d5fec6e 100644
--- a/includes/Searcher.php
+++ b/includes/Searcher.php
@@ -2,6 +2,7 @@
namespace CirrusSearch;
+use CirrusSearch\Profile\SearchProfileService;
use CirrusSearch\Query\CountContentWordsBuilder;
use CirrusSearch\Query\NearMatchQueryBuilder;
use CirrusSearch\Query\PrefixSearchQueryBuilder;
@@ -270,7 +271,8 @@
$term = Util::stripQuestionMarks( $term, $this->config->get(
'CirrusSearchStripQuestionMarks' ) );
// Transform Mediawiki specific syntax to filters and extra
(pre-escaped) query string
- $builderSettings = $this->config->getElement(
'CirrusSearchFullTextQueryBuilderProfiles',
$this->searchContext->getFulltextQueryBuilderProfile() );
+ $builderSettings = $this->config->getProfileService()
+ ->loadProfileByName(
SearchProfileService::FT_QUERY_BUILDER,
$this->searchContext->getFulltextQueryBuilderProfile() );
$features = [
// Handle morelike keyword (greedy). This needs to be
the
diff --git a/profiles/FullTextQueryBuilderProfiles.config.php
b/profiles/FullTextQueryBuilderProfiles.config.php
index 5e7cfa3..c191525 100644
--- a/profiles/FullTextQueryBuilderProfiles.config.php
+++ b/profiles/FullTextQueryBuilderProfiles.config.php
@@ -22,7 +22,7 @@
* http://www.gnu.org/copyleft/gpl.html
*/
-$wgCirrusSearchFullTextQueryBuilderProfiles = [
+return [
// default query builder, based on top of QueryString
'default' => [
'builder_class' => Query\FullTextQueryStringQueryBuilder::class,
diff --git a/profiles/FullTextQueryBuilderProfiles.php
b/profiles/FullTextQueryBuilderProfiles.php
deleted file mode 100644
index 5b234d4..0000000
--- a/profiles/FullTextQueryBuilderProfiles.php
+++ /dev/null
@@ -1,33 +0,0 @@
-<?php
-
-namespace CirrusSearch;
-
-use WebRequest;
-
-/**
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License along
- * with this program; if not, write to the Free Software Foundation, Inc.,
- * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
- * http://www.gnu.org/copyleft/gpl.html
- */
-
-class FullTextQueryBuilderProfiles {
- public static function overrideOptions( WebRequest $request ) {
- global $wgCirrusSearchFullTextQueryBuilderProfiles,
- $wgCirrusSearchFullTextQueryBuilderProfile;
- $profile = $request->getVal( 'cirrusFTQBProfile' );
- if ( $profile != null && isset(
$wgCirrusSearchFullTextQueryBuilderProfiles[$profile] ) ) {
- $wgCirrusSearchFullTextQueryBuilderProfile = $profile;
- }
- }
-}
diff --git a/tests/unit/Profile/SearchProfileServiceFactoryTest.php
b/tests/unit/Profile/SearchProfileServiceFactoryTest.php
index 885b7e5..4e41e49 100644
--- a/tests/unit/Profile/SearchProfileServiceFactoryTest.php
+++ b/tests/unit/Profile/SearchProfileServiceFactoryTest.php
@@ -36,6 +36,7 @@
'crossproject block order' => [
SearchProfileService::CROSS_PROJECT_BLOCK_SCORER,
SearchProfileService::CONTEXT_DEFAULT ],
'completion' => [ SearchProfileService::COMPLETION,
SearchProfileService::CONTEXT_DEFAULT ],
'phrase suggester' => [
SearchProfileService::PHRASE_SUGGESTER, SearchProfileService::CONTEXT_DEFAULT ],
+ 'fulltext query builder' => [
SearchProfileService::FT_QUERY_BUILDER, SearchProfileService::CONTEXT_DEFAULT ],
];
}
@@ -125,6 +126,14 @@
SearchProfileService::PHRASE_SUGGESTER,
SearchProfileService::CONTEXT_DEFAULT,
'config', 'CirrusSearchPhraseSuggestSettings',
[ 'unittest' => [] ],
],
+ 'fulltext query builder by uri' => [
+ SearchProfileService::FT_QUERY_BUILDER,
SearchProfileService::CONTEXT_DEFAULT,
+ 'uri', 'cirrusFTQBProfile', [ 'unittest' => []
],
+ ],
+ 'fulltext query builder by config' => [
+ SearchProfileService::FT_QUERY_BUILDER,
SearchProfileService::CONTEXT_DEFAULT,
+ 'config',
'CirrusSearchFullTextQueryBuilderProfile', [ 'unittest' => [] ],
+ ],
];
}
--
To view, visit https://gerrit.wikimedia.org/r/404429
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: I561a4aaea30c98db851db5a921584ee524eb4b18
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/CirrusSearch
Gerrit-Branch: master
Gerrit-Owner: DCausse <[email protected]>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
