1f73b5d5e4
Why:
Both AtomFeed::formatTime() and RSSFeed::formatTime() short-circuit with
null if the input is falsy. This caused deprecation warnings down the
line, as the return value was later fed into str_replace(), which raises
a deprecation warning on PHP 8 if it gets null.
It also caused unexpected output on all PHP versions: the Mustache
templates for both Atom and RSS conditionally emit the date elements
(<updated> in Atom, <pubDate> in RSS), but this conditional output is
skipped only if the variable is null, not when it’s an empty string –
which is exactly what the XML encoding returned on all PHP versions.
What:
Introduce a new method, xmlEncodeNullable(), which properly handles null
values, and returns them as-is, without trying to encode them. This:
- Avoids the deprecation warnings on PHP 8, since str_replace() is no
longer called.
- Makes the conditional output work: the <updated>/<pubDate> elements
are no longer output if no date is available.
- This makes the RSS output spec-compliant, as no garbage is output
anymore. The RSS <pubDate> is optional [1].
- It doesn’t make the Atom output entirely spec-compliant, as Atom
requires <updated> to be present [2], but the removal of garbage
(it was a single letter Z) should still increase compatibility.
[1] https://www.rssboard.org/rss-specification#hrelementsOfLtitemgt
[2] https://validator.w3.org/feed/docs/atom.html#requiredEntryElements
Bug: T385332
Change-Id: Iafd89c0d61baecd7c68f62b2a0764cc78cf25069
(cherry picked from commit 60c57b0fd5303e9627b7684ebac4cd369c1fe7a6)
103 lines
3.1 KiB
PHP
103 lines
3.1 KiB
PHP
<?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;
|
|
|
|
/**
|
|
* Generate an RSS feed.
|
|
*
|
|
* @ingroup Feed
|
|
*/
|
|
class RSSFeed extends ChannelFeed {
|
|
|
|
/**
|
|
* Format a date given a timestamp. If a timestamp is not given, nothing is returned
|
|
*
|
|
* @param string|int|null $ts Timestamp
|
|
* @return string|null Date string
|
|
*/
|
|
private function formatTime( $ts ) {
|
|
if ( $ts ) {
|
|
return gmdate( 'D, d M Y H:i:s \G\M\T', (int)wfTimestamp( TS_UNIX, $ts ) );
|
|
}
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Output an RSS 2.0 header
|
|
*/
|
|
public function outHeader() {
|
|
$this->outXmlHeader();
|
|
// Manually escaping rather than letting Mustache do it because Mustache
|
|
// uses htmlentities, which does not work with XML
|
|
$templateParams = [
|
|
'title' => $this->getTitle(),
|
|
'url' => $this->xmlEncode(
|
|
$this->urlUtils->expand( $this->getUrlUnescaped(), PROTO_CURRENT ) ?? ''
|
|
),
|
|
'description' => $this->getDescription(),
|
|
'language' => $this->xmlEncode( $this->getLanguage() ),
|
|
'version' => $this->xmlEncode( MW_VERSION ),
|
|
'timestamp' => $this->xmlEncode( $this->formatTime( wfTimestampNow() ) )
|
|
];
|
|
print $this->templateParser->processTemplate( 'RSSHeader', $templateParams );
|
|
}
|
|
|
|
/**
|
|
* Output an RSS 2.0 item
|
|
* @param FeedItem $item Item to be output
|
|
*/
|
|
public function outItem( $item ) {
|
|
// Manually escaping rather than letting Mustache do it because Mustache
|
|
// uses htmlentities, which does not work with XML
|
|
$templateParams = [
|
|
"title" => $item->getTitle(),
|
|
"url" => $this->xmlEncode(
|
|
$this->urlUtils->expand( $item->getUrlUnescaped(), PROTO_CURRENT ) ?? ''
|
|
),
|
|
"permalink" => $item->rssIsPermalink,
|
|
"uniqueID" => $item->getUniqueID(),
|
|
"description" => $item->getDescription(),
|
|
"date" => $this->xmlEncodeNullable( $this->formatTime( $item->getDate() ) ),
|
|
"author" => $item->getAuthor()
|
|
];
|
|
$comments = $item->getCommentsUnescaped();
|
|
if ( $comments ) {
|
|
$commentsEscaped = $this->xmlEncode(
|
|
$this->urlUtils->expand( $comments, PROTO_CURRENT ) ?? ''
|
|
);
|
|
$templateParams["comments"] = $commentsEscaped;
|
|
}
|
|
print $this->templateParser->processTemplate( 'RSSItem', $templateParams );
|
|
}
|
|
|
|
/**
|
|
* Output an RSS 2.0 footer
|
|
*/
|
|
public function outFooter() {
|
|
print "</channel></rss>";
|
|
}
|
|
}
|
|
|
|
/** @deprecated class alias since 1.40 */
|
|
class_alias( RSSFeed::class, 'RSSFeed' );
|