class.assJavaApplet.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';
require_once './Modules/TestQuestionPool/classes/class.ilUserQuestionResult.php';

class assJavaApplet extends assQuestion implements ilObjQuestionScoringAdjustable, iQuestionCondition
{
    public $javaapplet_filename;

    public $java_code;

    public $java_codebase;

    public $java_archive;

    public $java_width;

    public $java_height;

    public $parameters;

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

    public function splitParams($params = "")
    {
        $params_array = explode("<separator>", $params);
        foreach ($params_array as $pair) {
            if (preg_match("/(.*?)\=(.*)/", $pair, $matches)) {
                switch ($matches[1]) {
                    case "java_code":
                        $this->java_code = $matches[2];
                        break;
                    case "java_codebase":
                        $this->java_codebase = $matches[2];
                        break;
                    case "java_archive":
                        $this->java_archive = $matches[2];
                        break;
                    case "java_width":
                        $this->java_width = $matches[2];
                        break;
                    case "java_height":
                        $this->java_height = $matches[2];
                        break;
                }
                if (preg_match("/param_name_(\d+)/", $matches[1], $found_key)) {
                    $this->parameters[$found_key[1]]["name"] = $matches[2];
                }
                if (preg_match("/param_value_(\d+)/", $matches[1], $found_key)) {
                    $this->parameters[$found_key[1]]["value"] = $matches[2];
                }
            }
        }
    }

    public function buildParams()
    {
        $params_array = array();
        if ($this->java_code) {
            array_push($params_array, "java_code=$this->java_code");
        }
        if ($this->java_codebase) {
            array_push($params_array, "java_codebase=$this->java_codebase");
        }
        if ($this->java_archive) {
            array_push($params_array, "java_archive=$this->java_archive");
        }
        if ($this->java_width) {
            array_push($params_array, "java_width=$this->java_width");
        }
        if ($this->java_height) {
            array_push($params_array, "java_height=$this->java_height");
        }
        foreach ($this->parameters as $key => $value) {
            array_push($params_array, "param_name_$key=" . $value["name"]);
            array_push($params_array, "param_value_$key=" . $value["value"]);
        }
        
        return join("<separator>", $params_array);
    }

    public function buildParamsOnly()
    {
        $params_array = array();
        if ($this->java_code) {
            array_push($params_array, "java_code=$this->java_code");
            array_push($params_array, "java_codebase=$this->java_codebase");
            array_push($params_array, "java_archive=$this->java_archive");
        }
        foreach ($this->parameters as $key => $value) {
            array_push($params_array, "param_name_$key=" . $value["name"]);
            array_push($params_array, "param_value_$key=" . $value["value"]);
        }
        return join("<separator>", $params_array);
    }

    public function isComplete()
    {
        if (strlen($this->title)
            && $this->author
            && $this->question
            && $this->javaapplet_filename
            && $this->java_width
            && $this->java_height
            && $this->getPoints() > 0
        ) {
            return true;
        } elseif (strlen($this->title)
            && $this->author
            && $this->question
            && $this->getJavaArchive()
            && $this->getJavaCodebase()
            && $this->java_width
            && $this->java_height
            && $this->getPoints() > 0
        ) {
            return true;
        }
        return false;
    }


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

    public function saveAdditionalQuestionDataToDb()
    {
        global $DIC;
        $ilDB = $DIC['ilDB'];
        $params = $this->buildParams();
        // save additional data
        $ilDB->manipulateF(
            "DELETE FROM " . $this->getAdditionalTableName() . " WHERE question_fi = %s",
            array( "integer" ),
            array( $this->getId() )
        );
        $ilDB->manipulateF(
            "INSERT INTO " . $this->getAdditionalTableName(
                                                            ) . " (question_fi, image_file, params) VALUES (%s, %s, %s)",
            array( "integer", "text", "text" ),
            array(
                                $this->getId(),
                                $this->javaapplet_filename,
                                $params
                            )
        );
    }

