includes/api/ApiPageSet.php

   1 <?php
   2 /**
   3  * Copyright © 2006, 2013 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  */
  22 use MediaWiki\MediaWikiServices;
  23 use Wikimedia\Rdbms\ResultWrapper;
  24 use Wikimedia\Rdbms\IDatabase;
  25
  26 /**
  27  * This class contains a list of pages that the client has requested.
  28  * Initially, when the client passes in titles=, pageids=, or revisions=
  29  * parameter, an instance of the ApiPageSet class will normalize titles,
  30  * determine if the pages/revisions exist, and prefetch any additional page
  31  * data requested.
  32  *
  33  * When a generator is used, the result of the generator will become the input
  34  * for the second instance of this class, and all subsequent actions will use
  35  * the second instance for all their work.
  36  *
  37  * @ingroup API
  38  * @since 1.21 derives from ApiBase instead of ApiQueryBase
  39  */
  40 class ApiPageSet extends ApiBase {
  41         /**
  42          * Constructor flag: The new instance of ApiPageSet will ignore the 'generator=' parameter
  43          * @since 1.21
  44          */
  45         const DISABLE_GENERATORS = 1;
  46
  47         private $mDbSource;
  48         private $mParams;
  49         private $mResolveRedirects;
  50         private $mConvertTitles;
  51         private $mAllowGenerator;
  52
  53         private $mAllPages = []; // [ns][dbkey] => page_id or negative when missing
  54         private $mTitles = [];
  55         private $mGoodAndMissingPages = []; // [ns][dbkey] => page_id or negative when missing
  56         private $mGoodPages = []; // [ns][dbkey] => page_id
  57         private $mGoodTitles = [];
  58         private $mMissingPages = []; // [ns][dbkey] => fake page_id
  59         private $mMissingTitles = [];
  60         /** @var array [fake_page_id] => [ 'title' => $title, 'invalidreason' => $reason ] */
  61         private $mInvalidTitles = [];
  62         private $mMissingPageIDs = [];
  63         private $mRedirectTitles = [];
  64         private $mSpecialTitles = [];
  65         private $mAllSpecials = []; // separate from mAllPages to avoid breaking getAllTitlesByNamespace()
  66         private $mNormalizedTitles = [];
  67         private $mInterwikiTitles = [];
  68         /** @var Title[] */
  69         private $mPendingRedirectIDs = [];
  70         private $mPendingRedirectSpecialPages = []; // [dbkey] => [ Title $from, Title $to ]
  71         private $mResolvedRedirectTitles = [];
  72         private $mConvertedTitles = [];
  73         private $mGoodRevIDs = [];
  74         private $mLiveRevIDs = [];
  75         private $mDeletedRevIDs = [];
  76         private $mMissingRevIDs = [];
  77         private $mGeneratorData = []; // [ns][dbkey] => data array
  78         private $mFakePageId = -1;
  79         private $mCacheMode = 'public';
  80         private $mRequestedPageFields = [];
  81         /** @var int */
  82         private $mDefaultNamespace = NS_MAIN;
  83         /** @var callable|null */
  84         private $mRedirectMergePolicy;
  85
  86         /**
  87          * Add all items from $values into the result
  88          * @param array $result Output
  89          * @param array $values Values to add
  90          * @param string[] $flags The names of boolean flags to mark this element
  91          * @param string $name If given, name of the value
  92          */
  93         private static function addValues( array &$result, $values, $flags = [], $name = null ) {
  94                 foreach ( $values as $val ) {
  95                         if ( $val instanceof Title ) {
  96                                 $v = [];
  97                                 ApiQueryBase::addTitleInfo( $v, $val );
  98                         } elseif ( $name !== null ) {
  99                                 $v = [ $name => $val ];
 100                         } else {
 101                                 $v = $val;
 102                         }
 103                         foreach ( $flags as $flag ) {
 104                                 $v[$flag] = true;
 105                         }
 106                         $result[] = $v;
 107                 }
 108         }
 109
 110         /**
 111          * @param ApiBase $dbSource Module implementing getDB().
 112          *        Allows PageSet to reuse existing db connection from the shared state like ApiQuery.
 113          * @param int $flags Zero or more flags like DISABLE_GENERATORS
 114          * @param int $defaultNamespace The namespace to use if none is specified by a prefix.
 115          * @since 1.21 accepts $flags instead of two boolean values
 116          */
 117         public function __construct( ApiBase $dbSource, $flags = 0, $defaultNamespace = NS_MAIN ) {
 118                 parent::__construct( $dbSource->getMain(), $dbSource->getModuleName() );
 119                 $this->mDbSource = $dbSource;
 120                 $this->mAllowGenerator = ( $flags & self::DISABLE_GENERATORS ) == 0;
 121                 $this->mDefaultNamespace = $defaultNamespace;
 122
 123                 $this->mParams = $this->extractRequestParams();
 124                 $this->mResolveRedirects = $this->mParams['redirects'];
 125                 $this->mConvertTitles = $this->mParams['converttitles'];
 126         }
 127
 128         /**
 129          * In case execute() is not called, call this method to mark all relevant parameters as used
 130          * This prevents unused parameters from being reported as warnings
 131          */
 132         public function executeDryRun() {
 133                 $this->executeInternal( true );
 134         }
 135
 136         /**
 137          * Populate the PageSet from the request parameters.
 138          */
 139         public function execute() {
 140                 $this->executeInternal( false );
 141         }
 142
 143         /**
 144          * Populate the PageSet from the request parameters.
 145          * @param bool $isDryRun If true, instantiates generator, but only to mark
 146          *    relevant parameters as used
 147          */
 148         private function executeInternal( $isDryRun ) {
 149                 $generatorName = $this->mAllowGenerator ? $this->mParams['generator'] : null;
 150                 if ( isset( $generatorName ) ) {
 151                         $dbSource = $this->mDbSource;
 152                         if ( !$dbSource instanceof ApiQuery ) {
 153                                 // If the parent container of this pageset is not ApiQuery, we must create it to run generator
 154                                 $dbSource = $this->getMain()->getModuleManager()->getModule( 'query' );
 155                         }
 156                         $generator = $dbSource->getModuleManager()->getModule( $generatorName, null, true );
 157                         if ( $generator === null ) {
 158                                 $this->dieWithError( [ 'apierror-badgenerator-unknown', $generatorName ], 'badgenerator' );
 159                         }
 160                         if ( !$generator instanceof ApiQueryGeneratorBase ) {
 161                                 $this->dieWithError( [ 'apierror-badgenerator-notgenerator', $generatorName ], 'badgenerator' );
 162                         }
 163                         // Create a temporary pageset to store generator's output,
 164                         // add any additional fields generator may need, and execute pageset to populate titles/pageids
 165                         $tmpPageSet = new ApiPageSet( $dbSource, self::DISABLE_GENERATORS );
 166                         $generator->setGeneratorMode( $tmpPageSet );
 167                         $this->mCacheMode = $generator->getCacheMode( $generator->extractRequestParams() );
 168
 169                         if ( !$isDryRun ) {
 170                                 $generator->requestExtraData( $tmpPageSet );
 171                         }
 172                         $tmpPageSet->executeInternal( $isDryRun );
 173
 174                         // populate this pageset with the generator output
 175                         if ( !$isDryRun ) {
 176                                 $generator->executeGenerator( $this );
 177
 178                                 // Avoid PHP 7.1 warning of passing $this by reference
 179                                 $apiModule = $this;
 180                                 Hooks::run( 'APIQueryGeneratorAfterExecute', [ &$generator, &$apiModule ] );
 181                         } else {
 182                                 // Prevent warnings from being reported on these parameters
 183                                 $main = $this->getMain();
 184                                 foreach ( $generator->extractRequestParams() as $paramName => $param ) {
 185                                         $main->markParamsUsed( $generator->encodeParamName( $paramName ) );
 186                                 }
 187                         }
 188
 189                         if ( !$isDryRun ) {
 190                                 $this->resolvePendingRedirects();
 191                         }
 192                 } else {
 193                         // Only one of the titles/pageids/revids is allowed at the same time
 194                         $dataSource = null;
 195                         if ( isset( $this->mParams['titles'] ) ) {
 196                                 $dataSource = 'titles';
 197                         }
 198                         if ( isset( $this->mParams['pageids'] ) ) {
 199                                 if ( isset( $dataSource ) ) {
 200                                         $this->dieWithError(
 201                                                 [
 202                                                         'apierror-invalidparammix-cannotusewith',
 203                                                         $this->encodeParamName( 'pageids' ),
 204                                                         $this->encodeParamName( $dataSource )
 205                                                 ],
 206                                                 'multisource'
 207                                         );
 208                                 }
 209                                 $dataSource = 'pageids';
 210                         }
 211                         if ( isset( $this->mParams['revids'] ) ) {
 212                                 if ( isset( $dataSource ) ) {
 213                                         $this->dieWithError(
 214                                                 [
 215                                                         'apierror-invalidparammix-cannotusewith',
 216                                                         $this->encodeParamName( 'revids' ),
 217                                                         $this->encodeParamName( $dataSource )
 218                                                 ],
 219                                                 'multisource'
 220                                         );
 221                                 }
 222                                 $dataSource = 'revids';
 223                         }
 224
 225                         if ( !$isDryRun ) {
 226                                 // Populate page information with the original user input
 227                                 switch ( $dataSource ) {
 228                                         case 'titles':
 229                                                 $this->initFromTitles( $this->mParams['titles'] );
 230                                                 break;
 231                                         case 'pageids':
 232                                                 $this->initFromPageIds( $this->mParams['pageids'] );
 233                                                 break;
 234                                         case 'revids':
 235                                                 if ( $this->mResolveRedirects ) {
 236                                                         $this->addWarning( 'apiwarn-redirectsandrevids' );
 237                                                 }
 238                                                 $this->mResolveRedirects = false;
 239                                                 $this->initFromRevIDs( $this->mParams['revids'] );
 240                                                 break;
 241                                         default:
 242                                                 // Do nothing - some queries do not need any of the data sources.
 243                                                 break;
 244                                 }
 245                         }
 246                 }
 247         }
 248
 249         /**
 250          * Check whether this PageSet is resolving redirects
 251          * @return bool
 252          */
 253         public function isResolvingRedirects() {
 254                 return $this->mResolveRedirects;
 255         }
 256
 257         /**
 258          * Return the parameter name that is the source of data for this PageSet
 259          *
 260          * If multiple source parameters are specified (e.g. titles and pageids),
 261          * one will be named arbitrarily.
 262          *
 263          * @return string|null
 264          */
 265         public function getDataSource() {
 266                 if ( $this->mAllowGenerator && isset( $this->mParams['generator'] ) ) {
 267                         return 'generator';
 268                 }
 269                 if ( isset( $this->mParams['titles'] ) ) {
 270                         return 'titles';
 271                 }
 272                 if ( isset( $this->mParams['pageids'] ) ) {
 273                         return 'pageids';
 274                 }
 275                 if ( isset( $this->mParams['revids'] ) ) {
 276                         return 'revids';
 277                 }
 278
 279                 return null;
 280         }
 281
 282         /**
 283          * Request an additional field from the page table.
 284          * Must be called before execute()
 285          * @param string $fieldName Field name
 286          */
 287         public function requestField( $fieldName ) {
 288                 $this->mRequestedPageFields[$fieldName] = null;
 289         }
 290
 291         /**
 292          * Get the value of a custom field previously requested through
 293          * requestField()
 294          * @param string $fieldName Field name
 295          * @return mixed Field value
 296          */
 297         public function getCustomField( $fieldName ) {
 298                 return $this->mRequestedPageFields[$fieldName];
 299         }
 300
 301         /**
 302          * Get the fields that have to be queried from the page table:
 303          * the ones requested through requestField() and a few basic ones
 304          * we always need
 305          * @return array Array of field names
 306          */
 307         public function getPageTableFields() {
 308                 // Ensure we get minimum required fields
 309                 // DON'T change this order
 310                 $pageFlds = [
 311                         'page_namespace' => null,
 312                         'page_title' => null,
 313                         'page_id' => null,
 314                 ];
 315
 316                 if ( $this->mResolveRedirects ) {
 317                         $pageFlds['page_is_redirect'] = null;
 318                 }
 319
 320                 if ( $this->getConfig()->get( 'ContentHandlerUseDB' ) ) {
 321                         $pageFlds['page_content_model'] = null;
 322                 }
 323
 324                 if ( $this->getConfig()->get( 'PageLanguageUseDB' ) ) {
 325                         $pageFlds['page_lang'] = null;
 326                 }
 327
 328                 foreach ( LinkCache::getSelectFields() as $field ) {
 329                         $pageFlds[$field] = null;
 330                 }
 331
 332                 $pageFlds = array_merge( $pageFlds, $this->mRequestedPageFields );
 333
 334                 return array_keys( $pageFlds );
 335         }
 336
 337         /**
 338          * Returns an array [ns][dbkey] => page_id for all requested titles.
 339          * page_id is a unique negative number in case title was not found.
 340          * Invalid titles will also have negative page IDs and will be in namespace 0
 341          * @return array
 342          */
 343         public function getAllTitlesByNamespace() {
 344                 return $this->mAllPages;
 345         }
 346
 347         /**
 348          * All Title objects provided.
 349          * @return Title[]
 350          */
 351         public function getTitles() {
 352                 return $this->mTitles;
 353         }
 354
 355         /**
 356          * Returns the number of unique pages (not revisions) in the set.
 357          * @return int
 358          */
 359         public function getTitleCount() {
 360                 return count( $this->mTitles );
 361         }
 362
 363         /**
 364          * Returns an array [ns][dbkey] => page_id for all good titles.
 365          * @return array
 366          */
 367         public function getGoodTitlesByNamespace() {
 368                 return $this->mGoodPages;
 369         }
 370
 371         /**
 372          * Title objects that were found in the database.
 373          * @return Title[] Array page_id (int) => Title (obj)
 374          */
 375         public function getGoodTitles() {
 376                 return $this->mGoodTitles;
 377         }
 378
 379         /**
 380          * Returns the number of found unique pages (not revisions) in the set.
 381          * @return int
 382          */
 383         public function getGoodTitleCount() {
 384                 return count( $this->mGoodTitles );
 385         }
 386
 387         /**
 388          * Returns an array [ns][dbkey] => fake_page_id for all missing titles.
 389          * fake_page_id is a unique negative number.
 390          * @return array
 391          */
 392         public function getMissingTitlesByNamespace() {
 393                 return $this->mMissingPages;
 394         }
 395
 396         /**
 397          * Title objects that were NOT found in the database.
 398          * The array's index will be negative for each item
 399          * @return Title[]
 400          */
 401         public function getMissingTitles() {
 402                 return $this->mMissingTitles;
 403         }
 404
 405         /**
 406          * Returns an array [ns][dbkey] => page_id for all good and missing titles.
 407          * @return array
 408          */
 409         public function getGoodAndMissingTitlesByNamespace() {
 410                 return $this->mGoodAndMissingPages;
 411         }
 412
 413         /**
 414          * Title objects for good and missing titles.
 415          * @return array
 416          */
 417         public function getGoodAndMissingTitles() {
 418                 return $this->mGoodTitles + $this->mMissingTitles;
 419         }
 420
 421         /**
 422          * Titles that were deemed invalid by Title::newFromText()
 423          * The array's index will be unique and negative for each item
 424          * @return array[] Array of arrays with 'title' and 'invalidreason' properties
 425          */
 426         public function getInvalidTitlesAndReasons() {
 427                 return $this->mInvalidTitles;
 428         }
 429
 430         /**
 431          * Page IDs that were not found in the database
 432          * @return array Array of page IDs
 433          */
 434         public function getMissingPageIDs() {
 435                 return $this->mMissingPageIDs;
 436         }
 437
 438         /**
 439          * Get a list of redirect resolutions - maps a title to its redirect
 440          * target, as an array of output-ready arrays
 441          * @return Title[]
 442          */
 443         public function getRedirectTitles() {
 444                 return $this->mRedirectTitles;
 445         }
 446
 447         /**
 448          * Get a list of redirect resolutions - maps a title to its redirect
 449          * target. Includes generator data for redirect source when available.
 450          * @param ApiResult|null $result
 451          * @return array Array of prefixed_title (string) => Title object
 452          * @since 1.21
 453          */
 454         public function getRedirectTitlesAsResult( $result = null ) {
 455                 $values = [];
 456                 foreach ( $this->getRedirectTitles() as $titleStrFrom => $titleTo ) {
 457                         $r = [
 458                                 'from' => strval( $titleStrFrom ),
 459                                 'to' => $titleTo->getPrefixedText(),
 460                         ];
 461                         if ( $titleTo->hasFragment() ) {
 462                                 $r['tofragment'] = $titleTo->getFragment();
 463                         }
 464                         if ( $titleTo->isExternal() ) {
 465                                 $r['tointerwiki'] = $titleTo->getInterwiki();
 466                         }
 467                         if ( isset( $this->mResolvedRedirectTitles[$titleStrFrom] ) ) {
 468                                 $titleFrom = $this->mResolvedRedirectTitles[$titleStrFrom];
 469                                 $ns = $titleFrom->getNamespace();
 470                                 $dbkey = $titleFrom->getDBkey();
 471                                 if ( isset( $this->mGeneratorData[$ns][$dbkey] ) ) {
 472                                         $r = array_merge( $this->mGeneratorData[$ns][$dbkey], $r );
 473                                 }
 474                         }
 475
 476                         $values[] = $r;
 477                 }
 478                 if ( !empty( $values ) && $result ) {
 479                         ApiResult::setIndexedTagName( $values, 'r' );
 480                 }
 481
 482                 return $values;
 483         }
 484
 485         /**
 486          * Get a list of title normalizations - maps a title to its normalized
 487          * version.
 488          * @return array Array of raw_prefixed_title (string) => prefixed_title (string)
 489          */
 490         public function getNormalizedTitles() {
 491                 return $this->mNormalizedTitles;
 492         }
 493
 494         /**
 495          * Get a list of title normalizations - maps a title to its normalized
 496          * version in the form of result array.
 497          * @param ApiResult|null $result
 498          * @return array Array of raw_prefixed_title (string) => prefixed_title (string)
 499          * @since 1.21
 500          */
 501         public function getNormalizedTitlesAsResult( $result = null ) {
 502                 $values = [];
 503                 $contLang = MediaWikiServices::getInstance()->getContentLanguage();
 504                 foreach ( $this->getNormalizedTitles() as $rawTitleStr => $titleStr ) {
 505                         $encode = $contLang->normalize( $rawTitleStr ) !== $rawTitleStr;
 506                         $values[] = [
 507                                 'fromencoded' => $encode,
 508                                 'from' => $encode ? rawurlencode( $rawTitleStr ) : $rawTitleStr,
 509                                 'to' => $titleStr
 510                         ];
 511                 }
 512                 if ( !empty( $values ) && $result ) {
 513                         ApiResult::setIndexedTagName( $values, 'n' );
 514                 }
 515
 516                 return $values;
 517         }
 518
 519         /**
 520          * Get a list of title conversions - maps a title to its converted
 521          * version.
 522          * @return array Array of raw_prefixed_title (string) => prefixed_title (string)
 523          */
 524         public function getConvertedTitles() {
 525                 return $this->mConvertedTitles;
 526         }
 527
 528         /**
 529          * Get a list of title conversions - maps a title to its converted
 530          * version as a result array.
 531          * @param ApiResult|null $result
 532          * @return array Array of (from, to) strings
 533          * @since 1.21
 534          */
 535         public function getConvertedTitlesAsResult( $result = null ) {
 536                 $values = [];
 537                 foreach ( $this->getConvertedTitles() as $rawTitleStr => $titleStr ) {
 538                         $values[] = [
 539                                 'from' => $rawTitleStr,
 540                                 'to' => $titleStr
 541                         ];
 542                 }
 543                 if ( !empty( $values ) && $result ) {
 544                         ApiResult::setIndexedTagName( $values, 'c' );
 545                 }
 546
 547                 return $values;
 548         }
 549
 550         /**
 551          * Get a list of interwiki titles - maps a title to its interwiki
 552          * prefix.
 553          * @return array Array of raw_prefixed_title (string) => interwiki_prefix (string)
 554          */
 555         public function getInterwikiTitles() {
 556                 return $this->mInterwikiTitles;
 557         }
 558
 559         /**
 560          * Get a list of interwiki titles - maps a title to its interwiki
 561          * prefix as result.
 562          * @param ApiResult|null $result
 563          * @param bool $iwUrl
 564          * @return array Array of raw_prefixed_title (string) => interwiki_prefix (string)
 565          * @since 1.21
 566          */
 567         public function getInterwikiTitlesAsResult( $result = null, $iwUrl = false ) {
 568                 $values = [];
 569                 foreach ( $this->getInterwikiTitles() as $rawTitleStr => $interwikiStr ) {
 570                         $item = [
 571                                 'title' => $rawTitleStr,
 572                                 'iw' => $interwikiStr,
 573                         ];
 574                         if ( $iwUrl ) {
 575                                 $title = Title::newFromText( $rawTitleStr );
 576                                 $item['url'] = $title->getFullURL( '', false, PROTO_CURRENT );
 577                         }
 578                         $values[] = $item;
 579                 }
 580                 if ( !empty( $values ) && $result ) {
 581                         ApiResult::setIndexedTagName( $values, 'i' );
 582                 }
 583
 584                 return $values;
 585         }
 586
 587         /**
 588          * Get an array of invalid/special/missing titles.
 589          *
 590          * @param array $invalidChecks List of types of invalid titles to include.
 591          *   Recognized values are:
 592          *   - invalidTitles: Titles and reasons from $this->getInvalidTitlesAndReasons()
 593          *   - special: Titles from $this->getSpecialTitles()
 594          *   - missingIds: ids from $this->getMissingPageIDs()
 595          *   - missingRevIds: ids from $this->getMissingRevisionIDs()
 596          *   - missingTitles: Titles from $this->getMissingTitles()
 597          *   - interwikiTitles: Titles from $this->getInterwikiTitlesAsResult()
 598          * @return array Array suitable for inclusion in the response
 599          * @since 1.23
 600          */
 601         public function getInvalidTitlesAndRevisions( $invalidChecks = [ 'invalidTitles',
 602                 'special', 'missingIds', 'missingRevIds', 'missingTitles', 'interwikiTitles' ]
 603         ) {
 604                 $result = [];
 605                 if ( in_array( 'invalidTitles', $invalidChecks ) ) {
 606                         self::addValues( $result, $this->getInvalidTitlesAndReasons(), [ 'invalid' ] );
 607                 }
 608                 if ( in_array( 'special', $invalidChecks ) ) {
 609                         $known = [];
 610                         $unknown = [];
 611                         foreach ( $this->getSpecialTitles() as $title ) {
 612                                 if ( $title->isKnown() ) {
 613                                         $known[] = $title;
 614                                 } else {
 615                                         $unknown[] = $title;
 616                                 }
 617                         }
 618                         self::addValues( $result, $unknown, [ 'special', 'missing' ] );
 619                         self::addValues( $result, $known, [ 'special' ] );
 620                 }
 621                 if ( in_array( 'missingIds', $invalidChecks ) ) {
 622                         self::addValues( $result, $this->getMissingPageIDs(), [ 'missing' ], 'pageid' );
 623                 }
 624                 if ( in_array( 'missingRevIds', $invalidChecks ) ) {
 625                         self::addValues( $result, $this->getMissingRevisionIDs(), [ 'missing' ], 'revid' );
 626                 }
 627                 if ( in_array( 'missingTitles', $invalidChecks ) ) {
 628                         $known = [];
 629                         $unknown = [];
 630                         foreach ( $this->getMissingTitles() as $title ) {
 631                                 if ( $title->isKnown() ) {
 632                                         $known[] = $title;
 633                                 } else {
 634                                         $unknown[] = $title;
 635                                 }
 636                         }
 637                         self::addValues( $result, $unknown, [ 'missing' ] );
 638                         self::addValues( $result, $known, [ 'missing', 'known' ] );
 639                 }
 640                 if ( in_array( 'interwikiTitles', $invalidChecks ) ) {
 641                         self::addValues( $result, $this->getInterwikiTitlesAsResult() );
 642                 }
 643
 644                 return $result;
 645         }
 646
 647         /**
 648          * Get the list of valid revision IDs (requested with the revids= parameter)
 649          * @return array Array of revID (int) => pageID (int)
 650          */
 651         public function getRevisionIDs() {
 652                 return $this->mGoodRevIDs;
 653         }
 654
 655         /**
 656          * Get the list of non-deleted revision IDs (requested with the revids= parameter)
 657          * @return array Array of revID (int) => pageID (int)
 658          */
 659         public function getLiveRevisionIDs() {
 660                 return $this->mLiveRevIDs;
 661         }
 662
 663         /**
 664          * Get the list of revision IDs that were associated with deleted titles.
 665          * @return array Array of revID (int) => pageID (int)
 666          */
 667         public function getDeletedRevisionIDs() {
 668                 return $this->mDeletedRevIDs;
 669         }
 670
 671         /**
 672          * Revision IDs that were not found in the database
 673          * @return array Array of revision IDs
 674          */
 675         public function getMissingRevisionIDs() {
 676                 return $this->mMissingRevIDs;
 677         }
 678
 679         /**
 680          * Revision IDs that were not found in the database as result array.
 681          * @param ApiResult|null $result
 682          * @return array Array of revision IDs
 683          * @since 1.21
 684          */
 685         public function getMissingRevisionIDsAsResult( $result = null ) {
 686                 $values = [];
 687                 foreach ( $this->getMissingRevisionIDs() as $revid ) {
 688                         $values[$revid] = [
 689                                 'revid' => $revid
 690                         ];
 691                 }
 692                 if ( !empty( $values ) && $result ) {
 693                         ApiResult::setIndexedTagName( $values, 'rev' );
 694                 }
 695
 696                 return $values;
 697         }
 698
 699         /**
 700          * Get the list of titles with negative namespace
 701          * @return Title[]
 702          */
 703         public function getSpecialTitles() {
 704                 return $this->mSpecialTitles;
 705         }
 706
 707         /**
 708          * Returns the number of revisions (requested with revids= parameter).
 709          * @return int Number of revisions.
 710          */
 711         public function getRevisionCount() {
 712                 return count( $this->getRevisionIDs() );
 713         }
 714
 715         /**
 716          * Populate this PageSet from a list of Titles
 717          * @param array $titles Array of Title objects
 718          */
 719         public function populateFromTitles( $titles ) {
 720                 $this->initFromTitles( $titles );
 721         }
 722
 723         /**
 724          * Populate this PageSet from a list of page IDs
 725          * @param array $pageIDs Array of page IDs
 726          */
 727         public function populateFromPageIDs( $pageIDs ) {
 728                 $this->initFromPageIds( $pageIDs );
 729         }
 730
 731         /**
 732          * Populate this PageSet from a rowset returned from the database
 733          *
 734          * Note that the query result must include the columns returned by
 735          * $this->getPageTableFields().
 736          *
 737          * @param IDatabase $db
 738          * @param ResultWrapper $queryResult
 739          */
 740         public function populateFromQueryResult( $db, $queryResult ) {
 741                 $this->initFromQueryResult( $queryResult );
 742         }
 743
 744         /**
 745          * Populate this PageSet from a list of revision IDs
 746          * @param array $revIDs Array of revision IDs
 747          */
 748         public function populateFromRevisionIDs( $revIDs ) {
 749                 $this->initFromRevIDs( $revIDs );
 750         }
 751
 752         /**
 753          * Extract all requested fields from the row received from the database
 754          * @param stdClass $row Result row
 755          */
 756         public function processDbRow( $row ) {
 757                 // Store Title object in various data structures
 758                 $title = Title::newFromRow( $row );
 759
 760                 $linkCache = MediaWikiServices::getInstance()->getLinkCache();
 761                 $linkCache->addGoodLinkObjFromRow( $title, $row );
 762
 763                 $pageId = (int)$row->page_id;
 764                 $this->mAllPages[$row->page_namespace][$row->page_title] = $pageId;
 765                 $this->mTitles[] = $title;
 766
 767                 if ( $this->mResolveRedirects && $row->page_is_redirect == '1' ) {
 768                         $this->mPendingRedirectIDs[$pageId] = $title;
 769                 } else {
 770                         $this->mGoodPages[$row->page_namespace][$row->page_title] = $pageId;
 771                         $this->mGoodAndMissingPages[$row->page_namespace][$row->page_title] = $pageId;
 772                         $this->mGoodTitles[$pageId] = $title;
 773                 }
 774
 775                 foreach ( $this->mRequestedPageFields as $fieldName => &$fieldValues ) {
 776                         $fieldValues[$pageId] = $row->$fieldName;
 777                 }
 778         }
 779
 780         /**
 781          * This method populates internal variables with page information
 782          * based on the given array of title strings.
 783          *
 784          * Steps:
 785          * #1 For each title, get data from `page` table
 786          * #2 If page was not found in the DB, store it as missing
 787          *
 788          * Additionally, when resolving redirects:
 789          * #3 If no more redirects left, stop.
 790          * #4 For each redirect, get its target from the `redirect` table.
 791          * #5 Substitute the original LinkBatch object with the new list
 792          * #6 Repeat from step #1
 793          *
 794          * @param array $titles Array of Title objects or strings
 795          */
 796         private function initFromTitles( $titles ) {
 797                 // Get validated and normalized title objects
 798                 $linkBatch = $this->processTitlesArray( $titles );
 799                 if ( $linkBatch->isEmpty() ) {
 800                         // There might be special-page redirects
 801                         $this->resolvePendingRedirects();
 802                         return;
 803                 }
 804
 805                 $db = $this->getDB();
 806                 $set = $linkBatch->constructSet( 'page', $db );
 807
 808                 // Get pageIDs data from the `page` table
 809                 $res = $db->select( 'page', $this->getPageTableFields(), $set,
 810                         __METHOD__ );
 811
 812                 // Hack: get the ns:titles stored in [ ns => [ titles ] ] format
 813                 $this->initFromQueryResult( $res, $linkBatch->data, true ); // process Titles
 814
 815                 // Resolve any found redirects
 816                 $this->resolvePendingRedirects();
 817         }
 818
 819         /**
 820          * Does the same as initFromTitles(), but is based on page IDs instead
 821          * @param array $pageids Array of page IDs
 822          * @param bool $filterIds Whether the IDs need filtering
 823          */
 824         private function initFromPageIds( $pageids, $filterIds = true ) {
 825                 if ( !$pageids ) {
 826                         return;
 827                 }
 828
 829                 $pageids = array_map( 'intval', $pageids ); // paranoia
 830                 $remaining = array_flip( $pageids );
 831
 832                 if ( $filterIds ) {
 833                         $pageids = $this->filterIDs( [ [ 'page', 'page_id' ] ], $pageids );
 834                 }
 835
 836                 $res = null;
 837                 if ( !empty( $pageids ) ) {
 838                         $set = [
 839                                 'page_id' => $pageids
 840                         ];
 841                         $db = $this->getDB();
 842
 843                         // Get pageIDs data from the `page` table
 844                         $res = $db->select( 'page', $this->getPageTableFields(), $set,
 845                                 __METHOD__ );
 846                 }
 847
 848                 $this->initFromQueryResult( $res, $remaining, false ); // process PageIDs
 849
 850                 // Resolve any found redirects
 851                 $this->resolvePendingRedirects();
 852         }
 853
 854         /**
 855          * Iterate through the result of the query on 'page' table,
 856          * and for each row create and store title object and save any extra fields requested.
 857          * @param ResultWrapper $res DB Query result
 858          * @param array $remaining Array of either pageID or ns/title elements (optional).
 859          *        If given, any missing items will go to $mMissingPageIDs and $mMissingTitles
 860          * @param bool $processTitles Must be provided together with $remaining.
 861          *        If true, treat $remaining as an array of [ns][title]
 862          *        If false, treat it as an array of [pageIDs]
 863          */
 864         private function initFromQueryResult( $res, &$remaining = null, $processTitles = null ) {
 865                 if ( !is_null( $remaining ) && is_null( $processTitles ) ) {
 866                         ApiBase::dieDebug( __METHOD__, 'Missing $processTitles parameter when $remaining is provided' );
 867                 }
 868
 869                 $nsInfo = MediaWikiServices::getInstance()->getNamespaceInfo();
 870
 871                 $usernames = [];
 872                 if ( $res ) {
 873                         foreach ( $res as $row ) {
 874                                 $pageId = (int)$row->page_id;
 875
 876                                 // Remove found page from the list of remaining items
 877                                 if ( isset( $remaining ) ) {
 878                                         if ( $processTitles ) {
 879                                                 unset( $remaining[$row->page_namespace][$row->page_title] );
 880                                         } else {
 881                                                 unset( $remaining[$pageId] );
 882                                         }
 883                                 }
 884
 885                                 // Store any extra fields requested by modules
 886                                 $this->processDbRow( $row );
 887
 888                                 // Need gender information
 889                                 if ( $nsInfo->hasGenderDistinction( $row->page_namespace ) ) {
 890                                         $usernames[] = $row->page_title;
 891                                 }
 892                         }
 893                 }
 894
 895                 if ( isset( $remaining ) ) {
 896                         // Any items left in the $remaining list are added as missing
 897                         if ( $processTitles ) {
 898                                 // The remaining titles in $remaining are non-existent pages
 899                                 $linkCache = MediaWikiServices::getInstance()->getLinkCache();
 900                                 foreach ( $remaining as $ns => $dbkeys ) {
 901                                         foreach ( array_keys( $dbkeys ) as $dbkey ) {
 902                                                 $title = Title::makeTitle( $ns, $dbkey );
 903                                                 $linkCache->addBadLinkObj( $title );
 904                                                 $this->mAllPages[$ns][$dbkey] = $this->mFakePageId;
 905                                                 $this->mMissingPages[$ns][$dbkey] = $this->mFakePageId;
 906                                                 $this->mGoodAndMissingPages[$ns][$dbkey] = $this->mFakePageId;
 907                                                 $this->mMissingTitles[$this->mFakePageId] = $title;
 908                                                 $this->mFakePageId--;
 909                                                 $this->mTitles[] = $title;
 910
 911                                                 // need gender information
 912                                                 if ( $nsInfo->hasGenderDistinction( $ns ) ) {
 913                                                         $usernames[] = $dbkey;
 914                                                 }
 915                                         }
 916                                 }
 917                         } else {
 918                                 // The remaining pageids do not exist
 919                                 if ( !$this->mMissingPageIDs ) {
 920                                         $this->mMissingPageIDs = array_keys( $remaining );
 921                                 } else {
 922                                         $this->mMissingPageIDs = array_merge( $this->mMissingPageIDs, array_keys( $remaining ) );
 923                                 }
 924                         }
 925                 }
 926
 927                 // Get gender information
 928                 $genderCache = MediaWikiServices::getInstance()->getGenderCache();
 929                 $genderCache->doQuery( $usernames, __METHOD__ );
 930         }
 931
 932         /**
 933          * Does the same as initFromTitles(), but is based on revision IDs
 934          * instead
 935          * @param array $revids Array of revision IDs
 936          */
 937         private function initFromRevIDs( $revids ) {
 938                 if ( !$revids ) {
 939                         return;
 940                 }
 941
 942                 $revids = array_map( 'intval', $revids ); // paranoia
 943                 $db = $this->getDB();
 944                 $pageids = [];
 945                 $remaining = array_flip( $revids );
 946
 947                 $revids = $this->filterIDs( [ [ 'revision', 'rev_id' ], [ 'archive', 'ar_rev_id' ] ], $revids );
 948                 $goodRemaining = array_flip( $revids );
 949
 950                 if ( $revids ) {
 951                         $tables = [ 'revision', 'page' ];
 952                         $fields = [ 'rev_id', 'rev_page' ];
 953                         $where = [ 'rev_id' => $revids, 'rev_page = page_id' ];
 954
 955                         // Get pageIDs data from the `page` table
 956                         $res = $db->select( $tables, $fields, $where, __METHOD__ );
 957                         foreach ( $res as $row ) {
 958                                 $revid = (int)$row->rev_id;
 959                                 $pageid = (int)$row->rev_page;
 960                                 $this->mGoodRevIDs[$revid] = $pageid;
 961                                 $this->mLiveRevIDs[$revid] = $pageid;
 962                                 $pageids[$pageid] = '';
 963                                 unset( $remaining[$revid] );
 964                                 unset( $goodRemaining[$revid] );
 965                         }
 966                 }
 967
 968                 // Populate all the page information
 969                 $this->initFromPageIds( array_keys( $pageids ), false );
 970
 971                 // If the user can see deleted revisions, pull out the corresponding
 972                 // titles from the archive table and include them too. We ignore
 973                 // ar_page_id because deleted revisions are tied by title, not page_id.
 974                 if ( $goodRemaining && $this->getUser()->isAllowed( 'deletedhistory' ) ) {
 975                         $tables = [ 'archive' ];
 976                         $fields = [ 'ar_rev_id', 'ar_namespace', 'ar_title' ];
 977                         $where = [ 'ar_rev_id' => array_keys( $goodRemaining ) ];
 978
 979                         $res = $db->select( $tables, $fields, $where, __METHOD__ );
 980                         $titles = [];
 981                         foreach ( $res as $row ) {
 982                                 $revid = (int)$row->ar_rev_id;
 983                                 $titles[$revid] = Title::makeTitle( $row->ar_namespace, $row->ar_title );
 984                                 unset( $remaining[$revid] );
 985                         }
 986
 987                         $this->initFromTitles( $titles );
 988
 989                         foreach ( $titles as $revid => $title ) {
 990                                 $ns = $title->getNamespace();
 991                                 $dbkey = $title->getDBkey();
 992
 993                                 // Handle converted titles
 994                                 if ( !isset( $this->mAllPages[$ns][$dbkey] ) &&
 995                                         isset( $this->mConvertedTitles[$title->getPrefixedText()] )
 996                                 ) {
 997                                         $title = Title::newFromText( $this->mConvertedTitles[$title->getPrefixedText()] );
 998                                         $ns = $title->getNamespace();
 999                                         $dbkey = $title->getDBkey();
1000                                 }
1001
1002                                 if ( isset( $this->mAllPages[$ns][$dbkey] ) ) {
1003                                         $this->mGoodRevIDs[$revid] = $this->mAllPages[$ns][$dbkey];
1004                                         $this->mDeletedRevIDs[$revid] = $this->mAllPages[$ns][$dbkey];
1005                                 } else {
1006                                         $remaining[$revid] = true;
1007                                 }
1008                         }
1009                 }
1010
1011                 $this->mMissingRevIDs = array_keys( $remaining );
1012         }
1013
1014         /**
1015          * Resolve any redirects in the result if redirect resolution was
1016          * requested. This function is called repeatedly until all redirects
1017          * have been resolved.
1018          */
1019         private function resolvePendingRedirects() {
1020                 if ( $this->mResolveRedirects ) {
1021                         $db = $this->getDB();
1022                         $pageFlds = $this->getPageTableFields();
1023
1024                         // Repeat until all redirects have been resolved
1025                         // The infinite loop is prevented by keeping all known pages in $this->mAllPages
1026                         while ( $this->mPendingRedirectIDs || $this->mPendingRedirectSpecialPages ) {
1027                                 // Resolve redirects by querying the pagelinks table, and repeat the process
1028                                 // Create a new linkBatch object for the next pass
1029                                 $linkBatch = $this->getRedirectTargets();
1030
1031                                 if ( $linkBatch->isEmpty() ) {
1032                                         break;
1033                                 }
1034
1035                                 $set = $linkBatch->constructSet( 'page', $db );
1036                                 if ( $set === false ) {
1037                                         break;
1038                                 }
1039
1040                                 // Get pageIDs data from the `page` table
1041                                 $res = $db->select( 'page', $pageFlds, $set, __METHOD__ );
1042
1043                                 // Hack: get the ns:titles stored in [ns => array(titles)] format
1044                                 $this->initFromQueryResult( $res, $linkBatch->data, true );
1045                         }
1046                 }
1047         }
1048
1049         /**
1050          * Get the targets of the pending redirects from the database
1051          *
1052          * Also creates entries in the redirect table for redirects that don't
1053          * have one.
1054          * @return LinkBatch
1055          */
1056         private function getRedirectTargets() {
1057                 $titlesToResolve = [];
1058                 $db = $this->getDB();
1059
1060                 if ( $this->mPendingRedirectIDs ) {
1061                         $res = $db->select(
1062                                 'redirect',
1063                                 [
1064                                         'rd_from',
1065                                         'rd_namespace',
1066                                         'rd_fragment',
1067                                         'rd_interwiki',
1068                                         'rd_title'
1069                                 ], [ 'rd_from' => array_keys( $this->mPendingRedirectIDs ) ],
1070                                         __METHOD__
1071                                 );
1072                         foreach ( $res as $row ) {
1073                                 $rdfrom = (int)$row->rd_from;
1074                                 $from = $this->mPendingRedirectIDs[$rdfrom]->getPrefixedText();
1075                                 $to = Title::makeTitle(
1076                                         $row->rd_namespace,
1077                                         $row->rd_title,
1078                                         $row->rd_fragment,
1079                                         $row->rd_interwiki
1080                                 );
1081                                 $this->mResolvedRedirectTitles[$from] = $this->mPendingRedirectIDs[$rdfrom];
1082                                 unset( $this->mPendingRedirectIDs[$rdfrom] );
1083                                 if ( $to->isExternal() ) {
1084                                         $this->mInterwikiTitles[$to->getPrefixedText()] = $to->getInterwiki();
1085                                 } elseif ( !isset( $this->mAllPages[$to->getNamespace()][$to->getDBkey()] ) ) {
1086                                         $titlesToResolve[] = $to;
1087                                 }
1088                                 $this->mRedirectTitles[$from] = $to;
1089                         }
1090
1091                         if ( $this->mPendingRedirectIDs ) {
1092                                 // We found pages that aren't in the redirect table
1093                                 // Add them
1094                                 foreach ( $this->mPendingRedirectIDs as $id => $title ) {
1095                                         $page = WikiPage::factory( $title );
1096                                         $rt = $page->insertRedirect();
1097                                         if ( !$rt ) {
1098                                                 // What the hell. Let's just ignore this
1099                                                 continue;
1100                                         }
1101                                         if ( $rt->isExternal() ) {
1102                                                 $this->mInterwikiTitles[$rt->getPrefixedText()] = $rt->getInterwiki();
1103                                         } elseif ( !isset( $this->mAllPages[$rt->getNamespace()][$rt->getDBkey()] ) ) {
1104                                                 $titlesToResolve[] = $rt;
1105                                         }
1106                                         $from = $title->getPrefixedText();
1107                                         $this->mResolvedRedirectTitles[$from] = $title;
1108                                         $this->mRedirectTitles[$from] = $rt;
1109                                         unset( $this->mPendingRedirectIDs[$id] );
1110                                 }
1111                         }
1112                 }
1113
1114                 if ( $this->mPendingRedirectSpecialPages ) {
1115                         foreach ( $this->mPendingRedirectSpecialPages as $key => list( $from, $to ) ) {
1116                                 $fromKey = $from->getPrefixedText();
1117                                 $this->mResolvedRedirectTitles[$fromKey] = $from;
1118                                 $this->mRedirectTitles[$fromKey] = $to;
1119                                 if ( $to->isExternal() ) {
1120                                         $this->mInterwikiTitles[$to->getPrefixedText()] = $to->getInterwiki();
1121                                 } elseif ( !isset( $this->mAllPages[$to->getNamespace()][$to->getDBkey()] ) ) {
1122                                         $titlesToResolve[] = $to;
1123                                 }
1124                         }
1125                         $this->mPendingRedirectSpecialPages = [];
1126
1127                         // Set private caching since we don't know what criteria the
1128                         // special pages used to decide on these redirects.
1129                         $this->mCacheMode = 'private';
1130                 }
1131
1132                 return $this->processTitlesArray( $titlesToResolve );
1133         }
1134
1135         /**
1136          * Get the cache mode for the data generated by this module.
1137          * All PageSet users should take into account whether this returns a more-restrictive
1138          * cache mode than the using module itself. For possible return values and other
1139          * details about cache modes, see ApiMain::setCacheMode()
1140          *
1141          * Public caching will only be allowed if *all* the modules that supply
1142          * data for a given request return a cache mode of public.
1143          *
1144          * @param array|null $params
1145          * @return string
1146          * @since 1.21
1147          */
1148         public function getCacheMode( $params = null ) {
1149                 return $this->mCacheMode;
1150         }
1151
1152         /**
1153          * Given an array of title strings, convert them into Title objects.
1154          * Alternatively, an array of Title objects may be given.
1155          * This method validates access rights for the title,
1156          * and appends normalization values to the output.
1157          *
1158          * @param array $titles Array of Title objects or strings
1159          * @return LinkBatch
1160          */
1161         private function processTitlesArray( $titles ) {
1162                 $usernames = [];
1163                 $linkBatch = new LinkBatch();
1164                 $services = MediaWikiServices::getInstance();
1165                 $contLang = $services->getContentLanguage();
1166
1167                 foreach ( $titles as $title ) {
1168                         if ( is_string( $title ) ) {
1169                                 try {
1170                                         $titleObj = Title::newFromTextThrow( $title, $this->mDefaultNamespace );
1171                                 } catch ( MalformedTitleException $ex ) {
1172                                         // Handle invalid titles gracefully
1173                                         if ( !isset( $this->mAllPages[0][$title] ) ) {
1174                                                 $this->mAllPages[0][$title] = $this->mFakePageId;
1175                                                 $this->mInvalidTitles[$this->mFakePageId] = [
1176                                                         'title' => $title,
1177                                                         'invalidreason' => $this->getErrorFormatter()->formatException( $ex, [ 'bc' => true ] ),
1178                                                 ];
1179                                                 $this->mFakePageId--;
1180                                         }
1181                                         continue; // There's nothing else we can do
1182                                 }
1183                         } else {
1184                                 $titleObj = $title;
1185                         }
1186                         $unconvertedTitle = $titleObj->getPrefixedText();
1187                         $titleWasConverted = false;
1188                         if ( $titleObj->isExternal() ) {
1189                                 // This title is an interwiki link.
1190                                 $this->mInterwikiTitles[$unconvertedTitle] = $titleObj->getInterwiki();
1191                         } else {
1192                                 // Variants checking
1193                                 if (
1194                                         $this->mConvertTitles && $contLang->hasVariants() && !$titleObj->exists()
1195                                 ) {
1196                                         // Language::findVariantLink will modify titleText and titleObj into
1197                                         // the canonical variant if possible
1198                                         $titleText = is_string( $title ) ? $title : $titleObj->getPrefixedText();
1199                                         $contLang->findVariantLink( $titleText, $titleObj );
1200                                         $titleWasConverted = $unconvertedTitle !== $titleObj->getPrefixedText();
1201                                 }
1202
1203                                 if ( $titleObj->getNamespace() < 0 ) {
1204                                         // Handle Special and Media pages
1205                                         $titleObj = $titleObj->fixSpecialName();
1206                                         $ns = $titleObj->getNamespace();
1207                                         $dbkey = $titleObj->getDBkey();
1208                                         if ( !isset( $this->mAllSpecials[$ns][$dbkey] ) ) {
1209                                                 $this->mAllSpecials[$ns][$dbkey] = $this->mFakePageId;
1210                                                 $target = null;
1211                                                 if ( $ns === NS_SPECIAL && $this->mResolveRedirects ) {
1212                                                         $spFactory = $services->getSpecialPageFactory();
1213                                                         $special = $spFactory->getPage( $dbkey );
1214                                                         if ( $special instanceof RedirectSpecialArticle ) {
1215                                                                 // Only RedirectSpecialArticle is intended to redirect to an article, other kinds of
1216                                                                 // RedirectSpecialPage are probably applying weird URL parameters we don't want to handle.
1217                                                                 $context = new DerivativeContext( $this );
1218                                                                 $context->setTitle( $titleObj );
1219                                                                 $context->setRequest( new FauxRequest );
1220                                                                 $special->setContext( $context );
1221                                                                 list( /* $alias */, $subpage ) = $spFactory->resolveAlias( $dbkey );
1222                                                                 $target = $special->getRedirect( $subpage );
1223                                                         }
1224                                                 }
1225                                                 if ( $target ) {
1226                                                         $this->mPendingRedirectSpecialPages[$dbkey] = [ $titleObj, $target ];
1227                                                 } else {
1228                                                         $this->mSpecialTitles[$this->mFakePageId] = $titleObj;
1229                                                         $this->mFakePageId--;
1230                                                 }
1231                                         }
1232                                 } else {
1233                                         // Regular page
1234                                         $linkBatch->addObj( $titleObj );
1235                                 }
1236                         }
1237
1238                         // Make sure we remember the original title that was
1239                         // given to us. This way the caller can correlate new
1240                         // titles with the originally requested when e.g. the
1241                         // namespace is localized or the capitalization is
1242                         // different
1243                         if ( $titleWasConverted ) {
1244                                 $this->mConvertedTitles[$unconvertedTitle] = $titleObj->getPrefixedText();
1245                                 // In this case the page can't be Special.
1246                                 if ( is_string( $title ) && $title !== $unconvertedTitle ) {
1247                                         $this->mNormalizedTitles[$title] = $unconvertedTitle;
1248                                 }
1249                         } elseif ( is_string( $title ) && $title !== $titleObj->getPrefixedText() ) {
1250                                 $this->mNormalizedTitles[$title] = $titleObj->getPrefixedText();
1251                         }
1252
1253                         // Need gender information
1254                         if (
1255                                 MediaWikiServices::getInstance()->getNamespaceInfo()->
1256                                         hasGenderDistinction( $titleObj->getNamespace() )
1257                         ) {
1258                                 $usernames[] = $titleObj->getText();
1259                         }
1260                 }
1261                 // Get gender information
1262                 $genderCache = $services->getGenderCache();
1263                 $genderCache->doQuery( $usernames, __METHOD__ );
1264
1265                 return $linkBatch;
1266         }
1267
1268         /**
1269          * Set data for a title.
1270          *
1271          * This data may be extracted into an ApiResult using
1272          * self::populateGeneratorData. This should generally be limited to
1273          * data that is likely to be particularly useful to end users rather than
1274          * just being a dump of everything returned in non-generator mode.
1275          *
1276          * Redirects here will *not* be followed, even if 'redirects' was
1277          * specified, since in the case of multiple redirects we can't know which
1278          * source's data to use on the target.
1279          *
1280          * @param Title $title
1281          * @param array $data
1282          */
1283         public function setGeneratorData( Title $title, array $data ) {
1284                 $ns = $title->getNamespace();
1285                 $dbkey = $title->getDBkey();
1286                 $this->mGeneratorData[$ns][$dbkey] = $data;
1287         }
1288
1289         /**
1290          * Controls how generator data about a redirect source is merged into
1291          * the generator data for the redirect target. When not set no data
1292          * is merged. Note that if multiple titles redirect to the same target
1293          * the order of operations is undefined.
1294          *
1295          * Example to include generated data from redirect in target, prefering
1296          * the data generated for the destination when there is a collision:
1297          * @code
1298          *   $pageSet->setRedirectMergePolicy( function( array $current, array $new ) {
1299          *       return $current + $new;
1300          *   } );
1301          * @endcode
1302          *
1303          * @param callable|null $callable Recieves two array arguments, first the
1304          *  generator data for the redirect target and second the generator data
1305          *  for the redirect source. Returns the resulting generator data to use
1306          *  for the redirect target.
1307          */
1308         public function setRedirectMergePolicy( $callable ) {
1309                 $this->mRedirectMergePolicy = $callable;
1310         }
1311
1312         /**
1313          * Populate the generator data for all titles in the result
1314          *
1315          * The page data may be inserted into an ApiResult object or into an
1316          * associative array. The $path parameter specifies the path within the
1317          * ApiResult or array to find the "pages" node.
1318          *
1319          * The "pages" node itself must be an associative array mapping the page ID
1320          * or fake page ID values returned by this pageset (see
1321          * self::getAllTitlesByNamespace() and self::getSpecialTitles()) to
1322          * associative arrays of page data. Each of those subarrays will have the
1323          * data from self::setGeneratorData() merged in.
1324          *
1325          * Data that was set by self::setGeneratorData() for pages not in the
1326          * "pages" node will be ignored.
1327          *
1328          * @param ApiResult|array &$result
1329          * @param array $path
1330          * @return bool Whether the data fit
1331          */
1332         public function populateGeneratorData( &$result, array $path = [] ) {
1333                 if ( $result instanceof ApiResult ) {
1334                         $data = $result->getResultData( $path );
1335                         if ( $data === null ) {
1336                                 return true;
1337                         }
1338                 } else {
1339                         $data = &$result;
1340                         foreach ( $path as $key ) {
1341                                 if ( !isset( $data[$key] ) ) {
1342                                         // Path isn't in $result, so nothing to add, so everything
1343                                         // "fits"
1344                                         return true;
1345                                 }
1346                                 $data = &$data[$key];
1347                         }
1348                 }
1349                 foreach ( $this->mGeneratorData as $ns => $dbkeys ) {
1350                         if ( $ns === NS_SPECIAL ) {
1351                                 $pages = [];
1352                                 foreach ( $this->mSpecialTitles as $id => $title ) {
1353                                         $pages[$title->getDBkey()] = $id;
1354                                 }
1355                         } else {
1356                                 if ( !isset( $this->mAllPages[$ns] ) ) {
1357                                         // No known titles in the whole namespace. Skip it.
1358                                         continue;
1359                                 }
1360                                 $pages = $this->mAllPages[$ns];
1361                         }
1362                         foreach ( $dbkeys as $dbkey => $genData ) {
1363                                 if ( !isset( $pages[$dbkey] ) ) {
1364                                         // Unknown title. Forget it.
1365                                         continue;
1366                                 }
1367                                 $pageId = $pages[$dbkey];
1368                                 if ( !isset( $data[$pageId] ) ) {
1369                                         // $pageId didn't make it into the result. Ignore it.
1370                                         continue;
1371                                 }
1372
1373                                 if ( $result instanceof ApiResult ) {
1374                                         $path2 = array_merge( $path, [ $pageId ] );
1375                                         foreach ( $genData as $key => $value ) {
1376                                                 if ( !$result->addValue( $path2, $key, $value ) ) {
1377                                                         return false;
1378                                                 }
1379                                         }
1380                                 } else {
1381                                         $data[$pageId] = array_merge( $data[$pageId], $genData );
1382                                 }
1383                         }
1384                 }
1385
1386                 // Merge data generated about redirect titles into the redirect destination
1387                 if ( $this->mRedirectMergePolicy ) {
1388                         foreach ( $this->mResolvedRedirectTitles as $titleFrom ) {
1389                                 $dest = $titleFrom;
1390                                 while ( isset( $this->mRedirectTitles[$dest->getPrefixedText()] ) ) {
1391                                         $dest = $this->mRedirectTitles[$dest->getPrefixedText()];
1392                                 }
1393                                 $fromNs = $titleFrom->getNamespace();
1394                                 $fromDBkey = $titleFrom->getDBkey();
1395                                 $toPageId = $dest->getArticleID();
1396                                 if ( isset( $data[$toPageId] ) &&
1397                                         isset( $this->mGeneratorData[$fromNs][$fromDBkey] )
1398                                 ) {
1399                                         // It is necessary to set both $data and add to $result, if an ApiResult,
1400                                         // to ensure multiple redirects to the same destination are all merged.
1401                                         $data[$toPageId] = call_user_func(
1402                                                 $this->mRedirectMergePolicy,
1403                                                 $data[$toPageId],
1404                                                 $this->mGeneratorData[$fromNs][$fromDBkey]
1405                                         );
1406                                         if ( $result instanceof ApiResult &&
1407                                                 !$result->addValue( $path, $toPageId, $data[$toPageId], ApiResult::OVERRIDE )
1408                                         ) {
1409                                                 return false;
1410                                         }
1411                                 }
1412                         }
1413                 }
1414
1415                 return true;
1416         }
1417
1418         /**
1419          * Get the database connection (read-only)
1420          * @return IDatabase
1421          */
1422         protected function getDB() {
1423                 return $this->mDbSource->getDB();
1424         }
1425
1426         public function getAllowedParams( $flags = 0 ) {
1427                 $result = [
1428                         'titles' => [
1429                                 ApiBase::PARAM_ISMULTI => true,
1430                                 ApiBase::PARAM_HELP_MSG => 'api-pageset-param-titles',
1431                         ],
1432                         'pageids' => [
1433                                 ApiBase::PARAM_TYPE => 'integer',
1434                                 ApiBase::PARAM_ISMULTI => true,
1435                                 ApiBase::PARAM_HELP_MSG => 'api-pageset-param-pageids',
1436                         ],
1437                         'revids' => [
1438                                 ApiBase::PARAM_TYPE => 'integer',
1439                                 ApiBase::PARAM_ISMULTI => true,
1440                                 ApiBase::PARAM_HELP_MSG => 'api-pageset-param-revids',
1441                         ],
1442                         'generator' => [
1443                                 ApiBase::PARAM_TYPE => null,
1444                                 ApiBase::PARAM_HELP_MSG => 'api-pageset-param-generator',
1445                                 ApiBase::PARAM_SUBMODULE_PARAM_PREFIX => 'g',
1446                         ],
1447                         'redirects' => [
1448                                 ApiBase::PARAM_DFLT => false,
1449                                 ApiBase::PARAM_HELP_MSG => $this->mAllowGenerator
1450                                         ? 'api-pageset-param-redirects-generator'
1451                                         : 'api-pageset-param-redirects-nogenerator',
1452                         ],
1453                         'converttitles' => [
1454                                 ApiBase::PARAM_DFLT => false,
1455                                 ApiBase::PARAM_HELP_MSG => [
1456                                         'api-pageset-param-converttitles',
1457                                         [ Message::listParam( LanguageConverter::$languagesWithVariants, 'text' ) ],
1458                                 ],
1459                         ],
1460                 ];
1461
1462                 if ( !$this->mAllowGenerator ) {
1463                         unset( $result['generator'] );
1464                 } elseif ( $flags & ApiBase::GET_VALUES_FOR_HELP ) {
1465                         $result['generator'][ApiBase::PARAM_TYPE] = 'submodule';
1466                         $result['generator'][ApiBase::PARAM_SUBMODULE_MAP] = $this->getGenerators();
1467                 }
1468
1469                 return $result;
1470         }
1471
1472         protected function handleParamNormalization( $paramName, $value, $rawValue ) {
1473                 parent::handleParamNormalization( $paramName, $value, $rawValue );
1474
1475                 if ( $paramName === 'titles' ) {
1476                         // For the 'titles' parameter, we want to split it like ApiBase would
1477                         // and add any changed titles to $this->mNormalizedTitles
1478                         $value = $this->explodeMultiValue( $value, self::LIMIT_SML2 + 1 );
1479                         $l = count( $value );
1480                         $rawValue = $this->explodeMultiValue( $rawValue, $l );
1481                         for ( $i = 0; $i < $l; $i++ ) {
1482                                 if ( $value[$i] !== $rawValue[$i] ) {
1483                                         $this->mNormalizedTitles[$rawValue[$i]] = $value[$i];
1484                                 }
1485                         }
1486                 }
1487         }
1488
1489         private static $generators = null;
1490
1491         /**
1492          * Get an array of all available generators
1493          * @return array
1494          */
1495         private function getGenerators() {
1496                 if ( self::$generators === null ) {
1497                         $query = $this->mDbSource;
1498                         if ( !( $query instanceof ApiQuery ) ) {
1499                                 // If the parent container of this pageset is not ApiQuery,
1500                                 // we must create it to get module manager
1501                                 $query = $this->getMain()->getModuleManager()->getModule( 'query' );
1502                         }
1503                         $gens = [];
1504                         $prefix = $query->getModulePath() . '+';
1505                         $mgr = $query->getModuleManager();
1506                         foreach ( $mgr->getNamesWithClasses() as $name => $class ) {
1507                                 if ( is_subclass_of( $class, ApiQueryGeneratorBase::class ) ) {
1508                                         $gens[$name] = $prefix . $name;
1509                                 }
1510                         }
1511                         ksort( $gens );
1512                         self::$generators = $gens;
1513                 }
1514
1515                 return self::$generators;
1516         }
1517 }