class.ilLanguage.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2009 ILIAS open source, Extended GPL, see docs/LICENSE */


class ilLanguage
{
    public $ilias;
    
    public $text;
    
    public $lang_default;

    public $lang_user;

    public $lang_path;

    public $lang_key;

    public $lang_name;

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

    public $loaded_modules;

    protected static $used_topics = array();

    protected static $used_modules = array();
    protected $cached_modules = array();

    protected $map_modules_txt = array();

    protected $usage_log_enabled = false;

    protected static $lng_log = array();

    public function __construct($a_lang_key)
    {
        global $DIC;
        $ilIliasIniFile = $DIC->iliasIni();

        $this->log = $DIC->logger()->root();

        $this->lang_key = $a_lang_key;
        
        $this->text = array();
        $this->loaded_modules = array();

        $this->usage_log_enabled = self::isUsageLogEnabled();

        $this->lang_path = ILIAS_ABSOLUTE_PATH . "/lang";
        $this->cust_lang_path = ILIAS_ABSOLUTE_PATH . "/Customizing/global/lang";

        $this->lang_default = $ilIliasIniFile->readVariable("language", "default");

        if ($DIC->offsetExists('ilSetting')) {
            $ilSetting = $DIC->settings();
            if ($ilSetting->get("language") != "") {
                $this->lang_default = $ilSetting->get("language");
            }
        }
        if ($DIC->offsetExists('ilUser')) {
            $ilUser = $DIC->user();
            $this->lang_user = $ilUser->prefs["language"];
        }

        $langs = $this->getInstalledLanguages();
        
        if (!in_array($this->lang_key, $langs)) {
            $this->lang_key = $this->lang_default;
        }

        require_once('./Services/Language/classes/class.ilCachedLanguage.php');
        $this->global_cache = ilCachedLanguage::getInstance($this->lang_key);
        if ($this->global_cache->isActive()) {
            $this->cached_modules = $this->global_cache->getTranslations();
        }

        $this->loadLanguageModule("common");

        return true;
    }

    public function getLangKey()
    {
        return $this->lang_key;
    }
    
    public function getDefaultLanguage()
    {
        return $this->lang_default ? $this->lang_default : 'en';
    }
    
    public function txtlng($a_module, $a_topic, $a_language)
    {
        if (strcmp($a_language, $this->lang_key) == 0) {
            return $this->txt($a_topic);
        } else {
            return ilLanguage::_lookupEntry($a_language, $a_module, $a_topic);
        }
    }

    public function txt($a_topic, $a_default_lang_fallback_mod = "")
    {
        if (empty($a_topic)) {
            return "";
        }

        // remember the used topics
        self::$used_topics[$a_topic] = $a_topic;

        $translation = "";
        if (isset($this->text[$a_topic])) {
            $translation = $this->text[$a_topic];
        }

        if ($translation == "" && $a_default_lang_fallback_mod != "") {
            // #13467 - try current language first (could be missing module)
            if ($this->lang_key != $this->lang_default) {
                $translation = ilLanguage::_lookupEntry(
                    $this->lang_key,
                    $a_default_lang_fallback_mod,
                    $a_topic
                );
            }
            // try default language last
            if ($translation == "" || $translation == "-" . $a_topic . "-") {
                $translation = ilLanguage::_lookupEntry(
                    $this->lang_default,
                    $a_default_lang_fallback_mod,
                    $a_topic
                );
            }
        }


        if ($translation == "") {
            if (ILIAS_LOG_ENABLED && is_object($this->log)) {
                $this->log->debug("Language (" . $a_lang_key . "): topic -" . $a_topic . "- not present");
            }
            return "-" . $a_topic . "-";
        } else {
            if ($this->usage_log_enabled) {
                self::logUsage($this->map_modules_txt[$a_topic], $a_topic);
            }
            return $translation;
        }
    }
    
    public function exists($a_topic)
    {
        return isset($this->text[$a_topic]);
    }
    
