class.ilObjLanguageExtGUI.php

Go to the documentation of this file.

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

define("ILIAS_LANGUAGE_MODULE", "Services/Language");

require_once("./Services/Object/classes/class.ilObjectGUI.php");
require_once("Services/Language/classes/class.ilObjLanguageAccess.php");


class ilObjLanguageExtGUI extends ilObjectGUI
{
        private $inputsize = 50;
        private $commentsize = 30;

        function ilObjLanguageExtGUI($a_data, $a_id = 0, $a_call_by_reference = false)
        {
                global $lng, $ilCtrl, $ilClientIniFile;

                // language maintenance strings are defined in administration
        $lng->loadLanguageModule("administration");
        $lng->loadLanguageModule("meta");

                //  view mode ('translate' or empty) needed for prepareOutput()
                $ilCtrl->saveParameter($this, "view_mode");

                // type and id of get the bound object
                $this->type = "lng";
                if (! $this->id = $_GET['obj_id'])
                {
                        $this->id = ilObjLanguageAccess::_lookupId($lng->getUserLanguage());
                }
                
                // do all generic GUI initialisations
                $this->ilObjectGUI($a_data, $this->id, false, true);
                
                // initialize the array to store GUI session variables
                if (!is_array($_SESSION[get_class($this)]))
                {
                        $_SESSION[get_class($this)] = array();
                }
                $this->session =& $_SESSION[get_class($this)];


                // read the lang mode
        $this->langmode = $ilClientIniFile->readVariable("system","LANGMODE");
        }


        function assignObject()
        {
                require_once("Services/Language/classes/class.ilObjLanguageExt.php");
                $this->object =& new ilObjLanguageExt($this->id);
        }


        function &executeCommand()
        {
                global $ilHelp;
                
                if (!ilObjLanguageAccess::_checkMaintenance())
                {
             $this->ilErr->raiseError($this->lng->txt("permission_denied"),$this->ilErr->MESSAGE);
             exit;
                }
                
                $cmd = $this->ctrl->getCmd("view")."Object";
                $this->$cmd();
                
                $ilHelp->setScreenIdComponent("lng");
//              exit;
        }

        
        function cancelObject()
        {
                $this->viewObject();
        }

