-
-
Notifications
You must be signed in to change notification settings - Fork 128
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[WIP] Notifications enhancements (#764)
* WIP support enahnced notifications Signed-off-by: Dan Cunningham <[email protected]> * working Signed-off-by: Dan Cunningham <[email protected]> * Notification enhancements, Dynamic actions, navigation partialy working, media attachments Signed-off-by: Dan Cunningham <[email protected]> * remove test files Signed-off-by: Dan Cunningham <[email protected]> * Improvements Signed-off-by: Dan Cunningham <[email protected]> * Lot of fixes, internal notification now supports actions. Signed-off-by: Dan Cunningham <[email protected]> * Align with MainUI changes Signed-off-by: Dan Cunningham <[email protected]> * Change payload key names Signed-off-by: Dan Cunningham <[email protected]> * Use "ui" for UI based commands Signed-off-by: Dan Cunningham <[email protected]> * Support the full ui... command option Signed-off-by: Dan Cunningham <[email protected]> --------- Signed-off-by: Dan Cunningham <[email protected]>
- Loading branch information
1 parent
a20f2da
commit d70b62d
Showing
8 changed files
with
567 additions
and
48 deletions.
There are no files selected for viewing
This file contains 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,13 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd"> | ||
| <plist version="1.0"> | ||
| <dict> | ||
| <key>NSExtension</key> | ||
| <dict> | ||
| <key>NSExtensionPointIdentifier</key> | ||
| <string>com.apple.usernotifications.service</string> | ||
| <key>NSExtensionPrincipalClass</key> | ||
| <string>$(PRODUCT_MODULE_NAME).NotificationService</string> | ||
| </dict> | ||
| </dict> | ||
| </plist> |
This file contains 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,156 @@ | ||
| // Copyright (c) 2010-2024 Contributors to the openHAB project | ||
| // | ||
| // See the NOTICE file(s) distributed with this work for additional | ||
| // information. | ||
| // | ||
| // This program and the accompanying materials are made available under the | ||
| // terms of the Eclipse Public License 2.0 which is available at | ||
| // http://www.eclipse.org/legal/epl-2.0 | ||
| // | ||
| // SPDX-License-Identifier: EPL-2.0 | ||
|
|
||
| import os.log | ||
| import UniformTypeIdentifiers | ||
| import UserNotifications | ||
|
|
||
| class NotificationService: UNNotificationServiceExtension { | ||
| var contentHandler: ((UNNotificationContent) -> Void)? | ||
| var bestAttemptContent: UNMutableNotificationContent? | ||
|
|
||
| override func didReceive(_ request: UNNotificationRequest, withContentHandler contentHandler: @escaping (UNNotificationContent) -> Void) { | ||
| self.contentHandler = contentHandler | ||
| bestAttemptContent = (request.content.mutableCopy() as? UNMutableNotificationContent) | ||
| if let bestAttemptContent { | ||
| var notificationActions: [UNNotificationAction] = [] | ||
| let userInfo = bestAttemptContent.userInfo | ||
| os_log("handleNotification userInfo %{PUBLIC}@", log: .default, type: .info, userInfo) | ||
|
|
||
| // Check if the user has defined custom actions in the payload | ||
| if let actionsArray = parseActions(userInfo), let category = parseCategory(userInfo) { | ||
| for actionDict in actionsArray { | ||
| if let action = actionDict["action"], | ||
| let title = actionDict["title"] { | ||
| var options: UNNotificationActionOptions = [] | ||
| // navigate options need to bring the app forward | ||
| if action.hasPrefix("navigate") { | ||
| options = [.foreground] | ||
| } | ||
| let notificationAction = UNNotificationAction( | ||
| identifier: action, | ||
| title: title, | ||
| options: options | ||
| ) | ||
| notificationActions.append(notificationAction) | ||
| } | ||
| } | ||
| if !notificationActions.isEmpty { | ||
| os_log("handleNotification registering %{PUBLIC}@ for category %{PUBLIC}@", log: .default, type: .info, notificationActions, category) | ||
| let notificationCategory = | ||
| UNNotificationCategory( | ||
| identifier: category, | ||
| actions: notificationActions, | ||
| intentIdentifiers: [], | ||
| options: .customDismissAction | ||
| ) | ||
| UNUserNotificationCenter.current().getNotificationCategories { (existingCategories) in | ||
| // Check if the new category already exists, this is a hash of the actions string done by the cloud service | ||
| let existingCategoryIdentifiers = existingCategories.map(\.identifier) | ||
| if !existingCategoryIdentifiers.contains(category) { | ||
| var updatedCategories = existingCategories | ||
| os_log("handleNotification adding category %{PUBLIC}@", log: .default, type: .info, category) | ||
| updatedCategories.insert(notificationCategory) | ||
| UNUserNotificationCenter.current().setNotificationCategories(updatedCategories) | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // check if there is an attachment to put on the notification | ||
| // this should be last as we need to wait for media | ||
| // TODO: we should support relative paths and try the user's openHAB (local,remote) for content | ||
| if let attachmentURLString = userInfo["media-attachment-url"] as? String, let attachmentURL = URL(string: attachmentURLString) { | ||
| os_log("handleNotification downloading %{PUBLIC}@", log: .default, type: .info, attachmentURLString) | ||
| downloadAndAttachMedia(url: attachmentURL) { attachment in | ||
| if let attachment { | ||
| os_log("handleNotification attaching %{PUBLIC}@", log: .default, type: .info, attachmentURLString) | ||
| bestAttemptContent.attachments = [attachment] | ||
| } else { | ||
| os_log("handleNotification could not attach %{PUBLIC}@", log: .default, type: .info, attachmentURLString) | ||
| } | ||
| contentHandler(bestAttemptContent) | ||
| } | ||
| } else { | ||
| contentHandler(bestAttemptContent) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| override func serviceExtensionTimeWillExpire() { | ||
| // Called just before the extension will be terminated by the system. | ||
| // Use this as an opportunity to deliver your "best attempt" at modified content, otherwise the original push payload will be used. | ||
| os_log("serviceExtensionTimeWillExpire", log: .default, type: .info) | ||
| if let contentHandler, let bestAttemptContent { | ||
| contentHandler(bestAttemptContent) | ||
| } | ||
| } | ||
|
|
||
| private func parseActions(_ userInfo: [AnyHashable: Any]) -> [[String: String]]? { | ||
| // Extract actions and convert it from JSON string to an array of dictionaries | ||
| if let actionsString = userInfo["actions"] as? String, let actionsData = actionsString.data(using: .utf8) { | ||
| do { | ||
| if let actionsArray = try JSONSerialization.jsonObject(with: actionsData, options: []) as? [[String: String]] { | ||
| return actionsArray | ||
| } | ||
| } catch { | ||
| os_log("Error parsing actions: %{PUBLIC}@", log: .default, type: .info, error.localizedDescription) | ||
| } | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| private func parseCategory(_ userInfo: [AnyHashable: Any]) -> String? { | ||
| // Extract category from aps dictionary | ||
| if let aps = userInfo["aps"] as? [String: Any], | ||
| let category = aps["category"] as? String { | ||
| return category | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| private func downloadAndAttachMedia(url: URL, completion: @escaping (UNNotificationAttachment?) -> Void) { | ||
| let task = URLSession.shared.downloadTask(with: url) { localURL, response, error in | ||
| guard let localURL else { | ||
| os_log("Error downloading media %{PUBLIC}@", log: .default, type: .error, error?.localizedDescription ?? "Unknown error") | ||
| completion(nil) | ||
| return | ||
| } | ||
|
|
||
| do { | ||
| let fileManager = FileManager.default | ||
| let tempDirectory = NSTemporaryDirectory() | ||
| let tempFile = URL(fileURLWithPath: tempDirectory).appendingPathComponent(UUID().uuidString) | ||
|
|
||
| try fileManager.moveItem(at: localURL, to: tempFile) | ||
|
|
||
| let attachment: UNNotificationAttachment? | ||
|
|
||
| if let mimeType = response?.mimeType, | ||
| let utType = UTType(mimeType: mimeType), | ||
| utType.conforms(to: .data) { | ||
| let newTempFile = tempFile.appendingPathExtension(utType.preferredFilenameExtension ?? "") | ||
| try fileManager.moveItem(at: tempFile, to: newTempFile) | ||
| attachment = try UNNotificationAttachment(identifier: UUID().uuidString, url: newTempFile, options: nil) | ||
| } else { | ||
| os_log("Unrecognized MIME type or file extension", log: .default, type: .error) | ||
| attachment = nil | ||
| } | ||
|
|
||
| completion(attachment) | ||
| } catch { | ||
| os_log("Failed to create UNNotificationAttachment: %{PUBLIC}@", log: .default, type: .error, error.localizedDescription) | ||
| completion(nil) | ||
| } | ||
| } | ||
| task.resume() | ||
| } | ||
| } |
Oops, something went wrong.