Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
0.00% covered (danger)
0.00%
0 / 66
0.00% covered (danger)
0.00%
0 / 9
 CRAP
0.00% covered (danger)
0.00%
0 / 1
AbstractRestQti
0.00% covered (danger)
0.00%
0 / 66
0.00% covered (danger)
0.00%
0 / 9
 600
0.00% covered (danger)
0.00%
0 / 1
 getTaskName
n/a
0 / 0
n/a
0 / 0
 0
 getStatus
0.00% covered (danger)
0.00%
0 / 9
0.00% covered (danger)
0.00%
0 / 1
 12
 getTaskStatus
0.00% covered (danger)
0.00%
0 / 5
0.00% covered (danger)
0.00%
0 / 1
 12
 isMetadataGuardiansEnabled
0.00% covered (danger)
0.00%
0 / 8
0.00% covered (danger)
0.00%
0 / 1
 12
 isMetadataValidatorsEnabled
0.00% covered (danger)
0.00%
0 / 8
0.00% covered (danger)
0.00%
0 / 1
 12
 isItemMustExistEnabled
0.00% covered (danger)
0.00%
0 / 8
0.00% covered (danger)
0.00%
0 / 1
 12
 isItemMustBeOverwrittenEnabled
0.00% covered (danger)
0.00%
0 / 8
0.00% covered (danger)
0.00%
0 / 1
 12
 updateMetadata
