class.ilObjQuestionPool.php

Go to the documentation of this file.

<?php

include_once "./Modules/Test/classes/inc.AssessmentConstants.php";

class ilObjQuestionPool extends ilObject
{
    private array $mob_ids;
    private array $file_ids;

    public $online;

    private $showTaxonomies = null;

    private $navTaxonomyId = null;

    private $skillServiceEnabled;

    private $import_dir;

    public function __construct($a_id = 0, $a_call_by_reference = true)
    {
        $this->type = "qpl";
        parent::__construct($a_id, $a_call_by_reference);
        $this->setOnline(0);

        $this->skillServiceEnabled = false;
    }

    public function create($a_upload = false): int
    {
        $id = parent::create();

        // meta data will be created by
        // import parser
        if (!$a_upload) {
            $this->createMetaData();
        }
        return $id;
    }

    public function createReference(): int
    {
        $result = parent::createReference();
        $this->saveToDb();
        return $result;
    }

    public function update(): bool
    {
        $this->updateMetaData();
        if (!parent::update()) {
            return false;
        }

        // put here object specific stuff

        return true;
    }

    protected function beforeUpdateMetaData(): bool
    {
        global $DIC;
        $ilUser = $DIC['ilUser'];
        include_once "./Services/MetaData/classes/class.ilMD.php";
        $md = new ilMD($this->getId(), 0, $this->getType());
        $md_gen = $md->getGeneral();
        if ($md_gen == false) {
            include_once "./Services/MetaData/classes/class.ilMDCreator.php";
            $md_creator = new ilMDCreator($this->getId(), 0, $this->getType());
            $md_creator->setTitle($this->getTitle());
            $md_creator->setTitleLanguage($ilUser->getPref('language'));
            $md_creator->create();
        }
        return true;
    }

    public function read($a_force_db = false): void
    {
        parent::read($a_force_db);
        $this->loadFromDb();
    }


    public function delete(): bool
    {
        // always call parent delete function first!!
        if (!parent::delete()) {
            return false;
        }

        // delete meta data
        $this->deleteMetaData();

        //put here your module specific stuff
        $this->deleteQuestionpool();

        require_once 'Modules/TestQuestionPool/classes/questions/class.ilAssQuestionSkillAssignmentImportFails.php';
        $qsaImportFails = new ilAssQuestionSkillAssignmentImportFails($this->getId());
        $qsaImportFails->deleteRegisteredImportFails();

        return true;
    }

    public function deleteQuestionpool(): void
    {
        $questions = &$this->getAllQuestions();

        if (count($questions)) {
            foreach ($questions as $question_id) {
                $this->deleteQuestion($question_id);
            }
        }

        // delete export files
        include_once "./Services/Utilities/classes/class.ilUtil.php";
        $qpl_data_dir = ilFileUtils::getDataDir() . "/qpl_data";
        $directory = $qpl_data_dir . "/qpl_" . $this->getId();
        if (is_dir($directory)) {
            include_once "./Services/Utilities/classes/class.ilUtil.php";
            ilFileUtils::delDir($directory);
        }
    }

    public function deleteQuestion($question_id): void
    {
        include_once "./Modules/Test/classes/class.ilObjTest.php";
        include_once "./Modules/TestQuestionPool/classes/class.assQuestion.php";

        $question = assQuestion::instantiateQuestion($question_id);
        $question->delete($question_id);
    }

    public function loadFromDb(): void
    {
        global $DIC;
        $ilDB = $DIC['ilDB'];

        $result = $ilDB->queryF(
            "SELECT * FROM qpl_questionpool WHERE obj_fi = %s",
            array('integer'),
            array($this->getId())
        );
        if ($result->numRows() == 1) {
            $row = $ilDB->fetchAssoc($result);
            $this->setOnline($row['isonline']);
            $this->setShowTaxonomies($row['show_taxonomies']);
            $this->setNavTaxonomyId($row['nav_taxonomy']);
            $this->setSkillServiceEnabled($row['skill_service']);
        }
    }

    public function saveToDb(): void
    {
        global $DIC;
        $ilDB = $DIC['ilDB'];

        $result = $ilDB->queryF(
            "SELECT id_questionpool FROM qpl_questionpool WHERE obj_fi = %s",
            array('integer'),
            array($this->getId())
        );

        if ($result->numRows() == 1) {
            $result = $ilDB->update(
                'qpl_questionpool',
                array(
                    'isonline' => array('text', $this->getOnline()),
                    'show_taxonomies' => array('integer', (int) $this->getShowTaxonomies()),
                    'nav_taxonomy' => array('integer', (int) $this->getNavTaxonomyId()),
                    'skill_service' => array('integer', (int) $this->isSkillServiceEnabled()),
                    'tstamp' => array('integer', time())
                ),
                array(
                    'obj_fi' => array('integer', $this->getId())
                )
            );
        } else {
            $next_id = $ilDB->nextId('qpl_questionpool');

            $result = $ilDB->insert('qpl_questionpool', array(
                'id_questionpool' => array('integer', $next_id),
                'isonline' => array('text', $this->getOnline()),
                'show_taxonomies' => array('integer', (int) $this->getShowTaxonomies()),
                'nav_taxonomy' => array('integer', (int) $this->getNavTaxonomyId()),
                'skill_service' => array('integer', (int) $this->isSkillServiceEnabled()),
                'tstamp' => array('integer', time()),
                'obj_fi' => array('integer', $this->getId())
            ));
        }
    }

    public function getQuestiontype($question_id)
    {
        global $DIC;
        $ilDB = $DIC['ilDB'];

        if ($question_id < 1) {
            return null;
        }

        $result = $ilDB->queryF(
            "SELECT qpl_qst_type.type_tag FROM qpl_questions, qpl_qst_type WHERE qpl_questions.question_type_fi = qpl_qst_type.question_type_id AND qpl_questions.question_id = %s",
            array('integer'),
            array($question_id)
        );

        if ($result->numRows() == 1) {
            $data = $ilDB->fetchAssoc($result);
            return $data["type_tag"];
        }
        return null;
    }

