Merge pull request #81 from aspose-pdf-cloud/pdfapps-6709-added-use-cases-for-links

kaferi · web-flow · commit e25ea8673511 · 2025-03-04T10:13:43.000+02:00
PDFAPPS-6709: added use cases for Links
diff --git a/Uses-Cases/Links/add/appendLink.py b/Uses-Cases/Links/add/appendLink.py
@@ -0,0 +1,89 @@
+import shutil
+import json
+import logging
+from pathlib import Path
+from asposepdfcloud import ApiClient, PdfApi, LinkAnnotation, LinkActionType, LinkHighlightingMode, Color, Link, Rectangle
+
+# 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_LINK_ACTION = "https://reference.aspose.cloud/pdf/"
+    PAGE_NUMBER = 2
+    LINK_RECT = Rectangle(llx=244.914, lly=488.622, urx=284.776, ury=498.588)
+
+
+class PdfLinks:
+    """Class for managing PDF links 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 upload_document(self):
+        """Upload a PDF document to the Aspose Cloud server."""
+        if self.pdf_api:
+            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 self.pdf_api:
+            try:
+                temp_file = self.pdf_api.download_file(Config.PDF_DOCUMENT_NAME)
+                local_path = Config.LOCAL_FOLDER / Config.LOCAL_RESULT_DOCUMENT_NAME
+                shutil.move(temp_file, 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_link(self):
+        """Append a new hyperlink annotation to a specific page in the PDF document."""
+        if self.pdf_api:
+            link_annotation = LinkAnnotation(
+                links=[Link(href=Config.NEW_LINK_ACTION)],
+                action_type= LinkActionType.GOTOURIACTION,
+                action=Config.NEW_LINK_ACTION,
+                highlighting=LinkHighlightingMode.INVERT,
+                color=Color(a=255, r=0, g=255, b=0),
+                rect=Config.LINK_RECT,
+            )
+
+            try:
+                response = self.pdf_api.post_page_link_annotations(
+                    Config.PDF_DOCUMENT_NAME, Config.PAGE_NUMBER, [link_annotation]
+                )
+                if response.code == 200:
+                    logging.info(f"append_link(): Link '{Config.NEW_LINK_ACTION}' added to page #{Config.PAGE_NUMBER}.")
+                else:
+                    logging.error(f"append_link(): Failed to add link to the page. Response code: {response.code}")
+            except Exception as e:
+                logging.error(f"append_link(): Error while adding link: {e}")
+
+
+if __name__ == "__main__":
+    pdf_links = PdfLinks()
+    pdf_links.upload_document()
+    pdf_links.append_link()
+    pdf_links.download_result()
diff --git a/Uses-Cases/Links/get/getLinksAndShow.py b/Uses-Cases/Links/get/getLinksAndShow.py
@@ -0,0 +1,80 @@
+import shutil
+import json
+import logging
+from pathlib import Path
+from asposepdfcloud import ApiClient, PdfApi
+
+# 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"
+    PAGE_NUMBER = 2
+    LINK_FIND_ID = "GI5UO32UN5KVESKBMN2GS33OHMZTEMJMGUYDQLBTGYYCYNJSGE"
+
+
+class PdfLinks:
+    """Class for managing PDF links 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 upload_document(self):
+        """Upload a PDF document to the Aspose Cloud server."""
+        if self.pdf_api:
+            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_links_array(self, links, prefix):
+        for item in links:
+            logging.info(f"{prefix} Link ID: '{item.id}' - Link Action: '{item.action}'")
+
+    def get_all_links(self):
+        """Get all hyperlink annotations for a specific PDF document."""
+        if self.pdf_api:
+            try:
+                response = self.pdf_api.get_page_link_annotations( Config.PDF_DOCUMENT_NAME, Config.PAGE_NUMBER)
+                if response.code == 200:
+                    self.show_links_array(response.links.list, "All: ")
+                else:
+                    logging.error(f"Failed to add link to the page. Response code: {response.code}")
+            except Exception as e:
+                logging.error(f"Error while adding link: {e}")
+
+    def get_link_by_id(self, link_id: str):
+        """Get hyperlink annotation using the specific Id in PDF document."""
+        if self.pdf_api:
+            try:
+                result_link = self.pdf_api.get_link_annotation(Config.PDF_DOCUMENT_NAME, link_id)
+                if result_link.code == 200:
+                    self.show_links_array([result_link.link], "Find: ")
+            except Exception as e:
+                logging.error(f"Error while adding link: {e}")
+
+if __name__ == "__main__":
+    pdf_links = PdfLinks()
+    pdf_links.upload_document()
+    pdf_links.get_all_links()
+    pdf_links.get_link_by_id(Config.LINK_FIND_ID)
diff --git a/Uses-Cases/Links/remove/removeLink.py b/Uses-Cases/Links/remove/removeLink.py
@@ -0,0 +1,91 @@
+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"
+    PAGE_NUMBER = 2
+    LINK_FIND_ID = "GI5UO32UN5KVESKBMN2GS33OHMZTEMJMGUYDQLBTGYYCYNJSGE"
+
+
+class PdfLinks:
+    """Class for managing PDF links 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 upload_document(self):
+        """Upload a PDF document to the Aspose Cloud server."""
+        if self.pdf_api:
+            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 self.pdf_api:
+            try:
+                temp_file = self.pdf_api.download_file(Config.PDF_DOCUMENT_NAME)
+                local_path = Config.LOCAL_FOLDER / Config.LOCAL_RESULT_DOCUMENT_NAME
+                shutil.move(temp_file, 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 show_links_array(self, links, prefix):
+        for item in links:
+            logging.info(f"{prefix} Link ID: '{item.id}' - Link Action: '{item.action}'")
+
+    def get_all_links(self):
+        """Get all hyperlink annotations for a specific PDF document."""
+        if self.pdf_api:
+            try:
+                response = self.pdf_api.get_page_link_annotations( Config.PDF_DOCUMENT_NAME, Config.PAGE_NUMBER)
+                if response.code == 200:
+                    self.show_links_array(response.links.list, "All: ")
+                else:
+                    logging.error(f"Failed to add link to the page. Response code: {response.code}")
+            except Exception as e:
+                logging.error(f"Error while adding link: No links found - {e}")
+
+    def remove_link_by_id(self):
+        if self.pdf_api:
+            response: AsposeResponse = self.pdf_api.delete_link_annotation(Config.PDF_DOCUMENT_NAME, Config.LINK_FIND_ID)
+
+            if response.code == 200:
+                logging.info("Link annotation with ID " + Config.LINK_FIND_ID + " has been removed.")
+            else:
+                logging.erro("Failed to remove link annotation with ID " + Config.LINK_FIND_ID)
+
+if __name__ == "__main__":
+    pdf_links = PdfLinks()
+    pdf_links.upload_document()
+    pdf_links.get_all_links()
+    pdf_links.remove_link_by_id()
+    pdf_links.download_result()
diff --git a/Uses-Cases/Links/replace/replaceLink.py b/Uses-Cases/Links/replace/replaceLink.py
@@ -0,0 +1,112 @@
+import shutil
+import json
+import logging
+from pathlib import Path
+from asposepdfcloud import ApiClient, PdfApi, LinkAnnotationsResponse, LinkAnnotationResponse
+
+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_LINK_ACTION = "https://reference.aspose.cloud/pdf/"
+    PAGE_NUMBER = 2
+    LINK_FIND_ID = "GI5UO32UN5KVESKBMN2GS33OHMZTEMJMGUYDQLBTGYYCYNJSGE"
+
+# Configure logging
+logging.basicConfig(level=logging.INFO, format="%(asctime)s - %(levelname)s - %(message)s")
+
+class PdfLinks:
+    """Class for managing PDF links 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 upload_document(self):
+        """Upload a PDF document to the Aspose Cloud server."""
+        if self.pdf_api:
+            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 self.pdf_api:
+            try:
+                temp_file = self.pdf_api.download_file(Config.PDF_DOCUMENT_NAME)
+                local_path = Config.LOCAL_FOLDER / Config.LOCAL_RESULT_DOCUMENT_NAME
+                shutil.move(temp_file, 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 show_links_array(self, links, prefix):
+        """Show all hyperlink annotations for a specific PDF document."""
+        for item in links:
+            logging.info(f"{prefix} Link ID: '{item.id}' - Link Action: '{item.action}'")
+
+    def get_all_links(self):
+        """Get all hyperlink annotations for a specific PDF document."""
+        if self.pdf_api:
+            try:
+                response = self.pdf_api.get_page_link_annotations( Config.PDF_DOCUMENT_NAME, Config.PAGE_NUMBER)
+                if response.code == 200:
+                    self.show_links_array(response.links.list, "All: ")
+                else:
+                    logging.error(f"Failed to add link to the page. Response code: {response.code}")
+            except Exception as e:
+                logging.error(f"Error while adding link: No links found - {e}")
+
+    def get_link_by_id(self) -> LinkAnnotationResponse:
+        if self.pdf_api:
+            result_link: LinkAnnotationResponse = self.pdf_api.get_link_annotation(Config.PDF_DOCUMENT_NAME, Config.LINK_FIND_ID)
+
+            if result_link.code == 200:
+                return result_link
+
+            print("Link not found.")
+            return None
+
+    def replace_link(self):
+        if self.pdf_api:
+            link_annotation: LinkAnnotationResponse = self.get_link_by_id()
+
+            if not link_annotation:
+                return
+
+            link_annotation.link.action = Config.NEW_LINK_ACTION
+
+            response: LinkAnnotationsResponse = self.pdf_api.put_link_annotation(
+                Config.PDF_DOCUMENT_NAME,
+                Config.LINK_FIND_ID,
+                link_annotation.link,
+            )
+
+            if response.code == 200:
+                print("Link annotation replaced successfully.")
+            else:
+                print("Failed to replace link annotation.")
+
+if __name__ == "__main__":
+    pdf_links = PdfLinks()
+    pdf_links.upload_document()
+    pdf_links.get_all_links()
+    pdf_links.replace_link()
+    pdf_links.download_result()
