47adb6d65a
Automatically refactors wg prefixed globals to use MediaWikiServices config using Rector. Doesn't include files that set globals or files that fail CI. Rector Gist: https://gist.github.com/tchin25/7cc54f6d23aedef010b22e4dfbead228 * This patch uses a modified source code rector library for our specific use case and the rector will have different effects without it. A writeup for future reference is here: https://meta.wikimedia.org/wiki/User:TChin_(WMF)/Using_Rector_On_MediaWiki Change-Id: I1a691f01cd82e60bf41207d32501edb4b9835e37
139 lines
3.5 KiB
PHP
139 lines
3.5 KiB
PHP
<?php
|
|
|
|
/**
|
|
* Copyright © 2004 Brion Vibber <brion@pobox.com>
|
|
* https://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
|
|
*/
|
|
|
|
use MediaWiki\MediaWikiServices;
|
|
|
|
/**
|
|
* Class to support the outputting of syndication feeds in Atom and RSS format.
|
|
*
|
|
* @stable to extend
|
|
* @ingroup Feed
|
|
*/
|
|
abstract class ChannelFeed extends FeedItem {
|
|
|
|
/** @var TemplateParser */
|
|
protected $templateParser;
|
|
|
|
/**
|
|
* @stable to call
|
|
*
|
|
* @param string|Title $title Feed's title
|
|
* @param string $description
|
|
* @param string $url URL uniquely designating the feed.
|
|
* @param string $date Feed's date
|
|
* @param string $author Author's user name
|
|
* @param string $comments
|
|
*
|
|
*/
|
|
public function __construct(
|
|
$title, $description, $url, $date = '', $author = '', $comments = ''
|
|
) {
|
|
parent::__construct( $title, $description, $url, $date, $author, $comments );
|
|
$this->templateParser = new TemplateParser();
|
|
}
|
|
|
|
/**
|
|
* Generate Header of the feed
|
|
* @par Example:
|
|
* @code
|
|
* print "<feed>";
|
|
* @endcode
|
|
*/
|
|
abstract public function outHeader();
|
|
|
|
/**
|
|
* Generate an item
|
|
* @par Example:
|
|
* @code
|
|
* print "<item>...</item>";
|
|
* @endcode
|
|
* @param FeedItem $item
|
|
*/
|
|
abstract public function outItem( $item );
|
|
|
|
/**
|
|
* Generate Footer of the feed
|
|
* @par Example:
|
|
* @code
|
|
* print "</feed>";
|
|
* @endcode
|
|
*/
|
|
abstract public function outFooter();
|
|
|
|
/**
|
|
* Setup and send HTTP headers. Don't send any content;
|
|
* content might end up being cached and re-sent with
|
|
* these same headers later.
|
|
*
|
|
* This should be called from the outHeader() method,
|
|
* but can also be called separately.
|
|
*/
|
|
public function httpHeaders() {
|
|
global $wgOut;
|
|
$varyOnXFP = MediaWikiServices::getInstance()->getMainConfig()->get( 'VaryOnXFP' );
|
|
# We take over from $wgOut, excepting its cache header info
|
|
$wgOut->disable();
|
|
$mimetype = $this->contentType();
|
|
header( "Content-type: $mimetype; charset=UTF-8" );
|
|
|
|
// Set a sensible filename
|
|
$mimeAnalyzer = MediaWikiServices::getInstance()->getMimeAnalyzer();
|
|
$ext = $mimeAnalyzer->getExtensionFromMimeTypeOrNull( $mimetype ) ?? 'xml';
|
|
header( "Content-Disposition: inline; filename=\"feed.{$ext}\"" );
|
|
|
|
if ( $varyOnXFP ) {
|
|
$wgOut->addVaryHeader( 'X-Forwarded-Proto' );
|
|
}
|
|
$wgOut->sendCacheControl();
|
|
}
|
|
|
|
/**
|
|
* Return an internet media type to be sent in the headers.
|
|
*
|
|
* @stable to override
|
|
*
|
|
* @return string
|
|
*/
|
|
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' );
|
|
}
|
|
|
|
/**
|
|
* Output the initial XML headers.
|
|
*/
|
|
protected function outXmlHeader() {
|
|
$this->httpHeaders();
|
|
echo '<?xml version="1.0"?>' . "\n";
|
|
}
|
|
}
|