1 import Code from "../services/code";
2 import DrawIO from "../services/drawio";
3 import Clipboard from "../services/clipboard";
6 * Handle pasting images from clipboard.
7 * @param {ClipboardEvent} event
8 * @param {WysiwygEditor} wysiwygComponent
11 function editorPaste(event, editor, wysiwygComponent) {
12 const clipboard = new Clipboard(event.clipboardData || event.dataTransfer);
14 // Don't handle the event ourselves if no items exist of contains table-looking data
15 if (!clipboard.hasItems() || clipboard.containsTabularData()) {
19 const images = clipboard.getImages();
20 for (const imageFile of images) {
22 const id = "image-" + Math.random().toString(16).slice(2);
23 const loadingImage = window.baseUrl('/loading.gif');
24 event.preventDefault();
27 editor.insertContent(`<p><img src="${loadingImage}" id="${id}"></p>`);
29 uploadImageFile(imageFile, wysiwygComponent).then(resp => {
30 const safeName = resp.name.replace(/"/g, '');
31 const newImageHtml = `<img src="${resp.thumbs.display}" alt="${safeName}" />`;
33 const newEl = editor.dom.create('a', {
38 editor.dom.replace(newEl, id);
40 editor.dom.remove(id);
41 window.$events.emit('error', wysiwygComponent.imageUploadErrorText);
49 * Upload an image file to the server
51 * @param {WysiwygEditor} wysiwygComponent
53 async function uploadImageFile(file, wysiwygComponent) {
54 if (file === null || file.type.indexOf('image') !== 0) {
55 throw new Error(`Not an image file`);
60 let fileNameMatches = file.name.match(/\.(.+)$/);
61 if (fileNameMatches.length > 1) ext = fileNameMatches[1];
64 const remoteFilename = "image-" + Date.now() + "." + ext;
65 const formData = new FormData();
66 formData.append('file', file, remoteFilename);
67 formData.append('uploaded_to', wysiwygComponent.pageId);
69 const resp = await window.$http.post(window.baseUrl('/images/gallery'), formData);
73 function registerEditorShortcuts(editor) {
75 for (let i = 1; i < 5; i++) {
76 editor.shortcuts.add('meta+' + i, '', ['FormatBlock', false, 'h' + (i+1)]);
79 // Other block shortcuts
80 editor.shortcuts.add('meta+5', '', ['FormatBlock', false, 'p']);
81 editor.shortcuts.add('meta+d', '', ['FormatBlock', false, 'p']);
82 editor.shortcuts.add('meta+6', '', ['FormatBlock', false, 'blockquote']);
83 editor.shortcuts.add('meta+q', '', ['FormatBlock', false, 'blockquote']);
84 editor.shortcuts.add('meta+7', '', ['codeeditor', false, 'pre']);
85 editor.shortcuts.add('meta+e', '', ['codeeditor', false, 'pre']);
86 editor.shortcuts.add('meta+8', '', ['FormatBlock', false, 'code']);
87 editor.shortcuts.add('meta+shift+E', '', ['FormatBlock', false, 'code']);
89 // Save draft shortcut
90 editor.shortcuts.add('meta+S', '', () => {
91 window.$events.emit('editor-save-draft');
95 editor.shortcuts.add('meta+13', '', () => {
96 window.$events.emit('editor-save-page');
99 // Loop through callout styles
100 editor.shortcuts.add('meta+9', '', function() {
101 const selectedNode = editor.selection.getNode();
102 const callout = selectedNode ? selectedNode.closest('.callout') : null;
104 const formats = ['info', 'success', 'warning', 'danger'];
105 const currentFormatIndex = formats.findIndex(format => callout && callout.classList.contains(format));
106 const newFormatIndex = (currentFormatIndex + 1) % formats.length;
107 const newFormat = formats[newFormatIndex];
109 editor.formatter.apply('callout' + newFormat);
115 * Load custom HTML head content from the settings into the editor.
118 function loadCustomHeadContent(editor) {
119 window.$http.get(window.baseUrl('/custom-head-content')).then(resp => {
120 if (!resp.data) return;
121 let head = editor.getDoc().querySelector('head');
122 head.innerHTML += resp.data;
127 * Create and enable our custom code plugin
129 function codePlugin() {
131 function elemIsCodeBlock(elem) {
132 return elem.className === 'CodeMirrorContainer';
135 function showPopup(editor) {
136 const selectedNode = editor.selection.getNode();
138 if (!elemIsCodeBlock(selectedNode)) {
139 const providedCode = editor.selection.getNode().textContent;
140 window.components.first('code-editor').open(providedCode, '', (code, lang) => {
141 const wrap = document.createElement('div');
142 wrap.innerHTML = `<pre><code class="language-${lang}"></code></pre>`;
143 wrap.querySelector('code').innerText = code;
145 editor.formatter.toggle('pre');
146 const node = editor.selection.getNode();
147 editor.dom.setHTML(node, wrap.querySelector('pre').innerHTML);
148 editor.fire('SetContent');
155 let lang = selectedNode.hasAttribute('data-lang') ? selectedNode.getAttribute('data-lang') : '';
156 let currentCode = selectedNode.querySelector('textarea').textContent;
158 window.components.first('code-editor').open(currentCode, lang, (code, lang) => {
159 const editorElem = selectedNode.querySelector('.CodeMirror');
160 const cmInstance = editorElem.CodeMirror;
162 Code.setContent(cmInstance, code);
163 Code.setMode(cmInstance, lang, code);
165 const textArea = selectedNode.querySelector('textarea');
166 if (textArea) textArea.textContent = code;
167 selectedNode.setAttribute('data-lang', lang);
173 function codeMirrorContainerToPre(codeMirrorContainer) {
174 const textArea = codeMirrorContainer.querySelector('textarea');
175 const code = textArea.textContent;
176 const lang = codeMirrorContainer.getAttribute('data-lang');
178 codeMirrorContainer.removeAttribute('contentEditable');
179 const pre = document.createElement('pre');
180 const codeElem = document.createElement('code');
181 codeElem.classList.add(`language-${lang}`);
182 codeElem.textContent = code;
183 pre.appendChild(codeElem);
185 codeMirrorContainer.parentElement.replaceChild(pre, codeMirrorContainer);
188 window.tinymce.PluginManager.add('codeeditor', function(editor, url) {
192 editor.addButton('codeeditor', {
198 editor.addCommand('codeeditor', () => {
203 editor.on('PreProcess', function (e) {
204 $('div.CodeMirrorContainer', e.node).each((index, elem) => {
205 codeMirrorContainerToPre(elem);
209 editor.on('dblclick', event => {
210 let selectedNode = editor.selection.getNode();
211 if (!elemIsCodeBlock(selectedNode)) return;
215 function parseCodeMirrorInstances() {
217 // Recover broken codemirror instances
218 $('.CodeMirrorContainer').filter((index ,elem) => {
219 return typeof elem.querySelector('.CodeMirror').CodeMirror === 'undefined';
220 }).each((index, elem) => {
221 codeMirrorContainerToPre(elem);
224 const codeSamples = $('body > pre').filter((index, elem) => {
225 return elem.contentEditable !== "false";
228 if (!codeSamples.length) return;
229 editor.undoManager.transact(function () {
230 codeSamples.each((index, elem) => {
231 Code.wysiwygView(elem);
236 editor.on('init', function() {
237 // Parse code mirror instances on init, but delay a little so this runs after
238 // initial styles are fetched into the editor.
239 parseCodeMirrorInstances();
240 // Parsed code mirror blocks when content is set but wait before setting this handler
241 // to avoid any init 'SetContent' events.
243 editor.on('SetContent', parseCodeMirrorInstances);
250 function drawIoPlugin(drawioUrl, isDarkMode, pageId, wysiwygComponent) {
252 let pageEditor = null;
253 let currentNode = null;
255 function isDrawing(node) {
256 return node.hasAttribute('drawio-diagram');
259 function showDrawingManager(mceEditor, selectedNode = null) {
260 pageEditor = mceEditor;
261 currentNode = selectedNode;
262 // Show image manager
263 window.ImageManager.show(function (image) {
265 let imgElem = selectedNode.querySelector('img');
266 pageEditor.dom.setAttrib(imgElem, 'src', image.url);
267 pageEditor.dom.setAttrib(selectedNode, 'drawio-diagram', image.id);
269 let imgHTML = `<div drawio-diagram="${image.id}" contenteditable="false"><img src="${image.url}"></div>`;
270 pageEditor.insertContent(imgHTML);
275 function showDrawingEditor(mceEditor, selectedNode = null) {
276 pageEditor = mceEditor;
277 currentNode = selectedNode;
278 DrawIO.show(drawioUrl, drawingInit, updateContent);
281 async function updateContent(pngData) {
282 const id = "image-" + Math.random().toString(16).slice(2);
283 const loadingImage = window.baseUrl('/loading.gif');
285 // Handle updating an existing image
288 let imgElem = currentNode.querySelector('img');
290 const img = await DrawIO.upload(pngData, pageId);
291 pageEditor.dom.setAttrib(imgElem, 'src', img.url);
292 pageEditor.dom.setAttrib(currentNode, 'drawio-diagram', img.id);
294 window.$events.emit('error', wysiwygComponent.imageUploadErrorText);
300 setTimeout(async () => {
301 pageEditor.insertContent(`<div drawio-diagram contenteditable="false"><img src="${loadingImage}" id="${id}"></div>`);
304 const img = await DrawIO.upload(pngData, pageId);
305 pageEditor.dom.setAttrib(id, 'src', img.url);
306 pageEditor.dom.get(id).parentNode.setAttribute('drawio-diagram', img.id);
308 pageEditor.dom.remove(id);
309 window.$events.emit('error', wysiwygComponent.imageUploadErrorText);
316 function drawingInit() {
318 return Promise.resolve('');
321 let drawingId = currentNode.getAttribute('drawio-diagram');
322 return DrawIO.load(drawingId);
325 window.tinymce.PluginManager.add('drawio', function(editor, url) {
327 editor.addCommand('drawio', () => {
328 const selectedNode = editor.selection.getNode();
329 showDrawingEditor(editor, isDrawing(selectedNode) ? selectedNode : null);
332 editor.addButton('drawio', {
335 image: `data:image/svg+xml;base64,${btoa(`<svg viewBox="0 0 24 24" fill="${isDarkMode ? '#BBB' : '#000000'}" xmlns="http://www.w3.org/2000/svg">
336 <path d="M23 7V1h-6v2H7V1H1v6h2v10H1v6h6v-2h10v2h6v-6h-2V7h2zM3 3h2v2H3V3zm2 18H3v-2h2v2zm12-2H7v-2H5V7h2V5h10v2h2v10h-2v2zm4 2h-2v-2h2v2zM19 5V3h2v2h-2zm-5.27 9h-3.49l-.73 2H7.89l3.4-9h1.4l3.41 9h-1.63l-.74-2zm-3.04-1.26h2.61L12 8.91l-1.31 3.83z"/>
337 <path d="M0 0h24v24H0z" fill="none"/>
342 text: 'Drawing Manager',
344 let selectedNode = editor.selection.getNode();
345 showDrawingManager(editor, isDrawing(selectedNode) ? selectedNode : null);
351 editor.on('dblclick', event => {
352 let selectedNode = editor.selection.getNode();
353 if (!isDrawing(selectedNode)) return;
354 showDrawingEditor(editor, selectedNode);
357 editor.on('SetContent', function () {
358 const drawings = editor.$('body > div[drawio-diagram]');
359 if (!drawings.length) return;
361 editor.undoManager.transact(function () {
362 drawings.each((index, elem) => {
363 elem.setAttribute('contenteditable', 'false');
371 function customHrPlugin() {
372 window.tinymce.PluginManager.add('customhr', function (editor) {
373 editor.addCommand('InsertHorizontalRule', function () {
374 let hrElem = document.createElement('hr');
375 let cNode = editor.selection.getNode();
376 let parentNode = cNode.parentNode;
377 parentNode.insertBefore(hrElem, cNode);
380 editor.addButton('hr', {
382 tooltip: 'Horizontal line',
383 cmd: 'InsertHorizontalRule'
386 editor.addMenuItem('hr', {
388 text: 'Horizontal line',
389 cmd: 'InsertHorizontalRule',
396 function listenForBookStackEditorEvents(editor) {
398 // Replace editor content
399 window.$events.listen('editor::replace', ({html}) => {
400 editor.setContent(html);
403 // Append editor content
404 window.$events.listen('editor::append', ({html}) => {
405 const content = editor.getContent() + html;
406 editor.setContent(content);
409 // Prepend editor content
410 window.$events.listen('editor::prepend', ({html}) => {
411 const content = html + editor.getContent();
412 editor.setContent(content);
415 // Insert editor content at the current location
416 window.$events.listen('editor::insert', ({html}) => {
417 editor.insertContent(html);
420 // Focus on the editor
421 window.$events.listen('editor::focus', () => {
426 class WysiwygEditor {
429 this.elem = this.$el;
431 this.pageId = this.$opts.pageId;
432 this.textDirection = this.$opts.textDirection;
433 this.imageUploadErrorText = this.$opts.imageUploadErrorText;
434 this.isDarkMode = document.documentElement.classList.contains('dark-mode');
436 this.plugins = "image imagetools table textcolor paste link autolink fullscreen code customhr autosave lists codeeditor media";
439 this.tinyMceConfig = this.getTinyMceConfig();
440 window.$events.emitPublic(this.elem, 'editor-tinymce::pre-init', {config: this.tinyMceConfig});
441 window.tinymce.init(this.tinyMceConfig);
448 const drawioUrlElem = document.querySelector('[drawio-url]');
450 const url = drawioUrlElem.getAttribute('drawio-url');
451 drawIoPlugin(url, this.isDarkMode, this.pageId, this);
452 this.plugins += ' drawio';
455 if (this.textDirection === 'rtl') {
456 this.plugins += ' directionality'
461 const textDirPlugins = this.textDirection === 'rtl' ? 'ltr rtl' : '';
462 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`
467 const context = this;
470 selector: '#html-editor',
472 window.baseUrl('/dist/styles.css'),
475 skin: this.isDarkMode ? 'dark' : 'lightgray',
476 body_class: 'page-content',
477 browser_spellcheck: true,
478 relative_urls: false,
479 directionality : this.textDirection,
480 remove_script_host: false,
481 document_base_url: window.baseUrl('/'),
482 end_container_on_empty_block: true,
485 paste_data_images: false,
486 extended_valid_elements: 'pre[*],svg[*],div[drawio-diagram]',
487 automatic_uploads: false,
488 valid_children: "-div[p|h1|h2|h3|h4|h5|h6|blockquote],+div[pre],+div[img]",
489 plugins: this.plugins,
490 imagetools_toolbar: 'imageoptions',
491 toolbar: this.getToolBar(),
492 content_style: `html, body, html.dark-mode {background: ${this.isDarkMode ? '#222' : '#fff'};} body {padding-left: 15px !important; padding-right: 15px !important; margin:0!important; margin-left:auto!important;margin-right:auto!important;}`,
494 {title: "Header Large", format: "h2"},
495 {title: "Header Medium", format: "h3"},
496 {title: "Header Small", format: "h4"},
497 {title: "Header Tiny", format: "h5"},
498 {title: "Paragraph", format: "p", exact: true, classes: ''},
499 {title: "Blockquote", format: "blockquote"},
500 {title: "Code Block", icon: "code", cmd: 'codeeditor', format: 'codeeditor'},
501 {title: "Inline Code", icon: "code", inline: "code"},
502 {title: "Callouts", items: [
503 {title: "Info", format: 'calloutinfo'},
504 {title: "Success", format: 'calloutsuccess'},
505 {title: "Warning", format: 'calloutwarning'},
506 {title: "Danger", format: 'calloutdanger'}
509 style_formats_merge: false,
510 media_alt_source: false,
513 codeeditor: {selector: 'p,h1,h2,h3,h4,h5,h6,td,th,div'},
514 alignleft: {selector: 'p,h1,h2,h3,h4,h5,h6,td,th,div,ul,ol,li,table,img', classes: 'align-left'},
515 aligncenter: {selector: 'p,h1,h2,h3,h4,h5,h6,td,th,div,ul,ol,li,table,img', classes: 'align-center'},
516 alignright: {selector: 'p,h1,h2,h3,h4,h5,h6,td,th,div,ul,ol,li,table,img', classes: 'align-right'},
517 calloutsuccess: {block: 'p', exact: true, attributes: {class: 'callout success'}},
518 calloutinfo: {block: 'p', exact: true, attributes: {class: 'callout info'}},
519 calloutwarning: {block: 'p', exact: true, attributes: {class: 'callout warning'}},
520 calloutdanger: {block: 'p', exact: true, attributes: {class: 'callout danger'}}
522 file_browser_callback: function (field_name, url, type, win) {
524 if (type === 'file') {
525 window.EntitySelectorPopup.show(function(entity) {
526 const originalField = win.document.getElementById(field_name);
527 originalField.value = entity.link;
528 const mceForm = originalField.closest('.mce-form');
529 const inputs = mceForm.querySelectorAll('input');
531 // Set text to display if not empty
532 if (!inputs[1].value) {
533 inputs[1].value = entity.name;
537 inputs[2].value = entity.name;
541 if (type === 'image') {
542 // Show image manager
543 window.ImageManager.show(function (image) {
545 // Set popover link input to image url then fire change event
546 // to ensure the new value sticks
547 win.document.getElementById(field_name).value = image.url;
548 if ("createEvent" in document) {
549 let evt = document.createEvent("HTMLEvents");
550 evt.initEvent("change", false, true);
551 win.document.getElementById(field_name).dispatchEvent(evt);
553 win.document.getElementById(field_name).fireEvent("onchange");
556 // Replace the actively selected content with the linked image
557 let html = `<a href="${image.url}" target="_blank">`;
558 html += `<img src="${image.thumbs.display}" alt="${image.name}">`;
560 win.tinyMCE.activeEditor.execCommand('mceInsertContent', false, html);
565 paste_preprocess: function (plugin, args) {
566 let content = args.content;
567 if (content.indexOf('<img src="file://') !== -1) {
571 init_instance_callback: function(editor) {
572 loadCustomHeadContent(editor);
574 setup: function (editor) {
576 editor.on('ExecCommand change input NodeChange ObjectResized', editorChange);
578 editor.on('init', () => {
580 // Scroll to the content if needed.
581 const queryParams = (new URL(window.location)).searchParams;
582 const scrollId = queryParams.get('content-id');
584 scrollToText(scrollId);
587 // Override for touch events to allow scroll on mobile
588 const container = editor.getContainer();
589 const toolbarButtons = container.querySelectorAll('.mce-btn');
590 for (let button of toolbarButtons) {
591 button.addEventListener('touchstart', event => {
592 event.stopPropagation();
595 window.editor = editor;
598 function editorChange() {
599 const content = editor.getContent();
600 if (context.isDarkMode) {
601 editor.contentDocument.documentElement.classList.add('dark-mode');
603 window.$events.emit('editor-html-change', content);
606 function scrollToText(scrollId) {
607 const element = editor.dom.get(encodeURIComponent(scrollId).replace(/!/g, '%21'));
612 // scroll the element into the view and put the cursor at the end.
613 element.scrollIntoView();
614 editor.selection.select(element, true);
615 editor.selection.collapse(false);
619 listenForBookStackEditorEvents(editor);
621 // TODO - Update to standardise across both editors
622 // Use events within listenForBookStackEditorEvents instead (Different event signature)
623 window.$events.listen('editor-html-update', html => {
624 editor.setContent(html);
625 editor.selection.select(editor.getBody(), true);
626 editor.selection.collapse(false);
630 registerEditorShortcuts(editor);
633 let draggedContentEditable;
635 function hasTextContent(node) {
636 return node && !!( node.textContent || node.innerText );
639 editor.on('dragstart', function () {
640 let node = editor.selection.getNode();
642 if (node.nodeName === 'IMG') {
643 wrap = editor.dom.getParent(node, '.mceTemp');
645 if (!wrap && node.parentNode.nodeName === 'A' && !hasTextContent(node.parentNode)) {
646 wrap = node.parentNode;
650 // Track dragged contenteditable blocks
651 if (node.hasAttribute('contenteditable') && node.getAttribute('contenteditable') === 'false') {
652 draggedContentEditable = node;
657 // Custom drop event handling
658 editor.on('drop', function (event) {
659 let dom = editor.dom,
660 rng = tinymce.dom.RangeUtils.getCaretRangeFromPoint(event.clientX, event.clientY, editor.getDoc());
662 // Template insertion
663 const templateId = event.dataTransfer && event.dataTransfer.getData('bookstack/template');
665 event.preventDefault();
666 window.$http.get(`/templates/${templateId}`).then(resp => {
667 editor.selection.setRng(rng);
668 editor.undoManager.transact(function () {
669 editor.execCommand('mceInsertContent', false, resp.data.html);
674 // Don't allow anything to be dropped in a captioned image.
675 if (dom.getParent(rng.startContainer, '.mceTemp')) {
676 event.preventDefault();
678 event.preventDefault();
680 editor.undoManager.transact(function () {
681 editor.selection.setRng(rng);
682 editor.selection.setNode(wrap);
687 // Handle contenteditable section drop
688 if (!event.isDefaultPrevented() && draggedContentEditable) {
689 event.preventDefault();
690 editor.undoManager.transact(function () {
691 const selectedNode = editor.selection.getNode();
692 const range = editor.selection.getRng();
693 const selectedNodeRoot = selectedNode.closest('body > *');
694 if (range.startOffset > (range.startContainer.length / 2)) {
695 editor.$(selectedNodeRoot).after(draggedContentEditable);
697 editor.$(selectedNodeRoot).before(draggedContentEditable);
702 // Handle image insert
703 if (!event.isDefaultPrevented()) {
704 editorPaste(event, editor, context);
710 // Custom Image picker button
711 editor.addButton('image-insert', {
714 tooltip: 'Insert an image',
715 onclick: function () {
716 window.ImageManager.show(function (image) {
717 let html = `<a href="${image.url}" target="_blank">`;
718 html += `<img src="${image.thumbs.display}" alt="${image.name}">`;
720 editor.execCommand('mceInsertContent', false, html);
725 // Paste image-uploads
726 editor.on('paste', event => editorPaste(event, editor, context));
728 // Custom handler hook
729 window.$events.emitPublic(context.elem, 'editor-tinymce::setup', {editor});
736 export default WysiwygEditor;