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