Total Complexity | 104 |
Total Lines | 593 |
Duplicated Lines | 0 % |
Changes | 0 |
Complex classes like AjaxController often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use AjaxController, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
55 | class AjaxController |
||
56 | { |
||
57 | /** |
||
58 | * @return JsonResponse |
||
59 | */ |
||
60 | public function getNewStorageUrlAction(): JsonResponse |
||
61 | { |
||
62 | $backendUser = $this->getBackendUser(); |
||
63 | if (!$backendUser->isAdmin()) { |
||
64 | return new JsonExceptionResponse(new ControllerException('User is not admin', 1554380677)); |
||
65 | } |
||
66 | $uriBuilder = GeneralUtility::makeInstance(UriBuilder::class); |
||
67 | $urlParameters = [ |
||
68 | 'edit' => [ |
||
69 | 'sys_file_storage' => [ |
||
70 | 0 => 'new', |
||
71 | ], |
||
72 | ], |
||
73 | 'returnUrl' => (string)$uriBuilder->buildUriFromRoute('file_DigitalAssetManagement'), |
||
74 | ]; |
||
75 | return new JsonResponse([(string)$uriBuilder->buildUriFromRoute('record_edit', $urlParameters)]); |
||
76 | } |
||
77 | |||
78 | /** |
||
79 | * @param ServerRequestInterface $request |
||
80 | * @return Response |
||
81 | */ |
||
82 | public function prepareDownloadAction(ServerRequestInterface $request): JsonResponse |
||
122 | } |
||
123 | |||
124 | /** |
||
125 | * @param Folder $folder |
||
126 | * @param \ZipArchive $zip |
||
127 | * @param array $parentFolders |
||
128 | */ |
||
129 | protected function addFolderToArchiveRecursive(Folder $folder, \ZipArchive $zip, array $parentFolders = []): void |
||
142 | } |
||
143 | } |
||
144 | |||
145 | /** |
||
146 | * @return JsonResponse |
||
147 | */ |
||
148 | public function damGetLogoutUrlAction(): JsonResponse |
||
149 | { |
||
150 | if (empty($this->getBackendUser()->user['uid'])) { |
||
151 | return new JsonExceptionResponse(new ControllerException('User is not logged in', 1554380677)); |
||
152 | } |
||
153 | $uriBuilder = GeneralUtility::makeInstance(UriBuilder::class); |
||
154 | return new JsonResponse([ (string)$uriBuilder->buildUriFromRoute('logout') ]); |
||
155 | } |
||
156 | |||
157 | /** |
||
158 | * Set module state of BE user. Send a json array as ['data'] POST |
||
159 | * |
||
160 | * @param ServerRequestInterface $request |
||
161 | * @return JsonResponse |
||
162 | */ |
||
163 | public function setStateAction(ServerRequestInterface $request): JsonResponse |
||
164 | { |
||
165 | $backendUser = $this->getBackendUser(); |
||
166 | $backendUser->uc['digital_asset_management'] = $request->getParsedBody()['data'] ?? []; |
||
167 | $backendUser->writeUC(); |
||
168 | return new JsonResponse(); |
||
169 | } |
||
170 | |||
171 | /** |
||
172 | * @return JsonResponse |
||
173 | */ |
||
174 | public function getStateAction(): JsonResponse |
||
177 | } |
||
178 | |||
179 | /** |
||
180 | * @param ServerRequestInterface $request |
||
181 | * |
||
182 | * @return JsonResponse |
||
183 | */ |
||
184 | public function createFolderAction(ServerRequestInterface $request): JsonResponse |
||
185 | { |
||
186 | $identifier = $request->getQueryParams()['identifier'] ?? ''; |
||
187 | if (empty($identifier)) { |
||
188 | return new JsonExceptionResponse(new ControllerException('Identifier needed', 1554204780)); |
||
189 | } |
||
190 | try { |
||
191 | $folder = $this->createFolderRecursive($identifier); |
||
192 | return new JsonResponse([new FolderItemFolder($folder)]); |
||
193 | } catch (ResourceException $e) { |
||
194 | return new JsonExceptionResponse($e); |
||
195 | } |
||
196 | } |
||
197 | |||
198 | /** |
||
199 | * @param ServerRequestInterface $request |
||
200 | * |
||
201 | * @return JsonResponse |
||
202 | */ |
||
203 | public function fileUploadAction(ServerRequestInterface $request): JsonResponse |
||
204 | { |
||
205 | $identifier = $request->getQueryParams()['identifier'] ?? ''; |
||
206 | $conflictMode = $request->getQueryParams()['conflictMode'] ?? ''; |
||
207 | $tempFilename = ''; |
||
208 | try { |
||
209 | if (empty($identifier)) { |
||
210 | throw new ControllerException('Identifier needed', 1554132801); |
||
211 | } |
||
212 | if (empty($conflictMode) || !in_array($conflictMode, ['replace', 'cancel', 'rename'], true)) { |
||
213 | throw new ControllerException('conflictMode must be one of "replace", "cancel", "rename"'); |
||
214 | } |
||
215 | $folderIdentifier = dirname($identifier) . '/'; |
||
216 | $fileIdentifier = basename($identifier); |
||
217 | $resourceFactory = GeneralUtility::makeInstance(ResourceFactory::class); |
||
218 | try { |
||
219 | $folder = $resourceFactory->retrieveFileOrFolderObject($folderIdentifier); |
||
220 | } catch (ResourceDoesNotExistException $e) { |
||
221 | $folder = $this->createFolderRecursive($folderIdentifier); |
||
222 | } |
||
223 | $tempFilename = tempnam(sys_get_temp_dir(), 'upload_'); |
||
224 | file_put_contents($tempFilename, $request->getBody()); |
||
225 | $file = $folder->addFile($tempFilename, $fileIdentifier, (string)DuplicationBehavior::cast($conflictMode)); |
||
226 | $fileExtension = strtolower($file->getExtension()); |
||
227 | if (GeneralUtility::inList($GLOBALS['TYPO3_CONF_VARS']['GFX']['imagefile_ext'], $fileExtension) |
||
228 | || GeneralUtility::inList($GLOBALS['TYPO3_CONF_VARS']['GFX']['mediafile_ext'], $fileExtension) |
||
229 | ) { |
||
230 | return new JsonResponse([new FolderItemImage($file)]); |
||
231 | } |
||
232 | return new JsonResponse([new FolderItemFile($file)]); |
||
233 | } catch (ResourceException $e) { |
||
234 | if (!empty($tempFilename) && file_exists($tempFilename)) { |
||
235 | unlink($tempFilename); |
||
236 | } |
||
237 | return new JsonExceptionResponse($e); |
||
238 | } catch (ControllerException $e) { |
||
239 | return new JsonExceptionResponse($e); |
||
240 | } |
||
241 | } |
||
242 | |||
243 | /** |
||
244 | * @param string $folderIdentifier |
||
245 | * |
||
246 | * @return Folder |
||
247 | */ |
||
248 | protected function createFolderRecursive(string $folderIdentifier): Folder |
||
249 | { |
||
250 | $resourceFactory = GeneralUtility::makeInstance(ResourceFactory::class); |
||
251 | $stack = []; |
||
252 | while (true) { |
||
253 | $parentName = dirname($folderIdentifier); |
||
254 | $folderName = basename($folderIdentifier); |
||
255 | $stack[] = $folderName; |
||
256 | try { |
||
257 | $parentObject = $resourceFactory->retrieveFileOrFolderObject($parentName); |
||
258 | break; |
||
259 | } catch (ResourceDoesNotExistException $e) { |
||
260 | $folderIdentifier = $parentName; |
||
261 | } |
||
262 | } |
||
263 | while ($folderName = array_pop($stack)) { |
||
264 | try { |
||
265 | $parentObject = $parentObject->createFolder($folderName); |
||
|
|||
266 | } catch (ResourceException $e) { |
||
267 | } |
||
268 | } |
||
269 | return $parentObject; |
||
270 | } |
||
271 | |||
272 | /** |
||
273 | * @param ServerRequestInterface $request |
||
274 | * |
||
275 | * @return JsonResponse |
||
276 | */ |
||
277 | public function fileExistsAction(ServerRequestInterface $request): JsonResponse |
||
278 | { |
||
279 | $identifier = $request->getQueryParams()['identifier']; |
||
280 | if (empty($identifier)) { |
||
281 | return new JsonExceptionResponse(new ControllerException('Identifier needed', 1554125449)); |
||
282 | } |
||
283 | $resourceFactory = GeneralUtility::makeInstance(ResourceFactory::class); |
||
284 | $folderIdentifier = dirname($identifier) . '/'; |
||
285 | $fileIdentifier = basename($identifier); |
||
286 | try { |
||
287 | $folder = $resourceFactory->retrieveFileOrFolderObject($folderIdentifier); |
||
288 | } catch (ResourceDoesNotExistException $e) { |
||
289 | return new FileExistsResponse(FileExistsResponse::PARENT_FOLDER_DOES_NOT_EXIST); |
||
290 | } |
||
291 | $fileName = $folder->getStorage()->sanitizeFileName($fileIdentifier, $folder); |
||
292 | if ($folder->hasFile($fileName)) { |
||
293 | $file = $resourceFactory->getFileObjectFromCombinedIdentifier($folderIdentifier . $fileName); |
||
294 | // If file is an image or media, create image object, else file object |
||
295 | $fileExtension = strtolower($file->getExtension()); |
||
296 | if (GeneralUtility::inList($GLOBALS['TYPO3_CONF_VARS']['GFX']['imagefile_ext'], $fileExtension) |
||
297 | || GeneralUtility::inList($GLOBALS['TYPO3_CONF_VARS']['GFX']['mediafile_ext'], $fileExtension) |
||
298 | ) { |
||
299 | return new JsonResponse([new FolderItemImage($file)]); |
||
300 | } |
||
301 | return new JsonResponse([new FolderItemFile($file)]); |
||
302 | } else { |
||
303 | return new FileExistsResponse(FileExistsResponse::FILE_DOES_NOT_EXIST); |
||
304 | } |
||
305 | } |
||
306 | |||
307 | /** |
||
308 | * Return item list (folders, files, images) of a storage:path |
||
309 | * FAL folder identifier. GET request with identifier argument. |
||
310 | * |
||
311 | * @param ServerRequestInterface $request |
||
312 | * |
||
313 | * @return JsonResponse |
||
314 | */ |
||
315 | public function getFolderItemsAction(ServerRequestInterface $request): JsonResponse |
||
316 | { |
||
317 | try { |
||
318 | $identifier = $request->getQueryParams()['identifier'] ?? ''; |
||
319 | if (empty($identifier)) { |
||
320 | throw new ControllerException('Identifier needed', 1553699828); |
||
321 | } |
||
322 | $resourceFactory = GeneralUtility::makeInstance(ResourceFactory::class); |
||
323 | $folderObject = $resourceFactory->getObjectFromCombinedIdentifier($identifier); |
||
324 | if (!$folderObject instanceof Folder) { |
||
325 | throw new ControllerException('Identifier is not a folder', 1553701684); |
||
326 | } |
||
327 | $subFolders = $folderObject->getSubfolders(); |
||
328 | $folders = []; |
||
329 | foreach ($subFolders as $subFolder) { |
||
330 | $folders[] = new FolderItemFolder($subFolder); |
||
331 | } |
||
332 | $allFiles = $folderObject->getFiles(); |
||
333 | $files = []; |
||
334 | $images = []; |
||
335 | foreach ($allFiles as $file) { |
||
336 | // If file is an image or media, create image object, else file object |
||
337 | $fileExtension = strtolower($file->getExtension()); |
||
338 | if (GeneralUtility::inList($GLOBALS['TYPO3_CONF_VARS']['GFX']['imagefile_ext'], $fileExtension) |
||
339 | || GeneralUtility::inList($GLOBALS['TYPO3_CONF_VARS']['GFX']['mediafile_ext'], $fileExtension) |
||
340 | ) { |
||
341 | $images[] = new FolderItemImage($file); |
||
342 | } else { |
||
343 | $files[] = new FolderItemFile($file); |
||
344 | } |
||
345 | } |
||
346 | return new FolderItemsResponse($folders, $files, $images); |
||
347 | } catch (ResourceException $e) { |
||
348 | return new JsonExceptionResponse($e); |
||
349 | } catch (ControllerException $e) { |
||
350 | return new JsonExceptionResponse($e); |
||
351 | } |
||
352 | } |
||
353 | |||
354 | /** |
||
355 | * Returns list of storages (admins), or file mounts (non-admin). Admins |
||
356 | * do NOT receive a list of file mounts, just the storages. |
||
357 | * |
||
358 | * Storages are returned in no particular order, file mounts are ordered |
||
359 | * by 'sorting' DB field. |
||
360 | * |
||
361 | * Return structure is an array of Storage or FileMount objects. |
||
362 | * |
||
363 | * @return JsonResponse |
||
364 | */ |
||
365 | public function getStoragesAndMountsAction(): JsonResponse |
||
366 | { |
||
367 | $backendUser = $this->getBackendUser(); |
||
368 | $storages = $backendUser->getFileStorages(); |
||
369 | $entities = []; |
||
370 | if ($backendUser->isAdmin()) { |
||
371 | foreach ($storages as $storage) { |
||
372 | $entities[] = new Storage($storage); |
||
373 | } |
||
374 | } else { |
||
375 | foreach ($storages as $storage) { |
||
376 | $fileMounts = $storage->getFileMounts(); |
||
377 | foreach ($fileMounts as $fileMount) { |
||
378 | $entities[] = new FileMount($storage, $fileMount); |
||
379 | } |
||
380 | } |
||
381 | } |
||
382 | return new StoragesAndMountsResponse($entities); |
||
383 | } |
||
384 | |||
385 | /** |
||
386 | * Returns list of folders only. No files, no images |
||
387 | * Result is sorted by name |
||
388 | * |
||
389 | * Return structure is an array of TreeItemFolder objects. |
||
390 | * |
||
391 | * @param ServerRequestInterface $request |
||
392 | * |
||
393 | * @return JsonResponse |
||
394 | */ |
||
395 | public function getTreeFoldersAction(ServerRequestInterface $request): JsonResponse |
||
417 | } |
||
418 | } |
||
419 | |||
420 | /** |
||
421 | * Copy files or folders |
||
422 | * Query parameters |
||
423 | * 'identifiers' array of identifier to copy |
||
424 | * 'targetFolderIdentifier' string the target identifier. Must be a folder. |
||
425 | * 'conflictMode' string one of: "replace", "cancel", "rename", as defined in \TYPO3\CMS\Core\Resource\DuplicationBehavior |
||
426 | * |
||
427 | * @param ServerRequestInterface $request |
||
428 | * |
||
429 | * @return JsonResponse |
||
430 | */ |
||
431 | public function copyResourcesAction(ServerRequestInterface $request): JsonResponse |
||
432 | { |
||
433 | try { |
||
434 | $identifiers = $request->getQueryParams()['identifiers']; |
||
435 | $conflictMode = $request->getQueryParams()['conflictMode'] ?? ''; |
||
436 | $targetFolderIdentifier = $request->getQueryParams()['targetFolderIdentifier']; |
||
437 | if (empty($identifiers)) { |
||
438 | throw new ControllerException('Identifiers needed', 1553699828); |
||
439 | } |
||
440 | if (empty($conflictMode) || !in_array($conflictMode, ['replace', 'cancel', 'rename'], true)) { |
||
441 | throw new ControllerException('conflictMode must be one of "replace", "cancel", "rename"'); |
||
442 | } |
||
443 | if (empty($targetFolderIdentifier)) { |
||
444 | throw new ControllerException( |
||
445 | 'Target folder identifier needed', |
||
446 | 1554122023 |
||
447 | ); |
||
448 | } |
||
449 | $resourceFactory = GeneralUtility::makeInstance(ResourceFactory::class); |
||
450 | $targetFolderObject = $resourceFactory->getObjectFromCombinedIdentifier($targetFolderIdentifier); |
||
451 | if (!$targetFolderObject instanceof Folder) { |
||
452 | throw new ControllerException('Target identifier is not a folder', 1553701684); |
||
453 | } |
||
454 | } catch (ResourceException $e) { |
||
455 | return new JsonExceptionResponse($e); |
||
456 | } catch (ControllerException $e) { |
||
457 | return new JsonExceptionResponse($e); |
||
458 | } |
||
459 | $resources = []; |
||
460 | foreach ($identifiers as $identifier) { |
||
461 | $state = FileOperationResult::FAILED; |
||
462 | $message = ''; |
||
463 | $resultEntity = null; |
||
464 | try { |
||
465 | $sourceObject = $resourceFactory->getObjectFromCombinedIdentifier($identifier); |
||
466 | if ($resultObject = $sourceObject->copyTo($targetFolderObject, null, (string)DuplicationBehavior::cast($conflictMode))) { |
||
467 | if ($resultObject instanceof Folder) { |
||
468 | $resultEntity = new FolderItemFolder($resultObject); |
||
469 | } else { |
||
470 | $resultEntity = new FolderItemFile($resultObject); |
||
471 | } |
||
472 | $state = FileOperationResult::COPIED; |
||
473 | } |
||
474 | } catch (InvalidTargetFolderException $e) { |
||
475 | $message = $e->getMessage(); |
||
476 | } catch (ResourceException $e) { |
||
477 | $message = $e->getMessage(); |
||
478 | } |
||
479 | $resources[] = new FileOperationResult($identifier, $state, $message, $resultEntity); |
||
480 | } |
||
481 | return new FileOperationResponse($resources); |
||
482 | } |
||
483 | |||
484 | /** |
||
485 | * Move files or folders |
||
486 | * Query parameters |
||
487 | * 'identifiers' array of identifier to move |
||
488 | * 'targetFolderIdentifier' string the target identifier. Must be a folder. |
||
489 | * 'conflictMode' string one of: "replace", "cancel", "rename", as defined in \TYPO3\CMS\Core\Resource\DuplicationBehavior |
||
490 | * |
||
491 | * @param ServerRequestInterface $request |
||
492 | * |
||
493 | * @return JsonResponse |
||
494 | */ |
||
495 | public function moveResourcesAction(ServerRequestInterface $request): JsonResponse |
||
543 | } |
||
544 | |||
545 | /** |
||
546 | * rename file or folder |
||
547 | * Query parameters |
||
548 | * 'identifier' string identifier to rename |
||
549 | * 'targetName' string The new name of file or folder. |
||
550 | * 'conflictMode' string one of: "replace", "cancel", "rename" |
||
551 | * |
||
552 | * @param ServerRequestInterface $request |
||
553 | * |
||
554 | * @return JsonResponse |
||
555 | */ |
||
556 | public function renameResourcesAction(ServerRequestInterface $request): JsonResponse |
||
557 | { |
||
558 | try { |
||
559 | $identifier = $request->getQueryParams()['identifier']; |
||
560 | $targetName = $request->getQueryParams()['targetName']; |
||
561 | $conflictMode = $request->getQueryParams()['conflictMode'] ?? ''; |
||
562 | if (empty($identifier)) { |
||
563 | throw new ControllerException('Identifier needed', 1553699828); |
||
564 | } |
||
565 | if (empty($conflictMode) || !in_array($conflictMode, ['replace', 'cancel', 'rename'], true)) { |
||
566 | throw new ControllerException('conflictMode must be one of "replace", "cancel", "rename"'); |
||
567 | } |
||
568 | if (empty($targetName)) { |
||
569 | throw new ControllerException('Target name needed', 1554193259); |
||
570 | } |
||
571 | $resourceFactory = GeneralUtility::makeInstance(ResourceFactory::class); |
||
572 | $fileOrFolder = $resourceFactory->retrieveFileOrFolderObject($identifier); |
||
573 | } catch (ResourceException $e) { |
||
574 | return new JsonExceptionResponse($e); |
||
575 | } catch (ControllerException $e) { |
||
576 | return new JsonExceptionResponse($e); |
||
577 | } |
||
578 | $resources = []; |
||
579 | $state = FileOperationResult::FAILED; |
||
580 | $resultEntity = null; |
||
581 | try { |
||
582 | if ($fileOrFolder === null) { |
||
583 | throw new ResourceException\ResourceDoesNotExistException('Resource does not exist'); |
||
584 | } else { |
||
585 | $resultObject = $fileOrFolder->rename($targetName, (string)DuplicationBehavior::cast($conflictMode)); |
||
586 | if ($resultObject instanceof Folder) { |
||
587 | $resultEntity = new FolderItemFolder($resultObject); |
||
588 | $message = 'Folder was successfully renamed'; |
||
589 | } else { |
||
590 | $resultEntity = new FolderItemFile($resultObject); |
||
591 | $message = 'File was successfully renamed'; |
||
592 | } |
||
593 | $state = FileOperationResult::RENAMED; |
||
594 | } |
||
595 | } catch (ResourceException $e) { |
||
596 | $message = $e->getMessage(); |
||
597 | } |
||
598 | $resources[] = new FileOperationResult($identifier, $state, $message, $resultEntity); |
||
599 | return new JsonResponse($resources); |
||
600 | } |
||
601 | |||
602 | /** |
||
603 | * delete file or folder |
||
604 | * Query parameters |
||
605 | * 'identifiers' array of strings identifier of file or folder to delete |
||
606 | * |
||
607 | * @param ServerRequestInterface $request |
||
608 | * |
||
609 | * @return JsonResponse |
||
610 | */ |
||
611 | public function deleteResourcesAction(ServerRequestInterface $request): JsonResponse |
||
612 | { |
||
613 | try { |
||
614 | $identifiers = $request->getQueryParams()['identifiers']; |
||
615 | if (empty($identifiers)) { |
||
616 | throw new ControllerException('Identifiers needed', 1553699828); |
||
617 | } |
||
618 | } catch (ControllerException $e) { |
||
619 | return new JsonExceptionResponse($e); |
||
620 | } |
||
621 | $resourceFactory = GeneralUtility::makeInstance(ResourceFactory::class); |
||
622 | $resources = []; |
||
623 | foreach ($identifiers as $identifier) { |
||
624 | try { |
||
625 | $sourceObject = $resourceFactory->getObjectFromCombinedIdentifier($identifier); |
||
626 | if ($sourceObject->delete(true)) { |
||
627 | $state = FileOperationResult::DELETED; |
||
628 | $message = 'Resource deleted'; |
||
629 | } else { |
||
630 | $state = FileOperationResult::FAILED; |
||
631 | $message = 'Resource could not be deleted'; |
||
632 | } |
||
633 | } catch (ResourceException $e) { |
||
634 | $state = FileOperationResult::FAILED; |
||
635 | $message = $e->getMessage(); |
||
636 | } |
||
637 | $resources[] = new FileOperationResult($identifier, $state, $message, null); |
||
638 | } |
||
639 | return new FileOperationResponse($resources); |
||
640 | } |
||
641 | |||
642 | /** |
||
643 | * @return BackendUserAuthentication |
||
644 | */ |
||
645 | protected function getBackendUser(): BackendUserAuthentication |
||
648 | } |
||
649 | } |
||
650 |