// Copyright 2014 The Gogs Authors. All rights reserved.
// Use of this source code is governed by a MIT-style
// license that can be found in the LICENSE file.
package template
import (
"fmt"
"html/template"
"mime"
"path/filepath"
"strings"
"sync"
"time"
"github.com/editorconfig/editorconfig-core-go/v2"
jsoniter "github.com/json-iterator/go"
"github.com/microcosm-cc/bluemonday"
"golang.org/x/net/html/charset"
"golang.org/x/text/transform"
log "unknwon.dev/clog/v2"
"github.com/gogs/git-module"
"gogs.io/gogs/internal/conf"
"gogs.io/gogs/internal/cryptoutil"
"gogs.io/gogs/internal/db"
"gogs.io/gogs/internal/gitutil"
"gogs.io/gogs/internal/markup"
"gogs.io/gogs/internal/tool"
)
var (
funcMap []template.FuncMap
funcMapOnce sync.Once
)
// FuncMap returns a list of user-defined template functions.
func FuncMap() []template.FuncMap {
funcMapOnce.Do(func() {
funcMap = []template.FuncMap{map[string]interface{}{
"BuildCommit": func() string {
return conf.BuildCommit
},
"Year": func() int {
return time.Now().Year()
},
"UseHTTPS": func() bool {
return conf.Server.URL.Scheme == "https"
},
"AppName": func() string {
return conf.App.BrandName
},
"AppSubURL": func() string {
return conf.Server.Subpath
},
"AppURL": func() string {
return conf.Server.ExternalURL
},
"AppVer": func() string {
return conf.App.Version
},
"AppDomain": func() string {
return conf.Server.Domain
},
"DisableGravatar": func() bool {
return conf.Picture.DisableGravatar
},
"ShowFooterTemplateLoadTime": func() bool {
return conf.Other.ShowFooterTemplateLoadTime
},
"LoadTimes": func(startTime time.Time) string {
return fmt.Sprint(time.Since(startTime).Nanoseconds()/1e6) + "ms"
},
"AvatarLink": tool.AvatarLink,
"AppendAvatarSize": tool.AppendAvatarSize,
"Safe": Safe,
"Sanitize": bluemonday.UGCPolicy().Sanitize,
"Str2HTML": Str2HTML,
"NewLine2br": NewLine2br,
"TimeSince": tool.TimeSince,
"RawTimeSince": tool.RawTimeSince,
"FileSize": tool.FileSize,
"Subtract": tool.Subtract,
"Add": func(a, b int) int {
return a + b
},
"ActionIcon": ActionIcon,
"DateFmtLong": func(t time.Time) string {
return t.Format(time.RFC1123Z)
},
"DateFmtShort": func(t time.Time) string {
return t.Format("Jan 02, 2006")
},
"SubStr": func(str string, start, length int) string {
if len(str) == 0 {
return ""
}
end := start + length
if length == -1 {
end = len(str)
}
if len(str) < end {
return str
}
return str[start:end]
},
"Join": strings.Join,
"EllipsisString": tool.EllipsisString,
"DiffFileTypeToStr": DiffFileTypeToStr,
"DiffLineTypeToStr": DiffLineTypeToStr,
"Sha1": Sha1,
"ShortSHA1": tool.ShortSHA1,
"ActionContent2Commits": ActionContent2Commits,
"EscapePound": EscapePound,
"RenderCommitMessage": RenderCommitMessage,
"ThemeColorMetaTag": func() string {
return conf.UI.ThemeColorMetaTag
},
"FilenameIsImage": func(filename string) bool {
mimeType := mime.TypeByExtension(filepath.Ext(filename))
return strings.HasPrefix(mimeType, "image/")
},
"TabSizeClass": func(ec *editorconfig.Editorconfig, filename string) string {
if ec != nil {
def, err := ec.GetDefinitionForFilename(filename)
if err == nil && def.TabWidth > 0 {
return fmt.Sprintf("tab-size-%d", def.TabWidth)
}
}
return "tab-size-8"
},
"InferSubmoduleURL": gitutil.InferSubmoduleURL,
}}
})
return funcMap
}
func Safe(raw string) template.HTML {
return template.HTML(raw)
}
func Str2HTML(raw string) template.HTML {
return template.HTML(markup.Sanitize(raw))
}
// NewLine2br simply replaces "\n" to "
".
func NewLine2br(raw string) string {
return strings.Replace(raw, "\n", "
", -1)
}
func Sha1(str string) string {
return cryptoutil.SHA1(str)
}
func ToUTF8WithErr(content []byte) (error, string) {
charsetLabel, err := tool.DetectEncoding(content)
if err != nil {
return err, ""
} else if charsetLabel == "UTF-8" {
return nil, string(content)
}
encoding, _ := charset.Lookup(charsetLabel)
if encoding == nil {
return fmt.Errorf("Unknown encoding: %s", charsetLabel), string(content)
}
// If there is an error, we concatenate the nicely decoded part and the
// original left over. This way we won't loose data.
result, n, err := transform.String(encoding.NewDecoder(), string(content))
if err != nil {
result = result + string(content[n:])
}
return err, result
}
// RenderCommitMessage renders commit message with special links.
func RenderCommitMessage(full bool, msg, urlPrefix string, metas map[string]string) string {
cleanMsg := template.HTMLEscapeString(msg)
fullMessage := string(markup.RenderIssueIndexPattern([]byte(cleanMsg), urlPrefix, metas))
msgLines := strings.Split(strings.TrimSpace(fullMessage), "\n")
numLines := len(msgLines)
if numLines == 0 {
return ""
} else if !full {
return msgLines[0]
} else if numLines == 1 || (numLines >= 2 && len(msgLines[1]) == 0) {
// First line is a header, standalone or followed by empty line
header := fmt.Sprintf("
%s", strings.Join(msgLines[2:], "\n")) } else { fullMessage = header } } else { // Non-standard git message, there is no header line fullMessage = fmt.Sprintf("