class.assFlashQuestion.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.iQuestionCondition.php';

class assFlashQuestion extends assQuestion implements ilObjQuestionScoringAdjustable, iQuestionCondition
{
    private $width;
    private $height;
    private $parameters;
    private $applet;

    public function __construct(
        $title = "",
        $comment = "",
        $author = "",
        $owner = -1,
        $question = ""
    ) {
        parent::__construct($title, $comment, $author, $owner, $question);
        $this->parameters = array();
        $this->width = 540;
        $this->height = 400;
        $this->applet = "";
    }
    
    public function isComplete()
    {
        if (strlen($this->title)
            && ($this->author)
            && ($this->question)
            && ($this->getMaximumPoints() > 0)
            && (strlen($this->getApplet()))
        ) {
            return true;
        }
        return false;
    }

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

    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, width, height, applet, params) VALUES (%s, %s, %s, %s, %s)",
            array( "integer", "integer", "integer", "text", "text" ),
            array(
                                $this->getId(),
                                (strlen($this->getWidth())) ? $this->getWidth() : 550,
                                (strlen($this->getHeight())) ? $this->getHeight() : 400,
                                $this->getApplet(),
                                serialize($this->getParameters())
                            )
        );

        try {
            $this->moveAppletIfExists();
        } catch (\ilFileUtilsException $e) {
            \ilLoggerFactory::getRootLogger()->error($e->getMessage());
        }
    }

    protected function moveAppletIfExists()
    {
        if (
            isset($_SESSION['flash_upload_filename']) && is_string($_SESSION['flash_upload_filename']) &&
            file_exists($_SESSION['flash_upload_filename']) && is_file($_SESSION['flash_upload_filename'])
        ) {
            $path = $this->getFlashPath();
            \ilUtil::makeDirParents($path);

            require_once 'Services/Utilities/classes/class.ilFileUtils.php';
            \ilFileUtils::rename($_SESSION['flash_upload_filename'], $path . $this->getApplet());
            unset($_SESSION['flash_upload_filename']);
        }
    }

    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->setTitle($data["title"]);
            $this->setComment($data["description"]);
            $this->setSuggestedSolution($data["solution_hint"]);
            $this->setOriginalId($data["original_id"]);
            $this->setObjId($data["obj_fi"]);
            $this->setAuthor($data["author"]);
            $this->setOwner($data["owner"]);
            $this->setPoints($data["points"]);

            include_once("./Services/RTE/classes/class.ilRTE.php");
            $this->setQuestion(ilRTE::_replaceMediaObjectImageSrc($data["question_text"], 1));
            $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) {
            }
            
            // load additional data
            $result = $ilDB->queryF(
                "SELECT * FROM " . $this->getAdditionalTableName() . " WHERE question_fi = %s",
                array("integer"),
                array($question_id)
            );
            if ($result->numRows() == 1) {
                $data = $ilDB->fetchAssoc($result);
                $this->setWidth($data["width"]);
                $this->setHeight($data["height"]);
                $this->setApplet($data["applet"]);
                $this->parameters = unserialize($data["params"]);
                if (!is_array($this->parameters)) {
                    $this->clearParameters();
                }
                unset($_SESSION["flash_upload_filename"]);
            }
        }
        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 applet
        $clone->duplicateApplet($this_id, $thisObjId);

        $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 applet
        $clone->copyApplet($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 applet
        $clone->copyApplet($sourceQuestionId, $sourceParentId);

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

        return $clone->id;
    }

    protected function duplicateApplet($question_id, $objectId = null)
    {
        $flashpath = $this->getFlashPath();
        $flashpath_original = preg_replace("/([^\d])$this->id([^\d])/", "\${1}$question_id\${2}", $flashpath);
        
        if ((int) $objectId > 0) {
            $flashpath_original = str_replace("/$this->obj_id/", "/$objectId/", $flashpath_original);
        }
        
        if (!file_exists($flashpath)) {
            ilUtil::makeDirParents($flashpath);
        }
        $filename = $this->getApplet();
        if (!copy($flashpath_original . $filename, $flashpath . $filename)) {
            print "flash applet could not be duplicated!!!! ";
        }
    }

    protected function copyApplet($question_id, $source_questionpool)
    {
        $flashpath = $this->getFlashPath();
        $flashpath_original = preg_replace("/([^\d])$this->id([^\d])/", "\${1}$question_id\${2}", $flashpath);
        $flashpath_original = str_replace("/$this->obj_id/", "/$source_questionpool/", $flashpath_original);
        if (!file_exists($flashpath)) {
            ilUtil::makeDirParents($flashpath);
        }
        $filename = $this->getApplet();
        if (!copy($flashpath_original . $filename, $flashpath . $filename)) {
            print "flash applet could not be copied!!!! ";
        }
    }

    public function getMaximumPoints()
    {
        return $this->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;
        
        $found_values = array();
        if (is_null($pass)) {
            $pass = $this->getSolutionMaxPass($active_id);
        }

        $result = $this->getCurrentSolutionResultSet($active_id, $pass, $authorizedSolution);

        $points = 0;
        while ($data = $ilDB->fetchAssoc($result)) {
            $points += $data["points"];
        }

        return $points;
    }

    public function calculateReachedPointsFromPreviewSession(ilAssQuestionPreviewSession $previewSession)
    {
        $points = 0;
        foreach ($previewSession->getParticipantsSolution() as $solution) {
            if (isset($solution['points'])) {
                $points += $solution['points'];
            }
        }
        
        $reachedPoints = $this->deductHintPointsFromReachedPoints($previewSession, $points);
        
        return $this->ensureNonNegativePoints($reachedPoints);
    }
    
    public function sendToHost($url, $data, $optional_headers = null)
    {
        $params = array('http' => array(
            'method' => 'POST',
            'content' => $data
        ));
        if ($optional_headers !== null) {
            $params['http']['header'] = $optional_headers;
        }
        $ctx = stream_context_create($params);
        $fp = @fopen($url, 'rb', false, $ctx);
        if (!$fp) {
            throw new Exception("Problem with $url, $php_errormsg");
        }
        $response = @stream_get_contents($fp);
        if ($response === false) {
            throw new Exception("Problem reading data from $url, $php_errormsg");
        }
        return $response;
    }
    
    public function moveUploadedFile($tmpfile, $flashfile)
    {
        $result = "";
        if (!empty($tmpfile)) {
            $flashfile = str_replace(" ", "_", $flashfile);
            $flashpath = $this->getFlashPath();
            if (!file_exists($flashpath)) {
                ilUtil::makeDirParents($flashpath);
            }
            if (ilUtil::moveUploadedFile($tmpfile, $flashfile, $flashpath . $flashfile)) {
                $result = $flashfile;
            }
        }
        return $result;
    }

    public function deleteApplet()
    {
        @unlink($this->getFlashPath() . $this->getApplet());
        $this->applet = "";
    }
    
    public function saveWorkingData($active_id, $pass = null, $authorized = true)
    {
        // nothing to save!

        //$this->getProcessLocker()->requestUserSolutionUpdateLock();
        // store in tst_solutions
        //$this->getProcessLocker()->releaseUserSolutionUpdateLock();
        
        return true;
    }

    protected function savePreviewData(ilAssQuestionPreviewSession $previewSession)
    {
        // nothing to save!

        return true;
    }

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

    public function getQuestionType()
    {
        return "assFlashQuestion";
    }
    
    public function getAdditionalTableName()
    {
        return "qpl_qst_flash";
    }
    
    public function getAnswerTableName()
    {
        return "";
    }
    
    public function deleteAnswers($question_id)
    {
    }

    public function getRTETextWithMediaObjects()
    {
        $text = parent::getRTETextWithMediaObjects();
        return $text;
    }

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

        return $startrow + 1;
    }
    
    public function fromXML(&$item, &$questionpool_id, &$tst_id, &$tst_object, &$question_counter, &$import_mapping)
    {
        include_once "./Modules/TestQuestionPool/classes/import/qti12/class.assFlashQuestionImport.php";
        $import = new assFlashQuestionImport($this);
        $import->fromXML($item, $questionpool_id, $tst_id, $tst_object, $question_counter, $import_mapping);
    }
    
    public function toXML($a_include_header = true, $a_include_binary = true, $a_shuffle = false, $test_output = false, $force_image_references = false)
    {
        include_once "./Modules/TestQuestionPool/classes/export/qti12/class.assFlashQuestionExport.php";
        $export = new assFlashQuestionExport($this);
        return $export->toXML($a_include_header, $a_include_binary, $a_shuffle, $test_output, $force_image_references);
    }

    public function getBestSolution($active_id, $pass)
    {
        $user_solution = array();
        return $user_solution;
    }
    
    public function setHeight($a_height)
    {
        if (!$a_height) {
            $a_height = 400;
        }
        $this->height = $a_height;
    }
    
    public function getHeight()
    {
        return $this->height;
    }

    public function setWidth($a_width)
    {
        if (!$a_width) {
            $a_width = 550;
        }
        $this->width = $a_width;
    }
    
    public function getWidth()
    {
        return $this->width;
    }
    
    public function setApplet($a_applet)
    {
        $this->applet = $a_applet;
    }
    
    public function getApplet()
    {
        return $this->applet;
    }
    
    public function addParameter($name, $value)
    {
        $this->parameters[$name] = $value;
    }
    
    public function setParameters($params)
    {
        if (is_array($params)) {
            $this->parameters = $params;
        } else {
            $this->parameters = array();
        }
    }
    
    public function removeParameter($name)
    {
        unset($this->parameters[$name]);
    }
    
    public function clearParameters()
    {
        $this->parameters = array();
    }
    
    public function getParameters()
    {
        return $this->parameters;
    }
    
    public function isAutosaveable()
    {
        return false;
    }

    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::EmptyAnswerExpression,
        );
    }

    public function getUserQuestionResult($active_id, $pass)
    {
        // TODO: Implement getUserQuestionResult() method.
    }
    
    public function getAvailableAnswerOptions($index = null)
    {
        // TODO: Implement getAvailableAnswerOptions() method.
    }

    // fau: testNav - new function getTestQuestionConfig()
    // hey: refactored identifiers
    public function buildTestPresentationConfig()
        // hey.
    {
        // hey: refactored identifiers
        return parent::buildTestPresentationConfig()
            // hey.
            ->setFormChangeDetectionEnabled(false)
            ->setBackgroundChangeDetectionEnabled(true);
    }
    // fau.
}