Prezentprogramo 3.1__py3-none-any.whl

hovercraft/generate.py

@@ -0,0 +1,473 @@
+import os
+import re
+import shutil
+from lxml import etree, html
+
+# from pkg_resources import resource_string
+import importlib.resources
+from pyhtml2pdf import converter
+from screeninfo import get_monitors
+from .parse import rst2xml, SlideMaker
+from .position import position_slides
+from .template import (
+    Template,
+    CSS_RESOURCE,
+    JS_RESOURCE,
+    JS_POSITION_HEADER,
+    JS_POSITION_BODY,
+    OTHER_RESOURCE,
+    DIRECTORY_RESOURCE,
+)
+
+
+class ResourceResolver(etree.Resolver):
+    def resolve(self, url, pubid, context):
+        if url.startswith("resource:"):
+            prefix, filename = url.split(":", 1)
+            # return self.resolve_strinog(resource_string(__name__, filename), context)
+            ref = importlib.resources.files(__name__).joinpath(filename)
+            return self.resolve_string(ref.read_bytes(), context)
+
+
+def rst2html(
+    filepath,
+    template_info,
+    auto_console=False,
+    skip_help=False,
+    skip_notes=False,
+    mathjax=False,
+    slide_numbers=False,
+    default_movement_from_args=False,
+):
+    # Read the infile
+    with open(filepath, "rb") as infile:
+        rststring = infile.read()
+
+    presentation_dir = os.path.split(filepath)[0]
+
+    # First convert reST to XML
+    xml, dependencies = rst2xml(rststring, filepath)
+    tree = etree.fromstring(xml)
+
+    # Fix up the resulting XML so it makes sense
+    sm = SlideMaker(tree, skip_notes=skip_notes)
+    tree = sm.walk()
+
+    data_width = None
+    # Pick up CSS information from the tree:
+    for attrib, value in tree.attrib.items():
+
+        if attrib.startswith("data-width"):
+            data_width = value
+
+        if attrib.startswith("css"):
+
+            if "-" in attrib:
+                dummy, media = attrib.split("-", 1)
+            else:
+                media = "all"
+            css_files = tree.attrib[attrib].split()
+            for css_file in css_files:
+                target = f'css/{css_file.split("/")[-1]}'
+                if media in ("console", "preview"):
+                    # The "console" media is used to style the presenter
+                    # console and does not need to be included in the header,
+                    # but must be copied. So we add it as a non css file,
+                    # even though it's a css-file.
+                    template_info.add_resource(
+                        os.path.abspath(os.path.join(presentation_dir, css_file)),
+                        OTHER_RESOURCE,
+                        target=target,
+                    )
+                else:
+                    # Add as a css resource:
+                    template_info.add_resource(
+                        os.path.abspath(os.path.join(presentation_dir, css_file)),
+                        CSS_RESOURCE,
+                        target=target,
+                        extra_info=media,
+                    )
+
+        elif attrib.startswith("js"):
+            if attrib == "js-header":
+                media = JS_POSITION_HEADER
+            else:
+                # Put javascript in body tag as default.
+                media = JS_POSITION_BODY
+            js_files = tree.attrib[attrib].split()
+            for js_file in js_files:
+                target = f'js/{js_file.split("/")[-1]}'
+                template_info.add_resource(
+                    os.path.abspath(os.path.join(presentation_dir, js_file)),
+                    JS_RESOURCE,
+                    target=target,
+                    extra_info=media,
+                )
+
+    if sm.need_mathjax and mathjax:
+        if mathjax.startswith("http"):
+            template_info.add_resource(
+                None, JS_RESOURCE, target=mathjax, extra_info=JS_POSITION_HEADER
+            )
+        else:
+            # Local copy
+            template_info.add_resource(mathjax, DIRECTORY_RESOURCE, target="mathjax")
+            template_info.add_resource(
+                None,
+                JS_RESOURCE,
+                target="mathjax/MathJax.js?config=TeX-MML-AM_CHTML",
+                extra_info=JS_POSITION_HEADER,
+            )
+
+    # Set step width
+    set_step_width(tree, data_width)
+
+    # Position all slides
+    position_slides(tree, default_movement_from_args, data_width)
+
+    # Add the template info to the tree:
+    tree.append(template_info.xml_node())
+
+    # If the console-should open automatically, set an attribute on the document:
+    if auto_console:
+        tree.attrib["auto-console"] = "True"
+
+    # If the console-should open automatically, set an attribute on the document:
+    if skip_help:
+        tree.attrib["skip-help"] = "True"
+
+    # If the slide numbers should be displayed, set an attribute on the document:
+    if slide_numbers:
+        tree.attrib["slide-numbers"] = "True"
+
+    # We need to set up a resolver for resources, so we can include the
+    # reST.xsl file if so desired.
+    parser = etree.XMLParser()
+    parser.resolvers.add(ResourceResolver())
+
+    # Transform the tree to HTML
+    xsl_tree = etree.fromstring(template_info.xsl, parser)
+    transformer = etree.XSLT(xsl_tree)
+    tree = transformer(tree)
+    result = html.tostring(tree)
+
+    return template_info.doctype + result, dependencies
+
+
+def set_step_width(tree, data_width):
+    step_divs = tree.findall("step")
+    width = None
+    if data_width:
+        width = data_width
+    else:
+        presentation_monitor = get_monitors()[
+            -1
+        ]  # Assuming the last monitor is for presentation
+        width = presentation_monitor.width
+        tree.attrib["data-width"] = str(width)
+
+    # Add width style to each found div
+    for div in step_divs:
+        div.set("style", f"width: {width}px;")  # Adding width style
+
+
+def copy_resource(filename, sourcedir, targetdir, sourcepath=None, targetpath=None):
+    if filename[0] == "/" or ":" in filename:
+        # Absolute path or URI: Do nothing
+        return None  # No monitoring needed
+    if sourcepath is None:
+        sourcepath = os.path.join(sourcedir, filename)
+    if targetpath is None:
+        targetpath = os.path.join(targetdir, filename)
+
+    if os.path.exists(targetpath) and os.path.getmtime(sourcepath) <= os.path.getmtime(
+        targetpath
+    ):
+        # File has not changed since last copy, so skip.
+        return sourcepath  # Monitor this file
+
+    targetdir = os.path.split(targetpath)[0]
+    if not os.path.exists(targetdir):
+        os.makedirs(targetdir)
+
+    shutil.copy2(sourcepath, targetpath)
+    return sourcepath  # Monitor this file
+
+
+def generate(args):
+    """Generates the presentation and returns a list of files used"""
+
+    source_files = {args.presentation}
+
+    # Parse the template info
+    template_info = Template(args.template)
+    if args.css:
+        presentation_dir = os.path.split(args.presentation)[0]
+        target_path = os.path.relpath(args.css, presentation_dir)
+        template_info.add_resource(
+            args.css, CSS_RESOURCE, target=target_path, extra_info="all"
+        )
+        source_files.add(args.css)
+    if args.js:
+        presentation_dir = os.path.split(args.presentation)[0]
+        target_path = os.path.relpath(args.js, presentation_dir)
+        template_info.add_resource(
+            args.js, JS_RESOURCE, target=target_path, extra_info=JS_POSITION_BODY
+        )
+        source_files.add(args.js)
+
+    # Make the resulting HTML
+    htmldata, dependencies = rst2html(
+        args.presentation,
+        template_info,
+        args.auto_console,
+        args.skip_help,
+        args.skip_notes,
+        args.mathjax,
+        args.slide_numbers,
+        args.default_movement,
+    )
+    source_files.update(dependencies)
+
+    # Create targetdir directory
+    if not os.path.exists(args.targetdir):
+        os.makedirs(args.targetdir)
+
+    # Copy supporting files
+    source_files.update(template_info.copy_resources(args.targetdir))
+
+    # Copy files from the source:
+    sourcedir = os.path.split(os.path.abspath(args.presentation))[0]
+    tree = html.fromstring(htmldata)
+
+    # Copy images to targetdir/img directory and update html tree
+    for image in tree.iterdescendants("img"):
+        img_src = image.attrib["src"]
+        filename = img_src.split("/")[-1]
+        targetpath = os.path.join(args.targetdir, f"img/{filename}")
+        source_files.add(
+            copy_resource(
+                img_src,
+                sourcedir,
+                args.targetdir,
+                sourcepath=None,
+                targetpath=targetpath,
+            )
+        )
+        image.attrib["src"] = f"img/{filename}"
+
+    for source in tree.iterdescendants("source"):
+        filename = source.attrib["src"]
+        source_files.add(copy_resource(filename, sourcedir, args.targetdir))
+
+    # Code for handling iframe sources
+    for iframe in tree.iterdescendants("iframe"):
+        iframe_src = iframe.attrib.get("src")
+        if iframe_src:
+            filename = iframe_src.split("/")[-1]
+            targetpath = os.path.join(args.targetdir, f"iframe/{filename}")
+            source_files.add(
+                copy_resource(
+                    iframe_src,
+                    sourcedir,
+                    args.targetdir,
+                    sourcepath=None,
+                    targetpath=targetpath,
+                )
+            )
+            iframe.attrib["src"] = f"iframe/{filename}"
+
+    RE_CSS_URL = re.compile(rb"""url\(['"]?(.*?)['"]?[\)\?\#]""")
+
+    # Copy any files referenced by url() in the css-files:
+    for resource in template_info.resources:
+        if resource.resource_type != CSS_RESOURCE:
+            continue
+        # path in CSS is relative to CSS file; construct source/dest accordingly
+        css_base = template_info.template_root if resource.is_in_template else sourcedir
+        css_sourcedir = os.path.dirname(os.path.join(css_base, resource.filepath))
+        css_targetdir = os.path.dirname(
+            os.path.join(args.targetdir, resource.final_path())
+        )
+        uris = RE_CSS_URL.findall(template_info.read_data(resource))
+        uris = [uri.decode() for uri in uris]
+        if resource.is_in_template and template_info.builtin_template:
+            for filename in uris:
+                template_info.add_resource(
+                    filename, OTHER_RESOURCE, target=css_targetdir, is_in_template=True
+                )
+        else:
+            for filename in uris:
+                source_files.add(copy_resource(filename, css_sourcedir, css_targetdir))
+
+    # Write the HTML out
+    htmldata = html.tostring(tree)
+    with open(os.path.join(args.targetdir, "index.html"), "wb") as outfile:
+        outfile.write(htmldata)
+
+    # All done!
+
+    return {os.path.abspath(f) for f in source_files if f}
+
+
+def prepare_for_pdf(html_file_path):
+    # Read the HTML content from the file
+    with open(html_file_path, "r") as html_file:
+        html_content = html_file.read()
+
+        html_content = html_content.replace(
+            "<head>",
+            """<head>
+        <style>
+            .pdfContainer
+            {
+                justify-content: center;
+                align-items: center;
+                display: flex;
+                width: 100%;
+                height: 100%;
+                page-break-after: always;
+            }
+            .substep
+            {
+                opacity: 1 !important;
+            }
+        </style>""",
+        )
+
+    # Find and delete the specific div
+    tree = html.fromstring(html_content)
+    divs_to_delete = tree.xpath('//div[@id="impress"]')
+    for div_to_delete in divs_to_delete:
+        parent = div_to_delete.getparent()
+        for element in div_to_delete.iterchildren():
+            parent.insert(parent.index(div_to_delete), element)
+        parent.remove(div_to_delete)
+
+    # Add a new div around each div with class "step"
+    step_divs = tree.xpath('//div[contains(@class, "step")]')
+    for step_div in step_divs:
+        container_div = html.Element("div")
+        container_div.set("class", "pdfContainer")
+        step_div.addprevious(container_div)
+        container_div.append(step_div)
+
+    # Convert the modified tree back to HTML
+    html_content = html.tostring(tree, encoding="unicode")
+
+    # Write the modified HTML back to the file
+    with open(html_file_path, "w") as html_file:
+        html_file.write(html_content)
+
+
+def generate_pdf(args):
+    """Generates the pdf and returns a list of files used"""
+
+    source_files = {args.presentation}
+    # Parse the template info
+    template_info = Template(args.template)
+    if args.css:
+        presentation_dir = os.path.split(args.presentation)[0]
+        target_path = os.path.relpath(args.css, presentation_dir)
+        template_info.add_resource(
+            args.css, CSS_RESOURCE, target=target_path, extra_info="all"
+        )
+        source_files.add(args.css)
+    if args.js:
+        presentation_dir = os.path.split(args.presentation)[0]
+        target_path = os.path.relpath(args.js, presentation_dir)
+        template_info.add_resource(
+            args.js, JS_RESOURCE, target=target_path, extra_info=JS_POSITION_BODY
+        )
+        source_files.add(args.js)
+
+    # Make the resulting HTML
+    htmldata, dependencies = rst2html(
+        args.presentation,
+        template_info,
+        args.auto_console,
+        args.skip_help,
+        args.skip_notes,
+        args.mathjax,
+        args.slide_numbers,
+    )
+    source_files.update(dependencies)
+
+    args.targetdir = "tmp"
+
+    # Write the HTML out
+    if not os.path.exists(args.targetdir):
+        os.makedirs(args.targetdir)
+
+    indexHtmlPath = os.path.abspath(os.path.join(args.targetdir, "index.html"))
+
+    with open(indexHtmlPath, "wb") as outfile:
+        outfile.write(htmldata)
+
+    # Copy supporting files
+    source_files.update(template_info.copy_resources(args.targetdir))
+
+    # Copy files from the source:
+    sourcedir = os.path.split(os.path.abspath(args.presentation))[0]
+    tree = html.fromstring(htmldata)
+    for image in tree.iterdescendants("img"):
+        filename = image.attrib["src"]
+        source_files.add(copy_resource(filename, sourcedir, args.targetdir))
+    for source in tree.iterdescendants("source"):
+        filename = source.attrib["src"]
+        source_files.add(copy_resource(filename, sourcedir, args.targetdir))
+
+    # Code for handling iframe sources
+    for iframe in tree.iterdescendants("iframe"):
+        iframe_src = iframe.attrib.get("src")
+        if iframe_src:
+            filename = iframe_src.split("/")[-1]
+            targetpath = os.path.join(args.targetdir, f"iframe/{filename}")
+            source_files.add(
+                copy_resource(
+                    iframe_src,
+                    sourcedir,
+                    args.targetdir,
+                    sourcepath=None,
+                    targetpath=targetpath,
+                )
+            )
+            iframe.attrib["src"] = f"iframe/{filename}"
+
+    RE_CSS_URL = re.compile(rb"""url\(['"]?(.*?)['"]?[\)\?\#]""")
+
+    # Copy any files referenced by url() in the css-files:
+    for resource in template_info.resources:
+        if resource.resource_type != CSS_RESOURCE:
+            continue
+        # path in CSS is relative to CSS file; construct source/dest accordingly
+        css_base = template_info.template_root if resource.is_in_template else sourcedir
+        css_sourcedir = os.path.dirname(os.path.join(css_base, resource.filepath))
+        css_targetdir = os.path.dirname(
+            os.path.join(args.targetdir, resource.final_path())
+        )
+        uris = RE_CSS_URL.findall(template_info.read_data(resource))
+        uris = [uri.decode() for uri in uris]
+        if resource.is_in_template and template_info.builtin_template:
+            for filename in uris:
+                template_info.add_resource(
+                    filename, OTHER_RESOURCE, target=css_targetdir, is_in_template=True
+                )
+        else:
+            for filename in uris:
+                source_files.add(copy_resource(filename, css_sourcedir, css_targetdir))
+
+    # ==========
+
+    prepare_for_pdf(indexHtmlPath)
+
+    converter.convert(
+        f"file:///{indexHtmlPath}",
+        args.pdf_output_path,
+        install_driver=False,
+        print_options={"landscape": True},
+    )
+
+    shutil.rmtree(args.targetdir)
+
+    return {os.path.abspath(f) for f in source_files if f}