update to MediaWiki 1.17.0

1 files changed, 148 insertions, 121 deletions

diff --git a/includes/api/ApiQueryWatchlist.php b/includes/api/ApiQueryWatchlist.php
index caac0706..784f89c0 100644
--- a/includes/api/ApiQueryWatchlist.php
+++ b/includes/api/ApiQueryWatchlist.php
@@ -1,11 +1,10 @@
 <?php
-
-/*
- * Created on Sep 25, 2006
- *
+/**
  * API for MediaWiki 1.8+
  *
- * Copyright (C) 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
+ * Created on Sep 25, 2006
+ *
+ * Copyright © 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -19,13 +18,15 @@
  *
  * You should have received a copy of the GNU General Public License along
  * with this program; if not, write to the Free Software Foundation, Inc.,
- * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
  */
 
 if ( !defined( 'MEDIAWIKI' ) ) {
 	// Eclipse helper - will be ignored in production
-	require_once ( 'ApiQueryBase.php' );
+	require_once( 'ApiQueryBase.php' );
 }
 
 /**
@@ -37,7 +38,7 @@ if ( !defined( 'MEDIAWIKI' ) ) {
 class ApiQueryWatchlist extends ApiQueryGeneratorBase {
 
 	public function __construct( $query, $moduleName ) {
-		parent :: __construct( $query, $moduleName, 'wl' );
+		parent::__construct( $query, $moduleName, 'wl' );
 	}
 
 	public function execute() {
@@ -50,38 +51,23 @@ class ApiQueryWatchlist extends ApiQueryGeneratorBase {
 
 	private $fld_ids = false, $fld_title = false, $fld_patrol = false, $fld_flags = false,
 			$fld_timestamp = false, $fld_user = false, $fld_comment = false, $fld_parsedcomment = false, $fld_sizes = false,
-			$fld_notificationtimestamp = false;
+			$fld_notificationtimestamp = false, $fld_userid = false;
 
 	private function run( $resultPageSet = null ) {
-		global $wgUser;
-
 		$this->selectNamedDB( 'watchlist', DB_SLAVE, 'watchlist' );
 
 		$params = $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;
-		}
+		$user = $this->getWatchlistUser( $params );
 
 		if ( !is_null( $params['prop'] ) && is_null( $resultPageSet ) ) {
-
 			$prop = array_flip( $params['prop'] );
 
 			$this->fld_ids = isset( $prop['ids'] );
 			$this->fld_title = isset( $prop['title'] );
 			$this->fld_flags = isset( $prop['flags'] );
 			$this->fld_user = isset( $prop['user'] );
+			$this->fld_userid = isset( $prop['userid'] );
 			$this->fld_comment = isset( $prop['comment'] );
 			$this->fld_parsedcomment = isset ( $prop['parsedcomment'] );
 			$this->fld_timestamp = isset( $prop['timestamp'] );
@@ -90,19 +76,20 @@ class ApiQueryWatchlist extends ApiQueryGeneratorBase {
 			$this->fld_notificationtimestamp = isset( $prop['notificationtimestamp'] );
 
 			if ( $this->fld_patrol ) {
-				if ( !$user->useRCPatrol() && !$user->useNPPatrol() )
+				if ( !$user->useRCPatrol() && !$user->useNPPatrol() ) {
 					$this->dieUsage( 'patrol property is not available', 'patrol' );
+				}
 			}
 		}
-	
-		$this->addFields( array (
+
+		$this->addFields( array(
 			'rc_namespace',
 			'rc_title',
 			'rc_timestamp'
 		) );
 
 		if ( is_null( $resultPageSet ) ) {
-			$this->addFields( array (
+			$this->addFields( array(
 				'rc_cur_id',
 				'rc_this_oldid'
 			) );
@@ -110,7 +97,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', $this->fld_user || $this->fld_userid );
 			$this->addFieldsIf( 'rc_user_text', $this->fld_user );
 			$this->addFieldsIf( 'rc_comment', $this->fld_comment || $this->fld_parsedcomment );
 			$this->addFieldsIf( 'rc_patrolled', $this->fld_patrol );
@@ -123,22 +110,26 @@ class ApiQueryWatchlist extends ApiQueryGeneratorBase {
 			$this->addFields( 'rc_cur_id' );
 		}
 
-		$this->addTables( array (
+		$this->addTables( array(
 			'watchlist',
 			'page',
 			'recentchanges'
 		) );
 
 		$userId = $user->getId();
-		$this->addWhere( array (
+		$this->addWhere( array(
 			'wl_namespace = rc_namespace',
 			'wl_title = rc_title',
 			'rc_cur_id = page_id',
 			'wl_user' => $userId,
 			'rc_deleted' => 0,
 		) );
+		
+		$db = $this->getDB();
 
-		$this->addWhereRange( 'rc_timestamp', $params['dir'], $params['start'], $params['end'] );
+		$this->addWhereRange( 'rc_timestamp', $params['dir'], 
+			$db->timestamp( $params['start'] ), 
+			$db->timestamp( $params['end'] ) );
 		$this->addWhereFld( 'wl_namespace', $params['namespace'] );
 		$this->addWhereIf( 'rc_this_oldid=page_latest', !$params['allrev'] );
 
@@ -149,45 +140,53 @@ class ApiQueryWatchlist extends ApiQueryGeneratorBase {
 			if ( ( isset ( $show['minor'] ) && isset ( $show['!minor'] ) )
 					|| ( isset ( $show['bot'] ) && isset ( $show['!bot'] ) )
 					|| ( isset ( $show['anon'] ) && isset ( $show['!anon'] ) )
-					|| ( isset ( $show['patrolled'] ) && isset ( $show['!patrolled'] ) ) ) {
-
+					|| ( isset ( $show['patrolled'] ) && isset ( $show['!patrolled'] ) )
+			)
+			{
 				$this->dieUsageMsg( array( 'show' ) );
 			}
-			
+
 			// Check permissions.
-			if ( ( isset( $show['patrolled'] ) || isset( $show['!patrolled'] ) ) && !$wgUser->useRCPatrol() && !$wgUser->useNPPatrol() )
-				$this->dieUsage( "You need the patrol right to request the patrolled flag", 'permissiondenied' );
+			if ( isset( $show['patrolled'] ) || isset( $show['!patrolled'] ) ) {
+				global $wgUser;
+				if ( !$wgUser->useRCPatrol() && !$wgUser->useNPPatrol() ) {
+					$this->dieUsage( 'You need the patrol right to request the patrolled flag', 'permissiondenied' );
+				}
+			}
 
 			/* Add additional conditions to query depending upon parameters. */
