class.ilExerciseXMLWriter.php

Go to the documentation of this file.

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

include_once "./Services/Xml/classes/class.ilXmlWriter.php";
include_once "./Modules/Exercise/classes/class.ilExAssignment.php";

class ilExerciseXMLWriter extends ilXmlWriter {
        
        static $CONTENT_ATTACH_NO = 0;
        static $CONTENT_ATTACH_ENCODED = 1;
        static $CONTENT_ATTACH_ZLIB_ENCODED = 2;
        static $CONTENT_ATTACH_GZIP_ENCODED = 3;
        
        static $STATUS_NOT_GRADED = "NOT_GRADED";
        static $STATUS_PASSED = "PASSED";
        static $STATUS_FAILED = "FAILED";
        var $attachFileContents;
        
        var $attachMembers;
        
        var $exercise;
        
        function ilExerciseXMLWriter() {
                // @todo: needs to be revised for multiple assignments per exercise
                //die ("Needs revision for ILIAS 4.1");
                parent::ilXmlWriter ();
                $this->attachFileContents = ilExerciseXMLWriter::$CONTENT_ATTACH_NO;
        }
        
        function setExercise(&  $exercise) {
                $this->exercise = & $exercise;
        }
        
        function setAttachFileContents($attachFileContents) {
                if ($attachFileContents == ilExerciseXMLWriter::$CONTENT_ATTACH_GZIP_ENCODED && ! function_exists ( "gzencode" )) {
                        throw new ilExerciseException ( "Inflating with gzip is not supported", ilExerciseException::$ID_DEFLATE_METHOD_MISMATCH );
                }
                if ($attachFileContents == ilExerciseXMLWriter::$CONTENT_ATTACH_ZLIB_ENCODED && ! function_exists ( "gzcompress" )) {
                        throw new ilExerciseException ( "Inflating with zlib (compress/uncompress) is not supported", ilExerciseException::$ID_DEFLATE_METHOD_MISMATCH );
                }
                
                $this->attachFileContents = $attachFileContents;
        }
        
        function start() {
                $this->__buildHeader ();
                
                $attribs = array ("obj_id" => "il_" . IL_INST_ID . "_exc_" . $this->exercise->getId () );
                
                if ($this->exercise->getOwner ())
                        $attribs ["owner"] = "il_" . IL_INST_ID . "_usr_" . $this->exercise->getOwner ();
                
                $this->xmlStartTag ( "Exercise", $attribs );
                
                //todo: create new dtd for new assignment structure
                //$this->xmlElement("Title", null,$this->exercise->getTitle());
                //$this->xmlElement("Description",  null,$this->exercise->getDescription());
                //$this->xmlElement("Instruction",  null,$this->exercise->getInstruction());
                //$this->xmlElement("DueDate",  null,$this->exercise->getTimestamp());
                

                //todo: as a workaround use first assignment for compatibility with old exercise dtd
                $assignments = ilExAssignment::getAssignmentDataOfExercise ( $this->exercise->getId () );
                
                if (count ( $assignments ) > 0) {
                        foreach ( $assignments as $assignment ) {
                                $this->xmlElement ( "Title", null, $this->exercise->getTitle ());
                                $this->xmlElement ( "Description", null, $this->exercise->getDescription () );
                                $this->xmlElement ( "Instruction", null, $assignment ["instruction"] );
                                $this->xmlElement ( "DueDate", null, $assignment ["deadline"] );
                                
                                $this->handleAssignmentFiles ( $this->exercise->getId (), $assignment ["id"] );
                                //todo: we handle only the first one for workaround, remove later for new dtd
                                break;
                        }
                } else {
                        $this->xmlElement ( "Title", null, $this->exercise->getTitle () );
                        $this->xmlElement ( "Description", null, $this->exercise->getDescription () );
                }
                
                if ($this->attachMembers) {                                     
                        $this->handleAssignmentMembers ($this->exercise->getId (), $assignments);
                }
                
                $this->xmlEndTag ( "Exercise" );
                $this->__buildFooter ();
                
                return true;
        }
        
        function getXML() {
                return $this->xmlDumpMem ( FALSE );
        }
        
