X-Git-Url: https://git.heureux-cyclage.org/?a=blobdiff_plain;f=includes%2Fapi%2FApiOpenSearch.php;h=19741b00fa53a2f4835b2f2c30bce0a9be563a5e;hb=442bec4f9bb83ccaeaccca4588e309c9777970ca;hp=8b24af91f936d5e53deffd47aa47e94f1d137a30;hpb=398160f15e748e1b09388b20d43029c940877a30;p=lhc%2Fweb%2Fwiklou.git

diff --git a/includes/api/ApiOpenSearch.php b/includes/api/ApiOpenSearch.php
index 8b24af91f9..19741b00fa 100644
--- a/includes/api/ApiOpenSearch.php
+++ b/includes/api/ApiOpenSearch.php
@@ -1,12 +1,10 @@
 <?php
-
-
-/*
- * Created on Oct 13, 2006
+/**
  *
- * API for MediaWiki 1.8+
  *
- * Copyright (C) 2006 Yuri Astrakhan <FirstnameLastname@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
@@ -20,81 +18,109 @@
  *
  * 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')) {
+if ( !defined( 'MEDIAWIKI' ) ) {
 	// Eclipse helper - will be ignored in production
-	require_once ("ApiBase.php");
+	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() {
-		$search = null;
-		extract($this->ExtractRequestParams());
-
-		$title = Title :: newFromText($search);
-		if(!$title)
-			return; // Return empty result
+		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 );
 			
-		// Prepare nested request
-		$params = new FauxRequest(array (
-			'action' => 'query',
-			'list' => 'allpages',
-			'apnamespace' => $title->getNamespace(),
-			'aplimit' => 10,
-			'apprefix' => $title->getDBkey()
-		));
-
-		// Execute
-		$module = new ApiMain($params);
-		$module->execute();
-
-		// Get clean data
-		$data = & $module->getResultData();
-
-		// Reformat useful data for future printing by JSON engine
-		$srchres = array ();
-		foreach ($data['query']['allpages'] as $pageid => & $pageinfo) {
-			// Note: this data will no be printable by the xml engine
-			// because it does not support lists of unnamed items
-			$srchres[] = $pageinfo['title'];
+			// 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 );
 	}
 
-	protected function getAllowedParams() {
-		return array (
-			'search' => null
+	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,
 		);
 	}
 
-	protected function getParamDescription() {
-		return array (
-			'search' => 'Search string'
+	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',
 		);
 	}
 
-	protected function getDescription() {
+	public function getDescription() {
 		return 'This module implements OpenSearch protocol';
 	}
 
 	protected function getExamples() {
-		return array (
+		return array(
 			'api.php?action=opensearch&search=Te'
 		);
 	}
@@ -103,4 +129,3 @@ class ApiOpenSearch extends ApiBase {
 		return __CLASS__ . ': $Id$';
 	}
 }
-?>
\ No newline at end of file