@capgo/capacitor-updater 4.0.0-alpha.9 → 4.0.0

package/ios/Plugin/CapacitorUpdater.swift

@@ -1,6 +1,7 @@
 import Foundation
 import SSZipArchive
 import Alamofire
+import zlib
 
 extension URL {
     var isDirectory: Bool {
@@ -47,10 +48,10 @@ extension OperatingSystemVersion {
     }
 }
 extension Bundle {
-    var releaseVersionNumber: String? {
+    var versionName: String? {
         return infoDictionary?["CFBundleShortVersionString"] as? String
     }
-    var buildVersionNumber: String? {
+    var versionCode: String? {
         return infoDictionary?["CFBundleVersion"] as? String
     }
 }
@@ -131,8 +132,8 @@ extension CustomError: LocalizedError {
 
 @objc public class CapacitorUpdater: NSObject {
     
-    private let versionBuild = Bundle.main.releaseVersionNumber ?? ""
-    private let versionCode = Bundle.main.buildVersionNumber ?? ""
+    private let versionName = Bundle.main.versionName ?? ""
+    private let versionCode = Bundle.main.versionCode ?? ""
     private let versionOs = ProcessInfo().operatingSystemVersion.getFullVersion()
     private let documentsDir = FileManager.default.urls(for: .documentDirectory, in: .userDomainMask).first!
     private let libraryDir = FileManager.default.urls(for: .libraryDirectory, in: .userDomainMask).first!
@@ -142,13 +143,10 @@ extension CustomError: LocalizedError {
     private let INFO_SUFFIX = "_info"
     private let FALLBACK_VERSION = "pastVersion"
     private let NEXT_VERSION = "nextVersion"
-
-    private var lastPathHot = ""
-    private var lastPathPersist = ""
     
     public let TAG = "✨  Capacitor-updater:";
     public let CAP_SERVER_PATH = "serverBasePath"
-    public let pluginVersion = "4.0.0-alpha.9"
+    public let pluginVersion = "4.0.0"
     public var statsUrl = ""
     public var appId = ""
     public var deviceID = UIDevice.current.identifierForVendor?.uuidString ?? ""
@@ -204,8 +202,19 @@ extension CustomError: LocalizedError {
             throw CustomError.cannotUnflat
         }
     }
+
+    private func getChecksum(filePath: URL) -> String {
+        do {
+            let fileData = try Data.init(contentsOf: filePath)
+            let checksum = fileData.withUnsafeBytes { crc32(0, $0.bindMemory(to: Bytef.self).baseAddress, uInt(fileData.count)) }
+            return String(format:"%08X", checksum).lowercased()
+        } catch {
+            print("\(self.TAG) Cannot get checksum: \(filePath.path)", error)
+            return ""
+        }
+    }
     
-    private func saveDownloaded(sourceZip: URL, id: String, base: URL) throws {
+    private func saveDownloaded(sourceZip: URL, id: String, base: URL) throws  {
         try prepareFolder(source: base)
         let destHot = base.appendingPathComponent(id)
         let destUnZip = documentsDir.appendingPathComponent(randomString(length: 10))
@@ -217,19 +226,20 @@ extension CustomError: LocalizedError {
         }
     }
 
-    public func getLatest(url: URL) -> AppVersion? {
+    public func getLatest(url: URL) -> AppVersion {
         let semaphore = DispatchSemaphore(value: 0)
         let latest = AppVersion()
         let parameters: [String: String] = [
             "platform": "ios",
             "device_id": self.deviceID,
             "app_id": self.appId,
-            "version_build": self.versionBuild,
+            "version_build": self.versionName,
             "version_code": self.versionCode,
             "version_os": self.versionOs,
             "plugin_version": self.pluginVersion,
             "version_name": self.getCurrentBundle().getVersionName()
         ]
+        print("\(self.TAG) Auto-update parameters: \(parameters)")
         let request = AF.request(url, method: .post,parameters: parameters, encoder: JSONParameterEncoder.default)
 
         request.validate().responseDecodable(of: AppVersionDec.self) { response in
@@ -246,7 +256,6 @@ extension CustomError: LocalizedError {
                     }
                     if let message = response.value?.message {
                         latest.message = message
-                        print("\(self.TAG) Auto-update message: \(message)")
                     }
                 case let .failure(error):
                     print("\(self.TAG) Error getting Latest", error )
@@ -254,18 +263,19 @@ extension CustomError: LocalizedError {
             semaphore.signal()
         }
         semaphore.wait()
-        return latest.url != "" ? latest : nil
+        return latest
     }
     
     private func setCurrentBundle(bundle: String) {
         UserDefaults.standard.set(bundle, forKey: self.CAP_SERVER_PATH)
-        print("\(self.TAG) Current bundle set to: \(bundle)")
         UserDefaults.standard.synchronize()
+        print("\(self.TAG) Current bundle set to: \(bundle == "" ? BundleInfo.ID_BUILTIN : bundle)")
     }
 
     public func download(url: URL, version: String) throws -> BundleInfo {
         let semaphore = DispatchSemaphore(value: 0)
         let id: String = self.randomString(length: 10)
+        var checksum = ""
         var mainError: NSError? = nil
         let destination: DownloadRequest.Destination = { _, _ in
             let documentsURL = FileManager.default.urls(for: .documentDirectory, in: .userDomainMask)[0]
@@ -285,6 +295,7 @@ extension CustomError: LocalizedError {
                 case .success:
                     self.notifyDownload(id, 71)
                     do {
+                        checksum = self.getChecksum(filePath: fileURL)
                         try self.saveDownloaded(sourceZip: fileURL, id: id, base: self.documentsDir.appendingPathComponent(self.bundleDirectoryHot))
                         self.notifyDownload(id, 85)
                         try self.saveDownloaded(sourceZip: fileURL, id: id, base: self.libraryDir.appendingPathComponent(self.bundleDirectory))
@@ -301,13 +312,13 @@ extension CustomError: LocalizedError {
             }
             semaphore.signal()
         }
-        self.saveBundleInfo(id: id, bundle: BundleInfo(id: id, version: version, status: BundleStatus.DOWNLOADING, downloaded: Date()))
+        self.saveBundleInfo(id: id, bundle: BundleInfo(id: id, version: version, status: BundleStatus.DOWNLOADING, downloaded: Date(), checksum: checksum))
         self.notifyDownload(id, 0)
         semaphore.wait()
         if (mainError != nil) {
             throw mainError!
         }
-        let info: BundleInfo = BundleInfo(id: id, version: version, status: BundleStatus.PENDING, downloaded: Date())
+        let info: BundleInfo = BundleInfo(id: id, version: version, status: BundleStatus.PENDING, downloaded: Date(), checksum: checksum)
         self.saveBundleInfo(id: id, bundle: info)
         return info
     }
@@ -330,8 +341,12 @@ extension CustomError: LocalizedError {
         }
     }
     
-    public func delete(id: String) -> Bool {
+    public func delete(id: String, removeInfo: Bool) -> Bool {
         let deleted: BundleInfo = self.getBundleInfo(id: id)
+        if (deleted.isBuiltin() || self.getCurrentBundleId() == id) {
+            print("\(self.TAG) Cannot delete \(id)")
+            return false
+        }
         let destHot = documentsDir.appendingPathComponent(bundleDirectoryHot).appendingPathComponent(id)
         let destPersist = libraryDir.appendingPathComponent(bundleDirectory).appendingPathComponent(id)
         do {
@@ -345,11 +360,18 @@ extension CustomError: LocalizedError {
             print("\(self.TAG) Folder \(destPersist.path), not removed.")
             return false
         }
+        if (removeInfo) {
+            self.removeBundleInfo(id: id)
+        }
         self.removeBundleInfo(id: id)
-        self.sendStats(action: "delete", bundle: deleted)
+        self.sendStats(action: "delete", versionName: deleted.getVersionName())
         return true
     }
 
+    public func delete(id: String) -> Bool {
+        return self.delete(id: id, removeInfo: true)
+    }
+
     public func getBundleDirectory(id: String) -> URL {
         return libraryDir.appendingPathComponent(self.bundleDirectory).appendingPathComponent(id)
     }
@@ -358,21 +380,31 @@ extension CustomError: LocalizedError {
         return self.set(id: bundle.getId());
     }
 
-    public func set(id: String) -> Bool {
+    private func bundleExists(id: String) -> Bool {
         let destHot = self.getPathHot(id: id)
         let destHotPersist = self.getPathPersist(id: id)
         let indexHot = destHot.appendingPathComponent("index.html")
         let indexPersist = destHotPersist.appendingPathComponent("index.html")
-        let existing: BundleInfo = self.getBundleInfo(id: id)
-        let bundle: URL = self.getBundleDirectory(id: id)
-        print("bundle", bundle.path)
-        if (bundle.isDirectory && destHotPersist.isDirectory && indexHot.exist && indexPersist.exist) {
-            self.setCurrentBundle(bundle: String(bundle.path.suffix(10)))
+        let url: URL = self.getBundleDirectory(id: id)
+        if(url.isDirectory && destHotPersist.isDirectory && indexHot.exist && indexPersist.exist) {
+            return true;
+        }
+        return false;
+    }
+
+    public func set(id: String) -> Bool {
+        let newBundle: BundleInfo = self.getBundleInfo(id: id)
+        if(newBundle.isBuiltin()) {
+            self.reset()
+            return true
+        }
+        if (bundleExists(id: id)) {
+            self.setCurrentBundle(bundle: self.getBundleDirectory(id: id).path)
             self.setBundleStatus(id: id, status: BundleStatus.PENDING)
-            sendStats(action: "set", bundle: existing)
+            sendStats(action: "set", versionName: newBundle.getVersionName())
             return true
         }
-        sendStats(action: "set_fail", bundle: existing)
+        sendStats(action: "set_fail", versionName: newBundle.getVersionName())
         return false
     }
     
@@ -389,32 +421,43 @@ extension CustomError: LocalizedError {
     }
     
     public func reset(isInternal: Bool) {
+        print("\(self.TAG) reset: \(isInternal)")
         self.setCurrentBundle(bundle: "")
-        self.setFallbackVersion(fallback: Optional<BundleInfo>.none)
-        let _ = self.setNextVersion(next: Optional<String>.none)
-        UserDefaults.standard.synchronize()
+        self.setFallbackBundle(fallback: Optional<BundleInfo>.none)
+        let _ = self.setNextBundle(next: Optional<String>.none)
         if(!isInternal) {
-            sendStats(action: "reset", bundle: self.getCurrentBundle())
+            sendStats(action: "reset", versionName: self.getCurrentBundle().getVersionName())
         }
     }
     
-    public func commit(bundle: BundleInfo) {
+    public func setSuccess(bundle: BundleInfo, autoDeletePrevious: Bool) {
         self.setBundleStatus(id: bundle.getId(), status: BundleStatus.SUCCESS)
-        self.setFallbackVersion(fallback: bundle)
+        let fallback: BundleInfo = self.getFallbackBundle()
+        print("\(self.TAG) Fallback bundle is: \(fallback.toString())")
+        print("\(self.TAG) Version successfully loaded: \(bundle.toString())")
+        if(autoDeletePrevious && !fallback.isBuiltin()) {
+            let res = self.delete(id: fallback.getId())
+            if (res) {
+                print("\(self.TAG) Deleted previous bundle: \(fallback.toString())")
+            } else {
+                print("\(self.TAG) Failed to delete previous bundle: \(fallback.toString())")
+            }
+        }
+        self.setFallbackBundle(fallback: bundle)
     }
     
-    public func rollback(bundle: BundleInfo) {
+    public func setError(bundle: BundleInfo) {
         self.setBundleStatus(id: bundle.getId(), status: BundleStatus.ERROR);
     }
 
-    func sendStats(action: String, bundle: BundleInfo) {
+    func sendStats(action: String, versionName: String) {
         if (statsUrl == "") { return }
         let parameters: [String: String] = [
             "platform": "ios",
             "action": action,
             "device_id": self.deviceID,
-            "version_name": bundle.getVersionName(),
-            "version_build": self.versionBuild,
+            "version_name": versionName,
+            "version_build": self.versionName,
             "version_code": self.versionCode,
             "version_os": self.versionOs,
             "plugin_version": self.pluginVersion,
@@ -423,23 +466,31 @@ extension CustomError: LocalizedError {
 
         DispatchQueue.global(qos: .background).async {
             let _ = AF.request(self.statsUrl, method: .post,parameters: parameters, encoder: JSONParameterEncoder.default)
-            print("\(self.TAG) Stats send for \(action), version \(bundle.getVersionName())")
+            print("\(self.TAG) Stats send for \(action), version \(versionName)")
         }
     }
 
-    public func getBundleInfo(id: String = BundleInfo.ID_BUILTIN) -> BundleInfo {
-        print("\(self.TAG) Getting info for bundle [\(id)]")
-        if(BundleInfo.ID_BUILTIN == id) {
-            return BundleInfo(id: id, version: "", status: BundleStatus.SUCCESS)
+    public func getBundleInfo(id: String?) -> BundleInfo {
+        var trueId = BundleInfo.VERSION_UNKNOWN
+        if(id != nil) {
+            trueId = id!
         }
-        do {
-            let result: BundleInfo = try UserDefaults.standard.getObj(forKey: "\(id)\(self.INFO_SUFFIX)", castTo: BundleInfo.self)
-            print("\(self.TAG) Returning info bundle [\(id)]", result.toString())
-            return result
-        } catch {
-            print("\(self.TAG) Failed to parse info for bundle [\(id)]", error.localizedDescription)
-            return BundleInfo(id: id, version: "", status: BundleStatus.PENDING)
+        print("\(self.TAG) Getting info for bundle [\(trueId)]")
+        let result: BundleInfo;
+        if(BundleInfo.ID_BUILTIN == trueId) {
+            result = BundleInfo(id: trueId, version: "", status: BundleStatus.SUCCESS, checksum: "")
+        } else if (BundleInfo.VERSION_UNKNOWN == trueId) {
+            result = BundleInfo(id: trueId, version: "", status: BundleStatus.ERROR, checksum: "")
+        } else {
+            do {
+                result = try UserDefaults.standard.getObj(forKey: "\(trueId)\(self.INFO_SUFFIX)", castTo: BundleInfo.self)
+            } catch {
+                print("\(self.TAG) Failed to parse info for bundle [\(trueId)]", error.localizedDescription)
+                result = BundleInfo(id: trueId, version: "", status: BundleStatus.PENDING, checksum: "")
+            }
         }
+        print("\(self.TAG) Returning info bundle [\(result.toString())]")
+        return result;
     }
 
     public func getBundleInfoByVersionName(version: String) -> BundleInfo? {
@@ -488,57 +539,54 @@ extension CustomError: LocalizedError {
         self.saveBundleInfo(id: id, bundle: info.setStatus(status: status.localizedString))
     }
 
-    private func getCurrentBundleVersion() -> String {
-        if(self.isUsingBuiltin()) {
-            return BundleInfo.ID_BUILTIN
-        } else {
-            let path: String = self.getCurrentBundleId()
-            return path.lastPathComponent
-        }
-    }
-
     public func getCurrentBundle() -> BundleInfo {
         return self.getBundleInfo(id: self.getCurrentBundleId());
     }
 
     public func getCurrentBundleId() -> String {
-        return UserDefaults.standard.string(forKey: self.CAP_SERVER_PATH) ?? self.DEFAULT_FOLDER
+        guard let bundlePath = UserDefaults.standard.string(forKey: self.CAP_SERVER_PATH) else {
+            return BundleInfo.ID_BUILTIN
+        }
+        if (bundlePath == "") {
+            return BundleInfo.ID_BUILTIN
+        }
+        let bundleID = bundlePath.components(separatedBy: "/").last ?? bundlePath
+        return bundleID
     }
 
     public func isUsingBuiltin() -> Bool {
-        return self.getCurrentBundleId() == self.DEFAULT_FOLDER
+        return (UserDefaults.standard.string(forKey: self.CAP_SERVER_PATH) ?? "") == self.DEFAULT_FOLDER
     }
 
-    public func getFallbackVersion() -> BundleInfo {
+    public func getFallbackBundle() -> BundleInfo {
         let id: String = UserDefaults.standard.string(forKey: self.FALLBACK_VERSION) ?? BundleInfo.ID_BUILTIN
         return self.getBundleInfo(id: id)
     }
 
-    private func setFallbackVersion(fallback: BundleInfo?) {
+    private func setFallbackBundle(fallback: BundleInfo?) {
         UserDefaults.standard.set(fallback == nil ? BundleInfo.ID_BUILTIN : fallback!.getId(), forKey: self.FALLBACK_VERSION)
+        UserDefaults.standard.synchronize()
     }
 
-    public func getNextVersion() -> BundleInfo? {
-        let id: String = UserDefaults.standard.string(forKey: self.NEXT_VERSION) ?? ""
-        if(id != "") {
-            return self.getBundleInfo(id: id)
-        } else {
-            return nil
-        }
+    public func getNextBundle() -> BundleInfo? {
+        let id: String? = UserDefaults.standard.string(forKey: self.NEXT_VERSION)
+        return self.getBundleInfo(id: id)
     }
 
-    public func setNextVersion(next: String?) -> Bool {
-        if (next == nil) {
+    public func setNextBundle(next: String?) -> Bool {
+        guard let nextId = next else {
             UserDefaults.standard.removeObject(forKey: self.NEXT_VERSION)
-        } else {
-            let bundle: URL = self.getBundleDirectory(id: next!)
-            if (!bundle.exist) {
-                return false
-            }
-            UserDefaults.standard.set(next, forKey: self.NEXT_VERSION)
-            self.setBundleStatus(id: next!, status: BundleStatus.PENDING);
+            UserDefaults.standard.synchronize()
+            return false
+        }
+        let newBundle: BundleInfo = self.getBundleInfo(id: nextId)
+        let bundle: URL = self.getBundleDirectory(id: nextId)
+        if (!newBundle.isBuiltin() && !bundle.exist) {
+            return false
         }
+        UserDefaults.standard.set(nextId, forKey: self.NEXT_VERSION)
         UserDefaults.standard.synchronize()
+        self.setBundleStatus(id: nextId, status: BundleStatus.PENDING)
         return true
     }
 }

package/ios/Plugin/CapacitorUpdaterPlugin.m

@@ -13,8 +13,9 @@ CAP_PLUGIN(CapacitorUpdaterPlugin, "CapacitorUpdater",
            CAP_PLUGIN_METHOD(reload, CAPPluginReturnPromise);
            CAP_PLUGIN_METHOD(notifyAppReady, CAPPluginReturnPromise);
            CAP_PLUGIN_METHOD(setDelay, CAPPluginReturnPromise);
+           CAP_PLUGIN_METHOD(cancelDelay, CAPPluginReturnPromise);
            CAP_PLUGIN_METHOD(getLatest, CAPPluginReturnPromise);
-           CAP_PLUGIN_METHOD(getId, CAPPluginReturnPromise);
+           CAP_PLUGIN_METHOD(getDeviceId, CAPPluginReturnPromise);
            CAP_PLUGIN_METHOD(getPluginVersion, CAPPluginReturnPromise);
            CAP_PLUGIN_METHOD(next, CAPPluginReturnPromise);
            CAP_PLUGIN_METHOD(isAutoUpdateEnabled, CAPPluginReturnPromise);