From c3fc200c5dfe0f62bbcb791c5e1c5e6bd75b0962 Mon Sep 17 00:00:00 2001
From: Anthony Stirling <77850077+Frooodle@users.noreply.github.com>
Date: Tue, 24 Mar 2026 14:11:27 +0000
Subject: [PATCH] Remove images (#5966)

---
 .../api/misc/RemoveImagesController.java      | 137 ++++++++++++++++++
 1 file changed, 137 insertions(+)
 create mode 100644 app/core/src/main/java/stirling/software/SPDF/controller/api/misc/RemoveImagesController.java

diff --git a/app/core/src/main/java/stirling/software/SPDF/controller/api/misc/RemoveImagesController.java b/app/core/src/main/java/stirling/software/SPDF/controller/api/misc/RemoveImagesController.java
new file mode 100644
index 0000000000..715320daed
--- /dev/null
+++ b/app/core/src/main/java/stirling/software/SPDF/controller/api/misc/RemoveImagesController.java
@@ -0,0 +1,137 @@
+package stirling.software.SPDF.controller.api.misc;
+
+import java.io.ByteArrayOutputStream;
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.List;
+
+import org.apache.pdfbox.cos.COSDictionary;
+import org.apache.pdfbox.cos.COSName;
+import org.apache.pdfbox.pdmodel.PDDocument;
+import org.apache.pdfbox.pdmodel.PDPage;
+import org.apache.pdfbox.pdmodel.PDResources;
+import org.apache.pdfbox.pdmodel.graphics.PDXObject;
+import org.apache.pdfbox.pdmodel.graphics.form.PDFormXObject;
+import org.apache.pdfbox.pdmodel.graphics.image.PDImageXObject;
+import org.springframework.http.MediaType;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.ModelAttribute;
+import org.springframework.web.multipart.MultipartFile;
+
+import io.swagger.v3.oas.annotations.Operation;
+
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+
+import stirling.software.common.annotations.AutoJobPostMapping;
+import stirling.software.common.annotations.api.GeneralApi;
+import stirling.software.common.model.api.PDFFile;
+import stirling.software.common.service.CustomPDFDocumentFactory;
+import stirling.software.common.util.ExceptionUtils;
+import stirling.software.common.util.GeneralUtils;
+import stirling.software.common.util.WebResponseUtils;
+
+@GeneralApi
+@Slf4j
+@RequiredArgsConstructor
+public class RemoveImagesController {
+
+    private final CustomPDFDocumentFactory pdfDocumentFactory;
+
+    @AutoJobPostMapping(consumes = MediaType.MULTIPART_FORM_DATA_VALUE, value = "/remove-image-pdf")
+    @Operation(
+            summary = "Remove images from PDF",
+            description =
+                    "This endpoint removes all embedded images from a PDF file and returns the"
+                            + " modified document. Input:PDF Output:PDF Type:SISO")
+    public ResponseEntity<byte[]> removeImages(@ModelAttribute PDFFile request)
+            throws IOException {
+
+        MultipartFile inputFile = request.getFileInput();
+
+        try (PDDocument pdfDoc = pdfDocumentFactory.load(request)) {
+
+            int totalPages = pdfDoc.getNumberOfPages();
+            int imagesRemoved = 0;
+
+            for (int pageIndex = 0; pageIndex < totalPages; pageIndex++) {
+                PDPage currentPage = pdfDoc.getPage(pageIndex);
+                imagesRemoved += removeImagesFromPage(currentPage);
+            }
+
+            log.info("Removed {} images from PDF with {} pages", imagesRemoved, totalPages);
+
+            ByteArrayOutputStream baos = new ByteArrayOutputStream();
+            pdfDoc.save(baos);
+            byte[] pdfContent = baos.toByteArray();
+
+            return WebResponseUtils.bytesToWebResponse(
+                    pdfContent,
+                    GeneralUtils.generateFilename(
+                            inputFile.getOriginalFilename(), "_images_removed.pdf"));
+
+        } catch (IOException e) {
+            throw ExceptionUtils.handlePdfException(e, "during image removal");
+        }
+    }
+
+    private int removeImagesFromPage(PDPage page) throws IOException {
+        int imagesRemoved = 0;
+
+        PDResources resources = page.getResources();
+        if (resources == null) {
+            return imagesRemoved;
+        }
+
+        imagesRemoved += removeImagesFromResources(resources);
+        return imagesRemoved;
+    }
+
+    private int removeImagesFromFormXObject(PDFormXObject formXObject) throws IOException {
+        PDResources resources = formXObject.getResources();
+        if (resources == null) {
+            return 0;
+        }
+
+        return removeImagesFromResources(resources);
+    }
+
+    private int removeImagesFromResources(PDResources resources) throws IOException {
+        if (resources == null) {
+            return 0;
+        }
+
+        COSDictionary xObjects = resources.getCOSObject().getCOSDictionary(COSName.XOBJECT);
+        if (xObjects == null) {
+            return 0;
+        }
+
+        int imagesRemoved = 0;
+        // Create snapshot to safely iterate while removing
+        List<COSName> names = new ArrayList<>(xObjects.keySet());
+
+        for (COSName name : names) {
+            try {
+                PDXObject xObject = resources.getXObject(name);
+                if (xObject == null) {
+                    continue;
+                }
+
+                // Remove direct images
+                if (xObject instanceof PDImageXObject) {
+                    xObjects.removeItem(name);
+                    imagesRemoved++;
+                    log.debug("Removed image: {}", name.getName());
+                }
+                // Recursively process nested form XObjects
+                else if (xObject instanceof PDFormXObject form) {
+                    imagesRemoved += removeImagesFromResources(form.getResources());
+                }
+            } catch (IOException e) {
+                log.warn("Error processing XObject {}: {}", name.getName(), e.getMessage());
+            }
+        }
+
+        return imagesRemoved;
+    }
+}