PDFAPPS-6682: added use cases for Headers/Footers

Author: Dmitriy-Xawstov

Uses-Cases/HeaderFooter/appendImageFooter.py

@@ -0,0 +1,129 @@
+import shutil
+import json
+import logging
+from pathlib import Path
+from asposepdfcloud import ApiClient, PdfApi, ImageFooter, HorizontalAlignment
+
+# 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"
+    IMAGE_FOOTER_FILE = "sample.png"
+    PAGE_NUMBER = 2     # Your document page number...
+    
+
+class pdfHederFooter:
+    """Class for managing PDF headers and footers 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_file(self, fileName: str):
+        """ Upload a local fileName to the Aspose Cloud server. """
+        if not self._ensure_api_initialized():
+            return
+
+        file_path = Config.LOCAL_FOLDER / fileName
+        try:
+            self.pdf_api.upload_file(fileName, str(file_path))
+            logging.info(f"upload_file(): File '{fileName}' uploaded successfully.")
+        except Exception as e:
+            logging.error(f"upload_document(): Failed to upload file: {e}")
+
+    def upload_document(self):
+        """ Upload a PDF document to the Aspose Cloud server. """
+        self.upload_file(Config.PDF_DOCUMENT_NAME)
+
+    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_image_footer(self):
+        """Append a new image footer to the PDF document."""
+        if not self._ensure_api_initialized():
+            return
+
+        new_footer = ImageFooter(
+            background = True,
+            horizontal_alignment = HorizontalAlignment.CENTER,
+            file_name = Config.IMAGE_FOOTER_FILE,
+            width = 24,
+            height = 24
+        )
+
+        try:
+            response = self.pdf_api.post_document_image_footer(
+                Config.PDF_DOCUMENT_NAME, new_footer
+            )
+            if response.code == 200:
+                logging.info(f"append_image_footer(): Footer '{new_footer.file_name}' added to the document #{Config.PDF_DOCUMENT_NAME}.")
+            else:
+                logging.error(f"append_image_footer(): Failed to add footer '{new_footer.file_name}' to the document #{Config.PDF_DOCUMENT_NAME}. Response code: {response.code}")
+        except Exception as e:
+            logging.error(f"append_image_footer(): Error while adding footer: {e}")
+
+    def append_image_footer_page(self):
+        """Append a new image footer on the page in PDF document."""
+        if not self._ensure_api_initialized():
+            return
+
+        new_footer = ImageFooter(
+            background = True,
+            horizontal_alignment = HorizontalAlignment.RIGHT,
+            file_name = Config.IMAGE_FOOTER_FILE,
+            width = 24,
+            height = 24
+        )
+
+        try:
+            response = self.pdf_api.post_document_image_footer(
+                Config.PDF_DOCUMENT_NAME, new_footer, start_page_number=Config.PAGE_NUMBER, end_page_number=Config.PAGE_NUMBER
+            )
+            if response.code == 200:
+                logging.info(f"append_image_footer_page(): Footer '{new_footer.file_name}' added to the page #{Config.PAGE_NUMBER}.")
+            else:
+                logging.error(f"append_image_footer_page(): Failed to add footer '{new_footer.file_name}' to the document #{Config.PAGE_NUMBER}. Response code: {response.code}")
+        except Exception as e:
+            logging.error(f"append_image_footer_page(): Error while adding footer: {e}")
+
+
+if __name__ == "__main__":
+    pdf_header_footer = pdfHederFooter()
+    pdf_header_footer.upload_document()
+    pdf_header_footer.upload_file(Config.IMAGE_FOOTER_FILE)
+    pdf_header_footer.append_image_footer()
+    pdf_header_footer.append_image_footer_page()
+    pdf_header_footer.download_result()

Uses-Cases/HeaderFooter/appendImageHeader.py

@@ -0,0 +1,129 @@
+import shutil
+import json
+import logging
+from pathlib import Path
+from asposepdfcloud import ApiClient, PdfApi, ImageHeader, HorizontalAlignment, TextHorizontalAlignment
+
+# 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"
+    IMAGE_HEADER_FILE = "sample.png"
+    PAGE_NUMBER = 2     # Your document page number...
+    
+
+class pdfHederFooter:
+    """Class for managing PDF headers and footers 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_file(self, fileName: str):
+        """ Upload a local fileName to the Aspose Cloud server. """
+        if not self._ensure_api_initialized():
+            return
+
+        file_path = Config.LOCAL_FOLDER / fileName
+        try:
+            self.pdf_api.upload_file(fileName, str(file_path))
+            logging.info(f"upload_file(): File '{fileName}' uploaded successfully.")
+        except Exception as e:
+            logging.error(f"upload_document(): Failed to upload file: {e}")
+
+    def upload_document(self):
+        """ Upload a PDF document to the Aspose Cloud server. """
+        self.upload_file(Config.PDF_DOCUMENT_NAME)
+
+    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_image_header(self):
+        """Append a new image header to the PDF document."""
+        if not self._ensure_api_initialized():
+            return
+
+        new_header = ImageHeader(
+            background = True,
+            horizontal_alignment = HorizontalAlignment.CENTER,
+            file_name = Config.IMAGE_HEADER_FILE,
+            width = 24,
+            height = 24
+        )
+
+        try:
+            response = self.pdf_api.post_document_image_header(
+                Config.PDF_DOCUMENT_NAME, new_header
+            )
+            if response.code == 200:
+                logging.info(f"append_image_header(): Header '{new_header.file_name}' added to the document '{Config.PDF_DOCUMENT_NAME}'.")
+            else:
+                logging.error(f"append_image_header(): Failed to add header '{new_header.file_name}' to the document '{Config.PDF_DOCUMENT_NAME}'. Response code: {response.code}")
+        except Exception as e:
+            logging.error(f"append_image_header(): Error while adding header: {e}")
+
+    def append_image_heade_page(self):
+        """Append a new image header to the page on PDF document."""
+        if not self._ensure_api_initialized():
+            return
+
+        new_header = ImageHeader(
+            background = True,
+            horizontal_alignment = HorizontalAlignment.LEFT,
+            file_name = Config.IMAGE_HEADER_FILE,
+            width = 24,
+            height = 24
+        )
+
+        try:
+            response = self.pdf_api.post_document_image_header(
+                Config.PDF_DOCUMENT_NAME, new_header, start_page_number=Config.PAGE_NUMBER, end_page_number=Config.PAGE_NUMBER
+            )
+            if response.code == 200:
+                logging.info(f"append_image_heade_page(): Header '{new_header.file_name}' added to the page #{Config.PAGE_NUMBER}.")
+            else:
+                logging.error(f"append_image_heade_page(): Failed to add header '{new_header.file_name}' to the page #{Config.PAGE_NUMBER}. Response code: {response.code}")
+        except Exception as e:
+            logging.error(f"append_image_heade_page(): Error while adding header: {e}")
+
+
+if __name__ == "__main__":
+    pdf_header_footer = pdfHederFooter()
+    pdf_header_footer.upload_document()
+    pdf_header_footer.upload_file(Config.IMAGE_HEADER_FILE)
+    pdf_header_footer.append_image_header()
+    pdf_header_footer.append_image_heade_page()
+    pdf_header_footer.download_result()