class.ilSCORM2004StoreData.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

class ilSCORM2004StoreData
{
    public static function scormPlayerUnload(int $packageId, int $refId, bool $time_from_lms, ?int $userId = null): void
    {
        global $DIC;

        $ilDB = $DIC->database();

        //              $data = json_decode(is_string($data) ? $data : file_get_contents('php://input'));
        $data = json_decode(file_get_contents('php://input'));
        if (!$data) {
            return;
        }
        if ($userId == null) {
            $userId = (int) $data->p;
            self::checkIfAllowed($packageId, $userId, $data->hash);
        }
        $last_visited = null;
        if ($data->last != "") {
            $last_visited = $data->last;
        }
        $endDate = date(
            'Y-m-d H:i:s',
            mktime(
                (int) date('H'),
                (int) date('i') + 5,
                (int) date('s'),
                (int) date('m'),
                (int) date('d'),
                (int) date('Y')
            )
        );
        $total_time_sec = null;
        if ($data->total_time_sec != "") {
            $total_time_sec = $data->total_time_sec;
            $ilDB->manipulateF(
                'UPDATE sahs_user 
                                SET total_time_sec = %s, last_visited = %s, hash_end =%s, last_access = %s
                                WHERE obj_id = %s AND user_id = %s',
                array('integer', 'text', 'timestamp', 'timestamp', 'integer', 'integer'),
                array($total_time_sec, $last_visited, $endDate, date('Y-m-d H:i:s'), $packageId, $userId)
            );
            if ($time_from_lms == true) {
                self::ensureObjectDataCacheExistence();
                global $DIC;

                $ilObjDataCache = $DIC["ilObjDataCache"];
                // sync access number and time in read event table
                ilSCORM2004Tracking::_syncReadEvent($packageId, $userId, "sahs", $refId, $time_from_lms);
                //end sync access number and time in read event table
            }
        } else {
            $ilDB->manipulateF(
                'UPDATE sahs_user 
                                SET last_visited = %s, hash_end =%s, last_access = %s
                                WHERE obj_id = %s AND user_id = %s',
                array('text', 'timestamp', 'timestamp', 'integer', 'integer'),
                array($last_visited, $endDate, date('Y-m-d H:i:s'), $packageId, $userId)
            );
        }

        header('Content-Type: text/plain; charset=UTF-8');
        print("");
    }

    public static function checkIfAllowed(int $packageId, int $userId, int $hash): void
    {
        global $DIC;

        $ilDB = $DIC->database();
        $res = $ilDB->queryF(
            'select hash from sahs_user where obj_id=%s AND user_id=%s AND hash_end>%s',
            array('integer', 'integer', 'timestamp'),
            array($packageId, $userId, date('Y-m-d H:i:s'))
        );
        $rowtmp = $ilDB->fetchAssoc($res);
        if ($rowtmp && (int) $rowtmp['hash'] == $hash) {
            return;
        }

        die("not allowed");
    }

    protected static function ensureObjectDataCacheExistence(): void
    {
        global $DIC;

        $ilObjDataCache = $DIC["ilObjDataCache"];

        if ($ilObjDataCache instanceof ilObjectDataCache) {
            return;
        }
        $ilObjDataCache = new ilObjectDataCache();
        $GLOBALS['DIC']['ilObjDataCache'] = $ilObjDataCache;
    }

