Fix commit id / issue id link in markdown.

This commit is contained in:
takezoe
2013-06-09 00:32:28 +09:00
parent 5c79124bf9
commit ef677bdb08
7 changed files with 50 additions and 37 deletions

View File

@@ -27,8 +27,13 @@ trait RepositoryViewerControllerBase extends ControllerBase {
val owner = params("owner") val owner = params("owner")
val repository = params("repository") val repository = params("repository")
val content = params("content") val content = params("content")
val enableWikiLink = params("enableWikiLink").toBoolean
val enableCommitLink = params("enableCommitLink").toBoolean
val enableIssueLink = params("enableIssueLink").toBoolean
contentType = "text/html" contentType = "text/html"
view.helpers.markdown(content, getRepository(owner, repository, servletContext).get, true) view.helpers.markdown(content, getRepository(owner, repository, servletContext).get,
enableWikiLink, enableCommitLink, enableIssueLink)
}) })
/** /**

View File

@@ -12,19 +12,19 @@ object Markdown {
* Converts Markdown of Wiki pages to HTML. * Converts Markdown of Wiki pages to HTML.
*/ */
def toHtml(markdown: String, repository: service.RepositoryService.RepositoryInfo, def toHtml(markdown: String, repository: service.RepositoryService.RepositoryInfo,
wikiLink: Boolean)(implicit context: app.Context): String = { enableWikiLink: Boolean, enableCommitLink: Boolean, enableIssueLink: Boolean)(implicit context: app.Context): String = {
val rootNode = new PegDownProcessor( val rootNode = new PegDownProcessor(
Extensions.AUTOLINKS | Extensions.WIKILINKS | Extensions.FENCED_CODE_BLOCKS | Extensions.TABLES Extensions.AUTOLINKS | Extensions.WIKILINKS | Extensions.FENCED_CODE_BLOCKS | Extensions.TABLES
).parseMarkdown(markdown.toCharArray) ).parseMarkdown(markdown.toCharArray)
new GitBucketHtmlSerializer(markdown, wikiLink, context, repository).toHtml(rootNode) new GitBucketHtmlSerializer(markdown, context, repository, enableWikiLink, enableCommitLink, enableIssueLink).toHtml(rootNode)
} }
} }
class GitBucketLinkRender(wikiLink: Boolean, context: app.Context, class GitBucketLinkRender(context: app.Context, repository: service.RepositoryService.RepositoryInfo,
repository: service.RepositoryService.RepositoryInfo) extends LinkRenderer { enableWikiLink: Boolean) extends LinkRenderer {
override def render(node: WikiLinkNode): Rendering = { override def render(node: WikiLinkNode): Rendering = {
if(wikiLink){ if(enableWikiLink){
super.render(node) super.render(node)
} else { } else {
try { try {
@@ -62,30 +62,32 @@ class GitBucketVerbatimSerializer extends VerbatimSerializer {
} }
} }
// /** class GitBucketHtmlSerializer(markdown: String, context: app.Context, repository: service.RepositoryService.RepositoryInfo,
// * Converts the issue number and the commit id to the link. enableWikiLink: Boolean, enableCommitLink: Boolean, enableIssueLink: Boolean) extends ToHtmlSerializer(
// */ new GitBucketLinkRender(context, repository, enableWikiLink),
// private def markdownFilter(value: String, repository: service.RepositoryService.RepositoryInfo)(implicit context: app.Context): String = {
// value
// .replaceAll("#([0-9]+)", "[$0](%s/%s/%s/issue/$1)".format(context.path, repository.owner, repository.name))
// .replaceAll("[0-9a-f]{40}", "[$0](%s/%s/%s/commit/$0)".format(context.path, repository.owner, repository.name))
// }
class GitBucketHtmlSerializer(markdown: String, wikiLink: Boolean, context: app.Context, repository: service.RepositoryService.RepositoryInfo)
extends ToHtmlSerializer(
new GitBucketLinkRender(wikiLink, context, repository),
Map[String, VerbatimSerializer](VerbatimSerializer.DEFAULT -> new GitBucketVerbatimSerializer).asJava Map[String, VerbatimSerializer](VerbatimSerializer.DEFAULT -> new GitBucketVerbatimSerializer).asJava
) { ) {
override def toHtml(rootNode: RootNode): String = {
val html = super.toHtml(rootNode)
if(enableIssueLink){
// convert marked issue id to link.
html.replaceAll("#\\{\\{\\{\\{([0-9]+)\\}\\}\\}\\}",
"<a href=\"%s/%s/%s/issue/$1\">#$1</a>".format(context.path, repository.owner, repository.name))
} else html
}
override def visit(node: TextNode) { override def visit(node: TextNode) {
// convert commit id to link. // convert commit id to link.
val text = node.getText.replaceAll("[0-9a-f]{40}", val text1 = if(enableCommitLink) node.getText.replaceAll("[0-9a-f]{40}",
"<a href=\"%s/%s/%s/commit/$0\">$0</a>".format(context.path, repository.owner, repository.name)) "<a href=\"%s/%s/%s/commit/$0\">$0</a>".format(context.path, repository.owner, repository.name))
else node.getText
// convert issue id to link // mark issue id to link
val startIndex = node.getStartIndex val startIndex = node.getStartIndex
val text2 = if(startIndex > 0 && markdown.charAt(startIndex - 1) == '#'){ val text2 = if(enableIssueLink && startIndex > 0 && markdown.charAt(startIndex - 1) == '#'){
text.replaceFirst("^([0-9]+)", "<a href=\"%s/%s/%s/issue/$1\">$0</a>".format(context.path, repository.owner, repository.name)) text1.replaceFirst("^([0-9]+)", "{{{{$0}}}}")
} else text } else text1
if (abbreviations.isEmpty) { if (abbreviations.isEmpty) {
printer.print(text2) printer.print(text2)
@@ -94,7 +96,13 @@ class GitBucketHtmlSerializer(markdown: String, wikiLink: Boolean, context: app.
} }
} }
override def visit(node: SpecialTextNode) { override def visit(node: HeaderNode) {
printer.printEncoded(node.getText) if(enableIssueLink && markdown.substring(node.getStartIndex, node.getEndIndex).startsWith("#")){
printer.print("#" * node.getLevel)
visitChildren(node)
} else {
printTag(node, "h" + node.getLevel)
} }
}
} }

View File

@@ -1,13 +1,8 @@
package view package view
import java.util.Date import java.util.Date
import java.text.SimpleDateFormat import java.text.SimpleDateFormat
import twirl.api.Html import twirl.api.Html
import org.pegdown._
import org.pegdown.LinkRenderer.Rendering
import org.pegdown.ast.WikiLinkNode
object helpers { object helpers {
/** /**
@@ -27,8 +22,9 @@ object helpers {
/** /**
* Converts Markdown of Wiki pages to HTML. * Converts Markdown of Wiki pages to HTML.
*/ */
def markdown(value: String, repository: service.RepositoryService.RepositoryInfo, wikiLink: Boolean)(implicit context: app.Context): twirl.api.Html = { def markdown(value: String, repository: service.RepositoryService.RepositoryInfo,
Html(Markdown.toHtml(value, repository, wikiLink)) enableWikiLink: Boolean, enableCommitLink: Boolean, enableIssueLink: Boolean)(implicit context: app.Context): Html = {
Html(Markdown.toHtml(value, repository, enableWikiLink, enableCommitLink, enableIssueLink))
} }
/** /**

View File

@@ -1,4 +1,5 @@
@(repository: service.RepositoryService.RepositoryInfo, content: String, style: String = "")(implicit context: app.Context) @(repository: service.RepositoryService.RepositoryInfo, content: String, enableWikiLink: Boolean,
enableCommitLink: Boolean, enableIssueLink: Boolean, style: String = "")(implicit context: app.Context)
@import context._ @import context._
<div class="tabbable"> <div class="tabbable">
<ul class="nav nav-tabs"> <ul class="nav nav-tabs">
@@ -23,7 +24,10 @@ $(function(){
$('#preview').click(function(){ $('#preview').click(function(){
$('#preview-area').html('<img src="@path/assets/common/images/indicator.gif"> Previewing...'); $('#preview-area').html('<img src="@path/assets/common/images/indicator.gif"> Previewing...');
$.post('@path/@repository.owner/@repository.name/_preview', { $.post('@path/@repository.owner/@repository.name/_preview', {
content: $('#content').val() content : $('#content').val(),
enableWikiLink : @enableWikiLink,
enableCommitLink : @enableCommitLink,
enableIssueLink : @enableIssueLink
}, function(data){ }, function(data){
$('#preview-area').html(data); $('#preview-area').html(data);
prettyPrint(); prettyPrint();

View File

@@ -55,7 +55,7 @@
@readme.map { content => @readme.map { content =>
<table class="table table-bordered"> <table class="table table-bordered">
<tr> <tr>
<td>@helpers.markdown(content, repository, false)</td> <td>@helpers.markdown(content, repository, false, true, true)</td>
</tr> </tr>
</table> </table>
} }

View File

@@ -19,7 +19,7 @@
</li> </li>
</ul> </ul>
<div class="markdown-body"> <div class="markdown-body">
@helpers.markdown(page.content, repository, true) @helpers.markdown(page.content, repository, true, false, false)
</div> </div>
<div class="small"> <div class="small">
<span class="description">Last edited by @page.committer at @helpers.datetime(page.time)</span> <span class="description">Last edited by @page.committer at @helpers.datetime(page.time)</span>

View File

@@ -21,7 +21,7 @@
<form action="@path/@repository.owner/@repository.name/wiki/@if(pageName == ""){_new} else {_edit}" method="POST" validate="true"> <form action="@path/@repository.owner/@repository.name/wiki/@if(pageName == ""){_new} else {_edit}" method="POST" validate="true">
<span id="error-pageName" class="error"></span> <span id="error-pageName" class="error"></span>
<input type="text" name="pageName" value="@pageName" style="width: 900px; font-weight: bold;" placeholder="Input a page name."/> <input type="text" name="pageName" value="@pageName" style="width: 900px; font-weight: bold;" placeholder="Input a page name."/>
@html.preview(repository, page.map(_.content).getOrElse(""), "width: 900px; height: 400px;") @html.preview(repository, page.map(_.content).getOrElse(""), true, false, false, "width: 900px; height: 400px;")
<input type="text" name="message" value="" style="width: 900px;" placeholder="Write a small message here explaining this change. (Optional)"/> <input type="text" name="message" value="" style="width: 900px;" placeholder="Write a small message here explaining this change. (Optional)"/>
<input type="hidden" name="currentPageName" value="@pageName"/> <input type="hidden" name="currentPageName" value="@pageName"/>
<input type="submit" value="Save" class="btn btn-primary"> <input type="submit" value="Save" class="btn btn-primary">