]> BookStack Code Mirror - bookstack/blob - resources/assets/js/components/wysiwyg-editor.js
Update maintenance.php
[bookstack] / resources / assets / js / components / wysiwyg-editor.js
1 import Code from "../services/code";
2 import DrawIO from "../services/drawio";
3
4 /**
5  * Handle pasting images from clipboard.
6  * @param {ClipboardEvent} event
7  * @param {WysiwygEditor} wysiwygComponent
8  * @param editor
9  */
10 function editorPaste(event, editor, wysiwygComponent) {
11     const clipboardItems = event.clipboardData.items;
12     if (!event.clipboardData || !clipboardItems) return;
13
14     // Don't handle if clipboard includes text content
15     for (let clipboardItem of clipboardItems) {
16         if (clipboardItem.type.includes('text/')) {
17             return;
18         }
19     }
20
21     for (let clipboardItem of clipboardItems) {
22         if (!clipboardItem.type.includes("image")) {
23             continue;
24         }
25
26         const id = "image-" + Math.random().toString(16).slice(2);
27         const loadingImage = window.baseUrl('/loading.gif');
28         const file = clipboardItem.getAsFile();
29
30         setTimeout(() => {
31             editor.insertContent(`<p><img src="${loadingImage}" id="${id}"></p>`);
32
33             uploadImageFile(file, wysiwygComponent).then(resp => {
34                 editor.dom.setAttrib(id, 'src', resp.thumbs.display);
35             }).catch(err => {
36                 editor.dom.remove(id);
37                 window.$events.emit('error', trans('errors.image_upload_error'));
38                 console.log(err);
39             });
40         }, 10);
41     }
42 }
43
44 /**
45  * Upload an image file to the server
46  * @param {File} file
47  * @param {WysiwygEditor} wysiwygComponent
48  */
49 async function uploadImageFile(file, wysiwygComponent) {
50     if (file === null || file.type.indexOf('image') !== 0) {
51         throw new Error(`Not an image file`);
52     }
53
54     let ext = 'png';
55     if (file.name) {
56         let fileNameMatches = file.name.match(/\.(.+)$/);
57         if (fileNameMatches.length > 1) ext = fileNameMatches[1];
58     }
59
60     const remoteFilename = "image-" + Date.now() + "." + ext;
61     const formData = new FormData();
62     formData.append('file', file, remoteFilename);
63     formData.append('uploaded_to', wysiwygComponent.pageId);
64
65     const resp = await window.$http.post(window.baseUrl('/images/gallery'), formData);
66     return resp.data;
67 }
68
69 function registerEditorShortcuts(editor) {
70     // Headers
71     for (let i = 1; i < 5; i++) {
72         editor.shortcuts.add('meta+' + i, '', ['FormatBlock', false, 'h' + (i+1)]);
73     }
74
75     // Other block shortcuts
76     editor.shortcuts.add('meta+5', '', ['FormatBlock', false, 'p']);
77     editor.shortcuts.add('meta+d', '', ['FormatBlock', false, 'p']);
78     editor.shortcuts.add('meta+6', '', ['FormatBlock', false, 'blockquote']);
79     editor.shortcuts.add('meta+q', '', ['FormatBlock', false, 'blockquote']);
80     editor.shortcuts.add('meta+7', '', ['codeeditor', false, 'pre']);
81     editor.shortcuts.add('meta+e', '', ['codeeditor', false, 'pre']);
82     editor.shortcuts.add('meta+8', '', ['FormatBlock', false, 'code']);
83     editor.shortcuts.add('meta+shift+E', '', ['FormatBlock', false, 'code']);
84
85     // Save draft shortcut
86     editor.shortcuts.add('meta+S', '', () => {
87         window.$events.emit('editor-save-draft');
88     });
89
90     // Save page shortcut
91     editor.shortcuts.add('meta+13', '', () => {
92         window.$events.emit('editor-save-page');
93     });
94
95     // Loop through callout styles
96     editor.shortcuts.add('meta+9', '', function() {
97         let selectedNode = editor.selection.getNode();
98         let formats = ['info', 'success', 'warning', 'danger'];
99
100         if (!selectedNode || selectedNode.className.indexOf('callout') === -1) {
101             editor.formatter.apply('calloutinfo');
102             return;
103         }
104
105         for (let i = 0; i < formats.length; i++) {
106             if (selectedNode.className.indexOf(formats[i]) === -1) continue;
107             let newFormat = (i === formats.length -1) ? formats[0] : formats[i+1];
108             editor.formatter.apply('callout' + newFormat);
109             return;
110         }
111         editor.formatter.apply('p');
112     });
113
114 }
115
116 /**
117  * Load custom HTML head content from the settings into the editor.
118  * @param editor
119  */
120 function loadCustomHeadContent(editor) {
121     window.$http.get(window.baseUrl('/custom-head-content')).then(resp => {
122         if (!resp.data) return;
123         let head = editor.getDoc().querySelector('head');
124         head.innerHTML += resp.data;
125     });
126 }
127
128 /**
129  * Create and enable our custom code plugin
130  */
131 function codePlugin() {
132
133     function elemIsCodeBlock(elem) {
134         return elem.className === 'CodeMirrorContainer';
135     }
136
137     function showPopup(editor) {
138         let selectedNode = editor.selection.getNode();
139
140         if (!elemIsCodeBlock(selectedNode)) {
141             let providedCode = editor.selection.getNode().textContent;
142             window.vues['code-editor'].open(providedCode, '', (code, lang) => {
143                 let wrap = document.createElement('div');
144                 wrap.innerHTML = `<pre><code class="language-${lang}"></code></pre>`;
145                 wrap.querySelector('code').innerText = code;
146
147                 editor.formatter.toggle('pre');
148                 let node = editor.selection.getNode();
149                 editor.dom.setHTML(node, wrap.querySelector('pre').innerHTML);
150                 editor.fire('SetContent');
151             });
152             return;
153         }
154
155         let lang = selectedNode.hasAttribute('data-lang') ? selectedNode.getAttribute('data-lang') : '';
156         let currentCode = selectedNode.querySelector('textarea').textContent;
157
158         window.vues['code-editor'].open(currentCode, lang, (code, lang) => {
159             let editorElem = selectedNode.querySelector('.CodeMirror');
160             let cmInstance = editorElem.CodeMirror;
161             if (cmInstance) {
162                 Code.setContent(cmInstance, code);
163                 Code.setMode(cmInstance, lang);
164             }
165             let textArea = selectedNode.querySelector('textarea');
166             if (textArea) textArea.textContent = code;
167             selectedNode.setAttribute('data-lang', lang);
168         });
169     }
170
171     function codeMirrorContainerToPre($codeMirrorContainer) {
172         let textArea = $codeMirrorContainer[0].querySelector('textarea');
173         let code = textArea.textContent;
174         let lang = $codeMirrorContainer[0].getAttribute('data-lang');
175
176         $codeMirrorContainer.removeAttr('contentEditable');
177         let $pre = $('<pre></pre>');
178         $pre.append($('<code></code>').each((index, elem) => {
179             // Needs to be textContent since innerText produces BR:s
180             elem.textContent = code;
181         }).attr('class', `language-${lang}`));
182         $codeMirrorContainer.replaceWith($pre);
183     }
184
185     window.tinymce.PluginManager.add('codeeditor', function(editor, url) {
186
187         let $ = editor.$;
188
189         editor.addButton('codeeditor', {
190             text: 'Code block',
191             icon: false,
192             cmd: 'codeeditor'
193         });
194
195         editor.addCommand('codeeditor', () => {
196             showPopup(editor);
197         });
198
199         // Convert
200         editor.on('PreProcess', function (e) {
201             $('div.CodeMirrorContainer', e.node).
202             each((index, elem) => {
203                 let $elem = $(elem);
204                 codeMirrorContainerToPre($elem);
205             });
206         });
207
208         editor.on('dblclick', event => {
209             let selectedNode = editor.selection.getNode();
210             if (!elemIsCodeBlock(selectedNode)) return;
211             showPopup(editor);
212         });
213
214         editor.on('SetContent', function () {
215
216             // Recover broken codemirror instances
217             $('.CodeMirrorContainer').filter((index ,elem) => {
218                 return typeof elem.querySelector('.CodeMirror').CodeMirror === 'undefined';
219             }).each((index, elem) => {
220                 codeMirrorContainerToPre($(elem));
221             });
222
223             let codeSamples = $('body > pre').filter((index, elem) => {
224                 return elem.contentEditable !== "false";
225             });
226
227             if (!codeSamples.length) return;
228             editor.undoManager.transact(function () {
229                 codeSamples.each((index, elem) => {
230                     Code.wysiwygView(elem);
231                 });
232             });
233         });
234
235     });
236 }
237
238 function drawIoPlugin() {
239
240     let pageEditor = null;
241     let currentNode = null;
242
243     function isDrawing(node) {
244         return node.hasAttribute('drawio-diagram');
245     }
246
247     function showDrawingManager(mceEditor, selectedNode = null) {
248         pageEditor = mceEditor;
249         currentNode = selectedNode;
250         // Show image manager
251         window.ImageManager.show(function (image) {
252             if (selectedNode) {
253                 let imgElem = selectedNode.querySelector('img');
254                 pageEditor.dom.setAttrib(imgElem, 'src', image.url);
255                 pageEditor.dom.setAttrib(selectedNode, 'drawio-diagram', image.id);
256             } else {
257                 let imgHTML = `<div drawio-diagram="${image.id}" contenteditable="false"><img src="${image.url}"></div>`;
258                 pageEditor.insertContent(imgHTML);
259             }
260         }, 'drawio');
261     }
262
263     function showDrawingEditor(mceEditor, selectedNode = null) {
264         pageEditor = mceEditor;
265         currentNode = selectedNode;
266         DrawIO.show(drawingInit, updateContent);
267     }
268
269     async function updateContent(pngData) {
270         const id = "image-" + Math.random().toString(16).slice(2);
271         const loadingImage = window.baseUrl('/loading.gif');
272         const pageId = Number(document.getElementById('page-editor').getAttribute('page-id'));
273
274         // Handle updating an existing image
275         if (currentNode) {
276             DrawIO.close();
277             let imgElem = currentNode.querySelector('img');
278             try {
279                 const img = await DrawIO.upload(pngData, pageId);
280                 pageEditor.dom.setAttrib(imgElem, 'src', img.url);
281                 pageEditor.dom.setAttrib(currentNode, 'drawio-diagram', img.id);
282             } catch (err) {
283                 window.$events.emit('error', trans('errors.image_upload_error'));
284                 console.log(err);
285             }
286             return;
287         }
288
289         setTimeout(async () => {
290             pageEditor.insertContent(`<div drawio-diagram contenteditable="false"><img src="${loadingImage}" id="${id}"></div>`);
291             DrawIO.close();
292             try {
293                 const img = await DrawIO.upload(pngData, pageId);
294                 pageEditor.dom.setAttrib(id, 'src', img.url);
295                 pageEditor.dom.get(id).parentNode.setAttribute('drawio-diagram', img.id);
296             } catch (err) {
297                 pageEditor.dom.remove(id);
298                 window.$events.emit('error', trans('errors.image_upload_error'));
299                 console.log(err);
300             }
301         }, 5);
302     }
303
304
305     function drawingInit() {
306         if (!currentNode) {
307             return Promise.resolve('');
308         }
309
310         let drawingId = currentNode.getAttribute('drawio-diagram');
311         return DrawIO.load(drawingId);
312     }
313
314     window.tinymce.PluginManager.add('drawio', function(editor, url) {
315
316         editor.addCommand('drawio', () => {
317             let selectedNode = editor.selection.getNode();
318             showDrawingEditor(editor, isDrawing(selectedNode) ? selectedNode : null);
319         });
320
321         editor.addButton('drawio', {
322             type: 'splitbutton',
323             tooltip: 'Drawing',
324             image: `data:image/svg+xml;base64,PHN2ZyB2aWV3Qm94PSIwIDAgMjQgMjQiIGZpbGw9IiMwMDAwMDAiICB4bWxucz0iaHR0cDovL3d3 dy53My5vcmcvMjAwMC9zdmciPgogICAgPHBhdGggZD0iTTIzIDdWMWgtNnYySDdWMUgxdjZoMnYx MEgxdjZoNnYtMmgxMHYyaDZ2LTZoLTJWN2gyek0zIDNoMnYySDNWM3ptMiAxOEgzdi0yaDJ2Mnpt MTItMkg3di0ySDVWN2gyVjVoMTB2MmgydjEwaC0ydjJ6bTQgMmgtMnYtMmgydjJ6TTE5IDVWM2gy djJoLTJ6bS01LjI3IDloLTMuNDlsLS43MyAySDcuODlsMy40LTloMS40bDMuNDEgOWgtMS42M2wt Ljc0LTJ6bS0zLjA0LTEuMjZoMi42MUwxMiA4LjkxbC0xLjMxIDMuODN6Ii8+CiAgICA8cGF0aCBk PSJNMCAwaDI0djI0SDB6IiBmaWxsPSJub25lIi8+Cjwvc3ZnPg==`,
325             cmd: 'drawio',
326             menu: [
327                 {
328                     text: 'Drawing Manager',
329                     onclick() {
330                         let selectedNode = editor.selection.getNode();
331                         showDrawingManager(editor, isDrawing(selectedNode) ? selectedNode : null);
332                     }
333                 }
334             ]
335         });
336
337         editor.on('dblclick', event => {
338             let selectedNode = editor.selection.getNode();
339             if (!isDrawing(selectedNode)) return;
340             showDrawingEditor(editor, selectedNode);
341         });
342
343         editor.on('SetContent', function () {
344             let drawings = editor.$('body > div[drawio-diagram]');
345             if (!drawings.length) return;
346
347             editor.undoManager.transact(function () {
348                 drawings.each((index, elem) => {
349                     elem.setAttribute('contenteditable', 'false');
350                 });
351             });
352         });
353
354     });
355 }
356
357 function customHrPlugin() {
358     window.tinymce.PluginManager.add('customhr', function (editor) {
359         editor.addCommand('InsertHorizontalRule', function () {
360             let hrElem = document.createElement('hr');
361             let cNode = editor.selection.getNode();
362             let parentNode = cNode.parentNode;
363             parentNode.insertBefore(hrElem, cNode);
364         });
365
366         editor.addButton('hr', {
367             icon: 'hr',
368             tooltip: 'Horizontal line',
369             cmd: 'InsertHorizontalRule'
370         });
371
372         editor.addMenuItem('hr', {
373             icon: 'hr',
374             text: 'Horizontal line',
375             cmd: 'InsertHorizontalRule',
376             context: 'insert'
377         });
378     });
379 }
380
381
382 class WysiwygEditor {
383
384     constructor(elem) {
385         this.elem = elem;
386
387         const pageEditor = document.getElementById('page-editor');
388         this.pageId = pageEditor.getAttribute('page-id');
389         this.textDirection = pageEditor.getAttribute('text-direction');
390
391         this.plugins = "image table textcolor paste link autolink fullscreen imagetools code customhr autosave lists codeeditor media";
392         this.loadPlugins();
393
394         this.tinyMceConfig = this.getTinyMceConfig();
395         window.tinymce.init(this.tinyMceConfig);
396     }
397
398     loadPlugins() {
399         codePlugin();
400         customHrPlugin();
401         if (document.querySelector('[drawio-enabled]').getAttribute('drawio-enabled') === 'true') {
402             drawIoPlugin();
403             this.plugins += ' drawio';
404         }
405         if (this.textDirection === 'rtl') {
406             this.plugins += ' directionality'
407         }
408     }
409
410     getToolBar() {
411         const textDirPlugins = this.textDirection === 'rtl' ? 'ltr rtl' : '';
412         return `undo redo | styleselect | bold italic underline strikethrough superscript subscript | forecolor backcolor | alignleft aligncenter alignright alignjustify | bullist numlist outdent indent | table image-insert link hr drawio media | removeformat code ${textDirPlugins} fullscreen`
413     }
414
415     getTinyMceConfig() {
416
417         const context = this;
418
419         return {
420             selector: '#html-editor',
421             content_css: [
422                 window.baseUrl('/dist/styles.css'),
423             ],
424             branding: false,
425             body_class: 'page-content',
426             browser_spellcheck: true,
427             relative_urls: false,
428             directionality : this.textDirection,
429             remove_script_host: false,
430             document_base_url: window.baseUrl('/'),
431             end_container_on_empty_block: true,
432             statusbar: false,
433             menubar: false,
434             paste_data_images: false,
435             extended_valid_elements: 'pre[*],svg[*],div[drawio-diagram]',
436             automatic_uploads: false,
437             valid_children: "-div[p|h1|h2|h3|h4|h5|h6|blockquote],+div[pre],+div[img]",
438             plugins: this.plugins,
439             imagetools_toolbar: 'imageoptions',
440             toolbar: this.getToolBar(),
441             content_style: "html, body {background: #FFF;} body {padding-left: 15px !important; padding-right: 15px !important; margin:0!important; margin-left:auto!important;margin-right:auto!important;}",
442             style_formats: [
443                 {title: "Header Large", format: "h2"},
444                 {title: "Header Medium", format: "h3"},
445                 {title: "Header Small", format: "h4"},
446                 {title: "Header Tiny", format: "h5"},
447                 {title: "Paragraph", format: "p", exact: true, classes: ''},
448                 {title: "Blockquote", format: "blockquote"},
449                 {title: "Code Block", icon: "code", cmd: 'codeeditor', format: 'codeeditor'},
450                 {title: "Inline Code", icon: "code", inline: "code"},
451                 {title: "Callouts", items: [
452                         {title: "Info", format: 'calloutinfo'},
453                         {title: "Success", format: 'calloutsuccess'},
454                         {title: "Warning", format: 'calloutwarning'},
455                         {title: "Danger", format: 'calloutdanger'}
456                     ]},
457             ],
458             style_formats_merge: false,
459             media_alt_source: false,
460             media_poster: false,
461             formats: {
462                 codeeditor: {selector: 'p,h1,h2,h3,h4,h5,h6,td,th,div'},
463                 alignleft: {selector: 'p,h1,h2,h3,h4,h5,h6,td,th,div,ul,ol,li,table,img', classes: 'align-left'},
464                 aligncenter: {selector: 'p,h1,h2,h3,h4,h5,h6,td,th,div,ul,ol,li,table,img', classes: 'align-center'},
465                 alignright: {selector: 'p,h1,h2,h3,h4,h5,h6,td,th,div,ul,ol,li,table,img', classes: 'align-right'},
466                 calloutsuccess: {block: 'p', exact: true, attributes: {class: 'callout success'}},
467                 calloutinfo: {block: 'p', exact: true, attributes: {class: 'callout info'}},
468                 calloutwarning: {block: 'p', exact: true, attributes: {class: 'callout warning'}},
469                 calloutdanger: {block: 'p', exact: true, attributes: {class: 'callout danger'}}
470             },
471             file_browser_callback: function (field_name, url, type, win) {
472
473                 if (type === 'file') {
474                     window.EntitySelectorPopup.show(function(entity) {
475                         let originalField = win.document.getElementById(field_name);
476                         originalField.value = entity.link;
477                         $(originalField).closest('.mce-form').find('input').eq(2).val(entity.name);
478                     });
479                 }
480
481                 if (type === 'image') {
482                     // Show image manager
483                     window.ImageManager.show(function (image) {
484
485                         // Set popover link input to image url then fire change event
486                         // to ensure the new value sticks
487                         win.document.getElementById(field_name).value = image.url;
488                         if ("createEvent" in document) {
489                             let evt = document.createEvent("HTMLEvents");
490                             evt.initEvent("change", false, true);
491                             win.document.getElementById(field_name).dispatchEvent(evt);
492                         } else {
493                             win.document.getElementById(field_name).fireEvent("onchange");
494                         }
495
496                         // Replace the actively selected content with the linked image
497                         let html = `<a href="${image.url}" target="_blank">`;
498                         html += `<img src="${image.thumbs.display}" alt="${image.name}">`;
499                         html += '</a>';
500                         win.tinyMCE.activeEditor.execCommand('mceInsertContent', false, html);
501                     }, 'gallery');
502                 }
503
504             },
505             paste_preprocess: function (plugin, args) {
506                 let content = args.content;
507                 if (content.indexOf('<img src="file://') !== -1) {
508                     args.content = '';
509                 }
510             },
511             init_instance_callback: function(editor) {
512                 loadCustomHeadContent(editor);
513             },
514             setup: function (editor) {
515
516                 editor.on('ExecCommand change input NodeChange ObjectResized', editorChange);
517
518                 editor.on('init', () => {
519                     editorChange();
520                     // Scroll to the content if needed.
521                     const queryParams = (new URL(window.location)).searchParams;
522                     const scrollId = queryParams.get('content-id');
523                     if (scrollId) {
524                         scrollToText(scrollId);
525                     }
526
527                     // Override for touch events to allow scroll on mobile
528                     const container = editor.getContainer();
529                     const toolbarButtons = container.querySelectorAll('.mce-btn');
530                     for (let button of toolbarButtons) {
531                         button.addEventListener('touchstart', event => {
532                             event.stopPropagation();
533                         });
534                     }
535                     window.editor = editor;
536                 });
537
538                 function editorChange() {
539                     let content = editor.getContent();
540                     window.$events.emit('editor-html-change', content);
541                 }
542
543                 function scrollToText(scrollId) {
544                     const element = editor.dom.get(encodeURIComponent(scrollId).replace(/!/g, '%21'));
545                     if (!element) {
546                         return;
547                     }
548
549                     // scroll the element into the view and put the cursor at the end.
550                     element.scrollIntoView();
551                     editor.selection.select(element, true);
552                     editor.selection.collapse(false);
553                     editor.focus();
554                 }
555
556                 window.$events.listen('editor-html-update', html => {
557                     editor.setContent(html);
558                     editor.selection.select(editor.getBody(), true);
559                     editor.selection.collapse(false);
560                     editorChange(html);
561                 });
562
563                 registerEditorShortcuts(editor);
564
565                 let wrap;
566
567                 function hasTextContent(node) {
568                     return node && !!( node.textContent || node.innerText );
569                 }
570
571                 editor.on('dragstart', function () {
572                     let node = editor.selection.getNode();
573
574                     if (node.nodeName !== 'IMG') return;
575                     wrap = editor.dom.getParent(node, '.mceTemp');
576
577                     if (!wrap && node.parentNode.nodeName === 'A' && !hasTextContent(node.parentNode)) {
578                         wrap = node.parentNode;
579                     }
580                 });
581
582                 editor.on('drop', function (event) {
583                     let dom = editor.dom,
584                         rng = tinymce.dom.RangeUtils.getCaretRangeFromPoint(event.clientX, event.clientY, editor.getDoc());
585
586                     // Don't allow anything to be dropped in a captioned image.
587                     if (dom.getParent(rng.startContainer, '.mceTemp')) {
588                         event.preventDefault();
589                     } else if (wrap) {
590                         event.preventDefault();
591
592                         editor.undoManager.transact(function () {
593                             editor.selection.setRng(rng);
594                             editor.selection.setNode(wrap);
595                             dom.remove(wrap);
596                         });
597                     }
598
599                     wrap = null;
600                 });
601
602                 // Custom Image picker button
603                 editor.addButton('image-insert', {
604                     title: 'My title',
605                     icon: 'image',
606                     tooltip: 'Insert an image',
607                     onclick: function () {
608                         window.ImageManager.show(function (image) {
609                             let html = `<a href="${image.url}" target="_blank">`;
610                             html += `<img src="${image.thumbs.display}" alt="${image.name}">`;
611                             html += '</a>';
612                             editor.execCommand('mceInsertContent', false, html);
613                         }, 'gallery');
614                     }
615                 });
616
617                 // Paste image-uploads
618                 editor.on('paste', event => editorPaste(event, editor, context));
619
620             }
621         };
622     }
623
624 }
625
626 export default WysiwygEditor;