add logic for acceptableUpdatePreparingUsage

Author: erikng

CHANGELOG.md

@@ -76,6 +76,10 @@ Requires macOS 12.0 and higher. Further releases and feature requests may make t
   - [Issue 548](https://github.com/macadmins/nudge/issues/548)
 - When the device is running macOS 12.3 or higher, Nudge uses the delta logic for macOS Upgrades
   - [Issue 417](https://github.com/macadmins/nudge/issues/417)
+- Nudge can now bypass activations and re-activations when a macOS update is `Downloading`, `Preparing` or `Staged` for installation.
+  - To enable this, please configure the `acceptableUpdatePreparingUsage` key under `optionalFeatures` to true
+  - Be aware that the current logic used for this **cannot differentiate** when an update has completed preparing and is in the `Staged` phase, waiting for a user to reboot. This is due to an Apple process staying in memory. This will result in a reduction in Nudge re-activations
+  - Issue [555](https://github.com/macadmins/nudge/issues/555)
 
 ## [1.1.16] - 2024-03-13
 This will be the **final Nudge release** for macOS 11 and potentially other versions of macOS.

Nudge/Preferences/DefaultPreferencesNudge.swift

@@ -82,6 +82,12 @@ struct OptionalFeatureVariables {
         optionalFeaturesJSON?.acceptableCameraUsage ??
         false
     }
+
+    static var acceptableUpdatePreparingUsage: Bool {
+        optionalFeaturesProfile?["acceptableUpdatePreparingUsage"] as? Bool ??
+        optionalFeaturesJSON?.acceptableUpdatePreparingUsage ??
+        false
+    }
 
     static var acceptableScreenSharingUsage: Bool {
         optionalFeaturesProfile?["acceptableScreenSharingUsage"] as? Bool ??

Nudge/Preferences/PreferencesStructure.swift

@@ -66,7 +66,7 @@ extension NudgePreferences {
 // MARK: - OptionalFeatures
 struct OptionalFeatures: Codable {
     var acceptableApplicationBundleIDs, acceptableAssertionApplicationNames: [String]?
-    var acceptableAssertionUsage, acceptableCameraUsage, acceptableScreenSharingUsage, aggressiveUserExperience, aggressiveUserFullScreenExperience, asynchronousSoftwareUpdate, attemptToBlockApplicationLaunches, attemptToCheckForSupportedDevice, attemptToFetchMajorUpgrade: Bool?
+    var acceptableAssertionUsage, acceptableCameraUsage, acceptableUpdatePreparingUsage, acceptableScreenSharingUsage, aggressiveUserExperience, aggressiveUserFullScreenExperience, asynchronousSoftwareUpdate, attemptToBlockApplicationLaunches, attemptToCheckForSupportedDevice, attemptToFetchMajorUpgrade: Bool?
     var blockedApplicationBundleIDs: [String]?
     var customSOFAFeedURL: String?
     var disableNudgeForStandardInstalls, disableSoftwareUpdateWorkflow, enforceMinorUpdates, honorFocusModes, honorCycleTimersOnExit: Bool?
@@ -97,6 +97,7 @@ extension OptionalFeatures {
         acceptableAssertionApplicationNames: [String]? = nil,
         acceptableAssertionUsage: Bool? = nil,
         acceptableCameraUsage: Bool? = nil,
+        acceptableUpdatePreparingUsage: Bool? = nil,
         acceptableScreenSharingUsage: Bool? = nil,
         aggressiveUserExperience: Bool? = nil,
         aggressiveUserFullScreenExperience: Bool? = nil,
@@ -120,6 +121,7 @@ extension OptionalFeatures {
             acceptableAssertionApplicationNames: acceptableAssertionApplicationNames ?? self.acceptableAssertionApplicationNames,
             acceptableAssertionUsage: acceptableAssertionUsage ?? self.acceptableAssertionUsage,
             acceptableCameraUsage: acceptableCameraUsage ?? self.acceptableCameraUsage,
+            acceptableUpdatePreparingUsage: acceptableUpdatePreparingUsage ?? self.acceptableUpdatePreparingUsage,
             acceptableScreenSharingUsage: acceptableScreenSharingUsage ?? self.acceptableScreenSharingUsage,
             aggressiveUserExperience: aggressiveUserExperience ?? self.aggressiveUserExperience,
             aggressiveUserFullScreenExperience: aggressiveUserFullScreenExperience ?? self.aggressiveUserFullScreenExperience,

Nudge/Utilities/UILogic.swift

@@ -6,10 +6,17 @@
 //
 
 import AppKit
+import Darwin
 import Foundation
 import IOKit.pwr_mgt // Asertions
 import SwiftUI
 
+struct ProcessInfoStruct {
+    var pid: Int32
+    var command: String
+    var arguments: [String]
+}
+
 func initialLaunchLogic() {
     guard !CommandLineUtilities().unitTestingEnabled() else {
         LogManager.debug("App being ran in test mode", logger: uiLog)
@@ -177,6 +184,88 @@ private func logDeferralStates() {
     LoggerUtilities().logUserDeferrals()
 }
 
+func getAllProcesses() -> [ProcessInfoStruct] {
+    var processes = [ProcessInfoStruct]()
+    
+    // Get the number of processes
+    var mib: [Int32] = [CTL_KERN, KERN_PROC, KERN_PROC_ALL]
+    var size = 0
+    sysctl(&mib, u_int(mib.count), nil, &size, nil, 0)
+    
+    let processCount = size / MemoryLayout<kinfo_proc>.size
+    var processList = [kinfo_proc](repeating: kinfo_proc(), count: processCount)
+    
+    // Get the list of processes
+    sysctl(&mib, u_int(mib.count), &processList, &size, nil, 0)
+    
+    // Extract process info
+    for process in processList {
+        let command = withUnsafePointer(to: process.kp_proc.p_comm) {
+            $0.withMemoryRebound(to: CChar.self, capacity: Int(MAXCOMLEN)) {
+                String(cString: $0)
+            }
+        }
+        let pid = process.kp_proc.p_pid
+        let arguments = getArgumentsForPID(pid: pid)
+        processes.append(ProcessInfoStruct(pid: pid, command: command, arguments: arguments))
+    }
+    
+    return processes
+}
+
+func getArgumentsForPID(pid: Int32) -> [String] {
+    var args = [String]()
+    
+    var mib: [Int32] = [CTL_KERN, KERN_PROCARGS2, pid]
+    var size = 0
+    sysctl(&mib, u_int(mib.count), nil, &size, nil, 0)
+    
+    var buffer = [CChar](repeating: 0, count: size)
+    sysctl(&mib, u_int(mib.count), &buffer, &size, nil, 0)
+    
+    // Convert buffer to a string with proper bounds checking
+    let bufferString = String(bytesNoCopy: &buffer, length: size, encoding: .ascii, freeWhenDone: false)
+    
+    // Split the string into arguments
+    if let bufferString = bufferString {
+        args = bufferString.split(separator: "\0").map { String($0) }
+    }
+    
+    // Drop the first element which is the full path to the executable
+    if !args.isEmpty {
+        args.removeFirst()
+    }
+    
+    return args
+}
+
+func isAnyProcessRunning(commandsWithArgs: [(commandPattern: String, arguments: [String]?)]) -> Bool {
+    let processes = getAllProcesses()
+    for (commandPattern, arguments) in commandsWithArgs {
+        let matchingProcesses = processes.filter { process in
+            fnmatch(commandPattern, process.command, 0) == 0 &&
+            (arguments == nil || arguments!.allSatisfy { arg in
+                process.arguments.contains(where: { $0.contains(arg) })
+            })
+        }
+        if !matchingProcesses.isEmpty {
+            return true
+        }
+    }
+    return false
+}
+
+func isDownloadingOrPreparingSoftwareUpdate() -> Bool {
+    let commandsWithArgs: [(commandPattern: String, arguments: [String]?)] = [
+        ("softwareupdated", ["/System/Library/PrivateFrameworks/MobileSoftwareUpdate.framework/Support/softwareupdated"]), // When downloading a minor update, this process is running.
+        ("installcoordinationd", ["/System/Library/PrivateFrameworks/InstallCoordination.framework/Support/installcoordinationd"]), // When preparing a minor update, this process is running. Unfortunately, after preparing the update, this process appears to stay running.
+        ("softwareupdate", ["/usr/bin/softwareupdate", "--fetch-full-installer"]), // When downloading a major upgrade via SoftwareUpdate prefpane, it triggers a --fetch-full-installer run. Nudge also performs this method.
+        ("osinstallersetupd" ,["/Applications/*Install macOS *.app/Contents/Frameworks/OSInstallerSetup.framework/Resources/osinstallersetupd"]), // When installing a major upgrade, this process is running.
+        // /System/Library/PrivateFrameworks/PackageKit.framework/Resources/installd||system_installd - system_installd may be interesting, but I think installd is being used for any package
+    ]
+    return isAnyProcessRunning(commandsWithArgs: commandsWithArgs)
+}
+
 func needToActivateNudge() -> Bool {
     if NSApplication.shared.isActive && nudgeLogState.afterFirstLaunch {
         LogManager.notice("Nudge is currently the frontmostApplication", logger: uiLog)
@@ -265,6 +354,7 @@ private func shouldBailOutEarly() -> Bool {
     /// 6. Acceptable Assertions are on
     /// 7. Acceptable Apps are in front
     /// 8. Refresh Timer hasn't been met
+    /// 9. macOS Updates are downloading or preparing for installation
     let frontmostApplication = NSWorkspace.shared.frontmostApplication
     let pastRequiredInstallationDate = DateManager().pastRequiredInstallationDate()
 
@@ -313,6 +403,12 @@ private func shouldBailOutEarly() -> Bool {
     if isRefreshTimerPassedThreshold() {
         return true
     }
+    
+    // Check if downloading or preparing updates
+    if OptionalFeatureVariables.acceptableUpdatePreparingUsage && isDownloadingOrPreparingSoftwareUpdate() {
+        LogManager.info("Ignoring Nudge activation - macOS is currently downloading or preparing an update", logger: uiLog)
+        return true
+    }
 
     return false
 }