3758769f0d
"I wouldn't object to stylizing the API code to bring it in line with the rest of MW on principle, but I'm not gonna bother myself." --Roan <http://www.mediawiki.org/wiki/Special:Code/MediaWiki/60657#c5108> If you're seeing this commit in blames, tell your blame tool to ignore whitespace, e.g., git blame -w or svn blame -x -w.
384 lines
12 KiB
PHP
384 lines
12 KiB
PHP
<?php
|
|
|
|
/*
|
|
* Created on Sep 25, 2006
|
|
*
|
|
* API for MediaWiki 1.8+
|
|
*
|
|
* Copyright (C) 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
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* 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.
|
|
* http://www.gnu.org/copyleft/gpl.html
|
|
*/
|
|
|
|
if ( !defined( 'MEDIAWIKI' ) ) {
|
|
// Eclipse helper - will be ignored in production
|
|
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 execute() {
|
|
$this->run();
|
|
}
|
|
|
|
public function executeGenerator( $resultPageSet ) {
|
|
$this->run( $resultPageSet );
|
|
}
|
|
|
|
private $fld_ids = false, $fld_title = false, $fld_patrol = false, $fld_flags = false,
|
|
$fld_timestamp = false, $fld_user = false, $fld_comment = false, $fld_sizes = false;
|
|
|
|
private function run( $resultPageSet = null ) {
|
|
global $wgUser, $wgDBtype;
|
|
|
|
$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;
|
|
}
|
|
|
|
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_timestamp = isset( $prop['timestamp'] );
|
|
$this->fld_sizes = isset( $prop['sizes'] );
|
|
$this->fld_patrol = isset( $prop['patrol'] );
|
|
|
|
if ( $this->fld_patrol ) {
|
|
if ( !$user->useRCPatrol() && !$user->useNPPatrol() )
|
|
$this->dieUsage( 'patrol property is not available', 'patrol' );
|
|
}
|
|
}
|
|
|
|
if ( is_null( $resultPageSet ) ) {
|
|
$this->addFields( array (
|
|
'rc_cur_id',
|
|
'rc_this_oldid',
|
|
'rc_namespace',
|
|
'rc_title',
|
|
'rc_timestamp'
|
|
) );
|
|
|
|
$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->addFieldsIf( 'rc_patrolled', $this->fld_patrol );
|
|
$this->addFieldsIf( 'rc_old_len', $this->fld_sizes );
|
|
$this->addFieldsIf( 'rc_new_len', $this->fld_sizes );
|
|
}
|
|
elseif ( $params['allrev'] ) {
|
|
$this->addFields( array (
|
|
'rc_this_oldid',
|
|
'rc_namespace',
|
|
'rc_title',
|
|
'rc_timestamp'
|
|
) );
|
|
} else {
|
|
$this->addFields( array (
|
|
'rc_cur_id',
|
|
'rc_namespace',
|
|
'rc_title',
|
|
'rc_timestamp'
|
|
) );
|
|
}
|
|
|
|
$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' => $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->dieUsage( "Incorrect parameter - mutually exclusive values may not be supplied", 'show' );
|
|
}
|
|
|
|
// 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' );
|
|
|
|
/* 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 ( !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 ( $params['start'] ) && !isset ( $params['end'] ) && $wgDBtype == 'mysql' );
|
|
|
|
$this->addOption( 'LIMIT', $params['limit'] + 1 );
|
|
|
|
$ids = array ();
|
|
$count = 0;
|
|
$res = $this->select( __METHOD__ );
|
|
|
|
$db = $this->getDB();
|
|
while ( $row = $db->fetchObject( $res ) ) {
|
|
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;
|
|
}
|
|
|
|
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;
|
|
}
|
|
} else {
|
|
if ( $params['allrev'] ) {
|
|
$ids[] = intval( $row->rc_this_oldid );
|
|
} else {
|
|
$ids[] = intval( $row->rc_cur_id );
|
|
}
|
|
}
|
|
}
|
|
|
|
$db->freeResult( $res );
|
|
|
|
if ( is_null( $resultPageSet ) ) {
|
|
$this->getResult()->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'item' );
|
|
}
|
|
elseif ( $params['allrev'] ) {
|
|
$resultPageSet->populateFromRevisionIDs( $ids );
|
|
} else {
|
|
$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 );
|
|
}
|
|
|
|
if ( $this->fld_title )
|
|
ApiQueryBase :: addTitleInfo( $vals, Title :: makeTitle( $row->rc_namespace, $row->rc_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_comment && isset( $row->rc_comment ) )
|
|
$vals['comment'] = $row->rc_comment;
|
|
|
|
return $vals;
|
|
}
|
|
|
|
public function getAllowedParams() {
|
|
return array (
|
|
'allrev' => false,
|
|
'start' => array (
|
|
ApiBase :: PARAM_TYPE => 'timestamp'
|
|
),
|
|
'end' => array (
|
|
ApiBase :: PARAM_TYPE => 'timestamp'
|
|
),
|
|
'namespace' => array (
|
|
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 (
|
|
'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
|
|
),
|
|
'prop' => array (
|
|
APIBase :: PARAM_ISMULTI => true,
|
|
APIBase :: PARAM_DFLT => 'ids|title|flags',
|
|
APIBase :: PARAM_TYPE => array (
|
|
'ids',
|
|
'title',
|
|
'flags',
|
|
'user',
|
|
'comment',
|
|
'timestamp',
|
|
'patrol',
|
|
'sizes',
|
|
)
|
|
),
|
|
'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'
|
|
)
|
|
);
|
|
}
|
|
|
|
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' => '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"
|
|
);
|
|
}
|
|
|
|
public function getDescription() {
|
|
return "Get all recent changes to pages in the logged in user's watchlist";
|
|
}
|
|
|
|
protected function getExamples() {
|
|
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&generator=watchlist&prop=info',
|
|
'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$';
|
|
}
|
|
}
|