WordPress 4.6.3-scripts
[autoinstalls/wordpress.git] / wp-includes / pomo / mo.php
index 68c0792fdcf58855d330c559322cefa66106d08f..6bc44d614d69c899078889a62f8035ae44f8131e 100644 (file)
@@ -2,7 +2,7 @@
 /**
  * Class for working with MO files
  *
- * @version $Id: mo.php 718 2012-10-31 00:32:02Z nbachiyski $
+ * @version $Id: mo.php 1157 2015-11-20 04:30:11Z dd32 $
  * @package pomo
  * @subpackage mo
  */
@@ -10,7 +10,7 @@
 require_once dirname(__FILE__) . '/translations.php';
 require_once dirname(__FILE__) . '/streams.php';
 
-if ( !class_exists( 'MO' ) ):
+if ( ! class_exists( 'MO', false ) ):
 class MO extends Gettext_Translations {
 
        var $_nplurals = 2;
@@ -27,6 +27,10 @@ class MO extends Gettext_Translations {
                return $this->import_from_reader($reader);
        }
 
+       /**
+        * @param string $filename
+        * @return bool
+        */
        function export_to_file($filename) {
                $fh = fopen($filename, 'wb');
                if ( !$fh ) return false;
@@ -35,6 +39,9 @@ class MO extends Gettext_Translations {
                return $res;
        }
 
+       /**
+        * @return string|false
+        */
        function export() {
                $tmp_fh = fopen("php://temp", 'r+');
                if ( !$tmp_fh ) return false;
@@ -43,6 +50,10 @@ class MO extends Gettext_Translations {
                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;
@@ -55,6 +66,10 @@ class MO extends Gettext_Translations {
                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);
@@ -75,21 +90,23 @@ class MO extends Gettext_Translations {
                $current_addr++;
                $originals_table = chr(0);
 
+               $reader = new POMO_Reader();
+
                foreach($entries as $entry) {
                        $originals_table .= $this->export_original($entry) . chr(0);
-                       $length = strlen($this->export_original($entry));
+                       $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', strlen($exported_headers), $current_addr));
+               fwrite($fh, pack('VV', $reader->strlen($exported_headers), $current_addr));
                $current_addr += strlen($exported_headers) + 1;
                $translations_table = $exported_headers . chr(0);
 
                foreach($entries as $entry) {
                        $translations_table .= $this->export_translations($entry) . chr(0);
-                       $length = strlen($this->export_translations($entry));
+                       $length = $reader->strlen($this->export_translations($entry));
                        fwrite($fh, pack('VV', $length, $current_addr));
                        $current_addr += $length + 1;
                }
@@ -99,19 +116,30 @@ class MO extends Gettext_Translations {
                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 .= chr(0).$entry->plural;
-               if (!is_null($entry->context)) $exported = $entry->context . chr(4) . $exported;
+               if ($entry->context) $exported = $entry->context . chr(4) . $exported;
                return $exported;
        }
 
+       /**
+        * @param Translation_Entry $entry
+        * @return string
+        */
        function export_translations($entry) {
                //TODO: warnings for control characters
-               return implode(chr(0), $entry->translations);
+               return $entry->is_plural ? implode(chr(0), $entry->translations) : $entry->translations[0];
        }
 
+       /**
+        * @return string
+        */
        function export_headers() {
                $exported = '';
                foreach($this->headers as $header => $value) {
@@ -120,6 +148,10 @@ class MO extends Gettext_Translations {
                return $exported;
        }
 
+       /**
+        * @param int $magic
+        * @return string|false
+        */
        function get_byteorder($magic) {
                // The magic is 0x950412de
 
@@ -137,6 +169,9 @@ class MO extends Gettext_Translations {
                }
        }
 
+       /**
+        * @param POMO_FileReader $reader
+        */
        function import_from_reader($reader) {
                $endian_string = MO::get_byteorder($reader->readint32());
                if (false === $endian_string) {
@@ -155,46 +190,49 @@ class MO extends Gettext_Translations {
                if (!is_array($header))
                        return false;
 
-               extract( $header );
-
                // support revision 0 of MO format specs, only
-               if ($revision != 0)
+               if ( $header['revision'] != 0 ) {
                        return false;
+               }
 
                // seek to data blocks
-               $reader->seekto($originals_lenghts_addr);
+               $reader->seekto( $header['originals_lenghts_addr'] );
 
                // read originals' indices
-               $originals_lengths_length = $translations_lenghts_addr - $originals_lenghts_addr;
-               if ( $originals_lengths_length != $total * 8 )
+               $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 )
+               if ( $reader->strlen( $originals ) != $originals_lengths_length ) {
                        return false;
+               }
 
                // read translations' indices
-               $translations_lenghts_length = $hash_addr - $translations_lenghts_addr;
-               if ( $translations_lenghts_length != $total * 8 )
+               $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 )
+               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 = $hash_addr + $hash_length * 4;
+               $strings_addr = $header['hash_addr'] + $header['hash_length'] * 4;
 
                $reader->seekto($strings_addr);
 
                $strings = $reader->read_all();
                $reader->close();
 
-               for ( $i = 0; $i < $total; $i++ ) {
+               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;
@@ -246,10 +284,17 @@ class MO extends Gettext_Translations {
                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;
        }