go-cqhttp/db/database.go

package db

import (
	"fmt"
	"hash/crc32"

	"github.com/Mrs4s/go-cqhttp/global"
)

type (
	// Database 数据库操作接口定义
	Database interface {
		// Open 初始化数据库
		Open() error

		// GetMessageByGlobalID 通过 GlobalID 来获取消息
		GetMessageByGlobalID(int32) (StoredMessage, error)
		// GetGroupMessageByGlobalID 通过 GlobalID 来获取群消息
		GetGroupMessageByGlobalID(int32) (*StoredGroupMessage, error)
		// GetPrivateMessageByGlobalID 通过 GlobalID 来获取私聊消息
		GetPrivateMessageByGlobalID(int32) (*StoredPrivateMessage, error)
		// GetGuildChannelMessageByID 通过 ID 来获取频道消息
		GetGuildChannelMessageByID(string) (*StoredGuildChannelMessage, error)

		// InsertGroupMessage 向数据库写入新的群消息
		InsertGroupMessage(*StoredGroupMessage) error
		// InsertPrivateMessage 向数据库写入新的私聊消息
		InsertPrivateMessage(*StoredPrivateMessage) error
		// InsertGuildChannelMessage 向数据库写入新的频道消息
		InsertGuildChannelMessage(*StoredGuildChannelMessage) error
	}

	StoredMessage interface {
		GetID() string
		GetType() string
		GetGlobalID() int32
		GetAttribute() *StoredMessageAttribute
		GetContent() []global.MSG
	}

	// StoredGroupMessage 持久化群消息
	StoredGroupMessage struct {
		ID          string                  `bson:"_id" yaml:"-"`
		GlobalID    int32                   `bson:"globalId" yaml:"-"`
		Attribute   *StoredMessageAttribute `bson:"attribute" yaml:"-"`
		SubType     string                  `bson:"subType" yaml:"-"`
		QuotedInfo  *QuotedInfo             `bson:"quotedInfo" yaml:"-"`
		GroupCode   int64                   `bson:"groupCode" yaml:"-"`
		AnonymousID string                  `bson:"anonymousId" yaml:"-"`
		Content     []global.MSG            `bson:"content" yaml:"content"`
	}

	// StoredPrivateMessage 持久化私聊消息
	StoredPrivateMessage struct {
		ID         string                  `bson:"_id" yaml:"-"`
		GlobalID   int32                   `bson:"globalId" yaml:"-"`
		Attribute  *StoredMessageAttribute `bson:"attribute" yaml:"-"`
		SubType    string                  `bson:"subType" yaml:"-"`
		QuotedInfo *QuotedInfo             `bson:"quotedInfo" yaml:"-"`
		SessionUin int64                   `bson:"sessionUin" yaml:"-"`
		TargetUin  int64                   `bson:"targetUin" yaml:"-"`
		Content    []global.MSG            `bson:"content" yaml:"content"`
	}

	// StoredGuildChannelMessage 持久化频道消息
	StoredGuildChannelMessage struct {
		ID         string                       `bson:"_id" yaml:"-"`
		Attribute  *StoredGuildMessageAttribute `bson:"attribute" yaml:"-"`
		GuildID    uint64                       `bson:"guildId" yaml:"-"`
		ChannelID  uint64                       `bson:"channelId" yaml:"-"`
		QuotedInfo *QuotedInfo                  `bson:"quotedInfo" yaml:"-"`
		Content    []global.MSG                 `bson:"content" yaml:"content"`
	}

	// StoredMessageAttribute 持久化消息属性
	StoredMessageAttribute struct {
		MessageSeq int32  `bson:"messageSeq" yaml:"-"`
		InternalID int32  `bson:"internalId" yaml:"-"`
		SenderUin  int64  `bson:"senderUin" yaml:"-"`
		SenderName string `bson:"senderName" yaml:"-"`
		Timestamp  int64  `bson:"timestamp" yaml:"-"`
	}

	// StoredGuildMessageAttribute 持久化频道消息属性
	StoredGuildMessageAttribute struct {
		MessageSeq   uint64 `bson:"messageSeq" yaml:"-"`
		InternalID   uint64 `bson:"internalId" yaml:"-"`
		SenderTinyID uint64 `bson:"senderTinyId" yaml:"-"`
		SenderName   string `bson:"senderName" yaml:"-"`
		Timestamp    int64  `bson:"timestamp" yaml:"-"`
	}

	// QuotedInfo 引用回复
	QuotedInfo struct {
		PrevID        string       `bson:"prevId" yaml:"-"`
		PrevGlobalID  int32        `bson:"prevGlobalId" yaml:"-"`
		QuotedContent []global.MSG `bson:"quotedContent" yaml:"quoted_content"`
	}
)

// ToGlobalID 构建`code`-`msgID`的字符串并返回其CRC32 Checksum的值
func ToGlobalID(code int64, msgID int32) int32 {
	return int32(crc32.ChecksumIEEE([]byte(fmt.Sprintf("%d-%d", code, msgID))))
}

func (m *StoredGroupMessage) GetID() string                         { return m.ID }
func (m *StoredGroupMessage) GetType() string                       { return "group" }
func (m *StoredGroupMessage) GetGlobalID() int32                    { return m.GlobalID }
func (m *StoredGroupMessage) GetAttribute() *StoredMessageAttribute { return m.Attribute }
func (m *StoredGroupMessage) GetContent() []global.MSG              { return m.Content }

func (m *StoredPrivateMessage) GetID() string                         { return m.ID }
func (m *StoredPrivateMessage) GetType() string                       { return "private" }
func (m *StoredPrivateMessage) GetGlobalID() int32                    { return m.GlobalID }
func (m *StoredPrivateMessage) GetAttribute() *StoredMessageAttribute { return m.Attribute }
func (m *StoredPrivateMessage) GetContent() []global.MSG              { return m.Content }