markdown-to-confluence 0.5.1__py3-none-any.whl → 0.5.3__py3-none-any.whl

md2conf/svg.py

@@ -0,0 +1,341 @@
+"""
+Publish Markdown files to Confluence wiki.
+
+Copyright 2022-2026, Levente Hunyadi
+
+:see: https://github.com/hunyadi/md2conf
+"""
+
+import logging
+import re
+from pathlib import Path
+
+import lxml.etree as ET
+
+ElementType = ET._Element  # pyright: ignore [reportPrivateUsage]
+
+LOGGER = logging.getLogger(__name__)
+
+SVG_NAMESPACE = "http://www.w3.org/2000/svg"
+
+
+def _check_svg(root: ElementType) -> bool:
+    "Tests if the element is a plain or scoped SVG element."
+
+    root_tag = root.tag
+    if not isinstance(root_tag, str):
+        raise TypeError("expected: tag names as `str`")
+
+    # Handle namespaced and non-namespaced SVG
+    qname = ET.QName(root_tag)
+    return qname.localname == "svg" and (not qname.namespace or qname.namespace == SVG_NAMESPACE)
+
+
+def _extract_dimensions_from_root(root: ElementType) -> tuple[int | None, int | None]:
+    """
+    Extracts width and height from an SVG root element.
+
+    Attempts to read dimensions from:
+    1. Explicit width/height attributes on the root <svg> element
+    2. The viewBox attribute if width/height are not specified
+
+    :param root: The root element of the SVG document.
+    :returns: A tuple of (width, height) in pixels, or (None, None) if dimensions cannot be determined.
+    """
+
+    if not _check_svg(root):
+        return None, None
+
+    width_attr = root.get("width")
+    height_attr = root.get("height")
+
+    width = _parse_svg_length(width_attr) if width_attr else None
+    height = _parse_svg_length(height_attr) if height_attr else None
+
+    # If width/height not specified, try to derive from viewBox
+    if width is None or height is None:
+        viewbox = root.get("viewBox")
+        if viewbox:
+            vb_width, vb_height = _parse_viewbox(viewbox)
+            if width is None:
+                width = vb_width
+            if height is None:
+                height = vb_height
+
+    return width, height
+
+
+def get_svg_dimensions(path: Path) -> tuple[int | None, int | None]:
+    """
+    Extracts width and height from an SVG file.
+
+    Attempts to read dimensions from:
+    1. Explicit width/height attributes on the root <svg> element
+    2. The viewBox attribute if width/height are not specified
+
+    :param path: Path to the SVG file.
+    :returns: A tuple of (width, height) in pixels, or (None, None) if dimensions cannot be determined.
+    """
+
+    try:
+        tree = ET.parse(str(path))
+        root = tree.getroot()
+        width, height = _extract_dimensions_from_root(root)
+        if width is None and height is None:
+            LOGGER.warning("SVG file %s does not have an <svg> root element", path)
+        return width, height
+
+    except ET.XMLSyntaxError as ex:
+        LOGGER.warning("Failed to parse SVG file %s: %s", path, ex)
+        return None, None
+    except Exception as ex:
+        LOGGER.warning("Unexpected error reading SVG dimensions from %s: %s", path, ex)
+        return None, None
+
+
+def get_svg_dimensions_from_bytes(data: bytes) -> tuple[int | None, int | None]:
+    """
+    Extracts width and height from SVG data in memory.
+
+    Attempts to read dimensions from:
+    1. Explicit width/height attributes on the root <svg> element
+    2. The viewBox attribute if width/height are not specified
+
+    :param data: The SVG content as bytes.
+    :returns: A tuple of (width, height) in pixels, or (None, None) if dimensions cannot be determined.
+    """
+
+    try:
+        root = ET.fromstring(data)
+        return _extract_dimensions_from_root(root)
+
+    except ET.XMLSyntaxError as ex:
+        LOGGER.warning("Failed to parse SVG data: %s", ex)
+        return None, None
+    except Exception as ex:
+        LOGGER.warning("Unexpected error reading SVG dimensions from data: %s", ex)
+        return None, None
+
+
+def _serialize_svg_opening_tag(root: ElementType) -> str:
+    """
+    Serializes just the opening tag of an SVG element (without children or closing tag).
+
+    :param root: The root SVG element.
+    :returns: The opening tag string, e.g., '<svg width="100" height="200" ...>'.
+    """
+
+    # Build the opening tag from element name and attributes
+    root_tag = root.tag
+    if not isinstance(root_tag, str):
+        raise TypeError("expected: tag names as `str`")
+    tag_name = ET.QName(root_tag).localname
+    parts = [f"<{tag_name}"]
+
+    # Add namespace declarations (nsmap)
+    for prefix, uri in root.nsmap.items():
+        if prefix is None:
+            parts.append(f' xmlns="{uri}"')
+        else:
+            parts.append(f' xmlns:{prefix}="{uri}"')
+
+    # Add attributes
+    for name, value in root.attrib.items():
+        qname = ET.QName(name)
+
+        # Handle namespaced attributes
+        if qname.namespace:
+            # Find prefix for this namespace
+            prefix = None
+            for p, u in root.nsmap.items():
+                if u == qname.namespace and p is not None:
+                    prefix = p
+                    break
+            if prefix:
+                parts.append(f' {prefix}:{qname.localname}="{value}"')
+            else:
+                parts.append(f' {qname.localname}="{value}"')
+        else:
+            parts.append(f' {name}="{value}"')
+
+    parts.append(">")
+    return "".join(parts)
+
+
+def fix_svg_dimensions(data: bytes) -> bytes:
+    """
+    Fixes SVG data by setting explicit width/height attributes based on viewBox.
+
+    Mermaid generates SVGs with width="100%" which Confluence doesn't handle well.
+    This function replaces percentage-based dimensions with explicit pixel values
+    derived from the viewBox.
+
+    Note: SVGs containing foreignObject elements are NOT modified, as Confluence
+    has rendering issues with foreignObject when explicit dimensions are set.
+
+    Uses lxml to parse and modify the root element's attributes, then replaces
+    just the opening tag in the original document to preserve the rest exactly.
+
+    :param data: The SVG content as bytes.
+    :returns: The modified SVG content with explicit dimensions, or original data if modification fails.
+    """
+
+    try:
+        text = data.decode("utf-8")
+
+        # Skip SVGs with foreignObject - Confluence has issues rendering
+        # foreignObject content when explicit width/height are set on the SVG
+        if "<foreignObject" in text:
+            LOGGER.debug("Skipping dimension fix for SVG with foreignObject elements")
+            return data
+
+        # Parse the SVG to extract root element attributes
+        root = ET.fromstring(data)
+
+        # Verify it's an SVG element
+        if not _check_svg(root):
+            return data
+
+        # Check if we need to fix (has width="100%" or similar percentage)
+        width_attr = root.get("width")
+        if width_attr != "100%":
+            # Check if it already has a valid numeric width
+            if width_attr is not None and _parse_svg_length(width_attr) is not None:
+                return data  # Already has numeric width
+
+        # Get viewBox dimensions
+        viewbox = root.get("viewBox")
+        if not viewbox:
+            return data
+
+        vb_width, vb_height = _parse_viewbox(viewbox)
+        if vb_width is None or vb_height is None:
+            return data
+
+        # Extract the original opening tag from the text
+        svg_tag_match = re.search(r"<svg\b[^>]*>", text)
+        if not svg_tag_match:
+            return data
+
+        original_tag = svg_tag_match.group(0)
+
+        # Modify the root element's attributes
+        root.set("width", str(vb_width))
+
+        # Set height if missing or if it's a percentage
+        height_attr = root.get("height")
+        if height_attr is None or height_attr == "100%":
+            root.set("height", str(vb_height))
+
+        # Serialize just the opening tag with modified attributes
+        new_tag = _serialize_svg_opening_tag(root)
+
+        # Replace the original opening tag with the new one
+        text = text.replace(original_tag, new_tag, 1)
+
+        return text.encode("utf-8")
+
+    except Exception as ex:
+        LOGGER.warning("Unexpected error fixing SVG dimensions: %s", ex)
+        return data
+
+
+def _parse_svg_length(value: str) -> int | None:
+    """
+    Parses an SVG length value and converts it to pixels.
+
+    Supports: px, pt, em, ex, in, cm, mm, pc, and unit-less values.
+    For simplicity, assumes 96 DPI and 16px base font size.
+
+    :param value: The SVG length string (e.g., "100", "100px", "10em").
+    :returns: The length in pixels as an integer, or None if parsing fails.
+    """
+
+    if not value:
+        return None
+
+    value = value.strip()
+
+    # Match number with optional unit
+    match = re.match(r"^([+-]?(?:\d+\.?\d*|\.\d+))(%|px|pt|em|ex|in|cm|mm|pc)?$", value, re.IGNORECASE)
+    if not match:
+        return None
+
+    num_str, unit = match.groups()
+    try:
+        num = float(num_str)
+    except ValueError:
+        return None
+
+    # Convert to pixels (assuming 96 DPI, 16px base font)
+    match unit.lower() if unit else None:
+        case None | "px":
+            pixels = num
+        case "pt":
+            pixels = num * 96 / 72  # 1pt = 1/72 inch
+        case "in":
+            pixels = num * 96
+        case "cm":
+            pixels = num * 96 / 2.54
+        case "mm":
+            pixels = num * 96 / 25.4
+        case "pc":
+            pixels = num * 96 / 6  # 1pc = 12pt = 1/6 inch
+        case "em":
+            pixels = num * 16  # assume 16px base font
+        case "ex":
+            pixels = num * 8  # assume ex ≈ 0.5em
+        case "%":
+            # Percentage values can't be resolved without a container; skip
+            return None
+        case _:
+            return None
+
+    return int(round(pixels))
+
+
+def _parse_viewbox(viewbox: str) -> tuple[int | None, int | None]:
+    """
+    Parses an SVG viewBox attribute and extracts width and height.
+
+    :param viewbox: The viewBox string (e.g., "0 0 100 200").
+    :returns: A tuple of (width, height) in pixels, or (None, None) if parsing fails.
+    """
+
+    if not viewbox:
+        return None, None
+
+    # viewBox format: "min-x min-y width height"
+    # Values can be separated by whitespace and/or commas
+    parts = re.split(r"[\s,]+", viewbox.strip())
+    if len(parts) != 4:
+        return None, None
+
+    try:
+        width = int(round(float(parts[2])))
+        height = int(round(float(parts[3])))
+        return width, height
+    except ValueError:
+        return None, None
+
+
+def fix_svg_get_dimensions(image_data: bytes) -> tuple[bytes, int | None, int | None]:
+    """
+    Post-processes SVG diagram data by fixing dimensions and extracting metadata.
+
+    This handles the common pattern for SVG diagrams:
+
+    1. fixes SVG dimensions (converts percentage-based to explicit pixels), and
+    2. extracts width/height from the SVG.
+
+    :param image_data: Raw SVG data as bytes.
+    :returns: Tuple of update raw data, image width, image height.
+    """
+
+    # fix SVG to have explicit width/height instead of percentages
+    image_data = fix_svg_dimensions(image_data)
+
+    # extract dimensions from the fixed SVG
+    width, height = get_svg_dimensions_from_bytes(image_data)
+
+    return image_data, width, height

