Store PDF Annotations for Multiple Users in Swift for iOS

1
//
2
//  Copyright © 2020-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
class MultipleUsersExample: Example {
12

13
    override init() {
14
        super.init()
15

16
        title = "Store annotations in JSON files for multiple users"
17
        contentDescription = "Shows how to store annotations in JSON files for multiple users"
18
        category = .subclassing
19
        priority = 50
20
    }
21

22
    override func invoke(with delegate: ExampleRunnerDelegate) -> UIViewController {
23
        let document = AssetLoader.document(for: .annualReport)
24
        let controller = MultipleUsersPDFViewController(document: document)
25
        return controller
26
    }
27
}
28

29
private class MultipleUsersPDFViewController: PDFViewController {
30

31
    private func withFirstProvider<T>(of document: Document, perform: (PDFDocumentProvider) -> T ) -> T {
32
        return perform(document.documentProviders.first!)
33
    }
34

35
    private(set) var currentUsername: String = "" {
36
        didSet {
37
            guard oldValue != currentUsername else { return }
38

39
            let document = self.document!
40

41
            // Forward to the document
42
            document.defaultAnnotationUsername = currentUsername
43

44
            guard let documentsUrl = FileManager.default.urls(for: .documentDirectory, in: .userDomainMask).first else { return }
45

46
            let oldInstantJSONFile = documentsUrl.appendingPathComponent("\(oldValue).json", isDirectory: false)
47
            let currentInstantJSONFile = documentsUrl.appendingPathComponent("\(currentUsername).json", isDirectory: false)
48

49
            // Save the previous user's annotation into its own JSON file.
50
            let oldJsonData = withFirstProvider(of: document) {
51
                return try! document.generateInstantJSON(from: $0)
52
            }
53
            try? oldJsonData.write(to: oldInstantJSONFile, options: Data.WritingOptions.atomic)
54

55
            // Then clear the document cache
56
            document.clearCache()
57

58
            // Load the annotations of the current users into the document.
59
            guard let newJsonData = try? Data(contentsOf: currentInstantJSONFile) else { return }
60

61
            let jsonContainer = DataContainerProvider(data: newJsonData)
62
            withFirstProvider(of: document) {
63
                try! document.applyInstantJSON(fromDataProvider: jsonContainer, to: $0, lenient: false)
64
            }
65

66
            // And finally - reload the PDF.
67
            reloadData()
68
        }
69
    }
70

71
    override func commonInit(with document: Document?, configuration: PDFConfiguration) {
72
        super.commonInit(with: document, configuration: configuration)
73

74
        // Set a test user.
75
        self.currentUsername = "Testuser"
76

77
        // Customize the toolbar.
78
        // See https://www.nutrient.io/guides/ios/customizing-the-interface/customizing-the-toolbar/ for more details.
79
        updateCustomToolbar()
80
        documentInfoCoordinator.availableControllerOptions = [DocumentInfoOption.annotations]
81
        navigationItem.rightBarButtonItems = [thumbnailsButtonItem, outlineButtonItem, annotationButtonItem]
82
    }
83

84
    // MARK: - Private
85

86
    private func updateCustomToolbar() {
87
        let switchUserButtonItem = UIBarButtonItem(title: "User: \(currentUsername)", style: .plain, target: self, action: #selector(switchUser(_:)))
88
        navigationItem.leftBarButtonItems = [closeButtonItem, switchUserButtonItem]
89
    }
90

91
    @objc func switchUser(_ sender: UIBarButtonItem) {
92
        // Dismiss any popovers.
93
        dismissViewController(of: nil, animated: true)
94

95
        let alertController = UIAlertController(title: "Switch User", message: "Enter username.", preferredStyle: .alert)
96
        alertController.addTextField { textField in
97
            textField.text = self.currentUsername
98
        }
99
        alertController.addAction(UIAlertAction(title: "Cancel", style: .cancel))
100
        alertController.addAction(UIAlertAction(title: "Switch", style: .default, handler: { [unowned self] _ in
101
            // In a real application you want to make the username unique and also check for characters that are trouble on file systems.
102
            guard let username = alertController.textFields?.first?.text else { return }
103
            // Set new username
104
            self.currentUsername = username
105
            // Update toolbar to show new name.
106
            self.updateCustomToolbar()
107
        }))
108

109
        present(alertController, animated: true, completion: nil)
110
    }
111
}