195 lines
9.3 KiB
Kotlin
195 lines
9.3 KiB
Kotlin
package org.session.libsession.messaging
|
|
|
|
|
|
import android.content.Context
|
|
import android.net.Uri
|
|
import org.session.libsession.messaging.jobs.AttachmentUploadJob
|
|
import org.session.libsession.messaging.jobs.Job
|
|
import org.session.libsession.messaging.jobs.MessageSendJob
|
|
import org.session.libsession.messaging.messages.control.ConfigurationMessage
|
|
import org.session.libsession.messaging.messages.visible.Attachment
|
|
import org.session.libsession.messaging.messages.visible.VisibleMessage
|
|
import org.session.libsession.messaging.open_groups.OpenGroup
|
|
import org.session.libsession.messaging.open_groups.OpenGroupV2
|
|
import org.session.libsession.messaging.sending_receiving.attachments.AttachmentId
|
|
import org.session.libsession.messaging.sending_receiving.data_extraction.DataExtractionNotificationInfoMessage
|
|
import org.session.libsession.messaging.sending_receiving.attachments.DatabaseAttachment
|
|
import org.session.libsession.messaging.sending_receiving.link_preview.LinkPreview
|
|
import org.session.libsession.messaging.sending_receiving.quotes.QuoteModel
|
|
import org.session.libsession.messaging.threads.Address
|
|
import org.session.libsession.messaging.threads.GroupRecord
|
|
import org.session.libsession.messaging.threads.recipients.Recipient.RecipientSettings
|
|
import org.session.libsignal.libsignal.ecc.ECKeyPair
|
|
import org.session.libsignal.service.api.messages.SignalServiceAttachmentPointer
|
|
import org.session.libsignal.service.api.messages.SignalServiceGroup
|
|
|
|
interface StorageProtocol {
|
|
|
|
// General
|
|
fun getUserPublicKey(): String?
|
|
fun getUserKeyPair(): Pair<String, ByteArray>?
|
|
fun getUserX25519KeyPair(): ECKeyPair
|
|
fun getUserDisplayName(): String?
|
|
fun getUserProfileKey(): ByteArray?
|
|
fun getUserProfilePictureURL(): String?
|
|
fun setUserProfilePictureUrl(newProfilePicture: String)
|
|
|
|
fun getProfileKeyForRecipient(recipientPublicKey: String): ByteArray?
|
|
fun getDisplayNameForRecipient(recipientPublicKey: String): String?
|
|
fun setProfileKeyForRecipient(recipientPublicKey: String, profileKey: ByteArray)
|
|
|
|
// Signal Protocol
|
|
|
|
fun getOrGenerateRegistrationID(): Int
|
|
|
|
// Jobs
|
|
fun persistJob(job: Job)
|
|
fun markJobAsSucceeded(job: Job)
|
|
fun markJobAsFailed(job: Job)
|
|
fun getAllPendingJobs(type: String): List<Job>
|
|
fun getAttachmentUploadJob(attachmentID: Long): AttachmentUploadJob?
|
|
fun getMessageSendJob(messageSendJobID: String): MessageSendJob?
|
|
fun resumeMessageSendJobIfNeeded(messageSendJobID: String)
|
|
fun isJobCanceled(job: Job): Boolean
|
|
|
|
// Authorization
|
|
fun getAuthToken(room: String, server: String): String?
|
|
fun setAuthToken(room: String, server: String, newValue: String)
|
|
fun removeAuthToken(room: String, server: String)
|
|
|
|
// Open Groups
|
|
fun getAllV2OpenGroups(): Map<Long, OpenGroupV2>
|
|
fun getV2OpenGroup(threadId: String): OpenGroupV2?
|
|
|
|
// Open Groups
|
|
fun getThreadID(openGroupID: String): String?
|
|
fun addOpenGroup(server: String, channel: Long)
|
|
fun setOpenGroupServerMessageID(messageID: Long, serverID: Long, threadID: Long, isSms: Boolean)
|
|
fun getQuoteServerID(quoteID: Long, publicKey: String): Long?
|
|
|
|
// Open Group Public Keys
|
|
fun getOpenGroupPublicKey(server: String): String?
|
|
fun setOpenGroupPublicKey(server: String, newValue: String)
|
|
|
|
// Open Group User Info
|
|
fun setOpenGroupDisplayName(publicKey: String, room: String, server: String, displayName: String)
|
|
fun getOpenGroupDisplayName(publicKey: String, room: String, server: String): String?
|
|
|
|
// Open Group Metadata
|
|
|
|
fun updateTitle(groupID: String, newValue: String)
|
|
fun updateProfilePicture(groupID: String, newValue: ByteArray)
|
|
fun setUserCount(room: String, server: String, newValue: Int)
|
|
|
|
// Last Message Server ID
|
|
fun getLastMessageServerId(room: String, server: String): Long?
|
|
fun setLastMessageServerId(room: String, server: String, newValue: Long)
|
|
fun removeLastMessageServerId(room: String, server: String)
|
|
|
|
// Last Deletion Server ID
|
|
fun getLastDeletionServerId(room: String, server: String): Long?
|
|
fun setLastDeletionServerId(room: String, server: String, newValue: Long)
|
|
fun removeLastDeletionServerId(room: String, server: String)
|
|
|
|
// Message Handling
|
|
fun isMessageDuplicated(timestamp: Long, sender: String): Boolean
|
|
fun getReceivedMessageTimestamps(): Set<Long>
|
|
fun addReceivedMessageTimestamp(timestamp: Long)
|
|
// fun removeReceivedMessageTimestamps(timestamps: Set<Long>)
|
|
// Returns the IDs of the saved attachments.
|
|
fun persistAttachments(messageId: Long, attachments: List<Attachment>): List<Long>
|
|
fun getAttachmentsForMessage(messageId: Long): List<DatabaseAttachment>
|
|
|
|
fun getMessageIdInDatabase(timestamp: Long, author: String): Long?
|
|
fun markAsSent(timestamp: Long, author: String)
|
|
fun markUnidentified(timestamp: Long, author: String)
|
|
fun setErrorMessage(timestamp: Long, author: String, error: Exception)
|
|
|
|
// Closed Groups
|
|
fun getGroup(groupID: String): GroupRecord?
|
|
fun createGroup(groupID: String, title: String?, members: List<Address>, avatar: SignalServiceAttachmentPointer?, relay: String?, admins: List<Address>, formationTimestamp: Long)
|
|
fun isGroupActive(groupPublicKey: String): Boolean
|
|
fun setActive(groupID: String, value: Boolean)
|
|
fun getZombieMember(groupID: String): Set<String>
|
|
fun removeMember(groupID: String, member: Address)
|
|
fun updateMembers(groupID: String, members: List<Address>)
|
|
fun updateZombieMembers(groupID: String, members: List<Address>)
|
|
// Closed Group
|
|
fun getAllClosedGroupPublicKeys(): Set<String>
|
|
fun getAllActiveClosedGroupPublicKeys(): Set<String>
|
|
fun addClosedGroupPublicKey(groupPublicKey: String)
|
|
fun removeClosedGroupPublicKey(groupPublicKey: String)
|
|
fun addClosedGroupEncryptionKeyPair(encryptionKeyPair: ECKeyPair, groupPublicKey: String)
|
|
fun removeAllClosedGroupEncryptionKeyPairs(groupPublicKey: String)
|
|
fun insertIncomingInfoMessage(context: Context, senderPublicKey: String, groupID: String, type: SignalServiceGroup.Type,
|
|
name: String, members: Collection<String>, admins: Collection<String>, sentTimestamp: Long)
|
|
fun insertOutgoingInfoMessage(context: Context, groupID: String, type: SignalServiceGroup.Type, name: String,
|
|
members: Collection<String>, admins: Collection<String>, threadID: Long, sentTimestamp: Long)
|
|
fun isClosedGroup(publicKey: String): Boolean
|
|
fun getClosedGroupEncryptionKeyPairs(groupPublicKey: String): MutableList<ECKeyPair>
|
|
fun getLatestClosedGroupEncryptionKeyPair(groupPublicKey: String): ECKeyPair?
|
|
|
|
// Groups
|
|
fun getAllGroups(): List<GroupRecord>
|
|
|
|
// Settings
|
|
fun setProfileSharing(address: Address, value: Boolean)
|
|
|
|
// Thread
|
|
fun getOrCreateThreadIdFor(address: Address): Long
|
|
fun getOrCreateThreadIdFor(publicKey: String, groupPublicKey: String?, openGroupID: String?): Long
|
|
fun getThreadIdFor(address: Address): Long?
|
|
fun getThreadIdForMms(mmsId: Long): Long
|
|
|
|
// Session Request
|
|
fun getSessionRequestSentTimestamp(publicKey: String): Long?
|
|
fun setSessionRequestSentTimestamp(publicKey: String, newValue: Long)
|
|
fun getSessionRequestProcessedTimestamp(publicKey: String): Long?
|
|
fun setSessionRequestProcessedTimestamp(publicKey: String, newValue: Long)
|
|
|
|
// Loki User
|
|
fun getDisplayName(publicKey: String): String?
|
|
fun setDisplayName(publicKey: String, newName: String)
|
|
fun getServerDisplayName(serverID: String, publicKey: String): String?
|
|
fun getProfilePictureURL(publicKey: String): String?
|
|
|
|
// Recipient
|
|
fun getRecipientSettings(address: Address): RecipientSettings?
|
|
fun addContacts(contacts: List<ConfigurationMessage.Contact>)
|
|
|
|
// PartAuthority
|
|
fun getAttachmentDataUri(attachmentId: AttachmentId): Uri
|
|
fun getAttachmentThumbnailUri(attachmentId: AttachmentId): Uri
|
|
|
|
// Message Handling
|
|
/// Returns the ID of the `TSIncomingMessage` that was constructed.
|
|
fun persist(message: VisibleMessage, quotes: QuoteModel?, linkPreview: List<LinkPreview?>, groupPublicKey: String?, openGroupID: String?, attachments: List<Attachment>): Long?
|
|
|
|
// Data Extraction Notification
|
|
fun insertDataExtractionNotificationMessage(senderPublicKey: String, message: DataExtractionNotificationInfoMessage, sentTimestamp: Long)
|
|
|
|
// DEPRECATED
|
|
fun getAuthToken(server: String): String?
|
|
fun setAuthToken(server: String, newValue: String?)
|
|
fun removeAuthToken(server: String)
|
|
|
|
fun getLastMessageServerID(group: Long, server: String): Long?
|
|
fun setLastMessageServerID(group: Long, server: String, newValue: Long)
|
|
fun removeLastMessageServerID(group: Long, server: String)
|
|
|
|
fun getLastDeletionServerID(group: Long, server: String): Long?
|
|
fun setLastDeletionServerID(group: Long, server: String, newValue: Long)
|
|
fun removeLastDeletionServerID(group: Long, server: String)
|
|
|
|
fun getOpenGroup(threadID: String): OpenGroup?
|
|
fun getAllOpenGroups(): Map<Long, OpenGroup>
|
|
|
|
fun setUserCount(group: Long, server: String, newValue: Int)
|
|
fun setOpenGroupProfilePictureURL(group: Long, server: String, newValue: String)
|
|
fun getOpenGroupProfilePictureURL(group: Long, server: String): String?
|
|
|
|
fun setOpenGroupDisplayName(publicKey: String, channel: Long, server: String, displayName: String)
|
|
fun getOpenGroupDisplayName(publicKey: String, channel: Long, server: String): String?
|
|
|
|
}
|