Add user settings key/value DB table

models/error.go

@@ -325,6 +325,36 @@ func (err ErrReachLimitOfRepo) Error() string {
 	return fmt.Sprintf("user has reached maximum limit of repositories [limit: %d]", err.Limit)
 }
 
+// ErrUserSettingExists represents a "setting already exists for user" error.
+type ErrUserSettingExists struct {
+	Setting *UserSetting
+}
+
+// IsErrUserSettingExists checks if an error is a ErrUserSettingExists.
+func IsErrUserSettingExists(err error) bool {
+	_, ok := err.(ErrUserSettingExists)
+	return ok
+}
+
+func (err ErrUserSettingExists) Error() string {
+	return fmt.Sprintf("setting already exists for user [uid: %d, key: %s]", err.Setting.UserID, err.Setting.Key)
+}
+
+// ErrUserSettingNotExists represents a "setting already exists for user" error.
+type ErrUserSettingNotExists struct {
+	Setting *UserSetting
+}
+
+// IsErrUserSettingNotExists checks if an error is a ErrUserSettingNotExists.
+func IsErrUserSettingNotExists(err error) bool {
+	_, ok := err.(ErrUserSettingNotExists)
+	return ok
+}
+
+func (err ErrUserSettingNotExists) Error() string {
+	return fmt.Sprintf("setting already exists for user [uid: %d, key: %s]", err.Setting.UserID, err.Setting.Key)
+}
+
 //  __      __.__ __   .__
 // /  \    /  \__|  | _|__|
 // \   \/\/   /  |  |/ /  |

models/migrations/migrations.go

@@ -338,6 +338,8 @@ var migrations = []Migration{
 	NewMigration("Alter issue/comment table TEXT fields to LONGTEXT", alterIssueAndCommentTextFieldsToLongText),
 	// v192 -> v193
 	NewMigration("RecreateIssueResourceIndexTable to have a primary key instead of an unique index", recreateIssueResourceIndexTable),
+	// v193 -> v194
+	NewMigration("Create key/value table for user settings", createUserSettingsTable),
 }
 
 // GetCurrentDBVersion returns the current db version

models/migrations/v193.go

@@ -0,0 +1,25 @@
+// Copyright 2021 The Gitea Authors. All rights reserved.
+// Use of this source code is governed by a MIT-style
+// license that can be found in the LICENSE file.
+
+package migrations
+
+import (
+	"fmt"
+
+	"xorm.io/xorm"
+)
+
+func createUserSettingsTable(x *xorm.Engine) error {
+	type UserSetting struct {
+		ID     int64  `xorm:"pk autoincr"`
+		UserID int64  `xorm:"index"`              // to load all of someone's settings
+		Key    string `xorm:"varchar(255) index"` // ensure key is always lowercase
+		Value  string `xorm:"text"`
+	}
+	if err := x.Sync2(new(UserSetting)); err != nil {
+		return fmt.Errorf("sync2: %v", err)
+	}
+	return nil
+
+}

models/models.go

@@ -139,6 +139,7 @@ func init() {
 		new(PushMirror),
 		new(RepoArchiver),
 		new(ProtectedTag),
+		new(UserSetting),
 	)
 
 	gonicNames := []string{"SSL", "UID"}

models/user.go

@@ -1201,6 +1201,7 @@ func deleteUser(e Engine, u *User) error {
 		&TeamUser{UID: u.ID},
 		&Collaboration{UserID: u.ID},
 		&Stopwatch{UserID: u.ID},
+		&UserSetting{UserID: u.ID},
 	); err != nil {
 		return fmt.Errorf("deleteBeans: %v", err)
 	}

models/user_setting.go

