class.ilObjLanguageFolderGUI.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\HTTP\Services as HTTPServices;
use ILIAS\Refinery\Factory as Refinery;

class ilObjLanguageFolderGUI extends ilObjectGUI
{
    protected HTTPServices $http;
    protected Refinery $refinery;

    public function __construct(?array $a_data, int $a_id, bool $a_call_by_reference)
    {
        global $DIC;
        $this->type = "lngf";
        parent::__construct($a_data, $a_id, $a_call_by_reference, false);
        //$_GET["sort_by"] = "language";
        $this->lng->loadLanguageModule("lng");
        $this->http = $DIC->http();
        $this->refinery = $DIC->refinery();
    }

    public function viewObject(): void
    {
        global $DIC;

        if ($this->checkPermissionBool("write")) {
            // refresh
            $refresh = ilLinkButton::getInstance();
            $refresh->setUrl($this->ctrl->getLinkTarget($this, "confirmRefresh"));
            $refresh->setCaption("refresh_languages");
            $this->toolbar->addButtonInstance($refresh);

            // check languages
            $check = ilLinkButton::getInstance();
            $check->setUrl($this->ctrl->getLinkTarget($this, "checkLanguage"));
            $check->setCaption("check_languages");
            $this->toolbar->addButtonInstance($check);
        }

        $ilClientIniFile = $DIC["ilClientIniFile"];
        if ($ilClientIniFile->variableExists("system", "LANGUAGE_LOG")) {
            $download = ilLinkButton::getInstance();
            $download->setUrl($this->ctrl->getLinkTarget($this, "listDeprecated"));
            $download->setCaption("lng_download_deprecated");
            $this->toolbar->addButtonInstance($download);
        }

        if ($this->checkPermissionBool("write")) {
            if (!$this->settings->get("lang_detection")) {
                // Toggle Button for auto language detection (toggle off)
                $toggleButton = $DIC->ui()->factory()->button()->toggle("", $DIC->ctrl()->getLinkTarget($this, "enableLanguageDetection"), $DIC->ctrl()->getLinkTarget($this, "disableLanguageDetection"), false)
                    ->withLabel($this->lng->txt("language_detection"))->withAriaLabel($this->lng->txt("lng_enable_language_detection"));
            } else {
                // Toggle Button for auto language detection (toggle on)
                $toggleButton = $DIC->ui()->factory()->button()->toggle("", $DIC->ctrl()->getLinkTarget($this, "enableLanguageDetection"), $DIC->ctrl()->getLinkTarget($this, "disableLanguageDetection"), true)
                    ->withLabel($this->lng->txt("language_detection"))->withAriaLabel($this->lng->txt("lng_disable_language_detection"));
            }
            $this->toolbar->addComponent($toggleButton);
        }

        $ltab = new ilLanguageTableGUI($this, "view", $this->object);
        $this->tpl->setContent($ltab->getHTML());
    }

    public function installObject(): void
    {
        $this->checkPermission("write");
        $this->lng->loadLanguageModule("meta");

        foreach ($this->getPostId() as $obj_id) {
            $langObj = new ilObjLanguage((int) $obj_id);
            $key = $langObj->install();

            if ($key !== "") {
                $lang_installed[] = $key;
            }

            unset($langObj);
        }

        if (isset($lang_installed)) {
            if (count($lang_installed) === 1) {
                $this->data = $this->lng->txt("meta_l_" . $lang_installed[0]) . " " . strtolower($this->lng->txt("installed")) . ".";
            } else {
                $langnames = [];
                foreach ($lang_installed as $lang_key) {
                    $langnames[] = $this->lng->txt("meta_l_" . $lang_key);
                }
                $this->data = implode(", ", $langnames) . " " . strtolower($this->lng->txt("installed")) . ".";
            }
        } else {
            $this->data = $this->lng->txt("languages_already_installed");
        }

        $this->out();
    }


