Glossary: Fix XLSX and CSV exported #6722

Author: AngelFQC

public/main/inc/lib/export.lib.inc.php

@@ -46,7 +46,9 @@ public static function arrayToCsv(
         }
 
         $enclosure = $enclosure !== '' ? $enclosure : '"';
-        $filePath  = api_get_path(SYS_ARCHIVE_PATH) . uniqid() . '.csv';
+        $filePath  = api_get_path(SYS_ARCHIVE_PATH);
+        $filePath .= $writeOnly ? $filename : uniqid('');
+        $filePath .= '.csv';
 
         // define a single-character escape
         $escapeChar = '\\';
@@ -74,7 +76,9 @@ public static function arrayToCsv(
      */
     public static function arrayToCsvSimple(array $data, string $filename = 'export', bool $writeOnly = false, array $header = [])
     {
-        $file = api_get_path(SYS_ARCHIVE_PATH) . uniqid('') . '.csv';
+        $file = api_get_path(SYS_ARCHIVE_PATH);
+        $file .= $writeOnly ? $filename : uniqid('');
+        $file .= '.csv';
 
         $handle = fopen($file, 'w');
 
@@ -104,7 +108,7 @@ public static function arrayToCsvSimple(array $data, string $filename = 'export'
     /**
      * Export tabular data to XLS-file.
      */
-    public static function arrayToXls(array $data, string $filename = 'export')
+    public static function arrayToXls(array $data, string $filename = 'export', bool $writeOnly = false)
     {
         if (empty($data)) {
             return false;
@@ -122,12 +126,19 @@ public static function arrayToXls(array $data, string $filename = 'export')
             $rowNumber++;
         }
 
-        $filePath = api_get_path(SYS_ARCHIVE_PATH).uniqid('').'.xlsx';
+        $filePath = api_get_path(SYS_ARCHIVE_PATH);
+        $filePath .= $writeOnly ? $filename : uniqid('');
+        $filePath .= '.xlsx';
+
         $writer = new Xlsx($spreadsheet);
         $writer->save($filePath);
 
-        DocumentManager::file_send_for_download($filePath, true, $filename.'.xlsx');
-        exit;
+        if (!$writeOnly) {
+            DocumentManager::file_send_for_download($filePath, true, $filename.'.xlsx');
+            exit;
+        }
+
+        return $filePath;
     }
 
     /**

src/CoreBundle/Controller/Api/ExportCGlossaryAction.php

@@ -6,6 +6,7 @@
 
 use Chamilo\CoreBundle\Entity\Course;
 use Chamilo\CoreBundle\Entity\Session;
+use Chamilo\CoreBundle\Settings\SettingsManager;
 use Chamilo\CourseBundle\Entity\CGlossary;
 use Chamilo\CourseBundle\Repository\CGlossaryRepository;
 use Doctrine\ORM\EntityManager;
@@ -14,22 +15,20 @@
 use Doctrine\ORM\OptimisticLockException;
 use Doctrine\ORM\TransactionRequiredException;
 use PDF;
-use PhpOffice\PhpSpreadsheet\IOFactory;
-use PhpOffice\PhpSpreadsheet\Spreadsheet;
 use PhpOffice\PhpSpreadsheet\Writer\Exception;
 use Symfony\Component\HttpFoundation\BinaryFileResponse;
 use Symfony\Component\HttpFoundation\File\File;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpFoundation\ResponseHeaderBag;
 use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
-use Symfony\Component\HttpKernel\KernelInterface;
 use Symfony\Contracts\Translation\TranslatorInterface;
 
 readonly class ExportCGlossaryAction
 {
     public function __construct(
         private TranslatorInterface $translator,
+        private SettingsManager $settingsManager,
     ) {}
 
     /**
@@ -39,7 +38,6 @@ public function __invoke(
         Request $request,
         CGlossaryRepository $repo,
         EntityManager $em,
-        KernelInterface $kernel,
         TranslatorInterface $translator
     ): Response {
         $format = $request->get('format');
@@ -50,7 +48,6 @@ public function __invoke(
             throw new BadRequestHttpException('Invalid export format');
         }
 
-        $exportPath = $kernel->getCacheDir();
         $course = null;
         $session = null;
         if (0 !== $cid) {
@@ -66,9 +63,7 @@ public function __invoke(
         $exportFilePath = $this->generateExportFile(
             $glossaryItems,
             $format,
-            $exportPath,
             $course,
-            $session
         );
 
         $response = new BinaryFileResponse(
@@ -88,59 +83,44 @@ public function __invoke(
     private function generateExportFile(
         array $glossaryItems,
         string $format,
-        string $exportPath,
         ?Course $course,
-        ?Session $session = null,
     ): string {
-        return match ($format) {
-            'csv' => $this->generateCsvFile($glossaryItems, $exportPath),
-            'xls' => $this->generateExcelFile($glossaryItems, $exportPath),
-            'pdf' => $this->generatePdfFile($glossaryItems, $course, $session),
-            default => throw new NotSupported('Export format not supported'),
-        };
-    }
+        if ('pdf' === $format) {
+            return $this->generatePdfFile($glossaryItems, $course);
+        }
 
-    private function generateCsvFile(array $glossaryItems, string $exportPath): string
-    {
-        $csvFilePath = $exportPath.'/glossary.csv';
-        $csvContent = '';
+        $list = [];
+        $list[] = ['term', 'definition'];
+
+        $allowStrip = 'true' === $this->settingsManager->getSetting('glossary.allow_remove_tags_in_glossary_export');
 
-        /** @var CGlossary $item */
         foreach ($glossaryItems as $item) {
-            $csvContent .= $item->getTitle().','.$item->getDescription()."\n";
+            $definition = $item->getDescription();
+
+            if ($allowStrip) {
+                $definition = htmlspecialchars_decode(strip_tags($definition), ENT_QUOTES);
+            }
+
+            $list[] = [$item->getTitle(), $definition];
         }
-        file_put_contents($csvFilePath, $csvContent);
 
-        return $csvFilePath;
+        return match ($format) {
+            'csv' => $this->generateCsvFile($list, $course),
+            'xls' => $this->generateExcelFile($list, $course),
+        };
     }
 
-    /**
-     * @throws Exception
-     */
-    private function generateExcelFile(array $glossaryItems, string $exportPath): string
+    private function generateCsvFile(array $glossaryItems, Course $course): string
     {
-        $excelFilePath = $exportPath.'/glossary.xlsx';
-        $spreadsheet = new Spreadsheet();
-        $sheet = $spreadsheet->getActiveSheet();
-
-        /** @var CGlossary $item */
-        foreach ($glossaryItems as $index => $item) {
-            $row = $index + 1;
-            $sheet->setCellValue('A'.$row, $item->getTitle());
-            $sheet->setCellValue('B'.$row, $item->getDescription());
-        }
-
-        $writer = IOFactory::createWriter($spreadsheet, 'Xlsx');
-        $writer->save($excelFilePath);
+        return \Export::arrayToCsv($glossaryItems, 'glossary_course_'.$course->getCode(), true);
+    }
 
-        return $excelFilePath;
+    private function generateExcelFile(array $glossaryItems, Course $course): string
+    {
+        return \Export::arrayToXls($glossaryItems, 'glossary_course_'.$course->getCode(), true);
     }
 
-    private function generatePdfFile(
-        array $glossaryItems,
-        ?Course $course,
-        ?Session $session = null,
-    ): string
+    private function generatePdfFile(array $glossaryItems, Course $course): string
     {
         $html = '<h1>'.$this->translator->trans('Glossary').'</h1>';
         $html .= '<table>';