setup/classes/class.ilLanguage.php

Go to the documentation of this file.

<?php
/*
        +-----------------------------------------------------------------------------+
        | ILIAS open source                                                           |
        +-----------------------------------------------------------------------------+
        | Copyright (c) 1998-2001 ILIAS open source, University of Cologne            |
        |                                                                             |
        | 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 (at your option) 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. |
        +-----------------------------------------------------------------------------+
*/


class ilLanguage
{
        var $text = array();
        
        var $lang_default = "en";

        var $lang_path;

        var $lang_key;

        var $separator = "#:#";
        
        var $comment_separator = "###";

        function ilLanguage($a_lang_key)
        {
                $this->lang_key = ($a_lang_key) ? $a_lang_key : $this->lang_default;
                //$_GET["lang"] = $this->lang_key;  // only for downward compability (old setup)
                $this->lang_path = ILIAS_ABSOLUTE_PATH."/lang";

                // set lang file...
                $txt = file($this->lang_path."/setup_lang_sel_multi.lang");

                // ...and load langdata
                if (is_array($txt))
                {
                        foreach ($txt as $row)
                        {
                                if ($row[0] != "#")
                                {
                                        $a = explode($this->separator,trim($row));
                                        $this->text[trim($a[0])] = trim($a[1]);
                                }
                        }
                }

                // set lang file...
                $txt = file($this->lang_path."/setup_".$this->lang_key.".lang");

                // ...and load langdata
                if (is_array($txt))
                {
                        foreach ($txt as $row)
                        {
                                if ($row[0] != "#")
                                {
                                        $a = explode($this->separator,trim($row));
                                        $this->text[trim($a[0])] = trim($a[1]);
                                }
                        }

                        return true;
                }

                return false;
        }
        
        function txt($a_topic)
        {
                global $log;
                
                if (empty($a_topic))
                {
                        return "";
                }

                $translation = $this->text[$a_topic];
                
                //get position of the comment_separator
                $pos = strpos($translation, $this->comment_separator);

                if ($pos !== false)
                {
                        // remove comment
                        $translation = substr($translation,0,$pos);
                }

                if ($translation == "")
                {
                        $log->writeLanguageLog($a_topic,$this->lang_key);
                        return "-".$a_topic."-";
                }
                else
                {
                        return $translation;
                }
        }

        function getLanguages()
        {
                $d = dir($this->lang_path);
                $tmpPath = getcwd();
                chdir ($this->lang_path);

                // get available setup-files
                while ($entry = $d->read())
                {
                        if (is_file($entry) && (ereg ("(^setup_.{2}\.lang$)", $entry)))
                        {
                                $lang_key = substr($entry,6,2);
                                $languages[] = $lang_key;
                        }
                }

                chdir($tmpPath);

                return $languages;
        }

