class.ilTestResultsImportParser.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\Filesystem\Stream\Stream;
use ILIAS\ResourceStorage\Services as ResourceStorage;

class ilTestResultsImportParser extends ilSaxParser
{
    private $table;
    private $active_id_mapping;
    private $question_id_mapping;
    private string $user_criteria_field = '';
    private string $user_criteria_type = '';
    private bool $user_criteria_checked = false;

    protected $src_pool_def_id_mapping;
    private string $import_directory;

    public function __construct(
        ?string $a_xml_file,
        private ilObjTest $test_obj,
        private ilDBInterface $db,
        private ilLogger $log,
        private ResourceStorage $irss
    ) {
        parent::__construct($a_xml_file, true);
        $this->table = '';
        $this->active_id_mapping = [];
        $this->question_id_mapping = [];
        $this->src_pool_def_id_mapping = [];
        $this->import_directory = dirname($a_xml_file);
    }

    public function getQuestionIdMapping(): array
    {
        return $this->question_id_mapping;
    }

    public function setQuestionIdMapping(array $question_id_mapping): void
    {
        $this->question_id_mapping = $question_id_mapping;
    }

    public function getSrcPoolDefIdMapping(): array
    {
        return $this->src_pool_def_id_mapping;
    }

    public function setSrcPoolDefIdMapping(array $src_pool_def_id_mapping): void
    {
        $this->src_pool_def_id_mapping = $src_pool_def_id_mapping;
    }

    public function setHandlers($a_xml_parser): void
    {
        xml_set_object($a_xml_parser, $this);
        xml_set_element_handler($a_xml_parser, 'handlerBeginTag', 'handlerEndTag');
        xml_set_character_data_handler($a_xml_parser, 'handlerParseCharacterData');
    }

