class.ilTestImporter.php

Go to the documentation of this file.

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

include_once("./Services/Export/classes/class.ilXmlImporter.php");

class ilTestImporter extends ilXmlImporter
{
    public static $finallyProcessedTestsRegistry = array();
    
    public function importXmlRepresentation($a_entity, $a_id, $a_xml, $a_mapping)
    {
        // Container import => test object already created
        include_once "./Modules/Test/classes/class.ilObjTest.php";
        ilObjTest::_setImportDirectory($this->getImportDirectoryContainer());

        if ($new_id = $a_mapping->getMapping('Services/Container', 'objs', $a_id)) {
            // container content
            $newObj = ilObjectFactory::getInstanceByObjId($new_id, false);
            $_SESSION['tst_import_subdir'] = $this->getImportPackageName();
            $newObj->saveToDb(); // this generates test id first time
            $questionParentObjId = $newObj->getId();
            $newObj->setOnline(true);
            $questionParentObjId = $newObj->getId();
        } else {
            // single object
            $new_id = $a_mapping->getMapping('Modules/Test', 'tst', 'new_id');
            $newObj = ilObjectFactory::getInstanceByObjId($new_id, false);
            
            if (isset($_SESSION['tst_import_qst_parent'])) {
                $questionParentObjId = $_SESSION['tst_import_qst_parent'];
            } else {
                $questionParentObjId = $newObj->getId();
            }
        }

        $newObj->loadFromDb();

        list($xml_file, $qti_file) = $this->parseXmlFileNames();

        if (!@file_exists($xml_file)) {
            $GLOBALS['ilLog']->write(__METHOD__ . ': Cannot find xml definition: ' . $xml_file);
            return false;
        }
        if (!@file_exists($qti_file)) {
            $GLOBALS['ilLog']->write(__METHOD__ . ': Cannot find xml definition: ' . $qti_file);
            return false;
        }
        
        /* @var ilObjTest $newObj */
        
        // FIXME: Copied from ilObjTestGUI::importVerifiedFileObject
        // TODO: move all logic to ilObjTest::importVerifiedFile and call
        // this method from ilObjTestGUI and ilTestImporter
        $newObj->mark_schema->flush();
        

        if (isset($_SESSION['tst_import_idents'])) {
            $idents = $_SESSION['tst_import_idents'];
        } else {
            $idents = null;
        }

        // start parsing of QTI files
        include_once "./Services/QTI/classes/class.ilQTIParser.php";
        $qtiParser = new ilQTIParser($qti_file, IL_MO_PARSE_QTI, $questionParentObjId, $idents);
        $qtiParser->setTestObject($newObj);
        $result = $qtiParser->startParsing();

        // import page data
        include_once("./Modules/LearningModule/classes/class.ilContObjParser.php");
        $contParser = new ilContObjParser($newObj, $xml_file, basename($this->getImportDirectory()));
        $contParser->setQuestionMapping($qtiParser->getImportMapping());
        $contParser->startParsing();

        foreach ($qtiParser->getQuestionIdMapping() as $oldQuestionId => $newQuestionId) {
            $a_mapping->addMapping(
                "Services/Taxonomy",
                "tax_item",
                "tst:quest:$oldQuestionId",
                $newQuestionId
            );

            $a_mapping->addMapping(
                "Services/Taxonomy",
                "tax_item_obj_id",
                "tst:quest:$oldQuestionId",
                $newObj->getId()
            );

            $a_mapping->addMapping(
                "Modules/Test",
                "quest",
                $oldQuestionId,
                $newQuestionId
            );
        }
        
        if ($newObj->isRandomTest()) {
            $newObj->questions = array();
            $this->importRandomQuestionSetConfig($newObj, $xml_file, $a_mapping);
        }

        // import test results
        if (@file_exists($_SESSION["tst_import_results_file"])) {
            include_once("./Modules/Test/classes/class.ilTestResultsImportParser.php");
            $results = new ilTestResultsImportParser($_SESSION["tst_import_results_file"], $newObj);
            $results->setQuestionIdMapping($a_mapping->getMappingsOfEntity('Modules/Test', 'quest'));
            $results->setSrcPoolDefIdMapping($a_mapping->getMappingsOfEntity('Modules/Test', 'rnd_src_pool_def'));
            $results->startParsing();
        }
        
        $newObj->saveToDb(); // this creates test_fi
        $newObj->update(); // this saves ilObject data
        
        // import skill assignments
        $importedAssignmentList = $this->importQuestionSkillAssignments($a_mapping, $newObj, $xml_file);
        $this->importSkillLevelThresholds($a_mapping, $importedAssignmentList, $newObj, $xml_file);
            
        $a_mapping->addMapping("Modules/Test", "tst", $a_id, $newObj->getId());

        ilObjTest::_setImportDirectory();
    }

