]>
Commit | Line | Data |
---|---|---|
9d9597df | 1 | import { Injectable } from '@angular/core' |
41d71344 | 2 | import { MarkdownIt } from 'markdown-it' |
7e049ea4 | 3 | import { HtmlRendererService } from '@app/shared/renderer/html-renderer.service' |
7e049ea4 C |
4 | |
5 | type MarkdownParsers = { | |
6 | textMarkdownIt: MarkdownIt | |
3131c13e C |
7 | textWithHTMLMarkdownIt: MarkdownIt |
8 | ||
7e049ea4 | 9 | enhancedMarkdownIt: MarkdownIt |
3131c13e C |
10 | enhancedWithHTMLMarkdownIt: MarkdownIt |
11 | ||
7e049ea4 C |
12 | completeMarkdownIt: MarkdownIt |
13 | } | |
14 | ||
15 | type MarkdownConfig = { | |
16 | rules: string[] | |
17 | html: boolean | |
18 | escape?: boolean | |
19 | } | |
20 | ||
21 | type MarkdownParserConfigs = { | |
22 | [id in keyof MarkdownParsers]: MarkdownConfig | |
23 | } | |
9d9597df C |
24 | |
25 | @Injectable() | |
26 | export class MarkdownService { | |
621d99f5 C |
27 | static TEXT_RULES = [ |
28 | 'linkify', | |
29 | 'autolink', | |
30 | 'emphasis', | |
31 | 'link', | |
32 | 'newline', | |
33 | 'list' | |
34 | ] | |
3131c13e C |
35 | static TEXT_WITH_HTML_RULES = MarkdownService.TEXT_RULES.concat([ 'html_inline', 'html_block' ]) |
36 | ||
621d99f5 | 37 | static ENHANCED_RULES = MarkdownService.TEXT_RULES.concat([ 'image' ]) |
3131c13e C |
38 | static ENHANCED_WITH_HTML_RULES = MarkdownService.TEXT_WITH_HTML_RULES.concat([ 'image' ]) |
39 | ||
7e049ea4 C |
40 | static COMPLETE_RULES = MarkdownService.ENHANCED_WITH_HTML_RULES.concat([ 'block', 'inline', 'heading', 'paragraph' ]) |
41 | ||
42 | private markdownParsers: MarkdownParsers = { | |
43 | textMarkdownIt: null, | |
3131c13e | 44 | textWithHTMLMarkdownIt: null, |
7e049ea4 | 45 | enhancedMarkdownIt: null, |
3131c13e | 46 | enhancedWithHTMLMarkdownIt: null, |
7e049ea4 C |
47 | completeMarkdownIt: null |
48 | } | |
49 | private parsersConfig: MarkdownParserConfigs = { | |
50 | textMarkdownIt: { rules: MarkdownService.TEXT_RULES, html: false }, | |
3131c13e C |
51 | textWithHTMLMarkdownIt: { rules: MarkdownService.TEXT_WITH_HTML_RULES, html: true, escape: true }, |
52 | ||
7e049ea4 | 53 | enhancedMarkdownIt: { rules: MarkdownService.ENHANCED_RULES, html: false }, |
3131c13e C |
54 | enhancedWithHTMLMarkdownIt: { rules: MarkdownService.ENHANCED_WITH_HTML_RULES, html: true, escape: true }, |
55 | ||
7e049ea4 C |
56 | completeMarkdownIt: { rules: MarkdownService.COMPLETE_RULES, html: true } |
57 | } | |
621d99f5 | 58 | |
7e049ea4 | 59 | constructor (private htmlRenderer: HtmlRendererService) {} |
9d9597df | 60 | |
3131c13e C |
61 | textMarkdownToHTML (markdown: string, withHtml = false) { |
62 | if (withHtml) return this.render('textWithHTMLMarkdownIt', markdown) | |
63 | ||
7e049ea4 C |
64 | return this.render('textMarkdownIt', markdown) |
65 | } | |
66b16caf | 66 | |
3131c13e C |
67 | enhancedMarkdownToHTML (markdown: string, withHtml = false) { |
68 | if (withHtml) return this.render('enhancedWithHTMLMarkdownIt', markdown) | |
41d71344 | 69 | |
7e049ea4 | 70 | return this.render('enhancedMarkdownIt', markdown) |
07fa4c97 C |
71 | } |
72 | ||
3131c13e | 73 | completeMarkdownToHTML (markdown: string) { |
7e049ea4 C |
74 | return this.render('completeMarkdownIt', markdown) |
75 | } | |
76 | ||
77 | private async render (name: keyof MarkdownParsers, markdown: string) { | |
53055a11 | 78 | if (!markdown) return '' |
07fa4c97 | 79 | |
7e049ea4 C |
80 | const config = this.parsersConfig[ name ] |
81 | if (!this.markdownParsers[ name ]) { | |
82 | this.markdownParsers[ name ] = await this.createMarkdownIt(config) | |
41d71344 C |
83 | } |
84 | ||
7e049ea4 C |
85 | let html = this.markdownParsers[ name ].render(markdown) |
86 | html = this.avoidTruncatedTags(html) | |
621d99f5 | 87 | |
7e049ea4 | 88 | if (config.escape) return this.htmlRenderer.toSafeHtml(html) |
1eb23e12 | 89 | |
7e049ea4 | 90 | return html |
1eb23e12 C |
91 | } |
92 | ||
7e049ea4 | 93 | private async createMarkdownIt (config: MarkdownConfig) { |
1eb23e12 | 94 | // FIXME: import('...') returns a struct module, containing a "default" field corresponding to our sanitizeHtml function |
41d71344 C |
95 | const MarkdownItClass: typeof import ('markdown-it') = (await import('markdown-it') as any).default |
96 | ||
7e049ea4 | 97 | const markdownIt = new MarkdownItClass('zero', { linkify: true, breaks: true, html: config.html }) |
621d99f5 | 98 | |
7e049ea4 | 99 | for (const rule of config.rules) { |
621d99f5 C |
100 | markdownIt.enable(rule) |
101 | } | |
102 | ||
103 | this.setTargetToLinks(markdownIt) | |
104 | ||
105 | return markdownIt | |
106 | } | |
3d9eaae3 | 107 | |
41d71344 | 108 | private setTargetToLinks (markdownIt: MarkdownIt) { |
9d9597df | 109 | // Snippet from markdown-it documentation: https://github.com/markdown-it/markdown-it/blob/master/docs/architecture.md#renderer |
3d9eaae3 | 110 | const defaultRender = markdownIt.renderer.rules.link_open || function (tokens, idx, options, env, self) { |
9d9597df C |
111 | return self.renderToken(tokens, idx, options) |
112 | } | |
113 | ||
632c5e36 C |
114 | markdownIt.renderer.rules.link_open = function (tokens, index, options, env, self) { |
115 | const token = tokens[index] | |
9d9597df | 116 | |
632c5e36 C |
117 | const targetIndex = token.attrIndex('target') |
118 | if (targetIndex < 0) token.attrPush([ 'target', '_blank' ]) | |
119 | else token.attrs[targetIndex][1] = '_blank' | |
120 | ||
121 | const relIndex = token.attrIndex('rel') | |
122 | if (relIndex < 0) token.attrPush([ 'rel', 'noopener noreferrer' ]) | |
123 | else token.attrs[relIndex][1] = 'noopener noreferrer' | |
9d9597df C |
124 | |
125 | // pass token to default renderer. | |
632c5e36 | 126 | return defaultRender(tokens, index, options, env, self) |
9d9597df C |
127 | } |
128 | } | |
07fa4c97 | 129 | |
8eaa6d62 | 130 | private avoidTruncatedTags (html: string) { |
e182430a C |
131 | return html.replace(/\*\*?([^*]+)$/, '$1') |
132 | .replace(/<a[^>]+>([^<]+)<\/a>\s*...((<\/p>)|(<\/li>)|(<\/strong>))?$/mi, '$1...') | |
f5b72c39 C |
133 | .replace(/\[[^\]]+\]\(([^\)]+)$/m, '$1') |
134 | .replace(/\s?\[[^\]]+\]?[.]{3}<\/p>$/m, '...</p>') | |
07fa4c97 | 135 | } |
9d9597df | 136 | } |