BookStack Code Mirror - bookstack/blob - resources/js/wysiwyg/plugin-codeeditor.js

   1 function elemIsCodeBlock(elem) {
   2     return elem.tagName.toLowerCase() === 'code-block';
   3 }
   4
   5 /**
   6  * @param {Editor} editor
   7  * @param {String} code
   8  * @param {String} language
   9  * @param {function(string, string)} callback (Receives (code: string,language: string)
  10  */
  11 function showPopup(editor, code, language, callback) {
  12     window.$components.first('code-editor').open(code, language, (newCode, newLang) => {
  13         callback(newCode, newLang)
  14         editor.focus()
  15     });
  16 }
  17
  18 /**
  19  * @param {Editor} editor
  20  * @param {CodeBlockElement} codeBlock
  21  */
  22 function showPopupForCodeBlock(editor, codeBlock) {
  23     showPopup(editor, codeBlock.getContent(), codeBlock.getLanguage(), (newCode, newLang) => {
  24         codeBlock.setContent(newCode, newLang);
  25     });
  26 }
  27
  28 /**
  29  * Define our custom code-block HTML element that we use.
  30  * Needs to be delayed since it needs to be defined within the context of the
  31  * child editor window and document, hence its definition within a callback.
  32  * @param {Editor} editor
  33  */
  34 function defineCodeBlockCustomElement(editor) {
  35     const doc = editor.getDoc();
  36     const win = doc.defaultView;
  37
  38     class CodeBlockElement extends win.HTMLElement {
  39
  40         /**
  41          * @type {?SimpleEditorInterface}
  42          */
  43         editor = null;
  44
  45         constructor() {
  46             super();
  47             this.attachShadow({mode: 'open'});
  48
  49             const stylesToCopy = document.querySelectorAll('link[rel="stylesheet"]:not([media="print"])');
  50             const copiedStyles = Array.from(stylesToCopy).map(styleEl => styleEl.cloneNode(false));
  51
  52             const cmContainer = document.createElement('div');
  53             cmContainer.style.pointerEvents = 'none';
  54             cmContainer.contentEditable = 'false';
  55             cmContainer.classList.add('CodeMirrorContainer');
  56
  57             this.shadowRoot.append(...copiedStyles, cmContainer);
  58         }
  59
  60         getLanguage() {
  61             const getLanguageFromClassList = (classes) => {
  62                 const langClasses = classes.split(' ').filter(cssClass => cssClass.startsWith('language-'));
  63                 return (langClasses[0] || '').replace('language-', '');
  64             };
  65
  66             const code = this.querySelector('code');
  67             const pre = this.querySelector('pre');
  68             return getLanguageFromClassList(pre.className) || (code && getLanguageFromClassList(code.className)) || '';
  69         }
  70
  71         setContent(content, language) {
  72             if (this.editor) {
  73                 this.editor.setContent(content);
  74                 this.editor.setMode(language, content);
  75             }
  76
  77             let pre = this.querySelector('pre');
  78             if (!pre) {
  79                 pre = doc.createElement('pre');
  80                 this.append(pre);
  81             }
  82             pre.innerHTML = '';
  83
  84             const code = doc.createElement('code');
  85             pre.append(code);
  86             code.innerText = content;
  87             code.className = `language-${language}`;
  88         }
  89
  90         getContent() {
  91             const code = this.querySelector('code') || this.querySelector('pre');
  92             const tempEl = document.createElement('pre');
  93             tempEl.innerHTML = code.innerHTML.replace(/\ufeff/g, '');
  94
  95             const brs = tempEl.querySelectorAll('br');
  96             for (const br of brs) {
  97                 br.replaceWith('\n');
  98             }
  99
 100             return tempEl.textContent;
 101         }
 102
 103         connectedCallback() {
 104             const connectedTime = Date.now();
 105             if (this.editor) {
 106                 return;
 107             }
 108
 109             this.cleanChildContent();
 110             const content = this.getContent();
 111             const lines = content.split('\n').length;
 112             const height = (lines * 19.2) + 18 + 24;
 113             this.style.height = `${height}px`;
 114
 115             const container = this.shadowRoot.querySelector('.CodeMirrorContainer');
 116             const renderEditor = (Code) => {
 117                 this.editor = Code.wysiwygView(container, this.shadowRoot, content, this.getLanguage());
 118                 setTimeout(() => this.style.height = null, 12);
 119             };
 120
 121             window.importVersioned('code').then((Code) => {
 122                 const timeout = (Date.now() - connectedTime < 20) ? 20 : 0;
 123                 setTimeout(() => renderEditor(Code), timeout);
 124             });
 125         }
 126
 127         cleanChildContent() {
 128             const pre = this.querySelector('pre');
 129             if (!pre) return;
 130
 131             for (const preChild of pre.childNodes) {
 132                 if (preChild.nodeName === '#text' && preChild.textContent === '') {
 133                     preChild.remove();
 134                 }
 135             }
 136         }
 137     }
 138
 139     win.customElements.define('code-block', CodeBlockElement);
 140 }
 141
 142
 143 /**
 144  * @param {Editor} editor
 145  * @param {String} url
 146  */
 147 function register(editor, url) {
 148
 149     editor.ui.registry.addIcon('codeblock', '<svg width="24" height="24"><path d="M4 3h16c.6 0 1 .4 1 1v16c0 .6-.4 1-1 1H4a1 1 0 0 1-1-1V4c0-.6.4-1 1-1Zm1 2v14h14V5Z"/><path d="M11.103 15.423c.277.277.277.738 0 .922a.692.692 0 0 1-1.106 0l-4.057-3.78a.738.738 0 0 1 0-1.107l4.057-3.872c.276-.277.83-.277 1.106 0a.724.724 0 0 1 0 1.014L7.6 12.012ZM12.897 8.577c-.245-.312-.2-.675.08-.955.28-.281.727-.27 1.027.033l4.057 3.78a.738.738 0 0 1 0 1.107l-4.057 3.872c-.277.277-.83.277-1.107 0a.724.724 0 0 1 0-1.014l3.504-3.412z"/></svg>')
 150
 151     editor.ui.registry.addButton('codeeditor', {
 152         tooltip: 'Insert code block',
 153         icon: 'codeblock',
 154         onAction() {
 155             editor.execCommand('codeeditor');
 156         }
 157     });
 158
 159     editor.ui.registry.addButton('editcodeeditor', {
 160         tooltip: 'Edit code block',
 161         icon: 'edit-block',
 162         onAction() {
 163             editor.execCommand('codeeditor');
 164         }
 165     });
 166
 167     editor.addCommand('codeeditor', () => {
 168         const selectedNode = editor.selection.getNode();
 169         const doc = selectedNode.ownerDocument;
 170         if (elemIsCodeBlock(selectedNode)) {
 171             showPopupForCodeBlock(editor, selectedNode);
 172         } else {
 173             const textContent = editor.selection.getContent({format: 'text'});
 174             showPopup(editor, textContent, '', (newCode, newLang) => {
 175                 const pre = doc.createElement('pre');
 176                 const code = doc.createElement('code');
 177                 code.classList.add(`language-${newLang}`);
 178                 code.innerText = newCode;
 179                 pre.append(code);
 180
 181                 editor.insertContent(pre.outerHTML);
 182             });
 183         }
 184     });
 185
 186     editor.on('dblclick', event => {
 187         let selectedNode = editor.selection.getNode();
 188         if (elemIsCodeBlock(selectedNode)) {
 189             showPopupForCodeBlock(editor, selectedNode);
 190         }
 191     });
 192
 193     editor.on('PreInit', () => {
 194         editor.parser.addNodeFilter('pre', function(elms) {
 195             for (const el of elms) {
 196                 const wrapper = tinymce.html.Node.create('code-block', {
 197                     contenteditable: 'false',
 198                 });
 199
 200                 const spans = el.getAll('span');
 201                 for (const span of spans) {
 202                     span.unwrap();
 203                 }
 204                 el.attr('style', null);
 205                 el.wrap(wrapper);
 206             }
 207         });
 208
 209         editor.parser.addNodeFilter('code-block', function(elms) {
 210             for (const el of elms) {
 211                 el.attr('contenteditable', 'false');
 212             }
 213         });
 214
 215         editor.serializer.addNodeFilter('code-block', function(elms) {
 216             for (const el of elms) {
 217                 el.unwrap();
 218             }
 219         });
 220     });
 221
 222     editor.ui.registry.addContextToolbar('codeeditor', {
 223         predicate: function (node) {
 224             return node.nodeName.toLowerCase() === 'code-block';
 225         },
 226         items: 'editcodeeditor',
 227         position: 'node',
 228         scope: 'node'
 229     });
 230
 231     editor.on('PreInit', () => {
 232         defineCodeBlockCustomElement(editor);
 233     });
 234 }
 235
 236 /**
 237  * @param {WysiwygConfigOptions} options
 238  * @return {register}
 239  */
 240 export function getPlugin(options) {
 241     return register;
 242 }