<?php
/* vim: set expandtab tabstop=4 shiftwidth=4: */
//  
//  Copyright (c) 2003 Laurent Bedubourg
//  
//  This library is free software; you can redistribute it and/or
//  modify it under the terms of the GNU Lesser General Public
//  License as published by the Free Software Foundation; either
//  version 2.1 of the License, or (at your option) any later version.
//  
//  This library is distributed in the hope that it will be useful,
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
//  Lesser General Public License for more details.
//  
//  You should have received a copy of the GNU Lesser General Public
//  License along with this library; if not, write to the Free Software
//  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//  
//  Authors: Laurent Bedubourg <laurent.bedubourg@free.fr>
//  

//require_once "PEAR.php";

define('GETTEXT_NATIVE', 1);
define('GETTEXT_PHP', 2);

/**
* Generic gettext static class.
*
* This class allows gettext usage with php even if the gettext support is 
* not compiled in php.
*
* The developper can choose between the GETTEXT_NATIVE support and the
* GETTEXT_PHP support on initialisation. If native is not supported, the
* system will fall back to PHP support.
*
* On both systems, this package add a variable interpolation system so you can
* translate entire dynamic sentences in stead of peace of sentences.
*
* Small example without pear error lookup :
* 
* <?php
* require_once "get_text.php";
*
* get_text::init();
* get_text::set_language('fr_Fr');      // may throw GetText_Error
* get_text::add_domain('myAppDomain');  // may throw GetText_Error
* get_text::set_var('login', $login);   
* get_text::set_var('name', $name);
* 
* // may throw GetText_Error
* echo get_text::gettext('Welcome ${name}, you\'re connected with login ${login}');
* 
* // should echo something like :
* //
* // "Bienvenue Jean-Claude, vous êtes connecté en tant qu'utilisateur jcaccount"
* // 
* // or if fr_FR translation does not exists
* //
* // "Welcome Jean-Claude, you're connected with login jcaccount"
* 
* ?>
*
* A gettext mini-howto should be provided with this package, if you're new 
* to gettext usage, please read it to learn how to build a gettext 
* translation directory (locale).
* 
* @todo    Tools to manage gettext files in php.
* 
*          - non traducted domains / keys
*          - modification of keys
*          - domain creation, preparation, delete, ...
*          - tool to extract required messages from TOF templates
*
* @version 0.5
* @author  Laurent Bedubourg <laurent.bedubourg@free.fr>
*/
class get_text
{
    /**
     * This method returns current gettext support class.
     *
     * @return GetText_Support
     * @static 1
     * @access private
     */
    function &_support($set=false)
    { 
        static $support_obj;
        if ($set !== false) 
        { 
            $support_obj = $set; 
        } 
        elseif (!isset($support_obj)) 
        {
            trigger_error("get_text not initialized !". endl.
            	"Please call get_text::init() before calling ".
                "any get_text function !" . endl , E_USER_ERROR);
        }
        return $support_obj;
    }
    
    /**
     * Initialize gettext package.
     *
     * This method instantiate the gettext support depending on managerType
     * value. 
     *
     * GETTEXT_NATIVE try to use gettext php support and fall back to PHP
     * support if not installed.
     *
     * GETTEXT_PHP explicitely request the usage of PHP support.
     *
     * @param  int $managerType
     *         Gettext support type.
     *         
     * @access public
     * @static 1
     */
    function init($managerType = GETTEXT_NATIVE)
    {
        if ($managerType == GETTEXT_NATIVE) 
        {
            if (function_exists('gettext')) 
            {
                return get_text::_support(new gettext_native_support());
            }
        }
        // fail back to php support 
        return get_text::_support(new gettext_php_support());
    }
    
    /**
     * Set the language to use for traduction.
     *
     * @param string $lang_code
     *        The language code usually defined as ll_CC, ll is the two letter
     *        language code and CC is the two letter country code.
     *
     * @throws GetText_Error if language is not supported by your system.
     */
    function set_language($lang_code, $encoding)
    {
        $support = &get_text::_support();
        return $support->set_language($lang_code, $encoding);
    }
    
