GrowiRenderer.js 5.9 KB

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