    public function isInUse($question_id): bool
    {
        global $DIC;
        $ilDB = $DIC['ilDB'];

        $result = $ilDB->queryF(
            "SELECT COUNT(solution_id) solution_count FROM tst_solutions WHERE question_fi = %s",
            array('integer'),
            array($question_id)
        );
        $row = $ilDB->fetchAssoc($result);
        return $row["solution_count"];
    }

    public function createQuestion($question_type, $question_id = -1)
    {
        include_once "./Modules/TestQuestionPool/classes/class.assQuestion.php";
        if ($question_id > 0) {
            return assQuestion::instantiateQuestionGUI($question_id);
        }
        assQuestion::_includeClass($question_type, 1);
        $question_type_gui = $question_type . "GUI";
        $question_gui = new $question_type_gui();
        return $question_gui;
    }

    public function duplicateQuestion($question_id): int
    {
        $question = $this->createQuestion("", $question_id);
        $newtitle = $question->object->getTitle();
        if ($question->object->questionTitleExists($this->getId(), $question->object->getTitle())) {
            $counter = 2;
            while ($question->object->questionTitleExists($this->getId(), $question->object->getTitle() . " ($counter)")) {
                $counter++;
            }
            $newtitle = $question->object->getTitle() . " ($counter)";
        }
        $new_id = $question->object->duplicate(false, $newtitle);
        // update question count of question pool
        ilObjQuestionPool::_updateQuestionCount($this->getId());
        return $new_id;
    }

    public function copyQuestion($question_id, $questionpool_to): int
    {
        $question_gui = $this->createQuestion("", $question_id);
        if ($question_gui->object->getObjId() == $questionpool_to) {
            // the question is copied into the same question pool
            return $this->duplicateQuestion($question_id);
        } else {
            // the question is copied into another question pool
            $newtitle = $question_gui->object->getTitle();
            if ($question_gui->object->questionTitleExists($this->getId(), $question_gui->object->getTitle())) {
                $counter = 2;
                while ($question_gui->object->questionTitleExists($this->getId(), $question_gui->object->getTitle() . " ($counter)")) {
                    $counter++;
                }
                $newtitle = $question_gui->object->getTitle() . " ($counter)";
            }
            return $question_gui->object->copyObject($this->getId(), $newtitle);
        }
    }

    public function getPrintviewQuestions(): array
    {
        global $DIC;
        $ilDB = $DIC['ilDB'];

        $query_result = $ilDB->queryF(
            "SELECT qpl_questions.*, qpl_qst_type.type_tag, qpl_qst_type.plugin, qpl_questions.tstamp updated FROM qpl_questions, qpl_qst_type WHERE qpl_questions.original_id IS NULL AND qpl_questions.tstamp > 0 AND qpl_questions.question_type_fi = qpl_qst_type.question_type_id AND qpl_questions.obj_fi = %s",
            array('integer'),
            array($this->getId())
        );
        $rows = array();
        $types = $this->getQuestionTypeTranslations();
        if ($query_result->numRows()) {
            while ($row = $ilDB->fetchAssoc($query_result)) {
                $row['ttype'] = $types[$row['type_tag']];
                if ($row["plugin"]) {
                    if ($this->isPluginActive($row["type_tag"])) {
                        array_push($rows, $row);
                    }
                } else {
                    array_push($rows, $row);
                }
            }
        }
        return $rows;
    }

    private function exportXMLSettings($xmlWriter): void
    {
        $xmlWriter->xmlStartTag('Settings');

        $xmlWriter->xmlElement('ShowTaxonomies', null, (int) $this->getShowTaxonomies());
        $xmlWriter->xmlElement('NavTaxonomy', null, (int) $this->getNavTaxonomyId());
        $xmlWriter->xmlElement('SkillService', null, (int) $this->isSkillServiceEnabled());

        $xmlWriter->xmlEndTag('Settings');
    }

    public function objectToXmlWriter(ilXmlWriter &$a_xml_writer, $a_inst, $a_target_dir, &$expLog, $questions): void
    {
        global $DIC;
        $ilBench = $DIC['ilBench'];

        $this->mob_ids = array();
        $this->file_ids = array();

        $attrs = array();
        $attrs["Type"] = "Questionpool_Test";
        $a_xml_writer->xmlStartTag("ContentObject", $attrs);

        // MetaData
        $this->exportXMLMetaData($a_xml_writer);

        // Settings
        $this->exportXMLSettings($a_xml_writer);

        // PageObjects
        $expLog->write(date("[y-m-d H:i:s] ") . "Start Export Page Objects");
        $ilBench->start("ContentObjectExport", "exportPageObjects");
        $this->exportXMLPageObjects($a_xml_writer, $a_inst, $expLog, $questions);
        $ilBench->stop("ContentObjectExport", "exportPageObjects");
        $expLog->write(date("[y-m-d H:i:s] ") . "Finished Export Page Objects");

        // MediaObjects
        $expLog->write(date("[y-m-d H:i:s] ") . "Start Export Media Objects");
        $ilBench->start("ContentObjectExport", "exportMediaObjects");
        $this->exportXMLMediaObjects($a_xml_writer, $a_inst, $a_target_dir, $expLog);
        $ilBench->stop("ContentObjectExport", "exportMediaObjects");
        $expLog->write(date("[y-m-d H:i:s] ") . "Finished Export Media Objects");

        // FileItems
        $expLog->write(date("[y-m-d H:i:s] ") . "Start Export File Items");
        $ilBench->start("ContentObjectExport", "exportFileItems");
        $this->exportFileItems($a_target_dir, $expLog);
        $ilBench->stop("ContentObjectExport", "exportFileItems");
        $expLog->write(date("[y-m-d H:i:s] ") . "Finished Export File Items");

        // skill assignments
        $this->populateQuestionSkillAssignmentsXml($a_xml_writer, $questions);

        $a_xml_writer->xmlEndTag("ContentObject");
    }

