fix: enforce sort_key is unique per user

Author: jmattheis

api/application.go

@@ -12,6 +12,7 @@ import (
 	"github.com/gotify/server/v2/auth"
 	"github.com/gotify/server/v2/model"
 	"github.com/h2non/filetype"
+	"gorm.io/gorm"
 )
 
 // The ApplicationDatabase interface for encapsulating database access.
@@ -102,7 +103,8 @@ func (a *ApplicationAPI) CreateApplication(ctx *gin.Context) {
 			Internal:        false,
 		}
 
-		if success := successOrAbort(ctx, 500, a.DB.CreateApplication(&app)); !success {
+		if err := a.DB.CreateApplication(&app); err != nil {
+			handleApplicationError(ctx, err)
 			return
 		}
 		ctx.JSON(200, withResolvedImage(&app))
@@ -262,7 +264,8 @@ func (a *ApplicationAPI) UpdateApplication(ctx *gin.Context) {
 					app.SortKey = applicationParams.SortKey
 				}
 
-				if success := successOrAbort(ctx, 500, a.DB.UpdateApplication(app)); !success {
+				if err := a.DB.UpdateApplication(app); err != nil {
+					handleApplicationError(ctx, err)
 					return
 				}
 				ctx.JSON(200, withResolvedImage(app))
@@ -477,3 +480,11 @@ func ValidApplicationImageExt(ext string) bool {
 		return false
 	}
 }
+
+func handleApplicationError(ctx *gin.Context, err error) {
+	if errors.Is(err, gorm.ErrDuplicatedKey) {
+		ctx.AbortWithError(400, errors.New("sort key is not unique"))
+	} else {
+		ctx.AbortWithError(500, err)
+	}
+}

api/application_test.go

@@ -647,6 +647,21 @@ func (s *ApplicationSuite) Test_UpdateApplication_WithoutPermission_expectNotFou
 	assert.Equal(s.T(), 404, s.recorder.Code)
 }
 
+func (s *ApplicationSuite) Test_UpdateApplication_duplicateSortKey() {
+	user := s.db.User(5)
+	user.App(1) // sortKey=a0
+	user.App(2) // sortKey=a1
+
+	s.withFormData("name=new_name&sortKey=a0")
+	test.WithUser(s.ctx, 5)
+	s.ctx.Params = gin.Params{{Key: "id", Value: "2"}}
+
+	s.a.UpdateApplication(s.ctx)
+
+	assert.EqualError(s.T(), s.ctx.Errors[0].Err, "sort key is not unique")
+	assert.Equal(s.T(), 400, s.recorder.Code)
+}
+
 func (s *ApplicationSuite) withFormData(formData string) {
 	s.ctx.Request = httptest.NewRequest("POST", "/token", strings.NewReader(formData))
 	s.ctx.Request.Header.Set("Content-Type", "application/x-www-form-urlencoded")

database/database.go

@@ -36,6 +36,7 @@ func New(dialect, connection, defaultUser, defaultPass string, strength int, cre
 	gormConfig := &gorm.Config{
 		Logger:                                   dbLogger,
 		DisableForeignKeyConstraintWhenMigrating: true,
+		TranslateError:                           true,
 	}
 
 	var db *gorm.DB

model/application.go

@@ -20,7 +20,7 @@ type Application struct {
 	// required: true
 	// example: AWH0wZ5r0Mbac.r
 	Token  string `gorm:"type:varchar(180);uniqueIndex:uix_applications_token" json:"token"`
-	UserID uint   `gorm:"index" json:"-"`
+	UserID uint   `gorm:"index;uniqueIndex:idx_id_sortkey,priority:1" json:"-"`
 	// The application name. This is how the application should be displayed to the user.
 	//
 	// required: true
@@ -58,5 +58,5 @@ type Application struct {
 	//
 	// required: false
 	// example: a1
-	SortKey string `form:"sortKey" query:"sortKey" json:"sortKey"`
+	SortKey string `gorm:"uniqueIndex:idx_id_sortkey,priority:2" form:"sortKey" query:"sortKey" json:"sortKey"`
 }