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

class assMatchingQuestion extends assQuestion implements ilObjQuestionScoringAdjustable, ilObjAnswerScoringAdjustable, iQuestionCondition
{
        var $matchingpairs;
        var $matching_type;

        protected $terms;

        protected $definitions;
        var $thumb_geometry = 100;

        var $element_height;

        const MATCHING_MODE_1_ON_1 = '1:1';
        const MATCHING_MODE_N_ON_N = 'n:n';

        protected $matchingMode = self::MATCHING_MODE_1_ON_1;

        public function __construct(
                $title = "",
                $comment = "",
                $author = "",
                $owner = -1,
                $question = "",
                $matching_type = MT_TERMS_DEFINITIONS
        )
        {
                parent::__construct($title, $comment, $author, $owner, $question);
                $this->matchingpairs = array();
                $this->matching_type = $matching_type;
                $this->terms = array();
                $this->definitions = array();
        }

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

        public function saveToDb($original_id = "")
        {
                global $ilDB;

                $this->saveQuestionDataToDb($original_id);
                $this->saveAdditionalQuestionDataToDb();
                $this->saveAnswerSpecificDataToDb( $ilDB );


                parent::saveToDb($original_id);
        }

        public function saveAnswerSpecificDataToDb()
        {
                global $ilDB;
                // delete old terms
                $ilDB->manipulateF( "DELETE FROM qpl_a_mterm WHERE question_fi = %s",
                                                        array( 'integer' ),
                                                        array( $this->getId() )
                );

                // delete old definitions
                $ilDB->manipulateF( "DELETE FROM qpl_a_mdef WHERE question_fi = %s",
                                                        array( 'integer' ),
                                                        array( $this->getId() )
                );

                $termids = array();
                // write terms
                foreach ($this->terms as $key => $term)
                {
                        $next_id = $ilDB->nextId( 'qpl_a_mterm' );
                        $ilDB->insert('qpl_a_mterm', array(
                                'term_id' => array('integer', $next_id),
                                'question_fi' => array('integer', $this->getId()),
                                'picture' => array('text', $term->picture),
                                'term' => array('text', $term->text),
                                'ident' => array('integer', $term->identifier)
                        ));
                        $termids[$term->identifier] = $next_id;
                }

                $definitionids = array();
                // write definitions
                foreach ($this->definitions as $key => $definition)
                {
                        $next_id = $ilDB->nextId( 'qpl_a_mdef' );
                        $ilDB->insert('qpl_a_mdef', array(
                                'def_id' => array('integer', $next_id),
                                'question_fi' => array('integer', $this->getId()),
                                'picture' => array('text', $definition->picture),
                                'definition' => array('text', $definition->text),
                                'ident' => array('integer', $definition->identifier)
                        ));
                        $definitionids[$definition->identifier] = $next_id;
                }

                $ilDB->manipulateF( "DELETE FROM qpl_a_matching WHERE question_fi = %s",
                                                        array( 'integer' ),
                                                        array( $this->getId() )
                );
                $matchingpairs = $this->getMatchingPairs();
                foreach ($matchingpairs as $key => $pair)
                {
                        $next_id = $ilDB->nextId( 'qpl_a_matching' );
                        $ilDB->manipulateF( "INSERT INTO qpl_a_matching (answer_id, question_fi, points, term_fi, definition_fi) VALUES (%s, %s, %s, %s, %s)",
                                                                array( 'integer', 'integer', 'float', 'integer', 'integer' ),
                                                                array(
                                                                        $next_id,
                                                                        $this->getId(),
                                                                        $pair->points,
                                                                        $termids[$pair->term->identifier],
                                                                        $definitionids[$pair->definition->identifier]
                                                                )
                        );
                }

                $this->rebuildThumbnails();
        }

        public function saveAdditionalQuestionDataToDb()
        {
                global $ilDB;

                // save additional data

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

                $ilDB->insert($this->getAdditionalTableName(), array(
                        'question_fi' => array('integer', $this->getId()),
                        'shuffle' => array('text', $this->shuffle),
                        'matching_type' => array('text', $this->matching_type),
                        'thumb_geometry' => array('integer', $this->getThumbGeometry()),
                        'matching_mode' => array('text', $this->getMatchingMode())
                ));
        }

