class.ilObjSurveyQuestionPoolGUI.php

Go to the documentation of this file.

<?php

use ILIAS\Filesystem\Stream\Streams;
use ILIAS\Filesystem\Util\Archive\Archives as ILIASArchives;
use ILIAS\SurveyQuestionPool\Editing\EditingGUIRequest;
use ILIAS\Refinery\Factory as RefineryFactory;
use ILIAS\HTTP\Services as HTTPServices;

class ilObjSurveyQuestionPoolGUI extends ilObjectGUI implements ilCtrlBaseClassInterface
{
    protected \ILIAS\SurveyQuestionPool\InternalGUIService $gui;
    protected \ILIAS\SurveyQuestionPool\Editing\EditManager $edit_manager;
    protected bool $update;
    protected EditingGUIRequest $edit_request;
    protected ilNavigationHistory $nav_history;
    protected ilHelpGUI $help;
    protected ilLogger $log;
    protected RefineryFactory $refinery;
    protected ILIASArchives $archives;
    public string $defaultscript;

    public function __construct()
    {
        global $DIC;

        $this->nav_history = $DIC["ilNavigationHistory"];
        $this->toolbar = $DIC->toolbar();
        $this->help = $DIC["ilHelp"];
        $this->refinery = $DIC->refinery();
        $this->archives = $DIC->archives();
        $this->edit_request = $DIC->surveyQuestionPool()
            ->internal()
            ->gui()
            ->editing()
            ->request();
        $this->edit_manager = $DIC->surveyQuestionPool()
                                  ->internal()
                                  ->domain()
                                  ->editing();

        $this->type = "spl";

        parent::__construct(
            "",
            $this->edit_request->getRefId(),
            true,
            false
        );
        $this->lng->loadLanguageModule("survey");
        $this->ctrl->saveParameter($this, array("ref_id"));
        $this->log = ilLoggerFactory::getLogger('svy');
        $this->gui = $DIC->surveyQuestionPool()->internal()->gui();
    }

    public function executeCommand(): void
    {
        $ilNavigationHistory = $this->nav_history;
        if (!$this->checkPermissionBool("visible") &&
            !$this->checkPermissionBool("read")) {
            $this->checkPermission("read");
        }

        // add entry to navigation history
        if (!$this->getCreationMode() &&
            $this->checkPermissionBool("read")) {
            $ilNavigationHistory->addItem(
                $this->ref_id,
                "ilias.php?baseClass=ilObjSurveyQuestionPoolGUI&cmd=questions&ref_id=" . $this->ref_id,
                "spl"
            );
        }

        $this->tpl->addCss(ilUtil::getStyleSheetLocation("output", "survey.css"), "screen");
        $this->prepareOutput();

        $cmd = $this->ctrl->getCmd("questions");
        $next_class = $this->ctrl->getNextClass($this);
        if ($cmd !== "cancel") {
            $this->ctrl->setReturn($this, "questions");
        }
        $q_type = "";
        if ($this->edit_request->getQuestionId() < 1) {
            $q_type = $this->edit_request->getSelectedQuestionTypes();
        }

        $this->log->debug("- cmd=" . $cmd . " next_class=" . $next_class);
        switch ($next_class) {
            case 'ilobjectmetadatagui':
                $this->tabs_gui->activateTab("meta_data");
                $this->checkPermission('write');
                $md_gui = new ilObjectMetaDataGUI($this->object);
                $this->ctrl->forwardCommand($md_gui);
                break;

            case 'ilpermissiongui':
                $perm_gui = new ilPermissionGUI($this);
                $this->ctrl->forwardCommand($perm_gui);
                break;

            case 'ilobjectcopygui':
                $cp = new ilObjectCopyGUI($this);
                $cp->setType('spl');
                $this->ctrl->forwardCommand($cp);
                break;

            case 'ilinfoscreengui':
                $this->tabs_gui->activateTab("info_short");
                $this->infoScreenForward();
                break;

            case "ilcommonactiondispatchergui":
                $gui = ilCommonActionDispatcherGUI::getInstanceFromAjaxCall();
                $this->ctrl->forwardCommand($gui);
                break;

            case strtolower(\ILIAS\SurveyQuestionPool\Settings\SettingsGUI::class):
                $this->checkPermission("write");
                $this->tabs_gui->activateTab("settings");
                $gui = $this->gui->settings()->settingsGUI(
                    $this->object->getId(),
                    $this->object->getRefId()
                );
                $this->ctrl->forwardCommand($gui);
                break;

            case strtolower(ilExportGUI::class):
                $export = new ilExportGUI($this, $this->object);
                $this->ctrl->forwardCommand($export);
                break;

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

            default:
                $q_gui = SurveyQuestionGUI::_getQuestionGUI(
                    $q_type,
                    $this->edit_request->getQuestionId()
                );
                $this->log->debug("- This is the switch/case default, going to question id =" . $this->edit_request->getQuestionId());
                $q_gui->setQuestionTabs();
                $this->ctrl->forwardCommand($q_gui);

                // not on create
                if ($q_gui->object->isComplete()) {
                    $this->tpl->setTitle($this->lng->txt("question") . ": " . $q_gui->object->getTitle());
                }
                break;
        }
        if (strtolower($this->edit_request->getBaseClass()) !== "iladministrationgui" &&
            $this->getCreationMode() !== true) {
            $this->tpl->printToStdout();
        }
    }

