<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* Class for working with MO files

[2] Fix | Delete

*

[3] Fix | Delete

* @version $Id: mo.php 1157 2015-11-20 04:30:11Z dd32 $

[4] Fix | Delete

* @package pomo

[5] Fix | Delete

* @subpackage mo

[6] Fix | Delete

*/

[7] Fix | Delete

[8] Fix | Delete

require_once __DIR__ . '/translations.php';

[9] Fix | Delete

require_once __DIR__ . '/streams.php';

[10] Fix | Delete

[11] Fix | Delete

if ( ! class_exists( 'MO', false ) ) :

[12] Fix | Delete

class MO extends Gettext_Translations {

[13] Fix | Delete

[14] Fix | Delete

/**

[15] Fix | Delete

* Number of plural forms.

[16] Fix | Delete

*

[17] Fix | Delete

* @var int

[18] Fix | Delete

*/

[19] Fix | Delete

public $_nplurals = 2;

[20] Fix | Delete

[21] Fix | Delete

/**

[22] Fix | Delete

* Loaded MO file.

[23] Fix | Delete

*

[24] Fix | Delete

* @var string

[25] Fix | Delete

*/

[26] Fix | Delete

private $filename = '';

[27] Fix | Delete

[28] Fix | Delete

/**

[29] Fix | Delete

* Returns the loaded MO file.

[30] Fix | Delete

*

[31] Fix | Delete

* @return string The loaded MO file.

[32] Fix | Delete

*/

[33] Fix | Delete

public function get_filename() {

[34] Fix | Delete

return $this->filename;

[35] Fix | Delete

}

[36] Fix | Delete

[37] Fix | Delete

/**

[38] Fix | Delete

* Fills up with the entries from MO file $filename

[39] Fix | Delete

*

[40] Fix | Delete

* @param string $filename MO file to load

[41] Fix | Delete

* @return bool True if the import from file was successful, otherwise false.

[42] Fix | Delete

*/

[43] Fix | Delete

public function import_from_file( $filename ) {

[44] Fix | Delete

$reader = new POMO_FileReader( $filename );

[45] Fix | Delete

[46] Fix | Delete

if ( ! $reader->is_resource() ) {

[47] Fix | Delete

return false;

[48] Fix | Delete

}

[49] Fix | Delete

[50] Fix | Delete

$this->filename = (string) $filename;

[51] Fix | Delete

[52] Fix | Delete

return $this->import_from_reader( $reader );

[53] Fix | Delete

}

[54] Fix | Delete

[55] Fix | Delete

/**

[56] Fix | Delete

* @param string $filename

[57] Fix | Delete

* @return bool

[58] Fix | Delete

*/

[59] Fix | Delete

public function export_to_file( $filename ) {

[60] Fix | Delete

$fh = fopen( $filename, 'wb' );

[61] Fix | Delete

if ( ! $fh ) {

[62] Fix | Delete

return false;

[63] Fix | Delete

}

[64] Fix | Delete

$res = $this->export_to_file_handle( $fh );

[65] Fix | Delete

fclose( $fh );

[66] Fix | Delete

return $res;

[67] Fix | Delete

}

[68] Fix | Delete

[69] Fix | Delete

/**

[70] Fix | Delete

* @return string|false

[71] Fix | Delete

*/

[72] Fix | Delete

public function export() {

[73] Fix | Delete

$tmp_fh = fopen( 'php://temp', 'r+' );

[74] Fix | Delete

if ( ! $tmp_fh ) {

[75] Fix | Delete

return false;

[76] Fix | Delete

}

[77] Fix | Delete

$this->export_to_file_handle( $tmp_fh );

[78] Fix | Delete

rewind( $tmp_fh );

[79] Fix | Delete

return stream_get_contents( $tmp_fh );

[80] Fix | Delete

}

[81] Fix | Delete

[82] Fix | Delete

/**

[83] Fix | Delete

* @param Translation_Entry $entry

[84] Fix | Delete

* @return bool

[85] Fix | Delete

*/

[86] Fix | Delete

public function is_entry_good_for_export( $entry ) {

[87] Fix | Delete

if ( empty( $entry->translations ) ) {

[88] Fix | Delete

return false;

[89] Fix | Delete

}

[90] Fix | Delete

[91] Fix | Delete

if ( ! array_filter( $entry->translations ) ) {

[92] Fix | Delete

return false;

[93] Fix | Delete

}

[94] Fix | Delete

[95] Fix | Delete

return true;

[96] Fix | Delete

}

[97] Fix | Delete

[98] Fix | Delete

/**

[99] Fix | Delete

* @param resource $fh

[100] Fix | Delete

* @return true

[101] Fix | Delete

*/

[102] Fix | Delete

public function export_to_file_handle( $fh ) {

[103] Fix | Delete

$entries = array_filter( $this->entries, array( $this, 'is_entry_good_for_export' ) );

[104] Fix | Delete

ksort( $entries );

[105] Fix | Delete

$magic = 0x950412de;

[106] Fix | Delete

$revision = 0;

[107] Fix | Delete

$total = count( $entries ) + 1; // All the headers are one entry.

[108] Fix | Delete

$originals_lengths_addr = 28;

[109] Fix | Delete

$translations_lengths_addr = $originals_lengths_addr + 8 * $total;

[110] Fix | Delete

$size_of_hash = 0;

[111] Fix | Delete

$hash_addr = $translations_lengths_addr + 8 * $total;

[112] Fix | Delete

$current_addr = $hash_addr;

[113] Fix | Delete

fwrite(

[114] Fix | Delete

$fh,

[115] Fix | Delete

pack(

[116] Fix | Delete

'V*',

[117] Fix | Delete

$magic,

[118] Fix | Delete

$revision,

[119] Fix | Delete

$total,

[120] Fix | Delete

$originals_lengths_addr,

[121] Fix | Delete

$translations_lengths_addr,

[122] Fix | Delete

$size_of_hash,

[123] Fix | Delete

$hash_addr

[124] Fix | Delete

)

[125] Fix | Delete

);

[126] Fix | Delete

fseek( $fh, $originals_lengths_addr );

[127] Fix | Delete

[128] Fix | Delete

// Headers' msgid is an empty string.

[129] Fix | Delete

fwrite( $fh, pack( 'VV', 0, $current_addr ) );

[130] Fix | Delete

++$current_addr;

[131] Fix | Delete

$originals_table = "\0";

[132] Fix | Delete

[133] Fix | Delete

$reader = new POMO_Reader();

[134] Fix | Delete

[135] Fix | Delete

foreach ( $entries as $entry ) {

[136] Fix | Delete

$originals_table .= $this->export_original( $entry ) . "\0";

[137] Fix | Delete

$length = $reader->strlen( $this->export_original( $entry ) );

[138] Fix | Delete

fwrite( $fh, pack( 'VV', $length, $current_addr ) );

[139] Fix | Delete

$current_addr += $length + 1; // Account for the NULL byte after.

[140] Fix | Delete

}

[141] Fix | Delete

[142] Fix | Delete

$exported_headers = $this->export_headers();

[143] Fix | Delete

fwrite( $fh, pack( 'VV', $reader->strlen( $exported_headers ), $current_addr ) );

[144] Fix | Delete

$current_addr += strlen( $exported_headers ) + 1;

[145] Fix | Delete

$translations_table = $exported_headers . "\0";

[146] Fix | Delete

[147] Fix | Delete

foreach ( $entries as $entry ) {

[148] Fix | Delete

$translations_table .= $this->export_translations( $entry ) . "\0";

[149] Fix | Delete

$length = $reader->strlen( $this->export_translations( $entry ) );

[150] Fix | Delete

fwrite( $fh, pack( 'VV', $length, $current_addr ) );

[151] Fix | Delete

$current_addr += $length + 1;

[152] Fix | Delete

}

[153] Fix | Delete

[154] Fix | Delete

fwrite( $fh, $originals_table );

[155] Fix | Delete

fwrite( $fh, $translations_table );

[156] Fix | Delete

return true;

[157] Fix | Delete

}

[158] Fix | Delete

[159] Fix | Delete

/**

[160] Fix | Delete

* @param Translation_Entry $entry

[161] Fix | Delete

* @return string

[162] Fix | Delete

*/

[163] Fix | Delete

public function export_original( $entry ) {

[164] Fix | Delete

// TODO: Warnings for control characters.

[165] Fix | Delete

$exported = $entry->singular;

[166] Fix | Delete

if ( $entry->is_plural ) {

[167] Fix | Delete

$exported .= "\0" . $entry->plural;

[168] Fix | Delete

}

[169] Fix | Delete

if ( $entry->context ) {

[170] Fix | Delete

$exported = $entry->context . "\4" . $exported;

[171] Fix | Delete

}

[172] Fix | Delete

return $exported;

[173] Fix | Delete

}

[174] Fix | Delete

[175] Fix | Delete

/**

[176] Fix | Delete

* @param Translation_Entry $entry

[177] Fix | Delete

* @return string

[178] Fix | Delete

*/

[179] Fix | Delete

public function export_translations( $entry ) {

[180] Fix | Delete

// TODO: Warnings for control characters.

[181] Fix | Delete

return $entry->is_plural ? implode( "\0", $entry->translations ) : $entry->translations[0];

[182] Fix | Delete

}

[183] Fix | Delete

[184] Fix | Delete

/**

[185] Fix | Delete

* @return string

[186] Fix | Delete

*/

[187] Fix | Delete

public function export_headers() {

[188] Fix | Delete

$exported = '';

[189] Fix | Delete

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

[190] Fix | Delete

$exported .= "$header: $value\n";

[191] Fix | Delete

}

[192] Fix | Delete

return $exported;

[193] Fix | Delete

}