    public function handlerBeginTag($a_xml_parser, $a_name, $a_attribs): void
    {
        switch (strtolower($a_name)) {
            case "results":
                break;
            case "row":
                switch ($this->table) {
                    case 'tst_active':
                        if (!$this->user_criteria_checked) {
                            $this->user_criteria_checked = true;
                            if (isset($a_attribs['user_criteria'])
                                && $this->db->tableColumnExists('usr_data', $a_attribs['user_criteria'])) {
                                $analyzer = new ilDBAnalyzer();
                                $info = $analyzer->getFieldInformation('usr_data');
                                $this->user_criteria_field = $a_attribs['user_criteria'];
                                $this->user_criteria_type = $info[$a_attribs['user_criteria']]['type'];
                            }
                        }
                        $usr_id = ANONYMOUS_USER_ID;
                        if ($this->user_criteria_field !== '') {
                            $result = $this->db->queryF(
                                'SELECT usr_id FROM usr_data WHERE '
                                    . $this->user_criteria_field . ' =  %s',
                                array($this->user_criteria_type),
                                array($a_attribs[$this->user_criteria_field])
                            );
                            if ($result->numRows()) {
                                $row = $this->db->fetchAssoc($result);
                                $usr_id = $row['usr_id'];
                            }
                        }
                        $next_id = $this->db->nextId('tst_active');

                        $this->db->insert('tst_active', array(
                            'active_id' => array('integer', $next_id),
                            'user_fi' => array('integer', $usr_id),
                            'anonymous_id' => array('text', strlen($a_attribs['anonymous_id']) ? $a_attribs['anonymous_id'] : null),
                            'test_fi' => array('integer', $this->test_obj->getTestId()),
                            'lastindex' => array('integer', $a_attribs['lastindex']),
                            'tries' => array('integer', $a_attribs['tries']),
                            'submitted' => array('integer', $a_attribs['submitted']),
                            'submittimestamp' => array('timestamp', strlen($a_attribs['submittimestamp']) ? $a_attribs['submittimestamp'] : null),
                            'tstamp' => array('integer', $a_attribs['tstamp']),
                            'importname' => array('text', $a_attribs['fullname']),
                            'last_finished_pass' => array('integer', $this->fetchLastFinishedPass($a_attribs)),
                            'last_started_pass' => array('integer', $this->fetchLastStartedPass($a_attribs)),
                            'answerstatusfilter' => array('integer', $this->fetchAttribute($a_attribs, 'answer_status_filter')),
                            'objective_container' => array('integer', $this->fetchAttribute($a_attribs, 'objective_container'))
                        ));
                        $this->active_id_mapping[$a_attribs['active_id']] = $next_id;
                        break;
                    case 'tst_test_rnd_qst':
                        $nextId = $this->db->nextId('tst_test_rnd_qst');
                        $newActiveId = $this->active_id_mapping[$a_attribs['active_fi']];
                        $newQuestionId = $this->question_id_mapping[$a_attribs['question_fi']];
                        $newSrcPoolDefId = $this->src_pool_def_id_mapping[$a_attribs['src_pool_def_fi']];
                        $this->db->insert('tst_test_rnd_qst', array(
                            'test_random_question_id' => array('integer', $nextId),
                            'active_fi' => array('integer', $newActiveId),
                            'question_fi' => array('integer', $newQuestionId),
                            'sequence' => array('integer', $a_attribs['sequence']),
                            'pass' => array('integer', $a_attribs['pass']),
                            'tstamp' => array('integer', $a_attribs['tstamp']),
                            'src_pool_def_fi' => array('integer', $newSrcPoolDefId)
                        ));
                        break;
                    case 'tst_pass_result':
                        $affectedRows = $this->db->manipulateF(
                            "INSERT INTO tst_pass_result (active_fi, pass, points, maxpoints, questioncount, answeredquestions, workingtime, tstamp) VALUES (%s,%s,%s,%s,%s,%s,%s,%s)",
                            array(
                                'integer',
                                'integer',
                                'float',
                                'float',
                                'integer',
                                'integer',
                                'integer',
                                'integer'
                            ),
                            array(
                                $this->active_id_mapping[$a_attribs['active_fi']],
                                strlen($a_attribs['pass']) ? $a_attribs['pass'] : 0,
                                ($a_attribs["points"]) ? $a_attribs["points"] : 0,
                                ($a_attribs["maxpoints"]) ? $a_attribs["maxpoints"] : 0,
                                $a_attribs["questioncount"],
                                $a_attribs["answeredquestions"],
                                ($a_attribs["workingtime"]) ? $a_attribs["workingtime"] : 0,
                                $a_attribs["tstamp"]
                            )
                        );
                        break;
                    case 'tst_result_cache':
                        $affectedRows = $this->db->manipulateF(
                            "INSERT INTO tst_result_cache (active_fi, pass, max_points, reached_points, mark_short, mark_official, passed, failed, tstamp) VALUES (%s,%s,%s,%s,%s,%s,%s,%s,%s)",
                            array(
                                'integer',
                                'integer',
                                'float',
                                'float',
                                'text',
                                'text',
                                'integer',
                                'integer',
                                'integer'
                            ),
                            array(
                                $this->active_id_mapping[$a_attribs['active_fi']],
                                strlen($a_attribs['pass']) ? $a_attribs['pass'] : 0,
                                ($a_attribs["max_points"]) ? $a_attribs["max_points"] : 0,
                                ($a_attribs["reached_points"]) ? $a_attribs["reached_points"] : 0,
                                strlen($a_attribs["mark_short"]) ? $a_attribs["mark_short"] : " ",
                                strlen($a_attribs["mark_official"]) ? $a_attribs["mark_official"] : " ",
                                ($a_attribs["passed"]) ? 1 : 0,
                                ($a_attribs["failed"]) ? 1 : 0,
                                $a_attribs["tstamp"]
                            )
                        );
                        break;
                    case 'tst_sequence':
                        $affectedRows = $this->db->insert("tst_sequence", array(
                            "active_fi" => array("integer", $this->active_id_mapping[$a_attribs['active_fi']]),
                            "pass" => array("integer", $a_attribs['pass']),
                            "sequence" => array("clob", $a_attribs['sequence']),
                            "postponed" => array("text", (strlen($a_attribs['postponed'])) ? $a_attribs['postponed'] : null),
                            "hidden" => array("text", (strlen($a_attribs['hidden'])) ? $a_attribs['hidden'] : null),
                            "tstamp" => array("integer", $a_attribs['tstamp'])
                        ));
                        break;
                    case 'tst_solutions':
                        $next_id = $this->db->nextId('tst_solutions');
                        $affectedRows = $this->db->insert("tst_solutions", array(
                            "solution_id" => array("integer", $next_id),
                            "active_fi" => array("integer", $this->active_id_mapping[$a_attribs['active_fi']]),
                            "question_fi" => array("integer", $this->question_id_mapping[$a_attribs['question_fi']]),
                            "value1" => array("clob", $this->importParticipantsUploadedFiles($a_attribs)),
                            "value2" => array("clob", (strlen($a_attribs['value2'])) ? $a_attribs['value2'] : null),
                            "pass" => array("integer", $a_attribs['pass']),
                            "tstamp" => array("integer", $a_attribs['tstamp'])
                        ));
                        break;
                    case 'tst_test_result':
                        $next_id = $this->db->nextId('tst_test_result');
                        $affectedRows = $this->db->manipulateF(
                            "INSERT INTO tst_test_result (test_result_id, active_fi, question_fi, points, pass, manual, tstamp) VALUES (%s, %s, %s, %s, %s, %s, %s)",
                            array('integer', 'integer','integer', 'float', 'integer', 'integer','integer'),
                            array($next_id, $this->active_id_mapping[$a_attribs['active_fi']], $this->question_id_mapping[$a_attribs['question_fi']], $a_attribs['points'], $a_attribs['pass'], (strlen($a_attribs['manual'])) ? $a_attribs['manual'] : 0, $a_attribs['tstamp'])
                        );
                        break;
                    case 'tst_times':
                        $next_id = $this->db->nextId('tst_times');
                        $affectedRows = $this->db->manipulateF(
                            "INSERT INTO tst_times (times_id, active_fi, started, finished, pass, tstamp) VALUES (%s, %s, %s, %s, %s, %s)",
                            array('integer', 'integer', 'timestamp', 'timestamp', 'integer', 'integer'),
                            array($next_id, $this->active_id_mapping[$a_attribs['active_fi']], $a_attribs['started'], $a_attribs['finished'], $a_attribs['pass'], $a_attribs['tstamp'])
                        );
                        break;
                }
                break;
            default:
                $this->table = $a_name;
                break;
        }
    }

