cuqmbr/rss-bridge
1
0
Fork 0
mirror of https://github.com/RSS-Bridge/rss-bridge.git synced 2025-04-05 00:59:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'master' of https://github.com/rss-bridge/rss-bridge

Browse Source
This commit is contained in:
Phantop 2024-08-31 11:33:25 -04:00
commit e039bd2d8d
46 changed files with 537 additions and 504 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
actions/ConnectivityAction.php
View File

@ -14,9 +14,10 @@ class ConnectivityAction implements ActionInterface
{
private BridgeFactory $bridgeFactory;
public function __construct()
{
$this->bridgeFactory = new BridgeFactory();
public function __construct(
BridgeFactory $bridgeFactory
) {
$this->bridgeFactory = $bridgeFactory;
}
public function __invoke(Request $request): Response

16
actions/DetectAction.php
View File

@ -2,6 +2,14 @@
class DetectAction implements ActionInterface
{
private BridgeFactory $bridgeFactory;
public function __construct(
BridgeFactory $bridgeFactory
) {
$this->bridgeFactory = $bridgeFactory;
}
public function __invoke(Request $request): Response
{
$url = $request->get('url');
@ -14,14 +22,12 @@ class DetectAction implements ActionInterface
return new Response(render(__DIR__ . '/../templates/error.html.php', ['message' => 'You must specify a format']));
}
$bridgeFactory = new BridgeFactory();
foreach ($bridgeFactory->getBridgeClassNames() as $bridgeClassName) {
if (!$bridgeFactory->isEnabled($bridgeClassName)) {
foreach ($this->bridgeFactory->getBridgeClassNames() as $bridgeClassName) {
if (!$this->bridgeFactory->isEnabled($bridgeClassName)) {
continue;
}
$bridge = $bridgeFactory->create($bridgeClassName);
$bridge = $this->bridgeFactory->create($bridgeClassName);
$bridgeParams = $bridge->detectParameters($url);

41
actions/DisplayAction.php
View File

@ -4,11 +4,16 @@ class DisplayAction implements ActionInterface
{
private CacheInterface $cache;
private Logger $logger;
private BridgeFactory $bridgeFactory;
public function __construct()
{
$this->cache = RssBridge::getCache();
$this->logger = RssBridge::getLogger();
public function __construct(
CacheInterface $cache,
Logger $logger,
BridgeFactory $bridgeFactory
) {
$this->cache = $cache;
$this->logger = $logger;
$this->bridgeFactory = $bridgeFactory;
}
public function __invoke(Request $request): Response
@ -39,8 +44,7 @@ class DisplayAction implements ActionInterface
if (!$bridgeName) {
return new Response(render(__DIR__ . '/../templates/error.html.php', ['message' => 'Missing bridge parameter']), 400);
}
$bridgeFactory = new BridgeFactory();
$bridgeClassName = $bridgeFactory->createBridgeClassName($bridgeName);
$bridgeClassName = $this->bridgeFactory->createBridgeClassName($bridgeName);
if (!$bridgeClassName) {
return new Response(render(__DIR__ . '/../templates/error.html.php', ['message' => 'Bridge not found']), 404);
}
@ -48,7 +52,7 @@ class DisplayAction implements ActionInterface
if (!$format) {
return new Response(render(__DIR__ . '/../templates/error.html.php', ['message' => 'You must specify a format']), 400);
}
if (!$bridgeFactory->isEnabled($bridgeClassName)) {
if (!$this->bridgeFactory->isEnabled($bridgeClassName)) {
return new Response(render(__DIR__ . '/../templates/error.html.php', ['message' => 'This bridge is not whitelisted']), 400);
}
@ -62,7 +66,7 @@ class DisplayAction implements ActionInterface
define('NOPROXY', true);
}
$bridge = $bridgeFactory->create($bridgeClassName);
$bridge = $this->bridgeFactory->create($bridgeClassName);
$response = $this->createResponse($request, $bridge, $format);
@ -85,7 +89,9 @@ class DisplayAction implements ActionInterface
$this->cache->set($cacheKey, $response, 60 * 15);
}
if (rand(1, 100) === 2) {
// For 1% of requests, prune cache
if (rand(1, 100) === 1) {
// This might be resource intensive!
$this->cache->prune();
}
@ -121,17 +127,16 @@ class DisplayAction implements ActionInterface
return new Response(render(__DIR__ . '/../templates/exception.html.php', ['e' => $e]), 429);
}
if ($e instanceof HttpException) {
// Reproduce (and log) these responses regardless of error output and report limit
if ($e->getCode() === 429) {
$this->logger->info(sprintf('Exception in DisplayAction(%s): %s', $bridge->getShortName(), create_sane_exception_message($e)));
return new Response(render(__DIR__ . '/../templates/exception.html.php', ['e' => $e]), 429);
}
if ($e->getCode() === 503) {
$this->logger->info(sprintf('Exception in DisplayAction(%s): %s', $bridge->getShortName(), create_sane_exception_message($e)));
return new Response(render(__DIR__ . '/../templates/exception.html.php', ['e' => $e]), 503);
if (in_array($e->getCode(), [429, 503])) {
// Log with debug, immediately reproduce and return
$this->logger->debug(sprintf('Exception in DisplayAction(%s): %s', $bridge->getShortName(), create_sane_exception_message($e)));
return new Response(render(__DIR__ . '/../templates/exception.html.php', ['e' => $e]), $e->getCode());
}
// Some other status code which we let fail normally (but don't log it)
} else {
// Log error if it's not an HttpException
$this->logger->error(sprintf('Exception in DisplayAction(%s)', $bridge->getShortName()), ['e' => $e]);
}
$this->logger->error(sprintf('Exception in DisplayAction(%s)', $bridge->getShortName()), ['e' => $e]);
$errorOutput = Configuration::getConfig('error', 'output');
$reportLimit = Configuration::getConfig('error', 'report_limit');
$errorCount = 1;

16
actions/FindfeedAction.php
View File

@ -7,6 +7,14 @@
*/
class FindfeedAction implements ActionInterface
{
private BridgeFactory $bridgeFactory;
public function __construct(
BridgeFactory $bridgeFactory
) {
$this->bridgeFactory = $bridgeFactory;
}
public function __invoke(Request $request): Response
{
$url = $request->get('url');
@ -19,15 +27,13 @@ class FindfeedAction implements ActionInterface
return new Response('You must specify a format', 400);
}
$bridgeFactory = new BridgeFactory();
$results = [];
foreach ($bridgeFactory->getBridgeClassNames() as $bridgeClassName) {
if (!$bridgeFactory->isEnabled($bridgeClassName)) {
foreach ($this->bridgeFactory->getBridgeClassNames() as $bridgeClassName) {
if (!$this->bridgeFactory->isEnabled($bridgeClassName)) {
continue;
}
$bridge = $bridgeFactory->create($bridgeClassName);
$bridge = $this->bridgeFactory->create($bridgeClassName);
$bridgeParams = $bridge->detectParameters($url);

17
actions/FrontpageAction.php
View File

@ -2,6 +2,14 @@
final class FrontpageAction implements ActionInterface
{
private BridgeFactory $bridgeFactory;
public function __construct(
BridgeFactory $bridgeFactory
) {
$this->bridgeFactory = $bridgeFactory;
}
public function __invoke(Request $request): Response
{
$token = $request->attribute('token');
@ -9,10 +17,9 @@ final class FrontpageAction implements ActionInterface
$messages = [];
$activeBridges = 0;
$bridgeFactory = new BridgeFactory();
$bridgeClassNames = $bridgeFactory->getBridgeClassNames();
$bridgeClassNames = $this->bridgeFactory->getBridgeClassNames();
foreach ($bridgeFactory->getMissingEnabledBridges() as $missingEnabledBridge) {
foreach ($this->bridgeFactory->getMissingEnabledBridges() as $missingEnabledBridge) {
$messages[] = [
'body' => sprintf('Warning : Bridge "%s" not found', $missingEnabledBridge),
'level' => 'warning'
@ -21,8 +28,8 @@ final class FrontpageAction implements ActionInterface
$body = '';
foreach ($bridgeClassNames as $bridgeClassName) {
if ($bridgeFactory->isEnabled($bridgeClassName)) {
$body .= BridgeCard::render($bridgeClassName, $token);
if ($this->bridgeFactory->isEnabled($bridgeClassName)) {
$body .= BridgeCard::render($this->bridgeFactory, $bridgeClassName, $token);
$activeBridges++;
}
}

16
actions/ListAction.php
View File

@ -2,19 +2,25 @@
class ListAction implements ActionInterface
{
private BridgeFactory $bridgeFactory;
public function __construct(
BridgeFactory $bridgeFactory
) {
$this->bridgeFactory = $bridgeFactory;
}
public function __invoke(Request $request): Response
{
$list = new \stdClass();
$list->bridges = [];
$list->total = 0;
$bridgeFactory = new BridgeFactory();
foreach ($bridgeFactory->getBridgeClassNames() as $bridgeClassName) {
$bridge = $bridgeFactory->create($bridgeClassName);
foreach ($this->bridgeFactory->getBridgeClassNames() as $bridgeClassName) {
$bridge = $this->bridgeFactory->create($bridgeClassName);
$list->bridges[$bridgeClassName] = [
'status' => $bridgeFactory->isEnabled($bridgeClassName) ? 'active' : 'inactive',
'status' => $this->bridgeFactory->isEnabled($bridgeClassName) ? 'active' : 'inactive',
'uri' => $bridge->getURI(),
'donationUri' => $bridge->getDonationURI(),
'name' => $bridge->getName(),

19
bin/cache-clear
View File

@ -6,22 +6,11 @@
*/
require __DIR__ . '/../lib/bootstrap.php';
require __DIR__ . '/../lib/config.php';
$config = [];
if (file_exists(__DIR__ . '/../config.ini.php')) {
$config = parse_ini_file(__DIR__ . '/../config.ini.php', true, INI_SCANNER_TYPED);
if (!$config) {
http_response_code(500);
exit("Error parsing config.ini.php\n");
}
}
Configuration::loadConfiguration($config, getenv());
$container = require __DIR__ . '/../lib/dependencies.php';
$logger = new SimpleLogger('rssbridge');
$logger->addHandler(new StreamHandler('php://stderr', Logger::INFO));
$cacheFactory = new CacheFactory($logger);
$cache = $cacheFactory->create();
/** @var CacheInterface $cache */
$cache = $container['cache'];
$cache->clear();

25
bin/cache-prune
View File

@ -6,22 +6,19 @@
*/
require __DIR__ . '/../lib/bootstrap.php';
require __DIR__ . '/../lib/config.php';
$config = [];
if (file_exists(__DIR__ . '/../config.ini.php')) {
$config = parse_ini_file(__DIR__ . '/../config.ini.php', true, INI_SCANNER_TYPED);
if (!$config) {
http_response_code(500);
exit("Error parsing config.ini.php\n");
}
$container = require __DIR__ . '/../lib/dependencies.php';
if (
Configuration::getConfig('cache', 'type') === 'file'
&& !Configuration::getConfig('FileCache', 'enable_purge')
) {
// Override enable_purge for this particular execution
Configuration::setConfig('FileCache', 'enable_purge', true);
}
Configuration::loadConfiguration($config, getenv());
$logger = new SimpleLogger('rssbridge');
$logger->addHandler(new StreamHandler('php://stderr', Logger::INFO));
$cacheFactory = new CacheFactory($logger);
$cache = $cacheFactory->create();
/** @var CacheInterface $cache */
$cache = $container['cache'];
$cache->prune();

20
bin/test Executable file
View File

@ -0,0 +1,20 @@
#!/usr/bin/env php
<?php
/**
* Add log records to all three levels (for testing purposes)
*/
require __DIR__ . '/../lib/bootstrap.php';
require __DIR__ . '/../lib/config.php';
$container = require __DIR__ . '/../lib/dependencies.php';
/** @var Logger $logger */
$logger = $container['logger'];
$logger->debug('This is a test debug message');
$logger->info('This is a test info message');
$logger->error('This is a test error message');

6
bridges/ABCNewsBridge.php
View File

@ -31,17 +31,17 @@ class ABCNewsBridge extends BridgeAbstract
{
$url = sprintf('https://www.abc.net.au/news/%s', $this->getInput('topic'));
$dom = getSimpleHTMLDOM($url);
$dom = $dom->find('div[data-component="CardList"]', 0);
$dom = $dom->find('div[data-component="PaginationList"]', 0);
if (!$dom) {
throw new \Exception(sprintf('Unable to find css selector on `%s`', $url));
}
$dom = defaultLinkTo($dom, $this->getURI());
foreach ($dom->find('div[data-component="GenericCard"]') as $article) {
foreach ($dom->find('article[data-component="DetailCard"]') as $article) {
$a = $article->find('a', 0);
$this->items[] = [
'title' => $a->plaintext,
'uri' => $a->href,
'content' => $article->find('[data-component="CardDescription"]', 0)->plaintext,
'content' => $article->find('p', 0)->plaintext,
'timestamp' => strtotime($article->find('time', 0)->datetime),
];
}

32
bridges/AO3Bridge.php
View File

@ -68,12 +68,13 @@ class AO3Bridge extends BridgeAbstract
*/
private function collectList($url)
{
$httpClient = RssBridge::getHttpClient();
$version = 'v0.0.1';
$agent = ['useragent' => "rss-bridge $version (https://github.com/RSS-Bridge/rss-bridge)"];
$headers = [
"useragent: rss-bridge $version (https://github.com/RSS-Bridge/rss-bridge)"
];
$response = getContents($url, $headers);
$response = $httpClient->request($url, $agent);
$html = \str_get_html($response->getBody());
$html = \str_get_html($response);
$html = defaultLinkTo($html, self::URI);
// Get list title. Will include page range + count in some cases
@ -128,14 +129,15 @@ class AO3Bridge extends BridgeAbstract
case ('last'):
// only way to get this is using the navigate page unfortunately
$url .= '/navigate';
$response = $httpClient->request($url, $agent);
$html = \str_get_html($response->getBody());
$response = getContents($url, $headers);
$html = \str_get_html($response);
$html = defaultLinkTo($html, self::URI);
$url = $html->find('ol.index.group > li > a', -1)->href;
break;
}
$response = $httpClient->request($url, $agent);
$html = \str_get_html($response->getBody());
$response = getContents($url, $headers);
$html = \str_get_html($response);
$html = defaultLinkTo($html, self::URI);
// remove duplicate fic summary
if ($ficsum = $html->find('#workskin > .preface > .summary', 0)) {
@ -159,16 +161,18 @@ class AO3Bridge extends BridgeAbstract
*/
private function collectWork($url)
{
$httpClient = RssBridge::getHttpClient();
$version = 'v0.0.1';
$agent = ['useragent' => "rss-bridge $version (https://github.com/RSS-Bridge/rss-bridge)"];
$headers = [
"useragent: rss-bridge $version (https://github.com/RSS-Bridge/rss-bridge)"
];
$response = getContents($url . '/navigate', $headers);
$response = $httpClient->request($url . '/navigate', $agent);
$html = \str_get_html($response->getBody());
$html = \str_get_html($response);
$html = defaultLinkTo($html, self::URI);
$response = $httpClient->request($url . '?view_full_work=true', $agent);
$workhtml = \str_get_html($response->getBody());
$response = getContents($url . '?view_full_work=true', $headers);
$workhtml = \str_get_html($response);
$workhtml = defaultLinkTo($workhtml, self::URI);
$this->title = $html->find('h2 a', 0)->plaintext;

5
bridges/BMDSystemhausBlogBridge.php
View File

@ -54,7 +54,7 @@ class BMDSystemhausBlogBridge extends BridgeAbstract
public function collectData()
{
// get website content
$html = getSimpleHTMLDOM($this->getURI()) or returnServerError('No contents received!');
$html = getSimpleHTMLDOM($this->getURI());
// Convert relative links in HTML into absolute links
$html = defaultLinkTo($html, self::URI);
@ -207,7 +207,8 @@ class BMDSystemhausBlogBridge extends BridgeAbstract
//-----------------------------------------------------
public function getURI()
{
$lURI = $this->getURIbyCountry($this->getInput('country'));
$country = $this->getInput('country') ?? '';
$lURI = $this->getURIbyCountry($country);
return $lURI != '' ? $lURI : parent::getURI();
}

2
bridges/CeskaTelevizeBridge.php
View File

@ -60,7 +60,7 @@ class CeskaTelevizeBridge extends BridgeAbstract
foreach ($html->find('#episodeListSection a[data-testid=card]') as $element) {
$itemTitle = $element->find('h3', 0);
$itemContent = $element->find('p[class^=content-]', 0);
$itemDate = $element->find('div[class^=playTime-] span', 0);
$itemDate = $element->find('div[class^=playTime-] span, [data-testid=episode-item-broadcast] span', 0);
$itemThumbnail = $element->find('img', 0);
$itemUri = self::URI . $element->getAttribute('href');

33
bridges/HinduTamilBridge.php
View File

@ -4,6 +4,7 @@ class HinduTamilBridge extends FeedExpander
{
const NAME = 'HinduTamil';
const URI = 'https://www.hindutamil.in';
const FEED_BASE_URL = 'https://feeds.feedburner.com/Hindu_Tamil_';
const DESCRIPTION = 'Retrieve full articles from hindutamil.in feeds';
const MAINTAINER = 'tillcash';
const PARAMETERS = [
@ -45,8 +46,6 @@ class HinduTamilBridge extends FeedExpander
],
];
const FEED_BASE_URL = 'https://feeds.feedburner.com/Hindu_Tamil_';
public function getName()
{
$topic = $this->getKey('topic');
@ -69,34 +68,30 @@ class HinduTamilBridge extends FeedExpander
return $item;
}
$date = $dom->find('p span.date', 1);
if ($date) {
$item['timestamp'] = $this->toRFC3339($date->plaintext);
}
$image = $dom->find('#LoadArticle figure', 0) ?? '';
$item['content'] = $image . $this->cleanContent($content);
$item['timestamp'] = $this->getTimestamp($dom) ?? $item['timestamp'];
$item['content'] = $this->getImage($dom) . $this->cleanContent($content);
return $item;
}
private function cleanContent($content)
private function cleanContent($content): string
{
foreach ($content->find('div[align="center"], script') as $remove) {
foreach ($content->find('div[align="center"], script, .adsplacement') as $remove) {
$remove->outertext = '';
}
return $content;
return $content->innertext;
}
private function toRFC3339($dateString)
private function getTimestamp($dom): ?string
{
$timestamp = strtotime(trim($dateString));
$date = $dom->find('meta[property="article:published_time"]', 0);
return $date ? $date->getAttribute('content') : null;
}
if ($timestamp === false) {
return null;
}
return date('Y-m-d\TH:i:s', $timestamp) . '+05:30';
private function getImage($dom): string
{
$image = $dom->find('meta[property="og:image"]', 0);
return $image ? sprintf('<p><img src="%s"></p>', $image->getAttribute('content')) : '';
}
}

24
bridges/TwitchBridge.php
View File

@ -99,7 +99,7 @@ EOD;
$user = $data->user;
if ($user->videos === null) {
// twitch regularly does this for unknown reasons
//$this->logger->info('Twitch returned empty set of videos', ['data' => $data]);
$this->debug->info('Twitch returned empty set of videos', ['data' => $data]);
return;
}
@ -196,23 +196,21 @@ EOD;
// e.g. 01:53:27
private function formatTimestampTime($seconds)
{
return sprintf(
'%02d:%02d:%02d',
floor($seconds / 3600),
($seconds / 60) % 60,
$seconds % 60
);
$floor = floor($seconds / 3600);
$i = intval($seconds / 60) % 60;
$i1 = $seconds % 60;
return sprintf('%02d:%02d:%02d', $floor, $i, $i1);
}
// e.g. 01h53m27s
private function formatQueryTime($seconds)
{
return sprintf(
'%02dh%02dm%02ds',
floor($seconds / 3600),
($seconds / 60) % 60,
$seconds % 60
);
$floor = floor($seconds / 3600);
$i = intval($seconds / 60) % 60;
$i1 = $seconds % 60;
return sprintf('%02dh%02dm%02ds', $floor, $i, $i1);
}
/**

2
caches/FileCache.php
View File

@ -97,8 +97,10 @@ class FileCache implements CacheInterface
}
$expiration = $item['expiration'] ?? time();
if ($expiration === 0 || $expiration > time()) {
// Cached forever, or not expired yet
continue;
}
// Expired, so delete file
unlink($cacheFile);
}
}

11
docs/01_General/03_Requirements.md
View File

@ -1,14 +1,3 @@
- PHP 7.4 (or higher)
- [`openssl`](https://secure.php.net/manual/en/book.openssl.php) extension
- [`libxml`](https://secure.php.net/manual/en/book.libxml.php) extension (enabled by default, see [PHP Manual](http://php.net/manual/en/libxml.installation.php))
- [`mbstring`](https://secure.php.net/manual/en/book.mbstring.php) extension
- [`simplexml`](https://secure.php.net/manual/en/book.simplexml.php) extension
- [`curl`](https://secure.php.net/manual/en/book.curl.php) extension
- [`json`](https://secure.php.net/manual/en/book.json.php) extension
- [`filter`](https://secure.php.net/manual/en/book.filter.php) extension
- [`zip`](https://secure.php.net/manual/en/book.zip.php) (for some bridges)
- [`sqlite3`](http://php.net/manual/en/book.sqlite3.php) extension (only when using SQLiteCache)
Enable extensions by un-commenting the corresponding line in your PHP configuration (`php.ini`).

29
docs/01_General/05_FAQ.md
View File

@ -1,30 +1,33 @@
This page provides a collection of frequently asked questions and their answers. Please check this page before opening a new Issue :revolving_hearts:
* [Why doesn't my bridge show new contents?](#why-doesnt-my-bridge-show-new-contents)
* [How can I make a bridge update more frequently?](#how-can-i-make-a-bridge-update-more-frequently)
* [Firefox doesn't show feeds anymore, what can I do?](#firefox-doesnt-show-feeds-anymore-what-can-i-do)
## Why doesn't my bridge show new contents?
RSS-Bridge creates a cached version of your feed in order to reduce traffic and respond faster. The cached version is created on the first request and served for all subsequent requests. On every request RSS-Bridge checks if the cache timeout has elapsed. If the timeout has elapsed, it loads new contents and updates the cached version.
RSS-Bridge creates a cached version of your feed in order to reduce traffic and respond faster.
The cached version is created on the first request and served for all subsequent requests.
On every request RSS-Bridge checks if the cache timeout has elapsed.
If the timeout has elapsed, it loads new contents and updates the cached version.
_Notice_: RSS-Bridge only updates feeds if you actively request it, for example by pressing F5 in your browser or using a feed reader.
_Notice_: RSS-Bridge only updates feeds if you actively request it,
for example by pressing F5 in your browser or using a feed reader.
The cache duration is bridge specific and can last anywhere between five minutes and 24 hours. You can specify a custom cache timeout for each bridge if [this option](#how-can-i-make-a-bridge-update-more-frequently) has been enabled on the server.
The cache duration is bridge specific (usually `1h`)
You can specify a custom cache timeout for each bridge if
[this option](#how-can-i-make-a-bridge-update-more-frequently) has been enabled on the server.
## How can I make a bridge update more frequently?
You can only do that if you are hosting the RSS-Bridge instance:
- Lower the bridge ttl: `CACHE_TIMEOUT` constant
- Enable [`custom_timeout`](../03_For_Hosts/08_Custom_Configuration.md#customtimeout)
- Alternatively, change the default timeout for your bridge by modifying the `CACHE_TIMEOUT` constant in the relevant bridge file (e.g [here](https://github.com/RSS-Bridge/rss-bridge/blob/master/bridges/FilterBridge.php#L7) for the Filter Bridge).
## Firefox doesn't show feeds anymore, what can I do?
As of version 64, Firefox removed support for viewing Atom and RSS feeds in the browser. This results in the browser downloading the pages instead of showing contents.
As of version 64, Firefox removed support for viewing Atom and RSS feeds in the browser.
This results in the browser downloading the pages instead of showing contents.
Further reading:
- https://support.mozilla.org/en-US/kb/feed-reader-replacements-firefox
- https://bugzilla.mozilla.org/show_bug.cgi?id=1477667
To restore the original behavior in Firefox 64 or higher you can use following Add-on which attempts to recreate the original behavior (with some sugar on top):
- https://addons.mozilla.org/en-US/firefox/addon/rsspreview/
To restore the original behavior in Firefox 64 or higher you can use following Add-on
which attempts to recreate the original behavior (with some sugar on top):
- https://addons.mozilla.org/en-US/firefox/addon/rsspreview/

22
docs/02_CLI/index.md
View File

@ -1,10 +1,12 @@
RSS-Bridge supports calls via CLI. You can use the same parameters as you would normally use via the URI. Example:
RSS-Bridge supports calls via CLI.
You can use the same parameters as you would normally use via the URI. Example:
`php index.php action=display bridge=DansTonChat format=Json`
## Required parameters
RSS-Bridge requires a few parameters that must be specified on every call. Omitting these parameters will result in error messages:
RSS-Bridge requires a few parameters that must be specified on every call.
Omitting these parameters will result in error messages:
### action
@ -17,20 +19,26 @@ Value | Description
### bridge
This parameter specifies the name of the bridge RSS-Bridge should return feeds from. The name of the bridge equals the class name of the bridges in the ./bridges/ folder without the 'Bridge' prefix. For example: DansTonChatBridge => DansTonChat.
This parameter specifies the name of the bridge RSS-Bridge should return feeds from.
The name of the bridge equals the class name of the bridges in the ./bridges/ folder without the 'Bridge' prefix.
For example: DansTonChatBridge => DansTonChat.
### format
This parameter specifies the format in which RSS-Bridge returns the contents. RSS-Bridge currently supports five formats: `Atom`, `Html`, `Json`, `Mrss`and `Plaintext`.
This parameter specifies the format in which RSS-Bridge returns the contents.
## Optional parameters
RSS-Bridge supports optional parameters. These parameters are only valid if the options have been enabled in the index.php script.
RSS-Bridge supports optional parameters.
These parameters are only valid if the options have been enabled in the index.php script.
### \_noproxy
This parameter is only available if a proxy server has been specified via `proxy.url` and `proxy.by_bridge` has been enabled. This is a Boolean parameter that can be set to `true` or `false`.
This parameter is only available if a proxy server has been specified via `proxy.url` and `proxy.by_bridge`
has been enabled. This is a Boolean parameter that can be set to `true` or `false`.
## Bridge parameters
Each bridge can specify its own set of parameters. As in the example above, some bridges don't specify any parameters or only optional parameters that can be neglected. For more details read the `PARAMETERS` definition for your bridge.
Each bridge can specify its own set of parameters.
As in the example above, some bridges don't specify any parameters or only optional parameters that can be neglected.
For more details read the `PARAMETERS` definition for your bridge.

11
docs/03_For_Hosts/01_Installation.md
View File

@ -1,10 +1 @@
In order to install RSS-Bridge on your own web server* do as follows:
* Make sure your web server meets all [requirements](../01_General/03_Requirements.md)
* Download the ZIP file of the [last stable release](https://github.com/RSS-Bridge/rss-bridge/releases)
* Place all files on your web server
For linux hosts:
* Grant read-write-access for `www-data` to the `./cache` directory (`chown -R www-data ./cache`)
You have successfully installed RSS-Bridge.
https://github.com/RSS-Bridge/rss-bridge/blob/master/README.md

38
docs/03_For_Hosts/02_Updating.md
View File

@ -1,38 +0,0 @@
Updating an existing installation is very simple, depending on your type of installation.
## Release Build
* Download latest version
* Extract all files
* Replace existing files
This will update all core files to the latest version. Your custom configuration and bridges are left untouched. Keep in mind that changes to any core file of RSS-Bridge will be replaced.
## Heroku
### If you didn't fork the repo before
Fork the repo by clicking the `Fork` button at the top right of this page (must be on desktop site). Then on your Heroku account, go to the application. Click on the `Deploy` tab and connect the repo named `yourusername/rss-bridge`. Do a manual deploy of the `master` branch.
### If you forked the repo before
[Click here to create a new pull request to your fork](https://github.com/RSS-Bridge/rss-bridge/pull/new/master). Select `compare across forks`, make the base repository `yourusername/rss-bridge` and ensure the branch is set to master. Put any title you want and create the pull request. On the page that comes after this, merge the pull request.
You then want to go to your application in Heroku, connect your fork via the `Deploy` tab and deploy the `master` branch.
You can turn on auto-deploy for the master branch if you don't want to go through the process of logging into Heroku and deploying the branch every time changes to the repo are made in the future.
## Git
To get the latest changes from the master branch
```
git pull
```
To use a specific tag
```
git fetch --all
git checkout tags/<tag-name>
```

105
docs/03_For_Hosts/06_Authentication.md
View File

@ -1,101 +1,6 @@
Depending on your servers abilities you can choose between two types of authentication:
* [.htaccess](#htaccess)
* [RSS-Bridge Authentication](#rss-bridge-authentication)
**General advice**:
- Make sure to use a strong password, no matter which solution you choose!
- Enable HTTPS on your server to ensure your connection is encrypted and secure!
## .htaccess
.htaccess files are commonly used to restrict access to files on a web server. One of the features of .htaccess files is the ability to password protect specific (or all) directories. If setup correctly, a password is required to access the files.
The usage of .htaccess files requires three basic steps:
1) [Enable .htaccess](#enable-htaccess)
2) [Create a .htpasswd file](#create-a-htpasswd-file)
3) [Create a .htaccess file](#create-a-htaccess-file)
### Enable .htaccess
This process depends on the server you are using. Some providers may require you to change some settings, or place/change some file. Here are some helpful links for your server (please add your own if missing :sparkling_heart:)
- Apache: http://ask.xmodulo.com/enable-htaccess-apache.html
### Create a .htpasswd file
The `.htpasswd` file contains the user name and password used for login to your web server. Please notice that the password is stored in encrypted form, which requires you to encrypt your password before creating the `.htpasswd` file!
Here are three ways of creating your own `.htpasswd` file:
**1) Example file**
Example `.htpasswd` file (user name: "test", password: "test"):
```.htpasswd
test:$apr1$a52u9ILP$XTNG8qMJiEXSm1zD0lQcR0
```
Just copy and paste the contents to your `.htpasswd` file.
**2) Online generator (read warning!)**
You can create your own `.htpasswd` file online using a `.htpasswd` generator like this: https://www.htaccesstools.com/htpasswd-generator/
**WARNING!**
- Never insert real passwords to an online generator!
**3) Generate your own password**
Another way to create your own `.htpasswd` file is to run this script on your server (it'll output the data for you, you just have to paste it int a `.htpasswd` file):
```PHP
<?php
// Password to be encrypted for a .htpasswd file
$clearTextPassword = 'some password';
// Encrypt password
$password = crypt($clearTextPassword, base64_encode($clearTextPassword));
// Print encrypted password
echo $password;
?>
```
>source: https://www.htaccesstools.com/articles/create-password-for-htpasswd-file-using-php/
### Create a .htaccess file
The `.htaccess` file is used to specify which directories are password protected. For that purpose you should place the file in whatever directory you want to restrict access. If you want to restrict access to RSS-Bridge in general, you should place the file in the root directory (where `index.php` is located).
Two parameters must be specified in the `.htaccess` file:
* AuthName
* AuthUserFile
`AuthName` specifies the name of the authentication (i.e. "RSS-Bridge"). `AuthUserFile` defines the **absolute** path to a `.htpasswd` file.
Here are two ways of creating your own `.htaccess` file:
**1) Example file**
```.htaccess
AuthType Basic
AuthName "My Protected Area"
AuthUserFile /path/to/.htpasswd
Require valid-user
```
Notice: You must change the `AuthUserFile` location to fit your own server (i.e. `/var/www/html/rss-bridge/.htpasswd`)
**2) Online generator**
You can use an online generator to create the file for you and copy-paste it to your `.htaccess` file: https://www.htaccesstools.com/htaccess-authentication/
## RSS-Bridge Authentication
RSS-Bridge ships with an authentication module designed for single user environments. You can enable authentication and specify the username & password in the [configuration file](../03_For_Hosts/08_Custom_Configuration.md#authentication).
Please notice that the password is stored in plain text and thus is readable to anyone who can access the file. Make sure to restrict access to the file, so that it cannot be read remotely!
* http basic auth
* token
* Access control via webserver (see nginx/caddy/apache docs)
https://github.com/RSS-Bridge/rss-bridge/blob/master/README.md

15
docs/03_For_Hosts/07_Customizations.md
View File

@ -1,9 +1,14 @@
RSS-Bridge ships a few options the host may or may not activate. All options are listed in the [config.default.ini.php](https://github.com/RSS-Bridge/rss-bridge/blob/master/config.default.ini.php) file, see [Custom Configuration](08_Custom_Configuration.md) section for more information.
RSS-Bridge ships a few options the host may or may not activate.
All options are listed in the [config.default.ini.php](https://github.com/RSS-Bridge/rss-bridge/blob/master/config.default.ini.php) file,
see [Custom Configuration](08_Custom_Configuration.md) section for more information.
## Customizable cache timeout
Sometimes it is necessary to specify custom timeouts to update contents more frequently than the bridge maintainer intended. In these cases the client may specify a custom cache timeout to prevent loading contents from cache earlier (or later).
Sometimes it is necessary to specify custom timeouts to update contents more frequently
than the bridge maintainer intended.
In these cases the client may specify a custom cache timeout to prevent loading contents
from cache earlier (or later).
This option can be activated by setting the [`cache.custom_timeout`](08_Custom_Configuration.md#custom_timeout) option to `true`. When enabled each bridge receives an additional parameter `Cache timeout in seconds` that can be set to any value between 1 and 86400 (24 hours). If the value is not within the limits the default settings apply (as specified by the bridge maintainer).
The cache timeout is send to RSS-Bridge using the `_cache_timeout` parameter. RSS-Bridge will return an error message if the parameter is received and the option is disabled.
This option can be activated by setting the [`cache.custom_timeout`](08_Custom_Configuration.md#custom_timeout) option to `true`.
When enabled each bridge receives an additional parameter `Cache timeout in seconds`
that can be set to any value.

13
docs/03_For_Hosts/08_Custom_Configuration.md
View File

@ -1,16 +1,21 @@
RSS-Bridge supports custom configurations for common parameters on the server side!
A default configuration file (`config.default.ini.php`) is shipped with RSS-Bridge. Please do not edit this file, as it gets replaced when upgrading RSS-Bridge!
A default configuration file (`config.default.ini.php`) is shipped with RSS-Bridge.
Please do not edit this file, as it gets replaced when upgrading RSS-Bridge!
You should, however, use this file as template to create your own configuration (or leave it as is, to keep the default settings). In order to create your own configuration perform following actions:
You should, however, use this file as template to create your own configuration
(or leave it as is, to keep the default settings).
In order to create your own configuration perform following actions:
* Create the file `config.ini.php` in the RSS-Bridge root folder (next to `config.default.ini.php`)
* Copy the contents from `config.default.ini.php` to your configuration file
* Change the parameters to satisfy your requirements
RSS-Bridge will automatically detect the `config.ini.php` and use it. If the file doesn't exist it will default to `config.default.ini.php` automatically.
RSS-Bridge will automatically detect the `config.ini.php` and use it.
If the file doesn't exist it will default to `config.default.ini.php` automatically.
__Notice__: If a parameter is not specified in your `config.ini.php` RSS-Bridge will automatically use the default settings from `config.default.ini.php`.
__Notice__: If a parameter is not specified in your `config.ini.php` RSS-Bridge will
automatically use the default settings from `config.default.ini.php`.
# Available parameters

6
docs/03_For_Hosts/index.md
View File

@ -1,8 +1,5 @@
This section is directed at **hosts** and **server administrators**.
To install RSS-Bridge, please follow the [installation instructions](../03_For_Hosts/01_Installation.md).
You must have access to a web server with a working PHP environment!
RSS-Bridge comes with a large amount of bridges.
Some bridges could be implemented more efficiently by actually using proprietary APIs,
@ -11,4 +8,5 @@ but there are reasons against it:
- RSS-Bridge exists in the first place to NOT use APIs.
- See [the rant](https://github.com/RSS-Bridge/rss-bridge/blob/master/README.md#Rant)
- APIs require private keys that could be stored on servers running RSS-Bridge,which is a security concern, involves complex authorizations for inexperienced users and could cause harm (when using paid services for example). In a closed environment (a server only you use for yourself) however you might be interested in using them anyway. So, check [this](https://github.com/RSS-Bridge/rss-bridge/pull/478/files) possible implementation of an anti-captcha solution.
- APIs require private keys that could be stored on servers running RSS-Bridge,
- which is a security concern, involves complex authorizations for inexperienced users and could cause harm (when using paid services for example). In a closed environment (a server only you use for yourself) however you might be interested in using them anyway. So, check [this](https://github.com/RSS-Bridge/rss-bridge/pull/478/files) possible implementation of an anti-captcha solution.

3
docs/05_Bridge_API/01_How_to_create_a_new_bridge.md
View File

@ -27,4 +27,5 @@ The file must start with the PHP tags and end with an empty line. The closing ta
// This line is empty (just imagine it!)
```
The next step is to extend one of the base classes. Refer to one of an base classes listed on the [Bridge API](../05_Bridge_API/index.md) page.
The next step is to extend one of the base classes.
Refer to one of an base classes listed on the [Bridge API](../05_Bridge_API/index.md) page.

7
docs/05_Bridge_API/02_BridgeAbstract.md
View File

@ -50,10 +50,10 @@ For example: `MyBridge.php` => `MyBridge`
```PHP
<?PHP
class MyBridge extends BridgeAbstract {
class MyBridge extends BridgeAbstract
{
}
// This line is empty (just imagine it!)
```
</div></details>
@ -76,7 +76,8 @@ const CACHE_TIMEOUT // (optional) Defines the maximum duration for the cache in
```PHP
<?php
class MyBridge extends BridgeAbstract {
class MyBridge extends BridgeAbstract
{
const NAME = 'My Bridge';
const URI = 'https://rss-bridge.github.io/rss-bridge/Bridge_API/BridgeAbstract.html';
const DESCRIPTION = 'Returns "Hello World!"';

34
docs/09_Technical_recommendations/index.md
View File

@ -1,28 +1,32 @@
## General recommendations
* Use [HTTPS](https://en.wikipedia.org/wiki/HTTPS) (`https://...`) over [HTTP](https://en.wikipedia.org/wiki/HTTPS) (`http://...`) whenever possible
## Test a site before building a bridge
Some sites make use of anti-bot mechanisms (e.g.: by using JavaScript) in which case they work fine in regular browsers, but not in the PHP environment. To check if a site works with RSS-Bridge, create a new bridge using the [template](../05_Bridge_API/02_BridgeAbstract.md#template) and load a valid URL (not the base URL!).
Some sites make use of anti-bot mechanisms (e.g.: by using JavaScript) in which case they work fine in regular browsers,
but not in the PHP environment.
To check if a site works with RSS-Bridge, create a new bridge using the
[template](../05_Bridge_API/02_BridgeAbstract.md#template)
and load a valid URL (not the base URL!).
**Example (using github.com)**
```PHP
<?php
class TestBridge extends BridgeAbstract {
const NAME = 'Unnamed bridge';
const URI = '';
const DESCRIPTION = 'No description provided';
const MAINTAINER = 'No maintainer';
const PARAMETERS = [];
const CACHE_TIMEOUT = 3600;
class TestBridge extends BridgeAbstract
{
const NAME = 'Unnamed bridge';
const URI = '';
const DESCRIPTION = 'No description provided';
const MAINTAINER = 'No maintainer';
const PARAMETERS = [];
const CACHE_TIMEOUT = 3600;
public function collectData(){
$html = getSimpleHTMLDOM('https://github.com/rss-bridge/rss-bridge')
or returnServerError('No contents received!');
}
public function collectData()
{
$html = getSimpleHTMLDOM('https://github.com/rss-bridge/rss-bridge');
}
}
```
This bridge should return an empty page (HTML format)
This bridge should return an empty page (HTML format)

34
index.php
View File

@ -5,19 +5,12 @@ if (version_compare(\PHP_VERSION, '7.4.0') === -1) {
exit("RSS-Bridge requires minimum PHP version 7.4\n");
}
require_once __DIR__ . '/lib/bootstrap.php';
require __DIR__ . '/lib/bootstrap.php';
require __DIR__ . '/lib/config.php';
$config = [];
if (file_exists(__DIR__ . '/config.ini.php')) {
$config = parse_ini_file(__DIR__ . '/config.ini.php', true, INI_SCANNER_TYPED);
if (!$config) {
http_response_code(500);
exit("Error parsing config.ini.php\n");
}
}
Configuration::loadConfiguration($config, getenv());
$container = require __DIR__ . '/lib/dependencies.php';
$logger = new SimpleLogger('rssbridge');
$logger = $container['logger'];
set_exception_handler(function (\Throwable $e) use ($logger) {
$response = new Response(render(__DIR__ . '/templates/exception.html.php', ['e' => $e]), 500);
@ -60,23 +53,6 @@ register_shutdown_function(function () use ($logger) {
}
});
$cacheFactory = new CacheFactory($logger);
// Uncomment this for info logging to fs
// $logger->addHandler(new StreamHandler('/tmp/rss-bridge.txt', Logger::INFO));
// Uncomment this for debug logging to fs
// $logger->addHandler(new StreamHandler('/tmp/rss-bridge-debug.txt', Logger::DEBUG));
if (Debug::isEnabled()) {
$logger->addHandler(new ErrorLogHandler(Logger::DEBUG));
$cache = $cacheFactory->create('array');
} else {
$logger->addHandler(new ErrorLogHandler(Logger::INFO));
$cache = $cacheFactory->create();
}
$httpClient = new CurlHttpClient();
date_default_timezone_set(Configuration::getConfig('system', 'timezone'));
$argv = $argv ?? null;
@ -88,7 +64,7 @@ if ($argv) {
}
try {
$rssBridge = new RssBridge($logger, $cache, $httpClient);
$rssBridge = new RssBridge($container);
$response = $rssBridge->main($request);
$response->send();
} catch (\Throwable $e) {

9
lib/BridgeCard.php
View File

@ -2,10 +2,11 @@
final class BridgeCard
{
public static function render(string $bridgeClassName, ?string $token): string
{
$bridgeFactory = new BridgeFactory();
public static function render(
BridgeFactory $bridgeFactory,
string $bridgeClassName,
?string $token
): string {
$bridge = $bridgeFactory->create($bridgeClassName);
$uri = $bridge->getURI();

10
lib/BridgeFactory.php
View File

@ -8,10 +8,12 @@ final class BridgeFactory
private array $enabledBridges = [];
private array $missingEnabledBridges = [];
public function __construct()
{
$this->cache = RssBridge::getCache();
$this->logger = RssBridge::getLogger();
public function __construct(
CacheInterface $cache,
Logger $logger
) {
$this->cache = $cache;
$this->logger = $logger;
// Create all possible bridge class names from fs
foreach (scandir(__DIR__ . '/../bridges/') as $file) {

4
lib/CacheFactory.php
View File

@ -14,10 +14,6 @@ class CacheFactory
public function create(string $name = null): CacheInterface
{
$name ??= Configuration::getConfig('cache', 'type');
if (!$name) {
throw new \Exception('No cache type configured');
}
$cacheNames = [];
foreach (scandir(PATH_LIB_CACHES) as $file) {
if (preg_match('/^([^.]+)Cache\.php$/U', $file, $m)) {

42
lib/Configuration.php
View File

@ -15,43 +15,6 @@ final class Configuration
{
}
public static function checkInstallation(): array
{
$errors = [];
// OpenSSL: https://www.php.net/manual/en/book.openssl.php
if (!extension_loaded('openssl')) {
$errors[] = 'openssl extension not loaded';
}
// libxml: https://www.php.net/manual/en/book.libxml.php
if (!extension_loaded('libxml')) {
$errors[] = 'libxml extension not loaded';
}
// Multibyte String (mbstring): https://www.php.net/manual/en/book.mbstring.php
if (!extension_loaded('mbstring')) {
$errors[] = 'mbstring extension not loaded';
}
// SimpleXML: https://www.php.net/manual/en/book.simplexml.php
if (!extension_loaded('simplexml')) {
$errors[] = 'simplexml extension not loaded';
}
// Client URL Library (curl): https://www.php.net/manual/en/book.curl.php
// Allow RSS-Bridge to run without curl module in CLI mode without root certificates
if (!extension_loaded('curl') && !(php_sapi_name() === 'cli' && empty(ini_get('curl.cainfo')))) {
$errors[] = 'curl extension not loaded';
}
// JavaScript Object Notation (json): https://www.php.net/manual/en/book.json.php
if (!extension_loaded('json')) {
$errors[] = 'json extension not loaded';
}
return $errors;
}
public static function loadConfiguration(array $customConfig = [], array $env = [])
{
if (!file_exists(__DIR__ . '/../config.default.ini.php')) {
@ -204,7 +167,10 @@ final class Configuration
return self::$config[strtolower($section)][strtolower($key)] ?? $default;
}
private static function setConfig(string $section, string $key, $value): void
/**
* @internal Please avoid usage
*/
public static function setConfig(string $section, string $key, $value): void
{
self::$config[strtolower($section)][strtolower($key)] = $value;
}

35
lib/Container.php Normal file
View File

@ -0,0 +1,35 @@
<?php
declare(strict_types=1);
class Container implements \ArrayAccess
{
private array $values = [];
private array $resolved = [];
public function offsetSet($offset, $value): void
{
$this->values[$offset] = $value;
}
#[\ReturnTypeWillChange]
public function offsetGet($offset)
{
if (!isset($this->values[$offset])) {
throw new \Exception(sprintf('Unknown container key: "%s"', $offset));
}
if (!isset($this->resolved[$offset])) {
$this->resolved[$offset] = $this->values[$offset]($this);
}
return $this->resolved[$offset];
}
#[\ReturnTypeWillChange]
public function offsetExists($offset)
{
}
public function offsetUnset($offset): void
{
}
}

5
lib/FeedItem.php
View File

@ -25,7 +25,10 @@ class FeedItem
private function __construct()
{
$this->logger = RssBridge::getLogger();
global $container;
// The default NullLogger is for when running the unit tests
$this->logger = $container['logger'] ?? new NullLogger();
}
public function __set($name, $value)

104
lib/RssBridge.php
View File

@ -2,79 +2,16 @@
final class RssBridge
{
private static Logger $logger;
private static CacheInterface $cache;
private static HttpClient $httpClient;
private Container $container;
public function __construct(
Logger $logger,
CacheInterface $cache,
HttpClient $httpClient
Container $container
) {
self::$logger = $logger;
self::$cache = $cache;
self::$httpClient = $httpClient;
$this->container = $container;
}
public function main(Request $request): Response
{
foreach ($request->toArray() as $key => $value) {
if (!is_string($value)) {
return new Response(render(__DIR__ . '/../templates/error.html.php', [
'message' => "Query parameter \"$key\" is not a string.",
]), 400);
}
}
if (Configuration::getConfig('system', 'enable_maintenance_mode')) {
return new Response(render(__DIR__ . '/../templates/error.html.php', [
'title' => '503 Service Unavailable',
'message' => 'RSS-Bridge is down for maintenance.',
]), 503);
}
// HTTP Basic auth check
if (Configuration::getConfig('authentication', 'enable')) {
if (Configuration::getConfig('authentication', 'password') === '') {
return new Response('The authentication password cannot be the empty string', 500);
}
$user = $request->server('PHP_AUTH_USER');
$password = $request->server('PHP_AUTH_PW');
if ($user === null || $password === null) {
$html = render(__DIR__ . '/../templates/error.html.php', [
'message' => 'Please authenticate in order to access this instance!',
]);
return new Response($html, 401, ['WWW-Authenticate' => 'Basic realm="RSS-Bridge"']);
}
if (
(Configuration::getConfig('authentication', 'username') !== $user)
|| (! hash_equals(Configuration::getConfig('authentication', 'password'), $password))
) {
$html = render(__DIR__ . '/../templates/error.html.php', [
'message' => 'Please authenticate in order to access this instance!',
]);
return new Response($html, 401, ['WWW-Authenticate' => 'Basic realm="RSS-Bridge"']);
}
// At this point the username and password was correct
}
// Add token as attribute to request
$request = $request->withAttribute('token', $request->get('token'));
// Token authentication check
if (Configuration::getConfig('authentication', 'token')) {
if (! $request->attribute('token')) {
return new Response(render(__DIR__ . '/../templates/token.html.php', [
'message' => '',
]), 401);
}
if (! hash_equals(Configuration::getConfig('authentication', 'token'), $request->attribute('token'))) {
return new Response(render(__DIR__ . '/../templates/token.html.php', [
'message' => 'Invalid token',
]), 401);
}
}
$action = $request->get('action', 'Frontpage');
$actionName = strtolower($action) . 'Action';
$actionName = implode(array_map('ucfirst', explode('-', $actionName)));
@ -83,27 +20,20 @@ final class RssBridge
return new Response(render(__DIR__ . '/../templates/error.html.php', ['message' => 'Invalid action']), 400);
}
$className = '\\' . $actionName;
$actionObject = new $className();
$handler = $this->container[$actionName];
$response = $actionObject($request);
return $response;
}
public static function getLogger(): Logger
{
// null logger is only for the tests not to fail
return self::$logger ?? new NullLogger();
}
public static function getCache(): CacheInterface
{
return self::$cache;
}
public static function getHttpClient(): HttpClient
{
return self::$httpClient;
$middlewares = [
new SecurityMiddleware(),
new MaintenanceMiddleware(),
new BasicAuthMiddleware(),
new TokenAuthenticationMiddleware(),
];
$action = function ($req) use ($handler) {
return $handler($req);
};
foreach (array_reverse($middlewares) as $middleware) {
$action = fn ($req) => $middleware($req, $action);
}
return $action($request);
}
}

1
lib/bootstrap.php
View File

@ -37,6 +37,7 @@ spl_autoload_register(function ($className) {
__DIR__ . '/../caches/',
__DIR__ . '/../formats/',
__DIR__ . '/../lib/',
__DIR__ . '/../middlewares/',
];
foreach ($folders as $folder) {
$file = $folder . $className . '.php';

13
lib/config.php Normal file
View File

@ -0,0 +1,13 @@
<?php
declare(strict_types=1);
$config = [];
if (file_exists(__DIR__ . '/../config.ini.php')) {
$config = parse_ini_file(__DIR__ . '/../config.ini.php', true, INI_SCANNER_TYPED);
if (!$config) {
http_response_code(500);
exit("Error parsing config.ini.php\n");
}
}
Configuration::loadConfiguration($config, getenv());

15
lib/contents.php
View File

@ -14,8 +14,13 @@ function getContents(
array $curlOptions = [],
bool $returnFull = false
) {
$httpClient = RssBridge::getHttpClient();
$cache = RssBridge::getCache();
global $container;
/** @var HttpClient $httpClient */
$httpClient = $container['http_client'];
/** @var CacheInterface $cache */
$cache = $container['cache'];
// TODO: consider url validation at this point
@ -212,7 +217,11 @@ function getSimpleHTMLDOMCached(
$defaultBRText = DEFAULT_BR_TEXT,
$defaultSpanText = DEFAULT_SPAN_TEXT
) {
$cache = RssBridge::getCache();
global $container;
/** @var CacheInterface $cache */
$cache = $container['cache'];
$cacheKey = 'pages_' . $url;
$content = $cache->get($cacheKey);
if (!$content) {

78
lib/dependencies.php Normal file
View File

@ -0,0 +1,78 @@
<?php
declare(strict_types=1);
$container = new Container();
$container[ConnectivityAction::class] = function ($c) {
return new ConnectivityAction($c['bridge_factory']);
};
$container[DetectAction::class] = function ($c) {
return new DetectAction($c['bridge_factory']);
};
$container[DisplayAction::class] = function ($c) {
return new DisplayAction($c['cache'], $c['logger'], $c['bridge_factory']);
};
$container[FindfeedAction::class] = function ($c) {
return new FindfeedAction($c['bridge_factory']);
};
$container[FrontpageAction::class] = function ($c) {
return new FrontpageAction($c['bridge_factory']);
};
$container[HealthAction::class] = function () {
return new HealthAction();
};
$container[ListAction::class] = function ($c) {
return new ListAction($c['bridge_factory']);
};
$container['bridge_factory'] = function ($c) {
return new BridgeFactory($c['cache'], $c['logger']);
};
$container['http_client'] = function () {
return new CurlHttpClient();
};
$container['cache_factory'] = function ($c) {
return new CacheFactory($c['logger']);
};
$container['logger'] = function () {
$logger = new SimpleLogger('rssbridge');
if (Debug::isEnabled()) {
$logger->addHandler(new ErrorLogHandler(Logger::DEBUG));
} else {
$logger->addHandler(new ErrorLogHandler(Logger::INFO));
}
// Uncomment this for info logging to fs
// $logger->addHandler(new StreamHandler('/tmp/rss-bridge.txt', Logger::INFO));
// Uncomment this for debug logging to fs
//$logger->addHandler(new StreamHandler('/tmp/rss-bridge-debug.txt', Logger::DEBUG));
return $logger;
};
$container['cache'] = function ($c) {
/** @var CacheFactory $cacheFactory */
$cacheFactory = $c['cache_factory'];
$type = Configuration::getConfig('cache', 'type');
if (!$type) {
throw new \Exception('No cache type configured');
}
if (Debug::isEnabled()) {
$cache = $cacheFactory->create('array');
} else {
$cache = $cacheFactory->create($type);
}
return $cache;
};
return $container;

3
lib/logger.php
View File

@ -175,8 +175,9 @@ final class ErrorLogHandler
$context = Json::encode($record['context']);
}
}
// Intentionally omitting newline
$text = sprintf(
"[%s] %s.%s %s %s\n",
'[%s] %s.%s %s %s',
$record['created_at']->format('Y-m-d H:i:s'),
$record['name'],
$record['level_name'],

38
middlewares/BasicAuthMiddleware.php Normal file
View File

@ -0,0 +1,38 @@
<?php
declare(strict_types=1);
/**
* HTTP Basic auth check
*/
class BasicAuthMiddleware implements Middleware
{
public function __invoke(Request $request, $next): Response
{
if (!Configuration::getConfig('authentication', 'enable')) {
return $next($request);
}
if (Configuration::getConfig('authentication', 'password') === '') {
return new Response('The authentication password cannot be the empty string', 500);
}
$user = $request->server('PHP_AUTH_USER');
$password = $request->server('PHP_AUTH_PW');
if ($user === null || $password === null) {
$html = render(__DIR__ . '/../templates/error.html.php', [
'message' => 'Please authenticate in order to access this instance!',
]);
return new Response($html, 401, ['WWW-Authenticate' => 'Basic realm="RSS-Bridge"']);
}
if (
(Configuration::getConfig('authentication', 'username') !== $user)
|| (!hash_equals(Configuration::getConfig('authentication', 'password'), $password))
) {
$html = render(__DIR__ . '/../templates/error.html.php', [
'message' => 'Please authenticate in order to access this instance!',
]);
return new Response($html, 401, ['WWW-Authenticate' => 'Basic realm="RSS-Bridge"']);
}
return $next($request);
}
}

17
middlewares/MaintenanceMiddleware.php Normal file
View File

@ -0,0 +1,17 @@
<?php
declare(strict_types=1);
class MaintenanceMiddleware implements Middleware
{
public function __invoke(Request $request, $next): Response
{
if (!Configuration::getConfig('system', 'enable_maintenance_mode')) {
return $next($request);
}
return new Response(render(__DIR__ . '/../templates/error.html.php', [
'title' => '503 Service Unavailable',
'message' => 'RSS-Bridge is down for maintenance.',
]), 503);
}
}

8
middlewares/Middleware.php Normal file
View File

@ -0,0 +1,8 @@
<?php
declare(strict_types=1);
interface Middleware
{
public function __invoke(Request $request, $next): Response;
}

21
middlewares/SecurityMiddleware.php Normal file
View File

@ -0,0 +1,21 @@
<?php
declare(strict_types=1);
/**
* Make sure that only strings are allowed in GET parameters
*/
class SecurityMiddleware implements Middleware
{
public function __invoke(Request $request, $next): Response
{
foreach ($request->toArray() as $key => $value) {
if (!is_string($value)) {
return new Response(render(__DIR__ . '/../templates/error.html.php', [
'message' => "Query parameter \"$key\" is not a string.",
]), 400);
}
}
return $next($request);
}
}

29
middlewares/TokenAuthenticationMiddleware.php Normal file
View File

@ -0,0 +1,29 @@
<?php
declare(strict_types=1);
class TokenAuthenticationMiddleware implements Middleware
{
public function __invoke(Request $request, $next): Response
{
if (! Configuration::getConfig('authentication', 'token')) {
return $next($request);
}
// Always add token to request attribute
$request = $request->withAttribute('token', $request->get('token'));
if (! $request->attribute('token')) {
return new Response(render(__DIR__ . '/../templates/token.html.php', [
'message' => 'Missing token',
]), 401);
}
if (! hash_equals(Configuration::getConfig('authentication', 'token'), $request->attribute('token'))) {
return new Response(render(__DIR__ . '/../templates/token.html.php', [
'message' => 'Invalid token',
]), 401);
}
return $next($request);
}
}