        function __buildHeader() {
                $this->xmlSetDtdDef ( "<!DOCTYPE Exercise PUBLIC \"-//ILIAS//DTD ExerciseAdministration//EN\" \"" . ILIAS_HTTP_PATH . "/xml/ilias_exercise_3_10.dtd\">" );
                $this->xmlSetGenCmt ( "Exercise Object" );
                $this->xmlHeader ();
                
                return true;
        }
        
        function __buildFooter() {
        
        }
        
        public function setAttachMembers($value) {
                $this->attachMembers = $value ? true : false;
        }
        
        private function attachMarking($user_id, $assignment_id) {
                
                $amark = ilExAssignment::lookupMarkOfUser($assignment_id, $user_id);
                $astatus = ilExAssignment::lookupStatusOfUser($assignment_id, $user_id);
                $acomment = ilExAssignment::lookupCommentForUser($assignment_id, $user_id);
                $anotice = ilExAssignment::lookupNoticeOfUser($assignment_id, $user_id);
                
                
                if ($astatus == "notgraded") {
                        $status = ilExerciseXMLWriter::$STATUS_NOT_GRADED;
                } elseif ($astatus == "failed") {
                        $status = ilExerciseXMLWriter::$STATUS_FAILED;
                } else {
                        $status = ilExerciseXMLWriter::$STATUS_PASSED;
                }
                
                $this->xmlStartTag ( "Marking", array ("status" => $status ) );
                $this->xmlElement ( "Mark", null, $amark);
                $this->xmlElement ( "Notice", null, $anotice );
                $this->xmlElement ( "Comment", null, $acomment );
                $this->xmlEndTag ( "Marking" );
        }
        
        private function handleAssignmentFiles($ex_id, $as_id) {
                $this->xmlStartTag ( "Files" );
                include_once ("./Modules/Exercise/classes/class.ilFSStorageExercise.php");
                $storage = new ilFSStorageExercise ( $ex_id, $as_id );
                $files = $storage->getFiles ();
                
                if (count ( $files )) {
                        foreach ( $files as $file ) {
                                $this->xmlStartTag ( "File", array ("size" => $file ["size"] ) );
                                $this->xmlElement ( "Filename", null, $file ["name"] );
                                if ($this->attachFileContents) {
                                        $filename = $file ["fullpath"];
                                        if (@is_file ( $filename )) {
                                                $content = @file_get_contents ( $filename );
                                                $attribs = array ("mode" => "PLAIN" );
                                                if ($this->attachFileContents == ilExerciseXMLWriter::$CONTENT_ATTACH_ZLIB_ENCODED) {
                                                        $attribs = array ("mode" => "ZLIB" );
                                                        $content = gzcompress ( $content, 9 );
                                                } elseif ($this->attachFileContents == ilExerciseXMLWriter::$CONTENT_ATTACH_GZIP_ENCODED) {
                                                        $attribs = array ("mode" => "GZIP" );
                                                        $content = gzencode ( $content, 9 );
                                                }
                                                $content = base64_encode ( $content );
                                                $this->xmlElement ( "Content", $attribs, $content );
                                        }
                                }
                                $this->xmlEndTag ( "File" );
                        }
                }
                $this->xmlEndTag ( "Files" );
        }
        
        private function handleAssignmentMembers($ex_id, $assignments) {
                $this->xmlStartTag ( "Members" );
                include_once ("./Modules/Exercise/classes/class.ilExerciseMembers.php");
                $members = ilExerciseMembers::_getMembers($ex_id);
                if (count ( $members )) {
                        foreach ( $members as $member_id ) {
                                $this->xmlStartTag ( "Member", array ("usr_id" => "il_" . IL_INST_ID . "_usr_" . $member_id  ) );
                                if (count ($assignments) > 0) {
                                        foreach($assignments as $assignment) {
                                                $this->attachMarking ( $member_id, $assignment["id"] );         
                                                //todo: handle only first assignment, must be fixed when for dtd
                                                break;
                                        }
                                }                               
                                $this->xmlEndTag ( "Member" );
                        }
                }
                $this->xmlEndTag ( "Members" );
        }
}

?>