    protected function populateQuestionSkillAssignmentsXml(ilXmlWriter &$a_xml_writer, $questions): void
    {
        global $DIC;
        $ilDB = $DIC['ilDB'];

        require_once 'Modules/TestQuestionPool/classes/class.ilAssQuestionSkillAssignmentList.php';
        $assignmentList = new ilAssQuestionSkillAssignmentList($ilDB);
        $assignmentList->setParentObjId($this->getId());
        $assignmentList->loadFromDb();
        $assignmentList->loadAdditionalSkillData();

        require_once 'Modules/TestQuestionPool/classes/questions/class.ilAssQuestionSkillAssignmentExporter.php';
        $skillQuestionAssignmentExporter = new ilAssQuestionSkillAssignmentExporter();
        $skillQuestionAssignmentExporter->setXmlWriter($a_xml_writer);
        $skillQuestionAssignmentExporter->setQuestionIds($questions);
        $skillQuestionAssignmentExporter->setAssignmentList($assignmentList);
        $skillQuestionAssignmentExporter->export();
    }

    public function exportXMLMetaData(&$a_xml_writer): void
    {
        include_once("Services/MetaData/classes/class.ilMD2XML.php");
        $md2xml = new ilMD2XML($this->getId(), 0, $this->getType());
        $md2xml->setExportMode(true);
        $md2xml->startExport();
        $a_xml_writer->appendXML($md2xml->getXML());
    }

    public function modifyExportIdentifier($a_tag, $a_param, $a_value)
    {
        if ($a_tag == "Identifier" && $a_param == "Entry") {
            include_once "./Services/Utilities/classes/class.ilUtil.php";
            $a_value = ilUtil::insertInstIntoID($a_value);
        }

        return $a_value;
    }


    public function exportXMLPageObjects(&$a_xml_writer, $a_inst, &$expLog, $questions): void
    {
        global $DIC;
        $ilBench = $DIC['ilBench'];

        include_once "./Modules/LearningModule/classes/class.ilLMPageObject.php";

        foreach ($questions as $question_id) {
            $ilBench->start("ContentObjectExport", "exportPageObject");
            $expLog->write(date("[y-m-d H:i:s] ") . "Page Object " . $question_id);

            $attrs = array();
            $a_xml_writer->xmlStartTag("PageObject", $attrs);


            // export xml to writer object
            $ilBench->start("ContentObjectExport", "exportPageObject_XML");
            include_once("./Modules/TestQuestionPool/classes/class.ilAssQuestionPage.php");
            $page_object = new ilAssQuestionPage($question_id);
            $page_object->buildDom();
            $page_object->insertInstIntoIDs($a_inst);
            $mob_ids = $page_object->collectMediaObjects(false);
            require_once 'Services/COPage/classes/class.ilPCFileList.php';
            $file_ids = ilPCFileList::collectFileItems($page_object, $page_object->getDomDoc());
            $xml = $page_object->getXMLFromDom(false, false, false, "", true);
            $xml = str_replace("&", "&amp;", $xml);
            $a_xml_writer->appendXML($xml);
            $page_object->freeDom();
            unset($page_object);

            $ilBench->stop("ContentObjectExport", "exportPageObject_XML");

            // collect media objects
            $ilBench->start("ContentObjectExport", "exportPageObject_CollectMedia");
            foreach ($mob_ids as $mob_id) {
                $this->mob_ids[$mob_id] = $mob_id;
            }
            $ilBench->stop("ContentObjectExport", "exportPageObject_CollectMedia");

            // collect all file items
            $ilBench->start("ContentObjectExport", "exportPageObject_CollectFileItems");
            //$file_ids = $page_obj->getFileItemIds();
            foreach ($file_ids as $file_id) {
                $this->file_ids[$file_id] = $file_id;
            }
            $ilBench->stop("ContentObjectExport", "exportPageObject_CollectFileItems");

            $a_xml_writer->xmlEndTag("PageObject");

            $ilBench->stop("ContentObjectExport", "exportPageObject");
        }
    }

    public function exportXMLMediaObjects(&$a_xml_writer, $a_inst, $a_target_dir, &$expLog): void
    {
        include_once("./Services/MediaObjects/classes/class.ilObjMediaObject.php");

        foreach ($this->mob_ids as $mob_id) {
            $expLog->write(date("[y-m-d H:i:s] ") . "Media Object " . $mob_id);
            if (ilObjMediaObject::_exists($mob_id)) {
                $media_obj = new ilObjMediaObject($mob_id);
                $media_obj->exportXML($a_xml_writer, $a_inst);
                $media_obj->exportFiles($a_target_dir);
                unset($media_obj);
            }
        }
    }

    public function exportFileItems($target_dir, &$expLog): void
    {
        include_once("./Modules/File/classes/class.ilObjFile.php");

        foreach ($this->file_ids as $file_id) {
            $expLog->write(date("[y-m-d H:i:s] ") . "File Item " . $file_id);
            $file_dir = $target_dir . '/objects/il_' . IL_INST_ID . '_file_' . $file_id;
            ilFileUtils::makeDir($file_dir);
            $file_obj = new ilObjFile($file_id, false);
            $source_file = $file_obj->getFile($file_obj->getVersion());
            if (!is_file($source_file)) {
                $source_file = $file_obj->getFile();
            }
            if (is_file($source_file)) {
                copy($source_file, $file_dir . '/' . $file_obj->getFileName());
            }
            unset($file_obj);
        }
    }

    public function createExportDirectory(): void
    {
        include_once "./Services/Utilities/classes/class.ilUtil.php";
        $qpl_data_dir = ilFileUtils::getDataDir() . "/qpl_data";
        ilFileUtils::makeDir($qpl_data_dir);
        if (!is_writable($qpl_data_dir)) {
            $this->ilias->raiseError("Questionpool Data Directory (" . $qpl_data_dir
                . ") not writeable.", $this->ilias->error_obj->FATAL);
        }

        // create learning module directory (data_dir/lm_data/lm_<id>)
        $qpl_dir = $qpl_data_dir . "/qpl_" . $this->getId();
        ilFileUtils::makeDir($qpl_dir);
        if (!@is_dir($qpl_dir)) {
            $this->ilias->raiseError("Creation of Questionpool Directory failed.", $this->ilias->error_obj->FATAL);
        }
        // create Export subdirectory (data_dir/lm_data/lm_<id>/Export)
        ilFileUtils::makeDir($this->getExportDirectory('xls'));
        if (!@is_dir($this->getExportDirectory('xls'))) {
            $this->ilias->raiseError("Creation of Export Directory failed.", $this->ilias->error_obj->FATAL);
        }
        ilFileUtils::makeDir($this->getExportDirectory('zip'));
        if (!@is_dir($this->getExportDirectory('zip'))) {
            $this->ilias->raiseError("Creation of Export Directory failed.", $this->ilias->error_obj->FATAL);
        }
    }

