5 * Created on Sep 25, 2006
7 * Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22 * http://www.gnu.org/copyleft/gpl.html
26 use MediaWiki\MediaWikiServices
;
27 use MediaWiki\Linker\LinkTarget
;
30 * A query module to show basic page information.
34 class ApiQueryInfo
extends ApiQueryBase
{
36 private $fld_protection = false, $fld_talkid = false,
37 $fld_subjectid = false, $fld_url = false,
38 $fld_readable = false, $fld_watched = false,
39 $fld_watchers = false, $fld_visitingwatchers = false,
40 $fld_notificationtimestamp = false,
41 $fld_preload = false, $fld_displaytitle = false;
52 private $pageRestrictions, $pageIsRedir, $pageIsNew, $pageTouched,
53 $pageLatest, $pageLength;
55 private $protections, $restrictionTypes, $watched, $watchers, $visitingwatchers,
56 $notificationtimestamps, $talkids, $subjectids, $displaytitles;
57 private $showZeroWatchers = false;
59 private $tokenFunctions;
61 private $countTestedActions = 0;
63 public function __construct( ApiQuery
$query, $moduleName ) {
64 parent
::__construct( $query, $moduleName, 'in' );
68 * @param ApiPageSet $pageSet
71 public function requestExtraData( $pageSet ) {
72 $pageSet->requestField( 'page_restrictions' );
73 // If the pageset is resolving redirects we won't get page_is_redirect.
74 // But we can't know for sure until the pageset is executed (revids may
75 // turn it off), so request it unconditionally.
76 $pageSet->requestField( 'page_is_redirect' );
77 $pageSet->requestField( 'page_is_new' );
78 $config = $this->getConfig();
79 $pageSet->requestField( 'page_touched' );
80 $pageSet->requestField( 'page_latest' );
81 $pageSet->requestField( 'page_len' );
82 if ( $config->get( 'ContentHandlerUseDB' ) ) {
83 $pageSet->requestField( 'page_content_model' );
85 if ( $config->get( 'PageLanguageUseDB' ) ) {
86 $pageSet->requestField( 'page_lang' );
91 * Get an array mapping token names to their handler functions.
92 * The prototype for a token function is func($pageid, $title)
93 * it should return a token or false (permission denied)
94 * @deprecated since 1.24
95 * @return array Array(tokenname => function)
97 protected function getTokenFunctions() {
98 // Don't call the hooks twice
99 if ( isset( $this->tokenFunctions
) ) {
100 return $this->tokenFunctions
;
103 // If we're in a mode that breaks the same-origin policy, no tokens can
105 if ( $this->lacksSameOriginSecurity() ) {
109 $this->tokenFunctions
= [
110 'edit' => [ 'ApiQueryInfo', 'getEditToken' ],
111 'delete' => [ 'ApiQueryInfo', 'getDeleteToken' ],
112 'protect' => [ 'ApiQueryInfo', 'getProtectToken' ],
113 'move' => [ 'ApiQueryInfo', 'getMoveToken' ],
114 'block' => [ 'ApiQueryInfo', 'getBlockToken' ],
115 'unblock' => [ 'ApiQueryInfo', 'getUnblockToken' ],
116 'email' => [ 'ApiQueryInfo', 'getEmailToken' ],
117 'import' => [ 'ApiQueryInfo', 'getImportToken' ],
118 'watch' => [ 'ApiQueryInfo', 'getWatchToken' ],
120 Hooks
::run( 'APIQueryInfoTokens', [ &$this->tokenFunctions
] );
122 return $this->tokenFunctions
;
125 static protected $cachedTokens = [];
128 * @deprecated since 1.24
130 public static function resetTokenCache() {
131 ApiQueryInfo
::$cachedTokens = [];
135 * @deprecated since 1.24
137 public static function getEditToken( $pageid, $title ) {
138 // We could check for $title->userCan('edit') here,
139 // but that's too expensive for this purpose
140 // and would break caching
142 if ( !$wgUser->isAllowed( 'edit' ) ) {
146 // The token is always the same, let's exploit that
147 if ( !isset( ApiQueryInfo
::$cachedTokens['edit'] ) ) {
148 ApiQueryInfo
::$cachedTokens['edit'] = $wgUser->getEditToken();
151 return ApiQueryInfo
::$cachedTokens['edit'];
155 * @deprecated since 1.24
157 public static function getDeleteToken( $pageid, $title ) {
159 if ( !$wgUser->isAllowed( 'delete' ) ) {
163 // The token is always the same, let's exploit that
164 if ( !isset( ApiQueryInfo
::$cachedTokens['delete'] ) ) {
165 ApiQueryInfo
::$cachedTokens['delete'] = $wgUser->getEditToken();
168 return ApiQueryInfo
::$cachedTokens['delete'];
172 * @deprecated since 1.24
174 public static function getProtectToken( $pageid, $title ) {
176 if ( !$wgUser->isAllowed( 'protect' ) ) {
180 // The token is always the same, let's exploit that
181 if ( !isset( ApiQueryInfo
::$cachedTokens['protect'] ) ) {
182 ApiQueryInfo
::$cachedTokens['protect'] = $wgUser->getEditToken();
185 return ApiQueryInfo
::$cachedTokens['protect'];
189 * @deprecated since 1.24
191 public static function getMoveToken( $pageid, $title ) {
193 if ( !$wgUser->isAllowed( 'move' ) ) {
197 // The token is always the same, let's exploit that
198 if ( !isset( ApiQueryInfo
::$cachedTokens['move'] ) ) {
199 ApiQueryInfo
::$cachedTokens['move'] = $wgUser->getEditToken();
202 return ApiQueryInfo
::$cachedTokens['move'];
206 * @deprecated since 1.24
208 public static function getBlockToken( $pageid, $title ) {
210 if ( !$wgUser->isAllowed( 'block' ) ) {
214 // The token is always the same, let's exploit that
215 if ( !isset( ApiQueryInfo
::$cachedTokens['block'] ) ) {
216 ApiQueryInfo
::$cachedTokens['block'] = $wgUser->getEditToken();
219 return ApiQueryInfo
::$cachedTokens['block'];
223 * @deprecated since 1.24
225 public static function getUnblockToken( $pageid, $title ) {
226 // Currently, this is exactly the same as the block token
227 return self
::getBlockToken( $pageid, $title );
231 * @deprecated since 1.24
233 public static function getEmailToken( $pageid, $title ) {
235 if ( !$wgUser->canSendEmail() ||
$wgUser->isBlockedFromEmailuser() ) {
239 // The token is always the same, let's exploit that
240 if ( !isset( ApiQueryInfo
::$cachedTokens['email'] ) ) {
241 ApiQueryInfo
::$cachedTokens['email'] = $wgUser->getEditToken();
244 return ApiQueryInfo
::$cachedTokens['email'];
248 * @deprecated since 1.24
250 public static function getImportToken( $pageid, $title ) {
252 if ( !$wgUser->isAllowedAny( 'import', 'importupload' ) ) {
256 // The token is always the same, let's exploit that
257 if ( !isset( ApiQueryInfo
::$cachedTokens['import'] ) ) {
258 ApiQueryInfo
::$cachedTokens['import'] = $wgUser->getEditToken();
261 return ApiQueryInfo
::$cachedTokens['import'];
265 * @deprecated since 1.24
267 public static function getWatchToken( $pageid, $title ) {
269 if ( !$wgUser->isLoggedIn() ) {
273 // The token is always the same, let's exploit that
274 if ( !isset( ApiQueryInfo
::$cachedTokens['watch'] ) ) {
275 ApiQueryInfo
::$cachedTokens['watch'] = $wgUser->getEditToken( 'watch' );
278 return ApiQueryInfo
::$cachedTokens['watch'];
282 * @deprecated since 1.24
284 public static function getOptionsToken( $pageid, $title ) {
286 if ( !$wgUser->isLoggedIn() ) {
290 // The token is always the same, let's exploit that
291 if ( !isset( ApiQueryInfo
::$cachedTokens['options'] ) ) {
292 ApiQueryInfo
::$cachedTokens['options'] = $wgUser->getEditToken();
295 return ApiQueryInfo
::$cachedTokens['options'];
298 public function execute() {
299 $this->params
= $this->extractRequestParams();
300 if ( !is_null( $this->params
['prop'] ) ) {
301 $prop = array_flip( $this->params
['prop'] );
302 $this->fld_protection
= isset( $prop['protection'] );
303 $this->fld_watched
= isset( $prop['watched'] );
304 $this->fld_watchers
= isset( $prop['watchers'] );
305 $this->fld_visitingwatchers
= isset( $prop['visitingwatchers'] );
306 $this->fld_notificationtimestamp
= isset( $prop['notificationtimestamp'] );
307 $this->fld_talkid
= isset( $prop['talkid'] );
308 $this->fld_subjectid
= isset( $prop['subjectid'] );
309 $this->fld_url
= isset( $prop['url'] );
310 $this->fld_readable
= isset( $prop['readable'] );
311 $this->fld_preload
= isset( $prop['preload'] );
312 $this->fld_displaytitle
= isset( $prop['displaytitle'] );
315 $pageSet = $this->getPageSet();
316 $this->titles
= $pageSet->getGoodTitles();
317 $this->missing
= $pageSet->getMissingTitles();
318 $this->everything
= $this->titles +
$this->missing
;
319 $result = $this->getResult();
321 uasort( $this->everything
, [ 'Title', 'compare' ] );
322 if ( !is_null( $this->params
['continue'] ) ) {
323 // Throw away any titles we're gonna skip so they don't
325 $cont = explode( '|', $this->params
['continue'] );
326 $this->dieContinueUsageIf( count( $cont ) != 2 );
327 $conttitle = Title
::makeTitleSafe( $cont[0], $cont[1] );
328 foreach ( $this->everything
as $pageid => $title ) {
329 if ( Title
::compare( $title, $conttitle ) >= 0 ) {
332 unset( $this->titles
[$pageid] );
333 unset( $this->missing
[$pageid] );
334 unset( $this->everything
[$pageid] );
338 $this->pageRestrictions
= $pageSet->getCustomField( 'page_restrictions' );
339 // when resolving redirects, no page will have this field
340 $this->pageIsRedir
= !$pageSet->isResolvingRedirects()
341 ?
$pageSet->getCustomField( 'page_is_redirect' )
343 $this->pageIsNew
= $pageSet->getCustomField( 'page_is_new' );
345 $this->pageTouched
= $pageSet->getCustomField( 'page_touched' );
346 $this->pageLatest
= $pageSet->getCustomField( 'page_latest' );
347 $this->pageLength
= $pageSet->getCustomField( 'page_len' );
349 // Get protection info if requested
350 if ( $this->fld_protection
) {
351 $this->getProtectionInfo();
354 if ( $this->fld_watched ||
$this->fld_notificationtimestamp
) {
355 $this->getWatchedInfo();
358 if ( $this->fld_watchers
) {
359 $this->getWatcherInfo();
362 if ( $this->fld_visitingwatchers
) {
363 $this->getVisitingWatcherInfo();
366 // Run the talkid/subjectid query if requested
367 if ( $this->fld_talkid ||
$this->fld_subjectid
) {
371 if ( $this->fld_displaytitle
) {
372 $this->getDisplayTitle();
375 /** @var $title Title */
376 foreach ( $this->everything
as $pageid => $title ) {
377 $pageInfo = $this->extractPageInfo( $pageid, $title );
378 $fit = $pageInfo !== null && $result->addValue( [
381 ], $pageid, $pageInfo );
383 $this->setContinueEnumParameter( 'continue',
384 $title->getNamespace() . '|' .
392 * Get a result array with information about a title
393 * @param int $pageid Page ID (negative for missing titles)
394 * @param Title $title
397 private function extractPageInfo( $pageid, $title ) {
399 // $title->exists() needs pageid, which is not set for all title objects
400 $titleExists = $pageid > 0;
401 $ns = $title->getNamespace();
402 $dbkey = $title->getDBkey();
404 $pageInfo['contentmodel'] = $title->getContentModel();
406 $pageLanguage = $title->getPageLanguage();
407 $pageInfo['pagelanguage'] = $pageLanguage->getCode();
408 $pageInfo['pagelanguagehtmlcode'] = $pageLanguage->getHtmlCode();
409 $pageInfo['pagelanguagedir'] = $pageLanguage->getDir();
411 if ( $titleExists ) {
412 $pageInfo['touched'] = wfTimestamp( TS_ISO_8601
, $this->pageTouched
[$pageid] );
413 $pageInfo['lastrevid'] = intval( $this->pageLatest
[$pageid] );
414 $pageInfo['length'] = intval( $this->pageLength
[$pageid] );
416 if ( isset( $this->pageIsRedir
[$pageid] ) && $this->pageIsRedir
[$pageid] ) {
417 $pageInfo['redirect'] = true;
419 if ( $this->pageIsNew
[$pageid] ) {
420 $pageInfo['new'] = true;
424 if ( !is_null( $this->params
['token'] ) ) {
425 $tokenFunctions = $this->getTokenFunctions();
426 $pageInfo['starttimestamp'] = wfTimestamp( TS_ISO_8601
, time() );
427 foreach ( $this->params
['token'] as $t ) {
428 $val = call_user_func( $tokenFunctions[$t], $pageid, $title );
429 if ( $val === false ) {
430 $this->setWarning( "Action '$t' is not allowed for the current user" );
432 $pageInfo[$t . 'token'] = $val;
437 if ( $this->fld_protection
) {
438 $pageInfo['protection'] = [];
439 if ( isset( $this->protections
[$ns][$dbkey] ) ) {
440 $pageInfo['protection'] =
441 $this->protections
[$ns][$dbkey];
443 ApiResult
::setIndexedTagName( $pageInfo['protection'], 'pr' );
445 $pageInfo['restrictiontypes'] = [];
446 if ( isset( $this->restrictionTypes
[$ns][$dbkey] ) ) {
447 $pageInfo['restrictiontypes'] =
448 $this->restrictionTypes
[$ns][$dbkey];
450 ApiResult
::setIndexedTagName( $pageInfo['restrictiontypes'], 'rt' );
453 if ( $this->fld_watched
&& $this->watched
!== null ) {
454 $pageInfo['watched'] = $this->watched
[$ns][$dbkey];
457 if ( $this->fld_watchers
) {
458 if ( $this->watchers
!== null && $this->watchers
[$ns][$dbkey] !== 0 ) {
459 $pageInfo['watchers'] = $this->watchers
[$ns][$dbkey];
460 } elseif ( $this->showZeroWatchers
) {
461 $pageInfo['watchers'] = 0;
465 if ( $this->fld_visitingwatchers
) {
466 if ( $this->visitingwatchers
!== null && $this->visitingwatchers
[$ns][$dbkey] !== 0 ) {
467 $pageInfo['visitingwatchers'] = $this->visitingwatchers
[$ns][$dbkey];
468 } elseif ( $this->showZeroWatchers
) {
469 $pageInfo['visitingwatchers'] = 0;
473 if ( $this->fld_notificationtimestamp
) {
474 $pageInfo['notificationtimestamp'] = '';
475 if ( $this->notificationtimestamps
[$ns][$dbkey] ) {
476 $pageInfo['notificationtimestamp'] =
477 wfTimestamp( TS_ISO_8601
, $this->notificationtimestamps
[$ns][$dbkey] );
481 if ( $this->fld_talkid
&& isset( $this->talkids
[$ns][$dbkey] ) ) {
482 $pageInfo['talkid'] = $this->talkids
[$ns][$dbkey];
485 if ( $this->fld_subjectid
&& isset( $this->subjectids
[$ns][$dbkey] ) ) {
486 $pageInfo['subjectid'] = $this->subjectids
[$ns][$dbkey];
489 if ( $this->fld_url
) {
490 $pageInfo['fullurl'] = wfExpandUrl( $title->getFullURL(), PROTO_CURRENT
);
491 $pageInfo['editurl'] = wfExpandUrl( $title->getFullURL( 'action=edit' ), PROTO_CURRENT
);
492 $pageInfo['canonicalurl'] = wfExpandUrl( $title->getFullURL(), PROTO_CANONICAL
);
494 if ( $this->fld_readable
) {
495 $pageInfo['readable'] = $title->userCan( 'read', $this->getUser() );
498 if ( $this->fld_preload
) {
499 if ( $titleExists ) {
500 $pageInfo['preload'] = '';
503 Hooks
::run( 'EditFormPreloadText', [ &$text, &$title ] );
505 $pageInfo['preload'] = $text;
509 if ( $this->fld_displaytitle
) {
510 if ( isset( $this->displaytitles
[$pageid] ) ) {
511 $pageInfo['displaytitle'] = $this->displaytitles
[$pageid];
513 $pageInfo['displaytitle'] = $title->getPrefixedText();
517 if ( $this->params
['testactions'] ) {
518 $limit = $this->getMain()->canApiHighLimits() ? self
::LIMIT_SML1
: self
::LIMIT_SML2
;
519 if ( $this->countTestedActions
>= $limit ) {
520 return null; // force a continuation
523 $user = $this->getUser();
524 $pageInfo['actions'] = [];
525 foreach ( $this->params
['testactions'] as $action ) {
526 $this->countTestedActions++
;
527 $pageInfo['actions'][$action] = $title->userCan( $action, $user );
535 * Get information about protections and put it in $protections
537 private function getProtectionInfo() {
539 $this->protections
= [];
540 $db = $this->getDB();
542 // Get normal protections for existing titles
543 if ( count( $this->titles
) ) {
544 $this->resetQueryParams();
545 $this->addTables( 'page_restrictions' );
546 $this->addFields( [ 'pr_page', 'pr_type', 'pr_level',
547 'pr_expiry', 'pr_cascade' ] );
548 $this->addWhereFld( 'pr_page', array_keys( $this->titles
) );
550 $res = $this->select( __METHOD__
);
551 foreach ( $res as $row ) {
552 /** @var $title Title */
553 $title = $this->titles
[$row->pr_page
];
555 'type' => $row->pr_type
,
556 'level' => $row->pr_level
,
557 'expiry' => $wgContLang->formatExpiry( $row->pr_expiry
, TS_ISO_8601
)
559 if ( $row->pr_cascade
) {
560 $a['cascade'] = true;
562 $this->protections
[$title->getNamespace()][$title->getDBkey()][] = $a;
564 // Also check old restrictions
565 foreach ( $this->titles
as $pageId => $title ) {
566 if ( $this->pageRestrictions
[$pageId] ) {
567 $namespace = $title->getNamespace();
568 $dbKey = $title->getDBkey();
569 $restrictions = explode( ':', trim( $this->pageRestrictions
[$pageId] ) );
570 foreach ( $restrictions as $restrict ) {
571 $temp = explode( '=', trim( $restrict ) );
572 if ( count( $temp ) == 1 ) {
573 // old old format should be treated as edit/move restriction
574 $restriction = trim( $temp[0] );
576 if ( $restriction == '' ) {
579 $this->protections
[$namespace][$dbKey][] = [
581 'level' => $restriction,
582 'expiry' => 'infinity',
584 $this->protections
[$namespace][$dbKey][] = [
586 'level' => $restriction,
587 'expiry' => 'infinity',
590 $restriction = trim( $temp[1] );
591 if ( $restriction == '' ) {
594 $this->protections
[$namespace][$dbKey][] = [
596 'level' => $restriction,
597 'expiry' => 'infinity',
605 // Get protections for missing titles
606 if ( count( $this->missing
) ) {
607 $this->resetQueryParams();
608 $lb = new LinkBatch( $this->missing
);
609 $this->addTables( 'protected_titles' );
610 $this->addFields( [ 'pt_title', 'pt_namespace', 'pt_create_perm', 'pt_expiry' ] );
611 $this->addWhere( $lb->constructSet( 'pt', $db ) );
612 $res = $this->select( __METHOD__
);
613 foreach ( $res as $row ) {
614 $this->protections
[$row->pt_namespace
][$row->pt_title
][] = [
616 'level' => $row->pt_create_perm
,
617 'expiry' => $wgContLang->formatExpiry( $row->pt_expiry
, TS_ISO_8601
)
622 // Separate good and missing titles into files and other pages
623 // and populate $this->restrictionTypes
624 $images = $others = [];
625 foreach ( $this->everything
as $title ) {
626 if ( $title->getNamespace() == NS_FILE
) {
627 $images[] = $title->getDBkey();
631 // Applicable protection types
632 $this->restrictionTypes
[$title->getNamespace()][$title->getDBkey()] =
633 array_values( $title->getRestrictionTypes() );
636 if ( count( $others ) ) {
637 // Non-images: check templatelinks
638 $lb = new LinkBatch( $others );
639 $this->resetQueryParams();
640 $this->addTables( [ 'page_restrictions', 'page', 'templatelinks' ] );
641 $this->addFields( [ 'pr_type', 'pr_level', 'pr_expiry',
642 'page_title', 'page_namespace',
643 'tl_title', 'tl_namespace' ] );
644 $this->addWhere( $lb->constructSet( 'tl', $db ) );
645 $this->addWhere( 'pr_page = page_id' );
646 $this->addWhere( 'pr_page = tl_from' );
647 $this->addWhereFld( 'pr_cascade', 1 );
649 $res = $this->select( __METHOD__
);
650 foreach ( $res as $row ) {
651 $source = Title
::makeTitle( $row->page_namespace
, $row->page_title
);
652 $this->protections
[$row->tl_namespace
][$row->tl_title
][] = [
653 'type' => $row->pr_type
,
654 'level' => $row->pr_level
,
655 'expiry' => $wgContLang->formatExpiry( $row->pr_expiry
, TS_ISO_8601
),
656 'source' => $source->getPrefixedText()
661 if ( count( $images ) ) {
662 // Images: check imagelinks
663 $this->resetQueryParams();
664 $this->addTables( [ 'page_restrictions', 'page', 'imagelinks' ] );
665 $this->addFields( [ 'pr_type', 'pr_level', 'pr_expiry',
666 'page_title', 'page_namespace', 'il_to' ] );
667 $this->addWhere( 'pr_page = page_id' );
668 $this->addWhere( 'pr_page = il_from' );
669 $this->addWhereFld( 'pr_cascade', 1 );
670 $this->addWhereFld( 'il_to', $images );
672 $res = $this->select( __METHOD__
);
673 foreach ( $res as $row ) {
674 $source = Title
::makeTitle( $row->page_namespace
, $row->page_title
);
675 $this->protections
[NS_FILE
][$row->il_to
][] = [
676 'type' => $row->pr_type
,
677 'level' => $row->pr_level
,
678 'expiry' => $wgContLang->formatExpiry( $row->pr_expiry
, TS_ISO_8601
),
679 'source' => $source->getPrefixedText()
686 * Get talk page IDs (if requested) and subject page IDs (if requested)
687 * and put them in $talkids and $subjectids
689 private function getTSIDs() {
690 $getTitles = $this->talkids
= $this->subjectids
= [];
693 foreach ( $this->everything
as $t ) {
694 if ( MWNamespace
::isTalk( $t->getNamespace() ) ) {
695 if ( $this->fld_subjectid
) {
696 $getTitles[] = $t->getSubjectPage();
698 } elseif ( $this->fld_talkid
) {
699 $getTitles[] = $t->getTalkPage();
702 if ( !count( $getTitles ) ) {
706 $db = $this->getDB();
708 // Construct a custom WHERE clause that matches
709 // all titles in $getTitles
710 $lb = new LinkBatch( $getTitles );
711 $this->resetQueryParams();
712 $this->addTables( 'page' );
713 $this->addFields( [ 'page_title', 'page_namespace', 'page_id' ] );
714 $this->addWhere( $lb->constructSet( 'page', $db ) );
715 $res = $this->select( __METHOD__
);
716 foreach ( $res as $row ) {
717 if ( MWNamespace
::isTalk( $row->page_namespace
) ) {
718 $this->talkids
[MWNamespace
::getSubject( $row->page_namespace
)][$row->page_title
] =
719 intval( $row->page_id
);
721 $this->subjectids
[MWNamespace
::getTalk( $row->page_namespace
)][$row->page_title
] =
722 intval( $row->page_id
);
727 private function getDisplayTitle() {
728 $this->displaytitles
= [];
730 $pageIds = array_keys( $this->titles
);
732 if ( !count( $pageIds ) ) {
736 $this->resetQueryParams();
737 $this->addTables( 'page_props' );
738 $this->addFields( [ 'pp_page', 'pp_value' ] );
739 $this->addWhereFld( 'pp_page', $pageIds );
740 $this->addWhereFld( 'pp_propname', 'displaytitle' );
741 $res = $this->select( __METHOD__
);
743 foreach ( $res as $row ) {
744 $this->displaytitles
[$row->pp_page
] = $row->pp_value
;
749 * Get information about watched status and put it in $this->watched
750 * and $this->notificationtimestamps
752 private function getWatchedInfo() {
753 $user = $this->getUser();
755 if ( $user->isAnon() ||
count( $this->everything
) == 0
756 ||
!$user->isAllowed( 'viewmywatchlist' )
762 $this->notificationtimestamps
= [];
764 $store = MediaWikiServices
::getInstance()->getWatchedItemStore();
765 $timestamps = $store->getNotificationTimestampsBatch( $user, $this->everything
);
767 if ( $this->fld_watched
) {
768 foreach ( $timestamps as $namespaceId => $dbKeys ) {
769 $this->watched
[$namespaceId] = array_map(
777 if ( $this->fld_notificationtimestamp
) {
778 $this->notificationtimestamps
= $timestamps;
783 * Get the count of watchers and put it in $this->watchers
785 private function getWatcherInfo() {
786 if ( count( $this->everything
) == 0 ) {
790 $user = $this->getUser();
791 $canUnwatchedpages = $user->isAllowed( 'unwatchedpages' );
792 $unwatchedPageThreshold = $this->getConfig()->get( 'UnwatchedPageThreshold' );
793 if ( !$canUnwatchedpages && !is_int( $unwatchedPageThreshold ) ) {
797 $this->showZeroWatchers
= $canUnwatchedpages;
800 if ( !$canUnwatchedpages ) {
801 $countOptions['minimumWatchers'] = $unwatchedPageThreshold;
804 $this->watchers
= MediaWikiServices
::getInstance()->getWatchedItemStore()->countWatchersMultiple(
811 * Get the count of watchers who have visited recent edits and put it in
812 * $this->visitingwatchers
814 * Based on InfoAction::pageCounts
816 private function getVisitingWatcherInfo() {
817 $config = $this->getConfig();
818 $user = $this->getUser();
819 $db = $this->getDB();
821 $canUnwatchedpages = $user->isAllowed( 'unwatchedpages' );
822 $unwatchedPageThreshold = $this->getConfig()->get( 'UnwatchedPageThreshold' );
823 if ( !$canUnwatchedpages && !is_int( $unwatchedPageThreshold ) ) {
827 $this->showZeroWatchers
= $canUnwatchedpages;
829 $titlesWithThresholds = [];
830 if ( $this->titles
) {
831 $lb = new LinkBatch( $this->titles
);
833 // Fetch last edit timestamps for pages
834 $this->resetQueryParams();
835 $this->addTables( [ 'page', 'revision' ] );
836 $this->addFields( [ 'page_namespace', 'page_title', 'rev_timestamp' ] );
838 'page_latest = rev_id',
839 $lb->constructSet( 'page', $db ),
841 $this->addOption( 'GROUP BY', [ 'page_namespace', 'page_title' ] );
842 $timestampRes = $this->select( __METHOD__
);
844 $age = $config->get( 'WatchersMaxAge' );
846 foreach ( $timestampRes as $row ) {
847 $revTimestamp = wfTimestamp( TS_UNIX
, (int)$row->rev_timestamp
);
848 $timestamps[$row->page_namespace
][$row->page_title
] = $revTimestamp - $age;
850 $titlesWithThresholds = array_map(
851 function( LinkTarget
$target ) use ( $timestamps ) {
853 $target, $timestamps[$target->getNamespace()][$target->getDBkey()]
860 if ( $this->missing
) {
861 $titlesWithThresholds = array_merge(
862 $titlesWithThresholds,
864 function( LinkTarget
$target ) {
865 return [ $target, null ];
871 $store = MediaWikiServices
::getInstance()->getWatchedItemStore();
872 $this->visitingwatchers
= $store->countVisitingWatchersMultiple(
873 $titlesWithThresholds,
874 !$canUnwatchedpages ?
$unwatchedPageThreshold : null
878 public function getCacheMode( $params ) {
879 // Other props depend on something about the current user
888 if ( array_diff( (array)$params['prop'], $publicProps ) ) {
892 // testactions also depends on the current user
893 if ( $params['testactions'] ) {
897 if ( !is_null( $params['token'] ) ) {
904 public function getAllowedParams() {
907 ApiBase
::PARAM_ISMULTI
=> true,
908 ApiBase
::PARAM_TYPE
=> [
912 'watchers', # private
913 'visitingwatchers', # private
914 'notificationtimestamp', # private
917 'readable', # private
920 // If you add more properties here, please consider whether they
921 // need to be added to getCacheMode()
923 ApiBase
::PARAM_HELP_MSG_PER_VALUE
=> [],
926 ApiBase
::PARAM_TYPE
=> 'string',
927 ApiBase
::PARAM_ISMULTI
=> true,
930 ApiBase
::PARAM_DEPRECATED
=> true,
931 ApiBase
::PARAM_ISMULTI
=> true,
932 ApiBase
::PARAM_TYPE
=> array_keys( $this->getTokenFunctions() )
935 ApiBase
::PARAM_HELP_MSG
=> 'api-help-param-continue',
940 protected function getExamplesMessages() {
942 'action=query&prop=info&titles=Main%20Page'
943 => 'apihelp-query+info-example-simple',
944 'action=query&prop=info&inprop=protection&titles=Main%20Page'
945 => 'apihelp-query+info-example-protection',
949 public function getHelpUrls() {
950 return 'https://www.mediawiki.org/wiki/API:Info';