2018-09-29 14:03:54 +05:30
|
|
|
// Copyright 2018 The Gitea Authors. All rights reserved.
|
2014-04-10 23:50:58 +05:30
|
|
|
// Copyright 2014 The Gogs Authors. All rights reserved.
|
2022-11-27 23:50:29 +05:30
|
|
|
// SPDX-License-Identifier: MIT
|
2014-04-10 23:50:58 +05:30
|
|
|
|
2016-12-06 23:28:31 +05:30
|
|
|
package templates
|
2014-04-10 23:50:58 +05:30
|
|
|
|
|
|
|
import (
|
2017-03-02 05:55:44 +05:30
|
|
|
"bytes"
|
2022-01-20 04:56:57 +05:30
|
|
|
"context"
|
Scoped labels (#22585)
Add a new "exclusive" option per label. This makes it so that when the
label is named `scope/name`, no other label with the same `scope/`
prefix can be set on an issue.
The scope is determined by the last occurence of `/`, so for example
`scope/alpha/name` and `scope/beta/name` are considered to be in
different scopes and can coexist.
Exclusive scopes are not enforced by any database rules, however they
are enforced when editing labels at the models level, automatically
removing any existing labels in the same scope when either attaching a
new label or replacing all labels.
In menus use a circle instead of checkbox to indicate they function as
radio buttons per scope. Issue filtering by label ensures that only a
single scoped label is selected at a time. Clicking with alt key can be
used to remove a scoped label, both when editing individual issues and
batch editing.
Label rendering refactor for consistency and code simplification:
* Labels now consistently have the same shape, emojis and tooltips
everywhere. This includes the label list and label assignment menus.
* In label list, show description below label same as label menus.
* Don't use exactly black/white text colors to look a bit nicer.
* Simplify text color computation. There is no point computing luminance
in linear color space, as this is a perceptual problem and sRGB is
closer to perceptually linear.
* Increase height of label assignment menus to show more labels. Showing
only 3-4 labels at a time leads to a lot of scrolling.
* Render all labels with a new RenderLabel template helper function.
Label creation and editing in multiline modal menu:
* Change label creation to open a modal menu like label editing.
* Change menu layout to place name, description and colors on separate
lines.
* Don't color cancel button red in label editing modal menu.
* Align text to the left in model menu for better readability and
consistent with settings layout elsewhere.
Custom exclusive scoped label rendering:
* Display scoped label prefix and suffix with slightly darker and
lighter background color respectively, and a slanted edge between them
similar to the `/` symbol.
* In menus exclusive labels are grouped with a divider line.
---------
Co-authored-by: Yarden Shoham <hrsi88@gmail.com>
Co-authored-by: Lauris BH <lauris@nix.lv>
2023-02-19 00:47:39 +05:30
|
|
|
"encoding/hex"
|
2014-04-10 23:50:58 +05:30
|
|
|
"fmt"
|
2018-02-27 12:39:18 +05:30
|
|
|
"html"
|
2014-04-10 23:50:58 +05:30
|
|
|
"html/template"
|
Scoped labels (#22585)
Add a new "exclusive" option per label. This makes it so that when the
label is named `scope/name`, no other label with the same `scope/`
prefix can be set on an issue.
The scope is determined by the last occurence of `/`, so for example
`scope/alpha/name` and `scope/beta/name` are considered to be in
different scopes and can coexist.
Exclusive scopes are not enforced by any database rules, however they
are enforced when editing labels at the models level, automatically
removing any existing labels in the same scope when either attaching a
new label or replacing all labels.
In menus use a circle instead of checkbox to indicate they function as
radio buttons per scope. Issue filtering by label ensures that only a
single scoped label is selected at a time. Clicking with alt key can be
used to remove a scoped label, both when editing individual issues and
batch editing.
Label rendering refactor for consistency and code simplification:
* Labels now consistently have the same shape, emojis and tooltips
everywhere. This includes the label list and label assignment menus.
* In label list, show description below label same as label menus.
* Don't use exactly black/white text colors to look a bit nicer.
* Simplify text color computation. There is no point computing luminance
in linear color space, as this is a perceptual problem and sRGB is
closer to perceptually linear.
* Increase height of label assignment menus to show more labels. Showing
only 3-4 labels at a time leads to a lot of scrolling.
* Render all labels with a new RenderLabel template helper function.
Label creation and editing in multiline modal menu:
* Change label creation to open a modal menu like label editing.
* Change menu layout to place name, description and colors on separate
lines.
* Don't color cancel button red in label editing modal menu.
* Align text to the left in model menu for better readability and
consistent with settings layout elsewhere.
Custom exclusive scoped label rendering:
* Display scoped label prefix and suffix with slightly darker and
lighter background color respectively, and a slanted edge between them
similar to the `/` symbol.
* In menus exclusive labels are grouped with a divider line.
---------
Co-authored-by: Yarden Shoham <hrsi88@gmail.com>
Co-authored-by: Lauris BH <lauris@nix.lv>
2023-02-19 00:47:39 +05:30
|
|
|
"math"
|
2016-08-12 04:46:36 +05:30
|
|
|
"mime"
|
2017-11-28 15:13:51 +05:30
|
|
|
"net/url"
|
2016-08-12 04:46:36 +05:30
|
|
|
"path/filepath"
|
2020-11-08 22:51:54 +05:30
|
|
|
"reflect"
|
2019-11-07 19:04:28 +05:30
|
|
|
"regexp"
|
2014-04-10 23:50:58 +05:30
|
|
|
"strings"
|
|
|
|
"time"
|
2019-11-01 10:18:30 +05:30
|
|
|
"unicode"
|
2014-05-26 05:41:25 +05:30
|
|
|
|
2022-08-25 08:01:57 +05:30
|
|
|
activities_model "code.gitea.io/gitea/models/activities"
|
Avatar refactor, move avatar code from `models` to `models.avatars`, remove duplicated code (#17123)
Why this refactor
The goal is to move most files from `models` package to `models.xxx` package. Many models depend on avatar model, so just move this first.
And the existing logic is not clear, there are too many function like `AvatarLink`, `RelAvatarLink`, `SizedRelAvatarLink`, `SizedAvatarLink`, `MakeFinalAvatarURL`, `HashedAvatarLink`, etc. This refactor make everything clear:
* user.AvatarLink()
* user.AvatarLinkWithSize(size)
* avatars.GenerateEmailAvatarFastLink(email, size)
* avatars.GenerateEmailAvatarFinalLink(email, size)
And many duplicated code are deleted in route handler, the handler and the model share the same avatar logic now.
2021-10-06 04:55:46 +05:30
|
|
|
"code.gitea.io/gitea/models/avatars"
|
2022-06-13 15:07:59 +05:30
|
|
|
issues_model "code.gitea.io/gitea/models/issues"
|
2022-03-29 11:59:02 +05:30
|
|
|
"code.gitea.io/gitea/models/organization"
|
2021-12-10 06:57:50 +05:30
|
|
|
repo_model "code.gitea.io/gitea/models/repo"
|
2022-10-17 04:59:26 +05:30
|
|
|
system_model "code.gitea.io/gitea/models/system"
|
2021-11-24 15:19:20 +05:30
|
|
|
user_model "code.gitea.io/gitea/models/user"
|
2016-11-10 21:54:48 +05:30
|
|
|
"code.gitea.io/gitea/modules/base"
|
2020-04-28 23:35:39 +05:30
|
|
|
"code.gitea.io/gitea/modules/emoji"
|
2021-06-14 22:50:43 +05:30
|
|
|
"code.gitea.io/gitea/modules/git"
|
2022-06-11 19:20:14 +05:30
|
|
|
giturl "code.gitea.io/gitea/modules/git/url"
|
2022-11-08 20:43:58 +05:30
|
|
|
gitea_html "code.gitea.io/gitea/modules/html"
|
2021-07-24 21:33:58 +05:30
|
|
|
"code.gitea.io/gitea/modules/json"
|
2016-11-10 21:54:48 +05:30
|
|
|
"code.gitea.io/gitea/modules/log"
|
2017-09-16 22:47:57 +05:30
|
|
|
"code.gitea.io/gitea/modules/markup"
|
2022-03-30 14:12:47 +05:30
|
|
|
"code.gitea.io/gitea/modules/markup/markdown"
|
2020-01-10 15:04:21 +05:30
|
|
|
"code.gitea.io/gitea/modules/repository"
|
2016-11-10 21:54:48 +05:30
|
|
|
"code.gitea.io/gitea/modules/setting"
|
2020-07-12 14:40:56 +05:30
|
|
|
"code.gitea.io/gitea/modules/svg"
|
Use a general Eval function for expressions in templates. (#23927)
One of the proposals in #23328
This PR introduces a simple expression calculator
(templates/eval/eval.go), it can do basic expression calculations.
Many untested template helper functions like `Mul` `Add` can be replaced
by this new approach.
Then these `Add` / `Mul` / `percentage` / `Subtract` / `DiffStatsWidth`
could all use this `Eval`.
And it provides enhancements for Golang templates, and improves
readability.
Some examples:
----
* Before: `{{Add (Mul $glyph.Row 12) 12}}`
* After: `{{Eval $glyph.Row "*" 12 "+" 12}}`
----
* Before: `{{if lt (Add $i 1) (len $.Topics)}}`
* After: `{{if Eval $i "+" 1 "<" (len $.Topics)}}`
## FAQ
### Why not use an existing expression package?
We need a highly customized expression engine:
* do the calculation on the fly, without pre-compiling
* deal with int/int64/float64 types, to make the result could be used in
Golang template.
* make the syntax could be used in the Golang template directly
* do not introduce too much complex or strange syntax, we just need a
simple calculator.
* it needs to strictly follow Golang template's behavior, for example,
Golang template treats all non-zero values as truth, but many 3rd
packages don't do so.
### What's the benefit?
* Developers don't need to add more `Add`/`Mul`/`Sub`-like functions,
they were getting more and more.
Now, only one `Eval` is enough for all cases.
* The new code reads better than old `{{Add (Mul $glyph.Row 12) 12}}`,
the old one isn't familiar to most procedural programming developers
(eg, the Golang expression syntax).
* The `Eval` is fully covered by tests, many old `Add`/`Mul`-like
functions were never tested.
### The performance?
It doesn't use `reflect`, it doesn't need to parse or compile when used
in Golang template, the performance is as fast as native Go template.
### Is it too complex? Could it be unstable?
The expression calculator program is a common homework for computer
science students, and it's widely used as a teaching and practicing
purpose for developers. The algorithm is pretty well-known.
The behavior can be clearly defined, it is stable.
2023-04-07 18:55:49 +05:30
|
|
|
"code.gitea.io/gitea/modules/templates/eval"
|
2019-08-15 20:16:21 +05:30
|
|
|
"code.gitea.io/gitea/modules/timeutil"
|
|
|
|
"code.gitea.io/gitea/modules/util"
|
2019-09-06 07:50:09 +05:30
|
|
|
"code.gitea.io/gitea/services/gitdiff"
|
2017-11-22 12:39:48 +05:30
|
|
|
|
2019-10-16 02:54:16 +05:30
|
|
|
"github.com/editorconfig/editorconfig-core-go/v2"
|
2014-04-10 23:50:58 +05:30
|
|
|
)
|
|
|
|
|
2019-11-07 19:04:28 +05:30
|
|
|
// Used from static.go && dynamic.go
|
|
|
|
var mailSubjectSplit = regexp.MustCompile(`(?m)^-{3,}[\s]*$`)
|
|
|
|
|
2016-11-25 11:53:48 +05:30
|
|
|
// NewFuncMap returns functions for injecting to templates
|
2016-03-07 03:10:04 +05:30
|
|
|
func NewFuncMap() []template.FuncMap {
|
|
|
|
return []template.FuncMap{map[string]interface{}{
|
2023-04-08 18:45:22 +05:30
|
|
|
// -----------------------------------------------------------------
|
|
|
|
// html/template related functions
|
|
|
|
"dict": dict, // it's lowercase because this name has been widely used. Our other functions should have uppercase names.
|
|
|
|
"Eval": Eval,
|
|
|
|
"Safe": Safe,
|
|
|
|
"Escape": html.EscapeString,
|
|
|
|
"QueryEscape": url.QueryEscape,
|
|
|
|
"JSEscape": template.JSEscapeString,
|
|
|
|
"Str2html": Str2html, // TODO: rename it to SanitizeHTML
|
|
|
|
"URLJoin": util.URLJoin,
|
|
|
|
|
|
|
|
"PathEscape": url.PathEscape,
|
|
|
|
"PathEscapeSegments": util.PathEscapeSegments,
|
|
|
|
|
|
|
|
// -----------------------------------------------------------------
|
|
|
|
// string / json
|
|
|
|
"Join": strings.Join,
|
|
|
|
"DotEscape": DotEscape,
|
|
|
|
"HasPrefix": strings.HasPrefix,
|
|
|
|
"EllipsisString": base.EllipsisString,
|
|
|
|
|
|
|
|
"Json": func(in interface{}) string {
|
|
|
|
out, err := json.Marshal(in)
|
|
|
|
if err != nil {
|
|
|
|
return ""
|
|
|
|
}
|
|
|
|
return string(out)
|
|
|
|
},
|
|
|
|
"JsonPrettyPrint": func(in string) string {
|
|
|
|
var out bytes.Buffer
|
|
|
|
err := json.Indent(&out, []byte(in), "", " ")
|
|
|
|
if err != nil {
|
|
|
|
return ""
|
|
|
|
}
|
|
|
|
return out.String()
|
|
|
|
},
|
|
|
|
|
|
|
|
// -----------------------------------------------------------------
|
|
|
|
// svg / avatar / icon
|
|
|
|
"svg": svg.RenderHTML,
|
|
|
|
"avatar": Avatar,
|
|
|
|
"avatarHTML": AvatarHTML,
|
|
|
|
"avatarByAction": AvatarByAction,
|
|
|
|
"avatarByEmail": AvatarByEmail,
|
|
|
|
"repoAvatar": RepoAvatar,
|
|
|
|
"EntryIcon": base.EntryIcon,
|
|
|
|
"MigrationIcon": MigrationIcon,
|
|
|
|
"ActionIcon": ActionIcon,
|
|
|
|
|
|
|
|
"SortArrow": func(normSort, revSort, urlSort string, isDefault bool) template.HTML {
|
|
|
|
// if needed
|
|
|
|
if len(normSort) == 0 || len(urlSort) == 0 {
|
|
|
|
return ""
|
|
|
|
}
|
|
|
|
|
|
|
|
if len(urlSort) == 0 && isDefault {
|
|
|
|
// if sort is sorted as default add arrow tho this table header
|
|
|
|
if isDefault {
|
|
|
|
return svg.RenderHTML("octicon-triangle-down", 16)
|
|
|
|
}
|
|
|
|
} else {
|
|
|
|
// if sort arg is in url test if it correlates with column header sort arguments
|
|
|
|
// the direction of the arrow should indicate the "current sort order", up means ASC(normal), down means DESC(rev)
|
|
|
|
if urlSort == normSort {
|
|
|
|
// the table is sorted with this header normal
|
|
|
|
return svg.RenderHTML("octicon-triangle-up", 16)
|
|
|
|
} else if urlSort == revSort {
|
|
|
|
// the table is sorted with this header reverse
|
|
|
|
return svg.RenderHTML("octicon-triangle-down", 16)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
// the table is NOT sorted with this header
|
|
|
|
return ""
|
|
|
|
},
|
|
|
|
|
|
|
|
// -----------------------------------------------------------------
|
|
|
|
// time / number / format
|
|
|
|
"FileSize": base.FileSize,
|
|
|
|
"CountFmt": base.FormatNumberSI,
|
|
|
|
"TimeSince": timeutil.TimeSince,
|
|
|
|
"TimeSinceUnix": timeutil.TimeSinceUnix,
|
|
|
|
"Sec2Time": util.SecToTime,
|
|
|
|
"DateFmtLong": func(t time.Time) string {
|
2023-04-11 04:31:20 +05:30
|
|
|
return t.Format(time.RFC3339)
|
2023-04-08 18:45:22 +05:30
|
|
|
},
|
|
|
|
"LoadTimes": func(startTime time.Time) string {
|
|
|
|
return fmt.Sprint(time.Since(startTime).Nanoseconds()/1e6) + "ms"
|
|
|
|
},
|
|
|
|
|
|
|
|
// -----------------------------------------------------------------
|
|
|
|
// slice
|
|
|
|
"containGeneric": func(arr, v interface{}) bool {
|
|
|
|
arrV := reflect.ValueOf(arr)
|
|
|
|
if arrV.Kind() == reflect.String && reflect.ValueOf(v).Kind() == reflect.String {
|
|
|
|
return strings.Contains(arr.(string), v.(string))
|
|
|
|
}
|
|
|
|
if arrV.Kind() == reflect.Slice {
|
|
|
|
for i := 0; i < arrV.Len(); i++ {
|
|
|
|
iV := arrV.Index(i)
|
|
|
|
if !iV.CanInterface() {
|
|
|
|
continue
|
|
|
|
}
|
|
|
|
if iV.Interface() == v {
|
|
|
|
return true
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return false
|
|
|
|
},
|
|
|
|
"contain": func(s []int64, id int64) bool {
|
|
|
|
for i := 0; i < len(s); i++ {
|
|
|
|
if s[i] == id {
|
|
|
|
return true
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return false
|
|
|
|
},
|
|
|
|
|
|
|
|
// -----------------------------------------------------------------
|
|
|
|
// setting
|
2016-03-07 03:10:04 +05:30
|
|
|
"AppName": func() string {
|
|
|
|
return setting.AppName
|
|
|
|
},
|
|
|
|
"AppSubUrl": func() string {
|
2016-11-27 15:44:25 +05:30
|
|
|
return setting.AppSubURL
|
2016-03-07 03:10:04 +05:30
|
|
|
},
|
2021-05-08 19:57:25 +05:30
|
|
|
"AssetUrlPrefix": func() string {
|
2021-04-28 18:05:06 +05:30
|
|
|
return setting.StaticURLPrefix + "/assets"
|
2019-10-22 17:41:01 +05:30
|
|
|
},
|
2016-03-07 03:10:04 +05:30
|
|
|
"AppUrl": func() string {
|
2023-02-09 22:01:30 +05:30
|
|
|
// The usage of AppUrl should be avoided as much as possible,
|
|
|
|
// because the AppURL(ROOT_URL) may not match user's visiting site and the ROOT_URL in app.ini may be incorrect.
|
|
|
|
// And it's difficult for Gitea to guess absolute URL correctly with zero configuration,
|
|
|
|
// because Gitea doesn't know whether the scheme is HTTP or HTTPS unless the reverse proxy could tell Gitea.
|
2016-11-27 15:44:25 +05:30
|
|
|
return setting.AppURL
|
2016-03-07 03:10:04 +05:30
|
|
|
},
|
|
|
|
"AppVer": func() string {
|
|
|
|
return setting.AppVer
|
|
|
|
},
|
2023-04-07 13:01:41 +05:30
|
|
|
"AppDomain": func() string { // documented in mail-templates.md
|
2016-03-07 03:10:04 +05:30
|
|
|
return setting.Domain
|
|
|
|
},
|
2022-08-23 18:28:04 +05:30
|
|
|
"AssetVersion": func() string {
|
|
|
|
return setting.AssetVersion
|
|
|
|
},
|
Add context cache as a request level cache (#22294)
To avoid duplicated load of the same data in an HTTP request, we can set
a context cache to do that. i.e. Some pages may load a user from a
database with the same id in different areas on the same page. But the
code is hidden in two different deep logic. How should we share the
user? As a result of this PR, now if both entry functions accept
`context.Context` as the first parameter and we just need to refactor
`GetUserByID` to reuse the user from the context cache. Then it will not
be loaded twice on an HTTP request.
But of course, sometimes we would like to reload an object from the
database, that's why `RemoveContextData` is also exposed.
The core context cache is here. It defines a new context
```go
type cacheContext struct {
ctx context.Context
data map[any]map[any]any
lock sync.RWMutex
}
var cacheContextKey = struct{}{}
func WithCacheContext(ctx context.Context) context.Context {
return context.WithValue(ctx, cacheContextKey, &cacheContext{
ctx: ctx,
data: make(map[any]map[any]any),
})
}
```
Then you can use the below 4 methods to read/write/del the data within
the same context.
```go
func GetContextData(ctx context.Context, tp, key any) any
func SetContextData(ctx context.Context, tp, key, value any)
func RemoveContextData(ctx context.Context, tp, key any)
func GetWithContextCache[T any](ctx context.Context, cacheGroupKey string, cacheTargetID any, f func() (T, error)) (T, error)
```
Then let's take a look at how `system.GetString` implement it.
```go
func GetSetting(ctx context.Context, key string) (string, error) {
return cache.GetWithContextCache(ctx, contextCacheKey, key, func() (string, error) {
return cache.GetString(genSettingCacheKey(key), func() (string, error) {
res, err := GetSettingNoCache(ctx, key)
if err != nil {
return "", err
}
return res.SettingValue, nil
})
})
}
```
First, it will check if context data include the setting object with the
key. If not, it will query from the global cache which may be memory or
a Redis cache. If not, it will get the object from the database. In the
end, if the object gets from the global cache or database, it will be
set into the context cache.
An object stored in the context cache will only be destroyed after the
context disappeared.
2023-02-15 19:07:34 +05:30
|
|
|
"DisableGravatar": func(ctx context.Context) bool {
|
2023-02-24 15:53:13 +05:30
|
|
|
return system_model.GetSettingWithCacheBool(ctx, system_model.KeyPictureDisableGravatar)
|
2016-03-07 03:10:04 +05:30
|
|
|
},
|
2019-05-08 14:11:35 +05:30
|
|
|
"DefaultShowFullName": func() bool {
|
|
|
|
return setting.UI.DefaultShowFullName
|
|
|
|
},
|
2016-09-01 10:31:32 +05:30
|
|
|
"ShowFooterTemplateLoadTime": func() bool {
|
|
|
|
return setting.ShowFooterTemplateLoadTime
|
|
|
|
},
|
2019-12-28 05:13:56 +05:30
|
|
|
"AllowedReactions": func() []string {
|
|
|
|
return setting.UI.Reactions
|
|
|
|
},
|
2021-06-29 19:58:38 +05:30
|
|
|
"CustomEmojis": func() map[string]string {
|
|
|
|
return setting.UI.CustomEmojisMap
|
|
|
|
},
|
2016-03-07 03:10:04 +05:30
|
|
|
"ThemeColorMetaTag": func() string {
|
2016-07-23 21:53:54 +05:30
|
|
|
return setting.UI.ThemeColorMetaTag
|
2016-03-07 03:10:04 +05:30
|
|
|
},
|
2017-04-01 06:33:01 +05:30
|
|
|
"MetaAuthor": func() string {
|
|
|
|
return setting.UI.Meta.Author
|
|
|
|
},
|
|
|
|
"MetaDescription": func() string {
|
|
|
|
return setting.UI.Meta.Description
|
|
|
|
},
|
|
|
|
"MetaKeywords": func() string {
|
|
|
|
return setting.UI.Meta.Keywords
|
|
|
|
},
|
2019-11-22 01:36:23 +05:30
|
|
|
"UseServiceWorker": func() bool {
|
|
|
|
return setting.UI.UseServiceWorker
|
|
|
|
},
|
2021-02-20 04:36:56 +05:30
|
|
|
"EnableTimetracking": func() bool {
|
|
|
|
return setting.Service.EnableTimetracking
|
|
|
|
},
|
2017-09-12 14:55:42 +05:30
|
|
|
"DisableGitHooks": func() bool {
|
|
|
|
return setting.DisableGitHooks
|
|
|
|
},
|
2021-02-11 23:04:34 +05:30
|
|
|
"DisableWebhooks": func() bool {
|
|
|
|
return setting.DisableWebhooks
|
|
|
|
},
|
2018-08-24 10:30:22 +05:30
|
|
|
"DisableImportLocal": func() bool {
|
|
|
|
return !setting.ImportLocalPaths
|
|
|
|
},
|
2018-07-06 02:55:04 +05:30
|
|
|
"DefaultTheme": func() string {
|
|
|
|
return setting.UI.DefaultTheme
|
|
|
|
},
|
2020-07-03 15:25:36 +05:30
|
|
|
"NotificationSettings": func() map[string]interface{} {
|
|
|
|
return map[string]interface{}{
|
2020-05-08 03:19:00 +05:30
|
|
|
"MinTimeout": int(setting.UI.Notification.MinTimeout / time.Millisecond),
|
|
|
|
"TimeoutStep": int(setting.UI.Notification.TimeoutStep / time.Millisecond),
|
|
|
|
"MaxTimeout": int(setting.UI.Notification.MaxTimeout / time.Millisecond),
|
|
|
|
"EventSourceUpdateTime": int(setting.UI.Notification.EventSourceUpdateTime / time.Millisecond),
|
2020-04-24 09:27:38 +05:30
|
|
|
}
|
|
|
|
},
|
2023-04-08 18:45:22 +05:30
|
|
|
"MermaidMaxSourceCharacters": func() int {
|
|
|
|
return setting.MermaidMaxSourceCharacters
|
|
|
|
},
|
2020-11-08 22:51:54 +05:30
|
|
|
|
2023-04-08 18:45:22 +05:30
|
|
|
// -----------------------------------------------------------------
|
|
|
|
// render
|
|
|
|
"RenderCommitMessage": RenderCommitMessage,
|
|
|
|
"RenderCommitMessageLinkSubject": RenderCommitMessageLinkSubject,
|
2020-11-08 22:51:54 +05:30
|
|
|
|
2023-04-08 18:45:22 +05:30
|
|
|
"RenderCommitBody": RenderCommitBody,
|
|
|
|
"RenderCodeBlock": RenderCodeBlock,
|
|
|
|
"RenderIssueTitle": RenderIssueTitle,
|
|
|
|
"RenderEmoji": RenderEmoji,
|
|
|
|
"RenderEmojiPlain": emoji.ReplaceAliases,
|
|
|
|
"ReactionToEmoji": ReactionToEmoji,
|
|
|
|
"RenderNote": RenderNote,
|
2020-06-25 03:53:05 +05:30
|
|
|
|
2023-04-08 18:45:22 +05:30
|
|
|
"RenderMarkdownToHtml": func(ctx context.Context, input string) template.HTML {
|
|
|
|
output, err := markdown.RenderString(&markup.RenderContext{
|
|
|
|
Ctx: ctx,
|
|
|
|
URLPrefix: setting.AppSubURL,
|
|
|
|
}, input)
|
|
|
|
if err != nil {
|
|
|
|
log.Error("RenderString: %v", err)
|
2020-06-25 03:53:05 +05:30
|
|
|
}
|
2023-04-08 18:45:22 +05:30
|
|
|
return template.HTML(output)
|
2020-02-11 22:32:41 +05:30
|
|
|
},
|
2023-03-06 03:29:05 +05:30
|
|
|
"RenderLabel": func(ctx context.Context, label *issues_model.Label) template.HTML {
|
|
|
|
return template.HTML(RenderLabel(ctx, label))
|
Scoped labels (#22585)
Add a new "exclusive" option per label. This makes it so that when the
label is named `scope/name`, no other label with the same `scope/`
prefix can be set on an issue.
The scope is determined by the last occurence of `/`, so for example
`scope/alpha/name` and `scope/beta/name` are considered to be in
different scopes and can coexist.
Exclusive scopes are not enforced by any database rules, however they
are enforced when editing labels at the models level, automatically
removing any existing labels in the same scope when either attaching a
new label or replacing all labels.
In menus use a circle instead of checkbox to indicate they function as
radio buttons per scope. Issue filtering by label ensures that only a
single scoped label is selected at a time. Clicking with alt key can be
used to remove a scoped label, both when editing individual issues and
batch editing.
Label rendering refactor for consistency and code simplification:
* Labels now consistently have the same shape, emojis and tooltips
everywhere. This includes the label list and label assignment menus.
* In label list, show description below label same as label menus.
* Don't use exactly black/white text colors to look a bit nicer.
* Simplify text color computation. There is no point computing luminance
in linear color space, as this is a perceptual problem and sRGB is
closer to perceptually linear.
* Increase height of label assignment menus to show more labels. Showing
only 3-4 labels at a time leads to a lot of scrolling.
* Render all labels with a new RenderLabel template helper function.
Label creation and editing in multiline modal menu:
* Change label creation to open a modal menu like label editing.
* Change menu layout to place name, description and colors on separate
lines.
* Don't color cancel button red in label editing modal menu.
* Align text to the left in model menu for better readability and
consistent with settings layout elsewhere.
Custom exclusive scoped label rendering:
* Display scoped label prefix and suffix with slightly darker and
lighter background color respectively, and a slanted edge between them
similar to the `/` symbol.
* In menus exclusive labels are grouped with a divider line.
---------
Co-authored-by: Yarden Shoham <hrsi88@gmail.com>
Co-authored-by: Lauris BH <lauris@nix.lv>
2023-02-19 00:47:39 +05:30
|
|
|
},
|
2023-03-06 03:29:05 +05:30
|
|
|
"RenderLabels": func(ctx context.Context, labels []*issues_model.Label, repoLink string) template.HTML {
|
2022-09-16 18:14:00 +05:30
|
|
|
htmlCode := `<span class="labels-list">`
|
2020-10-26 03:19:48 +05:30
|
|
|
for _, label := range labels {
|
2021-02-10 08:20:44 +05:30
|
|
|
// Protect against nil value in labels - shouldn't happen but would cause a panic if so
|
|
|
|
if label == nil {
|
|
|
|
continue
|
|
|
|
}
|
Scoped labels (#22585)
Add a new "exclusive" option per label. This makes it so that when the
label is named `scope/name`, no other label with the same `scope/`
prefix can be set on an issue.
The scope is determined by the last occurence of `/`, so for example
`scope/alpha/name` and `scope/beta/name` are considered to be in
different scopes and can coexist.
Exclusive scopes are not enforced by any database rules, however they
are enforced when editing labels at the models level, automatically
removing any existing labels in the same scope when either attaching a
new label or replacing all labels.
In menus use a circle instead of checkbox to indicate they function as
radio buttons per scope. Issue filtering by label ensures that only a
single scoped label is selected at a time. Clicking with alt key can be
used to remove a scoped label, both when editing individual issues and
batch editing.
Label rendering refactor for consistency and code simplification:
* Labels now consistently have the same shape, emojis and tooltips
everywhere. This includes the label list and label assignment menus.
* In label list, show description below label same as label menus.
* Don't use exactly black/white text colors to look a bit nicer.
* Simplify text color computation. There is no point computing luminance
in linear color space, as this is a perceptual problem and sRGB is
closer to perceptually linear.
* Increase height of label assignment menus to show more labels. Showing
only 3-4 labels at a time leads to a lot of scrolling.
* Render all labels with a new RenderLabel template helper function.
Label creation and editing in multiline modal menu:
* Change label creation to open a modal menu like label editing.
* Change menu layout to place name, description and colors on separate
lines.
* Don't color cancel button red in label editing modal menu.
* Align text to the left in model menu for better readability and
consistent with settings layout elsewhere.
Custom exclusive scoped label rendering:
* Display scoped label prefix and suffix with slightly darker and
lighter background color respectively, and a slanted edge between them
similar to the `/` symbol.
* In menus exclusive labels are grouped with a divider line.
---------
Co-authored-by: Yarden Shoham <hrsi88@gmail.com>
Co-authored-by: Lauris BH <lauris@nix.lv>
2023-02-19 00:47:39 +05:30
|
|
|
htmlCode += fmt.Sprintf("<a href='%s/issues?labels=%d'>%s</a> ",
|
2023-03-06 03:29:05 +05:30
|
|
|
repoLink, label.ID, RenderLabel(ctx, label))
|
2020-10-26 03:19:48 +05:30
|
|
|
}
|
2022-09-16 18:14:00 +05:30
|
|
|
htmlCode += "</span>"
|
|
|
|
return template.HTML(htmlCode)
|
2020-10-26 03:19:48 +05:30
|
|
|
},
|
2023-04-08 18:45:22 +05:30
|
|
|
|
|
|
|
// -----------------------------------------------------------------
|
|
|
|
// misc
|
|
|
|
"DiffLineTypeToStr": DiffLineTypeToStr,
|
|
|
|
"ShortSha": base.ShortSha,
|
|
|
|
"ActionContent2Commits": ActionContent2Commits,
|
|
|
|
"IsMultilineCommitMessage": IsMultilineCommitMessage,
|
|
|
|
"CommentMustAsDiff": gitdiff.CommentMustAsDiff,
|
|
|
|
"MirrorRemoteAddress": mirrorRemoteAddress,
|
|
|
|
|
|
|
|
"ParseDeadline": func(deadline string) []string {
|
|
|
|
return strings.Split(deadline, "|")
|
2021-07-24 09:51:51 +05:30
|
|
|
},
|
2023-04-08 18:45:22 +05:30
|
|
|
"FilenameIsImage": func(filename string) bool {
|
|
|
|
mimeType := mime.TypeByExtension(filepath.Ext(filename))
|
|
|
|
return strings.HasPrefix(mimeType, "image/")
|
|
|
|
},
|
|
|
|
"TabSizeClass": func(ec interface{}, filename string) string {
|
|
|
|
var (
|
|
|
|
value *editorconfig.Editorconfig
|
|
|
|
ok bool
|
|
|
|
)
|
|
|
|
if ec != nil {
|
|
|
|
if value, ok = ec.(*editorconfig.Editorconfig); !ok || value == nil {
|
|
|
|
return "tab-size-8"
|
|
|
|
}
|
|
|
|
def, err := value.GetDefinitionForFilename(filename)
|
|
|
|
if err != nil {
|
|
|
|
log.Error("tab size class: getting definition for filename: %v", err)
|
|
|
|
return "tab-size-8"
|
|
|
|
}
|
|
|
|
if def.TabWidth > 0 {
|
|
|
|
return fmt.Sprintf("tab-size-%d", def.TabWidth)
|
|
|
|
}
|
2022-06-08 14:29:16 +05:30
|
|
|
}
|
2023-04-08 18:45:22 +05:30
|
|
|
return "tab-size-8"
|
|
|
|
},
|
|
|
|
"SubJumpablePath": func(str string) []string {
|
|
|
|
var path []string
|
|
|
|
index := strings.LastIndex(str, "/")
|
|
|
|
if index != -1 && index != len(str) {
|
|
|
|
path = append(path, str[0:index+1], str[index+1:])
|
|
|
|
} else {
|
|
|
|
path = append(path, str)
|
|
|
|
}
|
|
|
|
return path
|
2022-06-08 14:29:16 +05:30
|
|
|
},
|
2022-10-21 14:09:26 +05:30
|
|
|
"CompareLink": func(baseRepo, repo *repo_model.Repository, branchName string) string {
|
|
|
|
var curBranch string
|
|
|
|
if repo.ID != baseRepo.ID {
|
|
|
|
curBranch += fmt.Sprintf("%s/%s:", url.PathEscape(repo.OwnerName), url.PathEscape(repo.Name))
|
|
|
|
}
|
|
|
|
curBranch += util.PathEscapeSegments(branchName)
|
|
|
|
|
|
|
|
return fmt.Sprintf("%s/compare/%s...%s",
|
|
|
|
baseRepo.Link(),
|
|
|
|
util.PathEscapeSegments(baseRepo.DefaultBranch),
|
|
|
|
curBranch,
|
|
|
|
)
|
|
|
|
},
|
2019-11-07 19:04:28 +05:30
|
|
|
}}
|
|
|
|
}
|
|
|
|
|
2020-12-09 05:42:15 +05:30
|
|
|
// AvatarHTML creates the HTML for an avatar
|
2021-12-20 10:11:31 +05:30
|
|
|
func AvatarHTML(src string, size int, class, name string) template.HTML {
|
2020-12-04 00:16:11 +05:30
|
|
|
sizeStr := fmt.Sprintf(`%d`, size)
|
|
|
|
|
|
|
|
if name == "" {
|
|
|
|
name = "avatar"
|
2020-09-08 22:47:56 +05:30
|
|
|
}
|
|
|
|
|
2020-12-04 00:16:11 +05:30
|
|
|
return template.HTML(`<img class="` + class + `" src="` + src + `" title="` + html.EscapeString(name) + `" width="` + sizeStr + `" height="` + sizeStr + `"/>`)
|
|
|
|
}
|
|
|
|
|
2020-12-08 09:44:28 +05:30
|
|
|
// Avatar renders user avatars. args: user, size (int), class (string)
|
Add context cache as a request level cache (#22294)
To avoid duplicated load of the same data in an HTTP request, we can set
a context cache to do that. i.e. Some pages may load a user from a
database with the same id in different areas on the same page. But the
code is hidden in two different deep logic. How should we share the
user? As a result of this PR, now if both entry functions accept
`context.Context` as the first parameter and we just need to refactor
`GetUserByID` to reuse the user from the context cache. Then it will not
be loaded twice on an HTTP request.
But of course, sometimes we would like to reload an object from the
database, that's why `RemoveContextData` is also exposed.
The core context cache is here. It defines a new context
```go
type cacheContext struct {
ctx context.Context
data map[any]map[any]any
lock sync.RWMutex
}
var cacheContextKey = struct{}{}
func WithCacheContext(ctx context.Context) context.Context {
return context.WithValue(ctx, cacheContextKey, &cacheContext{
ctx: ctx,
data: make(map[any]map[any]any),
})
}
```
Then you can use the below 4 methods to read/write/del the data within
the same context.
```go
func GetContextData(ctx context.Context, tp, key any) any
func SetContextData(ctx context.Context, tp, key, value any)
func RemoveContextData(ctx context.Context, tp, key any)
func GetWithContextCache[T any](ctx context.Context, cacheGroupKey string, cacheTargetID any, f func() (T, error)) (T, error)
```
Then let's take a look at how `system.GetString` implement it.
```go
func GetSetting(ctx context.Context, key string) (string, error) {
return cache.GetWithContextCache(ctx, contextCacheKey, key, func() (string, error) {
return cache.GetString(genSettingCacheKey(key), func() (string, error) {
res, err := GetSettingNoCache(ctx, key)
if err != nil {
return "", err
}
return res.SettingValue, nil
})
})
}
```
First, it will check if context data include the setting object with the
key. If not, it will query from the global cache which may be memory or
a Redis cache. If not, it will get the object from the database. In the
end, if the object gets from the global cache or database, it will be
set into the context cache.
An object stored in the context cache will only be destroyed after the
context disappeared.
2023-02-15 19:07:34 +05:30
|
|
|
func Avatar(ctx context.Context, item interface{}, others ...interface{}) template.HTML {
|
2022-11-24 03:27:37 +05:30
|
|
|
size, class := gitea_html.ParseSizeAndClass(avatars.DefaultAvatarPixelSize, avatars.DefaultAvatarClass, others...)
|
2020-12-04 00:16:11 +05:30
|
|
|
|
2021-11-24 09:21:08 +05:30
|
|
|
switch t := item.(type) {
|
2021-11-24 15:19:20 +05:30
|
|
|
case *user_model.User:
|
Add context cache as a request level cache (#22294)
To avoid duplicated load of the same data in an HTTP request, we can set
a context cache to do that. i.e. Some pages may load a user from a
database with the same id in different areas on the same page. But the
code is hidden in two different deep logic. How should we share the
user? As a result of this PR, now if both entry functions accept
`context.Context` as the first parameter and we just need to refactor
`GetUserByID` to reuse the user from the context cache. Then it will not
be loaded twice on an HTTP request.
But of course, sometimes we would like to reload an object from the
database, that's why `RemoveContextData` is also exposed.
The core context cache is here. It defines a new context
```go
type cacheContext struct {
ctx context.Context
data map[any]map[any]any
lock sync.RWMutex
}
var cacheContextKey = struct{}{}
func WithCacheContext(ctx context.Context) context.Context {
return context.WithValue(ctx, cacheContextKey, &cacheContext{
ctx: ctx,
data: make(map[any]map[any]any),
})
}
```
Then you can use the below 4 methods to read/write/del the data within
the same context.
```go
func GetContextData(ctx context.Context, tp, key any) any
func SetContextData(ctx context.Context, tp, key, value any)
func RemoveContextData(ctx context.Context, tp, key any)
func GetWithContextCache[T any](ctx context.Context, cacheGroupKey string, cacheTargetID any, f func() (T, error)) (T, error)
```
Then let's take a look at how `system.GetString` implement it.
```go
func GetSetting(ctx context.Context, key string) (string, error) {
return cache.GetWithContextCache(ctx, contextCacheKey, key, func() (string, error) {
return cache.GetString(genSettingCacheKey(key), func() (string, error) {
res, err := GetSettingNoCache(ctx, key)
if err != nil {
return "", err
}
return res.SettingValue, nil
})
})
}
```
First, it will check if context data include the setting object with the
key. If not, it will query from the global cache which may be memory or
a Redis cache. If not, it will get the object from the database. In the
end, if the object gets from the global cache or database, it will be
set into the context cache.
An object stored in the context cache will only be destroyed after the
context disappeared.
2023-02-15 19:07:34 +05:30
|
|
|
src := t.AvatarLinkWithSize(ctx, size*setting.Avatar.RenderedSizeFactor)
|
2020-12-10 11:14:13 +05:30
|
|
|
if src != "" {
|
2021-11-24 09:21:08 +05:30
|
|
|
return AvatarHTML(src, size, class, t.DisplayName())
|
2020-12-10 11:14:13 +05:30
|
|
|
}
|
2022-05-11 15:39:36 +05:30
|
|
|
case *repo_model.Collaborator:
|
Add context cache as a request level cache (#22294)
To avoid duplicated load of the same data in an HTTP request, we can set
a context cache to do that. i.e. Some pages may load a user from a
database with the same id in different areas on the same page. But the
code is hidden in two different deep logic. How should we share the
user? As a result of this PR, now if both entry functions accept
`context.Context` as the first parameter and we just need to refactor
`GetUserByID` to reuse the user from the context cache. Then it will not
be loaded twice on an HTTP request.
But of course, sometimes we would like to reload an object from the
database, that's why `RemoveContextData` is also exposed.
The core context cache is here. It defines a new context
```go
type cacheContext struct {
ctx context.Context
data map[any]map[any]any
lock sync.RWMutex
}
var cacheContextKey = struct{}{}
func WithCacheContext(ctx context.Context) context.Context {
return context.WithValue(ctx, cacheContextKey, &cacheContext{
ctx: ctx,
data: make(map[any]map[any]any),
})
}
```
Then you can use the below 4 methods to read/write/del the data within
the same context.
```go
func GetContextData(ctx context.Context, tp, key any) any
func SetContextData(ctx context.Context, tp, key, value any)
func RemoveContextData(ctx context.Context, tp, key any)
func GetWithContextCache[T any](ctx context.Context, cacheGroupKey string, cacheTargetID any, f func() (T, error)) (T, error)
```
Then let's take a look at how `system.GetString` implement it.
```go
func GetSetting(ctx context.Context, key string) (string, error) {
return cache.GetWithContextCache(ctx, contextCacheKey, key, func() (string, error) {
return cache.GetString(genSettingCacheKey(key), func() (string, error) {
res, err := GetSettingNoCache(ctx, key)
if err != nil {
return "", err
}
return res.SettingValue, nil
})
})
}
```
First, it will check if context data include the setting object with the
key. If not, it will query from the global cache which may be memory or
a Redis cache. If not, it will get the object from the database. In the
end, if the object gets from the global cache or database, it will be
set into the context cache.
An object stored in the context cache will only be destroyed after the
context disappeared.
2023-02-15 19:07:34 +05:30
|
|
|
src := t.AvatarLinkWithSize(ctx, size*setting.Avatar.RenderedSizeFactor)
|
2021-11-24 09:21:08 +05:30
|
|
|
if src != "" {
|
|
|
|
return AvatarHTML(src, size, class, t.DisplayName())
|
|
|
|
}
|
2022-03-29 11:59:02 +05:30
|
|
|
case *organization.Organization:
|
Add context cache as a request level cache (#22294)
To avoid duplicated load of the same data in an HTTP request, we can set
a context cache to do that. i.e. Some pages may load a user from a
database with the same id in different areas on the same page. But the
code is hidden in two different deep logic. How should we share the
user? As a result of this PR, now if both entry functions accept
`context.Context` as the first parameter and we just need to refactor
`GetUserByID` to reuse the user from the context cache. Then it will not
be loaded twice on an HTTP request.
But of course, sometimes we would like to reload an object from the
database, that's why `RemoveContextData` is also exposed.
The core context cache is here. It defines a new context
```go
type cacheContext struct {
ctx context.Context
data map[any]map[any]any
lock sync.RWMutex
}
var cacheContextKey = struct{}{}
func WithCacheContext(ctx context.Context) context.Context {
return context.WithValue(ctx, cacheContextKey, &cacheContext{
ctx: ctx,
data: make(map[any]map[any]any),
})
}
```
Then you can use the below 4 methods to read/write/del the data within
the same context.
```go
func GetContextData(ctx context.Context, tp, key any) any
func SetContextData(ctx context.Context, tp, key, value any)
func RemoveContextData(ctx context.Context, tp, key any)
func GetWithContextCache[T any](ctx context.Context, cacheGroupKey string, cacheTargetID any, f func() (T, error)) (T, error)
```
Then let's take a look at how `system.GetString` implement it.
```go
func GetSetting(ctx context.Context, key string) (string, error) {
return cache.GetWithContextCache(ctx, contextCacheKey, key, func() (string, error) {
return cache.GetString(genSettingCacheKey(key), func() (string, error) {
res, err := GetSettingNoCache(ctx, key)
if err != nil {
return "", err
}
return res.SettingValue, nil
})
})
}
```
First, it will check if context data include the setting object with the
key. If not, it will query from the global cache which may be memory or
a Redis cache. If not, it will get the object from the database. In the
end, if the object gets from the global cache or database, it will be
set into the context cache.
An object stored in the context cache will only be destroyed after the
context disappeared.
2023-02-15 19:07:34 +05:30
|
|
|
src := t.AsUser().AvatarLinkWithSize(ctx, size*setting.Avatar.RenderedSizeFactor)
|
2020-12-10 11:14:13 +05:30
|
|
|
if src != "" {
|
2021-11-24 09:21:08 +05:30
|
|
|
return AvatarHTML(src, size, class, t.AsUser().DisplayName())
|
2020-12-10 11:14:13 +05:30
|
|
|
}
|
2020-12-04 00:16:11 +05:30
|
|
|
}
|
2021-11-24 09:21:08 +05:30
|
|
|
|
2020-12-08 09:44:28 +05:30
|
|
|
return template.HTML("")
|
|
|
|
}
|
|
|
|
|
2020-12-09 10:41:15 +05:30
|
|
|
// AvatarByAction renders user avatars from action. args: action, size (int), class (string)
|
Add context cache as a request level cache (#22294)
To avoid duplicated load of the same data in an HTTP request, we can set
a context cache to do that. i.e. Some pages may load a user from a
database with the same id in different areas on the same page. But the
code is hidden in two different deep logic. How should we share the
user? As a result of this PR, now if both entry functions accept
`context.Context` as the first parameter and we just need to refactor
`GetUserByID` to reuse the user from the context cache. Then it will not
be loaded twice on an HTTP request.
But of course, sometimes we would like to reload an object from the
database, that's why `RemoveContextData` is also exposed.
The core context cache is here. It defines a new context
```go
type cacheContext struct {
ctx context.Context
data map[any]map[any]any
lock sync.RWMutex
}
var cacheContextKey = struct{}{}
func WithCacheContext(ctx context.Context) context.Context {
return context.WithValue(ctx, cacheContextKey, &cacheContext{
ctx: ctx,
data: make(map[any]map[any]any),
})
}
```
Then you can use the below 4 methods to read/write/del the data within
the same context.
```go
func GetContextData(ctx context.Context, tp, key any) any
func SetContextData(ctx context.Context, tp, key, value any)
func RemoveContextData(ctx context.Context, tp, key any)
func GetWithContextCache[T any](ctx context.Context, cacheGroupKey string, cacheTargetID any, f func() (T, error)) (T, error)
```
Then let's take a look at how `system.GetString` implement it.
```go
func GetSetting(ctx context.Context, key string) (string, error) {
return cache.GetWithContextCache(ctx, contextCacheKey, key, func() (string, error) {
return cache.GetString(genSettingCacheKey(key), func() (string, error) {
res, err := GetSettingNoCache(ctx, key)
if err != nil {
return "", err
}
return res.SettingValue, nil
})
})
}
```
First, it will check if context data include the setting object with the
key. If not, it will query from the global cache which may be memory or
a Redis cache. If not, it will get the object from the database. In the
end, if the object gets from the global cache or database, it will be
set into the context cache.
An object stored in the context cache will only be destroyed after the
context disappeared.
2023-02-15 19:07:34 +05:30
|
|
|
func AvatarByAction(ctx context.Context, action *activities_model.Action, others ...interface{}) template.HTML {
|
|
|
|
action.LoadActUser(ctx)
|
|
|
|
return Avatar(ctx, action.ActUser, others...)
|
2020-12-09 10:41:15 +05:30
|
|
|
}
|
|
|
|
|
2020-12-08 09:44:28 +05:30
|
|
|
// RepoAvatar renders repo avatars. args: repo, size(int), class (string)
|
2021-12-10 06:57:50 +05:30
|
|
|
func RepoAvatar(repo *repo_model.Repository, others ...interface{}) template.HTML {
|
2022-11-24 03:27:37 +05:30
|
|
|
size, class := gitea_html.ParseSizeAndClass(avatars.DefaultAvatarPixelSize, avatars.DefaultAvatarClass, others...)
|
2020-12-04 00:16:11 +05:30
|
|
|
|
2020-12-08 09:44:28 +05:30
|
|
|
src := repo.RelAvatarLink()
|
|
|
|
if src != "" {
|
2020-12-09 05:42:15 +05:30
|
|
|
return AvatarHTML(src, size, class, repo.FullName())
|
2020-12-08 09:44:28 +05:30
|
|
|
}
|
2020-12-04 00:16:11 +05:30
|
|
|
return template.HTML("")
|
|
|
|
}
|
|
|
|
|
|
|
|
// AvatarByEmail renders avatars by email address. args: email, name, size (int), class (string)
|
Add context cache as a request level cache (#22294)
To avoid duplicated load of the same data in an HTTP request, we can set
a context cache to do that. i.e. Some pages may load a user from a
database with the same id in different areas on the same page. But the
code is hidden in two different deep logic. How should we share the
user? As a result of this PR, now if both entry functions accept
`context.Context` as the first parameter and we just need to refactor
`GetUserByID` to reuse the user from the context cache. Then it will not
be loaded twice on an HTTP request.
But of course, sometimes we would like to reload an object from the
database, that's why `RemoveContextData` is also exposed.
The core context cache is here. It defines a new context
```go
type cacheContext struct {
ctx context.Context
data map[any]map[any]any
lock sync.RWMutex
}
var cacheContextKey = struct{}{}
func WithCacheContext(ctx context.Context) context.Context {
return context.WithValue(ctx, cacheContextKey, &cacheContext{
ctx: ctx,
data: make(map[any]map[any]any),
})
}
```
Then you can use the below 4 methods to read/write/del the data within
the same context.
```go
func GetContextData(ctx context.Context, tp, key any) any
func SetContextData(ctx context.Context, tp, key, value any)
func RemoveContextData(ctx context.Context, tp, key any)
func GetWithContextCache[T any](ctx context.Context, cacheGroupKey string, cacheTargetID any, f func() (T, error)) (T, error)
```
Then let's take a look at how `system.GetString` implement it.
```go
func GetSetting(ctx context.Context, key string) (string, error) {
return cache.GetWithContextCache(ctx, contextCacheKey, key, func() (string, error) {
return cache.GetString(genSettingCacheKey(key), func() (string, error) {
res, err := GetSettingNoCache(ctx, key)
if err != nil {
return "", err
}
return res.SettingValue, nil
})
})
}
```
First, it will check if context data include the setting object with the
key. If not, it will query from the global cache which may be memory or
a Redis cache. If not, it will get the object from the database. In the
end, if the object gets from the global cache or database, it will be
set into the context cache.
An object stored in the context cache will only be destroyed after the
context disappeared.
2023-02-15 19:07:34 +05:30
|
|
|
func AvatarByEmail(ctx context.Context, email, name string, others ...interface{}) template.HTML {
|
2022-11-24 03:27:37 +05:30
|
|
|
size, class := gitea_html.ParseSizeAndClass(avatars.DefaultAvatarPixelSize, avatars.DefaultAvatarClass, others...)
|
Add context cache as a request level cache (#22294)
To avoid duplicated load of the same data in an HTTP request, we can set
a context cache to do that. i.e. Some pages may load a user from a
database with the same id in different areas on the same page. But the
code is hidden in two different deep logic. How should we share the
user? As a result of this PR, now if both entry functions accept
`context.Context` as the first parameter and we just need to refactor
`GetUserByID` to reuse the user from the context cache. Then it will not
be loaded twice on an HTTP request.
But of course, sometimes we would like to reload an object from the
database, that's why `RemoveContextData` is also exposed.
The core context cache is here. It defines a new context
```go
type cacheContext struct {
ctx context.Context
data map[any]map[any]any
lock sync.RWMutex
}
var cacheContextKey = struct{}{}
func WithCacheContext(ctx context.Context) context.Context {
return context.WithValue(ctx, cacheContextKey, &cacheContext{
ctx: ctx,
data: make(map[any]map[any]any),
})
}
```
Then you can use the below 4 methods to read/write/del the data within
the same context.
```go
func GetContextData(ctx context.Context, tp, key any) any
func SetContextData(ctx context.Context, tp, key, value any)
func RemoveContextData(ctx context.Context, tp, key any)
func GetWithContextCache[T any](ctx context.Context, cacheGroupKey string, cacheTargetID any, f func() (T, error)) (T, error)
```
Then let's take a look at how `system.GetString` implement it.
```go
func GetSetting(ctx context.Context, key string) (string, error) {
return cache.GetWithContextCache(ctx, contextCacheKey, key, func() (string, error) {
return cache.GetString(genSettingCacheKey(key), func() (string, error) {
res, err := GetSettingNoCache(ctx, key)
if err != nil {
return "", err
}
return res.SettingValue, nil
})
})
}
```
First, it will check if context data include the setting object with the
key. If not, it will query from the global cache which may be memory or
a Redis cache. If not, it will get the object from the database. In the
end, if the object gets from the global cache or database, it will be
set into the context cache.
An object stored in the context cache will only be destroyed after the
context disappeared.
2023-02-15 19:07:34 +05:30
|
|
|
src := avatars.GenerateEmailAvatarFastLink(ctx, email, size*setting.Avatar.RenderedSizeFactor)
|
2020-12-04 00:16:11 +05:30
|
|
|
|
|
|
|
if src != "" {
|
2020-12-09 05:42:15 +05:30
|
|
|
return AvatarHTML(src, size, class, name)
|
2020-12-04 00:16:11 +05:30
|
|
|
}
|
|
|
|
|
|
|
|
return template.HTML("")
|
|
|
|
}
|
|
|
|
|
2016-11-25 11:53:48 +05:30
|
|
|
// Safe render raw as HTML
|
2015-08-08 14:40:34 +05:30
|
|
|
func Safe(raw string) template.HTML {
|
|
|
|
return template.HTML(raw)
|
|
|
|
}
|
|
|
|
|
2016-11-25 11:53:48 +05:30
|
|
|
// Str2html render Markdown text to HTML
|
2014-04-10 23:50:58 +05:30
|
|
|
func Str2html(raw string) template.HTML {
|
2017-09-16 22:47:57 +05:30
|
|
|
return template.HTML(markup.Sanitize(raw))
|
2014-04-10 23:50:58 +05:30
|
|
|
}
|
|
|
|
|
2022-03-23 18:04:20 +05:30
|
|
|
// DotEscape wraps a dots in names with ZWJ [U+200D] in order to prevent autolinkers from detecting these as urls
|
|
|
|
func DotEscape(raw string) string {
|
|
|
|
return strings.ReplaceAll(raw, ".", "\u200d.\u200d")
|
|
|
|
}
|
|
|
|
|
2015-01-31 04:35:20 +05:30
|
|
|
// RenderCommitMessage renders commit message with XSS-safe and special links.
|
2022-01-20 04:56:57 +05:30
|
|
|
func RenderCommitMessage(ctx context.Context, msg, urlPrefix string, metas map[string]string) template.HTML {
|
|
|
|
return RenderCommitMessageLink(ctx, msg, urlPrefix, "", metas)
|
2017-11-13 07:05:55 +05:30
|
|
|
}
|
|
|
|
|
|
|
|
// RenderCommitMessageLink renders commit message as a XXS-safe link to the provided
|
|
|
|
// default url, handling for special links.
|
2022-01-20 04:56:57 +05:30
|
|
|
func RenderCommitMessageLink(ctx context.Context, msg, urlPrefix, urlDefault string, metas map[string]string) template.HTML {
|
2015-09-19 07:27:06 +05:30
|
|
|
cleanMsg := template.HTMLEscapeString(msg)
|
2018-02-27 12:39:18 +05:30
|
|
|
// we can safely assume that it will not return any error, since there
|
|
|
|
// shouldn't be any special HTML.
|
2021-04-20 03:55:08 +05:30
|
|
|
fullMessage, err := markup.RenderCommitMessage(&markup.RenderContext{
|
2022-01-20 04:56:57 +05:30
|
|
|
Ctx: ctx,
|
2021-04-20 03:55:08 +05:30
|
|
|
URLPrefix: urlPrefix,
|
|
|
|
DefaultLink: urlDefault,
|
|
|
|
Metas: metas,
|
|
|
|
}, cleanMsg)
|
2018-02-27 12:39:18 +05:30
|
|
|
if err != nil {
|
2019-04-02 13:18:31 +05:30
|
|
|
log.Error("RenderCommitMessage: %v", err)
|
2018-02-27 12:39:18 +05:30
|
|
|
return ""
|
|
|
|
}
|
2022-06-20 15:32:49 +05:30
|
|
|
msgLines := strings.Split(strings.TrimSpace(fullMessage), "\n")
|
2017-11-13 07:05:55 +05:30
|
|
|
if len(msgLines) == 0 {
|
2015-12-07 04:48:12 +05:30
|
|
|
return template.HTML("")
|
2015-09-19 07:27:06 +05:30
|
|
|
}
|
2017-11-13 07:05:55 +05:30
|
|
|
return template.HTML(msgLines[0])
|
2015-01-31 04:35:20 +05:30
|
|
|
}
|
|
|
|
|
2019-09-10 14:33:30 +05:30
|
|
|
// RenderCommitMessageLinkSubject renders commit message as a XXS-safe link to
|
|
|
|
// the provided default url, handling for special links without email to links.
|
2022-01-20 04:56:57 +05:30
|
|
|
func RenderCommitMessageLinkSubject(ctx context.Context, msg, urlPrefix, urlDefault string, metas map[string]string) template.HTML {
|
2019-11-01 10:18:30 +05:30
|
|
|
msgLine := strings.TrimLeftFunc(msg, unicode.IsSpace)
|
|
|
|
lineEnd := strings.IndexByte(msgLine, '\n')
|
|
|
|
if lineEnd > 0 {
|
|
|
|
msgLine = msgLine[:lineEnd]
|
|
|
|
}
|
|
|
|
msgLine = strings.TrimRightFunc(msgLine, unicode.IsSpace)
|
|
|
|
if len(msgLine) == 0 {
|
|
|
|
return template.HTML("")
|
|
|
|
}
|
|
|
|
|
2019-09-10 14:33:30 +05:30
|
|
|
// we can safely assume that it will not return any error, since there
|
|
|
|
// shouldn't be any special HTML.
|
2021-04-20 03:55:08 +05:30
|
|
|
renderedMessage, err := markup.RenderCommitMessageSubject(&markup.RenderContext{
|
2022-01-20 04:56:57 +05:30
|
|
|
Ctx: ctx,
|
2021-04-20 03:55:08 +05:30
|
|
|
URLPrefix: urlPrefix,
|
|
|
|
DefaultLink: urlDefault,
|
|
|
|
Metas: metas,
|
|
|
|
}, template.HTMLEscapeString(msgLine))
|
2019-09-10 14:33:30 +05:30
|
|
|
if err != nil {
|
|
|
|
log.Error("RenderCommitMessageSubject: %v", err)
|
|
|
|
return template.HTML("")
|
|
|
|
}
|
2019-11-01 10:18:30 +05:30
|
|
|
return template.HTML(renderedMessage)
|
2019-09-10 14:33:30 +05:30
|
|
|
}
|
|
|
|
|
2017-11-30 10:38:40 +05:30
|
|
|
// RenderCommitBody extracts the body of a commit message without its title.
|
2022-01-20 04:56:57 +05:30
|
|
|
func RenderCommitBody(ctx context.Context, msg, urlPrefix string, metas map[string]string) template.HTML {
|
2019-11-01 10:18:30 +05:30
|
|
|
msgLine := strings.TrimRightFunc(msg, unicode.IsSpace)
|
|
|
|
lineEnd := strings.IndexByte(msgLine, '\n')
|
|
|
|
if lineEnd > 0 {
|
|
|
|
msgLine = msgLine[lineEnd+1:]
|
|
|
|
} else {
|
|
|
|
return template.HTML("")
|
|
|
|
}
|
|
|
|
msgLine = strings.TrimLeftFunc(msgLine, unicode.IsSpace)
|
|
|
|
if len(msgLine) == 0 {
|
|
|
|
return template.HTML("")
|
|
|
|
}
|
|
|
|
|
2021-04-20 03:55:08 +05:30
|
|
|
renderedMessage, err := markup.RenderCommitMessage(&markup.RenderContext{
|
2022-01-20 04:56:57 +05:30
|
|
|
Ctx: ctx,
|
2021-04-20 03:55:08 +05:30
|
|
|
URLPrefix: urlPrefix,
|
|
|
|
Metas: metas,
|
|
|
|
}, template.HTMLEscapeString(msgLine))
|
2018-02-27 12:39:18 +05:30
|
|
|
if err != nil {
|
2019-04-02 13:18:31 +05:30
|
|
|
log.Error("RenderCommitMessage: %v", err)
|
2018-02-27 12:39:18 +05:30
|
|
|
return ""
|
|
|
|
}
|
2019-11-01 10:18:30 +05:30
|
|
|
return template.HTML(renderedMessage)
|
2017-11-30 10:38:40 +05:30
|
|
|
}
|
|
|
|
|
2022-10-15 23:54:41 +05:30
|
|
|
// Match text that is between back ticks.
|
|
|
|
var codeMatcher = regexp.MustCompile("`([^`]+)`")
|
|
|
|
|
|
|
|
// RenderCodeBlock renders "`…`" as highlighted "<code>" block.
|
|
|
|
// Intended for issue and PR titles, these containers should have styles for "<code>" elements
|
|
|
|
func RenderCodeBlock(htmlEscapedTextToRender template.HTML) template.HTML {
|
|
|
|
htmlWithCodeTags := codeMatcher.ReplaceAllString(string(htmlEscapedTextToRender), "<code>$1</code>") // replace with HTML <code> tags
|
|
|
|
return template.HTML(htmlWithCodeTags)
|
|
|
|
}
|
|
|
|
|
2020-12-03 16:20:47 +05:30
|
|
|
// RenderIssueTitle renders issue/pull title with defined post processors
|
2022-01-20 04:56:57 +05:30
|
|
|
func RenderIssueTitle(ctx context.Context, text, urlPrefix string, metas map[string]string) template.HTML {
|
2021-04-20 03:55:08 +05:30
|
|
|
renderedText, err := markup.RenderIssueTitle(&markup.RenderContext{
|
2022-01-20 04:56:57 +05:30
|
|
|
Ctx: ctx,
|
2021-04-20 03:55:08 +05:30
|
|
|
URLPrefix: urlPrefix,
|
|
|
|
Metas: metas,
|
|
|
|
}, template.HTMLEscapeString(text))
|
2020-12-03 16:20:47 +05:30
|
|
|
if err != nil {
|
|
|
|
log.Error("RenderIssueTitle: %v", err)
|
|
|
|
return template.HTML("")
|
|
|
|
}
|
|
|
|
return template.HTML(renderedText)
|
|
|
|
}
|
|
|
|
|
Scoped labels (#22585)
Add a new "exclusive" option per label. This makes it so that when the
label is named `scope/name`, no other label with the same `scope/`
prefix can be set on an issue.
The scope is determined by the last occurence of `/`, so for example
`scope/alpha/name` and `scope/beta/name` are considered to be in
different scopes and can coexist.
Exclusive scopes are not enforced by any database rules, however they
are enforced when editing labels at the models level, automatically
removing any existing labels in the same scope when either attaching a
new label or replacing all labels.
In menus use a circle instead of checkbox to indicate they function as
radio buttons per scope. Issue filtering by label ensures that only a
single scoped label is selected at a time. Clicking with alt key can be
used to remove a scoped label, both when editing individual issues and
batch editing.
Label rendering refactor for consistency and code simplification:
* Labels now consistently have the same shape, emojis and tooltips
everywhere. This includes the label list and label assignment menus.
* In label list, show description below label same as label menus.
* Don't use exactly black/white text colors to look a bit nicer.
* Simplify text color computation. There is no point computing luminance
in linear color space, as this is a perceptual problem and sRGB is
closer to perceptually linear.
* Increase height of label assignment menus to show more labels. Showing
only 3-4 labels at a time leads to a lot of scrolling.
* Render all labels with a new RenderLabel template helper function.
Label creation and editing in multiline modal menu:
* Change label creation to open a modal menu like label editing.
* Change menu layout to place name, description and colors on separate
lines.
* Don't color cancel button red in label editing modal menu.
* Align text to the left in model menu for better readability and
consistent with settings layout elsewhere.
Custom exclusive scoped label rendering:
* Display scoped label prefix and suffix with slightly darker and
lighter background color respectively, and a slanted edge between them
similar to the `/` symbol.
* In menus exclusive labels are grouped with a divider line.
---------
Co-authored-by: Yarden Shoham <hrsi88@gmail.com>
Co-authored-by: Lauris BH <lauris@nix.lv>
2023-02-19 00:47:39 +05:30
|
|
|
// RenderLabel renders a label
|
2023-03-06 03:29:05 +05:30
|
|
|
func RenderLabel(ctx context.Context, label *issues_model.Label) string {
|
Scoped labels (#22585)
Add a new "exclusive" option per label. This makes it so that when the
label is named `scope/name`, no other label with the same `scope/`
prefix can be set on an issue.
The scope is determined by the last occurence of `/`, so for example
`scope/alpha/name` and `scope/beta/name` are considered to be in
different scopes and can coexist.
Exclusive scopes are not enforced by any database rules, however they
are enforced when editing labels at the models level, automatically
removing any existing labels in the same scope when either attaching a
new label or replacing all labels.
In menus use a circle instead of checkbox to indicate they function as
radio buttons per scope. Issue filtering by label ensures that only a
single scoped label is selected at a time. Clicking with alt key can be
used to remove a scoped label, both when editing individual issues and
batch editing.
Label rendering refactor for consistency and code simplification:
* Labels now consistently have the same shape, emojis and tooltips
everywhere. This includes the label list and label assignment menus.
* In label list, show description below label same as label menus.
* Don't use exactly black/white text colors to look a bit nicer.
* Simplify text color computation. There is no point computing luminance
in linear color space, as this is a perceptual problem and sRGB is
closer to perceptually linear.
* Increase height of label assignment menus to show more labels. Showing
only 3-4 labels at a time leads to a lot of scrolling.
* Render all labels with a new RenderLabel template helper function.
Label creation and editing in multiline modal menu:
* Change label creation to open a modal menu like label editing.
* Change menu layout to place name, description and colors on separate
lines.
* Don't color cancel button red in label editing modal menu.
* Align text to the left in model menu for better readability and
consistent with settings layout elsewhere.
Custom exclusive scoped label rendering:
* Display scoped label prefix and suffix with slightly darker and
lighter background color respectively, and a slanted edge between them
similar to the `/` symbol.
* In menus exclusive labels are grouped with a divider line.
---------
Co-authored-by: Yarden Shoham <hrsi88@gmail.com>
Co-authored-by: Lauris BH <lauris@nix.lv>
2023-02-19 00:47:39 +05:30
|
|
|
labelScope := label.ExclusiveScope()
|
|
|
|
|
|
|
|
textColor := "#111"
|
|
|
|
if label.UseLightTextColor() {
|
|
|
|
textColor = "#eee"
|
|
|
|
}
|
|
|
|
|
|
|
|
description := emoji.ReplaceAliases(template.HTMLEscapeString(label.Description))
|
|
|
|
|
|
|
|
if labelScope == "" {
|
|
|
|
// Regular label
|
|
|
|
return fmt.Sprintf("<div class='ui label' style='color: %s !important; background-color: %s !important' title='%s'>%s</div>",
|
2023-03-06 03:29:05 +05:30
|
|
|
textColor, label.Color, description, RenderEmoji(ctx, label.Name))
|
Scoped labels (#22585)
Add a new "exclusive" option per label. This makes it so that when the
label is named `scope/name`, no other label with the same `scope/`
prefix can be set on an issue.
The scope is determined by the last occurence of `/`, so for example
`scope/alpha/name` and `scope/beta/name` are considered to be in
different scopes and can coexist.
Exclusive scopes are not enforced by any database rules, however they
are enforced when editing labels at the models level, automatically
removing any existing labels in the same scope when either attaching a
new label or replacing all labels.
In menus use a circle instead of checkbox to indicate they function as
radio buttons per scope. Issue filtering by label ensures that only a
single scoped label is selected at a time. Clicking with alt key can be
used to remove a scoped label, both when editing individual issues and
batch editing.
Label rendering refactor for consistency and code simplification:
* Labels now consistently have the same shape, emojis and tooltips
everywhere. This includes the label list and label assignment menus.
* In label list, show description below label same as label menus.
* Don't use exactly black/white text colors to look a bit nicer.
* Simplify text color computation. There is no point computing luminance
in linear color space, as this is a perceptual problem and sRGB is
closer to perceptually linear.
* Increase height of label assignment menus to show more labels. Showing
only 3-4 labels at a time leads to a lot of scrolling.
* Render all labels with a new RenderLabel template helper function.
Label creation and editing in multiline modal menu:
* Change label creation to open a modal menu like label editing.
* Change menu layout to place name, description and colors on separate
lines.
* Don't color cancel button red in label editing modal menu.
* Align text to the left in model menu for better readability and
consistent with settings layout elsewhere.
Custom exclusive scoped label rendering:
* Display scoped label prefix and suffix with slightly darker and
lighter background color respectively, and a slanted edge between them
similar to the `/` symbol.
* In menus exclusive labels are grouped with a divider line.
---------
Co-authored-by: Yarden Shoham <hrsi88@gmail.com>
Co-authored-by: Lauris BH <lauris@nix.lv>
2023-02-19 00:47:39 +05:30
|
|
|
}
|
|
|
|
|
|
|
|
// Scoped label
|
2023-03-06 03:29:05 +05:30
|
|
|
scopeText := RenderEmoji(ctx, labelScope)
|
|
|
|
itemText := RenderEmoji(ctx, label.Name[len(labelScope)+1:])
|
Scoped labels (#22585)
Add a new "exclusive" option per label. This makes it so that when the
label is named `scope/name`, no other label with the same `scope/`
prefix can be set on an issue.
The scope is determined by the last occurence of `/`, so for example
`scope/alpha/name` and `scope/beta/name` are considered to be in
different scopes and can coexist.
Exclusive scopes are not enforced by any database rules, however they
are enforced when editing labels at the models level, automatically
removing any existing labels in the same scope when either attaching a
new label or replacing all labels.
In menus use a circle instead of checkbox to indicate they function as
radio buttons per scope. Issue filtering by label ensures that only a
single scoped label is selected at a time. Clicking with alt key can be
used to remove a scoped label, both when editing individual issues and
batch editing.
Label rendering refactor for consistency and code simplification:
* Labels now consistently have the same shape, emojis and tooltips
everywhere. This includes the label list and label assignment menus.
* In label list, show description below label same as label menus.
* Don't use exactly black/white text colors to look a bit nicer.
* Simplify text color computation. There is no point computing luminance
in linear color space, as this is a perceptual problem and sRGB is
closer to perceptually linear.
* Increase height of label assignment menus to show more labels. Showing
only 3-4 labels at a time leads to a lot of scrolling.
* Render all labels with a new RenderLabel template helper function.
Label creation and editing in multiline modal menu:
* Change label creation to open a modal menu like label editing.
* Change menu layout to place name, description and colors on separate
lines.
* Don't color cancel button red in label editing modal menu.
* Align text to the left in model menu for better readability and
consistent with settings layout elsewhere.
Custom exclusive scoped label rendering:
* Display scoped label prefix and suffix with slightly darker and
lighter background color respectively, and a slanted edge between them
similar to the `/` symbol.
* In menus exclusive labels are grouped with a divider line.
---------
Co-authored-by: Yarden Shoham <hrsi88@gmail.com>
Co-authored-by: Lauris BH <lauris@nix.lv>
2023-02-19 00:47:39 +05:30
|
|
|
|
|
|
|
itemColor := label.Color
|
|
|
|
scopeColor := label.Color
|
|
|
|
if r, g, b, err := label.ColorRGB(); err == nil {
|
|
|
|
// Make scope and item background colors slightly darker and lighter respectively.
|
|
|
|
// More contrast needed with higher luminance, empirically tweaked.
|
|
|
|
luminance := (0.299*r + 0.587*g + 0.114*b) / 255
|
2023-03-13 06:16:13 +05:30
|
|
|
contrast := 0.01 + luminance*0.03
|
Scoped labels (#22585)
Add a new "exclusive" option per label. This makes it so that when the
label is named `scope/name`, no other label with the same `scope/`
prefix can be set on an issue.
The scope is determined by the last occurence of `/`, so for example
`scope/alpha/name` and `scope/beta/name` are considered to be in
different scopes and can coexist.
Exclusive scopes are not enforced by any database rules, however they
are enforced when editing labels at the models level, automatically
removing any existing labels in the same scope when either attaching a
new label or replacing all labels.
In menus use a circle instead of checkbox to indicate they function as
radio buttons per scope. Issue filtering by label ensures that only a
single scoped label is selected at a time. Clicking with alt key can be
used to remove a scoped label, both when editing individual issues and
batch editing.
Label rendering refactor for consistency and code simplification:
* Labels now consistently have the same shape, emojis and tooltips
everywhere. This includes the label list and label assignment menus.
* In label list, show description below label same as label menus.
* Don't use exactly black/white text colors to look a bit nicer.
* Simplify text color computation. There is no point computing luminance
in linear color space, as this is a perceptual problem and sRGB is
closer to perceptually linear.
* Increase height of label assignment menus to show more labels. Showing
only 3-4 labels at a time leads to a lot of scrolling.
* Render all labels with a new RenderLabel template helper function.
Label creation and editing in multiline modal menu:
* Change label creation to open a modal menu like label editing.
* Change menu layout to place name, description and colors on separate
lines.
* Don't color cancel button red in label editing modal menu.
* Align text to the left in model menu for better readability and
consistent with settings layout elsewhere.
Custom exclusive scoped label rendering:
* Display scoped label prefix and suffix with slightly darker and
lighter background color respectively, and a slanted edge between them
similar to the `/` symbol.
* In menus exclusive labels are grouped with a divider line.
---------
Co-authored-by: Yarden Shoham <hrsi88@gmail.com>
Co-authored-by: Lauris BH <lauris@nix.lv>
2023-02-19 00:47:39 +05:30
|
|
|
// Ensure we add the same amount of contrast also near 0 and 1.
|
|
|
|
darken := contrast + math.Max(luminance+contrast-1.0, 0.0)
|
|
|
|
lighten := contrast + math.Max(contrast-luminance, 0.0)
|
|
|
|
// Compute factor to keep RGB values proportional.
|
|
|
|
darkenFactor := math.Max(luminance-darken, 0.0) / math.Max(luminance, 1.0/255.0)
|
|
|
|
lightenFactor := math.Min(luminance+lighten, 1.0) / math.Max(luminance, 1.0/255.0)
|
|
|
|
|
|
|
|
scopeBytes := []byte{
|
|
|
|
uint8(math.Min(math.Round(r*darkenFactor), 255)),
|
|
|
|
uint8(math.Min(math.Round(g*darkenFactor), 255)),
|
|
|
|
uint8(math.Min(math.Round(b*darkenFactor), 255)),
|
|
|
|
}
|
|
|
|
itemBytes := []byte{
|
|
|
|
uint8(math.Min(math.Round(r*lightenFactor), 255)),
|
|
|
|
uint8(math.Min(math.Round(g*lightenFactor), 255)),
|
|
|
|
uint8(math.Min(math.Round(b*lightenFactor), 255)),
|
|
|
|
}
|
|
|
|
|
|
|
|
itemColor = "#" + hex.EncodeToString(itemBytes)
|
|
|
|
scopeColor = "#" + hex.EncodeToString(scopeBytes)
|
|
|
|
}
|
|
|
|
|
|
|
|
return fmt.Sprintf("<span class='ui label scope-parent' title='%s'>"+
|
|
|
|
"<div class='ui label scope-left' style='color: %s !important; background-color: %s !important'>%s</div>"+
|
|
|
|
"<div class='ui label scope-right' style='color: %s !important; background-color: %s !important''>%s</div>"+
|
|
|
|
"</span>",
|
|
|
|
description,
|
|
|
|
textColor, scopeColor, scopeText,
|
|
|
|
textColor, itemColor, itemText)
|
|
|
|
}
|
|
|
|
|
2020-04-28 23:35:39 +05:30
|
|
|
// RenderEmoji renders html text with emoji post processors
|
2023-03-06 03:29:05 +05:30
|
|
|
func RenderEmoji(ctx context.Context, text string) template.HTML {
|
|
|
|
renderedText, err := markup.RenderEmoji(&markup.RenderContext{Ctx: ctx},
|
|
|
|
template.HTMLEscapeString(text))
|
2020-04-28 23:35:39 +05:30
|
|
|
if err != nil {
|
|
|
|
log.Error("RenderEmoji: %v", err)
|
|
|
|
return template.HTML("")
|
|
|
|
}
|
|
|
|
return template.HTML(renderedText)
|
|
|
|
}
|
|
|
|
|
2022-01-20 23:16:10 +05:30
|
|
|
// ReactionToEmoji renders emoji for use in reactions
|
2020-04-28 23:35:39 +05:30
|
|
|
func ReactionToEmoji(reaction string) template.HTML {
|
|
|
|
val := emoji.FromCode(reaction)
|
|
|
|
if val != nil {
|
|
|
|
return template.HTML(val.Emoji)
|
|
|
|
}
|
|
|
|
val = emoji.FromAlias(reaction)
|
|
|
|
if val != nil {
|
|
|
|
return template.HTML(val.Emoji)
|
|
|
|
}
|
2021-11-16 23:48:25 +05:30
|
|
|
return template.HTML(fmt.Sprintf(`<img alt=":%s:" src="%s/assets/img/emoji/%s.png"></img>`, reaction, setting.StaticURLPrefix, url.PathEscape(reaction)))
|
2020-04-28 23:35:39 +05:30
|
|
|
}
|
|
|
|
|
2019-05-24 13:22:05 +05:30
|
|
|
// RenderNote renders the contents of a git-notes file as a commit message.
|
2022-01-20 04:56:57 +05:30
|
|
|
func RenderNote(ctx context.Context, msg, urlPrefix string, metas map[string]string) template.HTML {
|
2019-05-24 13:22:05 +05:30
|
|
|
cleanMsg := template.HTMLEscapeString(msg)
|
2021-04-20 03:55:08 +05:30
|
|
|
fullMessage, err := markup.RenderCommitMessage(&markup.RenderContext{
|
2022-01-20 04:56:57 +05:30
|
|
|
Ctx: ctx,
|
2021-04-20 03:55:08 +05:30
|
|
|
URLPrefix: urlPrefix,
|
|
|
|
Metas: metas,
|
|
|
|
}, cleanMsg)
|
2019-05-24 13:22:05 +05:30
|
|
|
if err != nil {
|
|
|
|
log.Error("RenderNote: %v", err)
|
|
|
|
return ""
|
|
|
|
}
|
2022-06-20 15:32:49 +05:30
|
|
|
return template.HTML(fullMessage)
|
2019-05-24 13:22:05 +05:30
|
|
|
}
|
|
|
|
|
2017-11-30 10:38:40 +05:30
|
|
|
// IsMultilineCommitMessage checks to see if a commit message contains multiple lines.
|
|
|
|
func IsMultilineCommitMessage(msg string) bool {
|
2018-06-15 19:37:48 +05:30
|
|
|
return strings.Count(strings.TrimSpace(msg), "\n") >= 1
|
2017-11-30 10:38:40 +05:30
|
|
|
}
|
|
|
|
|
2016-11-25 11:53:48 +05:30
|
|
|
// Actioner describes an action
|
2014-04-10 23:50:58 +05:30
|
|
|
type Actioner interface {
|
2022-08-25 08:01:57 +05:30
|
|
|
GetOpType() activities_model.ActionType
|
2014-04-10 23:50:58 +05:30
|
|
|
GetActUserName() string
|
2014-05-09 12:12:50 +05:30
|
|
|
GetRepoUserName() string
|
2014-04-10 23:50:58 +05:30
|
|
|
GetRepoName() string
|
2015-09-01 18:59:52 +05:30
|
|
|
GetRepoPath() string
|
|
|
|
GetRepoLink() string
|
2014-04-10 23:50:58 +05:30
|
|
|
GetBranch() string
|
|
|
|
GetContent() string
|
2015-09-01 18:59:52 +05:30
|
|
|
GetCreate() time.Time
|
|
|
|
GetIssueInfos() []string
|
2014-04-10 23:50:58 +05:30
|
|
|
}
|
|
|
|
|
2017-09-20 06:52:42 +05:30
|
|
|
// ActionIcon accepts an action operation type and returns an icon class name.
|
2022-08-25 08:01:57 +05:30
|
|
|
func ActionIcon(opType activities_model.ActionType) string {
|
2014-04-10 23:50:58 +05:30
|
|
|
switch opType {
|
2022-08-25 08:01:57 +05:30
|
|
|
case activities_model.ActionCreateRepo, activities_model.ActionTransferRepo, activities_model.ActionRenameRepo:
|
2014-07-26 09:54:27 +05:30
|
|
|
return "repo"
|
2022-08-25 08:01:57 +05:30
|
|
|
case activities_model.ActionCommitRepo, activities_model.ActionPushTag, activities_model.ActionDeleteTag, activities_model.ActionDeleteBranch:
|
2014-07-26 09:54:27 +05:30
|
|
|
return "git-commit"
|
2022-08-25 08:01:57 +05:30
|
|
|
case activities_model.ActionCreateIssue:
|
2014-07-26 09:54:27 +05:30
|
|
|
return "issue-opened"
|
2022-08-25 08:01:57 +05:30
|
|
|
case activities_model.ActionCreatePullRequest:
|
2015-11-16 22:09:48 +05:30
|
|
|
return "git-pull-request"
|
2022-08-25 08:01:57 +05:30
|
|
|
case activities_model.ActionCommentIssue, activities_model.ActionCommentPull:
|
2016-07-16 10:15:13 +05:30
|
|
|
return "comment-discussion"
|
2022-11-03 21:19:00 +05:30
|
|
|
case activities_model.ActionMergePullRequest, activities_model.ActionAutoMergePullRequest:
|
2015-11-16 22:09:48 +05:30
|
|
|
return "git-merge"
|
2022-08-25 08:01:57 +05:30
|
|
|
case activities_model.ActionCloseIssue, activities_model.ActionClosePullRequest:
|
2016-02-22 23:10:00 +05:30
|
|
|
return "issue-closed"
|
2022-08-25 08:01:57 +05:30
|
|
|
case activities_model.ActionReopenIssue, activities_model.ActionReopenPullRequest:
|
2016-03-05 23:28:51 +05:30
|
|
|
return "issue-reopened"
|
2022-08-25 08:01:57 +05:30
|
|
|
case activities_model.ActionMirrorSyncPush, activities_model.ActionMirrorSyncCreate, activities_model.ActionMirrorSyncDelete:
|
2020-12-11 04:36:45 +05:30
|
|
|
return "mirror"
|
2022-08-25 08:01:57 +05:30
|
|
|
case activities_model.ActionApprovePullRequest:
|
2020-04-24 10:28:14 +05:30
|
|
|
return "check"
|
2022-08-25 08:01:57 +05:30
|
|
|
case activities_model.ActionRejectPullRequest:
|
2020-07-17 20:45:12 +05:30
|
|
|
return "diff"
|
2022-08-25 08:01:57 +05:30
|
|
|
case activities_model.ActionPublishRelease:
|
2020-07-30 00:50:54 +05:30
|
|
|
return "tag"
|
2022-08-25 08:01:57 +05:30
|
|
|
case activities_model.ActionPullReviewDismissed:
|
2021-02-11 23:02:25 +05:30
|
|
|
return "x"
|
2014-04-10 23:50:58 +05:30
|
|
|
default:
|
2020-04-24 10:28:14 +05:30
|
|
|
return "question"
|
2014-04-10 23:50:58 +05:30
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2016-11-25 11:53:48 +05:30
|
|
|
// ActionContent2Commits converts action content to push commits
|
2020-01-10 15:04:21 +05:30
|
|
|
func ActionContent2Commits(act Actioner) *repository.PushCommits {
|
|
|
|
push := repository.NewPushCommits()
|
2021-03-02 02:38:10 +05:30
|
|
|
|
2021-03-06 09:39:49 +05:30
|
|
|
if act == nil || act.GetContent() == "" {
|
|
|
|
return push
|
|
|
|
}
|
|
|
|
|
2015-11-14 03:40:25 +05:30
|
|
|
if err := json.Unmarshal([]byte(act.GetContent()), push); err != nil {
|
2019-04-02 13:18:31 +05:30
|
|
|
log.Error("json.Unmarshal:\n%s\nERROR: %v", act.GetContent(), err)
|
2014-07-26 09:54:27 +05:30
|
|
|
}
|
2021-08-26 04:34:58 +05:30
|
|
|
|
|
|
|
if push.Len == 0 {
|
|
|
|
push.Len = len(push.Commits)
|
|
|
|
}
|
|
|
|
|
2014-07-26 09:54:27 +05:30
|
|
|
return push
|
|
|
|
}
|
|
|
|
|
2016-11-25 11:53:48 +05:30
|
|
|
// DiffLineTypeToStr returns diff line type name
|
2014-04-10 23:50:58 +05:30
|
|
|
func DiffLineTypeToStr(diffType int) string {
|
|
|
|
switch diffType {
|
|
|
|
case 2:
|
|
|
|
return "add"
|
|
|
|
case 3:
|
|
|
|
return "del"
|
|
|
|
case 4:
|
|
|
|
return "tag"
|
|
|
|
}
|
|
|
|
return "same"
|
|
|
|
}
|
2017-10-15 04:47:39 +05:30
|
|
|
|
2021-09-18 21:52:51 +05:30
|
|
|
// MigrationIcon returns a SVG name matching the service an issue/comment was migrated from
|
2019-07-08 07:44:12 +05:30
|
|
|
func MigrationIcon(hostname string) string {
|
|
|
|
switch hostname {
|
|
|
|
case "github.com":
|
2021-09-18 21:52:51 +05:30
|
|
|
return "octicon-mark-github"
|
2019-07-08 07:44:12 +05:30
|
|
|
default:
|
2021-09-18 21:52:51 +05:30
|
|
|
return "gitea-git"
|
2019-07-08 07:44:12 +05:30
|
|
|
}
|
|
|
|
}
|
2019-11-07 19:04:28 +05:30
|
|
|
|
2021-06-14 22:50:43 +05:30
|
|
|
type remoteAddress struct {
|
|
|
|
Address string
|
|
|
|
Username string
|
|
|
|
Password string
|
|
|
|
}
|
|
|
|
|
2022-08-15 08:42:01 +05:30
|
|
|
func mirrorRemoteAddress(ctx context.Context, m *repo_model.Repository, remoteName string, ignoreOriginalURL bool) remoteAddress {
|
2021-06-14 22:50:43 +05:30
|
|
|
a := remoteAddress{}
|
2022-06-11 19:20:14 +05:30
|
|
|
|
|
|
|
remoteURL := m.OriginalURL
|
2022-08-15 08:42:01 +05:30
|
|
|
if ignoreOriginalURL || remoteURL == "" {
|
2022-06-11 19:20:14 +05:30
|
|
|
var err error
|
|
|
|
remoteURL, err = git.GetRemoteAddress(ctx, m.RepoPath(), remoteName)
|
|
|
|
if err != nil {
|
|
|
|
log.Error("GetRemoteURL %v", err)
|
|
|
|
return a
|
|
|
|
}
|
|
|
|
}
|
2021-06-14 22:50:43 +05:30
|
|
|
|
2022-06-11 19:20:14 +05:30
|
|
|
u, err := giturl.Parse(remoteURL)
|
2021-06-14 22:50:43 +05:30
|
|
|
if err != nil {
|
2022-06-11 19:20:14 +05:30
|
|
|
log.Error("giturl.Parse %v", err)
|
2021-06-14 22:50:43 +05:30
|
|
|
return a
|
|
|
|
}
|
|
|
|
|
2022-06-11 19:20:14 +05:30
|
|
|
if u.Scheme != "ssh" && u.Scheme != "file" {
|
|
|
|
if u.User != nil {
|
|
|
|
a.Username = u.User.Username()
|
|
|
|
a.Password, _ = u.User.Password()
|
|
|
|
}
|
|
|
|
u.User = nil
|
2021-06-14 22:50:43 +05:30
|
|
|
}
|
|
|
|
a.Address = u.String()
|
|
|
|
|
|
|
|
return a
|
|
|
|
}
|
2022-06-12 17:38:23 +05:30
|
|
|
|
Use a general Eval function for expressions in templates. (#23927)
One of the proposals in #23328
This PR introduces a simple expression calculator
(templates/eval/eval.go), it can do basic expression calculations.
Many untested template helper functions like `Mul` `Add` can be replaced
by this new approach.
Then these `Add` / `Mul` / `percentage` / `Subtract` / `DiffStatsWidth`
could all use this `Eval`.
And it provides enhancements for Golang templates, and improves
readability.
Some examples:
----
* Before: `{{Add (Mul $glyph.Row 12) 12}}`
* After: `{{Eval $glyph.Row "*" 12 "+" 12}}`
----
* Before: `{{if lt (Add $i 1) (len $.Topics)}}`
* After: `{{if Eval $i "+" 1 "<" (len $.Topics)}}`
## FAQ
### Why not use an existing expression package?
We need a highly customized expression engine:
* do the calculation on the fly, without pre-compiling
* deal with int/int64/float64 types, to make the result could be used in
Golang template.
* make the syntax could be used in the Golang template directly
* do not introduce too much complex or strange syntax, we just need a
simple calculator.
* it needs to strictly follow Golang template's behavior, for example,
Golang template treats all non-zero values as truth, but many 3rd
packages don't do so.
### What's the benefit?
* Developers don't need to add more `Add`/`Mul`/`Sub`-like functions,
they were getting more and more.
Now, only one `Eval` is enough for all cases.
* The new code reads better than old `{{Add (Mul $glyph.Row 12) 12}}`,
the old one isn't familiar to most procedural programming developers
(eg, the Golang expression syntax).
* The `Eval` is fully covered by tests, many old `Add`/`Mul`-like
functions were never tested.
### The performance?
It doesn't use `reflect`, it doesn't need to parse or compile when used
in Golang template, the performance is as fast as native Go template.
### Is it too complex? Could it be unstable?
The expression calculator program is a common homework for computer
science students, and it's widely used as a teaching and practicing
purpose for developers. The algorithm is pretty well-known.
The behavior can be clearly defined, it is stable.
2023-04-07 18:55:49 +05:30
|
|
|
// 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
|
|
|
|
}
|