    public function loadLanguageModule($a_module)
    {
        global $DIC;
        $ilDB = $DIC->database();

        if (in_array($a_module, $this->loaded_modules)) {
            return;
        }

        $this->loaded_modules[] = $a_module;

        // remember the used modules globally
        self::$used_modules[$a_module] = $a_module;

        $lang_key = $this->lang_key;

        if (empty($this->lang_key)) {
            $lang_key = $this->lang_user;
        }

        if (is_array($this->cached_modules[$a_module])) {
            $this->text = array_merge($this->text, $this->cached_modules[$a_module]);

            if ($this->usage_log_enabled) {
                foreach (array_keys($this->cached_modules[$a_module]) as $key) {
                    $this->map_modules_txt[$key] = $a_module;
                }
            }

            return;
        }

        $q = "SELECT * FROM lng_modules " .
                "WHERE lang_key = " . $ilDB->quote($lang_key, "text") . " AND module = " .
                $ilDB->quote($a_module, "text");
        $r = $ilDB->query($q);
        $row = $r->fetchRow(ilDBConstants::FETCHMODE_ASSOC);
        
        $new_text = unserialize($row["lang_array"]);
        if (is_array($new_text)) {
            $this->text = array_merge($this->text, $new_text);

            if ($this->usage_log_enabled) {
                foreach (array_keys($new_text) as $key) {
                    $this->map_modules_txt[$key] = $a_module;
                }
            }
        }
    }
    
    
    public function getInstalledLanguages()
    {
        return self::_getInstalledLanguages();
    }

    public static function _getInstalledLanguages()
    {
        include_once("./Services/Object/classes/class.ilObject.php");
        $langlist = ilObject::_getObjectsByType("lng");

        foreach ($langlist as $lang) {
            if (substr($lang["desc"], 0, 9) == "installed") {
                $languages[] = $lang["title"];
            }
        }

        return $languages ? $languages : array();
    }

    public static function _lookupEntry($a_lang_key, $a_mod, $a_id)
    {
        global $DIC;
        $ilDB = $DIC->database();
        
        $set = $ilDB->query($q = sprintf(
            "SELECT * FROM lng_data WHERE module = %s " .
            "AND lang_key = %s AND identifier = %s",
            $ilDB->quote((string) $a_mod, "text"),
            $ilDB->quote((string) $a_lang_key, "text"),
            $ilDB->quote((string) $a_id, "text")
        ));
        $rec = $ilDB->fetchAssoc($set);
        
        if ($rec["value"] != "") {
            // remember the used topics
            self::$used_topics[$a_id] = $a_id;
            self::$used_modules[$a_mod] = $a_mod;

            if (self::isUsageLogEnabled()) {
                self::logUsage($a_mod, $a_id);
            }

            return $rec["value"];
        }
        
        return "-" . $a_id . "-";
    }

