Merge pull request #1073 from gitblit/1062-DocEditorUpdates

Paul Martin

2016-04-30 a502d96a860456ec5e8c96761db70f7cabb74751

 src/main/java/com/gitblit/utils/MarkdownUtils.java

@@ -15,67 +15,91 @@
 */

package com.gitblit.utils;



import static org.pegdown.Extensions.ALL;

import static org.pegdown.Extensions.ANCHORLINKS;

import static org.pegdown.Extensions.SMARTYPANTS;



import java.io.IOException;

import java.io.Reader;

import java.io.StringReader;

import java.io.StringWriter;

import java.text.MessageFormat;



import org.slf4j.LoggerFactory;

import org.tautua.markdownpapers.Markdown;

import org.tautua.markdownpapers.parser.ParseException;

import org.apache.commons.io.IOUtils;

import org.pegdown.LinkRenderer;

import org.pegdown.ParsingTimeoutException;

import org.pegdown.PegDownProcessor;

import org.pegdown.ast.RootNode;



import com.gitblit.IStoredSettings;

import com.gitblit.Keys;

import com.gitblit.wicket.MarkupProcessor.WorkaroundHtmlSerializer;



/**

 * Utility methods for transforming raw markdown text to html.

 * 
 *

 * @author James Moger

 * 
 *

 */

public class MarkdownUtils {



   /**

    * Returns the html version of the plain source text.

    *

    * @param text

    * @return html version of plain text

    * @throws java.text.ParseException

    */

   public static String transformPlainText(String text) {

      // url auto-linking

      text = text.replaceAll("((http|https)://[0-9A-Za-z-_=\\?\\.\\$#&/]*)", "<a href=\"$1\">$1</a>");

      String html = "<pre>" + text + "</pre>";

      return html;

   }





   /**

    * Returns the html version of the markdown source text.

    * 
    *

    * @param markdown

    * @return html version of markdown text

    * @throws java.text.ParseException

    */

   public static String transformMarkdown(String markdown) throws java.text.ParseException {

   public static String transformMarkdown(String markdown) {

      return transformMarkdown(markdown, null);

   }



   /**

    * Returns the html version of the markdown source text.

    *

    * @param markdown

    * @return html version of markdown text

    * @throws java.text.ParseException

    */

   public static String transformMarkdown(String markdown, LinkRenderer linkRenderer) {

      try {

         StringReader reader = new StringReader(markdown);

         String html = transformMarkdown(reader);

         reader.close();

         return html;

      } catch (IllegalArgumentException e) {

         throw new java.text.ParseException(e.getMessage(), 0);

      } catch (NullPointerException p) {

         throw new java.text.ParseException("Markdown string is null!", 0);

         PegDownProcessor pd = new PegDownProcessor(ALL & ~SMARTYPANTS & ~ANCHORLINKS);

         RootNode astRoot = pd.parseMarkdown(markdown.toCharArray());

         return new WorkaroundHtmlSerializer(linkRenderer == null ? new LinkRenderer() : linkRenderer).toHtml(astRoot);

      } catch (ParsingTimeoutException e) {

         return null;

      }

   }



   /**

    * Returns the html version of the markdown source reader. The reader is

    * closed regardless of success or failure.

    * 
    *

    * @param markdownReader

    * @return html version of the markdown text

    * @throws java.text.ParseException

    */

   public static String transformMarkdown(Reader markdownReader) throws java.text.ParseException {

   public static String transformMarkdown(Reader markdownReader) throws IOException {

      // Read raw markdown content and transform it to html

      StringWriter writer = new StringWriter();

      try {

         Markdown md = new Markdown();

         md.transform(markdownReader, writer);

         return writer.toString().trim();

      } catch (StringIndexOutOfBoundsException e) {

         LoggerFactory.getLogger(MarkdownUtils.class).error("MarkdownPapers failed to parse Markdown!", e);

         throw new java.text.ParseException(e.getMessage(), 0);

      } catch (ParseException p) {

         LoggerFactory.getLogger(MarkdownUtils.class).error("MarkdownPapers failed to parse Markdown!", p);

         throw new java.text.ParseException(p.getMessage(), 0);

      } catch (Exception e) {

         LoggerFactory.getLogger(MarkdownUtils.class).error("MarkdownPapers failed to parse Markdown!", e);

         throw new java.text.ParseException(e.getMessage(), 0);

         IOUtils.copy(markdownReader, writer);

         String markdown = writer.toString();

         return transformMarkdown(markdown);

      } finally {

         try {

            writer.close();

@@ -84,4 +108,49 @@
         }

      }

   }





   /**

    * Transforms GFM (Github Flavored Markdown) to html.

    * Gitblit does not support the complete GFM specification.

    *

    * @param input

    * @param repositoryName

    * @return html

    */

   public static String transformGFM(IStoredSettings settings, String input, String repositoryName) {

      String text = input;



      // strikethrough

      text = text.replaceAll("~~(.*)~~", "<s>$1</s>");

      text = text.replaceAll("\\{(?:-){2}(.*)(?:-){2}}", "<s>$1</s>");



      // underline

      text = text.replaceAll("\\{(?:\\+){2}(.*)(?:\\+){2}}", "<u>$1</u>");



      // strikethrough, replacement

      text = text.replaceAll("\\{~~(.*)~>(.*)~~}", "<s>$1</s><u>$2</u>");



      // highlight

      text = text.replaceAll("\\{==(.*)==}", "<span class='highlight'>$1</span>");



      String canonicalUrl = settings.getString(Keys.web.canonicalUrl, "https://localhost:8443");



      // emphasize and link mentions

      String mentionReplacement = String.format(" **[@$1](%1s/user/$1)**", canonicalUrl);

      text = text.replaceAll("\\s@([A-Za-z0-9-_]+)", mentionReplacement);



      // link ticket refs
      String ticketReplacement = MessageFormat.format("$1[#$2]({0}/tickets?r={1}&h=$2)$3", canonicalUrl, repositoryName);
      text = text.replaceAll("([\\s,]+)#(\\d+)([\\s,:\\.\\n])", ticketReplacement);

      // link commit shas

      int shaLen = settings.getInteger(Keys.web.shortCommitIdLength, 6);

      String commitPattern = MessageFormat.format("\\s([A-Fa-f0-9]'{'{0}'}')([A-Fa-f0-9]'{'{1}'}')", shaLen, 40 - shaLen);

      String commitReplacement = String.format(" [`$1`](%1$s/commit?r=%2$s&h=$1$2)", canonicalUrl, repositoryName);

      text = text.replaceAll(commitPattern, commitReplacement);



      String html = transformMarkdown(text);

      return html;

   }

}