diff --git a/actions/ConnectivityAction.php b/actions/ConnectivityAction.php index 9ebd640c..19e6b9a6 100644 --- a/actions/ConnectivityAction.php +++ b/actions/ConnectivityAction.php @@ -38,8 +38,7 @@ class ConnectivityAction implements ActionInterface } if (!isset($request['bridge'])) { - print render_template('connectivity.html.php'); - return; + return render_template('connectivity.html.php'); } $bridgeClassName = $this->bridgeFactory->sanitizeBridgeName($request['bridge']); @@ -48,7 +47,7 @@ class ConnectivityAction implements ActionInterface throw new \InvalidArgumentException('Bridge name invalid!'); } - $this->reportBridgeConnectivity($bridgeClassName); + return $this->reportBridgeConnectivity($bridgeClassName); } private function reportBridgeConnectivity($bridgeClassName) @@ -80,7 +79,6 @@ class ConnectivityAction implements ActionInterface $retVal['successful'] = false; } - header('Content-Type: text/json'); - print Json::encode($retVal); + return new Response(Json::encode($retVal), 200, ['Content-Type' => 'text/json']); } } diff --git a/actions/DetectAction.php b/actions/DetectAction.php index 71060bb8..6524bdfe 100644 --- a/actions/DetectAction.php +++ b/actions/DetectAction.php @@ -44,8 +44,8 @@ class DetectAction implements ActionInterface $bridgeParams['bridge'] = $bridgeClassName; $bridgeParams['format'] = $format; - header('Location: ?action=display&' . http_build_query($bridgeParams), true, 301); - return; + $url = '?action=display&' . http_build_query($bridgeParams); + return new Response('', 301, ['Location' => $url]); } throw new \Exception('No bridge found for given URL: ' . $targetURL); diff --git a/actions/DisplayAction.php b/actions/DisplayAction.php index 67c7c741..a0b23fd0 100644 --- a/actions/DisplayAction.php +++ b/actions/DisplayAction.php @@ -52,8 +52,7 @@ class DisplayAction implements ActionInterface if (! Configuration::getConfig('cache', 'custom_timeout')) { unset($request['_cache_timeout']); $uri = parse_url($_SERVER['REQUEST_URI'], PHP_URL_PATH) . '?' . http_build_query($request); - header('Location: ' . $uri, true, 301); - return; + return new Response('', 301, ['Location' => $uri]); } $cache_timeout = filter_var($request['_cache_timeout'], FILTER_VALIDATE_INT); @@ -116,8 +115,8 @@ class DisplayAction implements ActionInterface if ($mtime <= $stime) { // Cached data is older or same - header('Last-Modified: ' . gmdate('D, d M Y H:i:s ', $mtime) . 'GMT', true, 304); - return; + $lastModified2 = gmdate('D, d M Y H:i:s ', $mtime) . 'GMT'; + return new Response('', 304, ['Last-Modified' => $lastModified2]); } } @@ -197,11 +196,12 @@ class DisplayAction implements ActionInterface $format->setExtraInfos($infos); $lastModified = $cache->getTime(); $format->setLastModified($lastModified); + $headers = []; if ($lastModified) { - header('Last-Modified: ' . gmdate('D, d M Y H:i:s ', $lastModified) . 'GMT'); + $headers['Last-Modified'] = gmdate('D, d M Y H:i:s ', $lastModified) . 'GMT'; } - header('Content-Type: ' . $format->getMimeType() . '; charset=' . $format->getCharset()); - print $format->stringify(); + $headers['Content-Type'] = $format->getMimeType() . '; charset=' . $format->getCharset(); + return new Response($format->stringify(), 200, $headers); } private static function createGithubIssueUrl($bridge, $e, string $message): string diff --git a/actions/FrontpageAction.php b/actions/FrontpageAction.php index 9980facf..4b9d7cd3 100644 --- a/actions/FrontpageAction.php +++ b/actions/FrontpageAction.php @@ -5,91 +5,7 @@ final class FrontpageAction implements ActionInterface public function execute(array $request) { $showInactive = (bool) ($request['show_inactive'] ?? null); - - $totalBridges = 0; - $totalActiveBridges = 0; - - $html = self::getHead() - . self::getHeader() - . self::getSearchbar() - . self::getBridges($showInactive, $totalBridges, $totalActiveBridges) - . self::getFooter($totalBridges, $totalActiveBridges, $showInactive); - - print $html; - } - - private static function getHead() - { - return << - - - - - RSS-Bridge - - - - - - -
-EOD; - } - - private static function getHeader() - { - $warning = ''; - - if (Debug::isEnabled()) { - if (!Debug::isSecure()) { - $warning .= <<Warning : Debug mode is active from any location, - make sure only you can access RSS-Bridge. -EOD; - } else { - $warning .= <<Warning : Debug mode is active from your IP address, - your requests will bypass the cache. -EOD; - } - } - - return << - - {$warning} - -EOD; - } - - private static function getSearchbar() - { - $query = filter_input(INPUT_GET, 'q', \FILTER_SANITIZE_SPECIAL_CHARS); - - return << -

Search

- - -EOD; - } - - private static function getBridges($showInactive, &$totalBridges, &$totalActiveBridges) - { - $body = ''; - $totalActiveBridges = 0; - $inactiveBridges = ''; + $activeBridges = 0; $bridgeFactory = new BridgeFactory(); $bridgeClassNames = $bridgeFactory->getBridgeClassNames(); @@ -97,58 +13,22 @@ EOD; $formatFactory = new FormatFactory(); $formats = $formatFactory->getFormatNames(); - $totalBridges = count($bridgeClassNames); - + $body = ''; foreach ($bridgeClassNames as $bridgeClassName) { if ($bridgeFactory->isWhitelisted($bridgeClassName)) { $body .= BridgeCard::displayBridgeCard($bridgeClassName, $formats); - $totalActiveBridges++; + $activeBridges++; } elseif ($showInactive) { - $inactiveBridges .= BridgeCard::displayBridgeCard($bridgeClassName, $formats, false) . PHP_EOL; + $body .= BridgeCard::displayBridgeCard($bridgeClassName, $formats, false) . PHP_EOL; } } - $body .= $inactiveBridges; - - return $body; - } - - private static function getFooter($totalBridges, $totalActiveBridges, $showInactive) - { - $version = Configuration::getVersion(); - - $email = Configuration::getConfig('admin', 'email'); - $admininfo = ''; - if ($email) { - $admininfo = << - - You may email the administrator of this RSS-Bridge instance - at {$email} - -EOD; - } - - $inactive = ''; - - if ($totalActiveBridges !== $totalBridges) { - if ($showInactive) { - $inactive = '
'; - } else { - $inactive = '
'; - } - } - - return << - RSS-Bridge ~ Public Domain
-

{$version}

- {$totalActiveBridges}/{$totalBridges} active bridges.
- {$inactive} - {$admininfo} - -
- -EOD; + return render(__DIR__ . '/../templates/frontpage.html.php', [ + 'admin_email' => Configuration::getConfig('admin', 'email'), + 'bridges' => $body, + 'active_bridges' => $activeBridges, + 'total_bridges' => count($bridgeClassNames), + 'show_inactive' => $showInactive, + ]); } } diff --git a/actions/ListAction.php b/actions/ListAction.php index e2b0ccb9..3e151690 100644 --- a/actions/ListAction.php +++ b/actions/ListAction.php @@ -36,10 +36,7 @@ class ListAction implements ActionInterface 'description' => $bridge->getDescription() ]; } - $list->total = count($list->bridges); - - header('Content-Type: application/json'); - print Json::encode($list); + return new Response(Json::encode($list), 200, ['Content-Type' => 'application/json']); } } diff --git a/lib/ActionFactory.php b/lib/ActionFactory.php deleted file mode 100644 index c97891b7..00000000 --- a/lib/ActionFactory.php +++ /dev/null @@ -1,38 +0,0 @@ -folder = $folder; - } - - /** - * @param string $name The name of the action e.g. "Display", "List", or "Connectivity" - */ - public function create(string $name): ActionInterface - { - $name = strtolower($name) . 'Action'; - $name = implode(array_map('ucfirst', explode('-', $name))); - $filePath = $this->folder . $name . '.php'; - if (!file_exists($filePath)) { - throw new \Exception('Invalid action'); - } - $className = '\\' . $name; - return new $className(); - } -} diff --git a/lib/ActionInterface.php b/lib/ActionInterface.php index ea5020a3..4eb9cc65 100644 --- a/lib/ActionInterface.php +++ b/lib/ActionInterface.php @@ -22,7 +22,7 @@ interface ActionInterface * * Note: This function directly outputs data to the user. * - * @return void + * @return ?string */ public function execute(array $request); } diff --git a/lib/RssBridge.php b/lib/RssBridge.php index 3ff118f7..904a1cd4 100644 --- a/lib/RssBridge.php +++ b/lib/RssBridge.php @@ -60,6 +60,7 @@ final class RssBridge } }); + // Consider: ini_set('error_reporting', E_ALL & ~E_DEPRECATED); date_default_timezone_set(Configuration::getConfig('system', 'timezone')); $authenticationMiddleware = new AuthenticationMiddleware(); @@ -73,9 +74,22 @@ final class RssBridge } } - $actionFactory = new ActionFactory(); - $action = $request['action'] ?? 'Frontpage'; - $action = $actionFactory->create($action); - $action->execute($request); + $actionName = $request['action'] ?? 'Frontpage'; + $actionName = strtolower($actionName) . 'Action'; + $actionName = implode(array_map('ucfirst', explode('-', $actionName))); + + $filePath = __DIR__ . '/../actions/' . $actionName . '.php'; + if (!file_exists($filePath)) { + throw new \Exception(sprintf('Invalid action: %s', $actionName)); + } + $className = '\\' . $actionName; + $action = new $className(); + + $response = $action->execute($request); + if (is_string($response)) { + print $response; + } elseif ($response instanceof Response) { + $response->send(); + } } } diff --git a/lib/contents.php b/lib/contents.php index 33f20cc2..c339d3ca 100644 --- a/lib/contents.php +++ b/lib/contents.php @@ -44,6 +44,38 @@ final class Response '504' => 'Gateway Timeout', '505' => 'HTTP Version Not Supported' ]; + private string $body; + private int $code; + private array $headers; + + public function __construct( + string $body = '', + int $code = 200, + array $headers = [] + ) { + $this->body = $body; + $this->code = $code; + $this->headers = $headers; + } + + public function getBody() + { + return $this->body; + } + + public function getHeaders() + { + return $this->headers; + } + + public function send(): void + { + http_response_code($this->code); + foreach ($this->headers as $name => $value) { + header(sprintf('%s: %s', $name, $value)); + } + print $this->body; + } } /** diff --git a/static/style.css b/static/style.css index b5f3c00b..786e1526 100644 --- a/static/style.css +++ b/static/style.css @@ -78,12 +78,12 @@ header > div.logo { margin: auto; } -header > section.warning { +section.warning { background-color: #ffc600; color: #5f5f5f; } -header > section.critical-warning { +section.critical-warning { background-color: #cf3e3e; font-weight: bold; color: white; diff --git a/templates/frontpage.html.php b/templates/frontpage.html.php new file mode 100644 index 00000000..4560dc28 --- /dev/null +++ b/templates/frontpage.html.php @@ -0,0 +1,62 @@ + + + + + +
+ Warning : Debug mode is active from any location, + make sure only you can access RSS-Bridge. +
+ +
+ Warning : Debug mode is active from your IP address, + your requests will bypass the cache. +
+ + + +
+

