296 lines
7.9 KiB
PHP
296 lines
7.9 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.
|
|
*
|
|
* @addtogroup 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;
|
|
|
|
private function run($resultPageSet = null) {
|
|
global $wgUser, $wgDBtype;
|
|
|
|
$this->selectNamedDB('watchlist', DB_SLAVE, 'watchlist');
|
|
|
|
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());
|
|
|
|
if (!is_null($prop) && is_null($resultPageSet)) {
|
|
|
|
$prop = array_flip($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_patrol = isset($prop['patrol']);
|
|
|
|
if ($this->fld_patrol) {
|
|
global $wgUseRCPatrol, $wgUser;
|
|
if (!$wgUseRCPatrol || !$wgUser->isAllowed('patrol'))
|
|
$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_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);
|
|
}
|
|
elseif ($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 = $wgUser->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', $dir, $start, $end);
|
|
$this->addWhereFld('wl_namespace', $namespace);
|
|
$this->addWhereIf('rc_this_oldid=page_latest', !$allrev);
|
|
|
|
# This is a index optimization for mysql, as done in the Special:Watchlist page
|
|
$this->addWhereIf("rc_timestamp > ''", !isset ($start) && !isset ($end) && $wgDBtype == 'mysql');
|
|
|
|
$this->addOption('LIMIT', $limit +1);
|
|
|
|
$data = array ();
|
|
$count = 0;
|
|
$res = $this->select(__METHOD__);
|
|
|
|
$db = $this->getDB();
|
|
while ($row = $db->fetchObject($res)) {
|
|
if (++ $count > $limit) {
|
|
// We've reached the one extra which shows that there are additional pages to be had. Stop here...
|
|
$this->setContinueEnumParameter('start', $row->rc_timestamp);
|
|
break;
|
|
}
|
|
|
|
if (is_null($resultPageSet)) {
|
|
$vals = $this->extractRowInfo($row);
|
|
if ($vals)
|
|
$data[] = $vals;
|
|
} else {
|
|
$title = Title :: makeTitle($row->rc_namespace, $row->rc_title);
|
|
// skip any pages that user has no rights to read
|
|
if ($title->userCanRead()) {
|
|
if ($allrev) {
|
|
$data[] = intval($row->rc_this_oldid);
|
|
} else {
|
|
$data[] = intval($row->rc_cur_id);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
$db->freeResult($res);
|
|
|
|
if (is_null($resultPageSet)) {
|
|
$this->getResult()->setIndexedTagName($data, 'item');
|
|
$this->getResult()->addValue('query', $this->getModuleName(), $data);
|
|
}
|
|
elseif ($allrev) {
|
|
$resultPageSet->populateFromRevisionIDs($data);
|
|
} else {
|
|
$resultPageSet->populateFromPageIDs($data);
|
|
}
|
|
}
|
|
|
|
private function extractRowInfo($row) {
|
|
|
|
$title = Title :: makeTitle($row->rc_namespace, $row->rc_title);
|
|
if (!$title->userCanRead())
|
|
return false;
|
|
|
|
$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);
|
|
|
|
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 ($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_comment && !empty ($row->rc_comment))
|
|
$vals['comment'] = $row->rc_comment;
|
|
|
|
return $vals;
|
|
}
|
|
|
|
protected 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'
|
|
),
|
|
'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'
|
|
)
|
|
)
|
|
);
|
|
}
|
|
|
|
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).'
|
|
);
|
|
}
|
|
|
|
protected function getDescription() {
|
|
return '';
|
|
}
|
|
|
|
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'
|
|
);
|
|
}
|
|
|
|
public function getVersion() {
|
|
return __CLASS__ . ': $Id$';
|
|
}
|
|
}
|
|
?>
|