    public static function lookupId($a_lang_key)
    {
        global $DIC;
        $ilDB = $DIC->database();

        $query = 'SELECT obj_id FROM object_data ' . ' ' .
        'WHERE title = ' . $ilDB->quote($a_lang_key, 'text') . ' ' .
            'AND type = ' . $ilDB->quote('lng', 'text');

        $res = $ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            return $row->obj_id;
        }
        return 0;
    }


    public function getUsedTopics()
    {
        asort(self::$used_topics);
        return self::$used_topics;
    }
    
    public function getUsedModules()
    {
        asort(self::$used_modules);
        return self::$used_modules;
    }

    public function getUserLanguage()
    {
        return $this->lang_user;
    }

    public static function getFallbackInstance()
    {
        return new self('en');
    }

    public static function getGlobalInstance()
    {
        global $DIC;
        $ilSetting = $DIC->settings();
        if ($DIC->offsetExists('ilUser')) {
            $ilUser = $DIC->user();
        }

        if (!ilSession::get('lang') && !$_GET['lang']) {
            if (
                $ilUser instanceof ilObjUser &&
                (!$ilUser->getId() || $ilUser->isAnonymous())
            ) {
                require_once 'Services/Language/classes/class.ilLanguageDetection.php';
                $language_detection = new ilLanguageDetection();
                $language = $language_detection->detect();

                $ilUser->setPref('language', $language);
                $_GET['lang'] = $language;
            }
        }

        if (isset($_POST['change_lang_to']) && $_POST['change_lang_to'] != "") {
            $_GET['lang'] = ilUtil::stripSlashes($_POST['change_lang_to']);
        }

        // prefer personal setting when coming from login screen
        // Added check for ilUser->getId > 0 because it is 0 when the language is changed and the terms of service should be displayed
        if (
            $ilUser instanceof ilObjUser &&
            ($ilUser->getId() && !$ilUser->isAnonymous())
        ) {
            ilSession::set('lang', $ilUser->getPref('language'));
        }

        ilSession::set('lang', (isset($_GET['lang']) && $_GET['lang']) ? $_GET['lang'] : ilSession::get('lang'));

        // check whether lang selection is valid
        $langs = self::_getInstalledLanguages();
        if (!in_array(ilSession::get('lang'), $langs)) {
            if ($ilSetting instanceof ilSetting && $ilSetting->get('language') != '') {
                ilSession::set('lang', $ilSetting->get('language'));
            } else {
                ilSession::set('lang', $langs[0]);
            }
        }
        $_GET['lang'] = ilSession::get('lang');

        return new self(ilSession::get('lang'));
    }

    /*
     * Transfer text to Javascript
     *
     * @param string|array $a_lang_key languag key or array of language keys
     * @param ilTemplate $a_tpl template
     */
    public function toJS($a_lang_key, ilTemplate $a_tpl = null)
    {
        global $DIC;
        $tpl = $DIC['tpl'];

        if (!is_object($a_tpl)) {
            $a_tpl = $tpl;
        }

        if (!is_array($a_lang_key)) {
            $a_lang_key = array($a_lang_key);
        }

        $map = array();
        foreach ($a_lang_key as $lk) {
            $map[$lk] = $this->txt($lk);
        }
        $this->toJSMap($map, $a_tpl);
    }

    public function toJSMap($a_map, ilTemplate $a_tpl = null)
    {
        global $DIC;
        $tpl = $DIC['tpl'];

        if (!is_object($a_tpl)) {
            $a_tpl = $tpl;
        }

        if (!is_array($a_map)) {
            return;
        }

        foreach ($a_map as $k => $v) {
            if ($v != "") {
                include_once("./Services/JSON/classes/class.ilJsonUtil.php");
                $a_tpl->addOnloadCode("il.Language.setLangVar('" . $k . "', " . ilJsonUtil::encode($v) . ");");
            }
        }
    }

    protected static function logUsage($a_module, $a_identifier)
    {
        if ($a_module != "" && $a_identifier != "") {
            self::$lng_log[$a_identifier] = $a_module;
        }
    }

    protected static function isUsageLogEnabled()
    {
        global $DIC;
        $ilClientIniFile = $DIC->clientIni();
        $ilDB = $DIC->database();

        if (!(($ilDB instanceof ilDBMySQL) || ($ilDB instanceof ilDBPdoMySQLMyISAM)) || !$ilClientIniFile instanceof ilIniFile) {
            return false;
        }

        if (DEVMODE) {
            return true;
        }

        if (!$ilClientIniFile->variableExists('system', 'LANGUAGE_LOG')) {
            return $ilClientIniFile->readVariable('system', 'LANGUAGE_LOG') == 1;
        }
        return false;
    }

    public function __destruct()
    {
        global $DIC;

        //case $ilDB not existing should not happen but if something went wrong it shouldn't leads to any failures
        if (!$this->usage_log_enabled || !$DIC->isDependencyAvailable("database")) {
            return;
        }

        $ilDB = $DIC->database();

        foreach ((array) self::$lng_log as $identifier => $module) {
            $wave[] = '(' . $ilDB->quote($module, 'text') . ', ' . $ilDB->quote($identifier, 'text') . ')';
            unset(self::$lng_log[$identifier]);

            if (count($wave) == 150 || (count(self::$lng_log) == 0 && count($wave) > 0)) {
                $query = 'REPLACE INTO lng_log (module, identifier) VALUES ' . implode(', ', $wave);
                $ilDB->manipulate($query);

                $wave = array();
            }
        }
    }
} // END class.Language