Compare commits

..
1832 Commits
Author SHA1 Message Date
Sparkle-Bot b328c499a3 Update Package management files for version 2.6.1 2024-05-02 15:22:43 +00:00
Zorg 00e6259c9d Update CHANGELOG for 2.6.1 2024-05-02 17:15:18 +02:00
Zorg 31b462f860 Extract archives in a separate directory from the input archive (#2550) 2024-04-30 21:24:43 +02:00
Zorg 5264c01d37 Remove assert on download response being available (#2547) 2024-04-25 20:01:14 -07:00
Zorg 0cff81740f Fix the WebKit view not transitioning from light to dark mode (#2542)
adaptReleaseNotesAppearance was over-engineered to update the transparent background state of the web view (which was causing the issue) and the background NSBox view when the system changes to dark or light mode. This is because when dark mode support was originally written, it used to use a stylesheet that was only specific to dark aqua. However this code has changed some time ago to use a universal stylesheet for both light/dark mode.

So now when the WebKit view is created, we just opt into a transparent background and set up a background NSBox view once and don't do anything when the effectiveAppearance of the views change. This fixes visual issues on current and older OS systems when changing system appearance.
2024-04-21 15:58:37 -07:00
Viktor Szépe e9989a8ae7 Fix typos (#2537) 2024-04-13 16:12:23 -07:00
Zorg 2e1bdb98f1 Update upload-artifact version to v4 (#2536) 2024-03-31 20:26:04 -07:00
Zorg d30adc8407 Create tar.xz files with built-in tar and remove bzip2 fallback (#2535) 2024-03-31 16:41:50 -07:00
Zorg 0183bf2b3f Clarify authorization prompt can show after starting extraction (#2534) 2024-03-29 11:02:35 -07:00
Zorg 2b7615fe5b Fallback in case SULocalizedStringFromTableInBundle() fails (#2533)
SULocalizedStringFromTableInBundle() should only fail in the abnormal situation where the app bundle may have been moved while it was running. Technically the app is running in an unsupported state but I suppose we can guard against it here.
2024-03-28 18:52:28 -07:00
Zorg 9aece0259c Add NN (Norwegian Nynorsk) locale (#2532) 2024-03-28 18:51:35 -07:00
Zorg 8c7476f93d Document user driver interaction with authorization (#2531) 2024-03-27 19:20:43 -07:00
Sparkle-Bot 0a4caaf7a8 Update Package management files for version 2.6.0 2024-03-15 18:08:43 +00:00
Sparkle-Bot a603047fd5 Update Package management files for version 2.6.0-beta.2 2024-03-04 02:40:08 +00:00
Zorg 2bd33682d1 Update CHANGELOG 2024-03-03 18:34:12 -08:00
Zorg dfab64efdf Remove installer status & connection entitlement files (#2517)
These entitlements are not easy to configure properly and most developers should not be using these services.

Also simplify how to opt into enabling sandboxing entitlements for the Downloader XPC Service.
2024-03-03 17:41:12 -08:00
Zorg 51ce7108c9 Swap app bundles with APFS atomic swap if team IDs match (#2516) 2024-03-02 17:32:54 -08:00
Sparkle-Bot 56e365d050 Update Package management files for version 2.6.0-beta.1 2024-02-23 05:22:24 +00:00
Zorg c983fa1548 Update CHANGELOG for 2.6 2024-02-22 21:11:53 -08:00
Zorg ef1f03cf1e Disable sandboxing for downloader XPC service by default (#2511) 2024-02-19 18:49:18 -08:00
Zorg 4d164ba4ab Update GitHub actions runners to Xcode 15.2 (#2506) 2024-02-18 12:38:30 -08:00
Zorg 66c198932d Perform Gatekeeper scan to pre-warm app launch (#2505)
This avoids users being a "Verifying..." Dialog when the installed update is (re-)launched.

This scan is only done for macOS 14.4+ onwards (gktool was introduced in macOS 14.0 but had issues).

Also this scan is only done if Autoupdate's team identifier matches the new update's team identifier. Otherwise the OS may think Autoupdate is modifying a bundle which it shouldn't be permitted to (this is a bug).
2024-02-18 12:37:58 -08:00
CheolHyun Mun 24f0f3952d Update Korean localization (#2504) 2024-02-16 22:03:03 -08:00
Zorg 7e5ebca735 Mention only 10.13 minimum macOS requirement
The last couple years of Xcode releases don't support anything less than 10.13 deployment target.
2024-01-13 08:00:01 -08:00
Zorg 001d6d6a69 Use $PROJECT_DIR instead of $SRCROOT (#2489) 2024-01-13 07:59:15 -08:00
Zorg 9e9830eb0f Update CI runners to use Xcode 15.1 (#2484) 2023-12-28 15:17:11 -05:00
Zorg 615043da2b Audit minimum supported system version in Swift Package.swift (#2483)
Also add Package.swift to the Xcode project so its contents are searchable.
2023-12-28 14:41:08 -05:00
Eitot 485f0e661d Set minimum deployment to macOS 10.13 in Package.swift (#2481) 2023-12-27 14:31:01 -05:00
Zorg f1daff840f Merge branch '2.5.2-dev' into 2.x 2023-12-21 09:29:52 -08:00
Sparkle-Bot 47d3d90aee Update Package management files for version 2.5.2 2023-12-20 04:08:02 +00:00
Zorg 9a29d14b7b Update CHANGELOG for 2.5.2 2023-12-19 19:58:50 -08:00
Zorg 7a7fb9ecd9 Don't clean up update directory when Autoupdate receives SIGTERM (#2479)
Under rare circumstances, if Autoupdate receives SIGTERM while the installer queue is installing an update this could cause potential corruption.
2023-12-19 19:56:25 -08:00
1024jp 4ad2b0d945 Update Japanese localization (#2285) (#2475) 2023-12-19 19:56:06 -08:00
Emir SARI 2afa08405c Improve Turkish translations (#2464)
Updates the strings to be more in-line with the Apple terminology, and
capitalisation. Ambiguities have been found and fixed as well.
2023-12-19 19:55:43 -08:00
Billy Gray ed1bc2fdc8 Update Spanish translation for 'You are currently running version %@.' and 'Version History'. (#2463) 2023-12-19 19:55:17 -08:00
Zorg b84c1b14ce Don't clean up update directory when Autoupdate receives SIGTERM (#2479)
Under rare circumstances, if Autoupdate receives SIGTERM while the installer queue is installing an update this could cause potential corruption.
2023-12-19 19:49:36 -08:00
1024jp 0a92e049eb Update Japanese localization (#2285) (#2475) 2023-12-02 06:57:15 -08:00
Zorg 1a0b023e1c Store private seed as the secret for newly generated keys (#2472)
This improves compatibility when using the seed onto other cryptography libraries.
2023-11-23 09:23:10 -05:00
Zorg 1e419c8c16 Improve signing error message to developers (#2471)
If we detect the wrong archive is being served (i.e, expected content length differs from archive length) we log this out to developers. If the app version in the archive (if available) also differs, we report this discrepancy as well. If the update archive looks the same but signing validation fails, we tell the developer the update may have not been signed correctly.

I'm not changing the generic error that is reported to users about the update being improperly signed (that would involve propagating this information there and updating bunch of localizations). The extra info is more for the developer than it is for the user.

Fixes #2468
2023-11-18 16:04:44 -08:00
Emir SARI ac6c897dd5 Improve Turkish translations (#2464)
Updates the strings to be more in-line with the Apple terminology, and
capitalisation. Ambiguities have been found and fixed as well.
2023-11-10 05:32:09 -08:00
Billy Gray 5a708be2a5 Update Spanish translation for 'You are currently running version %@.' and 'Version History'. (#2463) 2023-10-31 17:54:14 -07:00
Zorg 82209831c0 Update GitHub checkout action for create-draft-release (#2457) 2023-10-16 21:14:57 -07:00
Zorg 70a9ad52ae Fix false positive analyzer warning about resumableUpdate type (#2454) 2023-10-16 20:31:32 -07:00
Jozef Izso a00fd1d323 Update GHA libraries to use modern NodeJS runtime (#2451)
* Update `actions/checkout` and `actions/upload-artifact`

This removes the warning about the deprecated `node12` runtime used by existing actions.

* Update `mshick/add-pr-comment`

The v2 action uses `node16` runtime
Workflow will use the `GITHUB_TOKEN` with `pull-requests: write` permission instead of PAT
2023-10-15 20:19:37 -07:00
Sparkle-Bot 1f07f4096e Update Package management files for version 2.5.1 2023-10-15 23:57:08 +00:00
Zorg 679d3568c2 Update CHANGELOG for 2.5.1 2023-10-15 16:37:29 -07:00
Zorg bd90fb7b18 Filter for archive files in generate_appcast more intelligently (#2448) 2023-10-08 09:38:50 -07:00
floorish 9684a433ee Use correct entitlements and dsym files when using custom bundle id and XPC names in ConfigCommon (#2446) 2023-09-30 10:39:16 -07:00
Zorg ff4d4f53a8 Bring back specifying version in issue template 2023-09-30 08:13:44 -07:00
Zorg 469f423e28 Fix test cases for localized release notes (#2444) 2023-09-28 22:52:32 -07:00
Zorg 846838c90b Update issue templates (#2443) 2023-09-28 21:06:23 -07:00
Zorg f6a86f52b3 Default to English for XML nodes when no xml:lang is present (#2440)
This only applies when multiple XML nodes are present with the same name. E.g. multiple description or releaseNoteLink elements with different xml:lang's specified.

Also generate a warning if an language has to be interpreted implicitly when there is no xml:lang explicitly specified and there are multiple node items.
2023-09-28 20:02:29 -07:00
Sparkle-Bot f0ceaf5cc9 Update Package management files for version 2.5.0 2023-09-15 23:55:58 +00:00
Zorg 569f69b463 Update CHANGELOG 2023-09-15 16:48:38 -07:00
Zorg 7cc751ff4f Fail gracefully when auxiliary tool cannot be located (#2436) 2023-09-06 21:05:59 -07:00
Sparkle-Bot d005af3e03 Update Package management files for version 2.5.0-beta.2 2023-09-02 18:55:48 +00:00
Zorg 4cdfffa8e9 Update CHANGELOG 2023-09-02 11:49:30 -07:00
Zorg 0e865f07c5 Fix Updater.app not starting when running Sparkle as root on Sonoma (#2432)
This may occur for example when you run sparkle-cli as root or use Sparkle.framework in a root process. This is not typically a common use case, but could be used from daemons.

The issue is that Sonoma doesn't like starting our Updater app in the user domain when intermediate directories containing it are root owned (due to lack of file permission access that wasn't present in Ventura). So now we try to create intermediate directories in the standard user's home directory.
2023-09-02 10:01:23 -07:00
Zorg a6e22a0667 Fix make release not building distribution successfully (#2430)
For some reason, the default BUILDDIR that was set was problematic. We are now defaulting BUILDDIR inside of ./build which resolves this issue. This also means by default, builds are not placed inside of system temp directories anymore.

I do not know when this stopped working or why.
2023-08-28 21:54:48 -07:00
Zorg 8125490931 Pre-warm installs before relaunch (#2421)
Move a lot of the installation work to be done during the first phase of installation (when possible), before the target app needs to be terminated. For the common case where the old and new bundles are on the same volume, the final phase of installation requiring a restart is now just an atomic swap.

Also move the termination listener to the agent app which resolves some launch/CI failures we've been seeing.
2023-08-27 22:22:52 -07:00
Zorg 4abbb2b4f1 Update CHANGELOG 2023-08-22 19:52:44 -07:00
Zorg 28e85abe88 Remove hyphenation in "You're up to date" message (#2425) 2023-08-22 19:49:48 -07:00
Zorg 5675086860 Update CHANGELOG 2023-08-12 18:19:10 -07:00
Zorg e59cf0e101 Improve permission prompt layout spacing (#2420) 2023-08-12 18:17:11 -07:00
Sparkle-Bot b5a9c0a1f1 Update Package management files for version 2.5.0-beta.1 2023-07-31 03:02:43 +00:00
Zorg 57c3732f7d Update CHANGELOG for 2.5 2023-07-30 19:50:37 -07:00
Zorg 0155c78a99 Ignore file URL scheme in custom allowed URL schemes (#2410) 2023-07-29 22:55:44 -07:00
Zorg d41b8652ee Adopt new app activation APIs in macOS Sonoma (#2409) 2023-07-29 21:21:31 -07:00
Zorg 821b0ff37f Improve error for xattr code signing for delta updates (#2408) 2023-07-23 16:47:49 -07:00
Zorg c9c08b7f42 Report an error when detecting duplicate updates in generate_appcast (#2407) 2023-07-22 16:25:38 -07:00
Nathan Manceaux-Panot 7c8fe1d427 Expose installed version string to update notes HTML page (#2373) 2023-07-11 22:07:42 -07:00
Zorg 5528d7f9ec Fix KVO usage for updaterController.updater.* (#2404)
KVO was not set up properly when trying to retrieve the updater from the updater controller, especially when the updater controller hasn't been fully initialized yet.
2023-07-04 07:29:57 -07:00
Zorg 419552a7d3 Upgrade Xcode in CI setup (#2397) 2023-06-24 16:24:51 -07:00
Eitot c23d74d8e0 Replace CFUUID* with NSUUID (#2395)
This resolves a nullability warning by the static analyzer.
2023-06-23 22:23:37 -07:00
Zorg 456a3d4275 Allow developer to use custom URL schemes in release notes view (#2393) 2023-06-19 20:27:18 -07:00
Sparkle-Bot 87e4fcbac3 Update Package management files for version 2.4.2 2023-06-18 00:17:52 +00:00
Zorg 2af0fa916c Update CHANGELOG for 2.4.2 2023-06-17 17:07:28 -07:00
Zorg 8039288f64 Harden verification of Sparkle update download (#2392) 2023-06-17 17:01:45 -07:00
Zorg 4ca2e2eb21 Fix NSKeyedUnarchiver warning for not specifying keyed NSString class (#2383) 2023-06-11 07:04:03 -07:00
Zorg f7567e5a69 Ignore release notes download when we shouldn't show release notes (#2381) 2023-05-27 09:18:17 -04:00
Sparkle-Bot 7907f058bc Update Package management files for version 2.4.1 2023-04-13 05:37:26 +00:00
Zorg 4a322e0ab4 Update CHANGELOG 2023-04-12 22:28:29 -07:00
Zorg 270582b2e7 Pass bookmark data for the downloaded update (#2359)
Also let Xcode 14.3 update the nibs.
2023-04-12 22:23:50 -07:00
Sparkle-Bot 91a2c1c100 Update Package management files for version 2.4.1-beta.1 2023-04-07 18:35:57 +00:00
Zorg 53d58921ef Update changelog for 2.4.1 2023-04-07 11:28:04 -07:00
Zorg e15324773f Remove auxiliary apps and relocate symbols in SPM package (#2356) 2023-04-07 11:23:23 -07:00
Zorg b7b858dbf3 Fix compile error when SPARKLE_EMBED_DOWNLOADER_XPC_SERVICE=0 (#2346) 2023-03-25 21:39:55 -07:00
Kent Sutherland 8e2107a57d Add -Wno-declaration-after-statement to silence warnings that only apply to pre-C99 (#2345) 2023-03-22 20:03:17 -07:00
Sparkle-Bot 631846cc82 Update Package management files for version 2.4.0 2023-03-19 14:48:24 +00:00
Zorg 3a99b31f37 Add plain-text embedded release notes support for sparkle-cli (#2344) 2023-03-18 22:20:30 -07:00
Zorg 151c256721 Update changelog for adding plain text release notes view 2023-03-18 21:30:42 -07:00
Zorg 82b94a131d Fix name reference in changelog 2023-03-18 21:14:34 -07:00
Sparkle-Bot 4ac6ea827a Update Package management files for version 2.4.0-beta.2 2023-03-13 03:05:11 +00:00
Zorg b5199e7a05 Update changelog for Sparkle 2.4 again 2023-03-12 19:53:37 -07:00
Zorg 39495fd562 Remove redundant codesign check (#2341) 2023-03-12 19:44:50 -07:00
Zorg 60568b82ba Don't allow DSA-only updates to pass if DSA is disabled (#2340) 2023-03-12 07:59:03 -07:00
Zorg 9ab2c0d58c Hide impractical compression options only useful for debugging (#2335) 2023-03-04 18:03:45 -08:00
Zorg 665bba36cc Fix documentation formatting (#2334) 2023-03-04 16:02:03 -08:00
Sparkle-Bot 1e8308116e Update Package management files for version 2.4.0-beta.1 2023-03-04 06:29:02 +00:00
Zorg 245c6821aa Update changelog for 2.4 2023-03-03 22:14:05 -08:00
Zorg ad936155fa Upgrade CI to use Xcode 14.2 (#2333) 2023-03-03 21:46:24 -08:00
Zorg d220346206 Trigger new update check in resetUpdateCycle if feed/channels changed (#2324) 2023-03-03 21:04:07 -08:00
Daniel Jalkut 95f8e7e0cf Turn off CLANG_MODULES_AUTOLINK for XPC services, to avoid Xcode inferring that they depend upon Sparkle.framework. This seems to resolve a pesky, recurring issue in which Xcode reports dependency cycles between the XPC services, Sparkle, and/or the host apps that embed Sparkle. (#2332) 2023-03-02 23:31:11 -08:00
Zorg 362f50a8a1 Exit with an error if generate_appcast cannot sign an update (#2322) 2023-02-25 13:18:03 -08:00
Zorg 87697ce10f Update SUVersionDisplay to allow including build versions and update information (#2321) 2023-02-25 08:15:02 -08:00
Sparkle-Bot da75bb432e Update Package management files for version 2.3.2 2023-02-12 15:15:22 -08:00
Zorg fde8f0a35e Update CHANGELOG for 2.3.2 2023-02-12 15:14:20 -08:00
Zorg 06edf5695d Remove unnecessary min macro checks (#2318)
Minimum OS preprocessor checks should only be used when compiler may generate compile warnings for deprecated APIs when the deployment target is raised.
2023-02-11 22:24:56 -08:00
Zorg ffc203b89a Add support for plain text release notes view (#2315)
This also allows embedded release notes to be plain text using sparkle:format="plain-text" attribute.

Also, Catalyst apps only support plain text release notes (compared to before where release notes weren't supported for Catalyst apps).
2023-02-11 19:34:26 -08:00
Zorg 348c3a9658 Don't construct appcast item if enclosure URL is invalid (#2317) 2023-02-07 20:12:07 -08:00
Lauri-Matti Parppei 077d7228ba Finnish localization grammar fixes (#2311) 2023-01-12 22:34:40 -08:00
Zorg be7f6952c2 Reduce code size and make codebase more consistent (#2305) 2022-12-27 12:03:03 -08:00
Zorg 91b8f4eaa0 Add delegate method to hide showing version history option (#2303) 2022-12-23 07:17:44 -08:00
Sparkle-Bot cc90026ade Update Package management files for version 2.3.1 2022-12-22 21:44:04 -08:00
Zorg 68d539ce83 Update CHANGELOG for 2.3.1 2022-12-22 21:42:51 -08:00
Zorg 8154b1eab3 Add deprecations/warnings for incorrect feed & update checking usage (#2295)
* Add deprecations/warnings for incorrect feed & update checking usage

This change deprecates -[SPUUpdater setFeedURL:] and logs warnings when the updater detects that feed URLs from user defaults are still being used.

This change also logs a warning when checkForUpdatesInBackground is used incorrectly if Sparkle is configured to ask the user's permission to check for updates but a check is done when automatic update checking is NO.
2022-12-19 20:34:20 -08:00
Zorg 14e4a98b69 Log the URL that failed to download correctly (#2296) 2022-12-03 23:30:44 -08:00
Zorg f36c34f2f4 Remove duplicate Sparkle localization strings in Updater app (#2288) 2022-12-02 23:01:01 -08:00
Zorg bdc095bf3a Ask permission for automatically downloading and installing new updates (#2285) 2022-12-02 22:29:17 -08:00
Zorg 8cd13b0cfd Upgrade CI to default to using Xcode 14.1 (#2287) 2022-11-27 12:48:48 -08:00
Zorg 89e2f94872 Enable deployment post processing for Release configurations (#2286) 2022-11-27 12:48:20 -08:00
Zorg a6536ea8f1 Fix update permission alert title text overlapping with question text (#2284)
This change adjusts the layout constraints between the title and message text to be more proper.

This issue is only noticeable in Russian, Spanish, Ukrainian, and Slovenian on my machine.

Issue has been present in Sparkle 1 as well.
2022-11-27 05:36:22 -08:00
Sam df313f7f59 Update Czech translation (#2275) 2022-10-29 16:22:32 -07:00
Zorg f06ccf2711 Update ReadMe with rationale for building Sparkle 2022-10-21 09:30:18 +02:00
Bing Zheung ef9398ab32 Add zh_HK (Chinese, Hong Kong) localization (#2273) 2022-10-08 11:28:53 -07:00
Zorg 8ac92e3ffa Bump development version 2022-10-08 11:28:18 -07:00
Sparkle-Bot 2a98381dfe Update Package management files for version 2.3.0 2022-10-01 16:01:44 +00:00
Zorg 9b4c91bc58 Update CHANGELOG 2022-10-01 08:27:56 -07:00
Zorg a7855eabe6 Update secondary CI runner from Xcode 14.0 -> 14.1 beta (#2272) 2022-09-24 10:32:56 -07:00
Chiahong f86907c13c Update zh_TW localization (#2271) 2022-09-23 22:31:07 -07:00
Sparkle-Bot 028e4c2bec Update Package management files for version 2.3.0-beta.2 2022-09-19 05:53:23 +00:00
Zorg 891cd38eba Update CHANGELOG for 2.3.0-beta.2 2022-09-18 22:44:16 -07:00
Zorg a208bd5cf9 Add -p option to sign_update to only print the signed signature (#2268) 2022-09-18 07:18:39 -07:00
Zorg 005392963f Allow developer to always force allowing automatic updates (#2266)
By default, if the SUAllowsAutomaticUpdates Info.plist key is not specified, the update alert option to allow automatic downloading/installing of updates will only be shown if automatic checking of updates is enabled. However, the developer can now override this by setting SUAllowsAutomaticUpdates to true in Info.plist which indicates the option should be available even if automatic checking of updates is not enabled.
2022-09-16 20:41:08 -07:00
Sparkle-Bot 83cc66b988 Update Package management files for version 2.3.0-beta.1 2022-09-06 02:35:22 +00:00
Zorg a93317fb08 Update CHANGELOG for 2.3 2022-09-05 19:27:15 -07:00
Zorg 1b1a7db1ac Expose maximum-versions option to preserve in feed per branch (#2259) 2022-09-05 16:20:35 -07:00
Zorg d9c0cc7f53 Add delegate method for when user makes an update choice (#2257)
Also add gentle reminder support in legacy SUUpdater 1.x methods
2022-09-04 15:58:09 -07:00
Zorg 7d68f8f7ae Improve clarification on documentation for SPUUpdater properties (#2256) 2022-09-03 14:18:57 -07:00
Zorg 03f2452379 Expose -[SPUStandardUserDriver activeUpdateAlert] as private API (#2255) 2022-09-03 07:25:31 -07:00
Zorg fc8000471b Pick branch runner is running on when drafting releases (#2254) 2022-09-02 13:34:31 -07:00
kakaiikaka 6c0e685063 added zh_CN l10n for "Version History" (#2247) 2022-08-30 22:18:53 -07:00
Sparkle-Bot c7c8b719cb Update Package management files for version 2.2.2 2022-08-28 23:28:16 -07:00
Zorg 4fa7b23f09 Update CHANGELOG for 2.2.2 2022-08-28 23:26:07 -07:00
Zorg f1fe9e45f6 Revert "Add 2.2.2 to test on CI"
This reverts commit 679cbc8652.
2022-08-28 22:04:05 -07:00
Zorg 679cbc8652 Add 2.2.2 to test on CI 2022-08-28 15:54:09 -07:00
Chiahong 6ef1f7fc7f Update zh_TW localization (#2246) 2022-08-28 15:17:25 -07:00
Zorg 6831a35e28 Update Package.resolved (#2245) 2022-08-27 17:26:35 -07:00
Zorg 1c560652e7 Remove ed25519 git submodule (#2244)
Also allow release scripts to work without git repository and bump the Sparkle versions.
2022-08-27 10:46:29 -07:00
Eitot 863f85b5f5 Clean up left-over code (#2243) 2022-08-27 06:17:28 -07:00
Zorg f46ea87380 Ensure install handlers are invoked on main queue (#2235) 2022-08-22 18:23:23 -07:00
Zorg f5d4ad52ca Allow user to re-try installing/relaunching application (#2234)
If the app termination request is delayed or canceled, the user can check for updates again with the standard user driver and try installing/relaunching again, which will trigger the installer to send another quit event to the running application.

Before the install/relaunch window would close but the check for updates option would still be present but not functional.
2022-08-21 08:54:03 -07:00
Zorg 926c47d48e Find potential matching translocated running apps in updater agent (#2233)
In the installer progress agent, when we find all potential running applications for a host bundle, we should also consider any translocated running apps that look-alike the host bundle.

This matters when updating external bundles. For example if sparkle-cli tries to update an app on disk in ~/Downloads/ but a running instance of the app is translocated, sparkle-cli should terminate the translocated instance of the app before installing the update.

It's possible this could generate a false positive but we err on the side of safety here. We only use running translocated apps if we find no regular matching apps.
2022-08-20 10:30:00 -07:00
Zorg fbfcec3453 Fix recently introduced bugs in generate_appcast with multiple feeds (#2232)
We fix the validation check for using the output option when multiple feeds are present, fix not generating new feeds when no prior feed is available, and fix incorrect logic with cleaning up delta files when multiple feeds are present.
2022-08-19 21:36:50 -07:00
Zorg 8f77f066c1 Add delta update attributes for validating an app hasn't been stripped (#2231) 2022-08-19 20:48:52 -07:00
Zorg 47f335614a Wait for a threshold amount of time before replying with status info data (#2230)
This also reverts 6a69f26dcc and 4cb6719c6b
2022-08-19 10:40:25 -07:00
Zorg 80a5b80ade Move old updates to old_updates in generate_appcast (#2228)
Document --versions in generate_appcast better and add comments to explain why certain policies were made.

Add separate option to automatically pruned old update files. Now we only automatically move old update files aside. If the user passes --auto-prune-update-files we will also remove the old update files automatically.

Move old release notes files too.

Don't make old-updates directory hidden.
2022-08-14 19:07:48 -07:00
Zorg e81ccbd891 Upgrade Xcode builds in CI to 13.4.1 and 14.0 beta (#2226) 2022-08-12 18:49:40 -07:00
Kent Sutherland dc2e1ff534 Update Portuguese localization (#2224) 2022-08-08 19:24:56 -07:00
Zorg 37ef179284 Prune and preserve necessary updates in generate_appcast (#2218)
We preserve a batch of updates for each branch point (defined by an update's {majorVersion, minSystemVersion, maxSystemVersion, channel}). The latest for each branch point is used for generating delta updates.

We prune older update items that are no longer needed in the feed or needed for generating delta updates from newer items. We move pruned update files into a separate hidden directory, which is later garbage collected after a couple weeks based on each file's last modification date.

To insert new update items that are older than the latest update in the feed, --version flag needs to be used.

The overall goal is to have the feed only keep a small window of updates to serve to the user. This will also ease future processing generate_appcast needs to do and ensure the cache's directory doesn't blow up by pruning old updates.
2022-08-07 19:13:20 -07:00
Zorg 6a69f26dcc Clean up handling appcast item registration message (#2223) 2022-08-07 17:08:33 -07:00
Zorg 4cb6719c6b Critical update alerts may not show up as promptly as they should when automatically installing them (#2221)
Wait for appcast item registration before finishing automatic update driver.

This fixes a potential race issue where sometimes the automatic update driver on completion would sometimes not trigger to prompt an update alert immediately for critical updates. Note in this case, the update would still be installed on app termination and would still be scheduled to alert the user on the regular update check interval, so this issue is not severe.
2022-08-06 11:28:47 -07:00
Zorg 2c81393ec2 Remove module imports from framework headers (#2217)
Framework headers should not be using them. The warning these aim to suppress (-Wauto-import) is also going away.
2022-07-29 22:01:04 -07:00
Zorg 983d19580b Fix handle applying patches when files aren't writeable (#2216) 2022-07-23 10:37:29 -07:00
Zorg 6cbe8444a0 Refine update alert when no release notes are shown (#2206)
* Set layout constraint constant between buttons and description to 20

* Disable update alert resizing when no release notes are available

* Fix layout constraint warning

* Set alert autosave frame name only when release notes are shown
2022-07-17 20:56:17 -07:00
Zorg 45a9099082 Reject DSA only configurations for setting up the updater (#2207)
The one exception is an updater that is targeted to update another / non-main bundle.

Note we still allow configuration of not using DSA or EdDSA with the deprecation warning in tact.
2022-07-17 20:55:31 -07:00
Jie aa72b3f639 Hide automatic install check box when allowsAutomaticUpdates is disabled (#2202) 2022-07-17 16:45:02 -07:00
Zorg 372f0504a5 Bump minimum deployment target to macOS 10.13 (#2196) 2022-07-17 16:43:24 -07:00
Zorg 470296a90e Remove outdated model translation plist (#2195) 2022-07-17 15:57:43 -07:00
Zorg 242ae2c392 Disable implicit dependencies for runnable schemes (#2171)
Also add missing explicit dependencies from targets
2022-07-17 15:52:16 -07:00
Sparkle-Bot 059ce91287 Update Package management files for version 2.2.1 2022-07-16 13:34:05 +00:00
Zorg cc0007de3a Update CHANGELOG 2022-07-16 06:25:46 -07:00
VinBoiSoft fe69cab530 Update Italian localization (#2192) 2022-07-09 12:43:10 -07:00
Zorg 14e511f901 Fix memory leaks when using generate_appcast (#2193)
We fix one memory leak when calculating sha's, one memory leak in the xar delta applying path, and avoid creating Bundles for reading the Sparkle framework version.

There are some other small leaks with the xar delta creation/applying code but since it's a legacy implementation and the APIs are undocumented I don't want to touch it too much.

The biggest culprit here is the leak when calculating sha's I believe, if you have many archive items.
2022-07-09 12:22:36 -07:00
Pavel Moiseenko 80e60279ee Make dark scroll bar in dark theme (#2187) 2022-07-04 09:40:44 -07:00
Sparkle-Bot c1bf68f91f Update Package management files for version 2.2.0 2022-07-02 18:55:40 +00:00
Zorg 4622061d8f Add deprecation of -s flag in CHANGELOG 2022-07-02 09:45:00 -07:00
Zorg a7e5320d6a Update CHANGELOG 2022-07-01 21:58:58 -07:00
basilTandaONe 90221e7a0f Update Greek localizations (#2185)
Co-authored-by: aONe
2022-07-01 21:47:16 -07:00
aONe 7c1cc5627b Updated Greek translation (#2184)
Fixes #2175, from @seitsme
2022-07-01 19:08:13 -07:00
Zorg bececc3738 Reset opportune time for showing new updates after preference changes (#2183)
Reset opportune time for showing update notice when updater starts as well.

Also update updater header API documentation and add private protocol for gentle scheduled reminder APIs that the updater uses.
2022-07-01 19:06:27 -07:00
1024jp a6984d3c02 Update Japanese localization (#2182)
* Add unlocalized strings to Japanese localization

* Remove unwanted spaces in Japanese localization
2022-06-30 21:54:01 -07:00
Zorg 102c4a4009 Fix Greek translation in "You are currently running version" string (#2181) 2022-06-28 22:26:20 -07:00
Zorg d2fd9a50e0 Use recovery suggestion key for update permission error (#2180) 2022-06-26 18:41:55 -07:00
Zorg d544d456e0 Synchronize usage of XPC connections to main queue (#2178) 2022-06-25 21:29:44 -07:00
Zorg b1f6c161d1 Use snprintf instead of sprintf to fix compile warning (#2179) 2022-06-25 16:41:32 -07:00
Zorg 06daa03196 Fix installer status xpc service bundle ID (#2177)
The bundle ID name broke after I was renaming the XPC Services for 2.2.
2022-06-25 15:00:33 -07:00
Zorg e64b7649f2 Deprecate -s flag and add --ed-key-file option to generate_appcast (#2170) 2022-06-24 21:19:10 -07:00
Sparkle-Bot 220c1edac1 Update Package management files for version 2.2.0-beta.2 2022-06-20 02:54:54 +00:00
Zorg e866f8d786 Update changelog for Sparkle 2.2 2022-06-19 18:18:31 -07:00
Zorg 2b6664cd8a Fix incorrect references in gentle reminder header documentation (#2165) 2022-06-19 17:39:52 -07:00
Zorg a913fe1355 Update external licenses text and add ed25519 (#2164) 2022-06-18 20:54:46 -07:00
Zorg 24b072c661 Update gentle reminder API documentation (#2163) 2022-06-18 12:59:13 -07:00
Zorg 2ddef5179e Bump initial installer message timeouts and declare daemon/agents as Interactive (#2162) 2022-06-18 11:40:45 -07:00
Sparkle-Bot 308ba94373 Update Package management files for version 2.2.0-beta.1 2022-06-13 02:31:58 +00:00
Zorg 9a1142a5b1 Fix pull request number in changelog 2022-06-12 19:23:40 -07:00
Zorg 4cb4974107 Update changelog to incorporate #2119 2022-06-12 18:59:27 -07:00
Zorg 5343305e3f Report friendly error if installation fails with no write permission (#2157)
On macOS 13 (Ventura) and later, installation could fail if Gatekeeper blocks app modifications. Note this is only applicable for external updaters like sparkle-cli where the updater and target bundle to update have different team identifiers.
2022-06-12 18:50:40 -07:00
Zorg 72c866f964 Update changelog with stage manager fix 2022-06-12 15:23:23 -07:00
Zorg 6808a94dbb Don't let status window make other active windows exit in stage manager (#2153)
We set the status window's collection behavior to full screen auxiliary. This is how the collection behavior for the update alerts and permission prompts are set up, but we never applied it to the status window.

With this change, bringing the status window up front (e.g, for downloading an update) does not push the other app's windows back into the stage manager tiles.
2022-06-12 15:19:55 -07:00
Zorg 38ed86dad0 Update Changelog for Sparkle 2.2 2022-06-11 19:33:13 -07:00
Zorg 15e8270291 Silence deprecation warnings when bumping deployment target (#2152) 2022-06-11 13:09:23 -07:00
Zorg d7942768b8 Validate permission bits of Sparkle executable for delta updates (#2151) 2022-06-11 11:21:52 -07:00
Zorg f126876d35 Show checking window back in focus and activate app if needed (#2150) 2022-06-10 21:53:58 -07:00
Zorg 9080bebc88 Fix Xcode 14 warnings (#2149)
* Upgrade project version

* Use +initialize instead of +load for debug warning
2022-06-10 21:30:42 -07:00
Zorg bf6dc6210f Update issue templates to reflect new discussions 2022-06-05 18:01:17 -07:00
Zorg 04d3c13043 Make displayVersionString non-null and update fallback documentation (#2139) 2022-06-05 16:35:04 -07:00
samschott a33bae7bad Use displayVersionString instead of versionString for OS version mismatch error message (#2138) 2022-06-05 16:34:37 -07:00
Zorg b3d31d254e Update create-draft-release CI action 2022-06-05 07:13:20 -07:00
Zorg 024eec0b09 Update Xcode in CI to 13.3.1 (#2137) 2022-06-04 23:16:33 -07:00
Zorg 9ba73525b0 Update last update check time when choosing to install update (#2136)
In the UI driver, this is when the user chooses to Install & Relaunch.

In the automatic download based driver, this is when Sparkle hands off responsibility to its delegate to install the update and they trigger the callback to relaunch the app.
2022-06-04 18:43:59 -07:00
Zorg 7ced6efba0 Remove SPUURLRequest class (#2134)
This class was only introduced because older OS versions we no longer support didn't have NSURLRequest implement NSSecureCoding.
2022-06-04 18:22:44 -07:00
Zorg fabd3e6c7b Schedule next update check if we're firing immediately (#2133)
Even if the updater is set to not automatically check for updates.

This fixes a bug where an update cycle may not complete if the automatic update driver first started, and the update should have been resumed but automatic update checks were disabled by the developer.

The developer would have had to disable automatic update checks, check updates in the background themselves, have updates set to download automatically/silently, and be in a situation where the update would be deferred to non-silent update (for example, user requiring authorization to install, critical update being presented, info-only update being presented).
2022-06-04 14:03:03 -07:00
Zorg 58fa11ce04 Add standard user driver APIs for gentle scheduled update reminders (#2122)
* Log warning if gentle reminders aren't implemented for background app
* Don't let background running app steal focus from other apps except at launch
* Don't set update alert window level to floating for background apps
* Show update alert in back for currently active background apps
* Disable warnings for direct ivar access
* Center update status window to last update alert window shown
* Activate app from user initiated checks if it's not active
* Set systemHasBeenIdle to YES only if the app isn't preventing display sleep
* Don't make status window key if update alert wasn't key window
2022-06-04 13:14:01 -07:00
Zorg 503830bf24 Refine minimizing state for download/extraction/installation status (#2121)
Don't allow status window to be minimizable for non-app bundle updates due to atomicity concerns.

Add delegate method to allow developer to configure if they want the status window to be minimizable.
2022-05-08 11:12:12 -04:00
Zorg 2bc9471ed1 Delay showing scheduled update alert if application is active (#2120)
We wait until a more opportune time when the app becomes re-activated, but if too much time 
has passed we will show the update anyway. A few exceptions are:

* App just launched
* User has been idle on their machine
* User initiates update check themselves
2022-05-08 10:32:14 -04:00
Zorg 339e26984e Add support for running framework and CLI as root (#2119)
When the framework or sparkle-cli is run as root, we always launch the installer (Autoupdate) in the system domain.

For the progress tool agent, we chown() the copied Updater.app so the Updater app has proper ownership of it (and clean it up later). The progress tool app may not be able to clean up the parent directory, but that's okay and will be garbage collected on a later run.

To get the username and home directory for the user session when running the framework as root, we use the SecurityConfiguration framework. Sparkle needs and depends on an active GUI user login session. If a user ssh's in to install an update, that user must be the same as the active logged in user.

Installing interactive based package updates as root is not supported. For sparkle-cli, we disallow using --interactive when running as root.

An additional error exit code is added for sparkle-cli when ran as root and trying to install a interactive based package update, which is unsupported.
2022-05-07 09:33:27 -04:00
Zorg 9042c8dbd9 Fall back to regular update if delta update fails to download (#2118)
Also log out the download failure when a delta update fails to download (such as a 404 error for example).

Additionally, add a check to make sure that top-level appcast items cannot be delta update items.
2022-05-01 22:58:29 -07:00
Eitot 180f8975cf Replace deprecated code with newer APIs (#2112)
* Use UniformTypeIdentifiers framework to replace deprecated types

kUTType* constants are deprecated since macOS 12. The UniformTypeIdentifiers framework is available since the macOS 11 SDK.

* Replace renamed constants

* Use API_AVAILABLE macro instead of __OSX_AVAILABLE
2022-04-24 16:51:48 -07:00
Zorg d5b650bae7 Skip delta updates on exFAT and FAT32 file systems (#2115)
We don't support applying delta updates on these systems (due to lack of permission support), so we shouldn't even try downloading delta updates in this case.
2022-04-24 00:39:40 -07:00
Zorg 94719edeb3 Ignore custom icons set via resource forks in delta updates (#2114)
For creation, we will disallow creating delta updates if a custom resource fork icon data is found in either the old or app bundles.

For applying, we will just ignore the icon data when performing hash verification and continue applying the patch.
2022-04-24 00:38:42 -07:00
Eitot c33a416b53 Update localisations (#2113)
* Remove duplicate localization identifiers

Some localizations have multiple identifiers, e.g. Canadian French has "fr-CA", "fr_ca" and "fr_CA" and Norwegian Bokmål has "nb" and "no" (though "no" can include Norwegian Nynorsk, Xcode seems to treat it as Bokmål and therefore a duplicate of "nb"). This commit removes superfluous identifiers and keeps the identifier that Xcode uses by default.

This also removes the no.lproj/ directory which contains either obsolete localized strings or strings that are present in nb.lproj/ too.

Furthermore, this renames the .lproj/ directories for "pt_PT"/"pt_BR" to "pt-PT"/"pt-BR" since the latter identifiers are the default in Xcode.

* Update localizable strings to match the current localizations

Replaces the following characters in the localizable strings:
- ellipses (... → …)
- curly apostrophe (' → ’)
- em dashes (-- → —)
- non-breaking spaces

These were already used in the .strings files.

* Regenerate Sparkle.strings

This applies the changes in the previous commit to the strings files of the base localization.

This also removes the following strings, which are no longer present in the source:
- "%1$@ wants permission to update %2$@."	
- "%1$@ wants permission to update."
- "An error occurred while downloading the update feed."
- "An error occurred while installing the update. Please try again later."
- "An error occurred while relaunching %1$@, but the new version will be available next time you run %1$@."
- "Are you sure you want to skip this upgrade?"
- "Don't Skip"
- "Skip Upgrade"
- "The update is improperly signed."
- "You already have the newest version of %@."
- "B", "GB", "KB" and "MB"

* Update localized Sparkle.strings

This applies the changes in the previous commits to the strings files of the localizations.

* Re-import localizations

This updates the .strings files using xcodebuild to:
- remove obsolete localizable strings,
- incorporate (changed) localization comments and
- replace UTF-16 encoded .strings files with UTF-8.

* Update Dutch localization

* Update French localization

This replaces single quotes and spaces with apostrophes and non-breaking spaces.
2022-04-24 00:36:29 -07:00
Eitot b0116ef31b Remove obsolete SDK checks (#2111)
Sparkle currently requires at least Xcode 12 (or the macOS 11 SDK), therefore fallbacks for older versions are no longer needed.

* Remove +isOperatingSystemAtLeastVersion: method

* Remove +operatingSystemVersion accessor method

* Remove SUTouchBarForwardDeclarations header
2022-04-23 23:34:20 -07:00
Eitot c0cf32c2b7 Remove obsolete fallbacks folder older OS versions (#2110)
* Remove fallback for NSByteCountFormatter

* Remove fallback for NSFont -monospacedDigitSystemFontOfSize:weight:
2022-04-21 20:00:33 -07:00
Zorg f250bead4b Update alert activation improvements (#2100)
* Don't activate app when bringing up update alert errors
* Don't set status window level to floating
* Make status window minimize-able after checking for updates
* Allow install button to have focus when app has just launched
* Reset install button focus when app becomes active again
2022-03-06 22:39:32 -08:00
Zorg 640e988a39 Change XPC Service product names to be more human readable (#2096)
They should not be bundle IDs because they may surface up in the UI.

Particularly, the Installer XPC Service may show up in the authorization prompt when authorization is required to install an update.
2022-03-06 21:26:56 -08:00
Zorg 183a930797 Ignore -Wobjc-interface-ivars warning (#2099) 2022-03-05 13:03:08 -08:00
BR Lingo 2f86c4f5fe Translation of new strings (#2094)
Adaptation of previously translated strings to use a more inclusive language
Translation consistency amendments
2022-02-26 19:52:28 -08:00
Sparkle-Bot 286edd1fa2 Update Package management files for version 2.1.0 2022-02-18 18:59:35 +00:00
Zorg 242ba4e5c4 Update changelog and documentation (#2089) 2022-02-12 14:06:39 -08:00
Dan Rigdon-Bel 8edc77fdb2 Use strcoll_l() for locale-independent comparisons (#2087)
The update code uses the compareFiles function to determine the sort order of file names in a directory, which is then compared with a list of files in the Sparkle update info. If the list of files of a directory from Sparkle's update is different than what is on disk, the Sparkle abandons the update and does a full download. This bug would prevent Sparkle from updating properly when the file lists are calculated on an English language system, but then checked on a destination Japanese system.

The fix is to use strcoll_l(), which is locale-independent, when comparing file names for sorting. This will ignore any locale changes the host application has made that could potentially affect Sparkle's sort order.
2022-02-08 20:38:55 -08:00
Sparkle-Bot eb938ad15a Update Package management files for version 2.1.0-beta.2 2022-02-05 07:02:18 +00:00
Zorg 18c751eaf9 Update CHANGELOG 2022-02-04 22:54:34 -08:00
Zorg 94b48c45e7 Preserve file system compression when applying delta updates (#2084) 2022-01-30 23:37:42 -08:00
Zorg e8fea3481a Add generate_appcast support for recent features (#2082)
We add support for:
* <sparkle:belowVersion> in <sparkle:informationalUpdate>
* <sparkle:ignoreSkippedUpgradesBelowVersion>
2022-01-30 15:20:55 -08:00
Zorg 8ea4d705f5 Add option to ignore skipped upgrades (#2081)
Normally when a major upgrade is skipped, subsequent updates for that major release are skipped. This element however allows publishing updates that ignore the user skipping the major version before a specific sub-release.
2022-01-29 23:02:45 -08:00
Zorg ac2ef612bc Don't let skipping a major version to skip subsequent major versions (#2079) 2022-01-29 10:37:09 -08:00
Zorg 84252a64f8 Add sparkle:belowVersion element for informational updates (#2080)
This allows marking all updates below a specific version as informational only.

A new element (sparkle:belowVersion) was introduced this over a new attribute for sparkle:version due to compatibility reasons.
2022-01-29 10:36:11 -08:00
Zorg 930ea303fd Add sparkle:belowVersion element for informational updates (#2080)
This allows marking all updates below a specific version as informational only.

A new element (sparkle:belowVersion) was introduced this over a new attribute for sparkle:version due to compatibility reasons.
2022-01-29 10:35:24 -08:00
Sparkle-Bot 452472ee3e Update Package management files for version 2.1.0-beta.1 2022-01-24 03:00:42 +00:00
Zorg d4499956e7 Update CHANGELOG for 2.1.0 2022-01-23 18:40:00 -08:00
Zorg 91bccdf0ad Verify code signing in generate_appcast (#2077)
In generate_appcast we:

* Validate code signing integrity of new updates
* Add hidden flag to disable checking for nested code during validation
* Warn if new and old apps have differing signing identities when generating deltas
2022-01-23 14:46:52 -08:00
Zorg 89e20a490d Add hidden option to generate_appcast to set max CDATA threshold (#2075) 2022-01-22 20:58:53 -08:00
Zorg 9e45a78e6f Verify applying delta patch in generate_appcast (#2076) 2022-01-22 20:14:45 -08:00
Zorg 92d8b2bee6 Add verify and account options for signing updates (#2074)
Accounts are intended to be used for when working on products that belong to different organizations. This way multiple keys related to Sparkle can be stored in the keychain.

We also add a --verify option to sign_update which allows verifying that updates are signed correctly.
2022-01-22 18:48:02 -08:00
ZorgandEric Shapiro 6bed29c481 Add check for http statusCode on file downloads (#2073)
Co-authored-by: Eric Shapiro
2022-01-22 13:03:01 -08:00
Zorg fa9bfc1fc4 Fix unsteady progress when installing updates (#2072)
Also add -showInstallingUpdateWithApplicationTerminated: to SPUUserDriver which replaces -showInstallingUpdate and -showSendingTerminationSignal
2022-01-22 12:07:45 -08:00
Zorg 05abb2f7e4 Fix version compare not treating '2.1.0' and '2.1' as being equal (#2065) 2022-01-18 00:07:56 -08:00
Zorg c029b98efb Fix progress bar and button alignment for checking updates (#2066) 2022-01-18 00:05:05 -08:00
Zorg c30f6fe7fb Calculate hash of file for delta updates without using mmap (#2067) 2022-01-18 00:04:40 -08:00
digitalMoksha 403209b818 Preserve the Entitlements directory in podspec (#2062)
In order to code sign Sparkle when installing via a Pod, the `Entitlements` directory needs to be available.
2022-01-16 12:53:09 -08:00
Zorg 1641371e83 Warn and validate against irregular permissions for delta patches (#2061)
* Only track 0755 permissions for symbolic links

Also warn the user when encountering symbolic links that have a non-standard permission mode.

* Warn users when bad or irregular permissions are encountered
2022-01-15 23:00:59 -08:00
Zorg 1f538981c3 Reference XPC Service names from build setting variables (#2060) 2022-01-13 19:25:47 -08:00
Zorg 0a152ed02d Update FileManager APIs (#2059) 2022-01-09 22:30:10 -08:00
Zorg b05c058219 Silence deprecations and use modern NSSecureCoding APIs (#2058) 2022-01-09 19:25:28 -08:00
Zorg 3bd1b25513 Simplify tracking of file permissions for deltas (#2057)
Also fixes minor issue where change in permissions wasn't printed in correct format when applying a patch in verbose mode.
2022-01-09 18:20:50 -08:00
Zorg 41f953d77b Fix minor binary delta issues and make version 3 the default (#2055) 2022-01-08 21:23:15 -08:00
Zorg 51ee14c3d3 Add UI tests for delta updates and automatic updates (#2054) 2022-01-08 18:05:07 -08:00
Zorg f6396aecfb Add heuristics for binary delta when files move to other directories (#2053)
We have one heuristic for when a .framework version changes, and another for when a file with the same name moves to another location.

To support this, we added a clone + binary diff command.

Also document and improve the format.
2022-01-08 11:48:27 -08:00
Zorg 71fc8d7b11 Add additional options to delta tools (#2052) 2022-01-04 00:14:45 -08:00
Zorg 23fc577184 Add new version 3 binary delta archive format (#2051)
This new format introduces:

* A new container format which stores metadata in a way that is more efficient for compression, decompression, and size. Creation time can be 2x faster, apply time can be a few seconds faster, size savings can be 500 KB - couple of MB due to metadata alone.
* An array of supported compression formats including lzma, bzip2, zlib and more. We now default to lzma which is as competitive as bzip2 (which we were using in version 2 format) in applying/creation times, but can save several MB on size.
* Tracking of files from an old app being replicated in different locations in the new app. This can track unchanged files being renamed and can result in significant savings if the files are large.

Version 2 format is still the default. To use version 3, pass --version=3 to BinaryDelta when creating a patch. We will switch the default to version 3 later. generate_appcast support is upcoming.
2022-01-02 11:35:51 -08:00
Zorg a1add127eb Update pull request templates and Xcode CI version to 13.2.1 (#2048) 2021-12-29 23:23:55 -08:00
Zorg fc44085602 Isolate xar usage in its own archive type for delta patches (#2047)
Also remove support for creating and applying version 1 delta files. Version 2 delta files have been supported by Sparkle 1.10 and later.
2021-12-29 22:41:08 -08:00
Sparkle-Bot 85d3fa2e0e Update Package management files for version 2.0.0 2021-12-26 22:59:45 +00:00
Zorg 81b281b596 Fix readme typo 2021-12-26 14:43:44 -08:00
Zorg ee3f8f3285 Update changelog and readme for Sparkle 2 (#2040) 2021-12-26 14:42:31 -08:00
Zorg 26f1209fe9 Fix incorrect xz log warning in make release (2.x) (#2045) 2021-12-25 00:52:56 -08:00
Sparkle-Bot 2195ee0883 Update Package management files for version 2.0.0-rc.1 2021-12-12 05:35:16 +00:00
Zorg 92c8142354 Fix Cocoapods badge URL 2021-12-11 19:57:32 -08:00
Zorg 1d04bd44ab Update README (#2038)
Add SPM compatible badge. Update for soon anticipated release of Sparkle 2.
2021-12-11 19:54:39 -08:00
Zorg 017f8f733e Add and update Carthage binary json distribution file on release (#2036) 2021-12-11 11:07:39 -08:00
Eitot b37fa239db Update Dutch and German localization (#2034) 2021-12-08 17:52:51 -08:00
Sparkle-Bot 831e9b4eb7 Update Package.swift and Sparkle.podspec for version 2.0.0-beta.6 2021-12-06 07:11:10 +00:00
Zorg 0a19f6f30d Document how to implement error based delegate methods in Swift (#2033) 2021-12-05 22:56:48 -08:00
Zorg 3a64116913 Update and review internal documentation (#2030) 2021-12-04 22:59:17 -08:00
Zorg 1ef42e9d1c Add apfs dmg unarchiving test (#2028) 2021-11-25 15:53:19 -05:00
Zorg c500487077 Improve pipe usage when unarchiving files (#2027) 2021-11-24 19:21:53 -05:00
Zorg acc4674c3e Fix volume detection being wrong in rare cases (#2026) 2021-11-24 11:33:04 -05:00
Zorg 39cedd4092 Fix unarchiving job being blocked when passed bad input (#2023) 2021-11-24 11:16:31 -05:00
Zorg 4517d61db5 Clarify signing error better (#2022) 2021-11-23 12:51:03 -05:00
Zorg 18fe269949 Update issue templates and minor capitalization issue (#2024) 2021-11-15 18:36:53 -08:00
Zorg 3a9c257691 Sync CHANGELOG with 1.x 2021-11-12 21:18:01 -08:00
Zorg 3fcc87086c Use user agent of updater bundle instead of the host bundle (#2020) 2021-11-12 21:09:31 -08:00
Zorg 4b6527424a Revert monotonic timer (#2018) 2021-11-12 15:14:01 -08:00
Sparkle-Bot 1adbbccf5e Update Package.swift and Sparkle.podspec for version 2.0.0-beta.5 2021-11-08 07:40:57 +00:00
Zorg d792a3a4a9 Fix create-draft-release not including pre-release suffix 2021-11-07 23:10:36 -08:00
Zorg 32bc43fa9b Update CHANGELOG to sync 1.27.1 changes 2021-11-07 20:13:49 -08:00
Zorg 4b9388d9aa Add full release notes link flag to generate_appcast (#2015) 2021-11-07 19:52:03 -08:00
Zorg c53ed49e5e Prevent potential rapid update checks using monotonic clock (2.x) (#2002) 2021-11-07 17:20:19 -08:00
Zorg 011a7dbb36 Revert "Use NSPanel for Sparkle windows to allow untitled windows form Dock (#2005)"
This reverts commit 52511a2b1c.

Reverting due to extended discussion in #2005
2021-11-07 16:28:02 -08:00
Ethan Wong fb1f5aafbe Launch test app in English for UI Tests for prevent local test failure. (#2014) 2021-11-07 15:08:43 -08:00
Ethan Wong 52511a2b1c Use NSPanel for Sparkle windows to allow untitled windows form Dock (#2005) 2021-11-07 09:03:55 -08:00
Zorg 5b312aa63e Fix null deference analyzer warnings (#2011) 2021-11-06 18:49:45 -07:00
Zorg 7cec9dbbe0 Ensure analyze step is only ran during pull requests 2021-11-06 18:07:37 -07:00
Zorg dde2b48af7 Post analyzer warnings in CI (#2010) 2021-11-06 17:59:30 -07:00
Zorg 9b6f962b31 Clarify documentation for canCheckForUpdates / sessionInProgress (#2009) 2021-11-06 15:38:25 -07:00
Zorg 1cba9f466d Whitelist about:srcdoc as a safe web URL (#2006)
The document I tested (after enabling javascript) was:

<description>
          <![CDATA[
              <p>Hello</p>
              <script>
              var iframe = document.createElement("iframe");
              iframe.srcdoc = `<!DOCTYPE html><p>Hello World!</p>`;
              document.body.appendChild(iframe);
              </script>
          ]]>
</description>
2021-11-06 14:52:09 -07:00
Zorg dbe1ae94f9 Update documentation, readme, changelog (#2004) 2021-11-06 02:17:49 -07:00
Zorg 45956ae5b0 Support relative links for fullReleaseNotesLink and enforce http(s) (#2003) 2021-11-06 01:56:50 -07:00
aONe 4c1bebedf9 fullReleaseNotesLink implemented (#2001) 2021-11-04 22:35:23 -07:00
Zorg 873a026627 Add project version inputs to create-draft-release workflow (#1998) 2021-10-30 22:55:27 -07:00
Zorg 9e54c5ca4d Sync 1.27.1 changelog (#1997) 2021-10-30 16:24:25 -07:00
Zorg 083790afa7 Don't use current date unless necessary when scheduling next update (2.x) (#1992) 2021-10-30 11:03:52 -07:00
Zorg c3030a6621 Revert "Set CODE_SIGN_INJECT_BASE_ENTITLEMENTS=NO for release (#1973)" (#1994)
For development we should include task-get-allow entitlements. For distribution if people use custom workflows, they need to properly re-sign the app without preserving this entitlement
2021-10-30 11:02:04 -07:00
Billy Gray e48edc6856 Adds standard user driver delegate method for responding to Version History button (#1989) 2021-10-29 16:59:48 -07:00
Zorg a81f8f3d2d Add safer handling for applying binary delta files (#1988) 2021-10-29 12:14:23 -07:00
Zorg 88c325a66f Bump default Xcode version to 13.1 (#1987) 2021-10-28 23:46:34 -07:00
Sparkle-Bot 0d43f88a83 Update Package.swift and Sparkle.podspec for version 2.0.0-beta.4 2021-10-24 04:04:45 +00:00
Zorg 2268b96c78 Bump project version to 2.0.0 beta 4 2021-10-23 20:56:35 -07:00
Zorg 3de3591d13 Fix order of inserting new appcast items in generate_appcast (#1982)
When we don't have any information for existing items, we have been appending new items below the existing ones. We should insert new items such that new items are inserted in order of version descending.
2021-10-23 20:21:54 -07:00
Zorg 7a9c1d76e6 Update Xcode 13 to 13.1 in CI (#1983) 2021-10-22 23:28:51 -07:00
Eitot fad6f1efe8 Update Dutch localisation (#1976) 2021-10-21 23:55:57 -07:00
Eitot 8045bf7af8 Update German localisation (#1977) 2021-10-21 23:54:39 -07:00
Zorg a436711133 Update CI to Xcode 12.5.1 2021-10-21 22:45:37 -07:00
Eitot ae7e7f12bc Update English localisation (#1978) 2021-10-21 22:40:34 -07:00
Zorg 80abad4477 Move XPC Services inside Sparkle framework (#1965)
Also bump FRAMEWORK_VERSION from A to B to work around system cache issues.
2021-10-17 23:35:09 -07:00
Zorg c9097ba42c Set CODE_SIGN_INJECT_BASE_ENTITLEMENTS=NO for release (#1973)
This removes the com.apple.security.get-task-allow entitlement on helper executable tools and XPC Services. While this is not a big deal, I don't think we should distribute executables with this entitlement which allows debugging them (with SIP / hardened runtime on). Note notarization ought to reject this entitlement with library validation enabled, so people must be getting around this anyway (either by using Xcode's Archive / Export which automatically strips this entitlement, or re-signing Sparkle tools without preserving entitlements).
2021-10-17 23:30:47 -07:00
Micah Moore 08f473fe82 Updates Version History French string translation. (#1975) 2021-10-11 20:11:45 -07:00
Zorg 6f8e8e4789 Make canCheckForUpdates property KVO compliant/observable (#1968)
* Make canCheckForUpdates property KVO compliant/observable

Also set updater session in progress when probing for update check interval to use.

* Add assert that driver must be nil in checkForUpdatesWithDriver:..
2021-10-03 12:58:00 -07:00
Daniel Jalkut a9d5a42768 When applying the system font size to the baseline CSS for the web view, use px instead of pt to specify the font size. This is consistent with best practices for web content, and alleviates a problem wherein the text in the web view, if not based on a full-fledged release notes HTML document, appears too large. (#1962) 2021-09-22 22:23:04 -07:00
Daniel Jalkut 9364c96336 Don't manipulate the default WebView preferences, which at least on Monterey beta returns a preferences instance with nil identifier and with autosaves set to YES. This has the unfortunate effect of causing Sparkle, when it uses SULegacyWebView, to pollute the host app's user defaults with high level WebKit defaults for user style sheet, font sizes, etc. Specifying a unique identifier as well as turning autosaves off should both ensure Sparkle doesn't impose app-wide defaults on the host app, and also avoid littering the host app's preference file with identifier-prefixed defaults. (#1961) 2021-09-22 19:14:13 -07:00
Sparkle-Bot ed9fa9bfed Update Package.swift and Sparkle.podspec for version 2.0.0-beta.3 2021-09-19 23:54:50 +00:00
Zorg 21b264543d Update version to 2.0.0-beta.3 (2003) (#1959) 2021-09-19 16:48:03 -07:00
Zorg eba1734f09 Fix issues with standard updater controller initialization (#1958)
* Fix init'ing updater delegates in standard updater controller in nibs

* Convert updaterDelegate/userDriverDelegate properties to ivars

This should allow connecting outlets in IB while disallowing setting them programmatically.
2021-09-19 16:32:43 -07:00
Zorg 1dea970512 Update changelog and documentation (#1956)
* Update author to Sparkle Project when generating documentation

* Sync change log from 1.27.0

* Add recommendation to not call checkForUpdatesInBackground directly

* Add testing documentation for latsUpdateCheckDate

* Fix formatting with user driver header documentation
2021-09-19 08:44:01 -07:00
Zorg 0f53f65241 Fix not being able to show resumed update in utmost focus (#1948)
This fixes a minor bug where canCheckForUpdates returned NO on a user initiated update check that shows an update that was already downloaded / begun installing. Now that it returns YES, the update can be shown in utmost focus by the user again.
2021-09-12 14:57:29 -07:00
Konstantin Zamyakin c60f12ab47 update some russian translates (#1947) 2021-09-11 13:14:38 -07:00
Mayur Pawashe 364e797676 Update cocoa pods badge to use shorter maxAge/cacheSeconds (#1945)
cacheSeconds has superseded maxAge.
2021-09-06 15:22:04 -07:00
Mayur Pawashe bf8216240c Add space 2021-09-06 12:05:37 -07:00
Mayur Pawashe f599a7a1a9 Update readme (#1944) 2021-09-06 12:04:50 -07:00
Vojtěch Koňařík 7096317766 Another localization update. (#1943) 2021-09-06 09:23:05 -07:00
Mayur Pawashe a8840953fe Fix podspec not using .xz (#1942) 2021-09-03 22:58:13 -07:00
Sparkle-Bot 76acd9cb5f Update Package.swift and Sparkle.podspec for version 2.0.0-beta.2 2021-09-04 05:11:08 +00:00
Mayur Pawashe e4b2d96faf Update Sparkle 2 build to beta 2 (#1941) 2021-09-03 22:04:43 -07:00
Mayur Pawashe 9229fc57b1 Add API reference homepage, fix formatting, and improve information (#1940) 2021-09-03 17:24:41 -07:00
Mayur Pawashe c396a53c6f Fix check to only validate XPC display versions in Debug (#1939) 2021-09-03 13:27:25 -07:00
Mayur Pawashe 2a67e2d732 Update podspec to include XPC Services and use https (#1935) 2021-09-03 10:16:37 -07:00
J-rg a135f1a1ee Fix German localization (#1931) 2021-09-03 08:39:28 -07:00
Mayur Pawashe 30361b0128 Use a custom bot personal access token (#1930)
This bot has owner access to the repo and should be able to push changes to protected branches, as long as the workflows are being ran from trusted branches / remotes.

Also extract changelog and use it for the draft.
2021-09-02 23:13:37 -07:00
Mayur Pawashe cce5edd78d Remove installer interaction delegate API / refactor finishing update cycle (#1925) 2021-09-02 23:12:26 -07:00
runner 515b8259bc Update Package.swift and Sparkle.podspec for version 2.0.0-beta.1 2021-08-29 03:37:49 +00:00
Mayur Pawashe edc0fd0e56 Fix issues with GitHub release workflow (#1926) 2021-08-28 18:53:42 -07:00
Mayur Pawashe b4e0dcca6c Bump 2.x project version to 2.0.0-beta.1 (#1924) 2021-08-28 17:27:42 -07:00
Tony Arnold ee679586cf Add a workflow that builds and publishes a release via GitHub Actions (#1908)
The workflow assumes changelog and version information have been updated and the tag has not been created yet before running it. When the workflow finishes, it should take you to a release page with the uploaded binaries, where you can verify the final details and publish a tag officially.

Also the following improvements were made:

* Change CURRENT_PROJECT_VERSION to represent a monotonically increasing bundle version (starting at 2000)
* Add MARKETING_VERSION to represent marketing version of Sparkle, comprised of SPARKLE_VERSION_MAJOR, SPARKLE_VERSION_MINOR, SPARKLE_VERSION_PATCH, and the new SPARKLE_VERSION_SUFFIX for pre-releases.
* Verify code signing signatures of extracted SPM zip file in make release and CI
* Generate changes to Sparkle podspec, just like the Package.swift file, based on current marketing version
* Improve format of Info.plist version strings when appending git hash info, eliminating unnecessary whitespace
* Simplify validating that XPC Service versions align with framework version
* Handle lightweight tags in addition to annotated tags in release-move-tag.sh
2021-08-26 22:42:38 -07:00
Mayur Pawashe c6f1cd4e3c Improve API header docs (#1918)
* Don't expose SPUDownloadData initializer publicly

* Make SUAppcast -init unavailable

* Fix documented default user agent string

* Improve header documentation for SUAppcast(Item) and comparators

* Update more API documentation headers

Also allow returning nil in -allowedSystemProfileKeysForUpdater:

* Clarify documentation on -allowedSystemProfileKeysForUpdater:

* Rename willIdleScheduling -> notSchedule for delegate method

* Make minor correctness fix for reading info URL
2021-08-21 11:24:23 -07:00
Mayur Pawashe 306ea26df8 Don't expose sparkleBundle (#1917) 2021-08-21 11:19:14 -07:00
Mayur Pawashe d719b92636 Remove old DSA generation script (#1922) 2021-08-21 10:01:56 -07:00
Mayur Pawashe b43b188c82 Clear resumable info-only updates when user skips them (#1920) 2021-08-20 21:34:04 -07:00
Mayur Pawashe 6b9981f567 Add generation of API docs (#1915) 2021-08-09 18:27:44 -07:00
Mayur Pawashe 34fcb8784b Support appcast selection features in generate_appcast (#1914)
Add generate_appcast options for appcast selection features

We can now supply for new update items:

* Link
* Channel name
* Last major version / minimum autoupdate version
* Phased rollout interval
* Last critical update version
* Originating informational update versions

We can also specify the maximum number of delta items to generate.

Lastly we can specify which versions to create new items for now. This allows applying flags for only specific versions, or for exceptional cases allows adding old versions that do not meet the most recent updates threshold (maxNewVersionsInFeed) -- think for updates for a prior OS or for a prior major version.

We do not override the minimum system version element on already existing items now, if the element already exists. Apps don't strictly need to specify LSMinimumSystemVersion and this allows users specifying it themselves in the feed.

The help page for generate_appcast was expanded with how the archive directory looks like, how release notes work, that old entries are kept in tact, and how extracted archives are cached..

We now write out the number of new updates written and the number of existing items updated, to make the generated result be less confusing.

Bug fixes:

* The scheme now builds for Debug so I can properly debug generate_appcast from within Xcode (distribution builds are still in Release)
* Newly generated items were appended at the end of the appcast and not necessarily inserted in the correct order (on top). As a workaround when we process existing items, we remove them, and re-add them.
* Fixed an off-by-one error for maximum number of delta files we can generate.

Fixes #1903
2021-08-08 09:07:27 -07:00
Mayur Pawashe 4f7ed347ab Adopt Swift Argument parser for Swift tools (#1913)
Also remove the deprecated usage of passing DSA key as an argument, because it can just be provided as an option (-f)
2021-08-01 08:56:18 -07:00
Zorg 9823892062 Revert modifying Package.swift 2021-07-26 15:58:20 +01:00
Zorg a22562431b Add documentation suggestion if updater fails to start 2021-07-26 15:58:20 +01:00
Zorg 4db96f6c4f Improve error reporting for DSA validation 2021-07-26 15:58:20 +01:00
Zorg 385673ff24 Populate error objects in code signing validation methods 2021-07-26 15:58:20 +01:00
Zorg c3cdbf46cb Don't allow an app to use an invalid EdDSA public key 2021-07-26 15:58:20 +01:00
Zorg 89ab067477 Populate NSError when signature validation or code sign fails 2021-07-26 15:58:20 +01:00
Mayur Pawashe 29a2fa7974 Create valid xar files (#1906)
* Create xar files with valid directory/filename structure

* Don't use file hash for determining if files are equal or not
2021-07-24 09:04:48 -07:00
Mayur PawasheandKornel cb9386a4ea Ignore symlink permissions in binary deltas (#1905)
Co-authored-by: Kornel <kornel@geekhood.net>
2021-07-23 17:42:13 -07:00
Sungbin Jo 119766a650 Fix appcast pubDate tag generation in different locales
Fixes #1900
2021-07-21 15:11:21 +01:00
Mayur Pawashe 9eba644190 Don't expose NSMenuItemValidation programmatically (#1897)
It doesn't make much sense to call this method programmatically due to it checking a specific selector. A client should set the menu item's target/action to the controller/checkForUpdates: action or call SPUUpdater methods directly.
2021-07-19 08:03:37 -07:00
Mayur Pawashe 4a87deeb7f Update changelog for Sparkle 2 (#1896)
* Update changelog for Sparkle 2

* Add more updates about appcast elements/attributes

* Clarify bestValidUpdateInAppcast method is discouraged for some cases

* Re-order changelog bullets

* Use https:// in sample links
2021-07-18 13:08:33 -07:00
Mayur Pawashe a09aad7ca0 Don't ignore -Wcompletion-handler if compiler doesn't understand it (#1894)
* Don't ignore -Wcompletion-handler if compiler doesn't understand it

Older Xcode versions threw a warning at not recognizing this warning.

* Silence WKWebView warning too
2021-07-16 07:54:19 -07:00
Mayur Pawashe 9c360b465b Add log warning for DSA deprecation and link to documentation (#1890) 2021-07-14 00:04:45 -07:00
Mayur Pawashe d9d7e310a5 Pull current date out of appcast filtering and add tests for phased group rollouts (#1889) 2021-07-11 16:47:05 -07:00
Mayur Pawashe 5677ca3f5a Avoid DSA verification if EdDSA verification passes (#1888)
If EdDSA verification passes we don't need to have DSA verification pass, and don't need to require the new update to contain a DSA signature or keys.

Also reject updates if app has EdDSA but no EdDSA signature is provided
2021-07-11 08:59:09 -07:00
Mayur Pawashe 29d4b801fc Reset skipped updates when updates are user initiated and checked (#1887)
Instead of only when a new update is found. This resets skipped updates if the user initiates a new check even if a new update is not found.
2021-07-10 08:52:33 -07:00
Mayur Pawashe 2157f78ffd Provide reason update is not found to updater delegate (#1886) 2021-07-10 08:52:06 -07:00
Mayur Pawashe e5c63b6369 Set $USER and $HOME variables when running guided pkg installers (#1884)
Set $USER and $HOME variables when running guided pkg installers

This allows pre/post install scripts to reference the user's environment correctly. The standard pkg installer GUI preserves these two variables.
2021-07-07 08:31:33 -07:00
Zorg 9f2629c892 Fix false un-initialized warning 2021-07-05 18:20:24 -07:00
Mayur Pawashe b21647bcef Allow delegate to pick no valid items (#1880)
* Allow delegate to pick no valid items

We now allow returning SUAppcastItem.emptyAppcastItem in -bestValidUpdateInAppcast:forUpdater: to indicate no update should be picked.

We preserve returning nil to indicate Sparkle handles the best appcast selection instead.

People have expressed needs for both of these decisions (and deprecated SUUpdater relies on the nil behavior).
2021-07-05 10:01:52 -07:00
Mayur Pawashe ac1bb7036c Make installing major upgrades opt-in (#1881) 2021-07-04 08:58:26 -07:00
Mayur Pawashe eecc4802db Merge pull request #1879 from sparkle-project/channels
Add support for channels
2021-06-28 19:57:58 -07:00
Zorg e0a7304a81 Remove outdated comment 2021-06-27 23:08:50 -07:00
Zorg 78a66c7dda Add channels support to sparkle-cli 2021-06-27 22:40:16 -07:00
Zorg d8f5f58468 Restrict channel names to reasonable set of characters 2021-06-27 22:06:02 -07:00
Zorg e5f1bd5e02 Fix initializing recoveryOption 2021-06-27 22:05:13 -07:00
Zorg c329319b0c Merge branch '2.x' into channels 2021-06-27 15:49:00 -07:00
Mayur Pawashe ad4ec8e3ab Merge pull request #1878 from sparkle-project/sparkle-version-element
Favor sparkle:version and sparkle:shortVersionString elements over enclosure attributes
2021-06-27 15:40:51 -07:00
Zorg 8997bad17e Update error message to lacking version element instead of attribute 2021-06-27 15:19:46 -07:00
Zorg c631a52b48 Re-order where link element is in sample appcast 2021-06-27 15:17:11 -07:00
Zorg dab34b62a0 Merge branch '2.x' into sparkle-version-element 2021-06-27 15:16:12 -07:00
Zorg c968334192 Allow only one channel in appcast feed items 2021-06-27 15:14:37 -07:00
Mayur Pawashe 6639feaafc Merge pull request #1877 from sparkle-project/update-not-found-why
Expose why new update is unavailable
2021-06-27 15:13:49 -07:00
Zorg 29c9b72be6 Refer developers to channels API where appropriate 2021-06-27 01:16:23 -07:00
Zorg 64484507b5 Guard against delegate returning nil channels incorrectly 2021-06-27 00:47:54 -07:00
Zorg bc7e2d4845 Export SUAppcastElementBetaChannel in new exported constants header 2021-06-27 00:40:33 -07:00
Zorg 9bb59b8c00 Add tests for filtering allowed channels and macOS releases 2021-06-27 00:28:09 -07:00
Zorg 267f2b82b1 Do not say no valid update could be found if there were no items
There may not be any applicable items due to sparkle:channels now.
2021-06-26 23:49:45 -07:00
Zorg 5fba1fe046 Add channels support to Sparkle
This allows developers to post updates to specific channels like for beta updates. Updaters only get notifications from channels they're allowed to be on.
2021-06-26 23:18:22 -07:00
Zorg ccd8886bfd Adopt sparkle:version and sparkle:shortVersionString elements
We should recommend using sparkle:version and sparkle:shortVersionString elements inside the appcast item instead of inside the enclosure for consistency.

Delta updates do not need to specify sparkle:version, and can inherit the top level element. This clears up some confusion and reduces duplication (and reduces error proneness / saves me work when testing delta / info-only features).

This is also consistent with informational updates. Regardless whether you want to make an update informational only or not, the sparkle:version stays in the same top-level place.

This is a backwards compatible change. Very old versions of Sparkle (possibly up to a decade or more ago) have supported specifying sparkle:version as a top level item. Winsparkle supports it as well because it's needed for info-only updates.

This is only changing what we recommend / standardize. The attribute variants are still usable.

External tools relying on Sparkle's feed format may have to adapt to this standardization (they have always needed to support info-only updates with a missing enclosure which apps do leverage anyway).

I updated generate_appcast to prefer the element variants and updated the tool so it understands them (this was a bug).
2021-06-26 21:01:39 -07:00
Zorg 1c1b7416ba Add Version History string to localization file 2021-06-26 18:33:00 -07:00
Zorg ed3e331f56 Update SampleAppcast.xml with links to Sparkle's website 2021-06-26 18:21:47 -07:00
Zorg aa867a0cb9 Expose reason why new update is not available to user
When user is on version >= latest appcast feed item, we give them an option to view version history.

When user can't update because of a min/max OS requirement, we give them an option to view product's website.
2021-06-26 18:18:44 -07:00
Zorg 5d27dc6fb3 Expose the reason and latest appcast item when update is not found 2021-06-26 16:06:39 -07:00
Mayur Pawashe fefce16697 Merge pull request #1876 from sparkle-project/refine-standard-updater-controller
Refine standard updater controller
2021-06-26 15:04:27 -07:00
Zorg 28065e7240 Refine SPUStandardUpdaterController API
* Make updater/userDriver properties non-null
* Expose starting the updater and allowing it to be done later instead of at instantiation (so clients in some cases will not need to make their controller declared as an optional)
* Make sender in checkForUpdates: nullable
2021-06-26 12:35:13 -07:00
Zorg d0f43e04d1 Merge branch '2.x' into expose-starting-updater 2021-06-26 11:09:35 -07:00
Mayur Pawashe 746bb1b248 Merge pull request #1862 from sparkle-project/selective-critical
Select critical/informational updates by version & store state in appcast items
2021-06-26 10:51:36 -07:00
Zorg ba5d895e8f Document where to find SPUAppcastItemStateResolver 2021-06-26 10:05:25 -07:00
Zorg 7efa996ba9 Merge branch '2.x' into selective-critical 2021-06-26 10:01:33 -07:00
Mayur Pawashe 2411d7538d Merge pull request #1875 from sparkle-project/fix-analyzer-warnings
Fix analyzer warnings
2021-06-26 09:46:29 -07:00
Zorg 3e1651d1cd Expose starting updater manually on SPUStandardUpdaterController
This allows instantiating SPUStandardUpdaterController right away programmatically, but starting the updater at a later point.
2021-06-26 09:44:41 -07:00
Zorg 4780cfccd5 Reword initializer deprecation messages 2021-06-26 01:36:54 -07:00
Zorg 50df5ed438 Retrieve critical update info even if stateResolver == nil 2021-06-26 01:21:14 -07:00
Zorg 3d8e00eecd Annotate SUAppcastItem initializers as nullable
Also mark -init as unavailable.
2021-06-25 22:26:52 -07:00
Zorg 25e0de5988 Fix analyzer warnings 2021-06-25 22:17:29 -07:00
Zorg 6e3cd6b313 Mark init methods as unavailable 2021-06-21 00:11:06 -07:00
Zorg 31f6f512e1 Export SUAppcastItem designated initializer to PrivateHeaders
Clients can use this header if they need to, but they should first talk to us / explore other avenues.
2021-06-20 23:55:40 -07:00
Zorg 686fd05fce Add tests for informational only updates 2021-06-20 23:11:02 -07:00
Zorg da30373a30 Clarify informationOnlyUpdate description in user driver docs 2021-06-20 23:10:20 -07:00
Zorg 1444561899 Add support for selectively choosing what updates are info-only
Example:
<sparkle:informationalUpdate>
    <sparkle:version>1.5.0</sparkle:version>
    <sparkle:version>1.5.1</sparkle:version>
</sparkle:informationalUpdate>

Means that updating only from versions 1.5.0 and 1.5.1 are shown an informational update (provided there is an info link).

<sparkle:informationalUpdate></sparkle:informationalUpdate>

Means that updating from any version gets an informational update (provided there is an info link).

No presence of this new element falls back to current behavior in Sparkle where an informational update is shown if an enclosure is missing but an info link is provided.
2021-06-20 21:59:05 -07:00
Zorg fb8a0a02c8 Fix typos 2021-06-20 20:42:18 -07:00
Mayur Pawashe 9a3ada03f9 Merge pull request #1872 from sparkle-project/http-headers-releasenotes
Pass http headers and user agent when downloading release notes
2021-06-19 17:28:23 -07:00
Zorg d794a2d803 Merge branch '2.x' into selective-critical 2021-06-18 00:21:53 -07:00
Zorg b1f9bff9a1 Pass http headers and user agent when downloading release notes 2021-06-17 20:29:33 -07:00
Mayur Pawashe c548721e16 Merge pull request #1871 from sparkle-project/restore-removed-initializers
Restore more removed SUAppcastItem initializer methods
2021-06-17 20:13:40 -07:00
Zorg eeb24ed92d Restore more removed SUAppcastItem initializer methods 2021-06-17 19:50:37 -07:00
Mayur Pawashe 66de9697f3 Merge pull request #1868 from sparkle-project/xcode13
Upgrade and fix Xcode 13 warnings
2021-06-17 00:39:31 -07:00
Mayur Pawashe cb1e58e309 Merge pull request #1870 from tonyarnold/restore-suappcastitem-public-init
Restore public initializer for SUAppcastItem
2021-06-17 00:37:04 -07:00
Tony Arnold 24a0485e98 Restore public initializer for SUAppcastItem
Closes #1869
2021-06-16 09:56:19 +10:00
Zorg 29e7ad4495 Merge branch '2.x' into selective-critical 2021-06-12 22:33:21 -07:00
Zorg 961605c6d6 Upgrade macOS and Xcode versions for CI 2021-06-11 22:50:32 -07:00
Zorg 2b8d2a2be7 Set SDKROOT to macosx instead of nothing 2021-06-11 22:42:52 -07:00
Zorg dfdd6ac978 Update last upgrade version of project files 2021-06-11 22:40:57 -07:00
Zorg 52f3337eda Enable parallelizing building of targets
Not doing this is deprecated in Xcode 13.
2021-06-11 22:35:41 -07:00
Zorg defa8e4332 Add Sparkle.framework as dependency to Distribution 2021-06-11 22:34:55 -07:00
Zorg 3636e22cc5 Fix sparkle-cli not linking/embedding Sparkle.framework 2021-06-11 22:26:28 -07:00
Zorg 50ba774bbe Fix -Wcompletion-handler warnings 2021-06-11 22:25:14 -07:00
Mayur Pawashe 432f10f804 Merge pull request #1867 from danielpunkass/xcode13-fix-cgimage
Fix the build with Xcode 13 by explcitly importing ImageIO
2021-06-11 18:49:08 -07:00
Daniel Jalkut 232ce2543e Fix the build with Xcode 13 by explcitly importing ImageIO. Previously it was being implicitly imported along with Foundation. 2021-06-09 14:04:26 -04:00
Mayur Pawashe efe1c8c02e Merge pull request #1866 from sparkle-project/configuration-cleanup
Configuration cleanup
2021-06-07 19:25:23 -07:00
Zorg 1697c7966c Fix unit tests from not building 2021-06-06 20:26:03 -07:00
Zorg 5203518fbd Remove allowing downgrades
Downgrades hasn't worked properly with choosing the best appcast selection in a long long time.
2021-06-06 19:40:58 -07:00
Zorg 9fd2e72913 Fix missing implementation method in sparkle-cli 2021-06-06 19:38:00 -07:00
Zorg ff83896e01 Set app category for InstallerProgress agent tool 2021-06-06 19:36:56 -07:00
Zorg 89ecb88f2b Define DEBUG=0 for release builds 2021-06-06 19:35:15 -07:00
Zorg 4825ac5d62 Remove outdated comments 2021-06-06 19:31:30 -07:00
Zorg e2723717f1 Don't link to AppKit and WebKit explicitly 2021-06-06 19:26:49 -07:00
Zorg b6956a480d Don't include WebKit implementation when not building UI bits 2021-06-06 19:26:25 -07:00
Zorg 7f87d8842e Add missing appkit prevention includes 2021-06-06 19:16:51 -07:00
Zorg cbd1503c06 Add configuration option to not build UI bits 2021-06-06 19:09:19 -07:00
Zorg eda1b4bdaa Remove SparkleCore target and use <> imports
In some cases for shared headers in downloader XPC Service or generate_appcast / sign_update tools, I had to do a little dance for using double quote imports.
2021-06-06 18:38:49 -07:00
Zorg 7861cea66c Merge branch '2.x' into selective-critical 2021-06-01 23:35:03 -07:00
Mayur Pawashe c0691c4606 Merge pull request #1865 from sparkle-project/disable-automatic-downloads-manual-checks
Don't allow setting/toggling automatic updates in update alert when update checks are disabled
2021-06-01 23:33:20 -07:00
Zorg 0063fbda17 Don't allow setting automatic updates when update checks are disabled 2021-06-01 10:19:44 -07:00
Zorg d468757ee1 Revert some unnecessary changes I made 2021-05-31 12:51:09 -07:00
Zorg 1013b2506a Remove #warning 2021-05-31 12:17:43 -07:00
Zorg 1aadf1b351 Remove passing around preventsAutoupdate flag
Also improve user driver documentation slightly.
2021-05-31 11:57:33 -07:00
Zorg 5287453cfd Use dot-syntax naming 2021-05-31 11:41:30 -07:00
Zorg 88f678ebe6 Remove SPUUserUpdateStageInformational 2021-05-31 11:24:32 -07:00
Zorg ee5e98d3dd Rename SPUUpdateState back to SPUUserUpdateState 2021-05-31 11:13:05 -07:00
Zorg 062bfaaa97 Remove old code passing min/max OS tests 2021-05-31 10:59:35 -07:00
Zorg f51bb996e6 Remove critical and major upgrade properties from SPUUpdateState 2021-05-31 10:22:55 -07:00
Zorg 8fb44df0b7 Add unit tests for critical updates 2021-05-31 10:16:04 -07:00
Zorg 8f488c6ffd Fix unit tests 2021-05-31 09:58:09 -07:00
Zorg 63e0b47c98 Don't expose appcast item state publicly 2021-05-31 09:32:00 -07:00
Zorg fabf415999 Resolve appcast item properties from external environment at init 2021-05-31 09:27:21 -07:00
Zorg 0e264dae2f Add comments on critical testing functions 2021-05-31 00:20:11 -07:00
Zorg 60bbb373e2 Add comments on legacy critical update path 2021-05-31 00:17:08 -07:00
Zorg 1cc11d76a2 Fix SPUUpdateState reference 2021-05-31 00:14:55 -07:00
Zorg 90bdd84832 Move SPUUserUpdateChoice into its own header 2021-05-31 00:13:07 -07:00
Zorg b7f9b76dd9 Rename SPUUserUpdateState -> SPUUpdateState 2021-05-31 00:00:38 -07:00
Zorg 253f45b476 Add optional version field to sparkle:criticalUpdate element
This version indicates the version that was first marked critical. So versions below this specified version will treat the update as critical while versions >= the specified version will not.

Also move sparkle:criticalUpdate to root level element instead of it being a tag. The tagged version is now deprecated and doesn't support the version field.
2021-05-30 23:37:38 -07:00
Mayur Pawashe 433e1bf3de Merge pull request #1860 from 1024jp/localizeJa
Add missing Japanese localization strings
2021-05-30 10:08:44 -07:00
Mayur Pawashe bbdebfdbee Merge pull request #1858 from sparkle-project/warnings
Fix all Interface Builder and compiler warnings and require macOS 10.11 (El Capitan)
2021-05-30 09:46:10 -07:00
1024jp 8a62dc06fe Add missing Japanese localization strings
that were added in #1853.
2021-05-30 16:51:23 +09:00
Mayur Pawashe d7c504a254 Merge pull request #1853 from sparkle-project/skip-major-updates
Skip minor updates separately from major upgrades
2021-05-29 23:19:28 -07:00
Zorg 87a4e349ce Remove more legacy pre 10.11 checks 2021-05-29 22:53:25 -07:00
Zorg 549a8ce117 Re-annotate sender as unused 2021-05-29 22:46:51 -07:00
Zorg 91fc440d15 Animate resizing the window when disclosing more info 2021-05-29 14:49:28 -07:00
Zorg 79cd07fc70 Use alerts instead of notifications 2021-05-29 07:52:50 -07:00
Zorg 0cdb0976ef Don't hide skipping button for major upgrades if update is critical 2021-05-29 07:50:30 -07:00
Zorg e0a414909c Re-word skip upgrade title confirmation 2021-05-28 23:56:04 -07:00
Zorg 8e466eecc8 Fix unit tests for skipped updates 2021-05-28 23:28:44 -07:00
Zorg 17eb15e9d3 Simplify skipping major updates
We now only track one major version to skip and one minor version to skip, instead of an array of potentially growing minor/major versions.
2021-05-28 23:11:13 -07:00
Zorg 7d3c7ae78a Add alert confirmation for skipping major upgrades 2021-05-28 17:23:31 -07:00
Zorg a630614dc4 Use "update" still instead of "upgrade" for major updates 2021-05-27 22:26:23 -07:00
Zorg 87ecba77d3 Set LSMinimumSystemVersion for the test app 2021-05-27 21:50:30 -07:00
Zorg 455e63cc59 Remove hard coded 10.11 deployment targets 2021-05-27 21:50:16 -07:00
Zorg 57b39fc1e5 Update and remove 10.9 and 10.10 references 2021-05-27 21:39:24 -07:00
Zorg b2127da6f5 Add missing trailing constraint to Release Notes label 2021-05-27 16:37:44 -07:00
Zorg 8fc1689c26 Remove hidden shouldAskAboutProfile button binding 2021-05-27 16:28:41 -07:00
Zorg 898ac7253a Set code sign identity to adhoc across the project 2021-05-24 01:04:33 -07:00
Zorg f8ef9608dc Fix warning from using -stringByAddingPercentEscapesUsingEncoding: 2021-05-24 00:41:46 -07:00
Zorg d22ef79d9e Remove unused outlets 2021-05-16 15:45:06 -07:00
Zorg 8af1d18764 Update localization files 2021-05-16 15:42:05 -07:00
Zorg a7e090e3ca Revert "Start to move permission prompt localizations away from xib"
This reverts commit e607bf19dc.
2021-05-16 15:35:49 -07:00
Zorg e607bf19dc Start to move permission prompt localizations away from xib 2021-05-16 12:39:22 -07:00
Zorg 7490a91406 Re-adjust leading constraint for anonymous info button 2021-05-16 10:18:27 -07:00
Zorg 9ee2a525d0 Decrease distance between response buttons info view 2021-05-16 10:14:42 -07:00
Zorg 54caf47602 Set leading constraint of more info description to be bit higher 2021-05-16 10:06:56 -07:00
Zorg ed87bcdab6 Use NSStackView for permission prompt window 2021-05-16 10:01:48 -07:00
Zorg ef577fe0c0 Make subview for anonymous system info button 2021-05-15 21:54:06 -07:00
Zorg 7c8defb75e Create separate subviews for permission prompt 2021-05-15 21:41:19 -07:00
Zorg f6d8b506ae Align disclosure button with include anonymous info text 2021-05-15 14:21:17 -07:00
Zorg 3306ccd994 Suppress deprecation warnings for SMJobSubmit functions 2021-05-15 11:58:01 -07:00
Zorg 07aca30e11 Bump deployment target to 10.11 2021-05-15 11:53:08 -07:00
Zorg be75bb38f6 Add auto layout constraints to update permission prompt 2021-05-14 22:52:20 -07:00
Zorg debab803c9 Add auto-layout constraints to status window 2021-05-14 22:28:38 -07:00
Zorg 8dc4e78cb2 Remove unused installationPath variable from normalization changes 2021-05-14 22:09:41 -07:00
Zorg e91ae897e7 Add method to compare two minimum autoupdate versions 2021-05-14 18:28:32 -07:00
Mayur Pawashe 91e71c219c Merge pull request #1854 from sparkle-project/xpc-sha
Validate XPC Service versions
2021-05-10 19:11:57 -07:00
Zorg f56e923043 Validate XPC Services versions in startUpdater: 2021-05-10 01:02:27 -07:00
Zorg 50bec90279 Set fetch-depth to 0 in GitHub Actions CI 2021-05-10 00:26:57 -07:00
Zorg 1f9d76bc13 Retitle install button to "Install Upgrade" for major updates 2021-05-09 23:16:01 -07:00
Zorg 59fbd37bb1 Re-title skip button when update is a major one 2021-05-09 23:03:05 -07:00
Zorg f671b82e50 Test against SPUUserUpdateStageInformational 2021-05-09 22:53:58 -07:00
Zorg 1565db3fec Add secure coding to SPUUserUpdateState 2021-05-09 22:51:50 -07:00
Zorg 25b3d01efa Rename majorUpdate to majorUpgrade 2021-05-09 22:45:40 -07:00
Zorg d193f2e28b Pass majorUpdate information to user driver
We unify the user driver method showing the update to take a generic state object now. The current fields of the state object are its current stage, if it's user initiated, and if the update is a major one.

We also remove deprecated code paths that were complex to support and will otherwise generate in compile errors if people adopt the new API.
2021-05-09 22:42:42 -07:00
Zorg a79f6b2a85 Add documentation to SPUSkippedUpdate 2021-05-09 20:48:32 -07:00
Zorg 0ee12d881d Add and fix unit tests for skipping updates 2021-05-09 19:53:19 -07:00
Zorg 6d6cc2d052 Add support for skipping major and minor updates separately 2021-05-09 19:30:44 -07:00
Mayur Pawashe 039adc1ef2 Merge pull request #1850 from sparkle-project/better-appcast-selection
Better appcast selection
2021-05-03 19:02:20 -07:00
Zorg 62695379d9 Clarify what versions not to filter for 2021-05-02 23:15:01 -07:00
Zorg f82f9eb878 Fix typo 2021-05-02 23:13:58 -07:00
Zorg a1aef4eca0 Fix string localization 2021-05-02 23:12:48 -07:00
Zorg 3d2dc8a7f6 Update documentation for -bestValidUpdateInAppcast:forUpdater:
This method will not be invoked for appcast with zero items. Clients must pick best item and cannot pick "no items."
2021-05-02 23:09:45 -07:00
Zorg 5a3b71b96a Add note about not returning a delta update item in delegate 2021-05-02 22:38:27 -07:00
Zorg 3c9508bd2a Add tests for testing minimum autoupdate version 2021-05-02 22:32:50 -07:00
Zorg 79c1141155 Refactor finding latest appcast item 2021-05-02 21:44:35 -07:00
Zorg ebb822af43 Merge branch '2.x' into better-appcast-selection 2021-05-02 16:06:45 -07:00
Zorg c882da7bc7 Update documentation for -bestValidUpdateInAppcast 2021-05-02 16:06:22 -07:00
Zorg f1be9f72d5 Remove passing includesSkippedUpdates in favor of background flag 2021-05-02 15:59:43 -07:00
Zorg e7441351d7 Make improvements to best appcast selection
* Prefer using the latest update that passes minimumAutoupdateVersion

When an update is not found:
* Find latest appcast item that may fail min/max OS
* Report that user cannot install an update due to unsupported OS
2021-05-02 15:50:03 -07:00
Mayur Pawashe 3cafb688b7 Merge pull request #1849 from sparkle-project/appcast-item-nullability
Add nullability annotations to SUAppcastItem
2021-05-02 13:49:27 -07:00
Zorg d84a79cfc2 Merge branch '2.x' into appcast-item-nullability 2021-05-02 11:29:39 -07:00
Zorg c33ccd5921 Merge branch '2.x' into appcast-item-nullability 2021-05-02 11:17:42 -07:00
Zorg 6ad996338d Add nullability annotations to SUAppcastItem 2021-05-02 10:00:56 -07:00
Mayur Pawashe 46f7898d36 Merge pull request #1844 from sparkle-project/download-driver-appcast
Re-use download driver for downloading appcast & release notes
2021-05-02 09:03:20 -07:00
Mayur Pawashe 85ac073e6d Merge pull request #1846 from sparkle-project/enforce-session-in-progress
Enforce the updater session is in progress
2021-05-02 09:03:04 -07:00
Mayur Pawashe 7c46e8db3e Merge pull request #1848 from sparkle-project/skip-installing-update
Allow skipping/canceling of an update that is currently installing
2021-05-02 09:02:08 -07:00
Zorg fbe48e5738 Allow skipping/canceling of an update that is currently installing 2021-05-01 19:53:01 -07:00
Mayur Pawashe b140c05bad Merge pull request #1843 from sparkle-project/nsunavailable
Add NS_UNAVAILABLE attributes to user driver classes
2021-05-01 17:26:15 -07:00
Mayur Pawashe c79785aad4 Merge pull request #1845 from sparkle-project/version-dash-separator
Port #1504 (dash separators in version strings) to 2.x
2021-05-01 17:25:53 -07:00
Mayur Pawashe 5da8199818 Merge pull request #1847 from sparkle-project/sandbox-errors
Log more sandbox errors
2021-05-01 17:25:35 -07:00
Zorg 79a6bb1318 Disable unused debugging options in test app scheme 2021-05-01 14:48:31 -07:00
Zorg 9b8756d824 Add sandbox log if connection to installer fails 2021-05-01 14:46:34 -07:00
Zorg 712753d812 Add log linking to sandboxed steps if app isn't sandboxed at all 2021-05-01 14:36:45 -07:00
Zorg e8d5c8024c Log error if developer sandboxes installer launcher service 2021-05-01 14:30:21 -07:00
Zorg af245bfe62 Enforce the updater session is in progress
We should enforce update session is in progress before checking for new updates. I've tested checking for updates regularly, in background, and informational updates.

An update check could have been made while the permission request was in flight, which we don't want to happen.
2021-05-01 11:08:18 -07:00
Zorg 9a12dbf62a Port #1504 (dash separators in version strings) to 2.x
On second thought I realized we can support this without doing any date comparison because the code just picks the first item if two are equal.
2021-05-01 10:48:53 -07:00
Zorg 477d0a243f Fix unit tests 2021-04-30 22:21:19 -07:00
Zorg ab294d607d Hide private SUAppcast / SUAppcastItem APIs 2021-04-30 21:40:47 -07:00
Zorg 26c63c1a7b Remove commented out code 2021-04-30 21:28:56 -07:00
Zorg 6adb0c3017 Use download driver for downloading release notes 2021-04-30 21:10:41 -07:00
Zorg 7cb72238fa Use download driver for downloading appcast 2021-04-30 20:37:00 -07:00
Zorg 0eb5a706f8 Add NS_UNAVAILABLE attributes to user driver classes 2021-04-30 18:03:22 -07:00
Mayur Pawashe e179443799 Merge pull request #1836 from jaroslavas/feature/sign-update-file
Add private_key parameter in sign_update
2021-04-26 20:11:57 -07:00
Jaroslav Ozevič c00946ee20 Fixed error message in case sign_update can't find the key in the keychain 2021-04-26 10:07:38 +03:00
Jaroslav Ozevič 12a3da9629 Update sign_update to accept -f <private_key_file> or -s <private_key> parameters 2021-04-26 09:49:50 +03:00
Mayur Pawashe 84cdb0c7e8 Merge pull request #1838 from sparkle-project/fix-delta-updates
Fix delta updates edge cases
2021-04-25 21:39:53 -07:00
Mayur Pawashe 478cc98b90 Merge pull request #1839 from sparkle-project/remove-auth-promt-localization
Remove localizing authorization prompt
2021-04-25 20:26:56 -07:00
Mayur Pawashe bf35926cf3 Merge pull request #1840 from sparkle-project/fix-test-app-responder
Test App: Allow check for updates menu item to be invoked outside of settings
2021-04-25 20:26:15 -07:00
Kornel 8034404cc7 Merge pull request #1835 from 1024jp/localizeJa
Add missing Japanese localization strings
2021-04-26 02:54:37 +01:00
Zorg 411360deb2 Allow check for updates menu item to be invoked outside of settings
Previously check for updates was only in responder chain of the settings window controller. Now it's in responder chain of the entire application.
2021-04-25 15:48:20 -07:00
Zorg d91223a5b6 Remove localizing authorization prompt
The message string gets cached and I don't think this is the proper way to localize the auth dialog (which I think has some other mechanism). So I am removing localization here for now until this can possibly be done properly.
2021-04-25 14:46:42 -07:00
Zorg 063974c553 Simplify logic in -preferredUpdateForRegularAppcastItem method 2021-04-25 14:28:33 -07:00
Mayur Pawashe 97f15943e4 Merge pull request #1837 from sparkle-project/cleanup-download
Clean up downloads better
2021-04-25 14:22:56 -07:00
Zorg 564f0c316a Refactor retrieving regular & delta update items 2021-04-25 13:57:09 -07:00
Zorg 50942909f2 Add comment indicating why we don't pass full downloaded path 2021-04-25 12:24:34 -07:00
Zorg 71557fac85 Include secondary non-delta update to resumable updates 2021-04-25 12:15:44 -07:00
Zorg e51eb32403 Fix bestValidUpdateInAppcast: not handling delta updates correctly
All the top level appcast items are non-delta items. The client needs to give us back a non-delta update item. We then fetch the appropriate delta item ourselves.
2021-04-24 21:42:33 -07:00
Zorg 6d0d1a7aa8 Add comment about clearing download after beginning installation 2021-04-24 19:40:54 -07:00
Zorg c44c164aff Clean up empty / temporary progress agent tool directory immediately 2021-04-24 19:29:10 -07:00
Zorg 1244612946 Clear download from installer when extraction fails
One example of extraction failing is the delta update failing to apply.
2021-04-24 19:11:36 -07:00
Zorg 842d258330 Clean up download directory upon skipping already downloaded update 2021-04-24 19:00:06 -07:00
Jaroslav Ozevič ef7c16bb9d Add private_key parameter in sign_update 2021-04-23 15:09:30 +03:00
1024jp f56f937ad2 Add missing Japanese localization strings
that were added in #1833.
2021-04-21 09:14:07 +09:00
Mayur Pawashe 02b85635c7 Merge pull request #1833 from sparkle-project/missing-localizations
Update missing localizations strings
2021-04-18 19:32:25 -07:00
Zorg ce70a30be5 Don't localize rare/unlikely/specific scenario error strings 2021-04-18 19:00:58 -07:00
Zorg e8f41640dc Comment which localizations are rare/unlikely 2021-04-18 18:54:05 -07:00
Mayur Pawashe 7247803fea Merge pull request #1831 from sparkle-project/deprecate-dismiss-check
Deprecate -dismissUserInitiatedUpdateCheck user driver method
2021-04-18 18:29:39 -07:00
Mayur Pawashe fe8b6b3e2a Merge pull request #1827 from sparkle-project/show-update-focus
Show the present update in focus when checkForUpdates is invoked
2021-04-18 18:29:11 -07:00
Mayur Pawashe f0ff2e3ef0 Merge pull request #1832 from sparkle-project/update-auth-prompt
Update authorization prompt when updating an app
2021-04-18 18:22:30 -07:00
Zorg c7ff8f4bb0 Add Install on Quit localizations from automatic alert from 1.x 2021-04-18 12:11:46 -07:00
Zorg 669c369ce7 Add missing localization strings to Sparkle.strings 2021-04-18 12:06:34 -07:00
Zorg db6ef214ab Update authorization prompt when updating an app
We have a slightly different prompt for an app updating itself vs an app/tool updating another app. Also put prompt in the localization strings.
2021-04-18 11:44:30 -07:00
Zorg ba11897345 Deprecate -dismissUserInitiatedUpdateCheck user driver method
We don't have a dismiss method for every transition state and we don't want to. This should be up to the UI to determine how to transition from one UI state to another UI state.
2021-04-17 22:21:22 -07:00
Zorg cc4c02f467 Add showUpdateInFocus implementation to Test App user driver 2021-04-17 16:36:28 -07:00
Zorg f58cc9e9b5 Merge branch '2.x' into show-update-focus 2021-04-17 16:25:36 -07:00
Mayur Pawashe 8f3e340e47 Merge pull request #1829 from sparkle-project/merge-show-update-methods
Merge show update methods
2021-04-17 16:23:53 -07:00
Mayur Pawashe 547fde293d Merge pull request #1830 from sparkle-project/enforce-only-owner
Don't bring up authorization just because group ID doesn't match
2021-04-17 16:09:40 -07:00
Zorg 302f3f41a3 Clear downloaded update upon skipping
I had this line of code before in the legacy path but forgot to use it.
2021-04-17 16:07:18 -07:00
Zorg af9935540a Don't bring up authorization just because group ID doesn't match 2021-04-17 13:47:00 -07:00
Zorg 188a893174 Rename new state back to not downloaded 2021-04-16 19:07:48 -07:00
Zorg 3309abf936 Remove DEBUG conditional check around deprecated methods 2021-04-16 16:55:48 -07:00
Zorg 1abe5f70db Add comment for legacy path 2021-04-16 16:47:22 -07:00
Zorg ab9ffdb901 Rename SPUUserUpdateStateNotDownloaded to SPUUserUpdateStateNew
Update documentation too.

Fix test app trying to make installable update skippable.
2021-04-16 16:40:33 -07:00
Zorg e64253be0b Merge showUpdateFount: methods into single one
Handling the different variations with different completion blocks is a pain when ultimately clients want to display a mostly unified user interface.
2021-04-16 16:34:01 -07:00
Zorg 8ff356bc7d Update documentation on checkForUpdates 2021-04-16 12:16:34 -07:00
Zorg 3593157e3d Merge branch '2.x' into show-update-focus 2021-04-16 12:04:05 -07:00
Mayur Pawashe 2d0b9ae356 Merge pull request #1826 from 1024jp/localizeJa
Add missing Japanese localization strings
2021-04-16 12:02:25 -07:00
Zorg d9e0265d76 Show the present update during updater progress too
This includes updater permission request, downloading updates, downloading appcast, installing update, and so on.
2021-04-16 11:32:00 -07:00
1024jp 5ff2d7765e Add missing Japanese localization strings
that added in #1819.
2021-04-17 00:02:51 +09:00
Zorg 6b3d2af21a Simplify UI driver storing showingUpdate state 2021-04-16 00:01:37 -07:00
Zorg 2f783e01f0 Show the present update in focus when checkForUpdates is invoked
When the update is shown to the user, the menu item for checking for updates is no longer disabled. Instead it is enabled, and when invoked, will bring the update to utmost focus back to the user again.

This is consistent with other options (eg Preferences...) that bring up windows. Improved user experience here is that updates are now less "lost".

We (re)define properties on SPUUpdater:

canCheckForUpdates - to mean that the user can check for updates (start a new update check or show the already present update frontmost)

sessionInProgress - to mean if Sparkle's internal driver / scheduler is running (i.e, downloading appcast or update, showing update, starting installation).
2021-04-15 22:56:41 -07:00
Mayur Pawashe 40545494f2 Merge pull request #1819 from sparkle-project/user-driver-relaunch
Show alert that non-relaunched application was installed
2021-04-15 20:02:59 -07:00
Zorg b0d9a75f98 Add new installed update localizations to Sparkle.strings 2021-04-15 19:36:14 -07:00
Zorg ed89783a0e Merge branch '2.x' into user-driver-relaunch 2021-04-13 00:05:39 -07:00
Mayur Pawashe cb17e08b92 Merge pull request #1823 from sparkle-project/entitlements
Entitlement scripts/configuration updates
2021-04-12 19:20:46 -07:00
Mayur Pawashe 286af16842 Merge pull request #1821 from sparkle-project/api-updater-doc
Update API documentation for instantiating/using updater
2021-04-12 19:20:20 -07:00
Mayur Pawashe a084e2f09d Merge pull request #1822 from sparkle-project/sample-appcast-edSignature
Update SampleAppcast.xml to use edSignatures
2021-04-12 19:19:47 -07:00
Mayur Pawashe 9524b32024 Merge pull request #1820 from sparkle-project/simplify-user-driver
Simplify user driver
2021-04-12 19:19:27 -07:00
Zorg cb10bb8046 Remove SPUUserDriverCoreComponent usage completely 2021-04-11 23:31:04 -07:00
Zorg 2d9bf07b18 Add new user driver methods to cancel update checks / downloads
Remove SPUUserDriverCoreComponent dependency from sparkle-cli and the Test App too, which really wasn't helping at all.
2021-04-11 23:15:02 -07:00
Zorg eea87561ab Update XPC Service signing script
Add entitlements to InstallerConnection and InstallerStatus services and add option to specify bundle id in the now renamed codesign_xpc_service.py script.
2021-04-11 21:52:09 -07:00
Zorg e7bc17b192 Use $(PRODUCT_BUNDLE_IDENTIFIER) for defaults exception for test app 2021-04-11 20:19:33 -07:00
Zorg 07e96961bf Sign altered app in release too for the test app 2021-04-11 20:04:53 -07:00
Zorg 895bb71fae Add InstallerStatus and InstallerConnection services to Distribution 2021-04-11 20:03:59 -07:00
Zorg 372d711d20 Remove ATS allow-exception scripts for debug / test app 2021-04-11 19:43:12 -07:00
Zorg 5408ab10c1 Remove lesser used XPC Services for Test App
Testing WebKit2 is more important than testing sandboxed downloader service.
More people should be adding entitlements to their app for connection services, so we will do that in the test app too.
2021-04-11 19:28:46 -07:00
Zorg 3ea863d82b Remove incorrect note about when relaunch happens
User driver can also request to not relaunch the app and this is worded oddly.
2021-04-11 19:01:27 -07:00
Zorg bd1769e82e Update SampleAppcast.xml to use edSignatures 2021-04-11 15:17:53 -07:00
Zorg 0b634f4d76 Update API documentation for instantiating/using updater 2021-04-11 15:00:43 -07:00
Zorg 9052ea912d Ensure permission request response is handled on main thread
We were doing this before but I accidentally removed it in a recent commit.
2021-04-11 14:43:52 -07:00
Zorg 833eb89bb5 Simplify user driver API
Deprecate the "done" statuses for user initiated update checks and downloading updates because they really did nothing but burden implementor (there was a relic of an XPC reason back in the day that no longer applies).
2021-04-11 14:41:07 -07:00
Zorg e909c0d988 Show alert that non-relaunched application was installed
This only applies when the updater outlives the application it is updating and the application is not relaunched (i.e, an external/remote updater).
2021-04-11 14:01:03 -07:00
Mayur Pawashe 1f90f7c993 Merge pull request #1818 from sparkle-project/update-cycle-2
Defer requiring feed URL until checking for updates
2021-04-11 13:12:11 -07:00
Zorg 6db6a9892a Defer requiring feed URL until checking for updates
Also don't automatically reset update cycle if updater hasn't been started yet.
2021-04-10 15:18:13 -07:00
Mayur Pawashe e20f099c90 Merge pull request #1815 from sparkle-project/fix-interactive
Fix interactive flag being ignored in sparkle-cli
2021-04-05 19:05:59 -07:00
Zorg 9b6e7ba828 Fix interactive flag being ignored in sparkle-cli 2021-04-04 16:57:37 -07:00
Mayur Pawashe 8c53b1d3ec Merge pull request #1812 from sparkle-project/system-domain
Pass whether or not system domain is being used back to framework
2021-04-04 16:37:37 -07:00
Mayur Pawashe faf047c4ea Merge pull request #1813 from sparkle-project/service-length
Increase max mach service name length to 127 characters
2021-04-04 16:36:08 -07:00
Zorg 71a36f8be4 Add comments on message type tags 2021-04-04 14:06:27 -07:00
Zorg ebc48cee5c Increase max mach service name length to 127 characters 2021-04-03 22:43:01 -07:00
Zorg 467ffb15ca Pass whether or not system domain is being used back to framework
This avoids needing to do a file system check in InstallerConnection to determine if we need to connect to the system or user domain.
2021-04-03 17:16:38 -07:00
Mayur Pawashe a79aa1690b Merge pull request #1810 from sparkle-project/permission-prompt-no-modal
Don't make permission prompt a modal window
2021-03-29 19:12:41 -07:00
Mayur Pawashe e1fdd5a6c4 Merge pull request #1809 from sparkle-project/update-cycle
Universally start update cycle one runloop cycle later
2021-03-29 19:12:27 -07:00
Mayur Pawashe a108d4bc72 Merge pull request #1811 from sparkle-project/relaunch-host
Provide option to open host bundle path instead of app path
2021-03-29 19:08:21 -07:00
Zorg 5a0529a2cd Provide option to open host bundle path instead of app path
This is useful for plug-ins that may want Sparkle to open eg a .prefpane or .saver instead of re-launching System Preferences (which is the app used to wait for termination; normally we only relaunch an app that was proven to be alive).

In a plug-in world, it may not be possible to tell which is more desirable so we provide both options. In 1.x, there was a delegate -pathToRelaunchForUpdater: method to pick between these, however in 2.x for hardening sake, there isn't an API to open any arbitrary bundle path so we provide explicit options.
2021-03-28 23:39:10 -07:00
Zorg 3a201a45ac Don't make permission prompt a modal window
This can block the rest of the UI from being loaded on an app that is just starting. I saw this myself in a pref pane plugin.
2021-03-28 17:35:32 -07:00
Zorg 93b8700060 Add self.driver != nil assert 2021-03-28 17:10:10 -07:00
Zorg 2614af86ff Don't defer some of sparkle-cli delegate callbacks 2021-03-28 16:35:21 -07:00
Zorg 5ae944778a Set canCheckForUpdates to NO before probing install status 2021-03-28 16:25:05 -07:00
Zorg f2986ef090 Start updater one runloop cycle later
And remove logic in SPUStandardUpdaterController and SUUpdater that defers starting the updater one cycle later, because that logic is now in SPUUpdater which they invoke.

It is too easy to start the updater "too soon" (if not using SPUStandardUpdaterController or SUUpdater) and I had some weird approach before that allowed the developer to check for updates before starting the updater and it would get deferred until the updater was started (without showing a permission prompt). Instead, defer the update cycle check allowing developer to check for updates immediately after starting the updater if needed (sparkle-cli needs to do this in one case).

Errors are now logged when checking for updates without having started the updater.

This fixes edge cases of UI being shown too early.
2021-03-28 13:21:20 -07:00
Mayur Pawashe 923bb96eda Merge pull request #1802 from sparkle-project/features
Add quicker & more reliable updating to features
2021-03-28 12:47:44 -07:00
Mayur Pawashe 2af01e8844 Merge pull request #1808 from sparkle-project/normalization
Compute app path normalization in progress agent
2021-03-28 10:51:10 -07:00
Zorg 414c8affc5 Compute app path normalization in progress agent
Compute path instead of having installer pass over arbitrary path to agent.
2021-03-27 22:17:25 -07:00
Zorg 90aa98b68c Update changelog 2021-03-25 23:24:18 -07:00
Zorg 7e8084b064 Update readme / changelog 2021-03-23 19:37:20 -07:00
Mayur Pawashe 25001d83ee Merge pull request #1803 from sparkle-project/preventAccidentalInstalls-2.x
Disable keyboard shortcut for active not-initiated scheduled checks
2021-03-23 19:22:32 -07:00
Mayur Pawashe 78b0570a76 Merge pull request #1804 from sparkle-project/no-hide-on-deactivate
Don't hide standard updater window on deactivation
2021-03-23 19:22:20 -07:00
Zorg 9555cb7397 Fix UI tests from not making update alert hide on deactivation 2021-03-22 23:05:02 -07:00
Zorg 78ec0f46b7 Disable keyboard shortcut for active not-initiated scheduled checks
This ports #1036 over to 2.x. Looks like I forgot to port half of it.
2021-03-22 16:17:07 -07:00
Zorg f95bf0c7d5 Don't hide standard updater window on deactivation
Sometimes when the app is re-activated, the window is ordered back behind other applications. Also it may be useful to eg read the release notes when browsing another application. We still preserve the logic that defers showing the update alert when the application isn't initially frontmost.
2021-03-22 15:48:47 -07:00
Zorg cf14d09ee0 Update CHANGELOG 2021-03-22 01:36:31 -07:00
Zorg 90448fd564 Add quicker & more reliable updating to features 2021-03-22 01:14:20 -07:00
Mayur Pawashe 0a4846a186 Merge pull request #1801 from sparkle-project/atomic-swap
Update and replace bundle directories even more atomically on apfs
2021-03-21 18:54:36 -07:00
Zorg b3e7a03660 Update and replace bundle directories even more atomically on apfs
With these changes, it should not be possible for neither an old or new bundle to be at the destination.

We also perform temporary directory cleanup after final installation stage is and relaunching an app is performed because we can save some time (150 ms+ in one of my cases).
2021-03-21 17:54:51 -07:00
Mayur Pawashe 83aac00fe6 Merge pull request #1800 from sparkle-project/log-nserror
Add and use function to log NSError objects recursively
2021-03-19 13:50:14 -07:00
Zorg 89b7fef457 Add and use function to log NSError objects recursively 2021-03-19 12:35:22 -07:00
Mayur Pawashe 5fbf119e6a Merge pull request #1799 from sparkle-project/graceful-change-owner-group-failure
Don't make changing owner/group a hard fatal error
2021-03-19 11:18:39 -07:00
Zorg 2e8fc4d17a Don't make changing owner/group a hard fatal error 2021-03-19 10:28:59 -07:00
Mayur Pawashe 454e6d2f13 Merge pull request #1798 from sparkle-project/disable-hardened-runtime-sparkle-cli
Disable hardened runtime for sparkle-cli
2021-03-19 09:20:54 -07:00
Zorg 28924f4b2a Disable hardened runtime for sparkle-cli 2021-03-18 20:49:08 -07:00
Mayur Pawashe d102a50f66 Merge pull request #1795 from sparkle-project/main-dev
Main development change
2021-03-08 21:12:05 -08:00
Zorg bfc55ac8b0 Add 1.x feature frozen note 2021-03-08 00:54:02 -08:00
Zorg 1f35e7b5cd Add GitHub issue / pull request templates 2021-03-08 00:51:09 -08:00
Zorg f23799a531 Re-add INSTALL document which directs user to Sparkle website docs 2021-03-08 00:40:44 -08:00
Zorg 81453d1410 Update ReadMe to update development branch and feature-freeze 1.x 2021-03-08 00:40:12 -08:00
Mayur Pawashe 7064ac160b Merge pull request #1794 from sparkle-project/sync-localizations
Sync localizations
2021-03-07 10:21:45 -08:00
Mayur Pawashe f74f9d288d Merge pull request #1793 from sparkle-project/ci-upload-dist
Test validity of archived products and upload distribution in CI
2021-03-07 09:23:50 -08:00
Mayur Pawashe 3c8ebd921f Merge pull request #1792 from sparkle-project/1.x-sync
Sync SPM + changelog changes
2021-03-07 09:23:13 -08:00
Zorg 579e7bd98b Add Persian localizations 2021-03-06 23:56:24 -08:00
Zorg 6d548efb2b Sync localization changes from 1.x 2021-03-06 23:51:21 -08:00
Zorg 2179eb1e39 Upload release distribution only for Xcode 12 builds currently 2021-03-06 23:19:25 -08:00
Zorg 3ded119af5 Include Xcode version in artifact upload 2021-03-06 22:47:49 -08:00
Zorg 018d4ea630 Reference relative path 2021-03-06 22:14:27 -08:00
Zorg ef68656783 Test validity of archived products and upload distribution in CI 2021-03-06 21:53:31 -08:00
Kornel aeffb2710a Changelog 2021-03-06 20:56:07 -08:00
Kornel 7c223ef0d1 Changelog 2021-03-06 20:54:45 -08:00
Zorg 724e9eb79e Fight SPM retagging
https://github.com/sparkle-project/Sparkle/commit/b5c9539f16de5b8647418fc467c6ca8fd5c8d22c
2021-03-06 20:20:08 -08:00
Jonas Zaugg 59c2c7358f Update make-release-package.sh
Now provides an error and exits when not complying with SemVer
2021-03-06 20:19:18 -08:00
Jonas Zaugg dc7b2f2030 Update make-release-package.sh
Only check and update tag in Package.swift when not running a CI build. As long as GitHub actions are reserved for tests, this should be ok as this is a "fake" update of Package.swift anyway. If you ever use GitHub actions for releases, you'll probably have to rethink the tagging logic once again
2021-03-06 20:19:04 -08:00
Jonas Zaugg 78a0d4e4e7 Checks SemVer and default to force tagging 2021-03-06 20:18:45 -08:00
Jonas Zaugg cd8794acce Various fixes to SPM logic
Improves prompt asking to force move tag (default is NO, but can be triggered after `make release`). Fixes issues with single quotes in make-release-package.sh.
2021-03-06 20:18:23 -08:00
Jonas Zaugg fd940884c8 Include tag instead of version in Package.swift 2021-03-06 20:16:41 -08:00
Zorg e76e34ead8 Rename SPM zip
https://github.com/sparkle-project/Sparkle/commit/891afd44c7075e699924ed9b81d8dc94a5111dfd#diff-507d750ad623604486faa5c9772800e8a019c7675a08688e94bde91872c0f1d8
2021-03-06 20:16:06 -08:00
Mayur Pawashe 2dd324d316 Merge pull request #1789 from sparkle-project/relocate-tools
Move helper tools into executables directory of framework
2021-03-02 22:25:18 -08:00
Mayur Pawashe 9e7548c4ff Merge pull request #1790 from sparkle-project/propogate-errors
Propagate errors from installer and agent to Sparkle
2021-03-01 19:53:14 -08:00
Zorg e21f7c4e87 Ensure startInstallationToURL method populates error object 2021-02-28 23:47:14 -08:00
Zorg 370fdb8368 Fix auto-synthesize warning 2021-02-28 23:47:07 -08:00
Zorg d3f6370828 Re-add SUSignatureError because I didn't see Swift code using it 2021-02-28 23:27:18 -08:00
Zorg efa9cc20d0 Fix tests 2021-02-28 23:20:06 -08:00
Zorg 7d8e3059ec Add and use SUAgentInvalidationError 2021-02-28 22:23:58 -08:00
Zorg f400b27cb2 Re-add __attribute__((noreturn)) attribute 2021-02-28 22:20:32 -08:00
Zorg f43b5ee3c3 Propagate agent errors to Sparkle 2021-02-28 22:14:35 -08:00
Zorg 1526a024b8 Propagate installer errors to Sparkle 2021-02-28 21:40:17 -08:00
Zorg 5cd1d3c824 Move helper tools into executables directory of framework 2021-02-28 10:25:42 -08:00
Mayur Pawashe 8a868914e5 Merge pull request #1786 from sparkle-project/bump-unarchiving-test-timeout-2x
Bump unarchiving tests timeout from 7 seconds to 30 seconds (2.x)
2021-02-22 07:44:40 -08:00
Zorg f5ee4dedb4 Bump unarchiving tests timeout from 7 seconds to 30 seconds 2021-02-21 18:05:51 -08:00
Mayur Pawashe ef23e7d65e Merge pull request #1781 from sparkle-project/add-release-distribution-2x
Add building distribution in Release in CI (2.x)
2021-02-21 17:51:00 -08:00
Mayur Pawashe d29d3f97a5 Merge pull request #1784 from sparkle-project/bz2-make-fallback-2x
Add fallback to bz2 when building Sparkle distribution (2.x)
2021-02-21 17:50:19 -08:00
Zorg a1cba4dd91 Add fallback to bz2 when building Sparkle distribution 2021-02-21 17:21:02 -08:00
Zorg 699a9df7bf Add building distribution in Release in CI 2021-02-21 15:42:43 -08:00
Mayur Pawashe 5aa68fa82b Merge pull request #1778 from sparkle-project/user-disable-automatic
Revert logic that prevented users from disabling automatic downloads
2021-02-21 15:01:56 -08:00
Mayur Pawashe adc62f8e34 Merge pull request #1777 from sparkle-project/installer-progress-locale-symlink
Remove locale symlinks in installer progress tool
2021-02-21 08:47:38 -08:00
Zorg f977a92e4c Revert logic that prevented users from disabling automatic downloads
In 2.x, updates can be downloaded automatically and presented later even if they can't be installed automatically without user intervention. Users need to in control and be able to disable automatic downloads regardless of developer's Info.plist intention.
2021-02-21 08:33:32 -08:00
Zorg dd24e8d938 Remove locale symlinks in installer progress tool 2021-02-21 08:27:59 -08:00
Mayur Pawashe 03f20a05a8 Merge pull request #1776 from sparkle-project/error-messages
Improve error messages developers run into
2021-02-21 07:14:59 -08:00
Mayur Pawashe 7ecc624afb Merge pull request #1774 from sparkle-project/delegate-methods
Add download, extract, skip delegate methods from 1.x
2021-02-21 07:13:53 -08:00
Zorg e331afddb1 Add host name of bundle in potential user facing error messages 2021-02-20 21:50:45 -08:00
Zorg 45581d5658 Log to users to check for Autoupdate console logs 2021-02-20 21:32:34 -08:00
Zorg 9931992912 Provide URL to troubleshoot XPC timed out issues 2021-02-20 21:09:57 -08:00
Zorg df3d9e2b14 Update error messages to specify Sparkle 2
This makes it more clear the developer is using Sparkle 2.
2021-02-20 20:48:32 -08:00
Zorg e148659cbb Add userDidSkipThisVersion case for informational updates 2021-02-20 20:33:58 -08:00
Mayur Pawashe 0a8443c94a Merge pull request #1773 from sparkle-project/lovette-patch-2
Correct generate_appcast -s command line argument usage help (2.x)
2021-02-20 20:00:56 -08:00
Lance Lovette 0e26a3e27a Correct generate_appcast -s command line argument usage help
Fixes sparkle-project/Sparkle#1766
2021-02-20 19:46:34 -08:00
Zorg ea472ae3f0 Add updater:shouldPostponeRelaunchForUpdate: 1.x stub 2021-02-20 19:40:02 -08:00
Zorg 59326e80d4 Add 1.x willInstallUpdateOnQuit:immediateInstallationBlock: stub 2021-02-20 19:32:21 -08:00
Zorg 3c0962b137 Add delegate methods for downloading/extracting updates 2021-02-20 19:05:24 -08:00
Zorg 2d666b4d84 Add updater:userDidSkipThisVersion: delegate method 2021-02-20 00:38:12 -08:00
Mayur Pawashe c822f88cf1 Merge pull request #1767 from sparkle-project/generate-appcast-priv-dsa-flag
Fix -f command line argument handling (2.x)
2021-02-17 20:32:33 -08:00
Lance Lovette 16dc6c2b5b Fix -f command line argument handling
https://github.com/sparkle-project/Sparkle/issues/1763
2021-02-17 20:14:34 -08:00
Mayur Pawashe 08a7122b36 Merge pull request #1761 from sparkle-project/real-time-2
Use wall time for our updater scheduled check timer
2021-02-14 08:48:58 -08:00
Zorg 8792137fda Use wall time for our updater scheduled check timer 2021-02-14 00:40:08 -08:00
Mayur Pawashe 25820ccd4b Merge pull request #1758 from sparkle-project/flat-package-mpkg
Support mpkg for updating/installing flat non-archived packages
2021-02-13 11:12:56 -08:00
Zorg 1290b974de Support mpkg for updating/installing flat non-archived packages 2021-02-13 10:04:08 -08:00
Mayur Pawashe c39370e64b Merge pull request #1745 from sparkle-project/flat-package-2x
Add support for updating/installing from flat non-archived packages
2021-02-10 22:23:46 -08:00
Mayur Pawashe 0b9bacfd0e Merge pull request #1755 from sparkle-project/not-found-reporting
Alter update not found error message
2021-02-07 11:59:49 -08:00
Kornel ad545813f0 Merge pull request #1754 from grit96/1748-2.x
Apply custom headers to app download (2.x)
2021-02-07 15:02:19 +00:00
Geraint White 3f226ccdd7 Apply custom headers to app download
The custom headers added in #489 only applied to the appcast download.
This makes them apply to the app download as well for the case when both are hosted behind authentication.
2021-02-07 10:05:08 +00:00
Zorg 13a36cb904 Add fallback to legacy showUpdateNotFoundWithAcknowledgement method 2021-02-06 23:46:06 -08:00
Zorg c5def52133 Update user driver methods for passing error to updates not found 2021-02-06 23:31:29 -08:00
Zorg 6b0d9f0de2 Tell user if they are running newer version than latest appcast item
This ports https://github.com/sparkle-project/Sparkle/pull/1427 to 2.x
2021-02-06 23:26:51 -08:00
Zorg a9254d1e02 Create alert using NSError for update not found error 2021-02-06 23:00:44 -08:00
Mayur Pawashe 2b9a02c825 Merge pull request #1753 from sparkle-project/fix-swallow-scheduled-ui-error
Don't swallow errors for scheduled driver after update is shown
2021-02-06 10:42:00 -08:00
Zorg 9d335b1233 Don't swallow errors for scheduled driver after update is shown 2021-02-05 21:42:24 -08:00
Mayur Pawashe 43379af33e Merge pull request #1747 from sparkle-project/fix-unimplemented-preventsAutoupdate-warning
Fix minor unimplemented preventsAutoupdate synthesize warning
2021-01-31 21:48:36 -08:00
Zorg 4c14d7d556 Fix minor unimplemented preventsAutoupdate synthesize warning 2021-01-31 21:34:02 -08:00
Zorg afe03b7161 Fix compile errors in generate_appcast 2021-01-30 23:24:50 -08:00
Zorg 79a9c50d2d Add support for updating/installing from flat packages
With these changes, modern pkg's should no longer need to be archived.

Only guided package installations are supported for flat packages. Specifying an interactive package installation type will result in a rejection. If the file URL has a ".pkg" suffix it is by default assumed to be a guided pkg installation now, which relieves the burden of needing to previously specify sparkle:installationType in the app cast item enclosure, in this case (for 2.x). Moreover, this relieves the burden of developers needing to archive their pkg for Sparkle.
2021-01-30 22:59:09 -08:00
Mayur Pawashe c5add680aa Merge pull request #1736 from sparkle-project/phased-group-rollout-2x
Port phased group rollout to 2.x
2021-01-30 19:13:28 -08:00
Zorg e8ebf23504 Compute current date only once for all app cast items 2021-01-30 18:09:39 -08:00
Mayur Pawashe da5be8902c Merge pull request #1741 from sparkle-project/remove-disable-automatic-skip
Remove hiding skip button on automatic updates logic
2021-01-30 12:45:21 -08:00
Zorg 7cffceb1f7 Remove hiding skip button on automatic updates
If user opts-out of automatic downloads (eg via app pref), they should be able to skip.

This logic for detecting minimumAutoupdateVersion present isn't sufficient and consistent enough, chooses to have skip visible in cases updates aren't prevented.
2021-01-30 08:25:54 -08:00
Zorg 6c846d0fad Combine phasedUpdateGroup / background flags 2021-01-29 22:21:26 -08:00
Zorg 044313db59 Remove redundant method 2021-01-29 22:15:50 -08:00
Zorg e089b9b435 Filter supported app cast items before finding the best item
This fixes scenarios where delegates may not take min/max OS version or phased update groups in account (and they shouldn't).
2021-01-29 21:45:58 -08:00
Zorg 98dc6314a5 Remove unused delegate method addition 2021-01-24 23:44:24 -08:00
Zorg 915786e11f Fix hostSupportsItem: returning YES too early 2021-01-24 23:39:33 -08:00
Zorg 60fcc89b7e Make phased rollout interval an app cast element not an enclosure one
Previous behavior doesn't work properly with delta update items. They should not be treated separately.
2021-01-24 23:21:18 -08:00
Zorg f9d421f851 Update from previous version if newest item doesn't pass rollout 2021-01-24 21:48:33 -08:00
Zorg 27d7058e0e Don't track if update was downloaded or checked in background
Note the prior check was also wrong, it should have used the background flag from the app cast check, not the download driver.
2021-01-24 21:22:24 -08:00
Zorg 03503d37b6 Fix SUUpdateGroupIdentifierKey not being read from user defaults 2021-01-24 21:21:42 -08:00
Zorg 0364e01c3a Remove method not used publicly in SUPhasedUpdateGroupInfo.h 2021-01-24 20:18:56 -08:00
Zorg bc0e338cde Use new update group for next downloaded update if applicable 2021-01-24 20:17:10 -08:00
Zorg d97dbf7ba0 Remove unused header import 2021-01-24 18:18:01 -08:00
Zorg 9818eff9a2 Add support for phased group updates to 2.x 2021-01-24 18:14:48 -08:00
Mayur Pawashe 4767ef60ec Merge pull request #1733 from sparkle-project/alert-state
Hide skip and later buttons in appropriate scenarios
2021-01-24 10:35:53 -08:00
Zorg e197f3093a Update hiding skip button case with checking minimumAutoupdateVersion 2021-01-24 10:25:45 -08:00
Zorg 1d930b585e Merge branch '2.x' into alert-state 2021-01-24 10:20:11 -08:00
Mayur Pawashe 6da14f7c46 Merge pull request #1735 from sparkle-project/prevent-autoupdate-2x
Port preventing new version from being auto installed to 2.x
2021-01-24 10:16:42 -08:00
Zorg 5ca8984c10 Port preventing new version from being auto installed to 2.x
Original PR for master: https://github.com/sparkle-project/Sparkle/pull/1688
2021-01-24 00:21:47 -08:00
Zorg 27f31a2913 Change capitalization 2021-01-23 21:32:51 -08:00
Zorg 3e544c7d26 Use "Install On Quit" localization again 2021-01-23 21:30:47 -08:00
Zorg 507255224a Fix hidden state for automatic install button and add comments 2021-01-23 20:50:07 -08:00
Zorg c1381d48d1 Add comments and rename some title alert strings to match 1.x 2021-01-23 19:29:50 -08:00
Zorg c3ce4f624b Hide skip button when developer enables automatic downloads too 2021-01-23 18:15:58 -08:00
Zorg 0a35f9d807 Hide skip and later buttons in appropriate scenarios 2021-01-23 17:23:04 -08:00
Mayur Pawashe fd209ced12 Merge pull request #1730 from sparkle-project/migrate-keys
Add export/import options to generate_keys
2021-01-23 16:38:33 -08:00
Zorg d85c1df752 Add options to export and import private/public key pair 2021-01-23 07:51:32 -08:00
Zorg 4fdd01052b Add option to store a specified private+public key pair directly
This is useful for migrating keys from one machine to another.
2021-01-23 01:43:41 -08:00
Kornel 1278b426f2 Merge pull request #1726 from zorgiepoo/cancheckforupdates 2021-01-19 11:59:23 +00:00
Kornel e880f34f7c Merge branch '2.x' into cancheckforupdates 2021-01-19 11:41:12 +00:00
Kornel 1d178a9a19 Merge pull request #1722 from zorgiepoo/important-1x-fixes 2021-01-19 11:38:22 +00:00
Kornel 22af258dc8 Merge pull request #1728 from zorgiepoo/about-blank-fix-2x
Ignore opening about:blank URLs (2.x)
2021-01-19 11:36:28 +00:00
Zorg 01d19ca92e Ignore opening about:blank URLs
Fix from 8f19f6a8cc which I regressed accidentally.
2021-01-18 09:12:16 -08:00
Zorg 173ccc845a Fix project references from previous commit of updating bin scripts 2021-01-17 22:07:20 -08:00
Zorg a0401fade9 Update and sync bin directory from 1.x 2021-01-17 21:58:02 -08:00
Zorg c6a89eb32b Integrate "Remove locale symlinks"
https://github.com/sparkle-project/Sparkle/commit/d4d4c68ad2e11ecdf21b2a71d45710cec4834c0c
2021-01-17 19:31:44 -08:00
Zorg f7906c45c0 Fix typo 2021-01-17 17:24:29 -08:00
Zorg 6d0f7fce26 Remove outdated user driver any thread comments 2021-01-17 17:23:11 -08:00
Zorg 6308b262a0 Preserve showCanCheckForUpdates: method on user driver 2021-01-17 17:17:49 -08:00
Zorg 2066cd7232 Migrate canCheckForUpdates property from user driver -> updater 2021-01-17 17:01:48 -08:00
Zorg 64d2ee1b5d Integrate "Remove max size from update alert" (#1676)
https://github.com/sparkle-project/Sparkle/pull/1676
2021-01-17 13:14:26 -08:00
Zorg 7896b5ab44 Remove extraneous [] in ReadMe 2021-01-17 12:24:17 -08:00
Zorg c70b39ba79 Fix SUHost nullability compile errors in unit tests 2021-01-16 21:10:25 -08:00
Zorg 7c7968b2f2 Fix UIDelegate not being set from master
4390eb9eb2
2021-01-16 20:45:05 -08:00
Zorg ae81bd27a2 Update resources from master branch 2021-01-16 20:42:26 -08:00
Zorg fd6d480d3d Remove executable bit from SUHost.h/.m 2021-01-16 20:37:14 -08:00
Zorg fc18529767 Add test link in test app
https://github.com/sparkle-project/Sparkle/commit/1b209e6726a4244e131a2ab0d3c1d0098c619794
2021-01-16 20:35:27 -08:00
Zorg 6fc5011362 Integrate "tiny fixes"
https://github.com/sparkle-project/Sparkle/commit/208b0dc49a79bfea604b1c10cc1b0e50a02f7e3d
2021-01-16 20:33:52 -08:00
pierswalter 176ff8f3df Update SUSystemProfiler.m
Masked sysctl hw.cputype value when evaluating the CPU type.
Used macros from mach/machine.h instead of magic numbers.
Added support for ARM in evaluation of hw.cpusubtype.
2021-01-16 20:26:04 -08:00
Zorg f64436165b Check OS in -hostSupportsItem: 2021-01-16 20:19:15 -08:00
Zorg 154b702552 Parse and serialize osString appcast item property 2021-01-16 20:14:52 -08:00
Jake Fenton c03cc0fa17 check if SUBundleName is set before normalizing
When changing the name of an app, there's a couple things to do in order
to ensure auto-updates still work:

1. set SUBundle Name. This basically tells Sparkle "ey, expect an app
of {SUBundleName}.(app|pkg) instead of the normal name."
2. set `SPARKLE_NORMALIZE_INSTALLED_APPLICATION_NAME` in
commonConfig.xccconfig to reset the name of the app.

in (2), we always used the host's bundle name, instead of checking to
see if SUBundleName was set, which means normalization doesn't work as
expected during app name changes.
2021-01-16 20:00:10 -08:00
Zorg f858b99f93 Add hr Sparkle.strings file I forgot to add previously 2021-01-16 19:52:19 -08:00
Michael Buckley 85f41927f3 Integrate "Annotate SUHost for nullability" 2021-01-16 19:52:02 -08:00
Julian Mayer d8a8282b60 fix 2021-01-16 19:48:05 -08:00
Julian Mayer a6ffe0fa71 #1352 2021-01-16 19:47:46 -08:00
Zorg 523542ad90 Re-add Croatian (hr) localization
I may have accidentally removed this.
2021-01-16 19:40:34 -08:00
Quinn Taylor 57d9a780b8 Fix second bold sentence in read-only update alert dialog. (#1515)
• Updated error dialog code in SUBasicUpdateDriver, and created a local variable to reuse `[aHost name]`.
• Updated content of Sparkle.strings files, splitting existing affected translations into 2 chunks each.
• Fixed the Catalan translation, which was using an old string key.
• Removed a few unnecessary comments in the Polish translation.
2021-01-16 19:25:44 -08:00
Zorg 8d6d81c58f Integrate "Improved error when running from translocated location"
Except correctly.

https://github.com/sparkle-project/Sparkle/pull/1392/files
2021-01-16 18:54:38 -08:00
Zorg 7a228c7e1d Integrate "fix: read SUAutomaticallyUpdate from Info.plist"
https://github.com/sparkle-project/Sparkle/commit/4f47fb02db4d2572dbd8e9822f7a985ee80bb556
2021-01-16 18:29:36 -08:00
Zorg 6e326f3cea Integrate trying to preserve Finder tags in 2.x
https://github.com/sparkle-project/Sparkle/commit/1081dcdda187a9be5635594d388090f78de940f9
2021-01-16 18:27:41 -08:00
Zorg 3c0e02f333 Integrate "Fix #1061 & #835: Sparkle clients polling too frequently"
https://github.com/sparkle-project/Sparkle/pull/1135
2021-01-16 18:13:58 -08:00
Zorg 32b0ca2e0f Fix build failure due to removed INSTALL.markdown 2021-01-12 20:19:59 -08:00
Kornel 6316c53aba Merge pull request #1720 from zorgiepoo/readme-sync 2021-01-10 22:52:01 +00:00
Zorg 8fc7cadf69 Update internal docs regarding 2.x 2021-01-10 11:10:59 -08:00
Zorg cb5eb0e47d Update repo readme & docs to sync with 1.x 2021-01-10 11:05:54 -08:00
Maurice Parker ea11447ab2 Don't initialize the webview if we don't show release notes (#1713) 2021-01-06 14:39:00 +00:00
Kornel 8a3cc2e073 Merge pull request #1711 from thebluepotato/fix-catch-22-2.x 2021-01-05 14:45:50 +00:00
Jonas Zaugg 03fb6d969f Match changes made to 1.x branch
Fixes the issue of Package.swift being updated after tag, see #1710.
2021-01-05 15:37:21 +01:00
Kornel d4fb14f1fd Merge pull request #1705 from zorgiepoo/remove-async-user-driver 2021-01-03 21:38:20 +00:00
Zorg ec4b113d17 Add assertion checks for user driver methods called from main thread 2021-01-03 10:57:49 -08:00
Boy van Amstel ace5d99a27 Update INSTALL to include submodule init step
The install description currently fails to notify the user that they should install the git submodule(s) present in the repo.

This causes `make release` to fail.
2021-01-03 15:19:03 +00:00
Zorg 164e0e4f9a Adopt WKWebView
We fallback to legacy WebView in two cases:

* On systems prior to macOS 10.11 (it may be possible to support WKWebView in 10.10, but due to an 10.11+ only API I didn't bother putting in the effort)
* For apps using the downloader XPC service which are most likely sandboxed apps without an outgoing network entitlement. WKWebView doesn't function in that case (FB6993802 - https://github.com/feedback-assistant/reports/issues/1)

Additional notes:

* Added an abstraction for using WebView or WKWebView
* Web view is created and inserted programmatically rather than from the nib which has previously caused issues (and is not allowed for WKWebView prior to 10.12 due to some NSCoding bug).
* We need to rely on WKWebView private API for drawing transparent background (FB7539179 - https://github.com/feedback-assistant/reports/issues/81). Additional notes in the code.
* We always inject a custom stylesheet for dark mode colors and default font family/size (for WKWebView).
* This should also improve the Catalyst support story (#1482)
2021-01-03 10:10:57 +00:00
Mayur Pawashe 09178f70e9 Migrate to GitHub Actions CI (2.x) (#1706) 2021-01-03 10:08:35 +00:00
Zorg 3bc20cb096 Add noreturn attributes to command line user driver methods 2020-12-31 11:17:55 -08:00
Zorg 80cecd37b5 Fix compile error with missing '[' 2020-12-31 11:16:11 -08:00
Zorg 7951b81b69 Eliminate assumption that user driver calls are invoked in any thread
This reduces friction in creating a SPUUserDriver. This assumption that the calls could be made from any thread is a relic of the past of separating the user driver into a different process from the updater/scheduler, which is no longer sane or supported.

This should speed up things very slightly too.
2020-12-31 11:00:59 -08:00
Kornel 066da58f4d Merge pull request #1703 from sparkle-project/base-internationalization-2.x 2020-12-29 21:36:32 +00:00
Zorg 5e5aebffd3 Reduce code duplication by using SUAdHocCodeSigning 2020-12-28 15:35:45 -08:00
Zorg 98eef51931 Fix Test Application by disabling hardened runtime for XPC helper 2020-12-28 15:24:03 -08:00
Zorg 5e0b3f2a19 Add localization strings files for Test Application 2020-12-28 15:20:37 -08:00
Zorg 48a1379dbe Add strings files for SUUpdateAlert and SUUpdatePermissionPrompt 2020-12-28 15:13:28 -08:00
Zorg 3038218ea7 Enable base internationalization
Fix issues with Test Application.
2020-12-28 14:48:59 -08:00
Charles Srstka 238fd42bb3 Support getting app icon from asset catalog 2020-12-10 08:56:53 +00:00
Martin Pilkington eac4522817 System profiler privacy and transparency (#1690) 2020-11-30 13:12:48 +00:00
Kornel 94d05336a6 Merge pull request #1664 from skelpo/improve-generator-tools 2020-10-13 12:35:14 +01:00
Gwynne Raskind 93e4fd9424 Fix generate_appcast so links to localized release notes are embedded as full URLs instead of unescaped filenames. This makes them load reliably in complex contexts (such as the presence of characters like spaces in the filenames). 2020-10-12 12:43:43 -05:00
Gwynne Raskind 741ec1a08b Further cleanup generate_keys and its new "lookup-only mode". 2020-10-06 08:14:44 -05:00
Gwynne Raskind 7a8ead559b Clean up generate_keys/main.swift quite a bit - more comments, better output to console, cleaner error reporting 2020-10-06 07:54:08 -05:00
Kornel c802a38c92 Merge pull request #1662 from zorgiepoo/2.x-module-imports 2020-10-04 12:37:14 +01:00
Zorg 8947a6e50d Merge branch '2.x' into 2.x-module-imports 2020-10-03 11:10:58 -07:00
Kornel 5e73e70322 Merge pull request #1660 from zorgiepoo/2.x-double-quote-include 2020-10-03 14:13:52 +01:00
Zorg e2bf94df7e Fix more missing import warnings 2020-10-03 01:59:29 -07:00
Zorg a266b400cb Add more missing module imports 2020-10-03 01:54:53 -07:00
Zorg 7b4c648812 Use module imports to avoid warnings from clients 2020-10-03 01:14:50 -07:00
Zorg d38fd92668 Use double quote includes in a bunch of other places I missed 2020-10-03 00:41:59 -07:00
Zorg 772e610537 Set CLANG_WARN_QUOTED_INCLUDE_IN_FRAMEWORK_HEADER instead 2020-10-03 00:38:15 -07:00
Zorg 02e11f3c3a Add -Wno-quoted-include-in-framework-header to ConfigCommon 2020-10-03 00:10:53 -07:00
Zorg 8c7adbdca7 Use double quote includes with pragma ignore warning 2020-10-03 00:10:24 -07:00
Kornel 852d678585 Merge pull request #1656 from skelpo/merge-from-1.x 2020-09-23 21:13:50 +01:00
Gwynne Raskind e3ba2388e8 Fix tests to actually build 2020-09-23 07:36:55 -05:00
Denis Dzyubenko 6f1fceb7d4 generate_appcast follow symbolic links
When archives are stored as symlinks e.g. due to storing binary files in a
git-annex repository, everything works file except file size in the generate
feed xml file. This patch makes generate_appcast correctly determine file size
by following the symlink

(cherry picked from commit 7233bb93e7)
2020-09-23 07:28:12 -05:00
Bi11 bc6d15a13c Support App Store URL scheme in release note webview
(cherry picked from commit f2fc729b69)
2020-09-23 07:27:51 -05:00
Brad Andalman 65cab6a14d generate_appcast can update the release notes element’s URL when required
Previously, generate_appcast could only add or remove the release notes element for an update. This was probably fine, because it was unlikely to change: the release notes URL was determined by the SUFeedURL.

However, now that —release-notes-url-prefix was added, the release notes element CAN change. So, with this commit, if the release notes element is present for an update, the URL will be set correctly.

(cherry picked from commit 7c7e924ed4)
2020-09-23 07:26:54 -05:00
Kornel 923f15220f Merge pull request #1648 from oneeightyg/feature-1646-generate-appcast-output-filename 2020-09-23 07:26:36 -05:00
Kornel 5fcc9a8aa9 Merge pull request #1644 from oneeightyg/feature-1642-release-notes-url-prefix
Add —release-notes-url-prefix to generate_appcast

(cherry picked from commit 7ea72a2af4)
2020-09-23 07:24:03 -05:00
Kornel 500d97d8ff Merge pull request #1635 from thebluepotato/spm-xcframework-2.x 2020-08-29 14:02:45 +01:00
Jonas Zaugg d1367393c2 Travis Xcode updated to newer beta 2020-08-29 02:02:24 +02:00
Jonas Zaugg 404b67a256 Mirror changes made to 1.x branch
Fixup Travis, build through Xcode scheme, etc.
2020-08-03 02:36:04 +02:00
Jonas Zaugg de8de29df2 Mirror changes made to the spm-xcframework branch and include SparkleCore 2020-08-03 02:09:39 +02:00
Jonas Zaugg 6a55563307 Add SPM binary target support 2020-08-03 02:06:48 +02:00
Kornel 438f4a21d5 Merge pull request #1636 from skelpo/forward-fixes 2020-08-01 20:58:28 +01:00
Gwynne Raskind 32bb57c029 Cosmetic fixes to ConfigCommon.xcconfig. Disable COPY_PHASE_STRIP in ConfigCommonRelease.xcconfig to silence a large number of warnings about failing to strip codesigned binaries. 2020-07-25 02:20:53 -05:00
Gwynne Raskind 1c77f59214 Fix incorrect paths in project file 2020-07-25 02:20:08 -05:00
Gwynne Raskind a95f1592cd Fix several dozen warnings. Fix several things to actually respect the 10.9 minimum of the beta. 2020-07-25 02:19:50 -05:00
Gwynne Raskind e7f8161ae4 Update last migration check version of project and schemes as of Xcode 12's checks. Fix how WMO is enabled for Swift code in Release builds. 2020-07-25 02:17:07 -05:00
Gwynne Raskind 9422bf16ae Forward-port improvements to generate_appcast from main branch (overridable download URL prefixes, extracting archives to uniqued output directory names during generation, -h flag to print usage, support for specifying Ed25519 key as string on command line, much smarter args parsing, ability to override keychain used to find signing keys) 2020-07-24 20:43:22 -05:00
Gwynne Raskind 418068e902 Forward-port PR #1499 (localized release notes in appcast) to 2.x 2020-07-24 20:33:35 -05:00
Gwynne Raskind 04b2122fed SUPublicEDKey expects to be a string, not data. Sigh. 2020-07-22 14:15:43 -05:00
Gwynne Raskind bdffcb0dd5 Disable the ability to create synchronizable keys for now. Requires entitlements on the generate tool which is a giant pain in the rear. Tweak the output a bit more so it's nice and consistent. 2020-07-22 10:52:01 -05:00
Gwynne Raskind be25c2ac64 Add the ability to make a generated signing key syncable over iCloud Keychain. Heavily overhauls the UI to actually explain things a little and behave how it's supposed to. 2020-07-22 10:45:02 -05:00
Gwynne Raskind 8487a24584 Default the Distribution scheme to build Release because who cares 2020-07-22 07:52:22 -05:00
Gwynne Raskind 820fdadfd7 Forward-port the fix for the stupid use of backticks in an echo command in build-docs.sh 2020-07-22 07:52:06 -05:00
Gwynne Raskind 1343c27805 Forward-port the newer generate_keys and sign_update tools (or at least their inclusion in the build) from 1.x, including changing the distribution archive from bzip2 to xz. 2020-07-22 07:51:45 -05:00
Kornel Lesiński 7acb6c4292 Revert "Add dependencies to "Set Git Version Info" Run Script phase"
This reverts commit 9592e35d1c.
2020-07-20 21:29:54 +01:00
Jordan Rose 9592e35d1c Add dependencies to "Set Git Version Info" Run Script phase
This keeps it from running when nothing's changed, which keeps Xcode
from re-signing the framework when nothing's changed, which keeps
downstream clients from re-copying the framework when nothing's
changed.
2020-07-16 15:40:39 +01:00
Jordan Rose e7e20e6ac8 Represent invalid public keys and signatures explicitly
Rather than using a valid-but-incorrect public key or signature to
make sure a failure to parse turns into a failure to validate, only
return a public key / signature when it is both present and at least
minimally valid. Syntactically invalid public keys / signatures are
also logged explicitly.
2020-06-25 00:01:09 +01:00
Jordan Rose 2b4b2a4443 SUDSAVerifierTest -> SUSignatureVerifierTest
The file got renamed, but the test class did not.
No functionality change.
2020-06-25 00:01:09 +01:00
Jordan Rose bd601b2f8c If a signature is present but invalid, don't just ignore it
Otherwise, a typo in an Ed25519 signature could lead to falling back
to DSA.
2020-06-25 00:01:09 +01:00
Jordan Rose b137b7f072 Test SUSignatureVerifier with Ed25519 keys 2020-06-25 00:01:09 +01:00
Jordan Rose 705638799c Allow relative URLs in appcasts
The base URL is taken from the server response rather than from the
original requested URL to account for redirects.
2020-06-23 22:40:53 +01:00
Jordan Rose 6b47d3fe90 Remove classes from test target that are already in Sparkle.framework
Avoids "Class SUCodeSigningVerifier is implemented in both
Sparkle.framework/Versions/A/Sparkle and
Sparkle Unit Tests.xctest/Contents/MacOS/Sparkle Unit Tests.
One of the two will be used. Which one is undefined."
2020-06-23 22:37:50 +01:00
Jordan Rose 3e000a897f Test post-validation of code-signed binaries
This gets more complicated, since binaries can be just code-signed, or
use both code signing and DSA keys, or be rotating keys for one or the
other.

The code signing test cases emulate certificate rotation by changing
the "identifier" for the bundle; the script used to sign each bundle
(with ad hoc signing) is included to support future expansion of
testing.
2020-06-16 21:13:39 +01:00
Jordan Rose b969c31f07 Test SUUpdateValidator's post-validation logic
The actual tests here are the same as pre-validation; things only get
complicated when validating with code signing. The setup's a little
more involved though, since we need a supposedly-downloaded bundle to
do anything.

Also test invalid signatures, which are not always the same as absent
signatures.
2020-06-16 21:13:39 +01:00
Jordan Rose 299157c3e7 Start SUUpdateValidatorTest with prevalidation testing 2020-06-16 21:13:39 +01:00
Philippe Casgrain 3a8040ae2e Fixed typo in sign_update usage 2020-06-16 13:19:43 +01:00
Philippe Casgrain 9a74b23f7f Replaced deprecated method
-initWithBase64Encoding has been deprecated since OS X 10.9, and that
is our deployment target.
2020-06-16 13:19:43 +01:00
Kornel 0900d09ab3 Run swiftlint 2020-06-10 12:19:02 +01:00
Rajiv Shah 1755a3da05 Silence two warnings 2020-06-10 12:17:38 +01:00
Rajiv Shah bb56b5b259 Run SwifLint autocorrect 2020-06-10 12:15:34 +01:00
Rajiv Shah 5df208336a Copy SwiftLint config from master 2020-06-10 12:15:34 +01:00
Jordan Rose 50f754c21d Don't treat a download prevalidation failure as a regular validation failure
You have to remember to invoke prevalidation anyway, so it doesn't
gain much for post-validation to check whether prevalidation failed.

Also, remove a no-longer correct comment from the corresponding
header.
2020-06-10 12:14:30 +01:00
Jordan Rose 8455216a58 Don't complain about pre-validated package installs
That's the normal way packages get installed in 2.x.
2020-06-10 12:14:30 +01:00
Jordan Rose 524761c50f Remove -[SUPublicKeys isEqualToKey:]
It's been broken since 2018, and we suspect no one's using it anyway.
2020-06-10 12:14:30 +01:00
Jordan Rose 626ccc79c6 Update missing key messages to refer to EdDSA rather than DSA 2020-06-10 12:14:30 +01:00
Jordan Rose a9ba760d6e Rename generate_appcast briding header to match standard naming 2020-06-10 12:14:30 +01:00
Jordan Rose 9561b365af Update signing self-check to look for EdDSA (like 14f1d352 on 1.x) 2020-06-10 12:14:30 +01:00
Jordan Rose 723e5d11be Statically link libed25519.a everywhere that needs it. 2020-06-10 12:14:30 +01:00
Jordan Rose 19ef31b681 Use EdDSA keys in test app (like 9c4729ed on 1.x) 2020-06-10 12:14:30 +01:00
Jordan Rose 50d321a1a9 Now that we're close enough to 1.x, steal its implementation of SUSignatureVerifier.m and SUUpdateValidator.m wholesale. 2020-06-10 12:14:30 +01:00
Jordan Rose 55e0dc508c Rename -[SUSignatureVerifier verifyStream:signatures:] to -verifyDSASignatureOfStream:signatures: (like b9150d2 on 1.x) 2020-06-10 12:14:30 +01:00
Jordan Rose f6f4ac6925 Make SecKeyRef as needed (like 1006326 on 1.x) 2020-06-10 12:14:30 +01:00
Jordan Rose 2ace19e72b Read SUPublicEDKey from plist (like 68856e0 in 1.x) 2020-06-10 12:14:30 +01:00
Jordan Rose cb12461be1 Separate prevalidation out of constructor (like 92e00ba on 1.x) 2020-06-10 12:14:30 +01:00
Jordan Rose e7c828b332 Rename SUDSAVerifier to SUSignatureVerifier (like 98ea3e3 on 1.x) 2020-06-10 12:14:30 +01:00
Jordan Rose 5dbc53a8b8 Adopt SUPublicKeys (like c094a38 on 1.x) 2020-06-10 12:14:30 +01:00
Jordan Rose 5dc407ddc5 Switch the signature verifier to use SUSignatures (like 6df898f on 1.x) 2020-06-10 12:14:30 +01:00
Jordan Rose 261f5dc797 Push SUSignature through SUAppcastItem (like 8ad1f57 on 1.x) 2020-06-10 12:14:30 +01:00
Tony Arnold 25d394acda Update the code signing verifier tests to match what is on master 2020-06-10 12:14:30 +01:00
Tony Arnold 401cd5f628 Add Xcode group for the command line tools
# Conflicts:
#	Sparkle.xcodeproj/project.pbxproj
2020-06-10 12:14:30 +01:00
Tony Arnold ddc8fac6c6 Add sign_update command line tool
This code has been ported directly from `master`.

Co-authored-by: Kornel Lesiński <github@pornel.net>

# Conflicts:
#	Sparkle.xcodeproj/project.pbxproj
2020-06-10 12:14:30 +01:00
Tony Arnold da573aa9ab Add generate_keys command line tool
This code has been ported directly from `master`.

Co-authored-by: Kornel Lesiński <github@pornel.net>

# Conflicts:
#	Sparkle.xcodeproj/project.pbxproj
2020-06-10 12:14:30 +01:00
Tony Arnold 8b40e22432 Update generate_appcast command line tool to support ed25519 signatures
This code has been ported directly from `master`.

Co-authored-by: Kornel Lesiński <github@pornel.net>

# Conflicts:
#	Sparkle.xcodeproj/project.pbxproj
2020-06-10 12:14:30 +01:00
Tony Arnold 93a8aca7fd Add ed25519 as a static library to the project
# Conflicts:
#	Sparkle.xcodeproj/project.pbxproj
2020-06-10 12:14:30 +01:00
Tony Arnold 63aa96a076 Look up the path for the System Applications directory, as it is not a single directory on macOS Catalina 2020-06-10 12:14:29 +01:00
Kornel 7b13157dce Merge pull request #1598 from rajivshah3/fix/2.x/ci
2.x: Fix CI tests
2020-05-27 11:44:59 +01:00
Rajiv Shah aa9e05958d Fix SUCodeSigningVerifierTest on macOS 10.15
Pre-installed apps, such as Calculator, are now installed under the System folder
2020-05-26 17:36:42 -04:00
Rajiv Shah 58fff9732e Copy new Travis CI config from master 2020-05-26 17:31:02 -04:00
Kornel 9c8fef56e3 Merge pull request #1592 from R4N/fullscreen-alert-fix-v2 2020-05-15 20:39:17 +01:00
Micah Moore 0e0b87afd4 Sets UpdateAlert and UpdatePermissionPrompt window's fullscreen collectionBehavior to NSWindowCollectionBehaviorFullScreenAuxiliary to allow them to present on top of the Main App's window if it's fullscreen. 2020-05-15 14:15:11 -04:00
Kornel b8f87f1702 Merge pull request #1584 from ksuther/fix-warnings 2020-05-05 14:14:33 +01:00
Kent Sutherland 32db72a2fc Fix format warning 2020-05-04 19:03:07 -05:00
Kent Sutherland f83f29193b Remove __attribute__((noreturn)) since these methods no longer abort 2020-05-04 19:02:56 -05:00
Kent Sutherland 93cff25e6f Remove @import from framework headers
Xcode 11.4 turns on -Watimport-in-framework-header by default which causes this to warn
2020-05-04 19:02:41 -05:00
Kornel f886459367 Merge pull request #1567 from panicinc/merge/app-translocation
Adding support for detecting App Translocation and showing an error
2020-03-27 14:33:41 +00:00
Logan Collins 54e663085b Adding support for detecting App Translocation and showing an error, originally from #1392. 2020-03-26 14:58:59 -07:00
Kornel 80627a4946 Merge pull request #1566 from bdkjones/2.x
Better Appcast Errors
2020-03-26 12:20:41 +00:00
Bryan Jones ba8dd4d010 Better Appcast Errors
Removes extra layer of UserInfo dictionary, exposing underlying errors to implementors.
2020-03-25 23:21:05 -07:00
Kornel 5270fe0f51 Merge pull request #1557 from martinsp/fix-2.x-build
Fixes `make release` for 2.x
2020-03-07 01:21:10 +00:00
Martins Polakovs 03ab0b72a6 Fixes make release 2020-03-06 22:22:55 +02:00
Kornel 931f7855f7 Merge pull request #1554 from philippec/fix-build-2.x
Fixed build issue
2020-02-21 10:35:35 +00:00
Philippe Casgrain a10a99ce1a Fixed build issue
Added missing semi-colon that prevented a `make release` build.
2020-02-20 22:59:44 -05:00
Kornel a9209b94b7 Merge pull request #1545 from bdkjones/2.x
Remove most production-reachable instances of abort().
2020-02-06 10:01:37 +00:00
Kornel Lesiński d2ac8bc61e Bump version
Fixes #1547
2020-02-06 09:53:23 +00:00
Bryan Jones e5e4c6c2e1 Remove most production-reachable instances of abort(). 2020-02-05 23:25:07 -08:00
Kornel a045f1a50b Merge pull request #1524 from jakob/issue-1505
Sparkle 2.x: Delay startup of updater
2019-12-15 17:05:27 +00:00
Jakob 771b193924 Use self to avoid warning 2019-12-14 22:53:56 +01:00
Jakob 0cd3aa0d9d SUUpdater: Delay updater startup
This should allow configuring the updater in willFinishLaunching:
Should fix #1505
2019-12-14 22:33:48 +01:00
Kornel c694980a94 Merge pull request #1522 from jakob/update-readme-2.x
Update README for Sparkle 2.x
2019-12-14 16:50:37 +00:00
Jakob 7c413a3da2 Make link clickable 2019-12-14 16:48:27 +01:00
Jakob b08e339a50 Add link to issue #1523 2019-12-14 16:46:54 +01:00
Jakob 91b6716f85 README: Update current status and add next steps 2019-12-14 16:19:48 +01:00
Jakob d7d567d5e2 README: Change title to "Sparkle 2.x Beta" 2019-12-14 16:08:49 +01:00
Jakob 4a82eb3d69 README: Fix link to issues 2019-12-14 16:01:40 +01:00
Martin Jan Köhler d9cce796cb Let SPUUpdaterDelegate handle errors currently suppressed (#1494)
* Let SPUUpdaterDelegate handle errors which are suppressed when calling the user driver
2019-10-31 00:30:00 +00:00
Kornel 67819be18a Merge pull request #1479 from ksuther/ui-separation-and-xpc
Added bsdiff as an explicit dependency to targets
2019-10-02 17:03:12 +01:00
Kent Sutherland 03d2ddc005 Added bsdiff as an explicit dependency to BinaryDelta and Sparkle Unit Tests targets 2019-10-01 20:06:27 -05:00
Kornel 1d6266e978 Merge pull request #1477 from ksuther/ui-separation-and-xpc
ui-separation-and-xpc branch fixes
2019-09-29 23:11:25 +01:00
Kent Sutherland 5de92bad8f Add bsdiff as an explicit dependency to Autoupdater to avoid errors if implicit dependencies is disabled 2019-09-29 00:14:49 -04:00
Kent Sutherland 3ad6b2b75b Add explicit casts to silence Xcode 11 warnings 2019-09-29 00:12:55 -04:00
Kornel 14871e5ee9 Merge pull request #1451 from mangerlahn/bugfix/cleanup-downloder-on-cancel
#1449 Fix ongoing download after the update has been cancelled
2019-08-08 22:24:59 +01:00
Max Langer f42aac7797 #1449 Fix ongoing download after the update has been cancelled 2019-08-07 23:43:46 +02:00
Kornel 3f978e865d Merge pull request #1430 from martinjbaker/patch-1
fixed incorrect syntax
2019-06-29 13:59:10 +01:00
martinjbaker c65fad6b53 fixed incorrect syntax
missing quotes on sparkle:installationType examples
2019-06-29 10:03:13 +01:00
Kornel 6fa1302ecb Merge pull request #1425 from DivineDominion/patch-1
Make XPC service prefix "org.sparkle-project" customizable
2019-06-26 20:50:52 +01:00
Christian Tietze 9980a0f911 replace org.sparkle-project with XPC_SERVICE_BUNDLE_ID_PREFIX 2019-06-26 09:25:15 +02:00
Kornel 696f1f7bf1 Merge pull request #1422 from tonyarnold/feature/bring-forward-bsdiff-static-library
Package bsdiff as a static library
2019-06-17 23:55:44 +01:00
Tony Arnold 9e4f395c97 Add Xcode 10’s workspace checks property list to the project 2019-06-16 21:31:16 +10:00
Tony Arnold e4020faae0 Rename “Third Party” Xcode group to “Vendor” to match underlying folder name 2019-06-16 19:50:25 +10:00
Tony Arnold 210a8fb165 Separate the bsdiff sources into a new static library, and use it in targets 2019-06-16 19:44:03 +10:00
Tony Arnold 3569b46d35 Fix localization region deprecation warnings 2019-05-20 11:22:39 +01:00
Kornel 2f9c721719 Merge pull request #1393 from FlixelPhotos/ui-separation-and-xpc
Update codesign script and INSTALL doc
2019-04-18 20:33:58 +01:00
Karl Moskowski 47b35a737a Update INSTALL document:
- updated codesign script
- hardened runtime and notarization
- testing notes
2019-04-18 08:48:47 -04:00
Karl Moskowski 6975392ed3 Upate the codesign script (since it’s for more than just XPCs)
#1319
2019-04-18 08:20:20 -04:00
Kornel 36f4955740 Merge pull request #1391 from michelf/hardened
Updated XPC codesigning to enable hardened runtime.
2019-04-16 19:34:46 +01:00
Martins Spilners 894f9dd683 Fix header imports (#1390)
Allows building Distribution scheme with Xcode 10.2
2019-04-16 16:49:23 +01:00
Michel Fortin dc819460a9 Updated XPC codesigning to enable hardened runtime. 2019-02-14 22:16:51 -05:00
Kornel b0fe9aa09a Merge pull request #1357 from danielpunkass/fix-framework-import-warnings
Update imports to use framework-style imports consistently
2019-02-04 23:14:41 +00:00
Daniel Jalkut ee64dc7574 Update imports to use framework-style imports to avoid warnings when CLANG_WARN_QUOTED_INCLUDE_IN_FRAMEWORK_HEADER = YES. Add CLANG_WARN_QUOTED_INCLUDE_IN_FRAMEWORK_HEADER to xcconfig file to protect against any changes that would introduce such warnings for clients who have the waring enabled. 2019-02-04 13:39:48 -05:00
Kornel b1c3b313f5 Merge pull request #1332 from ksuther/downloader-finishTasksAndInvalidate
Use finishTasksAndInvalidate instead of invalidateAndCancel in SPUDownloader
2018-12-14 19:18:04 +00:00
Kent Sutherland 01bc8628da Use finishTasksAndInvalidate instead of invalidateAndCancel
-cleanup is only called when the task has finished, so it's safe to do this.
This silences a spurious warning logged by NSURLSession (or somewhere else internal):

Task <BB2AE4EF-8E93-44D7-9AB3-6EE9A9E3ACF8>.<1> load failed with error Error Domain=NSURLErrorDomain Code=-999 "cancelled" UserInfo={NSErrorFailingURLStringKey=https://example.com/appcast.xml, NSErrorFailingURLKey=https://example.com/appcast.xml, _NSURLErrorRelatedURLSessionTaskErrorKey=(
    "LocalDownloadTask <BB2AE4EF-8E93-44D7-9AB3-6EE9A9E3ACF8>.<1>"
), _NSURLErrorFailingURLSessionTaskErrorKey=LocalDownloadTask <BB2AE4EF-8E93-44D7-9AB3-6EE9A9E3ACF8>.<1>, NSLocalizedDescription=cancelled} [-999]
2018-12-14 12:49:20 -06:00
Daniel Jalkut 2e1596c673 A recent merge with master caused the CLANG_WARN_COMMA warning to be enabled, which generates warnings in this ui-separation-and-xpc only file. I thought it would be safest to use #pragma clang diagnostic ignore to quiet the warnings without changing the source file in this file. (#1314) 2018-11-14 17:26:10 +00:00
Kornel 0a13dfab4a Workaround for Security.framework not supporting better keys 2018-11-13 13:39:32 +00:00
Daniel Jalkut 96eb45efdc Quiet a warning about a missing @synthesize for observingAppearance property. (#1312) 2018-11-11 15:42:30 +01:00
Kornel 1784fc1a72 Merge remote-tracking branch 'origin/ui-separation-and-xpc' into ui-separation-and-xpc
* origin/ui-separation-and-xpc:
  Fix unit tests (#1311)
2018-11-11 14:23:42 +00:00
Kornel 832902cea7 Merge tag '1.20.0' into ui-separation-and-xpc
* tag '1.20.0': (28 commits)
  Bump
  Fix binary delta creation on network drives
  New Spanish localisation
  Fix compilation issues on Xcode 10 with new build system
  Bump
  Updated readme to indicate that the 10.11 SDK is required to compile Xcode 7 was released with 10.11, the reference to the 10.8 SDK is out of date.
  Explicitly specify types to silence "Messaging unqualified id" warning that's new in Xcode 10. Removed __has_feature(objc_generics) check and use generisc to help silence the warnings.
  Updated Finnish language resources
  Remove executable bit on distributed source files.
  Fix potential hang with dispatch_sync to main thread
  Deliver SPUDownloaderSession delegate messages on the main queue
  add tips for user to install doxygen
  add delegate callbacks for fininshed download and extraction related events
  Restored legacy CLI for backward compatibility
  Fixed index out of bounds
  More complex argument parsing to support both inputs
  Function to load the private key directly from the keychain
  Minor naming improvement
  Bump
  Explain why auth is requested
  ...
2018-11-11 14:21:37 +00:00
Kornel 2121a7d9f2 Merge tag '1.19.0' into ui-separation-and-xpc
* tag '1.19.0': (44 commits)
  Ensure cocoapods is installed before performing the release “sanity check” (#860)
  Silence ‘This block declaration is not a prototype’ Xcode warning
  Silence ‘decodeObjectOfClass:forKey: is only available on macOS 10.8’ Xcode warnings, similar to commit ea94969188
  10.7 compatibility
  Avoid invalid use of main thread
  Update wording of read-only error
  Improve 'read-only' error message (#1192)
  "all" target
  Hidden verbose flag
  Outdated comment
  Amend to avoid gender issue
  Changelog
  Bump
  move Xcode 9.2 automatic changes from project to xcconfig files
  Bring project up to Xcode 9.2 settings
  silence 10.9 availability and other warnings and use modules when available
  Ensure UI is changed only on the main thread
  nil checks
  Fix typo in expectation description
  Finish tests for persistent download
  ...
2018-11-11 14:18:07 +00:00
Daniel Jalkut ad0ea07252 Fix unit tests (#1311)
* Quiet warnings from Swift compiler: "Using '!' here is deprecated and will be removed in a future release"

* Ignore diagnostics that yield 'messaging unqualified id' warnings when calling XCTAssertNotEqualObjects. I have filed a bug with Apple, Radar #45968630, requesting that they quiet the warning internally to the macro implementation.

* When setting the access time on a directory and its contents, set the access time on the directory last so that it will be guaranteed to match the expected value. There is a side-effect of calling getFileSystemRepresentation that it sets the access time of its container folder, presumably because of an implementatiton detail of how Foundation builds up the path. Note there is another problem here that the order of items from NSDirectoryEnumerator is undefined, so some of the interior items of a directory will undoubtedly end up getting slightly varying access times set upon them. However, for the purposes of Sparkle's use of this method to "keep things alive" in /tmp, I don't think there is an issue. This fix addresses a failing unit test testUpdateFileAccessTime, which was failing because of very slight differences in access time created by the problem described.
2018-11-11 13:10:12 +01:00
Kornel 45d27cc5d0 Safety-check around observing appearance
#1307
2018-11-09 16:55:51 +01:00
Kornel 34e96171f3 Merge pull request #1306 from teologov/ui-separation-and-xpc-fix-make-release
Fix make release script.
2018-11-09 15:39:42 +00:00
Andrey Teologov b3fa1fc904 fixed make-release-package.sh failure 2018-11-09 08:20:30 +02:00
Kornel 3cb3eb55ec Merge pull request #1304 from danielpunkass/improved-install-instructions
Improved install instructions
2018-11-07 22:51:45 +00:00
Kornel bcb943a093 Merge pull request #1305 from danielpunkass/app-extension-safe-api
Define APPLICATION_EXTENSION_API_ONLY = NO
2018-11-07 22:50:22 +00:00
Daniel Jalkut be29f66ddd Define APPLICATION_EXTENSION_API_ONLY = NO. As long as we don't ourselves depend upon any Frameworks that are incompatible with Application Extensions, then we should allow frameworks that require compatibility to be able to link with us. 2018-11-07 17:38:37 -05:00
Daniel Jalkut 2f6587f5a6 Add a note in Usage to indicate additional configuration is required for Sandboxed apps. 2018-11-04 12:53:41 -05:00
Daniel Jalkut 01bacb9647 Another backwards-coded Markdown link. 2018-11-04 12:51:08 -05:00
Daniel Jalkut 75b7066a6e Add two other XPC services that seems to be required by most if not all sandboxed apps. I am not 100% sure I understand the role yet of these but as an instructional document this gets at the requirements in a way that is better than nothing. 2018-11-04 12:16:13 -05:00
Daniel Jalkut 5bf8730c6b I had the Markdown link backwards. 2018-11-04 12:11:36 -05:00
Daniel Jalkut 05393a8223 Trying to fix links 2018-11-04 12:10:50 -05:00
Daniel Jalkut 8f65c07a1a Remove links to the zorgiepoo issues database because zorgiepoo indicated surprise about people still coming there, and because issues are being tracked in the main repository's issues. 2018-11-04 12:07:53 -05:00
Daniel Jalkut fbbb44bf73 Add links to the INSTALL document to make it easier to access. 2018-11-02 15:38:08 -04:00
Daniel Jalkut 9b960233ca Taking a stab at rewriting some of the instructional content to be more clearly understood by folks just getting familiar with the XPC version of the project. Removed the 'Requirements' section because it's out of date with the README and doesn't need to be listed redundantly. 2018-11-02 13:34:06 -04:00
Daniel Jalkut 9e67ef244b Change to Markdown style headings. 2018-11-02 13:12:48 -04:00
Daniel Jalkut 43b5382daf Rename INSTALL to INSTALL.markdown so it will present as a readable file on GitHub. 2018-11-02 13:09:57 -04:00
Kornel dbcdd76da2 Merge pull request #1294 from michelf/ui-separation-and-xpc
releaseNotesView must be strong if we attach an observer to it
2018-10-09 08:57:09 +01:00
Michel Fortin b9328cc466 releaseNotesView must be strong if since we're attaching an observer to it. 2018-10-08 15:25:20 -04:00
Kornel 8ba29aa40d Merge pull request #1293 from ksuther/effectiveAppearance-observation
Only observe effectiveAppearance on 10.14 or later
2018-10-08 18:59:23 +01:00
Kent Sutherland 467325bc21 Only observe effectiveAppearance on 10.14 or later
Observing WebView is crashing on 10.12 when SUUpdateAlert gets released even though removeObserver is called in dealloc
2018-10-08 11:10:53 -05:00
Kornel 7e351b52c7 Merge pull request #1288 from michelf/ui-separation-and-xpc
Dark Mode Release Notes Complement
2018-09-15 18:56:27 +01:00
Michel Fortin 20d5b4e003 Setting darkBackgroundView to nil when adapting for light mode so it gets recreated later if we re-enter dark mode. 2018-09-15 09:59:47 -04:00
Michel Fortin 077e2b155f Avoid checking appearance by name, use bestMatchFromAppearancesWithNames for future-proofing. 2018-09-15 09:47:37 -04:00
Michel Fortin 3ed5f3875b React to effective appearance changing. 2018-09-15 09:45:54 -04:00
Kornel 34fe3b52ff Merge pull request #1281 from michelf/ui-separation-and-xpc-prompt-fr
Fixing cut text in prompt window (French)
2018-08-27 10:36:25 +01:00
Michel Fortin 6daa5e152b Adjusting French text above the system profile table view so it fits. 2018-08-26 19:04:21 -04:00
Michel Fortin e6d9a01316 The "include anonymous system profile" checkbox is not wide enough for its French content. 2018-08-26 18:51:38 -04:00
Kornel 502378553e Merge pull request #1280 from michelf/ui-separation-and-xpc-darkmode
Showing release notes with dark appearance according to the system theme
2018-08-26 23:13:29 +01:00
Michel Fortin 64eb13672d Showing release notes with dark appearance according to the system theme.
This is done by applying a user stylesheet, making the background of the WebView transparent, and using a NSBox to display the dynamic dark background color. The appearance of the release notes will unfortunately not adapt if the theme is changed while the release notes window is open.
2018-08-26 11:51:10 -04:00
Kornel e40628a78f Merge pull request #1273 from rob-patchett/ui-separation-and-xpc
Adds an option to turn off hideOnDeactivate in SPUStandardUserDriver for foreground apps
2018-07-25 14:11:56 +01:00
Robert Patchett a8528a256b Add an option to turn off hideOnDeactivate in SPUStandardUserDriver for forground apps 2018-07-25 14:46:37 +02:00
Kornel cc94d66994 Merge pull request #1252 from ksuther/ui-separation-and-xpc
Silence Xcode 10 "Messaging unqualified id" warnings by specifying types (XPC branch)
2018-06-14 23:26:09 +03:00
Kent Sutherland 4bcaee7213 Updated readme to indicate Xcode 7 or later is required. 2018-06-14 21:22:39 +02:00
Kent Sutherland d574574345 Explicitly specify types to silence "Messaging unqualified id" warning that's new in Xcode 10.
Removed __has_feature(objc_generics) check and use generisc to help silence the warnings.
2018-06-14 21:22:38 +02:00
Kornel 89ce79488c Merge pull request #1238 from aonez/aone-ui-separation-and-xpc
Download process string updated to match master
2018-05-28 11:17:02 +01:00
aone b3ecc89f11 Download process string updated to match master 2018-05-28 10:09:05 +02:00
Kornel 67320fcb80 Merge pull request #1184 from ksuther/downloadSession-leak
Fixed SPUDownloader leak
2018-02-15 23:07:30 -08:00
Kent Sutherland 3bf3096369 Fixed SPUDownloader getting leaked because the NSURLSession wasn't being invalidated 2018-02-15 22:52:20 -06:00
Kornel 6cd66a4db9 Merge pull request #1183 from charlieMonroe/patch-1
Fixing build error when some enclosing folder contains a space.
2018-02-15 09:15:03 -08:00
charlieMonroe 3fd5e2315b Fixing build error when some enclosing folder contains a space.
I personally have my projects on iCloud Drive which contains a space in the path (`~/Library/Mobile Documents/...`) and the build fails running these two scripts.
2018-02-15 09:53:55 +01:00
Kornel 0093e2f1c9 Merge pull request #1170 from kolpanic/ui-separation-and-xpc
Check if cocoapods is installed
2018-01-04 18:18:08 +00:00
Karl Moskowski 17fc6dbe89 Ensure cocoapods is installed before performing the release “sanity check” (#860) 2018-01-04 09:03:59 -05:00
Kornel ad506261ee Merge pull request #1162 from ksuther/synthesize-warning
Fixed an auto-synthesis warning
2017-12-10 19:14:09 +00:00
Kent Sutherland 1e31d849f5 Fixed an auto-synthesis warning 2017-12-10 13:02:48 -06:00
Kornel e30d1b9f68 Merge pull request #1161 from ksuther/sign-with-hyphen
Run codesign when signing identity is a hyphen
2017-12-08 17:51:27 +00:00
Kent Sutherland 3ec3d6f2af Run codesign when signing identity is set to "-"
This creates an adhoc signature rather than not signing
2017-12-08 11:42:58 -06:00
Kornel abb6e28a9f Merge pull request #1160 from ksuther/shell-script-fixes
Shell script fixes
2017-12-08 01:09:50 +00:00
Kent Sutherland f42ceec378 Check for a signing identity of "-" when building Sparkle Test App 2017-12-07 19:07:02 -06:00
Kent Sutherland 4565467287 Shell script fixes (warnings flagged by shellcheck)
Don't call codesign in set-agent-signing if the identity is "-"
2017-12-07 17:32:28 -06:00
Kornel 8b47c5db71 Fixed target variable 2017-12-06 17:46:00 +00:00
Kornel 30ab76da03 Merge pull request #1134 from ProsoftEngineering/NSURLSession
Replace NSURLDownload with NSURLSession
2017-10-04 20:38:23 +01:00
Brian Bergstrand a3cc5f8b5d Replace NSURLDownload with NSURLSessionDownloadTask 2017-10-04 12:52:47 -05:00
Brian Bergstrand 218315ffce Bump min OS version for NSURLSession requirement 2017-10-04 12:49:35 -05:00
Kornel 648f8c960d Merge pull request #1128 from ksuther/ui-separation-and-xpc
Merged master into ui-separation-and-xpc
2017-09-19 19:36:10 +01:00
Kent Sutherland 4c27d7bf73 Merge branch 'master' into ui-separation-and-xpc 2017-09-18 22:39:17 -05:00
Kornel d41c8b3e60 Merge pull request #1127 from ksuther/xcode9-warning
Silence Xcode 9 warning
2017-09-18 23:05:31 +01:00
Kent Sutherland 5aea901ab6 Silence Xcode 9 warning 2017-09-18 12:21:57 -05:00
Kornel 08f19f0330 Merge pull request #1120 from ksuther/fix-scheduled-includesSkippedUpdates
Fix for Skip This Updates button not working in XPC branch
2017-08-16 23:43:00 +01:00
Kent Sutherland 618fd6e85a includesSkippedUpdates was set to YES in SPUScheduledUpdateDriver
This was causing the Skip This Version button to not work when a background update check ran.
This was introduced in 47f08be1a.
2017-08-16 12:17:01 -04:00
Kornel 7b3c3b7e58 Merge remote-tracking branch 'origin/master' into ui-separation-and-xpc
* origin/master: (21 commits)
  Bump
  Update Xcode version for Travis CI
  Fix for the timing issue of termination detection.
  Add optional updaterDidRelaunchApplication: method on SUUpdaterDelegate (#1115)
  Better error message
  Warning
  Update to Xcode 9/Swift 4
  Revert "Ensure UI code always runs on the main thread"
  Update German localization with some terminology changes
  Update German localization for informal style
  Update Dutch localization for informal style
  Update Dutch localization with some style changes
  Include bin files in CocoaPods installation
  Simplified check
  Rename OSX macOS
  [BasicUpdateDriver] - extend hostSupportsItem method to also check the sparkle:os attribute from the enclosure element to decide if an update item is valid for the host
  [AppcastItem] - parse and save the sparkle:os attribute of the enclosure element and add isOsxUpdate method to item class
  Updated Japanese translation to reflect change on 55be13c
  Updated translation to reflect change on “Update error message to mention temp folders rather than optical drives”.
  Changelog
  ...
2017-08-14 13:38:16 +01:00
Kornel f27416c97c Merge pull request #1117 from mentalfaculty/studies
Added a timer invalidation in a asynchronous callback.
2017-08-10 13:45:18 +01:00
Drew McCormack ab942fa9b7 Added a timer invalidation in a asynchronous callback.
The scheduleNextUpdateCheckFiringImmediately: method includes an asynchronous callback. It invalidates the timer before invoking the method with the callback (retrieveNextUpdateCheckInterval:), but doesn’t not invalidate again inside the callback block.

The problem with this is that it is possible the timer is started during the delay. In release versions of an app, crashes have been seen due to an assertion that the NSTimer be nil when scheduling.

The proposed fix is to invalidate the timer in the callback, ensuring the NSTimer is nil before scheduling.
2017-08-10 10:19:01 +02:00
Kornel c3c2e51a08 Merge pull request #1091 from ksuther/remove-unused-function
Remove unused escapeURLComponent
2017-06-10 23:38:38 +01:00
Kent Sutherland d11eb126a1 Remove unused escapeURLComponent 2017-06-10 17:29:07 -05:00
Kornel fa7235c54e Merge pull request #1090 from ksuther/init-for-spustandardupdatercontroller
Added initWithUpdaterDelegate:userDriverDelegate: to SPUStandardUpdaterController
2017-06-09 23:32:00 +01:00
Kent Sutherland ed1e6031b6 Added initWithUpdaterDelegate:userDriverDelegate: to SPUStandardUpdaterController 2017-06-09 12:26:18 -05:00
Kornel 7fc20434b9 Merge remote-tracking branch 'origin/master' into ui-separation-and-xpc
* origin/master:
  Don't assume that the progress block exists (the parameter is nullable)
  Prepend app name to Autoupdate.app name
  Error message tweak
  Update error message to mention temp folders rather than optical drives
  1.18.0
  Log more errors
  Unify handling of aborted updates
2017-06-02 12:07:36 +01:00
Kornel 415b4fe164 Merge commit '60727bffa53ebfbfaf701575904847827bc1656a' into ui-separation-and-xpc
* commit '60727bffa53ebfbfaf701575904847827bc1656a':
  Log key read failure
  Formatting
  Escape + as well
  Escape profile URLs better
  Special case for .tar.gz extension
  Inline release notes if they don't look like a standalone HTML document
  Simplify release notes link check
  Feed formatting
2017-04-24 18:10:35 +01:00
Kornel Lesiński 2d30762570 Merge remote-tracking branch 'origin/master' into ui-separation-and-xpc
* origin/master: (39 commits)
  %s is deliberate in this format string
  Unused
  Make generate_appcast available as a shared scheme
  Shush Xcode
  Link straight to docs from the readme
  ignore .html files when scanning for archives
  Missing strings translation.
  Updated swift
  Warn against abusing installUpdatesIfAvailable
  when generating the appcast, if an .html file exists of the same name as the archive, then it will be linked in as the releaseNotesLink
  Revert "Fix pt_BR translations"
  Revert "Fix pt_BR translations (#1039)"
  Fix Japanse localization
  Add more info to auth tool run failure
  Fix pt_BR translations (#1039)
  Fix pt_BR translations
  Disable the keyboard shortcut for the install button for scheduled updates to avoid accidental installs.
  added `sparkle:shortVersionString` to the enclosure, #1032
  Changelog
  percent encode the filename used in the delta url
  ...
2017-03-24 12:14:05 +00:00
Zorg a4eefe6725 Move SPUUpdateDriver.h up in the Xcode project 2017-01-20 22:09:41 -05:00
Zorg 934f9e2c32 Add some documentation to internal SPUUpdateDriver 2017-01-20 22:09:19 -05:00
Zorg 446df27354 Document why the user driver API was designed the way it was 2017-01-20 21:00:05 -05:00
Zorg b24ea83d0f Merge branch '1.17.x' into ui-separation-and-xpc 2017-01-20 20:50:28 -05:00
Zorg aaac6cd594 Document TerminationListener a bit 2017-01-19 23:14:08 -05:00
Zorg a000e3b311 Handle listening for termination of already-dead processes
Before our TerminationListener didn't handle a process that has already been terminated. In my fork this is unlikely to be an actual issue but in master, the application can very well be dead before the termination listener initiates.
2017-01-19 23:11:20 -05:00
Zorg dc02d2d614 Merge branch 'master' into ui-separation-and-xpc 2017-01-18 19:55:39 -05:00
Zorg 7a1e396530 Merge branch '1.17.x' into ui-separation-and-xpc 2017-01-17 19:13:30 -05:00
Zorg dfaed624ae Merge branch 'master' into ui-separation-and-xpc 2017-01-17 15:58:02 -05:00
Zorg 9dd4d46bb9 Merge branch 'master' into ui-separation-and-xpc 2017-01-16 20:08:56 -05:00
Zorg 0c7db7f24d Remove ask for updater permission changes from Read Me
This no longer differs from master's current behavior.
2017-01-16 16:23:00 -05:00
Zorg a34102a140 Revert back to asking for updater permission on 2nd launch
I don't think I have a great justification anymore for waiting more than 'x' hours. This may just be an artifact when I was initially architecting Sparkle so that the entire framework could be stuffed into an XPC service.
2017-01-16 16:20:36 -05:00
Zorg 0b32116f65 Merge branch '1.17.x' into ui-separation-and-xpc 2017-01-16 15:17:16 -05:00
Zorg fdebf50f81 Merge branch 'master' into ui-separation-and-xpc 2017-01-15 20:21:49 -05:00
Zorg 62c9a8c785 Merge branch '1.17.x' into ui-separation-and-xpc 2017-01-12 21:50:14 -05:00
Zorg 6a4f1e6340 Merge branch 'master' into ui-separation-and-xpc 2017-01-12 21:13:24 -05:00
Zorg d980fe8783 Merge branch 'master' into ui-separation-and-xpc 2017-01-12 21:12:50 -05:00
Zorg 5cff3cd543 Change network service type to background where appropriate 2017-01-10 18:42:33 -05:00
Zorg 866fbfe4fd Remove bullet points in ReadMe that are less relevant now
Either they're merged in master now or are in the process of being merged soon.
2017-01-09 00:02:32 -05:00
Zorg c543edf6f6 Update graph of sparkle image 2017-01-08 23:56:31 -05:00
Zorg 930346d24b Remove unused header that must have been added from master 2017-01-08 23:54:20 -05:00
Zorg 55b586f4dc Split resumable updates type into downloadable and info update types 2017-01-08 23:42:25 -05:00
Zorg 4c01a69870 Rename SPUDownloadedUpdate -> SPUResumableUpdate
A resumable update isn't necessarily a downloaded update now, due to informational only updates.
2017-01-08 23:12:23 -05:00
Zorg 604d3f578a Use -[SUHost objectForInfoDictionaryKey:] in couple more places 2017-01-08 09:23:15 -05:00
Zorg 005a9a069e Merge branch 'master' into ui-separation-and-xpc 2017-01-07 23:26:57 -05:00
Zorg 2bb5ce4318 Make SUBundleIcon & SUApplicationInfo take SUHost, not NSBundle
When we retrieve the "CFBundleIconFile" key from the Info dictionary, we should rely on SUHost's method of obtaining that value now.
2017-01-07 22:55:13 -05:00
Zorg b645005689 Improve -[SUHost objectForInfoDictionaryKey:]
We use the cached host bundle if the host bundle is equal to the main bundle.
Otherwise we read in the latest Info dictionary every time.

The cached case is the most common case. The odd case (updating other bundles) is less common. Thus we have better performance for the common case, and we retain correct code in both cases.
2017-01-07 22:32:08 -05:00
Zorg 3b2ea83c6f Fix latest analyzer warnings 2017-01-07 11:22:13 -05:00
Zorg 874ec099b9 Merge branch 'master' into ui-separation-and-xpc 2017-01-07 11:13:40 -05:00
Zorg 23011345cb Add SUOperatingSystem.m to generate_appcast since SULog now needs it 2017-01-06 22:29:03 -05:00
Zorg f04c73445e Document logging levels 2017-01-06 12:59:01 -05:00
Zorg 36fd5a8bbd Add some comments to SULog.h/m 2017-01-05 23:19:28 -05:00
Zorg 31cfbbccd9 Change around SULog.m #include's 2017-01-05 23:15:59 -05:00
Zorg af0a88dab3 Remove private _SULogDisableStandardErrorStream() function
When using ASL, don't log to stderr if a terminal is attached. This behavior closely matches os_log()
2017-01-05 23:09:58 -05:00
Zorg e1a4ad9371 Add level parameter to SULog()
Current levels are: default and error
2017-01-05 22:51:36 -05:00
Zorg 36e7cf263c Use os_log API for errors instead of ASL if it's available 2017-01-05 21:23:16 -05:00
Zorg 19df2867af Merge branch 'master' into ui-separation-and-xpc 2017-01-03 22:19:21 -05:00
Zorg 5ce1d7b3dc Merge branch 'master' into ui-separation-and-xpc 2017-01-02 18:12:01 -05:00
Zorg dca2114934 Add user driver method to show informational only updates
This will increase the chance of a user driver implementing being able to show informational only updates. Also it's better to use a new method rather than re-use another existing one inappropriately.
2017-01-02 18:00:17 -05:00
Zorg c25f127188 Merge branch 'master' into ui-separation-and-xpc 2017-01-01 22:45:28 -05:00
Zorg 2001328032 Add user driver docs & handling for showing informational updates
Perhaps I should add another method to the user driver for showing informational updates in the near future.
2017-01-01 22:22:07 -05:00
Zorg 9d354e5606 Improve title text of update alert for normal & informational updates 2017-01-01 21:38:39 -05:00
Zorg ad43a6d0c9 Informational only updates shouldn't be presented as downloadable 2017-01-01 21:38:08 -05:00
Zorg 0bb3ab51b3 Handle informational only updates from the automatic update driver
The automatic update driver defers the informational only update & aborts, allowing a scheduled UI driver to resume it. The automatic update driver aborts before the point an update would normally be downloaded.
2017-01-01 21:22:02 -05:00
Zorg 27a24a5413 Make sure downloader progress doesn't exceed expected max progress 2016-12-29 11:46:17 -05:00
Zorg e3f68b70bf Prefer using HTTP expected content length over appcast item length
Also use (u)int64_t instead of NS(U)Integer
2016-12-29 11:11:05 -05:00
Zorg a82f5acdd6 Sort the project file using webkit's script:
https://github.com/WebKit/webkit/blob/master/Tools/Scripts/sort-Xcode-project-file

This may help with mergability a bit.
2016-12-28 21:28:16 -05:00
Zorg e463ed4bcb Merge branch 'master' into ui-separation-and-xpc 2016-12-28 21:19:40 -05:00
Zorg 52397d616f Download response may not return expected length for a smaller part 2016-12-28 12:54:05 -05:00
Zorg 47b1c8a9a2 Expected content length from http header should not be accumulated 2016-12-28 12:39:18 -05:00
Zorg 6d69b1215d Prevalidation is mostly merged into master now 2016-12-27 17:51:33 -05:00
Zorg 7609068886 Sync unit test configuration files to be similar to master branch 2016-12-27 17:47:47 -05:00
Zorg f7d9e44ab6 Xcode fixing its project file again 2016-12-27 15:41:21 -05:00
Zorg ab64d8d19f Merge branch 'master' into ui-separation-and-xpc 2016-12-27 15:38:13 -05:00
Zorg 76013ba66c Merge branch 'master' into ui-separation-and-xpc 2016-12-27 15:32:56 -05:00
Zorg cba7f51132 Merge branch 'master' into ui-separation-and-xpc 2016-12-27 10:29:33 -05:00
Zorg e3a467b126 Rename update permission prompt & nib to use SU prefix 2016-12-27 10:06:41 -05:00
Zorg 9fa601c08f Remove old SUAutomaticUpdateAlert strings 2016-12-27 09:03:56 -05:00
Zorg 29ef0150b5 Use [NSApplication sharedApplication] instead to match master 2016-12-26 21:07:21 -05:00
Zorg 65c0c1e7fe Move code from SPUInstallerValidation.m to SUUpdateValidator.m 2016-12-26 21:01:47 -05:00
Zorg b482f55e46 Merge branch 'master' into ui-separation-and-xpc 2016-12-26 19:30:28 -05:00
Zorg 36ed896d0f Rename SPUInstallerProtocol -> SUInstallerProtocol, remove -cleanup
This is to prepare for the next merge from master.
2016-12-26 19:12:02 -05:00
Zorg fd533f937e Don't pass version comparator to SUInstaller 2016-12-26 13:03:20 -05:00
Zorg d362caac98 Rename applicationPath to bundlePath in SUPlainInstaller
This is less confusing. I also documented the SUPlainInstaller initializer method.
2016-12-26 12:58:26 -05:00
Zorg cc77f11e22 Use self instead of [self class] to refer to class method 2016-12-26 11:17:27 -05:00
Zorg 55bc22b1ae Merge branch 'master' into ui-separation-and-xpc 2016-12-26 11:04:56 -05:00
Zorg 66e5460208 Remove some specific deprecated markings in SUUpdaterDelegate.h
The entire protocol is deprecated anyway.
2016-12-26 10:43:21 -05:00
Zorg bd6df5b707 Add nullability annotations to SUUpdaterDelegate.h 2016-12-26 10:35:28 -05:00
Zorg f656bf5068 Clarify where this delegate method exists 2016-12-24 21:42:54 -05:00
Zorg 2a612f450e Merge branch 'master' into ui-separation-and-xpc 2016-12-24 21:34:49 -05:00
Zorg 853a0ecd82 Use SU prefix for ApplicationInfo and BundleIcon classes
This is to hopefully make merging recent changes from master easier.
2016-12-24 21:19:20 -05:00
Zorg 1943d971fc Remove SUParameterAssert.h since I removed it in master 2016-12-23 19:17:17 -05:00
Zorg 8aada73941 Merge branch 'master' into ui-separation-and-xpc 2016-12-23 19:14:27 -05:00
Zorg ae35c09624 Fix update validation code from recent merge for pkg updates 2016-12-23 14:58:31 -05:00
Zorg fe79d29665 Merge branch 'master' into ui-separation-and-xpc 2016-12-23 14:50:54 -05:00
Zorg 553168ba51 Merge branch 'master' into ui-separation-and-xpc 2016-12-23 14:44:32 -05:00
Zorg 2c1e996fab Update comments 2016-12-22 09:36:37 -05:00
Zorg b28fd2410d Mark SPUInstallerValidation and SUUpdateValidator as daemon-safe 2016-12-20 22:00:54 -05:00
Zorg 35ef590f2b Update graph of sparkle image in documentation 2016-12-20 21:50:21 -05:00
Zorg 574c0f63ca Add documentation files to Xcode project group 2016-12-20 21:48:06 -05:00
Zorg b6b554e830 Appcast instance cannot be nil here. 2016-12-20 20:54:35 -05:00
Zorg d5e54005ce Fix static analyzer warning by marking method return type as nullable 2016-12-20 20:47:59 -05:00
Zorg 09da99f4cf Merge branch 'master' into ui-separation-and-xpc 2016-12-20 20:23:07 -05:00
Mayur Pawashe 07b9b71f8f Merge pull request #2 from ksuther/ui-separation-and-xpc
Fixed retain cycle between SPUBasicUpdateDriver and SUAppcastDriver
2016-12-19 11:40:19 -05:00
Kent Sutherland 70af94624d Fixed retain cycle between SPUBasicUpdateDriver and SUAppcastDriver 2016-12-15 15:56:36 -06:00
Zorg 9ea4cf1bf6 Merge branch 'master' into ui-separation-and-xpc 2016-12-04 17:05:01 -05:00
Zorg fee1b0c126 Mention ABI compatibility specifically 2016-12-03 22:41:43 -05:00
Zorg 2c9d44a341 Improve documentation wording for setFeedURL: 2016-12-03 22:23:48 -05:00
Zorg 9392e3260a Comment style changes 2016-12-03 22:19:13 -05:00
Zorg eb78f61f41 Annotate that -[SPUUpdater setFeedURL:] can take nil as a value 2016-12-03 22:15:08 -05:00
Zorg a6abd1c206 Specify nonatomic in SPUUpdater and SUUpdater where applicable. 2016-12-03 22:00:12 -05:00
Zorg 7b0d0d8909 Merge branch 'master' into ui-separation-and-xpc 2016-12-03 21:50:33 -05:00
Zorg 7783e9f704 Merge branch 'master' into ui-separation-and-xpc 2016-11-11 19:28:02 -05:00
Zorg 8106aa8700 Merge branch 'master' into ui-separation-and-xpc 2016-11-10 15:57:25 -05:00
Zorg efd39a31e9 Remove Makefile-icon 2016-11-03 16:11:59 -04:00
Zorg f46d4b7c4d Mark startUpdater method as being invoked on main thread only 2016-11-03 15:29:25 -04:00
Zorg 5a7462e5b9 Remove the optimized Sparkle.icns that was merged from master
This branch doesn't have Sparkle bundle an icon in the first place.
2016-11-03 15:22:48 -04:00
Zorg 8e7cb0ac79 Merge branch 'master' into ui-separation-and-xpc 2016-11-01 19:46:30 -04:00
Zorg c72efdfb34 Merge branch 'master' into ui-separation-and-xpc 2016-10-31 21:49:00 -04:00
Zorg e2adfd2617 No need to have debug warning in SUUpdater when one is in SPUUpdater
This came from a recent merge.
2016-09-17 09:17:51 -04:00
Zorg 2d4568671c Remove unused 'Invalidate Connection' menu item in Test App 2016-09-16 23:16:32 -04:00
Zorg 6b452b2861 Move swift build settings to xcconfig files 2016-09-16 15:22:19 -04:00
Zorg 163158cacf Merge branch 'master' into ui-separation-and-xpc 2016-09-16 15:08:04 -04:00
Zorg a0ced6018d Update ReadMe 2016-09-05 13:58:59 -04:00
Zorg f36e7a46cd Merge branch 'master' into ui-separation-and-xpc
Updating some documentation
2016-09-05 13:48:25 -04:00
Zorg fd4ff8a6e7 Merge branch 'master' into ui-separation-and-xpc 2016-09-04 23:52:40 -04:00
Zorg 1a5cf6e48f Add @import Foundation handling for SPUStatusCompletionResults.h 2016-09-04 23:49:41 -04:00
Zorg 17277b1f77 Merge updater delegate installer interaction allowed methods 2016-09-04 22:57:59 -04:00
Zorg 30d4a5eb5c Merge code sign test changes from master 2016-09-04 18:23:23 -04:00
Zorg def9a599a3 More SU -> SPU renaming
Some of these class names conflicted with the official branch even though they are almost nothing like code-wise now.
2016-09-04 18:21:41 -04:00
Zorg 32373e8185 Use -[NSURL checkResourceIsReachableAndReturnError:] in tests
This avoids nullability warnings when converting NSURL -> NSString path
2016-09-03 22:56:38 -04:00
Zorg 213bedfa37 Merge branch 'master' into ui-separation-and-xpc 2016-09-03 22:50:25 -04:00
Zorg d3ebffb267 Update header documentation for SPUUpdater/SPUUpdaterDelegate 2016-08-30 00:33:03 -04:00
Zorg b911b8c540 Use @import module syntax in exported headers if available
This will decrease compiler warnings to module-based projects that include Sparkle.
2016-08-29 23:59:10 -04:00
Zorg cc38a3d7a6 Pass user initiated flag when update is found to the user driver
This is better than the hack in the previous commit. Also, a user driver may very well want to act differently in showing UI if the user initiated the update check.
2016-08-29 00:31:29 -04:00
Zorg f9a2c7a450 Let user driver know if resume update checks are user initiated 2016-08-29 00:04:23 -04:00
Zorg f5a79ecc79 Merge branch 'master' into ui-separation-and-xpc 2016-08-28 09:42:05 -04:00
Zorg 64bf8d02e2 Remove note about removing mdimport since it's been merged in master 2016-08-28 00:11:07 -04:00
Zorg 325059484f Only log missing 'length' warning once per all appcast item instances 2016-08-27 23:58:01 -04:00
Zorg 56cd205880 Merge branch 'master' into ui-separation-and-xpc 2016-08-27 22:46:14 -04:00
Mayur Pawashe 021c1a7803 Merge pull request #1 from michelf/ui-separation-and-xpc
Fixing memory leak transferring dictionary to ARC
2016-08-27 14:17:58 -04:00
Zorg 4d13c54d4c Merge branch 'master' into ui-separation-and-xpc 2016-08-27 13:54:20 -04:00
Zorg 7c49f722a8 Merge branch 'master' into ui-separation-and-xpc 2016-08-27 11:34:42 -04:00
Michel Fortin 5f255c4865 Fixing memory leak where transferring of property dictionary to ARC. 2016-08-27 11:20:34 -04:00
Zorg fb2aea0d86 Fix normalization relaunch path setting and improve relaunching code
SPARKLE_NORMALIZE_INSTALLED_APPLICATION_NAME=1 now works properly again. In the progress agent, we don't use the path sent from the installer unless the normalized setting is enabled.
2016-08-27 10:40:38 -04:00
Zorg 251feb7e07 Rename registerRelaunchBundlePath to registerApplicationBundlePath 2016-08-27 02:24:37 -04:00
Zorg 6f337aa6f3 Remove outdated comment about command key being held down in test app 2016-08-26 22:32:49 -04:00
Zorg 9b4aaef3dd Update documentation on -[SPUUserDriver dismissUpdateInstallation] 2016-08-26 18:58:59 -04:00
Zorg 2548057da8 Clarify why installer has handling for timeouts 2016-08-26 18:46:25 -04:00
Zorg fb5c577dad Update comment to reflect what occurs after sending stage 2 request 2016-08-26 18:35:52 -04:00
Zorg db642a0700 Fix relaunching if multiple instances of app were running
We leave the "application was alive and needs to terminate logic" to the progress agent rather than to the installer too.
2016-08-26 18:23:42 -04:00
Zorg 328a445b5c Clarify that the agent tool shouldn't monitor processes' death 2016-08-26 18:01:44 -04:00
Zorg fbad9e466f Update installation document to include termination, SU->SPU changes 2016-08-26 01:47:57 -04:00
Zorg 44b70bb16c Remove SPUApplicationIcon and merge it into SPUApplicationInfo
Every component that needed SPUApplicationIcon also needed SPUApplicationInfo
2016-08-26 01:08:06 -04:00
Zorg 46a75cde97 Terminate application in the progress agent instead of user driver
This allows us to remove SPUUserDriverUIComponent and remove a bunch of logic in the user driver regarding termination. The user drivers generally don't need to know about the application bundle anymore, and strictly now only show UI events.

This has another advantage of the agent being able to quit multiple instances of an application even if the application to update is sandboxed.

We enforce the logic that an application can only be relaunched if it was running initially.
2016-08-25 23:46:42 -04:00
Zorg 27ea7ca2f5 Implement new allow installer interaction methods in sparkle-cli 2016-08-21 18:58:11 -04:00
Zorg b8d1ac45c3 Clarify that interaction also allows installer UI to show up 2016-08-21 18:46:03 -04:00
Zorg b1fa9efa24 Distinguish initiated vs scheduled updates for allowing interaction 2016-08-21 15:58:33 -04:00
Zorg 6a8680464b Pass installer interaction flag to drivers and use delegate once 2016-08-21 15:14:47 -04:00
Zorg 55d58a2203 Add SparkleCore to make-release-package.sh 2016-08-21 11:24:09 -04:00
Zorg f62f7fa1b8 Add localization scripts to SparkleCore 2016-08-21 02:33:19 -04:00
Zorg 5f0f964c65 Merge branch 'sparkle-core' into ui-separation-and-xpc 2016-08-21 02:17:42 -04:00
Zorg f9c87d76db Fix SparkleCore build issues in Release configuration
We don't import SPUUserDriverUIComponent in SparkleCore because it is an exported class a part of Sparkle framework, which causes issues.

Instead, we import SPUApplicationInfo which is not exported from Sparkle.
2016-08-21 02:07:04 -04:00
Zorg 2ca76bef1c Update comment about how cache path method should not in SUHost 2016-08-20 22:00:35 -04:00
Zorg 53cc1cf1ce Add localization scripts from the Framework to the Progress app 2016-08-20 21:51:42 -04:00
Zorg 3547cb1239 Create SparkleCore target that only includes Core related files
Some build issues still need to be resolved.
2016-08-20 21:44:16 -04:00
Zorg e27c5437ab Resume the XPC connections after setting up invalidation handlers 2016-08-20 19:07:10 -04:00
Zorg 47f08be1a0 Don't check or download updates if updater isn't allowed interaction
This only affects updater delegates that return NO from -updaterShouldAllowInstallerInteraction:

This improves the user experience in sparkle-cli where now the checking can be aborted before even downloading the update feed, if it knows ahead of time that installation will fail.
2016-08-20 18:56:01 -04:00
Zorg 7dd066d894 Add SPUDownloadData as compile source to Downloader service 2016-08-20 13:01:51 -04:00
Zorg e2eb9f2af1 Update INSTALL 2016-08-20 12:58:12 -04:00
Zorg 47cdd37238 Rename PersistentDownload -> Downloader 2016-08-20 12:54:13 -04:00
Zorg eb53b58e2b Remove TemporaryDownloader XPC Service
Temporary downloads now use the Persistent Downloader code
2016-08-20 12:14:31 -04:00
Zorg e476ca2cf0 Handle both temporary and persistent downloads in our Downloader
I will aim to remove the TemporaryDownloader target and rename PersistentDownloader to just Downloader.
2016-08-20 11:26:49 -04:00
Zorg 9ac76d6253 Replace -cleanupWithCompletion: with just a -cleanup
SUPersistentDownloader doesn't implement -dealloc anymore so there shouldn't be issues
2016-08-20 09:46:42 -04:00
Zorg ab44d58d0e Don't invoke -cleanup in SUTemporaryDownloader's dealloc
The file will be cleaned up eventually anyway and I don't want to risk something happening when the connection dies.
2016-08-18 19:47:32 -04:00
Zorg b11794b518 Add XPC service documentation section to practices 2016-08-16 20:05:28 -04:00
Zorg 4b962725a5 Document installation resumability behavior for -checkForUpdatesInBackground 2016-08-16 19:52:14 -04:00
Zorg 4bbd3d6c29 Re-order methods in SPUUpdater, put more interesting ones up top 2016-08-16 19:48:03 -04:00
Zorg 1d3e5753d3 -automaticallyDownloadsUpdates should take account if developer disables automatic updates
This behavior is more consistent with the official branch.
2016-08-16 19:43:56 -04:00
Zorg 35ec3caf55 Add documentation to undocumented properties in SPUUpdater 2016-08-16 19:18:46 -04:00
Zorg b92b7948f0 More SU -> SPU changes in the comments 2016-08-16 19:07:16 -04:00
Zorg 69eb10edba Document SPUUserDriver cannot have optional methods 2016-08-16 19:05:05 -04:00
Zorg a6a2da7a69 Add silent termination method to user driver
This is triggered if the update is automatically downloaded and the installer is started in the background, and the updater's delegate decides to handle silent installation and installs the update invoking its immediate installation block. In this scenario, this fixes an issue where the application may not be terminated silently.
2016-08-16 18:59:13 -04:00
Zorg c9a11a262d Spell Compatibility properly 2016-08-16 00:45:45 -04:00
Zorg 05e22348ca Add check to make sure update bundle is signed if no DSA key is provided
This is not a security check. This is just to save a developer from shooting themselves in the foot.
The security checks are done in the installer.
2016-08-16 00:28:29 -04:00
Zorg 6f1b13954b Add authentication before terminating app / launching installer to changes 2016-08-15 21:12:06 -04:00
Zorg 97e769bab0 Update installation docs on handling symlinks 2016-08-15 19:42:56 -04:00
Zorg 4bbce0a25f Re-add temporary read-write exception for use defaults
Switching between a sandboxed and non-sandboxed app with regards to user defaults has some bugs with saving user defaults.
Confirmed by an Apple engineer.
2016-08-15 01:36:48 -04:00
Zorg 5a743ac366 Clarify documentation for applicationBundle in SPUStandardUserDriver 2016-08-15 00:33:29 -04:00
Zorg 1282e42031 Defend against possible symbolic link attack 2016-08-14 23:07:44 -04:00
Zorg 423d288290 Add some defense and comment about relaunching the new app 2016-08-14 21:48:16 -04:00
Zorg 9e183b4e85 Add comment why relaunch path is passed again 2016-08-14 21:17:34 -04:00
Zorg 3132d19afc Add note about no-DSA deprecation 2016-08-14 20:14:34 -04:00
Zorg 2cc3b4c349 Add security note for JoinExistingSession XPC service key 2016-08-14 19:04:21 -04:00
Zorg e6c529e0ee Update README and add documentation, screenshots to reflect this fork. 2016-08-14 18:22:45 -04:00
Zorg 010f642922 Add AppKit prevention guard 2016-08-14 18:14:48 -04:00
Zorg 55e906ba3e Show or dismiss installation progress after sending termination request
Whether we show or dismiss progress depends on whether the current application (from the user driver) is being terminated or not.
2016-08-14 14:32:44 -04:00
Zorg bbfcd564d2 Detect if shift key is held down ASAP when launching test app 2016-08-14 13:44:10 -04:00
Zorg 57325c7507 Add update permission request and response classes
We now pass these to and from the user driver.
2016-08-14 12:51:37 -04:00
Zorg 3f7c3933e7 Fix order of delegation events by dispatching async to main queue
This synchronizes more with the user driver handling events.
2016-08-14 00:55:17 -04:00
Zorg e972e9072c Remove unnecessary import 2016-08-13 23:20:16 -04:00
Zorg 6321329282 Comment why NSWorkspace launchApplicationAtURL: method isn't used 2016-08-13 21:50:45 -04:00
Zorg 73f49ce573 Remove userDriver and delegate properties from SPUUpdater
Until I find a good reason to have them there, they should not be publicly available.
I actually found a couple bugs from code that was accidently referencing them.
2016-08-13 21:32:31 -04:00
Zorg 32d9fd6526 Add flag for custom feed URL to sparkle-cli
This may be useful if user defaults can't be relied on for the feed URL.
For example, if an app is sandboxed, its user defaults may differ from the defaults sparkle-cli looks up.
2016-08-13 20:55:11 -04:00
Zorg 4ec5652a0d Add callbacks for scheduled updates occurring after a delay and being idled
I think I used to have this when the remote XPC callbacks were in the user driver and I removed them at some point.
These callbacks are now part of the SPUUpdaterDelegate and the logic is simpler now than before.
The command line utility makes use of these callbacks.
2016-08-13 20:35:14 -04:00
Zorg eb319ee1b7 Add documentation for prescheduled update actions 2016-08-13 19:37:20 -04:00
Zorg e21d4f1d32 Add sparkle-cli to release build configuration 2016-08-13 19:36:51 -04:00
Zorg d7ddfd2c6b Update installation documentation regarding permission for changing owner/group 2016-08-13 18:24:15 -04:00
Zorg b5ace2d037 Save the NSDate into user defaults for first launch instead of the interval
This is more consistent with how the last update check logic works.
I changed the value of SUTimeIntervalAtFirstLaunchKey for backwards compatibility purposes.
2016-08-13 18:03:16 -04:00
Zorg 3d7f48e03d Merge branch 'master' into ui-separation-and-xpc 2016-08-13 16:56:55 -04:00
Zorg e1397a7098 Copy localizations to installer progress app
Maybe one day only the localizations that are needed can be copied
2016-08-13 16:45:08 -04:00
Zorg ad10096156 Quit all running instances of an application 2016-08-13 15:02:24 -04:00
Zorg af7952b773 Hold down shift instead of command to use popup titlebar user driver 2016-08-13 14:33:09 -04:00
Zorg d9946273a7 Clarify when applicationBundle != hostBundle 2016-08-13 13:08:39 -04:00
Zorg 29d790c63c Pass application bundle into SPUUpdater instead of relying on delegate method 2016-08-13 12:57:26 -04:00
Zorg 26107994f4 Fix typo 2016-08-13 12:14:23 -04:00
Zorg f83d749a39 Not necessarily true, also there's external updaters to worry about 2016-08-13 12:13:27 -04:00
Zorg ad14421b24 Pass relaunch path to standard user driver from SUUpdater 2016-08-13 11:55:50 -04:00
Zorg 5114cd9d83 Distinguish between application and host bundle in user drivers 2016-08-13 11:21:15 -04:00
Zorg cdc329d2c3 Remove SPUUselessUserDriver and just pass nil 2016-08-13 10:57:00 -04:00
Zorg 8eb61afe53 Use SPUUserDriverUIComponent for command line user driver 2016-08-13 10:49:45 -04:00
Zorg b8ccc5d079 Fix compiler error 2016-08-13 10:35:38 -04:00
Zorg fa2e857b4e Add more AppKit prevention guards 2016-08-13 10:35:01 -04:00
Zorg d8ce7cb48b Add external releasenote support to popup titlebar user driver 2016-08-13 10:23:54 -04:00
Zorg 6dddbcc353 Add acknowledgement handler to installation did finish 2016-08-13 09:50:19 -04:00
Zorg f65f4beda8 Fix download progress for popup title user driver 2016-08-13 09:30:40 -04:00
Zorg 3c2875602e Add SPUUserDriverUIComponent and don't export SPUApplicationInfo 2016-08-13 09:19:48 -04:00
Zorg 1a94956f71 Rename userDriver to standardUserDriver for its delegate callbacks 2016-08-13 09:08:32 -04:00
Zorg 92b94343f4 Remove delegate property from SPUStandardUserDriverProtocol
Also remove delegate from user driver core component and popup titlebar user driver.
2016-08-13 09:00:51 -04:00
Zorg b58773cb5e Allow popup titlebar user driver to update other bundles 2016-08-13 08:49:47 -04:00
Zorg 6fb7b4a18b Use popup title user driver when holding down command at launch 2016-08-13 08:39:55 -04:00
Zorg f514861871 Add clarification why SPUStandardUserDriverProtocol doesn't adopt SUUserDriver 2016-08-13 01:37:37 -04:00
Zorg 73c659a2fe Update SPUStandardUpdaterController docs 2016-08-13 01:28:00 -04:00
Zorg a0bc1b19c8 Update some old "SUStandardUserDriver" references 2016-08-13 01:22:34 -04:00
Zorg 8e5554880d Move SUUpdaterDelegate.h to Deprecated group 2016-08-12 23:21:45 -04:00
Zorg d1c2faf7e5 Fixing some old SUUpdater references 2016-08-12 23:18:53 -04:00
Zorg 85914936d7 Add infinite recursion note for -feedURL 2016-08-12 23:06:10 -04:00
Zorg d0d39bc623 For installUpdatesIfAvailable stub, do background update check instead of initiated 2016-08-12 23:04:40 -04:00
Zorg f18d410c6a Add SPUUpdaterDelegate and deprecate SUUpdaterDelegate 2016-08-12 23:02:23 -04:00
Zorg 878c30d17c More SU -> SPU renaming for status completion results 2016-08-12 20:45:24 -04:00
Zorg f5afdc1cd8 Group download data, text encoding name, and MIME type into one class 2016-08-12 20:26:56 -04:00
Zorg bce9c083c1 Remove temporary read-write user preference exception for test app
Note cfprefsd processes may have to be killed or computer may have to be rebooted for user defaults to be read again for the test application.
2016-08-12 19:43:51 -04:00
Zorg 93c23e938f TestAppHelper doesn't do much, so doesn't need RunLoopType as NSRunLoop 2016-08-12 19:03:19 -04:00
Zorg a523621b71 Remove support for remotely using user driver from updater
Although it is interesting to separate the user driver and update scheduler in different processes, this has yet to prove useful. Further, this management should not exist in the user driver protocol since the protocol would be doing double duty. If this separation is useful in the future, it should be separated into another driver altogether. Note that it is also hard to write correct code that separates the user driver and updater. Removing this code should greatly reduce maintenance costs.
2016-08-12 18:48:54 -04:00
Zorg 86668d852b Remove LSBackgroundOnly from Progress Agent app
LSUIElement should only be used if the app can show UI
2016-08-12 16:58:50 -04:00
Zorg 62bbf73ab4 Remove "SUUpdater" reference 2016-08-12 16:52:38 -04:00
Zorg 1a0e169e7f Improve displaying release notes in sparkle-cli (safer & less code) 2016-08-11 20:58:53 -04:00
Zorg a51edf3dad Remove adopted protocol from protocols used for XPC
This is because XPC decoders on older systems may not traverse adopted protocols
2016-08-11 20:58:19 -04:00
Zorg f7d1cab4a0 Make sure we have a valid IANA charset name 2016-08-10 22:44:34 -04:00
Zorg 65d78d5129 Pass text encoding and MIME type to user driver for release notes
This fixes issues where the user driver may not be displaying release notes properly because it doesn't know what kind of data was downloaded (eg: html vs plain text).
2016-08-10 22:11:19 -04:00
Zorg 085724322f Use id type for updater 2016-08-10 21:44:12 -04:00
Zorg 69db74bc36 Resolve symlinks when finding a matching running application path
This fixes issues where Sparkle may think an application has already terminated when placed in a directory that has symlinks (such as /tmp/)
2016-08-10 20:29:10 -04:00
Zorg 11cbecbeaa Test changing ownership/group to determine if authorization is needed
This will work correctly in scenarios where the app to update is in a temporary location for instance.
2016-08-10 20:05:20 -04:00
Zorg 31d6d40112 s/SUStandardUpdaterController/SPUStandardUpdaterController/ 2016-08-10 18:22:41 -04:00
Zorg ba93d9056e Make configuration and valid feed URL checks safer
Instead of potential abort()'ing, we abort the update driver with a supplied error.
2016-08-10 18:16:01 -04:00
Zorg 9dca6fd27b Specifying invalid DSA key in the info.plist is now a config error 2016-08-09 23:35:27 -04:00
Zorg 2b65860293 Fix nullability warning 2016-08-06 21:01:15 -04:00
Zorg 766dd50aeb More SU -> SPU prefix changing 2016-08-06 21:00:14 -04:00
Zorg bdd2b7571b Mark SPUUpdater with nullability annotations 2016-08-06 20:47:30 -04:00
Zorg f2713138b9 s/SUUpdater/SPUUpdater/ 2016-08-06 20:30:58 -04:00
Zorg e53539b19e Don't deprecate +defaultComparator, although discourage it and use alloc/init 2016-08-06 11:18:00 -04:00
Zorg b676e3761a Add comments for the delegator property of SPUUpdater 2016-08-06 11:04:19 -04:00
Zorg a303859f10 Add deprecation notice to interactive package installer 2016-08-06 10:57:53 -04:00
Zorg bf0aa81546 Add deprecation notice from nib instantiated SUUpdater 2016-08-06 10:54:53 -04:00
Zorg eae8ccb2e7 Don't think SPUApplicationInfo should be exported 2016-08-06 10:52:29 -04:00
Zorg fdd6707f5b Add SU_EXPORT to user driver classes that should be public, I think 2016-08-06 10:49:32 -04:00
Zorg e3dd0d5ce5 Use class name rather than hardcoding it 2016-08-06 10:44:12 -04:00
Zorg 42a9a34be4 Add logging notice and some more explanation for not supporting -installUpdatesIfAvailable (yet) 2016-08-06 10:28:52 -04:00
Zorg 1663a822c8 Allow but deprecate serving download without DSA signature
This allows for a better transitioning period. In the future, this should be removed.
2016-08-06 10:20:36 -04:00
Zorg 6bfdd18d9e Ignore deprecation warnings in SUUpdater.m 2016-08-05 22:26:38 -04:00
Zorg b8d51539d7 Make SUUpdater.h a public header in the framework 2016-08-05 22:16:48 -04:00
Zorg e726dd01e4 Add incomplete -installUpdatesIfAvailable stub for now 2016-08-05 21:59:12 -04:00
Zorg 4ed6d40af8 Update deprecation documentation 2016-08-05 21:49:25 -04:00
Zorg 6e35a1b84d Add deprecation notice 2016-08-05 21:24:14 -04:00
Zorg 86e026588b Handle deprecated updater will install on quit callback
I may have to reconsider the design of this API in general.
2016-08-05 21:18:08 -04:00
Zorg ca36d9963e Remove -updaterIsRequestingQuit: delegate callback and use user driver instead
This way we remove delegate responsibility duplication and this should make backwards compatibility easier
2016-08-05 19:39:12 -04:00
Zorg c9f673cda8 Use SPU prefix in many places 2016-08-05 19:10:21 -04:00
Zorg f5444228c5 Re-add +defaultComparator on SUStandardVersionComparator
Have it be deprecated however. Maybe I can change my mind here later.
2016-08-04 00:15:04 -04:00
Zorg 4f285d2245 Rename SUUpdater -> SPUUpdater & add SUUpdater for backwards compatibility
New classes will soon be prefixed with "SPU"
I still need to look into adding a compatibility layer for -updater:willInstallUpdateOnQuit:immediateInstallationInvocation: and possibly deprecating no-DSA instead of outright rejecting it.
2016-08-03 23:30:55 -04:00
Zorg c811db1e67 Remove Release-HTTP build configuration 2016-08-01 22:17:20 -04:00
Zorg 5dfe4ce71b Set up ATS exceptions for Test App in release mode
Now the test app works properly when building it in release.
2016-08-01 22:02:18 -04:00
Zorg 1a3466ba04 Don't use TestAppHelper or code sign update in release 2016-08-01 22:01:30 -04:00
Zorg 52fd21e119 Reload NSBundle cache on its info plist dictionary
We reload the info dictionary before we start off an update driver. This is so that we have the latest up to date information for the bundle.
2016-07-31 20:38:48 -04:00
Zorg 411c0ac8bd Only pass host bundle identifier to probe methods 2016-07-31 20:32:21 -04:00
Zorg 682a47f4fa Update INSTALL file 2016-07-30 22:35:59 -04:00
Zorg b8df5d3023 Merge branch 'master' into ui-separation-and-xpc 2016-07-30 22:18:29 -04:00
Zorg a7e03c7f9b Add note about when installer ignores agent/updater invalidation 2016-07-30 20:46:46 -04:00
Zorg 607399f1e6 Comment on why agent is connecting to installer instead of vise versa 2016-07-30 20:41:03 -04:00
Zorg cc9f4d92af Update validation documentation 2016-07-30 18:05:57 -04:00
Zorg 5ad5598a19 Make sure update directory != nil during cleanup 2016-07-30 17:49:37 -04:00
Zorg 1ca233eadf Validate the update before extraction whenever possible
If we download a package type installation or a delta update, we should validate the update before trying to unarchive it.

We can't do this with ordinary updates because we handle changing of DSA keys for that particular case.
2016-07-30 17:36:22 -04:00
Zorg 2fc57ce288 Move installation validation to separate class 2016-07-30 16:03:52 -04:00
Zorg d42ac08bf2 Split connection agent counter into two separate variables 2016-07-30 15:38:09 -04:00
Zorg 97ce687b86 Update installation documentation 2016-07-30 14:20:20 -04:00
Zorg 23e027d02f Have progress agent terminate after relaunching, not after stopping progress 2016-07-30 14:18:39 -04:00
Zorg 8c564fef1f Remove +[SUFileManager defaultManager] and use alloc/init 2016-07-30 10:39:17 -04:00
Zorg 069f78579c Remove commented code 2016-07-30 01:23:03 -04:00
Zorg ea1b04391f Improve cache storage handling of files
We first create a directory with respect to the app's bundle ID being updated, sparkle's bundle ID, and a directory inside for a specific purpose. Then we remove all old directories inside there, and create a new unique temporary directory.

This is to avoid conflicts with eg: multiple updaters running against each other around the same time, or files for one function interfering with files from another purpose, while still having a way to clean up old files.
2016-07-30 01:00:14 -04:00
Zorg 32584ab228 Make content length RSS attribute optional but highly recommended 2016-07-29 21:17:16 -04:00
Zorg 5852ecf0e7 Improve handling of disallowing update interaction
When resuming updates, if interaction is disallowed, we can't continue on with interactive package installation
2016-07-29 20:21:53 -04:00
Zorg 0d0258a87f Rename un/nonguided package to interactive package, and guided to normal 2016-07-29 00:22:52 -04:00
Zorg 097710e27a Update sparkle-cli help usage and interactive flag 2016-07-29 00:16:24 -04:00
Zorg b967c2f13f Disallow interaction for interactive package installers if updater rejects it 2016-07-29 00:15:55 -04:00
Zorg 322ee026ea Fix installer tests 2016-07-28 23:28:44 -04:00
Zorg e2da47b7c7 Improve handling of storing files in cache
Create distinct subdirectories in our cache directory so files for different purposes won't conflict.

For the installer, move the download archive to the installer's cache location. If the installer is running as root, this moves it to a place only root can access I believe. This is also to prevent other functionality from touching these files.
2016-07-28 22:54:28 -04:00
Zorg 32bf570b4c Add some comments to installation process 2016-07-28 20:27:12 -04:00
Zorg bd352c7db5 Take out lot of unnecessary installation code now 2016-07-27 23:11:59 -04:00
Zorg 626e506cae Update codesign_xpc script to sign auxiliary executables too 2016-07-27 21:50:25 -04:00
Zorg cb6fd34448 Add signing for progress agent in the launcher XPC service
This is only for debug builds. Release products aren't signed. This allows the updater agent app to be placed in the installer launcher service's MacOS directory, which is more convenient for developers to sign.
2016-07-27 21:08:32 -04:00
Zorg 3be36d8f22 Don't pass installer/agent path to launcher XPC service
The InstallerLauncher code now tries to locate these tools inside Contents/MacOS/ or inside the Resources directory. The installer launcher XPC service now has a copy of the tools included in its bundle.

This may seem like wasting space but it enables eg, the XPC service not trusting a sandboxed application. A developer could always remove the tools from the Sparkle framework if necessary (we can't because the XPC services are optional..)

Using the XPC service allows the developer to sign the installer executable (Autoupdate.app). The agent app can be moved and signed into the MacOS executables directory as well. We don't do that automatically because Xcode's tooling doesn't play nice with attempting that, although that could be looked at later.
2016-07-27 19:57:46 -04:00
Zorg 8ab7bd6edb Rename XPC services to use reverse DNS style 2016-07-27 00:40:04 -04:00
Zorg 5ceeb3dfd3 Remove "incoming connection" log 2016-07-27 00:04:34 -04:00
Zorg 2191a2b6ed Improve termination & cleanup for progress agent & installer 2016-07-26 23:57:48 -04:00
Zorg 2eccc3a1db Remove unused header 2016-07-26 23:39:49 -04:00
Zorg c445a3f1e4 Remove linking to unused system frameworks 2016-07-26 21:10:22 -04:00
Zorg 6fc5dfb8e7 Simplify release quarantine method 2016-07-26 21:05:42 -04:00
Zorg 929705d6dd Update installer unit test 2016-07-26 21:05:25 -04:00
Zorg 9e1664b42e This function shouldn't be concerned about symlinks
Besides, the path passed into this function in our code comes from a NSBundle
2016-07-26 20:50:23 -04:00
Zorg 260235b2a0 Break retain cycles rather than using weak ref for connection handlers 2016-07-26 20:42:15 -04:00
Zorg 646ed6f3c4 Improve logic for allowing installer interaction
We now distinguish between the updater delegate allowing interaction and the update driver allowing interaction. We also remove an interaction allowed flag from the AppInstaller, letting shouldShowUI flag suffice.
2016-07-26 20:00:56 -04:00
Zorg f9e2609fa1 Update is no longer cancelable after installation begins 2016-07-26 19:25:49 -04:00
Zorg 0ca688073b Disable root support & checking
Assume that the updater will be run as a logged in user.
The command line driver and progress app aren't completely root safe anyway, and running the progress app under a different user could be quite awkward from root
2016-07-26 19:16:38 -04:00
Zorg 9f4e44f919 Don't move old app to Trash
Several reasons:
* The user may not look at the trash anyway, and it would bloat their HD space
* Other sofware updaters don't move old versions to the trash either. Can confuse the user or not be seemly transparent experience.
* Moving app to trash will not work if user has to authenticate anyway
* Unclear how long and expensive this operation *could* take in all scenarios
* App replacements in Apple's new file system can be atomic-safe, but that may only be the case if the old app is no longer needed

Cons:
* Few tech savvy users may not be able to restore an app without re-downloading it. This would still be rarely done even amongst them.
2016-07-25 19:11:20 -04:00
Zorg eac55846a8 Avoid copying the installer to a temporary location 2016-07-25 17:13:18 -04:00
Zorg 70cc3ea360 Remove unused mach service 2016-07-25 00:14:13 -04:00
Zorg fe62ad0468 Merge branch 'xpc-remove-auth' into ui-separation-and-xpc 2016-07-25 00:12:45 -04:00
Zorg 7d16e223c3 Remove stray AuthorizationRef reference 2016-07-25 00:05:42 -04:00
Zorg 150f10ed05 Update Installer unit test 2016-07-24 23:55:21 -04:00
Zorg 0cb59a1b02 Update user driver documentation 2016-07-24 23:44:37 -04:00
Zorg 1384b5a80f Allow tagging installation type in appcast item enclosure
This is now necessary for package type installations so we can know whether or not we should authenticate ahead of time.

Of course, we also verify that the download contains the type of installation we expect (because the appcast is not very trusted).
2016-07-24 23:35:47 -04:00
Zorg 35801a22f2 Remove stray Autoupdate group folder reference 2016-07-24 21:51:54 -04:00
Zorg ec69aa07a3 Add JoinExistingSession to TestAppHelper too 2016-07-24 21:47:12 -04:00
Zorg d8196e1c5d s/cancelled/canceled/ 2016-07-24 20:17:09 -04:00
Zorg da8065f67e Put preventive measures for aborting update more than once.
This resolves issues with canceling not taking complete effect.
2016-07-24 20:13:06 -04:00
Zorg 8d93513813 Don't need SUAuthorizationEnvironment anymore 2016-07-24 19:28:56 -04:00
Zorg 1d3776d5c7 Show app icon in the prompt for authorization 2016-07-24 19:23:56 -04:00
Zorg e5643e2990 Improve authorization prompt handling
We now present a better worded dialog (X wants to update. Please type your password to allow this. OK/Cancel)
We still need to set the icon for the dialog window.

I also fixed some issues with canceling the dialog still throwing an error.
2016-07-24 17:05:26 -04:00
Zorg c95b337b09 Don't need SUSubmitInstaller.h/m anymore 2016-07-24 15:37:33 -04:00
Zorg 25a52439a1 Remove stray reference to SUAuthorizationEnvironment 2016-07-24 15:09:52 -04:00
Zorg e2a51347b9 Differentiate between resuming an installing update & a downloaded one 2016-07-24 14:37:21 -04:00
Zorg ec7766022d Add callback for showing downloaded updates that haven't started 2016-07-24 14:24:04 -04:00
Zorg 5c0ee2d74a Rename did finish downloaading callbacks to did start extracting 2016-07-24 13:29:03 -04:00
Zorg 48938d0e78 Clear downloaded update if delta extraction fails 2016-07-24 13:13:17 -04:00
Zorg a1d43997d9 With JoinExistingSession, the agent doesn't need to submit the intaller ever 2016-07-24 13:03:39 -04:00
Zorg 7d4690ed17 Add JoinExistingSession key to InstallerLauncher service
This is necessary for older OS versions (10.8 & 10.9), otherwise authorization interaction will not be allowed
2016-07-24 11:10:20 -04:00
Zorg 21ad358772 Add JoinExistingSession key to InstallerLauncher service
This is necessary for older OS versions (10.8 & 10.9), otherwise authorization interaction will not be allowed
2016-07-24 11:06:37 -04:00
Zorg ad950beab6 Include SUStatusInfoProtocol methods in SUInstallerStatusProtocol to fix 10.8 compatiblity issues 2016-07-23 23:57:20 -04:00
Zorg d98fe465b5 Allow installer authorization by default
Fixes accidental bug during refactor where authorization wouldn't even be attempted
2016-07-23 23:54:08 -04:00
Zorg 3200029157 Include adopted protocol methods in SUInstallerStatusProtocol
This is because of compatibility issues with 10.8
2016-07-23 23:31:00 -04:00
Zorg 41ee168f2c Change try again error to authorize later error 2016-07-23 14:49:19 -04:00
Zorg c2db46f656 Add error codes to log messages 2016-07-23 14:46:35 -04:00
Zorg 350aeb1c81 Change how errors are passed & clear download after installer starts 2016-07-23 13:50:14 -04:00
Zorg 345ed3b60e Add resuming downloaded updates without starting the installer automatically
This allows automatically downloading updates, and having them prompt up later, so the user can perform authorization later for starting up the installer
2016-07-23 09:08:29 -04:00
Zorg b014737e83 Group appcast update item, download name, and temp directory into one class 2016-07-18 23:25:44 -04:00
Zorg 3244bf7f14 Move installer status info service to progress agent 2016-07-18 21:14:33 -04:00
Zorg 50594dda57 Move execute package out from SUFileManager 2016-07-18 19:48:25 -04:00
Zorg dd02cb2509 Change Autoupdate target from app to command line tool 2016-07-18 18:46:12 -04:00
Zorg 66e3083e0c Initial work on removing AuthorizationExecuteWithPrivileges
I need to at least look at:
* Automatic downloaded / silent updates
* Running updates as root user from beginning
* Status info query service
* Add guided flag in the appcast
2016-07-18 17:40:35 -04:00
Zorg 6b5f014946 Release self if we fail to set up termination callback 2016-07-17 10:54:15 -04:00
Zorg 849d265900 Use kqueues to determine if a process identifier terminates
This way we don't have to rely on AppKit for watching when the target process dies
2016-07-16 21:58:41 -04:00
Zorg 59af8ae0ba Remove old reachability related code/comments 2016-07-16 17:21:57 -04:00
Zorg f7f9ac4c6d Terminate the running application matching the bundle rather than ourselves
This allows the standard user driver to properly be used remotely
2016-07-16 16:59:54 -04:00
Zorg 3939fcfb82 Update Installation documentation 2016-07-16 16:34:01 -04:00
Zorg e0109e2fd5 Have executable path be inside arguments array 2016-07-16 13:09:08 -04:00
Zorg da185de61b Rationalize which domain we submit jobs under 2016-07-16 13:04:10 -04:00
Zorg e00d303c08 Don't log that we're terminating the app
This way if installation takes a long time, it may not look like it is because of termination.
2016-07-16 12:11:52 -04:00
Zorg c37fc24389 Rename AutoUpdate to Installer for service name functions 2016-07-16 08:58:34 -04:00
Zorg a962c8fa8f Make sure Mach service names are shorter than 64 characters
NSXPCConnection has this length restriction on 10.8 and possibly later versions of macOS
2016-07-16 08:30:37 -04:00
Zorg ea6625024c Improve detecting if the updater is still alive
Rather than just testing if our connection is still alive (which is deceiving), we make a ping/pong request and see if we get a response back.
2016-07-15 16:48:26 -04:00
Zorg 64d740a761 Don't log SMJobRemove() job not found error
Also rationalize why we aren't first checking if the job already exists
2016-07-13 22:55:20 -04:00
Zorg 2c3996a522 Add timeouts if the installer or updater don't respond back in timely matter
This is only for creating the initial connection
2016-07-13 22:28:36 -04:00
Zorg 97eb25b27f Supply the base URL when loading external release notes
This fixes an issue where relative external references could not be loaded from the release notes.
Note this just affects apps that have a 'com.apple.security.network.client' entitlement or apps that aren't sandboxed.
2016-07-13 18:00:06 -04:00
Zorg e171824a74 Merge branch 'master' into ui-separation-and-xpc 2016-07-13 00:28:14 -04:00
Zorg a65a7346cf Fix 10.8 bug by re-declaring method in Installer connection protocol
Even though the method is declared in the super protocol type, the XPC decoder on older systems (i.e, 10.8) doesn't parse methods there.
2016-07-12 23:25:27 -04:00
Zorg 7092c19652 Remove accidental SparkleInstallerConnection copy in framework 2016-07-12 21:19:28 -04:00
Zorg 69b4b9e81b Fix installer progress app not terminating properly
This is done by canceling apple termination events, and by exit'ing later
2016-07-12 20:43:53 -04:00
Zorg 8563a40cd2 Use XPC for IPC to the installer instead of CFMessagePort
We now use XPC for communication between Sparkle.framework and Autoupdate.
Autoupdate is now ran as a launchd agaent/daemon. (Most of the time, it acts as an agent).

Using XPC can only be done from non-sandboxed processes, so a connection and status service had to be created.

Currently, the GUI progress tool doesn't work properly, but everything else should be behaving like before.
2016-07-12 19:59:24 -04:00
Zorg 80bc8353ed Handle defer installation when resuming updates in sparkle-cli 2016-07-12 19:50:00 -04:00
Zorg 7d1c0aa83b Merge branch 'master' into ui-separation-and-xpc 2016-07-04 23:29:09 -04:00
Zorg 1b5b4972c9 Document -grantAuthorizationPrivilegesWithError: 2016-07-04 21:33:51 -04:00
Zorg ddb4262b7b Rename and document -updateAccessTimeOfItemAtRootURL:error: 2016-07-04 21:25:54 -04:00
Zorg 599c3fb3c1 Add unit test for updating access dates 2016-07-04 21:10:49 -04:00
Zorg b8bb06fb2f Change step # references to section names now 2016-07-04 19:56:23 -04:00
Zorg 63febfd9cd Updating installation docs into sections rather than bulleted points
Also make some other changes with choice of wording
2016-07-04 19:51:40 -04:00
Zorg b4f7a28aa3 Add updater delegate immediate installation handler to installation docs 2016-07-03 20:18:21 -04:00
Zorg 998a349617 Add updater delegate method for installing & relaunching new update 2016-07-03 18:44:11 -04:00
Zorg 9881476008 Update updater delegate documentation 2016-07-03 14:22:22 -04:00
Zorg 340633fd79 Comment more on why launching Autoupdate with LaunchServices is necessary 2016-07-03 11:54:28 -04:00
Zorg a615703883 Suppress const void* to void* warning for context info 2016-07-03 00:42:42 -04:00
Zorg e4d6e268e2 Stage 2 installation seems to be handled fine 2016-07-03 00:24:38 -04:00
Zorg e32d0dbc1a This validation warning note isn't a real concern for now 2016-07-02 23:32:56 -04:00
Zorg ef4af6b4a8 Marking main parameters as unused 2016-07-02 23:31:05 -04:00
Zorg 8de5c5cfa2 Update installation data documentation 2016-07-02 23:30:36 -04:00
Zorg 54408ca1a9 Fix bug where updater ignored 3rd stage installation failures
Only prevalent if the updater lives in a different process than the app being updated
2016-07-02 23:23:57 -04:00
Zorg 4240138818 The installer shells out to authorization 2016-07-02 19:29:53 -04:00
Zorg 39f7915492 Non-guided pkg installers show progress already 2016-07-02 19:28:35 -04:00
Zorg 23a07127d0 Add installation documentation detailing IPC 2016-07-02 19:26:33 -04:00
Zorg 641f3b0d47 Update mdimporter bundles during delta extraction
During delta extraction, these bundles may not be updated appropriately, so we should just be safe and update them ourselves
2016-07-01 21:23:51 -04:00
Zorg a7aad3b16a Use the authorization environment when requesting for auth
This probably went missing accidently when I did a merge
2016-07-01 20:13:39 -04:00
Zorg a6ccd4cfa9 Avoid unguided package installers if we may be running as root 2016-06-30 22:14:19 -04:00
Zorg b982e9460c Handle package installer (non-guided) errors 2016-06-29 00:09:22 -04:00
Zorg a09aa0b33f Package installs should be guided by default. Opt out for non-guided. 2016-06-29 00:09:08 -04:00
Zorg 9acfe7f180 Don't pass allowsAutomaticUpdates to user driver
Let the user driver read from updater settings to know if automatic updates are allowed
2016-06-28 00:28:21 -04:00
Zorg 30f346a967 Fix normal & resumable update handlers for popup titlebar user driver 2016-06-27 23:57:34 -04:00
Zorg 9a528d912a Fix PopUp Titlebar user driver not showing embedded release notes 2016-06-27 23:57:12 -04:00
Zorg c117837785 Add resumable update handler & fix normal update handler in sparkle-cli 2016-06-27 23:29:45 -04:00
Zorg 34ce18c44f Add private function for disabling stderr logging
This is useful for releasing sparkle-cli
2016-06-27 23:15:51 -04:00
Zorg e919c13f55 Always log output to stderr (for now...) 2016-06-27 00:02:37 -04:00
Zorg a3a6e3b3b7 Separate showing downloadable update from resumable update in user driver 2016-06-27 00:00:20 -04:00
Zorg 23a3ad4b05 Remove pch files, don't use older __nullable/__nonnull attributes 2016-06-25 10:18:12 -04:00
Zorg dc5298ce54 Make method for finding running appliction to reduce duped code 2016-06-24 23:42:31 -04:00
Zorg 1aedf2f9ed Remove duplicated Sparkle Cache directory code 2016-06-23 23:31:18 -04:00
Zorg 1392190d47 Make sure SULog delivers messages synchronously 2016-06-21 19:04:01 -04:00
Zorg b1606648cf Use isValidVersion: method in SUHost that already exists 2016-06-20 23:35:17 -04:00
Zorg 4d379f3e0a Add copying SparkleLocalMessagePort to release package script 2016-06-20 00:21:11 -04:00
Zorg da39e841f9 Fix build errors for fileop 2016-06-20 00:17:46 -04:00
Zorg 7e54e94472 Remove build settings I didn't configure
Maybe these happened during a bad merge.
2016-06-20 00:12:00 -04:00
Zorg 6cca0673c5 Change SURemoteMessagePort protocol to SURemoteMessagePortProtocol 2016-06-19 23:52:46 -04:00
Zorg 6a4b96580a Info only updates shouldn't require enclosure length 2016-06-16 23:27:39 -04:00
Zorg a780894d14 Fix appcast unit tests 2016-06-16 23:23:43 -04:00
Zorg af7c7cea2b Merge branch 'master' into ui-separation-and-xpc 2016-06-16 22:46:26 -04:00
Zorg 29d32eaaa0 Disable automatic termination when using SULocalMessagePort 2016-06-16 22:38:11 -04:00
Zorg 061e99995f Add XPC service for local message port
This should work under 10.12 (beta) environment now when sandboxed.
2016-06-15 21:44:24 -04:00
Zorg 911f2150f9 Don't think update driver should be interruptible anymore 2016-06-11 23:52:05 -04:00
Zorg adba3bd945 Don't allow SUUpdater to be kept alive by cycle resets 2016-06-11 23:31:24 -04:00
Zorg 71b91734e5 Merge branch 'master' into ui-separation-and-xpc 2016-06-11 21:07:57 -04:00
Zorg f70c7429ba Merge branch 'auth-wait-fileop' into ui-separation-and-xpc 2016-06-08 23:44:05 -04:00
Zorg 207390a2c1 Retrieve child pid by using fcntl() 2016-06-06 23:11:38 -04:00
Zorg 86d5d49111 Comment why AuthorizationExecuteWithPrivileges() is still being used 2016-06-04 18:02:21 -04:00
Zorg b2cb1bd531 Wait for all children processes to stop
This fixes installation failing when we check for the wrong child and don't let the installer finish. However, this code now ignores the status from the child. I might see if there's a better way around fixing that..
2016-06-04 17:38:21 -04:00
Zorg f36397e89c Handle EINTR for wait() and don't store / back up ECHILD handler 2016-06-04 13:31:57 -04:00
Zorg 623f535883 We can do guided installation silently if we're root 2016-06-03 23:16:21 -04:00
Zorg 070686b488 Use NS_ASSUME_NONNULL macros 2016-05-29 20:21:14 -04:00
Zorg 4482e2b736 Fix unsigned cast warning 2016-05-29 20:20:42 -04:00
Zorg c80ddf99f8 Declare constants for SUAppcastItem.m 2016-05-29 17:42:34 -04:00
Zorg 45aaba9ee9 Use ivars in SUAppcastItem initializers to make code smaller 2016-05-29 17:29:13 -04:00
Zorg 53c4abaf9e Remove providing custom installer progress app
I don't think this feature would be used much, and I don't want to deal with additional maintainability. As it is, the progress app should show up in rare cases.
2016-05-29 17:01:38 -04:00
Zorg d44ef6bb75 Installer progress: change the dock icon to the bundle being updated
This way we don't have to include an icon for the installer progress app. There is a minor issue where the dock icon changes back before termination. However, this app should show up in rare cases in the first place, so I still think this is a good trade off.

For most applications, it makes more sense to use the app's icon than Sparkle's. That and we can save some disk space usage.
2016-05-29 16:39:46 -04:00
Zorg 355d6eddbf Rely more on content length from appcast item than from downloader
The rationale is that the downloader may be giving us an expected length for a block of data rather than the whole
2016-05-29 14:25:21 -04:00
Zorg f62285ff3b Use Appcast's content length when downloader doesn't retrieve an expected length 2016-05-29 13:17:56 -04:00
Zorg 80267f22b5 Test if we are root for guided silent installs 2016-05-29 11:28:38 -04:00
Zorg da145b2100 Log terminating target application in sparkle-cli 2016-05-29 11:28:11 -04:00
Zorg 0fb951bd4c NSURLQuarantinePropertiesKey isn't used anywhere 2016-05-29 10:53:45 -04:00
Zorg b4f1f67ddb Prevent using wrong combination of flags 2016-05-28 23:15:54 -04:00
Zorg a113ce49bd Add interactive option to sparkle-cli
This allows installation by requesting the user to enter a password when elevated privileges are necessary. This only works if the application is alive before installation begins.
2016-05-28 23:04:43 -04:00
Zorg ec0889ef83 Redirect stdout/stderr when unmounting dmg 2016-05-28 17:06:41 -04:00
Zorg 1046cb4217 Don't attempt 3rd installation stage if 2nd failed 2016-05-28 12:05:00 -04:00
Zorg f210fddb30 Add error for being unable to install the update silently 2016-05-28 11:50:46 -04:00
Zorg 0cf1aee693 Add -updaterShouldDownloadReleaseNotes: delegate method 2016-05-28 10:13:18 -04:00
Zorg 7bfccc3898 Fix nullability warning 2016-05-28 09:49:51 -04:00
Zorg 87903c0d97 Fix unit tests from not compiling
SUFileManager fileManager method had to be renamed to satisfy Swift
2016-05-27 22:23:04 -04:00
Zorg 7df7222fe4 Merge branch 'master' into ui-separation-and-xpc 2016-05-27 16:30:13 -04:00
Zorg 348426e501 Make cancelling authorization prompt graceful
An error dialog no longer shows up when the user cancels an authorization request
2016-05-27 15:56:26 -04:00
Zorg bcb3f669ba Fix couple of nullability warnings 2016-05-27 14:26:13 -04:00
Zorg 1438dd6140 Rename SUUnarchiver protocol to SUUnarchiverProtocol for less confusion 2016-05-27 14:14:22 -04:00
Zorg 64a7624744 Add authorization environment when using file manager
If the file manager is used for authorization, we can now supply an authorization environment.

This allows us to specify a customized prompt message and an icon to use in the authorization dialog window. We no longer need to include an icon for Autoupdate app.

We now also see if we can get authorization rights access right away, rather than lazily when executing a tool.
2016-05-27 12:36:44 -04:00
Zorg d182b28d09 Rename AppcastDownloader service to TemporaryDownloader 2016-05-26 18:27:15 -04:00
Zorg c5026976ee Rename UpdateDownloader service to PersistentDownloader 2016-05-26 18:10:07 -04:00
Zorg c9cb670761 Improve codesign_xpc script by taking files instead of a directory 2016-05-21 19:55:37 -04:00
Zorg cd135d9b10 Add log to see if remote message service gets interrupted 2016-05-21 00:07:36 -04:00
Zorg 1084071810 Enable automatic termination if creating CFMessagePort fails 2016-05-20 23:58:31 -04:00
Zorg dd0230e6c2 Use ASL_LEVEL_ERR instead of "3" 2016-05-20 21:57:47 -04:00
Zorg d463db5742 Protect RemoteMessagePort service terminating prematurely 2016-05-20 18:28:07 -04:00
Zorg e3795194d6 Set completion handler to nil when download fails 2016-05-20 18:26:53 -04:00
Zorg cb5cf9aa69 self can't be nil here 2016-05-20 16:35:09 -04:00
Zorg 0a53d51d89 Don't send NSURLResponse objects over XPC or to the user driver
This class doesn't support NSSecureCoding in OS X 10.8, so this fixes a crash there.
2016-05-19 21:52:50 -04:00
Zorg 4a0837a500 Add wrapper class over NSURLRequest that implements NSSecureCoding
This fixes a crash on OS X 10.8 where NSURLRequest didn't implement secure coding there
2016-05-19 21:21:50 -04:00
Zorg 83fe6adcba Make sure XPC versions are synced with the framework version 2016-05-19 19:29:47 -04:00
Zorg 7c06ceb7e4 Set version info for XPC services 2016-05-18 22:28:02 -04:00
Zorg 4661fee388 Deal with byte order when sending installation progress 2016-05-18 20:08:01 -04:00
Zorg 1a952227a7 Replace assert(false/NO) with abort() 2016-05-18 19:15:01 -04:00
Zorg eec2eca0c2 Document SULog and its intended use case 2016-05-18 19:04:41 -04:00
Zorg a8dd49acad On second thought, stick to using NSLog for DEBUG warning 2016-05-18 19:03:13 -04:00
Zorg 3826b35bc2 Explain why NSLog is being used here. 2016-05-18 18:53:30 -04:00
Zorg 4ba3673dfd Use SULog over NSLog in a couple of places now 2016-05-18 18:52:25 -04:00
Zorg 72d63f3992 Print friendly error messages in sparkle-cli 2016-05-18 18:51:47 -04:00
Zorg 346f996942 Re-write logging functionality
1. Use Apple's logging system (ASL) - don't invent our own inefficient mechanism.
2. Logging is not dependent on a global file that any process and thread using Sparkle can write to now, which could also be cleared at any point before.
3. Don't write to stderr on non-debug builds. This is ideal for sparkle-cli utility.
2016-05-18 18:48:01 -04:00
Zorg 3b05179ccf Don't litter status messages with SULog
We should just stick to logging errors
2016-05-18 18:01:02 -04:00
Zorg 159c16fc12 Improve error handling on readfile() 2016-05-16 19:25:39 -04:00
Zorg 71330366d8 Don't forget to free the buffer on failure 2016-05-16 19:22:34 -04:00
Zorg a1b6cbb5e2 Don't exit the program on failure for bsdiff.c 2016-05-16 19:15:57 -04:00
Zorg e1af0264de Don't exit the program on failure for bspatch.c
We call warn type functions instead of err ones now and do some cleanup
2016-05-16 19:02:00 -04:00
Zorg 7056ccb321 Use FILE* functions in bspatch.c 2016-05-16 18:21:52 -04:00
Zorg 77ad42aab6 Use FILE* (fopen/fread/etc) functions for bsdiff.c
This way we don't have to handle EINTR
2016-05-16 10:57:42 -04:00
Zorg fa36cb300b Add exception handling to secure coding archivers/unarchivers 2016-05-14 23:27:59 -04:00
Zorg 8b19b0e1b4 Adding todo to implement showing linked release notes from popup user driver 2016-05-14 21:57:41 -04:00
Zorg fbb9fbf535 Add showing release notes from sparkle-cli 2016-05-14 21:56:35 -04:00
Zorg 1446acf519 Add methods onto user driver show showing linked release notes
These release notes are downloaded while showing that the new update is found
2016-05-14 21:45:25 -04:00
Zorg 95416e4f65 Add SUURLDownload specifically for downloading temporary files 2016-05-13 22:11:47 -04:00
Zorg d21c4c4785 s/appcastData/data/ - this shouldn't be appcast specific 2016-05-08 16:25:56 -04:00
Zorg 70582639ee Remove completion block from SUUpdateDownloaderProtocol
Only use the delegate now for communication via this protocol.
This cleans up some inconsistency.
2016-05-08 16:24:16 -04:00
Zorg 033f59e643 Comment on why these delegate methods are being implemented 2016-05-06 19:36:46 -04:00
Zorg c9c1de30e4 Don't implement failedToDownloadUpdate delegate
It's not necessary and won't be invoked before user driver shows the error.
2016-05-06 19:35:13 -04:00
Zorg 9d1e707577 Add probing for updates to sparkle-cli 2016-05-06 19:22:15 -04:00
Zorg bc43e9186f Download cleanup should be before aborting 2016-05-06 19:20:17 -04:00
Zorg 4a2dd657b2 Remove Supporting Files group for sparkle-cli 2016-05-02 02:00:00 -04:00
Zorg 0df9bd6760 Merge branch 'master' into ui-separation-and-xpc 2016-05-02 01:22:58 -04:00
Zorg c2f4be611b Add usage description & options to sparkle-cli 2016-05-01 22:14:49 -04:00
Zorg 702a1dffc0 Add the old and a new postpone relaunch hook to the install driver 2016-05-01 18:23:45 -04:00
Zorg 704518278c Set installer driver's update item when resuming an update 2016-05-01 17:56:42 -04:00
Zorg 738490af07 Fix not showing that updates can be checked before permission request 2016-05-01 17:09:44 -04:00
Zorg 4b75564b5f Remove has launched before check box from Test App
We don't export an API for configuring this in SUUpdater.
Messing with the user defaults is not ideal, and we don't use hasLaunchedBefore anymore

For testing this, the user defaults should just be removed manually, and the test app should be relaunched.
This option never used to work for me that well before anyway.
2016-05-01 16:54:17 -04:00
Zorg 305e33945f Change update permission prompt to prompt after a few hours
The old behavior used to be to prompt on second launch.
However, applications can be re-launched in a short amount of time, and Sparkle can be loaded multiple times during a single app launch.
So prompting after a certain amount of time after first launch works better.
2016-05-01 16:21:22 -04:00
Zorg 350eba452c s/SUUpdatePermissionPromptResult/SUUpdatePermission/ && s/shouldSendProfile/sendProfile/ 2016-05-01 14:54:17 -04:00
Zorg 1356024b25 Add --grant-automatic-checks and --send-profile flags
If an update permission request comes up, this alows us to make a decision.

Also I renamed the defer and checknow flags to defer-install and check-immediately
2016-05-01 14:33:13 -04:00
Zorg 235e93f0c1 Dismiss update installation before aborting update
This fixes bug where the idle status update is invoked before the install is dismissed.
2016-05-01 13:51:57 -04:00
Zorg 7d8d5d1f46 Adjust error message for automatic updates being disabled 2016-05-01 13:51:39 -04:00
Zorg 004da55780 Add error message if bundle paths are invalid/inaccessible 2016-05-01 12:03:50 -04:00
Zorg c0a148f5ff Post relaunch notification only if we are relaunching 2016-05-01 11:54:23 -04:00
Zorg 981f67e8b1 Only trigger update delegate error abort when there's an error 2016-05-01 11:21:04 -04:00
Zorg a4157e5989 Add checknow flag to check for updates immediately
What is new is that we can now disable checking for updates immediately.
sparkle-cli is not intended to be run for a long time, so if the next update check is not soon, we exit.
A client can now launch sparkle-cli without having to necessarily check for updates, so that they don't check for updates too soon.
2016-05-01 02:46:22 -04:00
Zorg 9bea84b29e Fix unit tests from not compiling 2016-05-01 01:10:35 -04:00
Zorg d632dcb72f Add a verbose mode to command line driver 2016-05-01 01:06:38 -04:00
Zorg 11c79b7b2a Add command line argument parsing to sparkle-cli
Also add defer installation option, which will not terminate the application right away.
Rename "relaunch" option as "application" instead.
2016-05-01 00:39:28 -04:00
Zorg 83bb5354dc Use NSRunLoop instead of NSApplication
Don't use AppKit where we don't have to, especially for command line tools
2016-04-30 23:02:21 -04:00
Zorg 15483815ff Pass path to relaunch to sparkle-cli
We also now listen on termination for the app that we are going to re-launch,
rather than the bundle we are updating.
2016-04-30 22:52:04 -04:00
Zorg d9952b8f22 Merge branch 'master' into ui-separation-and-xpc 2016-04-30 14:11:44 -04:00
Zorg ef134d9245 Allow updater to be ran as root & inherit privileges
The installer can now inherit privileges from the updater, which inherits
privileges from the process that spawns the updater. As such, we can now
run the updater & installer as root, and no authorization dialog can prompt up.

The installer now must abort or install if the target app has terminated.
Zombie processes will no longer stay around.

Because the root user has no trash directory, we ignore logging the error if it was not found.
We also avoid invoking mdimport which fails as root on the installed app.
mdimport may have been used before for updating mdimporter files, however, it should be the developer's
responsibility to ensure their mdimporter files have an updated date stamp, which will work if a user updates an app manually.
Other than that, we already touch the app to register it with LaunchServices, so that should suffice.
2016-04-30 12:26:36 -04:00
Zorg 65e2bac89e Improve finding live target app in command line driver 2016-04-30 12:26:25 -04:00
Zorg fdee19ec69 Add installation did finish event. This is not complete.
For sparkle-cli and out-of-process updaters, I added a did finish installing event.

I also have logic dealing with whether an update can be silently installed or not.

I made closing status windows before app termination a reponsibility for the user driver now, not
the installer drivers.

I improved checking for updates before starting the updater, if Sparle didn't ask the user for permission yet.

Currently, Autoupdate can persist in the background even when the app is terminated,
if we don't have sufficient privilleges to install right away for example, or if an update isn't silent.
After much thinking, I need to ditch this strategy because:

1. An app can be manually replaced and so the installer would have to monitor that
2. We leave a zombie process running
2016-04-29 00:37:21 -04:00
Zorg 7183d9ebc5 Merge branch 'master' into ui-separation-and-xpc 2016-04-20 00:05:45 -04:00
Zorg 2c64d98ec8 Mention that OS X 10.8 is required 2016-04-19 23:31:43 -04:00
Zorg 0b640d5d20 Fix bug where updated app can think a new update has already been downloaded
This is fixed by invalidating the local port connection from Autoupdate right before launching the new update
2016-04-19 20:55:36 -04:00
Zorg 8a8cef7dce Add INSTALL file and add XPC services to Distribution target 2016-04-18 21:23:09 -04:00
Zorg 47d8ed8f05 Removing this codesign script because we're not including XPC services in the framework 2016-04-17 23:27:26 -04:00
Zorg 4ea4ece4fd Add XPC service dependencies to Test App 2016-04-17 23:13:27 -04:00
Zorg 3b892524a6 Rewrite ATS check by distinguishing if Sparkle is in XPC service or not
If it's not in a XPC service, then the main bundle decides the rules.
2016-04-17 23:01:20 -04:00
Zorg 2a89393853 Take XPC services out of the framework & make them optional
I'm hoping this will ease some of the build configuration issues I've been running into.
Apps (eg: unsigned, not-sandboxed) don't need to (although they still can) use the XPC services.
Sandboxed apps naturally should use the XPC services. Although, you can for example, choose not to use the
downloader services if the host app already entitlements to allow network connections.

If you use the downloader services, you must configure ATS exceptions in them. And if you use those services,
you probably want to sign them with the required entitlements.

If you don't use the services, Sparkle will fall back on almost-identical code executed within the framework instead.

There may be other reasons to use the services or not other than for sandboxing, like fault tolerance.
Lastly, XPC services work within an application namespace. They are discoverable as long as they're in the app.
That's why we can have an app incorporate the services and let the framework use them.
2016-04-17 21:24:11 -04:00
Zorg 31dc457676 Do some Xcode XPC service cleaning
Rename the XPC service products so that they start with 'Sparkle'
Make the bundle IDs of the services a part of the build configuration, so we can pass it to the preprocessor.
2016-04-17 18:44:06 -04:00
Zorg 22e32a2304 Add codesign script and disable more signing for release modes
We have a custom codesign-after-copy script because Xcode's code sign on copy feature is bad when it
comes to frameworks including signable tools. In release build configurations, nothing we build uses
an ad-hoc code signature. This is logical because ad-hoc signatures are only meant to be used for testing purposes.
2016-04-17 03:20:57 -04:00
Zorg b9f2a24660 Only use ad-hoc signing for Debug type builds and testing
We shouldn't sign Sparkle for Release builds after all..
2016-04-17 00:26:09 -04:00
Zorg a1fa7b1fa3 Make a script file for our ats-exception run script 2016-04-17 00:00:17 -04:00
Zorg 78f2453f2b Don't ad-hoc sign Sparkle
Only the XPC services need to be ad-hoc signed (else Xcode gets cranky),
or targets with entitlements like our Test Application.

Distributing ad-hoc binaries can be mixed with distributing unsigned apps,
and ad-hoc is no worse than unsigned when it comes to distributing, so we're all good.
2016-04-16 23:04:36 -04:00
Zorg d96fd93edf Start the updater in TestAppHelper 2016-04-16 21:48:02 -04:00
Zorg 786d3d4bb6 Remove support for updating without DSA signing
Updating without DSA signing the download is simply not secure.
Before, we were keen on allowing no DSA signing as long as https is used.
However, under the separate process security model, the installer can't know or trust
if the download came over from https. We could move downloading into the installer, but
the installer may run with full privileges one day in the future, and this would
complicate the installer & updater interaction. Furthermore, this could disallow us from being able
to silently download the update in the future if the installer runs at full privileges.

An upside is that the validation and configuration checking code is simpler to read through now.

Even if we could validate that an update came over https, it is still not as secure as people may like to believe.
For example, a hijacked server can choose to manipulate the download (within restrictions), even if it's signed by a developer ID, but not with our DSA support.

Changing of DSA keys and Apple code signing identities is still allowed as long as one of these pairs match and are valid.
Hence requiring DSA signing is also safer when it comes to losing one of your keys. It's only a bit less convenient.
2016-04-16 18:04:47 -04:00
Zorg 88f4557bdd Sign with DSA "and/or" code sign 2016-04-16 17:53:16 -04:00
Zorg 39bc068b89 Move Sparkle debug warning into +load
Also use NSLog here instead of SULog because we don't want to start the logger early on
2016-04-16 17:53:16 -04:00
Zorg e767f6a4c6 Add release build configuration that allows arbitrary HTTP loads
In debug mode we always build with arbitrary http loads, but in release mode we
only want to build sparkle-cli and SparkleTestApp with arbitrary http loads.

An ATS error was added back if arbitrary HTTP loads are not allowed and if the feed URL is http://

The "distribution" target/scheme is now not very up to date because it builds everything under Release configuration.
2016-04-16 17:52:03 -04:00
Zorg 13993aea67 Defaulting NSAllowsArbitraryLoads to NO in XPC info.plist's 2016-04-16 10:21:42 -04:00
Zorg 5eef1d1243 Remove empty configuration files
If specific config files are needed for debug, release, and coverage, they can always be added later.
Right now, they just take up useless space.
2016-04-16 10:15:28 -04:00
Zorg 98f07419aa Remove ATS exception from TestApplication
The XPC services (under debug mode) now handle this.
2016-04-16 01:56:50 -04:00
Zorg 7a0ee291f9 ATS cannot be reliably checked against anymore
An app can contain a XPC service with restricted entitlements and own ATS exceptions.
Indeed, Sparkle now is a framework that embeds two XPC services that include download entitlements.
If ATS is disabled, it'd have to be disabled in those services, not within the root of the application.

So we can't keep this detection because it will generate false positives. And it's not really our responsibility anyway.
2016-04-16 01:52:29 -04:00
Zorg 63e100ae0d Instead of checking for main bundle, check for app bundle
We really want to differentiate between apps and prefpanes/plug-ins.
Using the main bundle is not at all a reliable indicator because an updater could target
any kind of bundle anywhere.
2016-04-16 01:48:54 -04:00
Zorg 291bef326b Require the updater to be started, separate from initializing
This new method also takes an error object as output, which means we can now
read a bundle in Sparkle without having to abort. If a check for updates action is invoked
before the updater has been started, it becomes a pending scheduled operation.
2016-04-15 23:36:12 -04:00
Zorg bab33b66cb Making minor improvements to property/synthesize names 2016-04-12 23:56:24 -04:00
Zorg ad0868ab4f Only use performedStage1Installation property on main thread
Should resolve any thread-safe worries
2016-04-11 21:54:29 -04:00
Zorg 18e666ac3a Don't make a permission prompt decision
We shouldn't change the user defaults on behalf of another application. This may require more thinking..
2016-04-11 09:03:25 -04:00
Zorg acaa021583 Merge branch 'master' into ui-separation-and-xpc 2016-04-11 03:25:00 -04:00
Zorg c105154ba8 Only recursively update access time, not modification time of updates 2016-04-11 02:01:58 -04:00
Zorg d4466d1448 Add Installer Progress depedency to Sparkle.framework 2016-04-11 01:31:32 -04:00
Zorg ee8fed0c2a Remove Sparkle target depedency from BinaryDelta
This shouldn't be needed.
2016-04-11 01:30:10 -04:00
Zorg e1b13f9c67 Add sparkle-cli tool that can update any arbitrary app
I added an application target but it's really intended to be used as a command line tool. The reason being was that it was the easiest way to bundle the Sparkle framework, I've found.

Note this doesn't work perfectly yet, but it's a good start. Trying to update anything that's not Sparkle based will crash for instance. And it will use the installer progress tool which may be undesirable.
2016-04-11 01:29:08 -04:00
Zorg d5f1dcc7c3 Use futimes() when updating mod times recursively 2016-04-11 00:18:32 -04:00
Zorg 88f5d9a6d9 Fix SUAppcastItem's delta updates failing to securely unarchive 2016-04-11 00:09:51 -04:00
Zorg 163a64f3fe Fix unit tests using SUCodeSigningVerifier due to previous commit 2016-04-10 19:43:30 -04:00
Zorg 15c9ae65e7 We support bundles, not applications, in the general sense 2016-04-10 19:41:58 -04:00
Zorg 1151d66337 Remove customized application icon for installer progress
This created more complexity than it was worth and leads to subpar user experience because the user can see the icon switch back to the generic one when the updater terminates. So we now bundle the icon in the install progress tool. If a developer wants to use a custom icon, they can provide their own customized tool.
2016-04-10 19:25:31 -04:00
Zorg 8eb0bc1921 Messed up on argument order here 2016-04-10 17:13:00 -04:00
Zorg 2b84e83ba4 Add customization point to installer progress tool & desired icon 2016-04-10 15:57:47 -04:00
Zorg 5fdc438fa6 Refactor InstallerProgress tool into separate classes 2016-04-10 14:46:05 -04:00
Zorg 7015303726 Pass around download name rather than download path
We know that the download sits in the update directory
2016-04-10 13:51:32 -04:00
Zorg 296154d467 Check the parent directory for writability too 2016-04-10 09:07:00 -04:00
Zorg cd108ef47c Allow automatically downloading updates, but alerting the user immediately
Following cases where after an update has been automatically downloaded, Sparkle may alert the user right away:
1) Critical updates
2) Insufficient write access to install without being root
3) Package type installations

In addition to alerting the user right away, if they dismiss the update, the schedule timer will be on regular intervals. We also no longer need to care about writability in the updater, only just in the installer.
2016-04-10 02:32:54 -04:00
Zorg 5a0ee5d56a Don't follow symbolic links for file operations
This fixes issues with updating modification/access time, and changing owner/group
where symbolic links used to be followed. Tests are included.
2016-04-09 22:33:17 -04:00
Zorg 20e8ea8603 Fix tests that use SUStandardVersionComparator 2016-04-09 21:22:22 -04:00
Zorg e1a9e98d8b Fix implicit type conversion warnings 2016-04-09 18:48:19 -04:00
Zorg 39f82edcf6 Remove standard version comparator singleton
There's no reason for this to be a singleton instance, and the singleton pattern is not even implemented right
2016-04-09 18:13:00 -04:00
Zorg 8d5f1edf39 Remove duplicated header 2016-04-09 18:06:41 -04:00
Zorg beacf49158 Improve authorization handling
Duplicated code from SUFileManager and SUGuidedPackageInstaller has been removed.

SUPlainInstaller now tests if it needs authorization rather than by trying to touch the old app.

SUGuidedPackageInstaller now tries to grab authorization during stage 2 of the installation.
2016-04-09 18:00:47 -04:00
Zorg b3b12dc4be Remove unused variable warning 2016-04-09 16:31:28 -04:00
Zorg bb3a2e299e Don't show installer progress if installer already displays progress 2016-04-09 15:29:18 -04:00
Zorg 33bd47cd1f Fix deprecated API warning for -[NSData initWithBase64Encoding:] 2016-04-09 14:55:55 -04:00
Zorg 61ed9920b4 Use NSURL's checkResourceIsReachableAndReturnError: instead of FSRef's
Fixes deprecated API warning in DMG unarchiver code
2016-04-09 14:44:32 -04:00
Zorg f528f6b2ba Fix warnings for bspatch 2016-04-09 14:36:16 -04:00
Zorg 5f253e8c64 Fix not showing download update initiation when applying delta update fails 2016-04-09 13:43:47 -04:00
Zorg 00cdab1766 s/updateInProgress/canCheckForUpdates/ 2016-04-09 13:22:48 -04:00
Zorg e14077ee9a s/SUUpdaterController/SUStandardUpdaterController/ 2016-04-09 13:21:29 -04:00
Zorg e5b5952287 Avoid probing the installer multiple times 2016-04-09 12:53:49 -04:00
Zorg c80015bf99 Move invoking showCanCheckForUpdates: outside of this completion 2016-04-09 12:35:23 -04:00
Zorg 1bb301e82a Change updateInProgress to canCheckForUpdates
This more accurately reflects its intended purpose. From the beginning,
the user cannot check for updates until the updater is ready;
however this doesn't mean that the update is in progress.
2016-04-09 11:39:02 -04:00
Zorg 933504263a Use Autoupdate's icon for installer progress tool 2016-04-09 01:05:11 -04:00
Zorg 233fa268b5 Add tool for showing installer progress
This tool is only launched if a certain amount of time has passed,
and if we're allowed to show UI
2016-04-09 00:36:09 -04:00
Zorg c178e34d8f Remove unused headers from SUStatusController 2016-04-07 23:07:27 -04:00
Zorg 97a8568491 Add service for remote message port
This allows the updater to communicate to the installer without an additional entitlement
2016-04-04 01:18:15 -04:00
Zorg c4800182a2 Simplify testing for writable permissions to host path
Before there was always lag when checking for updates the first time.
This helps improve consistency.
2016-04-03 21:30:59 -04:00
Zorg b22d2c2568 Make menu item validation work in the test app 2016-04-03 20:06:56 -04:00
Zorg 44a61b830e Move debug warning up in initializer because it spawns really often.. 2016-04-03 20:04:56 -04:00
Zorg 6dedd8309f Handle multiple live remote port connections better
This also should fix a bug where sometimes an update could not be resumed
2016-04-03 19:56:29 -04:00
Zorg 32c687ed79 Make SURemoteMessagePort operations asynchronous 2016-04-03 17:05:56 -04:00
Zorg d7cca8a594 Check if runningApplication is nil for errors.. 2016-04-02 12:17:54 -04:00
Zorg 116c8ea8b7 Supply NSWorkspaceLaunchNewInstance when launching AutoUpdate
I don't think it actually matters since we are launching a copy we created, but
sounds like the right thing to do anyway.
2016-04-02 12:12:48 -04:00
Zorg 38a69cee5b Launch AutoUpdate via LaunchServices again.
I was being stupid for trying to launch the executable rather than the app.
2016-04-02 05:34:31 -04:00
Zorg a3a2310952 Fix Appcast unit tests 2016-04-02 02:14:54 -04:00
Zorg e03607a2d6 Only use SUFileManager in debug mode for the test app
This way we don't have to export it in release mode
2016-04-02 00:10:20 -04:00
Zorg 51e1e1c646 More care to handling invalidation logic 2016-04-01 23:58:32 -04:00
Zorg d5cd64159c Handle error handling for update downloader connection 2016-04-01 23:45:59 -04:00
Zorg 0b19d8d7fd Add error handling cleanup to Appcast Downloader connection 2016-04-01 23:22:52 -04:00
Zorg 92e5c30c0d Move SUUnarchiver.h from private to project 2016-04-01 22:51:10 -04:00
Zorg 9b1d441194 Add warning that Sparkle shouldn't be used when built in Debug
This is for several reasons: ATS, very short default update timer intervals, ...
2016-04-01 22:45:46 -04:00
Zorg e74a397152 Add downloader XPC services for sandboxed apps
ATS exceptions now need to be included in the appcast & update downloader services - *shrugs*.
I've a run script configured to disable ATS for release builds.
2016-04-01 22:41:12 -04:00
Zorg 9525b156a2 Export classes that we are using publicly so release build compiles 2016-04-01 22:36:42 -04:00
Zorg e7f85bb40f Add testing writability as part of SUInstallerLauncher
This is necessary for detecting if automatic updates are possible in a sandboxed environment
2016-04-01 18:56:20 -04:00
Zorg 5c08e0a1d1 Add InstallerLauncher XPC Service
This allows Sparkle to be used as-is in a sandboxed application,
without needing to place Sparkle into its own XPC service.

Currently the main app may need to set a global mach service lookup exception
and a client download exception, however this can be fixed by creating a couple more
services. Testing for disk writability will need be done in a service too.
2016-04-01 17:54:12 -04:00
Zorg ee77bf59d5 IB is not smart enough to parse Nullable attribute 2016-04-01 17:41:28 -04:00
Zorg 009de37415 Remove references to status controller from AutoUpdate 2016-04-01 15:17:18 -04:00
Zorg e0e93e3edf Remove old periodic timer code 2016-04-01 15:15:11 -04:00
Zorg 60fcbe4f88 Call -fileManagerByPreservingAuthorizationRights during cleanup
Since cleanup may be invoked after 2nd stage failed for example.
2016-04-01 15:12:50 -04:00
Zorg c9f66cdeff Don't bring up an authorized dialog during cleanup
If permissions are abnormal during cleanup or somewhere along the lines, it may be
possible to bring up authorization dialog that is not really needed. Prevent this from happening.

We would want to restrict authorization from being possible anyway when not needed.
2016-04-01 15:06:47 -04:00
Zorg 32edf6cc5d Add temporary hack for bringing up authorization dialog right away if needed later 2016-04-01 14:11:30 -04:00
Zorg 941ae6481f Read the allowsUI flag again for performing installation work
Also some code cleanup. In the future, we may want to figure out authorization
before extraction even occurs.
2016-04-01 13:55:34 -04:00
Zorg e0b3a128b0 Revert 3 stage installation..
Just do all installation in 3rd stage at the moment and reconsider this idea..
Doing any work prior to finishing the installation that requires keeping files in
a temporary directory for potentially a long time turns not to probably not be a great idea.
Unfortunately I don't think trying to keep the files up to date every some interval is a _great_ idea.
I will need to rethink this some more.
2016-03-31 00:53:01 -04:00
Zorg 9e6f376285 Add periodic timer for preventing temporary file cleanup
This is inevitable if we stick to a three stage installation.
The other direction to consider is to defer most installation until after the app terminated,
although that may have disadvantages of its own.

One important addition is touching the new app recursively before moving it in a temp directory.
This is important because archives can preserve modification & access times, but we don't want that.
2016-03-29 01:15:39 -04:00
Zorg 5c624eccbe Fix issues with unit tests 2016-03-27 22:58:41 -04:00
Zorg e792798294 Forgot to invoke download receive response/progress user driver callbacks 2016-03-27 22:29:23 -04:00
Zorg 08696841c2 Fix bug where generic error dialog was shown when no update was found 2016-03-27 21:57:06 -04:00
Zorg 0b94f56f7f Rename some user driver delegate methods 2016-03-27 19:03:28 -04:00
Zorg d12121a265 Add SUUpdaterSettings class, allowing to read default settings.
This is convenient if the updater and app live in separate processes.
No need to use XPC to find out what certain settings are, and it may take too long to find out that way.
2016-03-27 18:44:36 -04:00
Zorg 9bb87b2018 Move installationPath out from SUHost
It's not too relevant to SUHost, and mostly relevant to the installer.
Plus its output can depend on whether a certain file exists on the system.
2016-03-27 17:54:38 -04:00
Zorg 6de75413e8 Don't show user initiated progress when resuming an update
Retrieving the data to resume an update happens very quickly.
2016-03-27 16:36:24 -04:00
Zorg b27255468a Update cycle should only be reset if update is not in progress 2016-03-27 16:11:17 -04:00
Zorg b0963583ba Remove unused header 2016-03-27 16:03:55 -04:00
Zorg 46387097c1 These resets are not necessary 2016-03-27 16:03:23 -04:00
Zorg c58eaa205e Remove -[SUUpdater updateInProgress]
This method is not used anymore internally. Outside, the user driver should
be used instead.
2016-03-27 15:56:17 -04:00
Zorg ac0aaddefa Use -resetUpdateCycleAfterShortDelay internally but don't expose it publicly 2016-03-27 15:51:52 -04:00
Zorg 528c6f25ed Remove user defaults observing in standard updater controller
If these settings are changed, they should be changed through SUUpdater, honestly.
Morever, this user defaults code retains the controller.
2016-03-27 15:46:40 -04:00
Zorg a8252cbe20 This is supposed to be main bundle actually 2016-03-27 14:51:36 -04:00
Zorg 7fc6896170 Move automatic updates property from SUHost into SUUpdater
SUHost cannot properly detect if automatic updates are allowed due to write permissions,
thus it should not be a property of SUHost at all.
2016-03-27 13:33:28 -04:00
Zorg 9c7d41dd90 Updating SUUserDriver docs 2016-03-27 00:08:01 -04:00
Zorg eddf611ede Decryption password should now be supported 2016-03-26 23:46:27 -04:00
Zorg 8184838835 Explain reasoning on re-assigning updateItem here 2016-03-26 23:16:17 -04:00
Zorg 301f3bf4e3 Move appCachePath out of SUHost for process independence
The behavior depends on what kind of process is invoking is, which is no good.
2016-03-26 22:54:08 -04:00
Zorg fb32c8e18a Fix unarchiving unit tests 2016-03-26 02:20:34 -04:00
Zorg 8e4498adaf Refactor unarchivers to use protocols and less dynamism/global state
Before there were implicit dependencies and unarchivers were globally registered as their classes were loaded.
This flexibilty is unnecessary and comes with a safety (eg: forgetting to link in a class) and harder to read cost
2016-03-26 01:54:15 -04:00
Zorg 9d6f196111 Dismiss user initiated update check progress after appcast is loaded
Fixes bug where the update check progress window could still be visible after the appcast loaded successfully
2016-03-26 00:12:28 -04:00
Zorg 06c2f47024 Make delta updates & multiple download attempts work. 2016-03-25 23:58:05 -04:00
Zorg 1e9292acf4 Merge branch 'master' into ui-separation-and-xpc 2016-03-23 22:37:11 -04:00
Zorg 5d1d2291a0 Don't see why handledResumeInstallationToStage2 is needed actually 2016-03-21 21:17:18 -04:00
Zorg 65a6d41147 Merge branch 'master' into ui-separation-and-xpc 2016-03-21 01:12:34 -04:00
Zorg 4042068c82 Fix Appcast unit tests 2016-03-21 01:09:25 -04:00
Zorg a3c950f480 Remove unused function 2016-03-21 00:57:31 -04:00
Zorg a1d08a354d Add updater resumability, merge automatic & regular update prompts
Resumability works by asking the installer for its progress and for the appcast item we've given it before.

If an automatic silent download occurs, we abort it after the installer tool finishes with its basic steps.
Then, a user initiated or scheduled check can resume the update. The scheduled check fires during a longer-than-normal
span since usually the user can install by quitting the app, unless the app has been alive for a very long time.
One exception to this is when the update is marked critical; in that case, the scheduled check is fired immediately after
an automatic update download. Subsequent attempts will be fired using a normal update check interval.

Todo: delta updates probably don't work when they fail and fallback to a regular update
2016-03-21 00:46:34 -04:00
Zorg 615f71474b Fix retain cycle by making these references weak 2016-03-20 13:16:36 -04:00
Zorg 4e8a39267d Fix memory corruption issue when copying CFDataRef bytes
Copy the bytes manually using -[NSData dataWithBytes:length:]
If we use -[NSData copy] instead, we may be using already freed memory
(according to ASAN), which is no good. This may be because the bytes aren't
deep copied.

Also add some @autoreleasepool wrappers because why not.
2016-03-19 22:06:33 -04:00
Zorg 56a75bd4b6 Fix update scheduling not always firing 2016-03-19 15:25:44 -04:00
Zorg 87275b23c8 Refactor update drivers
This removes subclassing usage making the code harder to follow.
Todo: handle resuming an update already waiting to be installed,
adding impatience timer for automatic update scheduling
2016-03-19 12:09:11 -04:00
Zorg 1e645e8bd7 Remove resources/source files Autoupdate doesn't use anymore 2016-03-13 19:50:28 -04:00
Zorg d44094a692 Fix installer tests and add comment about running them 2016-03-13 19:32:58 -04:00
Zorg cb0b7c8cfe Remove all termination logic from the user driver
Autoupdate is now responsible for all of this. The user driver implementation is shorter and less complex now.
2016-03-13 19:18:51 -04:00
Zorg af126d9c82 Update automatic update driver to reflect AutoUpdate changes 2016-03-13 18:56:02 -04:00
Zorg f918368c72 Change SUCancelUpdateInstallation to SUDismissUpdateInstallation
Since this is not really canceling the installation anymore.
2016-03-13 16:52:25 -04:00
Zorg 85517dd0dd Don't think I need to handle this 2016-03-13 16:19:28 -04:00
Zorg d78f487596 Remove tempDir deletion warning 2016-03-13 16:17:51 -04:00
Zorg e7fdfb9dc9 Don't handle out of order messages 2016-03-13 16:17:24 -04:00
Zorg 64c17df1e6 Improve TerminationListener by observing NSRunningApplication instance
Listening for app termination doesn't require polling anymore.
2016-03-13 14:26:12 -04:00
Zorg f82a698937 Handle installer cleanup occur after any stage 2016-03-13 13:39:28 -04:00
Zorg b10202769f Documenting the SUInstaller protocol 2016-03-13 13:27:53 -04:00
Zorg 194c0ed63a Split installation into more stages.
We now have a stage where authorization is allowed (when the user intiates a relaunch).
This stage occurs before the user application is terminated (if the operation succeeds).

An install attempt will always be made after the validation is finished now. However, if the
user doesn't explicitly relaunch the app, we don't bug the user about auth prompts which means
updates can fail in this kind of scenario.
2016-03-13 13:09:36 -04:00
Zorg 72d3634f32 Merge branch 'master' into ui-separation-and-xpc 2016-03-12 20:07:39 -05:00
Zorg 25ab5a1870 Move SUUpdater references out of update drivers
This decreases coupling for the updater and updater drivers.

We still pass in the updater because we need it for invoking the updater delegate's methods,
but we now use type 'id' instead of SUUpdater* because we don't want to invoke anything on the object.
Furthermore, we never #import SUUpdater, only forward class declarations.
2016-03-12 19:57:28 -05:00
Zorg f4869e584c Improve grammar 2016-03-12 18:28:08 -05:00
Zorg 079f1e33bc Guard against more than 1 initialization more strongly 2016-03-12 18:26:54 -05:00
Zorg 84ad85c253 Don't use main bundle in SUStandardUpdaterController 2016-03-12 18:24:29 -05:00
Zorg 6753c788f8 Fix issues with unit tests
I added public DSA file, automatic update checking, disabled system profiling
in the unit test's info.plist so that SUUpdater won't complain that DSA is missing,
and it won't prompt for update permission the first time.
2016-03-12 18:21:07 -05:00
Zorg 4dcef32eb4 Fix unit tests from not building/passing.
UI tests will fail right now due to the current custom UI I'm using.
2016-03-12 16:44:52 -05:00
Zorg 38abfca4b0 Remove more unused #imports 2016-03-12 16:12:33 -05:00
Zorg 46256b297b Do not pass the user driver in delegate methods
This is bad for a number of reasons.

1. Our SUUserDriver protocol wasn't quite the right protocol to pass in.
2. This made the UI/Core components to hold a depedency to the user driver, when it
really was not used for anything other than passing to the delegate. We can now
remove this bidirectional depedency between the components and the user driver.
3. This encourages that the client can handle multiple user drivers within the same class,
which encourages complexity. If they were able to set the delegate, they should have a reference
to the user driver.

Indeed, SUUpdater, SUUpdaterDelegate, and the update drivers all have the same problem.
An unfortunate design decision..
2016-03-12 15:53:00 -05:00
Zorg 2a277c24b5 Put SUInstaller protocol into its own file 2016-03-12 14:43:27 -05:00
Zorg 25b451b4c2 Remove unused #imports 2016-03-12 14:43:11 -05:00
Zorg cee120065f Split installation work into stages
This is to minimize the amount of time the app is left terminated.
App restarts should always be near instantaneous.

More work needs to be done to make authenticated installs more friendly,
and not making installs abortable after validation is done.
2016-03-12 13:25:07 -05:00
Zorg 59bbcfadb0 Initial work on separating the updater & installer
The installer (Autoupdate.app) is now responsible for extracting & verifying the update.
It talks to the updater via mach ports. We can't afford to use a XPC service due to
lack of perfoming privileged tasks.
2016-03-10 01:49:59 -05:00
Zorg 73a0f10010 I don't see installerForHost:error: used anywhere
We can also demote relaunchPath from being an ivar
2016-03-08 00:22:57 -05:00
Zorg 6f30ae2093 Remove passing duplicated host path 2016-03-08 00:16:03 -05:00
Zorg 7ea2d0f9cf Separating Autoupdate into separate files 2016-03-08 00:00:00 -05:00
Zorg 57f0bc4245 Make download validation function take a SUHost 2016-03-07 23:24:35 -05:00
Zorg cf3674b2d7 Exit on failure here 2016-03-07 23:15:40 -05:00
Zorg 00368011c8 Add delegate outlets to SUStandardUpdaterController
This adds delegate outlets to the updater and to the user driver, so a
developer can hook either of them up. Note we now initialize the updater and
user driver after being awoken from the nib.

We also took this chance to make the delegates to the updater and user driver read only.
This means that the delegates have to be available on initialization, which is good because
changing delegates or setting delegates too late (and missing messages) is bad.
2016-03-06 23:38:17 -05:00
Zorg 1e92d403ec Improve SUUpdater docs 2016-03-05 17:33:27 -05:00
Zorg f2b9ae97c2 Merge branch 'master' into ui-separation-and-xpc 2016-03-05 15:06:25 -05:00
Zorg 96f016a790 Add acknowledgement handlers to no update found / errors
This way, if the errors are not presented modally, they won't be dismissed
until we tell the updater we are finished acknowledging them
2016-03-05 14:42:17 -05:00
Zorg 337f39e8b9 Just log an error instead of changing update button
Because the update installation will be aborted soon anyway..
2016-03-05 13:33:32 -05:00
Zorg 53719cc8b7 Fix termination being delayed when connection is invalidated 2016-03-05 13:12:52 -05:00
Zorg 5dca54d904 Add custom user driver in the test app 2016-03-05 12:59:11 -05:00
Zorg 30cb984341 Split SUStandardUserDriver into re-usable components 2016-03-05 00:17:41 -05:00
Zorg 43942bcbad Remove UITests-Info.plist being copied to UI Tests bundle 2016-03-04 20:13:02 -05:00
Zorg ed72d25eaa Re-sign the altered/new test app
For sandbox testing, we really have to use ad-hoc signing.
Which means we have to sign the "new" app after we alter its info.plist file,
so that our code signing verifier doesn't (rightfully) complain
2016-03-04 20:05:33 -05:00
Zorg db4e8a9946 s/SUUpdaterController/SUStandardUpdaterController.m/ 2016-03-04 19:25:25 -05:00
Zorg 0338cd443a This should not be wrapped in an exception 2016-03-04 19:19:28 -05:00
Zorg f2e485df87 Add proper remote updater idling support
Meaning that we don't send a message or re-establish the XPC connection
immediately when something goes wrong
2016-03-04 19:00:47 -05:00
Zorg 58f4e97f9c Note about being dispatched on main queue 2016-03-03 22:31:49 -05:00
Zorg af8e195cd9 Handle app termination better with regards to automatic updates
We should terminate even if the update aborts.

We should also terminate even if the connection is invalidated or interrupted, if we've
already been told to quit
2016-03-03 22:28:38 -05:00
Zorg 2e44a5ecc5 Reverting code signing since our verifier doesn't look ad-hoc signatures 2016-03-03 22:12:55 -05:00
Zorg 6c9cbbb389 Set deployment target to 10.8 2016-03-03 20:02:01 -05:00
Zorg 045de30926 Clean up last bit of warnings 2016-03-03 19:59:16 -05:00
Zorg 62fa723564 Use ad-hoc code signing for test app so Xcode won't complain 2016-03-03 19:55:40 -05:00
Zorg cc5826d2f1 Add SUStandardUserDriverDelegate.h 2016-03-03 19:45:52 -05:00
Zorg a652ab952e Add documentation to dismissUpdateInstallation for SUStandardUserDriver 2016-03-03 19:40:25 -05:00
Zorg ada2688b86 Set up invalidation and interruption XPC handlers 2016-03-03 19:20:01 -05:00
Zorg f5a9cf14de s/SUSparkleUserDriver/SUStandardUserDriver/ 2016-03-03 18:29:15 -05:00
Zorg 5f572854d2 Improve docs on showing update is found, plus some formatting 2016-03-03 18:08:34 -05:00
Zorg 8a42975dc2 Add test application code for Sparkle over XPC 2016-03-03 03:03:56 -05:00
Zorg ed00162faa Fix project header imports 2016-03-02 01:44:03 -05:00
Zorg 65f16e7e8c Make delegate methods optional 2016-03-02 01:43:51 -05:00
Zorg 1b9d93f739 Add initForBundle: back just so we can raise an exception 2016-03-02 01:22:54 -05:00
Zorg 9ee8a6d314 Wrap initializer with standard if self != nil check 2016-03-02 01:15:10 -05:00
Zorg b58eeeabb5 Add docs to SUUpdater initializer 2016-03-02 01:13:33 -05:00
Zorg 5eb715f1f3 Added docs to sparkle's user driver
Also split SUSparkleUserDriverDelegate into two protocols, since it
just makes sense.
2016-03-02 00:53:28 -05:00
Zorg 4a2c3dd922 Update docs on SUUpdaterController 2016-03-01 23:18:44 -05:00
Zorg ad26fe9627 Use -[SUSparkleUserDriver updateInProgress] instead
If a developer doesn't want to use SUUpdateController, it'll be
clear to them how to implement the menu item validation
2016-03-01 23:15:08 -05:00
Zorg 772c6b7d3f Just add Sparkle user driver reference to SUUpdaterController 2016-03-01 23:03:05 -05:00
Zorg 8b0eae8ef4 Revert deferring startUpdateCycle in SUUpdater init
I decided it was less evil to allow SUUpdater to defer cycling and have
a mutable delegate, than it was for SUUpdateController to have a nullable SUUpdater
that could be instantiated an arbitrary time later

I have also changed the delay from 0 to 1, on the safer side.
2016-03-01 22:46:15 -05:00
Zorg 1da4ee961c Add delegate as parameter to SUUpdater's initializer 2016-03-01 22:22:05 -05:00
Zorg efac2acf57 Change SUUpdaterDelegate to be weak reference 2016-03-01 21:51:02 -05:00
Zorg 077b0c7bc9 Separate out UI bits from SUSparkleUserDriver delegate protocol 2016-03-01 21:40:13 -05:00
Zorg f5bc152f1c No longer true 2016-03-01 21:25:40 -05:00
Zorg ba4bbbb99a Rename UserUpdaterDriver -> UserDriver
This ends up to be more natural to me.
2016-03-01 21:24:50 -05:00
Zorg d3a09cc68a Move custom version displayer away from SUUpdater delegate
This is a UI related protocol and thus should be part of the user updater driver,
not a part of the core updater.
2016-03-01 21:09:28 -05:00
Zorg dafdcf21b6 Add more nullability specifiers 2016-03-01 20:15:45 -05:00
Zorg 1b46ecf663 Improve SUUpdaterController docs and add nullability specifiers 2016-03-01 20:08:21 -05:00
Zorg dd3c698f3e Add documentation to SUUpdaterController 2016-03-01 19:48:56 -05:00
Zorg 30c2ba125b Remove IBOutlet attribute for SUUpdater delegate 2016-03-01 19:37:39 -05:00
Zorg f26811b439 Document resetUpdateCycleAfterShortDelay and updateInProgress 2016-03-01 19:19:01 -05:00
Zorg 7dd3e02546 Clarify why automatic update driver doesn't listen for system power off 2016-03-01 19:11:07 -05:00
Zorg 0c41fafb47 Add more doc notes to SUUserUpdaterDriver.h 2016-03-01 18:53:37 -05:00
Zorg 3362ea174a Remove SUAutomaticInstallationChoice since it was duplicated definitions 2016-03-01 02:50:44 -05:00
Zorg cea47960dd Fix filename in comments 2016-03-01 02:37:24 -05:00
Zorg 721ccdc5d9 Adding documentation comments to SUUserUpdaterDriver 2016-03-01 02:36:42 -05:00
Zorg 49c10c8cb5 Move Sparkle's user updater driver delegate protocol out of SUUserUpdaterDriver 2016-03-01 00:16:59 -05:00
Zorg 0a6db8ef7a I can verify this later 2016-03-01 00:02:34 -05:00
Zorg cf31592e4a Ignore deprecated warnings for calling alert modal methods on updater delegate 2016-02-29 23:47:44 -05:00
Zorg 097784db95 Cancel update cycle and abort updates in SUUpdater's dealloc 2016-02-29 23:41:39 -05:00
Zorg b6fe5ea289 Move permission checking of allowing automatic updates to SUUpdater
SUHost can be called from any process with different privilege levels,
so it can't determine if the user can install to the app bundle without issue
2016-02-29 22:48:27 -05:00
Zorg f7b6a70979 These two classes are not referenced here anymore 2016-02-29 18:27:33 -05:00
Zorg 7c16419a6d SUUpdatePermissionPromptResult is a core/non-UI class 2016-02-29 08:38:28 -05:00
Zorg 253f544bbe Remove old localized byte count code 2016-02-29 08:28:54 -05:00
Zorg 16b9d47cbe SUHost can go back to non-public header
Although I don't know if this should be the final decision on that matter.
If users create their own user drivers, will they want SUHost?
2016-02-29 03:04:36 -05:00
Zorg d3ed152e1a Let SUSparkleUserUpdaterDriver take a NSBundle instead of SUHost
This way we don't have to expose SUHost to public anymore, I think
2016-02-29 03:00:12 -05:00
Zorg 5e87fe6daa Let delegate tell us if it's responsible for signaling termination 2016-02-29 02:53:50 -05:00
Zorg 34cf472834 Import Foundation in SUStatusCompletionResults.h 2016-02-29 02:29:22 -05:00
Zorg 1278a34d3b Move SUUserUpdaterDriverDelegate into its own source file 2016-02-29 02:28:51 -05:00
Zorg 1aa6f88819 Move status completion results into a new header 2016-02-29 02:23:15 -05:00
Zorg 829a88be58 Remove references to IOKit 2016-02-29 01:48:01 -05:00
Zorg 4a26c395d8 Add no-AppKit guards against all "core" files
Also move system shut off handling to the user driver.
Observing system shut off is difficult without AppKit, and
a client may want to observe for varying types of events.
I suppose this is consistent with application termination
notifications though.
2016-02-29 01:42:16 -05:00
Zorg 02ee6f9c15 Fix bad typo :\ 2016-02-28 22:53:57 -05:00
Zorg 6c1aa38ac9 Mm.. I don't think so. 2016-02-28 22:16:51 -05:00
Zorg 45e6951552 User updater driver is now aware about updates being in progress or not 2016-02-28 22:10:58 -05:00
Zorg 8c769ca9cd Raising exception if -[SUUpdater init] is called 2016-02-28 21:28:46 -05:00
Zorg 2e28d47d48 Add some docs on SUUpdateController 2016-02-28 21:21:40 -05:00
Zorg 21b49d41a2 Make sure updater is not nil for menu validation 2016-02-28 21:15:43 -05:00
Zorg 8325c9a4d9 Remove duplicated referenced classes in test app and framework 2016-02-28 21:05:23 -05:00
Zorg 6ade2f270b Don't see why this method should be very generic 2016-02-28 21:01:49 -05:00
Zorg 15b4d1adf3 Add a "Updater NIB" object for standard sparkle UI
I may consider  extending SUUpdater instead of another controller..
2016-02-28 20:18:06 -05:00
Zorg 7f494f13be Fix not observing driver finishing notifications 2016-02-28 20:16:47 -05:00
Zorg 34ad4cfd6b Add note about has launched before logic needing improvement 2016-02-28 18:03:38 -05:00
Zorg cba11cac2d Don't need to forward declare these methods 2016-02-28 17:50:00 -05:00
Zorg 3725d1e14d We don't need to delay update cycle from SUUpdater anymore 2016-02-28 17:48:47 -05:00
Zorg cfd462002c Let AutoUpdater relaunch itself through LaunchServices
This solves several problems:
1) we can't spawn a task reliably from a XPC process
2) we don't want to link to AppKit from SUBasicUpdateDriver
3) spawning a task to invoke open utility is poor with bad inputs
2016-02-28 17:46:29 -05:00
Zorg caf5e01643 Merge branch 'best-update-by-version' into ui-separation-core 2016-02-28 15:52:00 -05:00
Zorg 196bb64483 Be extra careful the updater is passed as a weak reference 2016-02-28 15:40:33 -05:00
Zorg 30abbb238a Fix AutoUpdate activation issues
Forcing the app to activate after we show the status window in AutoUpdate seems to work better
2016-02-28 15:34:11 -05:00
Zorg dccce32beb Temporary fix for running the test application 2016-02-28 15:18:09 -05:00
Zorg 680484f7c2 SUWindowController can be removed; it doesn't do anything 2016-02-28 15:09:09 -05:00
Zorg 030725ff2d Replace Cocoa imports with Foundation in unit tests 2016-02-28 14:52:39 -05:00
Zorg cd83dd3769 Removing NTSynchronousTask for good 2016-02-28 14:45:16 -05:00
Zorg f88eec8105 Remove NTSynchronousTask from SUCodeSigningVerifierTest 2016-02-28 14:11:54 -05:00
Zorg c6df59c7b0 Fix code signing verifier tests for me 2016-02-28 14:06:05 -05:00
Zorg 876c7af538 Move finding active host pid into Autoupdate
Also use 'open' instead of NSWorkspace to remove our dependency on AppKit
2016-02-28 13:38:51 -05:00
Zorg 513d7f39a1 Use SUFileManager to move the temp item to the trash 2016-02-28 12:27:53 -05:00
Zorg 3e64da75b6 Replace Cocoa import with Foundation wherever possible 2016-02-28 11:59:27 -05:00
Zorg 6041d68db6 Add note about .pch usually being a bad idea 2016-02-28 11:41:09 -05:00
Zorg d216f30f47 More secure coding implementation forgot to remove 2016-02-28 11:37:35 -05:00
Zorg 8af18843ef Move AppKit functionality from SUHost to SUApplicationInfo
These operations also make incorrect assumptions when called from out of process,
so it makes sense to separate them out. Furthermore, SUHost can now only depend on
Foundation
2016-02-28 11:36:11 -05:00
Zorg 2a13d62838 Forgot to remove this secure coding implmentation 2016-02-28 11:09:48 -05:00
Zorg 1fc1d3598a No need for SUSystemProfiler singleton, and SUHost doesn't need to know about it 2016-02-28 11:09:11 -05:00
Zorg 0d7b0037a1 Remove unneeded deps from SUHost 2016-02-28 10:51:31 -05:00
Zorg 4a3f0ad984 Pass the SUHost into the driver's constructor 2016-02-28 02:00:57 -05:00
Zorg f630188255 Remove/modernize a bunch of cruft
Yeah, this isn't backwards compatible with older code that uses Sparkle

Few notes:
* Mostly everything from *.pch has been moved out for saner dependency tracking
* 10.7 compatibility has been removed out so I don't import Cocoa when I don't have to
* sharedUpdaters/SUUpdater singletons has been removed out so updaters can actually be deallocated properly
 (and since singletons are generally horrible idea anyway)
* SUUpdater doesn't have UI/cocoa/bindings/menu validation code. Its new initializer method takes a user driver
 (perhaps in the future I'll create another class that "binds" the UI and core)
2016-02-28 01:39:15 -05:00
Zorg b5a1826a47 finishTermination property is no longer used 2016-02-27 21:47:27 -05:00
Zorg 717f741977 Simplify sending termination signal from the user driver 2016-02-27 21:13:26 -05:00
Zorg 3d2958326c Looks like standard Foundation classes (NSNumber, NSString) are safe 2016-02-27 20:30:18 -05:00
Zorg 3bf91e795e Move delegate protocol to SUUserUpdaterDriver protocol 2016-02-27 19:59:39 -05:00
Zorg cdea8015d3 Merge branch 'master' into ui-separation 2016-02-27 19:41:27 -05:00
Zorg bea00a99e8 Update SULoggerUpdateDriver example 2016-02-27 19:40:09 -05:00
Zorg 0e7eba5ae9 Add note about not dispatching to main queue again 2016-02-27 19:31:53 -05:00
Zorg aee0b6f7d8 Allow user driver's delegate to handle initiating update checks
In a XPC environment, a delegate may handle update checks by sending a message
to the XPC process that tells it to reset the sparkle updater's check cycle.
If the user driver delegate can do this, the XPC process will not need to wait
for a reply, allowing the system to kill the XPC process when it becomes idle.
2016-02-27 17:54:19 -05:00
Zorg dec088b9ad Dispatch reply blocks to main queue 2016-02-27 16:41:05 -05:00
Zorg fbfcbbdf2d Move check update timer into the user driver
In an XPC environment, XPC processes may be killed if they are considered idle.
Thus, we must do the update checking in the user driver.
2016-02-27 16:28:25 -05:00
Zorg 3230fd982b Change SUUserUpdaterDriver so that every reply block must get a response
These changes are to make XPC environment more friendly. Every reply block must
get a response and is not optional to respond to. For example we can no longer have
a reply block that is just "cancelUpdate()"; it must now take an option whether
we are done now or if we want to cancel, and the receiver should now be aware
when canceling doesn't make sense (i.e, if update already aborted). Furthermore,
a reply block must get exactly *one* response.
2016-02-27 14:00:28 -05:00
Zorg b6d1726d77 Cleanup showing update alerts and use weak references 2016-02-26 20:28:35 -05:00
Zorg 582381a5df Add note about permission dialog being modal 2016-02-26 20:06:11 -05:00
Zorg beae77136b Preserve & deprecate SUUpdater show modal alert methdods
Just to keep backwards compatibility as an option
2016-02-23 22:29:25 -05:00
Zorg e20ecce343 Make sure delegate responds to methods 2016-02-23 21:58:58 -05:00
Zorg 14f56c519b Move modal alert delegation to user updater driver 2016-02-23 21:56:14 -05:00
Zorg cd66b1013a Modal alert methods no longer needed for SUSparkleUserUpdaterDriver 2016-02-22 23:27:23 -05:00
Zorg a6d6e31b2c Remove asking user updater driver if it's showing alerts modally
non-void/synchronous calls over XPC don't work properly, and
these methods don't seem very proper architecture wise anyway.
A proper solution will be needed for notifying the delegate of modal alerts
2016-02-22 23:21:27 -05:00
Zorg 308cfe36cf Don't assume the host is our original application for code signing verification
Tested to make sure this the verification didn't break
2016-02-22 22:50:37 -05:00
Zorg b6e558d82e Timeout if target app takes too long to terminate
This makes the AutoUpdate app less trusting for the target app
2016-02-21 23:42:03 -05:00
Zorg a9df54eb98 Replace critical Sparkle error alerts with raised exceptions
Alert UI does not belong here. And since these are critical errors,
they should not be recoverable (i.e, user can't just hit 'OK')
2016-02-21 17:30:45 -05:00
Zorg f00978c87b Move -dismissUpdateInstallation call into basic update driver 2016-02-21 16:57:54 -05:00
Zorg 0e97f0b4b6 Handle app termination in the user driver
If an automatic update needs to be applied at termination,
the app delegate will need to hold responsibility of delaying
termination until Sparkle is ready to relaunch
2016-02-21 13:24:54 -05:00
Zorg 5a60ddaf8c activeUpdateAlert needs to be a strong reference 2016-02-21 00:48:49 -05:00
Zorg c3824b4c20 Making dismissUpdateInstallation independent of installation type
Also clean up warnings/temporary comments
2016-02-21 00:26:51 -05:00
Zorg 6b5a3547e7 Cleaning up SUUserUpdateDriver protocol 2016-02-20 23:52:24 -05:00
Zorg 1ebb150a1b Null out applicationWillTerminate block reference 2016-02-20 21:44:30 -05:00
Zorg 80bdd318ba Condense manual vs automatic update alert code 2016-02-20 21:36:16 -05:00
Zorg 1fad56c4c3 Add user driver methods for automatic updating
Note that the protocol API for the user updater driver can still be improved.

applicationWillTerminate: is done from the user driver because that's the only way that will
function across different processes.
2016-02-20 19:39:48 -05:00
Zorg 835f4ac5b5 Forgot to remove -openInfoURLForAppcastItem: from previous commit 2016-02-19 21:07:48 -05:00
Zorg e6ac015dde Remove opening info URL from being an update alert choice
This option is really "do something in user driver & remind me later"
2016-02-19 21:00:54 -05:00
Zorg 6acbf0010a Merge branch 'master' into ui-separation 2016-02-19 19:56:43 -05:00
Zorg 0bb5de196a Remove initializer taking SUHost from SUUserUpdaterDriver 2016-02-19 17:27:44 -05:00
Zorg 48e0febf1a Add NSSecureCoding to SUUpdatePermissionPromptResult 2016-02-15 00:18:01 -05:00
Zorg 480feff34f Update postponing code is not as bad as I thought 2016-02-15 00:08:07 -05:00
Zorg 1cfbffa74c Making Sparkle more XPC friendly
We support NSSecureCoding for SUAppcastItem and SUHost

Callbacks from XPC <-> Host app now async to main GCD queue.
This is needed for everything to be thread safe.

Todo: NSDate parsing sucks and is temporarily disabled.
In particular, we're using deprecated methods to read the dates,
which don't support NSSecureCoding. The other problem is that the dates are
really useless technically and we shouldn't sort by them.
2016-02-15 00:00:01 -05:00
Zorg a9f1e2d919 Add SUSparkleUserUpdaterDriver.h to Sparkle.h 2016-02-14 21:16:48 -05:00
Zorg 46a2485d9c Created custom user update driver protocol
Everything related to the protocol is intended for showing & dismissing progress,
as well as making UI actions such as canceling, installing, confirming update permissions
2016-02-14 20:57:32 -05:00
Zorg 7ca99547b9 Add note about default icon assumption potentially being off 2016-02-14 13:18:32 -05:00
Zorg 96fb18e0df Launch AutoUpdate via NSWorkspace instead of NSTask
This will allow the app to run normally without being terminated because
a XPC service was terminated
2016-02-14 09:47:16 -05:00
Zorg 2ef497afcd Added delegate methods to all UI bits
This is still incomplete and not perfect yet.

In particular, these delegate methods ought to perhaps be grouped in a separate class.

The UI code that is currently done should be treated the same manner as a custom UI

Relaunching Sparkle should give customization over showing the UI of the autoupdater app
2016-02-13 23:09:01 -05:00
Zorg 0a29626615 Initial work on UI separation
Separated just the permission prompt so far
2016-02-11 23:45:36 -05:00
673 changed files with 45334 additions and 15270 deletions

No files matched your search

@@ -1,11 +1,24 @@
---
name: Enhancements and Bug Fixes
about: Found a bug? Want to implement a new feature?
about: Found a bug? Want to implement a new feature? Something else?
title: ''
assignees: ''
---
<!--
If this is a question or an idea, please consider posting in Discussions first:
https://github.com/sparkle-project/Sparkle/discussions
Otherwise the answer to your issue may already be in Console.app on your computer.
Please use Console.app and search for Sparkle.
Please try troubleshooting steps:
https://github.com/sparkle-project/Sparkle#troubleshooting
-->
## Summary
[provide general summary to the issue or enhancement and its rationale]
@@ -16,4 +29,4 @@ assignees: ''
## Version
[please specify versions of Sparkle this is applicable to; note new pull requests must be developed and landed in 2.x development branch first]
[please specify versions of Sparkle this is applicable to]
@@ -1,34 +0,0 @@
---
name: Sparkle 2.x doesn't work in my app
about: Problems with using the beta version of Sparkle 2
title: ''
labels: '2.x'
assignees: ''
---
<!--
The answer to your issue is probably already in Console.app on your computer.
Please use Console.app and search for Sparkle.
Please try troubleshooting steps:
https://github.com/sparkle-project/Sparkle#troubleshooting
-->
### Description of the problem
### Do you use Sandboxing in your app?
### Version of `Sparkle.framework` in the latest version of your app
### Version of `Sparkle.framework` in the old version of app that your users have (or N/A)
### Sparkle's output from Console.app
```
```
### Steps to reproduce the behavior
@@ -1,8 +1,7 @@
---
name: Sparkle 1.x doesn't work in my app
about: Problems with integration, unexpected errors
name: Sparkle doesn't work in my app
about: Problems with integration, unexpected errors using Sparkle
title: ''
labels: '1.x'
assignees: ''
---
@@ -32,3 +31,5 @@ https://github.com/sparkle-project/Sparkle#troubleshooting
```
### Steps to reproduce the behavior
[The more information provided and pasted verbatim, the easier it will be to diagnose an issue. If you can provide the affected application/binary and XML feed to reproduce an issue, share them]
+3 -11
View File
@@ -2,18 +2,10 @@
Fixes # (issue)
## Checklist:
## Misc Checklist
- [ ] My change is being tested and reviewed against the Sparkle 2.x branch. New changes must be developed on the 2.x development branch first.
- [ ] My change is being backported to master branch (Sparkle 1.x), if deemed necessary. Please create a separate pull request for 1.x, should it be backported.
- [ ] I have reviewed and commented my code, particularly in hard-to-understand areas.
## Type of change
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] My change is or requires a documentation or localization update
- [ ] My change requires a documentation update on [Sparkle's website repository](https://github.com/sparkle-project/sparkle-project.github.io)
- [ ] My change requires changes to generate_appcast, generate_keys, or sign_update
## Testing
+64 -9
View File
@@ -10,43 +10,98 @@ jobs:
build:
strategy:
matrix:
xcode: ['/Applications/Xcode_12.2.app/Contents/Developer', '/Applications/Xcode_11.7.app/Contents/Developer']
xcode: ['xcode14.3.1', 'xcode15.2']
include:
- xcode: 'xcode15.2'
xcode-path: '/Applications/Xcode_15.2.app/Contents/Developer'
upload-dist: true
run-analyzer: true
macos: 'macos-13'
- xcode: 'xcode14.3.1'
xcode-path: '/Applications/Xcode_14.3.1.app/Contents/Developer'
upload-dist: false
run-analyzer: false
macos: 'macos-13'
name: Build and Test Sparkle
runs-on: macos-10.15
runs-on: ${{ matrix.macos }}
permissions:
pull-requests: write
steps:
- name: Checkout
uses: actions/checkout@v2
uses: actions/checkout@v4
with:
submodules: true
fetch-depth: 0
- name: Build Unit Tests
env:
DEVELOPER_DIR: ${{ matrix.xcode }}
DEVELOPER_DIR: ${{ matrix.xcode-path }}
run: |
xcodebuild build-for-testing -project Sparkle.xcodeproj -scheme Distribution -enableCodeCoverage YES -derivedDataPath build
- name: Run Unit Tests
env:
DEVELOPER_DIR: ${{ matrix.xcode }}
DEVELOPER_DIR: ${{ matrix.xcode-path }}
run: |
xcodebuild test-without-building -project Sparkle.xcodeproj -scheme Distribution -enableCodeCoverage YES -derivedDataPath build
- name: Build UI Tests
env:
DEVELOPER_DIR: ${{ matrix.xcode }}
DEVELOPER_DIR: ${{ matrix.xcode-path }}
run: |
xcodebuild build-for-testing -project Sparkle.xcodeproj -scheme UITests -configuration Debug -derivedDataPath build
- name: Run UI Tests
env:
DEVELOPER_DIR: ${{ matrix.xcode }}
DEVELOPER_DIR: ${{ matrix.xcode-path }}
run: |
xcodebuild test-without-building -project Sparkle.xcodeproj -scheme UITests -configuration Debug -derivedDataPath build
- name: Analyze Sparkle
if: ${{ matrix.run-analyzer && github.event_name == 'pull_request' }}
env:
DEVELOPER_DIR: ${{ matrix.xcode-path }}
run: |
xcodebuild analyze -project Sparkle.xcodeproj -quiet -scheme Sparkle -configuration Release -derivedDataPath analyze > analyze_output.txt
- name: Find Analyzed Warnings
if: ${{ success() && matrix.run-analyzer && github.event_name == 'pull_request' }}
id: findwarnings
env:
DEVELOPER_DIR: ${{ matrix.xcode-path }}
run: |
if grep -q "warning:" analyze_output.txt; then
echo '::set-output name=analyzestatus::0'
else
echo '::set-output name=analyzestatus::1'
fi
- name: Extract Analyzed Warnings
if: ${{ success() && matrix.run-analyzer && github.event_name == 'pull_request' && steps.findwarnings.outputs.analyzestatus == '0' }}
id: warnings
run: |
echo ::set-output name=content::$(cat analyze_output.txt)
- name: Post Analyzed Warnings
if: ${{ success() && matrix.run-analyzer && github.event_name == 'pull_request' && steps.findwarnings.outputs.analyzestatus == '0' }}
uses: mshick/add-pr-comment@v2
with:
allow-repeats: false
message: "``` ${{ steps.warnings.outputs.content }} ```"
- name: Build Release Distribution
env:
DEVELOPER_DIR: ${{ matrix.xcode }}
DEVELOPER_DIR: ${{ matrix.xcode-path }}
run: |
xcodebuild build -project Sparkle.xcodeproj -scheme Distribution -configuration Release -derivedDataPath build
- name: Archive Test Results
if: failure()
uses: actions/upload-artifact@v2
uses: actions/upload-artifact@v4
with:
name: build-logs
path: build/Logs
- name: Upload Distribution
if: ${{ success() && matrix.upload-dist }}
uses: actions/upload-artifact@v4
with:
name: Sparkle-distribution-${{ matrix.xcode }}.tar.xz
path: build/Build/Products/Release/sparkle-dist.tar.xz
+101
View File
@@ -0,0 +1,101 @@
name: "Create Draft Release"
env:
BUILDDIR: "build"
DEVELOPER_DIR: "/Applications/Xcode_15.2.app/Contents/Developer"
on:
workflow_dispatch:
inputs:
marketingVersion:
description: "Marketing Version"
required: true
default: ""
prereleaseSuffix:
description: "Pre-release Suffix"
required: false
default: ""
buildVersion:
description: "Product Build"
required: true
default: ""
concurrency:
group: publish-release-${{ github.ref }}
cancel-in-progress: true
jobs:
release:
name: "Publish binaries for release"
runs-on: macos-13
steps:
- name: "Checkout sources"
uses: actions/checkout@v4
with:
token: ${{ secrets.BOT_PERSONAL_ACCESS_TOKEN }}
submodules: true
fetch-depth: 0
- name: "Extract latest changes from CHANGELOG"
run: |
./Configurations/generate_latest_changes.py > latest-changes.txt
- name: "Overwrite project versions in project"
run: |
IFS='.' read major minor patch <<< "${{ github.event.inputs.marketingVersion }}"
sed -E -i '' "s/SPARKLE_VERSION_MAJOR =.+/SPARKLE_VERSION_MAJOR = $major/g" ./Configurations/ConfigCommon.xcconfig
sed -E -i '' "s/SPARKLE_VERSION_MINOR =.+/SPARKLE_VERSION_MINOR = $minor/g" ./Configurations/ConfigCommon.xcconfig
sed -E -i '' "s/SPARKLE_VERSION_PATCH =.+/SPARKLE_VERSION_PATCH = $patch/g" ./Configurations/ConfigCommon.xcconfig
if [[ ! -z "${{ github.event.inputs.prereleaseSuffix }}" ]]; then
sed -E -i '' "s/SPARKLE_VERSION_SUFFIX =.*/SPARKLE_VERSION_SUFFIX = ${{ github.event.inputs.prereleaseSuffix }}/g" ./Configurations/ConfigCommon.xcconfig
else
sed -E -i '' "s/SPARKLE_VERSION_SUFFIX =.*/SPARKLE_VERSION_SUFFIX =/g" ./Configurations/ConfigCommon.xcconfig
fi
sed -E -i '' "s/CURRENT_PROJECT_VERSION =.+/CURRENT_PROJECT_VERSION = ${{ github.event.inputs.buildVersion }}/g" ./Configurations/ConfigCommon.xcconfig
git add ./Configurations/ConfigCommon.xcconfig
- name: "Determine if this is a pre-release version"
run: |
if [[ ! -z "${{ github.event.inputs.prereleaseSuffix }}" ]]; then
echo "PRERELEASE_VERSION=true" >> $GITHUB_ENV
else
echo "PRERELEASE_VERSION=false" >> $GITHUB_ENV
fi
- name: "Set up git and create tag"
run: |
git config user.name Sparkle-Bot
git config user.email sparkle.project.bot@gmail.com
git tag "${{ github.event.inputs.marketingVersion }}${{ github.event.inputs.prereleaseSuffix }}"
- name: "Build release distribution"
run: make release
env:
GITHUB_ACTOR: ${{ github.actor }}
GITHUB_REPOSITORY: ${{ github.repository }}
GITHUB_TOKEN: ${{ secrets.BOT_PERSONAL_ACCESS_TOKEN }}
- name: "Push the updated package description"
env:
GITHUB_TOKEN: ${{ secrets.BOT_PERSONAL_ACCESS_TOKEN }}
run: git push
- name: "Draft a release"
uses: softprops/action-gh-release@v1
with:
draft: true
prerelease: ${{ env.PRERELEASE_VERSION }}
target_commitish: ${{ github.ref_name }}
name: "${{ github.event.inputs.marketingVersion }}${{ github.event.inputs.prereleaseSuffix }}"
tag_name: "${{ github.event.inputs.marketingVersion }}${{ github.event.inputs.prereleaseSuffix }}"
fail_on_unmatched_files: true
token: ${{ secrets.BOT_PERSONAL_ACCESS_TOKEN }}
body_path: latest-changes.txt
files: |
build/Build/Products/Release/Sparkle-*.tar.xz
build/Build/Products/Release/Sparkle-for-Swift-Package-Manager.zip
-3
View File
@@ -1,3 +0,0 @@
[submodule "Vendor/ed25519"]
path = Vendor/ed25519
url = https://github.com/orlp/ed25519
+35
View File
@@ -0,0 +1,35 @@
//
// AgentConnection.h
// Sparkle
//
// Created by Mayur Pawashe on 7/17/16.
// Copyright © 2016 Sparkle Project. All rights reserved.
//
#import <Foundation/Foundation.h>
NS_ASSUME_NONNULL_BEGIN
@protocol AgentConnectionDelegate <NSObject>
- (void)agentConnectionDidInitiate;
- (void)agentConnectionDidInvalidate;
@end
@protocol SPUInstallerAgentProtocol;
SPU_OBJC_DIRECT_MEMBERS @interface AgentConnection : NSObject
- (instancetype)initWithHostBundleIdentifier:(NSString *)bundleIdentifier delegate:(id<AgentConnectionDelegate>)delegate;
- (void)startListener;
- (void)invalidate;
@property (nonatomic, readonly, nullable) id<SPUInstallerAgentProtocol> agent;
@property (nonatomic, readonly) BOOL connected;
@property (nonatomic, nullable) NSError *invalidationError;
@end
NS_ASSUME_NONNULL_END
+119
View File
@@ -0,0 +1,119 @@
//
// AgentConnection.m
// Sparkle
//
// Created by Mayur Pawashe on 7/17/16.
// Copyright © 2016 Sparkle Project. All rights reserved.
//
#import "AgentConnection.h"
#import "SPUMessageTypes.h"
#import "SPUInstallerAgentProtocol.h"
#import "SUInstallerAgentInitiationProtocol.h"
#include "AppKitPrevention.h"
@interface AgentConnection () <NSXPCListenerDelegate, SUInstallerAgentInitiationProtocol>
@end
@implementation AgentConnection
{
NSXPCListener *_xpcListener;
NSXPCConnection *_activeConnection;
__weak id<AgentConnectionDelegate> _delegate;
}
@synthesize agent = _agent;
@synthesize connected = _connected;
@synthesize invalidationError = _invalidationError;
- (instancetype)initWithHostBundleIdentifier:(NSString *)bundleIdentifier delegate:(id<AgentConnectionDelegate>)delegate
{
self = [super init];
if (self != nil) {
// Agents should always be the one that connect to daemons due to how mach bootstraps work
// For this reason, we are the ones that are creating a listener, not the agent
_xpcListener = [[NSXPCListener alloc] initWithMachServiceName:SPUProgressAgentServiceNameForBundleIdentifier(bundleIdentifier)];
_xpcListener.delegate = self;
_delegate = delegate;
}
return self;
}
- (void)startListener
{
[_xpcListener resume];
}
- (void)invalidate
{
_delegate = nil;
[_activeConnection invalidate];
_activeConnection = nil;
[_xpcListener invalidate];
_xpcListener = nil;
}
- (BOOL)listener:(NSXPCListener *)__unused listener shouldAcceptNewConnection:(NSXPCConnection *)newConnection
{
if (_activeConnection != nil) {
[newConnection invalidate];
return NO;
}
newConnection.exportedInterface = [NSXPCInterface interfaceWithProtocol:@protocol(SUInstallerAgentInitiationProtocol)];
newConnection.exportedObject = self;
newConnection.remoteObjectInterface = [NSXPCInterface interfaceWithProtocol:@protocol(SPUInstallerAgentProtocol)];
_activeConnection = newConnection;
__weak __typeof__(self) weakSelf = self;
newConnection.interruptionHandler = ^{
dispatch_async(dispatch_get_main_queue(), ^{
__typeof__(self) strongSelf = weakSelf;
if (strongSelf != nil) {
[strongSelf->_activeConnection invalidate];
}
});
};
newConnection.invalidationHandler = ^{
dispatch_async(dispatch_get_main_queue(), ^{
__typeof__(self) strongSelf = weakSelf;
if (strongSelf != nil) {
[strongSelf->_delegate agentConnectionDidInvalidate];
}
});
};
[newConnection resume];
_agent = newConnection.remoteObjectProxy;
return YES;
}
- (void)connectionDidInitiateWithReply:(void (^)(void))acknowledgement
{
dispatch_async(dispatch_get_main_queue(), ^{
self->_connected = YES;
[self->_delegate agentConnectionDidInitiate];
});
acknowledgement();
}
- (void)connectionWillInvalidateWithError:(NSError *)error
{
dispatch_async(dispatch_get_main_queue(), ^{
self->_invalidationError = error;
});
}
@end
+24
View File
@@ -0,0 +1,24 @@
//
// AppInstaller.h
// Sparkle
//
// Created by Mayur Pawashe on 3/7/16.
// Copyright © 2016 Sparkle Project. All rights reserved.
//
#import <Foundation/Foundation.h>
#import "SUUnarchiverProtocol.h"
NS_ASSUME_NONNULL_BEGIN
SPU_OBJC_DIRECT_MEMBERS @interface AppInstaller : NSObject
- (instancetype)initWithHostBundleIdentifier:(NSString *)hostBundleIdentifier homeDirectory:(NSString *)homeDirectory userName:(NSString *)userName;
- (void)start;
- (void)cleanupAndExitWithStatus:(int)status error:(NSError * _Nullable)error __attribute__((noreturn));
@end
NS_ASSUME_NONNULL_END
+697
View File
@@ -0,0 +1,697 @@
//
// AppInstaller.m
// Sparkle
//
// Created by Mayur Pawashe on 3/7/16.
// Copyright © 2016 Sparkle Project. All rights reserved.
//
#import "AppInstaller.h"
#import "SUInstaller.h"
#import "SUUpdateValidator.h"
#import "SULog.h"
#import "SULog+NSError.h"
#import "SUHost.h"
#import "SULocalizations.h"
#import "SUStandardVersionComparator.h"
#import "SPUMessageTypes.h"
#import "SPUSecureCoding.h"
#import "SPUInstallationInputData.h"
#import "SUUnarchiver.h"
#import "SUFileManager.h"
#import "SPUInstallationInfo.h"
#import "SUAppcastItem.h"
#import "SUErrors.h"
#import "SUInstallerCommunicationProtocol.h"
#import "AgentConnection.h"
#import "SPUInstallerAgentProtocol.h"
#import "SPUInstallationType.h"
#import "SPULocalCacheDirectory.h"
#import "SPUVerifierInformation.h"
#include "AppKitPrevention.h"
#define FIRST_UPDATER_MESSAGE_TIMEOUT 18ull
#define RETRIEVE_PROCESS_IDENTIFIER_TIMEOUT 8ull
/**
* Show display progress UI after a delay from starting the final part of the installation.
* This should be long enough so that we don't show progress for very fast installations, but
* short enough so that we don't leave the user wondering why nothing is happening.
*/
static const NSTimeInterval SUDisplayProgressTimeDelay = 0.7;
@interface AppInstaller () <NSXPCListenerDelegate, SUInstallerCommunicationProtocol, AgentConnectionDelegate>
@end
@implementation AppInstaller
{
NSXPCListener* _xpcListener;
NSXPCConnection *_activeConnection;
id<SUInstallerCommunicationProtocol> _communicator;
AgentConnection *_agentConnection;
SUUpdateValidator *_updateValidator;
NSString *_hostBundleIdentifier;
NSString *_homeDirectory;
NSString *_userName;
SUHost *_host;
NSString *_updateDirectoryPath;
NSString *_extractionDirectory;
NSString *_downloadName;
NSString *_decryptionPassword;
SUSignatures *_signatures;
NSString *_relaunchPath;
NSString *_installationType;
SPUVerifierInformation *_verifierInformation;
id<SUInstallerProtocol> _installer;
dispatch_queue_t _installerQueue;
BOOL _shouldRelaunch;
BOOL _shouldShowUI;
BOOL _receivedUpdaterPong;
BOOL _willCompleteInstallation;
BOOL _receivedInstallationData;
BOOL _finishedValidation;
BOOL _agentInitiatedConnection;
BOOL _performedStage1Installation;
BOOL _performedStage2Installation;
BOOL _performedStage3Installation;
BOOL _targetTerminated;
}
- (instancetype)initWithHostBundleIdentifier:(NSString *)hostBundleIdentifier homeDirectory:(NSString *)homeDirectory userName:(NSString *)userName
{
if (!(self = [super init])) {
return nil;
}
_hostBundleIdentifier = [hostBundleIdentifier copy];
_homeDirectory = [homeDirectory copy];
_userName = [userName copy];
_xpcListener = [[NSXPCListener alloc] initWithMachServiceName:SPUInstallerServiceNameForBundleIdentifier(hostBundleIdentifier)];
_xpcListener.delegate = self;
_agentConnection = [[AgentConnection alloc] initWithHostBundleIdentifier:hostBundleIdentifier delegate:self];
return self;
}
- (BOOL)listener:(NSXPCListener *)__unused listener shouldAcceptNewConnection:(NSXPCConnection *)newConnection
{
if (_activeConnection != nil) {
SULog(SULogLevelDefault, @"Rejecting multiple connections...");
[newConnection invalidate];
return NO;
}
_activeConnection = newConnection;
newConnection.exportedInterface = [NSXPCInterface interfaceWithProtocol:@protocol(SUInstallerCommunicationProtocol)];
newConnection.exportedObject = self;
newConnection.remoteObjectInterface = [NSXPCInterface interfaceWithProtocol:@protocol(SUInstallerCommunicationProtocol)];
__weak __typeof__(self) weakSelf = self;
newConnection.interruptionHandler = ^{
dispatch_async(dispatch_get_main_queue(), ^{
__typeof__(self) strongSelf = weakSelf;
if (strongSelf != nil) {
[strongSelf->_activeConnection invalidate];
}
});
};
newConnection.invalidationHandler = ^{
dispatch_async(dispatch_get_main_queue(), ^{
__typeof__(self) strongSelf = weakSelf;
if (strongSelf != nil) {
if (strongSelf->_activeConnection != nil && !strongSelf->_willCompleteInstallation) {
[strongSelf cleanupAndExitWithStatus:EXIT_FAILURE error:[NSError errorWithDomain:SUSparkleErrorDomain code:SPUInstallerError userInfo:@{ NSLocalizedDescriptionKey: @"Invalidation on remote port being called, and installation is not close enough to completion!" }]];
}
strongSelf->_communicator = nil;
strongSelf->_activeConnection = nil;
}
});
};
[newConnection resume];
_communicator = newConnection.remoteObjectProxy;
return YES;
}
- (void)start
{
[_xpcListener resume];
[_agentConnection startListener];
dispatch_after(dispatch_time(DISPATCH_TIME_NOW, (int64_t)(FIRST_UPDATER_MESSAGE_TIMEOUT * NSEC_PER_SEC)), dispatch_get_main_queue(), ^{
if (!self->_receivedInstallationData) {
[self cleanupAndExitWithStatus:EXIT_FAILURE error:[NSError errorWithDomain:SUSparkleErrorDomain code:SPUInstallerError userInfo:@{ NSLocalizedDescriptionKey: @"Timeout: installation data was never received" }]];
}
if (!self->_agentConnection.connected) {
[self cleanupAndExitWithStatus:EXIT_FAILURE error:[NSError errorWithDomain:SUSparkleErrorDomain code:SPUInstallerError userInfo:@{ NSLocalizedDescriptionKey: @"Timeout: agent connection was never initiated" }]];
}
});
}
- (void)extractAndInstallUpdate SPU_OBJC_DIRECT
{
[_communicator handleMessageWithIdentifier:SPUExtractionStarted data:[NSData data]];
NSString *archivePath = [_updateDirectoryPath stringByAppendingPathComponent:_downloadName];
id<SUUnarchiverProtocol> unarchiver = [SUUnarchiver unarchiverForPath:archivePath extractionDirectory:_extractionDirectory updatingHostBundlePath:_host.bundlePath decryptionPassword:_decryptionPassword expectingInstallationType:_installationType];
NSError *unarchiverError = nil;
BOOL success = NO;
if (!unarchiver) {
unarchiverError = [NSError errorWithDomain:SUSparkleErrorDomain code:SUUnarchivingError userInfo:@{ NSLocalizedDescriptionKey: [NSString stringWithFormat:@"No valid unarchiver was found for %@", archivePath] }];
success = NO;
} else {
NSError *fileAttributesError = nil;
NSDictionary<NSFileAttributeKey, id> *archiveFileAttributes = [NSFileManager.defaultManager attributesOfItemAtPath:archivePath error:&fileAttributesError];
if (archiveFileAttributes == nil) {
SULog(SULogLevelError, @"Failed to retrieve file attributes from archive: %@.", fileAttributesError);
} else {
_verifierInformation.actualContentLength = (uint64_t)(archiveFileAttributes.fileSize);
}
_updateValidator = [[SUUpdateValidator alloc] initWithDownloadPath:archivePath signatures:_signatures host:_host verifierInformation:_verifierInformation];
// Delta & package updates will require validation before extraction
// Normal application updates are a bit more lenient allowing developers to change one of apple dev ID or EdDSA keys
BOOL needsPrevalidation = [[unarchiver class] mustValidateBeforeExtraction] || ![_installationType isEqualToString:SPUInstallationTypeApplication];
if (needsPrevalidation) {
success = [_updateValidator validateDownloadPathWithError:&unarchiverError];
} else {
success = YES;
}
}
if (!success) {
[self unarchiverDidFailWithError:unarchiverError];
} else {
[unarchiver
unarchiveWithCompletionBlock:^(NSError * _Nullable error) {
if (error != nil) {
[self unarchiverDidFailWithError:[NSError errorWithDomain:SUSparkleErrorDomain code:SUUnarchivingError userInfo:@{ NSLocalizedDescriptionKey: [NSString stringWithFormat:@"Failed to unarchive %@", archivePath], NSUnderlyingErrorKey: (NSError * _Nonnull)error }]];
} else {
[self->_communicator handleMessageWithIdentifier:SPUValidationStarted data:[NSData data]];
NSError *validationError = nil;
BOOL validationSuccess = [self->_updateValidator validateWithUpdateDirectory:self->_extractionDirectory error:&validationError];
if (!validationSuccess) {
[self cleanupAndExitWithStatus:EXIT_FAILURE error:[NSError errorWithDomain:SUSparkleErrorDomain code:SPUInstallerError userInfo:@{ NSLocalizedDescriptionKey: @"Update validation was a failure", NSUnderlyingErrorKey: validationError }]];
} else {
[self->_communicator handleMessageWithIdentifier:SPUInstallationStartedStage1 data:[NSData data]];
self->_finishedValidation = YES;
if (self->_agentInitiatedConnection) {
[self retrieveProcessIdentifierAndStartInstallation];
}
}
}
}
progressBlock:^(double progress) {
if (sizeof(progress) == sizeof(uint64_t)) {
uint64_t progressValue = CFSwapInt64HostToLittle(*(uint64_t *)&progress);
NSData *data = [NSData dataWithBytes:&progressValue length:sizeof(progressValue)];
[self->_communicator handleMessageWithIdentifier:SPUExtractedArchiveWithProgress data:data];
}
}];
}
}
- (void)clearUpdateDirectory SPU_OBJC_DIRECT
{
if (_updateDirectoryPath != nil) {
NSError *theError = nil;
if (![[[SUFileManager alloc] init] removeItemAtURL:[NSURL fileURLWithPath:_updateDirectoryPath] error:&theError]) {
SULog(SULogLevelError, @"Couldn't remove update folder: %@.", theError);
}
_updateDirectoryPath = nil;
}
}
- (void)unarchiverDidFailWithError:(NSError *)error SPU_OBJC_DIRECT
{
SULog(SULogLevelError, @"Failed to unarchive file");
SULogError(error);
// No longer need update validator until next possible extraction (eg: if initial delta update fails)
_updateValidator = nil;
// Client could try update again with different inputs
// Eg: one common case is if a delta update fails, client may want to fall back to regular update
// We really only need to set updateDirectoryPath to nil since that's the field we check if we've received installation data,
// but may as well set other fields to nil too
[self clearUpdateDirectory];
_downloadName = nil;
_extractionDirectory = nil;
_decryptionPassword = nil;
_signatures = nil;
_relaunchPath = nil;
_host = nil;
NSData *archivedError = SPUArchiveRootObjectSecurely(error);
[_communicator handleMessageWithIdentifier:SPUArchiveExtractionFailed data:archivedError != nil ? archivedError : [NSData data]];
}
- (void)agentConnectionDidInitiate
{
_agentInitiatedConnection = YES;
if (_finishedValidation) {
[self retrieveProcessIdentifierAndStartInstallation];
}
}
- (void)agentConnectionDidInvalidate
{
if (!_finishedValidation || !_agentInitiatedConnection || !_targetTerminated) {
NSMutableDictionary *userInfo = [NSMutableDictionary dictionaryWithDictionary:@{ NSLocalizedDescriptionKey: @"Error: Agent connection invalidated before installation began" }];
NSError *agentError = _agentConnection.invalidationError;
if (agentError != nil) {
userInfo[NSUnderlyingErrorKey] = agentError;
}
[self cleanupAndExitWithStatus:EXIT_FAILURE error:[NSError errorWithDomain:SUSparkleErrorDomain code:SPUInstallerError userInfo:userInfo]];
}
}
- (void)retrieveProcessIdentifierAndStartInstallation SPU_OBJC_DIRECT
{
// We use the relaunch path for the bundle to listen for termination instead of the host path
// For a plug-in this makes a big difference; we want to wait until the app hosting the plug-in terminates
// Otherwise for an app, the relaunch path and host path should be identical
__block BOOL receivedResponse = NO;
[_agentConnection.agent registerApplicationBundlePath:_relaunchPath reply:^(BOOL targetTerminated) {
dispatch_async(dispatch_get_main_queue(), ^{
receivedResponse = YES;
if (!targetTerminated) {
[self->_agentConnection.agent listenForTerminationWithCompletion:^{
dispatch_async(dispatch_get_main_queue(), ^{
self->_targetTerminated = YES;
if (self->_performedStage1Installation) {
[self finishInstallationAfterHostTermination];
}
});
}];
} else {
self->_targetTerminated = YES;
}
[self startInstallation];
});
}];
dispatch_after(dispatch_time(DISPATCH_TIME_NOW, (int64_t)(RETRIEVE_PROCESS_IDENTIFIER_TIMEOUT * NSEC_PER_SEC)), dispatch_get_main_queue(), ^{
if (!receivedResponse) {
[self cleanupAndExitWithStatus:EXIT_FAILURE error:[NSError errorWithDomain:SUSparkleErrorDomain code:SPUInstallerError userInfo:@{ NSLocalizedDescriptionKey: @"Timeout error: failed to retrieve process identifier from agent" }]];
}
});
}
- (void)handleMessageWithIdentifier:(int32_t)identifier data:(NSData *)data
{
if (identifier == SPUInstallationData && _updateDirectoryPath == nil) {
dispatch_async(dispatch_get_main_queue(), ^{
// Mark that we have received the installation data
// Do not rely on eg: self->_updateDirectoryPath != nil because we may set it to nil again if an early stage fails (i.e, archive extraction)
self->_receivedInstallationData = YES;
SPUInstallationInputData *installationData = (SPUInstallationInputData *)SPUUnarchiveRootObjectSecurely(data, [SPUInstallationInputData class]);
if (installationData == nil) {
[self cleanupAndExitWithStatus:EXIT_FAILURE error:[NSError errorWithDomain:SUSparkleErrorDomain code:SPUInstallerError userInfo:@{ NSLocalizedDescriptionKey: @"Error: Failed to unarchive input installation data" }]];
return;
}
NSString *installationType = installationData.installationType;
if (!SPUValidInstallationType(installationType)) {
[self cleanupAndExitWithStatus:EXIT_FAILURE error:[NSError errorWithDomain:SUSparkleErrorDomain code:SPUInstallerError userInfo:@{ NSLocalizedDescriptionKey: [NSString stringWithFormat:@"Error: Received invalid installation type: %@", installationType] }]];
return;
}
NSBundle *hostBundle = [NSBundle bundleWithPath:installationData.hostBundlePath];
NSString *bundleIdentifier = hostBundle.bundleIdentifier;
if (bundleIdentifier == nil || ![bundleIdentifier isEqualToString:self->_hostBundleIdentifier]) {
[self cleanupAndExitWithStatus:EXIT_FAILURE error:[NSError errorWithDomain:SUSparkleErrorDomain code:SPUInstallerError userInfo:@{ NSLocalizedDescriptionKey: [NSString stringWithFormat:@"Error: Failed to match host bundle identifiers %@ and %@", self->_hostBundleIdentifier, bundleIdentifier] }]];
return;
}
// This will be important later
if (installationData.relaunchPath == nil) {
[self cleanupAndExitWithStatus:EXIT_FAILURE error:[NSError errorWithDomain:SUSparkleErrorDomain code:SPUInstallerError userInfo:@{ NSLocalizedDescriptionKey: @"Error: Failed to obtain relaunch path from installation data" }]];
return;
}
// This installation path is specific to sparkle and the bundle identifier
NSString *rootCacheInstallationPath = [[SPULocalCacheDirectory cachePathForBundleIdentifier:bundleIdentifier] stringByAppendingPathComponent:@"Installation"];
[SPULocalCacheDirectory removeOldItemsInDirectory:rootCacheInstallationPath];
NSString *cacheInstallationPath = [SPULocalCacheDirectory createUniqueDirectoryInDirectory:rootCacheInstallationPath];
if (cacheInstallationPath == nil) {
[self cleanupAndExitWithStatus:EXIT_FAILURE error:[NSError errorWithDomain:SUSparkleErrorDomain code:SPUInstallerError userInfo:@{ NSLocalizedDescriptionKey: [NSString stringWithFormat:@"Error: Failed to create installation cache directory in %@", rootCacheInstallationPath] }]];
return;
}
// Resolve the bookmark data for the downloaded update
// See "Share file access between processes with URL bookmarks" in https://developer.apple.com/documentation/security/app_sandbox/accessing_files_from_the_macos_app_sandbox
BOOL isStale = NO;
NSError *bookmarkError = nil;
NSURL *downloadURL = [NSURL URLByResolvingBookmarkData:installationData.updateURLBookmarkData options:NSURLBookmarkResolutionWithoutUI relativeToURL:nil bookmarkDataIsStale:&isStale error:&bookmarkError];
if (downloadURL == nil) {
[self cleanupAndExitWithStatus:EXIT_FAILURE error:[NSError errorWithDomain:SUSparkleErrorDomain code:SPUInstallerError userInfo:@{ NSLocalizedDescriptionKey: @"Error: Failed to resolve bookmark data from downloaded update", NSUnderlyingErrorKey: bookmarkError }]];
return;
}
// Validate the download URL before moving it
{
NSArray<NSString *> *downloadURLPathComponents = downloadURL.URLByResolvingSymlinksInPath.pathComponents;
if (downloadURLPathComponents == nil) {
[self cleanupAndExitWithStatus:EXIT_FAILURE error:[NSError errorWithDomain:SUSparkleErrorDomain code:SPUInstallerError userInfo:@{ NSLocalizedDescriptionKey: @"Error: Failed to retrieve path components from download URL" }]];
return;
}
if ([downloadURLPathComponents containsObject:@".."]) {
[self cleanupAndExitWithStatus:EXIT_FAILURE error:[NSError errorWithDomain:SUSparkleErrorDomain code:SPUInstallerError userInfo:@{ NSLocalizedDescriptionKey: @"Error: download URL path components contains '..' which is unsafe" }]];
return;
}
if (![downloadURLPathComponents containsObject:@SPARKLE_BUNDLE_IDENTIFIER] || ![downloadURLPathComponents containsObject:@"PersistentDownloads"]) {
[self cleanupAndExitWithStatus:EXIT_FAILURE error:[NSError errorWithDomain:SUSparkleErrorDomain code:SPUInstallerError userInfo:@{ NSLocalizedDescriptionKey: @"Error: download URL path components does not contain PersistentDownloads or "@SPARKLE_BUNDLE_IDENTIFIER }]];
return;
}
}
if (!isStale) {
SULog(SULogLevelError, @"Error: bookmark data for update download is stale.. but still continuing.");
}
NSString *downloadName = downloadURL.lastPathComponent;
if (downloadName == nil) {
[self cleanupAndExitWithStatus:EXIT_FAILURE error:[NSError errorWithDomain:SUSparkleErrorDomain code:SPUInstallerError userInfo:@{ NSLocalizedDescriptionKey: @"Error: Failed to retrieve download name from download URL" }]];
return;
}
// Move the download archive to somewhere where probably only we will be touching it
// This prevents eg: if a bug exists in the updater that removes files we are trying to install
// When this tool is ran as root, we are moving it into a directory that only root will have access to
NSURL *downloadDestinationURL = [[NSURL fileURLWithPath:cacheInstallationPath] URLByAppendingPathComponent:downloadName];
NSError *moveError = nil;
if (![[[SUFileManager alloc] init] moveItemAtURL:downloadURL toURL:downloadDestinationURL error:&moveError]) {
[self cleanupAndExitWithStatus:EXIT_FAILURE error:[NSError errorWithDomain:SUSparkleErrorDomain code:SPUInstallerError userInfo:@{ NSLocalizedDescriptionKey: @"Error: Failed to move download archive to new location", NSUnderlyingErrorKey: moveError }]];
return;
}
// Make sure the downloaded archive we moved over is a regular file and not a symbolic link placed by an attacker
NSError *attributesError = nil;
NSString *downloadDestinationPath = downloadDestinationURL.path;
if (downloadDestinationPath == nil) {
[self cleanupAndExitWithStatus:EXIT_FAILURE error:[NSError errorWithDomain:SUSparkleErrorDomain code:SPUInstallerError userInfo:@{ NSLocalizedDescriptionKey: [NSString stringWithFormat:@"Error: Failed to retrieve download archive path from %@", downloadDestinationURL] }]];
return;
}
NSDictionary<NSString *, id> *archiveAttributes = [[NSFileManager defaultManager] attributesOfItemAtPath:downloadDestinationPath error:&attributesError];
if (archiveAttributes == nil) {
[self cleanupAndExitWithStatus:EXIT_FAILURE error:[NSError errorWithDomain:SUSparkleErrorDomain code:SPUInstallerError userInfo:@{ NSLocalizedDescriptionKey: [NSString stringWithFormat:@"Error: Failed to retrieve download archive attributes from %@", downloadDestinationPath] }]];
return;
}
if (![(NSString *)archiveAttributes[NSFileType] isEqualToString:NSFileTypeRegular]) {
[self cleanupAndExitWithStatus:EXIT_FAILURE error:[NSError errorWithDomain:SUSparkleErrorDomain code:SPUInstallerError userInfo:@{ NSLocalizedDescriptionKey: [NSString stringWithFormat:@"Error: Received bad archive file type: %@", archiveAttributes[NSFileType]] }]];
return;
}
NSString *extractionDirectory = [SPULocalCacheDirectory createUniqueDirectoryInDirectory:cacheInstallationPath];
if (extractionDirectory == nil) {
[self cleanupAndExitWithStatus:EXIT_FAILURE error:[NSError errorWithDomain:SUSparkleErrorDomain code:SPUInstallerError userInfo:@{ NSLocalizedDescriptionKey: [NSString stringWithFormat:@"Error: Failed to create installation extraction directory in %@", cacheInstallationPath] }]];
return;
}
// Carry these properties separately rather than using the SUInstallationInputData object
// Some of our properties may slightly differ than our input and we don't want to make the mistake of using one of those
self->_installationType = installationType;
self->_relaunchPath = installationData.relaunchPath;
self->_downloadName = downloadName;
self->_signatures = installationData.signatures;
self->_updateDirectoryPath = cacheInstallationPath;
self->_extractionDirectory = extractionDirectory;
self->_host = [[SUHost alloc] initWithBundle:hostBundle];
self->_verifierInformation = [[SPUVerifierInformation alloc] initWithExpectedVersion:installationData.expectedVersion expectedContentLength:installationData.expectedContentLength];
[self extractAndInstallUpdate];
});
} else if (identifier == SPUSentUpdateAppcastItemData) {
SUAppcastItem *updateItem = (SUAppcastItem *)SPUUnarchiveRootObjectSecurely(data, [SUAppcastItem class]);
if (updateItem != nil) {
SPUInstallationInfo *installationInfo = [[SPUInstallationInfo alloc] initWithAppcastItem:updateItem canSilentlyInstall:[_installer canInstallSilently]];
NSData *archivedData = SPUArchiveRootObjectSecurely(installationInfo);
if (archivedData != nil) {
[_agentConnection.agent registerInstallationInfoData:archivedData];
}
}
} else if (identifier == SPUResumeInstallationToStage2 && data.length == sizeof(uint8_t) * 2) {
// Because anyone can ask us to resume the installation, it may be wise to think about backwards compatibility here if IPC changes
uint8_t relaunch = *((const uint8_t *)data.bytes);
uint8_t showsUI = *((const uint8_t *)data.bytes + 1);
dispatch_async(dispatch_get_main_queue(), ^{
// This flag has an impact on interactive type installations and showing UI progress during non-interactive installations
self->_shouldShowUI = (BOOL)showsUI;
// Don't test if the application was alive initially, leave that to the progress agent if we decide to relaunch
self->_shouldRelaunch = (BOOL)relaunch;
if (self->_performedStage1Installation) {
// Resume the installation if we aren't done with stage 2 yet, and remind the client we are prepared to relaunch
dispatch_async(self->_installerQueue, ^{
if (!self->_performedStage2Installation) {
[self performStage2Installation];
} else if (!self->_performedStage3Installation) {
// If we already performed the 2nd stage, re-purpose this request to re-try sending another termination signal
dispatch_async(dispatch_get_main_queue(), ^{
// Don't check if the target is already terminated, leave that to the progress agent
// We could be slightly off if there were multiple instances running
[self->_agentConnection.agent sendTerminationSignal];
});
}
});
}
});
} else if (identifier == SPUCancelInstallation) {
dispatch_async(dispatch_get_main_queue(), ^{
[self cleanupAndExitWithStatus:0 error:nil];
});
} else if (identifier == SPUUpdaterAlivePong) {
_receivedUpdaterPong = YES;
}
}
- (void)startInstallation SPU_OBJC_DIRECT
{
_willCompleteInstallation = YES;
dispatch_queue_attr_t queuePriority = dispatch_queue_attr_make_with_qos_class(DISPATCH_QUEUE_SERIAL, QOS_CLASS_USER_INITIATED, 0);
_installerQueue = dispatch_queue_create("org.sparkle-project.sparkle.installer", queuePriority);
dispatch_async(_installerQueue, ^{
NSError *installerError = nil;
id <SUInstallerProtocol> installer = [SUInstaller installerForHost:self->_host expectedInstallationType:self->_installationType updateDirectory:self->_extractionDirectory homeDirectory:self->_homeDirectory userName:self->_userName error:&installerError];
if (installer == nil) {
dispatch_async(dispatch_get_main_queue(), ^{
[self cleanupAndExitWithStatus:EXIT_FAILURE error:[NSError errorWithDomain:SUSparkleErrorDomain code:SPUInstallerError userInfo:@{ NSLocalizedDescriptionKey: @"Error: Failed to create installer instance", NSUnderlyingErrorKey: installerError }]];
});
return;
}
NSError *firstStageError = nil;
if (![installer performInitialInstallation:&firstStageError]) {
self->_installer = nil;
dispatch_async(dispatch_get_main_queue(), ^{
[self cleanupAndExitWithStatus:EXIT_FAILURE error:[NSError errorWithDomain:SUSparkleErrorDomain code:SPUInstallerError userInfo:@{ NSLocalizedDescriptionKey: @"Error: Failed to start installer", NSUnderlyingErrorKey: firstStageError }]];
});
return;
}
uint8_t canPerformSilentInstall = (uint8_t)[installer canInstallSilently];
dispatch_async(dispatch_get_main_queue(), ^{
self->_installer = installer;
uint8_t sendInformation[] = {canPerformSilentInstall, (uint8_t)self->_targetTerminated};
NSData *sendData = [NSData dataWithBytes:sendInformation length:sizeof(sendInformation)];
[self->_communicator handleMessageWithIdentifier:SPUInstallationFinishedStage1 data:sendData];
self->_performedStage1Installation = YES;
if (self->_targetTerminated) {
// Stage 2 can still be run before we finish installation
// if the updater requests for it before the app is terminated
[self finishInstallationAfterHostTermination];
}
});
});
}
- (void)performStage2Installation SPU_OBJC_DIRECT
{
BOOL canPerformSecondStage = _shouldShowUI || [_installer canInstallSilently];
if (canPerformSecondStage) {
_performedStage2Installation = YES;
dispatch_async(dispatch_get_main_queue(), ^{
uint8_t targetTerminated = (uint8_t)self->_targetTerminated;
NSData *sendData = [NSData dataWithBytes:&targetTerminated length:sizeof(targetTerminated)];
[self->_communicator handleMessageWithIdentifier:SPUInstallationFinishedStage2 data:sendData];
// Don't check if the target is already terminated, leave that to the progress agent
// We could be slightly off if there were multiple instances running
[self->_agentConnection.agent sendTerminationSignal];
});
} else {
_installer = nil;
dispatch_async(dispatch_get_main_queue(), ^{
[self cleanupAndExitWithStatus:EXIT_FAILURE error:[NSError errorWithDomain:SUSparkleErrorDomain code:SPUInstallerError userInfo:@{ NSLocalizedDescriptionKey: @"Error: Failed to resume installer on stage 2 because installation cannot be installed silently" }]];
});
}
}
- (void)finishInstallationAfterHostTermination SPU_OBJC_DIRECT
{
assert(self->_targetTerminated);
// Show our installer progress UI tool if only after a certain amount of time passes,
// and if our installer is silent (i.e, doesn't show progress on its own)
__block BOOL shouldShowUIProgress = YES;
if (self->_shouldShowUI && [self->_installer canInstallSilently]) {
// Ask the updater if it is still alive
// If they are, we will receive a pong response back
// Reset if we received a pong just to be on the safe side
self->_receivedUpdaterPong = NO;
[self->_communicator handleMessageWithIdentifier:SPUUpdaterAlivePing data:[NSData data]];
dispatch_after(dispatch_time(DISPATCH_TIME_NOW, (int64_t)(SUDisplayProgressTimeDelay * NSEC_PER_SEC)), dispatch_get_main_queue(), ^{
// Make sure we're still eligible for showing the installer progress
// Also if the updater process is still alive, showing the progress should not be our duty
// if the communicator object is nil, the updater definitely isn't alive. However, if it is not nil,
// this does not necessarily mean the updater is alive, so we should also check if we got a recent response back from the updater
if (shouldShowUIProgress && (!self->_receivedUpdaterPong || self->_communicator == nil)) {
[self->_agentConnection.agent showProgress];
}
});
}
dispatch_async(self->_installerQueue, ^{
if (!self->_performedStage2Installation) {
[self performStage2Installation];
}
if (!self->_performedStage2Installation) {
// We failed and we're going to exit shortly
return;
}
NSError *thirdStageError = nil;
if (![self->_installer performFinalInstallationProgressBlock:nil error:&thirdStageError]) {
[self->_installer performCleanup];
self->_installer = nil;
dispatch_async(dispatch_get_main_queue(), ^{
[self cleanupAndExitWithStatus:EXIT_FAILURE error:[NSError errorWithDomain:SUSparkleErrorDomain code:SPUInstallerError userInfo:@{ NSLocalizedDescriptionKey: @"Failed to finalize installation", NSUnderlyingErrorKey: thirdStageError }]];
});
return;
}
self->_performedStage3Installation = YES;
dispatch_async(dispatch_get_main_queue(), ^{
// Make sure to stop our displayed progress before we move onto cleanup & relaunch
// This will also stop the agent from broadcasting the status info service, which we want to do before
// we relaunch the app because the relaunched app could check the service upon launch..
[self->_agentConnection.agent stopProgress];
shouldShowUIProgress = NO;
[self->_communicator handleMessageWithIdentifier:SPUInstallationFinishedStage3 data:[NSData data]];
if (self->_shouldRelaunch) {
// This will also signal to the agent that it will terminate soon
[self->_agentConnection.agent relaunchApplication];
}
[self->_installer performCleanup];
[self cleanupAndExitWithStatus:EXIT_SUCCESS error:nil];
});
});
}
- (void)cleanupAndExitWithStatus:(int)status error:(NSError * _Nullable)error __attribute__((noreturn))
{
if (error != nil) {
SULogError(error);
NSData *errorData = SPUArchiveRootObjectSecurely((NSError * _Nonnull)error);
if (errorData != nil) {
[_communicator handleMessageWithIdentifier:SPUInstallerError data:errorData];
}
}
// It's nice to tell the other end we're invalidating
[_activeConnection invalidate];
_activeConnection = nil;
[_xpcListener invalidate];
_xpcListener = nil;
[_agentConnection invalidate];
_agentConnection = nil;
[self clearUpdateDirectory];
exit(status);
}
@end
+19
View File
@@ -0,0 +1,19 @@
//
// SPUDeltaArchive.h
// Sparkle
//
// Created by Mayur Pawashe on 12/29/21.
// Copyright © 2021 Sparkle Project. All rights reserved.
//
#import <Foundation/Foundation.h>
@protocol SPUDeltaArchiveProtocol;
@class SPUDeltaArchiveHeader;
NS_ASSUME_NONNULL_BEGIN
// Opens patch file for reading and decodes the archive header
id<SPUDeltaArchiveProtocol> SPUDeltaArchiveReadPatchAndHeader(NSString *patchFile, SPUDeltaArchiveHeader * _Nullable __autoreleasing * _Nullable outHeader);
NS_ASSUME_NONNULL_END
+121
View File
@@ -0,0 +1,121 @@
//
// SPUDeltaArchive.m
// Sparkle
//
// Created by Mayur Pawashe on 12/29/21.
// Copyright © 2021 Sparkle Project. All rights reserved.
//
#import "SPUDeltaArchive.h"
#import "SPUDeltaArchiveProtocol.h"
#import "SPUSparkleDeltaArchive.h"
#import "SPUXarDeltaArchive.h"
#import <CommonCrypto/CommonDigest.h>
#include "AppKitPrevention.h"
SPUDeltaCompressionMode SPUDeltaCompressionModeDefault = (SPUDeltaCompressionMode)UINT8_MAX;
id<SPUDeltaArchiveProtocol> SPUDeltaArchiveReadPatchAndHeader(NSString *patchFile, SPUDeltaArchiveHeader * _Nullable __autoreleasing * _Nullable outHeader)
{
id<SPUDeltaArchiveProtocol> sparkleArchive = [[SPUSparkleDeltaArchive alloc] initWithPatchFileForReading:patchFile];
SPUDeltaArchiveHeader *header = [sparkleArchive readHeader];
if (header == nil) {
#if SPARKLE_BUILD_LEGACY_DELTA_SUPPORT
NSError *archiveError = sparkleArchive.error;
if (archiveError != nil && [archiveError.domain isEqualToString:SPARKLE_DELTA_ARCHIVE_ERROR_DOMAIN] && archiveError.code == SPARKLE_DELTA_ARCHIVE_ERROR_CODE_BAD_MAGIC) {
// Retry with XAR archive if the magic value is unexpected
[sparkleArchive close];
id<SPUDeltaArchiveProtocol> xarArchive = [[SPUXarDeltaArchive alloc] initWithPatchFileForReading:patchFile];
SPUDeltaArchiveHeader *xarHeader = [xarArchive readHeader];
if (outHeader != NULL) {
*outHeader = xarHeader;
}
return xarArchive;
} else
#endif
{
if (outHeader != NULL) {
*outHeader = nil;
}
return sparkleArchive;
}
} else {
if (outHeader != NULL) {
*outHeader = header;
}
return sparkleArchive;
}
}
@implementation SPUDeltaArchiveItem
@synthesize relativeFilePath = _relativeFilePath;
@synthesize itemFilePath = _itemFilePath;
@synthesize clonedRelativePath = _clonedRelativePath;
@synthesize sourcePath = _sourcePath;
@synthesize commands = _commands;
#if SPARKLE_BUILD_LEGACY_DELTA_SUPPORT
@synthesize xarContext = _xarContext;
#endif
@synthesize mode = _mode;
@synthesize codedDataLength = _codedDataLength;
- (instancetype)initWithRelativeFilePath:(NSString *)relativeFilePath commands:(SPUDeltaItemCommands)commands mode:(uint16_t)mode
{
self = [super init];
if (self != nil) {
_relativeFilePath = [relativeFilePath copy];
_commands = commands;
_mode = mode;
}
return self;
}
@end
@implementation SPUDeltaArchiveHeader
{
unsigned char _beforeTreeHash[CC_SHA1_DIGEST_LENGTH];
unsigned char _afterTreeHash[CC_SHA1_DIGEST_LENGTH];
}
@synthesize compression = _compression;
@synthesize compressionLevel = _compressionLevel;
@synthesize fileSystemCompression = _fileSystemCompression;
@synthesize majorVersion = _majorVersion;
@synthesize minorVersion = _minorVersion;
- (instancetype)initWithCompression:(SPUDeltaCompressionMode)compression compressionLevel:(uint8_t)compressionLevel fileSystemCompression:(bool)fileSystemCompression majorVersion:(uint16_t)majorVersion minorVersion:(uint16_t)minorVersion beforeTreeHash:(const unsigned char *)beforeTreeHash afterTreeHash:(const unsigned char *)afterTreeHash
{
self = [super init];
if (self != nil)
{
_compression = compression;
_compressionLevel = compressionLevel;
_fileSystemCompression = fileSystemCompression;
_majorVersion = majorVersion;
_minorVersion = minorVersion;
memcpy(_beforeTreeHash, beforeTreeHash, sizeof(_beforeTreeHash));
memcpy(_afterTreeHash, afterTreeHash, sizeof(_afterTreeHash));
}
return self;
}
- (unsigned char *)beforeTreeHash
{
return _beforeTreeHash;
}
- (unsigned char *)afterTreeHash
{
return _afterTreeHash;
}
@end
+112
View File
@@ -0,0 +1,112 @@
//
// SPUDeltaArchiveProtocol.h
// Autoupdate
//
// Created by Mayur Pawashe on 12/28/21.
// Copyright © 2021 Sparkle Project. All rights reserved.
//
#import <Foundation/Foundation.h>
#import "SPUDeltaCompressionMode.h"
NS_ASSUME_NONNULL_BEGIN
// Attributes for an item we extract/write to the archive
// Note: BinaryDiff cannot coexist together with Delete
typedef NS_ENUM(uint8_t, SPUDeltaItemCommands) {
SPUDeltaItemCommandEndMarker = 0,
SPUDeltaItemCommandDelete = (1u << 0),
SPUDeltaItemCommandExtract = (1u << 1),
SPUDeltaItemCommandModifyPermissions = (1u << 2),
SPUDeltaItemCommandBinaryDiff = (1u << 3),
SPUDeltaItemCommandClone = (1u << 4),
};
// Represents header for our archive
SPU_OBJC_DIRECT_MEMBERS @interface SPUDeltaArchiveHeader : NSObject
- (instancetype)initWithCompression:(SPUDeltaCompressionMode)compression compressionLevel:(uint8_t)compressionLevel fileSystemCompression:(bool)fileSystemCompression majorVersion:(uint16_t)majorVersion minorVersion:(uint16_t)minorVersion beforeTreeHash:(const unsigned char *)beforeTreeHash afterTreeHash:(const unsigned char *)afterTreeHash;
@property (nonatomic, readonly) SPUDeltaCompressionMode compression;
@property (nonatomic, readonly) uint8_t compressionLevel;
@property (nonatomic, readonly) bool fileSystemCompression;
@property (nonatomic, readonly) uint16_t majorVersion;
@property (nonatomic, readonly) uint16_t minorVersion;
@property (nonatomic, readonly) unsigned char *beforeTreeHash;
@property (nonatomic, readonly) unsigned char *afterTreeHash;
@end
// Represents an item we read or write to in our delta archive
SPU_OBJC_DIRECT_MEMBERS @interface SPUDeltaArchiveItem : NSObject
- (instancetype)initWithRelativeFilePath:(NSString *)relativeFilePath commands:(SPUDeltaItemCommands)commands mode:(uint16_t)mode;
// The relative file path of the item, eg /Contents/MacOS/Foo
@property (nonatomic, readonly) NSString *relativeFilePath;
// For extraction, the path where the item will be extracted. For creation, the path to the item to add to the archive.
@property (nonatomic, nullable) NSString *itemFilePath;
// The relative file path of the originating item for clones. This may be null.
// For example, if /Contents/Resources/hello/foo.txt moves to /Contents/Resources/hello2/foo.txt, the former is the relative path
@property (nonatomic, nullable) NSString *clonedRelativePath;
// The source path of the item to extract file metadata from such as file size.
@property (nonatomic, nullable) NSString *sourcePath;
// The commands that describe the actions to take for this item.
@property (nonatomic, readonly) SPUDeltaItemCommands commands;
// Provided change in permissions for item or tracking file mode for the item
@property (nonatomic) uint16_t mode;
// Private properties
#if SPARKLE_BUILD_LEGACY_DELTA_SUPPORT
// xar_file context for Xar delta archiver
@property (nonatomic, nullable) const void *xarContext;
#endif
// Tracking length of item's data in data section, when encoding items and when extracting items
@property (nonatomic) uint64_t codedDataLength;
@end
// A protocol for reading and writing binary delta patches
// Operations must be done in order. The header must first be read or written before any other operations.
// For reading, file items cannot be extracted out of order.
@protocol SPUDeltaArchiveProtocol <NSObject>
@property (nonatomic, readonly, class) BOOL maySupportSafeExtraction;
// If non-nil, there was an error with reading or writing data from the archive
@property (nonatomic, readonly, nullable) NSError *error;
// Closes file for reading/writing, called in -dealloc if it's not called manually
- (void)close;
// For reading
// Retrieves metadata for the archive including major/minor version and expected bundle hashes
- (nullable SPUDeltaArchiveHeader *)readHeader;
// Enumerate through items in the patch file and read the path, attributes, permissions (if permission attribute is available), and way to stop enumeration
- (void)enumerateItems:(void (^)(SPUDeltaArchiveItem *item, BOOL *stop))itemHandler;
// Extract a file item from the patch file to a destination file
// The item's physical file path must be set as a destination
- (BOOL)extractItem:(SPUDeltaArchiveItem *)item;
// ------------
// For writing
// Set metadata for archive including major/minor version and expected bundle hashes
- (void)writeHeader:(SPUDeltaArchiveHeader *)header;
// Add item to patch file
// Physical file path must be provided if there is an extract or binary delta attribute
// Permissions are used only if there is a modify permissions attribute
- (void)addItem:(SPUDeltaArchiveItem *)item;
// Finishes encoding items after having added all of them
- (void)finishEncodingItems;
@end
NS_ASSUME_NONNULL_END
+22
View File
@@ -0,0 +1,22 @@
//
// SPUDeltaCompressionMode.h
// Sparkle
//
// Created by Mayur Pawashe on 1/3/22.
// Copyright © 2022 Sparkle Project. All rights reserved.
//
#import <Foundation/Foundation.h>
// Compression mode to use during patch creation
typedef NS_ENUM(uint8_t, SPUDeltaCompressionMode) {
SPUDeltaCompressionModeNone = 0,
SPUDeltaCompressionModeBzip2,
SPUDeltaCompressionModeLZMA,
SPUDeltaCompressionModeLZFSE,
SPUDeltaCompressionModeLZ4,
SPUDeltaCompressionModeZLIB
};
// For Swift access
extern SPUDeltaCompressionMode SPUDeltaCompressionModeDefault;
+26
View File
@@ -0,0 +1,26 @@
//
// SPUInstallationInfo.h
// Sparkle
//
// Created by Mayur Pawashe on 4/10/16.
// Copyright © 2016 Sparkle Project. All rights reserved.
//
#import <Foundation/Foundation.h>
NS_ASSUME_NONNULL_BEGIN
@class SUAppcastItem;
SPU_OBJC_DIRECT_MEMBERS @interface SPUInstallationInfo : NSObject <NSSecureCoding>
- (instancetype)initWithAppcastItem:(SUAppcastItem *)appcastItem canSilentlyInstall:(BOOL)canSilentlyInstall;
@property (nonatomic, readonly) SUAppcastItem *appcastItem;
@property (nonatomic, readonly) BOOL canSilentlyInstall;
@property (nonatomic) BOOL systemDomain;
@end
NS_ASSUME_NONNULL_END
+65
View File
@@ -0,0 +1,65 @@
//
// SPUInstallationInfo.m
// Sparkle
//
// Created by Mayur Pawashe on 4/10/16.
// Copyright © 2016 Sparkle Project. All rights reserved.
//
#import "SPUInstallationInfo.h"
#import "SUAppcastItem.h"
#include "AppKitPrevention.h"
static NSString *SUAppcastItemKey = @"SUAppcastItem";
static NSString *SUCanSilentlyInstallKey = @"SUCanSilentlyInstall";
static NSString *SUSystemDomainKey = @"SUSystemDomain";
@implementation SPUInstallationInfo
@synthesize appcastItem = _appcastItem;
@synthesize canSilentlyInstall = _canSilentlyInstall;
@synthesize systemDomain = _systemDomain;
- (instancetype)initWithAppcastItem:(SUAppcastItem *)appcastItem canSilentlyInstall:(BOOL)canSilentlyInstall systemDomain:(BOOL)systemDomain
{
self = [super init];
if (self != nil) {
_appcastItem = appcastItem;
_canSilentlyInstall = canSilentlyInstall;
_systemDomain = systemDomain;
}
return self;
}
- (instancetype)initWithAppcastItem:(SUAppcastItem *)appcastItem canSilentlyInstall:(BOOL)canSilentlyInstall
{
return [self initWithAppcastItem:appcastItem canSilentlyInstall:canSilentlyInstall systemDomain:NO];
}
- (nullable instancetype)initWithCoder:(NSCoder *)decoder
{
SUAppcastItem *appcastItem = [decoder decodeObjectOfClass:[SUAppcastItem class] forKey:SUAppcastItemKey];
if (appcastItem == nil) {
return nil;
}
BOOL canSilentlyInstall = [decoder decodeBoolForKey:SUCanSilentlyInstallKey];
BOOL systemDomain = [decoder decodeBoolForKey:SUSystemDomainKey];
return [self initWithAppcastItem:appcastItem canSilentlyInstall:canSilentlyInstall systemDomain:systemDomain];
}
- (void)encodeWithCoder:(NSCoder *)coder
{
[coder encodeObject:_appcastItem forKey:SUAppcastItemKey];
[coder encodeBool:_canSilentlyInstall forKey:SUCanSilentlyInstallKey];
[coder encodeBool:_systemDomain forKey:SUSystemDomainKey];
}
+ (BOOL)supportsSecureCoding
{
return YES;
}
@end
+40
View File
@@ -0,0 +1,40 @@
//
// SPUInstallationInputData.h
// Sparkle
//
// Created by Mayur Pawashe on 3/24/16.
// Copyright © 2016 Sparkle Project. All rights reserved.
//
#import <Foundation/Foundation.h>
@class SUSignatures;
NS_ASSUME_NONNULL_BEGIN
SPU_OBJC_DIRECT_MEMBERS @interface SPUInstallationInputData : NSObject <NSSecureCoding>
/*
* relaunchPath - path to application bundle to relaunch and listen for termination
* hostBundlePath - path to host bundle to update & replace
* updateDirectoryPath - path to update directory (i.e, temporary directory containing the new update archive)
* downloadName - name of update archive in update directory
* signatures - signatures for the update that came from the appcast item
* decryptionPassword - optional decryption password for dmg archives
* expectedVersion - optional expected version of the new update
* expectedContentLength - optional expected content length of the new download archive
*/
- (instancetype)initWithRelaunchPath:(NSString *)relaunchPath hostBundlePath:(NSString *)hostBundlePath updateURLBookmarkData:(NSData *)updateURLBookmarkData installationType:(NSString *)installationType signatures:(SUSignatures * _Nullable)signatures decryptionPassword:(nullable NSString *)decryptionPassword expectedVersion:(NSString *)expectedVersion expectedContentLength:(uint64_t)expectedContentLength;
@property (nonatomic, copy, readonly) NSString *relaunchPath;
@property (nonatomic, copy, readonly) NSString *hostBundlePath;
@property (nonatomic, copy, readonly) NSData *updateURLBookmarkData;
@property (nonatomic, copy, readonly) NSString *installationType;
@property (nonatomic, readonly, nullable) SUSignatures *signatures; // nullable because although not using signatures is deprecated, it's still supported
@property (nonatomic, copy, readonly, nullable) NSString *decryptionPassword;
@property (nonatomic, copy, readonly, nullable) NSString *expectedVersion;
@property (nonatomic, readonly) uint64_t expectedContentLength;
@end
NS_ASSUME_NONNULL_END
+111
View File
@@ -0,0 +1,111 @@
//
// SPUInstallationInputData.m
// Sparkle
//
// Created by Mayur Pawashe on 3/24/16.
// Copyright © 2016 Sparkle Project. All rights reserved.
//
#import "SPUInstallationInputData.h"
#import "SPUInstallationType.h"
#import "SUSignatures.h"
#include "AppKitPrevention.h"
static NSString *SURelaunchPathKey = @"SURelaunchPath";
static NSString *SUHostBundlePathKey = @"SUHostBundlePath";
static NSString *SUUpdateURLBookmarkDataKey = @"SUUpdateURLBookmarkData";
static NSString *SUSignaturesKey = @"SUSignatures";
static NSString *SUDecryptionPasswordKey = @"SUDecryptionPassword";
static NSString *SUInstallationTypeKey = @"SUInstallationType";
static NSString *SUExpectedVersionKey = @"SUExpectedVersion";
static NSString *SUExpectedContentLength = @"SUExpectedContentLength";
@implementation SPUInstallationInputData
@synthesize relaunchPath = _relaunchPath;
@synthesize hostBundlePath = _hostBundlePath;
@synthesize updateURLBookmarkData = _updateURLBookmarkData;
@synthesize signatures = _signatures;
@synthesize decryptionPassword = _decryptionPassword;
@synthesize installationType = _installationType;
@synthesize expectedVersion = _expectedVersion;
@synthesize expectedContentLength = _expectedContentLength;
- (instancetype)initWithRelaunchPath:(NSString *)relaunchPath hostBundlePath:(NSString *)hostBundlePath updateURLBookmarkData:(NSData *)updateURLBookmarkData installationType:(NSString *)installationType signatures:(SUSignatures * _Nullable)signatures decryptionPassword:(nullable NSString *)decryptionPassword expectedVersion:(nonnull NSString *)expectedVersion expectedContentLength:(uint64_t)expectedContentLength
{
self = [super init];
if (self != nil) {
_relaunchPath = [relaunchPath copy];
_hostBundlePath = [hostBundlePath copy];
_updateURLBookmarkData = updateURLBookmarkData;
_installationType = [installationType copy];
assert(SPUValidInstallationType(_installationType));
_signatures = signatures;
_decryptionPassword = [decryptionPassword copy];
_expectedVersion = [expectedVersion copy];
_expectedContentLength = expectedContentLength;
}
return self;
}
- (nullable instancetype)initWithCoder:(NSCoder *)decoder
{
NSString *relaunchPath = [decoder decodeObjectOfClass:[NSString class] forKey:SURelaunchPathKey];
if (relaunchPath == nil) {
return nil;
}
NSString *hostBundlePath = [decoder decodeObjectOfClass:[NSString class] forKey:SUHostBundlePathKey];
if (hostBundlePath == nil) {
return nil;
}
NSData *updateURLBookmarkData = [decoder decodeObjectOfClass:[NSData class] forKey:SUUpdateURLBookmarkDataKey];
if (updateURLBookmarkData == nil) {
return nil;
}
NSString *installationType = [decoder decodeObjectOfClass:[NSString class] forKey:SUInstallationTypeKey];
if (!SPUValidInstallationType(installationType)) {
return nil;
}
SUSignatures *signatures = [decoder decodeObjectOfClass:[SUSignatures class] forKey:SUSignaturesKey];
if (signatures == nil) {
return nil;
}
NSString *decryptionPassword = [decoder decodeObjectOfClass:[NSString class] forKey:SUDecryptionPasswordKey];
NSString *expectedVersion = [decoder decodeObjectOfClass:[NSString class] forKey:SUExpectedVersionKey];
uint64_t expectedContentLength = (uint64_t)[decoder decodeInt64ForKey:SUExpectedContentLength];
return [self initWithRelaunchPath:relaunchPath hostBundlePath:hostBundlePath updateURLBookmarkData:updateURLBookmarkData installationType:installationType signatures:signatures decryptionPassword:decryptionPassword expectedVersion:expectedVersion expectedContentLength:expectedContentLength];
}
- (void)encodeWithCoder:(NSCoder *)coder
{
[coder encodeObject:_relaunchPath forKey:SURelaunchPathKey];
[coder encodeObject:_hostBundlePath forKey:SUHostBundlePathKey];
[coder encodeObject:_updateURLBookmarkData forKey:SUUpdateURLBookmarkDataKey];
[coder encodeObject:_installationType forKey:SUInstallationTypeKey];
[coder encodeObject:_signatures forKey:SUSignaturesKey];
if (_decryptionPassword != nil) {
[coder encodeObject:_decryptionPassword forKey:SUDecryptionPasswordKey];
}
if (_expectedVersion != nil) {
[coder encodeObject:_expectedVersion forKey:SUExpectedVersionKey];
}
[coder encodeInt64:(int64_t)_expectedContentLength forKey:SUExpectedContentLength];
}
+ (BOOL)supportsSecureCoding
{
return YES;
}
@end
+49
View File
@@ -0,0 +1,49 @@
//
// SPUMessageTypes.h
// Sparkle
//
// Created by Mayur Pawashe on 3/11/16.
// Copyright © 2016 Sparkle Project. All rights reserved.
//
#import <Foundation/Foundation.h>
NS_ASSUME_NONNULL_BEGIN
// Order matters; higher stages have higher values.
typedef NS_ENUM(int32_t, SPUInstallerMessageType)
{
SPUInstallerNotStarted = 0,
SPUExtractionStarted = 1,
SPUExtractedArchiveWithProgress = 2,
SPUArchiveExtractionFailed = 3,
SPUValidationStarted = 4,
SPUInstallationStartedStage1 = 5,
SPUInstallationFinishedStage1 = 6,
SPUInstallationFinishedStage2 = 7,
SPUInstallationFinishedStage3 = 8,
SPUUpdaterAlivePing = 9,
SPUInstallerError = 10
};
typedef NS_ENUM(int32_t, SPUUpdaterMessageType)
{
SPUInstallationData = 0,
SPUSentUpdateAppcastItemData = 1,
SPUResumeInstallationToStage2 = 2,
SPUUpdaterAlivePong = 3,
SPUCancelInstallation = 4
};
BOOL SPUInstallerMessageTypeIsLegal(SPUInstallerMessageType oldMessageType, SPUInstallerMessageType newMessageType);
// Used by framework to communicate to installer (Autoupdate)
NSString *SPUInstallerServiceNameForBundleIdentifier(NSString *bundleIdentifier);
// Used by framework to communicate to progress agent tool (Updater)
NSString *SPUStatusInfoServiceNameForBundleIdentifier(NSString *bundleIdentifier);
// Used by progress agent tool to communicate to installer (Autoupdate)
NSString *SPUProgressAgentServiceNameForBundleIdentifier(NSString *bundleIdentifier);
NS_ASSUME_NONNULL_END
+85
View File
@@ -0,0 +1,85 @@
//
// SPUMessageTypes.m
// Sparkle
//
// Created by Mayur Pawashe on 3/11/16.
// Copyright © 2016 Sparkle Project. All rights reserved.
//
#import "SPUMessageTypes.h"
#include "AppKitPrevention.h"
// Tags added to the bundle identifier which is used as Mach service names
// These should be very short because of length restrictions
#define SPARKLE_INSTALLER_TAG @"-spki"
#define SPARKLE_STATUS_TAG @"-spks"
#define SPARKLE_PROGRESS_TAG @"-spkp"
// macOS 10.8 couldn't handle service names that are >= 64 characters,
// but 10.9 raised this to >= 128 characters
#define MAX_SERVICE_NAME_LENGTH 127u
BOOL SPUInstallerMessageTypeIsLegal(SPUInstallerMessageType oldMessageType, SPUInstallerMessageType newMessageType)
{
BOOL legal;
switch (newMessageType) {
case SPUInstallerNotStarted:
legal = (oldMessageType == SPUInstallerNotStarted);
break;
case SPUExtractionStarted:
legal = (oldMessageType == SPUInstallerNotStarted);
break;
case SPUExtractedArchiveWithProgress:
case SPUArchiveExtractionFailed:
legal = (oldMessageType == SPUExtractionStarted || oldMessageType == SPUExtractedArchiveWithProgress);
break;
case SPUValidationStarted:
legal = (oldMessageType == SPUExtractionStarted || oldMessageType == SPUExtractedArchiveWithProgress);
break;
case SPUInstallationStartedStage1:
legal = (oldMessageType == SPUValidationStarted);
break;
case SPUInstallationFinishedStage1:
legal = (oldMessageType == SPUInstallationStartedStage1);
break;
case SPUInstallationFinishedStage2:
legal = (oldMessageType == SPUInstallationFinishedStage1);
break;
case SPUInstallationFinishedStage3:
legal = (oldMessageType == SPUInstallationFinishedStage2);
break;
case SPUInstallerError:
case SPUUpdaterAlivePing:
// Having this state being dependent on other installation states would make the complicate our logic
// So just always allow these type of messages
legal = YES;
break;
}
return legal;
}
static NSString *SPUServiceNameWithTag(NSString *tagName, NSString *bundleIdentifier)
{
NSString *serviceName = [bundleIdentifier stringByAppendingString:tagName];
NSUInteger length = MIN(serviceName.length, MAX_SERVICE_NAME_LENGTH);
// If the service name is too long, cut off the beginning rather than cutting off the end
// This should lead to a more unique name
return [serviceName substringFromIndex:serviceName.length - length];
}
NSString *SPUInstallerServiceNameForBundleIdentifier(NSString *bundleIdentifier)
{
return SPUServiceNameWithTag(SPARKLE_INSTALLER_TAG, bundleIdentifier);
}
NSString *SPUStatusInfoServiceNameForBundleIdentifier(NSString *bundleIdentifier)
{
return SPUServiceNameWithTag(SPARKLE_STATUS_TAG, bundleIdentifier);
}
NSString *SPUProgressAgentServiceNameForBundleIdentifier(NSString *bundleIdentifier)
{
return SPUServiceNameWithTag(SPARKLE_PROGRESS_TAG, bundleIdentifier);
}
+107
View File
@@ -0,0 +1,107 @@
//
// SPUSparkleDeltaArchive.h
// Sparkle
//
// Created by Mayur Pawashe on 12/30/21.
// Copyright © 2021 Sparkle Project. All rights reserved.
//
#import <Foundation/Foundation.h>
#import "SPUDeltaArchiveProtocol.h"
#import "SPUDeltaCompressionMode.h"
NS_ASSUME_NONNULL_BEGIN
#define SPARKLE_DELTA_ARCHIVE_ERROR_DOMAIN @"Sparkle Delta Archive"
#define SPARKLE_DELTA_ARCHIVE_ERROR_CODE_BAD_MAGIC 1
#define SPARKLE_DELTA_ARCHIVE_ERROR_CODE_BAD_COMPRESSION_VALUE 2
#define SPARKLE_DELTA_ARCHIVE_ERROR_CODE_BAD_CHUNK_SIZE 3
#define SPARKLE_DELTA_ARCHIVE_ERROR_CODE_BAD_CLONE_LOOKUP 4
#define SPARKLE_DELTA_ARCHIVE_ERROR_CODE_TOO_MANY_FILES 5
#define SPARKLE_DELTA_ARCHIVE_ERROR_CODE_LINK_TOO_LONG 6
/*
Modern container format for binary delta archives.
Delta archive format has four sections which are the header, the relative file path table, the commands, and the data blobs.
The relative file path table records all the file paths the archive needs to know about.
The commands are the operations to be recorded (eg: extract, clone, binary diff, delete).
The commands may additionally have more metadata such as file permission modes, relative path indexes in the case of clones, or file sizes for the data blobs.
The data blobs contain all file data from extract and binary diff outputs.
The implementation design of this archive is such that we do not seek backwards or skip ahead to fetch data.
We go through the archive when writing or reading from it in a single pass.
-- UNCOMPRESSED --
[ HEADER (part 1) ]
magic (length: 4)
compression (length: 1)
metadata (See format below. length: 1)
-- METADATA --
compressionLevel (bits [0, 4])
(bits [5, 6] reserved)
fileSystemCompression (bit 7)
-- COMPRESSED --
[ HEADER (part 2)]
majorVersion (length: 2)
minorVersion (length: 2)
beforeTreeHash (length: 40)
afterTreeHash (length: 40)
[ RELATIVE_FILE_PATH_TABLE ]
sizeOfRelativeFilePathTable (length: 8 bytes)
List of null terminated path strings joined together (N paths)
[ COMMANDS ]
[ Command ]
Set of command types for entry (length: 1 byte)
Additional metadata for command (see below section)
(M commands where M <= N paths)
(Indexes for commands refer to indexes to relative file path table, excluding extraneous trailing entries in relative path table used for clones)
(Last command must be a ZERO COMMAND (a null terminating command))
[COMMAND METADATA]
[COMMAND: DELETE]
N/A: no additional data
[COMMAND: MODIFY_PERMISSIONS]
fileMode (length: 2)
[COMMAND: CLONE_FILE]
sourceRelativePathIndex (length: 4)
[COMMAND: EXTRACT_FILE]
dataLength (length: 8 for regular files, 2 for symbolic links, 0 for directories)
[COMMAND: BINARY_DIFF_FILE]
dataLength (length: 8)
Note: These command types may be OR'd or combined. In those cases, different commands
that have the same attribute (eg dataLength) are not repeated. This list of metadata is also
in order in what will be encoded/decoded first.
EXTRACT_FILE and BINARY_DIFF_FILE cannot be combined.
CLONE_FILE and EXTRACT_FILE cannot be combined.
MODIFY_PERMISSIONS can be combined with either CLONE_FILE, EXTRACT_FILE, BINARY_DIFF_FILE, or just by itself.
CLONE_FILE can be combined with BINARY_DIFF_FILE or just by itself.
DELETE can be combined with EXTRACT_FILE, or just by itself. It is only combined with EXTRACT_FILE when the file type (regular, directory, or symlink) changes.
[ DATA_BLOBS ]
All raw binary data joined together
(P number of blobs where P <= M commands)
(Indexes for data blobs correspond to indexes for a filtered list of applicable commands (EXTRACT_FILE, BINARY_DIFF_FILE) that have data content)
*/
SPU_OBJC_DIRECT_MEMBERS @interface SPUSparkleDeltaArchive : NSObject <SPUDeltaArchiveProtocol>
- (instancetype)initWithPatchFileForWriting:(NSString *)patchFile;
- (instancetype)initWithPatchFileForReading:(NSString *)patchFile;
@end
NS_ASSUME_NONNULL_END
File diff suppressed because it is too large. Load diff
+28
View File
@@ -0,0 +1,28 @@
//
// SPUXarDeltaArchive.h
// Autoupdate
//
// Created by Mayur Pawashe on 12/28/21.
// Copyright © 2021 Sparkle Project. All rights reserved.
//
#if SPARKLE_BUILD_LEGACY_DELTA_SUPPORT
#import <Foundation/Foundation.h>
#import "SPUDeltaArchiveProtocol.h"
#import "SPUDeltaCompressionMode.h"
NS_ASSUME_NONNULL_BEGIN
// Legacy container format for binary delta archives
SPU_OBJC_DIRECT_MEMBERS @interface SPUXarDeltaArchive : NSObject <SPUDeltaArchiveProtocol>
- (instancetype)initWithPatchFileForWriting:(NSString *)patchFile SPU_OBJC_DIRECT;
- (instancetype)initWithPatchFileForReading:(NSString *)patchFile SPU_OBJC_DIRECT;
@end
NS_ASSUME_NONNULL_END
#endif
+413
View File
@@ -0,0 +1,413 @@
//
// SPUXarDeltaArchive.m
// Autoupdate
//
// Created by Mayur Pawashe on 12/28/21.
// Copyright © 2021 Sparkle Project. All rights reserved.
//
#if SPARKLE_BUILD_LEGACY_DELTA_SUPPORT
#import "SPUXarDeltaArchive.h"
#include <xar/xar.h>
#include "SUBinaryDeltaCommon.h"
#import <Availability.h>
#import <CommonCrypto/CommonDigest.h>
#include "AppKitPrevention.h"
#if __MAC_OS_X_VERSION_MAX_ALLOWED >= 120000
#define HAS_XAR_GET_SAFE_PATH 1
#else
#define HAS_XAR_GET_SAFE_PATH 0
#endif
#if HAS_XAR_GET_SAFE_PATH
// This is preferred over xar_get_path (which is deprecated) when it's available
// Don't use OS availability for this API
extern char *xar_get_safe_path(xar_file_t f) __attribute__((weak_import));
#endif
// Xar attribute keys
#define BINARY_DELTA_ATTRIBUTES_KEY "binary-delta-attributes"
#define MAJOR_DIFF_VERSION_KEY "major-version"
#define MINOR_DIFF_VERSION_KEY "minor-version"
#define BEFORE_TREE_SHA1_KEY "before-tree-sha1"
#define AFTER_TREE_SHA1_KEY "after-tree-sha1"
#define DELETE_KEY "delete"
#define EXTRACT_KEY "extract"
#define BINARY_DELTA_KEY "binary-delta"
#define MODIFY_PERMISSIONS_KEY "mod-permissions"
// Errors
#define SPARKLE_DELTA_XAR_ARCHIVE_ERROR_DOMAIN @"Sparkle XAR Archive"
#define SPARKLE_DELTA_XAR_ARCHIVE_ERROR_CODE_OPEN_FAILURE 1
#define SPARKLE_DELTA_XAR_ARCHIVE_ERROR_CODE_ADD_FAILURE 2
#define SPARKLE_DELTA_XAR_ARCHIVE_ERROR_CODE_EXTRACT_FAILURE 3
#define SPARKLE_DELTA_XAR_ARCHIVE_ERROR_CODE_UNSUPPORTED_COMPRESSION_FAILURE 4
@implementation SPUXarDeltaArchive
{
NSMutableDictionary<NSString *, NSValue *> *_fileTable;
NSString *_patchFile;
xar_t _x;
int32_t _xarMode;
}
@synthesize error = _error;
- (instancetype)initWithPatchFileForWriting:(NSString *)patchFile
{
self = [super init];
if (self != nil) {
_patchFile = [patchFile copy];
_xarMode = WRITE;
_fileTable = [NSMutableDictionary dictionary];
}
return self;
}
- (instancetype)initWithPatchFileForReading:(NSString *)patchFile
{
self = [super init];
if (self != nil) {
_patchFile = [patchFile copy];
_xarMode = READ;
}
return self;
}
- (void)dealloc
{
[self close];
}
- (void)close
{
if (_x != NULL) {
xar_close(_x);
_x = NULL;
}
}
// This indicates if safe extraction is available at compile time (SDK), but not if it's available at runtime.
+ (BOOL)maySupportSafeExtraction
{
return HAS_XAR_GET_SAFE_PATH;
}
- (nullable SPUDeltaArchiveHeader *)readHeader
{
NSString *patchFile = _patchFile;
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wdeprecated-declarations"
// Sparkle's XAR delta archives have been superseded by Sparkle's own format
xar_t x = xar_open(patchFile.fileSystemRepresentation, READ);
#pragma clang diagnostic pop
if (x == NULL) {
_error = [NSError errorWithDomain:SPARKLE_DELTA_XAR_ARCHIVE_ERROR_DOMAIN code:SPARKLE_DELTA_XAR_ARCHIVE_ERROR_CODE_OPEN_FAILURE userInfo:@{ NSLocalizedDescriptionKey: [NSString stringWithFormat:@"Failed to xar_open() file for reading: %@", patchFile] }];
return nil;
}
_x = x;
uint16_t majorDiffVersion = SUBinaryDeltaMajorVersionFirst;
uint16_t minorDiffVersion = 0;
NSString *expectedBeforeHash = nil;
NSString *expectedAfterHash = nil;
xar_subdoc_t subdoc;
for (subdoc = xar_subdoc_first(_x); subdoc; subdoc = xar_subdoc_next(subdoc)) {
if (strcmp(xar_subdoc_name(subdoc), BINARY_DELTA_ATTRIBUTES_KEY) == 0) {
{
// available in version 2.0 or later
const char *value = NULL;
xar_subdoc_prop_get(subdoc, MAJOR_DIFF_VERSION_KEY, &value);
if (value != NULL) {
majorDiffVersion = (uint16_t)[@(value) intValue];
}
}
{
// available in version 2.0 or later
const char *value = NULL;
xar_subdoc_prop_get(subdoc, MINOR_DIFF_VERSION_KEY, &value);
if (value != NULL) {
minorDiffVersion = (uint16_t)[@(value) intValue];
}
}
// available in version 2.0 or later
{
const char *value = NULL;
xar_subdoc_prop_get(subdoc, BEFORE_TREE_SHA1_KEY, &value);
if (value != NULL) {
expectedBeforeHash = @(value);
}
}
// available in version 2.0 or later
{
const char *value = NULL;
xar_subdoc_prop_get(subdoc, AFTER_TREE_SHA1_KEY, &value);
if (value != NULL) {
expectedAfterHash = @(value);
}
}
}
}
unsigned char rawExpectedBeforeHash[CC_SHA1_DIGEST_LENGTH] = {0};
getRawHashFromDisplayHash(rawExpectedBeforeHash, expectedBeforeHash);
unsigned char rawExpectedAfterHash[CC_SHA1_DIGEST_LENGTH] = {0};
getRawHashFromDisplayHash(rawExpectedAfterHash, expectedAfterHash);
// I wasn't able to figure out how to retrieve the compression options from xar,
// so we will use default flags to indicate the info isn't available
return [[SPUDeltaArchiveHeader alloc] initWithCompression:SPUDeltaCompressionModeDefault compressionLevel:0 fileSystemCompression:false majorVersion:majorDiffVersion minorVersion:minorDiffVersion beforeTreeHash:rawExpectedBeforeHash afterTreeHash:rawExpectedAfterHash];
}
- (void)writeHeader:(SPUDeltaArchiveHeader *)header
{
NSString *patchFile = _patchFile;
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wdeprecated-declarations"
// Sparkle's XAR delta archives have been superseded by Sparkle's own format
xar_t x = xar_open(patchFile.fileSystemRepresentation, WRITE);
#pragma clang diagnostic pop
if (x == NULL) {
_error = [NSError errorWithDomain:SPARKLE_DELTA_XAR_ARCHIVE_ERROR_DOMAIN code:SPARKLE_DELTA_XAR_ARCHIVE_ERROR_CODE_OPEN_FAILURE userInfo:@{ NSLocalizedDescriptionKey: [NSString stringWithFormat:@"Failed to xar_open() file for writing: %@", patchFile] }];
return;
}
_x = x;
SPUDeltaCompressionMode compression = (header.compression == SPUDeltaCompressionModeDefault ? SPUDeltaCompressionModeBzip2 : header.compression);
uint8_t compressionLevel;
// Only 1 - 9 are valid, 0 is special case to use default level 9
if (header.compressionLevel <= 0 || header.compressionLevel > 9) {
compressionLevel = 9;
} else {
compressionLevel = header.compressionLevel;
}
switch (compression) {
case SPUDeltaCompressionModeNone:
xar_opt_set(x, XAR_OPT_COMPRESSION, XAR_OPT_VAL_NONE);
break;
case SPUDeltaCompressionModeBzip2: {
xar_opt_set(x, XAR_OPT_COMPRESSION, "bzip2");
char buffer[256] = {0};
snprintf(buffer, sizeof(buffer) - 1, "%d", compressionLevel);
xar_opt_set(x, XAR_OPT_COMPRESSIONARG, buffer);
break;
}
case SPUDeltaCompressionModeLZMA:
case SPUDeltaCompressionModeLZFSE:
case SPUDeltaCompressionModeLZ4:
case SPUDeltaCompressionModeZLIB: {
_error = [NSError errorWithDomain:SPARKLE_DELTA_XAR_ARCHIVE_ERROR_DOMAIN code:SPARKLE_DELTA_XAR_ARCHIVE_ERROR_CODE_UNSUPPORTED_COMPRESSION_FAILURE userInfo:@{ NSLocalizedDescriptionKey: [NSString stringWithFormat:@"Version 2 patches only support bzip2 compression."] }];
return;
}
}
xar_subdoc_t attributes = xar_subdoc_new(x, BINARY_DELTA_ATTRIBUTES_KEY);
xar_subdoc_prop_set(attributes, MAJOR_DIFF_VERSION_KEY, [[NSString stringWithFormat:@"%u", header.majorVersion] UTF8String]);
xar_subdoc_prop_set(attributes, MINOR_DIFF_VERSION_KEY, [[NSString stringWithFormat:@"%u", header.minorVersion] UTF8String]);
xar_subdoc_prop_set(attributes, BEFORE_TREE_SHA1_KEY, [displayHashFromRawHash(header.beforeTreeHash) UTF8String]);
xar_subdoc_prop_set(attributes, AFTER_TREE_SHA1_KEY, [displayHashFromRawHash(header.afterTreeHash) UTF8String]);
}
static xar_file_t _xarAddFile(NSMutableDictionary<NSString *, NSValue *> *fileTable, xar_t x, NSString *relativePath, NSString *filePath)
{
NSArray<NSString *> *rootRelativePathComponents = relativePath.pathComponents;
// Relative path must at least have starting "/" component and one more path component
if (rootRelativePathComponents.count < 2) {
return NULL;
}
NSArray<NSString *> *relativePathComponents = [rootRelativePathComponents subarrayWithRange:NSMakeRange(1, rootRelativePathComponents.count - 1)];
NSUInteger relativePathComponentsCount = relativePathComponents.count;
// Build parent files as needed until we get to our final file we want to add
// So if we get "Contents/Resources/foo.txt", we will first add "Contents" parent,
// then "Resources" parent, then "foo.txt" as the final entry we want to add
// We store every file we add into a fileTable for easy referencing
// Note if a diff has Contents/Resources/foo/ and Contents/Resources/foo/bar.txt,
// due to sorting order we will add the foo directory first and won't end up with
// misordering bugs
xar_file_t lastParent = NULL;
for (NSUInteger componentIndex = 0; componentIndex < relativePathComponentsCount; componentIndex++) {
NSArray<NSString *> *subpathComponents = [relativePathComponents subarrayWithRange:NSMakeRange(0, componentIndex + 1)];
NSString *subpathKey = [subpathComponents componentsJoinedByString:@"/"];
xar_file_t cachedFile = [fileTable[subpathKey] pointerValue];
if (cachedFile != NULL) {
lastParent = cachedFile;
} else {
xar_file_t newParent;
BOOL atLastIndex = (componentIndex == relativePathComponentsCount - 1);
NSString *lastPathComponent = subpathComponents.lastObject;
if (atLastIndex && filePath != nil) {
newParent = xar_add_frompath(x, lastParent, lastPathComponent.fileSystemRepresentation, filePath.fileSystemRepresentation);
} else {
newParent = xar_add_frombuffer(x, lastParent, lastPathComponent.fileSystemRepresentation, "", 1);
}
lastParent = newParent;
fileTable[subpathKey] = [NSValue valueWithPointer:newParent];
}
}
return lastParent;
}
- (void)addItem:(SPUDeltaArchiveItem *)item
{
if (_error != nil) {
return;
}
NSString *relativeFilePath = item.relativeFilePath;
NSString *filePath = item.itemFilePath;
SPUDeltaItemCommands commands = item.commands;
uint16_t mode = item.mode;
xar_file_t newFile = _xarAddFile(_fileTable, _x, relativeFilePath, filePath);
if (newFile == NULL) {
_error = [NSError errorWithDomain:SPARKLE_DELTA_XAR_ARCHIVE_ERROR_DOMAIN code:SPARKLE_DELTA_XAR_ARCHIVE_ERROR_CODE_ADD_FAILURE userInfo:@{ NSLocalizedDescriptionKey: [NSString stringWithFormat:@"Failed to add xar file entry: %@", relativeFilePath] }];
return;
}
if ((commands & SPUDeltaItemCommandDelete) != 0) {
xar_prop_set(newFile, DELETE_KEY, "true");
}
if ((commands & SPUDeltaItemCommandExtract) != 0) {
xar_prop_set(newFile, EXTRACT_KEY, "true");
}
if ((commands & SPUDeltaItemCommandBinaryDiff) != 0) {
xar_prop_set(newFile, BINARY_DELTA_KEY, "true");
}
if ((commands & SPUDeltaItemCommandModifyPermissions) != 0) {
xar_prop_set(newFile, MODIFY_PERMISSIONS_KEY, [NSString stringWithFormat:@"%u", mode].UTF8String);
}
}
- (void)finishEncodingItems
{
// Items are already encoded when they are extracted prior
}
- (void)enumerateItems:(void (^)(SPUDeltaArchiveItem *, BOOL *))itemHandler
{
if (_error != nil) {
return;
}
BOOL exitedEarly = NO;
xar_iter_t iter = xar_iter_new();
for (xar_file_t file = xar_file_first(_x, iter); file; file = xar_file_next(iter)) {
char *pathCString;
#if HAS_XAR_GET_SAFE_PATH
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wunguarded-availability-new"
if (xar_get_safe_path != NULL) {
pathCString = xar_get_safe_path(file);
}
#pragma clang diagnostic pop
else
#endif
{
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wdeprecated-declarations"
pathCString = xar_get_path(file);
#pragma clang diagnostic pop
}
if (pathCString == NULL) {
continue;
}
NSString *relativePath = [[NSString alloc] initWithBytesNoCopy:pathCString length:strlen(pathCString) encoding:NSUTF8StringEncoding freeWhenDone:YES];
if (relativePath == nil) {
free(pathCString);
continue;
}
SPUDeltaItemCommands commands = 0;
{
const char *value = NULL;
if (xar_prop_get(file, DELETE_KEY, &value) == 0) {
commands |= SPUDeltaItemCommandDelete;
}
}
{
const char *value = NULL;
if (xar_prop_get(file, BINARY_DELTA_KEY, &value) == 0) {
commands |= SPUDeltaItemCommandBinaryDiff;
}
}
{
const char *value = NULL;
if (xar_prop_get(file, EXTRACT_KEY, &value) == 0) {
commands |= SPUDeltaItemCommandExtract;
}
}
uint16_t mode = 0;
{
const char *value = NULL;
if (xar_prop_get(file, MODIFY_PERMISSIONS_KEY, &value) == 0) {
commands |= SPUDeltaItemCommandModifyPermissions;
mode = (uint16_t)[@(value) intValue];
}
}
SPUDeltaArchiveItem *item = [[SPUDeltaArchiveItem alloc] initWithRelativeFilePath:relativePath commands:commands mode:mode];
item.xarContext = file;
itemHandler(item, &exitedEarly);
if (exitedEarly) {
break;
}
}
xar_iter_free(iter);
}
- (BOOL)extractItem:(SPUDeltaArchiveItem *)item
{
if (_error != nil) {
return NO;
}
assert(item.itemFilePath != nil);
assert(item.xarContext != NULL);
xar_file_t file = item.xarContext;
if (xar_extract_tofile(_x, file, item.itemFilePath.fileSystemRepresentation) != 0) {
_error = [NSError errorWithDomain:SPARKLE_DELTA_XAR_ARCHIVE_ERROR_DOMAIN code:SPARKLE_DELTA_XAR_ARCHIVE_ERROR_CODE_EXTRACT_FAILURE userInfo:@{ NSLocalizedDescriptionKey: [NSString stringWithFormat:@"Failed to extract xar file entry to %@", item.itemFilePath] }];
return NO;
}
return YES;
}
@end
#endif
File renamed without changes.
+481
View File
@@ -0,0 +1,481 @@
//
// SUBinaryDeltaApply.m
// Sparkle
//
// Created by Mark Rowe on 2009-06-01.
// Copyright 2009 Mark Rowe. All rights reserved.
//
#import "SUBinaryDeltaApply.h"
#import "SUBinaryDeltaCommon.h"
#import "SPUDeltaArchiveProtocol.h"
#import "SPUDeltaArchive.h"
#import <CommonCrypto/CommonDigest.h>
#import <Foundation/Foundation.h>
#include "bspatch.h"
#include <stdio.h>
#include <stdlib.h>
#import <sys/stat.h>
#include "AppKitPrevention.h"
static BOOL applyBinaryDeltaToFile(NSString *patchFile, NSString *sourceFilePath, NSString *destinationFilePath)
{
const char *argv[] = {"/usr/bin/bspatch", [sourceFilePath fileSystemRepresentation], [destinationFilePath fileSystemRepresentation], [patchFile fileSystemRepresentation]};
BOOL success = (bspatch(4, argv) == 0);
unlink([patchFile fileSystemRepresentation]);
return success;
}
BOOL applyBinaryDelta(NSString *source, NSString *finalDestination, NSString *patchFile, BOOL verbose, void (^progressCallback)(double progress), NSError *__autoreleasing *error)
{
SPUDeltaArchiveHeader *header = nil;
id<SPUDeltaArchiveProtocol> archive = SPUDeltaArchiveReadPatchAndHeader(patchFile, &header);
if (archive.error != nil) {
if (error != NULL) {
*error = archive.error;
}
return NO;
}
progressCallback(0/7.0);
SUBinaryDeltaMajorVersion majorDiffVersion = header.majorVersion;
uint16_t minorDiffVersion = header.minorVersion;
unsigned char *expectedBeforeHash = header.beforeTreeHash;
unsigned char *expectedAfterHash = header.afterTreeHash;
if (majorDiffVersion < SUBinaryDeltaMajorVersionFirst) {
if (error != NULL) {
*error = [NSError errorWithDomain:NSCocoaErrorDomain code:NSFileReadCorruptFileError userInfo:@{ NSLocalizedDescriptionKey: [NSString stringWithFormat:@"Unable to identify diff-version %u in delta. Giving up.", majorDiffVersion] }];
}
return NO;
}
if (majorDiffVersion < SUBinaryDeltaMajorVersionFirstSupported) {
if (error != NULL) {
*error = [NSError errorWithDomain:NSCocoaErrorDomain code:NSFileReadCorruptFileError userInfo:@{ NSLocalizedDescriptionKey: [NSString stringWithFormat:@"Applying version %u patches is no longer supported.", majorDiffVersion] }];
}
return NO;
}
if (majorDiffVersion > SUBinaryDeltaMajorVersionLatest) {
if (error != NULL) {
*error = [NSError errorWithDomain:NSCocoaErrorDomain code:NSFileReadUnknownError userInfo:@{ NSLocalizedDescriptionKey: [NSString stringWithFormat:@"A later version is needed to apply this patch (on major version %u, but patch requests version %u).", SUBinaryDeltaMajorVersionLatest, majorDiffVersion] }];
}
return NO;
}
// Reject patches that did not generate valid hierarchical xar container paths
// These will not succeed to patch using recent versions of BinaryDelta
if ([[archive class] maySupportSafeExtraction] && majorDiffVersion == SUBinaryDeltaMajorVersion2 && minorDiffVersion < 3) {
if (error != NULL) {
*error = [NSError errorWithDomain:NSCocoaErrorDomain code:NSFileReadCorruptFileError userInfo:@{ NSLocalizedDescriptionKey: [NSString stringWithFormat:@"This patch version (%u.%u) is too old and potentially unsafe to apply. Please re-generate the patch using the latest version of BinaryDelta or generate_appcast. New version %u.%u patches will still be compatible with older versions of Sparkle.", majorDiffVersion, minorDiffVersion, majorDiffVersion, latestMinorVersionForMajorVersion(majorDiffVersion)] }];
}
return NO;
}
if (expectedBeforeHash == nil || expectedAfterHash == nil) {
if (error != NULL) {
*error = [NSError errorWithDomain:NSCocoaErrorDomain code:NSFileReadCorruptFileError userInfo:@{ NSLocalizedDescriptionKey: @"Unable to find before-sha1 or after-sha1 metadata in delta. Giving up." }];
}
return NO;
}
if (verbose) {
fprintf(stderr, "Applying version %u.%u patch...\n", majorDiffVersion, minorDiffVersion);
fprintf(stderr, "Verifying source...");
}
progressCallback(1/7.0);
unsigned char beforeHash[CC_SHA1_DIGEST_LENGTH] = {0};
if (!getRawHashOfTreeWithVersion(beforeHash, source, majorDiffVersion)) {
if (verbose) {
fprintf(stderr, "\n");
}
if (error != NULL) {
*error = [NSError errorWithDomain:NSCocoaErrorDomain code:NSFileReadUnknownError userInfo:@{ NSLocalizedDescriptionKey: [NSString stringWithFormat:@"Unable to calculate hash of tree %@", source] }];
}
return NO;
}
if (memcmp(beforeHash, expectedBeforeHash, CC_SHA1_DIGEST_LENGTH) != 0) {
if (verbose) {
fprintf(stderr, "\n");
}
if (error != NULL) {
*error = [NSError errorWithDomain:NSCocoaErrorDomain code:NSFileReadUnknownError userInfo:@{ NSLocalizedDescriptionKey: [NSString stringWithFormat:@"Source doesn't have expected hash (%@ != %@). Giving up.", displayHashFromRawHash(expectedBeforeHash), displayHashFromRawHash(beforeHash)] }];
}
return NO;
}
if (verbose) {
fprintf(stderr, "\nCopying files...");
}
progressCallback(2/7.0);
// Make a temporary destination path if necessary
// If we want to apply file system compression after we're done applying, we'll need to use a different
// temporary path
NSString *destination;
if (header.fileSystemCompression) {
destination = [finalDestination.stringByDeletingLastPathComponent stringByAppendingPathComponent:[NSString stringWithFormat:@".tmp.%@", finalDestination.lastPathComponent]];
} else {
destination = finalDestination;
}
if (!removeTree(destination)) {
if (verbose) {
fprintf(stderr, "\n");
}
if (error != NULL) {
*error = [NSError errorWithDomain:NSCocoaErrorDomain code:NSFileWriteUnknownError userInfo:@{ NSLocalizedDescriptionKey: [NSString stringWithFormat:@"Failed to remove %@", destination] }];
}
return NO;
}
progressCallback(3/7.0);
if (!copyTree(source, destination)) {
if (verbose) {
fprintf(stderr, "\n");
}
if (error != NULL) {
*error = [NSError errorWithDomain:NSCocoaErrorDomain code:NSFileWriteUnknownError userInfo:@{ NSLocalizedDescriptionKey: [NSString stringWithFormat:@"Failed to copy %@ to %@", source, destination] }];
}
return NO;
}
progressCallback(4/7.0);
if (verbose) {
fprintf(stderr, "\nPatching...");
}
NSFileManager *fileManager = [[NSFileManager alloc] init];
// Ensure error is cleared out in advance
if (error != NULL) {
*error = nil;
}
[archive enumerateItems:^(SPUDeltaArchiveItem *item, BOOL *stop) {
NSString *relativePath = item.relativeFilePath;
if ([relativePath.pathComponents containsObject:@".."]) {
if (error != NULL) {
*error = [NSError errorWithDomain:NSCocoaErrorDomain code:NSFileWriteUnknownError userInfo:@{ NSLocalizedDescriptionKey: [NSString stringWithFormat:@"Relative path '%@' contains '..' path component", relativePath] }];
}
*stop = YES;
return;
}
NSString *sourceFilePath = [source stringByAppendingPathComponent:relativePath];
NSString *destinationFilePath = [destination stringByAppendingPathComponent:relativePath];
{
NSString *destinationParentDirectory = destinationFilePath.stringByDeletingLastPathComponent;
NSDictionary<NSFileAttributeKey, id> *destinationParentDirectoryAttributes = [fileManager attributesOfItemAtPath:destinationParentDirectory error:NULL];
// It is OK for the directory parent to not exist if it has already been removed
if (destinationParentDirectoryAttributes != nil) {
// But if it does exist, make sure the entry in the parent directory we're looking at is good
// If it's inside a symlink, this is not good in any circumstance
NSString *fileType = destinationParentDirectoryAttributes[NSFileType];
if ([fileType isEqualToString:NSFileTypeSymbolicLink]) {
if (error != NULL) {
*error = [NSError errorWithDomain:NSCocoaErrorDomain code:NSFileWriteUnknownError userInfo:@{ NSLocalizedDescriptionKey: [NSString stringWithFormat:@"Failed to create patch because '%@' cannot be a symbolic link.", destinationParentDirectory] }];
}
*stop = YES;
return;
}
}
}
// Don't use -[NSFileManager fileExistsAtPath:] because it will follow symbolic links
BOOL fileExisted = verbose && [fileManager attributesOfItemAtPath:destinationFilePath error:nil];
BOOL removedFile = NO;
// Files that have no property set that we check for will get ignored
// This is important because they aren't part of the delta, just part of the directory structure
SPUDeltaItemCommands commands = item.commands;
if ((commands & SPUDeltaItemCommandDelete) != 0) {
if (!removeTree(destinationFilePath)) {
if (verbose) {
fprintf(stderr, "\n");
}
if (error != NULL) {
*error = [NSError errorWithDomain:NSCocoaErrorDomain code:NSFileWriteUnknownError userInfo:@{ NSLocalizedDescriptionKey: [NSString stringWithFormat:@"delete: failed to remove %@", destination] }];
}
*stop = YES;
return;
}
removedFile = YES;
}
if ((commands & SPUDeltaItemCommandClone) != 0 && (commands & SPUDeltaItemCommandBinaryDiff) == 0) {
NSString *clonedRelativePath = item.clonedRelativePath;
if ([clonedRelativePath.pathComponents containsObject:@".."]) {
if (error != NULL) {
*error = [NSError errorWithDomain:NSCocoaErrorDomain code:NSFileWriteUnknownError userInfo:@{ NSLocalizedDescriptionKey: [NSString stringWithFormat:@"Relative path for clone '%@' contains '..' path component", clonedRelativePath] }];
}
*stop = YES;
return;
}
NSString *clonedOriginalPath = [source stringByAppendingPathComponent:clonedRelativePath];
// Ensure there isn't an item already at our destination
[fileManager removeItemAtPath:destinationFilePath error:NULL];
NSError *copyError = nil;
if (![fileManager copyItemAtPath:clonedOriginalPath toPath:destinationFilePath error:&copyError]) {
if (verbose) {
fprintf(stderr, "\n");
}
if (error != NULL) {
*error = copyError;
}
*stop = YES;
return;
}
if (verbose) {
fprintf(stderr, "\n✂️ %s %s -> %s", VERBOSE_CLONED, [clonedRelativePath fileSystemRepresentation], [relativePath fileSystemRepresentation]);
}
} else if ((commands & SPUDeltaItemCommandBinaryDiff) != 0) {
NSString *tempDiffFile = temporaryFilename(@"apply-binary-delta");
item.itemFilePath = tempDiffFile;
if (![archive extractItem:item]) {
if (verbose) {
fprintf(stderr, "\n");
}
if (error != NULL) {
*error = [NSError errorWithDomain:NSCocoaErrorDomain code:NSFileWriteUnknownError userInfo:@{ NSLocalizedDescriptionKey: [NSString stringWithFormat:@"Unable to extract diffed file to %@", tempDiffFile], NSUnderlyingErrorKey: (NSError * _Nonnull)archive.error }];
}
*stop = YES;
return;
}
NSString *sourceDiffFilePath;
NSString *clonedRelativePath;
if ((commands & SPUDeltaItemCommandClone) != 0) {
clonedRelativePath = item.clonedRelativePath;
if ([clonedRelativePath.pathComponents containsObject:@".."]) {
if (error != NULL) {
*error = [NSError errorWithDomain:NSCocoaErrorDomain code:NSFileWriteUnknownError userInfo:@{ NSLocalizedDescriptionKey: [NSString stringWithFormat:@"Relative path for clone '%@' contains '..' path component", clonedRelativePath] }];
}
*stop = YES;
return;
}
sourceDiffFilePath = [source stringByAppendingPathComponent:clonedRelativePath];
} else {
sourceDiffFilePath = sourceFilePath;
clonedRelativePath = nil;
}
// Decide if we need to preserve original file permissions from the original file
// applyBinaryDeltaToFile() normally preserves file permissions on the file it's replacing.
// However this is not possible if the destination file we're patching is not writable.
// We also need to preserve permissions for clones except when we'll be changing permissions later anyway.
BOOL needsToCopyFilePermissions;
if (![fileManager isWritableFileAtPath:destinationFilePath]) {
// Remove the file non-writable we're patching that may cause issues
[fileManager removeItemAtPath:destinationFilePath error:NULL];
// We will need to preserve permissions if there is no need to make permission changes later on
needsToCopyFilePermissions = (commands & SPUDeltaItemCommandModifyPermissions) == 0;
} else {
needsToCopyFilePermissions = ((commands & SPUDeltaItemCommandClone) != 0) && ((commands & SPUDeltaItemCommandModifyPermissions) == 0);
}
if (!applyBinaryDeltaToFile(tempDiffFile, sourceDiffFilePath, destinationFilePath)) {
if (verbose) {
fprintf(stderr, "\n");
}
if (error != NULL) {
*error = [NSError errorWithDomain:NSCocoaErrorDomain code:NSFileWriteUnknownError userInfo:@{ NSLocalizedDescriptionKey: [NSString stringWithFormat:@"Unable to patch %@ to destination %@", sourceFilePath, destinationFilePath] }];
}
*stop = YES;
return;
}
if (needsToCopyFilePermissions) {
struct stat sourceFileInfo = {0};
if (lstat(sourceDiffFilePath.fileSystemRepresentation, &sourceFileInfo) != 0) {
if (verbose) {
fprintf(stderr, "\n");
}
if (error != NULL) {
*error = [NSError errorWithDomain:NSCocoaErrorDomain code:NSFileWriteUnknownError userInfo:@{ NSLocalizedDescriptionKey: [NSString stringWithFormat:@"Unable to retrieve stat info from %@", sourceFilePath] }];
}
*stop = YES;
return;
}
if (chmod(destinationFilePath.fileSystemRepresentation, sourceFileInfo.st_mode) != 0) {
if (verbose) {
fprintf(stderr, "\n");
}
if (error != NULL) {
*error = [NSError errorWithDomain:NSCocoaErrorDomain code:NSFileWriteNoPermissionError userInfo:@{ NSLocalizedDescriptionKey: [NSString stringWithFormat:@"Unable to modify permissions (%u) on file %@", sourceFileInfo.st_mode, destinationFilePath] }];
}
*stop = YES;
return;
}
}
if (verbose) {
if ((commands & SPUDeltaItemCommandClone) != 0) {
fprintf(stderr, "\n🔨 %s %s -> %s", VERBOSE_PATCHED, [clonedRelativePath fileSystemRepresentation], [relativePath fileSystemRepresentation]);
} else {
fprintf(stderr, "\n🔨 %s %s", VERBOSE_PATCHED, [relativePath fileSystemRepresentation]);
}
}
} else if ((commands & SPUDeltaItemCommandExtract) != 0) { // extract and permission modifications don't coexist
item.itemFilePath = destinationFilePath;
if (![archive extractItem:item]) {
if (verbose) {
fprintf(stderr, "\n");
}
if (error != NULL) {
*error = [NSError errorWithDomain:NSCocoaErrorDomain code:NSFileWriteUnknownError userInfo:@{ NSLocalizedDescriptionKey: [NSString stringWithFormat:@"Unable to extract file to %@", destinationFilePath], NSUnderlyingErrorKey: (NSError * _Nonnull)archive.error }];
}
*stop = YES;
return;
}
if (verbose) {
if (fileExisted) {
fprintf(stderr, "\n✏️ %s %s", VERBOSE_UPDATED, [relativePath fileSystemRepresentation]);
} else {
fprintf(stderr, "\n✅ %s %s", VERBOSE_ADDED, [relativePath fileSystemRepresentation]);
}
}
} else if (verbose && removedFile) {
fprintf(stderr, "\n❌ %s %s", VERBOSE_DELETED, [relativePath fileSystemRepresentation]);
}
if ((commands & SPUDeltaItemCommandModifyPermissions) != 0) {
mode_t mode = (mode_t)item.mode;
if (!modifyPermissions(destinationFilePath, mode)) {
if (verbose) {
fprintf(stderr, "\n");
}
if (error != NULL) {
*error = [NSError errorWithDomain:NSCocoaErrorDomain code:NSFileWriteNoPermissionError userInfo:@{ NSLocalizedDescriptionKey: [NSString stringWithFormat:@"Unable to modify permissions (%u) on file %@", mode, destinationFilePath] }];
}
*stop = YES;
return;
}
if (verbose) {
fprintf(stderr, "\n👮 %s %s (0%o)", VERBOSE_MODIFIED, [relativePath fileSystemRepresentation], mode & PERMISSION_FLAGS);
}
}
}];
[archive close];
// Set error from enumerating items if we have encountered an error and haven't set it yet
NSError *archiveError = archive.error;
if (archiveError != nil) {
if (verbose) {
fprintf(stderr, "\n");
}
if (error != NULL && *error == nil) {
*error = archiveError;
}
removeTree(destination);
return NO;
}
progressCallback(5/7.0);
// Re-apply file system compression is requested
if (header.fileSystemCompression) {
if (verbose) {
fprintf(stderr, "\nApplying file system compression...");
}
NSTask *dittoTask = [[NSTask alloc] init];
dittoTask.executableURL = [NSURL fileURLWithPath:@"/usr/bin/ditto" isDirectory:NO];
dittoTask.arguments = @[@"--hfsCompression", destination, finalDestination];
// If we fail to apply file system compression, we will try falling back to not doing this
BOOL failedToApplyFileSystemCompression = NO;
NSError *launchError = nil;
if (![dittoTask launchAndReturnError:&launchError]) {
failedToApplyFileSystemCompression = YES;
fprintf(stderr, "\nWarning: failed to launch ditto task for file compression: %s", launchError.localizedDescription.UTF8String);
}
if (!failedToApplyFileSystemCompression) {
[dittoTask waitUntilExit];
if (dittoTask.terminationStatus != 0) {
failedToApplyFileSystemCompression = YES;
fprintf(stderr, "\nWarning: ditto task for file compression returned exit status %d", dittoTask.terminationStatus);
}
}
if (failedToApplyFileSystemCompression) {
// Try to replace bundle normally
if (![fileManager replaceItemAtURL:[NSURL fileURLWithPath:finalDestination] withItemAtURL:[NSURL fileURLWithPath:destination isDirectory:YES] backupItemName:nil options:0 resultingItemURL:NULL error:error]) {
removeTree(destination);
return NO;
}
} else {
// Remove original copy
[fileManager removeItemAtURL:[NSURL fileURLWithPath:destination isDirectory:YES] error:NULL];
}
}
progressCallback(6/7.0);
if (verbose) {
fprintf(stderr, "\nVerifying destination...");
}
unsigned char afterHash[CC_SHA1_DIGEST_LENGTH] = {0};
if (!getRawHashOfTreeWithVersion(afterHash, finalDestination, majorDiffVersion)) {
if (verbose) {
fprintf(stderr, "\n");
}
if (error != NULL) {
*error = [NSError errorWithDomain:NSCocoaErrorDomain code:NSFileReadUnknownError userInfo:@{ NSLocalizedDescriptionKey: [NSString stringWithFormat:@"Unable to calculate hash of tree %@", finalDestination] }];
}
removeTree(finalDestination);
return NO;
}
if (memcmp(afterHash, expectedAfterHash, CC_SHA1_DIGEST_LENGTH) != 0) {
if (verbose) {
fprintf(stderr, "\n");
}
if (error != NULL) {
*error = [NSError errorWithDomain:NSCocoaErrorDomain code:NSFileReadUnknownError userInfo:@{ NSLocalizedDescriptionKey: [NSString stringWithFormat:@"Destination doesn't have expected hash (%@ != %@). Giving up.", displayHashFromRawHash(expectedAfterHash), displayHashFromRawHash(afterHash)] }];
}
removeTree(finalDestination);
return NO;
}
progressCallback(7/7.0);
if (verbose) {
fprintf(stderr, "\nDone!\n");
}
return YES;
}
+78
View File
@@ -0,0 +1,78 @@
//
// SUBinaryDeltaCommon.h
// Sparkle
//
// Created by Mark Rowe on 2009-06-01.
// Copyright 2009 Mark Rowe. All rights reserved.
//
#ifndef SUBINARYDELTACOMMON_H
#define SUBINARYDELTACOMMON_H
#import <Foundation/Foundation.h>
#import "SPUDeltaCompressionMode.h"
#include <fts.h>
#define PERMISSION_FLAGS (S_IRWXU | S_IRWXG | S_IRWXO | S_ISUID | S_ISGID | S_ISVTX)
#define VALID_SYMBOLIC_LINK_PERMISSIONS 0755
// Enforcing Sparkle's executable permissions to be valid allows us to perform a preflight test before
// downloading delta items
#define VALID_SPARKLE_EXECUTABLE_PERMISSIONS 0755
#define APPLE_CODE_SIGN_XATTR_CODE_DIRECTORY_KEY "com.apple.cs.CodeDirectory"
#define APPLE_CODE_SIGN_XATTR_CODE_REQUIREMENTS_KEY "com.apple.cs.CodeRequirements"
#define APPLE_CODE_SIGN_XATTR_CODE_SIGNATURE_KEY "com.apple.cs.CodeSignature"
#define VERBOSE_DELETED "Deleted" // file is deleted from the file system when applying a patch
#define VERBOSE_REMOVED "Removed" // file is set to be removed when creating a patch
#define VERBOSE_ADDED "Added" // file is added to the patch or file system
#define VERBOSE_DIFFED "Diffed" // file is diffed when creating a patch
#define VERBOSE_PATCHED "Patched" // file is patched when applying a patch
#define VERBOSE_UPDATED "Updated" // file's contents are updated
#define VERBOSE_MODIFIED "Modified" // file's metadata is modified
#define VERBOSE_CLONED "Cloned" // file is cloned in content from a differently named file
#define MAJOR_VERSION_IS_AT_LEAST(actualMajor, expectedMajor) (actualMajor >= expectedMajor)
// Relative path of custom icon data that may be set on a bundle via a resource fork
#define CUSTOM_ICON_PATH @"/Icon\r"
// Changes that break backwards compatibility will have different major versions
// Changes that affect creating but not applying patches will have different minor versions
typedef NS_ENUM(uint16_t, SUBinaryDeltaMajorVersion)
{
// Note: support for creating or applying version 1 deltas have been removed
SUBinaryDeltaMajorVersion1 = 1,
SUBinaryDeltaMajorVersion2 = 2,
SUBinaryDeltaMajorVersion3 = 3
};
extern SUBinaryDeltaMajorVersion SUBinaryDeltaMajorVersionDefault;
extern SUBinaryDeltaMajorVersion SUBinaryDeltaMajorVersionLatest;
extern SUBinaryDeltaMajorVersion SUBinaryDeltaMajorVersionFirst;
extern SUBinaryDeltaMajorVersion SUBinaryDeltaMajorVersionFirstSupported;
// Additional compression methods for version 3 patches that we have for debugging are zlib, bzip2, none
#define COMPRESSION_METHOD_ARGUMENT_DESCRIPTION @"The compression method to use for generating delta updates. Supported methods for version 3 delta files are 'lzma' (best compression, slowest), 'lzfse' (good compression, fast), 'lz4' (worse compression, fastest), and 'default'. Note that version 2 delta files only support 'bzip2', and 'default' so other methods will be ignored if version 2 files are being generated. The 'default' compression for version 3 delta files is currently lzma."
//#define COMPRESSION_LEVEL_ARGUMENT_DESCRIPTION @"The compression level to use for generating delta updates. This only applies if the compression method used is bzip2 which accepts values from 1 - 9. A special value of 0 will use the default compression level."
SPUDeltaCompressionMode deltaCompressionModeFromDescription(NSString *description, BOOL *requestValid);
NSString *deltaCompressionStringFromMode(SPUDeltaCompressionMode mode);
extern int compareFiles(const FTSENT **a, const FTSENT **b);
BOOL getRawHashOfTreeWithVersion(unsigned char *hashBuffer, NSString *path, uint16_t majorVersion);
BOOL getRawHashOfTreeAndFileTablesWithVersion(unsigned char *hashBuffer, NSString *path, uint16_t majorVersion, NSMutableDictionary<NSData *, NSMutableArray<NSString *> *> *hashToFileKeyDictionary, NSMutableDictionary<NSString *, NSData *> *fileKeyToHashDictionary);
NSString *displayHashFromRawHash(const unsigned char *hash);
void getRawHashFromDisplayHash(unsigned char *hash, NSString *hexHash);
extern NSString *hashOfTreeWithVersion(NSString *path, uint16_t majorVersion);
extern NSString *hashOfTree(NSString *path);
extern BOOL removeTree(NSString *path);
extern BOOL copyTree(NSString *source, NSString *dest);
extern BOOL modifyPermissions(NSString *path, mode_t desiredPermissions);
extern NSString *pathRelativeToDirectory(NSString *directory, NSString *path);
NSString *temporaryFilename(NSString *base);
NSString *temporaryDirectory(NSString *base);
NSString *stringWithFileSystemRepresentation(const char*);
uint16_t latestMinorVersionForMajorVersion(SUBinaryDeltaMajorVersion majorVersion);
#endif
+384
View File
@@ -0,0 +1,384 @@
//
// SUBinaryDeltaCommon.m
// Sparkle
//
// Created by Mark Rowe on 2009-06-01.
// Copyright 2009 Mark Rowe. All rights reserved.
//
#include "SUBinaryDeltaCommon.h"
#import "SUFileManager.h"
#include <CommonCrypto/CommonDigest.h>
#include <Foundation/Foundation.h>
#include <fcntl.h>
#include <stdio.h>
#include <string.h>
#include <sys/mman.h>
#include <sys/param.h>
#include <sys/stat.h>
#include <xlocale.h>
#include "AppKitPrevention.h"
// Note: the framework bundle version must be bumped, and generate_appcast must be updated to compare it,
// when we add/change new major versions and defaults. Unit tests need to be updated to use new versions too.
SUBinaryDeltaMajorVersion SUBinaryDeltaMajorVersionDefault = SUBinaryDeltaMajorVersion3;
SUBinaryDeltaMajorVersion SUBinaryDeltaMajorVersionLatest = SUBinaryDeltaMajorVersion3;
SUBinaryDeltaMajorVersion SUBinaryDeltaMajorVersionFirst = SUBinaryDeltaMajorVersion1;
SUBinaryDeltaMajorVersion SUBinaryDeltaMajorVersionFirstSupported = SUBinaryDeltaMajorVersion2;
SPUDeltaCompressionMode deltaCompressionModeFromDescription(NSString *requestedDescription, BOOL *requestValid)
{
// Set to NO later if request was not valid
if (requestValid != NULL) {
*requestValid = YES;
}
SPUDeltaCompressionMode compression;
NSString *description = requestedDescription.lowercaseString;
if ([description isEqualToString:@"default"]) {
compression = SPUDeltaCompressionModeDefault;
} else if ([description isEqualToString:@"none"]) {
compression = SPUDeltaCompressionModeNone;
} else if ([description isEqualToString:@"bzip2"]) {
compression = SPUDeltaCompressionModeBzip2;
} else if ([description isEqualToString:@"lzma"]) {
compression = SPUDeltaCompressionModeLZMA;
} else if ([description isEqualToString:@"lzfse"]) {
compression = SPUDeltaCompressionModeLZFSE;
} else if ([description isEqualToString:@"lz4"]) {
compression = SPUDeltaCompressionModeLZ4;
} else if ([description isEqualToString:@"zlib"]) {
compression = SPUDeltaCompressionModeZLIB;
} else {
compression = SPUDeltaCompressionModeDefault;
if (requestValid != NULL) {
*requestValid = NO;
}
}
return compression;
}
NSString *deltaCompressionStringFromMode(SPUDeltaCompressionMode mode)
{
switch (mode) {
case SPUDeltaCompressionModeBzip2:
return @"bzip2";
case SPUDeltaCompressionModeLZMA:
return @"LZMA";
case SPUDeltaCompressionModeNone:
return @"no";
case SPUDeltaCompressionModeLZ4:
return @"LZ4";
case SPUDeltaCompressionModeLZFSE:
return @"LZFSE";
case SPUDeltaCompressionModeZLIB:
return @"ZLIB";
default:
break;
}
if (mode == SPUDeltaCompressionModeDefault) {
return @"default";
}
return @"unknown";
}
int compareFiles(const FTSENT **a, const FTSENT **b)
{
return strcoll_l((*a)->fts_name, (*b)->fts_name, _c_locale);
}
NSString *pathRelativeToDirectory(NSString *directory, NSString *path)
{
NSUInteger directoryLength = [directory length];
if ([path hasPrefix:directory])
return [path substringFromIndex:directoryLength];
return path;
}
NSString *stringWithFileSystemRepresentation(const char *input)
{
return [[NSFileManager defaultManager] stringWithFileSystemRepresentation:input length:strlen(input)];
}
uint16_t latestMinorVersionForMajorVersion(SUBinaryDeltaMajorVersion majorVersion)
{
switch (majorVersion) {
case SUBinaryDeltaMajorVersion1:
return 2;
case SUBinaryDeltaMajorVersion2:
return 4;
case SUBinaryDeltaMajorVersion3:
return 1;
}
return 0;
}
NSString *temporaryFilename(NSString *base)
{
NSString *template = [NSTemporaryDirectory() stringByAppendingPathComponent:[NSString stringWithFormat:@"%@.XXXXXXXXXX", base]];
NSMutableData *data = [NSMutableData data];
[data appendBytes:template.fileSystemRepresentation length:strlen(template.fileSystemRepresentation) + 1];
char *buffer = data.mutableBytes;
int fd = mkstemp(buffer);
if (fd == -1) {
perror("mkstemp");
return nil;
}
if (close(fd) != 0) {
perror("close");
return nil;
}
return stringWithFileSystemRepresentation(buffer);
}
NSString *temporaryDirectory(NSString *base)
{
NSString *template = [NSTemporaryDirectory() stringByAppendingPathComponent:[NSString stringWithFormat:@"%@.XXXXXXXXXX", base]];
NSMutableData *data = [NSMutableData data];
[data appendBytes:template.fileSystemRepresentation length:strlen(template.fileSystemRepresentation) + 1];
char *buffer = data.mutableBytes;
char *templateResult = mkdtemp(buffer);
if (templateResult == NULL) {
perror("mkdtemp");
return nil;
}
return stringWithFileSystemRepresentation(templateResult);
}
static void _hashOfBuffer(unsigned char *hash, const char *buffer, ssize_t bufferLength)
{
assert(bufferLength >= 0 && bufferLength <= UINT32_MAX);
CC_SHA1_CTX hashContext;
CC_SHA1_Init(&hashContext);
CC_SHA1_Update(&hashContext, buffer, (CC_LONG)bufferLength);
CC_SHA1_Final(hash, &hashContext);
}
static BOOL _hashOfFileContents(unsigned char *hash, FTSENT *ent, void *tempBuffer, size_t tempBufferSize)
{
if (ent->fts_info == FTS_SL) {
char linkDestination[MAXPATHLEN + 1];
ssize_t linkDestinationLength = readlink(ent->fts_path, linkDestination, MAXPATHLEN);
if (linkDestinationLength < 0) {
perror("readlink");
return NO;
}
_hashOfBuffer(hash, linkDestination, linkDestinationLength);
} else if (ent->fts_info == FTS_F) {
ssize_t fileSize = ent->fts_statp->st_size;
if (fileSize <= 0) {
_hashOfBuffer(hash, NULL, 0);
} else {
FILE *file = fopen(ent->fts_path, "rb");
if (file == NULL) {
perror("fopen");
return NO;
}
CC_SHA1_CTX hashContext;
CC_SHA1_Init(&hashContext);
size_t bytesLeft = (size_t)fileSize;
while (bytesLeft > 0) {
size_t bytesToConsume = (bytesLeft >= tempBufferSize) ? tempBufferSize : bytesLeft;
if (fread(tempBuffer, bytesToConsume, 1, file) < 1) {
perror("fread");
fclose(file);
return NO;
}
CC_SHA1_Update(&hashContext, tempBuffer, (CC_LONG)bytesToConsume);
bytesLeft -= bytesToConsume;
}
CC_SHA1_Final(hash, &hashContext);
fclose(file);
}
} else if (ent->fts_info == FTS_D) {
memset(hash, 0xdd, CC_SHA1_DIGEST_LENGTH);
} else {
return NO;
}
return YES;
}
BOOL getRawHashOfTreeWithVersion(unsigned char *hashBuffer, NSString *path, uint16_t majorVersion)
{
return getRawHashOfTreeAndFileTablesWithVersion(hashBuffer, path, majorVersion, nil, nil);
}
BOOL getRawHashOfTreeAndFileTablesWithVersion(unsigned char *hashBuffer, NSString *path, uint16_t __unused majorVersion, NSMutableDictionary<NSData *, NSMutableArray<NSString *> *> *hashToFileKeyDictionary, NSMutableDictionary<NSString *, NSData *> *fileKeyToHashDictionary)
{
char pathBuffer[PATH_MAX] = { 0 };
if (![path getFileSystemRepresentation:pathBuffer maxLength:sizeof(pathBuffer)]) {
return NO;
}
const size_t tempBufferSize = 16384;
void *tempBuffer = calloc(1, tempBufferSize);
if (tempBuffer == NULL) {
perror("calloc");
return NO;
}
char *const sourcePaths[] = { pathBuffer, 0 };
FTS *fts = fts_open(sourcePaths, FTS_PHYSICAL | FTS_NOCHDIR, compareFiles);
if (!fts) {
perror("fts_open");
free(tempBuffer);
return NO;
}
CC_SHA1_CTX hashContext;
CC_SHA1_Init(&hashContext);
// Ensure the path uses filesystem-specific Unicode normalization #1017
NSString *normalizedPath = stringWithFileSystemRepresentation(pathBuffer);
FTSENT *ent = 0;
while ((ent = fts_read(fts))) {
if (ent->fts_info != FTS_F && ent->fts_info != FTS_SL && ent->fts_info != FTS_D)
continue;
NSString *relativePath = pathRelativeToDirectory(normalizedPath, stringWithFileSystemRepresentation(ent->fts_path));
// Ignore icon resource fork data
if (relativePath.length == 0 || [relativePath isEqualToString:CUSTOM_ICON_PATH]) {
continue;
}
unsigned char fileHash[CC_SHA1_DIGEST_LENGTH];
if (!_hashOfFileContents(fileHash, ent, tempBuffer, tempBufferSize)) {
fts_close(fts);
free(tempBuffer);
return NO;
}
CC_SHA1_Update(&hashContext, fileHash, sizeof(fileHash));
// For file hash tables we only track regular files
if (ent->fts_info == FTS_F) {
NSData *hashKey = [NSData dataWithBytes:fileHash length:sizeof(fileHash)];
if (hashToFileKeyDictionary != nil) {
if (hashToFileKeyDictionary[hashKey] == nil) {
hashToFileKeyDictionary[hashKey] = [NSMutableArray array];
}
[hashToFileKeyDictionary[hashKey] addObject:relativePath];
}
if (fileKeyToHashDictionary != nil) {
fileKeyToHashDictionary[relativePath] = hashKey;
}
}
const char *relativePathBytes = [relativePath fileSystemRepresentation];
CC_SHA1_Update(&hashContext, relativePathBytes, (CC_LONG)strlen(relativePathBytes));
uint16_t mode = ent->fts_statp->st_mode;
uint16_t type = ent->fts_info;
uint16_t permissions = mode & PERMISSION_FLAGS;
// permission of symlinks are 0777 on some linux file systems and can't be changed,
// differing from the 0755 macOS default.
// hardcoding a value helps avoid differences between filesystems.
uint16_t hashedPermissions = (ent->fts_info == FTS_SL) ? VALID_SYMBOLIC_LINK_PERMISSIONS : permissions;
CC_SHA1_Update(&hashContext, &type, sizeof(type));
CC_SHA1_Update(&hashContext, &hashedPermissions, sizeof(hashedPermissions));
}
free(tempBuffer);
fts_close(fts);
CC_SHA1_Final(hashBuffer, &hashContext);
return YES;
}
void getRawHashFromDisplayHash(unsigned char *hash, NSString *hexHash)
{
const char *hexString = hexHash.UTF8String;
if (hexString == NULL) {
return;
}
for (size_t blockIndex = 0; blockIndex < CC_SHA1_DIGEST_LENGTH; blockIndex++) {
const char *currentBlock = hexString + blockIndex * 2;
char convertedBlock[3] = {currentBlock[0], currentBlock[1], '\0'};
hash[blockIndex] = (unsigned char)strtol(convertedBlock, NULL, 16);
}
}
NSString *displayHashFromRawHash(const unsigned char *hash)
{
char hexHash[CC_SHA1_DIGEST_LENGTH * 2 + 1] = {0};
for (size_t i = 0; i < CC_SHA1_DIGEST_LENGTH; i++) {
snprintf(hexHash + i * 2, 3, "%02x", hash[i]);
}
return @(hexHash);
}
NSString *hashOfTreeWithVersion(NSString *path, uint16_t majorVersion)
{
unsigned char hash[CC_SHA1_DIGEST_LENGTH];
if (!getRawHashOfTreeWithVersion(hash, path, majorVersion)) {
return nil;
}
return displayHashFromRawHash(hash);
}
extern NSString *hashOfTree(NSString *path)
{
return hashOfTreeWithVersion(path, SUBinaryDeltaMajorVersionLatest);
}
BOOL removeTree(NSString *path)
{
NSFileManager *fileManager = [NSFileManager defaultManager];
// Don't use fileExistsForPath: because it will try to follow symbolic links
if (![fileManager attributesOfItemAtPath:path error:nil]) {
return YES;
}
return [fileManager removeItemAtPath:path error:nil];
}
BOOL copyTree(NSString *source, NSString *dest)
{
// SUFileManager will be more reliable for copying items especially across network mounts
return [[[SUFileManager alloc] init] copyItemAtURL:[NSURL fileURLWithPath:source] toURL:[NSURL fileURLWithPath:dest] error:NULL];
}
BOOL modifyPermissions(NSString *path, mode_t desiredPermissions)
{
NSFileManager *fileManager = [NSFileManager defaultManager];
NSDictionary *attributes = [fileManager attributesOfItemAtPath:path error:nil];
if (!attributes) {
return NO;
}
NSNumber *permissions = [attributes objectForKey:NSFilePosixPermissions];
if (!permissions) {
return NO;
}
mode_t newMode = ([permissions unsignedShortValue] & ~PERMISSION_FLAGS) | desiredPermissions;
int (*changeModeFunc)(const char *, mode_t) = [(NSString *)[attributes objectForKey:NSFileType] isEqualToString:NSFileTypeSymbolicLink] ? lchmod : chmod;
if (changeModeFunc([path fileSystemRepresentation], newMode) != 0) {
return NO;
}
return YES;
}
@@ -10,8 +10,9 @@
#define SUBINARYDELTACREATE_H
#import "SUBinaryDeltaCommon.h"
#import "SPUDeltaArchiveProtocol.h"
@class NSString;
BOOL createBinaryDelta(NSString *source, NSString *destination, NSString *patchFile, SUBinaryDeltaMajorVersion majorVersion, BOOL verbose, NSError * __autoreleasing *error);
BOOL createBinaryDelta(NSString *source, NSString *destination, NSString *patchFile, SUBinaryDeltaMajorVersion majorVersion, SPUDeltaCompressionMode compression, uint8_t compressionLevel, BOOL verbose, NSError * __autoreleasing *error);
#endif
File diff suppressed because it is too large. Load diff
@@ -14,9 +14,14 @@
NS_ASSUME_NONNULL_BEGIN
#ifndef BUILDING_SPARKLE_TESTS
SPU_OBJC_DIRECT_MEMBERS
#endif
@interface SUBinaryDeltaUnarchiver : NSObject <SUUnarchiverProtocol>
- (instancetype)initWithArchivePath:(NSString *)archivePath updateHostBundlePath:(NSString *)updateHostBundlePath;
- (instancetype)initWithArchivePath:(NSString *)archivePath extractionDirectory:(NSString *)extractionDirectory updateHostBundlePath:(NSString *)updateHostBundlePath;
+ (BOOL)canUnarchivePath:(NSString *)path;
@end
@@ -16,17 +16,12 @@
#include "AppKitPrevention.h"
@interface SUBinaryDeltaUnarchiver ()
@property (nonatomic, copy, readonly) NSString *archivePath;
@property (nonatomic, copy, readonly) NSString *updateHostBundlePath;
@end
@implementation SUBinaryDeltaUnarchiver
@synthesize archivePath = _archivePath;
@synthesize updateHostBundlePath = _updateHostBundlePath;
{
NSString *_archivePath;
NSString *_updateHostBundlePath;
NSString *_extractionDirectory;
}
+ (BOOL)canUnarchivePath:(NSString *)path
{
@@ -43,7 +38,11 @@
// We used to invoke mdimport on the bundle but this is not a very good approach.
// There's no need to do that for non-delta updates and for updates that contain no mdimporters.
// Moreover, updating the timestamp on the mdimporter bundles is what developers have to do anyway when shipping their new update outside of Sparkle
// Note: this is used from unit tests
+ (void)updateSpotlightImportersAtBundlePath:(NSString *)targetPath
#ifndef BUILDING_SPARKLE_TESTS
SPU_OBJC_DIRECT
#endif
{
NSURL *targetURL = [NSURL fileURLWithPath:targetPath];
// Only recurse if it's actually a directory. Don't recurse into a
@@ -63,7 +62,7 @@
}
}
SUFileManager *fileManager = [SUFileManager defaultManager];
SUFileManager *fileManager = [[SUFileManager alloc] init];
for (NSURL *file in filesToUpdate) {
NSError *error = nil;
if (![fileManager updateModificationAndAccessTimeOfItemAtURL:file error:&error]) {
@@ -73,12 +72,13 @@
}
}
- (instancetype)initWithArchivePath:(NSString *)archivePath updateHostBundlePath:(NSString *)updateHostBundlePath
- (instancetype)initWithArchivePath:(NSString *)archivePath extractionDirectory:(NSString *)extractionDirectory updateHostBundlePath:(NSString *)updateHostBundlePath
{
self = [super init];
if (self != nil) {
_archivePath = [archivePath copy];
_updateHostBundlePath = [updateHostBundlePath copy];
_extractionDirectory = [extractionDirectory copy];
}
return self;
}
@@ -95,17 +95,17 @@
- (void)extractDeltaWithNotifier:(SUUnarchiverNotifier *)notifier
{
NSString *sourcePath = self.updateHostBundlePath;
NSString *targetPath = [[self.archivePath stringByDeletingLastPathComponent] stringByAppendingPathComponent:[sourcePath lastPathComponent]];
NSString *sourcePath = _updateHostBundlePath;
NSString *targetPath = [_extractionDirectory stringByAppendingPathComponent:[sourcePath lastPathComponent]];
NSError *applyDiffError = nil;
BOOL success = applyBinaryDelta(sourcePath, targetPath, self.archivePath, NO, ^(double progress){
BOOL success = applyBinaryDelta(sourcePath, targetPath, _archivePath, NO, ^(double progress){
[notifier notifyProgress:progress];
}, &applyDiffError);
if (success) {
[[self class] updateSpotlightImportersAtBundlePath:targetPath];
[SUBinaryDeltaUnarchiver updateSpotlightImportersAtBundlePath:targetPath];
[notifier notifySuccess];
}
else {
@@ -113,6 +113,6 @@
}
}
- (NSString *)description { return [NSString stringWithFormat:@"%@ <%@>", [self class], self.archivePath]; }
- (NSString *)description { return [NSString stringWithFormat:@"%@ <%@>", [self class], _archivePath]; }
@end
+36
View File
@@ -0,0 +1,36 @@
//
// SUCodeSigningVerifier.h
// Sparkle
//
// Created by Andy Matuschak on 7/5/12.
//
//
#ifndef SUCODESIGNINGVERIFIER_H
#define SUCODESIGNINGVERIFIER_H
#import <Foundation/Foundation.h>
NS_ASSUME_NONNULL_BEGIN
#ifndef BUILDING_SPARKLE_TESTS
SPU_OBJC_DIRECT_MEMBERS
#endif
@interface SUCodeSigningVerifier : NSObject
+ (BOOL)codeSignatureIsValidAtBundleURL:(NSURL *)newBundleURL andMatchesSignatureAtBundleURL:(NSURL *)oldBundleURL error:(NSError **)error;
+ (BOOL)codeSignatureIsValidAtBundleURL:(NSURL *)bundleURL checkNestedCode:(BOOL)checkNestedCode error:(NSError **)error;
// Same as above except does not check for nested code. This method should be used by the framework.
+ (BOOL)codeSignatureIsValidAtBundleURL:(NSURL *)bundleURL error:(NSError *__autoreleasing *)error;
+ (BOOL)bundleAtURLIsCodeSigned:(NSURL *)bundleURL;
+ (NSString * _Nullable)teamIdentifierAtURL:(NSURL *)url;
@end
NS_ASSUME_NONNULL_END
#endif
+285
View File
@@ -0,0 +1,285 @@
//
// SUCodeSigningVerifier.m
// Sparkle
//
// Created by Andy Matuschak on 7/5/12.
//
//
#include <Security/CodeSigning.h>
#include <Security/SecCode.h>
#import "SUCodeSigningVerifier.h"
#import "SULog.h"
#import "SUErrors.h"
#include "AppKitPrevention.h"
@implementation SUCodeSigningVerifier
+ (BOOL)codeSignatureIsValidAtBundleURL:(NSURL *)newBundleURL andMatchesSignatureAtBundleURL:(NSURL *)oldBundleURL error:(NSError * __autoreleasing *)error
{
OSStatus result;
SecRequirementRef requirement = NULL;
SecStaticCodeRef staticCode = NULL;
SecStaticCodeRef oldCode = NULL;
CFErrorRef cfError = NULL;
result = SecStaticCodeCreateWithPath((__bridge CFURLRef)oldBundleURL, kSecCSDefaultFlags, &oldCode);
if (result == errSecCSUnsigned) {
if (error != NULL) {
*error = [NSError errorWithDomain:SUSparkleErrorDomain code:SUInsufficientSigningError userInfo:@{ NSLocalizedDescriptionKey: [NSString stringWithFormat:@"Bundle is not code signed: %@", newBundleURL] }];
}
return NO;
}
result = SecCodeCopyDesignatedRequirement(oldCode, kSecCSDefaultFlags, &requirement);
if (result != noErr) {
NSString *message = [NSString stringWithFormat:@"Failed to copy designated requirement. Code Signing OSStatus code: %d", result];
SULog(SULogLevelError, @"%@", message);
if (error != NULL) {
*error = [NSError errorWithDomain:SUSparkleErrorDomain code:SUInsufficientSigningError userInfo:@{ NSLocalizedDescriptionKey: message }];
}
goto finally;
}
result = SecStaticCodeCreateWithPath((__bridge CFURLRef)newBundleURL, kSecCSDefaultFlags, &staticCode);
if (result != noErr) {
NSString *message = [NSString stringWithFormat:@"Failed to get static code %d", result];
SULog(SULogLevelError, @"%@", message);
if (error != NULL) {
*error = [NSError errorWithDomain:SUSparkleErrorDomain code:SUInsufficientSigningError userInfo:@{ NSLocalizedDescriptionKey: message }];
}
goto finally;
}
// Note that kSecCSCheckNestedCode may not work with pre-Mavericks code signing.
// See https://github.com/sparkle-project/Sparkle/issues/376#issuecomment-48824267 and https://developer.apple.com/library/mac/technotes/tn2206
// Additionally, there are several reasons to stay away from deep verification and to prefer EdDSA signing the download archive instead.
// See https://github.com/sparkle-project/Sparkle/pull/523#commitcomment-17549302 and https://github.com/sparkle-project/Sparkle/issues/543
SecCSFlags flags = (SecCSFlags) (kSecCSDefaultFlags | kSecCSCheckAllArchitectures);
result = SecStaticCodeCheckValidityWithErrors(staticCode, flags, requirement, &cfError);
if (result != errSecSuccess) {
NSError *underlyingError;
if (cfError != NULL) {
NSError *tmpError = CFBridgingRelease(cfError);
underlyingError = tmpError;
} else {
underlyingError = nil;
}
NSMutableDictionary *userInfo = [NSMutableDictionary dictionary];
if (underlyingError != nil) {
userInfo[NSUnderlyingErrorKey] = underlyingError;
}
if (result == errSecCSUnsigned) {
NSString *message = @"The host app is signed, but the new version of the app is not signed using Apple Code Signing. Please ensure that the new app is signed and that archiving did not corrupt the signature.";
SULog(SULogLevelError, @"%@", message);
if (error != NULL) {
userInfo[NSLocalizedDescriptionKey] = message;
*error = [NSError errorWithDomain:SUSparkleErrorDomain code:SUInsufficientSigningError userInfo:[userInfo copy]];
}
} else if (result == errSecCSReqFailed) {
CFStringRef requirementString = nil;
NSString *initialMessage;
if (SecRequirementCopyString(requirement, kSecCSDefaultFlags, &requirementString) == noErr) {
initialMessage = [NSString stringWithFormat:@"Code signature of the new version doesn't match the old version: %@. Please ensure that old and new app is signed using exactly the same certificate.", requirementString];
SULog(SULogLevelError, @"%@", initialMessage);
CFRelease(requirementString);
} else {
initialMessage = @"Code signature of new version doesn't match the old version. Please ensure that old and new app is signed using exactly the same certificate.";
}
NSDictionary *oldInfo = [self logSigningInfoForCode:oldCode label:@"old info"];
NSDictionary *newInfo = [self logSigningInfoForCode:staticCode label:@"new info"];
if (error != NULL) {
userInfo[NSLocalizedDescriptionKey] = [NSString stringWithFormat:@"%@ old info: %@. new info: %@", initialMessage, oldInfo, newInfo];
*error = [NSError errorWithDomain:SUSparkleErrorDomain code:SUInsufficientSigningError userInfo:[userInfo copy]];
}
} else {
if (error != NULL) {
userInfo[NSLocalizedDescriptionKey] = @"Error: Old app bundle code signing signature failed to match new bundle code signature";
*error = [NSError errorWithDomain:SUSparkleErrorDomain code:SUInsufficientSigningError userInfo:[userInfo copy]];
}
}
}
finally:
if (oldCode) CFRelease(oldCode);
if (staticCode) CFRelease(staticCode);
if (requirement) CFRelease(requirement);
return (result == noErr);
}
+ (BOOL)codeSignatureIsValidAtBundleURL:(NSURL *)bundleURL error:(NSError *__autoreleasing *)error
{
return [self codeSignatureIsValidAtBundleURL:bundleURL checkNestedCode:NO error:error];
}
+ (BOOL)codeSignatureIsValidAtBundleURL:(NSURL *)bundleURL checkNestedCode:(BOOL)checkNestedCode error:(NSError *__autoreleasing *)error
{
OSStatus result;
SecStaticCodeRef staticCode = NULL;
CFErrorRef cfError = NULL;
result = SecStaticCodeCreateWithPath((__bridge CFURLRef)bundleURL, kSecCSDefaultFlags, &staticCode);
if (result != noErr) {
SULog(SULogLevelError, @"Failed to get static code %d", result);
if (error != NULL) {
*error = [NSError errorWithDomain:SUSparkleErrorDomain code:SUInsufficientSigningError userInfo:@{ NSLocalizedDescriptionKey: [NSString stringWithFormat:@"Failed to get static code for verifying code signature: %d", result] }];
}
goto finally;
}
// See in -codeSignatureIsValidAtBundleURL:andMatchesSignatureAtBundleURL:error: for why kSecCSCheckNestedCode is not always passed
SecCSFlags flags = (SecCSFlags) (kSecCSDefaultFlags | kSecCSCheckAllArchitectures);
if (checkNestedCode) {
flags |= kSecCSCheckNestedCode;
}
result = SecStaticCodeCheckValidityWithErrors(staticCode, flags, NULL, &cfError);
if (result != errSecSuccess) {
NSError *underlyingError;
if (cfError != NULL) {
NSError *tmpError = CFBridgingRelease(cfError);
underlyingError = tmpError;
} else {
underlyingError = nil;
}
NSMutableDictionary *userInfo = [NSMutableDictionary dictionary];
if (underlyingError != nil) {
userInfo[NSUnderlyingErrorKey] = underlyingError;
}
if (result == errSecCSUnsigned) {
NSString *message = [NSString stringWithFormat:@"Error: The app is not signed using Apple Code Signing. %@", bundleURL];
SULog(SULogLevelError, @"%@", message);
if (error != NULL) {
userInfo[NSLocalizedDescriptionKey] = message;
*error = [NSError errorWithDomain:SUSparkleErrorDomain code:SUInsufficientSigningError userInfo:[userInfo copy]];
}
} else if (result == errSecCSReqFailed) {
if (error != NULL) {
NSDictionary *newInfo = [self logSigningInfoForCode:staticCode label:@"new info"];
NSString *message = [NSString stringWithFormat:@"Error: The app failed Apple Code Signing checks: %@ - new info: %@", bundleURL, newInfo];
userInfo[NSLocalizedDescriptionKey] = message;
*error = [NSError errorWithDomain:SUSparkleErrorDomain code:SUInsufficientSigningError userInfo:[userInfo copy]];
}
} else {
if (error != NULL) {
NSString *message = [NSString stringWithFormat:@"Error: The app failed Apple Code Signing checks: %@", bundleURL];
userInfo[NSLocalizedDescriptionKey] = message;
*error = [NSError errorWithDomain:SUSparkleErrorDomain code:SUInsufficientSigningError userInfo:[userInfo copy]];
}
}
}
finally:
if (staticCode) CFRelease(staticCode);
return (result == noErr);
}
static id valueOrNSNull(id value) {
return value ? value : [NSNull null];
}
+ (NSDictionary *)codeSignatureInfoForCode:(SecStaticCodeRef)code SPU_OBJC_DIRECT
{
CFDictionaryRef signingInfo = nil;
const SecCSFlags flags = (SecCSFlags) (kSecCSSigningInformation | kSecCSRequirementInformation | kSecCSDynamicInformation | kSecCSContentInformation);
if (SecCodeCopySigningInformation(code, flags, &signingInfo) == noErr) {
NSDictionary *signingDict = CFBridgingRelease(signingInfo);
NSMutableDictionary *relevantInfo = [NSMutableDictionary dictionary];
for (NSString *key in @[@"format", @"identifier", @"requirements", @"teamid", @"signing-time"]) {
[relevantInfo setObject:valueOrNSNull([signingDict objectForKey:key]) forKey:key];
}
NSDictionary *infoPlist = [signingDict objectForKey:@"info-plist"];
[relevantInfo setObject:valueOrNSNull([infoPlist objectForKey:@"CFBundleShortVersionString"]) forKey:@"version"];
[relevantInfo setObject:valueOrNSNull([infoPlist objectForKey:(__bridge NSString *)kCFBundleVersionKey]) forKey:@"build"];
return [relevantInfo copy];
}
return nil;
}
+ (NSDictionary *)logSigningInfoForCode:(SecStaticCodeRef)code label:(NSString*)label SPU_OBJC_DIRECT
{
NSDictionary *relevantInfo = [self codeSignatureInfoForCode:code];
SULog(SULogLevelDefault, @"%@: %@", label, relevantInfo);
return relevantInfo;
}
+ (BOOL)bundleAtURLIsCodeSigned:(NSURL *)bundleURL
{
OSStatus result;
SecStaticCodeRef staticCode = NULL;
result = SecStaticCodeCreateWithPath((__bridge CFURLRef)bundleURL, kSecCSDefaultFlags, &staticCode);
if (result == errSecCSUnsigned) {
return NO;
}
SecRequirementRef requirement = NULL;
result = SecCodeCopyDesignatedRequirement(staticCode, kSecCSDefaultFlags, &requirement);
if (staticCode) {
CFRelease(staticCode);
}
if (requirement) {
CFRelease(requirement);
}
if (result == errSecCSUnsigned) {
return NO;
}
return (result == 0);
}
+ (NSString * _Nullable)teamIdentifierAtURL:(NSURL *)url
{
SecStaticCodeRef staticCode = NULL;
OSStatus staticCodeResult = SecStaticCodeCreateWithPath((__bridge CFURLRef)url, kSecCSDefaultFlags, &staticCode);
if (staticCodeResult != noErr) {
SULog(SULogLevelError, @"Failed to get static code for retrieving team identifier: %d", staticCodeResult);
return nil;
}
CFDictionaryRef cfSigningInformation = NULL;
OSStatus copySigningInfoCode = SecCodeCopySigningInformation(staticCode, kSecCSSigningInformation,
&cfSigningInformation);
NSDictionary *signingInformation = CFBridgingRelease(cfSigningInformation);
if (copySigningInfoCode != noErr) {
SULog(SULogLevelError, @"Failed to get signing information for retrieving team identifier: %d", copySigningInfoCode);
return nil;
}
// Note this will return nil for ad-hoc or unsigned binaries
return signingInformation[(NSString *)kSecCodeInfoTeamIdentifier];
}
@end
+31
View File
@@ -0,0 +1,31 @@
//
// SUDiskImageUnarchiver.h
// Sparkle
//
// Created by Andy Matuschak on 6/16/08.
// Copyright 2008 Andy Matuschak. All rights reserved.
//
#if SPARKLE_BUILD_DMG_SUPPORT
#ifndef SUDISKIMAGEUNARCHIVER_H
#define SUDISKIMAGEUNARCHIVER_H
#import <Foundation/Foundation.h>
#import "SUUnarchiverProtocol.h"
NS_ASSUME_NONNULL_BEGIN
SPU_OBJC_DIRECT_MEMBERS @interface SUDiskImageUnarchiver : NSObject <SUUnarchiverProtocol>
- (instancetype)initWithArchivePath:(NSString *)archivePath extractionDirectory:(NSString *)extractionDirectory decryptionPassword:(nullable NSString *)decryptionPassword;
+ (BOOL)canUnarchivePath:(NSString *)path;
@end
NS_ASSUME_NONNULL_END
#endif
#endif
@@ -6,6 +6,8 @@
// Copyright 2008 Andy Matuschak. All rights reserved.
//
#if SPARKLE_BUILD_DMG_SUPPORT
#import "SUDiskImageUnarchiver.h"
#import "SUUnarchiverNotifier.h"
#import "SULog.h"
@@ -13,17 +15,12 @@
#include "AppKitPrevention.h"
@interface SUDiskImageUnarchiver ()
@property (nonatomic, copy, readonly) NSString *archivePath;
@property (nullable, nonatomic, copy, readonly) NSString *decryptionPassword;
@end
@implementation SUDiskImageUnarchiver
@synthesize archivePath = _archivePath;
@synthesize decryptionPassword = _decryptionPassword;
{
NSString *_archivePath;
NSString *_decryptionPassword;
NSString *_extractionDirectory;
}
+ (BOOL)canUnarchivePath:(NSString *)path
{
@@ -35,12 +32,13 @@
return NO;
}
- (instancetype)initWithArchivePath:(NSString *)archivePath decryptionPassword:(nullable NSString *)decryptionPassword
- (instancetype)initWithArchivePath:(NSString *)archivePath extractionDirectory:(NSString *)extractionDirectory decryptionPassword:(nullable NSString *)decryptionPassword
{
self = [super init];
if (self != nil) {
_archivePath = [archivePath copy];
_decryptionPassword = [decryptionPassword copy];
_extractionDirectory = [extractionDirectory copy];
}
return self;
}
@@ -54,41 +52,30 @@
}
// Called on a non-main thread.
- (void)extractDMGWithNotifier:(SUUnarchiverNotifier *)notifier
- (void)extractDMGWithNotifier:(SUUnarchiverNotifier *)notifier SPU_OBJC_DIRECT
{
@autoreleasepool {
@autoreleasepool {
BOOL mountedSuccessfully = NO;
// get a unique mount point path
NSString *mountPoint = nil;
NSFileManager *manager;
NSError *error;
NSArray *contents;
NSError *error = nil;
NSArray *contents = nil;
do
{
// Using NSUUID would make creating UUIDs be done in Cocoa,
// and thus managed under ARC. Sadly, the class is in 10.8 and later.
CFUUIDRef uuid = CFUUIDCreate(NULL);
if (uuid)
{
NSString *uuidString = CFBridgingRelease(CFUUIDCreateString(NULL, uuid));
if (uuidString)
{
mountPoint = [@"/Volumes" stringByAppendingPathComponent:uuidString];
}
CFRelease(uuid);
}
}
{
NSString *uuidString = [[NSUUID UUID] UUIDString];
mountPoint = [@"/Volumes" stringByAppendingPathComponent:uuidString];
}
// Note: this check does not follow symbolic links, which is what we want
while ([[NSURL fileURLWithPath:mountPoint] checkResourceIsReachableAndReturnError:NULL]);
while ([[NSURL fileURLWithPath:mountPoint] checkResourceIsReachableAndReturnError:NULL]);
NSData *promptData = nil;
promptData = [NSData dataWithBytes:"yes\n" length:4];
NSData *promptData = [NSData dataWithBytes:"yes\n" length:4];
NSMutableArray *arguments = [@[@"attach", self.archivePath, @"-mountpoint", mountPoint, /*@"-noverify",*/ @"-nobrowse", @"-noautoopen"] mutableCopy];
NSMutableArray *arguments = [@[@"attach", _archivePath, @"-mountpoint", mountPoint, /*@"-noverify",*/ @"-nobrowse", @"-noautoopen"] mutableCopy];
if (self.decryptionPassword) {
NSMutableData *passwordData = [[self.decryptionPassword dataUsingEncoding:NSUTF8StringEncoding] mutableCopy];
if (_decryptionPassword) {
NSMutableData *passwordData = [[_decryptionPassword dataUsingEncoding:NSUTF8StringEncoding] mutableCopy];
// From the hdiutil docs:
// read a null-terminated passphrase from standard input
//
@@ -102,7 +89,7 @@
NSData *output = nil;
NSInteger taskResult = -1;
@try
{
NSTask *task = [[NSTask alloc] init];
task.launchPath = @"/usr/bin/hdiutil";
@@ -115,28 +102,56 @@
task.standardInput = inputPipe;
task.standardOutput = outputPipe;
[task launch];
NSFileHandle *fileStdHandle = outputPipe.fileHandleForReading;
NSMutableData *currentOutput = [NSMutableData data];
fileStdHandle.readabilityHandler = ^(NSFileHandle *file) {
[currentOutput appendData:file.availableData];
};
dispatch_semaphore_t terminationSemaphore = dispatch_semaphore_create(0);
task.terminationHandler = ^(NSTask *__unused terminatingTask) {
fileStdHandle.readabilityHandler = nil;
dispatch_semaphore_signal(terminationSemaphore);
};
if (![task launchAndReturnError:&error]) {
goto reportError;
}
[notifier notifyProgress:0.125];
[inputPipe.fileHandleForWriting writeData:promptData];
if (@available(macOS 10.15, *)) {
if (![inputPipe.fileHandleForWriting writeData:promptData error:&error]) {
goto reportError;
}
}
#if MAC_OS_X_VERSION_MIN_REQUIRED < MAC_OS_X_VERSION_10_15
else
{
@try {
[inputPipe.fileHandleForWriting writeData:promptData];
} @catch (NSException *) {
goto reportError;
}
}
#endif
[inputPipe.fileHandleForWriting closeFile];
// Read data to end *before* waiting until the task ends so we don't deadlock if the stdout buffer becomes full if we haven't consumed from it
output = [outputPipe.fileHandleForReading readDataToEndOfFile];
dispatch_semaphore_wait(terminationSemaphore, DISPATCH_TIME_FOREVER);
output = [currentOutput copy];
[task waitUntilExit];
taskResult = task.terminationStatus;
}
@catch (NSException *)
{
goto reportError;
}
[notifier notifyProgress:0.5];
if (taskResult != 0)
{
if (taskResult != 0)
{
NSString *resultStr = output ? [[NSString alloc] initWithData:output encoding:NSUTF8StringEncoding] : nil;
SULog(SULogLevelError, @"hdiutil failed with code: %ld data: <<%@>>", (long)taskResult, resultStr);
goto reportError;
@@ -146,31 +161,32 @@
// Now that we've mounted it, we need to copy out its contents.
manager = [[NSFileManager alloc] init];
contents = [manager contentsOfDirectoryAtPath:mountPoint error:&error];
if (error)
if (contents == nil)
{
SULog(SULogLevelError, @"Couldn't enumerate contents of archive mounted at %@: %@", mountPoint, error);
goto reportError;
}
double itemsCopied = 0;
double totalItems = [contents count];
double totalItems = (double)[contents count];
for (NSString *item in contents)
{
for (NSString *item in contents)
{
NSString *fromPath = [mountPoint stringByAppendingPathComponent:item];
NSString *toPath = [[self.archivePath stringByDeletingLastPathComponent] stringByAppendingPathComponent:item];
// We skip any files in the DMG which are not readable.
if (![manager isReadableFileAtPath:fromPath]) {
continue;
}
NSString *toPath = [_extractionDirectory stringByAppendingPathComponent:item];
itemsCopied += 1.0;
[notifier notifyProgress:0.5 + itemsCopied/(totalItems*2.0)];
// We skip any files in the DMG which are not readable but include the item in the progress
if (![manager isReadableFileAtPath:fromPath]) {
continue;
}
SULog(SULogLevelDefault, @"copyItemAtPath:%@ toPath:%@", fromPath, toPath);
if (![manager copyItemAtPath:fromPath toPath:toPath error:&error])
{
if (![manager copyItemAtPath:fromPath toPath:toPath error:&error])
{
goto reportError;
}
}
@@ -189,18 +205,19 @@
task.standardOutput = [NSPipe pipe];
task.standardError = [NSPipe pipe];
@try {
[task launch];
} @catch (NSException *exception) {
NSError *launchCleanupError = nil;
if (![task launchAndReturnError:&launchCleanupError]) {
SULog(SULogLevelError, @"Failed to unmount %@", mountPoint);
SULog(SULogLevelError, @"Exception: %@", exception);
SULog(SULogLevelError, @"Error: %@", launchCleanupError);
}
} else {
SULog(SULogLevelError, @"Can't mount DMG %@", self.archivePath);
SULog(SULogLevelError, @"Can't mount DMG %@", _archivePath);
}
}
}
- (NSString *)description { return [NSString stringWithFormat:@"%@ <%@>", [self class], self.archivePath]; }
- (NSString *)description { return [NSString stringWithFormat:@"%@ <%@>", [self class], _archivePath]; }
@end
#endif
@@ -6,16 +6,22 @@
// Copyright © 2021 Sparkle Project. All rights reserved.
//
#if SPARKLE_BUILD_PACKAGE_SUPPORT
#import <Foundation/Foundation.h>
#import "SUUnarchiverProtocol.h"
NS_ASSUME_NONNULL_BEGIN
// An unarchiver for flat packages that doesn't really do any unarchiving
@interface SUFlatPackageUnarchiver : NSObject <SUUnarchiverProtocol>
SPU_OBJC_DIRECT_MEMBERS @interface SUFlatPackageUnarchiver : NSObject <SUUnarchiverProtocol>
- (instancetype)initWithFlatPackagePath:(NSString *)flatPackagePath;
- (instancetype)initWithFlatPackagePath:(NSString *)flatPackagePath extractionDirectory:(NSString *)extractionDirectory expectingInstallationType:(NSString *)installationType;
+ (BOOL)canUnarchivePath:(NSString *)path;
@end
NS_ASSUME_NONNULL_END
#endif
+79
View File
@@ -0,0 +1,79 @@
//
// SUFlatPackageUnarchiver.m
// Autoupdate
//
// Created by Mayur Pawashe on 1/30/21.
// Copyright © 2021 Sparkle Project. All rights reserved.
//
#if SPARKLE_BUILD_PACKAGE_SUPPORT
#import "SUFlatPackageUnarchiver.h"
#import "SUUnarchiverNotifier.h"
#import "SPUInstallationType.h"
#import "SUErrors.h"
#include "AppKitPrevention.h"
@implementation SUFlatPackageUnarchiver
{
NSString *_flatPackagePath;
NSString *_expectedInstallationType;
NSString *_extractionDirectory;
}
+ (BOOL)canUnarchivePath:(NSString *)path
{
return [path.pathExtension isEqualToString:@"pkg"] || [path.pathExtension isEqualToString:@"mpkg"];
}
+ (BOOL)mustValidateBeforeExtraction
{
return YES;
}
- (instancetype)initWithFlatPackagePath:(NSString *)flatPackagePath extractionDirectory:(NSString *)extractionDirectory expectingInstallationType:(NSString *)installationType
{
self = [super init];
if (self != nil) {
_flatPackagePath = [flatPackagePath copy];
_expectedInstallationType = [installationType copy];
_extractionDirectory = [extractionDirectory copy];
}
return self;
}
- (void)unarchiveWithCompletionBlock:(void (^)(NSError * _Nullable))completionBlock progressBlock:(void (^ _Nullable)(double))progressBlock
{
SUUnarchiverNotifier *notifier = [[SUUnarchiverNotifier alloc] initWithCompletionBlock:completionBlock progressBlock:progressBlock];
// Flat packages must use guided package installs, not interactive
BOOL isDirectory = NO;
if (![_expectedInstallationType isEqualToString:SPUInstallationTypeGuidedPackage]) {
[notifier notifyFailureWithError:[NSError errorWithDomain:SUSparkleErrorDomain code:SUUnarchivingError userInfo:@{ NSLocalizedDescriptionKey:[NSString stringWithFormat:@"Flat package does not have guided installation type but %@ instead", _expectedInstallationType]}]];
} else if (![[NSFileManager defaultManager] fileExistsAtPath:_flatPackagePath isDirectory:&isDirectory] || isDirectory) {
[notifier notifyFailureWithError:[NSError errorWithDomain:SUSparkleErrorDomain code:SUUnarchivingError userInfo:@{ NSLocalizedDescriptionKey:[NSString stringWithFormat:@"Flat package does not exist at %@", _flatPackagePath]}]];
} else {
// Copying the flat package should be very fast, especially on APFS
NSError *copyError = nil;
if (![[NSFileManager defaultManager] copyItemAtPath:_flatPackagePath toPath:[_extractionDirectory stringByAppendingPathComponent:_flatPackagePath.lastPathComponent] error:&copyError]) {
NSMutableDictionary *userInfoDictionary = [NSMutableDictionary dictionaryWithDictionary:@{ NSLocalizedDescriptionKey:[NSString stringWithFormat:@"Flat package (%@) cannot be copied to extraction directory (%@)", _flatPackagePath, _extractionDirectory]}];
if (copyError != nil) {
userInfoDictionary[NSUnderlyingErrorKey] = copyError;
}
[notifier notifyFailureWithError:[NSError errorWithDomain:SUSparkleErrorDomain code:SUUnarchivingError userInfo:userInfoDictionary]];
} else {
[notifier notifyProgress:1.0];
[notifier notifySuccess];
}
}
}
- (NSString *)description { return [NSString stringWithFormat:@"%@ <%@>", [self class], _flatPackagePath]; }
@end
#endif
@@ -6,7 +6,7 @@
// Copyright 2010 Dragon Systems Software Limited. All rights reserved.
//
/*!
/**
# Sparkle Guided Installations
A guided installation allows Sparkle to download and install a package (pkg) or multi-package (mpkg) without user interaction.
@@ -14,20 +14,17 @@ A guided installation allows Sparkle to download and install a package (pkg) or
The installer package is installed using macOS's built-in command line installer, `/usr/sbin/installer`. No installation interface is shown to the user.
A guided installation can be started by applications other than the application being replaced. This is particularly useful where helper applications or agents are used.
## To Do
- Replace the use of `AuthorizationExecuteWithPrivilegesAndWait`. This method remains because it is well supported and tested. Ideally a helper tool or XPC would be used.
*/
#if SPARKLE_BUILD_PACKAGE_SUPPORT
#import <Foundation/Foundation.h>
#import "SUInstallerProtocol.h"
NS_ASSUME_NONNULL_BEGIN
SPU_OBJC_DIRECT_MEMBERS @interface SUGuidedPackageInstaller : NSObject <SUInstallerProtocol>
@interface SUGuidedPackageInstaller : NSObject <SUInstallerProtocol>
- (instancetype)initWithPackagePath:(NSString *)packagePath installationPath:(NSString *)installationPath fileOperationToolPath:(NSString *)fileOperationToolPath;
- (instancetype)initWithPackagePath:(NSString *)packagePath homeDirectory:(NSString *)homeDirectory userName:(NSString *)userName;
@end
NS_ASSUME_NONNULL_END
#endif
+92
View File
@@ -0,0 +1,92 @@
//
// SUGuidedPackageInstaller.m
// Sparkle
//
// Created by Graham Miln on 14/05/2010.
// Copyright 2010 Dragon Systems Software Limited. All rights reserved.
//
#if SPARKLE_BUILD_PACKAGE_SUPPORT
#import <sys/stat.h>
#import "SUGuidedPackageInstaller.h"
#import "SUErrors.h"
#include "AppKitPrevention.h"
@implementation SUGuidedPackageInstaller
{
NSString *_packagePath;
NSString *_homeDirectory;
NSString *_userName;
}
- (instancetype)initWithPackagePath:(NSString *)packagePath homeDirectory:(NSString *)homeDirectory userName:(NSString *)userName
{
self = [super init];
if (self != nil) {
_packagePath = [packagePath copy];
_homeDirectory = [homeDirectory copy];
_userName = [userName copy];
}
return self;
}
- (BOOL)performInitialInstallation:(NSError * __autoreleasing *)__unused error
{
return YES;
}
- (BOOL)performFinalInstallationProgressBlock:(nullable void(^)(double))__unused cb error:(NSError * __autoreleasing *)error
{
// This command *must* be run as root
NSString *installerPath = @"/usr/sbin/installer";
NSTask *task = [[NSTask alloc] init];
task.launchPath = installerPath;
task.arguments = @[@"-pkg", _packagePath, @"-target", @"/"];
// Set the $HOME and $USER variables so pre/post install scripts reference the correct user environment
task.environment = @{@"HOME": _homeDirectory, @"USER": _userName};
task.standardError = nil;
task.standardOutput = nil;
NSError *launchError = nil;
if (![task launchAndReturnError:&launchError]) {
if (error != NULL) {
NSMutableDictionary *userInfo = [NSMutableDictionary dictionaryWithDictionary:@{ NSLocalizedDescriptionKey: @"Guided package installer failed to launch" }];
if (launchError != nil) {
userInfo[NSUnderlyingErrorKey] = launchError;
}
*error = [NSError errorWithDomain:SUSparkleErrorDomain code:SUInstallationError userInfo:userInfo];
}
return NO;
}
[task waitUntilExit];
if (task.terminationStatus != EXIT_SUCCESS) {
if (error != NULL) {
*error = [NSError errorWithDomain:SUSparkleErrorDomain code:SUInstallationError userInfo:@{ NSLocalizedDescriptionKey: [NSString stringWithFormat:@"Guided package installer returned non-zero exit status (%d)", task.terminationStatus] }];
}
return NO;
}
return YES;
}
- (void)performCleanup
{
}
- (BOOL)canInstallSilently
{
return YES;
}
@end
#endif
+28
View File
@@ -0,0 +1,28 @@
//
// SUInstaller.h
// Sparkle
//
// Created by Andy Matuschak on 4/10/08.
// Copyright 2008 Andy Matuschak. All rights reserved.
//
#import <Foundation/Foundation.h>
#import "SUInstallerProtocol.h"
NS_ASSUME_NONNULL_BEGIN
@class SUHost;
SPU_OBJC_DIRECT_MEMBERS @interface SUInstaller : NSObject
+ (nullable id<SUInstallerProtocol>)installerForHost:(SUHost *)host expectedInstallationType:(NSString *)expectedInstallationType updateDirectory:(NSString *)updateDirectory homeDirectory:(NSString *)homeDirectory userName:(NSString *)userName error:(NSError **)error;
+ (nullable NSString *)installSourcePathInUpdateFolder:(NSString *)inUpdateFolder forHost:(SUHost *)host
#if SPARKLE_BUILD_PACKAGE_SUPPORT
isPackage:(BOOL *)isPackagePtr isGuided:(nullable BOOL *)isGuidedPtr
#endif
;
@end
NS_ASSUME_NONNULL_END
+224
View File
@@ -0,0 +1,224 @@
//
// SUInstaller.m
// Sparkle
//
// Created by Andy Matuschak on 4/10/08.
// Copyright 2008 Andy Matuschak. All rights reserved.
//
#import "SUInstaller.h"
#import "SUPlainInstaller.h"
#import "SUPackageInstaller.h"
#import "SUGuidedPackageInstaller.h"
#import "SUHost.h"
#import "SUConstants.h"
#import "SULog.h"
#import "SUErrors.h"
#import "SPUInstallationType.h"
#import "SUNormalization.h"
#include "AppKitPrevention.h"
@implementation SUInstaller
+ (nullable NSString *)installSourcePathInUpdateFolder:(NSString *)inUpdateFolder forHost:(SUHost *)host
#if SPARKLE_BUILD_PACKAGE_SUPPORT
isPackage:(BOOL *)isPackagePtr isGuided:(BOOL *)isGuidedPtr
#endif
{
NSParameterAssert(inUpdateFolder);
NSParameterAssert(host);
// Search subdirectories for the application
NSString *currentFile,
*newAppDownloadPath = nil,
*bundleFileName = [[host bundlePath] lastPathComponent],
*alternateBundleFileName = [[host name] stringByAppendingPathExtension:[[host bundlePath] pathExtension]];
#if SPARKLE_BUILD_PACKAGE_SUPPORT
NSString *fallbackPackagePath = nil;
BOOL isPackage = NO;
BOOL isGuided = YES;
#endif
NSDirectoryEnumerator *dirEnum = [[NSFileManager defaultManager] enumeratorAtPath:inUpdateFolder];
NSString *bundleFileNameNoExtension = [bundleFileName stringByDeletingPathExtension];
while ((currentFile = [dirEnum nextObject])) {
NSString *currentPath = [inUpdateFolder stringByAppendingPathComponent:currentFile];
// Ignore all symbolic links and aliases
{
NSURL *currentPathURL = [NSURL fileURLWithPath:currentPath];
NSNumber *symbolicLinkFlag = nil;
[currentPathURL getResourceValue:&symbolicLinkFlag forKey:NSURLIsSymbolicLinkKey error:NULL];
if (symbolicLinkFlag.boolValue) {
// NSDirectoryEnumerator won't recurse into symlinked directories
continue;
}
NSNumber *aliasFlag = nil;
[currentPathURL getResourceValue:&aliasFlag forKey:NSURLIsAliasFileKey error:NULL];
if (aliasFlag.boolValue) {
NSNumber *directoryFlag = nil;
[currentPathURL getResourceValue:&directoryFlag forKey:NSURLIsDirectoryKey error:NULL];
// Some DMGs have symlinks into /Applications! That's no good!
if (directoryFlag.boolValue) {
[dirEnum skipDescendents];
}
continue;
}
}
NSString *currentFilename = [currentFile lastPathComponent];
#if SPARKLE_BUILD_PACKAGE_SUPPORT
NSString *currentExtension = [currentFile pathExtension];
NSString *currentFilenameNoExtension = [currentFilename stringByDeletingPathExtension];
#endif
if ([currentFilename isEqualToString:bundleFileName] ||
[currentFilename isEqualToString:alternateBundleFileName]) // We found one!
{
#if SPARKLE_BUILD_PACKAGE_SUPPORT
isPackage = NO;
#endif
newAppDownloadPath = currentPath;
break;
#if SPARKLE_BUILD_PACKAGE_SUPPORT
} else if ([currentExtension isEqualToString:@"pkg"] ||
[currentExtension isEqualToString:@"mpkg"]) {
if ([currentFilenameNoExtension isEqualToString:bundleFileNameNoExtension]) {
isPackage = YES;
newAppDownloadPath = currentPath;
break;
} else {
// Remember any other non-matching packages we have seen should we need to use one of them as a fallback.
fallbackPackagePath = currentPath;
}
#endif
} else {
// Try matching on bundle identifiers in case the user has changed the name of the host app
NSBundle *incomingBundle = [NSBundle bundleWithPath:currentPath];
NSString *hostBundleIdentifier = host.bundle.bundleIdentifier;
if (incomingBundle && [incomingBundle.bundleIdentifier isEqualToString:hostBundleIdentifier]) {
#if SPARKLE_BUILD_PACKAGE_SUPPORT
isPackage = NO;
#endif
newAppDownloadPath = currentPath;
break;
}
}
}
#if SPARKLE_BUILD_PACKAGE_SUPPORT
// We don't have a valid path. Try to use the fallback package.
if (newAppDownloadPath == nil && fallbackPackagePath != nil) {
isPackage = YES;
newAppDownloadPath = fallbackPackagePath;
}
if (isPackage) {
// Guided (or now "normal") installs used to be opt-in (i.e, Sparkle would detect foo.sparkle_guided.pkg or foo.sparkle_guided.mpkg),
// but to get an interactive (or "unguided") install, the developer now must opt-out of guided installations.
// foo.app -> foo.sparkle_interactive.pkg or foo.sparkle_interactive.mpkg
if ([[[newAppDownloadPath stringByDeletingPathExtension] pathExtension] isEqualToString:@"sparkle_interactive"]) {
isGuided = NO;
}
}
if (isPackagePtr)
*isPackagePtr = isPackage;
if (isGuidedPtr)
*isGuidedPtr = isGuided;
#endif
if (!newAppDownloadPath) {
SULog(SULogLevelError, @"Searched %@ for %@.(app%@)", inUpdateFolder, bundleFileNameNoExtension,
#if SPARKLE_BUILD_PACKAGE_SUPPORT
@"|pkg"
#else
@""
#endif
);
}
return newAppDownloadPath;
}
+ (nullable id<SUInstallerProtocol>)installerForHost:(SUHost *)host expectedInstallationType:(NSString *)expectedInstallationType updateDirectory:(NSString *)updateDirectory homeDirectory:(NSString *)homeDirectory userName:(NSString *)userName error:(NSError * __autoreleasing *)error
{
#if SPARKLE_BUILD_PACKAGE_SUPPORT
BOOL isPackage = NO;
BOOL isGuided = NO;
#endif
NSString *newDownloadPath = [self installSourcePathInUpdateFolder:updateDirectory forHost:host
#if SPARKLE_BUILD_PACKAGE_SUPPORT
isPackage:&isPackage isGuided:&isGuided
#endif
];
if (newDownloadPath == nil) {
if (error != NULL) {
*error = [NSError errorWithDomain:SUSparkleErrorDomain code:SUMissingUpdateError userInfo:@{ NSLocalizedDescriptionKey: @"Couldn't find an appropriate update in the downloaded package." }];
}
return nil;
}
// Make sure we find the type of installer that we were expecting to find
// We shouldn't implicitly trust the installation type fed into here from the appcast because the installation type helps us determine
// ahead of time whether or not this installer tool should be ran as root or not
id <SUInstallerProtocol> installer = nil;
#if SPARKLE_BUILD_PACKAGE_SUPPORT
if (isPackage && isGuided) {
if (![expectedInstallationType isEqualToString:SPUInstallationTypeGuidedPackage]) {
if (error != NULL) {
*error = [NSError errorWithDomain:SUSparkleErrorDomain code:SUInstallationError userInfo:@{ NSLocalizedDescriptionKey: [NSString stringWithFormat:@"Found guided package installer but '%@=%@' was probably missing in the appcast item enclosure", SUAppcastAttributeInstallationType, SPUInstallationTypeGuidedPackage] }];
}
} else {
installer = [[SUGuidedPackageInstaller alloc] initWithPackagePath:newDownloadPath homeDirectory:homeDirectory userName:userName];
}
} else if (isPackage) {
if (![expectedInstallationType isEqualToString:SPUInstallationTypeInteractivePackage]) {
if (error != NULL) {
*error = [NSError errorWithDomain:SUSparkleErrorDomain code:SUInstallationError userInfo:@{ NSLocalizedDescriptionKey: [NSString stringWithFormat:@"Found package installer but '%@=%@' was probably missing in the appcast item enclosure", SUAppcastAttributeInstallationType, SPUInstallationTypeInteractivePackage] }];
}
} else {
installer = [[SUPackageInstaller alloc] initWithPackagePath:newDownloadPath];
}
} else
#endif
{
if (![expectedInstallationType isEqualToString:SPUInstallationTypeApplication]) {
if (error != NULL) {
*error = [NSError errorWithDomain:SUSparkleErrorDomain code:SUInstallationError userInfo:@{ NSLocalizedDescriptionKey: [NSString stringWithFormat:@"Found regular application update but expected '%@=%@' from the appcast item enclosure instead", SUAppcastAttributeInstallationType, expectedInstallationType] }];
}
} else {
NSString *normalizedInstallationPath = nil;
if (SPARKLE_NORMALIZE_INSTALLED_APPLICATION_NAME) {
normalizedInstallationPath = SUNormalizedInstallationPath(host);
}
// If we have a normalized path, we'll install to "#{CFBundleName}.app", but only if that path doesn't already exist. If we're "Foo 4.2.app," and there's a "Foo.app" in this directory, we don't want to overwrite it! But if there's no "Foo.app," we'll take that name.
// Otherwise if there's no normalized path (the more likely case), we'll just use the host bundle's path
// Check progress agent app which computes normalized path too according to these rules
NSString *installationPath;
if (normalizedInstallationPath != nil && ![[NSFileManager defaultManager] fileExistsAtPath:normalizedInstallationPath]) {
installationPath = normalizedInstallationPath;
} else {
installationPath = host.bundlePath;
}
installer = [[SUPlainInstaller alloc] initWithHost:host bundlePath:newDownloadPath installationPath:installationPath];
}
}
return installer;
}
@end
+38
View File
@@ -0,0 +1,38 @@
//
// SUInstallerProtocol.h
// Sparkle
//
// Created by Mayur Pawashe on 3/12/16.
// Copyright © 2016 Sparkle Project. All rights reserved.
//
#import <Foundation/Foundation.h>
NS_ASSUME_NONNULL_BEGIN
@protocol SUInstallerProtocol <NSObject>
// Any installation work can be done prior to user application being terminated and relaunched
// No UI should occur during this stage (i.e, do not show package installer apps, etc..)
// Should be able to be called from non-main thread
- (BOOL)performInitialInstallation:(NSError **)error;
// Any installation work after the user application has has been terminated. This is where the final installation work can be done.
// After this stage is done, the user application may be relaunched.
// Should be able to be called from non-main thread
- (BOOL)performFinalInstallationProgressBlock:(nullable void(^)(double))cb error:(NSError **)error;
// Any clean up work can be done here
// This is work that may be performed after the user application may have been updated / relaunched,
// or after an error occurred in the previous stages.
// Should be able to be called from any thread
- (void)performCleanup;
// Indicates whether or not this installer can install the update silently in the background, without hindering the user
// If this returns NO, then the installation can fail if the user did not directly request for the install to occur.
// Should be thread safe
- (BOOL)canInstallSilently;
@end
NS_ASSUME_NONNULL_END
+23
View File
@@ -0,0 +1,23 @@
//
// SUPackageInstaller.h
// Sparkle
//
// Created by Andy Matuschak on 4/10/08.
// Copyright 2008 Andy Matuschak. All rights reserved.
//
#if SPARKLE_BUILD_PACKAGE_SUPPORT
#import <Foundation/Foundation.h>
#import "SUInstallerProtocol.h"
// This is the deprecated package installation type, aka the "interactive" package installer
// For a more supported package installation, see SUGuidedPackageInstaller
SPU_OBJC_DIRECT_MEMBERS @interface SUPackageInstaller : NSObject <SUInstallerProtocol>
- (instancetype)initWithPackagePath:(NSString *)packagePath;
@end
#endif
@@ -6,6 +6,8 @@
// Copyright 2008 Andy Matuschak. All rights reserved.
//
#if SPARKLE_BUILD_PACKAGE_SUPPORT
#import "SUPackageInstaller.h"
#import "SUConstants.h"
#import "SUErrors.h"
@@ -14,26 +16,18 @@
#include "AppKitPrevention.h"
@interface SUPackageInstaller ()
@property (nonatomic, readonly, copy) NSString *packagePath;
@property (nonatomic, readonly, copy) NSString *installationPath;
@end
@implementation SUPackageInstaller
{
NSString *_packagePath;
}
static NSString *SUOpenUtilityPath = @"/usr/bin/open";
@synthesize packagePath = _packagePath;
@synthesize installationPath = _installationPath;
- (instancetype)initWithPackagePath:(NSString *)packagePath installationPath:(NSString *)installationPath
- (instancetype)initWithPackagePath:(NSString *)packagePath
{
self = [super init];
if (self != nil) {
_packagePath = [packagePath copy];
_installationPath = [installationPath copy];
}
return self;
}
@@ -55,7 +49,7 @@ static NSString *SUOpenUtilityPath = @"/usr/bin/open";
// -W = wait until the app has quit.
// -n = Open another instance if already open.
// -b = app bundle identifier
NSArray<NSString *> *args = @[@"-W", @"-n", @"-b", @"com.apple.installer", self.packagePath];
NSArray *args = @[@"-W", @"-n", @"-b", @"com.apple.installer", _packagePath];
// Known bug: if the installation fails or is canceled, Sparkle goes ahead and restarts, thinking everything is fine.
@try {
@@ -73,14 +67,15 @@ static NSString *SUOpenUtilityPath = @"/usr/bin/open";
return YES;
}
- (void)performCleanup
{
}
- (BOOL)canInstallSilently
{
return NO;
}
- (BOOL)supportsDeterminateProgress
{
return NO;
}
@end
#endif
@@ -14,9 +14,11 @@
NS_ASSUME_NONNULL_BEGIN
@interface SUPipedUnarchiver : NSObject <SUUnarchiverProtocol>
SPU_OBJC_DIRECT_MEMBERS @interface SUPipedUnarchiver : NSObject <SUUnarchiverProtocol>
- (instancetype)initWithArchivePath:(NSString *)archivePath;
- (instancetype)initWithArchivePath:(NSString *)archivePath extractionDirectory:(NSString *)extractionDirectory;
+ (BOOL)canUnarchivePath:(NSString *)path;
@end
+242
View File
@@ -0,0 +1,242 @@
//
// SUPipedUnarchiver.m
// Sparkle
//
// Created by Andy Matuschak on 6/16/08.
// Copyright 2008 Andy Matuschak. All rights reserved.
//
#import "SUPipedUnarchiver.h"
#import "SUUnarchiverNotifier.h"
#import "SULog.h"
#import "SUErrors.h"
#include "AppKitPrevention.h"
@implementation SUPipedUnarchiver
{
NSString *_archivePath;
NSString *_extractionDirectory;
}
static NSArray <NSString *> * _Nullable _commandAndArgumentsConformingToTypeOfPath(NSString *path)
{
NSArray <NSString *> *extractTGZ = @[@"/usr/bin/tar", @"-zxC"];
NSArray <NSString *> *extractTBZ = @[@"/usr/bin/tar", @"-jxC"];
NSArray <NSString *> *extractTXZ = extractTGZ;
// Note: keep this list in sync with generate_appcast's unarchiveUpdates()
NSDictionary <NSString *, NSArray<NSString *> *> *extractCommandDictionary =
@{
@".zip" : @[@"/usr/bin/ditto", @"-x",@"-k",@"-"],
@".tar" : @[@"/usr/bin/tar", @"-xC"],
@".tar.gz" : extractTGZ,
@".tgz" : extractTGZ,
@".tar.bz2" : extractTBZ,
@".tbz" : extractTBZ,
@".tar.xz" : extractTXZ,
@".txz" : extractTXZ,
@".tar.lzma" : extractTXZ
};
NSString *lastPathComponent = [path lastPathComponent];
for (NSString *currentType in extractCommandDictionary)
{
if ([lastPathComponent hasSuffix:currentType]) {
return [extractCommandDictionary objectForKey:currentType];
}
}
return nil;
}
+ (BOOL)canUnarchivePath:(NSString *)path
{
return _commandAndArgumentsConformingToTypeOfPath(path) != nil;
}
+ (BOOL)mustValidateBeforeExtraction
{
return NO;
}
- (instancetype)initWithArchivePath:(NSString *)archivePath extractionDirectory:(NSString *)extractionDirectory
{
self = [super init];
if (self != nil) {
_archivePath = [archivePath copy];
_extractionDirectory = [extractionDirectory copy];
}
return self;
}
- (void)unarchiveWithCompletionBlock:(void (^)(NSError * _Nullable))completionBlock progressBlock:(void (^ _Nullable)(double))progressBlock
{
NSArray <NSString *> *commandAndArguments = _commandAndArgumentsConformingToTypeOfPath(_archivePath);
assert(commandAndArguments != nil);
NSString *command = commandAndArguments.firstObject;
assert(command != nil);
NSArray <NSString *> *arguments = [commandAndArguments subarrayWithRange:NSMakeRange(1, commandAndArguments.count - 1)];
dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{
SUUnarchiverNotifier *notifier = [[SUUnarchiverNotifier alloc] initWithCompletionBlock:completionBlock progressBlock:progressBlock];
[self extractArchivePipingDataToCommand:command arguments:arguments notifier:notifier];
});
}
// This method abstracts the types that use a command line tool piping data from stdin.
- (void)extractArchivePipingDataToCommand:(NSString *)command arguments:(NSArray*)args notifier:(SUUnarchiverNotifier *)notifier SPU_OBJC_DIRECT
{
// *** GETS CALLED ON NON-MAIN THREAD!!!
@autoreleasepool {
NSString *destination = _extractionDirectory;
SULog(SULogLevelDefault, @"Extracting using '%@' '%@' < '%@' '%@'", command, [args componentsJoinedByString:@"' '"], _archivePath, destination);
// Get the file size.
NSDictionary *attributes = [[NSFileManager defaultManager] attributesOfItemAtPath:_archivePath error:nil];
NSUInteger expectedLength = [(NSNumber *)[attributes objectForKey:NSFileSize] unsignedIntegerValue];
if (expectedLength == 0) {
NSError *error = [NSError errorWithDomain:SUSparkleErrorDomain code:SUUnarchivingError userInfo:@{ NSLocalizedDescriptionKey:[NSString stringWithFormat:@"Extraction failed, archive '%@' is empty", _archivePath]}];
[notifier notifyFailureWithError:error];
return;
}
NSFileHandle *archiveInput = [NSFileHandle fileHandleForReadingAtPath:_archivePath];
NSPipe *pipe = [NSPipe pipe];
NSTask *task = [[NSTask alloc] init];
[task setStandardInput:pipe];
[task setStandardError:[NSFileHandle fileHandleWithStandardError]];
[task setStandardOutput:[NSFileHandle fileHandleWithStandardOutput]];
[task setLaunchPath:command];
[task setArguments:[args arrayByAddingObject:destination]];
NSError *launchError = nil;
if (![task launchAndReturnError:&launchError]) {
[notifier notifyFailureWithError:launchError];
return;
}
NSFileHandle *archiveOutput = [pipe fileHandleForWriting];
NSUInteger bytesWritten = 0;
#if MAC_OS_X_VERSION_MIN_REQUIRED < MAC_OS_X_VERSION_10_15
BOOL hasIOErrorMethods;
if (@available(macOS 10.15, *)) {
hasIOErrorMethods = YES;
} else {
hasIOErrorMethods = NO;
}
#endif
do {
NSData *data;
#if MAC_OS_X_VERSION_MIN_REQUIRED < MAC_OS_X_VERSION_10_15
if (!hasIOErrorMethods) {
@try {
data = [archiveInput readDataOfLength:256*1024];
} @catch (NSException *exception) {
SULog(SULogLevelError, @"Failed to read data from archive with exception reason %@", exception.reason);
data = nil;
}
}
else
#endif
{
NSError *readError = nil;
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wpartial-availability"
data = [archiveInput readDataUpToLength:256*1024 error:&readError];
#pragma clang diagnostic pop
if (data == nil) {
SULog(SULogLevelError, @"Failed to read data from archive with error %@", readError);
}
}
NSUInteger len = [data length];
if (len == 0) {
break;
}
NSError *writeError = nil;
#if MAC_OS_X_VERSION_MIN_REQUIRED < MAC_OS_X_VERSION_10_15
if (!hasIOErrorMethods) {
@try {
[archiveOutput writeData:data];
} @catch (NSException *exception) {
SULog(SULogLevelError, @"Failed to write data to pipe with exception reason %@", exception.reason);
break;
}
}
else
#endif
{
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wpartial-availability"
if (![archiveOutput writeData:data error:&writeError]) {
#pragma clang diagnostic pop
SULog(SULogLevelError, @"Failed to write data to pipe with error %@", writeError);
break;
}
}
bytesWritten += len;
[notifier notifyProgress:(double)bytesWritten / (double)expectedLength];
}
while(bytesWritten < expectedLength);
if (@available(macOS 10.15, *)) {
NSError *archiveOutputCloseError = nil;
if (![archiveOutput closeAndReturnError:&archiveOutputCloseError]) {
SULog(SULogLevelError, @"Failed to close pipe with error %@", archiveOutputCloseError);
}
}
#if MAC_OS_X_VERSION_MIN_REQUIRED < MAC_OS_X_VERSION_10_15
else
{
[archiveOutput closeFile];
}
#endif
if (@available(macOS 10.15, *)) {
NSError *archiveInputCloseError = nil;
if (![archiveInput closeAndReturnError:&archiveInputCloseError]) {
SULog(SULogLevelError, @"Failed to close archive input with error %@", archiveInputCloseError);
}
}
#if MAC_OS_X_VERSION_MIN_REQUIRED < MAC_OS_X_VERSION_10_15
else
{
[archiveInput closeFile];
}
#endif
[task waitUntilExit];
if ([task terminationStatus] != 0) {
NSError *error = [NSError errorWithDomain:SUSparkleErrorDomain code:SUUnarchivingError userInfo:@{ NSLocalizedDescriptionKey:[NSString stringWithFormat:@"Extraction failed, command '%@' returned %d", command, [task terminationStatus]]}];
[notifier notifyFailureWithError:error];
return;
}
if (bytesWritten != expectedLength) {
NSError *error = [NSError errorWithDomain:SUSparkleErrorDomain code:SUUnarchivingError userInfo:@{ NSLocalizedDescriptionKey:[NSString stringWithFormat:@"Extraction failed, command '%@' got only %ld of %ld bytes", command, (long)bytesWritten, (long)expectedLength]}];
[notifier notifyFailureWithError:error];
return;
}
[notifier notifySuccess];
}
}
- (NSString *)description { return [NSString stringWithFormat:@"%@ <%@>", [self class], _archivePath]; }
@end
@@ -9,20 +9,16 @@
#import <Foundation/Foundation.h>
#import "SUInstallerProtocol.h"
NS_ASSUME_NONNULL_BEGIN
@class SUHost;
@protocol SUVersionComparison;
@interface SUPlainInstaller : NSObject <SUInstallerProtocol>
SPU_OBJC_DIRECT_MEMBERS @interface SUPlainInstaller : NSObject <SUInstallerProtocol>
/*!
/**
@param host The current (old) bundle host
@param bundlePath The path to the new bundle that will be installed.
@param installationPath The path the new bundlePath will be installed to.
@param fileOperationToolPath The path to the file operation tool for authorized operations.
*/
- (instancetype)initWithHost:(SUHost *)host bundlePath:(NSString *)bundlePath installationPath:(NSString *)installationPath fileOperationToolPath:(NSString *)fileOperationToolPath;
- (instancetype)initWithHost:(SUHost *)host bundlePath:(NSString *)bundlePath installationPath:(NSString *)installationPath;
@end
NS_ASSUME_NONNULL_END
+404
View File
@@ -0,0 +1,404 @@
//
// SUPlainInstaller.m
// Sparkle
//
// Created by Andy Matuschak on 4/10/08.
// Copyright 2008 Andy Matuschak. All rights reserved.
//
#import "SUPlainInstaller.h"
#import "SUFileManager.h"
#import "SUConstants.h"
#import "SUHost.h"
#import "SULog.h"
#import "SUErrors.h"
#import "SUVersionComparisonProtocol.h"
#import "SUStandardVersionComparator.h"
#import "SUCodeSigningVerifier.h"
#include "AppKitPrevention.h"
@implementation SUPlainInstaller
{
SUHost *_host;
NSString *_bundlePath;
NSString *_installationPath;
NSURL *_temporaryOldDirectory;
// We get an obj-c warning if we use 'newTemporaryDirectory' name about new + ownership stuff, so use 'temporaryNewDirectory' instead
NSURL *_temporaryNewDirectory;
BOOL _newAndOldBundlesOnSameVolume;
BOOL _canPerformSafeAtomicSwap;
}
- (instancetype)initWithHost:(SUHost *)host bundlePath:(NSString *)bundlePath installationPath:(NSString *)installationPath
{
self = [super init];
if (self != nil) {
_host = host;
_bundlePath = [bundlePath copy];
_installationPath = [installationPath copy];
}
return self;
}
- (void)_performInitialInstallationWithFileManager:(SUFileManager *)fileManager oldBundleURL:(NSURL *)oldBundleURL newBundleURL:(NSURL *)newBundleURL performGatekeeperScan:(BOOL)performGatekeeperScan progressBlock:(nullable void(^)(double))progress SPU_OBJC_DIRECT
{
// Release our new app from quarantine
NSError *quarantineError = nil;
if (![fileManager releaseItemFromQuarantineAtRootURL:newBundleURL error:&quarantineError]) {
// Not big enough of a deal to fail the entire installation
SULog(SULogLevelError, @"Failed to release quarantine at %@ with error %@", newBundleURL.path, quarantineError);
}
if (progress) {
progress(5/11.0);
}
// Try to preserve Finder Tags
NSArray *resourceTags = nil;
BOOL retrievedResourceTags = [oldBundleURL getResourceValue:&resourceTags forKey:NSURLTagNamesKey error:NULL];
if (retrievedResourceTags && resourceTags.count > 0) {
[newBundleURL setResourceValue:resourceTags forKey:NSURLTagNamesKey error:NULL];
}
if (progress) {
progress(6/11.0);
}
// Update owner and group (if possible)
NSError *changeOwnerAndGroupError = nil;
if (![fileManager changeOwnerAndGroupOfItemAtRootURL:newBundleURL toMatchURL:oldBundleURL error:&changeOwnerAndGroupError]) {
// Not a fatal error
SULog(SULogLevelError, @"Failed to change owner and group of new app at %@ to match old app at %@", newBundleURL.path, oldBundleURL.path);
SULog(SULogLevelError, @"Error: %@", changeOwnerAndGroupError);
}
if (progress) {
progress(7/11.0);
}
// Register the new bundle with LaunchServices and the system
NSError *touchError = nil;
if (![fileManager updateModificationAndAccessTimeOfItemAtURL:newBundleURL error:&touchError]) {
// Not a fatal error, but a pretty unfortunate one
SULog(SULogLevelError, @"Failed to update modification and access time of new app at %@", newBundleURL.path);
SULog(SULogLevelError, @"Error: %@", touchError);
}
if (progress) {
progress(8/11.0);
}
if (performGatekeeperScan) {
// Perform a Gatekeeper scan to pre-warm the app launch
// This avoids users seeing a "Verifying..." dialog when the installed update is launched
// Note the tool we use to perform the Gatekeeper scan (gktool) is technically available on macOS 14.0,
// however there are some potential bugs/issues with performing a Gatekeeper scan on versions before 14.4:
// https://github.com/sparkle-project/Sparkle/issues/2491
if (@available(macOS 14.4, *)) {
// Only perform Gatekeeper scan if we're updating an app bundle
NSString *newBundlePath = newBundleURL.path;
if ([newBundlePath.pathExtension caseInsensitiveCompare:@"app"] == NSOrderedSame) {
NSURL *gktoolURL = [NSURL fileURLWithPath:@"/usr/bin/gktool" isDirectory:NO];
if ([gktoolURL checkResourceIsReachableAndReturnError:NULL]) {
NSTask *gatekeeperScanTask = [[NSTask alloc] init];
gatekeeperScanTask.executableURL = gktoolURL;
gatekeeperScanTask.arguments = @[@"scan", newBundlePath];
NSError *taskError;
if (![gatekeeperScanTask launchAndReturnError:&taskError]) {
// Not a fatal error
SULog(SULogLevelError, @"Failed to perform GateKeeper scan on '%@' with error %@", newBundlePath, taskError);
} else {
[gatekeeperScanTask waitUntilExit];
if (gatekeeperScanTask.terminationStatus != 0) {
SULog(SULogLevelError, @"gktool failed and returned exit status %d", gatekeeperScanTask.terminationStatus);
}
}
}
}
}
}
}
- (BOOL)startInstallationToURL:(NSURL *)installationURL fromUpdateAtURL:(NSURL *)newURL withHost:(SUHost *)host progressBlock:(nullable void(^)(double))progress error:(NSError * __autoreleasing *)error SPU_OBJC_DIRECT
{
if (installationURL == nil || newURL == nil) {
// this really shouldn't happen but just in case
SULog(SULogLevelError, @"Failed to perform installation because either installation URL (%@) or new URL (%@) is nil", installationURL, newURL);
if (error != NULL) {
*error = [NSError errorWithDomain:SUSparkleErrorDomain code:SUInstallationError userInfo:@{ NSLocalizedDescriptionKey: @"Failed to perform installation because the paths to install at and from are not valid" }];
}
return NO;
}
if (progress) {
progress(1/11.0);
}
SUFileManager *fileManager = [[SUFileManager alloc] init];
// Update the access time of our entire application before moving it into a temporary directory
// The system periodically cleans up files by looking at the mod & access times, so we have to make sure they're up to date
// They could be potentially be preserved when archiving an application, but also an update could just be sitting on the system for a long time
// before being installed
if (!_newAndOldBundlesOnSameVolume) {
NSError *accessTimeError = nil;
if (![fileManager updateAccessTimeOfItemAtRootURL:newURL error:&accessTimeError]) {
if (error != NULL) {
NSMutableDictionary *userInfo = [NSMutableDictionary dictionaryWithDictionary:@{ NSLocalizedDescriptionKey: @"Failed to recursively update new application's modification time before moving into temporary directory" }];
if (accessTimeError != nil) {
userInfo[NSUnderlyingErrorKey] = accessTimeError;
}
*error = [NSError errorWithDomain:SUSparkleErrorDomain code:SUInstallationError userInfo:userInfo];
}
return NO;
}
}
NSURL *oldURL = [NSURL fileURLWithPath:host.bundlePath];
if (oldURL == nil) {
// this really shouldn't happen but just in case
SULog(SULogLevelError, @"Failed to construct URL from bundle path: %@", host.bundlePath);
if (error != NULL) {
*error = [NSError errorWithDomain:SUSparkleErrorDomain code:SUInstallationError userInfo:@{ NSLocalizedDescriptionKey: @"Failed to perform installation because a path could not be constructed for the old installation" }];
}
return NO;
}
if (progress) {
progress(2/11.0);
}
NSURL *tempNewDirectoryURL;
if (!_newAndOldBundlesOnSameVolume) {
// Create a temporary directory for our new app that resides on our destination's volume
// We use oldURL here instead of installationURL because in the case of normalization, installationURL may not exist
// And we don't want to use either of the URL's parent directories because the parent directory could be on a different volume
tempNewDirectoryURL = [fileManager makeTemporaryDirectoryAppropriateForDirectoryURL:oldURL error:error];
if (tempNewDirectoryURL == nil) {
return NO;
}
_temporaryNewDirectory = tempNewDirectoryURL;
} else {
tempNewDirectoryURL = nil;
}
if (progress) {
progress(3/11.0);
}
// Move the new app to our temporary directory if needed
NSURL *newFinalURL;
if (!_newAndOldBundlesOnSameVolume) {
NSString *newURLLastPathComponent = newURL.lastPathComponent;
newFinalURL = [tempNewDirectoryURL URLByAppendingPathComponent:newURLLastPathComponent];
NSError *newTempMoveError = nil;
if (![fileManager moveItemAtURL:newURL toURL:newFinalURL error:&newTempMoveError]) {
if (error != NULL) {
NSMutableDictionary *userInfo = [NSMutableDictionary dictionaryWithDictionary:@{ NSLocalizedDescriptionKey: [NSString stringWithFormat:@"Failed to move the new app from %@ to its temp directory at %@", newURL.path, newFinalURL.path] }];
if (newTempMoveError != nil) {
userInfo[NSUnderlyingErrorKey] = newTempMoveError;
}
*error = [NSError errorWithDomain:SUSparkleErrorDomain code:SUInstallationError userInfo:userInfo];
}
return NO;
}
} else {
newFinalURL = newURL;
}
if (progress) {
progress(4/11.0);
}
if (!_newAndOldBundlesOnSameVolume) {
// If we're updating a bundle on another volume, the install process can be pretty slow.
// In this case let's get out of the way and skip the Gatekeeper scan
[self _performInitialInstallationWithFileManager:fileManager oldBundleURL:oldURL newBundleURL:newFinalURL performGatekeeperScan:NO progressBlock:progress];
}
if (progress) {
progress(9/11.0);
}
// First try swapping the application atomically
NSError *swapError = nil;
BOOL swappedApp;
// If we can not safely perform an atomic swap, or if the app is normalized and the installation path differs, go through the old swap path
if (!_canPerformSafeAtomicSwap || (SPARKLE_NORMALIZE_INSTALLED_APPLICATION_NAME && ![oldURL.path isEqual:installationURL.path])) {
swappedApp = NO;
} else {
// We will be cleaning up the temporary directory later in -performCleanup:
// We don't want to clean it up now because it can take some time
swappedApp = [fileManager swapItemAtURL:installationURL withItemAtURL:newFinalURL error:&swapError];
}
if (!swappedApp) {
// Otherwise swap out the old and new applications using the legacy path
if (swapError != nil) {
SULog(SULogLevelDefault, @"Invoking fallback from failing to replace original item with error: %@", swapError);
}
// Create a temporary directory for our old app that resides on its volume
NSURL *tempOldDirectoryURL = [fileManager makeTemporaryDirectoryAppropriateForDirectoryURL:oldURL error:error];
if (tempOldDirectoryURL == nil) {
return NO;
}
_temporaryOldDirectory = tempOldDirectoryURL;
if (progress) {
progress(10/11.0);
}
NSString *oldURLFilename = oldURL.lastPathComponent;
if (oldURLFilename == nil) {
// this really shouldn't happen..
SULog(SULogLevelError, @"Failed to retrieve last path component from old URL: %@", oldURL.path);
if (error != NULL) {
*error = [NSError errorWithDomain:SUSparkleErrorDomain code:SUInstallationError userInfo:@{ NSLocalizedDescriptionKey: @"Failed to perform installation because the last path component of the old installation URL could not be constructed." }];
}
return NO;
}
// Move the old app to the temporary directory
NSURL *oldTempURL = [tempOldDirectoryURL URLByAppendingPathComponent:oldURLFilename];
NSError *oldMoveError = nil;
if (![fileManager moveItemAtURL:oldURL toURL:oldTempURL error:&oldMoveError]) {
if (error != NULL) {
NSMutableDictionary *userInfo = [NSMutableDictionary dictionaryWithDictionary:@{ NSLocalizedDescriptionKey: [NSString stringWithFormat:@"Failed to move the old app at %@ to a temporary location at %@", oldURL.path, oldTempURL.path] }];
if (oldMoveError != nil) {
userInfo[NSUnderlyingErrorKey] = oldMoveError;
}
*error = [NSError errorWithDomain:SUSparkleErrorDomain code:SUInstallationError userInfo:userInfo];
}
return NO;
}
if (progress) {
progress(10.5/11.0);
}
// Move the new app to its final destination
NSError *installMoveError = nil;
if (![fileManager moveItemAtURL:newFinalURL toURL:installationURL error:&installMoveError]) {
if (error != NULL) {
NSMutableDictionary *userInfo = [NSMutableDictionary dictionaryWithDictionary:@{ NSLocalizedDescriptionKey: [NSString stringWithFormat:@"Failed to move new app at %@ to final destination %@", newFinalURL.path, installationURL.path] }];
if (installMoveError != nil) {
userInfo[NSUnderlyingErrorKey] = installMoveError;
}
*error = [NSError errorWithDomain:SUSparkleErrorDomain code:SUInstallationError userInfo:userInfo];
}
// Attempt to restore our old app back the way it was on failure
[fileManager moveItemAtURL:oldTempURL toURL:oldURL error:NULL];
return NO;
}
}
if (progress) {
progress(11/11.0);
}
return YES;
}
- (BOOL)performInitialInstallation:(NSError * __autoreleasing *)error
{
// Prevent malicious downgrades
// Note that we may not be able to do this for package installations, hence this code being done here
NSString *hostVersion = [_host version];
NSBundle *bundle = [NSBundle bundleWithPath:_bundlePath];
SUHost *updateHost = [[SUHost alloc] initWithBundle:bundle];
NSString *updateVersion = [updateHost objectForInfoDictionaryKey:(__bridge NSString *)kCFBundleVersionKey];
id<SUVersionComparison> comparator = [[SUStandardVersionComparator alloc] init];
if (!updateVersion || [comparator compareVersion:hostVersion toVersion:updateVersion] == NSOrderedDescending) {
if (error != NULL) {
NSString *errorMessage = [NSString stringWithFormat:@"For security reasons, updates that downgrade version of the application are not allowed. Refusing to downgrade app from version %@ to %@. Aborting update.", hostVersion, updateVersion];
*error = [NSError errorWithDomain:SUSparkleErrorDomain code:SUDowngradeError userInfo:@{ NSLocalizedDescriptionKey: errorMessage }];
}
return NO;
}
SUFileManager *fileManager = [[SUFileManager alloc] init];
if (@available(macOS 13.0, *)) {
NSURL *mainExecutableURL = NSBundle.mainBundle.executableURL;
if (mainExecutableURL == nil) {
// This shouldn't happen
_canPerformSafeAtomicSwap = NO;
} else {
NSString *installerTeamIdentifier = [SUCodeSigningVerifier teamIdentifierAtURL:mainExecutableURL];
NSString *bundleTeamIdentifier = [SUCodeSigningVerifier teamIdentifierAtURL:bundle.bundleURL];
// If the new update is code signed and Autoupdate is not signed with the same Team ID as the new update,
// then we may run into Privacy & Security prompt issues from the OS
// To avoid these, we skip the gatekeeper scan and skip performing an atomic swap during install
_canPerformSafeAtomicSwap = (bundleTeamIdentifier == nil || (installerTeamIdentifier != nil && [installerTeamIdentifier isEqualToString:bundleTeamIdentifier]));
}
} else {
_canPerformSafeAtomicSwap = YES;
}
if (!_canPerformSafeAtomicSwap) {
SULog(SULogLevelDefault, @"Skipping atomic rename/swap and gatekeeper scan because Autoupdate is not signed with same identity as the new update %@", bundle.bundleURL.lastPathComponent);
}
_newAndOldBundlesOnSameVolume = [fileManager itemAtURL:bundle.bundleURL isOnSameVolumeItemAsURL:_host.bundle.bundleURL];
// We can do a lot of the installation work ahead of time if the new app update does not need to be copied to another volume
if (_newAndOldBundlesOnSameVolume) {
[self _performInitialInstallationWithFileManager:fileManager oldBundleURL:_host.bundle.bundleURL newBundleURL:bundle.bundleURL performGatekeeperScan:_canPerformSafeAtomicSwap progressBlock:NULL];
}
return YES;
}
- (BOOL)performFinalInstallationProgressBlock:(nullable void(^)(double))cb error:(NSError *__autoreleasing*)error
{
// Note: we must do most installation work in the third stage due to relying on our application sitting in temporary directories.
// It must not be possible for our update to sit in temporary directories for a very long time.
return [self startInstallationToURL:[NSURL fileURLWithPath:_installationPath] fromUpdateAtURL:[NSURL fileURLWithPath:_bundlePath] withHost:_host progressBlock:cb error:error];
}
- (void)performCleanup
{
SUFileManager *fileManager = [[SUFileManager alloc] init];
if (_temporaryNewDirectory != nil) {
[fileManager removeItemAtURL:_temporaryNewDirectory error:NULL];
}
if (_temporaryOldDirectory != nil) {
[fileManager removeItemAtURL:_temporaryOldDirectory error:NULL];
}
}
- (BOOL)canInstallSilently
{
return YES;
}
@end
@@ -1,5 +1,5 @@
//
// SUDSAVerifier.h
// SUSignatureVerifier.h
// Sparkle
//
// Created by Andy Matuschak on 3/16/06.
@@ -18,15 +18,22 @@
#import <Foundation/Foundation.h>
@class SUSignatures;
@class SUPublicKeys;
@class SPUVerifierInformation;
@interface SUSignatureVerifier : NSObject
NS_ASSUME_NONNULL_BEGIN
+ (BOOL)validatePath:(NSString *)path withSignatures:(SUSignatures *)signatures withPublicKeys:(SUPublicKeys *)pkeys;
SPU_OBJC_DIRECT_MEMBERS @interface SUSignatureVerifier : NSObject
+ (BOOL)validatePath:(NSString *)path withSignatures:(SUSignatures *)signatures withPublicKeys:(SUPublicKeys *)pkeys verifierInformation:(SPUVerifierInformation * _Nullable)verifierInformation error:(NSError * __autoreleasing *)error;
- (instancetype)init NS_UNAVAILABLE;
- (instancetype)initWithPublicKeys:(SUPublicKeys *)pkeys;
- (BOOL)verifyFileAtPath:(NSString *)path signatures:(SUSignatures *)signatures;
- (BOOL)verifyFileAtPath:(NSString *)path signatures:(SUSignatures *)signatures verifierInformation:(SPUVerifierInformation * _Nullable)verifierInformation error:(NSError * __autoreleasing *)error;
@end
NS_ASSUME_NONNULL_END
#endif
+416
View File
@@ -0,0 +1,416 @@
//
// SUDSAVerifier.m
// Sparkle
//
// Created by Andy Matuschak on 3/16/06.
// Copyright 2006 Andy Matuschak. All rights reserved.
//
// Includes code by Zach Waldowski on 10/18/13.
// Copyright 2014 Big Nerd Ranch. Licensed under MIT.
//
// Includes code from Plop by Mark Hamlin.
// Copyright 2011 Mark Hamlin. Licensed under BSD.
//
#import "SUSignatureVerifier.h"
#import "SULog.h"
#import "SUSignatures.h"
#import "SUErrors.h"
#import "SPUVerifierInformation.h"
#import "SUConstants.h"
#if SPARKLE_BUILD_LEGACY_DSA_SUPPORT
#include <CommonCrypto/CommonDigest.h>
#endif
#import "ed25519.h"
#include "AppKitPrevention.h"
@implementation SUSignatureVerifier
{
SUPublicKeys *_pubKeys;
}
+ (BOOL)validatePath:(NSString *)path withSignatures:(SUSignatures *)signatures withPublicKeys:(SUPublicKeys *)pkeys verifierInformation:(SPUVerifierInformation * _Nullable)verifierInformation error:(NSError * __autoreleasing *)error
{
SUSignatureVerifier *verifier = [(SUSignatureVerifier *)[self alloc] initWithPublicKeys:pkeys];
if (verifier == nil) {
if (error != NULL) {
*error = [NSError errorWithDomain:SUSparkleErrorDomain code:SUValidationError userInfo:@{ NSLocalizedDescriptionKey: @"Failed to create SUSignatureVerifier instance" }];
}
return NO;
}
return [verifier verifyFileAtPath:path signatures:signatures verifierInformation:verifierInformation error:error];
}
- (instancetype)initWithPublicKeys:(SUPublicKeys *)pubkeys
{
self = [super init];
if (self != nil) {
_pubKeys = pubkeys;
}
return self;
}
#if SPARKLE_BUILD_LEGACY_DSA_SUPPORT
- (SecKeyRef)dsaSecKeyRef SPU_OBJC_DIRECT
{
NSData *data = [_pubKeys.dsaPubKey dataUsingEncoding:NSASCIIStringEncoding];
if (!self || !data.length) {
SULog(SULogLevelError, @"Could not read public DSA key");
return nil;
}
SecExternalFormat format = kSecFormatOpenSSL;
SecExternalItemType itemType = kSecItemTypePublicKey;
CFArrayRef items = NULL;
OSStatus status = SecItemImport((__bridge CFDataRef)data, NULL, &format, &itemType, (SecItemImportExportFlags)0, NULL, NULL, &items);
if (status != errSecSuccess || !items) {
if (items) {
CFRelease(items);
}
SULog(SULogLevelError, @"Public DSA key could not be imported: %d", status);
return nil;
}
SecKeyRef dsaPubKeySecKey = nil;
if (format == kSecFormatOpenSSL && itemType == kSecItemTypePublicKey && CFArrayGetCount(items) == 1) {
// Seems silly, but we can't quiet the warning about dropping CFTypeRef's const qualifier through
// any manner of casting I've tried, including interim explicit cast to void*. The -Wcast-qual
// warning is on by default with -Weverything and apparently became more noisy as of Xcode 7.
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wcast-qual"
dsaPubKeySecKey = (SecKeyRef)CFRetain(CFArrayGetValueAtIndex(items, 0));
#pragma clang diagnostic pop
}
CFRelease(items);
return dsaPubKeySecKey;
}
#endif
- (BOOL)verifyFileAtPath:(NSString *)path signatures:(SUSignatures *)signatures verifierInformation:(SPUVerifierInformation * _Nullable)verifierInformation error:(NSError * __autoreleasing *)error
{
if (!path || !path.length) {
if (error != NULL) {
*error = [NSError errorWithDomain:SUSparkleErrorDomain code:SUValidationError userInfo:@{ NSLocalizedDescriptionKey: @"Path passed to verify has zero length and is not valid" }];
}
return NO;
}
if (!signatures) {
if (error != NULL) {
*error = [NSError errorWithDomain:SUSparkleErrorDomain code:SUValidationError userInfo:@{ NSLocalizedDescriptionKey: @"No signatures given to verifyFileAtPath" }];
}
return NO;
}
switch (_pubKeys.ed25519PubKeyStatus) {
case SUSigningInputStatusAbsent:
if (signatures.ed25519SignatureStatus != SUSigningInputStatusAbsent) {
SULog(SULogLevelDefault, @"The update has an EdDSA signature, but it won't be used, because the old app doesn't have an EdDSA public key");
}
break;
case SUSigningInputStatusInvalid:
if (signatures.ed25519SignatureStatus != SUSigningInputStatusAbsent) {
NSString *message = @"The update has an EdDSA signature, but the app has an invalid EdDSA public key, so the update will automatically be rejected.";
SULog(SULogLevelError, @"%@", message);
if (error != NULL) {
*error = [NSError errorWithDomain:SUSparkleErrorDomain code:SUValidationError userInfo:@{ NSLocalizedDescriptionKey: message }];
}
return NO;
}
SULog(SULogLevelDefault, @"The app has an invalid EdDSA public key, but there is no EdDSA signature in the update. Falling back to DSA.");
break;
case SUSigningInputStatusPresent:
switch (signatures.ed25519SignatureStatus) {
case SUSigningInputStatusAbsent: {
NSString *message = @"The app has an EdDSA public key, but there is no EdDSA signature in the update, so the update will be rejected.";
SULog(SULogLevelError, @"%@", message);
if (error != NULL) {
*error = [NSError errorWithDomain:SUSparkleErrorDomain code:SUValidationError userInfo:@{ NSLocalizedDescriptionKey: message }];
}
return NO;
}
case SUSigningInputStatusInvalid: {
NSString *message = @"The update has an EdDSA signature, but it's invalid, so the update will automatically be rejected.";
SULog(SULogLevelError, @"%@", message);
if (error != NULL) {
*error = [NSError errorWithDomain:SUSparkleErrorDomain code:SUValidationError userInfo:@{ NSLocalizedDescriptionKey: message }];
}
return NO;
}
case SUSigningInputStatusPresent: {
NSError *dataError = nil;
NSData *data = [NSData dataWithContentsOfFile:path options:NSDataReadingMappedAlways error:&dataError];
if (!data || !data.length) {
SULog(SULogLevelError, @"Failed to load file %@: %@", path, dataError);
if (error != NULL) {
NSMutableDictionary *userInfo = [NSMutableDictionary dictionary];
userInfo[NSLocalizedDescriptionKey] = [NSString stringWithFormat:@"Failed to load file: %@", path];
if (dataError != nil) {
userInfo[NSUnderlyingErrorKey] = dataError;
}
*error = [NSError errorWithDomain:SUSparkleErrorDomain code:SUValidationError userInfo:[userInfo copy]];
}
return NO;
}
if (ed25519_verify(signatures.ed25519Signature, data.bytes, data.length, _pubKeys.ed25519PubKey)) {
SULog(SULogLevelDefault, @"OK: EdDSA signature is correct");
#if SPARKLE_BUILD_LEGACY_DSA_SUPPORT
// No need to check DSA when EdDSA verification succeeded, unless a DSA signature is provided and it's
// erroneously invalid
if (signatures.dsaSignatureStatus != SUSigningInputStatusInvalid)
#endif
{
return YES;
}
} else {
NSMutableString *message = [NSMutableString stringWithString:@"EdDSA signature does not match. Data of the update file being checked is different than data that has been signed, or the public key and the private key are not from the same set."];
// Elaborate on the error message if we have more information about the download archive
if (verifierInformation != nil) {
BOOL reportedDiscrepancy = NO;
if (verifierInformation.expectedContentLength > 0 && verifierInformation.actualContentLength > 0) {
if (verifierInformation.expectedContentLength != verifierInformation.actualContentLength) {
[message appendFormat:@" The downloaded update (%@) is likely different than the signed archive because the expected content length from the appcast item (%llu bytes) differs from the downloaded archive length (%llu bytes).", path.lastPathComponent, verifierInformation.expectedContentLength, verifierInformation.actualContentLength];
reportedDiscrepancy = YES;
}
}
NSString *actualVersion = verifierInformation.actualVersion;
if (actualVersion != nil && ![verifierInformation.expectedVersion isEqualToString:actualVersion]) {
[message appendFormat:@" The downloaded update (%@) also has a CFBundleVersion (%@) which differs from the %@ in the appcast item (%@).", path.lastPathComponent, actualVersion, SUAppcastAttributeVersion, verifierInformation.expectedVersion];
reportedDiscrepancy = YES;
}
if (!reportedDiscrepancy && verifierInformation.expectedContentLength > 0) {
[message appendFormat:@" The downloaded update (%@) is likely not signed correctly because the archive has the expected content length (%llu bytes)%@ which matches the appcast item.", path.lastPathComponent, verifierInformation.actualContentLength, (actualVersion == nil ? @"" : [NSString stringWithFormat:@" and CFBundleVersion (%@)", actualVersion])];
}
}
SULog(SULogLevelError, @"%@", [message copy]);
#if SPARKLE_BUILD_LEGACY_DSA_SUPPORT
if (signatures.dsaSignatureStatus != SUSigningInputStatusAbsent) {
SULog(SULogLevelDefault, @"DSA signature won't be checked, because EdDSA verification has already failed");
}
#endif
if (error != NULL) {
*error = [NSError errorWithDomain:SUSparkleErrorDomain code:SUValidationError userInfo:@{ NSLocalizedDescriptionKey: message }];
}
return NO;
}
}
}
break;
}
#if SPARKLE_BUILD_LEGACY_DSA_SUPPORT
switch (_pubKeys.dsaPubKeyStatus) {
case SUSigningInputStatusAbsent:
if (signatures.dsaSignatureStatus != SUSigningInputStatusAbsent) {
SULog(SULogLevelDefault, @"The update has a DSA signature, but it can't be used, because the old app doesn't have a DSA public key");
}
break;
case SUSigningInputStatusInvalid:
if (signatures.dsaSignatureStatus != SUSigningInputStatusAbsent) {
// We will have already logged an error for this failure when the public key was read in, so just do an informational log here.
NSString *message = @"The update has a DSA signature, but the app has an invalid DSA public key, so the update will automatically be rejected.";
SULog(SULogLevelError, @"%@", message);
if (error != NULL) {
*error = [NSError errorWithDomain:SUSparkleErrorDomain code:SUValidationError userInfo:@{ NSLocalizedDescriptionKey: message }];
}
return NO;
}
SULog(SULogLevelDefault, @"The app has an invalid DSA public key, but there is no DSA signature in the update.");
break;
case SUSigningInputStatusPresent:
switch (signatures.dsaSignatureStatus) {
case SUSigningInputStatusAbsent:
SULog(SULogLevelError, @"There is no DSA signature in the update");
break;
case SUSigningInputStatusInvalid: {
NSString *message = @"The update has a DSA signature, but it's invalid, so the update will automatically be rejected.";
SULog(SULogLevelError, @"%@", message);
if (error != NULL) {
*error = [NSError errorWithDomain:SUSparkleErrorDomain code:SUValidationError userInfo:@{ NSLocalizedDescriptionKey: message }];
}
return NO;
}
case SUSigningInputStatusPresent: {
NSInputStream *dataInputStream = [NSInputStream inputStreamWithFileAtPath:path];
return [self verifyDSASignatureOfStream:dataInputStream dsaSignature:signatures.dsaSignature error:error];
}
}
}
#else
switch (_pubKeys.dsaPubKeyStatus) {
case SUSigningInputStatusAbsent:
break;
case SUSigningInputStatusInvalid:
// We don't keep track of DSA signatures, so we will ignore this mistake and treat it as if it were absent
break;
case SUSigningInputStatusPresent:
if (error != NULL) {
*error = [NSError errorWithDomain:SUSparkleErrorDomain code:SUValidationError userInfo:@{ NSLocalizedDescriptionKey: @"The old app has a DSA public key but DSA support is disabled, and the old app does not have an EdDSA public key." }];
}
return NO;
}
#endif
if (error != NULL) {
// Use generic failure
*error = [NSError errorWithDomain:SUSparkleErrorDomain code:SUValidationError userInfo:@{ NSLocalizedDescriptionKey: @"EdDSA and DSA verification for the update has failed" }];
}
return NO;
}
#if SPARKLE_BUILD_LEGACY_DSA_SUPPORT
- (BOOL)verifyDSASignatureOfStream:(NSInputStream *)stream dsaSignature:(NSData *)dsaSignature error:(NSError * __autoreleasing *)outError SPU_OBJC_DIRECT
{
if (!stream || !dsaSignature) {
SULog(SULogLevelError, @"Invalid arguments to verifyStream");
if (outError != NULL) {
*outError = [NSError errorWithDomain:SUSparkleErrorDomain code:SUValidationError userInfo:@{ NSLocalizedDescriptionKey: @"Invalid arguments to verifyStream" }];
}
return NO;
}
SecKeyRef dsaPubKeySecKey = [self dsaSecKeyRef];
if (!dsaPubKeySecKey) {
if (outError != NULL) {
*outError = [NSError errorWithDomain:SUSparkleErrorDomain code:SUValidationError userInfo:@{ NSLocalizedDescriptionKey: @"Failed to create DSA Sec Key Ref" }];
}
return NO;
}
// Sparkle's DSA support is deprecated
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wdeprecated-declarations"
__block SecGroupTransformRef group = SecTransformCreateGroupTransform();
__block SecTransformRef dataReadTransform = NULL;
__block SecTransformRef dataDigestTransform = NULL;
__block SecTransformRef dataVerifyTransform = NULL;
__block CFErrorRef error = NULL;
BOOL (^cleanup)(void) = ^{
if (group) CFRelease(group);
if (dataReadTransform) CFRelease(dataReadTransform);
if (dataDigestTransform) CFRelease(dataDigestTransform);
if (dataVerifyTransform) CFRelease(dataVerifyTransform);
if (error) CFRelease(error);
if (dsaPubKeySecKey) CFRelease(dsaPubKeySecKey);
return NO;
};
dataReadTransform = SecTransformCreateReadTransformWithReadStream((__bridge CFReadStreamRef)stream);
if (!dataReadTransform) {
if (outError != NULL) {
*outError = [NSError errorWithDomain:SUSparkleErrorDomain code:SUValidationError userInfo:@{ NSLocalizedDescriptionKey: @"File containing update archive could not be read (failed to create SecTransform for input stream)" }];
}
return cleanup();
}
dataDigestTransform = SecDigestTransformCreate(kSecDigestSHA1, CC_SHA1_DIGEST_LENGTH, NULL);
if (!dataDigestTransform) {
if (outError != NULL) {
*outError = [NSError errorWithDomain:SUSparkleErrorDomain code:SUValidationError userInfo:@{ NSLocalizedDescriptionKey: @"File containing update archive could not be read (failed to create SecDigest for input stream)" }];
}
return cleanup();
}
dataVerifyTransform = SecVerifyTransformCreate(dsaPubKeySecKey, (__bridge CFDataRef)dsaSignature, &error);
if (!dataVerifyTransform) {
SULog(SULogLevelError, @"Could not understand format of the signature: %@; Signature data: %@", error, dsaSignature);
if (outError != NULL) {
NSError *underlyingError = (__bridge NSError *)error;
NSMutableDictionary *userInfo = [NSMutableDictionary dictionary];
userInfo[NSLocalizedDescriptionKey] = [NSString stringWithFormat:@"Could not understand format of the signature data %@", dsaSignature];
if (underlyingError != NULL) {
userInfo[NSUnderlyingErrorKey] = underlyingError;
}
*outError = [NSError errorWithDomain:SUSparkleErrorDomain code:SUValidationError userInfo:[userInfo copy]];
}
return cleanup();
}
#pragma clang diagnostic pop
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wdeprecated-declarations"
SecTransformConnectTransforms(dataReadTransform, kSecTransformOutputAttributeName, dataDigestTransform, kSecTransformInputAttributeName, group, &error);
#pragma clang diagnostic pop
if (error) {
if (outError != NULL) {
*outError = [NSError errorWithDomain:SUSparkleErrorDomain code:SUValidationError userInfo:@{NSLocalizedDescriptionKey : @"Failed to connect data read transform", NSUnderlyingErrorKey: (__bridge NSError *)error}];
}
return cleanup();
}
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wdeprecated-declarations"
SecTransformConnectTransforms(dataDigestTransform, kSecTransformOutputAttributeName, dataVerifyTransform, kSecTransformInputAttributeName, group, &error);
#pragma clang diagnostic pop
if (error) {
if (outError != NULL) {
*outError = [NSError errorWithDomain:SUSparkleErrorDomain code:SUValidationError userInfo:@{NSLocalizedDescriptionKey : @"Failed to connect data digest transform", NSUnderlyingErrorKey: (__bridge NSError *)error}];
}
return cleanup();
}
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wdeprecated-declarations"
NSNumber *result = CFBridgingRelease(SecTransformExecute(group, &error));
#pragma clang diagnostic pop
if (error) {
SULog(SULogLevelError, @"DSA signature verification failed: %@", error);
if (outError != NULL) {
*outError = [NSError errorWithDomain:SUSparkleErrorDomain code:SUValidationError userInfo:@{ NSLocalizedDescriptionKey: @"DSA signature verification failed", NSUnderlyingErrorKey: (__bridge NSError *)error}];
}
return cleanup();
}
if (!result.boolValue) {
if (outError != NULL) {
*outError = [NSError errorWithDomain:SUSparkleErrorDomain code:SUValidationError userInfo:@{ NSLocalizedDescriptionKey: @"DSA signature does not match. Data of the update file being checked is different than data that has been signed, or the public key and the private key are not from the same set"}];
}
}
cleanup();
return result.boolValue;
}
#endif
@end
+21
View File
@@ -0,0 +1,21 @@
//
// SUStatusInfoProtocol.h
// Sparkle
//
// Created by Mayur Pawashe on 7/10/16.
// Copyright © 2016 Sparkle Project. All rights reserved.
//
#import <Foundation/Foundation.h>
NS_ASSUME_NONNULL_BEGIN
@protocol SUStatusInfoProtocol
- (void)probeStatusInfoWithReply:(void (^)(NSData * _Nullable installationInfoData))reply;
- (void)probeStatusConnectivityWithReply:(void (^)(void))reply;
@end
NS_ASSUME_NONNULL_END
@@ -12,9 +12,9 @@ NS_ASSUME_NONNULL_BEGIN
@protocol SUUnarchiverProtocol;
@interface SUUnarchiver : NSObject
SPU_OBJC_DIRECT_MEMBERS @interface SUUnarchiver : NSObject
+ (nullable id <SUUnarchiverProtocol>)unarchiverForPath:(NSString *)path updatingHostBundlePath:(nullable NSString *)hostPath decryptionPassword:(nullable NSString *)decryptionPassword;
+ (nullable id <SUUnarchiverProtocol>)unarchiverForPath:(NSString *)path extractionDirectory:(NSString *)extractionDirectory updatingHostBundlePath:(nullable NSString *)hostPath decryptionPassword:(nullable NSString *)decryptionPassword expectingInstallationType:(NSString *)installationType;
@end
+45
View File
@@ -0,0 +1,45 @@
//
// SUUnarchiver.m
// Sparkle
//
// Created by Andy Matuschak on 3/16/06.
// Copyright 2006 Andy Matuschak. All rights reserved.
//
#import "SUUnarchiver.h"
#import "SUUnarchiverProtocol.h"
#import "SUPipedUnarchiver.h"
#import "SUDiskImageUnarchiver.h"
#import "SUBinaryDeltaUnarchiver.h"
#import "SUFlatPackageUnarchiver.h"
#include "AppKitPrevention.h"
@implementation SUUnarchiver
+ (nullable id <SUUnarchiverProtocol>)unarchiverForPath:(NSString *)path extractionDirectory:(NSString *)extractionDirectory updatingHostBundlePath:(nullable NSString *)hostPath decryptionPassword:(nullable NSString *)decryptionPassword expectingInstallationType:(NSString *)installationType
{
if ([SUPipedUnarchiver canUnarchivePath:path]) {
return [[SUPipedUnarchiver alloc] initWithArchivePath:path extractionDirectory:extractionDirectory];
}
#if SPARKLE_BUILD_DMG_SUPPORT
else if ([SUDiskImageUnarchiver canUnarchivePath:path]) {
return [[SUDiskImageUnarchiver alloc] initWithArchivePath:path extractionDirectory:extractionDirectory decryptionPassword:decryptionPassword];
}
#endif
else if ([SUBinaryDeltaUnarchiver canUnarchivePath:path]) {
assert(hostPath != nil);
NSString *nonNullHostPath = hostPath;
return [[SUBinaryDeltaUnarchiver alloc] initWithArchivePath:path extractionDirectory:extractionDirectory updateHostBundlePath:nonNullHostPath];
}
#if SPARKLE_BUILD_PACKAGE_SUPPORT
else if ([SUFlatPackageUnarchiver canUnarchivePath:path]) {
// Flat packages are only supported for guided packaage installs
return [[SUFlatPackageUnarchiver alloc] initWithFlatPackagePath:path extractionDirectory:extractionDirectory expectingInstallationType:installationType];
}
#endif
return nil;
}
@end
@@ -10,7 +10,7 @@
NS_ASSUME_NONNULL_BEGIN
@interface SUUnarchiverNotifier : NSObject
SPU_OBJC_DIRECT_MEMBERS @interface SUUnarchiverNotifier : NSObject
- (instancetype)initWithCompletionBlock:(void (^)(NSError * _Nullable))completionBlock progressBlock:(void (^ _Nullable)(double))progressBlock;
@@ -13,17 +13,11 @@
#include "AppKitPrevention.h"
@interface SUUnarchiverNotifier ()
@property (nonatomic, readonly, copy) void (^completionBlock)(NSError * _Nullable);
@property (nonatomic, readonly, copy) void (^ _Nullable progressBlock)(double);
@end
@implementation SUUnarchiverNotifier
@synthesize completionBlock = _completionBlock;
@synthesize progressBlock = _progressBlock;
{
void (^_completionBlock)(NSError * _Nullable);
void (^ _Nullable _progressBlock)(double);
}
- (instancetype)initWithCompletionBlock:(void (^)(NSError * _Nullable))completionBlock progressBlock:(void (^ _Nullable)(double))progressBlock
{
@@ -31,6 +25,8 @@
if (self != nil) {
_completionBlock = [completionBlock copy];
_progressBlock = [progressBlock copy];
} else {
assert(false);
}
return self;
}
@@ -38,13 +34,13 @@
- (void)notifySuccess
{
dispatch_async(dispatch_get_main_queue(), ^{
self.completionBlock(nil);
self->_completionBlock(nil);
});
}
- (void)notifyFailureWithError:(NSError * _Nullable)reason
{
NSMutableDictionary *userInfo = [NSMutableDictionary dictionaryWithObject:SULocalizedString(@"An error occurred while extracting the archive. Please try again later.", nil) forKey:NSLocalizedDescriptionKey];
NSMutableDictionary *userInfo = [NSMutableDictionary dictionaryWithObject:@"An error occurred while extracting the archive. Please try again later." forKey:NSLocalizedDescriptionKey];
if (reason) {
[userInfo setObject:(NSError * _Nonnull)reason forKey:NSUnderlyingErrorKey];
}
@@ -52,15 +48,15 @@
NSError *error = [NSError errorWithDomain:SUSparkleErrorDomain code:SUUnarchivingError userInfo:userInfo];
dispatch_async(dispatch_get_main_queue(), ^{
self.completionBlock(error);
self->_completionBlock(error);
});
}
- (void)notifyProgress:(double)progress
{
if (self.progressBlock != nil) {
if (_progressBlock != nil) {
dispatch_async(dispatch_get_main_queue(), ^{
self.progressBlock(progress);
self->_progressBlock(progress);
});
}
}
@@ -12,8 +12,6 @@ NS_ASSUME_NONNULL_BEGIN
@protocol SUUnarchiverProtocol <NSObject>
+ (BOOL)canUnarchivePath:(NSString *)path;
+ (BOOL)mustValidateBeforeExtraction;
- (void)unarchiveWithCompletionBlock:(void (^)(NSError * _Nullable))completionBlock progressBlock:(void (^ _Nullable)(double))progressBlock;
+26
View File
@@ -0,0 +1,26 @@
//
// StatusInfo.h
// Sparkle
//
// Created by Mayur Pawashe on 7/10/16.
// Copyright © 2016 Sparkle Project. All rights reserved.
//
#import <Foundation/Foundation.h>
#import "SUStatusInfoProtocol.h"
NS_ASSUME_NONNULL_BEGIN
SPU_OBJC_DIRECT_MEMBERS @interface StatusInfo : NSObject <SUStatusInfoProtocol>
- (instancetype)initWithHostBundleIdentifier:(NSString *)bundleIdentifier;
@property (nonatomic, nullable) NSData *installationInfoData;
- (void)startListener;
- (void)invalidate;
@end
NS_ASSUME_NONNULL_END
+105
View File
@@ -0,0 +1,105 @@
//
// StatusInfo.m
// Sparkle
//
// Created by Mayur Pawashe on 7/10/16.
// Copyright © 2016 Sparkle Project. All rights reserved.
//
#import "StatusInfo.h"
#import "SPUMessageTypes.h"
#include "AppKitPrevention.h"
#define REPLY_STATUS_INFO_TIMEOUT 2
@interface StatusInfo () <NSXPCListenerDelegate>
@end
@implementation StatusInfo
{
NSXPCListener *_xpcListener;
NSMutableDictionary *_pendingReplies;
NSUInteger _pendingReplyCounter;
}
@synthesize installationInfoData = _installationInfoData;
- (instancetype)initWithHostBundleIdentifier:(NSString *)bundleIdentifier
{
self = [super init];
if (self != nil) {
_xpcListener = [[NSXPCListener alloc] initWithMachServiceName:SPUStatusInfoServiceNameForBundleIdentifier(bundleIdentifier)];
_xpcListener.delegate = self;
_pendingReplies = [NSMutableDictionary dictionary];
}
return self;
}
- (void)startListener
{
[_xpcListener resume];
}
- (void)invalidate
{
[_xpcListener invalidate];
_xpcListener = nil;
}
- (BOOL)listener:(NSXPCListener *)__unused listener shouldAcceptNewConnection:(NSXPCConnection *)newConnection
{
newConnection.exportedInterface = [NSXPCInterface interfaceWithProtocol:@protocol(SUStatusInfoProtocol)];
newConnection.exportedObject = self;
[newConnection resume];
return YES;
}
- (void)setInstallationInfoData:(NSData *)installationInfoData
{
_installationInfoData = installationInfoData;
// Respond to all of our pending replies
for (NSNumber *replyKey in _pendingReplies) {
void (^replyBlock)(NSData * _Nullable) = self->_pendingReplies[replyKey];
replyBlock(_installationInfoData);
}
[_pendingReplies removeAllObjects];
}
- (void)probeStatusInfoWithReply:(void (^)(NSData * _Nullable))reply
{
dispatch_async(dispatch_get_main_queue(), ^{
if (self->_installationInfoData != nil) {
reply(self->_installationInfoData);
} else {
// If we don't have the installation info data currently, we may receive it in a very short window afterwards
// In this case wait a bit for the reply. If we receive the data it will be in -setInstallationInfoData:
NSUInteger currentReplyCounter = self->_pendingReplyCounter;
self->_pendingReplyCounter++;
NSNumber *currentReplyCounterKey = @(currentReplyCounter);
self->_pendingReplies[currentReplyCounterKey] = [reply copy];
dispatch_after(dispatch_time(DISPATCH_TIME_NOW, (int64_t)(REPLY_STATUS_INFO_TIMEOUT * NSEC_PER_SEC)), dispatch_get_main_queue(), ^{
void (^replyBlock)(NSData * _Nullable) = self->_pendingReplies[currentReplyCounterKey];
if (replyBlock != nil) {
replyBlock(self->_installationInfoData);
[self->_pendingReplies removeObjectForKey:currentReplyCounterKey];
}
});
}
});
}
- (void)probeStatusConnectivityWithReply:(void (^)(void))reply
{
reply();
}
@end
+43
View File
@@ -0,0 +1,43 @@
#import <Foundation/Foundation.h>
#import "AppInstaller.h"
#include "AppKitPrevention.h"
int main(int __unused argc, const char __unused *argv[])
{
@autoreleasepool
{
NSArray<NSString *> *args = [[NSProcessInfo processInfo] arguments];
if (args.count != 4) {
return EXIT_FAILURE;
}
NSString *hostBundleIdentifier = args[1];
NSString *homeDirectory = args[2];
NSString *userName = args[3];
AppInstaller *appInstaller = [[AppInstaller alloc] initWithHostBundleIdentifier:hostBundleIdentifier homeDirectory:homeDirectory userName:userName];
[appInstaller start];
// Ignore SIGTERM because we are going to catch it ourselves
signal(SIGTERM, SIG_IGN);
// Ignore SIGPIPE because we won't want read or write failures due to broken pipe to unexpectably
// terminate the process (e.g, when extracting archives or performing package installs).
signal(SIGPIPE, SIG_IGN);
dispatch_source_t sigtermSource = dispatch_source_create(DISPATCH_SOURCE_TYPE_SIGNAL, SIGTERM, 0, dispatch_get_main_queue());
dispatch_source_set_event_handler(sigtermSource, ^{
// Don't clear the update directory because the installer may be in middle of installing an update
// We still need to set an event handler for receiving SIGTERM though, otherwise our job may not terminate
// (This is also recommended from the developer documentation).
// Simply exit with SIGTERM if we receive this signal
exit(SIGTERM);
});
dispatch_resume(sigtermSource);
[[NSRunLoop currentRunLoop] run];
}
return EXIT_SUCCESS;
}
+8
View File
@@ -0,0 +1,8 @@
//
// Use this file to import your target's public headers that you would like to expose to Swift.
//
#import "SUBinaryDeltaApply.h"
#import "SUBinaryDeltaCreate.h"
#import "SPUDeltaArchive.h"
#import "SPUDeltaArchiveProtocol.h"
+228
View File
@@ -0,0 +1,228 @@
//
// main.swift
// BinaryDelta
//
// Created by Mayur Pawashe on 1/3/22.
// Copyright © 2022 Sparkle Project. All rights reserved.
//
import Foundation
import ArgumentParser
// Create a patch from an old and new bundle
struct Create: ParsableCommand {
@Option(name: .long, help: ArgumentHelp("The major version of the patch to generate. Defaults to the latest stable version. Older versions will need to be specified for updating from applications using older versions of Sparkle.", valueName: "version"))
var version: Int = Int(SUBinaryDeltaMajorVersionDefault.rawValue)
@Flag(name: .customLong("verbose"), help: ArgumentHelp("Enable logging of the changes being archived into the generated patch."))
var verbose: Bool = false
@Option(name: .long, help: ArgumentHelp(COMPRESSION_METHOD_ARGUMENT_DESCRIPTION, valueName: "compression"))
var compression: String = "default"
@Option(name: .long, help: .hidden)
var compressionLevel: UInt8 = 0
@Argument(help: ArgumentHelp("Path to original bundle to create a patch from."))
var beforeTree: String
@Argument(help: ArgumentHelp("Path to new bundle to create a patch from."))
var afterTree: String
@Argument(help: ArgumentHelp("Path to new patch file to create."))
var patchFile: String
func validate() throws {
var validCompression: ObjCBool = false
let compressionMode = deltaCompressionModeFromDescription(compression, &validCompression)
guard validCompression.boolValue else {
fputs("Error: unrecognized compression \(compression)\n", stderr)
throw ExitCode(1)
}
switch compressionMode {
case SPUDeltaCompressionModeDefault:
fallthrough
case .none:
guard compressionLevel == 0 else {
fputs("Error: compression level must be 0 for compression \(compression)\n", stderr)
throw ExitCode(1)
}
break
case .bzip2:
guard compressionLevel >= 0 && compressionLevel <= 9 else {
fputs("Error: compression level \(compressionLevel) is not valid.\n", stderr)
throw ExitCode(1)
}
break
case .LZMA:
fallthrough
case .LZFSE:
fallthrough
case .LZ4:
fallthrough
case .ZLIB:
guard version >= 3 else {
fputs("Error: version \(version) patch files do not support compression \(compression)\n", stderr)
throw ExitCode(1)
}
guard compressionLevel == 0 else {
fputs("Error: compression level provided must be 0 for compression \(compression)\n", stderr)
throw ExitCode(1)
}
break
@unknown default:
fputs("Error: unrecognized compression \(compression)\n", stderr)
throw ExitCode(1)
}
guard version >= SUBinaryDeltaMajorVersionFirst.rawValue else {
fputs("Error: version provided \(version) is not valid.\n", stderr)
throw ExitCode(1)
}
guard version >= SUBinaryDeltaMajorVersionFirstSupported.rawValue else {
fputs("Error: creating version \(version) patches is no longer supported.\n", stderr)
throw ExitCode(1)
}
guard version <= SUBinaryDeltaMajorVersionLatest.rawValue else {
fputs("Error: this program is too old to create a version \(version) patch, or the version number provided is invalid.\n", stderr)
throw ExitCode(1)
}
let fileManager = FileManager.default
var isDirectory: ObjCBool = false
if !fileManager.fileExists(atPath: beforeTree, isDirectory: &isDirectory) || !isDirectory.boolValue {
fputs("Error: before-tree must be a directory\n", stderr)
throw ExitCode(1)
}
if !fileManager.fileExists(atPath: afterTree, isDirectory: &isDirectory) || !isDirectory.boolValue {
fputs("Error: after-tree must be a directory\n", stderr)
throw ExitCode(1)
}
}
func run() throws {
let compressionMode = deltaCompressionModeFromDescription(compression, nil)
guard let majorDeltaVersion = SUBinaryDeltaMajorVersion(rawValue: UInt16(version)) else {
// We shouldn't reach here
fputs("Error: failed to retrieve major version from provided version: \(version)\n", stderr)
throw ExitCode(1)
}
var createDiffError: NSError? = nil
if !createBinaryDelta(beforeTree, afterTree, patchFile, majorDeltaVersion, compressionMode, compressionLevel, verbose, &createDiffError) {
if let error = createDiffError {
fputs("\(error.localizedDescription)\n", stderr)
} else {
fputs("Error: Failed to create patch due to unknown reason.\n", stderr)
}
throw ExitCode(1)
}
}
}
// Apply a patch from an old bundle to generate a new bundle
struct Apply: ParsableCommand {
static let configuration = CommandConfiguration(abstract: "Apply a patch against an original bundle to generate a new bundle.")
@Flag(name: .customLong("verbose"), help: ArgumentHelp("Enable logging of changes being applied from the patch."))
var verbose: Bool = false
@Argument(help: ArgumentHelp("Path to original bundle to patch."))
var beforeTree: String
@Argument(help: ArgumentHelp("Path to new bundle to create."))
var afterTree: String
@Argument(help: ArgumentHelp("Path to patch file to apply."))
var patchFile: String
func validate() throws {
let fileManager = FileManager.default
var isDirectory: ObjCBool = false
if !fileManager.fileExists(atPath: beforeTree, isDirectory: &isDirectory) || !isDirectory.boolValue {
fputs("Error: before-tree must be a directory\n", stderr)
throw ExitCode(1)
}
if !fileManager.fileExists(atPath: patchFile, isDirectory: &isDirectory) || isDirectory.boolValue {
fputs("Error: patch-file must be a file\n", stderr)
throw ExitCode(1)
}
}
func run() throws {
var applyDiffError: NSError?
if (!applyBinaryDelta(beforeTree, afterTree, patchFile, verbose, { _ in }, &applyDiffError)) {
if let error = applyDiffError {
fputs("\(error.localizedDescription)\n", stderr)
} else {
fputs("Error: patch failed to apply for unknown reason\n", stderr)
}
throw ExitCode(1)
}
}
}
// Output information for BinaryDelta or from a patch file
struct Info: ParsableCommand {
@Argument(help: ArgumentHelp("Path to patch file to extract information from."))
var patchFile : String?
func run() throws {
if let patchFile = patchFile {
// Print version of patch file
var header: SPUDeltaArchiveHeader? = nil
let archive = SPUDeltaArchiveReadPatchAndHeader(patchFile, &header)
if let error = archive.error {
fputs("Error: Unable to open patch \(patchFile): \(error.localizedDescription)\n", stderr)
throw ExitCode(1)
}
if let header = header {
if header.majorVersion < SUBinaryDeltaMajorVersionFirst.rawValue {
fputs("Error: major version \(header.majorVersion) is invalid.\n", stderr)
throw ExitCode(1)
}
fputs("Patch version \(header.majorVersion).\(header.minorVersion)", stdout)
// Print out compression info only if it's available
// We can't get compression info from version 2 files
if header.compression != SPUDeltaCompressionModeDefault, let compressionDescription = deltaCompressionStringFromMode(header.compression) {
fputs(" using \(compressionDescription) compression", stdout)
// Compression level isn't available or applicable for all formats
if header.compressionLevel != 0 {
fputs(" with level \(header.compressionLevel)", stdout)
}
}
fputs("\n", stdout)
} else {
fputs("Error: Failed to retrieve header due to unknown reason.\n", stderr)
throw ExitCode(1)
}
} else {
// Print version of program
fputs("BinaryDelta version \(SUBinaryDeltaMajorVersionLatest.rawValue).\(latestMinorVersionForMajorVersion(SUBinaryDeltaMajorVersionLatest))\n", stdout)
}
}
}
struct BinaryDelta: ParsableCommand {
static let configuration = CommandConfiguration(commandName: "BinaryDelta", abstract: "Create and apply small and efficient delta patches between an old and new version of a bundle.", subcommands: [Create.self, Apply.self, Info.self])
}
DispatchQueue.global().async(execute: {
BinaryDelta.main()
CFRunLoopStop(CFRunLoopGetMain())
})
CFRunLoopRun()
+279 -2
View File
@@ -1,3 +1,280 @@
# 2.6.1
* Extract archives in a separate directory from the input archive (#2550) (Zorg)
* Fix the release notes WebKit view not updating background when transitioning from light to dark mode (#2542) (Zorg)
* Add NN (Norwegian Nynorsk) locale (#2532) (Sjur N Moshagen, Zorg)
* Create tar.xz files with built-in tar and remove bzip2 fallback for creating a release distribution (#2535) (Zorg)
* Add fallback in case SULocalizedStringFromTableInBundle() fails (#2533) (Zorg)
* Remove assert on download response being available fixing rare crash (#2547) (Zorg)
* Clarify when authoriation prompt may show in SPUUserDriver documentation (#2531, #2534) (Zorg)
* Fix typos in codebase (#2537) (Viktor Szépe)
# 2.6.0
* Perform Gatekeeper scan to pre-warm app launch (#2505) (Zorg)
* Disable sandboxing for the Downloader XPC service by default to fix downloader prompt warnings (#2511) (Zorg)
* Store private seed as the secret for newly generated keys (#2472) (Zorg)
* Improve signing error message to developers if they serve the wrong update file (#2471) (Zorg)
* Prevent app modification warnings from external updaters (like sparkli-cli) by improving installation (#2516) (Zorg)
* Update Korean localization (#2504) (CheolHyun Mun)
* Use $PROJECT_DIR instead of $SRCROOT (#2489) (Zorg)
* Set Package.swift minimum deployment to macOS 10.13 (#2481) (Eitot)
* Fix false positive analyzer warning about resumableUpdate type (#2454) (Zorg)
# 2.5.2
* Don't clean up update directory when Autoupdate receives SIGTERM (#2479) (Zorg)
* Update Japanese localization (#2475) (1024jp)
* Improve Turkish translations (#2464) (Emir SARI)
* Update Spanish translation for 'You are currently running version %@.' and 'Version History' (#2463) (Billy Gray)
# 2.5.1
* Default to English for XML nodes when no xml:lang is present (#2440) (Zorg)
* Filter for archive files in generate_appcast more intelligently (#2448) (Zorg)
* Use correct entitlements and dsym files when using custom bundle id and XPC names in ConfigCommon (#2446) (floorish)
# 2.5.0
* Add ability to adapt release notes based on the currently installed version (#2373) (Nathan Manceaux-Panot)
* Allow developers to use custom URL schemes in the release notes view (#2393) (Zorg)
* Adopt cooperative app activation APIs in macOS 14 Sonoma (#2409) (Zorg)
* Improve permission prompt layout (#2420) (Zorg)
* Remove hyphenation in "You're up to date" message (#2425) (Zorg, Dom Neill)
* Pre-warm installs before relaunch and resolve sporadic failures in CI (#2421) (Zorg)
* Fix make release not building distribution successfully (#2430) (Zorg)
* Fix Updater app not starting when running Sparkle as root (e.g. from CLI with sudo or a daemon) on macOS 14 Sonoma (#2432) (Zorg)
* Fix KVO usage for updaterController.updater.* (#2404) (Zorg)
* Replace CFUUID* with NSUUID (#2395) (Eitot)
* Report an error when detecting duplicate updates in generate_appcast (#2407) (Zorg)
* Improve error for rejecting xattr based code signing for delta updates (#2408) (Zorg)
* Fail gracefully when auxiliary tool cannot be located (#2436) (Zorg)
# 2.4.2
* Ignore release notes download when we shouldn't show release notes (#2381) (Zorg)
* Fix NSKeyedUnarchiver warning for not specifying keyed NSString class (#2381) (Zorg)
* Harden verification of Sparkle update download (#2392) (Zorg)
# 2.4.1
* Remove auxiliary apps and relocate symbols in SPM package to resolve missing AvailableLibraries warnings (#2356) (Zorg)
* Add -Wno-declaration-after-statement to silence warnings that only apply to pre-C99 (#2345) (Kent Sutherland)
* Fix compile error when setting SPARKLE_EMBED_DOWNLOADER_XPC_SERVICE=0 (#2346) (Zorg)
* Improve how downloaded update is passed to the installer (#2359) (Zorg)
# 2.4.0
* Reduce code size
* Enable deployment postprocessing in Release to properly strip debug symbols and strip all non-global symbols (#2286, #2305) (Zorg)
* Remove duplicate Sparkle localization strings in Updater app (#2288) (Zorg)
* Optimize codebase for generated code size (less properties, direct methods, etc) (#2305) (Zorg)
* Add additional settings to `ConfigCommon.xcconfig` for disabling features
* Ask permission for automatically downloading and installing new updates (#2285) (Zorg)
* Add support for plain text release notes view that does not use web view (#2315) (Zorg)
* Update `SUVersionDisplay` to better customize and display how versions are shown (#2321) (Zorg)
* Add deprecations/warnings for incorrect background update checking usage (#2295) (Zorg)
* Deprecate `-[SPUUpdater setFeedURL:]` API and add `-[SPUUpdater clearFeedURLFromUserDefaults]` for migrating away from `-[SPUUpdater setFeedURL:]` (#2295)
* Trigger a new update check in `-[SPUUpdater resetUpdateCycle]` if the updater's feed or allowed channels have changed (#2324) (Zorg)
* Exit with an error if generate_appcast cannot sign an update that must be signed (#2322) (Zorg)
* Remove a redundant Apple code signing check when verifying new updates (#2341) (Zorg)
* Turn off auto-linking for XPC targets to alleviate circular dependency issues (#2332) (Daniel Jalkut)
# 2.3.2
* Fix potential crash during download if appcast item includes invalid enclosure URL (#2317) (Zorg)
* Add delegate method to hide showing version history option (#2303) (Zorg)
* Finnish localization grammar fixes (#2311) (Lauri-Matti Parppei)
# 2.3.1
* Fix update permission alert title text overlapping with question text in some languages (#2284) (Zorg)
* Log the URL that failed to download correctly (#2296) (Zorg)
* Update Czech translation (#2275) (Sam)
* Add zh_HK (Chinese, Hong Kong) localization (#2273) (Bing Zheung)
# 2.3.0
* Bump minimum deployment target to macOS 10.13 (#2196) (Zorg)
* Remove and preserve necessary updates in generate_appcast (#2218) (Zorg)
* Move old update files no longer needed to old_updates/ in archive directory in generate_appcast (#2228) (Zorg)
* Expose maximum-versions option (per branch) in generate_appcast to preserve in the feed (#2259) (Zorg)
* Add -p option to sign_update to only print the signed signature (#2268) (Zorg)
* Hide automatic install check box when allowsAutomaticUpdates is disabled (#2202) (Jie)
* Allow developer to always force allowing automatic updates (#2266) (Zorg)
* Fix update window going haywire during resize when release notes are hidden by disabling resizing (#2200) (Zorg)
* Allow user to re-try installing/relaunching application when quit is delayed/cancelled (#2234) (Zorg)
* Add delta update attributes for validating an app hasn't been stripped from removed localizations or architectures (#2219) (Zorg)
* Fix delta patches not applying edge case if files from source that need to be diffed are not writeable (#2211) (Zorg)
* Add delegate callback when user makes choice to install, dismiss, or skip an update (#2250) (Zorg)
* Reject serving updates with DSA only and no EdDSA (#2167) (Zorg)
* Find potential matching running apps that are translocated in the updater agent (#2233) (Zorg)
* Expose -[SPUStandardUserDriver activeUpdateAlert] as private API (#2255) (Zorg)
* Add zh_CN l10n for "Version History" (#2247) (kakaiikaka)
* Update zh_TW localization (#2271) (Chiahong)
* Remove ed25519 git submodule in favor of including the dependency directly (#2244) (Zorg)
* Clean up left-over code (#2243) (Eitot)
* Update Package.resolved (#2245) (Zorg)
* Remove model translation table for system profiling (#2188) (Zorg)
* Improve documentation usage for SPUUpdater properties (#2256) (Zorg)
This release improves generate_appcast by automatically removing updates that are no longer needed in the generated appcast, and moving old update files to old_updates/ in the archives directory. New delta update attributes are also added to let Sparkle know when to skip downloading delta updates if the application has been stripped.
macOS 10.13 or later is now required (due to Xcode 14 dropping support for deploying to older OS versions).
If you're not generating appcasts automatically, remember to add `<sparkle:minimumSystemVersion>10.13</sparkle:minimumSystemVersion>` element to `<item>`s in your appcast.
# 2.2.2
* Critical update alerts may not show up as promptly as they should when they are being automatically installed (#2230) (Zorg)
* Remove module imports from framework headers (#2217) (Zorg)
* Update Portuguese localization (#2224) (Kent Sutherland)
* Update zh_TW localization (#2246) (Chiahong)
# 2.2.1
* Make scroll bar dark in dark theme for Release Notes by default (#2187) (Pavel Moiseenko)
* Fix memory leaks when using generate_appcast (#2193) (Zorg)
* Update Italian localization (#2192) (VinBoiSoft)
# 2.2.0
* Update Focus Improvements (#924)
* Present new scheduled updates in utmost focus only at opportune times (Zorg)
* For regular apps opportune times are: app launch, app re-activation, and system being idle (without a power assertion being held to prevent display sleep).
* For background (dockless) apps opportune time is just app launch. Otherwise, the update is now shown behind other applications and windows, instead of previously stealing focus from other active apps.
* Add APIs and documentation for adding gentle update reminders to compliment Sparkle's standard user interface (Zorg) (#2122)
* Allow status window to be minimizable for regular app installs (Zorg) (#2100)
* Center status window and inherit key focus from the previously shown update alert window (Zorg)
* Activate app when checking for updates if the app is not currently active (e.g, from a menu bar extra menu item) (Zorg)
* Fix issue where bringing status window to front made other active windows exit in macOS Ventura's Stage Manager (#2153) (Zorg)
* Fix showing update in focus not bringing the "checking for updates" window in focus (Zorg) (#2150)
* Rename XPC Service filenames for Sandboxing to show more friendly human-readable name in authorization dialog (Zorg) (#2096)
* Add support for running the framework and sparkle-cli as root (Zorg) (#2119)
* Fix issue where update cycle may not complete in unusual configuration if automatic checks are disabled + automatic downloading is enabled + install requires user interaction (Zorg) (#2133)
* Synchronize usage of XPC connections to main queue to fix potential race conditions (Zorg) (#2178)
* Update last update check time when choosing to install an update & relaunch (Zorg) (#2136)
* Improve error reporting in the framework and sparkle-cli when installation fails with no write permission (Zorg) (#2157)
* Use displayVersionString instead of versionString for OS version mismatch error message (samschott) (#2138)
* Make displayVersionString non-null and update fallback documentation (Zorg) (#2139)
* Ignore custom icons set via resource forks when applying delta updates (Zorg) (#2114)
* Fall back to regular update if delta update fails to download (Zorg) (#2118)
* Skip downloading delta updates when application has been moved to a file system (like FAT) that doesn't support regular permission modes (Zorg) (#2148)
* Bump initial installer message timeouts and declare daemon/agents processes as Interactive (Zorg) (#2162)
* Add and improve translation strings and update pt-BR (BR Lingo) (#2094)
* Update localisations (Eitot) (#2113)
* Update Greek localizations (seitsme) (#2184, #2185)
* Update Japanese localization (1024jp) (#2182)
* Replace deprecated code with newer APIs (Eitot) (#2112)
* Remove obsolete fallbacks for older OS versions (Eitot) (#2110)
* Remove SPUURLRequest (Zorg) (#2124)
* Silence ivar deprecation warnings (Zorg) (#2099)
* Fix Xcode 14 project warnings (Zorg) (#2147, #2179)
* Deprecate -s flag and add --ed-key-file option to generate_appcast (Zorg) (#2170)
* Update text for external licenses (Zorg) (#2164)
This update renames the bundled XPC Services, brings improvements to notifying users of new updates without disrupting their focus, and adds [gentle update reminder APIs](https://sparkle-project.org/documentation/gentle-reminders/) to further customize how Sparkle's standard user interface delivers new update alerts.
The `-s` flag for passing a raw private EdDSA key to sign_update and generate_appcast is now deprecated. If you were using this option previously, please see the help pages of these tools for more information.
# 2.1.0
* New Binary Delta format (version 3)
* Features a custom and more efficient container format, migrating away from the deprecated xar format (Zorg) (#2051)
* Adds delta compression options for lzma, bzip2, zlib, lzfse, lz4, and no compression (Zorg) (#2051)
* Changes default delta format compression from bzip2 (in version 2) to lzma (in version 3) resulting in smaller deltas (Zorg) (#2051)
* Preserve file system (HFS+/apfs) level compression when applying delta updates (Zorg) (#2084)
* Tracks renames and binary diffs for files that have moved around to new locations using intelligent heuristics (Zorg) (#2051, #2053)
* Added more unit tests, UI tests, and generate_appcast/BinaryDelta tools support for the new format (Zorg) (#2052, #2054)
* Major upgrade improvements (#2070)
* Fix skipping a major version to not skip subsequent major versions (Zorg) (#2079)
* Add sparkle:belowVersion element for informational updates (Zorg) (#2080)
* Add option to allow developers to ignore/reset user skipped upgrades (Zorg) (#2081)
* Fix progress bar and button alignment for checking updates (Zorg) (#2066)
* This deprecates `-[SPUUserDriver showInstallingUpdate]` and `-[SPUUserDriver showSendingTerminationSignal]` in favor for `-[SPUUserDriver showInstallingUpdateWithApplicationTerminated:]`
* Fix unsteady progress when installing updates (Zorg) (#2072)
* Check http statusCode in didFinishDownloadingToURL (Eric Shapiro, Zorg) (#2049, #2073)
* Use strcoll_l() for locale-independent comparisons for delta updates (Dan Rigdon-Bel) (#2087)
* Fix version compare not treating '2.1.0' and '2.1' as being equal (Zorg) (#2065)
* Add verify and account options for signing updates (Zorg) (#2074)
* Add delta patch and Apple code signing verification in generate_appcast (Zorg) (#2076, #2077)
* Use more modern NSSecureCoding APIs when available (Zorg) (#2058)
* Use more modern FileManager APIs for copying files (Zorg) (#2059)
* Fix make release failing when customizing XPC_SERVICE_BUNDLE_ID_PREFIX (Zorg) (#2060)
* Preserve the Entitlements directory in podspec (digitalMoksha) (#2062)
* Add hidden option to generate_appcast to set max CDATA threshold (Zorg) (#2075)
This update introduces a new major format for [delta updates](https://sparkle-project.org/documentation/delta-updates/), which migrates away from deprecated APIs (xar) and creates smaller patches. If you don't use `generate_appcast`, please check the [compatibility notes for creating delta updates](https://sparkle-project.org/documentation/delta-updates/#compatibility).
# 2.0.0
* Support for Sandboxed Applications (Zorg)
* Support for writing custom user interfaces (Zorg)
* Support for updating external Sparkle-based bundles (Zorg)
* Added command line utility to update Sparkle-based bundles (Zorg)
* Modern architecture
* Moves extraction, validation, and installation into a submitted launchd agent/daemon with XPC communication (Zorg)
* Features faster installs with shorter update/relaunch times (#1802) (Zorg)
* Provides more robust installs when user authorization is needed (Zorg)
* Adoption of improved atomic-safe updates leveraging APFS (#1801) (Zorg)
* API Changes
* Introduced new SPUStandardUpdaterController, SPUUpdater, SPUUserDriver classes/protocols (Zorg)
* Decoupled AppKit and UI logic in the framework from core functionality (Zorg)
* Ensure (most) API compatibility with Sparkle 1; you can likely test Sparkle 2 in an existing app with little to no changes (Zorg)
* Deprecated SUUpdater, albeit it is still functional for testing and transitional purposes (Zorg)
* `-bestValidUpdateInAppcast:forUpdater:` delegate method behavior has been refined and discouraged for some cases. Please review its updated header documentation in `SPUUpdaterDelegate.h` if you use this method. (#1838, #1862, #1879, #1880) (Zorg)
* Delegation methods may have been removed or added to the newer updater API. Please review `SPUUpdaterDelegate` if using `SPUUpdater`. (Zorg)
* Updater Changes
* Automatic silent and manual update alert prompts are now merged together (Zorg)
* Updates will attempt to install even if the user quits the application without relaunching the application update explicitly (Zorg)
* Updates can be downloaded in the background automatically but later prompt the user to install them, particularly if Sparkle doesn't have sufficient permission to install them without the user's permission (Zorg)
* Authorization now occurs before launching the installer and before terminating the application, which can be canceled by the user cleanly (Zorg)
* Sparkle uses the icon of the bundle to update for its authorization dialog. A 32x32 image representation of the icon is needed. (Zorg)
* Sudden termination for silent automatic updates isn't disabled anymore (Zorg)
* Policy Changes
* Non-bare package based updates that are zipped or archived must add sparkle:installationType="package" to the appcast item enclosure (this doesn't apply to bare packages which aren't archived) (Zorg)
* We now recommend using sparkle:version and sparkle:shortVersionString top level elements instead of enclosure attributes (#1878) (Zorg)
* The link element in an appcast item is now used for directing users to the product's website if they don't meet minimum system requirements (#1877) (Zorg)
* Expose why a new update is unavailable and direct user to prior release notes or website info (#1877, #1886) (Zorg)
* Add <sparkle:fullReleaseNotesLink> element allowing Sparkle to show a better stylized and full changelog to the user (#2001) (aONe)
* Add delegate API allowing applications to show full in-app or offline version history to the user (#1989) (Billy Gray)
* Major/Paid Upgrades Enhancements
* Latest minor updates are preferred over major updates (specified by sparkle:minimumAutoupdateVersion) (#1850) (Zorg)
* Major updates can be skipped with a user confirmation (#1853) (Zorg)
* Informational only and critical updates can be specified selectively by app version (#1862)
* Add support for posting updates only on specific channels (eg for supporting beta updates) (#1879) (Zorg)
* System profiler privacy and transparency (#1690) (Martin Pilkington)
* Support getting app icon from asset catalog (#1694) (Charles Srstka)
* Don't bring up authorization just because group ID doesn't match (#1830) (Zorg)
* Raise minimum system version to macOS 10.11 (Zorg)
* Special thanks to developers using early builds of this release in production and contributors for keeping this running (Kornel, Jonas Zaugg, Gwynne Raskind, Jordan Rose, Tony Arnold, Bryan Jones, Christian Tietze, Jakob Egger, and many more)
Please visit [Sparkle's website](http://sparkle-project.org) for more information on documentation and migration.
If you are migrating from earlier beta versions of Sparkle 2 and use sandboxing, please re-familiarize yourself with the [Sandboxing guide](https://sparkle-project.org/documentation/sandboxing/). Some of the XPC Services are now optional and integration with XPC Services and code signing have been simplified. The SPUUserDriver protocol for custom user interfaces has been greatly simplified too.
# 1.27.1
* Use px instead of pt when specifying font size to fix default font size in WebView from #1962 (regressed in 1.25.0 with WKWebView adoption) (Daniel Jalkut)
* Fix to prevent Sparkle manipulating the host app's high level WebView defaults from #1961 (affecting only macOS versions before 10.11 in 1.x branch) (Daniel Jalkut)
* Add safer handling of applying binary delta files from #1990 (Zorg)
* Don't use current date unless necessary when scheduling next update from #1991 (Zorg)
* Whitelist about:srcdoc as a safe web URL from #1938, #2007 (Louis Pontoise, Zorg)
* Backport not hiding update window on deactivation from #2008 (Zorg)
# 1.27.0
* Deprecate not using EdDSA and skip DSA verification when possible in #1892 (Zorg)
* Pass http headers and user agent when downloading release notes from #1873 (Zorg)
* Fix project warnings from #1893 (Zorg)
* Update sample appcast from #1895 (Zorg)
* Fix appcast pubDate tag generation in different locales from #1898 (Sungbin Jo)
* Create valid xar archives for generating binary delta files from #1906 (Zorg)
* Fix a few issues with German localization from #1931 (J-rg)
* Fix issues with Russian localizations from #1947 (Konstantin Zamyakin)
* Fix issues with Czech localizations from #1943 (Vojtěch Koňařík)
* Add an automated workflow that builds and publishes official Sparkle releases (Tony Arnold, Zorg)
# 1.26.0
* Flat package support from #1745 (Zorg)
@@ -134,7 +411,7 @@
# 1.20.0
* `generate_appcast` option to read private key directly from the keychain (Tamás Lustyik)
* Add delegate callbacks for fininshed download and extraction related events (Csaba Horony)
* Add delegate callbacks for finished download and extraction related events (Csaba Horony)
* Don't check for updates if Do Not Disturb is on (Kornel)
* Expose `CodesigningVerifier`, add codesign info API (sunuslee)
* Threading fixes:
@@ -484,7 +761,7 @@ Important security fixes:
* All the user defaults keys are now private; instead, SUUpdater is KVC-compliant for automaticallyChecksForUpdates, updateCheckInterval, and feedURL.
* Reduced the size of the English-only framework by 25%.
* System profiling information is now only submitted to the server once per week; this will help normalize your statistics across users with different interval preferences.
* The feedParamatersForUpdater: delegate method now requires "displayKey" and "displayVersion" keys so that it can inform the user what's being sent.
* The feedParametersForUpdater: delegate method now requires "displayKey" and "displayVersion" keys so that it can inform the user what's being sent.
* Added a delegate method called pathToRelaunchForUpdater: which can be used for plugins to provide the path which should be used when relaunching the client after installing an update.
* Added support for xml:lang to pick localized nodes in appcasts (for release notes, etc).
* Fixed a bug which would cause the "checking for updates" window to not disappear in certain extraordinary error conditions.
+1
View File
@@ -0,0 +1 @@
{"1.27.1": "https://github.com/sparkle-project/Sparkle/releases/download/1.27.1/Sparkle-1.27.1.tar.xz", "2.0.0-beta.6": "https://github.com/sparkle-project/Sparkle/releases/download/2.0.0-beta.6/Sparkle-2.0.0-beta.6.tar.xz", "2.0.0-rc.1": "https://github.com/sparkle-project/Sparkle/releases/download/2.0.0-rc.1/Sparkle-2.0.0-rc.1.tar.xz", "2.0.0": "https://github.com/sparkle-project/Sparkle/releases/download/2.0.0/Sparkle-2.0.0.tar.xz", "2.1.0-beta.1": "https://github.com/sparkle-project/Sparkle/releases/download/2.1.0-beta.1/Sparkle-2.1.0-beta.1.tar.xz", "2.1.0-beta.2": "https://github.com/sparkle-project/Sparkle/releases/download/2.1.0-beta.2/Sparkle-2.1.0-beta.2.tar.xz", "2.1.0": "https://github.com/sparkle-project/Sparkle/releases/download/2.1.0/Sparkle-2.1.0.tar.xz", "2.2.0-beta.1": "https://github.com/sparkle-project/Sparkle/releases/download/2.2.0-beta.1/Sparkle-2.2.0-beta.1.tar.xz", "2.2.0-beta.2": "https://github.com/sparkle-project/Sparkle/releases/download/2.2.0-beta.2/Sparkle-2.2.0-beta.2.tar.xz", "2.2.0": "https://github.com/sparkle-project/Sparkle/releases/download/2.2.0/Sparkle-2.2.0.tar.xz", "2.2.1": "https://github.com/sparkle-project/Sparkle/releases/download/2.2.1/Sparkle-2.2.1.tar.xz", "2.2.2": "https://github.com/sparkle-project/Sparkle/releases/download/2.2.2/Sparkle-2.2.2.tar.xz", "2.3.0-beta.1": "https://github.com/sparkle-project/Sparkle/releases/download/2.3.0-beta.1/Sparkle-2.3.0-beta.1.tar.xz", "2.3.0-beta.2": "https://github.com/sparkle-project/Sparkle/releases/download/2.3.0-beta.2/Sparkle-2.3.0-beta.2.tar.xz", "2.3.0": "https://github.com/sparkle-project/Sparkle/releases/download/2.3.0/Sparkle-2.3.0.tar.xz", "2.3.1": "https://github.com/sparkle-project/Sparkle/releases/download/2.3.1/Sparkle-2.3.1.tar.xz", "2.3.2": "https://github.com/sparkle-project/Sparkle/releases/download/2.3.2/Sparkle-2.3.2.tar.xz", "2.4.0-beta.1": "https://github.com/sparkle-project/Sparkle/releases/download/2.4.0-beta.1/Sparkle-2.4.0-beta.1.tar.xz", "2.4.0-beta.2": "https://github.com/sparkle-project/Sparkle/releases/download/2.4.0-beta.2/Sparkle-2.4.0-beta.2.tar.xz", "2.4.0": "https://github.com/sparkle-project/Sparkle/releases/download/2.4.0/Sparkle-2.4.0.tar.xz", "2.4.1-beta.1": "https://github.com/sparkle-project/Sparkle/releases/download/2.4.1-beta.1/Sparkle-2.4.1-beta.1.tar.xz", "2.4.1": "https://github.com/sparkle-project/Sparkle/releases/download/2.4.1/Sparkle-2.4.1.tar.xz", "2.4.2": "https://github.com/sparkle-project/Sparkle/releases/download/2.4.2/Sparkle-2.4.2.tar.xz", "2.5.0-beta.1": "https://github.com/sparkle-project/Sparkle/releases/download/2.5.0-beta.1/Sparkle-2.5.0-beta.1.tar.xz", "2.5.0-beta.2": "https://github.com/sparkle-project/Sparkle/releases/download/2.5.0-beta.2/Sparkle-2.5.0-beta.2.tar.xz", "2.5.0": "https://github.com/sparkle-project/Sparkle/releases/download/2.5.0/Sparkle-2.5.0.tar.xz", "2.5.1": "https://github.com/sparkle-project/Sparkle/releases/download/2.5.1/Sparkle-2.5.1.tar.xz", "2.5.2": "https://github.com/sparkle-project/Sparkle/releases/download/2.5.2/Sparkle-2.5.2.tar.xz", "2.6.0-beta.1": "https://github.com/sparkle-project/Sparkle/releases/download/2.6.0-beta.1/Sparkle-2.6.0-beta.1.tar.xz", "2.6.0-beta.2": "https://github.com/sparkle-project/Sparkle/releases/download/2.6.0-beta.2/Sparkle-2.6.0-beta.2.tar.xz", "2.6.0": "https://github.com/sparkle-project/Sparkle/releases/download/2.6.0/Sparkle-2.6.0.tar.xz", "2.6.1": "https://github.com/sparkle-project/Sparkle/releases/download/2.6.1/Sparkle-2.6.1.tar.xz"}
@@ -1,4 +1,4 @@
// Generate Appcast Debug
#include "ConfigGenerateKeys.xcconfig"
#include "CommandLineTool-Shared.xcconfig"
#include "ConfigSwiftDebug.xcconfig"
@@ -1,4 +1,4 @@
// Generate Appcast Release
#include "ConfigGenerateKeys.xcconfig"
#include "CommandLineTool-Shared.xcconfig"
#include "ConfigSwiftRelease.xcconfig"
@@ -0,0 +1,6 @@
// Generate Appcast only
#include "ConfigSwift.xcconfig"
SWIFT_OBJC_BRIDGING_HEADER = $(PRODUCT_NAME)/Bridging-Header.h
GCC_PREPROCESSOR_DEFINITIONS = $(GCC_PREPROCESSOR_DEFINITIONS) BUILDING_EXTERNALLY=1
@@ -1 +0,0 @@
// BinaryDelta tool only
@@ -1,2 +0,0 @@
#include "ConfigBinaryDelta.xcconfig"
@@ -1 +0,0 @@
#include "ConfigBinaryDelta.xcconfig"
+106 -23
View File
@@ -1,45 +1,131 @@
// Common
// Set to 1 or 0 to build and bundle the provided XPC Services in Sparkle framework
// (Note for testing purposes for sandboxed apps, disabling all XPC services and then re-enabling them
// may not work on the same login session due to a system caching issue. See comments for setting FRAMEWORK_VERSION for more info)
SPARKLE_EMBED_INSTALLER_LAUNCHER_XPC_SERVICE = 1
// Embedding the downloader service also enables building legacy WebKit1 support
SPARKLE_EMBED_DOWNLOADER_XPC_SERVICE = 1
SPARKLE_EMBED_INSTALLER_STATUS_XPC_SERVICE = 0
SPARKLE_EMBED_INSTALLER_CONNECTION_XPC_SERVICE = 0
// Set to 0 to disable building legacy 1.x SUUpdater stub
SPARKLE_BUILD_LEGACY_SUUPDATER = 1
// Set to 0 to not build legacy DSA signing support
// Don't disable this if you haven't migrated to EdDSA yet or if you support updating
// other developer's applications that haven't migrated to EdDSA yet
// If this is disabled, this requires an update to OTHER_SWIFT_FLAGS_COMMON below
SPARKLE_BUILD_LEGACY_DSA_SUPPORT = 1
// Set to 0 to not build legacy DSA signing support for generate_appcast
// Don't disable this if you still have items in your appcast feed that still need DSA signatures
// If this is disabled, this requires an update to OTHER_SWIFT_FLAGS_COMMON below
GENERATE_APPCAST_BUILD_LEGACY_DSA_SUPPORT = 1
// Set to 0 to not build legacy / xar based delta update support
SPARKLE_BUILD_LEGACY_DELTA_SUPPORT = 1
// Set to 0 to not build bzip2 support for version 3 delta based updates
SPARKLE_BUILD_BZIP2_DELTA_SUPPORT = 1
// Set to 0 to not build support for package (pkg) based installations
// If this is disabled, this requires an update to OTHER_SWIFT_FLAGS_COMMON below
SPARKLE_BUILD_PACKAGE_SUPPORT = 1
// Set to 0 to not build support for extracting updates from disk images (dmgs)
// If this is disabled, this requires an update to OTHER_SWIFT_FLAGS_COMMON below
SPARKLE_BUILD_DMG_SUPPORT = 1
// Set to 0 to only build all non-UI bits (which means client uses a custom SPUUserDriver)
SPARKLE_BUILD_UI_BITS = 1
// Set to 0 to not use and copy localization / string files to framework
SPARKLE_COPY_LOCALIZATIONS = 1
// Compilation flags for Swift tools and unit tests
// If SPARKLE_BUILD_LEGACY_DELTA_SUPPORT is set to 0, remove -DSPARKLE_BUILD_LEGACY_DSA_SUPPORT
// If GENERATE_APPCAST_BUILD_LEGACY_DSA_SUPPORT is set to 0, remove -DGENERATE_APPCAST_BUILD_LEGACY_DSA_SUPPORT
// If SPARKLE_BUILD_PACKAGE_SUPPORT is set to 0, remove -DSPARKLE_BUILD_PACKAGE_SUPPORT
// If SPARKLE_BUILD_DMG_SUPPORT is set to 0, remove -DSPARKLE_BUILD_DMG_SUPPORT
OTHER_SWIFT_FLAGS_COMMON = -DSPARKLE_BUILD_LEGACY_DSA_SUPPORT -DGENERATE_APPCAST_BUILD_LEGACY_DSA_SUPPORT -DSPARKLE_BUILD_PACKAGE_SUPPORT -DSPARKLE_BUILD_DMG_SUPPORT
// Minimum supported macOS version
MACOSX_DEPLOYMENT_TARGET = 10.13
// Supported architectures
ARCHS = $(ARCHS_STANDARD)
// Default Sparkle names
SPARKLE_BUNDLE_IDENTIFIER = org.sparkle-project.Sparkle
SPARKLE_RELAUNCH_TOOL_NAME = Autoupdate
SPARKLE_FILEOP_TOOL_NAME = fileop
SPARKLE_INSTALLER_PROGRESS_TOOL_NAME = Updater
SPARKLE_INSTALLER_PROGRESS_TOOL_BUNDLE_ID = $(SPARKLE_BUNDLE_IDENTIFIER).$(SPARKLE_INSTALLER_PROGRESS_TOOL_NAME)
SPARKLE_APPEND_VERSION_NUMBER = 1
// Set these if you want to use custom name for the XPC Services
// For the Installer one in particular, this name may show up in an authorization prompt
// when installing an update that requires authorization.
INSTALLER_CONNECTION_NAME = InstallerConnection
INSTALLER_STATUS_NAME = InstallerStatus
INSTALLER_LAUNCHER_NAME = Installer
DOWNLOADER_NAME = Downloader
// Set this to your own prefix if you want to use XPC Service bundle IDs with different prefix
XPC_SERVICE_BUNDLE_ID_PREFIX = org.sparkle-project
INSTALLER_CONNECTION_BUNDLE_ID = ${XPC_SERVICE_BUNDLE_ID_PREFIX}.InstallerConnection
INSTALLER_STATUS_BUNDLE_ID = ${XPC_SERVICE_BUNDLE_ID_PREFIX}.InstallerStatus
INSTALLER_LAUNCHER_BUNDLE_ID = ${XPC_SERVICE_BUNDLE_ID_PREFIX}.InstallerLauncher
DOWNLOADER_BUNDLE_ID = ${XPC_SERVICE_BUNDLE_ID_PREFIX}.DownloaderService
// The Downloader XPC Service is not sandboxed by default.
// Uncomment line to enable Sandboxing for this service.
// If this is done, you *must* set a custom XPC_SERVICE_BUNDLE_ID_PREFIX for your app above.
// Otherwise sandboxed apps that use the same sandboxed Downloader Service may conflict with each other.
//DOWNLOADER_SANDBOXED_ENTITLEMENTS = Downloader/Downloader.entitlements
// Sparkle usually doesn't allow downgrades as they're usually accidental, but
// if your app has a downgrade function or URL handler, turn this on
SPARKLE_AUTOMATED_DOWNGRADES = 0
// If your app file on disk is named "MyApp 1.1b4", Sparkle usually updates it
// in place, giving you an app named 1.1b4 that is actually 1.2. Turn the
// following on to always reset the name back to "MyApp":
// following on to always reset the name back to "MyApp"
// If you are using this option to change the name of your app, you should
// disable the option again when you no longer need it
// Note this option is only supported for regular application updates and not plug-ins
SPARKLE_NORMALIZE_INSTALLED_APPLICATION_NAME = 0
SPARKLE_VERSION_MAJOR = 1
SPARKLE_VERSION_MINOR = 26
SPARKLE_VERSION_PATCH = 0
SPARKLE_VERSION = $(SPARKLE_VERSION_MAJOR).$(SPARKLE_VERSION_MINOR).$(SPARKLE_VERSION_PATCH)
SPARKLE_ICON_NAME = AppIcon
CURRENT_PROJECT_VERSION = $(SPARKLE_VERSION)
// If you change any of these version details, you must increase CURRENT_PROJECT_VERSION
// These variables must have a space after the '=' too
SPARKLE_VERSION_MAJOR = 2
SPARKLE_VERSION_MINOR = 6
SPARKLE_VERSION_PATCH = 1
// This should be in SemVer format or empty, ie. "-beta.1"
// These variables must have a space after the '=' too
SPARKLE_VERSION_SUFFIX =
CURRENT_PROJECT_VERSION = 2037
MARKETING_VERSION = $(SPARKLE_VERSION_MAJOR).$(SPARKLE_VERSION_MINOR).$(SPARKLE_VERSION_PATCH)$(SPARKLE_VERSION_SUFFIX)
ALWAYS_SEARCH_USER_PATHS = NO
ENABLE_STRICT_OBJC_MSGSEND = YES
GCC_SYMBOLS_PRIVATE_EXTERN = YES
GCC_INLINES_ARE_PRIVATE_EXTERN = YES
ARCHS = $(ARCHS_STANDARD)
MACOSX_DEPLOYMENT_TARGET = 10.9
PRODUCT_NAME = ${TARGET_NAME}
PRODUCT_BUNDLE_IDENTIFIER = org.sparkle-project.Sparkle.${PRODUCT_NAME:rfc1034identifier}
GCC_PREPROCESSOR_DEFINITIONS_COMMON = SPARKLE_NORMALIZE_INSTALLED_APPLICATION_NAME=$(SPARKLE_NORMALIZE_INSTALLED_APPLICATION_NAME) SPARKLE_AUTOMATED_DOWNGRADES=$(SPARKLE_AUTOMATED_DOWNGRADES) SPARKLE_APPEND_VERSION_NUMBER=$(SPARKLE_APPEND_VERSION_NUMBER) SPARKLE_BUNDLE_IDENTIFIER=\"$(SPARKLE_BUNDLE_IDENTIFIER)\" SPARKLE_RELAUNCH_TOOL_NAME=\"$(SPARKLE_RELAUNCH_TOOL_NAME)\" SPARKLE_FILEOP_TOOL_NAME=\"$(SPARKLE_FILEOP_TOOL_NAME)\"
GCC_PREPROCESSOR_DEFINITIONS_COMMON = SPU_OBJC_DIRECT=__attribute__((objc_direct)) SPU_OBJC_DIRECT_MEMBERS=__attribute__((objc_direct_members)) SPARKLE_NORMALIZE_INSTALLED_APPLICATION_NAME=$(SPARKLE_NORMALIZE_INSTALLED_APPLICATION_NAME) SPARKLE_BUILD_UI_BITS=$(SPARKLE_BUILD_UI_BITS) SPARKLE_COPY_LOCALIZATIONS=$(SPARKLE_COPY_LOCALIZATIONS) SPARKLE_BUILD_LEGACY_SUUPDATER=$(SPARKLE_BUILD_LEGACY_SUUPDATER) SPARKLE_BUILD_PACKAGE_SUPPORT=$(SPARKLE_BUILD_PACKAGE_SUPPORT) SPARKLE_BUILD_DMG_SUPPORT=$(SPARKLE_BUILD_DMG_SUPPORT) SPARKLE_BUILD_LEGACY_DELTA_SUPPORT=$(SPARKLE_BUILD_LEGACY_DELTA_SUPPORT) SPARKLE_BUILD_BZIP2_DELTA_SUPPORT=$(SPARKLE_BUILD_BZIP2_DELTA_SUPPORT) SPARKLE_BUILD_LEGACY_DSA_SUPPORT=$(SPARKLE_BUILD_LEGACY_DSA_SUPPORT) GENERATE_APPCAST_BUILD_LEGACY_DSA_SUPPORT=$(GENERATE_APPCAST_BUILD_LEGACY_DSA_SUPPORT) SPARKLE_BUNDLE_IDENTIFIER=\"$(SPARKLE_BUNDLE_IDENTIFIER)\" CURRENT_PROJECT_VERSION=\"$(CURRENT_PROJECT_VERSION)\" MARKETING_VERSION=\"$(MARKETING_VERSION)\" SPARKLE_RELAUNCH_TOOL_NAME=\"$(SPARKLE_RELAUNCH_TOOL_NAME)\" SPARKLE_INSTALLER_PROGRESS_TOOL_NAME=\"$(SPARKLE_INSTALLER_PROGRESS_TOOL_NAME)\" SPARKLE_INSTALLER_PROGRESS_TOOL_BUNDLE_ID=\"$(SPARKLE_INSTALLER_PROGRESS_TOOL_BUNDLE_ID)\" SPARKLE_ICON_NAME=\"$(SPARKLE_ICON_NAME)\" INSTALLER_LAUNCHER_NAME=\"${INSTALLER_LAUNCHER_NAME}\" INSTALLER_LAUNCHER_BUNDLE_ID=\"${INSTALLER_LAUNCHER_BUNDLE_ID}\" INSTALLER_LAUNCHER_XPC_SERVICE_EMBEDDED=$(SPARKLE_EMBED_INSTALLER_LAUNCHER_XPC_SERVICE) INSTALLER_CONNECTION_NAME=\"${INSTALLER_CONNECTION_NAME}\" INSTALLER_CONNECTION_BUNDLE_ID=\"${INSTALLER_CONNECTION_BUNDLE_ID}\" INSTALLER_CONNECTION_XPC_SERVICE_EMBEDDED=$(SPARKLE_EMBED_INSTALLER_CONNECTION_XPC_SERVICE) INSTALLER_STATUS_NAME=\"${INSTALLER_STATUS_NAME}\" INSTALLER_STATUS_BUNDLE_ID=\"${INSTALLER_STATUS_BUNDLE_ID}\" INSTALLER_STATUS_XPC_SERVICE_EMBEDDED=$(SPARKLE_EMBED_INSTALLER_STATUS_XPC_SERVICE) DOWNLOADER_NAME=\"${DOWNLOADER_NAME}\" DOWNLOADER_BUNDLE_ID=\"${DOWNLOADER_BUNDLE_ID}\" DOWNLOADER_XPC_SERVICE_EMBEDDED=$(SPARKLE_EMBED_DOWNLOADER_XPC_SERVICE)
ENABLE_HARDENED_RUNTIME = YES;
CODE_SIGN_IDENTITY = -
SDKROOT = macosx
ENABLE_HARDENED_RUNTIME = YES
CLANG_ENABLE_OBJC_ARC = YES
GCC_ENABLE_PASCAL_STRINGS = NO
GCC_NO_COMMON_BLOCKS = YES;
COMBINE_HIDPI_IMAGES = NO;
GCC_NO_COMMON_BLOCKS = YES
COMBINE_HIDPI_IMAGES = NO
// Enable warnings
CLANG_ANALYZER_LOCALIZABILITY_NONLOCALIZED = YES;
CLANG_ANALYZER_LOCALIZABILITY_NONLOCALIZED = YES
CLANG_ANALYZER_SECURITY_FLOATLOOPCOUNTER = YES
CLANG_ANALYZER_SECURITY_INSECUREAPI_RAND = YES
CLANG_ANALYZER_SECURITY_INSECUREAPI_STRCPY = YES
@@ -55,7 +141,7 @@ CLANG_WARN_OBJC_IMPLICIT_ATOMIC_PROPERTIES = YES
CLANG_WARN_OBJC_IMPLICIT_RETAIN_SELF = YES
CLANG_WARN_OBJC_MISSING_PROPERTY_SYNTHESIS = YES
CLANG_WARN_OBJC_REPEATED_USE_OF_WEAK = YES
CLANG_WARN_QUOTED_INCLUDE_IN_FRAMEWORK_HEADER = NO
CLANG_WARN_QUOTED_INCLUDE_IN_FRAMEWORK_HEADER = YES
CLANG_WARN_SUSPICIOUS_IMPLICIT_CONVERSION = YES
CLANG_WARN_UNREACHABLE_CODE = YES
GCC_TREAT_IMPLICIT_FUNCTION_DECLARATIONS_AS_ERRORS = YES
@@ -82,8 +168,5 @@ GCC_WARN_UNUSED_LABEL = YES
GCC_WARN_UNUSED_PARAMETER = YES
GCC_WARN_UNUSED_VARIABLE = YES
// These should be removed once the conversion to ARC is complete
WARNING_CFLAGS_EXTRA = -Wno-custom-atomic-properties -Wno-implicit-atomic-properties
// Turn on all warnings, then disable a few which are almost impossible to avoid
WARNING_CFLAGS = -Wall -Weverything -Wno-unused-macros -Wno-gnu-statement-expression -Wno-arc-repeated-use-of-weak -Wno-auto-import -Wno-gnu-zero-variadic-macro-arguments -Wno-format-non-iso $(WARNING_CFLAGS_EXTRA)
WARNING_CFLAGS = -Wall -Weverything -Wno-unused-macros -Wno-gnu-statement-expression -Wno-auto-import -Wno-gnu-zero-variadic-macro-arguments -Wno-format-non-iso -Wno-direct-ivar-access -Wno-declaration-after-statement -Wno-gnu-conditional-omitted-operand -Werror=undef
@@ -0,0 +1,13 @@
#include "ConfigCommonDebug.xcconfig"
GCC_PREPROCESSOR_DEFINITIONS = $(GCC_PREPROCESSOR_DEFINITIONS_COMMON)
OTHER_SWIFT_FLAGS = $(OTHER_SWIFT_FLAGS_COMMON)
CLANG_WARN_BLOCK_CAPTURE_AUTORELEASING = YES;
CLANG_WARN_COMMA = YES;
CLANG_WARN_INFINITE_RECURSION = YES;
CLANG_WARN_RANGE_LOOP_ANALYSIS = YES;
CLANG_WARN_STRICT_PROTOTYPES = YES;
CLANG_WARN_SUSPICIOUS_MOVE = YES;
GCC_GENERATE_TEST_COVERAGE_FILES = YES
GCC_INSTRUMENT_PROGRAM_FLOW_ARCS = YES
@@ -13,5 +13,6 @@ DEBUG_INFORMATION_FORMAT = dwarf
ENABLE_TESTABILITY = YES
GCC_GENERATE_DEBUGGING_SYMBOLS = YES
GCC_PREPROCESSOR_DEFINITIONS = $(GCC_PREPROCESSOR_DEFINITIONS_COMMON) DEBUG=1
OTHER_SWIFT_FLAGS = $(OTHER_SWIFT_FLAGS_COMMON)
ONLY_ACTIVE_ARCH = YES
COPY_PHASE_STRIP = NO
+4 -1
View File
@@ -11,7 +11,10 @@ CLANG_WARN_SUSPICIOUS_MOVE = YES;
GCC_OPTIMIZATION_LEVEL = s
DEBUG_INFORMATION_FORMAT = dwarf-with-dsym
GCC_GENERATE_DEBUGGING_SYMBOLS = YES
GCC_PREPROCESSOR_DEFINITIONS = $(GCC_PREPROCESSOR_DEFINITIONS_COMMON)
GCC_PREPROCESSOR_DEFINITIONS = $(GCC_PREPROCESSOR_DEFINITIONS_COMMON) DEBUG=0
OTHER_SWIFT_FLAGS = $(OTHER_SWIFT_FLAGS_COMMON)
DEAD_CODE_STRIPPING = YES
GCC_TREAT_WARNINGS_AS_ERRORS = NO
GCC_WARN_UNINITIALIZED_AUTOS = YES
COPY_PHASE_STRIP = NO
DEPLOYMENT_POSTPROCESSING = YES
+9
View File
@@ -0,0 +1,9 @@
// Downloader
INFOPLIST_FILE = Downloader/Info.plist
WRAPPER_EXTENSION = xpc
PRODUCT_BUNDLE_IDENTIFIER = ${DOWNLOADER_BUNDLE_ID}
PRODUCT_NAME = ${DOWNLOADER_NAME}
CODE_SIGN_ENTITLEMENTS = $(DOWNLOADER_SANDBOXED_ENTITLEMENTS)
GCC_PREPROCESSOR_DEFINITIONS = $(GCC_PREPROCESSOR_DEFINITIONS) BUILDING_SPARKLE_SOURCES_EXTERNALLY=1
CLANG_MODULES_AUTOLINK = NO
@@ -0,0 +1,2 @@
// Downloader Debug
#include "ConfigDownloader.xcconfig"
-5
View File
@@ -1,5 +0,0 @@
// Fileop tool only
PRODUCT_NAME = $(SPARKLE_FILEOP_TOOL_NAME)
SKIP_INSTALL = YES
CLANG_ENABLE_MODULES = NO
+14 -2
View File
@@ -4,10 +4,22 @@ DYLIB_INSTALL_NAME_BASE = @rpath
DYLIB_COMPATIBILITY_VERSION = 1.6
DYLIB_CURRENT_VERSION = $(SPARKLE_VERSION_MAJOR).$(SPARKLE_VERSION_MINOR).$(SPARKLE_VERSION_PATCH)
WRAPPER_EXTENSION = framework
FRAMEWORK_VERSION = A
// Sparkle 2 used to support developers embedding XPC Services in their own app bundle
// However the Sparkle framework now bundles these XPC Services. Unfortunately this causes
// a cache conflict in the system from upgrading from previous to newer versions of Sparkle, and
// XPC Services inside Sparkle may not launch (a system reboot would fix this though).
// The system cache seems to depend on the Sparkle file path,
// so as a better workaround we have changed the FRAMEWORK_VERSION from A to B
FRAMEWORK_VERSION = B
INFOPLIST_FILE = Sparkle/Sparkle-Info.plist
GCC_PREPROCESSOR_DEFINITIONS = $(inherited) BUILDING_SPARKLE=1
OTHER_LDFLAGS = -Wl,-U,_NSURLQuarantinePropertiesKey
SKIP_INSTALL = YES
DEFINES_MODULE = YES
PRODUCT_BUNDLE_IDENTIFIER = ${SPARKLE_BUNDLE_IDENTIFIER}
// As long as we don't ourselves depend upon any Frameworks that are incompatible
// with Application Extensions, then we should allow frameworks that require
// compatibility to be able to link with us.
APPLICATION_EXTENSION_API_ONLY = YES
@@ -1,2 +1,4 @@
#include "ConfigFramework.xcconfig"
// Strip all non-global symbols (including debug symbols)
STRIP_STYLE = non-global
@@ -1,7 +0,0 @@
// Generate Appcast only
#include "ConfigSwift.xcconfig"
SWIFT_OBJC_BRIDGING_HEADER = generate_appcast/Appcast-Bridging-Header.h
MACOSX_DEPLOYMENT_TARGET = 10.11
PRODUCT_NAME = generate_appcast
@@ -1,4 +0,0 @@
// Generate Appcast Debug
#include "ConfigGenerateAppcast.xcconfig"
#include "ConfigSwiftDebug.xcconfig"
@@ -1,4 +0,0 @@
// Generate Appcast Release
#include "ConfigGenerateAppcast.xcconfig"
#include "ConfigSwiftRelease.xcconfig"
@@ -1,7 +0,0 @@
// Generate Appcast only
#include "ConfigSwift.xcconfig"
SWIFT_OBJC_BRIDGING_HEADER = generate_keys/Bridging-Header.h
MACOSX_DEPLOYMENT_TARGET = 10.11
PRODUCT_NAME = generate_keys
@@ -0,0 +1,8 @@
// InstallerConnection
INFOPLIST_FILE = InstallerConnection/Info.plist
WRAPPER_EXTENSION = xpc
PRODUCT_BUNDLE_IDENTIFIER = ${INSTALLER_CONNECTION_BUNDLE_ID}
PRODUCT_NAME = ${INSTALLER_CONNECTION_NAME}
GCC_PREPROCESSOR_DEFINITIONS = $(GCC_PREPROCESSOR_DEFINITIONS) BUILDING_SPARKLE_SOURCES_EXTERNALLY=1
CLANG_MODULES_AUTOLINK = NO
@@ -0,0 +1,3 @@
// InstallerConnection Debug
#include "ConfigInstallerConnection.xcconfig"
@@ -0,0 +1,8 @@
// Installer Launcher
INFOPLIST_FILE = InstallerLauncher/Info.plist
WRAPPER_EXTENSION = xpc
PRODUCT_BUNDLE_IDENTIFIER = ${INSTALLER_LAUNCHER_BUNDLE_ID}
PRODUCT_NAME = ${INSTALLER_LAUNCHER_NAME}
GCC_PREPROCESSOR_DEFINITIONS = $(GCC_PREPROCESSOR_DEFINITIONS) BUILDING_SPARKLE_SOURCES_EXTERNALLY=1
CLANG_MODULES_AUTOLINK = NO
@@ -0,0 +1,2 @@
// Installer Launcher Debug
#include "ConfigInstallerLauncher.xcconfig"
@@ -0,0 +1,8 @@
// Installer Progress only
INFOPLIST_FILE = Sparkle/InstallerProgress/InstallerProgress-Info.plist
PRODUCT_NAME = $(SPARKLE_INSTALLER_PROGRESS_TOOL_NAME)
PRODUCT_BUNDLE_IDENTIFIER = $(SPARKLE_INSTALLER_PROGRESS_TOOL_BUNDLE_ID)
GCC_PREPROCESSOR_DEFINITIONS = $(GCC_PREPROCESSOR_DEFINITIONS) BUILDING_SPARKLE=0 BUILDING_SPARKLE_SOURCES_EXTERNALLY=1
SKIP_INSTALL = YES
CLANG_ENABLE_MODULES = NO
@@ -0,0 +1,8 @@
// InstallerStatus
INFOPLIST_FILE = InstallerStatus/Info.plist
WRAPPER_EXTENSION = xpc
PRODUCT_BUNDLE_IDENTIFIER = ${INSTALLER_STATUS_BUNDLE_ID}
PRODUCT_NAME = ${INSTALLER_STATUS_NAME}
GCC_PREPROCESSOR_DEFINITIONS = $(GCC_PREPROCESSOR_DEFINITIONS) BUILDING_SPARKLE=0 BUILDING_SPARKLE_SOURCES_EXTERNALLY=1
CLANG_MODULES_AUTOLINK = NO
@@ -0,0 +1,3 @@
// InstallerStatus Debug
#include "ConfigInstallerStatus.xcconfig"
+1 -3
View File
@@ -1,8 +1,6 @@
// Relaunch Tool only
INFOPLIST_FILE = Sparkle/Autoupdate/Autoupdate-Info.plist
PRODUCT_NAME = $(SPARKLE_RELAUNCH_TOOL_NAME)
SKIP_INSTALL = YES
ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon
CLANG_ENABLE_MODULES = NO
OTHER_LDFLAGS = -Wl,-U,_NSURLQuarantinePropertiesKey
GCC_PREPROCESSOR_DEFINITIONS = $(GCC_PREPROCESSOR_DEFINITIONS) BUILDING_SPARKLE_SOURCES_EXTERNALLY=1
@@ -1 +0,0 @@
#include "ConfigRelaunch.xcconfig"
@@ -1 +0,0 @@
#include "ConfigRelaunch.xcconfig"
@@ -0,0 +1,7 @@
// sparkle command line tool only
INFOPLIST_FILE = sparkle-cli/Info.plist
PRODUCT_BUNDLE_IDENTIFIER = org.sparkle-project.sparkle-cli
PRODUCT_NAME = sparkle
LD_RUNPATH_SEARCH_PATHS = @executable_path/../Frameworks/
ENABLE_HARDENED_RUNTIME = NO
+1 -1
View File
@@ -1,2 +1,2 @@
SWIFT_VERSION = 4.2
SWIFT_VERSION = 5
SWIFT_SWIFT3_OBJC_INFERENCE = Off;
+2 -1
View File
@@ -1 +1,2 @@
SWIFT_OPTIMIZATION_LEVEL = -Owholemodule
SWIFT_OPTIMIZATION_LEVEL = -O
SWIFT_COMPILATION_MODE = wholemodule
+3 -3
View File
@@ -1,9 +1,9 @@
// Test Application only
// Test Application
INFOPLIST_FILE = TestApplication/TestApplication-Info.plist
WRAPPER_EXTENSION = app
ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon
ASSETCATALOG_COMPILER_APPICON_NAME = $(SPARKLE_ICON_NAME)
LD_RUNPATH_SEARCH_PATHS = @executable_path/../Frameworks
PRODUCT_BUNDLE_IDENTIFIER = org.sparkle-project.SparkleTestApp
CODE_SIGN_ENTITLEMENTS = TestApplication/Sparkle-Test-App.entitlements
ENABLE_HARDENED_RUNTIME = NO
CODE_SIGN_IDENTITY = -
+1 -1
View File
@@ -1,2 +1,2 @@
// Test Application Debug
#include "ConfigTestApp.xcconfig"
@@ -0,0 +1,7 @@
// Test Application Helper
INFOPLIST_FILE = TestAppHelper/Info.plist
WRAPPER_EXTENSION = xpc
LD_RUNPATH_SEARCH_PATHS = @executable_path/../../../../Frameworks
PRODUCT_BUNDLE_IDENTIFIER = org.sparkle-project.TestAppHelper
ENABLE_HARDENED_RUNTIME = NO
Loaded 100 of 673 files, more files were not shown because too many files have changed in this diff. Show more