App\Application\Middleware\PhpViewMiddleware

Complexity

Total Complexity

6

Size/Duplication

Total Lines	68
Duplicated Lines	0 %

Test Coverage

Coverage

88.89%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	checkUserListAuthorization()	0	8	2
A	__construct()	0	11	1
A	process()	0	32	3

<?php

namespace App\Application\Middleware;

use App\Domain\User\Service\Authorization\UserPermissionVerifier;
use App\Infrastructure\Utility\JsImportCacheBuster;
use App\Infrastructure\Utility\Settings;
use Cake\Database\Exception\DatabaseException;
use Odan\Session\SessionInterface;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Server\MiddlewareInterface;
use Psr\Http\Server\RequestHandlerInterface;
use Slim\App;
use Slim\Interfaces\RouteParserInterface;
use Slim\Routing\RouteContext;
use Slim\Views\PhpRenderer;

/**
 * Adds attributes to the PhpRenderer and updates js imports with version number.
 * Documentation: https://github.com/samuelgfeller/slim-example-project/wiki/Template-rendering.
 */
final class PhpViewMiddleware implements MiddlewareInterface
{
    /** @var array<string, mixed> */
    private array $publicSettings;
    /** @var array<string, mixed> */
    private array $deploymentSettings;

    public function __construct(
        private readonly App $app,
        private readonly PhpRenderer $phpRenderer,
        private readonly SessionInterface $session,
        private readonly JsImportCacheBuster $jsImportCacheBuster,
        Settings $settings,
        private readonly UserPermissionVerifier $userPermissionVerifier,
        private readonly RouteParserInterface $routeParser
    ) {
        $this->publicSettings = $settings->get('public');
        $this->deploymentSettings = $settings->get('deployment');
    }

    public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
    {
        $loggedInUserId = $this->session->get('user_id');
        // The following has to work even with no connection to mysql to display the error page (layout needs those attr)
        $this->phpRenderer->setAttributes([
            'version' => $this->deploymentSettings['version'],
            'uri' => $request->getUri(),
            'basePath' => $this->app->getBasePath(),
            'route' => $this->routeParser,
            'currRouteName' => RouteContext::fromRequest($request)->getRoute()?->getName(),
            'flash' => $this->session->getFlash(),
            // Used for public values used by view like company email address
            'config' => $this->publicSettings,
            'authenticatedUser' => $loggedInUserId,
        ]);

        // Check and set user list authorization for "users" nav point
        if ($loggedInUserId) {
            // Check if the authenticated user is allowed to see user list
            // Add the user list authorization as an attribute to the PhpRenderer
            $this->phpRenderer->addAttribute(
                'userListAuthorization',
                $this->checkUserListAuthorization($loggedInUserId)
            );
        }

        // Add version number to js imports
        if ($this->deploymentSettings['update_js_imports_version'] === true) {
            $this->jsImportCacheBuster->addVersionToJsImports();
        }

        return $handler->handle($request);
    }

    /**
     * Check if the user is allowed to see the user list.
     *
     * @param int $loggedInUserId
     * @return bool
     */
    private function checkUserListAuthorization(int $loggedInUserId): bool
    {
        try {
            // If the authenticated user is allowed to read another user (id + 1), the user list can be displayed
            return $this->userPermissionVerifier->isGrantedToRead($loggedInUserId + 1, false);
        } catch (DatabaseException $databaseException) {
            // Mysql connection not working. Caught here to prevent error page from crashing
            return false;
        }
    }
}