Changeset 57337

Timestamp:

01/23/2024 01:32:34 PM (9 months ago)

Author:

swissspidy

Message:

I18N: Introduce a more performant localization library.

This introduces a more lightweight library for loading .mo translation files which offers increased speed and lower memory usage.
It also supports loading multiple locales at the same time, which makes locale switching faster too.

For plugins interacting with the $l10n global variable in core, a shim is added to retain backward compatibility with the existing pomo library.

In addition to that, this library supports translations contained in PHP files, avoiding a binary file format and leveraging OPCache if available.
If an .mo translation file has a corresponding .l10n.php file, the latter will be loaded instead.
This behavior can be adjusted using the new translation_file_format and load_translation_file filters.

PHP translation files will be typically created by downloading language packs, but can also be generated by plugins.
See ​https://make.wordpress.org/core/2023/11/08/merging-performant-translations-into-core/ for more context.

Props dd32, swissspidy, flixos90, joemcgill, westonruter, akirk, SergeyBiryukov.
Fixes #59656.

Location:

trunk

Files:

• src/wp-admin/includes/plugin.php (modified) (1 diff)
• src/wp-includes/class-wp-locale-switcher.php (modified) (1 diff)
• src/wp-includes/compat.php (modified) (1 diff)
• src/wp-includes/functions.php (modified) (1 diff)
• src/wp-includes/l10n (added)
• src/wp-includes/l10n.php (modified) (3 diffs)
• src/wp-includes/l10n/class-wp-translation-controller.php (added)
• src/wp-includes/l10n/class-wp-translation-file-mo.php (added)
• src/wp-includes/l10n/class-wp-translation-file-php.php (added)
• src/wp-includes/l10n/class-wp-translation-file.php (added)
• src/wp-includes/l10n/class-wp-translations.php (added)
• src/wp-settings.php (modified) (2 diffs)
• tests/phpunit/data/l10n (added)
• tests/phpunit/data/l10n/example-simple.mo (added)
• tests/phpunit/data/l10n/example-simple.php (added)
• tests/phpunit/data/l10n/example-simple.po (added)
• tests/phpunit/data/l10n/fa_IR.mo (added)
• tests/phpunit/data/l10n/plural.mo (added)
• tests/phpunit/data/l10n/simple.mo (added)
• tests/phpunit/data/pomo/simple.l10n.php (added)
• tests/phpunit/tests/l10n/loadTextdomainJustInTime.php (modified) (1 diff)
• tests/phpunit/tests/l10n/wpLocaleSwitcher.php (modified) (3 diffs)
• tests/phpunit/tests/l10n/wpTranslationController.php (added)
• tests/phpunit/tests/l10n/wpTranslations.php (added)
• tests/phpunit/tests/l10n/wpTranslationsConvert.php (added)

trunk/src/wp-admin/includes/plugin.php

@@ -1010 +1010 @@
                 $wp_filesystem->delete( WP_LANG_DIR . '/plugins/' . $plugin_slug . '-' . $translation . '.po' );
                 $wp_filesystem->delete( WP_LANG_DIR . '/plugins/' . $plugin_slug . '-' . $translation . '.mo' );
+                $wp_filesystem->delete( WP_LANG_DIR . '/plugins/' . $plugin_slug . '-' . $translation . '.l10n.php' );
 
                 $json_translation_files = glob( WP_LANG_DIR . '/plugins/' . $plugin_slug . '-' . $translation . '-*.json' );

trunk/src/wp-includes/class-wp-locale-switcher.php

@@ -284 +284 @@
         $wp_locale = new WP_Locale();
 
