/* * 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 Capacitor import Version import WebKit // Helper class to detect when WebView loading completes class WebViewLoadDelegate: NSObject, WKNavigationDelegate { private let completion: (Bool) -> Void private var hasCompleted = false init(completion: @escaping (Bool) -> Void) { self.completion = completion super.init() } func webView(_ webView: WKWebView, didFinish navigation: WKNavigation!) { if !hasCompleted { hasCompleted = true webView.navigationDelegate = nil // Clean up completion(true) } } func webView(_ webView: WKWebView, didFail navigation: WKNavigation!, withError error: Error) { if !hasCompleted { hasCompleted = true webView.navigationDelegate = nil // Clean up completion(false) } } func webView(_ webView: WKWebView, didFailProvisionalNavigation navigation: WKNavigation!, withError error: Error) { if !hasCompleted { hasCompleted = true webView.navigationDelegate = nil // Clean up completion(false) } } } /** * Please read the Capacitor iOS Plugin Development Guide * here: https://capacitorjs.com/docs/plugins/ios */ @objc(CapacitorUpdaterPlugin) public class CapacitorUpdaterPlugin: CAPPlugin, CAPBridgedPlugin { let logger = Logger(withTag: "✨ CapgoUpdater") public let identifier = "CapacitorUpdaterPlugin" public let jsName = "CapacitorUpdater" public let pluginMethods: [CAPPluginMethod] = [ CAPPluginMethod(name: "download", returnType: CAPPluginReturnPromise), CAPPluginMethod(name: "setUpdateUrl", returnType: CAPPluginReturnPromise), CAPPluginMethod(name: "setStatsUrl", returnType: CAPPluginReturnPromise), CAPPluginMethod(name: "setChannelUrl", returnType: CAPPluginReturnPromise), CAPPluginMethod(name: "set", returnType: CAPPluginReturnPromise), CAPPluginMethod(name: "list", returnType: CAPPluginReturnPromise), CAPPluginMethod(name: "delete", returnType: CAPPluginReturnPromise), CAPPluginMethod(name: "reset", returnType: CAPPluginReturnPromise), CAPPluginMethod(name: "current", returnType: CAPPluginReturnPromise), CAPPluginMethod(name: "reload", returnType: CAPPluginReturnPromise), CAPPluginMethod(name: "notifyAppReady", returnType: CAPPluginReturnPromise), CAPPluginMethod(name: "setDelay", returnType: CAPPluginReturnPromise), CAPPluginMethod(name: "setMultiDelay", returnType: CAPPluginReturnPromise), CAPPluginMethod(name: "cancelDelay", returnType: CAPPluginReturnPromise), CAPPluginMethod(name: "getLatest", returnType: CAPPluginReturnPromise), CAPPluginMethod(name: "setChannel", returnType: CAPPluginReturnPromise), CAPPluginMethod(name: "unsetChannel", returnType: CAPPluginReturnPromise), CAPPluginMethod(name: "getChannel", returnType: CAPPluginReturnPromise), CAPPluginMethod(name: "listChannels", returnType: CAPPluginReturnPromise), CAPPluginMethod(name: "setCustomId", returnType: CAPPluginReturnPromise), CAPPluginMethod(name: "getDeviceId", returnType: CAPPluginReturnPromise), CAPPluginMethod(name: "getPluginVersion", returnType: CAPPluginReturnPromise), CAPPluginMethod(name: "next", returnType: CAPPluginReturnPromise), CAPPluginMethod(name: "isAutoUpdateEnabled", returnType: CAPPluginReturnPromise), CAPPluginMethod(name: "getBuiltinVersion", returnType: CAPPluginReturnPromise), CAPPluginMethod(name: "isAutoUpdateAvailable", returnType: CAPPluginReturnPromise), CAPPluginMethod(name: "getNextBundle", returnType: CAPPluginReturnPromise), CAPPluginMethod(name: "setShakeMenu", returnType: CAPPluginReturnPromise), CAPPluginMethod(name: "isShakeMenuEnabled", returnType: CAPPluginReturnPromise) ] public var implementation = CapgoUpdater() private let PLUGIN_VERSION: String = "7.8.9" static let updateUrlDefault = "https://plugin.capgo.app/updates" static let statsUrlDefault = "https://plugin.capgo.app/stats" static let channelUrlDefault = "https://plugin.capgo.app/channel_self" // Note: DELAY_CONDITION_PREFERENCES is now defined in DelayUpdateUtils.DELAY_CONDITION_PREFERENCES private var updateUrl = "" private var statsUrl = "" private var backgroundTaskID: UIBackgroundTaskIdentifier = UIBackgroundTaskIdentifier.invalid private var currentVersionNative: Version = "0.0.0" private var autoUpdate = false private var appReadyTimeout = 10000 private var appReadyCheck: DispatchWorkItem? private var resetWhenUpdate = true private var directUpdate = false private var directUpdateMode: String = "false" private var wasRecentlyInstalledOrUpdated = false private var autoSplashscreen = false private var autoDeleteFailed = false private var autoDeletePrevious = false private var keepUrlPathAfterReload = false private var backgroundWork: DispatchWorkItem? private var taskRunning = false private var periodCheckDelay = 0 public var shakeMenuEnabled = false let semaphoreReady = DispatchSemaphore(value: 0) private var delayUpdateUtils: DelayUpdateUtils! override public func load() { let disableJSLogging = getConfig().getBoolean("disableJSLogging", false) // Set webView for logging to JavaScript console if ((self.bridge?.webView) != nil) && !disableJSLogging { logger.setWebView(webView: (self.bridge?.webView)!) logger.info("WebView set successfully for logging") } else { logger.error("Failed to get webView for logging") } #if targetEnvironment(simulator) logger.info("::::: SIMULATOR :::::") logger.info("Application directory: \(NSHomeDirectory())") #endif self.semaphoreUp() self.implementation.deviceID = (UserDefaults.standard.string(forKey: "appUUID") ?? UUID().uuidString).lowercased() UserDefaults.standard.set( self.implementation.deviceID, forKey: "appUUID") UserDefaults.standard.synchronize() logger.info("init for device \(self.implementation.deviceID)") guard let versionName = getConfig().getString("version", Bundle.main.versionName) else { logger.error("Cannot get version name") // crash the app fatalError("Cannot get version name") } do { currentVersionNative = try Version(versionName) } catch { logger.error("Cannot parse versionName \(versionName)") } logger.info("version native \(self.currentVersionNative.description)") implementation.versionBuild = getConfig().getString("version", Bundle.main.versionName)! autoDeleteFailed = getConfig().getBoolean("autoDeleteFailed", true) autoDeletePrevious = getConfig().getBoolean("autoDeletePrevious", true) keepUrlPathAfterReload = getConfig().getBoolean("keepUrlPathAfterReload", false) // Handle directUpdate configuration - support string values and backward compatibility if let directUpdateString = getConfig().getString("directUpdate") { directUpdateMode = directUpdateString directUpdate = directUpdateString == "always" || directUpdateString == "atInstall" } else { let directUpdateBool = getConfig().getBoolean("directUpdate", false) if directUpdateBool { directUpdateMode = "always" // backward compatibility: true = always directUpdate = true } else { directUpdateMode = "false" directUpdate = false } } autoSplashscreen = getConfig().getBoolean("autoSplashscreen", false) updateUrl = getConfig().getString("updateUrl", CapacitorUpdaterPlugin.updateUrlDefault)! autoUpdate = getConfig().getBoolean("autoUpdate", true) appReadyTimeout = getConfig().getInt("appReadyTimeout", 10000) implementation.timeout = Double(getConfig().getInt("responseTimeout", 20)) resetWhenUpdate = getConfig().getBoolean("resetWhenUpdate", true) shakeMenuEnabled = getConfig().getBoolean("shakeMenu", false) let periodCheckDelayValue = getConfig().getInt("periodCheckDelay", 0) if periodCheckDelayValue >= 0 && periodCheckDelayValue > 600 { periodCheckDelay = 600 } else { periodCheckDelay = periodCheckDelayValue } implementation.publicKey = getConfig().getString("publicKey", "")! implementation.notifyDownloadRaw = notifyDownload implementation.PLUGIN_VERSION = self.PLUGIN_VERSION // Set logger for shared classes implementation.setLogger(logger) CryptoCipherV2.setLogger(logger) // Initialize DelayUpdateUtils self.delayUpdateUtils = DelayUpdateUtils(currentVersionNative: currentVersionNative, installNext: { [weak self] in self?.installNext() }, logger: logger) let config = (self.bridge?.viewController as? CAPBridgeViewController)?.instanceDescriptor().legacyConfig implementation.appId = Bundle.main.infoDictionary?["CFBundleIdentifier"] as? String ?? "" implementation.appId = config?["appId"] as? String ?? implementation.appId implementation.appId = getConfig().getString("appId", implementation.appId)! if implementation.appId == "" { fatalError("appId is missing in capacitor.config.json or plugin config, and cannot be retrieved from the native app, please add it globally or in the plugin config") } logger.info("appId \(implementation.appId)") implementation.statsUrl = getConfig().getString("statsUrl", CapacitorUpdaterPlugin.statsUrlDefault)! implementation.channelUrl = getConfig().getString("channelUrl", CapacitorUpdaterPlugin.channelUrlDefault)! implementation.defaultChannel = getConfig().getString("defaultChannel", "")! self.implementation.autoReset() // Check if app was recently installed/updated BEFORE cleanupObsoleteVersions updates LatestVersionNative self.wasRecentlyInstalledOrUpdated = self.checkIfRecentlyInstalledOrUpdated() if resetWhenUpdate { self.cleanupObsoleteVersions() } // Load the server // This is very much swift specific, android does not do that // In android we depend on the serverBasePath capacitor property // In IOS we do not. Instead during the plugin initialization we try to call setServerBasePath // The idea is to prevent having to store the bundle in 2 locations for hot reload and persisten storage // According to martin it is not possible to use serverBasePath on ios in a way that allows us to store the bundle once if !self.initialLoad() { logger.error("unable to force reload, the plugin might fallback to the builtin version") } let nc = NotificationCenter.default nc.addObserver(self, selector: #selector(appMovedToBackground), name: UIApplication.didEnterBackgroundNotification, object: nil) nc.addObserver(self, selector: #selector(appMovedToForeground), name: UIApplication.willEnterForegroundNotification, object: nil) nc.addObserver(self, selector: #selector(appKilled), name: UIApplication.willTerminateNotification, object: nil) self.appMovedToForeground() self.checkForUpdateAfterDelay() } private func initialLoad() -> Bool { guard let bridge = self.bridge else { return false } let id = self.implementation.getCurrentBundleId() var dest: URL if BundleInfo.ID_BUILTIN == id { dest = Bundle.main.resourceURL!.appendingPathComponent("public") } else { dest = self.implementation.getBundleDirectory(id: id) } if !FileManager.default.fileExists(atPath: dest.path) { logger.error("Initial load fail - file at path \(dest.path) doesn't exist. Defaulting to buildin!! \(id)") dest = Bundle.main.resourceURL!.appendingPathComponent("public") } logger.info("Initial load \(id)") // We don't use the viewcontroller here as it does not work during the initial load state bridge.setServerBasePath(dest.path) return true } private func semaphoreWait(waitTime: Int) { // print("\(CapgoUpdater.TAG) semaphoreWait \(waitTime)") _ = semaphoreReady.wait(timeout: .now() + .milliseconds(waitTime)) } private func semaphoreUp() { DispatchQueue.global().async { self.semaphoreWait(waitTime: 0) } } private func semaphoreDown() { semaphoreReady.signal() } private func cleanupObsoleteVersions() { var LatestVersionNative: Version = "0.0.0" do { LatestVersionNative = try Version(UserDefaults.standard.string(forKey: "LatestVersionNative") ?? "0.0.0") } catch { logger.error("Cannot get version native \(currentVersionNative)") } if LatestVersionNative != "0.0.0" && self.currentVersionNative.description != LatestVersionNative.description { _ = self._reset(toLastSuccessful: false) let res = implementation.list() res.forEach { version in logger.info("Deleting obsolete bundle: \(version.getId())") let res = implementation.delete(id: version.getId()) if !res { logger.error("Delete failed, id \(version.getId()) doesn't exist") } } } UserDefaults.standard.set( self.currentVersionNative.description, forKey: "LatestVersionNative") UserDefaults.standard.synchronize() } @objc func notifyDownload(id: String, percent: Int, ignoreMultipleOfTen: Bool = false) { let bundle = self.implementation.getBundleInfo(id: id) self.notifyListeners("download", data: ["percent": percent, "bundle": bundle.toJSON()]) if percent == 100 { self.notifyListeners("downloadComplete", data: ["bundle": bundle.toJSON()]) self.implementation.sendStats(action: "download_complete", versionName: bundle.getVersionName()) } else if percent.isMultiple(of: 10) || ignoreMultipleOfTen { self.implementation.sendStats(action: "download_\(percent)", versionName: bundle.getVersionName()) } } @objc func setUpdateUrl(_ call: CAPPluginCall) { if !getConfig().getBoolean("allowModifyUrl", false) { logger.error("setUpdateUrl called without allowModifyUrl") call.reject("setUpdateUrl called without allowModifyUrl set allowModifyUrl in your config to true to allow it") return } guard let url = call.getString("url") else { logger.error("setUpdateUrl called without url") call.reject("setUpdateUrl called without url") return } self.updateUrl = url call.resolve() } @objc func setStatsUrl(_ call: CAPPluginCall) { if !getConfig().getBoolean("allowModifyUrl", false) { logger.error("setStatsUrl called without allowModifyUrl") call.reject("setStatsUrl called without allowModifyUrl set allowModifyUrl in your config to true to allow it") return } guard let url = call.getString("url") else { logger.error("setStatsUrl called without url") call.reject("setStatsUrl called without url") return } self.statsUrl = url call.resolve() } @objc func setChannelUrl(_ call: CAPPluginCall) { if !getConfig().getBoolean("allowModifyUrl", false) { logger.error("setChannelUrl called without allowModifyUrl") call.reject("setChannelUrl called without allowModifyUrl set allowModifyUrl in your config to true to allow it") return } guard let url = call.getString("url") else { logger.error("setChannelUrl called without url") call.reject("setChannelUrl called without url") return } self.implementation.channelUrl = url call.resolve() } @objc func getBuiltinVersion(_ call: CAPPluginCall) { call.resolve(["version": implementation.versionBuild]) } @objc func getDeviceId(_ call: CAPPluginCall) { call.resolve(["deviceId": implementation.deviceID]) } @objc func getPluginVersion(_ call: CAPPluginCall) { call.resolve(["version": self.PLUGIN_VERSION]) } @objc func download(_ call: CAPPluginCall) { guard let urlString = call.getString("url") else { logger.error("Download called without url") call.reject("Download called without url") return } guard let version = call.getString("version") else { logger.error("Download called without version") call.reject("Download called without version") return } let sessionKey = call.getString("sessionKey", "") var checksum = call.getString("checksum", "") let manifestArray = call.getArray("manifest") let url = URL(string: urlString) logger.info("Downloading \(String(describing: url))") DispatchQueue.global(qos: .background).async { do { let next: BundleInfo if let manifestArray = manifestArray { // Convert JSArray to [ManifestEntry] var manifestEntries: [ManifestEntry] = [] for item in manifestArray { if let manifestDict = item as? [String: Any] { let entry = ManifestEntry( file_name: manifestDict["file_name"] as? String, file_hash: manifestDict["file_hash"] as? String, download_url: manifestDict["download_url"] as? String ) manifestEntries.append(entry) } } next = try self.implementation.downloadManifest(manifest: manifestEntries, version: version, sessionKey: sessionKey) } else { next = try self.implementation.download(url: url!, version: version, sessionKey: sessionKey) } // If public key is present but no checksum provided, refuse installation if self.implementation.publicKey != "" && checksum == "" { self.logger.error("Public key present but no checksum provided") self.implementation.sendStats(action: "checksum_required", versionName: next.getVersionName()) let id = next.getId() let resDel = self.implementation.delete(id: id) if !resDel { self.logger.error("Delete failed, id \(id) doesn't exist") } throw ObjectSavableError.checksum } checksum = try CryptoCipherV2.decryptChecksum(checksum: checksum, publicKey: self.implementation.publicKey) if (checksum != "" || self.implementation.publicKey != "") && next.getChecksum() != checksum { self.logger.error("Error checksum \(next.getChecksum()) \(checksum)") self.implementation.sendStats(action: "checksum_fail", versionName: next.getVersionName()) let id = next.getId() let resDel = self.implementation.delete(id: id) if !resDel { self.logger.error("Delete failed, id \(id) doesn't exist") } throw ObjectSavableError.checksum } else { self.logger.info("Good checksum \(next.getChecksum()) \(checksum)") } self.notifyListeners("updateAvailable", data: ["bundle": next.toJSON()]) call.resolve(next.toJSON()) } catch { self.logger.error("Failed to download from: \(String(describing: url)) \(error.localizedDescription)") self.notifyListeners("downloadFailed", data: ["version": version]) self.implementation.sendStats(action: "download_fail") call.reject("Failed to download from: \(url!)", error.localizedDescription) } } } public func _reload() -> Bool { guard let bridge = self.bridge else { return false } self.semaphoreUp() let id = self.implementation.getCurrentBundleId() let dest: URL if BundleInfo.ID_BUILTIN == id { dest = Bundle.main.resourceURL!.appendingPathComponent("public") } else { dest = self.implementation.getBundleDirectory(id: id) } logger.info("Reloading \(id)") if let vc = bridge.viewController as? CAPBridgeViewController { guard let capBridge = vc.bridge else { logger.error("Cannot get capBridge") return false } // Use semaphore to wait for WebView load completion let loadSemaphore = DispatchSemaphore(value: 0) var loadSuccess = false // Set up navigation delegate to detect when loading completes let navigationDelegate = WebViewLoadDelegate { [weak self] success in loadSuccess = success if success { self?.checkAppReady() self?.notifyListeners("appReloaded", data: [:]) } loadSemaphore.signal() } if keepUrlPathAfterReload { DispatchQueue.main.async { guard let url = vc.webView?.url else { self.logger.error("vc.webView?.url is null?") loadSuccess = false loadSemaphore.signal() return } capBridge.setServerBasePath(dest.path) var urlComponents = URLComponents(url: capBridge.config.serverURL, resolvingAgainstBaseURL: false)! urlComponents.path = url.path if let finalUrl = urlComponents.url { vc.webView?.navigationDelegate = navigationDelegate _ = vc.webView?.load(URLRequest(url: finalUrl)) } else { loadSuccess = false loadSemaphore.signal() } } } else { vc.setServerBasePath(path: dest.path) // For setServerBasePath, we need to wait for the next page load vc.webView?.navigationDelegate = navigationDelegate // Trigger a reload to ensure the new path is loaded DispatchQueue.main.async { vc.webView?.reload() } } // Wait for load completion with timeout let result = loadSemaphore.wait(timeout: .now() + 10) // 10 second timeout if result == .timedOut { logger.error("Reload timed out after 10 seconds") DispatchQueue.main.async { vc.webView?.navigationDelegate = nil // Clean up } return false } return loadSuccess } return false } @objc func reload(_ call: CAPPluginCall) { if self._reload() { call.resolve() } else { logger.error("Reload failed") call.reject("Reload failed") } } @objc func next(_ call: CAPPluginCall) { guard let id = call.getString("id") else { logger.error("Next called without id") call.reject("Next called without id") return } logger.info("Setting next active id \(id)") if !self.implementation.setNextBundle(next: id) { logger.error("Set next version failed. id \(id) does not exist.") call.reject("Set next version failed. id \(id) does not exist.") } else { call.resolve(self.implementation.getBundleInfo(id: id).toJSON()) } } @objc func set(_ call: CAPPluginCall) { guard let id = call.getString("id") else { logger.error("Set called without id") call.reject("Set called without id") return } let res = implementation.set(id: id) logger.info("Set active bundle: \(id)") if !res { logger.info("Bundle successfully set to: \(id) ") call.reject("Update failed, id \(id) doesn't exist") } else { self.reload(call) } } @objc func delete(_ call: CAPPluginCall) { guard let id = call.getString("id") else { logger.error("Delete called without version") call.reject("Delete called without id") return } let res = implementation.delete(id: id) if res { call.resolve() } else { logger.error("Delete failed, id \(id) doesn't exist or it cannot be deleted (perhaps it is the 'next' bundle)") call.reject("Delete failed, id \(id) does not exist or it cannot be deleted (perhaps it is the 'next' bundle)") } } @objc func list(_ call: CAPPluginCall) { let raw = call.getBool("raw", false) let res = implementation.list(raw: raw) var resArr: [[String: String]] = [] for v in res { resArr.append(v.toJSON()) } call.resolve([ "bundles": resArr ]) } @objc func getLatest(_ call: CAPPluginCall) { let channel = call.getString("channel") DispatchQueue.global(qos: .background).async { let res = self.implementation.getLatest(url: URL(string: self.updateUrl)!, channel: channel) if res.error != nil { call.reject( res.error!) } else if res.message != nil { call.reject( res.message!) } else { call.resolve(res.toDict()) } } } @objc func unsetChannel(_ call: CAPPluginCall) { let triggerAutoUpdate = call.getBool("triggerAutoUpdate", false) DispatchQueue.global(qos: .background).async { let res = self.implementation.unsetChannel() if res.error != "" { call.reject(res.error, "UNSETCHANNEL_FAILED", nil, [ "message": res.error, "error": res.error.contains("Channel URL") ? "missing_config" : "request_failed" ]) } else { if self._isAutoUpdateEnabled() && triggerAutoUpdate { self.logger.info("Calling autoupdater after channel change!") self.backgroundDownload() } call.resolve(res.toDict()) } } } @objc func setChannel(_ call: CAPPluginCall) { guard let channel = call.getString("channel") else { logger.error("setChannel called without channel") call.reject("setChannel called without channel", "SETCHANNEL_INVALID_PARAMS", nil, [ "message": "setChannel called without channel", "error": "missing_parameter" ]) return } let triggerAutoUpdate = call.getBool("triggerAutoUpdate") ?? false DispatchQueue.global(qos: .background).async { let res = self.implementation.setChannel(channel: channel) if res.error != "" { call.reject(res.error, "SETCHANNEL_FAILED", nil, [ "message": res.error, "error": res.error.contains("Channel URL") ? "missing_config" : "request_failed" ]) } else { if self._isAutoUpdateEnabled() && triggerAutoUpdate { self.logger.info("Calling autoupdater after channel change!") self.backgroundDownload() } call.resolve(res.toDict()) } } } @objc func getChannel(_ call: CAPPluginCall) { DispatchQueue.global(qos: .background).async { let res = self.implementation.getChannel() if res.error != "" { call.reject(res.error, "GETCHANNEL_FAILED", nil, [ "message": res.error, "error": res.error.contains("Channel URL") ? "missing_config" : "request_failed" ]) } else { call.resolve(res.toDict()) } } } @objc func listChannels(_ call: CAPPluginCall) { DispatchQueue.global(qos: .background).async { let res = self.implementation.listChannels() if res.error != "" { call.reject(res.error, "LISTCHANNELS_FAILED", nil, [ "message": res.error, "error": res.error.contains("Channel URL") ? "missing_config" : "request_failed" ]) } else { call.resolve(res.toDict()) } } } @objc func setCustomId(_ call: CAPPluginCall) { guard let customId = call.getString("customId") else { logger.error("setCustomId called without customId") call.reject("setCustomId called without customId") return } self.implementation.customId = customId } @objc func _reset(toLastSuccessful: Bool) -> Bool { guard let bridge = self.bridge else { return false } if (bridge.viewController as? CAPBridgeViewController) != nil { let fallback: BundleInfo = self.implementation.getFallbackBundle() // If developer wants to reset to the last successful bundle, and that bundle is not // the built-in bundle, set it as the bundle to use and reload. if toLastSuccessful && !fallback.isBuiltin() { logger.info("Resetting to: \(fallback.toString())") return self.implementation.set(bundle: fallback) && self._reload() } logger.info("Resetting to builtin version") // Otherwise, reset back to the built-in bundle and reload. self.implementation.reset() return self._reload() } return false } @objc func reset(_ call: CAPPluginCall) { let toLastSuccessful = call.getBool("toLastSuccessful") ?? false if self._reset(toLastSuccessful: toLastSuccessful) { call.resolve() } else { logger.error("Reset failed") call.reject("Reset failed") } } @objc func current(_ call: CAPPluginCall) { let bundle: BundleInfo = self.implementation.getCurrentBundle() call.resolve([ "bundle": bundle.toJSON(), "native": self.currentVersionNative.description ]) } @objc func notifyAppReady(_ call: CAPPluginCall) { self.semaphoreDown() let bundle = self.implementation.getCurrentBundle() self.implementation.setSuccess(bundle: bundle, autoDeletePrevious: self.autoDeletePrevious) logger.info("Current bundle loaded successfully. [notifyAppReady was called] \(bundle.toString())") call.resolve(["bundle": bundle.toJSON()]) } @objc func setMultiDelay(_ call: CAPPluginCall) { guard let delayConditionList = call.getValue("delayConditions") else { logger.error("setMultiDelay called without delayCondition") call.reject("setMultiDelay called without delayCondition") return } // Handle background conditions with empty value (set to "0") if var modifiableList = delayConditionList as? [[String: Any]] { for i in 0.. Bool { let instanceDescriptor = (self.bridge?.viewController as? CAPBridgeViewController)?.instanceDescriptor() if instanceDescriptor?.serverURL != nil { logger.warn("AutoUpdate is automatic disabled when serverUrl is set.") } return self.autoUpdate && self.updateUrl != "" && instanceDescriptor?.serverURL == nil } @objc func isAutoUpdateEnabled(_ call: CAPPluginCall) { call.resolve([ "enabled": self._isAutoUpdateEnabled() ]) } @objc func isAutoUpdateAvailable(_ call: CAPPluginCall) { let instanceDescriptor = (self.bridge?.viewController as? CAPBridgeViewController)?.instanceDescriptor() let isAvailable = instanceDescriptor?.serverURL == nil call.resolve([ "available": isAvailable ]) } func checkAppReady() { self.appReadyCheck?.cancel() self.appReadyCheck = DispatchWorkItem(block: { self.DeferredNotifyAppReadyCheck() }) logger.info("Wait for \(self.appReadyTimeout) ms, then check for notifyAppReady") DispatchQueue.main.asyncAfter(deadline: .now() + .milliseconds(self.appReadyTimeout), execute: self.appReadyCheck!) } func checkRevert() { // Automatically roll back to fallback version if notifyAppReady has not been called yet let current: BundleInfo = self.implementation.getCurrentBundle() if current.isBuiltin() { logger.info("Built-in bundle is active. We skip the check for notifyAppReady.") return } logger.info("Current bundle is: \(current.toString())") if BundleStatus.SUCCESS.localizedString != current.getStatus() { logger.error("notifyAppReady was not called, roll back current bundle: \(current.toString())") logger.error("Did you forget to call 'notifyAppReady()' in your Capacitor App code?") self.notifyListeners("updateFailed", data: [ "bundle": current.toJSON() ]) self.implementation.sendStats(action: "update_fail", versionName: current.getVersionName()) self.implementation.setError(bundle: current) _ = self._reset(toLastSuccessful: true) if self.autoDeleteFailed && !current.isBuiltin() { logger.info("Deleting failing bundle: \(current.toString())") let res = self.implementation.delete(id: current.getId(), removeInfo: false) if !res { logger.info("Delete version deleted: \(current.toString())") } else { logger.error("Failed to delete failed bundle: \(current.toString())") } } } else { logger.info("notifyAppReady was called. This is fine: \(current.toString())") } } func DeferredNotifyAppReadyCheck() { self.checkRevert() self.appReadyCheck = nil } func endBackGroundTask() { UIApplication.shared.endBackgroundTask(self.backgroundTaskID) self.backgroundTaskID = UIBackgroundTaskIdentifier.invalid } func sendReadyToJs(current: BundleInfo, msg: String) { logger.info("sendReadyToJs") DispatchQueue.global().async { self.semaphoreWait(waitTime: self.appReadyTimeout) self.notifyListeners("appReady", data: ["bundle": current.toJSON(), "status": msg]) // Auto hide splashscreen if enabled // We show it on background when conditions are met, so we should hide it on foreground regardless of update outcome if self.autoSplashscreen { self.hideSplashscreen() } } } private func hideSplashscreen() { DispatchQueue.main.async { guard let bridge = self.bridge else { self.logger.warn("Bridge not available for hiding splashscreen with autoSplashscreen") return } // Create a plugin call for the hide method let call = CAPPluginCall(callbackId: "autoHideSplashscreen", options: [:], success: { (_, _) in self.logger.info("Splashscreen hidden automatically") }, error: { (_) in self.logger.error("Failed to auto-hide splashscreen") }) // Try to call the SplashScreen hide method directly through the bridge if let splashScreenPlugin = bridge.plugin(withName: "SplashScreen") { // Use runtime method invocation to call hide method let selector = NSSelectorFromString("hide:") if splashScreenPlugin.responds(to: selector) { _ = splashScreenPlugin.perform(selector, with: call) self.logger.info("Called SplashScreen hide method") } else { self.logger.warn("autoSplashscreen: SplashScreen plugin does not respond to hide: method. Make sure @capacitor/splash-screen plugin is properly installed.") } } else { self.logger.warn("autoSplashscreen: SplashScreen plugin not found. Install @capacitor/splash-screen plugin.") } } } private func showSplashscreen() { DispatchQueue.main.async { guard let bridge = self.bridge else { self.logger.warn("Bridge not available for showing splashscreen with autoSplashscreen") return } // Create a plugin call for the show method let call = CAPPluginCall(callbackId: "autoShowSplashscreen", options: [:], success: { (_, _) in self.logger.info("Splashscreen shown automatically") }, error: { (_) in self.logger.error("Failed to auto-show splashscreen") }) // Try to call the SplashScreen show method directly through the bridge if let splashScreenPlugin = bridge.plugin(withName: "SplashScreen") { // Use runtime method invocation to call show method let selector = NSSelectorFromString("show:") if splashScreenPlugin.responds(to: selector) { _ = splashScreenPlugin.perform(selector, with: call) self.logger.info("Called SplashScreen show method") } else { self.logger.warn("autoSplashscreen: SplashScreen plugin does not respond to show: method. Make sure @capacitor/splash-screen plugin is properly installed.") } } else { self.logger.warn("autoSplashscreen: SplashScreen plugin not found. Install @capacitor/splash-screen plugin.") } } } private func checkIfRecentlyInstalledOrUpdated() -> Bool { let userDefaults = UserDefaults.standard let currentVersion = self.currentVersionNative.description let lastKnownVersion = userDefaults.string(forKey: "LatestVersionNative") ?? "0.0.0" if lastKnownVersion == "0.0.0" { // First time running, consider it as recently installed return true } else if lastKnownVersion != currentVersion { // Version changed, consider it as recently updated return true } return false } private func shouldUseDirectUpdate() -> Bool { switch directUpdateMode { case "false": return false case "always": return true case "atInstall": if self.wasRecentlyInstalledOrUpdated { // Reset the flag after first use to prevent subsequent foreground events from using direct update self.wasRecentlyInstalledOrUpdated = false return true } return false default: return false } } func endBackGroundTaskWithNotif(msg: String, latestVersionName: String, current: BundleInfo, error: Bool = true) { if error { self.implementation.sendStats(action: "download_fail", versionName: current.getVersionName()) self.notifyListeners("downloadFailed", data: ["version": latestVersionName]) } self.notifyListeners("noNeedUpdate", data: ["bundle": current.toJSON()]) self.sendReadyToJs(current: current, msg: msg) logger.info("endBackGroundTaskWithNotif \(msg) current: \(current.getVersionName()) latestVersionName: \(latestVersionName)") self.endBackGroundTask() } func backgroundDownload() { let shouldDirectUpdate = self.shouldUseDirectUpdate() let messageUpdate = shouldDirectUpdate ? "Update will occur now." : "Update will occur next time app moves to background." guard let url = URL(string: self.updateUrl) else { logger.error("Error no url or wrong format") return } DispatchQueue.global(qos: .background).async { self.backgroundTaskID = UIApplication.shared.beginBackgroundTask(withName: "Finish Download Tasks") { // End the task if time expires. self.endBackGroundTask() } self.logger.info("Check for update via \(self.updateUrl)") let res = self.implementation.getLatest(url: url, channel: nil) let current = self.implementation.getCurrentBundle() // Handle network errors and other failures first if res.error != nil { self.logger.error("getLatest failed with error: \(res.error ?? "")") self.endBackGroundTaskWithNotif(msg: "Network error: \(res.error ?? "")", latestVersionName: res.version, current: current, error: true) return } if (res.message) != nil { self.logger.info("API message: \(res.message ?? "")") if res.major == true { self.notifyListeners("majorAvailable", data: ["version": res.version]) } self.endBackGroundTaskWithNotif(msg: res.message ?? "", latestVersionName: res.version, current: current, error: true) return } if res.version == "builtin" { self.logger.info("Latest version is builtin") if shouldDirectUpdate { self.logger.info("Direct update to builtin version") _ = self._reset(toLastSuccessful: false) self.endBackGroundTaskWithNotif(msg: "Updated to builtin version", latestVersionName: res.version, current: self.implementation.getCurrentBundle(), error: false) } else { self.logger.info("Setting next bundle to builtin") _ = self.implementation.setNextBundle(next: BundleInfo.ID_BUILTIN) self.endBackGroundTaskWithNotif(msg: "Next update will be to builtin version", latestVersionName: res.version, current: current, error: false) } return } let sessionKey = res.sessionKey ?? "" guard let downloadUrl = URL(string: res.url) else { self.logger.error("Error no url or wrong format") self.endBackGroundTaskWithNotif(msg: "Error no url or wrong format", latestVersionName: res.version, current: current) return } let latestVersionName = res.version if latestVersionName != "" && current.getVersionName() != latestVersionName { do { self.logger.info("New bundle: \(latestVersionName) found. Current is: \(current.getVersionName()). \(messageUpdate)") var nextImpl = self.implementation.getBundleInfoByVersionName(version: latestVersionName) if nextImpl == nil || nextImpl?.isDeleted() == true { if nextImpl?.isDeleted() == true { self.logger.info("Latest bundle already exists and will be deleted, download will overwrite it.") let res = self.implementation.delete(id: nextImpl!.getId(), removeInfo: true) if res { self.logger.info("Failed bundle deleted: \(nextImpl!.toString())") } else { self.logger.error("Failed to delete failed bundle: \(nextImpl!.toString())") } } if res.manifest != nil { nextImpl = try self.implementation.downloadManifest(manifest: res.manifest!, version: latestVersionName, sessionKey: sessionKey) } else { nextImpl = try self.implementation.download(url: downloadUrl, version: latestVersionName, sessionKey: sessionKey) } } guard let next = nextImpl else { self.logger.error("Error downloading file") self.endBackGroundTaskWithNotif(msg: "Error downloading file", latestVersionName: latestVersionName, current: current) return } if next.isErrorStatus() { self.logger.error("Latest bundle already exists and is in error state. Aborting update.") self.endBackGroundTaskWithNotif(msg: "Latest version is in error state. Aborting update.", latestVersionName: latestVersionName, current: current) return } res.checksum = try CryptoCipherV2.decryptChecksum(checksum: res.checksum, publicKey: self.implementation.publicKey) if res.checksum != "" && next.getChecksum() != res.checksum && res.manifest == nil { self.logger.error("Error checksum \(next.getChecksum()) \(res.checksum)") self.implementation.sendStats(action: "checksum_fail", versionName: next.getVersionName()) let id = next.getId() let resDel = self.implementation.delete(id: id) if !resDel { self.logger.error("Delete failed, id \(id) doesn't exist") } self.endBackGroundTaskWithNotif(msg: "Error checksum", latestVersionName: latestVersionName, current: current) return } if shouldDirectUpdate { let delayUpdatePreferences = UserDefaults.standard.string(forKey: DelayUpdateUtils.DELAY_CONDITION_PREFERENCES) ?? "[]" let delayConditionList: [DelayCondition] = self.fromJsonArr(json: delayUpdatePreferences).map { obj -> DelayCondition in let kind: String = obj.value(forKey: "kind") as! String let value: String? = obj.value(forKey: "value") as? String return DelayCondition(kind: kind, value: value) } if !delayConditionList.isEmpty { self.logger.info("Update delayed until delay conditions met") self.endBackGroundTaskWithNotif(msg: "Update delayed until delay conditions met", latestVersionName: latestVersionName, current: next, error: false) return } _ = self.implementation.set(bundle: next) _ = self._reload() self.endBackGroundTaskWithNotif(msg: "update installed", latestVersionName: latestVersionName, current: next, error: false) } else { self.notifyListeners("updateAvailable", data: ["bundle": next.toJSON()]) _ = self.implementation.setNextBundle(next: next.getId()) self.endBackGroundTaskWithNotif(msg: "update downloaded, will install next background", latestVersionName: latestVersionName, current: current, error: false) } return } catch { self.logger.error("Error downloading file \(error.localizedDescription)") let current: BundleInfo = self.implementation.getCurrentBundle() self.endBackGroundTaskWithNotif(msg: "Error downloading file", latestVersionName: latestVersionName, current: current) return } } else { self.logger.info("No need to update, \(current.getId()) is the latest bundle.") self.endBackGroundTaskWithNotif(msg: "No need to update, \(current.getId()) is the latest bundle.", latestVersionName: latestVersionName, current: current, error: false) return } } } @objc func appKilled() { logger.info("onActivityDestroyed: all activity destroyed") self.delayUpdateUtils.checkCancelDelay(source: .killed) } private func installNext() { let delayUpdatePreferences = UserDefaults.standard.string(forKey: DelayUpdateUtils.DELAY_CONDITION_PREFERENCES) ?? "[]" let delayConditionList: [DelayCondition] = fromJsonArr(json: delayUpdatePreferences).map { obj -> DelayCondition in let kind: String = obj.value(forKey: "kind") as! String let value: String? = obj.value(forKey: "value") as? String return DelayCondition(kind: kind, value: value) } if !delayConditionList.isEmpty { logger.info("Update delayed until delay conditions met") return } let current: BundleInfo = self.implementation.getCurrentBundle() let next: BundleInfo? = self.implementation.getNextBundle() if next != nil && !next!.isErrorStatus() && next!.getVersionName() != current.getVersionName() { logger.info("Next bundle is: \(next!.toString())") if self.implementation.set(bundle: next!) && self._reload() { logger.info("Updated to bundle: \(next!.toString())") _ = self.implementation.setNextBundle(next: Optional.none) } else { logger.error("Update to bundle: \(next!.toString()) Failed!") } } } @objc private func toJson(object: Any) -> String { guard let data = try? JSONSerialization.data(withJSONObject: object, options: []) else { return "" } return String(data: data, encoding: String.Encoding.utf8) ?? "" } @objc private func fromJsonArr(json: String) -> [NSObject] { guard let jsonData = json.data(using: .utf8) else { return [] } let object = try? JSONSerialization.jsonObject( with: jsonData, options: .mutableContainers ) as? [NSObject] return object ?? [] } @objc func appMovedToForeground() { let current: BundleInfo = self.implementation.getCurrentBundle() self.implementation.sendStats(action: "app_moved_to_foreground", versionName: current.getVersionName()) self.delayUpdateUtils.checkCancelDelay(source: .foreground) self.delayUpdateUtils.unsetBackgroundTimestamp() if backgroundWork != nil && taskRunning { backgroundWork!.cancel() logger.info("Background Timer Task canceled, Activity resumed before timer completes") } if self._isAutoUpdateEnabled() { self.backgroundDownload() } else { logger.info("Auto update is disabled") self.sendReadyToJs(current: current, msg: "disabled") } self.checkAppReady() } @objc func checkForUpdateAfterDelay() { if periodCheckDelay == 0 || !self._isAutoUpdateEnabled() { return } guard let url = URL(string: self.updateUrl) else { logger.error("Error no url or wrong format") return } let timer = Timer.scheduledTimer(withTimeInterval: TimeInterval(periodCheckDelay), repeats: true) { _ in DispatchQueue.global(qos: .background).async { let res = self.implementation.getLatest(url: url, channel: nil) let current = self.implementation.getCurrentBundle() if res.version != current.getVersionName() { self.logger.info("New version found: \(res.version)") self.backgroundDownload() } } } RunLoop.current.add(timer, forMode: .default) } @objc func appMovedToBackground() { let current: BundleInfo = self.implementation.getCurrentBundle() self.implementation.sendStats(action: "app_moved_to_background", versionName: current.getVersionName()) logger.info("Check for pending update") // Show splashscreen only if autoSplashscreen is enabled AND autoUpdate is enabled AND directUpdate would be used if self.autoSplashscreen { var canShowSplashscreen = true if !self._isAutoUpdateEnabled() { logger.warn("autoSplashscreen is enabled but autoUpdate is disabled. Splashscreen will not be shown. Enable autoUpdate or disable autoSplashscreen.") canShowSplashscreen = false } if !self.shouldUseDirectUpdate() { logger.warn("autoSplashscreen is enabled but directUpdate is not configured for immediate updates. Set directUpdate to 'always' or 'atInstall', or disable autoSplashscreen.") canShowSplashscreen = false } if canShowSplashscreen { self.showSplashscreen() } } // Set background timestamp let backgroundTimestamp = Int64(Date().timeIntervalSince1970 * 1000) // Convert to milliseconds self.delayUpdateUtils.setBackgroundTimestamp(backgroundTimestamp) self.delayUpdateUtils.checkCancelDelay(source: .background) self.installNext() } @objc func getNextBundle(_ call: CAPPluginCall) { let bundle = self.implementation.getNextBundle() if bundle == nil || bundle?.isUnknown() == true { call.resolve() return } call.resolve(bundle!.toJSON()) } @objc func setShakeMenu(_ call: CAPPluginCall) { guard let enabled = call.getBool("enabled") else { logger.error("setShakeMenu called without enabled parameter") call.reject("setShakeMenu called without enabled parameter") return } self.shakeMenuEnabled = enabled logger.info("Shake menu \(enabled ? "enabled" : "disabled")") call.resolve() } @objc func isShakeMenuEnabled(_ call: CAPPluginCall) { call.resolve([ "enabled": self.shakeMenuEnabled ]) } }