// Copyright © 2022 Rangeproof Pty Ltd. All rights reserved. import Foundation import GRDB import Sodium import DifferenceKit import SessionUtilitiesKit fileprivate typealias ViewModel = SessionThreadViewModel /// This type is used to populate the `ConversationCell` in the `HomeVC`, `MessageRequestsViewController` and the /// `GlobalSearchViewController`, it has a number of query methods which can be used to retrieve the relevant data for each /// screen in a single location in an attempt to avoid spreading out _almost_ duplicated code in multiple places /// /// **Note:** When updating the UI make sure to check the actual queries being run as some fields will have incorrect default values /// in order to optimise their queries to only include the required data public struct SessionThreadViewModel: FetchableRecordWithRowId, Decodable, Equatable, Hashable, Identifiable, Differentiable { public static let rowIdKey: SQL = SQL(stringLiteral: CodingKeys.rowId.stringValue) public static let threadIdKey: SQL = SQL(stringLiteral: CodingKeys.threadId.stringValue) public static let threadVariantKey: SQL = SQL(stringLiteral: CodingKeys.threadVariant.stringValue) public static let threadCreationDateTimestampKey: SQL = SQL(stringLiteral: CodingKeys.threadCreationDateTimestamp.stringValue) public static let threadMemberNamesKey: SQL = SQL(stringLiteral: CodingKeys.threadMemberNames.stringValue) public static let threadIsNoteToSelfKey: SQL = SQL(stringLiteral: CodingKeys.threadIsNoteToSelf.stringValue) public static let threadIsMessageRequestKey: SQL = SQL(stringLiteral: CodingKeys.threadIsMessageRequest.stringValue) public static let threadRequiresApprovalKey: SQL = SQL(stringLiteral: CodingKeys.threadRequiresApproval.stringValue) public static let threadShouldBeVisibleKey: SQL = SQL(stringLiteral: CodingKeys.threadShouldBeVisible.stringValue) public static let threadIsPinnedKey: SQL = SQL(stringLiteral: CodingKeys.threadIsPinned.stringValue) public static let threadIsBlockedKey: SQL = SQL(stringLiteral: CodingKeys.threadIsBlocked.stringValue) public static let threadMutedUntilTimestampKey: SQL = SQL(stringLiteral: CodingKeys.threadMutedUntilTimestamp.stringValue) public static let threadOnlyNotifyForMentionsKey: SQL = SQL(stringLiteral: CodingKeys.threadOnlyNotifyForMentions.stringValue) public static let threadMessageDraftKey: SQL = SQL(stringLiteral: CodingKeys.threadMessageDraft.stringValue) public static let threadContactIsTypingKey: SQL = SQL(stringLiteral: CodingKeys.threadContactIsTyping.stringValue) public static let threadUnreadCountKey: SQL = SQL(stringLiteral: CodingKeys.threadUnreadCount.stringValue) public static let threadUnreadMentionCountKey: SQL = SQL(stringLiteral: CodingKeys.threadUnreadMentionCount.stringValue) public static let contactProfileKey: SQL = SQL(stringLiteral: CodingKeys.contactProfile.stringValue) public static let closedGroupNameKey: SQL = SQL(stringLiteral: CodingKeys.closedGroupName.stringValue) public static let closedGroupUserCountKey: SQL = SQL(stringLiteral: CodingKeys.closedGroupUserCount.stringValue) public static let currentUserIsClosedGroupMemberKey: SQL = SQL(stringLiteral: CodingKeys.currentUserIsClosedGroupMember.stringValue) public static let currentUserIsClosedGroupAdminKey: SQL = SQL(stringLiteral: CodingKeys.currentUserIsClosedGroupAdmin.stringValue) public static let closedGroupProfileFrontKey: SQL = SQL(stringLiteral: CodingKeys.closedGroupProfileFront.stringValue) public static let closedGroupProfileBackKey: SQL = SQL(stringLiteral: CodingKeys.closedGroupProfileBack.stringValue) public static let closedGroupProfileBackFallbackKey: SQL = SQL(stringLiteral: CodingKeys.closedGroupProfileBackFallback.stringValue) public static let openGroupNameKey: SQL = SQL(stringLiteral: CodingKeys.openGroupName.stringValue) public static let openGroupServerKey: SQL = SQL(stringLiteral: CodingKeys.openGroupServer.stringValue) public static let openGroupRoomTokenKey: SQL = SQL(stringLiteral: CodingKeys.openGroupRoomToken.stringValue) public static let openGroupProfilePictureDataKey: SQL = SQL(stringLiteral: CodingKeys.openGroupProfilePictureData.stringValue) public static let openGroupUserCountKey: SQL = SQL(stringLiteral: CodingKeys.openGroupUserCount.stringValue) public static let interactionIdKey: SQL = SQL(stringLiteral: CodingKeys.interactionId.stringValue) public static let interactionVariantKey: SQL = SQL(stringLiteral: CodingKeys.interactionVariant.stringValue) public static let interactionTimestampMsKey: SQL = SQL(stringLiteral: CodingKeys.interactionTimestampMs.stringValue) public static let interactionBodyKey: SQL = SQL(stringLiteral: CodingKeys.interactionBody.stringValue) public static let interactionStateKey: SQL = SQL(stringLiteral: CodingKeys.interactionState.stringValue) public static let interactionIsOpenGroupInvitationKey: SQL = SQL(stringLiteral: CodingKeys.interactionIsOpenGroupInvitation.stringValue) public static let interactionAttachmentDescriptionInfoKey: SQL = SQL(stringLiteral: CodingKeys.interactionAttachmentDescriptionInfo.stringValue) public static let interactionAttachmentCountKey: SQL = SQL(stringLiteral: CodingKeys.interactionAttachmentCount.stringValue) public static let threadContactNameInternalKey: SQL = SQL(stringLiteral: CodingKeys.threadContactNameInternal.stringValue) public static let authorNameInternalKey: SQL = SQL(stringLiteral: CodingKeys.authorNameInternal.stringValue) public static let currentUserPublicKeyKey: SQL = SQL(stringLiteral: CodingKeys.currentUserPublicKey.stringValue) public static let threadUnreadCountString: String = CodingKeys.threadUnreadCount.stringValue public static let threadUnreadMentionCountString: String = CodingKeys.threadUnreadMentionCount.stringValue public static let closedGroupUserCountString: String = CodingKeys.closedGroupUserCount.stringValue public static let openGroupUserCountString: String = CodingKeys.openGroupUserCount.stringValue public static let contactProfileString: String = CodingKeys.contactProfile.stringValue public static let closedGroupProfileFrontString: String = CodingKeys.closedGroupProfileFront.stringValue public static let closedGroupProfileBackString: String = CodingKeys.closedGroupProfileBack.stringValue public static let closedGroupProfileBackFallbackString: String = CodingKeys.closedGroupProfileBackFallback.stringValue public static let interactionAttachmentDescriptionInfoString: String = CodingKeys.interactionAttachmentDescriptionInfo.stringValue public var differenceIdentifier: String { threadId } public var id: String { threadId } public let rowId: Int64 public let threadId: String public let threadVariant: SessionThread.Variant private let threadCreationDateTimestamp: TimeInterval public let threadMemberNames: String? public let threadIsNoteToSelf: Bool /// This flag indicates whether the thread is an outgoing message request public let threadIsMessageRequest: Bool? /// This flag indicates whether the thread is an incoming message request public let threadRequiresApproval: Bool? public let threadShouldBeVisible: Bool? public let threadIsPinned: Bool public let threadIsBlocked: Bool? public let threadMutedUntilTimestamp: TimeInterval? public let threadOnlyNotifyForMentions: Bool? public let threadMessageDraft: String? public let threadContactIsTyping: Bool? public let threadUnreadCount: UInt? public let threadUnreadMentionCount: UInt? // Thread display info private let contactProfile: Profile? private let closedGroupProfileFront: Profile? private let closedGroupProfileBack: Profile? private let closedGroupProfileBackFallback: Profile? public let closedGroupName: String? private let closedGroupUserCount: Int? public let currentUserIsClosedGroupMember: Bool? public let currentUserIsClosedGroupAdmin: Bool? public let openGroupName: String? public let openGroupServer: String? public let openGroupRoomToken: String? public let openGroupProfilePictureData: Data? private let openGroupUserCount: Int? // Interaction display info public let interactionId: Int64? public let interactionVariant: Interaction.Variant? private let interactionTimestampMs: Int64? public let interactionBody: String? public let interactionState: RecipientState.State? public let interactionIsOpenGroupInvitation: Bool? public let interactionAttachmentDescriptionInfo: Attachment.DescriptionInfo? public let interactionAttachmentCount: Int? public let authorId: String? private let threadContactNameInternal: String? private let authorNameInternal: String? public let currentUserPublicKey: String public let currentUserBlindedPublicKey: String? // UI specific logic public var displayName: String { return SessionThread.displayName( threadId: threadId, variant: threadVariant, closedGroupName: closedGroupName, openGroupName: openGroupName, isNoteToSelf: threadIsNoteToSelf, profile: profile ) } public var profile: Profile? { switch threadVariant { case .contact: return contactProfile case .closedGroup: return (closedGroupProfileBack ?? closedGroupProfileBackFallback) case .openGroup: return nil } } public var additionalProfile: Profile? { switch threadVariant { case .closedGroup: return closedGroupProfileFront default: return nil } } public var lastInteractionDate: Date { guard let interactionTimestampMs: Int64 = interactionTimestampMs else { return Date(timeIntervalSince1970: threadCreationDateTimestamp) } return Date(timeIntervalSince1970: (TimeInterval(interactionTimestampMs) / 1000)) } public var enabledMessageTypes: MessageInputTypes { guard !threadIsNoteToSelf else { return .all } return (threadRequiresApproval == false && threadIsMessageRequest == false ? .all : .textOnly ) } public var userCount: Int? { switch threadVariant { case .contact: return nil case .closedGroup: return closedGroupUserCount case .openGroup: return openGroupUserCount } } /// This function returns the thread contact profile name formatted for the specific type of thread provided /// /// **Note:** The 'threadVariant' parameter is used for profile context but in the search results we actually want this /// to always behave as the `contact` variant which is why this needs to be a function instead of just using the provided /// parameter public func threadContactName() -> String { return Profile.displayName( for: .contact, id: threadId, name: threadContactNameInternal, nickname: nil, // Folded into 'threadContactNameInternal' within the Query customFallback: "Anonymous" ) } /// This function returns the profile name formatted for the specific type of thread provided /// /// **Note:** The 'threadVariant' parameter is used for profile context but in the search results we actually want this /// to always behave as the `contact` variant which is why this needs to be a function instead of just using the provided /// parameter public func authorName(for threadVariant: SessionThread.Variant) -> String { return Profile.displayName( for: threadVariant, id: (authorId ?? threadId), name: authorNameInternal, nickname: nil, // Folded into 'authorName' within the Query customFallback: (threadVariant == .contact ? "Anonymous" : nil ) ) } } // MARK: - Convenience Initialization public extension SessionThreadViewModel { static let invalidId: String = "INVALID_THREAD_ID" // Note: This init method is only used system-created cells or empty states init( threadId: String? = nil, threadVariant: SessionThread.Variant? = nil, currentUserIsClosedGroupMember: Bool? = nil, unreadCount: UInt = 0 ) { self.rowId = -1 self.threadId = (threadId ?? SessionThreadViewModel.invalidId) self.threadVariant = (threadVariant ?? .contact) self.threadCreationDateTimestamp = 0 self.threadMemberNames = nil self.threadIsNoteToSelf = false self.threadIsMessageRequest = false self.threadRequiresApproval = false self.threadShouldBeVisible = false self.threadIsPinned = false self.threadIsBlocked = nil self.threadMutedUntilTimestamp = nil self.threadOnlyNotifyForMentions = nil self.threadMessageDraft = nil self.threadContactIsTyping = nil self.threadUnreadCount = unreadCount self.threadUnreadMentionCount = nil // Thread display info self.contactProfile = nil self.closedGroupProfileFront = nil self.closedGroupProfileBack = nil self.closedGroupProfileBackFallback = nil self.closedGroupName = nil self.closedGroupUserCount = nil self.currentUserIsClosedGroupMember = currentUserIsClosedGroupMember self.currentUserIsClosedGroupAdmin = nil self.openGroupName = nil self.openGroupServer = nil self.openGroupRoomToken = nil self.openGroupProfilePictureData = nil self.openGroupUserCount = nil // Interaction display info self.interactionId = nil self.interactionVariant = nil self.interactionTimestampMs = nil self.interactionBody = nil self.interactionState = nil self.interactionIsOpenGroupInvitation = nil self.interactionAttachmentDescriptionInfo = nil self.interactionAttachmentCount = nil self.authorId = nil self.threadContactNameInternal = nil self.authorNameInternal = nil self.currentUserPublicKey = getUserHexEncodedPublicKey() self.currentUserBlindedPublicKey = nil } } // MARK: - Mutation public extension SessionThreadViewModel { func populatingCurrentUserBlindedKey( currentUserBlindedPublicKeyForThisThread: String? = nil ) -> SessionThreadViewModel { return SessionThreadViewModel( rowId: self.rowId, threadId: self.threadId, threadVariant: self.threadVariant, threadCreationDateTimestamp: self.threadCreationDateTimestamp, threadMemberNames: self.threadMemberNames, threadIsNoteToSelf: self.threadIsNoteToSelf, threadIsMessageRequest: self.threadIsMessageRequest, threadRequiresApproval: self.threadRequiresApproval, threadShouldBeVisible: self.threadShouldBeVisible, threadIsPinned: self.threadIsPinned, threadIsBlocked: self.threadIsBlocked, threadMutedUntilTimestamp: self.threadMutedUntilTimestamp, threadOnlyNotifyForMentions: self.threadOnlyNotifyForMentions, threadMessageDraft: self.threadMessageDraft, threadContactIsTyping: self.threadContactIsTyping, threadUnreadCount: self.threadUnreadCount, threadUnreadMentionCount: self.threadUnreadMentionCount, contactProfile: self.contactProfile, closedGroupProfileFront: self.closedGroupProfileFront, closedGroupProfileBack: self.closedGroupProfileBack, closedGroupProfileBackFallback: self.closedGroupProfileBackFallback, closedGroupName: self.closedGroupName, closedGroupUserCount: self.closedGroupUserCount, currentUserIsClosedGroupMember: self.currentUserIsClosedGroupMember, currentUserIsClosedGroupAdmin: self.currentUserIsClosedGroupAdmin, openGroupName: self.openGroupName, openGroupServer: self.openGroupServer, openGroupRoomToken: self.openGroupRoomToken, openGroupProfilePictureData: self.openGroupProfilePictureData, openGroupUserCount: self.openGroupUserCount, interactionId: self.interactionId, interactionVariant: self.interactionVariant, interactionTimestampMs: self.interactionTimestampMs, interactionBody: self.interactionBody, interactionState: self.interactionState, interactionIsOpenGroupInvitation: self.interactionIsOpenGroupInvitation, interactionAttachmentDescriptionInfo: self.interactionAttachmentDescriptionInfo, interactionAttachmentCount: self.interactionAttachmentCount, authorId: self.authorId, threadContactNameInternal: self.threadContactNameInternal, authorNameInternal: self.authorNameInternal, currentUserPublicKey: self.currentUserPublicKey, currentUserBlindedPublicKey: ( currentUserBlindedPublicKeyForThisThread ?? SessionThread.getUserHexEncodedBlindedKey( threadId: self.threadId, threadVariant: self.threadVariant ) ) ) } } // MARK: - HomeVC & MessageRequestsViewController // MARK: --SessionThreadViewModel public extension SessionThreadViewModel { /// **Note:** This query **will not** include deleted incoming messages in it's unread count (they should never be marked as unread /// but including this warning just in case there is a discrepancy) static func baseQuery( userPublicKey: String, filterSQL: SQL, groupSQL: SQL, orderSQL: SQL ) -> (([Int64]) -> AdaptedFetchRequest>) { return { rowIds -> AdaptedFetchRequest> in let thread: TypedTableAlias = TypedTableAlias() let contact: TypedTableAlias = TypedTableAlias() let typingIndicator: TypedTableAlias = TypedTableAlias() let closedGroup: TypedTableAlias = TypedTableAlias() let groupMember: TypedTableAlias = TypedTableAlias() let openGroup: TypedTableAlias = TypedTableAlias() let interaction: TypedTableAlias = TypedTableAlias() let recipientState: TypedTableAlias = TypedTableAlias() let linkPreview: TypedTableAlias = TypedTableAlias() let attachment: TypedTableAlias = TypedTableAlias() let interactionAttachment: TypedTableAlias = TypedTableAlias() let profile: TypedTableAlias = TypedTableAlias() let profileIdColumnLiteral: SQL = SQL(stringLiteral: Profile.Columns.id.name) let profileNicknameColumnLiteral: SQL = SQL(stringLiteral: Profile.Columns.nickname.name) let profileNameColumnLiteral: SQL = SQL(stringLiteral: Profile.Columns.name.name) let firstInteractionAttachmentLiteral: SQL = SQL(stringLiteral: "firstInteractionAttachment") let interactionAttachmentAttachmentIdColumnLiteral: SQL = SQL(stringLiteral: InteractionAttachment.Columns.attachmentId.name) let interactionAttachmentInteractionIdColumnLiteral: SQL = SQL(stringLiteral: InteractionAttachment.Columns.interactionId.name) let interactionAttachmentAlbumIndexColumnLiteral: SQL = SQL(stringLiteral: InteractionAttachment.Columns.albumIndex.name) /// **Note:** The `numColumnsBeforeProfiles` value **MUST** match the number of fields before /// the `ViewModel.contactProfileKey` entry below otherwise the query will fail to /// parse and might throw /// /// Explicitly set default values for the fields ignored for search results let numColumnsBeforeProfiles: Int = 12 let numColumnsBetweenProfilesAndAttachmentInfo: Int = 10 // The attachment info columns will be combined let request: SQLRequest = """ SELECT \(thread.alias[Column.rowID]) AS \(ViewModel.rowIdKey), \(thread[.id]) AS \(ViewModel.threadIdKey), \(thread[.variant]) AS \(ViewModel.threadVariantKey), \(thread[.creationDateTimestamp]) AS \(ViewModel.threadCreationDateTimestampKey), (\(SQL("\(thread[.id]) = \(userPublicKey)"))) AS \(ViewModel.threadIsNoteToSelfKey), \(thread[.isPinned]) AS \(ViewModel.threadIsPinnedKey), \(contact[.isBlocked]) AS \(ViewModel.threadIsBlockedKey), \(thread[.mutedUntilTimestamp]) AS \(ViewModel.threadMutedUntilTimestampKey), \(thread[.onlyNotifyForMentions]) AS \(ViewModel.threadOnlyNotifyForMentionsKey), (\(typingIndicator[.threadId]) IS NOT NULL) AS \(ViewModel.threadContactIsTypingKey), \(Interaction.self).\(ViewModel.threadUnreadCountKey), \(Interaction.self).\(ViewModel.threadUnreadMentionCountKey), \(ViewModel.contactProfileKey).*, \(ViewModel.closedGroupProfileFrontKey).*, \(ViewModel.closedGroupProfileBackKey).*, \(ViewModel.closedGroupProfileBackFallbackKey).*, \(closedGroup[.name]) AS \(ViewModel.closedGroupNameKey), (\(groupMember[.profileId]) IS NOT NULL) AS \(ViewModel.currentUserIsClosedGroupAdminKey), \(openGroup[.name]) AS \(ViewModel.openGroupNameKey), \(openGroup[.imageData]) AS \(ViewModel.openGroupProfilePictureDataKey), \(Interaction.self).\(ViewModel.interactionIdKey), \(Interaction.self).\(ViewModel.interactionVariantKey), \(Interaction.self).\(ViewModel.interactionTimestampMsKey), \(Interaction.self).\(ViewModel.interactionBodyKey), -- Default to 'sending' assuming non-processed interaction when null IFNULL(MIN(\(recipientState[.state])), \(SQL("\(RecipientState.State.sending)"))) AS \(ViewModel.interactionStateKey), (\(linkPreview[.url]) IS NOT NULL) AS \(ViewModel.interactionIsOpenGroupInvitationKey), -- These 4 properties will be combined into 'Attachment.DescriptionInfo' \(attachment[.id]), \(attachment[.variant]), \(attachment[.contentType]), \(attachment[.sourceFilename]), COUNT(\(interactionAttachment[.interactionId])) AS \(ViewModel.interactionAttachmentCountKey), \(interaction[.authorId]), IFNULL(\(ViewModel.contactProfileKey).\(profileNicknameColumnLiteral), \(ViewModel.contactProfileKey).\(profileNameColumnLiteral)) AS \(ViewModel.threadContactNameInternalKey), IFNULL(\(profile[.nickname]), \(profile[.name])) AS \(ViewModel.authorNameInternalKey), \(SQL("\(userPublicKey)")) AS \(ViewModel.currentUserPublicKeyKey) FROM \(SessionThread.self) LEFT JOIN \(Contact.self) ON \(contact[.id]) = \(thread[.id]) LEFT JOIN \(ThreadTypingIndicator.self) ON \(typingIndicator[.threadId]) = \(thread[.id]) LEFT JOIN ( -- Fetch all interaction-specific data in a subquery to be more efficient SELECT \(interaction[.id]) AS \(ViewModel.interactionIdKey), \(interaction[.threadId]), \(interaction[.variant]) AS \(ViewModel.interactionVariantKey), MAX(\(interaction[.timestampMs])) AS \(ViewModel.interactionTimestampMsKey), \(interaction[.body]) AS \(ViewModel.interactionBodyKey), \(interaction[.authorId]), \(interaction[.linkPreviewUrl]), SUM(\(interaction[.wasRead]) = false) AS \(ViewModel.threadUnreadCountKey), SUM(\(interaction[.wasRead]) = false AND \(interaction[.hasMention]) = true) AS \(ViewModel.threadUnreadMentionCountKey) FROM \(Interaction.self) WHERE \(SQL("\(interaction[.variant]) != \(Interaction.Variant.standardIncomingDeleted)")) GROUP BY \(interaction[.threadId]) ) AS \(Interaction.self) ON \(interaction[.threadId]) = \(thread[.id]) LEFT JOIN \(RecipientState.self) ON ( -- Ignore 'skipped' states \(SQL("\(recipientState[.state]) != \(RecipientState.State.skipped)")) AND \(recipientState[.interactionId]) = \(Interaction.self).\(ViewModel.interactionIdKey) ) LEFT JOIN \(LinkPreview.self) ON ( \(linkPreview[.url]) = \(interaction[.linkPreviewUrl]) AND \(SQL("\(linkPreview[.variant]) = \(LinkPreview.Variant.openGroupInvitation)")) AND \(Interaction.linkPreviewFilterLiteral(timestampColumn: ViewModel.interactionTimestampMsKey)) ) LEFT JOIN \(InteractionAttachment.self) AS \(firstInteractionAttachmentLiteral) ON ( \(firstInteractionAttachmentLiteral).\(interactionAttachmentAlbumIndexColumnLiteral) = 0 AND \(firstInteractionAttachmentLiteral).\(interactionAttachmentInteractionIdColumnLiteral) = \(Interaction.self).\(ViewModel.interactionIdKey) ) LEFT JOIN \(Attachment.self) ON \(attachment[.id]) = \(firstInteractionAttachmentLiteral).\(interactionAttachmentAttachmentIdColumnLiteral) LEFT JOIN \(InteractionAttachment.self) ON \(interactionAttachment[.interactionId]) = \(Interaction.self).\(ViewModel.interactionIdKey) LEFT JOIN \(Profile.self) ON \(profile[.id]) = \(interaction[.authorId]) -- Thread naming & avatar content LEFT JOIN \(Profile.self) AS \(ViewModel.contactProfileKey) ON \(ViewModel.contactProfileKey).\(profileIdColumnLiteral) = \(thread[.id]) LEFT JOIN \(OpenGroup.self) ON \(openGroup[.threadId]) = \(thread[.id]) LEFT JOIN \(ClosedGroup.self) ON \(closedGroup[.threadId]) = \(thread[.id]) LEFT JOIN \(GroupMember.self) ON ( \(SQL("\(groupMember[.role]) = \(GroupMember.Role.admin)")) AND \(groupMember[.groupId]) = \(closedGroup[.threadId]) AND \(SQL("\(groupMember[.profileId]) = \(userPublicKey)")) ) LEFT JOIN \(Profile.self) AS \(ViewModel.closedGroupProfileFrontKey) ON ( \(ViewModel.closedGroupProfileFrontKey).\(profileIdColumnLiteral) = ( SELECT MIN(\(groupMember[.profileId])) FROM \(GroupMember.self) JOIN \(Profile.self) ON \(profile[.id]) = \(groupMember[.profileId]) WHERE ( \(SQL("\(groupMember[.role]) = \(GroupMember.Role.standard)")) AND \(groupMember[.groupId]) = \(closedGroup[.threadId]) AND \(SQL("\(groupMember[.profileId]) != \(userPublicKey)")) ) ) ) LEFT JOIN \(Profile.self) AS \(ViewModel.closedGroupProfileBackKey) ON ( \(ViewModel.closedGroupProfileBackKey).\(profileIdColumnLiteral) != \(ViewModel.closedGroupProfileFrontKey).\(profileIdColumnLiteral) AND \(ViewModel.closedGroupProfileBackKey).\(profileIdColumnLiteral) = ( SELECT MAX(\(groupMember[.profileId])) FROM \(GroupMember.self) JOIN \(Profile.self) ON \(profile[.id]) = \(groupMember[.profileId]) WHERE ( \(SQL("\(groupMember[.role]) = \(GroupMember.Role.standard)")) AND \(groupMember[.groupId]) = \(closedGroup[.threadId]) AND \(SQL("\(groupMember[.profileId]) != \(userPublicKey)")) ) ) ) LEFT JOIN \(Profile.self) AS \(ViewModel.closedGroupProfileBackFallbackKey) ON ( \(closedGroup[.threadId]) IS NOT NULL AND \(ViewModel.closedGroupProfileBackKey).\(profileIdColumnLiteral) IS NULL AND \(ViewModel.closedGroupProfileBackFallbackKey).\(profileIdColumnLiteral) = \(SQL("\(userPublicKey)")) ) WHERE \(thread.alias[Column.rowID]) IN \(rowIds) \(groupSQL) ORDER BY \(orderSQL) """ return request.adapted { db in let adapters = try splittingRowAdapters(columnCounts: [ numColumnsBeforeProfiles, Profile.numberOfSelectedColumns(db), Profile.numberOfSelectedColumns(db), Profile.numberOfSelectedColumns(db), Profile.numberOfSelectedColumns(db), numColumnsBetweenProfilesAndAttachmentInfo, Attachment.DescriptionInfo.numberOfSelectedColumns() ]) return ScopeAdapter([ ViewModel.contactProfileString: adapters[1], ViewModel.closedGroupProfileFrontString: adapters[2], ViewModel.closedGroupProfileBackString: adapters[3], ViewModel.closedGroupProfileBackFallbackString: adapters[4], ViewModel.interactionAttachmentDescriptionInfoString: adapters[6] ]) } } } static var optimisedJoinSQL: SQL = { let thread: TypedTableAlias = TypedTableAlias() let contact: TypedTableAlias = TypedTableAlias() let interaction: TypedTableAlias = TypedTableAlias() return """ LEFT JOIN \(Contact.self) ON \(contact[.id]) = \(thread[.id]) LEFT JOIN ( SELECT \(interaction[.threadId]), MAX(\(interaction[.timestampMs])) AS \(ViewModel.interactionTimestampMsKey) FROM \(Interaction.self) WHERE \(SQL("\(interaction[.variant]) != \(Interaction.Variant.standardIncomingDeleted)")) GROUP BY \(interaction[.threadId]) ) AS \(Interaction.self) ON \(interaction[.threadId]) = \(thread[.id]) """ }() static func homeFilterSQL(userPublicKey: String) -> SQL { let thread: TypedTableAlias = TypedTableAlias() let contact: TypedTableAlias = TypedTableAlias() return """ \(thread[.shouldBeVisible]) = true AND ( -- Is not a message request \(SQL("\(thread[.variant]) != \(SessionThread.Variant.contact)")) OR \(SQL("\(thread[.id]) = \(userPublicKey)")) OR \(contact[.isApproved]) = true ) AND ( -- Only show the 'Note to Self' thread if it has an interaction \(SQL("\(thread[.id]) != \(userPublicKey)")) OR \(Interaction.self).\(ViewModel.interactionTimestampMsKey) IS NOT NULL ) """ } static func messageRequestsFilterSQL(userPublicKey: String) -> SQL { let thread: TypedTableAlias = TypedTableAlias() let contact: TypedTableAlias = TypedTableAlias() return """ \(thread[.shouldBeVisible]) = true AND ( -- Is a message request \(SQL("\(thread[.variant]) = \(SessionThread.Variant.contact)")) AND \(SQL("\(thread[.id]) != \(userPublicKey)")) AND IFNULL(\(contact[.isApproved]), false) = false ) """ } static let groupSQL: SQL = { let thread: TypedTableAlias = TypedTableAlias() return SQL("GROUP BY \(thread[.id])") }() static let homeOrderSQL: SQL = { let thread: TypedTableAlias = TypedTableAlias() return SQL("\(thread[.isPinned]) DESC, IFNULL(\(Interaction.self).\(ViewModel.interactionTimestampMsKey), (\(thread[.creationDateTimestamp]) * 1000)) DESC") }() static let messageRequetsOrderSQL: SQL = { let thread: TypedTableAlias = TypedTableAlias() return SQL("IFNULL(\(Interaction.self).\(ViewModel.interactionTimestampMsKey), (\(thread[.creationDateTimestamp]) * 1000)) DESC") }() } // MARK: - ConversationVC public extension SessionThreadViewModel { /// **Note:** This query **will** include deleted incoming messages in it's unread count (they should never be marked as unread /// but including this warning just in case there is a discrepancy) static func conversationQuery(threadId: String, userPublicKey: String) -> AdaptedFetchRequest> { let thread: TypedTableAlias = TypedTableAlias() let contact: TypedTableAlias = TypedTableAlias() let closedGroup: TypedTableAlias = TypedTableAlias() let groupMember: TypedTableAlias = TypedTableAlias() let openGroup: TypedTableAlias = TypedTableAlias() let interaction: TypedTableAlias = TypedTableAlias() let closedGroupUserCountTableLiteral: SQL = SQL(stringLiteral: "\(ViewModel.closedGroupUserCountString)_table") let groupMemberGroupIdColumnLiteral: SQL = SQL(stringLiteral: GroupMember.Columns.groupId.name) let profileIdColumnLiteral: SQL = SQL(stringLiteral: Profile.Columns.id.name) /// **Note:** The `numColumnsBeforeProfiles` value **MUST** match the number of fields before /// the `ViewModel.contactProfileKey` entry below otherwise the query will fail to /// parse and might throw /// /// Explicitly set default values for the fields ignored for search results let numColumnsBeforeProfiles: Int = 14 let request: SQLRequest = """ SELECT \(thread.alias[Column.rowID]) AS \(ViewModel.rowIdKey), \(thread[.id]) AS \(ViewModel.threadIdKey), \(thread[.variant]) AS \(ViewModel.threadVariantKey), \(thread[.creationDateTimestamp]) AS \(ViewModel.threadCreationDateTimestampKey), (\(SQL("\(thread[.id]) = \(userPublicKey)"))) AS \(ViewModel.threadIsNoteToSelfKey), ( \(SQL("\(thread[.variant]) = \(SessionThread.Variant.contact)")) AND \(SQL("\(thread[.id]) != \(userPublicKey)")) AND IFNULL(\(contact[.isApproved]), false) = false ) AS \(ViewModel.threadIsMessageRequestKey), ( \(SQL("\(thread[.variant]) = \(SessionThread.Variant.contact)")) AND IFNULL(\(contact[.didApproveMe]), false) = false ) AS \(ViewModel.threadRequiresApprovalKey), \(thread[.shouldBeVisible]) AS \(ViewModel.threadShouldBeVisibleKey), \(thread[.isPinned]) AS \(ViewModel.threadIsPinnedKey), \(contact[.isBlocked]) AS \(ViewModel.threadIsBlockedKey), \(thread[.mutedUntilTimestamp]) AS \(ViewModel.threadMutedUntilTimestampKey), \(thread[.onlyNotifyForMentions]) AS \(ViewModel.threadOnlyNotifyForMentionsKey), \(thread[.messageDraft]) AS \(ViewModel.threadMessageDraftKey), \(Interaction.self).\(ViewModel.threadUnreadCountKey), \(ViewModel.contactProfileKey).*, \(closedGroup[.name]) AS \(ViewModel.closedGroupNameKey), \(closedGroupUserCountTableLiteral).\(ViewModel.closedGroupUserCountKey) AS \(ViewModel.closedGroupUserCountKey), (\(groupMember[.profileId]) IS NOT NULL) AS \(ViewModel.currentUserIsClosedGroupMemberKey), \(openGroup[.name]) AS \(ViewModel.openGroupNameKey), \(openGroup[.server]) AS \(ViewModel.openGroupServerKey), \(openGroup[.roomToken]) AS \(ViewModel.openGroupRoomTokenKey), \(openGroup[.userCount]) AS \(ViewModel.openGroupUserCountKey), \(Interaction.self).\(ViewModel.interactionIdKey), \(SQL("\(userPublicKey)")) AS \(ViewModel.currentUserPublicKeyKey) FROM \(SessionThread.self) LEFT JOIN \(Contact.self) ON \(contact[.id]) = \(thread[.id]) LEFT JOIN ( -- Fetch all interaction-specific data in a subquery to be more efficient SELECT \(interaction[.id]) AS \(ViewModel.interactionIdKey), \(interaction[.threadId]), MAX(\(interaction[.timestampMs])), SUM(\(interaction[.wasRead]) = false) AS \(ViewModel.threadUnreadCountKey) FROM \(Interaction.self) GROUP BY \(interaction[.threadId]) ) AS \(Interaction.self) ON \(interaction[.threadId]) = \(thread[.id]) LEFT JOIN \(Profile.self) AS \(ViewModel.contactProfileKey) ON \(ViewModel.contactProfileKey).\(profileIdColumnLiteral) = \(thread[.id]) LEFT JOIN \(OpenGroup.self) ON \(openGroup[.threadId]) = \(thread[.id]) LEFT JOIN \(ClosedGroup.self) ON \(closedGroup[.threadId]) = \(thread[.id]) LEFT JOIN \(GroupMember.self) ON ( \(SQL("\(groupMember[.role]) = \(GroupMember.Role.standard)")) AND \(groupMember[.groupId]) = \(closedGroup[.threadId]) AND \(SQL("\(groupMember[.profileId]) = \(userPublicKey)")) ) LEFT JOIN ( SELECT \(groupMember[.groupId]), COUNT(*) AS \(ViewModel.closedGroupUserCountKey) FROM \(GroupMember.self) WHERE ( \(SQL("\(groupMember[.groupId]) = \(threadId)")) AND \(SQL("\(groupMember[.role]) = \(GroupMember.Role.standard)")) ) GROUP BY \(groupMember[.groupId]) ) AS \(closedGroupUserCountTableLiteral) ON \(SQL("\(closedGroupUserCountTableLiteral).\(groupMemberGroupIdColumnLiteral) = \(threadId)")) WHERE \(SQL("\(thread[.id]) = \(threadId)")) GROUP BY \(thread[.id]) """ return request.adapted { db in let adapters = try splittingRowAdapters(columnCounts: [ numColumnsBeforeProfiles, Profile.numberOfSelectedColumns(db) ]) return ScopeAdapter([ ViewModel.contactProfileString: adapters[1] ]) } } static func conversationSettingsProfileQuery(threadId: String, userPublicKey: String) -> AdaptedFetchRequest> { let thread: TypedTableAlias = TypedTableAlias() let closedGroup: TypedTableAlias = TypedTableAlias() let groupMember: TypedTableAlias = TypedTableAlias() let openGroup: TypedTableAlias = TypedTableAlias() let profile: TypedTableAlias = TypedTableAlias() let profileIdColumnLiteral: SQL = SQL(stringLiteral: Profile.Columns.id.name) /// **Note:** The `numColumnsBeforeProfiles` value **MUST** match the number of fields before /// the `ViewModel.contactProfileKey` entry below otherwise the query will fail to /// parse and might throw /// /// Explicitly set default values for the fields ignored for search results let numColumnsBeforeProfiles: Int = 6 let request: SQLRequest = """ SELECT \(thread.alias[Column.rowID]) AS \(ViewModel.rowIdKey), \(thread[.id]) AS \(ViewModel.threadIdKey), \(thread[.variant]) AS \(ViewModel.threadVariantKey), \(thread[.creationDateTimestamp]) AS \(ViewModel.threadCreationDateTimestampKey), false AS \(ViewModel.threadIsNoteToSelfKey), false AS \(ViewModel.threadIsPinnedKey), \(ViewModel.contactProfileKey).*, \(ViewModel.closedGroupProfileFrontKey).*, \(ViewModel.closedGroupProfileBackKey).*, \(ViewModel.closedGroupProfileBackFallbackKey).*, \(openGroup[.imageData]) AS \(ViewModel.openGroupProfilePictureDataKey), \(SQL("\(userPublicKey)")) AS \(ViewModel.currentUserPublicKeyKey) FROM \(SessionThread.self) LEFT JOIN \(Profile.self) AS \(ViewModel.contactProfileKey) ON \(ViewModel.contactProfileKey).\(profileIdColumnLiteral) = \(thread[.id]) LEFT JOIN \(ClosedGroup.self) ON \(closedGroup[.threadId]) = \(thread[.id]) LEFT JOIN \(OpenGroup.self) ON \(openGroup[.threadId]) = \(thread[.id]) LEFT JOIN \(Profile.self) AS \(ViewModel.closedGroupProfileFrontKey) ON ( \(ViewModel.closedGroupProfileFrontKey).\(profileIdColumnLiteral) = ( SELECT MIN(\(groupMember[.profileId])) FROM \(GroupMember.self) JOIN \(Profile.self) ON \(profile[.id]) = \(groupMember[.profileId]) WHERE ( \(SQL("\(groupMember[.role]) = \(GroupMember.Role.standard)")) AND \(groupMember[.groupId]) = \(closedGroup[.threadId]) AND \(SQL("\(groupMember[.profileId]) != \(userPublicKey)")) ) ) ) LEFT JOIN \(Profile.self) AS \(ViewModel.closedGroupProfileBackKey) ON ( \(ViewModel.closedGroupProfileBackKey).\(profileIdColumnLiteral) != \(ViewModel.closedGroupProfileFrontKey).\(profileIdColumnLiteral) AND \(ViewModel.closedGroupProfileBackKey).\(profileIdColumnLiteral) = ( SELECT MAX(\(groupMember[.profileId])) FROM \(GroupMember.self) JOIN \(Profile.self) ON \(profile[.id]) = \(groupMember[.profileId]) WHERE ( \(SQL("\(groupMember[.role]) = \(GroupMember.Role.standard)")) AND \(groupMember[.groupId]) = \(closedGroup[.threadId]) AND \(SQL("\(groupMember[.profileId]) != \(userPublicKey)")) ) ) ) LEFT JOIN \(Profile.self) AS \(ViewModel.closedGroupProfileBackFallbackKey) ON ( \(closedGroup[.threadId]) IS NOT NULL AND \(ViewModel.closedGroupProfileBackKey).\(profileIdColumnLiteral) IS NULL AND \(ViewModel.closedGroupProfileBackFallbackKey).\(profileIdColumnLiteral) = \(SQL("\(userPublicKey)")) ) WHERE \(SQL("\(thread[.id]) = \(threadId)")) """ return request.adapted { db in let adapters = try splittingRowAdapters(columnCounts: [ numColumnsBeforeProfiles, Profile.numberOfSelectedColumns(db), Profile.numberOfSelectedColumns(db), Profile.numberOfSelectedColumns(db), Profile.numberOfSelectedColumns(db) ]) return ScopeAdapter([ ViewModel.contactProfileString: adapters[1], ViewModel.closedGroupProfileFrontString: adapters[2], ViewModel.closedGroupProfileBackString: adapters[3], ViewModel.closedGroupProfileBackFallbackString: adapters[4] ]) } } } // MARK: - Search Queries public extension SessionThreadViewModel { fileprivate static let searchResultsLimit: Int = 500 static func searchTermParts(_ searchTerm: String) -> [String] { /// Process the search term in order to extract the parts of the search pattern we want /// /// Step 1 - Keep any "quoted" sections as stand-alone search /// Step 2 - Separate any words outside of quotes /// Step 3 - Join the different search term parts with 'OR" (include results for each individual term) /// Step 4 - Append a wild-card character to the final word return searchTerm .split(separator: "\"") .enumerated() .flatMap { index, value -> [String] in guard index % 2 == 1 else { return String(value) .split(separator: " ") .map { String($0) } } return ["\"\(value)\""] } .filter { !$0.isEmpty } } static func pattern(_ db: Database, searchTerm: String) throws -> FTS5Pattern { // Note: FTS doesn't support both prefix/suffix wild cards so don't bother trying to // add a prefix one let rawPattern: String = searchTermParts(searchTerm) .joined(separator: " OR ") .appending("*") /// There are cases where creating a pattern can fail, we want to try and recover from those cases /// by failling back to simpler patterns if needed let maybePattern: FTS5Pattern? = (try? db.makeFTS5Pattern(rawPattern: rawPattern, forTable: Interaction.self)) .defaulting( to: (try? db.makeFTS5Pattern(rawPattern: searchTerm, forTable: Interaction.self)) .defaulting(to: FTS5Pattern(matchingAnyTokenIn: searchTerm)) ) guard let pattern: FTS5Pattern = maybePattern else { throw StorageError.invalidSearchPattern } return pattern } static func messagesQuery(userPublicKey: String, pattern: FTS5Pattern) -> AdaptedFetchRequest> { let interaction: TypedTableAlias = TypedTableAlias() let thread: TypedTableAlias = TypedTableAlias() let closedGroup: TypedTableAlias = TypedTableAlias() let groupMember: TypedTableAlias = TypedTableAlias() let openGroup: TypedTableAlias = TypedTableAlias() let profile: TypedTableAlias = TypedTableAlias() let profileIdColumnLiteral: SQL = SQL(stringLiteral: Profile.Columns.id.name) let interactionLiteral: SQL = SQL(stringLiteral: Interaction.databaseTableName) let interactionFullTextSearch: SQL = SQL(stringLiteral: Interaction.fullTextSearchTableName) /// **Note:** The `numColumnsBeforeProfiles` value **MUST** match the number of fields before /// the `ViewModel.contactProfileKey` entry below otherwise the query will fail to /// parse and might throw /// /// Explicitly set default values for the fields ignored for search results let numColumnsBeforeProfiles: Int = 6 let request: SQLRequest = """ SELECT \(interaction.alias[Column.rowID]) AS \(ViewModel.rowIdKey), \(thread[.id]) AS \(ViewModel.threadIdKey), \(thread[.variant]) AS \(ViewModel.threadVariantKey), \(thread[.creationDateTimestamp]) AS \(ViewModel.threadCreationDateTimestampKey), (\(SQL("\(thread[.id]) = \(userPublicKey)"))) AS \(ViewModel.threadIsNoteToSelfKey), \(thread[.isPinned]) AS \(ViewModel.threadIsPinnedKey), \(ViewModel.contactProfileKey).*, \(ViewModel.closedGroupProfileFrontKey).*, \(ViewModel.closedGroupProfileBackKey).*, \(ViewModel.closedGroupProfileBackFallbackKey).*, \(closedGroup[.name]) AS \(ViewModel.closedGroupNameKey), \(openGroup[.name]) AS \(ViewModel.openGroupNameKey), \(openGroup[.imageData]) AS \(ViewModel.openGroupProfilePictureDataKey), \(interaction[.id]) AS \(ViewModel.interactionIdKey), \(interaction[.variant]) AS \(ViewModel.interactionVariantKey), \(interaction[.timestampMs]) AS \(ViewModel.interactionTimestampMsKey), \(interaction[.body]) AS \(ViewModel.interactionBodyKey), \(interaction[.authorId]), IFNULL(\(profile[.nickname]), \(profile[.name])) AS \(ViewModel.authorNameInternalKey), \(SQL("\(userPublicKey)")) AS \(ViewModel.currentUserPublicKeyKey) FROM \(Interaction.self) JOIN \(interactionFullTextSearch) ON ( \(interactionFullTextSearch).rowid = \(interactionLiteral).rowid AND \(interactionFullTextSearch).\(SQL(stringLiteral: Interaction.Columns.body.name)) MATCH \(pattern) ) JOIN \(SessionThread.self) ON \(thread[.id]) = \(interaction[.threadId]) JOIN \(Profile.self) ON \(profile[.id]) = \(interaction[.authorId]) LEFT JOIN \(Profile.self) AS \(ViewModel.contactProfileKey) ON \(ViewModel.contactProfileKey).\(profileIdColumnLiteral) = \(interaction[.threadId]) LEFT JOIN \(ClosedGroup.self) ON \(closedGroup[.threadId]) = \(interaction[.threadId]) LEFT JOIN \(OpenGroup.self) ON \(openGroup[.threadId]) = \(interaction[.threadId]) LEFT JOIN \(Profile.self) AS \(ViewModel.closedGroupProfileFrontKey) ON ( \(ViewModel.closedGroupProfileFrontKey).\(profileIdColumnLiteral) = ( SELECT MIN(\(groupMember[.profileId])) FROM \(GroupMember.self) JOIN \(Profile.self) ON \(profile[.id]) = \(groupMember[.profileId]) WHERE ( \(SQL("\(groupMember[.role]) = \(GroupMember.Role.standard)")) AND \(groupMember[.groupId]) = \(closedGroup[.threadId]) AND \(groupMember[.profileId]) != \(userPublicKey) ) ) ) LEFT JOIN \(Profile.self) AS \(ViewModel.closedGroupProfileBackKey) ON ( \(ViewModel.closedGroupProfileBackKey).\(profileIdColumnLiteral) != \(ViewModel.closedGroupProfileFrontKey).\(profileIdColumnLiteral) AND \(ViewModel.closedGroupProfileBackKey).\(profileIdColumnLiteral) = ( SELECT MAX(\(groupMember[.profileId])) FROM \(GroupMember.self) JOIN \(Profile.self) ON \(profile[.id]) = \(groupMember[.profileId]) WHERE ( \(SQL("\(groupMember[.role]) = \(GroupMember.Role.standard)")) AND \(groupMember[.groupId]) = \(closedGroup[.threadId]) AND \(groupMember[.profileId]) != \(userPublicKey) ) ) ) LEFT JOIN \(Profile.self) AS \(ViewModel.closedGroupProfileBackFallbackKey) ON ( \(closedGroup[.threadId]) IS NOT NULL AND \(ViewModel.closedGroupProfileBackKey).\(profileIdColumnLiteral) IS NULL AND \(ViewModel.closedGroupProfileBackFallbackKey).\(profileIdColumnLiteral) = \(userPublicKey) ) ORDER BY \(Column.rank), \(interaction[.timestampMs].desc) LIMIT \(SQL("\(SessionThreadViewModel.searchResultsLimit)")) """ return request.adapted { db in let adapters = try splittingRowAdapters(columnCounts: [ numColumnsBeforeProfiles, Profile.numberOfSelectedColumns(db), Profile.numberOfSelectedColumns(db), Profile.numberOfSelectedColumns(db), Profile.numberOfSelectedColumns(db) ]) return ScopeAdapter([ ViewModel.contactProfileString: adapters[1], ViewModel.closedGroupProfileFrontString: adapters[2], ViewModel.closedGroupProfileBackString: adapters[3], ViewModel.closedGroupProfileBackFallbackString: adapters[4] ]) } } /// This method does an FTS search against threads and their contacts to find any which contain the pattern /// /// **Note:** Unfortunately the FTS search only allows for a single pattern match per query which means we /// need to combine the results of **all** of the following potential matches as unioned queries: /// - Contact thread contact nickname /// - Contact thread contact name /// - Closed group name /// - Closed group member nickname /// - Closed group member name /// - Open group name /// - "Note to self" text match static func contactsAndGroupsQuery(userPublicKey: String, pattern: FTS5Pattern, searchTerm: String) -> AdaptedFetchRequest> { let thread: TypedTableAlias = TypedTableAlias() let closedGroup: TypedTableAlias = TypedTableAlias() let groupMember: TypedTableAlias = TypedTableAlias() let openGroup: TypedTableAlias = TypedTableAlias() let profile: TypedTableAlias = TypedTableAlias() let profileIdColumnLiteral: SQL = SQL(stringLiteral: Profile.Columns.id.name) let profileNicknameColumnLiteral: SQL = SQL(stringLiteral: Profile.Columns.nickname.name) let profileNameColumnLiteral: SQL = SQL(stringLiteral: Profile.Columns.name.name) let profileFullTextSearch: SQL = SQL(stringLiteral: Profile.fullTextSearchTableName) let closedGroupNameColumnLiteral: SQL = SQL(stringLiteral: ClosedGroup.Columns.name.name) let closedGroupLiteral: SQL = SQL(stringLiteral: ClosedGroup.databaseTableName) let closedGroupFullTextSearch: SQL = SQL(stringLiteral: ClosedGroup.fullTextSearchTableName) let openGroupNameColumnLiteral: SQL = SQL(stringLiteral: OpenGroup.Columns.name.name) let openGroupLiteral: SQL = SQL(stringLiteral: OpenGroup.databaseTableName) let openGroupFullTextSearch: SQL = SQL(stringLiteral: OpenGroup.fullTextSearchTableName) let groupMemberInfoLiteral: SQL = SQL(stringLiteral: "groupMemberInfo") let groupMemberGroupIdColumnLiteral: SQL = SQL(stringLiteral: GroupMember.Columns.groupId.name) let groupMemberProfileLiteral: SQL = SQL(stringLiteral: "groupMemberProfile") let noteToSelfLiteral: SQL = SQL(stringLiteral: "NOTE_TO_SELF".localized().lowercased()) let searchTermLiteral: SQL = SQL(stringLiteral: searchTerm.lowercased()) /// **Note:** The `numColumnsBeforeProfiles` value **MUST** match the number of fields before /// the `ViewModel.contactProfileKey` entry below otherwise the query will fail to /// parse and might throw /// /// We use `IFNULL(rank, 100)` because the custom `Note to Self` like comparison will get a null /// `rank` value which ends up as the first result, by defaulting to `100` it will always be ranked last compared /// to any relevance-based results let numColumnsBeforeProfiles: Int = 8 var sqlQuery: SQL = "" let selectQuery: SQL = """ SELECT IFNULL(\(Column.rank), 100) AS \(Column.rank), \(thread.alias[Column.rowID]) AS \(ViewModel.rowIdKey), \(thread[.id]) AS \(ViewModel.threadIdKey), \(thread[.variant]) AS \(ViewModel.threadVariantKey), \(thread[.creationDateTimestamp]) AS \(ViewModel.threadCreationDateTimestampKey), \(groupMemberInfoLiteral).\(ViewModel.threadMemberNamesKey), (\(SQL("\(thread[.id]) = \(userPublicKey)"))) AS \(ViewModel.threadIsNoteToSelfKey), \(thread[.isPinned]) AS \(ViewModel.threadIsPinnedKey), \(ViewModel.contactProfileKey).*, \(ViewModel.closedGroupProfileFrontKey).*, \(ViewModel.closedGroupProfileBackKey).*, \(ViewModel.closedGroupProfileBackFallbackKey).*, \(closedGroup[.name]) AS \(ViewModel.closedGroupNameKey), \(openGroup[.name]) AS \(ViewModel.openGroupNameKey), \(openGroup[.imageData]) AS \(ViewModel.openGroupProfilePictureDataKey), \(SQL("\(userPublicKey)")) AS \(ViewModel.currentUserPublicKeyKey) FROM \(SessionThread.self) """ // MARK: --Contact Threads let contactQueryCommonJoinFilterGroup: SQL = """ JOIN \(Profile.self) AS \(ViewModel.contactProfileKey) ON \(ViewModel.contactProfileKey).\(profileIdColumnLiteral) = \(thread[.id]) LEFT JOIN \(Profile.self) AS \(ViewModel.closedGroupProfileFrontKey) ON false LEFT JOIN \(Profile.self) AS \(ViewModel.closedGroupProfileBackKey) ON false LEFT JOIN \(Profile.self) AS \(ViewModel.closedGroupProfileBackFallbackKey) ON false LEFT JOIN \(ClosedGroup.self) ON false LEFT JOIN \(OpenGroup.self) ON false LEFT JOIN ( SELECT \(groupMember[.groupId]), '' AS \(ViewModel.threadMemberNamesKey) FROM \(GroupMember.self) ) AS \(groupMemberInfoLiteral) ON false WHERE \(SQL("\(thread[.variant]) = \(SessionThread.Variant.contact)")) AND \(SQL("\(thread[.id]) != \(userPublicKey)")) GROUP BY \(thread[.id]) """ // Contact thread nickname searching (ignoring note to self - handled separately) sqlQuery += selectQuery sqlQuery += """ JOIN \(profileFullTextSearch) ON ( \(profileFullTextSearch).rowid = \(ViewModel.contactProfileKey).rowid AND \(profileFullTextSearch).\(profileNicknameColumnLiteral) MATCH \(pattern) ) """ sqlQuery += contactQueryCommonJoinFilterGroup // Contact thread name searching (ignoring note to self - handled separately) sqlQuery += """ UNION ALL """ sqlQuery += selectQuery sqlQuery += """ JOIN \(profileFullTextSearch) ON ( \(profileFullTextSearch).rowid = \(ViewModel.contactProfileKey).rowid AND \(profileFullTextSearch).\(profileNameColumnLiteral) MATCH \(pattern) ) """ sqlQuery += contactQueryCommonJoinFilterGroup // MARK: --Closed Group Threads let closedGroupQueryCommonJoinFilterGroup: SQL = """ JOIN \(ClosedGroup.self) ON \(closedGroup[.threadId]) = \(thread[.id]) JOIN \(GroupMember.self) ON ( \(SQL("\(groupMember[.role]) = \(GroupMember.Role.standard)")) AND \(groupMember[.groupId]) = \(thread[.id]) ) LEFT JOIN ( SELECT \(groupMember[.groupId]), GROUP_CONCAT(IFNULL(\(profile[.nickname]), \(profile[.name])), ', ') AS \(ViewModel.threadMemberNamesKey) FROM \(GroupMember.self) JOIN \(Profile.self) ON \(profile[.id]) = \(groupMember[.profileId]) WHERE \(SQL("\(groupMember[.role]) = \(GroupMember.Role.standard)")) GROUP BY \(groupMember[.groupId]) ) AS \(groupMemberInfoLiteral) ON \(groupMemberInfoLiteral).\(groupMemberGroupIdColumnLiteral) = \(closedGroup[.threadId]) LEFT JOIN \(Profile.self) AS \(ViewModel.closedGroupProfileFrontKey) ON ( \(ViewModel.closedGroupProfileFrontKey).\(profileIdColumnLiteral) = ( SELECT MIN(\(groupMember[.profileId])) FROM \(GroupMember.self) JOIN \(Profile.self) ON \(profile[.id]) = \(groupMember[.profileId]) WHERE ( \(SQL("\(groupMember[.role]) = \(GroupMember.Role.standard)")) AND \(groupMember[.groupId]) = \(closedGroup[.threadId]) AND \(groupMember[.profileId]) != \(userPublicKey) ) ) ) LEFT JOIN \(Profile.self) AS \(ViewModel.closedGroupProfileBackKey) ON ( \(ViewModel.closedGroupProfileBackKey).\(profileIdColumnLiteral) != \(ViewModel.closedGroupProfileFrontKey).\(profileIdColumnLiteral) AND \(ViewModel.closedGroupProfileBackKey).\(profileIdColumnLiteral) = ( SELECT MAX(\(groupMember[.profileId])) FROM \(GroupMember.self) JOIN \(Profile.self) ON \(profile[.id]) = \(groupMember[.profileId]) WHERE ( \(SQL("\(groupMember[.role]) = \(GroupMember.Role.standard)")) AND \(groupMember[.groupId]) = \(closedGroup[.threadId]) AND \(groupMember[.profileId]) != \(userPublicKey) ) ) ) LEFT JOIN \(Profile.self) AS \(ViewModel.closedGroupProfileBackFallbackKey) ON ( \(ViewModel.closedGroupProfileBackKey).\(profileIdColumnLiteral) IS NULL AND \(ViewModel.closedGroupProfileBackFallbackKey).\(profileIdColumnLiteral) = \(userPublicKey) ) LEFT JOIN \(Profile.self) AS \(ViewModel.contactProfileKey) ON false LEFT JOIN \(OpenGroup.self) ON false WHERE \(SQL("\(thread[.variant]) = \(SessionThread.Variant.closedGroup)")) GROUP BY \(thread[.id]) """ // Closed group thread name searching sqlQuery += """ UNION ALL """ sqlQuery += selectQuery sqlQuery += """ JOIN \(closedGroupFullTextSearch) ON ( \(closedGroupFullTextSearch).rowid = \(closedGroupLiteral).rowid AND \(closedGroupFullTextSearch).\(closedGroupNameColumnLiteral) MATCH \(pattern) ) """ sqlQuery += closedGroupQueryCommonJoinFilterGroup // Closed group member nickname searching sqlQuery += """ UNION ALL """ sqlQuery += selectQuery sqlQuery += """ JOIN \(Profile.self) AS \(groupMemberProfileLiteral) ON \(groupMemberProfileLiteral).\(profileIdColumnLiteral) = \(groupMember[.profileId]) JOIN \(profileFullTextSearch) ON ( \(profileFullTextSearch).rowid = \(groupMemberProfileLiteral).rowid AND \(profileFullTextSearch).\(profileNicknameColumnLiteral) MATCH \(pattern) ) """ sqlQuery += closedGroupQueryCommonJoinFilterGroup // Closed group member name searching sqlQuery += """ UNION ALL """ sqlQuery += selectQuery sqlQuery += """ JOIN \(Profile.self) AS \(groupMemberProfileLiteral) ON \(groupMemberProfileLiteral).\(profileIdColumnLiteral) = \(groupMember[.profileId]) JOIN \(profileFullTextSearch) ON ( \(profileFullTextSearch).rowid = \(groupMemberProfileLiteral).rowid AND \(profileFullTextSearch).\(profileNameColumnLiteral) MATCH \(pattern) ) """ sqlQuery += closedGroupQueryCommonJoinFilterGroup // MARK: --Open Group Threads // Open group thread name searching sqlQuery += """ UNION ALL """ sqlQuery += selectQuery sqlQuery += """ JOIN \(OpenGroup.self) ON \(openGroup[.threadId]) = \(thread[.id]) JOIN \(openGroupFullTextSearch) ON ( \(openGroupFullTextSearch).rowid = \(openGroupLiteral).rowid AND \(openGroupFullTextSearch).\(openGroupNameColumnLiteral) MATCH \(pattern) ) LEFT JOIN \(Profile.self) AS \(ViewModel.contactProfileKey) ON false LEFT JOIN \(Profile.self) AS \(ViewModel.closedGroupProfileFrontKey) ON false LEFT JOIN \(Profile.self) AS \(ViewModel.closedGroupProfileBackKey) ON false LEFT JOIN \(Profile.self) AS \(ViewModel.closedGroupProfileBackFallbackKey) ON false LEFT JOIN \(ClosedGroup.self) ON false LEFT JOIN ( SELECT \(groupMember[.groupId]), '' AS \(ViewModel.threadMemberNamesKey) FROM \(GroupMember.self) ) AS \(groupMemberInfoLiteral) ON false WHERE \(SQL("\(thread[.variant]) = \(SessionThread.Variant.openGroup)")) AND \(SQL("\(thread[.id]) != \(userPublicKey)")) GROUP BY \(thread[.id]) """ // MARK: --Note to Self Thread let noteToSelfQueryCommonJoins: SQL = """ JOIN \(Profile.self) AS \(ViewModel.contactProfileKey) ON \(ViewModel.contactProfileKey).\(profileIdColumnLiteral) = \(thread[.id]) LEFT JOIN \(Profile.self) AS \(ViewModel.closedGroupProfileFrontKey) ON false LEFT JOIN \(Profile.self) AS \(ViewModel.closedGroupProfileBackKey) ON false LEFT JOIN \(Profile.self) AS \(ViewModel.closedGroupProfileBackFallbackKey) ON false LEFT JOIN \(OpenGroup.self) ON false LEFT JOIN \(ClosedGroup.self) ON false LEFT JOIN ( SELECT \(groupMember[.groupId]), '' AS \(ViewModel.threadMemberNamesKey) FROM \(GroupMember.self) ) AS \(groupMemberInfoLiteral) ON false """ // Note to self thread searching for 'Note to Self' (need to join an FTS table to // ensure there is a 'rank' column) sqlQuery += """ UNION ALL """ sqlQuery += selectQuery sqlQuery += """ LEFT JOIN \(profileFullTextSearch) ON false """ sqlQuery += noteToSelfQueryCommonJoins sqlQuery += """ WHERE \(SQL("\(thread[.id]) = \(userPublicKey)")) AND '\(noteToSelfLiteral)' LIKE '%\(searchTermLiteral)%' """ // Note to self thread nickname searching sqlQuery += """ UNION ALL """ sqlQuery += selectQuery sqlQuery += """ JOIN \(profileFullTextSearch) ON ( \(profileFullTextSearch).rowid = \(ViewModel.contactProfileKey).rowid AND \(profileFullTextSearch).\(profileNicknameColumnLiteral) MATCH \(pattern) ) """ sqlQuery += noteToSelfQueryCommonJoins sqlQuery += """ WHERE \(SQL("\(thread[.id]) = \(userPublicKey)")) """ // Note to self thread name searching sqlQuery += """ UNION ALL """ sqlQuery += selectQuery sqlQuery += """ JOIN \(profileFullTextSearch) ON ( \(profileFullTextSearch).rowid = \(ViewModel.contactProfileKey).rowid AND \(profileFullTextSearch).\(profileNameColumnLiteral) MATCH \(pattern) ) """ sqlQuery += noteToSelfQueryCommonJoins sqlQuery += """ WHERE \(SQL("\(thread[.id]) = \(userPublicKey)")) """ // Group everything by 'threadId' (the same thread can be found in multiple queries due // to seaerching both nickname and name), then order everything by 'rank' (relevance) // first, 'Note to Self' second (want it to appear at the bottom of threads unless it // has relevance) adn then try to group and sort based on thread type and names let finalQuery: SQL = """ SELECT * FROM ( \(sqlQuery) ) GROUP BY \(ViewModel.threadIdKey) ORDER BY \(Column.rank), \(ViewModel.threadIsNoteToSelfKey), \(ViewModel.closedGroupNameKey), \(ViewModel.openGroupNameKey), \(ViewModel.threadIdKey) LIMIT \(SQL("\(SessionThreadViewModel.searchResultsLimit)")) """ // Construct the actual request let request: SQLRequest = SQLRequest( literal: finalQuery, adapter: RenameColumnAdapter { column in // Note: The query automatically adds a suffix to the various profile columns // to make them easier to distinguish (ie. 'id' -> 'id:1') - this breaks the // decoding so we need to strip the information after the colon guard column.contains(":") else { return column } return String(column.split(separator: ":")[0]) }, cached: false ) // Add adapters which will group the various 'Profile' columns so they can be decoded // as instances of 'Profile' types return request.adapted { db in let adapters = try splittingRowAdapters(columnCounts: [ numColumnsBeforeProfiles, Profile.numberOfSelectedColumns(db), Profile.numberOfSelectedColumns(db), Profile.numberOfSelectedColumns(db), Profile.numberOfSelectedColumns(db) ]) return ScopeAdapter([ ViewModel.contactProfileString: adapters[1], ViewModel.closedGroupProfileFrontString: adapters[2], ViewModel.closedGroupProfileBackString: adapters[3], ViewModel.closedGroupProfileBackFallbackString: adapters[4] ]) } } /// This method returns only the 'Note to Self' thread in the structure of a search result conversation static func noteToSelfOnlyQuery(userPublicKey: String) -> AdaptedFetchRequest> { let thread: TypedTableAlias = TypedTableAlias() let profileIdColumnLiteral: SQL = SQL(stringLiteral: Profile.Columns.id.name) /// **Note:** The `numColumnsBeforeProfiles` value **MUST** match the number of fields before /// the `ViewModel.contactProfileKey` entry below otherwise the query will fail to /// parse and might throw let numColumnsBeforeProfiles: Int = 8 let request: SQLRequest = """ SELECT 100 AS \(Column.rank), \(thread.alias[Column.rowID]) AS \(ViewModel.rowIdKey), \(thread[.id]) AS \(ViewModel.threadIdKey), \(thread[.variant]) AS \(ViewModel.threadVariantKey), \(thread[.creationDateTimestamp]) AS \(ViewModel.threadCreationDateTimestampKey), '' AS \(ViewModel.threadMemberNamesKey), true AS \(ViewModel.threadIsNoteToSelfKey), \(thread[.isPinned]) AS \(ViewModel.threadIsPinnedKey), \(ViewModel.contactProfileKey).*, \(SQL("\(userPublicKey)")) AS \(ViewModel.currentUserPublicKeyKey) FROM \(SessionThread.self) JOIN \(Profile.self) AS \(ViewModel.contactProfileKey) ON \(ViewModel.contactProfileKey).\(profileIdColumnLiteral) = \(thread[.id]) WHERE \(SQL("\(thread[.id]) = \(userPublicKey)")) """ // Add adapters which will group the various 'Profile' columns so they can be decoded // as instances of 'Profile' types return request.adapted { db in let adapters = try splittingRowAdapters(columnCounts: [ numColumnsBeforeProfiles, Profile.numberOfSelectedColumns(db) ]) return ScopeAdapter([ ViewModel.contactProfileString: adapters[1] ]) } } } // MARK: - Share Extension public extension SessionThreadViewModel { static func shareQuery(userPublicKey: String) -> AdaptedFetchRequest> { let thread: TypedTableAlias = TypedTableAlias() let contact: TypedTableAlias = TypedTableAlias() let closedGroup: TypedTableAlias = TypedTableAlias() let groupMember: TypedTableAlias = TypedTableAlias() let openGroup: TypedTableAlias = TypedTableAlias() let profile: TypedTableAlias = TypedTableAlias() let interaction: TypedTableAlias = TypedTableAlias() let profileIdColumnLiteral: SQL = SQL(stringLiteral: Profile.Columns.id.name) /// **Note:** The `numColumnsBeforeProfiles` value **MUST** match the number of fields before /// the `ViewModel.contactProfileKey` entry below otherwise the query will fail to /// parse and might throw /// /// Explicitly set default values for the fields ignored for search results let numColumnsBeforeProfiles: Int = 7 let request: SQLRequest = """ SELECT \(thread.alias[Column.rowID]) AS \(ViewModel.rowIdKey), \(thread[.id]) AS \(ViewModel.threadIdKey), \(thread[.variant]) AS \(ViewModel.threadVariantKey), \(thread[.creationDateTimestamp]) AS \(ViewModel.threadCreationDateTimestampKey), (\(SQL("\(thread[.id]) = \(userPublicKey)"))) AS \(ViewModel.threadIsNoteToSelfKey), \(thread[.isPinned]) AS \(ViewModel.threadIsPinnedKey), \(contact[.isBlocked]) AS \(ViewModel.threadIsBlockedKey), \(ViewModel.contactProfileKey).*, \(ViewModel.closedGroupProfileFrontKey).*, \(ViewModel.closedGroupProfileBackKey).*, \(ViewModel.closedGroupProfileBackFallbackKey).*, \(closedGroup[.name]) AS \(ViewModel.closedGroupNameKey), \(openGroup[.name]) AS \(ViewModel.openGroupNameKey), \(openGroup[.imageData]) AS \(ViewModel.openGroupProfilePictureDataKey), \(SQL("\(userPublicKey)")) AS \(ViewModel.currentUserPublicKeyKey) FROM \(SessionThread.self) LEFT JOIN \(Contact.self) ON \(contact[.id]) = \(thread[.id]) LEFT JOIN ( SELECT *, MAX(\(interaction[.timestampMs])) FROM \(Interaction.self) GROUP BY \(interaction[.threadId]) ) AS \(Interaction.self) ON \(interaction[.threadId]) = \(thread[.id]) LEFT JOIN \(Profile.self) AS \(ViewModel.contactProfileKey) ON \(ViewModel.contactProfileKey).\(profileIdColumnLiteral) = \(thread[.id]) LEFT JOIN \(ClosedGroup.self) ON \(closedGroup[.threadId]) = \(thread[.id]) LEFT JOIN \(OpenGroup.self) ON \(openGroup[.threadId]) = \(thread[.id]) LEFT JOIN \(Profile.self) AS \(ViewModel.closedGroupProfileFrontKey) ON ( \(ViewModel.closedGroupProfileFrontKey).\(profileIdColumnLiteral) = ( SELECT MIN(\(groupMember[.profileId])) FROM \(GroupMember.self) JOIN \(Profile.self) ON \(profile[.id]) = \(groupMember[.profileId]) WHERE ( \(SQL("\(groupMember[.role]) = \(GroupMember.Role.standard)")) AND \(groupMember[.groupId]) = \(closedGroup[.threadId]) AND \(SQL("\(groupMember[.profileId]) != \(userPublicKey)")) ) ) ) LEFT JOIN \(Profile.self) AS \(ViewModel.closedGroupProfileBackKey) ON ( \(ViewModel.closedGroupProfileBackKey).\(profileIdColumnLiteral) != \(ViewModel.closedGroupProfileFrontKey).\(profileIdColumnLiteral) AND \(ViewModel.closedGroupProfileBackKey).\(profileIdColumnLiteral) = ( SELECT MAX(\(groupMember[.profileId])) FROM \(GroupMember.self) JOIN \(Profile.self) ON \(profile[.id]) = \(groupMember[.profileId]) WHERE ( \(SQL("\(groupMember[.role]) = \(GroupMember.Role.standard)")) AND \(groupMember[.groupId]) = \(closedGroup[.threadId]) AND \(SQL("\(groupMember[.profileId]) != \(userPublicKey)")) ) ) ) LEFT JOIN \(Profile.self) AS \(ViewModel.closedGroupProfileBackFallbackKey) ON ( \(closedGroup[.threadId]) IS NOT NULL AND \(ViewModel.closedGroupProfileBackKey).\(profileIdColumnLiteral) IS NULL AND \(ViewModel.closedGroupProfileBackFallbackKey).\(profileIdColumnLiteral) = \(SQL("\(userPublicKey)")) ) WHERE ( \(thread[.shouldBeVisible]) = true AND ( -- Is not a message request \(SQL("\(thread[.variant]) != \(SessionThread.Variant.contact)")) OR \(SQL("\(thread[.id]) = \(userPublicKey)")) OR \(contact[.isApproved]) = true ) AND ( -- Only show the 'Note to Self' thread if it has an interaction \(SQL("\(thread[.id]) != \(userPublicKey)")) OR \(interaction[.id]) IS NOT NULL ) ) GROUP BY \(thread[.id]) ORDER BY IFNULL(\(interaction[.timestampMs]), (\(thread[.creationDateTimestamp]) * 1000)) DESC """ return request.adapted { db in let adapters = try splittingRowAdapters(columnCounts: [ numColumnsBeforeProfiles, Profile.numberOfSelectedColumns(db), Profile.numberOfSelectedColumns(db), Profile.numberOfSelectedColumns(db), Profile.numberOfSelectedColumns(db) ]) return ScopeAdapter([ ViewModel.contactProfileString: adapters[1], ViewModel.closedGroupProfileFrontString: adapters[2], ViewModel.closedGroupProfileBackString: adapters[3], ViewModel.closedGroupProfileBackFallbackString: adapters[4] ]) } } }