1 import * as MarkdownIt from 'markdown-it'
2 import { Injectable } from '@angular/core'
3 import { buildVideoLink, decorateVideoLink } from '@shared/core-utils'
7 ENHANCED_WITH_HTML_RULES,
10 } from '@shared/core-utils/renderer/markdown'
11 import { HtmlRendererService } from './html-renderer.service'
13 type MarkdownParsers = {
14 textMarkdownIt: MarkdownIt
15 textWithHTMLMarkdownIt: MarkdownIt
17 enhancedMarkdownIt: MarkdownIt
18 enhancedWithHTMLMarkdownIt: MarkdownIt
20 unsafeMarkdownIt: MarkdownIt
22 customPageMarkdownIt: MarkdownIt
25 type MarkdownConfig = {
32 type MarkdownParserConfigs = {
33 [id in keyof MarkdownParsers]: MarkdownConfig
37 export class MarkdownService {
38 private markdownParsers: MarkdownParsers = {
40 textWithHTMLMarkdownIt: null,
42 enhancedMarkdownIt: null,
43 enhancedWithHTMLMarkdownIt: null,
45 unsafeMarkdownIt: null,
47 customPageMarkdownIt: null
49 private parsersConfig: MarkdownParserConfigs = {
50 textMarkdownIt: { rules: TEXT_RULES, breaks: true, html: false },
51 textWithHTMLMarkdownIt: { rules: TEXT_WITH_HTML_RULES, breaks: true, html: true, escape: true },
53 enhancedMarkdownIt: { rules: ENHANCED_RULES, breaks: true, html: false },
54 enhancedWithHTMLMarkdownIt: { rules: ENHANCED_WITH_HTML_RULES, breaks: true, html: true, escape: true },
56 unsafeMarkdownIt: { rules: COMPLETE_RULES, breaks: true, html: true, escape: false },
58 customPageMarkdownIt: { rules: COMPLETE_RULES, breaks: false, html: true, escape: true }
61 private emojiModule: any
63 constructor (private htmlRenderer: HtmlRendererService) {}
65 textMarkdownToHTML (options: {
70 const { markdown, withHtml = false, withEmoji = false } = options
72 if (withHtml) return this.render({ name: 'textWithHTMLMarkdownIt', markdown, withEmoji })
74 return this.render({ name: 'textMarkdownIt', markdown, withEmoji })
77 enhancedMarkdownToHTML (options: {
82 const { markdown, withHtml = false, withEmoji = false } = options
84 if (withHtml) return this.render({ name: 'enhancedWithHTMLMarkdownIt', markdown, withEmoji })
86 return this.render({ name: 'enhancedMarkdownIt', markdown, withEmoji })
89 markdownToUnsafeHTML (options: { markdown: string }) {
90 return this.render({ name: 'unsafeMarkdownIt', markdown: options.markdown, withEmoji: true })
93 customPageMarkdownToHTML (options: {
95 additionalAllowedTags: string[]
97 const { markdown, additionalAllowedTags } = options
99 return this.render({ name: 'customPageMarkdownIt', markdown, withEmoji: true, additionalAllowedTags })
102 processVideoTimestamps (videoShortUUID: string, html: string) {
103 return html.replace(/((\d{1,2}):)?(\d{1,2}):(\d{1,2})/g, function (str, _, h, m, s) {
104 const t = (3600 * +(h || 0)) + (60 * +(m || 0)) + (+(s || 0))
106 const url = decorateVideoLink({
107 url: buildVideoLink({ shortUUID: videoShortUUID }),
111 // Sync class name with timestamp-route-transformer directive
112 return `<a class="video-timestamp" href="${url}">${str}</a>`
116 private async render (options: {
117 name: keyof MarkdownParsers
120 additionalAllowedTags?: string[]
122 const { name, markdown, withEmoji, additionalAllowedTags } = options
123 if (!markdown) return ''
125 const config = this.parsersConfig[name]
126 if (!this.markdownParsers[name]) {
127 this.markdownParsers[name] = await this.createMarkdownIt(config)
130 if (!this.emojiModule) {
131 this.emojiModule = (await import('markdown-it-emoji/light')).default
134 this.markdownParsers[name].use(this.emojiModule)
138 let html = this.markdownParsers[name].render(markdown)
139 html = this.avoidTruncatedTags(html)
141 if (config.escape) return this.htmlRenderer.toSafeHtml(html, additionalAllowedTags)
146 private async createMarkdownIt (config: MarkdownConfig) {
147 // FIXME: import('...') returns a struct module, containing a "default" field
148 const MarkdownItClass: typeof import ('markdown-it') = (await import('markdown-it') as any).default
150 const markdownIt = new MarkdownItClass('zero', { linkify: true, breaks: config.breaks, html: config.html })
152 for (const rule of config.rules) {
153 markdownIt.enable(rule)
156 this.setTargetToLinks(markdownIt)
161 private setTargetToLinks (markdownIt: MarkdownIt) {
162 // Snippet from markdown-it documentation: https://github.com/markdown-it/markdown-it/blob/master/docs/architecture.md#renderer
163 const defaultRender = markdownIt.renderer.rules.link_open || function (tokens, idx, options, env, self) {
164 return self.renderToken(tokens, idx, options)
167 markdownIt.renderer.rules.link_open = function (tokens, index, options, env, self) {
168 const token = tokens[index]
170 const targetIndex = token.attrIndex('target')
171 if (targetIndex < 0) token.attrPush([ 'target', '_blank' ])
172 else token.attrs[targetIndex][1] = '_blank'
174 const relIndex = token.attrIndex('rel')
175 if (relIndex < 0) token.attrPush([ 'rel', 'noopener noreferrer' ])
176 else token.attrs[relIndex][1] = 'noopener noreferrer'
178 // pass token to default renderer.*
179 return defaultRender(tokens, index, options, env, self)
183 private avoidTruncatedTags (html: string) {
184 return html.replace(/\*\*?([^*]+)$/, '$1')
185 .replace(/<a[^>]+>([^<]+)<\/a>\s*...((<\/p>)|(<\/li>)|(<\/strong>))?$/mi, '$1...')
186 .replace(/\[[^\]]+\]\(([^)]+)$/m, '$1')
187 .replace(/\s?\[[^\]]+\]?[.]{3}<\/p>$/m, '...</p>')