]>
Commit | Line | Data |
---|---|---|
14aa8556 | 1 | import * as MarkdownIt from 'markdown-it' |
67ed6552 | 2 | import { Injectable } from '@angular/core' |
15a7eafb | 3 | import { buildVideoLink, decorateVideoLink } from '@shared/core-utils' |
9ff36c2d C |
4 | import { |
5 | COMPLETE_RULES, | |
6 | ENHANCED_RULES, | |
7 | ENHANCED_WITH_HTML_RULES, | |
8 | TEXT_RULES, | |
9 | TEXT_WITH_HTML_RULES | |
10 | } from '@shared/core-utils/renderer/markdown' | |
67ed6552 | 11 | import { HtmlRendererService } from './html-renderer.service' |
7e049ea4 C |
12 | |
13 | type MarkdownParsers = { | |
14 | textMarkdownIt: MarkdownIt | |
3131c13e C |
15 | textWithHTMLMarkdownIt: MarkdownIt |
16 | ||
7e049ea4 | 17 | enhancedMarkdownIt: MarkdownIt |
3131c13e C |
18 | enhancedWithHTMLMarkdownIt: MarkdownIt |
19 | ||
2539932e C |
20 | unsafeMarkdownIt: MarkdownIt |
21 | ||
22 | customPageMarkdownIt: MarkdownIt | |
7e049ea4 C |
23 | } |
24 | ||
25 | type MarkdownConfig = { | |
26 | rules: string[] | |
27 | html: boolean | |
2539932e | 28 | breaks: boolean |
7e049ea4 C |
29 | escape?: boolean |
30 | } | |
31 | ||
32 | type MarkdownParserConfigs = { | |
33 | [id in keyof MarkdownParsers]: MarkdownConfig | |
34 | } | |
9d9597df C |
35 | |
36 | @Injectable() | |
37 | export class MarkdownService { | |
7e049ea4 C |
38 | private markdownParsers: MarkdownParsers = { |
39 | textMarkdownIt: null, | |
3131c13e | 40 | textWithHTMLMarkdownIt: null, |
2539932e | 41 | |
7e049ea4 | 42 | enhancedMarkdownIt: null, |
3131c13e | 43 | enhancedWithHTMLMarkdownIt: null, |
2539932e C |
44 | |
45 | unsafeMarkdownIt: null, | |
46 | ||
47 | customPageMarkdownIt: null | |
7e049ea4 C |
48 | } |
49 | private parsersConfig: MarkdownParserConfigs = { | |
2539932e C |
50 | textMarkdownIt: { rules: TEXT_RULES, breaks: true, html: false }, |
51 | textWithHTMLMarkdownIt: { rules: TEXT_WITH_HTML_RULES, breaks: true, html: true, escape: true }, | |
3131c13e | 52 | |
2539932e C |
53 | enhancedMarkdownIt: { rules: ENHANCED_RULES, breaks: true, html: false }, |
54 | enhancedWithHTMLMarkdownIt: { rules: ENHANCED_WITH_HTML_RULES, breaks: true, html: true, escape: true }, | |
3131c13e | 55 | |
2539932e C |
56 | unsafeMarkdownIt: { rules: COMPLETE_RULES, breaks: true, html: true, escape: false }, |
57 | ||
58 | customPageMarkdownIt: { rules: COMPLETE_RULES, breaks: false, html: true, escape: true } | |
7e049ea4 | 59 | } |
621d99f5 | 60 | |
369e7754 C |
61 | private emojiModule: any |
62 | ||
7e049ea4 | 63 | constructor (private htmlRenderer: HtmlRendererService) {} |
9d9597df | 64 | |
0672dc76 | 65 | textMarkdownToHTML (markdown: string, withHtml = false, withEmoji = false) { |
2539932e | 66 | if (withHtml) return this.render({ name: 'textWithHTMLMarkdownIt', markdown, withEmoji }) |
3131c13e | 67 | |
2539932e | 68 | return this.render({ name: 'textMarkdownIt', markdown, withEmoji }) |
7e049ea4 | 69 | } |
66b16caf | 70 | |
0672dc76 | 71 | enhancedMarkdownToHTML (markdown: string, withHtml = false, withEmoji = false) { |
2539932e C |
72 | if (withHtml) return this.render({ name: 'enhancedWithHTMLMarkdownIt', markdown, withEmoji }) |
73 | ||
74 | return this.render({ name: 'enhancedMarkdownIt', markdown, withEmoji }) | |
75 | } | |
41d71344 | 76 | |
2539932e C |
77 | unsafeMarkdownToHTML (markdown: string, _trustedInput: true) { |
78 | return this.render({ name: 'unsafeMarkdownIt', markdown, withEmoji: true }) | |
07fa4c97 C |
79 | } |
80 | ||
2539932e C |
81 | customPageMarkdownToHTML (markdown: string, additionalAllowedTags: string[]) { |
82 | return this.render({ name: 'customPageMarkdownIt', markdown, withEmoji: true, additionalAllowedTags }) | |
7e049ea4 C |
83 | } |
84 | ||
9162fdd3 | 85 | processVideoTimestamps (videoShortUUID: string, html: string) { |
b29bf61d RK |
86 | return html.replace(/((\d{1,2}):)?(\d{1,2}):(\d{1,2})/g, function (str, _, h, m, s) { |
87 | const t = (3600 * +(h || 0)) + (60 * +(m || 0)) + (+(s || 0)) | |
9162fdd3 C |
88 | |
89 | const url = decorateVideoLink({ | |
90 | url: buildVideoLink({ shortUUID: videoShortUUID }), | |
91 | startTime: t | |
92 | }) | |
b29bf61d RK |
93 | return `<a class="video-timestamp" href="${url}">${str}</a>` |
94 | }) | |
95 | } | |
96 | ||
2539932e C |
97 | private async render (options: { |
98 | name: keyof MarkdownParsers | |
99 | markdown: string | |
100 | withEmoji: boolean | |
101 | additionalAllowedTags?: string[] | |
102 | }) { | |
103 | const { name, markdown, withEmoji, additionalAllowedTags } = options | |
53055a11 | 104 | if (!markdown) return '' |
07fa4c97 | 105 | |
9df52d66 C |
106 | const config = this.parsersConfig[name] |
107 | if (!this.markdownParsers[name]) { | |
108 | this.markdownParsers[name] = await this.createMarkdownIt(config) | |
0672dc76 | 109 | |
110 | if (withEmoji) { | |
369e7754 C |
111 | if (!this.emojiModule) { |
112 | this.emojiModule = (await import('markdown-it-emoji/light')).default | |
113 | } | |
114 | ||
9df52d66 | 115 | this.markdownParsers[name].use(this.emojiModule) |
0672dc76 | 116 | } |
41d71344 C |
117 | } |
118 | ||
9df52d66 | 119 | let html = this.markdownParsers[name].render(markdown) |
7e049ea4 | 120 | html = this.avoidTruncatedTags(html) |
621d99f5 | 121 | |
2539932e | 122 | if (config.escape) return this.htmlRenderer.toSafeHtml(html, additionalAllowedTags) |
1eb23e12 | 123 | |
7e049ea4 | 124 | return html |
1eb23e12 C |
125 | } |
126 | ||
7e049ea4 | 127 | private async createMarkdownIt (config: MarkdownConfig) { |
14aa8556 | 128 | // FIXME: import('...') returns a struct module, containing a "default" field |
41d71344 C |
129 | const MarkdownItClass: typeof import ('markdown-it') = (await import('markdown-it') as any).default |
130 | ||
2539932e | 131 | const markdownIt = new MarkdownItClass('zero', { linkify: true, breaks: config.breaks, html: config.html }) |
621d99f5 | 132 | |
7e049ea4 | 133 | for (const rule of config.rules) { |
621d99f5 C |
134 | markdownIt.enable(rule) |
135 | } | |
136 | ||
137 | this.setTargetToLinks(markdownIt) | |
138 | ||
139 | return markdownIt | |
140 | } | |
3d9eaae3 | 141 | |
41d71344 | 142 | private setTargetToLinks (markdownIt: MarkdownIt) { |
9d9597df | 143 | // Snippet from markdown-it documentation: https://github.com/markdown-it/markdown-it/blob/master/docs/architecture.md#renderer |
3d9eaae3 | 144 | const defaultRender = markdownIt.renderer.rules.link_open || function (tokens, idx, options, env, self) { |
9d9597df C |
145 | return self.renderToken(tokens, idx, options) |
146 | } | |
147 | ||
632c5e36 C |
148 | markdownIt.renderer.rules.link_open = function (tokens, index, options, env, self) { |
149 | const token = tokens[index] | |
9d9597df | 150 | |
632c5e36 C |
151 | const targetIndex = token.attrIndex('target') |
152 | if (targetIndex < 0) token.attrPush([ 'target', '_blank' ]) | |
153 | else token.attrs[targetIndex][1] = '_blank' | |
154 | ||
155 | const relIndex = token.attrIndex('rel') | |
156 | if (relIndex < 0) token.attrPush([ 'rel', 'noopener noreferrer' ]) | |
157 | else token.attrs[relIndex][1] = 'noopener noreferrer' | |
9d9597df | 158 | |
9df52d66 | 159 | // pass token to default renderer.* |
632c5e36 | 160 | return defaultRender(tokens, index, options, env, self) |
9d9597df C |
161 | } |
162 | } | |
07fa4c97 | 163 | |
8eaa6d62 | 164 | private avoidTruncatedTags (html: string) { |
e182430a C |
165 | return html.replace(/\*\*?([^*]+)$/, '$1') |
166 | .replace(/<a[^>]+>([^<]+)<\/a>\s*...((<\/p>)|(<\/li>)|(<\/strong>))?$/mi, '$1...') | |
9df52d66 | 167 | .replace(/\[[^\]]+\]\(([^)]+)$/m, '$1') |
f5b72c39 | 168 | .replace(/\s?\[[^\]]+\]?[.]{3}<\/p>$/m, '...</p>') |
07fa4c97 | 169 | } |
9d9597df | 170 | } |