Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
| Total | |
0.00% |
0 / 90 |
|
0.00% |
0 / 7 |
CRAP | |
0.00% |
0 / 1 |
| RestTask | |
0.00% |
0 / 90 |
|
0.00% |
0 / 7 |
552 | |
0.00% |
0 / 1 |
| __construct | |
0.00% |
0 / 2 |
|
0.00% |
0 / 1 |
2 | |||
| getAll | |
0.00% |
0 / 12 |
|
0.00% |
0 / 1 |
20 | |||
| get | |
0.00% |
0 / 20 |
|
0.00% |
0 / 1 |
20 | |||
| stats | |
0.00% |
0 / 7 |
|
0.00% |
0 / 1 |
6 | |||
| archive | |
0.00% |
0 / 19 |
|
0.00% |
0 / 1 |
30 | |||
| download | |
0.00% |
0 / 28 |
|
0.00% |
0 / 1 |
30 | |||
| assertTaskIdExists | |
0.00% |
0 / 2 |
|
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) 2017 (original work) Open Assessment Technologies SA (under the project TAO-PRODUCT); |
| 19 | * |
| 20 | */ |
| 21 | |
| 22 | namespace oat\taoTaskQueue\controller; |
| 23 | |
| 24 | use common_session_SessionManager; |
| 25 | use oat\oatbox\filesystem\FileSystemService; |
| 26 | use oat\tao\model\routing\AnnotationReader\security; |
| 27 | use oat\taoTaskQueue\model\TaskLogInterface; |
| 28 | |
| 29 | /** |
| 30 | * @deprecated Use oat\taoTaskQueue\controller\TaskQueueWebApi instead! |
| 31 | */ |
| 32 | class RestTask extends \tao_actions_CommonModule |
| 33 | { |
| 34 | public const PARAMETER_TASK_ID = 'taskId'; |
| 35 | public const PARAMETER_LIMIT = 'limit'; |
| 36 | public const PARAMETER_OFFSET = 'offset'; |
| 37 | |
| 38 | /** @var string */ |
| 39 | private $userId; |
| 40 | |
| 41 | /** |
| 42 | * @inheritdoc |
| 43 | * @security("hide") |
| 44 | */ |
| 45 | public function __construct() |
| 46 | { |
| 47 | parent::__construct(); |
| 48 | |
| 49 | $this->userId = common_session_SessionManager::getSession()->getUserUri(); |
| 50 | } |
| 51 | |
| 52 | /** |
| 53 | * @throws \common_exception_NotImplemented |
| 54 | */ |
| 55 | public function getAll() |
| 56 | { |
| 57 | if (!\tao_helpers_Request::isAjax()) { |
| 58 | throw new \Exception('Only ajax call allowed.'); |
| 59 | } |
| 60 | |
| 61 | /** @var TaskLogInterface $taskLogService */ |
| 62 | $taskLogService = $this->getServiceManager()->get(TaskLogInterface::SERVICE_ID); |
| 63 | $limit = $offset = null; |
| 64 | |
| 65 | if ($this->hasRequestParameter(self::PARAMETER_LIMIT)) { |
| 66 | $limit = (int) $this->getRequestParameter(self::PARAMETER_LIMIT); |
| 67 | } |
| 68 | |
| 69 | if ($this->hasRequestParameter(self::PARAMETER_OFFSET)) { |
| 70 | $offset = (int) $this->getRequestParameter(self::PARAMETER_OFFSET); |
| 71 | } |
| 72 | |
| 73 | return $this->returnJson([ |
| 74 | 'success' => true, |
| 75 | 'data' => $taskLogService->findAvailableByUser($this->userId, $limit, $offset)->toArray() |
| 76 | ]); |
| 77 | } |
| 78 | |
| 79 | /** |
| 80 | * @throws \common_exception_NotImplemented |
| 81 | */ |
| 82 | public function get() |
| 83 | { |
| 84 | if (!\tao_helpers_Request::isAjax()) { |
| 85 | throw new \Exception('Only ajax call allowed.'); |
| 86 | } |
| 87 | |
| 88 | /** @var TaskLogInterface $taskLogService */ |
| 89 | $taskLogService = $this->getServiceManager()->get(TaskLogInterface::SERVICE_ID); |
| 90 | |
| 91 | try { |
| 92 | $this->assertTaskIdExists(); |
| 93 | |
| 94 | $response = $taskLogService->getByIdAndUser( |
| 95 | $this->getRequestParameter(self::PARAMETER_TASK_ID), |
| 96 | $this->userId |
| 97 | ); |
| 98 | |
| 99 | return $this->returnJson([ |
| 100 | 'success' => true, |
| 101 | 'data' => $response->toArray() |
| 102 | ]); |
| 103 | } catch (\Exception $e) { |
| 104 | return $this->returnJson([ |
| 105 | 'success' => false, |
| 106 | 'errorMsg' => $e instanceof \common_exception_UserReadableException |
| 107 | ? $e->getUserMessage() |
| 108 | : $e->getMessage(), |
| 109 | 'errorCode' => $e->getCode(), |
| 110 | ]); |
| 111 | } |
| 112 | } |
| 113 | |
| 114 | /** |
| 115 | * @throws \common_exception_NotImplemented |
| 116 | */ |
| 117 | public function stats() |
| 118 | { |
| 119 | if (!\tao_helpers_Request::isAjax()) { |
| 120 | throw new \Exception('Only ajax call allowed.'); |
| 121 | } |
| 122 | |
| 123 | /** @var TaskLogInterface $taskLogService */ |
| 124 | $taskLogService = $this->getServiceManager()->get(TaskLogInterface::SERVICE_ID); |
| 125 | |
| 126 | return $this->returnJson([ |
| 127 | 'success' => true, |
| 128 | 'data' => $taskLogService->getStats($this->userId)->toArray() |
| 129 | ]); |
| 130 | } |
| 131 | |
| 132 | /** |
| 133 | * @throws \common_exception_NotImplemented |
| 134 | */ |
| 135 | public function archive() |
| 136 | { |
| 137 | if (!\tao_helpers_Request::isAjax()) { |
| 138 | throw new \Exception('Only ajax call allowed.'); |
| 139 | } |
| 140 | |
| 141 | try { |
| 142 | $this->assertTaskIdExists(); |
| 143 | |
| 144 | /** @var TaskLogInterface $taskLogService */ |
| 145 | $taskLogService = $this->getServiceManager()->get(TaskLogInterface::SERVICE_ID); |
| 146 | |
| 147 | $taskLogEntity = $taskLogService->getByIdAndUser( |
| 148 | $this->getRequestParameter(self::PARAMETER_TASK_ID), |
| 149 | $this->userId |
| 150 | ); |
| 151 | |
| 152 | return $this->returnJson([ |
| 153 | 'success' => (bool) $taskLogService->archive($taskLogEntity) |
| 154 | ]); |
| 155 | } catch (\Exception $e) { |
| 156 | return $this->returnJson([ |
| 157 | 'success' => false, |
| 158 | 'errorMsg' => $e instanceof \common_exception_UserReadableException |
| 159 | ? $e->getUserMessage() |
| 160 | : $e->getMessage(), |
| 161 | 'errorCode' => $e instanceof \common_exception_NotFound ? 404 : $e->getCode(), |
| 162 | ]); |
| 163 | } |
| 164 | } |
| 165 | |
| 166 | /** |
| 167 | * Download the file created by task. |
| 168 | */ |
| 169 | public function download() |
| 170 | { |
| 171 | try { |
| 172 | $this->assertTaskIdExists(); |
| 173 | |
| 174 | /** @var TaskLogInterface $taskLogService */ |
| 175 | $taskLogService = $this->getServiceManager()->get(TaskLogInterface::SERVICE_ID); |
| 176 | |
| 177 | $taskLogEntity = $taskLogService->getByIdAndUser( |
| 178 | $this->getRequestParameter(self::PARAMETER_TASK_ID), |
| 179 | $this->userId |
| 180 | ); |
| 181 | |
| 182 | if (!$taskLogEntity->getStatus()->isCompleted()) { |
| 183 | throw new \RuntimeException('Task "' . $taskLogEntity->getId() . '" is not downloadable.'); |
| 184 | } |
| 185 | |
| 186 | $filename = $taskLogEntity->getFileNameFromReport(); |
| 187 | |
| 188 | if (empty($filename)) { |
| 189 | throw new \LogicException('Filename not found in report.'); |
| 190 | } |
| 191 | |
| 192 | /** @var FileSystemService $fileSystem */ |
| 193 | $fileSystem = $this->getServiceManager()->get(FileSystemService::SERVICE_ID); |
| 194 | $directory = $fileSystem->getDirectory('taskQueueStorage'); |
| 195 | $file = $directory->getFile($filename); |
| 196 | |
| 197 | header('Set-Cookie: fileDownload=true'); |
| 198 | setcookie('fileDownload', 'true', 0, '/'); |
| 199 | header('Content-Disposition: attachment; filename="' . $filename . '"'); |
| 200 | header('Content-Type: ' . $file->getMimeType()); |
| 201 | |
| 202 | \tao_helpers_Http::returnStream($file->readPsrStream()); |
| 203 | exit(); |
| 204 | } catch (\Exception $e) { |
| 205 | return $this->returnJson([ |
| 206 | 'success' => false, |
| 207 | 'errorMsg' => $e instanceof \common_exception_UserReadableException |
| 208 | ? $e->getUserMessage() |
| 209 | : $e->getMessage(), |
| 210 | 'errorCode' => $e->getCode(), |
| 211 | ]); |
| 212 | } |
| 213 | } |
| 214 | |
| 215 | /** |
| 216 | * @throws \common_exception_MissingParameter |
| 217 | */ |
| 218 | protected function assertTaskIdExists() |
| 219 | { |
| 220 | if (!$this->hasRequestParameter(self::PARAMETER_TASK_ID)) { |
| 221 | throw new \common_exception_MissingParameter(self::PARAMETER_TASK_ID, $this->getRequestURI()); |
| 222 | } |
| 223 | } |
| 224 | } |