class.ilTestSession.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2013 ILIAS open source, Extended GPL, see docs/LICENSE */

class ilTestSession
{
        const ACCESS_CODE_SESSION_INDEX = "tst_access_code";
        
        const ACCESS_CODE_CHAR_DOMAIN = "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ";
        
        const ACCESS_CODE_LENGTH = 5;
        
        var $active_id;

        var $user_id;

        var $anonymous_id;

        var $test_id;

        var $lastsequence;

        protected $lastPresentationMode;

        var $submitted;

        var $tstamp;

        var $submittedTimestamp;

        private $lastFinishedPass;
        
        private $objectiveOrientedContainerId;

        public function __construct()
        {
                $this->active_id = 0;
                $this->user_id = 0;
                $this->anonymous_id = 0;
                $this->test_id = 0;
                $this->lastsequence = 0;
                $this->lastPresentationMode = null;
                $this->submitted = FALSE;
                $this->submittedTimestamp = "";
                $this->pass = 0;
                $this->ref_id = 0;
                $this->tstamp = 0;

                $this->lastFinishedPass = null;
                $this->objectiveOrientedContainerId = 0;
        }

        function setRefId($a_val)
        {
                $this->ref_id = $a_val;
        }

        function getRefId()
        {
                return $this->ref_id;
        }
        
        protected function activeIDExists($user_id, $test_id)
        {
                global $ilDB;

                if ($_SESSION["AccountId"] != ANONYMOUS_USER_ID)
                {
                        $result = $ilDB->queryF("SELECT * FROM tst_active WHERE user_fi = %s AND test_fi = %s",
                                array('integer','integer'),
                                array($user_id, $test_id)
                        );
                        if ($result->numRows())
                        {
                                $row = $ilDB->fetchAssoc($result);
                                $this->active_id = $row["active_id"];
                                $this->user_id = $row["user_fi"];
                                $this->anonymous_id = $row["anonymous_id"];
                                $this->test_id = $row["test_fi"];
                                $this->lastsequence = $row["lastindex"];
                                $this->pass = $row["tries"];
                                $this->submitted = ($row["submitted"]) ? TRUE : FALSE;
                                $this->submittedTimestamp = $row["submittimestamp"];
                                $this->tstamp = $row["tstamp"];

                                $this->setLastFinishedPass($row['last_finished_pass']);
                                $this->setObjectiveOrientedContainerId((int)$row['objective_container']);

                                return true;
                        }
                }
                return false;
        }
        
        function increaseTestPass()
        {
                global $ilDB, $ilLog;

                $this->increasePass();
                $this->setLastSequence(0);
                $submitted = ($this->isSubmitted()) ? 1 : 0;
                // there has to be at least 10 seconds between new test passes (to ensure that noone double clicks the finish button and increases the test pass by more than 1)
                if (time() - $_SESSION['tst_last_increase_pass'] > 10)
                {
                        $_SESSION['tst_last_increase_pass'] = time();
                        $this->tstamp = time();
                        if ($this->active_id > 0)
                        {
                                $ilDB->update('tst_active',
                                        array(
                                                'lastindex' => array('integer', $this->getLastSequence()),
                                                'tries' => array('integer', $this->getPass()),
                                                'submitted' => array('integer', $submitted),
                                                'submittimestamp' => array('timestamp', strlen($this->getSubmittedTimestamp()) ? $this->getSubmittedTimestamp() : NULL),
                                                'tstamp' => array('integer', time()),
                                                'last_finished_pass' => array('integer', $this->getLastFinishedPass()),
                                                'objective_container' => array('integer', (int)$this->getObjectiveOrientedContainerId())
                                        ),
                                        array(
                                                'active_id' => array('integer', $this->getActiveId())
                                        )
                                );

                                // update learning progress
                                include_once("./Modules/Test/classes/class.ilObjTestAccess.php");
                                include_once("./Services/Tracking/classes/class.ilLPStatusWrapper.php");
                                ilLPStatusWrapper::_updateStatus(ilObjTestAccess::_lookupObjIdForTestId($this->getTestId()),
                                        ilObjTestAccess::_getParticipantId($this->active_id));
                        }
                        else
                        {
                                if (!$this->activeIDExists($this->getUserId(), $this->getTestId()))
                                {
                                        $anonymous_id = ($this->getAnonymousId()) ? $this->getAnonymousId() : NULL;
                                        $submittedTs = (strlen($this->getSubmittedTimestamp())) ? $this->getSubmittedTimestamp() : NULL;
                                        $next_id = $ilDB->nextId('tst_active');

                                        $ilDB->insert('tst_active', array(
                                                'active_id' => array('integer', $next_id),
                                                'user_fi' => array('integer', $this->getUserId()),
                                                'anonymous_id' => array('text', $anonymous_id),
                                                'test_fi' => array('integer', $this->getTestId()),
                                                'lastindex' => array('integer', $this->getLastSequence()),
                                                'tries' => array('integer', $this->getPass()),
                                                'submitted' => array('integer', $submitted),
                                                'submittimestamp' => array('timestamp', $submittedTs),
                                                'tstamp' => array('integer', time()),
                                                'objective_container' => array('integer', (int)$this->getObjectiveOrientedContainerId()),
                                        ));

                                        $this->active_id = $next_id;

                                        // update learning progress
                                        include_once("./Modules/Test/classes/class.ilObjTestAccess.php");
                                        include_once("./Services/Tracking/classes/class.ilLPStatusWrapper.php");
                                        ilLPStatusWrapper::_updateStatus(ilObjTestAccess::_lookupObjIdForTestId($this->getTestId()),
                                                $this->getUserId());
                                }
                        }
                }
        }
        