    public function finalProcessing($a_mapping)
    {
        $maps = $a_mapping->getMappingsOfEntity("Modules/Test", "tst");
        
        foreach ($maps as $old => $new) {
            if ($old == "new_id" || (int) $old <= 0) {
                continue;
            }
            
            if (isset(self::$finallyProcessedTestsRegistry[$new])) {
                continue;
            }

            /* @var ilObjTest $testOBJ */
            $testOBJ = ilObjectFactory::getInstanceByObjId($new, false);
            if ($testOBJ->isRandomTest()) {
                $this->finalRandomTestTaxonomyProcessing($a_mapping, $old, $new, $testOBJ);
            }
            
            self::$finallyProcessedTestsRegistry[$new] = true;
        }
    }
    
    protected function finalRandomTestTaxonomyProcessing(ilImportMapping $mapping, $oldTstObjId, $newTstObjId, ilObjTest $testOBJ)
    {
        require_once 'Services/Taxonomy/classes/class.ilObjTaxonomy.php';
        
        // get all new taxonomies of this object and store usage for test object
        
        $new_tax_ids = $mapping->getMapping(
            'Services/Taxonomy',
            'tax_usage_of_obj',
            $oldTstObjId
        );
        
        if ($new_tax_ids !== false) {
            $tax_ids = explode(":", $new_tax_ids);
            
            foreach ($tax_ids as $tid) {
                ilObjTaxonomy::saveUsage($tid, $newTstObjId);
            }
        }

        // update all source pool definition's tax/taxNode ids with new mapped id
        
        $ilDB = isset($GLOBALS['DIC']) ? $GLOBALS['DIC']['ilDB'] : $GLOBALS['ilDB'];

        require_once 'Modules/Test/classes/class.ilTestRandomQuestionSetSourcePoolDefinitionFactory.php';
        $srcPoolDefFactory = new ilTestRandomQuestionSetSourcePoolDefinitionFactory(
            $ilDB,
            $testOBJ
        );

        require_once 'Modules/Test/classes/class.ilTestRandomQuestionSetSourcePoolDefinitionList.php';
        $srcPoolDefList = new ilTestRandomQuestionSetSourcePoolDefinitionList(
            $ilDB,
            $testOBJ,
            $srcPoolDefFactory
        );

        $srcPoolDefList->loadDefinitions();

        foreach ($srcPoolDefList as $definition) {
            // #21330
            if (!is_array($definition->getMappedTaxonomyFilter()) || 0 === count($definition->getMappedTaxonomyFilter())) {
                continue;
            }

            $definition->setMappedTaxonomyFilter(
                $this->getNewMappedTaxonomyFilter(
                    $mapping,
                    $definition->getMappedTaxonomyFilter()
                )
            );
            $definition->saveToDb();
        }
    }

    protected function getNewMappedTaxonomyFilter(ilImportMapping $mapping, array $mappedFilter)
    {
        $newMappedFilter = array();

        foreach ($mappedFilter as $taxId => $taxNodes) {
            $newTaxId = $mapping->getMapping(
                'Services/Taxonomy',
                'tax',
                $taxId
            );

            if (!$newTaxId) {
                continue;
            }

            $newMappedFilter[$newTaxId] = array();

            foreach ($taxNodes as $taxNodeId) {
                $newTaxNodeId = $mapping->getMapping(
                    'Services/Taxonomy',
                    'tax_tree',
                    $taxNodeId
                );

                if (!$newTaxNodeId) {
                    continue;
                }

                $newMappedFilter[$newTaxId][] = $newTaxNodeId;
            }
        }

        return $newMappedFilter;
    }

