1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
|
<?php
/**
* Copyright © 2004 Brooke Vibber <bvibber@wikimedia.org>
* 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
*/
namespace MediaWiki\Feed;
use MediaWiki\Html\TemplateParser;
use MediaWiki\MainConfigNames;
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 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( MainConfigNames::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";
}
}
/** @deprecated class alias since 1.40 */
class_alias( ChannelFeed::class, 'ChannelFeed' );
|
