Feed.php

Go to the documentation of this file.

<?php
class FeedItem {
    public $title;

    public $description;

    public $url;

    public $date;

    public $author;

    public $uniqueId;

    public $comments;

    public $rssIsPermalink = false;

    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;
    }

    public function xmlEncode( $string ) {
        $string = str_replace( "\r\n", "\n", $string );
        $string = preg_replace( '/[\x00-\x08\x0b\x0c\x0e-\x1f]/', '', $string );
        return htmlspecialchars( $string );
    }

    public function getUniqueId() {
        if ( $this->uniqueId ) {
            return $this->xmlEncode( wfExpandUrl( $this->uniqueId, PROTO_CURRENT ) );
        }
    }

    public function setUniqueId( $uniqueId, $rssIsPermalink = false ) {
        $this->uniqueId = $uniqueId;
        $this->rssIsPermalink = $rssIsPermalink;
    }

    public function getTitle() {
        return $this->xmlEncode( $this->title );
    }

    public function getUrl() {
        return $this->xmlEncode( $this->url );
    }

    public function getDescription() {
        return $this->xmlEncode( $this->description );
    }

    public function getLanguage() {
        global $wgLanguageCode;
        return wfBCP47( $wgLanguageCode );
    }

    public function getDate() {
        return $this->date;
    }

    public function getAuthor() {
        return $this->xmlEncode( $this->author );
    }

    public function getComments() {
        return $this->xmlEncode( $this->comments );
    }

    public static function stripComment( $text ) {
        return preg_replace( '/\[\[([^]]*\|)?([^]]+)\]\]/', '\2', $text );
    }
}

abstract class ChannelFeed extends FeedItem {
    abstract public function outHeader();

    abstract public function outItem( $item );

    abstract public function outFooter();

    public function httpHeaders() {
        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" );

        // Set a sane filename
        $exts = MimeMagic::singleton()->getExtensionsForType( $mimetype );
        $ext = $exts ? strtok( $exts, ' ' ) : 'xml';
        header( "Content-Disposition: inline; filename=\"feed.{$ext}\"" );

        if ( $wgVaryOnXFP ) {
            $wgOut->addVaryHeader( 'X-Forwarded-Proto' );
        }
        $wgOut->sendCacheControl();

    }

    private function contentType() {
        global $wgRequest;

        $ctype = $wgRequest->getVal( 'ctype', 'application/xml' );
        $allowedctypes = [
            'application/xml',
            'text/xml',
            'application/rss+xml',
            'application/atom+xml'
        ];

        return ( in_array( $ctype, $allowedctypes ) ? $ctype : 'application/xml' );
    }

    protected function outXmlHeader() {
        $this->httpHeaders();
        echo '<?xml version="1.0"?>' . "\n";
    }
}

class RSSFeed extends ChannelFeed {

    function formatTime( $ts ) {
        return gmdate( 'D, d M Y H:i:s \G\M\T', wfTimestamp( TS_UNIX, $ts ) );
    }

    function outHeader() {
        global $wgVersion;

        $this->outXmlHeader();
        ?><rss version="2.0" xmlns:dc="http://purl.org/dc/elements/1.1/">
    <channel>
        <title><?php print $this->getTitle() ?></title>
        <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>
        <lastBuildDate><?php print $this->formatTime( wfTimestampNow() ) ?></lastBuildDate>
<?php
    }

    function outItem( $item ) {
        // @codingStandardsIgnoreStart Ignore long lines and formatting issues.
    ?>
        <item>
            <title><?php print $item->getTitle(); ?></title>
            <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 wfExpandUrl( $item->getComments(), PROTO_CURRENT ); ?></comments><?php }?>
        </item>
<?php
        // @codingStandardsIgnoreEnd
    }

    function outFooter() {
    ?>
    </channel>
</rss><?php
    }
}

class AtomFeed extends ChannelFeed {
    function formatTime( $timestamp ) {
        // need to use RFC 822 time format at least for rss2.0
        return gmdate( 'Y-m-d\TH:i:s', wfTimestamp( TS_UNIX, $timestamp ) );
    }

    function outHeader() {
        global $wgVersion;

        $this->outXmlHeader();
        // @codingStandardsIgnoreStart Ignore long lines and formatting issues.
        ?><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 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>

<?php
        // @codingStandardsIgnoreEnd
    }

    private function getFeedId() {
        return $this->getSelfUrl();
    }

    private function getSelfUrl() {
        global $wgRequest;
        return htmlspecialchars( $wgRequest->getFullRequestURL() );
    }

    function outItem( $item ) {
        global $wgMimeType;
        // @codingStandardsIgnoreStart Ignore long lines and formatting issues.
    ?>
    <entry>
        <id><?php print $item->getUniqueId(); ?></id>
        <title><?php print $item->getTitle(); ?></title>
        <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 } ?>

        <summary type="html"><?php print $item->getDescription() ?></summary>
        <?php if ( $item->getAuthor() ) { ?><author><name><?php print $item->getAuthor(); ?></name></author><?php }?>
    </entry>

<?php /* @todo FIXME: Need to add comments
    <?php if( $item->getComments() ) { ?><dc:comment><?php print $item->getComments() ?></dc:comment><?php }?>
      */
    }

    function outFooter() {?>
    </feed><?php
        // @codingStandardsIgnoreEnd
    }
}