Add Ginger MO

src/wp-admin/includes/class-language-pack-upgrader.php

@@ -288,6 +288,45 @@ public function bulk_upgrade( $language_updates = array(), $args = array() ) {
 			)
 		);
 
+		foreach ( $language_updates_results as $translation ) {
+			switch ( $translation['type'] ) {
+				case 'plugin':
+					$file = WP_LANG_DIR . '/plugins/' . $translation['slug'] . '-' . $translation['language'] . '.mo';
+					break;
+				case 'theme':
+					$file = WP_LANG_DIR . '/themes/' . $translation['slug'] . '-' . $translation['language'] . '.mo';
+					break;
+				default:
+					$file = WP_LANG_DIR . '/' . $translation['language'] . '.mo';
+					break;
+			}
+
+			if ( file_exists( $file ) ) {
+				/** This filter is documented in wp-includes/l10n.php */
+				$preferred_format = apply_filters( 'translation_file_format', 'php' );
+				if ( ! in_array( $preferred_format, array( 'php', 'mo', 'json' ), true ) ) {
+					$preferred_format = 'php';
+				}
+
+				$mofile_preferred = str_replace( '.mo', ".mo.$preferred_format", $file );
+
+				/** This filter is documented in wp-includes/l10n.php */
+				$convert = apply_filters( 'convert_translation_files', true );
+
+				if ( 'mo' !== $preferred_format && $convert ) {
+					$contents = Ginger_MO_Translation_File::transform( $file, $preferred_format );
+
+					if ( false !== $contents ) {
+						if ( true === $this->fs_connect( array( dirname( $file ) ) ) ) {
+							$wp_filesystem->put_contents( $mofile_preferred, $contents, FS_CHMOD_FILE );
+						} else {
+							file_put_contents( $mofile_preferred, $contents, LOCK_EX ); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_system_read_file_put_contents
+						}
+					}
+				}
+			}
+		}
+
 		// Re-add upgrade hooks.
 		add_action( 'upgrader_process_complete', array( 'Language_Pack_Upgrader', 'async_upgrade' ), 20 );
 		add_action( 'upgrader_process_complete', 'wp_version_check', 10, 0 );

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

