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  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 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, $fld_displaytitle = 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                         $this->fld_displaytitle = isset( $prop['displaytitle'] );
 214                 }
 215
 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();
 221
 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
 225                         // clutter queries
 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' );
 230                         }
 231                         $conttitle = Title::makeTitleSafe( $cont[0], $cont[1] );
 232                         foreach ( $this->everything as $pageid => $title ) {
 233                                 if ( Title::compare( $title, $conttitle ) >= 0 ) {
 234                                         break;
 235                                 }
 236                                 unset( $this->titles[$pageid] );
 237                                 unset( $this->missing[$pageid] );
 238                                 unset( $this->everything[$pageid] );
 239                         }
 240                 }
 241
 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' );
 249
 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                 if ( $this->fld_displaytitle ) {
 265                         $this->getDisplayTitle();
 266                 }
 267
 268                 foreach ( $this->everything as $pageid => $title ) {
 269                         $pageInfo = $this->extractPageInfo( $pageid, $title );
 270                         $fit = $result->addValue( array(
 271                                 'query',
 272                                 'pages'
 273                         ), $pageid, $pageInfo );
 274                         if ( !$fit ) {
 275                                 $this->setContinueEnumParameter( 'continue',
 276                                                 $title->getNamespace() . '|' .
 277                                                 $title->getText() );
 278                                 break;
 279                         }
 280                 }
 281         }
 282
 283         /**
 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
 287          * @return array
 288          */
 289         private function extractPageInfo( $pageid, $title ) {
 290                 $pageInfo = array();
 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] );
 296
 297                         if ( $this->pageIsRedir[$pageid] ) {
 298                                 $pageInfo['redirect'] = '';
 299                         }
 300                         if ( $this->pageIsNew[$pageid] ) {
 301                                 $pageInfo['new'] = '';
 302                         }
 303                 }
 304
 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" );
 312                                 } else {
 313                                         $pageInfo[$t . 'token'] = $val;
 314                                 }
 315                         }
 316                 }
 317
 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()];
 323                         }
 324                         $this->getResult()->setIndexedTagName( $pageInfo['protection'], 'pr' );
 325                 }
 326
 327                 if ( $this->fld_watched && isset( $this->watched[$title->getNamespace()][$title->getDBkey()] ) ) {
 328                         $pageInfo['watched'] = '';
 329                 }
 330
 331                 if ( $this->fld_talkid && isset( $this->talkids[$title->getNamespace()][$title->getDBkey()] ) ) {
 332                         $pageInfo['talkid'] = $this->talkids[$title->getNamespace()][$title->getDBkey()];
 333                 }
 334
 335                 if ( $this->fld_subjectid && isset( $this->subjectids[$title->getNamespace()][$title->getDBkey()] ) ) {
 336                         $pageInfo['subjectid'] = $this->subjectids[$title->getNamespace()][$title->getDBkey()];
 337                 }
 338
 339                 if ( $this->fld_url ) {
 340                         $pageInfo['fullurl'] = $title->getFullURL();
 341                         $pageInfo['editurl'] = $title->getFullURL( 'action=edit' );
 342                 }
 343                 if ( $this->fld_readable && $title->userCanRead() ) {
 344                         $pageInfo['readable'] = '';
 345                 }
 346
 347                 if ( $this->fld_preload ) {
 348                         if ( $title->exists() ) {
 349                                 $pageInfo['preload'] = '';
 350                         } else {
 351                                 $text = null;
 352                                 wfRunHooks( 'EditFormPreloadText', array( &$text, &$title ) );
 353
 354                                 $pageInfo['preload'] = $text;
 355                         }
 356                 }
 357
 358                 if ( $this->fld_displaytitle ) {
 359                         if ( isset( $this->displaytitles[$title->getArticleId()] ) ) {
 360                                 $pageInfo['displaytitle'] = $this->displaytitles[$title->getArticleId()];
 361                         } else {
 362                                 $pageInfo['displaytitle'] = $title->getPrefixedText();
 363                         }
 364                 }
 365
 366                 return $pageInfo;
 367         }
 368
 369         /**
 370          * Get information about protections and put it in $protections
 371          */
 372         private function getProtectionInfo() {
 373                 $this->protections = array();
 374                 $db = $this->getDB();
 375
 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',
 383                                         'page_title' ) );
 384                         $this->addWhereFld( 'pr_page', array_keys( $this->titles ) );
 385
 386                         $res = $this->select( __METHOD__ );
 387                         foreach ( $res as $row ) {
 388                                 $a = array(
 389                                         'type' => $row->pr_type,
 390                                         'level' => $row->pr_level,
 391                                         'expiry' => Block::decodeExpiry( $row->pr_expiry, TS_ISO_8601 )
 392                                 );
 393                                 if ( $row->pr_cascade ) {
 394                                         $a['cascade'] = '';
 395                                 }
 396                                 $this->protections[$row->page_namespace][$row->page_title][] = $a;
 397
 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] );
 406
 407                                                         if ( $restriction == '' ) {
 408                                                                 continue;
 409                                                         }
 410                                                         $this->protections[$row->page_namespace][$row->page_title][] = array(
 411                                                                 'type' => 'edit',
 412                                                                 'level' => $restriction,
 413                                                                 'expiry' => 'infinity',
 414                                                         );
 415                                                         $this->protections[$row->page_namespace][$row->page_title][] = array(
 416                                                                 'type' => 'move',
 417                                                                 'level' => $restriction,
 418                                                                 'expiry' => 'infinity',
 419                                                         );
 420                                                 } else {
 421                                                         $restriction = trim( $temp[1] );
 422                                                         if ( $restriction == '' ) {
 423                                                                 continue;
 424                                                         }
 425                                                         $this->protections[$row->page_namespace][$row->page_title][] = array(
 426                                                                 'type' => $temp[0],
 427                                                                 'level' => $restriction,
 428                                                                 'expiry' => 'infinity',
 429                                                         );
 430                                                 }
 431                                         }
 432                                 }
 433                         }
 434                 }
 435
 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(
 446                                         'type' => 'create',
 447                                         'level' => $row->pt_create_perm,
 448                                         'expiry' => Block::decodeExpiry( $row->pt_expiry, TS_ISO_8601 )
 449                                 );
 450                         }
 451                 }
 452
 453                 // Cascading protections
 454                 $images = $others = array();
 455                 foreach ( $this->everything as $title ) {
 456                         if ( $title->getNamespace() == NS_FILE ) {
 457                                 $images[] = $title->getDBkey();
 458                         } else {
 459                                 $others[] = $title;
 460                         }
 461                 }
 462
 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 );
 475
 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()
 484                                 );
 485                         }
 486                 }
 487
 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 );
 498
 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()
 507                                 );
 508                         }
 509                 }
 510         }
 511
 512         /**
 513          * Get talk page IDs (if requested) and subject page IDs (if requested)
 514          * and put them in $talkids and $subjectids
 515          */
 516         private function getTSIDs() {
 517                 $getTitles = $this->talkids = $this->subjectids = array();
 518
 519                 foreach ( $this->everything as $t ) {
 520                         if ( MWNamespace::isTalk( $t->getNamespace() ) ) {
 521                                 if ( $this->fld_subjectid ) {
 522                                         $getTitles[] = $t->getSubjectPage();
 523                                 }
 524                         } elseif ( $this->fld_talkid ) {
 525                                 $getTitles[] = $t->getTalkPage();
 526                         }
 527                 }
 528                 if ( !count( $getTitles ) ) {
 529                         return;
 530                 }
 531
 532                 $db = $this->getDB();
 533
 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 );
 546                         } else {
 547                                 $this->subjectids[MWNamespace::getTalk( $row->page_namespace )][$row->page_title] =
 548                                                 intval( $row->page_id );
 549                         }
 550                 }
 551         }
 552
 553         private function getDisplayTitle() {
 554                 $this->displaytitles = array();
 555
 556                 $pageIds = array_keys( $this->titles );
 557
 558                 if ( !count( $pageIds ) ) {
 559                         return;
 560                 }
 561
 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__ );
 568
 569                 foreach ( $res as $row ) {
 570                         $this->displaytitles[$row->pp_page] = $row->pp_value;
 571                 }
 572         }
 573
 574         /**
 575          * Get information about watched status and put it in $this->watched
 576          */
 577         private function getWatchedInfo() {
 578                 global $wgUser;
 579
 580                 if ( $wgUser->isAnon() || count( $this->titles ) == 0 ) {
 581                         return;
 582                 }
 583
 584                 $this->watched = array();
 585                 $db = $this->getDB();
 586
 587                 $lb = new LinkBatch( $this->titles );
 588
 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()
 597                 ) );
 598
 599                 $res = $this->select( __METHOD__ );
 600
 601                 foreach ( $res as $row ) {
 602                         $this->watched[$row->page_namespace][$row->page_title] = true;
 603                 }
 604         }
 605
 606         public function getCacheMode( $params ) {
 607                 $publicProps = array(
 608                         'protection',
 609                         'talkid',
 610                         'subjectid',
 611                         'url',
 612                         'preload',
 613                         'displaytitle',
 614                 );
 615                 if ( !is_null( $params['prop'] ) ) {
 616                         foreach ( $params['prop'] as $prop ) {
 617                                 if ( !in_array( $prop, $publicProps ) ) {
 618                                         return 'private';
 619                                 }
 620                         }
 621                 }
 622                 if ( !is_null( $params['token'] ) ) {
 623                         return 'private';
 624                 }
 625                 return 'public';
 626         }
 627
 628         public function getAllowedParams() {
 629                 return array(
 630                         'prop' => array(
 631                                 ApiBase::PARAM_DFLT => null,
 632                                 ApiBase::PARAM_ISMULTI => true,
 633                                 ApiBase::PARAM_TYPE => array(
 634                                         'protection',
 635                                         'talkid',
 636                                         'watched', # private
 637                                         'subjectid',
 638                                         'url',
 639                                         'readable', # private
 640                                         'preload',
 641                                         'displaytitle',
 642                                         // If you add more properties here, please consider whether they
 643                                         // need to be added to getCacheMode()
 644                                 ) ),
 645                         'token' => array(
 646                                 ApiBase::PARAM_DFLT => null,
 647                                 ApiBase::PARAM_ISMULTI => true,
 648                                 ApiBase::PARAM_TYPE => array_keys( $this->getTokenFunctions() )
 649                         ),
 650                         'continue' => null,
 651                 );
 652         }
 653
 654         public function getParamDescription() {
 655                 return array(
 656                         'prop' => array(
 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',
 666                         ),
 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',
 669                 );
 670         }
 671
 672         public function getDescription() {
 673                 return 'Get basic page information such as namespace, title, last touched date, ...';
 674         }
 675
 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' ),
 679                 ) );
 680         }
 681
 682         protected function getExamples() {
 683                 return array(
 684                         'api.php?action=query&prop=info&titles=Main%20Page',
 685                         'api.php?action=query&prop=info&inprop=protection&titles=Main%20Page'
 686                 );
 687         }
 688
 689         public function getVersion() {
 690                 return __CLASS__ . ': $Id$';
 691         }
 692 }