[194] Fix | Delete

[195] Fix | Delete

/**

[196] Fix | Delete

* @param int $magic

[197] Fix | Delete

* @return string|false

[198] Fix | Delete

*/

[199] Fix | Delete

public function get_byteorder( $magic ) {

[200] Fix | Delete

// The magic is 0x950412de.

[201] Fix | Delete

[202] Fix | Delete

// bug in PHP 5.0.2, see https://savannah.nongnu.org/bugs/?func=detailitem&item_id=10565

[203] Fix | Delete

$magic_little = (int) - 1794895138;

[204] Fix | Delete

$magic_little_64 = (int) 2500072158;

[205] Fix | Delete

// 0xde120495

[206] Fix | Delete

$magic_big = ( (int) - 569244523 ) & 0xFFFFFFFF;

[207] Fix | Delete

if ( $magic_little === $magic || $magic_little_64 === $magic ) {

[208] Fix | Delete

return 'little';

[209] Fix | Delete

} elseif ( $magic_big === $magic ) {

[210] Fix | Delete

return 'big';

[211] Fix | Delete

} else {

[212] Fix | Delete

return false;

[213] Fix | Delete

}

[214] Fix | Delete

}

[215] Fix | Delete

[216] Fix | Delete

/**

[217] Fix | Delete

* @param POMO_FileReader $reader

[218] Fix | Delete

* @return bool True if the import was successful, otherwise false.

[219] Fix | Delete

*/

