X-Git-Url: http://git.heureux-cyclage.org/?a=blobdiff_plain;f=includes%2Fapi%2FApiOpenSearch.php;h=397d715c456f52c9fb8351ae1ce5a52eeb98f2cb;hb=c286869e3825733e17ca1a5a3f239797ec146d14;hp=2778037b9c9c42aa056b51265c0ade588998e311;hpb=262435b9f8a1b5ba478af3e638ec2999a73aff51;p=lhc%2Fweb%2Fwiklou.git

diff --git a/includes/api/ApiOpenSearch.php b/includes/api/ApiOpenSearch.php
index 2778037b9c..397d715c45 100644
--- a/includes/api/ApiOpenSearch.php
+++ b/includes/api/ApiOpenSearch.php
@@ -1,12 +1,11 @@
 <?php
 
-
-/*
+/**
  * Created on Oct 13, 2006
  *
  * API for MediaWiki 1.8+
  *
- * Copyright (C) 2006 Yuri Astrakhan <FirstnameLastname@gmail.com>
+ * 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
@@ -24,75 +23,84 @@
  * http://www.gnu.org/copyleft/gpl.html
  */
 
-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());
-		
-		// Prepare nested request
-		$params = new FauxRequest(array (
-			'action' => 'query',
-			'list' => 'allpages',
-			'apnamespace' => 0,
-			'aplimit' => 10,
-			'apprefix' => $search
-		));
-		
-		// Execute
-		$module = new ApiMain($params);
-		$module->execute();
-		
-		// Get clean data
-		$result =& $module->getResult();
-		$result->SanitizeData();
-		$data =& $result->GetData();
-		
-		// 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'];
+		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 ) {
+			$srchres = array();
+		} else {
+			// Open search results may be stored for a very long
+			// time
+			$this->getMain()->setCacheMaxAge( $wgSearchSuggestCacheExpiry );
+			$this->getMain()->setCacheControl( array( 'must-revalidate' => false ) );
+
+			$srchres = PrefixSearch::titleSearch( $search, $limit,
+				$namespaces );
 		}
-		
 		// 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, $srchres );
 	}
-	
-	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 (
+	protected function getExamples() {
+		return array(
 			'api.php?action=opensearch&search=Te'
 		);
 	}
@@ -101,4 +109,3 @@ class ApiOpenSearch extends ApiBase {
 		return __CLASS__ . ': $Id$';
 	}
 }
-?>
\ No newline at end of file