-			$this->addWhereIf( 'rc_minor = 0', isset ( $show['!minor'] ) );
-			$this->addWhereIf( 'rc_minor != 0', isset ( $show['minor'] ) );
-			$this->addWhereIf( 'rc_bot = 0', isset ( $show['!bot'] ) );
-			$this->addWhereIf( 'rc_bot != 0', isset ( $show['bot'] ) );
-			$this->addWhereIf( 'rc_user = 0', isset ( $show['anon'] ) );
-			$this->addWhereIf( 'rc_user != 0', isset ( $show['!anon'] ) );
+			$this->addWhereIf( 'rc_minor = 0', isset( $show['!minor'] ) );
+			$this->addWhereIf( 'rc_minor != 0', isset( $show['minor'] ) );
+			$this->addWhereIf( 'rc_bot = 0', isset( $show['!bot'] ) );
+			$this->addWhereIf( 'rc_bot != 0', isset( $show['bot'] ) );
+			$this->addWhereIf( 'rc_user = 0', isset( $show['anon'] ) );
+			$this->addWhereIf( 'rc_user != 0', isset( $show['!anon'] ) );
 			$this->addWhereIf( 'rc_patrolled = 0', isset( $show['!patrolled'] ) );
 			$this->addWhereIf( 'rc_patrolled != 0', isset( $show['patrolled'] ) );
 		}
 