    public function getExportDirectory($type = ""): string
    {
        include_once "./Services/Utilities/classes/class.ilUtil.php";
        switch ($type) {
            case 'xml':
                include_once("./Services/Export/classes/class.ilExport.php");
                $export_dir = ilExport::_getExportDirectory($this->getId(), $type, $this->getType());
                break;
            case 'xls':
            case 'zip':
                $export_dir = ilFileUtils::getDataDir() . "/qpl_data" . "/qpl_" . $this->getId() . "/export_$type";
                break;
            default:
                $export_dir = ilFileUtils::getDataDir() . "/qpl_data" . "/qpl_" . $this->getId() . "/export";
                break;
        }
        return $export_dir;
    }

    public static function _createImportDirectory(): string
    {
        global $DIC;
        $ilias = $DIC['ilias'];

        include_once "./Services/Utilities/classes/class.ilUtil.php";
        $qpl_data_dir = ilFileUtils::getDataDir() . "/qpl_data";
        ilFileUtils::makeDir($qpl_data_dir);

        if (!is_writable($qpl_data_dir)) {
            $ilias->raiseError("Questionpool Data Directory (" . $qpl_data_dir
                . ") not writeable.", $ilias->error_obj->FATAL);
        }

        // create questionpool directory (data_dir/qpl_data/qpl_import)
        $qpl_dir = $qpl_data_dir . "/qpl_import";
        ilFileUtils::makeDir($qpl_dir);
        if (!@is_dir($qpl_dir)) {
            $ilias->raiseError("Creation of Questionpool Directory failed.", $ilias->error_obj->FATAL);
        }
        return $qpl_dir;
    }

    public static function _setImportDirectory($a_import_dir = null): void
    {
        if (strlen($a_import_dir)) {
            ilSession::set("qpl_import_dir", $a_import_dir);
        } else {
            ilSession::clear("qpl_import_dir");
        }
    }

    public static function _getImportDirectory(): string
    {
        return ilSession::get("qpl_import_dir") ?? '';
    }

    public function getImportDirectory()
    {
        return ilObjQuestionPool::_getImportDirectory();
    }

    public function &getAllQuestions(): array
    {
        global $DIC;
        $ilDB = $DIC['ilDB'];

        $result = $ilDB->queryF(
            "SELECT question_id FROM qpl_questions WHERE obj_fi = %s AND qpl_questions.tstamp > 0 AND original_id IS NULL",
            array('integer'),
            array($this->getId())
        );
        $questions = array();
        while ($row = $ilDB->fetchAssoc($result)) {
            array_push($questions, $row["question_id"]);
        }
        return $questions;
    }

    public function &getAllQuestionIds(): array
    {
        global $DIC;
        $ilDB = $DIC['ilDB'];

        $query_result = $ilDB->queryF(
            "SELECT question_id, qpl_qst_type.type_tag, qpl_qst_type.plugin FROM qpl_questions, qpl_qst_type WHERE original_id IS NULL AND qpl_questions.tstamp > 0 AND obj_fi = %s AND complete = %s AND qpl_questions.question_type_fi = qpl_qst_type.question_type_id",
            array('integer','text'),
            array($this->getId(), 1)
        );
        $questions = array();
        if ($query_result->numRows()) {
            while ($row = $ilDB->fetchAssoc($query_result)) {
                if ($row["plugin"]) {
                    if ($this->isPluginActive($row["type_tag"])) {
                        array_push($questions, $row["question_id"]);
                    }
                } else {
                    array_push($questions, $row["question_id"]);
                }
            }
        }
        return $questions;
    }

    public function checkQuestionParent($questionId): bool
    {
        global $DIC; /* @var ILIAS\DI\Container $DIC */

        $row = $DIC->database()->fetchAssoc($DIC->database()->queryF(
            "SELECT COUNT(question_id) cnt FROM qpl_questions WHERE question_id = %s AND obj_fi = %s",
            array('integer', 'integer'),
            array($questionId, $this->getId())
        ));

        return (bool) $row['cnt'];
    }

    public function getImportMapping(): array
    {
        return array();
    }

    public function questionsToXML($questions): string
    {
        $xml = "";
        // export button was pressed
        if (count($questions) > 0) {
            foreach ($questions as $key => $value) {
                $question = $this->createQuestion("", $value);
                $xml .= $question->object->toXML();
            }
            if (count($questions) > 1) {
                $xml = preg_replace("/<\/questestinterop>\s*<.xml.*?>\s*<questestinterop>/", "", $xml);
            }
        }
        $xml = preg_replace("/(<\?xml[^>]*?>)/", "\\1" . "<!DOCTYPE questestinterop SYSTEM \"ims_qtiasiv1p2p1.dtd\">", $xml);
        return $xml;
    }

    public static function _getQuestionCount($questionpool_id, $complete_questions_only = false): int
    {
        global $DIC;
        $ilDB = $DIC['ilDB'];
        if ($complete_questions_only) {
            $result = $ilDB->queryF(
                "SELECT COUNT(question_id) question_count FROM qpl_questions WHERE obj_fi = %s AND qpl_questions.tstamp > 0 AND original_id IS NULL AND complete = %s",
                array('integer', 'text'),
                array($questionpool_id, 1)
            );
        } else {
            $result = $ilDB->queryF(
                "SELECT COUNT(question_id) question_count FROM qpl_questions WHERE obj_fi = %s AND qpl_questions.tstamp > 0 AND original_id IS NULL",
                array('integer'),
                array($questionpool_id)
            );
        }
        $row = $ilDB->fetchAssoc($result);
        return $row["question_count"];
    }

    public function setOnline($a_online_status): void
    {
        switch ($a_online_status) {
            case 0:
            case 1:
                $this->online = $a_online_status;
                break;
            default:
                $this->online = 0;
                break;
        }
    }