[220] Fix | Delete

public function import_from_reader( $reader ) {

[221] Fix | Delete

$endian_string = MO::get_byteorder( $reader->readint32() );

[222] Fix | Delete

if ( false === $endian_string ) {

[223] Fix | Delete

return false;

[224] Fix | Delete

}

[225] Fix | Delete

$reader->setEndian( $endian_string );

[226] Fix | Delete

[227] Fix | Delete

$endian = ( 'big' === $endian_string ) ? 'N' : 'V';

[228] Fix | Delete

[229] Fix | Delete

$header = $reader->read( 24 );

[230] Fix | Delete

if ( $reader->strlen( $header ) !== 24 ) {

[231] Fix | Delete

return false;

[232] Fix | Delete

}

[233] Fix | Delete

[234] Fix | Delete

// Parse header.

[235] Fix | Delete

$header = unpack( "{$endian}revision/{$endian}total/{$endian}originals_lengths_addr/{$endian}translations_lengths_addr/{$endian}hash_length/{$endian}hash_addr", $header );

[236] Fix | Delete

if ( ! is_array( $header ) ) {

[237] Fix | Delete

return false;

[238] Fix | Delete

}

[239] Fix | Delete

[240] Fix | Delete

// Support revision 0 of MO format specs, only.

[241] Fix | Delete

if ( 0 !== $header['revision'] ) {

[242] Fix | Delete

return false;

[243] Fix | Delete

}

[244] Fix | Delete

[245] Fix | Delete

// Seek to data blocks.

[246] Fix | Delete

$reader->seekto( $header['originals_lengths_addr'] );

[247] Fix | Delete

[248] Fix | Delete

// Read originals' indices.

[249] Fix | Delete

$originals_lengths_length = $header['translations_lengths_addr'] - $header['originals_lengths_addr'];

[250] Fix | Delete

if ( $originals_lengths_length !== $header['total'] * 8 ) {

[251] Fix | Delete

return false;

[252] Fix | Delete

}

[253] Fix | Delete

[254] Fix | Delete

$originals = $reader->read( $originals_lengths_length );

[255] Fix | Delete

if ( $reader->strlen( $originals ) !== $originals_lengths_length ) {

[256] Fix | Delete

return false;

[257] Fix | Delete

}

[258] Fix | Delete

[259] Fix | Delete

// Read translations' indices.

[260] Fix | Delete

$translations_lengths_length = $header['hash_addr'] - $header['translations_lengths_addr'];

[261] Fix | Delete

if ( $translations_lengths_length !== $header['total'] * 8 ) {

[262] Fix | Delete

return false;

[263] Fix | Delete

}

[264] Fix | Delete

[265] Fix | Delete

$translations = $reader->read( $translations_lengths_length );

[266] Fix | Delete

if ( $reader->strlen( $translations ) !== $translations_lengths_length ) {

[267] Fix | Delete

return false;

[268] Fix | Delete

}

[269] Fix | Delete

[270] Fix | Delete

// Transform raw data into set of indices.

[271] Fix | Delete

$originals = $reader->str_split( $originals, 8 );

[272] Fix | Delete

$translations = $reader->str_split( $translations, 8 );

[273] Fix | Delete

[274] Fix | Delete

// Skip hash table.

[275] Fix | Delete

$strings_addr = $header['hash_addr'] + $header['hash_length'] * 4;

[276] Fix | Delete

[277] Fix | Delete

$reader->seekto( $strings_addr );

[278] Fix | Delete

[279] Fix | Delete

$strings = $reader->read_all();

[280] Fix | Delete

$reader->close();

[281] Fix | Delete

[282] Fix | Delete

for ( $i = 0; $i < $header['total']; $i++ ) {

[283] Fix | Delete

$o = unpack( "{$endian}length/{$endian}pos", $originals[ $i ] );

[284] Fix | Delete

$t = unpack( "{$endian}length/{$endian}pos", $translations[ $i ] );

[285] Fix | Delete

if ( ! $o || ! $t ) {

[286] Fix | Delete

return false;

[287] Fix | Delete

}

[288] Fix | Delete

[289] Fix | Delete

// Adjust offset due to reading strings to separate space before.

[290] Fix | Delete

$o['pos'] -= $strings_addr;

[291] Fix | Delete

$t['pos'] -= $strings_addr;

[292] Fix | Delete

[293] Fix | Delete

$original = $reader->substr( $strings, $o['pos'], $o['length'] );

[294] Fix | Delete

$translation = $reader->substr( $strings, $t['pos'], $t['length'] );

[295] Fix | Delete

[296] Fix | Delete

if ( '' === $original ) {

[297] Fix | Delete

$this->set_headers( $this->make_headers( $translation ) );

[298] Fix | Delete

} else {

[299] Fix | Delete

$entry = &$this->make_entry( $original, $translation );

[300] Fix | Delete

$this->entries[ $entry->key() ] = &$entry;

[301] Fix | Delete

}

[302] Fix | Delete

}

[303] Fix | Delete

return true;

[304] Fix | Delete

}

