Implemented SetTunnelStatus intent

Signed-off-by: Alessio Nossa <alessio.nossa@gmail.com>

4 files changed, 487 insertions, 2 deletions

diff --git a/Sources/Shared/Intents.intentdefinition b/Sources/Shared/Intents.intentdefinition
index 590fa39..6f2d38c 100644
--- a/Sources/Shared/Intents.intentdefinition
+++ b/Sources/Shared/Intents.intentdefinition
@@ -3,7 +3,94 @@
 <plist version="1.0">
 <dict>
 	<key>INEnums</key>
-	<array/>
+	<array>
+		<dict>
+			<key>INEnumDisplayName</key>
+			<string>State</string>
+			<key>INEnumDisplayNameID</key>
+			<string>kiXIKs</string>
+			<key>INEnumGeneratesHeader</key>
+			<true/>
+			<key>INEnumName</key>
+			<string>State</string>
+			<key>INEnumType</key>
+			<string>State</string>
+			<key>INEnumValues</key>
+			<array>
+				<dict>
+					<key>INEnumValueDisplayName</key>
+					<string>unknown</string>
+					<key>INEnumValueDisplayNameID</key>
+					<string>57IgER</string>
+					<key>INEnumValueName</key>
+					<string>unknown</string>
+				</dict>
+				<dict>
+					<key>INEnumValueDisplayName</key>
+					<string>on</string>
+					<key>INEnumValueDisplayNameID</key>
+					<string>tbFf8o</string>
+					<key>INEnumValueIndex</key>
+					<integer>1</integer>
+					<key>INEnumValueName</key>
+					<string>on</string>
+				</dict>
+				<dict>
+					<key>INEnumValueDisplayName</key>
+					<string>off</string>
+					<key>INEnumValueDisplayNameID</key>
+					<string>7lY4Sc</string>
+					<key>INEnumValueIndex</key>
+					<integer>2</integer>
+					<key>INEnumValueName</key>
+					<string>off</string>
+				</dict>
+			</array>
+		</dict>
+		<dict>
+			<key>INEnumDisplayName</key>
+			<string>Operation</string>
+			<key>INEnumDisplayNameID</key>
+			<string>urZ7WZ</string>
+			<key>INEnumGeneratesHeader</key>
+			<true/>
+			<key>INEnumName</key>
+			<string>Operation</string>
+			<key>INEnumType</key>
+			<string>Regular</string>
+			<key>INEnumValues</key>
+			<array>
+				<dict>
+					<key>INEnumValueDisplayName</key>
+					<string>unknown</string>
+					<key>INEnumValueDisplayNameID</key>
+					<string>efZxZH</string>
+					<key>INEnumValueName</key>
+					<string>unknown</string>
+				</dict>
+				<dict>
+					<key>INEnumValueDisplayName</key>
+					<string>Turn</string>
+					<key>INEnumValueDisplayNameID</key>
+					<string>viQ2K7</string>
+					<key>INEnumValueIndex</key>
+					<integer>1</integer>
+					<key>INEnumValueName</key>
+					<string>turn</string>
+				</dict>
+				<dict>
+					<key>INEnumValueDisplayName</key>
+					<string>Toggle</string>
+					<key>INEnumValueDisplayNameID</key>
+					<string>N4IzMI</string>
+					<key>INEnumValueIndex</key>
+					<integer>2</integer>
+					<key>INEnumValueName</key>
+					<string>toggle</string>
+				</dict>
+			</array>
+		</dict>
+	</array>
 	<key>INIntentDefinitionModelVersion</key>
 	<string>1.2</string>
 	<key>INIntentDefinitionNamespace</key>
@@ -360,6 +447,271 @@ Example
 			<key>INIntentVerb</key>
 			<string>Do</string>
 		</dict>
