Merge branch 'main' into go-gitea#17676-init-content-history

Author: lunny

.air.toml

@@ -7,3 +7,4 @@ bin = "gitea"
 include_ext = ["go", "tmpl"]
 exclude_dir = ["modules/git/tests", "services/gitdiff/testdata", "modules/avatar/testdata"]
 include_dir = ["cmd", "models", "modules", "options", "routers", "services", "templates"]
+exclude_regex = ["_test.go$"]

.eslintrc

@@ -13,6 +13,7 @@ plugins:
   - eslint-plugin-import
   - eslint-plugin-vue
   - eslint-plugin-html
+  - eslint-plugin-github
 
 extends:
   - plugin:vue/recommended
@@ -96,6 +97,23 @@ rules:
   function-paren-newline: [0]
   generator-star-spacing: [0]
   getter-return: [2]
+  github/array-foreach: [2]
+  github/async-currenttarget: [2]
+  github/async-preventdefault: [2]
+  github/authenticity-token: [0]
+  github/get-attribute: [2]
+  github/js-class-name: [0]
+  github/no-blur: [0]
+  github/no-d-none: [0]
+  github/no-dataset: [2]
+  github/no-implicit-buggy-globals: [0]
+  github/no-inner-html: [0]
+  github/no-innerText: [2]
+  github/no-then: [2]
+  github/no-useless-passive: [2]
+  github/prefer-observers: [0]
+  github/require-passive-events: [2]
+  github/unescaped-html-literal: [0]
   grouped-accessor-pairs: [2]
   guard-for-in: [0]
   id-blacklist: [0]

Makefile

@@ -328,7 +328,7 @@ lint: lint-frontend lint-backend
 
 .PHONY: lint-frontend
 lint-frontend: node_modules
-	npx eslint --color --max-warnings=0 web_src/js build templates *.config.js
+	npx eslint --color --max-warnings=0 web_src/js build templates *.config.js docs/assets/js
 	npx stylelint --color --max-warnings=0 web_src/less
 	npx editorconfig-checker templates
 

build/generate-images.js

@@ -80,5 +80,5 @@ async function main() {
   ]);
 }
 
-main().then(exit).catch(exit);
+main().then(exit).catch(exit); // eslint-disable-line github/no-then
 

build/generate-svg.js

@@ -54,5 +54,5 @@ async function main() {
   ]);
 }
 
-main().then(exit).catch(exit);
+main().then(exit).catch(exit); // eslint-disable-line github/no-then
 

cmd/web_https.go

@@ -13,6 +13,7 @@ import (
 	"code.gitea.io/gitea/modules/graceful"
 	"code.gitea.io/gitea/modules/log"
 	"code.gitea.io/gitea/modules/setting"
+
 	"github.com/klauspost/cpuid/v2"
 )
 

docs/assets/js/search.js

@@ -15,7 +15,7 @@ const fuseOptions = {
   shouldSort: true,
   includeMatches: true,
   matchAllTokens: true,
-  threshold: 0.0, // for parsing diacritics
+  threshold: 0, // for parsing diacritics
   tokenize: true,
   location: 0,
   distance: 100,
@@ -52,25 +52,25 @@ function doSearch() {
     executeSearch(searchQuery);
   } else {
     const para = document.createElement('P');
-    para.innerText = 'Please enter a word or phrase above';
+    para.textContent = 'Please enter a word or phrase above';
     document.getElementById('search-results').appendChild(para);
   }
 }
 
 function getJSON(url, fn) {
   const request = new XMLHttpRequest();
   request.open('GET', url, true);
-  request.onload = function () {
+  request.addEventListener('load', () => {
     if (request.status >= 200 && request.status < 400) {
       const data = JSON.parse(request.responseText);
       fn(data);
     } else {
       console.error(`Target reached on ${url} with error ${request.status}`);
     }
-  };
-  request.onerror = function () {
+  });
+  request.addEventListener('error', () => {
     console.error(`Connection error ${request.status}`);
-  };
+  });
   request.send();
 }
 
