diff --git a/database/accounts/sessions.go b/database/accounts/sessions.go index 16eef1c..7d52f7e 100644 --- a/database/accounts/sessions.go +++ b/database/accounts/sessions.go @@ -48,7 +48,7 @@ func CreateSession(uuid string, expires int, userAgent, ip, login_method string) if ipinfo != nil && ipinfo.Name != "" { loc = ipinfo.Name } - messageSender.SendEvent(models.EventMessage{ + _ = messageSender.SendNotification(models.EventMessage{ Event: messageevent.Login, Time: time.Now().UTC(), Message: fmt.Sprintf("%s: %s (%s)\n%s", login_method, ip, loc, userAgent), diff --git a/database/models/messageSender.go b/database/models/messageSender.go index 94f9ee9..2121c13 100644 --- a/database/models/messageSender.go +++ b/database/models/messageSender.go @@ -8,9 +8,9 @@ type MessageSenderProvider struct { } type EventMessage struct { - Event string `json:"event"` + Event any `json:"event"` Clients []Client `json:"clients"` Time time.Time `json:"time"` - Message string `json:"message"` - Emoji string `json:"emoji"` + Message any `json:"message"` + Emoji any `json:"emoji"` } diff --git a/utils/messageSender/javascript/javascript.go b/utils/messageSender/javascript/javascript.go index d0ce03f..cb96d71 100644 --- a/utils/messageSender/javascript/javascript.go +++ b/utils/messageSender/javascript/javascript.go @@ -84,7 +84,7 @@ func (j *JavaScriptSender) ensureRuntime() error { // fallbackToTextMessage formats structured events for scripts that only // implement sendMessage. func (j *JavaScriptSender) fallbackToTextMessage(event models.EventMessage) error { - message := fmt.Sprintf("%s%s%s\nEvent: %s\nMessage: %s\nTime: %s", + message := fmt.Sprintf("%v%v%v\nEvent: %v\nMessage: %v\nTime: %s", event.Emoji, event.Emoji, event.Emoji, event.Event, event.Message, @@ -98,14 +98,14 @@ func (j *JavaScriptSender) fallbackToTextMessage(event models.EventMessage) erro } clientNames = append(clientNames, name) } - message = fmt.Sprintf("%s%s%s\nEvent: %s\nClients: %s\nMessage: %s\nTime: %s", + message = fmt.Sprintf("%v%v%v\nEvent: %v\nClients: %s\nMessage: %v\nTime: %s", event.Emoji, event.Emoji, event.Emoji, event.Event, clientNames, event.Message, event.Time.UTC().Format(time.RFC3339Nano)) } - return j.SendTextMessage(message, event.Event) + return j.SendTextMessage(message, fmt.Sprint(event.Event)) } func init() { diff --git a/utils/messageSender/loader_test.go b/utils/messageSender/loader_test.go index d78dc01..14d72ba 100644 --- a/utils/messageSender/loader_test.go +++ b/utils/messageSender/loader_test.go @@ -21,6 +21,21 @@ func TestParseTemplateFormatsEventTimeInLocalTimezone(t *testing.T) { } } +func TestParseTemplateFormatsAnyTypedEventField(t *testing.T) { + for _, tc := range []struct { + event any + want string + }{ + {event: models.EventMessage{Event: "Offline"}, want: "Offline"}, + {event: models.EventMessage{Event: 42}, want: "42"}, + {event: models.EventMessage{Event: nil}, want: ""}, + } { + if got := parseTemplate("{{event}}", tc.event); got != tc.want { + t.Fatalf("parseTemplate with Event=%v = %q, want %q", tc.event, got, tc.want) + } + } +} + func Test(t *testing.T) { senders := factory.GetAllMessageSenders() if len(senders) == 0 { diff --git a/utils/messageSender/sender.go b/utils/messageSender/sender.go index 8fadb24..b053117 100644 --- a/utils/messageSender/sender.go +++ b/utils/messageSender/sender.go @@ -4,12 +4,14 @@ import ( "encoding/json" "fmt" logger "github.com/komari-monitor/komari/utils/log" + "reflect" "strings" "sync" "time" "github.com/komari-monitor/komari/database" "github.com/komari-monitor/komari/database/auditlog" + "github.com/komari-monitor/komari/database/clients" "github.com/komari-monitor/komari/database/models" "github.com/komari-monitor/komari/internal/config" "github.com/komari-monitor/komari/utils/messageSender/factory" @@ -103,6 +105,28 @@ func SendTextMessage(message string, title string) error { auditlog.Log("", "", "Failed to send message after 3 attempts: "+err.Error()+","+title, "error") return err } + +// SendNotification 是通知发送的统一实现:解析事件中的客户端 UUID(外部传入可只含 +// UUID 字段)后委托 SendEvent。内部调用与 admin:sendNotification RPC 共用此实现。 +func SendNotification(event models.EventMessage) error { + if len(event.Clients) > 0 { + eventClients := make([]models.Client, 0, len(event.Clients)) + for _, c := range event.Clients { + if c.UUID == "" { + continue + } + if full, err := clients.GetClientByUUID(c.UUID); err == nil { + eventClients = append(eventClients, full) + } + } + if len(eventClients) == 0 { + return fmt.Errorf("none of the specified clients exist") + } + event.Clients = eventClients + } + return SendEvent(event) +} + func SendEvent(event models.EventMessage) error { if CurrentProvider() == nil { return fmt.Errorf("message sender provider is not initialized") @@ -130,11 +154,11 @@ func SendEvent(event models.EventMessage) error { for i := 0; i < 3; i++ { err = eventSender.SendEvent(event) if err == nil || err.Error() == "short response: \x00\x00\x00\x1a\x00\x00\x00" { - auditlog.Log("", "", "Event message sent: "+event.Event, "info") + auditlog.Log("", "", "Event message sent: "+fmt.Sprint(event.Event), "info") return nil } } - auditlog.Log("", "", "Failed to send event message after 3 attempts: "+err.Error()+","+event.Event, "error") + auditlog.Log("", "", "Failed to send event message after 3 attempts: "+err.Error()+","+fmt.Sprint(event.Event), "error") return err } @@ -144,39 +168,72 @@ func SendEvent(event models.EventMessage) error { messageTemplate = parseTemplate(messageTemplate, event) for i := 0; i < 3; i++ { - err = CurrentProvider().SendTextMessage(messageTemplate, event.Event) + err = CurrentProvider().SendTextMessage(messageTemplate, fmt.Sprint(event.Event)) if err == nil || err.Error() == "short response: \x00\x00\x00\x1a\x00\x00\x00" { // QQ 会返回这个错误,但实际上消息是发送成功的 - auditlog.Log("", "", "Event message sent: "+event.Event, "info") + auditlog.Log("", "", "Event message sent: "+fmt.Sprint(event.Event), "info") return nil } } - auditlog.Log("", "", "Failed to send event message after 3 attempts: "+err.Error()+","+event.Event, "error") + auditlog.Log("", "", "Failed to send event message after 3 attempts: "+err.Error()+","+fmt.Sprint(event.Event), "error") return err } -func parseTemplate(messageTemplate string, event models.EventMessage) string { - // Aggregate client names. If Name is empty, fall back to UUID. - clientNames := make([]string, 0, len(event.Clients)) - for _, c := range event.Clients { - name := c.Name - if strings.TrimSpace(name) == "" { - // fallback to UUID when name is not set - name = c.UUID - } - clientNames = append(clientNames, name) +// parseTemplate 通过反射解析 event 持有的结构体的所有字段,将模板中的 {{fieldName}} +// 占位符替换为对应值(字段名小写,如 {{event}}、{{time}}、{{message}}、{{emoji}})。 +// 为兼容旧模板,Clients 字段同时支持 {{client}}(旧)与 {{clients}}(新)两种占位符。 +// event 为非结构体(如 map 等)时原样返回模板。 +func parseTemplate(messageTemplate string, event any) string { + eventValue := reflect.ValueOf(event) + if eventValue.Kind() == reflect.Pointer { + eventValue = eventValue.Elem() } - joinedClients := strings.Join(clientNames, ", ") - - replaceMap := map[string]string{ - "{{event}}": event.Event, - "{{client}}": joinedClients, - "{{time}}": event.Time.In(time.Local).Format(time.RFC3339Nano), - "{{message}}": event.Message, - "{{emoji}}": event.Emoji, + if eventValue.Kind() != reflect.Struct { + return messageTemplate } + eventType := eventValue.Type() result := messageTemplate - for placeholder, value := range replaceMap { + for i := 0; i < eventType.NumField(); i++ { + field := eventType.Field(i) + placeholder := "{{" + strings.ToLower(field.Name) + "}}" + value := formatTemplateField(field.Name, eventValue.Field(i)) result = strings.ReplaceAll(result, placeholder, value) + if field.Name == "Clients" { + result = strings.ReplaceAll(result, "{{client}}", value) + } } return result } + +// formatTemplateField 将事件字段格式化为模板占位符的值: +// 字符串字段直接取值;any 字段取其实际值格式化;Clients 字段拼接客户端名称 +// (无名称时回退为 UUID);Time 字段按服务器本地时区格式化为 RFC3339;其余类型返回空串。 +func formatTemplateField(fieldName string, v reflect.Value) string { + if v.Kind() == reflect.Interface { + if v.IsNil() { + return "" + } + return fmt.Sprint(v.Interface()) + } + switch v.Kind() { + case reflect.String: + return v.String() + case reflect.Slice: + if fieldName == "Clients" { + clientNames := make([]string, 0, v.Len()) + for i := 0; i < v.Len(); i++ { + clientValue := v.Index(i) + name := clientValue.FieldByName("Name").String() + if strings.TrimSpace(name) == "" { + name = clientValue.FieldByName("UUID").String() + } + clientNames = append(clientNames, name) + } + return strings.Join(clientNames, ", ") + } + case reflect.Struct: + if t, ok := v.Interface().(time.Time); ok { + return t.In(time.Local).Format(time.RFC3339Nano) + } + } + return "" +} diff --git a/utils/notifier/expire.go b/utils/notifier/expire.go index 03d692c..a35c96f 100644 --- a/utils/notifier/expire.go +++ b/utils/notifier/expire.go @@ -71,7 +71,7 @@ func CheckExpire() { for _, clientInfo := range clientLeadToExpire { message += fmt.Sprintf("• %s (%dd)\n", clientInfo.Name, clientInfo.DaysLeft) } - messageSender.SendEvent(models.EventMessage{ + _ = messageSender.SendNotification(models.EventMessage{ Event: messageevent.Expire, Time: time.Now().UTC(), Message: message, diff --git a/utils/notifier/load.go b/utils/notifier/load.go index 5cf34f3..0932bd7 100644 --- a/utils/notifier/load.go +++ b/utils/notifier/load.go @@ -200,24 +200,20 @@ func bytesPerSecondToMbps(bytesPerSecond int64) float32 { // sendLoadNotification 发送负载通知 func sendLoadNotification(clientUUIDs []string, task models.LoadNotification) { - ex_clients := []models.Client{} - for _, clientUUID := range clientUUIDs { - cl, err := clients.GetClientByUUID(clientUUID) - if err == nil { - ex_clients = append(ex_clients, cl) - } - } - if len(ex_clients) == 0 { - return + eventClients := make([]models.Client, 0, len(clientUUIDs)) + for _, uuid := range clientUUIDs { + eventClients = append(eventClients, models.Client{UUID: uuid}) } go func() { - messageSender.SendEvent(models.EventMessage{ + if err := messageSender.SendNotification(models.EventMessage{ Event: messageevent.Alert, - Clients: ex_clients, + Clients: eventClients, Time: time.Now().UTC(), Emoji: "⚠️", Message: task.Name, - }) + }); err != nil { + logger.Errorf("notifier", "Failed to send load notification for task %d: %v", task.Id, err) + } }() } diff --git a/utils/notifier/offline.go b/utils/notifier/offline.go index e7503e4..a735bd5 100644 --- a/utils/notifier/offline.go +++ b/utils/notifier/offline.go @@ -1,7 +1,6 @@ package notifier import ( - "fmt" logger "github.com/komari-monitor/komari/utils/log" "sync" "time" @@ -106,18 +105,16 @@ func OfflineNotification(clientID string, endedConnectionID int64) { state.isConnExist = false // Send notification - message := fmt.Sprintf("🔴%s is offline", client.Name) - go func(msg string) { - if err := messageSender.SendEvent(models.EventMessage{ + go func() { + if err := messageSender.SendNotification(models.EventMessage{ Event: messageevent.Offline, Clients: []models.Client{client}, Time: time.Now().UTC(), - //Message: msg, - Emoji: "🔴", + Emoji: "🔴", }); err != nil { logger.ErrorArgs("notifier", "Failed to send offline notification:", err) } - }(message) + }() // 更新数据库中的最后通知时间 db := dbcore.GetDBInstance() @@ -181,16 +178,14 @@ func OnlineNotification(clientID string, connectionID int64) { } // 规则4:客户端离线足够久已通知(或未待离线),现在重新上线,发送上线通知。 - message := fmt.Sprintf("🟢%s is online", client.Name) - go func(msg string) { - if err := messageSender.SendEvent(models.EventMessage{ + go func() { + if err := messageSender.SendNotification(models.EventMessage{ Event: messageevent.Online, Clients: []models.Client{client}, Time: time.Now().UTC(), - //Message: msg, - Emoji: "🟢", + Emoji: "🟢", }); err != nil { logger.ErrorArgs("notifier", "Failed to send online notification:", err) } - }(message) + }() } diff --git a/utils/notifier/traffic.go b/utils/notifier/traffic.go index 7695bff..e1fa55d 100644 --- a/utils/notifier/traffic.go +++ b/utils/notifier/traffic.go @@ -8,6 +8,7 @@ import ( "github.com/komari-monitor/komari/database/clients" "github.com/komari-monitor/komari/database/models" + messageevent "github.com/komari-monitor/komari/database/models/messageEvent" "github.com/komari-monitor/komari/internal/config" logger "github.com/komari-monitor/komari/utils/log" "github.com/komari-monitor/komari/utils/messageSender" @@ -95,8 +96,8 @@ func CheckTraffic() { msg := fmt.Sprintf("used %d%% (%s / %s), type=%s", curStep, humanBytes(used), humanBytes(c.TrafficLimit), strings.ToLower(c.TrafficLimitType)) // 发送通知(内部会检查 NotificationEnabled) - _ = messageSender.SendEvent(models.EventMessage{ - Event: "Traffic", + _ = messageSender.SendNotification(models.EventMessage{ + Event: messageevent.Traffic, Clients: []models.Client{c}, Time: time.Now().UTC(), Emoji: "⚠️", diff --git a/utils/notifier/traffic_report.go b/utils/notifier/traffic_report.go index 9b60869..4caedac 100644 --- a/utils/notifier/traffic_report.go +++ b/utils/notifier/traffic_report.go @@ -11,10 +11,10 @@ import ( "context" "github.com/komari-monitor/komari/database/dbcore" - "github.com/komari-monitor/komari/internal/metricstore" "github.com/komari-monitor/komari/database/models" messageevent "github.com/komari-monitor/komari/database/models/messageEvent" "github.com/komari-monitor/komari/internal/config" + "github.com/komari-monitor/komari/internal/metricstore" "github.com/komari-monitor/komari/internal/scheduler" "github.com/komari-monitor/komari/utils/messageSender" ) @@ -141,7 +141,7 @@ func sendTrafficReport(daily, weekly, monthly bool) { emoji = "📅" } - if err := messageSender.SendEvent(models.EventMessage{ + if err := messageSender.SendNotification(models.EventMessage{ Event: eventType, Clients: eventClients, Time: now, diff --git a/utils/renewal/renewal.go b/utils/renewal/renewal.go index e514d1a..f4b9c33 100644 --- a/utils/renewal/renewal.go +++ b/utils/renewal/renewal.go @@ -110,7 +110,7 @@ func CheckAndAutoRenewal(client models.Client) { auditlog.EventLog("renewal", fmt.Sprintf("Auto-renewed client: %s until %s", client.Name, timeutil.FormatSystemDate(newExpireTime))) - messageSender.SendEvent(models.EventMessage{ + _ = messageSender.SendNotification(models.EventMessage{ Event: messageevent.Renew, Clients: []models.Client{client}, Time: time.Now().UTC(), diff --git a/web/rpc/jsonrpc/admin.notification.go b/web/rpc/jsonrpc/admin.notification.go index 52b9e74..0b52b5a 100644 --- a/web/rpc/jsonrpc/admin.notification.go +++ b/web/rpc/jsonrpc/admin.notification.go @@ -2,11 +2,13 @@ package jsonrpc import ( "context" + "fmt" "github.com/komari-monitor/komari/database/dbcore" "github.com/komari-monitor/komari/database/models" "github.com/komari-monitor/komari/database/notification" "github.com/komari-monitor/komari/pkg/rpc" + "github.com/komari-monitor/komari/utils/messageSender" "gorm.io/gorm/clause" ) @@ -29,6 +31,26 @@ func init() { reg("editTrafficReportNotifications", adminEditTrafficReport, "Edit traffic report notifications") reg("enableTrafficReportNotifications", adminEnableTrafficReport, "Enable traffic report notifications") reg("disableTrafficReportNotifications", adminDisableTrafficReport, "Disable traffic report notifications") + // send notification + reg("sendNotification", adminSendNotification, "Send a notification") +} + +// adminSendNotification 发送一条通知。仅供外部(插件/脚本)通过 RPC 调用, +// 内部通知逻辑(notifier/renewal/session 等)直接调用 messageSender.SendNotification。 +func adminSendNotification(_ context.Context, req *rpc.JsonRpcRequest) (any, *rpc.JsonRpcError) { + var params struct { + Event models.EventMessage `json:"event"` + } + if err := req.BindParams(¶ms); err != nil { + return nil, rpc.MakeError(rpc.InvalidParams, "Invalid request data: "+err.Error(), nil) + } + if fmt.Sprint(params.Event.Event) == "" { + return nil, rpc.MakeError(rpc.InvalidParams, "event is required", nil) + } + if err := messageSender.SendNotification(params.Event); err != nil { + return nil, rpc.MakeError(rpc.InternalError, "Failed to send notification: "+err.Error(), nil) + } + return nil, nil } // reg 是 admin 命名空间方法的注册便捷封装。 diff --git a/web/rpc/jsonrpc/admin.system.go b/web/rpc/jsonrpc/admin.system.go index ded8e40..7d4bb76 100644 --- a/web/rpc/jsonrpc/admin.system.go +++ b/web/rpc/jsonrpc/admin.system.go @@ -166,12 +166,11 @@ func adminExec(ctx context.Context, req *rpc.JsonRpcRequest) (any, *rpc.JsonRpcE } func adminTestSendMessage(_ context.Context, _ *rpc.JsonRpcRequest) (any, *rpc.JsonRpcError) { - err := messageSender.SendEvent(models.EventMessage{ + if err := messageSender.SendNotification(models.EventMessage{ Event: "Test", Time: time.Now().UTC(), Message: "This is a test message from Komari.", - }) - if err != nil { + }); err != nil { return nil, rpc.MakeError(rpc.InternalError, "Failed to send message: "+err.Error(), nil) } return nil, nil