includes/api/ApiQueryWatchlist.php

   1 <?php
   2 /**
   3  *
   4  *
   5  * Created on Sep 25, 2006
   6  *
   7  * Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License along
  20  * with this program; if not, write to the Free Software Foundation, Inc.,
  21  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  22  * http://www.gnu.org/copyleft/gpl.html
  23  *
  24  * @file
  25  */
  26
  27 /**
  28  * This query action allows clients to retrieve a list of recently modified pages
  29  * that are part of the logged-in user's watchlist.
  30  *
  31  * @ingroup API
  32  */
  33 class ApiQueryWatchlist extends ApiQueryGeneratorBase {
  34
  35         public function __construct( ApiQuery $query, $moduleName ) {
  36                 parent::__construct( $query, $moduleName, 'wl' );
  37         }
  38
  39         public function execute() {
  40                 $this->run();
  41         }
  42
  43         public function executeGenerator( $resultPageSet ) {
  44                 $this->run( $resultPageSet );
  45         }
  46
  47         private $fld_ids = false, $fld_title = false, $fld_patrol = false,
  48                 $fld_flags = false, $fld_timestamp = false, $fld_user = false,
  49                 $fld_comment = false, $fld_parsedcomment = false, $fld_sizes = false,
  50                 $fld_notificationtimestamp = false, $fld_userid = false,
  51                 $fld_loginfo = false;
  52
  53         /**
  54          * @param ApiPageSet $resultPageSet
  55          * @return void
  56          */
  57         private function run( $resultPageSet = null ) {
  58                 $this->selectNamedDB( 'watchlist', DB_SLAVE, 'watchlist' );
  59
  60                 $params = $this->extractRequestParams();
  61
  62                 $user = $this->getUser();
  63                 $wlowner = $this->getWatchlistUser( $params );
  64
  65                 if ( !is_null( $params['prop'] ) && is_null( $resultPageSet ) ) {
  66                         $prop = array_flip( $params['prop'] );
  67
  68                         $this->fld_ids = isset( $prop['ids'] );
  69                         $this->fld_title = isset( $prop['title'] );
  70                         $this->fld_flags = isset( $prop['flags'] );
  71                         $this->fld_user = isset( $prop['user'] );
  72                         $this->fld_userid = isset( $prop['userid'] );
  73                         $this->fld_comment = isset( $prop['comment'] );
  74                         $this->fld_parsedcomment = isset( $prop['parsedcomment'] );
  75                         $this->fld_timestamp = isset( $prop['timestamp'] );
  76                         $this->fld_sizes = isset( $prop['sizes'] );
  77                         $this->fld_patrol = isset( $prop['patrol'] );
  78                         $this->fld_notificationtimestamp = isset( $prop['notificationtimestamp'] );
  79                         $this->fld_loginfo = isset( $prop['loginfo'] );
  80
  81                         if ( $this->fld_patrol ) {
  82                                 if ( !$user->useRCPatrol() && !$user->useNPPatrol() ) {
  83                                         $this->dieUsage( 'patrol property is not available', 'patrol' );
  84                                 }
  85                         }
  86                 }
  87
  88                 $this->addFields( array(
  89                         'rc_id',
  90                         'rc_namespace',
  91                         'rc_title',
  92                         'rc_timestamp',
  93                         'rc_type',
  94                         'rc_deleted',
  95                 ) );
  96
  97                 if ( is_null( $resultPageSet ) ) {
  98                         $this->addFields( array(
  99                                 'rc_cur_id',
 100                                 'rc_this_oldid',
 101                                 'rc_last_oldid',
 102                         ) );
 103
 104                         $this->addFieldsIf( array( 'rc_type', 'rc_minor', 'rc_bot' ), $this->fld_flags );
 105                         $this->addFieldsIf( 'rc_user', $this->fld_user || $this->fld_userid );
 106                         $this->addFieldsIf( 'rc_user_text', $this->fld_user );
 107                         $this->addFieldsIf( 'rc_comment', $this->fld_comment || $this->fld_parsedcomment );
 108                         $this->addFieldsIf( array( 'rc_patrolled', 'rc_log_type' ), $this->fld_patrol );
 109                         $this->addFieldsIf( array( 'rc_old_len', 'rc_new_len' ), $this->fld_sizes );
 110                         $this->addFieldsIf( 'wl_notificationtimestamp', $this->fld_notificationtimestamp );
 111                         $this->addFieldsIf(
 112                                 array( 'rc_logid', 'rc_log_type', 'rc_log_action', 'rc_params' ),
 113                                 $this->fld_loginfo
 114                         );
 115                 } elseif ( $params['allrev'] ) {
 116                         $this->addFields( 'rc_this_oldid' );
 117                 } else {
 118                         $this->addFields( 'rc_cur_id' );
 119                 }
 120
 121                 $this->addTables( array(
 122                         'recentchanges',
 123                         'watchlist',
 124                 ) );
 125
 126                 $userId = $wlowner->getId();
 127                 $this->addJoinConds( array( 'watchlist' => array( 'INNER JOIN',
 128                         array(
 129                                 'wl_user' => $userId,
 130                                 'wl_namespace=rc_namespace',
 131                                 'wl_title=rc_title'
 132                         )
 133                 ) ) );
 134
 135                 $db = $this->getDB();
 136
 137                 $this->addTimestampWhereRange( 'rc_timestamp', $params['dir'],
 138                         $params['start'], $params['end'] );
 139                 // Include in ORDER BY for uniqueness
 140                 $this->addWhereRange( 'rc_id', $params['dir'], null, null );
 141
 142                 if ( !is_null( $params['continue'] ) ) {
 143                         $cont = explode( '|', $params['continue'] );
 144                         $this->dieContinueUsageIf( count( $cont ) != 2 );
 145                         $op = ( $params['dir'] === 'newer' ? '>' : '<' );
 146                         $continueTimestamp = $db->addQuotes( $db->timestamp( $cont[0] ) );
 147                         $continueId = (int)$cont[1];
 148                         $this->dieContinueUsageIf( $continueId != $cont[1] );
 149                         $this->addWhere( "rc_timestamp $op $continueTimestamp OR " .
 150                                 "(rc_timestamp = $continueTimestamp AND " .
 151                                 "rc_id $op= $continueId)"
 152                         );
 153                 }
 154
 155                 $this->addWhereFld( 'wl_namespace', $params['namespace'] );
 156
 157                 if ( !$params['allrev'] ) {
 158                         $this->addTables( 'page' );
 159                         $this->addJoinConds( array( 'page' => array( 'LEFT JOIN', 'rc_cur_id=page_id' ) ) );
 160                         $this->addWhere( 'rc_this_oldid=page_latest OR rc_type=' . RC_LOG );
 161                 }
 162
 163                 if ( !is_null( $params['show'] ) ) {
 164                         $show = array_flip( $params['show'] );
 165
 166                         /* Check for conflicting parameters. */
 167                         if ( ( isset( $show['minor'] ) && isset( $show['!minor'] ) )
 168                                 || ( isset( $show['bot'] ) && isset( $show['!bot'] ) )
 169                                 || ( isset( $show['anon'] ) && isset( $show['!anon'] ) )
 170                                 || ( isset( $show['patrolled'] ) && isset( $show['!patrolled'] ) )
 171                                 || ( isset( $show['unread'] ) && isset( $show['!unread'] ) )
 172                         ) {
 173                                 $this->dieUsageMsg( 'show' );
 174                         }
 175
 176                         // Check permissions.
 177                         if ( isset( $show['patrolled'] ) || isset( $show['!patrolled'] ) ) {
 178                                 if ( !$user->useRCPatrol() && !$user->useNPPatrol() ) {
 179                                         $this->dieUsage(
 180                                                 'You need the patrol right to request the patrolled flag',
 181                                                 'permissiondenied'
 182                                         );
 183                                 }
 184                         }
 185
 186                         /* Add additional conditions to query depending upon parameters. */
 187                         $this->addWhereIf( 'rc_minor = 0', isset( $show['!minor'] ) );
 188                         $this->addWhereIf( 'rc_minor != 0', isset( $show['minor'] ) );
 189                         $this->addWhereIf( 'rc_bot = 0', isset( $show['!bot'] ) );
 190                         $this->addWhereIf( 'rc_bot != 0', isset( $show['bot'] ) );
 191                         $this->addWhereIf( 'rc_user = 0', isset( $show['anon'] ) );
 192                         $this->addWhereIf( 'rc_user != 0', isset( $show['!anon'] ) );
 193                         $this->addWhereIf( 'rc_patrolled = 0', isset( $show['!patrolled'] ) );
 194                         $this->addWhereIf( 'rc_patrolled != 0', isset( $show['patrolled'] ) );
 195                         $this->addWhereIf( 'wl_notificationtimestamp IS NOT NULL', isset( $show['unread'] ) );
 196                         $this->addWhereIf( 'wl_notificationtimestamp IS NULL', isset( $show['!unread'] ) );
 197                 }
 198
 199                 if ( !is_null( $params['type'] ) ) {
 200                         try {
 201                                 $this->addWhereFld( 'rc_type', RecentChange::parseToRCType( $params['type'] ) );
 202                         } catch ( Exception $e ) {
 203                                 ApiBase::dieDebug( __METHOD__, $e->getMessage() );
 204                         }
 205                 }
 206
 207                 if ( !is_null( $params['user'] ) && !is_null( $params['excludeuser'] ) ) {
 208                         $this->dieUsage( 'user and excludeuser cannot be used together', 'user-excludeuser' );
 209                 }
 210                 if ( !is_null( $params['user'] ) ) {
 211                         $this->addWhereFld( 'rc_user_text', $params['user'] );
 212                 }
 213                 if ( !is_null( $params['excludeuser'] ) ) {
 214                         $this->addWhere( 'rc_user_text != ' . $db->addQuotes( $params['excludeuser'] ) );
 215                 }
 216
 217                 // This is an index optimization for mysql, as done in the Special:Watchlist page
 218                 $this->addWhereIf(
 219                         "rc_timestamp > ''",
 220                         !isset( $params['start'] ) && !isset( $params['end'] ) && $db->getType() == 'mysql'
 221                 );
 222
 223                 // Paranoia: avoid brute force searches (bug 17342)
 224                 if ( !is_null( $params['user'] ) || !is_null( $params['excludeuser'] ) ) {
 225                         if ( !$user->isAllowed( 'deletedhistory' ) ) {
 226                                 $bitmask = Revision::DELETED_USER;
 227                         } elseif ( !$user->isAllowedAny( 'suppressrevision', 'viewsuppressed' ) ) {
 228                                 $bitmask = Revision::DELETED_USER | Revision::DELETED_RESTRICTED;
 229                         } else {
 230                                 $bitmask = 0;
 231                         }
 232                         if ( $bitmask ) {
 233                                 $this->addWhere( $this->getDB()->bitAnd( 'rc_deleted', $bitmask ) . " != $bitmask" );
 234                         }
 235                 }
 236
 237                 // LogPage::DELETED_ACTION hides the affected page, too. So hide those
 238                 // entirely from the watchlist, or someone could guess the title.
 239                 if ( !$user->isAllowed( 'deletedhistory' ) ) {
 240                         $bitmask = LogPage::DELETED_ACTION;
 241                 } elseif ( !$user->isAllowedAny( 'suppressrevision', 'viewsuppressed' ) ) {
 242                         $bitmask = LogPage::DELETED_ACTION | LogPage::DELETED_RESTRICTED;
 243                 } else {
 244                         $bitmask = 0;
 245                 }
 246                 if ( $bitmask ) {
 247                         $this->addWhere( $this->getDB()->makeList( array(
 248                                 'rc_type != ' . RC_LOG,
 249                                 $this->getDB()->bitAnd( 'rc_deleted', $bitmask ) . " != $bitmask",
 250                         ), LIST_OR ) );
 251                 }
 252
 253                 $this->addOption( 'LIMIT', $params['limit'] + 1 );
 254
 255                 $ids = array();
 256                 $count = 0;
 257                 $res = $this->select( __METHOD__ );
 258
 259                 foreach ( $res as $row ) {
 260                         if ( ++$count > $params['limit'] ) {
 261                                 // We've reached the one extra which shows that there are
 262                                 // additional pages to be had. Stop here...
 263                                 $this->setContinueEnumParameter( 'continue', "$row->rc_timestamp|$row->rc_id" );
 264                                 break;
 265                         }
 266
 267                         if ( is_null( $resultPageSet ) ) {
 268                                 $vals = $this->extractRowInfo( $row );
 269                                 $fit = $this->getResult()->addValue( array( 'query', $this->getModuleName() ), null, $vals );
 270                                 if ( !$fit ) {
 271                                         $this->setContinueEnumParameter( 'continue', "$row->rc_timestamp|$row->rc_id" );
 272                                         break;
 273                                 }
 274                         } else {
 275                                 if ( $params['allrev'] ) {
 276                                         $ids[] = intval( $row->rc_this_oldid );
 277                                 } else {
 278                                         $ids[] = intval( $row->rc_cur_id );
 279                                 }
 280                         }
 281                 }
 282
 283                 if ( is_null( $resultPageSet ) ) {
 284                         $this->getResult()->addIndexedTagName(
 285                                 array( 'query', $this->getModuleName() ),
 286                                 'item'
 287                         );
 288                 } elseif ( $params['allrev'] ) {
 289                         $resultPageSet->populateFromRevisionIDs( $ids );
 290                 } else {
 291                         $resultPageSet->populateFromPageIDs( $ids );
 292                 }
 293         }
 294
 295         private function extractRowInfo( $row ) {
 296                 /* Determine the title of the page that has been changed. */
 297                 $title = Title::makeTitle( $row->rc_namespace, $row->rc_title );
 298                 $user = $this->getUser();
 299
 300                 /* Our output data. */
 301                 $vals = array();
 302                 $type = intval( $row->rc_type );
 303                 $vals['type'] = RecentChange::parseFromRCType( $type );
 304                 $anyHidden = false;
 305
 306                 /* Create a new entry in the result for the title. */
 307                 if ( $this->fld_title || $this->fld_ids ) {
 308                         // These should already have been filtered out of the query, but just in case.
 309                         if ( $type === RC_LOG && ( $row->rc_deleted & LogPage::DELETED_ACTION ) ) {
 310                                 $vals['actionhidden'] = true;
 311                                 $anyHidden = true;
 312                         }
 313                         if ( $type !== RC_LOG ||
 314                                 LogEventsList::userCanBitfield( $row->rc_deleted, LogPage::DELETED_ACTION, $user )
 315                         ) {
 316                                 if ( $this->fld_title ) {
 317                                         ApiQueryBase::addTitleInfo( $vals, $title );
 318                                 }
 319                                 if ( $this->fld_ids ) {
 320                                         $vals['pageid'] = intval( $row->rc_cur_id );
 321                                         $vals['revid'] = intval( $row->rc_this_oldid );
 322                                         $vals['old_revid'] = intval( $row->rc_last_oldid );
 323                                 }
 324                         }
 325                 }
 326
 327                 /* Add user data and 'anon' flag, if user is anonymous. */
 328                 if ( $this->fld_user || $this->fld_userid ) {
 329                         if ( $row->rc_deleted & Revision::DELETED_USER ) {
 330                                 $vals['userhidden'] = true;
 331                                 $anyHidden = true;
 332                         }
 333                         if ( Revision::userCanBitfield( $row->rc_deleted, Revision::DELETED_USER, $user ) ) {
 334                                 if ( $this->fld_userid ) {
 335                                         $vals['userid'] = (int)$row->rc_user;
 336                                         // for backwards compatibility
 337                                         $vals['user'] = (int)$row->rc_user;
 338                                 }
 339
 340                                 if ( $this->fld_user ) {
 341                                         $vals['user'] = $row->rc_user_text;
 342                                 }
 343
 344                                 if ( !$row->rc_user ) {
 345                                         $vals['anon'] = true;
 346                                 }
 347                         }
 348                 }
 349
 350                 /* Add flags, such as new, minor, bot. */
 351                 if ( $this->fld_flags ) {
 352                         $vals['bot'] = (bool)$row->rc_bot;
 353                         $vals['new'] = $row->rc_type == RC_NEW;
 354                         $vals['minor'] = (bool)$row->rc_minor;
 355                 }
 356
 357                 /* Add sizes of each revision. (Only available on 1.10+) */
 358                 if ( $this->fld_sizes ) {
 359                         $vals['oldlen'] = intval( $row->rc_old_len );
 360                         $vals['newlen'] = intval( $row->rc_new_len );
 361                 }
 362
 363                 /* Add the timestamp. */
 364                 if ( $this->fld_timestamp ) {
 365                         $vals['timestamp'] = wfTimestamp( TS_ISO_8601, $row->rc_timestamp );
 366                 }
 367
 368                 if ( $this->fld_notificationtimestamp ) {
 369                         $vals['notificationtimestamp'] = ( $row->wl_notificationtimestamp == null )
 370                                 ? ''
 371                                 : wfTimestamp( TS_ISO_8601, $row->wl_notificationtimestamp );
 372                 }
 373
 374                 /* Add edit summary / log summary. */
 375                 if ( $this->fld_comment || $this->fld_parsedcomment ) {
 376                         if ( $row->rc_deleted & Revision::DELETED_COMMENT ) {
 377                                 $vals['commenthidden'] = true;
 378                                 $anyHidden = true;
 379                         }
 380                         if ( Revision::userCanBitfield( $row->rc_deleted, Revision::DELETED_COMMENT, $user ) ) {
 381                                 if ( $this->fld_comment && isset( $row->rc_comment ) ) {
 382                                         $vals['comment'] = $row->rc_comment;
 383                                 }
 384
 385                                 if ( $this->fld_parsedcomment && isset( $row->rc_comment ) ) {
 386                                         $vals['parsedcomment'] = Linker::formatComment( $row->rc_comment, $title );
 387                                 }
 388                         }
 389                 }
 390
 391                 /* Add the patrolled flag */
 392                 if ( $this->fld_patrol ) {
 393                         $vals['patrolled'] = $row->rc_patrolled == 1;
 394                         $vals['unpatrolled'] = ChangesList::isUnpatrolled( $row, $user );
 395                 }
 396
 397                 if ( $this->fld_loginfo && $row->rc_type == RC_LOG ) {
 398                         if ( $row->rc_deleted & LogPage::DELETED_ACTION ) {
 399                                 $vals['actionhidden'] = true;
 400                                 $anyHidden = true;
 401                         }
 402                         if ( LogEventsList::userCanBitfield( $row->rc_deleted, LogPage::DELETED_ACTION, $user ) ) {
 403                                 $vals['logid'] = intval( $row->rc_logid );
 404                                 $vals['logtype'] = $row->rc_log_type;
 405                                 $vals['logaction'] = $row->rc_log_action;
 406                                 $vals['logparams'] = LogFormatter::newFromRow( $row )->formatParametersForApi();
 407                         }
 408                 }
 409
 410                 if ( $anyHidden && ( $row->rc_deleted & Revision::DELETED_RESTRICTED ) ) {
 411                         $vals['suppressed'] = true;
 412                 }
 413
 414                 return $vals;
 415         }
 416
 417         public function getAllowedParams() {
 418                 return array(
 419                         'allrev' => false,
 420                         'start' => array(
 421                                 ApiBase::PARAM_TYPE => 'timestamp'
 422                         ),
 423                         'end' => array(
 424                                 ApiBase::PARAM_TYPE => 'timestamp'
 425                         ),
 426                         'namespace' => array(
 427                                 ApiBase::PARAM_ISMULTI => true,
 428                                 ApiBase::PARAM_TYPE => 'namespace'
 429                         ),
 430                         'user' => array(
 431                                 ApiBase::PARAM_TYPE => 'user',
 432                         ),
 433                         'excludeuser' => array(
 434                                 ApiBase::PARAM_TYPE => 'user',
 435                         ),
 436                         'dir' => array(
 437                                 ApiBase::PARAM_DFLT => 'older',
 438                                 ApiBase::PARAM_TYPE => array(
 439                                         'newer',
 440                                         'older'
 441                                 ),
 442                                 ApiHelp::PARAM_HELP_MSG => 'api-help-param-direction',
 443                         ),
 444                         'limit' => array(
 445                                 ApiBase::PARAM_DFLT => 10,
 446                                 ApiBase::PARAM_TYPE => 'limit',
 447                                 ApiBase::PARAM_MIN => 1,
 448                                 ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
 449                                 ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
 450                         ),
 451                         'prop' => array(
 452                                 ApiBase::PARAM_ISMULTI => true,
 453                                 ApiBase::PARAM_DFLT => 'ids|title|flags',
 454                                 ApiBase::PARAM_HELP_MSG_PER_VALUE => array(),
 455                                 ApiBase::PARAM_TYPE => array(
 456                                         'ids',
 457                                         'title',
 458                                         'flags',
 459                                         'user',
 460                                         'userid',
 461                                         'comment',
 462                                         'parsedcomment',
 463                                         'timestamp',
 464                                         'patrol',
 465                                         'sizes',
 466                                         'notificationtimestamp',
 467                                         'loginfo',
 468                                 )
 469                         ),
 470                         'show' => array(
 471                                 ApiBase::PARAM_ISMULTI => true,
 472                                 ApiBase::PARAM_TYPE => array(
 473                                         'minor',
 474                                         '!minor',
 475                                         'bot',
 476                                         '!bot',
 477                                         'anon',
 478                                         '!anon',
 479                                         'patrolled',
 480                                         '!patrolled',
 481                                         'unread',
 482                                         '!unread',
 483                                 )
 484                         ),
 485                         'type' => array(
 486                                 ApiBase::PARAM_DFLT => 'edit|new|log|categorize',
 487                                 ApiBase::PARAM_ISMULTI => true,
 488                                 ApiBase::PARAM_HELP_MSG_PER_VALUE => array(),
 489                                 ApiBase::PARAM_TYPE => RecentChange::getChangeTypes()
 490                         ),
 491                         'owner' => array(
 492                                 ApiBase::PARAM_TYPE => 'user'
 493                         ),
 494                         'token' => array(
 495                                 ApiBase::PARAM_TYPE => 'string'
 496                         ),
 497                         'continue' => array(
 498                                 ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
 499                         ),
 500                 );
 501         }
 502
 503         protected function getExamplesMessages() {
 504                 return array(
 505                         'action=query&list=watchlist'
 506                                 => 'apihelp-query+watchlist-example-simple',
 507                         'action=query&list=watchlist&wlprop=ids|title|timestamp|user|comment'
 508                                 => 'apihelp-query+watchlist-example-props',
 509                         'action=query&list=watchlist&wlallrev=&wlprop=ids|title|timestamp|user|comment'
 510                                 => 'apihelp-query+watchlist-example-allrev',
 511                         'action=query&generator=watchlist&prop=info'
 512                                 => 'apihelp-query+watchlist-example-generator',
 513                         'action=query&generator=watchlist&gwlallrev=&prop=revisions&rvprop=timestamp|user'
 514                                 => 'apihelp-query+watchlist-example-generator-rev',
 515                         'action=query&list=watchlist&wlowner=Example&wltoken=123ABC'
 516                                 => 'apihelp-query+watchlist-example-wlowner',
 517                 );
 518         }
 519
 520         public function getHelpUrls() {
 521                 return 'https://www.mediawiki.org/wiki/API:Watchlist';
 522         }
 523 }