WeBWorK: xsl and pretext for 2.19

Author: Alex-Jordan

pretext/lib/pretext.py

@@ -1123,6 +1123,7 @@ def webwork_to_xml(
         ww_reps_dir = os.path.join(generated_dir, "webwork")
         # where generated images from webwork exercises will live
         ww_images_dir = os.path.join(ww_reps_dir, "images")
+
     else:
         msg = "".join(
             [
@@ -1165,7 +1166,10 @@ def webwork_to_xml(
     extracted_pg_xml = ET.parse(extracted_pg_filename).getroot()
     localization = extracted_pg_xml.get("localization")
     webwork2_server = extracted_pg_xml.find("server-params-pub").get("webwork2-server")
+    renderer_server = extracted_pg_xml.find("server-params-pub").get("renderer")
     numbered_title_filesafe = extracted_pg_xml.get("numbered-title-filesafe")
+    generated_dir_source = extracted_pg_xml.find("directories").get("generated-directory-source")
+    external_dir_source = extracted_pg_xml.find("directories").get("external-directory-source")
     ww_project_dir = os.path.join(ww_reps_dir, "pg", numbered_title_filesafe)
     if not (os.path.isdir(ww_project_dir)):
         os.mkdir(ww_project_dir)
@@ -1185,6 +1189,7 @@ def webwork_to_xml(
             "user": extracted_pg_xml.find("server-params-pub").get("user-id"),
             "passwd": extracted_pg_xml.find("server-params-pub").get("password"),
             "disableCookies": '1',
+            "renderer": renderer_server
         }
         static_processing = extracted_pg_xml.find("processing").attrib["static"]
         pg_location = extracted_pg_xml.find("processing").attrib["pg-location"]
@@ -1196,8 +1201,10 @@ def webwork_to_xml(
             "user": "anonymous",
             "passwd": "anonymous",
             "disableCookies": '1',
+            "renderer": "https://webwork-dev.aimath.org"
         }
         static_processing = 'webwork2'
+        interactive_processing = 'webwork2'
         pg_location = '/opt/webwork/pg'
 
     # ideally, pub_file is in use, in which case server_params_pub is nonempty.
@@ -1235,6 +1242,8 @@ def webwork_to_xml(
         courseID        = server_params_pub["courseID"]
         user            = server_params_pub["user"]
         passwd          = server_params_pub["passwd"]
+        if static_processing == "renderer":
+            renderer       = sanitize_url(server_params_pub["renderer"])
 
     webwork2_domain_webwork2 = webwork2_domain + "/webwork2/"
     webwork2_render_rpc = webwork2_domain_webwork2 + "render_rpc"
@@ -1250,6 +1259,12 @@ def webwork_to_xml(
         or (extracted_pg_xml.xpath("//problem[@origin='webwork2']"))
     )
 
+    # Establish if there is any need to use renderer
+    need_for_renderer = (
+        (static_processing == 'renderer')
+        and (extracted_pg_xml.xpath("//problem[@origin!='webwork2']"))
+    )
+
     # Establish if there is any need to use a socket
     need_for_socket = (
         (static_processing == 'local')
@@ -1264,6 +1279,8 @@ def webwork_to_xml(
         raise ImportError(__module_warning.format("requests"))
 
     # Establish WW server version, for live rendering if nothing else
+    # Note: if the renderer is doing live rendering there may be no need for a WW server and
+    # this entire block can be conditioned on need_for_webwork2
     # First try to identify the WW version according to what a response hash says it is.
     # This should work for 2.17 and beyond.
     try:
@@ -1317,6 +1334,14 @@ def webwork_to_xml(
             + "                         Is there a WeBWorK landing page at {}?\n"
             + "                         And does it display the WeBWorK version?\n"
         )
+        raise ValueError(msg.format(webwork2_domain_webwork2))
+
+    if webwork2_major_version != 2 or webwork2_minor_version < 16:
+        msg = (
+            "PTX:ERROR:   PreTeXt supports WeBWorK 2.16 and later, and it appears you are attempting to use version: {}\n"
+            + "                         Server: {}\n"
+            + "                         You may want to use the AIM WeBWorK server at webwork-ptx.aimath.org.\n"
+        )
         raise ValueError(msg.format(webwork2_version, webwork2_domain))
 
     webwork2_path = webwork2_render_rpc if (webwork2_major_version == 2 and webwork2_minor_version >= 19) else webwork2_html2xml
@@ -1340,19 +1365,14 @@ def webwork_to_xml(
             pghuman[problem.get("id")] = problem.find("pghuman").text
             pgdense[problem.get("id")] = problem.find("pgdense").text
 
-    if webwork2_major_version != 2 or webwork2_minor_version < 16:
-        msg = (
-            "PTX:ERROR:   PreTeXt supports WeBWorK 2.16 and later, and it appears you are attempting to use version: {}\n"
-            + "                         Server: {}\n"
-            + "                         You may want to use the AIM WeBWorK server at webwork-ptx.aimath.org.\n"
-        )
-        raise ValueError(msg.format(ww_version, ww_domain))
-
     # using a "Session()" will pool connection information
     # since we always hit the same server, this should increase performance
     if need_for_webwork2:
         webwork2_session = requests.Session()
 
+    if need_for_renderer:
+        renderer_session = requests.Session()
+
     clientsocket = None
 
     if need_for_socket:
@@ -1397,13 +1417,15 @@ def webwork_to_xml(
     webwork_representations = ET.Element("webwork-representations", nsmap=NSMAP)
     # Choose one of the dictionaries to take its keys as what to loop through
     for problem in origin:
-        if origin[problem] == "webwork2":
+        if origin[problem] == "external":
+            msg = "building representations of external WeBWorK problem"
+        elif origin[problem] == "webwork2":
             msg = "building representations of webwork2-hosted WeBWorK problem"
         elif origin[problem] == "generated":
             msg = "building representations of generated WeBWorK problem"
         else:
             raise ValueError(
-                "PTX:ERROR: problem origin should be 'webwork2' or 'generated', not '{}'".format(
+                "PTX:ERROR: problem origin should be 'external', 'webwork2', or 'generated', not '{}'".format(
                     origin[problem]
                 )
             )
@@ -1431,7 +1453,7 @@ def webwork_to_xml(
         # but kill this for the code that is used repeatedly by embedded problems in HTML
         # So here we branch a copy for embedding where we kill `$refreshCachedImages=1;`
         # But we can't literally just remove that, since an author may have used something
-        # like `$refreshCachedImages  =  'true' ;` so instead, we change `$refreshCachedImages`
+        # like `$refreshCachedImages  =  'true' ;` so instead, we change `refreshCachedImages`
         # to something inert
         if origin[problem] == "generated":
             embed_problem = re.sub(r'(refreshCachedImages)(?![\w\d])', r'\1Inert', pgdense[problem])
@@ -1460,16 +1482,44 @@ def webwork_to_xml(
                 if not received: break
                 buffer.extend(received)
                 if buffer.endswith(b'ENDOFSOCKETDATA'): break
-
             response = buffer.decode().replace('ENDOFSOCKETDATA', '')
 
+        elif static_processing == 'renderer' and origin[problem] != 'webwork2':
+            if origin[problem] == "external":
+                with open(os.path.join(external_dir, path[problem])) as f: rawProblemSource = f.read()
+                server_params_source = {"rawProblemSource":rawProblemSource}
+            else:
+                server_params_source = {"rawProblemSource":pgdense[problem]}
+
+            server_params = {
+                "showSolutions": "1",
+                "showHints": "1",
+                "displayMode": "PTX",
+                "courseID": courseID,
+                "user": user,
+                "passwd": passwd,
+                "outputformat": "ptx",
+                "problemSeed": seed[problem],
+                "problemUUID": problem,
+            }
+            server_params.update(server_params_source)
+
+            msg = "sending {} to renderer to save in {}: origin is '{}'"
+            log.info(msg.format(problem, ww_reps_file, origin[problem]))
+
+            response = renderer_session.post(renderer + '/renderer/render-ptx', data=server_params)
+            response = response.text
+
         else:
             # Construct URL to get static version from server
             # First establish how the acctual problem code
             # should be delivered to whatever will render it
             if webwork2_minor_version >= 19:
                 if origin[problem] == "webwork2":
                     server_params_source = {"sourceFilePath":path[problem]}
+                elif origin[problem] == "external":
+                    with open(os.path.join(external_dir, path[problem])) as f: rawProblemSource = f.read()
+                    server_params_source = {"rawProblemSource":rawProblemSource}
                 else:
                     server_params_source = {"rawProblemSource":pgdense[problem]}
             else:
@@ -1511,7 +1561,7 @@ def webwork_to_xml(
 
             msg = "sending {} to server to save in {}: origin is '{}'"
             log.info(msg.format(problem, ww_reps_file, origin[problem]))
-            if origin[problem] == "webwork2":
+            if origin[problem] == "external" or origin[problem] == "webwork2":
                 log.debug(
                     "server-to-ptx: {}\n{}\n{}\n{}".format(
                         problem, webwork2_path, path[problem], ww_reps_file
@@ -1685,7 +1735,10 @@ def webwork_to_xml(
             if static_processing == 'local' and origin[problem] != 'webwork2':
                 ww_image_scheme = ''
             else:
-                ww_image_url = urllib.parse.urljoin(webwork2_domain, ww_image_full_path)
+                if static_processing == 'renderer' and origin[problem] != 'webwork2':
+                    ww_image_url = urllib.parse.urljoin(renderer, ww_image_full_path)
+                else:
+                    ww_image_url = urllib.parse.urljoin(webwork2_domain, ww_image_full_path)
                 # strip away the scheme and location, if present (e.g 'https://webwork-ptx.aimath.org/')
                 ww_image_url_parsed = urllib.parse.urlparse(ww_image_url)
                 ww_image_scheme = ww_image_url_parsed.scheme
@@ -1753,7 +1806,10 @@ def webwork_to_xml(
                 # download actual image files
                 # http://stackoverflow.com/questions/13137817/how-to-download-image-using-requests
                 try:
-                    image_response = webwork2_session.get(image_url)
+                    if static_processing == 'renderer' and origin[problem] != 'webwork2':
+                        image_response = renderer_session.get(image_url)
+                    else:
+                        image_response = webwork2_session.get(image_url)
                 except requests.exceptions.RequestException as e:
                     root_cause = str(e)
                     msg = "PTX:ERROR: there was a problem downloading an image file,\n URL: {}\n"
@@ -1806,7 +1862,7 @@ def webwork_to_xml(
         webwork_reps.set("ww-id", problem)
         static = ET.SubElement(webwork_reps, "static")
         static.set("seed", seed[problem])
-        if origin[problem] == "webwork2":
+        if origin[problem] == "external" or origin[problem] == "webwork2":
             static.set("source", path[problem])
 
         # If there is "badness"...
@@ -1916,6 +1972,8 @@ def static_webwork_level(write, read):
         else:
             if origin[problem] == "webwork2":
                 source_value = path[problem]
+            elif origin[problem] == "external" and webwork2_minor_version >= 19:
+                source_value = os.path.join(external_dir, path[problem])
             else:
                 if webwork2_minor_version < 19:
                     source_value = embed_problem_base64
@@ -1929,6 +1987,7 @@ def static_webwork_level(write, read):
         rendering_data.set(source_key, source_value)
         rendering_data.set("origin", origin[problem])
         rendering_data.set("domain", webwork2_domain)
+        rendering_data.set("renderer", renderer_server)
         rendering_data.set("course-id", courseID)
         rendering_data.set("user-id", user)
         rendering_data.set("passwd", passwd)
@@ -1951,7 +2010,7 @@ def static_webwork_level(write, read):
             else:
                 formatted_pg = pghuman[problem]
             pg.text = ET.CDATA("\n" + formatted_pg)
-        elif origin[problem] == "webwork2":
+        elif origin[problem] == "external" or origin[problem] == "webwork2":
             pg.set("source", path[problem])
 
     # write to file
@@ -1976,6 +2035,14 @@ def static_webwork_level(write, read):
         webwork2_session.close()
     except:
         pass
+    try:
+        renderer_session.close()
+    except:
+        pass
+
+    # close the socket
+    if clientsocket:
+        clientsocket.send(b'quit')
 
     # close the socket
     if clientsocket:
@@ -2032,9 +2099,15 @@ def pg_macros(xml_source, pub_file, stringparams, dest_dir):
 
     if pub_file:
         stringparams["publisher"] = pub_file
+
     ptx_xsl_dir = get_ptx_xsl_path()
     extraction_xslt = os.path.join(ptx_xsl_dir, "support", "pretext-pg-macros.xsl")
-    xsltproc(extraction_xslt, xml_source, None, output_dir=dest_dir, stringparams=stringparams)
+    tmp_dir = get_temporary_directory()
+    xsltproc(extraction_xslt, xml_source, None, output_dir=tmp_dir, stringparams=stringparams)
+    copy_build_directory(tmp_dir, dest_dir)
+    #folder_name = os.listdir(tmp_dir)[0]
+    #folder = os.path.join(tmp_dir, folder_name)
+    #copy_build_directory(folder, os.path.join(dest_dir,folder_name))
 
 ############################################################
 #

pretext/pretext

@@ -326,10 +326,10 @@ def get_cli_arguments():
         ("latex-image", "LaTeX pictures (method: [xelatex], pdflatex)"),
         (
             "webwork",
-            "WeBWorK problems in authored, PG, url, and static representations",
+            "WeBWorK problems in PG files and various representations",
         ),
         ("references", "References and citations via Citation Stylesheet Language"),
-        ("pg-macros", "Server-side macros for WeBWorK problem generation"),
+        ("pg-macros", "PG macros for WeBWorK problem generation"),
         ("dynamic", "Expression subsitutions for dynamically generated exercises"),
         ("youtube", "Thumbnails for YouTube videos (JPEG only)"),
         ("play-button", "generate generic static video image"),
@@ -387,7 +387,7 @@ def get_cli_arguments():
         ),
         ("assembly-version", "PreTeXt source, after pre-processor resolves versions and customizations (for developers)", ),
         ("sagenb", "Sage worksheet conversion (removed)"),
-        ("webwork-sets", "Folder tree of PG files, set definitions, and set headers"),
+        ("webwork-sets", "Folder tree of PG files, PG macros, set definitions, and set headers"),
         ("all", "All available output formats"),
     ]
     format_help = "Output formats are:\n" + "\n".join(