        function viewObject()
        {
                global $ilUser;
                
                $this->tpl->addBlockFile("ADM_CONTENT", "adm_content", "tpl.lang_edit_items.html", "Services/Language");

                // set the language to compare with
        $compare = $this->getPar('compare', $this->lng->getDefaultLanguage());

                // get the default values if the compare language is the same
                if ($compare == $this->object->key)
                {
                        $compare_object = $this->object->getGlobalLanguageFile();
                        $compare_content = $compare_object->getAllValues();
                        $compare_comments = $compare_object->getAllComments();
                        $compare_note = " ". $this->lng->txt("language_default_entries");
                }

                // get the remarks in database
                $remarks = $this->object->getAllRemarks();

                // page translation mode:
                // - the table is filtered by a list of modules and topics
                // - all found entries are shown on the same page
                if ($this->_isPageTranslation())
                {
                        $offset = 0;
                        $limit = 0;

                        $modules = $this->getPar("page_modules", array());
                        $topics = $this->getPar("page_topics", array());

                        if (!isset($compare_content))
                        {
                                $compare_content = ilObjLanguageExt::_getValues(
                                                                        $compare, $modules, $topics);

                                $compare_comments = ilObjLanguageExt::_getRemarks($compare);
                        }

                        $translations = ilObjLanguageExt::_getValues(
                                                        $this->object->key, $modules, $topics);
                }
                // normal view mode:
                // - the table is filtered manually by module, mode and pattern
                // - found entries are paged by maximum list length
                // - the filter selection is shown
                else
                {
                        $offset = $this->getPar('offset','0');
                        $limit = $ilUser->getPref("hits_per_page");

                        $filter_mode = $this->getPar('filter_mode','all');
                        $filter_pattern = $this->getPar('filter_pattern','');
                        $filter_module = $this->getPar('filter_module','administration');
                        $filter_modules = $filter_module ? array($filter_module) : array();

                        if (!isset($compare_content))
                        {
                                $compare_content = ilObjLanguageExt::_getValues(
                                                        $compare, $filter_modules);

                                $compare_comments = ilObjLanguageExt::_getRemarks($compare);
                        }

                        switch ($filter_mode)
                        {
                                case "changed":
                                        $translations = $this->object->getChangedValues(
                                                                $filter_modules, $filter_pattern);
                                        break;

                                case "added":   //langmode only
                                        $translations = $this->object->getAddedValues(
                                                                $filter_modules, $filter_pattern);
                                        break;

                                case "unchanged":
                                        $translations = $this->object->getUnchangedValues(
                                                        $filter_modules, $filter_pattern);
                                        break;
                                        
                                case "commented":
                    $translations = $this->object->getCommentedValues(
                                                        $filter_modules, $filter_pattern);
                                        break;

                                case "dbremarks":
                    $translations = $this->object->getAllValues(
                                                        $filter_modules, $filter_pattern);

                                        $translations = array_intersect_key($translations, $remarks);
                                        break;

                                case "equal":
                    $translations = $this->object->getAllValues(
                                                        $filter_modules, $filter_pattern);

                                        $translations = array_intersect_assoc($translations, $compare_content);
                                        break;

                                case "different":
                    $translations = $this->object->getAllValues(
                                                        $filter_modules, $filter_pattern);

                                        $translations = array_diff_assoc($translations, $compare_content);
                                        break;

                                case "conflicts":
                                    $former_file = $this->object->getCustLangPath() . '/ilias_' . $this->object->key . '.lang';
                                        if (!is_readable($former_file))
                                        {
                        ilUtil::sendFailure(sprintf($this->lng->txt("language_former_file_missing"), $former_file)
                                                                                .'<br />'. $this->lng->txt("language_former_file_description") , false);
                        $translations = array();
                        break;
                                        }
                                        $global_file_obj = $this->object->getGlobalLanguageFile();
                                        $former_file_obj = new ilLanguageFile($former_file);
                                        $former_file_obj->read();
                                        $global_changes = array_diff_assoc(
                                                                                        $global_file_obj->getAllValues(),
                                                                                        $former_file_obj->getAllValues());
                                        if (!count($global_changes))
                                        {
                        ilUtil::sendInfo(sprintf($this->lng->txt("language_former_file_equal"), $former_file)
                                                                                .'<br />'. $this->lng->txt("language_former_file_description") , false);
                        $translations = array();
                        break;
                                        }
                                        $translations = $this->object->getChangedValues(
                                                                $filter_modules, $filter_pattern);

                                        $translations = array_intersect_key($translations, $global_changes);
                                    break;

                                case "all":
                                default:
                                        $translations = $this->object->getAllValues(
                                                        $filter_modules, $filter_pattern);
                        }

                        // show the filter section
                        $this->tpl->setCurrentBlock("filter");

                        // filter by language module
                        $options = array();
                        $options[""] = $this->lng->txt("language_all_modules");
                        $modules = ilObjLanguageExt::_getModules($this->object->key);
                        foreach ($modules as $mod)
                        {
                                $options[$mod] = $mod;
                        }
                        $this->tpl->setVariable("SELECT_MODULE",
                                ilUtil::formSelect($filter_module, "filter_module", $options, false, true));
                                
                        // filter by mode
                        $options = array();
                        $options["all"] = $this->lng->txt("language_scope_global");
                        $options["changed"] = $this->lng->txt("language_scope_local");
                        if ($this->langmode)
                        {
                                $options["added"] = $this->lng->txt("language_scope_added");
                        }
                        $options["unchanged"] = $this->lng->txt("language_scope_unchanged");
                        $options["equal"] = $this->lng->txt("language_scope_equal");
                        $options["different"] = $this->lng->txt("language_scope_different");
                        $options["commented"] = $this->lng->txt("language_scope_commented");
                        if ($this->langmode)
                        {
                                $options["dbremarks"] = $this->lng->txt("language_scope_dbremarks");
                        }
                        $options["conflicts"] = $this->lng->txt("language_scope_conflicts");
                        $this->tpl->setVariable("SELECT_MODE",
                                ilUtil::formSelect($filter_mode, "filter_mode", $options, false, true));
                        
                        // filter by pattern
                        $this->tpl->setVariable("PATTERN_NAME", "filter_pattern");
                        $this->tpl->setVariable("PATTERN_VALUE", ilUtil::prepareFormOutput($filter_pattern));

                        // and general filter variables
                        $this->tpl->setVariable("FILTER_ACTION", $this->ctrl->getFormAction($this));
                        $this->tpl->setVariable("TXT_FILTER", $this->lng->txt("filter"));
                        $this->tpl->setVariable("OFFSET_NAME", "offset");
                        $this->tpl->setVariable("OFFSET_VALUE", "0");
                        $this->tpl->setVariable("TXT_APPLY_FILTER", $this->lng->txt("apply_filter"));
                        $this->tpl->setVariable("CMD_FILTER", "view");
                        $this->tpl->parseCurrentBlock();
                }
                
                // show the compare section
                $this->tpl->setCurrentBlock("compare");
                $this->tpl->setVariable("COMPARE_ACTION", $this->ctrl->getFormAction($this));
                $this->tpl->setVariable("TXT_COMPARE", $this->lng->txt("language_compare"));
                $this->tpl->setVariable("TXT_CHANGE", $this->lng->txt("change"));
                $options = array();
                $langlist = $this->lng->getInstalledLanguages();
                foreach ($langlist as $lang_key)
                {
                $options[$lang_key] = $this->lng->txt("meta_l_".$lang_key);
                }
                $this->tpl->setVariable("SELECT_COMPARE",
                        ilUtil::formSelect($compare, "compare", $options, false, true,1));
                $this->tpl->setVariable("CMD_COMPARE", "view");
                $this->tpl->parseCurrentBlock();

                // prepare the dataset for the output table
                $sort_by = $this->getPar('sort_by','translation');
                $sort_order = $this->getPar('sort_order','asc');

                $list = array();
                foreach($translations as $name => $translation)
                {
                        $keys = explode($this->lng->separator, $name);
                        $data = array();
                        
                        $data["module"] = $keys[0];
                        $data["topic"] = $keys[1];
                        $data["name"] = $name;
                        $data["translation"] = $translation;
                        $data["default"] = $compare_content[$name];
                        $data["default_comment"] = $compare_comments[$name];

                        $list[] = $data;
                }
                $list = ilUtil::sortArray($list, $sort_by, $sort_order);
                if ($limit > 0)
                {
                        $list = array_slice($list, $offset, $limit);
                }

                // create and configure the table object
                include_once 'Services/Table/classes/class.ilTableGUI.php';
                $tbl = new ilTableGUI();

                $tbl->disable('title');
 
                $tbl->setHeaderNames(array($this->lng->txt("module"),
                                                                   $this->lng->txt("identifier"),
                                                                   $this->lng->txt("meta_l_".$this->object->key),
                                                                   $this->lng->txt("meta_l_".$compare).$compare_note));

                $tbl->setHeaderVars(array("module",
                                                                  "topic",
                                                                  "translation",
                                                                  "default"),
                                                        $this->ctrl->getParameterArray($this));


                $tbl->setColumnWidth(array( "10%",
                                                                        "20%",
                                                                        "40%",
                                                                        "30%"));

                $tbl->setOrderColumn($sort_by);
                $tbl->setOrderDirection($sort_order);
                $tbl->setLimit($limit);
                $tbl->setOffset($offset);
                $tbl->setMaxCount(count($translations));


                // prepare the table template
                $tpl =& new ilTemplate("tpl.table.html", true, true);
                $tpl->setCurrentBlock("tbl_form_header");
                $tpl->setVariable("FORMACTION",$this->ctrl->getFormAction($this));
                $tpl->parseCurrentBlock();

                $tpl->setCurrentBlock("tbl_action_btn");
                $tpl->setVariable("BTN_NAME",'save');
                $tpl->setVariable("BTN_VALUE",$this->lng->txt('save'));
                $tpl->parseCurrentBlock();
 
                $tpl->setCurrentBlock("tbl_action_row");
                $tpl->setVariable("COLUMN_COUNTS","4");
                $tpl->parseCurrentBlock();

                // render the table rows
        $tpl->addBlockfile("TBL_CONTENT", "tbl_content", "tpl.lang_items_row.html", "Services/Language");
                foreach ($list as $data)
                {
                        if ($this->langmode)
                        {
                    $tpl->setCurrentBlock('comment');
                                $tpl->setVariable("COM_ID", ilUtil::prepareFormOutput($data["name"].$this->lng->separator."comment"));
                                $tpl->setVariable("COM_NAME", ilUtil::prepareFormOutput($data["name"].$this->lng->separator."comment"));
                                $tpl->setVariable("COM_VALUE", ilUtil::prepareFormOutput($remarks[$data["name"]]));
                                $tpl->setVariable("COM_SIZE", $this->commentsize);
                                $tpl->setVariable("COM_MAX", 250);
                                $tpl->setVariable("TXT_COMMENT", $this->lng->txt('comment'));
                                $tpl->parseCurrentBlock();
                }
                        else
                        {
                    $tpl->setCurrentBlock('hidden_comment');
                                $tpl->setVariable("COM_NAME", ilUtil::prepareFormOutput($data["name"].$this->lng->separator."comment"));
                                $tpl->setVariable("COM_VALUE", ilUtil::prepareFormOutput($remarks[$data["name"]]));
                                $tpl->parseCurrentBlock();
                        }

                        $tpl->setCurrentBlock("row");
                        $tpl->setVariable("T_ROWS", ceil(strlen($data["translation"]) / $this->inputsize));
                        $tpl->setVariable("T_SIZE", $this->inputsize);
                        $tpl->setVariable("T_NAME", ilUtil::prepareFormOutput($data["name"]));
                        $tpl->setVariable("T_USER_VALUE", ilUtil::prepareFormOutput($data["translation"]));

                        $tpl->setVariable("MODULE", ilUtil::prepareFormOutput($data["module"]));
                        $tpl->setVariable("TOPIC", ilUtil::prepareFormOutput($data["topic"]));
                        $tpl->setVariable("DEFAULT_VALUE", ilUtil::prepareFormOutput($data["default"]));
                        $tpl->setVariable("COMMENT", ilUtil::prepareFormOutput($data["default_comment"]));
                        $tpl->parseCurrentBlock();
                }

                // render and show the table
                $tbl->setTemplate($tpl);
                $tbl->render();
                $this->tpl->setVariable("TRANSLATION_TABLE", $tpl->get());
//              $this->tpl->show();
        }
        

