MO

Contents

Description Description

Source Source

File: wp-includes/pomo/mo.php

14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
class MO extends Gettext_Translations {
 
    var $_nplurals = 2;
 
    /**
     * Loaded MO file.
     *
     * @var string
     */
    private $filename = '';
 
    /**
     * Returns the loaded MO file.
     *
     * @return string The loaded MO file.
     */
    public function get_filename() {
        return $this->filename;
    }
 
    /**
     * Fills up with the entries from MO file $filename
     *
     * @param string $filename MO file to load
     * @return bool True if the import from file was successful, otherwise false.
     */
    function import_from_file( $filename ) {
        $reader = new POMO_FileReader( $filename );
 
        if ( ! $reader->is_resource() ) {
            return false;
        }
 
        $this->filename = (string) $filename;
 
        return $this->import_from_reader( $reader );
    }
 
    /**
     * @param string $filename
     * @return bool
     */
    function export_to_file( $filename ) {
        $fh = fopen( $filename, 'wb' );
        if ( ! $fh ) {
            return false;
        }
        $res = $this->export_to_file_handle( $fh );
        fclose( $fh );
        return $res;
    }
 
    /**
     * @return string|false
     */
    function export() {
        $tmp_fh = fopen( 'php://temp', 'r+' );
        if ( ! $tmp_fh ) {
            return false;
        }
        $this->export_to_file_handle( $tmp_fh );
        rewind( $tmp_fh );
        return stream_get_contents( $tmp_fh );
    }
 
    /**
     * @param Translation_Entry $entry
     * @return bool
     */
    function is_entry_good_for_export( $entry ) {
        if ( empty( $entry->translations ) ) {
            return false;
        }
 
        if ( ! array_filter( $entry->translations ) ) {
            return false;
        }
 
        return true;
    }
 
    /**
     * @param resource $fh
     * @return true
     */
    function export_to_file_handle( $fh ) {
        $entries = array_filter( $this->entries, array( $this, 'is_entry_good_for_export' ) );
        ksort( $entries );
        $magic                     = 0x950412de;
        $revision                  = 0;
        $total                     = count( $entries ) + 1; // all the headers are one entry
        $originals_lenghts_addr    = 28;
        $translations_lenghts_addr = $originals_lenghts_addr + 8 * $total;
        $size_of_hash              = 0;
        $hash_addr                 = $translations_lenghts_addr + 8 * $total;
        $current_addr              = $hash_addr;
        fwrite(
            $fh,
            pack(
                'V*',
                $magic,
                $revision,
                $total,
                $originals_lenghts_addr,
                $translations_lenghts_addr,
                $size_of_hash,
                $hash_addr
            )
        );
        fseek( $fh, $originals_lenghts_addr );
 
        // headers' msgid is an empty string
        fwrite( $fh, pack( 'VV', 0, $current_addr ) );
        $current_addr++;
        $originals_table = "\0";
 
        $reader = new POMO_Reader();
 
        foreach ( $entries as $entry ) {
            $originals_table .= $this->export_original( $entry ) . "\0";
            $length           = $reader->strlen( $this->export_original( $entry ) );
            fwrite( $fh, pack( 'VV', $length, $current_addr ) );
            $current_addr += $length + 1; // account for the NULL byte after
        }
 
        $exported_headers = $this->export_headers();
        fwrite( $fh, pack( 'VV', $reader->strlen( $exported_headers ), $current_addr ) );
        $current_addr      += strlen( $exported_headers ) + 1;
        $translations_table = $exported_headers . "\0";
 
        foreach ( $entries as $entry ) {
            $translations_table .= $this->export_translations( $entry ) . "\0";
            $length              = $reader->strlen( $this->export_translations( $entry ) );
            fwrite( $fh, pack( 'VV', $length, $current_addr ) );
            $current_addr += $length + 1;
        }
 
        fwrite( $fh, $originals_table );
        fwrite( $fh, $translations_table );
        return true;
    }
 
    /**
     * @param Translation_Entry $entry
     * @return string
     */
    function export_original( $entry ) {
        //TODO: warnings for control characters
        $exported = $entry->singular;
        if ( $entry->is_plural ) {
            $exported .= "\0" . $entry->plural;
        }
        if ( $entry->context ) {
            $exported = $entry->context . "\4" . $exported;
        }
        return $exported;
    }
 
    /**
     * @param Translation_Entry $entry
     * @return string
     */
    function export_translations( $entry ) {
        //TODO: warnings for control characters
        return $entry->is_plural ? implode( "\0", $entry->translations ) : $entry->translations[0];
    }
 
    /**
     * @return string
     */
    function export_headers() {
        $exported = '';
        foreach ( $this->headers as $header => $value ) {
            $exported .= "$header: $value\n";
        }
        return $exported;
    }
 
