class.assImagemapQuestion.php

Go to the documentation of this file.

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

require_once './Modules/TestQuestionPool/classes/class.assQuestion.php';
require_once './Modules/Test/classes/inc.AssessmentConstants.php';
require_once './Modules/TestQuestionPool/interfaces/interface.ilObjQuestionScoringAdjustable.php';
require_once './Modules/TestQuestionPool/interfaces/interface.ilObjAnswerScoringAdjustable.php';

class assImagemapQuestion extends assQuestion //implements ilObjQuestionScoringAdjustable, ilObjAnswerScoringAdjustable
{
        const MODE_SINGLE_CHOICE   = 0;
        const MODE_MULTIPLE_CHOICE = 1;

        var $answers;

        var $image_filename;

        var $imagemap_contents;
        
        var $coords;

        protected $is_multiple_choice = false;

        public function __construct(
                $title = "",
                $comment = "",
                $author = "",
                $owner = -1,
                $question = "",
                $image_filename = ""
        )
        {
                parent::__construct($title, $comment, $author, $owner, $question);
                $this->image_filename = $image_filename;
                $this->answers = array();
                $this->coords = array();
        }

        public function setIsMultipleChoice($is_multiple_choice)
        {
                $this->is_multiple_choice = $is_multiple_choice;
        }

        public function getIsMultipleChoice()
        {
                return $this->is_multiple_choice;
        }

        function isComplete()
        {
                if (strlen($this->title) 
                        && ($this->author) 
                        && ($this->question) 
                        && ($this->image_filename) 
                        && (count($this->answers)) 
                        && ($this->getMaximumPoints() > 0)
                )
                {
                        return true;
                }
                return false;
        }

        public function saveToDb($original_id = "")
        {
                $this->saveQuestionDataToDb($original_id);
                $this->saveAdditionalQuestionDataToDb();
                $this->saveAnswerSpecificDataToDb();
                parent::saveToDb($original_id);
        }

        public function saveAnswerSpecificDataToDb()
        {
                global $ilDB;
                $ilDB->manipulateF( "DELETE FROM qpl_a_imagemap WHERE question_fi = %s",
                                                        array( "integer" ),
                                                        array( $this->getId() )
                );

                // Anworten wegschreiben
                foreach ($this->answers as $key => $value)
                {
                        $answer_obj   = $this->answers[$key];
                        $next_id      = $ilDB->nextId( 'qpl_a_imagemap' );
                        $ilDB->manipulateF( "INSERT INTO qpl_a_imagemap (answer_id, question_fi, answertext, points, aorder, coords, area, points_unchecked) VALUES (%s, %s, %s, %s, %s, %s, %s, %s)",
                                                                        array( "integer", "integer", "text", "float", "integer", "text", "text", "float" ),
                                                                        array( $next_id, $this->id, $answer_obj->getAnswertext(
                                                                        ), $answer_obj->getPoints(), $answer_obj->getOrder(
                                                                        ), $answer_obj->getCoords(), $answer_obj->getArea(
                                                                        ), $answer_obj->getPointsUnchecked() )
                        );
                }
        }

        public function saveAdditionalQuestionDataToDb()
        {
                global $ilDB;
                
                $ilDB->manipulateF( "DELETE FROM " . $this->getAdditionalTableName() . " WHERE question_fi = %s",
                                                        array( "integer" ),
                                                        array( $this->getId() )
                );
                
                $ilDB->manipulateF( "INSERT INTO " . $this->getAdditionalTableName(
                                                                                                                                                ) . " (question_fi, image_file, is_multiple_choice) VALUES (%s, %s, %s)",
                                                        array( "integer", "text", 'integer' ),
                                                        array(
                                                                $this->getId(),
                                                                $this->image_filename,
                                                                (int)$this->is_multiple_choice
                                                        )
                );
        }