[305] Fix | Delete

[306] Fix | Delete

/**

[307] Fix | Delete

* Build a Translation_Entry from original string and translation strings,

[308] Fix | Delete

* found in a MO file

[309] Fix | Delete

*

[310] Fix | Delete

* @static

[311] Fix | Delete

* @param string $original original string to translate from MO file. Might contain

[312] Fix | Delete

* 0x04 as context separator or 0x00 as singular/plural separator

[313] Fix | Delete

* @param string $translation translation string from MO file. Might contain

[314] Fix | Delete

* 0x00 as a plural translations separator

[315] Fix | Delete

* @return Translation_Entry Entry instance.

[316] Fix | Delete

*/

[317] Fix | Delete

public function &make_entry( $original, $translation ) {

[318] Fix | Delete

$entry = new Translation_Entry();

[319] Fix | Delete

// Look for context, separated by \4.

[320] Fix | Delete

$parts = explode( "\4", $original );

[321] Fix | Delete

if ( isset( $parts[1] ) ) {

[322] Fix | Delete

$original = $parts[1];

[323] Fix | Delete

$entry->context = $parts[0];

[324] Fix | Delete

}

[325] Fix | Delete

// Look for plural original.

[326] Fix | Delete

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

[327] Fix | Delete

$entry->singular = $parts[0];

[328] Fix | Delete

if ( isset( $parts[1] ) ) {

[329] Fix | Delete

$entry->is_plural = true;

[330] Fix | Delete

$entry->plural = $parts[1];

[331] Fix | Delete

}

[332] Fix | Delete

// Plural translations are also separated by \0.

[333] Fix | Delete

$entry->translations = explode( "\0", $translation );

[334] Fix | Delete

return $entry;

[335] Fix | Delete

}

[336] Fix | Delete

[337] Fix | Delete

/**

[338] Fix | Delete

* @param int $count

[339] Fix | Delete

* @return string

[340] Fix | Delete

*/

[341] Fix | Delete

public function select_plural_form( $count ) {

[342] Fix | Delete

return $this->gettext_select_plural_form( $count );

[343] Fix | Delete

}

[344] Fix | Delete

[345] Fix | Delete

/**

[346] Fix | Delete

* @return int

[347] Fix | Delete

*/

[348] Fix | Delete

public function get_plural_forms_count() {

[349] Fix | Delete

return $this->_nplurals;

[350] Fix | Delete

}

[351] Fix | Delete

}

[352] Fix | Delete

endif;

[353] Fix | Delete

[354] Fix | Delete