    public function getOnline(): string
    {
        if (strcmp($this->online, "") == 0) {
            $this->online = "0";
        }
        return $this->online;
    }

    public function setShowTaxonomies($showTaxonomies): void
    {
        $this->showTaxonomies = $showTaxonomies;
    }

    public function getShowTaxonomies(): ?bool
    {
        return $this->showTaxonomies;
    }

    public function setNavTaxonomyId($navTaxonomyId): void
    {
        $this->navTaxonomyId = $navTaxonomyId;
    }

    public function getNavTaxonomyId(): ?int
    {
        return $this->navTaxonomyId;
    }

    public function isNavTaxonomyActive(): bool
    {
        return $this->getShowTaxonomies() && (int) $this->getNavTaxonomyId();
    }

    public static function _lookupOnline($a_obj_id, $is_reference = false)
    {
        global $DIC;
        $ilDB = $DIC['ilDB'];

        if ($is_reference) {
            $result = $ilDB->queryF(
                "SELECT qpl_questionpool.isonline FROM qpl_questionpool,object_reference WHERE object_reference.ref_id = %s AND object_reference.obj_id = qpl_questionpool.obj_fi",
                array('integer'),
                array($a_obj_id)
            );
        } else {
            $result = $ilDB->queryF(
                "SELECT isonline FROM qpl_questionpool WHERE obj_fi = %s",
                array('integer'),
                array($a_obj_id)
            );
        }
        if ($result->numRows() == 1) {
            $row = $ilDB->fetchAssoc($result);
            return $row["isonline"];
        }
        return 0;
    }

    public static function _hasEqualPoints($a_obj_id, $is_reference = false): int
    {
        global $DIC;
        $ilDB = $DIC['ilDB'];

        if ($is_reference) {
            $result = $ilDB->queryF(
                "SELECT count(DISTINCT qpl_questions.points) equal_points FROM qpl_questions, object_reference WHERE object_reference.ref_id = %s AND qpl_questions.tstamp > 0 AND object_reference.obj_id = qpl_questions.obj_fi AND qpl_questions.original_id IS NULL",
                array('integer'),
                array($a_obj_id)
            );
        } else {
            $result = $ilDB->queryF(
                "SELECT count(DISTINCT points) equal_points FROM qpl_questions WHERE obj_fi = %s AND qpl_questions.tstamp > 0 AND qpl_questions.original_id IS NULL",
                array('integer'),
                array($a_obj_id)
            );
        }
        if ($result->numRows() == 1) {
            $row = $ilDB->fetchAssoc($result);
            if ($row["equal_points"] == 1) {
                return 1;
            } else {
                return 0;
            }
        }
        return 0;
    }

    public function pasteFromClipboard(): bool
    {
        global $DIC;
        $ilDB = $DIC['ilDB'];

        $success = false;
        if (ilSession::get("qpl_clipboard") != null) {
            $success = true;
            foreach (ilSession::get("qpl_clipboard") as $question_object) {
                if (strcmp($question_object["action"], "move") == 0) {
                    $result = $ilDB->queryF(
                        "SELECT obj_fi FROM qpl_questions WHERE question_id = %s",
                        array('integer'),
                        array($question_object["question_id"])
                    );
                    if ($result->numRows() == 1) {
                        $row = $ilDB->fetchAssoc($result);
                        $source_questionpool = $row["obj_fi"];
                        // change the questionpool id in the qpl_questions table
                        $affectedRows = $ilDB->manipulateF(
                            "UPDATE qpl_questions SET obj_fi = %s WHERE question_id = %s",
                            array('integer','integer'),
                            array($this->getId(), $question_object["question_id"])
                        );
                        if (!$affectedRows) {
                            $success = false;
                        }

                        // move question data to the new target directory
                        $source_path = CLIENT_WEB_DIR . "/assessment/" . $source_questionpool . "/" . $question_object["question_id"] . "/";
                        if (@is_dir($source_path)) {
                            $target_path = CLIENT_WEB_DIR . "/assessment/" . $this->getId() . "/";
                            if (!@is_dir($target_path)) {
                                include_once "./Services/Utilities/classes/class.ilUtil.php";
                                ilFileUtils::makeDirParents($target_path);
                            }
                            rename($source_path, $target_path . $question_object["question_id"]);
                        }
                        // update question count of source question pool
                        ilObjQuestionPool::_updateQuestionCount($source_questionpool);
                    }
                } else {
                    $new_question_id = $this->copyQuestion($question_object["question_id"], $this->getId());
                    if (!$new_question_id) {
                        $success = false;
                    }
                }
            }
        }
        // update question count of question pool
        ilObjQuestionPool::_updateQuestionCount($this->getId());
        ilSession::clear("qpl_clipboard");

        return $success;
    }

    public function copyToClipboard($question_id): void
    {
        if (ilSession::get("qpl_clipboard") == null) {
            ilSession::set("qpl_clipboard", array());
        }
        $clip = ilSession::get('qpl_clipboard');
        $clip[$question_id] = array("question_id" => $question_id, "action" => "copy");
        ilSession::set('qpl_clipboard', $clip);
        //$_SESSION["qpl_clipboard"][$question_id] = array("question_id" => $question_id, "action" => "copy");
    }

    public function moveToClipboard($question_id): void
    {
        if (ilSession::get("qpl_clipboard") == null) {
            ilSession::set("qpl_clipboard", array());
        }
        $clip = ilSession::get('qpl_clipboard');
        $clip[$question_id] = array("question_id" => $question_id, "action" => "move");
        ilSession::set('qpl_clipboard', $clip);
        //$_SESSION["qpl_clipboard"][$question_id] = array("question_id" => $question_id, "action" => "move");
    }

    public function cleanupClipboard($deletedQuestionId): void
    {
        if (ilSession::get('qpl_clipboard') == null) {
            return;
        }

        $clip = ilSession::get('qpl_clipboard');
        if (!isset($clip[$deletedQuestionId])) {
            return;
        }

        unset($clip[$deletedQuestionId]);

        if (!count($clip)) {
            ilSession::clear('qpl_clipboard');
        } else {
            ilSession::set('qpl_clipboard', $clip);
        }
    }

