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( [
  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( [
  99                                 'rc_cur_id',
 100                                 'rc_this_oldid',
 101                                 'rc_last_oldid',
 102                         ] );
 103
 104                         $this->addFieldsIf( [ '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( [ 'rc_patrolled', 'rc_log_type' ], $this->fld_patrol );
 109                         $this->addFieldsIf( [ 'rc_old_len', 'rc_new_len' ], $this->fld_sizes );
 110                         $this->addFieldsIf( 'wl_notificationtimestamp', $this->fld_notificationtimestamp );
 111                         $this->addFieldsIf(
 112                                 [ '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( [
 122                         'recentchanges',
 123                         'watchlist',
 124                 ] );
 125
 126                 $userId = $wlowner->getId();
 127                 $this->addJoinConds( [ 'watchlist' => [ 'INNER JOIN',
 128                         [
 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( [ 'page' => [ '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( 'rc_timestamp >= wl_notificationtimestamp', isset( $show['unread'] ) );
 196                         $this->addWhereIf(
 197                                 'wl_notificationtimestamp IS NULL OR rc_timestamp < wl_notificationtimestamp',
 198                                 isset( $show['!unread'] )
 199                         );
 200                 }
 201
 202                 if ( !is_null( $params['type'] ) ) {
 203                         try {
 204                                 $this->addWhereFld( 'rc_type', RecentChange::parseToRCType( $params['type'] ) );
 205                         } catch ( Exception $e ) {
 206                                 ApiBase::dieDebug( __METHOD__, $e->getMessage() );
 207                         }
 208                 }
 209
 210                 if ( !is_null( $params['user'] ) && !is_null( $params['excludeuser'] ) ) {
 211                         $this->dieUsage( 'user and excludeuser cannot be used together', 'user-excludeuser' );
 212                 }
 213                 if ( !is_null( $params['user'] ) ) {
 214                         $this->addWhereFld( 'rc_user_text', $params['user'] );
 215                 }
 216                 if ( !is_null( $params['excludeuser'] ) ) {
 217                         $this->addWhere( 'rc_user_text != ' . $db->addQuotes( $params['excludeuser'] ) );
 218                 }
 219
 220                 // This is an index optimization for mysql, as done in the Special:Watchlist page
 221                 $this->addWhereIf(
 222                         "rc_timestamp > ''",
 223                         !isset( $params['start'] ) && !isset( $params['end'] ) && $db->getType() == 'mysql'
 224                 );
 225
 226                 // Paranoia: avoid brute force searches (bug 17342)
 227                 if ( !is_null( $params['user'] ) || !is_null( $params['excludeuser'] ) ) {
 228                         if ( !$user->isAllowed( 'deletedhistory' ) ) {
 229                                 $bitmask = Revision::DELETED_USER;
 230                         } elseif ( !$user->isAllowedAny( 'suppressrevision', 'viewsuppressed' ) ) {
 231                                 $bitmask = Revision::DELETED_USER | Revision::DELETED_RESTRICTED;
 232                         } else {
 233                                 $bitmask = 0;
 234                         }
 235                         if ( $bitmask ) {
 236                                 $this->addWhere( $this->getDB()->bitAnd( 'rc_deleted', $bitmask ) . " != $bitmask" );
 237                         }
 238                 }
 239
 240                 // LogPage::DELETED_ACTION hides the affected page, too. So hide those
 241                 // entirely from the watchlist, or someone could guess the title.
 242                 if ( !$user->isAllowed( 'deletedhistory' ) ) {
 243                         $bitmask = LogPage::DELETED_ACTION;
 244                 } elseif ( !$user->isAllowedAny( 'suppressrevision', 'viewsuppressed' ) ) {
 245                         $bitmask = LogPage::DELETED_ACTION | LogPage::DELETED_RESTRICTED;
 246                 } else {
 247                         $bitmask = 0;
 248                 }
 249                 if ( $bitmask ) {
 250                         $this->addWhere( $this->getDB()->makeList( [
 251                                 'rc_type != ' . RC_LOG,
 252                                 $this->getDB()->bitAnd( 'rc_deleted', $bitmask ) . " != $bitmask",
 253                         ], LIST_OR ) );
 254                 }
 255
 256                 $this->addOption( 'LIMIT', $params['limit'] + 1 );
 257
 258                 $ids = [];
 259                 $count = 0;
 260                 $res = $this->select( __METHOD__ );
 261
 262                 foreach ( $res as $row ) {
 263                         if ( ++$count > $params['limit'] ) {
 264                                 // We've reached the one extra which shows that there are
 265                                 // additional pages to be had. Stop here...
 266                                 $this->setContinueEnumParameter( 'continue', "$row->rc_timestamp|$row->rc_id" );
 267                                 break;
 268                         }
 269
 270                         if ( is_null( $resultPageSet ) ) {
 271                                 $vals = $this->extractRowInfo( $row );
 272                                 $fit = $this->getResult()->addValue( [ 'query', $this->getModuleName() ], null, $vals );
 273                                 if ( !$fit ) {
 274                                         $this->setContinueEnumParameter( 'continue', "$row->rc_timestamp|$row->rc_id" );
 275                                         break;
 276                                 }
 277                         } else {
 278                                 if ( $params['allrev'] ) {
 279                                         $ids[] = intval( $row->rc_this_oldid );
 280                                 } else {
 281                                         $ids[] = intval( $row->rc_cur_id );
 282                                 }
 283                         }
 284                 }
 285
 286                 if ( is_null( $resultPageSet ) ) {
 287                         $this->getResult()->addIndexedTagName(
 288                                 [ 'query', $this->getModuleName() ],
 289                                 'item'
 290                         );
 291                 } elseif ( $params['allrev'] ) {
 292                         $resultPageSet->populateFromRevisionIDs( $ids );
 293                 } else {
 294                         $resultPageSet->populateFromPageIDs( $ids );
 295                 }
 296         }
 297
 298         private function extractRowInfo( $row ) {
 299                 /* Determine the title of the page that has been changed. */
 300                 $title = Title::makeTitle( $row->rc_namespace, $row->rc_title );
 301                 $user = $this->getUser();
 302
 303                 /* Our output data. */
 304                 $vals = [];
 305                 $type = intval( $row->rc_type );
 306                 $vals['type'] = RecentChange::parseFromRCType( $type );
 307                 $anyHidden = false;
 308
 309                 /* Create a new entry in the result for the title. */
 310                 if ( $this->fld_title || $this->fld_ids ) {
 311                         // These should already have been filtered out of the query, but just in case.
 312                         if ( $type === RC_LOG && ( $row->rc_deleted & LogPage::DELETED_ACTION ) ) {
 313                                 $vals['actionhidden'] = true;
 314                                 $anyHidden = true;
 315                         }
 316                         if ( $type !== RC_LOG ||
 317                                 LogEventsList::userCanBitfield( $row->rc_deleted, LogPage::DELETED_ACTION, $user )
 318                         ) {
 319                                 if ( $this->fld_title ) {
 320                                         ApiQueryBase::addTitleInfo( $vals, $title );
 321                                 }
 322                                 if ( $this->fld_ids ) {
 323                                         $vals['pageid'] = intval( $row->rc_cur_id );
 324                                         $vals['revid'] = intval( $row->rc_this_oldid );
 325                                         $vals['old_revid'] = intval( $row->rc_last_oldid );
 326                                 }
 327                         }
 328                 }
 329
 330                 /* Add user data and 'anon' flag, if user is anonymous. */
 331                 if ( $this->fld_user || $this->fld_userid ) {
 332                         if ( $row->rc_deleted & Revision::DELETED_USER ) {
 333                                 $vals['userhidden'] = true;
 334                                 $anyHidden = true;
 335                         }
 336                         if ( Revision::userCanBitfield( $row->rc_deleted, Revision::DELETED_USER, $user ) ) {
 337                                 if ( $this->fld_userid ) {
 338                                         $vals['userid'] = (int)$row->rc_user;
 339                                         // for backwards compatibility
 340                                         $vals['user'] = (int)$row->rc_user;
 341                                 }
 342
 343                                 if ( $this->fld_user ) {
 344                                         $vals['user'] = $row->rc_user_text;
 345                                 }
 346
 347                                 if ( !$row->rc_user ) {
 348                                         $vals['anon'] = true;
 349                                 }
 350                         }
 351                 }
 352
 353                 /* Add flags, such as new, minor, bot. */
 354                 if ( $this->fld_flags ) {
 355                         $vals['bot'] = (bool)$row->rc_bot;
 356                         $vals['new'] = $row->rc_type == RC_NEW;
 357                         $vals['minor'] = (bool)$row->rc_minor;
 358                 }
 359
 360                 /* Add sizes of each revision. (Only available on 1.10+) */
 361                 if ( $this->fld_sizes ) {
 362                         $vals['oldlen'] = intval( $row->rc_old_len );
 363                         $vals['newlen'] = intval( $row->rc_new_len );
 364                 }
 365
 366                 /* Add the timestamp. */
 367                 if ( $this->fld_timestamp ) {
 368                         $vals['timestamp'] = wfTimestamp( TS_ISO_8601, $row->rc_timestamp );
 369                 }
 370
 371                 if ( $this->fld_notificationtimestamp ) {
 372                         $vals['notificationtimestamp'] = ( $row->wl_notificationtimestamp == null )
 373                                 ? ''
 374                                 : wfTimestamp( TS_ISO_8601, $row->wl_notificationtimestamp );
 375                 }
 376
 377                 /* Add edit summary / log summary. */
 378                 if ( $this->fld_comment || $this->fld_parsedcomment ) {
 379                         if ( $row->rc_deleted & Revision::DELETED_COMMENT ) {
 380                                 $vals['commenthidden'] = true;
 381                                 $anyHidden = true;
 382                         }
 383                         if ( Revision::userCanBitfield( $row->rc_deleted, Revision::DELETED_COMMENT, $user ) ) {
 384                                 if ( $this->fld_comment && isset( $row->rc_comment ) ) {
 385                                         $vals['comment'] = $row->rc_comment;
 386                                 }
 387
 388                                 if ( $this->fld_parsedcomment && isset( $row->rc_comment ) ) {
 389                                         $vals['parsedcomment'] = Linker::formatComment( $row->rc_comment, $title );
 390                                 }
 391                         }
 392                 }
 393
 394                 /* Add the patrolled flag */
 395                 if ( $this->fld_patrol ) {
 396                         $vals['patrolled'] = $row->rc_patrolled == 1;
 397                         $vals['unpatrolled'] = ChangesList::isUnpatrolled( $row, $user );
 398                 }
 399
 400                 if ( $this->fld_loginfo && $row->rc_type == RC_LOG ) {
 401                         if ( $row->rc_deleted & LogPage::DELETED_ACTION ) {
 402                                 $vals['actionhidden'] = true;
 403                                 $anyHidden = true;
 404                         }
 405                         if ( LogEventsList::userCanBitfield( $row->rc_deleted, LogPage::DELETED_ACTION, $user ) ) {
 406                                 $vals['logid'] = intval( $row->rc_logid );
 407                                 $vals['logtype'] = $row->rc_log_type;
 408                                 $vals['logaction'] = $row->rc_log_action;
 409                                 $vals['logparams'] = LogFormatter::newFromRow( $row )->formatParametersForApi();
 410                         }
 411                 }
 412
 413                 if ( $anyHidden && ( $row->rc_deleted & Revision::DELETED_RESTRICTED ) ) {
 414                         $vals['suppressed'] = true;
 415                 }
 416
 417                 return $vals;
 418         }
 419
 420         public function getAllowedParams() {
 421                 return [
 422                         'allrev' => false,
 423                         'start' => [
 424                                 ApiBase::PARAM_TYPE => 'timestamp'
 425                         ],
 426                         'end' => [
 427                                 ApiBase::PARAM_TYPE => 'timestamp'
 428                         ],
 429                         'namespace' => [
 430                                 ApiBase::PARAM_ISMULTI => true,
 431                                 ApiBase::PARAM_TYPE => 'namespace'
 432                         ],
 433                         'user' => [
 434                                 ApiBase::PARAM_TYPE => 'user',
 435                         ],
 436                         'excludeuser' => [
 437                                 ApiBase::PARAM_TYPE => 'user',
 438                         ],
 439                         'dir' => [
 440                                 ApiBase::PARAM_DFLT => 'older',
 441                                 ApiBase::PARAM_TYPE => [
 442                                         'newer',
 443                                         'older'
 444                                 ],
 445                                 ApiHelp::PARAM_HELP_MSG => 'api-help-param-direction',
 446                         ],
 447                         'limit' => [
 448                                 ApiBase::PARAM_DFLT => 10,
 449                                 ApiBase::PARAM_TYPE => 'limit',
 450                                 ApiBase::PARAM_MIN => 1,
 451                                 ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
 452                                 ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
 453                         ],
 454                         'prop' => [
 455                                 ApiBase::PARAM_ISMULTI => true,
 456                                 ApiBase::PARAM_DFLT => 'ids|title|flags',
 457                                 ApiBase::PARAM_HELP_MSG_PER_VALUE => [],
 458                                 ApiBase::PARAM_TYPE => [
 459                                         'ids',
 460                                         'title',
 461                                         'flags',
 462                                         'user',
 463                                         'userid',
 464                                         'comment',
 465                                         'parsedcomment',
 466                                         'timestamp',
 467                                         'patrol',
 468                                         'sizes',
 469                                         'notificationtimestamp',
 470                                         'loginfo',
 471                                 ]
 472                         ],
 473                         'show' => [
 474                                 ApiBase::PARAM_ISMULTI => true,
 475                                 ApiBase::PARAM_TYPE => [
 476                                         'minor',
 477                                         '!minor',
 478                                         'bot',
 479                                         '!bot',
 480                                         'anon',
 481                                         '!anon',
 482                                         'patrolled',
 483                                         '!patrolled',
 484                                         'unread',
 485                                         '!unread',
 486                                 ]
 487                         ],
 488                         'type' => [
 489                                 ApiBase::PARAM_DFLT => 'edit|new|log|categorize',
 490                                 ApiBase::PARAM_ISMULTI => true,
 491                                 ApiBase::PARAM_HELP_MSG_PER_VALUE => [],
 492                                 ApiBase::PARAM_TYPE => RecentChange::getChangeTypes()
 493                         ],
 494                         'owner' => [
 495                                 ApiBase::PARAM_TYPE => 'user'
 496                         ],
 497                         'token' => [
 498                                 ApiBase::PARAM_TYPE => 'string'
 499                         ],
 500                         'continue' => [
 501                                 ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
 502                         ],
 503                 ];
 504         }
 505
 506         protected function getExamplesMessages() {
 507                 return [
 508                         'action=query&list=watchlist'
 509                                 => 'apihelp-query+watchlist-example-simple',
 510                         'action=query&list=watchlist&wlprop=ids|title|timestamp|user|comment'
 511                                 => 'apihelp-query+watchlist-example-props',
 512                         'action=query&list=watchlist&wlallrev=&wlprop=ids|title|timestamp|user|comment'
 513                                 => 'apihelp-query+watchlist-example-allrev',
 514                         'action=query&generator=watchlist&prop=info'
 515                                 => 'apihelp-query+watchlist-example-generator',
 516                         'action=query&generator=watchlist&gwlallrev=&prop=revisions&rvprop=timestamp|user'
 517                                 => 'apihelp-query+watchlist-example-generator-rev',
 518                         'action=query&list=watchlist&wlowner=Example&wltoken=123ABC'
 519                                 => 'apihelp-query+watchlist-example-wlowner',
 520                 ];
 521         }
 522
 523         public function getHelpUrls() {
 524                 return 'https://www.mediawiki.org/wiki/API:Watchlist';
 525         }
 526 }