# http://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
/**
* Basic support for outputting syndication feeds in RSS, other formats.
* Contain a feed class as well as classes to build rss / atom ... feeds
* Available feeds are defined in Defines.php
*/
/**
* A base class for basic support for outputting syndication feeds in RSS and other formats.
*/
class FeedItem {
/**#@+
* @var string
* @private
*/
var $Title = 'Wiki';
var $Description = '';
var $Url = '';
var $Date = '';
var $Author = '';
/**#@-*/
/**#@+
* @todo document
* @param $Url URL uniquely designating the item.
*/
function __construct( $Title, $Description, $Url, $Date = '', $Author = '', $Comments = '' ) {
$this->Title = $Title;
$this->Description = $Description;
$this->Url = $Url;
$this->Date = $Date;
$this->Author = $Author;
$this->Comments = $Comments;
}
/**
* @static
*/
function xmlEncode( $string ) {
$string = str_replace( "\r\n", "\n", $string );
$string = preg_replace( '/[\x00-\x08\x0b\x0c\x0e-\x1f]/', '', $string );
return htmlspecialchars( $string );
}
function getTitle() { return $this->xmlEncode( $this->Title ); }
function getUrl() { return $this->xmlEncode( $this->Url ); }
function getDescription() { return $this->xmlEncode( $this->Description ); }
function getLanguage() {
global $wgContLanguageCode;
return $wgContLanguageCode;
}
function getDate() { return $this->Date; }
function getAuthor() { return $this->xmlEncode( $this->Author ); }
function getComments() { return $this->xmlEncode( $this->Comments ); }
/**#@-*/
}
/**
* @todo document (needs one-sentence top-level class description).
*/
class ChannelFeed extends FeedItem {
/**#@+
* Abstract function, override!
* @abstract
*/
/**
* Generate Header of the feed
*/
function outHeader() {
# print "";
}
/**
* Generate an item
* @param $item
*/
function outItem( $item ) {
# print "...";
}
/**
* Generate Footer of the feed
*/
function outFooter() {
# print "";
}
/**#@-*/
/**
* Setup and send HTTP headers. Don't send any content;
* content might end up being cached and re-sent with
* these same headers later.
*
* This should be called from the outHeader() method,
* but can also be called separately.
*
* @public
*/
function httpHeaders() {
global $wgOut;
# We take over from $wgOut, excepting its cache header info
$wgOut->disable();
$mimetype = $this->contentType();
header( "Content-type: $mimetype; charset=UTF-8" );
$wgOut->sendCacheControl();
}
/**
* Return an internet media type to be sent in the headers.
*
* @return string
* @private
*/
function contentType() {
global $wgRequest;
$ctype = $wgRequest->getVal('ctype','application/xml');
$allowedctypes = array('application/xml','text/xml','application/rss+xml','application/atom+xml');
return (in_array($ctype, $allowedctypes) ? $ctype : 'application/xml');
}
/**
* Output the initial XML headers with a stylesheet for legibility
* if someone finds it in a browser.
* @private
*/
function outXmlHeader() {
global $wgStylePath, $wgStyleVersion;
$this->httpHeaders();
echo '' . "\n";
echo '\n";
}
}
/**
* Generate a RSS feed
*/
class RSSFeed extends ChannelFeed {
/**
* Format a date given a timestamp
* @param integer $ts Timestamp
* @return string Date string
*/
function formatTime( $ts ) {
return gmdate( 'D, d M Y H:i:s \G\M\T', wfTimestamp( TS_UNIX, $ts ) );
}
/**
* Ouput an RSS 2.0 header
*/
function outHeader() {
global $wgVersion;
$this->outXmlHeader();
?><?php print $this->getTitle() ?>
getUrl() ?>
getDescription() ?>getLanguage() ?>MediaWiki formatTime( wfTimestampNow() ) ?><?php print $item->getTitle() ?>
getUrl() ?>
getDescription() ?>
getDate() ) { ?>formatTime( $item->getDate() ) ?>
getAuthor() ) { ?>getAuthor() ?>
getComments() ) { ?>getComments() ?>outXmlHeader();
?>getFeedId() ?><?php print $this->getTitle() ?>formatTime( wfTimestampNow() ) ?>ZgetDescription() ?>MediaWiki
getSelfUrl();
}
/**
* Atom 1.0 requests a self-reference to the feed.
* @return string
* @private
*/
function getSelfUrl() {
global $wgRequest;
return htmlspecialchars( $wgRequest->getFullRequestURL() );
}
/**
* Output a given item.
* @param $item
*/
function outItem( $item ) {
global $wgMimeType;
?>
getUrl() ?><?php print $item->getTitle() ?>
getDate() ) { ?>
formatTime( $item->getDate() ) ?>ZgetDescription() ?>
getAuthor() ) { ?>getAuthor() ?>
getComments() ) { ?>getComments() ?>
*/
}
/**
* Outputs the footer for Atom 1.0 feed (basicly '\').
*/
function outFooter() {?>