1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
|
<?php
/**
* 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.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @since 1.23
*/
/**
* Recent changes feed.
*
* @ingroup API
*/
class ApiFeedRecentChanges extends ApiBase {
/**
* This module uses a custom feed wrapper printer.
*
* @return ApiFormatFeedWrapper
*/
public function getCustomPrinter() {
return new ApiFormatFeedWrapper( $this->getMain() );
}
/**
* Format the rows (generated by SpecialRecentchanges or SpecialRecentchangeslinked)
* as an RSS/Atom feed.
*/
public function execute() {
$config = $this->getConfig();
$this->params = $this->extractRequestParams();
if ( !$config->get( 'Feed' ) ) {
$this->dieUsage( 'Syndication feeds are not available', 'feed-unavailable' );
}
$feedClasses = $config->get( 'FeedClasses' );
if ( !isset( $feedClasses[$this->params['feedformat']] ) ) {
$this->dieUsage( 'Invalid subscription feed type', 'feed-invalid' );
}
$this->getMain()->setCacheMode( 'public' );
if ( !$this->getMain()->getParameter( 'smaxage' ) ) {
// bug 63249: This page gets hit a lot, cache at least 15 seconds.
$this->getMain()->setCacheMaxAge( 15 );
}
$feedFormat = $this->params['feedformat'];
$specialClass = $this->params['target'] !== null
? 'SpecialRecentchangeslinked'
: 'SpecialRecentchanges';
$formatter = $this->getFeedObject( $feedFormat, $specialClass );
// Everything is passed implicitly via $wgRequest… :(
// The row-getting functionality should maybe be factored out of ChangesListSpecialPage too…
$rc = new $specialClass();
$rows = $rc->getRows();
$feedItems = $rows ? ChangesFeed::buildItems( $rows ) : array();
ApiFormatFeedWrapper::setResult( $this->getResult(), $formatter, $feedItems );
}
/**
* Return a ChannelFeed object.
*
* @param string $feedFormat Feed's format (either 'rss' or 'atom')
* @param string $specialClass Relevant special page name (either 'SpecialRecentchanges' or
* 'SpecialRecentchangeslinked')
* @return ChannelFeed
*/
public function getFeedObject( $feedFormat, $specialClass ) {
if ( $specialClass === 'SpecialRecentchangeslinked' ) {
$title = Title::newFromText( $this->params['target'] );
if ( !$title ) {
$this->dieUsageMsg( array( 'invalidtitle', $this->params['target'] ) );
}
$feed = new ChangesFeed( $feedFormat, false );
$feedObj = $feed->getFeedObject(
$this->msg( 'recentchangeslinked-title', $title->getPrefixedText() )
->inContentLanguage()->text(),
$this->msg( 'recentchangeslinked-feed' )->inContentLanguage()->text(),
SpecialPage::getTitleFor( 'Recentchangeslinked' )->getFullURL()
);
} else {
$feed = new ChangesFeed( $feedFormat, 'rcfeed' );
$feedObj = $feed->getFeedObject(
$this->msg( 'recentchanges' )->inContentLanguage()->text(),
$this->msg( 'recentchanges-feed-description' )->inContentLanguage()->text(),
SpecialPage::getTitleFor( 'Recentchanges' )->getFullURL()
);
}
return $feedObj;
}
public function getAllowedParams() {
$config = $this->getConfig();
$feedFormatNames = array_keys( $config->get( 'FeedClasses' ) );
$ret = array(
'feedformat' => array(
ApiBase::PARAM_DFLT => 'rss',
ApiBase::PARAM_TYPE => $feedFormatNames,
),
'namespace' => array(
ApiBase::PARAM_TYPE => 'namespace',
),
'invert' => false,
'associated' => false,
'days' => array(
ApiBase::PARAM_DFLT => 7,
ApiBase::PARAM_MIN => 1,
ApiBase::PARAM_TYPE => 'integer',
),
'limit' => array(
ApiBase::PARAM_DFLT => 50,
ApiBase::PARAM_MIN => 1,
ApiBase::PARAM_MAX => $config->get( 'FeedLimit' ),
ApiBase::PARAM_TYPE => 'integer',
),
'from' => array(
ApiBase::PARAM_TYPE => 'timestamp',
),
'hideminor' => false,
'hidebots' => false,
'hideanons' => false,
'hideliu' => false,
'hidepatrolled' => false,
'hidemyself' => false,
'tagfilter' => array(
ApiBase::PARAM_TYPE => 'string',
),
'target' => array(
ApiBase::PARAM_TYPE => 'string',
),
'showlinkedto' => false,
);
if ( $config->get( 'AllowCategorizedRecentChanges' ) ) {
$ret += array(
'categories' => array(
ApiBase::PARAM_TYPE => 'string',
ApiBase::PARAM_ISMULTI => true,
),
'categories_any' => false,
);
}
return $ret;
}
public function getParamDescription() {
return array(
'feedformat' => 'The format of the feed',
'namespace' => 'Namespace to limit the results to',
'invert' => 'All namespaces but the selected one',
'associated' => 'Include associated (talk or main) namespace',
'days' => 'Days to limit the results to',
'limit' => 'Maximum number of results to return',
'from' => 'Show changes since then',
'hideminor' => 'Hide minor changes',
'hidebots' => 'Hide changes made by bots',
'hideanons' => 'Hide changes made by anonymous users',
'hideliu' => 'Hide changes made by registered users',
'hidepatrolled' => 'Hide patrolled changes',
'hidemyself' => 'Hide changes made by yourself',
'tagfilter' => 'Filter by tag',
'target' => 'Show only changes on pages linked from this page',
'showlinkedto' => 'Show changes on pages linked to the selected page instead',
'categories' => 'Show only changes on pages in all of these categories',
'categories_any' => 'Show only changes on pages in any of the categories instead',
);
}
public function getDescription() {
return 'Returns a recent changes feed';
}
public function getExamples() {
return array(
'api.php?action=feedrecentchanges',
'api.php?action=feedrecentchanges&days=30'
);
}
}
|
