The Unified and Autonomous Development Platform
chore: Markdown renderer refactoring and minor bug fixes
Robin Shenff430f800051
diff --git a/pom.xml b/pom.xmlindex 04a95dcaee..527b5f7eee 100644--- a/pom.xml+++ b/pom.xml@@ -648,7 +648,7 @@<lucene.version>8.7.0</lucene.version><shiro.version>1.13.0</shiro.version><jgit.version>5.13.3.202401111512-r</jgit.version>- <flexmark.version>0.64.0</flexmark.version>+ <flexmark.version>0.64.8</flexmark.version><groovy.version>3.0.19</groovy.version><servlet.version>3.1.0</servlet.version><jackson.version>2.14.0-rc1</jackson.version>diff --git a/server-core/src/main/java/io/onedev/server/CoreModule.java b/server-core/src/main/java/io/onedev/server/CoreModule.javaindex acb741e64e..df3ec062ee 100644--- a/server-core/src/main/java/io/onedev/server/CoreModule.java+++ b/server-core/src/main/java/io/onedev/server/CoreModule.java@@ -59,7 +59,7 @@ import io.onedev.server.mail.DefaultMailManager;import io.onedev.server.mail.MailManager;import io.onedev.server.markdown.DefaultMarkdownManager;import io.onedev.server.markdown.MarkdownManager;-import io.onedev.server.markdown.MarkdownProcessor;+import io.onedev.server.markdown.HtmlProcessor;import io.onedev.server.model.support.administration.GroovyScript;import io.onedev.server.model.support.administration.authenticator.Authenticator;import io.onedev.server.notification.*;@@ -407,7 +407,7 @@ public class CoreModule extends AbstractPluginModule {contribute(Extension.class, new EmojiExtension());contribute(Extension.class, new SourcePositionTrackExtension());- contributeFromPackage(MarkdownProcessor.class, MarkdownProcessor.class);+ contributeFromPackage(HtmlProcessor.class, HtmlProcessor.class);contribute(ResourcePackScopeContribution.class, () -> newArrayList(WebApplication.class));diff --git a/server-core/src/main/java/io/onedev/server/markdown/CodeProcessor.java b/server-core/src/main/java/io/onedev/server/markdown/CodeProcessor.javaindex 3b3a68f6f7..b3e8ce2369 100644--- a/server-core/src/main/java/io/onedev/server/markdown/CodeProcessor.java+++ b/server-core/src/main/java/io/onedev/server/markdown/CodeProcessor.java@@ -23,13 +23,13 @@ import io.onedev.server.web.component.markdown.SuggestionSupport;import io.onedev.server.web.component.markdown.SuggestionSupport.Selection;import io.onedev.server.web.page.project.blob.render.BlobRenderContext;-public class CodeProcessor implements MarkdownProcessor {+public class CodeProcessor implements HtmlProcessor {@Override- public void process(Document document, @Nullable Project project,- @Nullable BlobRenderContext blobRenderContext,- @Nullable SuggestionSupport suggestionSupport,- boolean forExternal) {+ public void process(Document document, @Nullable Project project,+ @Nullable BlobRenderContext blobRenderContext,+ @Nullable SuggestionSupport suggestionSupport,+ boolean forExternal) {Collection<Element> codeElements = new ArrayList<>();NodeTraversor.traverse(new NodeVisitor() {diff --git a/server-core/src/main/java/io/onedev/server/markdown/CommitProcessor.java b/server-core/src/main/java/io/onedev/server/markdown/CommitProcessor.javaindex a781d362e9..dbd76a1839 100644--- a/server-core/src/main/java/io/onedev/server/markdown/CommitProcessor.java+++ b/server-core/src/main/java/io/onedev/server/markdown/CommitProcessor.java@@ -27,7 +27,7 @@ import io.onedev.server.web.component.markdown.SuggestionSupport;import io.onedev.server.web.page.project.blob.render.BlobRenderContext;import io.onedev.server.web.page.project.commits.CommitDetailPage;-public class CommitProcessor implements MarkdownProcessor {+public class CommitProcessor implements HtmlProcessor {private static final Collection<String> IGNORED_TAGS = ImmutableSet.of("pre", "code", "a");@@ -35,10 +35,10 @@ public class CommitProcessor implements MarkdownProcessor {"(^|\\W+)((" + ProjectPathValidator.PATTERN.pattern() + "):)?([a-z0-9]{40})($|[^a-z0-9])");@Override- public void process(Document document, @Nullable Project project,- @Nullable BlobRenderContext blobRenderContext,- @Nullable SuggestionSupport suggestionSupport,- boolean forExternal) {+ public void process(Document document, @Nullable Project project,+ @Nullable BlobRenderContext blobRenderContext,+ @Nullable SuggestionSupport suggestionSupport,+ boolean forExternal) {TextNodeVisitor visitor = new TextNodeVisitor() {@Overridediff --git a/server-core/src/main/java/io/onedev/server/markdown/DefaultMarkdownManager.java b/server-core/src/main/java/io/onedev/server/markdown/DefaultMarkdownManager.javaindex a8be976958..31e0be2224 100644--- a/server-core/src/main/java/io/onedev/server/markdown/DefaultMarkdownManager.java+++ b/server-core/src/main/java/io/onedev/server/markdown/DefaultMarkdownManager.java@@ -11,12 +11,9 @@ import com.vladsch.flexmark.formatter.Formatter;import com.vladsch.flexmark.formatter.Formatter.Builder;import com.vladsch.flexmark.formatter.Formatter.FormatterExtension;import com.vladsch.flexmark.formatter.NodeFormatter;-import com.vladsch.flexmark.formatter.NodeFormatterFactory;import com.vladsch.flexmark.formatter.NodeFormattingHandler;import com.vladsch.flexmark.html.HtmlRenderer;import com.vladsch.flexmark.parser.Parser;-import com.vladsch.flexmark.util.ast.Node;-import com.vladsch.flexmark.util.data.DataHolder;import com.vladsch.flexmark.util.data.MutableDataHolder;import com.vladsch.flexmark.util.data.MutableDataSet;import com.vladsch.flexmark.util.misc.Extension;@@ -26,8 +23,6 @@ import io.onedev.server.util.HtmlUtils;import io.onedev.server.web.component.markdown.SuggestionSupport;import io.onedev.server.web.page.project.blob.render.BlobRenderContext;import io.onedev.server.web.resource.AttachmentResource;-import org.jetbrains.annotations.NotNull;-import org.jsoup.nodes.Document;import org.jsoup.nodes.Element;import javax.annotation.Nullable;@@ -45,11 +40,11 @@ public class DefaultMarkdownManager implements MarkdownManager {private final Set<Extension> contributedExtensions;- private final Set<MarkdownProcessor> htmlTransformers;+ private final Set<HtmlProcessor> htmlTransformers;@Injectpublic DefaultMarkdownManager(SettingManager settingManager, Set<Extension> contributedExtensions,- Set<MarkdownProcessor> htmlTransformers) {+ Set<HtmlProcessor> htmlTransformers) {this.settingManager = settingManager;this.contributedExtensions = contributedExtensions;this.htmlTransformers = htmlTransformers;@@ -82,50 +77,39 @@ public class DefaultMarkdownManager implements MarkdownManager {@Overridepublic String render(String markdown) {- Node node = parse(markdown);- return HtmlRenderer.builder(setupOptions()).build().render(node);+ var options = setupOptions();+ Parser parser = Parser.builder(options).build();+ return HtmlRenderer.builder(options).build().render(parser.parse(markdown));}-+@Override- public Document process(Document document, @Nullable Project project, @Nullable BlobRenderContext blobRenderContext,- @Nullable SuggestionSupport suggestionSupport, boolean forExternal) {- document = HtmlUtils.sanitize(document);- for (MarkdownProcessor htmlTransformer: htmlTransformers)- htmlTransformer.process(document, project, blobRenderContext, suggestionSupport, forExternal);-+ public String process(String html, Project project,+ @Nullable BlobRenderContext blobRenderContext,+ @Nullable SuggestionSupport suggestionSupport,+ boolean forExternal) {+ var doc = HtmlUtils.parse(html);+ doc = HtmlUtils.sanitize(doc);+ for (var htmlTransformer: htmlTransformers)+ htmlTransformer.process(doc, project, blobRenderContext, suggestionSupport, forExternal);+if (forExternal) {- for (Element element: document.body().getElementsByTag("img")) {- element.attr("src", toExternalUrl(element.attr("src")));+ for (Element element: doc.body().getElementsByTag("img")) {+ element.attr("src", toExternal(element.attr("src")));String style = element.attr("style");if (!style.endsWith(";"))style += ";";style += "max-width:100%";element.attr("style", style);}- for (Element element: document.body().getElementsByTag("a"))- element.attr("href", toExternalUrl(element.attr("href")));+ for (Element element: doc.body().getElementsByTag("a"))+ element.attr("href", toExternal(element.attr("href")));}- document.outputSettings().prettyPrint(false);- return document;- }-- @Override- public String process(String html, Project project,- @Nullable BlobRenderContext blobRenderContext,- @Nullable SuggestionSupport suggestionSupport,- boolean forExternal) {- return process(HtmlUtils.parse(html), project, blobRenderContext, suggestionSupport, forExternal).body().html();+ doc.outputSettings().prettyPrint(false);+ return doc.body().html();}@Override- public Node parse(String markdown) {- MutableDataHolder options = setupOptions();- Parser parser = Parser.builder(options).build();- return parser.parse(markdown);- }-- @Override- public String toExternalUrl(String url) {+ public String toExternal(String url) {if (url.startsWith("/"))return AttachmentResource.authorizeGroup(settingManager.getSystemSetting().getServerUrl() + url);else@@ -134,9 +118,6 @@ public class DefaultMarkdownManager implements MarkdownManager {@Overridepublic String format(String markdown, Set<NodeFormattingHandler<?>> handlers) {- Parser parser = Parser.builder().build();- Node node = parser.parse(markdown);-Collection<FormatterExtension> extensions = new ArrayList<>();extensions.add(new FormatterExtension() {@@ -146,30 +127,24 @@ public class DefaultMarkdownManager implements MarkdownManager {@Overridepublic void extend(Builder formatterBuilder) {- formatterBuilder.nodeFormatterFactory(new NodeFormatterFactory() {+ formatterBuilder.nodeFormatterFactory(options -> new NodeFormatter() {@Override- public @NotNull NodeFormatter create(@NotNull DataHolder options) {- return new NodeFormatter() {-- @Override- public @Nullable Set<NodeFormattingHandler<?>> getNodeFormattingHandlers() {- return handlers;- }+ public @Nullable Set<NodeFormattingHandler<?>> getNodeFormattingHandlers() {+ return handlers;+ }- @Override- public @Nullable Set<Class<?>> getNodeClasses() {- return null;- }-- };+ @Override+ public @Nullable Set<Class<?>> getNodeClasses() {+ return null;}});}- });- return Formatter.builder().extensions(extensions).build().render(node);+ });+ var parser = Parser.builder().build();+ return Formatter.builder().extensions(extensions).build().render(parser.parse(markdown));}}diff --git a/server-core/src/main/java/io/onedev/server/markdown/ExternalLinkFormatter.java b/server-core/src/main/java/io/onedev/server/markdown/ExternalLinkFormatter.javaindex e9e678cd75..6aa6ef10d3 100644--- a/server-core/src/main/java/io/onedev/server/markdown/ExternalLinkFormatter.java+++ b/server-core/src/main/java/io/onedev/server/markdown/ExternalLinkFormatter.java@@ -14,7 +14,7 @@ public class ExternalLinkFormatter<N extends InlineLinkNode> implements NodeFormmarkdown.append("[");context.renderChildren(node);markdown.append("](");- markdown.append(OneDev.getInstance(MarkdownManager.class).toExternalUrl(node.getUrl().toString()));+ markdown.append(OneDev.getInstance(MarkdownManager.class).toExternal(node.getUrl().toString()));markdown.append(")");}diff --git a/server-core/src/main/java/io/onedev/server/markdown/MarkdownProcessor.java b/server-core/src/main/java/io/onedev/server/markdown/HtmlProcessor.javasimilarity index 61%rename from server-core/src/main/java/io/onedev/server/markdown/MarkdownProcessor.javarename to server-core/src/main/java/io/onedev/server/markdown/HtmlProcessor.javaindex 5a19d7e2d9..631d336644 100644--- a/server-core/src/main/java/io/onedev/server/markdown/MarkdownProcessor.java+++ b/server-core/src/main/java/io/onedev/server/markdown/HtmlProcessor.java@@ -10,11 +10,11 @@ import io.onedev.server.web.component.markdown.SuggestionSupport;import io.onedev.server.web.page.project.blob.render.BlobRenderContext;@ExtensionPoint-public interface MarkdownProcessor {+public interface HtmlProcessor {- void process(Document document, @Nullable Project project,- @Nullable BlobRenderContext blobRenderContext,- @Nullable SuggestionSupport suggestionSupport,- boolean forExternal);+ void process(Document document, @Nullable Project project,+ @Nullable BlobRenderContext blobRenderContext,+ @Nullable SuggestionSupport suggestionSupport,+ boolean forExternal);}diff --git a/server-core/src/main/java/io/onedev/server/markdown/MarkdownManager.java b/server-core/src/main/java/io/onedev/server/markdown/MarkdownManager.javaindex 2877070401..b3af1204a6 100644--- a/server-core/src/main/java/io/onedev/server/markdown/MarkdownManager.java+++ b/server-core/src/main/java/io/onedev/server/markdown/MarkdownManager.java@@ -1,18 +1,13 @@package io.onedev.server.markdown;-import java.util.Set;--import javax.annotation.Nullable;--import org.jsoup.nodes.Document;-import com.vladsch.flexmark.formatter.NodeFormattingHandler;-import com.vladsch.flexmark.util.ast.Node;-import io.onedev.server.model.Project;import io.onedev.server.web.component.markdown.SuggestionSupport;import io.onedev.server.web.page.project.blob.render.BlobRenderContext;+import javax.annotation.Nullable;+import java.util.Set;+public interface MarkdownManager {/**@@ -26,19 +21,12 @@ public interface MarkdownManager {*/String render(String markdown);- Node parse(String markdown);-- Document process(Document document, @Nullable Project project,- @Nullable BlobRenderContext blobRenderContext,- @Nullable SuggestionSupport suggestionSupport,- boolean forExternal);-- String process(String html, @Nullable Project project,- @Nullable BlobRenderContext blobRenderContext,- @Nullable SuggestionSupport suggestionSupport,- boolean forExternal);+ String process(String html, @Nullable Project project,+ @Nullable BlobRenderContext blobRenderContext,+ @Nullable SuggestionSupport suggestionSupport,+ boolean forExternal);- String toExternalUrl(String url);+ String toExternal(String url);String format(String markdown, Set<NodeFormattingHandler<?>> handlers);diff --git a/server-core/src/main/java/io/onedev/server/markdown/MentionProcessor.java b/server-core/src/main/java/io/onedev/server/markdown/MentionProcessor.javaindex 85b56dfb0e..92606292e3 100644--- a/server-core/src/main/java/io/onedev/server/markdown/MentionProcessor.java+++ b/server-core/src/main/java/io/onedev/server/markdown/MentionProcessor.java@@ -11,13 +11,13 @@ import io.onedev.server.model.Project;import io.onedev.server.web.component.markdown.SuggestionSupport;import io.onedev.server.web.page.project.blob.render.BlobRenderContext;-public class MentionProcessor extends MentionParser implements MarkdownProcessor {+public class MentionProcessor extends MentionParser implements HtmlProcessor {@Override- public void process(Document document, Project project,- @Nullable BlobRenderContext blobRenderContext,- @Nullable SuggestionSupport suggestionSupport,- boolean forExternal) {+ public void process(Document document, Project project,+ @Nullable BlobRenderContext blobRenderContext,+ @Nullable SuggestionSupport suggestionSupport,+ boolean forExternal) {parseMentions(document);}diff --git a/server-core/src/main/java/io/onedev/server/markdown/ReferenceProcessor.java b/server-core/src/main/java/io/onedev/server/markdown/ReferenceProcessor.javaindex b67b429f9a..74befc0fc9 100644--- a/server-core/src/main/java/io/onedev/server/markdown/ReferenceProcessor.java+++ b/server-core/src/main/java/io/onedev/server/markdown/ReferenceProcessor.java@@ -15,17 +15,16 @@ import org.jsoup.nodes.Document;import org.unbescape.html.HtmlEscape;import javax.annotation.Nullable;-import java.util.function.BiFunction;import static io.onedev.server.entityreference.ReferenceUtils.transformReferences;-public class ReferenceProcessor implements MarkdownProcessor {+public class ReferenceProcessor implements HtmlProcessor {@Override- public void process(Document document, @Nullable Project project,- @Nullable BlobRenderContext blobRenderContext,- @Nullable SuggestionSupport suggestionSupport,- boolean forExternal) {+ public void process(Document document, @Nullable Project project,+ @Nullable BlobRenderContext blobRenderContext,+ @Nullable SuggestionSupport suggestionSupport,+ boolean forExternal) {transformReferences(document, project, (reference, text) -> {text = HtmlEscape.escapeHtml5(text);if (reference instanceof IssueReference) {diff --git a/server-core/src/main/java/io/onedev/server/markdown/StrikeThroughProcessor.java b/server-core/src/main/java/io/onedev/server/markdown/StrikeThroughProcessor.javaindex 0f09cc1fcb..0051d1bd18 100644--- a/server-core/src/main/java/io/onedev/server/markdown/StrikeThroughProcessor.java+++ b/server-core/src/main/java/io/onedev/server/markdown/StrikeThroughProcessor.java@@ -18,17 +18,17 @@ import io.onedev.server.util.TextNodeVisitor;import io.onedev.server.web.component.markdown.SuggestionSupport;import io.onedev.server.web.page.project.blob.render.BlobRenderContext;-public class StrikeThroughProcessor implements MarkdownProcessor {+public class StrikeThroughProcessor implements HtmlProcessor {private static final Collection<String> IGNORED_TAGS = ImmutableSet.of("pre", "code", "a");private static final Pattern PATTERN = Pattern.compile("~~(.*?)~~");@Override- public void process(Document document, Project project,- @Nullable BlobRenderContext blobRenderContext,- @Nullable SuggestionSupport suggestionSupport,- boolean forExternal) {+ public void process(Document document, Project project,+ @Nullable BlobRenderContext blobRenderContext,+ @Nullable SuggestionSupport suggestionSupport,+ boolean forExternal) {TextNodeVisitor visitor = new TextNodeVisitor() {@Overridediff --git a/server-core/src/main/java/io/onedev/server/markdown/UrlProcessor.java b/server-core/src/main/java/io/onedev/server/markdown/UrlProcessor.javaindex f07c64523e..7db68c8a19 100644--- a/server-core/src/main/java/io/onedev/server/markdown/UrlProcessor.java+++ b/server-core/src/main/java/io/onedev/server/markdown/UrlProcessor.java@@ -32,15 +32,15 @@ import io.onedev.server.web.page.project.blob.ProjectBlobPage;import io.onedev.server.web.page.project.blob.render.BlobRenderContext;import io.onedev.server.web.page.project.blob.render.BlobRenderContext.Mode;-public class UrlProcessor implements MarkdownProcessor {+public class UrlProcessor implements HtmlProcessor {private static final Logger logger = LoggerFactory.getLogger(UrlProcessor.class);@Override- public void process(Document document, Project project,- @Nullable BlobRenderContext blobRenderContext,- @Nullable SuggestionSupport suggestionSupport,- boolean forExternal) {+ public void process(Document document, Project project,+ @Nullable BlobRenderContext blobRenderContext,+ @Nullable SuggestionSupport suggestionSupport,+ boolean forExternal) {if (RequestCycle.get() != null && blobRenderContext != null && project != null) {GitService gitService = OneDev.getInstance(GitService.class);ObjectId revId;diff --git a/server-core/src/main/java/io/onedev/server/util/HtmlUtils.java b/server-core/src/main/java/io/onedev/server/util/HtmlUtils.javaindex 3b429172bc..ef86ac448b 100644--- a/server-core/src/main/java/io/onedev/server/util/HtmlUtils.java+++ b/server-core/src/main/java/io/onedev/server/util/HtmlUtils.java@@ -14,7 +14,8 @@ public class HtmlUtils {private static final String[] SAFE_TAGS = new String[] { "h1", "h2", "h3", "h4", "h5", "h6", "h7", "h8", "br", "b","i", "strong", "em", "a", "pre", "code", "img", "tt", "div", "ins", "del", "sup", "sub", "p", "ol", "ul","li", "table", "thead", "tbody", "tfoot", "th", "tr", "td", "rt", "rp", "blockquote", "dl", "dt", "dd",- "kbd", "q", "hr", "strike", "caption", "cite", "col", "colgroup", "small", "span", "u", "input", "video", "source"};+ "kbd", "q", "hr", "strike", "caption", "cite", "col", "colgroup", "small", "span", "u", "input", "video",+ "source", "details", "summary"};private static final String[] SAFE_ATTRIBUTES = new String[] { "abbr", "accept", "accept-charset", "accesskey","action", "align", "alt", "axis", "border", "cellpadding", "cellspacing", "char", "charoff", "charset",diff --git a/server-core/src/main/java/io/onedev/server/web/component/markdown/MarkdownEditor.java b/server-core/src/main/java/io/onedev/server/web/component/markdown/MarkdownEditor.javaindex 189ae3c32a..d4b0b5f335 100644--- a/server-core/src/main/java/io/onedev/server/web/component/markdown/MarkdownEditor.java+++ b/server-core/src/main/java/io/onedev/server/web/component/markdown/MarkdownEditor.java@@ -36,7 +36,6 @@ import org.apache.wicket.markup.head.OnDomReadyHeaderItem;import org.apache.wicket.markup.head.OnLoadHeaderItem;import org.apache.wicket.markup.html.WebMarkupContainer;import org.apache.wicket.markup.html.basic.Label;-import org.apache.wicket.markup.html.form.Form;import org.apache.wicket.markup.html.form.FormComponentPanel;import org.apache.wicket.markup.html.form.TextArea;import org.apache.wicket.markup.html.panel.Fragment;diff --git a/server-ee b/server-eeindex b65fb627e3..eb0ed6c465 160000--- a/server-ee+++ b/server-ee@@ -1 +1 @@-Subproject commit b65fb627e3703c7d67a36077b888b318c22b1a6e+Subproject commit eb0ed6c4658108a23421a65cd748807a171447abdiff --git a/server-plugin/server-plugin-notification-discord/src/main/java/io/onedev/server/plugin/notification/discord/DiscordNotificationManager.java b/server-plugin/server-plugin-notification-discord/src/main/java/io/onedev/server/plugin/notification/discord/DiscordNotificationManager.javaindex a42e848bfc..87f0f335d7 100644--- a/server-plugin/server-plugin-notification-discord/src/main/java/io/onedev/server/plugin/notification/discord/DiscordNotificationManager.java+++ b/server-plugin/server-plugin-notification-discord/src/main/java/io/onedev/server/plugin/notification/discord/DiscordNotificationManager.java@@ -54,8 +54,8 @@ public class DiscordNotificationManager extends ChannelNotificationManager<DiscoString markdown = commentText.getPlainContent();Set<NodeFormattingHandler<?>> handlers = new HashSet<>();- handlers.add(new NodeFormattingHandler<>(Link.class, new ExternalLinkFormatter<Link>()));- handlers.add(new NodeFormattingHandler<>(Image.class, new ExternalLinkFormatter<Image>()));+ handlers.add(new NodeFormattingHandler<>(Link.class, new ExternalLinkFormatter<>()));+ handlers.add(new NodeFormattingHandler<>(Image.class, new ExternalLinkFormatter<>()));sections.add(markdownManager.format(markdown, handlers));} else if (commentText instanceof PlainText) {diff --git a/server-plugin/server-plugin-notification-slack/src/main/java/io/onedev/server/plugin/notification/slack/SlackNotificationManager.java b/server-plugin/server-plugin-notification-slack/src/main/java/io/onedev/server/plugin/notification/slack/SlackNotificationManager.javaindex edbb632a8c..1f3b5fe23d 100644--- a/server-plugin/server-plugin-notification-slack/src/main/java/io/onedev/server/plugin/notification/slack/SlackNotificationManager.java+++ b/server-plugin/server-plugin-notification-slack/src/main/java/io/onedev/server/plugin/notification/slack/SlackNotificationManager.java@@ -50,7 +50,7 @@ public class SlackNotificationManager extends ChannelNotificationManager<SlackNoprivate void renderInlineLink(@NotNull InlineLinkNode node, @NotNull NodeFormatterContext context,@NotNull MarkdownWriter markdown) {markdown.append("<");- markdown.append(markdownManager.toExternalUrl(node.getUrl().toString()));+ markdown.append(markdownManager.toExternal(node.getUrl().toString()));markdown.append("|");context.renderChildren(node);markdown.append(">");