diff options
author | Unknwon <u@gogs.io> | 2017-04-04 19:29:59 -0400 |
---|---|---|
committer | Unknwon <u@gogs.io> | 2017-04-04 19:29:59 -0400 |
commit | d05395fe906dad7741201faa69a54fef538deda9 (patch) | |
tree | 11dae6c5c9b40b8ce85c7294bd0309c03cb1199e /modules/markup/markdown.go | |
parent | 37b10666dea98cebf75d0c6f11ee87211ef94703 (diff) |
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
Diffstat (limited to 'modules/markup/markdown.go')
-rw-r--r-- | modules/markup/markdown.go | 167 |
1 files changed, 0 insertions, 167 deletions
diff --git a/modules/markup/markdown.go b/modules/markup/markdown.go deleted file mode 100644 index c325f19f..00000000 --- a/modules/markup/markdown.go +++ /dev/null @@ -1,167 +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 markup - -import ( - "bytes" - "fmt" - "path" - "path/filepath" - "regexp" - "strings" - - "github.com/russross/blackfriday" - - "github.com/gogits/gogs/modules/base" - "github.com/gogits/gogs/modules/setting" -) - -// IsMarkdownFile reports whether name looks like a Markdown file based on its extension. -func IsMarkdownFile(name string) bool { - extension := strings.ToLower(filepath.Ext(name)) - for _, ext := range setting.Markdown.FileExtensions { - if strings.ToLower(ext) == extension { - return true - } - } - return false -} - -// MarkdownRenderer is a extended version of underlying Markdown render object. -type MarkdownRenderer struct { - blackfriday.Renderer - urlPrefix string -} - -var validLinksPattern = regexp.MustCompile(`^[a-z][\w-]+://|^mailto:`) - -// isLink reports whether link fits valid format. -func isLink(link []byte) bool { - return validLinksPattern.Match(link) -} - -// Link defines how formal links should be processed to produce corresponding HTML elements. -func (r *MarkdownRenderer) Link(out *bytes.Buffer, link []byte, title []byte, content []byte) { - if len(link) > 0 && !isLink(link) { - if link[0] != '#' { - link = []byte(path.Join(r.urlPrefix, string(link))) - } - } - - r.Renderer.Link(out, link, title, content) -} - -// AutoLink defines how auto-detected links should be processed to produce corresponding HTML elements. -// Reference for kind: https://github.com/russross/blackfriday/blob/master/markdown.go#L69-L76 -func (r *MarkdownRenderer) AutoLink(out *bytes.Buffer, link []byte, kind int) { - if kind != blackfriday.LINK_TYPE_NORMAL { - r.Renderer.AutoLink(out, link, kind) - return - } - - // Since this method could only possibly serve one link at a time, - // we do not need to find all. - if bytes.HasPrefix(link, []byte(setting.AppUrl)) { - 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, base.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) - } - - index := string(m[i+7 : j]) - fullRepoURL := setting.AppUrl + strings.TrimPrefix(r.urlPrefix, "/") - var link string - if strings.HasPrefix(string(m), fullRepoURL) { - // Use a short issue reference if the URL refers to this repository - link = fmt.Sprintf(`<a href="%s">#%s</a>`, m, index) - } else { - // Use a cross-repository issue reference if the URL refers to a different repository - repo := string(m[len(setting.AppUrl) : i-1]) - link = fmt.Sprintf(`<a href="%s">%s#%s</a>`, m, repo, index) - } - out.WriteString(link) - return - } - } - - r.Renderer.AutoLink(out, link, kind) -} - -// ListItem defines how list items should be processed to produce corresponding HTML elements. -func (options *MarkdownRenderer) ListItem(out *bytes.Buffer, text []byte, flags int) { - // Detect procedures to draw checkboxes. - 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) -} - -// RawMarkdown renders Markdown to HTML without handling special links. -func RawMarkdown(body []byte, urlPrefix string) []byte { - htmlFlags := 0 - htmlFlags |= blackfriday.HTML_SKIP_STYLE - htmlFlags |= blackfriday.HTML_OMIT_CONTENTS - - if setting.Smartypants.Enabled { - htmlFlags |= blackfriday.HTML_USE_SMARTYPANTS - if setting.Smartypants.Fractions { - htmlFlags |= blackfriday.HTML_SMARTYPANTS_FRACTIONS - } - if setting.Smartypants.Dashes { - htmlFlags |= blackfriday.HTML_SMARTYPANTS_DASHES - } - if setting.Smartypants.LatexDashes { - htmlFlags |= blackfriday.HTML_SMARTYPANTS_LATEX_DASHES - } - if setting.Smartypants.AngledQuotes { - htmlFlags |= blackfriday.HTML_SMARTYPANTS_ANGLED_QUOTES - } - } - - renderer := &MarkdownRenderer{ - 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 -} - -// Markdown takes a string or []byte and renders to HTML in Markdown syntax with special links. -func Markdown(input interface{}, urlPrefix string, metas map[string]string) []byte { - return Render(MARKDOWN, input, urlPrefix, metas) -} |