database

Mar 16, 2024

Changes in this version

+ type BackfillStateQuery struct

+ func (bq *BackfillStateQuery) GetBackfillState(ctx context.Context, userID id.UserID, portalKey PortalKey) (*BackfillState, error)

+ func (bq *BackfillStateQuery) NewBackfillState(userID id.UserID, portalKey PortalKey) *BackfillState

+ type BackfillTask struct

+ BackfillType BackfillType

+ BatchDelay int

+ CompletedAt *time.Time

+ DispatchTime *time.Time

+ MaxBatchEvents int

+ MaxTotalEvents int

+ Portal PortalKey

+ Priority int

+ QueueID int

+ TimeStart *time.Time

+ UserID id.UserID

+ func (b *BackfillTask) Insert(ctx context.Context) error

+ func (b *BackfillTask) MarkDispatched(ctx context.Context) error

+ func (b *BackfillTask) MarkDone(ctx context.Context) error

+ func (b *BackfillTask) MarshalZerologObject(evt *zerolog.Event)

+ func (b *BackfillTask) Scan(row dbutil.Scannable) (*BackfillTask, error)

+ func (b *BackfillTask) String() string

+ type BackfillTaskQuery struct

+ func (bq *BackfillTaskQuery) DeleteAll(ctx context.Context, userID id.UserID) error

+ func (bq *BackfillTaskQuery) DeleteAllForPortal(ctx context.Context, userID id.UserID, portalKey PortalKey) error

+ func (bq *BackfillTaskQuery) GetNext(ctx context.Context, userID id.UserID, backfillTypes []BackfillType) (*BackfillTask, error)

+ func (bq *BackfillTaskQuery) HasUnstartedOrInFlightOfType(ctx context.Context, userID id.UserID, backfillTypes []BackfillType) (has bool)

+ func (bq *BackfillTaskQuery) NewWithValues(userID id.UserID, backfillType BackfillType, priority int, portal PortalKey, ...) *BackfillTask

type Database

+ BackfillQueue *BackfillTaskQuery

+ BackfillState *BackfillStateQuery

Oct 16, 2023

Changes in this version

type HistorySyncQuery

+ func (hsq *HistorySyncQuery) ConversationHasMessages(userID id.UserID, portalKey PortalKey) (exists bool)

Sep 16, 2023

Changes in this version

type Message

+ GalleryPart int

type MessageType

+ const MsgBeeperGallery

Jul 16, 2023

Changes in this version

type HistorySyncQuery

+ func (hsq *HistorySyncQuery) DeleteConversation(userID id.UserID, jid string)

+ func (hsq *HistorySyncQuery) GetRecentConversations(userID id.UserID, n int) (conversations []*HistorySyncConversation)

Jun 16, 2023

Changes in this version

type Message

+ SenderMXID id.UserID

Apr 16, 2023

Changes in this version

type Puppet

+ ContactInfoSet bool

Jan 16, 2023

Changes in this version

type Message

+ func (msg *Message) GetPollOptionHashes(ids []string) map[string][32]byte

+ func (msg *Message) GetPollOptionIDs(hashes [][]byte) map[[32]byte]string

+ func (msg *Message) PutPollOptions(opts map[[32]byte]string)

type MessageType

+ const MsgMatrixPoll

Dec 16, 2022

Changes in this version

type Portal

+ InSpace bool

+ IsParent bool

+ ParentGroup types.JID

type PortalQuery

+ func (pq *PortalQuery) GetAllByParentGroup(jid types.JID) []*Portal

Oct 16, 2022

Changes in this version

type MessageType

+ const MsgEdit

Jul 16, 2022

Changes in this version

type Portal

+ AvatarSet bool

+ LastSync time.Time

+ NameSet bool

+ TopicSet bool

type Puppet

+ AvatarSet bool

+ LastSync time.Time

+ NameSet bool

Jun 16, 2022

Changes in this version

type Backfill

+ DispatchTime *time.Time

+ func (b *Backfill) MarkDispatched()

type BackfillQuery