    public function loadFromDb($question_id)
    {
        global $DIC;
        $ilDB = $DIC['ilDB'];

        $result = $ilDB->queryF(
            "SELECT qpl_questions.*, " . $this->getAdditionalTableName() . ".* FROM qpl_questions LEFT JOIN " . $this->getAdditionalTableName() . " ON " . $this->getAdditionalTableName() . ".question_fi = qpl_questions.question_id WHERE qpl_questions.question_id = %s",
            array("integer"),
            array($question_id)
        );
        if ($result->numRows() == 1) {
            $data = $ilDB->fetchAssoc($result);
            $this->setId($question_id);
            $this->setObjId($data["obj_fi"]);
            $this->setNrOfTries($data['nr_of_tries']);
            $this->setTitle($data["title"]);
            $this->setComment($data["description"]);
            $this->setOriginalId($data["original_id"]);
            $this->setAuthor($data["author"]);
            $this->setPoints($data["points"]);
            $this->setOwner($data["owner"]);
            include_once("./Services/RTE/classes/class.ilRTE.php");
            $this->setQuestion(ilRTE::_replaceMediaObjectImageSrc($data["question_text"], 1));
            $this->setJavaAppletFilename($data["image_file"]);
            $this->splitParams($data["params"]);
            $this->setEstimatedWorkingTime(substr($data["working_time"], 0, 2), substr($data["working_time"], 3, 2), substr($data["working_time"], 6, 2));
            
            try {
                $this->setLifecycle(ilAssQuestionLifecycle::getInstance($data['lifecycle']));
            } catch (ilTestQuestionPoolInvalidArgumentException $e) {
                $this->setLifecycle(ilAssQuestionLifecycle::getDraftInstance());
            }
            
            try {
                $this->setAdditionalContentEditingMode($data['add_cont_edit_mode']);
            } catch (ilTestQuestionPoolException $e) {
            }
        }
        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->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 image
        $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 image
        $clone->copyApplet($sourceQuestionId, $sourceParentId);

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

        return $clone->id;
    }

    public function duplicateApplet($question_id, $objectId = null)
    {
        $javapath = $this->getJavaPath();
        $javapath_original = preg_replace("/([^\d])$this->id([^\d])/", "\${1}$question_id\${2}", $javapath);
        
        if ((int) $objectId > 0) {
            $javapath_original = str_replace("/$this->obj_id/", "/$objectId/", $javapath_original);
        }
        
        if (!file_exists($javapath)) {
            ilUtil::makeDirParents($javapath);
        }
        $filename = $this->getJavaAppletFilename();
        if (!copy($javapath_original . $filename, $javapath . $filename)) {
            print "java applet could not be duplicated!!!! ";
        }
    }

    public function copyApplet($question_id, $source_questionpool)
    {
        $javapath = $this->getJavaPath();
        $javapath_original = preg_replace("/([^\d])$this->id([^\d])/", "\${1}$question_id\${2}", $javapath);
        $javapath_original = str_replace("/$this->obj_id/", "/$source_questionpool/", $javapath_original);
        if (!file_exists($javapath)) {
            ilUtil::makeDirParents($javapath);
        }
        $filename = $this->getJavaAppletFilename();
        if (!copy($javapath_original . $filename, $javapath . $filename)) {
            print "java applet could not be copied!!!! ";
        }
    }

    public function getJavaCode()
    {
        return $this->java_code;
    }

    public function getJavaCodebase()
    {
        return $this->java_codebase;
    }

    public function getJavaArchive()
    {
        return $this->java_archive;
    }

    public function setJavaCode($java_code = "")
    {
        $this->java_code = $java_code;
    }

    public function setJavaCodebase($java_codebase = "")
    {
        $this->java_codebase = $java_codebase;
    }

    public function setJavaArchive($java_archive = "")
    {
        $this->java_archive = $java_archive;
    }

    public function getJavaWidth()
    {
        return $this->java_width;
    }

    public function setJavaWidth($java_width = "")
    {
        $this->java_width = $java_width;
    }

    public function getJavaHeight()
    {
        return $this->java_height;
    }

    public function setJavaHeight($java_height = "")
    {
        $this->java_height = $java_height;
    }

