3 * Basic support for outputting syndication feeds in RSS, other formats.
5 * Contain a feed class as well as classes to build rss / atom ... feeds
6 * Available feeds are defined in Defines.php
8 * Copyright © 2004 Brion Vibber <brion@pobox.com>
9 * http://www.mediawiki.org/
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 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
24 * http://www.gnu.org/copyleft/gpl.html
34 * A base class for basic support for outputting syndication feeds in RSS and other formats.
44 var $Description = '';
55 * @param $Title String: Item's title
56 * @param $Description String
57 * @param $Url String: URL uniquely designating the item.
58 * @param $Date String: Item's date
59 * @param $Author String: Author's user name
60 * @param $Comments String
62 function __construct( $Title, $Description, $Url, $Date = '', $Author = '', $Comments = '' ) {
63 $this->Title
= $Title;
64 $this->Description
= $Description;
66 $this->UniqueId
= $Url;
67 $this->RSSIsPermalink
= false;
69 $this->Author
= $Author;
70 $this->Comments
= $Comments;
74 * Get the last touched timestamp
76 * @return String last-touched timestamp
78 public function getLastMod() {
79 return $this->Title
->getTouched();
83 * Encode $string so that it can be safely embedded in a XML document
85 * @param $string String: string to encode
88 public function xmlEncode( $string ) {
89 $string = str_replace( "\r\n", "\n", $string );
90 $string = preg_replace( '/[\x00-\x08\x0b\x0c\x0e-\x1f]/', '', $string );
91 return htmlspecialchars( $string );
95 * Get the unique id of this item
99 public function getUniqueId() {
100 if ( $this->UniqueId
) {
101 return $this->xmlEncode( $this->UniqueId
);
106 * set the unique id of an item
108 * @param $uniqueId String: unique id for the item
109 * @param $RSSisPermalink Boolean: set to true if the guid (unique id) is a permalink (RSS feeds only)
111 public function setUniqueId($uniqueId, $RSSisPermalink = false) {
112 $this->UniqueId
= $uniqueId;
113 $this->RSSIsPermalink
= $RSSisPermalink;
117 * Get the title of this item; already xml-encoded
121 public function getTitle() {
122 return $this->xmlEncode( $this->Title
);
126 * Get the DB prefixed title
128 * @return String the prefixed title, with underscores and
129 * any interwiki and namespace prefixes
131 public function getDBPrefixedTitle() {
132 return $this->Title
->getPrefixedDBKey();
136 * Get the URL of this item; already xml-encoded
140 public function getUrl() {
141 return $this->xmlEncode( $this->Url
);
145 * Get the description of this item; already xml-encoded
149 public function getDescription() {
150 return $this->xmlEncode( $this->Description
);
154 * Get the language of this item
158 public function getLanguage() {
159 global $wgLanguageCode;
160 return $wgLanguageCode;
164 * Get the title of this item
168 public function getDate() {
173 * Get the author of this item; already xml-encoded
177 public function getAuthor() {
178 return $this->xmlEncode( $this->Author
);
182 * Get the comment of this item; already xml-encoded
186 public function getComments() {
187 return $this->xmlEncode( $this->Comments
);
191 * Quickie hack... strip out wikilinks to more legible form from the comment.
193 * @param $text String: wikitext
196 public static function stripComment( $text ) {
197 return preg_replace( '/\[\[([^]]*\|)?([^]]+)\]\]/', '\2', $text );
203 * @todo document (needs one-sentence top-level class description).
206 class ChannelFeed
extends FeedItem
{
208 * Abstract function, override!
213 * Generate Header of the feed
215 function outHeader() {
223 function outItem( $item ) {
224 # print "<item>...</item>";
228 * Generate Footer of the feed
230 function outFooter() {
236 * Setup and send HTTP headers. Don't send any content;
237 * content might end up being cached and re-sent with
238 * these same headers later.
240 * This should be called from the outHeader() method,
241 * but can also be called separately.
243 public function httpHeaders() {
246 # We take over from $wgOut, excepting its cache header info
248 $mimetype = $this->contentType();
249 header( "Content-type: $mimetype; charset=UTF-8" );
250 $wgOut->sendCacheControl();
255 * Return an internet media type to be sent in the headers.
260 function contentType() {
262 $ctype = $wgRequest->getVal('ctype','application/xml');
263 $allowedctypes = array('application/xml','text/xml','application/rss+xml','application/atom+xml');
264 return (in_array($ctype, $allowedctypes) ?
$ctype : 'application/xml');
268 * Output the initial XML headers with a stylesheet for legibility
269 * if someone finds it in a browser.
272 function outXmlHeader() {
273 global $wgStylePath, $wgStyleVersion;
275 $this->httpHeaders();
276 echo '<?xml version="1.0"?>' . "\n";
277 echo '<?xml-stylesheet type="text/css" href="' .
278 htmlspecialchars( wfExpandUrl( "$wgStylePath/common/feed.css?$wgStyleVersion" ) ) .
284 * Generate a RSS feed
288 class RSSFeed
extends ChannelFeed
{
291 * Format a date given a timestamp
293 * @param $ts Integer: timestamp
294 * @return String: date string
296 function formatTime( $ts ) {
297 return gmdate( 'D, d M Y H:i:s \G\M\T', wfTimestamp( TS_UNIX
, $ts ) );
301 * Ouput an RSS 2.0 header
303 function outHeader() {
305 $this->outXmlHeader();
306 ?
><rss version
="2.0" xmlns
:dc
="http://purl.org/dc/elements/1.1/">
308 <title
><?php
print $this->getTitle() ?
></title
>
309 <link
><?php
print $this->getUrl() ?
></link
>
310 <description
><?php
print $this->getDescription() ?
></description
>
311 <language
><?php
print $this->getLanguage() ?
></language
>
312 <generator
>MediaWiki
<?php
print MW_VERSION ?
></generator
>
313 <lastBuildDate
><?php
print $this->formatTime( wfTimestampNow() ) ?
></lastBuildDate
>
318 * Output an RSS 2.0 item
319 * @param $item FeedItem: item to be output
321 function outItem( $item ) {
324 <title
><?php
print $item->getTitle() ?
></title
>
325 <link
><?php
print $item->getUrl() ?
></link
>
326 <guid
<?php
if( !$item->RSSIsPermalink
) print ' isPermaLink="false"' ?
>><?php
print $item->getUniqueId() ?
></guid
>
327 <description
><?php
print $item->getDescription() ?
></description
>
328 <?php
if( $item->getDate() ) { ?
><pubDate
><?php
print $this->formatTime( $item->getDate() ) ?
></pubDate
><?php
} ?
>
329 <?php
if( $item->getAuthor() ) { ?
><dc
:creator
><?php
print $item->getAuthor() ?
></dc
:creator
><?php
}?
>
330 <?php
if( $item->getComments() ) { ?
><comments
><?php
print $item->getComments() ?
></comments
><?php
}?
>
336 * Ouput an RSS 2.0 footer
338 function outFooter() {
346 * Generate an Atom feed
350 class AtomFeed
extends ChannelFeed
{
354 function formatTime( $ts ) {
355 // need to use RFC 822 time format at least for rss2.0
356 return gmdate( 'Y-m-d\TH:i:s', wfTimestamp( TS_UNIX
, $ts ) );
360 * Outputs a basic header for Atom 1.0 feeds.
362 function outHeader() {
363 $this->outXmlHeader();
364 ?
><feed xmlns
="http://www.w3.org/2005/Atom" xml
:lang
="<?php print $this->getLanguage() ?>">
365 <id
><?php
print $this->getFeedId() ?
></id
>
366 <title
><?php
print $this->getTitle() ?
></title
>
367 <link rel
="self" type
="application/atom+xml" href
="<?php print $this->getSelfUrl() ?>"/>
368 <link rel
="alternate" type
="text/html" href
="<?php print $this->getUrl() ?>"/>
369 <updated
><?php
print $this->formatTime( wfTimestampNow() ) ?
>Z
</updated
>
370 <subtitle
><?php
print $this->getDescription() ?
></subtitle
>
371 <generator
>MediaWiki
<?php
print MW_VERSION ?
></generator
>
377 * Atom 1.0 requires a unique, opaque IRI as a unique indentifier
378 * for every feed we create. For now just use the URL, but who
379 * can tell if that's right? If we put options on the feed, do we
380 * have to change the id? Maybe? Maybe not.
385 function getFeedId() {
386 return $this->getSelfUrl();
390 * Atom 1.0 requests a self-reference to the feed.
394 function getSelfUrl() {
396 return htmlspecialchars( $wgRequest->getFullRequestURL() );
400 * Output a given item.
403 function outItem( $item ) {
407 <id
><?php
print $item->getUniqueId() ?
></id
>
408 <title
><?php
print $item->getTitle() ?
></title
>
409 <link rel
="alternate" type
="<?php print $wgMimeType ?>" href
="<?php print $item->getUrl() ?>"/>
410 <?php
if( $item->getDate() ) { ?
>
411 <updated
><?php
print $this->formatTime( $item->getDate() ) ?
>Z
</updated
>
414 <summary type
="html"><?php
print $item->getDescription() ?
></summary
>
415 <?php
if( $item->getAuthor() ) { ?
><author
><name
><?php
print $item->getAuthor() ?
></name
></author
><?php
}?
>
418 <?php
/* FIXME need to add comments
419 <?php if( $item->getComments() ) { ?><dc:comment><?php print $item->getComments() ?></dc:comment><?php }?>
424 * Outputs the footer for Atom 1.0 feed (basicly '\</feed\>').
426 function outFooter() {?
>