        function saveObject()
        {
                // prepare the values to be saved
                $save_array = array();
                $remarks_array = array();
                foreach ($_POST as $key => $value)
                {
                        $keys = explode($this->lng->separator, ilUtil::stripSlashes($key, false));

                        if (count($keys) == 2)
                        {
                                // avoid line breaks
                                $value = preg_replace("/(\015\012)|(\015)|(\012)/","<br />",$value);
                                $value = ilUtil::stripSlashes($value, false);
                                $save_array[$key] = $value;

                                $remarks_array[$key] = $_POST[$key.$this->lng->separator."comment"];
                        }
                }
                
                // save the translations
                ilObjLanguageExt::_saveValues($this->object->key, $save_array, $remarks_array);

                // view the list
                $this->viewObject();
        }
        

        function importObject()
        {
                $this->tpl->addBlockFile("ADM_CONTENT", "adm_content", "tpl.lang_file_import.html", "Services/Language");

                $this->tpl->setVariable("FORMACTION",$this->ctrl->getFormAction($this));
                $this->tpl->setVariable("TXT_HEADER",$this->lng->txt("language_import_file"));
                $this->tpl->setVariable("TXT_FILE",$this->lng->txt("file"));
                
                $this->tpl->setVariable("TXT_MODE",$this->lng->txt("language_mode_existing"));
                $this->tpl->setVariable("TXT_MODE_KEEPALL",$this->lng->txt("language_mode_existing_keepall"));
                $this->tpl->setVariable("TXT_MODE_KEEPNEW",$this->lng->txt("language_mode_existing_keepnew"));
                $this->tpl->setVariable("TXT_MODE_REPLACE",$this->lng->txt("language_mode_existing_replace"));
                $this->tpl->setVariable("TXT_MODE_DELETE",$this->lng->txt("language_mode_existing_delete"));

                $this->tpl->setVariable("TXT_UPLOAD",$this->lng->txt("upload"));
                $this->tpl->setVariable("CMD_UPLOAD","upload");
//              $this->tpl->show();
        }
        
        
        function uploadObject()
        {
                if ($_POST['cmd']['upload'])
                {
                        $file = $_FILES['userfile']['tmp_name'].'x';
                        
                        if (ilUtil::moveUploadedFile($_FILES['userfile']['tmp_name'],
                                                                                 $_FILES['userfile']['name'],
                                                                                 $file))
                        {
                                $this->object->importLanguageFile($file,$_POST['mode_existing']);
                                ilUtil::sendSuccess(sprintf($this->lng->txt("language_file_imported"), $_FILES['userfile']['name']) , false);
                                $this->importObject();
                        }
                        else
                        {
                                $this->importObject();
                        }
                }
                else
                {
                        $this->cancelObject();
                }
        }

        
        function exportObject()
        {
                $scope = $_POST["scope"] ? $_POST["scope"] : "global";
                
                $this->tpl->addBlockFile("ADM_CONTENT", "adm_content", "tpl.lang_file_export.html", "Services/Language");

                $this->tpl->setVariable("FORMACTION",$this->ctrl->getFormAction($this));
                $this->tpl->setVariable("TXT_HEADER",$this->lng->txt("language_export_file"));

                $this->tpl->setVariable("TXT_SCOPE",$this->lng->txt("language_file_scope"));
                $this->tpl->setVariable("TXT_SCOPE_GLOBAL",$this->lng->txt("language_scope_global"));
                $this->tpl->setVariable("TXT_SCOPE_LOCAL",$this->lng->txt("language_scope_local"));
                $this->tpl->setVariable("TXT_SCOPE_UNCHANGED",$this->lng->txt("language_scope_unchanged"));

                $this->tpl->setVariable("CHECKED_GLOBAL",$scope == 'global' ? 'checked="checked"' : '');
                $this->tpl->setVariable("CHECKED_LOCAL",$scope == 'local' ? 'checked="checked"' : '');
                $this->tpl->setVariable("CHECKED_UNCHANGED",$scope == 'unchanged' ? 'checked="checked"' : '');

                if ($this->langmode)
                {
                        $this->tpl->setVariable("TXT_SCOPE_ADDED",$this->lng->txt("language_scope_added"));
                        $this->tpl->setVariable("CHECKED_ADDED",$scope == 'added' ? 'checked="checked"' : '');

                        $this->tpl->setVariable("TXT_SCOPE_MERGED",$this->lng->txt("language_scope_merged"));
                        $this->tpl->setVariable("CHECKED_MERGED",$scope == 'merged' ? 'checked="checked"' : '');
            }

                $this->tpl->setVariable("TXT_DOWNLOAD",$this->lng->txt("download"));
                $this->tpl->setVariable("CMD_DOWNLOAD","download");
//              $this->tpl->show();
        }

        
        function downloadObject()
        {
                $filename = 'ilias_' . $this->object->key . '_'
                . str_replace(".", "_", substr(ILIAS_VERSION, 0, strpos(ILIAS_VERSION, " ")))
        . "-" . date('Y-m-d')
                . ".lang.".$_POST["scope"];
                
                $global_file_obj = $this->object->getGlobalLanguageFile();
                $local_file_obj = new ilLanguageFile($filename, $this->object->key, $_POST["scope"]);

                if ($_POST["scope"] == 'global')
                {
            $local_file_obj->setParam("author", $global_file_obj->getParam('author'));
            $local_file_obj->setParam("version", $global_file_obj->getParam('version'));
                        $local_file_obj->setAllValues($this->object->getAllValues());
                        if ($this->langmode)
                        {
                                $local_file_obj->setAllComments($this->object->getAllRemarks());
                        }
                }
                elseif ($_POST["scope"] == 'local')
                {
                $local_file_obj->setParam("based_on", $global_file_obj->getParam('version'));
                        $local_file_obj->setAllValues($this->object->getChangedValues());
                        if ($this->langmode)
                        {
                                $local_file_obj->setAllComments($this->object->getAllRemarks());
                        }
                }
                elseif ($_POST["scope"] == 'added') // langmode only
                {
                $local_file_obj->setParam("author", $global_file_obj->getParam('author'));
            $local_file_obj->setParam("version", $global_file_obj->getParam('version'));
                        $local_file_obj->setAllValues($this->object->getAddedValues());
                        $local_file_obj->setAllComments($this->object->getAllRemarks());
                }
                elseif ($_POST["scope"] == 'unchanged')
                {
                $local_file_obj->setParam("author", $global_file_obj->getParam('author'));
            $local_file_obj->setParam("version", $global_file_obj->getParam('version'));
                        $local_file_obj->setAllValues($this->object->getUnchangedValues());
                        if ($this->langmode)
                        {
                                $local_file_obj->setAllComments($this->object->getAllRemarks());
                        }
                }
                elseif ($_POST["scope"] == 'merged') // langmode only
                {
                $local_file_obj->setParam("author", $global_file_obj->getParam('author'));
            $local_file_obj->setParam("version", $global_file_obj->getParam('version'));
                        $local_file_obj->setAllValues($this->object->getMergedValues());
                        $local_file_obj->setAllComments($this->object->getMergedRemarks());
                }

                ilUtil::deliverData($local_file_obj->build(), $filename);
        }


