summaryrefslogtreecommitdiffstats
path: root/modules/base
diff options
context:
space:
mode:
authorUnknwon <u@gogs.io>2016-02-20 17:10:05 -0500
committerUnknwon <u@gogs.io>2016-02-20 17:10:05 -0500
commitd5a3021a7d86a6dbf42df97c5c25e22b0b3f9505 (patch)
tree2a2c54eb587a4875b742f932398af99d140297ea /modules/base
parentd8a994ef243349f321568f9e36d5c3f444b99cae (diff)
downloadgitea-d5a3021a7d86a6dbf42df97c5c25e22b0b3f9505.tar.gz
gitea-d5a3021a7d86a6dbf42df97c5c25e22b0b3f9505.zip
Make markdown as an independent module
Diffstat (limited to 'modules/base')
-rw-r--r--modules/base/base.go19
-rw-r--r--modules/base/markdown.go354
-rw-r--r--modules/base/tool.go40
3 files changed, 24 insertions, 389 deletions
diff --git a/modules/base/base.go b/modules/base/base.go
index 45e2151e38..8ba211aa7a 100644
--- a/modules/base/base.go
+++ b/modules/base/base.go
@@ -4,27 +4,8 @@
package base
-import (
- "os"
- "os/exec"
- "path/filepath"
-)
-
const DOC_URL = "https://github.com/gogits/go-gogs-client/wiki"
type (
TplName string
)
-
-// ExecPath returns the executable path.
-func ExecPath() (string, error) {
- file, err := exec.LookPath(os.Args[0])
- if err != nil {
- return "", err
- }
- p, err := filepath.Abs(file)
- if err != nil {
- return "", err
- }
- return p, nil
-}
diff --git a/modules/base/markdown.go b/modules/base/markdown.go
deleted file mode 100644
index 10158edd32..0000000000
--- a/modules/base/markdown.go
+++ /dev/null
@@ -1,354 +0,0 @@
-// 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 (
- "bytes"
- "fmt"
- "io"
- "net/http"
- "path"
- "path/filepath"
- "regexp"
- "strings"
-
- "github.com/Unknwon/com"
- "github.com/russross/blackfriday"
- "golang.org/x/net/html"
-
- "github.com/gogits/gogs/modules/setting"
-)
-
-// TODO: put this into 'markdown' module.
-
-func isletter(c byte) bool {
- return (c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
-}
-
-func isalnum(c byte) bool {
- return (c >= '0' && c <= '9') || isletter(c)
-}
-
-var validLinksPattern = regexp.MustCompile(`^[a-z][\w-]+://`)
-
-func isLink(link []byte) bool {
- return validLinksPattern.Match(link)
-}
-
-func IsMarkdownFile(name string) bool {
- name = strings.ToLower(name)
- switch filepath.Ext(name) {
- case ".md", ".markdown", ".mdown", ".mkd":
- return true
- }
- return false
-}
-
-func IsTextFile(data []byte) (string, bool) {
- contentType := http.DetectContentType(data)
- if strings.Index(contentType, "text/") != -1 {
- return contentType, true
- }
- return contentType, false
-}
-
-func IsImageFile(data []byte) (string, bool) {
- contentType := http.DetectContentType(data)
- if strings.Index(contentType, "image/") != -1 {
- return contentType, true
- }
- return contentType, false
-}
-
-// IsReadmeFile returns true if given file name suppose to be a README file.
-func IsReadmeFile(name string) bool {
- name = strings.ToLower(name)
- if len(name) < 6 {
- return false
- } else if len(name) == 6 {
- if name == "readme" {
- return true
- }
- return false
- }
- if name[:7] == "readme." {
- return true
- }
- return false
-}
-
-var (
- MentionPattern = regexp.MustCompile(`(\s|^)@[0-9a-zA-Z_\.]+`)
- commitPattern = regexp.MustCompile(`(\s|^)https?.*commit/[0-9a-zA-Z]+(#+[0-9a-zA-Z-]*)?`)
- issueFullPattern = regexp.MustCompile(`(\s|^)https?.*issues/[0-9]+(#+[0-9a-zA-Z-]*)?`)
- issueIndexPattern = regexp.MustCompile(`( |^|\()#[0-9]+\b`)
- sha1CurrentPattern = regexp.MustCompile(`\b[0-9a-f]{40}\b`)
-)
-
-type CustomRender struct {
- blackfriday.Renderer
- urlPrefix string
-}
-
-func (r *CustomRender) Link(out *bytes.Buffer, link []byte, title []byte, content []byte) {
- if len(link) > 0 && !isLink(link) {
- if link[0] == '#' {
- // link = append([]byte(options.urlPrefix), link...)
- } else {
- link = []byte(path.Join(r.urlPrefix, string(link)))
- }
- }
-
- r.Renderer.Link(out, link, title, content)
-}
-
-func (r *CustomRender) AutoLink(out *bytes.Buffer, link []byte, kind int) {
- if kind != 1 {
- r.Renderer.AutoLink(out, link, kind)
- return
- }
-
- // This method could only possibly serve one link at a time, no need to find all.
- m := commitPattern.Find(link)
- if m != nil {
- m = bytes.TrimSpace(m)
- i := strings.Index(string(m), "commit/")
- j := strings.Index(string(m), "#")
- if j == -1 {
- j = len(m)
- }
- out.WriteString(fmt.Sprintf(` <code><a href="%s">%s</a></code>`, m, ShortSha(string(m[i+7:j]))))
- return
- }
-
- m = issueFullPattern.Find(link)
- if m != nil {
- m = bytes.TrimSpace(m)
- i := strings.Index(string(m), "issues/")
- j := strings.Index(string(m), "#")
- if j == -1 {
- j = len(m)
- }
- out.WriteString(fmt.Sprintf(` <a href="%s">#%s</a>`, m, ShortSha(string(m[i+7:j]))))
- return
- }
-
- r.Renderer.AutoLink(out, link, kind)
-}
-
-func (options *CustomRender) ListItem(out *bytes.Buffer, text []byte, flags int) {
- switch {
- case bytes.HasPrefix(text, []byte("[ ] ")):
- text = append([]byte(`<input type="checkbox" disabled="" />`), text[3:]...)
- case bytes.HasPrefix(text, []byte("[x] ")):
- text = append([]byte(`<input type="checkbox" disabled="" checked="" />`), text[3:]...)
- }
- options.Renderer.ListItem(out, text, flags)
-}
-
-var (
- svgSuffix = []byte(".svg")
- svgSuffixWithMark = []byte(".svg?")
- spaceBytes = []byte(" ")
- spaceEncodedBytes = []byte("%20")
-)
-
-func (r *CustomRender) Image(out *bytes.Buffer, link []byte, title []byte, alt []byte) {
- prefix := strings.Replace(r.urlPrefix, "/src/", "/raw/", 1)
- if len(link) > 0 {
- if isLink(link) {
- // External link with .svg suffix usually means CI status.
- if bytes.HasSuffix(link, svgSuffix) || bytes.Contains(link, svgSuffixWithMark) {
- r.Renderer.Image(out, link, title, alt)
- return
- }
- } else {
- if link[0] != '/' {
- prefix += "/"
- }
- link = bytes.Replace([]byte((prefix + string(link))), spaceBytes, spaceEncodedBytes, -1)
- fmt.Println(333, string(link))
- }
- }
-
- out.WriteString(`<a href="`)
- out.Write(link)
- out.WriteString(`">`)
- r.Renderer.Image(out, link, title, alt)
- out.WriteString("</a>")
-}
-
-func cutoutVerbosePrefix(prefix string) string {
- count := 0
- for i := 0; i < len(prefix); i++ {
- if prefix[i] == '/' {
- count++
- }
- if count >= 3+setting.AppSubUrlDepth {
- return prefix[:i]
- }
- }
- return prefix
-}
-
-func RenderIssueIndexPattern(rawBytes []byte, urlPrefix string, metas map[string]string) []byte {
- urlPrefix = cutoutVerbosePrefix(urlPrefix)
- ms := issueIndexPattern.FindAll(rawBytes, -1)
- for _, m := range ms {
- var space string
- m2 := m
- if m2[0] != '#' {
- space = string(m2[0])
- m2 = m2[1:]
- }
- if metas == nil {
- rawBytes = bytes.Replace(rawBytes, m, []byte(fmt.Sprintf(`%s<a href="%s/issues/%s">%s</a>`,
- space, urlPrefix, m2[1:], m2)), 1)
- } else {
- // Support for external issue tracker
- metas["index"] = string(m2[1:])
- rawBytes = bytes.Replace(rawBytes, m, []byte(fmt.Sprintf(`%s<a href="%s">%s</a>`,
- space, com.Expand(metas["format"], metas), m2)), 1)
- }
- }
- return rawBytes
-}
-
-func RenderSpecialLink(rawBytes []byte, urlPrefix string, metas map[string]string) []byte {
- ms := MentionPattern.FindAll(rawBytes, -1)
- for _, m := range ms {
- m = bytes.TrimSpace(m)
- rawBytes = bytes.Replace(rawBytes, m,
- []byte(fmt.Sprintf(`<a href="%s/%s">%s</a>`, setting.AppSubUrl, m[1:], m)), -1)
- }
-
- rawBytes = RenderIssueIndexPattern(rawBytes, urlPrefix, metas)
- rawBytes = RenderSha1CurrentPattern(rawBytes, urlPrefix)
- return rawBytes
-}
-
-func RenderSha1CurrentPattern(rawBytes []byte, urlPrefix string) []byte {
- ms := sha1CurrentPattern.FindAll(rawBytes, -1)
- for _, m := range ms {
- rawBytes = bytes.Replace(rawBytes, m, []byte(fmt.Sprintf(
- `<a href="%s/commit/%s"><code>%s</code></a>`, urlPrefix, m, ShortSha(string(m)))), -1)
- }
- return rawBytes
-}
-
-func RenderRawMarkdown(body []byte, urlPrefix string) []byte {
- htmlFlags := 0
- htmlFlags |= blackfriday.HTML_SKIP_STYLE
- htmlFlags |= blackfriday.HTML_OMIT_CONTENTS
- renderer := &CustomRender{
- Renderer: blackfriday.HtmlRenderer(htmlFlags, "", ""),
- urlPrefix: urlPrefix,
- }
-
- // set up the parser
- extensions := 0
- extensions |= blackfriday.EXTENSION_NO_INTRA_EMPHASIS
- extensions |= blackfriday.EXTENSION_TABLES
- extensions |= blackfriday.EXTENSION_FENCED_CODE
- extensions |= blackfriday.EXTENSION_AUTOLINK
- extensions |= blackfriday.EXTENSION_STRIKETHROUGH
- extensions |= blackfriday.EXTENSION_SPACE_HEADERS
- extensions |= blackfriday.EXTENSION_NO_EMPTY_LINE_BEFORE_BLOCK
-
- if setting.Markdown.EnableHardLineBreak {
- extensions |= blackfriday.EXTENSION_HARD_LINE_BREAK
- }
-
- body = blackfriday.Markdown(body, renderer, extensions)
- return body
-}
-
-var (
- leftAngleBracket = []byte("</")
- rightAngleBracket = []byte(">")
-)
-
-var noEndTags = []string{"img", "input", "br", "hr"}
-
-// PostProcessMarkdown treats different types of HTML differently,
-// and only renders special links for plain text blocks.
-func PostProcessMarkdown(rawHtml []byte, urlPrefix string, metas map[string]string) []byte {
- startTags := make([]string, 0, 5)
- var buf bytes.Buffer
- tokenizer := html.NewTokenizer(bytes.NewReader(rawHtml))
-
-OUTER_LOOP:
- for html.ErrorToken != tokenizer.Next() {
- token := tokenizer.Token()
- switch token.Type {
- case html.TextToken:
- buf.Write(RenderSpecialLink([]byte(token.String()), urlPrefix, metas))
-
- case html.StartTagToken:
- buf.WriteString(token.String())
- tagName := token.Data
- // If this is an excluded tag, we skip processing all output until a close tag is encountered.
- if strings.EqualFold("a", tagName) || strings.EqualFold("code", tagName) || strings.EqualFold("pre", tagName) {
- stackNum := 1
- for html.ErrorToken != tokenizer.Next() {
- token = tokenizer.Token()
-
- // Copy the token to the output verbatim
- buf.WriteString(token.String())
-
- if token.Type == html.StartTagToken {
- stackNum++
- }
-
- // If this is the close tag to the outer-most, we are done
- if token.Type == html.EndTagToken {
- stackNum--
-
- if stackNum <= 0 && strings.EqualFold(tagName, token.Data) {
- break
- }
- }
- }
- continue OUTER_LOOP
- }
-
- if !com.IsSliceContainsStr(noEndTags, token.Data) {
- startTags = append(startTags, token.Data)
- }
-
- case html.EndTagToken:
- if len(startTags) == 0 {
- buf.WriteString(token.String())
- break
- }
-
- buf.Write(leftAngleBracket)
- buf.WriteString(startTags[len(startTags)-1])
- buf.Write(rightAngleBracket)
- startTags = startTags[:len(startTags)-1]
- default:
- buf.WriteString(token.String())
- }
- }
-
- if io.EOF == tokenizer.Err() {
- return buf.Bytes()
- }
-
- // If we are not at the end of the input, then some other parsing error has occurred,
- // so return the input verbatim.
- return rawHtml
-}
-
-func RenderMarkdown(rawBytes []byte, urlPrefix string, metas map[string]string) []byte {
- result := RenderRawMarkdown(rawBytes, urlPrefix)
- result = PostProcessMarkdown(result, urlPrefix, metas)
- result = Sanitizer.SanitizeBytes(result)
- return result
-}
-
-func RenderMarkdownString(raw, urlPrefix string, metas map[string]string) string {
- return string(RenderMarkdown([]byte(raw), urlPrefix, metas))
-}
diff --git a/modules/base/tool.go b/modules/base/tool.go
index 811a76960c..bc6ff81a14 100644
--- a/modules/base/tool.go
+++ b/modules/base/tool.go
@@ -15,14 +15,14 @@ import (
"hash"
"html/template"
"math"
- "regexp"
+ "net/http"
"strings"
"time"
+ "unicode"
"unicode/utf8"
"github.com/Unknwon/com"
"github.com/Unknwon/i18n"
- "github.com/microcosm-cc/bluemonday"
"github.com/gogits/chardet"
@@ -30,20 +30,6 @@ import (
"github.com/gogits/gogs/modules/setting"
)
-var Sanitizer = bluemonday.UGCPolicy()
-
-func BuildSanitizer() {
- // Normal markdown-stuff
- Sanitizer.AllowAttrs("class").Matching(regexp.MustCompile(`[\p{L}\p{N}\s\-_',:\[\]!\./\\\(\)&]*`)).OnElements("code")
-
- // Checkboxes
- Sanitizer.AllowAttrs("type").Matching(regexp.MustCompile(`^checkbox$`)).OnElements("input")
- Sanitizer.AllowAttrs("checked", "disabled").OnElements("input")
-
- // Custom URL-Schemes
- Sanitizer.AllowURLSchemes(setting.Markdown.CustomURLSchemes...)
-}
-
// EncodeMD5 encodes string to md5 hex value.
func EncodeMD5(str string) string {
m := md5.New()
@@ -504,3 +490,25 @@ func Int64sToMap(ints []int64) map[int64]bool {
}
return m
}
+
+// IsLetter reports whether the rune is a letter (category L).
+// https://github.com/golang/go/blob/master/src/go/scanner/scanner.go#L257
+func IsLetter(ch rune) bool {
+ return 'a' <= ch && ch <= 'z' || 'A' <= ch && ch <= 'Z' || ch == '_' || ch >= 0x80 && unicode.IsLetter(ch)
+}
+
+func IsTextFile(data []byte) (string, bool) {
+ contentType := http.DetectContentType(data)
+ if strings.Index(contentType, "text/") != -1 {
+ return contentType, true
+ }
+ return contentType, false
+}
+
+func IsImageFile(data []byte) (string, bool) {
+ contentType := http.DetectContentType(data)
+ if strings.Index(contentType, "image/") != -1 {
+ return contentType, true
+ }
+ return contentType, false
+}