class.assClozeTest.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/classes/class.assClozeGapCombination.php';
require_once './Modules/TestQuestionPool/interfaces/interface.ilObjQuestionScoringAdjustable.php';
require_once './Modules/TestQuestionPool/interfaces/interface.ilObjAnswerScoringAdjustable.php';
require_once './Modules/TestQuestionPool/interfaces/interface.iQuestionCondition.php';
require_once './Modules/TestQuestionPool/classes/class.ilUserQuestionResult.php';

class assClozeTest extends assQuestion implements ilObjQuestionScoringAdjustable, ilObjAnswerScoringAdjustable, iQuestionCondition
{
    public $gaps;

    public $gap_combinations;


    public $gap_combinations_exists;
    
    public $start_tag;

    public $end_tag;
    
    public $textgap_rating;

    public $identical_scoring;

    public $fixedTextLength;

    public $cloze_text;

    public function __construct(
        $title = "",
        $comment = "",
        $author = "",
        $owner = -1,
        $question = ""
    ) {
        parent::__construct($title, $comment, $author, $owner, $question);
        $this->start_tag = "[gap]";
        $this->end_tag = "[/gap]";
        $this->gaps = array();
        $this->setQuestion($question); // @TODO: Should this be $question?? See setter for why this is not trivial.
        $this->fixedTextLength = "";
        $this->identical_scoring = 1;
        $this->gap_combinations_exists = false;
        $this->gap_combinations = array();
    }

    public function isComplete()
    {
        if (strlen($this->getTitle())
            && $this->getAuthor()
            && $this->getClozeText()
            && count($this->getGaps())
            && $this->getMaximumPoints() > 0) {
            return true;
        }
        return false;
    }

    public function cleanQuestiontext($text)
    {
        $text = preg_replace("/\[gap[^\]]*?\]/", "[gap]", $text);
        $text = preg_replace("/<gap([^>]*?)>/", "[gap]", $text);
        $text = str_replace("</gap>", "[/gap]", $text);
        return $text;
    }

