LesLibres.org/Rss-Bridge
2
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

core: Add an option to return errors in different formats (#1071)

Browse source 
Bridge errors are currently included as part of the feed to
notify users about erroneous bridges (before that, bridges
silently failed).

This solution, however, can produce a high load of error
messages if servers are down (see #994 for more details).

Admins may also not want to include error messages in feeds
in order to keep those kind of problems away from users or
simply to silently fail by choice.

This commit adds a new configuration section "error" with
one option "output" which can be set to following values:

"feed": To include error messages in the feed (default)
"http": To return a HTTP header for each error
"none": To disable error reporting

Note that errors are always logged to 'error.log' independent
of the settings above.

Closes #1066
This commit is contained in:
LogMANOriginal 2019-10-31 18:40:51 +01:00 committed by GitHub
parent a0afe36d56
commit e8536ac1b2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 68 additions and 46 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

102
actions/DisplayAction.php
View file

@ -146,19 +146,58 @@ class DisplayAction extends ActionAbstract {
} catch(Error $e) { } catch(Error $e) {
error_log($e); error_log($e);
$item = new \FeedItem(); if(Configuration::getConfig('error', 'output') === 'feed') {
$item = new \FeedItem();
// Create "new" error message every 24 hours // Create "new" error message every 24 hours
$this->userData['_error_time'] = urlencode((int)(time() / 86400)); $this->userData['_error_time'] = urlencode((int)(time() / 86400));
// Error 0 is a special case (i.e. "trying to get property of non-object") // Error 0 is a special case (i.e. "trying to get property of non-object")
if($e->getCode() === 0) { if($e->getCode() === 0) {
$item->setTitle( $item->setTitle(
'Bridge encountered an unexpected situation! (' 'Bridge encountered an unexpected situation! ('
. $this->userData['_error_time'] . $this->userData['_error_time']
. ')' . ')'
);
} else {
$item->setTitle(
'Bridge returned error '
. $e->getCode()
. '! ('
. $this->userData['_error_time']
. ')'
);
}
$item->setURI(
(isset($_SERVER['REQUEST_URI']) ? parse_url($_SERVER['REQUEST_URI'], PHP_URL_PATH) : '')
. '?'
. http_build_query($this->userData)
); );
} else {
$item->setTimestamp(time());
$item->setContent(buildBridgeException($e, $bridge));
$items[] = $item;
} elseif(Configuration::getConfig('error', 'output') === 'http') {
header('Content-Type: text/html', true, $e->getCode());
die(buildTransformException($e, $bridge));
}
} catch(Exception $e) {
error_log($e);
if(Configuration::getConfig('error', 'output') === 'feed') {
$item = new \FeedItem();
// Create "new" error message every 24 hours
$this->userData['_error_time'] = urlencode((int)(time() / 86400));
$item->setURI(
(isset($_SERVER['REQUEST_URI']) ? parse_url($_SERVER['REQUEST_URI'], PHP_URL_PATH) : '')
. '?'
. http_build_query($this->userData)
);
$item->setTitle( $item->setTitle(
'Bridge returned error ' 'Bridge returned error '
. $e->getCode() . $e->getCode()
@ -166,43 +205,14 @@ class DisplayAction extends ActionAbstract {
. $this->userData['_error_time'] . $this->userData['_error_time']
. ')' . ')'
); );
$item->setTimestamp(time());
$item->setContent(buildBridgeException($e, $bridge));
$items[] = $item;
} elseif(Configuration::getConfig('error', 'output') === 'http') {
header('Content-Type: text/html', true, $e->getCode());
die(buildTransformException($e, $bridge));
} }
$item->setURI(
(isset($_SERVER['REQUEST_URI']) ? parse_url($_SERVER['REQUEST_URI'], PHP_URL_PATH) : '')
. '?'
. http_build_query($this->userData)
);
$item->setTimestamp(time());
$item->setContent(buildBridgeException($e, $bridge));
$items[] = $item;
} catch(Exception $e) {
error_log($e);
$item = new \FeedItem();
// Create "new" error message every 24 hours
$this->userData['_error_time'] = urlencode((int)(time() / 86400));
$item->setURI(
(isset($_SERVER['REQUEST_URI']) ? parse_url($_SERVER['REQUEST_URI'], PHP_URL_PATH) : '')
. '?'
. http_build_query($this->userData)
);
$item->setTitle(
'Bridge returned error '
. $e->getCode()
. '! ('
. $this->userData['_error_time']
. ')'
);
$item->setTimestamp(time());
$item->setContent(buildBridgeException($e, $bridge));
$items[] = $item;
} }
// Store data in cache // Store data in cache

9
config.default.ini.php
View file

@ -61,6 +61,15 @@ username = ""
; Use a strong password to prevent others from guessing your login! ; Use a strong password to prevent others from guessing your login!
password = "" password = ""
[error]
; Defines how error messages are returned by RSS-Bridge
;
; "feed" = As part of the feed (default)
; "http" = As HTTP error message
; "none" = No errors are reported
output = "feed"
; --- Cache specific configuration --------------------------------------------- ; --- Cache specific configuration ---------------------------------------------
[SQLiteCache] [SQLiteCache]

3
lib/Configuration.php
View file

@ -201,6 +201,9 @@ final class Configuration {
&& !filter_var(self::getConfig('admin', 'email'), FILTER_VALIDATE_EMAIL)) && !filter_var(self::getConfig('admin', 'email'), FILTER_VALIDATE_EMAIL))
self::reportConfigurationError('admin', 'email', 'Is not a valid email address'); self::reportConfigurationError('admin', 'email', 'Is not a valid email address');
if(!is_string(self::getConfig('error', 'output')))
self::reportConfigurationError('error', 'output', 'Is not a valid String');
} }
/** /**