        public function loadFromDb($question_id)
        {
                global $ilDB;

                $query = "
                        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
                ";

                $result = $ilDB->queryF(
                        $query, 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"]);
                        include_once("./Services/RTE/classes/class.ilRTE.php");
                        $this->setQuestion(ilRTE::_replaceMediaObjectImageSrc($data["question_text"], 1));
                        $this->setThumbGeometry($data["thumb_geometry"]);
                        $this->setShuffle($data["shuffle"]);
                        $this->setMatchingMode($data['matching_mode'] === null ? self::MATCHING_MODE_1_ON_1 : $data['matching_mode']);
                        $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)
                        {
                        }
                }

                $termids = array();
                $result = $ilDB->queryF("SELECT * FROM qpl_a_mterm WHERE question_fi = %s ORDER BY term_id ASC",
                        array('integer'),
                        array($question_id)
                );
                include_once "./Modules/TestQuestionPool/classes/class.assAnswerMatchingTerm.php";
                $this->terms = array();
                if ($result->numRows() > 0)
                {
                        while ($data = $ilDB->fetchAssoc($result))
                        {
                                $term = new assAnswerMatchingTerm($data['term'], $data['picture'], $data['ident']);
                                array_push($this->terms, $term);
                                $termids[$data['term_id']] = $term;
                        }
                }

                $definitionids = array();
                $result = $ilDB->queryF("SELECT * FROM qpl_a_mdef WHERE question_fi = %s ORDER BY def_id ASC",
                        array('integer'),
                        array($question_id)
                );
                include_once "./Modules/TestQuestionPool/classes/class.assAnswerMatchingDefinition.php";
                $this->definitions = array();
                if ($result->numRows() > 0)
                {
                        while ($data = $ilDB->fetchAssoc($result))
                        {
                                $definition = new assAnswerMatchingDefinition($data['definition'], $data['picture'], $data['ident']);
                                array_push($this->definitions, $definition);
                                $definitionids[$data['def_id']] = $definition;
                        }
                }

