diff --git a/modules/base/tool.go b/modules/base/tool.go index bd3a8458e..13b07c043 100644 --- a/modules/base/tool.go +++ b/modules/base/tool.go @@ -141,55 +141,6 @@ func FileSize(s int64) string { return humanize.IBytes(uint64(s)) } -// Subtract deals with subtraction of all types of number. -func Subtract(left, right interface{}) interface{} { - var rleft, rright int64 - var fleft, fright float64 - isInt := true - switch v := left.(type) { - case int: - rleft = int64(v) - case int8: - rleft = int64(v) - case int16: - rleft = int64(v) - case int32: - rleft = int64(v) - case int64: - rleft = v - case float32: - fleft = float64(v) - isInt = false - case float64: - fleft = v - isInt = false - } - - switch v := right.(type) { - case int: - rright = int64(v) - case int8: - rright = int64(v) - case int16: - rright = int64(v) - case int32: - rright = int64(v) - case int64: - rright = v - case float32: - fright = float64(v) - isInt = false - case float64: - fright = v - isInt = false - } - - if isInt { - return rleft - rright - } - return fleft + float64(rleft) - (fright + float64(rright)) -} - // EllipsisString returns a truncated short string, // it appends '...' in the end of the length of string is too large. func EllipsisString(str string, length int) string { diff --git a/modules/base/tool_test.go b/modules/base/tool_test.go index 33677a910..0c3e76704 100644 --- a/modules/base/tool_test.go +++ b/modules/base/tool_test.go @@ -114,45 +114,6 @@ func TestFileSize(t *testing.T) { assert.Equal(t, "2.0 EiB", FileSize(size)) } -func TestSubtract(t *testing.T) { - toFloat64 := func(n interface{}) float64 { - switch v := n.(type) { - case int: - return float64(v) - case int8: - return float64(v) - case int16: - return float64(v) - case int32: - return float64(v) - case int64: - return float64(v) - case float32: - return float64(v) - case float64: - return v - default: - return 0.0 - } - } - values := []interface{}{ - int(-3), - int8(14), - int16(81), - int32(-156), - int64(1528), - float32(3.5), - float64(-15.348), - } - for _, left := range values { - for _, right := range values { - expected := toFloat64(left) - toFloat64(right) - sub := Subtract(left, right) - assert.InDelta(t, expected, sub, 1e-3) - } - } -} - func TestEllipsisString(t *testing.T) { assert.Equal(t, "...", EllipsisString("foobar", 0)) assert.Equal(t, "...", EllipsisString("foobar", 1)) diff --git a/modules/templates/eval/eval.go b/modules/templates/eval/eval.go new file mode 100644 index 000000000..5d4ac915b --- /dev/null +++ b/modules/templates/eval/eval.go @@ -0,0 +1,344 @@ +// Copyright 2023 The Gitea Authors. All rights reserved. +// SPDX-License-Identifier: MIT + +package eval + +import ( + "fmt" + "strconv" + "strings" + + "code.gitea.io/gitea/modules/util" +) + +type Num struct { + Value any // int64 or float64, nil on error +} + +var opPrecedence = map[string]int{ + // "(": 1, this is for low precedence like function calls, they are handled separately + "or": 2, + "and": 3, + "not": 4, + "==": 5, "!=": 5, "<": 5, "<=": 5, ">": 5, ">=": 5, + "+": 6, "-": 6, + "*": 7, "/": 7, +} + +type stack[T any] struct { + name string + elems []T +} + +func (s *stack[T]) push(t T) { + s.elems = append(s.elems, t) +} + +func (s *stack[T]) pop() T { + if len(s.elems) == 0 { + panic(s.name + " stack is empty") + } + t := s.elems[len(s.elems)-1] + s.elems = s.elems[:len(s.elems)-1] + return t +} + +func (s *stack[T]) peek() T { + if len(s.elems) == 0 { + panic(s.name + " stack is empty") + } + return s.elems[len(s.elems)-1] +} + +type operator string + +type eval struct { + stackNum stack[Num] + stackOp stack[operator] + funcMap map[string]func([]Num) Num +} + +func newEval() *eval { + e := &eval{} + e.stackNum.name = "num" + e.stackOp.name = "op" + return e +} + +func toNum(v any) (Num, error) { + switch v := v.(type) { + case string: + if strings.Contains(v, ".") { + n, err := strconv.ParseFloat(v, 64) + if err != nil { + return Num{n}, err + } + return Num{n}, nil + } + n, err := strconv.ParseInt(v, 10, 64) + if err != nil { + return Num{n}, err + } + return Num{n}, nil + case float32, float64: + n, _ := util.ToFloat64(v) + return Num{n}, nil + default: + n, err := util.ToInt64(v) + if err != nil { + return Num{n}, err + } + return Num{n}, nil + } +} + +func truth(b bool) int64 { + if b { + return int64(1) + } + return int64(0) +} + +func applyOp2Generic[T int64 | float64](op operator, n1, n2 T) Num { + switch op { + case "+": + return Num{n1 + n2} + case "-": + return Num{n1 - n2} + case "*": + return Num{n1 * n2} + case "/": + return Num{n1 / n2} + case "==": + return Num{truth(n1 == n2)} + case "!=": + return Num{truth(n1 != n2)} + case "<": + return Num{truth(n1 < n2)} + case "<=": + return Num{truth(n1 <= n2)} + case ">": + return Num{truth(n1 > n2)} + case ">=": + return Num{truth(n1 >= n2)} + case "and": + t1, _ := util.ToFloat64(n1) + t2, _ := util.ToFloat64(n2) + return Num{truth(t1 != 0 && t2 != 0)} + case "or": + t1, _ := util.ToFloat64(n1) + t2, _ := util.ToFloat64(n2) + return Num{truth(t1 != 0 || t2 != 0)} + } + panic("unknown operator: " + string(op)) +} + +func applyOp2(op operator, n1, n2 Num) Num { + float := false + if _, ok := n1.Value.(float64); ok { + float = true + } else if _, ok = n2.Value.(float64); ok { + float = true + } + if float { + f1, _ := util.ToFloat64(n1.Value) + f2, _ := util.ToFloat64(n2.Value) + return applyOp2Generic(op, f1, f2) + } + return applyOp2Generic(op, n1.Value.(int64), n2.Value.(int64)) +} + +func toOp(v any) (operator, error) { + if v, ok := v.(string); ok { + return operator(v), nil + } + return "", fmt.Errorf(`unsupported token type "%T"`, v) +} + +func (op operator) hasOpenBracket() bool { + return strings.HasSuffix(string(op), "(") // it's used to support functions like "sum(" +} + +func (op operator) isComma() bool { + return op == "," +} + +func (op operator) isCloseBracket() bool { + return op == ")" +} + +type ExprError struct { + msg string + tokens []any + err error +} + +func (err ExprError) Error() string { + sb := strings.Builder{} + sb.WriteString(err.msg) + sb.WriteString(" [ ") + for _, token := range err.tokens { + _, _ = fmt.Fprintf(&sb, `"%v" `, token) + } + sb.WriteString("]") + if err.err != nil { + sb.WriteString(": ") + sb.WriteString(err.err.Error()) + } + return sb.String() +} + +func (err ExprError) Unwrap() error { + return err.err +} + +func (e *eval) applyOp() { + op := e.stackOp.pop() + if op == "not" { + num := e.stackNum.pop() + i, _ := util.ToInt64(num.Value) + e.stackNum.push(Num{truth(i == 0)}) + } else if op.hasOpenBracket() || op.isCloseBracket() || op.isComma() { + panic(fmt.Sprintf("incomplete sub-expression with operator %q", op)) + } else { + num2 := e.stackNum.pop() + num1 := e.stackNum.pop() + e.stackNum.push(applyOp2(op, num1, num2)) + } +} + +func (e *eval) exec(tokens ...any) (ret Num, err error) { + defer func() { + if r := recover(); r != nil { + rErr, ok := r.(error) + if !ok { + rErr = fmt.Errorf("%v", r) + } + err = ExprError{"invalid expression", tokens, rErr} + } + }() + for _, token := range tokens { + n, err := toNum(token) + if err == nil { + e.stackNum.push(n) + continue + } + + op, err := toOp(token) + if err != nil { + return Num{}, ExprError{"invalid expression", tokens, err} + } + + switch { + case op.hasOpenBracket(): + e.stackOp.push(op) + case op.isCloseBracket(), op.isComma(): + var stackTopOp operator + for len(e.stackOp.elems) > 0 { + stackTopOp = e.stackOp.peek() + if stackTopOp.hasOpenBracket() || stackTopOp.isComma() { + break + } + e.applyOp() + } + if op.isCloseBracket() { + nums := []Num{e.stackNum.pop()} + for !e.stackOp.peek().hasOpenBracket() { + stackTopOp = e.stackOp.pop() + if !stackTopOp.isComma() { + return Num{}, ExprError{"bracket doesn't match", tokens, nil} + } + nums = append(nums, e.stackNum.pop()) + } + for i, j := 0, len(nums)-1; i < j; i, j = i+1, j-1 { + nums[i], nums[j] = nums[j], nums[i] // reverse nums slice, to get the right order for arguments + } + stackTopOp = e.stackOp.pop() + fn := string(stackTopOp[:len(stackTopOp)-1]) + if fn == "" { + if len(nums) != 1 { + return Num{}, ExprError{"too many values in one bracket", tokens, nil} + } + e.stackNum.push(nums[0]) + } else if f, ok := e.funcMap[fn]; ok { + e.stackNum.push(f(nums)) + } else { + return Num{}, ExprError{"unknown function: " + fn, tokens, nil} + } + } else { + e.stackOp.push(op) + } + default: + for len(e.stackOp.elems) > 0 && len(e.stackNum.elems) > 0 { + stackTopOp := e.stackOp.peek() + if stackTopOp.hasOpenBracket() || stackTopOp.isComma() || precedence(stackTopOp, op) < 0 { + break + } + e.applyOp() + } + e.stackOp.push(op) + } + } + for len(e.stackOp.elems) > 0 && !e.stackOp.peek().isComma() { + e.applyOp() + } + if len(e.stackNum.elems) != 1 { + return Num{}, ExprError{fmt.Sprintf("expect 1 value as final result, but there are %d", len(e.stackNum.elems)), tokens, nil} + } + return e.stackNum.pop(), nil +} + +func precedence(op1, op2 operator) int { + p1 := opPrecedence[string(op1)] + p2 := opPrecedence[string(op2)] + if p1 == 0 { + panic("unknown operator precedence: " + string(op1)) + } else if p2 == 0 { + panic("unknown operator precedence: " + string(op2)) + } + return p1 - p2 +} + +func castFloat64(nums []Num) bool { + hasFloat := false + for _, num := range nums { + if _, hasFloat = num.Value.(float64); hasFloat { + break + } + } + if hasFloat { + for i, num := range nums { + if _, ok := num.Value.(float64); !ok { + f, _ := util.ToFloat64(num.Value) + nums[i] = Num{f} + } + } + } + return hasFloat +} + +func fnSum(nums []Num) Num { + if castFloat64(nums) { + var sum float64 + for _, num := range nums { + sum += num.Value.(float64) + } + return Num{sum} + } + var sum int64 + for _, num := range nums { + sum += num.Value.(int64) + } + return Num{sum} +} + +// Expr evaluates the given expression tokens and returns the result. +// It supports the following operators: +, -, *, /, and, or, not, ==, !=, >, >=, <, <=. +// Non-zero values are treated as true, zero values are treated as false. +// If no error occurs, the result is either an int64 or a float64. +// If all numbers are integer, the result is an int64, otherwise if there is any float number, the result is a float64. +func Expr(tokens ...any) (Num, error) { + e := newEval() + e.funcMap = map[string]func([]Num) Num{"sum": fnSum} + return e.exec(tokens...) +} diff --git a/modules/templates/eval/eval_test.go b/modules/templates/eval/eval_test.go new file mode 100644 index 000000000..c9e514b5e --- /dev/null +++ b/modules/templates/eval/eval_test.go @@ -0,0 +1,94 @@ +// Copyright 2023 The Gitea Authors. All rights reserved. +// SPDX-License-Identifier: MIT + +package eval + +import ( + "math" + "strings" + "testing" + + "github.com/stretchr/testify/assert" +) + +func tokens(s string) (a []any) { + for _, v := range strings.Fields(s) { + a = append(a, v) + } + return a +} + +func TestEval(t *testing.T) { + n, err := Expr(0, "/", 0.0) + assert.NoError(t, err) + assert.True(t, math.IsNaN(n.Value.(float64))) + + _, err = Expr(nil) + assert.ErrorContains(t, err, "unsupported token type") + _, err = Expr([]string{}) + assert.ErrorContains(t, err, "unsupported token type") + _, err = Expr(struct{}{}) + assert.ErrorContains(t, err, "unsupported token type") + + cases := []struct { + expr string + want any + }{ + {"-1", int64(-1)}, + {"1 + 2", int64(3)}, + {"3 - 2 + 4", int64(5)}, + {"1 + 2 * 3", int64(7)}, + {"1 + ( 2 * 3 )", int64(7)}, + {"( 1 + 2 ) * 3", int64(9)}, + {"( 1 + 2.0 ) / 3", float64(1)}, + {"sum( 1 , 2 , 3 , 4 )", int64(10)}, + {"100 + sum( 1 , 2 + 3 , 0.0 ) / 2", float64(103)}, + {"100 * 5 / ( 5 + 15 )", int64(25)}, + {"9 == 5", int64(0)}, + {"5 == 5", int64(1)}, + {"9 != 5", int64(1)}, + {"5 != 5", int64(0)}, + {"9 > 5", int64(1)}, + {"5 > 9", int64(0)}, + {"5 >= 9", int64(0)}, + {"9 >= 9", int64(1)}, + {"9 < 5", int64(0)}, + {"5 < 9", int64(1)}, + {"9 <= 5", int64(0)}, + {"5 <= 5", int64(1)}, + {"1 and 2", int64(1)}, // Golang template definition: non-zero values are all truth + {"1 and 0", int64(0)}, + {"0 and 0", int64(0)}, + {"1 or 2", int64(1)}, + {"1 or 0", int64(1)}, + {"0 or 1", int64(1)}, + {"0 or 0", int64(0)}, + {"not 2 == 1", int64(1)}, + {"not not ( 9 < 5 )", int64(0)}, + } + + for _, c := range cases { + n, err := Expr(tokens(c.expr)...) + if assert.NoError(t, err, "expr: %s", c.expr) { + assert.Equal(t, c.want, n.Value) + } + } + + bads := []struct { + expr string + errMsg string + }{ + {"0 / 0", "integer divide by zero"}, + {"1 +", "num stack is empty"}, + {"+ 1", "num stack is empty"}, + {"( 1", "incomplete sub-expression"}, + {"1 )", "op stack is empty"}, // can not find the corresponding open bracket after the stack becomes empty + {"1 , 2", "expect 1 value as final result"}, + {"( 1 , 2 )", "too many values in one bracket"}, + {"1 a 2", "unknown operator"}, + } + for _, c := range bads { + _, err = Expr(tokens(c.expr)...) + assert.ErrorContains(t, err, c.errMsg, "expr: %s", c.expr) + } +} diff --git a/modules/templates/helper.go b/modules/templates/helper.go index 1686e5483..56be05048 100644 --- a/modules/templates/helper.go +++ b/modules/templates/helper.go @@ -42,6 +42,7 @@ import ( "code.gitea.io/gitea/modules/repository" "code.gitea.io/gitea/modules/setting" "code.gitea.io/gitea/modules/svg" + "code.gitea.io/gitea/modules/templates/eval" "code.gitea.io/gitea/modules/timeutil" "code.gitea.io/gitea/modules/util" "code.gitea.io/gitea/services/gitdiff" @@ -105,24 +106,9 @@ func NewFuncMap() []template.FuncMap { "TimeSinceUnix": timeutil.TimeSinceUnix, "FileSize": base.FileSize, "LocaleNumber": LocaleNumber, - "Subtract": base.Subtract, "EntryIcon": base.EntryIcon, "MigrationIcon": MigrationIcon, - "Add": func(a ...int) int { - sum := 0 - for _, val := range a { - sum += val - } - return sum - }, - "Mul": func(a ...int) int { - sum := 1 - for _, val := range a { - sum *= val - } - return sum - }, - "ActionIcon": ActionIcon, + "ActionIcon": ActionIcon, "DateFmtLong": func(t time.Time) string { return t.Format(time.RFC1123Z) }, @@ -377,7 +363,7 @@ func NewFuncMap() []template.FuncMap { "QueryEscape": url.QueryEscape, "DotEscape": DotEscape, "Iterate": func(arg interface{}) (items []int64) { - count := util.ToInt64(arg) + count, _ := util.ToInt64(arg) for i := int64(0); i < count; i++ { items = append(items, i) } @@ -397,6 +383,7 @@ func NewFuncMap() []template.FuncMap { curBranch, ) }, + "Eval": Eval, }} } @@ -472,28 +459,8 @@ func NewTextFuncMap() []texttmpl.FuncMap { } return dict, nil }, - "percentage": func(n int, values ...int) float32 { - sum := 0 - for i := 0; i < len(values); i++ { - sum += values[i] - } - return float32(n) * 100 / float32(sum) - }, - "Add": func(a ...int) int { - sum := 0 - for _, val := range a { - sum += val - } - return sum - }, - "Mul": func(a ...int) int { - sum := 1 - for _, val := range a { - sum *= val - } - return sum - }, "QueryEscape": url.QueryEscape, + "Eval": Eval, }} } @@ -944,6 +911,18 @@ func mirrorRemoteAddress(ctx context.Context, m *repo_model.Repository, remoteNa // LocaleNumber renders a number with a Custom Element, browser will render it with a locale number func LocaleNumber(v interface{}) template.HTML { - num := util.ToInt64(v) + num, _ := util.ToInt64(v) return template.HTML(fmt.Sprintf(`%d`, num, num)) } + +// Eval the expression and return the result, see the comment of eval.Expr for details. +// To use this helper function in templates, pass each token as a separate parameter. +// +// {{ $int64 := Eval $var "+" 1 }} +// {{ $float64 := Eval $var "+" 1.0 }} +// +// Golang's template supports comparable int types, so the int64 result can be used in later statements like {{if lt $int64 10}} +func Eval(tokens ...any) (any, error) { + n, err := eval.Expr(tokens...) + return n.Value, err +} diff --git a/modules/util/util.go b/modules/util/util.go index e9ea007cc..782b905be 100644 --- a/modules/util/util.go +++ b/modules/util/util.go @@ -9,7 +9,6 @@ import ( "errors" "fmt" "math/big" - "os" "strconv" "strings" @@ -198,14 +197,8 @@ func ToTitleCaseNoLower(s string) string { return cases.Title(language.English, cases.NoLower).String(s) } -func logError(msg string, args ...any) { - // TODO: the "util" package can not import the "modules/log" package, so we use the "fmt" package here temporarily. - // In the future, we should decouple the dependency between them. - _, _ = fmt.Fprintf(os.Stderr, msg, args...) -} - // ToInt64 transform a given int into int64. -func ToInt64(number interface{}) int64 { +func ToInt64(number interface{}) (int64, error) { var value int64 switch v := number.(type) { case int: @@ -218,6 +211,7 @@ func ToInt64(number interface{}) int64 { value = int64(v) case int64: value = v + case uint: value = int64(v) case uint8: @@ -228,13 +222,61 @@ func ToInt64(number interface{}) int64 { value = int64(v) case uint64: value = int64(v) + + case float32: + value = int64(v) + case float64: + value = int64(v) + case string: var err error if value, err = strconv.ParseInt(v, 10, 64); err != nil { - logError("strconv.ParseInt failed for %q: %v", v, err) + return 0, err } default: - logError("unable to convert %q to int64", v) + return 0, fmt.Errorf("unable to convert %v to int64", number) } - return value + return value, nil +} + +// ToFloat64 transform a given int into float64. +func ToFloat64(number interface{}) (float64, error) { + var value float64 + switch v := number.(type) { + case int: + value = float64(v) + case int8: + value = float64(v) + case int16: + value = float64(v) + case int32: + value = float64(v) + case int64: + value = float64(v) + + case uint: + value = float64(v) + case uint8: + value = float64(v) + case uint16: + value = float64(v) + case uint32: + value = float64(v) + case uint64: + value = float64(v) + + case float32: + value = float64(v) + case float64: + value = v + + case string: + var err error + if value, err = strconv.ParseFloat(v, 64); err != nil { + return 0, err + } + default: + return 0, fmt.Errorf("unable to convert %v to float64", number) + } + return value, nil } diff --git a/templates/repo/branch/list.tmpl b/templates/repo/branch/list.tmpl index 162fa1876..6dd6aecb3 100644 --- a/templates/repo/branch/list.tmpl +++ b/templates/repo/branch/list.tmpl @@ -69,11 +69,12 @@
{{.CommitsBehind}}
-
+ {{/* old code bears 0/0.0 = NaN output, so it might output invalid "width: NaNpx", it just works and doesn't caues any problem. */}} +
{{.CommitsAhead}}
-
+
{{end}} diff --git a/templates/repo/commits_list_small.tmpl b/templates/repo/commits_list_small.tmpl index 40a9843c8..5bc159de8 100644 --- a/templates/repo/commits_list_small.tmpl +++ b/templates/repo/commits_list_small.tmpl @@ -2,7 +2,7 @@
{{range .comment.Commits}} {{$tag := printf "%s-%d" $.comment.HashTag $index}} - {{$index = Add $index 1}} + {{$index = Eval $index "+" 1}}
{{svg "octicon-git-commit"}} {{if .User}} diff --git a/templates/repo/diff/stats.tmpl b/templates/repo/diff/stats.tmpl index 1e62fa6d6..1e466d6b4 100644 --- a/templates/repo/diff/stats.tmpl +++ b/templates/repo/diff/stats.tmpl @@ -1,4 +1,4 @@ -{{Add .file.Addition .file.Deletion}} - +{{Eval .file.Addition "+" .file.Deletion}} +
diff --git a/templates/repo/editor/edit.tmpl b/templates/repo/editor/edit.tmpl index 6ecc5e146..0ac6e93d4 100644 --- a/templates/repo/editor/edit.tmpl +++ b/templates/repo/editor/edit.tmpl @@ -12,7 +12,7 @@