Changeset 10946 for sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-gp-custom-warnings/wporg-gp-custom-warnings.php

Timestamp:

05/04/2021 05:45:15 AM (3 years ago)

Author:

dd32

Message:

Translate: Add a warning that triggers on unexpected malformed sptintf placeholders.

This is to handle the cases where a literal percent word is replaced by % within a printf-string without being escaped, as has happened in learn.wordpress.org strings multiple times.

Included is a translation fixer, which automatically escapes the % to %% when possible, as long as the resulting string passes through the other "placeholders match" checks.

File:

• sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-gp-custom-warnings/wporg-gp-custom-warnings.php (modified) (1 diff)

sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-gp-custom-warnings/wporg-gp-custom-warnings.php

@@ -264 +264 @@
 
     /**
+     * Adds a warning for adding unexpected percent signs in a sprintf-like string.
+     * 
+     * This is to catch translations for originals like this:
+     *  - Original: `<a href="%s">100 percent</a>`
+     *  - Submitted translation: `<a href="%s">100%</a>`
+     *  - Proper translation: `<a href="%s">100%%</a>`
+     *
+     * @param string $original    The original string.
+     * @param string $translation The translated string.
+     */
+    public function warning_unexpected_sprintf_token( $original, $translation ) {
+        $unexpected_tokens = [];
+        $is_sprintf        = preg_match( '!%((\d+\$(?:\d+)?)?[bcdefgosux])!i', $original );
+
+        // Find any percents that are not valid or escaped.
+        if ( $is_sprintf ) {
+            // Negative/Positive lookahead not used to allow the warning to include the context around the % sign.
+            preg_match_all( '/(?P<context>[^\s%]*)%((\d+\$(?:\d+)?)?(?P<char>.))/i', $translation, $m );
+
+            foreach ( $m['char'] as $i => $char ) {
+                // % is included for escaped %%.
+                if ( false === strpos( 'bcdefgosux%', $char ) ) {
+                    $unexpected_tokens[] = $m[0][ $i ];
+                }
+            }
+        }
+
+        if ( $unexpected_tokens ) {
+            return "The translation contains the following unexpected placeholders: " . implode( ', ', $unexpected_tokens );
+        }
+
+        return true; // All is okay.
+    }
+
+    /**
      * Registers all methods starting with warning_ with GlotPress.
      */