    public function installLocalObject(): void
    {
        $this->checkPermission("write");
        $this->lng->loadLanguageModule("meta");

        foreach ($this->getPostId() as $obj_id) {
            $langObj = new ilObjLanguage($obj_id);
            $key = $langObj->install();

            if ($key !== "") {
                $lang_installed[] = $key;
            }

            unset($langObj);

            $langObj = new ilObjLanguage($obj_id);
            $key = $langObj->install("local");

            if ($key !== "") {
                $local_installed[] = $key;
            }

            unset($langObj);
        }

        if (isset($lang_installed)) {
            if (count($lang_installed) === 1) {
                $this->data = $this->lng->txt("meta_l_" . $lang_installed[0]) . " " . strtolower($this->lng->txt("installed")) . ".";
            } else {
                $langnames = [];
                foreach ($lang_installed as $lang_key) {
                    $langnames[] = $this->lng->txt("meta_l_" . $lang_key);
                }
                $this->data = implode(", ", $langnames) . " " . strtolower($this->lng->txt("installed")) . ".";
            }
        }

        if (isset($local_installed)) {
            if (count($local_installed) === 1) {
                $this->data .= " " . $this->lng->txt("meta_l_" . $local_installed[0]) . " " . $this->lng->txt("local_language_file") . " " . strtolower($this->lng->txt("installed")) . ".";
            } else {
                $langnames = [];
                foreach ($local_installed as $lang_key) {
                    $langnames[] = $this->lng->txt("meta_l_" . $lang_key);
                }
                $this->data .= " " . implode(", ", $langnames) . " " . $this->lng->txt("local_language_files") . " " . strtolower($this->lng->txt("installed")) . ".";
            }
        } else {
            $this->data .= " " . $this->lng->txt("local_languages_already_installed");
        }

        $this->out();
    }


    public function uninstallObject(): void
    {
        $this->checkPermission('write');
        $this->lng->loadLanguageModule("meta");

        $sys_lang = false;
        $usr_lang = false;

        // uninstall all selected languages
        foreach ($this->getPostId() as $obj_id) {
            $langObj = new ilObjLanguage($obj_id);
            if (!($sys_lang = $langObj->isSystemLanguage()) && !($usr_lang = $langObj->isUserLanguage())) {
                $key = $langObj->uninstall();
                if ($key !== "") {
                    $lang_uninstalled[] = $key;
                }
            }
            unset($langObj);
        }

        // generate output message
        if (isset($lang_uninstalled)) {
            if (count($lang_uninstalled) === 1) {
                $this->data = $this->lng->txt("meta_l_" . $lang_uninstalled[0]) . " " . $this->lng->txt("uninstalled");
            } else {
                $langnames = [];
                foreach ($lang_uninstalled as $lang_key) {
                    $langnames[] = $this->lng->txt("meta_l_" . $lang_key);
                }

                $this->data = implode(", ", $langnames) . " " . $this->lng->txt("uninstalled");
            }
        } elseif ($sys_lang) {
            $this->data = $this->lng->txt("cannot_uninstall_systemlanguage");
        } elseif ($usr_lang) {
            $this->data = $this->lng->txt("cannot_uninstall_language_in_use");
        } else {
            $this->data = $this->lng->txt("languages_already_uninstalled");
        }

        $this->out();
    }


    public function uninstallChangesObject(): void
    {
        $this->checkPermission("write");

        $this->data = $this->lng->txt("selected_languages_updated");
        $this->lng->loadLanguageModule("meta");
        $refreshed = [];

        foreach ($this->getPostId() as $id) {
            $langObj = new ilObjLanguage((int) $id, false);

            if ($langObj->isInstalled()) {
                if ($langObj->check()) {
                    $langObj->flush("all");
                    $langObj->insert();
                    $langObj->setTitle($langObj->getKey());
                    $langObj->setDescription("installed");
                    $langObj->update();
                    $refreshed[] = $langObj->getKey();
                }
                $this->data .= "<br />" . $this->lng->txt("meta_l_" . $langObj->getKey());
            }

            unset($langObj);
        }
        ilObjLanguage::refreshPlugins($refreshed);
        $this->out();
    }

