class.ilSoapTestAdministration.php

Go to the documentation of this file.

<?php
  /*
   +-----------------------------------------------------------------------------+
   | ILIAS open source                                                           |
   +-----------------------------------------------------------------------------+
   | Copyright (c) 1998-2001 ILIAS open source, University of Cologne            |
   |                                                                             |
   | This program is free software; you can redistribute it and/or               |
   | modify it under the terms of the GNU General Public License                 |
   | as published by the Free Software Foundation; either version 2              |
   | of the License, or (at your option) any later version.                      |
   |                                                                             |
   | This program is distributed in the hope that it will be useful,             |
   | but WITHOUT ANY WARRANTY; without even the implied warranty of              |
   | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               |
   | GNU General Public License for more details.                                |
   |                                                                             |
   | You should have received a copy of the GNU General Public License           |
   | along with this program; if not, write to the Free Software                 |
   | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA. |
   +-----------------------------------------------------------------------------+
  */
 
 
include_once './webservice/soap/classes/class.ilSoapAdministration.php';
 
class ilSoapTestAdministration extends ilSoapAdministration
{
    private function hasWritePermissionForTest($active_id)
    {
        global $ilDB;
        global $ilAccess;
 
        $permission_ok = false;
        $result = $ilDB->queryF(
            "SELECT tst_tests.obj_fi FROM tst_active, tst_tests WHERE tst_active.active_id = %s AND tst_active.test_fi = tst_tests.test_id",
            array('integer'),
            array($active_id)
        );
        $row = $ilDB->fetchAssoc($result);
        if ($row['obj_fi']) {
            $obj_id = $row['obj_fi'];
            foreach ($ref_ids = ilObject::_getAllReferences($obj_id) as $ref_id) {
                if ($ilAccess->checkAccess("write", "", $ref_id)) {
                    $permission_ok = true;
                    break;
                }
            }
        }
        return $permission_ok;
    }
    
    public function isAllowedCall($sid, $active_id, $saveaction = true)
    {
        global $ilDB;
        global $ilUser;
 
        if ($this->hasWritePermissionForTest($active_id)) {
            return true;
        }
 
        if ($saveaction) {
            $result = $ilDB->queryF(
                "SELECT * FROM tst_times WHERE active_fi = %s ORDER BY started DESC",
                array('integer'),
                array($active_id)
            );
            if ($result->numRows()) {
                $row = $ilDB->fetchAssoc($result);
                if (preg_match("/(\\d{4})-(\\d{2})-(\\d{2}) (\\d{2}):(\\d{2}):(\\d{2})/", $row["started"], $matches)) {
                    $time = mktime($matches[4], $matches[5], $matches[6], $matches[2], $matches[3], $matches[1]);
                    $now = time();
                    $diff = $now - $time;
                    $client = explode("::", $sid);
                    global $ilClientIniFile;
                    $expires = $ilClientIniFile->readVariable('session', 'expire');
                    if ($diff <= $expires) {
                        return true;
                    } else {
                        return false;
                    }
                } else {
                    return false;
                }
            } else {
                return false;
            }
        } else {
            $result = $ilDB->queryF(
                "SELECT user_fi FROM tst_active WHERE active_id = %s",
                array('integer'),
                array($active_id)
            );
            $row = $ilDB->fetchAssoc($result);
            if ($row['user_fi'] == $ilUser->getId()) {
                return true;
            } else {
                return false;
            }
        }
    }
 
