From 9db190c7e736ec8d063187d4241b59feaf7dc2d1 Mon Sep 17 00:00:00 2001 From: Pierre Schmitz Date: Wed, 22 Jun 2011 11:28:20 +0200 Subject: update to MediaWiki 1.17.0 --- includes/api/ApiQueryWatchlistRaw.php | 135 +++++++++++++++++++--------------- 1 file changed, 75 insertions(+), 60 deletions(-) (limited to 'includes/api/ApiQueryWatchlistRaw.php') diff --git a/includes/api/ApiQueryWatchlistRaw.php b/includes/api/ApiQueryWatchlistRaw.php index 42d4005b..0e5617e3 100644 --- a/includes/api/ApiQueryWatchlistRaw.php +++ b/includes/api/ApiQueryWatchlistRaw.php @@ -1,11 +1,10 @@ .@home.nl + * Created on Oct 4, 2008 + * + * Copyright © 2008 Roan Kattouw .@home.nl * * 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 ApiQueryWatchlistRaw extends ApiQueryGeneratorBase { public function __construct( $query, $moduleName ) { - parent :: __construct( $query, $moduleName, 'wr' ); + parent::__construct( $query, $moduleName, 'wr' ); } public function execute() { @@ -49,54 +50,54 @@ class ApiQueryWatchlistRaw extends ApiQueryGeneratorBase { } private function run( $resultPageSet = null ) { - global $wgUser; - $this->selectNamedDB( 'watchlist', DB_SLAVE, 'watchlist' ); - if ( !$wgUser->isLoggedIn() ) - $this->dieUsage( 'You must be logged-in to have a watchlist', 'notloggedin' ); $params = $this->extractRequestParams(); + + $user = $this->getWatchlistUser( $params ); + $prop = array_flip( (array)$params['prop'] ); $show = array_flip( (array)$params['show'] ); - if ( isset( $show['changed'] ) && isset( $show['!changed'] ) ) + if ( isset( $show['changed'] ) && isset( $show['!changed'] ) ) { $this->dieUsageMsg( array( 'show' ) ); + } $this->addTables( 'watchlist' ); $this->addFields( array( 'wl_namespace', 'wl_title' ) ); $this->addFieldsIf( 'wl_notificationtimestamp', isset( $prop['changed'] ) ); - $this->addWhereFld( 'wl_user', $wgUser->getId() ); + $this->addWhereFld( 'wl_user', $user->getId() ); $this->addWhereFld( 'wl_namespace', $params['namespace'] ); $this->addWhereIf( 'wl_notificationtimestamp IS NOT NULL', isset( $show['changed'] ) ); $this->addWhereIf( 'wl_notificationtimestamp IS NULL', isset( $show['!changed'] ) ); - if ( isset( $params['continue'] ) ) - { + if ( isset( $params['continue'] ) ) { $cont = explode( '|', $params['continue'] ); - if ( count( $cont ) != 2 ) + if ( count( $cont ) != 2 ) { $this->dieUsage( "Invalid continue param. You should pass the " . "original value returned by the previous query", "_badcontinue" ); + } $ns = intval( $cont[0] ); $title = $this->getDB()->strencode( $this->titleToKey( $cont[1] ) ); - $this->addWhere( "wl_namespace > '$ns' OR " . - "(wl_namespace = '$ns' AND " . - "wl_title >= '$title')" ); + $this->addWhere( + "wl_namespace > '$ns' OR " . + "(wl_namespace = '$ns' AND " . + "wl_title >= '$title')" + ); } // Don't ORDER BY wl_namespace if it's constant in the WHERE clause - if ( count( $params['namespace'] ) == 1 ) + if ( count( $params['namespace'] ) == 1 ) { $this->addOption( 'ORDER BY', 'wl_title' ); - else + } else { $this->addOption( 'ORDER BY', 'wl_namespace, wl_title' ); + } $this->addOption( 'LIMIT', $params['limit'] + 1 ); $res = $this->select( __METHOD__ ); - - $db = $this->getDB(); + $titles = array(); $count = 0; - while ( $row = $db->fetchObject( $res ) ) - { - if ( ++$count > $params['limit'] ) - { + 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( 'continue', $row->wl_namespace . '|' . $this->keyToTitle( $row->wl_title ) ); @@ -104,88 +105,102 @@ class ApiQueryWatchlistRaw extends ApiQueryGeneratorBase { } $t = Title::makeTitle( $row->wl_namespace, $row->wl_title ); - if ( is_null( $resultPageSet ) ) - { + if ( is_null( $resultPageSet ) ) { $vals = array(); ApiQueryBase::addTitleInfo( $vals, $t ); if ( isset( $prop['changed'] ) && !is_null( $row->wl_notificationtimestamp ) ) + { $vals['changed'] = wfTimestamp( TS_ISO_8601, $row->wl_notificationtimestamp ); + } $fit = $this->getResult()->addValue( $this->getModuleName(), null, $vals ); - if ( !$fit ) - { + if ( !$fit ) { $this->setContinueEnumParameter( 'continue', $row->wl_namespace . '|' . $this->keyToTitle( $row->wl_title ) ); break; } - } - else + } else { $titles[] = $t; + } } - if ( is_null( $resultPageSet ) ) + if ( is_null( $resultPageSet ) ) { $this->getResult()->setIndexedTagName_internal( $this->getModuleName(), 'wr' ); - else + } else { $resultPageSet->populateFromTitles( $titles ); + } } public function getAllowedParams() { - return array ( + return array( 'continue' => null, - 'namespace' => array ( - ApiBase :: PARAM_ISMULTI => true, - ApiBase :: PARAM_TYPE => 'namespace' + 'namespace' => array( + ApiBase::PARAM_ISMULTI => true, + ApiBase::PARAM_TYPE => 'namespace' ), - '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_TYPE => array ( + 'prop' => array( + ApiBase::PARAM_ISMULTI => true, + ApiBase::PARAM_TYPE => array( 'changed', ) ), - 'show' => array ( - ApiBase :: PARAM_ISMULTI => true, - ApiBase :: PARAM_TYPE => array ( + 'show' => array( + ApiBase::PARAM_ISMULTI => true, + ApiBase::PARAM_TYPE => array( 'changed', '!changed', ) + ), + 'owner' => array( + ApiBase::PARAM_TYPE => 'user' + ), + 'token' => array( + ApiBase::PARAM_TYPE => 'string' ) ); } public function getParamDescription() { - return array ( + return array( 'continue' => 'When more results are available, use this to continue', - 'namespace' => 'Only list pages in the given namespace(s).', - 'limit' => 'How many total results to return per request.', - 'prop' => 'Which additional properties to get (non-generator mode only).', - 'show' => 'Only list items that meet these criteria.', + 'namespace' => 'Only list pages in the given namespace(s)', + 'limit' => 'How many total results to return per request', + 'prop' => array( + 'Which additional properties to get (non-generator mode only)', + ' changed - Adds timestamp of when the user was last notified about the edit', + ), + 'show' => 'Only list items that meet these criteria', + '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 pages on the logged in user's watchlist"; } - + public function getPossibleErrors() { return array_merge( parent::getPossibleErrors(), array( array( 'code' => 'notloggedin', 'info' => 'You must be logged-in to have a watchlist' ), array( 'show' ), + array( 'code' => 'bad_wlowner', 'info' => 'Specified user does not exist' ), + array( 'code' => 'bad_wltoken', 'info' => 'Incorrect watchlist token provided -- please set a correct token in Special:Preferences' ), ) ); } protected function getExamples() { - return array ( + return array( 'api.php?action=query&list=watchlistraw', 'api.php?action=query&generator=watchlistraw&gwrshow=changed&prop=revisions', ); } public function getVersion() { - return __CLASS__ . ': $Id: ApiQueryWatchlistRaw.php 69578 2010-07-20 02:46:20Z tstarling $'; + return __CLASS__ . ': $Id: ApiQueryWatchlistRaw.php 70647 2010-08-07 19:59:42Z ialex $'; } } \ No newline at end of file -- cgit v1.2.3-54-g00ecf