Generate a PDF report using Swift for iOS

1
//
2
//  Copyright © 2018-2025 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
final class ReportPDFGenerationExample: Example {
12
    var statusHUDItem: StatusHUDItem?
13

14
    // MARK: Lifecycle
15

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

19
        title = "Generate a PDF Report"
20
        contentDescription = "Generate a PDF document on a mobile device without any server use."
21
        category = .documentGeneration
22
        priority = 1
23
    }
24

25
    override func invoke(with delegate: ExampleRunnerDelegate) -> UIViewController? {
26
        // Get base document
27
        let document = AssetLoader.document(for: .annualReport)
28
        guard let configuration = Processor.Configuration(document: document) else {
29
            fatalError("Processor configuration needs a valid document")
30
        }
31

32
        // Keep only the first and the last page of the original document.
33
        configuration.removePages(IndexSet(1..<Int(document.pageCount - 1)))
34

35
        // Add a newly created single-paged document as the second page of the report
36
        let pageInfo = document.pageInfoForPage(at: 0)!
37
        let secondPageDocument = self.generateSecondPage(pageInfo: pageInfo)
38
        let secondPageTemplate = PageTemplate(document: secondPageDocument, sourcePageIndex: 0)
39
        configuration.addNewPage(at: 1, configuration: PDFNewPageConfiguration(pageTemplate: secondPageTemplate, builderBlock: nil))
40

41
        // Add a new page with a pattern grid as the third page of the report.
42
        configuration.addNewPage(at: 2, configuration: PDFNewPageConfiguration(pageTemplate: PageTemplate(pageType: .tiledPatternPage, identifier: .grid5mm)) {
43
            $0.backgroundColor = .white
44
        })
45

46
        // Add a page from an existing document.
47
        let welcomeDocument = AssetLoader.document(for: .welcome)
48
        let welcomeTemplate = PageTemplate(document: welcomeDocument, sourcePageIndex: 7)
49
        configuration.addNewPage(at: 3, configuration: PDFNewPageConfiguration(pageTemplate: welcomeTemplate, builderBlock: nil))
50

51
        // Scale the recently added page to the first page size
52
        configuration.scalePage(3, to: pageInfo.size)
53

54
        // Draw "Generated for John Doe. Page X" on every page
55
        self.drawWatermark(name: "John Doe", configuration: configuration)
56

57
        // Flatten all annotations.
58
        configuration.modifyAnnotations(ofTypes: .all, change: .flatten)
59

60
        // Set owner password to only allow printing
61
        let ownerPassword = "test123"
62
        let documentSecurityOptions = try? Document.SecurityOptions(ownerPassword: ownerPassword, userPassword: nil, keyLength: Document.SecurityOptionsKeyLengthAutomatic, permissions: [.printing])
63
        let processedDocumentURL = FileHelper.temporaryPDFFileURL(prefix: "processed")
64

65
        statusHUDItem = StatusHUDItem.progress(withText: PSPDFKit.localizedString("Preparing") + ("…"))
66
        statusHUDItem?.push(animated: true, on: delegate.currentViewController?.view.window)
67

68
        DispatchQueue.global(qos: .default).async(execute: {() -> Void in
69
            // Process annotations.
70
            // `PSPDFProcessor` doesn't modify the document, but creates an output file instead.
71
            let processor = Processor(configuration: configuration, securityOptions: documentSecurityOptions)
72
            processor.delegate = self
73
            try! processor.write(toFileURL: processedDocumentURL)
74

75
            DispatchQueue.main.async(execute: { [weak self] () -> Void in
76
                guard let self else {
77
                    return
78
                }
79

80
                self.statusHUDItem?.pop(animated: true)
81
                self.statusHUDItem = nil
82
                // The newly processed Document.
83
                let processedDocument = Document(url: processedDocumentURL)
84
                processedDocument.title = "Generated PDF Report"
85
                let pdfController = PDFViewController(document: processedDocument)
86
                pdfController.navigationItem.rightBarButtonItems = [pdfController.annotationButtonItem, pdfController.searchButtonItem, pdfController.activityButtonItem]
87
                delegate.currentViewController?.navigationController?.pushViewController(pdfController, animated: true)
88
                self.presentSuccessAlert(viewController: pdfController)
89
            })
90
        })
91

92
        return nil
93
    }
94

95
    // MARK: Private
