From e95f42b15686ad547a919ddaef18d75eac9bf5d9 Mon Sep 17 00:00:00 2001 From: Zorg Date: Sat, 3 Oct 2026 21:16:37 -0700 Subject: [PATCH] Download and install newer update while prior one is in flight (#2928) The update cycle is refactored and simplified. Notably we remove a suite of classes (automatic, probe, UI scheduled, UI initiated, core, basic, more..) and collapse them into a single update driver. If the update driver is started in automatic mode, it can escalate into UI mode without ending the cycle (previously we would end the cycle and flag that the next cycle had to be started in a UI mode carrying the previous update). SPUUpdater doesn't do installer progress queries anymore and thus these have been reduced. Even if a prior update has been downloaded before, the updater uses the regular scheduled check interval and the update driver is responsible for determining whether or not the impatient update interval has elapsed. Every update check checks if a newer superseded update is available and if it should replace any updates that have been previously been downloaded or started installing. The two conditions we do not check for superseded updates is if the installer is ran in the system domain (requiring authorization), and updating other bundles from an external updater (to not conflict with apps self-updating themselves). This change adds a UI test to test a superseded update is downloaded and began to install automatically. Fixes #2469. Previous attempt was in #2908 but I decided that was hacking the current architecture too much and exposing issues making it hard to implement this functionality correctly. Used AI for much of this refactoring, reviewing, and code implementation. --- Sparkle.xcodeproj/project.pbxproj | 90 +- .../xcschemes/Sparkle Test App.xcscheme | 5 + Sparkle/SPUAutomaticUpdateDriver.h | 23 - Sparkle/SPUAutomaticUpdateDriver.m | 155 --- Sparkle/SPUBasicUpdateDriver.h | 46 - Sparkle/SPUBasicUpdateDriver.m | 292 ----- Sparkle/SPUCoreBasedUpdateDriver.h | 77 -- Sparkle/SPUCoreBasedUpdateDriver.m | 402 ------- Sparkle/SPUDownloadedUpdate.h | 8 +- Sparkle/SPUDownloadedUpdate.m | 2 - Sparkle/SPUInformationalUpdate.h | 20 - Sparkle/SPUInformationalUpdate.m | 31 - Sparkle/SPUInstallerDriver.m | 36 +- Sparkle/SPUProbingUpdateDriver.h | 23 - Sparkle/SPUProbingUpdateDriver.m | 90 -- Sparkle/SPUReleaseNotesDriver.h | 27 + Sparkle/SPUReleaseNotesDriver.m | 121 ++ Sparkle/SPUResumableUpdate.h | 22 - Sparkle/SPUScheduledUpdateDriver.h | 24 - Sparkle/SPUScheduledUpdateDriver.m | 109 -- Sparkle/SPUUIBasedUpdateDriver.h | 48 - Sparkle/SPUUIBasedUpdateDriver.m | 507 -------- Sparkle/SPUUpdateDriver.h | 57 +- Sparkle/SPUUpdateDriver.m | 1053 +++++++++++++++++ Sparkle/SPUUpdater.m | 293 ++--- Sparkle/SPUUpdaterTimer.m | 9 +- Sparkle/SPUUserDriver.h | 2 +- Sparkle/SPUUserInitiatedUpdateDriver.h | 23 - Sparkle/SPUUserInitiatedUpdateDriver.m | 149 --- Sparkle/SUAppcastDriver.h | 2 +- Sparkle/SUAppcastDriver.m | 16 +- Sparkle/SUErrors.h | 1 + TestApplication/SUTestApplicationDelegate.m | 225 +++- TestApplication/sparkletestcast.xml | 28 + UITests/SUTestApplicationTest.swift | 45 + 35 files changed, 1670 insertions(+), 2391 deletions(-) delete mode 100644 Sparkle/SPUAutomaticUpdateDriver.h delete mode 100644 Sparkle/SPUAutomaticUpdateDriver.m delete mode 100644 Sparkle/SPUBasicUpdateDriver.h delete mode 100644 Sparkle/SPUBasicUpdateDriver.m delete mode 100644 Sparkle/SPUCoreBasedUpdateDriver.h delete mode 100644 Sparkle/SPUCoreBasedUpdateDriver.m delete mode 100644 Sparkle/SPUInformationalUpdate.h delete mode 100644 Sparkle/SPUInformationalUpdate.m delete mode 100644 Sparkle/SPUProbingUpdateDriver.h delete mode 100644 Sparkle/SPUProbingUpdateDriver.m create mode 100644 Sparkle/SPUReleaseNotesDriver.h create mode 100644 Sparkle/SPUReleaseNotesDriver.m delete mode 100644 Sparkle/SPUResumableUpdate.h delete mode 100644 Sparkle/SPUScheduledUpdateDriver.h delete mode 100644 Sparkle/SPUScheduledUpdateDriver.m delete mode 100644 Sparkle/SPUUIBasedUpdateDriver.h delete mode 100644 Sparkle/SPUUIBasedUpdateDriver.m create mode 100644 Sparkle/SPUUpdateDriver.m delete mode 100644 Sparkle/SPUUserInitiatedUpdateDriver.h delete mode 100644 Sparkle/SPUUserInitiatedUpdateDriver.m diff --git a/Sparkle.xcodeproj/project.pbxproj b/Sparkle.xcodeproj/project.pbxproj index da97d527..d0ca721f 100644 --- a/Sparkle.xcodeproj/project.pbxproj +++ b/Sparkle.xcodeproj/project.pbxproj @@ -168,8 +168,6 @@ 72266A8B29464CEA00645376 /* SUHost.m in Sources */ = {isa = PBXBuildFile; fileRef = 61EF67550E25B58D00F754E0 /* SUHost.m */; }; 72266A8C29464D0200645376 /* SUSignatures.m in Sources */ = {isa = PBXBuildFile; fileRef = EA1E286D22B665E8004AA304 /* SUSignatures.m */; }; 7229E1B61C97C91100CB50D0 /* SPUUpdateDriver.h in Headers */ = {isa = PBXBuildFile; fileRef = 7229E1B51C97C91100CB50D0 /* SPUUpdateDriver.h */; }; - 7229E1B91C97CC4D00CB50D0 /* SPUScheduledUpdateDriver.h in Headers */ = {isa = PBXBuildFile; fileRef = 7229E1B71C97CC4D00CB50D0 /* SPUScheduledUpdateDriver.h */; }; - 7229E1BA1C97CC4D00CB50D0 /* SPUScheduledUpdateDriver.m in Sources */ = {isa = PBXBuildFile; fileRef = 7229E1B81C97CC4D00CB50D0 /* SPUScheduledUpdateDriver.m */; }; 7229E1BD1C98EFF200CB50D0 /* SPUDownloadDriver.h in Headers */ = {isa = PBXBuildFile; fileRef = 7229E1BB1C98EFF200CB50D0 /* SPUDownloadDriver.h */; }; 7229E1BE1C98EFF200CB50D0 /* SPUDownloadDriver.m in Sources */ = {isa = PBXBuildFile; fileRef = 7229E1BC1C98EFF200CB50D0 /* SPUDownloadDriver.m */; }; 722C9539286EA68C0033908A /* SPUGentleUserDriverReminders.h in Headers */ = {isa = PBXBuildFile; fileRef = 722C9538286EA54A0033908A /* SPUGentleUserDriverReminders.h */; settings = {ATTRIBUTES = (Private, ); }; }; @@ -302,7 +300,6 @@ 7267E5F81D3D91A800D1BF90 /* SUPipedUnarchiver.m in Sources */ = {isa = PBXBuildFile; fileRef = 7267E5831D3D89B300D1BF90 /* SUPipedUnarchiver.m */; }; 7267E5F91D3D92DA00D1BF90 /* Autoupdate in Copy Tools */ = {isa = PBXBuildFile; fileRef = 72B398D21D3D879300EE297F /* Autoupdate */; settings = {ATTRIBUTES = (CodeSignOnCopy, ); }; }; 7267E5FA1D3DAC3600D1BF90 /* StatusInfo.m in Sources */ = {isa = PBXBuildFile; fileRef = 7267E5A41D3D8A8A00D1BF90 /* StatusInfo.m */; }; - 7267E5FD1D3DD1B700D1BF90 /* SPUResumableUpdate.h in Headers */ = {isa = PBXBuildFile; fileRef = 7267E5FB1D3DD1B700D1BF90 /* SPUResumableUpdate.h */; }; 7269E494264798200088C213 /* SPUSkippedUpdate.h in Headers */ = {isa = PBXBuildFile; fileRef = 7269E492264798200088C213 /* SPUSkippedUpdate.h */; }; 7269E496264798200088C213 /* SPUSkippedUpdate.m in Sources */ = {isa = PBXBuildFile; fileRef = 7269E493264798200088C213 /* SPUSkippedUpdate.m */; }; 7269E4982648D3460088C213 /* SPUSkippedUpdate.m in Sources */ = {isa = PBXBuildFile; fileRef = 7269E493264798200088C213 /* SPUSkippedUpdate.m */; }; @@ -359,6 +356,8 @@ 729F7EB0273F1840004592DC /* SPUUserAgent+Private.m in Sources */ = {isa = PBXBuildFile; fileRef = 729F7EAE273F1840004592DC /* SPUUserAgent+Private.m */; }; 729F7ECE27409077004592DC /* SparkleTestCodeSignApp_bad_extraneous.zip in Resources */ = {isa = PBXBuildFile; fileRef = 729F7ECD27409076004592DC /* SparkleTestCodeSignApp_bad_extraneous.zip */; }; 72A1C2631CD6849C004CD282 /* SUUpdatePermissionPrompt.h in Headers */ = {isa = PBXBuildFile; fileRef = 612DCBAD0D488BC60015DBEA /* SUUpdatePermissionPrompt.h */; }; + 72A1C982305EC3E10009ECA3 /* SPUReleaseNotesDriver.m in Sources */ = {isa = PBXBuildFile; fileRef = 72A1C981305EC3E10009ECA3 /* SPUReleaseNotesDriver.m */; }; + 72A1C983305EC3E10009ECA3 /* SPUReleaseNotesDriver.h in Headers */ = {isa = PBXBuildFile; fileRef = 72A1C980305EC3E10009ECA3 /* SPUReleaseNotesDriver.h */; }; 72A450531C69A68900D67EEA /* SUUpdatePermissionResponse.h in Headers */ = {isa = PBXBuildFile; fileRef = 72A450511C69A68900D67EEA /* SUUpdatePermissionResponse.h */; settings = {ATTRIBUTES = (Public, ); }; }; 72A450541C69A68900D67EEA /* SUUpdatePermissionResponse.m in Sources */ = {isa = PBXBuildFile; fileRef = 72A450521C69A68900D67EEA /* SUUpdatePermissionResponse.m */; }; 72A4A2401BB6567D00E7820D /* SUFileManagerTest.swift in Sources */ = {isa = PBXBuildFile; fileRef = 72A4A23F1BB6567D00E7820D /* SUFileManagerTest.swift */; }; @@ -374,24 +373,10 @@ 72AEB1D929A1CB510033883E /* SPUNoUpdateFoundInfo.m in Sources */ = {isa = PBXBuildFile; fileRef = 72AEB1D729A1CB510033883E /* SPUNoUpdateFoundInfo.m */; }; 72B3DEC91E23472200457642 /* SPUDownloadedUpdate.h in Headers */ = {isa = PBXBuildFile; fileRef = 72B3DEC71E23472200457642 /* SPUDownloadedUpdate.h */; }; 72B3DECA1E23472200457642 /* SPUDownloadedUpdate.m in Sources */ = {isa = PBXBuildFile; fileRef = 72B3DEC81E23472200457642 /* SPUDownloadedUpdate.m */; }; - 72B3DECD1E23479000457642 /* SPUInformationalUpdate.h in Headers */ = {isa = PBXBuildFile; fileRef = 72B3DECB1E23479000457642 /* SPUInformationalUpdate.h */; }; - 72B3DECF1E23479000457642 /* SPUInformationalUpdate.m in Sources */ = {isa = PBXBuildFile; fileRef = 72B3DECC1E23479000457642 /* SPUInformationalUpdate.m */; }; 72B767CA1C9B707000A07552 /* SUAppcastDriver.h in Headers */ = {isa = PBXBuildFile; fileRef = 72B767C81C9B707000A07552 /* SUAppcastDriver.h */; }; 72B767CB1C9B707000A07552 /* SUAppcastDriver.m in Sources */ = {isa = PBXBuildFile; fileRef = 72B767C91C9B707000A07552 /* SUAppcastDriver.m */; }; 72B767CE1C9B924900A07552 /* SPUInstallerDriver.h in Headers */ = {isa = PBXBuildFile; fileRef = 72B767CC1C9B924900A07552 /* SPUInstallerDriver.h */; }; 72B767CF1C9B924900A07552 /* SPUInstallerDriver.m in Sources */ = {isa = PBXBuildFile; fileRef = 72B767CD1C9B924900A07552 /* SPUInstallerDriver.m */; }; - 72B767D21C9C7B9300A07552 /* SPUProbingUpdateDriver.h in Headers */ = {isa = PBXBuildFile; fileRef = 72B767D01C9C7B9300A07552 /* SPUProbingUpdateDriver.h */; }; - 72B767D31C9C7B9300A07552 /* SPUProbingUpdateDriver.m in Sources */ = {isa = PBXBuildFile; fileRef = 72B767D11C9C7B9300A07552 /* SPUProbingUpdateDriver.m */; }; - 72B767D61C9C8B5C00A07552 /* SPUBasicUpdateDriver.h in Headers */ = {isa = PBXBuildFile; fileRef = 72B767D41C9C8B5C00A07552 /* SPUBasicUpdateDriver.h */; }; - 72B767D71C9C8B5C00A07552 /* SPUBasicUpdateDriver.m in Sources */ = {isa = PBXBuildFile; fileRef = 72B767D51C9C8B5C00A07552 /* SPUBasicUpdateDriver.m */; }; - 72B767DA1C9CD2E400A07552 /* SPUUIBasedUpdateDriver.h in Headers */ = {isa = PBXBuildFile; fileRef = 72B767D81C9CD2E400A07552 /* SPUUIBasedUpdateDriver.h */; }; - 72B767DB1C9CD2E400A07552 /* SPUUIBasedUpdateDriver.m in Sources */ = {isa = PBXBuildFile; fileRef = 72B767D91C9CD2E400A07552 /* SPUUIBasedUpdateDriver.m */; }; - 72B767DE1C9CDB9700A07552 /* SPUUserInitiatedUpdateDriver.h in Headers */ = {isa = PBXBuildFile; fileRef = 72B767DC1C9CDB9700A07552 /* SPUUserInitiatedUpdateDriver.h */; }; - 72B767DF1C9CDB9700A07552 /* SPUUserInitiatedUpdateDriver.m in Sources */ = {isa = PBXBuildFile; fileRef = 72B767DD1C9CDB9700A07552 /* SPUUserInitiatedUpdateDriver.m */; }; - 72B767E21C9CE90A00A07552 /* SPUCoreBasedUpdateDriver.h in Headers */ = {isa = PBXBuildFile; fileRef = 72B767E01C9CE90A00A07552 /* SPUCoreBasedUpdateDriver.h */; }; - 72B767E31C9CE90A00A07552 /* SPUCoreBasedUpdateDriver.m in Sources */ = {isa = PBXBuildFile; fileRef = 72B767E11C9CE90A00A07552 /* SPUCoreBasedUpdateDriver.m */; }; - 72B767E61C9CFD7200A07552 /* SPUAutomaticUpdateDriver.h in Headers */ = {isa = PBXBuildFile; fileRef = 72B767E41C9CFD7200A07552 /* SPUAutomaticUpdateDriver.h */; }; - 72B767E71C9CFD7200A07552 /* SPUAutomaticUpdateDriver.m in Sources */ = {isa = PBXBuildFile; fileRef = 72B767E51C9CFD7200A07552 /* SPUAutomaticUpdateDriver.m */; }; 72BC6C3D275027BF0083F14B /* SparkleTestCodeSign_apfs.dmg in Resources */ = {isa = PBXBuildFile; fileRef = 72BC6C3C275027BF0083F14B /* SparkleTestCodeSign_apfs.dmg */; }; 72C56E042EFB45B10005A484 /* SUSignatureVerifier.m in Sources */ = {isa = PBXBuildFile; fileRef = 7267E59B1D3D8A5A00D1BF90 /* SUSignatureVerifier.m */; }; 72C56E052EFB45BD0005A484 /* SPUVerifierInformation.m in Sources */ = {isa = PBXBuildFile; fileRef = 72D04F3C2B094C8400A6DEAA /* SPUVerifierInformation.m */; }; @@ -434,6 +419,7 @@ 72EB736129BEB36100FBCEE7 /* DevSignedAppVersion2.zip in Resources */ = {isa = PBXBuildFile; fileRef = 72EB736029BEB36100FBCEE7 /* DevSignedAppVersion2.zip */; }; 72EB87EA1CB8798800C37F42 /* ShowInstallerProgress.m in Sources */ = {isa = PBXBuildFile; fileRef = 72EB87E91CB8798800C37F42 /* ShowInstallerProgress.m */; }; 72EB87EB1CB8859100C37F42 /* Updater.app in Copy Tools */ = {isa = PBXBuildFile; fileRef = 721C24451CB753E6005440CB /* Updater.app */; settings = {ATTRIBUTES = (RemoveHeadersOnCopy, ); }; }; + 72EBE788305E4E3200AB3A73 /* SPUUpdateDriver.m in Sources */ = {isa = PBXBuildFile; fileRef = 72EBE787305E4E3200AB3A73 /* SPUUpdateDriver.m */; }; 72EE17FB26D1CC8800C58B19 /* SUInstallerLauncher+Private.h in Headers */ = {isa = PBXBuildFile; fileRef = 72EE17FA26D1CBC000C58B19 /* SUInstallerLauncher+Private.h */; settings = {ATTRIBUTES = (Private, ); }; }; 72EE17FC26D1CC9D00C58B19 /* SPUInstallationType.h in Headers */ = {isa = PBXBuildFile; fileRef = 7214B8851D45AD9A00CB5CED /* SPUInstallationType.h */; settings = {ATTRIBUTES = (Private, ); }; }; 72EE181926DAE70900C58B19 /* SPUUpdateCheck.h in Headers */ = {isa = PBXBuildFile; fileRef = 72EE181826DAE6E100C58B19 /* SPUUpdateCheck.h */; settings = {ATTRIBUTES = (Public, ); }; }; @@ -1080,8 +1066,6 @@ 722589B51E0A24B9005EA0B9 /* Security.md */ = {isa = PBXFileReference; lastKnownFileType = net.daringfireball.markdown; path = Security.md; sourceTree = ""; }; 722589B61E0A24C6005EA0B9 /* Design Practices.md */ = {isa = PBXFileReference; lastKnownFileType = net.daringfireball.markdown; path = "Design Practices.md"; sourceTree = ""; }; 7229E1B51C97C91100CB50D0 /* SPUUpdateDriver.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = SPUUpdateDriver.h; sourceTree = ""; }; - 7229E1B71C97CC4D00CB50D0 /* SPUScheduledUpdateDriver.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = SPUScheduledUpdateDriver.h; sourceTree = ""; }; - 7229E1B81C97CC4D00CB50D0 /* SPUScheduledUpdateDriver.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = SPUScheduledUpdateDriver.m; sourceTree = ""; }; 7229E1BB1C98EFF200CB50D0 /* SPUDownloadDriver.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = SPUDownloadDriver.h; sourceTree = ""; }; 7229E1BC1C98EFF200CB50D0 /* SPUDownloadDriver.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = SPUDownloadDriver.m; sourceTree = ""; }; 722C9538286EA54A0033908A /* SPUGentleUserDriverReminders.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = SPUGentleUserDriverReminders.h; sourceTree = ""; }; @@ -1244,7 +1228,6 @@ 7267E5DD1D3D8F5A00D1BF90 /* SUStatusInfoProtocol.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; name = SUStatusInfoProtocol.h; path = Autoupdate/SUStatusInfoProtocol.h; sourceTree = SOURCE_ROOT; }; 7267E5E31D3D90AA00D1BF90 /* SUFileManager.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = SUFileManager.h; sourceTree = ""; }; 7267E5E41D3D90AA00D1BF90 /* SUFileManager.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = SUFileManager.m; sourceTree = ""; }; - 7267E5FB1D3DD1B700D1BF90 /* SPUResumableUpdate.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = SPUResumableUpdate.h; sourceTree = ""; }; 7269E492264798200088C213 /* SPUSkippedUpdate.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = SPUSkippedUpdate.h; sourceTree = ""; }; 7269E493264798200088C213 /* SPUSkippedUpdate.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = SPUSkippedUpdate.m; sourceTree = ""; }; 7269E4992648F7C00088C213 /* SPUUserUpdateState.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = SPUUserUpdateState.m; sourceTree = ""; }; @@ -1302,6 +1285,8 @@ 729F7EAD273F1840004592DC /* SPUUserAgent+Private.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = "SPUUserAgent+Private.h"; sourceTree = ""; }; 729F7EAE273F1840004592DC /* SPUUserAgent+Private.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = "SPUUserAgent+Private.m"; sourceTree = ""; }; 729F7ECD27409076004592DC /* SparkleTestCodeSignApp_bad_extraneous.zip */ = {isa = PBXFileReference; lastKnownFileType = archive.zip; path = SparkleTestCodeSignApp_bad_extraneous.zip; sourceTree = ""; }; + 72A1C980305EC3E10009ECA3 /* SPUReleaseNotesDriver.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = SPUReleaseNotesDriver.h; sourceTree = ""; }; + 72A1C981305EC3E10009ECA3 /* SPUReleaseNotesDriver.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = SPUReleaseNotesDriver.m; sourceTree = ""; }; 72A40F082956120D007C7DD5 /* ConfigFrameworkRelease.xcconfig */ = {isa = PBXFileReference; lastKnownFileType = text.xcconfig; path = ConfigFrameworkRelease.xcconfig; sourceTree = ""; }; 72A450511C69A68900D67EEA /* SUUpdatePermissionResponse.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = SUUpdatePermissionResponse.h; sourceTree = ""; }; 72A450521C69A68900D67EEA /* SUUpdatePermissionResponse.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = SUUpdatePermissionResponse.m; sourceTree = ""; }; @@ -1322,24 +1307,10 @@ 72B398D21D3D879300EE297F /* Autoupdate */ = {isa = PBXFileReference; explicitFileType = "compiled.mach-o.executable"; includeInIndex = 0; path = Autoupdate; sourceTree = BUILT_PRODUCTS_DIR; }; 72B3DEC71E23472200457642 /* SPUDownloadedUpdate.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = SPUDownloadedUpdate.h; sourceTree = ""; }; 72B3DEC81E23472200457642 /* SPUDownloadedUpdate.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = SPUDownloadedUpdate.m; sourceTree = ""; }; - 72B3DECB1E23479000457642 /* SPUInformationalUpdate.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = SPUInformationalUpdate.h; sourceTree = ""; }; - 72B3DECC1E23479000457642 /* SPUInformationalUpdate.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = SPUInformationalUpdate.m; sourceTree = ""; }; 72B767C81C9B707000A07552 /* SUAppcastDriver.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = SUAppcastDriver.h; sourceTree = ""; }; 72B767C91C9B707000A07552 /* SUAppcastDriver.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = SUAppcastDriver.m; sourceTree = ""; }; 72B767CC1C9B924900A07552 /* SPUInstallerDriver.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = SPUInstallerDriver.h; sourceTree = ""; }; 72B767CD1C9B924900A07552 /* SPUInstallerDriver.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = SPUInstallerDriver.m; sourceTree = ""; }; - 72B767D01C9C7B9300A07552 /* SPUProbingUpdateDriver.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = SPUProbingUpdateDriver.h; sourceTree = ""; }; - 72B767D11C9C7B9300A07552 /* SPUProbingUpdateDriver.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = SPUProbingUpdateDriver.m; sourceTree = ""; }; - 72B767D41C9C8B5C00A07552 /* SPUBasicUpdateDriver.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = SPUBasicUpdateDriver.h; sourceTree = ""; }; - 72B767D51C9C8B5C00A07552 /* SPUBasicUpdateDriver.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = SPUBasicUpdateDriver.m; sourceTree = ""; }; - 72B767D81C9CD2E400A07552 /* SPUUIBasedUpdateDriver.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = SPUUIBasedUpdateDriver.h; sourceTree = ""; }; - 72B767D91C9CD2E400A07552 /* SPUUIBasedUpdateDriver.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = SPUUIBasedUpdateDriver.m; sourceTree = ""; }; - 72B767DC1C9CDB9700A07552 /* SPUUserInitiatedUpdateDriver.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = SPUUserInitiatedUpdateDriver.h; sourceTree = ""; }; - 72B767DD1C9CDB9700A07552 /* SPUUserInitiatedUpdateDriver.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = SPUUserInitiatedUpdateDriver.m; sourceTree = ""; }; - 72B767E01C9CE90A00A07552 /* SPUCoreBasedUpdateDriver.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = SPUCoreBasedUpdateDriver.h; sourceTree = ""; }; - 72B767E11C9CE90A00A07552 /* SPUCoreBasedUpdateDriver.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = SPUCoreBasedUpdateDriver.m; sourceTree = ""; }; - 72B767E41C9CFD7200A07552 /* SPUAutomaticUpdateDriver.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = SPUAutomaticUpdateDriver.h; sourceTree = ""; }; - 72B767E51C9CFD7200A07552 /* SPUAutomaticUpdateDriver.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = SPUAutomaticUpdateDriver.m; sourceTree = ""; }; 72BC6C3C275027BF0083F14B /* SparkleTestCodeSign_apfs.dmg */ = {isa = PBXFileReference; lastKnownFileType = file; path = SparkleTestCodeSign_apfs.dmg; sourceTree = ""; }; 72C4E01F30340BE400DAF61C /* SPUInstallerProgressLocalizedStrings.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = SPUInstallerProgressLocalizedStrings.h; sourceTree = ""; }; 72C4E02030340C2B00DAF61C /* generate_progress_tool_localizations.py */ = {isa = PBXFileReference; lastKnownFileType = text.script.python; path = generate_progress_tool_localizations.py; sourceTree = ""; }; @@ -1383,6 +1354,7 @@ 72EB735E29BE981300FBCEE7 /* DevSignedApp.zip */ = {isa = PBXFileReference; lastKnownFileType = archive.zip; path = DevSignedApp.zip; sourceTree = ""; }; 72EB736029BEB36100FBCEE7 /* DevSignedAppVersion2.zip */ = {isa = PBXFileReference; lastKnownFileType = archive.zip; path = DevSignedAppVersion2.zip; sourceTree = ""; }; 72EB87E91CB8798800C37F42 /* ShowInstallerProgress.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = ShowInstallerProgress.m; path = Sparkle/InstallerProgress/ShowInstallerProgress.m; sourceTree = SOURCE_ROOT; }; + 72EBE787305E4E3200AB3A73 /* SPUUpdateDriver.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = SPUUpdateDriver.m; sourceTree = ""; }; 72EE17FA26D1CBC000C58B19 /* SUInstallerLauncher+Private.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = "SUInstallerLauncher+Private.h"; sourceTree = ""; }; 72EE181826DAE6E100C58B19 /* SPUUpdateCheck.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = SPUUpdateCheck.h; sourceTree = ""; }; 72EF30BA2675CF38008CE987 /* SPUAppcastItemStateResolver.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = SPUAppcastItemStateResolver.h; sourceTree = ""; }; @@ -2093,26 +2065,20 @@ 61CFB2C20E38496B007A1735 /* Drivers */ = { isa = PBXGroup; children = ( - 72B767E81C9D114F00A07552 /* Update Drivers */, - 72B767D41C9C8B5C00A07552 /* SPUBasicUpdateDriver.h */, - 72B767D51C9C8B5C00A07552 /* SPUBasicUpdateDriver.m */, - 72B767E01C9CE90A00A07552 /* SPUCoreBasedUpdateDriver.h */, - 72B767E11C9CE90A00A07552 /* SPUCoreBasedUpdateDriver.m */, + 7229E1B51C97C91100CB50D0 /* SPUUpdateDriver.h */, + 72EBE787305E4E3200AB3A73 /* SPUUpdateDriver.m */, 7229E1BB1C98EFF200CB50D0 /* SPUDownloadDriver.h */, 7229E1BC1C98EFF200CB50D0 /* SPUDownloadDriver.m */, - 7267E5FB1D3DD1B700D1BF90 /* SPUResumableUpdate.h */, 72B3DEC71E23472200457642 /* SPUDownloadedUpdate.h */, 72B3DEC81E23472200457642 /* SPUDownloadedUpdate.m */, - 72B3DECB1E23479000457642 /* SPUInformationalUpdate.h */, - 72B3DECC1E23479000457642 /* SPUInformationalUpdate.m */, 72B767CC1C9B924900A07552 /* SPUInstallerDriver.h */, 72B767CD1C9B924900A07552 /* SPUInstallerDriver.m */, 728337A41C9E6FF40085AA99 /* SPUProbeInstallStatus.h */, 728337A51C9E6FF40085AA99 /* SPUProbeInstallStatus.m */, - 72B767D81C9CD2E400A07552 /* SPUUIBasedUpdateDriver.h */, - 72B767D91C9CD2E400A07552 /* SPUUIBasedUpdateDriver.m */, 72B767C81C9B707000A07552 /* SUAppcastDriver.h */, 72B767C91C9B707000A07552 /* SUAppcastDriver.m */, + 72A1C980305EC3E10009ECA3 /* SPUReleaseNotesDriver.h */, + 72A1C981305EC3E10009ECA3 /* SPUReleaseNotesDriver.m */, ); name = Drivers; sourceTree = ""; @@ -2326,22 +2292,6 @@ path = Autoupdate; sourceTree = ""; }; - 72B767E81C9D114F00A07552 /* Update Drivers */ = { - isa = PBXGroup; - children = ( - 7229E1B51C97C91100CB50D0 /* SPUUpdateDriver.h */, - 72B767E41C9CFD7200A07552 /* SPUAutomaticUpdateDriver.h */, - 72B767E51C9CFD7200A07552 /* SPUAutomaticUpdateDriver.m */, - 72B767D01C9C7B9300A07552 /* SPUProbingUpdateDriver.h */, - 72B767D11C9C7B9300A07552 /* SPUProbingUpdateDriver.m */, - 7229E1B71C97CC4D00CB50D0 /* SPUScheduledUpdateDriver.h */, - 7229E1B81C97CC4D00CB50D0 /* SPUScheduledUpdateDriver.m */, - 72B767DC1C9CDB9700A07552 /* SPUUserInitiatedUpdateDriver.h */, - 72B767DD1C9CDB9700A07552 /* SPUUserInitiatedUpdateDriver.m */, - ); - name = "Update Drivers"; - sourceTree = ""; - }; 72D9549F1CBB415C006F28BD /* sparkle-cli */ = { isa = PBXGroup; children = ( @@ -2507,14 +2457,10 @@ buildActionMask = 2147483647; files = ( 61299B3609CB04E000B7442F /* Sparkle.h in Headers */, - 72B767E61C9CFD7200A07552 /* SPUAutomaticUpdateDriver.h in Headers */, - 72B767D61C9C8B5C00A07552 /* SPUBasicUpdateDriver.h in Headers */, - 72B767E21C9CE90A00A07552 /* SPUCoreBasedUpdateDriver.h in Headers */, 72F9EC441D5E9ED8004AC8B6 /* SPUDownloadData.h in Headers */, 72EF30C12675CF38008CE987 /* SPUAppcastItemState.h in Headers */, 72AEB1D429A1A74E0033883E /* SPUStandardVersionDisplay.h in Headers */, 7229E1BD1C98EFF200CB50D0 /* SPUDownloadDriver.h in Headers */, - 7267E5FD1D3DD1B700D1BF90 /* SPUResumableUpdate.h in Headers */, 7267E5B61D3D8AEE00D1BF90 /* SPUInstallationInfo.h in Headers */, 7245495C2ECA648000ABA991 /* SPUUpdaterSettings+Debug.h in Headers */, 72EE181926DAE70900C58B19 /* SPUUpdateCheck.h in Headers */, @@ -2526,8 +2472,6 @@ 728337A61C9E6FF40085AA99 /* SPUProbeInstallStatus.h in Headers */, 7286EE5F28CEC84900163C1D /* SUTextViewReleaseNotesView.h in Headers */, 723C8A541E2D60DB00C14942 /* SUTouchBarButtonGroup.h in Headers */, - 72B767D21C9C7B9300A07552 /* SPUProbingUpdateDriver.h in Headers */, - 7229E1B91C97CC4D00CB50D0 /* SPUScheduledUpdateDriver.h in Headers */, 726E075C1CA3A6D6001A286B /* SPUSecureCoding.h in Headers */, 7246E0A31C83B685003B4E75 /* SPUStandardUpdaterController.h in Headers */, 725CB95A1C7121830064365A /* SPUStandardUserDriver.h in Headers */, @@ -2542,9 +2486,9 @@ 72C56E0C2EFDFB850005A484 /* SPUExtractSignedFeed.h in Headers */, 61299A5C09CA6D4500B7442F /* SUConstants.h in Headers */, 726DF88E1C84277600188804 /* SPUUserUpdateState.h in Headers */, - 72B767DA1C9CD2E400A07552 /* SPUUIBasedUpdateDriver.h in Headers */, 7229E1B61C97C91100CB50D0 /* SPUUpdateDriver.h in Headers */, 72DBA37D1D60CC34002594A8 /* SPUUpdatePermissionRequest.h in Headers */, + 72A1C983305EC3E10009ECA3 /* SPUReleaseNotesDriver.h in Headers */, 61B5F8ED09C4CE3C00B25A18 /* SPUUpdater.h in Headers */, 720E217B1D0D00BF003A311C /* SPUUpdaterCycle.h in Headers */, 72F9EC481D5EA904004AC8B6 /* SPUUpdaterDelegate.h in Headers */, @@ -2554,7 +2498,6 @@ 723ABFC4259D4CB300BDB4FA /* SUWKWebView.h in Headers */, 72AEB1D829A1CB510033883E /* SPUNoUpdateFoundInfo.h in Headers */, 725CB9571C7120410064365A /* SPUUserDriver.h in Headers */, - 72B767DE1C9CDB9700A07552 /* SPUUserInitiatedUpdateDriver.h in Headers */, 72F94F581CC44DE1002DEE68 /* SPUXPCServiceInfo.h in Headers */, 61B5FC0D09C4FC8200B25A18 /* SUAppcast.h in Headers */, 72B767CA1C9B707000A07552 /* SUAppcastDriver.h in Headers */, @@ -2570,7 +2513,6 @@ 55C14F06136EF6DB00649790 /* SULog.h in Headers */, EA1E286E22B665F0004AA304 /* SUSignatures.h in Headers */, 723ABF1B259D055E00BDB4FA /* SUReleaseNotesView.h in Headers */, - 72B3DECD1E23479000457642 /* SPUInformationalUpdate.h in Headers */, 726F2CE51BC9C33D001971A4 /* SUOperatingSystem.h in Headers */, 61A225A40D1C4AC000430CCD /* SUStandardVersionComparator.h in Headers */, 6196CFF909C72148000DC222 /* SUStatusController.h in Headers */, @@ -3609,9 +3551,6 @@ 72C56E052EFB45BD0005A484 /* SPUVerifierInformation.m in Sources */, 72C56E042EFB45B10005A484 /* SUSignatureVerifier.m in Sources */, 723ABF31259D062F00BDB4FA /* SULegacyWebView.m in Sources */, - 72B767E71C9CFD7200A07552 /* SPUAutomaticUpdateDriver.m in Sources */, - 72B767D71C9C8B5C00A07552 /* SPUBasicUpdateDriver.m in Sources */, - 72B767E31C9CE90A00A07552 /* SPUCoreBasedUpdateDriver.m in Sources */, 72F9EC451D5E9ED8004AC8B6 /* SPUDownloadData.m in Sources */, 723ABFC5259D4CB300BDB4FA /* SUWKWebView.m in Sources */, 7229E1BE1C98EFF200CB50D0 /* SPUDownloadDriver.m in Sources */, @@ -3622,15 +3561,12 @@ 72EF30BF2675CF38008CE987 /* SPUAppcastItemState.m in Sources */, 721BC20F1D1CDE55002BC71E /* SPULocalCacheDirectory.m in Sources */, 7267E5B21D3D8AD500D1BF90 /* SPUMessageTypes.m in Sources */, - 72B3DECF1E23479000457642 /* SPUInformationalUpdate.m in Sources */, + 72EBE788305E4E3200AB3A73 /* SPUUpdateDriver.m in Sources */, 728337A71C9E6FF40085AA99 /* SPUProbeInstallStatus.m in Sources */, - 72B767D31C9C7B9300A07552 /* SPUProbingUpdateDriver.m in Sources */, - 7229E1BA1C97CC4D00CB50D0 /* SPUScheduledUpdateDriver.m in Sources */, 726E075D1CA3A6D6001A286B /* SPUSecureCoding.m in Sources */, 7246E0A41C83B685003B4E75 /* SPUStandardUpdaterController.m in Sources */, 725CB95B1C7121830064365A /* SPUStandardUserDriver.m in Sources */, 723C8A551E2D60DB00C14942 /* SUTouchBarButtonGroup.m in Sources */, - 72B767DB1C9CD2E400A07552 /* SPUUIBasedUpdateDriver.m in Sources */, 72DBA37E1D60CC34002594A8 /* SPUUpdatePermissionRequest.m in Sources */, 72EF30C02675CF38008CE987 /* SPUAppcastItemStateResolver.m in Sources */, 61B5F8EE09C4CE3C00B25A18 /* SPUUpdater.m in Sources */, @@ -3639,8 +3575,8 @@ 726E078E1CA891E9001A286B /* SPUUpdaterSettings.m in Sources */, 721D588F25BE59F900D23BEA /* SUPhasedUpdateGroupInfo.m in Sources */, 72F9EC401D5E823F004AC8B6 /* SPUUpdaterTimer.m in Sources */, - 72B767DF1C9CDB9700A07552 /* SPUUserInitiatedUpdateDriver.m in Sources */, 72F94F591CC44DE1002DEE68 /* SPUXPCServiceInfo.m in Sources */, + 72A1C982305EC3E10009ECA3 /* SPUReleaseNotesDriver.m in Sources */, 61B5FBB709C4FAFF00B25A18 /* SUAppcast.m in Sources */, 72B767CB1C9B707000A07552 /* SUAppcastDriver.m in Sources */, 61B5FC6F09C51F4900B25A18 /* SUAppcastItem.m in Sources */, diff --git a/Sparkle.xcodeproj/xcshareddata/xcschemes/Sparkle Test App.xcscheme b/Sparkle.xcodeproj/xcshareddata/xcschemes/Sparkle Test App.xcscheme index d3e6a793..fbf8b3c8 100644 --- a/Sparkle.xcodeproj/xcshareddata/xcschemes/Sparkle Test App.xcscheme +++ b/Sparkle.xcodeproj/xcshareddata/xcschemes/Sparkle Test App.xcscheme @@ -58,6 +58,11 @@ value = "DELTA_AND_MARKDOWN" isEnabled = "NO"> + + diff --git a/Sparkle/SPUAutomaticUpdateDriver.h b/Sparkle/SPUAutomaticUpdateDriver.h deleted file mode 100644 index 1c06e701..00000000 --- a/Sparkle/SPUAutomaticUpdateDriver.h +++ /dev/null @@ -1,23 +0,0 @@ -// -// SPUAutomaticUpdateDriver.h -// Sparkle -// -// Created by Mayur Pawashe on 3/18/16. -// Copyright © 2016 Sparkle Project. All rights reserved. -// - -#import -#import "SPUUpdateDriver.h" - -NS_ASSUME_NONNULL_BEGIN - -@class SUHost; -@protocol SPUUpdaterDelegate, SPUUserDriver; - -SPU_OBJC_DIRECT_MEMBERS @interface SPUAutomaticUpdateDriver : NSObject - -- (instancetype)initWithHost:(SUHost *)host applicationBundle:(NSBundle *)applicationBundle updater:(id)updater userDriver:(id )userDriver updaterDelegate:(nullable id )updaterDelegate; - -@end - -NS_ASSUME_NONNULL_END diff --git a/Sparkle/SPUAutomaticUpdateDriver.m b/Sparkle/SPUAutomaticUpdateDriver.m deleted file mode 100644 index bcb5fb0e..00000000 --- a/Sparkle/SPUAutomaticUpdateDriver.m +++ /dev/null @@ -1,155 +0,0 @@ -// -// SPUAutomaticUpdateDriver.m -// Sparkle -// -// Created by Mayur Pawashe on 3/18/16. -// Copyright © 2016 Sparkle Project. All rights reserved. -// - -#import "SPUAutomaticUpdateDriver.h" -#import "SPUUpdateDriver.h" -#import "SUHost.h" -#import "SPUUpdaterDelegate.h" -#import "SPUCoreBasedUpdateDriver.h" -#import "SULog.h" -#import "SUAppcastItem.h" -#import "SPUUserDriver.h" -#import "SUErrors.h" - - -#include "AppKitPrevention.h" - -@interface SPUAutomaticUpdateDriver () -@end - -@implementation SPUAutomaticUpdateDriver -{ - SPUCoreBasedUpdateDriver *_coreDriver; - SUAppcastItem* _updateItem; - - __weak id _updater; - __weak id _userDriver; - __weak id _updaterDelegate; - - BOOL _installerDidFinishPreparation; -} - -- (instancetype)initWithHost:(SUHost *)host applicationBundle:(NSBundle *)applicationBundle updater:(id)updater userDriver:(id )userDriver updaterDelegate:(nullable id )updaterDelegate -{ - self = [super init]; - if (self != nil) { - _updater = updater; - // The user driver is only used for a termination callback - _userDriver = userDriver; - _updaterDelegate = updaterDelegate; - _coreDriver = [[SPUCoreBasedUpdateDriver alloc] initWithHost:host applicationBundle:applicationBundle updateCheck:SPUUpdateCheckUpdatesInBackground updater:updater updaterDelegate:updaterDelegate delegate:self]; - } - return self; -} - -- (void)setCompletionHandler:(SPUUpdateDriverCompletion)completionBlock -{ - [_coreDriver setCompletionHandler:completionBlock]; -} - -- (void)setUpdateShownHandler:(void (^)(void))updateShownHandler -{ -} - -- (void)setUpdateWillInstallHandler:(void (^)(void))updateWillInstallHandler -{ - [_coreDriver setUpdateWillInstallHandler:updateWillInstallHandler]; -} - -- (void)checkForUpdatesAtAppcastURL:(NSURL *)appcastURL withUserAgent:(NSString *)userAgent httpHeaders:(NSDictionary * _Nullable)httpHeaders -{ - [_coreDriver checkForUpdatesAtAppcastURL:appcastURL withUserAgent:userAgent httpHeaders:httpHeaders inBackground:YES requiresSilentInstall:YES]; -} - -- (void)resumeInstallingUpdate -{ - // Nothing really to do here.. this shouldn't be called. - SULog(SULogLevelError, @"Error: resumeInstallingUpdate: called on SPUAutomaticUpdateDriver"); -} - -- (void)resumeUpdate:(id)__unused resumableUpdate -{ - // Nothing really to do here.. this shouldn't be called. - SULog(SULogLevelError, @"Error: resumeDownloadedUpdate: called on SPUAutomaticUpdateDriver"); -} - -// Note: critical updates can be downloaded automatically first before needing user attention -static BOOL SPUUpdateRequiresUserAttentionBeforeDownloading(SUAppcastItem *updateItem) -{ - return (updateItem.isInformationOnlyUpdate || updateItem.majorUpgrade || updateItem.signingValidationStatus == SPUAppcastSigningValidationStatusFailed); -} - -- (void)basicDriverDidFindUpdateWithAppcastItem:(SUAppcastItem *)updateItem secondaryAppcastItem:(SUAppcastItem * _Nullable)secondaryUpdateItem -{ - _updateItem = updateItem; - - if (SPUUpdateRequiresUserAttentionBeforeDownloading(updateItem)) { - [_coreDriver deferInformationalUpdate:updateItem secondaryUpdate:secondaryUpdateItem]; - [self abortUpdate]; - } else { - [_coreDriver downloadUpdateFromAppcastItem:updateItem secondaryAppcastItem:secondaryUpdateItem inBackground:YES]; - } -} - -- (BOOL)showingUpdate -{ - return NO; -} - -- (void)installerDidFinishPreparationAndWillInstallImmediately:(BOOL)willInstallImmediately -{ - _installerDidFinishPreparation = YES; - - if (!willInstallImmediately) { - BOOL installationHandledByDelegate = NO; - id updaterDelegate = _updaterDelegate; - if ([updaterDelegate respondsToSelector:@selector(updater:willInstallUpdateOnQuit:immediateInstallationBlock:)]) { - __weak __typeof__(self) weakSelf = self; - installationHandledByDelegate = [updaterDelegate updater:_updater willInstallUpdateOnQuit:_updateItem immediateInstallationBlock:^{ - dispatch_async(dispatch_get_main_queue(), ^{ - __typeof__(self) strongSelf = weakSelf; - if (strongSelf != nil) { - [strongSelf->_coreDriver finishInstallationWithResponse:SPUUserUpdateChoiceInstall displayingUserInterface:NO]; - } - }); - }]; - } - - if (!installationHandledByDelegate) { - // We are done and can safely abort now - // The installer tool will keep the installation alive - [self abortUpdate]; - } - } -} - -- (void)basicDriverIsRequestingAbortUpdateWithError:(NSError *)error -{ - [self abortUpdateWithError:error]; -} - -- (void)coreDriverIsRequestingAbortUpdateWithError:(NSError *)error -{ - [self abortUpdateWithError:error]; -} - -- (void)abortUpdate -{ - [self abortUpdateWithError:nil]; -} - -- (void)abortUpdateWithError:(NSError *)error -{ - // It should not be necessary to include properties from SPUUpdateRequiresUserAttentionBeforeDownloading() because _installerDidFinishPreparation should be NO in those cases, - // but we'll include the check anyway - BOOL showNextUpdateImmediately = (error == nil || error.code == SUInstallationAuthorizeLaterError) && (!_installerDidFinishPreparation || _updateItem.criticalUpdate || SPUUpdateRequiresUserAttentionBeforeDownloading(_updateItem)); - - [_coreDriver abortUpdateAndShowNextUpdateImmediately:showNextUpdateImmediately error:error]; -} - -@end diff --git a/Sparkle/SPUBasicUpdateDriver.h b/Sparkle/SPUBasicUpdateDriver.h deleted file mode 100644 index 192921e7..00000000 --- a/Sparkle/SPUBasicUpdateDriver.h +++ /dev/null @@ -1,46 +0,0 @@ -// -// SPUBasicUpdateDriver.h -// Sparkle -// -// Created by Mayur Pawashe on 3/18/16. -// Copyright © 2016 Sparkle Project. All rights reserved. -// - -#import -#import "SPUUpdateDriver.h" -#import "SPUUpdateCheck.h" - -NS_ASSUME_NONNULL_BEGIN - -@class SUHost, SUAppcastItem; -@protocol SPUUpdaterDelegate; - -@protocol SPUBasicUpdateDriverDelegate - -- (void)basicDriverDidFindUpdateWithAppcastItem:(SUAppcastItem *)appcastItem secondaryAppcastItem:(SUAppcastItem * _Nullable)secondaryAppcastItem systemDomain:(NSNumber * _Nullable)systemDomain; - -- (void)basicDriverIsRequestingAbortUpdateWithError:(nullable NSError *)error; - -@optional - -- (void)basicDriverDidFinishLoadingAppcast; - -@end - -SPU_OBJC_DIRECT_MEMBERS @interface SPUBasicUpdateDriver : NSObject - -- (instancetype)initWithHost:(SUHost *)host updateCheck:(SPUUpdateCheck)updateCheck updater:(id)updater updaterDelegate:(nullable id )updaterDelegate delegate:(id )delegate; - -- (void)setCompletionHandler:(SPUUpdateDriverCompletion)completionBlock; - -- (void)checkForUpdatesAtAppcastURL:(NSURL *)appcastURL withUserAgent:(NSString *)userAgent httpHeaders:(NSDictionary * _Nullable)httpHeaders inBackground:(BOOL)background; - -- (void)resumeInstallingUpdate; - -- (void)resumeUpdate:(id)resumableUpdate; - -- (void)abortUpdateAndShowNextUpdateImmediately:(BOOL)shouldSignalShowingUpdate resumableUpdate:(id _Nullable)resumableUpdate error:(nullable NSError *)error; - -@end - -NS_ASSUME_NONNULL_END diff --git a/Sparkle/SPUBasicUpdateDriver.m b/Sparkle/SPUBasicUpdateDriver.m deleted file mode 100644 index 99032279..00000000 --- a/Sparkle/SPUBasicUpdateDriver.m +++ /dev/null @@ -1,292 +0,0 @@ -// -// SPUBasicUpdateDriver.m -// Sparkle -// -// Created by Mayur Pawashe on 3/18/16. -// Copyright © 2016 Sparkle Project. All rights reserved. -// - -#import "SPUBasicUpdateDriver.h" -#import "SUAppcastDriver.h" -#import "SPUUpdaterDelegate.h" -#import "SUErrors.h" -#import "SULocalizations.h" -#import "SUHost.h" -#import "SUAppcastItem.h" -#import "SPUProbeInstallStatus.h" -#import "SPUInstallationInfo.h" -#import "SPUResumableUpdate.h" -#import "SPUAppcastItemState.h" -#import "SUAppcastItem+Private.h" -#import "SPUInstallationType.h" -#import "SUVersionDisplayProtocol.h" -#import "SPUStandardVersionDisplay.h" -#import "SPUNoUpdateFoundInfo.h" - - -#include "AppKitPrevention.h" - -@interface SPUBasicUpdateDriver () - -@end - -@implementation SPUBasicUpdateDriver -{ - SUAppcastDriver *_appcastDriver; - SUHost *_host; - - SPUUpdateDriverCompletion _completionBlock; - - SPUUpdateCheck _updateCheck; - - __weak id _updater; - __weak id _updaterDelegate; - __weak id _delegate; - - BOOL _aborted; -} - -- (instancetype)initWithHost:(SUHost *)host updateCheck:(SPUUpdateCheck)updateCheck updater:(id)updater updaterDelegate:(id )updaterDelegate delegate:(id )delegate -{ - self = [super init]; - if (self != nil) { - _host = host; - _updateCheck = updateCheck; - _updater = updater; - _updaterDelegate = updaterDelegate; - _delegate = delegate; - - _appcastDriver = [[SUAppcastDriver alloc] initWithHost:host updater:updater updaterDelegate:updaterDelegate delegate:self]; - } - return self; -} - -- (void)setCompletionHandler:(SPUUpdateDriverCompletion)completionBlock -{ - _completionBlock = [completionBlock copy]; -} - -- (void)checkForUpdatesAtAppcastURL:(NSURL *)appcastURL withUserAgent:(NSString *)userAgent httpHeaders:(NSDictionary * _Nullable)httpHeaders inBackground:(BOOL)background -{ - if ([_host isRunningOnReadOnlyVolume]) { - NSString *hostName = _host.name; - id delegate = _delegate; -#if SPARKLE_COPY_LOCALIZATIONS - NSBundle *sparkleBundle = SUSparkleBundle(); -#endif - if ([_host isRunningTranslocated]) { - [delegate basicDriverIsRequestingAbortUpdateWithError:[NSError errorWithDomain:SUSparkleErrorDomain code:SURunningTranslocated userInfo:@{ NSLocalizedRecoverySuggestionErrorKey: [NSString stringWithFormat:SULocalizedStringFromTableInBundle(@"Quit %1$@, move it into your Applications folder, relaunch it from there and try again.", SPARKLE_TABLE, sparkleBundle, nil), hostName], NSLocalizedDescriptionKey: [NSString stringWithFormat:SULocalizedStringFromTableInBundle(@"%1$@ can’t be updated if it’s running from the location it was downloaded to.", SPARKLE_TABLE, sparkleBundle, nil), hostName], }]]; - } else { - [delegate basicDriverIsRequestingAbortUpdateWithError:[NSError errorWithDomain:SUSparkleErrorDomain code:SURunningFromDiskImageError userInfo:@{ NSLocalizedDescriptionKey: [NSString stringWithFormat:SULocalizedStringFromTableInBundle(@"%1$@ can’t be updated because it was opened from a read-only or a temporary location.", SPARKLE_TABLE, sparkleBundle, nil), hostName], NSLocalizedRecoverySuggestionErrorKey: [NSString stringWithFormat:SULocalizedStringFromTableInBundle(@"Use Finder to copy %1$@ to the Applications folder, relaunch it from there, and try again.", SPARKLE_TABLE, sparkleBundle, nil), hostName] }]]; - } - } else { - [_appcastDriver loadAppcastFromURL:appcastURL userAgent:userAgent httpHeaders:httpHeaders inBackground:background]; - } -} - -- (void)notifyResumableUpdateItem:(SUAppcastItem *)updateItem secondaryUpdateItem:(SUAppcastItem * _Nullable)secondaryUpdateItem systemDomain:(NSNumber * _Nullable)systemDomain SPU_OBJC_DIRECT -{ - if (updateItem == nil) { - [_delegate basicDriverIsRequestingAbortUpdateWithError:[NSError errorWithDomain:SUSparkleErrorDomain code:SUResumeAppcastError userInfo:@{ NSLocalizedDescriptionKey: SULocalizedStringFromTableInBundle(@"Failed to resume installing update.", SPARKLE_TABLE, SUSparkleBundle(), nil) }]]; - } else { - // Kind of lying, but triggering the notification so drivers can know when to stop showing initial fetching progress - [self notifyFinishLoadingAppcast]; - - SUAppcastItem *nonNullUpdateItem = updateItem; - [self notifyFoundValidUpdateWithAppcastItem:nonNullUpdateItem secondaryAppcastItem:secondaryUpdateItem systemDomain:systemDomain resuming:YES]; - } -} - -- (void)resumeInstallingUpdate -{ - NSString *hostBundleIdentifier = _host.bundle.bundleIdentifier; - assert(hostBundleIdentifier != nil); - [SPUProbeInstallStatus probeInstallerUpdateItemForHostBundleIdentifier:hostBundleIdentifier completion:^(SPUInstallationInfo * _Nullable installationInfo) { - dispatch_async(dispatch_get_main_queue(), ^{ - [self notifyResumableUpdateItem:installationInfo.appcastItem secondaryUpdateItem:nil systemDomain:@(installationInfo.systemDomain)]; - }); - }]; -} - -- (void)resumeUpdate:(id)resumableUpdate -{ - [self notifyResumableUpdateItem:resumableUpdate.updateItem secondaryUpdateItem:resumableUpdate.secondaryUpdateItem systemDomain:nil]; -} - -- (void)didFailToFetchAppcastWithError:(NSError *)error -{ - if (!_aborted) { - [_delegate basicDriverIsRequestingAbortUpdateWithError:error]; - } -} - -- (void)notifyFinishLoadingAppcast SPU_OBJC_DIRECT -{ - id delegate = _delegate; - if ([delegate respondsToSelector:@selector(basicDriverDidFinishLoadingAppcast)]) { - [delegate basicDriverDidFinishLoadingAppcast]; - } -} - -- (void)didFinishLoadingAppcast:(SUAppcast *)appcast -{ - if (!_aborted) { - id updaterDelegate = _updaterDelegate; - if ([updaterDelegate respondsToSelector:@selector((updater:didFinishLoadingAppcast:))]) { - [updaterDelegate updater:_updater didFinishLoadingAppcast:appcast]; - } - - [self notifyFinishLoadingAppcast]; - } -} - -- (void)notifyFoundValidUpdateWithAppcastItem:(SUAppcastItem *)updateItem secondaryAppcastItem:(SUAppcastItem * _Nullable)secondaryUpdateItem systemDomain:(NSNumber * _Nullable)systemDomain resuming:(BOOL)resuming SPU_OBJC_DIRECT -{ - if (!_aborted) { - id delegate = _delegate; - id updaterDelegate = _updaterDelegate; - id updater = _updater; - - if (!resuming) { - // Give the delegate a chance to bail - - NSError *shouldNotProceedError = nil; - if ([updaterDelegate respondsToSelector:@selector(updater:shouldProceedWithUpdate:updateCheck:error:)] && ![updaterDelegate updater:updater shouldProceedWithUpdate:updateItem updateCheck:_updateCheck error:&shouldNotProceedError]) { - [delegate basicDriverIsRequestingAbortUpdateWithError:shouldNotProceedError]; - return; - } - } - - [[NSNotificationCenter defaultCenter] postNotificationName:SUUpdaterDidFindValidUpdateNotification - object:updater - userInfo:@{ SUUpdaterAppcastItemNotificationKey: updateItem }]; - - if ([updaterDelegate respondsToSelector:@selector((updater:didFindValidUpdate:))]) { - [updaterDelegate updater:updater didFindValidUpdate:updateItem]; - } - - [delegate basicDriverDidFindUpdateWithAppcastItem:updateItem secondaryAppcastItem:secondaryUpdateItem systemDomain:systemDomain]; - } -} - -- (void)didFindValidUpdateWithAppcastItem:(SUAppcastItem *)updateItem secondaryAppcastItem:(SUAppcastItem * _Nullable)secondaryAppcastItem -{ - [self notifyFoundValidUpdateWithAppcastItem:updateItem secondaryAppcastItem:secondaryAppcastItem systemDomain:nil resuming:NO]; -} - -- (void)didNotFindUpdateWithLatestAppcastItem:(nullable SUAppcastItem *)latestAppcastItem hostToLatestAppcastItemComparisonResult:(NSComparisonResult)hostToLatestAppcastItemComparisonResult background:(BOOL)background -{ - if (!_aborted) { - NSString *localizedDescription; - -#if SPARKLE_COPY_LOCALIZATIONS - NSBundle *sparkleBundle = SUSparkleBundle(); -#else - NSBundle *sparkleBundle = nil; -#endif - - SPUNoUpdateFoundReason reason; - if (latestAppcastItem != nil) { - switch (hostToLatestAppcastItemComparisonResult) { - case NSOrderedDescending: - // This means the user is a 'newer than latest' version. give a slight hint to the user instead of wrongly claiming this version is identical to the latest feed version. - localizedDescription = SULocalizedStringFromTableInBundle(@"You’re up to date!", SPARKLE_TABLE, sparkleBundle, "Status message shown when the user checks for updates but is already current or the feed doesn't contain any updates."); - - reason = SPUNoUpdateFoundReasonOnNewerThanLatestVersion; - break; - case NSOrderedSame: - // No new update is available and we're on the latest - localizedDescription = SULocalizedStringFromTableInBundle(@"You’re up to date!", SPARKLE_TABLE, sparkleBundle, "Status message shown when the user checks for updates but is already current or the feed doesn't contain any updates."); - - reason = SPUNoUpdateFoundReasonOnLatestVersion; - break; - case NSOrderedAscending: - // A new update is available but cannot be installed - // More detailed recovery suggestions are in SPUNoUpdateFoundRecoverySuggestion() - - if (!latestAppcastItem.arm64HardwareRequirementIsOK) { - localizedDescription = SULocalizedStringFromTableInBundle(@"Your Mac is too old", SPARKLE_TABLE, sparkleBundle, nil); - - reason = SPUNoUpdateFoundReasonHardwareDoesNotSupportARM64; - } else if (!latestAppcastItem.minimumOperatingSystemVersionIsOK) { - localizedDescription = SULocalizedStringFromTableInBundle(@"Your macOS version is too old", SPARKLE_TABLE, sparkleBundle, nil); - - reason = SPUNoUpdateFoundReasonSystemIsTooOld; - } else if (!latestAppcastItem.maximumOperatingSystemVersionIsOK) { - localizedDescription = SULocalizedStringFromTableInBundle(@"Your macOS version is too new", SPARKLE_TABLE, sparkleBundle, nil); - - reason = SPUNoUpdateFoundReasonSystemIsTooNew; - } else { - // We shouldn't realistically get here - localizedDescription = SULocalizedStringFromTableInBundle(@"You’re up to date!", SPARKLE_TABLE, sparkleBundle, "Status message shown when the user checks for updates but is already current or the feed doesn't contain any updates."); - - reason = SPUNoUpdateFoundReasonUnknown; - } - break; - } - } else { - // When no updates are found in the appcast - // We will need to assume the user is up to date if the feed doesn't have any applicable update items - // There could be update items on channels the updater is not subscribed to for example. But we can't tell the user about them. - // There could also only be update items available for other platforms or none at all. - localizedDescription = SULocalizedStringFromTableInBundle(@"You’re up to date!", SPARKLE_TABLE, sparkleBundle, "Status message shown when the user checks for updates but is already current or the feed doesn't contain any updates."); - - reason = SPUNoUpdateFoundReasonOnLatestVersion; - } - - // We use the standard version displayer here to construct a reason string, - // but it's possible for the user driver to override this before displaying if they wish - id versionDisplayer = [SPUStandardVersionDisplay standardVersionDisplay]; - NSString *recoverySuggestion = SPUNoUpdateFoundRecoverySuggestion(reason, latestAppcastItem, _host, versionDisplayer, sparkleBundle); - - NSString *recoveryOption = SULocalizedStringFromTableInBundle(@"OK", SPARKLE_TABLE, sparkleBundle, nil); - - NSMutableDictionary *userInfo = - [NSMutableDictionary dictionaryWithDictionary:@{ - NSLocalizedDescriptionKey: localizedDescription, - NSLocalizedRecoverySuggestionErrorKey: recoverySuggestion, - NSLocalizedRecoveryOptionsErrorKey: @[recoveryOption], - SPUNoUpdateFoundReasonKey: @(reason), - SPUNoUpdateFoundUserInitiatedKey: @(!background), - }]; - - if (latestAppcastItem != nil) { - userInfo[SPULatestAppcastItemFoundKey] = latestAppcastItem; - } - - NSError *notFoundError = - [NSError - errorWithDomain:SUSparkleErrorDomain - code:SUNoUpdateError - userInfo:[userInfo copy]]; - - id updaterDelegate = _updaterDelegate; - id updater = _updater; - - if (updater != nil) { - if ([updaterDelegate respondsToSelector:@selector((updaterDidNotFindUpdate:error:))]) { - [updaterDelegate updaterDidNotFindUpdate:updater error:notFoundError]; - } else if ([updaterDelegate respondsToSelector:@selector((updaterDidNotFindUpdate:))]) { - [updaterDelegate updaterDidNotFindUpdate:updater]; - } - - [[NSNotificationCenter defaultCenter] postNotificationName:SUUpdaterDidNotFindUpdateNotification object:updater userInfo:userInfo]; - } - - [_delegate basicDriverIsRequestingAbortUpdateWithError:notFoundError]; - } -} - -- (void)abortUpdateAndShowNextUpdateImmediately:(BOOL)shouldShowUpdateImmediately resumableUpdate:(id _Nullable)resumableUpdate error:(nullable NSError *)error -{ - _aborted = YES; - - [_appcastDriver cleanup:^{ - if (self->_completionBlock != nil) { - self->_completionBlock(shouldShowUpdateImmediately, resumableUpdate, error); - self->_completionBlock = nil; - } - }]; -} - -@end diff --git a/Sparkle/SPUCoreBasedUpdateDriver.h b/Sparkle/SPUCoreBasedUpdateDriver.h deleted file mode 100644 index b608d23d..00000000 --- a/Sparkle/SPUCoreBasedUpdateDriver.h +++ /dev/null @@ -1,77 +0,0 @@ -// -// SPUCoreBasedUpdateDriver.h -// Sparkle -// -// Created by Mayur Pawashe on 3/18/16. -// Copyright © 2016 Sparkle Project. All rights reserved. -// - -#import -#import "SPUUpdateDriver.h" -#import "SPUUserUpdateState.h" -#import "SPUUpdateCheck.h" - -NS_ASSUME_NONNULL_BEGIN - -@class SUHost, SUAppcastItem; -@protocol SPUUpdaterDelegate; - -@protocol SPUCoreBasedUpdateDriverDelegate - -- (void)basicDriverDidFindUpdateWithAppcastItem:(SUAppcastItem *)updateItem secondaryAppcastItem:(SUAppcastItem * _Nullable)secondaryAppcastItem; - -- (void)installerDidFinishPreparationAndWillInstallImmediately:(BOOL)willInstallImmediately; - -- (void)coreDriverIsRequestingAbortUpdateWithError:(nullable NSError *)error; - -- (void)basicDriverIsRequestingAbortUpdateWithError:(nullable NSError *)error; - -@optional - -- (void)basicDriverDidFinishLoadingAppcast; - -- (void)downloadDriverWillBeginDownload; - -- (void)downloadDriverDidReceiveExpectedContentLength:(uint64_t)expectedContentLength; - -- (void)downloadDriverDidReceiveDataOfLength:(uint64_t)length; - -- (void)coreDriverDidStartExtractingUpdate; - -- (void)installerDidStartInstallingWithApplicationTerminated:(BOOL)applicationTerminated; - -- (void)installerDidExtractUpdateWithProgress:(double)progress; - -- (void)installerDidFinishInstallationAndRelaunched:(BOOL)relaunched acknowledgement:(void(^)(void))acknowledgement; - -@end - -SPU_OBJC_DIRECT_MEMBERS @interface SPUCoreBasedUpdateDriver : NSObject - -- (instancetype)initWithHost:(SUHost *)host applicationBundle:(NSBundle *)applicationBundle updateCheck:(SPUUpdateCheck)updateCheck updater:(id)updater updaterDelegate:(nullable id )updaterDelegate delegate:(id)delegate; - -- (void)setCompletionHandler:(SPUUpdateDriverCompletion)completionBlock; - -- (void)setUpdateWillInstallHandler:(void (^)(void))updateWillInstallHandler; - -- (void)checkForUpdatesAtAppcastURL:(NSURL *)appcastURL withUserAgent:(NSString *)userAgent httpHeaders:(NSDictionary * _Nullable)httpHeaders inBackground:(BOOL)background requiresSilentInstall:(BOOL)silentInstall; - -- (void)resumeInstallingUpdate; - -- (void)resumeUpdate:(id)resumableUpdate; - -- (void)downloadUpdateFromAppcastItem:(SUAppcastItem *)updateItem secondaryAppcastItem:(SUAppcastItem * _Nullable)secondaryUpdateItem inBackground:(BOOL)background; - -- (void)deferInformationalUpdate:(SUAppcastItem *)updateItem secondaryUpdate:(SUAppcastItem * _Nullable)secondaryUpdateItem; - -- (void)extractDownloadedUpdate; - -- (void)clearDownloadedUpdate; - -- (void)finishInstallationWithResponse:(SPUUserUpdateChoice)installUpdateStatus displayingUserInterface:(BOOL)displayingUserInterface; - -- (void)abortUpdateAndShowNextUpdateImmediately:(BOOL)shouldShowUpdateImmediately error:(nullable NSError *)error; - -@end - -NS_ASSUME_NONNULL_END diff --git a/Sparkle/SPUCoreBasedUpdateDriver.m b/Sparkle/SPUCoreBasedUpdateDriver.m deleted file mode 100644 index 563a136a..00000000 --- a/Sparkle/SPUCoreBasedUpdateDriver.m +++ /dev/null @@ -1,402 +0,0 @@ -// -// SPUCoreBasedUpdateDriver.m -// Sparkle -// -// Created by Mayur Pawashe on 3/18/16. -// Copyright © 2016 Sparkle Project. All rights reserved. -// - -#import "SPUCoreBasedUpdateDriver.h" -#import "SUHost.h" -#import "SPUUpdaterDelegate.h" -#import "SPUBasicUpdateDriver.h" -#import "SPUInstallerDriver.h" -#import "SPUDownloadDriver.h" -#import "SULog.h" -#import "SULog+NSError.h" -#import "SUErrors.h" -#import "SPUResumableUpdate.h" -#import "SPUDownloadedUpdate.h" -#import "SPUInformationalUpdate.h" -#import "SUAppcastItem.h" -#import "SULocalizations.h" -#import "SPUInstallationType.h" -#import "SUPhasedUpdateGroupInfo.h" - - -#include "AppKitPrevention.h" - -@interface SPUCoreBasedUpdateDriver () -@end - -@implementation SPUCoreBasedUpdateDriver -{ - SPUBasicUpdateDriver *_basicDriver; - SPUDownloadDriver *_downloadDriver; - SPUInstallerDriver *_installerDriver; - SUAppcastItem *_updateItem; - SUAppcastItem * _Nullable _secondaryUpdateItem; - id _resumableUpdate; - SPUDownloadedUpdate *_downloadedUpdateForRemoval; - SUHost *_host; - NSString *_userAgent; - NSDictionary * _Nullable _httpHeaders; - - __weak id _updater; // if we didn't have legacy support, I'd remove this.. - __weak id _updaterDelegate; - __weak id _delegate; - - BOOL _resumingInstallingUpdate; - BOOL _silentInstall; -} - -- (instancetype)initWithHost:(SUHost *)host applicationBundle:(NSBundle *)applicationBundle updateCheck:(SPUUpdateCheck)updateCheck updater:(id)updater updaterDelegate:(nullable id )updaterDelegate delegate:(id)delegate -{ - self = [super init]; - if (self != nil) { - _delegate = delegate; - - NSString *bundleIdentifier = host.bundle.bundleIdentifier; - assert(bundleIdentifier != nil); - - _basicDriver = [[SPUBasicUpdateDriver alloc] initWithHost:host updateCheck:updateCheck updater:updater updaterDelegate:updaterDelegate delegate:self]; - _installerDriver = [[SPUInstallerDriver alloc] initWithHost:host applicationBundle:applicationBundle updater:updater updaterDelegate:updaterDelegate delegate:self]; - - _host = host; - _updater = updater; - _updaterDelegate = updaterDelegate; - } - return self; -} - -- (void)setCompletionHandler:(SPUUpdateDriverCompletion)completionBlock -{ - [_basicDriver setCompletionHandler:completionBlock]; -} - -- (void)setUpdateWillInstallHandler:(void (^)(void))updateWillInstallHandler -{ - [_installerDriver setUpdateWillInstallHandler:updateWillInstallHandler]; -} - -- (void)checkForUpdatesAtAppcastURL:(NSURL *)appcastURL withUserAgent:(NSString *)userAgent httpHeaders:(NSDictionary * _Nullable)httpHeaders inBackground:(BOOL)background requiresSilentInstall:(BOOL)silentInstall -{ - _userAgent = [userAgent copy]; - _httpHeaders = httpHeaders; - _silentInstall = silentInstall; - - [_basicDriver checkForUpdatesAtAppcastURL:appcastURL withUserAgent:userAgent httpHeaders:httpHeaders inBackground:background]; -} - -- (void)resumeInstallingUpdate -{ - _resumingInstallingUpdate = YES; - _silentInstall = NO; - - [_basicDriver resumeInstallingUpdate]; -} - -- (void)resumeUpdate:(id)resumableUpdate -{ - _resumableUpdate = resumableUpdate; - _silentInstall = NO; - - [_basicDriver resumeUpdate:resumableUpdate]; -} - -- (void)basicDriverDidFinishLoadingAppcast -{ - id delegate = _delegate; - if ([delegate respondsToSelector:@selector(basicDriverDidFinishLoadingAppcast)]) { - [delegate basicDriverDidFinishLoadingAppcast]; - } -} - -- (void)basicDriverDidFindUpdateWithAppcastItem:(SUAppcastItem *)updateItem secondaryAppcastItem:(SUAppcastItem * _Nullable)secondaryUpdateItem systemDomain:(NSNumber * _Nullable)systemDomain -{ - _updateItem = updateItem; - _secondaryUpdateItem = secondaryUpdateItem; - - if (_resumingInstallingUpdate) { - assert(systemDomain != nil); - [_installerDriver resumeInstallingUpdateWithUpdateItem:updateItem systemDomain:systemDomain.boolValue]; - } - - [_delegate basicDriverDidFindUpdateWithAppcastItem:updateItem secondaryAppcastItem:secondaryUpdateItem]; -} - -- (void)downloadUpdateFromAppcastItem:(SUAppcastItem *)updateItem secondaryAppcastItem:(SUAppcastItem * _Nullable)secondaryUpdateItem inBackground:(BOOL)background SPU_OBJC_DIRECT -{ - _downloadDriver = [[SPUDownloadDriver alloc] initWithUpdateItem:updateItem secondaryUpdateItem:secondaryUpdateItem host:_host userAgent:_userAgent httpHeaders:_httpHeaders inBackground:background delegate:self]; - - id updater = _updater; - id updaterDelegate = _updaterDelegate; - - if (updater != nil && [updaterDelegate respondsToSelector:@selector((updater:willDownloadUpdate:withRequest:))]) { - [updaterDelegate updater:updater willDownloadUpdate:updateItem withRequest:_downloadDriver.request]; - } - - [_downloadDriver downloadFile]; -} - -- (void)downloadDriverWillBeginDownload -{ - id delegate = _delegate; - if ([delegate respondsToSelector:@selector(downloadDriverWillBeginDownload)]) { - [delegate downloadDriverWillBeginDownload]; - } -} - -- (void)downloadDriverDidReceiveExpectedContentLength:(uint64_t)expectedContentLength -{ - id delegate = _delegate; - if ([delegate respondsToSelector:@selector(downloadDriverDidReceiveExpectedContentLength:)]) { - [delegate downloadDriverDidReceiveExpectedContentLength:expectedContentLength]; - } -} - -- (void)downloadDriverDidReceiveDataOfLength:(uint64_t)length -{ - id delegate = _delegate; - if ([delegate respondsToSelector:@selector(downloadDriverDidReceiveDataOfLength:)]) { - [delegate downloadDriverDidReceiveDataOfLength:length]; - } -} - -- (void)downloadDriverDidDownloadUpdate:(SPUDownloadedUpdate *)downloadedUpdate -{ - // Use a new update group for our next downloaded update - // We could restrict this to when the appcast was downloaded in the background, - // but it shouldn't matter. - if (downloadedUpdate.updateItem.phasedRolloutInterval != nil) { - [SUPhasedUpdateGroupInfo setNewUpdateGroupIdentifierForHost:_host]; - } - - id updater = _updater; - id updaterDelegate = _updaterDelegate; - - if (updater != nil && [updaterDelegate respondsToSelector:@selector(updater:didDownloadUpdate:)]) { - [updaterDelegate updater:updater didDownloadUpdate:_updateItem]; - } - - _resumableUpdate = downloadedUpdate; - [self extractUpdate:downloadedUpdate]; -} - -- (void)deferInformationalUpdate:(SUAppcastItem *)updateItem secondaryUpdate:(SUAppcastItem * _Nullable)secondaryUpdateItem -{ - _resumableUpdate = [[SPUInformationalUpdate alloc] initWithAppcastItem:updateItem secondaryAppcastItem:secondaryUpdateItem]; -} - -- (void)extractDownloadedUpdate -{ - id resumableUpdate = _resumableUpdate; - assert(resumableUpdate != nil && [resumableUpdate isKindOfClass:[SPUDownloadedUpdate class]]); - [self extractUpdate:(SPUDownloadedUpdate *)resumableUpdate]; -} - -- (void)clearDownloadedUpdate -{ - id downloadedUpdateObject = (_resumableUpdate != nil) ? _resumableUpdate : _downloadedUpdateForRemoval; - - if (downloadedUpdateObject == nil) { - SULog(SULogLevelError, @"Warning: clearDownloadedUpdate called but no downloaded update is tracked"); - return; - } - - if ([downloadedUpdateObject isKindOfClass:[SPUDownloadedUpdate class]]) { - if (_downloadDriver == nil) { - _downloadDriver = [[SPUDownloadDriver alloc] initWithHost:_host]; - } - - SPUDownloadedUpdate *downloadedUpdate = (SPUDownloadedUpdate *)downloadedUpdateObject; - [_downloadDriver removeDownloadedUpdate:downloadedUpdate]; - } - - // Clear any type of resumable update - _resumableUpdate = nil; -} - -- (void)extractUpdate:(SPUDownloadedUpdate *)downloadedUpdate SPU_OBJC_DIRECT -{ - id updater = _updater; - id updaterDelegate = _updaterDelegate; - - if (updater != nil && [updaterDelegate respondsToSelector:@selector(updater:willExtractUpdate:)]) { - [updaterDelegate updater:updater willExtractUpdate:_updateItem]; - } - - // Now we have to extract the downloaded archive. - id delegate = _delegate; - if ([delegate respondsToSelector:@selector(coreDriverDidStartExtractingUpdate)]) { - [delegate coreDriverDidStartExtractingUpdate]; - } - - [_installerDriver extractDownloadedUpdate:downloadedUpdate silently:_silentInstall completion:^(NSError * _Nullable error) { - if (error != nil) { - if (error.code != SUInstallationAuthorizeLaterError) { - [self clearDownloadedUpdate]; - } - - [self->_delegate coreDriverIsRequestingAbortUpdateWithError:error]; - } else { - // If the installer started properly, we can't use the downloaded update archive anymore - // Especially if the installer fails later and we try resuming the update with a missing archive file - // We must clear the download after the installer begins using it however (in -installerDidStartInstalling) - self->_downloadedUpdateForRemoval = downloadedUpdate; - self->_resumableUpdate = nil; - - if (updater != nil && [updaterDelegate respondsToSelector:@selector(updater:didExtractUpdate:)]) { - [updaterDelegate updater:updater didExtractUpdate:self->_updateItem]; - } - } - }]; -} - -- (void)downloadDriverDidFailToDownloadFileWithError:(NSError *)error -{ - if ([_updateItem isDeltaUpdate]) { - SULog(SULogLevelError, @"Failed to download delta update. Falling back to regular update..."); - SULogError(error); - - [self fallBackAndDownloadRegularUpdate]; - } else { - id updater = _updater; - id updaterDelegate = _updaterDelegate; - - if (updater != nil && [updaterDelegate respondsToSelector:@selector((updater:failedToDownloadUpdate:error:))]) { - NSError *errorToReport = [error.userInfo objectForKey:NSUnderlyingErrorKey]; - if (errorToReport == nil) { - errorToReport = error; - } - - [updaterDelegate updater:updater failedToDownloadUpdate:_updateItem error:errorToReport]; - } - - [_delegate coreDriverIsRequestingAbortUpdateWithError:error]; - } -} - -- (void)installerDidStartInstallingWithApplicationTerminated:(BOOL)applicationTerminated -{ - id delegate = _delegate; - if ([delegate respondsToSelector:@selector(installerDidStartInstallingWithApplicationTerminated:)]) { - [delegate installerDidStartInstallingWithApplicationTerminated:applicationTerminated]; - } -} - -- (void)installerDidStartExtracting -{ - // The installer has moved the archive and no longer needs the download directory - [self clearDownloadedUpdate]; -} - -- (void)installerDidExtractUpdateWithProgress:(double)progress -{ - id delegate = _delegate; - if ([delegate respondsToSelector:@selector(installerDidExtractUpdateWithProgress:)]) { - [delegate installerDidExtractUpdateWithProgress:progress]; - } -} - -- (void)installerDidFinishPreparationAndWillInstallImmediately:(BOOL)willInstallImmediately -{ - [_delegate installerDidFinishPreparationAndWillInstallImmediately:willInstallImmediately]; -} - -- (void)finishInstallationWithResponse:(SPUUserUpdateChoice)response displayingUserInterface:(BOOL)displayingUserInterface -{ - switch (response) { - case SPUUserUpdateChoiceDismiss: - [_delegate coreDriverIsRequestingAbortUpdateWithError:nil]; - break; - case SPUUserUpdateChoiceSkip: - [_installerDriver cancelUpdate]; - break; - case SPUUserUpdateChoiceInstall: - [_installerDriver installWithToolAndRelaunch:YES displayingUserInterface:displayingUserInterface]; - break; - } -} - -- (void)installerWillFinishInstallationAndRelaunch:(BOOL)relaunch -{ - id updater = _updater; - id updaterDelegate = _updaterDelegate; - - if (updater != nil) { - if ([updaterDelegate respondsToSelector:@selector((updater:willInstallUpdate:))]) { - [updaterDelegate updater:updater willInstallUpdate:_updateItem]; - } - - if (relaunch) { - [[NSNotificationCenter defaultCenter] postNotificationName:SUUpdaterWillRestartNotification object:updater]; - if ([updaterDelegate respondsToSelector:@selector((updaterWillRelaunchApplication:))]) { - [updaterDelegate updaterWillRelaunchApplication:updater]; - } - } - } -} - -- (void)installerDidFinishInstallationAndRelaunched:(BOOL)relaunched acknowledgement:(void(^)(void))acknowledgement -{ - id delegate = _delegate; - if ([delegate respondsToSelector:@selector(installerDidFinishInstallationAndRelaunched:acknowledgement:)]) { - [delegate installerDidFinishInstallationAndRelaunched:relaunched acknowledgement:acknowledgement]; - } else { - acknowledgement(); - } -} - -- (void)installerIsRequestingAbortInstallWithError:(nullable NSError *)error -{ - [_delegate coreDriverIsRequestingAbortUpdateWithError:error]; -} - -- (void)basicDriverIsRequestingAbortUpdateWithError:(nullable NSError *)error -{ - // A delegate may want to handle this type of error specially - [_delegate basicDriverIsRequestingAbortUpdateWithError:error]; -} - -- (void)fallBackAndDownloadRegularUpdate SPU_OBJC_DIRECT -{ - SUAppcastItem *secondaryUpdateItem = _secondaryUpdateItem; - assert(secondaryUpdateItem != nil); - - BOOL backgroundDownload = _downloadDriver.inBackground; - - // Fall back to the non-delta update. Note that we don't want to trigger another update was found event. - _updateItem = secondaryUpdateItem; - _secondaryUpdateItem = nil; - - [self downloadUpdateFromAppcastItem:secondaryUpdateItem secondaryAppcastItem:nil inBackground:backgroundDownload]; -} - -- (void)installerDidFailToApplyDeltaUpdate -{ - [self clearDownloadedUpdate]; - - [self fallBackAndDownloadRegularUpdate]; -} - -- (void)abortUpdateAndShowNextUpdateImmediately:(BOOL)shouldShowUpdateImmediately error:(nullable NSError *)error -{ - [_installerDriver abortInstall]; - - void (^basicDriverAbort)(void) = ^{ - id resumableUpdate = (error == nil || error.code == SUInstallationAuthorizeLaterError) ? self->_resumableUpdate : nil; - - [self->_basicDriver abortUpdateAndShowNextUpdateImmediately:shouldShowUpdateImmediately resumableUpdate:resumableUpdate error:error]; - }; - - if (_downloadDriver != nil) { - [_downloadDriver cleanup:^{ - basicDriverAbort(); - }]; - } else { - basicDriverAbort(); - } -} - -@end diff --git a/Sparkle/SPUDownloadedUpdate.h b/Sparkle/SPUDownloadedUpdate.h index 38daed17..18bb5b94 100644 --- a/Sparkle/SPUDownloadedUpdate.h +++ b/Sparkle/SPUDownloadedUpdate.h @@ -7,14 +7,18 @@ // #import -#import "SPUResumableUpdate.h" NS_ASSUME_NONNULL_BEGIN -SPU_OBJC_DIRECT_MEMBERS @interface SPUDownloadedUpdate : NSObject +@class SUAppcastItem; + +SPU_OBJC_DIRECT_MEMBERS @interface SPUDownloadedUpdate : NSObject - (instancetype)initWithAppcastItem:(SUAppcastItem *)updateItem secondaryAppcastItem:(SUAppcastItem * _Nullable)secondaryItem downloadBookmarkData:(NSData *)downloadBookmarkData downloadToken:(NSString *)downloadToken; +@property (nonatomic, readonly) SUAppcastItem *updateItem; +@property (nonatomic, readonly, nullable) SUAppcastItem *secondaryUpdateItem; + @property (nonatomic, readonly) NSData *downloadBookmarkData; @property (nonatomic, readonly) NSString *downloadToken; diff --git a/Sparkle/SPUDownloadedUpdate.m b/Sparkle/SPUDownloadedUpdate.m index 5c2b4189..b1be1d93 100644 --- a/Sparkle/SPUDownloadedUpdate.m +++ b/Sparkle/SPUDownloadedUpdate.m @@ -13,8 +13,6 @@ @implementation SPUDownloadedUpdate -// If we ever enable auto-synthesize in the future, we'll still need this synthesize -// because the property is declared in a protocol @synthesize updateItem = _updateItem; @synthesize secondaryUpdateItem = _secondaryUpdateItem; diff --git a/Sparkle/SPUInformationalUpdate.h b/Sparkle/SPUInformationalUpdate.h deleted file mode 100644 index 32882b13..00000000 --- a/Sparkle/SPUInformationalUpdate.h +++ /dev/null @@ -1,20 +0,0 @@ -// -// SPUInformationalUpdate.h -// Sparkle -// -// Created by Mayur Pawashe on 1/8/17. -// Copyright © 2017 Sparkle Project. All rights reserved. -// - -#import -#import "SPUResumableUpdate.h" - -NS_ASSUME_NONNULL_BEGIN - -SPU_OBJC_DIRECT_MEMBERS @interface SPUInformationalUpdate : NSObject - -- (instancetype)initWithAppcastItem:(SUAppcastItem *)updateItem secondaryAppcastItem:(SUAppcastItem * _Nullable)secondaryUpdateItem; - -@end - -NS_ASSUME_NONNULL_END diff --git a/Sparkle/SPUInformationalUpdate.m b/Sparkle/SPUInformationalUpdate.m deleted file mode 100644 index 3f40a370..00000000 --- a/Sparkle/SPUInformationalUpdate.m +++ /dev/null @@ -1,31 +0,0 @@ -// -// SPUInformationalUpdate.m -// Sparkle -// -// Created by Mayur Pawashe on 1/8/17. -// Copyright © 2017 Sparkle Project. All rights reserved. -// - -#import "SPUInformationalUpdate.h" - - -#include "AppKitPrevention.h" - -@implementation SPUInformationalUpdate - -// If we ever enable auto-synthesize in the future, we'll still need this synthesize -// because the property is declared in a protocol -@synthesize updateItem = _updateItem; -@synthesize secondaryUpdateItem = _secondaryUpdateItem; - -- (instancetype)initWithAppcastItem:(SUAppcastItem *)updateItem secondaryAppcastItem:(SUAppcastItem * _Nullable)secondaryUpdateItem -{ - self = [super init]; - if (self != nil) { - _updateItem = updateItem; - _secondaryUpdateItem = secondaryUpdateItem; - } - return self; -} - -@end diff --git a/Sparkle/SPUInstallerDriver.m b/Sparkle/SPUInstallerDriver.m index c35129d6..fa7b452a 100644 --- a/Sparkle/SPUInstallerDriver.m +++ b/Sparkle/SPUInstallerDriver.m @@ -62,7 +62,6 @@ SPUInstallerMessageType _currentStage; NSUInteger _extractionAttempts; - BOOL _postponedOnce; BOOL _relaunch; BOOL _systemDomain; BOOL _aborted; @@ -487,8 +486,8 @@ // Send a probe/ping to the status service, which should boost/prioritize its startup if (hostBundleIdentifier != nil) { - [SPUProbeInstallStatus probeInstallerInProgressForHostBundleIdentifier:hostBundleIdentifier completion:^(BOOL stausServiceIsRunning) { - if (!stausServiceIsRunning) { + [SPUProbeInstallStatus probeInstallerInProgressForHostBundleIdentifier:hostBundleIdentifier completion:^(BOOL statusServiceIsRunning) { + if (!statusServiceIsRunning) { SULog(SULogLevelError, @"Error: failed to probe status service for %@ from the framework", hostBundleIdentifier); } }]; @@ -510,30 +509,29 @@ { assert(_updateItem); - id delegate = _delegate; - if (![self mayUpdateAndRestart]) { - [delegate installerIsRequestingAbortInstallWithError:nil]; + [_delegate installerIsRequestingAbortInstallWithError:nil]; return; } // Give the host app an opportunity to postpone the install and relaunch. - if (!_postponedOnce) - { - id updater = _updater; - id updaterDelegate = _updaterDelegate; - if (updater != nil && [updaterDelegate respondsToSelector:@selector(updater:shouldPostponeRelaunchForUpdate:untilInvokingBlock:)]) { - _postponedOnce = YES; - __weak __typeof__(self) weakSelf = self; - if ([updaterDelegate updater:updater shouldPostponeRelaunchForUpdate:_updateItem untilInvokingBlock:^{ - [weakSelf installWithToolAndRelaunch:relaunch displayingUserInterface:showUI]; - }]) { - return; - } + id updater = _updater; + id updaterDelegate = _updaterDelegate; + if (updater != nil && [updaterDelegate respondsToSelector:@selector(updater:shouldPostponeRelaunchForUpdate:untilInvokingBlock:)]) { + __weak __typeof__(self) weakSelf = self; + if ([updaterDelegate updater:updater shouldPostponeRelaunchForUpdate:_updateItem untilInvokingBlock:^{ + [weakSelf _installWithToolAndRelaunch:relaunch displayingUserInterface:showUI]; + }]) { + return; } } + [self _installWithToolAndRelaunch:relaunch displayingUserInterface:showUI]; +} + +- (void)_installWithToolAndRelaunch:(BOOL)relaunch displayingUserInterface:(BOOL)showUI SPU_OBJC_DIRECT +{ if (_updateWillInstallHandler != NULL) { _updateWillInstallHandler(); } @@ -550,7 +548,7 @@ // Avoid re-notifying the delegate twice if (!_notifiedDelegateInstallationWillFinish) { _notifiedDelegateInstallationWillFinish = YES; - [delegate installerWillFinishInstallationAndRelaunch:relaunch]; + [_delegate installerWillFinishInstallationAndRelaunch:relaunch]; } uint8_t response[2] = {(uint8_t)relaunch, (uint8_t)showUI}; diff --git a/Sparkle/SPUProbingUpdateDriver.h b/Sparkle/SPUProbingUpdateDriver.h deleted file mode 100644 index 30d7a48d..00000000 --- a/Sparkle/SPUProbingUpdateDriver.h +++ /dev/null @@ -1,23 +0,0 @@ -// -// SPUProbingUpdateDriver.h -// Sparkle -// -// Created by Mayur Pawashe on 3/18/16. -// Copyright © 2016 Sparkle Project. All rights reserved. -// - -#import -#import "SPUUpdateDriver.h" - -NS_ASSUME_NONNULL_BEGIN - -@class SUHost; -@protocol SPUUpdaterDelegate; - -SPU_OBJC_DIRECT_MEMBERS @interface SPUProbingUpdateDriver : NSObject - -- (instancetype)initWithHost:(SUHost *)host updater:(id)updater updaterDelegate:(nullable id )updaterDelegate; - -@end - -NS_ASSUME_NONNULL_END diff --git a/Sparkle/SPUProbingUpdateDriver.m b/Sparkle/SPUProbingUpdateDriver.m deleted file mode 100644 index f4990ba3..00000000 --- a/Sparkle/SPUProbingUpdateDriver.m +++ /dev/null @@ -1,90 +0,0 @@ -// -// SPUProbingUpdateDriver.m -// Sparkle -// -// Created by Mayur Pawashe on 3/18/16. -// Copyright © 2016 Sparkle Project. All rights reserved. -// - -#import "SPUProbingUpdateDriver.h" -#import "SPUBasicUpdateDriver.h" - - -#include "AppKitPrevention.h" - -@interface SPUProbingUpdateDriver () - -@end - -@implementation SPUProbingUpdateDriver -{ - SPUBasicUpdateDriver *_basicDriver; - id _resumableUpdate; -} - -- (instancetype)initWithHost:(SUHost *)host updater:(id)updater updaterDelegate:(id )updaterDelegate -{ - self = [super init]; - if (self != nil) { - _basicDriver = [[SPUBasicUpdateDriver alloc] initWithHost:host updateCheck:SPUUpdateCheckUpdateInformation updater:updater updaterDelegate:updaterDelegate delegate:self]; - } - return self; -} - -- (void)setCompletionHandler:(SPUUpdateDriverCompletion)completionBlock -{ - [_basicDriver setCompletionHandler:completionBlock]; -} - -- (void)setUpdateShownHandler:(void (^)(void))updateShownHandler -{ -} - -- (void)setUpdateWillInstallHandler:(void (^)(void))updateWillInstallHandler -{ -} - -- (void)checkForUpdatesAtAppcastURL:(NSURL *)appcastURL withUserAgent:(NSString *)userAgent httpHeaders:(NSDictionary * _Nullable)httpHeaders -{ - [_basicDriver checkForUpdatesAtAppcastURL:appcastURL withUserAgent:userAgent httpHeaders:httpHeaders inBackground:YES]; -} - -- (void)resumeInstallingUpdate -{ - [_basicDriver resumeInstallingUpdate]; -} - -- (void)resumeUpdate:(id)resumableUpdate -{ - _resumableUpdate = resumableUpdate; - - [_basicDriver resumeUpdate:resumableUpdate]; -} - -- (void)basicDriverDidFindUpdateWithAppcastItem:(SUAppcastItem *)__unused appcastItem secondaryAppcastItem:(SUAppcastItem * _Nullable)__unused secondaryAppcastItem systemDomain:(NSNumber * _Nullable)__unused systemDomain -{ - // Stop as soon as we have an answer - [self abortUpdate]; -} - -- (BOOL)showingUpdate -{ - return NO; -} - -- (void)basicDriverIsRequestingAbortUpdateWithError:(nullable NSError *)error -{ - [self abortUpdateWithError:error]; -} - -- (void)abortUpdate -{ - [self abortUpdateWithError:nil]; -} - -- (void)abortUpdateWithError:(nullable NSError *)error -{ - [_basicDriver abortUpdateAndShowNextUpdateImmediately:NO resumableUpdate:_resumableUpdate error:error]; -} - -@end diff --git a/Sparkle/SPUReleaseNotesDriver.h b/Sparkle/SPUReleaseNotesDriver.h new file mode 100644 index 00000000..c9a0370b --- /dev/null +++ b/Sparkle/SPUReleaseNotesDriver.h @@ -0,0 +1,27 @@ +// +// SPUReleaseNotesDriver.h +// Sparkle +// +// Created by Mayur Pawashe on 3/18/16. +// Copyright © 2016 Sparkle Project. All rights reserved. +// + +#import +#import "SPUDownloadDriver.h" + +NS_ASSUME_NONNULL_BEGIN + +@class SUHost, SUSignatures, SPUDownloadData; + +// Downloads and (if required) verifies release notes data for a found update +SPU_OBJC_DIRECT_MEMBERS @interface SPUReleaseNotesDriver : NSObject + +- (instancetype)initWithReleaseNotesURL:(NSURL *)releaseNotesURL contentLength:(uint64_t)contentLength signatures:(SUSignatures * _Nullable)signatures httpHeaders:(NSDictionary * _Nullable)httpHeaders userAgent:(NSString * _Nullable)userAgent host:(SUHost *)host completionHandler:(void (^)(SPUDownloadData * _Nullable, NSError * _Nullable))completionHandler; + +- (void)startDownload; + +- (void)cleanup:(void (^)(void))cleanupHandler; + +@end + +NS_ASSUME_NONNULL_END diff --git a/Sparkle/SPUReleaseNotesDriver.m b/Sparkle/SPUReleaseNotesDriver.m new file mode 100644 index 00000000..40013c07 --- /dev/null +++ b/Sparkle/SPUReleaseNotesDriver.m @@ -0,0 +1,121 @@ +// +// SPUReleaseNotesDriver.m +// Sparkle +// +// Created by Mayur Pawashe on 3/18/16. +// Copyright © 2016 Sparkle Project. All rights reserved. +// + +#import "SPUReleaseNotesDriver.h" +#import "SUHost.h" +#import "SUErrors.h" +#import "SPUDownloadData.h" +#import "SPUDownloadDataPrivate.h" +#import "SPUExtractSignedFeed.h" +#import "SUSignatures.h" +#import "SUSignatureVerifier.h" +#import "SPUVerifierInformation.h" +#import "SULocalizations.h" + + +#include "AppKitPrevention.h" + +@implementation SPUReleaseNotesDriver +{ + SPUDownloadDriver *_downloadDriver; + SUHost *_host; + SUSignatures *_signatures; + + void (^_completionHandler)(SPUDownloadData * _Nullable, NSError * _Nullable); + + uint64_t _contentLength; +} + +- (instancetype)initWithReleaseNotesURL:(NSURL *)releaseNotesURL contentLength:(uint64_t)contentLength signatures:(SUSignatures * _Nullable)signatures httpHeaders:(NSDictionary * _Nullable)httpHeaders userAgent:(NSString * _Nullable)userAgent host:(SUHost *)host completionHandler:(void (^)(SPUDownloadData * _Nullable, NSError * _Nullable))completionHandler +{ + self = [super init]; + if (self != nil) { + _host = host; + _signatures = signatures; + _contentLength = contentLength; + _downloadDriver = [[SPUDownloadDriver alloc] initWithRequestURL:releaseNotesURL host:host userAgent:userAgent httpHeaders:httpHeaders inBackground:NO cachePolicy:NSURLRequestReloadIgnoringLocalCacheData delegate:self]; + _completionHandler = [completionHandler copy]; + } else { + assert(false); + } + return self; +} + +- (void)startDownload +{ + [_downloadDriver downloadFile]; +} + +- (void)downloadDriverDidDownloadData:(SPUDownloadData *)downloadDataToValidate +{ + if (_completionHandler != nil) { + SPUDownloadData *downloadDataToPassToUserDriver; + + // Strip out any sign warning comment prefix for markdown data so that user drivers + // will not have to deal with parsing them (if their markdown parsers don't handle decoding HTML) + NSString *MIMEType = downloadDataToValidate.MIMEType; + NSString *pathExtension = _downloadDriver.request.URL.pathExtension; + if ([MIMEType isEqualToString:@"text/markdown"] || [MIMEType isEqualToString:@"text/x-markdown"] || + [pathExtension caseInsensitiveCompare:@"md"] == NSOrderedSame || [pathExtension caseInsensitiveCompare:@"markdown"] == NSOrderedSame) { + + NSData *contentData = SPUExtractReleaseNotesContent(downloadDataToValidate.data); + if (contentData.length != downloadDataToValidate.data.length) { + downloadDataToPassToUserDriver = [[SPUDownloadData alloc] initWithData:contentData URL:downloadDataToValidate.URL textEncodingName:downloadDataToValidate.textEncodingName MIMEType:downloadDataToValidate.MIMEType]; + } else { + downloadDataToPassToUserDriver = downloadDataToValidate; + } + } else { + downloadDataToPassToUserDriver = downloadDataToValidate; + } + + if (_host.requiresSignedAppcast) { + SUSignatureVerifier *signatureVerifier = [[SUSignatureVerifier alloc] initWithPublicKeys:_host.publicKeys]; + SPUVerifierInformation *verifierInformation = [[SPUVerifierInformation alloc] initWithExpectedVersion:nil expectedContentLength:_contentLength]; + verifierInformation.actualContentLength = downloadDataToValidate.data.length; + + NSError *verifierError = nil; + if (![signatureVerifier verifyData:downloadDataToValidate.data signatures:_signatures fileKind:@"release notes" verifierInformation:verifierInformation error:&verifierError]) { + NSMutableDictionary *userInfo = [NSMutableDictionary dictionaryWithDictionary:@{NSLocalizedDescriptionKey:SULocalizedStringFromTableInBundle(@"The release notes is improperly signed and could not be validated. Please contact the app developer for more information.", SPARKLE_TABLE, SUSparkleBundle(), nil)}]; + + if (verifierError != nil) { + [userInfo setObject:verifierError forKey:NSUnderlyingErrorKey]; + } + + _completionHandler(nil, [NSError errorWithDomain:SUSparkleErrorDomain code:SUDownloadError userInfo:userInfo]); + } else { + _completionHandler(downloadDataToPassToUserDriver, nil); + } + } else { + _completionHandler(downloadDataToPassToUserDriver, nil); + } + + _completionHandler = nil; + } +} + +- (void)downloadDriverDidFailToDownloadFileWithError:(nonnull NSError *)error +{ + if (_completionHandler != nil) { + NSMutableDictionary *userInfo = [NSMutableDictionary dictionaryWithDictionary:@{NSLocalizedDescriptionKey:SULocalizedStringFromTableInBundle(@"An error occurred while downloading the release notes.", SPARKLE_TABLE, SUSparkleBundle(), nil)}]; + + if (error != nil) { + [userInfo setObject:error forKey:NSUnderlyingErrorKey]; + } + + _completionHandler(nil, [NSError errorWithDomain:SUSparkleErrorDomain code:SUDownloadError userInfo:userInfo]); + _completionHandler = nil; + } +} + +- (void)cleanup:(void (^)(void))cleanupHandler +{ + _completionHandler = nil; + [_downloadDriver cleanup:cleanupHandler]; +} + +@end diff --git a/Sparkle/SPUResumableUpdate.h b/Sparkle/SPUResumableUpdate.h deleted file mode 100644 index 1b138587..00000000 --- a/Sparkle/SPUResumableUpdate.h +++ /dev/null @@ -1,22 +0,0 @@ -// -// SPUResumableUpdate.h -// Sparkle -// -// Created by Mayur Pawashe on 7/18/16. -// Copyright © 2016 Sparkle Project. All rights reserved. -// - -#import - -NS_ASSUME_NONNULL_BEGIN - -@class SUAppcastItem; - -@protocol SPUResumableUpdate - -@property (nonatomic, readonly) SUAppcastItem *updateItem; -@property (nonatomic, readonly, nullable) SUAppcastItem *secondaryUpdateItem; - -@end - -NS_ASSUME_NONNULL_END diff --git a/Sparkle/SPUScheduledUpdateDriver.h b/Sparkle/SPUScheduledUpdateDriver.h deleted file mode 100644 index 5cf0e294..00000000 --- a/Sparkle/SPUScheduledUpdateDriver.h +++ /dev/null @@ -1,24 +0,0 @@ -// -// SPUScheduledUpdateDriver.h -// Sparkle -// -// Created by Mayur Pawashe on 3/15/16. -// Copyright © 2016 Sparkle Project. All rights reserved. -// - -#import -#import "SPUUpdateDriver.h" -#import "SPUUIBasedUpdateDriver.h" - -NS_ASSUME_NONNULL_BEGIN - -@class SUHost; -@protocol SPUUserDriver, SPUUpdaterDelegate; - -SPU_OBJC_DIRECT_MEMBERS @interface SPUScheduledUpdateDriver : NSObject - -- (instancetype)initWithHost:(SUHost *)host applicationBundle:(NSBundle *)applicationBundle updater:(id)updater userDriver:(id )userDriver updaterDelegate:(nullable id )updaterDelegate; - -@end - -NS_ASSUME_NONNULL_END diff --git a/Sparkle/SPUScheduledUpdateDriver.m b/Sparkle/SPUScheduledUpdateDriver.m deleted file mode 100644 index 22027d2d..00000000 --- a/Sparkle/SPUScheduledUpdateDriver.m +++ /dev/null @@ -1,109 +0,0 @@ -// -// SPUScheduledUpdateDriver.m -// Sparkle -// -// Created by Mayur Pawashe on 3/15/16. -// Copyright © 2016 Sparkle Project. All rights reserved. -// - -#import "SPUScheduledUpdateDriver.h" -#import "SUHost.h" -#import "SUErrors.h" -#import "SPUUpdaterDelegate.h" -#import "SPUUserDriver.h" - - -#include "AppKitPrevention.h" - -@interface SPUScheduledUpdateDriver() - -@end - -@implementation SPUScheduledUpdateDriver -{ - SPUUIBasedUpdateDriver *_uiDriver; - - void (^_updateDidShowHandler)(void); - - BOOL _showedUpdate; -} - -- (instancetype)initWithHost:(SUHost *)host applicationBundle:(NSBundle *)applicationBundle updater:(id)updater userDriver:(id )userDriver updaterDelegate:(nullable id )updaterDelegate -{ - self = [super init]; - if (self != nil) { - _uiDriver = [[SPUUIBasedUpdateDriver alloc] initWithHost:host applicationBundle:applicationBundle updater:updater userDriver:userDriver userInitiated:NO updaterDelegate:updaterDelegate delegate:self]; - } - return self; -} - -- (void)setCompletionHandler:(SPUUpdateDriverCompletion)completionBlock -{ - [_uiDriver setCompletionHandler:completionBlock]; -} - -- (void)setUpdateShownHandler:(void (^)(void))handler -{ - _updateDidShowHandler = [handler copy]; -} - -- (void)setUpdateWillInstallHandler:(void (^)(void))updateWillInstallHandler -{ - [_uiDriver setUpdateWillInstallHandler:updateWillInstallHandler]; -} - -- (void)checkForUpdatesAtAppcastURL:(NSURL *)appcastURL withUserAgent:(NSString *)userAgent httpHeaders:(NSDictionary * _Nullable)httpHeaders -{ - [_uiDriver checkForUpdatesAtAppcastURL:appcastURL withUserAgent:userAgent httpHeaders:httpHeaders inBackground:YES]; -} - -- (void)resumeInstallingUpdate -{ - [_uiDriver resumeInstallingUpdate]; -} - -- (void)resumeUpdate:(id)resumableUpdate -{ - [_uiDriver resumeUpdate:resumableUpdate]; -} - -- (void)uiDriverDidShowUpdate -{ - _showedUpdate = YES; - - if (_updateDidShowHandler != nil) { - _updateDidShowHandler(); - } -} - -- (BOOL)showingUpdate -{ - return _showedUpdate; -} - -- (void)basicDriverIsRequestingAbortUpdateWithError:(nullable NSError *) error -{ - [self abortUpdateWithError:error]; -} - -- (void)coreDriverIsRequestingAbortUpdateWithError:(nullable NSError *) error -{ - [self abortUpdateWithError:error]; -} - -- (void)uiDriverIsRequestingAbortUpdateWithError:(nullable NSError *)error -{ - [self abortUpdateWithError:error]; -} - -- (void)abortUpdate -{ - [self abortUpdateWithError:nil]; -} - -- (void)abortUpdateWithError:(nullable NSError *)error -{ - [_uiDriver abortUpdateWithError:error showErrorToUser:_showedUpdate]; -} - -@end diff --git a/Sparkle/SPUUIBasedUpdateDriver.h b/Sparkle/SPUUIBasedUpdateDriver.h deleted file mode 100644 index 0f7817f2..00000000 --- a/Sparkle/SPUUIBasedUpdateDriver.h +++ /dev/null @@ -1,48 +0,0 @@ -// -// SPUUIBasedUpdateDriver.h -// Sparkle -// -// Created by Mayur Pawashe on 3/18/16. -// Copyright © 2016 Sparkle Project. All rights reserved. -// - -#import -#import "SPUUpdateDriver.h" - -NS_ASSUME_NONNULL_BEGIN - -@protocol SPUUIBasedUpdateDriverDelegate - -- (void)basicDriverIsRequestingAbortUpdateWithError:(nullable NSError *)error; -- (void)coreDriverIsRequestingAbortUpdateWithError:(nullable NSError *)error; -- (void)uiDriverIsRequestingAbortUpdateWithError:(nullable NSError *)error; - -@optional - -- (void)uiDriverDidShowUpdate; -- (void)basicDriverDidFinishLoadingAppcast; - -@end - -@class SUHost; -@protocol SPUUserDriver, SPUUpdaterDelegate; - -SPU_OBJC_DIRECT_MEMBERS @interface SPUUIBasedUpdateDriver : NSObject - -- (instancetype)initWithHost:(SUHost *)host applicationBundle:(NSBundle *)applicationBundle updater:(id)updater userDriver:(id )userDriver userInitiated:(BOOL)userInitiated updaterDelegate:(nullable id )updaterDelegate delegate:(id)delegate; - -- (void)setCompletionHandler:(SPUUpdateDriverCompletion)completionBlock; - -- (void)setUpdateWillInstallHandler:(void (^)(void))updateWillInstallHandler; - -- (void)checkForUpdatesAtAppcastURL:(NSURL *)appcastURL withUserAgent:(NSString *)userAgent httpHeaders:(NSDictionary * _Nullable)httpHeaders inBackground:(BOOL)background; - -- (void)resumeInstallingUpdate; - -- (void)resumeUpdate:(id)resumableUpdate; - -- (void)abortUpdateWithError:(nullable NSError *)error showErrorToUser:(BOOL)showedUserProgress; - -@end - -NS_ASSUME_NONNULL_END diff --git a/Sparkle/SPUUIBasedUpdateDriver.m b/Sparkle/SPUUIBasedUpdateDriver.m deleted file mode 100644 index fad56fa1..00000000 --- a/Sparkle/SPUUIBasedUpdateDriver.m +++ /dev/null @@ -1,507 +0,0 @@ -// -// SPUUIBasedUpdateDriver.m -// Sparkle -// -// Created by Mayur Pawashe on 3/18/16. -// Copyright © 2016 Sparkle Project. All rights reserved. -// - -#import "SPUUIBasedUpdateDriver.h" -#import "SPUCoreBasedUpdateDriver.h" -#import "SPUUserDriver.h" -#import "SUHost.h" -#import "SUConstants.h" -#import "SPUUpdaterDelegate.h" -#import "SUAppcastItem.h" -#import "SUErrors.h" -#import "SPUDownloadData.h" -#import "SPUDownloadDataPrivate.h" -#import "SPUExtractSignedFeed.h" -#import "SPUResumableUpdate.h" -#import "SPUDownloadDriver.h" -#import "SPUSkippedUpdate.h" -#import "SPUUserUpdateState+Private.h" -#import "SUAppcastItem+Private.h" -#import "SUSignatures.h" -#import "SUSignatureVerifier.h" -#import "SPUVerifierInformation.h" -#import "SULocalizations.h" - - -#include "AppKitPrevention.h" - -// Private class for downloading release notes -@interface SPUReleaseNotesDriver: NSObject -@end - -@implementation SPUReleaseNotesDriver -{ - SPUDownloadDriver *_downloadDriver; - SUHost *_host; - SUSignatures *_signatures; - - void (^_completionHandler)(SPUDownloadData * _Nullable, NSError * _Nullable); - - uint64_t _contentLength; -} - -- (instancetype)initWithReleaseNotesURL:(NSURL *)releaseNotesURL contentLength:(uint64_t)contentLength signatures:(SUSignatures * _Nullable)signatures httpHeaders:(NSDictionary * _Nullable)httpHeaders userAgent:(NSString * _Nullable)userAgent host:(SUHost *)host completionHandler:(void (^)(SPUDownloadData * _Nullable, NSError * _Nullable))completionHandler SPU_OBJC_DIRECT -{ - self = [super init]; - if (self != nil) { - _host = host; - _signatures = signatures; - _contentLength = contentLength; - _downloadDriver = [[SPUDownloadDriver alloc] initWithRequestURL:releaseNotesURL host:host userAgent:userAgent httpHeaders:httpHeaders inBackground:NO cachePolicy:NSURLRequestReloadIgnoringLocalCacheData delegate:self]; - _completionHandler = [completionHandler copy]; - } else { - assert(false); - } - return self; -} - -- (void)startDownload SPU_OBJC_DIRECT -{ - [_downloadDriver downloadFile]; -} - -- (void)downloadDriverDidDownloadData:(SPUDownloadData *)downloadDataToValidate -{ - if (_completionHandler != nil) { - SPUDownloadData *downloadDataToPassToUserDriver; - - // Strip out any sign warning comment prefix for markdown data so that user drivers - // will not have to deal with parsing them (if their markdown parsers don't handle decoding HTML) - NSString *MIMEType = downloadDataToValidate.MIMEType; - NSString *pathExtension = _downloadDriver.request.URL.pathExtension; - if ([MIMEType isEqualToString:@"text/markdown"] || [MIMEType isEqualToString:@"text/x-markdown"] || - [pathExtension caseInsensitiveCompare:@"md"] == NSOrderedSame || [pathExtension caseInsensitiveCompare:@"markdown"] == NSOrderedSame) { - - NSData *contentData = SPUExtractReleaseNotesContent(downloadDataToValidate.data); - if (contentData.length != downloadDataToValidate.data.length) { - downloadDataToPassToUserDriver = [[SPUDownloadData alloc] initWithData:contentData URL:downloadDataToValidate.URL textEncodingName:downloadDataToValidate.textEncodingName MIMEType:downloadDataToValidate.MIMEType]; - } else { - downloadDataToPassToUserDriver = downloadDataToValidate; - } - } else { - downloadDataToPassToUserDriver = downloadDataToValidate; - } - - if (_host.requiresSignedAppcast) { - SUSignatureVerifier *signatureVerifier = [[SUSignatureVerifier alloc] initWithPublicKeys:_host.publicKeys]; - SPUVerifierInformation *verifierInformation = [[SPUVerifierInformation alloc] initWithExpectedVersion:nil expectedContentLength:_contentLength]; - verifierInformation.actualContentLength = downloadDataToValidate.data.length; - - NSError *verifierError = nil; - if (![signatureVerifier verifyData:downloadDataToValidate.data signatures:_signatures fileKind:@"release notes" verifierInformation:verifierInformation error:&verifierError]) { - NSMutableDictionary *userInfo = [NSMutableDictionary dictionaryWithDictionary:@{NSLocalizedDescriptionKey:SULocalizedStringFromTableInBundle(@"The release notes is improperly signed and could not be validated. Please contact the app developer for more information.", SPARKLE_TABLE, SUSparkleBundle(), nil)}]; - - if (verifierError != nil) { - [userInfo setObject:verifierError forKey:NSUnderlyingErrorKey]; - } - - _completionHandler(nil, [NSError errorWithDomain:SUSparkleErrorDomain code:SUDownloadError userInfo:userInfo]); - } else { - _completionHandler(downloadDataToPassToUserDriver, nil); - } - } else { - _completionHandler(downloadDataToPassToUserDriver, nil); - } - - _completionHandler = nil; - } -} - -- (void)downloadDriverDidFailToDownloadFileWithError:(nonnull NSError *)error -{ - if (_completionHandler != nil) { - NSMutableDictionary *userInfo = [NSMutableDictionary dictionaryWithDictionary:@{NSLocalizedDescriptionKey:SULocalizedStringFromTableInBundle(@"An error occurred while downloading the release notes.", SPARKLE_TABLE, SUSparkleBundle(), nil)}]; - - if (error != nil) { - [userInfo setObject:error forKey:NSUnderlyingErrorKey]; - } - - _completionHandler(nil, [NSError errorWithDomain:SUSparkleErrorDomain code:SUDownloadError userInfo:userInfo]); - _completionHandler = nil; - } -} - -- (void)cleanup:(void (^)(void))cleanupHandler SPU_OBJC_DIRECT -{ - _completionHandler = nil; - [_downloadDriver cleanup:cleanupHandler]; -} - -@end - -@interface SPUUIBasedUpdateDriver() -@end - -@implementation SPUUIBasedUpdateDriver -{ - SPUCoreBasedUpdateDriver *_coreDriver; - SUHost *_host; - id _userDriver; - SPUReleaseNotesDriver *_releaseNotesDriver; - NSDictionary *_httpHeaders; - NSString *_userAgent; - - __weak id _updater; - __weak id _updaterDelegate; - __weak id _delegate; - - BOOL _userInitiated; - BOOL _resumingInstallingUpdate; - BOOL _resumingDownloadedInfoOrUpdate; -} - -- (instancetype)initWithHost:(SUHost *)host applicationBundle:(NSBundle *)applicationBundle updater:(id)updater userDriver:(id )userDriver userInitiated:(BOOL)userInitiated updaterDelegate:(nullable id )updaterDelegate delegate:(id)delegate -{ - self = [super init]; - if (self != nil) { - _userDriver = userDriver; - _delegate = delegate; - _updater = updater; - _userInitiated = userInitiated; - _updaterDelegate = updaterDelegate; - _host = host; - - SPUUpdateCheck updateCheck = userInitiated ? SPUUpdateCheckUpdates : SPUUpdateCheckUpdatesInBackground; - - _coreDriver = [[SPUCoreBasedUpdateDriver alloc] initWithHost:host applicationBundle:applicationBundle updateCheck:updateCheck updater:updater updaterDelegate:updaterDelegate delegate:self]; - } - return self; -} - -- (void)setCompletionHandler:(SPUUpdateDriverCompletion)completionBlock -{ - [_coreDriver setCompletionHandler:completionBlock]; -} - -- (void)setUpdateWillInstallHandler:(void (^)(void))updateWillInstallHandler -{ - [_coreDriver setUpdateWillInstallHandler:updateWillInstallHandler]; -} - -- (void)_clearSkippedUpdatesIfUserInitiated SPU_OBJC_DIRECT -{ - if (_userInitiated) { - [SPUSkippedUpdate clearSkippedUpdateForHost:_host]; - } -} - -- (void)checkForUpdatesAtAppcastURL:(NSURL *)appcastURL withUserAgent:(NSString *)userAgent httpHeaders:(NSDictionary * _Nullable)httpHeaders inBackground:(BOOL)background -{ - _httpHeaders = httpHeaders; - _userAgent = userAgent; - - [self _clearSkippedUpdatesIfUserInitiated]; - - [_coreDriver checkForUpdatesAtAppcastURL:appcastURL withUserAgent:userAgent httpHeaders:httpHeaders inBackground:background requiresSilentInstall:NO]; -} - -- (void)resumeInstallingUpdate -{ - [self _clearSkippedUpdatesIfUserInitiated]; - - _resumingInstallingUpdate = YES; - [_coreDriver resumeInstallingUpdate]; -} - -- (void)resumeUpdate:(id)resumableUpdate -{ - [self _clearSkippedUpdatesIfUserInitiated]; - - _resumingDownloadedInfoOrUpdate = YES; - [_coreDriver resumeUpdate:resumableUpdate]; -} - -- (void)basicDriverDidFinishLoadingAppcast -{ - id delegate = _delegate; - if ([delegate respondsToSelector:@selector(basicDriverDidFinishLoadingAppcast)]) { - [delegate basicDriverDidFinishLoadingAppcast]; - } -} - -- (void)basicDriverDidFindUpdateWithAppcastItem:(SUAppcastItem *)updateItem secondaryAppcastItem:(SUAppcastItem * _Nullable)secondaryUpdateItem -{ - id updaterDelegate = _updaterDelegate; - id delegate = _delegate; - - SPUUserUpdateStage stage; - // Major upgrades and information only updates are not downloaded automatically, as well as feeds that failed signing validation - if (_resumingDownloadedInfoOrUpdate && !updateItem.majorUpgrade && !updateItem.informationOnlyUpdate && updateItem.signingValidationStatus != SPUAppcastSigningValidationStatusFailed) { - stage = SPUUserUpdateStageDownloaded; - } else if (_resumingInstallingUpdate) { - stage = SPUUserUpdateStageInstalling; - } else { - stage = SPUUserUpdateStageNotDownloaded; - } - - SPUUserUpdateState *state = [[SPUUserUpdateState alloc] initWithStage:stage userInitiated:_userInitiated]; - - [_userDriver showUpdateFoundWithAppcastItem:updateItem state:state reply:^(SPUUserUpdateChoice userChoice) { - dispatch_async(dispatch_get_main_queue(), ^{ - - // Rule out invalid choices - SPUUserUpdateChoice validatedChoice; - if (updateItem.isInformationOnlyUpdate && userChoice == SPUUserUpdateChoiceInstall) { - validatedChoice = SPUUserUpdateChoiceDismiss; - } else { - validatedChoice = userChoice; - } - - id updater = self->_updater; - if (updater != nil) { - if ([updaterDelegate respondsToSelector:@selector(updater:userDidMakeChoice:forUpdate:state:)]) { - [updaterDelegate updater:updater userDidMakeChoice:validatedChoice forUpdate:updateItem state:state]; - } else if (validatedChoice == SPUUserUpdateChoiceSkip && [updaterDelegate respondsToSelector:@selector(updater:userDidSkipThisVersion:)]) { - #pragma clang diagnostic push - #pragma clang diagnostic ignored "-Wdeprecated-declarations" - [updaterDelegate updater:updater userDidSkipThisVersion:updateItem]; - #pragma clang diagnostic pop - } - } - - switch (validatedChoice) { - case SPUUserUpdateChoiceInstall: { - switch (stage) { - case SPUUserUpdateStageDownloaded: - [self->_coreDriver extractDownloadedUpdate]; - break; - case SPUUserUpdateStageInstalling: - [self->_coreDriver finishInstallationWithResponse:validatedChoice displayingUserInterface:YES]; - break; - case SPUUserUpdateStageNotDownloaded: - [self->_coreDriver downloadUpdateFromAppcastItem:updateItem secondaryAppcastItem:secondaryUpdateItem inBackground:NO]; - break; - } - break; - } - case SPUUserUpdateChoiceSkip: { - [SPUSkippedUpdate skipUpdate:updateItem host:self->_host]; - - switch (stage) { - case SPUUserUpdateStageDownloaded: - case SPUUserUpdateStageNotDownloaded: - // Informational and major updates can be resumed too, so make sure we check - // self->_resumingDownloadedInfoOrUpdate instead of the stage we pass to user driver - if (self->_resumingDownloadedInfoOrUpdate) { - [self->_coreDriver clearDownloadedUpdate]; - } - - [delegate uiDriverIsRequestingAbortUpdateWithError:nil]; - - break; - case SPUUserUpdateStageInstalling: - [self->_coreDriver finishInstallationWithResponse:validatedChoice displayingUserInterface:YES]; - break; - } - - break; - } - case SPUUserUpdateChoiceDismiss: { - switch (stage) { - case SPUUserUpdateStageDownloaded: - case SPUUserUpdateStageNotDownloaded: { - [self->_delegate uiDriverIsRequestingAbortUpdateWithError:nil]; - break; - } - case SPUUserUpdateStageInstalling: { - [self->_coreDriver finishInstallationWithResponse:validatedChoice displayingUserInterface:YES]; - break; - } - } - - break; - } - } - }); - }]; - - if ([delegate respondsToSelector:@selector(uiDriverDidShowUpdate)]) { - [delegate uiDriverDidShowUpdate]; - } - - if (updateItem.releaseNotesURL != nil && (![updaterDelegate respondsToSelector:@selector(updater:shouldDownloadReleaseNotesForUpdate:)] || [updaterDelegate updater:_updater shouldDownloadReleaseNotesForUpdate:updateItem])) { - - __weak __typeof__(self) weakSelf = self; - _releaseNotesDriver = [[SPUReleaseNotesDriver alloc] initWithReleaseNotesURL:updateItem.releaseNotesURL contentLength:updateItem.releaseNotesContentLength signatures:updateItem.releaseNotesSignatures httpHeaders:_httpHeaders userAgent:_userAgent host:_host completionHandler:^(SPUDownloadData * _Nullable downloadData, NSError * _Nullable error) { - __typeof__(self) strongSelf = weakSelf; - if (strongSelf != nil) { - id userDriver = strongSelf->_userDriver; - if (downloadData != nil) { - [userDriver showUpdateReleaseNotesWithDownloadData:(SPUDownloadData * _Nonnull)downloadData]; - } else { - [userDriver showUpdateReleaseNotesFailedToDownloadWithError:(NSError * _Nonnull)error]; - } - } - }]; - - [_releaseNotesDriver startDownload]; - } -} - -- (void)downloadDriverWillBeginDownload -{ - void (^cancelDownload)(void) = ^{ - dispatch_async(dispatch_get_main_queue(), ^{ - id updaterDelegate = self->_updaterDelegate; - if ([updaterDelegate respondsToSelector:@selector((userDidCancelDownload:))]) { - [updaterDelegate userDidCancelDownload:self->_updater]; - } - - [self->_delegate uiDriverIsRequestingAbortUpdateWithError:nil]; - }); - }; - - [_userDriver showDownloadInitiatedWithCancellation:cancelDownload]; -} - -- (void)downloadDriverDidReceiveExpectedContentLength:(uint64_t)expectedContentLength -{ - [_userDriver showDownloadDidReceiveExpectedContentLength:expectedContentLength]; -} - -- (void)downloadDriverDidReceiveDataOfLength:(uint64_t)length -{ - [_userDriver showDownloadDidReceiveDataOfLength:length]; -} - -- (void)coreDriverDidStartExtractingUpdate -{ - [_userDriver showDownloadDidStartExtractingUpdate]; -} - -- (void)installerDidStartInstallingWithApplicationTerminated:(BOOL)applicationTerminated -{ - if ([_userDriver respondsToSelector:@selector(showInstallingUpdateWithApplicationTerminated:retryTerminatingApplication:)]) { - __weak __typeof__(self) weakSelf = self; - [_userDriver showInstallingUpdateWithApplicationTerminated:applicationTerminated retryTerminatingApplication:^{ - if (!applicationTerminated) { - dispatch_async(dispatch_get_main_queue(), ^{ - __typeof__(self) strongSelf = weakSelf; - if (strongSelf != nil) { - [strongSelf->_coreDriver finishInstallationWithResponse:SPUUserUpdateChoiceInstall displayingUserInterface:YES]; - } - }); - } - }]; - } else if ([_userDriver respondsToSelector:@selector(showInstallingUpdateWithApplicationTerminated:)]) { -#pragma clang diagnostic push -#pragma clang diagnostic ignored "-Wdeprecated-declarations" - [_userDriver showInstallingUpdateWithApplicationTerminated:applicationTerminated]; -#pragma clang diagnostic pop - } else { -#pragma clang diagnostic push -#pragma clang diagnostic ignored "-Wdeprecated-declarations" - if ([_userDriver respondsToSelector:@selector(showInstallingUpdate)]) { - [_userDriver showInstallingUpdate]; - } - - if (!applicationTerminated) { - if ([_userDriver respondsToSelector:@selector(showSendingTerminationSignal)]) { - [_userDriver showSendingTerminationSignal]; - } - } -#pragma clang diagnostic pop - } -} - -- (void)installerDidExtractUpdateWithProgress:(double)progress -{ - [_userDriver showExtractionReceivedProgress:progress]; -} - -- (void)installerDidFinishPreparationAndWillInstallImmediately:(BOOL)willInstallImmediately -{ - if (!willInstallImmediately) { - [_userDriver showReadyToInstallAndRelaunch:^(SPUUserUpdateChoice choice) { - dispatch_async(dispatch_get_main_queue(), ^{ - [self->_coreDriver finishInstallationWithResponse:choice displayingUserInterface:YES]; - }); - }]; - } -} - -- (void)installerDidFinishInstallationAndRelaunched:(BOOL)relaunched acknowledgement:(void(^)(void))acknowledgement -{ - if ([_userDriver respondsToSelector:@selector(showUpdateInstalledAndRelaunched:acknowledgement:)]) { - [_userDriver showUpdateInstalledAndRelaunched:relaunched acknowledgement:acknowledgement]; - } else { -#pragma clang diagnostic push -#pragma clang diagnostic ignored "-Wdeprecated-declarations" - [_userDriver showUpdateInstallationDidFinishWithAcknowledgement:acknowledgement]; -#pragma clang diagnostic pop - } -} - -- (void)basicDriverIsRequestingAbortUpdateWithError:(nullable NSError *)error -{ - // A delegate may want to handle this type of error specially - [_delegate basicDriverIsRequestingAbortUpdateWithError:error]; -} - -- (void)coreDriverIsRequestingAbortUpdateWithError:(NSError *)error -{ - // A delegate may want to handle this type of error specially - [_delegate coreDriverIsRequestingAbortUpdateWithError:error]; -} - -- (void)_abortUpdateWithError:(nullable NSError *)error showErrorToUser:(BOOL)showErrorToUser SPU_OBJC_DIRECT -{ - void (^abortUpdate)(void) = ^{ - if (showErrorToUser) { - [self->_userDriver dismissUpdateInstallation]; - } - [self->_coreDriver abortUpdateAndShowNextUpdateImmediately:NO error:error]; - }; - - if (error != nil && showErrorToUser) { - NSError *nonNullError = error; - - if (error.code == SUNoUpdateError) { - if ([_userDriver respondsToSelector:@selector(showUpdateNotFoundWithError:acknowledgement:)]) { - [_userDriver showUpdateNotFoundWithError:(NSError * _Nonnull)error acknowledgement:^{ - dispatch_async(dispatch_get_main_queue(), ^{ - abortUpdate(); - }); - }]; - } else if ([_userDriver respondsToSelector:@selector(showUpdateNotFoundWithAcknowledgement:)]) { - // Eventually we should remove this fallback once clients adopt -showUpdateNotFoundWithError:acknowledgement: -#pragma clang diagnostic push -#pragma clang diagnostic ignored "-Wdeprecated-declarations" - [_userDriver showUpdateNotFoundWithAcknowledgement:^{ -#pragma clang diagnostic pop - dispatch_async(dispatch_get_main_queue(), ^{ - abortUpdate(); - }); - }]; - } - } else if (error.code == SUInstallationCanceledError || error.code == SUInstallationAuthorizeLaterError) { - abortUpdate(); - } else { - [_userDriver showUpdaterError:nonNullError acknowledgement:^{ - dispatch_async(dispatch_get_main_queue(), ^{ - abortUpdate(); - }); - }]; - } - } else { - abortUpdate(); - } -} - -- (void)abortUpdateWithError:(nullable NSError *)error showErrorToUser:(BOOL)showErrorToUser -{ - if (_releaseNotesDriver != nil) { - [_releaseNotesDriver cleanup:^{ - [self _abortUpdateWithError:error showErrorToUser:showErrorToUser]; - }]; - } else { - [self _abortUpdateWithError:error showErrorToUser:showErrorToUser]; - } -} - -@end diff --git a/Sparkle/SPUUpdateDriver.h b/Sparkle/SPUUpdateDriver.h index dd9872e9..b5c485b9 100644 --- a/Sparkle/SPUUpdateDriver.h +++ b/Sparkle/SPUUpdateDriver.h @@ -6,18 +6,43 @@ // Copyright © 2016 Sparkle Project. All rights reserved. // +#import + NS_ASSUME_NONNULL_BEGIN -@protocol SPUResumableUpdate; +@class SPUDownloadedUpdate; +@class SUHost; +@protocol SPUUserDriver, SPUUpdaterDelegate; -typedef void (^SPUUpdateDriverCompletion)(BOOL shouldShowUpdateImmediately, id _Nullable resumableUpdate, NSError * _Nullable error); +// The driver's cycle has ended. resumableLocalUpdate reflects the local state (a downloaded-but-not-installed +// update) that should be passed back in on the next cycle, if any. +typedef void (^SPUUpdateDriverCompletion)(BOOL shouldResetImpatientCheckDate, SPUDownloadedUpdate * _Nullable resumableLocalUpdate, NSError * _Nullable error); -// This protocol describes an update driver that drives updates -// An update driver may have multiple levels of other controller components (eg: basic update driver, core based update driver, ui based update driver, appcast driver, etc) -// The update driver and the components the driver has communicates via parameter passing and delegation.. -// The old Sparkle architecture communicated via subclassing and method overriding, but this lead to bugs due to high coupling, and complexity of not being aware of methods being executed. -// The newer architecture is still complex but should be more reliable to maintain and extend. -@protocol SPUUpdateDriver +typedef NS_ENUM(NSUInteger, SPUUpdateDriverInstallMode) { + // The driver only probes for update information and never shows anything or downloads/installs + // (eg: -checkForUpdateInformation) + SPUUpdateDriverInstallModeNone, + + // The driver may silently download and stage/install an update without asking first. + // If an update needs the user's attention before proceeding (eg: it's a major upgrade, + // informational-only, critical, or requires authorization), the driver escalates to + // SPUUpdateDriverInstallModeShowingUI in the same cycle rather than proceeding silently. + SPUUpdateDriverInstallModeAutomatic, + + // The driver presents UI via the user driver and asks before downloading/installing. + SPUUpdateDriverInstallModeShowingUI, +}; + +// This class drives an update check cycle: querying the appcast, downloading, extracting, +// installing, and presenting UI as needed, according to its install mode. +SPU_OBJC_DIRECT_MEMBERS @interface SPUUpdateDriver : NSObject + +- (instancetype)initWithHost:(SUHost *)host applicationBundle:(NSBundle *)applicationBundle updater:(id)updater userDriver:(nullable id )userDriver updaterDelegate:(nullable id )updaterDelegate userInitiated:(BOOL)userInitiated installMode:(SPUUpdateDriverInstallMode)installMode; + +// Only meaningful for a driver constructed with SPUUpdateDriverInstallModeAutomatic. +// Must be set (along with impatientUpdateCheckInterval) before starting a check. +@property (nonatomic, copy) NSDate *lastImpatientCheckedDate; +@property (nonatomic) NSTimeInterval impatientUpdateCheckInterval; - (void)setCompletionHandler:(SPUUpdateDriverCompletion)completionBlock; @@ -25,19 +50,17 @@ typedef void (^SPUUpdateDriverCompletion)(BOOL shouldShowUpdateImmediately, id)resumableUpdate; +// Checks for updates, resuming resumableLocalUpdate (a downloaded-but-not-installed update) if one +// was passed back from a prior cycle's completion handler. The driver also probes on its own for an +// update that an external installer job (eg: from another instance of the updater) +// may already be staging or installing; if it finds one, that global state +// takes priority over resumableLocalUpdate. +- (void)checkForUpdatesAtAppcastURL:(NSURL *)appcastURL withUserAgent:(NSString *)userAgent httpHeaders:(nullable NSDictionary *)httpHeaders resumingLocalUpdate:(nullable SPUDownloadedUpdate *)resumableLocalUpdate; @property (nonatomic, readonly) BOOL showingUpdate; -// A likely implementation of -abortUpdate is invoking -abortUpdateWithError: by passing nil -- (void)abortUpdate; - // This should be invoked on the update driver to finish the update driver's work -- (void)abortUpdateWithError:(NSError * _Nullable)error; +- (void)abortUpdateWithError:(nullable NSError *)error; @end diff --git a/Sparkle/SPUUpdateDriver.m b/Sparkle/SPUUpdateDriver.m new file mode 100644 index 00000000..f3bb289b --- /dev/null +++ b/Sparkle/SPUUpdateDriver.m @@ -0,0 +1,1053 @@ +// +// SPUUpdateDriver.m +// Sparkle +// +// Created by Mayur Pawashe on 3/15/16. +// Copyright © 2016 Sparkle Project. All rights reserved. +// + +#import "SPUUpdateDriver.h" +#import "SPUUserDriver.h" +#import "SUHost.h" +#import "SUConstants.h" +#import "SPUUpdaterDelegate.h" +#import "SUAppcastItem.h" +#import "SUErrors.h" +#import "SPUDownloadData.h" +#import "SPUReleaseNotesDriver.h" +#import "SPUSkippedUpdate.h" +#import "SPUUserUpdateState+Private.h" +#import "SUAppcastItem+Private.h" +#import "SPUUpdateCheck.h" +#import "SUAppcastDriver.h" +#import "SPUInstallerDriver.h" +#import "SPUDownloadDriver.h" +#import "SULog.h" +#import "SULog+NSError.h" +#import "SPUDownloadedUpdate.h" +#import "SPUInstallationType.h" +#import "SUPhasedUpdateGroupInfo.h" +#import "SPUProbeInstallStatus.h" +#import "SPUInstallationInfo.h" +#import "SUVersionDisplayProtocol.h" +#import "SPUStandardVersionDisplay.h" +#import "SPUNoUpdateFoundInfo.h" +#import "SUStandardVersionComparator.h" +#import "SULocalizations.h" + + +#include "AppKitPrevention.h" + +// Note: critical updates can be downloaded automatically first before needing user attention +static BOOL SPUUpdateRequiresUserAttentionBeforeDownloading(SUAppcastItem *updateItem) +{ + return (updateItem.isInformationOnlyUpdate || updateItem.majorUpgrade || updateItem.signingValidationStatus == SPUAppcastSigningValidationStatusFailed); +} + +@interface SPUUpdateDriver () +@end + +@implementation SPUUpdateDriver +{ + SUAppcastDriver *_appcastDriver; + SPUDownloadDriver *_downloadDriver; + SPUInstallerDriver *_installerDriver; + + SUHost *_host; + id _userDriver; + SPUReleaseNotesDriver *_releaseNotesDriver; + NSDictionary *_httpHeaders; + NSString *_userAgent; + + SUAppcastItem *_updateItem; + SUAppcastItem * _Nullable _secondaryUpdateItem; + + SPUDownloadedUpdate *_resumableLocalUpdate; + SPUDownloadedUpdate *_downloadedUpdateForRemoval; + + SPUInstallationInfo *_pendingResumeInstallationInfo; + + NSDate *_lastImpatientCheckedDate; + + SPUUpdateDriverCompletion _completionBlock; + void (^_updateShownHandler)(void); + + SPUUpdateDriverInstallMode _installMode; + SPUUserUpdateStage _currentStage; + + NSTimeInterval _impatientUpdateCheckInterval; + + __weak id _updater; + __weak id _updaterDelegate; + + BOOL _userInitiated; + BOOL _startedResumingInstallingUpdate; + BOOL _startedResumingDownloadedUpdate; + BOOL _installerDidFinishPreparation; + BOOL _showingUpdate; + BOOL _showingUserInitiatedProgress; + BOOL _aborted; + BOOL _impatientIntervalElapsedForResumingInstall; + BOOL _shouldResetImpatientCheckDate; +} + +@synthesize showingUpdate = _showingUpdate; +@synthesize lastImpatientCheckedDate = _lastImpatientCheckedDate; +@synthesize impatientUpdateCheckInterval = _impatientUpdateCheckInterval; + +- (instancetype)initWithHost:(SUHost *)host applicationBundle:(NSBundle *)applicationBundle updater:(id)updater userDriver:(id )userDriver updaterDelegate:(nullable id )updaterDelegate userInitiated:(BOOL)userInitiated installMode:(SPUUpdateDriverInstallMode)installMode +{ + self = [super init]; + if (self != nil) { + _host = host; + _userDriver = userDriver; + _updater = updater; + _updaterDelegate = updaterDelegate; + _userInitiated = userInitiated; + _installMode = installMode; + _lastImpatientCheckedDate = [NSDate date]; + + _appcastDriver = [[SUAppcastDriver alloc] initWithHost:host updater:updater updaterDelegate:updaterDelegate delegate:self]; + _installerDriver = [[SPUInstallerDriver alloc] initWithHost:host applicationBundle:applicationBundle updater:updater updaterDelegate:updaterDelegate delegate:self]; + } + return self; +} + +- (void)setCompletionHandler:(SPUUpdateDriverCompletion)completionBlock +{ + _completionBlock = [completionBlock copy]; +} + +- (void)setUpdateShownHandler:(void (^)(void))updateShownHandler +{ + _updateShownHandler = [updateShownHandler copy]; +} + +- (void)setUpdateWillInstallHandler:(void (^)(void))updateWillInstallHandler +{ + [_installerDriver setUpdateWillInstallHandler:updateWillInstallHandler]; +} + +#pragma mark - Preparing to check for updates + +- (void)fireUpdateShownHandlerIfNeeded SPU_OBJC_DIRECT +{ + if (_updateShownHandler != nil) { + _updateShownHandler(); + _updateShownHandler = nil; + } +} + +#pragma mark - Checking for updates + +- (void)checkForUpdatesAtAppcastURL:(NSURL *)appcastURL withUserAgent:(NSString *)userAgent httpHeaders:(NSDictionary * _Nullable)httpHeaders resumingLocalUpdate:(SPUDownloadedUpdate * _Nullable)resumableLocalUpdate +{ + _httpHeaders = httpHeaders; + _userAgent = [userAgent copy]; + + if (_userInitiated) { + [SPUSkippedUpdate clearSkippedUpdateForHost:_host]; + + _showingUserInitiatedProgress = YES; + + [self fireUpdateShownHandlerIfNeeded]; + + [_userDriver showUserInitiatedUpdateCheckWithCancellation:^{ + dispatch_async(dispatch_get_main_queue(), ^{ + if (self->_showingUserInitiatedProgress) { + [self abortUpdateWithError:nil]; + } + }); + }]; + } + + __weak __typeof__(self) weakSelf = self; + NSString *hostBundleIdentifier = _host.bundle.bundleIdentifier; + assert(hostBundleIdentifier != nil); + [SPUProbeInstallStatus probeInstallerUpdateItemForHostBundleIdentifier:hostBundleIdentifier completion:^(SPUInstallationInfo * _Nullable installationInfo) { + dispatch_async(dispatch_get_main_queue(), ^{ + __typeof__(self) strongSelf = weakSelf; + if (strongSelf == nil) { + return; + } + + if (installationInfo != nil) { + // An external installer job (eg: from another instance of the updater) is already + // staging or installing an update - that takes priority over resumableLocalUpdate + strongSelf->_startedResumingInstallingUpdate = YES; + + if (installationInfo.systemDomain || ![strongSelf->_host.bundle isEqual:NSBundle.mainBundle]) { + // When an update required auth or when updating another bundle that may + // have been started by another updater, don't risk canceling it + [strongSelf notifyFoundValidUpdateWithAppcastItem:installationInfo.appcastItem secondaryAppcastItem:nil systemDomain:@(installationInfo.systemDomain) resumingExistingUpdate:YES]; + return; + } + + strongSelf->_pendingResumeInstallationInfo = installationInfo; + } else if (resumableLocalUpdate != nil) { + strongSelf->_startedResumingDownloadedUpdate = YES; + strongSelf->_resumableLocalUpdate = resumableLocalUpdate; + } + + if ([strongSelf->_host isRunningOnReadOnlyVolume]) { + NSString *hostName = strongSelf->_host.name; +#if SPARKLE_COPY_LOCALIZATIONS + NSBundle *sparkleBundle = SUSparkleBundle(); +#endif + + if ([strongSelf->_host isRunningTranslocated]) { + [strongSelf abortUpdateWithError:[NSError errorWithDomain:SUSparkleErrorDomain code:SURunningTranslocated userInfo:@{ NSLocalizedRecoverySuggestionErrorKey: [NSString stringWithFormat:SULocalizedStringFromTableInBundle(@"Quit %1$@, move it into your Applications folder, relaunch it from there and try again.", SPARKLE_TABLE, sparkleBundle, nil), hostName], NSLocalizedDescriptionKey: [NSString stringWithFormat:SULocalizedStringFromTableInBundle(@"%1$@ can’t be updated if it’s running from the location it was downloaded to.", SPARKLE_TABLE, sparkleBundle, nil), hostName], }]]; + } else { + [strongSelf abortUpdateWithError:[NSError errorWithDomain:SUSparkleErrorDomain code:SURunningFromDiskImageError userInfo:@{ NSLocalizedDescriptionKey: [NSString stringWithFormat:SULocalizedStringFromTableInBundle(@"%1$@ can’t be updated because it was opened from a read-only or a temporary location.", SPARKLE_TABLE, sparkleBundle, nil), hostName], NSLocalizedRecoverySuggestionErrorKey: [NSString stringWithFormat:SULocalizedStringFromTableInBundle(@"Use Finder to copy %1$@ to the Applications folder, relaunch it from there, and try again.", SPARKLE_TABLE, sparkleBundle, nil), hostName] }]]; + } + } else { + BOOL resumingUpdate = (installationInfo != nil || resumableLocalUpdate != nil); + [strongSelf->_appcastDriver loadAppcastFromURL:appcastURL userAgent:userAgent httpHeaders:httpHeaders inBackground:!strongSelf->_userInitiated resumingUpdate:resumingUpdate]; + } + }); + }]; +} + +#pragma mark - SUAppcastDriverDelegate + +- (void)didFailToFetchAppcastWithError:(NSError *)error +{ + if (!_aborted) { + if (_pendingResumeInstallationInfo != nil) { + SUAppcastItem *pendingItem = _pendingResumeInstallationInfo.appcastItem; + BOOL pendingSystemDomain = _pendingResumeInstallationInfo.systemDomain; + _pendingResumeInstallationInfo = nil; + + // The appcast check itself failed, so pretend it finished loading so drivers stop showing fetching progress + [self notifyFoundValidUpdateWithAppcastItem:pendingItem secondaryAppcastItem:nil systemDomain:@(pendingSystemDomain) resumingExistingUpdate:YES]; + return; + } else if (_resumableLocalUpdate != nil) { + [self notifyFoundValidUpdateWithAppcastItem:_resumableLocalUpdate.updateItem secondaryAppcastItem:_resumableLocalUpdate.secondaryUpdateItem systemDomain:nil resumingExistingUpdate:YES]; + return; + } + + [self abortUpdateWithError:error]; + } +} + +- (void)didFinishLoadingAppcast:(SUAppcast *)appcast +{ + if (!_aborted) { + id updaterDelegate = _updaterDelegate; + if ([updaterDelegate respondsToSelector:@selector((updater:didFinishLoadingAppcast:))]) { + [updaterDelegate updater:_updater didFinishLoadingAppcast:appcast]; + } + } +} + +- (void)notifyFoundValidUpdateWithAppcastItem:(SUAppcastItem *)updateItem secondaryAppcastItem:(SUAppcastItem * _Nullable)secondaryUpdateItem systemDomain:(NSNumber * _Nullable)systemDomain resumingExistingUpdate:(BOOL)resumingExistingUpdate SPU_OBJC_DIRECT +{ + if (!_aborted) { + id updaterDelegate = _updaterDelegate; + id updater = _updater; + + if (!resumingExistingUpdate) { + // Give the delegate a chance to bail + + SPUUpdateCheck updateCheck; + if (_userInitiated) { + updateCheck = SPUUpdateCheckUpdates; + } else if (_installMode == SPUUpdateDriverInstallModeShowingUI || _installMode == SPUUpdateDriverInstallModeAutomatic) { + updateCheck = SPUUpdateCheckUpdatesInBackground; + } else { + updateCheck = SPUUpdateCheckUpdateInformation; + } + + NSError *shouldNotProceedError = nil; + if ([updaterDelegate respondsToSelector:@selector(updater:shouldProceedWithUpdate:updateCheck:error:)] && ![updaterDelegate updater:updater shouldProceedWithUpdate:updateItem updateCheck:updateCheck error:&shouldNotProceedError]) { + [self abortUpdateWithError:(shouldNotProceedError != nil) ? shouldNotProceedError : [NSError errorWithDomain:SUSparkleErrorDomain code:SUUpdateCheckDeclinedError userInfo:nil]]; + return; + } + } + + [[NSNotificationCenter defaultCenter] postNotificationName:SUUpdaterDidFindValidUpdateNotification + object:updater + userInfo:@{ SUUpdaterAppcastItemNotificationKey: updateItem }]; + + if ([updaterDelegate respondsToSelector:@selector((updater:didFindValidUpdate:))]) { + [updaterDelegate updater:updater didFindValidUpdate:updateItem]; + } + + _updateItem = updateItem; + _secondaryUpdateItem = secondaryUpdateItem; + + if (resumingExistingUpdate && _startedResumingInstallingUpdate) { + assert(systemDomain != nil); + [_installerDriver resumeInstallingUpdateWithUpdateItem:updateItem systemDomain:systemDomain.boolValue]; + } + + if (_installMode == SPUUpdateDriverInstallModeNone) { + // Probing: stop as soon as we have an answer + [self abortUpdateWithError:nil]; + return; + } + + if (resumingExistingUpdate) { + if (_startedResumingInstallingUpdate) { + _currentStage = SPUUserUpdateStageInstalling; + } else if (_startedResumingDownloadedUpdate) { + _currentStage = SPUUserUpdateStageDownloaded; + } else { + assert(false); + } + } else { + _currentStage = SPUUserUpdateStageNotDownloaded; + } + + if (_installMode == SPUUpdateDriverInstallModeShowingUI) { + [self presentUpdateFoundWithAppcastItem:updateItem secondaryAppcastItem:secondaryUpdateItem]; + return; + } + + // For automatic install mode, if we are resuming an installing update we will + // check if impatient interval elapsed, otherwise the last impatient update check date + // will be refreshed (when downloading a new fresh update or escalating to showing UI) + if (resumingExistingUpdate) { + if (_startedResumingInstallingUpdate) { + // The update has already finished preparation from a previous cycle + _installerDidFinishPreparation = YES; + + NSTimeInterval intervalSinceImpatientDate = [[NSDate date] timeIntervalSinceDate:_lastImpatientCheckedDate]; + _impatientIntervalElapsedForResumingInstall = (intervalSinceImpatientDate >= _impatientUpdateCheckInterval); + } + // This will escalate to showing UI if !_startedResumingInstallingUpdate + // because _installerDidFinishPreparation is NO + [self finishOrEscalateAutomaticCycleWithError:nil]; + } else { + if (SPUUpdateRequiresUserAttentionBeforeDownloading(updateItem)) { + // Escalate to showing UI right now for this item, rather than deferring to a later cycle + [self escalateToShowingUI]; + [self presentUpdateFoundWithAppcastItem:updateItem secondaryAppcastItem:secondaryUpdateItem]; + } else { + _shouldResetImpatientCheckDate = YES; + [self downloadUpdateFromAppcastItem:updateItem secondaryAppcastItem:secondaryUpdateItem inBackground:YES]; + } + } + } +} + +- (BOOL)pendingUpdateItem:(SUAppcastItem *)pendingUpdateItem isSupersededByUpdateItem:(SUAppcastItem *)newUpdateItem SPU_OBJC_DIRECT +{ + id versionComparator = nil; + id updaterDelegate = _updaterDelegate; + id updater = _updater; + if (updater != nil && [updaterDelegate respondsToSelector:@selector(versionComparatorForUpdater:)]) { +#pragma clang diagnostic push +#pragma clang diagnostic ignored "-Wdeprecated-declarations" + versionComparator = [updaterDelegate versionComparatorForUpdater:updater]; +#pragma clang diagnostic pop + } + if (versionComparator == nil) { + versionComparator = [SUStandardVersionComparator defaultComparator]; + } + + return ([versionComparator compareVersion:pendingUpdateItem.versionString toVersion:newUpdateItem.versionString] == NSOrderedAscending); +} + +- (void)didFindValidUpdateWithAppcastItem:(SUAppcastItem *)updateItem secondaryAppcastItem:(SUAppcastItem * _Nullable)secondaryAppcastItem +{ + if (_pendingResumeInstallationInfo != nil) { + SUAppcastItem *pendingItem = _pendingResumeInstallationInfo.appcastItem; + BOOL pendingSystemDomain = _pendingResumeInstallationInfo.systemDomain; + _pendingResumeInstallationInfo = nil; + + if (![self pendingUpdateItem:pendingItem isSupersededByUpdateItem:updateItem]) { + [self notifyFoundValidUpdateWithAppcastItem:pendingItem secondaryAppcastItem:nil systemDomain:@(pendingSystemDomain) resumingExistingUpdate:YES]; + return; + } + + // No need to discard the prior resumable installed update. + // The update will be discarded when we submit new installer job + } else if (_resumableLocalUpdate != nil) { + if (![self pendingUpdateItem:_resumableLocalUpdate.updateItem isSupersededByUpdateItem:updateItem]) { + [self notifyFoundValidUpdateWithAppcastItem:_resumableLocalUpdate.updateItem secondaryAppcastItem:_resumableLocalUpdate.secondaryUpdateItem systemDomain:nil resumingExistingUpdate:YES]; + return; + } else { + // Discard stale resumable update + [self clearDownloadedUpdate]; + } + } + + [self notifyFoundValidUpdateWithAppcastItem:updateItem secondaryAppcastItem:secondaryAppcastItem systemDomain:nil resumingExistingUpdate:NO]; +} + +- (void)didNotFindUpdateWithLatestAppcastItem:(nullable SUAppcastItem *)latestAppcastItem hostToLatestAppcastItemComparisonResult:(NSComparisonResult)hostToLatestAppcastItemComparisonResult background:(BOOL)background +{ + if (!_aborted) { + if (_pendingResumeInstallationInfo != nil) { + SUAppcastItem *pendingItem = _pendingResumeInstallationInfo.appcastItem; + BOOL pendingSystemDomain = _pendingResumeInstallationInfo.systemDomain; + _pendingResumeInstallationInfo = nil; + + [self notifyFoundValidUpdateWithAppcastItem:pendingItem secondaryAppcastItem:nil systemDomain:@(pendingSystemDomain) resumingExistingUpdate:YES]; + return; + } else if (_resumableLocalUpdate != nil) { + [self notifyFoundValidUpdateWithAppcastItem:_resumableLocalUpdate.updateItem secondaryAppcastItem:_resumableLocalUpdate.secondaryUpdateItem systemDomain:nil resumingExistingUpdate:YES]; + return; + } + + NSString *localizedDescription; + +#if SPARKLE_COPY_LOCALIZATIONS + NSBundle *sparkleBundle = SUSparkleBundle(); +#else + NSBundle *sparkleBundle = nil; +#endif + + SPUNoUpdateFoundReason reason; + if (latestAppcastItem != nil) { + switch (hostToLatestAppcastItemComparisonResult) { + case NSOrderedDescending: + // This means the user is a 'newer than latest' version. give a slight hint to the user instead of wrongly claiming this version is identical to the latest feed version. + localizedDescription = SULocalizedStringFromTableInBundle(@"You’re up to date!", SPARKLE_TABLE, sparkleBundle, "Status message shown when the user checks for updates but is already current or the feed doesn't contain any updates."); + + reason = SPUNoUpdateFoundReasonOnNewerThanLatestVersion; + break; + case NSOrderedSame: + // No new update is available and we're on the latest + localizedDescription = SULocalizedStringFromTableInBundle(@"You’re up to date!", SPARKLE_TABLE, sparkleBundle, "Status message shown when the user checks for updates but is already current or the feed doesn't contain any updates."); + + reason = SPUNoUpdateFoundReasonOnLatestVersion; + break; + case NSOrderedAscending: + // A new update is available but cannot be installed + // More detailed recovery suggestions are in SPUNoUpdateFoundRecoverySuggestion() + + if (!latestAppcastItem.arm64HardwareRequirementIsOK) { + localizedDescription = SULocalizedStringFromTableInBundle(@"Your Mac is too old", SPARKLE_TABLE, sparkleBundle, nil); + + reason = SPUNoUpdateFoundReasonHardwareDoesNotSupportARM64; + } else if (!latestAppcastItem.minimumOperatingSystemVersionIsOK) { + localizedDescription = SULocalizedStringFromTableInBundle(@"Your macOS version is too old", SPARKLE_TABLE, sparkleBundle, nil); + + reason = SPUNoUpdateFoundReasonSystemIsTooOld; + } else if (!latestAppcastItem.maximumOperatingSystemVersionIsOK) { + localizedDescription = SULocalizedStringFromTableInBundle(@"Your macOS version is too new", SPARKLE_TABLE, sparkleBundle, nil); + + reason = SPUNoUpdateFoundReasonSystemIsTooNew; + } else { + // We shouldn't realistically get here + localizedDescription = SULocalizedStringFromTableInBundle(@"You’re up to date!", SPARKLE_TABLE, sparkleBundle, "Status message shown when the user checks for updates but is already current or the feed doesn't contain any updates."); + + reason = SPUNoUpdateFoundReasonUnknown; + } + break; + } + } else { + // When no updates are found in the appcast + // We will need to assume the user is up to date if the feed doesn't have any applicable update items + // There could be update items on channels the updater is not subscribed to for example. But we can't tell the user about them. + // There could also only be update items available for other platforms or none at all. + localizedDescription = SULocalizedStringFromTableInBundle(@"You’re up to date!", SPARKLE_TABLE, sparkleBundle, "Status message shown when the user checks for updates but is already current or the feed doesn't contain any updates."); + + reason = SPUNoUpdateFoundReasonOnLatestVersion; + } + + // We use the standard version displayer here to construct a reason string, + // but it's possible for the user driver to override this before displaying if they wish + id versionDisplayer = [SPUStandardVersionDisplay standardVersionDisplay]; + NSString *recoverySuggestion = SPUNoUpdateFoundRecoverySuggestion(reason, latestAppcastItem, _host, versionDisplayer, sparkleBundle); + + NSString *recoveryOption = SULocalizedStringFromTableInBundle(@"OK", SPARKLE_TABLE, sparkleBundle, nil); + + NSMutableDictionary *userInfo = + [NSMutableDictionary dictionaryWithDictionary:@{ + NSLocalizedDescriptionKey: localizedDescription, + NSLocalizedRecoverySuggestionErrorKey: recoverySuggestion, + NSLocalizedRecoveryOptionsErrorKey: @[recoveryOption], + SPUNoUpdateFoundReasonKey: @(reason), + SPUNoUpdateFoundUserInitiatedKey: @(!background), + }]; + + if (latestAppcastItem != nil) { + userInfo[SPULatestAppcastItemFoundKey] = latestAppcastItem; + } + + NSError *notFoundError = + [NSError + errorWithDomain:SUSparkleErrorDomain + code:SUNoUpdateError + userInfo:[userInfo copy]]; + + id updaterDelegate = _updaterDelegate; + id updater = _updater; + + if (updater != nil) { + if ([updaterDelegate respondsToSelector:@selector((updaterDidNotFindUpdate:error:))]) { + [updaterDelegate updaterDidNotFindUpdate:updater error:notFoundError]; + } else if ([updaterDelegate respondsToSelector:@selector((updaterDidNotFindUpdate:))]) { + [updaterDelegate updaterDidNotFindUpdate:updater]; + } + + [[NSNotificationCenter defaultCenter] postNotificationName:SUUpdaterDidNotFindUpdateNotification object:updater userInfo:userInfo]; + } + + [self abortUpdateWithError:notFoundError]; + } +} + +#pragma mark - Finding an update + +- (void)escalateToShowingUI SPU_OBJC_DIRECT +{ + _installMode = SPUUpdateDriverInstallModeShowingUI; + _shouldResetImpatientCheckDate = YES; +} + +- (void)presentUpdateFoundWithAppcastItem:(SUAppcastItem *)updateItem secondaryAppcastItem:(SUAppcastItem * _Nullable)secondaryUpdateItem SPU_OBJC_DIRECT +{ + id updaterDelegate = _updaterDelegate; + SPUUserUpdateStage stage = _currentStage; + + SPUUserUpdateState *state = [[SPUUserUpdateState alloc] initWithStage:stage userInitiated:_userInitiated]; + + [_userDriver showUpdateFoundWithAppcastItem:updateItem state:state reply:^(SPUUserUpdateChoice userChoice) { + dispatch_async(dispatch_get_main_queue(), ^{ + + // Rule out invalid choices + SPUUserUpdateChoice validatedChoice; + if (updateItem.isInformationOnlyUpdate && userChoice == SPUUserUpdateChoiceInstall) { + validatedChoice = SPUUserUpdateChoiceDismiss; + } else { + validatedChoice = userChoice; + } + + id updater = self->_updater; + if (updater != nil) { + if ([updaterDelegate respondsToSelector:@selector(updater:userDidMakeChoice:forUpdate:state:)]) { + [updaterDelegate updater:updater userDidMakeChoice:validatedChoice forUpdate:updateItem state:state]; + } else if (validatedChoice == SPUUserUpdateChoiceSkip && [updaterDelegate respondsToSelector:@selector(updater:userDidSkipThisVersion:)]) { + #pragma clang diagnostic push + #pragma clang diagnostic ignored "-Wdeprecated-declarations" + [updaterDelegate updater:updater userDidSkipThisVersion:updateItem]; + #pragma clang diagnostic pop + } + } + + switch (validatedChoice) { + case SPUUserUpdateChoiceInstall: { + switch (stage) { + case SPUUserUpdateStageDownloaded: + [self extractUpdate]; + break; + case SPUUserUpdateStageInstalling: + [self finishInstallationWithResponse:validatedChoice displayingUserInterface:YES]; + break; + case SPUUserUpdateStageNotDownloaded: + [self downloadUpdateFromAppcastItem:updateItem secondaryAppcastItem:secondaryUpdateItem inBackground:NO]; + break; + } + break; + } + case SPUUserUpdateChoiceSkip: { + [SPUSkippedUpdate skipUpdate:updateItem host:self->_host]; + + switch (stage) { + case SPUUserUpdateStageDownloaded: + case SPUUserUpdateStageNotDownloaded: + if (stage == SPUUserUpdateStageDownloaded) { + [self clearDownloadedUpdate]; + } + + [self abortUpdateWithError:nil]; + + break; + case SPUUserUpdateStageInstalling: + [self finishInstallationWithResponse:validatedChoice displayingUserInterface:YES]; + break; + } + + break; + } + case SPUUserUpdateChoiceDismiss: { + switch (stage) { + case SPUUserUpdateStageDownloaded: + case SPUUserUpdateStageNotDownloaded: { + [self abortUpdateWithError:nil]; + break; + } + case SPUUserUpdateStageInstalling: { + [self finishInstallationWithResponse:validatedChoice displayingUserInterface:YES]; + break; + } + } + + break; + } + } + }); + }]; + + _showingUpdate = YES; + [self fireUpdateShownHandlerIfNeeded]; + + NSURL *releaseNotesURL = updateItem.releaseNotesURL; + if (releaseNotesURL != nil && (![updaterDelegate respondsToSelector:@selector(updater:shouldDownloadReleaseNotesForUpdate:)] || [updaterDelegate updater:_updater shouldDownloadReleaseNotesForUpdate:updateItem])) { + + __weak __typeof__(self) weakSelf = self; + _releaseNotesDriver = [[SPUReleaseNotesDriver alloc] initWithReleaseNotesURL:releaseNotesURL contentLength:updateItem.releaseNotesContentLength signatures:updateItem.releaseNotesSignatures httpHeaders:_httpHeaders userAgent:_userAgent host:_host completionHandler:^(SPUDownloadData * _Nullable downloadData, NSError * _Nullable error) { + __typeof__(self) strongSelf = weakSelf; + if (strongSelf != nil) { + id userDriver = strongSelf->_userDriver; + if (downloadData != nil) { + [userDriver showUpdateReleaseNotesWithDownloadData:(SPUDownloadData * _Nonnull)downloadData]; + } else { + [userDriver showUpdateReleaseNotesFailedToDownloadWithError:(NSError * _Nonnull)error]; + } + } + }]; + + [_releaseNotesDriver startDownload]; + } +} + +#pragma mark - Downloading (a no-op UI-wise while still silently downloading in automatic mode) + +- (void)downloadUpdateFromAppcastItem:(SUAppcastItem *)updateItem secondaryAppcastItem:(SUAppcastItem * _Nullable)secondaryUpdateItem inBackground:(BOOL)background SPU_OBJC_DIRECT +{ + _downloadDriver = [[SPUDownloadDriver alloc] initWithUpdateItem:updateItem secondaryUpdateItem:secondaryUpdateItem host:_host userAgent:_userAgent httpHeaders:_httpHeaders inBackground:background delegate:self]; + + id updater = _updater; + id updaterDelegate = _updaterDelegate; + + if (updater != nil && [updaterDelegate respondsToSelector:@selector((updater:willDownloadUpdate:withRequest:))]) { + [updaterDelegate updater:updater willDownloadUpdate:updateItem withRequest:_downloadDriver.request]; + } + + [_downloadDriver downloadFile]; +} + +- (void)downloadDriverWillBeginDownload +{ + if (_installMode != SPUUpdateDriverInstallModeShowingUI) { + return; + } + + void (^cancelDownload)(void) = ^{ + dispatch_async(dispatch_get_main_queue(), ^{ + id updaterDelegate = self->_updaterDelegate; + if ([updaterDelegate respondsToSelector:@selector((userDidCancelDownload:))]) { + [updaterDelegate userDidCancelDownload:self->_updater]; + } + + [self abortUpdateWithError:nil]; + }); + }; + + [_userDriver showDownloadInitiatedWithCancellation:cancelDownload]; +} + +- (void)downloadDriverDidReceiveExpectedContentLength:(uint64_t)expectedContentLength +{ + if (_installMode != SPUUpdateDriverInstallModeShowingUI) { + return; + } + [_userDriver showDownloadDidReceiveExpectedContentLength:expectedContentLength]; +} + +- (void)downloadDriverDidReceiveDataOfLength:(uint64_t)length +{ + if (_installMode != SPUUpdateDriverInstallModeShowingUI) { + return; + } + [_userDriver showDownloadDidReceiveDataOfLength:length]; +} + +- (void)downloadDriverDidDownloadUpdate:(SPUDownloadedUpdate *)downloadedUpdate +{ + // Use a new update group for our next downloaded update + // We could restrict this to when the appcast was downloaded in the background, + // but it shouldn't matter. + if (downloadedUpdate.updateItem.phasedRolloutInterval != nil) { + [SUPhasedUpdateGroupInfo setNewUpdateGroupIdentifierForHost:_host]; + } + + id updater = _updater; + id updaterDelegate = _updaterDelegate; + + if (updater != nil && [updaterDelegate respondsToSelector:@selector(updater:didDownloadUpdate:)]) { + [updaterDelegate updater:updater didDownloadUpdate:_updateItem]; + } + + _resumableLocalUpdate = downloadedUpdate; + [self extractUpdate]; +} + +- (void)downloadDriverDidFailToDownloadFileWithError:(NSError *)error +{ + if ([_updateItem isDeltaUpdate]) { + SULog(SULogLevelError, @"Failed to download delta update. Falling back to regular update..."); + SULogError(error); + + [self fallBackAndDownloadRegularUpdate]; + } else { + id updater = _updater; + id updaterDelegate = _updaterDelegate; + + if (updater != nil && [updaterDelegate respondsToSelector:@selector((updater:failedToDownloadUpdate:error:))]) { + NSError *errorToReport = [error.userInfo objectForKey:NSUnderlyingErrorKey]; + if (errorToReport == nil) { + errorToReport = error; + } + + [updaterDelegate updater:updater failedToDownloadUpdate:_updateItem error:errorToReport]; + } + + [self abortUpdateWithError:error]; + } +} + +- (void)fallBackAndDownloadRegularUpdate SPU_OBJC_DIRECT +{ + SUAppcastItem *secondaryUpdateItem = _secondaryUpdateItem; + assert(secondaryUpdateItem != nil); + + BOOL backgroundDownload = _downloadDriver.inBackground; + + // Fall back to the non-delta update. Note that we don't want to trigger another update was found event. + _updateItem = secondaryUpdateItem; + _secondaryUpdateItem = nil; + + [self downloadUpdateFromAppcastItem:secondaryUpdateItem secondaryAppcastItem:nil inBackground:backgroundDownload]; +} + +#pragma mark - Extracting + +- (void)extractUpdate SPU_OBJC_DIRECT +{ + SPUDownloadedUpdate *downloadedUpdate = _resumableLocalUpdate; + assert(downloadedUpdate != nil); + + id updater = _updater; + id updaterDelegate = _updaterDelegate; + + if (updater != nil && [updaterDelegate respondsToSelector:@selector(updater:willExtractUpdate:)]) { + [updaterDelegate updater:updater willExtractUpdate:_updateItem]; + } + + // Now we have to extract the downloaded archive. + _currentStage = SPUUserUpdateStageDownloaded; + if (_installMode == SPUUpdateDriverInstallModeShowingUI) { + [_userDriver showDownloadDidStartExtractingUpdate]; + } + + [_installerDriver extractDownloadedUpdate:downloadedUpdate silently:(_installMode == SPUUpdateDriverInstallModeAutomatic) completion:^(NSError * _Nullable error) { + if (error != nil) { + if (error.code != SUInstallationAuthorizeLaterError) { + [self clearDownloadedUpdate]; + [self abortUpdateWithError:error]; + } else { + [self finishOrEscalateAutomaticCycleWithError:error]; + } + } else { + // If the installer started properly, we can't use the downloaded update archive anymore + // Especially if the installer fails later and we try resuming the update with a missing archive file + // We must clear the download after the installer begins using it however (in -installerDidStartInstalling) + self->_downloadedUpdateForRemoval = downloadedUpdate; + self->_resumableLocalUpdate = nil; + + if (updater != nil && [updaterDelegate respondsToSelector:@selector(updater:didExtractUpdate:)]) { + [updaterDelegate updater:updater didExtractUpdate:self->_updateItem]; + } + } + }]; +} + +- (void)clearDownloadedUpdate SPU_OBJC_DIRECT +{ + SPUDownloadedUpdate *downloadedUpdate = (_resumableLocalUpdate != nil) ? _resumableLocalUpdate : _downloadedUpdateForRemoval; + + if (downloadedUpdate == nil) { + SULog(SULogLevelError, @"Warning: clearDownloadedUpdate called but no downloaded update is tracked"); + return; + } + + if (_downloadDriver == nil) { + _downloadDriver = [[SPUDownloadDriver alloc] initWithHost:_host]; + } + + [_downloadDriver removeDownloadedUpdate:downloadedUpdate]; + + // Clear any type of resumable update + _resumableLocalUpdate = nil; +} + +- (void)installerDidStartExtracting +{ + // The installer has moved the archive and no longer needs the download directory + [self clearDownloadedUpdate]; +} + +- (void)installerDidExtractUpdateWithProgress:(double)progress +{ + if (_installMode != SPUUpdateDriverInstallModeShowingUI) { + return; + } + [_userDriver showExtractionReceivedProgress:progress]; +} + +#pragma mark - Installing + +- (void)installerDidStartInstallingWithApplicationTerminated:(BOOL)applicationTerminated +{ + if (_installMode != SPUUpdateDriverInstallModeShowingUI) { + return; + } + + if ([_userDriver respondsToSelector:@selector(showInstallingUpdateWithApplicationTerminated:retryTerminatingApplication:)]) { + __weak __typeof__(self) weakSelf = self; + [_userDriver showInstallingUpdateWithApplicationTerminated:applicationTerminated retryTerminatingApplication:^{ + if (!applicationTerminated) { + dispatch_async(dispatch_get_main_queue(), ^{ + __typeof__(self) strongSelf = weakSelf; + if (strongSelf != nil) { + [strongSelf finishInstallationWithResponse:SPUUserUpdateChoiceInstall displayingUserInterface:YES]; + } + }); + } + }]; + } else if ([_userDriver respondsToSelector:@selector(showInstallingUpdateWithApplicationTerminated:)]) { +#pragma clang diagnostic push +#pragma clang diagnostic ignored "-Wdeprecated-declarations" + [_userDriver showInstallingUpdateWithApplicationTerminated:applicationTerminated]; +#pragma clang diagnostic pop + } else { +#pragma clang diagnostic push +#pragma clang diagnostic ignored "-Wdeprecated-declarations" + if ([_userDriver respondsToSelector:@selector(showInstallingUpdate)]) { + [_userDriver showInstallingUpdate]; + } + + if (!applicationTerminated) { + if ([_userDriver respondsToSelector:@selector(showSendingTerminationSignal)]) { + [_userDriver showSendingTerminationSignal]; + } + } +#pragma clang diagnostic pop + } +} + +#pragma mark - Ready to install + +- (void)installerDidFinishPreparationAndWillInstallImmediately:(BOOL)willInstallImmediately +{ + _installerDidFinishPreparation = YES; + _currentStage = SPUUserUpdateStageInstalling; + + if (willInstallImmediately) { + return; + } + + if (_installMode == SPUUpdateDriverInstallModeShowingUI) { + [_userDriver showReadyToInstallAndRelaunch:^(SPUUserUpdateChoice choice) { + dispatch_async(dispatch_get_main_queue(), ^{ + [self finishInstallationWithResponse:choice displayingUserInterface:YES]; + }); + }]; + + _showingUpdate = YES; + [self fireUpdateShownHandlerIfNeeded]; + } else { + // Give the delegate a chance to handle installing on quit itself, bypassing Sparkle's own UI entirely - + // this takes priority over escalating to show UI, even for a critical update + id updaterDelegate = _updaterDelegate; + BOOL installationHandledByDelegate; + if ([updaterDelegate respondsToSelector:@selector(updater:willInstallUpdateOnQuit:immediateInstallationBlock:)]) { + __weak __typeof__(self) weakSelf = self; + installationHandledByDelegate = [updaterDelegate updater:_updater willInstallUpdateOnQuit:_updateItem immediateInstallationBlock:^{ + dispatch_async(dispatch_get_main_queue(), ^{ + __typeof__(self) strongSelf = weakSelf; + if (strongSelf != nil) { + [strongSelf finishInstallationWithResponse:SPUUserUpdateChoiceInstall displayingUserInterface:NO]; + } + }); + }]; + } else { + installationHandledByDelegate = NO; + } + + if (!installationHandledByDelegate) { + [self finishOrEscalateAutomaticCycleWithError:nil]; + } + } +} + +- (void)installerWillFinishInstallationAndRelaunch:(BOOL)relaunch +{ + id updater = _updater; + id updaterDelegate = _updaterDelegate; + + if (updater != nil) { + if ([updaterDelegate respondsToSelector:@selector((updater:willInstallUpdate:))]) { + [updaterDelegate updater:updater willInstallUpdate:_updateItem]; + } + + if (relaunch) { + [[NSNotificationCenter defaultCenter] postNotificationName:SUUpdaterWillRestartNotification object:updater]; + if ([updaterDelegate respondsToSelector:@selector((updaterWillRelaunchApplication:))]) { + [updaterDelegate updaterWillRelaunchApplication:updater]; + } + } + } +} + +- (void)installerDidFinishInstallationAndRelaunched:(BOOL)relaunched acknowledgement:(void(^)(void))acknowledgement +{ + if (_installMode != SPUUpdateDriverInstallModeShowingUI) { + acknowledgement(); + return; + } + + if ([_userDriver respondsToSelector:@selector(showUpdateInstalledAndRelaunched:acknowledgement:)]) { + [_userDriver showUpdateInstalledAndRelaunched:relaunched acknowledgement:acknowledgement]; + } else { +#pragma clang diagnostic push +#pragma clang diagnostic ignored "-Wdeprecated-declarations" + [_userDriver showUpdateInstallationDidFinishWithAcknowledgement:acknowledgement]; +#pragma clang diagnostic pop + } +} + +- (void)installerIsRequestingAbortInstallWithError:(nullable NSError *)error +{ + [self abortUpdateWithError:error]; +} + +- (void)installerDidFailToApplyDeltaUpdate +{ + [self clearDownloadedUpdate]; + + [self fallBackAndDownloadRegularUpdate]; +} + +- (void)finishInstallationWithResponse:(SPUUserUpdateChoice)response displayingUserInterface:(BOOL)displayingUserInterface SPU_OBJC_DIRECT +{ + switch (response) { + case SPUUserUpdateChoiceDismiss: + [self abortUpdateWithError:nil]; + break; + case SPUUserUpdateChoiceSkip: + [_installerDriver cancelUpdate]; + break; + case SPUUserUpdateChoiceInstall: + [_installerDriver installWithToolAndRelaunch:YES displayingUserInterface:displayingUserInterface]; + break; + } +} + +#pragma mark - Ending a cycle + +- (void)finishOrEscalateAutomaticCycleWithError:(nullable NSError *)error SPU_OBJC_DIRECT +{ + // Check if we need to escalate the automatic cycle into a UI one + // If an error occurs it must be SUInstallationAuthorizeLaterError for escalation + // if _updateItem == nil, we didn't get far enough in the driver to even find an update + // If !_installerDidFinishPreparation, we didn't get far enough to prepare installing a new update + // (e.g. it could be a local download resumable update). + if ((error == nil || error.code == SUInstallationAuthorizeLaterError) && + (_updateItem != nil) && + (!_installerDidFinishPreparation || _updateItem.criticalUpdate || SPUUpdateRequiresUserAttentionBeforeDownloading(_updateItem) || + _impatientIntervalElapsedForResumingInstall)) { + [self escalateToShowingUI]; + [self presentUpdateFoundWithAppcastItem:_updateItem secondaryAppcastItem:_secondaryUpdateItem]; + } else { + [self finishWithError:error]; + } +} + +- (void)abortUpdateWithError:(nullable NSError *)error +{ + if (_installMode == SPUUpdateDriverInstallModeShowingUI) { + _showingUserInitiatedProgress = NO; + _aborted = YES; + + BOOL showErrorToUser = _userInitiated || _showingUpdate; + + if (_releaseNotesDriver != nil) { + [_releaseNotesDriver cleanup:^{ + [self abortShowingUIWithError:error showErrorToUser:showErrorToUser]; + }]; + } else { + [self abortShowingUIWithError:error showErrorToUser:showErrorToUser]; + } + } else { + [self finishWithError:error]; + } +} + +- (void)abortShowingUIWithError:(nullable NSError *)error showErrorToUser:(BOOL)showErrorToUser SPU_OBJC_DIRECT +{ + void (^finish)(void) = ^{ + if (showErrorToUser) { + [self->_userDriver dismissUpdateInstallation]; + } + [self finishWithError:error]; + }; + + if (error != nil && showErrorToUser) { + NSError *nonNullError = error; + + if (error.code == SUNoUpdateError) { + if ([_userDriver respondsToSelector:@selector(showUpdateNotFoundWithError:acknowledgement:)]) { + [_userDriver showUpdateNotFoundWithError:(NSError * _Nonnull)error acknowledgement:^{ + dispatch_async(dispatch_get_main_queue(), ^{ + finish(); + }); + }]; + } else if ([_userDriver respondsToSelector:@selector(showUpdateNotFoundWithAcknowledgement:)]) { + // Eventually we should remove this fallback once clients adopt -showUpdateNotFoundWithError:acknowledgement: +#pragma clang diagnostic push +#pragma clang diagnostic ignored "-Wdeprecated-declarations" + [_userDriver showUpdateNotFoundWithAcknowledgement:^{ +#pragma clang diagnostic pop + dispatch_async(dispatch_get_main_queue(), ^{ + finish(); + }); + }]; + } + } else if (error.code == SUInstallationCanceledError) { + finish(); + } else { + [_userDriver showUpdaterError:nonNullError acknowledgement:^{ + dispatch_async(dispatch_get_main_queue(), ^{ + finish(); + }); + }]; + } + } else { + finish(); + } +} + +- (void)finishWithError:(nullable NSError *)error SPU_OBJC_DIRECT +{ + [_installerDriver abortInstall]; + + void (^finishAbort)(void) = ^{ + SPUDownloadedUpdate *resumableUpdate = (error == nil) ? self->_resumableLocalUpdate : nil; + + self->_aborted = YES; + + [self->_appcastDriver cleanup:^{ + if (self->_completionBlock != nil) { + self->_completionBlock(self->_shouldResetImpatientCheckDate, resumableUpdate, error); + self->_completionBlock = nil; + } + }]; + }; + + if (_downloadDriver != nil) { + [_downloadDriver cleanup:^{ + finishAbort(); + }]; + } else { + finishAbort(); + } +} + +@end diff --git a/Sparkle/SPUUpdater.m b/Sparkle/SPUUpdater.m index 268e2dcf..480ce027 100644 --- a/Sparkle/SPUUpdater.m +++ b/Sparkle/SPUUpdater.m @@ -19,18 +19,12 @@ #import "SULog+NSError.h" #import "SUCodeSigningVerifier.h" #import "SUSystemProfiler.h" -#import "SPUScheduledUpdateDriver.h" -#import "SPUProbingUpdateDriver.h" -#import "SPUUserInitiatedUpdateDriver.h" -#import "SPUAutomaticUpdateDriver.h" -#import "SPUProbeInstallStatus.h" #import "SUAppcastItem.h" -#import "SPUInstallationInfo.h" #import "SUErrors.h" #import "SPUXPCServiceInfo.h" #import "SPUUpdaterCycle.h" #import "SPUUpdaterTimer.h" -#import "SPUResumableUpdate.h" +#import "SPUDownloadedUpdate.h" #import "SUSignatures.h" #import "SPUUserAgent+Private.h" #import "SPUGentleUserDriverReminders.h" @@ -56,7 +50,7 @@ NSString *const SUUpdaterAppcastNotificationKey = @"SUUpdaterAppCastNotification @implementation SPUUpdater { id _userDriver; - id _driver; + SPUUpdateDriver *_driver; SUHost *_host; SUHost *_mainBundleHost; NSBundle *_applicationBundle; @@ -64,8 +58,9 @@ NSString *const SUUpdaterAppcastNotificationKey = @"SUUpdaterAppCastNotification SPUUpdaterSettings *_updaterSettings; SPUUpdaterCycle *_updaterCycle; SPUUpdaterTimer *_updaterTimer; - id _resumableUpdate; + SPUDownloadedUpdate *_resumableLocalUpdate; NSDate *_updateLastCheckedDate; + NSDate *_updateLastImpatientCheckedDate; NSURL *_lastCheckedFeedURL; NSSet * _lastAllowedChannels; @@ -105,6 +100,10 @@ NSString *const SUUpdaterAppcastNotificationKey = @"SUUpdaterAppCastNotification _delegate = delegate; + // Initialized to the current date instead of nil so the first update check runs + // correctly if there's a installation in progress by another external updater + _updateLastImpatientCheckedDate = [NSDate date]; + NSBundle *mainBundle = [NSBundle mainBundle]; _updatingMainBundle = [hostBundle isEqualTo:mainBundle]; @@ -515,87 +514,58 @@ NSString *const SUUpdaterAppcastNotificationKey = @"SUUpdaterAppCastNotification if (firingImmediately) { [self _checkForUpdatesInBackground]; } else { - // This may not return the same update check interval as the developer has configured - // Notably it may differ when we have an update that has been already downloaded and needs to resume, - // as well as if that update is marked critical or not - void (^retrieveNextUpdateCheckInterval)(void (^)(NSTimeInterval)) = ^(void (^completionHandler)(NSTimeInterval)) { - NSString *hostBundleIdentifier = self->_host.bundle.bundleIdentifier; - assert(hostBundleIdentifier != nil); - [SPUProbeInstallStatus probeInstallerUpdateItemForHostBundleIdentifier:hostBundleIdentifier completion:^(SPUInstallationInfo * _Nullable installationInfo) { - dispatch_async(dispatch_get_main_queue(), ^{ - NSTimeInterval regularCheckInterval = [self updateCheckInterval]; - NSTimeInterval impatientCheckInterval = [self->_updaterSettings impatientUpdateCheckInterval]; - if (installationInfo == nil) { - // Proceed as normal if there's no resumable updates - completionHandler(regularCheckInterval); - } else { - if ([installationInfo.appcastItem isCriticalUpdate] || [installationInfo.appcastItem isInformationOnlyUpdate]) { - completionHandler(MIN(regularCheckInterval, impatientCheckInterval)); - } else { - completionHandler(MAX(regularCheckInterval, impatientCheckInterval)); - } - } - }); - }]; - }; - - self.canCheckForUpdates = NO; - self.sessionInProgress = YES; - - retrieveNextUpdateCheckInterval(^(NSTimeInterval updateCheckInterval) { - [self setCanCheckForUpdates:YES]; - [self setSessionInProgress:NO]; - - // This callback is asynchronous, so the timer may be set. Invalidate to make sure it isn't. - [self->_updaterTimer invalidate]; - - NSTimeInterval intervalSinceCheck; - if (usingCurrentDate) { - // How long has it been since last we checked for an update? - NSDate *lastCheckDate = [self lastUpdateCheckDate]; - if (!lastCheckDate) { lastCheckDate = [NSDate distantPast]; } - intervalSinceCheck = [[NSDate date] timeIntervalSinceDate:lastCheckDate]; - if (intervalSinceCheck < 0) { - // Last update check date is in the future and bogus, so reset it to current date - [self updateLastUpdateCheckDate]; - - intervalSinceCheck = 0; - } - } else { + NSTimeInterval checkInterval = [self updateCheckInterval]; + + // This callback is asynchronous, so the timer may be set. Invalidate to make sure it isn't. + [_updaterTimer invalidate]; + + NSTimeInterval intervalSinceCheck; + if (usingCurrentDate) { + // How long has it been since last we checked for an update? + NSDate *lastCheckDate = [self lastUpdateCheckDate]; + if (!lastCheckDate) { + lastCheckDate = [NSDate distantPast]; + } + intervalSinceCheck = [[NSDate date] timeIntervalSinceDate:lastCheckDate]; + if (intervalSinceCheck < 0) { + // Last update check date is in the future and bogus, so reset it to current date + [self updateLastUpdateCheckDate]; + intervalSinceCheck = 0; } - - NSTimeInterval minimumUpdateCheckInterval = self->_updaterSettings.minimumUpdateCheckInterval; - - // Now we want to figure out how long until we check again. - if (updateCheckInterval < minimumUpdateCheckInterval) - updateCheckInterval = minimumUpdateCheckInterval; - if (intervalSinceCheck < updateCheckInterval) { - NSTimeInterval delayUntilCheck = (updateCheckInterval - intervalSinceCheck); // It hasn't been long enough. - if ([delegate respondsToSelector:@selector(updater:willScheduleUpdateCheckAfterDelay:)]) { - [delegate updater:self willScheduleUpdateCheckAfterDelay:delayUntilCheck]; - } - - if ([self->_userDriver respondsToSelector:@selector(logGentleScheduledUpdateReminderWarningIfNeeded)]) { - [(id)self->_userDriver logGentleScheduledUpdateReminderWarningIfNeeded]; - } - - uint64_t leewayUpdateCheckInterval = self->_updaterSettings.leewayUpdateCheckInterval; - - [self->_updaterTimer startAndFireAfterDelay:delayUntilCheck leewayUpdateCheckInterval:leewayUpdateCheckInterval]; - } else { - // We're overdue! Run one now. - [self _checkForUpdatesInBackground]; + } else { + intervalSinceCheck = 0; + } + + NSTimeInterval minimumUpdateCheckInterval = self->_updaterSettings.minimumUpdateCheckInterval; + + // Now we want to figure out how long until we check again. + if (checkInterval < minimumUpdateCheckInterval) + checkInterval = minimumUpdateCheckInterval; + if (intervalSinceCheck < checkInterval) { + NSTimeInterval delayUntilCheck = (checkInterval - intervalSinceCheck); // It hasn't been long enough. + if ([delegate respondsToSelector:@selector(updater:willScheduleUpdateCheckAfterDelay:)]) { + [delegate updater:self willScheduleUpdateCheckAfterDelay:delayUntilCheck]; } - }); + + if ([_userDriver respondsToSelector:@selector(logGentleScheduledUpdateReminderWarningIfNeeded)]) { + [(id)_userDriver logGentleScheduledUpdateReminderWarningIfNeeded]; + } + + uint64_t leewayUpdateCheckInterval = _updaterSettings.leewayUpdateCheckInterval; + + [_updaterTimer startAndFireAfterDelay:delayUntilCheck leewayUpdateCheckInterval:leewayUpdateCheckInterval]; + } else { + // We're overdue! Run one now. + [self _checkForUpdatesInBackground]; + } } } - (void)updaterTimerDidFire { // User can perform a checkForUpdates check around the same time the timer is ready to fire - if (!_sessionInProgress) - { + if (!_sessionInProgress) { [self _checkForUpdatesInBackground]; } } @@ -604,42 +574,24 @@ NSString *const SUUpdaterAppcastNotificationKey = @"SUUpdaterAppCastNotification { [self setSessionInProgress:YES]; [self setCanCheckForUpdates:NO]; - - // We don't want the probe check to act on the driver if the updater is going near death - __weak __typeof__(self) weakSelf = self; - - NSString *hostBundleIdentifier = _host.bundle.bundleIdentifier; - assert(hostBundleIdentifier != nil); - [SPUProbeInstallStatus probeInstallerInProgressForHostBundleIdentifier:hostBundleIdentifier completion:^(BOOL installerIsRunning) { - dispatch_async(dispatch_get_main_queue(), ^{ - __typeof__(self) strongSelf = weakSelf; - if (strongSelf == nil) { - return; - } - - id delegate = strongSelf->_delegate; - id updateDriver; - if (!installerIsRunning && [strongSelf automaticallyDownloadsUpdates] && strongSelf->_resumableUpdate == nil) { - updateDriver = - [[SPUAutomaticUpdateDriver alloc] - initWithHost:strongSelf->_host - applicationBundle:strongSelf->_applicationBundle - updater:strongSelf - userDriver:strongSelf->_userDriver - updaterDelegate:delegate]; - } else { - updateDriver = - [[SPUScheduledUpdateDriver alloc] - initWithHost:strongSelf->_host - applicationBundle:strongSelf->_applicationBundle - updater:strongSelf - userDriver:strongSelf->_userDriver - updaterDelegate:delegate]; - } - - [strongSelf checkForUpdatesWithDriver:updateDriver updateCheck:SPUUpdateCheckUpdatesInBackground installerInProgress:installerIsRunning]; - }); - }]; + + id delegate = _delegate; + + SPUUpdateDriverInstallMode installMode = [self automaticallyDownloadsUpdates] ? SPUUpdateDriverInstallModeAutomatic : SPUUpdateDriverInstallModeShowingUI; + + SPUUpdateDriver *updateDriver = [[SPUUpdateDriver alloc] initWithHost:_host applicationBundle:_applicationBundle updater:self userDriver:_userDriver updaterDelegate:delegate userInitiated:NO installMode:installMode]; + + if (installMode == SPUUpdateDriverInstallModeAutomatic) { + if ([_updateLastImpatientCheckedDate timeIntervalSinceNow] > 0) { + // Last impatient checked date is bogus (in the future), reset it + _updateLastImpatientCheckedDate = [NSDate date]; + } + + updateDriver.impatientUpdateCheckInterval = _updaterSettings.impatientUpdateCheckInterval; + updateDriver.lastImpatientCheckedDate = _updateLastImpatientCheckedDate; + } + + [self checkForUpdatesWithDriver:updateDriver updateCheck:SPUUpdateCheckUpdatesInBackground]; } // This is the developer-facing checkForUpdatesInBackground @@ -722,20 +674,9 @@ NSString *const SUUpdaterAppcastNotificationKey = @"SUUpdaterAppCastNotification [self setSessionInProgress:YES]; [self setCanCheckForUpdates:NO]; - id theUpdateDriver = [[SPUUserInitiatedUpdateDriver alloc] initWithHost:_host applicationBundle:_applicationBundle updater:self userDriver:_userDriver updaterDelegate:_delegate]; - - NSString *bundleIdentifier = _host.bundle.bundleIdentifier; - assert(bundleIdentifier != nil); - - __weak __typeof__(self) weakSelf = self; - [SPUProbeInstallStatus probeInstallerInProgressForHostBundleIdentifier:bundleIdentifier completion:^(BOOL installerInProgress) { - dispatch_async(dispatch_get_main_queue(), ^{ - __typeof__(self) strongSelf = weakSelf; - if (strongSelf != nil) { - [strongSelf checkForUpdatesWithDriver:theUpdateDriver updateCheck:SPUUpdateCheckUpdates installerInProgress:installerInProgress]; - } - }); - }]; + SPUUpdateDriver *theUpdateDriver = [[SPUUpdateDriver alloc] initWithHost:_host applicationBundle:_applicationBundle updater:self userDriver:_userDriver updaterDelegate:_delegate userInitiated:YES installMode:SPUUpdateDriverInstallModeShowingUI]; + + [self checkForUpdatesWithDriver:theUpdateDriver updateCheck:SPUUpdateCheckUpdates]; } - (void)checkForUpdateInformation @@ -751,36 +692,27 @@ NSString *const SUUpdaterAppcastNotificationKey = @"SUUpdaterAppCastNotification return; } - __weak __typeof__(self) weakSelf = self; if (!_startedUpdater) { SULog(SULogLevelError, @"Error: checkForUpdateInformation - updater hasn't been started yet. Please call -startUpdater: first"); return; } - + if (_sessionInProgress) { SULog(SULogLevelError, @"Error: -checkForUpdateInformation called but .sessionInProgress == YES"); return; } - + [self setSessionInProgress:YES]; [self setCanCheckForUpdates:NO]; - - NSString *bundleIdentifier = _host.bundle.bundleIdentifier; - assert(bundleIdentifier != nil); - [SPUProbeInstallStatus probeInstallerInProgressForHostBundleIdentifier:bundleIdentifier completion:^(BOOL installerInProgress) { - dispatch_async(dispatch_get_main_queue(), ^{ - __typeof__(self) strongSelf = weakSelf; - if (strongSelf != nil) { - [strongSelf checkForUpdatesWithDriver:[[SPUProbingUpdateDriver alloc] initWithHost:strongSelf->_host updater:strongSelf updaterDelegate:strongSelf->_delegate] updateCheck:SPUUpdateCheckUpdateInformation installerInProgress:installerInProgress]; - } - }); - }]; + + SPUUpdateDriver *probingDriver = [[SPUUpdateDriver alloc] initWithHost:_host applicationBundle:_applicationBundle updater:self userDriver:nil updaterDelegate:_delegate userInitiated:NO installMode:SPUUpdateDriverInstallModeNone]; + [self checkForUpdatesWithDriver:probingDriver updateCheck:SPUUpdateCheckUpdateInformation]; } -- (void)checkForUpdatesWithDriver:(id )d updateCheck:(SPUUpdateCheck)updateCheck installerInProgress:(BOOL)installerInProgress SPU_OBJC_DIRECT +- (void)checkForUpdatesWithDriver:(SPUUpdateDriver *)d updateCheck:(SPUUpdateCheck)updateCheck SPU_OBJC_DIRECT { if (_driver != nil) { - SULog(SULogLevelError, @"Error: checkForUpdatesWithDriver:updateCheck:installerInProgress: called when _driver != nil"); + SULog(SULogLevelError, @"Error: checkForUpdatesWithDriver:updateCheck: called when _driver != nil"); return; } @@ -791,30 +723,29 @@ NSString *const SUUpdaterAppcastNotificationKey = @"SUUpdaterAppCastNotification _driver = d; assert(_driver != nil); - void (^notifyDelegateOfDriverCompletion)(NSError * _Nullable, BOOL) = ^(NSError * _Nullable error, BOOL shouldShowUpdateImmediately) { + void (^notifyDelegateOfDriverCompletion)(NSError * _Nullable) = ^(NSError * _Nullable error) { id delegate = self->_delegate; if (error != nil) { - if (error.code != SUNoUpdateError && error.code != SUInstallationCanceledError && error.code != SUInstallationAuthorizeLaterError) { // Let's not bother logging this. + if (error.code != SUNoUpdateError && error.code != SUInstallationCanceledError) { // Let's not bother logging this. SULogError(error); } // Notify host app that update driver has aborted if a non-recoverable error occurs - if (error.code != SUInstallationAuthorizeLaterError && [delegate respondsToSelector:@selector((updater:didAbortWithError:))]) { + if ([delegate respondsToSelector:@selector((updater:didAbortWithError:))]) { [delegate updater:self didAbortWithError:(NSError * _Nonnull)error]; } } // Notify host app that update driver has finished - // As long as we're not going to immediately kick off a new check - if (!shouldShowUpdateImmediately && [delegate respondsToSelector:@selector((updater:didFinishUpdateCycleForUpdateCheck:error:))]) { + if ([delegate respondsToSelector:@selector((updater:didFinishUpdateCycleForUpdateCheck:error:))]) { [delegate updater:self didFinishUpdateCycleForUpdateCheck:updateCheck error:error]; } }; void (^abortUpdateDriver)(NSError * _Nullable , BOOL) = ^(NSError * _Nullable abortError, BOOL shouldScheduleNextUpdateCheck) { __weak __typeof__(self) weakSelf = self; - [self->_driver setCompletionHandler:^(BOOL __unused shouldShowUpdateImmediately, id _Nullable __unused resumableUpdate, NSError * _Nullable error) { + [self->_driver setCompletionHandler:^(BOOL __unused shouldResetImpatientCheckDate, SPUDownloadedUpdate * _Nullable __unused resumableLocalUpdate, NSError * _Nullable error) { __typeof__(self) strongSelf = weakSelf; if (strongSelf != nil) { strongSelf->_driver = nil; @@ -824,7 +755,7 @@ NSString *const SUUpdaterAppcastNotificationKey = @"SUUpdaterAppCastNotification strongSelf.sessionInProgress = NO; strongSelf.canCheckForUpdates = YES; - notifyDelegateOfDriverCompletion(error, NO); + notifyDelegateOfDriverCompletion(error); // Ensure the delegate doesn't start a new session when being notified of the previous one ending if (!strongSelf->_sessionInProgress) { @@ -850,7 +781,7 @@ NSString *const SUUpdaterAppcastNotificationKey = @"SUUpdaterAppCastNotification ([delegate respondsToSelector:@selector((updaterMayCheckForUpdates:))] && ![delegate updaterMayCheckForUpdates:self])) #pragma clang diagnostic pop { - abortUpdateDriver(mayCheckForUpdatesError, YES); + abortUpdateDriver((mayCheckForUpdatesError != nil) ? mayCheckForUpdatesError : [NSError errorWithDomain:SUSparkleErrorDomain code:SUUpdateCheckDeclinedError userInfo:nil], YES); return; } @@ -866,27 +797,34 @@ NSString *const SUUpdaterAppcastNotificationKey = @"SUUpdaterAppCastNotification // Run our update driver and schedule next update check on its completion __weak __typeof__(self) weakSelf = self; - [_driver setCompletionHandler:^(BOOL shouldShowUpdateImmediately, id _Nullable resumableUpdate, NSError * _Nullable error) { + [_driver setCompletionHandler:^(BOOL shouldResetImpatientCheckDate, SPUDownloadedUpdate * _Nullable resumableLocalUpdate, NSError * _Nullable error) { __typeof__(self) strongSelf = weakSelf; if (strongSelf != nil) { - strongSelf->_resumableUpdate = resumableUpdate; - strongSelf->_driver = nil; - + strongSelf->_resumableLocalUpdate = resumableLocalUpdate; + [strongSelf updateLastUpdateCheckDate]; + + // Track the last downloaded date locally the first time the automatic update driver + // downloads an update in the background. This is later used for the impatient update check. + if (shouldResetImpatientCheckDate) { + strongSelf->_updateLastImpatientCheckedDate = [strongSelf lastUpdateCheckDate]; + } + + strongSelf->_driver = nil; [strongSelf setSessionInProgress:NO]; [strongSelf setCanCheckForUpdates:YES]; - if (!strongSelf->_updatingMainBundle && error == nil && !shouldShowUpdateImmediately && resumableUpdate == nil) { + if (!strongSelf->_updatingMainBundle && error == nil && resumableLocalUpdate == nil) { // If we're not updating the main bundle, a potentially new installed bundle may have different info [NSNotificationCenter.defaultCenter postNotificationName:SUUpdateSettingsNeedsSynchronizationNotification object:nil userInfo:@{SUUpdateBundlePathUserInfoKey: strongSelf->_host.bundlePath}]; } - notifyDelegateOfDriverCompletion(error, shouldShowUpdateImmediately); + notifyDelegateOfDriverCompletion(error); // Ensure the delegate doesn't start a new session when being notified of the previous one ending if (!strongSelf->_sessionInProgress) { - [strongSelf scheduleNextUpdateCheckFiringImmediately:shouldShowUpdateImmediately usingCurrentDate:NO]; + [strongSelf scheduleNextUpdateCheckFiringImmediately:NO usingCurrentDate:NO]; } } }]; @@ -901,25 +839,18 @@ NSString *const SUUpdaterAppcastNotificationKey = @"SUUpdaterAppCastNotification [weakSelf updateLastUpdateCheckDate]; }]; - if (installerInProgress) { - // Resume an update that has already begun installing in the background - [_driver resumeInstallingUpdate]; - } else if (_resumableUpdate != nil) { - // Resume an update or info that has already been downloaded - [_driver resumeUpdate:(id _Nonnull)_resumableUpdate]; + // Check that the parameterized feed URL is valid + NSURL *theFeedURL = [self parameterizedFeedURL]; + if (theFeedURL == nil) { + // I think this is really unlikely to occur but better be safe + // We will not schedule a next update check if the feed URL cannot be formed + SULog(SULogLevelError, @"Error: failed to retrieve feed URL for bundle"); + + abortUpdateDriver([NSError errorWithDomain:SUSparkleErrorDomain code:SUInvalidFeedURLError userInfo:@{ NSLocalizedDescriptionKey: @"Sparkle cannot form a valid feed URL." }], NO); } else { - // Check that the parameterized feed URL is valid - NSURL *theFeedURL = [self parameterizedFeedURL]; - if (theFeedURL == nil) { - // I think this is really unlikely to occur but better be safe - // We will not schedule a next update check if the feed URL cannot be formed - SULog(SULogLevelError, @"Error: failed to retrieve feed URL for bundle"); - - abortUpdateDriver([NSError errorWithDomain:SUSparkleErrorDomain code:SUInvalidFeedURLError userInfo:@{ NSLocalizedDescriptionKey: @"Sparkle cannot form a valid feed URL." }], NO); - } else { - // Check for new updates - [_driver checkForUpdatesAtAppcastURL:theFeedURL withUserAgent:_userAgentString httpHeaders:_httpHeaders]; - } + // The driver probes on its own for an update an external installer job may already be + // staging or installing; otherwise it resumes _resumableLocalUpdate, if any + [_driver checkForUpdatesAtAppcastURL:theFeedURL withUserAgent:_userAgentString httpHeaders:_httpHeaders resumingLocalUpdate:_resumableLocalUpdate]; } } @@ -1363,7 +1294,7 @@ static NSString *escapeURLComponent(NSString *str) { // Abort any on-going updates // A driver could be retained by another object (eg: a timer), // so not aborting could mean it stays alive longer than we'd want - [_driver abortUpdate]; + [_driver abortUpdateWithError:nil]; _driver = nil; } diff --git a/Sparkle/SPUUpdaterTimer.m b/Sparkle/SPUUpdaterTimer.m index dd20f887..5a1a2c02 100644 --- a/Sparkle/SPUUpdaterTimer.m +++ b/Sparkle/SPUUpdaterTimer.m @@ -17,6 +17,8 @@ dispatch_source_t _source; __weak id _delegate; + + NSUInteger _timerGeneration; } - (instancetype)initWithDelegate:(id)delegate @@ -37,11 +39,15 @@ dispatch_time_t timeToFire = dispatch_walltime(NULL, (int64_t)(delay * NSEC_PER_SEC)); dispatch_source_set_timer(_source, timeToFire, DISPATCH_TIME_FOREVER, leewayUpdateCheckInterval * NSEC_PER_SEC); + _timerGeneration++; + NSUInteger currentTimerGeneration = _timerGeneration; __weak __typeof__(self) weakSelf = self; dispatch_source_set_event_handler(_source, ^{ __typeof__(self) strongSelf = weakSelf; if (strongSelf != nil) { - [strongSelf->_delegate updaterTimerDidFire]; + if (strongSelf->_timerGeneration == currentTimerGeneration) { + [strongSelf->_delegate updaterTimerDidFire]; + } } }); @@ -53,6 +59,7 @@ if (_source != nil) { dispatch_source_cancel(_source); _source = nil; + _timerGeneration++; } } diff --git a/Sparkle/SPUUserDriver.h b/Sparkle/SPUUserDriver.h index d2cd3cab..cd7a95e5 100644 --- a/Sparkle/SPUUserDriver.h +++ b/Sparkle/SPUUserDriver.h @@ -291,7 +291,7 @@ SU_EXPORT NS_SWIFT_UI_ACTOR @protocol SPUUserDriver - (void)showUpdateInstallationDidFinishWithAcknowledgement:(void (^)(void))acknowledgement __deprecated_msg("Implement -showUpdateInstalledAndRelaunched:acknowledgement: instead"); -- (void)dismissUserInitiatedUpdateCheck __deprecated_msg("Transition to new UI appropriately when a new update is shown, when no update is found, or when an update error occurs."); +- (void)dismissUserInitiatedUpdateCheck __deprecated_msg("Transition to new UI appropriately when a new update is shown, when no update is found, or when an update error occurs. This method is no longer called."); - (void)showInstallingUpdate __deprecated_msg("Implement -showInstallingUpdateWithApplicationTerminated:retryTerminatingApplication: instead."); diff --git a/Sparkle/SPUUserInitiatedUpdateDriver.h b/Sparkle/SPUUserInitiatedUpdateDriver.h deleted file mode 100644 index 97648c5c..00000000 --- a/Sparkle/SPUUserInitiatedUpdateDriver.h +++ /dev/null @@ -1,23 +0,0 @@ -// -// SPUUserInitiatedUpdateDriver.h -// Sparkle -// -// Created by Mayur Pawashe on 3/18/16. -// Copyright © 2016 Sparkle Project. All rights reserved. -// - -#import -#import "SPUUpdateDriver.h" - -NS_ASSUME_NONNULL_BEGIN - -@class SUHost; -@protocol SPUUpdaterDelegate, SPUUserDriver; - -SPU_OBJC_DIRECT_MEMBERS @interface SPUUserInitiatedUpdateDriver : NSObject - -- (instancetype)initWithHost:(SUHost *)host applicationBundle:(NSBundle *)applicationBundle updater:(id)updater userDriver:(id )userDriver updaterDelegate:(nullable id )updaterDelegate; - -@end - -NS_ASSUME_NONNULL_END diff --git a/Sparkle/SPUUserInitiatedUpdateDriver.m b/Sparkle/SPUUserInitiatedUpdateDriver.m deleted file mode 100644 index caeb257b..00000000 --- a/Sparkle/SPUUserInitiatedUpdateDriver.m +++ /dev/null @@ -1,149 +0,0 @@ -// -// SPUUserInitiatedUpdateDriver.m -// Sparkle -// -// Created by Mayur Pawashe on 3/18/16. -// Copyright © 2016 Sparkle Project. All rights reserved. -// - -#import "SPUUserInitiatedUpdateDriver.h" -#import "SPUUIBasedUpdateDriver.h" -#import "SPUUserDriver.h" - - -#include "AppKitPrevention.h" - -@interface SPUUserInitiatedUpdateDriver () - -@end - -@implementation SPUUserInitiatedUpdateDriver -{ - SPUUIBasedUpdateDriver *_uiDriver; - id _userDriver; - - void (^_updateDidShowHandler)(void); - - BOOL _showingUserInitiatedProgress; - BOOL _showingUpdate; - BOOL _aborted; -} - -@synthesize showingUpdate = _showingUpdate; - -- (instancetype)initWithHost:(SUHost *)host applicationBundle:(NSBundle *)applicationBundle updater:(id)updater userDriver:(id )userDriver updaterDelegate:(nullable id )updaterDelegate -{ - self = [super init]; - if (self != nil) { - _uiDriver = [[SPUUIBasedUpdateDriver alloc] initWithHost:host applicationBundle:applicationBundle updater:updater userDriver:userDriver userInitiated:YES updaterDelegate:updaterDelegate delegate:self]; - _userDriver = userDriver; - } - return self; -} - -- (void)setCompletionHandler:(SPUUpdateDriverCompletion)completionBlock -{ - [_uiDriver setCompletionHandler:completionBlock]; -} - -- (void)setUpdateShownHandler:(void (^)(void))handler -{ - _updateDidShowHandler = [handler copy]; -} - -- (void)setUpdateWillInstallHandler:(void (^)(void))updateWillInstallHandler -{ - [_uiDriver setUpdateWillInstallHandler:updateWillInstallHandler]; -} - -- (void)checkForUpdatesAtAppcastURL:(NSURL *)appcastURL withUserAgent:(NSString *)userAgent httpHeaders:(NSDictionary * _Nullable)httpHeaders -{ - _showingUserInitiatedProgress = YES; - - if (_updateDidShowHandler != nil) { - _updateDidShowHandler(); - _updateDidShowHandler = nil; - } - - [_userDriver showUserInitiatedUpdateCheckWithCancellation:^{ - dispatch_async(dispatch_get_main_queue(), ^{ - if (self->_showingUserInitiatedProgress) { - [self abortUpdate]; - } - }); - }]; - - [_uiDriver checkForUpdatesAtAppcastURL:appcastURL withUserAgent:userAgent httpHeaders:httpHeaders inBackground:NO]; -} - -- (void)resumeInstallingUpdate -{ - [_uiDriver resumeInstallingUpdate]; -} - -- (void)resumeUpdate:(id)resumableUpdate -{ - [_uiDriver resumeUpdate:resumableUpdate]; -} - -- (void)uiDriverDidShowUpdate -{ - // When a new update check has not been initiated and an update has been resumed, - // update the driver to indicate we are showing an update to the user - _showingUpdate = YES; - - if (_updateDidShowHandler != nil) { - _updateDidShowHandler(); - _updateDidShowHandler = nil; - } -} - -- (void)basicDriverIsRequestingAbortUpdateWithError:(nullable NSError *)error -{ - [self abortUpdateWithError:error]; -} - -- (void)coreDriverIsRequestingAbortUpdateWithError:(nullable NSError *)error -{ - [self abortUpdateWithError:error]; -} - -- (void)uiDriverIsRequestingAbortUpdateWithError:(nullable NSError *)error -{ - [self abortUpdateWithError:error]; -} - -- (void)basicDriverDidFinishLoadingAppcast -{ - if (_showingUserInitiatedProgress) { - _showingUserInitiatedProgress = NO; -#pragma clang diagnostic push -#pragma clang diagnostic ignored "-Wdeprecated-declarations" - if ([_userDriver respondsToSelector:@selector(dismissUserInitiatedUpdateCheck)]) { - [_userDriver dismissUserInitiatedUpdateCheck]; - } -#pragma clang diagnostic pop - } -} - -- (void)abortUpdate -{ - [self abortUpdateWithError:nil]; -} - -- (void)abortUpdateWithError:(nullable NSError *)error -{ - if (_showingUserInitiatedProgress) { -#pragma clang diagnostic push -#pragma clang diagnostic ignored "-Wdeprecated-declarations" - if ([_userDriver respondsToSelector:@selector(dismissUserInitiatedUpdateCheck)]) { - [_userDriver dismissUserInitiatedUpdateCheck]; - } -#pragma clang diagnostic pop - _showingUserInitiatedProgress = NO; - } - _aborted = YES; - [_uiDriver abortUpdateWithError:error showErrorToUser:YES]; -} - -@end diff --git a/Sparkle/SUAppcastDriver.h b/Sparkle/SUAppcastDriver.h index 5f033a7b..4dc482f0 100644 --- a/Sparkle/SUAppcastDriver.h +++ b/Sparkle/SUAppcastDriver.h @@ -33,7 +33,7 @@ SUAppcastDriverDefinitionAttribute - (instancetype)initWithHost:(SUHost *)host updater:(id)updater updaterDelegate:(nullable id )updaterDelegate delegate:(nullable id )delegate; -- (void)loadAppcastFromURL:(NSURL *)appcastURL userAgent:(NSString *)userAgent httpHeaders:(NSDictionary * _Nullable)httpHeaders inBackground:(BOOL)background; +- (void)loadAppcastFromURL:(NSURL *)appcastURL userAgent:(NSString *)userAgent httpHeaders:(NSDictionary * _Nullable)httpHeaders inBackground:(BOOL)background resumingUpdate:(BOOL)resumingUpdate; - (void)cleanup:(void (^)(void))completionHandler; diff --git a/Sparkle/SUAppcastDriver.m b/Sparkle/SUAppcastDriver.m index a2b5cfc5..b207a1e3 100644 --- a/Sparkle/SUAppcastDriver.m +++ b/Sparkle/SUAppcastDriver.m @@ -65,7 +65,7 @@ return self; } -- (void)loadAppcastFromURL:(NSURL *)appcastURL userAgent:(NSString *)userAgent httpHeaders:(NSDictionary * _Nullable)httpHeaders inBackground:(BOOL)background +- (void)loadAppcastFromURL:(NSURL *)appcastURL userAgent:(NSString *)userAgent httpHeaders:(NSDictionary * _Nullable)httpHeaders inBackground:(BOOL)background resumingUpdate:(BOOL)resumingUpdate { assert(NSThread.isMainThread); @@ -76,12 +76,18 @@ requestHTTPHeaders[@"Accept"] = @"application/rss+xml,*/*;q=0.1"; NSURLRequestCachePolicy cachePolicy; - if (!background || [_host boolForInfoDictionaryKey:SUDisableFeedCacheValidationKey]) { - // Always fetch the freshest feed when the user explicitly asks us to check, - // or if the developer disabled feed cache validation + if ([_host boolForInfoDictionaryKey:SUDisableFeedCacheValidationKey]) { + // The developer disabled feed cache validation + cachePolicy = NSURLRequestReloadIgnoringLocalCacheData; + } else if (resumingUpdate) { + // We already have an update downloaded or installing that we can fall back to resuming, + // so we will risk always respecting the cache + cachePolicy = NSURLRequestReloadRevalidatingCacheData; + } else if (!background) { + // Always fetch the freshest feed when the user explicitly asks us to check cachePolicy = NSURLRequestReloadIgnoringLocalCacheData; } else { - // With NSURLRequestReloadRevalidatingCacheData ETag / If-Modified-Since can be used so that + // With NSURLRequestReloadRevalidatingCacheData, ETag / If-Modified-Since can be used so that // a previously cached file can be used if it hasn't changed on the server. // However we have a bypass check interval periodically to force ignoring the cache data if // something happens to go wrong. diff --git a/Sparkle/SUErrors.h b/Sparkle/SUErrors.h index 3298688b..c48c94b6 100644 --- a/Sparkle/SUErrors.h +++ b/Sparkle/SUErrors.h @@ -45,6 +45,7 @@ typedef NS_ENUM(OSStatus, SUError) { SURunningTranslocated = 1005, SUWebKitTerminationError = 1006, SUReleaseNotesError = 1007, + SUUpdateCheckDeclinedError = 1008, // Download phase errors. SUTemporaryDirectoryError = 2000, diff --git a/TestApplication/SUTestApplicationDelegate.m b/TestApplication/SUTestApplicationDelegate.m index 77ed569b..1204ac37 100644 --- a/TestApplication/SUTestApplicationDelegate.m +++ b/TestApplication/SUTestApplicationDelegate.m @@ -24,6 +24,8 @@ SUUpdateSettingsWindowController *_updateSettingsWindowController; SUTestWebServer *_webServer; NSString *_testMode; + + BOOL _supersedeFoundInitialUpdate; } - (void)applicationDidFinishLaunching:(NSNotification * __unused)notification @@ -43,7 +45,7 @@ // Check if we are already up to date NSString *mainBundleVersion = (NSString *)[mainBundle objectForInfoDictionaryKey:(__bridge NSString *)kCFBundleVersionKey]; - if (([mainBundleVersion hasPrefix:@"2."] && [testMode isEqualToString:@"REGULAR"]) || (([mainBundleVersion isEqualToString:@"2.1"] || [mainBundleVersion isEqualToString:@"2.2"]) && [testMode isEqualToString:@"DELTA_AND_MARKDOWN"]) || ([mainBundleVersion isEqualToString:@"2.2"] && [testMode isEqualToString:@"AUTOMATIC"])) { + if (([mainBundleVersion hasPrefix:@"2."] && [testMode isEqualToString:@"REGULAR"]) || (([mainBundleVersion isEqualToString:@"2.1"] || [mainBundleVersion isEqualToString:@"2.2"]) && [testMode isEqualToString:@"DELTA_AND_MARKDOWN"]) || ([mainBundleVersion isEqualToString:@"2.2"] && [testMode isEqualToString:@"AUTOMATIC"]) || ([mainBundleVersion isEqualToString:@"3.1"] && [testMode isEqualToString:@"SUPERSEDE"])) { NSAlert *alreadyUpdatedAlert = [[NSAlert alloc] init]; alreadyUpdatedAlert.messageText = @"Update succeeded!"; alreadyUpdatedAlert.informativeText = @"This is the updated version of Sparkle Test App.\n\nDelete and rebuild the app to test updates again."; @@ -52,9 +54,12 @@ [[NSApplication sharedApplication] terminate:nil]; } -#if SPARKLE_BUILD_UI_BITS // Detect as early as possible if the shift key is held down - BOOL shiftKeyHeldDown = ([NSEvent modifierFlags] & NSEventModifierFlagShift) != 0; + BOOL shiftKeyHeldDown; +#if SPARKLE_BUILD_UI_BITS + shiftKeyHeldDown = ([NSEvent modifierFlags] & NSEventModifierFlagShift) != 0; +#else + shiftKeyHeldDown = NO; #endif NSFileManager *fileManager = [NSFileManager defaultManager]; @@ -70,7 +75,7 @@ NSString *bundleIdentifier = mainBundle.bundleIdentifier; assert(bundleIdentifier != nil); - + // Create a directory that'll be used for our web server listing NSURL *serverDirectoryURL = [[cacheDirectoryURL URLByAppendingPathComponent:bundleIdentifier] URLByAppendingPathComponent:@"ServerData"]; if ([serverDirectoryURL checkResourceIsReachableAndReturnError:nil]) { @@ -114,6 +119,9 @@ finalUpdatedVersion = @"2.1"; } else if ([testMode isEqualToString:@"AUTOMATIC"]) { finalUpdatedVersion = @"2.2"; + } else if ([testMode isEqualToString:@"SUPERSEDE"]) { + // This is the initial version which will later be superseded by 3.1 + finalUpdatedVersion = @"3.0"; } else { assert(false); } @@ -175,10 +183,10 @@ // Don't ever do this at home, kids (seriously) // (that is, including the private key inside of your application) - const unsigned char self_sign_demo_only_insecure_hack[64] = {200, 238, 135, 84, 10, 189, 3, 193, 61, 208, 203, 30, 133, 47, 12, 22, 19, 52, 252, 99, 110, 205, 209, 94, 215, 144, 201, 70, 27, 162, 163, 108, 0, 164, 68, 184, 226, 93, 121, 199, 172, 17, 26, 64, 89, 68, 232, 41, 2, 26, 245, 175, 158, 165, 42, 55, 5, 97, 8, 243, 251, 164, 93, 9}; + static const unsigned char self_sign_demo_only_insecure_hack[64] = {200, 238, 135, 84, 10, 189, 3, 193, 61, 208, 203, 30, 133, 47, 12, 22, 19, 52, 252, 99, 110, 205, 209, 94, 215, 144, 201, 70, 27, 162, 163, 108, 0, 164, 68, 184, 226, 93, 121, 199, 172, 17, 26, 64, 89, 68, 232, 41, 2, 26, 245, 175, 158, 165, 42, 55, 5, 97, 8, 243, 251, 164, 93, 9}; // in normal app this goes to Info.plist - const unsigned char public_key[32] = {121, 17, 79, 45, 155, 141, 51, 169, 188, 110, 91, 102, 182, 147, 215, 225, 252, 202, 110, 231, 200, 215, 62, 171, 40, 145, 237, 128, 130, 44, 150, 89}; - unsigned char signature[64]; + static const unsigned char public_key[32] = {121, 17, 79, 45, 155, 141, 51, 169, 188, 110, 91, 102, 182, 147, 215, 225, 252, 202, 110, 231, 200, 215, 62, 171, 40, 145, 237, 128, 130, 44, 150, 89}; + unsigned char signature[64] = {0}; if ([testMode isEqualToString:@"DELTA_AND_MARKDOWN"]) { NSError *deltaCreationError = nil; @@ -232,6 +240,121 @@ NSLog(@"Failed to write updated appcast with error %@", writeAppcastError); abort(); } + } else if ([testMode isEqualToString:@"SUPERSEDE"]) { + // Create the archive for the initial ("3.0") update from the bundle we already copied + // and signed above + NSString *zipName = @"Sparkle_Test_App.zip"; + NSTask *dittoTask = [[NSTask alloc] init]; + dittoTask.launchPath = @"/usr/bin/ditto"; + dittoTask.arguments = @[@"-c", @"-k", @"--sequesterRsrc", @"--keepParent", (NSString *)destinationBundleURL.lastPathComponent, zipName]; + dittoTask.currentDirectoryPath = serverDirectoryPath; + [dittoTask launch]; + [dittoTask waitUntilExit]; + + assert(dittoTask.terminationStatus == 0); + + [fileManager removeItemAtURL:destinationBundleURL error:NULL]; + + NSURL *archiveURL = [serverDirectoryURL URLByAppendingPathComponent:zipName]; + NSData *archive = [NSData dataWithContentsOfURL:archiveURL]; + assert(archive != nil); + + ed25519_sign(signature, (const unsigned char *)archive.bytes, archive.length, public_key, self_sign_demo_only_insecure_hack); + + NSString *signatureString = [[NSData dataWithBytes:signature length:64] base64EncodedStringWithOptions:(NSDataBase64EncodingOptions)0]; + + NSError *fileAttributesError = nil; + NSString *archiveURLPath = archiveURL.path; + assert(archiveURLPath != nil); + NSDictionary *archiveFileAttributes = [[NSFileManager defaultManager] attributesOfItemAtPath:archiveURLPath error:&fileAttributesError]; + if (archiveFileAttributes == nil) { + NSLog(@"Failed to retrieve file attributes from archive with error %@", fileAttributesError); + abort(); + } + + NSUInteger numberOfSupercede1LengthReplacements = [appcastContents replaceOccurrencesOfString:@"$INSERT_SUPERCEDE1_ARCHIVE_LENGTH" withString:[NSString stringWithFormat:@"%llu", archiveFileAttributes.fileSize] options:NSLiteralSearch range:NSMakeRange(0, appcastContents.length)]; + assert(numberOfSupercede1LengthReplacements == 1); + + NSUInteger numberOfSupercede1SignatureReplacements = [appcastContents replaceOccurrencesOfString:@"$INSERT_SUPERCEDE1_EDDSA_SIGNATURE" withString:signatureString options:NSLiteralSearch range:NSMakeRange(0, appcastContents.length)]; + assert(numberOfSupercede1SignatureReplacements == 1); + + // Build a second copy of the bundle for the superseding ("3.1") update + NSURL *supersedingDestinationBundleURL = [serverDirectoryURL URLByAppendingPathComponent:@"Superseding.app"]; + NSError *copySupersedingBundleError = nil; + if (![fileManager copyItemAtURL:bundleURL toURL:supersedingDestinationBundleURL error:©SupersedingBundleError]) { + NSLog(@"Failed to copy bundle for superseding update with error %@", copySupersedingBundleError); + abort(); + } + + NSURL *supersedingInfoURL = [[supersedingDestinationBundleURL URLByAppendingPathComponent:@"Contents"] URLByAppendingPathComponent:@"Info.plist"]; + NSMutableDictionary *supersedingInfoDictionary = [[NSMutableDictionary alloc] initWithContentsOfURL:supersedingInfoURL]; + [supersedingInfoDictionary setObject:@"3.1" forKey:(__bridge NSString *)kCFBundleVersionKey]; + [supersedingInfoDictionary setObject:@"3.1" forKey:@"CFBundleShortVersionString"]; + BOOL wroteSupersedingInfoFile = [supersedingInfoDictionary writeToURL:supersedingInfoURL atomically:NO]; + assert(wroteSupersedingInfoFile); + + [self signApplicationIfRequiredAtPath:supersedingDestinationBundleURL.path completion:^{ + dispatch_async(dispatch_get_main_queue(), ^{ + NSString *supersedingZipName = @"Sparkle_Test_App_Superseding.zip"; + NSTask *supersedingDittoTask = [[NSTask alloc] init]; + supersedingDittoTask.launchPath = @"/usr/bin/ditto"; + supersedingDittoTask.arguments = @[@"-c", @"-k", @"--sequesterRsrc", @"--keepParent", (NSString *)supersedingDestinationBundleURL.lastPathComponent, supersedingZipName]; + supersedingDittoTask.currentDirectoryPath = serverDirectoryPath; + [supersedingDittoTask launch]; + [supersedingDittoTask waitUntilExit]; + + assert(supersedingDittoTask.terminationStatus == 0); + + [fileManager removeItemAtURL:supersedingDestinationBundleURL error:NULL]; + + NSURL *supersedingArchiveURL = [serverDirectoryURL URLByAppendingPathComponent:supersedingZipName]; + NSData *supersedingArchive = [NSData dataWithContentsOfURL:supersedingArchiveURL]; + assert(supersedingArchive != nil); + + unsigned char supersedingSignature[64] = {0}; + ed25519_sign(supersedingSignature, (const unsigned char *)supersedingArchive.bytes, supersedingArchive.length, public_key, self_sign_demo_only_insecure_hack); + NSString *supersedingSignatureString = [[NSData dataWithBytes:supersedingSignature length:64] base64EncodedStringWithOptions:(NSDataBase64EncodingOptions)0]; + + NSError *supersedingFileAttributesError = nil; + NSString *supersedingArchiveURLPath = supersedingArchiveURL.path; + assert(supersedingArchiveURLPath != nil); + NSDictionary *supersedingArchiveFileAttributes = [[NSFileManager defaultManager] attributesOfItemAtPath:supersedingArchiveURLPath error:&supersedingFileAttributesError]; + if (supersedingArchiveFileAttributes == nil) { + NSLog(@"Failed to retrieve file attributes from superseding archive with error %@", supersedingFileAttributesError); + abort(); + } + + NSUInteger numberOfSupercede2LengthReplacements = [appcastContents replaceOccurrencesOfString:@"$INSERT_SUPERCEDE2_ARCHIVE_LENGTH" withString:[NSString stringWithFormat:@"%llu", supersedingArchiveFileAttributes.fileSize] options:NSLiteralSearch range:NSMakeRange(0, appcastContents.length)]; + assert(numberOfSupercede2LengthReplacements == 1); + + NSUInteger numberOfSupercede2SignatureReplacements = [appcastContents replaceOccurrencesOfString:@"$INSERT_SUPERCEDE2_EDDSA_SIGNATURE" withString:supersedingSignatureString options:NSLiteralSearch range:NSMakeRange(0, appcastContents.length)]; + assert(numberOfSupercede2SignatureReplacements == 1); + + NSRange feedSignaturesPrefixRange = [appcastContents rangeOfString:@"