class.assTextQuestion.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 assTextQuestion extends assQuestion implements ilObjQuestionScoringAdjustable, ilObjAnswerScoringAdjustable
{
    public $maxNumOfChars;

    public $keywords;

    public $answers;

    public $text_rating;

    /* method for automatic string matching */
    private $matchcondition;

    public $keyword_relation = 'any';

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

    public function isComplete()
    {
        if (strlen($this->title)
            && $this->author
            && $this->question
            && $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 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 ($ilDB->numRows($result) == 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((float) $data["points"]);
            $this->setOwner($data["owner"]);
            include_once("./Services/RTE/classes/class.ilRTE.php");
            $this->setQuestion(ilRTE::_replaceMediaObjectImageSrc($data["question_text"], 1));
            $this->setShuffle($data["shuffle"]);
            $this->setMaxNumOfChars($data["maxnumofchars"]);
            $this->setTextRating($this->isValidTextRating($data["textgap_rating"]) ? $data["textgap_rating"] : TEXTGAP_RATING_CASEINSENSITIVE);
            $this->matchcondition = (strlen($data['matchcondition'])) ? $data['matchcondition'] : 0;
            $this->setEstimatedWorkingTime(substr($data["working_time"], 0, 2), substr($data["working_time"], 3, 2), substr($data["working_time"], 6, 2));
            $this->setKeywordRelation(($data['keyword_relation']));
            
            try {
                $this->setAdditionalContentEditingMode($data['add_cont_edit_mode']);
            } catch (ilTestQuestionPoolException $e) {
            }
        }

        $result = $ilDB->queryF(
            "SELECT * FROM qpl_a_essay WHERE question_fi = %s",
            array("integer"),
            array($this->getId())
        );
        
        $this->flushAnswers();
        while ($row = $ilDB->fetchAssoc($result)) {
            $this->addAnswer($row['answertext'], $row['points']);
        }
        
        parent::loadFromDb($question_id);
    }

    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();
        }

        // copy question page content
        $clone->copyPageOfQuestion($this_id);
        // copy XHTML media objects
        $clone->copyXHTMLMediaObjectsOfQuestion($this_id);
        #$clone->duplicateAnswers($this_id);
        
        $clone->onDuplicate($thisObjId, $this_id, $clone->getObjId(), $clone->getId());

