Embed, flatten, or remove PDF annotations in Swift for iOS

1
//
2
//  Copyright © 2016-2026 PSPDFKit GmbH. All rights reserved.
3
//
4
//  The Nutrient sample applications are licensed with a modified BSD license.
5
//  Please see License for details. This notice may not be removed from this file.
6
//
7

8
import PSPDFKit
9
import PSPDFKitUI
10

11
/// Shows how to embed, flatten and remove annotations with `PSPDFProcessor`.
12
final class AnnotationProcessingExample: Example {
13

14
    // MARK: Lifecycle
15

16
    override init() {
17
        super.init()
18

19
        contentDescription = "Shows how to embed, flatten and remove annotations with PSPDFProcessor"
20
        category = .documentProcessing
21
        priority = 10
22
    }
23

24
    override func invoke(with delegate: ExampleRunnerDelegate) -> UIViewController {
25
        let document = AssetLoader.document(for: .welcome)
26
        return AnnotationProcessingPDFViewController(document: document)
27
    }
28
}
29

30
/// Processes annotations of it's document.
31
private final class AnnotationProcessingPDFViewController: PDFViewController {
32

33
    // MARK: Lifecycle
34

35
    override func commonInit(with document: Document?, configuration: PDFConfiguration) {
36
        super.commonInit(with: document, configuration: configuration)
37

38
        let actions = [("Embed", #selector(embedAnnotations)), ("Flatten", #selector(flattenAnnotations)), ("Remove", #selector(removeAnnotations))]
39
        let barButtonItems = actions.map { title, selector in
40
            UIBarButtonItem(title: title, style: .plain, target: self, action: selector)
41
        }
42
        navigationItem.setRightBarButtonItems(barButtonItems.reversed(), for: .document, animated: false)
43
    }
44

45
    // MARK: Bar Button Item Actions
46

47
    /// Presents document with annotations embedded.
48
    @objc
49
    private func embedAnnotations() {
50
        let embeddedDocumentURL = FileHelper.temporaryPDFFileURL(prefix: "embedded")
51

52
        // We want to embed annotations, i.e. keep them editable.
53
        guard processAnnotations(.embed, document: document!, newDocumentURL: embeddedDocumentURL) else {
54
            presentErrorMessage("Embedding annotations failed.")
55
            return
56
        }
57

58
        presentProcessedDocument(embeddedDocumentURL)
59
    }
60

61
    /// Presents document with annotations flattened.
62
    @objc
63
    private func flattenAnnotations() {
64
        let flattenedDocumentURL = FileHelper.temporaryPDFFileURL(prefix: "flattened")
65

66
        // We want to flatten annotations, i.e. make them non-editable.
67
        guard processAnnotations(.flatten, document: document!, newDocumentURL: flattenedDocumentURL) else {
68
            presentErrorMessage("Flattening annotations failed.")
69
            return
70
        }
71

72
        presentProcessedDocument(flattenedDocumentURL)
73
    }
74

75
    /// Presents document with annotations removed.
76
    @objc
77
    private func removeAnnotations() {
78
        let removedAnnotationsDocumentURL = FileHelper.temporaryPDFFileURL(prefix: "removedAnnotations")
79

80
        // We want to remove annotations.
81
        guard processAnnotations(.remove, document: document!, newDocumentURL: removedAnnotationsDocumentURL) else {
82
            presentErrorMessage("Removing annotations failed.")
83
            return
84
        }
85

86
        presentProcessedDocument(removedAnnotationsDocumentURL)
87
    }
88

89
    // MARK: Document Processing
90

91
    /// Processes annotations.
92
    ///
93
    /// - Parameters:
94
    ///     - annotationChange: Which `PSPDFAnnotationChange` to perform.
95
    ///     - document: `Document` containing pages with annotations.
96
    ///     - newDocumentURL: `URL` that's used as output file URL of `PSPDFProcessor`.
97
    /// - Returns: `true` iff processing succeeded, `false` otherwise.
98
    private func processAnnotations(_ annotationChange: AnnotationChange, document: Document, newDocumentURL: URL) -> Bool {
99
        // Set up configuration to flatten the document.
100
        guard let configuration = Processor.Configuration(document: document) else {
101
            print("Processor configuration needs a valid document")
102
            return false
103
        }
104

105
        // Process all types of annotations.
106
        configuration.modifyAnnotations(ofTypes: .all, change: annotationChange)
107

108
        // We are only interested in the pages that actually have annotations.
109
        configuration.includeOnlyIndexes(pagesWithAnnotations(document))
110

111
        do {
112
            // Process annotations.
113
            // `PSPDFProcessor` doesn't modify the document, but creates an output file instead.
114
            let processor = Processor(configuration: configuration, securityOptions: nil)
115
            processor.delegate = self
116
            try processor.write(toFileURL: newDocumentURL)
117
        } catch {
118
            print("Error while processing document: \(error)")
119
            return false
120
        }
121

122
        return true
123
    }
124

125
    // MARK: Helper
126

127
    /// Filters pages with annotations.
128
    ///
129
    /// - Parameter document: `Document` containing pages to filter.
130
    /// - Returns: `NSIndexSet` of pages with annotations.
131
    private func pagesWithAnnotations(_ document: Document) -> IndexSet {
132
        let pagesWithAnnotations = NSMutableIndexSet()
133
        let allTypesButLinkAndForms = Annotation.Kind.all.subtracting([.link, .widget])
134

135
        for page in 0..<document.pageCount {
136
            if document.annotationsForPage(at: page, type: allTypesButLinkAndForms).isEmpty { continue }
137
            pagesWithAnnotations.add(Int(page))
138
        }
139

140
        return pagesWithAnnotations as IndexSet
141
    }
142

143
    /// Presents a processed document.
144
    ///
145
    /// - Parameter processedDocumentURL: `URL` of processed document.
146
    private func presentProcessedDocument(_ processedDocumentURL: URL) {
147
        let processedDocument = Document(url: processedDocumentURL)
148
        let pdfController = PDFViewController(document: processedDocument)
149
        pdfController.navigationItem.setRightBarButtonItems([], for: .document, animated: false)
150
        let navigationController = UINavigationController(rootViewController: pdfController)
151
        present(navigationController, animated: true, completion: nil)
152
    }
153

154
    /// Presents an error message.
155
    ///
156
    /// - Parameter message: Error message to present.
157
    private func presentErrorMessage(_ message: String) {
158
        let alert = UIAlertController(title: "Error", message: message, preferredStyle: .alert)
159
        alert.addAction(UIAlertAction(title: "Dismiss", style: .default))
160
        self.present(alert, animated: true, completion: nil)
161
    }
162
}
163

164
extension AnnotationProcessingPDFViewController: ProcessorDelegate {
165
    nonisolated func processor(_ processor: Processor, didProcessPage currentPage: UInt, totalPages: UInt) {
166
        print("Progress: \(currentPage + 1) of \(totalPages)")
167
    }
168
}