Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
98.60% covered (success)
98.60%
141 / 143
92.31% covered (success)
92.31%
12 / 13
CRAP
0.00% covered (danger)
0.00%
0 / 1
SearchProfileServiceFactory
98.60% covered (success)
98.60%
141 / 143
92.31% covered (success)
92.31%
12 / 13
23
0.00% covered (danger)
0.00%
0 / 1
 __construct
100.00% covered (success)
100.00%
6 / 6
100.00% covered (success)
100.00%
1 / 1
1
 loadService
100.00% covered (success)
100.00%
16 / 16
100.00% covered (success)
100.00%
1 / 1
3
 loadCrossProjectBlockScorer
100.00% covered (success)
100.00%
10 / 10
100.00% covered (success)
100.00%
1 / 1
1
 loadSimilarityProfiles
100.00% covered (success)
100.00%
10 / 10
100.00% covered (success)
100.00%
1 / 1
1
 loadRescoreProfiles
100.00% covered (success)
100.00%
23 / 23
100.00% covered (success)
100.00%
1 / 1
1
 loadCompletionProfiles
100.00% covered (success)
100.00%
13 / 13
100.00% covered (success)
100.00%
1 / 1
1
 loadPhraseSuggesterProfiles
100.00% covered (success)
100.00%
7 / 7
100.00% covered (success)
100.00%
1 / 1
1
 loadIndexLookupFallbackProfiles
100.00% covered (success)
100.00%
6 / 6
100.00% covered (success)
100.00%
1 / 1
1
 loadSaneitizerProfiles
100.00% covered (success)
100.00%
2 / 2
100.00% covered (success)
100.00%
1 / 1
1
 loadDocumentSizeLimiterProfiles
100.00% covered (success)
100.00%
10 / 10
100.00% covered (success)
100.00%
1 / 1
1
 loadFullTextQueryProfiles
100.00% covered (success)
100.00%
12 / 12
100.00% covered (success)
100.00%
1 / 1
1
 loadInterwikiOverrides
87.50% covered (warning)
87.50%
14 / 16
0.00% covered (danger)
0.00%
0 / 1
9.16
 loadFallbackProfiles
