Add launchd-based system scheduling and UI support for system-scheduled timers #3
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,128 @@ | ||
| // | ||
| // LaunchAgentScheduler.swift | ||
| // AutoRun | ||
| // | ||
| // Created by OpenAI on 21.07.26. | ||
| // | ||
|
|
||
| import Foundation | ||
| import Darwin | ||
|
|
||
| /// Installs per-user LaunchAgent jobs so repeating timers can run even when | ||
| /// AutoRun is not actively counting down in the foreground. | ||
| enum LaunchAgentScheduler { | ||
| enum SchedulerError: Error { | ||
| case invalidInterval | ||
| case invalidLaunchValue | ||
| case unsupportedOneShotTimer | ||
| case unsupportedHomeDirectory | ||
| } | ||
|
|
||
| static func isSupported(timer: TimerItem) -> Bool { | ||
| timer.doesRepeat && timer.interval >= 1 | ||
| } | ||
|
|
||
| static func install(timer: TimerItem) throws { | ||
| guard isSupported(timer: timer) else { throw SchedulerError.unsupportedOneShotTimer } | ||
| guard timer.interval >= 1 else { throw SchedulerError.invalidInterval } | ||
|
|
||
| let launchAgentsDirectory = try launchAgentsDirectory() | ||
| try FileManager.default.createDirectory( | ||
| at: launchAgentsDirectory, | ||
| withIntermediateDirectories: true, | ||
| attributes: nil | ||
| ) | ||
|
|
||
| let plistURL = plistURL(for: timer) | ||
| let plist = try propertyList(for: timer) | ||
| let data = try PropertyListSerialization.data( | ||
| fromPropertyList: plist, | ||
| format: .xml, | ||
| options: 0 | ||
| ) | ||
| try data.write(to: plistURL, options: .atomic) | ||
|
|
||
| _ = runLaunchctl(arguments: ["bootout", "gui/\(getuid())", plistURL.path], allowFailure: true) | ||
| try runLaunchctl(arguments: ["bootstrap", "gui/\(getuid())", plistURL.path]) | ||
| try runLaunchctl(arguments: ["enable", "gui/\(getuid())/\(label(for: timer))"]) | ||
| } | ||
|
|
||
| static func uninstall(timer: TimerItem) { | ||
| let plistURL = plistURL(for: timer) | ||
| _ = runLaunchctl(arguments: ["bootout", "gui/\(getuid())", plistURL.path], allowFailure: true) | ||
| try? FileManager.default.removeItem(at: plistURL) | ||
| } | ||
|
|
||
| static func isInstalled(timer: TimerItem) -> Bool { | ||
| FileManager.default.fileExists(atPath: plistURL(for: timer).path) | ||
| } | ||
|
|
||
| static func label(for timer: TimerItem) -> String { | ||
| let identifier = timer.persistentModelID.id.description | ||
| .replacingOccurrences(of: "[^A-Za-z0-9.-]", with: "-", options: .regularExpression) | ||
| return "de.holgerkrupp.AutoRun.timer.\(identifier)" | ||
| } | ||
|
|
||
| private static func propertyList(for timer: TimerItem) throws -> [String: Any] { | ||
| let arguments = try programArguments(for: timer) | ||
| return [ | ||
| "Label": label(for: timer), | ||
| "ProgramArguments": arguments, | ||
| "StartInterval": Int(timer.interval.rounded()), | ||
| "RunAtLoad": false, | ||
| "StandardOutPath": logURL(for: timer, suffix: "out").path, | ||
| "StandardErrorPath": logURL(for: timer, suffix: "err").path | ||
| ] | ||
| } | ||
|
|
||
| private static func programArguments(for timer: TimerItem) throws -> [String] { | ||
| switch timer.launchType { | ||
| case .app: | ||
| guard let url = URL(string: timer.launchValue) else { throw SchedulerError.invalidLaunchValue } | ||
| return ["/usr/bin/open", url.path] | ||
| case .script: | ||
| guard timer.launchValue.isEmpty == false else { throw SchedulerError.invalidLaunchValue } | ||
| return ["/bin/zsh", "-c", timer.launchValue] | ||
| } | ||
| } | ||
|
|
||
| private static func launchAgentsDirectory() throws -> URL { | ||
| guard let home = FileManager.default.urls(for: .libraryDirectory, in: .userDomainMask).first else { | ||
| throw SchedulerError.unsupportedHomeDirectory | ||
| } | ||
| return home.appendingPathComponent("LaunchAgents", isDirectory: true) | ||
| } | ||
|
|
||
| private static func plistURL(for timer: TimerItem) -> URL { | ||
| (try? launchAgentsDirectory())?.appendingPathComponent("\(label(for: timer)).plist") | ||
| ?? URL(fileURLWithPath: NSTemporaryDirectory()).appendingPathComponent("\(label(for: timer)).plist") | ||
| } | ||
|
|
||
| private static func logURL(for timer: TimerItem, suffix: String) -> URL { | ||
| FileManager.default.temporaryDirectory.appendingPathComponent("\(label(for: timer)).\(suffix).log") | ||
| } | ||
|
|
||
| @discardableResult | ||
| private static func runLaunchctl(arguments: [String], allowFailure: Bool = false) throws -> String { | ||
| let process = Process() | ||
| let output = Pipe() | ||
| let error = Pipe() | ||
| process.executableURL = URL(fileURLWithPath: "/bin/launchctl") | ||
| process.arguments = arguments | ||
| process.standardOutput = output | ||
| process.standardError = error | ||
| try process.run() | ||
| process.waitUntilExit() | ||
|
|
||
| let outputText = String(data: output.fileHandleForReading.readDataToEndOfFile(), encoding: .utf8) ?? "" | ||
| let errorText = String(data: error.fileHandleForReading.readDataToEndOfFile(), encoding: .utf8) ?? "" | ||
| if process.terminationStatus != 0 && allowFailure == false { | ||
| throw NSError( | ||
| domain: "LaunchAgentScheduler", | ||
| code: Int(process.terminationStatus), | ||
| userInfo: [NSLocalizedDescriptionKey: errorText.isEmpty ? outputText : errorText] | ||
| ) | ||
| } | ||
| return outputText | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
With AutoRun.entitlements enabling the App Sandbox,
FileManager.default.urls(for: .libraryDirectory, in: .userDomainMask)resolves inside the app container rather than the user's~/Library. That means these plists are written under the container'sLibrary/LaunchAgents, so after a logout/reboot launchd will not auto-load them from the standard per-user LaunchAgents directory, whilereconcileSystemScheduleState()can still mark the timer active just because the container plist exists; users then see an active system-scheduled timer that never fires.Useful? React with 👍 / 👎.