Move some braces
[lhc/web/wiklou.git] / includes / api / ApiQueryInfo.php
1 <?php
2
3 /**
4 * Created on Sep 25, 2006
5 *
6 * API for MediaWiki 1.8+
7 *
8 * Copyright © 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
9 *
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.
14 *
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.
19 *
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 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
23 * http://www.gnu.org/copyleft/gpl.html
24 */
25
26 if ( !defined( 'MEDIAWIKI' ) ) {
27 // Eclipse helper - will be ignored in production
28 require_once( 'ApiQueryBase.php' );
29 }
30
31 /**
32 * A query module to show basic page information.
33 *
34 * @ingroup API
35 */
36 class ApiQueryInfo extends ApiQueryBase {
37
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;
42
43 public function __construct( $query, $moduleName ) {
44 parent::__construct( $query, $moduleName, 'in' );
45 }
46
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' );
55 }
56
57 /**
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)
62 */
63 protected function getTokenFunctions() {
64 // Don't call the hooks twice
65 if ( isset( $this->tokenFunctions ) ) {
66 return $this->tokenFunctions;
67 }
68
69 // If we're in JSON callback mode, no tokens can be obtained
70 if ( !is_null( $this->getMain()->getRequest()->getVal( 'callback' ) ) ) {
71 return array();
72 }
73
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' ),
83 );
84 wfRunHooks( 'APIQueryInfoTokens', array( &$this->tokenFunctions ) );
85 return $this->tokenFunctions;
86 }
87
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
92 global $wgUser;
93 if ( !$wgUser->isAllowed( 'edit' ) ) {
94 return false;
95 }
96
97 // The edit token is always the same, let's exploit that
98 static $cachedEditToken = null;
99 if ( !is_null( $cachedEditToken ) ) {
100 return $cachedEditToken;
101 }
102
103 $cachedEditToken = $wgUser->editToken();
104 return $cachedEditToken;
105 }
106
107 public static function getDeleteToken( $pageid, $title ) {
108 global $wgUser;
109 if ( !$wgUser->isAllowed( 'delete' ) ) {
110 return false;
111 }
112
113 static $cachedDeleteToken = null;
114 if ( !is_null( $cachedDeleteToken ) ) {
115 return $cachedDeleteToken;
116 }
117
118 $cachedDeleteToken = $wgUser->editToken();
119 return $cachedDeleteToken;
120 }
121
122 public static function getProtectToken( $pageid, $title ) {
123 global $wgUser;
124 if ( !$wgUser->isAllowed( 'protect' ) ) {
125 return false;
126 }
127
128 static $cachedProtectToken = null;
129 if ( !is_null( $cachedProtectToken ) ) {
130 return $cachedProtectToken;
131 }
132
133 $cachedProtectToken = $wgUser->editToken();
134 return $cachedProtectToken;
135 }
136
137 public static function getMoveToken( $pageid, $title ) {
138 global $wgUser;
139 if ( !$wgUser->isAllowed( 'move' ) ) {
140 return false;
141 }
142
143 static $cachedMoveToken = null;
144 if ( !is_null( $cachedMoveToken ) ) {
145 return $cachedMoveToken;
146 }
147
148 $cachedMoveToken = $wgUser->editToken();
149 return $cachedMoveToken;
150 }
151
152 public static function getBlockToken( $pageid, $title ) {
153 global $wgUser;
154 if ( !$wgUser->isAllowed( 'block' ) ) {
155 return false;
156 }
157
158 static $cachedBlockToken = null;
159 if ( !is_null( $cachedBlockToken ) ) {
160 return $cachedBlockToken;
161 }
162
163 $cachedBlockToken = $wgUser->editToken();
164 return $cachedBlockToken;
165 }
166
167 public static function getUnblockToken( $pageid, $title ) {
168 // Currently, this is exactly the same as the block token
169 return self::getBlockToken( $pageid, $title );
170 }
171
172 public static function getEmailToken( $pageid, $title ) {
173 global $wgUser;
174 if ( !$wgUser->canSendEmail() || $wgUser->isBlockedFromEmailUser() ) {
175 return false;
176 }
177
178 static $cachedEmailToken = null;
179 if ( !is_null( $cachedEmailToken ) ) {
180 return $cachedEmailToken;
181 }
182
183 $cachedEmailToken = $wgUser->editToken();
184 return $cachedEmailToken;
185 }
186
187 public static function getImportToken( $pageid, $title ) {
188 global $wgUser;
189 if ( !$wgUser->isAllowed( 'import' ) ) {
190 return false;
191 }
192
193 static $cachedImportToken = null;
194 if ( !is_null( $cachedImportToken ) ) {
195 return $cachedImportToken;
196 }
197
198 $cachedImportToken = $wgUser->editToken();
199 return $cachedImportToken;
200 }
201
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 }
214
215 $pageSet = $this->getPageSet();
216 $this->titles = $pageSet->getGoodTitles();
217 $this->missing = $pageSet->getMissingTitles();
218 $this->everything = $this->titles + $this->missing;
219 $result = $this->getResult();
220
221 uasort( $this->everything, array( 'Title', 'compare' ) );
222 if ( !is_null( $this->params['continue'] ) ) {
223 // Throw away any titles we're gonna skip so they don't
224 // clutter queries
225 $cont = explode( '|', $this->params['continue'] );
226 if ( count( $cont ) != 2 ) {
227 $this->dieUsage( 'Invalid continue param. You should pass the original ' .
228 'value returned by the previous query', '_badcontinue' );
229 }
230 $conttitle = Title::makeTitleSafe( $cont[0], $cont[1] );
231 foreach ( $this->everything as $pageid => $title ) {
232 if ( Title::compare( $title, $conttitle ) >= 0 ) {
233 break;
234 }
235 unset( $this->titles[$pageid] );
236 unset( $this->missing[$pageid] );
237 unset( $this->everything[$pageid] );
238 }
239 }
240
241 $this->pageRestrictions = $pageSet->getCustomField( 'page_restrictions' );
242 $this->pageIsRedir = $pageSet->getCustomField( 'page_is_redirect' );
243 $this->pageIsNew = $pageSet->getCustomField( 'page_is_new' );
244 $this->pageCounter = $pageSet->getCustomField( 'page_counter' );
245 $this->pageTouched = $pageSet->getCustomField( 'page_touched' );
246 $this->pageLatest = $pageSet->getCustomField( 'page_latest' );
247 $this->pageLength = $pageSet->getCustomField( 'page_len' );
248
249 $db = $this->getDB();
250 // Get protection info if requested
251 if ( $this->fld_protection ) {
252 $this->getProtectionInfo();
253 }
254
255 if ( $this->fld_watched ) {
256 $this->getWatchedInfo();
257 }
258
259 // Run the talkid/subjectid query if requested
260 if ( $this->fld_talkid || $this->fld_subjectid ) {
261 $this->getTSIDs();
262 }
263
264 foreach ( $this->everything as $pageid => $title ) {
265 $pageInfo = $this->extractPageInfo( $pageid, $title );
266 $fit = $result->addValue( array(
267 'query',
268 'pages'
269 ), $pageid, $pageInfo );
270 if ( !$fit ) {
271 $this->setContinueEnumParameter( 'continue',
272 $title->getNamespace() . '|' .
273 $title->getText() );
274 break;
275 }
276 }
277 }
278
279 /**
280 * Get a result array with information about a title
281 * @param $pageid int Page ID (negative for missing titles)
282 * @param $title Title object
283 * @return array
284 */
285 private function extractPageInfo( $pageid, $title ) {
286 $pageInfo = array();
287 if ( $title->exists() ) {
288 $pageInfo['touched'] = wfTimestamp( TS_ISO_8601, $this->pageTouched[$pageid] );
289 $pageInfo['lastrevid'] = intval( $this->pageLatest[$pageid] );
290 $pageInfo['counter'] = intval( $this->pageCounter[$pageid] );
291 $pageInfo['length'] = intval( $this->pageLength[$pageid] );
292 if ( $this->pageIsRedir[$pageid] ) {
293 $pageInfo['redirect'] = '';
294 }
295 if ( $this->pageIsNew[$pageid] ) {
296 $pageInfo['new'] = '';
297 }
298 }
299
300 if ( !is_null( $this->params['token'] ) ) {
301 $tokenFunctions = $this->getTokenFunctions();
302 $pageInfo['starttimestamp'] = wfTimestamp( TS_ISO_8601, time() );
303 foreach ( $this->params['token'] as $t ) {
304 $val = call_user_func( $tokenFunctions[$t], $pageid, $title );
305 if ( $val === false ) {
306 $this->setWarning( "Action '$t' is not allowed for the current user" );
307 } else {
308 $pageInfo[$t . 'token'] = $val;
309 }
310 }
311 }
312
313 if ( $this->fld_protection ) {
314 $pageInfo['protection'] = array();
315 if ( isset( $this->protections[$title->getNamespace()][$title->getDBkey()] ) ) {
316 $pageInfo['protection'] =
317 $this->protections[$title->getNamespace()][$title->getDBkey()];
318 }
319 $this->getResult()->setIndexedTagName( $pageInfo['protection'], 'pr' );
320 }
321
322 if ( $this->fld_watched && isset( $this->watched[$title->getNamespace()][$title->getDBkey()] ) ) {
323 $pageInfo['watched'] = '';
324 }
325
326 if ( $this->fld_talkid && isset( $this->talkids[$title->getNamespace()][$title->getDBkey()] ) ) {
327 $pageInfo['talkid'] = $this->talkids[$title->getNamespace()][$title->getDBkey()];
328 }
329
330 if ( $this->fld_subjectid && isset( $this->subjectids[$title->getNamespace()][$title->getDBkey()] ) ) {
331 $pageInfo['subjectid'] = $this->subjectids[$title->getNamespace()][$title->getDBkey()];
332 }
333
334 if ( $this->fld_url ) {
335 $pageInfo['fullurl'] = $title->getFullURL();
336 $pageInfo['editurl'] = $title->getFullURL( 'action=edit' );
337 }
338 if ( $this->fld_readable && $title->userCanRead() ) {
339 $pageInfo['readable'] = '';
340 }
341
342 if ( $this->fld_preload ) {
343 if ( $title->exists() ) {
344 $pageInfo['preload'] = '';
345 } else {
346 wfRunHooks( 'EditFormPreloadText', array( &$text, &$title ) );
347
348 $pageInfo['preload'] = $text;
349 }
350 }
351 return $pageInfo;
352 }
353
354 /**
355 * Get information about protections and put it in $protections
356 */
357 private function getProtectionInfo() {
358 $this->protections = array();
359 $db = $this->getDB();
360
361 // Get normal protections for existing titles
362 if ( count( $this->titles ) ) {
363 $this->resetQueryParams();
364 $this->addTables( array( 'page_restrictions', 'page' ) );
365 $this->addWhere( 'page_id=pr_page' );
366 $this->addFields( array( 'pr_page', 'pr_type', 'pr_level',
367 'pr_expiry', 'pr_cascade', 'page_namespace',
368 'page_title' ) );
369 $this->addWhereFld( 'pr_page', array_keys( $this->titles ) );
370
371 $res = $this->select( __METHOD__ );
372 while ( $row = $db->fetchObject( $res ) ) {
373 $a = array(
374 'type' => $row->pr_type,
375 'level' => $row->pr_level,
376 'expiry' => Block::decodeExpiry( $row->pr_expiry, TS_ISO_8601 )
377 );
378 if ( $row->pr_cascade ) {
379 $a['cascade'] = '';
380 }
381 $this->protections[$row->page_namespace][$row->page_title][] = $a;
382
383 // Also check old restrictions
384 if ( $this->pageRestrictions[$row->pr_page] ) {
385 $restrictions = explode( ':', trim( $this->pageRestrictions[$row->pr_page] ) );
386 foreach ( $restrictions as $restrict ) {
387 $temp = explode( '=', trim( $restrict ) );
388 if ( count( $temp ) == 1 ) {
389 // old old format should be treated as edit/move restriction
390 $restriction = trim( $temp[0] );
391
392 if ( $restriction == '' ) {
393 continue;
394 }
395 $this->protections[$row->page_namespace][$row->page_title][] = array(
396 'type' => 'edit',
397 'level' => $restriction,
398 'expiry' => 'infinity',
399 );
400 $this->protections[$row->page_namespace][$row->page_title][] = array(
401 'type' => 'move',
402 'level' => $restriction,
403 'expiry' => 'infinity',
404 );
405 } else {
406 $restriction = trim( $temp[1] );
407 if ( $restriction == '' ) {
408 continue;
409 }
410 $this->protections[$row->page_namespace][$row->page_title][] = array(
411 'type' => $temp[0],
412 'level' => $restriction,
413 'expiry' => 'infinity',
414 );
415 }
416 }
417 }
418 }
419 $db->freeResult( $res );
420 }
421
422 // Get protections for missing titles
423 if ( count( $this->missing ) ) {
424 $this->resetQueryParams();
425 $lb = new LinkBatch( $this->missing );
426 $this->addTables( 'protected_titles' );
427 $this->addFields( array( 'pt_title', 'pt_namespace', 'pt_create_perm', 'pt_expiry' ) );
428 $this->addWhere( $lb->constructSet( 'pt', $db ) );
429 $res = $this->select( __METHOD__ );
430 while ( $row = $db->fetchObject( $res ) ) {
431 $this->protections[$row->pt_namespace][$row->pt_title][] = array(
432 'type' => 'create',
433 'level' => $row->pt_create_perm,
434 'expiry' => Block::decodeExpiry( $row->pt_expiry, TS_ISO_8601 )
435 );
436 }
437 $db->freeResult( $res );
438 }
439
440 // Cascading protections
441 $images = $others = array();
442 foreach ( $this->everything as $title ) {
443 if ( $title->getNamespace() == NS_FILE ) {
444 $images[] = $title->getDBkey();
445 } else {
446 $others[] = $title;
447 }
448 }
449
450 if ( count( $others ) ) {
451 // Non-images: check templatelinks
452 $lb = new LinkBatch( $others );
453 $this->resetQueryParams();
454 $this->addTables( array( 'page_restrictions', 'page', 'templatelinks' ) );
455 $this->addFields( array( 'pr_type', 'pr_level', 'pr_expiry',
456 'page_title', 'page_namespace',
457 'tl_title', 'tl_namespace' ) );
458 $this->addWhere( $lb->constructSet( 'tl', $db ) );
459 $this->addWhere( 'pr_page = page_id' );
460 $this->addWhere( 'pr_page = tl_from' );
461 $this->addWhereFld( 'pr_cascade', 1 );
462
463 $res = $this->select( __METHOD__ );
464 while ( $row = $db->fetchObject( $res ) ) {
465 $source = Title::makeTitle( $row->page_namespace, $row->page_title );
466 $this->protections[$row->tl_namespace][$row->tl_title][] = array(
467 'type' => $row->pr_type,
468 'level' => $row->pr_level,
469 'expiry' => Block::decodeExpiry( $row->pr_expiry, TS_ISO_8601 ),
470 'source' => $source->getPrefixedText()
471 );
472 }
473 $db->freeResult( $res );
474 }
475
476 if ( count( $images ) ) {
477 // Images: check imagelinks
478 $this->resetQueryParams();
479 $this->addTables( array( 'page_restrictions', 'page', 'imagelinks' ) );
480 $this->addFields( array( 'pr_type', 'pr_level', 'pr_expiry',
481 'page_title', 'page_namespace', 'il_to' ) );
482 $this->addWhere( 'pr_page = page_id' );
483 $this->addWhere( 'pr_page = il_from' );
484 $this->addWhereFld( 'pr_cascade', 1 );
485 $this->addWhereFld( 'il_to', $images );
486
487 $res = $this->select( __METHOD__ );
488 while ( $row = $db->fetchObject( $res ) ) {
489 $source = Title::makeTitle( $row->page_namespace, $row->page_title );
490 $this->protections[NS_FILE][$row->il_to][] = array(
491 'type' => $row->pr_type,
492 'level' => $row->pr_level,
493 'expiry' => Block::decodeExpiry( $row->pr_expiry, TS_ISO_8601 ),
494 'source' => $source->getPrefixedText()
495 );
496 }
497 $db->freeResult( $res );
498 }
499 }
500
501 /**
502 * Get talk page IDs (if requested) and subject page IDs (if requested)
503 * and put them in $talkids and $subjectids
504 */
505 private function getTSIDs() {
506 $getTitles = $this->talkids = $this->subjectids = array();
507 $db = $this->getDB();
508 foreach ( $this->everything as $t ) {
509 if ( MWNamespace::isTalk( $t->getNamespace() ) ) {
510 if ( $this->fld_subjectid ) {
511 $getTitles[] = $t->getSubjectPage();
512 }
513 } elseif ( $this->fld_talkid ) {
514 $getTitles[] = $t->getTalkPage();
515 }
516 }
517 if ( !count( $getTitles ) ) {
518 return;
519 }
520
521 // Construct a custom WHERE clause that matches
522 // all titles in $getTitles
523 $lb = new LinkBatch( $getTitles );
524 $this->resetQueryParams();
525 $this->addTables( 'page' );
526 $this->addFields( array( 'page_title', 'page_namespace', 'page_id' ) );
527 $this->addWhere( $lb->constructSet( 'page', $db ) );
528 $res = $this->select( __METHOD__ );
529 while ( $row = $db->fetchObject( $res ) ) {
530 if ( MWNamespace::isTalk( $row->page_namespace ) ) {
531 $this->talkids[MWNamespace::getSubject( $row->page_namespace )][$row->page_title] =
532 intval( $row->page_id );
533 } else {
534 $this->subjectids[MWNamespace::getTalk( $row->page_namespace )][$row->page_title] =
535 intval( $row->page_id );
536 }
537 }
538 }
539
540 /**
541 * Get information about watched status and put it in $watched
542 */
543 private function getWatchedInfo() {
544 global $wgUser;
545
546 if ( $wgUser->isAnon() || count( $this->titles ) == 0 ) {
547 return;
548 }
549
550 $this->watched = array();
551 $db = $this->getDB();
552
553 $lb = new LinkBatch( $this->titles );
554
555 $this->resetQueryParams();
556 $this->addTables( array( 'page', 'watchlist' ) );
557 $this->addFields( array( 'page_title', 'page_namespace' ) );
558 $this->addWhere( array(
559 $lb->constructSet( 'page', $db ),
560 'wl_namespace=page_namespace',
561 'wl_title=page_title',
562 'wl_user' => $wgUser->getID()
563 ) );
564
565 $res = $this->select( __METHOD__ );
566
567 while ( $row = $db->fetchObject( $res ) ) {
568 $this->watched[$row->page_namespace][$row->page_title] = true;
569 }
570 }
571
572 public function getAllowedParams() {
573 return array(
574 'prop' => array(
575 ApiBase::PARAM_DFLT => null,
576 ApiBase::PARAM_ISMULTI => true,
577 ApiBase::PARAM_TYPE => array(
578 'protection',
579 'talkid',
580 'watched',
581 'subjectid',
582 'url',
583 'readable',
584 'preload'
585 ) ),
586 'token' => array(
587 ApiBase::PARAM_DFLT => null,
588 ApiBase::PARAM_ISMULTI => true,
589 ApiBase::PARAM_TYPE => array_keys( $this->getTokenFunctions() )
590 ),
591 'continue' => null,
592 );
593 }
594
595 public function getParamDescription() {
596 return array(
597 'prop' => array(
598 'Which additional properties to get:',
599 ' protection - List the protection level of each page',
600 ' talkid - The page ID of the talk page for each non-talk page',
601 ' watched - List the watched status of each page',
602 ' subjectid - The page ID of the parent page for each talk page',
603 ' url - Gives a full URL to the page, and also an edit URL',
604 ' readable - Whether the user can read this page',
605 ' preload - Gives the text returned by EditFormPreloadText'
606 ),
607 'token' => 'Request a token to perform a data-modifying action on a page',
608 'continue' => 'When more results are available, use this to continue',
609 );
610 }
611
612 public function getDescription() {
613 return 'Get basic page information such as namespace, title, last touched date, ...';
614 }
615
616 public function getPossibleErrors() {
617 return array_merge( parent::getPossibleErrors(), array(
618 array( 'code' => '_badcontinue', 'info' => 'Invalid continue param. You should pass the original value returned by the previous query' ),
619 ) );
620 }
621
622 protected function getExamples() {
623 return array(
624 'api.php?action=query&prop=info&titles=Main%20Page',
625 'api.php?action=query&prop=info&inprop=protection&titles=Main%20Page'
626 );
627 }
628
629 public function getVersion() {
630 return __CLASS__ . ': $Id$';
631 }
632 }