1 files changed, 102 insertions, 13 deletions

diff --git a/includes/api/ApiHelp.php b/includes/api/ApiHelp.php
index 1f32e019..eedbde13 100644
--- a/includes/api/ApiHelp.php
+++ b/includes/api/ApiHelp.php
@@ -1,11 +1,10 @@
 <?php
-
-/*
- * Created on Sep 6, 2006
- *
+/**
  * API for MediaWiki 1.8+
  *
- * Copyright (C) 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
+ * Created on Sep 6, 2006
+ *
+ * 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
@@ -19,13 +18,15 @@
  *
  * 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.
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
  */
 
 if ( !defined( 'MEDIAWIKI' ) ) {
 	// Eclipse helper - will be ignored in production
-	require_once ( 'ApiBase.php' );
+	require_once( 'ApiBase.php' );
 }
 
 /**
@@ -36,14 +37,71 @@ if ( !defined( 'MEDIAWIKI' ) ) {
 class ApiHelp extends ApiBase {
 
 	public function __construct( $main, $action ) {
-		parent :: __construct( $main, $action );
+		parent::__construct( $main, $action );
 	}
 
 	/**
-	 * Stub module for displaying help when no parameters are given
+	 * Module for displaying help
 	 */
 	public function execute() {
-		$this->dieUsage( '', 'help' );
+		// Get parameters
+		$params = $this->extractRequestParams();
+
+		if ( !isset( $params['modules'] ) && !isset( $params['querymodules'] ) ) {
+			$this->dieUsage( '', 'help' );
+		}
+
+		$this->getMain()->setHelp();
+
+		$result = $this->getResult();
+		$queryObj = new ApiQuery( $this->getMain(), 'query' );
+		$r = array();
+		if ( is_array( $params['modules'] ) ) {
+			$modArr = $this->getMain()->getModules();
+
+			foreach ( $params['modules'] as $m ) {
+				if ( !isset( $modArr[$m] ) ) {
+					$r[] = array( 'name' => $m, 'missing' => '' );
+					continue;
+				}
+				$module = new $modArr[$m]( $this->getMain(), $m );
+
+				$r[] = $this->buildModuleHelp( $module, 'action' );
+			}
+		}
+
+		if ( is_array( $params['querymodules'] ) ) {
+			$qmodArr = $queryObj->getModules();
+
+			foreach ( $params['querymodules'] as $qm ) {
+				if ( !isset( $qmodArr[$qm] ) ) {
+					$r[] = array( 'name' => $qm, 'missing' => '' );
+					continue;
+				}
+				$module = new $qmodArr[$qm]( $this, $qm );
+				$type = $queryObj->getModuleType( $qm );
+
+				if ( $type === null ) {
+					$r[] = array( 'name' => $qm, 'missing' => '' );
+					continue;
+				}
+
+				$r[] = $this->buildModuleHelp( $module, $type );
+			}
+		}
+		$result->setIndexedTagName( $r, 'module' );
+		$result->addValue( null, $this->getModuleName(), $r );
+	}
+
+	private function buildModuleHelp( $module, $type ) {
+		$msg = ApiMain::makeHelpMsgHeader( $module, $type );
+
+		$msg2 = $module->makeHelpMsg();
+		if ( $msg2 !== false ) {
+			$msg .= $msg2;
+		}
+
+		return $msg;
 	}
 
 	public function shouldCheckMaxlag() {
@@ -54,13 +112,44 @@ class ApiHelp extends ApiBase {
 		return false;
 	}
 
+	public function getAllowedParams() {
+		return array(
+			'modules' => array(
+				ApiBase::PARAM_ISMULTI => true
+			),
+			'querymodules' => array(
+				ApiBase::PARAM_ISMULTI => true
+			),
+		);
+	}
+
+	public function getParamDescription() {
+		return array(
+			'modules' => 'List of module names (value of the action= parameter)',
+			'querymodules' => 'List of query module names (value of prop=, meta= or list= parameter)',
+		);
+	}
+
 	public function getDescription() {
-		return array (
-			'Display this help screen.'
+		return 'Display this help screen. Or the help screen for the specified module';
+	}
+
+	protected function getExamples() {
+		return array(
+			'Whole help page:',
+			'  api.php?action=help',
+			'Module (action) help page:',
+			'  api.php?action=help&modules=protect',
+			'Query (list) modules help page:',
+			'  api.php?action=help&querymodules=categorymembers',
+			'Query (prop) modules help page:',
+			'  api.php?action=help&querymodules=info',
+			'Query (meta) modules help page:',
+			'  api.php?action=help&querymodules=siteinfo',
 		);
 	}
 
 	public function getVersion() {
-		return __CLASS__ . ': $Id: ApiHelp.php 60930 2010-01-11 15:55:52Z simetrical $';
+		return __CLASS__ . ': $Id: ApiHelp.php 73863 2010-09-28 02:33:43Z brion $';
 	}
 }