        function maintainObject()
        {
                global $ilUser;
                
                switch ($_POST["maintain"])
                {
                        // save the local changes to the local language file
                        case "save":
                                $lang_file = $this->object->getCustLangPath() . '/ilias_' . $this->object->key . '.lang.local';

                                if ((is_file($lang_file) and is_writable($lang_file))
                                or (!file_exists($lang_file) and is_writable($this->object->getCustLangPath())))
                                {
                                        // save a copy of the distributed language file
                                        $orig_file = $this->object->getLangPath() . '/ilias_' . $this->object->key . '.lang';
                                        $copy_file = $this->object->getCustLangPath() . '/ilias_' . $this->object->key . '.lang';
                                        @copy($orig_file, $copy_file);

                                        // save a backup of the old local language file
                                        @rename($lang_file, $lang_file.".bak");

                                        // create and write the new local language file
                                        $global_file_obj = $this->object->getGlobalLanguageFile();
                                        $local_file_obj = new ilLanguageFile($lang_file, $this->object->key, 'local');
                                        $local_file_obj->setParam('based_on', $global_file_obj->getParam('version'));
                                        $local_file_obj->setAllValues($this->object->getChangedValues());
                                        if ($this->langmode)
                                        {
                                                $local_file_obj->setAllComments($this->object->getAllRemarks());
                                        }
                                        $local_file_obj->write();
                                        
                                        $this->object->setLocal(true);
                                        ilUtil::sendSuccess($this->lng->txt("language_saved_local") , false);
                                }
                                else
                                {
                                        ilUtil::sendFailure($this->lng->txt("language_error_write_local") , false);
                                }
                                break;
                                
                        // load the content of the local language file
                        case "load":
                                $lang_file = $this->object->getCustLangPath() . '/ilias_' . $this->object->key . '.lang.local';
                            if (is_file($lang_file) and is_readable($lang_file))
                            {
                                        $this->object->importLanguageFile($lang_file, 'replace');
                                        $this->object->setLocal(true);
                                        ilUtil::sendSuccess($this->lng->txt("language_loaded_local") , false);
                                }
                                else
                                {
                                        ilUtil::sendFailure($this->lng->txt("language_error_read_local") , false);
                                }
                                break;

                        // revert the database to the default language file
                        case "clear":
                            $lang_file = $this->object->getLangPath() . '/ilias_' . $this->object->key . '.lang';
                            if (is_file($lang_file) and is_readable($lang_file))
                            {
                                        $this->object->importLanguageFile($lang_file, 'delete');
                                        $this->object->setLocal(false);
                                        ilUtil::sendSuccess($this->lng->txt("language_cleared_local") , false);
                                }
                                else
                                {
                                        ilUtil::sendFailure($this->lng->txt("language_error_clear_local") , false);
                                }
                                break;

                        // delete local additions in the datavase (langmode only)
                        case "delete_added":
                                ilObjLanguageExt::_deleteValues($this->object->key, $this->object->getAddedValues());
                                break;

                        // merge local changes back to the global language file (langmode only)
                        case "merge":

                                $orig_file = $this->object->getLangPath() . '/ilias_' . $this->object->key . '.lang';
                                $copy_file = $this->object->getCustLangPath() . '/ilias_' . $this->object->key . '.lang';

                                if (is_file($orig_file) and is_writable($orig_file))
                                {
                                        // save a copy of the global language file
                                        @copy($orig_file, $copy_file);

                                        // modify and write the new global file
                                        $global_file_obj = $this->object->getGlobalLanguageFile();
                        $global_file_obj->setAllValues($this->object->getMergedValues());
                        $global_file_obj->setAllComments($this->object->getMergedRemarks());
                                        $global_file_obj->write();
                    ilUtil::sendSuccess($this->lng->txt("language_merged_global") , false);
                                }
                                else
                                {
                                        ilUtil::sendFailure($this->lng->txt("language_error_write_global") , false);
                                }
                                break;

                        // remove the local language file (langmode only)
                        case "remove_local_file":
                                $lang_file = $this->object->getCustLangPath() . '/ilias_' . $this->object->key . '.lang.local';

                                if (!is_file($lang_file))
                                {
                                        $this->object->setLocal(false);
                                        ilUtil::sendFailure($this->lng->txt("language_error_local_missed") , false);
                    }
                                elseif (@unlink($lang_file))
                                {
                                        $this->object->setLocal(false);
                                        ilUtil::sendSuccess($this->lng->txt("language_local_file_deleted") , false);
                                }
                                else
                                {
                                        ilUtil::sendFailure($this->lng->txt("language_error_delete_local") , false);
                    }
                                break;

                }
                
                $this->tpl->addBlockFile("ADM_CONTENT", "adm_content", "tpl.lang_maintenance.html", "Services/Language");
                $this->tpl->setVariable("FORMACTION",$this->ctrl->getFormAction($this));
                $this->tpl->setVariable("TXT_MAINTENANCE",$this->lng->txt("language_maintenance"));
                $this->tpl->setVariable("TXT_MAINTAIN_LOCAL",$this->lng->txt("language_maintain_local_changes"));
                $this->tpl->setVariable("TXT_SELECT",$this->lng->txt("please_select"));
                $this->tpl->setVariable("TXT_SAVE",$this->lng->txt("language_save_local_changes"));
                $this->tpl->setVariable("TXT_LOAD",$this->lng->txt("language_load_local_changes"));
                $this->tpl->setVariable("TXT_CLEAR",$this->lng->txt("language_clear_local_changes"));
                if ($this->langmode)
                {
                        $this->tpl->setVariable("TXT_DELETE_ADDED",$this->lng->txt("language_delete_local_additions"));
                        $this->tpl->setVariable("TXT_MERGE",$this->lng->txt("language_merge_local_changes"));
                        $this->tpl->setVariable("TXT_REMOVE_LOCAL_FILE",$this->lng->txt("language_remove_local_file"));
                }
                $this->tpl->setVariable("TXT_NOTE_SAVE",$this->lng->txt("language_note_save_local"));
                $this->tpl->setVariable("TXT_MAINTAIN",$this->lng->txt("language_process_maintenance"));
                $this->tpl->setVariable("VAR_MAINTAIN", "maintain");
                $this->tpl->setVariable("CMD_MAINTAIN", "maintain");
//              $this->tpl->show();
        }