+		<dict>
+			<key>INIntentCategory</key>
+			<string>toggle</string>
+			<key>INIntentConfigurable</key>
+			<true/>
+			<key>INIntentDescription</key>
+			<string>Enables or disables a tunnel.
+
+The action will not return an error if there are problems during the activation, it just launches the procedure.</string>
+			<key>INIntentDescriptionID</key>
+			<string>T7NEBw</string>
+			<key>INIntentEligibleForWidgets</key>
+			<true/>
+			<key>INIntentLastParameterTag</key>
+			<integer>4</integer>
+			<key>INIntentManagedParameterCombinations</key>
+			<dict>
+				<key>state,tunnel,operation</key>
+				<dict>
+					<key>INIntentParameterCombinationSupportsBackgroundExecution</key>
+					<true/>
+					<key>INIntentParameterCombinationTitle</key>
+					<string>${operation} ${tunnel} tunnel ${state}</string>
+					<key>INIntentParameterCombinationTitleID</key>
+					<string>juDVvv</string>
+					<key>INIntentParameterCombinationUpdatesLinked</key>
+					<true/>
+				</dict>
+				<key>tunnel,operation</key>
+				<dict>
+					<key>INIntentParameterCombinationSupportsBackgroundExecution</key>
+					<true/>
+					<key>INIntentParameterCombinationTitle</key>
+					<string>${operation} ${tunnel} tunnel</string>
+					<key>INIntentParameterCombinationTitleID</key>
+					<string>kMEAI0</string>
+				</dict>
+			</dict>
+			<key>INIntentName</key>
+			<string>SetTunnelStatus</string>
+			<key>INIntentParameterCombinations</key>
+			<dict>
+				<key>state,tunnel,operation</key>
+				<dict>
+					<key>INIntentParameterCombinationIsLinked</key>
+					<true/>
+					<key>INIntentParameterCombinationSupportsBackgroundExecution</key>
+					<true/>
+					<key>INIntentParameterCombinationTitle</key>
+					<string>${operation} ${tunnel} tunnel ${state}</string>
+					<key>INIntentParameterCombinationTitleID</key>
+					<string>SjQ7Ur</string>
+				</dict>
+			</dict>
+			<key>INIntentParameters</key>
+			<array>
+				<dict>
+					<key>INIntentParameterConfigurable</key>
+					<true/>
+					<key>INIntentParameterDisplayName</key>
+					<string>Tunnel</string>
+					<key>INIntentParameterDisplayNameID</key>
+					<string>mbhQcc</string>
+					<key>INIntentParameterDisplayPriority</key>
+					<integer>1</integer>
+					<key>INIntentParameterMetadata</key>
+					<dict>
+						<key>INIntentParameterMetadataCapitalization</key>
+						<string>Sentences</string>
+						<key>INIntentParameterMetadataDefaultValueID</key>
+						<string>iBD5fT</string>
+					</dict>
+					<key>INIntentParameterName</key>
+					<string>tunnel</string>
+					<key>INIntentParameterPromptDialogs</key>
+					<array>
+						<dict>
+							<key>INIntentParameterPromptDialogCustom</key>
+							<true/>
+							<key>INIntentParameterPromptDialogType</key>
+							<string>Configuration</string>
+						</dict>
+						<dict>
+							<key>INIntentParameterPromptDialogCustom</key>
+							<true/>
+							<key>INIntentParameterPromptDialogType</key>
+							<string>Primary</string>
+						</dict>
+						<dict>
+							<key>INIntentParameterPromptDialogCustom</key>
+							<true/>
+							<key>INIntentParameterPromptDialogFormatString</key>
+							<string>There are ${count} options matching ‘${tunnel}’.</string>
+							<key>INIntentParameterPromptDialogFormatStringID</key>
+							<string>73NvEc</string>
+							<key>INIntentParameterPromptDialogType</key>
+							<string>DisambiguationIntroduction</string>
+						</dict>
+						<dict>
+							<key>INIntentParameterPromptDialogCustom</key>
+							<true/>
+							<key>INIntentParameterPromptDialogFormatString</key>
+							<string>Just to confirm, you wanted ‘${tunnel}’?</string>
+							<key>INIntentParameterPromptDialogFormatStringID</key>
+							<string>63TirR</string>
+							<key>INIntentParameterPromptDialogType</key>
+							<string>Confirmation</string>
+						</dict>
+					</array>
+					<key>INIntentParameterSupportsDynamicEnumeration</key>
+					<true/>
+					<key>INIntentParameterTag</key>
+					<integer>2</integer>
+					<key>INIntentParameterType</key>
+					<string>String</string>
+				</dict>
+				<dict>
+					<key>INIntentParameterConfigurable</key>
+					<true/>
+					<key>INIntentParameterDisplayName</key>
+					<string>Operation</string>
+					<key>INIntentParameterDisplayNameID</key>
+					<string>U9YFTG</string>
+					<key>INIntentParameterDisplayPriority</key>
+					<integer>2</integer>
+					<key>INIntentParameterEnumType</key>
+					<string>Operation</string>
+					<key>INIntentParameterEnumTypeNamespace</key>
+					<string>6NREiY</string>
+					<key>INIntentParameterMetadata</key>
+					<dict>
+						<key>INIntentParameterMetadataDefaultValue</key>
+						<string>turn</string>
+					</dict>
+					<key>INIntentParameterName</key>
+					<string>operation</string>
+					<key>INIntentParameterPromptDialogs</key>
+					<array>
+						<dict>
+							<key>INIntentParameterPromptDialogCustom</key>
+							<true/>
+							<key>INIntentParameterPromptDialogType</key>
+							<string>Configuration</string>
+						</dict>
+						<dict>
+							<key>INIntentParameterPromptDialogCustom</key>
+							<true/>
+							<key>INIntentParameterPromptDialogType</key>
+							<string>Primary</string>
+						</dict>
+						<dict>
+							<key>INIntentParameterPromptDialogCustom</key>
+							<true/>
+							<key>INIntentParameterPromptDialogFormatString</key>
+							<string>There are ${count} options matching ‘${operation}’.</string>
+							<key>INIntentParameterPromptDialogFormatStringID</key>
+							<string>SALmBF</string>
+							<key>INIntentParameterPromptDialogType</key>
+							<string>DisambiguationIntroduction</string>
+						</dict>
+						<dict>
+							<key>INIntentParameterPromptDialogCustom</key>
+							<true/>
+							<key>INIntentParameterPromptDialogFormatString</key>
+							<string>Just to confirm, you wanted ‘${operation}’?</string>
+							<key>INIntentParameterPromptDialogFormatStringID</key>
+							<string>vB13mD</string>
+							<key>INIntentParameterPromptDialogType</key>
+							<string>Confirmation</string>
+						</dict>
+					</array>
+					<key>INIntentParameterTag</key>
+					<integer>4</integer>
+					<key>INIntentParameterType</key>
+					<string>Integer</string>
+				</dict>
+				<dict>
+					<key>INIntentParameterConfigurable</key>
+					<true/>
+					<key>INIntentParameterDisplayName</key>
+					<string>State</string>
+					<key>INIntentParameterDisplayNameID</key>
+					<string>sLIh6r</string>
+					<key>INIntentParameterDisplayPriority</key>
+					<integer>3</integer>
+					<key>INIntentParameterEnumType</key>
+					<string>State</string>
+					<key>INIntentParameterEnumTypeNamespace</key>
+					<string>6NREiY</string>
+					<key>INIntentParameterMetadata</key>
+					<dict>
+						<key>INIntentParameterMetadataDefaultValue</key>
+						<string>on</string>
+					</dict>
+					<key>INIntentParameterName</key>
+					<string>state</string>
+					<key>INIntentParameterRelationship</key>
+					<dict>
+						<key>INIntentParameterRelationshipParentName</key>
+						<string>operation</string>
+						<key>INIntentParameterRelationshipPredicateName</key>
+						<string>EnumHasExactValue</string>
+						<key>INIntentParameterRelationshipPredicateValue</key>
+						<string>turn</string>
+					</dict>
+					<key>INIntentParameterTag</key>
+					<integer>1</integer>
+					<key>INIntentParameterType</key>
+					<string>Integer</string>
+				</dict>
+			</array>
+			<key>INIntentResponse</key>
+			<dict>
+				<key>INIntentResponseCodes</key>
+				<array>
+					<dict>
+						<key>INIntentResponseCodeName</key>
+						<string>success</string>
+						<key>INIntentResponseCodeSuccess</key>
+						<true/>
+					</dict>
+					<dict>
+						<key>INIntentResponseCodeName</key>
+						<string>failure</string>
+					</dict>
+				</array>
+				<key>INIntentResponseLastParameterTag</key>
+				<integer>1</integer>
+				<key>INIntentResponseParameters</key>
+				<array>
+					<dict>
+						<key>INIntentResponseParameterConfigurable</key>
+						<true/>
+						<key>INIntentResponseParameterCustomDisambiguation</key>
+						<true/>
+						<key>INIntentResponseParameterDisplayName</key>
+						<string>State</string>
+						<key>INIntentResponseParameterDisplayNameID</key>
+						<string>TXqy56</string>
+						<key>INIntentResponseParameterDisplayPriority</key>
+						<integer>1</integer>
+						<key>INIntentResponseParameterEnumType</key>
+						<string>State</string>
+						<key>INIntentResponseParameterEnumTypeNamespace</key>
+						<string>6NREiY</string>
+						<key>INIntentResponseParameterName</key>
+						<string>state</string>
+						<key>INIntentResponseParameterSupportsResolution</key>
+						<true/>
+						<key>INIntentResponseParameterTag</key>
+						<integer>1</integer>
+						<key>INIntentResponseParameterType</key>
+						<string>Integer</string>
+					</dict>
+				</array>
+			</dict>
+			<key>INIntentTitle</key>
+			<string>Set Tunnel Status</string>
+			<key>INIntentTitleID</key>
+			<string>HULmDn</string>
+			<key>INIntentType</key>
+			<string>Custom</string>
+			<key>INIntentVerb</key>
+			<string>Toggle</string>
+		</dict>
 	</array>
 	<key>INTypes</key>
 	<array/>