0.00% covered (danger)
0.00%
0 / 18
0.00% covered (danger)
0.00%
0 / 1
 20
 getUpdateMetadataRequestHandler
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
 2
 getMetadataService
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
 2
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) 2017-2022 (original work) Open Assessment Technologies SA;
19 *
20 *
21 */
22
23namespace oat\taoQtiItem\controller;
24
25use common_exception_MethodNotAllowed as HttpMethodNotAllowedException;
26use common_exception_RestApi as BadRequestException;
27use InvalidArgumentException;
28use JsonException;
29use oat\tao\model\http\HttpJsonResponseTrait;
30use oat\tao\model\taskQueue\TaskLog\Entity\EntityInterface;
31use oat\tao\model\taskQueue\TaskLogActionTrait;
32use oat\taoQtiItem\model\presentation\web\UpdateMetadataRequestHandler;
33use oat\taoQtiItem\model\qti\metadata\MetadataService;
34use Request;
35use RuntimeException;
36
37/**
38 * Class AbstractRestQti
39 * @package oat\taoQtiItem\controller
40 * @author Aleh Hutnikau, <hutnikau@1pt.com>
41 * @author Gyula Szucs <gyula@taotesting.com>
42 */
43abstract class AbstractRestQti extends \tao_actions_RestController
44{
45    use TaskLogActionTrait;
46    use HttpJsonResponseTrait;
47
48    public const TASK_ID_PARAM = 'id';
49
50    public const ENABLE_METADATA_GUARDIANS = 'enableMetadataGuardians';
51
52    public const ENABLE_METADATA_VALIDATORS = 'enableMetadataValidators';
53
54    public const ITEM_MUST_EXIST = 'itemMustExist';
55
56    public const ITEM_MUST_BE_OVERWRITTEN = 'itemMustBeOverwritten';
57
58    protected static $accepted_types = [
59        'application/zip',
60        'application/x-zip-compressed',
61        'multipart/x-zip',
62        'application/x-compressed'
63    ];
64
65    /**
66     * Name of the task created by the child.
67     *
68     * @return string
69     */
70    abstract protected function getTaskName();
71
72    /**
73     * Action to retrieve test import status from queue
74     */
75    public function getStatus()
76    {
77        try {
78            if (!$this->hasRequestParameter(self::TASK_ID_PARAM)) {
79                throw new \common_exception_MissingParameter(self::TASK_ID_PARAM, $this->getRequestURI());
80            }
81
82            $data = $this->getTaskLogReturnData(
83                $this->getRequestParameter(self::TASK_ID_PARAM),
84                $this->getTaskName()
85            );
86
87            $this->returnSuccess($data);
88        } catch (\Exception $e) {
89            $this->returnFailure($e);
90        }
91    }
92
93    /**
94     * Return 'Success' instead of 'Completed', required by the specified API.
95     *
96     * @param EntityInterface $taskLogEntity
97     * @return string
98     */
99    protected function getTaskStatus(EntityInterface $taskLogEntity)
100    {
101        if ($taskLogEntity->getStatus()->isCreated()) {
102            return __('In Progress');
103        } elseif ($taskLogEntity->getStatus()->isCompleted()) {
104            return __('Success');
105        }
106
107        return $taskLogEntity->getStatus()->getLabel();
108    }
109
110    /**
111     * @return bool
112     * @throws \common_exception_RestApi
113     */
114    protected function isMetadataGuardiansEnabled()
115    {
116        $enableMetadataGuardians = $this->getRequestParameter(self::ENABLE_METADATA_GUARDIANS);
117
118        if (is_null($enableMetadataGuardians)) {
119            return true; // default value if parameter not passed
120        }
121
122        if (!in_array($enableMetadataGuardians, ['true', 'false'])) {
123            throw new \common_exception_RestApi(
124                self::ENABLE_METADATA_GUARDIANS . ' parameter should be boolean (true or false).'
125            );
126        }
127
128        return filter_var($enableMetadataGuardians, FILTER_VALIDATE_BOOLEAN);
129    }
130
131    /**
132     * @return bool
133     * @throws \common_exception_RestApi
134     */
135    protected function isMetadataValidatorsEnabled()
136    {
137        $enableMetadataValidators = $this->getRequestParameter(self::ENABLE_METADATA_VALIDATORS);
138
139        if (is_null($enableMetadataValidators)) {
140            return true; // default value if parameter not passed
141        }
142
143        if (!in_array($enableMetadataValidators, ['true', 'false'])) {
144            throw new \common_exception_RestApi(
145                self::ENABLE_METADATA_VALIDATORS . ' parameter should be boolean (true or false).'
146            );
147        }
148
149        return filter_var($enableMetadataValidators, FILTER_VALIDATE_BOOLEAN);
150    }
151
152    /**
153     * @return bool
154     * @throws \common_exception_RestApi
155     */
156    protected function isItemMustExistEnabled()
157    {
158        $itemMustExistEnabled = $this->getRequestParameter(self::ITEM_MUST_EXIST);
159
160        if (is_null($itemMustExistEnabled)) {
161            return false; // default value if parameter not passed
162        }
163
164        if (!in_array($itemMustExistEnabled, ['true', 'false'])) {
165            throw new \common_exception_RestApi(
166                self::ITEM_MUST_EXIST . ' parameter should be boolean (true or false).'
167            );
168        }
169
170        return filter_var($itemMustExistEnabled, FILTER_VALIDATE_BOOLEAN);
171    }
172
173    /**
174     * @return bool
175     * @throws \common_exception_RestApi
176     */
177    protected function isItemMustBeOverwrittenEnabled()
178    {
179        $isItemMustBeOverwrittenEnabled = $this->getRequestParameter(self::ITEM_MUST_BE_OVERWRITTEN);
180
181        if (is_null($isItemMustBeOverwrittenEnabled)) {
182            return false; // default value if parameter not passed
183        }
184
185        if (!in_array($isItemMustBeOverwrittenEnabled, ['true', 'false'])) {
186            throw new \common_exception_RestApi(
187                self::ITEM_MUST_BE_OVERWRITTEN . ' parameter should be boolean (true or false).'
188            );
189        }
190
191        return filter_var($isItemMustBeOverwrittenEnabled, FILTER_VALIDATE_BOOLEAN);
192    }
193
194    /**
195     * Update metadata by parameters
196     */
197    public function updateMetadata(): void
198    {
199        if ($this->getRequestMethod() !== Request::HTTP_POST) {
200            throw new HttpMethodNotAllowedException(null, 0, [Request::HTTP_POST]);
201        }
202
203        try {
204            $metadataInput = $this->getUpdateMetadataRequestHandler()->handle(
205                $this->getPsrRequest()
206            );
207
208            $resourceIdentifier = $metadataInput->getResource()->getUri();
209
210            $this->getMetadataService()->getImporter()->setMetadataValues(
211                [$resourceIdentifier => [$metadataInput->getMetadata()]]
212            );
213
214            $this->getMetadataService()->getImporter()->inject(
215                $resourceIdentifier,
216                $metadataInput->getResource()
217            );
218        } catch (JsonException | InvalidArgumentException $exception) {
219            throw new BadRequestException($exception->getMessage(), 400);
220        } catch (RuntimeException $exception) {
221            throw new BadRequestException($exception->getMessage(), 422);
222        }
223
224        $this->setSuccessJsonResponse($metadataInput);
225    }
226
227    private function getUpdateMetadataRequestHandler(): UpdateMetadataRequestHandler
228    {
229        return $this->getPsrContainer()->get(UpdateMetadataRequestHandler::class);
230    }
231
232    private function getMetadataService(): MetadataService
233    {
234        return $this->getPsrContainer()->get(MetadataService::SERVICE_ID);
235    }
236}