Services/Language/classes/class.ilObjLanguage.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. |
        +-----------------------------------------------------------------------------+
*/

require_once "./classes/class.ilObject.php";

class ilObjLanguage extends ilObject
{
        var $separator;
        var $comment_separator;
        var $lang_default;
        var $lang_user;
        var $lang_path;

        var $key;
        var $status;


        function ilObjLanguage($a_id = 0, $a_call_by_reference = false)
        {
                global $lng;

                $this->type = "lng";
                $this->ilObject($a_id,$a_call_by_reference);

                $this->type = "lng";
                $this->key = $this->title;
                $this->status = $this->desc;
                $this->lang_default = $lng->lang_default;
                $this->lang_user = $lng->lang_user;
                $this->lang_path = $lng->lang_path;
                $this->cust_lang_path = $lng->cust_lang_path;
                $this->separator = $lng->separator;
                $this->comment_separator = $lng->comment_separator;
        }

        function getKey()
        {
                return $this->key;
        }

        function getStatus()
        {
                return $this->status;
        }

        function isSystemLanguage()
        {
                if ($this->key == $this->lang_default)
                        return true;
                else
                        return false;
        }

        function isUserLanguage()
        {
                if ($this->key == $this->lang_user)
                {
                        return true;
                }
                else
                {
                        return false;
                }
        }


        function isInstalled()
        {
                if (substr($this->getStatus(), 0, 9) == "installed")
                {
                        return true;
                }
                else
                {
                        return false;
                }
        }

        function isLocal()
        {
                if (substr($this->getStatus(), 10) == "local")
                {
                        return true;
                }
                else
                {
                        return false;
                }
        }

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

                if (($this->isInstalled() == false) || 
                                ($this->isInstalled() == true && $this->isLocal() == false && !empty($scope)))
                {
                        if ($this->check($scope))
                        {
                                // lang-file is ok. Flush data in db and...
                                if (empty($scope))
                                {
                                        $this->flush();
                                }

                                // ...re-insert data from lang-file
                                $this->insert($scope);

                                // update information in db-table about available/installed languages
                                if (empty($scope))
                                {
                                        $newDesc = 'installed';
                                }
                                else if ($scope == 'local')
                                {
                                        $newDesc = 'installed_local';
                                }
                                $this->setDescription($newDesc);
                                $this->update();
                                $this->optimizeData();
                                return $this->getKey();
                        }
                }
                return "";
        }


        function uninstall()
        {
                if ((substr($this->status, 0, 9) == "installed") && ($this->key != $this->lang_default) && ($this->key != $this->lang_user))
                {
                        $this->flush();
                        $this->setTitle($this->key);
                        $this->setDescription("not_installed");
                        $this->update();
                        $this->resetUserLanguage($this->key);

                        return $this->key;
                }
                return "";
        }


        function flush()
        {
                global $ilDB;
                
                $query = "DELETE FROM lng_data WHERE lang_key=".
                        $ilDB->quote($this->key);
                $this->ilias->db->query($query);
        }


        function insert($scope = '')
        {
                global $ilDB;
                
                if (!empty($scope))
                {
                        if ($scope == 'global')
                        {
                                $scope = ''; 
                        }
                        else
                        {
                                $scopeExtension = '.' . $scope;
                        }
                }
                
                $path = $this->lang_path;
                if ($scope == "local")
                {
                        $path = $this->cust_lang_path;
                }

                $tmpPath = getcwd();
                chdir($path);

                $lang_file = "ilias_" . $this->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 " .
                                                                "(".$ilDB->quote($separated[0]).",".
                                                                $ilDB->quote($separated[1]).",".
                                                                $ilDB->quote($this->key).",".
                                                                $ilDB->quote($separated[2]).")";
                                                $lang_array[$separated[0]][$separated[1]] = $separated[2];
                                        }
                                        else if ($scope == 'local')
                                        {
                                                // UPDATE because the global values have already been INSERTed
                                                $query = "UPDATE lng_data SET ".
                                                                 "module = ".$ilDB->quote($separated[0]).", " .
                                                                 "identifier = ".$ilDB->quote($separated[1]).", " . 
                                                                 "lang_key = ".$ilDB->quote($this->key).", " .
                                                                 "value = ".$ilDB->quote($separated[2])." " .
                                                                 "WHERE module = ".$ilDB->quote($separated[0])." " .
                                                                 "AND identifier = ".$ilDB->quote($separated[1])." " .
                                                                 "AND lang_key = ".$ilDB->quote($this->key);
                                                $lang_array[$separated[0]][$separated[1]] = $separated[2];
                                        }
                                        $this->ilias->db->query($query);
                                }

                                if (empty($scope))
                                {
                                        $query = "UPDATE object_data SET " .
                                                        "description = 'installed', " .
                                                        "last_update = now() " .
                                                        "WHERE title = ".$ilDB->quote($this->key)." " .
                                                        "AND type = 'lng'";
                                }
                                else if ($scope == 'local')
                                {
                                        $query = "UPDATE object_data SET " .
                                                        "description = 'installed_local', " .
                                                        "last_update = now() " .
                                                        "WHERE title = ".$ilDB->quote($this->key)." " .
                                                        "AND type = 'lng'";
                                }
                                $this->ilias->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($this->key).", " .
                                         " ".$ilDB->quote($module).", " . 
                                         " ".$ilDB->quote(serialize($lang_arr)).") ";
                                $ilDB->query($query);

                        }
                }

                chdir($tmpPath);
        }

        function resetUserLanguage($lang_key)
        {
                global $ilDB;
                
                $query = "UPDATE usr_pref SET " .
                                "value = ".$ilDB->quote($this->lang_default)." " .
                                "WHERE keyword = 'language' " .
                                "AND value = ".$ilDB->quote($lang_key);
                $this->ilias->db->query($query);
        }

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

                return false;
        }

        function optimizeData()
        {
                // optimize
                $query = "OPTIMIZE TABLE lng_data";
                $this->ilias->db->query($query);

                return true;
        }

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

                $path = $this->lang_path;
                if ($scope == "local")
                {
                        $path = $this->cust_lang_path;
                }
                
                $tmpPath = getcwd();
                
                // dir check
                if (!is_dir($path))
                {
                        $this->ilias->raiseError("Directory not found: ".$path, $this->ilias->error_obj->MESSAGE);
                }

                chdir($path);

                // compute lang-file name format
                $lang_file = "ilias_" . $this->key . ".lang" . $scopeExtension;

                // file check
                if (!is_file($lang_file))
                {
                        $this->ilias->raiseError("File not found: ".$lang_file,$this->ilias->error_obj->MESSAGE);
                }

                // header check
                if (!$content = $this->cut_header(file($lang_file)))
                {
                        $this->ilias->raiseError("Wrong Header in ".$lang_file,$this->ilias->error_obj->MESSAGE);
                }

                // check (counting) elements of each lang-entry
                $line = 0;
                foreach ($content as $key => $val)
                {
                        $separated = explode($this->separator, trim($val));
                        $num = count($separated);
                        ++$n;
                        if ($num != 3)
                        {
                                $line = $n + 36;
                                $this->ilias->raiseError("Wrong parameter count in ".$lang_file." in line $line (Value: $val)! Please check your language file!",$this->ilias->error_obj->MESSAGE);
                        }
                }

                chdir($tmpPath);

                // no error occured
                return true;
        }
} // END class.LanguageObject
?>