Merge "Added assertArrayEquals method to MediaWikiTestCase to avoid duplicating asort...

[lhc/web/wiklou.git] / includes / api / ApiOpenSearch.php

diff --git a/includes/api/ApiOpenSearch.php b/includes/api/ApiOpenSearch.php
index 50e82c0..0727cff 100644 (file)
--- a/includes/api/ApiOpenSearch.php
+++ b/includes/api/ApiOpenSearch.php
@@ -1,11 +1,10 @@
 <?php
-
-/*
- * Created on Oct 13, 2006
+/**
  *
- * API for MediaWiki 1.8+
  *
- * Copyright (C) 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
+ * Created on Oct 13, 2006
+ *
+ * Copyright © 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
  *
  * 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
@@ -19,97 +18,112 @@
  *
  * 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.,
- * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
  */
 
-if (!defined('MEDIAWIKI')) {
-       // Eclipse helper - will be ignored in production
-       require_once ("ApiBase.php");
-}
-
 /**
  * @ingroup API
  */
 class ApiOpenSearch extends ApiBase {
 
-       public function __construct($main, $action) {
-               parent :: __construct($main, $action);
+       public function __construct( $main, $action ) {
+               parent::__construct( $main, $action );
        }
 
        public function getCustomPrinter() {
-               return $this->getMain()->createPrinterByName('json');
+               return $this->getMain()->createPrinterByName( 'json' );
        }
 
        public function execute() {
+               global $wgEnableOpenSearchSuggest, $wgSearchSuggestCacheExpiry;
                $params = $this->extractRequestParams();
                $search = $params['search'];
                $limit = $params['limit'];
                $namespaces = $params['namespace'];
-               
-               // Open search results may be stored for a very long time
-               $this->getMain()->setCacheMaxAge(1200);
-
-               $srchres = PrefixSearch::titleSearch( $search, $limit, $namespaces );
-               
-               if( $params['redirects'] ) {
-                       foreach( $srchres as &$t ) {
-                               $title = Title::newFromText( $t );
-                               if( is_null( $title ) ) {
-                                       continue;
-                               }
-                               $article = new Article( $title );
-                               $redirTitle = $article->getRedirectTarget();
-                               if( !is_null( $redirTitle ) ) {
-                                       $t = $redirTitle->getPrefixedText();
+               $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, $srchres);
+               $result->addValue( null, 0, $search );
+               $result->addValue( null, 1, $searches );
        }
 
        public function getAllowedParams() {
-               return array (
+               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
+                       '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
+                               ApiBase::PARAM_DFLT => NS_MAIN,
+                               ApiBase::PARAM_TYPE => 'namespace',
+                               ApiBase::PARAM_ISMULTI => true
                        ),
-                       'redirects' => false,
+                       'suggest' => false,
                );
        }
 
        public function getParamDescription() {
-               return array (
+               return array(
                        'search' => 'Search string',
                        'limit' => 'Maximum amount of results to return',
                        'namespace' => 'Namespaces to search',
-                       'redirects' => 'Resolve redirects',
+                       'suggest' => 'Do nothing if $wgEnableOpenSearchSuggest is false',
                );
        }
 
        public function getDescription() {
-               return 'This module implements OpenSearch protocol';
+               return 'Search the wiki using the OpenSearch protocol';
        }
 
-       protected function getExamples() {
-               return array (
+       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$';
        }