ApiOpenSearch.php

Go to the documentation of this file.

<?php
class ApiOpenSearch extends ApiBase {

        public function __construct( $main, $action ) {
                parent::__construct( $main, $action );
        }

        public function getCustomPrinter() {
                return $this->getMain()->createPrinterByName( 'json' );
        }

        public function execute() {
                global $wgEnableOpenSearchSuggest, $wgSearchSuggestCacheExpiry;
                $params = $this->extractRequestParams();
                $search = $params['search'];
                $limit = $params['limit'];
                $namespaces = $params['namespace'];
                $suggest = $params['suggest'];

                // MWSuggest or similar hit
                if ( $suggest && !$wgEnableOpenSearchSuggest ) {
                        $searches = array();
                } else {
                        // Open search results may be stored for a very long time
                        $this->getMain()->setCacheMaxAge( $wgSearchSuggestCacheExpiry );
                        $this->getMain()->setCacheMode( 'public' );

                        $searches = PrefixSearch::titleSearch( $search, $limit,
                                $namespaces );

                        // if the content language has variants, try to retrieve fallback results
                        $fallbackLimit = $limit - count( $searches );
                        if ( $fallbackLimit > 0 ) {
                                global $wgContLang;

                                $fallbackSearches = $wgContLang->autoConvertToAllVariants( $search );
                                $fallbackSearches = array_diff( array_unique( $fallbackSearches ), array( $search ) );

                                foreach ( $fallbackSearches as $fbs ) {
                                        $fallbackSearchResult = PrefixSearch::titleSearch( $fbs, $fallbackLimit,
                                                $namespaces );
                                        $searches = array_merge( $searches, $fallbackSearchResult );
                                        $fallbackLimit -= count( $fallbackSearchResult );

                                        if ( $fallbackLimit == 0 ) {
                                                break;
                                        }
                                }
                        }
                }
                // Set top level elements
                $result = $this->getResult();
                $result->addValue( null, 0, $search );
                $result->addValue( null, 1, $searches );
        }

        public function getAllowedParams() {
                return array(
                        'search' => null,
                        'limit' => array(
                                ApiBase::PARAM_DFLT => 10,
                                ApiBase::PARAM_TYPE => 'limit',
                                ApiBase::PARAM_MIN => 1,
                                ApiBase::PARAM_MAX => 100,
                                ApiBase::PARAM_MAX2 => 100
                        ),
                        'namespace' => array(
                                ApiBase::PARAM_DFLT => NS_MAIN,
                                ApiBase::PARAM_TYPE => 'namespace',
                                ApiBase::PARAM_ISMULTI => true
                        ),
                        'suggest' => false,
                );
        }

        public function getParamDescription() {
                return array(
                        'search' => 'Search string',
                        'limit' => 'Maximum amount of results to return',
                        'namespace' => 'Namespaces to search',
                        'suggest' => 'Do nothing if $wgEnableOpenSearchSuggest is false',
                );
        }

        public function getDescription() {
                return 'Search the wiki using the OpenSearch protocol';
        }

        public function getExamples() {
                return array(
                        'api.php?action=opensearch&search=Te'
                );
        }

        public function getHelpUrls() {
                return 'https://www.mediawiki.org/wiki/API:Opensearch';
        }

        public function getVersion() {
                return __CLASS__ . ': $Id$';
        }
}