@capgo/capacitor-updater 8.0.0 → 8.1.0

package/ios/Sources/CapacitorUpdaterPlugin/InternalUtils.swift

@@ -0,0 +1,311 @@
+/*
+ * 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?
+}
+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
+    }
+}
+struct ChannelInfo: Codable {
+    let id: String?
+    let name: String?
+    let `public`: Bool?
+    let allow_self_set: Bool?
+}
+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
+    }
+}
+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?
+    var action: String?
+    var channel: String?
+    var defaultChannel: String?
+}
+
+public struct ManifestEntry: Codable {
+    let file_name: String?
+    let file_hash: String?
+    let download_url: String?
+}
+
+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
+    }
+}
+
+struct AppVersionDec: Decodable {
+    let version: String?
+    let checksum: String?
+    let url: String?
+    let message: String?
+    let error: 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.
+}
+
+public class AppVersion: NSObject {
+    var version: String = ""
+    var checksum: String = ""
+    var url: String = ""
+    var message: String?
+    var error: String?
+    var sessionKey: String?
+    var major: Bool?
+    var breaking: Bool?
+    var data: [String: String]?
+    var manifest: [ManifestEntry]?
+    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
+
+    // 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"
+            )
+        }
+    }
+}

package/ios/Sources/CapacitorUpdaterPlugin/Logger.swift

@@ -0,0 +1,310 @@
+import Capacitor
+import Foundation
+import os.log
+import WebKit
+
+public class Logger {
+    public enum LogLevel: Int {
+        case silent = 0
+        case error
+        case warn
+        case info
+        case debug
+
+        public static subscript(_ str: String) -> LogLevel? {
+            var index = 0
+
+            while let item = LogLevel(rawValue: index) {
+                if str == "\(item)" {
+                    return item
+                }
+
+                index += 1
+            }
+
+            return nil
+        }
+
+        public func asOSLogType() -> OSLogType {
+            switch self {
+            case .debug:
+                return OSLogType.debug
+            case .info:
+                return OSLogType.info
+            case .warn:
+                return OSLogType.default
+            case .error:
+                return OSLogType.error
+            case .silent:
+                return OSLogType.info // Compiler wants this, it will never be used
+            }
+        }
+        public func asString() -> String {
+            switch self {
+            case .debug:
+                return "debug"
+            case .info:
+                return "info"
+            case .warn:
+                return "warn"
+            case .error:
+                return "error"
+            case .silent:
+                return "info"
+            }
+        }
+    }
+
+    public struct Options {
+        public var level: LogLevel
+        public var labels: [String: String]
+        public var useSyslog: Bool
+
+        public init(level: LogLevel = LogLevel.info, labels: [String: String] = [:], useSyslog: Bool = false) {
+            self.level = level
+            self.labels = labels
+            self.useSyslog = useSyslog
+        }
+    }
+
+    private var _labels: [LogLevel: String] = [
+        LogLevel.silent: "",
+        LogLevel.error: "🔴",
+        LogLevel.warn: "🟠",
+        LogLevel.info: "🟢",
+        LogLevel.debug: "🔎"
+    ]
+
+    public var labels: [String: String] {
+        get {
+            var result: [String: String] = [:]
+
+            for (level, label) in _labels {
+                result[String(describing: level)] = label
+            }
+
+            return result
+        }
+
+        set {
+            for (level, label) in newValue {
+                if let logLevel = LogLevel[level] {
+                    _labels[logLevel] = label
+                }
+            }
+        }
+    }
+
+    public var level = LogLevel.info
+
+    public var levelName: String {
+        get {
+            String(describing: level)
+        }
+        set {
+            if let newLevel = LogLevel[newValue] {
+                level = newLevel
+            }
+        }
+    }
+
+    private var _tag = ""
+
+    public var tag: String {
+        get {
+            _tag
+        }
+        set {
+            if !newValue.isEmpty {
+                _tag = newValue
+            }
+        }
+    }
+
+    private let kDefaultTimerLabel = "default"
+    private var timers: [String: Date] = [:]
+    public var useSyslog = false
+    public var webView: WKWebView?
+
+    public func setWebView(webView: WKWebView) {
+        self.webView = webView
+    }
+
+    public init(
+        withTag tag: String,
+        config: InstanceConfiguration? = nil,
+        options: Options? = nil
+    ) {
+        self.tag = tag
+        if let config = config {
+            // The logger plugin's name is LoggerBridge, we want to look at the config
+            // named "Logger", so we can't use plugin.getConfigValue().
+            if let configLevel = getConfigValue("level", from: config) as? String,
+               let logLevel = LogLevel[configLevel] {
+                level = logLevel
+            }
+
+            if let configLabels = getConfigValue("labels", from: config) as? [String: String] {
+                labels = configLabels
+            }
+
+            if let configSyslog = getConfigValue("useSyslog", from: config) as? Bool {
+                useSyslog = configSyslog
+            }
+        }
+
+        if let options = options {
+            self.level = options.level
+            self.labels = options.labels
+            self.useSyslog = options.useSyslog
+        }
+    }
+
+    private func getConfigValue(_ configKey: String, from config: InstanceConfiguration) -> Any? {
+        if let config = config.pluginConfigurations as? JSObject {
+            return config[keyPath: KeyPath(stringLiteral: "Logger.\(configKey)")]
+        }
+
+        return nil
+    }
+
+    public func error(_ message: String) {
+        log(atLevel: LogLevel.error, message: message)
+    }
+
+    public func warn(_ message: String) {
+        log(atLevel: LogLevel.warn, message: message)
+    }
+
+    public func info(_ message: String) {
+        log(atLevel: LogLevel.info, message: message)
+    }
+
+    public func log(_ message: String) {
+        log(atLevel: LogLevel.info, message: message)
+    }
+
+    public func debug(_ message: String) {
+        log(atLevel: LogLevel.debug, message: message)
+    }
+
+    public func dir(_ value: Any?) {
+        // Check the log level here to avoid conversion to string
+        if canLog(atLevel: LogLevel.info) {
+            log(atLevel: LogLevel.info, message: String(describing: value))
+        }
+    }
+
+    public func log(atLevel level: LogLevel, message: String) {
+        // This will never fail, but we have to keep swift happy
+        if let label = _labels[level] {
+            log(atLevel: level, label: label, tag: tag, message: message)
+            if let webView = self.webView {
+                DispatchQueue.main.async {
+                    let combined = "\(label) \(self.tag) : \(message)"
+                    let jsArg = self.toJSStringLiteral(combined)
+                    webView.evaluateJavaScript("console.\(level.asString())(\(jsArg))", completionHandler: nil)
+                }
+            }
+        }
+    }
+
+    private func toJSStringLiteral(_ value: String) -> String {
+        // Prefer JSON encoding to produce a valid JS string literal
+        if let data = try? JSONEncoder().encode(value),
+           let encoded = String(data: data, encoding: .utf8) {
+            return encoded
+        }
+
+        // Fallback manual escaping (unlikely to be used)
+        var s = value
+        s = s.replacingOccurrences(of: "\\", with: "\\\\")
+        s = s.replacingOccurrences(of: "\"", with: "\\\"")
+        s = s.replacingOccurrences(of: "'", with: "\\'")
+        s = s.replacingOccurrences(of: "\n", with: "\\n")
+        s = s.replacingOccurrences(of: "\r", with: "\\r")
+        s = s.replacingOccurrences(of: "\u{2028}", with: "\\u2028")
+        s = s.replacingOccurrences(of: "\u{2029}", with: "\\u2029")
+        return "\"\(s)\""
+    }
+
+    public func log(atLevel level: LogLevel, label: String?, tag: String, message: String) {
+        // This will never fail, but we have to keep swift happy
+        if let label = label ?? _labels[level] {
+            print(atLevel: level, label: label, tag: tag, message: message)
+            // eval
+        }
+    }
+
+    private func canLog(atLevel level: LogLevel) -> Bool {
+        self.level.rawValue >= level.rawValue
+    }
+
+    private func print(atLevel level: LogLevel, label: String, tag: String, message: String) {
+        guard canLog(atLevel: level) else {
+            return
+        }
+
+        var msg = message
+
+        if !label.isEmpty {
+            // If the label is ASCII, put it after the tag, otherwise before.
+            if label[label.startIndex].isASCII {
+                msg = "[\(tag)] \(label): \(message)"
+            } else {
+                msg = "\(label) [\(tag)]: \(message)"
+            }
+        } else {
+            msg = "[\(tag)]: \(message)"
+        }
+
+        if useSyslog {
+            os_log("%{public}@", type: level.asOSLogType(), msg)
+        } else {
+            Swift.print(msg)
+        }
+    }
+
+    public func time(_ label: String?) {
+        timers[label ?? ""] = Date()
+    }
+
+    public func timeLog(_ label: String?) {
+        if let timer = timers[label ?? ""] {
+            info(formatTimeInterval(timer.timeIntervalSinceNow))
+        } else {
+            warn("timer \(label ?? kDefaultTimerLabel) does not exist")
+        }
+    }
+
+    public func timeEnd(_ label: String?) {
+        timeLog(label)
+        timers.removeValue(forKey: label ?? kDefaultTimerLabel)
+    }
+
+    private func formatTimeInterval(_ interval: TimeInterval) -> String {
+        let int = Int(interval)
+        let millis = Int(((1 + interval.remainder(dividingBy: 1)) * 1000).rounded())
+        let seconds = int % 60
+        let minutes = (int / 60) % 60
+        let hours = (int / 3600)
+
+        if seconds < 1 {
+            return "\(millis)ms"
+        }
+
+        if minutes < 1 {
+            return "\(seconds).\(String(format: "%0.3d", millis))s"
+        }
+
+        if hours < 1 {
+            return "\(minutes):\(String(format: "%0.2d", seconds)).\(String(format: "%0.3d", millis)) (min:sec.ms)"
+        }
+
+        return "\(hours):\(String(format: "%0.2d", minutes)):\(String(format: "%0.2d", seconds)) (hr:min:sec)"
+    }
+
+    public func trace() {
+        info(String(format: "%@", Thread.callStackSymbols))
+    }
+}