96
    private func generateSecondPage(pageInfo: PDFPageInfo) -> Document {
97
        // Create a separate single-paged document, which will be added as the second page of the report.
98
        let secondPageConfiguration = Processor.Configuration()
99
        let blankPageConfiguration = PDFNewPageConfiguration(pageTemplate: PageTemplate.blank) {
100
            $0.backgroundColor = UIColor.psc_systemBackground
101
            $0.pageSize = pageInfo.size
102
        }
103
        secondPageConfiguration.addNewPage(at: 0, configuration: blankPageConfiguration)
104

105
        // Invoke processor to create new document.
106
        let processor = Processor(configuration: secondPageConfiguration, securityOptions: nil)
107
        processor.delegate = self
108
        let data = try? processor.data()
109

110
        // Create the document which will be the report's second page
111
        let secondPageDocument = Document(dataProviders: [DataContainerProvider(data: data!)])
112

113
        // Create a free text annotation as the title of the second page.
114
        let titleFreeTextAnnotation = FreeTextAnnotation()
115
        titleFreeTextAnnotation.boundingBox = CGRect(x: 228, y: 924, width: 600, height: 80)
116
        titleFreeTextAnnotation.contents = "Some Annotations"
117
        titleFreeTextAnnotation.fontSize = 40
118

119
        // Create a vector stamp annotation on the second page.
120
        let logoURL = AssetLoader.assetURL(for: "PSPDFKit Logo.pdf")
121

122
        let vectorStamp = StampAnnotation()
123
        vectorStamp.boundingBox = CGRect(x: 50, y: 724, width: 200, height: 200)
124
        vectorStamp.appearanceStreamGenerator = FileAppearanceStreamGenerator(fileURL: logoURL)
125

126
        // Create a free text annotation which describes the vector stamp
127
        let vectorStampDescriptionFreeTextAnnotation = FreeTextAnnotation()
128
        vectorStampDescriptionFreeTextAnnotation.contents = "The logo above is a vector stamp annotation."
129
        vectorStampDescriptionFreeTextAnnotation.boundingBox = CGRect(x: 67, y: 620, width: 600, height: 80)
130
        vectorStampDescriptionFreeTextAnnotation.fontSize = 18
131

132
        // Create an image stamp annotation on the second page.
133
        let imageStamp = StampAnnotation()
134
        imageStamp.image = UIImage(named: "exampleimage.jpg")
135
        imageStamp.boundingBox = CGRect(x: 60, y: 400, width: (imageStamp.image?.size.width)! / 4, height: (imageStamp.image?.size.height)! / 4)
136

137
        // Create a free text annotation which describes the image stamp
138
        let imageStampDescriptionFreeTextAnnotation = FreeTextAnnotation()
139
        imageStampDescriptionFreeTextAnnotation.contents = "The image above is an image stamp annotation."
140
        imageStampDescriptionFreeTextAnnotation.boundingBox = CGRect(x: 67, y: 290, width: 600, height: 80)
141
        imageStampDescriptionFreeTextAnnotation.fontSize = 18
142

143
        // Add annotations to the newly processed document.
144
        secondPageDocument.add(annotations: [titleFreeTextAnnotation, vectorStamp, vectorStampDescriptionFreeTextAnnotation, imageStamp, imageStampDescriptionFreeTextAnnotation])
145

146
        guard let flattenedSecondPageConfiguration = Processor.Configuration(document: secondPageDocument) else {
147
            fatalError("Processor configuration needs a valid document")
148
        }
149

150
        // Flatten all annotations
151
        flattenedSecondPageConfiguration.modifyAnnotations(ofTypes: .all, change: .flatten)
152
        let flattenedSecondPageOutputFileURL = FileHelper.temporaryPDFFileURL(prefix: "flattened-second-page")
153
        let secondPageProcessor = Processor(configuration: flattenedSecondPageConfiguration, securityOptions: nil)
154
        secondPageProcessor.delegate = self
155
        try? secondPageProcessor.write(toFileURL: flattenedSecondPageOutputFileURL)
156

157
        return Document(url: flattenedSecondPageOutputFileURL)
158
    }
159

160
    private func drawWatermark(name: String, configuration: Processor.Configuration) {
161
        let renderDrawBlock: PDFRenderDrawBlock = { context, page, cropBox, _ in
162
            // Careful, this code is executed on background threads. Only use thread-safe drawing methods.
163
            let text = "Generated for \(name). Page \(page + 1)"
164
            let stringDrawingContext = NSStringDrawingContext()
165
            stringDrawingContext.minimumScaleFactor = 0.1
166

167
            let attributes: [NSAttributedString.Key: Any] = [
168
                .font: UIFont.boldSystemFont(ofSize: 30),
169
                .foregroundColor: UIColor.red.withAlphaComponent(0.5)
170
            ]
171
            // Add text in the bottom center
172
            context.translateBy(x: (cropBox.size.width / 2) - 230, y: cropBox.size.height - 100)
173
            text.draw(with: cropBox, options: .usesLineFragmentOrigin, attributes: attributes, context: stringDrawingContext)
174
        }
175
        // Draw at the bottom of all pages.
176
        configuration.drawOnAllCurrentPages(renderDrawBlock)
177
    }
178

179
    private func presentSuccessAlert(viewController: UIViewController) {
180
        let message = "1. Keep only the first and the last page of the original document.\n2. Add a newly created single-paged document as the second page of the report.\n3. Add a new page with a pattern grid as the third page of the report.\n4. Add a page from an existing document on disk.\n5. Draw watermark on every page.\n6. Flatten all annotations.\n7. Set owner password to only allow printing."
181
        let alert = UIAlertController(title: "Successful PDF Report Generation", message: message, preferredStyle: .alert)
182
        alert.addAction(UIAlertAction(title: "Dismiss", style: .default))
183
        viewController.present(alert, animated: true, completion: nil)
184
    }
185
}
186

187
extension ReportPDFGenerationExample: ProcessorDelegate {
188
    func processor(_ processor: Processor, didProcessPage currentPage: UInt, totalPages: UInt) {
189
        statusHUDItem?.progress = CGFloat((currentPage + 1) / totalPages)
190
        print("Progress: \(currentPage + 1) of \(totalPages)")
191
    }
192
}