@@ -0,0 +1,105 @@
+// Copyright 2020 The Gitea Authors. All rights reserved.
+// Use of this source code is governed by a MIT-style
+// license that can be found in the LICENSE file.
+
+package models
+
+import (
+	"strings"
+
+	"xorm.io/builder"
+)
+
+// UserSetting is a key value store of user settings
+type UserSetting struct {
+	ID     int64  `xorm:"pk autoincr"`
+	UserID int64  `xorm:"index"`              // to load all of someone's settings
+	Key    string `xorm:"varchar(255) index"` // ensure key is always lowercase
+	Value  string `xorm:"text"`
+}
+
+// BeforeInsert will be invoked by XORM before inserting a record
+func (setting *UserSetting) BeforeInsert() {
+	setting.Key = strings.ToLower(setting.Key)
+}
+
+// GetUserSetting returns specific settings from user
+func GetUserSetting(uid int64, keys []string) ([]*UserSetting, error) {
+	settings := make([]*UserSetting, 0, 5)
+	if err := x.
+		Where("user_id=?", uid).
+		And(builder.In("key", keys)).
+		Asc("id").
+		Find(&settings); err != nil {
+		return nil, err
+	}
+	return settings, nil
+}
+
+// GetUserAllSettings returns all settings from user
+func GetUserAllSettings(uid int64) ([]*UserSetting, error) {
+	settings := make([]*UserSetting, 0, 5)
+	if err := x.
+		Where("user_id=?", uid).
+		Asc("id").
+		Find(&settings); err != nil {
+		return nil, err
+	}
+	return settings, nil
+}
+
+// AddUserSetting adds a specific setting for a user
+func AddUserSetting(setting *UserSetting) error {
+	return addUserSetting(x, setting)
+}
+
+func addUserSetting(e Engine, setting *UserSetting) error {
+	used, err := settingExists(e, setting.UserID, setting.Key)
+	if err != nil {
+		return err
+	} else if used {
+		return ErrUserSettingExists{setting}
+	}
+	_, err = e.Insert(setting)
+	return err
+}
+
+func settingExists(e Engine, uid int64, key string) (bool, error) {
+	if len(key) == 0 {
+		return true, nil
+	}
+
+	return e.Where("key=?", strings.ToLower(key)).And("user_id = ?", uid).Get(&UserSetting{})
+}
+
+// DeleteUserSetting deletes a specific setting for a user
+func DeleteUserSetting(setting *UserSetting) error {
+	sess := x.NewSession()
+	defer sess.Close()
+	if err := sess.Begin(); err != nil {
+		return err
+	}
+
+	if _, err := sess.Delete(setting); err != nil {
+		return err
+	}
+
+	return sess.Commit()
+}
+
+// UpdateUserSettingValue updates a users' setting for a specific key
+func UpdateUserSettingValue(setting *UserSetting) error {
+	return updateUserSettingValue(x, setting)
+}
+
+func updateUserSettingValue(e Engine, setting *UserSetting) error {
+	used, err := settingExists(e, setting.UserID, setting.Key)
+	if err != nil {
+		return err
+	} else if !used {
+		return ErrUserSettingNotExists{setting}
+	}
+
+	_, err = e.ID(setting.ID).Cols("value").Update(setting)
+	return err
+}

models/user_setting_test.go

@@ -0,0 +1,42 @@
+// Copyright 2021 The Gitea Authors. All rights reserved.
+// Use of this source code is governed by a MIT-style
+// license that can be found in the LICENSE file.
+
+package models
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestUserSettings(t *testing.T) {
+	assert.NoError(t, PrepareTestDatabase())
+
+	newSetting := &UserSetting{UserID: 99, Key: "test_user_setting", Value: "Gitea User Setting Test"}
+
+	// create setting
+	err := AddUserSetting(newSetting)
+	assert.NoError(t, err)
+
+	// get specific setting
+	userSettings, err := GetUserSetting(99, []string{"test_user_setting"})
+	assert.NoError(t, err)
+	assert.Len(t, userSettings, 1)
+	assert.EqualValues(t, newSetting.Value, userSettings[0].Value)
+
+	// updated setting
+	updatedSetting := &UserSetting{UserID: 99, Key: "test_user_setting", Value: "Updated", ID: userSettings[0].ID}
+	err = UpdateUserSettingValue(updatedSetting)
+	assert.NoError(t, err)
+
+	// get all settings
+	userSettings, err = GetUserAllSettings(99)
+	assert.NoError(t, err)
+	assert.Len(t, userSettings, 1)
+	assert.EqualValues(t, userSettings[0].Value, updatedSetting.Value)
+
+	// delete setting
+	err = DeleteUserSetting(updatedSetting)
+	assert.NoError(t, err)
+}