    public 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->setNrOfTries($data['nr_of_tries']);
            $this->setObjId($data["obj_fi"]);
            $this->setTitle($data["title"]);
            $this->setComment($data["description"]);
            $this->setOriginalId($data["original_id"]);
            $this->setAuthor($data["author"]);
            $this->setPoints($data["points"]);
            $this->setOwner($data["owner"]);
            $this->setQuestion($this->cleanQuestiontext($data["question_text"]));
            $this->setClozeText($data['cloze_text']);
            $this->setFixedTextLength($data["fixed_textlen"]);
            $this->setIdenticalScoring(($data['tstamp'] == 0) ? true : $data["identical_scoring"]);
            // replacement of old syntax with new syntax
            include_once("./Services/RTE/classes/class.ilRTE.php");
            $this->question = ilRTE::_replaceMediaObjectImageSrc($this->question, 1);
            $this->cloze_text = ilRTE::_replaceMediaObjectImageSrc($this->cloze_text, 1);
            $this->setTextgapRating($data["textgap_rating"]);
            $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) {
            }

            // open the cloze gaps with all answers
            include_once "./Modules/TestQuestionPool/classes/class.assAnswerCloze.php";
            include_once "./Modules/TestQuestionPool/classes/class.assClozeGap.php";
            $result = $ilDB->queryF(
                "SELECT * FROM qpl_a_cloze WHERE question_fi = %s ORDER BY gap_id, aorder ASC",
                array("integer"),
                array($question_id)
            );
            if ($result->numRows() > 0) {
                $this->gaps = array();
                while ($data = $ilDB->fetchAssoc($result)) {
                    switch ($data["cloze_type"]) {
                        case CLOZE_TEXT:
                            if (!array_key_exists($data["gap_id"], $this->gaps)) {
                                $this->gaps[$data["gap_id"]] = new assClozeGap(CLOZE_TEXT);
                            }
                            $answer = new assAnswerCloze(
                                $data["answertext"],
                                $data["points"],
                                $data["aorder"]
                            );
                            $this->gaps[$data["gap_id"]]->setGapSize($data['gap_size']);
                            
                            $this->gaps[$data["gap_id"]]->addItem($answer);
                            break;
                        case CLOZE_SELECT:
                            if (!array_key_exists($data["gap_id"], $this->gaps)) {
                                $this->gaps[$data["gap_id"]] = new assClozeGap(CLOZE_SELECT);
                                $this->gaps[$data["gap_id"]]->setShuffle($data["shuffle"]);
                            }
                            $answer = new assAnswerCloze(
                                $data["answertext"],
                                $data["points"],
                                $data["aorder"]
                            );
                            $this->gaps[$data["gap_id"]]->addItem($answer);
                            break;
                        case CLOZE_NUMERIC:
                            if (!array_key_exists($data["gap_id"], $this->gaps)) {
                                $this->gaps[$data["gap_id"]] = new assClozeGap(CLOZE_NUMERIC);
                            }
                            $answer = new assAnswerCloze(
                                $data["answertext"],
                                $data["points"],
                                $data["aorder"]
                            );
                            $this->gaps[$data["gap_id"]]->setGapSize($data['gap_size']);
                            $answer->setLowerBound($data["lowerlimit"]);
                            $answer->setUpperBound($data["upperlimit"]);
                            $this->gaps[$data["gap_id"]]->addItem($answer);
                            break;
                    }
                }
            }
        }
        $assClozeGapCombinationObj = new assClozeGapCombination();
        $check_for_gap_combinations = $assClozeGapCombinationObj->loadFromDb($question_id);
        if (count($check_for_gap_combinations) != 0) {
            $this->setGapCombinationsExists(true);
            $this->setGapCombinations($check_for_gap_combinations);
        }
        parent::loadFromDb($question_id);
    }

    #region Save question to db
    
    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_cloze WHERE question_fi = %s",
            array( "integer" ),
            array( $this->getId() )
        );

        foreach ($this->gaps as $key => $gap) {
            $this->saveClozeGapItemsToDb($gap, $key);
        }
    }

    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, textgap_rating, identical_scoring, fixed_textlen, cloze_text) VALUES (%s, %s, %s, %s, %s)",
            array(
                                "integer",
                                "text",
                                "text",
                                "integer",
                                "text"
                            ),
            array(
                                $this->getId(),
                                $this->getTextgapRating(),
                                $this->getIdenticalScoring(),
                                $this->getFixedTextLength() ? $this->getFixedTextLength() : null,
                                ilRTE::_replaceMediaObjectImageSrc($this->getClozeText(), 0)
                            )
        );
    }

    protected function saveClozeGapItemsToDb($gap, $key)
    {
        global $ilDB;
        foreach ($gap->getItems($this->getShuffler()) as $item) {
            $query   = "";
            $next_id = $ilDB->nextId('qpl_a_cloze');
            switch ($gap->getType()) {
                case CLOZE_TEXT:
                    $this->saveClozeTextGapRecordToDb($next_id, $key, $item, $gap);
                    break;
                case CLOZE_SELECT:
                    $this->saveClozeSelectGapRecordToDb($next_id, $key, $item, $gap);
                    break;
                case CLOZE_NUMERIC:
                    $this->saveClozeNumericGapRecordToDb($next_id, $key, $item, $gap);
                    break;
            }
        }
    }

    protected function saveClozeTextGapRecordToDb($next_id, $key, $item, $gap)
    {
        global $ilDB;
        $ilDB->manipulateF(
            "INSERT INTO qpl_a_cloze (answer_id, question_fi, gap_id, answertext, points, aorder, cloze_type, gap_size) VALUES (%s, %s, %s, %s, %s, %s, %s, %s)",
            array(
                                "integer",
                                "integer",
                                "integer",
                                "text",
                                "float",
                                "integer",
                                "text",
                                "integer"
                            ),
            array(
                                $next_id,
                                $this->getId(),
                                $key,
                                strlen($item->getAnswertext()) ? $item->getAnswertext() : "",
                                $item->getPoints(),
                                $item->getOrder(),
                                $gap->getType(),
                                (int) $gap->getGapSize()
                            )
        );
    }

    protected function saveClozeSelectGapRecordToDb($next_id, $key, $item, $gap)
    {
        global $ilDB;
        $ilDB->manipulateF(
            "INSERT INTO qpl_a_cloze (answer_id, question_fi, gap_id, answertext, points, aorder, cloze_type, shuffle) VALUES (%s, %s, %s, %s, %s, %s, %s, %s)",
            array(
                                "integer",
                                "integer",
                                "integer",
                                "text",
                                "float",
                                "integer",
                                "text",
                                "text"
                            ),
            array(
                                $next_id,
                                $this->getId(),
                                $key,
                                strlen($item->getAnswertext()) ? $item->getAnswertext() : "",
                                $item->getPoints(),
                                $item->getOrder(),
                                $gap->getType(),
                                ($gap->getShuffle()) ? "1" : "0"
                            )
        );
    }

    protected function saveClozeNumericGapRecordToDb($next_id, $key, $item, $gap)
    {
        global $ilDB;
        
        include_once "./Services/Math/classes/class.EvalMath.php";
        $eval = new EvalMath();
        $eval->suppress_errors = true;
        $ilDB->manipulateF(
            "INSERT INTO qpl_a_cloze (answer_id, question_fi, gap_id, answertext, points, aorder, cloze_type, lowerlimit, upperlimit, gap_size) VALUES (%s, %s, %s, %s, %s, %s, %s, %s, %s, %s)",
            array(
                                "integer",
                                "integer",
                                "integer",
                                "text",
                                "float",
                                "integer",
                                "text",
                                "text",
                                "text",
                                "integer"
                            ),
            array(
                                $next_id,
                                $this->getId(),
                                $key,
                                strlen($item->getAnswertext()) ? $item->getAnswertext() : "",
                                $item->getPoints(),
                                $item->getOrder(),
                                $gap->getType(),
                                ($eval->e($item->getLowerBound() !== false) && strlen(
                                    $item->getLowerBound()
                                ) > 0) ? $item->getLowerBound() : $item->getAnswertext(),
                                ($eval->e($item->getUpperBound() !== false) && strlen(
                                    $item->getUpperBound()
                                ) > 0) ? $item->getUpperBound() : $item->getAnswertext(),
                                (int) $gap->getGapSize()
                            )
        );
    }



    #endregion Save question to db

    public function getGaps()
    {
        return $this->gaps;
    }


    public function flushGaps()
    {
        $this->gaps = array();
    }

    public function setClozeText($cloze_text = "")
    {
        $this->gaps = array();
        $cloze_text = $this->cleanQuestiontext($cloze_text);
        $this->cloze_text = $cloze_text;
        $this->createGapsFromQuestiontext();
    }

    public function setClozeTextValue($cloze_text = "")
    {
        $this->cloze_text = $cloze_text;
    }
    
    public function getClozeText()
    {
        return $this->cloze_text;
    }

    public function getStartTag()
    {
        return $this->start_tag;
    }

    public function setStartTag($start_tag = "[gap]")
    {
        $this->start_tag = $start_tag;
    }
    
    public function getEndTag()
    {
        return $this->end_tag;
    }

    public function setEndTag($end_tag = "[/gap]")
    {
        $this->end_tag = $end_tag;
    }

    public function createGapsFromQuestiontext()
    {
        include_once "./Modules/TestQuestionPool/classes/class.assClozeGap.php";
        include_once "./Modules/TestQuestionPool/classes/class.assAnswerCloze.php";
        $search_pattern = "|\[gap\](.*?)\[/gap\]|i";
        preg_match_all($search_pattern, $this->getClozeText(), $found);
        $this->gaps = array();
        if (count($found[0])) {
            foreach ($found[1] as $gap_index => $answers) {
                // create text gaps by default
                $gap = new assClozeGap(CLOZE_TEXT);
                $textparams = preg_split("/(?<!\\\\),/", $answers);
                foreach ($textparams as $key => $value) {
                    $answer = new assAnswerCloze($value, 0, $key);
                    $gap->addItem($answer);
                }
                $this->gaps[$gap_index] = $gap;
            }
        }
    }
    
    public function setGapType($gap_index, $gap_type)
    {
        if (array_key_exists($gap_index, $this->gaps)) {
            $this->gaps[$gap_index]->setType($gap_type);
        }
    }

    public function setGapShuffle($gap_index = 0, $shuffle = 1)
    {
        if (array_key_exists($gap_index, $this->gaps)) {
            $this->gaps[$gap_index]->setShuffle($shuffle);
        }
    }

    public function clearGapAnswers()
    {
        foreach ($this->gaps as $gap_index => $gap) {
            $this->gaps[$gap_index]->clearItems();
        }
    }

    public function getGapCount()
    {
        if (is_array($this->gaps)) {
            return count($this->gaps);
        } else {
            return 0;
        }
    }

    public function addGapAnswer($gap_index, $order, $answer)
    {
        if (array_key_exists($gap_index, $this->gaps)) {
            if ($this->gaps[$gap_index]->getType() == CLOZE_NUMERIC) {
                // only allow notation with "." for real numbers
                $answer = str_replace(",", ".", $answer);
            }
            $this->gaps[$gap_index]->addItem(new assAnswerCloze($answer, 0, $order));
        }
    }
    
    public function getGap($gap_index = 0)
    {
        if (array_key_exists($gap_index, $this->gaps)) {
            return $this->gaps[$gap_index];
        } else {
            return null;
        }
    }

    public function setGapSize($gap_index, $order, $size)
    {
        if (array_key_exists($gap_index, $this->gaps)) {
            $this->gaps[$gap_index]->setGapSize($size);
        }
    }
    
    public function setGapAnswerPoints($gap_index, $order, $points)
    {
        if (array_key_exists($gap_index, $this->gaps)) {
            $this->gaps[$gap_index]->setItemPoints($order, $points);
        }
    }

    public function addGapText($gap_index)
    {
        if (array_key_exists($gap_index, $this->gaps)) {
            include_once "./Modules/TestQuestionPool/classes/class.assAnswerCloze.php";
            $answer = new assAnswerCloze(
                "",
                0,
                $this->gaps[$gap_index]->getItemCount()
            );
            $this->gaps[$gap_index]->addItem($answer);
        }
    }
    
    public function addGapAtIndex($gap, $index)
    {
        $this->gaps[$index] = $gap;
    }

    public function setGapAnswerLowerBound($gap_index, $order, $bound)
    {
        if (array_key_exists($gap_index, $this->gaps)) {
            $this->gaps[$gap_index]->setItemLowerBound($order, $bound);
        }
    }

    public function setGapAnswerUpperBound($gap_index, $order, $bound)
    {
        if (array_key_exists($gap_index, $this->gaps)) {
            $this->gaps[$gap_index]->setItemUpperBound($order, $bound);
        }
    }

    public function getMaximumPoints()
    {
        $assClozeGapCombinationObj = new assClozeGapCombination();
        $points = 0;
        $gaps_used_in_combination = array();
        if ($assClozeGapCombinationObj->combinationExistsForQid($this->getId())) {
            $points =  $assClozeGapCombinationObj->getMaxPointsForCombination($this->getId());
            $gaps_used_in_combination = $assClozeGapCombinationObj->getGapsWhichAreUsedInCombination($this->getId());
        }
        foreach ($this->gaps as $gap_index => $gap) {
            if (!array_key_exists($gap_index, $gaps_used_in_combination)) {
                if ($gap->getType() == CLOZE_TEXT) {
                    $gap_max_points = 0;
                    foreach ($gap->getItems($this->getShuffler()) as $item) {
                        if ($item->getPoints() > $gap_max_points) {
                            $gap_max_points = $item->getPoints();
                        }
                    }
                    $points += $gap_max_points;
                } elseif ($gap->getType() == CLOZE_SELECT) {
                    $srpoints = 0;
                    foreach ($gap->getItems($this->getShuffler()) as $item) {
                        if ($item->getPoints() > $srpoints) {
                            $srpoints = $item->getPoints();
                        }
                    }
                    $points += $srpoints;
                } elseif ($gap->getType() == CLOZE_NUMERIC) {
                    $numpoints = 0;
                    foreach ($gap->getItems($this->getShuffler()) as $item) {
                        if ($item->getPoints() > $numpoints) {
                            $numpoints = $item->getPoints();
                        }
                    }
                    $points += $numpoints;
                }
            }
        }
            
        return $points;
    }

    public 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();
        }
        if ($this->gap_combinations_exists) {
            $this->copyGapCombination($this_id, $clone->getId());
        }
        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);

        $clone->onDuplicate($thisObjId, $this_id, $clone->getObjId(), $clone->getId());

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

        $clone->saveToDb();

        if ($this->gap_combinations_exists) {
            $this->copyGapCombination($original_id, $clone->getId());
            $clone->saveToDb();
        }

        // copy question page content
        $clone->copyPageOfQuestion($original_id);
        // copy XHTML media objects
        $clone->copyXHTMLMediaObjectsOfQuestion($original_id);

        $clone->onCopy($thisObjId, $thisId, $clone->getObjId(), $clone->getId());
        
        return $clone->getId();
    }

    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();
        
        if ($this->gap_combinations_exists) {
            $this->copyGapCombination($sourceQuestionId, $clone->getId());
            $clone->saveToDb();
        }
        // copy question page content
        $clone->copyPageOfQuestion($sourceQuestionId);
        // copy XHTML media objects
        $clone->copyXHTMLMediaObjectsOfQuestion($sourceQuestionId);

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

        return $clone->id;
    }
    
    public function copyGapCombination($orgID, $newID)
    {
        $assClozeGapCombinationObj = new assClozeGapCombination();
        $array = $assClozeGapCombinationObj->loadFromDb($orgID);
        $assClozeGapCombinationObj->importGapCombinationToDb($newID, $array);
    }

    public function updateClozeTextFromGaps()
    {
        $output = $this->getClozeText();
        foreach ($this->getGaps() as $gap_index => $gap) {
            $answers = array();
            foreach ($gap->getItemsRaw() as $item) {
                array_push($answers, str_replace(",", "\\,", $item->getAnswerText()));
            }
            $output = preg_replace("/\[gap\].*?\[\/gap\]/", "[_gap]" . $this->prepareTextareaOutput(join(",", $answers), true) . "[/_gap]", $output, 1);
        }
        $output = str_replace("_gap]", "gap]", $output);
        $this->cloze_text = $output;
    }
    
    public function deleteAnswerText($gap_index, $answer_index)
    {
        if (array_key_exists($gap_index, $this->gaps)) {
            if ($this->gaps[$gap_index]->getItemCount() == 1) {
                // this is the last answer text => remove the gap
                $this->deleteGap($gap_index);
            } else {
                // remove the answer text
                $this->gaps[$gap_index]->deleteItem($answer_index);
                $this->updateClozeTextFromGaps();
            }
        }
    }

    public function deleteGap($gap_index)
    {
        if (array_key_exists($gap_index, $this->gaps)) {
            $output = $this->getClozeText();
            foreach ($this->getGaps() as $replace_gap_index => $gap) {
                $answers = array();
                foreach ($gap->getItemsRaw() as $item) {
                    array_push($answers, str_replace(",", "\\,", $item->getAnswerText()));
                }
                if ($replace_gap_index == $gap_index) {
                    $output = preg_replace("/\[gap\].*?\[\/gap\]/", "", $output, 1);
                } else {
                    $output = preg_replace("/\[gap\].*?\[\/gap\]/", "[_gap]" . join(",", $answers) . "[/_gap]", $output, 1);
                }
            }
            $output = str_replace("_gap]", "gap]", $output);
            $this->cloze_text = $output;
            unset($this->gaps[$gap_index]);
            $this->gaps = array_values($this->gaps);
        }
    }

    public function getTextgapPoints($a_original, $a_entered, $max_points)
    {
        include_once "./Services/Utilities/classes/class.ilStr.php";
        $result = 0;
        $gaprating = $this->getTextgapRating();
        switch ($gaprating) {
            case TEXTGAP_RATING_CASEINSENSITIVE:
                if (strcmp(ilStr::strToLower($a_original), ilStr::strToLower($a_entered)) == 0) {
                    $result = $max_points;
                }
                break;
            case TEXTGAP_RATING_CASESENSITIVE:
                if (strcmp($a_original, $a_entered) == 0) {
                    $result = $max_points;
                }
                break;
            case TEXTGAP_RATING_LEVENSHTEIN1:
                if (levenshtein($a_original, $a_entered) <= 1) {
                    $result = $max_points;
                }
                break;
            case TEXTGAP_RATING_LEVENSHTEIN2:
                if (levenshtein($a_original, $a_entered) <= 2) {
                    $result = $max_points;
                }
                break;
            case TEXTGAP_RATING_LEVENSHTEIN3:
                if (levenshtein($a_original, $a_entered) <= 3) {
                    $result = $max_points;
                }
                break;
            case TEXTGAP_RATING_LEVENSHTEIN4:
                if (levenshtein($a_original, $a_entered) <= 4) {
                    $result = $max_points;
                }
                break;
            case TEXTGAP_RATING_LEVENSHTEIN5:
                if (levenshtein($a_original, $a_entered) <= 5) {
                    $result = $max_points;
                }
                break;
        }
        return $result;
    }
    
    public function getNumericgapPoints($a_original, $a_entered, $max_points, $lowerBound, $upperBound)
    {
        // fau: fixGapFormula - check entered value by evalMath
        //              if( ! $this->checkForValidFormula($a_entered) )
        //              {
        //                      return 0;
        //              }

        include_once "./Services/Math/classes/class.EvalMath.php";
        $eval = new EvalMath();
        $eval->suppress_errors = true;
        $result = 0;

        if ($eval->e($a_entered) === false) {
            return 0;
        } elseif (($eval->e($lowerBound) !== false) && ($eval->e($upperBound) !== false)) {
            // fau.
            if (($eval->e($a_entered) >= $eval->e($lowerBound)) && ($eval->e($a_entered) <= $eval->e($upperBound))) {
                $result = $max_points;
            }
        } elseif ($eval->e($lowerBound) !== false) {
            if (($eval->e($a_entered) >= $eval->e($lowerBound)) && ($eval->e($a_entered) <= $eval->e($a_original))) {
                $result = $max_points;
            }
        } elseif ($eval->e($upperBound) !== false) {
            if (($eval->e($a_entered) >= $eval->e($a_original)) && ($eval->e($a_entered) <= $eval->e($upperBound))) {
                $result = $max_points;
            }
        } else {
            if ($eval->e($a_entered) == $eval->e($a_original)) {
                $result = $max_points;
            }
        }
        return $result;
    }

    public function checkForValidFormula($value)
    {
        return preg_match("/^-?(\\d*)(,|\\.|\\/){0,1}(\\d*)$/", $value, $matches);
    }
    public function calculateReachedPoints($active_id, $pass = null, $authorized = true, $returndetails = false)
    {
        global $ilDB;
        
        if (is_null($pass)) {
            $pass = $this->getSolutionMaxPass($active_id);
        }

        $result = $this->getCurrentSolutionResultSet($active_id, $pass, $authorized);
        $user_result = array();
        while ($data = $ilDB->fetchAssoc($result)) {
            if (strcmp($data["value2"], "") != 0) {
                $user_result[$data["value1"]] = array(
                    "gap_id" => $data["value1"],
                    "value" => $data["value2"]
                );
            }
        }
        
        ksort($user_result); // this is required when identical scoring for same solutions is disabled

        if ($returndetails) {
            $detailed = array();
            $this->calculateReachedPointsForSolution($user_result, $detailed);
            return $detailed;
        }
        
        return $this->calculateReachedPointsForSolution($user_result);
    }
    
    protected function isValidNumericSubmitValue($submittedValue)
    {
        if (is_numeric($submittedValue)) {
            return true;
        }
        
        if (preg_match('/^[-+]{0,1}\d+\/\d+$/', $submittedValue)) {
            return true;
        }
        
        return false;
    }
    
    public function validateSolutionSubmit()
    {
        foreach ($this->getSolutionSubmit() as $gapIndex => $value) {
            $gap = $this->getGap($gapIndex);
            
            if ($gap->getType() != CLOZE_NUMERIC) {
                continue;
            }
            
            if (strlen($value) && !$this->isValidNumericSubmitValue($value)) {
                ilUtil::sendFailure($this->lng->txt("err_no_numeric_value"), true);
                return false;
            }
        }
        
        return true;
    }
    
    public function fetchSolutionSubmit($submit)
    {
        $solutionSubmit = array();
        
        foreach ($submit as $key => $value) {
            if (preg_match("/^gap_(\d+)/", $key, $matches)) {
                $value = ilUtil::stripSlashes($value, false);
                if (strlen($value)) {
                    $gap = $this->getGap($matches[1]);
                    if (is_object($gap)) {
                        if (!(($gap->getType() == CLOZE_SELECT) && ($value == -1))) {
                            if ($gap->getType() == CLOZE_NUMERIC) {
                                $value = str_replace(",", ".", $value);
                            }
                            $solutionSubmit[trim($matches[1])] = $value;
                        }
                    }
                }
            }
        }
        
        return $solutionSubmit;
    }
    
    public function getSolutionSubmit()
    {
        return $this->fetchSolutionSubmit($_POST);
    }
    
    public function saveWorkingData($active_id, $pass = null, $authorized = true)
    {
        global $ilDB;
        global $ilUser;
        if (is_null($pass)) {
            include_once "./Modules/Test/classes/class.ilObjTest.php";
            $pass = ilObjTest::_getPass($active_id);
        }

        $entered_values = 0;

        $this->getProcessLocker()->executeUserSolutionUpdateLockOperation(function () use (&$entered_values, $active_id, $pass, $authorized) {
            $this->removeCurrentSolution($active_id, $pass, $authorized);

            foreach ($this->getSolutionSubmit() as $val1 => $val2) {
                $value = trim(ilUtil::stripSlashes($val2, false));
                if (strlen($value)) {
                    $gap = $this->getGap(trim(ilUtil::stripSlashes($val1)));
                    if (is_object($gap)) {
                        if (!(($gap->getType() == CLOZE_SELECT) && ($value == -1))) {
                            $this->saveCurrentSolution($active_id, $pass, $val1, $value, $authorized);
                            $entered_values++;
                        }
                    }
                }
            }
        });

        if ($entered_values) {
            include_once("./Modules/Test/classes/class.ilObjAssessmentFolder.php");
            if (ilObjAssessmentFolder::_enabledAssessmentLogging()) {
                assQuestion::logAction($this->lng->txtlng("assessment", "log_user_entered_values", ilObjAssessmentFolder::_getLogLanguage()), $active_id, $this->getId());
            }
        } else {
            include_once("./Modules/Test/classes/class.ilObjAssessmentFolder.php");
            if (ilObjAssessmentFolder::_enabledAssessmentLogging()) {
                assQuestion::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, $authorized)
    {
        // nothing to rework!
    }

    public function getQuestionType()
    {
        return "assClozeTest";
    }

    public function getTextgapRating()
    {
        return $this->textgap_rating;
    }

    public function setTextgapRating($a_textgap_rating)
    {
        switch ($a_textgap_rating) {
            case TEXTGAP_RATING_CASEINSENSITIVE:
            case TEXTGAP_RATING_CASESENSITIVE:
            case TEXTGAP_RATING_LEVENSHTEIN1:
            case TEXTGAP_RATING_LEVENSHTEIN2:
            case TEXTGAP_RATING_LEVENSHTEIN3:
            case TEXTGAP_RATING_LEVENSHTEIN4:
            case TEXTGAP_RATING_LEVENSHTEIN5:
                $this->textgap_rating = $a_textgap_rating;
                break;
            default:
                $this->textgap_rating = TEXTGAP_RATING_CASEINSENSITIVE;
                break;
        }
    }

    public function getIdenticalScoring()
    {
        return ($this->identical_scoring) ? 1 : 0;
    }

    public function setIdenticalScoring($a_identical_scoring)
    {
        $this->identical_scoring = ($a_identical_scoring) ? 1 : 0;
    }

    public function getAdditionalTableName()
    {
        return "qpl_qst_cloze";
    }

    public function getAnswerTableName()
    {
        return array("qpl_a_cloze",'qpl_a_cloze_combi_res');
    }
    
    public function setFixedTextLength($a_text_len)
    {
        $this->fixedTextLength = $a_text_len;
    }
    
    public function getFixedTextLength()
    {
        return $this->fixedTextLength;
    }

    public function getMaximumGapPoints($gap_index)
    {
        $points = 0;
        $gap_max_points = 0;
        if (array_key_exists($gap_index, $this->gaps)) {
            $gap =&$this->gaps[$gap_index];
            foreach ($gap->getItems($this->getShuffler()) as $answer) {
                if ($answer->getPoints() > $gap_max_points) {
                    $gap_max_points = $answer->getPoints();
                }
            }
            $points += $gap_max_points;
        }
        return $points;
    }

    public function getRTETextWithMediaObjects()
    {
        return parent::getRTETextWithMediaObjects() . $this->getClozeText();
    }
    public function getGapCombinationsExists()
    {
        return $this->gap_combinations_exists;
    }

    public function getGapCombinations()
    {
        return $this->gap_combinations;
    }

    public function setGapCombinationsExists($value)
    {
        $this->gap_combinations_exists = $value;
    }

    public function setGapCombinations($value)
    {
        $this->gap_combinations = $value;
    }

    public function setExportDetailsXLS($worksheet, $startrow, $active_id, $pass)
    {
        parent::setExportDetailsXLS($worksheet, $startrow, $active_id, $pass);

        $solution = $this->getSolutionValues($active_id, $pass);
        $i = 1;
        foreach ($this->getGaps() as $gap_index => $gap) {
            $worksheet->setCell($startrow + $i, 0, $this->lng->txt("gap") . " $i");
            $worksheet->setBold($worksheet->getColumnCoord(0) . ($startrow + $i));
            $checked = false;
            foreach ($solution as $solutionvalue) {
                if ($gap_index == $solutionvalue["value1"]) {
                    $string_escaping_org_value = $worksheet->getStringEscaping();
                    try {
                        $worksheet->setStringEscaping(false);

                        switch ($gap->getType()) {
                            case CLOZE_SELECT:
                                $worksheet->setCell($startrow + $i, 1, $gap->getItem($solutionvalue["value2"])->getAnswertext());
                                break;
                            case CLOZE_NUMERIC:
                            case CLOZE_TEXT:
                                $worksheet->setCell($startrow + $i, 1, $solutionvalue["value2"]);
                                break;
                        }
                    } finally {
                        $worksheet->setStringEscaping($string_escaping_org_value);
                    }
                }
            }
            $i++;
        }

        return $startrow + $i + 1;
    }
    
    protected function lmMigrateQuestionTypeSpecificContent(ilAssSelfAssessmentMigrator $migrator)
    {
        // DO NOT USE SETTER FOR CLOZE TEXT -> SETTER DOES RECREATE GAP OBJECTS without having gap type info ^^
        //$this->setClozeText( $migrator->migrateToLmContent($this->getClozeText()) );
        $this->cloze_text = $migrator->migrateToLmContent($this->getClozeText());
        // DO NOT USE SETTER FOR CLOZE TEXT -> SETTER DOES RECREATE GAP OBJECTS without having gap type info ^^
    }
    
    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['clozetext'] =  $this->formatSAQuestion($this->getClozeText());
        $result['nr_of_tries'] = (int) $this->getNrOfTries();
        $result['shuffle'] = (bool) $this->getShuffle();
        $result['feedback'] = array(
            'onenotcorrect' => $this->formatSAQuestion($this->feedbackOBJ->getGenericFeedbackTestPresentation($this->getId(), false)),
            'allcorrect' => $this->formatSAQuestion($this->feedbackOBJ->getGenericFeedbackTestPresentation($this->getId(), true))
        );
        
        $gaps = array();
        foreach ($this->getGaps() as $key => $gap) {
            $items = array();
            foreach ($gap->getItems($this->getShuffler()) as $item) {
                $jitem = array();
                $jitem['points'] = $item->getPoints();
                $jitem['value'] = $this->formatSAQuestion($item->getAnswertext());
                $jitem['order'] = $item->getOrder();
                if ($gap->getType() == CLOZE_NUMERIC) {
                    $jitem['lowerbound'] = $item->getLowerBound();
                    $jitem['upperbound'] = $item->getUpperBound();
                } else {
                    $jitem['value'] = trim($jitem['value']);
                }
                array_push($items, $jitem);
            }

            if ($gap->getGapSize() && ($gap->getType() == CLOZE_TEXT || $gap->getType() == CLOZE_NUMERIC)) {
                $jgap['size'] = $gap->getGapSize();
            }

            $jgap['shuffle'] = $gap->getShuffle();
            $jgap['type'] = $gap->getType();
            $jgap['item'] = $items;
            
            array_push($gaps, $jgap);
        }
        $result['gaps'] = $gaps;
        $mobs = ilObjMediaObject::_getMobsOfObject("qpl:html", $this->getId());
        $result['mobs'] = $mobs;
        return json_encode($result);
    }

    public function getOperators($expression)
    {
        require_once "./Modules/TestQuestionPool/classes/class.ilOperatorsExpressionMapping.php";
        return ilOperatorsExpressionMapping::getOperatorsByExpression($expression);
    }

    public function getExpressionTypes()
    {
        return array(
            iQuestionCondition::PercentageResultExpression,
            iQuestionCondition::NumericResultExpression,
            iQuestionCondition::NumberOfResultExpression,
            iQuestionCondition::StringResultExpression,
            iQuestionCondition::EmptyAnswerExpression,
        );
    }

    public function getUserQuestionResult($active_id, $pass)
    {
        global $ilDB;
        $result = new ilUserQuestionResult($this, $active_id, $pass);

        $maxStep = $this->lookupMaxStep($active_id, $pass);

        if ($maxStep !== null) {
            $data = $ilDB->queryF(
                "
                                SELECT sol.value1+1 as val, sol.value2, cloze.cloze_type
                                FROM tst_solutions sol
                                INNER JOIN qpl_a_cloze cloze ON cloze.gap_id = value1 AND cloze.question_fi = sol.question_fi
                                WHERE sol.active_fi = %s AND sol.pass = %s AND sol.question_fi = %s AND sol.step = %s
                                GROUP BY sol.solution_id, sol.value1+1, sol.value2, cloze.cloze_type
                                ",
                array("integer", "integer", "integer","integer"),
                array($active_id, $pass, $this->getId(), $maxStep)
            );
        } else {
            $data = $ilDB->queryF(
                "
                                SELECT sol.value1+1 as val, sol.value2, cloze.cloze_type
                                FROM tst_solutions sol
                                INNER JOIN qpl_a_cloze cloze ON cloze.gap_id = value1 AND cloze.question_fi = sol.question_fi
                                WHERE sol.active_fi = %s AND sol.pass = %s AND sol.question_fi = %s
                                GROUP BY sol.solution_id, sol.value1+1, sol.value2, cloze.cloze_type
                                ",
                array("integer", "integer", "integer"),
                array($active_id, $pass, $this->getId())
            );
        }
        
        while ($row = $ilDB->fetchAssoc($data)) {
            if ($row["cloze_type"] == 1) {
                $row["value2"]++;
            }
            $result->addKeyValue($row["val"], $row["value2"]);
        }

        $points = $this->calculateReachedPoints($active_id, $pass);
        $max_points = $this->getMaximumPoints();

        $result->setReachedPercentage(($points/$max_points) * 100);

        return $result;
    }

    public function getAvailableAnswerOptions($index = null)
    {
        if ($index !== null) {
            return $this->getGap($index);
        } else {
            return $this->getGaps();
        }
    }

    public function calculateCombinationResult($user_result)
    {
        $points = 0;
        
        $assClozeGapCombinationObj = new assClozeGapCombination();
        
        if ($assClozeGapCombinationObj->combinationExistsForQid($this->getId())) {
            $combinations_for_question  = $assClozeGapCombinationObj->getCleanCombinationArray($this->getId());
            $gap_answers                = array();
            $gap_used_in_combination    = array();
            foreach ($user_result as $user_result_build_list) {
                if (is_array($user_result_build_list)) {
                    $gap_answers[$user_result_build_list['gap_id']] = $user_result_build_list['value'];
                }
            }

            foreach ($combinations_for_question as $combination) {
                foreach ($combination as $row_key => $row_answers) {
                    $combination_fulfilled = true;
                    $points_for_combination = $row_answers['points'];
                    foreach ($row_answers as $gap_key => $combination_gap_answer) {
                        if ($gap_key !== 'points') {
                            $gap_used_in_combination[$gap_key]= $gap_key;
                        }
                        if ($combination_fulfilled && array_key_exists($gap_key, $gap_answers)) {
                            switch ($combination_gap_answer['type']) {
                                case CLOZE_TEXT:
                                    $is_text_gap_correct = $this->getTextgapPoints($gap_answers[$gap_key], $combination_gap_answer['answer'], 1);
                                    if ($is_text_gap_correct != 1) {
                                        $combination_fulfilled = false;
                                    }
                                    break;
                                case CLOZE_SELECT:
                                    $answer     = $this->gaps[$gap_key]->getItem($gap_answers[$gap_key]);
                                    $answertext = $answer->getAnswertext();
                                    if ($answertext != $combination_gap_answer['answer']) {
                                        $combination_fulfilled = false;
                                    }
                                    break;
                                case CLOZE_NUMERIC:
                                    $answer = $this->gaps[$gap_key]->getItem(0);
                                    if ($combination_gap_answer['answer'] != 'out_of_bound') {
                                        $is_numeric_gap_correct = $this->getNumericgapPoints($answer->getAnswertext(), $gap_answers[$gap_key], 1, $answer->getLowerBound(), $answer->getUpperBound());
                                        if ($is_numeric_gap_correct != 1) {
                                            $combination_fulfilled = false;
                                        }
                                    } else {
                                        $wrong_is_the_new_right = $this->getNumericgapPoints($answer->getAnswertext(), $gap_answers[$gap_key], 1, $answer->getLowerBound(), $answer->getUpperBound());
                                        if ($wrong_is_the_new_right == 1) {
                                            $combination_fulfilled = false;
                                        }
                                    }
                                    break;
                            }
                        } else {
                            if ($gap_key !== 'points') {
                                $combination_fulfilled = false;
                            }
                        }
                    }
                    if ($combination_fulfilled) {
                        $points += $points_for_combination;
                    }
                }
            }
        }
        return array($points, $gap_used_in_combination);
    }
    protected function calculateReachedPointsForSolution($user_result, &$detailed = null)
    {
        if ($detailed === null) {
            $detailed = array();
        }

        $assClozeGapCombinationObj = new assClozeGapCombination();
        $combinations[1] = array();
        if ($assClozeGapCombinationObj->combinationExistsForQid($this->getId())) {
            $combinations = $this->calculateCombinationResult($user_result);
            $points = $combinations[0];
        }
        $counter          = 0;
        $solution_values_text = array(); // for identical scoring checks
        $solution_values_select = array(); // for identical scoring checks
        $solution_values_numeric = array(); // for identical scoring checks
        foreach ($user_result as $gap_id => $value) {
            if (is_string($value)) {
                $value = array("value" => $value);
            }
            
            if (array_key_exists($gap_id, $this->gaps) && !array_key_exists($gap_id, $combinations[1])) {
                switch ($this->gaps[$gap_id]->getType()) {
                    case CLOZE_TEXT:
                        $gappoints = 0;
                        for ($order = 0; $order < $this->gaps[$gap_id]->getItemCount(); $order++) {
                            $answer = $this->gaps[$gap_id]->getItem($order);
                            $gotpoints = $this->getTextgapPoints($answer->getAnswertext(), $value["value"], $answer->getPoints());
                            if ($gotpoints > $gappoints) {
                                $gappoints = $gotpoints;
                            }
                        }
                        if (!$this->getIdenticalScoring()) {
                            // check if the same solution text was already entered
                            if ((in_array($value["value"], $solution_values_text)) && ($gappoints > 0)) {
                                $gappoints = 0;
                            }
                        }
                        $points += $gappoints;
                        $detailed[$gap_id] = array("points" => $gappoints, "best" => ($this->getMaximumGapPoints($gap_id) == $gappoints) ? true : false, "positive" => ($gappoints > 0) ? true : false);
                        array_push($solution_values_text, $value["value"]);
                        break;
                    case CLOZE_NUMERIC:
                        $gappoints = 0;
                        for ($order = 0; $order < $this->gaps[$gap_id]->getItemCount(); $order++) {
                            $answer = $this->gaps[$gap_id]->getItem($order);
                            $gotpoints = $this->getNumericgapPoints($answer->getAnswertext(), $value["value"], $answer->getPoints(), $answer->getLowerBound(), $answer->getUpperBound());
                            if ($gotpoints > $gappoints) {
                                $gappoints = $gotpoints;
                            }
                        }
                        if (!$this->getIdenticalScoring()) {
                            // check if the same solution value was already entered
                            include_once "./Services/Math/classes/class.EvalMath.php";
                            $eval = new EvalMath();
                            $eval->suppress_errors = true;
                            $found_value = false;
                            foreach ($solution_values_numeric as $solval) {
                                if ($eval->e($solval) == $eval->e($value["value"])) {
                                    $found_value = true;
                                }
                            }
                            if ($found_value && ($gappoints > 0)) {
                                $gappoints = 0;
                            }
                        }
                        $points += $gappoints;
                        $detailed[$gap_id] = array("points" => $gappoints, "best" => ($this->getMaximumGapPoints($gap_id) == $gappoints) ? true : false, "positive" => ($gappoints > 0) ? true : false);
                        array_push($solution_values_numeric, $value["value"]);
                        break;
                    case CLOZE_SELECT:
                        if ($value["value"] >= 0) {
                            for ($order = 0; $order < $this->gaps[$gap_id]->getItemCount(); $order++) {
                                $answer = $this->gaps[$gap_id]->getItem($order);
                                if ($value["value"] == $answer->getOrder()) {
                                    $answerpoints = $answer->getPoints();
                                    if (!$this->getIdenticalScoring()) {
                                        // check if the same solution value was already entered
                                        if ((in_array($answer->getAnswertext(), $solution_values_select)) && ($answerpoints > 0)) {
                                            $answerpoints = 0;
                                        }
                                    }
                                    $points += $answerpoints;
                                    $detailed[$gap_id] = array("points" => $answerpoints, "best" => ($this->getMaximumGapPoints($gap_id) == $answerpoints) ? true : false, "positive" => ($answerpoints > 0) ? true : false);
                                    array_push($solution_values_select, $answer->getAnswertext());
                                }
                            }
                        }
                        break;
                }
            }
        }
        
        return $points;
    }

    public function calculateReachedPointsFromPreviewSession(ilAssQuestionPreviewSession $previewSession)
    {
        $userSolution = array();
        
        foreach ($previewSession->getParticipantsSolution() as $key => $val) {
            // fau: fixEmptyGapPreview - add the gap_id as array index
            $userSolution[$key] = array('gap_id' => $key, 'value' => $val);
            // fau.
        }
        
        $reachedPoints = $this->calculateReachedPointsForSolution($userSolution);
        $reachedPoints = $this->deductHintPointsFromReachedPoints($previewSession, $reachedPoints);
        
        return $this->ensureNonNegativePoints($reachedPoints);
    }
}