feat: migrate gin to echo (#1854)

IceWhaleTech · Jun 4, 2024 · 8f7c997 · 8f7c997
1 parent 0883f5f
commit 8f7c997
Show file tree

Hide file tree

Showing 18 changed files with 478 additions and 548 deletions.
diff --git a/go.mod b/go.mod
@@ -11,8 +11,6 @@ require (
 	github.com/disintegration/imaging v1.6.2
 	github.com/dsoprea/go-exif/v3 v3.0.1
 	github.com/getkin/kin-openapi v0.117.0
-	github.com/gin-contrib/gzip v0.0.6
-	github.com/gin-gonic/gin v1.9.1
 	github.com/glebarez/sqlite v1.8.0
 	github.com/go-ini/ini v1.67.0
 	github.com/go-resty/resty/v2 v2.7.0
@@ -41,10 +39,10 @@ require (
 	github.com/tidwall/gjson v1.14.4
 	go.uber.org/goleak v1.2.1
 	go.uber.org/zap v1.24.0
-	golang.org/x/crypto v0.14.0
+	golang.org/x/crypto v0.22.0
 	golang.org/x/oauth2 v0.7.0
 	golang.org/x/sync v0.3.0
-	golang.org/x/sys v0.14.0
+	golang.org/x/sys v0.19.0
 	gorm.io/gorm v1.25.0
 	gotest.tools v2.2.0+incompatible
 )
@@ -64,6 +62,7 @@ require (
 	github.com/gabriel-vasile/mimetype v1.4.2 // indirect
 	github.com/geoffgarside/ber v1.1.0 // indirect
 	github.com/gin-contrib/sse v0.1.0 // indirect
+	github.com/gin-gonic/gin v1.9.1 // indirect
 	github.com/glebarez/go-sqlite v1.21.1 // indirect
 	github.com/go-errors/errors v1.4.2 // indirect
 	github.com/go-ole/go-ole v1.2.6 // indirect
@@ -91,7 +90,7 @@ require (
 	github.com/klauspost/cpuid/v2 v2.2.4 // indirect
 	github.com/klauspost/pgzip v1.2.5 // indirect
 	github.com/kr/pretty v0.3.1 // indirect
-	github.com/labstack/gommon v0.4.0 // indirect
+	github.com/labstack/gommon v0.4.2 // indirect
 	github.com/leodido/go-urn v1.2.4 // indirect
 	github.com/lufia/plan9stats v0.0.0-20230110061619-bbe2e5e100de // indirect
 	github.com/mailru/easyjson v0.7.7 // indirect
@@ -124,9 +123,9 @@ require (
 	golang.org/x/arch v0.3.0 // indirect
 	golang.org/x/exp v0.0.0-20230713183714-613f0c0eb8a1 // indirect
 	golang.org/x/image v0.6.0 // indirect
-	golang.org/x/net v0.17.0 // indirect
-	golang.org/x/text v0.13.0 // indirect
-	golang.org/x/time v0.3.0 // indirect
+	golang.org/x/net v0.24.0 // indirect
+	golang.org/x/text v0.14.0 // indirect
+	golang.org/x/time v0.5.0 // indirect
 	google.golang.org/appengine v1.6.7 // indirect
 	google.golang.org/protobuf v1.30.0 // indirect
 	gopkg.in/natefinch/lumberjack.v2 v2.2.1 // indirect

diff --git a/go.sum b/go.sum
diff --git a/pkg/utils/default_post_form.go b/pkg/utils/default_post_form.go
@@ -0,0 +1,11 @@
+package utils
+
+import "github.com/labstack/echo/v4"
+
+func DefaultPostForm(ctx echo.Context, key, defaultValue string) string {
+	value := ctx.Request().Form.Get(key)
+	if value == "" {
+		return defaultValue
+	}
+	return value
+}
diff --git a/pkg/utils/default_query.go b/pkg/utils/default_query.go
@@ -0,0 +1,11 @@
+package utils
+
+import "github.com/labstack/echo/v4"
+
+func DefaultQuery(ctx echo.Context, key string, defaultValue string) string {
+	if value := ctx.QueryParam(key); value != "" {
+		return value
+	}
+
+	return defaultValue
+}
diff --git a/route/v1.go b/route/v1.go
@@ -2,50 +2,68 @@ package route
 
 import (
 	"crypto/ecdsa"
-	"os"
+	"net/http"
+	"strconv"
 
 	"github.com/IceWhaleTech/CasaOS-Common/external"
-	"github.com/IceWhaleTech/CasaOS-Common/middleware"
 	"github.com/IceWhaleTech/CasaOS-Common/utils/jwt"
 	"github.com/IceWhaleTech/CasaOS/common"
 	"github.com/IceWhaleTech/CasaOS/pkg/config"
 	v1 "github.com/IceWhaleTech/CasaOS/route/v1"
-
-	"github.com/gin-contrib/gzip"
-	"github.com/gin-gonic/gin"
+	"github.com/labstack/echo/v4"
+	echo_middleware "github.com/labstack/echo/v4/middleware"
 )
 
-func InitV1Router() *gin.Engine {
-	ginMode := gin.ReleaseMode
-	if config.ServerInfo.RunMode != "" {
-		ginMode = config.ServerInfo.RunMode
-	}
-	if os.Getenv(gin.EnvGinMode) != "" {
-		ginMode = os.Getenv(gin.EnvGinMode)
-	}
-	gin.SetMode(ginMode)
-
-	r := gin.New()
-	r.Use(gin.Recovery())
-	r.Use(middleware.Cors())
-	r.Use(gzip.Gzip(gzip.DefaultCompression))
-	if ginMode != gin.ReleaseMode {
-		r.Use(middleware.WriteLog())
-	}
-
-	r.GET("/v1/sys/debug", v1.GetSystemConfigDebug) // //debug
-
-	r.GET("/v1/sys/version/check", v1.GetSystemCheckVersion)
-	r.GET("/v1/sys/version/current", func(ctx *gin.Context) {
-		ctx.String(200, common.VERSION)
+func InitV1Router() http.Handler {
+	e := echo.New()
+
+	e.Use((echo_middleware.CORSWithConfig(echo_middleware.CORSConfig{
+		AllowOrigins:     []string{"*"},
+		AllowMethods:     []string{echo.POST, echo.GET, echo.OPTIONS, echo.PUT, echo.DELETE},
+		AllowHeaders:     []string{echo.HeaderAuthorization, echo.HeaderContentLength, echo.HeaderXCSRFToken, echo.HeaderContentType, echo.HeaderAccessControlAllowOrigin, echo.HeaderAccessControlAllowHeaders, echo.HeaderAccessControlAllowMethods, echo.HeaderConnection, echo.HeaderOrigin, echo.HeaderXRequestedWith},
+		ExposeHeaders:    []string{echo.HeaderContentLength, echo.HeaderAccessControlAllowOrigin, echo.HeaderAccessControlAllowHeaders},
+		MaxAge:           172800,
+		AllowCredentials: true,
+	})))
+	e.Use(echo_middleware.Gzip())
+	e.Use(echo_middleware.Recover())
+	e.Use(echo_middleware.Logger())
+
+	e.GET("/v1/sys/debug", v1.GetSystemConfigDebug) // //debug
+
+	e.GET("/v1/sys/version/check", v1.GetSystemCheckVersion)
+	e.GET("/v1/sys/version/current", func(ctx echo.Context) error {
+		return ctx.String(200, common.VERSION)
 	})
-	r.GET("/ping", func(ctx *gin.Context) {
-		ctx.String(200, "pong")
+	e.GET("/ping", func(ctx echo.Context) error {
+		return ctx.String(200, "pong")
 	})
-	r.GET("/v1/recover/:type", v1.GetRecoverStorage)
-	v1Group := r.Group("/v1")
-	//	r.Any("/v1/test", v1.CheckNetwork)
-	v1Group.Use(jwt.ExceptLocalhost(func() (*ecdsa.PublicKey, error) { return external.GetPublicKey(config.CommonInfo.RuntimePath) }))
+	e.GET("/v1/recover/:type", v1.GetRecoverStorage)
+	v1Group := e.Group("/v1")
+	//	e.Any("/v1/test", v1.CheckNetwork)
+	v1Group.Use(echo_middleware.JWTWithConfig(echo_middleware.JWTConfig{
+		Skipper: func(c echo.Context) bool {
+			return c.RealIP() == "::1" || c.RealIP() == "127.0.0.1"
+		},
+		ParseTokenFunc: func(token string, c echo.Context) (interface{}, error) {
+			valid, claims, err := jwt.Validate(token, func() (*ecdsa.PublicKey, error) { return external.GetPublicKey(config.CommonInfo.RuntimePath) })
+			if err != nil || !valid {
+				return nil, echo.ErrUnauthorized
+			}
+
+			c.Request().Header.Set("user_id", strconv.Itoa(claims.ID))
+
+			return claims, nil
+		},
+		TokenLookupFuncs: []echo_middleware.ValuesExtractor{
+			func(ctx echo.Context) ([]string, error) {
+				if len(ctx.Request().Header.Get(echo.HeaderAuthorization)) > 0 {
+					return []string{ctx.Request().Header.Get(echo.HeaderAuthorization)}, nil
+				}
+				return []string{ctx.QueryParam("token")}, nil
+			},
+		},
+	}))
 	{
 
 		v1SysGroup := v1Group.Group("/sys")
@@ -98,7 +116,7 @@ func InitV1Router() *gin.Engine {
 			v1FileGroup.GET("/content", v1.GetFilerContent) // file/read
 
 			// File uploads need to be handled separately, and will not be modified here
-			//v1FileGroup.POST("/upload", v1.PostFileUpload)
+			// v1FileGroup.POST("/upload", v1.PostFileUpload)
 			v1FileGroup.POST("/upload", v1.PostFileUpload)
 			v1FileGroup.GET("/upload", v1.GetFileUpload)
 			// v1FileGroup.GET("/download", v1.UserFileDownloadCommonService)
@@ -171,7 +189,6 @@ func InitV1Router() *gin.Engine {
 		v1OtherGroup.Use()
 		{
 			v1OtherGroup.GET("/search", v1.GetSearchResult)
-
 		}
 		v1ZerotierGroup := v1Group.Group("/zt")
 		v1ZerotierGroup.Use()
@@ -180,5 +197,5 @@ func InitV1Router() *gin.Engine {
 		}
 	}
 
-	return r
+	return e
 }
diff --git a/route/v1/cloud.go b/route/v1/cloud.go
@@ -11,33 +11,31 @@ import (
 	"github.com/IceWhaleTech/CasaOS/pkg/utils/common_err"
 	"github.com/IceWhaleTech/CasaOS/pkg/utils/httper"
 	"github.com/IceWhaleTech/CasaOS/service"
-	"github.com/gin-gonic/gin"
+	"github.com/labstack/echo/v4"
 	"go.uber.org/zap"
 )
 
-func ListStorages(c *gin.Context) {
+func ListStorages(ctx echo.Context) error {
 	// var req model.PageReq
-	// if err := c.ShouldBind(&req); err != nil {
-	// 	c.JSON(common_err.SUCCESS, model.Result{Success: common_err.CLIENT_ERROR, Message: common_err.GetMsg(common_err.CLIENT_ERROR), Data: err.Error()})
+	// if err := ctx.Bind(&req); err != nil {
+	// 	return ctx.JSON(common_err.SUCCESS, model.Result{Success: common_err.CLIENT_ERROR, Message: common_err.GetMsg(common_err.CLIENT_ERROR), Data: err.Error()})
 	// 	return
 	// }
 	// req.Validate()
 
-	//logger.Info("ListStorages", zap.Any("req", req))
-	//storages, total, err := service.MyService.Storage().GetStorages(req.Page, req.PerPage)
+	// logger.Info("ListStorages", zap.Any("req", req))
+	// storages, total, err := service.MyService.Storage().GetStorages(req.Page, req.PerPage)
 	// if err != nil {
-	// 	c.JSON(common_err.SUCCESS, model.Result{Success: common_err.SERVICE_ERROR, Message: common_err.GetMsg(common_err.SERVICE_ERROR), Data: err.Error()})
+	// 	return ctx.JSON(common_err.SUCCESS, model.Result{Success: common_err.SERVICE_ERROR, Message: common_err.GetMsg(common_err.SERVICE_ERROR), Data: err.Error()})
 	// 	return
 	// }
-	// c.JSON(common_err.SUCCESS, model.Result{Success: common_err.SUCCESS, Message: common_err.GetMsg(common_err.SUCCESS), Data: model.PageResp{
+	// return ctx.JSON(common_err.SUCCESS, model.Result{Success: common_err.SUCCESS, Message: common_err.GetMsg(common_err.SUCCESS), Data: model.PageResp{
 	// 	Content: storages,
 	// 	Total:   total,
 	// }})
 	r, err := service.MyService.Storage().GetStorages()
-
 	if err != nil {
-		c.JSON(common_err.SUCCESS, model.Result{Success: common_err.SERVICE_ERROR, Message: common_err.GetMsg(common_err.SERVICE_ERROR), Data: err.Error()})
-		return
+		return ctx.JSON(common_err.SUCCESS, model.Result{Success: common_err.SERVICE_ERROR, Message: common_err.GetMsg(common_err.SERVICE_ERROR), Data: err.Error()})
 	}
 
 	for i := 0; i < len(r.MountPoints); i++ {
@@ -53,7 +51,6 @@ func ListStorages(c *gin.Context) {
 			r.MountPoints[i].Icon = dropbox.ICONURL
 		}
 		if dataMap["type"] == "onedrive" {
-
 			r.MountPoints[i].Icon = onedrive.ICONURL
 		}
 		r.MountPoints[i].Name = dataMap["username"]
@@ -69,38 +66,36 @@ func ListStorages(c *gin.Context) {
 		})
 	}
 
-	c.JSON(common_err.SUCCESS, model.Result{Success: common_err.SUCCESS, Message: common_err.GetMsg(common_err.SUCCESS), Data: list})
+	return ctx.JSON(common_err.SUCCESS, model.Result{Success: common_err.SUCCESS, Message: common_err.GetMsg(common_err.SUCCESS), Data: list})
 }
 
-func UmountStorage(c *gin.Context) {
+func UmountStorage(ctx echo.Context) error {
 	json := make(map[string]string)
-	c.ShouldBind(&json)
+	ctx.Bind(&json)
 	mountPoint := json["mount_point"]
 	if mountPoint == "" {
-		c.JSON(common_err.CLIENT_ERROR, model.Result{Success: common_err.CLIENT_ERROR, Message: common_err.GetMsg(common_err.CLIENT_ERROR), Data: "mount_point is empty"})
-		return
+		return ctx.JSON(common_err.CLIENT_ERROR, model.Result{Success: common_err.CLIENT_ERROR, Message: common_err.GetMsg(common_err.CLIENT_ERROR), Data: "mount_point is empty"})
 	}
 	err := service.MyService.Storage().UnmountStorage(mountPoint)
 	if err != nil {
-		c.JSON(common_err.SERVICE_ERROR, model.Result{Success: common_err.SERVICE_ERROR, Message: common_err.GetMsg(common_err.SERVICE_ERROR), Data: err.Error()})
-		return
+		return ctx.JSON(common_err.SERVICE_ERROR, model.Result{Success: common_err.SERVICE_ERROR, Message: common_err.GetMsg(common_err.SERVICE_ERROR), Data: err.Error()})
 	}
 	service.MyService.Storage().DeleteConfigByName(strings.ReplaceAll(mountPoint, "/mnt/", ""))
-	c.JSON(common_err.SUCCESS, model.Result{Success: common_err.SUCCESS, Message: common_err.GetMsg(common_err.SUCCESS), Data: "success"})
+	return ctx.JSON(common_err.SUCCESS, model.Result{Success: common_err.SUCCESS, Message: common_err.GetMsg(common_err.SUCCESS), Data: "success"})
 }
 
-func GetStorage(c *gin.Context) {
-
-	// idStr := c.Query("id")
+func GetStorage(ctx echo.Context) error {
+	// idStr := ctx.QueryParam("id")
 	// id, err := strconv.Atoi(idStr)
 	// if err != nil {
-	// 	c.JSON(common_err.SUCCESS, model.Result{Success: common_err.CLIENT_ERROR, Message: common_err.GetMsg(common_err.CLIENT_ERROR), Data: err.Error()})
+	// 	return ctx.JSON(common_err.SUCCESS, model.Result{Success: common_err.CLIENT_ERROR, Message: common_err.GetMsg(common_err.CLIENT_ERROR), Data: err.Error()})
 	// 	return
 	// }
 	// storage, err := service.MyService.Storage().GetStorageById(uint(id))
 	// if err != nil {
-	// 	c.JSON(common_err.SUCCESS, model.Result{Success: common_err.SERVICE_ERROR, Message: common_err.GetMsg(common_err.SERVICE_ERROR), Data: err.Error()})
+	// 	return ctx.JSON(common_err.SUCCESS, model.Result{Success: common_err.SERVICE_ERROR, Message: common_err.GetMsg(common_err.SERVICE_ERROR), Data: err.Error()})
 	// 	return
 	// }
-	// c.JSON(common_err.SUCCESS, model.Result{Success: common_err.SUCCESS, Message: common_err.GetMsg(common_err.SUCCESS), Data: storage})
+	// return ctx.JSON(common_err.SUCCESS, model.Result{Success: common_err.SUCCESS, Message: common_err.GetMsg(common_err.SUCCESS), Data: storage})
+	return nil
 }
diff --git a/route/v1/driver.go b/route/v1/driver.go
@@ -6,10 +6,10 @@ import (
 	"github.com/IceWhaleTech/CasaOS/drivers/google_drive"
 	"github.com/IceWhaleTech/CasaOS/drivers/onedrive"
 	"github.com/IceWhaleTech/CasaOS/model"
-	"github.com/gin-gonic/gin"
+	"github.com/labstack/echo/v4"
 )
 
-func ListDriverInfo(c *gin.Context) {
+func ListDriverInfo(ctx echo.Context) error {
 	list := []model.Drive{}
 
 	google := google_drive.GetConfig()
@@ -30,5 +30,5 @@ func ListDriverInfo(c *gin.Context) {
 		Icon:    od.Icon,
 		AuthUrl: od.AuthUrl,
 	})
-	c.JSON(common_err.SUCCESS, model.Result{Success: common_err.SUCCESS, Message: common_err.GetMsg(common_err.SUCCESS), Data: list})
+	return ctx.JSON(common_err.SUCCESS, model.Result{Success: common_err.SUCCESS, Message: common_err.GetMsg(common_err.SUCCESS), Data: list})
 }