Changeset 57339

Timestamp:

01/23/2024 03:13:32 PM (2 years ago)

Author:

swissspidy

Message:

I18N: Improve edge case handling in WP_Translation_Controller.

Prevents PHP warnings for possibly undefined array keys.
Also fixes incorrect @covers annotations.

Follow-up to [57337].
See #59656.

Location:

trunk

Files:

• src/wp-includes/l10n.php (modified) (1 diff)
• src/wp-includes/l10n/class-wp-translation-controller.php (modified) (3 diffs)
• tests/phpunit/tests/l10n/wpTranslationController.php (modified) (2 diffs)
• tests/phpunit/tests/l10n/wpTranslationsConvert.php (modified) (8 diffs)

trunk/src/wp-includes/l10n.php

@@ -822 +822 @@
         array_unshift(
             $translation_files,
-            substr_replace( $mofile, ".l10n.$preferred_format", - strlen( $preferred_format ) )
+            substr_replace( $mofile, ".l10n.$preferred_format", - strlen( '.mo' ) )
         );
     }

trunk/src/wp-includes/l10n/class-wp-translation-controller.php

@@ -152 +152 @@
 
         if ( null !== $locale ) {
-            foreach ( $this->loaded_translations[ $locale ][ $textdomain ] as $i => $moe ) {
-                if ( $file === $moe || $file === $moe->get_file() ) {
-                    unset( $this->loaded_translations[ $locale ][ $textdomain ][ $i ] );
-                    unset( $this->loaded_files[ $moe->get_file() ][ $locale ][ $textdomain ] );
-                    return true;
+            if ( isset( $this->loaded_translations[ $locale ][ $textdomain ] ) ) {
+                foreach ( $this->loaded_translations[ $locale ][ $textdomain ] as $i => $moe ) {
+                    if ( $file === $moe || $file === $moe->get_file() ) {
+                        unset( $this->loaded_translations[ $locale ][ $textdomain ][ $i ] );
+                        unset( $this->loaded_files[ $moe->get_file() ][ $locale ][ $textdomain ] );
+                        return true;
+                    }
                 }
             }
@@ -164 +166 @@
 
         foreach ( $this->loaded_translations as $l => $domains ) {
+            if ( ! isset( $domains[ $textdomain ] ) ) {
+                continue;
+            }
+
             foreach ( $domains[ $textdomain ] as $i => $moe ) {
                 if ( $file === $moe || $file === $moe->get_file() ) {
@@ -186 +192 @@
      */
     public function unload_textdomain( string $textdomain = 'default', string $locale = null ): bool {
+        $unloaded = false;
+
         if ( null !== $locale ) {
-            foreach ( $this->loaded_translations[ $locale ][ $textdomain ] as $moe ) {
-                unset( $this->loaded_files[ $moe->get_file() ][ $locale ][ $textdomain ] );
+            if ( isset( $this->loaded_translations[ $locale ][ $textdomain ] ) ) {
+                $unloaded = true;
+                foreach ( $this->loaded_translations[ $locale ][ $textdomain ] as $moe ) {
+                    unset( $this->loaded_files[ $moe->get_file() ][ $locale ][ $textdomain ] );
+                }
             }
 
             unset( $this->loaded_translations[ $locale ][ $textdomain ] );
 
-            return true;
-        }
-
-        $unloaded = false;
+            return $unloaded;
+        }
 
         foreach ( $this->loaded_translations as $l => $domains ) {

trunk/tests/phpunit/tests/l10n/wpTranslationController.php

@@ -111 +111 @@
      * @return void
      */
+    public function test_load_textdomain_prefers_php_files_by_default() {
+        $load_successful = load_textdomain( 'wp-tests-domain', DIR_TESTDATA . '/pomo/simple.mo' );
+
+        $instance = WP_Translation_Controller::instance();
+
+        $is_loaded = $instance->is_textdomain_loaded( 'wp-tests-domain', 'en_US' );
+
+        $unload_mo  = $instance->unload_file( DIR_TESTDATA . '/pomo/simple.mo', 'wp-tests-domain' );
+        $unload_php = $instance->unload_file( DIR_TESTDATA . '/pomo/simple.l10n.php', 'wp-tests-domain' );
+
+        $unload_successful = unload_textdomain( 'wp-tests-domain' );
+
+        $this->assertTrue( $load_successful, 'Translation not successfully loaded' );
+        $this->assertTrue( $is_loaded );
+        $this->assertFalse( $unload_mo );
+        $this->assertTrue( $unload_php );
+        $this->assertTrue( $unload_successful );
+    }
+
+    /**
+     * @covers ::load_textdomain
+     *
+     * @return void
+     */
     public function test_load_textdomain_reads_php_files_if_filtered_format_is_unsupported() {
         add_filter(
@@ -298 +322 @@
 
     /**
+     * @covers ::unload_file
+     * @covers ::unload_textdomain
+     *
+     * @return void
+     */
+    public function test_unload_non_existent_files_and_textdomains() {
+        $controller = new WP_Translation_Controller();
+        $this->assertFalse( $controller->unload_textdomain( 'foobarbaz' ) );
+        $this->assertFalse( $controller->unload_textdomain( 'foobarbaz', 'es_ES' ) );
+        $this->assertFalse( $controller->unload_textdomain( 'default', 'es_ES' ) );
+        $this->assertFalse( $controller->unload_file( DIR_TESTDATA . '/l10n/fa_IR.mo' ) );
+        $this->assertFalse( $controller->unload_file( DIR_TESTDATA . '/l10n/fa_IR.mo', 'es_ES' ) );
+    }
+
+    /**
      * @covers ::load_textdomain
      * @covers ::unload_textdomain

trunk/tests/phpunit/tests/l10n/wpTranslationsConvert.php

@@ -29 +29 @@
 
     /**
-     * @covers ::unload
+     * @covers ::unload_textdomain
      *
      * @return void
@@ -41 +41 @@
     /**
      * @covers ::load
-     * @covers ::unload
+     * @covers ::unload_textdomain
      * @covers ::is_textdomain_loaded
      * @covers ::translate
@@ -63 +63 @@
 
     /**
-     * @covers ::unload
+     * @covers ::unload_file
      * @covers WP_Translation_File::get_file
      *
@@ -78 +78 @@
 
     /**
-     * @covers ::unload
+     * @covers ::unload_textdomain
      * @covers ::is_textdomain_loaded
      *
@@ -236 +236 @@
     /**
      * @covers ::load
-     * @covers ::unload
+     * @covers ::unload_file
      * @covers ::is_textdomain_loaded
      * @covers ::translate
@@ -290 +290 @@
      * @covers ::get_locale
      * @covers ::load
-     * @covers ::unload
+     * @covers ::unload_file
      * @covers ::is_textdomain_loaded
      * @covers ::translate
@@ -334 +334 @@
 
     /**
-     * @covers ::unload
+     * @covers ::unload_textdomain
      *
      * @return void
@@ -412 +412 @@
     /**
      * @covers ::load
-     * @covers ::unload
      * @covers ::is_textdomain_loaded
      * @covers ::translate