* (bug 153) Adjust thumbnail size calculations to match consistently;
[lhc/web/wiklou.git] / includes / Feed.php
index f50d7ee..f8a0784 100644 (file)
 
 /**
  * Contain a feed class as well as classes to build rss / atom ... feeds
+ * Available feeds are defined in Defines.php
  * @package MediaWiki
  */
 
-/**
- * Available feeds objects
- */
-$wgFeedClasses = array(
-       'rss' => 'RSSFeed',
-       'atom' => 'AtomFeed',
-       );
 
 /**
  * @todo document
@@ -48,7 +42,7 @@ class FeedItem {
        var $Author = '';
        /**#@-*/
        
-       /**
+       /**#@+
         * @todo document
         */
        function FeedItem( $Title, $Description, $Url, $Date = '', $Author = '', $Comments = '' ) {
@@ -62,48 +56,24 @@ class FeedItem {
        
        /**
         * @static
-        * @todo document
         */
        function xmlEncode( $string ) {
-               global $wgInputEncoding, $wgLang;
                $string = str_replace( "\r\n", "\n", $string );
-               if( strcasecmp( $wgInputEncoding, 'utf-8' ) != 0 ) {
-                       $string = $wgLang->iconv( $wgInputEncoding, 'utf-8', $string );
-               }
+               $string = preg_replace( '/[\x00-\x08\x0b\x0c\x0e-\x1f]/', '', $string );
                return htmlspecialchars( $string );
        }
        
-       /**
-        * @todo document
-        */
        function getTitle() { return $this->xmlEncode( $this->Title ); }
-       /**
-        * @todo document
-        */
        function getUrl() { return $this->xmlEncode( $this->Url ); }
-       /**
-        * @todo document
-        */
        function getDescription() { return $this->xmlEncode( $this->Description ); }
-       /**
-        * @todo document
-        */
        function getLanguage() {
-               global $wgLanguageCode;
-               return $wgLanguageCode;
+               global $wgContLanguageCode;
+               return $wgContLanguageCode;
        }
-       /**
-        * @todo document
-        */
        function getDate() { return $this->Date; }
-       /**
-        * @todo document
-        */
        function getAuthor() { return $this->xmlEncode( $this->Author ); }
-       /**
-        * @todo document
-        */
        function getComments() { return $this->xmlEncode( $this->Comments ); }
+       /**#@-*/
 }
 
 /**
@@ -140,20 +110,51 @@ class ChannelFeed extends FeedItem {
        /**#@-*/
        
        /**
-        * @todo document
-        * @param string $mimetype (optional) type of output
+        * 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 outXmlHeader( $mimetype='application/xml' ) {
-               global $wgServer, $wgStylePath, $wgOut;
+       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();
                
-               print '<' . '?xml version="1.0" encoding="utf-8"?' . ">\n";
-               print '<' . '?xml-stylesheet type="text/css" href="' .
-                       htmlspecialchars( "$wgServer$wgStylePath/feed.css" ) . '"?' . ">\n";
+       }
+       
+       /**
+        * 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 '<?xml version="1.0" encoding="utf-8"?>' . "\n";
+               echo '<?xml-stylesheet type="text/css" href="' .
+                       htmlspecialchars( "$wgServer$wgStylePath/common/feed.css" ) . '"?' . ">\n";
        }
 }
 
@@ -170,7 +171,7 @@ class RSSFeed extends ChannelFeed {
         * @return string Date string
         */
        function formatTime( $ts ) {
-               return gmdate( 'D, d M Y H:i:s \G\M\T', wfTimestamp2Unix( $ts ) );
+               return gmdate( 'D, d M Y H:i:s \G\M\T', wfTimestamp( TS_UNIX, $ts ) );
        }
        
        /**
@@ -229,7 +230,7 @@ class AtomFeed extends ChannelFeed {
         */
        function formatTime( $ts ) {
                // need to use RFC 822 time format at least for rss2.0
-               return gmdate( 'Y-m-d\TH:i:s', wfTimestamp2Unix( $ts ) );
+               return gmdate( 'Y-m-d\TH:i:s', wfTimestamp( TS_UNIX, $ts ) );
        }
 
        /**
@@ -239,16 +240,41 @@ class AtomFeed extends ChannelFeed {
                global $wgVersion, $wgOut;
                
                $this->outXmlHeader();
-               ?><feed version="0.3" 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
        }
        
+       /**
+        * 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
         */
@@ -256,16 +282,15 @@ class AtomFeed extends ChannelFeed {
                global $wgMimeType;
        ?>
        <entry>
+               <id><?php print $item->getUrl() ?></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 } ?>
+               <updated><?php print $this->formatTime( $item->getDate() ) ?>Z</updated>
+               <?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>
+               <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