    public static function persistCMIData(
        int $packageId,
        int $refId,
        string $defaultLessonMode,
        bool $comments,
        bool $interactions,
        bool $objectives,
        bool $time_from_lms,
        ?string $data = null,
        ?int $userId = null
    ): void {
        global $DIC;

        $ilLog = ilLoggerFactory::getLogger('sc13');

        if ($defaultLessonMode === "browse") {
            return;
        }

        $jsMode = strpos($_SERVER['HTTP_ACCEPT'], 'text/javascript') !== false;//ToDo: Avoid $_SERVER

        $data = json_decode(is_string($data) ? $data : file_get_contents('php://input'));
        $ilLog->debug("dataTo_setCMIData: " . file_get_contents('php://input'));
        if (!$data) {
            return;
        }
        if ($userId == null) {
            $userId = (int) $data->p;
            self::checkIfAllowed($packageId, $userId, $data->hash);
            //                  header('Access-Control-Allow-Origin: http://localhost:50012');//just for tests - not for release UK
        }
        $return = ilSCORM2004StoreData::setCMIData(
            $userId,
            $packageId,
            $data,
            $comments,
            $interactions,
            $objectives
        );

        //$new_global_status=ilSCORM2004StoreData::setGlobalObjectivesAndGetGlobalStatus($userId, $packageId, $data);
        ilSCORM2004StoreData::setGlobalObjectives($userId, $packageId, $data);
        $new_global_status = $data->now_global_status;
        $return["new_global_status"] = $new_global_status;

        // mantis #30293
        $score_scaled = $data->node[0][35];
        if ($score_scaled != null) {
            if (ilObjSCORM2004LearningModule::getQuantityOfSCOs($packageId) == 1) {
                ilLTIAppEventListener::handleOutcomeWithoutLP($packageId, $userId, $score_scaled * 100);
            }
        }

        ilSCORM2004StoreData::syncGlobalStatus($userId, $packageId, $refId, $data, $new_global_status, $time_from_lms);

        $ilLog->debug("SCORM: return of persistCMIData: " . json_encode($return));
        if ($jsMode) {
            header('Content-Type: text/javascript; charset=UTF-8');
            print(json_encode($return));
        } else {
            header('Content-Type: text/html; charset=UTF-8');
            print(var_export($return, true));
        }
    }

