mirror of
https://github.com/gitbucket/gitbucket.git
synced 2025-11-07 22:15:51 +01:00
Fix Markdown testcase
This commit is contained in:
Naoki Takezoe
@@ -1,6 +1,7 @@
|
||||
package gitbucket.core.view
|
||||
|
||||
import java.text.Normalizer
|
||||
import java.util.regex.Pattern
|
||||
import java.util.{Optional, Locale}
|
||||
|
||||
import gitbucket.core.controller.Context
|
||||
@@ -19,7 +20,7 @@ object Markdown {
|
||||
* @param enableRefsLink if true then issue reference (e.g. #123) is rendered as link
|
||||
* @param enableAnchor if true then anchor for headline is generated
|
||||
* @param enableTaskList if true then task list syntax is available
|
||||
* @param hasWritePermission
|
||||
* @param hasWritePermission true if user has writable to ths given repository
|
||||
* @param pages the list of existing Wiki pages
|
||||
*/
|
||||
def toHtml(markdown: String,
|
||||
@@ -37,8 +38,7 @@ object Markdown {
|
||||
|
||||
// escape task list
|
||||
val source = if(enableTaskList){
|
||||
s.replaceAll("""(?m)^( *)- \[([x| ])\] """, "$1* task:$2: ")
|
||||
// escapeTaskList(s)
|
||||
escapeTaskList(s)
|
||||
} else s
|
||||
|
||||
val options = new Options()
|
||||
@@ -46,133 +46,137 @@ object Markdown {
|
||||
Marked.marked(source, options, renderer)
|
||||
}
|
||||
|
||||
// private def escapeTaskList(text: String): String = {
|
||||
// Pattern.compile("""^( *)- \[([x| ])\] """, Pattern.MULTILINE).matcher(text).replaceAll("$1* task:$2: ")
|
||||
// }
|
||||
/**
|
||||
* Extends markedj Renderer for GitBucket
|
||||
*/
|
||||
class GitBucketMarkedRenderer(options: Options, repository: RepositoryService.RepositoryInfo,
|
||||
enableWikiLink: Boolean, enableRefsLink: Boolean, enableAnchor: Boolean, enableTaskList: Boolean, hasWritePermission: Boolean,
|
||||
pages: List[String])
|
||||
(implicit val context: Context) extends Renderer(options) with LinkConverter with RequestCache {
|
||||
|
||||
}
|
||||
override def heading(text: String, level: Int, raw: String): String = {
|
||||
val id = generateAnchorName(text)
|
||||
val out = new StringBuilder()
|
||||
|
||||
class GitBucketMarkedRenderer(options: Options, repository: RepositoryService.RepositoryInfo,
|
||||
enableWikiLink: Boolean, enableRefsLink: Boolean, enableAnchor: Boolean, enableTaskList: Boolean, hasWritePermission: Boolean,
|
||||
pages: List[String])
|
||||
(implicit val context: Context) extends Renderer(options) with LinkConverter with RequestCache {
|
||||
out.append("<h" + level + " id=\"" + options.getHeaderPrefix + id + "\" class=\"markdown-head\">")
|
||||
|
||||
override def heading(text: String, level: Int, raw: String): String = {
|
||||
val id = generateAnchorName(text)
|
||||
val out = new StringBuilder()
|
||||
|
||||
out.append("<h" + level + " id=\"" + options.getHeaderPrefix + id + "\" class=\"markdown-head\">")
|
||||
|
||||
if(enableAnchor){
|
||||
out.append("<a class=\"markdown-anchor-link\" href=\"#" + id + "\"></a>")
|
||||
out.append("<a class=\"markdown-anchor\" name=\"" + id + "\"></a>")
|
||||
}
|
||||
|
||||
out.append(text)
|
||||
out.append("</h" + level + ">\n")
|
||||
out.toString()
|
||||
}
|
||||
|
||||
override def code(code: String, lang: Optional[String], escaped: Boolean): String = {
|
||||
"<pre class=\"prettyprint" + (if(lang.isPresent) s" ${options.getLangPrefix}${lang.get}" else "" )+ "\">" +
|
||||
(if(escaped) code else escape(code, true)) + "</pre>"
|
||||
}
|
||||
|
||||
override def list(body: String, ordered: Boolean): String = {
|
||||
var listType: String = null
|
||||
if (ordered) {
|
||||
listType = "ol"
|
||||
}
|
||||
else {
|
||||
listType = "ul"
|
||||
}
|
||||
if(body.contains("""class="task-list-item-checkbox"""")){
|
||||
return "<" + listType + " class=\"task-list\">\n" + body + "</" + listType + ">\n"
|
||||
} else {
|
||||
return "<" + listType + ">\n" + body + "</" + listType + ">\n"
|
||||
}
|
||||
}
|
||||
|
||||
override def listitem(text: String): String = {
|
||||
if(text.contains("""class="task-list-item-checkbox" """)){
|
||||
return "<li class=\"task-list-item\">" + text + "</li>\n"
|
||||
} else {
|
||||
return "<li>" + text + "</li>\n"
|
||||
}
|
||||
}
|
||||
|
||||
override def text(text: String): String = {
|
||||
// convert commit id and username to link.
|
||||
val t1 = if(enableRefsLink) convertRefsLinks(text, repository, "issue:") else text
|
||||
|
||||
// convert task list to checkbox.
|
||||
val t2 = if(enableTaskList) convertCheckBox(t1, hasWritePermission) else t1
|
||||
|
||||
t2
|
||||
}
|
||||
|
||||
override def link(href: String, title: Optional[String], text: String): String = {
|
||||
super.link(fixUrl(href, true), title, text)
|
||||
}
|
||||
|
||||
override def image(href: String, title: Optional[String], text: String): String = {
|
||||
super.image(fixUrl(href, true), title, text)
|
||||
}
|
||||
|
||||
override def nolink(text: String): String = {
|
||||
if(enableWikiLink && text.startsWith("[[") && text.endsWith("]]")){
|
||||
val link = text.replaceAll("(^\\[\\[|\\]\\]$)", "")
|
||||
|
||||
val (label, page) = if(link.contains('|')){
|
||||
val i = link.indexOf('|')
|
||||
(link.substring(0, i), link.substring(i + 1))
|
||||
} else {
|
||||
(link, link)
|
||||
if(enableAnchor){
|
||||
out.append("<a class=\"markdown-anchor-link\" href=\"#" + id + "\"></a>")
|
||||
out.append("<a class=\"markdown-anchor\" name=\"" + id + "\"></a>")
|
||||
}
|
||||
|
||||
val url = repository.httpUrl.replaceFirst("/git/", "/").stripSuffix(".git") + "/wiki/" + StringUtil.urlEncode(page)
|
||||
if(pages.contains(page)){
|
||||
"<a href=\"" + url + "\">" + escape(label) + "</a>"
|
||||
} else {
|
||||
"<a href=\"" + url + "\" class=\"absent\">" + escape(label) + "</a>"
|
||||
}
|
||||
} else {
|
||||
escape(text)
|
||||
out.append(text)
|
||||
out.append("</h" + level + ">\n")
|
||||
out.toString()
|
||||
}
|
||||
|
||||
override def code(code: String, lang: Optional[String], escaped: Boolean): String = {
|
||||
"<pre class=\"prettyprint" + (if(lang.isPresent) s" ${options.getLangPrefix}${lang.get}" else "" )+ "\">" +
|
||||
(if(escaped) code else escape(code, true)) + "</pre>"
|
||||
}
|
||||
|
||||
override def list(body: String, ordered: Boolean): String = {
|
||||
var listType: String = null
|
||||
if (ordered) {
|
||||
listType = "ol"
|
||||
}
|
||||
else {
|
||||
listType = "ul"
|
||||
}
|
||||
if(body.contains("""class="task-list-item-checkbox"""")){
|
||||
return "<" + listType + " class=\"task-list\">\n" + body + "</" + listType + ">\n"
|
||||
} else {
|
||||
return "<" + listType + ">\n" + body + "</" + listType + ">\n"
|
||||
}
|
||||
}
|
||||
|
||||
override def listitem(text: String): String = {
|
||||
if(text.contains("""class="task-list-item-checkbox" """)){
|
||||
return "<li class=\"task-list-item\">" + text + "</li>\n"
|
||||
} else {
|
||||
return "<li>" + text + "</li>\n"
|
||||
}
|
||||
}
|
||||
|
||||
override def text(text: String): String = {
|
||||
// convert commit id and username to link.
|
||||
val t1 = if(enableRefsLink) convertRefsLinks(text, repository, "issue:") else text
|
||||
|
||||
// convert task list to checkbox.
|
||||
val t2 = if(enableTaskList) convertCheckBox(t1, hasWritePermission) else t1
|
||||
|
||||
t2
|
||||
}
|
||||
|
||||
override def link(href: String, title: Optional[String], text: String): String = {
|
||||
super.link(fixUrl(href, true), title, text)
|
||||
}
|
||||
|
||||
override def image(href: String, title: Optional[String], text: String): String = {
|
||||
super.image(fixUrl(href, true), title, text)
|
||||
}
|
||||
|
||||
override def nolink(text: String): String = {
|
||||
if(enableWikiLink && text.startsWith("[[") && text.endsWith("]]")){
|
||||
val link = text.replaceAll("(^\\[\\[|\\]\\]$)", "")
|
||||
|
||||
val (label, page) = if(link.contains('|')){
|
||||
val i = link.indexOf('|')
|
||||
(link.substring(0, i), link.substring(i + 1))
|
||||
} else {
|
||||
(link, link)
|
||||
}
|
||||
|
||||
val url = repository.httpUrl.replaceFirst("/git/", "/").stripSuffix(".git") + "/wiki/" + StringUtil.urlEncode(page)
|
||||
if(pages.contains(page)){
|
||||
"<a href=\"" + url + "\">" + escape(label) + "</a>"
|
||||
} else {
|
||||
"<a href=\"" + url + "\" class=\"absent\">" + escape(label) + "</a>"
|
||||
}
|
||||
} else {
|
||||
escape(text)
|
||||
}
|
||||
}
|
||||
|
||||
private def fixUrl(url: String, isImage: Boolean = false): String = {
|
||||
if(url.startsWith("http://") || url.startsWith("https://") || url.startsWith("/")){
|
||||
url
|
||||
} else if(url.startsWith("#")){
|
||||
("#" + generateAnchorName(url.substring(1)))
|
||||
} else if(!enableWikiLink){
|
||||
if(context.currentPath.contains("/blob/")){
|
||||
url + (if(isImage) "?raw=true" else "")
|
||||
} else if(context.currentPath.contains("/tree/")){
|
||||
val paths = context.currentPath.split("/")
|
||||
val branch = if(paths.length > 3) paths.drop(4).mkString("/") else repository.repository.defaultBranch
|
||||
repository.httpUrl.replaceFirst("/git/", "/").stripSuffix(".git") + "/blob/" + branch + "/" + url + (if(isImage) "?raw=true" else "")
|
||||
} else {
|
||||
val paths = context.currentPath.split("/")
|
||||
val branch = if(paths.length > 3) paths.last else repository.repository.defaultBranch
|
||||
repository.httpUrl.replaceFirst("/git/", "/").stripSuffix(".git") + "/blob/" + branch + "/" + url + (if(isImage) "?raw=true" else "")
|
||||
}
|
||||
} else {
|
||||
repository.httpUrl.replaceFirst("/git/", "/").stripSuffix(".git") + "/wiki/_blob/" + url
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
private def fixUrl(url: String, isImage: Boolean = false): String = {
|
||||
if(url.startsWith("http://") || url.startsWith("https://") || url.startsWith("/")){
|
||||
url
|
||||
} else if(url.startsWith("#")){
|
||||
("#" + generateAnchorName(url.substring(1)))
|
||||
} else if(!enableWikiLink){
|
||||
if(context.currentPath.contains("/blob/")){
|
||||
url + (if(isImage) "?raw=true" else "")
|
||||
} else if(context.currentPath.contains("/tree/")){
|
||||
val paths = context.currentPath.split("/")
|
||||
val branch = if(paths.length > 3) paths.drop(4).mkString("/") else repository.repository.defaultBranch
|
||||
repository.httpUrl.replaceFirst("/git/", "/").stripSuffix(".git") + "/blob/" + branch + "/" + url + (if(isImage) "?raw=true" else "")
|
||||
} else {
|
||||
val paths = context.currentPath.split("/")
|
||||
val branch = if(paths.length > 3) paths.last else repository.repository.defaultBranch
|
||||
repository.httpUrl.replaceFirst("/git/", "/").stripSuffix(".git") + "/blob/" + branch + "/" + url + (if(isImage) "?raw=true" else "")
|
||||
}
|
||||
} else {
|
||||
repository.httpUrl.replaceFirst("/git/", "/").stripSuffix(".git") + "/wiki/_blob/" + url
|
||||
}
|
||||
def escapeTaskList(text: String): String = {
|
||||
Pattern.compile("""^( *)- \[([x| ])\] """, Pattern.MULTILINE).matcher(text).replaceAll("$1* task:$2: ")
|
||||
}
|
||||
|
||||
private def generateAnchorName(text: String): String = {
|
||||
def generateAnchorName(text: String): String = {
|
||||
val normalized = Normalizer.normalize(text.replaceAll("<.*>", "").replaceAll("[\\s]", "-"), Normalizer.Form.NFD)
|
||||
val encoded = StringUtil.urlEncode(normalized)
|
||||
encoded.toLowerCase(Locale.ENGLISH)
|
||||
}
|
||||
|
||||
private def convertCheckBox(text: String, hasWritePermission: Boolean): String = {
|
||||
def convertCheckBox(text: String, hasWritePermission: Boolean): String = {
|
||||
val disabled = if (hasWritePermission) "" else "disabled"
|
||||
text.replaceAll("task:x:", """<input type="checkbox" class="task-list-item-checkbox" checked="checked" """ + disabled + "/>")
|
||||
.replaceAll("task: :", """<input type="checkbox" class="task-list-item-checkbox" """ + disabled + "/>")
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
|
||||
@@ -2,9 +2,9 @@ package gitbucket.core.view
|
||||
|
||||
import org.specs2.mutable._
|
||||
|
||||
class GitBucketHtmlSerializerSpec extends Specification {
|
||||
class MarkdownSpec extends Specification {
|
||||
|
||||
import GitBucketHtmlSerializer._
|
||||
import Markdown._
|
||||
|
||||
"generateAnchorName" should {
|
||||
"convert whitespace characters to hyphens" in {
|
||||
Reference in New Issue
Block a user