+ func (bq *BackfillQuery) GetBackfillState(userID id.UserID, portalKey *PortalKey) (backfillState *BackfillState)

+ func (bq *BackfillQuery) HasUnstartedOrInFlightOfType(userID id.UserID, backfillTypes []BackfillType) bool

+ func (bq *BackfillQuery) NewBackfillState(userID id.UserID, portalKey *PortalKey) *BackfillState

+ type BackfillState struct

+ BackfillComplete bool

+ FirstExpectedTimestamp uint64

+ Portal *PortalKey

+ ProcessingBatch bool

+ UserID id.UserID

+ func (b *BackfillState) Scan(row dbutil.Scannable) *BackfillState

+ func (b *BackfillState) SetProcessingBatch(processing bool)

+ func (b *BackfillState) Upsert()

May 16, 2022

Changes in this version

+ type Backfill struct

+ BackfillType BackfillType

+ BatchDelay int

+ CompletedAt *time.Time

+ MaxBatchEvents int

+ MaxTotalEvents int

+ Portal *PortalKey

+ Priority int

+ QueueID int

+ TimeEnd *time.Time

+ TimeStart *time.Time

+ UserID id.UserID

+ func (b *Backfill) Insert()

+ func (b *Backfill) MarkDone()

+ func (b *Backfill) Scan(row Scannable) *Backfill

+ func (b *Backfill) String() string

+ type BackfillQuery struct

+ func (bq *BackfillQuery) DeleteAll(userID id.UserID) error

+ func (bq *BackfillQuery) DeleteAllForPortal(userID id.UserID, portalKey PortalKey) error

+ func (bq *BackfillQuery) GetNext(userID id.UserID) (backfill *Backfill)

+ func (bq *BackfillQuery) New() *Backfill

+ func (bq *BackfillQuery) NewWithValues(userID id.UserID, backfillType BackfillType, priority int, portal *PortalKey, ...) *Backfill

+ type BackfillType int

+ const BackfillDeferred

+ const BackfillForward

+ const BackfillImmediate

+ func (bt BackfillType) String() string

type Database

+ Backfill *BackfillQuery

+ HistorySync *HistorySyncQuery

+ MediaBackfillRequest *MediaBackfillRequestQuery

+ func (db *Database) HandleSignalStoreError(device *store.Device, action string, attemptIndex int, err error) (retry bool)

+ type HistorySyncConversation struct

+ Archived bool

+ ConversationID string

+ DisappearingMode waProto.DisappearingMode_DisappearingModeInitiator

+ EndOfHistoryTransferType waProto.Conversation_ConversationEndOfHistoryTransferType

+ EphemeralExpiration *uint32

+ LastMessageTimestamp time.Time

+ MarkedAsUnread bool

+ MuteEndTime time.Time

+ Pinned uint32

+ PortalKey *PortalKey

+ UnreadCount uint32

+ UserID id.UserID

+ func (hsc *HistorySyncConversation) Scan(row Scannable) *HistorySyncConversation

+ func (hsc *HistorySyncConversation) Upsert()

+ type HistorySyncMessage struct

+ ConversationID string

+ Data []byte

+ MessageID string

+ Timestamp time.Time

+ UserID id.UserID

+ func (hsm *HistorySyncMessage) Insert()

+ type HistorySyncQuery struct

+ func (hsq *HistorySyncQuery) DeleteAllConversations(userID id.UserID) error

+ func (hsq *HistorySyncQuery) DeleteAllMessages(userID id.UserID) error

+ func (hsq *HistorySyncQuery) DeleteAllMessagesForPortal(userID id.UserID, portalKey PortalKey) error

+ func (hsq *HistorySyncQuery) DeleteMessages(userID id.UserID, conversationID string, messages []*waProto.WebMessageInfo) error

+ func (hsq *HistorySyncQuery) GetConversation(userID id.UserID, portalKey *PortalKey) (conversation *HistorySyncConversation)

+ func (hsq *HistorySyncQuery) GetMessagesBetween(userID id.UserID, conversationID string, startTime, endTime *time.Time, ...) (messages []*waProto.WebMessageInfo)