    public function saveQuestion($sid, $active_id, $question_id, $pass, $solution)
    {
        $this->initAuth($sid);
        $this->initIlias();
 
        if (!$this->__checkSession($sid)) {
            return $this->__raiseError($this->__getMessage(), $this->__getMessageCode());
        }
        if (!$this->isAllowedCall($sid, $active_id)) {
            return $this->__raiseError("The required user information is only available for active users.", "");
        }
        
        if (is_array($solution) && (array_key_exists("item", $solution))) {
            $solution = $solution["item"];
        }
 
        global $ilDB, $ilUser;
 
        require_once 'Modules/TestQuestionPool/classes/class.ilAssQuestionProcessLockerFactory.php';
        $processLockerFactory = new ilAssQuestionProcessLockerFactory(new ilSetting('assessment'), $ilDB);
        $processLockerFactory->setQuestionId($question_id);
        $processLockerFactory->setUserId($ilUser->getId());
        include_once("./Modules/Test/classes/class.ilObjAssessmentFolder.php");
        $processLockerFactory->setAssessmentLogEnabled(ilObjAssessmentFolder::_enabledAssessmentLogging());
        $processLocker  = $processLockerFactory->getLocker();
 
        $totalrows = 0;
 
        $processLocker->executePersistWorkingStateLockOperation(function () use (&$totalrows, $processLocker, $active_id, $question_id, $pass, $solution) {
            $processLocker->executeUserSolutionUpdateLockOperation(function () use (&$totalrows, $active_id, $question_id, $pass, $solution) {
                $ilDB = $GLOBALS['ilDB'];
                if (($active_id > 0) && ($question_id > 0) && (strlen($pass) > 0)) {
                    $affectedRows = $ilDB->manipulateF(
                        "DELETE FROM tst_solutions WHERE active_fi = %s AND question_fi = %s AND pass = %s",
                        array('integer', 'integer', 'integer'),
                        array($active_id, $question_id, $pass)
                    );
                }
                for ($i = 0; $i < count($solution); $i += 3) {
                    $next_id = $ilDB->nextId('tst_solutions');
                    $affectedRows = $ilDB->insert("tst_solutions", array(
                        "solution_id" => array("integer", $next_id),
                        "active_fi" => array("integer", $active_id),
                        "question_fi" => array("integer", $question_id),
                        "value1" => array("clob", $solution[$i]),
                        "value2" => array("clob", $solution[$i+1]),
                        "points" => array("float", $solution[$i+2]),
                        "pass" => array("integer", $pass),
                        "tstamp" => array("integer", time())
                    ));
                    $totalrows += $affectedRows;
                }
            });
 
            if ($totalrows != 0) {
                include_once "./Modules/TestQuestionPool/classes/class.assQuestion.php";
                $question = assQuestion::_instanciateQuestion($question_id);
                $question->setProcessLocker($processLocker);
                $question->calculateResultsFromSolution($active_id, $pass);
            }
        });
 
        if ($totalrows == 0) {
            return $this->__raiseError(
                "Wrong solution data. ILIAS did not execute any database queries: Solution data: " . print_r($solution, true),
                'No result'
            );
        }
 
        return true;
    }
 
    public function saveQuestionSolution($sid, $active_id, $question_id, $pass, $solution)
    {
        $this->initAuth($sid);
        $this->initIlias();
 
        if (!$this->__checkSession($sid)) {
            return $this->__raiseError($this->__getMessage(), $this->__getMessageCode());
        }
        if (!$this->isAllowedCall($sid, $active_id)) {
            return $this->__raiseError("The required user information is only available for active users.", "");
        }
        
        $solutions = array();
        if (preg_match("/<values>(.*?)<\/values>/is", $solution, $matches)) {
            if (preg_match_all("/<value>(.*?)<\/value><value>(.*?)<\/value><points>(.*?)<\/points>/is", $solution, $matches, PREG_SET_ORDER)) {
                foreach ($matches as $match) {
                    if (count($match) == 4) {
                        for ($i = 1; $i < count($match); $i++) {
                            array_push($solutions, trim($match[$i]));
                        }
                    }
                }
            }
        }
 
        if (count($solutions) == 0) {
            return $this->__raiseError("Wrong solution data. ILIAS did not find one or more solution triplets: $solution", "");
        }
        
        // Include main header
        $ilDB = $GLOBALS['ilDB'];
        if (($active_id > 0) && ($question_id > 0) && (strlen($pass) > 0)) {
            $affectedRows = $ilDB->manipulateF(
                "DELETE FROM tst_solutions WHERE active_fi = %s AND question_fi = %s AND pass = %s",
                array('integer', 'integer', 'integer'),
                array($active_id, $question_id, $pass)
            );
        }
        $totalrows = 0;
        for ($i = 0; $i < count($solutions); $i += 3) {
            $next_id = $ilDB->nextId('tst_solutions');
            $affectedRows = $ilDB->insert("tst_solutions", array(
                "solution_id" => array("integer", $next_id),
                "active_fi" => array("integer", $active_id),
                "question_fi" => array("integer", $question_id),
                "value1" => array("clob", $solutions[$i]),
                "value2" => array("clob", $solutions[$i+1]),
                "points" => array("float", $solutions[$i+2]),
                "pass" => array("integer", $pass),
                "tstamp" => array("integer", time())
            ));
            $totalrows += $affectedRows;
        }
        if (count($totalrows) == 0) {
            return $this->__raiseError("Wrong solution data. ILIAS did not execute any database queries");
        } else {
            include_once "./Modules/TestQuestionPool/classes/class.assQuestion.php";
            $question = assQuestion::_instanciateQuestion($question_id);
            $question->calculateResultsFromSolution($active_id, $pass);
        }
        return "TRUE";
    }
 