    public static function _isWriteable($object_id, $user_id): bool
    {
        global $DIC;
        $rbacsystem = $DIC['rbacsystem'];

        include_once "./Services/Object/classes/class.ilObject.php";
        $refs = ilObject::_getAllReferences($object_id);
        if (count($refs)) {
            foreach ($refs as $ref_id) {
                if ($rbacsystem->checkAccess("write", $ref_id) && (ilObject::_hasUntrashedReference($object_id))) {
                    return true;
                }
            }
        }
        return false;
    }

    public function &getQuestionDetails($question_ids): array
    {
        global $DIC;
        $ilDB = $DIC['ilDB'];

        $result = array();
        $query_result = $ilDB->query("SELECT qpl_questions.*, qpl_qst_type.type_tag FROM qpl_questions, qpl_qst_type WHERE qpl_questions.question_type_fi = qpl_qst_type.question_type_id AND " . $ilDB->in('qpl_questions.question_id', $question_ids, false, 'integer') . " ORDER BY qpl_questions.title");
        if ($query_result->numRows()) {
            while ($row = $ilDB->fetchAssoc($query_result)) {
                array_push($result, $row);
            }
        }
        return $result;
    }

    public function &getDeleteableQuestionDetails($question_ids): array
    {
        global $DIC;
        $ilDB = $DIC['ilDB'];
        $ilLog = $DIC['ilLog'];

        $result = array();
        $query_result = $ilDB->query("SELECT qpl_questions.*, qpl_qst_type.type_tag FROM qpl_questions, qpl_qst_type WHERE qpl_questions.question_type_fi = qpl_qst_type.question_type_id AND " . $ilDB->in('qpl_questions.question_id', $question_ids, false, 'integer') . " ORDER BY qpl_questions.title");
        if ($query_result->numRows()) {
            include_once "./Modules/TestQuestionPool/classes/class.assQuestion.php";
            while ($row = $ilDB->fetchAssoc($query_result)) {
                if (!assQuestion::_isUsedInRandomTest($row["question_id"])) {
                    array_push($result, $row);
                } else {
                    // the question was used in a random test prior to ILIAS 3.7 so it was inserted
                    // as a reference to the original question pool object and not as a copy. To allow
                    // the deletion of the question pool object, a copy must be created and all database references
                    // of the original question must changed with the reference of the copy

                    // 1. Create a copy of the original question
                    $question = $this->createQuestion("", $row["question_id"]);
                    $duplicate_id = $question->object->duplicate(true);
                    if ($duplicate_id > 0) {
                        // 2. replace the question id in the solutions
                        $affectedRows = $ilDB->manipulateF(
                            "UPDATE tst_solutions SET question_fi = %s WHERE question_fi = %s",
                            array('integer','integer'),
                            array($duplicate_id, $row["question_id"])
                        );

                        // 3. replace the question id in the question list of random tests
                        $affectedRows = $ilDB->manipulateF(
                            "UPDATE tst_test_rnd_qst SET question_fi = %s WHERE question_fi = %s",
                            array('integer','integer'),
                            array($duplicate_id, $row["question_id"])
                        );

                        // 4. replace the question id in the test results
                        $affectedRows = $ilDB->manipulateF(
                            "UPDATE tst_test_result SET question_fi = %s WHERE question_fi = %s",
                            array('integer','integer'),
                            array($duplicate_id, $row["question_id"])
                        );

                        // 5. replace the question id in the test&assessment log
                        $affectedRows = $ilDB->manipulateF(
                            "UPDATE ass_log SET question_fi = %s WHERE question_fi = %s",
                            array('integer','integer'),
                            array($duplicate_id, $row["question_id"])
                        );

                        // 6. The original question can be deleted, so add it to the list of questions
                        array_push($result, $row);
                    }
                }
            }
        }
        return $result;
    }

    public function _getFullPathToQpl($ref_id): string
    {
        global $DIC;
        $tree = $DIC['tree'];
        $path = $tree->getPathFull($ref_id);
        $items = array();
        $counter = 0;
        foreach ($path as $item) {
            if (($counter > 0) && ($counter < count($path) - 1)) {
                array_push($items, $item["title"]);
            }
            $counter++;
        }
        $fullpath = join(" > ", $items);
        include_once "./Services/Utilities/classes/class.ilStr.php";
        if (strlen($fullpath) > 60) {
            $fullpath = ilStr::subStr($fullpath, 0, 30) . "..." . ilStr::subStr($fullpath, ilStr::strLen($fullpath) - 30, 30);
        }
        return $fullpath;
    }

    public static function _getAvailableQuestionpools($use_object_id = false, $equal_points = false, $could_be_offline = false, $showPath = false, $with_questioncount = false, $permission = "read", $usr_id = ""): array
    {
        global $DIC;
        $ilUser = $DIC['ilUser'];
        $ilDB = $DIC['ilDB'];
        $lng = $DIC['lng'];

        $result_array = array();
        $permission = (strlen($permission) == 0) ? "read" : $permission;
        $qpls = ilUtil::_getObjectsByOperations("qpl", $permission, (strlen($usr_id)) ? $usr_id : $ilUser->getId(), -1);
        $obj_ids = array();
        foreach ($qpls as $ref_id) {
            $obj_id = ilObject::_lookupObjId($ref_id);
            $obj_ids[$ref_id] = $obj_id;
        }
        $titles = ilObject::_prepareCloneSelection($qpls, "qpl");
        if (count($obj_ids)) {
            $in = $ilDB->in('object_data.obj_id', $obj_ids, false, 'integer');
            if ($could_be_offline) {
                $result = $ilDB->query("SELECT qpl_questionpool.*, object_data.title FROM qpl_questionpool, object_data WHERE " .
                    "qpl_questionpool.obj_fi = object_data.obj_id AND $in ORDER BY object_data.title");
            } else {
                $result = $ilDB->queryF(
                    "SELECT qpl_questionpool.*, object_data.title FROM qpl_questionpool, object_data WHERE " .
                    "qpl_questionpool.obj_fi = object_data.obj_id AND $in AND qpl_questionpool.isonline = %s " .
                    "ORDER BY object_data.title",
                    array('text'),
                    array(1)
                );
            }
            while ($row = $ilDB->fetchAssoc($result)) {
                $add = true;
                if ($equal_points) {
                    if (!ilObjQuestionPool::_hasEqualPoints($row["obj_fi"])) {
                        $add = false;
                    }
                }
                if ($add) {
                    $ref_id = array_search($row["obj_fi"], $obj_ids);
                    $title = (($showPath) ? $titles[$ref_id] : $row["title"]);
                    if ($with_questioncount) {
                        $title .= " [" . $row["questioncount"] . " " . ($row["questioncount"] == 1 ? $lng->txt("ass_question") : $lng->txt("assQuestions")) . "]";
                    }

                    if ($use_object_id) {
                        $result_array[$row["obj_fi"]] = array(
                            'qpl_id' => $row['obj_fi'],
                            'qpl_title' => $row['title'],
                            "title" => $title,
                            "count" => $row["questioncount"]
                        );
                    } else {
                        $result_array[$ref_id] = array(
                            'qpl_id' => $row['obj_fi'],
                            'qpl_title' => $row['title'],
                            "title" => $title,
                            "count" => $row["questioncount"]
                        );
                    }
                }
            }
        }
        return $result_array;
    }

