dolibarr/htdocs/translate.class.php

<?php
/* ***************************************************************************
 * Copyright (C) 2001      Eric Seigne         <erics@rycks.com>
 * Copyright (C) 2004-2005 Destailleur Laurent <eldy@users.sourceforge.net>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 * ************************************************************************* */

/**
    	\file       htdocs/translate.class.php
		\brief      Fichier de la classe de traduction
		\author	    Laurent Destailleur
		\version    $Revision$
*/


/** 
        \class      Translate
		\brief      Classe permettant de g<EFBFBD>rer les traductions
*/

class Translate {

    var $dir;
    var $origlang;					// Langue origine
    var $defaultlang;				// Langue courante en vigueur de l'utilisateur

    var $tab_loaded=array();		// Tableau pour signaler les fichiers deja charg<72>s
    var $tab_translate=array();		// Tableau des traductions

	var $charset_inputfile='ISO-8859-1';	// Codage du contenu du fichier langue
	var $charset_output='ISO-8859-1';		// Codage par defaut de la sortie de la m<>thode trans
	

    /**
     *  \brief      Constructeur de la classe
     *  \param      dir             Repertoire racine des fichiers de traduction
     *  \param      conf			Objet qui contient la config Dolibarr
     */
    function Translate($dir = "",$conf)
    {
		// Si charset output defini
		if (isset($conf->character_set_client) && $conf->character_set_client) 
		{
			$this->charset_output=$conf->character_set_client;
		}
        $this->dir=$dir;
    }


	/**
	 *	\brief		Renvoie la chaine traduite pour une cl<EFBFBD> donn<EFBFBD>e.
	 *				Le tableau des traductions doit avoir <EFBFBD>t<EFBFBD> charg<EFBFBD>.
	 *	\param		key			Cl<EFBFBD> de traduction
	 *	\return		string		Chaine de traduction
	 */
	function getTransFromTab($key)
	{
		if (isset($this->tab_translate[$key]) && $this->tab_translate[$key])
		{
			return $this->tab_translate[$key];
		}
		else
		{
			return '';
		}
	}

	/**
	 *	\brief		Positionne la chaine traduite pour une cl<EFBFBD> donn<EFBFBD>e.
	 *	\param		key			Cl<EFBFBD> de traduction
	 *	\param		value		Chaine de traduction
	 */
	function setTransFromTab($key,$value)
	{
		$this->tab_translate[$key]=$value;
	}


    /**
     *  \brief      Accesseur de this->defaultlang
     *  \param      srclang     	Langue <EFBFBD> utiliser
     */
    function setDefaultLang($srclang='fr_FR')
    {
		$this->origlang=$srclang;
		
        if ($srclang == 'auto')
        {
            $langpref=$_SERVER['HTTP_ACCEPT_LANGUAGE'];
            $langpref=eregi_replace(";[^,]*","",$langpref);
            $langpref=eregi_replace("-","_",$langpref);

            $langlist=split("[;,]",$langpref);

            $langpart=split("_",$langlist[0]);

            if (isset($langpart[1])) $srclang=strtolower($langpart[0])."_".strtoupper($langpart[1]);
            else $srclang=strtolower($langpart[0])."_".strtoupper($langpart[0]);
        }

        $this->defaultlang=$srclang;
    }

    
    /**
     *  \brief      Accesseur de this->defaultlang
     *  \return     string      Langue utilis<EFBFBD>e
     */
    function getDefaultLang()
    {
        return $this->defaultlang;
    }

    
    /**
    		\brief      Positionne environnement PHP en fonction du langage
    		\remarks    Le code langue long (fr_FR, en_US, ...) doit <EFBFBD>tre positionn<EFBFBD>
    		\return     int             >0 si ok, <0 so ko
    */
    function setPhpLang()
    {
        //dolibarr_syslog("Translate::set_php_lang: ".$this->defaultlang,LOG_DEBUG);
       
        $code_lang_tiret=ereg_replace('_','-',$this->defaultlang);
        setlocale(LC_ALL, $this->defaultlang);    // Compenser pb de locale avec windows
        setlocale(LC_ALL, $code_lang_tiret);
        if (defined("MAIN_FORCE_SETLOCALE_LC_ALL") && MAIN_FORCE_SETLOCALE_LC_ALL) setlocale(LC_ALL, MAIN_FORCE_SETLOCALE_LC_ALL);
        if (defined("MAIN_FORCE_SETLOCALE_LC_TIME") && MAIN_FORCE_SETLOCALE_LC_TIME) setlocale(LC_TIME, MAIN_FORCE_SETLOCALE_LC_TIME);
        if (defined("MAIN_FORCE_SETLOCALE_LC_NUMERIC") && MAIN_FORCE_SETLOCALE_LC_NUMERIC) setlocale(LC_NUMERIC, MAIN_FORCE_SETLOCALE_LC_NUMERIC);
        if (defined("MAIN_FORCE_SETLOCALE_LC_MONETARY") && MAIN_FORCE_SETLOCALE_LC_MONETARY) setlocale(LC_MONETARY, MAIN_FORCE_SETLOCALE_LC_MONETARY);
    
        return 1;
    }


