This repository has been archived on 2023-02-01. You can view files and clone it, but cannot push or open issues or pull requests.
gitea/modules/base/template.go

287 lines
5.8 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 base
import (
"container/list"
"encoding/json"
"fmt"
"html/template"
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
"golang.org/x/net/html/charset"
"golang.org/x/text/transform"
2015-01-15 10:40:16 +00:00
"github.com/gogits/chardet"
"github.com/gogits/gogs/modules/setting"
2014-04-10 18:20:58 +00:00
)
2015-08-08 09:10:34 +00:00
func Safe(raw string) template.HTML {
return template.HTML(raw)
}
2014-04-10 18:20:58 +00:00
func Str2html(raw string) template.HTML {
2015-01-30 23:12:30 +00:00
return template.HTML(Sanitizer.Sanitize(raw))
2014-04-10 18:20:58 +00:00
}
func Range(l int) []int {
return make([]int, l)
}
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
}
2015-02-18 21:52:22 +00:00
func Sha1(str string) string {
return EncodeSha1(str)
}
2014-04-10 18:20:58 +00:00
func ShortSha(sha1 string) string {
if len(sha1) == 40 {
return sha1[:10]
}
return sha1
}
2014-12-09 07:18:25 +00:00
func DetectEncoding(content []byte) (string, error) {
detector := chardet.NewTextDetector()
result, err := detector.DetectBest(content)
if result.Charset != "UTF-8" && len(setting.AnsiCharset) > 0 {
return setting.AnsiCharset, err
}
2014-12-09 07:18:25 +00:00
return result.Charset, err
}
func ToUtf8WithErr(content []byte) (error, string) {
charsetLabel, err := DetectEncoding(content)
if err != nil {
return err, ""
}
if charsetLabel == "UTF-8" {
return nil, string(content)
}
encoding, _ := charset.Lookup(charsetLabel)
if encoding == nil {
return fmt.Errorf("unknow char decoder %s", charsetLabel), string(content)
}
result, n, err := transform.String(encoding.NewDecoder(), 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.
if err != nil {
result = result + string(content[n:])
}
return err, result
}
func ToUtf8(content string) string {
_, res := ToUtf8WithErr([]byte(content))
return res
}
// RenderCommitMessage renders commit message with XSS-safe and special links.
func RenderCommitMessage(msg, urlPrefix string) template.HTML {
return template.HTML(string(RenderIssueIndexPattern([]byte(template.HTMLEscapeString(msg)), urlPrefix)))
}
2014-04-10 18:20:58 +00:00
var mailDomains = map[string]string{
"gmail.com": "gmail.com",
}
var TemplateFuncs template.FuncMap = map[string]interface{}{
2014-05-22 01:37:13 +00:00
"GoVer": func() string {
2014-07-26 04:24:27 +00:00
return strings.Title(runtime.Version())
2014-05-22 01:37:13 +00:00
},
2014-04-10 18:20:58 +00:00
"AppName": func() string {
2014-05-26 00:11:25 +00:00
return setting.AppName
2014-04-10 18:20:58 +00:00
},
2014-09-20 00:11:34 +00:00
"AppSubUrl": func() string {
return setting.AppSubUrl
},
2014-04-10 18:20:58 +00:00
"AppVer": func() string {
2014-05-26 00:11:25 +00:00
return setting.AppVer
2014-04-10 18:20:58 +00:00
},
"AppDomain": func() string {
2014-05-26 00:11:25 +00:00
return setting.Domain
2014-04-10 18:20:58 +00:00
},
"DisableGravatar": func() bool {
return setting.DisableGravatar
},
2014-04-10 18:20:58 +00:00
"LoadTimes": func(startTime time.Time) string {
return fmt.Sprint(time.Since(startTime).Nanoseconds()/1e6) + "ms"
},
2015-08-13 08:07:11 +00:00
"AvatarLink": AvatarLink,
"Safe": Safe,
"Str2html": Str2html,
"TimeSince": TimeSince,
"RawTimeSince": RawTimeSince,
"FileSize": FileSize,
"Subtract": Subtract,
2014-04-11 16:14:11 +00:00
"Add": func(a, b int) int {
return a + b
},
2014-04-10 18:20:58 +00:00
"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,
2014-04-10 18:20:58 +00:00
"Mail2Domain": func(mail string) string {
if !strings.Contains(mail, "@") {
2014-10-19 05:35:24 +00:00
return "try.gogs.io"
2014-04-10 18:20:58 +00:00
}
suffix := strings.SplitN(mail, "@", 2)[1]
domain, ok := mailDomains[suffix]
if !ok {
return "mail." + suffix
}
return domain
},
"SubStr": func(str string, start, length int) string {
2014-10-19 05:35:24 +00:00
if len(str) == 0 {
return ""
}
end := start + length
if length == -1 {
end = len(str)
}
if len(str) < end {
return str
}
return str[start:end]
2014-04-10 18:20:58 +00:00
},
"DiffTypeToStr": DiffTypeToStr,
"DiffLineTypeToStr": DiffLineTypeToStr,
"Sha1": Sha1,
2014-04-10 18:20:58 +00:00
"ShortSha": ShortSha,
2014-07-26 04:24:27 +00:00
"Md5": EncodeMd5,
"ActionContent2Commits": ActionContent2Commits,
"Oauth2Icon": Oauth2Icon,
"Oauth2Name": Oauth2Name,
"ToUtf8": ToUtf8,
2014-11-07 21:44:25 +00:00
"EscapePound": func(str string) string {
return strings.Replace(strings.Replace(str, "%", "%25", -1), "#", "%23", -1)
2014-11-07 21:44:25 +00:00
},
"RenderCommitMessage": RenderCommitMessage,
2014-04-10 18:20:58 +00:00
}
type Actioner interface {
GetOpType() int
GetActUserName() string
GetActEmail() string
2014-05-09 06:42:50 +00:00
GetRepoUserName() string
2014-04-10 18:20:58 +00:00
GetRepoName() string
GetBranch() string
GetContent() string
}
// ActionIcon accepts a int that represents action operation type
// and returns a icon class name.
func ActionIcon(opType int) string {
switch opType {
2014-09-25 20:36:19 +00:00
case 1, 8: // Create, transfer repository.
2014-07-26 04:24:27 +00:00
return "repo"
2014-04-14 01:00:12 +00:00
case 5, 9: // Commit repository.
2014-07-26 04:24:27 +00:00
return "git-commit"
2014-04-10 18:20:58 +00:00
case 6: // Create issue.
2014-07-26 04:24:27 +00:00
return "issue-opened"
2014-05-06 17:47:47 +00:00
case 10: // Comment issue.
return "comment"
2014-04-10 18:20:58 +00:00
default:
return "invalid type"
}
}
type PushCommit struct {
Sha1 string
Message string
AuthorEmail string
AuthorName string
}
type PushCommits struct {
2014-10-11 01:40:51 +00:00
Len int
Commits []*PushCommit
CompareUrl string
2014-04-10 18:20:58 +00:00
}
2014-07-26 04:24:27 +00:00
func ActionContent2Commits(act Actioner) *PushCommits {
var push *PushCommits
if err := json.Unmarshal([]byte(act.GetContent()), &push); err != nil {
return nil
}
return push
}
2014-04-10 18:20:58 +00:00
func DiffTypeToStr(diffType int) string {
diffTypes := map[int]string{
1: "add", 2: "modify", 3: "del",
}
return diffTypes[diffType]
}
func DiffLineTypeToStr(diffType int) string {
switch diffType {
case 2:
return "add"
case 3:
return "del"
case 4:
return "tag"
}
return "same"
}
2014-04-14 01:00:12 +00:00
func Oauth2Icon(t int) string {
switch t {
case 1:
return "fa-github-square"
case 2:
return "fa-google-plus-square"
case 3:
return "fa-twitter-square"
case 4:
2014-08-10 01:01:29 +00:00
return "fa-qq"
2014-04-14 01:00:12 +00:00
case 5:
return "fa-weibo"
}
return ""
}
2014-05-05 20:21:43 +00:00
func Oauth2Name(t int) string {
switch t {
case 1:
return "GitHub"
case 2:
2014-08-10 01:01:29 +00:00
return "Google+"
2014-05-05 20:21:43 +00:00
case 3:
return "Twitter"
case 4:
2014-08-10 01:01:29 +00:00
return "腾讯 QQ"
2014-05-05 20:21:43 +00:00
case 5:
return "Weibo"
}
return ""
}