ilCmiXapiContentUploadImporter Class Reference

Collaboration diagram for ilCmiXapiContentUploadImporter:

Public Member Functions
	__construct (ilObjCmiXapi $object)
	ilCmiXapiContentUploadImporter constructor. More...
	ensureCreatedObjectDirectory ()
	importServerFile (string $serverFile)
	importFormUpload (array $fileData)
	getWebDataDirRelativeObjectDirectory ()

Data Fields
const	RELATIVE_CONTENT_DIRECTORY_NAMEBASE = 'lm_data/lm_'
const	RELATIVE_XSD_DIRECTORY = 'Modules/CmiXapi/xml/contentschema'
const	IMP_FILE_EXTENSION_XML = 'xml'
const	IMP_FILE_EXTENSION_ZIP = 'zip'
const	CMI5_XML = 'cmi5.xml'
const	CMI5_XSD = 'cmi5_v1_CourseStructure.xsd'
const	TINCAN_XML = 'tincan.xml'
const	TINCAN_XSD = 'tincan.xsd'

Protected Member Functions
	sanitizeObjectDirectory ()
	handleFile (string $serverFile)
	getUpload (?string $uploadFilePath)
	handleUpload (FileUploadResult $uploadResult)
	handleXmlFile (string $xmlFilePath)
	handleXmlFileFromUpload (string $xmlFileName, string $xmlFilePath)
	validateXmlFile (DOMDocument $dom, $xsdFilePath)
	handleZipContentUpload (string $uploadFilePath)
	getAbsoluteObjectDirectory ()
	fetchFileExtension (FileUploadResult $uploadResult)
	hasStoredContentXml ()
	getStoredContentXml ()
	getXsdFilePath (string $xsdFileName)
	initObjectFromCmi5Xml (DOMDocument $dom)
	initObjectFromTincanXml (DOMDocument $dom)

Protected Attributes
ilObjCmiXapi	$object

Static Protected Attributes
static array	$CONTENT_XML_FILENAMES
static array	$CONTENT_XSD_FILENAMES

Private Member Functions
	generateActivityId (string $publisherId)

Private Attributes
ILIAS DI Container	$dic

Detailed Description

Definition at line 35 of file class.ilCmiXapiContentUploadImporter.php.

Constructor & Destructor Documentation

__construct()

ilCmiXapiContentUploadImporter::__construct

(

ilObjCmiXapi

$object

)

ilCmiXapiContentUploadImporter constructor.

Definition at line 72 of file class.ilCmiXapiContentUploadImporter.php.

References $DIC, and $object.

    {
        global $DIC;
        $this->dic = $DIC;
        $this->object = $object;
    }

Member Function Documentation

ensureCreatedObjectDirectory()

ilCmiXapiContentUploadImporter::ensureCreatedObjectDirectory

(

)

Exceptions

Definition at line 82 of file class.ilCmiXapiContentUploadImporter.php.

References $DIC, and getWebDataDirRelativeObjectDirectory().

