001package org.hl7.fhir.utilities;
002
003/*
004  Copyright (c) 2011+, HL7, Inc.
005  All rights reserved.
006  
007  Redistribution and use in source and binary forms, with or without modification, 
008  are permitted provided that the following conditions are met:
009    
010   * Redistributions of source code must retain the above copyright notice, this 
011     list of conditions and the following disclaimer.
012   * Redistributions in binary form must reproduce the above copyright notice, 
013     this list of conditions and the following disclaimer in the documentation 
014     and/or other materials provided with the distribution.
015   * Neither the name of HL7 nor the names of its contributors may be used to 
016     endorse or promote products derived from this software without specific 
017     prior written permission.
018  
019  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
020  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
021  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
022  IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
023  INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 
024  NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 
025  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
026  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
027  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
028  POSSIBILITY OF SUCH DAMAGE.
029  
030 */
031
032
033
034import java.util.Collections;
035import java.util.Set;
036
037import org.commonmark.Extension;
038import org.commonmark.ext.gfm.tables.TablesExtension;
039import org.commonmark.node.Node;
040import org.commonmark.parser.Parser;
041import org.commonmark.renderer.html.HtmlRenderer;
042
043import com.github.rjeschke.txtmark.Processor;
044
045public class MarkDownProcessor {
046
047  public enum Dialect {DARING_FIREBALL, COMMON_MARK};
048  
049  private Dialect dialect;
050  
051  
052  public MarkDownProcessor(Dialect dialect) {
053    super();
054    this.dialect = dialect;
055  }
056
057
058  public String process(String source, String context) {
059    if (source == null) {
060      return null;
061    }
062    if ("".equals(source)) {
063      return "";
064    }
065    switch (dialect) {
066    case DARING_FIREBALL : return Processor.process(source); 
067    case COMMON_MARK : return processCommonMark(preProcess(source)); 
068    default: throw new Error("Unknown Markdown Dialect: "+dialect.toString()+" at "+context); 
069    }
070  }
071
072  /**
073   * This deals with a painful problem created by the intersection of previous publishing processes 
074   * and the way commonmark specifies that < is handled in content. For control reasons, the FHIR specification does 
075   * not allow raw html tags in the markdown 
076   * 
077   * This check finds any raw <[x] where [x] is any alpha character, and prepends \ to it so that it 
078   * renders as a < (e.g. gets escaped in the output HTML)
079   * 
080   * This is public to enable testing (not for direct use otherwise)
081   * 
082   * @param source
083   * @return
084   */
085  public static String preProcess(String source) {
086    StringBuilder b = new StringBuilder();
087    for (int i = 0; i < source.length(); i++) {
088      char last = i > 0 ? source.charAt(i-1) : 0;
089      char current = source.charAt(i);
090      char next = i < source.length() -1 ? source.charAt(i+1) : 0;
091      if (current == '<' && Character.isAlphabetic(next) && last != '\\') {
092        b.append('\\');
093        b.append(current);        
094      } else {
095        b.append(current);
096      }
097    }
098    return b.toString();
099  }
100
101
102  private String processCommonMark(String source) {
103    Set<Extension> extensions = Collections.singleton(TablesExtension.create());
104    Parser parser = Parser.builder().extensions(extensions).build();
105    Node document = parser.parse(source);
106    HtmlRenderer renderer = HtmlRenderer.builder().escapeHtml(true).extensions(extensions).build();
107    String html = renderer.render(document);
108    html = html.replace("<table>", "<table class=\"grid\">");
109    return html;  
110  }
111
112
113  public static boolean isSimpleMarkdown(String description) {
114    return !description.contains("\n");
115  }
116  
117}