Implemented SetTunnelStatus intent

Signed-off-by: Alessio Nossa <alessio.nossa@gmail.com>
2022-02-01 13:28:33 +01:00
parent fe3f2d089b
commit bb6ea1b2f3
4 changed files with 487 additions and 2 deletions
@@ -33,6 +33,7 @@
 			<key>IntentsSupported</key>
 			<array>
 				<string>GetPeersIntent</string>
+				<string>SetTunnelStatusIntent</string>
 				<string>UpdateConfigurationIntent</string>
 			</array>
 		</dict>
@@ -11,7 +11,9 @@ class IntentHandler: INExtension {
    }

    override func handler(for intent: INIntent) -> Any {
-        guard intent is GetPeersIntent || intent is UpdateConfigurationIntent else {
+        guard intent is GetPeersIntent ||
+                intent is UpdateConfigurationIntent ||
+                intent is SetTunnelStatusIntent else {
            fatalError("Unhandled intent type: \(intent)")
        }

@@ -15,6 +15,8 @@ class IntentHandling: NSObject {

    var onTunnelsManagerReady: ((TunnelsManager) -> Void)?

+    var onTunnelStatusActivationReturn: ((Bool) -> Void)?
+
    override init() {
        super.init()

@@ -27,6 +29,8 @@ class IntentHandling: NSObject {
            case .success(let tunnelsManager):
                self.tunnelsManager = tunnelsManager

+                self.tunnelsManager?.activationDelegate = self
+
                self.onTunnelsManagerReady?(tunnelsManager)
                self.onTunnelsManagerReady = nil
            }
@@ -170,3 +174,129 @@ extension IntentHandling: UpdateConfigurationIntentHandling {
    }

 }
+
+extension IntentHandling: SetTunnelStatusIntentHandling {
+
+    @available(iOSApplicationExtension 14.0, *)
+    func provideTunnelOptionsCollection(for intent: SetTunnelStatusIntent, with completion: @escaping (INObjectCollection<NSString>?, Error?) -> Void) {
+
+        self.allTunnelNames { tunnelsNames in
+            let tunnelsNamesObjects = (tunnelsNames ?? []).map { NSString(string: $0) }
+
+            let objectCollection = INObjectCollection(items: tunnelsNamesObjects)
+            completion(objectCollection, nil)
+        }
+    }
+
+    func handle(intent: SetTunnelStatusIntent, completion: @escaping (SetTunnelStatusIntentResponse) -> Void) {
+        guard let tunnelName = intent.tunnel else {
+            return completion(SetTunnelStatusIntentResponse(code: .failure, userActivity: nil))
+        }
+
+        let setTunnelStatusResultBlock: (Bool) -> Void = { result in
+            if result {
+                completion(SetTunnelStatusIntentResponse(code: .success, userActivity: nil))
+            } else {
+                completion(SetTunnelStatusIntentResponse(code: .failure, userActivity: nil))
+            }
+        }
+
+        let updateStatusBlock: (TunnelsManager) -> Void = { tunnelsManager in
+            guard let tunnel = tunnelsManager.tunnel(named: tunnelName) else {
+                completion(SetTunnelStatusIntentResponse(code: .failure, userActivity: nil))
+                return
+            }
+
+            let operation = intent.operation
+            let isOn: Bool
+
+            if operation == .toggle {
+                switch tunnel.status {
+                case .inactive:
+                    isOn = true
+                case .active:
+                    isOn = false
+                default:
+                    wg_log(.error, message: "SetTunnelStatusIntent action cannot be executed due to the current state of \(tunnelName) tunnel: \(tunnel.status)")
+                    completion(SetTunnelStatusIntentResponse(code: .failure, userActivity: nil))
+                    return
+                }
+
+            } else if operation == .turn {
+                if (tunnel.status == .inactive) || (tunnel.status == .active) {
+                    isOn = (intent.state == .on)
+
+                    if (isOn && tunnel.status == .active) || (!isOn && tunnel.status == .inactive) {
+                        wg_log(.debug, message: "Tunnel \(tunnelName) is already \(isOn ? "active" : "inactive")")
+                        completion(SetTunnelStatusIntentResponse(code: .success, userActivity: nil))
+                        return
+                    }
+                } else {
+                    wg_log(.error, message: "SetTunnelStatusIntent action cannot be executed due to the current state of \(tunnelName) tunnel: \(tunnel.status)")
+                    completion(SetTunnelStatusIntentResponse(code: .failure, userActivity: nil))
+                    return
+                }
+
+            } else {
+                wg_log(.error, message: "Invalid 'operation' option in action")
+                completion(SetTunnelStatusIntentResponse(code: .failure, userActivity: nil))
+                return
+            }
+
+            if tunnel.hasOnDemandRules {
+                tunnelsManager.setOnDemandEnabled(isOn, on: tunnel) { error in
+                    guard error == nil else {
+                        wg_log(.error, message: "Error setting OnDemand status: \(error!.localizedDescription).")
+                        completion(SetTunnelStatusIntentResponse(code: .failure, userActivity: nil))
+                        return
+                    }
+
+                    if !isOn {
+                        tunnelsManager.startDeactivation(of: tunnel)
+                    }
+
+                    completion(SetTunnelStatusIntentResponse(code: .success, userActivity: nil))
+                }
+            } else {
+                if isOn {
+                    self.onTunnelStatusActivationReturn = setTunnelStatusResultBlock
+                    tunnelsManager.startActivation(of: tunnel)
+                } else {
+                    tunnelsManager.startDeactivation(of: tunnel)
+                    completion(SetTunnelStatusIntentResponse(code: .success, userActivity: nil))
+                }
+            }
+        }
+
+        if let tunnelsManager = tunnelsManager {
+            updateStatusBlock(tunnelsManager)
+        } else {
+            if onTunnelsManagerReady != nil {
+                wg_log(.error, message: "Overriding onTunnelsManagerReady action in allTunnelPeers function. This should not happen.")
+            }
+            onTunnelsManagerReady = updateStatusBlock
+        }
+    }
+
+}
+
+extension IntentHandling: TunnelsManagerActivationDelegate {
+    func tunnelActivationAttemptFailed(tunnel: TunnelContainer, error: TunnelsManagerActivationAttemptError) {
+        wg_log(.error, message: "Tunnel Activation Attempt Failed with error: \(error.localizedDescription)")
+        self.onTunnelStatusActivationReturn?(false)
+    }
+
+    func tunnelActivationAttemptSucceeded(tunnel: TunnelContainer) {
+        // Nothing to do, we wait tunnelActivationSucceeded to be sure all activation logic has been executed
+    }
+
+    func tunnelActivationFailed(tunnel: TunnelContainer, error: TunnelsManagerActivationError) {
+        wg_log(.error, message: "Tunnel Activation Failed with error: \(error.localizedDescription)")
+        self.onTunnelStatusActivationReturn?(false)
+    }
+
+    func tunnelActivationSucceeded(tunnel: TunnelContainer) {
+        self.onTunnelStatusActivationReturn?(true)
+    }
+
+}