Refactor legacy `unknwon/com` package, improve golangci lint (#19284)
The main purpose is to refactor the legacy `unknwon/com` package. 1. Remove most imports of `unknwon/com`, only `util/legacy.go` imports the legacy `unknwon/com` 2. Use golangci's depguard to process denied packages 3. Fix some incorrect values in golangci.yml, eg, the version should be quoted string `"1.18"` 4. Use correctly escaped content for `go-import` and `go-source` meta tags 5. Refactor `com.Expand` to our stable (and the same fast) `vars.Expand`, our `vars.Expand` can still return partially rendered content even if the template is not good (eg: key mistach).tokarchuk/v1.17
wxiaoguang
3 years ago
committed by
GitHub
parent
5b7466053d
commit
65f17bfc31
@ -0,0 +1,93 @@ |
|||||||
|
// Copyright 2022 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 vars |
||||||
|
|
||||||
|
import ( |
||||||
|
"fmt" |
||||||
|
"strings" |
||||||
|
"unicode" |
||||||
|
"unicode/utf8" |
||||||
|
) |
||||||
|
|
||||||
|
// ErrWrongSyntax represents a wrong syntax with a template
|
||||||
|
type ErrWrongSyntax struct { |
||||||
|
Template string |
||||||
|
} |
||||||
|
|
||||||
|
func (err ErrWrongSyntax) Error() string { |
||||||
|
return fmt.Sprintf("wrong syntax found in %s", err.Template) |
||||||
|
} |
||||||
|
|
||||||
|
// ErrVarMissing represents an error that no matched variable
|
||||||
|
type ErrVarMissing struct { |
||||||
|
Template string |
||||||
|
Var string |
||||||
|
} |
||||||
|
|
||||||
|
func (err ErrVarMissing) Error() string { |
||||||
|
return fmt.Sprintf("the variable %s is missing for %s", err.Var, err.Template) |
||||||
|
} |
||||||
|
|
||||||
|
// Expand replaces all variables like {var} by `vars` map, it always returns the expanded string regardless of errors
|
||||||
|
// if error occurs, the error part doesn't change and is returned as it is.
|
||||||
|
func Expand(template string, vars map[string]string) (string, error) { |
||||||
|
// in the future, if necessary, we can introduce some escape-char,
|
||||||
|
// for example: it will use `#' as a reversed char, templates will use `{#{}` to do escape and output char '{'.
|
||||||
|
var buf strings.Builder |
||||||
|
var err error |
||||||
|
|
||||||
|
posBegin := 0 |
||||||
|
strLen := len(template) |
||||||
|
for posBegin < strLen { |
||||||
|
// find the next `{`
|
||||||
|
pos := strings.IndexByte(template[posBegin:], '{') |
||||||
|
if pos == -1 { |
||||||
|
buf.WriteString(template[posBegin:]) |
||||||
|
break |
||||||
|
} |
||||||
|
|
||||||
|
// copy texts between vars
|
||||||
|
buf.WriteString(template[posBegin : posBegin+pos]) |
||||||
|
|
||||||
|
// find the var between `{` and `}`/end
|
||||||
|
posBegin += pos |
||||||
|
posEnd := posBegin + 1 |
||||||
|
for posEnd < strLen { |
||||||
|
if template[posEnd] == '}' { |
||||||
|
posEnd++ |
||||||
|
break |
||||||
|
} // in the future, if we need to support escape chars, we can do: if (isEscapeChar) { posEnd+=2 }
|
||||||
|
posEnd++ |
||||||
|
} |
||||||
|
|
||||||
|
// the var part, it can be "{", "{}", "{..." or or "{...}"
|
||||||
|
part := template[posBegin:posEnd] |
||||||
|
posBegin = posEnd |
||||||
|
if part == "{}" || part[len(part)-1] != '}' { |
||||||
|
// treat "{}" or "{..." as error
|
||||||
|
err = ErrWrongSyntax{Template: template} |
||||||
|
buf.WriteString(part) |
||||||
|
} else { |
||||||
|
// now we get a valid key "{...}"
|
||||||
|
key := part[1 : len(part)-1] |
||||||
|
keyFirst, _ := utf8.DecodeRuneInString(key) |
||||||
|
if unicode.IsSpace(keyFirst) || unicode.IsPunct(keyFirst) || unicode.IsControl(keyFirst) { |
||||||
|
// the if key doesn't start with a letter, then we do not treat it as a var now
|
||||||
|
buf.WriteString(part) |
||||||
|
} else { |
||||||
|
// look up in the map
|
||||||
|
if val, ok := vars[key]; ok { |
||||||
|
buf.WriteString(val) |
||||||
|
} else { |
||||||
|
// write the non-existing var as it is
|
||||||
|
buf.WriteString(part) |
||||||
|
err = ErrVarMissing{Template: template, Var: key} |
||||||
|
} |
||||||
|
} |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
return buf.String(), err |
||||||
|
} |
||||||
@ -0,0 +1,72 @@ |
|||||||
|
// Copyright 2022 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 vars |
||||||
|
|
||||||
|
import ( |
||||||
|
"testing" |
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert" |
||||||
|
) |
||||||
|
|
||||||
|
func TestExpandVars(t *testing.T) { |
||||||
|
kases := []struct { |
||||||
|
tmpl string |
||||||
|
data map[string]string |
||||||
|
out string |
||||||
|
error bool |
||||||
|
}{ |
||||||
|
{ |
||||||
|
tmpl: "{a}", |
||||||
|
data: map[string]string{ |
||||||
|
"a": "1", |
||||||
|
}, |
||||||
|
out: "1", |
||||||
|
}, |
||||||
|
{ |
||||||
|
tmpl: "expand {a}, {b} and {c}, with non-var { } {#}", |
||||||
|
data: map[string]string{ |
||||||
|
"a": "1", |
||||||
|
"b": "2", |
||||||
|
"c": "3", |
||||||
|
}, |
||||||
|
out: "expand 1, 2 and 3, with non-var { } {#}", |
||||||
|
}, |
||||||
|
{ |
||||||
|
tmpl: "中文内容 {一}, {二} 和 {三} 中文结尾", |
||||||
|
data: map[string]string{ |
||||||
|
"一": "11", |
||||||
|
"二": "22", |
||||||
|
"三": "33", |
||||||
|
}, |
||||||
|
out: "中文内容 11, 22 和 33 中文结尾", |
||||||
|
}, |
||||||
|
{ |
||||||
|
tmpl: "expand {{a}, {b} and {c}", |
||||||
|
data: map[string]string{ |
||||||
|
"a": "foo", |
||||||
|
"b": "bar", |
||||||
|
}, |
||||||
|
out: "expand {{a}, bar and {c}", |
||||||
|
error: true, |
||||||
|
}, |
||||||
|
{ |
||||||
|
tmpl: "expand } {} and {", |
||||||
|
out: "expand } {} and {", |
||||||
|
error: true, |
||||||
|
}, |
||||||
|
} |
||||||
|
|
||||||
|
for _, kase := range kases { |
||||||
|
t.Run(kase.tmpl, func(t *testing.T) { |
||||||
|
res, err := Expand(kase.tmpl, kase.data) |
||||||
|
assert.EqualValues(t, kase.out, res) |
||||||
|
if kase.error { |
||||||
|
assert.Error(t, err) |
||||||
|
} else { |
||||||
|
assert.NoError(t, err) |
||||||
|
} |
||||||
|
}) |
||||||
|
} |
||||||
|
} |
||||||
@ -1,20 +0,0 @@ |
|||||||
// 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 util |
|
||||||
|
|
||||||
import ( |
|
||||||
"github.com/unknwon/com" |
|
||||||
) |
|
||||||
|
|
||||||
// CopyFile copies file from source to target path.
|
|
||||||
func CopyFile(src, dest string) error { |
|
||||||
return com.Copy(src, dest) |
|
||||||
} |
|
||||||
|
|
||||||
// CopyDir copy files recursively from source to target directory.
|
|
||||||
// It returns error when error occurs in underlying functions.
|
|
||||||
func CopyDir(srcPath, destPath string) error { |
|
||||||
return com.CopyDir(srcPath, destPath) |
|
||||||
} |
|
||||||
@ -0,0 +1,84 @@ |
|||||||
|
// Copyright 2022 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 util |
||||||
|
|
||||||
|
import ( |
||||||
|
"crypto/aes" |
||||||
|
"crypto/cipher" |
||||||
|
"crypto/rand" |
||||||
|
"errors" |
||||||
|
|
||||||
|
"github.com/unknwon/com" //nolint:depguard
|
||||||
|
) |
||||||
|
|
||||||
|
// CopyFile copies file from source to target path.
|
||||||
|
func CopyFile(src, dest string) error { |
||||||
|
return com.Copy(src, dest) |
||||||
|
} |
||||||
|
|
||||||
|
// CopyDir copy files recursively from source to target directory.
|
||||||
|
// It returns error when error occurs in underlying functions.
|
||||||
|
func CopyDir(srcPath, destPath string) error { |
||||||
|
return com.CopyDir(srcPath, destPath) |
||||||
|
} |
||||||
|
|
||||||
|
// ToStr converts any interface to string. should be replaced.
|
||||||
|
func ToStr(value interface{}, args ...int) string { |
||||||
|
return com.ToStr(value, args...) |
||||||
|
} |
||||||
|
|
||||||
|
// ToSnakeCase converts a string to snake_case. should be replaced.
|
||||||
|
func ToSnakeCase(str string) string { |
||||||
|
return com.ToSnakeCase(str) |
||||||
|
} |
||||||
|
|
||||||
|
// AESGCMEncrypt (from legacy package): encrypts plaintext with the given key using AES in GCM mode. should be replaced.
|
||||||
|
func AESGCMEncrypt(key, plaintext []byte) ([]byte, error) { |
||||||
|
block, err := aes.NewCipher(key) |
||||||
|
if err != nil { |
||||||
|
return nil, err |
||||||
|
} |
||||||
|
|
||||||
|
gcm, err := cipher.NewGCM(block) |
||||||
|
if err != nil { |
||||||
|
return nil, err |
||||||
|
} |
||||||
|
|
||||||
|
nonce := make([]byte, gcm.NonceSize()) |
||||||
|
if _, err := rand.Read(nonce); err != nil { |
||||||
|
return nil, err |
||||||
|
} |
||||||
|
|
||||||
|
ciphertext := gcm.Seal(nil, nonce, plaintext, nil) |
||||||
|
return append(nonce, ciphertext...), nil |
||||||
|
} |
||||||
|
|
||||||
|
// AESGCMDecrypt (from legacy package): decrypts ciphertext with the given key using AES in GCM mode. should be replaced.
|
||||||
|
func AESGCMDecrypt(key, ciphertext []byte) ([]byte, error) { |
||||||
|
block, err := aes.NewCipher(key) |
||||||
|
if err != nil { |
||||||
|
return nil, err |
||||||
|
} |
||||||
|
|
||||||
|
gcm, err := cipher.NewGCM(block) |
||||||
|
if err != nil { |
||||||
|
return nil, err |
||||||
|
} |
||||||
|
|
||||||
|
size := gcm.NonceSize() |
||||||
|
if len(ciphertext)-size <= 0 { |
||||||
|
return nil, errors.New("ciphertext is empty") |
||||||
|
} |
||||||
|
|
||||||
|
nonce := ciphertext[:size] |
||||||
|
ciphertext = ciphertext[size:] |
||||||
|
|
||||||
|
plainText, err := gcm.Open(nil, nonce, ciphertext, nil) |
||||||
|
if err != nil { |
||||||
|
return nil, err |
||||||
|
} |
||||||
|
|
||||||
|
return plainText, nil |
||||||
|
} |
||||||
@ -0,0 +1,37 @@ |
|||||||
|
// Copyright 2022 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 util |
||||||
|
|
||||||
|
import ( |
||||||
|
"crypto/aes" |
||||||
|
"crypto/rand" |
||||||
|
"testing" |
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert" |
||||||
|
"github.com/unknwon/com" //nolint:depguard
|
||||||
|
) |
||||||
|
|
||||||
|
func TestAESGCM(t *testing.T) { |
||||||
|
t.Parallel() |
||||||
|
|
||||||
|
key := make([]byte, aes.BlockSize) |
||||||
|
_, err := rand.Read(key) |
||||||
|
assert.NoError(t, err) |
||||||
|
|
||||||
|
plaintext := []byte("this will be encrypted") |
||||||
|
|
||||||
|
ciphertext, err := AESGCMEncrypt(key, plaintext) |
||||||
|
assert.NoError(t, err) |
||||||
|
|
||||||
|
decrypted, err := AESGCMDecrypt(key, ciphertext) |
||||||
|
assert.NoError(t, err) |
||||||
|
|
||||||
|
assert.Equal(t, plaintext, decrypted) |
||||||
|
|
||||||
|
// at the moment, we make sure the result is the same as the legacy package, this assertion can be removed in next round refactoring
|
||||||
|
legacy, err := com.AESGCMDecrypt(key, ciphertext) |
||||||
|
assert.NoError(t, err) |
||||||
|
assert.Equal(t, legacy, plaintext) |
||||||
|
} |
||||||
Loading…
Reference in new issue