2019-08-19 04:07:09 +02:00
import PromiseKit
@objc ( LKGroupChatAPI )
2019-09-26 03:32:47 +02:00
public final class LokiGroupChatAPI : LokiDotNetAPI {
2019-09-12 07:06:20 +02:00
private static var moderators : [ String : [ UInt64 : Set < String > ] ] = [ : ] // S e r v e r U R L t o ( c h a n n e l I D t o s e t o f m o d e r a t o r I D s )
2019-08-27 02:56:02 +02:00
// MARK: S e t t i n g s
2019-10-11 03:56:43 +02:00
private static let fallbackBatchCount = 256
2019-09-18 08:59:11 +02:00
private static let maxRetryCount : UInt = 8
2019-08-27 02:56:02 +02:00
// MARK: P u b l i c C h a t
2019-08-19 05:41:23 +02:00
@objc public static let publicChatMessageType = " network.loki.messenger.publicChat "
2019-10-09 03:40:39 +02:00
@objc private static let channelInfoType = " net.patter-app.settings "
2019-08-22 05:14:35 +02:00
2019-08-27 02:56:02 +02:00
// MARK: C o n v e n i e n c e
private static var userDisplayName : String {
return SSKEnvironment . shared . contactsManager . displayName ( forPhoneIdentifier : userHexEncodedPublicKey ) ? ? " Anonymous "
}
// MARK: D a t a b a s e
2019-09-26 03:32:47 +02:00
override internal class var authTokenCollection : String { " LokiGroupChatAuthTokenCollection " }
2019-08-27 02:56:02 +02:00
private static let lastMessageServerIDCollection = " LokiGroupChatLastMessageServerIDCollection "
2019-08-30 07:27:59 +02:00
private static let lastDeletionServerIDCollection = " LokiGroupChatLastDeletionServerIDCollection "
2019-08-27 02:56:02 +02:00
2019-08-28 02:04:15 +02:00
private static func getLastMessageServerID ( for group : UInt64 , on server : String ) -> UInt ? {
2019-08-27 02:56:02 +02:00
var result : UInt ? = nil
storage . dbReadConnection . read { transaction in
result = transaction . object ( forKey : " \( server ) . \( group ) " , inCollection : lastMessageServerIDCollection ) as ! UInt ?
}
return result
}
2019-08-28 02:04:15 +02:00
private static func setLastMessageServerID ( for group : UInt64 , on server : String , to newValue : UInt64 ) {
2019-08-27 02:56:02 +02:00
storage . dbReadWriteConnection . readWrite { transaction in
transaction . setObject ( newValue , forKey : " \( server ) . \( group ) " , inCollection : lastMessageServerIDCollection )
}
}
2019-10-09 07:19:58 +02:00
private static func removeLastMessageServerID ( for group : UInt64 , on server : String ) {
storage . dbReadWriteConnection . readWrite { transaction in
transaction . removeObject ( forKey : " \( server ) . \( group ) " , inCollection : lastMessageServerIDCollection )
}
}
2019-08-30 07:27:59 +02:00
private static func getLastDeletionServerID ( for group : UInt64 , on server : String ) -> UInt ? {
2019-08-27 02:56:02 +02:00
var result : UInt ? = nil
storage . dbReadConnection . read { transaction in
2019-08-30 07:27:59 +02:00
result = transaction . object ( forKey : " \( server ) . \( group ) " , inCollection : lastDeletionServerIDCollection ) as ! UInt ?
2019-08-27 02:56:02 +02:00
}
return result
}
2019-08-30 07:27:59 +02:00
private static func setLastDeletionServerID ( for group : UInt64 , on server : String , to newValue : UInt64 ) {
2019-08-27 02:56:02 +02:00
storage . dbReadWriteConnection . readWrite { transaction in
2019-08-30 07:27:59 +02:00
transaction . setObject ( newValue , forKey : " \( server ) . \( group ) " , inCollection : lastDeletionServerIDCollection )
2019-08-27 02:56:02 +02:00
}
}
2019-08-22 04:34:24 +02:00
2019-10-09 07:19:58 +02:00
private static func removeLastDeletionServerID ( for group : UInt64 , on server : String ) {
storage . dbReadWriteConnection . readWrite { transaction in
transaction . removeObject ( forKey : " \( server ) . \( group ) " , inCollection : lastDeletionServerIDCollection )
}
}
2019-08-27 02:56:02 +02:00
// MARK: P u b l i c A P I
2019-08-28 02:04:15 +02:00
public static func getMessages ( for group : UInt64 , on server : String ) -> Promise < [ LokiGroupMessage ] > {
2019-08-27 02:56:02 +02:00
print ( " [Loki] Getting messages for group chat with ID: \( group ) on server: \( server ) . " )
var queryParameters = " include_annotations=1 "
if let lastMessageServerID = getLastMessageServerID ( for : group , on : server ) {
queryParameters += " &since_id= \( lastMessageServerID ) "
} else {
queryParameters += " &count=- \( fallbackBatchCount ) "
}
let url = URL ( string : " \( server ) /channels/ \( group ) /messages? \( queryParameters ) " ) !
2019-08-19 04:07:09 +02:00
let request = TSRequest ( url : url )
return TSNetworkManager . shared ( ) . makePromise ( request : request ) . map { $0 . responseObject } . map { rawResponse in
guard let json = rawResponse as ? JSON , let rawMessages = json [ " data " ] as ? [ JSON ] else {
2019-08-27 02:56:02 +02:00
print ( " [Loki] Couldn't parse messages for group chat with ID: \( group ) on server: \( server ) from: \( rawResponse ) . " )
2019-09-02 05:27:12 +02:00
throw Error . parsingFailed
2019-08-19 04:07:09 +02:00
}
return rawMessages . flatMap { message in
2019-09-11 03:53:47 +02:00
let isDeleted = ( message [ " is_deleted " ] as ? Int = = 1 )
guard ! isDeleted else { return nil }
2019-08-19 04:07:09 +02:00
guard let annotations = message [ " annotations " ] as ? [ JSON ] , let annotation = annotations . first , let value = annotation [ " value " ] as ? JSON ,
2019-10-02 07:44:44 +02:00
let serverID = message [ " id " ] as ? UInt64 , let hexEncodedSignatureData = value [ " sig " ] as ? String , let signatureVersion = value [ " sigver " ] as ? UInt64 ,
let body = message [ " text " ] as ? String , let user = message [ " user " ] as ? JSON , let hexEncodedPublicKey = user [ " username " ] as ? String ,
2019-08-23 08:14:19 +02:00
let timestamp = value [ " timestamp " ] as ? UInt64 else {
2019-08-27 02:56:02 +02:00
print ( " [Loki] Couldn't parse message for group chat with ID: \( group ) on server: \( server ) from: \( message ) . " )
2019-08-19 04:07:09 +02:00
return nil
}
2019-10-02 07:44:44 +02:00
let displayName = user [ " name " ] as ? String ? ? NSLocalizedString ( " Anonymous " , comment : " " )
2019-08-27 02:56:02 +02:00
let lastMessageServerID = getLastMessageServerID ( for : group , on : server )
if serverID > ( lastMessageServerID ? ? 0 ) { setLastMessageServerID ( for : group , on : server , to : serverID ) }
2019-09-11 03:53:47 +02:00
let quote : LokiGroupMessage . Quote ?
if let quoteAsJSON = value [ " quote " ] as ? JSON , let quotedMessageTimestamp = quoteAsJSON [ " id " ] as ? UInt64 , let quoteeHexEncodedPublicKey = quoteAsJSON [ " author " ] as ? String , let quotedMessageBody = quoteAsJSON [ " text " ] as ? String {
2019-10-02 05:34:34 +02:00
let quotedMessageServerID = message [ " reply_to " ] as ? UInt64
quote = LokiGroupMessage . Quote ( quotedMessageTimestamp : quotedMessageTimestamp , quoteeHexEncodedPublicKey : quoteeHexEncodedPublicKey , quotedMessageBody : quotedMessageBody , quotedMessageServerID : quotedMessageServerID )
2019-09-11 03:53:47 +02:00
} else {
quote = nil
}
2019-10-02 07:44:44 +02:00
let signature = LokiGroupMessage . Signature ( data : Data ( hex : hexEncodedSignatureData ) , version : signatureVersion )
2019-10-02 05:34:34 +02:00
let result = LokiGroupMessage ( serverID : serverID , hexEncodedPublicKey : hexEncodedPublicKey , displayName : displayName , body : body , type : publicChatMessageType , timestamp : timestamp , quote : quote , signature : signature )
guard result . hasValidSignature ( ) else {
print ( " [Loki] Ignoring group chat message with invalid signature. " )
return nil
}
return result
2019-09-18 07:45:50 +02:00
} . sorted { $0 . timestamp < $1 . timestamp }
2019-08-19 04:07:09 +02:00
}
}
2019-08-28 02:04:15 +02:00
public static func sendMessage ( _ message : LokiGroupMessage , to group : UInt64 , on server : String ) -> Promise < LokiGroupMessage > {
2019-10-02 05:34:34 +02:00
guard let signedMessage = message . sign ( with : userKeyPair . privateKey ) else { return Promise ( error : Error . signingFailed ) }
2019-08-27 02:56:02 +02:00
return getAuthToken ( for : server ) . then { token -> Promise < LokiGroupMessage > in
print ( " [Loki] Sending message to group chat with ID: \( group ) on server: \( server ) . " )
let url = URL ( string : " \( server ) /channels/ \( group ) /messages " ) !
2019-10-02 05:34:34 +02:00
let parameters = signedMessage . toJSON ( )
2019-08-22 05:14:35 +02:00
let request = TSRequest ( url : url , method : " POST " , parameters : parameters )
request . allHTTPHeaderFields = [ " Content-Type " : " application/json " , " Authorization " : " Bearer \( token ) " ]
let displayName = userDisplayName
return TSNetworkManager . shared ( ) . makePromise ( request : request ) . map { $0 . responseObject } . map { rawResponse in
2019-08-23 08:14:19 +02:00
// I S O 8 6 0 1 D a t e F o r m a t t e r d o e s n ' t s u p p o r t m i l l i s e c o n d s b e f o r e i O S 1 1
2019-08-23 02:27:22 +02:00
let dateFormatter = DateFormatter ( )
dateFormatter . dateFormat = " yyyy-MM-dd'T'HH:mm:ss.SSSZ "
2019-08-28 02:04:15 +02:00
guard let json = rawResponse as ? JSON , let messageAsJSON = json [ " data " ] as ? JSON , let serverID = messageAsJSON [ " id " ] as ? UInt64 , let body = messageAsJSON [ " text " ] as ? String ,
2019-08-27 02:56:02 +02:00
let dateAsString = messageAsJSON [ " created_at " ] as ? String , let date = dateFormatter . date ( from : dateAsString ) else {
2019-08-27 03:58:12 +02:00
print ( " [Loki] Couldn't parse message for group chat with ID: \( group ) on server: \( server ) from: \( rawResponse ) . " )
2019-09-02 05:27:12 +02:00
throw Error . parsingFailed
2019-08-22 05:14:35 +02:00
}
let timestamp = UInt64 ( date . timeIntervalSince1970 ) * 1000
2019-10-02 05:34:34 +02:00
return LokiGroupMessage ( serverID : serverID , hexEncodedPublicKey : userHexEncodedPublicKey , displayName : displayName , body : body , type : publicChatMessageType , timestamp : timestamp , quote : signedMessage . quote , signature : signedMessage . signature )
2019-08-19 04:07:09 +02:00
}
2019-08-27 02:56:02 +02:00
} . recover { error -> Promise < LokiGroupMessage > in
if let error = error as ? NetworkManagerError , error . statusCode = = 401 {
print ( " [Loki] Group chat auth token for: \( server ) expired; dropping it. " )
storage . dbReadWriteConnection . removeObject ( forKey : server , inCollection : authTokenCollection )
}
throw error
2019-09-04 07:55:17 +02:00
} . retryingIfNeeded ( maxRetryCount : maxRetryCount ) . map { message in
Analytics . shared . track ( " Group Message Sent " )
return message
} . recover { error -> Promise < LokiGroupMessage > in
Analytics . shared . track ( " Failed to Send Group Message " )
throw error
}
2019-08-27 02:56:02 +02:00
}
2019-08-28 02:29:14 +02:00
public static func getDeletedMessageServerIDs ( for group : UInt64 , on server : String ) -> Promise < [ UInt64 ] > {
2019-08-27 02:56:02 +02:00
print ( " [Loki] Getting deleted messages for group chat with ID: \( group ) on server: \( server ) . " )
2019-08-30 07:27:59 +02:00
let queryParameters : String
if let lastDeletionServerID = getLastDeletionServerID ( for : group , on : server ) {
queryParameters = " since_id= \( lastDeletionServerID ) "
} else {
queryParameters = " count= \( fallbackBatchCount ) "
}
let url = URL ( string : " \( server ) /loki/v1/channel/ \( group ) /deletes? \( queryParameters ) " ) !
2019-08-27 02:56:02 +02:00
let request = TSRequest ( url : url )
return TSNetworkManager . shared ( ) . makePromise ( request : request ) . map { $0 . responseObject } . map { rawResponse in
2019-08-30 07:27:59 +02:00
guard let json = rawResponse as ? JSON , let deletions = json [ " data " ] as ? [ JSON ] else {
2019-08-27 02:56:02 +02:00
print ( " [Loki] Couldn't parse deleted messages for group chat with ID: \( group ) on server: \( server ) from: \( rawResponse ) . " )
2019-09-02 05:27:12 +02:00
throw Error . parsingFailed
2019-08-27 02:56:02 +02:00
}
2019-08-30 07:27:59 +02:00
return deletions . flatMap { deletion in
guard let serverID = deletion [ " id " ] as ? UInt64 , let messageServerID = deletion [ " message_id " ] as ? UInt64 else {
print ( " [Loki] Couldn't parse deleted message for group chat with ID: \( group ) on server: \( server ) from: \( deletion ) . " )
2019-08-27 02:56:02 +02:00
return nil
2019-08-23 08:25:12 +02:00
}
2019-08-30 07:27:59 +02:00
let lastDeletionServerID = getLastDeletionServerID ( for : group , on : server )
if serverID > ( lastDeletionServerID ? ? 0 ) { setLastDeletionServerID ( for : group , on : server , to : serverID ) }
return messageServerID
2019-08-27 02:56:02 +02:00
}
}
2019-08-19 04:07:09 +02:00
}
2019-09-02 05:27:12 +02:00
public static func deleteMessage ( with messageID : UInt , for group : UInt64 , on server : String , isSentByUser : Bool ) -> Promise < Void > {
2019-08-28 08:07:14 +02:00
return getAuthToken ( for : server ) . then { token -> Promise < Void > in
2019-09-02 05:27:12 +02:00
let isModerationRequest = ! isSentByUser
print ( " [Loki] Deleting message with ID: \( messageID ) for group chat with ID: \( group ) on server: \( server ) (isModerationRequest = \( isModerationRequest ) ). " )
let urlAsString = isSentByUser ? " \( server ) /channels/ \( group ) /messages/ \( messageID ) " : " \( server ) /loki/v1/moderation/message/ \( messageID ) "
let url = URL ( string : urlAsString ) !
2019-08-28 08:07:14 +02:00
let request = TSRequest ( url : url , method : " DELETE " , parameters : [ : ] )
request . allHTTPHeaderFields = [ " Content-Type " : " application/json " , " Authorization " : " Bearer \( token ) " ]
2019-09-02 05:27:12 +02:00
return TSNetworkManager . shared ( ) . makePromise ( request : request ) . done { result -> Void in
print ( " [Loki] Deleted message with ID: \( messageID ) on server: \( server ) . " )
2019-09-02 07:44:24 +02:00
} . retryingIfNeeded ( maxRetryCount : maxRetryCount )
2019-08-28 08:07:14 +02:00
}
}
2019-09-12 05:59:57 +02:00
public static func getModerators ( for group : UInt64 , on server : String ) -> Promise < Set < String > > {
let url = URL ( string : " \( server ) /loki/v1/channel/ \( group ) /get_moderators " ) !
let request = TSRequest ( url : url )
return TSNetworkManager . shared ( ) . makePromise ( request : request ) . map { $0 . responseObject } . map { rawResponse in
guard let json = rawResponse as ? JSON , let moderators = json [ " moderators " ] as ? [ String ] else {
print ( " [Loki] Couldn't parse moderators for group chat with ID: \( group ) on server: \( server ) from: \( rawResponse ) . " )
throw Error . parsingFailed
}
2019-09-12 07:06:20 +02:00
let moderatorAsSet = Set ( moderators ) ;
if self . moderators . keys . contains ( server ) {
self . moderators [ server ] ! [ group ] = moderatorAsSet
2019-09-12 05:59:57 +02:00
} else {
2019-09-12 07:06:20 +02:00
self . moderators [ server ] = [ group : moderatorAsSet ]
2019-09-12 05:59:57 +02:00
}
2019-09-12 07:06:20 +02:00
return moderatorAsSet
2019-09-12 05:59:57 +02:00
}
}
2019-09-12 07:06:20 +02:00
@objc ( isUserModerator : forGroup : onServer : )
public static func isUserModerator ( _ hexEncodedPublicString : String , for group : UInt64 , on server : String ) -> Bool {
return moderators [ server ] ? [ group ] ? . contains ( hexEncodedPublicString ) ? ? false
}
2019-10-03 06:09:31 +02:00
public static func setDisplayName ( to newDisplayName : String ? , on server : String ) -> Promise < Void > {
print ( " [Loki] Updating display name on server: \( server ) . " )
return getAuthToken ( for : server ) . then { token -> Promise < Void > in
2019-10-07 00:53:42 +02:00
let parameters : JSON = [ " name " : ( newDisplayName ? ? " " ) ]
2019-10-03 06:09:31 +02:00
let url = URL ( string : " \( server ) /users/me " ) !
let request = TSRequest ( url : url , method : " PATCH " , parameters : parameters )
request . allHTTPHeaderFields = [ " Content-Type " : " application/json " , " Authorization " : " Bearer \( token ) " ]
2019-10-09 03:40:39 +02:00
return TSNetworkManager . shared ( ) . makePromise ( request : request ) . retryingIfNeeded ( maxRetryCount : 3 ) . map { _ in } . recover { error in
2019-10-03 06:09:31 +02:00
print ( " Couldn't update display name due to error: \( error ) . " )
throw error
}
}
}
2019-10-09 03:40:39 +02:00
public static func getChannelInfo ( _ channel : UInt64 , on server : String ) -> Promise < LokiPublicChannel > {
let url = URL ( string : " \( server ) /channels/ \( channel ) ?include_annotations=1 " ) !
let request = TSRequest ( url : url )
return TSNetworkManager . shared ( ) . makePromise ( request : request ) . map { $0 . responseObject } . map { rawResponse in
guard let json = rawResponse as ? JSON ,
let data = json [ " data " ] as ? JSON ,
let annotations = data [ " annotations " ] as ? [ JSON ] ,
let infoAnnotation = annotations . first ,
let info = infoAnnotation [ " value " ] as ? JSON ,
let name = info [ " name " ] as ? String else {
print ( " [Loki] Couldn't parse info for group chat with ID: \( channel ) on server: \( server ) from: \( rawResponse ) . " )
throw Error . parsingFailed
}
return LokiPublicChannel ( name : name )
}
}
2019-10-09 07:19:58 +02:00
public static func resetLastMessageCache ( for group : UInt64 , on server : String ) {
removeLastMessageServerID ( for : group , on : server )
removeLastDeletionServerID ( for : group , on : server )
}
2019-08-27 02:56:02 +02:00
// MARK: P u b l i c A P I ( O b j - C )
@objc ( getMessagesForGroup : onServer : )
2019-08-28 02:04:15 +02:00
public static func objc_getMessages ( for group : UInt64 , on server : String ) -> AnyPromise {
2019-08-27 02:56:02 +02:00
return AnyPromise . from ( getMessages ( for : group , on : server ) )
2019-08-19 04:07:09 +02:00
}
2019-08-27 02:56:02 +02:00
@objc ( sendMessage : toGroup : onServer : )
2019-08-28 02:04:15 +02:00
public static func objc_sendMessage ( _ message : LokiGroupMessage , to group : UInt64 , on server : String ) -> AnyPromise {
2019-08-27 02:56:02 +02:00
return AnyPromise . from ( sendMessage ( message , to : group , on : server ) )
2019-08-19 04:07:09 +02:00
}
2019-08-28 08:07:14 +02:00
2019-10-03 06:09:31 +02:00
@objc ( deleteMessageWithID : forGroup : onServer : isSentByUser : )
2019-09-02 05:27:12 +02:00
public static func objc_deleteMessage ( with messageID : UInt , for group : UInt64 , on server : String , isSentByUser : Bool ) -> AnyPromise {
return AnyPromise . from ( deleteMessage ( with : messageID , for : group , on : server , isSentByUser : isSentByUser ) )
2019-08-28 08:07:14 +02:00
}
2019-10-03 06:09:31 +02:00
@objc ( setDisplayName : on : )
public static func objc_setDisplayName ( to newDisplayName : String ? , on server : String ) -> AnyPromise {
return AnyPromise . from ( setDisplayName ( to : newDisplayName , on : server ) )
}
2019-08-19 04:07:09 +02:00
}