Communication notifications

Signed-off-by: William Casarin <jb55@jb55.com>

DamusNotificationService/DamusNotificationService.entitlements

@@ -2,6 +2,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>com.apple.developer.usernotifications.communication</key>
+	<true/>
 	<key>com.apple.developer.kernel.extended-virtual-addressing</key>
 	<true/>
 	<key>com.apple.security.app-sandbox</key>

DamusNotificationService/NotificationService.swift

@@ -5,15 +5,32 @@
 //  Created by Daniel D’Aquino on 2023-11-10.
 //
 
+import Kingfisher
+import ImageIO
 import UserNotifications
 import Foundation
+import UniformTypeIdentifiers
+import Intents
 
 class NotificationService: UNNotificationServiceExtension {
 
     var contentHandler: ((UNNotificationContent) -> Void)?
     var bestAttemptContent: UNMutableNotificationContent?
 
+    private func configureKingfisherCache() {
+        guard let groupURL = FileManager.default.containerURL(forSecurityApplicationGroupIdentifier: Constants.DAMUS_APP_GROUP_IDENTIFIER) else {
+            return
+        }
+
+        let cachePath = groupURL.appendingPathComponent(Constants.IMAGE_CACHE_DIRNAME)
+        if let cache = try? ImageCache(name: "sharedCache", cacheDirectoryURL: cachePath) {
+            KingfisherManager.shared.cache = cache
+        }
+    }
+
     override func didReceive(_ request: UNNotificationRequest, withContentHandler contentHandler: @escaping (UNNotificationContent) -> Void) {
+        configureKingfisherCache()
+
         self.contentHandler = contentHandler
         
         guard let nostr_event_json = request.content.userInfo["nostr_event"] as? String,
@@ -40,9 +57,16 @@ class NotificationService: UNNotificationServiceExtension {
             return
         }
 
-        let txn = state.ndb.lookup_profile(nostr_event.pubkey)
-        let profile = txn?.unsafeUnownedValue?.profile
-        let name = Profile.displayName(profile: profile, pubkey: nostr_event.pubkey).displayName
+        let sender_profile = {
+            let txn = state.ndb.lookup_profile(nostr_event.pubkey)
+            let profile = txn?.unsafeUnownedValue?.profile
+            let picture = ((profile?.picture.map { URL(string: $0) }) ?? URL(string: robohash(nostr_event.pubkey)))!
+            return ProfileBuf(picture: picture,
+                                 name: profile?.name,
+                         display_name: profile?.display_name,
+                                nip05: profile?.nip05)
+        }()
+        let sender_pubkey = nostr_event.pubkey
 
         // Don't show notification details that match mute list.
         // TODO: Remove this code block once we get notification suppression entitlement from Apple. It will be covered by the `guard should_display_notification` block
@@ -56,7 +80,7 @@ class NotificationService: UNNotificationServiceExtension {
             contentHandler(content)
             return
         }
-        
+
         guard should_display_notification(state: state, event: nostr_event, mode: .push) else {
             Log.debug("should_display_notification failed", for: .push_notifications)
             // We should not display notification for this event. Suppress notification.
@@ -65,7 +89,7 @@ class NotificationService: UNNotificationServiceExtension {
             contentHandler(request.content)
             return
         }
-        
+
         guard let notification_object = generate_local_notification_object(from: nostr_event, state: state) else {
             Log.debug("generate_local_notification_object failed", for: .push_notifications)
             // We could not process this notification. Probably an unsupported nostr event kind. Suppress.
@@ -74,15 +98,58 @@ class NotificationService: UNNotificationServiceExtension {
             contentHandler(request.content)
             return
         }
-        
+
+
         Task {
-            guard let (improvedContent, _) = await NotificationFormatter.shared.format_message(displayName: name, notify: notification_object, state: state) else {
+            let sender_dn = DisplayName(name: sender_profile.name, display_name: sender_profile.display_name, pubkey: sender_pubkey)
+            guard let (improvedContent, _) = await NotificationFormatter.shared.format_message(displayName: sender_dn.displayName, notify: notification_object, state: state) else {
 
                 Log.debug("NotificationFormatter.format_message failed", for: .push_notifications)
                 return
             }
 
-            contentHandler(improvedContent)
+            do {
+                var options: [AnyHashable: Any] = [:]
+                if let imageSource = CGImageSourceCreateWithURL(sender_profile.picture as CFURL, nil),
+                   let uti = CGImageSourceGetType(imageSource) {
+                    options[UNNotificationAttachmentOptionsTypeHintKey] = uti
+                }
+
+                let attachment = try UNNotificationAttachment(identifier: sender_profile.picture.absoluteString, url: sender_profile.picture, options: options)
+                improvedContent.attachments = [attachment]
+            } catch {
+                Log.error("failed to get notification attachment: %s", for: .push_notifications, error.localizedDescription)
+            }
+
+            let kind = nostr_event.known_kind
+
+            // these aren't supported yet
+            if !(kind == .text || kind == .dm) {
+                contentHandler(improvedContent)
+                return
+            }
+
+            // rich communication notifications for kind1, dms, etc
+
+            let message_intent = await message_intent_from_note(ndb: state.ndb,
+                                                                sender_profile: sender_profile,
+                                                                content: improvedContent.body,
+                                                                note: nostr_event,
+                                                                our_pubkey: state.keypair.pubkey)
+
+            improvedContent.threadIdentifier = nostr_event.thread_id().hex()
+            improvedContent.categoryIdentifier = "COMMUNICATION"
+
+            let interaction = INInteraction(intent: message_intent, response: nil)
+            interaction.direction = .incoming
+            do {
+                try await interaction.donate()
+                let updated = try improvedContent.updating(from: message_intent)
+                contentHandler(updated)
+            } catch {
+                Log.error("failed to donate interaction: %s", for: .push_notifications, error.localizedDescription)
+                contentHandler(improvedContent)
+            }
         }
     }
     
@@ -95,3 +162,162 @@ class NotificationService: UNNotificationServiceExtension {
     }
 
 }
+
+struct ProfileBuf {
+    let picture: URL
+    let name: String?
+    let display_name: String?
+    let nip05: String?
+}
+
+func message_intent_from_note(ndb: Ndb, sender_profile: ProfileBuf, content: String, note: NdbNote, our_pubkey: Pubkey) async -> INSendMessageIntent {
+    let sender_pk = note.pubkey
+    let sender = await profile_to_inperson(name: sender_profile.name,
+                                   display_name: sender_profile.display_name,
+                                        picture: sender_profile.picture.absoluteString,
+                                          nip05: sender_profile.nip05,
+                                         pubkey: sender_pk,
+                                     our_pubkey: our_pubkey)
+
+    let conversationIdentifier = note.thread_id().hex()
+    var recipients: [INPerson] = []
+    var pks: [Pubkey] = []
+    let meta = INSendMessageIntentDonationMetadata()
+
+    // gather recipients
+    if let recipient_note_id = note.direct_replies() {
+        let replying_to = ndb.lookup_note(recipient_note_id)
+        if let replying_to_pk = replying_to?.unsafeUnownedValue?.pubkey {
+            meta.isReplyToCurrentUser = replying_to_pk == our_pubkey
+
+            if replying_to_pk != sender_pk {
+                // we push the actual person being replied to first
+                pks.append(replying_to_pk)
+            }
+        }
+    }
+
+    let pubkeys = Array(note.referenced_pubkeys)
+    meta.recipientCount = pubkeys.count
+    if pubkeys.contains(sender_pk) {
+        meta.recipientCount -= 1
+    }
+
+    for pk in pubkeys.prefix(3) {
+        if pk == sender_pk || pks.contains(pk) {
+            continue
+        }
+
+        if !meta.isReplyToCurrentUser && pk == our_pubkey {
+            meta.mentionsCurrentUser = true
+        }
+
+        pks.append(pk)
+    }
+
+    for pk in pks {
+        let recipient = await pubkey_to_inperson(ndb: ndb, pubkey: pk, our_pubkey: our_pubkey)
+        recipients.append(recipient)
+    }
+
+    // we enable default formatting this way
+    var groupName = INSpeakableString(spokenPhrase: "")
+
+    // otherwise we just say its a DM
+    if note.known_kind == .dm {
+        groupName = INSpeakableString(spokenPhrase: "DM")
+    }
+
+    let intent = INSendMessageIntent(recipients: recipients,
+                            outgoingMessageType: .outgoingMessageText,
+                                        content: content,
+                             speakableGroupName: groupName,
+                         conversationIdentifier: conversationIdentifier,
+                                    serviceName: "kind\(note.kind)",
+                                         sender: sender,
+                                    attachments: nil)
+    intent.donationMetadata = meta
+
+    // this is needed for recipients > 0
+    if let img = sender.image {
+        intent.setImage(img, forParameterNamed: \.speakableGroupName)
+    }
+
+    return intent
+}
+
+func pubkey_to_inperson(ndb: Ndb, pubkey: Pubkey, our_pubkey: Pubkey) async -> INPerson {
+    let profile_txn = ndb.lookup_profile(pubkey)
+    let profile = profile_txn?.unsafeUnownedValue?.profile
+    let name = profile?.name
+    let display_name = profile?.display_name
+    let nip05 = profile?.nip05
+    let picture = profile?.picture
+
+    return await profile_to_inperson(name: name,
+                             display_name: display_name,
+                                  picture: picture,
+                                    nip05: nip05,
+                                   pubkey: pubkey,
+                               our_pubkey: our_pubkey)
+}
+
+func fetch_pfp(picture: URL) async throws -> RetrieveImageResult {
+    try await withCheckedThrowingContinuation { continuation in
+        KingfisherManager.shared.retrieveImage(with: Kingfisher.ImageResource(downloadURL: picture)) { result in
+            switch result {
+            case .success(let img):
+                continuation.resume(returning: img)
+            case .failure(let error):
+                continuation.resume(throwing: error)
+            }
+        }
+    }
+}
+
+func profile_to_inperson(name: String?, display_name: String?, picture: String?, nip05: String?, pubkey: Pubkey, our_pubkey: Pubkey) async -> INPerson {
+    let npub = pubkey.npub
+    let handle = INPersonHandle(value: npub, type: .unknown)
+    var aliases: [INPersonHandle] = []
+
+    if let nip05 {
+        aliases.append(INPersonHandle(value: nip05, type: .emailAddress))
+    }
+
+    let nostrName = DisplayName(name: name, display_name: display_name, pubkey: pubkey)
+    let nameComponents = nostrName.nameComponents()
+    let displayName = nostrName.displayName
+    let contactIdentifier = npub
+    let customIdentifier = npub
+    let suggestionType = INPersonSuggestionType.socialProfile
+
+    var image: INImage? = nil
+
+    if let picture,
+       let url = URL(string: picture),
+       let img = try? await fetch_pfp(picture: url),
+       let imgdata = img.data()
+    {
+        image = INImage(imageData: imgdata)
+    } else {
+        Log.error("Failed to fetch pfp (%s) for %s", for: .push_notifications, picture ?? "nil", displayName)
+    }
+
+    let person = INPerson(personHandle: handle,
+                        nameComponents: nameComponents,
+                           displayName: displayName,
+                                 image: image,
+                     contactIdentifier: contactIdentifier,
+                      customIdentifier: customIdentifier,
+                                  isMe: pubkey == our_pubkey,
+                        suggestionType: suggestionType
+    )
+
+    return person
+}
+
+func robohash(_ pk: Pubkey) -> String {
+    return "https://robohash.org/" + pk.hex()
+}
+
+