includes/api/ApiHelp.php

   1 <?php
   2 /**
   3  *
   4  *
   5  * Created on Aug 29, 2014
   6  *
   7  * Copyright © 2014 Wikimedia Foundation and contributors
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License along
  20  * with this program; if not, write to the Free Software Foundation, Inc.,
  21  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  22  * http://www.gnu.org/copyleft/gpl.html
  23  *
  24  * @file
  25  */
  26
  27 use HtmlFormatter\HtmlFormatter;
  28 use MediaWiki\MediaWikiServices;
  29
  30 /**
  31  * Class to output help for an API module
  32  *
  33  * @since 1.25 completely rewritten
  34  * @ingroup API
  35  */
  36 class ApiHelp extends ApiBase {
  37         public function execute() {
  38                 $params = $this->extractRequestParams();
  39                 $modules = [];
  40
  41                 foreach ( $params['modules'] as $path ) {
  42                         $modules[] = $this->getModuleFromPath( $path );
  43                 }
  44
  45                 // Get the help
  46                 $context = new DerivativeContext( $this->getMain()->getContext() );
  47                 $context->setSkin( SkinFactory::getDefaultInstance()->makeSkin( 'apioutput' ) );
  48                 $context->setLanguage( $this->getMain()->getLanguage() );
  49                 $context->setTitle( SpecialPage::getTitleFor( 'ApiHelp' ) );
  50                 $out = new OutputPage( $context );
  51                 $out->setCopyrightUrl( 'https://www.mediawiki.org/wiki/Special:MyLanguage/Copyright' );
  52                 $context->setOutput( $out );
  53
  54                 self::getHelp( $context, $modules, $params );
  55
  56                 // Grab the output from the skin
  57                 ob_start();
  58                 $context->getOutput()->output();
  59                 $html = ob_get_clean();
  60
  61                 $result = $this->getResult();
  62                 if ( $params['wrap'] ) {
  63                         $data = [
  64                                 'mime' => 'text/html',
  65                                 'filename' => 'api-help.html',
  66                                 'help' => $html,
  67                         ];
  68                         ApiResult::setSubelementsList( $data, 'help' );
  69                         $result->addValue( null, $this->getModuleName(), $data );
  70                 } else {
  71                         $result->reset();
  72                         $result->addValue( null, 'text', $html, ApiResult::NO_SIZE_CHECK );
  73                         $result->addValue( null, 'mime', 'text/html', ApiResult::NO_SIZE_CHECK );
  74                         $result->addValue( null, 'filename', 'api-help.html', ApiResult::NO_SIZE_CHECK );
  75                 }
  76         }
  77
  78         /**
  79          * Generate help for the specified modules
  80          *
  81          * Help is placed into the OutputPage object returned by
  82          * $context->getOutput().
  83          *
  84          * Recognized options include:
  85          *  - headerlevel: (int) Header tag level
  86          *  - nolead: (bool) Skip the inclusion of api-help-lead
  87          *  - noheader: (bool) Skip the inclusion of the top-level section headers
  88          *  - submodules: (bool) Include help for submodules of the current module
  89          *  - recursivesubmodules: (bool) Include help for submodules recursively
  90          *  - helptitle: (string) Title to link for additional modules' help. Should contain $1.
  91          *  - toc: (bool) Include a table of contents
  92          *
  93          * @param IContextSource $context
  94          * @param ApiBase[]|ApiBase $modules
  95          * @param array $options Formatting options (described above)
  96          */
  97         public static function getHelp( IContextSource $context, $modules, array $options ) {
  98                 global $wgContLang;
  99
 100                 if ( !is_array( $modules ) ) {
 101                         $modules = [ $modules ];
 102                 }
 103
 104                 $out = $context->getOutput();
 105                 $out->addModuleStyles( [
 106                         'mediawiki.hlist',
 107                         'mediawiki.apihelp',
 108                 ] );
 109                 if ( !empty( $options['toc'] ) ) {
 110                         $out->addModules( 'mediawiki.toc' );
 111                 }
 112                 $out->setPageTitle( $context->msg( 'api-help-title' ) );
 113
 114                 $cache = MediaWikiServices::getInstance()->getMainWANObjectCache();
 115                 $cacheKey = null;
 116                 if ( count( $modules ) == 1 && $modules[0] instanceof ApiMain &&
 117                         $options['recursivesubmodules'] && $context->getLanguage() === $wgContLang
 118                 ) {
 119                         $cacheHelpTimeout = $context->getConfig()->get( 'APICacheHelpTimeout' );
 120                         if ( $cacheHelpTimeout > 0 ) {
 121                                 // Get help text from cache if present
 122                                 $cacheKey = $cache->makeKey( 'apihelp', $modules[0]->getModulePath(),
 123                                         (int)!empty( $options['toc'] ),
 124                                         str_replace( ' ', '_', SpecialVersion::getVersion( 'nodb' ) ) );
 125                                 $cached = $cache->get( $cacheKey );
 126                                 if ( $cached ) {
 127                                         $out->addHTML( $cached );
 128                                         return;
 129                                 }
 130                         }
 131                 }
 132                 if ( $out->getHTML() !== '' ) {
 133                         // Don't save to cache, there's someone else's content in the page
 134                         // already
 135                         $cacheKey = null;
 136                 }
 137
 138                 $options['recursivesubmodules'] = !empty( $options['recursivesubmodules'] );
 139                 $options['submodules'] = $options['recursivesubmodules'] || !empty( $options['submodules'] );
 140
 141                 // Prepend lead
 142                 if ( empty( $options['nolead'] ) ) {
 143                         $msg = $context->msg( 'api-help-lead' );
 144                         if ( !$msg->isDisabled() ) {
 145                                 $out->addHTML( $msg->parseAsBlock() );
 146                         }
 147                 }
 148
 149                 $haveModules = [];
 150                 $html = self::getHelpInternal( $context, $modules, $options, $haveModules );
 151                 if ( !empty( $options['toc'] ) && $haveModules ) {
 152                         $out->addHTML( Linker::generateTOC( $haveModules, $context->getLanguage() ) );
 153                 }
 154                 $out->addHTML( $html );
 155
 156                 $helptitle = isset( $options['helptitle'] ) ? $options['helptitle'] : null;
 157                 $html = self::fixHelpLinks( $out->getHTML(), $helptitle, $haveModules );
 158                 $out->clearHTML();
 159                 $out->addHTML( $html );
 160
 161                 if ( $cacheKey !== null ) {
 162                         $cache->set( $cacheKey, $out->getHTML(), $cacheHelpTimeout );
 163                 }
 164         }
 165
 166         /**
 167          * Replace Special:ApiHelp links with links to api.php
 168          *
 169          * @param string $html
 170          * @param string|null $helptitle Title to link to rather than api.php, must contain '$1'
 171          * @param array $localModules Keys are modules to link within the current page, values are ignored
 172          * @return string
 173          */
 174         public static function fixHelpLinks( $html, $helptitle = null, $localModules = [] ) {
 175                 $formatter = new HtmlFormatter( $html );
 176                 $doc = $formatter->getDoc();
 177                 $xpath = new DOMXPath( $doc );
 178                 $nodes = $xpath->query( '//a[@href][not(contains(@class,\'apihelp-linktrail\'))]' );
 179                 foreach ( $nodes as $node ) {
 180                         $href = $node->getAttribute( 'href' );
 181                         do {
 182                                 $old = $href;
 183                                 $href = rawurldecode( $href );
 184                         } while ( $old !== $href );
 185                         if ( preg_match( '!Special:ApiHelp/([^&/|#]+)((?:#.*)?)!', $href, $m ) ) {
 186                                 if ( isset( $localModules[$m[1]] ) ) {
 187                                         $href = $m[2] === '' ? '#' . $m[1] : $m[2];
 188                                 } elseif ( $helptitle !== null ) {
 189                                         $href = Title::newFromText( str_replace( '$1', $m[1], $helptitle ) . $m[2] )
 190                                                 ->getFullURL();
 191                                 } else {
 192                                         $href = wfAppendQuery( wfScript( 'api' ), [
 193                                                 'action' => 'help',
 194                                                 'modules' => $m[1],
 195                                         ] ) . $m[2];
 196                                 }
 197                                 $node->setAttribute( 'href', $href );
 198                                 $node->removeAttribute( 'title' );
 199                         }
 200                 }
 201
 202                 return $formatter->getText();
 203         }
 204
 205         /**
 206          * Wrap a message in HTML with a class.
 207          *
 208          * @param Message $msg
 209          * @param string $class
 210          * @param string $tag
 211          * @return string
 212          */
 213         private static function wrap( Message $msg, $class, $tag = 'span' ) {
 214                 return Html::rawElement( $tag, [ 'class' => $class ],
 215                         $msg->parse()
 216                 );
 217         }
 218
 219         /**
 220          * Recursively-called function to actually construct the help
 221          *
 222          * @param IContextSource $context
 223          * @param ApiBase[] $modules
 224          * @param array $options
 225          * @param array &$haveModules
 226          * @return string
 227          */
 228         private static function getHelpInternal( IContextSource $context, array $modules,
 229                 array $options, &$haveModules
 230         ) {
 231                 $out = '';
 232
 233                 $level = empty( $options['headerlevel'] ) ? 2 : $options['headerlevel'];
 234                 if ( empty( $options['tocnumber'] ) ) {
 235                         $tocnumber = [ 2 => 0 ];
 236                 } else {
 237                         $tocnumber = &$options['tocnumber'];
 238                 }
 239
 240                 foreach ( $modules as $module ) {
 241                         $tocnumber[$level]++;
 242                         $path = $module->getModulePath();
 243                         $module->setContext( $context );
 244                         $help = [
 245                                 'header' => '',
 246                                 'flags' => '',
 247                                 'description' => '',
 248                                 'help-urls' => '',
 249                                 'parameters' => '',
 250                                 'examples' => '',
 251                                 'submodules' => '',
 252                         ];
 253
 254                         if ( empty( $options['noheader'] ) || !empty( $options['toc'] ) ) {
 255                                 $anchor = $path;
 256                                 $i = 1;
 257                                 while ( isset( $haveModules[$anchor] ) ) {
 258                                         $anchor = $path . '|' . ++$i;
 259                                 }
 260
 261                                 if ( $module->isMain() ) {
 262                                         $headerContent = $context->msg( 'api-help-main-header' )->parse();
 263                                         $headerAttr = [
 264                                                 'class' => 'apihelp-header',
 265                                         ];
 266                                 } else {
 267                                         $name = $module->getModuleName();
 268                                         $headerContent = $module->getParent()->getModuleManager()->getModuleGroup( $name ) .
 269                                                 "=$name";
 270                                         if ( $module->getModulePrefix() !== '' ) {
 271                                                 $headerContent .= ' ' .
 272                                                         $context->msg( 'parentheses', $module->getModulePrefix() )->parse();
 273                                         }
 274                                         // Module names are always in English and not localized,
 275                                         // so English language and direction must be set explicitly,
 276                                         // otherwise parentheses will get broken in RTL wikis
 277                                         $headerAttr = [
 278                                                 'class' => 'apihelp-header apihelp-module-name',
 279                                                 'dir' => 'ltr',
 280                                                 'lang' => 'en',
 281                                         ];
 282                                 }
 283
 284                                 $headerAttr['id'] = $anchor;
 285
 286                                 $haveModules[$anchor] = [
 287                                         'toclevel' => count( $tocnumber ),
 288                                         'level' => $level,
 289                                         'anchor' => $anchor,
 290                                         'line' => $headerContent,
 291                                         'number' => implode( '.', $tocnumber ),
 292                                         'index' => false,
 293                                 ];
 294                                 if ( empty( $options['noheader'] ) ) {
 295                                         $help['header'] .= Html::element(
 296                                                 'h' . min( 6, $level ),
 297                                                 $headerAttr,
 298                                                 $headerContent
 299                                         );
 300                                 }
 301                         } else {
 302                                 $haveModules[$path] = true;
 303                         }
 304
 305                         $links = [];
 306                         $any = false;
 307                         for ( $m = $module; $m !== null; $m = $m->getParent() ) {
 308                                 $name = $m->getModuleName();
 309                                 if ( $name === 'main_int' ) {
 310                                         $name = 'main';
 311                                 }
 312
 313                                 if ( count( $modules ) === 1 && $m === $modules[0] &&
 314                                         !( !empty( $options['submodules'] ) && $m->getModuleManager() )
 315                                 ) {
 316                                         $link = Html::element( 'b', [ 'dir' => 'ltr', 'lang' => 'en' ], $name );
 317                                 } else {
 318                                         $link = SpecialPage::getTitleFor( 'ApiHelp', $m->getModulePath() )->getLocalURL();
 319                                         $link = Html::element( 'a',
 320                                                 [ 'href' => $link, 'class' => 'apihelp-linktrail', 'dir' => 'ltr', 'lang' => 'en' ],
 321                                                 $name
 322                                         );
 323                                         $any = true;
 324                                 }
 325                                 array_unshift( $links, $link );
 326                         }
 327                         if ( $any ) {
 328                                 $help['header'] .= self::wrap(
 329                                         $context->msg( 'parentheses' )
 330                                                 ->rawParams( $context->getLanguage()->pipeList( $links ) ),
 331                                         'apihelp-linktrail', 'div'
 332                                 );
 333                         }
 334
 335                         $flags = $module->getHelpFlags();
 336                         $help['flags'] .= Html::openElement( 'div',
 337                                 [ 'class' => 'apihelp-block apihelp-flags' ] );
 338                         $msg = $context->msg( 'api-help-flags' );
 339                         if ( !$msg->isDisabled() ) {
 340                                 $help['flags'] .= self::wrap(
 341                                         $msg->numParams( count( $flags ) ), 'apihelp-block-head', 'div'
 342                                 );
 343                         }
 344                         $help['flags'] .= Html::openElement( 'ul' );
 345                         foreach ( $flags as $flag ) {
 346                                 $help['flags'] .= Html::rawElement( 'li', null,
 347                                         self::wrap( $context->msg( "api-help-flag-$flag" ), "apihelp-flag-$flag" )
 348                                 );
 349                         }
 350                         $sourceInfo = $module->getModuleSourceInfo();
 351                         if ( $sourceInfo ) {
 352                                 if ( isset( $sourceInfo['namemsg'] ) ) {
 353                                         $extname = $context->msg( $sourceInfo['namemsg'] )->text();
 354                                 } else {
 355                                         // Probably English, so wrap it.
 356                                         $extname = Html::element( 'span', [ 'dir' => 'ltr', 'lang' => 'en' ], $sourceInfo['name'] );
 357                                 }
 358                                 $help['flags'] .= Html::rawElement( 'li', null,
 359                                         self::wrap(
 360                                                 $context->msg( 'api-help-source', $extname, $sourceInfo['name'] ),
 361                                                 'apihelp-source'
 362                                         )
 363                                 );
 364
 365                                 $link = SpecialPage::getTitleFor( 'Version', 'License/' . $sourceInfo['name'] );
 366                                 if ( isset( $sourceInfo['license-name'] ) ) {
 367                                         $msg = $context->msg( 'api-help-license', $link,
 368                                                 Html::element( 'span', [ 'dir' => 'ltr', 'lang' => 'en' ], $sourceInfo['license-name'] )
 369                                         );
 370                                 } elseif ( SpecialVersion::getExtLicenseFileName( dirname( $sourceInfo['path'] ) ) ) {
 371                                         $msg = $context->msg( 'api-help-license-noname', $link );
 372                                 } else {
 373                                         $msg = $context->msg( 'api-help-license-unknown' );
 374                                 }
 375                                 $help['flags'] .= Html::rawElement( 'li', null,
 376                                         self::wrap( $msg, 'apihelp-license' )
 377                                 );
 378                         } else {
 379                                 $help['flags'] .= Html::rawElement( 'li', null,
 380                                         self::wrap( $context->msg( 'api-help-source-unknown' ), 'apihelp-source' )
 381                                 );
 382                                 $help['flags'] .= Html::rawElement( 'li', null,
 383                                         self::wrap( $context->msg( 'api-help-license-unknown' ), 'apihelp-license' )
 384                                 );
 385                         }
 386                         $help['flags'] .= Html::closeElement( 'ul' );
 387                         $help['flags'] .= Html::closeElement( 'div' );
 388
 389                         foreach ( $module->getFinalDescription() as $msg ) {
 390                                 $msg->setContext( $context );
 391                                 $help['description'] .= $msg->parseAsBlock();
 392                         }
 393
 394                         $urls = $module->getHelpUrls();
 395                         if ( $urls ) {
 396                                 $help['help-urls'] .= Html::openElement( 'div',
 397                                         [ 'class' => 'apihelp-block apihelp-help-urls' ]
 398                                 );
 399                                 $msg = $context->msg( 'api-help-help-urls' );
 400                                 if ( !$msg->isDisabled() ) {
 401                                         $help['help-urls'] .= self::wrap(
 402                                                 $msg->numParams( count( $urls ) ), 'apihelp-block-head', 'div'
 403                                         );
 404                                 }
 405                                 if ( !is_array( $urls ) ) {
 406                                         $urls = [ $urls ];
 407                                 }
 408                                 $help['help-urls'] .= Html::openElement( 'ul' );
 409                                 foreach ( $urls as $url ) {
 410                                         $help['help-urls'] .= Html::rawElement( 'li', null,
 411                                                 Html::element( 'a', [ 'href' => $url, 'dir' => 'ltr' ], $url )
 412                                         );
 413                                 }
 414                                 $help['help-urls'] .= Html::closeElement( 'ul' );
 415                                 $help['help-urls'] .= Html::closeElement( 'div' );
 416                         }
 417
 418                         $params = $module->getFinalParams( ApiBase::GET_VALUES_FOR_HELP );
 419                         $dynamicParams = $module->dynamicParameterDocumentation();
 420                         $groups = [];
 421                         if ( $params || $dynamicParams !== null ) {
 422                                 $help['parameters'] .= Html::openElement( 'div',
 423                                         [ 'class' => 'apihelp-block apihelp-parameters' ]
 424                                 );
 425                                 $msg = $context->msg( 'api-help-parameters' );
 426                                 if ( !$msg->isDisabled() ) {
 427                                         $help['parameters'] .= self::wrap(
 428                                                 $msg->numParams( count( $params ) ), 'apihelp-block-head', 'div'
 429                                         );
 430                                 }
 431                                 $help['parameters'] .= Html::openElement( 'dl' );
 432
 433                                 $descriptions = $module->getFinalParamDescription();
 434
 435                                 foreach ( $params as $name => $settings ) {
 436                                         if ( !is_array( $settings ) ) {
 437                                                 $settings = [ ApiBase::PARAM_DFLT => $settings ];
 438                                         }
 439
 440                                         $help['parameters'] .= Html::rawElement( 'dt', null,
 441                                                 Html::element( 'span', [ 'dir' => 'ltr', 'lang' => 'en' ], $module->encodeParamName( $name ) )
 442                                         );
 443
 444                                         // Add description
 445                                         $description = [];
 446                                         if ( isset( $descriptions[$name] ) ) {
 447                                                 foreach ( $descriptions[$name] as $msg ) {
 448                                                         $msg->setContext( $context );
 449                                                         $description[] = $msg->parseAsBlock();
 450                                                 }
 451                                         }
 452
 453                                         // Add usage info
 454                                         $info = [];
 455
 456                                         // Required?
 457                                         if ( !empty( $settings[ApiBase::PARAM_REQUIRED] ) ) {
 458                                                 $info[] = $context->msg( 'api-help-param-required' )->parse();
 459                                         }
 460
 461                                         // Custom info?
 462                                         if ( !empty( $settings[ApiBase::PARAM_HELP_MSG_INFO] ) ) {
 463                                                 foreach ( $settings[ApiBase::PARAM_HELP_MSG_INFO] as $i ) {
 464                                                         $tag = array_shift( $i );
 465                                                         $info[] = $context->msg( "apihelp-{$path}-paraminfo-{$tag}" )
 466                                                                 ->numParams( count( $i ) )
 467                                                                 ->params( $context->getLanguage()->commaList( $i ) )
 468                                                                 ->params( $module->getModulePrefix() )
 469                                                                 ->parse();
 470                                                 }
 471                                         }
 472
 473                                         // Type documentation
 474                                         if ( !isset( $settings[ApiBase::PARAM_TYPE] ) ) {
 475                                                 $dflt = isset( $settings[ApiBase::PARAM_DFLT] )
 476                                                         ? $settings[ApiBase::PARAM_DFLT]
 477                                                         : null;
 478                                                 if ( is_bool( $dflt ) ) {
 479                                                         $settings[ApiBase::PARAM_TYPE] = 'boolean';
 480                                                 } elseif ( is_string( $dflt ) || is_null( $dflt ) ) {
 481                                                         $settings[ApiBase::PARAM_TYPE] = 'string';
 482                                                 } elseif ( is_int( $dflt ) ) {
 483                                                         $settings[ApiBase::PARAM_TYPE] = 'integer';
 484                                                 }
 485                                         }
 486                                         if ( isset( $settings[ApiBase::PARAM_TYPE] ) ) {
 487                                                 $type = $settings[ApiBase::PARAM_TYPE];
 488                                                 $multi = !empty( $settings[ApiBase::PARAM_ISMULTI] );
 489                                                 $hintPipeSeparated = true;
 490                                                 $count = !empty( $settings[ApiBase::PARAM_ISMULTI_LIMIT2] )
 491                                                         ? $settings[ApiBase::PARAM_ISMULTI_LIMIT2] + 1
 492                                                         : ApiBase::LIMIT_SML2 + 1;
 493
 494                                                 if ( is_array( $type ) ) {
 495                                                         $count = count( $type );
 496                                                         $deprecatedValues = isset( $settings[ApiBase::PARAM_DEPRECATED_VALUES] )
 497                                                                 ? $settings[ApiBase::PARAM_DEPRECATED_VALUES]
 498                                                                 : [];
 499                                                         $links = isset( $settings[ApiBase::PARAM_VALUE_LINKS] )
 500                                                                 ? $settings[ApiBase::PARAM_VALUE_LINKS]
 501                                                                 : [];
 502                                                         $values = array_map( function ( $v ) use ( $links, $deprecatedValues ) {
 503                                                                 $attr = [];
 504                                                                 if ( $v !== '' ) {
 505                                                                         // We can't know whether this contains LTR or RTL text.
 506                                                                         $attr['dir'] = 'auto';
 507                                                                 }
 508                                                                 if ( isset( $deprecatedValues[$v] ) ) {
 509                                                                         $attr['class'] = 'apihelp-deprecated-value';
 510                                                                 }
 511                                                                 $ret = $attr ? Html::element( 'span', $attr, $v ) : $v;
 512                                                                 if ( isset( $links[$v] ) ) {
 513                                                                         $ret = "[[{$links[$v]}|$ret]]";
 514                                                                 }
 515                                                                 return $ret;
 516                                                         }, $type );
 517                                                         $i = array_search( '', $type, true );
 518                                                         if ( $i === false ) {
 519                                                                 $values = $context->getLanguage()->commaList( $values );
 520                                                         } else {
 521                                                                 unset( $values[$i] );
 522                                                                 $values = $context->msg( 'api-help-param-list-can-be-empty' )
 523                                                                         ->numParams( count( $values ) )
 524                                                                         ->params( $context->getLanguage()->commaList( $values ) )
 525                                                                         ->parse();
 526                                                         }
 527                                                         $info[] = $context->msg( 'api-help-param-list' )
 528                                                                 ->params( $multi ? 2 : 1 )
 529                                                                 ->params( $values )
 530                                                                 ->parse();
 531                                                         $hintPipeSeparated = false;
 532                                                 } else {
 533                                                         switch ( $type ) {
 534                                                                 case 'submodule':
 535                                                                         $groups[] = $name;
 536
 537                                                                         if ( isset( $settings[ApiBase::PARAM_SUBMODULE_MAP] ) ) {
 538                                                                                 $map = $settings[ApiBase::PARAM_SUBMODULE_MAP];
 539                                                                                 $defaultAttrs = [];
 540                                                                         } else {
 541                                                                                 $prefix = $module->isMain() ? '' : ( $module->getModulePath() . '+' );
 542                                                                                 $map = [];
 543                                                                                 foreach ( $module->getModuleManager()->getNames( $name ) as $submoduleName ) {
 544                                                                                         $map[$submoduleName] = $prefix . $submoduleName;
 545                                                                                 }
 546                                                                                 $defaultAttrs = [ 'dir' => 'ltr', 'lang' => 'en' ];
 547                                                                         }
 548                                                                         ksort( $map );
 549
 550                                                                         $submodules = [];
 551                                                                         $deprecatedSubmodules = [];
 552                                                                         foreach ( $map as $v => $m ) {
 553                                                                                 $attrs = $defaultAttrs;
 554                                                                                 $arr = &$submodules;
 555                                                                                 try {
 556                                                                                         $submod = $module->getModuleFromPath( $m );
 557                                                                                         if ( $submod ) {
 558                                                                                                 if ( $submod->isDeprecated() ) {
 559                                                                                                         $arr = &$deprecatedSubmodules;
 560                                                                                                         $attrs['class'] = 'apihelp-deprecated-value';
 561                                                                                                 }
 562                                                                                         }
 563                                                                                 } catch ( ApiUsageException $ex ) {
 564                                                                                         // Ignore
 565                                                                                 }
 566                                                                                 if ( $attrs ) {
 567                                                                                         $v = Html::element( 'span', $attrs, $v );
 568                                                                                 }
 569                                                                                 $arr[] = "[[Special:ApiHelp/{$m}|{$v}]]";
 570                                                                         }
 571                                                                         $submodules = array_merge( $submodules, $deprecatedSubmodules );
 572                                                                         $count = count( $submodules );
 573                                                                         $info[] = $context->msg( 'api-help-param-list' )
 574                                                                                 ->params( $multi ? 2 : 1 )
 575                                                                                 ->params( $context->getLanguage()->commaList( $submodules ) )
 576                                                                                 ->parse();
 577                                                                         $hintPipeSeparated = false;
 578                                                                         // No type message necessary, we have a list of values.
 579                                                                         $type = null;
 580                                                                         break;
 581
 582                                                                 case 'namespace':
 583                                                                         $namespaces = MWNamespace::getValidNamespaces();
 584                                                                         if ( isset( $settings[ApiBase::PARAM_EXTRA_NAMESPACES] ) &&
 585                                                                                 is_array( $settings[ApiBase::PARAM_EXTRA_NAMESPACES] )
 586                                                                         ) {
 587                                                                                 $namespaces = array_merge( $namespaces, $settings[ApiBase::PARAM_EXTRA_NAMESPACES] );
 588                                                                         }
 589                                                                         sort( $namespaces );
 590                                                                         $count = count( $namespaces );
 591                                                                         $info[] = $context->msg( 'api-help-param-list' )
 592                                                                                 ->params( $multi ? 2 : 1 )
 593                                                                                 ->params( $context->getLanguage()->commaList( $namespaces ) )
 594                                                                                 ->parse();
 595                                                                         $hintPipeSeparated = false;
 596                                                                         // No type message necessary, we have a list of values.
 597                                                                         $type = null;
 598                                                                         break;
 599
 600                                                                 case 'tags':
 601                                                                         $tags = ChangeTags::listExplicitlyDefinedTags();
 602                                                                         $count = count( $tags );
 603                                                                         $info[] = $context->msg( 'api-help-param-list' )
 604                                                                                 ->params( $multi ? 2 : 1 )
 605                                                                                 ->params( $context->getLanguage()->commaList( $tags ) )
 606                                                                                 ->parse();
 607                                                                         $hintPipeSeparated = false;
 608                                                                         $type = null;
 609                                                                         break;
 610
 611                                                                 case 'limit':
 612                                                                         if ( isset( $settings[ApiBase::PARAM_MAX2] ) ) {
 613                                                                                 $info[] = $context->msg( 'api-help-param-limit2' )
 614                                                                                         ->numParams( $settings[ApiBase::PARAM_MAX] )
 615                                                                                         ->numParams( $settings[ApiBase::PARAM_MAX2] )
 616                                                                                         ->parse();
 617                                                                         } else {
 618                                                                                 $info[] = $context->msg( 'api-help-param-limit' )
 619                                                                                         ->numParams( $settings[ApiBase::PARAM_MAX] )
 620                                                                                         ->parse();
 621                                                                         }
 622                                                                         break;
 623
 624                                                                 case 'integer':
 625                                                                         // Possible messages:
 626                                                                         // api-help-param-integer-min,
 627                                                                         // api-help-param-integer-max,
 628                                                                         // api-help-param-integer-minmax
 629                                                                         $suffix = '';
 630                                                                         $min = $max = 0;
 631                                                                         if ( isset( $settings[ApiBase::PARAM_MIN] ) ) {
 632                                                                                 $suffix .= 'min';
 633                                                                                 $min = $settings[ApiBase::PARAM_MIN];
 634                                                                         }
 635                                                                         if ( isset( $settings[ApiBase::PARAM_MAX] ) ) {
 636                                                                                 $suffix .= 'max';
 637                                                                                 $max = $settings[ApiBase::PARAM_MAX];
 638                                                                         }
 639                                                                         if ( $suffix !== '' ) {
 640                                                                                 $info[] =
 641                                                                                         $context->msg( "api-help-param-integer-$suffix" )
 642                                                                                                 ->params( $multi ? 2 : 1 )
 643                                                                                                 ->numParams( $min, $max )
 644                                                                                                 ->parse();
 645                                                                         }
 646                                                                         break;
 647
 648                                                                 case 'upload':
 649                                                                         $info[] = $context->msg( 'api-help-param-upload' )
 650                                                                                 ->parse();
 651                                                                         // No type message necessary, api-help-param-upload should handle it.
 652                                                                         $type = null;
 653                                                                         break;
 654
 655                                                                 case 'string':
 656                                                                 case 'text':
 657                                                                         // Displaying a type message here would be useless.
 658                                                                         $type = null;
 659                                                                         break;
 660                                                         }
 661                                                 }
 662
 663                                                 // Add type. Messages for grep: api-help-param-type-limit
 664                                                 // api-help-param-type-integer api-help-param-type-boolean
 665                                                 // api-help-param-type-timestamp api-help-param-type-user
 666                                                 // api-help-param-type-password
 667                                                 if ( is_string( $type ) ) {
 668                                                         $msg = $context->msg( "api-help-param-type-$type" );
 669                                                         if ( !$msg->isDisabled() ) {
 670                                                                 $info[] = $msg->params( $multi ? 2 : 1 )->parse();
 671                                                         }
 672                                                 }
 673
 674                                                 if ( $multi ) {
 675                                                         $extra = [];
 676                                                         $lowcount = !empty( $settings[ApiBase::PARAM_ISMULTI_LIMIT1] )
 677                                                                 ? $settings[ApiBase::PARAM_ISMULTI_LIMIT1]
 678                                                                 : ApiBase::LIMIT_SML1;
 679                                                         $highcount = !empty( $settings[ApiBase::PARAM_ISMULTI_LIMIT2] )
 680                                                                 ? $settings[ApiBase::PARAM_ISMULTI_LIMIT2]
 681                                                                 : ApiBase::LIMIT_SML2;
 682
 683                                                         if ( $hintPipeSeparated ) {
 684                                                                 $extra[] = $context->msg( 'api-help-param-multi-separate' )->parse();
 685                                                         }
 686                                                         if ( $count > $lowcount ) {
 687                                                                 if ( $lowcount === $highcount ) {
 688                                                                         $msg = $context->msg( 'api-help-param-multi-max-simple' )
 689                                                                                 ->numParams( $lowcount );
 690                                                                 } else {
 691                                                                         $msg = $context->msg( 'api-help-param-multi-max' )
 692                                                                                 ->numParams( $lowcount, $highcount );
 693                                                                 }
 694                                                                 $extra[] = $msg->parse();
 695                                                         }
 696                                                         if ( $extra ) {
 697                                                                 $info[] = implode( ' ', $extra );
 698                                                         }
 699
 700                                                         $allowAll = isset( $settings[ApiBase::PARAM_ALL] )
 701                                                                 ? $settings[ApiBase::PARAM_ALL]
 702                                                                 : false;
 703                                                         if ( $allowAll || $settings[ApiBase::PARAM_TYPE] === 'namespace' ) {
 704                                                                 if ( $settings[ApiBase::PARAM_TYPE] === 'namespace' ) {
 705                                                                         $allSpecifier = ApiBase::ALL_DEFAULT_STRING;
 706                                                                 } else {
 707                                                                         $allSpecifier = ( is_string( $allowAll ) ? $allowAll : ApiBase::ALL_DEFAULT_STRING );
 708                                                                 }
 709                                                                 $info[] = $context->msg( 'api-help-param-multi-all' )
 710                                                                         ->params( $allSpecifier )
 711                                                                         ->parse();
 712                                                         }
 713                                                 }
 714                                         }
 715
 716                                         // Add default
 717                                         $default = isset( $settings[ApiBase::PARAM_DFLT] )
 718                                                 ? $settings[ApiBase::PARAM_DFLT]
 719                                                 : null;
 720                                         if ( $default === '' ) {
 721                                                 $info[] = $context->msg( 'api-help-param-default-empty' )
 722                                                         ->parse();
 723                                         } elseif ( $default !== null && $default !== false ) {
 724                                                 // We can't know whether this contains LTR or RTL text.
 725                                                 $info[] = $context->msg( 'api-help-param-default' )
 726                                                         ->params( Html::element( 'span', [ 'dir' => 'auto' ], $default ) )
 727                                                         ->parse();
 728                                         }
 729
 730                                         if ( !array_filter( $description ) ) {
 731                                                 $description = [ self::wrap(
 732                                                         $context->msg( 'api-help-param-no-description' ),
 733                                                         'apihelp-empty'
 734                                                 ) ];
 735                                         }
 736
 737                                         // Add "deprecated" flag
 738                                         if ( !empty( $settings[ApiBase::PARAM_DEPRECATED] ) ) {
 739                                                 $help['parameters'] .= Html::openElement( 'dd',
 740                                                         [ 'class' => 'info' ] );
 741                                                 $help['parameters'] .= self::wrap(
 742                                                         $context->msg( 'api-help-param-deprecated' ),
 743                                                         'apihelp-deprecated', 'strong'
 744                                                 );
 745                                                 $help['parameters'] .= Html::closeElement( 'dd' );
 746                                         }
 747
 748                                         if ( $description ) {
 749                                                 $description = implode( '', $description );
 750                                                 $description = preg_replace( '!\s*</([oud]l)>\s*<\1>\s*!', "\n", $description );
 751                                                 $help['parameters'] .= Html::rawElement( 'dd',
 752                                                         [ 'class' => 'description' ], $description );
 753                                         }
 754
 755                                         foreach ( $info as $i ) {
 756                                                 $help['parameters'] .= Html::rawElement( 'dd', [ 'class' => 'info' ], $i );
 757                                         }
 758                                 }
 759
 760                                 if ( $dynamicParams !== null ) {
 761                                         $dynamicParams = ApiBase::makeMessage( $dynamicParams, $context, [
 762                                                 $module->getModulePrefix(),
 763                                                 $module->getModuleName(),
 764                                                 $module->getModulePath()
 765                                         ] );
 766                                         $help['parameters'] .= Html::element( 'dt', null, '*' );
 767                                         $help['parameters'] .= Html::rawElement( 'dd',
 768                                                 [ 'class' => 'description' ], $dynamicParams->parse() );
 769                                 }
 770
 771                                 $help['parameters'] .= Html::closeElement( 'dl' );
 772                                 $help['parameters'] .= Html::closeElement( 'div' );
 773                         }
 774
 775                         $examples = $module->getExamplesMessages();
 776                         if ( $examples ) {
 777                                 $help['examples'] .= Html::openElement( 'div',
 778                                         [ 'class' => 'apihelp-block apihelp-examples' ] );
 779                                 $msg = $context->msg( 'api-help-examples' );
 780                                 if ( !$msg->isDisabled() ) {
 781                                         $help['examples'] .= self::wrap(
 782                                                 $msg->numParams( count( $examples ) ), 'apihelp-block-head', 'div'
 783                                         );
 784                                 }
 785
 786                                 $help['examples'] .= Html::openElement( 'dl' );
 787                                 foreach ( $examples as $qs => $msg ) {
 788                                         $msg = ApiBase::makeMessage( $msg, $context, [
 789                                                 $module->getModulePrefix(),
 790                                                 $module->getModuleName(),
 791                                                 $module->getModulePath()
 792                                         ] );
 793
 794                                         $link = wfAppendQuery( wfScript( 'api' ), $qs );
 795                                         $sandbox = SpecialPage::getTitleFor( 'ApiSandbox' )->getLocalURL() . '#' . $qs;
 796                                         $help['examples'] .= Html::rawElement( 'dt', null, $msg->parse() );
 797                                         $help['examples'] .= Html::rawElement( 'dd', null,
 798                                                 Html::element( 'a', [ 'href' => $link, 'dir' => 'ltr' ], "api.php?$qs" ) . ' ' .
 799                                                 Html::rawElement( 'a', [ 'href' => $sandbox ],
 800                                                         $context->msg( 'api-help-open-in-apisandbox' )->parse() )
 801                                         );
 802                                 }
 803                                 $help['examples'] .= Html::closeElement( 'dl' );
 804                                 $help['examples'] .= Html::closeElement( 'div' );
 805                         }
 806
 807                         $subtocnumber = $tocnumber;
 808                         $subtocnumber[$level + 1] = 0;
 809                         $suboptions = [
 810                                 'submodules' => $options['recursivesubmodules'],
 811                                 'headerlevel' => $level + 1,
 812                                 'tocnumber' => &$subtocnumber,
 813                                 'noheader' => false,
 814                         ] + $options;
 815
 816                         if ( $options['submodules'] && $module->getModuleManager() ) {
 817                                 $manager = $module->getModuleManager();
 818                                 $submodules = [];
 819                                 foreach ( $groups as $group ) {
 820                                         $names = $manager->getNames( $group );
 821                                         sort( $names );
 822                                         foreach ( $names as $name ) {
 823                                                 $submodules[] = $manager->getModule( $name );
 824                                         }
 825                                 }
 826                                 $help['submodules'] .= self::getHelpInternal(
 827                                         $context,
 828                                         $submodules,
 829                                         $suboptions,
 830                                         $haveModules
 831                                 );
 832                         }
 833
 834                         $module->modifyHelp( $help, $suboptions, $haveModules );
 835
 836                         Hooks::run( 'APIHelpModifyOutput', [ $module, &$help, $suboptions, &$haveModules ] );
 837
 838                         $out .= implode( "\n", $help );
 839                 }
 840
 841                 return $out;
 842         }
 843
 844         public function shouldCheckMaxlag() {
 845                 return false;
 846         }
 847
 848         public function isReadMode() {
 849                 return false;
 850         }
 851
 852         public function getCustomPrinter() {
 853                 $params = $this->extractRequestParams();
 854                 if ( $params['wrap'] ) {
 855                         return null;
 856                 }
 857
 858                 $main = $this->getMain();
 859                 $errorPrinter = $main->createPrinterByName( $main->getParameter( 'format' ) );
 860                 return new ApiFormatRaw( $main, $errorPrinter );
 861         }
 862
 863         public function getAllowedParams() {
 864                 return [
 865                         'modules' => [
 866                                 ApiBase::PARAM_DFLT => 'main',
 867                                 ApiBase::PARAM_ISMULTI => true,
 868                         ],
 869                         'submodules' => false,
 870                         'recursivesubmodules' => false,
 871                         'wrap' => false,
 872                         'toc' => false,
 873                 ];
 874         }
 875
 876         protected function getExamplesMessages() {
 877                 return [
 878                         'action=help'
 879                                 => 'apihelp-help-example-main',
 880                         'action=help&modules=query&submodules=1'
 881                                 => 'apihelp-help-example-submodules',
 882                         'action=help&recursivesubmodules=1'
 883                                 => 'apihelp-help-example-recursive',
 884                         'action=help&modules=help'
 885                                 => 'apihelp-help-example-help',
 886                         'action=help&modules=query+info|query+categorymembers'
 887                                 => 'apihelp-help-example-query',
 888                 ];
 889         }
 890
 891         public function getHelpUrls() {
 892                 return [
 893                         'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page',
 894                         'https://www.mediawiki.org/wiki/Special:MyLanguage/API:FAQ',
 895                         'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Quick_start_guide',
 896                 ];
 897         }
 898 }