MediaWiki REL1_28
ApiQueryInfo.php
Go to the documentation of this file.
1<?php
28
35
36 private $fld_protection = false, $fld_talkid = false,
37 $fld_subjectid = false, $fld_url = false,
38 $fld_readable = false, $fld_watched = false,
42
43 private $params;
44
46 private $titles;
48 private $missing;
50 private $everything;
51
54
57 private $showZeroWatchers = false;
58
60
62
63 public function __construct( ApiQuery $query, $moduleName ) {
64 parent::__construct( $query, $moduleName, 'in' );
65 }
66
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' );
84 }
85 if ( $config->get( 'PageLanguageUseDB' ) ) {
86 $pageSet->requestField( 'page_lang' );
87 }
88 }
89
97 protected function getTokenFunctions() {
98 // Don't call the hooks twice
99 if ( isset( $this->tokenFunctions ) ) {
101 }
102
103 // If we're in a mode that breaks the same-origin policy, no tokens can
104 // be obtained
105 if ( $this->lacksSameOriginSecurity() ) {
106 return [];
107 }
108
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' ],
119 ];
120 Hooks::run( 'APIQueryInfoTokens', [ &$this->tokenFunctions ] );
121
123 }
124
125 static protected $cachedTokens = [];
126
130 public static function resetTokenCache() {
132 }
133
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' ) ) {
143 return false;
144 }
145
146 // The token is always the same, let's exploit that
147 if ( !isset( ApiQueryInfo::$cachedTokens['edit'] ) ) {
148 ApiQueryInfo::$cachedTokens['edit'] = $wgUser->getEditToken();
149 }
150
151 return ApiQueryInfo::$cachedTokens['edit'];
152 }
153
157 public static function getDeleteToken( $pageid, $title ) {
159 if ( !$wgUser->isAllowed( 'delete' ) ) {
160 return false;
161 }
162
163 // The token is always the same, let's exploit that
164 if ( !isset( ApiQueryInfo::$cachedTokens['delete'] ) ) {
165 ApiQueryInfo::$cachedTokens['delete'] = $wgUser->getEditToken();
166 }
167
168 return ApiQueryInfo::$cachedTokens['delete'];
169 }
170
174 public static function getProtectToken( $pageid, $title ) {
176 if ( !$wgUser->isAllowed( 'protect' ) ) {
177 return false;
178 }
179
180 // The token is always the same, let's exploit that
181 if ( !isset( ApiQueryInfo::$cachedTokens['protect'] ) ) {
182 ApiQueryInfo::$cachedTokens['protect'] = $wgUser->getEditToken();
183 }
184
185 return ApiQueryInfo::$cachedTokens['protect'];
186 }
187
191 public static function getMoveToken( $pageid, $title ) {
193 if ( !$wgUser->isAllowed( 'move' ) ) {
194 return false;
195 }
196
197 // The token is always the same, let's exploit that
198 if ( !isset( ApiQueryInfo::$cachedTokens['move'] ) ) {
199 ApiQueryInfo::$cachedTokens['move'] = $wgUser->getEditToken();
200 }
201
202 return ApiQueryInfo::$cachedTokens['move'];
203 }
204
208 public static function getBlockToken( $pageid, $title ) {
210 if ( !$wgUser->isAllowed( 'block' ) ) {
211 return false;
212 }
213
214 // The token is always the same, let's exploit that
215 if ( !isset( ApiQueryInfo::$cachedTokens['block'] ) ) {
216 ApiQueryInfo::$cachedTokens['block'] = $wgUser->getEditToken();
217 }
218
219 return ApiQueryInfo::$cachedTokens['block'];
220 }
221
225 public static function getUnblockToken( $pageid, $title ) {
226 // Currently, this is exactly the same as the block token
227 return self::getBlockToken( $pageid, $title );
228 }
229
233 public static function getEmailToken( $pageid, $title ) {
235 if ( !$wgUser->canSendEmail() || $wgUser->isBlockedFromEmailuser() ) {
236 return false;
237 }
238
239 // The token is always the same, let's exploit that
240 if ( !isset( ApiQueryInfo::$cachedTokens['email'] ) ) {
241 ApiQueryInfo::$cachedTokens['email'] = $wgUser->getEditToken();
242 }
243
244 return ApiQueryInfo::$cachedTokens['email'];
245 }
246
250 public static function getImportToken( $pageid, $title ) {
252 if ( !$wgUser->isAllowedAny( 'import', 'importupload' ) ) {
253 return false;
254 }
255
256 // The token is always the same, let's exploit that
257 if ( !isset( ApiQueryInfo::$cachedTokens['import'] ) ) {
258 ApiQueryInfo::$cachedTokens['import'] = $wgUser->getEditToken();
259 }
260
261 return ApiQueryInfo::$cachedTokens['import'];
262 }
263
267 public static function getWatchToken( $pageid, $title ) {
269 if ( !$wgUser->isLoggedIn() ) {
270 return false;
271 }
272
273 // The token is always the same, let's exploit that
274 if ( !isset( ApiQueryInfo::$cachedTokens['watch'] ) ) {
275 ApiQueryInfo::$cachedTokens['watch'] = $wgUser->getEditToken( 'watch' );
276 }
277
278 return ApiQueryInfo::$cachedTokens['watch'];
279 }
280
284 public static function getOptionsToken( $pageid, $title ) {
286 if ( !$wgUser->isLoggedIn() ) {
287 return false;
288 }
289
290 // The token is always the same, let's exploit that
291 if ( !isset( ApiQueryInfo::$cachedTokens['options'] ) ) {
292 ApiQueryInfo::$cachedTokens['options'] = $wgUser->getEditToken();
293 }
294
295 return ApiQueryInfo::$cachedTokens['options'];
296 }
297
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'] );
313 }
314
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();
320
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
324 // clutter queries
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 ) {
330 break;
331 }
332 unset( $this->titles[$pageid] );
333 unset( $this->missing[$pageid] );
334 unset( $this->everything[$pageid] );
335 }
336 }
337
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' )
342 : [];
343 $this->pageIsNew = $pageSet->getCustomField( 'page_is_new' );
344
345 $this->pageTouched = $pageSet->getCustomField( 'page_touched' );
346 $this->pageLatest = $pageSet->getCustomField( 'page_latest' );
347 $this->pageLength = $pageSet->getCustomField( 'page_len' );
348
349 // Get protection info if requested
350 if ( $this->fld_protection ) {
351 $this->getProtectionInfo();
352 }
353
354 if ( $this->fld_watched || $this->fld_notificationtimestamp ) {
355 $this->getWatchedInfo();
356 }
357
358 if ( $this->fld_watchers ) {
359 $this->getWatcherInfo();
360 }
361
362 if ( $this->fld_visitingwatchers ) {
363 $this->getVisitingWatcherInfo();
364 }
365
366 // Run the talkid/subjectid query if requested
367 if ( $this->fld_talkid || $this->fld_subjectid ) {
368 $this->getTSIDs();
369 }
370
371 if ( $this->fld_displaytitle ) {
372 $this->getDisplayTitle();
373 }
374
376 foreach ( $this->everything as $pageid => $title ) {
377 $pageInfo = $this->extractPageInfo( $pageid, $title );
378 $fit = $pageInfo !== null && $result->addValue( [
379 'query',
380 'pages'
381 ], $pageid, $pageInfo );
382 if ( !$fit ) {
383 $this->setContinueEnumParameter( 'continue',
384 $title->getNamespace() . '|' .
385 $title->getText() );
386 break;
387 }
388 }
389 }
390
397 private function extractPageInfo( $pageid, $title ) {
398 $pageInfo = [];
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();
403
404 $pageInfo['contentmodel'] = $title->getContentModel();
405
406 $pageLanguage = $title->getPageLanguage();
407 $pageInfo['pagelanguage'] = $pageLanguage->getCode();
408 $pageInfo['pagelanguagehtmlcode'] = $pageLanguage->getHtmlCode();
409 $pageInfo['pagelanguagedir'] = $pageLanguage->getDir();
410
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] );
415
416 if ( isset( $this->pageIsRedir[$pageid] ) && $this->pageIsRedir[$pageid] ) {
417 $pageInfo['redirect'] = true;
418 }
419 if ( $this->pageIsNew[$pageid] ) {
420 $pageInfo['new'] = true;
421 }
422 }
423
424 if ( !is_null( $this->params['token'] ) ) {
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" );
431 } else {
432 $pageInfo[$t . 'token'] = $val;
433 }
434 }
435 }
436
437 if ( $this->fld_protection ) {
438 $pageInfo['protection'] = [];
439 if ( isset( $this->protections[$ns][$dbkey] ) ) {
440 $pageInfo['protection'] =
441 $this->protections[$ns][$dbkey];
442 }
443 ApiResult::setIndexedTagName( $pageInfo['protection'], 'pr' );
444
445 $pageInfo['restrictiontypes'] = [];
446 if ( isset( $this->restrictionTypes[$ns][$dbkey] ) ) {
447 $pageInfo['restrictiontypes'] =
448 $this->restrictionTypes[$ns][$dbkey];
449 }
450 ApiResult::setIndexedTagName( $pageInfo['restrictiontypes'], 'rt' );
451 }
452
453 if ( $this->fld_watched && $this->watched !== null ) {
454 $pageInfo['watched'] = $this->watched[$ns][$dbkey];
455 }
456
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;
462 }
463 }
464
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;
470 }
471 }
472
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] );
478 }
479 }
480
481 if ( $this->fld_talkid && isset( $this->talkids[$ns][$dbkey] ) ) {
482 $pageInfo['talkid'] = $this->talkids[$ns][$dbkey];
483 }
484
485 if ( $this->fld_subjectid && isset( $this->subjectids[$ns][$dbkey] ) ) {
486 $pageInfo['subjectid'] = $this->subjectids[$ns][$dbkey];
487 }
488
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 );
493 }
494 if ( $this->fld_readable ) {
495 $pageInfo['readable'] = $title->userCan( 'read', $this->getUser() );
496 }
497
498 if ( $this->fld_preload ) {
499 if ( $titleExists ) {
500 $pageInfo['preload'] = '';
501 } else {
502 $text = null;
503 Hooks::run( 'EditFormPreloadText', [ &$text, &$title ] );
504
505 $pageInfo['preload'] = $text;
506 }
507 }
508
509 if ( $this->fld_displaytitle ) {
510 if ( isset( $this->displaytitles[$pageid] ) ) {
511 $pageInfo['displaytitle'] = $this->displaytitles[$pageid];
512 } else {
513 $pageInfo['displaytitle'] = $title->getPrefixedText();
514 }
515 }
516
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
521 }
522
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 );
528 }
529 }
530
531 return $pageInfo;
532 }
533
537 private function getProtectionInfo() {
539 $this->protections = [];
540 $db = $this->getDB();
541
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 ) );
549
550 $res = $this->select( __METHOD__ );
551 foreach ( $res as $row ) {
553 $title = $this->titles[$row->pr_page];
554 $a = [
555 'type' => $row->pr_type,
556 'level' => $row->pr_level,
557 'expiry' => $wgContLang->formatExpiry( $row->pr_expiry, TS_ISO_8601 )
558 ];
559 if ( $row->pr_cascade ) {
560 $a['cascade'] = true;
561 }
562 $this->protections[$title->getNamespace()][$title->getDBkey()][] = $a;
563 }
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] );
575
576 if ( $restriction == '' ) {
577 continue;
578 }
579 $this->protections[$namespace][$dbKey][] = [
580 'type' => 'edit',
581 'level' => $restriction,
582 'expiry' => 'infinity',
583 ];
584 $this->protections[$namespace][$dbKey][] = [
585 'type' => 'move',
586 'level' => $restriction,
587 'expiry' => 'infinity',
588 ];
589 } else {
590 $restriction = trim( $temp[1] );
591 if ( $restriction == '' ) {
592 continue;
593 }
594 $this->protections[$namespace][$dbKey][] = [
595 'type' => $temp[0],
596 'level' => $restriction,
597 'expiry' => 'infinity',
598 ];
599 }
600 }
601 }
602 }
603 }
604
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][] = [
615 'type' => 'create',
616 'level' => $row->pt_create_perm,
617 'expiry' => $wgContLang->formatExpiry( $row->pt_expiry, TS_ISO_8601 )
618 ];
619 }
620 }
621
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();
628 } else {
629 $others[] = $title;
630 }
631 // Applicable protection types
632 $this->restrictionTypes[$title->getNamespace()][$title->getDBkey()] =
633 array_values( $title->getRestrictionTypes() );
634 }
635
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 );
648
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()
657 ];
658 }
659 }
660
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 );
671
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()
680 ];
681 }
682 }
683 }
684
689 private function getTSIDs() {
690 $getTitles = $this->talkids = $this->subjectids = [];
691
693 foreach ( $this->everything as $t ) {
694 if ( MWNamespace::isTalk( $t->getNamespace() ) ) {
695 if ( $this->fld_subjectid ) {
696 $getTitles[] = $t->getSubjectPage();
697 }
698 } elseif ( $this->fld_talkid ) {
699 $getTitles[] = $t->getTalkPage();
700 }
701 }
702 if ( !count( $getTitles ) ) {
703 return;
704 }
705
706 $db = $this->getDB();
707
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 );
720 } else {
721 $this->subjectids[MWNamespace::getTalk( $row->page_namespace )][$row->page_title] =
722 intval( $row->page_id );
723 }
724 }
725 }
726
727 private function getDisplayTitle() {
728 $this->displaytitles = [];
729
730 $pageIds = array_keys( $this->titles );
731
732 if ( !count( $pageIds ) ) {
733 return;
734 }
735
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__ );
742
743 foreach ( $res as $row ) {
744 $this->displaytitles[$row->pp_page] = $row->pp_value;
745 }
746 }
747
752 private function getWatchedInfo() {
753 $user = $this->getUser();
754
755 if ( $user->isAnon() || count( $this->everything ) == 0
756 || !$user->isAllowed( 'viewmywatchlist' )
757 ) {
758 return;
759 }
760
761 $this->watched = [];
762 $this->notificationtimestamps = [];
763
764 $store = MediaWikiServices::getInstance()->getWatchedItemStore();
765 $timestamps = $store->getNotificationTimestampsBatch( $user, $this->everything );
766
767 if ( $this->fld_watched ) {
768 foreach ( $timestamps as $namespaceId => $dbKeys ) {
769 $this->watched[$namespaceId] = array_map(
770 function( $x ) {
771 return $x !== false;
772 },
773 $dbKeys
774 );
775 }
776 }
777 if ( $this->fld_notificationtimestamp ) {
778 $this->notificationtimestamps = $timestamps;
779 }
780 }
781
785 private function getWatcherInfo() {
786 if ( count( $this->everything ) == 0 ) {
787 return;
788 }
789
790 $user = $this->getUser();
791 $canUnwatchedpages = $user->isAllowed( 'unwatchedpages' );
792 $unwatchedPageThreshold = $this->getConfig()->get( 'UnwatchedPageThreshold' );
793 if ( !$canUnwatchedpages && !is_int( $unwatchedPageThreshold ) ) {
794 return;
795 }
796
797 $this->showZeroWatchers = $canUnwatchedpages;
798
799 $countOptions = [];
800 if ( !$canUnwatchedpages ) {
801 $countOptions['minimumWatchers'] = $unwatchedPageThreshold;
802 }
803
804 $this->watchers = MediaWikiServices::getInstance()->getWatchedItemStore()->countWatchersMultiple(
805 $this->everything,
806 $countOptions
807 );
808 }
809
816 private function getVisitingWatcherInfo() {
817 $config = $this->getConfig();
818 $user = $this->getUser();
819 $db = $this->getDB();
820
821 $canUnwatchedpages = $user->isAllowed( 'unwatchedpages' );
822 $unwatchedPageThreshold = $this->getConfig()->get( 'UnwatchedPageThreshold' );
823 if ( !$canUnwatchedpages && !is_int( $unwatchedPageThreshold ) ) {
824 return;
825 }
826
827 $this->showZeroWatchers = $canUnwatchedpages;
828
829 $titlesWithThresholds = [];
830 if ( $this->titles ) {
831 $lb = new LinkBatch( $this->titles );
832
833 // Fetch last edit timestamps for pages
834 $this->resetQueryParams();
835 $this->addTables( [ 'page', 'revision' ] );
836 $this->addFields( [ 'page_namespace', 'page_title', 'rev_timestamp' ] );
837 $this->addWhere( [
838 'page_latest = rev_id',
839 $lb->constructSet( 'page', $db ),
840 ] );
841 $this->addOption( 'GROUP BY', [ 'page_namespace', 'page_title' ] );
842 $timestampRes = $this->select( __METHOD__ );
843
844 $age = $config->get( 'WatchersMaxAge' );
845 $timestamps = [];
846 foreach ( $timestampRes as $row ) {
847 $revTimestamp = wfTimestamp( TS_UNIX, (int)$row->rev_timestamp );
848 $timestamps[$row->page_namespace][$row->page_title] = $revTimestamp - $age;
849 }
850 $titlesWithThresholds = array_map(
851 function( LinkTarget $target ) use ( $timestamps ) {
852 return [
853 $target, $timestamps[$target->getNamespace()][$target->getDBkey()]
854 ];
855 },
857 );
858 }
859
860 if ( $this->missing ) {
861 $titlesWithThresholds = array_merge(
862 $titlesWithThresholds,
863 array_map(
864 function( LinkTarget $target ) {
865 return [ $target, null ];
866 },
868 )
869 );
870 }
871 $store = MediaWikiServices::getInstance()->getWatchedItemStore();
872 $this->visitingwatchers = $store->countVisitingWatchersMultiple(
873 $titlesWithThresholds,
874 !$canUnwatchedpages ? $unwatchedPageThreshold : null
875 );
876 }
877
878 public function getCacheMode( $params ) {
879 // Other props depend on something about the current user
880 $publicProps = [
881 'protection',
882 'talkid',
883 'subjectid',
884 'url',
885 'preload',
886 'displaytitle',
887 ];
888 if ( array_diff( (array)$params['prop'], $publicProps ) ) {
889 return 'private';
890 }
891
892 // testactions also depends on the current user
893 if ( $params['testactions'] ) {
894 return 'private';
895 }
896
897 if ( !is_null( $params['token'] ) ) {
898 return 'private';
899 }
900
901 return 'public';
902 }
903
904 public function getAllowedParams() {
905 return [
906 'prop' => [
909 'protection',
910 'talkid',
911 'watched', # private
912 'watchers', # private
913 'visitingwatchers', # private
914 'notificationtimestamp', # private
915 'subjectid',
916 'url',
917 'readable', # private
918 'preload',
919 'displaytitle',
920 // If you add more properties here, please consider whether they
921 // need to be added to getCacheMode()
922 ],
924 ],
925 'testactions' => [
926 ApiBase::PARAM_TYPE => 'string',
928 ],
929 'token' => [
932 ApiBase::PARAM_TYPE => array_keys( $this->getTokenFunctions() )
933 ],
934 'continue' => [
935 ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
936 ],
937 ];
938 }
939
940 protected function getExamplesMessages() {
941 return [
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',
946 ];
947 }
948
949 public function getHelpUrls() {
950 return 'https://www.mediawiki.org/wiki/API:Info';
951 }
952}
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
wfExpandUrl( $url, $defaultProto=PROTO_CURRENT)
Expand a potentially local URL to a fully-qualified URL.
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
$wgUser
Definition Setup.php:806
const PARAM_DEPRECATED
(boolean) Is the parameter deprecated (will show a warning)?
Definition ApiBase.php:106
dieContinueUsageIf( $condition)
Die with the $prefix.
Definition ApiBase.php:2240
getMain()
Get the main module.
Definition ApiBase.php:480
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below.
Definition ApiBase.php:88
extractRequestParams( $parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition ApiBase.php:685
const PARAM_HELP_MSG_PER_VALUE
((string|array|Message)[]) When PARAM_TYPE is an array, this is an array mapping those values to $msg...
Definition ApiBase.php:157
setWarning( $warning)
Set warning section for this module.
Definition ApiBase.php:1554
const LIMIT_SML2
Slow query, apihighlimits limit.
Definition ApiBase.php:190
getResult()
Get the result object.
Definition ApiBase.php:584
const LIMIT_SML1
Slow query, standard limit.
Definition ApiBase.php:188
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
Definition ApiBase.php:125
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition ApiBase.php:53
lacksSameOriginSecurity()
Returns true if the current request breaks the same-origin policy.
Definition ApiBase.php:512
This is a base class for all Query modules.
setContinueEnumParameter( $paramName, $paramValue)
Set a query-continue value.
resetQueryParams()
Blank the internal arrays with query parameters.
addFields( $value)
Add a set of fields to select to the internal array.
addOption( $name, $value=null)
Add an option such as LIMIT or USE INDEX.
addTables( $tables, $alias=null)
Add a set of tables to the internal array.
getDB()
Get the Query database connection (read-only)
addWhereFld( $field, $value)
Equivalent to addWhere(array($field => $value))
getPageSet()
Get the PageSet object to work on.
addWhere( $value)
Add a set of WHERE clauses to the internal array.
A query module to show basic page information.
static resetTokenCache()
getTokenFunctions()
Get an array mapping token names to their handler functions.
getVisitingWatcherInfo()
Get the count of watchers who have visited recent edits and put it in $this->visitingwatchers.
getExamplesMessages()
Returns usage examples for this module.
static getUnblockToken( $pageid, $title)
static getWatchToken( $pageid, $title)
static getDeleteToken( $pageid, $title)
Title[] $titles
Title[] $everything
static getEditToken( $pageid, $title)
Title[] $missing
static getMoveToken( $pageid, $title)
static getEmailToken( $pageid, $title)
static getProtectToken( $pageid, $title)
getWatchedInfo()
Get information about watched status and put it in $this->watched and $this->notificationtimestamps.
__construct(ApiQuery $query, $moduleName)
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
static $cachedTokens
static getOptionsToken( $pageid, $title)
getProtectionInfo()
Get information about protections and put it in $protections.
static getBlockToken( $pageid, $title)
requestExtraData( $pageSet)
getWatcherInfo()
Get the count of watchers and put it in $this->watchers.
extractPageInfo( $pageid, $title)
Get a result array with information about a title.
getHelpUrls()
Return links to more detailed help pages about the module.
static getImportToken( $pageid, $title)
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
getTSIDs()
Get talk page IDs (if requested) and subject page IDs (if requested) and put them in $talkids and $su...
getCacheMode( $params)
Get the cache mode for the data generated by this module.
This is the main query class.
Definition ApiQuery.php:38
static setIndexedTagName(array &$arr, $tag)
Set the tag name for numeric-keyed values in XML format.
getUser()
Get the User object.
getConfig()
Get the Config object.
Class representing a list of titles The execute() method checks them all for existence and adds them ...
Definition LinkBatch.php:32
MediaWikiServices is the service locator for the application scope of MediaWiki.
Represents a title within MediaWiki.
Definition Title.php:36
We use the convention $dbr for read and $dbw for write to help you keep track of whether the database object is a the world will explode Or to be a subsequent write query which succeeded on the master may fail when replicated to the slave due to a unique key collision Replication on the slave will stop and it may take hours to repair the database and get it back online Setting read_only in my cnf on the slave will avoid this but given the dire we prefer to have as many checks as possible We provide a but the wrapper functions like select() and insert() are usually more convenient. They take care of things like table prefixes and escaping for you. If you really need to make your own SQL
$res
Definition database.txt:21
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the local content language as $wgContLang
Definition design.txt:57
when a variable name is used in a it is silently declared as a new local masking the global
Definition design.txt:95
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
const PROTO_CANONICAL
Definition Defines.php:227
const NS_FILE
Definition Defines.php:62
const PROTO_CURRENT
Definition Defines.php:226
the array() calling protocol came about after MediaWiki 1.4rc1.
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a local account $user
Definition hooks.txt:249
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetMagic':DEPRECATED! Use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language & $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetSpecialPageAliases':DEPRECATED! Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language & $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Associative array mapping language codes to prefixed links of the form "language:title". & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition hooks.txt:1937
namespace and then decline to actually register it file or subcat img or subcat $title
Definition hooks.txt:986
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object to manipulate or replace but no entry for that model exists in $wgContentHandlers if desired whether it is OK to use $contentModel on $title Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok inclusive $limit
Definition hooks.txt:1135
null for the local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify $query
Definition hooks.txt:1595
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition injection.txt:37
getNamespace()
Get the namespace index.
getDBkey()
Get the main part with underscores.
$source
const TS_ISO_8601
ISO 8601 format with no timezone: 1986-02-09T20:00:00Z.
Definition defines.php:28
const TS_UNIX
Unix time - the number of seconds since 1970-01-01 00:00:00 UTC.
Definition defines.php:6