md2conf/text.py

@@ -1,7 +1,7 @@
 """
 Publish Markdown files to Confluence wiki.
 
-Copyright 2022-2025, Levente Hunyadi
+Copyright 2022-2026, Levente Hunyadi
 
 :see: https://github.com/hunyadi/md2conf
 """

md2conf/toc.py

@@ -1,7 +1,7 @@
 """
 Publish Markdown files to Confluence wiki.
 
-Copyright 2022-2025, Levente Hunyadi
+Copyright 2022-2026, Levente Hunyadi
 
 :see: https://github.com/hunyadi/md2conf
 """

md2conf/uri.py

@@ -1,7 +1,7 @@
 """
 Publish Markdown files to Confluence wiki.
 
-Copyright 2022-2025, Levente Hunyadi
+Copyright 2022-2026, Levente Hunyadi
 
 :see: https://github.com/hunyadi/md2conf
 """

md2conf/xml.py

@@ -1,7 +1,7 @@
 """
 Publish Markdown files to Confluence wiki.
 
-Copyright 2022-2025, Levente Hunyadi
+Copyright 2022-2026, Levente Hunyadi
 
 :see: https://github.com/hunyadi/md2conf
 """

markdown_to_confluence-0.5.1.dist-info/RECORD

@@ -1,35 +0,0 @@
-markdown_to_confluence-0.5.1.dist-info/licenses/LICENSE,sha256=56L-Y0dyZwyVlINRJRz3PNw-ka-oLVaAq-7d8zo6qlc,1077
-md2conf/__init__.py,sha256=BhdWezYDER-ShxuHElVX_sLnP_NkQ7WoO5tr318SwgE,402
-md2conf/__main__.py,sha256=ZAwZ2YqKUxKiVx8CQsrnso9z2deP5Xn80kqqf2o3AbY,11472
-md2conf/api.py,sha256=yFDsE_5IpCXG4z24ZrxF8QjF07ep3HiBHqaWKcGKf1k,40731
-md2conf/collection.py,sha256=nghFS5kK4kPbpLE7IHi4rprJK-Mu4KXNxjHYM9Rc5SQ,824
-md2conf/converter.py,sha256=BM94de0CAQGXOTSve7_042y3VF_yu77NITX5FUUeJPQ,69446
-md2conf/csf.py,sha256=rugs3qC2aJQCJSTczeBw9WhqSZZtMq14LjwT0V1b6Hc,6476
-md2conf/domain.py,sha256=EsaAfUaT2qIrK91uRyxaPEY4kSq-nzhccErxVqHdooc,2205
-md2conf/drawio.py,sha256=IqFlAegrKM5SQf5CqHD8STIzskH7Rpm9RtWwn_nXVTc,8581
-md2conf/emoticon.py,sha256=P2L5oQvnRXeVifJQ3sJ2Ck-6ptbxumq2vsT-rM0W0Ms,484
-md2conf/entities.dtd,sha256=M6NzqL5N7dPs_eUA_6sDsiSLzDaAacrx9LdttiufvYU,30215
-md2conf/environment.py,sha256=BhI7YktY7G26HOhGlUvTkH2Vmfa4E_dhu2snzbBgMvE,3902
-md2conf/extra.py,sha256=VuMxuOnnC2Qwy6y52ukIxsaYhrZArRqMmRHRE4QZl8g,687
-md2conf/latex.py,sha256=3eFgsvaq6ROAc2skW1Wq21CX_pJai1Yc9t861Z3s5XA,7600
-md2conf/local.py,sha256=Ou-j7kZWbHxC8Si8Yg7myqtTQ1He6mYQW1NpX3LLIcY,3704
-md2conf/markdown.py,sha256=t-z19Zs_91_jzRvwmOsWqCDt0Tdghmk5bpNUON0YlKc,3148
-md2conf/matcher.py,sha256=hkM49osFM9nrXRXe4pwcGCg0rrLsmKep7AYY_S01kNY,6774
-md2conf/mermaid.py,sha256=9P4VV69dooaFBNUjdTIpzq7BFA8rDMqEif1O7XKWPdM,2617
-md2conf/metadata.py,sha256=_kt_lh4gCzVRRhhrDk-cJCk9WMcX9ZDWB6hL0Lw3xoI,976
-md2conf/processor.py,sha256=8Y-NSxAuqSHMSN9vhw_83HisGAmq87XAY98dis_xZ0Y,9690
-md2conf/publisher.py,sha256=yI7gObPZLrNEXbiPKBJwkBPcGLI17UwzKd8FQe3U8bE,8634
-md2conf/puppeteer-config.json,sha256=-dMTAN_7kNTGbDlfXzApl0KJpAWna9YKZdwMKbpOb60,159
-md2conf/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-md2conf/scanner.py,sha256=o46fTQXuTpbtvpnQPW3CW4ydIb5bM362K2TFpwO51P0,6782
-md2conf/serializer.py,sha256=JrBj8Z9zP8PjBeVAlRRqnMKDoz6IvkRbTd6K-JgFVow,1757
-md2conf/text.py,sha256=fHOrUaPXAjE4iRhHqFq-CiI-knpo4wvyHCWp0crewqA,1736
-md2conf/toc.py,sha256=ZrfUfTv_Jiv27G4SBNjK3b-1ClYKoqN5yPRsEWp6IXk,2413
-md2conf/uri.py,sha256=KbLBdRFtZTQTZd8b4j0LtE8Pb68Ly0WkemF4iW-EAB4,1158
-md2conf/xml.py,sha256=Fu00Eg8c0VgMHIjRDBJBSNWtui8obEtowkiR7gHTduM,5526
-markdown_to_confluence-0.5.1.dist-info/METADATA,sha256=Qttp8PjzAJnE6mJ_2-1ABYAVMCjEQeuL7QlaOcTmiEY,36463
-markdown_to_confluence-0.5.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-markdown_to_confluence-0.5.1.dist-info/entry_points.txt,sha256=F1zxa1wtEObtbHS-qp46330WVFLHdMnV2wQ-ZorRmX0,50
-markdown_to_confluence-0.5.1.dist-info/top_level.txt,sha256=_FJfl_kHrHNidyjUOuS01ngu_jDsfc-ZjSocNRJnTzU,8
-markdown_to_confluence-0.5.1.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-markdown_to_confluence-0.5.1.dist-info/RECORD,,

