AtomFeed.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\Feed;
 
use MediaWiki\MainConfigNames;
use MediaWiki\MediaWikiServices;
use Wikimedia\Timestamp\TimestampFormat as TS;
 
class AtomFeed extends ChannelFeed {
    private function formatTime( $timestamp ) {
        if ( $timestamp ) {
            // need to use RFC 822 time format at least for rss2.0
            return gmdate( 'Y-m-d\TH:i:s', (int)wfTimestamp( TS::UNIX, $timestamp ) );
        }
        return null;
    }
 
    public function outHeader() {
        $this->outXmlHeader();
        // Manually escaping rather than letting Mustache do it because Mustache
        // uses htmlentities, which does not work with XML
        $templateParams = [
            'language' => $this->xmlEncode( $this->getLanguage() ),
            // Atom 1.0 requires a unique, opaque IRI as a unique identifier
            // 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.
            'feedID' => $this->getSelfUrl(),
            'title' => $this->getTitle(),
            'url' => $this->xmlEncode(
                $this->urlUtils->expand( $this->getUrlUnescaped(), PROTO_CURRENT ) ?? ''
            ),
            'selfUrl' => $this->getSelfUrl(),
            'timestamp' => $this->xmlEncode( $this->formatTime( wfTimestampNow() ) ),
            'description' => $this->getDescription(),
            'version' => $this->xmlEncode( MW_VERSION ),
        ];
        print $this->templateParser->processTemplate( 'AtomHeader', $templateParams );
    }
 
    private function getSelfUrl() {
        global $wgRequest;
        return htmlspecialchars( $wgRequest->getFullRequestURL() );
    }
 
    public function outItem( $item ) {
        $mimeType = MediaWikiServices::getInstance()->getMainConfig()
            ->get( MainConfigNames::MimeType );
        // Manually escaping rather than letting Mustache do it because Mustache
        // uses htmlentities, which does not work with XML
        $templateParams = [
            "uniqueID" => $item->getUniqueID(),
            "title" => $item->getTitle(),
            "mimeType" => $this->xmlEncode( $mimeType ),
            "url" => $this->xmlEncode(
                $this->urlUtils->expand( $item->getUrlUnescaped(), PROTO_CURRENT ) ?? ''
            ),
            "date" => $this->xmlEncodeNullable( $this->formatTime( $item->getDate() ) ),
            "description" => $item->getDescription(),
            "author" => $item->getAuthor()
        ];
        print $this->templateParser->processTemplate( 'AtomItem', $templateParams );
    }
 
    public function outFooter() {
        print "</feed>";
    }
}