4 * Created on Sep 25, 2006
6 * API for MediaWiki 1.8+
8 * Copyright © 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License along
21 * with this program; if not, write to the Free Software Foundation, Inc.,
22 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
23 * http://www.gnu.org/copyleft/gpl.html
26 if ( !defined( 'MEDIAWIKI' ) ) {
27 // Eclipse helper - will be ignored in production
28 require_once( 'ApiQueryBase.php' );
32 * A query module to show basic page information.
36 class ApiQueryInfo
extends ApiQueryBase
{
38 private $fld_protection = false, $fld_talkid = false,
39 $fld_subjectid = false, $fld_url = false,
40 $fld_readable = false, $fld_watched = false,
41 $fld_preload = false, $fld_displaytitle = false;
43 public function __construct( $query, $moduleName ) {
44 parent
::__construct( $query, $moduleName, 'in' );
47 public function requestExtraData( $pageSet ) {
48 $pageSet->requestField( 'page_restrictions' );
49 $pageSet->requestField( 'page_is_redirect' );
50 $pageSet->requestField( 'page_is_new' );
51 $pageSet->requestField( 'page_counter' );
52 $pageSet->requestField( 'page_touched' );
53 $pageSet->requestField( 'page_latest' );
54 $pageSet->requestField( 'page_len' );
58 * Get an array mapping token names to their handler functions.
59 * The prototype for a token function is func($pageid, $title)
60 * it should return a token or false (permission denied)
61 * @return array(tokenname => function)
63 protected function getTokenFunctions() {
64 // Don't call the hooks twice
65 if ( isset( $this->tokenFunctions
) ) {
66 return $this->tokenFunctions
;
69 // If we're in JSON callback mode, no tokens can be obtained
70 if ( !is_null( $this->getMain()->getRequest()->getVal( 'callback' ) ) ) {
74 $this->tokenFunctions
= array(
75 'edit' => array( 'ApiQueryInfo', 'getEditToken' ),
76 'delete' => array( 'ApiQueryInfo', 'getDeleteToken' ),
77 'protect' => array( 'ApiQueryInfo', 'getProtectToken' ),
78 'move' => array( 'ApiQueryInfo', 'getMoveToken' ),
79 'block' => array( 'ApiQueryInfo', 'getBlockToken' ),
80 'unblock' => array( 'ApiQueryInfo', 'getUnblockToken' ),
81 'email' => array( 'ApiQueryInfo', 'getEmailToken' ),
82 'import' => array( 'ApiQueryInfo', 'getImportToken' ),
84 wfRunHooks( 'APIQueryInfoTokens', array( &$this->tokenFunctions
) );
85 return $this->tokenFunctions
;
88 public static function getEditToken( $pageid, $title ) {
89 // We could check for $title->userCan('edit') here,
90 // but that's too expensive for this purpose
91 // and would break caching
93 if ( !$wgUser->isAllowed( 'edit' ) ) {
97 // The edit token is always the same, let's exploit that
98 static $cachedEditToken = null;
99 if ( !is_null( $cachedEditToken ) ) {
100 return $cachedEditToken;
103 $cachedEditToken = $wgUser->editToken();
104 return $cachedEditToken;
107 public static function getDeleteToken( $pageid, $title ) {
109 if ( !$wgUser->isAllowed( 'delete' ) ) {
113 static $cachedDeleteToken = null;
114 if ( !is_null( $cachedDeleteToken ) ) {
115 return $cachedDeleteToken;
118 $cachedDeleteToken = $wgUser->editToken();
119 return $cachedDeleteToken;
122 public static function getProtectToken( $pageid, $title ) {
124 if ( !$wgUser->isAllowed( 'protect' ) ) {
128 static $cachedProtectToken = null;
129 if ( !is_null( $cachedProtectToken ) ) {
130 return $cachedProtectToken;
133 $cachedProtectToken = $wgUser->editToken();
134 return $cachedProtectToken;
137 public static function getMoveToken( $pageid, $title ) {
139 if ( !$wgUser->isAllowed( 'move' ) ) {
143 static $cachedMoveToken = null;
144 if ( !is_null( $cachedMoveToken ) ) {
145 return $cachedMoveToken;
148 $cachedMoveToken = $wgUser->editToken();
149 return $cachedMoveToken;
152 public static function getBlockToken( $pageid, $title ) {
154 if ( !$wgUser->isAllowed( 'block' ) ) {
158 static $cachedBlockToken = null;
159 if ( !is_null( $cachedBlockToken ) ) {
160 return $cachedBlockToken;
163 $cachedBlockToken = $wgUser->editToken();
164 return $cachedBlockToken;
167 public static function getUnblockToken( $pageid, $title ) {
168 // Currently, this is exactly the same as the block token
169 return self
::getBlockToken( $pageid, $title );
172 public static function getEmailToken( $pageid, $title ) {
174 if ( !$wgUser->canSendEmail() ||
$wgUser->isBlockedFromEmailUser() ) {
178 static $cachedEmailToken = null;
179 if ( !is_null( $cachedEmailToken ) ) {
180 return $cachedEmailToken;
183 $cachedEmailToken = $wgUser->editToken();
184 return $cachedEmailToken;
187 public static function getImportToken( $pageid, $title ) {
189 if ( !$wgUser->isAllowed( 'import' ) ) {
193 static $cachedImportToken = null;
194 if ( !is_null( $cachedImportToken ) ) {
195 return $cachedImportToken;
198 $cachedImportToken = $wgUser->editToken();
199 return $cachedImportToken;
202 public function execute() {
203 $this->params
= $this->extractRequestParams();
204 if ( !is_null( $this->params
['prop'] ) ) {
205 $prop = array_flip( $this->params
['prop'] );
206 $this->fld_protection
= isset( $prop['protection'] );
207 $this->fld_watched
= isset( $prop['watched'] );
208 $this->fld_talkid
= isset( $prop['talkid'] );
209 $this->fld_subjectid
= isset( $prop['subjectid'] );
210 $this->fld_url
= isset( $prop['url'] );
211 $this->fld_readable
= isset( $prop['readable'] );
212 $this->fld_preload
= isset( $prop['preload'] );
213 $this->fld_displaytitle
= isset( $prop['displaytitle'] );
216 $pageSet = $this->getPageSet();
217 $this->titles
= $pageSet->getGoodTitles();
218 $this->missing
= $pageSet->getMissingTitles();
219 $this->everything
= $this->titles +
$this->missing
;
220 $result = $this->getResult();
222 uasort( $this->everything
, array( 'Title', 'compare' ) );
223 if ( !is_null( $this->params
['continue'] ) ) {
224 // Throw away any titles we're gonna skip so they don't
226 $cont = explode( '|', $this->params
['continue'] );
227 if ( count( $cont ) != 2 ) {
228 $this->dieUsage( 'Invalid continue param. You should pass the original ' .
229 'value returned by the previous query', '_badcontinue' );
231 $conttitle = Title
::makeTitleSafe( $cont[0], $cont[1] );
232 foreach ( $this->everything
as $pageid => $title ) {
233 if ( Title
::compare( $title, $conttitle ) >= 0 ) {
236 unset( $this->titles
[$pageid] );
237 unset( $this->missing
[$pageid] );
238 unset( $this->everything
[$pageid] );
242 $this->pageRestrictions
= $pageSet->getCustomField( 'page_restrictions' );
243 $this->pageIsRedir
= $pageSet->getCustomField( 'page_is_redirect' );
244 $this->pageIsNew
= $pageSet->getCustomField( 'page_is_new' );
245 $this->pageCounter
= $pageSet->getCustomField( 'page_counter' );
246 $this->pageTouched
= $pageSet->getCustomField( 'page_touched' );
247 $this->pageLatest
= $pageSet->getCustomField( 'page_latest' );
248 $this->pageLength
= $pageSet->getCustomField( 'page_len' );
250 // Get protection info if requested
251 if ( $this->fld_protection
) {
252 $this->getProtectionInfo();
255 if ( $this->fld_watched
) {
256 $this->getWatchedInfo();
259 // Run the talkid/subjectid query if requested
260 if ( $this->fld_talkid ||
$this->fld_subjectid
) {
264 if ( $this->fld_displaytitle
) {
265 $this->getDisplayTitle();
268 foreach ( $this->everything
as $pageid => $title ) {
269 $pageInfo = $this->extractPageInfo( $pageid, $title );
270 $fit = $result->addValue( array(
273 ), $pageid, $pageInfo );
275 $this->setContinueEnumParameter( 'continue',
276 $title->getNamespace() . '|' .
284 * Get a result array with information about a title
285 * @param $pageid int Page ID (negative for missing titles)
286 * @param $title Title object
289 private function extractPageInfo( $pageid, $title ) {
291 if ( $title->exists() ) {
292 $pageInfo['touched'] = wfTimestamp( TS_ISO_8601
, $this->pageTouched
[$pageid] );
293 $pageInfo['lastrevid'] = intval( $this->pageLatest
[$pageid] );
294 $pageInfo['counter'] = intval( $this->pageCounter
[$pageid] );
295 $pageInfo['length'] = intval( $this->pageLength
[$pageid] );
297 if ( $this->pageIsRedir
[$pageid] ) {
298 $pageInfo['redirect'] = '';
300 if ( $this->pageIsNew
[$pageid] ) {
301 $pageInfo['new'] = '';
305 if ( !is_null( $this->params
['token'] ) ) {
306 $tokenFunctions = $this->getTokenFunctions();
307 $pageInfo['starttimestamp'] = wfTimestamp( TS_ISO_8601
, time() );
308 foreach ( $this->params
['token'] as $t ) {
309 $val = call_user_func( $tokenFunctions[$t], $pageid, $title );
310 if ( $val === false ) {
311 $this->setWarning( "Action '$t' is not allowed for the current user" );
313 $pageInfo[$t . 'token'] = $val;
318 if ( $this->fld_protection
) {
319 $pageInfo['protection'] = array();
320 if ( isset( $this->protections
[$title->getNamespace()][$title->getDBkey()] ) ) {
321 $pageInfo['protection'] =
322 $this->protections
[$title->getNamespace()][$title->getDBkey()];
324 $this->getResult()->setIndexedTagName( $pageInfo['protection'], 'pr' );
327 if ( $this->fld_watched
&& isset( $this->watched
[$title->getNamespace()][$title->getDBkey()] ) ) {
328 $pageInfo['watched'] = '';
331 if ( $this->fld_talkid
&& isset( $this->talkids
[$title->getNamespace()][$title->getDBkey()] ) ) {
332 $pageInfo['talkid'] = $this->talkids
[$title->getNamespace()][$title->getDBkey()];
335 if ( $this->fld_subjectid
&& isset( $this->subjectids
[$title->getNamespace()][$title->getDBkey()] ) ) {
336 $pageInfo['subjectid'] = $this->subjectids
[$title->getNamespace()][$title->getDBkey()];
339 if ( $this->fld_url
) {
340 $pageInfo['fullurl'] = $title->getFullURL();
341 $pageInfo['editurl'] = $title->getFullURL( 'action=edit' );
343 if ( $this->fld_readable
&& $title->userCanRead() ) {
344 $pageInfo['readable'] = '';
347 if ( $this->fld_preload
) {
348 if ( $title->exists() ) {
349 $pageInfo['preload'] = '';
352 wfRunHooks( 'EditFormPreloadText', array( &$text, &$title ) );
354 $pageInfo['preload'] = $text;
358 if ( $this->fld_displaytitle
) {
359 if ( isset( $this->displaytitles
[$title->getArticleId()] ) ) {
360 $pageInfo['displaytitle'] = $this->displaytitles
[$title->getArticleId()];
362 $pageInfo['displaytitle'] = $title->getPrefixedText();
370 * Get information about protections and put it in $protections
372 private function getProtectionInfo() {
373 $this->protections
= array();
374 $db = $this->getDB();
376 // Get normal protections for existing titles
377 if ( count( $this->titles
) ) {
378 $this->resetQueryParams();
379 $this->addTables( array( 'page_restrictions', 'page' ) );
380 $this->addWhere( 'page_id=pr_page' );
381 $this->addFields( array( 'pr_page', 'pr_type', 'pr_level',
382 'pr_expiry', 'pr_cascade', 'page_namespace',
384 $this->addWhereFld( 'pr_page', array_keys( $this->titles
) );
386 $res = $this->select( __METHOD__
);
387 foreach ( $res as $row ) {
389 'type' => $row->pr_type
,
390 'level' => $row->pr_level
,
391 'expiry' => Block
::decodeExpiry( $row->pr_expiry
, TS_ISO_8601
)
393 if ( $row->pr_cascade
) {
396 $this->protections
[$row->page_namespace
][$row->page_title
][] = $a;
398 // Also check old restrictions
399 if ( $this->pageRestrictions
[$row->pr_page
] ) {
400 $restrictions = explode( ':', trim( $this->pageRestrictions
[$row->pr_page
] ) );
401 foreach ( $restrictions as $restrict ) {
402 $temp = explode( '=', trim( $restrict ) );
403 if ( count( $temp ) == 1 ) {
404 // old old format should be treated as edit/move restriction
405 $restriction = trim( $temp[0] );
407 if ( $restriction == '' ) {
410 $this->protections
[$row->page_namespace
][$row->page_title
][] = array(
412 'level' => $restriction,
413 'expiry' => 'infinity',
415 $this->protections
[$row->page_namespace
][$row->page_title
][] = array(
417 'level' => $restriction,
418 'expiry' => 'infinity',
421 $restriction = trim( $temp[1] );
422 if ( $restriction == '' ) {
425 $this->protections
[$row->page_namespace
][$row->page_title
][] = array(
427 'level' => $restriction,
428 'expiry' => 'infinity',
436 // Get protections for missing titles
437 if ( count( $this->missing
) ) {
438 $this->resetQueryParams();
439 $lb = new LinkBatch( $this->missing
);
440 $this->addTables( 'protected_titles' );
441 $this->addFields( array( 'pt_title', 'pt_namespace', 'pt_create_perm', 'pt_expiry' ) );
442 $this->addWhere( $lb->constructSet( 'pt', $db ) );
443 $res = $this->select( __METHOD__
);
444 foreach ( $res as $row ) {
445 $this->protections
[$row->pt_namespace
][$row->pt_title
][] = array(
447 'level' => $row->pt_create_perm
,
448 'expiry' => Block
::decodeExpiry( $row->pt_expiry
, TS_ISO_8601
)
453 // Cascading protections
454 $images = $others = array();
455 foreach ( $this->everything
as $title ) {
456 if ( $title->getNamespace() == NS_FILE
) {
457 $images[] = $title->getDBkey();
463 if ( count( $others ) ) {
464 // Non-images: check templatelinks
465 $lb = new LinkBatch( $others );
466 $this->resetQueryParams();
467 $this->addTables( array( 'page_restrictions', 'page', 'templatelinks' ) );
468 $this->addFields( array( 'pr_type', 'pr_level', 'pr_expiry',
469 'page_title', 'page_namespace',
470 'tl_title', 'tl_namespace' ) );
471 $this->addWhere( $lb->constructSet( 'tl', $db ) );
472 $this->addWhere( 'pr_page = page_id' );
473 $this->addWhere( 'pr_page = tl_from' );
474 $this->addWhereFld( 'pr_cascade', 1 );
476 $res = $this->select( __METHOD__
);
477 foreach ( $res as $row ) {
478 $source = Title
::makeTitle( $row->page_namespace
, $row->page_title
);
479 $this->protections
[$row->tl_namespace
][$row->tl_title
][] = array(
480 'type' => $row->pr_type
,
481 'level' => $row->pr_level
,
482 'expiry' => Block
::decodeExpiry( $row->pr_expiry
, TS_ISO_8601
),
483 'source' => $source->getPrefixedText()
488 if ( count( $images ) ) {
489 // Images: check imagelinks
490 $this->resetQueryParams();
491 $this->addTables( array( 'page_restrictions', 'page', 'imagelinks' ) );
492 $this->addFields( array( 'pr_type', 'pr_level', 'pr_expiry',
493 'page_title', 'page_namespace', 'il_to' ) );
494 $this->addWhere( 'pr_page = page_id' );
495 $this->addWhere( 'pr_page = il_from' );
496 $this->addWhereFld( 'pr_cascade', 1 );
497 $this->addWhereFld( 'il_to', $images );
499 $res = $this->select( __METHOD__
);
500 foreach ( $res as $row ) {
501 $source = Title
::makeTitle( $row->page_namespace
, $row->page_title
);
502 $this->protections
[NS_FILE
][$row->il_to
][] = array(
503 'type' => $row->pr_type
,
504 'level' => $row->pr_level
,
505 'expiry' => Block
::decodeExpiry( $row->pr_expiry
, TS_ISO_8601
),
506 'source' => $source->getPrefixedText()
513 * Get talk page IDs (if requested) and subject page IDs (if requested)
514 * and put them in $talkids and $subjectids
516 private function getTSIDs() {
517 $getTitles = $this->talkids
= $this->subjectids
= array();
519 foreach ( $this->everything
as $t ) {
520 if ( MWNamespace
::isTalk( $t->getNamespace() ) ) {
521 if ( $this->fld_subjectid
) {
522 $getTitles[] = $t->getSubjectPage();
524 } elseif ( $this->fld_talkid
) {
525 $getTitles[] = $t->getTalkPage();
528 if ( !count( $getTitles ) ) {
532 $db = $this->getDB();
534 // Construct a custom WHERE clause that matches
535 // all titles in $getTitles
536 $lb = new LinkBatch( $getTitles );
537 $this->resetQueryParams();
538 $this->addTables( 'page' );
539 $this->addFields( array( 'page_title', 'page_namespace', 'page_id' ) );
540 $this->addWhere( $lb->constructSet( 'page', $db ) );
541 $res = $this->select( __METHOD__
);
542 foreach ( $res as $row ) {
543 if ( MWNamespace
::isTalk( $row->page_namespace
) ) {
544 $this->talkids
[MWNamespace
::getSubject( $row->page_namespace
)][$row->page_title
] =
545 intval( $row->page_id
);
547 $this->subjectids
[MWNamespace
::getTalk( $row->page_namespace
)][$row->page_title
] =
548 intval( $row->page_id
);
553 private function getDisplayTitle() {
554 $this->displaytitles
= array();
556 $pageIds = array_keys( $this->titles
);
558 if ( !count( $pageIds ) ) {
562 $this->resetQueryParams();
563 $this->addTables( 'page_props' );
564 $this->addFields( array( 'pp_page', 'pp_value' ) );
565 $this->addWhereFld( 'pp_page', $pageIds );
566 $this->addWhereFld( 'pp_propname', 'displaytitle' );
567 $res = $this->select( __METHOD__
);
569 foreach ( $res as $row ) {
570 $this->displaytitles
[$row->pp_page
] = $row->pp_value
;
575 * Get information about watched status and put it in $this->watched
577 private function getWatchedInfo() {
580 if ( $wgUser->isAnon() ||
count( $this->titles
) == 0 ) {
584 $this->watched
= array();
585 $db = $this->getDB();
587 $lb = new LinkBatch( $this->titles
);
589 $this->resetQueryParams();
590 $this->addTables( array( 'page', 'watchlist' ) );
591 $this->addFields( array( 'page_title', 'page_namespace' ) );
592 $this->addWhere( array(
593 $lb->constructSet( 'page', $db ),
594 'wl_namespace=page_namespace',
595 'wl_title=page_title',
596 'wl_user' => $wgUser->getID()
599 $res = $this->select( __METHOD__
);
601 foreach ( $res as $row ) {
602 $this->watched
[$row->page_namespace
][$row->page_title
] = true;
606 public function getCacheMode( $params ) {
607 $publicProps = array(
615 if ( !is_null( $params['prop'] ) ) {
616 foreach ( $params['prop'] as $prop ) {
617 if ( !in_array( $prop, $publicProps ) ) {
622 if ( !is_null( $params['token'] ) ) {
628 public function getAllowedParams() {
631 ApiBase
::PARAM_DFLT
=> null,
632 ApiBase
::PARAM_ISMULTI
=> true,
633 ApiBase
::PARAM_TYPE
=> array(
639 'readable', # private
642 // If you add more properties here, please consider whether they
643 // need to be added to getCacheMode()
646 ApiBase
::PARAM_DFLT
=> null,
647 ApiBase
::PARAM_ISMULTI
=> true,
648 ApiBase
::PARAM_TYPE
=> array_keys( $this->getTokenFunctions() )
654 public function getParamDescription() {
657 'Which additional properties to get:',
658 ' protection - List the protection level of each page',
659 ' talkid - The page ID of the talk page for each non-talk page',
660 ' watched - List the watched status of each page',
661 ' subjectid - The page ID of the parent page for each talk page',
662 ' url - Gives a full URL to the page, and also an edit URL',
663 ' readable - Whether the user can read this page',
664 ' preload - Gives the text returned by EditFormPreloadText',
665 ' displaytitle - Gives the way the page title is actually displayed',
667 'token' => 'Request a token to perform a data-modifying action on a page',
668 'continue' => 'When more results are available, use this to continue',
672 public function getDescription() {
673 return 'Get basic page information such as namespace, title, last touched date, ...';
676 public function getPossibleErrors() {
677 return array_merge( parent
::getPossibleErrors(), array(
678 array( 'code' => '_badcontinue', 'info' => 'Invalid continue param. You should pass the original value returned by the previous query' ),
682 protected function getExamples() {
684 'api.php?action=query&prop=info&titles=Main%20Page',
685 'api.php?action=query&prop=info&inprop=protection&titles=Main%20Page'
689 public function getVersion() {
690 return __CLASS__
. ': $Id$';