[WIP] Internationalization

.gitignore

@@ -232,6 +232,7 @@ config/*
 !config/nginx.conf
 !config/php-fpm.conf
 !config/php.ini
+docker-compose.*
 
 ######################
 ## VisualStudioCode ##

CONTRIBUTORS.md

@@ -144,6 +144,7 @@
 * [Niehztog](https://github.com/Niehztog)
 * [NikNikYkt](https://github.com/NikNikYkt)
 * [Nono-m0le](https://github.com/Nono-m0le)
+* [NotsoanoNimus](https://github.com/NotsoanoNimus)
 * [obsiwitch](https://github.com/obsiwitch)
 * [Ololbu](https://github.com/Ololbu)
 * [ORelio](https://github.com/ORelio)

README.md

@@ -53,9 +53,10 @@ Requires minimum PHP 7.4.
 
 ### How to install on traditional shared web hosting
 
-RSS-Bridge can basically be unzipped in a web folder. Should be working instantly.
+RSS-Bridge can basically be unzipped into a web folder. Should be working instantly.
 
-Latest zip as of Sep 2023: https://github.com/RSS-Bridge/rss-bridge/archive/refs/tags/2023-09-24.zip
+Latest zip:
+https://github.com/RSS-Bridge/rss-bridge/archive/refs/heads/master.zip (2MB)
 
 ### How to install on Debian 12 (nginx + php-fpm)
 
@@ -66,7 +67,7 @@ timedatectl set-timezone Europe/Oslo
 
 apt install git nginx php8.2-fpm php-mbstring php-simplexml php-curl php-intl
 
-# Create a new user account
+# Create a user account
 useradd --shell /bin/bash --create-home rss-bridge
 
 cd /var/www
@@ -101,7 +102,10 @@ Nginx config:
 
 server {
     listen 80;
+
+    # TODO: change to your own server name
     server_name example.com;
+
     access_log /var/log/nginx/rss-bridge.access.log;
     error_log /var/log/nginx/rss-bridge.error.log;
     log_not_found off;
@@ -150,8 +154,11 @@ listen = /run/php/rss-bridge.sock
 listen.owner = www-data
 listen.group = www-data
 
+# Create 10 workers standing by to serve requests
 pm = static
 pm.max_children = 10
+
+# Respawn worker after 500 requests (workaround for memory leaks etc.) 
 pm.max_requests = 500
 ```
 
@@ -179,7 +186,7 @@ Install the latest release.
 
 ```shell
 cd /var/www
-composer create-project -v --no-dev rss-bridge/rss-bridge
+composer create-project -v --no-dev --no-scripts rss-bridge/rss-bridge
 ```
 
 ### How to install with Caddy
@@ -192,8 +199,16 @@ Install by downloading the docker image from Docker Hub:
 
 ```bash
 # Create container
-docker create --name=rss-bridge --publish 3000:80 rssbridge/rss-bridge
+docker create --name=rss-bridge --publish 3000:80 --volume $(pwd)/config:/config rssbridge/rss-bridge
+```
+
+You can put custom `config.ini.php` and bridges into `./config`.
+
+**You must restart container for custom changes to take effect.**
 
+See `docker-entrypoint.sh` for details.
+
+```bash
 # Start container
 docker start rss-bridge
 ```
@@ -207,30 +222,29 @@ Browse http://localhost:3000/
 docker build -t rss-bridge .
 
 # Create container
-docker create --name rss-bridge --publish 3000:80 rss-bridge
+docker create --name rss-bridge --publish 3000:80 --volume $(pwd)/config:/config rss-bridge
+```
+
+You can put custom `config.ini.php` and bridges into `./config`.
+
+**You must restart container for custom changes to take effect.**
 
+See `docker-entrypoint.sh` for details.
+
+```bash
 # Start container
 docker start rss-bridge
 ```
 
 Browse http://localhost:3000/
 
-### Install with docker-compose
-
-Create a `docker-compose.yml` file locally with with the following content:
-```yml
-version: '2'
-services:
-  rss-bridge:
-    image: rssbridge/rss-bridge:latest
-    volumes:
-      - </local/custom/path>:/config
-    ports:
-      - 3000:80
-    restart: unless-stopped
-```
+### Install with docker-compose (using Docker Hub)
+
+You can put custom `config.ini.php` and bridges into `./config`.
+
+**You must restart container for custom changes to take effect.**
 
-Then launch with `docker-compose`:
+See `docker-entrypoint.sh` for details.
 
 ```bash
 docker-compose up
@@ -418,7 +432,16 @@ See `formats/PlaintextFormat.php` for an example.
 
 These commands require that you have installed the dev dependencies in `composer.json`.
 
+Run all tests:
+
     ./vendor/bin/phpunit
+
+Run a single test class:
+
+    ./vendor/bin/phpunit --filter UrlTest
+
+Run linter:
+
     ./vendor/bin/phpcs --standard=phpcs.xml --warning-severity=0 --extensions=php -p ./
 
 https://github.com/squizlabs/PHP_CodeSniffer/wiki

actions/ConnectivityAction.php

@@ -19,27 +19,27 @@ public function __construct()
         $this->bridgeFactory = new BridgeFactory();
     }
 
-    public function execute(Request $request)
+    public function __invoke(Request $request): Response
     {
         if (!Debug::isEnabled()) {
-            return new Response('This action is only available in debug mode!', 403);
+            return new Response(xlat('errors:actions:display:debug_required'), 403);
         }
 
         $bridgeName = $request->get('bridge');
         if (!$bridgeName) {
-            return render_template('connectivity.html.php');
+            return new Response(render_template('connectivity.html.php'));
         }
         $bridgeClassName = $this->bridgeFactory->createBridgeClassName($bridgeName);
         if (!$bridgeClassName) {
-            return new Response('Bridge not found', 404);
+            return new Response(xlat('errors:general:not_found'), 404);
         }
         return $this->reportBridgeConnectivity($bridgeClassName);
     }
 
     private function reportBridgeConnectivity($bridgeClassName)
     {
         if (!$this->bridgeFactory->isEnabled($bridgeClassName)) {
-            throw new \Exception('Bridge is not whitelisted!');
+            throw new \Exception(xlat('errors:general:whitelist'));
         }
 
         $bridge = $this->bridgeFactory->create($bridgeClassName);
@@ -54,8 +54,8 @@ private function reportBridgeConnectivity($bridgeClassName)
         ];
         try {
             $response = getContents($bridge::URI, [], $curl_opts, true);
-            $result['http_code'] = $response['code'];
-            if (in_array($response['code'], [200])) {
+            $result['http_code'] = $response->getCode();
+            if (in_array($result['http_code'], [200])) {
                 $result['successful'] = true;
             }
         } catch (\Exception $e) {

actions/DetectAction.php

@@ -2,16 +2,16 @@
 
 class DetectAction implements ActionInterface
 {
-    public function execute(Request $request)
+    public function __invoke(Request $request): Response
     {
         $url = $request->get('url');
         $format = $request->get('format');
 
         if (!$url) {
-            return new Response(render(__DIR__ . '/../templates/error.html.php', ['message' => 'You must specify a url']));
+            return new Response(render(__DIR__ . '/../templates/error.html.php', ['message' => xlat('errors:general:specify_url')]));
         }
         if (!$format) {
-            return new Response(render(__DIR__ . '/../templates/error.html.php', ['message' => 'You must specify a format']));
+            return new Response(render(__DIR__ . '/../templates/error.html.php', ['message' => xlat('errors:general:specify_format')]));
         }
 
         $bridgeFactory = new BridgeFactory();
@@ -39,7 +39,7 @@ public function execute(Request $request)
         }
 
         return new Response(render(__DIR__ . '/../templates/error.html.php', [
-            'message' => 'No bridge found for given URL: ' . $url,
+            'message' => xlat('errors:general:not_found_for_url') . ': ' . $url,
         ]));
     }
 }

actions/DisplayAction.php

@@ -11,7 +11,7 @@ public function __construct()
         $this->logger = RssBridge::getLogger();
     }
 
-    public function execute(Request $request)
+    public function __invoke(Request $request): Response
     {
         $bridgeName = $request->get('bridge');
         $format = $request->get('format');
@@ -32,23 +32,23 @@ public function execute(Request $request)
                     return new Response('', 304, ['last-modified' => $modificationTimeGMT . 'GMT']);
                 }
             }
-            return $cachedResponse->withHeader('rss-bridge', 'This is a cached response');
+            return $cachedResponse->withHeader('rss-bridge', xlat('errors:actions:display:cached'));
         }
 
         if (!$bridgeName) {
-            return new Response(render(__DIR__ . '/../templates/error.html.php', ['message' => 'Missing bridge parameter']), 400);
+            return new Response(render(__DIR__ . '/../templates/error.html.php', ['message' => xlat('errors:general:missing_parameter')]), 400);
         }
         $bridgeFactory = new BridgeFactory();
         $bridgeClassName = $bridgeFactory->createBridgeClassName($bridgeName);
         if (!$bridgeClassName) {
-            return new Response(render(__DIR__ . '/../templates/error.html.php', ['message' => 'Bridge not found']), 404);
+            return new Response(render(__DIR__ . '/../templates/error.html.php', ['message' => xlat('errors:general:not_found')]), 404);
         }
 
         if (!$format) {
-            return new Response(render(__DIR__ . '/../templates/error.html.php', ['message' => 'You must specify a format']), 400);
+            return new Response(render(__DIR__ . '/../templates/error.html.php', ['message' => xlat('errors:general:format')]), 400);
         }
         if (!$bridgeFactory->isEnabled($bridgeClassName)) {
-            return new Response(render(__DIR__ . '/../templates/error.html.php', ['message' => 'This bridge is not whitelisted']), 400);
+            return new Response(render(__DIR__ . '/../templates/error.html.php', ['message' => xlat('errors:general:whitelist')]), 400);
         }
 
         if (
@@ -145,7 +145,7 @@ private function createResponse(Request $request, BridgeAbstract $bridge, string
             if ($errorCount >= $reportLimit) {
                 if ($errorOutput === 'feed') {
                     // Render the exception as a feed item
-                    $items[] = $this->createFeedItemFromException($e, $bridge);
+                    $items = [$this->createFeedItemFromException($e, $bridge)];
                 } elseif ($errorOutput === 'http') {
                     return new Response(render(__DIR__ . '/../templates/exception.html.php', ['e' => $e]), 500);
                 } elseif ($errorOutput === 'none') {
@@ -174,7 +174,7 @@ private function createFeedItemFromException($e, BridgeAbstract $bridge): FeedIt
 
         // Create a unique identifier every 24 hours
         $uniqueIdentifier = urlencode((int)(time() / 86400));
-        $title = sprintf('Bridge returned error %s! (%s)', $e->getCode(), $uniqueIdentifier);
+        $title = sprintf('%s %s! (%s)', xlat('errors:actions:display:error'), $e->getCode(), $uniqueIdentifier);
         $item->setTitle($title);
         $item->setURI(get_current_url());
         $item->setTimestamp(time());
@@ -213,22 +213,33 @@ private function logBridgeError($bridgeName, $code)
         return $report['count'];
     }
 
-    private static function createGithubIssueUrl($bridge, $e, string $message): string
+    private static function createGithubIssueUrl(BridgeAbstract $bridge, \Exception $e, string $message): string
     {
-        return sprintf('https://github.com/RSS-Bridge/rss-bridge/issues/new?%s', http_build_query([
-            'title' => sprintf('%s failed with error %s', $bridge->getName(), $e->getCode()),
+        $maintainer = $bridge->getMaintainer();
+        if (str_contains($maintainer, ',')) {
+            $maintainers = explode(',', $maintainer);
+        } else {
+            $maintainers = [$maintainer];
+        }
+        $maintainers = array_map('trim', $maintainers);
+
+        $query = [
+            'title' => $bridge->getName() . ' failed with: ' . $e->getMessage(),
             'body' => sprintf(
-                "```\n%s\n\n%s\n\nQuery string: %s\nVersion: %s\nOs: %s\nPHP version: %s\n```",
+                "```\n%s\n\n%s\n\nQuery string: %s\nVersion: %s\nOs: %s\nPHP version: %s\n```\nMaintainer: @%s",
                 $message,
                 implode("\n", trace_to_call_points(trace_from_exception($e))),
                 $_SERVER['QUERY_STRING'] ?? '',
                 Configuration::getVersion(),
                 PHP_OS_FAMILY,
-                phpversion() ?: 'Unknown'
+                phpversion() ?: 'Unknown',
+                implode(', @', $maintainers),
             ),
             'labels' => 'Bridge-Broken',
-            'assignee' => $bridge->getMaintainer(),
-        ]));
+            'assignee' => $maintainer[0],
+        ];
+
+        return 'https://github.com/RSS-Bridge/rss-bridge/issues/new?' . http_build_query($query);
     }
 
     private static function createGithubSearchUrl($bridge): string

actions/FindfeedAction.php

@@ -7,16 +7,16 @@
  */
 class FindfeedAction implements ActionInterface
 {
-    public function execute(Request $request)
+    public function __invoke(Request $request): Response
     {
         $url = $request->get('url');
         $format = $request->get('format');
 
         if (!$url) {
-            return new Response('You must specify a url', 400);
+            return new Response(xlat('errors:general:specify_url'), 400);
         }
         if (!$format) {
-            return new Response('You must specify a format', 400);
+            return new Response(xlat('errors:general:specify_format'), 400);
         }
 
         $bridgeFactory = new BridgeFactory();
@@ -69,7 +69,7 @@ public function execute(Request $request)
             $results[] = $content;
         }
         if ($results === []) {
-            return new Response(Json::encode(['message' => 'No bridge found for given url']), 404, ['content-type' => 'application/json']);
+            return new Response(Json::encode(['message' => xlat('errors:general:not_found_for_url')]), 404, ['content-type' => 'application/json']);
         }
         return new Response(Json::encode($results), 200, ['content-type' => 'application/json']);
     }
