class.ilScormAiccDataSet.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2016 ILIAS open source, Extended GPL, see docs/LICENSE */
include_once("./Services/DataSet/classes/class.ilDataSet.php");

class ilScormAiccDataSet extends ilDataSet
{
        function __construct()
        {
                $this->db_table = "sahs_lm";
                $this->properties = [
                        //"OfflineZipCreated" => "datetime",
                        "Id" => ["db_col" => "id", "db_type" => "integer"],
                        //"EntryPage" => "integer",
                        "APIAdapterName" => ["db_col" => "api_adapter", "db_type" => "text"],
                        "APIFunctionsPrefix" => ["db_col" => "api_func_prefix", "db_type" => "text"],
                        "AssignedGlossary" => ["db_col" => "glossary", "db_type" => "integer"],
                        "AutoContinue" => ["db_col" => "auto_continue", "db_type" => "text"],
                        "AutoReviewChar" => ["db_col" => "auto_review", "db_type" => "text"],
                        "AutoSuspend" => ["db_col" => "auto_suspend", "db_type" => "text"],
                        "Auto_last_visited" => ["db_col" => "auto_last_visited", "db_type" => "text"],
                        "Check_values" => ["db_col" => "check_values", "db_type" => "text"],
                        "Comments" => ["db_col" => "comments", "db_type" => "text"],
                        "CreditMode" => ["db_col" => "credit", "db_type" => "text"],
                        "Debug" => ["db_col" => "debug", "db_type" => "text"],
                        "DebugPw" => ["db_col" => "debugpw", "db_type" => "text"],
                        "DefaultLessonMode" => ["db_col" => "default_lesson_mode", "db_type" => "text"],
                        "Editable" => ["db_col" => "editable", "db_type" => "integer"],
                        "Fourth_edition" => ["db_col" => "fourth_edition", "db_type" => "text"],
                        "Height" => ["db_col" => "height", "db_type" => "integer"],
                        "HideNavig" => ["db_col" => "hide_navig", "db_type" => "text"],
                        "Ie_compatibility" => ["db_col" => "ie_compatibility", "db_type" => "text"],
                        "Ie_force_render" => ["db_col" => "ie_force_render", "db_type" => "text"],
                        "Interactions" => ["db_col" => "interactions", "db_type" => "text"],
                        "Localization" => ["db_col" => "localization", "db_type" => "text"],
                        "MasteryScore" => ["db_col" => "mastery_score", "db_type" => "integer"],
                        "MaxAttempt" => ["db_col" => "max_attempt", "db_type" => "integer"],
                        "ModuleVersion" => ["db_col" => "module_version", "db_type" => "integer"],
                        "NoMenu" => ["db_col" => "no_menu", "db_type" => "text"],
                        "Objectives" => ["db_col" => "objectives", "db_type" => "text"],
                        "OfflineMode" => ["db_col" => "offline_mode", "db_type" => "text"],
                        "Online" => ["db_col" => "c_online", "db_type" => "text"],
                        "OpenMode" => ["db_col" => "open_mode", "db_type" => "integer"],
                        "Sequencing" => ["db_col" => "sequencing", "db_type" => "text"],
                        "SequencingExpertMode" => ["db_col" => "seq_exp_mode", "db_type" => "integer"],
                        "Session" => ["db_col" => "unlimited_session", "db_type" => "text"],
                        "StyleSheetId" => ["db_col" => "stylesheet", "db_type" => "integer"],
                        "SubType" => ["db_col" => "c_type", "db_type" => "text"],
                        "Time_from_lms" => ["db_col" => "time_from_lms", "db_type" => "text"],
                        "Tries" => ["db_col" => "question_tries", "db_type" => "integer"],
                        "Width" => ["db_col" => "width", "db_type" => "integer"]
                ];

                $this->element_db_mapping = [];
                foreach ($this->properties as $key => $value)
                {
                        $this->element_db_mapping [$value["db_col"]] = $key;
                }
        }

