markdown-to-confluence 0.4.0__py3-none-any.whl → 0.4.2__py3-none-any.whl

md2conf/application.py

@@ -10,17 +10,13 @@ import logging
 from pathlib import Path
 from typing import Optional
 
-from .api import ConfluenceLabel, ConfluenceSession
-from .converter import (
-    ConfluenceDocument,
-    ConfluenceDocumentOptions,
-    ConfluencePageID,
-    attachment_name,
-)
-from .extra import override
+from .api import ConfluenceContentProperty, ConfluenceLabel, ConfluenceSession, ConfluenceStatus
+from .converter import ConfluenceDocument, ConfluenceDocumentOptions, ConfluencePageID, attachment_name, elements_from_string, get_volatile_attributes
+from .extra import override, path_relative_to
 from .metadata import ConfluencePageMetadata
 from .processor import Converter, DocumentNode, Processor, ProcessorFactory
 from .properties import PageError
+from .xml import is_xml_equal
 
 LOGGER = logging.getLogger(__name__)
 
@@ -32,9 +28,7 @@ class SynchronizingProcessor(Processor):
 
     api: ConfluenceSession
 
-    def __init__(
-        self, api: ConfluenceSession, options: ConfluenceDocumentOptions, root_dir: Path
-    ) -> None:
+    def __init__(self, api: ConfluenceSession, options: ConfluenceDocumentOptions, root_dir: Path) -> None:
         """
         Initializes a new processor instance.
 
@@ -47,9 +41,7 @@ class SynchronizingProcessor(Processor):
         self.api = api
 
     @override
-    def _synchronize_tree(
-        self, root: DocumentNode, root_id: Optional[ConfluencePageID]
-    ) -> None:
+    def _synchronize_tree(self, root: DocumentNode, root_id: Optional[ConfluencePageID]) -> None:
         """
         Creates the cross-reference index and synchronizes the directory tree structure with the Confluence page hierarchy.
 
@@ -59,14 +51,10 @@ class SynchronizingProcessor(Processor):
         """
 
         if root.page_id is None and root_id is None:
-            raise PageError(
-                f"expected: root page ID in options, or explicit page ID in {root.absolute_path}"
-            )
+            raise PageError(f"expected: root page ID in options, or explicit page ID in {root.absolute_path}")
         elif root.page_id is not None and root_id is not None:
             if root.page_id != root_id.page_id:
-                raise PageError(
-                    f"mismatched inferred page ID of {root_id.page_id} and explicit page ID in {root.absolute_path}"
-                )
+                raise PageError(f"mismatched inferred page ID of {root_id.page_id} and explicit page ID in {root.absolute_path}")
 
             real_id = root_id
         elif root_id is not None:
@@ -78,9 +66,7 @@ class SynchronizingProcessor(Processor):
 
         self._synchronize_subtree(root, real_id)
 
-    def _synchronize_subtree(
-        self, node: DocumentNode, parent_id: ConfluencePageID
-    ) -> None:
+    def _synchronize_subtree(self, node: DocumentNode, parent_id: ConfluencePageID) -> None:
         if node.page_id is not None:
             # verify if page exists
             page = self.api.get_page_properties(node.page_id)
@@ -88,6 +74,10 @@ class SynchronizingProcessor(Processor):
         elif node.title is not None:
             # look up page by title
             page = self.api.get_or_create_page(node.title, parent_id.page_id)
+
+            if page.status is ConfluenceStatus.ARCHIVED:
+                raise PageError(f"unable to update archived page with ID {page.id}")
+
             update = True
         else:
             # always create a new page
@@ -108,6 +98,7 @@ class SynchronizingProcessor(Processor):
             page_id=page.id,
             space_key=space_key,
             title=page.title,
+            synchronized=node.synchronized,
         )
         self.page_metadata.add(node.absolute_path, data)
 
@@ -115,9 +106,7 @@ class SynchronizingProcessor(Processor):
             self._synchronize_subtree(child_node, ConfluencePageID(page.id))
 
     @override
-    def _update_page(
-        self, page_id: ConfluencePageID, document: ConfluenceDocument, path: Path
-    ) -> None:
+    def _update_page(self, page_id: ConfluencePageID, document: ConfluenceDocument, path: Path) -> None:
         """
         Saves a new version of a Confluence document.
 