        function installLanguages($a_lang_keys, $a_local_keys)
        {
                if (empty($a_lang_keys))
                {
                        $a_lang_keys = array();
                }
                
                if (empty($a_local_keys))
                {
                        $a_local_keys = array();
                }

                $err_lang = array();

                $this->flushLanguages();
                
                $db_langs = $this->getAvailableLanguages();

                foreach ($a_lang_keys as $lang_key)
                {
                        if ($this->checkLanguage($lang_key))
                        {
                                $this->insertLanguage($lang_key);
                                
                                if (in_array($lang_key, $a_local_keys))
                                {
                                        if ($this->checkLanguage($lang_key, "local"))
                                        {
                                                $this->insertLanguage($lang_key, "local");
                                        }
                                        else
                                        {
                                                $err_lang[] = $lang_key;
                                        }
                                }
                                
                                // register language first time install
                                if (!array_key_exists($lang_key,$db_langs))
                                {
                                        if (in_array($lang_key, $a_local_keys))
                                        {
                                                $query = "INSERT INTO object_data ".
                                                                "(type,title,description,owner,create_date,last_update) ".
                                                                "VALUES ".
                                                                "('lng','".$lang_key."','installed_local','-1',now(),now())";
                                        }
                                        else
                                        {
                                                $query = "INSERT INTO object_data ".
                                                                "(type,title,description,owner,create_date,last_update) ".
                                                                "VALUES ".
                                                                "('lng','".$lang_key."','installed','-1',now(),now())";
                                        }
                                        $this->db->query($query);
                                }
                        }
                        else
                        {
                                $err_lang[] = $lang_key;
                        }
                }
                
                foreach ($db_langs as $key => $val)
                {
                        if (!in_array($key,$err_lang))
                        {
                                if (in_array($key,$a_lang_keys))
                                {
                                        if (in_array($key, $a_local_keys))
                                        {
                                                $query = "UPDATE object_data SET " .
                                                                "description = 'installed_local', " .
                                                                "last_update = now() " .
                                                                "WHERE obj_id='".$val["obj_id"]."' " .
                                                                "AND type='lng'";
                                        }
                                        else
                                        {
                                                $query = "UPDATE object_data SET " .
                                                                "description = 'installed', " .
                                                                "last_update = now() " .
                                                                "WHERE obj_id='".$val["obj_id"]."' " .
                                                                "AND type='lng'";
                                        }
                                        $this->db->query($query);
                                }
                                else
                                {
                                        if (substr($val["status"], 0, 9) == "installed")
                                        {
                                                $query = "UPDATE object_data SET " .
                                                                "description = 'not_installed', " .
                                                                "last_update = now() " .
                                                                "WHERE obj_id='" . $val["obj_id"] . "' " .
                                                                "AND type='lng'";
                                                $this->db->query($query);
                                        }
                                }
                        }
                }

                return ($err_lang) ? $err_lang : true;
        }

        function getInstalledLanguages()
        {
                $arr = array();

                $query = "SELECT * FROM object_data ".
                                "WHERE type = 'lng' ".
                                "AND description LIKE 'installed%'";
                $r = $this->db->query($query);

                while ($row = $r->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $arr[] = $row->title;
                }

                return $arr;
        }
        
        function getInstalledLocalLanguages()
        {
                $arr = array();

                $query = "SELECT * FROM object_data ".
                                "WHERE type = 'lng' ".
                                "AND description = 'installed_local'";
                $r = $this->db->query($query);

                while ($row = $r->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $arr[] = $row->title;
                }

                return $arr;
        }

        function getAvailableLanguages()
        {
                $arr = array();

                $query = "SELECT * FROM object_data ".
                                "WHERE type = 'lng'";
                $r = $this->db->query($query);

                while ($row = $r->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $arr[$row->title]["obj_id"] = $row->obj_id;
                        $arr[$row->title]["status"] = $row->description;
                }

                return $arr;
        }

        function checkLanguage($a_lang_key, $scope = '')
        {
                if (!empty($scope))
                {
                        if ($scope == 'global')
                        {
                                $scope = ''; 
                        }
                        else
                        {
                                $scopeExtension = '.' . $scope;
                        }
                }

                $tmpPath = getcwd();
                chdir($this->lang_path);

                // compute lang-file name format
                $lang_file = "ilias_" . $a_lang_key . ".lang" . $scopeExtension;

                // file check
                if (!is_file($lang_file))
                {
                        chdir($tmpPath);
                        return false;
                }

                // header check
                if (!$content = $this->cut_header(file($lang_file)))
                {
                        chdir($tmpPath);
                        return false;
                }

                // check (counting) elements of each lang-entry
                foreach ($content as $key => $val)
                {
                        $separated = explode($this->separator, trim($val));
                        $num = count($separated);

                        if ($num != 3)
                        {
                                chdir($tmpPath);
                                return false;
                        }
                }

                chdir($tmpPath);

                // no error occured
                return true;
        }

        function cut_header($content)
        {
                foreach ($content as $key => $val)
                {
                        if (trim($val) == "<!-- language file start -->")
                        {
                                return array_slice($content,$key +1);
                        }
                }

                return false;
        }

        function flushLanguages()
        {
                $query = "DELETE FROM lng_data";
                $this->db->query($query);
        }

