Merge Highlighter into release_1.10

Daniel D’Aquino (7):
      Add convenience functions
      Simplify SelectableText state management
      Add support for rendering highlights with comments
      Add support for adding comments when creating a highlight
      Add highlighter extension
      Fix highlight tag ambiguity with specifiers
      Improve handling of NostrDB when switching apps

William Casarin (4):
      lmdb: patch semaphore names to use group container prefix
      notifications: add extended virtual addressing entitlement
      highlighter: add extended virtual addressing entitlement

damus/Models/Camera/CameraService.swift

@@ -151,7 +151,7 @@ public class CameraService: NSObject, Identifiable {
 
             DispatchQueue.main.async {
                 self.alertError = AlertError(title: "Camera Access", message: "Damus needs camera and microphone access. Enable in settings.", primaryButtonTitle: "Go to settings", secondaryButtonTitle: nil, primaryAction: {
-                        UIApplication.shared.open(URL(string: UIApplication.openSettingsURLString)!,
+                        this_app.open(URL(string: UIApplication.openSettingsURLString)!,
                                                   options: [:], completionHandler: nil)
 
                 }, secondaryAction: nil)

damus/Models/CommentItem.swift

@@ -0,0 +1,23 @@
+//
+//  CommentItem.swift
+//  damus
+//
+//  Created by Daniel D’Aquino on 2024-08-14.
+//
+
+import Foundation
+
+struct CommentItem: TagConvertible {
+    static let TAG_KEY: String = "comment"
+    let content: String
+    var tag: [String] {
+        return [Self.TAG_KEY, content]
+    }
+    
+    static func from_tag(tag: TagSequence) -> CommentItem? {
+        guard tag.count == 2 else { return nil }
+        guard tag[0].string() == Self.TAG_KEY else { return nil }
+        
+        return CommentItem(content: tag[1].string())
+    }
+}

damus/Models/Contacts+.swift

@@ -109,7 +109,7 @@ func is_already_following(contacts: NostrEvent, follow: FollowRef) -> Bool {
         case let (.pubkey(pk), .pubkey(follow_pk)):
             return pk == follow_pk
         case (.hashtag, .pubkey), (.pubkey, .hashtag),
-            (.event, _), (.quote, _), (.param, _), (.naddr, _):
+            (.event, _), (.quote, _), (.param, _), (.naddr, _), (.reference(_), _):
             return false
         }
     }

damus/Models/DamusState.swift

@@ -74,6 +74,79 @@ class DamusState: HeadlessDamusState {
         self.push_notification_client = PushNotificationClient(keypair: keypair, settings: settings)
         self.emoji_provider = emoji_provider
     }
+    
+    @MainActor
+    convenience init?(keypair: Keypair) {
+        // nostrdb
+        var mndb = Ndb()
+        if mndb == nil {
+            // try recovery
+            print("DB ISSUE! RECOVERING")
+            mndb = Ndb.safemode()
+
+            // out of space or something?? maybe we need a in-memory fallback
+            if mndb == nil {
+                logout(nil)
+                return nil
+            }
+        }
+        
+        let navigationCoordinator: NavigationCoordinator = NavigationCoordinator()
+        let home: HomeModel = HomeModel()
+        let sub_id = UUID().uuidString
+
+        guard let ndb = mndb else { return nil }
+        let pubkey = keypair.pubkey
+
+        let pool = RelayPool(ndb: ndb, keypair: keypair)
+        let model_cache = RelayModelCache()
+        let relay_filters = RelayFilters(our_pubkey: pubkey)
+        let bootstrap_relays = load_bootstrap_relays(pubkey: pubkey)
+        
+        let settings = UserSettingsStore.globally_load_for(pubkey: pubkey)
+
+        let new_relay_filters = load_relay_filters(pubkey) == nil
+        for relay in bootstrap_relays {
+            let descriptor = RelayDescriptor(url: relay, info: .rw)
+            add_new_relay(model_cache: model_cache, relay_filters: relay_filters, pool: pool, descriptor: descriptor, new_relay_filters: new_relay_filters, logging_enabled: settings.developer_mode)
+        }
+
+        pool.register_handler(sub_id: sub_id, handler: home.handle_event)
+        
+        if let nwc_str = settings.nostr_wallet_connect,
+           let nwc = WalletConnectURL(str: nwc_str) {
+            try? pool.add_relay(.nwc(url: nwc.relay))
+        }
+        self.init(
+            pool: pool,
+            keypair: keypair,
+            likes: EventCounter(our_pubkey: pubkey),
+            boosts: EventCounter(our_pubkey: pubkey),
+            contacts: Contacts(our_pubkey: pubkey),
+            mutelist_manager: MutelistManager(user_keypair: keypair),
+            profiles: Profiles(ndb: ndb),
+            dms: home.dms,
+            previews: PreviewCache(),
+            zaps: Zaps(our_pubkey: pubkey),
+            lnurls: LNUrls(),
+            settings: settings,
+            relay_filters: relay_filters,
+            relay_model_cache: model_cache,
+            drafts: Drafts(),
+            events: EventCache(ndb: ndb),
+            bookmarks: BookmarksManager(pubkey: pubkey),
+            postbox: PostBox(pool: pool),
+            bootstrap_relays: bootstrap_relays,
+            replies: ReplyCounter(our_pubkey: pubkey),
+            wallet: WalletModel(settings: settings),
+            nav: navigationCoordinator,
+            music: MusicController(onChange: { _ in }),
+            video: VideoController(),
+            ndb: ndb,
+            quote_reposts: .init(our_pubkey: pubkey),
+            emoji_provider: DefaultEmojiProvider(showAllVariations: true)
+        )
+    }
 
     @discardableResult
     func add_zap(zap: Zapping) -> Bool {

damus/Models/DraftsModel.swift

@@ -28,4 +28,5 @@ class Drafts: ObservableObject {
     @Published var post: DraftArtifacts? = nil
     @Published var replies: [NostrEvent: DraftArtifacts] = [:]
     @Published var quotes: [NostrEvent: DraftArtifacts] = [:]
+    @Published var highlights: [HighlightSource: DraftArtifacts] = [:]
 }

damus/Models/HighlightEvent.swift

@@ -13,22 +13,203 @@ struct HighlightEvent {
     var event_ref: String? = nil
     var url_ref: URL? = nil
     var context: String? = nil
+    
+    // MARK: - Initializers and parsers
 
     static func parse(from ev: NostrEvent) -> HighlightEvent {
         var highlight = HighlightEvent(event: ev)
+        
+        var best_url_source: (url: URL, tagged_as_source: Bool)? = nil
 
         for tag in ev.tags {
             guard tag.count >= 2 else { continue }
             switch tag[0].string() {
             case "e":   highlight.event_ref = tag[1].string()
             case "a":   highlight.event_ref = tag[1].string()
-            case "r":   highlight.url_ref = URL(string: tag[1].string())
+            case "r":
+                if tag.count >= 3,
+                   tag[2].string() == HighlightSource.TAG_SOURCE_ELEMENT,
+                   let url = URL(string: tag[1].string()) {
+                    // URL marked as source. Very good candidate
+                    best_url_source = (url: url, tagged_as_source: true)
+                }
+                else if tag.count >= 3 && tag[2].string() != HighlightSource.TAG_SOURCE_ELEMENT {
+                    // URL marked as something else (not source). Not the source we are after
+                }
+                else if let url = URL(string: tag[1].string()), tag.count == 2 {
+                    // Unmarked URL. This might be what we are after (For NIP-84 backwards compatibility)
+                    if (best_url_source?.tagged_as_source ?? false) == false {
+                        // No URL candidates marked as the source. Mark this as the best option we have
+                        best_url_source = (url: url, tagged_as_source: false)
+                    }
+                }
             case "context": highlight.context = tag[1].string()
             default:
                 break
             }
         }
+        
+        if let best_url_source {
+            highlight.url_ref = best_url_source.url
+        }
 
         return highlight
     }
+    
+    // MARK: - Getting information about source
+    
+    func source_description_info(highlighted_event: NostrEvent?) -> ReplyDesc {
+        var others_count = 0
+        var highlighted_authors: [Pubkey] = []
+        var i = event.tags.count
+
+        if let highlighted_event {
+            highlighted_authors.append(highlighted_event.pubkey)
+        }
+
+        for tag in event.tags {
+            if let pubkey_with_role = PubkeyWithRole.from_tag(tag: tag) {
+                others_count += 1
+                if highlighted_authors.count < 2 {
+                    if let highlighted_event, pubkey_with_role.pubkey == highlighted_event.pubkey {
+                        continue
+                    } else {
+                        switch pubkey_with_role.role {
+                            case .author:
+                                highlighted_authors.append(pubkey_with_role.pubkey)
+                            default:
+                                break
+                        }
+                        
+                    }
+                }
+            }
+            i -= 1
+        }
+
+        return ReplyDesc(pubkeys: highlighted_authors, others: others_count)
+    }
+    
+    func source_description_text(ndb: Ndb, highlighted_event: NostrEvent?, locale: Locale = Locale.current) -> String {
+        let description_info = self.source_description_info(highlighted_event: highlighted_event)
+        let pubkeys = description_info.pubkeys
+
+        let bundle = bundleForLocale(locale: locale)
+
+        if pubkeys.count == 0 {
+            return NSLocalizedString("Highlighted", bundle: bundle, comment: "Label to indicate that the user is highlighting their own post.")
+        }
+
+        guard let profile_txn = NdbTxn(ndb: ndb) else  {
+            return ""
+        }
+
+        let names: [String] = pubkeys.map { pk in
+            let prof = ndb.lookup_profile_with_txn(pk, txn: profile_txn)
+
+            return Profile.displayName(profile: prof?.profile, pubkey: pk).username.truncate(maxLength: 50)
+        }
+
+        let uniqueNames: [String] = Array(Set(names))
+        return String(format: NSLocalizedString("Highlighted %@", bundle: bundle, comment: "Label to indicate that the user is highlighting 1 user."), locale: locale, uniqueNames.first ?? "")
+    }
+}
+
+// MARK: - Helper structures
+
+extension HighlightEvent {
+    struct PubkeyWithRole: TagKey, TagConvertible {
+        let pubkey: Pubkey
+        let role: Role
+
+        var tag: [String] {
+            if let role_text = self.role.rawValue {
+                return [keychar.description, self.pubkey.hex(), role_text]
+            }
+            else {
+                return [keychar.description, self.pubkey.hex()]
+            }
+        }
+
+        var keychar: AsciiCharacter { "p" }
+
+        static func from_tag(tag: TagSequence) -> HighlightEvent.PubkeyWithRole? {
+            var i = tag.makeIterator()
+            
+            guard tag.count >= 2,
+                  let t0 = i.next(),
+                  let key = t0.single_char,
+                  key == "p",
+                  let t1 = i.next(),
+                  let pubkey = t1.id().map(Pubkey.init)
+            else { return nil }
+            
+            let t3: String? = i.next()?.string()
+            let role = Role(rawValue: t3)
+            return PubkeyWithRole(pubkey: pubkey, role: role)
+        }
+        
+        enum Role: RawRepresentable {
+            case author
+            case editor
+            case mention
+            case other(String)
+            case no_role
+            
+            typealias RawValue = String?
+            var rawValue: String? {
+                switch self {
+                    case .author: "author"
+                    case .editor: "editor"
+                    case .mention: "mention"
+                    case .other(let role): role
+                    case .no_role: nil
+                }
+            }
+            
+            init(rawValue: String?) {
+                switch rawValue {
+                    case "author": self = .author
+                    case "editor": self = .editor
+                    case "mention": self = .mention
+                    default:
+                        if let rawValue {
+                            self = .other(rawValue)
+                        }
+                        else {
+                            self = .no_role
+                        }
+                }
+            }
+        }
+    }
+}
+
+struct HighlightContentDraft: Hashable {
+    let selected_text: String
+    let source: HighlightSource
+}
+
+enum HighlightSource: Hashable {
+    static let TAG_SOURCE_ELEMENT = "source"
+    case event(NostrEvent)
+    case external_url(URL)
+    
+    func tags() -> [[String]] {
+        switch self {
+            case .event(let event):
+                return [ ["e", "\(event.id)", HighlightSource.TAG_SOURCE_ELEMENT] ]
+            case .external_url(let url):
+                return [ ["r", "\(url)", HighlightSource.TAG_SOURCE_ELEMENT] ]
+        }
+    }
+    
+    func ref() -> RefId {
+        switch self {
+            case .event(let event):
+                return .event(event.id)
+            case .external_url(let url):
+                return .reference(url.absoluteString)
+        }
+    }
 }

damus/Models/Mentions.swift

@@ -256,46 +256,3 @@ func find_tag_ref(type: String, id: String, tags: [[String]]) -> Int? {
     
     return nil
 }
-
-struct PostTags {
-    let blocks: [Block]
-    let tags: [[String]]
-}
-
-/// Convert
-func make_post_tags(post_blocks: [Block], tags: [[String]]) -> PostTags {
-    var new_tags = tags
-
-    for post_block in post_blocks {
-        switch post_block {
-        case .mention(let mention):
-            switch(mention.ref) {
-            case .note, .nevent:
-                continue
-            default:
-                break
-            }
-
-            new_tags.append(mention.ref.tag)
-        case .hashtag(let hashtag):
-            new_tags.append(["t", hashtag.lowercased()])
-        case .text: break
-        case .invoice: break
-        case .relay: break
-        case .url(let url):
-            new_tags.append(["r", url.absoluteString])
-            break
-        }
-    }
-    
-    return PostTags(blocks: post_blocks, tags: new_tags)
-}
-
-func post_to_event(post: NostrPost, keypair: FullKeypair) -> NostrEvent? {
-    let post_blocks = parse_post_blocks(content: post.content)
-    let post_tags = make_post_tags(post_blocks: post_blocks, tags: post.tags)
-    let content = post_tags.blocks
-        .map(\.asString)
-        .joined(separator: "")
-    return NostrEvent(content: content, keypair: keypair.to_keypair(), kind: post.kind.rawValue, tags: post_tags.tags)
-}

damus/Models/Post.swift

@@ -17,10 +17,84 @@ struct NostrPost {
         self.kind = kind
         self.tags = tags
     }
+    
+    func to_event(keypair: FullKeypair) -> NostrEvent? {
+        let post_blocks = self.parse_blocks()
+        let post_tags = self.make_post_tags(post_blocks: post_blocks, tags: self.tags)
+        let content = post_tags.blocks
+            .map(\.asString)
+            .joined(separator: "")
+        
+        if self.kind == .highlight {
+            var new_tags = post_tags.tags.filter({ $0[safe: 0] != "comment" })
+            if content.count > 0 {
+                new_tags.append(["comment", content])
+            }
+            return NostrEvent(content: self.content, keypair: keypair.to_keypair(), kind: self.kind.rawValue, tags: new_tags)
+        }
+        
+        return NostrEvent(content: content, keypair: keypair.to_keypair(), kind: self.kind.rawValue, tags: post_tags.tags)
+    }
+    
+    func parse_blocks() -> [Block] {
+        guard let content_for_parsing = self.default_content_for_block_parsing() else { return [] }
+        return parse_post_blocks(content: content_for_parsing)
+    }
+    
+    private func default_content_for_block_parsing() -> String? {
+        switch kind {
+            case .highlight:
+                return tags.filter({ $0[safe: 0] == "comment" }).first?[safe: 1]
+            default:
+                return self.content
+        }
+    }
+    
+    /// Parse the post's contents to find more tags to apply to the final nostr event
+    private func make_post_tags(post_blocks: [Block], tags: [[String]]) -> PostTags {
+        var new_tags = tags
+
+        for post_block in post_blocks {
+            switch post_block {
+                case .mention(let mention):
+                    switch(mention.ref) {
+                    case .note, .nevent:
+                        continue
+                    default:
+                        break
+                    }
+                    
+                    if self.kind == .highlight, case .pubkey(_) = mention.ref {
+                        var new_tag = mention.ref.tag
+                        new_tag.append("mention")
+                        new_tags.append(new_tag)
+                    }
+                    else {
+                        new_tags.append(mention.ref.tag)
+                    }
+                case .hashtag(let hashtag):
+                    new_tags.append(["t", hashtag.lowercased()])
+                case .text: break
+                case .invoice: break
+                case .relay: break
+                case .url(let url):
+                    new_tags.append(self.kind == .highlight ? ["r", url.absoluteString, "mention"] : ["r", url.absoluteString])
+                    break
+            }
+        }
+        
+        return PostTags(blocks: post_blocks, tags: new_tags)
+    }
 }
 
+// MARK: - Helper structures and functions
+
+/// A struct used for temporarily holding tag information that was parsed from a post contents to aid in building a nostr event
+fileprivate struct PostTags {
+    let blocks: [Block]
+    let tags: [[String]]
+}
 
-/// Return a list of tags
 func parse_post_blocks(content: String) -> [Block] {
     return parse_note_content(content: .content(content, nil)).blocks
 }