Merge branch 'feature/i18n'

src/Exception/ExceptionInterface.php

@@ -0,0 +1,32 @@
+<?php
+/**
+ * Zend Framework
+ *
+ * LICENSE
+ *
+ * This source file is subject to the new BSD license that is bundled
+ * with this package in the file LICENSE.txt.
+ * It is also available through the world-wide-web at this URL:
+ * http://framework.zend.com/license/new-bsd
+ * If you did not receive a copy of the license and are unable to
+ * obtain it through the world-wide-web, please send an email
+ * to [email protected] so we can send you a copy immediately.
+ *
+ * @category   Zend
+ * @package    Zend_I18n
+ * @subpackage Translator
+ * @copyright  Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license    http://framework.zend.com/license/new-bsd     New BSD License
+ */
+
+namespace Zend\I18n\Exception;
+
+/**
+ * @category   Zend
+ * @package    Zend_I18n
+ * @subpackage Translator
+ * @copyright  Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license    http://framework.zend.com/license/new-bsd     New BSD License
+ */
+interface ExceptionInterface
+{}

src/Exception/InvalidArgumentException.php

@@ -0,0 +1,33 @@
+<?php
+/**
+ * Zend Framework
+ *
+ * LICENSE
+ *
+ * This source file is subject to the new BSD license that is bundled
+ * with this package in the file LICENSE.txt.
+ * It is also available through the world-wide-web at this URL:
+ * http://framework.zend.com/license/new-bsd
+ * If you did not receive a copy of the license and are unable to
+ * obtain it through the world-wide-web, please send an email
+ * to [email protected] so we can send you a copy immediately.
+ *
+ * @category   Zend
+ * @package    Zend_I18n
+ * @subpackage Translator
+ * @copyright  Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license    http://framework.zend.com/license/new-bsd     New BSD License
+ */
+
+namespace Zend\I18n\Exception;
+
+/**
+ * @category   Zend
+ * @package    Zend_I18n
+ * @subpackage Translator
+ * @copyright  Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license    http://framework.zend.com/license/new-bsd     New BSD License
+ */
+class InvalidArgumentException extends \InvalidArgumentException implements 
+    ExceptionInterface
+{}

src/Exception/OutOfBoundsException.php

@@ -0,0 +1,33 @@
+<?php
+/**
+ * Zend Framework
+ *
+ * LICENSE
+ *
+ * This source file is subject to the new BSD license that is bundled
+ * with this package in the file LICENSE.txt.
+ * It is also available through the world-wide-web at this URL:
+ * http://framework.zend.com/license/new-bsd
+ * If you did not receive a copy of the license and are unable to
+ * obtain it through the world-wide-web, please send an email
+ * to [email protected] so we can send you a copy immediately.
+ *
+ * @category   Zend
+ * @package    Zend_I18n
+ * @subpackage Translator
+ * @copyright  Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license    http://framework.zend.com/license/new-bsd     New BSD License
+ */
+
+namespace Zend\I18n\Exception;
+
+/**
+ * @category   Zend
+ * @package    Zend_I18n
+ * @subpackage Translator
+ * @copyright  Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license    http://framework.zend.com/license/new-bsd     New BSD License
+ */
+class OutOfBoundsException extends \OutOfBoundsException implements 
+    ExceptionInterface
+{}

src/Exception/ParseException.php

@@ -0,0 +1,32 @@
+<?php
+/**
+ * Zend Framework
+ *
+ * LICENSE
+ *
+ * This source file is subject to the new BSD license that is bundled
+ * with this package in the file LICENSE.txt.
+ * It is also available through the world-wide-web at this URL:
+ * http://framework.zend.com/license/new-bsd
+ * If you did not receive a copy of the license and are unable to
+ * obtain it through the world-wide-web, please send an email
+ * to [email protected] so we can send you a copy immediately.
+ *
+ * @category   Zend
+ * @package    Zend_I18n
+ * @subpackage Translator
+ * @copyright  Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license    http://framework.zend.com/license/new-bsd     New BSD License
+ */
+
+namespace Zend\I18n\Exception;
+
+/**
+ * @category   Zend
+ * @package    Zend_I18n
+ * @subpackage Translator
+ * @copyright  Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license    http://framework.zend.com/license/new-bsd     New BSD License
+ */
+class ParseException extends RuntimeException implements ExceptionInterface
+{}

