Merge pull request #7966 from kenjis/fix-lang-format-error

fix: lang() may return false
codeigniter4 · Oct 5, 2023 · c27fb5d · c27fb5d
2 parents efb12a8 + 1b94c4c
commit c27fb5d
Show file tree

Hide file tree

Showing 4 changed files with 51 additions and 1 deletion.
diff --git a/system/Language/Language.php b/system/Language/Language.php
@@ -12,6 +12,7 @@
 namespace CodeIgniter\Language;
 
 use Config\Services;
+use InvalidArgumentException;
 use MessageFormatter;
 
 /**
@@ -191,7 +192,14 @@ protected function formatMessage($message, array $args = [])
             return $message;
         }
 
-        return MessageFormatter::formatMessage($this->locale, $message, $args);
+        $formatted = MessageFormatter::formatMessage($this->locale, $message, $args);
+        if ($formatted === false) {
+            throw new InvalidArgumentException(
+                lang('Language.invalidMessageFormat', [$message, implode(',', $args)])
+            );
+        }
+
+        return $formatted;
     }
 
     /**

diff --git a/system/Language/en/Language.php b/system/Language/en/Language.php
@@ -0,0 +1,15 @@
+<?php
+
+/**
+ * This file is part of CodeIgniter 4 framework.
+ *
+ * (c) CodeIgniter Foundation <admin@codeigniter.com>
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+// "Language" language settings
+return [
+    'invalidMessageFormat' => 'Invalid message format: "{0}", args: "{1}"',
+];
diff --git a/tests/system/Language/LanguageTest.php b/tests/system/Language/LanguageTest.php
@@ -14,6 +14,7 @@
 use CodeIgniter\Test\CIUnitTestCase;
 use CodeIgniter\Test\Mock\MockLanguage;
 use Config\Services;
+use InvalidArgumentException;
 use MessageFormatter;
 use Tests\Support\Language\SecondMockLanguage;
 
@@ -126,6 +127,30 @@ public function testGetLineArrayFormatsMessages(): void
         $this->assertSame(['45 related books.'], $this->lang->getLine('books.bookList', [91 / 2]));
     }
 
+    /**
+     * @see https://github.com/codeigniter4/shield/issues/851
+     */
+    public function testGetLineInvalidFormatMessage(): void
+    {
+        // No intl extension? then we can't test this - go away....
+        if (! class_exists(MessageFormatter::class)) {
+            $this->markTestSkipped('No intl support.');
+        }
+
+        $this->expectException(InvalidArgumentException::class);
+        $this->expectExceptionMessage(
+            'Invalid message format: "تم الكشف عن كلمة المرور {0} بسبب اختراق البيانات وشوهدت {1 ، عدد} مرة في {2} في كلمات المرور المخترقة.", args: "password,hits,wording"'
+        );
+
+        $this->lang->setLocale('ar');
+
+        $this->lang->setData('Auth', [
+            'errorPasswordPwned' => 'تم الكشف عن كلمة المرور {0} بسبب اختراق البيانات وشوهدت {1 ، عدد} مرة في {2} في كلمات المرور المخترقة.',
+        ]);
+
+        $this->lang->getLine('Auth.errorPasswordPwned', ['password', 'hits', 'wording']);
+    }
+
     /**
      * @see https://github.com/codeigniter4/CodeIgniter4/issues/891
      */

diff --git a/user_guide_src/source/changelogs/v4.4.2.rst b/user_guide_src/source/changelogs/v4.4.2.rst
@@ -15,6 +15,8 @@ BREAKING
 Message Changes
 ***************
 
+- Added ``Language.invalidMessageFormat`` error message.
+
 Changes
 *******