From c281dbb4bb8f2671e026c064a270df647ffd2d5f Mon Sep 17 00:00:00 2001 From: Dario Ghunney Ware Date: Thu, 12 Jun 2025 18:16:45 +0100 Subject: [PATCH] fixing routing to page --- .../SPDF/config/EndpointConfiguration.java | 2 + .../api/misc/AttachmentsController.java | 94 ++++++--------- .../controller/web/OtherWebController.java | 4 +- .../SPDF/service/PDFAttachmentService.java | 108 ++++++++++++++++++ .../PDFAttachmentServiceInterface.java | 17 +++ .../main/resources/messages_en_GB.properties | 14 +++ .../main/resources/messages_en_US.properties | 3 +- .../templates/fragments/navElements.html | 5 +- .../main/resources/templates/home-legacy.html | 3 + .../templates/misc/add-attachments.html | 42 +++++++ testing/allEndpointsRemovedSettings.yml | 2 +- testing/endpoints.txt | 1 + testing/webpage_urls.txt | 1 + 13 files changed, 228 insertions(+), 68 deletions(-) create mode 100644 stirling-pdf/src/main/java/stirling/software/SPDF/service/PDFAttachmentService.java create mode 100644 stirling-pdf/src/main/java/stirling/software/SPDF/service/PDFAttachmentServiceInterface.java create mode 100644 stirling-pdf/src/main/resources/templates/misc/add-attachments.html diff --git a/stirling-pdf/src/main/java/stirling/software/SPDF/config/EndpointConfiguration.java b/stirling-pdf/src/main/java/stirling/software/SPDF/config/EndpointConfiguration.java index c9872992a..a43db93a8 100644 --- a/stirling-pdf/src/main/java/stirling/software/SPDF/config/EndpointConfiguration.java +++ b/stirling-pdf/src/main/java/stirling/software/SPDF/config/EndpointConfiguration.java @@ -173,6 +173,7 @@ public class EndpointConfiguration { addEndpointToGroup("Other", "get-info-on-pdf"); addEndpointToGroup("Other", "show-javascript"); addEndpointToGroup("Other", "remove-image-pdf"); + addEndpointToGroup("Other", "add-attachments"); // CLI addEndpointToGroup("CLI", "compress-pdf"); @@ -251,6 +252,7 @@ public class EndpointConfiguration { addEndpointToGroup("Java", "pdf-to-text"); addEndpointToGroup("Java", "remove-image-pdf"); addEndpointToGroup("Java", "pdf-to-markdown"); + addEndpointToGroup("Java", "add-attachments"); // Javascript addEndpointToGroup("Javascript", "pdf-organizer"); diff --git a/stirling-pdf/src/main/java/stirling/software/SPDF/controller/api/misc/AttachmentsController.java b/stirling-pdf/src/main/java/stirling/software/SPDF/controller/api/misc/AttachmentsController.java index 90a176df4..d709b0000 100644 --- a/stirling-pdf/src/main/java/stirling/software/SPDF/controller/api/misc/AttachmentsController.java +++ b/stirling-pdf/src/main/java/stirling/software/SPDF/controller/api/misc/AttachmentsController.java @@ -1,15 +1,9 @@ package stirling.software.SPDF.controller.api.misc; -import java.io.ByteArrayInputStream; import java.io.IOException; import java.util.List; -import org.apache.pdfbox.pdmodel.PDDocument; -import org.apache.pdfbox.pdmodel.PDDocumentCatalog; -import org.apache.pdfbox.pdmodel.PDEmbeddedFilesNameTreeNode; -import org.apache.pdfbox.pdmodel.PageMode; -import org.apache.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification; -import org.apache.pdfbox.pdmodel.common.filespecification.PDEmbeddedFile; +import org.apache.pdfbox.pdmodel.*; import org.springframework.http.ResponseEntity; import org.springframework.web.bind.annotation.*; import org.springframework.web.multipart.MultipartFile; @@ -21,71 +15,75 @@ import io.swagger.v3.oas.annotations.tags.Tag; import lombok.RequiredArgsConstructor; import lombok.extern.slf4j.Slf4j; +import stirling.software.SPDF.service.PDFAttachmentServiceInterface; import stirling.software.common.service.CustomPDFDocumentFactory; import stirling.software.common.util.WebResponseUtils; +@Slf4j @RestController @RequiredArgsConstructor @RequestMapping("/api/v1/misc") @Tag(name = "Misc", description = "Miscellaneous APIs") -@Slf4j public class AttachmentsController { private final CustomPDFDocumentFactory pdfDocumentFactory; + private final PDFAttachmentServiceInterface pdfAttachmentService; + + @SuppressWarnings("DataFlowIssue") @PostMapping(consumes = "multipart/form-data", value = "/add-attachments") @Operation( summary = "Add attachments to PDF", - description = "This endpoint adds embedded files (attachments) to a PDF and sets the PageMode to UseAttachments to make them visible. Input:PDF + Files Output:PDF Type:MISO") + description = + "This endpoint adds embedded files (attachments) to a PDF and sets the PageMode to UseAttachments to make them visible. Input:PDF + Files Output:PDF Type:MISO") public ResponseEntity addAttachments( @RequestParam("fileInput") MultipartFile pdfFile, @RequestParam("attachments") List attachments) throws IOException { // Load the PDF document - PDDocument document = pdfDocumentFactory.load(pdfFile, true); - + PDDocument document = pdfDocumentFactory.load(pdfFile, false); + // Get or create the document catalog PDDocumentCatalog catalog = document.getDocumentCatalog(); - + // Create embedded files name tree if it doesn't exist - PDEmbeddedFilesNameTreeNode efTree = catalog.getNames().getEmbeddedFiles(); - if (efTree == null) { - efTree = new PDEmbeddedFilesNameTreeNode(); - catalog.getNames().setEmbeddedFiles(efTree); + PDDocumentNameDictionary documentNames = catalog.getNames(); + PDEmbeddedFilesNameTreeNode embeddedFilesTree = new PDEmbeddedFilesNameTreeNode(); + + if (documentNames != null) { + embeddedFilesTree = documentNames.getEmbeddedFiles(); + } else { + documentNames = new PDDocumentNameDictionary(catalog); + documentNames.setEmbeddedFiles(embeddedFilesTree); } - // Add each attachment - for (MultipartFile attachment : attachments) { - if (attachment != null && !attachment.isEmpty()) { - addEmbeddedFile(document, efTree, attachment); - } - } + // Add attachments + catalog.setNames(documentNames); + pdfAttachmentService.addAttachment(document, embeddedFilesTree, attachments); // Set PageMode to UseAttachments to show the attachments panel catalog.setPageMode(PageMode.USE_ATTACHMENTS); - // Return the modified PDF return WebResponseUtils.pdfDocToWebResponse( document, Filenames.toSimpleFileName(pdfFile.getOriginalFilename()) - .replaceFirst("[.][^.]+$", "") + "_with_attachments.pdf"); + .replaceFirst("[.][^.]+$", "") + + "_with_attachments.pdf"); } @PostMapping(consumes = "multipart/form-data", value = "/remove-attachments") @Operation( summary = "Remove attachments from PDF", - description = "This endpoint removes all embedded files (attachments) from a PDF. Input:PDF Output:PDF Type:SISO") + description = + "This endpoint removes all embedded files (attachments) from a PDF. Input:PDF Output:PDF Type:SISO") public ResponseEntity removeAttachments( - @RequestParam("fileInput") MultipartFile pdfFile) - throws IOException { + @RequestParam("fileInput") MultipartFile pdfFile) throws IOException { - // Load the PDF document - PDDocument document = pdfDocumentFactory.load(pdfFile, true); - - // Get the document catalog + // Load the PDF document and document catalog + PDDocument document = pdfDocumentFactory.load(pdfFile); PDDocumentCatalog catalog = document.getDocumentCatalog(); - + // Remove embedded files if (catalog.getNames() != null) { catalog.getNames().setEmbeddedFiles(null); @@ -98,35 +96,7 @@ public class AttachmentsController { return WebResponseUtils.pdfDocToWebResponse( document, Filenames.toSimpleFileName(pdfFile.getOriginalFilename()) - .replaceFirst("[.][^.]+$", "") + "_attachments_removed.pdf"); - } - - private void addEmbeddedFile(PDDocument document, PDEmbeddedFilesNameTreeNode efTree, MultipartFile file) - throws IOException { - - // Create file specification - PDComplexFileSpecification fs = new PDComplexFileSpecification(); - fs.setFile(file.getOriginalFilename()); - fs.setFileDescription("Embedded file: " + file.getOriginalFilename()); - - // Create embedded file - PDEmbeddedFile ef = new PDEmbeddedFile(document, new ByteArrayInputStream(file.getBytes())); - ef.setSize((int) file.getSize()); - ef.setCreationDate(new java.util.GregorianCalendar()); - ef.setModDate(new java.util.GregorianCalendar()); - - // Set MIME type if available - String contentType = file.getContentType(); - if (contentType != null && !contentType.isEmpty()) { - ef.setSubtype(contentType); - } - - // Associate embedded file with file specification - fs.setEmbeddedFile(ef); - - // Add to the name tree - efTree.setNames(java.util.Collections.singletonMap(file.getOriginalFilename(), fs)); - - log.info("Added embedded file: {} ({} bytes)", file.getOriginalFilename(), file.getSize()); + .replaceFirst("[.][^.]+$", "") + + "_attachments_removed.pdf"); } } diff --git a/stirling-pdf/src/main/java/stirling/software/SPDF/controller/web/OtherWebController.java b/stirling-pdf/src/main/java/stirling/software/SPDF/controller/web/OtherWebController.java index 59c317581..84b656e40 100644 --- a/stirling-pdf/src/main/java/stirling/software/SPDF/controller/web/OtherWebController.java +++ b/stirling-pdf/src/main/java/stirling/software/SPDF/controller/web/OtherWebController.java @@ -192,10 +192,10 @@ public class OtherWebController { return "misc/auto-rename"; } - @GetMapping("/attachments") + @GetMapping("/add-attachments") @Hidden public String attachmentsForm(Model model) { model.addAttribute("currentPage", "attachments"); - return "misc/attachments"; + return "misc/add-attachments"; } } diff --git a/stirling-pdf/src/main/java/stirling/software/SPDF/service/PDFAttachmentService.java b/stirling-pdf/src/main/java/stirling/software/SPDF/service/PDFAttachmentService.java new file mode 100644 index 000000000..a5a3f2a4a --- /dev/null +++ b/stirling-pdf/src/main/java/stirling/software/SPDF/service/PDFAttachmentService.java @@ -0,0 +1,108 @@ +package stirling.software.SPDF.service; + +import java.io.IOException; +import java.util.List; +import java.util.Map; + +import org.apache.commons.lang3.StringUtils; +import org.apache.pdfbox.pdmodel.PDDocument; +import org.apache.pdfbox.pdmodel.PDEmbeddedFilesNameTreeNode; +import org.apache.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification; +import org.apache.pdfbox.pdmodel.common.filespecification.PDEmbeddedFile; +import org.apache.pdfbox.pdmodel.encryption.AccessPermission; +import org.springframework.stereotype.Service; +import org.springframework.web.multipart.MultipartFile; + +import lombok.extern.slf4j.Slf4j; + +@Slf4j +@Service +public class PDFAttachmentService implements PDFAttachmentServiceInterface { + + @Override + public void addAttachment( + PDDocument document, + PDEmbeddedFilesNameTreeNode embeddedFilesTree, + List attachments) + throws IOException { + Map existingNames; + + try { + existingNames = embeddedFilesTree.getNames(); + if (existingNames == null) { + log.debug("No existing embedded files found, creating new names map."); + existingNames = new java.util.HashMap<>(); + } + + log.debug("Embedded files: {}", existingNames.keySet()); + } catch (IOException e) { + log.error("Could not retrieve existing embedded files", e); + throw e; + } + + final Map existingEmbeddedFiles = existingNames; + attachments.forEach( + attachment -> { + // Create attachments specification + PDComplexFileSpecification fileSpecification = new PDComplexFileSpecification(); + fileSpecification.setFile(attachment.getOriginalFilename()); + fileSpecification.setFileUnicode(attachment.getOriginalFilename()); + fileSpecification.setFileDescription( + "Embedded attachment: " + attachment.getOriginalFilename()); + + try { + // Create embedded attachment + PDEmbeddedFile embeddedFile = + new PDEmbeddedFile(document, attachment.getInputStream()); + embeddedFile.setSize((int) attachment.getSize()); + embeddedFile.setCreationDate(new java.util.GregorianCalendar()); + embeddedFile.setFile(fileSpecification); + embeddedFile.setModDate(new java.util.GregorianCalendar()); + + // Set MIME type if available + String contentType = attachment.getContentType(); + if (StringUtils.isNotBlank(contentType)) { + embeddedFile.setSubtype(contentType); + } + + // Associate embedded attachment with file specification + fileSpecification.setEmbeddedFile(embeddedFile); + fileSpecification.setEmbeddedFileUnicode(embeddedFile); + + // Add to the existing names map + existingEmbeddedFiles.put( + attachment.getOriginalFilename(), fileSpecification); + + log.info( + "Added attachment: {} ({} bytes)", + attachment.getOriginalFilename(), + attachment.getSize()); + } catch (IOException e) { + log.warn( + "Failed to create embedded file for attachment: {}", + attachment.getOriginalFilename(), + e); + } + }); + + embeddedFilesTree.setNames(existingNames); + + // Ensure document has proper access permissions for embedded files + grantAccessPermissions(document); + } + + private void grantAccessPermissions(PDDocument document) { + AccessPermission currentPermissions = document.getCurrentAccessPermission(); + + currentPermissions.setCanAssembleDocument(true); + currentPermissions.setCanFillInForm(currentPermissions.canFillInForm()); + currentPermissions.setCanModify(true); + currentPermissions.setCanPrint(true); + currentPermissions.setCanPrintFaithful(true); + + // Ensure these permissions are enabled for embedded file access + currentPermissions.setCanExtractContent(true); + currentPermissions.setCanExtractForAccessibility(true); + currentPermissions.setCanModifyAnnotations(true); + } +} diff --git a/stirling-pdf/src/main/java/stirling/software/SPDF/service/PDFAttachmentServiceInterface.java b/stirling-pdf/src/main/java/stirling/software/SPDF/service/PDFAttachmentServiceInterface.java new file mode 100644 index 000000000..90ae33013 --- /dev/null +++ b/stirling-pdf/src/main/java/stirling/software/SPDF/service/PDFAttachmentServiceInterface.java @@ -0,0 +1,17 @@ +package stirling.software.SPDF.service; + +import java.io.IOException; +import java.util.List; + +import org.apache.pdfbox.pdmodel.PDDocument; +import org.apache.pdfbox.pdmodel.PDEmbeddedFilesNameTreeNode; +import org.springframework.web.multipart.MultipartFile; + +public interface PDFAttachmentServiceInterface { + + void addAttachment( + PDDocument document, + PDEmbeddedFilesNameTreeNode efTree, + List attachments) + throws IOException; +} diff --git a/stirling-pdf/src/main/resources/messages_en_GB.properties b/stirling-pdf/src/main/resources/messages_en_GB.properties index 7dc6cb571..102ea6381 100644 --- a/stirling-pdf/src/main/resources/messages_en_GB.properties +++ b/stirling-pdf/src/main/resources/messages_en_GB.properties @@ -513,6 +513,10 @@ home.addImage.title=Add image home.addImage.desc=Adds a image onto a set location on the PDF addImage.tags=img,jpg,picture,photo +home.attachments.title=Attachments +home.attachments.desc=Add or remove embedded files (attachments) to/from a PDF +attachments.tags=embed,attach,file,attachment,attachments + home.watermark.title=Add Watermark home.watermark.desc=Add a custom watermark to your PDF document. watermark.tags=Text,repeating,label,own,copyright,trademark,img,jpg,picture,photo @@ -1193,6 +1197,16 @@ addImage.everyPage=Every Page? addImage.upload=Add image addImage.submit=Add image +#attachments +attachments.title=Attachments +attachments.header=Add attachments to PDF +attachments.removeHeader=Remove attachments from PDF +attachments.selectFiles=Select files to attach +attachments.description=Allows you to add attachments to the PDF +attachments.descriptionPlaceholder=Enter a description for the attachments... +attachments.addButton=Add Attachments +attachments.removeDescription=This will remove all embedded files from the PDF. +attachments.removeButton=Remove All Attachments #merge merge.title=Merge diff --git a/stirling-pdf/src/main/resources/messages_en_US.properties b/stirling-pdf/src/main/resources/messages_en_US.properties index fb814f8e1..9506ff80b 100644 --- a/stirling-pdf/src/main/resources/messages_en_US.properties +++ b/stirling-pdf/src/main/resources/messages_en_US.properties @@ -474,7 +474,7 @@ addImage.tags=img,jpg,picture,photo home.attachments.title=Attachments home.attachments.desc=Add or remove embedded files (attachments) to/from a PDF -attachments.tags=embed,attach,file,attachment +attachments.tags=embed,attach,file,attachment,attachments home.watermark.title=Add Watermark home.watermark.desc=Add a custom watermark to your PDF document. @@ -484,7 +484,6 @@ home.permissions.title=Change Permissions home.permissions.desc=Change the permissions of your PDF document permissions.tags=read,write,edit,print - home.removePages.title=Remove home.removePages.desc=Delete unwanted pages from your PDF document. removePages.tags=Remove pages,delete pages diff --git a/stirling-pdf/src/main/resources/templates/fragments/navElements.html b/stirling-pdf/src/main/resources/templates/fragments/navElements.html index cd7fae74b..38dfa0ac6 100644 --- a/stirling-pdf/src/main/resources/templates/fragments/navElements.html +++ b/stirling-pdf/src/main/resources/templates/fragments/navElements.html @@ -236,7 +236,10 @@
-
+ +
+
diff --git a/stirling-pdf/src/main/resources/templates/home-legacy.html b/stirling-pdf/src/main/resources/templates/home-legacy.html index d60ac220e..9531a359b 100644 --- a/stirling-pdf/src/main/resources/templates/home-legacy.html +++ b/stirling-pdf/src/main/resources/templates/home-legacy.html @@ -290,6 +290,9 @@
+
+
diff --git a/stirling-pdf/src/main/resources/templates/misc/add-attachments.html b/stirling-pdf/src/main/resources/templates/misc/add-attachments.html new file mode 100644 index 000000000..60bb16c96 --- /dev/null +++ b/stirling-pdf/src/main/resources/templates/misc/add-attachments.html @@ -0,0 +1,42 @@ + + + + + + + + +
+
+ +

+
+
+
+
+ attachment + +
+ +
+ +
+
+ + +
+
+ + + +
+
+
+
+
+ +
+ + + \ No newline at end of file diff --git a/testing/allEndpointsRemovedSettings.yml b/testing/allEndpointsRemovedSettings.yml index 3290d6fef..8230b4418 100644 --- a/testing/allEndpointsRemovedSettings.yml +++ b/testing/allEndpointsRemovedSettings.yml @@ -128,7 +128,7 @@ ui: languages: [] # If empty, all languages are enabled. To display only German and Polish ["de_DE", "pl_PL"]. British English is always enabled. endpoints: # All the possible endpoints are disabled - toRemove: [crop, merge-pdfs, multi-page-layout, overlay-pdfs, pdf-to-single-page, rearrange-pages, remove-image-pdf, remove-pages, rotate-pdf, scale-pages, split-by-size-or-count, split-pages, split-pdf-by-chapters, split-pdf-by-sections, add-password, add-watermark, auto-redact, cert-sign, get-info-on-pdf, redact, remove-cert-sign, remove-password, sanitize-pdf, validate-signature, file-to-pdf, html-to-pdf, img-to-pdf, markdown-to-pdf, pdf-to-csv, pdf-to-html, pdf-to-img, pdf-to-markdown, pdf-to-pdfa, pdf-to-presentation, pdf-to-text, pdf-to-word, pdf-to-xml, url-to-pdf, add-image, add-page-numbers, add-stamp, auto-rename, auto-split-pdf, compress-pdf, decompress-pdf, extract-image-scans, extract-images, flatten, ocr-pdf, remove-blanks, repair, replace-invert-pdf, show-javascript, update-metadata, filter-contains-image, filter-contains-text, filter-file-size, filter-page-count, filter-page-rotation, filter-page-size] # list endpoints to disable (e.g. ['img-to-pdf', 'remove-pages']) + toRemove: [crop, merge-pdfs, multi-page-layout, overlay-pdfs, pdf-to-single-page, rearrange-pages, remove-image-pdf, remove-pages, rotate-pdf, scale-pages, split-by-size-or-count, split-pages, split-pdf-by-chapters, split-pdf-by-sections, add-password, add-watermark, auto-redact, cert-sign, get-info-on-pdf, redact, remove-cert-sign, remove-password, sanitize-pdf, validate-signature, file-to-pdf, html-to-pdf, img-to-pdf, markdown-to-pdf, pdf-to-csv, pdf-to-html, pdf-to-img, pdf-to-markdown, pdf-to-pdfa, pdf-to-presentation, pdf-to-text, pdf-to-word, pdf-to-xml, url-to-pdf, add-image, add-page-numbers, add-stamp, auto-rename, auto-split-pdf, compress-pdf, decompress-pdf, extract-image-scans, extract-images, flatten, ocr-pdf, remove-blanks, repair, replace-invert-pdf, show-javascript, update-metadata, filter-contains-image, filter-contains-text, filter-file-size, filter-page-count, filter-page-rotation, filter-page-size, add-attachments] # list endpoints to disable (e.g. ['img-to-pdf', 'remove-pages']) groupsToRemove: [] # list groups to disable (e.g. ['LibreOffice']) metrics: diff --git a/testing/endpoints.txt b/testing/endpoints.txt index 5468ad6c1..149e3af3a 100644 --- a/testing/endpoints.txt +++ b/testing/endpoints.txt @@ -30,6 +30,7 @@ /api/v1/misc/add-stamp /api/v1/misc/add-page-numbers /api/v1/misc/add-image +/api/v1/misc/add-attachments /api/v1/convert/url/pdf /api/v1/convert/pdf/xml /api/v1/convert/pdf/word diff --git a/testing/webpage_urls.txt b/testing/webpage_urls.txt index 8ccaaf0b1..c6c713dd0 100644 --- a/testing/webpage_urls.txt +++ b/testing/webpage_urls.txt @@ -51,3 +51,4 @@ /swagger-ui/index.html /licenses /releases +/add-attachments