class.ilTestPasswordChecker.php

Go to the documentation of this file.

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

require_once 'Modules/Test/classes/class.ilObjAssessmentFolder.php';

class ilTestPasswordChecker
{
        protected $rbacsystem;

        protected $user;

        protected $testOBJ;

        protected $lng;
        
        public function __construct(ilRbacSystem $rbacsystem, ilObjUser $user, ilObjTest $testOBJ, ilLanguage $lng)
        {
                $this->rbacsystem = $rbacsystem;
                $this->user = $user;
                $this->testOBJ = $testOBJ;
                $this->lng = $lng;
                
                $this->initSession();
        }
        
        public function isPasswordProtectionPageRedirectRequired()
        {
                if( !$this->isTestPasswordEnabled() )
                {
                        return false;
                }

                if( $this->isPrivilegedParticipant() )
                {
                        return false;
                }

                if( $this->isUserEnteredPasswordCorrect() )
                {
                        return false;
                }
                
                return true;
        }

        protected function isTestPasswordEnabled()
        {
                return strlen($this->testOBJ->getPassword());
        }

        protected function isPrivilegedParticipant()
        {
                return $this->rbacsystem->checkAccess('write', $this->testOBJ->getRefId());
        }
        
        public function wrongUserEnteredPasswordExist()
        {
                if( !strlen($this->getUserEnteredPassword()) )
                {
                        return false;
                }
                
                return !$this->isUserEnteredPasswordCorrect();
        }

        public function isUserEnteredPasswordCorrect()
        {
                return $this->getUserEnteredPassword() == $this->testOBJ->getPassword();
        }

        public function setUserEnteredPassword($enteredPassword)
        {
                $_SESSION[$this->buildSessionKey()] = $enteredPassword;
        }
        
        protected function getUserEnteredPassword()
        {
                return $_SESSION[$this->buildSessionKey()];
        }

        protected function initSession()
        {
                if( !isset($_SESSION[$this->buildSessionKey()]) )
                {
                        $_SESSION[$this->buildSessionKey()] = null;
                }
        }
        
        protected function buildSessionKey()
        {
                return 'tst_password_'.$this->testOBJ->getTestId();
        }
        
        public function logWrongEnteredPassword()
        {
                if( !ilObjAssessmentFolder::_enabledAssessmentLogging() )
                {
                        return;
                }
                
                ilObjAssessmentFolder::_addLog( $this->user->getId(), $this->testOBJ->getId(),
                        $this->getWrongEnteredPasswordLogMsg(), null, null, true, $this->testOBJ->getRefId()
                );
        }
        
        protected function getWrongEnteredPasswordLogMsg()
        {
                $msg = $this->lng->txtlng(
                        'assessment', 'log_wrong_test_password_entered', ilObjAssessmentFolder::_getLogLanguage()
                );
                
                return sprintf($msg, $this->getUserEnteredPassword());
        }
}