Bugfix: Fix regression in language codes (#2215)

tvdijen · web-flow · commit e3cf4340a862 · 2024-08-24T08:37:55.000+10:00
* Use Locales instead of Languages

* Rename locales to match ISO-standard

* Add upgrade note
diff --git a/config/config.php.dist b/config/config.php.dist
@@ -824,7 +824,7 @@ $config = [
      */
     'language.available' => [
         'en', 'no', 'nn', 'se', 'da', 'de', 'sv', 'fi', 'es', 'ca', 'fr', 'it', 'nl', 'lb',
-        'cs', 'sk', 'sl', 'lt', 'hr', 'hu', 'pl', 'pt', 'pt-br', 'tr', 'ja', 'zh', 'zh-tw',
+        'cs', 'sk', 'sl', 'lt', 'hr', 'hu', 'pl', 'pt', 'pt_BR', 'tr', 'ja', 'zh', 'zh_TW',
         'ru', 'et', 'he', 'id', 'sr', 'lv', 'ro', 'eu', 'el', 'af', 'zu', 'xh', 'st',
     ],
     'language.rtl' => ['ar', 'dv', 'fa', 'ur', 'he'],
diff --git a/docs/simplesamlphp-upgrade-notes-2.3.md b/docs/simplesamlphp-upgrade-notes-2.3.md
@@ -32,5 +32,8 @@ The following properties were marked `deprecated` and will be removed in a next
 
 ## BC break
 
-Plain-text admin-passwords are no longer allowed.
-Please use the `bin/pwgen.php` script to generate a secure password hash.
+- Plain-text admin-passwords are no longer allowed.
+  Please use the `bin/pwgen.php` script to generate a secure password hash.
+
+- The language codes `pt-br` and `zh-tw` have been renamed to `pt_BR` and `zh_TW`.
+  Please update your configuration to match the new names.
diff --git a/src/SimpleSAML/Locale/Language.php b/src/SimpleSAML/Locale/Language.php
@@ -11,7 +11,7 @@
 namespace SimpleSAML\Locale;
 
 use SimpleSAML\{Configuration, Logger, Utils};
-use Symfony\Component\Intl\Languages;
+use Symfony\Component\Intl\Locales;
 
 use function array_fill_keys;
 use function array_key_exists;
@@ -114,7 +114,7 @@ public function __construct(
     /**
      * Filter configured (available) languages against installed languages.
      *
-     * @return string[] The set of languages both in 'language.available' and  Languages::getNames().
+     * @return string[] The set of languages both in 'language.available' and  Locales::getNames().
      */
     private function getInstalledLanguages(): array
     {
@@ -124,7 +124,7 @@ private function getInstalledLanguages(): array
         );
         $availableLanguages = [];
         foreach ($configuredAvailableLanguages as $code) {
-            if (Languages::exists($code)) {
+            if (Locales::exists($code)) {
                 $availableLanguages[] = $code;
             } else {
                 Logger::error("Language \"$code\" not installed. Check config.");
@@ -219,8 +219,8 @@ public function getLanguage(): string
      */
     public function getLanguageLocalizedName(string $code): ?string
     {
-        if (Languages::exists($code)) {
-            return Languages::getName($code);
+        if (Locales::exists($code)) {
+            return Locales::getName($code);
         }
         Logger::error("Name for language \"$code\" not found. Check config.");
         return null;
diff --git a/src/SimpleSAML/Locale/Localization.php b/src/SimpleSAML/Locale/Localization.php
@@ -15,8 +15,8 @@
 use Gettext\Loader\{MoLoader, PoLoader};
 use Gettext\{Translations, Translator, TranslatorFunctions};
 use SimpleSAML\{Configuration, Logger};
-use Symfony\Component\HttpFoundation\File\File;
 use SimpleSAML\Locale\Translate;
+use Symfony\Component\HttpFoundation\File\File;
 
 use function explode;
 use function is_dir;
