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