Merge pull request #7494 from christianbeeznest/fixes-updates251

Internal: Hide system folders in Documents tool using platform settings

Author: christianbeeznest

src/CoreBundle/Migrations/Schema/V200/Version20201212203625.php

@@ -27,6 +27,7 @@ public function getDescription(): string
 
     public function up(Schema $schema): void
     {
+        $this->ensureCDocumentFiletypeVarchar15();
         $documentRepo = $this->container->get(CDocumentRepository::class);
         $courseRepo = $this->container->get(CourseRepository::class);
         $attemptRepo = $this->entityManager->getRepository(TrackEAttempt::class);
@@ -195,16 +196,24 @@ public function up(Schema $schema): void
             $counter = 1;
             $courseId = (int) $course->getId();
 
-            $sql = "SELECT iid, path FROM c_document
+            // We fetch session_id and filetype for debugging/consistency checks during migration.
+            // The legacy "path" is the only reliable identifier for system folders (language-independent).
+            $sql = "SELECT iid, path, session_id, filetype FROM c_document
                     WHERE c_id = {$courseId}
                       AND path NOT LIKE '/../exercises/%'
                       AND path NOT LIKE '/chat_files/%'
                     ORDER BY filetype DESC, path";
             $documents = $this->connection->executeQuery($sql)->fetchAllAssociative();
 
             foreach ($documents as $documentData) {
-                $documentId = (int) $documentData['iid'];
-                $documentPath = (string) $documentData['path'];
+                $documentId = (int) ($documentData['iid'] ?? 0);
+                $documentPath = (string) ($documentData['path'] ?? '');
+                $legacySessionId = (int) ($documentData['session_id'] ?? 0);
+                $legacyFiletype = (string) ($documentData['filetype'] ?? '');
+
+                if ($documentId <= 0 || '' === $documentPath) {
+                    continue;
+                }
 
                 $courseEntity = $courseRepo->find($courseId);
                 if (!$courseEntity) {
@@ -221,6 +230,28 @@ public function up(Schema $schema): void
                     continue;
                 }
 
+                // Detect and mark legacy system folders before linking/persisting.
+                // This avoids relying on translated titles and keeps identification stable over time.
+                $normalizedLegacyPath = $this->normalizeLegacyDocumentPath($documentPath);
+                $systemFolderType = $this->detectSystemFolderType($normalizedLegacyPath);
+
+                // Only overwrite filetype for folders to keep behavior safe and predictable.
+                if (null !== $systemFolderType) {
+                    $effectiveFiletype = $document->getFiletype() ?? $legacyFiletype;
+
+                    if ('folder' === $effectiveFiletype) {
+                        $document->setFiletype($systemFolderType);
+
+                        error_log(sprintf(
+                            '[MIGRATION][documents] Marked system folder (iid=%d, legacyPath=%s, legacySid=%d, type=%s).',
+                            $documentId,
+                            $normalizedLegacyPath,
+                            $legacySessionId,
+                            $systemFolderType
+                        ));
+                    }
+                }
+
                 $parent = null;
                 if ('.' !== \dirname($documentPath)) {
                     $currentPath = \dirname($documentPath);
@@ -362,4 +393,75 @@ private function insertAttemptFileRow(int $attemptId, Asset $asset): void
 
         error_log(sprintf('[MIGRATION][attempt_file] Linked asset to attempt (attemptId=%d).', $attemptId));
     }
+
+    /**
+     * Ensure c_document.filetype is large enough BEFORE we update it during data migration.
+     * Execute the ALTER immediately to avoid truncation during flush().
+     */
+    private function ensureCDocumentFiletypeVarchar15(): void
+    {
+        try {
+            // We run this upfront because this migration updates c_document.filetype during flush().
+            $this->connection->executeStatement('ALTER TABLE c_document MODIFY filetype VARCHAR(15);');
+            error_log('[MIGRATION][documents] Ensured c_document.filetype is VARCHAR(15) before data migration.');
+        } catch (Throwable $e) {
+            error_log('[MIGRATION][documents] Failed to resize c_document.filetype: '.$e->getMessage());
+        }
+    }
+
+    /**
+     * Normalize legacy paths so system folders can be detected reliably.
+     * Keep it strict and language-independent (do not use titles).
+     */
+    private function normalizeLegacyDocumentPath(string $path): string
+    {
+        $p = str_replace('//', '/', trim($path));
+        if ('' === $p) {
+            return '';
+        }
+
+        // Ensure leading slash for consistent prefix checks.
+        if ('/' !== $p[0]) {
+            $p = '/'.$p;
+        }
+
+        return $p;
+    }
+
+    /**
+     * Detect legacy system folder type from the original C1 document path.
+     */
+    private function detectSystemFolderType(string $legacyPath): ?string
+    {
+        if ('' === $legacyPath) {
+            return null;
+        }
+
+        // Session-scoped shared folders: keep a distinct type to hide them in base course views.
+        if (preg_match('#^/shared_folder_session_\d+(/|$)#', $legacyPath)) {
+            return 'user_folder_ses'; // <= 15 chars
+        }
+
+        // Base course shared folder.
+        if (0 === strpos($legacyPath, '/shared_folder')) {
+            return 'user_folder';
+        }
+
+        if (preg_match('#^/(images|audio|flash|video)(/|$)#', $legacyPath)) {
+            return 'media_folder';
+        }
+
+        if (0 === strpos($legacyPath, '/certificates')) {
+            return 'cert_folder'; // <= 15 chars
+        }
+
+        if (
+            0 === strpos($legacyPath, '/chat_history')
+            || 0 === strpos($legacyPath, '/chat_files')
+        ) {
+            return 'chat_folder';
+        }
+
+        return null;
+    }
 }

src/CoreBundle/State/DocumentCollectionStateProvider.php

@@ -14,6 +14,7 @@
 use Chamilo\CoreBundle\Entity\ResourceShowCourseResourcesInSessionInterface;
 use Chamilo\CoreBundle\Entity\Session;
 use Chamilo\CoreBundle\Repository\ResourceLinkRepository;
+use Chamilo\CoreBundle\Settings\SettingsManager;
 use Chamilo\CourseBundle\Entity\CDocument;
 use Chamilo\CourseBundle\Entity\CGroup;
 use Doctrine\ORM\EntityManagerInterface;
@@ -27,6 +28,7 @@ final class DocumentCollectionStateProvider implements ProviderInterface
     public function __construct(
         private readonly EntityManagerInterface $entityManager,
         private readonly RequestStack $requestStack,
+        private readonly SettingsManager $settingsManager,
     ) {}
 
     /**
@@ -68,6 +70,10 @@ public function provide(Operation $operation, array $uriVariables = [], array $c
 
         // Gradebook mode (e.g. gradebook=1)
         $isGradebook = !empty($query['gradebook']) && 1 === (int) $query['gradebook'];
+        $showUsersFolders = 'true' === (string) ($this->settingsManager->getSetting('document.show_users_folders', true) ?? '');
+        $showDefaultFolders = 'false' !== (string) ($this->settingsManager->getSetting('document.show_default_folders', true) ?? '');
+        $showChatFolder = 'true' === (string) ($this->settingsManager->getSetting('chat.show_chat_folder', true) ?? '');
+
         $rawFiletype = $query['filetype'] ?? null;
         $filetypes = [];
 
@@ -78,21 +84,32 @@ public function provide(Operation $operation, array $uriVariables = [], array $c
         }
 
         // Normalize & unique
-        $filetypes = array_values(array_unique(array_filter(array_map('strval', $filetypes))));
+        $requestedFiletypes = array_values(array_unique(array_filter(array_map('strval', $filetypes))));
 
         // Compatibility: treat "html" as a subtype of "file"
-        if (\in_array('file', $filetypes, true) && !\in_array('html', $filetypes, true)) {
-            $filetypes[] = 'html';
+        $effectiveFiletypes = $requestedFiletypes;
+        if (\in_array('file', $effectiveFiletypes, true) && !\in_array('html', $effectiveFiletypes, true)) {
+            $effectiveFiletypes[] = 'html';
+        }
+
+        // System folder subtypes
+        $systemFolderTypes = ['user_folder', 'user_folder_ses', 'media_folder', 'chat_folder', 'cert_folder'];
+
+        // If the client asks for "folder", include system folder subtypes as well.
+        // This keeps folder browsing working after migration (system folders have custom filetypes).
+        if (\in_array('folder', $effectiveFiletypes, true)) {
+            $effectiveFiletypes = array_values(array_unique(array_merge($effectiveFiletypes, $systemFolderTypes)));
         }
 
-        if (!empty($filetypes)) {
+        if (!empty($effectiveFiletypes)) {
             $qb
                 ->andWhere($qb->expr()->in('d.filetype', ':filetypes'))
-                ->setParameter('filetypes', $filetypes)
+                ->setParameter('filetypes', $effectiveFiletypes)
             ;
         }
 
-        $wantsCertificateList = \in_array('certificate', $filetypes, true);
+        // NOTE: this is for "certificate" filetype lists, not the certificates folder filetype.
+        $wantsCertificateList = \in_array('certificate', $effectiveFiletypes, true);
         $showSystemCertificates = !empty($query['showSystemCertificates']) && 1 === (int) $query['showSystemCertificates'];
 
         if (!$showSystemCertificates && !($isGradebook && $wantsCertificateList)) {
@@ -105,6 +122,45 @@ public function provide(Operation $operation, array $uriVariables = [], array $c
             }
         }
 
+        // Hide system folders depending on settings.
+        $explicitSystemTypes = array_values(array_intersect($requestedFiletypes, $systemFolderTypes));
+        $hiddenSystemTypes = [];
+
+        // User folders
+        if (!$showUsersFolders) {
+            $hiddenSystemTypes[] = 'user_folder';
+            $hiddenSystemTypes[] = 'user_folder_ses';
+        } else {
+            // When enabled, never show session-scoped shared folders in base course context.
+            if ($sid <= 0) {
+                $hiddenSystemTypes[] = 'user_folder_ses';
+            }
+        }
+
+        // Default media folders
+        if (!$showDefaultFolders) {
+            $hiddenSystemTypes[] = 'media_folder';
+        }
+
+        // Chat history folder (controlled by chat.show_chat_folder)
+        if (!$showChatFolder) {
+            $hiddenSystemTypes[] = 'chat_folder';
+        }
+
+        // Certificates folder: hide unless explicitly requested.
+        if (!$showSystemCertificates && !($isGradebook && $wantsCertificateList)) {
+            $hiddenSystemTypes[] = 'cert_folder';
+        }
+
+        $hiddenSystemTypes = array_values(array_unique(array_diff($hiddenSystemTypes, $explicitSystemTypes)));
+
+        if (!empty($hiddenSystemTypes)) {
+            $qb
+                ->andWhere($qb->expr()->notIn('d.filetype', ':hiddenFiletypes'))
+                ->setParameter('hiddenFiletypes', $hiddenSystemTypes)
+            ;
+        }
+
         $loadNode = !empty($query['loadNode']) && 1 === (int) $query['loadNode'];
 
         $parentNodeId = 0;