GrowiRenderer.js 5.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205
  1. import MarkdownIt from 'markdown-it';
  2. import Linker from './PreProcessor/Linker';
  3. import CsvToTable from './PreProcessor/CsvToTable';
  4. import XssFilter from './PreProcessor/XssFilter';
  5. import EmojiConfigurer from './markdown-it/emoji';
  6. import FooternoteConfigurer from './markdown-it/footernote';
  7. import HeaderLineNumberConfigurer from './markdown-it/header-line-number';
  8. import HeaderConfigurer from './markdown-it/header';
  9. import MathJaxConfigurer from './markdown-it/mathjax';
  10. import PlantUMLConfigurer from './markdown-it/plantuml';
  11. import TableConfigurer from './markdown-it/table';
  12. import TaskListsConfigurer from './markdown-it/task-lists';
  13. import TocAndAnchorConfigurer from './markdown-it/toc-and-anchor';
  14. import BlockdiagConfigurer from './markdown-it/blockdiag';
  15. import DrawioViewerConfigurer from './markdown-it/drawio-viewer';
  16. import TableWithHandsontableButtonConfigurer from './markdown-it/table-with-handsontable-button';
  17. import HeaderWithEditLinkConfigurer from './markdown-it/header-with-edit-link';
  18. const logger = require('@alias/logger')('growi:util:GrowiRenderer');
  19. export default class GrowiRenderer {
  20. /**
  21. *
  22. * @param {AppContainer} appContainer
  23. * @param {GrowiRenderer} originRenderer
  24. * @param {string} mode
  25. */
  26. constructor(appContainer, originRenderer) {
  27. this.appContainer = appContainer;
  28. if (originRenderer != null) {
  29. this.preProcessors = originRenderer.preProcessors;
  30. this.postProcessors = originRenderer.postProcessors;
  31. }
  32. else {
  33. this.preProcessors = [
  34. new Linker(appContainer),
  35. new CsvToTable(appContainer),
  36. new XssFilter(appContainer),
  37. ];
  38. this.postProcessors = [
  39. ];
  40. }
  41. this.initMarkdownItConfigurers = this.initMarkdownItConfigurers.bind(this);
  42. this.setup = this.setup.bind(this);
  43. this.process = this.process.bind(this);
  44. this.codeRenderer = this.codeRenderer.bind(this);
  45. }
  46. initMarkdownItConfigurers(mode) {
  47. const appContainer = this.appContainer;
  48. // init markdown-it
  49. this.md = new MarkdownIt({
  50. html: true,
  51. linkify: true,
  52. highlight: this.codeRenderer,
  53. });
  54. this.isMarkdownItConfigured = false;
  55. this.markdownItConfigurers = [
  56. new TaskListsConfigurer(appContainer),
  57. new HeaderConfigurer(appContainer),
  58. new EmojiConfigurer(appContainer),
  59. new MathJaxConfigurer(appContainer),
  60. new DrawioViewerConfigurer(appContainer),
  61. new PlantUMLConfigurer(appContainer),
  62. new BlockdiagConfigurer(appContainer),
  63. ];
  64. // add configurers according to mode
  65. switch (mode) {
  66. case 'page': {
  67. const pageContainer = appContainer.getContainer('PageContainer');
  68. this.markdownItConfigurers = this.markdownItConfigurers.concat([
  69. new FooternoteConfigurer(appContainer),
  70. new TocAndAnchorConfigurer(appContainer, pageContainer.setTocHtml),
  71. new HeaderLineNumberConfigurer(appContainer),
  72. new HeaderWithEditLinkConfigurer(appContainer),
  73. new TableWithHandsontableButtonConfigurer(appContainer),
  74. ]);
  75. break;
  76. }
  77. case 'editor':
  78. this.markdownItConfigurers = this.markdownItConfigurers.concat([
  79. new FooternoteConfigurer(appContainer),
  80. new HeaderLineNumberConfigurer(appContainer),
  81. new TableConfigurer(appContainer),
  82. ]);
  83. break;
  84. // case 'comment':
  85. // break;
  86. default:
  87. this.markdownItConfigurers = this.markdownItConfigurers.concat([
  88. new TableConfigurer(appContainer),
  89. ]);
  90. break;
  91. }
  92. }
  93. /**
  94. * setup with crowi config
  95. */
  96. setup(mode) {
  97. const crowiConfig = this.appContainer.config;
  98. let isEnabledLinebreaks;
  99. switch (mode) {
  100. case 'comment':
  101. isEnabledLinebreaks = crowiConfig.isEnabledLinebreaksInComments;
  102. break;
  103. default:
  104. isEnabledLinebreaks = crowiConfig.isEnabledLinebreaks;
  105. break;
  106. }
  107. this.md.set({
  108. breaks: isEnabledLinebreaks,
  109. });
  110. if (!this.isMarkdownItConfigured) {
  111. this.markdownItConfigurers.forEach((configurer) => {
  112. configurer.configure(this.md);
  113. });
  114. }
  115. }
  116. preProcess(markdown) {
  117. let processed = markdown;
  118. for (let i = 0; i < this.preProcessors.length; i++) {
  119. if (!this.preProcessors[i].process) {
  120. continue;
  121. }
  122. processed = this.preProcessors[i].process(processed);
  123. }
  124. return processed;
  125. }
  126. process(markdown) {
  127. return this.md.render(markdown);
  128. }
  129. postProcess(html) {
  130. let processed = html;
  131. for (let i = 0; i < this.postProcessors.length; i++) {
  132. if (!this.postProcessors[i].process) {
  133. continue;
  134. }
  135. processed = this.postProcessors[i].process(processed);
  136. }
  137. return processed;
  138. }
  139. codeRenderer(code, langExt) {
  140. const config = this.appContainer.getConfig();
  141. const noborder = (!config.highlightJsStyleBorder) ? 'hljs-no-border' : '';
  142. let citeTag = '';
  143. let hljsLang = 'plaintext';
  144. let showLinenumbers = false;
  145. if (langExt) {
  146. // https://regex101.com/r/qGs7eZ/3
  147. const match = langExt.match(/^([^:=\n]+)?(=([^:=\n]*))?(:([^:=\n]*))?(=([^:=\n]*))?$/);
  148. const lang = match[1];
  149. const fileName = match[5] || null;
  150. showLinenumbers = (match[2] != null) || (match[6] != null);
  151. if (fileName != null) {
  152. citeTag = `<cite>${fileName}</cite>`;
  153. }
  154. if (hljs.getLanguage(lang)) {
  155. hljsLang = lang;
  156. }
  157. }
  158. let highlightCode = code;
  159. try {
  160. highlightCode = hljs.highlight(hljsLang, code, true).value;
  161. // add line numbers
  162. if (showLinenumbers) {
  163. highlightCode = hljs.lineNumbersValue((highlightCode));
  164. }
  165. }
  166. catch (err) {
  167. logger.error(err);
  168. }
  169. return `<pre class="hljs ${noborder}">${citeTag}<code>${highlightCode}</code></pre>`;
  170. }
  171. highlightCode(code, lang) {
  172. }
  173. }