MediaWiki 1.17.0

[autoinstallsdev/mediawiki.git] / includes / api / ApiRsd.php

diff --git a/includes/api/ApiRsd.php b/includes/api/ApiRsd.php
new file mode 100644 (file)
index 0000000..7bc4722
--- /dev/null
+++ b/includes/api/ApiRsd.php
@@ -0,0 +1,180 @@
+<?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, 'http://www.mediawiki.org/', 'engineLink' );
+
+               $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'] : '',
+                       );
+                       $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: ApiRsd.php 76195 2010-11-06 15:57:15Z btongminh $';
+       }
+}
+
+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: ApiRsd.php 76195 2010-11-06 15:57:15Z btongminh $';
+       }
+}