100.00% covered (success)
100.00%
12 / 12
100.00% covered (success)
100.00%
1 / 1
1
1<?php
2
3namespace CirrusSearch\Profile;
4
5use BagOStuff;
6use CirrusSearch\CirrusSearchHookRunner;
7use CirrusSearch\InterwikiResolver;
8use CirrusSearch\SearchConfig;
9use ExtensionRegistry;
10use MediaWiki\Request\WebRequest;
11use MediaWiki\User\Options\UserOptionsLookup;
12use MediaWiki\User\UserIdentity;
13
14/**
15 * Default factory to build and prepare search profiles.
16 *
17 * The factory will load these defaults:
18 * <ul>
19 * <li>COMPLETION in CONTEXT_DEFAULT
20 *  <ul>
21 *   <li>default: <i>fuzzy</i></li>
22 *   <li>config override: <var>CirrusSearchCompletionSettings</var></li>
23 *   <li>user pref override: <var>cirrussearch-pref-completion-profile</var></li>
24 *  </ul>
25 * </li>
26 * <li>CROSS_PROJECT_BLOCK_SCORER in CONTEXT_DEFAULT
27 *  <ul>
28 *   <li>default: <i>static</i></li>
29 *   <li>config override: <var>CirrusSearchCrossProjectOrder</var></li>
30 *  </ul>
31 * </li>
32 * <li>FT_QUERY_BUILDER in CONTEXT_DEFAULT
33 *  <ul>
34 *   <li>default: <i>default</i></li>
35 *   <li>config override: <var>CirrusSearchFullTextQueryBuilderProfile</var></li>
36 *   <li>uri param override: <var>cirrusFTQBProfile</var></li>
37 *  </ul>
38 * </li>
39 * <li>PHRASE_SUGGESTER in CONTEXT_DEFAULT
40 *  <ul>
41 *   <li>default: <i>no defaults (selected by fallback methods profiles)</i></li>
42 *  </ul>
43 * </li>
44 * <li>RESCORE in CONTEXT_DEFAULT and CONTEXT_PREFIXSEARCH
45 *  <ul>
46 *   <li>default (CONTEXT_DEFAULT & CONTEXT_PREFIXSEARCH): <i>classic</i></li>
47 *   <li>config override (CONTEXT_DEFAULT): <var>CirrusSearchRescoreProfile</var></li>
48 *   <li>config override (CONTEXT_PREFIXSEARCH): <var>CirrusSearchPrefixSearchRescoreProfile</var></li>
49 *   <li>uri param override (CONTEXT_PREFIXSEARCH & CONTEXT_PREFIXSEARCH): <var>cirrusRescoreProfile</var></li>
50 *  </ul>
51 * </li>
52 * <li>SANEITIZER
53 *  <ul>
54 *   <li>default: <i>no defaults (automatically detected based on wiki size)</i></li>
55 *  </ul>
56 * </li>
57 * <li>SIMILARITY in CONTEXT_DEFAULT
58 *  <ul>
59 *   <li>default: <i>default</i></li>
60 *   <li>config override: <var>wgCirrusSearchSimilarityProfile</var></li>
61 *  </ul>
62 * </li>
63 * <li>FALLBACK in CONTEXT_DEFAULT
64 *  <ul>
65 *      <li>default: <i>none</i></li>
66 *   <li>config override: <var>wgCirrusSearchFallbackProfile</var></li>
67 *  </ul>
68 * </li>
69 * </ul>
70 *
71 * <b>NOTE:</b> extensions may load their own repositories and overriders.
72 */
73class SearchProfileServiceFactory {
74
75    /**
76     * Name of the service declared in MediaWikiServices
77     */
78    public const SERVICE_NAME = self::class;
79
80    /**
81     * Name of the repositories holding profiles
82     * provided by Cirrus.
83     */
84    private const CIRRUS_BASE = 'cirrus_base';
85
86    /**
87     * Name of the repositories holding profiles customized
88     * by wiki admin using CirrusSearch config vars.
89     */
90    private const CIRRUS_CONFIG = 'cirrus_config';
91
92    /**
93     * Name of the repositories holding profiles customized
94     * by extensions via extension attributes.
95     */
96    private const EXTENSION_REGISTRY = 'extension_registry';
97
98    /**
99     * @var InterwikiResolver
100     */
101    private $interwikiResolver;
102
103    /**
104     * @var SearchConfig
105     */
106    private $hostWikiConfig;
107
108    /**
109     * @var BagOStuff
110     */
111    private $localServerCache;
112
113    /**
114     * @var CirrusSearchHookRunner
115     */
116    private $cirrusSearchHookRunner;
117
118    /**
119     * @var UserOptionsLookup
120     */
121    private $userOptionsLookup;
122
123    /**
124     * @var ExtensionRegistry
125     */
126    private ExtensionRegistry $extensionRegistry;
127
128    public function __construct(
129        InterwikiResolver $resolver, SearchConfig $hostWikiConfig, BagOStuff $localServerCache,
130        CirrusSearchHookRunner $cirrusSearchHookRunner, UserOptionsLookup $userOptionsLookup,
131        ExtensionRegistry $extensionRegistry
132    ) {
133        $this->interwikiResolver = $resolver;
134        $this->hostWikiConfig = $hostWikiConfig;
135        $this->localServerCache = $localServerCache;
136        $this->cirrusSearchHookRunner = $cirrusSearchHookRunner;
137        $this->userOptionsLookup = $userOptionsLookup;
138        $this->extensionRegistry = $extensionRegistry;
139    }
140
141    /**
142     * @param SearchConfig $config
143     * @param WebRequest|null $request
144     * @param UserIdentity|null $user
145     * @param bool $forceHook force running the hook even if using HashSearchConfig
146     * @return SearchProfileService
147     */
148    public function loadService( SearchConfig $config, WebRequest $request = null, UserIdentity $user = null, $forceHook = false ) {
149        $service = new SearchProfileService( $this->userOptionsLookup, $request, $user );
150        $this->loadCrossProjectBlockScorer( $service, $config );
151        $this->loadSimilarityProfiles( $service, $config );
152        $this->loadRescoreProfiles( $service, $config );
153        $this->loadCompletionProfiles( $service, $config );
154        $this->loadPhraseSuggesterProfiles( $service, $config );
155        $this->loadIndexLookupFallbackProfiles( $service, $config );
156        $this->loadSaneitizerProfiles( $service );
157        $this->loadDocumentSizeLimiterProfiles( $service, $config );
158        $this->loadFullTextQueryProfiles( $service, $config );
159        $this->loadInterwikiOverrides( $service, $config );
160        $this->loadFallbackProfiles( $service, $config );
161        // Register extension profiles only if running on the host wiki.
162        // Only cirrus search is aware that we are running a crosswiki search
163        // Extensions have no way to know that the profiles they want to declare
164        // may be applied to other wikis. Since they may use host wiki config it seems
165        // safer not to allow extensions to add extra profiles here.
166        // E.g. extension could declare a profile that uses a field that is not available
167        // on the target wiki.
168        if ( $forceHook || $config->isLocalWiki() ) {
169            $this->cirrusSearchHookRunner->onCirrusSearchProfileService( $service );
170        }
171        $service->freeze();
172        return $service;
173    }
174
175    /**
176     * @param SearchProfileService $service
177     * @param SearchConfig $config
178     */
179    private function loadCrossProjectBlockScorer( SearchProfileService $service, SearchConfig $config ) {
180        $service->registerFileRepository( SearchProfileService::CROSS_PROJECT_BLOCK_SCORER,
181            self::CIRRUS_BASE, __DIR__ . '/../../profiles/CrossProjectBlockScorerProfiles.config.php' );
182        $service->registerRepository( new ConfigProfileRepository( SearchProfileService::CROSS_PROJECT_BLOCK_SCORER,
183            self::CIRRUS_CONFIG, 'CirrusSearchCrossProjectBlockScorerProfiles', $config ) );
184        $service->registerRepository( new ExtensionRegistryProfileRepository( SearchProfileService::CROSS_PROJECT_BLOCK_SCORER,
185            self::EXTENSION_REGISTRY, 'CirrusSearchCrossProjectBlockScorerProfiles', $this->extensionRegistry ) );
186        $service->registerDefaultProfile( SearchProfileService::CROSS_PROJECT_BLOCK_SCORER,
187            SearchProfileService::CONTEXT_DEFAULT, 'static' );
188        $service->registerConfigOverride( SearchProfileService::CROSS_PROJECT_BLOCK_SCORER,
189            SearchProfileService::CONTEXT_DEFAULT, $config, 'CirrusSearchCrossProjectOrder' );
190    }
191
192    /**
193     * @param SearchProfileService $service
194     * @param SearchConfig $config
195     */
196    private function loadSimilarityProfiles( SearchProfileService $service, SearchConfig $config ) {
197        $service->registerFileRepository( SearchProfileService::SIMILARITY, self::CIRRUS_BASE,
198            __DIR__ . '/../../profiles/SimilarityProfiles.config.php' );
199        $service->registerRepository( new ConfigProfileRepository( SearchProfileService::SIMILARITY,
200            self::CIRRUS_CONFIG, 'CirrusSearchSimilarityProfiles', $config ) );
201        $service->registerRepository( new ExtensionRegistryProfileRepository( SearchProfileService::SIMILARITY,
202            self::EXTENSION_REGISTRY, 'CirrusSearchSimilarityProfiles', $this->extensionRegistry ) );
203
204        $service->registerDefaultProfile( SearchProfileService::SIMILARITY,
205            SearchProfileService::CONTEXT_DEFAULT, 'bm25_with_defaults' );
206        $service->registerConfigOverride( SearchProfileService::SIMILARITY,
207            SearchProfileService::CONTEXT_DEFAULT, $config, 'CirrusSearchSimilarityProfile' );
208    }
209
210    /**
211     * @param SearchProfileService $service
212     * @param SearchConfig $config
213     */
214    private function loadRescoreProfiles( SearchProfileService $service, SearchConfig $config ) {
215        $service->registerFileRepository( SearchProfileService::RESCORE,
216            self::CIRRUS_BASE, __DIR__ . '/../../profiles/RescoreProfiles.config.php' );
217        $service->registerRepository( new ConfigProfileRepository( SearchProfileService::RESCORE,
218            self::CIRRUS_CONFIG, 'CirrusSearchRescoreProfiles', $config ) );
219        $service->registerRepository( new ExtensionRegistryProfileRepository( SearchProfileService::RESCORE,
220            self::EXTENSION_REGISTRY, 'CirrusSearchRescoreProfiles', $this->extensionRegistry ) );
221        $service->registerDefaultProfile( SearchProfileService::RESCORE,
222            SearchProfileService::CONTEXT_DEFAULT, 'classic' );
223        $service->registerDefaultProfile( SearchProfileService::RESCORE,
224            SearchProfileService::CONTEXT_PREFIXSEARCH, 'classic' );
225
226        $service->registerConfigOverride( SearchProfileService::RESCORE,
227            SearchProfileService::CONTEXT_DEFAULT, $config, 'CirrusSearchRescoreProfile' );
228        $service->registerConfigOverride( SearchProfileService::RESCORE,
229            SearchProfileService::CONTEXT_PREFIXSEARCH, $config, 'CirrusSearchPrefixSearchRescoreProfile' );
230
231        $service->registerUriParamOverride( SearchProfileService::RESCORE,
232            [ SearchProfileService::CONTEXT_DEFAULT, SearchProfileService::CONTEXT_PREFIXSEARCH ],
233            'cirrusRescoreProfile' );
234
235        // function chains
236        $service->registerFileRepository( SearchProfileService::RESCORE_FUNCTION_CHAINS,
237            self::CIRRUS_BASE, __DIR__ . '/../../profiles/RescoreFunctionChains.config.php' );
238        $service->registerRepository( new ConfigProfileRepository( SearchProfileService::RESCORE_FUNCTION_CHAINS,
239            self::CIRRUS_CONFIG, 'CirrusSearchRescoreFunctionScoreChains', $config ) );
240        $service->registerRepository( new ExtensionRegistryProfileRepository( SearchProfileService::RESCORE_FUNCTION_CHAINS,
241            self::EXTENSION_REGISTRY, 'CirrusSearchRescoreFunctionScoreChains', $this->extensionRegistry ) );
242        // No default profiles for function chains, these profiles are always accessed explicitly
243    }
244
245    /**
246     * @param SearchProfileService $service
247     * @param SearchConfig $config
248     */
249    private function loadCompletionProfiles( SearchProfileService $service, SearchConfig $config ) {
250        $service->registerRepository( CompletionSearchProfileRepository::fromFile( SearchProfileService::COMPLETION,
251            self::CIRRUS_BASE, __DIR__ . '/../../profiles/SuggestProfiles.config.php', $config ) );
252        $service->registerRepository( CompletionSearchProfileRepository::fromConfig( SearchProfileService::COMPLETION,
253            self::CIRRUS_CONFIG, 'CirrusSearchCompletionProfiles', $config ) );
254        $service->registerRepository( CompletionSearchProfileRepository::fromRepo(
255            new ExtensionRegistryProfileRepository( SearchProfileService::COMPLETION,
256            self::EXTENSION_REGISTRY, 'CirrusSearchCompletionProfiles', $this->extensionRegistry ), $config ) );
257        $service->registerDefaultProfile( SearchProfileService::COMPLETION,
258            SearchProfileService::CONTEXT_DEFAULT, 'fuzzy' );
259        // XXX: We don't really override the default here
260        // Due to the way User preference works we may always end up using
261        // the user pref overrides because we initialize default user pref
262        // in Hooks::onUserGetDefaultOptions
263        $service->registerConfigOverride( SearchProfileService::COMPLETION,
264            SearchProfileService::CONTEXT_DEFAULT, $config, 'CirrusSearchCompletionSettings' );
265        $service->registerUserPrefOverride( SearchProfileService::COMPLETION,
266            SearchProfileService::CONTEXT_DEFAULT, 'cirrussearch-pref-completion-profile' );
267    }
268
269    /**
270     * @param SearchProfileService $service
271     * @param SearchConfig $config
272     */
273    private function loadPhraseSuggesterProfiles( SearchProfileService $service, SearchConfig $config ) {
274        $service->registerRepository( PhraseSuggesterProfileRepoWrapper::fromFile( SearchProfileService::PHRASE_SUGGESTER,
275            self::CIRRUS_BASE, __DIR__ . '/../../profiles/PhraseSuggesterProfiles.config.php', $this->localServerCache ) );
276
277        $service->registerRepository( PhraseSuggesterProfileRepoWrapper::fromConfig( SearchProfileService::PHRASE_SUGGESTER,
278            self::CIRRUS_CONFIG, 'CirrusSearchPhraseSuggestProfiles', $config, $this->localServerCache ) );
279
280        $service->registerRepository( new PhraseSuggesterProfileRepoWrapper(
281            new ExtensionRegistryProfileRepository( SearchProfileService::PHRASE_SUGGESTER, self::EXTENSION_REGISTRY,
282                'CirrusSearchPhraseSuggestProfiles', $this->extensionRegistry ), $this->localServerCache ) );
283    }
284
285    private function loadIndexLookupFallbackProfiles( SearchProfileService $service, SearchConfig $config ) {
286        $service->registerFileRepository( SearchProfileService::INDEX_LOOKUP_FALLBACK,
287            self::CIRRUS_BASE, __DIR__ . '/../../profiles/IndexLookupFallbackProfiles.config.php' );
288
289        $service->registerRepository( new ConfigProfileRepository( SearchProfileService::INDEX_LOOKUP_FALLBACK,
290            self::CIRRUS_CONFIG, 'CirrusSearchIndexLookupFallbackProfiles', $config ) );
291
292        $service->registerRepository( new ExtensionRegistryProfileRepository( SearchProfileService::INDEX_LOOKUP_FALLBACK,
293            self::EXTENSION_REGISTRY, 'CirrusSearchIndexLookupFallbackProfiles', $this->extensionRegistry ) );
294    }
295
296    /**
297     * @param SearchProfileService $service
298     */
299    private function loadSaneitizerProfiles( SearchProfileService $service ) {
300        $service->registerFileRepository( SearchProfileService::SANEITIZER, self::CIRRUS_BASE,
301            __DIR__ . '/../../profiles/SaneitizeProfiles.config.php' );
302        // no name resolver, profile is automatically chosen based on wiki
303    }
304
305    /**
306     * @param SearchProfileService $service
307     * @param SearchConfig $config
308     */
309    private function loadDocumentSizeLimiterProfiles( SearchProfileService $service, SearchConfig $config ) {
310        $service->registerFileRepository( SearchProfileService::DOCUMENT_SIZE_LIMITER, self::CIRRUS_BASE,
311            __DIR__ . '/../../profiles/DocumentSizeLimiterProfiles.config.php' );
312        $service->registerRepository( new ConfigProfileRepository( SearchProfileService::DOCUMENT_SIZE_LIMITER,
313            self::CIRRUS_CONFIG, 'CirrusSearchDocumentSizeLimiterProfiles', $config ) );
314        $service->registerRepository( new ExtensionRegistryProfileRepository( SearchProfileService::DOCUMENT_SIZE_LIMITER,
315            self::EXTENSION_REGISTRY, 'CirrusSearchDocumentSizeLimiterProfiles', $this->extensionRegistry ) );
316        $service->registerDefaultProfile( SearchProfileService::DOCUMENT_SIZE_LIMITER,
317            SearchProfileService::CONTEXT_DEFAULT, "default" );
318        $service->registerConfigOverride( SearchProfileService::DOCUMENT_SIZE_LIMITER,
319            SearchProfileService::CONTEXT_DEFAULT, $config, "CirrusSearchDocumentSizeLimiterProfile" );
320    }
321
322    /**
323     * @param SearchProfileService $service
324     * @param SearchConfig $config
325     */
326    private function loadFullTextQueryProfiles( SearchProfileService $service, SearchConfig $config ) {
327        $service->registerFileRepository( SearchProfileService::FT_QUERY_BUILDER, self::CIRRUS_BASE,
328            __DIR__ . '/../../profiles/FullTextQueryBuilderProfiles.config.php' );
329
330        $service->registerRepository( new ConfigProfileRepository( SearchProfileService::FT_QUERY_BUILDER, self::CIRRUS_CONFIG,
331            'CirrusSearchFullTextQueryBuilderProfiles', $config ) );
332        $service->registerRepository( new ExtensionRegistryProfileRepository( SearchProfileService::FT_QUERY_BUILDER,
333            self::EXTENSION_REGISTRY, 'CirrusSearchFullTextQueryBuilderProfiles', $this->extensionRegistry ) );
334
335        $service->registerDefaultProfile( SearchProfileService::FT_QUERY_BUILDER,
336            SearchProfileService::CONTEXT_DEFAULT, 'default' );
337        $service->registerConfigOverride( SearchProfileService::FT_QUERY_BUILDER,
338            SearchProfileService::CONTEXT_DEFAULT, $config, 'CirrusSearchFullTextQueryBuilderProfile' );
339        $service->registerUriParamOverride( SearchProfileService::FT_QUERY_BUILDER,
340            SearchProfileService::CONTEXT_DEFAULT, 'cirrusFTQBProfile' );
341    }
342
343    /**
344     * If the host wiki defines profiles in CirrusSearchCrossProjectProfiles
345     * we inject the defaults into the target wiki profile service using a static overrider
346     * with a prio that just supersedes the config default.
347     *
348     * Only rescore et ftbuilder are supported so far.
349     *
350     * @param SearchProfileService $service
351     * @param SearchConfig $config
352     */
353    private function loadInterwikiOverrides( SearchProfileService $service, SearchConfig $config ) {
354        if ( $config->isLocalWiki() || $config === $this->hostWikiConfig ) {
355            return;
356        }
357        $iwPrefix = $this->interwikiResolver->getInterwikiPrefix( $config->getWikiId() );
358        if ( $iwPrefix === null ) {
359            return;
360        }
361        $profiles = $this->hostWikiConfig->getElement( 'CirrusSearchCrossProjectProfiles', $iwPrefix );
362        if ( $profiles === null || !is_array( $profiles ) || $profiles === [] ) {
363            return;
364        }
365        if ( isset( $profiles['rescore'] ) ) {
366            $service->registerProfileOverride( SearchProfileService::RESCORE,
367                SearchProfileService::CONTEXT_DEFAULT,
368                new StaticProfileOverride( $profiles['rescore'], SearchProfileOverride::CONFIG_PRIO - 1 ) );
369        }
370
371        if ( isset( $profiles['ftbuilder'] ) ) {
372            $service->registerProfileOverride( SearchProfileService::FT_QUERY_BUILDER,
373                SearchProfileService::CONTEXT_DEFAULT,
374                new StaticProfileOverride( $profiles['ftbuilder'], SearchProfileOverride::CONFIG_PRIO - 1 ) );
375        }
376    }
377
378    private function loadFallbackProfiles( SearchProfileService $service, SearchConfig $config ) {
379        $service->registerFileRepository( SearchProfileService::FALLBACKS, self::CIRRUS_BASE,
380            __DIR__ . '/../../profiles/FallbackProfiles.config.php' );
381        $service->registerRepository( new ConfigProfileRepository( SearchProfileService::FALLBACKS, self::CIRRUS_CONFIG,
382            'CirrusSearchFallbackProfiles', $config ) );
383        $service->registerRepository( new ExtensionRegistryProfileRepository( SearchProfileService::FALLBACKS, self::EXTENSION_REGISTRY,
384            'CirrusSearchFallbackProfiles', $this->extensionRegistry ) );
385
386        $service->registerDefaultProfile( SearchProfileService::FALLBACKS,
387            SearchProfileService::CONTEXT_DEFAULT, 'none' );
388        $service->registerConfigOverride( SearchProfileService::FALLBACKS,
389            SearchProfileService::CONTEXT_DEFAULT, $config, 'CirrusSearchFallbackProfile' );
390        $service->registerUriParamOverride( SearchProfileService::FALLBACKS,
391            SearchProfileService::CONTEXT_DEFAULT, 'cirrusFallbackProfile' );
392    }
393}