Document: Add LP usage warning when deleting documents - refs #4454

Author: @christianbeeznest

Author: christianbeeznest

assets/vue/views/documents/DocumentsList.vue

@@ -451,6 +451,34 @@
       />
     </form>
   </BaseDialogConfirmCancel>
+  <BaseDialogConfirmCancel
+    v-model:is-visible="isDeleteWarningLpDialogVisible"
+    :title="t('Confirm deletion')"
+    @confirm-clicked="forceDeleteItem"
+    @cancel-clicked="isDeleteWarningLpDialogVisible = false"
+  >
+    <div class="confirmation-content">
+      <BaseIcon
+        class="mr-2"
+        icon="alert"
+        size="big"
+      />
+      <p class="mb-2">
+        {{ t("The following documents are used in learning paths:") }}
+      </p>
+      <ul class="pl-4 mb-4">
+        <li
+          v-for="lp in lpListWarning"
+          :key="lp.lpId + lp.documentTitle"
+        >
+          <b>{{ lp.documentTitle }}</b> → {{ lp.lpTitle }}
+        </li>
+      </ul>
+      <p class="mt-4 font-semibold">
+        {{ t("Do you still want to delete them?") }}
+      </p>
+    </div>
+  </BaseDialogConfirmCancel>
 </template>
 
 <script setup>
@@ -504,6 +532,8 @@ const isAllowedToEdit = ref(false)
 const folders = ref([])
 const selectedFolder = ref(null)
 const isDownloading = ref(false)
