<?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
* http://www.gnu.org/copyleft/gpl.html
*/
-if (!defined('MEDIAWIKI')) {
+if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
- require_once ("ApiFormatBase.php");
+ require_once( "ApiBase.php" );
}
-class ApiOpenSearch extends ApiFormatBase {
+/**
+ * @ingroup API
+ */
+class ApiOpenSearch extends ApiBase {
- private $mResult = array();
-
- public function __construct($main, $action) {
- parent :: __construct($main, $action);
+ public function __construct( $main, $action ) {
+ parent::__construct( $main, $action );
}
- public function getMimeType() {
- return 'application/json';
+ public function getCustomPrinter() {
+ return $this->getMain()->createPrinterByName( 'json' );
}
public function execute() {
- $command = null;
- extract($this->ExtractRequestParams());
-
- // Prepare nested request
- $params = new FauxRequest(array (
- 'action' => 'query',
- 'list' => 'allpages',
- 'apnamespace' => 0,
- 'aplimit' => 10,
- 'apprefix' => $command
- ));
-
- // Execute
- $module = new ApiMain($params);
- $module->execute();
-
- // Get clean data
- $result =& $module->getResult();
- $result->SanitizeData();
- $data = $result->GetData();
-
- // Reformat useful data for future printing
- $result = array();
- foreach ($data['query']['allpages'] as $pageid => &$pageinfo) {
- $result[] = $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 );
}
-
- $this->mResult = array($command, $result);
- }
-
- public function executePrinter() {
- $json = new Services_JSON();
- $this->printText($json->encode($this->mResult, true));
+ // Set top level elements
+ $result = $this->getResult();
+ $result->addValue( null, 0, $search );
+ $result->addValue( null, 1, $srchres );
}
- protected function GetAllowedParams() {
- return array (
- 'command' => 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 (
- 'command' => '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 (
- 'api.php?action=opensearch&command=Te'
+ protected function getExamples() {
+ return array(
+ 'api.php?action=opensearch&search=Te'
);
}
return __CLASS__ . ': $Id$';
}
}
-?>
\ No newline at end of file