        function settingsObject()
        {
                global $ilSetting;

                $translate_key = "lang_translate_". $this->object->key;

                // save and get the page translation setting
                switch ($_POST["translation"])
                {
                        case "enable":
                                $ilSetting->set($translate_key, true);
                                break;
                        case "disable":
                                $ilSetting->set($translate_key, false);
                }
                $translate = $ilSetting->get($translate_key, false);
                
                $this->tpl->addBlockFile("ADM_CONTENT", "adm_content", "tpl.lang_settings.html", "Services/Language");

                $this->tpl->setVariable("FORMACTION",$this->ctrl->getFormAction($this));
                $this->tpl->setVariable("TXT_SETTINGS",$this->lng->txt("language_settings"));
                $this->tpl->setVariable("TXT_TRANSLATION",$this->lng->txt("language_translation_mode"));
                $this->tpl->setVariable("TXT_TRANSLATION_ENABLED",$this->lng->txt("language_translation_enabled"));
                $this->tpl->setVariable("TXT_TRANSLATION_DISABLED",$this->lng->txt("language_translation_disabled"));
                $this->tpl->setVariable("CHECKED_ENABLE", $translate ? 'checked="checked"': '');
                $this->tpl->setVariable("CHECKED_DISABLE", $translate ? '' : 'checked="checked"');
                $this->tpl->setVariable("TXT_NOTE_TRANSLATION",$this->lng->txt("language_note_translation"));
                $this->tpl->setVariable("TXT_CHANGE_SETTINGS",$this->lng->txt("language_change_settings"));
                $this->tpl->setVariable("CMD_SETTINGS", "settings");
//              $this->tpl->show();
        }

