includes/api/ApiQueryWatchlist.php

   1 <?php
   2
   3 /*
   4  * Created on Sep 25, 2006
   5  *
   6  * API for MediaWiki 1.8+
   7  *
   8  * Copyright (C) 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License along
  21  * with this program; if not, write to the Free Software Foundation, Inc.,
  22  * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  23  * http://www.gnu.org/copyleft/gpl.html
  24  */
  25
  26 if (!defined('MEDIAWIKI')) {
  27         // Eclipse helper - will be ignored in production
  28         require_once ('ApiQueryBase.php');
  29 }
  30
  31 /**
  32  * This query action allows clients to retrieve a list of recently modified pages
  33  * that are part of the logged-in user's watchlist.
  34  *
  35  * @ingroup API
  36  */
  37 class ApiQueryWatchlist extends ApiQueryGeneratorBase {
  38
  39         public function __construct($query, $moduleName) {
  40                 parent :: __construct($query, $moduleName, 'wl');
  41         }
  42
  43         public function execute() {
  44                 $this->run();
  45         }
  46
  47         public function executeGenerator($resultPageSet) {
  48                 $this->run($resultPageSet);
  49         }
  50
  51         private $fld_ids = false, $fld_title = false, $fld_patrol = false, $fld_flags = false,
  52                         $fld_timestamp = false, $fld_user = false, $fld_comment = false, $fld_sizes = false;
  53
  54         private function run($resultPageSet = null) {
  55                 global $wgUser, $wgDBtype;
  56
  57                 $this->selectNamedDB('watchlist', DB_SLAVE, 'watchlist');
  58
  59                 if (!$wgUser->isLoggedIn())
  60                         $this->dieUsage('You must be logged-in to have a watchlist', 'notloggedin');
  61
  62                 $allrev = $start = $end = $namespace = $user = $excludeuser = $dir = $limit = $prop = $show = null;
  63                 extract($this->extractRequestParams());
  64
  65                 if (!is_null($prop) && is_null($resultPageSet)) {
  66
  67                         $prop = array_flip($prop);
  68
  69                         $this->fld_ids = isset($prop['ids']);
  70                         $this->fld_title = isset($prop['title']);
  71                         $this->fld_flags = isset($prop['flags']);
  72                         $this->fld_user = isset($prop['user']);
  73                         $this->fld_comment = isset($prop['comment']);
  74                         $this->fld_timestamp = isset($prop['timestamp']);
  75                         $this->fld_sizes = isset($prop['sizes']);
  76                         $this->fld_patrol = isset($prop['patrol']);
  77
  78                         if ($this->fld_patrol) {
  79                                 global $wgUser;
  80                                 if (!$wgUser->useRCPatrol() && !$wgUser->useNPPatrol())
  81                                         $this->dieUsage('patrol property is not available', 'patrol');
  82                         }
  83                 }
  84
  85                 if (is_null($resultPageSet)) {
  86                         $this->addFields(array (
  87                                 'rc_cur_id',
  88                                 'rc_this_oldid',
  89                                 'rc_namespace',
  90                                 'rc_title',
  91                                 'rc_timestamp'
  92                         ));
  93
  94                         $this->addFieldsIf('rc_new', $this->fld_flags);
  95                         $this->addFieldsIf('rc_minor', $this->fld_flags);
  96                         $this->addFieldsIf('rc_user', $this->fld_user);
  97                         $this->addFieldsIf('rc_user_text', $this->fld_user);
  98                         $this->addFieldsIf('rc_comment', $this->fld_comment);
  99                         $this->addFieldsIf('rc_patrolled', $this->fld_patrol);
 100                         $this->addFieldsIf('rc_old_len', $this->fld_sizes);
 101                         $this->addFieldsIf('rc_new_len', $this->fld_sizes);
 102                 }
 103                 elseif ($allrev) {
 104                         $this->addFields(array (
 105                                 'rc_this_oldid',
 106                                 'rc_namespace',
 107                                 'rc_title',
 108                                 'rc_timestamp'
 109                         ));
 110                 } else {
 111                         $this->addFields(array (
 112                                 'rc_cur_id',
 113                                 'rc_namespace',
 114                                 'rc_title',
 115                                 'rc_timestamp'
 116                         ));
 117                 }
 118
 119                 $this->addTables(array (
 120                         'watchlist',
 121                         'page',
 122                         'recentchanges'
 123                 ));
 124
 125                 $userId = $wgUser->getId();
 126                 $this->addWhere(array (
 127                         'wl_namespace = rc_namespace',
 128                         'wl_title = rc_title',
 129                         'rc_cur_id = page_id',
 130                         'wl_user' => $userId,
 131                         'rc_deleted' => 0,
 132                 ));
 133
 134                 $this->addWhereRange('rc_timestamp', $dir, $start, $end);
 135                 $this->addWhereFld('wl_namespace', $namespace);
 136                 $this->addWhereIf('rc_this_oldid=page_latest', !$allrev);
 137
 138                 if (!is_null($show)) {
 139                         $show = array_flip($show);
 140
 141                         /* Check for conflicting parameters. */
 142                         if ((isset ($show['minor']) && isset ($show['!minor']))
 143                                         || (isset ($show['bot']) && isset ($show['!bot']))
 144                                         || (isset ($show['anon']) && isset ($show['!anon']))
 145                                         || (isset ($show['patrolled']) && isset ($show['!patrolled']))) {
 146
 147                                 $this->dieUsage("Incorrect parameter - mutually exclusive values may not be supplied", 'show');
 148                         }
 149
 150                         // Check permissions
 151                         global $wgUser;
 152                         if((isset($show['patrolled']) || isset($show['!patrolled'])) && !$wgUser->useRCPatrol() && !$wgUser->useNPPatrol())
 153                                 $this->dieUsage("You need the patrol right to request the patrolled flag", 'permissiondenied');
 154
 155                         /* Add additional conditions to query depending upon parameters. */
 156                         $this->addWhereIf('rc_minor = 0', isset ($show['!minor']));
 157                         $this->addWhereIf('rc_minor != 0', isset ($show['minor']));
 158                         $this->addWhereIf('rc_bot = 0', isset ($show['!bot']));
 159                         $this->addWhereIf('rc_bot != 0', isset ($show['bot']));
 160                         $this->addWhereIf('rc_user = 0', isset ($show['anon']));
 161                         $this->addWhereIf('rc_user != 0', isset ($show['!anon']));
 162                         $this->addWhereIf('rc_patrolled = 0', isset($show['!patrolled']));
 163                         $this->addWhereIf('rc_patrolled != 0', isset($show['patrolled']));
 164                 }
 165
 166                 if(!is_null($user) && !is_null($excludeuser))
 167                         $this->dieUsage('user and excludeuser cannot be used together', 'badparams');
 168                 if(!is_null($user))
 169                         $this->addWhereFld('rc_user_text', $user);
 170                 if(!is_null($excludeuser))
 171                         $this->addWhere('rc_user_text != ' . $this->getDB()->addQuotes($excludeuser));
 172
 173
 174                 # This is an index optimization for mysql, as done in the Special:Watchlist page
 175                 $this->addWhereIf("rc_timestamp > ''", !isset ($start) && !isset ($end) && $wgDBtype == 'mysql');
 176
 177                 $this->addOption('LIMIT', $limit +1);
 178
 179                 $data = array ();
 180                 $count = 0;
 181                 $res = $this->select(__METHOD__);
 182
 183                 $db = $this->getDB();
 184                 while ($row = $db->fetchObject($res)) {
 185                         if (++ $count > $limit) {
 186                                 // We've reached the one extra which shows that there are additional pages to be had. Stop here...
 187                                 $this->setContinueEnumParameter('start', wfTimestamp(TS_ISO_8601, $row->rc_timestamp));
 188                                 break;
 189                         }
 190
 191                         if (is_null($resultPageSet)) {
 192                                 $vals = $this->extractRowInfo($row);
 193                                 if ($vals)
 194                                         $data[] = $vals;
 195                         } else {
 196                                 if ($allrev) {
 197                                         $data[] = intval($row->rc_this_oldid);
 198                                 } else {
 199                                         $data[] = intval($row->rc_cur_id);
 200                                 }
 201                         }
 202                 }
 203
 204                 $db->freeResult($res);
 205
 206                 if (is_null($resultPageSet)) {
 207                         $this->getResult()->setIndexedTagName($data, 'item');
 208                         $this->getResult()->addValue('query', $this->getModuleName(), $data);
 209                 }
 210                 elseif ($allrev) {
 211                         $resultPageSet->populateFromRevisionIDs($data);
 212                 } else {
 213                         $resultPageSet->populateFromPageIDs($data);
 214                 }
 215         }
 216
 217         private function extractRowInfo($row) {
 218
 219                 $vals = array ();
 220
 221                 if ($this->fld_ids) {
 222                         $vals['pageid'] = intval($row->rc_cur_id);
 223                         $vals['revid'] = intval($row->rc_this_oldid);
 224                 }
 225
 226                 if ($this->fld_title)
 227                         ApiQueryBase :: addTitleInfo($vals, Title :: makeTitle($row->rc_namespace, $row->rc_title));
 228
 229                 if ($this->fld_user) {
 230                         $vals['user'] = $row->rc_user_text;
 231                         if (!$row->rc_user)
 232                                 $vals['anon'] = '';
 233                 }
 234
 235                 if ($this->fld_flags) {
 236                         if ($row->rc_new)
 237                                 $vals['new'] = '';
 238                         if ($row->rc_minor)
 239                                 $vals['minor'] = '';
 240                 }
 241
 242                 if ($this->fld_patrol && isset($row->rc_patrolled))
 243                         $vals['patrolled'] = '';
 244
 245                 if ($this->fld_timestamp)
 246                         $vals['timestamp'] = wfTimestamp(TS_ISO_8601, $row->rc_timestamp);
 247
 248                         $this->addFieldsIf('rc_new_len', $this->fld_sizes);
 249
 250                 if ($this->fld_sizes) {
 251                         $vals['oldlen'] = intval($row->rc_old_len);
 252                         $vals['newlen'] = intval($row->rc_new_len);
 253                 }
 254
 255                 if ($this->fld_comment && isset( $row->rc_comment ))
 256                         $vals['comment'] = $row->rc_comment;
 257
 258                 return $vals;
 259         }
 260
 261         public function getAllowedParams() {
 262                 return array (
 263                         'allrev' => false,
 264                         'start' => array (
 265                                 ApiBase :: PARAM_TYPE => 'timestamp'
 266                         ),
 267                         'end' => array (
 268                                 ApiBase :: PARAM_TYPE => 'timestamp'
 269                         ),
 270                         'namespace' => array (
 271                                 ApiBase :: PARAM_ISMULTI => true,
 272                                 ApiBase :: PARAM_TYPE => 'namespace'
 273                         ),
 274                         'user' => array(
 275                                 ApiBase :: PARAM_TYPE => 'user',
 276                         ),
 277                         'excludeuser' => array(
 278                                 ApiBase :: PARAM_TYPE => 'user',
 279                         ),
 280                         'dir' => array (
 281                                 ApiBase :: PARAM_DFLT => 'older',
 282                                 ApiBase :: PARAM_TYPE => array (
 283                                         'newer',
 284                                         'older'
 285                                 )
 286                         ),
 287                         'limit' => array (
 288                                 ApiBase :: PARAM_DFLT => 10,
 289                                 ApiBase :: PARAM_TYPE => 'limit',
 290                                 ApiBase :: PARAM_MIN => 1,
 291                                 ApiBase :: PARAM_MAX => ApiBase :: LIMIT_BIG1,
 292                                 ApiBase :: PARAM_MAX2 => ApiBase :: LIMIT_BIG2
 293                         ),
 294                         'prop' => array (
 295                                 APIBase :: PARAM_ISMULTI => true,
 296                                 APIBase :: PARAM_DFLT => 'ids|title|flags',
 297                                 APIBase :: PARAM_TYPE => array (
 298                                         'ids',
 299                                         'title',
 300                                         'flags',
 301                                         'user',
 302                                         'comment',
 303                                         'timestamp',
 304                                         'patrol',
 305                                         'sizes',
 306                                 )
 307                         ),
 308                         'show' => array (
 309                                 ApiBase :: PARAM_ISMULTI => true,
 310                                 ApiBase :: PARAM_TYPE => array (
 311                                         'minor',
 312                                         '!minor',
 313                                         'bot',
 314                                         '!bot',
 315                                         'anon',
 316                                         '!anon',
 317                                         'patrolled',
 318                                         '!patrolled',
 319                                 )
 320                         )
 321                 );
 322         }
 323
 324         public function getParamDescription() {
 325                 return array (
 326                         'allrev' => 'Include multiple revisions of the same page within given timeframe.',
 327                         'start' => 'The timestamp to start enumerating from.',
 328                         'end' => 'The timestamp to end enumerating.',
 329                         'namespace' => 'Filter changes to only the given namespace(s).',
 330                         'user' => 'Only list changes by this user',
 331                         'excludeuser' => 'Don\'t list changes by this user',
 332                         'dir' => 'In which direction to enumerate pages.',
 333                         'limit' => 'How many total results to return per request.',
 334                         'prop' => 'Which additional items to get (non-generator mode only).',
 335                         'show' => array (
 336                                 'Show only items that meet this criteria.',
 337                                 'For example, to see only minor edits done by logged-in users, set show=minor|!anon'
 338                         )
 339                 );
 340         }
 341
 342         public function getDescription() {
 343                 return "Get all recent changes to pages in the logged in user's watchlist";
 344         }
 345
 346         protected function getExamples() {
 347                 return array (
 348                         'api.php?action=query&list=watchlist',
 349                         'api.php?action=query&list=watchlist&wlprop=ids|title|timestamp|user|comment',
 350                         'api.php?action=query&list=watchlist&wlallrev&wlprop=ids|title|timestamp|user|comment',
 351                         'api.php?action=query&generator=watchlist&prop=info',
 352                         'api.php?action=query&generator=watchlist&gwlallrev&prop=revisions&rvprop=timestamp|user'
 353                 );
 354         }
 355
 356         public function getVersion() {
 357                 return __CLASS__ . ': $Id$';
 358         }
 359 }