+ func (hsq *HistorySyncQuery) GetNMostRecentConversations(userID id.UserID, n int) (conversations []*HistorySyncConversation)

+ func (hsq *HistorySyncQuery) NewConversation() *HistorySyncConversation

+ func (hsq *HistorySyncQuery) NewConversationWithValues(userID id.UserID, conversationID string, portalKey *PortalKey, ...) *HistorySyncConversation

+ func (hsq *HistorySyncQuery) NewMessageWithValues(userID id.UserID, conversationID, messageID string, ...) (*HistorySyncMessage, error)

+ type MediaBackfillRequest struct

+ Error string

+ EventID id.EventID

+ MediaKey []byte

+ PortalKey *PortalKey

+ Status MediaBackfillRequestStatus

+ UserID id.UserID

+ func (mbr *MediaBackfillRequest) Scan(row Scannable) *MediaBackfillRequest

+ func (mbr *MediaBackfillRequest) Upsert()

+ type MediaBackfillRequestQuery struct

+ func (mbr *MediaBackfillRequestQuery) DeleteAllMediaBackfillRequests(userID id.UserID) error

+ func (mbr *MediaBackfillRequestQuery) GetMediaBackfillRequestsForUser(userID id.UserID) (requests []*MediaBackfillRequest)

+ func (mbrq *MediaBackfillRequestQuery) NewMediaBackfillRequestWithValues(userID id.UserID, portalKey *PortalKey, eventID id.EventID, mediaKey []byte) *MediaBackfillRequest

+ type MediaBackfillRequestStatus int

+ const MediaBackfillRequestStatusNotRequested

+ const MediaBackfillRequestStatusRequestFailed

+ const MediaBackfillRequestStatusRequested

type PortalQuery

+ func (pq *PortalQuery) GetAllForUser(userID id.UserID) []*Portal

type User

+ Timezone string

+ func (user *User) GetLastAppStateKeyID() ([]byte, error)

Mar 15, 2022

Changes in this version

type Database

+ Reaction *ReactionQuery

type Message

+ Type MessageType

+ type MessageType string

+ const MsgFake

+ const MsgNormal

+ const MsgReaction

+ const MsgUnknown

+ type Reaction struct

+ Chat PortalKey

+ JID types.MessageID

+ MXID id.EventID

+ Sender types.JID

+ TargetJID types.MessageID

+ func (reaction *Reaction) Delete()

+ func (reaction *Reaction) GetTarget() *Message

+ func (reaction *Reaction) Scan(row Scannable) *Reaction

+ func (reaction *Reaction) Upsert()

+ type ReactionQuery struct

+ func (rq *ReactionQuery) GetByMXID(mxid id.EventID) *Reaction

+ func (rq *ReactionQuery) GetByTargetJID(chat PortalKey, jid types.MessageID, sender types.JID) *Reaction

+ func (rq *ReactionQuery) New() *Reaction

type User

+ PhoneLastPinged time.Time

Feb 16, 2022

Changes in this version

type Message

+ Error MessageErrorType

+ type MessageErrorType string

+ const MsgErrDecryptionFailed

+ const MsgErrMediaNotFound

+ const MsgNoError

type User

+ PhoneLastSeen time.Time

Jan 16, 2022

Changes in this version

type Database

+ DisappearingMessage *DisappearingMessageQuery

+ type DisappearingMessage struct

+ EventID id.EventID

+ ExpireAt time.Time

+ ExpireIn time.Duration

+ RoomID id.RoomID

+ func (msg *DisappearingMessage) Delete()

+ func (msg *DisappearingMessage) Insert()

+ func (msg *DisappearingMessage) Scan(row Scannable) *DisappearingMessage

+ func (msg *DisappearingMessage) StartTimer()

+ type DisappearingMessageQuery struct

+ func (dmq *DisappearingMessageQuery) GetUpcomingScheduled(duration time.Duration) (messages []*DisappearingMessage)

