@capgo/cordova-updater 8.1.1

package/src/ios/DeviceIdHelper.swift

@@ -0,0 +1,120 @@
+/*
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ */
+
+import Foundation
+import Security
+
+/**
+ * Helper class to manage device ID persistence across app installations.
+ * Uses iOS Keychain to persist the device ID.
+ */
+class DeviceIdHelper {
+    private static let keychainService = "app.capgo.updater"
+    private static let keychainAccount = "deviceId"
+    private static let legacyDefaultsKey = "appUUID"
+
+    /**
+     * Gets or creates a device ID that persists across reinstalls.
+     *
+     * This method:
+     * 1. First checks for an existing ID in Keychain (persists across reinstalls)
+     * 2. Falls back to UserDefaults (for migration from older versions)
+     * 3. Generates a new UUID if neither exists
+     * 4. Stores the ID in Keychain for future use
+     *
+     * @return Device ID as a lowercase UUID string
+     */
+    static func getOrCreateDeviceId() -> String {
+        // Try to get device ID from Keychain first
+        if let keychainDeviceId = getDeviceIdFromKeychain() {
+            return keychainDeviceId.lowercased()
+        }
+
+        // Migration: Check UserDefaults for existing device ID
+        var deviceId = UserDefaults.standard.string(forKey: legacyDefaultsKey)
+
+        if deviceId == nil || deviceId!.isEmpty {
+            // Generate new device ID if none exists
+            deviceId = UUID().uuidString
+        }
+
+        // Ensure lowercase for consistency
+        deviceId = deviceId!.lowercased()
+
+        // Save to Keychain for persistence across reinstalls
+        saveDeviceIdToKeychain(deviceId: deviceId!)
+
+        return deviceId!
+    }
+
+    /**
+     * Retrieves the device ID from iOS Keychain.
+     *
+     * @return Device ID string or nil if not found
+     */
+    private static func getDeviceIdFromKeychain() -> String? {
+        let query: [String: Any] = [
+            kSecClass as String: kSecClassGenericPassword,
+            kSecAttrService as String: keychainService,
+            kSecAttrAccount as String: keychainAccount,
+            kSecReturnData as String: true,
+            kSecMatchLimit as String: kSecMatchLimitOne
+        ]
+
+        var result: AnyObject?
+        let status = SecItemCopyMatching(query as CFDictionary, &result)
+
+        guard status == errSecSuccess,
+              let data = result as? Data,
+              let deviceId = String(data: data, encoding: .utf8) else {
+            return nil
+        }
+
+        return deviceId
+    }
+
+    /**
+     * Saves the device ID to iOS Keychain with appropriate accessibility settings.
+     *
+     * Uses kSecAttrAccessibleAfterFirstUnlockThisDeviceOnly:
+     * - Data persists across reinstalls
+     * - Data is NOT synced to iCloud
+     * - Data is accessible after first device unlock
+     * - Data stays on this device only (privacy-friendly)
+     *
+     * @param deviceId The device ID to save
+     */
+    private static func saveDeviceIdToKeychain(deviceId: String) {
+        guard let data = deviceId.data(using: .utf8) else {
+            return
+        }
+
+        // Delete any existing entry first
+        let deleteQuery: [String: Any] = [
+            kSecClass as String: kSecClassGenericPassword,
+            kSecAttrService as String: keychainService,
+            kSecAttrAccount as String: keychainAccount
+        ]
+        SecItemDelete(deleteQuery as CFDictionary)
+
+        // Add new entry with appropriate accessibility
+        let addQuery: [String: Any] = [
+            kSecClass as String: kSecClassGenericPassword,
+            kSecAttrService as String: keychainService,
+            kSecAttrAccount as String: keychainAccount,
+            kSecValueData as String: data,
+            // This ensures data persists across reinstalls but stays on device (not synced)
+            kSecAttrAccessible as String: kSecAttrAccessibleAfterFirstUnlockThisDeviceOnly
+        ]
+
+        let status = SecItemAdd(addQuery as CFDictionary, nil)
+
+        if status != errSecSuccess {
+            // Log error but don't crash - we'll fall back to UserDefaults on next launch
+            print("Failed to save device ID to Keychain: \(status)")
+        }
+    }
+}

package/src/ios/Info.plist