src/Exception/RangeException.php

@@ -0,0 +1,32 @@
+<?php
+/**
+ * Zend Framework
+ *
+ * LICENSE
+ *
+ * This source file is subject to the new BSD license that is bundled
+ * with this package in the file LICENSE.txt.
+ * It is also available through the world-wide-web at this URL:
+ * http://framework.zend.com/license/new-bsd
+ * If you did not receive a copy of the license and are unable to
+ * obtain it through the world-wide-web, please send an email
+ * to [email protected] so we can send you a copy immediately.
+ *
+ * @category   Zend
+ * @package    Zend_I18n
+ * @subpackage Translator
+ * @copyright  Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license    http://framework.zend.com/license/new-bsd     New BSD License
+ */
+
+namespace Zend\I18n\Exception;
+
+/**
+ * @category   Zend
+ * @package    Zend_I18n
+ * @subpackage Translator
+ * @copyright  Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license    http://framework.zend.com/license/new-bsd     New BSD License
+ */
+class RangeException extends \RangeException implements ExceptionInterface
+{}

src/Exception/RuntimeEception.php

@@ -0,0 +1,32 @@
+<?php
+/**
+ * Zend Framework
+ *
+ * LICENSE
+ *
+ * This source file is subject to the new BSD license that is bundled
+ * with this package in the file LICENSE.txt.
+ * It is also available through the world-wide-web at this URL:
+ * http://framework.zend.com/license/new-bsd
+ * If you did not receive a copy of the license and are unable to
+ * obtain it through the world-wide-web, please send an email
+ * to [email protected] so we can send you a copy immediately.
+ *
+ * @category   Zend
+ * @package    Zend_I18n
+ * @subpackage Translator
+ * @copyright  Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license    http://framework.zend.com/license/new-bsd     New BSD License
+ */
+
+namespace Zend\I18n\Exception;
+
+/**
+ * @category   Zend
+ * @package    Zend_I18n
+ * @subpackage Translator
+ * @copyright  Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license    http://framework.zend.com/license/new-bsd     New BSD License
+ */
+class RuntimeException extends \RuntimeException implements ExceptionInterface
+{}

src/Translator/Loader/Gettext.php