                $this->matchingpairs = array();
                $result = $ilDB->queryF("SELECT * FROM qpl_a_matching WHERE question_fi = %s ORDER BY answer_id",
                        array('integer'),
                        array($question_id)
                );
                include_once "./Modules/TestQuestionPool/classes/class.assAnswerMatchingPair.php";
                if ($result->numRows() > 0)
                {
                        while ($data = $ilDB->fetchAssoc($result))
                        {
                                array_push($this->matchingpairs, new assAnswerMatchingPair($termids[$data['term_fi']], $definitionids[$data['definition_fi']], $data['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);
                // duplicate the image
                $clone->duplicateImages($this_id, $thisObjId, $clone->getId(), $testObjId);

                $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 the image
                $clone->copyImages($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->copyImages($sourceQuestionId, $sourceParentId);

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

                return $clone->id;
        }

        public function duplicateImages($question_id, $objectId = null)
        {
                global $ilLog;
                $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);
                }
                
                foreach ($this->terms as $term)
                {
                        if (strlen($term->picture))
                        {
                                $filename = $term->picture;
                                if (!file_exists($imagepath))
                                {
                                        ilUtil::makeDirParents($imagepath);
                                }
                                if (!@copy($imagepath_original . $filename, $imagepath . $filename)) 
                                {
                                        $ilLog->write("matching question image could not be duplicated: $imagepath_original$filename");
                                }
                                if (@file_exists($imagepath_original . $this->getThumbPrefix() . $filename)) 
                                {
                                        if (!@copy($imagepath_original . $this->getThumbPrefix() . $filename, $imagepath . $this->getThumbPrefix() . $filename)) 
                                        {
                                                $ilLog->write("matching question image thumbnail could not be duplicated: $imagepath_original" . $this->getThumbPrefix() . $filename);
                                        }
                                }
                        }
                }
                foreach ($this->definitions as $definition)
                {
                        if (strlen($definition->picture))
                        {
                                $filename = $definition->picture;
                                if (!file_exists($imagepath))
                                {
                                        ilUtil::makeDirParents($imagepath);
                                }
                                if (!@copy($imagepath_original . $filename, $imagepath . $filename)) 
                                {
                                        $ilLog->write("matching question image could not be duplicated: $imagepath_original$filename");
                                }
                                if (@file_exists($imagepath_original . $this->getThumbPrefix() . $filename))
                                {
                                        if (!@copy($imagepath_original . $this->getThumbPrefix() . $filename, $imagepath . $this->getThumbPrefix() . $filename)) 
                                        {
                                                $ilLog->write("matching question image thumbnail could not be duplicated: $imagepath_original" . $this->getThumbPrefix() . $filename);
                                        }
                                }
                        }
                }
        }

        public function copyImages($question_id, $source_questionpool)
        {
                global $ilLog;
                
                $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);
                foreach ($this->terms as $term)
                {
                        if (strlen($term->picture))
                        {
                                if (!file_exists($imagepath))
                                {
                                        ilUtil::makeDirParents($imagepath);
                                }
                                $filename = $term->picture;
                                if (!@copy($imagepath_original . $filename, $imagepath . $filename)) 
                                {
                                        $ilLog->write("matching question image could not be copied: $imagepath_original$filename");
                                }
                                if (!@copy($imagepath_original . $this->getThumbPrefix() . $filename, $imagepath . $this->getThumbPrefix() . $filename)) 
                                {
                                        $ilLog->write("matching question image thumbnail could not be copied: $imagepath_original" . $this->getThumbPrefix() . $filename);
                                }
                        }
                }
                foreach ($this->definitions as $definition)
                {
                        if (strlen($definition->picture))
                        {
                                $filename = $definition->picture;
                                if (!file_exists($imagepath))
                                {
                                        ilUtil::makeDirParents($imagepath);
                                }

                                if( assQuestion::isFileAvailable($imagepath_original . $filename) )
                                {
                                        copy($imagepath_original . $filename, $imagepath . $filename);
                                }
                                else
                                {
                                        $ilLog->write("matching question image could not be copied: $imagepath_original$filename");
                                }
                                
                                if( assQuestion::isFileAvailable($imagepath_original . $this->getThumbPrefix() . $filename) )
                                {
                                        copy($imagepath_original . $this->getThumbPrefix() . $filename, $imagepath . $this->getThumbPrefix() . $filename);
                                }
                                else
                                {
                                        $ilLog->write("matching question image thumbnail could not be copied: $imagepath_original" . $this->getThumbPrefix() . $filename);
                                }
                        }
                }
        }

        public function insertMatchingPair($position, $term = null, $definition = null, $points = 0.0)
        {
                include_once "./Modules/TestQuestionPool/classes/class.assAnswerMatchingPair.php";
                include_once "./Modules/TestQuestionPool/classes/class.assAnswerMatchingTerm.php";
                include_once "./Modules/TestQuestionPool/classes/class.assAnswerMatchingDefinition.php";
                if (is_null($term)) $term = new assAnswerMatchingTerm();
                if (is_null($definition)) $definition = new assAnswerMatchingDefinition();
                $pair = new assAnswerMatchingPair($term, $definition, $points);
                if ($position < count($this->matchingpairs))
                {
                        $part1 = array_slice($this->matchingpairs, 0, $position);
                        $part2 = array_slice($this->matchingpairs, $position);
                        $this->matchingpairs = array_merge($part1, array($pair), $part2);
                }
                else
                {
                        array_push($this->matchingpairs, $pair);
                }
        }

        public function addMatchingPair($term = null, $definition = null, $points = 0.0)
        {
                require_once './Modules/TestQuestionPool/classes/class.assAnswerMatchingPair.php';
                require_once './Modules/TestQuestionPool/classes/class.assAnswerMatchingTerm.php';
                require_once './Modules/TestQuestionPool/classes/class.assAnswerMatchingDefinition.php';
                if (is_null($term)) 
                {
                        $term = new assAnswerMatchingTerm();
                }
                if (is_null($definition)) 
                {
                        $definition = new assAnswerMatchingDefinition();
                }
                $pair = new assAnswerMatchingPair($term, $definition, $points);
                array_push($this->matchingpairs, $pair);
        }

        public function getTermWithIdentifier($a_identifier)
        {
                foreach ($this->terms as $term)
                {
                        if ($term->identifier == $a_identifier) return $term;
                }
                return null;
        }

        public function getDefinitionWithIdentifier($a_identifier)
        {
                foreach ($this->definitions as $definition)
                {
                        if ($definition->identifier == $a_identifier) return $definition;
                }
                return null;
        }

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

        public function deleteMatchingPair($index = 0)
        {
                if ($index < 0)
                {
                        return;
                }
                if (count($this->matchingpairs) < 1)
                {
                        return;
                }
                if ($index >= count($this->matchingpairs))
                {
                        return;
                }
                unset($this->matchingpairs[$index]);
                $this->matchingpairs = array_values($this->matchingpairs);
        }

        public function flushMatchingPairs()
        {
                $this->matchingpairs = array();
        }

        public function getMatchingPairCount()
        {
                return count($this->matchingpairs);
        }

        public function getTerms()
        {
                return $this->terms;
        }
        
        public function getDefinitions()
        {
                return $this->definitions;
        }
        
        public function getTermCount()
        {
                return count($this->terms);
        }
        
        public function getDefinitionCount()
        {
                return count($this->definitions);
        }
        
        public function addTerm($term)
        {
                array_push($this->terms, $term);
        }
        
        public function addDefinition($definition)
        {
                array_push($this->definitions, $definition);
        }
        
        public function insertTerm($position, $term = null)
        {
                if (is_null($term))
                {
                        include_once "./Modules/TestQuestionPool/classes/class.assAnswerMatchingTerm.php";
                        $term = new assAnswerMatchingTerm();
                }
                if ($position < count($this->terms))
                {
                        $part1 = array_slice($this->terms, 0, $position);
                        $part2 = array_slice($this->terms, $position);
                        $this->terms = array_merge($part1, array($term), $part2);
                }
                else
                {
                        array_push($this->terms, $term);
                }
        }
        
        public function insertDefinition($position, $definition = null)
        {
                if (is_null($definition))
                {
                        include_once "./Modules/TestQuestionPool/classes/class.assAnswerMatchingDefinition.php";
                        $definition = new assAnswerMatchingDefinition();
                }
                if ($position < count($this->definitions))
                {
                        $part1 = array_slice($this->definitions, 0, $position);
                        $part2 = array_slice($this->definitions, $position);
                        $this->definitions = array_merge($part1, array($definition), $part2);
                }
                else
                {
                        array_push($this->definitions, $definition);
                }
        }
        
        public function flushTerms()
        {
                $this->terms = array();
        }

        public function flushDefinitions()
        {
                $this->definitions = array();
        }

        public function deleteTerm($position)
        {
                unset($this->terms[$position]);
                $this->terms = array_values($this->terms);
        }

        public function deleteDefinition($position)
        {
                unset($this->definitions[$position]);
                $this->definitions = array_values($this->definitions);
        }

        public function setTerm($term, $index)
        {
                $this->terms[$index] = $term;
        }

        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 = $this->getCurrentSolutionResultSet($active_id, $pass);
                while ($data = $ilDB->fetchAssoc($result))
                {
                        if (strcmp($data["value1"], "") != 0)
                        {
                                if( !isset($found_values[$data['value2']]) )
                                {
                                        $found_values[$data['value2']] = array();
                                }
                                
                                $found_values[$data['value2']][] = $data['value1'];
                        }
                }
                
                $points = $this->calculateReachedPointsForSolution($found_values);

                return $points;
        }

        function getMaximumPoints()
        {
                $points = 0;

                foreach( $this->getMaximumScoringMatchingPairs() as $pair )
                {
                        $points += $pair->points;
                }

                return $points;
        }

        public function getMaximumScoringMatchingPairs()
        {
                if( $this->getMatchingMode() == self::MATCHING_MODE_N_ON_N )
                {
                        return $this->getPositiveScoredMatchingPairs();
                }
                elseif( $this->getMatchingMode() == self::MATCHING_MODE_1_ON_1 )
                {
                        return $this->getMostPositiveScoredUniqueTermMatchingPairs();
                }

                return array();
        }

        private function getPositiveScoredMatchingPairs()
        {
                $matchingPairs = array();

                foreach( $this->matchingpairs as $pair )
                {
                        if( $pair->points <= 0 )
                        {
                                continue;
                        }

                        $matchingPairs[] = $pair;
                }

                return $matchingPairs;
        }

        private function getMostPositiveScoredUniqueTermMatchingPairs()
        {
                $matchingPairsByDefinition = array();

                foreach( $this->matchingpairs as $pair )
                {
                        if( $pair->points <= 0 )
                        {
                                continue;
                        }

                        $defId = $pair->definition->identifier;

                        if( !isset($matchingPairsByDefinition[$defId]) )
                        {
                                $matchingPairsByDefinition[$defId] = $pair;
                        }
                        elseif( $pair->points > $matchingPairsByDefinition[$defId]->points )
                        {
                                $matchingPairsByDefinition[$defId] = $pair;
                        }
                }

                return $matchingPairsByDefinition;
        }

        public function getEncryptedFilename($filename)
        {
                $extension = "";
                if (preg_match("/.*\\.(\\w+)$/", $filename, $matches))
                {
                        $extension = $matches[1];
                }
                return md5($filename) . "." . $extension;
        }

        public function removeTermImage($index)
        {
                $term = $this->terms[$index];
                if (is_object($term))
                {
                        $this->deleteImagefile($term->picture);
                        $term->picture = null;
                }
        }
        
        public function removeDefinitionImage($index)
        {
                $definition = $this->definitions[$index];
                if (is_object($definition))
                {
                        $this->deleteImagefile($definition->picture);
                        $definition->picture = null;
                }
        }
        

        public function deleteImagefile($filename)
        {
                $deletename = $filename;
                $result = @unlink($this->getImagePath().$deletename);
                $result = $result & @unlink($this->getImagePath().$this->getThumbPrefix() . $deletename);
                return $result;
        }

        function setImageFile($image_tempfilename, $image_filename, $previous_filename = '')
        {
                $result = TRUE;
                if (strlen($image_tempfilename))
                {
                        $image_filename = str_replace(" ", "_", $image_filename);
                        $imagepath = $this->getImagePath();
                        if (!file_exists($imagepath))
                        {
                                ilUtil::makeDirParents($imagepath);
                        }
                        $savename = $image_filename;
                        if (!ilUtil::moveUploadedFile($image_tempfilename, $savename, $imagepath.$savename))
                        {
                                $result = FALSE;
                        }
                        else
                        {
                                // create thumbnail file
                                $thumbpath = $imagepath . $this->getThumbPrefix() . $savename;
                                ilUtil::convertImage($imagepath.$savename, $thumbpath, "JPEG", $this->getThumbGeometry());
                        }
                        if ($result && (strcmp($image_filename, $previous_filename) != 0) && (strlen($previous_filename)))
                        {
                                $this->deleteImagefile($previous_filename);
                        }
                }
                return $result;
        }

        private function fetchSubmittedMatchingsFromPost()
        {
                $postData = $_POST['matching'][$this->getId()];

                $matchings = array();

                foreach( $this->getDefinitions() as $definition )
                {
                        if( isset($postData[$definition->identifier]) )
                        {
                                foreach( $this->getTerms() as $term )
                                {
                                        if( isset($postData[$definition->identifier][$term->identifier]) )
                                        {
                                                if( !is_array($postData[$definition->identifier]) )
                                                {
                                                        $postData[$definition->identifier] = array();
                                                }

                                                $matchings[$definition->identifier][] = $term->identifier;
                                        }
                                }
                        }
                }

                return $matchings;
        }

        private function checkSubmittedMatchings($submittedMatchings)
        {
                if( $this->getMatchingMode() == self::MATCHING_MODE_N_ON_N )
                {
                        return true;
                }

                $handledTerms = array();

                foreach( $submittedMatchings as $definition => $terms )
                {
                        if( count($terms) > 1 )
                        {
                                ilUtil::sendFailure($this->lng->txt("multiple_matching_values_selected"), true);
                                return false;
                        }

                        foreach( $terms as $i => $term )
                        {
                                if( isset($handledTerms[$term]) )
                                {
                                        ilUtil::sendFailure($this->lng->txt("duplicate_matching_values_selected"), true);
                                        return false;
                                }

                                $handledTerms[$term] = $term;
                        }
                }

                return true;
        }

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

                $submittedMatchings = $this->fetchSubmittedMatchingsFromPost();
                $submittedMatchingsValid = $this->checkSubmittedMatchings($submittedMatchings);

                $matchingsExist = false;

                if ($submittedMatchingsValid)
                {
                        if (is_null($pass))
                        {
                                include_once "./Modules/Test/classes/class.ilObjTest.php";
                                $pass = ilObjTest::_getPass($active_id);
                        }
                        
                        $this->getProcessLocker()->requestUserSolutionUpdateLock();

                        $affectedRows = $this->removeCurrentSolution($active_id, $pass);

                        foreach( $submittedMatchings as $definition => $terms )
                        {
                                foreach( $terms as $i => $term )
                                {
                                        $affectedRows = $this->saveCurrentSolution($active_id, $pass, $term, $definition);

                                        $matchingsExist = true;
                                }
                        }

                        $this->getProcessLocker()->releaseUserSolutionUpdateLock();
                        
                        $saveWorkingDataResult = true;
                }
                else
                {
                        $saveWorkingDataResult = false;
                }

                include_once ("./Modules/Test/classes/class.ilObjAssessmentFolder.php");
                if( ilObjAssessmentFolder::_enabledAssessmentLogging() )
                {
                        if( $matchingsExist )
                        {
                                $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 $saveWorkingDataResult;
        }

        protected function savePreviewData(ilAssQuestionPreviewSession $previewSession)
        {
                $submittedMatchings = $this->fetchSubmittedMatchingsFromPost();

                if( $this->checkSubmittedMatchings($submittedMatchings) )
                {
                        $previewSession->setParticipantsSolution($submittedMatchings);
                }
        }

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

        public function getRandomId()
        {
                mt_srand((double)microtime()*1000000);
                $random_number = mt_rand(1, 100000);
                $found = FALSE;
                while ($found)
                {
                        $found = FALSE;
                        foreach ($this->matchingpairs as $key => $pair)
                        {
                                if (($pair->term->identifier == $random_number) || ($pair->definition->identifier == $random_number))
                                {
                                        $found = TRUE;
                                        $random_number++;
                                }
                        }
                }
                return $random_number;
        }

        public function setShuffle($shuffle)
        {
                switch ($shuffle)
                {
                        case 0:
                        case 1:
                        case 2:
                        case 3:
                                $this->shuffle = $shuffle;
                                break;
                        default:
                                $this->shuffle = 1;
                                break;
                }
        }

        public function getQuestionType()
        {
                return "assMatchingQuestion";
        }
        
        public function getAdditionalTableName()
        {
                return "qpl_qst_matching";
        }

        public function getAnswerTableName()
        {
                return array("qpl_a_matching", "qpl_a_mterm");
        }

        public function getRTETextWithMediaObjects()
        {
                return parent::getRTETextWithMediaObjects();
        }
        
        public function &getMatchingPairs()
        {
                return $this->matchingpairs;
        }

        public function setExportDetailsXLS(&$worksheet, $startrow, $active_id, $pass, &$format_title, &$format_bold)
        {
                include_once ("./Services/Excel/classes/class.ilExcelUtils.php");
                $solutions = $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);
                $imagepath = $this->getImagePath();
                $i = 1;
                foreach ($solutions as $solution)
                {
                        $matches_written = FALSE;
                        foreach ($this->getMatchingPairs() as $idx => $pair)
                        {
                                if (!$matches_written) $worksheet->writeString($startrow + $i, 1, ilExcelUtils::_convert_text($this->lng->txt("matches")));
                                $matches_written = TRUE;
                                if ($pair->definition->identifier == $solution["value2"])
                                {
                                        if (strlen($pair->definition->text))
                                        {
                                                $worksheet->writeString($startrow + $i, 0, ilExcelUtils::_convert_text($pair->definition->text));
                                        }
                                        else
                                        {
                                                $worksheet->writeString($startrow + $i, 0, ilExcelUtils::_convert_text($pair->definition->picture));
                                        }
                                }
                                if ($pair->term->identifier == $solution["value1"])
                                {
                                        if (strlen($pair->term->text))
                                        {
                                                $worksheet->writeString($startrow + $i, 2, ilExcelUtils::_convert_text($pair->term->text));
                                        }
                                        else
                                        {
                                                $worksheet->writeString($startrow + $i, 2, ilExcelUtils::_convert_text($pair->term->picture));
                                        }
                                }
                        }
                        $i++;
                }
                return $startrow + $i + 1;
        }
        
        public function getThumbGeometry()
        {
                return $this->thumb_geometry;
        }
        
        public function getThumbSize()
        {
                return $this->getThumbGeometry();
        }
        
        public function setThumbGeometry($a_geometry)
        {
                $this->thumb_geometry = ($a_geometry < 1) ? 100 : $a_geometry;
        }

        public function rebuildThumbnails()
        {
                foreach ($this->terms as $term)
                {
                        if (strlen($term->picture)) $this->generateThumbForFile($this->getImagePath(), $term->picture);
                }
                foreach ($this->definitions as $definition)
                {
                        if (strlen($definition->picture)) $this->generateThumbForFile($this->getImagePath(), $definition->picture);
                }
        }
        
        public function getThumbPrefix()
        {
                return "thumb.";
        }
        
        protected function generateThumbForFile($path, $file)
        {
                $filename = $path . $file;
                if (@file_exists($filename))
                {
                        $thumbpath = $path . $this->getThumbPrefix() . $file;
                        $path_info = @pathinfo($filename);
                        $ext = "";
                        switch (strtoupper($path_info['extension']))
                        {
                                case 'PNG':
                                        $ext = 'PNG';
                                        break;
                                case 'GIF':
                                        $ext = 'GIF';
                                        break;
                                default:
                                        $ext = 'JPEG';
                                        break;
                        }
                        ilUtil::convertImage($filename, $thumbpath, $ext, $this->getThumbGeometry());
                }
        }

        public function toJSON()
        {
                $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['matching_mode'] = $this->getMatchingMode();
                $result['shuffle'] = true;
                $result['feedback'] = array(
                        'onenotcorrect' => $this->formatSAQuestion($this->feedbackOBJ->getGenericFeedbackTestPresentation($this->getId(), false)),
                        'allcorrect' => $this->formatSAQuestion($this->feedbackOBJ->getGenericFeedbackTestPresentation($this->getId(), true))
                );
                                
                $terms = array();
                foreach ($this->getTerms() as $term)
                {
                        $terms[] = array(
                                "text" => $term->text,
                                "id" =>(int)$term->identifier
                        );
                }
                $result['terms'] = $terms;

                // alex 9.9.2010 as a fix for bug 6513 I added the question id
                // to the "def_id" in the array. The $pair->definition->identifier is not
                // unique, since it gets it value from the morder table field
                // this value is not changed, when a question is copied.
                // thus copying the same question on a page results in problems
                // when the second one (the copy) is answered.

                $definitions = array();
                foreach ($this->getDefinitions() as $def)
                {
                        $definitions[] = array(
                                "text" => (string) $def->text,
                                "id" => (int) $this->getId().$def->identifier
                        );
                }
                $result['definitions'] = $definitions;
                
                // #10353
                $matchings = array();
                foreach ($this->getMatchingPairs() as $pair)
                {                       
                        $pid = $pair->definition->identifier;
                        if( $this->getMatchingMode() == self::MATCHING_MODE_N_ON_N )
                        {
                                $pid .= '::'.$pair->term->identifier;
                        }
                        
                        if( !isset($matchings[$pid]) || $matchings[$pid]["points"] < $pair->points )
                        {
                                $matchings[$pid] = array(
                                        "term_id" => (int) $pair->term->identifier,
                                        "def_id" => (int) $this->getId().$pair->definition->identifier,
                                        "points" => (int) $pair->points
                                );
                        }
                }
                
                $result['matchingPairs'] = array_values($matchings);
                        
                $mobs = ilObjMediaObject::_getMobsOfObject("qpl:html", $this->getId());
                $result['mobs'] = $mobs;
                
                global $lng;
                $lng->loadLanguageModule('assessment');
                $result['reset_button_label'] = $lng->txt("reset_terms");

                return json_encode($result);
        }
        
        public function supportsJavascriptOutput()
        {
                return true;
        }

        public function supportsNonJsOutput()
        {
                return false;
        }

        public function setMatchingMode($matchingMode)
        {
                $this->matchingMode = $matchingMode;
        }

        public function getMatchingMode()
        {
                return $this->matchingMode;
        }

        protected function calculateReachedPointsForSolution($found_values)
        {
                $points = 0;
                foreach($found_values as $definition => $terms)
                {
                        foreach($terms as $term)
                        {
                                foreach($this->matchingpairs as $pair)
                                {
                                        if($pair->definition->identifier == $definition && $pair->term->identifier == $term)
                                        {
                                                $points += $pair->points;
                                        }
                                }
                        }
                }
                return $points;
        }

        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::MatchingResultExpression,
                        iQuestionCondition::EmptyAnswerExpression,
                );
        }
        public function getUserQuestionResult($active_id, $pass)
        {
                global $ilDB;
                $result = new ilUserQuestionResult($this, $active_id, $pass);

                $data = $ilDB->queryF(
                        "SELECT morder FROM qpl_a_mdef WHERE question_fi = %s ORDER BY def_id",
                        array("integer"),
                        array($this->getId())
                );

                $definitions = array();
                for($index=1; $index <= $ilDB->numRows($data); ++$index)
                {
                        $row = $ilDB->fetchAssoc($data);
                        $definitions[$row["morder"]] = $index;
                }

                $data = $ilDB->queryF(
                        "SELECT ident FROM qpl_a_mterm WHERE question_fi = %s ORDER BY term_id",
                        array("integer"),
                        array($this->getId())
                );

                $terms = array();
                for($index=1; $index <= $ilDB->numRows($data); ++$index)
                {
                        $row = $ilDB->fetchAssoc($data);
                        $terms[$row["ident"]] = $index;
                }

                $data = $ilDB->queryF(
                        "SELECT value1, value2 FROM tst_solutions WHERE active_fi = %s AND pass = %s AND question_fi = %s AND step = (
                                SELECT MAX(step) FROM tst_solutions WHERE active_fi = %s AND pass = %s AND question_fi = %s
                        )",
                        array("integer", "integer", "integer","integer", "integer", "integer"),
                        array($active_id, $pass, $this->getId(), $active_id, $pass, $this->getId())
                );

                while($row = $ilDB->fetchAssoc($data))
                {
                        if($row["value1"] > 0)
                        {
                                $result->addKeyValue($definitions[$row["value2"]],$terms[$row["value1"]]);
                        }
                }

                $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->getMatchingPair($index);
                }
                else
                {
                        return $this->getMatchingPairs();
                }
        }

        protected function afterSyncWithOriginal($origQuestionId, $dupQuestionId, $origParentObjId, $dupParentObjId)
        {
                parent::afterSyncWithOriginal($origQuestionId, $dupQuestionId, $origParentObjId, $dupParentObjId);

                $origImagePath = $this->buildImagePath($origQuestionId, $origParentObjId);
                $dupImagePath  = $this->buildImagePath($dupQuestionId, $dupParentObjId);

                ilUtil::delDir($origImagePath);
                if(is_dir($dupImagePath))
                {
                        ilUtil::makeDirParents($origImagePath);
                        ilUtil::rCopy($dupImagePath, $origImagePath);
                }
        }
}