        function duplicate($for_test = true, $title = "", $author = "", $owner = "", $testObjId = null)
        {
                if ($this->id <= 0)
                {
                        // The question has not been saved. It cannot be duplicated
                        return;
                }
                // duplicate the question in database
                $this_id = $this->getId();
                $thisObjId = $this->getObjId();
                
                $clone = $this;
                include_once ("./Modules/TestQuestionPool/classes/class.assQuestion.php");
                $original_id = assQuestion::_getOriginalId($this->id);
                $clone->id = -1;
                
                if( (int)$testObjId > 0 )
                {
                        $clone->setObjId($testObjId);
                }
                
                if ($title)
                {
                        $clone->setTitle($title);
                }
                if ($author)
                {
                        $clone->setAuthor($author);
                }
                if ($owner)
                {
                        $clone->setOwner($owner);
                }
                if ($for_test)
                {
                        $clone->saveToDb($original_id);
                }
                else
                {
                        $clone->saveToDb();
                }

                // copy question page content
                $clone->copyPageOfQuestion($this_id);
                // copy XHTML media objects
                $clone->copyXHTMLMediaObjectsOfQuestion($this_id);
                // duplicate the image
                $clone->duplicateImage($this_id, $thisObjId);
                
                $clone->onDuplicate($thisObjId, $this_id, $clone->getObjId(), $clone->getId());
                
                return $clone->id;
        }

        function copyObject($target_questionpool_id, $title = "")
        {
                if ($this->id <= 0)
                {
                        // The question has not been saved. It cannot be duplicated
                        return;
                }
                // duplicate the question in database
                $clone = $this;
                include_once ("./Modules/TestQuestionPool/classes/class.assQuestion.php");
                $original_id = assQuestion::_getOriginalId($this->id);
                $clone->id = -1;
                $source_questionpool_id = $this->getObjId();
                $clone->setObjId($target_questionpool_id);
                if ($title)
                {
                        $clone->setTitle($title);
                }
                $clone->saveToDb();

                // copy question page content
                $clone->copyPageOfQuestion($original_id);
                // copy XHTML media objects
                $clone->copyXHTMLMediaObjectsOfQuestion($original_id);
                // duplicate the image
                $clone->copyImage($original_id, $source_questionpool_id);
                
                $clone->onCopy($source_questionpool_id, $original_id, $clone->getObjId(), $clone->getId());
                
                return $clone->id;
        }

        public function createNewOriginalFromThisDuplicate($targetParentId, $targetQuestionTitle = "")
        {
                if ($this->id <= 0)
                {
                        // The question has not been saved. It cannot be duplicated
                        return;
                }

                include_once ("./Modules/TestQuestionPool/classes/class.assQuestion.php");

                $sourceQuestionId = $this->id;
                $sourceParentId = $this->getObjId();

                // duplicate the question in database
                $clone = $this;
                $clone->id = -1;

                $clone->setObjId($targetParentId);

                if ($targetQuestionTitle)
                {
                        $clone->setTitle($targetQuestionTitle);
                }

                $clone->saveToDb();
                // copy question page content
                $clone->copyPageOfQuestion($sourceQuestionId);
                // copy XHTML media objects
                $clone->copyXHTMLMediaObjectsOfQuestion($sourceQuestionId);
                // duplicate the image
                $clone->copyImage($sourceQuestionId, $sourceParentId);

                $clone->onCopy($sourceParentId, $sourceQuestionId, $clone->getObjId(), $clone->getId());

                return $clone->id;
        }

        function duplicateImage($question_id, $objectId = null)
        {
                $imagepath = $this->getImagePath();
                $imagepath_original = str_replace("/$this->id/images", "/$question_id/images", $imagepath);
                
                if( (int)$objectId > 0 )
                {
                        $imagepath_original = str_replace("/$this->obj_id/", "/$objectId/", $imagepath_original);
                }
                
                if (!file_exists($imagepath)) {
                        ilUtil::makeDirParents($imagepath);
                }
                $filename = $this->getImageFilename();
                if (!copy($imagepath_original . $filename, $imagepath . $filename)) {
                        print "image could not be duplicated!!!! ";
                }
        }

