SearchApi.php

Go to the documentation of this file.

<?php
use MediaWiki\MediaWikiServices;
 
trait SearchApi {
 
    private static $BACKEND_NULL_PARAM = 'database-backed';
 
    public function buildCommonApiParams( $isScrollable = true ) {
        $params = [
            'search' => [
                ApiBase::PARAM_TYPE => 'string',
                ApiBase::PARAM_REQUIRED => true,
            ],
            'namespace' => [
                ApiBase::PARAM_DFLT => NS_MAIN,
                ApiBase::PARAM_TYPE => 'namespace',
                ApiBase::PARAM_ISMULTI => true,
            ],
            'limit' => [
                ApiBase::PARAM_DFLT => 10,
                ApiBase::PARAM_TYPE => 'limit',
                ApiBase::PARAM_MIN => 1,
                ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
                ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2,
            ],
        ];
        if ( $isScrollable ) {
            $params['offset'] = [
                ApiBase::PARAM_DFLT => 0,
                ApiBase::PARAM_TYPE => 'integer',
                ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
            ];
        }
 
        $searchConfig = MediaWikiServices::getInstance()->getSearchEngineConfig();
        $alternatives = $searchConfig->getSearchTypes();
        if ( count( $alternatives ) > 1 ) {
            if ( $alternatives[0] === null ) {
                $alternatives[0] = self::$BACKEND_NULL_PARAM;
            }
            $this->allowedParams['backend'] = [
                ApiBase::PARAM_DFLT => $searchConfig->getSearchType(),
                ApiBase::PARAM_TYPE => $alternatives,
            ];
            // @todo: support profile selection when multiple
            // backends are available. The solution could be to
            // merge all possible profiles and let ApiBase
            // subclasses do the check. Making ApiHelp and ApiSandbox
            // comprehensive might be more difficult.
        } else {
            $params += $this->buildProfileApiParam();
        }
 
        return $params;
    }
 
    private function buildProfileApiParam() {
        $configs = $this->getSearchProfileParams();
        $searchEngine = MediaWikiServices::getInstance()->newSearchEngine();
        $params = [];
        foreach ( $configs as $paramName => $paramConfig ) {
            $profiles = $searchEngine->getProfiles( $paramConfig['profile-type'],
                $this->getContext()->getUser() );
            if ( !$profiles ) {
                continue;
            }
 
            $types = [];
            $helpMessages = [];
            $defaultProfile = null;
            foreach ( $profiles as $profile ) {
                $types[] = $profile['name'];
                if ( isset ( $profile['desc-message'] ) ) {
                    $helpMessages[$profile['name']] = $profile['desc-message'];
                }
                if ( !empty( $profile['default'] ) ) {
                    $defaultProfile = $profile['name'];
                }
            }
 
            $params[$paramName] = [
                ApiBase::PARAM_TYPE => $types,
                ApiBase::PARAM_HELP_MSG => $paramConfig['help-message'],
                ApiBase::PARAM_HELP_MSG_PER_VALUE => $helpMessages,
                ApiBase::PARAM_DFLT => $defaultProfile,
            ];
        }
 
        return $params;
    }
 
    public function buildSearchEngine( array $params = null ) {
        if ( $params != null ) {
            $type = isset( $params['backend'] ) ? $params['backend'] : null;
            if ( $type === self::$BACKEND_NULL_PARAM ) {
                $type = null;
            }
            $searchEngine = MediaWikiServices::getInstance()->getSearchEngineFactory()->create( $type );
            $limit = $params['limit'];
            $searchEngine->setNamespaces( $params['namespace'] );
            $offset = null;
            if ( isset( $params['offset'] ) ) {
                // If the API supports offset then it probably
                // wants to fetch limit+1 so it can check if
                // more results are available to properly set
                // the continue param
                $offset = $params['offset'];
                $limit += 1;
            }
            $searchEngine->setLimitOffset( $limit, $offset );
 
            // Initialize requested search profiles.
            $configs = $this->getSearchProfileParams();
            foreach ( $configs as $paramName => $paramConfig ) {
                if ( isset( $params[$paramName] ) ) {
                    $searchEngine->setFeatureData(
                        $paramConfig['profile-type'],
                        $params[$paramName]
                    );
                }
            }
        } else {
            $searchEngine = MediaWikiServices::getInstance()->newSearchEngine();
        }
        return $searchEngine;
    }
 
    abstract public function getSearchProfileParams();
 
    abstract public function getContext();
}