    public function propertiesObject(?ilPropertyFormGUI $a_form = null): void
    {
        $this->ctrl->redirectByClass(\ILIAS\SurveyQuestionPool\Settings\SettingsGUI::class);
    }


    public function copyObject(): void
    {
        $qids = $this->edit_request->getQuestionIds();
        if (count($qids) > 0) {
            foreach ($qids as $key => $value) {
                $this->object->copyToClipboard($value);
            }
            $this->tpl->setOnScreenMessage('info', $this->lng->txt("spl_copy_insert_clipboard"), true);
        } else {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt("spl_copy_select_none"), true);
        }
        $this->ctrl->redirect($this, "questions");
    }

    public function moveObject(): void
    {
        $qids = $this->edit_request->getQuestionIds();
        if (count($qids) > 0) {
            foreach ($qids as $key => $value) {
                $this->object->moveToClipboard($value);
            }
            $this->tpl->setOnScreenMessage('info', $this->lng->txt("spl_move_insert_clipboard"), true);
        } else {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt("spl_move_select_none"), true);
        }
        $this->ctrl->redirect($this, "questions");
    }

    public function exportQuestionObject(): void
    {
        $qids = $this->edit_request->getQuestionIds();
        if (count($qids) > 0) {
            $this->createExportFileObject($qids);
        } else {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt("qpl_export_select_none"));
            $this->questionsObject();
        }
    }

    public function exportQuestionExportTabObject(): void
    {
        $qids = $this->http->wrapper()->query()->retrieve(
            "qid",
            $this->refinery->custom()->transformation(function (string $value) {
                $value = urldecode($value);
                return explode(',', $value);
            })
        );
        $this->createExportFileObject($qids);
    }

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

        // create an array of all checked checkboxes
        $checked_questions = $this->edit_request->getQuestionIds();
        if (count($checked_questions) === 0) {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt("qpl_delete_select_none"));
            $this->questionsObject();
            return;
        }

        $cgui = new ilConfirmationGUI();
        $cgui->setHeaderText($this->lng->txt("qpl_confirm_delete_questions"));

        $cgui->setFormAction($this->ctrl->getFormAction($this));
        $cgui->setCancel($this->lng->txt("cancel"), "cancelDeleteQuestions");
        $cgui->setConfirm($this->lng->txt("confirm"), "confirmDeleteQuestions");

        $infos = $this->object->getQuestionInfos($checked_questions);
        foreach ($infos as $data) {
            $txt = $data["title"] . " (" .
                SurveyQuestion::_getQuestionTypeName($data["type_tag"]) . ")";
            if ($data["description"]) {
                $txt .= "<div class=\"small\">" . $data["description"] . "</div>";
            }

            $cgui->addItem("q_id[]", $data["id"], $txt);
        }

        $this->tpl->setContent($cgui->getHTML());
    }

    public function confirmDeleteQuestionsObject(): void
    {
        // delete questions after confirmation
        $this->tpl->setOnScreenMessage('success', $this->lng->txt("qpl_questions_deleted"), true);
        $qids = $this->edit_request->getQuestionIds();
        foreach ($qids as $q_id) {
            $this->object->removeQuestion($q_id);
        }
        $this->ctrl->redirect($this, "questions");
    }

    public function cancelDeleteQuestionsObject(): void
    {
        // delete questions after confirmation
        $this->ctrl->redirect($this, "questions");
    }

    public function pasteObject(): void
    {
        $clip_questions = $this->edit_manager->getQuestionsFromClipboard();
        if (count($clip_questions) > 0) {
            $this->object->pasteFromClipboard();
        } else {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt("spl_paste_no_objects"), true);
        }
        $this->ctrl->redirect($this, "questions");
    }

    public function importQuestionsObject(): void
    {
        $tpl = $this->tpl;
        $form = $this->getImportForm();
        $tpl->setContent($form->getHTML());
    }

    public function getImportForm(): ilPropertyFormGUI
    {
        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this, "uploadQuestions"));
        $form->setTitle($this->lng->txt("import_question"));

        $fi = new ilFileInputGUI($this->lng->txt("select_file"), "qtidoc");
        $fi->setSuffixes(array("xml", "zip"));
        $fi->setRequired(true);
        $form->addItem($fi);

        $form->addCommandButton("uploadQuestions", $this->lng->txt("import"));
        $form->addCommandButton("questions", $this->lng->txt("cancel"));
        return $form;
    }

    public function uploadQuestionsObject(): void
    {
        $form = $this->getImportForm();
        if ($form->checkInput()) {
            // check if file was uploaded
            $source = $_FILES["qtidoc"]["tmp_name"];
            $error = 0;
            if (($source === 'none') || (!$source) || $_FILES["qtidoc"]["error"] > UPLOAD_ERR_OK) {
                $error = 1;
            }
            // check correct file type
            if (!$error && strpos("xml", $_FILES["qtidoc"]["type"]) !== false) {
                $error = 1;
            }
            if (!$error) {
                // import file into questionpool
                // create import directory
                $this->object->createImportDirectory();

                // copy uploaded file to import directory
                $full_path = $this->object->getImportDirectory() . "/" . $_FILES["qtidoc"]["name"];

                ilFileUtils::moveUploadedFile(
                    $_FILES["qtidoc"]["tmp_name"],
                    $_FILES["qtidoc"]["name"],
                    $full_path
                );
                $source = $full_path;
                $this->object->importObject($source, true);
                unlink($source);
            }
            $this->ctrl->redirect($this, "questions");
        } else {
            $form->setValuesByPost();
            $tpl = $this->tpl;
            $tpl->setContent($form->getHTML());
        }
    }

    public function filterQuestionBrowserObject(): void
    {
        $table_gui = new ilSurveyQuestionsTableGUI($this, 'questions');
        $table_gui->writeFilterToSession();
        $this->ctrl->redirect($this, 'questions');
    }

    public function resetfilterQuestionBrowserObject(): void
    {
        $table_gui = new ilSurveyQuestionsTableGUI($this, 'questions');
        $table_gui->resetFilter();
        $this->ctrl->redirect($this, 'questions');
    }

    public function questionsObject(): void
    {
        $this->tabs_gui->activateTab("survey_questions");
        $ilUser = $this->user;
        $ilToolbar = $this->toolbar;

        $this->object->purgeQuestions();

        if ($this->checkPermissionBool('write')) {
            $qtypes = new ilSelectInputGUI("", "sel_question_types");
            $qtypes->setValue($ilUser->getPref("svy_lastquestiontype"));
            $ilToolbar->addInputItem($qtypes);

            $options = array();
            foreach (ilObjSurveyQuestionPool::_getQuestiontypes() as $translation => $data) {
                $options[$data["type_tag"]] = $translation;
            }
            $qtypes->setOptions($options);

            $ilToolbar->setFormAction($this->ctrl->getFormAction($this));

            $this->gui->button(
                $this->lng->txt("svy_create_question"),
                "createQuestion"
            )->submit()->toToolbar();

            $ilToolbar->addSeparator();
            /*
            $this->gui->button(
                $this->lng->txt("import"),
                "importQuestions"
            )->submit()->toToolbar();
            */
        }

        $table_gui = new ilSurveyQuestionsTableGUI($this, 'questions', $this->checkPermissionBool('write'));
        $table_gui->setEditable($this->checkPermissionBool('write'));
        $arrFilter = array();
        foreach ($table_gui->getFilterItems() as $item) {
            if ($item->getValue() !== false) {
                $arrFilter[$item->getPostVar()] = $item->getValue();
            }
        }
        $table_gui->setData($this->object->getQuestionsData($arrFilter));
        $this->tpl->setContent($table_gui->getHTML());
    }

    public function updateObject(): void
    {
        $this->update = $this->object->update();
        $this->tpl->setOnScreenMessage('success', $this->lng->txt("msg_obj_modified"), true);
    }

    protected function afterSave(ilObject $new_object): void
    {
        // always send a message
        $this->tpl->setOnScreenMessage('success', $this->lng->txt("object_added"), true);

        ilUtil::redirect("ilias.php?ref_id=" . $new_object->getRefId() .
            "&baseClass=ilObjSurveyQuestionPoolGUI");
    }

    public function exportObject(): void
    {
        $export = new ilExportGUI($this, $this->object);
        $export->listExportFiles();
    }

    public function createExportFileObject($questions = null): void
    {
        $this->checkPermission("write");

        $svy = $this->object;
        $survey_exp = new ilSurveyQuestionpoolExport($svy);
        $survey_exp->buildExportFile($questions);
        $this->ctrl->redirect($this, "export");
    }

    public function downloadExportFileObject(): void
    {
        $files = $this->edit_request->getFiles();
        if (count($files) === 0) {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt("no_checkbox"), true);
            $this->ctrl->redirect($this, "export");
        }

        if (count($files) > 1) {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt("select_max_one_item"), true);
            $this->ctrl->redirect($this, "export");
        }


        $export_dir = $this->object->getExportDirectory();

        $file = basename($files[0]);

        ilFileDelivery::deliverFileLegacy($export_dir . "/" . $file, $file);
    }

    public function confirmDeleteExportFileObject(): void
    {
        $files = $this->edit_request->getFiles();
        if (count($files) === 0) {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt("no_checkbox"), true);
            $this->ctrl->redirect($this, "export");
        }

        $this->tpl->setOnScreenMessage('question', $this->lng->txt("info_delete_sure"));
        $table_gui = new ilSurveyQuestionPoolExportTableGUI($this, 'export', true);
        $export_dir = $this->object->getExportDirectory();
        $data = array();
        foreach ($files as $exp_file) {
            $file_arr = explode("__", $exp_file);
            $data[] = array('file' => $exp_file,
                            'date' => ilDatePresentation::formatDate(new ilDateTime($file_arr[0], IL_CAL_UNIX)),
                            'size' => filesize($export_dir . "/" . $exp_file)
            );
        }
        $table_gui->setData($data);
        $this->tpl->setVariable('ADM_CONTENT', $table_gui->getHTML());
    }

    public function cancelDeleteExportFileObject(): void
    {
        ilSession::clear("ilExportFiles");
        $this->ctrl->redirect($this, "export");
    }

    public function deleteExportFileObject(): void
    {
        $export_dir = $this->object->getExportDirectory();
        $files = $this->edit_request->getFiles();
        foreach ($files as $file) {
            $file = basename($file);

            $exp_file = $export_dir . "/" . $file;
            $exp_dir = $export_dir . "/" . substr($file, 0, -4);
            if (is_file($exp_file)) {
                unlink($exp_file);
            }
            if (is_dir($exp_dir)) {
                ilFileUtils::delDir($exp_dir);
            }
        }
        $this->ctrl->redirect($this, "export");
    }

    public function createQuestionObject(): void
    {
        $ilUser = $this->user;

        $ilUser->writePref(
            "svy_lastquestiontype",
            $this->edit_request->getSelectedQuestionTypes()
        );

        $q_gui = SurveyQuestionGUI::_getQuestionGUI(
            $this->edit_request->getSelectedQuestionTypes()
        );
        $q_gui->object->setObjId($this->object->getId());
        $q_gui->object->createNewQuestion();

        $this->ctrl->setParameterByClass(get_class($q_gui), "q_id", $q_gui->object->getId());
        $this->ctrl->setParameterByClass(
            get_class($q_gui),
            "sel_question_types",
            $this->edit_request->getSelectedQuestionTypes()
        );
        $this->ctrl->redirectByClass(get_class($q_gui), "editQuestion");
    }

    public function previewObject(): void
    {
        $q_gui = SurveyQuestionGUI::_getQuestionGUI(
            "",
            $this->edit_request->getPreview()
        );
        $this->ctrl->setParameterByClass(get_class($q_gui), "sel_question_types", $q_gui->getQuestionType());
        $this->ctrl->setParameterByClass(get_class($q_gui), "q_id", $this->edit_request->getPreview());
        $this->ctrl->redirectByClass(get_class($q_gui), "preview");
    }

    public function infoScreenObject(): void
    {
        $this->ctrl->redirectByClass(ilInfoScreenGUI::class, "showSummary");
    }

    public function infoScreenForward(): void
    {
        if (!$this->checkPermissionBool("read")) {
            $this->checkPermission("visible");
        }

        $info = new ilInfoScreenGUI($this);
        $info->enablePrivateNotes();

        // standard meta data
        $info->addMetaDataSections($this->object->getId(), 0, $this->object->getType());

        $this->ctrl->forwardCommand($info);
    }

    protected function importFile(string $file_to_import, string $path_to_uploaded_file_in_temp_dir): void
    {
        $unzip = $this->archives->unzip(Streams::ofResource(fopen($file_to_import, 'r')));
        # If export contains a manifest xml use standard import
        if (in_array(basename($file_to_import, ".zip") . DIRECTORY_SEPARATOR . "manifest.xml", iterator_to_array($unzip->getFiles()))) {
            parent::importFile($file_to_import, $path_to_uploaded_file_in_temp_dir);
            return;
        }
        $tpl = $this->tpl;

        $newObj = new ilObjSurveyQuestionPool();
        $newObj->setTitle("dummy");
        $newObj->create();
        $this->putObjectInTree($newObj);

        // import qti data
        $newObj->importObject($file_to_import);

        if ($path_to_uploaded_file_in_temp_dir !== ''
            && $this->temp_file_system->hasDir($path_to_uploaded_file_in_temp_dir)) {
            $this->temp_file_system->deleteDir($path_to_uploaded_file_in_temp_dir);
        }

        $this->deleteUploadedImportFile($path_to_uploaded_file_in_temp_dir);
        $this->tpl->setOnScreenMessage('success', $this->lng->txt("object_imported"), true);
        ilUtil::redirect("ilias.php?ref_id=" . $newObj->getRefId() .
            "&baseClass=ilObjSurveyQuestionPoolGUI");
    }

    protected function addLocatorItems(): void
    {
        $ilLocator = $this->locator;
        switch ($this->ctrl->getCmd()) {
            case "create":
            case "importFile":
            case "cancel":
                break;
            default:
                $ilLocator->addItem($this->object->getTitle(), $this->ctrl->getLinkTarget($this, ""), "", $this->edit_request->getRefId());
                break;
        }
        if ($this->edit_request->getQuestionId() > 0) {
            $q_id = $this->edit_request->getQuestionId();
            $q_type = SurveyQuestion::_getQuestionType($q_id) . "GUI";
            $q_title = SurveyQuestion::_getTitle($q_id);
            if ($q_title) {
                // not on create
                $this->ctrl->setParameterByClass($q_type, "q_id", $q_id);
                $ilLocator->addItem(
                    $q_title,
                    $this->ctrl->getLinkTargetByClass($q_type, "editQuestion")
                );
            }
        }
    }

    protected function getTabs(): void
    {
        $ilHelp = $this->help;
        $ilHelp->setScreenIdComponent("spl");

        if ($this->checkPermissionBool("read")) {
            $this->tabs_gui->addTab(
                "survey_questions",
                $this->lng->txt("survey_questions"),
                $this->ctrl->getLinkTarget($this, 'questions')
            );

            $this->tabs_gui->addTab(
                "info_short",
                $this->lng->txt("info_short"),
                $this->ctrl->getLinkTarget($this, "infoScreen")
            );
        }

        if ($this->checkPermissionBool('write')) {
            $this->tabs_gui->addTab(
                "settings",
                $this->lng->txt("settings"),
                $this->ctrl->getLinkTargetByClass(\ILIAS\SurveyQuestionPool\Settings\SettingsGUI::class)
            );

            // meta data
            $mdgui = new ilObjectMetaDataGUI($this->object);
            $mdtab = $mdgui->getTab();
            if ($mdtab) {
                $this->tabs_gui->addTab(
                    "meta_data",
                    $this->lng->txt("meta_data"),
                    $mdtab
                );
            }

            // export
            $this->tabs_gui->addTab(
                "export",
                $this->lng->txt("export"),
                $this->ctrl->getLinkTarget($this, 'export')
            );
        }

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

    public function saveObligatoryObject(): void
    {
        $obligatory = $this->edit_request->getObligatory();
        $this->object->setObligatoryStates($obligatory);

        $this->tpl->setOnScreenMessage('success', $this->lng->txt('msg_obj_modified'), true);
        $this->ctrl->redirect($this, "questions");
    }

    public static function _goto(string $a_target): void
    {
        global $DIC;
        $main_tpl = $DIC->ui()->mainTemplate();

        $ctrl = $DIC->ctrl();
        $ilAccess = $DIC->access();
        $lng = $DIC->language();

        if ($ilAccess->checkAccess("visible", "", $a_target) ||
            $ilAccess->checkAccess("read", "", $a_target)) {
            $ctrl->setParameterByClass("ilObjSurveyQuestionPoolGUI", "ref_id", $a_target);
            $ctrl->redirectByClass("ilObjSurveyQuestionPoolGUI", "infoScreen");
        } elseif ($ilAccess->checkAccess("read", "", ROOT_FOLDER_ID)) {
            $main_tpl->setOnScreenMessage('failure', sprintf(
                $lng->txt("msg_no_perm_read_item"),
                ilObject::_lookupTitle(ilObject::_lookupObjId($a_target))
            ), true);
            ilObjectGUI::_gotoRepositoryRoot();
        }
    }
}