    /**
     * Add a translation domain.
     *
     * The domain name is usually the name of the .po file you wish to use. 
     * For example, if you created a file 'lang/ll_CC/LC_MESSAGES/myapp.po',
     * you'll use 'myapp' as the domain name.
     *
     * @param string $domain
     *        The domain name.
     *
     * @param string $path optional
     *        The path to the locale directory (ie: /path/to/locale/) which
     *        contains ll_CC directories.
     */
    function add_domain($domain, $path=false)
    {
        $support =& get_text::_support();
        return $support->add_domain($domain, $path);
    }
    
    /**
     * Retrieve the translation for specified key.
     *
     * @param string $key
     *        String to translate using gettext support.
     */
    function gettext($key)
    { 
        $support = &get_text::_support();
        return $support->gettext($key);
    }
   
    /**
     * Add a variable to gettext interpolation system.
     *
     * @param string $key
     *        The variable name.
     *
     * @param string $value
     *        The variable value.
     */
    function set_var($key, $value)
    {
        $support =& get_text::_support();
        return $support->set_var($key, $value);
    }

    /**
     * Add an hashtable of variables.
     *
     * @param hashtable $hash 
     *        PHP associative array of variables.
     */
    function set_vars($hash)
    {
        $support =& get_text::_support();
        return $support->set_vars($hash);
    }

    /**
     * Reset interpolation variables.
     */
    function reset()
    {
        $support =& get_text::_support();
        return $support->reset();
    }
}

function raise_error($str) {
	//echo "$str";
	return 1;
}

function is_error($err) {
    return $err > 0;
}

/**
* Interface to gettext native support.
*
* @author Laurent Bedubourg <laurent.bedubourg@free.fr>
* @access private
*/
class gettext_native_support 
{
    var $_interpolation_vars = array();

    /**
     * Set gettext language code.
     * @throws GetText_Error
     */
    function set_language($lang_code, $encoding)
    {
        putenv("LANG=$lang_code");
        putenv("LC_ALL=$lang_code");
        putenv("LANGUAGE=$lang_code");
        
        //$set = setlocale(LC_ALL, "$lang_code");
        //$set = setlocale(LC_ALL, "$encoding");
        $set = setlocale(LC_ALL, "$lang_code.".".$encoding");
        setlocale(LC_NUMERIC, 'C'); // important for numeric presentation etc.
        if ($set === false) 
        {
            $str = sprintf('language code "%s", encoding "%s" not supported by your system',
                $lang_code, $encoding);
            //$err = new GetText_Error($str);
            //return PEAR::raise_error($err);
			return raise_error("1 " . $str);
        }
		//return 0;
    }
    
    /**
     * Add a translation domain.
     */
    function add_domain($domain, $path=false)
    {
        if ($path === false) 
        {
            bindtextdomain($domain, "./locale/");
        } 
        else 
        { 
            bindtextdomain($domain, $path);
        }
        //bind_textdomain_codeset($domain, $encoding);
        textdomain($domain);
    }
    
    /**
     * Retrieve translation for specified key.
     *
     * @access private
     */
    function _get_translation($key)
    {
        return gettext($key);
    }
    

    /**
     * Reset interpolation variables.
     */
    function reset()
    {
        $this->_interpolation_vars = array();
    }
    
    /**
     * Set an interpolation variable.
     */
    function set_var($key, $value)
    {
        $this->_interpolation_vars[$key] = $value;
    }

    /**
     * Set an associative array of interpolation variables.
     */
    function set_vars($hash)
    {
        $this->_interpolation_vars = array_merge($this->_interpolation_vars,
                                                $hash);
    }
    
    /**
     * Retrieve translation for specified key.
     *
     * @param  string $key  -- gettext msgid
     * @throws GetText_Error
     */
    function gettext($key)
    {
        $value = $this->_get_translation($key);
        if ($value === false) {
            $str = sprintf('Unable to locate gettext key "%s"', $key);
            //$err = new GetText_Error($str);
            //return PEAR::raise_error($err);
			return raise_error("2 " . $str);
        }
        
        while (preg_match('/\$\{(.*?)\}/sm', $value, $m)) {
            list($src, $var) = $m;

            // retrieve variable to interpolate in context, throw an exception
            // if not found.
            $var2 = $this->_get_var($var);
            if ($var2 === false) {
                $str = sprintf('Interpolation error, var "%s" not set', $var);
                //$err = new GetText_Error($str);
                //return PEAR::raise_error($err);
                return raise_error("3 " . $str);
            }
            $value = str_replace($src, $var2, $value);
        }
        return $value;
    }