    public function refreshObject(): void
    {
        $this->checkPermission("write");

        ilObjLanguage::refreshAll();
        $this->data = $this->lng->txt("languages_updated");
        $this->out();
    }


    public function refreshSelectedObject(): void
    {
        $this->checkPermission("write");
        $this->data = $this->lng->txt("selected_languages_updated");
        $this->lng->loadLanguageModule("meta");

        $refreshed = array();
        foreach ($this->getPostId() as $id) {
            $langObj = new ilObjLanguage((int) $id, false);
            if ($langObj->refresh()) {
                $refreshed[] = $langObj->getKey();
                $this->data .= "<br />" . $this->lng->txt("meta_l_" . $langObj->getKey());
            }
            unset($langObj);
        }

        ilObjLanguage::refreshPlugins($refreshed);
        $this->out();
    }

    public function setUserLanguageObject(): void
    {
        global $DIC;
        $ilUser = $DIC->user();

        $this->checkPermission("write");
        $this->lng->loadLanguageModule("meta");

        require_once "./Services/User/classes/class.ilObjUser.php";

        $post_id = $this->getPostId();

        if (count($post_id) !== 1) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt("choose_only_one_language") . "<br/>" . $this->lng->txt("action_aborted"), true);
            $this->ctrl->redirect($this, "view");
        }

        $obj_id = $post_id[0];

        $newUserLangObj = new ilObjLanguage($obj_id);

        if ($newUserLangObj->isUserLanguage()) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt("meta_l_" . $newUserLangObj->getKey()) . " " . $this->lng->txt("is_already_your") . " " . $this->lng->txt("user_language") . "<br/>" . $this->lng->txt("action_aborted"), true);
            $this->ctrl->redirect($this, "view");
        }

        if (!$newUserLangObj->isInstalled()) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt("meta_l_" . $newUserLangObj->getKey()) . " " . $this->lng->txt("language_not_installed") . "<br/>" . $this->lng->txt("action_aborted"), true);
            $this->ctrl->redirect($this, "view");
        }

        $curUser = new ilObjUser($ilUser->getId());
        $curUser->setLanguage($newUserLangObj->getKey());
        $curUser->update();

        $this->data = $this->lng->txt("user_language") . " " . $this->lng->txt("changed_to") . " " . $this->lng->txt("meta_l_" . $newUserLangObj->getKey()) . ".";

        $this->out();
    }


    public function setSystemLanguageObject(): void
    {
        $this->checkPermission("write");
        $this->lng->loadLanguageModule("meta");

        $post_id = $this->getPostId();

        if (count($post_id) !== 1) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt("choose_only_one_language") . "<br/>" . $this->lng->txt("action_aborted"), true);
            $this->ctrl->redirect($this, "view");
        }

        $obj_id = $post_id[0];

        $newSysLangObj = new ilObjLanguage($obj_id);

        if ($newSysLangObj->isSystemLanguage()) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt("meta_l_" . $newSysLangObj->getKey()) . " " . $this->lng->txt("is_already_your") . " " . $this->lng->txt("system_language") . "<br/>" . $this->lng->txt("action_aborted"), true);
            $this->ctrl->redirect($this, "view");
        }

        if (!$newSysLangObj->isInstalled()) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt("meta_l_" . $newSysLangObj->getKey()) . " " . $this->lng->txt("language_not_installed") . "<br/>" . $this->lng->txt("action_aborted"), true);
            $this->ctrl->redirect($this, "view");
        }

        $this->ilias->setSetting("language", $newSysLangObj->getKey());

        // update ini-file
        $this->ilias->ini->setVariable("language", "default", $newSysLangObj->getKey());
        $this->ilias->ini->write();

        $this->data = $this->lng->txt("system_language") . " " . $this->lng->txt("changed_to") . " " . $this->lng->txt("meta_l_" . $newSysLangObj->getKey()) . ".";

        $this->out();
    }

    public function checkLanguageObject(): void
    {
        $this->checkPermission("write");
        $this->data = $this->object->checkAllLanguages();
        $this->out();
    }

    public function out(): void
    {
        $this->tpl->setOnScreenMessage('info', $this->data, true);
        $this->ctrl->redirect($this, "view");
    }

    public function getAdminTabs(): void
    {
        $this->getTabs();
    }

    protected function getTabs(): void
    {
        if ($this->checkPermissionBool("read")) {
            $this->tabs_gui->addTab("settings", $this->lng->txt("settings"), $this->ctrl->getLinkTarget($this, "view"));
        }

        if ($this->checkPermissionBool("edit_permission")) {
            $this->tabs_gui->addTab("perm_settings", $this->lng->txt("perm_settings"), $this->ctrl->getLinkTargetByClass(array(self::class,"ilpermissiongui"), "perm"));
        }
    }

    public function executeCommand(): void
    {
        // always check read permission, needed write permissions are checked in the *Object functions
        $this->checkPermission("read", "", $this->type, $this->ref_id);

        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd();
        $this->prepareOutput();

        switch ($next_class) {
            case "ilpermissiongui":
                include_once "Services/AccessControl/classes/class.ilPermissionGUI.php";
                $perm_gui = new ilPermissionGUI($this);
                $this->tabs_gui->activateTab("perm_settings");
                $this->ctrl->forwardCommand($perm_gui);
                break;

            default:
                $this->tabs_gui->activateTab("settings");

                if (!$cmd) {
                    $cmd = "view";
                }

                $cmd .= "Object";
                $this->$cmd();

                break;
        }
    }

    public function confirmRefreshObject(): void
    {
        $this->checkPermission("write");

        $languages = ilObject::_getObjectsByType("lng");

        $ids = array();
        foreach ($languages as $lang) {
            $langObj = new ilObjLanguage((int) $lang["obj_id"], false);
            if ($langObj->isInstalled()) {
                $ids[] = $lang["obj_id"];
            }
        }
        $this->confirmRefreshSelectedObject($ids);
    }

    public function confirmRefreshSelectedObject(array $a_ids = array()): void
    {
        $this->checkPermission("write");
        $this->lng->loadLanguageModule("meta");

        $header = '';
        $ids = [];
        if (!empty($a_ids)) {
            $ids = $a_ids;
            $header = $this->lng->txt("lang_refresh_confirm");
        } elseif (!empty($post_id = $this->getPostId())) {
            $ids = $post_id;
            $header = $this->lng->txt("lang_refresh_confirm_selected");
        } else {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt("no_checkbox"), true);
            $this->ctrl->redirect($this, "view");
        }

        $conf_screen = new ilConfirmationGUI();
        $some_changed = false;
        foreach ($ids as $id) {
            $lang_key = ilObject::_lookupTitle((int) $id);
            $lang_title = $this->lng->txt("meta_l_" . $lang_key);
            $last_change = ilObjLanguage::_getLastLocalChange($lang_key);
            if (!empty($last_change)) {
                $some_changed = true;
                $lang_title .= " (" . $this->lng->txt("last_change") . " "
                    . ilDatePresentation::formatDate(new ilDateTime($last_change, IL_CAL_DATETIME)) . ")";
            }
            $conf_screen->addItem("id[]", (string) $id, $lang_title);
        }

        $conf_screen->setFormAction($this->ctrl->getFormAction($this));
        if ($some_changed) {
            $header .= "<br />" . $this->lng->txt("lang_refresh_confirm_info");
        }
        $conf_screen->setHeaderText($header);
        $conf_screen->setCancel($this->lng->txt("cancel"), "view");
        $conf_screen->setConfirm($this->lng->txt("ok"), "refreshSelected");
        $this->tpl->setContent($conf_screen->getHTML());
    }

    public function confirmUninstallObject(): void
    {
        $this->checkPermission("write");

        $this->lng->loadLanguageModule("meta");
        $conf_screen = new ilConfirmationGUI();
        $conf_screen->setFormAction($this->ctrl->getFormAction($this));
        $conf_screen->setHeaderText($this->lng->txt("lang_uninstall_confirm"));
        foreach ($this->getPostId() as $id) {
            $lang_title = ilObject::_lookupTitle($id);
            $conf_screen->addItem("id[]", (string) $id, $this->lng->txt("meta_l_" . $lang_title));
        }
        $conf_screen->setCancel($this->lng->txt("cancel"), "view");
        $conf_screen->setConfirm($this->lng->txt("ok"), "uninstall");
        $this->tpl->setContent($conf_screen->getHTML());
    }

    public function confirmUninstallChangesObject(): void
    {
        $this->checkPermission('write');

        $this->lng->loadLanguageModule("meta");
        $conf_screen = new ilConfirmationGUI();
        $conf_screen->setFormAction($this->ctrl->getFormAction($this));
        $conf_screen->setHeaderText($this->lng->txt("lang_uninstall_changes_confirm"));
        foreach ($this->getPostId() as $id) {
            $lang_title = ilObject::_lookupTitle($id);
            $conf_screen->addItem("id[]", (string) $id, $this->lng->txt("meta_l_" . $lang_title));
        }
        $conf_screen->setCancel($this->lng->txt("cancel"), "view");
        $conf_screen->setConfirm($this->lng->txt("ok"), "uninstallChanges");
        $this->tpl->setContent($conf_screen->getHTML());
    }

    public function getActions(): array
    {
        // standard actions for container
        return array(
            "install" => array("name" => "install", "lng" => "install"),
            "installLocal" => array("name" => "installLocal", "lng" => "install_local"),
            "uninstall" => array("name" => "uninstall", "lng" => "uninstall"),
            "refresh" => array("name" => "confirmRefreshSelected", "lng" => "refresh"),
            "setSystemLanguage" => array("name" => "setSystemLanguage", "lng" => "setSystemLanguage"),
            "setUserLanguage" => array("name" => "setUserLanguage", "lng" => "setUserLanguage")
        );
    }

    protected function disableLanguageDetectionObject(): void
    {
        $this->settings->set("lang_detection", '0');
        $this->tpl->setOnScreenMessage('success', $this->lng->txt("saved_successfully"));
        $this->viewObject();
    }

    protected function enableLanguageDetectionObject(): void
    {
        $this->settings->set("lang_detection", '1');
        $this->tpl->setOnScreenMessage('success', $this->lng->txt("saved_successfully"));
        $this->viewObject();
    }

    public function listDeprecatedObject(): void
    {
        $button = ilLinkButton::getInstance();
        $button->setCaption("download");
        $button->setUrl($this->ctrl->getLinkTarget($this, "downloadDeprecated"));
        $this->toolbar->addButtonInstance($button);

        include_once "./Services/Language/classes/class.ilLangDeprecated.php";

        $d = new ilLangDeprecated();
        $res = "";
        foreach ($d->getDeprecatedLangVars() as $key => $mod) {
            $res .= $mod . "," . $key . "\n";
        }

        $this->tpl->setContent("<pre>" . $res . "</pre>");
    }

    public function downloadDeprecatedObject(): void
    {
        include_once "./Services/Language/classes/class.ilLangDeprecated.php";
        $d = new ilLangDeprecated();
        $res = "";
        foreach ($d->getDeprecatedLangVars() as $key => $mod) {
            $res .= $mod . "," . $key . "\n";
        }

        ilUtil::deliverData($res, "lang_deprecated.csv");
    }

    private function getPostId()
    {
        $post_field = [];
        if ($this->http->wrapper()->post()->has("id")) {
            $post_field = $this->http->wrapper()->post()->retrieve(
                "id",
                $this->refinery->kindlyTo()->dictOf(
                    $this->refinery->kindlyTo()->int()
                )
            );
        }
        if ($post_field == null) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt("no_checkbox"), true);
            $this->ctrl->redirect($this, "view");
        }
        return $post_field;
    }
} // END class.ilObjLanguageFolderGUI