-		if ( !is_null( $params['user'] ) && !is_null( $params['excludeuser'] ) )
+		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'] ) )
+		}
+		if ( !is_null( $params['user'] ) ) {
 			$this->addWhereFld( 'rc_user_text', $params['user'] );
-		if ( !is_null( $params['excludeuser'] ) )
+		}
+		if ( !is_null( $params['excludeuser'] ) ) {
 			$this->addWhere( 'rc_user_text != ' . $this->getDB()->addQuotes( $params['excludeuser'] ) );
+		}
+
+		
 
-		$db = $this->getDB();
-			
 		// This is an index optimization for mysql, as done in the Special:Watchlist page
-		$this->addWhereIf( "rc_timestamp > ''", !isset ( $params['start'] ) && !isset ( $params['end'] ) && $db->getType() == 'mysql' );
+		$this->addWhereIf( "rc_timestamp > ''", !isset( $params['start'] ) && !isset( $params['end'] ) && $db->getType() == 'mysql' );
 
 		$this->addOption( 'LIMIT', $params['limit'] + 1 );
 
-		$ids = array ();
+		$ids = array();
 		$count = 0;
 		$res = $this->select( __METHOD__ );
 
-		while ( $row = $db->fetchObject( $res ) ) {
+		foreach ( $res as $row ) {
 			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 ) );
