forgejo/modules/templates/helper.go

313 lines
8.1 KiB
Go
Raw Normal View History

2014-04-10 18:20:58 +00:00
// 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 templates
2014-04-10 18:20:58 +00:00
import (
"container/list"
"encoding/json"
"fmt"
"html/template"
"mime"
"path/filepath"
2014-05-22 01:37:13 +00:00
"runtime"
2014-04-10 18:20:58 +00:00
"strings"
"time"
2014-05-26 00:11:25 +00:00
"github.com/microcosm-cc/bluemonday"
"golang.org/x/net/html/charset"
"golang.org/x/text/transform"
"gopkg.in/editorconfig/editorconfig-core-go.v1"
"code.gitea.io/gitea/models"
"code.gitea.io/gitea/modules/base"
"code.gitea.io/gitea/modules/log"
"code.gitea.io/gitea/modules/markdown"
"code.gitea.io/gitea/modules/setting"
2014-04-10 18:20:58 +00:00
)
2016-11-25 06:23:48 +00:00
// NewFuncMap returns functions for injecting to templates
2016-03-06 21:40:04 +00:00
func NewFuncMap() []template.FuncMap {
return []template.FuncMap{map[string]interface{}{
"GoVer": func() string {
return strings.Title(runtime.Version())
},
"UseHTTPS": func() bool {
return strings.HasPrefix(setting.AppURL, "https")
2016-03-06 21:40:04 +00:00
},
"AppName": func() string {
return setting.AppName
},
"AppSubUrl": func() string {
return setting.AppSubURL
2016-03-06 21:40:04 +00:00
},
"AppUrl": func() string {
return setting.AppURL
2016-03-06 21:40:04 +00:00
},
"AppVer": func() string {
return setting.AppVer
},
"AppDomain": func() string {
return setting.Domain
},
"DisableGravatar": func() bool {
return setting.DisableGravatar
},
"ShowFooterTemplateLoadTime": func() bool {
return setting.ShowFooterTemplateLoadTime
},
2016-03-06 21:40:04 +00:00
"LoadTimes": func(startTime time.Time) string {
return fmt.Sprint(time.Since(startTime).Nanoseconds()/1e6) + "ms"
},
"AvatarLink": base.AvatarLink,
"Safe": Safe,
"Sanitize": bluemonday.UGCPolicy().Sanitize,
2016-03-06 21:40:04 +00:00
"Str2html": Str2html,
"TimeSince": base.TimeSince,
"RawTimeSince": base.RawTimeSince,
"FileSize": base.FileSize,
"Subtract": base.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")
},
"List": List,
"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]
},
2016-08-30 12:07:50 +00:00
"EllipsisString": base.EllipsisString,
2016-03-06 21:40:04 +00:00
"DiffTypeToStr": DiffTypeToStr,
"DiffLineTypeToStr": DiffLineTypeToStr,
"Sha1": Sha1,
"ShortSha": base.ShortSha,
"MD5": base.EncodeMD5,
"ActionContent2Commits": ActionContent2Commits,
"EscapePound": func(str string) string {
return strings.NewReplacer("%", "%25", "#", "%23", " ", "%20", "?", "%3F").Replace(str)
2016-03-06 21:40:04 +00:00
},
"RenderCommitMessage": RenderCommitMessage,
"ThemeColorMetaTag": func() string {
2016-07-23 16:23:54 +00:00
return setting.UI.ThemeColorMetaTag
2016-03-06 21:40:04 +00:00
},
"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 := ec.GetDefinitionForFilename(filename)
if def.TabWidth > 0 {
return fmt.Sprintf("tab-size-%d", def.TabWidth)
}
}
return "tab-size-8"
},
2016-12-28 16:35:52 +00:00
"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])
path = append(path, str[index+1:])
2016-12-28 16:35:52 +00:00
} else {
path = append(path, str)
}
return path
},
2016-03-06 21:40:04 +00:00
}}
2015-11-14 03:45:33 +00:00
}
2016-11-25 06:23:48 +00:00
// Safe render raw as HTML
2015-08-08 09:10:34 +00:00
func Safe(raw string) template.HTML {
return template.HTML(raw)
}
2016-11-25 06:23:48 +00:00
// Str2html render Markdown text to HTML
2014-04-10 18:20:58 +00:00
func Str2html(raw string) template.HTML {
2016-02-20 22:10:05 +00:00
return template.HTML(markdown.Sanitizer.Sanitize(raw))
2014-04-10 18:20:58 +00:00
}
2016-11-25 06:23:48 +00:00
// List traversings the list
2014-04-10 18:20:58 +00:00
func List(l *list.List) chan interface{} {
e := l.Front()
c := make(chan interface{})
go func() {
for e != nil {
c <- e.Value
e = e.Next()
}
close(c)
}()
return c
}
2016-11-25 06:23:48 +00:00
// Sha1 returns sha1 sum of string
2015-02-18 21:52:22 +00:00
func Sha1(str string) string {
2015-11-13 22:10:25 +00:00
return base.EncodeSha1(str)
2014-12-09 07:18:25 +00:00
}
2016-11-25 06:23:48 +00:00
// ToUTF8WithErr converts content to UTF8 encoding
func ToUTF8WithErr(content []byte) (string, error) {
charsetLabel, err := base.DetectEncoding(content)
if err != nil {
2016-11-25 06:23:48 +00:00
return "", err
} else if charsetLabel == "UTF-8" {
2016-11-25 06:23:48 +00:00
return string(content), nil
}
encoding, _ := charset.Lookup(charsetLabel)
if encoding == nil {
2016-11-25 06:23:48 +00:00
return string(content), fmt.Errorf("Unknown encoding: %s", charsetLabel)
}
// 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:])
}
2016-11-25 06:23:48 +00:00
return result, err
}
2016-11-25 06:23:48 +00:00
// ToUTF8 converts content to UTF8 encoding and ignore error
2016-08-09 19:56:00 +00:00
func ToUTF8(content string) string {
2016-11-25 06:23:48 +00:00
res, _ := ToUTF8WithErr([]byte(content))
return res
}
2016-11-25 06:23:48 +00:00
// ReplaceLeft replaces all prefixes 'old' in 's' with 'new'.
func ReplaceLeft(s, old, new string) string {
2016-11-25 06:23:48 +00:00
oldLen, newLen, i, n := len(old), len(new), 0, 0
for ; i < len(s) && strings.HasPrefix(s[i:], old); n++ {
i += oldLen
}
// simple optimization
if n == 0 {
return s
}
// allocating space for the new string
2016-11-25 06:23:48 +00:00
curLen := n*newLen + len(s[i:])
replacement := make([]byte, curLen, curLen)
j := 0
2016-11-25 06:23:48 +00:00
for ; j < n*newLen; j += newLen {
copy(replacement[j:j+newLen], new)
}
copy(replacement[j:], s[i:])
return string(replacement)
}
// RenderCommitMessage renders commit message with XSS-safe and special links.
func RenderCommitMessage(full bool, msg, urlPrefix string, metas map[string]string) template.HTML {
cleanMsg := template.HTMLEscapeString(msg)
2016-02-20 22:10:05 +00:00
fullMessage := string(markdown.RenderIssueIndexPattern([]byte(cleanMsg), urlPrefix, metas))
msgLines := strings.Split(strings.TrimSpace(fullMessage), "\n")
numLines := len(msgLines)
if numLines == 0 {
return template.HTML("")
} else if !full {
return template.HTML(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("<h3>%s</h3>", msgLines[0])
if numLines >= 2 {
fullMessage = header + fmt.Sprintf("\n<pre>%s</pre>", strings.Join(msgLines[2:], "\n"))
} else {
fullMessage = header
}
} else {
// Non-standard git message, there is no header line
fullMessage = fmt.Sprintf("<h4>%s</h4>", strings.Join(msgLines, "<br>"))
}
return template.HTML(fullMessage)
}
2016-11-25 06:23:48 +00:00
// Actioner describes an action
2014-04-10 18:20:58 +00:00
type Actioner interface {
GetOpType() int
GetActUserName() string
2014-05-09 06:42:50 +00:00
GetRepoUserName() string
2014-04-10 18:20:58 +00:00
GetRepoName() string
2015-09-01 13:29:52 +00:00
GetRepoPath() string
GetRepoLink() string
2014-04-10 18:20:58 +00:00
GetBranch() string
GetContent() string
2015-09-01 13:29:52 +00:00
GetCreate() time.Time
GetIssueInfos() []string
2014-04-10 18:20:58 +00:00
}
// ActionIcon accepts a int that represents action operation type
// and returns a icon class name.
func ActionIcon(opType int) string {
switch opType {
case 1, 8: // Create and transfer repository
2014-07-26 04:24:27 +00:00
return "repo"
2015-11-16 16:39:48 +00:00
case 5, 9: // Commit repository
2014-07-26 04:24:27 +00:00
return "git-commit"
case 6: // Create issue
2014-07-26 04:24:27 +00:00
return "issue-opened"
2015-11-16 16:39:48 +00:00
case 7: // New pull request
return "git-pull-request"
case 10: // Comment issue
2016-07-16 04:45:13 +00:00
return "comment-discussion"
2015-11-16 16:39:48 +00:00
case 11: // Merge pull request
return "git-merge"
case 12, 14: // Close issue or pull request
return "issue-closed"
case 13, 15: // Reopen issue or pull request
return "issue-reopened"
2014-04-10 18:20:58 +00:00
default:
return "invalid type"
}
}
2016-11-25 06:23:48 +00:00
// ActionContent2Commits converts action content to push commits
2015-11-13 22:10:25 +00:00
func ActionContent2Commits(act Actioner) *models.PushCommits {
push := models.NewPushCommits()
if err := json.Unmarshal([]byte(act.GetContent()), push); err != nil {
log.Error(4, "json.Unmarshal:\n%s\nERROR: %v", act.GetContent(), err)
2014-07-26 04:24:27 +00:00
}
return push
}
2016-11-25 06:23:48 +00:00
// DiffTypeToStr returns diff type name
2014-04-10 18:20:58 +00:00
func DiffTypeToStr(diffType int) string {
diffTypes := map[int]string{
2015-11-03 14:52:17 +00:00
1: "add", 2: "modify", 3: "del", 4: "rename",
2014-04-10 18:20:58 +00:00
}
return diffTypes[diffType]
}
2016-11-25 06:23:48 +00:00
// DiffLineTypeToStr returns diff line type name
2014-04-10 18:20:58 +00:00
func DiffLineTypeToStr(diffType int) string {
switch diffType {
case 2:
return "add"
case 3:
return "del"
case 4:
return "tag"
}
return "same"
}