bug #53195 [HttpKernel] Fix default locale is ignored when set_locale_from_accept_language is used (jkobus)

nicolas-grekas · nicolas-grekas · commit 386e23865385 · 2023-12-29T14:50:26.000+01:00
This PR was submitted for the 6.4 branch but it was merged into the 5.4 branch instead. Discussion ---------- [HttpKernel] Fix default locale is ignored when `set_locale_from_accept_language` is used | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Issues | Fix #53086 | License | MIT Fix as discussed in #53086 Commits ------- c626b3a [HttpFoundation][FrameworkBundle] Fix default locale is ignored when set_locale_from_accept_language is used
diff --git a/src/Symfony/Component/HttpKernel/EventListener/LocaleListener.php b/src/Symfony/Component/HttpKernel/EventListener/LocaleListener.php
@@ -68,8 +68,10 @@ private function setLocale(Request $request)
     {
         if ($locale = $request->attributes->get('_locale')) {
             $request->setLocale($locale);
-        } elseif ($this->useAcceptLanguageHeader && $this->enabledLocales && ($preferredLanguage = $request->getPreferredLanguage($this->enabledLocales))) {
-            $request->setLocale($preferredLanguage);
+        } elseif ($this->useAcceptLanguageHeader && $this->enabledLocales) {
+            if ($request->getLanguages() && $preferredLanguage = $request->getPreferredLanguage($this->enabledLocales)) {
+                $request->setLocale($preferredLanguage);
+            }
             $request->attributes->set('_vary_by_language', true);
         }
     }
diff --git a/src/Symfony/Component/HttpKernel/Tests/EventListener/LocaleListenerTest.php b/src/Symfony/Component/HttpKernel/Tests/EventListener/LocaleListenerTest.php
@@ -130,6 +130,28 @@ public function testRequestPreferredLocaleFromAcceptLanguageHeader()
         $this->assertEquals('fr', $request->getLocale());
     }
 
+    public function testRequestDefaultLocaleIfNoAcceptLanguageHeaderIsPresent()
+    {
+        $request = new Request();
+        $listener = new LocaleListener($this->requestStack, 'de', null, true, ['lt', 'de']);
+        $event = $this->getEvent($request);
+
+        $listener->setDefaultLocale($event);
+        $listener->onKernelRequest($event);
+        $this->assertEquals('de', $request->getLocale());
+    }
+
+    public function testRequestVaryByLanguageAttributeIsSetIfUsingAcceptLanguageHeader()
+    {
+        $request = new Request();
+        $listener = new LocaleListener($this->requestStack, 'de', null, true, ['lt', 'de']);
+        $event = $this->getEvent($request);
+
+        $listener->setDefaultLocale($event);
+        $listener->onKernelRequest($event);
+        $this->assertTrue($request->attributes->get('_vary_by_language'));
+    }
+
     public function testRequestSecondPreferredLocaleFromAcceptLanguageHeader()
     {
         $request = Request::create('/');

Original file line number	Diff line number	Diff line change
`@@ -68,8 +68,10 @@ private function setLocale(Request $request)`
`68`	`68`	`{`
`69`	`69`	`if ($locale = $request->attributes->get('_locale')) {`
`70`	`70`	`$request->setLocale($locale);`
`71`		`- } elseif ($this->useAcceptLanguageHeader && $this->enabledLocales && ($preferredLanguage = $request->getPreferredLanguage($this->enabledLocales))) {`
`72`		`- $request->setLocale($preferredLanguage);`
	`71`	`+ } elseif ($this->useAcceptLanguageHeader && $this->enabledLocales) {`
	`72`	`+ if ($request->getLanguages() && $preferredLanguage = $request->getPreferredLanguage($this->enabledLocales)) {`
	`73`	`+ $request->setLocale($preferredLanguage);`
	`74`	`+ }`
`73`	`75`	`$request->attributes->set('_vary_by_language', true);`
`74`	`76`	`}`
`75`	`77`	`}`