class.ilSetupLanguage.php

Go to the documentation of this file.

<?php
/*
    +-----------------------------------------------------------------------------+
    | ILIAS open source                                                           |
    +-----------------------------------------------------------------------------+
    | Copyright (c) 1998-2009 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 ilSetupLanguage extends ilLanguage
{
    public $text = array();
    
    public $lang_default = "en";

    public $lang_path;

    public $lang_key;

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

    public function __construct($a_lang_key)
    {
        $this->lang_key = ($a_lang_key) ? $a_lang_key : $this->lang_default;

        $il_absolute_path = realpath(dirname(__FILE__) . '/../../../../');
        $this->lang_path = $il_absolute_path . "/lang";
        $this->cust_lang_path = $il_absolute_path . "/Customizing/global/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));
                    if (count($a) == 2) {
                        $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));
                    if (count($a) == 2) {
                        $this->text[trim($a[0])] = trim($a[1]);
                    }
                }
            }

            return true;
        }

        return false;
    }
    
    public function txt($a_topic, $a_default_lang_fallback_mod = '')
    {
        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;
        }
    }

    public 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) && (preg_match('/(^setup_.{2}\.lang$)/', $entry))) {
                $lang_key = substr($entry, 6, 2);
                $languages[] = $lang_key;
            }
        }

        chdir($tmpPath);

        return $languages;
    }

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

        $err_lang = array();

        $db_langs = $this->getAvailableLanguages();

        foreach ($a_lang_keys as $lang_key) {
            if ($this->checkLanguage($lang_key)) {
                $this->flushLanguage($lang_key, 'keep_local');
                $this->insertLanguage($lang_key);
                
                if (in_array($lang_key, $a_local_keys) && is_dir($this->cust_lang_path)) {
                    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)) {
                        $itype = 'installed_local';
                    } else {
                        $itype = 'installed';
                    }
                    $lid = $ilDB->nextId("object_data");
                    $query = "INSERT INTO object_data " .
                            "(obj_id,type,title,description,owner,create_date,last_update) " .
                            "VALUES " .
                            "(" .
                            $ilDB->quote($lid, "integer") . "," .
                            $ilDB->quote("lng", "text") . "," .
                            $ilDB->quote($lang_key, "text") . "," .
                            $ilDB->quote($itype, "text") . "," .
                            $ilDB->quote('-1', "integer") . "," .
                            $ilDB->now() . "," .
                            $ilDB->now() .
                            ")";
                    $this->db->manipulate($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)) {
                        $ld = 'installed_local';
                    } else {
                        $ld = 'installed';
                    }
                    $query = "UPDATE object_data SET " .
                            "description = " . $ilDB->quote($ld, "text") . ", " .
                            "last_update = " . $ilDB->now() . " " .
                            "WHERE obj_id = " . $ilDB->quote($val["obj_id"], "integer") . " " .
                            "AND type = " . $ilDB->quote("lng", "text");
                    $ilDB->manipulate($query);
                } else {
                    $this->flushLanguage($key, "all");
                    
                    if (substr($val["status"], 0, 9) == "installed") {
                        $query = "UPDATE object_data SET " .
                                "description = " . $ilDB->quote("not_installed", "text") . ", " .
                                "last_update = " . $ilDB->now() . " " .
                                "WHERE obj_id = " . $ilDB->quote($val["obj_id"], "integer") . " " .
                                "AND type = " . $ilDB->quote("lng", "text");
                        $ilDB->manipulate($query);
                    }
                }
            }
        }

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



    public function getInstalledLanguages()
    {
        global $ilDB;
        
        $arr = array();

        $query = "SELECT * FROM object_data " .
                "WHERE type = " . $ilDB->quote("lng", "text") . " " .
                "AND " . $ilDB->like("description", "text", 'installed%');
        $r = $ilDB->query($query);

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

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

        $query = "SELECT * FROM object_data " .
                "WHERE type = " . $ilDB->quote("lng", "text") . " " .
                "AND description = " . $ilDB->quote('installed_local', "text");
        $r = $ilDB->query($query);

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

        return $arr;
    }

    protected function getAvailableLanguages()
    {
        global $ilDB;
        
        $arr = array();

        $query = "SELECT * FROM object_data " .
                "WHERE type = " . $ilDB->quote("lng", "text");
        $r = $ilDB->query($query);

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

        return $arr;
    }

    protected function checkLanguage($a_lang_key, $scope = '')
    {
        $scopeExtension = "";
        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);

        // 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;
    }

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

        return false;
    }
    

    protected function flushLanguage($a_lang_key, $a_mode = 'all')
    {
        $ilDB = $this->db;
        
        ilSetupLanguage::_deleteLangData($a_lang_key, ($a_mode == 'keep_local'));

        if ($a_mode == 'all') {
            $ilDB->manipulate("DELETE FROM lng_modules WHERE lang_key = " .
                $ilDB->quote($a_lang_key, "text"));
        }
    }

    public static function _deleteLangData($a_lang_key, $a_keep_local_change)
    {
        global $ilDB;
        
        if (!$a_keep_local_change) {
            $ilDB->manipulate("DELETE FROM lng_data WHERE lang_key = " .
                $ilDB->quote($a_lang_key, "text"));
        } else {
            $ilDB->manipulate("DELETE FROM lng_data WHERE lang_key = " .
                $ilDB->quote($a_lang_key, "text") .
                " AND local_change IS NULL");
        }
    }

    protected function getLocalChanges($a_lang_key, $a_min_date = "", $a_max_date = "")
    {
        $ilDB = $this->db;
        
        if ($a_min_date == "") {
            $a_min_date = "1980-01-01 00:00:00";
        }
        if ($a_max_date == "") {
            $a_max_date = "2200-01-01 00:00:00";
        }
        
        $q = sprintf(
            "SELECT * FROM lng_data WHERE lang_key = %s " .
            "AND local_change >= %s AND local_change <= %s",
            $ilDB->quote($a_lang_key, "text"),
            $ilDB->quote($a_min_date, "timestamp"),
            $ilDB->quote($a_max_date, "timestamp")
        );
        $result = $ilDB->query($q);
        
        $changes = array();
        while ($row = $result->fetchRow(ilDBConstants::FETCHMODE_ASSOC)) {
            $changes[$row["module"]][$row["identifier"]] = $row["value"];
        }
        return $changes;
    }


    //TODO: remove redundant checks here!
    protected function insertLanguage($lang_key, $scope = '')
    {
        $ilDB = &$this->db;
        
        $lang_array = array();
        
        $scopeExtension = "";
        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_" . $lang_key . ".lang" . $scopeExtension;

        if (is_file($lang_file)) {
            // initialize the array for updating lng_modules below
            $lang_array = array();
            $lang_array["common"] = array();

            // remove header first
            if ($content = $this->cut_header(file($lang_file))) {
                // get the local changes from the database
                if (empty($scope)) {
                    $local_changes = $this->getLocalChanges($lang_key);
                } elseif ($scope == 'local') {
                    // set the change date to import time for a local file
                    // get the modification date of the local file
                    // get the newer local changes for a local file
                    $change_date = date("Y-m-d H:i:s", time());
                    $min_date = date("Y-m-d H:i:s", filemtime($lang_file));
                    $local_changes = $this->getLocalChanges($lang_key, $min_date);
                }

                foreach ($content as $key => $val) {
                    // split the line of the language file
                    // [0]:     module
                    // [1]:     identifier
                    // [2]:     value
                    // [3]:     comment (optional)
                    $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);
                    }

                    // check if the value has a local change
                    if (isset($local_changes[$separated[0]])) {
                        $local_value = $local_changes[$separated[0]][$separated[1]];
                    } else {
                        $local_value = null;
                    }

                    if (empty($scope)) {
                        if ($local_value != "" and $local_value != $separated[2]) {
                            // keep the locally changed value
                            $lang_array[$separated[0]][$separated[1]] = $local_value;
                        } else {
                            // insert a new value if no local value exists
                            // reset local_change if the values are equal
                            ilSetupLanguage::replaceLangEntry(
                                $separated[0],
                                $separated[1],
                                $lang_key,
                                $separated[2]
                            );

                            $lang_array[$separated[0]][$separated[1]] = $separated[2];
                        }
                    } elseif ($scope == 'local') {
                        if ($local_value != "") {
                            // keep a locally changed value that is newer than the local file
                            $lang_array[$separated[0]][$separated[1]] = $local_value;
                        } else {
                            // UPDATE because the global values have already been INSERTed
                            ilSetupLanguage::updateLangEntry(
                                $separated[0],
                                $separated[1],
                                $lang_key,
                                $separated[2],
                                $change_date
                            );
                            $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($lang_key, "text") .
                        " AND module = " . $ilDB->quote($module, "text");
                    $set = $ilDB->query($q);
                    $row = $ilDB->fetchAssoc($set);
                    $arr2 = unserialize($row["lang_array"]);
                    if (is_array($arr2)) {
                        $lang_arr = array_merge($arr2, $lang_arr);
                    }
                }
                ilSetupLanguage::replaceLangModule($lang_key, $module, $lang_arr);
            }
        }

        chdir($tmpPath);
    }

    final public static function replaceLangModule($a_key, $a_module, $a_array)
    {
        global $ilDB;
        
        $ilDB->manipulate(sprintf(
            "DELETE FROM lng_modules WHERE lang_key = %s AND module = %s",
            $ilDB->quote($a_key, "text"),
            $ilDB->quote($a_module, "text")
        ));
        /*$ilDB->manipulate(sprintf("INSERT INTO lng_modules (lang_key, module, lang_array) VALUES ".
            "(%s,%s,%s)", $ilDB->quote($a_key, "text"),
            $ilDB->quote($a_module, "text"),
            $ilDB->quote(serialize($a_array), "clob")));*/
        $ilDB->insert("lng_modules", array(
            "lang_key" => array("text", $a_key),
            "module" => array("text", $a_module),
            "lang_array" => array("clob", serialize($a_array))
            ));
    }

    final public static function replaceLangEntry(
        $a_module,
        $a_identifier,
        $a_lang_key,
        $a_value,
        $a_local_change = null
    ) {
        global $ilDB;

        $ilDB->manipulate(sprintf(
            "DELETE FROM lng_data WHERE module = %s AND " .
            "identifier = %s AND lang_key = %s",
            $ilDB->quote($a_module, "text"),
            $ilDB->quote($a_identifier, "text"),
            $ilDB->quote($a_lang_key, "text")
        ));

        // insert a new value if no local value exists
        // reset local_change if the values are equal
        $ilDB->manipulate(sprintf(
            "INSERT INTO lng_data " .
            "(module, identifier, lang_key, value, local_change) " .
            "VALUES (%s,%s,%s,%s,%s)",
            $ilDB->quote($a_module, "text"),
            $ilDB->quote($a_identifier, "text"),
            $ilDB->quote($a_lang_key, "text"),
            $ilDB->quote($a_value, "text"),
            $ilDB->quote($a_local_change, "timestamp")
        ));
    }

    final public static function updateLangEntry(
        $a_module,
        $a_identifier,
        $a_lang_key,
        $a_value,
        $a_local_change = null
    ) {
        global $ilDB;
        
        $ilDB->manipulate(sprintf(
            "UPDATE lng_data " .
            "SET value = %s, local_change = %s " .
            "WHERE module = %s AND identifier = %s AND lang_key = %s ",
            $ilDB->quote($a_value, "text"),
            $ilDB->quote($a_local_change, "timestamp"),
            $ilDB->quote($a_module, "text"),
            $ilDB->quote($a_identifier, "text"),
            $ilDB->quote($a_lang_key, "text")
        ));
    }

    public function getLocalLanguages()
    {
        $local_langs = array();
        if (is_dir($this->cust_lang_path)) {
            $d = dir($this->cust_lang_path);
            $tmpPath = getcwd();
            chdir($this->cust_lang_path);
    
            // get available .lang.local files
            while ($entry = $d->read()) {
                if (is_file($entry) && (preg_match("~(^ilias_.{2}\.lang.local$)~", $entry))) {
                    $lang_key = substr($entry, 6, 2);
                    $local_langs[] = $lang_key;
                }
            }
    
            chdir($tmpPath);
        }

        return $local_langs;
    }

    public 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) && (preg_match("~(^ilias_.{2}\.lang$)~", $entry))) {
                $lang_key = substr($entry, 6, 2);
                $languages1[] = $lang_key;
            }
        }
        
        //$languages = array_intersect($languages1,$setup_langs);

        chdir($tmpPath);

        return $languages1;
    }
    
    public 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;
    }
    
    public function loadLanguageModule($a_module)
    {
    }
} // END class.ilSetupLanguage