+const isDeleteWarningLpDialogVisible = ref(false)
+const lpListWarning = ref([])
 
 const {
   showNewDocumentButton,
@@ -678,9 +708,41 @@ function showDeleteMultipleDialog() {
   isDeleteMultipleDialogVisible.value = true
 }
 
-function confirmDeleteItem(itemToDelete) {
-  item.value = itemToDelete
-  isDeleteItemDialogVisible.value = true
+async function confirmDeleteItem(itemToDelete) {
+  try {
+    const response = await axios.get(`/api/documents/${itemToDelete.iid}/lp-usage`)
+    if (response.data.usedInLp) {
+      lpListWarning.value = response.data.lpList.map((lp) => ({
+        ...lp,
+        documentTitle: itemToDelete.title,
+        documentId: itemToDelete.iid,
+      }))
+      item.value = itemToDelete
+      isDeleteWarningLpDialogVisible.value = true
+    } else {
+      item.value = itemToDelete
+      isDeleteItemDialogVisible.value = true
+    }
+  } catch (error) {
+    console.error("Error checking LP usage for individual item:", error)
+  }
+}
+
+async function forceDeleteItem() {
+  try {
+    const docIdsToDelete = [...new Set(lpListWarning.value.map((lp) => lp.documentId))]
+
+    await Promise.all(docIdsToDelete.map((iid) => axios.delete(`/api/documents/${iid}`)))
+
+    notification.showSuccessNotification(t("Documents deleted"))
+    isDeleteWarningLpDialogVisible.value = false
+    item.value = {}
+    unselectAll()
+    onUpdateOptions(options.value)
+  } catch (error) {
+    console.error("Error deleting documents forcibly:", error)
+    notification.showErrorNotification(t("Error deleting document(s)."))
+  }
 }
 
 function getReplaceButtonTitle(item) {
@@ -726,10 +788,56 @@ async function downloadSelectedItems() {
 }
 
 async function deleteMultipleItems() {
-  await store.dispatch("documents/delMultiple", selectedItems.value)
+  const itemsWithoutLp = []
+  const documentsWithLpMap = {}
+
+  for (const item of selectedItems.value) {
+    try {
+      const response = await axios.get(`/api/documents/${item.iid}/lp-usage`)
+      if (response.data.usedInLp) {
+        if (!documentsWithLpMap[item.iid]) {
+          documentsWithLpMap[item.iid] = {
+            iid: item.iid,
+            title: item.title,
+            lpList: [],
+          }
+        }
+        documentsWithLpMap[item.iid].lpList.push(...response.data.lpList)
+      } else {
+        itemsWithoutLp.push(item)
+      }
+    } catch (error) {
+      console.error(`Error checking LP usage for document ${item.iid}:`, error)
+    }
+  }
+
+  const documentsWithLp = Object.values(documentsWithLpMap)
+
+  if (itemsWithoutLp.length > 0) {
+    try {
+      await store.dispatch("documents/delMultiple", itemsWithoutLp)
+    } catch (e) {
+      console.error("Error deleting documents without LP:", e)
+    }
+  }
+
+  if (documentsWithLp.length > 0) {
+    lpListWarning.value = documentsWithLp.flatMap((doc) =>
+      doc.lpList.map((lp) => ({
+        ...lp,
+        documentTitle: doc.title,
+        documentId: doc.iid,
+      })),
+    )
+
+    item.value = {}
+    isDeleteWarningLpDialogVisible.value = true
+  } else {
+    notification.showSuccessNotification(t("Documents deleted"))
+    unselectAll()
+  }
+
   isDeleteMultipleDialogVisible.value = false
-  notification.showSuccessNotification(t("Deleted"))
-  unselectAll()
   onUpdateOptions(options.value)
 }
 
@@ -901,7 +1009,7 @@ async function replaceDocument() {
   }
 
   if (!(documentToReplace.value.filetype === "file" || documentToReplace.value.filetype === "video")) {
-    notification.showErrorNotification(t("Only files or videos can be replaced."))
+    notification.showErrorNotification(t("Only files can be replaced."))
     return
   }
 

public/main/inc/lib/document.lib.php

@@ -2298,6 +2298,7 @@ class="moved ui-sortable-handle link_with_id"
                 'WITH',
                 'doc.resourceNode = node'
             )
+            ->addSelect('files')
             ->where('type = :type')
             ->andWhere('links.course = :course')
             ->setParameters([
@@ -2306,7 +2307,6 @@ class="moved ui-sortable-handle link_with_id"
             ])
             ->orderBy('node.parent', 'ASC');
 
-
         $sessionId = api_get_session_id();
         if (empty($sessionId)) {
             $qb->andWhere('links.session IS NULL');

src/CoreBundle/Controller/Api/DocumentLearningPathUsageAction.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+/* For licensing terms, see /license.txt */
+
+namespace Chamilo\CoreBundle\Controller\Api;
+
+use Chamilo\CourseBundle\Repository\CLpItemRepository;
+use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
+use Symfony\Component\HttpFoundation\JsonResponse;
+use Symfony\Component\HttpKernel\Attribute\AsController;
+
+#[AsController]
+class DocumentLearningPathUsageAction extends AbstractController
+{
+    public function __construct(
+        private CLpItemRepository $lpItemRepo
+    ) {}
+
+    public function __invoke($iid): JsonResponse
+    {
+        $lpUsages = $this->lpItemRepo->findLearningPathsUsingDocument((int) $iid);
+
+        return new JsonResponse([
+            'usedInLp' => !empty($lpUsages),
+            'lpList' => $lpUsages,
+        ]);
+    }
+}

src/CoreBundle/Entity/Listener/ResourceListener.php

@@ -23,7 +23,9 @@
 use Chamilo\CoreBundle\Tool\ToolChain;
 use Chamilo\CoreBundle\Traits\AccessUrlListenerTrait;
 use Chamilo\CourseBundle\Entity\CCalendarEvent;
+use Chamilo\CourseBundle\Entity\CDocument;
 use Cocur\Slugify\SlugifyInterface;
+use Doctrine\Persistence\Event\LifecycleEventArgs;
 use Doctrine\ORM\Event\PostPersistEventArgs;
 use Doctrine\ORM\Event\PostRemoveEventArgs;
 use Doctrine\ORM\Event\PostUpdateEventArgs;
@@ -389,4 +391,24 @@ private function addCCalendarEventGlobalLink(CCalendarEvent $event, PrePersistEv
             }
         }
     }
+
+    public function preRemove(AbstractResource $resource, LifecycleEventArgs $args): void
+    {
+        if (!$resource instanceof CDocument) {
+            return;
+        }
+
+        $em = $args->getObjectManager();
+        $resourceNode = $resource->getResourceNode();
+
+        if (!$resourceNode) {
+            return;
+        }
+
+        $docID = $resource->getIid();
+        $em->createQuery('DELETE FROM Chamilo\CourseBundle\Entity\CLpItem i WHERE i.path = :path AND i.itemType = :type')
+            ->setParameter('path', $docID)
+            ->setParameter('type', 'document')
+            ->execute();
+    }
 }

src/CoreBundle/Repository/ResourceNodeRepository.php

