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
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
|
<?php
/**
* Copyright © 2004 Brooke Vibber <bvibber@wikimedia.org>
* https://www.mediawiki.org/
*
* 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
*/
namespace MediaWiki\Feed;
use MediaWiki\Language\LanguageCode;
use MediaWiki\MainConfigNames;
use MediaWiki\MediaWikiServices;
use MediaWiki\Utils\UrlUtils;
/**
* @defgroup Feed Feed
*/
/**
* A base class for outputting syndication feeds (e.g. RSS and other formats).
*
* @ingroup Feed
*/
class FeedItem {
/** @var string */
public $title;
/** @var string */
public $description;
/** @var string */
public $url;
/** @var string */
public $date;
/** @var string */
public $author;
/** @var string */
public $uniqueId;
/** @var string */
public $comments;
/** @var bool */
public $rssIsPermalink = false;
protected UrlUtils $urlUtils;
/**
* @param string $title Item's title
* @param string $description
* @param string $url URL uniquely designating the item.
* @param string $date Item's date
* @param string $author Author's user name
* @param string $comments
*/
public function __construct(
$title, $description, $url, $date = '', $author = '', $comments = ''
) {
$this->title = $title;
$this->description = $description;
$this->url = $url;
$this->uniqueId = $url;
$this->date = $date;
$this->author = $author;
$this->comments = $comments;
$this->urlUtils = MediaWikiServices::getInstance()->getUrlUtils();
}
/**
* Encode $string so that it can be safely embedded in a XML document
*
* @param string $string String to encode
*
* @return string
*/
public function xmlEncode( $string ) {
$string = str_replace( "\r\n", "\n", $string );
$string = preg_replace( '/[\x00-\x08\x0b\x0c\x0e-\x1f]/', '', $string );
return htmlspecialchars( $string );
}
/**
* Encode $string so that it can be safely embedded in a XML document,
* returning `null` if $string was `null`.
* @since 1.44 (also backported to 1.39.12, 1.42.6 and 1.43.1)
*/
public function xmlEncodeNullable( ?string $string ): ?string {
return $string !== null ? $this->xmlEncode( $string ) : null;
}
/**
* Get the unique id of this item; already xml-encoded
*
* @return string
*/
public function getUniqueID() {
$id = $this->getUniqueIdUnescaped();
if ( $id ) {
return $this->xmlEncode( $id );
}
}
/**
* Get the unique id of this item, without any escaping
*
* @return string|null
*/
public function getUniqueIdUnescaped(): ?string {
if ( $this->uniqueId ) {
return $this->urlUtils->expand( $this->uniqueId, PROTO_CURRENT );
}
return null;
}
/**
* Set the unique id of an item
*
* @param string $uniqueId Unique id for the item
* @param bool $rssIsPermalink Set to true if the guid (unique id) is a permalink (RSS feeds only)
*/
public function setUniqueId( $uniqueId, $rssIsPermalink = false ) {
$this->uniqueId = $uniqueId;
$this->rssIsPermalink = $rssIsPermalink;
}
/**
* Get the title of this item; already xml-encoded
*
* @return string
*/
public function getTitle() {
return $this->xmlEncode( $this->title );
}
/**
* Get the URL of this item; already xml-encoded
*
* @return string
*/
public function getUrl() {
return $this->xmlEncode( $this->url );
}
/** Get the URL of this item without any escaping
*
* @return string
*/
public function getUrlUnescaped() {
return $this->url;
}
/**
* Get the description of this item; already xml-encoded
*
* @return string
*/
public function getDescription() {
return $this->xmlEncode( $this->description );
}
/**
* Get the description of this item without any escaping
*
* @return string
*/
public function getDescriptionUnescaped() {
return $this->description;
}
/**
* Get the language of this item
*
* @return string
*/
public function getLanguage() {
$languageCode = MediaWikiServices::getInstance()->getMainConfig()
->get( MainConfigNames::LanguageCode );
return LanguageCode::bcp47( $languageCode );
}
/**
* Get the date of this item
*
* @return string
*/
public function getDate() {
return $this->date;
}
/**
* Get the author of this item; already xml-encoded
*
* @return string
*/
public function getAuthor() {
return $this->xmlEncode( $this->author );
}
/**
* Get the author of this item without any escaping
*
* @return string
*/
public function getAuthorUnescaped() {
return $this->author;
}
/**
* Get the comment of this item; already xml-encoded
*
* @return string
*/
public function getComments() {
return $this->xmlEncode( $this->comments );
}
/**
* Get the comment of this item without any escaping
*
* @return string
*/
public function getCommentsUnescaped() {
return $this->comments;
}
/**
* Quickie hack... strip out wikilinks to more legible form from the comment.
*
* @param string $text Wikitext
*
* @return string
*/
public static function stripComment( $text ) {
return preg_replace( '/\[\[([^]]*\|)?([^]]+)\]\]/', '\2', $text );
}
}
|
