class.ilExerciseXMLParser.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2009 ILIAS open source, Extended GPL, see docs/LICENSE */

include_once 'Services/Tracking/classes/class.ilChangeEvent.php';
include_once 'Modules/Exercise/classes/class.ilExerciseXMLWriter.php';
include_once './Services/Xml/classes/class.ilSaxParser.php';

class ilExerciseXMLParser extends ilSaxParser
{

    static $CONTENT_NOT_COMPRESSED = 0;
    static $CONTENT_GZ_COMPRESSED = 1;
    static $CONTENT_ZLIB_COMPRESSED = 2;

    var $exercise;

    var $obj_id;


    var $result;

    var $mode;
    
    var $assignment;
    
    var $storage;

        function __construct($exercise, $a_xml_data, $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();
                }
                
                include_once ("./Modules/Exercise/classes/class.ilFSStorageExercise.php");
                $this->storage = new ilFSStorageExercise ( $this->exercise->getId(), $this->assignment->getId());
                $this->storage->create();
                $this->storage->init();
                
                $this->setXMLContent($a_xml_data);
                $this->obj_id = $obj_id;
                $this->result = false;
        }


        function setHandlers($a_xml_parser)
        {
                xml_set_object($a_xml_parser,$this);
                xml_set_element_handler($a_xml_parser,'handlerBeginTag','handlerEndTag');
                xml_set_character_data_handler($a_xml_parser,'handlerCharacterData');
        }

        function handlerBeginTag($a_xml_parser,$a_name,$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 && (int) $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 = 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;

                }
        }



        function handlerEndTag($a_xml_parser,$a_name)
        {
                switch($a_name)
                {
                        case 'Exercise':
                $this->result = true;
                                break;
                        case 'Title':
                            $this->exercise->setTitle(trim($this->cdata));
                            $this->assignment->setTitle(trim($this->cdata));
                                break;
                        case 'Description':
                            $this->exercise->setDescription(trim($this->cdata));
                                break;
                        case 'Instruction':
                                $this->assignment->setInstruction(trim($this->cdata));
                                break;
                        case 'DueDate':
                                $this->assignment->setDeadLine(trim($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 = trim($this->cdata);
                            break;
                        case 'Content':
                            $this->file_content = trim($this->cdata);
                            break;
                        case 'File':
                $this->updateFile($this->file_name, $this->file_content, $this->file_action);
                            break;
                        case 'Comment':
                             $this->comment = trim($this->cdata);
                             break;
                        case 'Notice':
                             $this->notice = trim($this->cdata);
                             break;
                        case 'Mark':
                             $this->mark = trim($this->cdata);
                             break;                          
                        case 'Marking':                    
                             // see Member end tag
                             break;                         
                }

                $this->cdata = '';

                return;
        }

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


        private function updateMember ($user_id, $action) {
       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);
       }
        }

        private function updateFile ($filename, $b64encodedContent, $action)
        {
       if (strlen($filename) == 0) {
           return;
       }
                 $filename= $this->storage->getAbsolutePath()."/".$filename;
                
            if ($action == "Attach")
        {
           $content = base64_decode((string) $b64encodedContent);
           if ($this->mode == ilExerciseXMLParser::$CONTENT_GZ_COMPRESSED) {
                $content = gzdecode($content);
               }elseif ($this->mode ==ilExerciseXMLParser::$CONTENT_ZLIB_COMPRESSED) {
                $content = gzuncompress($content);
               }
              
               //echo $filename;
               $this->storage->writeToFile($content, $filename);
           
        }
        if ($action == "Detach")
        {
            $this->storage->deleteFile($filename);
        }
        }

        public function start () {
            $this->startParsing();
            return $this->result > 0;
        }
        
        private function updateMarking($usr_id) {
                
                $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 () {
                return $this->assignment;
        }

}
?>