        function copyImage($question_id, $source_questionpool)
        {
                $imagepath = $this->getImagePath();
                $imagepath_original = str_replace("/$this->id/images", "/$question_id/images", $imagepath);
                $imagepath_original = str_replace("/$this->obj_id/", "/$source_questionpool/", $imagepath_original);
                if (!file_exists($imagepath)) 
                {
                        ilUtil::makeDirParents($imagepath);
                }
                $filename = $this->getImageFilename();
                if (!copy($imagepath_original . $filename, $imagepath . $filename)) 
                {
                        print "image could not be copied!!!! ";
                }
        }

        function loadFromDb($question_id)
        {
                global $ilDB;

                $result = $ilDB->queryF("SELECT qpl_questions.*, " . $this->getAdditionalTableName() . ".* FROM qpl_questions LEFT JOIN " . $this->getAdditionalTableName() . " ON " . $this->getAdditionalTableName() . ".question_fi = qpl_questions.question_id WHERE qpl_questions.question_id = %s",
                        array("integer"),
                        array($question_id)
                );
                if ($result->numRows() == 1)
                {
                        $data = $ilDB->fetchAssoc($result);
                        $this->setId($question_id);
                        $this->setObjId($data["obj_fi"]);
                        $this->setTitle($data["title"]);
                        $this->setComment($data["description"]);
                        $this->setOriginalId($data["original_id"]);
                        $this->setNrOfTries($data['nr_of_tries']);
                        $this->setAuthor($data["author"]);
                        $this->setPoints($data["points"]);
                        $this->setOwner($data["owner"]);
                        $this->setIsMultipleChoice($data["is_multiple_choice"] == self::MODE_MULTIPLE_CHOICE);
                        include_once("./Services/RTE/classes/class.ilRTE.php");
                        $this->setQuestion(ilRTE::_replaceMediaObjectImageSrc($data["question_text"], 1));
                        $this->setImageFilename($data["image_file"]);
                        $this->setEstimatedWorkingTime(substr($data["working_time"], 0, 2), substr($data["working_time"], 3, 2), substr($data["working_time"], 6, 2));
                        
                        try
                        {
                                $this->setAdditionalContentEditingMode($data['add_cont_edit_mode']);
                        }
                        catch(ilTestQuestionPoolException $e)
                        {
                        }

                        $result = $ilDB->queryF("SELECT * FROM qpl_a_imagemap WHERE question_fi = %s ORDER BY aorder ASC",
                                array("integer"),
                                array($question_id)
                        );
                        include_once "./Modules/TestQuestionPool/classes/class.assAnswerImagemap.php";
                        if ($result->numRows() > 0)
                        {
                                while ($data = $ilDB->fetchAssoc($result)) 
                                {
                                        array_push($this->answers, new ASS_AnswerImagemap($data["answertext"], $data["points"], $data["aorder"], $data["coords"], $data["area"], $data['question_fi'], $data['points_unchecked']));
                                }
                        }
                }
                parent::loadFromDb($question_id);
        }

        function uploadImagemap($imagemap_filename = "") 
        {
                $added = 0;
                if (!empty($imagemap_filename)) 
                {
                        $fp = fopen($imagemap_filename, "r");
                        $contents = fread($fp, filesize($imagemap_filename));
                        fclose($fp);
                        if (preg_match_all("/<area(.+)>/siU", $contents, $matches)) 
                        {
                                for ($i=0; $i< count($matches[1]); $i++) 
                                {
                                        preg_match("/alt\s*=\s*\"(.+)\"\s*/siU", $matches[1][$i], $alt);
                                        preg_match("/coords\s*=\s*\"(.+)\"\s*/siU", $matches[1][$i], $coords);
                                        preg_match("/shape\s*=\s*\"(.+)\"\s*/siU", $matches[1][$i], $shape);
                                        $this->addAnswer($alt[1], 0.0, count($this->answers), $coords[1], $shape[1]);
                                        $added++;
                                }
                        }
                }
                return $added;
        }

