461 lines
18 KiB
Objective-C
461 lines
18 KiB
Objective-C
//
|
|
// Copyright (c) 2017 Open Whisper Systems. All rights reserved.
|
|
//
|
|
|
|
#import "TSDatabaseView.h"
|
|
#import "NSNotificationCenter+OWS.h"
|
|
#import "OWSDevice.h"
|
|
#import "OWSReadTracking.h"
|
|
#import "TSIncomingMessage.h"
|
|
#import "TSInvalidIdentityKeyErrorMessage.h"
|
|
#import "TSOutgoingMessage.h"
|
|
#import "TSStorageManager.h"
|
|
#import "TSThread.h"
|
|
#import <YapDatabase/YapDatabaseCrossProcessNotification.h>
|
|
#import <YapDatabase/YapDatabaseView.h>
|
|
|
|
NSString *const DatabaseViewRegistrationCompleteNotification = @"DatabaseViewRegistrationCompleteNotification";
|
|
|
|
NSString *const TSInboxGroup = @"TSInboxGroup";
|
|
NSString *const TSArchiveGroup = @"TSArchiveGroup";
|
|
|
|
NSString *const TSUnreadIncomingMessagesGroup = @"TSUnreadIncomingMessagesGroup";
|
|
NSString *const TSSecondaryDevicesGroup = @"TSSecondaryDevicesGroup";
|
|
|
|
// YAPDB BUG: when changing from non-persistent to persistent view, we had to rename TSThreadDatabaseViewExtensionName
|
|
// -> TSThreadDatabaseViewExtensionName2 to work around https://github.com/yapstudios/YapDatabase/issues/324
|
|
NSString *const TSThreadDatabaseViewExtensionName = @"TSThreadDatabaseViewExtensionName2";
|
|
NSString *const TSMessageDatabaseViewExtensionName = @"TSMessageDatabaseViewExtensionName";
|
|
NSString *const TSThreadOutgoingMessageDatabaseViewExtensionName = @"TSThreadOutgoingMessageDatabaseViewExtensionName";
|
|
NSString *const TSUnreadDatabaseViewExtensionName = @"TSUnreadDatabaseViewExtensionName";
|
|
NSString *const TSUnseenDatabaseViewExtensionName = @"TSUnseenDatabaseViewExtensionName";
|
|
NSString *const TSThreadSpecialMessagesDatabaseViewExtensionName = @"TSThreadSpecialMessagesDatabaseViewExtensionName";
|
|
NSString *const TSSecondaryDevicesDatabaseViewExtensionName = @"TSSecondaryDevicesDatabaseViewExtensionName";
|
|
|
|
@interface TSDatabaseView ()
|
|
|
|
@property (nonatomic) BOOL areAllAsyncRegistrationsComplete;
|
|
|
|
@end
|
|
|
|
#pragma mark -
|
|
|
|
@implementation TSDatabaseView
|
|
|
|
+ (instancetype)sharedInstance
|
|
{
|
|
static TSDatabaseView *sharedInstance = nil;
|
|
static dispatch_once_t onceToken;
|
|
dispatch_once(&onceToken, ^{
|
|
sharedInstance = [[self alloc] initDefault];
|
|
});
|
|
return sharedInstance;
|
|
}
|
|
|
|
- (instancetype)initDefault
|
|
{
|
|
self = [super init];
|
|
|
|
if (!self) {
|
|
return self;
|
|
}
|
|
|
|
OWSSingletonAssert();
|
|
|
|
return self;
|
|
}
|
|
|
|
- (BOOL)hasPendingViewRegistrations
|
|
{
|
|
@synchronized(self)
|
|
{
|
|
return !self.areAllAsyncRegistrationsComplete;
|
|
}
|
|
}
|
|
|
|
+ (BOOL)hasPendingViewRegistrations
|
|
{
|
|
return ![TSDatabaseView sharedInstance].areAllAsyncRegistrationsComplete;
|
|
}
|
|
|
|
- (void)setAreAllAsyncRegistrationsComplete
|
|
{
|
|
@synchronized(self)
|
|
{
|
|
OWSAssert(!self.areAllAsyncRegistrationsComplete);
|
|
|
|
self.areAllAsyncRegistrationsComplete = YES;
|
|
}
|
|
}
|
|
|
|
+ (void)registerCrossProcessNotifier
|
|
{
|
|
// I don't think the identifier and name of this extension matter for our purposes,
|
|
// so long as they don't conflict with any other extension names.
|
|
YapDatabaseExtension *extension =
|
|
[[YapDatabaseCrossProcessNotification alloc] initWithIdentifier:@"SignalCrossProcessNotifier"];
|
|
[[TSStorageManager sharedManager].database registerExtension:extension withName:@"SignalCrossProcessNotifier"];
|
|
}
|
|
|
|
+ (void)registerMessageDatabaseViewWithName:(NSString *)viewName
|
|
viewGrouping:(YapDatabaseViewGrouping *)viewGrouping
|
|
version:(NSString *)version
|
|
async:(BOOL)async
|
|
{
|
|
OWSAssert([NSThread isMainThread]);
|
|
OWSAssert(viewName.length > 0);
|
|
OWSAssert((viewGrouping));
|
|
|
|
YapDatabaseView *existingView = [[TSStorageManager sharedManager].database registeredExtension:viewName];
|
|
if (existingView) {
|
|
OWSFail(@"Registered database view twice: %@", viewName);
|
|
return;
|
|
}
|
|
|
|
YapDatabaseViewSorting *viewSorting = [self messagesSorting];
|
|
|
|
YapDatabaseViewOptions *options = [[YapDatabaseViewOptions alloc] init];
|
|
options.isPersistent = YES;
|
|
options.allowedCollections =
|
|
[[YapWhitelistBlacklist alloc] initWithWhitelist:[NSSet setWithObject:[TSInteraction collection]]];
|
|
|
|
YapDatabaseView *view =
|
|
[[YapDatabaseView alloc] initWithGrouping:viewGrouping sorting:viewSorting versionTag:version options:options];
|
|
|
|
if (async) {
|
|
[[TSStorageManager sharedManager].database
|
|
asyncRegisterExtension:view
|
|
withName:viewName
|
|
completionBlock:^(BOOL ready) {
|
|
OWSCAssert(ready);
|
|
|
|
DDLogInfo(@"%@ asyncRegisterExtension: %@ -> %d", self.logTag, viewName, ready);
|
|
}];
|
|
} else {
|
|
[[TSStorageManager sharedManager].database registerExtension:view withName:viewName];
|
|
}
|
|
}
|
|
|
|
+ (void)registerUnreadDatabaseView
|
|
{
|
|
YapDatabaseViewGrouping *viewGrouping = [YapDatabaseViewGrouping withObjectBlock:^NSString *(
|
|
YapDatabaseReadTransaction *transaction, NSString *collection, NSString *key, id object) {
|
|
if ([object conformsToProtocol:@protocol(OWSReadTracking)]) {
|
|
id<OWSReadTracking> possiblyRead = (id<OWSReadTracking>)object;
|
|
if (!possiblyRead.wasRead && possiblyRead.shouldAffectUnreadCounts) {
|
|
return possiblyRead.uniqueThreadId;
|
|
}
|
|
}
|
|
return nil;
|
|
}];
|
|
|
|
[self registerMessageDatabaseViewWithName:TSUnreadDatabaseViewExtensionName
|
|
viewGrouping:viewGrouping
|
|
version:@"1"
|
|
async:NO];
|
|
}
|
|
|
|
+ (void)asyncRegisterUnseenDatabaseView
|
|
{
|
|
YapDatabaseViewGrouping *viewGrouping = [YapDatabaseViewGrouping withObjectBlock:^NSString *(
|
|
YapDatabaseReadTransaction *transaction, NSString *collection, NSString *key, id object) {
|
|
if ([object conformsToProtocol:@protocol(OWSReadTracking)]) {
|
|
id<OWSReadTracking> possiblyRead = (id<OWSReadTracking>)object;
|
|
if (!possiblyRead.wasRead) {
|
|
return possiblyRead.uniqueThreadId;
|
|
}
|
|
}
|
|
return nil;
|
|
}];
|
|
|
|
[self registerMessageDatabaseViewWithName:TSUnseenDatabaseViewExtensionName
|
|
viewGrouping:viewGrouping
|
|
version:@"1"
|
|
async:YES];
|
|
}
|
|
|
|
+ (void)asyncRegisterThreadSpecialMessagesDatabaseView
|
|
{
|
|
YapDatabaseViewGrouping *viewGrouping = [YapDatabaseViewGrouping withObjectBlock:^NSString *(
|
|
YapDatabaseReadTransaction *transaction, NSString *collection, NSString *key, id object) {
|
|
OWSAssert([object isKindOfClass:[TSInteraction class]]);
|
|
|
|
TSInteraction *interaction = (TSInteraction *)object;
|
|
if ([interaction isDynamicInteraction]) {
|
|
return interaction.uniqueThreadId;
|
|
} else if ([object isKindOfClass:[TSInvalidIdentityKeyErrorMessage class]]) {
|
|
TSInteraction *interaction = (TSInteraction *)object;
|
|
return interaction.uniqueThreadId;
|
|
} else if ([object isKindOfClass:[TSErrorMessage class]]) {
|
|
TSErrorMessage *errorMessage = (TSErrorMessage *)object;
|
|
if (errorMessage.errorType == TSErrorMessageNonBlockingIdentityChange) {
|
|
return errorMessage.uniqueThreadId;
|
|
}
|
|
}
|
|
return nil;
|
|
}];
|
|
|
|
[self registerMessageDatabaseViewWithName:TSThreadSpecialMessagesDatabaseViewExtensionName
|
|
viewGrouping:viewGrouping
|
|
version:@"1"
|
|
async:YES];
|
|
}
|
|
|
|
+ (void)registerThreadInteractionsDatabaseView
|
|
{
|
|
YapDatabaseViewGrouping *viewGrouping = [YapDatabaseViewGrouping withObjectBlock:^NSString *(
|
|
YapDatabaseReadTransaction *transaction, NSString *collection, NSString *key, id object) {
|
|
OWSAssert([object isKindOfClass:[TSInteraction class]]);
|
|
|
|
TSInteraction *interaction = (TSInteraction *)object;
|
|
return interaction.uniqueThreadId;
|
|
}];
|
|
|
|
[self registerMessageDatabaseViewWithName:TSMessageDatabaseViewExtensionName
|
|
viewGrouping:viewGrouping
|
|
version:@"1"
|
|
async:NO];
|
|
}
|
|
|
|
+ (void)asyncRegisterThreadOutgoingMessagesDatabaseView
|
|
{
|
|
YapDatabaseViewGrouping *viewGrouping = [YapDatabaseViewGrouping withObjectBlock:^NSString *(
|
|
YapDatabaseReadTransaction *transaction, NSString *collection, NSString *key, id object) {
|
|
if ([object isKindOfClass:[TSOutgoingMessage class]]) {
|
|
return ((TSOutgoingMessage *)object).uniqueThreadId;
|
|
}
|
|
return nil;
|
|
}];
|
|
|
|
[self registerMessageDatabaseViewWithName:TSThreadOutgoingMessageDatabaseViewExtensionName
|
|
viewGrouping:viewGrouping
|
|
version:@"2"
|
|
async:YES];
|
|
}
|
|
|
|
+ (void)registerThreadDatabaseView
|
|
{
|
|
YapDatabaseView *threadView =
|
|
[[TSStorageManager sharedManager].database registeredExtension:TSThreadDatabaseViewExtensionName];
|
|
if (threadView) {
|
|
OWSFail(@"Registered database view twice: %@", TSThreadDatabaseViewExtensionName);
|
|
return;
|
|
}
|
|
|
|
YapDatabaseViewGrouping *viewGrouping = [YapDatabaseViewGrouping withObjectBlock:^NSString *(
|
|
YapDatabaseReadTransaction *transaction, NSString *collection, NSString *key, id object) {
|
|
if (![object isKindOfClass:[TSThread class]]) {
|
|
return nil;
|
|
}
|
|
|
|
TSThread *thread = (TSThread *)object;
|
|
|
|
if (thread.isGroupThread) {
|
|
// Do nothing; we never hide group threads.
|
|
} else if (thread.hasEverHadMessage) {
|
|
// Do nothing; we never hide threads that have ever had a message.
|
|
} else {
|
|
YapDatabaseViewTransaction *viewTransaction = [transaction ext:TSMessageDatabaseViewExtensionName];
|
|
OWSAssert(viewTransaction);
|
|
NSUInteger threadMessageCount = [viewTransaction numberOfItemsInGroup:thread.uniqueId];
|
|
if (threadMessageCount < 1) {
|
|
return nil;
|
|
}
|
|
}
|
|
|
|
if (thread.archivalDate) {
|
|
return ([self threadShouldBeInInbox:thread]) ? TSInboxGroup : TSArchiveGroup;
|
|
} else if (thread.archivalDate) {
|
|
return TSArchiveGroup;
|
|
} else {
|
|
return TSInboxGroup;
|
|
}
|
|
}];
|
|
|
|
YapDatabaseViewSorting *viewSorting = [self threadSorting];
|
|
|
|
YapDatabaseViewOptions *options = [[YapDatabaseViewOptions alloc] init];
|
|
options.isPersistent = YES;
|
|
options.allowedCollections =
|
|
[[YapWhitelistBlacklist alloc] initWithWhitelist:[NSSet setWithObject:[TSThread collection]]];
|
|
|
|
YapDatabaseView *databaseView =
|
|
[[YapDatabaseView alloc] initWithGrouping:viewGrouping sorting:viewSorting versionTag:@"3" options:options];
|
|
|
|
[[TSStorageManager sharedManager].database registerExtension:databaseView
|
|
withName:TSThreadDatabaseViewExtensionName];
|
|
}
|
|
|
|
/**
|
|
* Determines whether a thread belongs to the archive or inbox
|
|
*
|
|
* @param thread TSThread
|
|
*
|
|
* @return Inbox if true, Archive if false
|
|
*/
|
|
|
|
+ (BOOL)threadShouldBeInInbox:(TSThread *)thread {
|
|
NSDate *lastMessageDate = thread.lastMessageDate;
|
|
NSDate *archivalDate = thread.archivalDate;
|
|
if (lastMessageDate && archivalDate) { // this is what is called
|
|
return ([lastMessageDate timeIntervalSinceDate:archivalDate] > 0)
|
|
? YES
|
|
: NO; // if there hasn't been a new message since the archive date, it's in the archive. an issue is
|
|
// that empty threads are always given with a lastmessage date of the present on every launch
|
|
} else if (archivalDate) {
|
|
return NO;
|
|
}
|
|
|
|
return YES;
|
|
}
|
|
|
|
+ (YapDatabaseViewSorting *)threadSorting {
|
|
return [YapDatabaseViewSorting withObjectBlock:^NSComparisonResult(YapDatabaseReadTransaction *transaction,
|
|
NSString *group,
|
|
NSString *collection1,
|
|
NSString *key1,
|
|
id object1,
|
|
NSString *collection2,
|
|
NSString *key2,
|
|
id object2) {
|
|
if ([group isEqualToString:TSArchiveGroup] || [group isEqualToString:TSInboxGroup]) {
|
|
if ([object1 isKindOfClass:[TSThread class]] && [object2 isKindOfClass:[TSThread class]]) {
|
|
TSThread *thread1 = (TSThread *)object1;
|
|
TSThread *thread2 = (TSThread *)object2;
|
|
|
|
return [thread1.lastMessageDate compare:thread2.lastMessageDate];
|
|
}
|
|
}
|
|
|
|
return NSOrderedSame;
|
|
}];
|
|
}
|
|
|
|
+ (YapDatabaseViewSorting *)messagesSorting {
|
|
return [YapDatabaseViewSorting withObjectBlock:^NSComparisonResult(YapDatabaseReadTransaction *transaction,
|
|
NSString *group,
|
|
NSString *collection1,
|
|
NSString *key1,
|
|
id object1,
|
|
NSString *collection2,
|
|
NSString *key2,
|
|
id object2) {
|
|
if ([object1 isKindOfClass:[TSInteraction class]] && [object2 isKindOfClass:[TSInteraction class]]) {
|
|
TSInteraction *message1 = (TSInteraction *)object1;
|
|
TSInteraction *message2 = (TSInteraction *)object2;
|
|
|
|
return [message1 compareForSorting:message2];
|
|
}
|
|
|
|
return NSOrderedSame;
|
|
}];
|
|
}
|
|
|
|
+ (void)asyncRegisterSecondaryDevicesDatabaseView
|
|
{
|
|
YapDatabaseViewGrouping *viewGrouping =
|
|
[YapDatabaseViewGrouping withObjectBlock:^NSString *_Nullable(YapDatabaseReadTransaction *_Nonnull transaction,
|
|
NSString *_Nonnull collection,
|
|
NSString *_Nonnull key,
|
|
id _Nonnull object) {
|
|
if ([object isKindOfClass:[OWSDevice class]]) {
|
|
OWSDevice *device = (OWSDevice *)object;
|
|
if (![device isPrimaryDevice]) {
|
|
return TSSecondaryDevicesGroup;
|
|
}
|
|
}
|
|
return nil;
|
|
}];
|
|
|
|
YapDatabaseViewSorting *viewSorting =
|
|
[YapDatabaseViewSorting withObjectBlock:^NSComparisonResult(YapDatabaseReadTransaction *_Nonnull transaction,
|
|
NSString *_Nonnull group,
|
|
NSString *_Nonnull collection1,
|
|
NSString *_Nonnull key1,
|
|
id _Nonnull object1,
|
|
NSString *_Nonnull collection2,
|
|
NSString *_Nonnull key2,
|
|
id _Nonnull object2) {
|
|
|
|
if ([object1 isKindOfClass:[OWSDevice class]] && [object2 isKindOfClass:[OWSDevice class]]) {
|
|
OWSDevice *device1 = (OWSDevice *)object1;
|
|
OWSDevice *device2 = (OWSDevice *)object2;
|
|
|
|
return [device2.createdAt compare:device1.createdAt];
|
|
}
|
|
|
|
return NSOrderedSame;
|
|
}];
|
|
|
|
YapDatabaseViewOptions *options = [YapDatabaseViewOptions new];
|
|
options.isPersistent = YES;
|
|
|
|
NSSet *deviceCollection = [NSSet setWithObject:[OWSDevice collection]];
|
|
options.allowedCollections = [[YapWhitelistBlacklist alloc] initWithWhitelist:deviceCollection];
|
|
|
|
YapDatabaseView *view =
|
|
[[YapDatabaseView alloc] initWithGrouping:viewGrouping sorting:viewSorting versionTag:@"3" options:options];
|
|
|
|
[[TSStorageManager sharedManager].database
|
|
asyncRegisterExtension:view
|
|
withName:TSSecondaryDevicesDatabaseViewExtensionName
|
|
completionBlock:^(BOOL ready) {
|
|
if (ready) {
|
|
DDLogDebug(@"%@ Successfully set up extension: %@", self.logTag, TSSecondaryDevicesGroup);
|
|
} else {
|
|
DDLogError(@"%@ Unable to setup extension: %@", self.logTag, TSSecondaryDevicesGroup);
|
|
}
|
|
}];
|
|
}
|
|
|
|
+ (id)unseenDatabaseViewExtension:(YapDatabaseReadTransaction *)transaction
|
|
{
|
|
OWSAssert(transaction);
|
|
|
|
id result = [transaction ext:TSUnseenDatabaseViewExtensionName];
|
|
|
|
if (!result) {
|
|
result = [transaction ext:TSUnreadDatabaseViewExtensionName];
|
|
OWSAssert(result);
|
|
}
|
|
|
|
return result;
|
|
}
|
|
|
|
+ (id)threadOutgoingMessageDatabaseView:(YapDatabaseReadTransaction *)transaction
|
|
{
|
|
OWSAssert(transaction);
|
|
|
|
id result = [transaction ext:TSThreadOutgoingMessageDatabaseViewExtensionName];
|
|
OWSAssert(result);
|
|
|
|
return result;
|
|
}
|
|
|
|
+ (id)threadSpecialMessagesDatabaseView:(YapDatabaseReadTransaction *)transaction
|
|
{
|
|
OWSAssert(transaction);
|
|
|
|
id result = [transaction ext:TSThreadSpecialMessagesDatabaseViewExtensionName];
|
|
OWSAssert(result);
|
|
|
|
return result;
|
|
}
|
|
|
|
+ (void)asyncRegistrationCompletion
|
|
{
|
|
OWSAssert([NSThread isMainThread]);
|
|
|
|
// All async registrations are complete when writes are unblocked.
|
|
[[TSStorageManager sharedManager].newDatabaseConnection
|
|
asyncReadWriteWithBlock:^(YapDatabaseReadWriteTransaction *_Nonnull transaction) {
|
|
[TSDatabaseView.sharedInstance setAreAllAsyncRegistrationsComplete];
|
|
|
|
[[NSNotificationCenter defaultCenter] postNotificationNameAsync:DatabaseViewRegistrationCompleteNotification
|
|
object:nil
|
|
userInfo:nil];
|
|
}];
|
|
}
|
|
|
|
@end
|