    protected function parseXmlFileNames()
    {
        $GLOBALS['ilLog']->write(__METHOD__ . ': ' . $this->getImportDirectory());
        
        $basename = basename($this->getImportDirectory());

        $xml = $this->getImportDirectory() . '/' . $basename . '.xml';
        $qti = $this->getImportDirectory() . '/' . preg_replace('/test|tst/', 'qti', $basename) . '.xml';
        
        return array($xml,$qti);
    }

    private function getImportDirectoryContainer()
    {
        $dir = $this->getImportDirectory();
        $dir = dirname($dir);
        return $dir;
    }

    private function getImportPackageName()
    {
        $dir = $this->getImportDirectory();
        $name = basename($dir);
        return $name;
    }

    protected function importRandomQuestionSetConfig(ilObjTest $testOBJ, $xmlFile, $a_mapping)
    {
        require_once 'Modules/Test/classes/class.ilObjTestXMLParser.php';
        $parser = new ilObjTestXMLParser($xmlFile);
        $parser->setTestOBJ($testOBJ);
        $parser->setImportMapping($a_mapping);
        $parser->startParsing();
    }
    
    protected function importQuestionSkillAssignments(ilImportMapping $mapping, ilObjTest $testOBJ, $xmlFile)
    {
        require_once 'Modules/TestQuestionPool/classes/questions/class.ilAssQuestionSkillAssignmentXmlParser.php';
        $parser = new ilAssQuestionSkillAssignmentXmlParser($xmlFile);
        $parser->startParsing();
        
        require_once 'Modules/TestQuestionPool/classes/questions/class.ilAssQuestionSkillAssignmentImporter.php';
        $importer = new ilAssQuestionSkillAssignmentImporter();
        $importer->setTargetParentObjId($testOBJ->getId());
        $importer->setImportInstallationId($this->getInstallId());
        $importer->setImportMappingRegistry($mapping);
        $importer->setImportMappingComponent('Modules/Test');
        $importer->setImportAssignmentList($parser->getAssignmentList());
        
        $importer->import();
        
        if ($importer->getFailedImportAssignmentList()->assignmentsExist()) {
            require_once 'Modules/TestQuestionPool/classes/questions/class.ilAssQuestionSkillAssignmentImportFails.php';
            $qsaImportFails = new ilAssQuestionSkillAssignmentImportFails($testOBJ->getId());
            $qsaImportFails->registerFailedImports($importer->getFailedImportAssignmentList());
            
            $testOBJ->setOnline(false);
        }
        
        return $importer->getSuccessImportAssignmentList();
    }
    
    protected function importSkillLevelThresholds(ilImportMapping $mapping, ilAssQuestionSkillAssignmentList $assignmentList, ilObjTest $testOBJ, $xmlFile)
    {
        require_once 'Modules/Test/classes/class.ilTestSkillLevelThresholdXmlParser.php';
        $parser = new ilTestSkillLevelThresholdXmlParser($xmlFile);
        $parser->startParsing();
        
        require_once 'Modules/Test/classes/class.ilTestSkillLevelThresholdImporter.php';
        $importer = new ilTestSkillLevelThresholdImporter();
        $importer->setTargetTestId($testOBJ->getTestId());
        $importer->setImportInstallationId($this->getInstallId());
        $importer->setImportMappingRegistry($mapping);
        $importer->setImportedQuestionSkillAssignmentList($assignmentList);
        $importer->setImportThresholdList($parser->getSkillLevelThresholdImportList());
        $importer->import();
        
        if ($importer->getFailedThresholdImportSkillList()->skillsExist()) {
            require_once 'Modules/Test/classes/class.ilTestSkillLevelThresholdImportFails.php';
            $sltImportFails = new ilTestSkillLevelThresholdImportFails($testOBJ->getId());
            $sltImportFails->registerFailedImports($importer->getFailedThresholdImportSkillList());
            
            $testOBJ->setOnline(false);
        }
    }
}