@@ -197,8 +196,7 @@ class ApiQueryWatchlist extends ApiQueryGeneratorBase {
 			if ( is_null( $resultPageSet ) ) {
 				$vals = $this->extractRowInfo( $row );
 				$fit = $this->getResult()->addValue( array( 'query', $this->getModuleName() ), null, $vals );
-				if ( !$fit )
-				{
+				if ( !$fit ) {
 					$this->setContinueEnumParameter( 'start',
 							wfTimestamp( TS_ISO_8601, $row->rc_timestamp ) );
 					break;
@@ -212,12 +210,9 @@ class ApiQueryWatchlist extends ApiQueryGeneratorBase {
 			}
 		}
 
-		$db->freeResult( $res );
-
 		if ( is_null( $resultPageSet ) ) {
 			$this->getResult()->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'item' );
-		}
-		elseif ( $params['allrev'] ) {
+		} elseif ( $params['allrev'] ) {
 			$resultPageSet->populateFromRevisionIDs( $ids );
 		} else {
 			$resultPageSet->populateFromPageIDs( $ids );
@@ -225,8 +220,7 @@ class ApiQueryWatchlist extends ApiQueryGeneratorBase {
 	}
 
 	private function extractRowInfo( $row ) {
-
-		$vals = array ();
+		$vals = array();
 
 		if ( $this->fld_ids ) {
 			$vals['pageid'] = intval( $row->rc_cur_id );
@@ -235,41 +229,60 @@ class ApiQueryWatchlist extends ApiQueryGeneratorBase {
 
 		$title = Title::makeTitle( $row->rc_namespace, $row->rc_title );
 
-		if ( $this->fld_title )
+		if ( $this->fld_title ) {
 			ApiQueryBase::addTitleInfo( $vals, $title );
+		}
 
-		if ( $this->fld_user ) {
-			$vals['user'] = $row->rc_user_text;
-			if ( !$row->rc_user )
+		if ( $this->fld_user || $this->fld_userid ) {
+
+			if ( $this->fld_user ) {
+				$vals['user'] = $row->rc_user_text;
+			}
+
+			if ( $this->fld_userid ) {
+				$vals['user'] = $row->rc_user;	
+			}
+
+			if ( !$row->rc_user ) {
 				$vals['anon'] = '';
+			}
 		}
 
 		if ( $this->fld_flags ) {
-			if ( $row->rc_new )
+			if ( $row->rc_new ) {
 				$vals['new'] = '';
-			if ( $row->rc_minor )
+			}
+			if ( $row->rc_minor ) {
 				$vals['minor'] = '';
-			if ( $row->rc_bot )
+			}
+			if ( $row->rc_bot ) {
 				$vals['bot'] = '';
+			}
 		}
 
-		if ( $this->fld_patrol && isset( $row->rc_patrolled ) )
+		if ( $this->fld_patrol && isset( $row->rc_patrolled ) ) {
 			$vals['patrolled'] = '';
+		}
 
-		if ( $this->fld_timestamp )
+		if ( $this->fld_timestamp ) {
 			$vals['timestamp'] = wfTimestamp( TS_ISO_8601, $row->rc_timestamp );
+		}
 
 		if ( $this->fld_sizes ) {
 			$vals['oldlen'] = intval( $row->rc_old_len );
 			$vals['newlen'] = intval( $row->rc_new_len );
 		}
-		
-		if ( $this->fld_notificationtimestamp )
-			$vals['notificationtimestamp'] = ( $row->wl_notificationtimestamp == null ) ? '' : wfTimestamp( TS_ISO_8601, $row->wl_notificationtimestamp );
 
-		if ( $this->fld_comment && isset( $row->rc_comment ) )
+		if ( $this->fld_notificationtimestamp ) {
+			$vals['notificationtimestamp'] = ( $row->wl_notificationtimestamp == null )
+				? ''
+				: wfTimestamp( TS_ISO_8601, $row->wl_notificationtimestamp );
+		}
+
+		if ( $this->fld_comment && isset( $row->rc_comment ) ) {
 			$vals['comment'] = $row->rc_comment;
-			
+		}
+
 		if ( $this->fld_parsedcomment && isset( $row->rc_comment ) ) {
 			global $wgUser;
 			$vals['parsedcomment'] = $wgUser->getSkin()->formatComment( $row->rc_comment, $title );
@@ -279,46 +292,47 @@ class ApiQueryWatchlist extends ApiQueryGeneratorBase {
 	}
 
 	public function getAllowedParams() {
-		return array (
+		return array(
 			'allrev' => false,
-			'start' => array (
-				ApiBase :: PARAM_TYPE => 'timestamp'
+			'start' => array(
+				ApiBase::PARAM_TYPE => 'timestamp'
 			),
-			'end' => array (
-				ApiBase :: PARAM_TYPE => 'timestamp'
+			'end' => array(
+				ApiBase::PARAM_TYPE => 'timestamp'
 			),
 			'namespace' => array (
-				ApiBase :: PARAM_ISMULTI => true,
-				ApiBase :: PARAM_TYPE => 'namespace'
+				ApiBase::PARAM_ISMULTI => true,
+				ApiBase::PARAM_TYPE => 'namespace'
 			),
 			'user' => array(
-				ApiBase :: PARAM_TYPE => 'user',
+				ApiBase::PARAM_TYPE => 'user',
 			),
 			'excludeuser' => array(
-				ApiBase :: PARAM_TYPE => 'user',
+				ApiBase::PARAM_TYPE => 'user',
 			),
-			'dir' => array (
-				ApiBase :: PARAM_DFLT => 'older',
-				ApiBase :: PARAM_TYPE => array (
+			'dir' => array(
+				ApiBase::PARAM_DFLT => 'older',
+				ApiBase::PARAM_TYPE => array(
 					'newer',
 					'older'
 				)
 			),
-			'limit' => array (
-				ApiBase :: PARAM_DFLT => 10,
-				ApiBase :: PARAM_TYPE => 'limit',
-				ApiBase :: PARAM_MIN => 1,
-				ApiBase :: PARAM_MAX => ApiBase :: LIMIT_BIG1,
-				ApiBase :: PARAM_MAX2 => ApiBase :: LIMIT_BIG2
+			'limit' => array(
+				ApiBase::PARAM_DFLT => 10,
+				ApiBase::PARAM_TYPE => 'limit',
+				ApiBase::PARAM_MIN => 1,
+				ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
+				ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
 			),
-			'prop' => array (
-				APIBase :: PARAM_ISMULTI => true,
-				APIBase :: PARAM_DFLT => 'ids|title|flags',
-				APIBase :: PARAM_TYPE => array (
+			'prop' => array(
+				ApiBase::PARAM_ISMULTI => true,
+				ApiBase::PARAM_DFLT => 'ids|title|flags',
+				ApiBase::PARAM_TYPE => array(
 					'ids',
 					'title',
 					'flags',
 					'user',
+					'userid',
 					'comment',
 					'parsedcomment',
 					'timestamp',
@@ -327,9 +341,9 @@ class ApiQueryWatchlist extends ApiQueryGeneratorBase {
 					'notificationtimestamp'
 				)
 			),
-			'show' => array (
-				ApiBase :: PARAM_ISMULTI => true,
-				ApiBase :: PARAM_TYPE => array (
+			'show' => array(
+				ApiBase::PARAM_ISMULTI => true,
+				ApiBase::PARAM_TYPE => array(
 					'minor',
 					'!minor',
 					'bot',
@@ -340,39 +354,52 @@ class ApiQueryWatchlist extends ApiQueryGeneratorBase {
 					'!patrolled',
 				)
 			),
-			'owner' => array (
-				ApiBase :: PARAM_TYPE => 'user'
+			'owner' => array(
+				ApiBase::PARAM_TYPE => 'user'
 			),
-			'token' => array (
-				ApiBase :: PARAM_TYPE => 'string'
+			'token' => array(
+				ApiBase::PARAM_TYPE => 'string'
 			)
 		);
 	}
 
 	public function getParamDescription() {
-		return array (
-			'allrev' => 'Include multiple revisions of the same page within given timeframe.',
-			'start' => 'The timestamp to start enumerating from.',
-			'end' => 'The timestamp to end enumerating.',
-			'namespace' => 'Filter changes to only the given namespace(s).',
+		return array(
+			'allrev' => 'Include multiple revisions of the same page within given timeframe',
+			'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 (
+			'dir' => 'In which direction to enumerate pages',
+			'limit' => 'How many total results to return per request',
+			'prop' => array(
+				'Which additional items to get (non-generator mode only).',
+				' ids                    - Adds revision ids and page ids',
+				' title                  - Adds title of the page',
+				' flags                  - Adds flags for the edit',
+				' user                   - Adds the user who made the edit',
+				' userid                 - Adds user id of whom made the edit',
+				' comment                - Adds comment of the edit',
+				' parsedcomment          - Adds parsed comment of the edit',
+				' timestamp              - Adds timestamp of the edit',
+				' patrol                 - Tags edits that are patrolled',
+				' size                   - Adds the old and new lengths of the page',
+				' notificationtimestamp  - Adds timestamp of when the user was last notified about the edit',
+			),
+			'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'
+				"For example, to see only minor edits done by logged-in users, set {$this->getModulePrefix()}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"
+			'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'
 		);
 	}
 
 	public function getDescription() {
 		return "Get all recent changes to pages in the logged in user's watchlist";
 	}
-	
+
 	public function getPossibleErrors() {
 		return array_merge( parent::getPossibleErrors(), array(
 			array( 'code' => 'bad_wlowner', 'info' => 'Specified user does not exist' ),
@@ -386,17 +413,17 @@ class ApiQueryWatchlist extends ApiQueryGeneratorBase {
 	}
 
 	protected function getExamples() {
-		return array (
+		return array(
 			'api.php?action=query&list=watchlist',
 			'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&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'
 		);
 	}
 
 	public function getVersion() {
-		return __CLASS__ . ': $Id: ApiQueryWatchlist.php 69932 2010-07-26 08:03:21Z tstarling $';
+		return __CLASS__ . ': $Id: ApiQueryWatchlist.php 85435 2011-04-05 14:00:08Z demon $';
 	}
 }