+ func (dmq *DisappearingMessageQuery) New() *DisappearingMessage

+ func (dmq *DisappearingMessageQuery) NewWithValues(roomID id.RoomID, eventID id.EventID, expireIn time.Duration, startNow bool) *DisappearingMessage

+ func (dmq *DisappearingMessageQuery) StartAllUnscheduledInRoom(roomID id.RoomID) (messages []*DisappearingMessage)

type Message

+ BroadcastListJID types.JID

type Portal

+ ExpirationTime uint32

type PortalQuery

+ func (pq *PortalQuery) FindPrivateChatsNotInSpace(receiver types.JID) (keys []PortalKey)

type User

+ SpaceRoom id.RoomID

+ func (user *User) IsInSpace(portal PortalKey) bool

+ func (user *User) MarkInSpace(portal PortalKey)

Dec 16, 2021

Changes in this version

type MessageQuery

+ func (mq *MessageQuery) GetMessagesBetween(chat PortalKey, minTimestamp, maxTimestamp time.Time) (messages []*Message)

type User

+ func (user *User) GetLastReadTS(portal PortalKey) time.Time

+ func (user *User) SetLastReadTS(portal PortalKey, ts time.Time)

Nov 10, 2021

Changes in this version

type Message

+ DecryptionError bool

+ func (msg *Message) IsFakeJID() bool

+ func (msg *Message) UpdateMXID(mxid id.EventID, stillDecryptionError bool)

type MessageQuery

+ func (mq *MessageQuery) GetFirstInChat(chat PortalKey) *Message

type Portal

+ FirstEventID id.EventID

+ NextBatchID id.BatchID

+ RelayUserID id.UserID

type UserQuery

+ func (uq *UserQuery) GetByUsername(username string) *User

Jun 15, 2021

Changes in this version

type MessageQuery

+ func (mq *MessageQuery) GetLastInChatBefore(chat PortalKey, maxTimestamp int64) *Message

Apr 1, 2021

Changes in this version

type Message

+ Sent bool

+ func (msg *Message) IsFakeMXID() bool

+ func (msg *Message) MarkSent()

type User

+ func (user *User) CreateUserPortal(newKey PortalKeyWithMeta)

Sep 4, 2020

Changes in this version

type PortalQuery

+ func (pq *PortalQuery) FindPrivateChats(receiver types.WhatsAppID) []*Portal

type Puppet

+ EnableReceipts bool

type SQLCryptoStore

+ func (store *SQLCryptoStore) FindDeviceID() (deviceID id.DeviceID)

Jul 10, 2020

Changes in this version

type Puppet

+ EnablePresence bool

Jun 3, 2020

Changes in this version

+ const VariableCountLimit

+ func Migrate(old *Database, new *Database)

+ type Database struct

+ Message *MessageQuery

+ Portal *PortalQuery

+ Puppet *PuppetQuery

+ User *UserQuery

+ func New(dbType string, uri string) (*Database, error)

+ func (db *Database) FindDeviceID() (deviceID id.DeviceID)

+ func (db *Database) Init() error

+ type Message struct

+ Chat PortalKey

+ Content *waProto.Message

+ JID types.WhatsAppMessageID

+ MXID id.EventID

+ Sender types.WhatsAppID

+ Timestamp uint64

+ func (msg *Message) Delete()

+ func (msg *Message) Insert()

+ func (msg *Message) Scan(row Scannable) *Message

+ type MessageQuery struct

+ func (mq *MessageQuery) GetAll(chat PortalKey) (messages []*Message)

+ func (mq *MessageQuery) GetByJID(chat PortalKey, jid types.WhatsAppMessageID) *Message

+ func (mq *MessageQuery) GetByMXID(mxid id.EventID) *Message

+ func (mq *MessageQuery) GetLastInChat(chat PortalKey) *Message

+ func (mq *MessageQuery) New() *Message

+ type Portal struct

+ Avatar string

+ AvatarURL id.ContentURI

+ Encrypted bool

+ Key PortalKey

+ MXID id.RoomID