        function saveToDb()
        {
                global $ilDB, $ilLog;
                
                $submitted = ($this->isSubmitted()) ? 1 : 0;
                if ($this->active_id > 0)
                {
                        $ilDB->update('tst_active',
                                array(
                                        'lastindex' => array('integer', $this->getLastSequence()),
                                        'tries' => array('integer', $this->getPass()),
                                        'submitted' => array('integer', $submitted),
                                        'submittimestamp' => array('timestamp', (strlen($this->getSubmittedTimestamp())) ? $this->getSubmittedTimestamp() : NULL),
                                        'tstamp' => array('integer', time()-10),
                                        'last_finished_pass' => array('integer', $this->getLastFinishedPass()),
                                        'objective_container' => array('integer', (int)$this->getObjectiveOrientedContainerId())
                                ),
                                array(
                                        'active_id' => array('integer', $this->getActiveId())
                                )
                        );

                        // update learning progress
                        include_once("./Modules/Test/classes/class.ilObjTestAccess.php");
                        include_once("./Services/Tracking/classes/class.ilLPStatusWrapper.php");
                        ilLPStatusWrapper::_updateStatus(ilObjTestAccess::_lookupObjIdForTestId($this->getTestId()),
                                ilObjTestAccess::_getParticipantId($this->getActiveId()));
                }
                else
                {
                        if (!$this->activeIDExists($this->getUserId(), $this->getTestId()))
                        {
                                $anonymous_id = ($this->getAnonymousId()) ? $this->getAnonymousId() : NULL;

                                $next_id = $ilDB->nextId('tst_active');
                                $ilDB->insert('tst_active',
                                        array(
                                                'active_id' => array('integer', $next_id),
                                                'user_fi' => array('integer', $this->getUserId()),
                                                'anonymous_id' => array('text', $anonymous_id),
                                                'test_fi' => array('integer', $this->getTestId()),
                                                'lastindex' => array('integer', $this->getLastSequence()),
                                                'tries' => array('integer', $this->getPass()),
                                                'submitted' => array('integer', $submitted),
                                                'submittimestamp' => array('timestamp', (strlen($this->getSubmittedTimestamp())) ? $this->getSubmittedTimestamp() : NULL),
                                                'tstamp' => array('integer', time()-10),
                                                'last_finished_pass' => array('integer', $this->getLastFinishedPass()),
                                                'objective_container' => array('integer', (int)$this->getObjectiveOrientedContainerId())
                                        )
                                );
                                $this->active_id = $next_id;

                                // update learning progress
                                include_once("./Modules/Test/classes/class.ilObjTestAccess.php");
                                include_once("./Services/Tracking/classes/class.ilLPStatusWrapper.php");
                                ilLPStatusWrapper::_updateStatus(ilObjTestAccess::_lookupObjIdForTestId($this->getTestId()),
                                        $this->getUserId());
                        }
                }
                include_once './Modules/Test/classes/class.ilObjTestAccess.php';
                include_once("./Services/Tracking/classes/class.ilLearningProgress.php");
                ilLearningProgress::_tracProgress($this->getUserId(),
                                                                                  ilObjTestAccess::_lookupObjIdForTestId($this->getTestId()),
                                                                                  $this->getRefId(),
                                                                                  'tst');
        }
        
