Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
| Total | |
0.00% |
0 / 51 |
|
0.00% |
0 / 7 |
CRAP | |
0.00% |
0 / 1 |
| TestPreviewer | |
0.00% |
0 / 51 |
|
0.00% |
0 / 7 |
210 | |
0.00% |
0 / 1 |
| init | |
0.00% |
0 / 26 |
|
0.00% |
0 / 1 |
30 | |||
| configuration | |
0.00% |
0 / 9 |
|
0.00% |
0 / 1 |
12 | |||
| setNoCacheHeaders | |
0.00% |
0 / 4 |
|
0.00% |
0 / 1 |
2 | |||
| getTestPreviewerConfigurationService | |
0.00% |
0 / 1 |
|
0.00% |
0 / 1 |
2 | |||
| getTestPreviewerService | |
0.00% |
0 / 1 |
|
0.00% |
0 / 1 |
2 | |||
| getTestPreviewerPresetsMapService | |
0.00% |
0 / 1 |
|
0.00% |
0 / 1 |
2 | |||
| mapXmlExceptionMessage | |
0.00% |
0 / 9 |
|
0.00% |
0 / 1 |
6 | |||
| 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) 2020 (original work) Open Assessment Technologies SA ; |
| 19 | */ |
| 20 | |
| 21 | declare(strict_types=1); |
| 22 | |
| 23 | namespace oat\taoQtiTestPreviewer\controller; |
| 24 | |
| 25 | use common_exception_UserReadableException; |
| 26 | use InvalidArgumentException; |
| 27 | use oat\tao\model\http\HttpJsonResponseTrait; |
| 28 | use oat\taoQtiTestPreviewer\models\test\TestPreviewConfig; |
| 29 | use oat\taoQtiTestPreviewer\models\test\service\TestPreviewer as TestPreviewerService; |
| 30 | use oat\taoQtiTestPreviewer\models\test\TestPreviewRequest; |
| 31 | use oat\taoQtiTestPreviewer\models\TestCategoryPresetMap; |
| 32 | use oat\taoQtiTestPreviewer\models\testConfiguration\service\TestPreviewerConfigurationService; |
| 33 | use qtism\data\storage\xml\XmlStorageException; |
| 34 | use tao_actions_ServiceModule; |
| 35 | use Throwable; |
| 36 | |
| 37 | class TestPreviewer extends tao_actions_ServiceModule |
| 38 | { |
| 39 | use HttpJsonResponseTrait; |
| 40 | |
| 41 | public function init() |
| 42 | { |
| 43 | try { |
| 44 | $requestParams = $this->getPsrRequest()->getQueryParams(); |
| 45 | |
| 46 | if (empty($requestParams['testUri'])) { |
| 47 | throw new InvalidArgumentException('Required `testUri` param is missing '); |
| 48 | } |
| 49 | |
| 50 | $testPreviewRequest = new TestPreviewRequest( |
| 51 | $requestParams['testUri'], |
| 52 | new TestPreviewConfig([TestPreviewConfig::CHECK_INFORMATIONAL => true]) |
| 53 | ); |
| 54 | $response = $this->getTestPreviewerService()->createPreview($testPreviewRequest); |
| 55 | |
| 56 | $this->setNoCacheHeaders(); |
| 57 | |
| 58 | $this->setSuccessJsonResponse( |
| 59 | [ |
| 60 | 'success' => true, |
| 61 | 'testData' => [], |
| 62 | 'testContext' => [], |
| 63 | 'testMap' => $response->getMap()->getMap(), |
| 64 | 'presetMap' => $this->getTestPreviewerPresetsMapService()->getMap() |
| 65 | ] |
| 66 | ); |
| 67 | } catch (XmlStorageException $xmlStorageException) { |
| 68 | $message = $this->mapXmlExceptionMessage($xmlStorageException); |
| 69 | $this->setErrorJsonResponse($message); |
| 70 | } catch (Throwable $exception) { |
| 71 | $message = $exception instanceof common_exception_UserReadableException |
| 72 | ? $exception->getUserMessage() |
| 73 | : $exception->getMessage(); |
| 74 | |
| 75 | $this->setErrorJsonResponse($message); |
| 76 | } |
| 77 | } |
| 78 | |
| 79 | public function configuration(): void |
| 80 | { |
| 81 | try { |
| 82 | $this->setNoCacheHeaders(); |
| 83 | |
| 84 | $this->setSuccessJsonResponse( |
| 85 | $this->getTestPreviewerConfigurationService()->getConfiguration() |
| 86 | ); |
| 87 | } catch (Throwable $exception) { |
| 88 | $message = $exception instanceof common_exception_UserReadableException |
| 89 | ? $exception->getUserMessage() |
| 90 | : $exception->getMessage(); |
| 91 | |
| 92 | $this->setErrorJsonResponse($message); |
| 93 | } |
| 94 | } |
| 95 | |
| 96 | private function setNoCacheHeaders(): void |
| 97 | { |
| 98 | $this->getResponseFormatter() |
| 99 | ->addHeader('Cache-Control', 'no-cache, no-store, must-revalidate') |
| 100 | ->addHeader('Pragma', 'no-cache') |
| 101 | ->addHeader('Expires', '0'); |
| 102 | } |
| 103 | |
| 104 | private function getTestPreviewerConfigurationService(): TestPreviewerConfigurationService |
| 105 | { |
| 106 | return $this->getServiceLocator()->get(TestPreviewerConfigurationService::class); |
| 107 | } |
| 108 | |
| 109 | private function getTestPreviewerService(): TestPreviewerService |
| 110 | { |
| 111 | return $this->getServiceLocator()->get(TestPreviewerService::class); |
| 112 | } |
| 113 | |
| 114 | private function getTestPreviewerPresetsMapService(): TestCategoryPresetMap |
| 115 | { |
| 116 | return $this->getPsrContainer()->get(TestCategoryPresetMap::class); |
| 117 | } |
| 118 | |
| 119 | private function mapXmlExceptionMessage(XmlStorageException $exception): string |
| 120 | { |
| 121 | if ( |
| 122 | stristr( |
| 123 | $exception->getMessage(), |
| 124 | 'An error occurred while unreferencing item reference with identifier' |
| 125 | ) !== false |
| 126 | ) { |
| 127 | return __( |
| 128 | 'It seems that some items have been deleted. ' . |
| 129 | 'Please remove the items with empty labels from the test and save before trying again.' |
| 130 | ); |
| 131 | } |
| 132 | return $exception->getMessage(); |
| 133 | } |
| 134 | } |