185 lines
4.3 KiB
PHP
185 lines
4.3 KiB
PHP
<?php
|
|
|
|
use MediaWiki\HookContainer\HookContainer;
|
|
use MediaWiki\HookContainer\HookRunner;
|
|
use MediaWiki\MainConfigNames;
|
|
use MediaWiki\User\UserIdentity;
|
|
use MediaWiki\User\UserOptionsLookup;
|
|
|
|
/**
|
|
* Configuration handling class for SearchEngine.
|
|
* Provides added service over plain configuration.
|
|
*
|
|
* @since 1.27
|
|
*/
|
|
class SearchEngineConfig {
|
|
|
|
/**
|
|
* Config object from which the settings will be derived.
|
|
* @var Config
|
|
*/
|
|
private $config;
|
|
|
|
/**
|
|
* Current language
|
|
* @var Language
|
|
*/
|
|
private $language;
|
|
|
|
/**
|
|
* Search Engine Mappings
|
|
*
|
|
* Key is the canonical name (used in $wgSearchType and $wgSearchTypeAlternatives).
|
|
* Value is a specification for ObjectFactory.
|
|
*
|
|
* @var array
|
|
*/
|
|
private $engineMappings;
|
|
|
|
/**
|
|
* @var HookRunner
|
|
*/
|
|
private $hookRunner;
|
|
|
|
/**
|
|
* @var UserOptionsLookup
|
|
*/
|
|
private $userOptionsLookup;
|
|
|
|
/**
|
|
* @param Config $config
|
|
* @param Language $lang
|
|
* @param HookContainer $hookContainer
|
|
* @param array $mappings
|
|
* @param UserOptionsLookup $userOptionsLookup
|
|
*/
|
|
public function __construct(
|
|
Config $config,
|
|
Language $lang,
|
|
HookContainer $hookContainer,
|
|
array $mappings,
|
|
UserOptionsLookup $userOptionsLookup
|
|
) {
|
|
$this->config = $config;
|
|
$this->language = $lang;
|
|
$this->engineMappings = $mappings;
|
|
$this->hookRunner = new HookRunner( $hookContainer );
|
|
$this->userOptionsLookup = $userOptionsLookup;
|
|
}
|
|
|
|
/**
|
|
* Retrieve original config.
|
|
* @return Config
|
|
*/
|
|
public function getConfig() {
|
|
return $this->config;
|
|
}
|
|
|
|
/**
|
|
* Make a list of searchable namespaces and their localized names.
|
|
* @return string[] Namespace ID => name
|
|
* @phan-return array<int,string>
|
|
*/
|
|
public function searchableNamespaces() {
|
|
$arr = [];
|
|
foreach ( $this->language->getNamespaces() as $ns => $name ) {
|
|
if ( $ns >= NS_MAIN ) {
|
|
$arr[$ns] = $name;
|
|
}
|
|
}
|
|
|
|
$this->hookRunner->onSearchableNamespaces( $arr );
|
|
return $arr;
|
|
}
|
|
|
|
/**
|
|
* Extract default namespaces to search from the given user's
|
|
* settings, returning a list of index numbers.
|
|
*
|
|
* @param UserIdentity $user
|
|
* @return int[]
|
|
*/
|
|
public function userNamespaces( $user ) {
|
|
$arr = [];
|
|
foreach ( $this->searchableNamespaces() as $ns => $name ) {
|
|
if ( $this->userOptionsLookup->getOption( $user, 'searchNs' . $ns ) ) {
|
|
$arr[] = $ns;
|
|
}
|
|
}
|
|
|
|
return $arr;
|
|
}
|
|
|
|
/**
|
|
* An array of namespaces indexes to be searched by default
|
|
*
|
|
* @return int[] Namespace IDs
|
|
*/
|
|
public function defaultNamespaces() {
|
|
return array_keys( $this->config->get( MainConfigNames::NamespacesToBeSearchedDefault ),
|
|
true );
|
|
}
|
|
|
|
/**
|
|
* Return the search engines we support. If only $wgSearchType
|
|
* is set, it'll be an array of just that one item.
|
|
*
|
|
* @return array
|
|
*/
|
|
public function getSearchTypes() {
|
|
$alternatives = $this->config->get( MainConfigNames::SearchTypeAlternatives ) ?: [];
|
|
array_unshift( $alternatives, $this->config->get( MainConfigNames::SearchType ) );
|
|
|
|
return $alternatives;
|
|
}
|
|
|
|
/**
|
|
* Return the search engine configured in $wgSearchType, etc.
|
|
*
|
|
* @return string|null
|
|
*/
|
|
public function getSearchType() {
|
|
return $this->config->get( MainConfigNames::SearchType );
|
|
}
|
|
|
|
/**
|
|
* Returns the mappings between canonical search name and underlying PHP class
|
|
*
|
|
* Key is the canonical name (used in $wgSearchType and $wgSearchTypeAlternatives).
|
|
* Value is a specification for ObjectFactory.
|
|
*
|
|
* For example to be able to use 'foobarsearch' in $wgSearchType and
|
|
* $wgSearchTypeAlternatives but the PHP class for 'foobarsearch'
|
|
* is 'MediaWiki\Extension\FoobarSearch\FoobarSearch' set:
|
|
*
|
|
* @par extension.json Example:
|
|
* @code
|
|
* "SearchMappings": {
|
|
* "foobarsearch": { "class": "MediaWiki\\Extension\\FoobarSearch\\FoobarSearch" }
|
|
* }
|
|
* @endcode
|
|
*
|
|
* @since 1.35
|
|
* @return array
|
|
*/
|
|
public function getSearchMappings() {
|
|
return $this->engineMappings;
|
|
}
|
|
|
|
/**
|
|
* Get a list of namespace names useful for showing in tooltips
|
|
* and preferences.
|
|
*
|
|
* @param int[] $namespaces
|
|
* @return string[] List of names
|
|
*/
|
|
public function namespacesAsText( $namespaces ) {
|
|
$formatted = array_map( [ $this->language, 'getFormattedNsText' ], $namespaces );
|
|
foreach ( $formatted as $key => $ns ) {
|
|
if ( empty( $ns ) ) {
|
|
$formatted[$key] = wfMessage( 'blanknamespace' )->text();
|
|
}
|
|
}
|
|
return $formatted;
|
|
}
|
|
}
|