iOS/Sources/App/Frontend/Extensions/WebViewScriptMessageHandler.swift
Bruno Pantaleão Gonçalves e17f81f64b
Organize webview folder (#4324)
<!-- Thank you for submitting a Pull Request and helping to improve Home
Assistant. Please complete the following sections to help the processing
and review of your changes. Please do not delete anything from this
template. -->

## Summary
<!-- Provide a brief summary of the changes you have made and most
importantly what they aim to achieve -->

## Screenshots
<!-- If this is a user-facing change not in the frontend, please include
screenshots in light and dark mode. -->

## Link to pull request in Documentation repository
<!-- Pull requests that add, change or remove functionality must have a
corresponding pull request in the Companion App Documentation repository
(https://github.com/home-assistant/companion.home-assistant). Please add
the number of this pull request after the "#" -->
Documentation: home-assistant/companion.home-assistant#

## Any other notes
<!-- If there is any other information of note, like if this Pull
Request is part of a bigger change, please include it here. -->
2026-02-08 15:18:43 +01:00

138 lines
5.5 KiB
Swift

import Foundation
import PromiseKit
import Shared
import WebKit
enum WKUserContentControllerMessage: String, CaseIterable {
case externalBus
case updateThemeColors
case getExternalAuth
case revokeExternalAuth
case logError
}
final class WebViewScriptMessageHandler: NSObject, WKScriptMessageHandler {
weak var webView: WebViewControllerProtocol?
@MainActor func userContentController(
_ userContentController: WKUserContentController,
didReceive message: WKScriptMessage
) {
guard let messageBody = message.body as? [String: Any] else {
Current.Log.error("received message for \(message.name) but of type: \(type(of: message.body))")
return
}
Current.Log.verbose("message \(message.body)".replacingOccurrences(of: "\n", with: " "))
guard UIApplication.shared.applicationState != .background else {
Current.Log.verbose("Ignoring WKUserContentController message \(message.name) because app is in background")
return
}
switch WKUserContentControllerMessage(rawValue: message.name) {
case .externalBus:
handleExternalBus(messageBody)
case .updateThemeColors:
handleUpdateThemeColors(messageBody)
case .getExternalAuth:
handleGetExternalAuth(messageBody)
case .revokeExternalAuth:
handleRevokeExternalAuth(messageBody)
case .logError:
handleLogError(messageBody)
default:
Current.Log.error("unknown message: \(message.name)")
}
}
/// Handle theme changes from frontend, updating local cache and UI
private func handleThemeUpdate(_ messageBody: [String: Any]) {
guard let traitCollection = webView?.traitCollection else {
let message = "WebViewController missing traitCollection for theme update"
Current.Log.error(message)
assertionFailure(message)
return
}
ThemeColors.updateCache(with: messageBody, for: traitCollection)
webView?.styleUI()
}
/// Handles externalBus messages by passing them to the webViewExternalMessageHandler.
private func handleExternalBus(_ messageBody: [String: Any]) {
webView?.webViewExternalMessageHandler.handleExternalMessage(messageBody)
}
/// Updates the theme colors based on the message body.
private func handleUpdateThemeColors(_ messageBody: [String: Any]) {
handleThemeUpdate(messageBody)
}
/// Retrieves an authentication token for the web view and invokes a JavaScript callback with the result.
private func handleGetExternalAuth(_ messageBody: [String: Any]) {
guard let callbackName = messageBody["callback"], let server = webView?.server else { return }
let force = messageBody["force"] as? Bool ?? false
Current.Log.verbose("getExternalAuth called, forced: \(force)")
firstly {
Current.api(for: server)?.tokenManager
.authDictionaryForWebView(forceRefresh: force) ??
.init(error: HomeAssistantAPI.APIError.noAPIAvailable)
}.done { [weak self] dictionary in
let jsonData = try? JSONSerialization.data(withJSONObject: dictionary)
if let jsonString = String(data: jsonData!, encoding: .utf8) {
let script = "\(callbackName)(true, \(jsonString))"
self?.webView?.evaluateJavaScript(script, completion: { result, error in
if let error {
Current.Log.error("Failed to trigger getExternalAuth callback: \(error)")
}
Current.Log.verbose("Success on getExternalAuth callback: \(String(describing: result))")
})
}
}.catch { [weak self] error in
self?.webView?.evaluateJavaScript("\(callbackName)(false, 'Token unavailable')") {
_, error in
if let error {
Current.Log.error("Failed to trigger getExternalAuth callback: \(error)")
}
}
Current.Log.error("Failed to authenticate webview: \(error)")
}
}
/// Revokes the current authentication token and informs the web view via a JavaScript callback.
private func handleRevokeExternalAuth(_ messageBody: [String: Any]) {
guard let callbackName = messageBody["callback"], let server = webView?.server else { return }
Current.Log.warning("Revoking access token")
firstly {
Current.api(for: server)?.tokenManager
.revokeToken() ?? .init(error: HomeAssistantAPI.APIError.noAPIAvailable)
}.done { [weak self, server] _ in
Current.servers.remove(identifier: server.identifier)
let script = "\(callbackName)(true)"
Current.Log.verbose("Running revoke external auth callback \(script)")
self?.webView?.evaluateJavaScript(script) { _, error in
Current.onboardingObservation.needed(.logout)
if let error {
Current.Log.error("Failed calling sign out callback: \(error)")
}
Current.Log.verbose("Successfully informed web client of log out.")
}
}.catch { error in
Current.Log.error("Failed to revoke token: \(error)")
}
}
private func handleLogError(_ messageBody: [String: Any]) {
Current.Log.error("WebView error: \(messageBody.description.replacingOccurrences(of: "\n", with: " "))")
}
}