pages: Fix repo-relative reference links in markdown docs

As with explicit links, also for reference links in markdown documents
which point to repository-relative files the links are broken. They do
not take the path to the repository into account.
This fix is related to commit b23269 which fixed issue #1358
for explicit links.

diff --git a/src/main/java/com/gitblit/wicket/MarkupProcessor.java b/src/main/java/com/gitblit/wicket/MarkupProcessor.java
index 15e5433283ab7be5e8645751f5c2fb3b823de4e5..90f3808be9f5a2d3e06e59241c576688bc95cdfc 100644 (file)
--- a/src/main/java/com/gitblit/wicket/MarkupProcessor.java
+++ b/src/main/java/com/gitblit/wicket/MarkupProcessor.java
@@ -19,8 +19,6 @@ import static org.pegdown.FastEncoder.encode;
 
 import java.io.Serializable;
 import java.io.StringWriter;
-import java.io.UnsupportedEncodingException;
-import java.net.URLEncoder;
 import java.text.MessageFormat;
 import java.util.ArrayList;
 import java.util.Arrays;
@@ -49,6 +47,7 @@ import org.pegdown.VerbatimSerializer;
 import org.pegdown.ast.ExpImageNode;
 import org.pegdown.ast.ExpLinkNode;
 import org.pegdown.ast.RefImageNode;
+import org.pegdown.ast.RefLinkNode;
 import org.pegdown.ast.WikiLinkNode;
 import org.pegdown.plugins.ToHtmlSerializerPlugin;
 import org.slf4j.Logger;
@@ -266,7 +265,7 @@ public class MarkupProcessor {
                        @Override
                        public void image(Attributes attributes, String imagePath) {
                                String url;
-                               if (imagePath.indexOf("://") == -1) {
+                               if (! isFullUrl(imagePath)) {
                                        // relative image
                                        String path = doc.getRelativePath(imagePath);
                                        String contextUrl = RequestCycle.get().getRequest().getRelativePathPrefixToContextRoot();
@@ -282,7 +281,7 @@ public class MarkupProcessor {
                        public void link(Attributes attributes, String hrefOrHashName, String text) {
                                String url;
                                if (hrefOrHashName.charAt(0) != '#') {
-                                       if (hrefOrHashName.indexOf("://") == -1) {
+                                       if (! isFullUrl(hrefOrHashName)) {
                                                // relative link
                                                String path = doc.getRelativePath(hrefOrHashName);
                                                url = getWicketUrl(DocPage.class, repositoryName, commitId, path);
@@ -323,7 +322,7 @@ public class MarkupProcessor {
 
                        @Override
                        public Rendering render(ExpImageNode node, String text) {
-                               if (node.url.indexOf("://") == -1) {
+                               if (! isFullUrl(node.url)) {
                                        // repository-relative image link
                                        String path = doc.getRelativePath(node.url);
                                        String contextUrl = RequestCycle.get().getRequest().getRelativePathPrefixToContextRoot();
@@ -337,7 +336,7 @@ public class MarkupProcessor {
                        @Override
                        public Rendering render(RefImageNode node, String url, String title, String alt) {
                                Rendering rendering;
-                               if (url.indexOf("://") == -1) {
+                               if (! isFullUrl(url)) {
                                        // repository-relative image link
                                        String path = doc.getRelativePath(url);
                                        String contextUrl = RequestCycle.get().getRequest().getRelativePathPrefixToContextRoot();
@@ -363,23 +362,31 @@ public class MarkupProcessor {
                                // Relative file-like MD links needs to be re-mapped to be relative to 
                                // repository name so that they display correctly sub-folder files
                                // Absolute links must be left un-touched.
-                               
+
                                // Note: The absolute lack of comments in ExpLinkNode is... well...
                                // I assume, that getRelativePath is handling "file like" links
-                               // like "/xx/tt"  or "../somefolder". What needs to be captured
-                               // is a full URL link. The easiest is to ask java to parse URL
-                               // and let it fail. Shame java.net.URL has no method to validate URL without
-                               // throwing.
-                               try {
-                                       new java.net.URL(node.url);
+                               // like "/xx/tt"  or "../somefolder".
+                               if (isFullUrl(node.url)) {
                                        // This is URL, fallback to superclass.
                                        return super.render(node,text);
-                               } catch (java.net.MalformedURLException ignored) {};
+                               }
                                // repository-relative link
                                String path = doc.getRelativePath(node.url);
                                String url = getWicketUrl(DocPage.class, repositoryName, commitId, path);
                                return new Rendering(url, text);
                        }
+
+                       @Override
+                       public Rendering render(RefLinkNode node, String url, String title, String text) {
+                               if (isFullUrl(url)) {
+                                       // This is URL, fallback to superclass.
+                                       return super.render(node, url, title, text);
+                               }
+                               // repository-relative link
+                               String path = doc.getRelativePath(url);
+                               String local_url = getWicketUrl(DocPage.class, repositoryName, commitId, path);
+                               return super.render(node, local_url, title, text);
+                       }
                };
 
                final String content = MarkdownUtils.transformMarkdown(doc.markup, renderer);
@@ -388,6 +395,24 @@ public class MarkupProcessor {
                doc.html = safeContent;
        }
 
+       private boolean isFullUrl(String url)
+       {
+               // Relative file-like links needs to be re-mapped to be relative to
+               // repository name so that they display correctly sub-folder files
+               // Absolute links must be left un-touched.
+               // Check if given string is a full URL link. The easiest is to ask java to parse URL
+               // and let it fail. Shame java.net.URL has no method to validate URL without
+               // throwing.
+               try {
+                       new java.net.URL(url);
+                       // Success, this is a URL
+                       return true;
+               } catch (java.net.MalformedURLException ignored) {};
+               // This is a relative link
+               return false;
+       }
+
+
        private String getWicketUrl(Class<? extends Page> pageClass, final String repositoryName, final String commitId, final String document) {
                String fsc = settings.getString(Keys.web.forwardSlashCharacter, "/");
                String encodedPath = document.replace(' ', '-');

diff --git a/src/test/java/com/gitblit/wicket/MarkupProcessorTest.java b/src/test/java/com/gitblit/wicket/MarkupProcessorTest.java
index a57f1fdbcedeafc6bc067679f564fa960385307e..2a2f5174e85eb4784038027244a2f38df13310ad 100644 (file)
--- a/src/test/java/com/gitblit/wicket/MarkupProcessorTest.java
+++ b/src/test/java/com/gitblit/wicket/MarkupProcessorTest.java
@@ -217,7 +217,7 @@ public class MarkupProcessorTest
                MarkupDocument mdoc = mp.parse("testrepo", "12345abcde", "main.md", markup);
                Document doc = Jsoup.parseBodyFragment(mdoc.html);
                String href = doc.getElementsByAttribute("href").attr("href");
-               assertEquals("Incorrect link rendered","doc/testrepo/12345abcde/%65%E5%67%2C%8A%Ee.md", href);
+               assertEquals("Incorrect link rendered","doc/testrepo/12345abcde/%E6%97%A5%E6%9C%AC%E8%AA%9E.md", href);
        }
 
        @Test