#3354 : LanguagePt update by Get_it

[lhc/web/wiklou.git] / includes / Feed.php

diff --git a/includes/Feed.php b/includes/Feed.php
index fcb077a..a798ce4 100644 (file)
--- a/includes/Feed.php
+++ b/includes/Feed.php
@@ -21,21 +21,17 @@
 
 /**
  * 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
+ * @package MediaWiki
  */
 class FeedItem {
-       /**@#+
+       /**#@+
         * @var string
         * @access private
         */
@@ -44,9 +40,9 @@ class FeedItem {
        var $Url = '';
        var $Date = '';
        var $Author = '';
-       /**@#-*/
+       /**#@-*/
        
-       /**
+       /**#@+
         * @todo document
         */
        function FeedItem( $Title, $Description, $Url, $Date = '', $Author = '', $Comments = '' ) {
@@ -60,112 +56,126 @@ 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 ); }
+       /**#@-*/
 }
 
 /**
  * @todo document
+ * @package MediaWiki
  */
 class ChannelFeed extends FeedItem {
-       /**@#+
+       /**#@+
         * Abstract function, override!
+        * @abstract
         */
         
        /**
-        * @todo document
+        * Generate Header of the feed
         */
        function outHeader() {
                # print "<feed>";
        }
        
        /**
-        * @todo document
+        * Generate an item
+        * @param $item
         */
        function outItem( $item ) {
                # print "<item>...</item>";
        }
        
        /**
-        * @todo document
+        * Generate Footer of the feed
         */
        function outFooter() {
                # print "</feed>";
        }
+       /**#@-*/
        
        /**
-        * @todo document
+        * 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";
+       }
 }
 
 /**
  * Generate a RSS feed
  * @todo document
+ * @package MediaWiki
  */
 class RSSFeed extends ChannelFeed {
 
        /**
-        * @todo document
+        * 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', wfTimestamp2Unix( $ts ) );
+               return gmdate( 'D, d M Y H:i:s \G\M\T', wfTimestamp( TS_UNIX, $ts ) );
        }
        
        /**
-        * @todo document
+        * Ouput an RSS 2.0 header
         */
        function outHeader() {
                global $wgVersion;
@@ -183,7 +193,8 @@ class RSSFeed extends ChannelFeed {
        }
        
        /**
-        * @todo document
+        * Output an RSS 2.0 item
+        * @param FeedItem item to be output
         */
        function outItem( $item ) {
        ?>
@@ -199,7 +210,7 @@ class RSSFeed extends ChannelFeed {
        }
 
        /**
-        * @todo document
+        * Ouput an RSS 2.0 footer
         */
        function outFooter() {
        ?>
@@ -211,6 +222,7 @@ class RSSFeed extends ChannelFeed {
 /**
  * Generate an Atom feed
  * @todo document
+ * @package MediaWiki
  */
 class AtomFeed extends ChannelFeed {
        /**
@@ -218,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 ) );
        }
 
        /**