feat: Source specifying for relative links is allowed

openedx · Sep 13, 2024 · 34aed04 · 34aed04
1 parent e3aee8d
commit 34aed04
Show file tree

Hide file tree

Showing 7 changed files with 53 additions and 7 deletions.
diff --git a/README.rst b/README.rst
@@ -58,6 +58,11 @@ The link map file can be supplied using `-f` or `--link_file`::
 
     cc2olx -r zip -i <IMSCC_FILE> -f <CSV_FILE>
 
+If the original course content contains relative links and the resources
+(images, documents etc) the links point to are not included into the exported
+course dump, you can specify their source using `-s` flag:
+
+    cc2olx -i <IMSCC_FILE> -s <RELATIVE_LINKS_SOURCE>
 
 Test Data
 ---------

diff --git a/src/cc2olx/cli.py b/src/cc2olx/cli.py
@@ -69,4 +69,10 @@ def parse_args(args=None):
             "should contain consumer_id, consumer_key and consumer_secret."
         ),
     )
+    parser.add_argument(
+        "-s",
+        "--relative_links_source",
+        nargs="?",
+        help="The relative links source in the format '<scheme>://<netloc>', e.g. 'https://example.com'",
+    )
     return parser.parse_args(args)
diff --git a/src/cc2olx/constants.py b/src/cc2olx/constants.py
@@ -0,0 +1,2 @@
+OLX_STATIC_DIR = "static"
+OLX_STATIC_PATH_TEMPLATE = f"/{OLX_STATIC_DIR}/{{static_filename}}"
diff --git a/src/cc2olx/main.py b/src/cc2olx/main.py
@@ -8,18 +8,25 @@
 from cc2olx import filesystem
 from cc2olx import olx
 from cc2olx.cli import parse_args, RESULT_TYPE_FOLDER, RESULT_TYPE_ZIP
-from cc2olx.models import Cartridge, OLX_STATIC_DIR
+from cc2olx.constants import OLX_STATIC_DIR
+from cc2olx.models import Cartridge
 from cc2olx.settings import collect_settings
 
 
-def convert_one_file(input_file, workspace, link_file=None, passport_file=None):
+def convert_one_file(
+    input_file,
+    workspace,
+    link_file=None,
+    passport_file=None,
+    relative_links_source=None,
+):
     filesystem.create_directory(workspace)
 
     cartridge = Cartridge(input_file, workspace)
     cartridge.load_manifest_extracted()
     cartridge.normalize()
 
-    olx_export = olx.OlxExport(cartridge, link_file, passport_file)
+    olx_export = olx.OlxExport(cartridge, link_file, passport_file, relative_links_source)
     olx_filename = cartridge.directory.parent / (cartridge.directory.name + "-course.xml")
     policy_filename = cartridge.directory.parent / "policy.json"
 
@@ -53,6 +60,7 @@ def main():
     workspace = settings["workspace"]
     link_file = settings["link_file"]
     passport_file = settings["passport_file"]
+    relative_links_source = settings["relative_links_source"]
 
     # setup logger
     logging_config = settings["logging_config"]
@@ -64,7 +72,14 @@ def main():
 
         for input_file in settings["input_files"]:
             try:
-                convert_one_file(input_file, temp_workspace, link_file, passport_file)
+                convert_one_file(
+                    input_file,
+                    temp_workspace,
+                    link_file,
+                    passport_file,
+                    relative_links_source,
+                )
+
             except Exception:
                 logger.exception("Error while converting %s file", input_file)
 

diff --git a/src/cc2olx/models.py b/src/cc2olx/models.py
@@ -6,6 +6,7 @@
 import zipfile
 
 from cc2olx import filesystem
+from cc2olx.constants import OLX_STATIC_PATH_TEMPLATE
 from cc2olx.external.canvas import ModuleMeta
 from cc2olx.qti import QtiParser
 from cc2olx.utils import clean_file_name
@@ -343,7 +344,7 @@ def get_resource_content(self, identifier):
                 return "html", {"html": html}
             elif "web_resources" in str(res_filename) and imghdr.what(str(res_filename)):
                 static_filename = str(res_filename).split("web_resources/")[1]
-                olx_static_path = "/{}/{}".format(OLX_STATIC_DIR, static_filename)
+                olx_static_path = OLX_STATIC_PATH_TEMPLATE.format(static_filename=static_filename)
                 html = (
                     '<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>'
                     '</head><body><p><img src="{}" alt="{}"></p></body></html>'.format(olx_static_path, static_filename)
@@ -353,7 +354,7 @@ def get_resource_content(self, identifier):
                 # This webcontent is outside of ``web_resources`` directory
                 # So we need to manually copy it to OLX_STATIC_DIR
                 self.extra_static_files.append(res_relative_path)
-                olx_static_path = "/{}/{}".format(OLX_STATIC_DIR, res_relative_path)
+                olx_static_path = OLX_STATIC_PATH_TEMPLATE.format(static_filename=res_relative_path)
                 html = (
                     '<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>'
                     '</head><body><p><a href="{}" alt="{}">{}<a></p></body></html>'.format(

diff --git a/src/cc2olx/olx.py b/src/cc2olx/olx.py
@@ -7,6 +7,7 @@
 from lxml import html
 from cc2olx.iframe_link_parser import KalturaIframeLinkParser
 
+from cc2olx.constants import OLX_STATIC_PATH_TEMPLATE
 from cc2olx.qti import QtiExport
 from cc2olx.utils import element_builder, passport_file_parser
 
@@ -36,11 +37,12 @@ class OlxExport:
     QTI = "qti"
     DISCUSSION = "discussion"
 
-    def __init__(self, cartridge, link_file=None, passport_file=None):
+    def __init__(self, cartridge, link_file=None, passport_file=None, relative_links_source=None):
         self.cartridge = cartridge
         self.doc = None
         self.link_file = link_file
         self.passport_file = passport_file
+        self.relative_links_source = relative_links_source
         self.iframe_link_parser = None
         if link_file:
             self.iframe_link_parser = KalturaIframeLinkParser(self.link_file)
@@ -250,6 +252,18 @@ def process_external_tools_link(item, html):
             html = html.replace(item, external_tool_url)
             return html
 
+        def process_extra_static_files(item, html):
+            if self.relative_links_source is None:
+                return html
+
+            for static_file in self.cartridge.extra_static_files:
+                if item == OLX_STATIC_PATH_TEMPLATE.format(static_filename=static_file):
+                    return html
+
+            url = urllib.parse.urljoin(self.relative_links_source, item)
+            html = html.replace(item, url)
+            return html
+
         for _, item in items:
             if "IMS-CC-FILEBASE" in item:
                 html = process_ims_cc_filebase(item, html)
@@ -259,6 +273,8 @@ def process_external_tools_link(item, html):
                 html = process_external_tools_link(item, html)
             elif "CANVAS_OBJECT_REFERENCE" in item:
                 html = process_canvas_reference(item, html)
+            else:
+                html = process_extra_static_files(item, html)
 
         return html
 

diff --git a/src/cc2olx/settings.py b/src/cc2olx/settings.py
@@ -47,5 +47,6 @@ def collect_settings(parsed_args):
         "workspace": Path.cwd() / parsed_args.output,
         "link_file": parsed_args.link_file,
         "passport_file": parsed_args.passport_file,
+        "relative_links_source": parsed_args.relative_links_source,
     }
     return settings
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		OLX_STATIC_DIR = "static"
		OLX_STATIC_PATH_TEMPLATE = f"/{OLX_STATIC_DIR}/{{static_filename}}"