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 "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->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 install ()
        {
                if ($this->getStatus() != "installed")
                {
                        if ($this->check())
                        {
                                // lang-file is ok. Flush data in db and...
                                $this->flush();
                                // ...re-insert data from lang-file
                                $this->insert();
                                // update information in db-table about available/installed languages
                                $this->setDescription("installed");
                                $this->update();
                                $this->optimizeData();
                                return $this->getKey();
                        }
                }
                return "";
        }


        function uninstall ()
        {
                if (($this->status == "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()
        {
                $query = "DELETE FROM lng_data WHERE lang_key='".$this->key."'";
                $this->ilias->db->query($query);
        }


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

                $lang_file = "ilias_".$this->key.".lang";

                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);
                                        }
                                        
                                        
                                        $num = count($separated);

                                        $query = "INSERT INTO lng_data ".
                                                         "(module,identifier,lang_key,value) ".
                                                         "VALUES ".
                                                         "('".$separated[0]."','".$separated[1]."','".$this->key."','".addslashes($separated[2])."')";
                                        $this->ilias->db->query($query);
                                }
                                $query = "UPDATE object_data SET ".
                                                 "last_update = now() ".
                                                 "WHERE title = '".$this->key."' ".
                                                 "AND type = 'lng'";
                                $this->ilias->db->query($query);
                        }
                }

                chdir($tmpPath);
        }

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

        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
                $q = "OPTIMIZE TABLE lng_data";
                $this->ilias->db->query($q);

                return true;
        }

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

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

                // 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
                foreach ($content as $key => $val)
                {
                        $separated = explode ($this->separator,trim($val));
                        $num = count($separated);

                        if ($num != 3)
                        {
                                $this->ilias->raiseError("Wrong parameter count in ".$lang_file."! Please check your language file!",$this->ilias->error_obj->MESSAGE);
                        }
                }

                chdir($tmpPath);

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