@@ -283,6 +283,8 @@ private function change_locale( $locale ) {
 
 		$wp_locale = new WP_Locale();
 
+		Ginger_MO::instance()->set_locale( $locale );
+
 		/**
 		 * Fires when the locale is switched to or restored.
 		 *

src/wp-includes/ginger-mo/class-ginger-mo-translation-file-json.php

@@ -0,0 +1,117 @@
+<?php
+/**
+ * Class Ginger_MO_Translation_File_JSON.
+ *
+ * @package WordPress
+ */
+
+/**
+ * Class Ginger_MO_Translation_File_JSON.
+ */
+class Ginger_MO_Translation_File_JSON extends Ginger_MO_Translation_File {
+	/**
+	 * Parses the file.
+	 *
+	 * @SuppressWarnings(PHPMD.NPathComplexity)
+	 *
+	 * @return void
+	 */
+	protected function parse_file() {
+		$this->parsed = true;
+
+		$data = file_get_contents( $this->file ); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents
+
+		if ( false === $data ) {
+			$this->error = true;
+			return;
+		}
+
+		$data = json_decode( $data, true );
+
+		if ( false === $data || ! is_array( $data ) ) {
+			$this->error = json_last_error_msg();
+			return;
+		}
+
+		if ( ! isset( $data['domain'] ) || ! isset( $data['locale_data'][ $data['domain'] ] ) ) {
+			$this->error = true;
+			return;
+		}
+
+		if ( isset( $data['translation-revision-date'] ) ) {
+			$this->headers['po-revision-date'] = $data['translation-revision-date'];
+		}
+
+		$entries = $data['locale_data'][ $data['domain'] ];
+
+		foreach ( $entries as $key => $item ) {
+			if ( '' === $key ) {
+				$headers = array_change_key_case( $item );
+				if ( isset( $headers['lang'] ) ) {
+					$this->headers['language'] = $headers['lang'];
+					unset( $headers['lang'] );
+				}
+
+				$this->headers = array_merge(
+					$this->headers,
+					$headers
+				);
+				continue;
+			}
+
+			if ( is_string( $item ) ) {
+				$this->entries[ (string) $key ] = $item;
+			} elseif ( is_array( $item ) ) {
+				$this->entries[ (string) $key ] = implode( "\0", $item );
+			}
+		}
+
+		unset( $this->headers['domain'] );
+	}
+
+	/**
+	 * Exports translation contents as a string.
+	 *
+	 * @return string Translation file contents.
+	 */
+	public function export(): string {
+		$headers = array_change_key_case( $this->headers );
+
+		$domain = $headers['domain'] ?? 'messages';
+
+		$data = array(
+			'domain'      => $domain,
+			'locale_data' => array(
+				$domain => $this->entries,
+			),
+		);
+
+		if ( isset( $headers['po-revision-date'] ) ) {
+			$data['translation-revision-date'] = $headers['po-revision-date'];
+		}
+
+		if ( isset( $headers['x-generator'] ) ) {
+			$data['generator'] = $headers['x-generator'];
+		}
+
+		$data['locale_data'][ $domain ][''] = array(
+			'domain' => $domain,
+		);
+
+		if ( isset( $headers['plural-forms'] ) ) {
+			$data['locale_data'][ $domain ]['']['plural-forms'] = $headers['plural-forms'];
+		}
+
+		if ( isset( $headers['language'] ) ) {
+			$data['locale_data'][ $domain ]['']['lang'] = $headers['language'];
+		}
+
+		$json = json_encode( $data, JSON_PRETTY_PRINT );
+
+		if ( false === $json ) {
+			return '';
+		}
+
+		return $json;
+	}
+}

src/wp-includes/ginger-mo/class-ginger-mo-translation-file-mo.php

@@ -0,0 +1,209 @@
+<?php
+/**
+ * Class Ginger_MO_Translation_File_MO.
+ *
+ * @package WordPress
+ */
+
+/**
+ * Class Ginger_MO_Translation_File_MO.
+ */
+class Ginger_MO_Translation_File_MO extends Ginger_MO_Translation_File {
+	/**
+	 * Endian value.
+	 *
+	 * V for little endian, N for big endian, or false.
+	 *
+	 * Used for unpack().
+	 *
+	 * @var false|'V'|'N'
+	 */
+	protected $uint32 = false;
+
+	/**
+	 * The magic number of the GNU message catalog format.
+	 *
+	 * @var int
+	 */
+	const MAGIC_MARKER = 0x950412de;
+
+	/**
+	 * Detects endian and validates file.
+	 *
+	 * @param string $header File contents.
+	 * @return false|'V'|'N' V for little endian, N for big endian, or false on failure.
+	 */
+	protected function detect_endian_and_validate_file( string $header ) {
+		$big = unpack( 'N', $header );
+
+		if ( false === $big ) {
+			return false;
+		}
+
+		$big = reset( $big );
+
+		if ( false === $big ) {
+			return false;
+		}
+
+		$little = unpack( 'V', $header );
+
+		if ( false === $little ) {
+			return false;
+		}
+
+		$little = reset( $little );
+
+		if ( false === $little ) {
+			return false;
+		}
+
+		if ( self::MAGIC_MARKER === $big ) {
+			return 'N';
+		}
+
+		if ( self::MAGIC_MARKER === $little ) {
+			return 'V';
+		}
+
+		$this->error = "Magic Marker doesn't exist";
+		return false;
+	}
+
+	/**
+	 * Parses the file.
+	 *
+	 * @SuppressWarnings(PHPMD.NPathComplexity)
+	 *
+	 * @return bool True on success, false otherwise.
+	 */
+	protected function parse_file(): bool {
+		$this->parsed = true;
+
+		$file_contents = file_get_contents( $this->file ); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents
+
+		if ( false === $file_contents ) {
+			return false;
+		}
+
+		$file_length = strlen( $file_contents );
+
+		if ( $file_length < 24 ) {
+			$this->error = 'Invalid Data.';
+			return false;
+		}
+
+		$this->uint32 = $this->detect_endian_and_validate_file( substr( $file_contents, 0, 4 ) );
+
+		if ( false === $this->uint32 ) {
+			return false;
+		}
+
+		$offsets = substr( $file_contents, 4, 24 );
+
+		if ( false === $offsets ) {
+			return false;
+		}
+
+		$offsets = unpack( "{$this->uint32}rev/{$this->uint32}total/{$this->uint32}originals_addr/{$this->uint32}translations_addr/{$this->uint32}hash_length/{$this->uint32}hash_addr", $offsets );
+
+		if ( false === $offsets ) {
+			return false;
+		}
+
+		$offsets['originals_length']    = $offsets['translations_addr'] - $offsets['originals_addr'];
+		$offsets['translations_length'] = $offsets['hash_addr'] - $offsets['translations_addr'];
+
+		if ( $offsets['rev'] > 0 ) {
+			$this->error = 'Unsupported Revision.';
+			return false;
+		}
+
+		if ( $offsets['translations_addr'] > $file_length || $offsets['originals_addr'] > $file_length ) {
+			$this->error = 'Invalid Data.';
+			return false;
+		}
+
+		// Load the Originals.
+		$original_data     = str_split( substr( $file_contents, $offsets['originals_addr'], $offsets['originals_length'] ), 8 );
+		$translations_data = str_split( substr( $file_contents, $offsets['translations_addr'], $offsets['translations_length'] ), 8 );
+
+		foreach ( array_keys( $original_data ) as $i ) {
+			$o = unpack( "{$this->uint32}length/{$this->uint32}pos", $original_data[ $i ] );
+			$t = unpack( "{$this->uint32}length/{$this->uint32}pos", $translations_data[ $i ] );
+
+			if ( false === $o || false === $t ) {
+				continue;
+			}
+
+			$original    = substr( $file_contents, $o['pos'], $o['length'] );
+			$translation = substr( $file_contents, $t['pos'], $t['length'] );
+			// GlotPress bug.
+			$translation = rtrim( $translation, "\0" );
+
+			// Metadata about the MO file is stored in the first translation entry.
+			if ( '' === $original ) {
+				foreach ( explode( "\n", $translation ) as $meta_line ) {
+					if ( '' === $meta_line ) {
+						continue;
+					}
+
+					list( $name, $value ) = array_map( 'trim', explode( ':', $meta_line, 2 ) );
+
+					$this->headers[ strtolower( $name ) ] = $value;
+				}
+			} else {
+				$this->entries[ (string) $original ] = $translation;
+			}
+		}
+
+		return true;
+	}
+
+	/**
+	 * Exports translation contents as a string.
+	 *
+	 * @return string Translation file contents.
+	 */
+	public function export(): string {
+		// Prefix the headers as the first key.
+		$headers_string = '';
+		foreach ( $this->headers as $header => $value ) {
+			$headers_string .= "{$header}: $value\n";
+		}
+		$entries     = array_merge( array( '' => $headers_string ), $this->entries );
+		$entry_count = count( $entries );
+
+		if ( false === $this->uint32 ) {
+			$this->uint32 = 'V';
+		}
+
+		$bytes_for_entries = $entry_count * 4 * 2;
+		// Pair of 32bit ints per entry.
+		$originals_addr    = 28; /* header */
+		$translations_addr = $originals_addr + $bytes_for_entries;
+		$hash_addr         = $translations_addr + $bytes_for_entries;
+		$entry_offsets     = $hash_addr;
+
+		$file_header = pack( $this->uint32 . '*', self::MAGIC_MARKER, 0 /* rev */, $entry_count, $originals_addr, $translations_addr, 0 /* hash_length */, $hash_addr );
+
+		$o_entries = '';
+		$t_entries = '';
+		$o_addr    = '';
+		$t_addr    = '';
+
+		foreach ( array_keys( $entries ) as $original ) {
+			$o_addr        .= pack( $this->uint32 . '*', strlen( $original ), $entry_offsets );
+			$entry_offsets += strlen( $original ) + 1;
+			$o_entries     .= $original . pack( 'x' );
+		}
+
+		foreach ( $entries as $translations ) {
+			$t_addr        .= pack( $this->uint32 . '*', strlen( $translations ), $entry_offsets );
+			$entry_offsets += strlen( $translations ) + 1;
+			$t_entries     .= $translations . pack( 'x' );
+		}
+
+		return $file_header . $o_addr . $t_addr . $o_entries . $t_entries;
+	}
+}