session-ios/SessionNotificationServiceE.../NotificationServiceExtensio...

218 lines
11 KiB
Swift
Raw Normal View History

import UserNotifications
import SessionMessagingKit
2020-11-11 06:45:50 +00:00
import SignalUtilitiesKit
2020-12-03 04:08:29 +00:00
public final class NotificationServiceExtension : UNNotificationServiceExtension {
2020-04-06 23:33:29 +00:00
private var didPerformSetup = false
private var areVersionMigrationsComplete = false
private var contentHandler: ((UNNotificationContent) -> Void)?
private var notificationContent: UNMutableNotificationContent?
2020-04-06 23:33:29 +00:00
private static let isFromRemoteKey = "remote"
private static let threadIdKey = "Signal.AppNotificationsUserInfoKey.threadId"
2020-12-03 04:08:29 +00:00
override public func didReceive(_ request: UNNotificationRequest, withContentHandler contentHandler: @escaping (UNNotificationContent) -> Void) {
self.contentHandler = contentHandler
self.notificationContent = request.content.mutableCopy() as? UNMutableNotificationContent
// Abort if the main app is running
2020-12-02 23:12:29 +00:00
var isMainAppAndActive = false
if let sharedUserDefaults = UserDefaults(suiteName: "group.com.loki-project.loki-messenger") {
2020-12-02 23:12:29 +00:00
isMainAppAndActive = sharedUserDefaults.bool(forKey: "isMainAppActive")
}
2020-12-02 23:12:29 +00:00
guard !isMainAppAndActive else { return self.handleFailure(for: notificationContent!) }
// Perform main setup
DispatchQueue.main.sync { self.setUpIfNecessary() { } }
// Handle the push notification
2020-07-28 00:25:48 +00:00
AppReadiness.runNowOrWhenAppDidBecomeReady {
let notificationContent = self.notificationContent!
guard let base64EncodedData = notificationContent.userInfo["ENCRYPTED_DATA"] as! String?, let data = Data(base64Encoded: base64EncodedData),
let envelope = try? MessageWrapper.unwrap(data: data), let envelopeAsData = try? envelope.serializedData() else {
return self.handleFailure(for: notificationContent)
}
Storage.write { transaction in // Intentionally capture self
do {
let (message, proto) = try MessageReceiver.parse(envelopeAsData, openGroupMessageServerID: nil, using: transaction)
2020-12-03 22:40:58 +00:00
let senderPublicKey = message.sender!
var senderDisplayName = OWSProfileManager.shared().profileNameForRecipient(withID: senderPublicKey, transaction: transaction) ?? senderPublicKey
2020-12-03 23:00:06 +00:00
let snippet: String
var userInfo: [String:Any] = [ NotificationServiceExtension.isFromRemoteKey : true ]
switch message {
case let visibleMessage as VisibleMessage:
2020-12-07 00:21:24 +00:00
let tsIncomingMessageID = try MessageReceiver.handleVisibleMessage(visibleMessage, associatedWithProto: proto, openGroupID: nil, isBackgroundPoll: false, using: transaction)
2020-12-03 23:00:06 +00:00
guard let tsIncomingMessage = TSIncomingMessage.fetch(uniqueId: tsIncomingMessageID, transaction: transaction) else {
return self.handleFailure(for: notificationContent)
}
let threadID = tsIncomingMessage.thread(with: transaction).uniqueId!
userInfo[NotificationServiceExtension.threadIdKey] = threadID
snippet = tsIncomingMessage.previewText(with: transaction).filterForDisplay?.replacingMentions(for: threadID, using: transaction)
?? "You've got a new message"
if let thread = TSThread.fetch(uniqueId: threadID, transaction: transaction), let group = thread as? TSGroupThread,
group.groupModel.groupType == .closedGroup { // Should always be true because we don't get PNs for open groups
senderDisplayName = String(format: NotificationStrings.incomingGroupMessageTitleFormat, senderDisplayName, group.groupModel.groupName ?? MessageStrings.newGroupDefaultTitle)
}
case let closedGroupControlMessage as ClosedGroupControlMessage:
2020-12-03 23:00:06 +00:00
// TODO: We could consider actually handling the update here. Not sure if there's enough time though, seeing as though
// in some cases we need to send messages (e.g. our sender key) to a number of other users.
switch closedGroupControlMessage.kind {
case .new(_, let name, _, _, _): snippet = "\(senderDisplayName) added you to \(name)"
2020-12-03 23:00:06 +00:00
default: return self.handleFailure(for: notificationContent)
}
default: return self.handleFailure(for: notificationContent)
2020-12-03 22:40:58 +00:00
}
notificationContent.userInfo = userInfo
notificationContent.badge = 1
let notificationsPreference = Environment.shared.preferences!.notificationPreviewType()
switch notificationsPreference {
case .namePreview:
notificationContent.title = senderDisplayName
2020-12-03 22:16:40 +00:00
notificationContent.body = snippet
case .nameNoPreview:
notificationContent.title = senderDisplayName
2020-12-03 22:16:40 +00:00
notificationContent.body = "You've got a new message"
case .noNameNoPreview:
notificationContent.title = "Session"
2020-12-03 22:16:40 +00:00
notificationContent.body = "You've got a new message"
default: break
}
self.handleSuccess(for: notificationContent)
} catch {
self.handleFailure(for: notificationContent)
}
2020-08-05 06:55:55 +00:00
}
}
}
2020-04-06 23:33:29 +00:00
2020-12-03 04:08:29 +00:00
private func setUpIfNecessary(completion: @escaping () -> Void) {
AssertIsOnMainThread()
// The NSE will often re-use the same process, so if we're
2020-04-06 23:33:29 +00:00
// already set up we want to do nothing; we're already ready
// to process new messages.
2020-04-06 23:33:29 +00:00
guard !didPerformSetup else { return }
2020-04-06 23:33:29 +00:00
didPerformSetup = true
// This should be the first thing we do.
SetCurrentAppContext(NotificationServiceExtensionContext())
DebugLogger.shared().enableTTYLogging()
if _isDebugAssertConfiguration() {
DebugLogger.shared().enableFileLogging()
}
_ = AppVersion.sharedInstance()
Cryptography.seedRandom()
// We should never receive a non-voip notification on an app that doesn't support
// app extensions since we have to inform the service we wanted these, so in theory
// this path should never occur. However, the service does have our push token
// so it is possible that could change in the future. If it does, do nothing
// and don't disturb the user. Messages will be processed when they open the app.
guard OWSPreferences.isReadyForAppExtensions() else { return completeSilenty() }
AppSetup.setupEnvironment(
appSpecificSingletonBlock: {
2020-11-11 20:55:24 +00:00
SSKEnvironment.shared.notificationsManager = NoopNotificationsManager()
},
migrationCompletion: { [weak self] in
self?.versionMigrationsDidComplete()
2020-07-23 05:41:47 +00:00
completion()
}
)
NotificationCenter.default.addObserver(self, selector: #selector(storageIsReady), name: .StorageIsReady, object: nil)
}
2020-12-03 04:08:29 +00:00
override public func serviceExtensionTimeWillExpire() {
// Called just before the extension will be terminated by the system.
// Use this as an opportunity to deliver your "best attempt" at modified content, otherwise the original push payload will be used.
let userInfo: [String:Any] = [ NotificationServiceExtension.isFromRemoteKey : true ]
let notificationContent = self.notificationContent!
notificationContent.userInfo = userInfo
notificationContent.badge = 1
notificationContent.title = "Session"
2020-12-03 22:16:40 +00:00
notificationContent.body = "You've got a new message"
handleSuccess(for: notificationContent)
}
@objc
2020-12-03 04:08:29 +00:00
private func versionMigrationsDidComplete() {
AssertIsOnMainThread()
areVersionMigrationsComplete = true
checkIsAppReady()
}
@objc
2020-12-03 04:08:29 +00:00
private func storageIsReady() {
AssertIsOnMainThread()
checkIsAppReady()
}
@objc
2020-12-03 04:08:29 +00:00
private func checkIsAppReady() {
AssertIsOnMainThread()
// Only mark the app as ready once.
guard !AppReadiness.isAppReady() else { return }
// App isn't ready until storage is ready AND all version migrations are complete.
guard OWSStorage.isStorageReady() && areVersionMigrationsComplete else { return }
2020-12-02 05:46:12 +00:00
SignalUtilitiesKit.Configuration.performMainSetup()
// Note that this does much more than set a flag; it will also run all deferred blocks.
AppReadiness.setAppIsReady()
}
2020-12-03 04:08:29 +00:00
private func completeSilenty() {
contentHandler!(.init())
}
2020-12-03 04:08:29 +00:00
private func handleSuccess(for content: UNMutableNotificationContent) {
contentHandler!(content)
}
2020-12-03 04:08:29 +00:00
private func handleFailure(for content: UNMutableNotificationContent) {
2020-12-03 22:16:40 +00:00
content.body = "You've got a new message"
content.title = "Session"
let userInfo: [String:Any] = [ NotificationServiceExtension.isFromRemoteKey : true ]
content.userInfo = userInfo
contentHandler!(content)
}
}
2020-12-03 22:16:40 +00:00
private extension String {
func replacingMentions(for threadID: String, using transaction: YapDatabaseReadWriteTransaction) -> String {
guard let userPublicKey = Storage.shared.getUserPublicKey() else { return self }
MentionsManager.populateUserPublicKeyCacheIfNeeded(for: threadID, in: transaction)
var result = self
let regex = try! NSRegularExpression(pattern: "@[0-9a-fA-F]*", options: [])
let knownPublicKeys = MentionsManager.userPublicKeyCache[threadID] ?? []
var mentions: [(range: NSRange, publicKey: String)] = []
var m0 = regex.firstMatch(in: result, options: .withoutAnchoringBounds, range: NSRange(location: 0, length: result.utf16.count))
while let m1 = m0 {
let publicKey = String((result as NSString).substring(with: m1.range).dropFirst()) // Drop the @
var matchEnd = m1.range.location + m1.range.length
if knownPublicKeys.contains(publicKey) {
let displayName = (publicKey == userPublicKey) ? OWSProfileManager.shared().getLocalUserProfile(with: transaction).profileName
2020-12-03 22:40:58 +00:00
: (OWSProfileManager.shared().profileNameForRecipient(withID: publicKey, transaction: transaction) ?? publicKey)
2020-12-03 22:16:40 +00:00
if let displayName = displayName {
result = (result as NSString).replacingCharacters(in: m1.range, with: "@\(displayName)")
mentions.append((range: NSRange(location: m1.range.location, length: displayName.utf16.count + 1), publicKey: publicKey)) // + 1 to include the @
matchEnd = m1.range.location + displayName.utf16.count
}
}
m0 = regex.firstMatch(in: result, options: .withoutAnchoringBounds, range: NSRange(location: matchEnd, length: result.utf16.count - matchEnd))
}
return result
}
}