+
+Level of detail for diagnostics. Enable this for debug traces if you encounter selfoss internal errors or are developing selfoss.
+
+* `0` (default) – Debugging is disabled, warnings will only be [logged](#logger-level).
+* `1` – Debugging is enabled, any error or warning will terminate the application and cause debugging information to be printed into the web browser.
+* `2` – Same as `1` but additional information (HTTP requests) will be logged when fetching feed content.
+
+
### `logger_destination`
diff --git a/src/common.php b/src/common.php
index d9db78c785..61bc148e9d 100644
--- a/src/common.php
+++ b/src/common.php
@@ -3,42 +3,40 @@
use Dice\Dice;
use helpers\Configuration;
use helpers\DatabaseConnection;
+use function helpers\sendError;
use Monolog\Formatter\LineFormatter;
use Monolog\Handler\ErrorLogHandler;
use Monolog\Handler\NullHandler;
use Monolog\Handler\StreamHandler;
use Monolog\Logger;
+use Tracy\Debugger;
require __DIR__ . '/constants.php';
+require_once __DIR__ . '/helpers/responses.php';
$autoloader = @include BASEDIR . '/vendor/autoload.php'; // we will show custom error
if ($autoloader === false) {
+ header('Content-type: text/plain');
echo 'The PHP dependencies are missing. Did you run `composer install` in the selfoss directory?';
exit;
}
-$startup_error = error_get_last();
-
-// F3 crashes when there were PHP startups error even though
-// they might not affect the program (e.g. unable to load an extension).
-// It also sets its own error_reporting value and uses the previous one
-// as a signal to disable the initialization failure check.
-error_reporting(0);
-
-$f3 = Base::instance();
-
-// Disable deprecation warnings.
-// Dice uses ReflectionParameter::getClass(), which is deprecated in PHP 8
-// but we have not set an error handler yet because it needs a Logger instantiated by Dice.
-error_reporting(E_ALL & ~E_DEPRECATED);
-
-$f3->set('AUTOLOAD', false);
-$f3->set('BASEDIR', BASEDIR);
+// Catch any errors and hopefully log them.
+Debugger::$errorTemplate = __DIR__ . '/error.500.phtml';
+Debugger::enable(Debugger::PRODUCTION);
$configuration = new Configuration(__DIR__ . '/../config.ini', $_ENV);
-$f3->set('DEBUG', $configuration->debug);
-$f3->set('cache', $configuration->cache);
+if ($configuration->debug !== 0) {
+ // Enable strict mode to loudly fail on any error or warning.
+ // We ignore deprecation warnings because Dice uses deprecated
+ // ReflectionParameter::getClass(), which we cannot do anything about.
+ Debugger::$strictMode = E_ALL & ~E_DEPRECATED;
+ // Switch to development mode so that traces are displayed.
+ Debugger::enable(Debugger::DEVELOPMENT);
+ // Dispatch will not run in production mode preventing bar from loading.
+ Debugger::dispatch();
+}
$dice = new Dice();
@@ -83,8 +81,7 @@
$dice->addRule(daos\TagsInterface::class, $shared);
if ($configuration->isChanged('dbSocket') && $configuration->isChanged('dbHost')) {
- echo 'You cannot set both `db_socket` and `db_host` options.' . PHP_EOL;
- exit;
+ sendError('You cannot set both `db_socket` and `db_host` options.' . PHP_EOL);
}
// Database connection
@@ -231,8 +228,7 @@ function($pattern, $text) {
} elseif ($logger_destination === 'error_log') {
$handler = new ErrorLogHandler(ErrorLogHandler::OPERATING_SYSTEM, $configuration->loggerLevel);
} else {
- echo 'The `logger_destination` option needs to be either `error_log` or a file path prefixed by `file:`.';
- exit;
+ sendError('The `logger_destination` option needs to be either `error_log` or a file path prefixed by `file:`.');
}
$formatter = new LineFormatter(null, null, true, true);
@@ -241,42 +237,5 @@ function($pattern, $text) {
}
$log->pushHandler($handler);
-if (isset($startup_error)) {
- $log->warn('PHP likely encountered a startup error: ', [$startup_error]);
-}
-
-// init error handling
-$f3->set('ONERROR',
- function(Base $f3) use ($configuration, $log, $handler) {
- $exception = $f3->get('EXCEPTION');
-
- try {
- if ($exception) {
- $log->error($exception->getMessage(), ['exception' => $exception]);
- } else {
- $log->error($f3->get('ERROR.text'));
- }
-
- if ($configuration->debug !== 0) {
- echo 'An error occurred' . ': ';
- echo $f3->get('ERROR.text') . "\n";
- echo $f3->get('ERROR.trace');
- } else {
- if ($handler instanceof StreamHandler) {
- echo 'An error occured, please check the log file “' . $handler->getUrl() . '”.' . PHP_EOL;
- } elseif ($handler instanceof ErrorLogHandler) {
- echo 'An error occured, please check your system logs.' . PHP_EOL;
- } else {
- echo 'An error occurred' . PHP_EOL;
- }
- }
- } catch (Exception $e) {
- echo 'Unable to write logs.' . PHP_EOL;
- echo $e->getMessage() . PHP_EOL;
- }
- }
-);
-
-if ($configuration->debug !== 0) {
- ini_set('display_errors', '0');
-}
+// Try to log errors encountered by error handler.
+Debugger::setLogger($dice->create(helpers\TracyLogger::class));
diff --git a/src/controllers/Index.php b/src/controllers/Index.php
index dc91868721..f2188f6d36 100644
--- a/src/controllers/Index.php
+++ b/src/controllers/Index.php
@@ -63,11 +63,13 @@ public function home() {
$home = BASEDIR . '/public/index.html';
if (!file_exists($home)) {
http_response_code(500);
+ header('Content-type: text/plain');
echo 'Please build the assets using `npm run build` or obtain a pre-built packages from https://selfoss.aditu.de.';
exit;
}
// show as full html page
+ header('Content-type: text/html');
readfile($home);
return;
diff --git a/src/controllers/Opml/Export.php b/src/controllers/Opml/Export.php
index 27bd6b28f8..d359c209d5 100644
--- a/src/controllers/Opml/Export.php
+++ b/src/controllers/Opml/Export.php
@@ -94,6 +94,11 @@ private function writeSource(array $source) {
public function export() {
$this->authentication->needsLoggedIn();
+ // save content as file and suggest file name
+ $exportName = 'selfoss-subscriptions-' . date('YmdHis') . '.xml';
+ header('Content-Disposition: attachment; filename="' . $exportName . '"');
+ header('Content-Type: text/xml; charset=UTF-8');
+
$this->logger->debug('start OPML export');
$this->writer->openMemory();
$this->writer->setIndent(true);
@@ -166,10 +171,6 @@ public function export() {
$this->writer->endDocument();
$this->logger->debug('finished OPML export');
- // save content as file and suggest file name
- $exportName = 'selfoss-subscriptions-' . date('YmdHis') . '.xml';
- header('Content-Disposition: attachment; filename="' . $exportName . '"');
- header('Content-Type: text/xml; charset=UTF-8');
echo $this->writer->outputMemory();
}
}
diff --git a/src/controllers/Opml/ImportPage.php b/src/controllers/Opml/ImportPage.php
index 11ec42152e..2c2d7b6adb 100644
--- a/src/controllers/Opml/ImportPage.php
+++ b/src/controllers/Opml/ImportPage.php
@@ -25,6 +25,7 @@ public function __construct(Authentication $authentication) {
*/
public function show() {
$this->authentication->needsLoggedIn();
+ header('Content-type: text/html');
readfile(BASEDIR . '/public/opml.html');
}
}
diff --git a/src/controllers/Sources/Update.php b/src/controllers/Sources/Update.php
index 6ff65c7ee8..5526072dd4 100644
--- a/src/controllers/Sources/Update.php
+++ b/src/controllers/Sources/Update.php
@@ -27,6 +27,8 @@ public function __construct(Authentication $authentication, ContentLoader $conte
* @return void
*/
public function updateAll() {
+ header('Content-type: text/plain');
+
// only allow access for localhost and loggedin users
if (!$this->authentication->allowedToUpdate()) {
exit('unallowed access');
@@ -47,6 +49,8 @@ public function updateAll() {
* @return void
*/
public function update($id) {
+ header('Content-type: text/plain');
+
// only allow access for localhost and authenticated users
if (!$this->authentication->allowedToUpdate()) {
exit('unallowed access');
diff --git a/src/controllers/Sources/Write.php b/src/controllers/Sources/Write.php
index 20714a7a57..dee16a47db 100644
--- a/src/controllers/Sources/Write.php
+++ b/src/controllers/Sources/Write.php
@@ -109,7 +109,7 @@ public function write($id = null) {
$validation = $this->sourcesDao->validate($title, $spout, $data);
if ($validation !== true) {
- $this->view->error(json_encode($validation));
+ $this->view->jsonError($validation);
}
// add/edit source
diff --git a/src/error.500.phtml b/src/error.500.phtml
new file mode 100644
index 0000000000..31d967633c
--- /dev/null
+++ b/src/error.500.phtml
@@ -0,0 +1,50 @@
+
+
+
+
+
+
selfoss failed
+
+
+
+
+
+
selfoss failed
+
+
We’re sorry! selfoss encountered an unexpected error and was unable to complete your request.
+
+
Please contact your administrator or try again later.
+
+
If you are the administrator,
+
+ please check the logs or add
+
+ selfoss is unable to log the error, make sure the data/logs directory is writeable (if applicable), or try adding
+
+ debug=1 to your selfoss instance configuration.
+
+
error 500 |
+
+
+
+
diff --git a/src/helpers/Authentication.php b/src/helpers/Authentication.php
index 87dbc7ec2a..368794525a 100644
--- a/src/helpers/Authentication.php
+++ b/src/helpers/Authentication.php
@@ -172,6 +172,7 @@ public function needsLoggedIn() {
*/
public function forbidden() {
header('HTTP/1.0 403 Forbidden');
+ header('Content-type: text/plain');
echo 'Access forbidden!';
exit;
}
diff --git a/src/helpers/Configuration.php b/src/helpers/Configuration.php
index 31ab8cfb24..11f7ad4953 100644
--- a/src/helpers/Configuration.php
+++ b/src/helpers/Configuration.php
@@ -24,7 +24,7 @@ class Configuration {
// Internal but overridable values.
- /** @var int debugging level @internal */
+ /** @var int debugging level */
public $debug = 0;
/** @var string @internal */
diff --git a/src/helpers/TracyLogger.php b/src/helpers/TracyLogger.php
new file mode 100644
index 0000000000..6aa6c734fc
--- /dev/null
+++ b/src/helpers/TracyLogger.php
@@ -0,0 +1,52 @@
+ Monolog\Logger::DEBUG,
+ self::INFO => Monolog\Logger::INFO,
+ self::WARNING => Monolog\Logger::WARNING,
+ self::ERROR => Monolog\Logger::ERROR,
+ self::EXCEPTION => Monolog\Logger::CRITICAL,
+ self::CRITICAL => Monolog\Logger::CRITICAL,
+ ];
+
+ /** @var Monolog\Logger */
+ protected $monolog;
+
+ public function __construct(Monolog\Logger $monolog) {
+ $this->monolog = $monolog;
+ }
+
+ public function log($message, $priority = self::INFO) {
+ $context = [
+ 'at' => Helpers::getSource(),
+ ];
+
+ if ($message instanceof Throwable || $message instanceof Exception) {
+ $context['exception'] = $message;
+ $message = '';
+ }
+
+ $this->monolog->addRecord(
+ self::PRIORITY_MAP[$priority] ?: Monolog\Logger::ERROR,
+ $message,
+ $context
+ );
+ }
+}
diff --git a/src/helpers/View.php b/src/helpers/View.php
index a9c37085b6..f63fc6b9e0 100644
--- a/src/helpers/View.php
+++ b/src/helpers/View.php
@@ -99,8 +99,7 @@ public function isAjax() {
* @return void
*/
public function error($message) {
- header('HTTP/1.0 400 Bad Request');
- exit($message);
+ sendError($message);
}
/**
@@ -111,8 +110,9 @@ public function error($message) {
* @return void
*/
public function jsonError($data) {
+ header('HTTP/1.0 400 Bad Request');
header('Content-type: application/json');
- $this->error(json_encode($data));
+ exit(json_encode($data));
}
/**
diff --git a/src/helpers/responses.php b/src/helpers/responses.php
new file mode 100644
index 0000000000..b5bbc7bcb9
--- /dev/null
+++ b/src/helpers/responses.php
@@ -0,0 +1,16 @@
+