Read receipts remove lockscreen notifications

No need to have a notification for a message you've already read on
desktop.

// FREEBIE

Author: michaelkirk

Podfile

@@ -3,7 +3,7 @@ source 'https://github.com/CocoaPods/Specs.git'
 
 target 'Signal' do
     pod 'SocketRocket',               :git => 'https://github.com/facebook/SocketRocket.git'
-    pod 'SignalServiceKit',           git: 'https://github.com/WhisperSystems/SignalServiceKit.git', branch: 'desktop-integration'
+    pod 'SignalServiceKit',           git: 'https://github.com/WhisperSystems/SignalServiceKit.git'
     #pod 'SignalServiceKit',           path: '../SignalServiceKit'
     pod 'OpenSSL',                    '~> 1.0.208'
     pod 'PastelogKit',                '~> 1.3'

Podfile.lock

@@ -119,19 +119,18 @@ DEPENDENCIES:
   - OpenSSL (~> 1.0.208)
   - PastelogKit (~> 1.3)
   - SCWaveformView (~> 1.0)
-  - SignalServiceKit (from `https://github.com/WhisperSystems/SignalServiceKit.git`, branch `desktop-integration`)
+  - SignalServiceKit (from `https://github.com/WhisperSystems/SignalServiceKit.git`)
   - SocketRocket (from `https://github.com/facebook/SocketRocket.git`)
 
 EXTERNAL SOURCES:
   SignalServiceKit:
-    :branch: desktop-integration
     :git: https://github.com/WhisperSystems/SignalServiceKit.git
   SocketRocket:
     :git: https://github.com/facebook/SocketRocket.git
 
 CHECKOUT OPTIONS:
   SignalServiceKit:
-    :commit: 800e2a95412045f565e7559b77b05eff5567cb95
+    :commit: 9821e0c0d03a01f556680a6ae869b70bf5b93681
     :git: https://github.com/WhisperSystems/SignalServiceKit.git
   SocketRocket:
     :commit: 8096fef47d582bff8ae3758c9ae7af1d55ea53d6
@@ -162,6 +161,6 @@ SPEC CHECKSUMS:
   UnionFind: c33be5adb12983981d6e827ea94fc7f9e370f52d
   YapDatabase: b1e43555a34a5298e23a045be96817a5ef0da58f
 
-PODFILE CHECKSUM: 430c423130f22d8319fc2a420b55a4a3c7b39c9a
+PODFILE CHECKSUM: 5dccee4c1c1ba5d4bf9575a81eeede82d1e89e8b
 
 COCOAPODS: 1.0.1

Signal.xcodeproj/project.pbxproj

@@ -24,6 +24,8 @@
 		458E383A1D6699FA0094BD24 /* OWSDeviceProvisioningURLParserTest.m in Sources */ = {isa = PBXBuildFile; fileRef = 458E38391D6699FA0094BD24 /* OWSDeviceProvisioningURLParserTest.m */; };
 		459311FC1D75C948008DD4F0 /* OWSDeviceTableViewCell.m in Sources */ = {isa = PBXBuildFile; fileRef = 459311FB1D75C948008DD4F0 /* OWSDeviceTableViewCell.m */; };
 		459C3F0D1C9B3A1B003ACF51 /* TSMessageAdapterTest.m in Sources */ = {isa = PBXBuildFile; fileRef = 459C3F0C1C9B3A1B003ACF51 /* TSMessageAdapterTest.m */; };
+		45BFFFA81D898AF0004A12A7 /* OWSStaleNotificationObserver.m in Sources */ = {isa = PBXBuildFile; fileRef = 45BFFFA71D898AF0004A12A7 /* OWSStaleNotificationObserver.m */; };
+		45BFFFA91D898AF0004A12A7 /* OWSStaleNotificationObserver.m in Sources */ = {isa = PBXBuildFile; fileRef = 45BFFFA71D898AF0004A12A7 /* OWSStaleNotificationObserver.m */; };
 		45C681B71D305A580050903A /* OWSCall.m in Sources */ = {isa = PBXBuildFile; fileRef = 45C681B61D305A580050903A /* OWSCall.m */; };
 		45C681B81D305A580050903A /* OWSCall.m in Sources */ = {isa = PBXBuildFile; fileRef = 45C681B61D305A580050903A /* OWSCall.m */; };
 		45C681BC1D305C080050903A /* OWSCallCollectionViewCell.m in Sources */ = {isa = PBXBuildFile; fileRef = 45C681BA1D305C080050903A /* OWSCallCollectionViewCell.m */; };
