ILIAS  release_5-3 Revision v5.3.23-19-g915713cf615
class.ilScormAiccDataSet.php
Go to the documentation of this file.
1<?php
2/* Copyright (c) 1998-2016 ILIAS open source, Extended GPL, see docs/LICENSE */
3include_once("./Services/DataSet/classes/class.ilDataSet.php");
4
6{
7 public function __construct()
8 {
9 $this->db_table = "sahs_lm";
10 $this->properties = [
11 //"OfflineZipCreated" => "datetime",
12 "Id" => ["db_col" => "id", "db_type" => "integer"],
13 //"EntryPage" => "integer",
14 "APIAdapterName" => ["db_col" => "api_adapter", "db_type" => "text"],
15 "APIFunctionsPrefix" => ["db_col" => "api_func_prefix", "db_type" => "text"],
16 "AssignedGlossary" => ["db_col" => "glossary", "db_type" => "integer"],
17 "AutoContinue" => ["db_col" => "auto_continue", "db_type" => "text"],
18 "AutoReviewChar" => ["db_col" => "auto_review", "db_type" => "text"],
19 "AutoSuspend" => ["db_col" => "auto_suspend", "db_type" => "text"],
20 "Auto_last_visited" => ["db_col" => "auto_last_visited", "db_type" => "text"],
21 "Check_values" => ["db_col" => "check_values", "db_type" => "text"],
22 "Comments" => ["db_col" => "comments", "db_type" => "text"],
23 "CreditMode" => ["db_col" => "credit", "db_type" => "text"],
24 "Debug" => ["db_col" => "debug", "db_type" => "text"],
25 "DebugPw" => ["db_col" => "debugpw", "db_type" => "text"],
26 "DefaultLessonMode" => ["db_col" => "default_lesson_mode", "db_type" => "text"],
27 "Editable" => ["db_col" => "editable", "db_type" => "integer"],
28 "Fourth_edition" => ["db_col" => "fourth_edition", "db_type" => "text"],
29 "Height" => ["db_col" => "height", "db_type" => "integer"],
30 "HideNavig" => ["db_col" => "hide_navig", "db_type" => "text"],
31 "Ie_force_render" => ["db_col" => "ie_force_render", "db_type" => "text"],
32 "Interactions" => ["db_col" => "interactions", "db_type" => "text"],
33 "Localization" => ["db_col" => "localization", "db_type" => "text"],
34 "MasteryScore" => ["db_col" => "mastery_score", "db_type" => "integer"],
35 "MaxAttempt" => ["db_col" => "max_attempt", "db_type" => "integer"],
36 "ModuleVersion" => ["db_col" => "module_version", "db_type" => "integer"],
37 "NoMenu" => ["db_col" => "no_menu", "db_type" => "text"],
38 "Objectives" => ["db_col" => "objectives", "db_type" => "text"],
39 "OfflineMode" => ["db_col" => "offline_mode", "db_type" => "text"],
40 "Online" => ["db_col" => "c_online", "db_type" => "text"],
41 "OpenMode" => ["db_col" => "open_mode", "db_type" => "integer"],
42 "Sequencing" => ["db_col" => "sequencing", "db_type" => "text"],
43 "SequencingExpertMode" => ["db_col" => "seq_exp_mode", "db_type" => "integer"],
44 "Session" => ["db_col" => "unlimited_session", "db_type" => "text"],
45 "StyleSheetId" => ["db_col" => "stylesheet", "db_type" => "integer"],
46 "SubType" => ["db_col" => "c_type", "db_type" => "text"],
47 "Time_from_lms" => ["db_col" => "time_from_lms", "db_type" => "text"],
48 "Tries" => ["db_col" => "question_tries", "db_type" => "integer"],
49 "Width" => ["db_col" => "width", "db_type" => "integer"],
50 "IdSetting" => ["db_col" => "id_setting", "db_type" => "integer"],
51 "NameSetting" => ["db_col" => "name_setting", "db_type" => "integer"]
52 ];
53
54 $this->element_db_mapping = [];
55 foreach ($this->properties as $key => $value) {
56 $this->element_db_mapping [$value["db_col"]] = $key;
57 }
58 }
59
65 public function readData($a_entity, $a_version, $a_id, $a_field = "")
66 {
67 global $ilDB;
68
69 $obj_id = $a_id;
70 $columns = [];
71 foreach ($this->properties as $property) {
72 array_push($columns, $property["db_col"]);
73 }
74
75 $query = "SELECT " . implode(",", $columns) . " FROM " . $this->db_table;
76 $query .= " WHERE id=" . $ilDB->quote($obj_id, "integer");
77 $result = $ilDB->query($query);
78 $this->data = [];
79 if ($dataset = $ilDB->fetchAssoc($result)) {
80 $this->data = $dataset;
81 }
82
83 $query = "SELECT title,description FROM object_data";
84 $query .= " WHERE obj_id=" . $ilDB->quote($obj_id, "integer");
85 $result = $ilDB->query($query);
86 while ($dataset = $ilDB->fetchAssoc($result)) {
87 $this->data ["title"] = $dataset["title"];
88 $this->data ["description"] = $dataset["description"];
89 }
90 }
91
98 public function writeData($a_entity, $a_version, $a_id, $data)
99 {
100 global $ilDB, $ilLog;
101 if (count($data) > 0) {
102 $columns = [];
103 foreach ($this->properties as $key => $value) {
104 if ($key == "Id" || $key == "title"|| $key == "description") {
105 continue;
106 }
107 //fix localization and mastery_score
108 if ($key == "MasteryScore" && $data[$key][0] == 0) {
109 continue;
110 }
111 if ($key == "Localization" && $data[$key][0] == "") {
112 continue;
113 }
114 //end fix
115 if (isset($data[$key])) {
116 if (count($data[$key]) > 0) {
117 $columns [$value["db_col"]] = [$value["db_type"], $data[$key][0]];
118 }
119 }
120 }
121 if (count($columns) > 0) {
122 $conditions ["id"] = ["integer", $a_id];
123 $ilDB->update($this->db_table, $columns, $conditions);
124 }
125
126 //setting title and description in table object_data
127 $od_table = "object_data";
128 $od_properties = [
129 "Title" => ["db_col" => "title", "db_type" => "text"],
130 "Description" => ["db_col" => "description", "db_type" => "text"]
131 ];
132 foreach ($od_properties as $key => $value) {
133 if (isset($data[$key])) {
134 if (count($data[$key]) > 0) {
135 $od_columns [$value["db_col"]] = [$value["db_type"], $data[$key][0]];
136 }
137 }
138
139 if (count($od_columns) > 0) {
140 $od_conditions ["obj_id"] = ["integer", $a_id];
141 $ilDB->update("object_data", $od_columns, $od_conditions);
142 }
143 }
144 } else {
145 $ilLog->write("no module properties for imported object");
146 }
147 }
148
149 /* retrieve element name by database column name
150 */
151 public function getElementNameByDbColumn($db_col_name)
152 {
153 if ($db_col_name == "title") {
154 return "Title";
155 }
156 if ($db_col_name == "description") {
157 return "Description";
158 }
159 return $this->element_db_mapping[$db_col_name];
160 }
161
173 public function getExtendedXmlRepresentation($a_entity, $a_schema_version, $a_ids, $a_field = "", $a_omit_header = false, $a_omit_types = false)
174 {
175 $GLOBALS["ilLog"]->write(json_encode($this->getTypes("sahs", "5.1.0"), JSON_PRETTY_PRINT));
176
177 $this->dircnt = 1;
178
179 $this->readData($a_entity, $a_schema_version, $a_ids, $a_field = "");
180 $id = $this->data["id"];
181
182 require_once("./Services/Export/classes/class.ilExport.php");
184
185 // step 1: check target release and supported versions
186 // step 2: init writer
187 require_once("./Services/Xml/classes/class.ilXmlWriter.php");
188 $writer = new ilXmlWriter();
189 if (!$a_omit_header) {
190 $writer->xmlHeader();
191 }
192
193 $atts = array("InstallationId" => IL_INST_ID,
194 "InstallationUrl" => ILIAS_HTTP_PATH, "TopEntity" => $a_entity);
195
196 $writer->appendXML("\n");
197 $writer->xmlStartTag($this->getDSPrefixString() . 'DataSet', $atts);
198 $writer->appendXML("\n");
199
200 foreach ($this->data as $key => $value) {
201 $writer->xmlElement($this->getElementNameByDbColumn($key), null, $value, true, true);
202 $writer->appendXML("\n");
203 }
204
205 $lmDir = ilUtil::getWebspaceDir("filesystem") . "/lm_data/lm_" . $id;
206 $baseFileName = "sahs_" . $id;
207 $scormBasePath=$exportDir . "/" . $baseFileName;
208 if (!file_exists($exportDir)) {
209 mkdir($exportDir, 0755, true);
210 }
211
212 ilUtil::zip($lmDir, $scormBasePath, true);
213 $scormFilePath = $scormBasePath . ".zip";
214
215 $writer->xmlEndTag($this->getDSPrefixString() . "DataSet");
216 $writer->appendXML("\n");
217
218 $xml = $writer->xmlDumpMem(false);
219 $baseExportName = time() . "__" . IL_INST_ID . "__" . $baseFileName;
220 $xmlFilePath = $exportDir . "/" . $baseExportName . ".xml";
221
222 if (!file_exists($xmlFilePath)) {
223 $xmlFile = fopen($xmlFilePath, "w");
224 fwrite($xmlFile, $xml);
225 fclose($xmlFile);
226 }
227
228 //create metadata
229 $metaData = $this->buildMetaData($id);
230
231 $metaDataFilePath = $exportDir . "/" . $baseExportName . "_metadata.xml";
232 if (!file_exists($metaDataFilePath)) {
233 $metaDataFile = fopen($metaDataFilePath, "w");
234 fwrite($metaDataFile, $metaData);
235 fclose($metaDataFile);
236 }
237
238 //create manifest file
239 $manWriter = new ilXmlWriter();
240 $manWriter->xmlHeader();
241 $manWriter->appendXML("\n<content>\n");
242
243 $files = [
244 "scormFile" => "content.zip",
245 "properties" => "properties.xml",
246 "metadata" => "metadata.xml"
247 ];
248 foreach ($files as $key => $value) {
249 $manWriter->xmlElement($key, null, $value, true, true);
250 $manWriter->appendXML("\n");
251 }
252
253 $manWriter->appendXML("</content>\n");
254 $manifest = $manWriter->xmlDumpMem(false);
255
256 $manifestFilePath = $exportDir . "/" . $baseExportName . "_manifest.xml";
257 if (!file_exists($manifestFilePath)) {
258 $manifestFile = fopen($manifestFilePath, "w");
259 fwrite($manifestFile, $manifest);
260 fclose($manifestFile);
261 }
262
263 $zArchive = new zipArchive();
264 $fileName = $exportDir . "/" . $baseExportName . ".zip";
265
266 if ($zArchive->open($fileName, ZipArchive::CREATE)!==true) {
267 exit("cannot open <$fileName>\n");
268 }
269
270 //creating final zip file
271 $zArchive->addFile($xmlFilePath, $baseExportName . '/properties.xml');
272 $zArchive->addFile($scormFilePath, $baseExportName . '/content.zip');
273 $zArchive->addFile($manifestFilePath, $baseExportName . '/' . "manifest.xml");
274 $zArchive->addFile($metaDataFilePath, $baseExportName . '/' . "metadata.xml");
275 $zArchive->close();
276 //delete temporary files
277 unlink($xmlFilePath);
278 unlink($scormFilePath);
279 unlink($manifestFilePath);
280 unlink($metaDataFilePath);
281
282 return $fileName;
283 }
284
285 public function buildMetaData($id)
286 {
287 require_once("Services/MetaData/classes/class.ilMD2XML.php");
288 $md2xml = new ilMD2XML($id, $id, "sahs");
289 $md2xml->startExport();
290 $xml = $md2xml->getXML();
291 return $xml;
292 }
293
301 protected function getTypes($a_entity, $a_version)
302 {
303 if ($a_entity == "sahs") {
304 switch ($a_version) {
305 case "5.1.0":
306 $types = [];
307 foreach ($this->properties as $key => $value) {
308 $types[$key] = $value["db_type"];
309 }
310 return $types;
311 break;
312 }
313 }
314 }
315
321 public function getXmlNamespace($a_entity, $a_schema_version)
322 {
323 return "http://www.ilias.de/xml/Modules/ScormAicc/" . $a_entity;
324 }
325
326 public function getDependencies()
327 {
328 return null;
329 }
330
331 public function getSupportedVersions()
332 {
333 return ["5.1.0"];
334 }
335}
$result
if(! $in) $columns
Definition: Utf8Test.php:45
$files
Definition: add-vimline.php:18
An exception for terminatinating execution or to throw for unit testing.
A dataset contains in data in a common structure that can be shared and transformed for different pur...
static _getExportDirectory($a_obj_id, $a_type="xml", $a_obj_type="", $a_entity="")
Get export directory for an repository object.
getSupportedVersions()
Get supported version.
getExtendedXmlRepresentation($a_entity, $a_schema_version, $a_ids, $a_field="", $a_omit_header=false, $a_omit_types=false)
own getXmlRepresentation function to embed zipfile in xml
readData($a_entity, $a_version, $a_id, $a_field="")
Read data.
writeData($a_entity, $a_version, $a_id, $data)
Write properties for imported object (actually updates !!)
getElementNameByDbColumn($db_col_name)
getXmlNamespace($a_entity, $a_schema_version)
Get xml namespace.
getTypes($a_entity, $a_version)
Get field types for entity.
static getWebspaceDir($mode="filesystem")
get webspace directory
static zip($a_dir, $a_file, $compress_content=false)
zips given directory/file into given zip.file
XML writer class.
$key
Definition: croninfo.php:18
if(!array_key_exists('StateId', $_REQUEST)) $id
$GLOBALS['loaded']
Global hash that tracks already loaded includes.
$xml
Definition: metadata.php:240
$query
$dataset
Definition: showstats.php:45
global $ilDB
$this data['403_header']