        return $clone->id;
    }

    public 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 answers
        #$clone->duplicateAnswers($original_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 answers
        #$clone->duplicateAnswers($sourceQuestionId);

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

        return $clone->id;
    }

    public function getMaxNumOfChars()
    {
        if (strcmp($this->maxNumOfChars, "") == 0) {
            return 0;
        } else {
            return $this->maxNumOfChars;
        }
    }

    public function setMaxNumOfChars($maxchars = 0)
    {
        $this->maxNumOfChars = $maxchars;
    }

    public function getMaximumPoints()
    {
        if (in_array($this->getKeywordRelation(), self::getScoringModesWithPointsByQuestion())) {
            return parent::getPoints();
        }
        
        $points = 0;
        
        foreach ($this->answers as $answer) {
            if ($answer->getPoints() > 0) {
                $points = $points + $answer->getPoints();
            }
        }
        
        return $points;
    }
    
    public function getMinimumPoints()
    {
        if (in_array($this->getKeywordRelation(), self::getScoringModesWithPointsByQuestion())) {
            return 0;
        }
        
        $points = 0;

        foreach ($this->answers as $answer) {
            if ($answer->getPoints() < 0) {
                $points = $points + $answer->getPoints();
            }
        }

        return $points;
    }
    public function setReachedPoints($active_id, $points, $pass = null)
    {
        global $ilDB;
        
        if (($points > 0) && ($points <= $this->getPoints())) {
            if (is_null($pass)) {
                $pass = $this->getSolutionMaxPass($active_id);
            }
            $affectedRows = $ilDB->manipulateF(
                "UPDATE tst_test_result SET points = %s WHERE active_fi = %s AND question_fi = %s AND pass = %s",
                array('float','integer','integer','integer'),
                array($points, $active_id, $this->getId(), $pass)
            );
            self::_updateTestPassResults($active_id, $pass);
            return true;
        } else {
            return true;
        }
    }
    
    private function isValidTextRating($textRating)
    {
        switch ($textRating) {
            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:
                return true;
        }
        
        return false;
    }

    public function isKeywordMatching($answertext, $a_keyword)
    {
        $result = false;
        $textrating = $this->getTextRating();
        include_once "./Services/Utilities/classes/class.ilStr.php";
        switch ($textrating) {
            case TEXTGAP_RATING_CASEINSENSITIVE:
                if (ilStr::strPos(ilStr::strToLower($answertext), ilStr::strToLower($a_keyword)) !== false) {
                    return true;
                }
                break;
            case TEXTGAP_RATING_CASESENSITIVE:
                if (ilStr::strPos($answertext, $a_keyword) !== false) {
                    return true;
                }
                break;
        }
        
        // "<p>red</p>" would not match "red" even with distance of 5
        $answertext = strip_tags($answertext);
        
        $answerwords = array();
        if (preg_match_all("/([^\s.]+)/", $answertext, $matches)) {
            foreach ($matches[1] as $answerword) {
                array_push($answerwords, trim($answerword));
            }
        }
        foreach ($answerwords as $a_original) {
            switch ($textrating) {
                case TEXTGAP_RATING_LEVENSHTEIN1:
                    if (levenshtein($a_original, $a_keyword) <= 1) {
                        return true;
                    }
                    break;
                case TEXTGAP_RATING_LEVENSHTEIN2:
                    if (levenshtein($a_original, $a_keyword) <= 2) {
                        return true;
                    }
                    break;
                case TEXTGAP_RATING_LEVENSHTEIN3:
                    if (levenshtein($a_original, $a_keyword) <= 3) {
                        return true;
                    }
                    break;
                case TEXTGAP_RATING_LEVENSHTEIN4:
                    if (levenshtein($a_original, $a_keyword) <= 4) {
                        return true;
                    }
                    break;
                case TEXTGAP_RATING_LEVENSHTEIN5:
                    if (levenshtein($a_original, $a_keyword) <= 5) {
                        return true;
                    }
                    break;
            }
        }
        return $result;
    }
    
    protected function calculateReachedPointsForSolution($solution)
    {
        // Return min points when keyword relation is NON KEYWORDS
        if ($this->getKeywordRelation() == 'non') {
            return $this->getMinimumPoints();
        }

        // Return min points if there are no answers present.
        $answers = $this->getAnswers();

        if (count($answers) == 0) {
            return $this->getMinimumPoints();
        }
        
        switch ($this->getKeywordRelation()) {
            case 'any':

                $points = 0;

                foreach ($answers as $answer) {
                    $qst_answer  = $answer->getAnswertext();
                    $user_answer = '  ' . $solution;

                    if ($this->isKeywordMatching($user_answer, $qst_answer)) {
                        $points += $answer->getPoints();
                    }
                }

                break;

            case 'all':

                $points = $this->getMaximumPoints();

                foreach ($answers as $answer) {
                    $qst_answer  = $answer->getAnswertext();
                    $user_answer = '  ' . $solution;

                    if (!$this->isKeywordMatching($user_answer, $qst_answer)) {
                        $points = 0;
                        break;
                    }
                }

                break;

            case 'one':

                $points = 0;

                foreach ($answers as $answer) {
                    $qst_answer  = $answer->getAnswertext();
                    $user_answer = '  ' . $solution;

                    if ($this->isKeywordMatching($user_answer, $qst_answer)) {
                        $points = $this->getMaximumPoints();
                        break;
                    }
                }

                break;
        }

        return $points;
    }

    public function calculateReachedPoints($active_id, $pass = null, $authorizedSolution = true, $returndetails = false)
    {
        if ($returndetails) {
            throw new ilTestException('return details not implemented for ' . __METHOD__);
        }
        
        global $ilDB;

        $points = 0;
        if (is_null($pass)) {
            $pass = $this->getSolutionMaxPass($active_id);
        }

        $result = $this->getCurrentSolutionResultSet($active_id, $pass, $authorizedSolution);
        
        // Return min points when no answer was given.
        if ($ilDB->numRows($result) == 0) {
            return $this->getMinimumPoints();
        }
        
        // Return points of points are already on the row.
        $row = $ilDB->fetchAssoc($result);
        if ($row["points"] != null) {
            return $row["points"];
        }

        return $this->calculateReachedPointsForSolution($row['value1']);
    }

    public function saveWorkingData($active_id, $pass = null, $authorized = true)
    {
        global $ilDB;
        global $ilUser;

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

        $entered_values = 0;
        $text = $this->getSolutionSubmit();

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

            if (strlen($text)) {
                $this->saveCurrentSolution($active_id, $pass, trim($text), null, $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;
    }

    public function getSolutionSubmit()
    {
        $text = ilUtil::stripSlashes($_POST["TEXT"], false);
        
        if (ilUtil::isHTML($text)) {
            $text = $this->getHtmlUserSolutionPurifier()->purify($text);
        }
        
        return $text;
    }

    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, maxnumofchars, keywords, 
                                                         textgap_rating, matchcondition, keyword_relation) VALUES (%s, %s, %s, %s, %s, %s)",
            array( "integer", "integer", "text", "text", 'integer', 'text' ),
            array(
                                $this->getId(),
                                $this->getMaxNumOfChars(),
                                null,
                                $this->getTextRating(),
                                $this->matchcondition,
                                $this->getKeywordRelation()
                            )
        );
    }

    public function saveAnswerSpecificDataToDb()
    {
        global $ilDB;

        $ilDB->manipulateF(
            "DELETE FROM qpl_a_essay WHERE question_fi = %s",
            array( "integer" ),
            array( $this->getId() )
        );

        foreach ($this->answers as $answer) {
            $nextID = $ilDB->nextId('qpl_a_essay');
            $ilDB->manipulateF(
                "INSERT INTO qpl_a_essay (answer_id, question_fi, answertext, points) VALUES (%s, %s, %s, %s)",
                array( "integer", "integer", "text", 'float' ),
                array(
                                    $nextID,
                                    $this->getId(),
                                    $answer->getAnswertext(),
                                    $answer->getPoints()
                                )
            );
        }
    }

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

    public function createRandomSolution($test_id, $user_id)
    {
    }

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

    public function getTextRating()
    {
        return $this->text_rating;
    }
    
    public function setTextRating($a_text_rating)
    {
        switch ($a_text_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->text_rating = $a_text_rating;
                break;
            default:
                $this->text_rating = TEXTGAP_RATING_CASEINSENSITIVE;
                break;
        }
    }
    
    public function getAdditionalTableName()
    {
        return "qpl_qst_essay";
    }

    public function getRTETextWithMediaObjects()
    {
        return parent::getRTETextWithMediaObjects();
    }

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

        $solutions = $this->getSolutionValues($active_id, $pass);
        
        $i = 1;
        $worksheet->setCell($startrow + $i, 0, $this->lng->txt("result"));
        $worksheet->setBold($worksheet->getColumnCoord(0) . ($startrow + $i));
        
        require_once 'Modules/Test/classes/class.ilObjAssessmentFolder.php';
        $assessment_folder = new ilObjAssessmentFolder();

        $string_escaping_org_value = $worksheet->getStringEscaping();
        if ($assessment_folder->getExportEssayQuestionsWithHtml() == 1) {
            $worksheet->setStringEscaping(false);
        }

        if (strlen($solutions[0]["value1"])) {
            $worksheet->setCell($startrow + $i, 1, $solutions[0]["value1"]);
        }
        $i++;

        $worksheet->setStringEscaping($string_escaping_org_value);
        return $startrow + $i + 1;
    }
    
    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['maxlength'] = (int) $this->getMaxNumOfChars();
        return json_encode($result);
    }

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

    public function addAnswer(
        $answertext = "",
        $points = 0.0,
        $points_unchecked = 0.0,
        $order = 0,
        $answerimage = ""
    ) {
        include_once "./Modules/TestQuestionPool/classes/class.assAnswerMultipleResponseImage.php";

        // add answer
        $answer = new ASS_AnswerMultipleResponseImage($answertext, $points);
        $this->answers[] = $answer;
    }
    
    public function getAnswers()
    {
        return $this->answers;
    }

    public 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];
    }

    public function deleteAnswer($index = 0)
    {
        if ($index < 0) {
            return;
        }
        if (count($this->answers) < 1) {
            return;
        }
        if ($index >= count($this->answers)) {
            return;
        }
        $answer = $this->answers[$index];
        if (strlen($answer->getImage())) {
            $this->deleteImage($answer->getImage());
        }
        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);
            }
        }
    }

    public function getAnswerTableName()
    {
        return 'qpl_a_essay';
    }

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

    public function setAnswers($answers)
    {
        if (isset($answers['answer'])) {
            $count = count($answers['answer']);
            $withPoints = true;
        } else {
            $count = count($answers);
            $withPoints = false;
        }
        
        $this->flushAnswers();
        
        for ($i = 0; $i < $count; $i++) {
            if ($withPoints) {
                $this->addAnswer($answers['answer'][$i], $answers['points'][$i]);
            } else {
                $this->addAnswer($answers[$i], 0);
            }
        }
    }

    public function duplicateAnswers($original_id)
    {
        global $ilDB;

        $result = $ilDB->queryF(
            "SELECT * FROM qpl_a_essay WHERE question_fi = %s",
            array('integer'),
            array($original_id)
        );
        if ($result->numRows()) {
            while ($row = $ilDB->fetchAssoc($result)) {
                $next_id = $ilDB->nextId('qpl_a_essay');
                $affectedRows = $ilDB->manipulateF(
                    "INSERT INTO qpl_a_essay (answer_id, question_fi, answertext, points) 
                                         VALUES (%s, %s, %s, %s)",
                    array('integer','integer','text','float'),
                    array($next_id, $this->getId(), $row["answertext"], $row["points"])
                );
            }
        }
    }

    public function getKeywordRelation()
    {
        return $this->keyword_relation;
    }

    public function setKeywordRelation($a_relation)
    {
        $this->keyword_relation = $a_relation;
    }
    
    public static function getValidScoringModes()
    {
        return array_merge(self::getScoringModesWithPointsByQuestion(), self::getScoringModesWithPointsByKeyword());
    }
    
    public static function getScoringModesWithPointsByQuestion()
    {
        return array('non', 'all', 'one');
    }
    
    public static function getScoringModesWithPointsByKeyword()
    {
        return array('any');
    }
    
    
    public function isAnswered($active_id, $pass = null)
    {
        $numExistingSolutionRecords = assQuestion::getNumExistingSolutionRecords($active_id, $pass, $this->getId());

        return $numExistingSolutionRecords > 0;
    }
    
    public static function isObligationPossible($questionId)
    {
        return true;
    }
    
    public function countLetters($text)
    {
        $text = strip_tags($text);
        
        $text = str_replace('&gt;', '>', $text);
        $text = str_replace('&lt;', '<', $text);
        $text = str_replace('&nbsp;', ' ', $text);
        $text = str_replace('&amp;', '&', $text);
        
        $text = str_replace("\r\n", "\n", $text);
        $text = str_replace("\n", "", $text);
        
        return ilStr::strLen($text);
    }
}