[WIP] Add scrub

examples/tests/src/scrub.test.ts

@@ -0,0 +1,115 @@
+import { afterEach, describe, expect, it } from "vitest";
+import { PDFDocument } from "../../../dist/mupdfjs";
+
+describe("PDFDocument scrub test", () => {
+	it("should clean metadata from a new document", () => {
+		// Create a new document
+		const doc = PDFDocument.createBlankDocument();
+
+		try {
+			// Set and verify Title
+			doc.setMetaData("info:Title", "Test Document");
+			doc.setMetaData("info:Author", "Test Author");
+			doc.setMetaData("info:Subject", "Test Subject");
+			doc.setMetaData("info:Keywords", "test, pdf");
+			doc.setMetaData("info:Creator", "Test Creator");
+			doc.setMetaData("info:Producer", "Test Producer");
+			doc.setMetaData("info:CreationDate", "D:20240101000000Z");
+			doc.setMetaData("info:ModDate", "D:20240101120000Z");
+
+			expect(doc.getMetaData("info:Title")).toBe("Test Document");
+			expect(doc.getMetaData("info:Author")).toBe("Test Author");
+			expect(doc.getMetaData("info:Subject")).toBe("Test Subject");
+			expect(doc.getMetaData("info:Keywords")).toBe("test, pdf");
+			expect(doc.getMetaData("info:Creator")).toBe("Test Creator");
+			expect(doc.getMetaData("info:Producer")).toBe("Test Producer");
+			expect(doc.getMetaData("info:CreationDate")).toBe("D:20240101000000Z");
+			expect(doc.getMetaData("info:ModDate")).toBe("D:20240101120000Z");
+
+			// Scrub metadata
+			doc.scrub({ metadata: true });
+
+			// Verify all metadata is cleaned after scrub
+			expect(doc.getMetaData("info:Title")).toBeUndefined();
+			expect(doc.getMetaData("info:Author")).toBeUndefined();
+			expect(doc.getMetaData("info:Subject")).toBeUndefined();
+			expect(doc.getMetaData("info:Keywords")).toBeUndefined();
+			expect(doc.getMetaData("info:Creator")).toBeUndefined();
+			expect(doc.getMetaData("info:Producer")).toBeUndefined();
+			expect(doc.getMetaData("info:CreationDate")).toBeUndefined();
+			expect(doc.getMetaData("info:ModDate")).toBeUndefined();
+		} finally {
+			doc.destroy();
+		}
+	});
+
+	it("should remove all links from pages", () => {
+		// Create a new document
+		const doc = PDFDocument.createBlankDocument();
+
+		try {
+			// Add a link to the first page
+			const page = doc.loadPage(0);
+			page.createLink([50, 50, 150, 100], "https://example.com");
+
+			// Verify link exists
+			const linksBeforeScrub = page.getLinks();
+			expect(linksBeforeScrub.length).toBe(1);
+			expect(linksBeforeScrub[0].getURI()).toBe("https://example.com");
+
+			// Scrub links
+			doc.scrub({ removeLinks: true });
+
+			// Verify links are removed
+			const linksAfterScrub = page.getLinks();
+			expect(linksAfterScrub.length).toBe(0);
+		} finally {
+			doc.destroy();
+		}
+	});
+
+	it("should remove file attachment annotations", () => {
+		// Create a new document
+		const doc = PDFDocument.createBlankDocument();
+
+		try {
+			// Add a file attachment annotation to the first page
+			const page = doc.loadPage(0);
+			const annot = page.createAnnotation("FileAttachment");
+			annot.setRect([50, 50, 100, 100]);
+			annot.setContents("Test attachment");
+			annot.update();
+
+			// Verify file attachment exists
+			const annotationsBeforeScrub = page.getAnnotations();
+			const fileAttachment = annotationsBeforeScrub.find(a => a.getType() === "FileAttachment");
+			expect(fileAttachment).toBeDefined();
+
+			// Scrub file attachments
+			doc.scrub({ attachedFiles: true });
+
+			// Verify file attachment exists but content is empty
+			const annotationsAfterScrub = page.getAnnotations();
+			const scrubbedAttachment = annotationsAfterScrub.find(a => a.getType() === "FileAttachment");
+			expect(scrubbedAttachment).toBeDefined();
+			expect(annotationsAfterScrub.length).toBe(annotationsBeforeScrub.length);
+
+			// Verify file content is empty
+			const fileSpec = scrubbedAttachment!.getFileSpec();
+			expect(fileSpec).toBeDefined();
+
+			// Get embedded file stream
+			const ef = fileSpec.get("EF");
+			expect(ef.isDictionary()).toBe(true);
+
+			// Verify stream content is empty
+			const stream = ef.get("F");
+			expect(stream.isStream()).toBe(true);
+			const content = stream.readStream();
+			expect(content.getLength()).toBe(1);
+			expect(content.readByte(0)).toBe(32); // space character
+		} finally {
+			doc.destroy();
+		}
+	});
+});

src/mupdfjs.ts

@@ -560,8 +560,16 @@ export class PDFDocument extends mupdf.PDFDocument {
 
         // Metadata cleaning
         if (metadata) {
-            // TODO: Implement metadata cleaning
-        }
+			// Clear all standard PDF metadata fields
+			this.setMetaData("info:Title", "");
+			this.setMetaData("info:Author", "");
+			this.setMetaData("info:Subject", "");
+			this.setMetaData("info:Keywords", "");
+			this.setMetaData("info:Creator", "");
+			this.setMetaData("info:Producer", "");
+			this.setMetaData("info:CreationDate", "");
+			this.setMetaData("info:ModDate", "");
+		}
 
         // Process each page
         const pageCount = this.countPages();
@@ -570,12 +578,31 @@ export class PDFDocument extends mupdf.PDFDocument {
 
             // Remove links
             if (removeLinks) {
-                // TODO: Implement link removal
+                const page = this.loadPage(i);
+                const links = page.getLinks();
+                for (const link of links) {
+                    page.deleteLink(link);
+                }
             }
 
             // Handle attached files
             if (attachedFiles) {
-                // TODO: Implement attached files handling
+                const page = this.loadPage(i);
+                const annotations = page.getAnnotations();
+                for (const annot of annotations) {
+                    if (annot.getType() === "FileAttachment") {
+                        // Empty the file content but keep the annotation
+                        const emptyBuffer = new Buffer(" ");
+                        const emptyFileSpec = this.addEmbeddedFile(
+                            "empty",
+                            "application/octet-stream",
+                            emptyBuffer,
+                            new Date(),
+                            new Date()
+                        );
+                        annot.setFileSpec(emptyFileSpec);
+                    }
+                }
             }
 
             // Clean pages
@@ -1042,4 +1069,4 @@ interface PageLabelRule {
     prefix?: string;
     style?: string;
     firstpagenum?: number;
-}
+}