third_party
/
gitea
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Make markdown as an independent module

Browse Source
tokarchuk/v1.17
Unknwon 9 years ago
parent d8a994ef24
commit d5a3021a7d
14 changed files with 157 additions and 143 deletions
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Show Stats Download Patch File Download Diff File
  1. 6
      models/repo.go
  2. 5
      models/user.go
  3. 6
      modules/avatar/avatar.go
  4. 19
      modules/base/base.go
  5. 40
      modules/base/tool.go
  6. 5
      modules/mailer/mail.go
  7. 171
      modules/markdown/markdown.go
  8. 5
      modules/template/template.go
  9. 8
      routers/api/v1/misc/markdown.go
  10. 3
      routers/install.go
  11. 13
      routers/repo/issue.go
  12. 5
      routers/repo/release.go
  13. 11
      routers/repo/view.go
  14. 3
      routers/repo/wiki.go

6
models/repo.go
Unescape View File

@ -30,9 +30,9 @@ import (
"github.com/gogits/git-module" "github.com/gogits/git-module"
api "github.com/gogits/go-gogs-client" api "github.com/gogits/go-gogs-client"
"github.com/gogits/gogs/modules/base"
"github.com/gogits/gogs/modules/bindata" "github.com/gogits/gogs/modules/bindata"
"github.com/gogits/gogs/modules/log" "github.com/gogits/gogs/modules/log"
"github.com/gogits/gogs/modules/markdown"
"github.com/gogits/gogs/modules/process" "github.com/gogits/gogs/modules/process"
"github.com/gogits/gogs/modules/setting" "github.com/gogits/gogs/modules/setting"
) )
@ -342,7 +342,7 @@ func (repo *Repository) CanEnablePulls() bool {
// AllowPulls returns true if repository meets the requirements of accepting pulls and has them enabled. // AllowPulls returns true if repository meets the requirements of accepting pulls and has them enabled.
func (repo *Repository) AllowsPulls() bool { func (repo *Repository) AllowsPulls() bool {
return repo.CanEnablePulls() && repo.EnablePulls; return repo.CanEnablePulls() && repo.EnablePulls
} }
func (repo *Repository) NextIssueIndex() int64 { func (repo *Repository) NextIssueIndex() int64 {
@ -358,7 +358,7 @@ func (repo *Repository) DescriptionHtml() template.HTML {
sanitize := func(s string) string { sanitize := func(s string) string {
return fmt.Sprintf(`<a href="%[1]s" target="_blank">%[1]s</a>`, s) return fmt.Sprintf(`<a href="%[1]s" target="_blank">%[1]s</a>`, s)
} }
return template.HTML(DescPattern.ReplaceAllStringFunc(base.Sanitizer.Sanitize(repo.Description), sanitize)) return template.HTML(DescPattern.ReplaceAllStringFunc(markdown.Sanitizer.Sanitize(repo.Description), sanitize))
} }
func (repo *Repository) LocalCopyPath() string { func (repo *Repository) LocalCopyPath() string {

5
models/user.go
Unescape View File

@ -29,6 +29,7 @@ import (
"github.com/gogits/gogs/modules/avatar" "github.com/gogits/gogs/modules/avatar"
"github.com/gogits/gogs/modules/base" "github.com/gogits/gogs/modules/base"
"github.com/gogits/gogs/modules/log" "github.com/gogits/gogs/modules/log"
"github.com/gogits/gogs/modules/markdown"
"github.com/gogits/gogs/modules/setting" "github.com/gogits/gogs/modules/setting"
) )
@ -111,7 +112,7 @@ func (u *User) BeforeUpdate() {
func (u *User) AfterSet(colName string, _ xorm.Cell) { func (u *User) AfterSet(colName string, _ xorm.Cell) {
switch colName { switch colName {
case "full_name": case "full_name":
u.FullName = base.Sanitizer.Sanitize(u.FullName) u.FullName = markdown.Sanitizer.Sanitize(u.FullName)
case "created": case "created":
u.Created = regulateTimeZone(u.Created) u.Created = regulateTimeZone(u.Created)
} }
@ -641,7 +642,7 @@ func updateUser(e Engine, u *User) error {
u.Description = u.Description[:255] u.Description = u.Description[:255]
} }
u.FullName = base.Sanitizer.Sanitize(u.FullName) u.FullName = markdown.Sanitizer.Sanitize(u.FullName)
_, err := e.Id(u.Id).AllCols().Update(u) _, err := e.Id(u.Id).AllCols().Update(u)
return err return err
} }

6
modules/avatar/avatar.go
Unescape View File

@ -16,6 +16,8 @@ import (
const _RANDOM_AVATAR_SIZE = 200 const _RANDOM_AVATAR_SIZE = 200
// RandomImage generates and returns a random avatar image unique to input data
// in custom size (height and width).
func RandomImageSize(size int, data []byte) (image.Image, error) { func RandomImageSize(size int, data []byte) (image.Image, error) {
randExtent := len(palette.WebSafe) - 32 randExtent := len(palette.WebSafe) - 32
rand.Seed(time.Now().UnixNano()) rand.Seed(time.Now().UnixNano())
@ -34,8 +36,8 @@ func RandomImageSize(size int, data []byte) (image.Image, error) {
return imgMaker.Make(data), nil return imgMaker.Make(data), nil
} }
// RandomImage generates and returns a random avatar image. // RandomImage generates and returns a random avatar image unique to input data
// The data should normally be the []byte type of email address. // in default size (height and width).
func RandomImage(data []byte) (image.Image, error) { func RandomImage(data []byte) (image.Image, error) {
return RandomImageSize(_RANDOM_AVATAR_SIZE, data) return RandomImageSize(_RANDOM_AVATAR_SIZE, data)
} }

19
modules/base/base.go
Unescape View File

@ -4,27 +4,8 @@
package base package base
import (
"os"
"os/exec"
"path/filepath"
)
const DOC_URL = "https://github.com/gogits/go-gogs-client/wiki" const DOC_URL = "https://github.com/gogits/go-gogs-client/wiki"
type ( type (
TplName string 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
}

40
modules/base/tool.go
Unescape View File

@ -15,14 +15,14 @@ import (
"hash" "hash"
"html/template" "html/template"
"math" "math"
"regexp" "net/http"
"strings" "strings"
"time" "time"
"unicode"
"unicode/utf8" "unicode/utf8"
"github.com/Unknwon/com" "github.com/Unknwon/com"
"github.com/Unknwon/i18n" "github.com/Unknwon/i18n"
"github.com/microcosm-cc/bluemonday"
"github.com/gogits/chardet" "github.com/gogits/chardet"
@ -30,20 +30,6 @@ import (
"github.com/gogits/gogs/modules/setting" "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. // EncodeMD5 encodes string to md5 hex value.
func EncodeMD5(str string) string { func EncodeMD5(str string) string {
m := md5.New() m := md5.New()
@ -504,3 +490,25 @@ func Int64sToMap(ints []int64) map[int64]bool {
} }
return m 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
}

5
modules/mailer/mail.go
Unescape View File

@ -14,6 +14,7 @@ import (
"github.com/gogits/gogs/models" "github.com/gogits/gogs/models"
"github.com/gogits/gogs/modules/base" "github.com/gogits/gogs/modules/base"
"github.com/gogits/gogs/modules/log" "github.com/gogits/gogs/modules/log"
"github.com/gogits/gogs/modules/markdown"
"github.com/gogits/gogs/modules/setting" "github.com/gogits/gogs/modules/setting"
) )
@ -126,7 +127,7 @@ func SendIssueNotifyMail(u, owner *models.User, repo *models.Repository, issue *
subject := fmt.Sprintf("[%s] %s (#%d)", repo.Name, issue.Name, issue.Index) subject := fmt.Sprintf("[%s] %s (#%d)", repo.Name, issue.Name, issue.Index)
content := fmt.Sprintf("%s<br>-<br> <a href=\"%s%s/%s/issues/%d\">View it on Gogs</a>.", content := fmt.Sprintf("%s<br>-<br> <a href=\"%s%s/%s/issues/%d\">View it on Gogs</a>.",
base.RenderSpecialLink([]byte(strings.Replace(issue.Content, "\n", "<br>", -1)), owner.Name+"/"+repo.Name, repo.ComposeMetas()), markdown.RenderSpecialLink([]byte(strings.Replace(issue.Content, "\n", "<br>", -1)), owner.Name+"/"+repo.Name, repo.ComposeMetas()),
setting.AppUrl, owner.Name, repo.Name, issue.Index) setting.AppUrl, owner.Name, repo.Name, issue.Index)
msg := NewMessage(tos, subject, content) msg := NewMessage(tos, subject, content)
msg.Info = fmt.Sprintf("Subject: %s, issue notify", subject) msg.Info = fmt.Sprintf("Subject: %s, issue notify", subject)
@ -149,7 +150,7 @@ func SendIssueMentionMail(r macaron.Render, u, owner *models.User,
data["IssueLink"] = fmt.Sprintf("%s/%s/issues/%d", owner.Name, repo.Name, issue.Index) data["IssueLink"] = fmt.Sprintf("%s/%s/issues/%d", owner.Name, repo.Name, issue.Index)
data["Subject"] = subject data["Subject"] = subject
data["ActUserName"] = u.DisplayName() data["ActUserName"] = u.DisplayName()
data["Content"] = string(base.RenderSpecialLink([]byte(issue.Content), owner.Name+"/"+repo.Name, repo.ComposeMetas())) data["Content"] = string(markdown.RenderSpecialLink([]byte(issue.Content), owner.Name+"/"+repo.Name, repo.ComposeMetas()))
body, err := r.HTMLString(string(NOTIFY_MENTION), data) body, err := r.HTMLString(string(NOTIFY_MENTION), data)
if err != nil { if err != nil {

171
modules/base/markdown.go → modules/markdown/markdown.go
Unescape View File

@ -2,41 +2,51 @@
// Use of this source code is governed by a MIT-style // Use of this source code is governed by a MIT-style
// license that can be found in the LICENSE file. // license that can be found in the LICENSE file.
package base package markdown
import ( import (
"bytes" "bytes"
"fmt" "fmt"
"io" "io"
"net/http"
"path" "path"
"path/filepath" "path/filepath"
"regexp" "regexp"
"strings" "strings"
"github.com/Unknwon/com" "github.com/Unknwon/com"
"github.com/microcosm-cc/bluemonday"
"github.com/russross/blackfriday" "github.com/russross/blackfriday"
"golang.org/x/net/html" "golang.org/x/net/html"
"github.com/gogits/gogs/modules/base"
"github.com/gogits/gogs/modules/setting" "github.com/gogits/gogs/modules/setting"
) )
// TODO: put this into 'markdown' module. var Sanitizer = bluemonday.UGCPolicy()
func isletter(c byte) bool { // BuildSanitizer initializes sanitizer with allowed attributes based on settings.
return (c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z') // This function should only be called once during entire application lifecycle.
} 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")
func isalnum(c byte) bool { // Custom URL-Schemes
return (c >= '0' && c <= '9') || isletter(c) Sanitizer.AllowURLSchemes(setting.Markdown.CustomURLSchemes...)
} }
var validLinksPattern = regexp.MustCompile(`^[a-z][\w-]+://`) var validLinksPattern = regexp.MustCompile(`^[a-z][\w-]+://`)
// isLink reports whether link fits valid format.
func isLink(link []byte) bool { func isLink(link []byte) bool {
return validLinksPattern.Match(link) return validLinksPattern.Match(link)
} }
// IsMarkdownFile reports whether name looks like a Markdown file
// based on its extension.
func IsMarkdownFile(name string) bool { func IsMarkdownFile(name string) bool {
name = strings.ToLower(name) name = strings.ToLower(name)
switch filepath.Ext(name) { switch filepath.Ext(name) {
@ -46,57 +56,46 @@ func IsMarkdownFile(name string) bool {
return false return false
} }
func IsTextFile(data []byte) (string, bool) { // IsReadmeFile reports whether name looks like a README file
contentType := http.DetectContentType(data) // based on its extension.
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 { func IsReadmeFile(name string) bool {
name = strings.ToLower(name) name = strings.ToLower(name)
if len(name) < 6 { if len(name) < 6 {
return false return false
} else if len(name) == 6 { } else if len(name) == 6 {
if name == "readme" { return name == "readme"
return true
}
return false
}
if name[:7] == "readme." {
return true
} }
return false return name[:7] == "readme."
} }
var ( var (
MentionPattern = regexp.MustCompile(`(\s|^)@[0-9a-zA-Z_\.]+`) // MentionPattern matches string that mentions someone, e.g. @Unknwon
commitPattern = regexp.MustCompile(`(\s|^)https?.*commit/[0-9a-zA-Z]+(#+[0-9a-zA-Z-]*)?`) MentionPattern = regexp.MustCompile(`(\s|^)@[0-9a-zA-Z_\.]+`)
issueFullPattern = regexp.MustCompile(`(\s|^)https?.*issues/[0-9]+(#+[0-9a-zA-Z-]*)?`)
issueIndexPattern = regexp.MustCompile(`( |^|\()#[0-9]+\b`) // CommitPattern matches link to certain commit with or without trailing hash,
sha1CurrentPattern = regexp.MustCompile(`\b[0-9a-f]{40}\b`) // e.g. https://try.gogs.io/gogs/gogs/commit/d8a994ef243349f321568f9e36d5c3f444b99cae#diff-2
CommitPattern = regexp.MustCompile(`(\s|^)https?.*commit/[0-9a-zA-Z]+(#+[0-9a-zA-Z-]*)?`)
// IssueFullPattern matches link to an issue with or without trailing hash,
// e.g. https://try.gogs.io/gogs/gogs/issues/4#issue-685
IssueFullPattern = regexp.MustCompile(`(\s|^)https?.*issues/[0-9]+(#+[0-9a-zA-Z-]*)?`)
// IssueIndexPattern matches string that references to an issue, e.g. #1287
IssueIndexPattern = regexp.MustCompile(`( |^|\()#[0-9]+\b`)
// Sha1CurrentPattern matches string that represents a commit SHA, e.g. d8a994ef243349f321568f9e36d5c3f444b99cae
Sha1CurrentPattern = regexp.MustCompile(`\b[0-9a-f]{40}\b`)
) )
type CustomRender struct { // Renderer is a extended version of underlying render object.
type Renderer struct {
blackfriday.Renderer blackfriday.Renderer
urlPrefix string urlPrefix string
} }
func (r *CustomRender) Link(out *bytes.Buffer, link []byte, title []byte, content []byte) { // Link defines how formal links should be processed to produce corresponding HTML elements.
func (r *Renderer) Link(out *bytes.Buffer, link []byte, title []byte, content []byte) {
if len(link) > 0 && !isLink(link) { if len(link) > 0 && !isLink(link) {
if link[0] == '#' { if link[0] != '#' {
// link = append([]byte(options.urlPrefix), link...)
} else {
link = []byte(path.Join(r.urlPrefix, string(link))) link = []byte(path.Join(r.urlPrefix, string(link)))
} }
} }
@ -104,14 +103,17 @@ func (r *CustomRender) Link(out *bytes.Buffer, link []byte, title []byte, conten
r.Renderer.Link(out, link, title, content) r.Renderer.Link(out, link, title, content)
} }
func (r *CustomRender) AutoLink(out *bytes.Buffer, link []byte, kind int) { // AutoLink defines how auto-detected links should be processed to produce corresponding HTML elements.
if kind != 1 { // Reference for kind: https://github.com/russross/blackfriday/blob/master/markdown.go#L69-L76
func (r *Renderer) AutoLink(out *bytes.Buffer, link []byte, kind int) {
if kind != blackfriday.LINK_TYPE_NORMAL {
r.Renderer.AutoLink(out, link, kind) r.Renderer.AutoLink(out, link, kind)
return return
} }
// This method could only possibly serve one link at a time, no need to find all. // Since this method could only possibly serve one link at a time,
m := commitPattern.Find(link) // we do not need to find all.
m := CommitPattern.Find(link)
if m != nil { if m != nil {
m = bytes.TrimSpace(m) m = bytes.TrimSpace(m)
i := strings.Index(string(m), "commit/") i := strings.Index(string(m), "commit/")
@ -119,11 +121,11 @@ func (r *CustomRender) AutoLink(out *bytes.Buffer, link []byte, kind int) {
if j == -1 { if j == -1 {
j = len(m) j = len(m)
} }
out.WriteString(fmt.Sprintf(` <code><a href="%s">%s</a></code>`, m, ShortSha(string(m[i+7:j])))) out.WriteString(fmt.Sprintf(` <code><a href="%s">%s</a></code>`, m, base.ShortSha(string(m[i+7:j]))))
return return
} }
m = issueFullPattern.Find(link) m = IssueFullPattern.Find(link)
if m != nil { if m != nil {
m = bytes.TrimSpace(m) m = bytes.TrimSpace(m)
i := strings.Index(string(m), "issues/") i := strings.Index(string(m), "issues/")
@ -131,14 +133,16 @@ func (r *CustomRender) AutoLink(out *bytes.Buffer, link []byte, kind int) {
if j == -1 { if j == -1 {
j = len(m) j = len(m)
} }
out.WriteString(fmt.Sprintf(` <a href="%s">#%s</a>`, m, ShortSha(string(m[i+7:j])))) out.WriteString(fmt.Sprintf(` <a href="%s">#%s</a>`, m, base.ShortSha(string(m[i+7:j]))))
return return
} }
r.Renderer.AutoLink(out, link, kind) r.Renderer.AutoLink(out, link, kind)
} }
func (options *CustomRender) ListItem(out *bytes.Buffer, text []byte, flags int) { // ListItem defines how list items should be processed to produce corresponding HTML elements.
func (options *Renderer) ListItem(out *bytes.Buffer, text []byte, flags int) {
// Detect procedures to draw checkboxes.
switch { switch {
case bytes.HasPrefix(text, []byte("[ ] ")): case bytes.HasPrefix(text, []byte("[ ] ")):
text = append([]byte(`<input type="checkbox" disabled="" />`), text[3:]...) text = append([]byte(`<input type="checkbox" disabled="" />`), text[3:]...)
@ -148,6 +152,8 @@ func (options *CustomRender) ListItem(out *bytes.Buffer, text []byte, flags int)
options.Renderer.ListItem(out, text, flags) options.Renderer.ListItem(out, text, flags)
} }
// Note: this section is for purpose of increase performance and
// reduce memory allocation at runtime since they are constant literals.
var ( var (
svgSuffix = []byte(".svg") svgSuffix = []byte(".svg")
svgSuffixWithMark = []byte(".svg?") svgSuffixWithMark = []byte(".svg?")
@ -155,11 +161,13 @@ var (
spaceEncodedBytes = []byte("%20") spaceEncodedBytes = []byte("%20")
) )
func (r *CustomRender) Image(out *bytes.Buffer, link []byte, title []byte, alt []byte) { // Image defines how images should be processed to produce corresponding HTML elements.
func (r *Renderer) Image(out *bytes.Buffer, link []byte, title []byte, alt []byte) {
prefix := strings.Replace(r.urlPrefix, "/src/", "/raw/", 1) prefix := strings.Replace(r.urlPrefix, "/src/", "/raw/", 1)
if len(link) > 0 { if len(link) > 0 {
if isLink(link) { if isLink(link) {
// External link with .svg suffix usually means CI status. // External link with .svg suffix usually means CI status.
// TODO: define a keyword to allow non-svg images render as external link.
if bytes.HasSuffix(link, svgSuffix) || bytes.Contains(link, svgSuffixWithMark) { if bytes.HasSuffix(link, svgSuffix) || bytes.Contains(link, svgSuffixWithMark) {
r.Renderer.Image(out, link, title, alt) r.Renderer.Image(out, link, title, alt)
return return
@ -180,6 +188,8 @@ func (r *CustomRender) Image(out *bytes.Buffer, link []byte, title []byte, alt [
out.WriteString("</a>") out.WriteString("</a>")
} }
// cutoutVerbosePrefix cutouts URL prefix including sub-path to
// return a clean unified string of request URL path.
func cutoutVerbosePrefix(prefix string) string { func cutoutVerbosePrefix(prefix string) string {
count := 0 count := 0
for i := 0; i < len(prefix); i++ { for i := 0; i < len(prefix); i++ {
@ -193,29 +203,40 @@ func cutoutVerbosePrefix(prefix string) string {
return prefix return prefix
} }
// RenderIssueIndexPattern renders issue indexes to corresponding links.
func RenderIssueIndexPattern(rawBytes []byte, urlPrefix string, metas map[string]string) []byte { func RenderIssueIndexPattern(rawBytes []byte, urlPrefix string, metas map[string]string) []byte {
urlPrefix = cutoutVerbosePrefix(urlPrefix) urlPrefix = cutoutVerbosePrefix(urlPrefix)
ms := issueIndexPattern.FindAll(rawBytes, -1) ms := IssueIndexPattern.FindAll(rawBytes, -1)
for _, m := range ms { for _, m := range ms {
var space string var space string
m2 := m if m[0] != '#' {
if m2[0] != '#' { space = string(m[0])
space = string(m2[0]) m = m[1:]
m2 = m2[1:]
} }
if metas == nil { if metas == nil {
rawBytes = bytes.Replace(rawBytes, m, []byte(fmt.Sprintf(`%s<a href="%s/issues/%s">%s</a>`, rawBytes = bytes.Replace(rawBytes, m, []byte(fmt.Sprintf(`%s<a href="%s/issues/%s">%s</a>`,
space, urlPrefix, m2[1:], m2)), 1) space, urlPrefix, m[1:], m)), 1)
} else { } else {
// Support for external issue tracker // Support for external issue tracker
metas["index"] = string(m2[1:]) metas["index"] = string(m[1:])
rawBytes = bytes.Replace(rawBytes, m, []byte(fmt.Sprintf(`%s<a href="%s">%s</a>`, rawBytes = bytes.Replace(rawBytes, m, []byte(fmt.Sprintf(`%s<a href="%s">%s</a>`,
space, com.Expand(metas["format"], metas), m2)), 1) space, com.Expand(metas["format"], metas), m)), 1)
} }
} }
return rawBytes return rawBytes
} }
// RenderSha1CurrentPattern renders SHA1 strings to corresponding links that assumes in the same repository.
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, base.ShortSha(string(m)))), -1)
}
return rawBytes
}
// RenderSpecialLink renders mentions, indexes and SHA1 strings to corresponding links.
func RenderSpecialLink(rawBytes []byte, urlPrefix string, metas map[string]string) []byte { func RenderSpecialLink(rawBytes []byte, urlPrefix string, metas map[string]string) []byte {
ms := MentionPattern.FindAll(rawBytes, -1) ms := MentionPattern.FindAll(rawBytes, -1)
for _, m := range ms { for _, m := range ms {
@ -229,20 +250,12 @@ func RenderSpecialLink(rawBytes []byte, urlPrefix string, metas map[string]strin
return rawBytes return rawBytes
} }
func RenderSha1CurrentPattern(rawBytes []byte, urlPrefix string) []byte { // RenderRaw renders Markdown to HTML without handling special links.
ms := sha1CurrentPattern.FindAll(rawBytes, -1) func RenderRaw(body []byte, urlPrefix string) []byte {
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 := 0
htmlFlags |= blackfriday.HTML_SKIP_STYLE htmlFlags |= blackfriday.HTML_SKIP_STYLE
htmlFlags |= blackfriday.HTML_OMIT_CONTENTS htmlFlags |= blackfriday.HTML_OMIT_CONTENTS
renderer := &CustomRender{ renderer := &Renderer{
Renderer: blackfriday.HtmlRenderer(htmlFlags, "", ""), Renderer: blackfriday.HtmlRenderer(htmlFlags, "", ""),
urlPrefix: urlPrefix, urlPrefix: urlPrefix,
} }
@ -272,9 +285,9 @@ var (
var noEndTags = []string{"img", "input", "br", "hr"} var noEndTags = []string{"img", "input", "br", "hr"}
// PostProcessMarkdown treats different types of HTML differently, // PostProcess treats different types of HTML differently,
// and only renders special links for plain text blocks. // and only renders special links for plain text blocks.
func PostProcessMarkdown(rawHtml []byte, urlPrefix string, metas map[string]string) []byte { func PostProcess(rawHtml []byte, urlPrefix string, metas map[string]string) []byte {
startTags := make([]string, 0, 5) startTags := make([]string, 0, 5)
var buf bytes.Buffer var buf bytes.Buffer
tokenizer := html.NewTokenizer(bytes.NewReader(rawHtml)) tokenizer := html.NewTokenizer(bytes.NewReader(rawHtml))
@ -342,13 +355,15 @@ OUTER_LOOP:
return rawHtml return rawHtml
} }
func RenderMarkdown(rawBytes []byte, urlPrefix string, metas map[string]string) []byte { // Render renders Markdown to HTML with special links.
result := RenderRawMarkdown(rawBytes, urlPrefix) func Render(rawBytes []byte, urlPrefix string, metas map[string]string) []byte {
result = PostProcessMarkdown(result, urlPrefix, metas) result := RenderRaw(rawBytes, urlPrefix)
result = PostProcess(result, urlPrefix, metas)
result = Sanitizer.SanitizeBytes(result) result = Sanitizer.SanitizeBytes(result)
return result return result
} }
func RenderMarkdownString(raw, urlPrefix string, metas map[string]string) string { // RenderString renders Markdown to HTML with special links and returns string type.
return string(RenderMarkdown([]byte(raw), urlPrefix, metas)) func RenderString(raw, urlPrefix string, metas map[string]string) string {
return string(Render([]byte(raw), urlPrefix, metas))
} }

5
modules/template/template.go
Unescape View File

@ -18,6 +18,7 @@ import (
"github.com/gogits/gogs/models" "github.com/gogits/gogs/models"
"github.com/gogits/gogs/modules/base" "github.com/gogits/gogs/modules/base"
"github.com/gogits/gogs/modules/markdown"
"github.com/gogits/gogs/modules/setting" "github.com/gogits/gogs/modules/setting"
) )
@ -108,7 +109,7 @@ func Safe(raw string) template.HTML {
} }
func Str2html(raw string) template.HTML { func Str2html(raw string) template.HTML {
return template.HTML(base.Sanitizer.Sanitize(raw)) return template.HTML(markdown.Sanitizer.Sanitize(raw))
} }
func Range(l int) []int { func Range(l int) []int {
@ -188,7 +189,7 @@ func ReplaceLeft(s, old, new string) string {
// RenderCommitMessage renders commit message with XSS-safe and special links. // RenderCommitMessage renders commit message with XSS-safe and special links.
func RenderCommitMessage(full bool, msg, urlPrefix string, metas map[string]string) template.HTML { func RenderCommitMessage(full bool, msg, urlPrefix string, metas map[string]string) template.HTML {
cleanMsg := template.HTMLEscapeString(msg) cleanMsg := template.HTMLEscapeString(msg)
fullMessage := string(base.RenderIssueIndexPattern([]byte(cleanMsg), urlPrefix, metas)) fullMessage := string(markdown.RenderIssueIndexPattern([]byte(cleanMsg), urlPrefix, metas))
msgLines := strings.Split(strings.TrimSpace(fullMessage), "\n") msgLines := strings.Split(strings.TrimSpace(fullMessage), "\n")
numLines := len(msgLines) numLines := len(msgLines)
if numLines == 0 { if numLines == 0 {

8
routers/api/v1/misc/markdown.go
Unescape View File

@ -7,7 +7,7 @@ package misc
import ( import (
api "github.com/gogits/go-gogs-client" api "github.com/gogits/go-gogs-client"
"github.com/gogits/gogs/modules/base" "github.com/gogits/gogs/modules/markdown"
"github.com/gogits/gogs/modules/middleware" "github.com/gogits/gogs/modules/middleware"
) )
@ -25,9 +25,9 @@ func Markdown(ctx *middleware.Context, form api.MarkdownOption) {
switch form.Mode { switch form.Mode {
case "gfm": case "gfm":
ctx.Write(base.RenderMarkdown([]byte(form.Text), form.Context, nil)) ctx.Write(markdown.Render([]byte(form.Text), form.Context, nil))
default: default:
ctx.Write(base.RenderRawMarkdown([]byte(form.Text), "")) ctx.Write(markdown.RenderRaw([]byte(form.Text), ""))
} }
} }
@ -38,5 +38,5 @@ func MarkdownRaw(ctx *middleware.Context) {
ctx.APIError(422, "", err) ctx.APIError(422, "", err)
return return
} }
ctx.Write(base.RenderRawMarkdown(body, "")) ctx.Write(markdown.RenderRaw(body, ""))
} }

3
routers/install.go
Unescape View File

@ -25,6 +25,7 @@ import (
"github.com/gogits/gogs/modules/cron" "github.com/gogits/gogs/modules/cron"
"github.com/gogits/gogs/modules/log" "github.com/gogits/gogs/modules/log"
"github.com/gogits/gogs/modules/mailer" "github.com/gogits/gogs/modules/mailer"
"github.com/gogits/gogs/modules/markdown"
"github.com/gogits/gogs/modules/middleware" "github.com/gogits/gogs/modules/middleware"
"github.com/gogits/gogs/modules/setting" "github.com/gogits/gogs/modules/setting"
"github.com/gogits/gogs/modules/ssh" "github.com/gogits/gogs/modules/ssh"
@ -93,7 +94,7 @@ func GlobalInit() {
} }
// Build Sanitizer // Build Sanitizer
base.BuildSanitizer() markdown.BuildSanitizer()
} }
func InstallInit(ctx *middleware.Context) { func InstallInit(ctx *middleware.Context) {

13
routers/repo/issue.go
Unescape View File

@ -22,6 +22,7 @@ import (
"github.com/gogits/gogs/modules/base" "github.com/gogits/gogs/modules/base"
"github.com/gogits/gogs/modules/log" "github.com/gogits/gogs/modules/log"
"github.com/gogits/gogs/modules/mailer" "github.com/gogits/gogs/modules/mailer"
"github.com/gogits/gogs/modules/markdown"
"github.com/gogits/gogs/modules/middleware" "github.com/gogits/gogs/modules/middleware"
"github.com/gogits/gogs/modules/setting" "github.com/gogits/gogs/modules/setting"
) )
@ -400,7 +401,7 @@ func ValidateRepoMetas(ctx *middleware.Context, form auth.CreateIssueForm) ([]in
func notifyWatchersAndMentions(ctx *middleware.Context, issue *models.Issue) { func notifyWatchersAndMentions(ctx *middleware.Context, issue *models.Issue) {
// Update mentions // Update mentions
mentions := base.MentionPattern.FindAllString(issue.Content, -1) mentions := markdown.MentionPattern.FindAllString(issue.Content, -1)
if len(mentions) > 0 { if len(mentions) > 0 {
for i := range mentions { for i := range mentions {
mentions[i] = strings.TrimSpace(mentions[i])[1:] mentions[i] = strings.TrimSpace(mentions[i])[1:]
@ -579,7 +580,7 @@ func ViewIssue(ctx *middleware.Context) {
ctx.Handle(500, "GetPoster", err) ctx.Handle(500, "GetPoster", err)
return return
} }
issue.RenderedContent = string(base.RenderMarkdown([]byte(issue.Content), ctx.Repo.RepoLink, issue.RenderedContent = string(markdown.Render([]byte(issue.Content), ctx.Repo.RepoLink,
ctx.Repo.Repository.ComposeMetas())) ctx.Repo.Repository.ComposeMetas()))
repo := ctx.Repo.Repository repo := ctx.Repo.Repository
@ -650,7 +651,7 @@ func ViewIssue(ctx *middleware.Context) {
participants[0] = issue.Poster participants[0] = issue.Poster
for _, comment = range issue.Comments { for _, comment = range issue.Comments {
if comment.Type == models.COMMENT_TYPE_COMMENT { if comment.Type == models.COMMENT_TYPE_COMMENT {
comment.RenderedContent = string(base.RenderMarkdown([]byte(comment.Content), ctx.Repo.RepoLink, comment.RenderedContent = string(markdown.Render([]byte(comment.Content), ctx.Repo.RepoLink,
ctx.Repo.Repository.ComposeMetas())) ctx.Repo.Repository.ComposeMetas()))
// Check tag. // Check tag.
@ -753,7 +754,7 @@ func UpdateIssueContent(ctx *middleware.Context) {
} }
ctx.JSON(200, map[string]interface{}{ ctx.JSON(200, map[string]interface{}{
"content": string(base.RenderMarkdown([]byte(issue.Content), ctx.Query("context"), ctx.Repo.Repository.ComposeMetas())), "content": string(markdown.Render([]byte(issue.Content), ctx.Query("context"), ctx.Repo.Repository.ComposeMetas())),
}) })
} }
@ -990,7 +991,7 @@ func UpdateCommentContent(ctx *middleware.Context) {
} }
ctx.JSON(200, map[string]interface{}{ ctx.JSON(200, map[string]interface{}{
"content": string(base.RenderMarkdown([]byte(comment.Content), ctx.Query("context"), ctx.Repo.Repository.ComposeMetas())), "content": string(markdown.Render([]byte(comment.Content), ctx.Query("context"), ctx.Repo.Repository.ComposeMetas())),
}) })
} }
@ -1088,7 +1089,7 @@ func Milestones(ctx *middleware.Context) {
return return
} }
for _, m := range miles { for _, m := range miles {
m.RenderedContent = string(base.RenderMarkdown([]byte(m.Content), ctx.Repo.RepoLink, ctx.Repo.Repository.ComposeMetas())) m.RenderedContent = string(markdown.Render([]byte(m.Content), ctx.Repo.RepoLink, ctx.Repo.Repository.ComposeMetas()))
m.CalOpenIssues() m.CalOpenIssues()
} }
ctx.Data["Milestones"] = miles ctx.Data["Milestones"] = miles

5
routers/repo/release.go
Unescape View File

@ -9,6 +9,7 @@ import (
"github.com/gogits/gogs/modules/auth" "github.com/gogits/gogs/modules/auth"
"github.com/gogits/gogs/modules/base" "github.com/gogits/gogs/modules/base"
"github.com/gogits/gogs/modules/log" "github.com/gogits/gogs/modules/log"
"github.com/gogits/gogs/modules/markdown"
"github.com/gogits/gogs/modules/middleware" "github.com/gogits/gogs/modules/middleware"
) )
@ -73,7 +74,7 @@ func Releases(ctx *middleware.Context) {
rel.NumCommitsBehind = ctx.Repo.CommitsCount - rel.NumCommits rel.NumCommitsBehind = ctx.Repo.CommitsCount - rel.NumCommits
} }
rel.Note = base.RenderMarkdownString(rel.Note, ctx.Repo.RepoLink, ctx.Repo.Repository.ComposeMetas()) rel.Note = markdown.RenderString(rel.Note, ctx.Repo.RepoLink, ctx.Repo.Repository.ComposeMetas())
tags[i] = rel tags[i] = rel
rels[j] = nil // Mark as used. rels[j] = nil // Mark as used.
break break
@ -137,7 +138,7 @@ func Releases(ctx *middleware.Context) {
rel.NumCommitsBehind = ctx.Repo.CommitsCount - rel.NumCommits rel.NumCommitsBehind = ctx.Repo.CommitsCount - rel.NumCommits
} }
rel.Note = base.RenderMarkdownString(rel.Note, ctx.Repo.RepoLink, ctx.Repo.Repository.ComposeMetas()) rel.Note = markdown.RenderString(rel.Note, ctx.Repo.RepoLink, ctx.Repo.Repository.ComposeMetas())
tags = append(tags, rel) tags = append(tags, rel)
} }
models.SortReleases(tags) models.SortReleases(tags)

11
routers/repo/view.go
Unescape View File

@ -17,6 +17,7 @@ import (
"github.com/gogits/gogs/models" "github.com/gogits/gogs/models"
"github.com/gogits/gogs/modules/base" "github.com/gogits/gogs/modules/base"
"github.com/gogits/gogs/modules/log" "github.com/gogits/gogs/modules/log"
"github.com/gogits/gogs/modules/markdown"
"github.com/gogits/gogs/modules/middleware" "github.com/gogits/gogs/modules/middleware"
"github.com/gogits/gogs/modules/template" "github.com/gogits/gogs/modules/template"
"github.com/gogits/gogs/modules/template/highlight" "github.com/gogits/gogs/modules/template/highlight"
@ -99,10 +100,10 @@ func Home(ctx *middleware.Context) {
case isTextFile: case isTextFile:
d, _ := ioutil.ReadAll(dataRc) d, _ := ioutil.ReadAll(dataRc)
buf = append(buf, d...) buf = append(buf, d...)
readmeExist := base.IsMarkdownFile(blob.Name()) || base.IsReadmeFile(blob.Name()) readmeExist := markdown.IsMarkdownFile(blob.Name()) || markdown.IsReadmeFile(blob.Name())
ctx.Data["ReadmeExist"] = readmeExist ctx.Data["ReadmeExist"] = readmeExist
if readmeExist { if readmeExist {
ctx.Data["FileContent"] = string(base.RenderMarkdown(buf, path.Dir(treeLink), ctx.Repo.Repository.ComposeMetas())) ctx.Data["FileContent"] = string(markdown.Render(buf, path.Dir(treeLink), ctx.Repo.Repository.ComposeMetas()))
} else { } else {
if err, content := template.ToUtf8WithErr(buf); err != nil { if err, content := template.ToUtf8WithErr(buf); err != nil {
if err != nil { if err != nil {
@ -138,7 +139,7 @@ func Home(ctx *middleware.Context) {
var readmeFile *git.Blob var readmeFile *git.Blob
for _, f := range entries { for _, f := range entries {
if f.IsDir() || !base.IsReadmeFile(f.Name()) { if f.IsDir() || !markdown.IsReadmeFile(f.Name()) {
continue continue
} else { } else {
readmeFile = f.Blob() readmeFile = f.Blob()
@ -169,8 +170,8 @@ func Home(ctx *middleware.Context) {
d, _ := ioutil.ReadAll(dataRc) d, _ := ioutil.ReadAll(dataRc)
buf = append(buf, d...) buf = append(buf, d...)
switch { switch {
case base.IsMarkdownFile(readmeFile.Name()): case markdown.IsMarkdownFile(readmeFile.Name()):
buf = base.RenderMarkdown(buf, treeLink, ctx.Repo.Repository.ComposeMetas()) buf = markdown.Render(buf, treeLink, ctx.Repo.Repository.ComposeMetas())
default: default:
buf = bytes.Replace(buf, []byte("\n"), []byte(`<br>`), -1) buf = bytes.Replace(buf, []byte("\n"), []byte(`<br>`), -1)
} }

3
routers/repo/wiki.go
Unescape View File

@ -14,6 +14,7 @@ import (
"github.com/gogits/gogs/models" "github.com/gogits/gogs/models"
"github.com/gogits/gogs/modules/auth" "github.com/gogits/gogs/modules/auth"
"github.com/gogits/gogs/modules/base" "github.com/gogits/gogs/modules/base"
"github.com/gogits/gogs/modules/markdown"
"github.com/gogits/gogs/modules/middleware" "github.com/gogits/gogs/modules/middleware"
) )
@ -106,7 +107,7 @@ func renderWikiPage(ctx *middleware.Context, isViewPage bool) (*git.Repository,
return nil, "" return nil, ""
} }
if isViewPage { if isViewPage {
ctx.Data["content"] = string(base.RenderMarkdown(data, ctx.Repo.RepoLink, ctx.Repo.Repository.ComposeMetas())) ctx.Data["content"] = string(markdown.Render(data, ctx.Repo.RepoLink, ctx.Repo.Repository.ComposeMetas()))
} else { } else {
ctx.Data["content"] = string(data) ctx.Data["content"] = string(data)
} }

Write Preview
Loading…
Cancel
Save