    public static function setCMIData(
        int $userId,
        int $packageId,
        object $data,
        bool $getComments,
        bool $getInteractions,
        bool $getObjectives
    ): array {
        global $DIC;

        $ilDB = $DIC->database();
        $ilLog = ilLoggerFactory::getLogger('sc13');

        $result = array();

        if (!$data) {
            return $result;
        }

        $i_check = $data->i_check;
        $i_set = $data->i_set;
        $b_node_update = false;
        $cmi_node_id = null;
        $a_map_cmi_interaction_id = array();

        $tables = array('node', 'comment', 'interaction', 'objective', 'correct_response');

        foreach ($tables as $table) {
            if (!is_array($data->$table)) {
                continue;
            }

            $ilLog->debug("SCORM: setCMIData, table -" . $table . "-");

            // now iterate through data rows from input
            foreach ($data->$table as &$row) {
                $ilLog->debug("Checking table: " . $table);

                switch ($table) {
                    case 'node': //is always first and has only 1 row

                        $res = $ilDB->queryF(
                            'SELECT cmi_node_id FROM cmi_node WHERE cp_node_id = %s and user_id = %s',
                            array('integer', 'integer'),
                            array($row[19], $userId)
                        );
                        $rowtmp = $ilDB->fetchAssoc($res);

                        if ($rowtmp != null) {
                            $cmi_node_id = $rowtmp['cmi_node_id'];
                            $b_node_update = true;
                        } else {
                            $cmi_node_id = $ilDB->nextId('cmi_node');
                            $b_node_update = false;
                        }
                        $ilLog->debug("setCMIdata with cmi_node_id = " . $cmi_node_id);
                        $a_data = array(
                            'accesscount' => array('integer', $row[0]),
                            'accessduration' => array('text', $row[1]),
                            'accessed' => array('text', $row[2]),
                            'activityabsduration' => array('text', $row[3]),
                            'activityattemptcount' => array('integer', $row[4]),
                            'activityexpduration' => array('text', $row[5]),
                            'activityprogstatus' => array('integer', $row[6]),
                            'attemptabsduration' => array('text', $row[7]),
                            'attemptcomplamount' => array('float', $row[8]),
                            'attemptcomplstatus' => array('integer', $row[9]),
                            'attemptexpduration' => array('text', $row[10]),
                            'attemptprogstatus' => array('integer', $row[11]),
                            'audio_captioning' => array('integer', $row[12]),
                            'audio_level' => array('float', $row[13]),
                            'availablechildren' => array('text', $row[14]),
                            'cmi_node_id' => array('integer', $cmi_node_id),
                            'completion' => array('float', $row[16]),
                            'completion_status' => array('text', $row[17]),
                            'completion_threshold' => array('text', $row[18]),
                            'cp_node_id' => array('integer', $row[19]),
                            'created' => array('text', $row[20]),
                            'credit' => array('text', $row[21]),
                            'delivery_speed' => array('float', $row[22]),
                            'c_entry' => array('text', $row[23]),
                            'c_exit' => array('text', $row[24]),
                            'c_language' => array('text', $row[25]),
                            'launch_data' => array('clob', $row[26]),
                            'learner_name' => array('text', $row[27]),
                            'location' => array('text', $row[28]),
                            'c_max' => array('float', $row[29]),
                            'c_min' => array('float', $row[30]),
                            'c_mode' => array('text', $row[31]),
                            'modified' => array('text', $row[32]),
                            'progress_measure' => array('float', $row[33]),
                            'c_raw' => array('float', $row[34]),
                            'scaled' => array('float', $row[35]),
                            'scaled_passing_score' => array('float', $row[36]),
                            'session_time' => array('text', $row[37]),
                            'success_status' => array('text', $row[38]),
                            'suspend_data' => array('clob', $row[39]),
                            'total_time' => array('text', $row[40]),
                            'user_id' => array('integer', $userId),
                            'c_timestamp' => array('timestamp', date('Y-m-d H:i:s')),
                            'additional_tables' => array('integer', $i_check)
                        );

                        if ($b_node_update == false) {
                            $ilDB->insert('cmi_node', $a_data);
                            $ilLog->debug("inserted");
                        } else {
                            $ilDB->update('cmi_node', $a_data, array('cmi_node_id' => array('integer', $cmi_node_id)));
                            $ilLog->debug("updated");
                        }

                        if ($b_node_update == true) {
                            //remove
                            if ($i_set > 7) {
                                $i_set -= 8;
                                if ($getComments) {
                                    $q = 'DELETE FROM cmi_comment WHERE cmi_node_id = %s';
                                    $ilDB->manipulateF($q, array('integer'), array($cmi_node_id));
                                }
                            }
                            if ($i_set > 3) {
                                $i_set -= 4;
                                if ($getInteractions) {
                                    $q = '
                                        DELETE cmir
                                        FROM cmi_correct_response cmir 
                                        INNER JOIN cmi_interaction cmii ON cmii.cmi_interaction_id = cmir.cmi_interaction_id 
                                        WHERE cmii.cmi_node_id = %s
                                    ';
                                    $ilDB->manipulateF($q, array('integer'), array($cmi_node_id));
                                }
                            }
                            if ($i_set > 1) {
                                $i_set -= 2;
                                if ($getInteractions) {
                                    $q = 'DELETE FROM cmi_interaction WHERE cmi_node_id = %s';
                                    $ilDB->manipulateF($q, array('integer'), array($cmi_node_id));
                                }
                            }
                            if ($i_set > 0) {
                                $i_set = 0;
                                if ($getObjectives) {
                                    $q = 'DELETE FROM cmi_objective WHERE cmi_node_id = %s';
                                    $ilDB->manipulateF($q, array('integer'), array($cmi_node_id));
                                }
                            }
                            //end remove
                        }
                        //to send to client
                        $result[(string) $row[19]] = $cmi_node_id;
                        break;

                    case 'comment':
                        $row[0] = $ilDB->nextId('cmi_comment');

                        $ilDB->insert('cmi_comment', array(
                            'cmi_comment_id' => array('integer', $row[0]),
                            'cmi_node_id' => array('integer', $cmi_node_id),
                            'c_comment' => array('clob', $row[2]),
                            'c_timestamp' => array('text', $row[3]),
                            'location' => array('text', $row[4]),
                            'sourceislms' => array('integer', $row[5])
                        ));
                        break;

                    case 'interaction':
                        $cmi_interaction_id = $ilDB->nextId('cmi_interaction');
                        $a_map_cmi_interaction_id[] = array($row[0], $cmi_interaction_id);
                        $ilDB->insert('cmi_interaction', array(
                            'cmi_interaction_id' => array('integer', $cmi_interaction_id),
                            'cmi_node_id' => array('integer', $cmi_node_id),
                            'description' => array('clob', $row[2]),
                            'id' => array('text', $row[3]),
                            'latency' => array('text', $row[4]),
                            'learner_response' => array('clob', $row[5]),
                            'result' => array('text', $row[6]),
                            'c_timestamp' => array('text', $row[7]),
                            'c_type' => array('text', $row[8]),
                            'weighting' => array('float', $row[9])
                        ));
                        break;

                    case 'objective':
                        $row[2] = $ilDB->nextId('cmi_objective');
                        $cmi_interaction_id = null;
                        if ($row[0] != null) {
                            foreach ($a_map_cmi_interaction_id as $i => $value) {
                                if ($row[0] == $value[0]) {
                                    $cmi_interaction_id = $value[1];
                                }
                            }
                        }
                        $ilDB->insert('cmi_objective', array(
                            'cmi_interaction_id' => array('integer', $cmi_interaction_id),
                            'cmi_node_id' => array('integer', $cmi_node_id),
                            'cmi_objective_id' => array('integer', $row[2]),
                            'completion_status' => array('text', $row[3]),
                            'description' => array('clob', $row[4]),
                            'id' => array('text', $row[5]),
                            'c_max' => array('float', $row[6]),
                            'c_min' => array('float', $row[7]),
                            'c_raw' => array('float', $row[8]),
                            'scaled' => array('float', $row[9]),
                            'progress_measure' => array('float', $row[10]),
                            'success_status' => array('text', $row[11]),
                            'scope' => array('text', $row[12])
                        ));
                        break;

                    case 'correct_response':
                        $cmi_interaction_id = null;
                        if ($row[1] !== null) {
                            foreach ($a_map_cmi_interaction_id as $i => $value) {
                                if ($row[1] == $value[0]) {
                                    $cmi_interaction_id = $value[1];
                                }
                            }
                            $row[0] = $ilDB->nextId('cmi_correct_response');
                            $ilDB->insert('cmi_correct_response', array(
                                'cmi_correct_resp_id' => array('integer', $row[0]),
                                'cmi_interaction_id' => array('integer', $cmi_interaction_id),
                                'pattern' => array('text', $row[2])
                            ));
                        }
                        break;
                }
            }
        }
        return $result;
    }

