248 lines
13 KiB
Kotlin
248 lines
13 KiB
Kotlin
package org.session.libsession.database
|
|
|
|
import android.content.Context
|
|
import android.net.Uri
|
|
import network.loki.messenger.libsession_util.Config
|
|
import org.session.libsession.messaging.BlindedIdMapping
|
|
import org.session.libsession.messaging.calls.CallMessageType
|
|
import org.session.libsession.messaging.contacts.Contact
|
|
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.Destination
|
|
import org.session.libsession.messaging.messages.Message
|
|
import org.session.libsession.messaging.messages.control.ConfigurationMessage
|
|
import org.session.libsession.messaging.messages.control.MessageRequestResponse
|
|
import org.session.libsession.messaging.messages.visible.Attachment
|
|
import org.session.libsession.messaging.messages.visible.Profile
|
|
import org.session.libsession.messaging.messages.visible.Reaction
|
|
import org.session.libsession.messaging.messages.visible.VisibleMessage
|
|
import org.session.libsession.messaging.open_groups.GroupMember
|
|
import org.session.libsession.messaging.open_groups.OpenGroup
|
|
import org.session.libsession.messaging.open_groups.OpenGroupApi
|
|
import org.session.libsession.messaging.sending_receiving.attachments.AttachmentId
|
|
import org.session.libsession.messaging.sending_receiving.attachments.DatabaseAttachment
|
|
import org.session.libsession.messaging.sending_receiving.data_extraction.DataExtractionNotificationInfoMessage
|
|
import org.session.libsession.messaging.sending_receiving.link_preview.LinkPreview
|
|
import org.session.libsession.messaging.sending_receiving.quotes.QuoteModel
|
|
import org.session.libsession.utilities.Address
|
|
import org.session.libsession.utilities.GroupRecord
|
|
import org.session.libsession.utilities.recipients.Recipient
|
|
import org.session.libsession.utilities.recipients.Recipient.RecipientSettings
|
|
import org.session.libsignal.crypto.ecc.ECKeyPair
|
|
import org.session.libsignal.messages.SignalServiceAttachmentPointer
|
|
import org.session.libsignal.messages.SignalServiceGroup
|
|
import org.session.libsignal.utilities.SessionId
|
|
import org.session.libsignal.utilities.guava.Optional
|
|
import network.loki.messenger.libsession_util.util.Contact as LibSessionContact
|
|
import network.loki.messenger.libsession_util.util.GroupMember as LibSessionGroupMember
|
|
|
|
interface StorageProtocol {
|
|
|
|
// General
|
|
fun getUserPublicKey(): String?
|
|
fun getUserX25519KeyPair(): ECKeyPair
|
|
fun getUserProfile(): Profile
|
|
fun setProfileAvatar(recipient: Recipient, profileAvatar: String?)
|
|
fun setProfilePicture(recipient: Recipient, newProfilePicture: String?, newProfileKey: ByteArray?)
|
|
fun setBlocksCommunityMessageRequests(recipient: Recipient, blocksMessageRequests: Boolean)
|
|
fun setUserProfilePicture(newProfilePicture: String?, newProfileKey: ByteArray?)
|
|
fun clearUserPic()
|
|
// Signal
|
|
fun getOrGenerateRegistrationID(): Int
|
|
|
|
// Jobs
|
|
fun persistJob(job: Job)
|
|
fun markJobAsSucceeded(jobId: String)
|
|
fun markJobAsFailedPermanently(jobId: String)
|
|
fun getAllPendingJobs(type: String): Map<String,Job?>
|
|
fun getAttachmentUploadJob(attachmentID: Long): AttachmentUploadJob?
|
|
fun getMessageSendJob(messageSendJobID: String): MessageSendJob?
|
|
fun getMessageReceiveJob(messageReceiveJobID: String): Job?
|
|
fun getGroupAvatarDownloadJob(server: String, room: String, imageId: String?): Job?
|
|
fun getConfigSyncJob(destination: Destination): Job?
|
|
fun resumeMessageSendJobIfNeeded(messageSendJobID: String)
|
|
fun isJobCanceled(job: Job): Boolean
|
|
fun cancelPendingMessageSendJobs(threadID: Long)
|
|
|
|
// Authorization
|
|
fun getAuthToken(room: String, server: String): String?
|
|
fun setAuthToken(room: String, server: String, newValue: String)
|
|
fun removeAuthToken(room: String, server: String)
|
|
|
|
// Servers
|
|
fun setServerCapabilities(server: String, capabilities: List<String>)
|
|
fun getServerCapabilities(server: String): List<String>
|
|
|
|
// Open Groups
|
|
fun getAllOpenGroups(): Map<Long, OpenGroup>
|
|
fun updateOpenGroup(openGroup: OpenGroup)
|
|
fun getOpenGroup(threadId: Long): OpenGroup?
|
|
fun addOpenGroup(urlAsString: String): OpenGroupApi.RoomInfo?
|
|
fun onOpenGroupAdded(server: String, room: String)
|
|
fun hasBackgroundGroupAddJob(groupJoinUrl: String): Boolean
|
|
fun setOpenGroupServerMessageID(messageID: Long, serverID: Long, threadID: Long, isSms: Boolean)
|
|
fun getOpenGroup(room: String, server: String): OpenGroup?
|
|
fun setGroupMemberRoles(members: List<GroupMember>)
|
|
|
|
// Open Group Public Keys
|
|
fun getOpenGroupPublicKey(server: String): String?
|
|
fun setOpenGroupPublicKey(server: String, newValue: String)
|
|
|
|
// Open Group Metadata
|
|
fun updateTitle(groupID: String, newValue: String)
|
|
fun updateProfilePicture(groupID: String, newValue: ByteArray)
|
|
fun removeProfilePicture(groupID: String)
|
|
fun hasDownloadedProfilePicture(groupID: String): Boolean
|
|
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 isDuplicateMessage(timestamp: Long): 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? // TODO: This is a weird name
|
|
fun updateSentTimestamp(messageID: Long, isMms: Boolean, openGroupSentTimestamp: Long, threadId: Long)
|
|
fun markAsResyncing(timestamp: Long, author: String)
|
|
fun markAsSyncing(timestamp: Long, author: String)
|
|
fun markAsSending(timestamp: Long, author: String)
|
|
fun markAsSent(timestamp: Long, author: String)
|
|
fun markUnidentified(timestamp: Long, author: String)
|
|
fun markAsSyncFailed(timestamp: Long, author: String, error: Exception)
|
|
fun markAsSentFailed(timestamp: Long, author: String, error: Exception)
|
|
fun clearErrorMessage(messageID: Long)
|
|
fun setMessageServerHash(messageID: Long, serverHash: String)
|
|
|
|
// Legacy 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 createInitialConfigGroup(groupPublicKey: String, name: String, members: Map<String, Boolean>, formationTimestamp: Long, encryptionKeyPair: ECKeyPair)
|
|
fun updateGroupConfig(groupPublicKey: String)
|
|
fun isGroupActive(groupPublicKey: String): Boolean
|
|
fun setActive(groupID: String, value: Boolean)
|
|
fun getZombieMembers(groupID: String): Set<String>
|
|
fun removeMember(groupID: String, member: Address)
|
|
fun updateMembers(groupID: String, members: List<Address>)
|
|
fun setZombieMembers(groupID: String, members: List<Address>)
|
|
fun getAllClosedGroupPublicKeys(): Set<String>
|
|
fun getAllActiveClosedGroupPublicKeys(): Set<String>
|
|
fun addClosedGroupPublicKey(groupPublicKey: String)
|
|
fun removeClosedGroupPublicKey(groupPublicKey: String)
|
|
fun addClosedGroupEncryptionKeyPair(encryptionKeyPair: ECKeyPair, groupPublicKey: String, timestamp: Long)
|
|
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 isLegacyClosedGroup(publicKey: String): Boolean
|
|
fun getClosedGroupEncryptionKeyPairs(groupPublicKey: String): MutableList<ECKeyPair>
|
|
fun getLatestClosedGroupEncryptionKeyPair(groupPublicKey: String): ECKeyPair?
|
|
fun updateFormationTimestamp(groupID: String, formationTimestamp: Long)
|
|
fun updateTimestampUpdated(groupID: String, updatedTimestamp: Long)
|
|
fun setExpirationTimer(address: String, duration: Int)
|
|
|
|
// Closed Groups
|
|
fun createNewGroup(groupName: String, groupDescription: String, members: Set<SessionId>): Optional<Recipient>
|
|
fun getMembers(groupPublicKey: String): List<LibSessionGroupMember>
|
|
fun acceptClosedGroupInvite(groupId: SessionId, name: String, authData: ByteArray, invitingAdmin: SessionId)
|
|
fun setGroupInviteComplete(approved: Boolean, invitee: String, closedGroup: SessionId)
|
|
|
|
// Groups
|
|
fun getAllGroups(includeInactive: Boolean): List<GroupRecord>
|
|
|
|
// Settings
|
|
fun setProfileSharing(address: Address, value: Boolean)
|
|
|
|
|
|
// Thread
|
|
fun getOrCreateThreadIdFor(address: Address): Long
|
|
fun getThreadIdFor(publicKey: String, groupPublicKey: String?, openGroupID: String?, createThread: Boolean): Long?
|
|
fun getThreadId(publicKeyOrOpenGroupID: String): Long?
|
|
fun getThreadId(openGroup: OpenGroup): Long?
|
|
fun getThreadId(address: Address): Long?
|
|
fun getThreadId(recipient: Recipient): Long?
|
|
fun getThreadIdForMms(mmsId: Long): Long
|
|
fun getLastUpdated(threadID: Long): Long
|
|
fun trimThread(threadID: Long, threadLimit: Int)
|
|
fun trimThreadBefore(threadID: Long, timestamp: Long)
|
|
fun getMessageCount(threadID: Long): Long
|
|
fun setPinned(threadID: Long, isPinned: Boolean)
|
|
fun isPinned(threadID: Long): Boolean
|
|
fun deleteConversation(threadID: Long)
|
|
fun setThreadDate(threadId: Long, newDate: Long)
|
|
fun clearMessages(threadID: Long, fromUser: Address? = null): Boolean
|
|
fun clearMedia(threadID: Long, fromUser: Address? = null): Boolean
|
|
|
|
// Contacts
|
|
fun getContactWithSessionID(sessionID: String): Contact?
|
|
fun getAllContacts(): Set<Contact>
|
|
fun setContact(contact: Contact)
|
|
fun getRecipientForThread(threadId: Long): Recipient?
|
|
fun getRecipientSettings(address: Address): RecipientSettings?
|
|
fun addLibSessionContacts(contacts: List<LibSessionContact>)
|
|
fun hasAutoDownloadFlagBeenSet(recipient: Recipient): Boolean
|
|
fun addContacts(contacts: List<ConfigurationMessage.Contact>)
|
|
fun shouldAutoDownloadAttachments(recipient: Recipient): Boolean
|
|
fun setAutoDownloadAttachments(recipient: Recipient, shouldAutoDownloadAttachments: Boolean)
|
|
|
|
// Attachments
|
|
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>, runThreadUpdate: Boolean): Long?
|
|
fun markConversationAsRead(threadId: Long, lastSeenTime: Long, force: Boolean = false)
|
|
fun getLastSeen(threadId: Long): Long
|
|
fun updateThread(threadId: Long, unarchive: Boolean)
|
|
fun insertDataExtractionNotificationMessage(senderPublicKey: String, message: DataExtractionNotificationInfoMessage, sentTimestamp: Long)
|
|
fun insertMessageRequestResponse(response: MessageRequestResponse)
|
|
fun setRecipientApproved(recipient: Recipient, approved: Boolean)
|
|
fun getRecipientApproved(address: Address): Boolean
|
|
fun setRecipientApprovedMe(recipient: Recipient, approvedMe: Boolean)
|
|
fun insertCallMessage(senderPublicKey: String, callMessageType: CallMessageType, sentTimestamp: Long)
|
|
fun conversationHasOutgoing(userPublicKey: String): Boolean
|
|
|
|
// Last Inbox Message Id
|
|
fun getLastInboxMessageId(server: String): Long?
|
|
fun setLastInboxMessageId(server: String, messageId: Long)
|
|
fun removeLastInboxMessageId(server: String)
|
|
|
|
// Last Outbox Message Id
|
|
fun getLastOutboxMessageId(server: String): Long?
|
|
fun setLastOutboxMessageId(server: String, messageId: Long)
|
|
fun removeLastOutboxMessageId(server: String)
|
|
fun getOrCreateBlindedIdMapping(blindedId: String, server: String, serverPublicKey: String, fromOutbox: Boolean = false): BlindedIdMapping
|
|
|
|
fun addReaction(reaction: Reaction, messageSender: String, notifyUnread: Boolean)
|
|
fun removeReaction(emoji: String, messageTimestamp: Long, author: String, notifyUnread: Boolean)
|
|
fun updateReactionIfNeeded(message: Message, sender: String, openGroupSentTimestamp: Long)
|
|
fun deleteReactions(messageId: Long, mms: Boolean)
|
|
fun setBlocked(recipients: Iterable<Recipient>, isBlocked: Boolean, fromConfigUpdate: Boolean = false)
|
|
fun setRecipientHash(recipient: Recipient, recipientHash: String?)
|
|
fun blockedContacts(): List<Recipient>
|
|
|
|
// Shared configs
|
|
fun notifyConfigUpdates(forConfigObject: Config)
|
|
fun conversationInConfig(publicKey: String?, groupPublicKey: String?, openGroupId: String?, visibleOnly: Boolean): Boolean
|
|
fun canPerformConfigChange(variant: String, publicKey: String, changeTimestampMs: Long): Boolean
|
|
fun isCheckingCommunityRequests(): Boolean
|
|
}
|