    /**
	 *  \brief      Charge en m<EFBFBD>moire le tableau de traduction pour un domaine particulier
     *              Si le domaine est deja charg<EFBFBD>, la fonction ne fait rien
     *  \param      domain      Nom du domain (fichier lang) <EFBFBD> charger
     *  \param      alt         Utilise le fichier alternatif meme si fichier dans la langue est trouv<EFBFBD>e
     */
    function Load($domain,$alt=0)
    {
        if (isset($this->tab_loaded[$domain]) && $this->tab_loaded[$domain]) { return; }    // Le fichier de ce domaine est deja charg<72>
        
        // Repertoire de traduction
        $scandir = $this->dir."/".$this->defaultlang;
        $file_lang =  $scandir . "/$domain.lang";
        $filelangexists=is_file($file_lang);

        if ($alt || ! $filelangexists)
        {
            // Repertoire de la langue alternative
			if ($this->defaultlang == "en_US") $scandiralt = $this->dir."/fr_FR";
            elseif (eregi('^fr',$this->defaultlang) && $this->defaultlang != 'fr_FR') $scandiralt = $this->dir."/fr_FR";
            elseif (eregi('^en',$this->defaultlang) && $this->defaultlang != 'en_US') $scandiralt = $this->dir."/en_US";
           	else $scandiralt = $this->dir."/en_US";

            $file_lang = $scandiralt . "/$domain.lang";
            $filelangexists=is_file($file_lang);
            $alt=1;
        }
        
        if ($filelangexists)
        {
			//dolibarr_syslog("Translate::load open file ".$file_lang);
            if($fp = @fopen($file_lang,"rt"))
            {
                $finded = 0;
                while (($ligne = fgets($fp,4096)) && ($finded == 0))
                {
                    if ($ligne[0] != "\n" && $ligne[0] != " " && $ligne[0] != "#")
                    {
                        $tab=split('=',$ligne,2);
                        $key=trim($tab[0]); $value='';
                        //print "Domain=$domain, found a string for $tab[0] with value $tab[1]<br>";
                        if (! $this->getTransFromTab($key))
                        {
	                        if (isset($tab[1])) $value=trim(ereg_replace('\\\n',"\n",$tab[1]));
							
							if (eregi('^CHARSET$',$key))
							{
								// On est tombe sur une balise qui declare le format du fichier lu
								$this->charset_inputfile=strtoupper($value);
								//print 'File '.$file_lang.' has format '.$this->charset_inputfile.'<br>';
							}
							else
							{
								// On stocke toujours dans le tableau Tab en ISO
	                        	if ($this->charset_inputfile == 'UTF-8')      $value=utf8_decode($value);
	                        	//if ($this->charset_inputfile == 'ISO-8859-1') $value=$value;

								$this->setTransFromTab($key,$value);
							}
                        }
                    }
                }
                fclose($fp);

                // Pour les langues aux fichiers parfois incomplets, on charge la langue alternative
                if (! $alt && $this->defaultlang != "fr_FR" && $this->defaultlang != "en_US")
                {
                    dolibarr_syslog("translate::load loading alternate translation file");
                    $this->load($domain,1);
                }

                $this->tab_loaded[$domain]=1;           // Marque ce fichier comme charg<72>
            }
        }
    }


    /**     
     *	\brief      Retourne la liste des domaines charg<EFBFBD>es en memoire
     *  \return     array       Tableau des domaines charg<EFBFBD>es
     */
    function list_domainloaded()
    {
        return join(",",array_keys($this->tab_loaded));
    }
    
    
    /**
     *  \brief      Retourne la version traduite du texte pass<EFBFBD> en param<EFBFBD>tre en la codant en HTML
     *              Si il n'y a pas de correspondance pour ce texte, on cherche dans fichier alternatif
     *              et si toujours pas trouv<EFBFBD>, il est retourn<EFBFBD> tel quel
     *              Les param<EFBFBD>tres de cette m<EFBFBD>thode peuvent contenir de balises HTML.
     *  \param      key         cl<EFBFBD> de chaine a traduire
     *  \param      param1      chaine de param1
     *  \param      param2      chaine de param1
     *  \param      param3      chaine de param1
     *	\param		maxsize		taille max
     *  \return     string      chaine traduite et cod<EFBFBD> en HTML
     */
    function trans($key, $param1='', $param2='', $param3='', $param4='', $maxsize=0)
    {
        if ($this->getTransFromTab($key))
        {
            // Si la traduction est disponible
            $str=sprintf($this->tab_translate[$key],$param1,$param2,$param3,$param4);
            if ($maxsize) $str=dolibarr_trunc($str,$maxsize);
            // On remplace les tags HTML par __xx__ pour eviter traduction par htmlentities
            $newstr=ereg_replace('<','__lt__',$str);
            $newstr=ereg_replace('>','__gt__',$newstr);
            $newstr=ereg_replace('"','__quot__',$newstr);

			$newstr=$this->convToOuptutCharset($newstr);
			
            // Cryptage en html de la chaine
			// $newstr est une chaine stockee en memoire au format $this->charset_output
            $newstr=htmlentities($newstr,ENT_QUOTES,$this->charset_output);

            // On restaure les tags HTML
            $newstr=ereg_replace('__lt__','<',$newstr);
            $newstr=ereg_replace('__gt__','>',$newstr);
            $newstr=ereg_replace('__quot__','"',$newstr);
            return $newstr;
        }
		else
		{
			return $this->convToOuptutCharset($key);
		}
    }