+        WP_Translation_Controller::instance()->set_locale( $locale );
+
         /**
          * Fires when the locale is switched to or restored.

trunk/src/wp-includes/compat.php

@@ -421 +421 @@
 }
 
+if ( ! function_exists( 'array_is_list' ) ) {
+    /**
+     * Polyfill for `array_is_list()` function added in PHP 8.1.
+     *
+     * Determines if the given array is a list.
+     *
+     * An array is considered a list if its keys consist of consecutive numbers from 0 to count($array)-1.
+     *
+     * @see https://github.com/symfony/polyfill-php81/tree/main
+     *
+     * @since 6.5.0
+     *
+     * @param array<mixed> $arr The array being evaluated.
+     * @return bool True if array is a list, false otherwise.
+     */
+    function array_is_list( $arr ) {
+        if ( ( array() === $arr ) || ( array_values( $arr ) === $arr ) ) {
+            return true;
+        }
+
+        $next_key = -1;
+
+        foreach ( $arr as $k => $v ) {
+            if ( ++$next_key !== $k ) {
+                return false;
+            }
+        }
+
+        return true;
+    }
+}
+
 if ( ! function_exists( 'str_contains' ) ) {
     /**

trunk/src/wp-includes/functions.php

@@ -6551 +6551 @@
         $locale_loaded = $locale ? $locale : get_locale();
         $mofile        = WP_LANG_DIR . '/continents-cities-' . $locale_loaded . '.mo';
-        unload_textdomain( 'continents-cities' );
+        unload_textdomain( 'continents-cities', true );
         load_textdomain( 'continents-cities', $mofile, $locale_loaded );
         $mo_loaded = true;

trunk/src/wp-includes/l10n.php

@@ -798 +798 @@
     }
 
-    $mo = new MO();
-    if ( ! $mo->import_from_file( $mofile ) ) {
-        $wp_textdomain_registry->set( $domain, $locale, false );
-
-        return false;
-    }
-
-    if ( isset( $l10n[ $domain ] ) ) {
-        $mo->merge_with( $l10n[ $domain ] );
-    }
-
-    unset( $l10n_unloaded[ $domain ] );
-
-    $l10n[ $domain ] = &$mo;
-
-    $wp_textdomain_registry->set( $domain, $locale, dirname( $mofile ) );
+    $i18n_controller = WP_Translation_Controller::instance();
+
+    // Ensures the correct locale is set as the current one, in case it was filtered.
+    $i18n_controller->set_locale( $locale );
+
+    /**
+     * Filters the preferred file format for translation files.
+     *
+     * Can be used to disable the use of PHP files for translations.
+     *
+     * @since 6.5.0
+     *
+     * @param string $preferred_format Preferred file format. Possible values: 'php', 'mo'. Default: 'php'.
+     * @param string $domain           The text domain.
+     */
+    $preferred_format = apply_filters( 'translation_file_format', 'php', $domain );
+    if ( ! in_array( $preferred_format, array( 'php', 'mo' ), true ) ) {
+        $preferred_format = 'php';
+    }
+
+    $translation_files = array( $mofile );
+    if ( 'mo' !== $preferred_format ) {
+        array_unshift(
+            $translation_files,
+            substr_replace( $mofile, '.l10n.', - strlen( $preferred_format ) )
+        );
+    }
+
+    foreach ( $translation_files as $file ) {
+        /**
+         * Filters the file path for loading translations for the given text domain.
+         *
+         * Similar to the {@see 'load_textdomain_mofile'} filter with the difference that
+         * the file path could be for an MO or PHP file.
+         *
+         * @since 6.5.0
+         *
+         * @param string $file   Path to the translation file to load.
+         * @param string $domain The text domain.
+         */
+        $file = (string) apply_filters( 'load_translation_file', $file, $domain );
+
+        $success = $i18n_controller->load_file( $file, $domain, $locale );
+
+        if ( $success ) {
+            if ( isset( $l10n[ $domain ] ) && $l10n[ $domain ] instanceof MO ) {
+                $i18n_controller->load_file( $l10n[ $domain ]->get_filename(), $domain, $locale );
+            }
+
+            // Unset NOOP_Translations reference in get_translations_for_domain().
+            unset( $l10n[ $domain ] );
+
+            $l10n[ $domain ] = new WP_Translations( $i18n_controller, $domain );
+
+            $wp_textdomain_registry->set( $domain, $locale, dirname( $file ) );
+
+            return true;
+        }
+    }
 
     return true;
@@ -867 +910 @@
     do_action( 'unload_textdomain', $domain, $reloadable );
 
+    // Since multiple locales are supported, reloadable text domains don't actually need to be unloaded.
+    if ( ! $reloadable ) {
+        WP_Translation_Controller::instance()->unload_textdomain( $domain );
+    }
+
     if ( isset( $l10n[ $domain ] ) ) {
         if ( $l10n[ $domain ] instanceof NOOP_Translations ) {
@@ -905 +953 @@
 
     // Unload previously loaded strings so we can switch translations.
-    unload_textdomain( 'default' );
+    unload_textdomain( 'default', true );
 
     $return = load_textdomain( 'default', WP_LANG_DIR . "/$locale.mo", $locale );

trunk/src/wp-settings.php

@@ -116 +116 @@
 require ABSPATH . WPINC . '/class-wp-error.php';
 require ABSPATH . WPINC . '/pomo/mo.php';
+require ABSPATH . WPINC . '/l10n/class-wp-translation-controller.php';
+require ABSPATH . WPINC . '/l10n/class-wp-translations.php';
+require ABSPATH . WPINC . '/l10n/class-wp-translation-file.php';
+require ABSPATH . WPINC . '/l10n/class-wp-translation-file-mo.php';
+require ABSPATH . WPINC . '/l10n/class-wp-translation-file-php.php';
 
 /**
@@ -618 +623 @@
 $GLOBALS['wp_locale_switcher']->init();
 
+WP_Translation_Controller::instance()->set_locale( $locale );
+
 // Load the functions for the active theme, for both parent and child theme if applicable.
 foreach ( wp_get_active_and_valid_themes() as $theme ) {

trunk/tests/phpunit/tests/l10n/loadTextdomainJustInTime.php

@@ -49 +49 @@
         $wp_textdomain_registry = new WP_Textdomain_Registry();
 
+        unload_textdomain( 'internationalized-plugin' );
+        unload_textdomain( 'internationalized-theme' );
+
         parent::tear_down();
     }

trunk/tests/phpunit/tests/l10n/wpLocaleSwitcher.php

@@ -21 +21 @@
      */
     protected static $user_id;
+
+    /**
+     * @var WP_Locale_Switcher
+     */
+    protected $orig_instance;
 
     public static function wpSetUpBeforeClass( WP_UnitTest_Factory $factory ) {
@@ -43 +48 @@
         $wp_textdomain_registry = new WP_Textdomain_Registry();
 
-        remove_filter( 'locale', array( $wp_locale_switcher, 'filter_locale' ) );
+        $this->orig_instance = $wp_locale_switcher;
+
+        remove_all_filters( 'locale' );
+        remove_all_filters( 'determine_locale' );
+
         $wp_locale_switcher = new WP_Locale_Switcher();
         $wp_locale_switcher->init();
@@ -59 +68 @@
         restore_current_locale();
 
-        remove_filter( 'locale', array( $wp_locale_switcher, 'filter_locale' ) );
-        $wp_locale_switcher = new WP_Locale_Switcher();
-        $wp_locale_switcher->init();
+        remove_all_filters( 'locale' );
+        remove_all_filters( 'determine_locale' );
+
+        $wp_locale_switcher = $this->orig_instance;
+
+        unload_textdomain( 'internationalized-plugin' );
+        unload_textdomain( 'custom-internationalized-theme' );
 
         parent::tear_down();