5 * Created on Oct 13, 2006
7 * API for MediaWiki 1.8+
9 * Copyright (C) 2006 Yuri Astrakhan <FirstnameLastname@gmail.com>
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License along
22 * with this program; if not, write to the Free Software Foundation, Inc.,
23 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
24 * http://www.gnu.org/copyleft/gpl.html
27 if (!defined('MEDIAWIKI')) {
28 // Eclipse helper - will be ignored in production
29 require_once ("ApiBase.php");
32 class ApiFeedWatchlist
extends ApiBase
{
34 public function __construct($main, $action) {
35 parent
:: __construct($main, $action);
38 public function getCustomPrinter() {
39 return new ApiFormatFeedWrapper($this->getMain());
42 public function execute() {
44 extract($this->extractRequestParams());
46 // Prepare nested request
47 $params = new FauxRequest(array (
50 'siprop' => 'general',
51 'list' => 'watchlist',
52 'wlstart' => wfTimestamp(TS_MW
, time() - intval( 3 * 86400 )), // limit to 3 days
57 $module = new ApiMain($params);
61 $result = & $module->getResult();
62 $result->SanitizeData();
63 $data = & $result->GetData();
65 $feedItems = array ();
66 foreach ($data['query']['watchlist'] as $index => $info) {
67 $title = $info['title'];
68 $titleUrl = Title
:: newFromText($title)->getFullUrl();
69 $feedItems[] = new FeedItem($title, '', $titleUrl, $info['timestamp'], $info['user']);
72 global $wgFeedClasses, $wgSitename, $wgContLanguageCode;
73 $feedTitle = $wgSitename . ' - ' . wfMsgForContent('watchlist') . ' [' . $wgContLanguageCode . ']';
74 $feedUrl = Title
:: makeTitle(NS_SPECIAL
, 'Watchlist')->getFullUrl();
75 $feed = new $wgFeedClasses[$feedformat] ($feedTitle, '!Watchlist!', $feedUrl);
77 ApiFormatFeedWrapper
:: setResult($this->getResult(), $feed, $feedItems);
80 protected function GetAllowedParams() {
81 global $wgFeedClasses;
82 $feedFormatNames = array_keys($wgFeedClasses);
84 'feedformat' => array (
85 ApiBase
:: PARAM_DFLT
=> 'rss',
86 ApiBase
:: PARAM_TYPE
=> $feedFormatNames
91 protected function GetParamDescription() {
93 'feedformat' => 'The format of the feed'
97 protected function GetDescription() {
98 return 'This module returns a watchlist feed';
101 protected function GetExamples() {
103 'api.php?action=feedwatchlist'
107 public function getVersion() {
108 return __CLASS__
. ': $Id$';