From ef1e71f1db7e5479b84ace66505fdbf00d4f742d Mon Sep 17 00:00:00 2001
From: Yannick Warnier <ywarnier@beeznest.org>
Date: Wed, 26 Jun 2024 16:35:05 +0200
Subject: [PATCH] Maintenance: CommonCartridge: Add configuration setting
 'commoncartridge_path_token' to allow for the previously recommended special
 path token when exporting to Common Cartridge packages - refs BT#21709

---
 main/common_cartridge/export/src/utils/CcHelpers.php | 4 ++++
 main/install/configuration.dist.php                  | 6 ++++++
 2 files changed, 10 insertions(+)

diff --git a/main/common_cartridge/export/src/utils/CcHelpers.php b/main/common_cartridge/export/src/utils/CcHelpers.php
index 343aeade53..0327d9b429 100644
--- a/main/common_cartridge/export/src/utils/CcHelpers.php
+++ b/main/common_cartridge/export/src/utils/CcHelpers.php
@@ -288,6 +288,10 @@ abstract class CcHelpers
         $courseDir = $internalCourseDocumentsPath = null;
         $courseInfo = api_get_course_info();
         $replaceprefix = '$1EdTech-CC-FILEBASE$';
+        $tokenSyntax = api_get_configuration_value('commoncartridge_path_token');
+        if (!empty($tokenSyntax)) {
+            $replaceprefix = $tokenSyntax;
+        }
         if (!empty($courseInfo)) {
             $courseDir = $courseInfo['directory'];
             $internalCourseDocumentsPath = '/courses/'.$courseDir.'/document';
diff --git a/main/install/configuration.dist.php b/main/install/configuration.dist.php
index 76425c5fe1..7dd68adb20 100644
--- a/main/install/configuration.dist.php
+++ b/main/install/configuration.dist.php
@@ -2561,3 +2561,9 @@ INSERT INTO extra_field_options (field_id, option_value, display_text, priority,
 
 // Define the default time in seconds to be registered if the user does logout from a course and there is no recent entry in track_e_course_access.
 //$_configuration['tracking_default_course_extra_time_on_logout'] = 600;
+
+// Define a special path token for the Common Cartridge export content.
+// Due to changes in naming by the responsible organization, the Chamilo default
+// is '$1EdTech-CC-FILEBASE$' (the latest), but previous versions of the standard
+// recommended '$IMS-CC-FILEBASE$', so you might want to use that for greater compatibility.
+//$_configuration['commoncartridge_path_token'] = '$IMS-CC-FILEBASE$';