2015-03-02 22:22:02 +01:00
|
|
|
<?php
|
|
|
|
/**
|
2019-02-06 17:18:33 +01:00
|
|
|
* MrssFormat - RSS 2.0 + Media RSS
|
|
|
|
* http://www.rssboard.org/rss-specification
|
|
|
|
* http://www.rssboard.org/media-rss
|
|
|
|
*
|
|
|
|
* Validators:
|
|
|
|
* https://validator.w3.org/feed/
|
|
|
|
* http://www.rssboard.org/rss-validator/
|
|
|
|
*
|
|
|
|
* Notes about the implementation:
|
|
|
|
*
|
|
|
|
* - The item author is not supported as it needs to be an e-mail address to be
|
|
|
|
* valid.
|
|
|
|
* - The RSS specification does not explicitly allow to have more than one
|
|
|
|
* enclosure as every item is meant to provide one "story", thus having
|
|
|
|
* multiple enclosures per item may lead to unexpected behavior.
|
|
|
|
* On top of that, it requires to have a length specified, which RSS-Bridge
|
|
|
|
* can't provide.
|
|
|
|
* - The Media RSS extension comes in handy, since it allows to have multiple
|
|
|
|
* enclosures, even though they recommend to have only one enclosure because
|
|
|
|
* of the one-story-per-item reason. It only requires to specify the URL,
|
|
|
|
* everything else is optional.
|
|
|
|
* - Since the Media RSS extension has its own namespace, the output is a valid
|
|
|
|
* RSS 2.0 feed that works with feed readers that don't support the extension.
|
|
|
|
*/
|
2016-09-10 20:41:11 +02:00
|
|
|
class MrssFormat extends FormatAbstract {
|
2019-10-31 19:00:12 +01:00
|
|
|
const MIME_TYPE = 'application/rss+xml';
|
|
|
|
|
2019-02-06 17:18:33 +01:00
|
|
|
const ALLOWED_IMAGE_EXT = array(
|
|
|
|
'.gif', '.jpg', '.png'
|
|
|
|
);
|
|
|
|
|
2016-09-10 20:41:11 +02:00
|
|
|
public function stringify(){
|
2019-02-06 17:18:33 +01:00
|
|
|
$urlPrefix = (isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'] == 'on') ? 'https://' : 'http://';
|
|
|
|
$urlHost = (isset($_SERVER['HTTP_HOST'])) ? $_SERVER['HTTP_HOST'] : '';
|
|
|
|
$urlPath = (isset($_SERVER['PATH_INFO'])) ? $_SERVER['PATH_INFO'] : '';
|
|
|
|
$urlRequest = (isset($_SERVER['REQUEST_URI'])) ? $_SERVER['REQUEST_URI'] : '';
|
2015-03-02 22:22:02 +01:00
|
|
|
|
2019-02-06 17:18:33 +01:00
|
|
|
$feedUrl = $this->xml_encode($urlPrefix . $urlHost . $urlRequest);
|
2015-03-02 22:22:02 +01:00
|
|
|
|
2016-09-10 20:41:11 +02:00
|
|
|
$extraInfos = $this->getExtraInfos();
|
|
|
|
$title = $this->xml_encode($extraInfos['name']);
|
2019-02-06 17:18:33 +01:00
|
|
|
$icon = $extraInfos['icon'];
|
2016-09-10 21:01:02 +02:00
|
|
|
|
2017-07-29 19:28:00 +02:00
|
|
|
if(!empty($extraInfos['uri'])) {
|
2016-09-10 21:01:02 +02:00
|
|
|
$uri = $this->xml_encode($extraInfos['uri']);
|
|
|
|
} else {
|
2018-11-05 19:05:59 +01:00
|
|
|
$uri = REPOSITORY;
|
2016-09-10 21:01:02 +02:00
|
|
|
}
|
|
|
|
|
2016-09-10 20:41:11 +02:00
|
|
|
$items = '';
|
2017-07-29 19:28:00 +02:00
|
|
|
foreach($this->getItems() as $item) {
|
2019-02-06 17:18:33 +01:00
|
|
|
$itemTimestamp = $item->getTimestamp();
|
2018-12-26 22:41:32 +01:00
|
|
|
$itemTitle = $this->xml_encode($item->getTitle());
|
|
|
|
$itemUri = $this->xml_encode($item->getURI());
|
|
|
|
$itemContent = $this->xml_encode($this->sanitizeHtml($item->getContent()));
|
2019-02-06 17:18:33 +01:00
|
|
|
$entryID = $item->getUid();
|
|
|
|
$isPermaLink = 'false';
|
|
|
|
|
|
|
|
if (empty($entryID) && !empty($itemUri)) { // Fallback to provided URI
|
|
|
|
$entryID = $itemUri;
|
|
|
|
$isPermaLink = 'true';
|
|
|
|
}
|
|
|
|
|
|
|
|
if (empty($entryID)) // Fallback to title and content
|
|
|
|
$entryID = hash('sha1', $itemTitle . $itemContent);
|
|
|
|
|
|
|
|
$entryTitle = '';
|
|
|
|
if (!empty($itemTitle))
|
|
|
|
$entryTitle = '<title>' . $itemTitle . '</title>';
|
|
|
|
|
|
|
|
$entryLink = '';
|
|
|
|
if (!empty($itemUri))
|
|
|
|
$entryLink = '<link>' . $itemUri . '</link>';
|
|
|
|
|
|
|
|
$entryPublished = '';
|
|
|
|
if (!empty($itemTimestamp)) {
|
|
|
|
$entryPublished = '<pubDate>'
|
|
|
|
. $this->xml_encode(gmdate(DATE_RFC2822, $itemTimestamp))
|
|
|
|
. '</pubDate>';
|
|
|
|
}
|
|
|
|
|
|
|
|
$entryDescription = '';
|
|
|
|
if (!empty($itemContent))
|
|
|
|
$entryDescription = '<description>' . $itemContent . '</description>';
|
2016-11-09 18:59:17 +01:00
|
|
|
|
2016-11-12 22:04:42 +01:00
|
|
|
$entryEnclosures = '';
|
2019-02-06 17:18:33 +01:00
|
|
|
foreach($item->getEnclosures() as $enclosure) {
|
|
|
|
$entryEnclosures .= '<media:content url="'
|
|
|
|
. $this->xml_encode($enclosure)
|
|
|
|
. '" type="' . getMimeType($enclosure) . '"/>'
|
|
|
|
. PHP_EOL;
|
2016-11-09 18:59:17 +01:00
|
|
|
}
|
|
|
|
|
2018-07-16 12:32:24 +02:00
|
|
|
$entryCategories = '';
|
2018-12-26 22:41:32 +01:00
|
|
|
foreach($item->getCategories() as $category) {
|
|
|
|
$entryCategories .= '<category>'
|
|
|
|
. $category . '</category>'
|
|
|
|
. PHP_EOL;
|
2018-07-16 12:32:24 +02:00
|
|
|
}
|
|
|
|
|
2016-09-10 20:41:11 +02:00
|
|
|
$items .= <<<EOD
|
2015-03-02 22:22:02 +01:00
|
|
|
|
2016-09-10 20:41:11 +02:00
|
|
|
<item>
|
2019-02-06 17:18:33 +01:00
|
|
|
{$entryTitle}
|
|
|
|
{$entryLink}
|
|
|
|
<guid isPermaLink="{$isPermaLink}">{$entryID}</guid>
|
|
|
|
{$entryPublished}
|
|
|
|
{$entryDescription}
|
2016-11-12 22:04:42 +01:00
|
|
|
{$entryEnclosures}
|
2018-07-16 12:32:24 +02:00
|
|
|
{$entryCategories}
|
2016-09-10 20:41:11 +02:00
|
|
|
</item>
|
2015-03-02 22:22:02 +01:00
|
|
|
|
|
|
|
EOD;
|
2016-09-10 20:41:11 +02:00
|
|
|
}
|
2015-03-02 22:22:02 +01:00
|
|
|
|
2016-11-07 20:49:44 +01:00
|
|
|
$charset = $this->getCharset();
|
|
|
|
|
2019-02-06 17:18:33 +01:00
|
|
|
$feedImage = '';
|
|
|
|
if (!empty($icon) && in_array(substr($icon, -4), self::ALLOWED_IMAGE_EXT)) {
|
|
|
|
$feedImage .= <<<EOD
|
|
|
|
<image>
|
|
|
|
<url>{$icon}</url>
|
|
|
|
<title>{$title}</title>
|
|
|
|
<link>{$uri}</link>
|
|
|
|
</image>
|
|
|
|
EOD;
|
|
|
|
}
|
|
|
|
|
2016-09-10 20:41:11 +02:00
|
|
|
/* Data are prepared, now let's begin the "MAGIE !!!" */
|
2016-11-07 20:49:44 +01:00
|
|
|
$toReturn = <<<EOD
|
|
|
|
<?xml version="1.0" encoding="{$charset}"?>
|
2019-02-06 17:18:33 +01:00
|
|
|
<rss version="2.0" xmlns:media="http://search.yahoo.com/mrss/" xmlns:atom="http://www.w3.org/2005/Atom">
|
2016-09-10 20:41:11 +02:00
|
|
|
<channel>
|
|
|
|
<title>{$title}</title>
|
2019-02-06 17:18:33 +01:00
|
|
|
<link>{$uri}</link>
|
2016-09-10 20:41:11 +02:00
|
|
|
<description>{$title}</description>
|
2019-02-06 17:18:33 +01:00
|
|
|
{$feedImage}
|
|
|
|
<atom:link rel="alternate" type="text/html" href="{$uri}"/>
|
|
|
|
<atom:link rel="self" href="{$feedUrl}" type="application/atom+xml"/>
|
2016-09-10 20:41:11 +02:00
|
|
|
{$items}
|
|
|
|
</channel>
|
2015-03-02 22:22:02 +01:00
|
|
|
</rss>
|
|
|
|
EOD;
|
|
|
|
|
2016-09-10 20:41:11 +02:00
|
|
|
// Remove invalid non-UTF8 characters
|
|
|
|
ini_set('mbstring.substitute_character', 'none');
|
2016-11-07 20:49:44 +01:00
|
|
|
$toReturn = mb_convert_encoding($toReturn, $this->getCharset(), 'UTF-8');
|
2016-09-10 20:41:11 +02:00
|
|
|
return $toReturn;
|
|
|
|
}
|
2015-03-02 22:22:02 +01:00
|
|
|
|
2016-09-10 20:41:11 +02:00
|
|
|
public function display(){
|
|
|
|
$this
|
2019-10-31 19:00:12 +01:00
|
|
|
->setContentType(self::MIME_TYPE . '; charset=' . $this->getCharset())
|
2016-09-10 20:41:11 +02:00
|
|
|
->callContentType();
|
2015-03-02 22:22:02 +01:00
|
|
|
|
2016-09-10 20:41:11 +02:00
|
|
|
return parent::display();
|
|
|
|
}
|
2016-08-09 17:05:29 +02:00
|
|
|
|
2016-09-10 20:41:11 +02:00
|
|
|
private function xml_encode($text){
|
|
|
|
return htmlspecialchars($text, ENT_XML1);
|
|
|
|
}
|
2015-03-02 22:22:02 +01:00
|
|
|
}
|