wip: 引入事件驱动

Author: Akizon77

cmd/root.go

@@ -4,7 +4,9 @@ import (
 	"fmt"
 	"os"
 
+	"github.com/gookit/event"
 	"github.com/komari-monitor/komari/cmd/flags"
+	"github.com/komari-monitor/komari/internal/eventType"
 
 	"github.com/spf13/cobra"
 )
@@ -40,6 +42,8 @@ Made by Akizon77 with love.`,
 }
 
 func Execute() {
+	event.Trigger(eventType.ProcessStart, nil)
+	defer event.Trigger(eventType.ProcessExit, nil)
 	if err := RootCmd.Execute(); err != nil {
 		fmt.Fprintln(os.Stderr, err)
 		os.Exit(1)

cmd/server.go

@@ -12,6 +12,7 @@ import (
 	"time"
 
 	"github.com/gin-gonic/gin"
+	"github.com/gookit/event"
 	"github.com/komari-monitor/komari/cmd/flags"
 	api "github.com/komari-monitor/komari/internal/api_v1"
 	"github.com/komari-monitor/komari/internal/database"
@@ -23,6 +24,7 @@ import (
 	d_notification "github.com/komari-monitor/komari/internal/database/notification"
 	"github.com/komari-monitor/komari/internal/database/records"
 	"github.com/komari-monitor/komari/internal/database/tasks"
+	"github.com/komari-monitor/komari/internal/eventType"
 	"github.com/komari-monitor/komari/internal/geoip"
 	logutil "github.com/komari-monitor/komari/internal/log"
 	"github.com/komari-monitor/komari/internal/messageSender"
@@ -57,25 +59,35 @@ func RunServer() {
 		log.Fatalf("Failed to create theme directory: %v", err)
 	}
 	InitDatabase()
+
 	if version.VersionHash != "unknown" {
 		gin.SetMode(gin.ReleaseMode)
 	}
+
 	conf, err := config.Get()
 	if err != nil {
 		log.Fatal(err)
 	}
+
+	r := gin.New()
+	r.Use(logutil.GinLogger())
+	r.Use(logutil.GinRecovery())
+
+	event.Trigger(eventType.ServerInitializeStart, event.M{"config": conf, "engine": r})
+	defer event.Trigger(eventType.ServerInitializeDone, event.M{"config": conf})
+
 	go geoip.InitGeoIp()
 	go DoScheduledWork()
 	go messageSender.Initialize()
 	go oauth.Initialize()
 
-	if conf.NezhaCompatEnabled {
-		server.StartNezhaGRPCServer(conf.NezhaCompatListen)
-	}
+	server.StartNezhaGRPCServer(conf.NezhaCompatListen)
 
-	config.Subscribe(func(event config.ConfigEvent) {
-		if event.New.OAuthProvider != event.Old.OAuthProvider {
-			oidcProvider, err := database.GetOidcConfigByName(event.New.OAuthProvider)
+	event.On(eventType.ConfigUpdated, event.ListenerFunc(func(e event.Event) error {
+		newConf := e.Get("new").(models.Config)
+		oldConf := e.Get("old").(models.Config)
+		if newConf.OAuthProvider != oldConf.OAuthProvider {
+			oidcProvider, err := database.GetOidcConfigByName(newConf.OAuthProvider)
 			if err != nil {
 				log.Printf("Failed to get OIDC provider config: %v", err)
 			} else {
@@ -86,10 +98,11 @@ func RunServer() {
 				auditlog.EventLog("error", fmt.Sprintf("Failed to load OIDC provider: %v", err))
 			}
 		}
-		if event.New.NotificationMethod != event.Old.NotificationMethod {
+		if newConf.NotificationMethod != oldConf.NotificationMethod {
 			messageSender.Initialize()
 		}
-	})
+		return nil
+	}), event.Max)
 
 	// 初始化 cloudflared
 	if strings.ToLower(GetEnv("KOMARI_ENABLE_CLOUDFLARED", "false")) == "true" {
@@ -99,9 +112,6 @@ func RunServer() {
 		}
 	}
 
-	r := gin.New()
-	r.Use(logutil.GinLogger())
-	r.Use(logutil.GinRecovery())
 	server.Init(r)
 
 	srv := &http.Server{

go.mod

@@ -48,6 +48,8 @@ require (
 	github.com/go-sql-driver/mysql v1.9.2 // indirect
 	github.com/goccy/go-json v0.10.5 // indirect
 	github.com/google/pprof v0.0.0-20240727154555-813a5fbdbec8 // indirect
+	github.com/gookit/event v1.2.0 // indirect
+	github.com/gookit/goutil v0.7.1 // indirect
 	github.com/inconshreveable/mousetrap v1.1.0 // indirect
 	github.com/jinzhu/inflection v1.0.0 // indirect
 	github.com/jinzhu/now v1.1.5 // indirect

go.sum

@@ -63,6 +63,10 @@ github.com/google/pprof v0.0.0-20240727154555-813a5fbdbec8 h1:FKHo8hFI3A+7w0aUQu
 github.com/google/pprof v0.0.0-20240727154555-813a5fbdbec8/go.mod h1:K1liHPHnj73Fdn/EKuT8nrFqBihUSKXoLYU0BuatOYo=
 github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
 github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
+github.com/gookit/event v1.2.0 h1:aa8ouNVlo4E/NRhHVXNU/JbWvlr91Gjh423WtCDYQ4Q=
+github.com/gookit/event v1.2.0/go.mod h1:gGYybJL0HEEo/+UmBN+MgLqUBIxcCGOP8FrLPk+J8w4=
+github.com/gookit/goutil v0.7.1 h1:AaFJPN9mrdeYBv8HOybri26EHGCC34WJVT7jUStGJsI=
+github.com/gookit/goutil v0.7.1/go.mod h1:vJS9HXctYTCLtCsZot5L5xF+O1oR17cDYO9R0HxBmnU=
 github.com/gorilla/websocket v1.5.3 h1:saDtZ6Pbx/0u+bgYQ3q96pZgCzfhKXGPqt7kZ72aNNg=
 github.com/gorilla/websocket v1.5.3/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE=
 github.com/inconshreveable/mousetrap v1.1.0 h1:wN+x4NVGpMsO7ErUn/mUI3vEoE6Jt13X2s0bqwp9tc8=

internal/database/config/config.go

@@ -6,8 +6,10 @@ import (
 	"sync"
 	"time"
 
+	"github.com/gookit/event"
 	"github.com/komari-monitor/komari/internal/database/dbcore"
 	"github.com/komari-monitor/komari/internal/database/models"
+	"github.com/komari-monitor/komari/internal/eventType"
 	"gorm.io/gorm"
 )
 
@@ -61,6 +63,7 @@ func Save(cst models.Config) error {
 	}
 	newConfig, _ := Get()
 	publishEvent(oldConfig, newConfig)
+	event.Trigger(eventType.ConfigUpdated, event.M{"old": oldConfig, "new": newConfig})
 	return nil
 }
 
@@ -103,6 +106,7 @@ func Update(cst map[string]interface{}) error {
 		if err := tx.Where("id = ?", oldConfig.ID).First(newConfig).Error; err != nil {
 			return errors.Join(err, errors.New("failed to retrieve updated configuration"))
 		}
+		event.Trigger(eventType.ConfigUpdated, event.M{"old": oldConfig, "new": *newConfig})
 		publishEvent(oldConfig, *newConfig)
 		return nil
 	})

internal/eventType/events.go

@@ -0,0 +1,55 @@
+package eventType
+
+const (
+	ClientWebsocketConnected    = "client.websocket.connected"    // 客户端通过 websocket 连接
+	ClientWebsocketDisconnected = "client.websocket.disconnected" // 客户端断开 websocket 连接
+	ClientMessageReceived       = "client.message.received"       // 收到客户端消息
+	ClientCreated               = "client.created"                // 新客户端创建
+	ClientUpdated               = "client.updated"                // 客户端信息更新
+	ClientDeleted               = "client.deleted"                // 客户端删除
+	ClientRenewed               = "client.renewed"                // 客户端续期
+
+	UserUpdateUsername = "user.update.username" // 用户更改用户名
+	UserUpdatePassword = "user.update.password" // 用户更改密码
+	UserLogin          = "user.login.succeeded" // 用户登录
+	UserLogout         = "user.logout"          // 用户登出
+	UserOidcBound      = "user.oidc.bound"      // 用户绑定 OIDC
+	UserOidcUnbound    = "user.oidc.unbound"    // 用户解绑 OIDC
+	UserTwoFaAdded     = "user.2fa.added"       // 用户添加 2FA
+	UserTwoFaRemoved   = "user.2fa.removed"     // 用户移除 2FA
+	UserSessionRevoked = "user.session.revoked" // 用户会话撤销
+
+	LoginFailed = "user.login.failed" // 用户登录失败
+
+	ConfigUpdated = "config.updated" // 配置更改
+
+	ProcessStart = "process.start" // 进程启动
+	ProcessExit  = "process.exit"  // 进程停止
+
+	ServerInitializeStart = "server.routers.start"     // 服务器路由初始化开始
+	ServerInitializeDone  = "server.routers.done"      // 服务器路由初始化完成
+	ServerListenGrpcStart = "server.listen.grpc.start" // 服务器开始监听 gRPC
+	ServerListenGrpcStop  = "server.listen.grpc.stop"  // 服务器停止监听 gRPC
+
+	TaskCreated = "task.created" // 任务创建
+	TaskUpdated = "task.updated" // 任务更新
+
+	HttpRequestReceived = "http.request.received" // 收到 HTTP 请求
+
+	SchedulerDatabase       = "scheduler.database"       // 数据库定时任务
+	SchedulerEveryMinute    = "scheduler.everyminute"    // 每分钟定时触发
+	SchedulerEvery5Minutes  = "scheduler.every5minutes"  // 每五分钟定时触发
+	SchedulerEvery30Minutes = "scheduler.every30minutes" // 每三十分钟定时触发
+	SchedulerEveryHour      = "scheduler.everyhour"      // 每小时定时触发
+	SchedulerEveryDay       = "scheduler.everyday"       // 每天定时触发
+
+	NotificationSent   = "notification.sent"   // 通知发送
+	NotificationFailed = "notification.failed" // 通知发送失败
+
+	TerminalEstablished = "terminal.established" // 终端连接建立
+	TerminalClosed      = "terminal.closed"      // 终端连接关闭
+
+	GeoIpUpdateStart  = "geoip.update.start"  // GeoIP 数据库更新开始
+	GeoIpUpdateDone   = "geoip.update.done"   // GeoIP 数据库更新完成
+	GeoIpUpdateFailed = "geoip.update.failed" // GeoIP 数据库更新失败
+)

internal/internal.go

@@ -0,0 +1,186 @@
+package internal
+
+import (
+	"github.com/gin-gonic/gin"
+	api "github.com/komari-monitor/komari/internal/api_v1"
+	"github.com/komari-monitor/komari/internal/api_v1/admin"
+	"github.com/komari-monitor/komari/internal/api_v1/admin/clipboard"
+	log_api "github.com/komari-monitor/komari/internal/api_v1/admin/log"
+	"github.com/komari-monitor/komari/internal/api_v1/admin/notification"
+	"github.com/komari-monitor/komari/internal/api_v1/admin/test"
+	"github.com/komari-monitor/komari/internal/api_v1/admin/update"
+	"github.com/komari-monitor/komari/internal/api_v1/client"
+	"github.com/komari-monitor/komari/internal/api_v1/jsonRpc"
+	"github.com/komari-monitor/komari/internal/api_v1/record"
+	"github.com/komari-monitor/komari/internal/api_v1/task"
+	"github.com/komari-monitor/komari/internal/database/models"
+)
+
+func LoadApiV1Routes(r *gin.Engine, conf models.Config) {
+	r.Use(func(c *gin.Context) {
+		if len(c.Request.URL.Path) >= 4 && c.Request.URL.Path[:4] == "/api" {
+			c.Header("Cache-Control", "no-store")
+		}
+		c.Next()
+	})
+
+	r.Use(api.PrivateSiteMiddleware())
+
+	r.Any("/ping", func(c *gin.Context) {
+		c.String(200, "pong")
+	})
+	// #region 公开路由
+	r.POST("/api/login", api.Login)
+	r.GET("/api/me", api.GetMe)
+	r.GET("/api/clients", api.GetClients)
+	r.GET("/api/nodes", api.GetNodesInformation)
+	r.GET("/api/public", api.GetPublicSettings)
+	r.GET("/api/oauth", api.OAuth)
+	r.GET("/api/oauth_callback", api.OAuthCallback)
+	r.GET("/api/logout", api.Logout)
+	r.GET("/api/version", api.GetVersion)
+	r.GET("/api/recent/:uuid", api.GetClientRecentRecords)
+
+	r.GET("/api/records/load", record.GetRecordsByUUID)
+	r.GET("/api/records/ping", record.GetPingRecords)
+	r.GET("/api/task/ping", task.GetPublicPingTasks)
+	r.GET("/api/rpc2", jsonRpc.OnRpcRequest)
+	r.POST("/api/rpc2", jsonRpc.OnRpcRequest)
+
+	// #region Agent
+	r.POST("/api/clients/register", client.RegisterClient)
+	tokenAuthrized := r.Group("/api/clients", api.TokenAuthMiddleware())
+	{
+		tokenAuthrized.GET("/report", client.WebSocketReport) // websocket
+		tokenAuthrized.POST("/uploadBasicInfo", client.UploadBasicInfo)
+		tokenAuthrized.POST("/report", client.UploadReport)
+		tokenAuthrized.GET("/terminal", client.EstablishConnection)
+		tokenAuthrized.POST("/task/result", client.TaskResult)
+	}
+	// #region 管理员
+	adminAuthrized := r.Group("/api/admin", api.AdminAuthMiddleware())
+	{
+		adminAuthrized.GET("/download/backup", admin.DownloadBackup)
+		adminAuthrized.POST("/upload/backup", admin.UploadBackup)
+		// test
+		testGroup := adminAuthrized.Group("/test")
+		{
+			testGroup.GET("/geoip", test.TestGeoIp)
+			testGroup.POST("/sendMessage", test.TestSendMessage)
+		}
+		// update
+		updateGroup := adminAuthrized.Group("/update")
+		{
+			updateGroup.POST("/mmdb", update.UpdateMmdbGeoIP)
+			updateGroup.POST("/user", update.UpdateUser)
+			updateGroup.PUT("/favicon", update.UploadFavicon)
+			updateGroup.POST("/favicon", update.DeleteFavicon)
+		}
+		// tasks
+		taskGroup := adminAuthrized.Group("/task")
+		{
+			taskGroup.GET("/all", admin.GetTasks)
+			taskGroup.POST("/exec", admin.Exec)
+			taskGroup.GET("/:task_id", admin.GetTaskById)
+			taskGroup.GET("/:task_id/result", admin.GetTaskResultsByTaskId)
+			taskGroup.GET("/:task_id/result/:uuid", admin.GetSpecificTaskResult)
+			taskGroup.GET("/client/:uuid", admin.GetTasksByClientId)
+		}
+		// settings
+		settingsGroup := adminAuthrized.Group("/settings")
+		{
+			settingsGroup.GET("/", admin.GetSettings)
+			settingsGroup.POST("/", admin.EditSettings)
+			settingsGroup.POST("/oidc", admin.SetOidcProvider)
+			settingsGroup.GET("/oidc", admin.GetOidcProvider)
+			settingsGroup.POST("/message-sender", admin.SetMessageSenderProvider)
+			settingsGroup.GET("/message-sender", admin.GetMessageSenderProvider)
+		}
+		// themes
+		themeGroup := adminAuthrized.Group("/theme")
+		{
+			themeGroup.PUT("/upload", admin.UploadTheme)
+			themeGroup.GET("/list", admin.ListThemes)
+			themeGroup.POST("/delete", admin.DeleteTheme)
+			themeGroup.GET("/set", admin.SetTheme)
+			themeGroup.POST("/update", admin.UpdateTheme)
+			themeGroup.POST("/settings", admin.UpdateThemeSettings)
+		}
+		// clients
+		clientGroup := adminAuthrized.Group("/client")
+		{
+			clientGroup.POST("/add", admin.AddClient)
+			clientGroup.GET("/list", admin.ListClients)
+			clientGroup.GET("/:uuid", admin.GetClient)
+			clientGroup.POST("/:uuid/edit", admin.EditClient)
+			clientGroup.POST("/:uuid/remove", admin.RemoveClient)
+			clientGroup.GET("/:uuid/token", admin.GetClientToken)
+			clientGroup.POST("/order", admin.OrderWeight)
+			// client terminal
+			clientGroup.GET("/:uuid/terminal", api.RequestTerminal)
+		}
+
+		// records
+		recordGroup := adminAuthrized.Group("/record")
+		{
+			recordGroup.POST("/clear", admin.ClearRecord)
+			recordGroup.POST("/clear/all", admin.ClearAllRecords)
+		}
+		// oauth2
+		oauth2Group := adminAuthrized.Group("/oauth2")
+		{
+			oauth2Group.GET("/bind", admin.BindingExternalAccount)
+			oauth2Group.POST("/unbind", admin.UnbindExternalAccount)
+		}
+		sessionGroup := adminAuthrized.Group("/session")
+		{
+			sessionGroup.GET("/get", admin.GetSessions)
+			sessionGroup.POST("/remove", admin.DeleteSession)
+			sessionGroup.POST("/remove/all", admin.DeleteAllSession)
+		}
+		two_factorGroup := adminAuthrized.Group("/2fa")
+		{
+			two_factorGroup.GET("/generate", admin.Generate2FA)
+			two_factorGroup.POST("/enable", admin.Enable2FA)
+			two_factorGroup.POST("/disable", admin.Disable2FA)
+		}
+		adminAuthrized.GET("/logs", log_api.GetLogs)
+
+		// clipboard
+		clipboardGroup := adminAuthrized.Group("/clipboard")
+		{
+			clipboardGroup.GET("/:id", clipboard.GetClipboard)
+			clipboardGroup.GET("", clipboard.ListClipboard)
+			clipboardGroup.POST("", clipboard.CreateClipboard)
+			clipboardGroup.POST("/:id", clipboard.UpdateClipboard)
+			clipboardGroup.POST("/remove", clipboard.BatchDeleteClipboard)
+			clipboardGroup.POST("/:id/remove", clipboard.DeleteClipboard)
+		}
+
+		notificationGroup := adminAuthrized.Group("/notification")
+		{
+			// offline notifications
+			notificationGroup.GET("/offline", notification.ListOfflineNotifications)
+			notificationGroup.POST("/offline/edit", notification.EditOfflineNotification)
+			notificationGroup.POST("/offline/enable", notification.EnableOfflineNotification)
+			notificationGroup.POST("/offline/disable", notification.DisableOfflineNotification)
+			loadAlertGroup := notificationGroup.Group("/load")
+			{
+				loadAlertGroup.GET("/", notification.GetAllLoadNotifications)
+				loadAlertGroup.POST("/add", notification.AddLoadNotification)
+				loadAlertGroup.POST("/delete", notification.DeleteLoadNotification)
+				loadAlertGroup.POST("/edit", notification.EditLoadNotification)
+			}
+		}
+
+		pingTaskGroup := adminAuthrized.Group("/ping")
+		{
+			pingTaskGroup.GET("/", admin.GetAllPingTasks)
+			pingTaskGroup.POST("/add", admin.AddPingTask)
+			pingTaskGroup.POST("/delete", admin.DeletePingTask)
+			pingTaskGroup.POST("/edit", admin.EditPingTask)
+
+		}
+
+	}
+}