        function loadTestSession($test_id, $user_id = "", $anonymous_id = "")
        {
                global $ilDB;
                global $ilUser;

                if (!$user_id)
                {
                        $user_id = $ilUser->getId();
                }
                if (($_SESSION["AccountId"] == ANONYMOUS_USER_ID) && $this->doesAccessCodeInSessionExists())
                {
                        $result = $ilDB->queryF("SELECT * FROM tst_active WHERE user_fi = %s AND test_fi = %s AND anonymous_id = %s",
                                array('integer','integer','text'),
                                array($user_id, $test_id, $this->getAccessCodeFromSession())
                        );
                }
                else if (strlen($anonymous_id))
                {
                        $result = $ilDB->queryF("SELECT * FROM tst_active WHERE user_fi = %s AND test_fi = %s AND anonymous_id = %s",
                                array('integer','integer','text'),
                                array($user_id, $test_id, $anonymous_id)
                        );
                }
                else
                {
                        if ($_SESSION["AccountId"] == ANONYMOUS_USER_ID)
                        {
                                return NULL;
                        }
                        $result = $ilDB->queryF("SELECT * FROM tst_active WHERE user_fi = %s AND test_fi = %s",
                                array('integer','integer'),
                                array($user_id, $test_id)
                        );
                }
                if ($result->numRows())
                {
                        $row = $ilDB->fetchAssoc($result);
                        $this->active_id = $row["active_id"];
                        $this->user_id = $row["user_fi"];
                        $this->anonymous_id = $row["anonymous_id"];
                        $this->test_id = $row["test_fi"];
                        $this->lastsequence = $row["lastindex"];
                        $this->pass = $row["tries"];
                        $this->submitted = ($row["submitted"]) ? TRUE : FALSE;
                        $this->submittedTimestamp = $row["submittimestamp"];
                        $this->tstamp = $row["tstamp"];

                        $this->setLastFinishedPass($row['last_finished_pass']);
                        $this->setObjectiveOrientedContainerId((int)$row['objective_container']);
                }
                elseif( $this->doesAccessCodeInSessionExists() )
                {
                        $this->unsetAccessCodeInSession();
                }
        }
        
        public function loadFromDb($active_id)
        {
                global $ilDB;
                $result = $ilDB->queryF("SELECT * FROM tst_active WHERE active_id = %s", 
                        array('integer'),
                        array($active_id)
                );
                if ($result->numRows())
                {
                        $row = $ilDB->fetchAssoc($result);
                        $this->active_id = $row["active_id"];
                        $this->user_id = $row["user_fi"];
                        $this->anonymous_id = $row["anonymous_id"];
                        $this->test_id = $row["test_fi"];
                        $this->lastsequence = $row["lastindex"];
                        $this->pass = $row["tries"];
                        $this->submitted = ($row["submitted"]) ? TRUE : FALSE;
                        $this->submittedTimestamp = $row["submittimestamp"];
                        $this->tstamp = $row["tstamp"];

                        $this->setLastFinishedPass($row['last_finished_pass']);
                        $this->setObjectiveOrientedContainerId((int)$row['objective_container']);
                }
        }
        
        function getActiveId()
        {
                return $this->active_id;
        }
        
        function setUserId($user_id)
        {
                $this->user_id = $user_id;
        }
        
        function getUserId()
        {
                return $this->user_id;
        }
        
        function setTestId($test_id)
        {
                $this->test_id = $test_id;
        }
        
        function getTestId()
        {
                return $this->test_id;
        }
        
        function setAnonymousId($anonymous_id)
        {
                $this->anonymous_id = $anonymous_id;
        }
        
        function getAnonymousId()
        {
                return $this->anonymous_id;
        }

        public function setLastSequence($lastsequence)
        {
                $this->lastsequence = $lastsequence;
        }
        