@@ -37,7 +37,7 @@ public function __construct(
         private readonly AccessUrlHelper $accessUrlHelper,
         private readonly SettingsManager $settingsManager
     ) {
-        $this->filesystem = $resourceFilesystem; // Asignar el filesystem correcto
+        $this->filesystem = $resourceFilesystem;
         parent::__construct($manager, $manager->getClassMetadata(ResourceNode::class));
     }
 

src/CoreBundle/Traits/Repository/ORM/NestedTreeRepositoryTrait.php

@@ -2,6 +2,7 @@
 
 namespace Chamilo\CoreBundle\Traits\Repository\ORM;
 
+use Gedmo\Exception\RuntimeException;
 use Gedmo\Tool\Wrapper\EntityWrapper;
 use Doctrine\ORM\Query;
 use Gedmo\Tree\Strategy;
@@ -668,12 +669,8 @@ public function moveUp($node, $number = 1)
      * UNSAFE: be sure to backup before running this method when necessary
      *
      * Removes given $node from the tree and reparents its descendants
-     *
-     * @param object $node
-     *
-     * @throws \RuntimeException - if something fails in transaction
      */
-    public function removeFromTree($node)
+    public function removeFromTree(object $node): void
     {
         $meta = $this->getClassMetadata();
         $em = $this->getEntityManager();
@@ -685,6 +682,11 @@ public function removeFromTree($node)
             $left = $wrapped->getPropertyValue($config['left']);
             $rootId = isset($config['root']) ? $wrapped->getPropertyValue($config['root']) : null;
 
+            if (!is_numeric($left) || !is_numeric($right)) {
+                $this->removeSingle($wrapped);
+                return;
+            }
+
             if ($right == $left + 1) {
                 $this->removeSingle($wrapped);
                 $this->listener
@@ -775,7 +777,7 @@ public function removeFromTree($node)
             } catch (\Exception $e) {
                 $em->close();
                 $em->getConnection()->rollback();
-                throw new \Gedmo\Exception\RuntimeException('Transaction failed', null, $e);
+                throw new RuntimeException('Transaction failed', null, $e);
             }
         } else {
             throw new InvalidArgumentException("Node is not related to this repository");

src/CourseBundle/Entity/CDocument.php

@@ -18,6 +18,7 @@
 use ApiPlatform\Metadata\Put;
 use ApiPlatform\Serializer\Filter\PropertyFilter;
 use Chamilo\CoreBundle\Controller\Api\CreateDocumentFileAction;
+use Chamilo\CoreBundle\Controller\Api\DocumentLearningPathUsageAction;
 use Chamilo\CoreBundle\Controller\Api\DownloadSelectedDocumentsAction;
 use Chamilo\CoreBundle\Controller\Api\ReplaceDocumentFileAction;
 use Chamilo\CoreBundle\Controller\Api\UpdateDocumentFileAction;
@@ -88,6 +89,13 @@
             deserialize: false
         ),
         new Get(security: "is_granted('VIEW', object.resourceNode)"),
+        new Get(
+            uriTemplate: '/documents/{iid}/lp-usage',
+            controller: DocumentLearningPathUsageAction::class,
+            security: "is_granted('ROLE_USER')",
+            read: false,
+            name: 'api_documents_lp_usage'
+        ),
         new Delete(security: "is_granted('DELETE', object.resourceNode)"),
         new Post(
             controller: CreateDocumentFileAction::class,

src/CourseBundle/Entity/CLpItem.php

@@ -18,7 +18,7 @@
  * Items from a learning path (LP).
  */
 #[ORM\Table(name: 'c_lp_item')]
-#[ORM\Index(name: 'lp_id', columns: ['lp_id'])]
+#[ORM\Index(columns: ['lp_id'], name: 'lp_id')]
 #[Gedmo\Tree(type: 'nested')]
 #[ORM\Entity(repositoryClass: CLpItemRepository::class)]
 class CLpItem implements Stringable

src/CourseBundle/Repository/CLpItemRepository.php

@@ -51,4 +51,17 @@ public function findItemsByLearningPathAndType(int $learningPathId, string $item
 
         return $query->getResult();
     }
+
+    public function findLearningPathsUsingDocument(int $resourceFileId): array
+    {
+        return $this->createQueryBuilder('i')
+            ->select('lp.iid AS lpId, lp.title AS lpTitle')
+            ->join('i.lp', 'lp')
+            ->where('i.itemType = :type')
+            ->andWhere('i.path = :path')
+            ->setParameter('type', 'document')
+            ->setParameter('path', $resourceFileId)
+            ->getQuery()
+            ->getArrayResult();
+    }
 }