    /**
     * Retrieve an interpolation variable value.
     * 
     * @return mixed
     * @access private
     */
    function _get_var($name)
    {
        if (!array_key_exists($name, $this->_interpolation_vars)) {
            return false;
        }
        return $this->_interpolation_vars[$name];
    }
}


/**
* Implementation of get_text support for PHP.
*
* This implementation is abble to cache .po files into php files returning the
* domain translation hashtable.
*
* @access private
* @author Laurent Bedubourg <laurent.bedubourg@free.fr>
*/
class gettext_php_support extends gettext_native_support
{
    var $_path     = 'locale/';
    var $_lang_code = false;
    var $_domains  = array();
    var $_end      = -1;
    var $_jobs     = array();

    /**
     * Set the translation domain.
     *
     * @param  string $lang_code -- language code
     * @throws GetText_Error
     */
    function set_language($lang_code, $encoding)
    {
        // if language already set, try to reload domains
        if ($this->_lang_code !== false and $this->_lang_code != $lang_code) 
        {
            foreach ($this->_domains as $domain) 
            {
                $this->_jobs[] = array($domain->name, $domain->path);
            }
            $this->_domains = array();
            $this->_end = -1;
        }
        
        $this->_lang_code = $lang_code;

        // this allow us to set the language code after 
        // domain list.
        while (count($this->_jobs) > 0) 
        {
            list($domain, $path) = array_shift($this->_jobs);
            $err = $this->add_domain($domain, $path);
            // error raised, break jobs
            /*if (PEAR::is_error($err)) {
                return $err;
            }*/
			if (is_error($err)) 
			{
                return $err;
            }            
        }
    }
    
    /**
     * Add a translation domain.
     *
     * @param string $domain        -- Domain name
     * @param string $path optional -- Repository path
     * @throws GetText_Error
     */
    function add_domain($domain, $path = "./locale/")
    {   
        if (array_key_exists($domain, $this->_domains)) 
        { 
            return; 
        }
        
        if (!$this->_lang_code) 
        { 
            $this->_jobs[] = array($domain, $path); 
            return;
        }

        $err = $this->_load_domain($domain, $path);
        if ($err != 0) 
        {
            return $err;
        }

        $this->_end++;
    }

    /**
     * Load a translation domain file.
     *
     * This method cache the translation hash into a php file unless
     * GETTEXT_NO_CACHE is defined.
     * 
     * @param  string $domain        -- Domain name
     * @param  string $path optional -- Repository
     * @throws GetText_Error
     * @access private
     */
    function _load_domain($domain, $path = "./locale")
    {
        $src_domain = $path . "/$this->_lang_code/LC_MESSAGES/$domain.po";
        $php_domain = $path . "/$this->_lang_code/LC_MESSAGES/$domain.php";
        
        if (!file_exists($src_domain)) 
        {
            $str = sprintf('Domain file "%s" not found.', $src_domain);
            //$err = new GetText_Error($str);
            //return PEAR::raise_error($err);
			return raise_error("4 " . $str);
        }
        
        $d = new gettext_domain();
        $d->name = $domain;
        $d->path = $path;
        
        if (!file_exists($php_domain) || (filemtime($php_domain) < filemtime($src_domain))) 
        {
            
            // parse and compile translation table
            $parser = new gettext_php_support_parser();
            $hash   = $parser->parse($src_domain);
            if (!defined('GETTEXT_NO_CACHE')) 
            {
                $comp = new gettext_php_support_compiler();
                $err  = $comp->compile($hash, $src_domain);
                /*if (PEAR::is_error($err)) { 
                    return $err; 
                }*/
    			if (is_error($err)) 
    			{
                    return $err;
                } 
            }
            $d->_keys = $hash;
        } 
        else 
        {
            $d->_keys = include $php_domain;
        }
        $this->_domains[] = &$d;
    }
    