    /**
     *  \brief       Retourne la version traduite du texte pass<EFBFBD> en param<EFBFBD>tre
     *               Si il n'y a pas de correspondance pour ce texte, on cherche dans fichier alternatif
     *               et si toujours pas trouv<EFBFBD>, il est retourn<EFBFBD> tel quel.
     *               Les param<EFBFBD>tres de cette m<EFBFBD>thode ne doivent pas contenir de balises HTML.
     *  \param       key         cl<EFBFBD> de chaine a traduire
     *  \param       param1      chaine de param1
     *  \param       param2      chaine de param1
     *  \param       param3      chaine de param1
     *  \param       param4      chaine de param1
     *  \return      string      chaine traduite
     */
    function transnoentities($key, $param1='', $param2='', $param3='', $param4='')
    {
        if ($this->getTransFromTab($key))
        {
            // Si la traduction est disponible
            return sprintf($this->tab_translate[$key],$param1,$param2,$param3,$param4);
        }
        return $key;
    }


    /**
     *  \brief       Retourne la version traduite du texte pass<EFBFBD> en param<EFBFBD>tre compl<EFBFBD>t<EFBFBD> du code pays
     *  \param       str            chaine a traduire
     *  \param       countrycode    code pays (FR, ...)
     *  \return      string         chaine traduite
     */
    function transcountry($str, $countrycode)
    {
        if ($this->tab_translate["$str$countrycode"]) return $this->trans("$str$countrycode");
        else return $this->trans("$str");
    }


    /**
     *  \brief       Convertit une chaine dans le charset de sortie
     *  \param       str            chaine a convertir
     *  \return      string         chaine traduite
     */
    function convToOuptutCharset($str)
    {
		if ($this->charset_output=='UTF-8')      	$str=utf8_encode($str);
		//if ($this->charset_output=='ISO-8859-1')	$str=$str;
		return $str;
    }


    /**
     *  \brief       Retourne la liste des langues disponibles
     *  \return      array     list of languages
     */
    function get_available_languages($langdir=DOL_DOCUMENT_ROOT)
    {
        // On parcour le r<>pertoire langs pour d<>tecter les langues disponibles
        $handle=opendir($langdir ."/langs");
        $langs_available=array();
        while ($file = trim(readdir($handle)))
        {
            if (eregi('^[a-z]+_[A-Z]+',$file))
            {
                array_push($langs_available,$file);
            }
        }
        return $langs_available;
    }
    
    /**
     *  \brief       Exp<EFBFBD>die le header correct et retourne le d<EFBFBD>but de la page html
     *  [en]         Send header and return a string of html start page
     *  \return      string      html header avec charset
     */
    function lang_header()
    {
        $texte = "<meta http-equiv=\"Content-Type\" content=\"text/html; charset=".$this->charset_output."\">\n";
        return $texte;
    }


   /**
     *  \brief      Renvoi si le fichier $filename existe dans la version de la langue courante ou alternative
     *  \param      filename        nom du fichier <EFBFBD> rechercher
     *  \param      searchalt       cherche aussi dans langue alternative
     *  \return     boolean         true si existe, false sinon
     */
    function file_exists($filename,$searchalt=0)
    {
        // Test si fichier dans r<>pertoire de la langue
        $htmlfile=$this->dir."/".$this->defaultlang."/".$filename;
        if (is_readable($htmlfile)) return true;

        if ($searchalt) {
            // Test si fichier dans r<>pertoire de la langue alternative
            if ($this->defaultlang != "en_US") $htmlfilealt = $this->dir."/en_US/".$filename;   
            else $htmlfilealt = $this->dir."/fr_FR/".$filename;
            if (is_readable($htmlfilealt)) return true;
        }
        
        return false;
    }


   /**
     *  \brief      Renvoi le fichier $filename dans la version de la langue courante, sinon alternative
     *  \param      filename        nom du fichier <EFBFBD> rechercher
     *  \param      searchalt       cherche aussi dans langue alternative
     */
    function print_file($filename,$searchalt=0)
    {
        // Test si fichier dans r<>pertoire de la langue
        $htmlfile=$this->dir."/".$this->defaultlang."/".$filename;
        if (is_readable($htmlfile))
        {
            include $htmlfile;
            return true;
        }

        if ($searchalt) {
            // Test si fichier dans r<>pertoire de la langue alternative
            if ($this->defaultlang != "en_US") $htmlfilealt = $this->dir."/en_US/".$filename;   
            else $htmlfilealt = $this->dir."/fr_FR/".$filename;
            if (is_readable($htmlfilealt))
            {
                include $htmlfilealt;
                return true;
            }
        }
        
        return false;
    }

}

?>