class.ilExerciseXMLParser.php

Go to the documentation of this file.

<?php

class ilExerciseXMLParser extends ilSaxParser
{
    public static int $CONTENT_NOT_COMPRESSED = 0;
    public static int $CONTENT_GZ_COMPRESSED = 1;
    public static int $CONTENT_ZLIB_COMPRESSED = 2;
    protected string $cdata;
    protected string $mark;
    protected string $notice;
    protected string $comment;
    protected string $file_content;
    protected string $file_name;
    protected string $status;
    protected string $file_action;
    protected int $usr_id;
    protected string $usr_action;

    public ilObjExercise $exercise;
    public int $obj_id;
    public bool $result;
    public int $mode;
    public ilExAssignment $assignment;

    public function __construct(
        ilObjExercise $exercise,
        string $a_xml_data,
        int $obj_id = -1
    ) {
        // @todo: needs to be revised for multiple assignments per exercise

        parent::__construct();

        $this->exercise = $exercise;
        // get all assignments and choose first one if exists, otherwise create
        $assignments = ilExAssignment::getAssignmentDataOfExercise($exercise->getId());
        if (count($assignments) > 0) {
            $this->assignment = new ilExAssignment($assignments [0]["id"]);
        } else {
            $this->assignment = new ilExAssignment();
            $this->assignment->setExerciseId($exercise->getId());
            $this->assignment->save();
        }

        $this->setXMLContent($a_xml_data);
        $this->obj_id = $obj_id;
        $this->result = false;
    }


    public function setHandlers($a_xml_parser): void
    {
        xml_set_element_handler($a_xml_parser, $this->handlerBeginTag(...), $this->handlerEndTag(...));
        xml_set_character_data_handler($a_xml_parser, $this->handlerCharacterData(...));
    }

    public function handlerBeginTag($a_xml_parser, string $a_name, array $a_attribs): void
    {
        $a_attribs = $this->trimAndStripAttribs($a_attribs);
        switch ($a_name) {
            case 'Exercise':
                if (isset($a_attribs["obj_id"])) {
                    $read_obj_id = ilUtil::__extractId($a_attribs["obj_id"], IL_INST_ID);
                    if ($this->obj_id != -1 && (int) $read_obj_id != -1 && $this->obj_id !== (int) $read_obj_id) {
                        throw new ilExerciseException("Object IDs (xml $read_obj_id and argument " . $this->obj_id . ") do not match!", ilExerciseException::$ID_MISMATCH);
                    }
                }
                break;
            case 'Member':
                $this->usr_action = $a_attribs["action"];
                $this->usr_id = (int) ilUtil::__extractId($a_attribs["usr_id"], IL_INST_ID);
                break;

            case 'File':
                $this->file_action = $a_attribs["action"];
                break;
            case 'Content':
                $this->mode = ilExerciseXMLParser::$CONTENT_NOT_COMPRESSED;
                if ($a_attribs["mode"] == "GZIP") {
                    if (!function_exists("gzdecode")) {
                        throw new ilExerciseException("Deflating with gzip is not supported", ilExerciseException::$ID_DEFLATE_METHOD_MISMATCH);
                    }

                    $this->mode = ilExerciseXMLParser::$CONTENT_GZ_COMPRESSED;
                } elseif ($a_attribs["mode"] == "ZLIB") {
                    if (!function_exists("gzuncompress")) {
                        throw new ilExerciseException("Deflating with zlib (compress/uncompress) is not supported", ilExerciseException::$ID_DEFLATE_METHOD_MISMATCH);
                    }

                    $this->mode = ilExerciseXMLParser::$CONTENT_ZLIB_COMPRESSED;
                }
                break;
            case 'Marking':
                $this->status = $a_attribs["status"];
                if ($this->status == ilExerciseXMLWriter::$STATUS_NOT_GRADED) {
                    $this->status = "notgraded";
                } elseif ($this->status == ilExerciseXMLWriter::$STATUS_PASSED) {
                    $this->status = "passed";
                } else {
                    $this->status = "failed";
                }
                break;
        }
    }



    public function handlerEndTag($a_xml_parser, string $a_name): void
    {
        switch ($a_name) {
            case 'Exercise':
                $this->result = true;
                break;
            case 'Title':
                $this->exercise->setTitle($this->trimAndStrip((string) $this->cdata));
                $this->assignment->setTitle($this->trimAndStrip((string) $this->cdata));
                break;
            case 'Description':
                $this->exercise->setDescription($this->trimAndStrip((string) $this->cdata));
                break;
            case 'Instruction':
                $this->assignment->setInstruction($this->trimAndStrip((string) $this->cdata));
                break;
            case 'DueDate':
                $this->assignment->setDeadLine($this->trimAndStrip((string) $this->cdata));
                break;
            case 'Member':
                $this->updateMember($this->usr_id, $this->usr_action);
                // update marking after update member.
                $this->updateMarking($this->usr_id);
                break;
            case 'Filename':
                $this->file_name = $this->trimAndStrip((string) $this->cdata);
                break;
            case 'Content':
                $this->file_content = $this->trimAndStrip((string) $this->cdata);
                break;
            case 'Comment':
                $this->comment = $this->trimAndStrip((string) $this->cdata);
                break;
            case 'Notice':
                $this->notice = $this->trimAndStrip((string) $this->cdata);
                break;
            case 'Mark':
                $this->mark = $this->trimAndStrip((string) $this->cdata);
                break;
            case 'Marking':
                // see Member end tag
                break;
        }
        $this->cdata = '';
    }

    public function handlerCharacterData($a_xml_parser, string $a_data): void
    {
        if ($a_data != "\n") {
            $this->cdata .= $a_data;
        }
    }


    private function updateMember(int $user_id, string $action): void
    {
        if (!is_int($user_id) || $user_id <= 0) {
            return;
        }
        $memberObject = new ilExerciseMembers($this->exercise);

        if ($action == "Attach" && !$memberObject->isAssigned($user_id)) {
            $memberObject->assignMember($user_id);
        }

        if ($action == "Detach" && $memberObject->isAssigned($user_id)) {
            $memberObject->deassignMember($user_id);
        }
    }

    public function start(): bool
    {
        $this->startParsing();
        return $this->result > 0;
    }

    private function updateMarking(int $usr_id): void
    {
        $member_status = $this->assignment->getMemberStatus($usr_id);
        if (isset($this->mark)) {
            $member_status->setMark(ilUtil::stripSlashes($this->mark));
        }
        if (isset($this->comment)) {
            $member_status->setComment(ilUtil::stripSlashes($this->comment));
        }
        if (isset($this->status)) {
            $member_status->setStatus(ilUtil::stripSlashes($this->status));
        }
        if (isset($this->notice)) {
            $member_status->setNotice(ilUtil::stripSlashes($this->notice));
        }
        $member_status->update();

        // reset variables
        $this->mark = null;
        $this->status = null;
        $this->notice = null;
        $this->comment = null;
    }

    public function getAssignment(): ilExAssignment
    {
        return $this->assignment;
    }

    protected function trimAndStripAttribs(array $attribs): array
    {
        $ret = [];
        foreach ($attribs as $k => $v) {
            $ret[$k] = $this->trimAndStrip((string) $v);
        }
        return $ret;
    }

    protected function trimAndStrip(string $input): string
    {
        return ilUtil::stripSlashes(trim($input));
    }
}