mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2025-05-31 20:02:09 +00:00
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).
This commit is contained in:
parent
5b7466053d
commit
65f17bfc31
22 changed files with 397 additions and 81 deletions
93
modules/templates/vars/vars.go
Normal file
93
modules/templates/vars/vars.go
Normal file
|
@ -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
|
||||
}
|
Loading…
Add table
Add a link
Reference in a new issue