451 lines
16 KiB
Swift
451 lines
16 KiB
Swift
//
|
|
// Copyright 2022 Signal Messenger, LLC
|
|
// SPDX-License-Identifier: AGPL-3.0-only
|
|
//
|
|
|
|
public import GRDB
|
|
public import LibSignalClient
|
|
|
|
extension Notification.Name {
|
|
public static let TSGroupThreadAvatarChanged = Notification.Name("TSGroupThreadAvatarChangedNotification")
|
|
}
|
|
|
|
public let TSGroupThread_NotificationKey_UniqueId = "TSGroupThread_NotificationKey_UniqueId"
|
|
|
|
open class TSGroupThread: TSThread {
|
|
override public class var recordType: TSThreadType { .groupThread }
|
|
|
|
public private(set) var groupModel: TSGroupModel
|
|
|
|
public enum CodingKeys: String, CodingKey, ColumnExpression {
|
|
case groupModel
|
|
}
|
|
|
|
public required init(inheritableDecoder decoder: any Decoder) throws {
|
|
let container = try decoder.container(keyedBy: CodingKeys.self)
|
|
let groupModelData = try container.decode(Data.self, forKey: .groupModel)
|
|
self.groupModel = try LegacySDSSerializer().deserializeLegacySDSData(groupModelData, ofClass: TSGroupModel.self)
|
|
try super.init(inheritableDecoder: decoder)
|
|
}
|
|
|
|
override public func encode(to encoder: any Encoder) throws {
|
|
try super.encode(to: encoder)
|
|
var container = encoder.container(keyedBy: CodingKeys.self)
|
|
try container.encode(LegacySDSSerializer().serializeAsLegacySDSData(self.groupModel), forKey: .groupModel)
|
|
}
|
|
|
|
override public var hash: Int {
|
|
var hasher = Hasher()
|
|
hasher.combine(super.hash)
|
|
hasher.combine(self.groupModel)
|
|
return hasher.finalize()
|
|
}
|
|
|
|
override public func isEqual(_ object: Any?) -> Bool {
|
|
guard let object = object as? Self else { return false }
|
|
guard super.isEqual(object) else { return false }
|
|
guard self.groupModel == object.groupModel else { return false }
|
|
return true
|
|
}
|
|
|
|
init(
|
|
id: Int64?,
|
|
uniqueId: String,
|
|
creationDate: Date?,
|
|
editTargetTimestamp: UInt64?,
|
|
isArchivedObsolete: Bool,
|
|
isMarkedUnreadObsolete: Bool,
|
|
lastDraftInteractionRowId: UInt64,
|
|
lastDraftUpdateTimestamp: UInt64,
|
|
lastInteractionRowId: UInt64,
|
|
lastSentStoryTimestamp: UInt64?,
|
|
mentionNotificationMode: TSThreadMentionNotificationMode,
|
|
messageDraft: String?,
|
|
messageDraftBodyRanges: MessageBodyRanges?,
|
|
mutedUntilTimestampObsolete: UInt64,
|
|
shouldThreadBeVisible: Bool,
|
|
storyViewMode: TSThreadStoryViewMode,
|
|
groupModel: TSGroupModel,
|
|
) {
|
|
self.groupModel = groupModel
|
|
super.init(
|
|
id: id,
|
|
uniqueId: uniqueId,
|
|
creationDate: creationDate,
|
|
editTargetTimestamp: editTargetTimestamp,
|
|
isArchivedObsolete: isArchivedObsolete,
|
|
isMarkedUnreadObsolete: isMarkedUnreadObsolete,
|
|
lastDraftInteractionRowId: lastDraftInteractionRowId,
|
|
lastDraftUpdateTimestamp: lastDraftUpdateTimestamp,
|
|
lastInteractionRowId: lastInteractionRowId,
|
|
lastSentStoryTimestamp: lastSentStoryTimestamp,
|
|
mentionNotificationMode: mentionNotificationMode,
|
|
messageDraft: messageDraft,
|
|
messageDraftBodyRanges: messageDraftBodyRanges,
|
|
mutedUntilTimestampObsolete: mutedUntilTimestampObsolete,
|
|
shouldThreadBeVisible: shouldThreadBeVisible,
|
|
storyViewMode: storyViewMode,
|
|
)
|
|
}
|
|
|
|
public init(
|
|
uniqueId: String,
|
|
groupModel: TSGroupModelV2,
|
|
) {
|
|
owsAssertDebug(!groupModel.groupId.isEmpty)
|
|
#if DEBUG
|
|
groupModel.groupMembers.forEach({ owsAssertDebug($0.isValid) })
|
|
#endif
|
|
|
|
self.groupModel = groupModel
|
|
super.init(uniqueId: uniqueId)
|
|
}
|
|
|
|
public convenience init(groupModel: TSGroupModelV2) {
|
|
self.init(
|
|
uniqueId: Self.defaultThreadId(forGroupId: groupModel.groupId),
|
|
groupModel: groupModel,
|
|
)
|
|
}
|
|
|
|
override func deepCopy() -> TSThread {
|
|
return TSGroupThread(
|
|
id: self.id,
|
|
uniqueId: self.uniqueId,
|
|
creationDate: self.creationDate,
|
|
editTargetTimestamp: self.editTargetTimestamp,
|
|
isArchivedObsolete: self.isArchivedObsolete,
|
|
isMarkedUnreadObsolete: self.isMarkedUnreadObsolete,
|
|
lastDraftInteractionRowId: self.lastDraftInteractionRowId,
|
|
lastDraftUpdateTimestamp: self.lastDraftUpdateTimestamp,
|
|
lastInteractionRowId: self.lastInteractionRowId,
|
|
lastSentStoryTimestamp: self.lastSentStoryTimestamp,
|
|
mentionNotificationMode: self.mentionNotificationMode,
|
|
messageDraft: self.messageDraft,
|
|
messageDraftBodyRanges: self.messageDraftBodyRanges,
|
|
mutedUntilTimestampObsolete: self.mutedUntilTimestampObsolete,
|
|
shouldThreadBeVisible: self.shouldThreadBeVisible,
|
|
storyViewMode: self.storyViewMode,
|
|
groupModel: self.groupModel,
|
|
)
|
|
}
|
|
|
|
public class func fetchGroupThreadViaCache(uniqueId: String, transaction: DBReadTransaction) -> TSGroupThread? {
|
|
return fetchViaCache(uniqueId: uniqueId, transaction: transaction)
|
|
}
|
|
|
|
override public func recipientAddresses(with tx: DBReadTransaction) -> [SignalServiceAddress] {
|
|
var groupMembers = self.groupModel.groupMembers
|
|
groupMembers.removeAll(where: { $0.isLocalAddress })
|
|
return groupMembers
|
|
}
|
|
|
|
public var groupNameOrDefault: String {
|
|
return self.groupModel.groupNameOrDefault
|
|
}
|
|
|
|
@objc
|
|
public class var defaultGroupName: String {
|
|
return OWSLocalizedString("NEW_GROUP_DEFAULT_TITLE", comment: "")
|
|
}
|
|
|
|
override open func anyWillInsert(transaction: DBWriteTransaction) {
|
|
super.anyWillInsert(transaction: transaction)
|
|
updateGroupMemberRecords(transaction: transaction)
|
|
}
|
|
|
|
override public func anyWillUpdate(transaction: DBWriteTransaction) {
|
|
super.anyWillUpdate(transaction: transaction)
|
|
|
|
// We used to update the group member records here, but there are many
|
|
// updates that don't touch membership. Now it's done explicitly where we
|
|
// update the group model, and not for other updates.
|
|
}
|
|
|
|
override public func anyDidInsert(transaction: DBWriteTransaction) {
|
|
super.anyDidInsert(transaction: transaction)
|
|
Logger.info("Inserted group thread: \(self.groupId.hexadecimalString)")
|
|
}
|
|
|
|
func update(
|
|
with newGroupModel: TSGroupModel,
|
|
transaction tx: DBWriteTransaction,
|
|
) {
|
|
let didAvatarChange = newGroupModel.avatarHash == groupModel.avatarHash
|
|
let didNameChange = newGroupModel.groupNameOrDefault == groupModel.groupNameOrDefault
|
|
|
|
let oldGroupMembers = groupModel.groupMembers
|
|
|
|
anyUpdate(transaction: tx) { groupThread in
|
|
if let oldGroupModelV2 = groupThread.groupModel as? TSGroupModelV2 {
|
|
if let newGroupModelV2 = newGroupModel as? TSGroupModelV2 {
|
|
owsPrecondition(oldGroupModelV2.revision <= newGroupModelV2.revision)
|
|
} else {
|
|
owsFail("Cannot downgrade a V2 model to a V1 model!")
|
|
}
|
|
}
|
|
|
|
_ = newGroupModel as NSCopying
|
|
groupThread.groupModel = newGroupModel.copy() as! TSGroupModel
|
|
}
|
|
|
|
updateGroupMemberRecords(transaction: tx)
|
|
clearGroupSendEndorsementsIfNeeded(oldGroupMembers: oldGroupMembers, tx: tx)
|
|
|
|
SSKEnvironment.shared.databaseStorageRef.touch(
|
|
thread: self,
|
|
shouldReindex: didNameChange,
|
|
tx: tx,
|
|
)
|
|
|
|
if didAvatarChange {
|
|
tx.addSyncCompletion {
|
|
NotificationCenter.default.postOnMainThread(
|
|
name: .TSGroupThreadAvatarChanged,
|
|
object: self.uniqueId,
|
|
userInfo: [TSGroupThread_NotificationKey_UniqueId: self.uniqueId],
|
|
)
|
|
}
|
|
}
|
|
}
|
|
|
|
// MARK: -
|
|
|
|
public var groupIdentifier: GroupIdentifier {
|
|
get throws {
|
|
return try GroupIdentifier(contents: self.groupId)
|
|
}
|
|
}
|
|
|
|
public static func fetch(forGroupId groupId: GroupIdentifier, tx: DBReadTransaction) -> TSGroupThread? {
|
|
return fetch(groupId: groupId.serialize(), transaction: tx)
|
|
}
|
|
|
|
@objc
|
|
public static func fetch(groupId: Data, transaction: DBReadTransaction) -> TSGroupThread? {
|
|
let uniqueId = threadId(forGroupId: groupId, transaction: transaction)
|
|
return TSGroupThread.fetchGroupThreadViaCache(uniqueId: uniqueId, transaction: transaction)
|
|
}
|
|
|
|
// MARK: -
|
|
|
|
@objc
|
|
func clearGroupSendEndorsementsIfNeeded(oldGroupMembers: [SignalServiceAddress], tx: DBWriteTransaction) {
|
|
let tsAccountManager = DependenciesBridge.shared.tsAccountManager
|
|
let localIdentifiers = tsAccountManager.localIdentifiers(tx: tx)
|
|
var oldGroupMembers = Set(oldGroupMembers.compactMap(\.serviceId))
|
|
var newGroupMembers = Set(self.groupModel.groupMembers.compactMap(\.serviceId))
|
|
// We don't have a GSE for ourselves, so ignore our own ACI in this check.
|
|
if let localIdentifiers {
|
|
oldGroupMembers.remove(localIdentifiers.aci)
|
|
newGroupMembers.remove(localIdentifiers.aci)
|
|
}
|
|
if oldGroupMembers != newGroupMembers {
|
|
let groupSendEndorsementStore = DependenciesBridge.shared.groupSendEndorsementStore
|
|
Logger.info("Clearing GSEs in \(self.logString) due to membership change.")
|
|
groupSendEndorsementStore.deleteEndorsements(groupThreadId: self.sqliteRowId!, tx: tx)
|
|
}
|
|
}
|
|
|
|
// MARK: -
|
|
|
|
public func updateWithStorySendEnabled(
|
|
_ storySendEnabled: Bool,
|
|
transaction: DBWriteTransaction,
|
|
updateStorageService: Bool = true,
|
|
) {
|
|
let wasStorySendEnabled = self.isStorySendExplicitlyEnabled
|
|
updateWithStoryViewMode(storySendEnabled ? .explicit : .disabled, transaction: transaction)
|
|
|
|
if updateStorageService {
|
|
SSKEnvironment.shared.storageServiceManagerRef.recordPendingUpdates(groupModel: groupModel)
|
|
}
|
|
|
|
if !wasStorySendEnabled, storySendEnabled {
|
|
// When enabling after being disabled, always unhide the story context.
|
|
if
|
|
let storyContextAssociatedData = StoryFinder.associatedData(for: self, transaction: transaction),
|
|
storyContextAssociatedData.isHidden
|
|
{
|
|
storyContextAssociatedData.update(
|
|
updateStorageService: updateStorageService,
|
|
isHidden: false,
|
|
transaction: transaction,
|
|
)
|
|
}
|
|
}
|
|
}
|
|
|
|
public func updateWithStoryViewMode(
|
|
_ storyViewMode: TSThreadStoryViewMode,
|
|
transaction tx: DBWriteTransaction,
|
|
) {
|
|
anyUpdate(transaction: tx) { thread in
|
|
thread.storyViewMode = storyViewMode
|
|
}
|
|
}
|
|
|
|
public var isStorySendExplicitlyEnabled: Bool {
|
|
storyViewMode == .explicit
|
|
}
|
|
|
|
public func isStorySendEnabled(transaction: DBReadTransaction) -> Bool {
|
|
if isStorySendExplicitlyEnabled { return true }
|
|
return StoryFinder.latestStoryForThread(self, transaction: transaction) != nil
|
|
}
|
|
|
|
// MARK: -
|
|
|
|
override func updateWithInsertedInteraction(
|
|
_ interaction: TSInteraction,
|
|
tx: DBWriteTransaction,
|
|
) {
|
|
super.updateWithInsertedInteraction(interaction, tx: tx)
|
|
|
|
let senderAddress: SignalServiceAddress? = {
|
|
if interaction is TSOutgoingMessage {
|
|
return DependenciesBridge.shared.tsAccountManager.localIdentifiers(tx: tx)?.aciAddress
|
|
} else if let incomingMessage = interaction as? TSIncomingMessage {
|
|
return incomingMessage.authorAddress
|
|
}
|
|
|
|
return nil
|
|
}()
|
|
|
|
guard let senderAddress else { return }
|
|
|
|
guard
|
|
let groupMember = TSGroupMember.groupMember(
|
|
for: senderAddress,
|
|
in: uniqueId,
|
|
transaction: tx,
|
|
)
|
|
else {
|
|
owsFailDebug("Unexpectedly missing group member record!")
|
|
return
|
|
}
|
|
|
|
groupMember.anyUpdateWith(
|
|
lastInteractionTimestamp: interaction.timestamp,
|
|
transaction: tx,
|
|
)
|
|
}
|
|
|
|
// MARK: - Testable build
|
|
|
|
#if TESTABLE_BUILD
|
|
static func forUnitTest(
|
|
groupId: UInt8 = 0,
|
|
groupMembers: [SignalServiceAddress] = [],
|
|
) -> TSGroupThread {
|
|
return _forUnitTest(
|
|
groupId: Data(repeating: groupId, count: 32),
|
|
secretParamsData: Data(count: 1),
|
|
groupMembers: groupMembers,
|
|
)
|
|
}
|
|
|
|
static func forUnitTest(
|
|
masterKey: GroupMasterKey,
|
|
groupMembers: [SignalServiceAddress] = [],
|
|
) -> TSGroupThread {
|
|
let secretParams = try! GroupSecretParams.deriveFromMasterKey(groupMasterKey: masterKey)
|
|
return _forUnitTest(
|
|
groupId: try! secretParams.getPublicParams().getGroupIdentifier().serialize(),
|
|
secretParamsData: secretParams.serialize(),
|
|
groupMembers: groupMembers,
|
|
)
|
|
}
|
|
|
|
private static func _forUnitTest(
|
|
groupId: Data,
|
|
secretParamsData: Data,
|
|
groupMembers: [SignalServiceAddress] = [],
|
|
) -> TSGroupThread {
|
|
let groupThreadId = TSGroupThread.defaultThreadId(forGroupId: groupId)
|
|
let groupThread = TSGroupThread(
|
|
id: 1,
|
|
uniqueId: groupThreadId,
|
|
creationDate: nil,
|
|
editTargetTimestamp: nil,
|
|
isArchivedObsolete: false,
|
|
isMarkedUnreadObsolete: false,
|
|
lastDraftInteractionRowId: 0,
|
|
lastDraftUpdateTimestamp: 0,
|
|
lastInteractionRowId: 1,
|
|
lastSentStoryTimestamp: nil,
|
|
mentionNotificationMode: .default,
|
|
messageDraft: nil,
|
|
messageDraftBodyRanges: nil,
|
|
mutedUntilTimestampObsolete: 0,
|
|
shouldThreadBeVisible: true,
|
|
storyViewMode: .default,
|
|
groupModel: TSGroupModelV2(
|
|
groupId: groupId,
|
|
name: "Example Group",
|
|
descriptionText: nil,
|
|
avatarDataState: .missing,
|
|
groupMembership: GroupMembership(membersForTest: groupMembers),
|
|
groupAccess: .defaultForV2,
|
|
revision: 1,
|
|
secretParamsData: secretParamsData,
|
|
avatarUrlPath: nil,
|
|
inviteLinkPassword: nil,
|
|
isAnnouncementsOnly: false,
|
|
isJoinRequestPlaceholder: false,
|
|
wasJustMigrated: false,
|
|
didJustAddSelfViaGroupLink: false,
|
|
addedByAddress: nil,
|
|
isTerminated: false,
|
|
),
|
|
)
|
|
groupThread.id = nil
|
|
return groupThread
|
|
}
|
|
#endif
|
|
}
|
|
|
|
// MARK: -
|
|
|
|
public extension TSThreadStoryViewMode {
|
|
var storageServiceMode: StorageServiceProtoGroupV2RecordStorySendMode {
|
|
switch self {
|
|
case .default:
|
|
return .default
|
|
case .explicit:
|
|
return .enabled
|
|
case .disabled:
|
|
return .disabled
|
|
case .blockList:
|
|
owsFailDebug("Unexpected story mode")
|
|
return .default
|
|
}
|
|
}
|
|
|
|
init(storageServiceMode: StorageServiceProtoGroupV2RecordStorySendMode) {
|
|
switch storageServiceMode {
|
|
case .default:
|
|
self = .default
|
|
case .disabled:
|
|
self = .disabled
|
|
case .enabled:
|
|
self = .explicit
|
|
case .UNRECOGNIZED(let value):
|
|
owsFailDebug("Unexpected story mode \(value)")
|
|
self = .default
|
|
}
|
|
}
|
|
}
|
|
|
|
// MARK: - StringInterpolation
|
|
|
|
public extension String.StringInterpolation {
|
|
mutating func appendInterpolation(groupThreadColumn column: TSGroupThread.CodingKeys) {
|
|
appendLiteral(column.rawValue)
|
|
}
|
|
|
|
mutating func appendInterpolation(groupThreadColumnFullyQualified column: TSGroupThread.CodingKeys) {
|
|
appendLiteral("\(TSThread.databaseTableName).\(column.rawValue)")
|
|
}
|
|
}
|