    public function &getQplQuestions(): array
    {
        global $DIC;
        $ilDB = $DIC['ilDB'];

        $questions = array();
        $result = $ilDB->queryF(
            "SELECT qpl_questions.question_id FROM qpl_questions WHERE qpl_questions.original_id IS NULL AND qpl_questions.tstamp > 0 AND qpl_questions.obj_fi = %s",
            array('integer'),
            array($this->getId())
        );
        while ($row = $ilDB->fetchAssoc($result)) {
            array_push($questions, $row["question_id"]);
        }
        return $questions;
    }

    public function cloneObject(int $a_target_id, int $a_copy_id = 0, bool $a_omit_tree = false): ?ilObject
    {
        $newObj = parent::cloneObject($a_target_id, $a_copy_id, $a_omit_tree);

        $cp_options = ilCopyWizardOptions::_getInstance($a_copy_id);
        $newObj->setOnline($this->getOnline());
        if ($cp_options->isRootNode($this->getRefId())) {
            $newObj->setOnline(0);
        }

        $newObj->setSkillServiceEnabled($this->isSkillServiceEnabled());
        $newObj->setShowTaxonomies($this->getShowTaxonomies());
        $newObj->saveToDb();

        // clone the questions in the question pool
        $questions = &$this->getQplQuestions();
        $questionIdsMap = array();
        foreach ($questions as $question_id) {
            $newQuestionId = $newObj->copyQuestion($question_id, $newObj->getId());
            $questionIdsMap[$question_id] = $newQuestionId;
        }

        // clone meta data
        include_once "./Services/MetaData/classes/class.ilMD.php";
        $md = new ilMD($this->getId(), 0, $this->getType());
        $md->cloneMD($newObj->getId(), 0, $newObj->getType());

        // update the metadata with the new title of the question pool
        $newObj->updateMetaData();

        require_once 'Modules/TestQuestionPool/classes/class.ilQuestionPoolTaxonomiesDuplicator.php';
        $duplicator = new ilQuestionPoolTaxonomiesDuplicator();
        $duplicator->setSourceObjId($this->getId());
        $duplicator->setSourceObjType($this->getType());
        $duplicator->setTargetObjId($newObj->getId());
        $duplicator->setTargetObjType($newObj->getType());
        $duplicator->setQuestionIdMapping($questionIdsMap);
        $duplicator->duplicate($duplicator->getAllTaxonomiesForSourceObject());

        $duplicatedTaxKeyMap = $duplicator->getDuplicatedTaxonomiesKeysMap();
        $newObj->setNavTaxonomyId($duplicatedTaxKeyMap->getMappedTaxonomyId($this->getNavTaxonomyId()));
        $newObj->saveToDb();

        return $newObj;
    }

    public function getQuestionTypes($all_tags = false, $fixOrder = false, $withDeprecatedTypes = true): array
    {
        return self::_getQuestionTypes($all_tags, $fixOrder, $withDeprecatedTypes);
    }

    public static function _getQuestionTypes($all_tags = false, $fixOrder = false, $withDeprecatedTypes = true): array
    {
        global $DIC;
        $ilDB = $DIC['ilDB'];
        $lng = $DIC['lng'];

        include_once "./Modules/Test/classes/class.ilObjAssessmentFolder.php";
        $forbidden_types = ilObjAssessmentFolder::_getForbiddenQuestionTypes();
        $lng->loadLanguageModule("assessment");
        $result = $ilDB->query("SELECT * FROM qpl_qst_type");
        $types = array();
        while ($row = $ilDB->fetchAssoc($result)) {
            if ($all_tags || (!in_array($row["question_type_id"], $forbidden_types))) {
                $ilLog = $DIC['ilLog'];

                if ($row["plugin"] == 0) {
                    $types[$lng->txt($row["type_tag"])] = $row;
                } else {
                    $component_factory = $DIC['component.factory'];
                    //$plugins = $component_repository->getPluginSlotById("qst")->getActivePlugins();
                    foreach ($component_factory->getActivePluginsInSlot("qst") as $pl) {
                        if (strcmp($pl->getQuestionType(), $row["type_tag"]) == 0) {
                            $types[$pl->getQuestionTypeTranslation()] = $row;
                        }
                    }
                }
            }
        }

        require_once 'Modules/TestQuestionPool/classes/class.ilAssQuestionTypeOrderer.php';
        $orderMode = ($fixOrder ? ilAssQuestionTypeOrderer::ORDER_MODE_FIX : ilAssQuestionTypeOrderer::ORDER_MODE_ALPHA);
        $orderer = new ilAssQuestionTypeOrderer($types, $orderMode);
        $types = $orderer->getOrderedTypes($withDeprecatedTypes);

        return $types;
    }