@@ -84,20 +84,20 @@ function executeSearch(searchQuery) {
       populateResults(result);
     } else {
       const para = document.createElement('P');
-      para.innerText = 'No matches found';
+      para.textContent = 'No matches found';
       document.getElementById('search-results').appendChild(para);
     }
   });
 }
 
 function populateResults(result) {
-  result.forEach((value, key) => {
+  for (const [key, value] of result.entries()) {
     const content = value.item.contents;
     let snippet = '';
     const snippetHighlights = [];
     if (fuseOptions.tokenize) {
       snippetHighlights.push(searchQuery);
-      value.matches.forEach((mvalue) => {
+      for (const mvalue of value.matches) {
         if (mvalue.key === 'tags' || mvalue.key === 'categories') {
           snippetHighlights.push(mvalue.value);
         } else if (mvalue.key === 'contents') {
@@ -111,7 +111,7 @@ function populateResults(result) {
             snippetHighlights.push(mvalue.value.substring(mvalue.indices[0][0], mvalue.indices[0][1] - mvalue.indices[0][0] + 1));
           }
         }
-      });
+      }
     }
 
     if (snippet.length < 1) {
@@ -130,10 +130,10 @@ function populateResults(result) {
     });
     document.getElementById('search-results').appendChild(htmlToElement(output));
 
-    snippetHighlights.forEach((snipvalue) => {
+    for (const snipvalue of snippetHighlights) {
       new Mark(document.getElementById(`summary-${key}`)).mark(snipvalue);
-    });
-  });
+    }
+  }
 }
 
 function render(templateString, data) {

integrations/api_repo_test.go

@@ -334,7 +334,7 @@ func TestAPIRepoMigrate(t *testing.T) {
 			case "You can not import from disallowed hosts.":
 				assert.EqualValues(t, "private-ip", testCase.repoName)
 			default:
-				assert.Fail(t, "unexpected error '%v' on url '%s'", respJSON["message"], testCase.cloneURL)
+				assert.Failf(t, "unexpected error '%v' on url '%s'", respJSON["message"], testCase.cloneURL)
 			}
 		} else {
 			assert.EqualValues(t, testCase.expectedStatus, resp.Code)

models/migrations/migrations.go

@@ -357,6 +357,8 @@ var migrations = []Migration{
 	NewMigration("Add table app_state", addTableAppState),
 	// v201 -> v202
 	NewMigration("Drop table remote_version (if exists)", dropTableRemoteVersion),
+	// v202 -> v203
+	NewMigration("Create key/value table for user settings", createUserSettingsTable),
 }
 
 // GetCurrentDBVersion returns the current db version

models/migrations/v202.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 unique(key_userid)"`              // to load all of someone's settings
+		SettingKey   string `xorm:"varchar(255) index unique(key_userid)"` // ensure key is always lowercase
+		SettingValue string `xorm:"text"`
+	}
+	if err := x.Sync2(new(UserSetting)); err != nil {
+		return fmt.Errorf("sync2: %v", err)
+	}
+	return nil
+
+}

models/user.go

@@ -1192,6 +1192,7 @@ func DeleteUser(ctx context.Context, u *User) (err error) {
 		&TeamUser{UID: u.ID},
 		&Collaboration{UserID: u.ID},
 		&Stopwatch{UserID: u.ID},
+		&user_model.Setting{UserID: u.ID},
 	); err != nil {
 		return fmt.Errorf("deleteBeans: %v", err)
 	}

models/user/main_test.go

@@ -1,4 +1,4 @@
-// Copyright 2020 The Gitea Authors. All rights reserved.
+// 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.
 

models/user/setting.go

