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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
|
<?php
/**
* API for MediaWiki 1.17+
*
* Created on October 26, 2010
*
* Copyright © 2010 Bryan Tong Minh and Brion Vibber
*
* 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.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
require_once( 'ApiBase.php' );
}
/**
* API module for sending out RSD information
* @ingroup API
*/
class ApiRsd extends ApiBase {
public function __construct( $main, $action ) {
parent::__construct( $main, $action );
}
public function execute() {
$result = $this->getResult();
$result->addValue( null, 'version', '1.0' );
$result->addValue( null, 'xmlns', 'http://archipelago.phrasewise.com/rsd' );
$service = array( 'apis' => $this->formatRsdApiList() );
ApiResult::setContent( $service, 'MediaWiki', 'engineName' );
ApiResult::setContent( $service, 'https://www.mediawiki.org/', 'engineLink' );
ApiResult::setContent( $service, Title::newMainPage()->getCanonicalUrl(), 'homePageLink' );
$result->setIndexedTagName( $service['apis'], 'api' );
$result->addValue( null, 'service', $service );
}
public function getCustomPrinter() {
return new ApiFormatXmlRsd( $this->getMain(), 'xml' );
}
public function getAllowedParams() {
return array();
}
public function getParamDescription() {
return array();
}
public function getDescription() {
return 'Export an RSD (Really Simple Discovery) schema';
}
protected function getExamples() {
return array(
'api.php?action=rsd'
);
}
/**
* Builds an internal list of APIs to expose information about.
* Normally this only lists the MediaWiki API, with its base URL,
* link to documentation, and a marker as to available authentication
* (to aid in OAuth client apps switching to support in the future).
*
* Extensions can expose other APIs, such as WordPress or Twitter-
* compatible APIs, by hooking 'ApiRsdServiceApis' and adding more
* elements to the array.
*
* See http://cyber.law.harvard.edu/blogs/gems/tech/rsd.html for
* the base RSD spec, and check WordPress and StatusNet sites for
* in-production examples listing several blogging and micrblogging
* APIs.
*
* @return array
*/
protected function getRsdApiList() {
$apis = array(
'MediaWiki' => array(
// The API link is required for all RSD API entries.
'apiLink' => wfExpandUrl( wfScript( 'api' ), PROTO_CURRENT ),
// Docs link is optional, but recommended.
'docs' => 'https://www.mediawiki.org/wiki/API',
// Some APIs may need a blog ID, but it may be left blank.
'blogID' => '',
// Additional settings are optional.
'settings' => array(
// Change this to true in the future as an aid to
// machine discovery of OAuth for API access.
'OAuth' => false,
)
),
);
wfRunHooks( 'ApiRsdServiceApis', array( &$apis ) );
return $apis;
}
/**
* Formats the internal list of exposed APIs into an array suitable
* to pass to the API's XML formatter.
*
* @return array
*/
protected function formatRsdApiList() {
$apis = $this->getRsdApiList();
$outputData = array();
foreach ( $apis as $name => $info ) {
$data = array(
'name' => $name,
'preferred' => wfBoolToStr( $name == 'MediaWiki' ),
'apiLink' => $info['apiLink'],
'blogID' => isset( $info['blogID'] ) ? $info['blogID'] : '',
);
$settings = array();
if ( isset( $info['docs'] ) ) {
ApiResult::setContent( $settings, $info['docs'], 'docs' );
}
if ( isset( $info['settings'] ) ) {
foreach ( $info['settings'] as $setting => $val ) {
if ( is_bool( $val ) ) {
$xmlVal = wfBoolToStr( $val );
} else {
$xmlVal = $val;
}
$setting = array( 'name' => $setting );
ApiResult::setContent( $setting, $xmlVal );
$settings[] = $setting;
}
}
if ( count( $settings ) ) {
$this->getResult()->setIndexedTagName( $settings, 'setting' );
$data['settings'] = $settings;
}
$outputData[] = $data;
}
return $outputData;
}
public function getVersion() {
return __CLASS__ . ': $Id$';
}
}
class ApiFormatXmlRsd extends ApiFormatXml {
public function __construct( $main, $format ) {
parent::__construct( $main, $format );
$this->setRootElement( 'rsd' );
}
public function getMimeType() {
return 'application/rsd+xml';
}
public function getVersion() {
return __CLASS__ . ': $Id$';
}
}
|
