1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
|
<?php
/*
* Created on Oct 13, 2006
*
* API for MediaWiki 1.8+
*
* Copyright (C) 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
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* 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.
* http://www.gnu.org/copyleft/gpl.html
*/
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 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 )
$srchres = array();
else {
// Open search results may be stored for a very long
// time
$this->getMain()->setCacheMaxAge( $wgSearchSuggestCacheExpiry );
$this->getMain()->setCacheMode( 'public' );
$srchres = PrefixSearch::titleSearch( $search, $limit,
$namespaces );
}
// Set top level elements
$result = $this->getResult();
$result->addValue( null, 0, $search );
$result->addValue( null, 1, $srchres );
}
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 'This module implements OpenSearch protocol';
}
protected function getExamples() {
return array (
'api.php?action=opensearch&search=Te'
);
}
public function getVersion() {
return __CLASS__ . ': $Id: ApiOpenSearch.php 69932 2010-07-26 08:03:21Z tstarling $';
}
}
|
