class.ilCmiXapiImporter.php

Go to the documentation of this file.

<?php

/* Copyright (c) 1998-2019 ILIAS open source, Extended GPL, see docs/LICENSE */


class ilCmiXapiImporter extends ilXmlImporter
{
    private $_moduleProperties = [];

    public $manifest = [];

    private $_dataset;

    private $_cmixObj;

    private $_newId = null;

    private $_entity;

    private $_import_objId;

    private $_import_dirname;

    private $_mapping;

    private $_hasContent = false;

    private $_relWebDir = 'lm_data/lm_';

    private $_relImportDir = '';

    private $_isSingleImport = false;

    public function __construct()
    {
        require_once "./Modules/CmiXapi/classes/class.ilCmiXapiDataSet.php";
        $this->_dataset = new ilCmiXapiDataSet();
        $this->_dataset->_cmixSettingsProperties['Title'] = '';
        $this->_dataset->_cmixSettingsProperties['Description'] = '';
        //todo: at the moment restricted to one module in xml file, extend?
    }

    public function importXmlRepresentation($a_entity, $a_id, $a_xml, $a_mapping) : void
    {
        global $DIC;
        $this->_entity = $a_entity;
        $this->_import_objId = $a_id;
        $this->_import_dirname = $a_xml;
        $this->_mapping = $a_mapping;

        if (false === ($this->_newId = $a_mapping->getMapping('Services/Container', 'objs', $this->_import_objId))) {
            $this->prepareSingleObject();
            $this->getImportDirectorySingle();
            $this->_isSingleImport = true;
        } else {
            $this->prepareContainerObject();
            $this->getImportDirectoryContainer();
        }
        $this->prepareLocalSourceStorage();
        $this->parseXmlFileProperties();
        $this->updateNewObj();
    }

    private function prepareSingleObject()
    {
        global $DIC;
        // create new cmix object
        $this->_cmixObj = new ilObjCmiXapi();
        // set type of questionpool object
        $this->_cmixObj->setType('cmix');
        // set title of questionpool object to "dummy"
        $this->_cmixObj->setTitle("dummy");
        // set description of questionpool object
        $this->_cmixObj->setDescription("test import");
        // create the questionpool class in the ILIAS database (object_data table)
        $this->_cmixObj->create(true);
        $this->_newId = $this->_cmixObj->getId();
        $this->_mapping->addMapping('Modules/CmiXapi', 'cmix', $this->_import_objId, $this->_newId);
        //$this->getImport();
        $this->_cmixObj->update();

        return $this;
    }

    private function prepareContainerObject() : void
    {
        global $DIC;
        // Container import => test object already created
        include_once "./Modules/Test/classes/class.ilObjTest.php";
        $this->_import_dirname = $this->getImportDirectoryContainer();

        if ($this->_newId = $this->_mapping->getMapping('Services/Container', 'objs', $this->_import_objId)) {
            // container content
            $this->_cmixObj = ilObjectFactory::getInstanceByObjId($this->_newId, false);
            //$_SESSION['tst_import_subdir'] = $this->getImportPackageName();
            $this->_cmixObj->save(); // this generates test id first time
            //var_dump([$this->getImportDirectory(), $this->_import_dirname]); exit;
            $this->_mapping->addMapping("Modules/CmiXapi", "cmix", $this->_import_objId, $this->_newId);
        }
        $this->_cmixObj->save();
        $this->_cmixObj->update();
    }

    private function prepareLocalSourceStorage()
    {
        global $DIC;
        if (true === (bool) $DIC->filesystem()->temp()->has($this->_relImportDir . '/content.zip')) {
            $this->_hasContent = true;
            $this->_relWebDir = $this->_relWebDir . $this->_cmixObj->getId();
            if (false === (bool) $DIC->filesystem()->web()->has($this->_relWebDir)) {
                $DIC->filesystem()->web()->createDir($this->_relWebDir);
                $DIC->filesystem()->web()->put($this->_relWebDir . '/content.zip', $DIC->filesystem()->temp()->read($this->_relImportDir . '/content.zip'));
                $webDataDir = ilUtil::getWebspaceDir();
                ilUtil::unzip($webDataDir . "/" . $this->_relWebDir . "/content.zip");
                $DIC->filesystem()->web()->delete($this->_relWebDir . '/content.zip');
            }
        }
        return $this;
    }

    private function parseXmlFileProperties()
    {
        global $DIC; 
        $xmlRoot = null;
        $xml = $DIC->filesystem()->temp()->readStream($this->_relImportDir . '/properties.xml');
        if ($xml != false) {
            $xmlRoot = simplexml_load_string($xml);
        }
        foreach ($this->_dataset->_cmixSettingsProperties as $key => $property) {
            $this->_moduleProperties[$key] = trim($xmlRoot->$key->__toString());
        }
        return $this;
    }

