Locale::withEnableDetectLocale() - Code Metrics - Inspection of "Increase code coverage & psalm level" - yiisoft/yii-middleware - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#42)

by Rustam

created 2023-03-09 09:37 UTC

Locale::withEnableDetectLocale() A

↳ Parent: Locale

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	3
nc	1
nop	1
dl	0
loc	5
ccs	4
cts	4
cp	1
crap	1
rs	10
c	1
b	0
f	0

<?php

declare(strict_types=1);

namespace Yiisoft\Yii\Middleware;

use DateInterval;
use Psr\Http\Message\ResponseFactoryInterface;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Server\MiddlewareInterface;
use Psr\Http\Server\RequestHandlerInterface;
use Psr\Log\LoggerInterface;
use Yiisoft\Aliases\Aliases;
use Yiisoft\Cookies\Cookie;
use Yiisoft\Http\Header;
use Yiisoft\Http\Method;
use Yiisoft\Http\Status;
use Yiisoft\Router\UrlGeneratorInterface;
use Yiisoft\Session\SessionInterface;
use Yiisoft\Strings\WildcardPattern;
use Yiisoft\Translator\TranslatorInterface;
use Yiisoft\Yii\Middleware\Exception\InvalidLocalesFormatException;

final class Locale implements MiddlewareInterface
{
    private const DEFAULT_LOCALE = 'en';
    private const DEFAULT_LOCALE_NAME = '_language';

    private bool $enableSaveLocale = true;
    private bool $enableDetectLocale = false;
    private string $defaultLocale = self::DEFAULT_LOCALE;
    private string $queryParameterName = self::DEFAULT_LOCALE_NAME;
    private string $sessionName = self::DEFAULT_LOCALE_NAME;
    private ?DateInterval $cookieDuration;

    /**
     * @param string[] $ignoredRequests
     */
    public function __construct(
        private TranslatorInterface $translator,
        private UrlGeneratorInterface $urlGenerator,
        private SessionInterface $session,
        private Aliases $aliases,
        private LoggerInterface $logger,
        private ResponseFactoryInterface $responseFactory,
        private array $locales = [],
        private array $ignoredRequests = [],
        private bool $cookieSecure = false,
        private string $baseUrlAlias = '@baseUrl',
    ) {
        $this->cookieDuration = new DateInterval('P30D');
    }