        function getImageFilename()
        {
                return $this->image_filename;
        }

        function setImageFilename($image_filename, $image_tempfilename = "") 
        {
                if (!empty($image_filename)) 
                {
                        $image_filename = str_replace(" ", "_", $image_filename);
                        $this->image_filename = $image_filename;
                }
                if (!empty($image_tempfilename)) 
                {
                        $imagepath = $this->getImagePath();
                        if (!file_exists($imagepath)) 
                        {
                                ilUtil::makeDirParents($imagepath);
                        }
                        if (!ilUtil::moveUploadedFile($image_tempfilename, $image_filename, $imagepath.$image_filename))
                        {
                                $this->ilias->raiseError("The image could not be uploaded!", $this->ilias->error_obj->MESSAGE);
                        }
                        global $ilLog; $ilLog->write("gespeichert: " . $imagepath.$image_filename);
                }
  }

        function get_imagemap_contents($href = "#") {
                $imagemap_contents = "<map name=\"".$this->title."\"> ";
                for ($i = 0; $i < count($this->answers); $i++) {
                        $imagemap_contents .= "<area alt=\"".$this->answers[$i]->getAnswertext()."\" ";
                        $imagemap_contents .= "shape=\"".$this->answers[$i]->getArea()."\" ";
                        $imagemap_contents .= "coords=\"".$this->answers[$i]->getCoords()."\" ";
                        $imagemap_contents .= "href=\"$href&selimage=" . $this->answers[$i]->getOrder() . "\" /> ";
                }
                $imagemap_contents .= "</map>";
                return $imagemap_contents;
        }

        function addAnswer(
                $answertext = "",
                $points = 0.0,
                $order = 0,
                $coords="",
                $area="",
                $points_unchecked = 0.0
        )
        {
                include_once "./Modules/TestQuestionPool/classes/class.assAnswerImagemap.php";
                if (array_key_exists($order, $this->answers)) 
                {
                        // Insert answer
                        $answer = new ASS_AnswerImagemap($answertext, $points, $order, $coords, $area, -1, $points_unchecked);
                        for ($i = count($this->answers) - 1; $i >= $order; $i--) 
                        {
                                $this->answers[$i+1] = $this->answers[$i];
                                $this->answers[$i+1]->setOrder($i+1);
                        }
                        $this->answers[$order] = $answer;
                }
                else 
                {
                        // Append answer
                        $answer = new ASS_AnswerImagemap($answertext, $points, count($this->answers), $coords, $area, -1, $points_unchecked);
                        array_push($this->answers, $answer);
                }
        }

        function getAnswerCount() {
                return count($this->answers);
        }

        function getAnswer($index = 0) {
                if ($index < 0) return NULL;
                if (count($this->answers) < 1) return NULL;
                if ($index >= count($this->answers)) return NULL;
                return $this->answers[$index];
        }

        function &getAnswers() 
        {
                return $this->answers;
        }

        function deleteArea($index = 0) 
        {
                if ($index < 0) return;
                if (count($this->answers) < 1) return;
                if ($index >= count($this->answers)) return;
                unset($this->answers[$index]);
                $this->answers = array_values($this->answers);
                for ($i = 0; $i < count($this->answers); $i++) {
                        if ($this->answers[$i]->getOrder() > $index) {
                                $this->answers[$i]->setOrder($i);
                        }
                }
        }

        function flushAnswers() {
                $this->answers = array();
        }

  function getMaximumPoints() {
                $points = 0;
                foreach ($this->answers as $key => $value) {
                        if($this->is_multiple_choice)
                        {
                                if($value->getPoints() > $value->getPointsUnchecked())
                                {
                                        $points += $value->getPoints();
                                }
                                else
                                {
                                        $points += $value->getPointsUnchecked();
                                }
                        }
                        else
                        {
                                if($value->getPoints() > $points)
                                {
                                        $points = $value->getPoints();
                                }
                        }
                }
                return $points;
  }

