Changeset 10063

Timestamp:

07/11/2020 03:57:12 PM (4 years ago)

Author:

ocean90

Message:

Translate: Adjust make-core-pot command to merge references and comments of duplicate originals before removing the duplicates.

Also, fix duplicate file comments in POT files and improve exclude lists.

See #5314.

File:

• sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-gp-customizations/inc/cli/class-make-core-pot.php (modified) (14 diffs)

sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-gp-customizations/inc/cli/class-make-core-pot.php

@@ -3 +3 @@
 namespace WordPressdotorg\GlotPress\Customizations\CLI;
 
+use Gettext\Extractors\Po;
+use Gettext\Translations;
 use GP;
 use WP_CLI;
 use WP_CLI\Utils;
 use WP_CLI_Command;
+use WP_CLI\I18n\PotGenerator;
 
 class Make_Core_Pot extends WP_CLI_Command {
@@ -57 +60 @@
 
         $file_comment = sprintf(
-            'Copyright (C) %s by the contributors\nThis file is distributed under the same license as the WordPress package.',
+            "Copyright (C) %s by the contributors\nThis file is distributed under the same license as the WordPress package.",
             date( 'Y' )
         );
+        PotGenerator::setCommentBeforeHeaders( $file_comment );
 
         $command_args = [
@@ -72 +76 @@
             'package-name'  => self::PACKAGE_NAME,
             'headers'       => $headers,
-            'file-comment'  => $file_comment,
+            'file-comment'  => '',
             'skip-js'       => true,
             'skip-audit'    => true,
@@ -108 +112 @@
             'wp-includes/js/codemirror/*',
             'wp-includes/js/crop/*',
+            'wp-includes/js/dist/vendor/*',
             'wp-includes/js/imgareaselect/*',
             'wp-includes/js/jcrop/*',
@@ -115 +120 @@
             'wp-includes/js/swfupload/*',
             'wp-includes/js/thickbox/*',
+            'wp-includes/js/clipboard.js',
+            'wp-includes/js/colorpicker.js',
+            'wp-includes/js/hoverIntent.js',
+            'wp-includes/js/json2.js',
+            'wp-includes/js/swfobject.js',
             'wp-includes/js/tw-sack.js',
+            'wp-includes/js/twemoji.js',
+            'wp-includes/js/underscore.js',
         ];
 
@@ -134 +146 @@
             'package-name'  => self::PACKAGE_NAME,
             'headers'       => $headers,
-            'file-comment'  => $file_comment,
+            'file-comment'  => '',
             'skip-audit'    => true,
             'ignore-domain' => true,
@@ -160 +172 @@
             'package-name'  => self::PACKAGE_NAME,
             'headers'       => $headers,
-            'file-comment'  => $file_comment,
+            'file-comment'  => '',
             'skip-js'       => true,
             'skip-audit'    => true,
@@ -184 +196 @@
         $admin_exclude = [
             'wp-admin/includes/continents-cities.php',
-            'editor.min.js', // Explicitly excluded as it's causing a memory leak: https://github.com/wp-cli/i18n-command/issues/185
             // External libraries.
             'wp-admin/includes/class-ftp*',
@@ -190 +201 @@
         ];
 
+        // Explicitly exclude minified JavaScript files as they may
+        // cause memory leaks: https://github.com/wp-cli/i18n-command/issues/185.
+        $admin_min_js  = array_map( 'basename', glob( $this->source . '/wp-admin/js/*.min.js' ) );
+        $admin_exclude = array_merge( $admin_exclude, $admin_min_js );
+
         $admin_exclude = array_merge( $admin_exclude, $admin_network_files );
 
@@ -203 +219 @@
             'include'       => 'wp-admin/*',
             'merge'         => $hello_dolly_pot,
-            'subtract'      => $this->destination . '/wordpress.pot',
-            'package-name'  => self::PACKAGE_NAME,
-            'headers'       => $headers,
-            'file-comment'  => $file_comment,
+            'package-name'  => self::PACKAGE_NAME,
+            'headers'       => $headers,
+            'file-comment'  => '',
             'skip-audit'    => true,
             'ignore-domain' => true,
@@ -219 +234 @@
         unlink( $hello_dolly_pot );
 
+        $this->merge_pot( $this->destination . '/wordpress.pot', $this->destination . '/wordpress-admin.pot' );
+
         // Admin Network.
         $command_args = [
@@ -229 +246 @@
         $command_assoc_args = [
             'include'       => implode( ',', $admin_network_files ),
-            'subtract'      => sprintf( '%1$s/wordpress.pot,%1$s/wordpress-admin.pot', $this->destination ),
-            'package-name'  => self::PACKAGE_NAME,
-            'headers'       => $headers,
-            'file-comment'  => $file_comment,
+            'package-name'  => self::PACKAGE_NAME,
+            'headers'       => $headers,
+            'file-comment'  => '',
             'skip-js'       => true, // TODO: No use of wp.i18n, yet.
             'skip-audit'    => true,
@@ -239 +255 @@
 
         WP_CLI::run_command( $command_args, $command_assoc_args );
+
+        $this->merge_pot( $this->destination . '/wordpress.pot', $this->destination . '/wordpress-admin-network.pot' );
+        $this->merge_pot( $this->destination . '/wordpress-admin.pot', $this->destination . '/wordpress-admin-network.pot' );
     }
 
@@ -254 +273 @@
         return preg_match( '/\$wp_version\s*=\s*\'(.*?)\';/', file_get_contents( $version_php ), $matches ) ? $matches[1] : false;
     }
+
+    /**
+     * Merges duplicate originals of two POT files.
+     *
+     * Preserves the references and comments of each original.
+     *
+     * @param string $to_file   Path to the POT file where duplicates should be merged into.
+     * @param string $from_file Path to the POT file where duplicates should be extracted from.
+     */
+    private function merge_pot( $to_file, $from_file ) {
+        $to = new Translations();
+        Po::fromFile( $to_file, $to );
+        $from = new Translations();
+        Po::fromFile( $from_file, $from );
+
+        foreach ( $to as $original ) {
+            // Check for duplicate.
+            $existing = $from->find( $original );
+            if ( ! $existing ) {
+                continue;
+            }
+
+            // Merge.
+            $original->mergeWith( $existing );
+
+            // Remove original from source
+            unset( $from[ $existing->getId() ] );
+        }
+
+        $to->deleteHeader( Translations::HEADER_LANGUAGE );
+        $from->deleteHeader( Translations::HEADER_LANGUAGE );
+        PotGenerator::toFile( $to, $to_file );
+        PotGenerator::toFile( $from, $from_file );
+    }
 }