@@ -82,7 +82,7 @@ private function getParameterName($bridge, $context, $key)
         } else if (isset($bridge::PARAMETERS['global'][$key]['name'])) {
             $name = $bridge::PARAMETERS['global'][$key]['name'];
         } else {
-            $name = 'Variable "' . $key . '" (No name provided)';
+            $name = xlat('errors:actions:findfeed:no_name_var', $key);
         }
         return $name;
     }

actions/FrontpageAction.php

@@ -2,7 +2,7 @@
 
 final class FrontpageAction implements ActionInterface
 {
-    public function execute(Request $request)
+    public function __invoke(Request $request): Response
     {
         $messages = [];
         $activeBridges = 0;
@@ -12,8 +12,8 @@ public function execute(Request $request)
 
         foreach ($bridgeFactory->getMissingEnabledBridges() as $missingEnabledBridge) {
             $messages[] = [
-                'body' => sprintf('Warning : Bridge "%s" not found', $missingEnabledBridge),
-                'level' => 'warning'
+                'body' => xlat('errors:general:not_found_named', $missingEnabledBridge),
+                'level' => 'warning',
             ];
         }
 
@@ -26,13 +26,13 @@ public function execute(Request $request)
         }
 
         // todo: cache this renderered template?
-        return render(__DIR__ . '/../templates/frontpage.html.php', [
+        return new Response(render(__DIR__ . '/../templates/frontpage.html.php', [
             'messages' => $messages,
             'admin_email' => Configuration::getConfig('admin', 'email'),
             'admin_telegram' => Configuration::getConfig('admin', 'telegram'),
             'bridges' => $body,
             'active_bridges' => $activeBridges,
             'total_bridges' => count($bridgeClassNames),
-        ]);
+        ]));
     }
 }