@@ -0,0 +1,194 @@
+<?php
+/**
+ * Zend Framework
+ *
+ * LICENSE
+ *
+ * This source file is subject to the new BSD license that is bundled
+ * with this package in the file LICENSE.txt.
+ * It is also available through the world-wide-web at this URL:
+ * http://framework.zend.com/license/new-bsd
+ * If you did not receive a copy of the license and are unable to
+ * obtain it through the world-wide-web, please send an email
+ * to [email protected] so we can send you a copy immediately.
+ *
+ * @category   Zend
+ * @package    Zend_I18n
+ * @subpackage Translator
+ * @copyright  Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license    http://framework.zend.com/license/new-bsd     New BSD License
+ */
+
+namespace Zend\I18n\Translator\Loader;
+
+use Zend\I18n\Exception;
+use Zend\I18n\Translator\TextDomain;
+use Zend\I18n\Translator\Plural\Rule as PluralRule;
+
+/**
+ * Gettext loader.
+ *
+ * @category   Zend
+ * @package    Zend_I18n
+ * @subpackage Translator
+ * @copyright  Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license    http://framework.zend.com/license/new-bsd     New BSD License
+ */
+class Gettext implements LoaderInterface
+{
+    /**
+     * Current file pointer.
+     *
+     * @var resource
+     */
+    protected $file;
+
+    /**
+     * Whether the current file is little endian.
+     *
+     * @var boolean
+     */
+    protected $littleEndian;
+
+    /**
+     * load(): defined by LoaderInterface.
+     *
+     * @see    LoaderInterface::load()
+     * @param  string $filename
+     * @param  string $locale
+     * @return TextDomain|null
+     */
+    public function load($filename, $locale)
+    {
+        $textDomain = new TextDomain();
+        $this->file = @fopen($filename, 'rb');
+
+        if (!$this->file) {
+            throw new Exception\InvalidArgumentException(
+                sprintf('Could not open file %s for reading', $filename)
+            );
+        }
+
+        // Verify magic number
+        $magic = fread($this->file, 4);
+
+        if ($magic === "\x95\x04\x12\xde") {
+            $this->littleEndian = true;
+        } elseif ($magic === "\xde\x12\x04\x95") {
+            $this->littleEndian = false;
+        } else {
+            fclose($this->file);
+            throw new Exception\InvalidArgumentException(
+                sprintf('%s is not a valid gettext file', $filename)
+            );
+        }
+
+        // Verify major revision (only 0 and 1 supported)
+        $majorRevision = ($this->readInteger() >> 16);
+
+        if ($majorRevision !== 0 && $majorRevision !== 1) {
+            fclose($this->file);
+            throw new Exception\InvalidArgumentException(
+                sprintf('%s has an unknown major revision', $filename)
+            );
+        }
+
+        // Gather main information
+        $numStrings                   = $this->readInteger();
+        $originalStringTableOffset    = $this->readInteger();
+        $translationStringTableOffset = $this->readInteger();
+
+        // Usually there follow size and offset of the hash table, but we have
+        // no need for it, so we skip them.
+        fseek($originalStringTableOffset);
+        $originalStringTable = $this->readIntegerList(2 * $numStrings);
+
+        fseek($translationStringTableOffset);
+        $translationStringTable = $this->readIntegerList(2 * $numStrings);
+
+        // Read in all translations
+        for ($current = 0; $current < $numStrings; $current++) {
+            $sizeKey                 = $current * 2 + 1;
+            $offsetKey               = $current * 2 + 2;
+            $originalStringSize      = $originalStringTable[$sizeKey];
+            $originalStringOffset    = $originalStringTable[$offsetKey];
+            $translationStringSize   = $translationStringTable[$sizeKey];
+            $translationStringOffset = $translationStringTable[$offsetKey];
+
+            $originalString = array('');
+            if ($originalStringSize > 0) {
+                fseek($originalStringOffset);
+                $originalString = explode("\0", fread($this->file, $originalStringSize));
+            }
+
+            if ($translationStringSize > 0) {
+                fseek($translationStringOffset);
+                $translationString = explode("\0", fread($this->file, $translationStringSize));
+
+                if (count($originalString) > 1 && count($translationString) > 1) {
+                    $textDomain[$original[0]] = $translationString;
+
+                    array_shift($originalString);
+
+                    foreach ($originalString as $string) {
+                        $textDomain[$string] = '';
+                    }
+                } else {
+                    $textDomain[$original[0]] = $translationString[0];
+                }
+            }
+        }
+
+        // Read header entries
+        if (array_key_exists('', $textDomain)) {
+            $rawHeaders = explode("\n", $textDomain['']);
+
+            foreach ($rawHeaders as $rawHeader) {
+                list($header, $content) = explode(':', $rawHeader, 1);
+
+                if (trim(strtolower($header)) === 'plural-forms') {
+                    $textDomain->pluralRule(
+                        PluralRule::fromString($content)
+                    );
+                }
+            }
+
+            unset($textDomain['']);
+        }
+
+        fclose($this->file);
+
+        return $textDomain;
+    }
+
+    /**
+     * Read a single integer from the current file.
+     *
+     * @return integer
+     */
+    protected function readInteger()
+    {
+        if ($this->littleEndian) {
+            $result = unpack('Vint', fread($this->file, 4));
+        } else {
+            $result = unpack('Nint', fread($this->file, 4));
+        }
+
+        return $result['int'];
+    }
+
+    /**
+     * Read an integer from the current file.
+     *
+     * @param  integer $num
+     * @return integer
+     */
+    protected function readIntegerList($num)
+    {
+        if ($this->littleEndian) {
+            return unpack('V' . $num, fread($this->file, 4 * $num));
+        } else {
+            return unpack('N' . $num, fread($this->file, 4 * $num));
+        }
+    }
+}