346de65455671c1a1826d6b0620c5c353f940233
4 * Created on Oct 13, 2006
6 * API for MediaWiki 1.8+
8 * Copyright (C) 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License along
21 * with this program; if not, write to the Free Software Foundation, Inc.,
22 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
23 * http://www.gnu.org/copyleft/gpl.html
26 if (!defined('MEDIAWIKI')) {
27 // Eclipse helper - will be ignored in production
28 require_once ("ApiBase.php");
32 * This action allows users to get their watchlist items in RSS/Atom formats.
33 * When executed, it performs a nested call to the API to get the needed data,
34 * and formats it in a proper format.
38 class ApiFeedWatchlist
extends ApiBase
{
40 public function __construct($main, $action) {
41 parent
:: __construct($main, $action);
45 * This module uses a custom feed wrapper printer.
47 public function getCustomPrinter() {
48 return new ApiFormatFeedWrapper($this->getMain());
52 * Make a nested call to the API to request watchlist items in the last $hours.
53 * Wrap the result as an RSS/Atom feed.
55 public function execute() {
57 global $wgFeedClasses, $wgFeedLimit, $wgSitename, $wgContLanguageCode;
60 $params = $this->extractRequestParams();
62 // limit to the number of hours going from now back
63 $endTime = wfTimestamp(TS_MW
, time() - intval($params['hours'] * 60 * 60));
65 $dbr = wfGetDB( DB_SLAVE
);
66 // Prepare parameters for nested request
70 'siprop' => 'general',
71 'list' => 'watchlist',
72 'wlprop' => 'title|user|comment|timestamp',
73 'wldir' => 'older', // reverse order - from newest to oldest
74 'wlend' => $dbr->timestamp($endTime), // stop at this time
75 'wllimit' => (50 > $wgFeedLimit) ?
$wgFeedLimit : 50
78 // Check for 'allrev' parameter, and if found, show all revisions to each page on wl.
79 if ( ! is_null ( $params['allrev'] ) ) $fauxReqArr['wlallrev'] = '';
82 $fauxReq = new FauxRequest ( $fauxReqArr );
85 $module = new ApiMain($fauxReq);
89 $data = $module->getResultData();
91 $feedItems = array ();
92 foreach ($data['query']['watchlist'] as $info) {
93 $feedItems[] = $this->createFeedItem($info);
96 $feedTitle = $wgSitename . ' - ' . wfMsgForContent('watchlist') . ' [' . $wgContLanguageCode . ']';
97 $feedUrl = SpecialPage
::getTitleFor( 'Watchlist' )->getFullUrl();
99 $feed = new $wgFeedClasses[$params['feedformat']] ($feedTitle, htmlspecialchars(wfMsgForContent('watchlist')), $feedUrl);
101 ApiFormatFeedWrapper
:: setResult($this->getResult(), $feed, $feedItems);
103 } catch (Exception
$e) {
105 // Error results should not be cached
106 $this->getMain()->setCacheMaxAge(0);
108 $feedTitle = $wgSitename . ' - Error - ' . wfMsgForContent('watchlist') . ' [' . $wgContLanguageCode . ']';
109 $feedUrl = SpecialPage
::getTitleFor( 'Watchlist' )->getFullUrl();
111 $feedFormat = isset($params['feedformat']) ?
$params['feedformat'] : 'rss';
112 $feed = new $wgFeedClasses[$feedFormat] ($feedTitle, htmlspecialchars(wfMsgForContent('watchlist')), $feedUrl);
115 if ($e instanceof UsageException
) {
116 $errorCode = $e->getCodeString();
118 // Something is seriously wrong
119 $errorCode = 'internal_api_error';
122 $errorText = $e->getMessage();
123 $feedItems[] = new FeedItem("Error ($errorCode)", $errorText, "", "", "");
124 ApiFormatFeedWrapper
:: setResult($this->getResult(), $feed, $feedItems);
128 private function createFeedItem($info) {
129 $titleStr = $info['title'];
130 $title = Title
:: newFromText($titleStr);
131 $titleUrl = $title->getFullUrl();
132 $comment = isset( $info['comment'] ) ?
$info['comment'] : null;
133 $timestamp = $info['timestamp'];
134 $user = $info['user'];
136 $completeText = "$comment ($user)";
138 return new FeedItem($titleStr, $completeText, $titleUrl, $timestamp, $user);
141 public function getAllowedParams() {
142 global $wgFeedClasses;
143 $feedFormatNames = array_keys($wgFeedClasses);
145 'feedformat' => array (
146 ApiBase
:: PARAM_DFLT
=> 'rss',
147 ApiBase
:: PARAM_TYPE
=> $feedFormatNames
150 ApiBase
:: PARAM_DFLT
=> 24,
151 ApiBase
:: PARAM_TYPE
=> 'integer',
152 ApiBase
:: PARAM_MIN
=> 1,
153 ApiBase
:: PARAM_MAX
=> 72,
159 public function getParamDescription() {
161 'feedformat' => 'The format of the feed',
162 'hours' => 'List pages modified within this many hours from now',
163 'allrev' => 'Include multiple revisions of the same page within given timeframe.'
167 public function getDescription() {
168 return 'This module returns a watchlist feed';
171 protected function getExamples() {
173 'api.php?action=feedwatchlist'
177 public function getVersion() {
178 return __CLASS__
. ': $Id$';