Prepare for upcoming contact changes

Session/Conversations/Views & Modals/ConversationTitleView.swift

@@ -74,7 +74,7 @@ final class ConversationTitleView : UIView {
             let sessionID = thread.contactIdentifier()!
             var result = sessionID
             Storage.read { transaction in
-                result = Storage.shared.getContact(with: sessionID)?.displayName ?? "Anonymous"
+                result = Storage.shared.getContact(with: sessionID)?.displayName(for: .regular) ?? "Anonymous"
             }
             return result
         }

SessionMessagingKit/Contacts/Contact.swift

@@ -2,10 +2,12 @@
 @objc(SNContact)
 public class Contact : NSObject, NSCoding { // NSObject/NSCoding conformance is needed for YapDatabase compatibility
     @objc public let sessionID: String
-    /// The display name of the contact.
+    /// The name of the contact.
     ///
     /// - Note: In open groups use `openGroupDisplayName`.
-    @objc public var displayName: String?
+    @objc public var name: String?
+    /// The contact's nickname.
+    @objc public var nickname: String?
     /// The URL from which to fetch the contact's profile picture.
     @objc public var profilePictureURL: String?
     /// The file name of the contact's profile picture on local storage.
@@ -17,11 +19,25 @@ public class Contact : NSObject, NSCoding { // NSObject/NSCoding conformance is
     
     /// In open groups, where it's more likely that multiple users have the same name, we display a bit of the Session ID after
     /// a user's display name for added context.
-    public var openGroupDisplayName: String? {
+    @objc public var openGroupDisplayName: String? {
-        guard let displayName = displayName else { return nil }
+        guard let name = name else { return nil }
         let endIndex = sessionID.endIndex
         let cutoffIndex = sessionID.index(endIndex, offsetBy: -8)
-        return "\(displayName) (...\(sessionID[cutoffIndex..<endIndex]))"
+        return "\(name) (...\(sessionID[cutoffIndex..<endIndex]))"
+    }
+    
+    @objc public func displayName(for context: Context) -> String? {
+        if let nickname = nickname { return nickname }
+        switch context {
+        case .regular: return name
+        case .openGroup: return openGroupDisplayName
+        }
+    }
+    
+    // MARK: Context
+    @objc(SNContactContext)
+    public enum Context : Int {
+        case regular, openGroup
     }
     
     // MARK: Initialization
@@ -43,7 +59,8 @@ public class Contact : NSObject, NSCoding { // NSObject/NSCoding conformance is
     public required init?(coder: NSCoder) {
         guard let sessionID = coder.decodeObject(forKey: "sessionID") as! String? else { return nil }
         self.sessionID = sessionID
-        if let displayName = coder.decodeObject(forKey: "displayName") as! String? { self.displayName = displayName }
+        if let name = coder.decodeObject(forKey: "displayName") as! String? { self.name = name }
+        if let nickname = coder.decodeObject(forKey: "nickname") as! String? { self.nickname = nickname }
         if let profilePictureURL = coder.decodeObject(forKey: "profilePictureURL") as! String? { self.profilePictureURL = profilePictureURL }
         if let profilePictureFileName = coder.decodeObject(forKey: "profilePictureFileName") as! String? { self.profilePictureFileName = profilePictureFileName }
         if let profilePictureEncryptionKey = coder.decodeObject(forKey: "profilePictureEncryptionKey") as! OWSAES256Key? { self.profilePictureEncryptionKey = profilePictureEncryptionKey }
@@ -52,7 +69,8 @@ public class Contact : NSObject, NSCoding { // NSObject/NSCoding conformance is
 
     public func encode(with coder: NSCoder) {
         coder.encode(sessionID, forKey: "sessionID")
-        coder.encode(displayName, forKey: "displayName")
+        coder.encode(name, forKey: "displayName")
+        coder.encode(nickname, forKey: "nickname")
         coder.encode(profilePictureURL, forKey: "profilePictureURL")
         coder.encode(profilePictureFileName, forKey: "profilePictureFileName")
         coder.encode(profilePictureEncryptionKey, forKey: "profilePictureEncryptionKey")
@@ -72,10 +90,6 @@ public class Contact : NSObject, NSCoding { // NSObject/NSCoding conformance is
 
     // MARK: Description
     override public var description: String {
-        if let displayName = displayName {
+        nickname ?? name ?? sessionID
-            return displayName
-        } else {
-            return sessionID
-        }
     }
 }

SessionMessagingKit/Sending & Receiving/MessageReceiver+Handling.swift

@@ -244,7 +244,7 @@ extension MessageReceiver {
             let contact = Storage.shared.getContact(with: sessionID) ?? Contact(sessionID: sessionID)
             if let displayName = newProfile.displayName, displayName != oldProfile?.profileName {
                 profileManager.updateProfileForContact(withID: sessionID, displayName: displayName, with: transaction)
-                contact.displayName = displayName
+                contact.name = displayName
             }
             if let profileKey = newProfile.profileKey, let profilePictureURL = newProfile.profilePictureURL, profileKey.count == kAES256_KeyByteLength,
                 profileKey != oldProfile?.profileKey?.keyData {

SessionMessagingKit/To Do/OWSUserProfile.m

@@ -280,7 +280,7 @@ NSString *const kLocalProfileUniqueId = @"kLocalProfileUniqueId";
             completion:completion];
         
         SNContact *contact = [LKStorage.shared getContactWithSessionID:self.sessionID] ?: [[SNContact alloc] initWithSessionID:self.sessionID];
-        contact.displayName = [profileName ows_stripped];
+        contact.name = [profileName ows_stripped];
         contact.profilePictureURL = avatarUrlPath;
         contact.profilePictureFileName = avatarFileName;
         [LKStorage.shared setContact:contact usingTransaction:transaction];
@@ -304,7 +304,7 @@ NSString *const kLocalProfileUniqueId = @"kLocalProfileUniqueId";
             completion:completion];
         
         SNContact *contact = [LKStorage.shared getContactWithSessionID:self.sessionID] ?: [[SNContact alloc] initWithSessionID:self.sessionID];
-        contact.displayName = [profileName ows_stripped];
+        contact.name = [profileName ows_stripped];
         contact.profilePictureURL = avatarUrlPath;
         contact.profilePictureFileName = avatarFileName;
         [LKStorage writeSyncWithBlock:^(YapDatabaseReadWriteTransaction *transaction) {
@@ -326,7 +326,7 @@ NSString *const kLocalProfileUniqueId = @"kLocalProfileUniqueId";
             completion:completion];
     
     SNContact *contact = [LKStorage.shared getContactWithSessionID:self.sessionID] ?: [[SNContact alloc] initWithSessionID:self.sessionID];
-    contact.displayName = [profileName ows_stripped];
+    contact.name = [profileName ows_stripped];
     contact.profilePictureURL = avatarUrlPath;
     [LKStorage writeSyncWithBlock:^(YapDatabaseReadWriteTransaction *transaction) {
         [LKStorage.shared setContact:contact usingTransaction:transaction];

SignalUtilitiesKit/Database/Migrations/ContactsMigration.swift

@@ -26,7 +26,7 @@ public class ContactsMigration : OWSDatabaseMigration {
                     profileOrNil = profile
                 }
                 if let profile = profileOrNil {
-                    contact.displayName = profile.profileName
+                    contact.name = profile.profileName
                     contact.profilePictureURL = profile.avatarUrlPath
                     contact.profilePictureFileName = profile.avatarFileName
                     contact.profilePictureEncryptionKey = profile.profileKey
@@ -42,7 +42,7 @@ public class ContactsMigration : OWSDatabaseMigration {
                     guard !contacts.contains(where: { $0.sessionID == memberSessionID }) else { return }
                     let contact = Contact(sessionID: memberSessionID)
                     if let profile = OWSUserProfile.fetch(uniqueId: memberSessionID, transaction: transaction) {
-                        contact.displayName = profile.profileName
+                        contact.name = profile.profileName
                         contact.profilePictureURL = profile.avatarUrlPath
                         contact.profilePictureFileName = profile.avatarFileName
                         contact.profilePictureEncryptionKey = profile.profileKey