重构:拆出 internal/config 与 internal/store 子包
把工程根目录中和"配置加载"、"数据存储"两个领域相关的全部 Go 文件迁到 internal/ 下的子包,按功能分组的第一阶段成果。 internal/config/ - 从 config.go 抽出 Config / MQTTConfig / WebConfig / DatabaseConfig 等 类型并大写导出,函数改名 Default/Load/Write/Validate/BuildTLS 等。 - 测试随被测代码迁移成 package config 的内部测试。 - 根目录留 config.go 作桥接:用 type alias 让旧的小写名(config / mqttConfig / databaseConfig 等)继续可用,避免修改 30+ 处调用方。 internal/store/ - 把 db.go、store_query.go、db_write_queue.go 与 13 个 *_store.go 一并 迁入;26 个 *Record 类型与 store 同包以避免循环依赖。 - store -> Store;50+ 标识符从小写未导出改为大写导出(包括 record、 ListOptions、错误变量、bot/llm/runtime 常量、helpers 等)。 - 新增 DB() / Driver() 访问器供 ai 子系统使用,避免直接访问私有字段。 - bot_pki_store.go 独立出来,把 PKI 解密所需的 store 方法集中归类。 - helpers.go 提供 hashPassword / uint32FromRecord / printJSON 等以前在 其他根目录文件中的辅助;test_helpers_test.go 提供 verifyPassword 与 publicMapTileSourceDTO 让测试可以本地运行而不依赖 main 包。 根目录新增: - store_bridge.go:完整 type-alias / 函数包装层,把 internal/store 的 导出名映射回旧的小写名,让 admin_*_routes.go、web.go、bot_service.go 等仍未迁出的文件继续编译。后续步骤把它们迁到各自领域包后可逐步删除。 - test_helpers_test.go:根目录测试沿用 openTestStore 的入口。 go build ./... 与 go test ./... 全部通过;测试数量与重构前一致。 Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
@@ -0,0 +1,373 @@
|
||||
package store
|
||||
|
||||
import (
|
||||
"crypto/ecdh"
|
||||
"crypto/rand"
|
||||
"encoding/base64"
|
||||
"encoding/binary"
|
||||
"errors"
|
||||
"fmt"
|
||||
"strings"
|
||||
"time"
|
||||
"unicode/utf8"
|
||||
|
||||
"meshtastic_mqtt_server/mqtpp"
|
||||
|
||||
"gorm.io/gorm"
|
||||
)
|
||||
|
||||
const (
|
||||
BotDefaultTopicPrefix = "msh/CN"
|
||||
BotDefaultPSK = "AQ=="
|
||||
BotDefaultNodeInfoBroadcastSeconds = int64(3600)
|
||||
BotMessageTypeChannel = "channel"
|
||||
BotMessageTypeDirect = "direct"
|
||||
BotMessageStatusPending = "pending"
|
||||
BotMessageStatusPublished = "published"
|
||||
BotMessageStatusFailed = "failed"
|
||||
)
|
||||
|
||||
var ErrBotNodeAlreadyExists = errors.New("bot node already exists")
|
||||
|
||||
type BotNodeInput struct {
|
||||
NodeNum *int64
|
||||
LongName string
|
||||
ShortName string
|
||||
Enabled bool
|
||||
DefaultChannelID string
|
||||
TopicPrefix string
|
||||
PSK string
|
||||
NodeInfoBroadcastEnabled bool
|
||||
NodeInfoBroadcastIntervalSeconds int64
|
||||
LLMQueueEnabled bool
|
||||
LLMIncludeChannelMessages bool
|
||||
}
|
||||
|
||||
type BotMessageListOptions struct {
|
||||
ListOptions
|
||||
BotID uint64
|
||||
MessageType string
|
||||
ChannelID string
|
||||
}
|
||||
|
||||
func (s *Store) ListBotNodes(opts ListOptions) ([]BotNodeRecord, error) {
|
||||
opts = NormalizeListOptions(opts)
|
||||
var rows []BotNodeRecord
|
||||
q := s.db.Model(&BotNodeRecord{}).
|
||||
Order("updated_at DESC").
|
||||
Order("id DESC").
|
||||
Limit(opts.Limit).
|
||||
Offset(opts.Offset)
|
||||
return rows, q.Find(&rows).Error
|
||||
}
|
||||
|
||||
func (s *Store) CountBotNodes(opts ListOptions) (int64, error) {
|
||||
var total int64
|
||||
return total, s.db.Model(&BotNodeRecord{}).Count(&total).Error
|
||||
}
|
||||
|
||||
func (s *Store) GetBotNode(id uint64) (*BotNodeRecord, error) {
|
||||
var row BotNodeRecord
|
||||
if err := s.db.Where("id = ?", id).Take(&row).Error; err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return &row, nil
|
||||
}
|
||||
|
||||
func (s *Store) CreateBotNode(input BotNodeInput) (*BotNodeRecord, error) {
|
||||
row, err := s.normalizedBotNodeRecord(input)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
if err := s.ensureBotNodeUnique(0, row.NodeID, row.NodeNum); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
if err := s.ensureBotNodeDoesNotConflictWithNodeInfo(row.NodeNum, row.NodeID); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
if err := populateBotNodeKeys(row); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
if err := s.db.Create(row).Error; err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return row, nil
|
||||
}
|
||||
|
||||
func (s *Store) UpdateBotNode(id uint64, input BotNodeInput) (*BotNodeRecord, error) {
|
||||
if id == 0 {
|
||||
return nil, fmt.Errorf("bot node id is required")
|
||||
}
|
||||
existing, err := s.GetBotNode(id)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
row, err := s.normalizedBotNodeRecord(input)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
if err := s.ensureBotNodeUnique(id, row.NodeID, row.NodeNum); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
// 只有当 node_num 真的发生变化时,才需要校验和 nodeinfo 表的冲突。
|
||||
// 否则机器人自己广播 NodeInfo 回写到 nodeinfo 表后,UpdateBotNode 会把这条
|
||||
// 自己的记录当成外部节点冲突,导致 “already exists or conflicts” 报错。
|
||||
if row.NodeNum != existing.NodeNum {
|
||||
if err := s.ensureBotNodeDoesNotConflictWithNodeInfo(row.NodeNum, row.NodeID); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
}
|
||||
updates := map[string]any{
|
||||
"node_id": row.NodeID,
|
||||
"node_num": row.NodeNum,
|
||||
"long_name": row.LongName,
|
||||
"short_name": row.ShortName,
|
||||
"enabled": row.Enabled,
|
||||
"default_channel_id": row.DefaultChannelID,
|
||||
"topic_prefix": row.TopicPrefix,
|
||||
"psk": row.PSK,
|
||||
"nodeinfo_broadcast_enabled": row.NodeInfoBroadcastEnabled,
|
||||
"nodeinfo_broadcast_interval_seconds": row.NodeInfoBroadcastIntervalSeconds,
|
||||
"llm_queue_enabled": row.LLMQueueEnabled,
|
||||
"llm_include_channel_messages": row.LLMIncludeChannelMessages,
|
||||
"updated_at": time.Now(),
|
||||
}
|
||||
if err := s.db.Model(&BotNodeRecord{}).Where("id = ?", id).Updates(updates).Error; err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return s.GetBotNode(id)
|
||||
}
|
||||
|
||||
func (s *Store) DeleteBotNode(id uint64) error {
|
||||
result := s.db.Where("id = ?", id).Delete(&BotNodeRecord{})
|
||||
if result.Error != nil {
|
||||
return result.Error
|
||||
}
|
||||
if result.RowsAffected == 0 {
|
||||
return gorm.ErrRecordNotFound
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func (s *Store) InsertBotMessage(row *BotMessageRecord) error {
|
||||
return s.db.Create(row).Error
|
||||
}
|
||||
|
||||
func (s *Store) UpdateBotMessageStatus(id uint64, status, errText string, publishedAt *time.Time) error {
|
||||
updates := map[string]any{"status": status, "error": strings.TrimSpace(errText), "published_at": publishedAt}
|
||||
result := s.db.Model(&BotMessageRecord{}).Where("id = ?", id).Updates(updates)
|
||||
if result.Error != nil {
|
||||
return result.Error
|
||||
}
|
||||
if result.RowsAffected == 0 {
|
||||
return gorm.ErrRecordNotFound
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func (s *Store) UpdateBotNodeInfoBroadcastAt(id uint64, t time.Time) error {
|
||||
result := s.db.Model(&BotNodeRecord{}).Where("id = ?", id).Updates(map[string]any{"last_nodeinfo_broadcast_at": &t, "updated_at": time.Now()})
|
||||
if result.Error != nil {
|
||||
return result.Error
|
||||
}
|
||||
if result.RowsAffected == 0 {
|
||||
return gorm.ErrRecordNotFound
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func (s *Store) RegenerateBotNodeKeys(id uint64) (*BotNodeRecord, error) {
|
||||
if id == 0 {
|
||||
return nil, fmt.Errorf("bot node id is required")
|
||||
}
|
||||
row, err := s.GetBotNode(id)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
if err := populateBotNodeKeys(row); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
updates := map[string]any{"public_key": row.PublicKey, "private_key": row.PrivateKey, "updated_at": time.Now()}
|
||||
if err := s.db.Model(&BotNodeRecord{}).Where("id = ?", id).Updates(updates).Error; err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return s.GetBotNode(id)
|
||||
}
|
||||
|
||||
func (s *Store) ListBotMessages(opts BotMessageListOptions) ([]BotMessageRecord, error) {
|
||||
opts.ListOptions = NormalizeListOptions(opts.ListOptions)
|
||||
var rows []BotMessageRecord
|
||||
q := applyBotMessageFilters(s.db.Model(&BotMessageRecord{}), opts).
|
||||
Order("created_at DESC").
|
||||
Order("id DESC").
|
||||
Limit(opts.Limit).
|
||||
Offset(opts.Offset)
|
||||
return rows, q.Find(&rows).Error
|
||||
}
|
||||
|
||||
func (s *Store) CountBotMessages(opts BotMessageListOptions) (int64, error) {
|
||||
var total int64
|
||||
q := applyBotMessageFilters(s.db.Model(&BotMessageRecord{}), opts)
|
||||
return total, q.Count(&total).Error
|
||||
}
|
||||
|
||||
func applyBotMessageFilters(q *gorm.DB, opts BotMessageListOptions) *gorm.DB {
|
||||
if opts.BotID != 0 {
|
||||
q = q.Where("bot_id = ?", opts.BotID)
|
||||
}
|
||||
if opts.MessageType != "" {
|
||||
q = q.Where("message_type = ?", opts.MessageType)
|
||||
}
|
||||
if opts.ChannelID != "" {
|
||||
q = q.Where("channel_id = ?", opts.ChannelID)
|
||||
}
|
||||
if opts.Since != nil {
|
||||
q = q.Where("created_at >= ?", *opts.Since)
|
||||
}
|
||||
if opts.Until != nil {
|
||||
q = q.Where("created_at <= ?", *opts.Until)
|
||||
}
|
||||
return q
|
||||
}
|
||||
|
||||
func (s *Store) normalizedBotNodeRecord(input BotNodeInput) (*BotNodeRecord, error) {
|
||||
longName := strings.TrimSpace(input.LongName)
|
||||
shortName := strings.TrimSpace(input.ShortName)
|
||||
channelID := strings.TrimSpace(input.DefaultChannelID)
|
||||
psk := strings.TrimSpace(input.PSK)
|
||||
if psk == "" {
|
||||
psk = BotDefaultPSK
|
||||
}
|
||||
if _, err := mqtpp.ExpandPSK(psk); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
topicPrefix := strings.Trim(strings.TrimSpace(input.TopicPrefix), "/")
|
||||
if topicPrefix == "" {
|
||||
topicPrefix = BotDefaultTopicPrefix
|
||||
}
|
||||
if longName == "" {
|
||||
return nil, fmt.Errorf("long name is required")
|
||||
}
|
||||
if !utf8.ValidString(longName) {
|
||||
return nil, fmt.Errorf("long name must be valid utf-8")
|
||||
}
|
||||
if shortName == "" {
|
||||
return nil, fmt.Errorf("short name is required")
|
||||
}
|
||||
if !utf8.ValidString(shortName) {
|
||||
return nil, fmt.Errorf("short name must be valid utf-8")
|
||||
}
|
||||
if channelID == "" {
|
||||
return nil, fmt.Errorf("default channel id is required")
|
||||
}
|
||||
interval := input.NodeInfoBroadcastIntervalSeconds
|
||||
if interval <= 0 {
|
||||
interval = BotDefaultNodeInfoBroadcastSeconds
|
||||
}
|
||||
if interval < 60 {
|
||||
return nil, fmt.Errorf("nodeinfo broadcast interval must be at least 60 seconds")
|
||||
}
|
||||
var nodeNum int64
|
||||
if input.NodeNum == nil || *input.NodeNum == 0 {
|
||||
generated, err := s.generateBotNodeNum()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
nodeNum = generated
|
||||
} else {
|
||||
nodeNum = *input.NodeNum
|
||||
}
|
||||
if err := ValidateBotNodeNum(nodeNum); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return &BotNodeRecord{NodeID: mqtpp.NodeNumToID(uint32(nodeNum)), NodeNum: nodeNum, LongName: longName, ShortName: shortName, Enabled: input.Enabled, DefaultChannelID: channelID, TopicPrefix: topicPrefix, PSK: psk, NodeInfoBroadcastEnabled: input.NodeInfoBroadcastEnabled, NodeInfoBroadcastIntervalSeconds: interval, LLMQueueEnabled: input.LLMQueueEnabled, LLMIncludeChannelMessages: input.LLMIncludeChannelMessages}, nil
|
||||
}
|
||||
|
||||
func populateBotNodeKeys(row *BotNodeRecord) error {
|
||||
privateKey, err := ecdh.X25519().GenerateKey(rand.Reader)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
row.PrivateKey = base64.StdEncoding.EncodeToString(privateKey.Bytes())
|
||||
row.PublicKey = base64.StdEncoding.EncodeToString(privateKey.PublicKey().Bytes())
|
||||
return nil
|
||||
}
|
||||
|
||||
func DecodeBotPublicKey(row BotNodeRecord) ([]byte, error) {
|
||||
if strings.TrimSpace(row.PublicKey) == "" {
|
||||
return nil, nil
|
||||
}
|
||||
key, err := base64.StdEncoding.DecodeString(row.PublicKey)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("invalid bot public key: %w", err)
|
||||
}
|
||||
return key, nil
|
||||
}
|
||||
|
||||
func ValidateBotNodeNum(nodeNum int64) error {
|
||||
if nodeNum <= 0 || nodeNum >= int64(mqtpp.NodeNumBroadcast) {
|
||||
return fmt.Errorf("node num must be between 1 and 4294967294")
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func (s *Store) generateBotNodeNum() (int64, error) {
|
||||
for i := 0; i < 32; i++ {
|
||||
var buf [4]byte
|
||||
if _, err := rand.Read(buf[:]); err != nil {
|
||||
return 0, err
|
||||
}
|
||||
nodeNum := int64(binary.LittleEndian.Uint32(buf[:]) & 0x7fffffff)
|
||||
if err := ValidateBotNodeNum(nodeNum); err != nil {
|
||||
continue
|
||||
}
|
||||
if err := s.ensureBotNodeUnique(0, mqtpp.NodeNumToID(uint32(nodeNum)), nodeNum); err != nil {
|
||||
if errors.Is(err, ErrBotNodeAlreadyExists) {
|
||||
continue
|
||||
}
|
||||
return 0, err
|
||||
}
|
||||
if err := s.ensureBotNodeDoesNotConflictWithNodeInfo(nodeNum, mqtpp.NodeNumToID(uint32(nodeNum))); err != nil {
|
||||
if errors.Is(err, ErrBotNodeAlreadyExists) {
|
||||
continue
|
||||
}
|
||||
return 0, err
|
||||
}
|
||||
return nodeNum, nil
|
||||
}
|
||||
return 0, fmt.Errorf("generate bot node num failed")
|
||||
}
|
||||
|
||||
func (s *Store) ensureBotNodeUnique(id uint64, nodeID string, nodeNum int64) error {
|
||||
var existing BotNodeRecord
|
||||
q := s.db.Where("node_id = ? OR node_num = ?", nodeID, nodeNum)
|
||||
if id != 0 {
|
||||
q = q.Where("id <> ?", id)
|
||||
}
|
||||
err := q.Take(&existing).Error
|
||||
if err == nil {
|
||||
return ErrBotNodeAlreadyExists
|
||||
}
|
||||
if errors.Is(err, gorm.ErrRecordNotFound) {
|
||||
return nil
|
||||
}
|
||||
return err
|
||||
}
|
||||
|
||||
func (s *Store) ensureBotNodeDoesNotConflictWithNodeInfo(nodeNum int64, selfNodeID string) error {
|
||||
var existing NodeInfoRecord
|
||||
q := s.db.Where("node_num = ?", nodeNum)
|
||||
if selfNodeID != "" {
|
||||
// 机器人自己广播 NodeInfo 后会以同样的 node_id/node_num 回写 nodeinfo;
|
||||
// 把这条自身记录从冲突检测中排除,避免把自己当成外部节点。
|
||||
q = q.Where("node_id <> ?", selfNodeID)
|
||||
}
|
||||
err := q.Take(&existing).Error
|
||||
if err == nil {
|
||||
return ErrBotNodeAlreadyExists
|
||||
}
|
||||
if errors.Is(err, gorm.ErrRecordNotFound) {
|
||||
return nil
|
||||
}
|
||||
return err
|
||||
}
|
||||
Reference in New Issue
Block a user