        public function readData($a_entity, $a_version, $a_id, $a_field = "")
        {
                global $ilDB;

                $obj_id = ilObject::_lookupObjectId ($a_id);
                $columns = [];
                foreach ($this->properties as $property)
                        array_push ($columns, $property["db_col"]);

                $query = "SELECT " . implode (",", $columns) . " FROM " . $this->db_table;
                $query .= " WHERE id=" . $ilDB->quote($obj_id, "integer");
                $result = $ilDB->query($query);
                $this->data = [];
                if ($dataset = $ilDB->fetchAssoc($result))
                {
                        $this->data = $dataset;
                }

                $query = "SELECT title,description FROM object_data";
                $query .= " WHERE obj_id=" . $ilDB->quote($obj_id, "integer");
                $result = $ilDB->query($query);
                while ($dataset = $ilDB->fetchAssoc($result))
                {
                        $this->data ["title"] = $dataset["title"];
                        $this->data ["description"] = $dataset["description"];
                }
        }
        
        public function writeData ($a_entity, $a_version, $a_id, $data)
        {
                global $ilDB, $ilLog;
                if (count ($data) > 0)
                {
                        $columns = [];
                        foreach ($this->properties as $key => $value)
                        {
                                if ($key == "Id" || $key == "title"|| $key == "description") continue;
                                if (isset ($data[$key]))
                                        if (count ($data[$key]) > 0)
                                                $columns [$value["db_col"]] = [$value["db_type"], $data[$key][0]];
                        }
                        if (count ($columns) > 0)
                        {
                                $conditions ["id"] = ["integer", $a_id];
                                $ilDB->update ($this->db_table, $columns, $conditions);
                        }

                        //setting title and description in table object_data
                        $od_table = "object_data";
                        $od_properties = [
                                "Title" => ["db_col" => "title", "db_type" => "text"],
                                "Description" => ["db_col" => "description", "db_type" => "text"]
                        ];
                        foreach ($od_properties as $key => $value)
                        {
                                if (isset ($data[$key]))
                                        if (count ($data[$key]) > 0)
                                                $od_columns [$value["db_col"]] = [$value["db_type"], $data[$key][0]];

                                if (count ($od_columns) > 0)
                                {
                                        $od_conditions ["obj_id"] = ["integer", $a_id];
                                        $ilDB->update ("object_data", $od_columns, $od_conditions);
                                }
                        }
                }
                else
                {
                        $ilLog->write ("no module properties for imported object");
                }
        }

        /* retrieve element name by database column name
         */
        public function getElementNameByDbColumn ($db_col_name)
        {
                if ($db_col_name == "title") return "Title";
                if ($db_col_name == "description") return "Description";
                return $this->element_db_mapping[$db_col_name];
        }