        function statisticsObject()
        {
                $modules = ilObjLanguageExt::_getModules($this->object->key);
                
                $data = array();
                $total = array("",0,0,0);
                foreach($modules as $module)
                {
                        $row = array();
                        $row[0] = $module;
                        $row[1] = count($this->object->getAllValues(array($module)));
                        $row[2] = count($this->object->getChangedValues(array($module)));
                        $row[3] = $row[1]-$row[2];
                        $total[1] += $row[1];
                        $total[2] += $row[2];
                        $total[3] += $row[3];
                        $data[] = $row;
                }
                $total[0] = "<b>".$this->lng->txt("language_all_modules")."</b>";
                $total[1] = "<b>".$total[1]."</b>";
                $total[2] = "<b>".$total[2]."</b>";
                $total[3] = "<b>".$total[3]."</b>";
                $data[] = $total;

                // prepare the templates for output
                $this->tpl->addBlockFile("ADM_CONTENT", "adm_content", "tpl.lang_statistics.html", "Services/Language");
                $this->tpl->addBlockFile("TABLE_STATISTICS", "table_statistics", "tpl.table.html");
                $this->tpl->addBlockFile("TBL_CONTENT", "tbl_content", "tpl.obj_tbl_rows.html");

                // create and configure the table object
                include_once 'Services/Table/classes/class.ilTableGUI.php';
                $tbl = new ilTableGUI();
                $tbl->disable('title');
                $tbl->disable('sort');
                $tbl->disable('numinfo');
                
                $tbl->setHeaderNames(array($this->lng->txt("module"),
                                                                   $this->lng->txt("language_scope_global"),
                                                                   $this->lng->txt("language_scope_local"),
                                                                   $this->lng->txt("language_scope_unchanged")));
                $tbl->setColumnWidth(array( "25%", "25%", "25%", "25%"));
                $tbl->setLimit(count($data));
                $tbl->setData($data);
                
                // show the table
                $tbl->render();
//              $this->tpl->show();
        }
        

