<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* I18N: WP_Translation_File_MO class.

[2] Fix | Delete

*

[3] Fix | Delete

* @package WordPress

[4] Fix | Delete

* @subpackage I18N

[5] Fix | Delete

* @since 6.5.0

[6] Fix | Delete

*/

[7] Fix | Delete

[8] Fix | Delete

/**

[9] Fix | Delete

* Class WP_Translation_File_MO.

[10] Fix | Delete

*

[11] Fix | Delete

* @since 6.5.0

[12] Fix | Delete

*/

[13] Fix | Delete

class WP_Translation_File_MO extends WP_Translation_File {

[14] Fix | Delete

/**

[15] Fix | Delete

* Endian value.

[16] Fix | Delete

*

[17] Fix | Delete

* V for little endian, N for big endian, or false.

[18] Fix | Delete

*

[19] Fix | Delete

* Used for unpack().

[20] Fix | Delete

*

[21] Fix | Delete

* @since 6.5.0

[22] Fix | Delete

* @var false|'V'|'N'

[23] Fix | Delete

*/

[24] Fix | Delete

protected $uint32 = false;

[25] Fix | Delete

[26] Fix | Delete

/**

[27] Fix | Delete

* The magic number of the GNU message catalog format.

[28] Fix | Delete

*

[29] Fix | Delete

* @since 6.5.0

[30] Fix | Delete

* @var int

[31] Fix | Delete

*/

[32] Fix | Delete

const MAGIC_MARKER = 0x950412de;

[33] Fix | Delete

[34] Fix | Delete

/**

[35] Fix | Delete

* Detects endian and validates file.

[36] Fix | Delete

*

[37] Fix | Delete

* @since 6.5.0

[38] Fix | Delete

*

[39] Fix | Delete

* @param string $header File contents.

[40] Fix | Delete

* @return false|'V'|'N' V for little endian, N for big endian, or false on failure.

[41] Fix | Delete

*/

[42] Fix | Delete

protected function detect_endian_and_validate_file( string $header ) {

[43] Fix | Delete

$big = unpack( 'N', $header );

[44] Fix | Delete

[45] Fix | Delete

if ( false === $big ) {

[46] Fix | Delete

return false;

[47] Fix | Delete

}

[48] Fix | Delete

[49] Fix | Delete

$big = reset( $big );

[50] Fix | Delete

[51] Fix | Delete

if ( false === $big ) {

[52] Fix | Delete

return false;

[53] Fix | Delete

}

[54] Fix | Delete

[55] Fix | Delete

$little = unpack( 'V', $header );

[56] Fix | Delete

[57] Fix | Delete

if ( false === $little ) {

[58] Fix | Delete

return false;

[59] Fix | Delete

}

[60] Fix | Delete

[61] Fix | Delete

$little = reset( $little );

[62] Fix | Delete

[63] Fix | Delete

if ( false === $little ) {

[64] Fix | Delete

return false;

[65] Fix | Delete

}

[66] Fix | Delete

[67] Fix | Delete

// Force cast to an integer as it can be a float on x86 systems. See https://core.trac.wordpress.org/ticket/60678.

[68] Fix | Delete

if ( (int) self::MAGIC_MARKER === $big ) {

[69] Fix | Delete

return 'N';

[70] Fix | Delete

}

[71] Fix | Delete

[72] Fix | Delete

// Force cast to an integer as it can be a float on x86 systems. See https://core.trac.wordpress.org/ticket/60678.

[73] Fix | Delete

if ( (int) self::MAGIC_MARKER === $little ) {

[74] Fix | Delete

return 'V';

[75] Fix | Delete

}

[76] Fix | Delete

[77] Fix | Delete

$this->error = 'Magic marker does not exist';

[78] Fix | Delete

return false;

[79] Fix | Delete

}

[80] Fix | Delete

[81] Fix | Delete

/**

[82] Fix | Delete

* Parses the file.

[83] Fix | Delete

*

[84] Fix | Delete

* @since 6.5.0

[85] Fix | Delete

*

[86] Fix | Delete

* @return bool True on success, false otherwise.

[87] Fix | Delete

*/

[88] Fix | Delete

protected function parse_file(): bool {

[89] Fix | Delete

$this->parsed = true;

[90] Fix | Delete

[91] Fix | Delete

$file_contents = file_get_contents( $this->file ); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents

[92] Fix | Delete

[93] Fix | Delete

if ( false === $file_contents ) {

[94] Fix | Delete

return false;

[95] Fix | Delete

}

[96] Fix | Delete

[97] Fix | Delete

$file_length = strlen( $file_contents );

[98] Fix | Delete

[99] Fix | Delete

if ( $file_length < 24 ) {

[100] Fix | Delete

$this->error = 'Invalid data';

[101] Fix | Delete

return false;

[102] Fix | Delete

}

[103] Fix | Delete

[104] Fix | Delete

$this->uint32 = $this->detect_endian_and_validate_file( substr( $file_contents, 0, 4 ) );

[105] Fix | Delete

[106] Fix | Delete

if ( false === $this->uint32 ) {

[107] Fix | Delete

return false;

[108] Fix | Delete

}

[109] Fix | Delete

[110] Fix | Delete

$offsets = substr( $file_contents, 4, 24 );

[111] Fix | Delete

[112] Fix | Delete

if ( false === $offsets ) {

[113] Fix | Delete

return false;

[114] Fix | Delete

}

[115] Fix | Delete

[116] Fix | Delete

$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 );

[117] Fix | Delete

[118] Fix | Delete

if ( false === $offsets ) {

[119] Fix | Delete

return false;

[120] Fix | Delete

}

[121] Fix | Delete

[122] Fix | Delete

$offsets['originals_length'] = $offsets['translations_addr'] - $offsets['originals_addr'];

[123] Fix | Delete

$offsets['translations_length'] = $offsets['hash_addr'] - $offsets['translations_addr'];

[124] Fix | Delete

[125] Fix | Delete

if ( $offsets['rev'] > 0 ) {

[126] Fix | Delete

$this->error = 'Unsupported revision';

[127] Fix | Delete

return false;

[128] Fix | Delete

}

[129] Fix | Delete

[130] Fix | Delete

if ( $offsets['translations_addr'] > $file_length || $offsets['originals_addr'] > $file_length ) {

[131] Fix | Delete

$this->error = 'Invalid data';

[132] Fix | Delete

return false;

[133] Fix | Delete

}

[134] Fix | Delete

[135] Fix | Delete

// Load the Originals.

[136] Fix | Delete

$original_data = str_split( substr( $file_contents, $offsets['originals_addr'], $offsets['originals_length'] ), 8 );

[137] Fix | Delete

$translations_data = str_split( substr( $file_contents, $offsets['translations_addr'], $offsets['translations_length'] ), 8 );

[138] Fix | Delete

[139] Fix | Delete

foreach ( array_keys( $original_data ) as $i ) {

[140] Fix | Delete

$o = unpack( "{$this->uint32}length/{$this->uint32}pos", $original_data[ $i ] );

[141] Fix | Delete

$t = unpack( "{$this->uint32}length/{$this->uint32}pos", $translations_data[ $i ] );

[142] Fix | Delete

[143] Fix | Delete

if ( false === $o || false === $t ) {

[144] Fix | Delete

continue;

[145] Fix | Delete

}

[146] Fix | Delete

[147] Fix | Delete

$original = substr( $file_contents, $o['pos'], $o['length'] );

[148] Fix | Delete

$translation = substr( $file_contents, $t['pos'], $t['length'] );

[149] Fix | Delete

// GlotPress bug.

[150] Fix | Delete

$translation = rtrim( $translation, "\0" );

[151] Fix | Delete

[152] Fix | Delete

// Metadata about the MO file is stored in the first translation entry.

[153] Fix | Delete

if ( '' === $original ) {

[154] Fix | Delete

foreach ( explode( "\n", $translation ) as $meta_line ) {

[155] Fix | Delete

if ( '' === $meta_line ) {

[156] Fix | Delete

continue;

[157] Fix | Delete

}

[158] Fix | Delete

[159] Fix | Delete

list( $name, $value ) = array_map( 'trim', explode( ':', $meta_line, 2 ) );

[160] Fix | Delete

[161] Fix | Delete

$this->headers[ strtolower( $name ) ] = $value;

[162] Fix | Delete

}

[163] Fix | Delete

} else {

[164] Fix | Delete

/*

[165] Fix | Delete

* In MO files, the key normally contains both singular and plural versions.

[166] Fix | Delete

* However, this just adds the singular string for lookup,

[167] Fix | Delete

* which caters for cases where both __( 'Product' ) and _n( 'Product', 'Products' )

[168] Fix | Delete

* are used and the translation is expected to be the same for both.

[169] Fix | Delete

*/

[170] Fix | Delete

$parts = explode( "\0", (string) $original );

[171] Fix | Delete

[172] Fix | Delete

$this->entries[ $parts[0] ] = $translation;

[173] Fix | Delete

}

[174] Fix | Delete

}

[175] Fix | Delete

[176] Fix | Delete

return true;

[177] Fix | Delete

}

