Refactoring: rename modules -> pkg

Reasons to change:

1. Shorter than 'modules'
2. More generally used by other Go projects
3. Corresponds to the naming of '$GOPATH/pkg' directory

2 files changed, 401 insertions, 0 deletions

diff --git a/pkg/template/highlight/highlight.go b/pkg/template/highlight/highlight.go
new file mode 100644
index 00000000..05029a4a
--- /dev/null
+++ b/pkg/template/highlight/highlight.go
@@ -0,0 +1,100 @@
+// Copyright 2015 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 highlight
+
+import (
+	"path"
+	"strings"
+
+	"github.com/gogits/gogs/pkg/setting"
+)
+
+var (
+	// File name should ignore highlight.
+	ignoreFileNames = map[string]bool{
+		"license": true,
+		"copying": true,
+	}
+
+	// File names that are representing highlight classes.
+	highlightFileNames = map[string]bool{
+		"cmakelists.txt": true,
+		"dockerfile": true,
+		"makefile":   true,
+	}
+
+	// Extensions that are same as highlight classes.
+	highlightExts = map[string]bool{
+		".arm":    true,
+		".as":     true,
+		".sh":     true,
+		".cs":     true,
+		".cpp":    true,
+		".c":      true,
+		".css":    true,
+		".cmake":  true,
+		".bat":    true,
+		".dart":   true,
+		".patch":  true,
+		".elixir": true,
+		".erlang": true,
+		".go":     true,
+		".html":   true,
+		".xml":    true,
+		".hs":     true,
+		".ini":    true,
+		".json":   true,
+		".java":   true,
+		".js":     true,
+		".less":   true,
+		".lua":    true,
+		".php":    true,
+		".py":     true,
+		".rb":     true,
+		".scss":   true,
+		".sql":    true,
+		".scala":  true,
+		".swift":  true,
+		".ts":     true,
+		".vb":     true,
+	}
+
+	// Extensions that are not same as highlight classes.
+	highlightMapping = map[string]string{
+		".txt": "nohighlight",
+	}
+)
+
+func NewContext() {
+	keys := setting.Cfg.Section("highlight.mapping").Keys()
+	for i := range keys {
+		highlightMapping[keys[i].Name()] = keys[i].Value()
+	}
+}
+
+// FileNameToHighlightClass returns the best match for highlight class name
+// based on the rule of highlight.js.
+func FileNameToHighlightClass(fname string) string {
+	fname = strings.ToLower(fname)
+	if ignoreFileNames[fname] {
+		return "nohighlight"
+	}
+
+	if highlightFileNames[fname] {
+		return fname
+	}
+
+	ext := path.Ext(fname)
+	if highlightExts[ext] {
+		return ext[1:]
+	}
+
+	name, ok := highlightMapping[ext]
+	if ok {
+		return name
+	}
+
+	return ""
+}
diff --git a/pkg/template/template.go b/pkg/template/template.go
new file mode 100644
index 00000000..61c47b8c
--- /dev/null
+++ b/pkg/template/template.go
@@ -0,0 +1,301 @@
+// 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 (
+	"container/list"
+	"encoding/json"
+	"fmt"
+	"html/template"
+	"mime"
+	"path/filepath"
+	"runtime"
+	"strings"
+	"time"
+
+	"github.com/microcosm-cc/bluemonday"
+	"golang.org/x/net/html/charset"
+	"golang.org/x/text/transform"
+	log "gopkg.in/clog.v1"
+	"gopkg.in/editorconfig/editorconfig-core-go.v1"
+
+	"github.com/gogits/gogs/models"
+	"github.com/gogits/gogs/pkg/base"
+	"github.com/gogits/gogs/pkg/markup"
+	"github.com/gogits/gogs/pkg/setting"
+)
+
+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")
+		},
+		"AppName": func() string {
+			return setting.AppName
+		},
+		"AppSubUrl": func() string {
+			return setting.AppSubUrl
+		},
+		"AppUrl": func() string {
+			return setting.AppUrl
+		},
+		"AppVer": func() string {
+			return setting.AppVer
+		},
+		"AppDomain": func() string {
+			return setting.Domain
+		},
+		"DisableGravatar": func() bool {
+			return setting.DisableGravatar
+		},
+		"ShowFooterTemplateLoadTime": func() bool {
+			return setting.ShowFooterTemplateLoadTime
+		},
+		"LoadTimes": func(startTime time.Time) string {
+			return fmt.Sprint(time.Since(startTime).Nanoseconds()/1e6) + "ms"
+		},
+		"AvatarLink":   base.AvatarLink,
+		"Safe":         Safe,
+		"Sanitize":     bluemonday.UGCPolicy().Sanitize,
+		"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]
+		},
+		"Join":              strings.Join,
+		"EllipsisString":    base.EllipsisString,
+		"DiffTypeToStr":     DiffTypeToStr,
+		"DiffLineTypeToStr": DiffLineTypeToStr,
+		"Sha1":              Sha1,
+		"ShortSha":          base.ShortSha,
+		"MD5":               base.EncodeMD5,
+		"ActionContent2Commits": ActionContent2Commits,
+		"EscapePound":           EscapePound,
+		"RenderCommitMessage":   RenderCommitMessage,
+		"ThemeColorMetaTag": func() string {
+			return setting.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 := ec.GetDefinitionForFilename(filename)
+				if def.TabWidth > 0 {
+					return fmt.Sprintf("tab-size-%d", def.TabWidth)
+				}
+			}
+			return "tab-size-8"
+		},
+	}}
+}
+
+func Safe(raw string) template.HTML {
+	return template.HTML(raw)
+}
+
+func Str2html(raw string) template.HTML {
+	return template.HTML(markup.Sanitize(raw))
+}
+
+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
+}
+
+func Sha1(str string) string {
+	return base.EncodeSha1(str)
+}
+
+func ToUTF8WithErr(content []byte) (error, string) {
+	charsetLabel, err := base.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
+}
+
+func ToUTF8(content string) string {
+	_, res := ToUTF8WithErr([]byte(content))
+	return res
+}
+
+// Replaces all prefixes 'old' in 's' with 'new'.
+func ReplaceLeft(s, old, new string) string {
+	old_len, new_len, i, n := len(old), len(new), 0, 0
+	for ; i < len(s) && strings.HasPrefix(s[i:], old); n += 1 {
+		i += old_len
+	}
+
+	// simple optimization
+	if n == 0 {
+		return s
+	}
+
+	// allocating space for the new string
+	newLen := n*new_len + len(s[i:])
+	replacement := make([]byte, newLen, newLen)
+
+	j := 0
+	for ; j < n*new_len; j += new_len {
+		copy(replacement[j:j+new_len], 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)
+	fullMessage := string(markup.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)
+}
+
+type Actioner interface {
+	GetOpType() int
+	GetActUserName() string
+	GetRepoUserName() string
+	GetRepoName() string
+	GetRepoPath() string
+	GetRepoLink() string
+	GetBranch() string
+	GetContent() string
+	GetCreate() time.Time
+	GetIssueInfos() []string
+}
+
+// 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
+		return "repo"
+	case 5: // Commit repository
+		return "git-commit"
+	case 6: // Create issue
+		return "issue-opened"
+	case 7: // New pull request
+		return "git-pull-request"
+	case 9: // Push tag
+		return "tag"
+	case 10: // Comment issue
+		return "comment-discussion"
+	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"
+	case 16: // Create branch
+		return "git-branch"
+	case 17, 18: // Delete branch or tag
+		return "alert"
+	case 19: // Fork a repository
+		return "repo-forked"
+	default:
+		return "invalid type"
+	}
+}
+
+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)
+	}
+	return push
+}
+
+func EscapePound(str string) string {
+	return strings.NewReplacer("%", "%25", "#", "%23", " ", "%20", "?", "%3F").Replace(str)
+}
+
+func DiffTypeToStr(diffType int) string {
+	diffTypes := map[int]string{
+		1: "add", 2: "modify", 3: "del", 4: "rename",
+	}
+	return diffTypes[diffType]
+}
+
+func DiffLineTypeToStr(diffType int) string {
+	switch diffType {
+	case 2:
+		return "add"
+	case 3:
+		return "del"
+	case 4:
+		return "tag"
+	}
+	return "same"
+}