        function getPar($a_request_name, $a_default_value)
        {
                // get the parameter value
                if (isset($_GET[$a_request_name]))
                {
                        $param = $_GET[$a_request_name];
                        $from_request = true;
                }
                elseif (isset($_POST[$a_request_name]))
                {
                        $param = $_POST[$a_request_name];
                        $from_request = true;
                }
                elseif (isset($this->session[$a_request_name]))
                {
                        $param = $this->session[$a_request_name];
                        $from_request = false;
                }
                else
                {
                        $param = $a_default_value;
                        $from_request = false;
                }
                
                // strip slashes from request parameters
                if ($from_request)
                {
                        if (is_array($param))
                        {
                                foreach ($param as $key => $value)
                                {
                                        $param[$key] = ilUtil::stripSlashes($value);
                                }
                        }
                        else
                        {
                                $param = ilUtil::stripSlashes($param);
                        }
                }
                
                // make the parameter available to further requests
                $this->session[$a_request_name] = $param;

                return $param;
        }

        function getAdminTabs(&$tabs_gui)
        {
                global $rbacsystem;

                $tabs_gui->addTarget("edit",
                        $this->ctrl->getLinkTarget($this, "view"),
                        array("","view","cancel","save"));

                $tabs_gui->addTarget("export",
                        $this->ctrl->getLinkTarget($this, "export"),
                        array("export","download"));

                $tabs_gui->addTarget("import",
                        $this->ctrl->getLinkTarget($this, "import"),
                        array("import","upload"));

                $tabs_gui->addTarget("language_maintain",
                        $this->ctrl->getLinkTarget($this, "maintain"),
                        array("maintain"));

                $tabs_gui->addTarget("settings",
                        $this->ctrl->getLinkTarget($this, "settings"),
                        array("settings"));
                
                $tabs_gui->addTarget("language_statistics",
                        $this->ctrl->getLinkTarget($this, "statistics"),
                        array("statistics"));
        }


