includes/api/ApiHelp.php

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