ChannelFeed.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\Feed;
 
use MediaWiki\Html\TemplateParser;
use MediaWiki\MainConfigNames;
use MediaWiki\MediaWikiServices;
use MediaWiki\Output\OutputPage;
use MediaWiki\Request\WebRequest;
 
abstract class ChannelFeed extends FeedItem {
 
    protected $templateParser;
 
    public function __construct(
        $title, $description, $url, $date = '', $author = '', $comments = ''
    ) {
        parent::__construct( $title, $description, $url, $date, $author, $comments );
        $this->templateParser = new TemplateParser();
    }
 
    abstract public function outputHeader( $output ): void;
 
    abstract public function outputItem( FeedItem $item, $output ): void;
 
    abstract public function outputFooter( $output ): void;
 
    public function sendHttpHeaders( $output ): void {
        $varyOnXFP = MediaWikiServices::getInstance()->getMainConfig()
            ->get( MainConfigNames::VaryOnXFP );
        # We take over from $wgOut, excepting its cache header info
        $output->disable();
        $mimetype = $this->contentType( $output->getRequest() );
        header( "Content-type: $mimetype; charset=UTF-8" );
        // @todo Maybe set a CSP header here at some point as defense in depth.
        // need to figure out how that interacts with browser display of article
        // snippets.
 
        // Set a sensible filename
        $mimeAnalyzer = MediaWikiServices::getInstance()->getMimeAnalyzer();
        $ext = $mimeAnalyzer->getExtensionFromMimeTypeOrNull( $mimetype ) ?? 'xml';
        header( "Content-Disposition: inline; filename=\"feed.{$ext}\"" );
 
        if ( $varyOnXFP ) {
            $output->addVaryHeader( 'X-Forwarded-Proto' );
        }
        $output->sendCacheControl();
    }
 
    private function contentType( $request ): string {
        $ctype = $request->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 outputXmlHeader( $output ): void {
        $this->sendHttpHeaders( $output );
        echo '<?xml version="1.0"?>' . "\n";
    }
}