Referenced by importFormUpload(), and importServerFile().

                                                  : void
    {
        global $DIC; /* @var \ILIAS\DI\Container $DIC */

        if (!$DIC->filesystem()->web()->has($this->getWebDataDirRelativeObjectDirectory())) {
            $DIC->filesystem()->web()->createDir($this->getWebDataDirRelativeObjectDirectory());
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

fetchFileExtension()

ilCmiXapiContentUploadImporter::fetchFileExtension ( FileUploadResult  $uploadResult )

protected

Definition at line 309 of file class.ilCmiXapiContentUploadImporter.php.

Referenced by handleUpload().

                                                                         : string
    {
        return pathinfo($uploadResult->getName(), PATHINFO_EXTENSION);
    }

Here is the caller graph for this function:

generateActivityId()

ilCmiXapiContentUploadImporter::generateActivityId ( string  $publisherId )

private

Definition at line 453 of file class.ilCmiXapiContentUploadImporter.php.

References $DIC, $objId, and ilCmiXapiUser\getIliasUuid().

Referenced by initObjectFromCmi5Xml().

                                                            : string
    {
        global $DIC;
        $objId = $this->object->getId();
        return "https://ilias.de/cmi5/activityid/" . (new \Ramsey\Uuid\UuidFactory())->uuid3(ilCmiXapiUser::getIliasUuid(), $objId . '-' . $publisherId);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getAbsoluteObjectDirectory()

ilCmiXapiContentUploadImporter::getAbsoluteObjectDirectory ( )

protected

Definition at line 293 of file class.ilCmiXapiContentUploadImporter.php.

References getWebDataDirRelativeObjectDirectory(), and ilFileUtils\getWebspaceDir().

Referenced by getStoredContentXml(), and handleZipContentUpload().

                                                   : string
    {
        $dirs = [
            ILIAS_ABSOLUTE_PATH,
            ilFileUtils::getWebspaceDir(),
            $this->getWebDataDirRelativeObjectDirectory()
        ];

        return implode(DIRECTORY_SEPARATOR, $dirs);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getStoredContentXml()

ilCmiXapiContentUploadImporter::getStoredContentXml ( )

protected

Definition at line 319 of file class.ilCmiXapiContentUploadImporter.php.

References getAbsoluteObjectDirectory(), and getWebDataDirRelativeObjectDirectory().

Referenced by handleFile(), handleUpload(), and hasStoredContentXml().

                                            : string
    {
        foreach (self::$CONTENT_XML_FILENAMES as $xmlFileName) {
            $xmlFilePath = $this->getWebDataDirRelativeObjectDirectory() . DIRECTORY_SEPARATOR . $xmlFileName;

            if ($this->dic->filesystem()->web()->has($xmlFilePath)) {
                return $this->getAbsoluteObjectDirectory() . DIRECTORY_SEPARATOR . $xmlFileName;
            }
        }

        return '';
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getUpload()

ilCmiXapiContentUploadImporter::getUpload ( ?string  $uploadFilePath )

protected

Exceptions

Definition at line 162 of file class.ilCmiXapiContentUploadImporter.php.

References $DIC, and $results.

Referenced by importFormUpload().

                                                         : FileUploadResult
    {
        global $DIC; /* @var \ILIAS\DI\Container $DIC */

        if ($DIC->upload()->hasUploads()) {
            if (!$DIC->upload()->hasBeenProcessed()) {
                $DIC->upload()->process();
            }

            /* @var FileUploadResult $result */

            $results = $DIC->upload()->getResults();

            if (isset($results[$uploadFilePath])) {
                $result = $results[$uploadFilePath];

                if ($result->isOK()) {
                    return $result;
                }

                throw new ilCmiXapiInvalidUploadContentException(
                    'upload processing failed with message ' .
                    '"' . $result->getStatus()->getMessage() . '"'
                );
            }

            throw new ilCmiXapiInvalidUploadContentException('upload lost during processing!');
        }

        throw new ilCmiXapiInvalidUploadContentException('no upload provided!');
    }

Here is the caller graph for this function:

getWebDataDirRelativeObjectDirectory()

ilCmiXapiContentUploadImporter::getWebDataDirRelativeObjectDirectory

(

)

Definition at line 304 of file class.ilCmiXapiContentUploadImporter.php.

Referenced by ensureCreatedObjectDirectory(), getAbsoluteObjectDirectory(), getStoredContentXml(), and sanitizeObjectDirectory().

                                                          : string
    {
        return self::RELATIVE_CONTENT_DIRECTORY_NAMEBASE . $this->object->getId();
    }

Here is the caller graph for this function:

getXsdFilePath()

ilCmiXapiContentUploadImporter::getXsdFilePath ( string  $xsdFileName )

protected

Definition at line 332 of file class.ilCmiXapiContentUploadImporter.php.

Referenced by handleXmlFile(), and handleXmlFileFromUpload().

                                                          : string
    {
        return ILIAS_ABSOLUTE_PATH . DIRECTORY_SEPARATOR . self::RELATIVE_XSD_DIRECTORY . DIRECTORY_SEPARATOR . $xsdFileName;
    }

Here is the caller graph for this function:

handleFile()

ilCmiXapiContentUploadImporter::handleFile ( string  $serverFile )

protected

Exceptions

ilCmiXapiInvalidUploadContentException

Definition at line 117 of file class.ilCmiXapiContentUploadImporter.php.

References getStoredContentXml(), handleXmlFile(), handleZipContentUpload(), and hasStoredContentXml().

Referenced by importServerFile().

                                                     : void
    {
        $fileInfo = pathinfo($serverFile);

        switch ($fileInfo['extension']) {
            case self::IMP_FILE_EXTENSION_XML:

                $this->handleXmlFile($serverFile);
                break;

            case self::IMP_FILE_EXTENSION_ZIP:

                $this->handleZipContentUpload($serverFile);

                if ($this->hasStoredContentXml()) {
                    $this->handleXmlFile($this->getStoredContentXml());
                }

                break;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

handleUpload()

ilCmiXapiContentUploadImporter::handleUpload ( FileUploadResult  $uploadResult )

protected

Exceptions

ilCmiXapiInvalidUploadContentException

Definition at line 197 of file class.ilCmiXapiContentUploadImporter.php.

References fetchFileExtension(), getStoredContentXml(), handleXmlFile(), handleXmlFileFromUpload(), handleZipContentUpload(), and hasStoredContentXml().

Referenced by importFormUpload().

                                                                   : void
    {
        switch ($this->fetchFileExtension($uploadResult)) {
            case self::IMP_FILE_EXTENSION_XML:

                $this->handleXmlFileFromUpload($uploadResult->getName(), $uploadResult->getPath());
                break;

            case self::IMP_FILE_EXTENSION_ZIP:

                $this->handleZipContentUpload($uploadResult->getPath());

                if ($this->hasStoredContentXml()) {
                    $this->handleXmlFile($this->getStoredContentXml());
                }

                break;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

handleXmlFile()

ilCmiXapiContentUploadImporter::handleXmlFile ( string  $xmlFilePath )

protected

Exceptions

ilCmiXapiInvalidUploadContentException

Definition at line 220 of file class.ilCmiXapiContentUploadImporter.php.

References getXsdFilePath(), initObjectFromCmi5Xml(), initObjectFromTincanXml(), and validateXmlFile().

Referenced by handleFile(), and handleUpload().

                                                         : void
    {
        $dom = new DOMDocument();
        $dom->load($xmlFilePath);

        switch (basename($xmlFilePath)) {
            case self::CMI5_XML:

                $xsdFilePath = $this->getXsdFilePath(self::CMI5_XSD);
                $this->validateXmlFile($dom, $xsdFilePath);

                $this->initObjectFromCmi5Xml($dom);

                break;

            case self::TINCAN_XML:

                $xsdFilePath = $this->getXsdFilePath(self::TINCAN_XSD);
                $this->validateXmlFile($dom, $xsdFilePath);

                $this->initObjectFromTincanXml($dom);

                break;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

handleXmlFileFromUpload()

ilCmiXapiContentUploadImporter::handleXmlFileFromUpload ( string  $xmlFileName, string  $xmlFilePath  )

protected

Exceptions

ilCmiXapiInvalidUploadContentException

Definition at line 249 of file class.ilCmiXapiContentUploadImporter.php.

References getXsdFilePath(), initObjectFromCmi5Xml(), initObjectFromTincanXml(), and validateXmlFile().

Referenced by handleUpload().

                                                                                        : void
    {
        $dom = new DOMDocument();
        $dom->load($xmlFilePath);
        switch (basename($xmlFileName)) {
            case self::CMI5_XML:

                $xsdFilePath = $this->getXsdFilePath(self::CMI5_XSD);
                $this->validateXmlFile($dom, $xsdFilePath);

                $this->initObjectFromCmi5Xml($dom);

                break;

            case self::TINCAN_XML:

                $xsdFilePath = $this->getXsdFilePath(self::TINCAN_XSD);
                $this->validateXmlFile($dom, $xsdFilePath);

                $this->initObjectFromTincanXml($dom);

                break;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

handleZipContentUpload()

ilCmiXapiContentUploadImporter::handleZipContentUpload ( string  $uploadFilePath )

protected

Definition at line 284 of file class.ilCmiXapiContentUploadImporter.php.

References getAbsoluteObjectDirectory().

Referenced by handleFile(), and handleUpload().

                                                                     : void
    {
        $targetPath = $this->getAbsoluteObjectDirectory();
        $zar = new \ZipArchive();
        $zar->open($uploadFilePath);
        $zar->extractTo($targetPath);
        $zar->close();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

hasStoredContentXml()

ilCmiXapiContentUploadImporter::hasStoredContentXml ( )

protected

Definition at line 314 of file class.ilCmiXapiContentUploadImporter.php.

References getStoredContentXml().

Referenced by handleFile(), and handleUpload().

                                            : bool
    {
        return $this->getStoredContentXml() !== '';
    }

Here is the call graph for this function:

Here is the caller graph for this function:

importFormUpload()

ilCmiXapiContentUploadImporter::importFormUpload

(

array

$fileData

)

Exceptions

Definition at line 144 of file class.ilCmiXapiContentUploadImporter.php.

References $DIC, ensureCreatedObjectDirectory(), getUpload(), handleUpload(), and sanitizeObjectDirectory().

                                                     : void
    {
        global $DIC;
        $this->ensureCreatedObjectDirectory();

        $uploadResult = $this->getUpload(
            $fileData['tmp_name']
        );

        $this->handleUpload($uploadResult);

        $this->sanitizeObjectDirectory();
    }

Here is the call graph for this function:

importServerFile()

ilCmiXapiContentUploadImporter::importServerFile

(

string

$serverFile

)

Exceptions

Definition at line 105 of file class.ilCmiXapiContentUploadImporter.php.

References ensureCreatedObjectDirectory(), handleFile(), and sanitizeObjectDirectory().

                                                        : void
    {
        $this->ensureCreatedObjectDirectory();

        $this->handleFile($serverFile);

        $this->sanitizeObjectDirectory();
    }

Here is the call graph for this function:

initObjectFromCmi5Xml()

ilCmiXapiContentUploadImporter::initObjectFromCmi5Xml ( DOMDocument  $dom )

protected

Definition at line 337 of file class.ilCmiXapiContentUploadImporter.php.

References generateActivityId(), ilObjCmiXapi\LMS_MASTERY_SCORE, ilLPObjSettings\LP_MODE_CMIX_COMPLETED, ilLPObjSettings\LP_MODE_CMIX_COMPLETED_OR_PASSED, ilLPObjSettings\LP_MODE_CMIX_PASSED, ilLPObjSettings\LP_MODE_DEACTIVATED, ilCmiXapiLP\MOVEON_COMPLETED, ilCmiXapiLP\MOVEON_COMPLETED_AND_PASSED, ilCmiXapiLP\MOVEON_COMPLETED_OR_PASSED, ilCmiXapiLP\MOVEON_PASSED, and ILIAS\Repository\object().

Referenced by handleXmlFile(), and handleXmlFileFromUpload().

                                                              : void
    {
        $xPath = new DOMXPath($dom);

        $courseNode = $xPath->query("//*[local-name()='course']")->item(0);
        // TODO: multilanguage support
        $title = $xPath->query("//*[local-name()='title']/*[local-name()='langstring']", $courseNode)->item(0)->nodeValue;
        $this->object->setTitle(trim($title));

        $description = $xPath->query("//*[local-name()='description']/*[local-name()='langstring']", $courseNode)->item(0)->nodeValue;
        $this->object->setDescription(trim($description));

        $publisherId = trim($courseNode->getAttribute('id'));
        $this->object->setPublisherId($publisherId);

        $activityId = $this->generateActivityId($publisherId);
        $this->object->setActivityId($activityId);

        $moveOn = '';

        foreach ($xPath->query("//*[local-name()='au']") as $assignedUnitNode) {
            $relativeLaunchUrl = $xPath->query("//*[local-name()='url']", $assignedUnitNode)->item(0)->nodeValue;
            if (!empty($xPath->query("//*[local-name()='launchParameters']", $assignedUnitNode)->item(0)->nodeValue)) {
                $launchParameters = $xPath->query(
                    "//*[local-name()='launchParameters']",
                    $assignedUnitNode
                )->item(0)->nodeValue;
            }
            if (!empty($assignedUnitNode->getAttribute('moveOn'))) {
                $moveOn = trim($assignedUnitNode->getAttribute('moveOn'));
            }
            if (!empty($xPath->query("//*[local-name()='entitlementKey']", $assignedUnitNode)->item(0)->nodeValue)) {
                $entitlementKey = $xPath->query(
                    "//*[local-name()='entitlementKey']",
                    $assignedUnitNode
                )->item(0)->nodeValue;
            }
            if (!empty($assignedUnitNode->getAttribute('masteryScore'))) {
                $masteryScore = trim($assignedUnitNode->getAttribute('masteryScore'));
            }

            if (!empty($relativeLaunchUrl)) {
                $this->object->setLaunchUrl(trim($relativeLaunchUrl));
            }
            if (!empty($launchParameters)) {
                $this->object->setLaunchParameters(trim($launchParameters));
            }
            if (!empty($moveOn)) {
                if ($moveOn == ilCmiXapiLP::MOVEON_COMPLETED_AND_PASSED) {
                    $moveOn = ilCmiXapiLP::MOVEON_PASSED;
                }
                $this->object->setMoveOn($moveOn);
            }
            if (!empty($entitlementKey)) {
                $this->object->setEntitlementKey($entitlementKey);
            }
            if (!empty($masteryScore)) {
                $this->object->setMasteryScore((float) $masteryScore);
            } else {
                $this->object->setMasteryScore(ilObjCmiXapi::LMS_MASTERY_SCORE);
            }

            break; // TODO: manage multi au imports
        }
        $xml_str = $dom->saveXML();
        $this->object->setXmlManifest($xml_str);
        $this->object->update();
        $this->object->save();

        $lpSettings = new ilLPObjSettings($this->object->getId());
        $mode = ilLPObjSettings::LP_MODE_DEACTIVATED;

        switch ($moveOn) {
            case ilCmiXapiLP::MOVEON_COMPLETED:
                $mode = ilLPObjSettings::LP_MODE_CMIX_COMPLETED;
                break;
            case ilCmiXapiLP::MOVEON_PASSED:
                $mode = ilLPObjSettings::LP_MODE_CMIX_PASSED;
                break;
            case ilCmiXapiLP::MOVEON_COMPLETED_OR_PASSED:
                $mode = ilLPObjSettings::LP_MODE_CMIX_COMPLETED_OR_PASSED;
                break;
            case ilCmiXapiLP::MOVEON_COMPLETED_AND_PASSED: // ich würde es noch implementieren
                $mode = ilLPObjSettings::LP_MODE_CMIX_PASSED;
                break;
        }
        $lpSettings->setMode($mode);
        $lpSettings->update();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initObjectFromTincanXml()

ilCmiXapiContentUploadImporter::initObjectFromTincanXml ( DOMDocument  $dom )

protected

Definition at line 427 of file class.ilCmiXapiContentUploadImporter.php.

Referenced by handleXmlFile(), and handleXmlFileFromUpload().

                                                                : void
    {
        $xPath = new DOMXPath($dom);

        foreach ($xPath->query("//*[local-name()='activity']") as $activityNode) {
            $title = $xPath->query("//*[local-name()='name']", $activityNode)->item(0)->nodeValue;
            $this->object->setTitle(trim($title));

            $description = $xPath->query("//*[local-name()='description']", $activityNode)->item(0)->nodeValue;
            $this->object->setDescription(trim($description));

            $activityId = $activityNode->getAttribute('id');
            $this->object->setActivityId(trim($activityId));

            $relativeLaunchUrl = $xPath->query("//*[local-name()='launch']", $activityNode)->item(0)->nodeValue;
            $this->object->setLaunchUrl(trim($relativeLaunchUrl));

            break; // TODO: manage multi activities imports
        }

        $xml_str = $dom->saveXML();
        $this->object->setXmlManifest($xml_str);
        $this->object->update();
        $this->object->save();
    }

Here is the caller graph for this function:

sanitizeObjectDirectory()

ilCmiXapiContentUploadImporter::sanitizeObjectDirectory ( )

protected

Definition at line 91 of file class.ilCmiXapiContentUploadImporter.php.

References getWebDataDirRelativeObjectDirectory(), ilFileUtils\getWebspaceDir(), and ilFileUtils\renameExecutables().

Referenced by importFormUpload(), and importServerFile().

                                                : void
    {
        ilFileUtils::renameExecutables(
            implode(DIRECTORY_SEPARATOR, [
                ilFileUtils::getWebspaceDir(),
                $this->getWebDataDirRelativeObjectDirectory()
            ])
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

validateXmlFile()

ilCmiXapiContentUploadImporter::validateXmlFile ( DOMDocument  $dom,   $xsdFilePath  )

protected

Exceptions

ilCmiXapiInvalidUploadContentException

Definition at line 277 of file class.ilCmiXapiContentUploadImporter.php.

Referenced by handleXmlFile(), and handleXmlFileFromUpload().

                                                                      : void
    {
        if (!$dom->schemaValidate($xsdFilePath)) {
            throw new ilCmiXapiInvalidUploadContentException('invalid content xml given!');
        }
    }

Here is the caller graph for this function:

Field Documentation

$CONTENT_XML_FILENAMES

array ilCmiXapiContentUploadImporter::$CONTENT_XML_FILENAMES

staticprotected

Initial value:

= [
        self::CMI5_XML, self::TINCAN_XML
    ]

Definition at line 53 of file class.ilCmiXapiContentUploadImporter.php.

$CONTENT_XSD_FILENAMES

array ilCmiXapiContentUploadImporter::$CONTENT_XSD_FILENAMES

staticprotected

Initial value:

= [
        self::CMI5_XML => self::CMI5_XSD

Definition at line 60 of file class.ilCmiXapiContentUploadImporter.php.

$dic

ILIAS DI Container ilCmiXapiContentUploadImporter::$dic

private

Definition at line 67 of file class.ilCmiXapiContentUploadImporter.php.

$object

ilObjCmiXapi ilCmiXapiContentUploadImporter::$object

protected

Definition at line 65 of file class.ilCmiXapiContentUploadImporter.php.

Referenced by __construct().

CMI5_XML

const ilCmiXapiContentUploadImporter::CMI5_XML = 'cmi5.xml'

Definition at line 44 of file class.ilCmiXapiContentUploadImporter.php.

CMI5_XSD

const ilCmiXapiContentUploadImporter::CMI5_XSD = 'cmi5_v1_CourseStructure.xsd'

Definition at line 45 of file class.ilCmiXapiContentUploadImporter.php.

IMP_FILE_EXTENSION_XML

const ilCmiXapiContentUploadImporter::IMP_FILE_EXTENSION_XML = 'xml'

Definition at line 41 of file class.ilCmiXapiContentUploadImporter.php.

IMP_FILE_EXTENSION_ZIP

const ilCmiXapiContentUploadImporter::IMP_FILE_EXTENSION_ZIP = 'zip'

Definition at line 42 of file class.ilCmiXapiContentUploadImporter.php.

RELATIVE_CONTENT_DIRECTORY_NAMEBASE

const ilCmiXapiContentUploadImporter::RELATIVE_CONTENT_DIRECTORY_NAMEBASE = 'lm_data/lm_'

Definition at line 37 of file class.ilCmiXapiContentUploadImporter.php.

Referenced by ilCmiXapiLaunchGUI\buildLaunchLink().

RELATIVE_XSD_DIRECTORY

const ilCmiXapiContentUploadImporter::RELATIVE_XSD_DIRECTORY = 'Modules/CmiXapi/xml/contentschema'

Definition at line 39 of file class.ilCmiXapiContentUploadImporter.php.

TINCAN_XML

const ilCmiXapiContentUploadImporter::TINCAN_XML = 'tincan.xml'

Definition at line 47 of file class.ilCmiXapiContentUploadImporter.php.

TINCAN_XSD

const ilCmiXapiContentUploadImporter::TINCAN_XSD = 'tincan.xsd'

Definition at line 48 of file class.ilCmiXapiContentUploadImporter.php.

---

The documentation for this class was generated from the following file:

• Modules/CmiXapi/classes/class.ilCmiXapiContentUploadImporter.php