        /* own getXmlRepresentation function to embed zipfile in xml
         *
         */
        public function getExtendedXmlRepresentation($a_entity, $a_schema_version, $a_ids, $a_field = "", $a_omit_header = false, $a_omit_types = false)
        {
                $GLOBALS["ilLog"]->write(json_encode($this->getTypes("sahs", "5.1.0"), JSON_PRETTY_PRINT));

                global $ilCtrl, $ilDB;
                $this->dircnt = 1;

                $this->readData($a_entity, $a_schema_version, $a_ids, $a_field = "");
                $id = $this->data["id"];

                require_once ("./Services/Export/classes/class.ilExport.php");
                $exportDir = ilExport::_getExportDirectory($id);

                // step 1: check target release and supported versions
                // step 2: init writer
                require_once ("./Services/Xml/classes/class.ilXmlWriter.php");
                $writer = new ilXmlWriter();
                if (!$a_omit_header) { $writer->xmlHeader(); }

                $atts = array("InstallationId" => IL_INST_ID,
                        "InstallationUrl" => ILIAS_HTTP_PATH, "TopEntity" => $a_entity);

                $writer->appendXML ("\n");
                $writer->xmlStartTag($this->getDSPrefixString().'DataSet', $atts);
                $writer->appendXML ("\n");

                foreach ($this->data as $key => $value)
                {
                        $writer->xmlElement($this->getElementNameByDbColumn ($key), Null, $value, TRUE, TRUE);
                        $writer->appendXML ("\n");
                }

                $lmDir = ilUtil::getWebspaceDir ("filesystem")."/lm_data/lm_".$id;
                $baseFileName = "sahs_" . $id;
                $scormBasePath=$exportDir . "/" . $baseFileName;
                if (!file_exists ($exportDir)) mkdir ($exportDir, 0755, true);

                ilUtil::zip($lmDir, $scormBasePath, true);
                $scormFilePath = $scormBasePath . ".zip";

                $writer->xmlEndTag($this->getDSPrefixString()."DataSet");
                $writer->appendXML ("\n");

                $xml = $writer->xmlDumpMem(false);
                $baseExportName = time() . "__" . IL_INST_ID . "__". $baseFileName;
                $xmlFilePath = $exportDir . "/" . $baseExportName . ".xml";

                if (!file_exists ($xmlFilePath))
                {
                        $xmlFile = fopen ($xmlFilePath, "w");
                        fwrite ($xmlFile, $xml);
                        fclose($xmlFile);
                }

                //create metadata
                $metaData = $this->buildMetaData ($id);

                $metaDataFilePath = $exportDir . "/" . $baseExportName . "_metadata.xml";
                if (!file_exists ($metaDataFilePath))
                {
                        $metaDataFile = fopen ($metaDataFilePath, "w");
                        fwrite ($metaDataFile, $metaData);
                        fclose($metaDataFile);
                }

                //create manifest file
                $manWriter = new ilXmlWriter();
                $manWriter->xmlHeader(); 
                $manWriter->appendXML ("\n<content>\n");

                $files = [
                        "scormFile" => $baseFileName . ".zip",
                        "properties" => $baseFileName . ".xml",
                        "metadata" => "metadata.xml"
                ];
                foreach ($files as $key => $value)
                {
                        $manWriter->xmlElement($key, Null, $value, TRUE, TRUE);
                        $manWriter->appendXML ("\n");
                }

                $manWriter->appendXML ("</content>\n");
                $manifest = $manWriter->xmlDumpMem(false);

                $manifestFilePath = $exportDir . "/" . $baseExportName . "_manifest.xml";
                if (!file_exists ($manifestFilePath))
                {
                        $manifestFile = fopen ($manifestFilePath, "w");
                        fwrite ($manifestFile, $manifest);
                        fclose($manifestFile);
                }

                $zArchive = new zipArchive();
                $fileName = $exportDir . "/" . $baseExportName . ".zip";

                if ($zArchive->open($fileName, ZipArchive::CREATE)!==TRUE) {
                        exit("cannot open <$fileName>\n");
                }

                //creating final zip file
                $zArchive->addFile($xmlFilePath, $baseFileName . ".xml");
                $zArchive->addFile($scormFilePath, $baseFileName . ".zip");
                $zArchive->addFile($manifestFilePath, "manifest.xml");
                $zArchive->addFile($metaDataFilePath, "metadata.xml");
                $zArchive->close();
                //delete temporary files
                unlink ($xmlFilePath);
                unlink ($scormFilePath);
                unlink ($manifestFilePath);
                unlink ($metaDataFilePath);

                return $fileName;
        }

        public function buildMetaData($id)
        {
                require_once ("Services/MetaData/classes/class.ilMD2XML.php");
                $md2xml = new ilMD2XML ($id, $id, "sahs");
                $md2xml->startExport();
                $xml = $md2xml->getXML();
                return $xml;
        }

        protected function getTypes($a_entity, $a_version)
        {
                if ($a_entity == "sahs")
                {
                        switch ($a_version)
                        {
                        case "5.1.0":
                                $types = [];
                                foreach ($this->properties as $key => $value)
                                        $types[$key] = $value["db_type"];
                                return $types;
                                break;
                        }
                }
        }

        function getXmlNamespace($a_entity, $a_schema_version)
        {
                return "http://www.ilias.de/xml/Modules/ScormAicc/".$a_entity;
        }
        
        public function getDependencies()
        {
                return null;
        }

        public function getSupportedVersions()
        {
                return ["5.1.0"];
        }
}