        public function calculateReachedPoints($active_id, $pass = NULL, $returndetails = FALSE)
        {
                if( $returndetails )
                {
                        throw new ilTestException('return details not implemented for '.__METHOD__);
                }
                
                global $ilDB;
                
                $found_values = array();
                if (is_null($pass))
                {
                        $pass = $this->getSolutionMaxPass($active_id);
                }
                $result = $ilDB->queryF("SELECT * FROM tst_solutions WHERE active_fi = %s AND question_fi = %s AND pass = %s",
                        array("integer","integer","integer"),
                        array($active_id, $this->getId(), $pass)
                );
                while ($data = $ilDB->fetchAssoc($result))
                {
                        if (strcmp($data["value1"], "") != 0)
                        {
                                array_push($found_values, $data["value1"]);
                        }
                }
                $points = 0;
                if (count($found_values) > 0)
                {
                        foreach ($this->answers as $key => $answer)
                        {
                                if (in_array($key, $found_values))
                                {
                                        $points += $answer->getPoints();
                                }
                                elseif( $this->getIsMultipleChoice() )
                                {
                                        $points += $answer->getPointsUnchecked();
                                }
                        }
                }

                return $points;
        }

        public function saveWorkingData($active_id, $pass = NULL)
        {
                global $ilDB;
                global $ilUser;

                if (is_null($pass))
                {
                        include_once "./Modules/Test/classes/class.ilObjTest.php";
                        $pass = ilObjTest::_getPass($active_id);
                }

                $this->getProcessLocker()->requestUserSolutionUpdateLock();

                if($this->is_multiple_choice && strlen($_GET['remImage']))
                {
                        $affectedRows = $ilDB->manipulateF("DELETE FROM tst_solutions WHERE active_fi = %s AND question_fi = %s AND pass = %s AND value1 = %s",
                                array("integer", "integer", "integer", "integer"),
                                array($active_id, $this->getId(), $pass, $_GET['remImage'])
                        );
                }
                elseif(!$this->is_multiple_choice)
                {
                        $affectedRows = $ilDB->manipulateF("DELETE FROM tst_solutions WHERE active_fi = %s AND question_fi = %s AND pass = %s",
                                array("integer", "integer", "integer"),
                                array($active_id, $this->getId(), $pass)
                        );
                }

                if (strlen($_GET["selImage"]))
                {
                        $imageWasSelected = true;
                        
                        $types = array('integer', 'integer', 'integer', 'integer');
                        $values = array($active_id, $this->getId(), $pass,  (int)$_GET['selImage']);
                        $query = 'DELETE FROM tst_solutions WHERE active_fi = %s AND question_fi = %s AND pass = %s AND value1 = %s';
                        
                        $ilDB->manipulateF($query, $types, $values);
                        
                        $next_id = $ilDB->nextId('tst_solutions');
                        $affectedRows = $ilDB->insert("tst_solutions", array(
                                "solution_id" => array("integer", $next_id),
                                "active_fi" => array("integer", $active_id),
                                "question_fi" => array("integer", $this->getId()),
                                "value1" => array("clob", $_GET['selImage']),
                                "value2" => array("clob", null),
                                "pass" => array("integer", $pass),
                                "tstamp" => array("integer", time())
                        ));
                }
                else
                {
                        $imageWasSelected = false;
                }

                $this->getProcessLocker()->releaseUserSolutionUpdateLock();

                require_once 'Modules/Test/classes/class.ilObjAssessmentFolder.php';
                if( ilObjAssessmentFolder::_enabledAssessmentLogging() )
                {
                        if( $imageWasSelected )
                        {
                                $this->logAction($this->lng->txtlng("assessment", "log_user_entered_values", ilObjAssessmentFolder::_getLogLanguage()), $active_id, $this->getId());
                        }
                        else
                        {
                                $this->logAction($this->lng->txtlng("assessment", "log_user_not_entered_values", ilObjAssessmentFolder::_getLogLanguage()), $active_id, $this->getId());
                        }
                }

                return true;
        }