Search

+ +
+ + + +
+ RSS-Bridge ~ Public Domain
+

+ + / active bridges.
+ + + + + + +
+ + + + +
+ + + + + + You may email the administrator of this RSS-Bridge instance at + + + +
diff --git a/tests/Actions/ListActionTest.php b/tests/Actions/ListActionTest.php index f3d06db6..4373be76 100644 --- a/tests/Actions/ListActionTest.php +++ b/tests/Actions/ListActionTest.php @@ -2,36 +2,26 @@ namespace RssBridge\Tests\Actions; -use ActionFactory; use BridgeFactory; use PHPUnit\Framework\TestCase; class ListActionTest extends TestCase { - private $data; - - /** - * @runInSeparateProcess - * @requires function xdebug_get_headers - */ public function testHeaders() { - $this->initAction(); - - $this->assertContains( - 'Content-Type: application/json', - xdebug_get_headers() - ); + $action = new \ListAction(); + $response = $action->execute([]); + $headers = $response->getHeaders(); + $this->assertSame($headers['Content-Type'], 'application/json'); } - /** - * @runInSeparateProcess - */ public function testOutput() { - $this->initAction(); + $action = new \ListAction(); + $response = $action->execute([]); + $data = $response->getBody(); - $items = json_decode($this->data, true); + $items = json_decode($data, true); $this->assertNotNull($items, 'invalid JSON output: ' . json_last_error_msg()); @@ -77,17 +67,4 @@ class ListActionTest extends TestCase $this->assertContains($bridge['status'], $allowedStatus, 'Invalid status value'); } } - - private function initAction() - { - $actionFactory = new ActionFactory(); - - $action = $actionFactory->create('list'); - - ob_start(); - $action->execute([]); - $this->data = ob_get_contents(); - ob_clean(); - ob_end_flush(); - } }