md2conf/domain.py

@@ -1,52 +0,0 @@
-"""
-Publish Markdown files to Confluence wiki.
-
-Copyright 2022-2025, Levente Hunyadi
-
-:see: https://github.com/hunyadi/md2conf
-"""
-
-from dataclasses import dataclass
-from typing import Literal
-
-
-@dataclass
-class ConfluencePageID:
-    page_id: str
-
-
-@dataclass
-class ConfluenceDocumentOptions:
-    """
-    Options that control the generated page content.
-
-    :param ignore_invalid_url: When true, ignore invalid URLs in input, emit a warning and replace the anchor with
-        plain text; when false, raise an exception.
-    :param heading_anchors: When true, emit a structured macro *anchor* for each section heading using GitHub
-        conversion rules for the identifier.
-    :param generated_by: Text to use as the generated-by prompt (or `None` to omit a prompt).
-    :param root_page_id: Confluence page to assume root page role for publishing a directory of Markdown files.
-    :param keep_hierarchy: Whether to maintain source directory structure when exporting to Confluence.
-    :param prefer_raster: Whether to choose PNG files over SVG files when available.
-    :param render_drawio: Whether to pre-render (or use the pre-rendered version of) draw.io diagrams.
-    :param render_mermaid: Whether to pre-render Mermaid diagrams into PNG/SVG images.
-    :param render_latex: Whether to pre-render LaTeX formulas into PNG/SVG images.
-    :param diagram_output_format: Target image format for diagrams.
-    :param webui_links: When true, convert relative URLs to Confluence Web UI links.
-    :param alignment: Alignment for block-level images and formulas.
-    :param use_panel: Whether to transform admonitions and alerts into a Confluence custom panel.
-    """
-
-    ignore_invalid_url: bool = False
-    heading_anchors: bool = False
-    generated_by: str | None = "This page has been generated with a tool."
-    root_page_id: ConfluencePageID | None = None
-    keep_hierarchy: bool = False
-    prefer_raster: bool = True
-    render_drawio: bool = False
-    render_mermaid: bool = False
-    render_latex: bool = False
-    diagram_output_format: Literal["png", "svg"] = "png"
-    webui_links: bool = False
-    alignment: Literal["center", "left", "right"] = "center"
-    use_panel: bool = False