    private function updateNewObj()
    {
        global $DIC; 
        $this->_cmixObj->setTitle($this->_moduleProperties['Title'] . " " . $DIC->language()->txt("copy_of_suffix"));
        $this->_cmixObj->setDescription($this->_moduleProperties['Description']);
        $this->_cmixObj->update();

        if ($this->_moduleProperties['LrsTypeId']) {
            $this->_cmixObj->setLrsTypeId((int) $this->_moduleProperties['LrsTypeId']);
            $this->_cmixObj->setLrsType(new ilCmiXapiLrsType((int) $this->_moduleProperties['LrsTypeId']));
        }
        $this->_cmixObj->setContentType($this->_moduleProperties['ContentType']);
        $this->_cmixObj->setSourceType($this->_moduleProperties['SourceType']);
        $this->_cmixObj->setActivityId($this->_moduleProperties['ActivityId']);
        $this->_cmixObj->setInstructions($this->_moduleProperties['Instructions']);
        // $this->_cmixObj->setOfflineStatus($this->_moduleProperties['OfflineStatus']);
        $this->_cmixObj->setLaunchUrl($this->_moduleProperties['LaunchUrl']);
        $this->_cmixObj->setAuthFetchUrlEnabled($this->_moduleProperties['AuthFetchUrl']);
        $this->_cmixObj->setLaunchMethod($this->_moduleProperties['LaunchMethod']);
        $this->_cmixObj->setLaunchMode($this->_moduleProperties['LaunchMode']);
        $this->_cmixObj->setMasteryScore($this->_moduleProperties['MasteryScore']);
        $this->_cmixObj->setKeepLpStatusEnabled($this->_moduleProperties['KeepLp']);
        $this->_cmixObj->setPrivacyIdent($this->_moduleProperties['PrivacyIdent']);
        $this->_cmixObj->setPrivacyName($this->_moduleProperties['PrivacyName']);
        $this->_cmixObj->setUserPrivacyComment($this->_moduleProperties['UsrPrivacyComment']);
        $this->_cmixObj->setStatementsReportEnabled($this->_moduleProperties['ShowStatements']);
        $this->_cmixObj->setXmlManifest($this->_moduleProperties['XmlManifest']);
        $this->_cmixObj->setVersion($this->_moduleProperties['Version']);
        $this->_cmixObj->setHighscoreEnabled($this->_moduleProperties['HighscoreEnabled']);
        $this->_cmixObj->setHighscoreAchievedTS($this->_moduleProperties['HighscoreAchievedTs']);
        $this->_cmixObj->setHighscorePercentage($this->_moduleProperties['HighscorePercentage']);
        $this->_cmixObj->setHighscoreWtime($this->_moduleProperties['HighscoreWtime']);
        $this->_cmixObj->setHighscoreOwnTable($this->_moduleProperties['HighscoreOwnTable']);
        $this->_cmixObj->setHighscoreTopTable($this->_moduleProperties['HighscoreTopTable']);
        $this->_cmixObj->setHighscoreTopNum($this->_moduleProperties['HighscoreTopNum']);
        $this->_cmixObj->setBypassProxyEnabled($this->_moduleProperties['BypassProxy']);
        $this->_cmixObj->setOnlyMoveon($this->_moduleProperties['OnlyMoveon']);
        $this->_cmixObj->setAchieved($this->_moduleProperties['Achieved']);
        $this->_cmixObj->setAnswered($this->_moduleProperties['Answered']);
        $this->_cmixObj->setCompleted($this->_moduleProperties['Completed']);
        $this->_cmixObj->setFailed($this->_moduleProperties['Failed']);
        $this->_cmixObj->setInitialized($this->_moduleProperties['Initialized']);
        $this->_cmixObj->setPassed($this->_moduleProperties['Passed']);
        $this->_cmixObj->setProgressed($this->_moduleProperties['Progressed']);
        $this->_cmixObj->setSatisfied($this->_moduleProperties['Satisfied']);
        $this->_cmixObj->setTerminated($this->_moduleProperties['Terminated']);
        $this->_cmixObj->setHideData($this->_moduleProperties['HideData']);
        $this->_cmixObj->setTimestamp($this->_moduleProperties['Timestamp']);
        $this->_cmixObj->setDuration($this->_moduleProperties['Duration']);
        $this->_cmixObj->setNoSubstatements($this->_moduleProperties['NoSubstatements']);
        $this->_cmixObj->setPublisherId((string) $this->_moduleProperties['PublisherId']);
//        $this->_cmixObj->setAnonymousHomepage($this->_moduleProperties['AnonymousHomepage']);
        $this->_cmixObj->setMoveOn((string) $this->_moduleProperties['MoveOn']);
        $this->_cmixObj->setLaunchParameters((string) $this->_moduleProperties['LaunchParameters']);
        $this->_cmixObj->setEntitlementKey((string) $this->_moduleProperties['EntitlementKey']);
        $this->_cmixObj->setSwitchToReviewEnabled($this->_moduleProperties['SwitchToReview']);
        $this->_cmixObj->save();
        $this->_cmixObj->updateMetaData();

        return $this;
    }

    private function deleteImportDirectiry()
    {
        global $DIC; 
        $DIC->filesystem()->temp()->delete($this->_relImportDir);
        return $this;
    }

    private function getImportDirectorySingle()
    {
        $importTempDir = $this->getImportDirectory();
        $dirArr = array_reverse(explode('/', $importTempDir));
        $this->_relImportDir = $dirArr[1] . '/' . $dirArr[0];
        return $this;
    }

    private function getImportDirectoryContainer()
    {
        $importTempDir = $this->getImportDirectory();
        $dirArr = array_reverse(explode('/', $importTempDir));
        $this->_relImportDir = $dirArr[3] . '/' . $dirArr[2] . '/' . $dirArr[1] . '/' . $dirArr[0];
        return $this;
        /*
        $dir = $this->getImportDirectory();
        $dir = dirname($dir);
        return $dir;
        */
    }

    public function init() : void
    {
    }

    public function __destruct()
    {
        if (true === $this->_isSingleImport) {
            $this->deleteImportDirectiry();
        }
    }
}  // EOF class