<?php
-
-/*
+/**
* Created on Sep 25, 2006
*
* API for MediaWiki 1.8+
*
- * Copyright (C) 2006 Yuri Astrakhan <FirstnameLastname@gmail.com>
+ * 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
*
* 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
*/
-if (!defined('MEDIAWIKI')) {
+if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
- require_once ('ApiQueryBase.php');
+ require_once( 'ApiQueryBase.php' );
}
+/**
+ * This query action allows clients to retrieve a list of recently modified pages
+ * that are part of the logged-in user's watchlist.
+ *
+ * @ingroup API
+ */
class ApiQueryWatchlist extends ApiQueryGeneratorBase {
- public function __construct($query, $moduleName) {
- parent :: __construct($query, $moduleName, 'wl');
+ public function __construct( $query, $moduleName ) {
+ parent::__construct( $query, $moduleName, 'wl' );
}
public function execute() {
$this->run();
}
- public function executeGenerator($resultPageSet) {
- $this->run($resultPageSet);
+ public function executeGenerator( $resultPageSet ) {
+ $this->run( $resultPageSet );
}
- private function run($resultPageSet = null) {
- global $wgUser;
-
- if (!$wgUser->isLoggedIn())
- $this->dieUsage('You must be logged-in to have a watchlist', 'notloggedin');
-
- $allrev = $start = $end = $namespace = $dir = $limit = $prop = null;
- extract($this->extractRequestParams());
-
- $db = $this->getDB();
-
- $dirNewer = ($dir === 'newer');
- $before = ($dirNewer ? '<=' : '>=');
- $after = ($dirNewer ? '>=' : '<=');
-
- $tables = array (
- 'watchlist',
- 'page',
- 'recentchanges'
- );
-
- $options = array (
- 'LIMIT' => $limit +1,
- 'ORDER BY' => 'rc_timestamp' . ($dirNewer ? '' : ' DESC'
- ));
-
- $patrol = $timestamp = $user = $comment = false;
- if (!is_null($prop)) {
- if (!is_null($resultPageSet))
- $this->dieUsage('prop parameter may not be used in a generator', 'params');
-
- $user = (false !== array_search('user', $prop));
- $comment = (false !== array_search('comment', $prop));
- $timestamp = (false !== array_search('timestamp', $prop));
- $patrol = (false !== array_search('patrol', $prop));
-
- if ($patrol) {
- global $wgUseRCPatrol, $wgUser;
- if (!$wgUseRCPatrol || !$wgUser->isAllowed('patrol'))
- $this->dieUsage('patrol property is not available', 'patrol');
+ 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;
+
+ private function run( $resultPageSet = null ) {
+ $this->selectNamedDB( 'watchlist', DB_SLAVE, 'watchlist' );
+
+ $params = $this->extractRequestParams();
+
+ $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_comment = isset( $prop['comment'] );
+ $this->fld_parsedcomment = isset ( $prop['parsedcomment'] );
+ $this->fld_timestamp = isset( $prop['timestamp'] );
+ $this->fld_sizes = isset( $prop['sizes'] );
+ $this->fld_patrol = isset( $prop['patrol'] );
+ $this->fld_notificationtimestamp = isset( $prop['notificationtimestamp'] );
+
+ if ( $this->fld_patrol ) {
+ if ( !$user->useRCPatrol() && !$user->useNPPatrol() ) {
+ $this->dieUsage( 'patrol property is not available', 'patrol' );
+ }
}
}
- if (is_null($resultPageSet)) {
- $fields = array (
- 'rc_cur_id AS page_id',
- 'rc_this_oldid AS rev_id',
- 'rc_namespace AS page_namespace',
- 'rc_title AS page_title',
- 'rc_new AS page_is_new',
- 'rc_minor AS rev_minor_edit'
- );
- if ($user) {
- $fields[] = 'rc_user AS rev_user';
- $fields[] = 'rc_user_text AS rev_user_text';
- }
- if ($comment)
- $fields[] = 'rc_comment AS rev_comment';
- if ($timestamp)
- $fields[] = 'rc_timestamp AS rev_timestamp';
- if ($patrol)
- $fields[] = 'rc_patrolled';
- }
- elseif ($allrev) {
- $fields = array (
- 'rc_this_oldid AS rev_id',
- 'rc_namespace AS page_namespace',
- 'rc_title AS page_title',
- 'rc_timestamp AS rev_timestamp'
- );
+ $this->addFields( array(
+ 'rc_namespace',
+ 'rc_title',
+ 'rc_timestamp'
+ ) );
+
+ if ( is_null( $resultPageSet ) ) {
+ $this->addFields( array(
+ 'rc_cur_id',
+ 'rc_this_oldid'
+ ) );
+
+ $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 || $this->fld_parsedcomment );
+ $this->addFieldsIf( 'rc_patrolled', $this->fld_patrol );
+ $this->addFieldsIf( 'rc_old_len', $this->fld_sizes );
+ $this->addFieldsIf( 'rc_new_len', $this->fld_sizes );
+ $this->addFieldsIf( 'wl_notificationtimestamp', $this->fld_notificationtimestamp );
+ } elseif ( $params['allrev'] ) {
+ $this->addFields( 'rc_this_oldid' );
} else {
- $fields = array (
- 'rc_cur_id AS page_id',
- 'rc_namespace AS page_namespace',
- 'rc_title AS page_title',
- 'rc_timestamp AS rev_timestamp'
- );
+ $this->addFields( 'rc_cur_id' );
}
- $where = array (
+ $this->addTables( array(
+ 'watchlist',
+ 'page',
+ 'recentchanges'
+ ) );
+
+ $userId = $user->getId();
+ $this->addWhere( array(
'wl_namespace = rc_namespace',
'wl_title = rc_title',
'rc_cur_id = page_id',
- 'wl_user' => $wgUser->getID());
+ 'wl_user' => $userId,
+ 'rc_deleted' => 0,
+ ) );
+
+ $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( $params['show'] ) ) {
+ $show = array_flip( $params['show'] );
+
+ /* Check for conflicting parameters. */
+ 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'] ) )
+ )
+ {
+ $this->dieUsageMsg( array( 'show' ) );
+ }
- if (!$allrev)
- $where[] = 'rc_this_oldid=page_latest';
- if (isset ($namespace))
- $where['wl_namespace'] = $namespace;
+ // Check permissions. FIXME: should this check $user instead of $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' );
+ }
- if (isset ($start))
- $where[] = 'rc_timestamp' . $after . $db->addQuotes($start);
+ /* 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_patrolled = 0', isset( $show['!patrolled'] ) );
+ $this->addWhereIf( 'rc_patrolled != 0', isset( $show['patrolled'] ) );
+ }
- if (isset ($end))
- $where[] = 'rc_timestamp' . $before . $db->addQuotes($end);
+ 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'] ) );
+ }
+
+ $db = $this->getDB();
- if (!isset ($start) && !isset ($end))
- $where[] = "rc_timestamp > ''";
+ // 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->profileDBIn();
- $res = $db->select($tables, $fields, $where, __METHOD__, $options);
- $this->profileDBOut();
+ $this->addOption( 'LIMIT', $params['limit'] + 1 );
- $data = array ();
+ $ids = array();
$count = 0;
- while ($row = $db->fetchObject($res)) {
- if (++ $count > $limit) {
+ $res = $this->select( __METHOD__ );
+
+ 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('from', $row->rev_timestamp);
+ $this->setContinueEnumParameter( 'start', wfTimestamp( TS_ISO_8601, $row->rc_timestamp ) );
break;
}
- $title = Title :: makeTitle($row->page_namespace, $row->page_title);
- // skip any pages that user has no rights to read
- if ($title->userCanRead()) {
-
- if (is_null($resultPageSet)) {
- $id = intval($row->page_id);
-
- $vals = array ();
- $vals['pageid'] = intval($row->page_id);
- $vals['revid'] = intval($row->rev_id);
- $vals['ns'] = $title->getNamespace();
- $vals['title'] = $title->getPrefixedText();
-
- if ($row->page_is_new)
- $vals['new'] = '';
- if ($row->rev_minor_edit)
- $vals['minor'] = '';
-
- if ($user) {
- if (!$row->rev_user)
- $vals['anon'] = '';
- $vals['user'] = $row->rev_user_text;
- }
- if ($comment)
- $vals['comment'] = $row->rev_comment;
- if ($timestamp)
- $vals['timestamp'] = $row->rev_timestamp;
- if ($patrol && $row->rc_patrolled)
- $vals['patrolled'] = '';
-
- $data[] = $vals;
+ if ( is_null( $resultPageSet ) ) {
+ $vals = $this->extractRowInfo( $row );
+ $fit = $this->getResult()->addValue( array( 'query', $this->getModuleName() ), null, $vals );
+ if ( !$fit ) {
+ $this->setContinueEnumParameter( 'start',
+ wfTimestamp( TS_ISO_8601, $row->rc_timestamp ) );
+ break;
}
- elseif ($allrev) {
- $data[] = intval($row->rev_id);
+ } else {
+ if ( $params['allrev'] ) {
+ $ids[] = intval( $row->rc_this_oldid );
} else {
- $data[] = intval($row->page_id);
+ $ids[] = intval( $row->rc_cur_id );
}
}
}
- $db->freeResult($res);
- if (is_null($resultPageSet)) {
- ApiResult :: setIndexedTagName($data, 'item');
- $this->getResult()->addValue('query', $this->getModuleName(), $data);
- }
- elseif ($allrev) {
- $resultPageSet->populateFromRevisionIDs($data);
+ if ( is_null( $resultPageSet ) ) {
+ $this->getResult()->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'item' );
+ } elseif ( $params['allrev'] ) {
+ $resultPageSet->populateFromRevisionIDs( $ids );
} else {
- $resultPageSet->populateFromPageIDs($data);
+ $resultPageSet->populateFromPageIDs( $ids );
+ }
+ }
+
+ private function extractRowInfo( $row ) {
+ $vals = array();
+
+ if ( $this->fld_ids ) {
+ $vals['pageid'] = intval( $row->rc_cur_id );
+ $vals['revid'] = intval( $row->rc_this_oldid );
+ }
+
+ $title = Title::makeTitle( $row->rc_namespace, $row->rc_title );
+
+ if ( $this->fld_title ) {
+ ApiQueryBase::addTitleInfo( $vals, $title );
+ }
+
+ if ( $this->fld_user ) {
+ $vals['user'] = $row->rc_user_text;
+ if ( !$row->rc_user ) {
+ $vals['anon'] = '';
+ }
+ }
+
+ if ( $this->fld_flags ) {
+ if ( $row->rc_new ) {
+ $vals['new'] = '';
+ }
+ if ( $row->rc_minor ) {
+ $vals['minor'] = '';
+ }
+ if ( $row->rc_bot ) {
+ $vals['bot'] = '';
+ }
+ }
+
+ if ( $this->fld_patrol && isset( $row->rc_patrolled ) ) {
+ $vals['patrolled'] = '';
+ }
+
+ 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 ) ) {
+ $vals['comment'] = $row->rc_comment;
+ }
+
+ if ( $this->fld_parsedcomment && isset( $row->rc_comment ) ) {
+ global $wgUser;
+ $vals['parsedcomment'] = $wgUser->getSkin()->formatComment( $row->rc_comment, $title );
+ }
+
+ return $vals;
}
- protected function getAllowedParams() {
- $namespaces = $this->getQuery()->getValidNamespaces();
- return array (
+ public function getAllowedParams() {
+ 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 => $namespaces
+ 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 (
+ '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_MAX1 => 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_DFLT => 'ids|title|flags',
+ APIBase::PARAM_TYPE => array(
+ 'ids',
+ 'title',
+ 'flags',
'user',
'comment',
+ 'parsedcomment',
'timestamp',
- 'patrol'
+ 'patrol',
+ 'sizes',
+ 'notificationtimestamp'
)
+ ),
+ 'show' => array(
+ ApiBase::PARAM_ISMULTI => true,
+ ApiBase::PARAM_TYPE => array(
+ 'minor',
+ '!minor',
+ 'bot',
+ '!bot',
+ 'anon',
+ '!anon',
+ 'patrolled',
+ '!patrolled',
+ )
+ ),
+ 'owner' => array(
+ ApiBase::PARAM_TYPE => 'user'
+ ),
+ 'token' => array(
+ ApiBase::PARAM_TYPE => 'string'
)
);
}
- protected 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).',
- 'dir' => 'In which direction to enumerate pages.',
- 'limit' => 'How many total pages to return per request.',
- 'prop' => 'Which additional items to get (non-generator mode only).'
+ 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)',
+ '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' => 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 user who 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 {$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'
);
}
- protected function getDescription() {
- return '';
+ 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' ),
+ array( 'code' => 'bad_wltoken', 'info' => 'Incorrect watchlist token provided -- please set a correct token in Special:Preferences' ),
+ array( 'code' => 'notloggedin', 'info' => 'You must be logged-in to have a watchlist' ),
+ array( 'code' => 'patrol', 'info' => 'patrol property is not available' ),
+ array( 'show' ),
+ array( 'code' => 'permissiondenied', 'info' => 'You need the patrol right to request the patrolled flag' ),
+ array( 'code' => 'user-excludeuser', 'info' => 'user and excludeuser cannot be used together' ),
+ ) );
}
protected function getExamples() {
- return array (
+ return array(
'api.php?action=query&list=watchlist',
- 'api.php?action=query&list=watchlist&wlallrev',
+ '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'
);
}
return __CLASS__ . ': $Id$';
}
}
-?>
\ No newline at end of file
dépôts / lhc / web / wiklou.git / blobdiff