Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
75.44% covered (warning)
75.44%
43 / 57
16.67% covered (danger)
16.67%
1 / 6
CRAP
0.00% covered (danger)
0.00%
0 / 1
QtiItemResponseRepository
75.44% covered (warning)
75.44%
43 / 57
16.67% covered (danger)
16.67%
1 / 6
29.17
0.00% covered (danger)
0.00%
0 / 1
 __construct
100.00% covered (success)
100.00%
4 / 4
100.00% covered (success)
100.00%
1 / 1
1
 save
80.00% covered (warning)
80.00%
4 / 5
0.00% covered (danger)
0.00%
0 / 1
2.03
 endItemTimer
85.71% covered (warning)
85.71%
6 / 7
0.00% covered (danger)
0.00%
0 / 1
2.01
 saveItemState
87.50% covered (warning)
87.50%
7 / 8
0.00% covered (danger)
0.00%
0 / 1
3.02
 saveItemResponses
73.33% covered (warning)
73.33%
22 / 30
0.00% covered (danger)
0.00%
0 / 1
13.29
 blockEmptyResponse
0.00% covered (danger)
0.00%
0 / 3
0.00% covered (danger)
0.00%
0 / 1
12
1<?php
2
3/**
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public License
6 * as published by the Free Software Foundation; under version 2
7 * of the License (non-upgradable).
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
17 *
18 * Copyright (c) 2021 (original work) Open Assessment Technologies SA;
19 *
20 * @author Ricardo Quintanilha <ricardo.quintanilha@taotesting.com>
21 */
22
23declare(strict_types=1);
24
25namespace oat\taoQtiTest\model\Infrastructure;
26
27use oat\tao\model\featureFlag\FeatureFlagChecker;
28use oat\taoQtiTest\model\Domain\Model\ItemResponse;
29use oat\taoQtiTest\model\Domain\Model\ItemResponseRepositoryInterface;
30use oat\taoQtiTest\model\Infrastructure\Validation\ExtraQtiInteractionResponseValidator;
31use oat\taoQtiTest\models\classes\runner\QtiRunnerInvalidResponsesException;
32use oat\taoQtiTest\models\runner\QtiRunnerEmptyResponsesException;
33use oat\taoQtiTest\models\runner\QtiRunnerItemResponseException;
34use oat\taoQtiTest\models\runner\QtiRunnerService;
35use oat\taoQtiTest\models\runner\RunnerServiceContext;
36use qtism\runtime\tests\AssessmentTestSession;
37use qtism\runtime\tests\AssessmentItemSessionException;
38use taoQtiTest_helpers_TestRunnerUtils as TestRunnerUtils;
39
40class QtiItemResponseRepository implements ItemResponseRepositoryInterface
41{
42    /** @var QtiRunnerService */
43    private $runnerService;
44    private FeatureFlagChecker $featureFlagChecker;
45    private QtiItemResponseValidator $itemResponseValidator;
46    private ExtraQtiInteractionResponseValidator $extraQtiInteractionResponseValidator;
47
48    public function __construct(
49        QtiRunnerService $runnerService,
50        FeatureFlagChecker $featureFlagChecker,
51        QtiItemResponseValidator $itemResponseValidator,
52        ExtraQtiInteractionResponseValidator $extraQtiInteractionResponseValidator
53    ) {
54        $this->runnerService = $runnerService;
55        $this->featureFlagChecker = $featureFlagChecker;
56        $this->itemResponseValidator = $itemResponseValidator;
57        $this->extraQtiInteractionResponseValidator = $extraQtiInteractionResponseValidator;
58    }
59
60    public function save(ItemResponse $itemResponse, RunnerServiceContext $serviceContext): void
61    {
62        if ($this->runnerService->isTerminated($serviceContext)) {
63            return;
64        }
65
66        $this->endItemTimer($itemResponse, $serviceContext);
67        $this->saveItemState($itemResponse, $serviceContext);
68        $this->saveItemResponses($itemResponse, $serviceContext);
69    }
70
71    private function endItemTimer(ItemResponse $itemResponse, RunnerServiceContext $serviceContext): void
72    {
73        if ($itemResponse->getDuration() === null) {
74            return;
75        }
76
77        $this->runnerService->endTimer(
78            $serviceContext,
79            $itemResponse->getDuration(),
80            $itemResponse->getTimestamp()
81        );
82    }
83
84    private function saveItemState(ItemResponse $itemResponse, RunnerServiceContext $serviceContext): void
85    {
86        if (
87            empty($itemResponse->getItemIdentifier())
88            || $itemResponse->getState() === null
89        ) {
90            return;
91        }
92
93        $this->runnerService->setItemState(
94            $serviceContext,
95            $itemResponse->getItemIdentifier(),
96            $itemResponse->getState()
97        );
98    }
99
100    private function saveItemResponses(ItemResponse $itemResponse, RunnerServiceContext $serviceContext): void
101    {
102        if (
103            empty($itemResponse->getItemIdentifier())
104            || $itemResponse->getResponse() === null
105        ) {
106            return;
107        }
108
109        $itemDefinition = $this->runnerService->getItemHref($serviceContext, $itemResponse->getItemIdentifier());
110
111        if (empty($itemDefinition)) {
112            return;
113        }
114
115        if (
116            $serviceContext->getCurrentAssessmentItemRef() === false
117            || $serviceContext->getCurrentAssessmentItemRef()->getIdentifier() !== $itemResponse->getItemIdentifier()
118        ) {
119            throw new QtiRunnerItemResponseException(__('Item response identifier does not match current item'));
120        }
121
122        $responses = $this->runnerService->parsesItemResponse(
123            $serviceContext,
124            $itemDefinition,
125            $itemResponse->getResponse()
126        );
127        /** @var AssessmentTestSession $testSession */
128        $testSession = $serviceContext->getTestSession();
129
130        if ($this->featureFlagChecker->isEnabled('FEATURE_FLAG_RESPONSE_VALIDATOR')) {
131            try {
132                $this->itemResponseValidator->validate($testSession, $responses);
133                $this->extraQtiInteractionResponseValidator->validate(
134                    $this->runnerService->getItemData($serviceContext, $itemDefinition),
135                    $responses
136                );
137            } catch (AssessmentItemSessionException | QtiRunnerInvalidResponsesException $e) {
138                throw new QtiRunnerInvalidResponsesException($e->getMessage());
139            }
140
141            $this->runnerService->storeItemResponse($serviceContext, $itemDefinition, $responses);
142            return;
143        }
144
145        if (
146            $this->runnerService->getTestConfig()->getConfigValue('enableAllowSkipping')
147            && !TestRunnerUtils::doesAllowSkipping($testSession)
148            && $this->runnerService->emptyResponse($serviceContext, $responses)
149        ) {
150            throw new QtiRunnerEmptyResponsesException();
151        }
152
153        $this->runnerService->storeItemResponse($serviceContext, $itemDefinition, $responses);
154    }
155
156    /**
157     * @param RunnerServiceContext $serviceContext
158     * @param mixed $responses
159     * @return bool
160     * @throws \common_Exception
161     * @throws \common_ext_ExtensionException
162     */
163    protected function blockEmptyResponse(RunnerServiceContext $serviceContext, mixed $responses): bool
164    {
165        return $this->runnerService->getTestConfig()->getConfigValue('enableAllowSkipping')
166            && !TestRunnerUtils::doesAllowSkipping($serviceContext->getTestSession())
167            && $this->runnerService->emptyResponse($serviceContext, $responses);
168    }
169}