@@ -0,0 +1,116 @@
+// 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 user
+
+import (
+	"context"
+	"fmt"
+	"strings"
+
+	"code.gitea.io/gitea/models/db"
+
+	"xorm.io/builder"
+)
+
+// Setting is a key value store of user settings
+type Setting struct {
+	ID           int64  `xorm:"pk autoincr"`
+	UserID       int64  `xorm:"index unique(key_userid)"`              // to load all of someone's settings
+	SettingKey   string `xorm:"varchar(255) index unique(key_userid)"` // ensure key is always lowercase
+	SettingValue string `xorm:"text"`
+}
+
+// TableName sets the table name for the settings struct
+func (s *Setting) TableName() string {
+	return "user_setting"
+}
+
+func init() {
+	db.RegisterModel(new(Setting))
+}
+
+// GetSettings returns specific settings from user
+func GetSettings(uid int64, keys []string) (map[string]*Setting, error) {
+	settings := make([]*Setting, 0, len(keys))
+	if err := db.GetEngine(db.DefaultContext).
+		Where("user_id=?", uid).
+		And(builder.In("setting_key", keys)).
+		Find(&settings); err != nil {
+		return nil, err
+	}
+	settingsMap := make(map[string]*Setting)
+	for _, s := range settings {
+		settingsMap[s.SettingKey] = s
+	}
+	return settingsMap, nil
+}
+
+// GetUserAllSettings returns all settings from user
+func GetUserAllSettings(uid int64) (map[string]*Setting, error) {
+	settings := make([]*Setting, 0, 5)
+	if err := db.GetEngine(db.DefaultContext).
+		Where("user_id=?", uid).
+		Find(&settings); err != nil {
+		return nil, err
+	}
+	settingsMap := make(map[string]*Setting)
+	for _, s := range settings {
+		settingsMap[s.SettingKey] = s
+	}
+	return settingsMap, nil
+}
+
+// DeleteSetting deletes a specific setting for a user
+func DeleteSetting(setting *Setting) error {
+	_, err := db.GetEngine(db.DefaultContext).Delete(setting)
+	return err
+}
+
+// SetSetting updates a users' setting for a specific key
+func SetSetting(setting *Setting) error {
+	if strings.ToLower(setting.SettingKey) != setting.SettingKey {
+		return fmt.Errorf("setting key should be lowercase")
+	}
+	return upsertSettingValue(setting.UserID, setting.SettingKey, setting.SettingValue)
+}
+
+func upsertSettingValue(userID int64, key string, value string) error {
+	return db.WithTx(func(ctx context.Context) error {
+		e := db.GetEngine(ctx)
+
+		// here we use a general method to do a safe upsert for different databases (and most transaction levels)
+		// 1. try to UPDATE the record and acquire the transaction write lock
+		//    if UPDATE returns non-zero rows are changed, OK, the setting is saved correctly
+		//    if UPDATE returns "0 rows changed", two possibilities: (a) record doesn't exist  (b) value is not changed
+		// 2. do a SELECT to check if the row exists or not (we already have the transaction lock)
+		// 3. if the row doesn't exist, do an INSERT (we are still protected by the transaction lock, so it's safe)
+		//
+		// to optimize the SELECT in step 2, we can use an extra column like `revision=revision+1`
+		//    to make sure the UPDATE always returns a non-zero value for existing (unchanged) records.
+
+		res, err := e.Exec("UPDATE user_setting SET setting_value=? WHERE setting_key=? AND user_id=?", value, key, userID)
+		if err != nil {
+			return err
+		}
+		rows, _ := res.RowsAffected()
+		if rows > 0 {
+			// the existing row is updated, so we can return
+			return nil
+		}
+
+		// in case the value isn't changed, update would return 0 rows changed, so we need this check
+		has, err := e.Exist(&Setting{UserID: userID, SettingKey: key})
+		if err != nil {
+			return err
+		}
+		if has {
+			return nil
+		}
+
+		// if no existing row, insert a new row
+		_, err = e.Insert(&Setting{UserID: userID, SettingKey: key, SettingValue: value})
+		return err
+	})
+}

models/user/setting_test.go

@@ -0,0 +1,51 @@
+// 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 user
+
+import (
+	"testing"
+
+	"code.gitea.io/gitea/models/unittest"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestSettings(t *testing.T) {
+	keyName := "test_user_setting"
+	assert.NoError(t, unittest.PrepareTestDatabase())
+
+	newSetting := &Setting{UserID: 99, SettingKey: keyName, SettingValue: "Gitea User Setting Test"}
+
+	// create setting
+	err := SetSetting(newSetting)
+	assert.NoError(t, err)
+	// test about saving unchanged values
+	err = SetSetting(newSetting)
+	assert.NoError(t, err)
+
+	// get specific setting
+	settings, err := GetSettings(99, []string{keyName})
+	assert.NoError(t, err)
+	assert.Len(t, settings, 1)
+	assert.EqualValues(t, newSetting.SettingValue, settings[keyName].SettingValue)
+
+	// updated setting
+	updatedSetting := &Setting{UserID: 99, SettingKey: keyName, SettingValue: "Updated"}
+	err = SetSetting(updatedSetting)
+	assert.NoError(t, err)
+
+	// get all settings
+	settings, err = GetUserAllSettings(99)
+	assert.NoError(t, err)
+	assert.Len(t, settings, 1)
+	assert.EqualValues(t, updatedSetting.SettingValue, settings[updatedSetting.SettingKey].SettingValue)
+
+	// delete setting
+	err = DeleteSetting(&Setting{UserID: 99, SettingKey: keyName})
+	assert.NoError(t, err)
+	settings, err = GetUserAllSettings(99)
+	assert.NoError(t, err)
+	assert.Len(t, settings, 0)
+}

modules/avatar/identicon/identicon_test.go

@@ -3,7 +3,7 @@
 // license that can be found in the LICENSE file.
 
 //go:build test_avatar_identicon
-//  +build test_avatar_identicon
+// +build test_avatar_identicon
 
 package identicon