add language middleware that sets the system's language from a given...

Closes #1568

Merge request studip/studip!993

composer.json

@@ -48,6 +48,7 @@
         "php-di/php-di": "6.3.4",
         "symfony/console": "5.3.6",
         "symfony/process": "^5.4",
-        "jumbojett/openid-connect-php": "^0.9.2"
+        "jumbojett/openid-connect-php": "^0.9.2",
+        "willdurand/negotiation": "^3.1"
     }
 }

composer.lock

@@ -4,7 +4,7 @@
         "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies",
         "This file is @generated automatically"
     ],
-    "content-hash": "2fa6a856bbe442274874aeabe26f054b",
+    "content-hash": "960497e77c90d28e8581a7cd673f884d",
     "packages": [
         {
             "name": "algo26-matthias/idna-convert",
@@ -3636,6 +3636,62 @@
                 }
             ],
             "time": "2020-10-01T07:46:32+00:00"
+        },
+        {
+            "name": "willdurand/negotiation",
+            "version": "3.1.0",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/willdurand/Negotiation.git",
+                "reference": "68e9ea0553ef6e2ee8db5c1d98829f111e623ec2"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/willdurand/Negotiation/zipball/68e9ea0553ef6e2ee8db5c1d98829f111e623ec2",
+                "reference": "68e9ea0553ef6e2ee8db5c1d98829f111e623ec2",
+                "shasum": ""
+            },
+            "require": {
+                "php": ">=7.1.0"
+            },
+            "require-dev": {
+                "symfony/phpunit-bridge": "^5.0"
+            },
+            "type": "library",
+            "extra": {
+                "branch-alias": {
+                    "dev-master": "3.0-dev"
+                }
+            },
+            "autoload": {
+                "psr-4": {
+                    "Negotiation\\": "src/Negotiation"
+                }
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "MIT"
+            ],
+            "authors": [
+                {
+                    "name": "William Durand",
+                    "email": "will+git@drnd.me"
+                }
+            ],
+            "description": "Content Negotiation tools for PHP provided as a standalone library.",
+            "homepage": "http://williamdurand.fr/Negotiation/",
+            "keywords": [
+                "accept",
+                "content",
+                "format",
+                "header",
+                "negotiation"
+            ],
+            "support": {
+                "issues": "https://github.com/willdurand/Negotiation/issues",
+                "source": "https://github.com/willdurand/Negotiation/tree/3.1.0"
+            },
+            "time": "2022-01-30T20:08:53+00:00"
         }
     ],
     "packages-dev": [
@@ -6728,5 +6784,5 @@
         "ext-mbstring": "*"
     },
     "platform-dev": [],
-    "plugin-api-version": "2.1.0"
+    "plugin-api-version": "2.3.0"
 }

lib/classes/JsonApi/Middlewares/Language.php

+<?php
+namespace JsonApi\Middlewares;
+
+use Negotiation\LanguageNegotiator;
+use Psr\Http\Message\ResponseInterface;
+use Psr\Http\Message\ServerRequestInterface as Request;
+use Psr\Http\Server\RequestHandlerInterface as RequestHandler;
+
+/**
+ * This class defines a middleware that tries to set the language for Stud.IP
+ * by analyzing the HTTP header "Accept-Language".
+ *
+ * @author Jan-Hendrik Willms <tleilax+studip@gmail.com>
+ */
+class Language
+{
+    /**
+     * @param Request        $request das Request-Objekt
+     * @param RequestHandler $handler der PSR-15 Request Handler
+     *
+     * @return ResponseInterface das neue Response-Objekt
+     */
+    public function __invoke(Request $request, RequestHandler $handler)
+    {
+        $language = $this->detectValidLanguageFromRequest($request);
+
+        // Set language if detected
+        if ($language) {
+            $_SESSION['_language'] = $language;
+            setTempLanguage(false, $language);
+        }
+
+        return $handler->handle($request);
+    }
+
+    /**
+     * Tries to detect a valid installed language from the request.
+     *
+     * @param Request $request
+     * @return string|null The detected language (if any)
+     */
+    private function detectValidLanguageFromRequest(Request $request): ?string
+    {
+        if (!$request->hasHeader('Accept-Language')) {
+            return null;
+        }
+
+        $negotiator = new LanguageNegotiator();
+        $best_language = $negotiator->getBest(
+            $request->getHeaderLine('Accept-Language'),
+            $this->getStudIPLanguagePriorities()
+        );
+
+        if (!$best_language) {
+            return null;
+        }
+
+        return $this->normalizeLanguageForStudIP($best_language->getType());
+    }
+
+    /**
+     * Returns a list of the normalized installed languages for the Stud.IP
+     * system.
+     *
+     * @return array
+     */
+    private function getStudIPLanguagePriorities(): array
+    {
+        return array_map(
+            function ($language) {
+                return str_replace('_', '-', $language);
+            },
+            array_keys($GLOBALS['INSTALLED_LANGUAGES'])
+        );
+    }
+
+    /**
+     * Normalizes the given language string (<language>-<variety>, e.g. de-de)
+     * for Stud.IP (e.g. de_DE).
+     *
+     * @param string $language
+     * @return string
+     */
+    private function normalizeLanguageForStudIP(string $language): string
+    {
+        $tags = explode('-', $language);
+        return $tags[0] . '_' . strtoupper($tags[1]);
+    }
+}

lib/classes/JsonApi/middleware.php

@@ -26,6 +26,9 @@ return function (App $app) {
     // Add Routing Middleware
     $app->addRoutingMiddleware();
 
+    // Add language middleware
+    $app->add(new Middlewares\Language());
+
     /** @var array|null */
     $corsOrigin = \Config::get()->getValue('JSONAPI_CORS_ORIGIN');
     if (is_array($corsOrigin) && count($corsOrigin)) {