summaryrefslogtreecommitdiffhomepage
path: root/ios/MullvadVPN/RelayCache/RelayCacheIO.swift
blob: 20cbe90f6a52b873269f1dadd5cde9730d6bc38e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
//
//  RelayCacheIO.swift
//  RelayCacheIO
//
//  Created by pronebird on 27/07/2021.
//  Copyright © 2021 Mullvad VPN AB. All rights reserved.
//

import Foundation

extension RelayCache {
    enum IO {}
}

extension RelayCache.IO {
    /// The default cache file location bound by app group container.
    static func defaultCacheFileURL(
        forSecurityApplicationGroupIdentifier appGroupIdentifier: String
    ) -> URL? {
        let containerURL = FileManager.default.containerURL(
            forSecurityApplicationGroupIdentifier: appGroupIdentifier
        )

        return containerURL?.appendingPathComponent("relays.json")
    }

    /// The path to pre-bundled `relays.json` file.
    static var preBundledRelaysFileURL: URL? {
        return Bundle.main.url(forResource: "relays", withExtension: "json")
    }

    /// Safely read the cache file from disk using file coordinator.
    static func read(cacheFileURL: URL) throws -> RelayCache.CachedRelays {
        var result: Result<RelayCache.CachedRelays, RelayCache.Error>?
        let fileCoordinator = NSFileCoordinator(filePresenter: nil)

        let accessor = { (fileURLForReading: URL) -> Void in
            // Decode data from disk
            do {
                let data = try Data(contentsOf: fileURLForReading)
                let relays = try JSONDecoder().decode(RelayCache.CachedRelays.self, from: data)

                result = .success(relays)
            } catch let error as DecodingError {
                result = .failure(.decodeCache(error))
            } catch {
                result = .failure(.readCache(error))
            }
        }

        var error: NSError?
        fileCoordinator.coordinate(readingItemAt: cacheFileURL,
                                   options: [.withoutChanges],
                                   error: &error,
                                   byAccessor: accessor)

        if let error = error {
            result = .failure(.readCache(error))
        }

        return try result!.get()
    }

    /// Safely read the cache file from disk using file coordinator and fallback to prebundled
    /// relays in case if the relay cache file is missing.
    static func readWithFallback(cacheFileURL: URL, preBundledRelaysFileURL: URL)
        throws -> RelayCache.CachedRelays
    {
        do {
            return try Self.read(cacheFileURL: cacheFileURL)
        } catch {
            let error = error as! RelayCache.Error

            switch error {
            case .decodeCache, .readCache(CocoaError.fileReadNoSuchFile):
                return try RelayCache.IO.readPrebundledRelays(fileURL: preBundledRelaysFileURL)
            default:
                throw error
            }
        }
    }

    /// Read pre-bundled relays file from disk.
    static func readPrebundledRelays(fileURL: URL) throws -> RelayCache.CachedRelays {
        do {
            let data = try Data(contentsOf: fileURL)
            let relays = try REST.Coding.makeJSONDecoder()
                .decode(REST.ServerRelaysResponse.self, from: data)

            return RelayCache.CachedRelays(
                relays: relays,
                updatedAt: Date(timeIntervalSince1970: 0)
            )
        } catch let error as DecodingError {
            throw RelayCache.Error.decodePrebundledRelays(error)
        } catch {
            throw RelayCache.Error.readPrebundledRelays(error)
        }
    }

    /// Safely write the cache file on disk using file coordinator.
    static func write(cacheFileURL: URL, record: RelayCache.CachedRelays) throws {
        var resultError: RelayCache.Error?
        let fileCoordinator = NSFileCoordinator(filePresenter: nil)

        let accessor = { (fileURLForWriting: URL) -> Void in
            do {
                let data = try JSONEncoder().encode(record)
                try data.write(to: fileURLForWriting)
            } catch let error as EncodingError {
                resultError = .encodeCache(error)
            } catch {
                resultError = .writeCache(error)
            }
        }

        var error: NSError?
        fileCoordinator.coordinate(writingItemAt: cacheFileURL,
                                   options: [.forReplacing],
                                   error: &error,
                                   byAccessor: accessor)

        if let resultError = resultError {
            throw resultError
        }
    }
}