        protected function reworkWorkingData($active_id, $pass, $obligationsAnswered)
        {
                // nothing to rework!
        }

        function syncWithOriginal()
        {
                if ($this->getOriginalId())
                {
                        parent::syncWithOriginal();
                }
        }

        function getQuestionType()
        {
                return "assImagemapQuestion";
        }

        function getAdditionalTableName()
        {
                return "qpl_qst_imagemap";
        }

        function getAnswerTableName()
        {
                return "qpl_a_imagemap";
        }

        function getRTETextWithMediaObjects()
        {
                $text = parent::getRTETextWithMediaObjects();
                foreach ($this->answers as $index => $answer)
                {
                        $text .= $this->feedbackOBJ->getSpecificAnswerFeedbackContent($this->getId(), $index);
                }
                return $text;
        }

        public function setExportDetailsXLS(&$worksheet, $startrow, $active_id, $pass, &$format_title, &$format_bold)
        {
                include_once ("./Services/Excel/classes/class.ilExcelUtils.php");
                $solution = $this->getSolutionValues($active_id, $pass);
                $worksheet->writeString($startrow, 0, ilExcelUtils::_convert_text($this->lng->txt($this->getQuestionType())), $format_title);
                $worksheet->writeString($startrow, 1, ilExcelUtils::_convert_text($this->getTitle()), $format_title);
                $i = 1;
                foreach ($this->getAnswers() as $id => $answer)
                {
                        $worksheet->writeString($startrow + $i, 0, ilExcelUtils::_convert_text($answer->getArea() . ": " . $answer->getCoords()), $format_bold);
                        if ($id == $solution[0]["value1"])
                        {
                                $worksheet->write($startrow + $i, 1, 1);
                        }
                        else
                        {
                                $worksheet->write($startrow + $i, 1, 0);
                        }
                        $i++;
                }
                return $startrow + $i + 1;
        }

        public function deleteImage()
        {
                $file = $this->getImagePath() . $this->getImageFilename();
                @unlink($file);
                $this->flushAnswers();
                $this->image_filename = "";
        }

        public function toJSON()
        {
                include_once("./Services/RTE/classes/class.ilRTE.php");
                $result = array();
                $result['id'] = (int) $this->getId();
                $result['type'] = (string) $this->getQuestionType();
                $result['title'] = (string) $this->getTitle();
                $result['question'] =  $this->formatSAQuestion($this->getQuestion());
                $result['nr_of_tries'] = (int) $this->getNrOfTries();
                $result['shuffle'] = (bool) $this->getShuffle();
                $result['is_multiple'] = (bool) $this->getIsMultipleChoice();
                $result['feedback'] = array(
                        "onenotcorrect" => $this->feedbackOBJ->getGenericFeedbackTestPresentation($this->getId(), false),
                        "allcorrect" => $this->feedbackOBJ->getGenericFeedbackTestPresentation($this->getId(), true)
                );
                $result['image'] = (string) $this->getImagePathWeb() . $this->getImageFilename();
                
                $answers = array();
                $order = 0;
                foreach ($this->getAnswers() as $key => $answer_obj)
                {
                        array_push($answers, array(
                                "answertext"       => (string)$answer_obj->getAnswertext(),
                                "points"           => (float)$answer_obj->getPoints(),
                                "points_unchecked" => (float)$answer_obj->getPointsUnchecked(),
                                "order"            => (int)$order,
                                "coords"           => $answer_obj->getCoords(),
                                "state"            => $answer_obj->getState(),
                                "area"             => $answer_obj->getArea(),
                                "feedback"         => ilRTE::_replaceMediaObjectImageSrc(
                                        $this->feedbackOBJ->getSpecificAnswerFeedbackExportPresentation($this->getId(), $key), 0
                                )
                        ));
                        $order++;
                }
                $result['answers'] = $answers;

                $mobs = ilObjMediaObject::_getMobsOfObject("qpl:html", $this->getId());
                $result['mobs'] = $mobs;
                
                return json_encode($result);
        }
}