Move local validation out of Translator and use it to validate locales in FallbackLocaleProvider as well

mpdude · mpdude · commit 7ba97ade6488 · 2022-02-28T08:48:24.000+01:00
diff --git a/src/Symfony/Component/Translation/FallbackLocaleProvider.php b/src/Symfony/Component/Translation/FallbackLocaleProvider.php
@@ -13,7 +13,7 @@
 
 /**
  * Derives fallback locales based on ICU parent locale information, by shortening locale
- * sub tags and ultimately by going through a list of configured fallbacl locales.
+ * sub tags and ultimately by going through a list of configured fallback locales.
  *
  * @author Matthias Pigulla <mp@webfactory.de>
  */
@@ -28,6 +28,10 @@ class FallbackLocaleProvider implements FallbackLocaleProviderInterface
 
     public function setFallbackLocales(array $locales): void
     {
+        foreach ($locales as $locale) {
+            LocaleValidator::assertValidLocale($locale);
+        }
+
         $this->fallbackLocales = $locales;
     }
 
@@ -44,6 +48,8 @@ public function getFallbackLocales(): array
      */
     public function computeFallbackLocales(string $locale): array
     {
+        LocaleValidator::assertValidLocale($locale);
+
         $this->parentLocales ??= json_decode(file_get_contents(__DIR__.'/Resources/data/parents.json'), true);
 
         $originLocale = $locale;
diff --git a/src/Symfony/Component/Translation/FallbackLocaleProviderInterface.php b/src/Symfony/Component/Translation/FallbackLocaleProviderInterface.php
@@ -11,6 +11,8 @@
 
 namespace Symfony\Component\Translation;
 
+use Symfony\Component\Translation\Exception\InvalidArgumentException;
+
 /**
  * For a given locale, implementations provide the list of alternative locales to
  * try when a translation cannot be found.
@@ -19,6 +21,13 @@
  */
 interface FallbackLocaleProviderInterface
 {
+    /**
+     * Sets the fallback locales.
+     *
+     * @param string[] $locales
+     *
+     * @throws InvalidArgumentException If a locale contains invalid characters
+     */
     public function setFallbackLocales(array $locales): void;
 
     /**
@@ -28,6 +37,9 @@ public function setFallbackLocales(array $locales): void;
     public function getFallbackLocales(): array;
 
     /**
+     * For a given locale, this method provides the ordered list of alternative (fallback) locales
+     * to try.
+     *
      * @return string[]
      */
     public function computeFallbackLocales(string $locale): array;
diff --git a/src/Symfony/Component/Translation/LocaleValidator.php b/src/Symfony/Component/Translation/LocaleValidator.php
@@ -0,0 +1,34 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Translation;
+
+use Symfony\Component\Translation\Exception\InvalidArgumentException;
+
+/**
+ * Asserts (syntactical) validity for given locale identifiers.
+ *
+ * @author Matthias Pigulla <mp@webfactory.de>
+ */
+class LocaleValidator
+{
+    /**
+     * Asserts that the locale is valid, throws an Exception if not.
+     *
+     * @throws InvalidArgumentException If the locale contains invalid characters
+     */
+    public static function assertValidLocale(string $locale): void
+    {
+        if (!preg_match('/^[a-z0-9@_\\.\\-]*$/i', $locale)) {
+            throw new InvalidArgumentException(sprintf('Invalid "%s" locale.', $locale));
+        }
+    }
+}
diff --git a/src/Symfony/Component/Translation/Translator.php b/src/Symfony/Component/Translation/Translator.php
@@ -147,14 +147,10 @@ public function getLocale(): string
      */
     public function setFallbackLocales(array $locales)
     {
+        $this->fallbackLocaleProvider->setFallbackLocales($locales);
+
         // needed as the fallback locales are linked to the already loaded catalogues
         $this->catalogues = [];
-
-        foreach ($locales as $locale) {
-            $this->assertValidLocale($locale);
-        }
-
-        $this->fallbackLocaleProvider->setFallbackLocales($locales);
         $this->cacheVary['fallback_locales'] = $locales;
     }
 
@@ -398,9 +394,7 @@ protected function computeFallbackLocales(string $locale)
      */
     protected function assertValidLocale(string $locale)
     {
-        if (!preg_match('/^[a-z0-9@_\\.\\-]*$/i', $locale)) {
-            throw new InvalidArgumentException(sprintf('Invalid "%s" locale.', $locale));
-        }
+        LocaleValidator::assertValidLocale($locale);
     }
 
     /**

Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@`
`13`	`13`
`14`	`14`	`/**`
`15`	`15`	`* Derives fallback locales based on ICU parent locale information, by shortening locale`
`16`		`- * sub tags and ultimately by going through a list of configured fallbacl locales.`
	`16`	`+ * sub tags and ultimately by going through a list of configured fallback locales.`
`17`	`17`	`*`
`18`	`18`	`* @author Matthias Pigulla <mp@webfactory.de>`
`19`	`19`	`*/`
`@@ -28,6 +28,10 @@ class FallbackLocaleProvider implements FallbackLocaleProviderInterface`
`28`	`28`
`29`	`29`	`public function setFallbackLocales(array $locales): void`
`30`	`30`	`{`
	`31`	`+ foreach ($locales as $locale) {`
	`32`	`+ LocaleValidator::assertValidLocale($locale);`
	`33`	`+ }`
	`34`	`+`
`31`	`35`	`$this->fallbackLocales = $locales;`
`32`	`36`	`}`
`33`	`37`
`@@ -44,6 +48,8 @@ public function getFallbackLocales(): array`
`44`	`48`	`*/`
`45`	`49`	`public function computeFallbackLocales(string $locale): array`
`46`	`50`	`{`
	`51`	`+ LocaleValidator::assertValidLocale($locale);`
	`52`	`+`
`47`	`53`	`$this->parentLocales ??= json_decode(file_get_contents(__DIR__.'/Resources/data/parents.json'), true);`
`48`	`54`
`49`	`55`	`$originLocale = $locale;`