chamilo /
chamilo-lms
| Total Complexity | 96 |
| Total Lines | 588 |
| Duplicated Lines | 0 % |
| Changes | 0 | ||
Complex classes like BaseResourceFileAction 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 BaseResourceFileAction, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 32 | class BaseResourceFileAction |
||
| 33 | { |
||
| 34 | public static function setLinks(AbstractResource $resource, EntityManagerInterface $em): void |
||
| 35 | { |
||
| 36 | $resourceNode = $resource->getResourceNode(); |
||
| 37 | $links = $resource->getResourceLinkArray(); |
||
| 38 | if ($links) { |
||
|
|
|||
| 39 | $groupRepo = $em->getRepository(CGroup::class); |
||
| 40 | $courseRepo = $em->getRepository(Course::class); |
||
| 41 | $sessionRepo = $em->getRepository(Session::class); |
||
| 42 | $userRepo = $em->getRepository(User::class); |
||
| 43 | |||
| 44 | foreach ($links as $link) { |
||
| 45 | $resourceLink = new ResourceLink(); |
||
| 46 | $linkSet = false; |
||
| 47 | if (isset($link['cid']) && !empty($link['cid'])) { |
||
| 48 | $course = $courseRepo->find($link['cid']); |
||
| 49 | if (null !== $course) { |
||
| 50 | $linkSet = true; |
||
| 51 | $resourceLink->setCourse($course); |
||
| 52 | } else { |
||
| 53 | throw new InvalidArgumentException(\sprintf('Course #%s does not exists', $link['cid'])); |
||
| 54 | } |
||
| 55 | } |
||
| 56 | |||
| 57 | if (isset($link['sid']) && !empty($link['sid'])) { |
||
| 58 | $session = $sessionRepo->find($link['sid']); |
||
| 59 | if (null !== $session) { |
||
| 60 | $linkSet = true; |
||
| 61 | $resourceLink->setSession($session); |
||
| 62 | } else { |
||
| 63 | throw new InvalidArgumentException(\sprintf('Session #%s does not exists', $link['sid'])); |
||
| 64 | } |
||
| 65 | } |
||
| 66 | |||
| 67 | if (isset($link['gid']) && !empty($link['gid'])) { |
||
| 68 | $group = $groupRepo->find($link['gid']); |
||
| 69 | if (null !== $group) { |
||
| 70 | $linkSet = true; |
||
| 71 | $resourceLink->setGroup($group); |
||
| 72 | } else { |
||
| 73 | throw new InvalidArgumentException(\sprintf('Group #%s does not exists', $link['gid'])); |
||
| 74 | } |
||
| 75 | } |
||
| 76 | |||
| 77 | if (isset($link['uid']) && !empty($link['uid'])) { |
||
| 78 | $user = $userRepo->find($link['uid']); |
||
| 79 | if (null !== $user) { |
||
| 80 | $linkSet = true; |
||
| 81 | $resourceLink->setUser($user); |
||
| 82 | } else { |
||
| 83 | throw new InvalidArgumentException(\sprintf('User #%s does not exists', $link['uid'])); |
||
| 84 | } |
||
| 85 | } |
||
| 86 | |||
| 87 | if (isset($link['visibility'])) { |
||
| 88 | $resourceLink->setVisibility((int) $link['visibility']); |
||
| 89 | } else { |
||
| 90 | throw new InvalidArgumentException('Link needs a visibility key'); |
||
| 91 | } |
||
| 92 | |||
| 93 | if ($linkSet) { |
||
| 94 | $em->persist($resourceLink); |
||
| 95 | $resourceNode->addResourceLink($resourceLink); |
||
| 96 | // $em->persist($resourceNode); |
||
| 97 | // $em->persist($resource->getResourceNode()); |
||
| 98 | } |
||
| 99 | } |
||
| 100 | } |
||
| 101 | |||
| 102 | // Use by Chamilo not api platform. |
||
| 103 | $links = $resource->getResourceLinkEntityList(); |
||
| 104 | if ($links) { |
||
| 105 | // error_log('$resource->getResourceLinkEntityList()'); |
||
| 106 | foreach ($links as $link) { |
||
| 107 | /*$rights = []; |
||
| 108 | * switch ($link->getVisibility()) { |
||
| 109 | * case ResourceLink::VISIBILITY_PENDING: |
||
| 110 | * case ResourceLink::VISIBILITY_DRAFT: |
||
| 111 | * $editorMask = ResourceNodeVoter::getEditorMask(); |
||
| 112 | * $resourceRight = new ResourceRight(); |
||
| 113 | * $resourceRight |
||
| 114 | * ->setMask($editorMask) |
||
| 115 | * ->setRole(ResourceNodeVoter::ROLE_CURRENT_COURSE_TEACHER) |
||
| 116 | * ; |
||
| 117 | * $rights[] = $resourceRight; |
||
| 118 | * break; |
||
| 119 | * } |
||
| 120 | * if (!empty($rights)) { |
||
| 121 | * foreach ($rights as $right) { |
||
| 122 | * $link->addResourceRight($right); |
||
| 123 | * } |
||
| 124 | * }*/ |
||
| 125 | // error_log('link adding to node: '.$resource->getResourceNode()->getId()); |
||
| 126 | // error_log('link with user : '.$link->getUser()->getUsername()); |
||
| 127 | $resource->getResourceNode()->addResourceLink($link); |
||
| 128 | |||
| 129 | $em->persist($link); |
||
| 130 | } |
||
| 131 | } |
||
| 132 | } |
||
| 133 | |||
| 134 | /** |
||
| 135 | * @todo use this function inside handleCreateFileRequest |
||
| 136 | */ |
||
| 137 | protected function handleCreateRequest(AbstractResource $resource, ResourceRepository $resourceRepository, Request $request): array |
||
| 182 | } |
||
| 183 | |||
| 184 | /** |
||
| 185 | * Function loaded when creating a resource using the api, then the ResourceListener is executed. |
||
| 186 | */ |
||
| 187 | public function handleCreateFileRequest( |
||
| 188 | AbstractResource $resource, |
||
| 189 | ResourceRepository $resourceRepository, |
||
| 190 | Request $request, |
||
| 191 | EntityManager $em, |
||
| 192 | string $fileExistsOption = '' |
||
| 193 | ): array { |
||
| 194 | $contentData = $request->getContent(); |
||
| 195 | |||
| 196 | if (!empty($contentData)) { |
||
| 197 | $contentData = json_decode($contentData, true); |
||
| 198 | $title = $contentData['title'] ?? ''; |
||
| 199 | $comment = $contentData['comment'] ?? ''; |
||
| 200 | $parentResourceNodeId = (int) ($contentData['parentResourceNodeId'] ?? 0); |
||
| 201 | $fileType = $contentData['filetype'] ?? ''; |
||
| 202 | $resourceLinkList = $contentData['resourceLinkList'] ?? []; |
||
| 203 | } else { |
||
| 204 | $title = $request->get('title'); |
||
| 205 | $comment = $request->get('comment'); |
||
| 206 | $parentResourceNodeId = (int) $request->get('parentResourceNodeId'); |
||
| 207 | $fileType = $request->get('filetype'); |
||
| 208 | $resourceLinkList = $request->get('resourceLinkList', []); |
||
| 209 | if (!empty($resourceLinkList)) { |
||
| 210 | $resourceLinkList = !str_contains($resourceLinkList, '[') ? json_decode('['.$resourceLinkList.']', true) : json_decode($resourceLinkList, true); |
||
| 211 | if (empty($resourceLinkList)) { |
||
| 212 | $message = 'resourceLinkList is not a valid json. Use for example: [{"cid":1, "visibility":1}]'; |
||
| 213 | |||
| 214 | throw new InvalidArgumentException($message); |
||
| 215 | } |
||
| 216 | } |
||
| 217 | } |
||
| 218 | |||
| 219 | if (empty($fileType)) { |
||
| 220 | throw new Exception('filetype needed: folder or file'); |
||
| 221 | } |
||
| 222 | |||
| 223 | if (0 === $parentResourceNodeId) { |
||
| 224 | throw new Exception('parentResourceNodeId int value needed'); |
||
| 225 | } |
||
| 226 | |||
| 227 | $resource->setParentResourceNode($parentResourceNodeId); |
||
| 228 | |||
| 229 | switch ($fileType) { |
||
| 230 | case 'certificate': |
||
| 231 | case 'file': |
||
| 232 | $content = ''; |
||
| 233 | if ($request->request->has('contentFile')) { |
||
| 234 | $content = $request->request->get('contentFile'); |
||
| 235 | } |
||
| 236 | $fileParsed = false; |
||
| 237 | // File upload. |
||
| 238 | if ($request->files->count() > 0) { |
||
| 239 | if (!$request->files->has('uploadFile')) { |
||
| 240 | throw new BadRequestHttpException('"uploadFile" is required'); |
||
| 241 | } |
||
| 242 | |||
| 243 | /** @var UploadedFile $uploadedFile */ |
||
| 244 | $uploadedFile = $request->files->get('uploadFile'); |
||
| 245 | $title = $uploadedFile->getClientOriginalName(); |
||
| 246 | |||
| 247 | if (empty($title)) { |
||
| 248 | throw new InvalidArgumentException('title is required'); |
||
| 249 | } |
||
| 250 | |||
| 251 | // Handle the appropriate action based on the fileExistsOption |
||
| 252 | if (!empty($fileExistsOption)) { |
||
| 253 | // Check if a document with the same title and parent resource node already exists |
||
| 254 | $existingDocument = $resourceRepository->findByTitleAndParentResourceNode($title, $parentResourceNodeId); |
||
| 255 | if ($existingDocument) { |
||
| 256 | if ('overwrite' == $fileExistsOption) { |
||
| 257 | // Perform actions when file exists and 'overwrite' option is selected |
||
| 258 | $resource->setResourceName($title); |
||
| 259 | $existingDocument->setTitle($title); |
||
| 260 | $existingDocument->setComment($comment); |
||
| 261 | $em->persist($existingDocument); |
||
| 262 | $em->flush(); |
||
| 263 | |||
| 264 | // Return any data you need for further processing |
||
| 265 | return [ |
||
| 266 | 'title' => $title, |
||
| 267 | 'filetype' => 'file', |
||
| 268 | 'comment' => $comment, |
||
| 269 | ]; |
||
| 270 | } |
||
| 271 | |||
| 272 | if ('rename' == $fileExistsOption) { |
||
| 273 | // Perform actions when file exists and 'rename' option is selected |
||
| 274 | $newTitle = $this->generateUniqueTitle($title); // Generate a unique title |
||
| 275 | $resource->setResourceName($newTitle); |
||
| 276 | $resource->setUploadFile($uploadedFile); |
||
| 277 | if (!empty($resourceLinkList)) { |
||
| 278 | $resource->setResourceLinkArray($resourceLinkList); |
||
| 279 | } |
||
| 280 | $em->persist($resource); |
||
| 281 | $em->flush(); |
||
| 282 | |||
| 283 | // Return any data you need for further processing |
||
| 284 | return [ |
||
| 285 | 'title' => $title, |
||
| 286 | 'filetype' => 'file', |
||
| 287 | 'comment' => $comment, |
||
| 288 | ]; |
||
| 289 | } |
||
| 290 | |||
| 291 | if ('nothing' == $fileExistsOption) { |
||
| 292 | // Perform actions when file exists and 'nothing' option is selected |
||
| 293 | // Display a message indicating that the file already exists |
||
| 294 | // or perform any other desired actions based on your application's requirements |
||
| 295 | $resource->setResourceName($title); |
||
| 296 | $flashBag = $request->getSession()->getFlashBag(); |
||
| 297 | $flashBag->add('warning', 'Upload Already Exists'); |
||
| 298 | |||
| 299 | return [ |
||
| 300 | 'title' => $title, |
||
| 301 | 'filetype' => 'file', |
||
| 302 | 'comment' => $comment, |
||
| 303 | ]; |
||
| 304 | } |
||
| 305 | |||
| 306 | throw new InvalidArgumentException('Invalid fileExistsOption'); |
||
| 307 | } else { |
||
| 308 | $resource->setResourceName($title); |
||
| 309 | $resource->setUploadFile($uploadedFile); |
||
| 310 | $fileParsed = true; |
||
| 311 | } |
||
| 312 | } |
||
| 313 | } |
||
| 314 | |||
| 315 | // Get data in content and create a HTML file. |
||
| 316 | if (!$fileParsed && $content) { |
||
| 317 | $uploadedFile = CreateUploadedFile::fromString($title.'.html', 'text/html', $content); |
||
| 318 | $resource->setUploadFile($uploadedFile); |
||
| 319 | $fileParsed = true; |
||
| 320 | } |
||
| 321 | |||
| 322 | if (!$fileParsed) { |
||
| 323 | throw new InvalidArgumentException('filetype was set to "file" but no upload file found'); |
||
| 324 | } |
||
| 325 | |||
| 326 | break; |
||
| 327 | |||
| 328 | case 'folder': |
||
| 329 | break; |
||
| 330 | } |
||
| 331 | |||
| 332 | // Set resource link list if exists. |
||
| 333 | if (!empty($resourceLinkList)) { |
||
| 334 | $resource->setResourceLinkArray($resourceLinkList); |
||
| 335 | } |
||
| 336 | |||
| 337 | return [ |
||
| 338 | 'title' => $title, |
||
| 339 | 'filetype' => $fileType, |
||
| 340 | 'comment' => $comment, |
||
| 341 | ]; |
||
| 342 | } |
||
| 343 | |||
| 344 | protected function handleCreateFileRequestUncompress(AbstractResource $resource, Request $request, EntityManager $em, KernelInterface $kernel): array |
||
| 345 | { |
||
| 346 | // Get the parameters from the request |
||
| 347 | $parentResourceNodeId = (int) $request->get('parentResourceNodeId'); |
||
| 348 | $fileType = $request->get('filetype'); |
||
| 349 | $resourceLinkList = $request->get('resourceLinkList', []); |
||
| 350 | if (!empty($resourceLinkList)) { |
||
| 351 | $resourceLinkList = !str_contains($resourceLinkList, '[') ? json_decode('['.$resourceLinkList.']', true) : json_decode($resourceLinkList, true); |
||
| 352 | if (empty($resourceLinkList)) { |
||
| 353 | $message = 'resourceLinkList is not a valid json. Use for example: [{"cid":1, "visibility":1}]'; |
||
| 354 | |||
| 355 | throw new InvalidArgumentException($message); |
||
| 356 | } |
||
| 357 | } |
||
| 358 | |||
| 359 | if (empty($fileType)) { |
||
| 360 | throw new Exception('filetype needed: folder or file'); |
||
| 361 | } |
||
| 362 | |||
| 363 | if (0 === $parentResourceNodeId) { |
||
| 364 | throw new Exception('parentResourceNodeId int value needed'); |
||
| 365 | } |
||
| 366 | |||
| 367 | if ('file' == $fileType && $request->files->count() > 0) { |
||
| 368 | if (!$request->files->has('uploadFile')) { |
||
| 369 | throw new BadRequestHttpException('"uploadFile" is required'); |
||
| 370 | } |
||
| 371 | |||
| 372 | $uploadedFile = $request->files->get('uploadFile'); |
||
| 373 | $resourceTitle = $uploadedFile->getClientOriginalName(); |
||
| 374 | $resource->setResourceName($resourceTitle); |
||
| 375 | $resource->setUploadFile($uploadedFile); |
||
| 376 | |||
| 377 | if ('zip' === $uploadedFile->getClientOriginalExtension()) { |
||
| 378 | // Extract the files and subdirectories |
||
| 379 | $extractedData = $this->extractZipFile($uploadedFile, $kernel); |
||
| 380 | $folderStructure = $extractedData['folderStructure']; |
||
| 381 | $extractPath = $extractedData['extractPath']; |
||
| 382 | $documents = $this->saveZipContentsAsDocuments($folderStructure, $em, $resourceLinkList, $parentResourceNodeId, '', $extractPath, $processedItems); |
||
| 383 | } |
||
| 384 | } |
||
| 385 | |||
| 386 | $resource->setParentResourceNode($parentResourceNodeId); |
||
| 387 | |||
| 388 | return [ |
||
| 389 | 'filetype' => $fileType, |
||
| 390 | 'comment' => 'Uncompressed', |
||
| 391 | ]; |
||
| 392 | } |
||
| 393 | |||
| 394 | protected function handleUpdateRequest(AbstractResource $resource, ResourceRepository $repo, Request $request, EntityManager $em): AbstractResource |
||
| 395 | { |
||
| 396 | $contentData = $request->getContent(); |
||
| 397 | $resourceLinkList = []; |
||
| 398 | if (!empty($contentData)) { |
||
| 399 | $contentData = json_decode($contentData, true); |
||
| 400 | if (isset($contentData['parentResourceNodeId']) && count($contentData) === 1) { |
||
| 401 | $parentResourceNodeId = (int) $contentData['parentResourceNodeId']; |
||
| 402 | } |
||
| 403 | $title = $contentData['title'] ?? ''; |
||
| 404 | $content = $contentData['contentFile'] ?? ''; |
||
| 405 | $resourceLinkList = $contentData['resourceLinkListFromEntity'] ?? []; |
||
| 406 | } else { |
||
| 407 | $title = $request->get('title'); |
||
| 408 | $content = $request->request->get('contentFile'); |
||
| 409 | } |
||
| 410 | |||
| 411 | $repo->setResourceName($resource, $title); |
||
| 412 | |||
| 413 | $resourceNode = $resource->getResourceNode(); |
||
| 414 | $hasFile = $resourceNode->hasResourceFile(); |
||
| 415 | |||
| 416 | if ($hasFile && !empty($content)) { |
||
| 417 | // The content is updated by the ResourceNodeListener.php |
||
| 418 | $resourceNode->setContent($content); |
||
| 419 | foreach ($resourceNode->getResourceFiles() as $resourceFile) { |
||
| 420 | $resourceFile->setSize(\strlen($content)); |
||
| 421 | } |
||
| 422 | $resource->setResourceNode($resourceNode); |
||
| 423 | } |
||
| 424 | |||
| 425 | $link = null; |
||
| 426 | if (!empty($resourceLinkList)) { |
||
| 427 | foreach ($resourceLinkList as $key => &$linkArray) { |
||
| 428 | // Find the exact link. |
||
| 429 | $linkId = $linkArray['id'] ?? 0; |
||
| 430 | if (!empty($linkId)) { |
||
| 431 | /** @var ResourceLink $link */ |
||
| 432 | $link = $resourceNode->getResourceLinks()->filter(fn ($link) => $link->getId() === $linkId)->first(); |
||
| 433 | |||
| 434 | if (null !== $link) { |
||
| 435 | $link->setVisibility((int) $linkArray['visibility']); |
||
| 436 | unset($resourceLinkList[$key]); |
||
| 437 | |||
| 438 | $em->persist($link); |
||
| 439 | } |
||
| 440 | } |
||
| 441 | } |
||
| 442 | |||
| 443 | $resource->setResourceLinkArray($resourceLinkList); |
||
| 444 | self::setLinks($resource, $em); |
||
| 445 | } |
||
| 446 | |||
| 447 | $isRecursive = !$hasFile; |
||
| 448 | // If it's a folder then change the visibility to the children (That have the same link). |
||
| 449 | if ($isRecursive && null !== $link) { |
||
| 450 | $repo->copyVisibilityToChildren($resource->getResourceNode(), $link); |
||
| 451 | } |
||
| 452 | |||
| 453 | if (!empty($parentResourceNodeId)) { |
||
| 454 | $parentResourceNode = $em->getRepository(ResourceNode::class)->find($parentResourceNodeId); |
||
| 455 | if ($parentResourceNode) { |
||
| 456 | $resourceNode->setParent($parentResourceNode); |
||
| 457 | } |
||
| 458 | } |
||
| 459 | |||
| 460 | $resourceNode->setUpdatedAt(new DateTime()); |
||
| 461 | |||
| 462 | return $resource; |
||
| 463 | } |
||
| 464 | |||
| 465 | private function saveZipContentsAsDocuments(array $folderStructure, EntityManager $em, $resourceLinkList = [], $parentResourceId = null, $currentPath = '', $extractPath = '', &$processedItems = []): array |
||
| 466 | { |
||
| 467 | $documents = []; |
||
| 468 | |||
| 469 | foreach ($folderStructure as $key => $item) { |
||
| 470 | if (\is_array($item)) { |
||
| 471 | $folderName = $key; |
||
| 472 | $subFolderStructure = $item; |
||
| 473 | |||
| 474 | $document = new CDocument(); |
||
| 475 | $document->setTitle($folderName); |
||
| 476 | $document->setFiletype('folder'); |
||
| 477 | |||
| 478 | if (null !== $parentResourceId) { |
||
| 479 | $document->setParentResourceNode($parentResourceId); |
||
| 480 | } |
||
| 481 | |||
| 482 | if (!empty($resourceLinkList)) { |
||
| 483 | $document->setResourceLinkArray($resourceLinkList); |
||
| 484 | } |
||
| 485 | |||
| 486 | $em->persist($document); |
||
| 487 | $em->flush(); |
||
| 488 | |||
| 489 | $documentId = $document->getResourceNode()->getId(); |
||
| 490 | $documents[$documentId] = [ |
||
| 491 | 'name' => $document->getTitle(), |
||
| 492 | 'files' => [], |
||
| 493 | ]; |
||
| 494 | |||
| 495 | $subDocuments = $this->saveZipContentsAsDocuments($subFolderStructure, $em, $resourceLinkList, $documentId, $currentPath.$folderName.'/', $extractPath, $processedItems); |
||
| 496 | $documents[$documentId]['files'] = $subDocuments; |
||
| 497 | } else { |
||
| 498 | $fileName = $item; |
||
| 499 | |||
| 500 | $document = new CDocument(); |
||
| 501 | $document->setTitle($fileName); |
||
| 502 | $document->setFiletype('file'); |
||
| 503 | |||
| 504 | if (null !== $parentResourceId) { |
||
| 505 | $document->setParentResourceNode($parentResourceId); |
||
| 506 | } |
||
| 507 | |||
| 508 | if (!empty($resourceLinkList)) { |
||
| 509 | $document->setResourceLinkArray($resourceLinkList); |
||
| 510 | } |
||
| 511 | |||
| 512 | $filePath = $extractPath.'/'.$currentPath.$fileName; |
||
| 513 | |||
| 514 | if (file_exists($filePath)) { |
||
| 515 | $uploadedFile = new UploadedFile( |
||
| 516 | $filePath, |
||
| 517 | $fileName |
||
| 518 | ); |
||
| 519 | |||
| 520 | $document->setUploadFile($uploadedFile); |
||
| 521 | $em->persist($document); |
||
| 522 | $em->flush(); |
||
| 523 | |||
| 524 | $documentId = $document->getResourceNode()->getId(); |
||
| 525 | $documents[$documentId] = [ |
||
| 526 | 'name' => $document->getTitle(), |
||
| 527 | 'files' => [], |
||
| 528 | ]; |
||
| 529 | } else { |
||
| 530 | error_log('File does not exist: '.$filePath); |
||
| 531 | |||
| 532 | continue; |
||
| 533 | } |
||
| 534 | } |
||
| 535 | } |
||
| 536 | |||
| 537 | return $documents; |
||
| 538 | } |
||
| 539 | |||
| 540 | private function extractZipFile(UploadedFile $file, KernelInterface $kernel): array |
||
| 575 | ]; |
||
| 576 | } |
||
| 577 | |||
| 578 | private function buildFolderStructure(array $paths, string $extractPath): array |
||
| 598 | } |
||
| 599 | |||
| 600 | private function formatFolderStructure(array $folderStructure): array |
||
| 601 | { |
||
| 615 | } |
||
| 616 | |||
| 617 | private function generateUniqueTitle(string $title): string |
||
| 622 |
Loading history...
This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.
Consider making the comparison explicit by using
empty(..)or! empty(...)instead.