diff --git a/Sources/WireGuardIntentsExtension/Info.plist b/Sources/WireGuardIntentsExtension/Info.plist
index 06ec3ab..fbe7d56 100644
--- a/Sources/WireGuardIntentsExtension/Info.plist
+++ b/Sources/WireGuardIntentsExtension/Info.plist
@@ -33,6 +33,7 @@
 			<key>IntentsSupported</key>
 			<array>
 				<string>GetPeersIntent</string>
+				<string>SetTunnelStatusIntent</string>
 				<string>UpdateConfigurationIntent</string>
 			</array>
 		</dict>
diff --git a/Sources/WireGuardIntentsExtension/IntentHandler.swift b/Sources/WireGuardIntentsExtension/IntentHandler.swift
index 62eb5e2..6f19951 100644
--- a/Sources/WireGuardIntentsExtension/IntentHandler.swift
+++ b/Sources/WireGuardIntentsExtension/IntentHandler.swift
@@ -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)")
         }
 
diff --git a/Sources/WireGuardIntentsExtension/IntentHandling.swift b/Sources/WireGuardIntentsExtension/IntentHandling.swift
index 1de3d46..78004e0 100644
--- a/Sources/WireGuardIntentsExtension/IntentHandling.swift
+++ b/Sources/WireGuardIntentsExtension/IntentHandling.swift
@@ -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)
+    }
+
+}