Thijs/wiki.techinc.nl
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

(bug 25648) API discovery information has been added as RSD link in page <head> and by providing an API module action=rsd. Added hook ApiRsdServiceApis for extensions to add their own service to the services list.

Browse source 
Patch by Brion Vibber and Bryan Tong Minh.
This commit is contained in:
Bryan Tong Minh 2010-10-28 19:20:21 +00:00
parent 2808a0d43f
commit e9fd126b9a
6 changed files with 206 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
RELEASE-NOTES
View file

@ -455,6 +455,10 @@ it from source control: http://www.mediawiki.org/wiki/Download_from_SVN
id, try the parser cache, and save it to it if necessary
* (bug 25463) Export header should not be shown if no pages were requested, to
reduce confusion
* (bug 25648) API discovery information has been added as RSD link in page
<head> and by providing an API module action=rsd. Added hook
ApiRsdServiceApis for extensions to add their own service to the services
list.
=== Languages updated in 1.17 ===

7
docs/hooks.txt
View file

@ -362,6 +362,13 @@ is the User object. In the hook, just add your callback to the
$tokenFunctions array and return true (returning false makes no sense)
$tokenFunctions: array(action => callback)
'ApiRsdServiceApis': Add or remove APIs from the RSD services list.
Each service should have its own entry in the $apis array and have a
unique name, passed as key for the array that represents the service data.
In this data array, the key-value-pair identified by the apiLink key is
required.
&$apis: array of services
'ArticleAfterFetchContent': after fetching content of an article from
the database
$article: the article (object) being loaded from the database

1
includes/AutoLoader.php
View file

@ -297,6 +297,7 @@ $wgAutoloadLocalClasses = array(
'ApiPatrol' => 'includes/api/ApiPatrol.php',
'ApiProtect' => 'includes/api/ApiProtect.php',
'ApiPurge' => 'includes/api/ApiPurge.php',
'ApiRsd' => 'includes/api/ApiRsd.php',
'ApiQuery' => 'includes/api/ApiQuery.php',
'ApiQueryAllCategories' => 'includes/api/ApiQueryAllCategories.php',
'ApiQueryAllimages' => 'includes/api/ApiQueryAllimages.php',

10
includes/Skin.php
View file

@ -216,6 +216,16 @@ class Skin extends Linker {
'title' => wfMsgForContent( 'opensearch-desc' ),
) );
# Real Simple Discovery link, provides auto-discovery information
# for the MediaWiki API (and potentially additional custom API
# support such as WordPress or Twitter-compatible APIs for a
# blogging extension, etc)
$out->addLink( array(
'rel' => 'EditURI',
'type' => 'application/rsd+xml',
'href' => wfExpandUrl( wfAppendQuery( wfScript( 'api' ), array( 'action' => 'rsd' ) ) ),
) );
$this->addMetadataLinks( $out );
$this->mRevisionId = $out->mRevisionId;

1
includes/api/ApiMain.php
View file

@ -63,6 +63,7 @@ class ApiMain extends ApiBase {
'feedwatchlist' => 'ApiFeedWatchlist',
'help' => 'ApiHelp',
'paraminfo' => 'ApiParamInfo',
'rsd' => 'ApiRsd',
// Write modules
'purge' => 'ApiPurge',

183
includes/api/ApiRsd.php Normal file
View file

@ -0,0 +1,183 @@
<?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 interface for page purging
* @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(
'engineName' => array(
'*' => 'MediaWiki'
),
'engineLink' => array(
'*' => 'http://www.mediawiki.org/'
),
'apis' => $this->formatRsdApiList()
);
$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 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' ) ),
// Docs link is optional, but recommended.
'docs' => 'http://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'] : ''
);
if ( isset( $info['docs'] ) ) {
$data['settings']['docs'] = array(
'*' => $info['docs'],
);
}
if ( isset( $info['settings'] ) ) {
foreach ( $info['settings'] as $setting => $val ) {
if ( is_bool( $val ) ) {
$xmlVal = wfBoolToStr( $val );
} else {
$xmlVal = $val;
}
$data['settings'][] = array(
'name' => $setting,
'*' => $xmlVal,
);
}
}
if ( isset( $data['settings'] ) ) {
$data['settings']['_element'] = 'setting';
}
$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';
}
}