        //TODO: remove redundant checks here!
        function insertLanguage($lang_key, $scope = '')
        {
                $ilDB =& $this->db;
                
                $lang_array = array();
                
                if (!empty($scope))
                {
                        if ($scope == 'global')
                        {
                                $scope = ''; 
                        }
                        else
                        {
                                $scopeExtension = '.' . $scope;
                        }
                }

                $tmpPath = getcwd();
                chdir($this->lang_path);

                $lang_file = "ilias_" . $lang_key . ".lang" . $scopeExtension;

                if ($lang_file)
                {
                        // remove header first
                        if ($content = $this->cut_header(file($lang_file)))
                        {
                                foreach ($content as $key => $val)
                                {
                                        $separated = explode($this->separator,trim($val));

                                        //get position of the comment_separator
                                        $pos = strpos($separated[2], $this->comment_separator);

                                        if ($pos !== false)
                                        {
                                                //cut comment of
                                                $separated[2] = substr($separated[2] , 0 , $pos);
                                        }

                                        if (empty($scope))
                                        {
                                                $query = "INSERT INTO lng_data ".
                                                                "(module,identifier,lang_key,value) ".
                                                                "VALUES ".
                                                                "('" . $separated[0] . "','" . $separated[1] . "','" . $lang_key . "','" . addslashes($separated[2]) . "')";
                                                $lang_array[$separated[0]][$separated[1]] = $separated[2];
                                        }
                                        else if ($scope == 'local')
                                        {
                                                $query = "UPDATE lng_data SET ".
                                                                "module = '" . $separated[0] . "', " .
                                                                "identifier = '" . $separated[1] . "', " . 
                                                                "lang_key = '" . $lang_key . "', " .
                                                                "value = '" . addslashes($separated[2]) . "' " .
                                                                "WHERE module = '" . $separated[0] . "' " .
                                                                "AND identifier = '" . $separated[1] . "' " .
                                                                "AND lang_key = '" . $lang_key . "'";
                                                $lang_array[$separated[0]][$separated[1]] = $separated[2];
                                        }
                                        $this->db->query($query);
                                }
                        }

                        // insert module data
                        $lang_array[$separated[0]][$separated[1]] = $separated[2];

                        foreach($lang_array as $module => $lang_arr)
                        {
                                if ($scope == "local")
                                {
                                        $q = "SELECT * FROM lng_modules WHERE ".
                                                " lang_key = ".$ilDB->quote($this->key).
                                                " AND module = ".$ilDB->quote($module);
                                        $set = $ilDB->query($q);
                                        $row = $set->fetchRow(DB_FETCHMODE_ASSOC);
                                        $arr2 = unserialize($row["lang_array"]);
                                        if (is_array($arr2))
                                        {
                                                $lang_arr = array_merge($arr2, $lang_arr);
                                        }
                                }
                                $query = "REPLACE INTO lng_modules (lang_key, module, lang_array) VALUES ".
                                         "(".$ilDB->quote($lang_key).", " .
                                         " ".$ilDB->quote($module).", " . 
                                         " ".$ilDB->quote(serialize($lang_arr)).") ";
                                $ilDB->query($query);

                        }
                }

                chdir($tmpPath);
        }
        
        function getLocalLanguages()
        {
                $local_langs = array();
                $d = dir($this->lang_path);
                $tmpPath = getcwd();
                chdir ($this->lang_path);

                // get available .lang.local files
                while ($entry = $d->read())
                {
                        if (is_file($entry) && (ereg ("(^ilias_.{2}\.lang.local$)", $entry)))
                        {
                                $lang_key = substr($entry,6,2);
                                $local_langs[] = $lang_key;
                        }
                }

                chdir($tmpPath);

                return $local_langs;
        }

        function getInstallableLanguages()
        {
                $setup_langs = $this->getLanguages();

                $d = dir($this->lang_path);
                $tmpPath = getcwd();
                chdir ($this->lang_path);

                // get available lang-files
                while ($entry = $d->read())
                {
                        if (is_file($entry) && (ereg ("(^ilias_.{2}\.lang$)", $entry)))
                        {
                                $lang_key = substr($entry,6,2);
                                $languages1[] = $lang_key;
                        }
                }
                
                //$languages = array_intersect($languages1,$setup_langs);    

                chdir($tmpPath);

                return $languages1;
        }
        
        function setDbHandler($a_db_handler)
        {
                if (empty($a_db_handler) or !is_object($a_db_handler))
                {
                        return false;
                }
                
                $this->db =& $a_db_handler;
                
                return true;
        }
} // END class.ilLanguage
?>