@@ -125,11 +114,11 @@ class SynchronizingProcessor(Processor):
         """
 
         base_path = path.parent
-        for image in document.images:
+        for image_path in document.images:
             self.api.upload_attachment(
                 page_id.page_id,
-                attachment_name(image),
-                attachment_path=base_path / image,
+                attachment_name(path_relative_to(image_path, base_path)),
+                attachment_path=image_path,
             )
 
         for name, data in document.embedded_images.items():
@@ -145,14 +134,8 @@ class SynchronizingProcessor(Processor):
         title = None
         if document.title is not None:
             meta = self.page_metadata.get(path)
-            if (
-                meta is not None
-                and meta.space_key is not None
-                and meta.title != document.title
-            ):
-                conflicting_page_id = self.api.page_exists(
-                    document.title, space_id=self.api.space_key_to_id(meta.space_key)
-                )
+            if meta is not None and meta.space_key is not None and meta.title != document.title:
+                conflicting_page_id = self.api.page_exists(document.title, space_id=self.api.space_key_to_id(meta.space_key))
                 if conflicting_page_id is None:
                     title = document.title
                 else:
@@ -162,17 +145,30 @@ class SynchronizingProcessor(Processor):
                         conflicting_page_id,
                     )
 
-        self.api.update_page(page_id.page_id, content, title=title)
+        # fetch existing page
+        page = self.api.get_page(page_id.page_id)
+        if not title:  # empty or `None`
+            title = page.title
+
+        # check if page has any changes
+        if page.title != title or not is_xml_equal(
+            document.root,
+            elements_from_string(page.content),
+            skip_attributes=get_volatile_attributes(),
+        ):
+            self.api.update_page(page_id.page_id, content, title=title, version=page.version.number + 1)
+        else:
+            LOGGER.info("Up-to-date page: %s", page_id)
 
         if document.labels is not None:
             self.api.update_labels(
                 page_id.page_id,
-                [
-                    ConfluenceLabel(name=label, prefix="global")
-                    for label in document.labels
-                ],
+                [ConfluenceLabel(name=label, prefix="global") for label in document.labels],
             )
 
+        if document.properties is not None:
+            self.api.update_content_properties_for_page(page_id.page_id, [ConfluenceContentProperty(key, value) for key, value in document.properties.items()])
+
     def _update_markdown(self, path: Path, *, page_id: str, space_key: str) -> None:
         """
         Writes the Confluence page ID and space key at the beginning of the Markdown file.
@@ -202,9 +198,7 @@ class SynchronizingProcessor(Processor):
 class SynchronizingProcessorFactory(ProcessorFactory):
     api: ConfluenceSession
 
-    def __init__(
-        self, api: ConfluenceSession, options: ConfluenceDocumentOptions
-    ) -> None:
+    def __init__(self, api: ConfluenceSession, options: ConfluenceDocumentOptions) -> None:
         super().__init__(options, api.site)
         self.api = api
 
@@ -219,7 +213,5 @@ class Application(Converter):
     This is the class instantiated by the command-line application.
     """
 
-    def __init__(
-        self, api: ConfluenceSession, options: ConfluenceDocumentOptions
-    ) -> None:
+    def __init__(self, api: ConfluenceSession, options: ConfluenceDocumentOptions) -> None:
         super().__init__(SynchronizingProcessorFactory(api, options))

md2conf/collection.py

@@ -7,25 +7,31 @@ Copyright 2022-2025, Levente Hunyadi
 """
 
 from pathlib import Path
-from typing import Iterable, Optional
+from typing import Generic, Iterable, Optional, TypeVar
 
 from .metadata import ConfluencePageMetadata
 
+K = TypeVar("K")
+V = TypeVar("V")
 
-class ConfluencePageCollection:
-    _metadata: dict[Path, ConfluencePageMetadata]
+
+class KeyValueCollection(Generic[K, V]):
+    _collection: dict[K, V]
 
     def __init__(self) -> None:
-        self._metadata = {}
+        self._collection = {}
 
     def __len__(self) -> int:
-        return len(self._metadata)
+        return len(self._collection)
+
+    def add(self, key: K, data: V) -> None:
+        self._collection[key] = data
+
+    def get(self, key: K) -> Optional[V]:
+        return self._collection.get(key)
 
-    def add(self, path: Path, data: ConfluencePageMetadata) -> None:
-        self._metadata[path] = data
+    def items(self) -> Iterable[tuple[K, V]]:
+        return self._collection.items()
 
-    def get(self, path: Path) -> Optional[ConfluencePageMetadata]:
-        return self._metadata.get(path)
 
-    def items(self) -> Iterable[tuple[Path, ConfluencePageMetadata]]:
-        return self._metadata.items()
+class ConfluencePageCollection(KeyValueCollection[Path, ConfluencePageMetadata]): ...