    /**
     * @param int $magic
     * @return string|false
     */
    function get_byteorder( $magic ) {
        // The magic is 0x950412de
 
        // bug in PHP 5.0.2, see https://savannah.nongnu.org/bugs/?func=detailitem&item_id=10565
        $magic_little    = (int) - 1794895138;
        $magic_little_64 = (int) 2500072158;
        // 0xde120495
        $magic_big = ( (int) - 569244523 ) & 0xFFFFFFFF;
        if ( $magic_little == $magic || $magic_little_64 == $magic ) {
            return 'little';
        } elseif ( $magic_big == $magic ) {
            return 'big';
        } else {
            return false;
        }
    }
 
    /**
     * @param POMO_FileReader $reader
     * @return bool True if the import was successful, otherwise false.
     */
    function import_from_reader( $reader ) {
        $endian_string = MO::get_byteorder( $reader->readint32() );
        if ( false === $endian_string ) {
            return false;
        }
        $reader->setEndian( $endian_string );
 
        $endian = ( 'big' == $endian_string ) ? 'N' : 'V';
 
        $header = $reader->read( 24 );
        if ( $reader->strlen( $header ) != 24 ) {
            return false;
        }
 
        // parse header
        $header = unpack( "{$endian}revision/{$endian}total/{$endian}originals_lenghts_addr/{$endian}translations_lenghts_addr/{$endian}hash_length/{$endian}hash_addr", $header );
        if ( ! is_array( $header ) ) {
            return false;
        }
 
        // support revision 0 of MO format specs, only
        if ( $header['revision'] != 0 ) {
            return false;
        }
 
        // seek to data blocks
        $reader->seekto( $header['originals_lenghts_addr'] );
 
        // read originals' indices
        $originals_lengths_length = $header['translations_lenghts_addr'] - $header['originals_lenghts_addr'];
        if ( $originals_lengths_length != $header['total'] * 8 ) {
            return false;
        }
 
        $originals = $reader->read( $originals_lengths_length );
        if ( $reader->strlen( $originals ) != $originals_lengths_length ) {
            return false;
        }
 
        // read translations' indices
        $translations_lenghts_length = $header['hash_addr'] - $header['translations_lenghts_addr'];
        if ( $translations_lenghts_length != $header['total'] * 8 ) {
            return false;
        }
 
        $translations = $reader->read( $translations_lenghts_length );
        if ( $reader->strlen( $translations ) != $translations_lenghts_length ) {
            return false;
        }
 
        // transform raw data into set of indices
        $originals    = $reader->str_split( $originals, 8 );
        $translations = $reader->str_split( $translations, 8 );
 
        // skip hash table
        $strings_addr = $header['hash_addr'] + $header['hash_length'] * 4;
 
        $reader->seekto( $strings_addr );
 
        $strings = $reader->read_all();
        $reader->close();
 
        for ( $i = 0; $i < $header['total']; $i++ ) {
            $o = unpack( "{$endian}length/{$endian}pos", $originals[ $i ] );
            $t = unpack( "{$endian}length/{$endian}pos", $translations[ $i ] );
            if ( ! $o || ! $t ) {
                return false;
            }
 
            // adjust offset due to reading strings to separate space before
            $o['pos'] -= $strings_addr;
            $t['pos'] -= $strings_addr;
 
            $original    = $reader->substr( $strings, $o['pos'], $o['length'] );
            $translation = $reader->substr( $strings, $t['pos'], $t['length'] );
 
            if ( '' === $original ) {
                $this->set_headers( $this->make_headers( $translation ) );
            } else {
                $entry                          = &$this->make_entry( $original, $translation );
                $this->entries[ $entry->key() ] = &$entry;
            }
        }
        return true;
    }
 
    /**
     * Build a Translation_Entry from original string and translation strings,
     * found in a MO file
     *
     * @static
     * @param string $original original string to translate from MO file. Might contain
     *  0x04 as context separator or 0x00 as singular/plural separator
     * @param string $translation translation string from MO file. Might contain
     *  0x00 as a plural translations separator
     * @return Translation_Entry Entry instance.
     */
    function &make_entry( $original, $translation ) {
        $entry = new Translation_Entry();
        // Look for context, separated by \4.
        $parts = explode( "\4", $original );
        if ( isset( $parts[1] ) ) {
            $original       = $parts[1];
            $entry->context = $parts[0];
        }
        // look for plural original
        $parts           = explode( "\0", $original );
        $entry->singular = $parts[0];
        if ( isset( $parts[1] ) ) {
            $entry->is_plural = true;
            $entry->plural    = $parts[1];
        }
        // plural translations are also separated by \0
        $entry->translations = explode( "\0", $translation );
        return $entry;
    }
 
    /**
     * @param int $count
     * @return string
     */
    function select_plural_form( $count ) {
        return $this->gettext_select_plural_form( $count );
    }
 
    /**
     * @return int
     */
    function get_plural_forms_count() {
        return $this->_nplurals;
    }
}

Expand full source code Collapse full source code View on Trac

Top ↑

Top ↑

Methods Methods

Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.