    /**
     * Implementation of gettext message retrieval.
     */
    function _get_translation($key)
    {
        for ($i = $this->_end; $i >= 0; $i--) 
        {
            if ($this->_domains[$i]->has_key($key)) 
            {
                return $this->_domains[$i]->get($key);
            }
        }
        return $key;
    }
}

/**
* Class representing a domain file for a specified language.
*
* @access private
* @author Laurent Bedubourg <laurent.bedubourg@free.fr>
*/
class gettext_domain
{
    var $name;
    var $path;

    var $_keys = array();

    function has_key($key)
    {
        return array_key_exists($key, $this->_keys);
    }

    function get($key)
    {
        return $this->_keys[$key];
    }
}

/**
* This class is used to parse gettext '.po' files into php associative arrays.
*
* @access private
* @author Laurent Bedubourg <laurent.bedubourg@free.fr>
*/
class gettext_php_support_parser 
{
    var $_hash = array();
    var $_current_key;
    var $_current_value;
    
    /**
     * Parse specified .po file.
     *
     * @return hashtable
     * @throws GetText_Error
     */
    function parse($file)
    {
        $this->_hash = array();
        $this->_current_key = false;
        $this->_current_value = "";
        
        if (!file_exists($file)) 
        {
            $str = sprintf('Unable to locate file "%s"', $file);
            //$err = new GetText_Error($str);
            //return PEAR::raise_error($err);
			return raise_error($str);
        }
        $i = 0;
        $lines = file($file);
        foreach ($lines as $line) 
        {
            $this->_parse_line($line, ++$i);
        }
        $this->_store_key();

        return $this->_hash;
    }

    /**
     * Parse one po line.
     *
     * @access private
     */
    function _parse_line($line, $nbr)
    {
        if (preg_match('/^\s*?#/', $line)) { return; }
        if (preg_match('/^\s*?msgid \"(.*?)(?!<\\\)\"/', $line, $m)) {
            $this->_store_key();
            $this->_current_key = $m[1];
            return;
        }
        if (preg_match('/^\s*?msgstr \"(.*?)(?!<\\\)\"/', $line, $m)) {
            $this->_current_value .= $m[1];
            return;
        }
        if (preg_match('/^\s*?\"(.*?)(?!<\\\)\"/', $line, $m)) {
            $this->_current_value .= $m[1];
            return;
        }
    }

    /**
     * Store last key/value pair into building hashtable.
     *
     * @access private
     */
    function _store_key()
    {
        if ($this->_current_key === false) return;
        $this->_current_value = str_replace('\\n', "\n", $this->_current_value);
        $this->_hash[$this->_current_key] = $this->_current_value;
        $this->_current_key = false;
        $this->_current_value = "";
    }
}


/**
* This class write a php file from a gettext hashtable.
*
* The produced file return the translation hashtable on include.
* 
* @throws GetText_Error
* @access private
* @author Laurent Bedubourg <laurent.bedubourg@free.fr>
*/
class gettext_php_support_compiler 
{
    /**
     * Write hash in an includable php file.
     */
    function compile(&$hash, $source_path)
    {
        $dest_path = preg_replace('/\.po$/', '.php', $source_path);
        $fp = @fopen($dest_path, "w");
        if (!$fp) 
        {
            $str = sprintf('Unable to open "%s" in write mode.', $dest_path);
            //$err = new GetText_Error($str);
            //return PEAR::raise_error($err);
			return raise_error($str);
        }
        fwrite($fp, '<?php' . "\n");
        fwrite($fp, 'return array(' . "\n");
        foreach ($hash as $key => $value) 
        {
            $key   = str_replace("'", "\\'", $key);
            $value = str_replace("'", "\\'", $value);
            fwrite($fp, '    \'' . $key . '\' => \'' . $value . "',\n");
        }
        fwrite($fp, ');' . "\n");
        fwrite($fp, '?>');
        fclose($fp);
    }
}

/**
* get_text related error.
*/
//class GetText_Error extends PEAR_Error {}

?>