+ Name string

+ Topic string

+ func (portal *Portal) Delete()

+ func (portal *Portal) GetUserIDs() []id.UserID

+ func (portal *Portal) Insert()

+ func (portal *Portal) Scan(row Scannable) *Portal

+ func (portal *Portal) Update()

+ type PortalKey struct

+ JID types.WhatsAppID

+ Receiver types.WhatsAppID

+ func GroupPortalKey(jid types.WhatsAppID) PortalKey

+ func NewPortalKey(jid, receiver types.WhatsAppID) PortalKey

+ func (key PortalKey) String() string

+ type PortalKeyWithMeta struct

+ InCommunity bool

+ type PortalQuery struct

+ func (pq *PortalQuery) GetAll() []*Portal

+ func (pq *PortalQuery) GetAllByJID(jid types.WhatsAppID) []*Portal

+ func (pq *PortalQuery) GetByJID(key PortalKey) *Portal

+ func (pq *PortalQuery) GetByMXID(mxid id.RoomID) *Portal

+ func (pq *PortalQuery) New() *Portal

+ type Puppet struct

+ AccessToken string

+ Avatar string

+ AvatarURL id.ContentURI

+ CustomMXID id.UserID

+ Displayname string

+ JID types.WhatsAppID

+ NameQuality int8

+ NextBatch string

+ func (puppet *Puppet) Insert()

+ func (puppet *Puppet) Scan(row Scannable) *Puppet

+ func (puppet *Puppet) Update()

+ type PuppetQuery struct

+ func (pq *PuppetQuery) Get(jid types.WhatsAppID) *Puppet

+ func (pq *PuppetQuery) GetAll() (puppets []*Puppet)

+ func (pq *PuppetQuery) GetAllWithCustomMXID() (puppets []*Puppet)

+ func (pq *PuppetQuery) GetByCustomMXID(mxid id.UserID) *Puppet

+ func (pq *PuppetQuery) New() *Puppet

+ type SQLCryptoStore struct

+ Account *crypto.OlmAccount

+ DeviceID id.DeviceID

+ GhostIDFormat string

+ PickleKey []byte

+ SyncToken string

+ UserID id.UserID

+ func NewSQLCryptoStore(db *Database, deviceID id.DeviceID) *SQLCryptoStore

+ func (store *SQLCryptoStore) AddOutboundGroupSession(session *crypto.OutboundGroupSession) (err error)

+ func (store *SQLCryptoStore) AddSession(key id.SenderKey, session *crypto.OlmSession) error

+ func (store *SQLCryptoStore) FilterTrackedUsers(users []id.UserID) []id.UserID

+ func (store *SQLCryptoStore) Flush() error

+ func (store *SQLCryptoStore) GetAccount() (*crypto.OlmAccount, error)

+ func (store *SQLCryptoStore) GetDevice(userID id.UserID, deviceID id.DeviceID) (*crypto.DeviceIdentity, error)

+ func (store *SQLCryptoStore) GetDevices(userID id.UserID) (map[id.DeviceID]*crypto.DeviceIdentity, error)

+ func (store *SQLCryptoStore) GetGroupSession(roomID id.RoomID, senderKey id.SenderKey, sessionID id.SessionID) (*crypto.InboundGroupSession, error)

+ func (store *SQLCryptoStore) GetLatestSession(key id.SenderKey) (*crypto.OlmSession, error)

+ func (store *SQLCryptoStore) GetNextBatch() string

+ func (store *SQLCryptoStore) GetOutboundGroupSession(roomID id.RoomID) (*crypto.OutboundGroupSession, error)

+ func (store *SQLCryptoStore) GetRoomMembers(roomID id.RoomID) (members []id.UserID, err error)

+ func (store *SQLCryptoStore) GetSessions(key id.SenderKey) (crypto.OlmSessionList, error)

+ func (store *SQLCryptoStore) HasSession(key id.SenderKey) bool

+ func (store *SQLCryptoStore) PutAccount(account *crypto.OlmAccount) error

