<?php
-
-# 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.,
-# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
-# http://www.gnu.org/copyleft/gpl.html
-
/**
- * @defgroup Feed Feed
- *
* 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
*
+ * 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
+ */
+
/**
* A base class for basic support for outputting syndication feeds in RSS and other formats.
*
* @ingroup Feed
*/
class FeedItem {
- /**#@+
- * @var string
- * @private
+ /**
+ * @var Title
*/
- var $Title = 'Wiki';
- var $Description = '';
- var $Url = '';
- var $Date = '';
- var $Author = '';
- /**#@-*/
+ 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->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;
}
/**
return htmlspecialchars( $string );
}
+ /**
+ * 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 );
+ return $this->xmlEncode( $this->title );
}
/**
* @return String
*/
public function getUrl() {
- return $this->xmlEncode( $this->Url );
+ return $this->xmlEncode( $this->url );
}
/**
* @return String
*/
public function getDescription() {
- return $this->xmlEncode( $this->Description );
+ return $this->xmlEncode( $this->description );
}
/**
* @return String
*/
public function getLanguage() {
- global $wgContLanguageCode;
- return $wgContLanguageCode;
+ global $wgLanguageCode;
+ return $wgLanguageCode;
}
/**
* @return String
*/
public function getDate() {
- return $this->Date;
+ return $this->date;
}
/**
* @return String
*/
public function getAuthor() {
- return $this->xmlEncode( $this->Author );
+ return $this->xmlEncode( $this->author );
}
/**
* @return String
*/
public function getComments() {
- return $this->xmlEncode( $this->Comments );
+ return $this->xmlEncode( $this->comments );
}
-
+
/**
* Quickie hack... strip out wikilinks to more legible form from the comment.
*
* @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;
* 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();
}
*/
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');
+ $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');
}
/**
$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";
}
}
?><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>
?>
<item>
<title><?php print $item->getTitle() ?></title>
- <link><?php print $item->getUrl() ?></link>
+ <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
}
class AtomFeed extends ChannelFeed {
/**
* @todo document
+ * @return string
*/
function formatTime( $ts ) {
// need to use RFC 822 time format at least for rss2.0
?><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>
global $wgMimeType;
?>
<entry>
- <id><?php print $item->getUrl() ?></id>
+ <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 } ?>
<?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 }?>
- */
+ */
}
/**
dépôts / lhc / web / wiklou.git / blobdiff