@@ -537,6 +539,8 @@
 		4597E94E1D8313C100040CDE /* sq */ = {isa = PBXFileReference; lastKnownFileType = text.plist.strings; name = sq; path = translations/sq.lproj/Localizable.strings; sourceTree = "<group>"; };
 		4597E94F1D8313CB00040CDE /* bg */ = {isa = PBXFileReference; lastKnownFileType = text.plist.strings; name = bg; path = translations/bg.lproj/Localizable.strings; sourceTree = "<group>"; };
 		459C3F0C1C9B3A1B003ACF51 /* TSMessageAdapterTest.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = TSMessageAdapterTest.m; path = "view controllers/Signals/TSMessageAdapters/TSMessageAdapterTest.m"; sourceTree = "<group>"; };
+		45BFFFA61D898AF0004A12A7 /* OWSStaleNotificationObserver.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = OWSStaleNotificationObserver.h; path = Observers/OWSStaleNotificationObserver.h; sourceTree = "<group>"; };
+		45BFFFA71D898AF0004A12A7 /* OWSStaleNotificationObserver.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = OWSStaleNotificationObserver.m; path = Observers/OWSStaleNotificationObserver.m; sourceTree = "<group>"; };
 		45C681B51D305A580050903A /* OWSCall.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = OWSCall.h; sourceTree = "<group>"; };
 		45C681B61D305A580050903A /* OWSCall.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = OWSCall.m; sourceTree = "<group>"; };
 		45C681B91D305C080050903A /* OWSCallCollectionViewCell.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = OWSCallCollectionViewCell.h; sourceTree = "<group>"; };
@@ -1167,6 +1171,15 @@
 			name = TSMessageAdapters;
 			sourceTree = "<group>";
 		};
+		45BFFFA51D898AB8004A12A7 /* Observers */ = {
+			isa = PBXGroup;
+			children = (
+				45BFFFA61D898AF0004A12A7 /* OWSStaleNotificationObserver.h */,
+				45BFFFA71D898AF0004A12A7 /* OWSStaleNotificationObserver.m */,
+			);
+			name = Observers;
+			sourceTree = "<group>";
+		};
 		70B8009F190C529C0042E3F0 /* Products */ = {
 			isa = PBXGroup;
 			children = (
@@ -1218,6 +1231,7 @@
 				457F3AC01D14A0F700C51351 /* Models */,
 				76EB052B18170B33006006FC /* Views */,
 				76EB04FE18170B33006006FC /* View Controllers */,
+				45BFFFA51D898AB8004A12A7 /* Observers */,
 			);
 			path = src;
 			sourceTree = "<group>";
@@ -2689,6 +2703,7 @@
 				E197B61918BBEC1A00F073E5 /* RemoteIOBufferListWrapper.m in Sources */,
 				76EB05A618170B33006006FC /* RtpPacket.m in Sources */,
 				76EB064218170B33006006FC /* StringUtil.m in Sources */,
+				45BFFFA81D898AF0004A12A7 /* OWSStaleNotificationObserver.m in Sources */,
 				A547DD741A70A87800103EC7 /* DJWActionSheet+OWS.m in Sources */,
 				45C681B71D305A580050903A /* OWSCall.m in Sources */,
 				76EB062618170B33006006FC /* Queue.m in Sources */,
@@ -2883,6 +2898,7 @@
 				B660F7311C29988E00687D6E /* IpEndPoint.m in Sources */,
 				B660F7321C29988E00687D6E /* PacketHandler.m in Sources */,
 				B660F7331C29988E00687D6E /* RtpPacket.m in Sources */,
+				45BFFFA91D898AF0004A12A7 /* OWSStaleNotificationObserver.m in Sources */,
 				B660F7341C29988E00687D6E /* RtpSocket.m in Sources */,
 				B660F7351C29988E00687D6E /* SequenceCounter.m in Sources */,
 				B660F7361C29988E00687D6E /* SrtpSocket.m in Sources */,

Signal/Signal-Info.plist

@@ -38,7 +38,7 @@
 		</dict>
 	</array>
 	<key>CFBundleVersion</key>
-	<string>2.5.0.11</string>
+	<string>2.5.0.12</string>
 	<key>ITSAppUsesNonExemptEncryption</key>
 	<false/>
 	<key>LOGS_EMAIL</key>

Signal/src/AppDelegate.m

@@ -15,6 +15,7 @@
 #import "TSSocketManager.h"
 #import "TextSecureKitEnv.h"
 #import "VersionMigrations.h"
+#import "OWSStaleNotificationObserver.h"
 #import <SignalServiceKit/OWSReadReceiptObserver.h>
 
 static NSString *const kStoryboardName                  = @"Storyboard";
@@ -26,6 +27,7 @@ @interface AppDelegate ()
 
 @property (nonatomic, retain) UIWindow *screenProtectionWindow;
 @property (nonatomic) OWSReadReceiptObserver *readReceiptObserver;
+@property (nonatomic) OWSStaleNotificationObserver *staleNotificationObserver;
 
 @end
 
@@ -119,20 +121,25 @@ - (void)setupTSKitEnv {
     [TextSecureKitEnv sharedEnv].contactsManager = [Environment getCurrent].contactsManager;
     [[TSStorageManager sharedManager] setupDatabase];
     [TextSecureKitEnv sharedEnv].notificationsManager = [[NotificationsManager alloc] init];
-    self.readReceiptObserver =
-        [[OWSReadReceiptObserver alloc] initWithMessagesManager:[TSMessagesManager sharedManager]];
+    self.readReceiptObserver = [OWSReadReceiptObserver new];
     [self.readReceiptObserver startObserving];
+
+    self.staleNotificationObserver = [OWSStaleNotificationObserver new];
+    [self.staleNotificationObserver startObserving];
 }
 
-- (void)application:(UIApplication *)application
-    didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken {
+- (void)application:(UIApplication *)application didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken
+{
+    DDLogDebug(@"%@ Successfully registered for remote notifications with token: %@", self.tag, deviceToken);
     [PushManager.sharedManager.pushNotificationFutureSource trySetResult:deviceToken];
 }
 
-- (void)application:(UIApplication *)application didFailToRegisterForRemoteNotificationsWithError:(NSError *)error {
+- (void)application:(UIApplication *)application didFailToRegisterForRemoteNotificationsWithError:(NSError *)error
+{
+    DDLogError(@"%@ Failed to register for remote notifications with error %@", self.tag, error);
 #ifdef DEBUG
-    DDLogWarn(@"We're in debug mode, and registered a fake push identifier");
-    [PushManager.sharedManager.pushNotificationFutureSource trySetResult:@"aFakePushIdentifier"];
+    DDLogWarn(@"%@ We're in debug mode. Faking success for remote registration with a fake push identifier", self.tag);
+    [PushManager.sharedManager.pushNotificationFutureSource trySetResult:[NSData dataWithLength:32]];
 #else
     [PushManager.sharedManager.pushNotificationFutureSource trySetFailure:error];
 #endif
@@ -352,4 +359,14 @@ - (BOOL)applicationIsActive {
     return NO;
 }
 
++ (NSString *)tag
+{
+    return [NSString stringWithFormat:@"[%@]", self.class];
+}
+
+- (NSString *)tag
+{
+    return self.class.tag;
+}
+
 @end

Signal/src/Observers/OWSStaleNotificationObserver.h

@@ -0,0 +1,15 @@
+//  Created by Michael Kirk on 9/14/16.
+//  Copyright © 2016 Open Whisper Systems. All rights reserved.
+
+NS_ASSUME_NONNULL_BEGIN
+
+@class PushManager;
+
+@interface OWSStaleNotificationObserver : NSObject
+
+- (instancetype)initWithPushManager:(PushManager *)pushManager NS_DESIGNATED_INITIALIZER;
+- (void)startObserving;
+
+@end
+
+NS_ASSUME_NONNULL_END

Signal/src/Observers/OWSStaleNotificationObserver.m

@@ -0,0 +1,71 @@
+//  Created by Michael Kirk on 9/14/16.
+//  Copyright © 2016 Open Whisper Systems. All rights reserved.
+
+#import "OWSStaleNotificationObserver.h"
+#import "PushManager.h"
+#import <SignalServiceKit/OWSReadReceiptsProcessor.h>
+#import <SignalServiceKit/TSIncomingMessage.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+@interface OWSStaleNotificationObserver ()
+
+@property (nonatomic, readonly) PushManager *pushManager;
+
+@end
+
+@implementation OWSStaleNotificationObserver
+
+- (void)dealloc
+{
+    [[NSNotificationCenter defaultCenter] removeObserver:self];
+}
+
+- (instancetype)init
+{
+    return [self initWithPushManager:[PushManager sharedManager]];
+}
+
+- (instancetype)initWithPushManager:(PushManager *)pushManager
+{
+    self = [super init];
+    if (!self) {
+        return self;
+    }
+
+    _pushManager = pushManager;
+
+    return self;
+}
+
+- (void)startObserving
+{
+    [[NSNotificationCenter defaultCenter] addObserver:self
+                                             selector:@selector(handleMessageRead:)
+                                                 name:OWSReadReceiptsProcessorMarkedMessageAsReadNotification
+                                               object:nil];
+}
+
+- (void)handleMessageRead:(NSNotification *)notification
+{
+    if ([notification.object isKindOfClass:[TSIncomingMessage class]]) {
+        TSIncomingMessage *message = (TSIncomingMessage *)notification.object;
+
+        DDLogDebug(@"%@ canceled notification for message:%@", self.tag, message);
+        [self.pushManager cancelNotificationsWithThreadId:message.uniqueThreadId];
+    }
+}
+
++ (NSString *)tag
+{
+    return [NSString stringWithFormat:@"[%@]", self.class];
+}
+
+- (NSString *)tag
+{
+    return self.class.tag;
+}
+
+@end
+
+NS_ASSUME_NONNULL_END

Signal/src/network/PushManager.h

@@ -7,7 +7,7 @@
 //
 
 #import <CollapsingFutures.h>
-#import <Foundation/Foundation.h>
+#import <PushKit/PushKit.h>
 
 #define Signal_Thread_UserInfo_Key @"Signal_Thread_Id"
 #define Signal_Message_UserInfo_Key @"Signal_Message_Id"
@@ -33,7 +33,7 @@ typedef void (^pushTokensSuccessBlock)(NSString *pushToken, NSString *voipToken)
  *  The Push Manager is responsible for registering the device for Signal push notifications.
  */
 
-@interface PushManager : NSObject
+@interface PushManager : NSObject <PKPushRegistryDelegate>
 
 + (PushManager *)sharedManager;
 
@@ -65,6 +65,7 @@ typedef void (^pushTokensSuccessBlock)(NSString *pushToken, NSString *voipToken)
 - (BOOL)supportsVOIPPush;
 - (UILocalNotification *)closeVOIPBackgroundTask;
 - (void)presentNotification:(UILocalNotification *)notification;
+- (void)cancelNotificationsWithThreadId:(NSString *)threadId;
 
 #pragma mark Push Notifications Delegate Methods
 

Signal/src/network/PushManager.m

@@ -6,8 +6,6 @@
 //  Copyright (c) 2014 Open Whisper Systems. All rights reserved.
 //
 
-#import <PushKit/PushKit.h>
-
 #import "AppDelegate.h"
 #import "OWSContactsManager.h"
 #import "InCallViewController.h"
@@ -22,7 +20,7 @@
 
 #define pushManagerDomain @"org.whispersystems.pushmanager"
 
-@interface PushManager () <PKPushRegistryDelegate>
+@interface PushManager ()
 
 @property TOCFutureSource *registerWithServerFutureSource;
 @property UIAlertView *missingPermissionsAlertView;
@@ -298,7 +296,8 @@ - (TOCFuture *)registerPushNotificationFuture {
 
 - (void)requestPushTokenWithSuccess:(pushTokensSuccessBlock)success failure:(failedPushRegistrationBlock)failure {
     if (!self.wantRemoteNotifications) {
-        success(@"FakeToken", @"FakePushToken");
+        DDLogWarn(@"%@ Using fake push tokens", self.tag);
+        success(@"fakePushToken", @"fakeVoipToken");
         return;
     }
 
@@ -451,4 +450,14 @@ - (void)cancelNotificationsWithThreadId:(NSString *)threadId {
     [self.currentNotifications removeObjectsInArray:toDelete];
 }
 
++ (NSString *)tag
+{
+    return [NSString stringWithFormat:@"[%@]", self.class];
+}
+
+- (NSString *)tag
+{
+    return self.class.tag;
+}
+
 @end