@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>CFBundleDevelopmentRegion</key>
+	<string>$(DEVELOPMENT_LANGUAGE)</string>
+	<key>CFBundleExecutable</key>
+	<string>$(EXECUTABLE_NAME)</string>
+	<key>CFBundleIdentifier</key>
+	<string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
+	<key>CFBundleInfoDictionaryVersion</key>
+	<string>6.0</string>
+	<key>CFBundleName</key>
+	<string>$(PRODUCT_NAME)</string>
+	<key>CFBundlePackageType</key>
+	<string>FMWK</string>
+	<key>CFBundleShortVersionString</key>
+	<string>1.0</string>
+	<key>CFBundleVersion</key>
+	<string>$(CURRENT_PROJECT_VERSION)</string>
+	<key>NSPrincipalClass</key>
+	<string></string>
+	<key>UIFileSharingEnabled</key>
+	<true/>
+	<key>LSSupportsOpeningDocumentsInPlace</key>
+	<true/>
+</dict>
+</plist>

package/src/ios/InternalUtils.swift

@@ -0,0 +1,471 @@
+/*
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ */
+
+import Foundation
+
+extension Collection {
+    subscript(safe index: Index) -> Element? {
+        return indices.contains(index) ? self[index] : nil
+    }
+}
+extension URL {
+    var isDirectory: Bool {
+        (try? resourceValues(forKeys: [.isDirectoryKey]))?.isDirectory == true
+    }
+    var exist: Bool {
+        return FileManager().fileExists(atPath: self.path)
+    }
+}
+struct SetChannelDec: Decodable {
+    let status: String?
+    let error: String?
+    let message: String?
+    let unset: Bool?
+}
+public class SetChannel: NSObject {
+    var status: String = ""
+    var error: String = ""
+    var message: String = ""
+}
+extension SetChannel {
+    func toDict() -> [String: Any] {
+        var dict: [String: Any] = [String: Any]()
+        let otherSelf: Mirror = Mirror(reflecting: self)
+        for child: Mirror.Child in otherSelf.children {
+            if let key: String = child.label {
+                dict[key] = child.value
+            }
+        }
+        return dict
+    }
+}
+struct GetChannelDec: Decodable {
+    let channel: String?
+    let status: String?
+    let error: String?
+    let message: String?
+    let allowSet: Bool?
+}
+public class GetChannel: NSObject {
+    var channel: String = ""
+    var status: String = ""
+    var error: String = ""
+    var message: String = ""
+    var allowSet: Bool = true
+}
+extension GetChannel {
+    func toDict() -> [String: Any] {
+        var dict: [String: Any] = [String: Any]()
+        let otherSelf: Mirror = Mirror(reflecting: self)
+        for child: Mirror.Child in otherSelf.children {
+            if let key: String = child.label {
+                dict[key] = child.value
+            }
+        }
+        return dict
+    }
+}
+// swiftlint:disable identifier_name
+struct ChannelInfo: Codable {
+    let id: Int
+    let name: String?
+    let `public`: Bool?
+    let allow_self_set: Bool?
+}
+// swiftlint:enable identifier_name
+struct ListChannelsDec: Decodable {
+    let channels: [ChannelInfo]?
+    let error: String?
+
+    init(from decoder: Decoder) throws {
+        let container = try decoder.singleValueContainer()
+
+        if let channelsArray = try? container.decode([ChannelInfo].self) {
+            // Backend returns direct array
+            self.channels = channelsArray
+            self.error = nil
+        } else {
+            // Handle error response
+            let errorContainer = try decoder.container(keyedBy: CodingKeys.self)
+            self.channels = nil
+            self.error = try? errorContainer.decode(String.self, forKey: .error)
+        }
+    }
+
+    private enum CodingKeys: String, CodingKey {
+        case error
+    }
+}
+public class ListChannels: NSObject {
+    var channels: [[String: Any]] = []
+    var error: String = ""
+}
+extension ListChannels {
+    func toDict() -> [String: Any] {
+        var dict: [String: Any] = [String: Any]()
+        let otherSelf: Mirror = Mirror(reflecting: self)
+        for child: Mirror.Child in otherSelf.children {
+            if let key: String = child.label {
+                dict[key] = child.value
+            }
+        }
+        return dict
+    }
+}
+// swiftlint:disable identifier_name
+struct InfoObject: Codable {
+    let platform: String?
+    let device_id: String?
+    let app_id: String?
+    let custom_id: String?
+    let version_build: String?
+    let version_code: String?
+    let version_os: String?
+    var version_name: String?
+    var old_version_name: String?
+    let plugin_version: String?
+    let is_emulator: Bool?
+    let is_prod: Bool?
+    let installSource: String?
+    var action: String?
+    var channel: String?
+    var defaultChannel: String?
+    var key_id: String?
+
+    enum CodingKeys: String, CodingKey {
+        case platform
+        case device_id
+        case app_id
+        case custom_id
+        case version_build
+        case version_code
+        case version_os
+        case version_name
+        case old_version_name
+        case plugin_version
+        case is_emulator
+        case is_prod
+        case installSource = "install_source"
+        case action
+        case channel
+        case defaultChannel
+        case key_id
+    }
+}
+
+extension InfoObject {
+    func toParameters() -> [String: Any] {
+        var parameters: [String: Any] = [:]
+        func set(_ key: String, _ value: Any?) {
+            guard let value = value else {
+                return
+            }
+            parameters[key] = value
+        }
+        set("platform", platform)
+        set("device_id", device_id)
+        set("app_id", app_id)
+        set("custom_id", custom_id)
+        set("version_build", version_build)
+        set("version_code", version_code)
+        set("version_os", version_os)
+        set("version_name", version_name)
+        set("old_version_name", old_version_name)
+        set("plugin_version", plugin_version)
+        set("is_emulator", is_emulator)
+        set("is_prod", is_prod)
+        set("install_source", installSource)
+        set("action", action)
+        set("channel", channel)
+        set("defaultChannel", defaultChannel)
+        set("key_id", key_id)
+        return parameters
+    }
+}
+// swiftlint:enable identifier_name
+
+// swiftlint:disable identifier_name
+struct StatsEvent: Codable {
+    let platform: String?
+    let device_id: String?
+    let app_id: String?
+    let custom_id: String?
+    let version_build: String?
+    let version_code: String?
+    let version_os: String?
+    let version_name: String?
+    let old_version_name: String?
+    let plugin_version: String?
+    let is_emulator: Bool?
+    let is_prod: Bool?
+    let installSource: String?
+    let action: String?
+    let channel: String?
+    let defaultChannel: String?
+    let key_id: String?
+    let metadata: [String: String]?
+    let timestamp: Int64
+
+    enum CodingKeys: String, CodingKey {
+        case platform
+        case device_id
+        case app_id
+        case custom_id
+        case version_build
+        case version_code
+        case version_os
+        case version_name
+        case old_version_name
+        case plugin_version
+        case is_emulator
+        case is_prod
+        case installSource = "install_source"
+        case action
+        case channel
+        case defaultChannel
+        case key_id
+        case metadata
+        case timestamp
+    }
+}
+// swiftlint:enable identifier_name
+
+// swiftlint:disable identifier_name
+public struct ManifestEntry: Codable {
+    let file_name: String?
+    let file_hash: String?
+    let download_url: String?
+}
+// swiftlint:enable identifier_name
+
+extension ManifestEntry {
+    func toDict() -> [String: Any] {
+        var dict: [String: Any] = [String: Any]()
+        let mirror = Mirror(reflecting: self)
+        for child in mirror.children {
+            if let key = child.label {
+                dict[key] = child.value
+            }
+        }
+        return dict
+    }
+}
+
+// swiftlint:disable identifier_name
+struct AppVersionDec: Decodable {
+    let version: String?
+    let checksum: String?
+    let url: String?
+    let message: String?
+    let error: String?
+    let kind: String?
+    let session_key: String?
+    let major: Bool?
+    let breaking: Bool?
+    let data: [String: String]?
+    let manifest: [ManifestEntry]?
+    let link: String?
+    let comment: String?
+    // The HTTP status code is captured separately in CapgoUpdater; this struct only mirrors JSON.
+}
+// swiftlint:enable identifier_name
+
+public class AppVersion: NSObject {
+    var version: String = ""
+    var checksum: String = ""
+    var url: String = ""
+    var message: String?
+    var error: String?
+    var kind: String?
+    var sessionKey: String?
+    var major: Bool?
+    var breaking: Bool?
+    var data: [String: String]?
+    var manifest: [ManifestEntry]?
+    var missing: [String: Any]?
+    var downloadSize: [String: Any]?
+    var link: String?
+    var comment: String?
+    var statusCode: Int = 0
+}
+
+extension AppVersion {
+    func toDict() -> [String: Any] {
+        var dict: [String: Any] = [String: Any]()
+        let otherSelf: Mirror = Mirror(reflecting: self)
+        for child: Mirror.Child in otherSelf.children {
+            if let key: String = child.label {
+                if key == "manifest", let manifestEntries = child.value as? [ManifestEntry] {
+                    dict[key] = manifestEntries.map { $0.toDict() }
+                } else {
+                    dict[key] = child.value
+                }
+            }
+        }
+        return dict
+    }
+}
+
+extension OperatingSystemVersion {
+    func getFullVersion(separator: String = ".") -> String {
+        return "\(majorVersion)\(separator)\(minorVersion)\(separator)\(patchVersion)"
+    }
+}
+extension Bundle {
+    var versionName: String? {
+        return infoDictionary?["CFBundleShortVersionString"] as? String
+    }
+    var versionCode: String? {
+        return infoDictionary?["CFBundleVersion"] as? String
+    }
+}
+
+extension ISO8601DateFormatter {
+    convenience init(_ formatOptions: Options) {
+        self.init()
+        self.formatOptions = formatOptions
+    }
+}
+extension Formatter {
+    static let iso8601withFractionalSeconds: ISO8601DateFormatter = ISO8601DateFormatter(
+        [.withInternetDateTime, .withFractionalSeconds])
+}
+extension Date {
+    var iso8601withFractionalSeconds: String { return Formatter.iso8601withFractionalSeconds.string(from: self) }
+}
+extension String {
+
+    var fileURL: URL {
+        return URL(fileURLWithPath: self)
+    }
+
+    var lastPathComponent: String {
+        get {
+            return fileURL.lastPathComponent
+        }
+    }
+    var iso8601withFractionalSeconds: Date? {
+        return Formatter.iso8601withFractionalSeconds.date(from: self)
+    }
+    func trim(using characterSet: CharacterSet = .whitespacesAndNewlines) -> String {
+        return trimmingCharacters(in: characterSet)
+    }
+}
+
+enum CustomError: Error {
+    // Throw when an unzip fail
+    case cannotUnzip
+    case cannotWrite
+    case cannotDecode
+    case cannotUnflat
+    case cannotCreateDirectory
+    case cannotDeleteDirectory
+    case cannotDecryptSessionKey
+    case invalidBase64
+    case insufficientDiskSpace
+
+    // Throw in all other cases
+    case unexpected(code: Int)
+}
+
+extension CustomError: LocalizedError {
+    public var errorDescription: String? {
+        switch self {
+        case .cannotUnzip:
+            return NSLocalizedString(
+                "The file cannot be unzip",
+                comment: "Invalid zip"
+            )
+        case .cannotCreateDirectory:
+            return NSLocalizedString(
+                "The folder cannot be created",
+                comment: "Invalid folder"
+            )
+        case .cannotDeleteDirectory:
+            return NSLocalizedString(
+                "The folder cannot be deleted",
+                comment: "Invalid folder"
+            )
+        case .cannotUnflat:
+            return NSLocalizedString(
+                "The file cannot be unflat",
+                comment: "Invalid folder"
+            )
+        case .unexpected:
+            return NSLocalizedString(
+                "An unexpected error occurred.",
+                comment: "Unexpected Error"
+            )
+        case .cannotDecode:
+            return NSLocalizedString(
+                "Decoding the zip failed with this key",
+                comment: "Invalid public key"
+            )
+        case .cannotWrite:
+            return NSLocalizedString(
+                "Cannot write to the destination",
+                comment: "Invalid destination"
+            )
+        case .cannotDecryptSessionKey:
+            return NSLocalizedString(
+                "Decrypting the session key failed",
+                comment: "Invalid session key"
+            )
+        case .invalidBase64:
+            return NSLocalizedString(
+                "Decrypting the base64 failed",
+                comment: "Invalid checksum key"
+            )
+        case .insufficientDiskSpace:
+            return NSLocalizedString(
+                "Insufficient disk space for download",
+                comment: "Not enough storage"
+            )
+        }
+    }
+}
+
+/// Thread-safe atomic counter for concurrent operations
+final class AtomicCounter {
+    private var value: Int = 0
+    private let lock = NSLock()
+
+    func increment() -> Int {
+        lock.lock()
+        defer { lock.unlock() }
+        value += 1
+        return value
+    }
+
+    var current: Int {
+        lock.lock()
+        defer { lock.unlock() }
+        return value
+    }
+}
+
+/// Thread-safe atomic boolean for concurrent operations
+final class AtomicBool {
+    private var _value: Bool
+    private let lock = NSLock()
+
+    init(initialValue: Bool = false) {
+        _value = initialValue
+    }
+
+    var value: Bool {
+        get {
+            lock.lock()
+            defer { lock.unlock() }
+            return _value
+        }
+        set {
+            lock.lock()
+            defer { lock.unlock() }
+            _value = newValue
+        }
+    }
+}