+ func (store *SQLCryptoStore) PutDevices(userID id.UserID, devices map[id.DeviceID]*crypto.DeviceIdentity) error

+ func (store *SQLCryptoStore) PutGroupSession(roomID id.RoomID, senderKey id.SenderKey, sessionID id.SessionID, ...) error

+ func (store *SQLCryptoStore) PutNextBatch(nextBatch string)

+ func (store *SQLCryptoStore) RemoveOutboundGroupSession(roomID id.RoomID) error

+ func (store *SQLCryptoStore) UpdateOutboundGroupSession(session *crypto.OutboundGroupSession) error

+ func (store *SQLCryptoStore) UpdateSession(key id.SenderKey, session *crypto.OlmSession) error

+ func (store *SQLCryptoStore) ValidateMessageIndex(senderKey id.SenderKey, sessionID id.SessionID, eventID id.EventID, index uint, ...) bool

+ type SQLStateStore struct

+ Typing map[id.RoomID]map[id.UserID]int64

+ func NewSQLStateStore(db *Database) *SQLStateStore

+ func (store *SQLStateStore) FindSharedRooms(userID id.UserID) (rooms []id.RoomID)

+ func (store *SQLStateStore) GetMember(roomID id.RoomID, userID id.UserID) *event.MemberEventContent

+ func (store *SQLStateStore) GetMembership(roomID id.RoomID, userID id.UserID) event.Membership

+ func (store *SQLStateStore) GetPowerLevel(roomID id.RoomID, userID id.UserID) int

+ func (store *SQLStateStore) GetPowerLevelRequirement(roomID id.RoomID, eventType event.Type) int

+ func (store *SQLStateStore) GetPowerLevels(roomID id.RoomID) (levels *event.PowerLevelsEventContent)

+ func (store *SQLStateStore) GetRoomMembers(roomID id.RoomID) map[id.UserID]*event.MemberEventContent

+ func (store *SQLStateStore) HasPowerLevel(roomID id.RoomID, userID id.UserID, eventType event.Type) bool

+ func (store *SQLStateStore) IsInRoom(roomID id.RoomID, userID id.UserID) bool

+ func (store *SQLStateStore) IsInvited(roomID id.RoomID, userID id.UserID) bool

+ func (store *SQLStateStore) IsMembership(roomID id.RoomID, userID id.UserID, allowedMemberships ...event.Membership) bool

+ func (store *SQLStateStore) IsRegistered(userID id.UserID) bool

+ func (store *SQLStateStore) MarkRegistered(userID id.UserID)

+ func (store *SQLStateStore) SetMember(roomID id.RoomID, userID id.UserID, member *event.MemberEventContent)

+ func (store *SQLStateStore) SetMembership(roomID id.RoomID, userID id.UserID, membership event.Membership)

+ func (store *SQLStateStore) SetPowerLevels(roomID id.RoomID, levels *event.PowerLevelsEventContent)

+ func (store *SQLStateStore) TryGetMember(roomID id.RoomID, userID id.UserID) (*event.MemberEventContent, bool)

+ type Scannable interface

+ Scan func(...interface{}) error

+ type User struct

+ JID types.WhatsAppID

+ LastConnection uint64

+ MXID id.UserID

+ ManagementRoom id.RoomID

+ Session *whatsapp.Session

+ func (user *User) GetInCommunityMap() map[PortalKey]bool

+ func (user *User) GetPortalKeys() []PortalKey

+ func (user *User) Insert()

+ func (user *User) IsInPortal(key PortalKey) bool

+ func (user *User) Scan(row Scannable) *User

+ func (user *User) SetPortalKeys(newKeys []PortalKeyWithMeta) error

+ func (user *User) Update()

+ func (user *User) UpdateLastConnection()

+ type UserQuery struct

+ func (uq *UserQuery) GetAll() (users []*User)

+ func (uq *UserQuery) GetByJID(userID types.WhatsAppID) *User

+ func (uq *UserQuery) GetByMXID(userID id.UserID) *User

+ func (uq *UserQuery) New() *User