        public function getLastSequence()
        {
                return $this->lastsequence;
        }
        
        function setPass($pass)
        {
                $this->pass = $pass;
        }
        
        function getPass()
        {
                return $this->pass;
        }

        function increasePass()
        {
                $this->pass += 1;
        }

        function isSubmitted()
        {
                return $this->submitted;
        }
        
        function setSubmitted()
        {
                $this->submitted = TRUE;
        }
        
        function getSubmittedTimestamp()
        {
                return $this->submittedTimestamp;
        }
        
        function setSubmittedTimestamp()
        {
                $this->submittedTimestamp = strftime("%Y-%m-%d %H:%M:%S");
        }

        public function setLastFinishedPass($lastFinishedPass)
        {
                $this->lastFinishedPass = $lastFinishedPass;
        }

        public function getLastFinishedPass()
        {
                return $this->lastFinishedPass;
        }

        public function setObjectiveOrientedContainerId($objectiveOriented)
        {
                $this->objectiveOrientedContainerId = $objectiveOriented;
        }

        public function getObjectiveOrientedContainerId()
        {
                return $this->objectiveOrientedContainerId;
        }

        public function isObjectiveOriented()
        {
                return (bool)$this->getObjectiveOrientedContainerId();
        }
        
        public function persistTestStartLock($testStartLock)
        {
                global $ilDB;

                $ilDB->update(
                        'tst_active',
                        array('start_lock' => array('text', $testStartLock)),
                        array('active_id' => array('integer', $this->getActiveId()))
                );
        }

        public function lookupTestStartLock()
        {
                global $ilDB;
                
                $res = $ilDB->queryF(
                        "SELECT start_lock FROM tst_active WHERE active_id = %s",
                        array('integer'), array($this->getActiveId())
                );
                
                while($row = $ilDB->fetchAssoc($res))
                {
                        return $row['start_lock'];
                }
                
                return null;
        }

        public function setAccessCodeToSession($access_code)
        {
                if (!is_array($_SESSION[self::ACCESS_CODE_SESSION_INDEX]))
                {
                        $_SESSION[self::ACCESS_CODE_SESSION_INDEX] = array();
                }
                
                $_SESSION[self::ACCESS_CODE_SESSION_INDEX][$this->getTestId()] = $access_code;
        }

        public function unsetAccessCodeInSession()
        {
                unset($_SESSION[self::ACCESS_CODE_SESSION_INDEX][$this->getTestId()]);
        }

        public function getAccessCodeFromSession()
        {
                if( !is_array($_SESSION[self::ACCESS_CODE_SESSION_INDEX]) )
                {
                        return null;
                }

                if( !isset($_SESSION[self::ACCESS_CODE_SESSION_INDEX][$this->getTestId()]) )
                {
                        return null;
                }

                return $_SESSION[self::ACCESS_CODE_SESSION_INDEX][$this->getTestId()];
        }
        
        public function doesAccessCodeInSessionExists()
        {
                if( !is_array($_SESSION[self::ACCESS_CODE_SESSION_INDEX]) )
                {
                        return false;
                }

                return isset($_SESSION[self::ACCESS_CODE_SESSION_INDEX][$this->getTestId()]);
        }

        public function createNewAccessCode()
        {
                do
                {
                        $code = $this->buildAccessCode();
                }
                while( $this->isAccessCodeUsed($code) );

                return $code;
        }

        public function isAccessCodeUsed($code)
        {
                global $ilDB;
                
                $query = "SELECT anonymous_id FROM tst_active WHERE test_fi = %s AND anonymous_id = %s";

                $result = $ilDB->queryF(
                        $query, array('integer', 'text'), array($this->getTestId(), $code)
                );
                
                return ($result->numRows() > 0);
        }

        private function buildAccessCode()
        {
                // create a 5 character code
                $codestring = self::ACCESS_CODE_CHAR_DOMAIN;

                mt_srand();

                $code = "";

                for($i = 1; $i <= self::ACCESS_CODE_LENGTH; $i++)
                {
                        $index = mt_rand(0, strlen($codestring)-1);
                        $code .= substr($codestring, $index, 1);
                }

                return $code;
        }
        
        public function isAnonymousUser()
        {
                return $this->getUserId() == ANONYMOUS_USER_ID;
        }
}