        function prepareOutput()
        {
                if ($this->_isPageTranslation())
                {
                        // show the pure translation page without menu, tabs etc.
                        $this->tpl->addBlockFile("CONTENT","content","tpl.adm_translate.html","Services/Language");
                        $this->tpl->setHeaderPageTitle($this->lng->txt("translation"));
                        $this->tpl->setTitle($this->lng->txt("translation"). " "
                                                                        .$this->lng->txt("meta_l_".$this->object->key));
                        $this->tpl->setTitleIcon(ilUtil::getImagePath("icon_lng_b.png"),
                                                                         $this->lng->txt("obj_" . $this->object->getType()));
                }
                else
                {
                        // show the full page framework
                        parent::prepareOutput();
                }
        }
        
        
        function addAdminLocatorItems()
        {
                global $ilLocator, $tpl;

                $ilLocator->addItem($this->lng->txt("administration"),
                        $this->ctrl->getLinkTargetByClass("iladministrationgui", "frameset"),
                        ilFrameTargetInfo::_getFrame("MainContent"));

                $ilLocator->addItem($this->lng->txt("languages"),
                        $this->ctrl->getLinkTargetByClass("ilobjlanguagefoldergui", ""));

                $ilLocator->addItem($this->lng->txt("meta_l_". $this->object->getTitle()),
                        $this->ctrl->getLinkTarget($this, "view"));
        }


        function setTitleAndDescription()
        {
                $this->tpl->setTitle($this->lng->txt("meta_l_".$this->object->getTitle()));
                // $this->tpl->setDescription($this->object->getLongDescription());
                $this->tpl->setTitleIcon(ilUtil::getImagePath("icon_".$this->object->getType()."_b.png"), $this->lng->txt("obj_" . $this->object->getType()));
        }


        //
        // STATIC FUNCTIONS
        //

        public static function _isPageTranslation()
        {
                return ($_GET['view_mode'] == "translate");
        }


        public static function _getTranslationLink()
        {
                global $ilSetting, $lng;

                // prevent translation link on translation screen
                // check setting of translation mode
                if (self::_isPageTranslation()
                        or !$ilSetting->get("lang_translate_".$lng->getLangKey()))
                {
                        return "";
                }

                // set the target for translation
                // ref id must be given to prevent params being deleted by ilAdministrtionGUI
                $action = "ilias.php"
                        ."?ref_id=".ilobjLanguageAccess::_lookupLangFolderRefId()
                        ."&baseClass=ilAdministrationGUI"
                        ."&cmdClass=ilobjlanguageextgui"
                        ."&view_mode=translate";

                $tpl = new ilTemplate("tpl.translation_link.html",true,true, "Services/Language");

                foreach($lng->getUsedModules() as $module => $dummy)
                {
                        $tpl->setCurrentBlock("hidden");
                        $tpl->setVariable("NAME", "page_modules[]");
                        $tpl->setVariable("VALUE", ilUtil::prepareFormOutput($module));
                        $tpl->parseCurrentBlock();
                }

                foreach($lng->getUsedTopics() as $topic => $dummy)
                {
                        $tpl->setCurrentBlock("hidden");
                        $tpl->setVariable("NAME", "page_topics[]");
                        $tpl->setVariable("VALUE", ilUtil::prepareFormOutput($topic));
                        $tpl->parseCurrentBlock();
                }
                
                $tpl->setVariable("ACTION", $action);
                $tpl->setVariable("TXT_TRANSLATE",$lng->txt("translation"));

                return $tpl->get();
        }

        
} // END class.ilObjLanguageExtGUI
?>