Fixes for fixme comments on my r59655
[lhc/web/wiklou.git] / includes / api / ApiQueryWatchlist.php
index a70ea49..4c8de69 100644 (file)
@@ -56,15 +56,26 @@ class ApiQueryWatchlist extends ApiQueryGeneratorBase {
 
                $this->selectNamedDB('watchlist', DB_SLAVE, 'watchlist');
 
-               if (!$wgUser->isLoggedIn())
-                       $this->dieUsage('You must be logged-in to have a watchlist', 'notloggedin');
+               $params = $this->extractRequestParams();
 
-               $allrev = $start = $end = $namespace = $dir = $limit = $prop = $show = null;
-               extract($this->extractRequestParams());
+               if (!is_null($params['owner']) && !is_null($params['token'])) {
+                       $user = User::newFromName($params['owner'],false);
+                       if( !$user->getId() ) {
+                               $this->dieUsage( 'Specified user does not exist', 'bad_wlowner' );
+                       }
+                       $token = $user->getOption('watchlisttoken');
+                       if ($token == '' || $token != $params['token']) {
+                               $this->dieUsage('Incorrect watchlist token provided -- please set a correct token in Special:Preferences', 'bad_wltoken');
+                       }
+               } elseif (!$wgUser->isLoggedIn()) {
+                       $this->dieUsage('You must be logged-in to have a watchlist', 'notloggedin');
+               } else {
+                       $user = $wgUser;
+               }
 
-               if (!is_null($prop) && is_null($resultPageSet)) {
+               if (!is_null($params['prop']) && is_null($resultPageSet)) {
 
-                       $prop = array_flip($prop);
+                       $prop = array_flip($params['prop']);
 
                        $this->fld_ids = isset($prop['ids']);
                        $this->fld_title = isset($prop['title']);
@@ -76,8 +87,7 @@ class ApiQueryWatchlist extends ApiQueryGeneratorBase {
                        $this->fld_patrol = isset($prop['patrol']);
 
                        if ($this->fld_patrol) {
-                               global $wgUser;
-                               if (!$wgUser->useRCPatrol() && !$wgUser->useNPPatrol())
+                               if (!$user->useRCPatrol() && !$user->useNPPatrol())
                                        $this->dieUsage('patrol property is not available', 'patrol');
                        }
                }
@@ -93,6 +103,7 @@ class ApiQueryWatchlist extends ApiQueryGeneratorBase {
 
                        $this->addFieldsIf('rc_new', $this->fld_flags);
                        $this->addFieldsIf('rc_minor', $this->fld_flags);
+                       $this->addFieldsIf('rc_bot', $this->fld_flags);
                        $this->addFieldsIf('rc_user', $this->fld_user);
                        $this->addFieldsIf('rc_user_text', $this->fld_user);
                        $this->addFieldsIf('rc_comment', $this->fld_comment);
@@ -100,7 +111,7 @@ class ApiQueryWatchlist extends ApiQueryGeneratorBase {
                        $this->addFieldsIf('rc_old_len', $this->fld_sizes);
                        $this->addFieldsIf('rc_new_len', $this->fld_sizes);
                }
-               elseif ($allrev) {
+               elseif ($params['allrev']) {
                        $this->addFields(array (
                                'rc_this_oldid',
                                'rc_namespace',
@@ -122,7 +133,7 @@ class ApiQueryWatchlist extends ApiQueryGeneratorBase {
                        'recentchanges'
                ));
 
-               $userId = $wgUser->getId();
+               $userId = $user->getId();
                $this->addWhere(array (
                        'wl_namespace = rc_namespace',
                        'wl_title = rc_title',
@@ -131,12 +142,12 @@ class ApiQueryWatchlist extends ApiQueryGeneratorBase {
                        'rc_deleted' => 0,
                ));
 
-               $this->addWhereRange('rc_timestamp', $dir, $start, $end);
-               $this->addWhereFld('wl_namespace', $namespace);
-               $this->addWhereIf('rc_this_oldid=page_latest', !$allrev);
+               $this->addWhereRange('rc_timestamp', $params['dir'], $params['start'], $params['end']);
+               $this->addWhereFld('wl_namespace', $params['namespace']);
+               $this->addWhereIf('rc_this_oldid=page_latest', !$params['allrev']);
 
-               if (!is_null($show)) {
-                       $show = array_flip($show);
+               if (!is_null($params['show'])) {
+                       $show = array_flip($params['show']);
 
                        /* Check for conflicting parameters. */
                        if ((isset ($show['minor']) && isset ($show['!minor']))
@@ -147,7 +158,8 @@ class ApiQueryWatchlist extends ApiQueryGeneratorBase {
                                $this->dieUsage("Incorrect parameter - mutually exclusive values may not be supplied", 'show');
                        }
                        
-                       // Check permissions
+                       // Check permissions.  FIXME: should this check $user instead of
+                       // $wgUser?
                        global $wgUser;
                        if((isset($show['patrolled']) || isset($show['!patrolled'])) && !$wgUser->useRCPatrol() && !$wgUser->useNPPatrol())
                                $this->dieUsage("You need the patrol right to request the patrolled flag", 'permissiondenied');
@@ -163,19 +175,26 @@ class ApiQueryWatchlist extends ApiQueryGeneratorBase {
                        $this->addWhereIf('rc_patrolled != 0', isset($show['patrolled']));                      
                }
 
+               if(!is_null($params['user']) && !is_null($params['excludeuser']))
+                       $this->dieUsage('user and excludeuser cannot be used together', 'user-excludeuser');
+               if(!is_null($params['user']))
+                       $this->addWhereFld('rc_user_text', $params['user']);
+               if(!is_null($params['excludeuser']))
+                       $this->addWhere('rc_user_text != ' . $this->getDB()->addQuotes($params['excludeuser']));
+
 
                # This is an index optimization for mysql, as done in the Special:Watchlist page
-               $this->addWhereIf("rc_timestamp > ''", !isset ($start) && !isset ($end) && $wgDBtype == 'mysql');
+               $this->addWhereIf("rc_timestamp > ''", !isset ($params['start']) && !isset ($params['end']) && $wgDBtype == 'mysql');
 
-               $this->addOption('LIMIT', $limit +1);
+               $this->addOption('LIMIT', $params['limit'] +1);
 
-               $data = array ();
+               $ids = array ();
                $count = 0;
                $res = $this->select(__METHOD__);
 
                $db = $this->getDB();
                while ($row = $db->fetchObject($res)) {
-                       if (++ $count > $limit) {
+                       if (++ $count > $params['limit']) {
                                // We've reached the one extra which shows that there are additional pages to be had. Stop here...
                                $this->setContinueEnumParameter('start', wfTimestamp(TS_ISO_8601, $row->rc_timestamp));
                                break;
@@ -183,13 +202,18 @@ class ApiQueryWatchlist extends ApiQueryGeneratorBase {
 
                        if (is_null($resultPageSet)) {
                                $vals = $this->extractRowInfo($row);
-                               if ($vals)
-                                       $data[] = $vals;
+                               $fit = $this->getResult()->addValue(array('query', $this->getModuleName()), null, $vals);
+                               if(!$fit)
+                               {
+                                       $this->setContinueEnumParameter('start',
+                                                       wfTimestamp(TS_ISO_8601, $row->rc_timestamp));
+                                       break;
+                               }
                        } else {
-                               if ($allrev) {
-                                       $data[] = intval($row->rc_this_oldid);
+                               if ($params['allrev']) {
+                                       $ids[] = intval($row->rc_this_oldid);
                                } else {
-                                       $data[] = intval($row->rc_cur_id);
+                                       $ids[] = intval($row->rc_cur_id);
                                }
                        }
                }
@@ -197,13 +221,12 @@ class ApiQueryWatchlist extends ApiQueryGeneratorBase {
                $db->freeResult($res);
 
                if (is_null($resultPageSet)) {
-                       $this->getResult()->setIndexedTagName($data, 'item');
-                       $this->getResult()->addValue('query', $this->getModuleName(), $data);
+                       $this->getResult()->setIndexedTagName_internal(array('query', $this->getModuleName()), 'item');
                }
-               elseif ($allrev) {
-                       $resultPageSet->populateFromRevisionIDs($data);
+               elseif ($params['allrev']) {
+                       $resultPageSet->populateFromRevisionIDs($ids);
                } else {
-                       $resultPageSet->populateFromPageIDs($data);
+                       $resultPageSet->populateFromPageIDs($ids);
                }
        }
 
@@ -230,6 +253,8 @@ class ApiQueryWatchlist extends ApiQueryGeneratorBase {
                                $vals['new'] = '';
                        if ($row->rc_minor)
                                $vals['minor'] = '';
+                       if ($row->rc_bot)
+                               $vals['bot'] = '';
                }
 
                if ($this->fld_patrol && isset($row->rc_patrolled))
@@ -238,8 +263,6 @@ class ApiQueryWatchlist extends ApiQueryGeneratorBase {
                if ($this->fld_timestamp)
                        $vals['timestamp'] = wfTimestamp(TS_ISO_8601, $row->rc_timestamp);
 
-                       $this->addFieldsIf('rc_new_len', $this->fld_sizes);
-
                if ($this->fld_sizes) {
                        $vals['oldlen'] = intval($row->rc_old_len);
                        $vals['newlen'] = intval($row->rc_new_len);
@@ -264,6 +287,12 @@ class ApiQueryWatchlist extends ApiQueryGeneratorBase {
                                ApiBase :: PARAM_ISMULTI => true,
                                ApiBase :: PARAM_TYPE => 'namespace'
                        ),
+                       'user' => array(
+                               ApiBase :: PARAM_TYPE => 'user',
+                       ),
+                       'excludeuser' => array(
+                               ApiBase :: PARAM_TYPE => 'user',
+                       ),
                        'dir' => array (
                                ApiBase :: PARAM_DFLT => 'older',
                                ApiBase :: PARAM_TYPE => array (
@@ -304,6 +333,12 @@ class ApiQueryWatchlist extends ApiQueryGeneratorBase {
                                        'patrolled',
                                        '!patrolled',
                                )
+                       ),
+                       'owner' => array (
+                               ApiBase :: PARAM_TYPE => 'user'
+                       ),
+                       'token' => array (
+                               ApiBase :: PARAM_TYPE => 'string'
                        )
                );
        }
@@ -314,13 +349,17 @@ class ApiQueryWatchlist extends ApiQueryGeneratorBase {
                        'start' => 'The timestamp to start enumerating from.',
                        'end' => 'The timestamp to end enumerating.',
                        'namespace' => 'Filter changes to only the given namespace(s).',
+                       'user' => 'Only list changes by this user',
+                       'excludeuser' => 'Don\'t list changes by this user',
                        'dir' => 'In which direction to enumerate pages.',
                        'limit' => 'How many total results to return per request.',
                        'prop' => 'Which additional items to get (non-generator mode only).',
                        'show' => array (
                                'Show only items that meet this criteria.',
                                'For example, to see only minor edits done by logged-in users, set show=minor|!anon'
-                       )
+                       ),
+                       'owner' => "The name of the user whose watchlist you'd like to access",
+                       'token' => "Give a security token (settable in preferences) to allow access to another user's watchlist"
                );
        }
 
@@ -334,7 +373,8 @@ class ApiQueryWatchlist extends ApiQueryGeneratorBase {
                        'api.php?action=query&list=watchlist&wlprop=ids|title|timestamp|user|comment',
                        'api.php?action=query&list=watchlist&wlallrev&wlprop=ids|title|timestamp|user|comment',
                        'api.php?action=query&generator=watchlist&prop=info',
-                       'api.php?action=query&generator=watchlist&gwlallrev&prop=revisions&rvprop=timestamp|user'
+                       'api.php?action=query&generator=watchlist&gwlallrev&prop=revisions&rvprop=timestamp|user',
+                       'api.php?action=query&list=watchlist&wlowner=Bob_Smith&wltoken=d8d562e9725ea1512894cdab28e5ceebc7f20237'
                );
        }