WikiIndex:Feed.php


 * 3) http://www.mediawiki.org/
 * 4) This program is free software; you can redistribute it and/or modify
 * 5) it under the terms of the GNU General Public License as published by
 * 6) the Free Software Foundation; either version 2 of the License, or
 * 7) (at your option) any later version.
 * 8) This program is distributed in the hope that it will be useful,
 * 9) but WITHOUT ANY WARRANTY; without even the implied warranty of
 * 10) MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * 11) GNU General Public License for more details.
 * 12) You should have received a copy of the GNU General Public License along
 * 13) with this program; if not, write to the Free Software Foundation, Inc.,
 * 14) 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 * 15) http://www.gnu.org/copyleft/gpl.html
 * 1) You should have received a copy of the GNU General Public License along
 * 2) with this program; if not, write to the Free Software Foundation, Inc.,
 * 3) 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 * 4) http://www.gnu.org/copyleft/gpl.html

/** * Contain a feed class as well as classes to build rss / atom ... feeds * Available feeds are defined in Defines.php * @package MediaWiki */

/** * @todo document * @package MediaWiki */ class FeedItem { /**#@+	 * @var string * @access private */	var $Title = 'Wiki'; var $Description = ''; var $Url = ''; var $Date = ''; var $Author = ''; /**#@-*/

/**#@+	 * @todo document */	function FeedItem( $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 * @package MediaWiki */ 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. *	 * @access 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 * @access 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. * @access private */	function outXmlHeader { global $wgServer, $wgStylePath;

$this->httpHeaders; echo ''. "\n"; echo '\n"; } }

/** * Generate a RSS feed * @todo document * @package MediaWiki */ 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; ?> getTitle ?> getUrl ?> getDescription ?> getLanguage ?> MediaWiki  formatTime( wfTimestampNow ) ?> 			 getTitle ?> getUrl ?> getDescription ?> <?php if( $item->getDate ) { ?><pubDate><?php print $this->formatTime( $item->getDate ) ?></pubDate><?php } ?> <?php if( $item->getAuthor ) { ?><dc:creator><?php print $item->getAuthor ?></dc:creator><?php }?> <?php if( $item->getComments ) { ?> <?php print $item->getComments ?> <?php }?> <?php }

/**	 * Ouput an RSS 2.0 footer */	function outFooter { ?> <?php } }

/** * Generate an Atom feed * @todo document * @package MediaWiki */ class AtomFeed extends ChannelFeed { /**	 * @todo document */	function formatTime( $ts ) { // need to use RFC 822 time format at least for rss2.0 return gmdate( 'Y-m-d\TH:i:s', wfTimestamp( TS_UNIX, $ts ) ); }

/**	 * @todo document */	function outHeader { global $wgVersion;

$this->outXmlHeader; ?><feed xmlns="http://www.w3.org/2005/Atom" xml:lang="<?php print $this->getLanguage ?>"> <id><?php print $this->getFeedId ?></id> <?php print $this->getTitle ?> <link rel="self" type="application/atom+xml" href="<?php print $this->getSelfUrl ?>"/> <link rel="alternate" type="text/html" href="<?php print $this->getUrl ?>"/> <?php print $this->formatTime( wfTimestampNow ) ?>Z <?php print $this->getDescription ?> MediaWiki <?php print $wgVersion ?>

<?php }

/**	 * Atom 1.0 requires a unique, opaque IRI as a unique indentifier * for every feed we create. For now just use the URL, but who * can tell if that's right? If we put options on the feed, do we * have to change the id? Maybe? Maybe not. *	 * @return string * @access private */	function getFeedId { return $this->getSelfUrl; }

/**	 * Atom 1.0 requests a self-reference to the feed. * @return string * @access private */	function getSelfUrl { global $wgRequest; return htmlspecialchars( $wgRequest->getFullRequestURL ); }

/**	 * @todo document */	function outItem( $item ) { global $wgMimeType; ?>		<id><?php print $item->getUrl ?></id> <?php print $item->getTitle ?> <link rel="alternate" type="<?php print $wgMimeType ?>" href="<?php print $item->getUrl ?>"/> <?php if( $item->getDate ) { ?> <?php print $this->formatTime( $item->getDate ) ?>Z <?php } ?>

<?php print $item->getDescription ?> <?php if( $item->getAuthor ) { ?> <?php print $item->getAuthor ?>  <?php }?>

<?php /* FIXME need to add comments <?php if( $item->getComments ) { ?><dc:comment><?php print $item->getComments ?></dc:comment><?php }?> */	}

/**	 * @todo document */	function outFooter {?> <?php } }

?>