    public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
    {
        if ($this->locales === []) {
            return $handler->handle($request);
        }

        $this->checkLocales();

        $uri = $request->getUri();
        $path = $uri->getPath();
        $query = $uri->getQuery();

        $locale = $this->getLocaleFromPath($path);

        if ($locale !== null) {
            $this->translator->setLocale($locale);
            $this->urlGenerator->setDefaultArgument($this->queryParameterName, $locale);

            $response = $handler->handle($request);
            $newPath = null;
            if ($this->isDefaultLocale($locale) && $request->getMethod() === Method::GET) {
                $length = strlen($locale);
                $newPath = substr($path, $length + 1);
            }
            return $this->applyLocaleFromPath($locale, $response, $query, $newPath);
        }
        if ($this->enableSaveLocale) {
            $locale = $this->getLocaleFromRequest($request);
        }
        if ($locale === null && $this->enableDetectLocale) {
            $locale = $this->detectLocale($request);
        }
        if ($locale === null || $this->isDefaultLocale($locale) || $this->isRequestIgnored($request)) {
            $this->urlGenerator->setDefaultArgument($this->queryParameterName, null);
            $request = $request->withUri($uri->withPath('/' . $this->defaultLocale . $path));
            return $handler->handle($request);
        }

        $this->translator->setLocale($locale);
        $this->urlGenerator->setDefaultArgument($this->queryParameterName, $locale);

        if ($request->getMethod() === Method::GET) {
            $location = rtrim($this->aliases->get($this->baseUrlAlias), '/') . '/'
                . $locale . $path . ($query !== '' ? '?' . $query : '');
            return $this->responseFactory
                ->createResponse(Status::FOUND)
                ->withHeader(Header::LOCATION, $location);
        }


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

    private function applyLocaleFromPath(
        string $locale,
        ResponseInterface $response,
        string $query,
        ?string $newPath = null,
    ): ResponseInterface {
        if ($newPath === '') {
            $newPath = '/';
        }

        if ($newPath !== null) {
            $location = rtrim($this->aliases->get($this->baseUrlAlias), '/')
                . $newPath . ($query !== '' ? '?' . $query : '');
            $response = $this->responseFactory
                ->createResponse(Status::FOUND)
                ->withHeader(Header::LOCATION, $location);
        }
        if ($this->enableSaveLocale) {
            $response = $this->saveLocale($locale, $response);
        }
        return $response;
    }

    private function getLocaleFromPath(string $path): ?string
    {
        $parts = [];
        /**
         * @var string $code
         * @var string $locale
         */
        foreach ($this->locales as $code => $locale) {
            $parts[] = $code;
            $parts[] = $locale;
        }

        $pattern = implode('|', $parts);
        if (preg_match("#^/($pattern)\b(/?)#i", $path, $matches)) {
            $matchedLocale = $matches[1];
            $locale = $this->parseLocale($matchedLocale);
            if (isset($this->locales[$locale])) {
                $this->logger->debug(sprintf("Locale '%s' found in URL", $locale));
                return $locale;
            }
        }
        return null;
    }

    private function getLocaleFromRequest(ServerRequestInterface $request): ?string
    {
        /** @var array<string, string> $cookies */
        $cookies = $request->getCookieParams();
        if (isset($cookies[$this->sessionName])) {
            $this->logger->debug(sprintf("Locale '%s' found in cookies", $cookies[$this->sessionName]));
            return $this->parseLocale($cookies[$this->sessionName]);
        }
        /** @var array<string, string> $queryParameters */
        $queryParameters = $request->getQueryParams();
        if (isset($queryParameters[$this->queryParameterName])) {
            $this->logger->debug(
                sprintf("Locale '%s' found in query string", $queryParameters[$this->queryParameterName])
            );
            return $this->parseLocale($queryParameters[$this->queryParameterName]);
        }
        return null;
    }

    private function isDefaultLocale(string $locale): bool
    {
        return $locale === $this->defaultLocale || $this->locales[$locale] === $this->defaultLocale;
    }

    private function detectLocale(ServerRequestInterface $request): ?string
    {
        foreach ($request->getHeader(Header::ACCEPT_LANGUAGE) as $language) {
            return $this->parseLocale($language);
        }
        return null;
    }

    private function saveLocale(string $locale, ResponseInterface $response): ResponseInterface
    {
        $this->logger->debug('Saving found locale to cookies');
        $this->session->set($this->sessionName, $locale);
        $cookie = new Cookie(name: $this->sessionName, value: $locale, secure: $this->cookieSecure);
        if ($this->cookieDuration !== null) {
            $cookie = $cookie->withMaxAge($this->cookieDuration);
        }
        return $cookie->addToResponse($response);
    }


    private function parseLocale(string $locale): string
    {
        if (str_contains($locale, '-')) {
            [$locale] = explode('-', $locale, 2);
        } elseif (str_contains($locale, '_')) {
            [$locale] = explode('_', $locale, 2);
        }

        return $locale;
    }

    private function isRequestIgnored(ServerRequestInterface $request): bool
    {
        foreach ($this->ignoredRequests as $ignoredRequest) {
            if ((new WildcardPattern($ignoredRequest))->match($request->getUri()->getPath())) {
                return true;
            }
        }
        return false;
    }

    /**
     * @throws InvalidLocalesFormatException
     */
    private function checkLocales(): void
    {
        foreach ($this->locales as $code => $locale) {
            if (!is_string($code) || !is_string($locale)) {
                throw new InvalidLocalesFormatException();
            }
        }
    }

    public function withLocales(array $locales): self
    {
        $new = clone $this;
        $new->locales = $locales;
        return $new;
    }

    public function withDefaultLocale(string $defaultLocale): self
    {
        $new = clone $this;
        $new->defaultLocale = $defaultLocale;
        return $new;
    }

    public function withQueryParameterName(string $queryParameterName): self
    {
        $new = clone $this;
        $new->queryParameterName = $queryParameterName;
        return $new;
    }

    public function withSessionName(string $sessionName): self
    {
        $new = clone $this;
        $new->sessionName = $sessionName;
        return $new;
    }

    public function withEnableSaveLocale(bool $enableSaveLocale): self
    {
        $new = clone $this;
        $new->enableSaveLocale = $enableSaveLocale;
        return $new;
    }

    public function withEnableDetectLocale(bool $enableDetectLocale): self
    {
        $new = clone $this;
        $new->enableDetectLocale = $enableDetectLocale;
        return $new;
    }

    /**
     * @param string[] $ignoredRequests
     *
     * @return $this
     */
    public function withIgnoredRequests(array $ignoredRequests): self
    {
        $new = clone $this;
        $new->ignoredRequests = $ignoredRequests;
        return $new;
    }

    public function withCookieSecure(bool $secure): self
    {
        $new = clone $this;
        $new->cookieSecure = $secure;
        return $new;
    }

    public function withBaseUrlAlias(string $baseUrlAlias): self
    {
        $new = clone $this;
        $new->baseUrlAlias = $baseUrlAlias;
        return $new;
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Yiisoft\Yii\Middleware;
6
7		use DateInterval;
8		use Psr\Http\Message\ResponseFactoryInterface;
9		use Psr\Http\Message\ResponseInterface;
10		use Psr\Http\Message\ServerRequestInterface;
11		use Psr\Http\Server\MiddlewareInterface;
12		use Psr\Http\Server\RequestHandlerInterface;
13		use Psr\Log\LoggerInterface;
14		use Yiisoft\Aliases\Aliases;
15		use Yiisoft\Cookies\Cookie;
16		use Yiisoft\Http\Header;
17		use Yiisoft\Http\Method;
18		use Yiisoft\Http\Status;
19		use Yiisoft\Router\UrlGeneratorInterface;
20		use Yiisoft\Session\SessionInterface;
21		use Yiisoft\Strings\WildcardPattern;
22		use Yiisoft\Translator\TranslatorInterface;
23		use Yiisoft\Yii\Middleware\Exception\InvalidLocalesFormatException;
24
25		final class Locale implements MiddlewareInterface
26		{
27		private const DEFAULT_LOCALE = 'en';
28		private const DEFAULT_LOCALE_NAME = '_language';
29
30		private bool $enableSaveLocale = true;
31		private bool $enableDetectLocale = false;
32		private string $defaultLocale = self::DEFAULT_LOCALE;
33		private string $queryParameterName = self::DEFAULT_LOCALE_NAME;
34		private string $sessionName = self::DEFAULT_LOCALE_NAME;
35		private ?DateInterval $cookieDuration;
36
37		/**
38		* @param string[] $ignoredRequests
39		*/
40	18	public function __construct(
41		private TranslatorInterface $translator,
42		private UrlGeneratorInterface $urlGenerator,
43		private SessionInterface $session,
44		private Aliases $aliases,
45		private LoggerInterface $logger,
46		private ResponseFactoryInterface $responseFactory,
47		private array $locales = [],
48		private array $ignoredRequests = [],
49		private bool $cookieSecure = false,
50		private string $baseUrlAlias = '@baseUrl',
51		) {
52	18	$this->cookieDuration = new DateInterval('P30D');
53		}
54
55	17	public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
56		{
57	17	if ($this->locales === []) {
58	1	return $handler->handle($request);
59		}
60
61	16	$this->checkLocales();
62
63	15	$uri = $request->getUri();
64	15	$path = $uri->getPath();
65	15	$query = $uri->getQuery();
66
67	15	$locale = $this->getLocaleFromPath($path);
68
69	15	if ($locale !== null) {
70	8	$this->translator->setLocale($locale);
71	8	$this->urlGenerator->setDefaultArgument($this->queryParameterName, $locale);
72
73	8	$response = $handler->handle($request);
74	8	$newPath = null;
75	8	if ($this->isDefaultLocale($locale) && $request->getMethod() === Method::GET) {
76	3	$length = strlen($locale);
77	3	$newPath = substr($path, $length + 1);
78		}
79	8	return $this->applyLocaleFromPath($locale, $response, $query, $newPath);
80		}
81	7	if ($this->enableSaveLocale) {
82	7	$locale = $this->getLocaleFromRequest($request);
83		}
84	7	if ($locale === null && $this->enableDetectLocale) {
85	2	$locale = $this->detectLocale($request);
86		}
87	7	if ($locale === null \|\| $this->isDefaultLocale($locale) \|\| $this->isRequestIgnored($request)) {
88	2	$this->urlGenerator->setDefaultArgument($this->queryParameterName, null);
89	2	$request = $request->withUri($uri->withPath('/' . $this->defaultLocale . $path));
90	2	return $handler->handle($request);
91		}
92
93	5	$this->translator->setLocale($locale);
94	5	$this->urlGenerator->setDefaultArgument($this->queryParameterName, $locale);
95
96	5	if ($request->getMethod() === Method::GET) {
97	4	$location = rtrim($this->aliases->get($this->baseUrlAlias), '/') . '/'
98	4	. $locale . $path . ($query !== '' ? '?' . $query : '');
99	4	return $this->responseFactory
100	4	->createResponse(Status::FOUND)
101	4	->withHeader(Header::LOCATION, $location);
102		}
103
104
105	1	return $handler->handle($request);
106		}
107
108	8	private function applyLocaleFromPath(
109		string $locale,
110		ResponseInterface $response,
111		string $query,
112		?string $newPath = null,
113		): ResponseInterface {
114	8	if ($newPath === '') {
115	1	$newPath = '/';
116		}
117
118	8	if ($newPath !== null) {
119	3	$location = rtrim($this->aliases->get($this->baseUrlAlias), '/')
120	3	. $newPath . ($query !== '' ? '?' . $query : '');
121	3	$response = $this->responseFactory
122	3	->createResponse(Status::FOUND)
123	3	->withHeader(Header::LOCATION, $location);
124		}
125	8	if ($this->enableSaveLocale) {
126	8	$response = $this->saveLocale($locale, $response);
127		}
128	8	return $response;
129		}
130
131	15	private function getLocaleFromPath(string $path): ?string
132		{
133	15	$parts = [];
134		/**
135		* @var string $code
136		* @var string $locale
137		*/
138	15	foreach ($this->locales as $code => $locale) {
139	15	$parts[] = $code;
140	15	$parts[] = $locale;
141		}
142
143	15	$pattern = implode('\|', $parts);
144	15	if (preg_match("#^/($pattern)\b(/?)#i", $path, $matches)) {
145	8	$matchedLocale = $matches[1];
146	8	$locale = $this->parseLocale($matchedLocale);
147	8	if (isset($this->locales[$locale])) {
148	8	$this->logger->debug(sprintf("Locale '%s' found in URL", $locale));
149	8	return $locale;
150		}
151		}
152	7	return null;
153		}
154
155	7	private function getLocaleFromRequest(ServerRequestInterface $request): ?string
156		{
157		/** @var array<string, string> $cookies */
158	7	$cookies = $request->getCookieParams();
159	7	if (isset($cookies[$this->sessionName])) {
160	1	$this->logger->debug(sprintf("Locale '%s' found in cookies", $cookies[$this->sessionName]));
161	1	return $this->parseLocale($cookies[$this->sessionName]);
162		}
163		/** @var array<string, string> $queryParameters */
164	6	$queryParameters = $request->getQueryParams();
165	6	if (isset($queryParameters[$this->queryParameterName])) {
166	4	$this->logger->debug(
167	4	sprintf("Locale '%s' found in query string", $queryParameters[$this->queryParameterName])
168	4	);
169	4	return $this->parseLocale($queryParameters[$this->queryParameterName]);
170		}
171	2	return null;
172		}
173
174	14	private function isDefaultLocale(string $locale): bool
175		{
176	14	return $locale === $this->defaultLocale \|\| $this->locales[$locale] === $this->defaultLocale;
177		}
178
179	2	private function detectLocale(ServerRequestInterface $request): ?string
180		{
181	2	foreach ($request->getHeader(Header::ACCEPT_LANGUAGE) as $language) {
182	1	return $this->parseLocale($language);
183		}
184	1	return null;
185		}
186
187	8	private function saveLocale(string $locale, ResponseInterface $response): ResponseInterface
188		{
189	8	$this->logger->debug('Saving found locale to cookies');
190	8	$this->session->set($this->sessionName, $locale);
191	8	$cookie = new Cookie(name: $this->sessionName, value: $locale, secure: $this->cookieSecure);
192	8	if ($this->cookieDuration !== null) {
193	8	$cookie = $cookie->withMaxAge($this->cookieDuration);
194		}
195	8	return $cookie->addToResponse($response);
196		}
197
198
199	14	private function parseLocale(string $locale): string
200		{
201	14	if (str_contains($locale, '-')) {
202	1	[$locale] = explode('-', $locale, 2);
203	13	} elseif (str_contains($locale, '_')) {
204	1	[$locale] = explode('_', $locale, 2);
205		}
206
207	14	return $locale;
208		}
209
210	6	private function isRequestIgnored(ServerRequestInterface $request): bool
211		{
212	6	foreach ($this->ignoredRequests as $ignoredRequest) {
213	1	if ((new WildcardPattern($ignoredRequest))->match($request->getUri()->getPath())) {
214	1	return true;
215		}
216		}
217	5	return false;
218		}
219
220		/**
221		* @throws InvalidLocalesFormatException
222		*/
223	16	private function checkLocales(): void
224		{
225	16	foreach ($this->locales as $code => $locale) {
226	16	if (!is_string($code) \|\| !is_string($locale)) {
227	1	throw new InvalidLocalesFormatException();
228		}
229		}
230		}
231
232	1	public function withLocales(array $locales): self
233		{
234	1	$new = clone $this;
235	1	$new->locales = $locales;
236	1	return $new;
237		}
238
239	3	public function withDefaultLocale(string $defaultLocale): self
240		{
241	3	$new = clone $this;
242	3	$new->defaultLocale = $defaultLocale;
243	3	return $new;
244		}
245
246	1	public function withQueryParameterName(string $queryParameterName): self
247		{
248	1	$new = clone $this;
249	1	$new->queryParameterName = $queryParameterName;
250	1	return $new;
251		}
252
253	1	public function withSessionName(string $sessionName): self
254		{
255	1	$new = clone $this;
256	1	$new->sessionName = $sessionName;
257	1	return $new;
258		}
259
260	1	public function withEnableSaveLocale(bool $enableSaveLocale): self
261		{
262	1	$new = clone $this;
263	1	$new->enableSaveLocale = $enableSaveLocale;
264	1	return $new;
265		}
266
267	3	public function withEnableDetectLocale(bool $enableDetectLocale): self
268		{
269	3	$new = clone $this;
270	3	$new->enableDetectLocale = $enableDetectLocale;
271	3	return $new;
272		}
273
274		/**
275		* @param string[] $ignoredRequests
276		*
277		* @return $this
278		*/
279	2	public function withIgnoredRequests(array $ignoredRequests): self
280		{
281	2	$new = clone $this;
282	2	$new->ignoredRequests = $ignoredRequests;
283	2	return $new;
284		}
285
286	1	public function withCookieSecure(bool $secure): self
287		{
288	1	$new = clone $this;
289	1	$new->cookieSecure = $secure;
290	1	return $new;
291		}
292
293	1	public function withBaseUrlAlias(string $baseUrlAlias): self
294		{
295	1	$new = clone $this;
296	1	$new->baseUrlAlias = $baseUrlAlias;
297	1	return $new;
298		}
299		}
300

yiisoft / yii-middleware

Pull Request — master (#42)

Locale::withEnableDetectLocale() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like