X-Git-Url: https://scripts.mit.edu/gitweb/autoinstallsdev/mediawiki.git/blobdiff_plain/a4b52d2fe555a507c376e78ee624898c55968364..18a6620945d02687fbcfc4c27355d952fd748b41:/includes/Feed.php

diff --git a/includes/Feed.php b/includes/Feed.php
index 6a286276..bc20a9dc 100644
--- a/includes/Feed.php
+++ b/includes/Feed.php
@@ -1,98 +1,202 @@
 <?php
-# Basic support for outputting syndication feeds in RSS, other formats
-# 
-# Copyright (C) 2004 Brion Vibber <brion@pobox.com>
-# 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.,
-# 59 Temple Place - Suite 330, Boston, MA 02111-1307, 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
- * @package MediaWiki
+ *
+ * Copyright © 2004 Brion Vibber <brion@pobox.com>
+ * 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
+ *
+ * @file
  */
 
+/**
+ * @defgroup Feed Feed
+ */
 
 /**
- * @todo document
- * @package MediaWiki
+ * A base class for basic support for outputting syndication feeds in RSS and other formats.
+ *
+ * @ingroup Feed
  */
 class FeedItem {
 	/**#@+
 	 * @var string
-	 * @access private
+	 * @private
 	 */
 	var $Title = 'Wiki';
 	var $Description = '';
 	var $Url = '';
 	var $Date = '';
 	var $Author = '';
+	var $UniqueId = '';
+	var $RSSIsPermalink;
 	/**#@-*/
-	
-	/**#@+
-	 * @todo document
+
+	/**
+	 * Constructor
+	 *
+	 * @param $Title String: Item's title
+	 * @param $Description String
+	 * @param $Url String: URL uniquely designating the item.
+	 * @param $Date String: Item's date
+	 * @param $Author String: Author's user name
+	 * @param $Comments String
 	 */
-	function FeedItem( $Title, $Description, $Url, $Date = '', $Author = '', $Comments = '' ) {
+	function __construct( $Title, $Description, $Url, $Date = '', $Author = '', $Comments = '' ) {
 		$this->Title = $Title;
 		$this->Description = $Description;
 		$this->Url = $Url;
+		$this->UniqueId = $Url;
+		$this->RSSIsPermalink = false;
 		$this->Date = $Date;
 		$this->Author = $Author;
 		$this->Comments = $Comments;
 	}
-	
+
 	/**
-	 * @static
+	 * Encode $string so that it can be safely embedded in a XML document
+	 *
+	 * @param $string String: string to encode
+	 * @return String
 	 */
-	function xmlEncode( $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 );
 	}
-	
-	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;
+
+	/**
+	 * Get the unique id of this item
+	 *
+	 * @return String
+	 */
+	public function getUniqueId() {
+		if ( $this->UniqueId ) {
+			return $this->xmlEncode( $this->UniqueId );
+		}
+	}
+
+	/**
+	 * set the unique id of an item
+	 *
+	 * @param $uniqueId String: unique id for the item
+	 * @param $RSSisPermalink Boolean: 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 description of this item; already xml-encoded
+	 *
+	 * @return String
+	 */
+	public function getDescription() {
+		return $this->xmlEncode( $this->Description );
+	}
+
+	/**
+	 * Get the language of this item
+	 *
+	 * @return String
+	 */
+	public function getLanguage() {
+		global $wgLanguageCode;
+		return $wgLanguageCode;
+	}
+
+	/**
+	 * Get the title 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 comment of this item; already xml-encoded
+	 *
+	 * @return String
+	 */
+	public function getComments() {
+		return $this->xmlEncode( $this->Comments );
+	}
+
+	/**
+	 * Quickie hack... strip out wikilinks to more legible form from the comment.
+	 *
+	 * @param $text String: wikitext
+	 * @return String
+	 */
+	public static function stripComment( $text ) {
+		return preg_replace( '/\[\[([^]]*\|)?([^]]+)\]\]/', '\2', $text );
 	}
-	function getDate() { return $this->Date; }
-	function getAuthor() { return $this->xmlEncode( $this->Author ); }
-	function getComments() { return $this->xmlEncode( $this->Comments ); }
 	/**#@-*/
 }
 
 /**
- * @todo document
- * @package MediaWiki
+ * @todo document (needs one-sentence top-level class description).
+ * @ingroup Feed
  */
 class ChannelFeed extends FeedItem {
 	/**#@+
 	 * Abstract function, override!
 	 * @abstract
 	 */
-	 
+
 	/**
 	 * Generate Header of the feed
 	 */
 	function outHeader() {
 		# print "<feed>";
 	}
-	
+
 	/**
 	 * Generate an item
 	 * @param $item
@@ -100,7 +204,7 @@ class ChannelFeed extends FeedItem {
 	function outItem( $item ) {
 		# print "<item>...</item>";
 	}
-	
+
 	/**
 	 * Generate Footer of the feed
 	 */
@@ -108,7 +212,7 @@ class ChannelFeed extends FeedItem {
 		# print "</feed>";
 	}
 	/**#@-*/
-	
+
 	/**
 	 * Setup and send HTTP headers. Don't send any content;
 	 * content might end up being cached and re-sent with
@@ -116,25 +220,23 @@ class ChannelFeed extends FeedItem {
 	 *
 	 * This should be called from the outHeader() method,
 	 * but can also be called separately.
-	 *
-	 * @access public
 	 */
-	function httpHeaders() {
+	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
+	 * @private
 	 */
 	function contentType() {
 		global $wgRequest;
@@ -142,44 +244,46 @@ class ChannelFeed extends FeedItem {
 		$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
+	 * @private
 	 */
 	function outXmlHeader() {
-		global $wgServer, $wgStylePath;
-		
+		global $wgStylePath, $wgStyleVersion;
+
 		$this->httpHeaders();
-		echo '<?xml version="1.0" encoding="utf-8"?' . ">\n";
+		echo '<?xml version="1.0"?>' . "\n";
 		echo '<?xml-stylesheet type="text/css" href="' .
-			htmlspecialchars( "$wgServer$wgStylePath/common/feed.css" ) . '"?' . ">\n";
+			htmlspecialchars( wfExpandUrl( "$wgStylePath/common/feed.css?$wgStyleVersion" ) ) .
+			'"?' . ">\n";
 	}
 }
 
 /**
  * Generate a RSS feed
- * @todo document
- * @package MediaWiki
+ *
+ * @ingroup Feed
  */
 class RSSFeed extends ChannelFeed {
 
 	/**
 	 * Format a date given a timestamp
-	 * @param integer $ts Timestamp
-	 * @return string Date string
+	 *
+	 * @param $ts Integer: 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();
 		?><rss version="2.0" xmlns:dc="http://purl.org/dc/elements/1.1/">
 	<channel>
@@ -191,16 +295,17 @@ class RSSFeed extends ChannelFeed {
 		<lastBuildDate><?php print $this->formatTime( wfTimestampNow() ) ?></lastBuildDate>
 <?php
 	}
-	
+
 	/**
 	 * Output an RSS 2.0 item
-	 * @param FeedItem item to be output
+	 * @param $item FeedItem: item to be output
 	 */
 	function outItem( $item ) {
 	?>
 		<item>
 			<title><?php print $item->getTitle() ?></title>
 			<link><?php print $item->getUrl() ?></link>
+			<guid<?php if( !$item->RSSIsPermalink ) print ' isPermaLink="false"' ?>><?php print $item->getUniqueId() ?></guid>
 			<description><?php print $item->getDescription() ?></description>
 			<?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 }?>
@@ -221,8 +326,8 @@ class RSSFeed extends ChannelFeed {
 
 /**
  * Generate an Atom feed
- * @todo document
- * @package MediaWiki
+ *
+ * @ingroup Feed
  */
 class AtomFeed extends ChannelFeed {
 	/**
@@ -234,52 +339,75 @@ class AtomFeed extends ChannelFeed {
 	}
 
 	/**
-	 * @todo document
+	 * Outputs a basic header for Atom 1.0 feeds.
 	 */
 	function outHeader() {
-		global $wgVersion, $wgOut;
-		
+		global $wgVersion;
+
 		$this->outXmlHeader();
-		?><feed version="0.3" xmlns="http://purl.org/atom/ns#" xml:lang="<?php print $this->getLanguage() ?>">	
+		?><feed xmlns="http://www.w3.org/2005/Atom" xml:lang="<?php print $this->getLanguage() ?>">
+		<id><?php print $this->getFeedId() ?></id>
 		<title><?php print $this->getTitle() ?></title>
+		<link rel="self" type="application/atom+xml" href="<?php print $this->getSelfUrl() ?>"/>
 		<link rel="alternate" type="text/html" href="<?php print $this->getUrl() ?>"/>
-		<modified><?php print $this->formatTime( wfTimestampNow() ) ?>Z</modified>
-		<tagline><?php print $this->getDescription() ?></tagline>
+		<updated><?php print $this->formatTime( wfTimestampNow() ) ?>Z</updated>
+		<subtitle><?php print $this->getDescription() ?></subtitle>
 		<generator>MediaWiki <?php print $wgVersion ?></generator>
-		
+
 <?php
 	}
-	
+
 	/**
-	 * @todo document
+	 * 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
+	 * @private
+	 */
+	function getFeedId() {
+		return $this->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;
 	?>
 	<entry>
+		<id><?php print $item->getUniqueId() ?></id>
 		<title><?php print $item->getTitle() ?></title>
 		<link rel="alternate" type="<?php print $wgMimeType ?>" href="<?php print $item->getUrl() ?>"/>
 		<?php if( $item->getDate() ) { ?>
-		<modified><?php print $this->formatTime( $item->getDate() ) ?>Z</modified>
-		<issued><?php print $this->formatTime( $item->getDate() ) ?></issued>
-		<created><?php print $this->formatTime( $item->getDate() ) ?>Z</created><?php } ?>
-	
-		<summary type="text/plain"><?php print $item->getDescription() ?></summary>
-		<?php if( $item->getAuthor() ) { ?><author><name><?php print $item->getAuthor() ?></name><!-- <url></url><email></email> --></author><?php }?>
-		<comment>foobar</comment>
+		<updated><?php print $this->formatTime( $item->getDate() ) ?>Z</updated>
+		<?php } ?>
+
+		<summary type="html"><?php print $item->getDescription() ?></summary>
+		<?php if( $item->getAuthor() ) { ?><author><name><?php print $item->getAuthor() ?></name></author><?php }?>
 	</entry>
 
 <?php /* FIXME need to add comments
 	<?php if( $item->getComments() ) { ?><dc:comment><?php print $item->getComments() ?></dc:comment><?php }?>
       */
 	}
-	
+
 	/**
-	 * @todo document
+	 * Outputs the footer for Atom 1.0 feed (basicly '\</feed\>').
 	 */
 	function outFooter() {?>
 	</feed><?php
 	}
 }
-
-?>