mark ApiEditPageTest as being slow tests

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

diff --git a/includes/Feed.php b/includes/Feed.php
index 7938803..f9dbf5b 100644 (file)
--- a/includes/Feed.php
+++ b/includes/Feed.php
@@ -36,38 +36,37 @@
  * @ingroup Feed
  */
 class FeedItem {
-       /**#@+
-        * @var string
-        * @private
+       /**
+        * @var Title
         */
-       var $Title = 'Wiki';
-       var $Description = '';
-       var $Url = '';
-       var $Date = '';
-       var $Author = '';
-       var $UniqueId = '';
-       var $RSSIsPermalink;
-       /**#@-*/
+       var $title;
+
+       var $description;
+       var $url;
+       var $date;
+       var $author;
+       var $uniqueId;
+       var $comments;
+       var $rssIsPermalink = false;
 
        /**
         * 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
+        * @param $title String|Title 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 __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;
+       function __construct( $title, $description, $url, $date = '', $author = '', $comments = '' ) {
+               $this->title = $title;
+               $this->description = $description;
+               $this->url = $url;
+               $this->uniqueId = $url;
+               $this->date = $date;
+               $this->author = $author;
+               $this->comments = $comments;
        }
 
        /**
@@ -88,8 +87,8 @@ class FeedItem {
         * @return String
         */
        public function getUniqueId() {
-               if ( $this->UniqueId ) {
-                       return $this->xmlEncode( $this->UniqueId );
+               if ( $this->uniqueId ) {
+                       return $this->xmlEncode( $this->uniqueId );
                }
        }
 
@@ -97,11 +96,11 @@ class FeedItem {
         * 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)
+        * @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 = $isPermalink;
+       public function setUniqueId( $uniqueId, $rssIsPermalink = false ) {
+               $this->uniqueId = $uniqueId;
+               $this->rssIsPermalink = $rssIsPermalink;
        }
 
        /**
@@ -110,7 +109,7 @@ class FeedItem {
         * @return String
         */
        public function getTitle() {
-               return $this->xmlEncode( $this->Title );
+               return $this->xmlEncode( $this->title );
        }
 
        /**
@@ -119,7 +118,7 @@ class FeedItem {
         * @return String
         */
        public function getUrl() {
-               return $this->xmlEncode( $this->Url );
+               return $this->xmlEncode( $this->url );
        }
 
        /**
@@ -128,7 +127,7 @@ class FeedItem {
         * @return String
         */
        public function getDescription() {
-               return $this->xmlEncode( $this->Description );
+               return $this->xmlEncode( $this->description );
        }
 
        /**
@@ -147,7 +146,7 @@ class FeedItem {
         * @return String
         */
        public function getDate() {
-               return $this->Date;
+               return $this->date;
        }
 
        /**
@@ -156,7 +155,7 @@ class FeedItem {
         * @return String
         */
        public function getAuthor() {
-               return $this->xmlEncode( $this->Author );
+               return $this->xmlEncode( $this->author );
        }
 
        /**
@@ -165,7 +164,7 @@ class FeedItem {
         * @return String
         */
        public function getComments() {
-               return $this->xmlEncode( $this->Comments );
+               return $this->xmlEncode( $this->comments );
        }
 
        /**
@@ -184,34 +183,35 @@ class FeedItem {
  * @todo document (needs one-sentence top-level class description).
  * @ingroup Feed
  */
-class ChannelFeed extends FeedItem {
-       /**#@+
-        * Abstract function, override!
-        * @abstract
-        */
-
+abstract class ChannelFeed extends FeedItem {
        /**
         * Generate Header of the feed
+        * @par Example:
+        * @code
+        * print "<feed>";
+        * @endcode
+        * @param $item
         */
-       function outHeader() {
-               # print "<feed>";
-       }
+       abstract public function outHeader();
 
        /**
         * Generate an item
+        * @par Example:
+        * @code
+        * print "<item>...</item>";
+        * @endcode
         * @param $item
         */
-       function outItem( $item ) {
-               # print "<item>...</item>";
-       }
+       abstract public function outItem( $item );
 
        /**
         * Generate Footer of the feed
+        * @par Example:
+        * @code
+        * print "</feed>";
+        * @endcode
         */
-       function outFooter() {
-               # print "</feed>";
-       }
-       /**#@-*/
+       abstract public function outFooter();
 
        /**
         * Setup and send HTTP headers. Don't send any content;
@@ -222,12 +222,15 @@ class ChannelFeed extends FeedItem {
         * but can also be called separately.
         */
        public function httpHeaders() {
-               global $wgOut;
+               global $wgOut, $wgVaryOnXFP;
 
                # We take over from $wgOut, excepting its cache header info
                $wgOut->disable();
                $mimetype = $this->contentType();
                header( "Content-type: $mimetype; charset=UTF-8" );
+               if ( $wgVaryOnXFP ) {
+                       $wgOut->addVaryHeader( 'X-Forwarded-Proto' );
+               }
                $wgOut->sendCacheControl();
 
        }
@@ -256,7 +259,7 @@ class ChannelFeed extends FeedItem {
                $this->httpHeaders();
                echo '<?xml version="1.0"?>' . "\n";
                echo '<?xml-stylesheet type="text/css" href="' .
-                       htmlspecialchars( wfExpandUrl( "$wgStylePath/common/feed.css?$wgStyleVersion" ) ) .
+                       htmlspecialchars( wfExpandUrl( "$wgStylePath/common/feed.css?$wgStyleVersion", PROTO_CURRENT ) ) .
                        '"?' . ">\n";
        }
 }
@@ -288,7 +291,7 @@ class RSSFeed extends ChannelFeed {
                ?><rss version="2.0" xmlns:dc="http://purl.org/dc/elements/1.1/">
        <channel>
                <title><?php print $this->getTitle() ?></title>
-               <link><?php print $this->getUrl() ?></link>
+               <link><?php print wfExpandUrl( $this->getUrl(), PROTO_CURRENT ) ?></link>
                <description><?php print $this->getDescription() ?></description>
                <language><?php print $this->getLanguage() ?></language>
                <generator>MediaWiki <?php print $wgVersion ?></generator>
@@ -304,12 +307,12 @@ class RSSFeed extends ChannelFeed {
        ?>
                <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>
+                       <link><?php print wfExpandUrl( $item->getUrl(), PROTO_CURRENT ) ?></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 }?>
-                       <?php if( $item->getComments() ) { ?><comments><?php print $item->getComments() ?></comments><?php }?>
+                       <?php if( $item->getComments() ) { ?><comments><?php print wfExpandUrl( $item->getComments(), PROTO_CURRENT ) ?></comments><?php }?>
                </item>
 <?php
        }
@@ -332,6 +335,7 @@ class RSSFeed extends ChannelFeed {
 class AtomFeed extends ChannelFeed {
        /**
         * @todo document
+        * @return string
         */
        function formatTime( $ts ) {
                // need to use RFC 822 time format at least for rss2.0
@@ -348,8 +352,8 @@ class AtomFeed extends ChannelFeed {
                ?><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() ?>"/>
+               <link rel="self" type="application/atom+xml" href="<?php print wfExpandUrl( $this->getSelfUrl(), PROTO_CURRENT ) ?>"/>
+               <link rel="alternate" type="text/html" href="<?php print wfExpandUrl( $this->getUrl(), PROTO_CURRENT ) ?>"/>
                <updated><?php print $this->formatTime( wfTimestampNow() ) ?>Z</updated>
                <subtitle><?php print $this->getDescription() ?></subtitle>
                <generator>MediaWiki <?php print $wgVersion ?></generator>
@@ -390,7 +394,7 @@ class AtomFeed extends ChannelFeed {
        <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() ?>"/>
+               <link rel="alternate" type="<?php print $wgMimeType ?>" href="<?php print wfExpandUrl( $item->getUrl(), PROTO_CURRENT ) ?>"/>
                <?php if( $item->getDate() ) { ?>
                <updated><?php print $this->formatTime( $item->getDate() ) ?>Z</updated>
                <?php } ?>
@@ -399,9 +403,9 @@ class AtomFeed extends ChannelFeed {
                <?php if( $item->getAuthor() ) { ?><author><name><?php print $item->getAuthor() ?></name></author><?php }?>
        </entry>
 
-<?php /* FIXME need to add comments
+<?php /* @todo FIXME: Need to add comments
        <?php if( $item->getComments() ) { ?><dc:comment><?php print $item->getComments() ?></dc:comment><?php }?>
-      */
+         */
        }
 
        /**