mirrors/rss-bridge
1
0
Fork 0
mirror of https://github.com/RSS-Bridge/rss-bridge.git synced 2024-12-20 19:10:09 +03:00
Code Issues Projects Releases Packages Wiki Activity
rss-bridge/formats/HtmlFormat.php

163 lines
4.2 KiB
PHP
Raw Normal View History

Refonte du code
2013-08-11 15:30:41 +04:00
<?php
[core] Apply common indentation All files are now using tabs for indentation
2016-09-10 21:41:11 +03:00
class HtmlFormat extends FormatAbstract {
formats: Add getMimeType() function (#1299) Allows getting the expected MIME type of the format's output. A corresponding MIME_TYPE constant is also defined in FormatAbstract for the format implementations to overwrite.
2019-10-31 21:00:12 +03:00
const MIME_TYPE = 'text/html';
[core] Apply common indentation All files are now using tabs for indentation
2016-09-10 21:41:11 +03:00
public function stringify(){
$extraInfos = $this->getExtraInfos();
$title = htmlspecialchars($extraInfos['name']);
$uri = htmlspecialchars($extraInfos['uri']);
[core] Support for bridge maintainers' donation URLs (#2102)
2021-06-25 22:45:25 +03:00
$donationUri = htmlspecialchars($extraInfos['donationUri']);
$donationsAllowed = Configuration::getConfig('admin', 'donations');
[HtmlFormat] Dynamically build buttons for other feed formats Adding or removing feed formats from the "formats/" directory currently has no effect on the buttons shown in the HTML format. This can cause errors if users press one of the buttons for a format that is no longer available on the server. This commit changes the behavior to dynamically add buttons based on the available formats. Syndication feeds, however, are no longer supported as they require knowledge about the content type, which is not known without further changes to the formats API (may be added later if there is a demand). Closes #942
2019-06-20 00:09:08 +03:00
// Dynamically build buttons for all formats (except HTML)
$formatFac = new FormatFactory();
$formatFac->setWorkingDir(PATH_LIB_FORMATS);
$buttons = '';
[HtmlFormat] Add syndication links (#1348) Adds <link> elements for each additional output format in the <head> of HTML format output to allow RSS readers to find the actual feeds directly from the HTML page.
2019-11-09 20:43:21 +03:00
$links = '';
[HtmlFormat] Dynamically build buttons for other feed formats Adding or removing feed formats from the "formats/" directory currently has no effect on the buttons shown in the HTML format. This can cause errors if users press one of the buttons for a format that is no longer available on the server. This commit changes the behavior to dynamically add buttons based on the available formats. Syndication feeds, however, are no longer supported as they require knowledge about the content type, which is not known without further changes to the formats API (may be added later if there is a demand). Closes #942
2019-06-20 00:09:08 +03:00
foreach($formatFac->getFormatNames() as $format) {
if(strcasecmp($format, 'HTML') === 0) {
continue;
}
[HtmlFormat] Use str_ireplace() when creating feed format URLs (#2008) Fixes feed format URLs not being created with correct format value if html feed URL uses a lowercase format value.
2021-03-08 10:17:12 +03:00
$query = str_ireplace('format=Html', 'format=' . $format, htmlentities($_SERVER['QUERY_STRING']));
[HtmlFormat] Dynamically build buttons for other feed formats Adding or removing feed formats from the "formats/" directory currently has no effect on the buttons shown in the HTML format. This can cause errors if users press one of the buttons for a format that is no longer available on the server. This commit changes the behavior to dynamically add buttons based on the available formats. Syndication feeds, however, are no longer supported as they require knowledge about the content type, which is not known without further changes to the formats API (may be added later if there is a demand). Closes #942
2019-06-20 00:09:08 +03:00
$buttons .= $this->buildButton($format, $query) . PHP_EOL;
[HtmlFormat] Add syndication links (#1348) Adds <link> elements for each additional output format in the <head> of HTML format output to allow RSS readers to find the actual feeds directly from the HTML page.
2019-11-09 20:43:21 +03:00
$mime = $formatFac->create($format)->getMimeType();
$links .= $this->buildLink($format, $query, $mime) . PHP_EOL;
[HtmlFormat] Dynamically build buttons for other feed formats Adding or removing feed formats from the "formats/" directory currently has no effect on the buttons shown in the HTML format. This can cause errors if users press one of the buttons for a format that is no longer available on the server. This commit changes the behavior to dynamically add buttons based on the available formats. Syndication feeds, however, are no longer supported as they require knowledge about the content type, which is not known without further changes to the formats API (may be added later if there is a demand). Closes #942
2019-06-20 00:09:08 +03:00
}
[core] Apply common indentation All files are now using tabs for indentation
2016-09-10 21:41:11 +03:00
[core] Support for bridge maintainers' donation URLs (#2102)
2021-06-25 22:45:25 +03:00
if($donationUri !== '' && $donationsAllowed) {
$buttons .= '<a href="'
. $donationUri
. '" target="_blank"><button class="highlight">Donate to maintainer</button></a>'
. PHP_EOL;
$links .= '<link href="'
. $donationUri
. ' target="_blank"" title="Donate to Maintainer" rel="alternate">'
. PHP_EOL;
}
[core] Apply common indentation All files are now using tabs for indentation
2016-09-10 21:41:11 +03:00
$entries = '';
[phpcs] Add missing rules - Do not add spaces after opening or before closing parenthesis // Wrong if( !is_null($var) ) { ... } // Right if(!is_null($var)) { ... } - Add space after closing parenthesis // Wrong if(true){ ... } // Right if(true) { ... } - Add body into new line - Close body in new line // Wrong if(true) { ... } // Right if(true) { ... } Notice: Spaces after keywords are not detected: // Wrong (not detected) // -> space after 'if' and missing space after 'else' if (true) { ... } else{ ... } // Right if(true) { ... } else { ... }
2017-07-29 20:28:00 +03:00
foreach($this->getItems() as $item) {
core: Add FeedItem class (#940) Add transformation from legacy items to FeedItems, before transforming items to the desired format. This allows using legacy bridges alongside bridges that return FeedItems. As discussed in #940, instead of throwing exceptions on invalid parameters, add messages to the debug log instead Add support for strings to setTimestamp(). If the provided timestamp is a string, automatically try to parse it using strtotime(). This allows bridges to simply use `$item['timestamp'] = $timestamp;` instead of `$item['timestamp'] = strtotime($timestamp);` Support simple_html_dom_node as input paramter for setURI Support simple_html_dom_node as input parameter for setContent
2018-12-27 00:41:32 +03:00
$entryAuthor = $item->getAuthor() ? '<br /><p class="author">by: ' . $item->getAuthor() . '</p>' : '';
$entryTitle = $this->sanitizeHtml(strip_tags($item->getTitle()));
$entryUri = $item->getURI() ?: $uri;
[core] Apply some fixes
2016-09-10 22:01:02 +03:00
[core] feat: improve date rendering in html formatter (#2516)
2022-03-22 22:41:13 +03:00
$entryDate = '';
core: Add FeedItem class (#940) Add transformation from legacy items to FeedItems, before transforming items to the desired format. This allows using legacy bridges alongside bridges that return FeedItems. As discussed in #940, instead of throwing exceptions on invalid parameters, add messages to the debug log instead Add support for strings to setTimestamp(). If the provided timestamp is a string, automatically try to parse it using strtotime(). This allows bridges to simply use `$item['timestamp'] = $timestamp;` instead of `$item['timestamp'] = strtotime($timestamp);` Support simple_html_dom_node as input paramter for setURI Support simple_html_dom_node as input parameter for setContent
2018-12-27 00:41:32 +03:00
if($item->getTimestamp()) {
[core] feat: improve date rendering in html formatter (#2516)
2022-03-22 22:41:13 +03:00
$entryDate = sprintf(
'<time datetime="%s">%s</time>',
date('Y-m-d H:i:s', $item->getTimestamp()),
date('Y-m-d H:i:s', $item->getTimestamp())
);
[core] Apply some fixes
2016-09-10 22:01:02 +03:00
}
$entryContent = '';
core: Add FeedItem class (#940) Add transformation from legacy items to FeedItems, before transforming items to the desired format. This allows using legacy bridges alongside bridges that return FeedItems. As discussed in #940, instead of throwing exceptions on invalid parameters, add messages to the debug log instead Add support for strings to setTimestamp(). If the provided timestamp is a string, automatically try to parse it using strtotime(). This allows bridges to simply use `$item['timestamp'] = $timestamp;` instead of `$item['timestamp'] = strtotime($timestamp);` Support simple_html_dom_node as input paramter for setURI Support simple_html_dom_node as input parameter for setContent
2018-12-27 00:41:32 +03:00
if($item->getContent()) {
[core] Apply some fixes
2016-09-10 22:01:02 +03:00
$entryContent = '<div class="content">'
core: Add FeedItem class (#940) Add transformation from legacy items to FeedItems, before transforming items to the desired format. This allows using legacy bridges alongside bridges that return FeedItems. As discussed in #940, instead of throwing exceptions on invalid parameters, add messages to the debug log instead Add support for strings to setTimestamp(). If the provided timestamp is a string, automatically try to parse it using strtotime(). This allows bridges to simply use `$item['timestamp'] = $timestamp;` instead of `$item['timestamp'] = strtotime($timestamp);` Support simple_html_dom_node as input paramter for setURI Support simple_html_dom_node as input parameter for setContent
2018-12-27 00:41:32 +03:00
. $this->sanitizeHtml($item->getContent())
[core] Apply some fixes
2016-09-10 22:01:02 +03:00
. '</div>';
}
[formats] Allow multiple enclosures All formats now support multiple enclosures. RSS will show a warning if more than one enclosure is used since many feed reader don't support multiple enclosures with RSS (also not clearly specified in the specification)
2016-11-13 00:04:42 +03:00
$entryEnclosures = '';
core: Add FeedItem class (#940) Add transformation from legacy items to FeedItems, before transforming items to the desired format. This allows using legacy bridges alongside bridges that return FeedItems. As discussed in #940, instead of throwing exceptions on invalid parameters, add messages to the debug log instead Add support for strings to setTimestamp(). If the provided timestamp is a string, automatically try to parse it using strtotime(). This allows bridges to simply use `$item['timestamp'] = $timestamp;` instead of `$item['timestamp'] = strtotime($timestamp);` Support simple_html_dom_node as input paramter for setURI Support simple_html_dom_node as input parameter for setContent
2018-12-27 00:41:32 +03:00
if(!empty($item->getEnclosures())) {
[formats] Allow multiple enclosures All formats now support multiple enclosures. RSS will show a warning if more than one enclosure is used since many feed reader don't support multiple enclosures with RSS (also not clearly specified in the specification)
2016-11-13 00:04:42 +03:00
$entryEnclosures = '<div class="attachments"><p>Attachments:</p>';
core: Add FeedItem class (#940) Add transformation from legacy items to FeedItems, before transforming items to the desired format. This allows using legacy bridges alongside bridges that return FeedItems. As discussed in #940, instead of throwing exceptions on invalid parameters, add messages to the debug log instead Add support for strings to setTimestamp(). If the provided timestamp is a string, automatically try to parse it using strtotime(). This allows bridges to simply use `$item['timestamp'] = $timestamp;` instead of `$item['timestamp'] = strtotime($timestamp);` Support simple_html_dom_node as input paramter for setURI Support simple_html_dom_node as input parameter for setContent
2018-12-27 00:41:32 +03:00
foreach($item->getEnclosures() as $enclosure) {
[formats] Allow multiple enclosures All formats now support multiple enclosures. RSS will show a warning if more than one enclosure is used since many feed reader don't support multiple enclosures with RSS (also not clearly specified in the specification)
2016-11-13 00:04:42 +03:00
$url = $this->sanitizeHtml($enclosure);
$entryEnclosures .= '<li class="enclosure"><a href="'
. $url
. '">'
. substr($url, strrpos($url, '/') + 1)
. '</a></li>';
}
$entryEnclosures .= '</div>';
[formats] Fix enclosures All bridges failed due to missing 'enclosures' element in the items array. With this commit all formats (ATOM, RSS and HTML) provide support for a single 'enclosure' element
2016-11-09 20:59:17 +03:00
}
Implemented feed item categories (#746)
2018-07-16 13:32:24 +03:00
$entryCategories = '';
core: Add FeedItem class (#940) Add transformation from legacy items to FeedItems, before transforming items to the desired format. This allows using legacy bridges alongside bridges that return FeedItems. As discussed in #940, instead of throwing exceptions on invalid parameters, add messages to the debug log instead Add support for strings to setTimestamp(). If the provided timestamp is a string, automatically try to parse it using strtotime(). This allows bridges to simply use `$item['timestamp'] = $timestamp;` instead of `$item['timestamp'] = strtotime($timestamp);` Support simple_html_dom_node as input paramter for setURI Support simple_html_dom_node as input parameter for setContent
2018-12-27 00:41:32 +03:00
if(!empty($item->getCategories())) {
Implemented feed item categories (#746)
2018-07-16 13:32:24 +03:00
$entryCategories = '<div class="categories"><p>Categories:</p>';
core: Add FeedItem class (#940) Add transformation from legacy items to FeedItems, before transforming items to the desired format. This allows using legacy bridges alongside bridges that return FeedItems. As discussed in #940, instead of throwing exceptions on invalid parameters, add messages to the debug log instead Add support for strings to setTimestamp(). If the provided timestamp is a string, automatically try to parse it using strtotime(). This allows bridges to simply use `$item['timestamp'] = $timestamp;` instead of `$item['timestamp'] = strtotime($timestamp);` Support simple_html_dom_node as input paramter for setURI Support simple_html_dom_node as input parameter for setContent
2018-12-27 00:41:32 +03:00
foreach($item->getCategories() as $category) {
Implemented feed item categories (#746)
2018-07-16 13:32:24 +03:00
$entryCategories .= '<li class="category">'
. $this->sanitizeHtml($category)
. '</li>';
}
$entryCategories .= '</div>';
}
[core] Apply common indentation All files are now using tabs for indentation
2016-09-10 21:41:11 +03:00
$entries .= <<<EOD
Refonte du code
2013-08-11 15:30:41 +04:00
Improved style for HtmlFormat.
2016-08-03 21:07:49 +03:00
<section class="feeditem">
[core] Apply common indentation All files are now using tabs for indentation
2016-09-10 21:41:11 +03:00
<h2><a class="itemtitle" href="{$entryUri}">{$entryTitle}</a></h2>
[core] feat: improve date rendering in html formatter (#2516)
2022-03-22 22:41:13 +03:00
{$entryDate}
[core] Apply common indentation All files are now using tabs for indentation
2016-09-10 21:41:11 +03:00
{$entryAuthor}
{$entryContent}
[formats] Allow multiple enclosures All formats now support multiple enclosures. RSS will show a warning if more than one enclosure is used since many feed reader don't support multiple enclosures with RSS (also not clearly specified in the specification)
2016-11-13 00:04:42 +03:00
{$entryEnclosures}
Implemented feed item categories (#746)
2018-07-16 13:32:24 +03:00
{$entryCategories}
Improved style for HtmlFormat.
2016-08-03 21:07:49 +03:00
</section>
Refonte du code
2013-08-11 15:30:41 +04:00
EOD;
[core] Apply common indentation All files are now using tabs for indentation
2016-09-10 21:41:11 +03:00
}
Refonte du code
2013-08-11 15:30:41 +04:00
[formats] Use custom characterset in all formats The specified characterset will now apply to all formats thus allowing other charactersets than 'UTF-8'
2016-11-07 22:49:44 +03:00
$charset = $this->getCharset();
[core] Apply common indentation All files are now using tabs for indentation
2016-09-10 21:41:11 +03:00
/* Data are prepared, now let's begin the "MAGIE !!!" */
$toReturn = <<<EOD
Improve HTML output
2014-05-28 18:57:30 +04:00
<!DOCTYPE html>
Refonte du code
2013-08-11 15:30:41 +04:00
<html>
Improve HTML output
2014-05-28 18:57:30 +04:00
<head>
[formats] Use custom characterset in all formats The specified characterset will now apply to all formats thus allowing other charactersets than 'UTF-8'
2016-11-07 22:49:44 +03:00
<meta charset="{$charset}">
core: Make RSS-Bridge more usable via mobile devices Adds styles for display sizes smaller than 768px where elements are currently hardly usable. Note that RSS-Bridge is not designed for mobile use, but some users may want to try things on their mobile phone before using it in real life applications. Resolves #796
2019-06-21 22:22:21 +03:00
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
[core] Apply common indentation All files are now using tabs for indentation
2016-09-10 21:41:11 +03:00
<title>{$title}</title>
Add a search bar to simplify looking for a bridge. (#494) * Add a search bar to simplify looking for a bridge. * Fix phpcs line length. * Change the phpcs config.
2017-03-21 23:31:10 +03:00
<link href="static/HtmlFormat.css" rel="stylesheet">
logo: Add logo to the project References #1087
2019-06-25 19:39:28 +03:00
<link rel="icon" type="image/png" href="static/favicon.png">
[HtmlFormat] Add syndication links (#1348) Adds <link> elements for each additional output format in the <head> of HTML format output to allow RSS readers to find the actual feeds directly from the HTML page.
2019-11-09 20:43:21 +03:00
{$links}
[core] Apply common indentation All files are now using tabs for indentation
2016-09-10 21:41:11 +03:00
<meta name="robots" content="noindex, follow">
Improve HTML output
2014-05-28 18:57:30 +04:00
</head>
<body>
[core] Apply common indentation All files are now using tabs for indentation
2016-09-10 21:41:11 +03:00
<h1 class="pagetitle"><a href="{$uri}" target="_blank">{$title}</a></h1>
<div class="buttons">
<a href="./#bridge-{$_GET['bridge']}"><button class="backbutton">← back to rss-bridge</button></a>
[HtmlFormat] Dynamically build buttons for other feed formats Adding or removing feed formats from the "formats/" directory currently has no effect on the buttons shown in the HTML format. This can cause errors if users press one of the buttons for a format that is no longer available on the server. This commit changes the behavior to dynamically add buttons based on the available formats. Syndication feeds, however, are no longer supported as they require knowledge about the content type, which is not known without further changes to the formats API (may be added later if there is a demand). Closes #942
2019-06-20 00:09:08 +03:00
{$buttons}
[core] Apply common indentation All files are now using tabs for indentation
2016-09-10 21:41:11 +03:00
</div>
Refonte du code
2013-08-11 15:30:41 +04:00
{$entries}
Improve HTML output
2014-05-28 18:57:30 +04:00
</body>
Refonte du code
2013-08-11 15:30:41 +04:00
</html>
EOD;
[formats] Use custom characterset in all formats The specified characterset will now apply to all formats thus allowing other charactersets than 'UTF-8'
2016-11-07 22:49:44 +03:00
// Remove invalid characters
ini_set('mbstring.substitute_character', 'none');
$toReturn = mb_convert_encoding($toReturn, $this->getCharset(), 'UTF-8');
[core] Apply common indentation All files are now using tabs for indentation
2016-09-10 21:41:11 +03:00
return $toReturn;
}
Refonte du code
2013-08-11 15:30:41 +04:00
[core] Apply common indentation All files are now using tabs for indentation
2016-09-10 21:41:11 +03:00
public function display() {
$this
formats: Add getMimeType() function (#1299) Allows getting the expected MIME type of the format's output. A corresponding MIME_TYPE constant is also defined in FormatAbstract for the format implementations to overwrite.
2019-10-31 21:00:12 +03:00
->setContentType(self::MIME_TYPE . '; charset=' . $this->getCharset())
[core] Apply common indentation All files are now using tabs for indentation
2016-09-10 21:41:11 +03:00
->callContentType();
Refonte du code
2013-08-11 15:30:41 +04:00
[core] Apply common indentation All files are now using tabs for indentation
2016-09-10 21:41:11 +03:00
return parent::display();
}
[HtmlFormat] Dynamically build buttons for other feed formats Adding or removing feed formats from the "formats/" directory currently has no effect on the buttons shown in the HTML format. This can cause errors if users press one of the buttons for a format that is no longer available on the server. This commit changes the behavior to dynamically add buttons based on the available formats. Syndication feeds, however, are no longer supported as they require knowledge about the content type, which is not known without further changes to the formats API (may be added later if there is a demand). Closes #942
2019-06-20 00:09:08 +03:00
private function buildButton($format, $query) {
return <<<EOD
<a href="./?{$query}"><button class="rss-feed">{$format}</button></a>
[HtmlFormat] Add syndication links (#1348) Adds <link> elements for each additional output format in the <head> of HTML format output to allow RSS readers to find the actual feeds directly from the HTML page.
2019-11-09 20:43:21 +03:00
EOD;
}
private function buildLink($format, $query, $mime) {
return <<<EOD
<link href="./?{$query}" title="{$format}" rel="alternate" type="{$mime}">
[HtmlFormat] Dynamically build buttons for other feed formats Adding or removing feed formats from the "formats/" directory currently has no effect on the buttons shown in the HTML format. This can cause errors if users press one of the buttons for a format that is no longer available on the server. This commit changes the behavior to dynamically add buttons based on the available formats. Syndication feeds, however, are no longer supported as they require knowledge about the content type, which is not known without further changes to the formats API (may be added later if there is a demand). Closes #942
2019-06-20 00:09:08 +03:00
EOD;
}
Improve HTML output
2014-05-28 18:57:30 +04:00
}
Reference in a new issue Copy permalink