    public function getQuestionSolution($sid, $active_id, $question_id, $pass)
    {
        $this->initAuth($sid);
        $this->initIlias();
 
        if (!$this->__checkSession($sid)) {
            return $this->__raiseError($this->__getMessage(), $this->__getMessageCode());
        }
        if (!$this->isAllowedCall($sid, $active_id, false)) {
            return $this->__raiseError("The required user information is only available for active users.", "");
        }
        $solution = array();
        // Include main header
        global $ilDB;
 
        $use_previous_answers = 1;
 
        $result = $ilDB->queryF(
            "SELECT tst_tests.use_previous_answers FROM tst_tests, tst_active WHERE tst_tests.test_id = tst_active.test_fi AND tst_active.active_id = %s",
            array('integer'),
            array($active_id)
        );
        if ($result->numRows()) {
            $row = $ilDB->fetchAssoc($result);
            $use_previous_answers = $row["use_previous_answers"];
        }
        $lastpass = 0;
        if ($use_previous_answers) {
            $result = $ilDB->queryF(
                "SELECT MAX(pass) maxpass FROM tst_test_result WHERE active_fi = %s AND question_fi = %s",
                array('integer', 'integer'),
                array($active_id, $question_id)
            );
            if ($result->numRows() == 1) {
                $row = $ilDB->fetchAssoc($result);
                $lastpass = $row["maxpass"];
            }
        } else {
            $lastpass = $pass;
        }
 
        if (($active_id > 0) && ($question_id > 0) && (strlen($lastpass) > 0)) {
            $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, $question_id, $lastpass)
            );
            if ($result->numRows()) {
                while ($row = $ilDB->fetchAssoc($result)) {
                    array_push($solution, $row["value1"]);
                    array_push($solution, $row["value2"]);
                    array_push($solution, $row["points"]);
                }
            }
        }
        return $solution;
    }
    
    public function getTestUserData($sid, $active_id)
    {
        $this->initAuth($sid);
        $this->initIlias();
 
        if (!$this->__checkSession($sid)) {
            return $this->__raiseError($this->__getMessage(), $this->__getMessageCode());
        }
        if (!$this->isAllowedCall($sid, $active_id, false)) {
            return $this->__raiseError("The required user information is only available for active users.", "");
        }
 
        global $lng, $ilDB;
 
        $result = $ilDB->queryF(
            "SELECT user_fi, test_fi FROM tst_active WHERE active_id = %s",
            array('integer'),
            array($active_id)
        );
        $row = $ilDB->fetchAssoc($result);
        $user_id = $row["user_fi"];
        $test_id = $row["test_fi"];
 
        $result = $ilDB->queryF(
            "SELECT anonymity FROM tst_tests WHERE test_id = %s",
            array('integer'),
            array($test_id)
        );
        $row = $ilDB->fetchAssoc($result);
        $anonymity = $row["anonymity"];
        
        $result = $ilDB->queryF(
            "SELECT firstname, lastname, title, login FROM usr_data WHERE usr_id = %s",
            array('integer'),
            array($user_id)
        );
 
        $userdata = array();
        if ($result->numRows() == 0) {
            $userdata["fullname"] = $lng->txt("deleted_user");
            $userdata["title"] = "";
            $userdata["firstname"] = "";
            $userdata["lastname"] = $lng->txt("anonymous");
            $userdata["login"] = "";
        } else {
            $data = $ilDB->fetchAssoc($result);
            if (($user_id == ANONYMOUS_USER_ID) || ($anonymity)) {
                $userdata["fullname"] = $lng->txt("anonymous");
                $userdata["title"] = "";
                $userdata["firstname"] = "";
                $userdata["lastname"] = $lng->txt("anonymous");
                $userdata["login"] = "";
            } else {
                $userdata["fullname"] = trim($data["title"] . " " . $data["firstname"] . " " . $data["lastname"]);
                $userdata["title"] = $data["title"];
                $userdata["firstname"] = $data["firstname"];
                $userdata["lastname"] = $data["lastname"];
                $userdata["login"] = $data["login"];
            }
        }
        return array_values($userdata);
    }
    
    public function getPositionOfQuestion($sid, $active_id, $question_id, $pass)
    {
        $this->initAuth($sid);
        $this->initIlias();
 
        if (!$this->__checkSession($sid)) {
            return $this->__raiseError($this->__getMessage(), $this->__getMessageCode());
        }
        if (!$this->isAllowedCall($sid, $active_id, false)) {
            return $this->__raiseError("The required user information is only available for active users.", "");
        }
 
        global $lng, $ilDB;
 
        $result = $ilDB->queryF(
            "SELECT tst_tests.random_test FROM tst_active, tst_tests WHERE tst_active.active_id = %s AND tst_tests.test_id = tst_active.test_fi",
            array('integer'),
            array($active_id)
        );
        if ($result->numRows() != 1) {
            return -1;
        }
        $row = $ilDB->fetchAssoc($result);
        $is_random = $row["random_test"];
 
        include_once "./Modules/Test/classes/class.ilTestSequence.php";
        $sequence = new ilTestSequence($active_id, $pass, $is_random);
        return $sequence->getSequenceForQuestion($question_id);
    }
    
    public function getPreviousReachedPoints($sid, $active_id, $question_id, $pass)
    {
        $this->initAuth($sid);
        $this->initIlias();
 
        if (!$this->__checkSession($sid)) {
            return $this->__raiseError($this->__getMessage(), $this->__getMessageCode());
        }
        if (!$this->isAllowedCall($sid, $active_id, false)) {
            return $this->__raiseError("The required user information is only available for active users.", "");
        }
 
        global $lng, $ilDB;
 
        $result = $ilDB->queryF(
            "SELECT tst_tests.random_test FROM tst_active, tst_tests WHERE tst_active.active_id = %s AND tst_tests.test_id = tst_active.test_fi",
            array('integer'),
            array($active_id)
        );
        if ($result->numRows() != 1) {
            return -1;
        }
        $row = $ilDB->fetchAssoc($result);
        $is_random = $row["random_test"];
 
        include_once "./Modules/Test/classes/class.ilTestSequence.php";
        $sequence = new ilTestSequence($active_id, $pass, $is_random);
        $result = $ilDB->queryF(
            "SELECT question_fi, points FROM tst_test_result WHERE active_fi = %s AND pass = %s",
            array('integer', 'integer'),
            array($active_id, $pass)
        );
        $reachedpoints = array();
        while ($row = $ilDB->fetchAssoc($result)) {
            $reachedpoints[$row["question_fi"]] = $row["points"];
        }
        $atposition = false;
        $pointsforposition = array();
        foreach ($sequence->getUserSequence() as $seq) {
            if (!$atposition) {
                $qid = $sequence->getQuestionForSequence($seq);
                if ($qid == $question_id) {
                    $atposition = true;
                } else {
                    array_push($pointsforposition, $reachedpoints[$qid]);
                }
            }
        }
        return $pointsforposition;
    }
    
    public function getNrOfQuestionsInPass($sid, $active_id, $pass)
    {
        $this->initAuth($sid);
        $this->initIlias();
 
        if (!$this->__checkSession($sid)) {
            return $this->__raiseError($this->__getMessage(), $this->__getMessageCode());
        }
        if (!$this->isAllowedCall($sid, $active_id, false)) {
            return $this->__raiseError("The required user information is only available for active users.", "");
        }
 
        global $lng, $ilDB;
 
        $result = $ilDB->queryF(
            "SELECT tst_tests.random_test FROM tst_active, tst_tests WHERE tst_active.active_id = %s AND tst_tests.test_id = tst_active.test_fi",
            array('integer'),
            array($active_id)
        );
        if ($result->numRows() != 1) {
            return 0;
        }
        $row = $ilDB->fetchAssoc($result);
        $is_random = $row["random_test"];
 
        include_once "./Modules/Test/classes/class.ilTestSequence.php";
        $sequence = new ilTestSequence($active_id, $pass, $is_random);
        return $sequence->getUserQuestionCount();
    }
    
    public function removeTestResults($sid, $test_ref_id, $a_user_ids)
    {
        $this->initAuth($sid);
        $this->initIlias();
 
        if (!$this->__checkSession($sid)) {
            return $this->__raiseError($this->__getMessage(), $this->__getMessageCode());
        }
        if (!strlen($test_ref_id)) {
            return $this->__raiseError(
                'No test id given. Aborting!',
                'Client'
            );
        }
        global $rbacsystem, $tree, $ilLog;
        
        global $ilAccess; /* @var ilAccessHandler $ilAccess */
        if (!$ilAccess->checkAccess('write', '', $test_ref_id)) {
            return $this->__raiseError('no permission. Aborting!', 'Client');
        }
 
        if (ilObject::_isInTrash($test_ref_id)) {
            return $this->__raiseError(
                'Test is trashed. Aborting!',
                'Client'
            );
        }
        
        if (!$tst = ilObjectFactory::getInstanceByRefId($test_ref_id, false)) {
            return $this->__raiseError('No test found for id: ' . $test_ref_id, 'Client');
        }
        if ($tst->getType() != 'tst') {
            return $this->__raiseError('Object with ref_id ' . $test_ref_id . ' is not of type test. Aborting', 'Client');
        }
        
        // Dirty hack
        if (isset($a_user_ids['item'])) {
            $a_user_ids = $a_user_ids['item'];
        }
        
        include_once './Modules/Test/classes/class.ilObjTest.php';
        include_once './Modules/Test/classes/class.ilTestParticipantData.php';
        $part = new ilTestParticipantData($GLOBALS['ilDB'], $GLOBALS['lng']);
        $part->setUserIds((array) $a_user_ids);
        $part->load($tst->getTestId());
        $tst->removeTestResults($part);
 
        return true;
    }
    
    public function getTestResults($sid, $test_ref_id, $sum_only)
    {
        $this->initAuth($sid);
        $this->initIlias();
 
        if (!$this->__checkSession($sid)) {
            return $this->__raiseError($this->__getMessage(), $this->__getMessageCode());
        }
        if (!strlen($test_ref_id)) {
            return $this->__raiseError(
                'No test id given. Aborting!',
                'Client'
            );
        }
        global $rbacsystem, $tree, $ilLog;
 
        if (ilObject::_isInTrash($test_ref_id)) {
            return $this->__raiseError(
                'Test is trashed. Aborting!',
                'Client'
            );
        }
        
        // get obj_id
        if (!$obj_id = ilObject::_lookupObjectId($test_ref_id)) {
            return $this->__raiseError(
                'No test found for id: ' . $test_ref_id,
                'Client'
            );
        }
 
 
        // Check access
        $permission_ok = false;
        foreach ($ref_ids = ilObject::_getAllReferences($obj_id) as $ref_id) {
            if ($rbacsystem->checkAccess('write', $ref_id)) {
                $permission_ok = true;
                break;
            }
        }
        if (!$permission_ok) {
            return $this->__raiseError(
                'No permission to edit the object with id: ' . $test_ref_id,
                'Server'
            );
        }
        // store into xml result set
        include_once './webservice/soap/classes/class.ilXMLResultSet.php';
        include_once './webservice/soap/classes/class.ilXMLResultSetWriter.php';
        
        $xmlResultSet = new ilXMLResultSet();
        $xmlResultSet->addColumn("user_id");
        $xmlResultSet->addColumn("login");
        $xmlResultSet->addColumn("firstname");
        $xmlResultSet->addColumn("lastname");
        $xmlResultSet->addColumn("matriculation");
        
        include_once './Modules/Test/classes/class.ilObjTest.php';
        $test_obj = new ilObjTest($obj_id, false);
        $participants =  $test_obj->getTestParticipants();
        
 
        if ($sum_only) {
            $data =  $test_obj->getAllTestResults($participants, false);
            // create xml
            $xmlResultSet->addColumn("maximum_points");
            $xmlResultSet->addColumn("received_points");
            // skip titles
            $titles = array_shift($data);
            foreach ($data as $row) {
                $xmlRow = new ilXMLResultSetRow();
                $xmlRow->setValue(0, $row["user_id"]);
                $xmlRow->setValue(1, $row["login"]);
                $xmlRow->setValue(2, $row["firstname"]);
                $xmlRow->setValue(3, $row["lastname"]);
                $xmlRow->setValue(4, $row["matriculation"]);
                $xmlRow->setValue(5, $row["max_points"]);
                $xmlRow->setValue(6, $row["reached_points"]);
                $xmlResultSet->addRow($xmlRow);
            }
        } else {
            $data =  $test_obj->getDetailedTestResults($participants);
            // create xml
            $xmlResultSet->addColumn("question_id");
            $xmlResultSet->addColumn("question_title");
            $xmlResultSet->addColumn("maximum_points");
            $xmlResultSet->addColumn("received_points");
            foreach ($data as $row) {
                $xmlRow = new ilXMLResultSetRow();
                $xmlRow->setValue(0, $row["user_id"]);
                $xmlRow->setValue(1, $row["login"]);
                $xmlRow->setValue(2, $row["firstname"]);
                $xmlRow->setValue(3, $row["lastname"]);
                $xmlRow->setValue(4, $row["matriculation"]);
                $xmlRow->setValue(5, $row["question_id"]);
                $xmlRow->setValue(6, $row["question_title"]);
                $xmlRow->setValue(7, $row["max_points"]);
                $xmlRow->setValue(8, $row["reached_points"]);
                $xmlResultSet->addRow($xmlRow);
            }
        }
        // create writer
        $xmlWriter = new ilXMLResultSetWriter($xmlResultSet);
        $xmlWriter->start();
        return $xmlWriter->getXML();
    }
}