PDFAPPS-6716: added use cases for Bookmarks

Dmitriy-Xawstov · web-flow · commit ab2a21b67410 · 2025-02-20T07:23:40.000+02:00
diff --git a/Uses-Cases/Bookmarks/add/appendBookmarks.py b/Uses-Cases/Bookmarks/add/appendBookmarks.py
@@ -0,0 +1,106 @@
+import shutil
+import json
+import logging
+from pathlib import Path
+from asposepdfcloud import ApiClient, PdfApi, Link, Color, Bookmark
+
+# Configure logging
+logging.basicConfig(level=logging.INFO, format="%(asctime)s - %(levelname)s - %(message)s")
+
+class Config:
+    """Configuration parameters."""
+    CREDENTIALS_FILE = Path(r"C:\\Projects\\ASPOSE\\Pdf.Cloud\\Credentials\\credentials.json")
+    LOCAL_FOLDER = Path(r"C:\Samples")
+    PDF_DOCUMENT_NAME = "sample.pdf"
+    LOCAL_RESULT_DOCUMENT_NAME = "output_sample.pdf"
+    NEW_BOOKMARK_TITLE = "• Підвищення продуктивності: Автоматизація дозволяє виконувати багато завдань швидше та ефективніше, ніж це може зробити людина. Це особливо важливо в промислових галузях, де швидкість та точність відіграють вирішальну роль." #"• Productivity improvement"
+    PARENT_BOOKMARK_FOR_APPEND = ""                 #The parent bookmark path. Specify an empty string when adding a bookmark to the root.
+    NEW_BOOKMARK_PAGE_NUMBER = 3
+    BOOKMARK_PAGE_POSITION_X = 89
+    BOOKMARK_PAGE_POSITION_Y = 564
+    
+
+class PdfBookmarks:
+    """Class for managing PDF bokkmarks using Aspose PDF Cloud API."""
+    def __init__(self, credentials_file: Path = Config.CREDENTIALS_FILE):
+        self.pdf_api = None
+        self._init_api(credentials_file)
+
+    def _init_api(self, credentials_file: Path):
+        """Initialize the API client."""
+        try:
+            with credentials_file.open("r", encoding="utf-8") as file:
+                credentials = json.load(file)
+                api_key, app_id = credentials.get("key"), credentials.get("id")
+                if not api_key or not app_id:
+                    raise ValueError("init_api(): Error: Missing API keys in the credentials file.")
+                self.pdf_api = PdfApi(ApiClient(api_key, app_id))
+        except (FileNotFoundError, json.JSONDecodeError, ValueError) as e:
+            logging.error(f"init_api(): Failed to load credentials: {e}")
+
+    def _ensure_api_initialized(self):
+        """Check if the API is initialized before making API calls."""
+        if not self.pdf_api:
+            logging.error("ensure_api_initialized(): PDF API is not initialized. Operation aborted.")
+            return False
+        return True
+
+    def upload_document(self):
+        """Upload a PDF document to the Aspose Cloud server."""
+        if not self._ensure_api_initialized():
+            return
+
+        file_path = Config.LOCAL_FOLDER / Config.PDF_DOCUMENT_NAME
+        try:
+            self.pdf_api.upload_file(Config.PDF_DOCUMENT_NAME, str(file_path))
+            logging.info(f"upload_document(): File {Config.PDF_DOCUMENT_NAME} uploaded successfully.")
+        except Exception as e:
+            logging.error(f"upload_document(): Failed to upload file: {e}")
+
+    def download_result(self):
+        """Download the processed PDF document from the Aspose Cloud server."""
+        if not self._ensure_api_initialized():
+            return
+
+        try:
+            file_path = self.pdf_api.download_file(Config.PDF_DOCUMENT_NAME)
+            local_path = Config.LOCAL_FOLDER / Config.LOCAL_RESULT_DOCUMENT_NAME
+            shutil.move(file_path, str(local_path))
+            logging.info(f"download_result(): File successfully downloaded: {local_path}")
+        except Exception as e:
+            logging.error(f"download_result(): Failed to download file: {e}")
+
+    def append_bookmark_link(self):
+        """Append a new bookmark link to a specific page in the PDF document."""
+        if not self._ensure_api_initialized():
+            return
+
+        newBookmark = Bookmark(
+            title = Config.NEW_BOOKMARK_TITLE,
+            italic = True,
+            bold = True,
+            color = Color(a=255,r=0,g=255,b=0),
+            level = 1,
+            page_display_left = Config.BOOKMARK_PAGE_POSITION_X,
+            page_display_top = Config.BOOKMARK_PAGE_POSITION_Y,
+            page_display_zoom = 2,
+            page_number = Config.NEW_BOOKMARK_PAGE_NUMBER
+        )
+
+        try:
+            response = self.pdf_api.post_bookmark(
+                Config.PDF_DOCUMENT_NAME, Config.PARENT_BOOKMARK_FOR_APPEND, [newBookmark]
+            )
+            if response.code == 200:
+                logging.info(f"append_bookmark_link(): Bookmark '{response.bookmarks.list[0].action}'->'{Config.NEW_BOOKMARK_TITLE}' added to page #{Config.NEW_BOOKMARK_PAGE_NUMBER}.")
+            else:
+                logging.error(f"append_bookmark_link(): Failed to add bookmark '{Config.NEW_BOOKMARK_TITLE}' to the page #{Config.NEW_BOOKMARK_PAGE_NUMBER}. Response code: {response.code}")
+        except Exception as e:
+            logging.error(f"append_bookmark_link(): Error while adding bookmark: {e}")
+
+
+if __name__ == "__main__":
+    pdf_bookmarks = PdfBookmarks()
+    pdf_bookmarks.upload_document()
+    pdf_bookmarks.append_bookmark_link()
+    pdf_bookmarks.download_result()
diff --git a/Uses-Cases/Bookmarks/get/getBookmarkByPathAndShow.py b/Uses-Cases/Bookmarks/get/getBookmarkByPathAndShow.py
@@ -0,0 +1,73 @@
+import shutil
+import json
+import logging
+from pathlib import Path
+from asposepdfcloud import ApiClient, PdfApi, BookmarkResponse
+
+# Configure logging
+logging.basicConfig(level=logging.INFO, format="%(asctime)s - %(levelname)s - %(message)s")
+
+
+class Config:
+    """Configuration parameters."""
+    CREDENTIALS_FILE = Path(r"C:\\Projects\\ASPOSE\\Pdf.Cloud\\Credentials\\credentials.json")
+    LOCAL_FOLDER = Path(r"C:\Samples")
+    PDF_DOCUMENT_NAME = "sample.pdf"
+    BOOKMARK_PATH = "/5"
+
+class PdfBookmarks:
+    """Class for managing PDF bookmarks using Aspose PDF Cloud API."""
+
+    def __init__(self, credentials_file: Path = Config.CREDENTIALS_FILE):
+        self.pdf_api = None
+        self._init_api(credentials_file)
+
+    def _init_api(self, credentials_file: Path):
+        """Initialize the API client."""
+        try:
+            with credentials_file.open("r", encoding="utf-8") as file:
+                credentials = json.load(file)
+                api_key, app_id = credentials.get("key"), credentials.get("id")
+                if not api_key or not app_id:
+                    raise ValueError("Error: Missing API keys in the credentials file.")
+                self.pdf_api = PdfApi(ApiClient(api_key, app_id))
+        except (FileNotFoundError, json.JSONDecodeError, ValueError) as e:
+            logging.error(f"Failed to load credentials: {e}")
+
+    def _ensure_api_initialized(self):
+        """Check if the API is initialized before making API calls."""
+        if not self.pdf_api:
+            logging.error("PDF API is not initialized. Operation aborted.")
+            return False
+        return True
+
+    def upload_document(self):
+        """Upload a PDF document to the Aspose Cloud server."""
+        if not self._ensure_api_initialized():
+            return
+
+        file_path = Config.LOCAL_FOLDER / Config.PDF_DOCUMENT_NAME
+        try:
+            self.pdf_api.upload_file(Config.PDF_DOCUMENT_NAME, str(file_path))
+            logging.info(f"File {Config.PDF_DOCUMENT_NAME} uploaded successfully.")
+        except Exception as e:
+            logging.error(f"Failed to upload file: {e}")
+
+    def get_bookmark(self):
+        """Get bookmark for a specific PDF document using bookmark path."""    
+        if not self._ensure_api_initialized():
+            return
+
+        try:
+            response : BookmarkResponse = self.pdf_api.get_bookmark( Config.PDF_DOCUMENT_NAME, Config.BOOKMARK_PATH)
+            if response.code == 200:
+                logging.info(f"Found bookmark => level: '{response.bookmark.level}' - action: '{response.bookmark.action}' - title: '{response.bookmark.title}'")
+            else:
+                logging.error(f"Failed to find bookmark for the document. Response code: {response.code}")
+        except Exception as e:
+            logging.error(f"Error while find bookmark: {e}")
+
+if __name__ == "__main__":
+    pdf_bookmarks = PdfBookmarks()
+    pdf_bookmarks.upload_document()
+    pdf_bookmarks.get_bookmark()
diff --git a/Uses-Cases/Bookmarks/get/getBookmarksAndShow.py b/Uses-Cases/Bookmarks/get/getBookmarksAndShow.py
@@ -0,0 +1,78 @@
+import shutil
+import json
+import logging
+from pathlib import Path
+from asposepdfcloud import ApiClient, PdfApi, Bookmarks, BookmarksResponse
+
+# Configure logging
+logging.basicConfig(level=logging.INFO, format="%(asctime)s - %(levelname)s - %(message)s")
+
+
+class Config:
+    """Configuration parameters."""
+    CREDENTIALS_FILE = Path(r"C:\\Projects\\ASPOSE\\Pdf.Cloud\\Credentials\\credentials.json")
+    LOCAL_FOLDER = Path(r"C:\Samples")
+    PDF_DOCUMENT_NAME = "sample.pdf"
+
+class PdfBookmarks:
+    """Class for managing PDF bookmarks using Aspose PDF Cloud API."""
+
+    def __init__(self, credentials_file: Path = Config.CREDENTIALS_FILE):
+        self.pdf_api = None
+        self._init_api(credentials_file)
+
+    def _init_api(self, credentials_file: Path):
+        """Initialize the API client."""
+        try:
+            with credentials_file.open("r", encoding="utf-8") as file:
+                credentials = json.load(file)
+                api_key, app_id = credentials.get("key"), credentials.get("id")
+                if not api_key or not app_id:
+                    raise ValueError("Error: Missing API keys in the credentials file.")
+                self.pdf_api = PdfApi(ApiClient(api_key, app_id))
+        except (FileNotFoundError, json.JSONDecodeError, ValueError) as e:
+            logging.error(f"Failed to load credentials: {e}")
+
+    def _ensure_api_initialized(self):
+        """Check if the API is initialized before making API calls."""
+        if not self.pdf_api:
+            logging.error("PDF API is not initialized. Operation aborted.")
+            return False
+        return True
+
+    def upload_document(self):
+        """Upload a PDF document to the Aspose Cloud server."""
+        if not self._ensure_api_initialized():
+            return
+
+        file_path = Config.LOCAL_FOLDER / Config.PDF_DOCUMENT_NAME
+        try:
+            self.pdf_api.upload_file(Config.PDF_DOCUMENT_NAME, str(file_path))
+            logging.info(f"File {Config.PDF_DOCUMENT_NAME} uploaded successfully.")
+        except Exception as e:
+            logging.error(f"Failed to upload file: {e}")
+
+    def show_bookmarks_array(self, bookmarks, prefix):
+        for item in bookmarks.list:
+            logging.info(f"{prefix} => level: '{item.level}' - action: '{item.action}' - title: '{item.title}'")
+            if item.bookmarks and item.bookmarks.list and item.bookmarks.list.length > 0:
+                self.show_bookmarks_array(bookmarks=item.bookmarks, prefix=prefix)
+
+    def get_all_bookmarks(self):
+        """Get all bookmarks for a specific PDF document."""    
+        if not self._ensure_api_initialized():
+            return
+
+        try:
+            response : BookmarksResponse = self.pdf_api.get_document_bookmarks( Config.PDF_DOCUMENT_NAME)
+            if response.code == 200:
+                self.show_bookmarks_array(response.bookmarks, "All")
+            else:
+                logging.error(f"Failed to get bookmarks for the document. Response code: {response.code}")
+        except Exception as e:
+            logging.error(f"Error while retrieving bookmarks array: {e}")
+
+if __name__ == "__main__":
+    pdf_bookmarks = PdfBookmarks()
+    pdf_bookmarks.upload_document()
+    pdf_bookmarks.get_all_bookmarks()
diff --git a/Uses-Cases/Bookmarks/remove/removeBookmark.py b/Uses-Cases/Bookmarks/remove/removeBookmark.py
@@ -0,0 +1,86 @@
+import shutil
+import json
+import logging
+from pathlib import Path
+from asposepdfcloud import ApiClient, PdfApi, AsposeResponse
+
+# Configure logging
+logging.basicConfig(level=logging.INFO, format="%(asctime)s - %(levelname)s - %(message)s")
+
+
+class Config:
+    """Configuration parameters."""
+    CREDENTIALS_FILE = Path(r"C:\\Projects\\ASPOSE\\Pdf.Cloud\\Credentials\\credentials.json")
+    LOCAL_FOLDER = Path(r"C:\Samples")
+    PDF_DOCUMENT_NAME = "sample.pdf"
+    LOCAL_RESULT_DOCUMENT_NAME = "output_sample.pdf"
+    BOOKMARK_PATH = "/1"
+
+
+class PdfBookmarks:
+    """Class for managing PDF bookmarks using Aspose PDF Cloud API."""
+
+    def __init__(self, credentials_file: Path = Config.CREDENTIALS_FILE):
+        self.pdf_api = None
+        self._init_api(credentials_file)
+
+    def _init_api(self, credentials_file: Path):
+        """Initialize the API client."""
+        try:
+            with credentials_file.open("r", encoding="utf-8") as file:
+                credentials = json.load(file)
+                api_key, app_id = credentials.get("key"), credentials.get("id")
+                if not api_key or not app_id:
+                    raise ValueError("Error: Missing API keys in the credentials file.")
+                self.pdf_api = PdfApi(ApiClient(api_key, app_id))
+        except (FileNotFoundError, json.JSONDecodeError, ValueError) as e:
+            logging.error(f"Failed to load credentials: {e}")
+
+    def _ensure_api_initialized(self):
+        """Check if the API is initialized before making API calls."""
+        if not self.pdf_api:
+            logging.error("PDF API is not initialized. Operation aborted.")
+            return False
+        return True
+
+    def upload_document(self):
+        """Upload a PDF document to the Aspose Cloud server."""
+        if not self._ensure_api_initialized():
+            return
+
+        file_path = Config.LOCAL_FOLDER / Config.PDF_DOCUMENT_NAME
+        try:
+            self.pdf_api.upload_file(Config.PDF_DOCUMENT_NAME, str(file_path))
+            logging.info(f"File {Config.PDF_DOCUMENT_NAME} uploaded successfully.")
+        except Exception as e:
+            logging.error(f"Failed to upload file: {e}")
+
+    def download_result(self):
+        """Download the processed PDF document from the Aspose Cloud server."""
+        if not self._ensure_api_initialized():
+            return
+
+        try:
+            file_path = self.pdf_api.download_file(Config.PDF_DOCUMENT_NAME)
+            local_path = Config.LOCAL_FOLDER / Config.LOCAL_RESULT_DOCUMENT_NAME
+            shutil.move(file_path, str(local_path))
+            logging.info(f"download_result(): File successfully downloaded: {local_path}")
+        except Exception as e:
+            logging.error(f"download_result(): Failed to download file: {e}")
+
+    def remove_bookmark_by_path(self):
+        if not self.pdf_api:
+            return
+
+        response: AsposeResponse = self.pdf_api.delete_bookmark(Config.PDF_DOCUMENT_NAME, Config.BOOKMARK_PATH)
+
+        if response.code == 200:
+            logging.info(f"Bookmark with path: '{Config.BOOKMARK_PATH}' has been removed.")
+        else:
+            logging.erro(f"Failed to remove bookmark with path: '{Config.LINK_FIND_ID}'.")
+
+if __name__ == "__main__":
+    pdf_bookmarks = PdfBookmarks()
+    pdf_bookmarks.upload_document()
+    pdf_bookmarks.remove_bookmark_by_path()
+    pdf_bookmarks.download_result()
diff --git a/Uses-Cases/Bookmarks/replace/replaceLink.py b/Uses-Cases/Bookmarks/replace/replaceLink.py