    public static function getQuestionTypeByTypeId($type_id)
    {
        global $DIC;
        $ilDB = $DIC['ilDB'];

        $query = "SELECT type_tag FROM qpl_qst_type WHERE question_type_id = %s";
        $types = array('integer');
        $values = array($type_id);
        $result = $ilDB->queryF($query, $types, $values);

        if ($row = $ilDB->fetchAssoc($result)) {
            return $row['type_tag'];
        }
        return null;
    }

    public static function getQuestionTypeTranslations(): array
    {
        global $DIC;
        $ilDB = $DIC['ilDB'];
        $lng = $DIC['lng'];
        $ilLog = $DIC['ilLog'];
        $component_factory = $DIC['component.factory'];

        $lng->loadLanguageModule("assessment");
        $result = $ilDB->query("SELECT * FROM qpl_qst_type");
        $types = array();
        while ($row = $ilDB->fetchAssoc($result)) {
            if ($row["plugin"] == 0) {
                $types[$row['type_tag']] = $lng->txt($row["type_tag"]);
            } else {
                foreach ($component_factory->getActivePluginsInSlot("qst") as $pl) {
                    if (strcmp($pl->getQuestionType(), $row["type_tag"]) == 0) {
                        $types[$row['type_tag']] = $pl->getQuestionTypeTranslation();
                    }
                }
            }
        }
        ksort($types);
        return $types;
    }

    public static function &_getSelfAssessmentQuestionTypes($all_tags = false): array
    {
        /*              $allowed_types = array(
                    "assSingleChoice" => 1,
                    "assMultipleChoice" => 2,
                    "assClozeTest" => 3,
                    "assMatchingQuestion" => 4,
                    "assOrderingQuestion" => 5,
                    "assOrderingHorizontal" => 6,
                    "assImagemapQuestion" => 7,
                    "assTextQuestion" => 8,
                    "assTextSubset" => 9,
                    "assErrorText" => 10
                    );*/
        $allowed_types = array(
            "assSingleChoice" => 1,
            "assMultipleChoice" => 2,
            "assKprimChoice" => 3,
            "assClozeTest" => 4,
            "assMatchingQuestion" => 5,
            "assOrderingQuestion" => 6,
            "assOrderingHorizontal" => 7,
            "assImagemapQuestion" => 8,
            "assTextSubset" => 9,
            "assErrorText" => 10,
            "assLongMenu" => 11
            );
        $satypes = array();
        $qtypes = ilObjQuestionPool::_getQuestionTypes($all_tags);
        foreach ($qtypes as $k => $t) {
            //if (in_array($t["type_tag"], $allowed_types))
            if (isset($allowed_types[$t["type_tag"]])) {
                $t["order"] = $allowed_types[$t["type_tag"]];
                $satypes[$k] = $t;
            }
        }
        return $satypes;
    }


    public function &getQuestionList(): array
    {
        global $DIC;
        $ilDB = $DIC['ilDB'];

        $questions = array();
        $result = $ilDB->queryF(
            "SELECT qpl_questions.*, qpl_qst_type.* FROM qpl_questions, qpl_qst_type WHERE qpl_questions.original_id IS NULL AND qpl_questions.obj_fi = %s AND qpl_questions.tstamp > 0 AND qpl_questions.question_type_fi = qpl_qst_type.question_type_id",
            array('integer'),
            array($this->getId())
        );
        while ($row = $ilDB->fetchAssoc($result)) {
            array_push($questions, $row);
        }
        return $questions;
    }

    public static function _updateQuestionCount($object_id): void
    {
        global $DIC;
        $ilDB = $DIC['ilDB'];
        $result = $ilDB->manipulateF(
            "UPDATE qpl_questionpool SET questioncount = %s, tstamp = %s WHERE obj_fi = %s",
            array('integer','integer','integer'),
            array(ilObjQuestionPool::_getQuestionCount($object_id, true), time(), $object_id)
        );
    }

    public function isPluginActive($questionType): bool
    {
        global $DIC;
        $component_repository = $DIC['component.repository'];

        if (!$component_repository->getComponentByTypeAndName(
            ilComponentInfo::TYPE_MODULES,
            'TestQuestionPool'
        )->getPluginSlotById('qst')->hasPluginName($questionType)) {
            return false;
        }

        return  $component_repository
            ->getComponentByTypeAndName(
                ilComponentInfo::TYPE_MODULES,
                'TestQuestionPool'
            )
            ->getPluginSlotById(
                'qst'
            )
            ->getPluginByName(
                $questionType
            )->isActive();
    }

    /*
    * Remove all questions with owner = 0
    */
    public function purgeQuestions(): void
    {
        global $DIC;
        $ilDB = $DIC['ilDB'];
        $ilUser = $DIC['ilUser'];

        require_once 'Modules/TestQuestionPool/classes/class.ilAssIncompleteQuestionPurger.php';
        $incompleteQuestionPurger = new ilAssIncompleteQuestionPurger($ilDB);
        $incompleteQuestionPurger->setOwnerId($ilUser->getId());
        $incompleteQuestionPurger->purge();
    }

    public function getTaxonomyIds(): array
    {
        require_once 'Services/Taxonomy/classes/class.ilObjTaxonomy.php';
        return ilObjTaxonomy::getUsageOfObject($this->getId());
    }

    public function isSkillServiceEnabled(): bool
    {
        return $this->skillServiceEnabled;
    }

    public function setSkillServiceEnabled($skillServiceEnabled): void
    {
        $this->skillServiceEnabled = $skillServiceEnabled;
    }

    private static $isSkillManagementGloballyActivated = null;

    public static function isSkillManagementGloballyActivated(): ?bool
    {
        if (self::$isSkillManagementGloballyActivated === null) {
            $skmgSet = new ilSkillManagementSettings();

            self::$isSkillManagementGloballyActivated = $skmgSet->isActivated();
        }

        return self::$isSkillManagementGloballyActivated;
    }

    public function fromXML($xmlFile): void
    {
        require_once 'Modules/TestQuestionPool/classes/class.ilObjQuestionPoolXMLParser.php';
        $parser = new ilObjQuestionPoolXMLParser($this, $xmlFile);
        $parser->startParsing();
    }
} // END class.ilObjQuestionPool