class.ilTestPasswordChecker.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

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

    public function isPasswordProtectionPageRedirectRequired(): bool
    {
        return  (
            $this->isTestPasswordEnabled()
            && !$this->isPrivilegedParticipant()
            && !$this->isUserEnteredPasswordCorrect()
        );
    }

    protected function isTestPasswordEnabled(): bool
    {
        return $this->testOBJ->getPassword() !== null;
    }

    protected function isPrivilegedParticipant(): bool
    {
        return $this->rbacsystem->checkAccess('write', $this->testOBJ->getRefId());
    }

    public function wrongUserEnteredPasswordExist(): bool
    {
        if ($this->getUserEnteredPassword() && $this->getUserEnteredPassword() === '') {
            return false;
        }

        return !$this->isUserEnteredPasswordCorrect();
    }

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

    public function setUserEnteredPassword($enteredPassword)
    {
        ilSession::set($this->buildSessionKey(), $enteredPassword);
    }

    protected function getUserEnteredPassword()
    {
        return ilSession::get($this->buildSessionKey());
    }

    protected function buildSessionKey(): string
    {
        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(): string
    {
        return $this->lng->txtlng(
            'assessment',
            'log_wrong_test_password_entered',
            ilObjAssessmentFolder::_getLogLanguage()
        );
    }
}