    protected static function setGlobalObjectives(int $userId, int $packageId, object $data): void
    {
        $ilLog = ilLoggerFactory::getLogger('sc13');
        $changed_seq_utilities = $data->changed_seq_utilities;
        $ilLog->debug("SCORM2004 adl_seq_utilities changed: " . $changed_seq_utilities);
        if ($changed_seq_utilities == 1) {
            $returnAr = ilSCORM2004StoreData::writeGObjective($userId, $packageId, (array) $data->adl_seq_utilities);
        }
    }


    //saves global_objectives to database
    //$dowrite only if changed adl_seq_utilities
    public static function writeGObjective(int $user, int $package, ?array $g_data): array
    {
        global $DIC;
        $ilDB = $DIC->database();
        $ilLog = ilLoggerFactory::getLogger('sc13');
        $ilLog->debug("SCORM2004 writeGObjective");

        $returnAr = array(null, null, null);

        //iterate over assoziative array
        if ($g_data == null) {
            return $returnAr;
        }

        $rows_to_insert = array();

        foreach ($g_data as $key => $value) {
            $ilLog->debug("SCORM2004 writeGObjective -key: " . $key);
            //objective
            //learner = ilias learner id
            //scope = null / course
            foreach ($value as $skey => $svalue) {
                $ilLog->debug("SCORM2004 writeGObjective -skey: " . $skey);
                //we always have objective and learner id
                //                var_dump($svalue->$user->{"null"});
                //                die();
                //                if ($g_data->$key->$skey->$user->$package) { //check
                //                    $o_value = $g_data->$key->$skey->$user->$package;
                //                    $scope = $package;
                //                } else { //UK: is this okay? can $scope=0 and $user->{"null"}; when is $scope used?
                //                    //scope 0
                //                    $o_value = $g_data->$key->$skey->$user->{"null"};
                //                    //has to be converted to NULL in JS Later
                //                    $scope = 0;
                //                }
                if (isset($svalue->$user->$package)) {
                    $o_value = $svalue->$user->$package;
                    $scope = $package;
                } else { //UK: is this okay? can $scope=0 and $user->{"null"}; when is $scope used?
                    //scope 0
                    $o_value = null;
                    //has to be converted to NULL in JS Later
                    $scope = 0;
                }

                //insert into database
                $objective_id = $skey;
                $toset = $o_value;
                $dbuser = $user;
                if ($key === "status") {
                    //special handling for status
                    //                    $completed = $g_data->$key->$skey->$user->{"completed"};
                    //                    $measure = $g_data->$key->$skey->$user->{"measure"};
                    //                    $satisfied = $g_data->$key->$skey->$user->{"satisfied"};
                    $completed = $svalue->$user->{"completed"};
                    $measure = $svalue->$user->{"measure"};
                    $satisfied = $svalue->$user->{"satisfied"};

                    $returnAr = array($completed, $satisfied, $measure);

                    $obj = '-course_overall_status-';
                    $pkg_id = $package;

                    $res = $ilDB->queryF(
                        '
                                        SELECT user_id FROM cmi_gobjective
                                        WHERE objective_id =%s
                                        AND user_id = %s
                                        AND scope_id = %s',
                        array('text', 'integer', 'integer'),
                        array($obj, $dbuser, $pkg_id)
                    );
                    $ilLog->debug("SCORM2004 Count is: " . $ilDB->numRows($res));
                    if (!$ilDB->numRows($res)) {
                        $ilDB->manipulateF(
                            '
                                                INSERT INTO cmi_gobjective
                                                (user_id, status, scope_id, measure, satisfied, objective_id)
                                                VALUES (%s, %s, %s, %s, %s, %s)',
                            array('integer', 'text', 'integer', 'text', 'text', 'text'),
                            array($dbuser, $completed, $pkg_id, $measure, $satisfied, $obj)
                        );
                        $ilLog->debug("SCORM2004 cmi_gobjective Insert status=" . $completed . " scope_id=" . $pkg_id . " measure=" . $measure . " satisfied=" . $satisfied . " objective_id=" . $obj);
                    } else {
                        $ilDB->manipulateF(
                            '
                                                UPDATE cmi_gobjective
                                                SET status = %s,
                                                        measure = %s,
                                                        satisfied = %s
                                                WHERE objective_id = %s
                                                AND user_id = %s
                                                AND scope_id = %s',
                            array('text', 'text', 'text', 'text', 'integer', 'integer'),
                            array($completed, $measure, $satisfied, $obj, $dbuser, $pkg_id)
                        );
                        //                        $ilLog->debug("SCORM2004 cmi_gobjective Update status=" . $completed . " scope_id=" . $pkg_id . " measure=" . $measure . " satisfied=" . $satisfied . " objective_id=" . $obj);
                    }
                } else { //add it to the rows_to_insert
                    //create the row if this is the first time it has been found
                    if ($rows_to_insert[$objective_id] == null) {
                        $rows_to_insert[$objective_id] = array();
                    }
                    $rows_to_insert[$objective_id][$key] = $toset;
                }
            }
        }

        //Get the scope for all the global objectives!!!
        $res = $ilDB->queryF(
            "SELECT global_to_system FROM cp_package WHERE obj_id = %s",
            array('text'),
            array($package)
        );

        $scope_id = ($ilDB->fetchObject($res)->global_to_system) ? 0 : $package;

        //build up the set to look for in the query
        $existing_key_template = "";
        foreach (array_keys($rows_to_insert) as $obj_id) {
            $existing_key_template .= "'{$obj_id}',";
        }
        //remove trailing ','
        $existing_key_template = substr($existing_key_template, 0, -1);
        $existing_keys = array();

        if ($existing_key_template != "") {
            //Get the ones that need to be updated in a single query
            $res = $ilDB->queryF(
                "SELECT objective_id 
                                                                  FROM cmi_gobjective 
                                                                  WHERE user_id = %s
                                                                  AND scope_id = %s
                                                                  AND objective_id IN ($existing_key_template)",
                array('integer', 'integer'),
                array($dbuser, $scope_id)
            );

            while ($row = $ilDB->fetchAssoc($res)) {
                $existing_keys[] = $row['objective_id'];
            }
        }

        foreach ($rows_to_insert as $obj_id => $vals) {
            if (in_array($obj_id, $existing_keys)) {
                $ilDB->manipulateF(
                    "UPDATE cmi_gobjective
                                                                         SET satisfied=%s,
                                                                                 measure=%s,
                                                                                 score_raw=%s,
                                                                             score_min=%s,
                                                                                 score_max=%s,
                                                                                 completion_status=%s,
                                                                                 progress_measure=%s
                                                                         WHERE objective_id = %s
                                                                         AND user_id = %s
                                                                         AND scope_id = %s",
                    array('text',
                          'text',
                          'text',
                          'text',
                          'text',
                          'text',
                          'text',
                          'text',
                          'integer',
                          'integer'
                    ),
                    array($vals['satisfied'],
                          $vals["measure"],
                          $vals["score_raw"],
                          $vals["score_min"],
                          $vals["score_max"],
                          $vals["completion_status"],
                          $vals["progress_measure"],
                          $obj_id,
                          $dbuser,
                          $scope_id
                    )
                );
            } else {
                $ilDB->manipulateF(
                    "INSERT INTO cmi_gobjective
                                                                        (user_id, satisfied, measure, scope_id, status, objective_id,
                                                                         score_raw, score_min, score_max, progress_measure, completion_status)
                                                                        VALUES(%s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s)",
                    array('integer',
                          'text',
                          'text',
                          'integer',
                          'text',
                          'text',
                          'text',
                          'text',
                          'text',
                          'text',
                          'text'
                    ),
                    array($dbuser,
                          $vals['satisfied'],
                          $vals['measure'],
                          $scope_id,
                          null,
                          $obj_id,
                          $vals['score_raw'],
                          $vals['score_min'],
                          $vals['score_max'],
                          $vals['progress_measure'],
                          $vals['completion_status']
                    )
                );
            }
        }

        // update learning progress here not necessary because integrated in setCMIdata
        // check _updateStatus for cmi_gobjective
        //              ilLPStatusWrapper::_updateStatus($package, $user);

        return $returnAr;
    }