    public function handlerEndTag($a_xml_parser, $a_name): void
    {
        switch (strtolower($a_name)) {
            case "tst_active":
                $this->log->write("active id mapping: " . print_r($this->active_id_mapping, true));
                break;
            case "tst_test_question":
                $this->log->write("question id mapping: " . print_r($this->question_id_mapping, true));
                break;
        }
    }

    public function handlerParseCharacterData($a_xml_parser, $a_data): void
    {
        // do nothing
    }

    private function fetchAttribute($attributes, $name)
    {
        if (isset($attributes[$name])) {
            return $attributes[$name];
        }

        return null;
    }

    private function fetchLastFinishedPass($attribs): ?int
    {
        if (isset($attribs['last_finished_pass'])) {
            return (int) $attribs['last_finished_pass'];
        }

        if ($attribs['tries'] > 0) {
            return $attribs['tries'] - 1;
        }

        return null;
    }

    private function fetchLastStartedPass($attribs): ?int
    {
        if (isset($attribs['last_started_pass'])) {
            return (int) $attribs['last_started_pass'];
        }

        if ($attribs['tries'] > 0) {
            return (int) $attribs['tries'] - 1;
        }

        return null;
    }

    private function importParticipantsUploadedFiles(array $a_attribs): ?string
    {
        ['value1' => $value1, 'value2' => $value2] = $a_attribs;

        if ($value2 !== 'rid') {
            return $value1 !== '' ? $value1 : null;
        }

        $resource_directory = "$this->import_directory/objects/resources/$value1";
        $file_name = $this->getFirstFileName($resource_directory);
        if (!is_string($file_name)) {
            return $value1 !== '' ? $value1 : null;
        }

        $file_path = "$resource_directory/$file_name";
        $new_rid = $this->irss->manage()->stream(
            new Stream(fopen($file_path, 'rwb')),
            new assFileUploadStakeholder(),
            basename($file_path),
        );
        return $new_rid->serialize();
    }

    private function getFirstFileName(string $resource_directory): mixed
    {
        $entries = array_filter(
            scandir($resource_directory),
            static fn(string $entry): bool => is_file("$resource_directory/$entry") && !in_array($entry, ['.', '..']),
        );
        return array_shift($entries);
    }
}