    public function calculateReachedPoints($active_id, $pass = null, $authorizedSolution = true, $returndetails = false)
    {
        if ($returndetails) {
            throw new ilTestException('return details not implemented for ' . __METHOD__);
        }
        
        global $DIC;
        $ilDB = $DIC['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);
    }
    
    // hey: prevPassSolutions - bypass intermediate solution requests and deligate
    //                                                  to own implementation for requests to authorized solutions
    public function getSolutionValues($active_id, $pass = null, $authorized = true)
    {
        if (!$authorized) {
            return array();
        }
        
        return $this->getSolutionValuesRegardlessOfAuthorization($active_id, $pass);
    }
    
    public function getSolutionValuesRegardlessOfAuthorization($active_id, $pass = null)
    {
        // - similar to getSolutionValues in general
        // - does not consider "step" in any kind
        // - returns a customized associative array
        // - is the original implementation for qtype
        return $this->getReachedInformation($active_id, $pass);
    }
    // hey.

    public function getReachedInformation($active_id, $pass = null)
    {
        global $DIC;
        $ilDB = $DIC['ilDB'];
        
        $found_values = array();
        if (is_null($pass)) {
            $pass = $this->getSolutionMaxPass($active_id);
        }
        $result = $ilDB->queryF(
            "SELECT * FROM tst_solutions WHERE active_fi = %s AND question_fi = %s AND pass = %s",
            array('integer','integer','integer'),
            array($active_id, $this->getId(), $pass)
        );
        $counter = 1;
        $user_result = array();
        while ($data = $ilDB->fetchAssoc($result)) {
            $true = 0;
            if ($data["points"] > 0) {
                $true = 1;
            }
            $solution = array(
                "order" => $counter,
                "points" => $data["points"],
                "true" => $true,
                "value1" => $data["value1"],
                "value2" => $data["value2"],
            );
            $counter++;
            array_push($user_result, $solution);
        }
        return $user_result;
    }

    public function addParameter($name = "", $value = "")
    {
        $index = $this->getParameterIndex($name);
        if ($index > -1) {
            $this->parameters[$index] = array("name" => $name, "value" => $value);
        } else {
            array_push($this->parameters, array("name" => $name, "value" => $value));
        }
    }

    public function addParameterAtIndex($index = 0, $name = "", $value = "")
    {
        if (array_key_exists($index, $this->parameters)) {
            // insert parameter
            $newparams = array();
            for ($i = 0; $i < $index; $i++) {
                array_push($newparams, $this->parameters[$i]);
            }
            array_push($newparams, array($name, $value));
            for ($i = $index; $i < count($this->parameters); $i++) {
                array_push($newparams, $this->parameters[$i]);
            }
            $this->parameters = $newparams;
        } else {
            array_push($this->parameters, array($name, $value));
        }
    }

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

    public function getParameter($index)
    {
        if (($index < 0) or ($index >= count($this->parameters))) {
            return undef;
        }
        return $this->parameters[$index];
    }

    public function getParameterIndex($name)
    {
        foreach ($this->parameters as $key => $value) {
            if (array_key_exists($name, $value)) {
                return $key;
            }
        }
        return -1;
    }

    public function getParameterCount()
    {
        return count($this->parameters);
    }

    public function flushParams()
    {
        $this->parameters = array();
    }

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

    public function getJavaAppletFilename()
    {
        return $this->javaapplet_filename;
    }

    public function setJavaAppletFilename($javaapplet_filename, $javaapplet_tempfilename = "")
    {
        if (!empty($javaapplet_filename)) {
            $this->javaapplet_filename = $javaapplet_filename;
        }
        if (!empty($javaapplet_tempfilename)) {
            $javapath = $this->getJavaPath();
            if (!file_exists($javapath)) {
                ilUtil::makeDirParents($javapath);
            }
            
            if (!ilUtil::moveUploadedFile($javaapplet_tempfilename, $javaapplet_filename, $javapath . $javaapplet_filename)) {
                $ilLog->write("ERROR: java applet question: java applet not uploaded: $javaapplet_filename");
            } else {
                $this->setJavaCodebase();
                $this->setJavaArchive();
            }
        }
    }
    
    public function deleteJavaAppletFilename()
    {
        @unlink($this->getJavaPath() . $this->getJavaAppletFilename());
        $this->javaapplet_filename = "";
    }

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

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

    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;
        foreach ($solutions as $solution) {
            $worksheet->setCell($startrow + $i, 1, $this->lng->txt("result") . " $i");
            if (strlen($solution["value1"])) {
                $worksheet->setCell($startrow + $i, 1, $solution["value1"]);
            }
            if (strlen($solution["value2"])) {
                $worksheet->setCell($startrow + $i, 2, $solution["value2"]);
            }
            $i++;
        }

        return $startrow + $i + 1;
    }

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

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

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

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

        return $result;
    }

    public function getAvailableAnswerOptions($index = null)
    {
        return array();
    }

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