    public static function syncGlobalStatus(int $userId, int $packageId, int $refId, object $data, int $new_global_status, bool $time_from_lms): void
    {
        global $DIC;
        $ilDB = $DIC->database();
        $ilLog = $DIC["ilLog"];
        $saved_global_status = $data->saved_global_status;
        $ilLog->write("saved_global_status=" . $saved_global_status);

        //update percentage_completed, sco_total_time_sec,status in sahs_user
        $totalTime = (int) $data->totalTimeCentisec;
        $totalTime = round($totalTime / 100);
        $ilDB->queryF(
            'UPDATE sahs_user SET sco_total_time_sec=%s, status=%s, percentage_completed=%s WHERE obj_id = %s AND user_id = %s',
            array('integer', 'integer', 'integer', 'integer', 'integer'),
            array($totalTime, $new_global_status, $data->percentageCompleted, $packageId, $userId)
        );

        self::ensureObjectDataCacheExistence();

        $ilObjDataCache = $DIC["ilObjDataCache"];

        // update learning progress
        if ($new_global_status != null) {//could only happen when synchronising from SCORM Offline Player
            ilLPStatusWrapper::_updateStatus($packageId, $userId);

            //                  here put code for soap to MaxCMS e.g. when if($saved_global_status != $new_global_status)
        }
        // sync access number and time in read event table
        if ($time_from_lms == false) {
            ilSCORM2004Tracking::_syncReadEvent($packageId, $userId, "sahs", $refId, $time_from_lms);
        }
        //end sync access number and time in read event table
    }
}