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
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
|
<?php
/**
*
*
* Created on June 06, 2011
*
* Copyright © 2011 Sam Reed
*
* 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
*/
/**
* @ingroup API
*/
class ApiFeedContributions extends ApiBase {
/**
* This module uses a custom feed wrapper printer.
*
* @return ApiFormatFeedWrapper
*/
public function getCustomPrinter() {
return new ApiFormatFeedWrapper( $this->getMain() );
}
public function execute() {
$params = $this->extractRequestParams();
$config = $this->getConfig();
if ( !$config->get( 'Feed' ) ) {
$this->dieUsage( 'Syndication feeds are not available', 'feed-unavailable' );
}
$feedClasses = $config->get( 'FeedClasses' );
if ( !isset( $feedClasses[$params['feedformat']] ) ) {
$this->dieUsage( 'Invalid subscription feed type', 'feed-invalid' );
}
if ( $params['showsizediff'] && $this->getConfig()->get( 'MiserMode' ) ) {
$this->dieUsage( 'Size difference is disabled in Miser Mode', 'sizediffdisabled' );
}
$msg = wfMessage( 'Contributions' )->inContentLanguage()->text();
$feedTitle = $config->get( 'Sitename' ) . ' - ' . $msg . ' [' . $config->get( 'LanguageCode' ) . ']';
$feedUrl = SpecialPage::getTitleFor( 'Contributions', $params['user'] )->getFullURL();
$target = $params['user'] == 'newbies'
? 'newbies'
: Title::makeTitleSafe( NS_USER, $params['user'] )->getText();
$feed = new $feedClasses[$params['feedformat']] (
$feedTitle,
htmlspecialchars( $msg ),
$feedUrl
);
$pager = new ContribsPager( $this->getContext(), array(
'target' => $target,
'namespace' => $params['namespace'],
'year' => $params['year'],
'month' => $params['month'],
'tagFilter' => $params['tagfilter'],
'deletedOnly' => $params['deletedonly'],
'topOnly' => $params['toponly'],
'newOnly' => $params['newonly'],
'showSizeDiff' => $params['showsizediff'],
) );
$feedLimit = $this->getConfig()->get( 'FeedLimit' );
if ( $pager->getLimit() > $feedLimit ) {
$pager->setLimit( $feedLimit );
}
$feedItems = array();
if ( $pager->getNumRows() > 0 ) {
$count = 0;
$limit = $pager->getLimit();
foreach ( $pager->mResult as $row ) {
// ContribsPager selects one more row for navigation, skip that row
if ( ++$count > $limit ) {
break;
}
$item = $this->feedItem( $row );
if ( $item !== null ) {
$feedItems[] = $item;
}
}
}
ApiFormatFeedWrapper::setResult( $this->getResult(), $feed, $feedItems );
}
protected function feedItem( $row ) {
// This hook is the api contributions equivalent to the
// ContributionsLineEnding hook. Hook implementers may cancel
// the hook to signal the user is not allowed to read this item.
$feedItem = null;
$hookResult = Hooks::run(
'ApiFeedContributions::feedItem',
array( $row, $this->getContext(), &$feedItem )
);
// Hook returned a valid feed item
if ( $feedItem instanceof FeedItem ) {
return $feedItem;
// Hook was canceled and did not return a valid feed item
} elseif ( !$hookResult ) {
return null;
}
// Hook completed and did not return a valid feed item
$title = Title::makeTitle( intval( $row->page_namespace ), $row->page_title );
if ( $title && $title->userCan( 'read', $this->getUser() ) ) {
$date = $row->rev_timestamp;
$comments = $title->getTalkPage()->getFullURL();
$revision = Revision::newFromRow( $row );
return new FeedItem(
$title->getPrefixedText(),
$this->feedItemDesc( $revision ),
$title->getFullURL( array( 'diff' => $revision->getId() ) ),
$date,
$this->feedItemAuthor( $revision ),
$comments
);
}
return null;
}
/**
* @param Revision $revision
* @return string
*/
protected function feedItemAuthor( $revision ) {
return $revision->getUserText();
}
/**
* @param Revision $revision
* @return string
*/
protected function feedItemDesc( $revision ) {
if ( $revision ) {
$msg = wfMessage( 'colon-separator' )->inContentLanguage()->text();
$content = $revision->getContent();
if ( $content instanceof TextContent ) {
// only textual content has a "source view".
$html = nl2br( htmlspecialchars( $content->getNativeData() ) );
} else {
//XXX: we could get an HTML representation of the content via getParserOutput, but that may
// contain JS magic and generally may not be suitable for inclusion in a feed.
// Perhaps Content should have a getDescriptiveHtml method and/or a getSourceText method.
//Compare also FeedUtils::formatDiffRow.
$html = '';
}
return '<p>' . htmlspecialchars( $revision->getUserText() ) . $msg .
htmlspecialchars( FeedItem::stripComment( $revision->getComment() ) ) .
"</p>\n<hr />\n<div>" . $html . "</div>";
}
return '';
}
public function getAllowedParams() {
$feedFormatNames = array_keys( $this->getConfig()->get( 'FeedClasses' ) );
$ret = array(
'feedformat' => array(
ApiBase::PARAM_DFLT => 'rss',
ApiBase::PARAM_TYPE => $feedFormatNames
),
'user' => array(
ApiBase::PARAM_TYPE => 'user',
ApiBase::PARAM_REQUIRED => true,
),
'namespace' => array(
ApiBase::PARAM_TYPE => 'namespace'
),
'year' => array(
ApiBase::PARAM_TYPE => 'integer'
),
'month' => array(
ApiBase::PARAM_TYPE => 'integer'
),
'tagfilter' => array(
ApiBase::PARAM_ISMULTI => true,
ApiBase::PARAM_TYPE => array_values( ChangeTags::listDefinedTags() ),
ApiBase::PARAM_DFLT => '',
),
'deletedonly' => false,
'toponly' => false,
'newonly' => false,
'showsizediff' => array(
ApiBase::PARAM_DFLT => false,
),
);
if ( $this->getConfig()->get( 'MiserMode' ) ) {
$ret['showsizediff'][ApiBase::PARAM_HELP_MSG] = 'api-help-param-disabled-in-miser-mode';
}
return $ret;
}
protected function getExamplesMessages() {
return array(
'action=feedcontributions&user=Example'
=> 'apihelp-feedcontributions-example-simple',
);
}
}
|