[178] Fix | Delete

[179] Fix | Delete

/**

[180] Fix | Delete

* Exports translation contents as a string.

[181] Fix | Delete

*

[182] Fix | Delete

* @since 6.5.0

[183] Fix | Delete

*

[184] Fix | Delete

* @return string Translation file contents.

[185] Fix | Delete

*/

[186] Fix | Delete

public function export(): string {

[187] Fix | Delete

// Prefix the headers as the first key.

[188] Fix | Delete

$headers_string = '';

[189] Fix | Delete

foreach ( $this->headers as $header => $value ) {

[190] Fix | Delete

$headers_string .= "{$header}: $value\n";

[191] Fix | Delete

}

[192] Fix | Delete

$entries = array_merge( array( '' => $headers_string ), $this->entries );

[193] Fix | Delete

$entry_count = count( $entries );

[194] Fix | Delete

[195] Fix | Delete

if ( false === $this->uint32 ) {

[196] Fix | Delete

$this->uint32 = 'V';

[197] Fix | Delete

}

[198] Fix | Delete

[199] Fix | Delete

$bytes_for_entries = $entry_count * 4 * 2;

[200] Fix | Delete

// Pair of 32bit ints per entry.

[201] Fix | Delete

$originals_addr = 28; /* header */

[202] Fix | Delete

$translations_addr = $originals_addr + $bytes_for_entries;

[203] Fix | Delete

$hash_addr = $translations_addr + $bytes_for_entries;

[204] Fix | Delete

$entry_offsets = $hash_addr;

[205] Fix | Delete

[206] Fix | Delete

$file_header = pack(

[207] Fix | Delete

$this->uint32 . '*',

[208] Fix | Delete

// Force cast to an integer as it can be a float on x86 systems. See https://core.trac.wordpress.org/ticket/60678.

[209] Fix | Delete

(int) self::MAGIC_MARKER,

[210] Fix | Delete

0, /* rev */

[211] Fix | Delete

$entry_count,

[212] Fix | Delete

$originals_addr,

[213] Fix | Delete

$translations_addr,

[214] Fix | Delete

0, /* hash_length */

[215] Fix | Delete

$hash_addr

[216] Fix | Delete

);

[217] Fix | Delete

[218] Fix | Delete

$o_entries = '';

[219] Fix | Delete

$t_entries = '';

[220] Fix | Delete

$o_addr = '';

[221] Fix | Delete

$t_addr = '';

[222] Fix | Delete

[223] Fix | Delete

foreach ( array_keys( $entries ) as $original ) {

[224] Fix | Delete

$o_addr .= pack( $this->uint32 . '*', strlen( $original ), $entry_offsets );

[225] Fix | Delete

$entry_offsets += strlen( $original ) + 1;

[226] Fix | Delete

$o_entries .= $original . "\0";

[227] Fix | Delete

}

[228] Fix | Delete

[229] Fix | Delete

foreach ( $entries as $translations ) {

[230] Fix | Delete

$t_addr .= pack( $this->uint32 . '*', strlen( $translations ), $entry_offsets );

[231] Fix | Delete

$entry_offsets += strlen( $translations ) + 1;

[232] Fix | Delete

$t_entries .= $translations . "\0";

[233] Fix | Delete

}

[234] Fix | Delete

[235] Fix | Delete

return $file_header . $o_addr . $t_addr . $o_entries . $t_entries;

[236] Fix | Delete

}

[237] Fix | Delete

}

[238] Fix | Delete

[239] Fix | Delete